Source/WebCore/fileapi/Blob.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 Blob_h
  32 #define Blob_h
  33
  34 #include "BlobData.h"
  35 #include "KURL.h"
  36 #include "PlatformString.h"
  37 #include <wtf/PassOwnPtr.h>
  38 #include <wtf/PassRefPtr.h>
  39 #include <wtf/RefCounted.h>
  40 #include <wtf/Vector.h>
  41
  42 namespace WebCore {
  43
  44 class ScriptExecutionContext;
  45
  46 class Blob : public RefCounted<Blob> {
  47 public:
  48     static PassRefPtr<Blob> create()
  49     {
  50         return adoptRef(new Blob);
  51     }
  52
  53     static PassRefPtr<Blob> create(PassOwnPtr<BlobData> blobData, long long size)
  54     {
  55         return adoptRef(new Blob(blobData, size));
  56     }
  57
  58     // For deserialization.
  59     static PassRefPtr<Blob> create(const KURL& srcURL, const String& type, long long size)
  60     {
  61         return adoptRef(new Blob(srcURL, type, size));
  62     }
  63
  64     virtual ~Blob();
  65
  66     const KURL& url() const { return m_internalURL; }
  67     const String& type() const { return m_type; }
  68
  69     virtual unsigned long long size() const { return static_cast<unsigned long long>(m_size); }
  70     virtual bool isFile() const { return false; }
  71
  72 #if ENABLE(BLOB)
  73     PassRefPtr<Blob> slice(long long start = 0, long long end = std::numeric_limits<long long>::max(), const String& contentType = String()) const;
  74
  75     // Prefixed version is deprecated. This internally calls sliceInternal() (as slice() does) after showing a deprecation message.
  76     PassRefPtr<Blob> webkitSlice(ScriptExecutionContext*, long long start = 0, long long end = std::numeric_limits<long long>::max(), const String& contentType = String()) const;
  77
  78 #endif
  79
  80 protected:
  81     Blob();
  82     Blob(PassOwnPtr<BlobData>, long long size);
  83
  84     // For deserialization.
  85     Blob(const KURL& srcURL, const String& type, long long size);
  86
  87 #if ENABLE(BLOB)
  88     PassRefPtr<Blob> sliceInternal(long long start, long long end, const String& contentType) const;
  89 #endif
  90
  91     // This is an internal URL referring to the blob data associated with this object. It serves
  92     // as an identifier for this blob. The internal URL is never used to source the blob's content
  93     // into an HTML or for FileRead'ing, public blob URLs must be used for those purposes.
  94     KURL m_internalURL;
  95
  96     String m_type;
  97     long long m_size;
  98 };
  99
 100 } // namespace WebCore
 101
 102 #endif // Blob_h