third_party/WebKit/public/platform/WebBlobData.h

   1 /*
   2  * Copyright (C) 2010 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #ifndef WebBlobData_h
  32 #define WebBlobData_h
  33
  34 #include "WebNonCopyable.h"
  35 #include "WebPrivateOwnPtr.h"
  36 #include "WebString.h"
  37 #include "WebThreadSafeData.h"
  38 #include "WebURL.h"
  39
  40 #if INSIDE_BLINK
  41 namespace WTF { template <typename T> class PassOwnPtr; }
  42 #endif
  43
  44 namespace blink {
  45
  46 class BlobData;
  47
  48 class WebBlobData : public WebNonCopyable {
  49 public:
  50     struct Item {
  51         enum { TypeData, TypeFile, TypeBlob, TypeFileSystemURL } type;
  52         WebThreadSafeData data;
  53         WebString blobUUID;
  54         WebString filePath;
  55         WebURL fileSystemURL;
  56         long long offset;
  57         long long length; // -1 means go to the end of the file/blob.
  58         double expectedModificationTime; // 0.0 means that the time is not set.
  59     };
  60
  61     BLINK_PLATFORM_EXPORT WebBlobData();
  62     BLINK_PLATFORM_EXPORT ~WebBlobData();
  63
  64     bool isNull() const { return !m_private.get(); }
  65
  66     // Returns the number of items.
  67     BLINK_PLATFORM_EXPORT size_t itemCount() const;
  68
  69     // Retrieves the values of the item at the given index. Returns false if
  70     // index is out of bounds.
  71     // This call is single use only per index. The memory ownership is
  72     // transfered to the result in the case of memory items. A second call with
  73     // the same index will result in null data.
  74     // TODO(dmurph): change the name to 'takeItemAt'
  75     BLINK_PLATFORM_EXPORT bool itemAt(size_t index, Item& result) const;
  76
  77     BLINK_PLATFORM_EXPORT WebString contentType() const;
  78
  79 #if INSIDE_BLINK
  80     BLINK_PLATFORM_EXPORT WebBlobData(const WTF::PassOwnPtr<BlobData>&);
  81     BLINK_PLATFORM_EXPORT WebBlobData& operator=(const WTF::PassOwnPtr<BlobData>&);
  82     BLINK_PLATFORM_EXPORT operator WTF::PassOwnPtr<BlobData>();
  83 #endif
  84
  85 private:
  86     WebPrivateOwnPtr<BlobData> m_private;
  87 };
  88
  89 } // namespace blink
  90
  91 #endif // WebBlobData_h