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 "bindings/core/v8/ScriptWrappable.h"
35#include "core/html/URLRegistry.h"
36#include "platform/blob/BlobData.h"
37#include "platform/heap/Handle.h"
38#include "wtf/PassOwnPtr.h"
39#include "wtf/PassRefPtr.h"
40#include "wtf/RefCounted.h"
41#include "wtf/text/WTFString.h"
42
43namespace blink {
44
45class ExceptionState;
46class ExecutionContext;
47
48class Blob : public RefCountedWillBeGarbageCollectedFinalized<Blob>, public ScriptWrappable, public URLRegistrable {
49    DEFINE_WRAPPERTYPEINFO();
50public:
51    static PassRefPtrWillBeRawPtr<Blob> create()
52    {
53        return adoptRefWillBeNoop(new Blob(BlobDataHandle::create()));
54    }
55
56    static PassRefPtrWillBeRawPtr<Blob> create(PassRefPtr<BlobDataHandle> blobDataHandle)
57    {
58        return adoptRefWillBeNoop(new Blob(blobDataHandle));
59    }
60
61    virtual ~Blob();
62
63    virtual unsigned long long size() const { return m_blobDataHandle->size(); }
64    virtual PassRefPtrWillBeRawPtr<Blob> slice(long long start, long long end, const String& contentType, ExceptionState&) const;
65
66    // To allow ExceptionState to be passed in last, manually enumerate the optional argument overloads.
67    PassRefPtrWillBeRawPtr<Blob> slice(ExceptionState& exceptionState) const
68    {
69        return slice(0, std::numeric_limits<long long>::max(), String(), exceptionState);
70    }
71    PassRefPtrWillBeRawPtr<Blob> slice(long long start, ExceptionState& exceptionState) const
72    {
73        return slice(start, std::numeric_limits<long long>::max(), String(), exceptionState);
74    }
75    PassRefPtrWillBeRawPtr<Blob> slice(long long start, long long end, ExceptionState& exceptionState) const
76    {
77        return slice(start, end, String(), exceptionState);
78    }
79
80    virtual void close(ExecutionContext*, ExceptionState&);
81
82    String type() const { return m_blobDataHandle->type(); }
83    String uuid() const { return m_blobDataHandle->uuid(); }
84    PassRefPtr<BlobDataHandle> blobDataHandle() const { return m_blobDataHandle; }
85    // True for all File instances, including the user-built ones.
86    virtual bool isFile() const { return false; }
87    // Only true for File instances that are backed by platform files.
88    virtual bool hasBackingFile() const { return false; }
89    bool hasBeenClosed() const { return m_hasBeenClosed; }
90
91    // Used by the JavaScript Blob and File constructors.
92    virtual void appendTo(BlobData&) const;
93
94    // URLRegistrable to support PublicURLs.
95    virtual URLRegistry& registry() const OVERRIDE FINAL;
96
97    void trace(Visitor*) { }
98
99protected:
100    explicit Blob(PassRefPtr<BlobDataHandle>);
101
102    static void clampSliceOffsets(long long size, long long& start, long long& end);
103private:
104    Blob();
105
106    RefPtr<BlobDataHandle> m_blobDataHandle;
107    bool m_hasBeenClosed;
108};
109
110} // namespace blink
111
112#endif // Blob_h
113