public/platform/WebBlobData.h

/*
 * Copyright (C) 2010 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef WebBlobData_h
#define WebBlobData_h

#include "WebNonCopyable.h"
#include "WebPrivateOwnPtr.h"
#include "WebString.h"
#include "WebThreadSafeData.h"
#include "WebURL.h"

namespace WebCore { class BlobData; }
#if INSIDE_BLINK
namespace WTF { template <typename T> class PassOwnPtr; }
#endif

namespace WebKit {

class WebBlobData : public WebNonCopyable {
public:
    struct Item {
        enum { TypeData, TypeFile, TypeBlob, TypeFileSystemURL } type;
        WebThreadSafeData data;
        WebString blobUUID;
        WebString filePath;
        WebURL fileSystemURL;
        long long offset;
        long long length; // -1 means go to the end of the file/blob.
        double expectedModificationTime; // 0.0 means that the time is not set.
    };

    BLINK_PLATFORM_EXPORT WebBlobData();
    BLINK_PLATFORM_EXPORT ~WebBlobData();

    bool isNull() const { return !m_private.get(); }

    // Returns the number of items.
    BLINK_PLATFORM_EXPORT size_t itemCount() const;

    // Retrieves the values of the item at the given index. Returns false if
    // index is out of bounds.
    BLINK_PLATFORM_EXPORT bool itemAt(size_t index, Item& result) const;

    BLINK_PLATFORM_EXPORT WebString contentType() const;

    BLINK_PLATFORM_EXPORT WebString contentDisposition() const;

#if INSIDE_BLINK
    BLINK_PLATFORM_EXPORT WebBlobData(const WTF::PassOwnPtr<WebCore::BlobData>&);
    BLINK_PLATFORM_EXPORT WebBlobData& operator=(const WTF::PassOwnPtr<WebCore::BlobData>&);
    BLINK_PLATFORM_EXPORT operator WTF::PassOwnPtr<WebCore::BlobData>();
#endif

private:
    WebPrivateOwnPtr<WebCore::BlobData> m_private;
};

} // namespace WebKit

#endif // WebBlobData_h