[Chromium] IndexedDB: Assertion failure when storing File objects
[WebKit-https.git] / Source / WebCore / bindings / js / SerializedScriptValue.h
1 /*
2  * Copyright (C) 2009 Apple 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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  *
25  */
26
27 #ifndef SerializedScriptValue_h
28 #define SerializedScriptValue_h
29
30 #include "PlatformString.h"
31 #include "ScriptState.h"
32 #include <heap/Strong.h>
33 #include <runtime/JSValue.h>
34 #include <wtf/ArrayBuffer.h>
35 #include <wtf/Forward.h>
36 #include <wtf/PassRefPtr.h>
37 #include <wtf/RefCounted.h>
38
39 typedef const struct OpaqueJSContext* JSContextRef;
40 typedef const struct OpaqueJSValue* JSValueRef;
41
42 namespace WebCore {
43
44 class MessagePort;
45 typedef Vector<RefPtr<MessagePort>, 1> MessagePortArray;
46 typedef Vector<RefPtr<WTF::ArrayBuffer>, 1> ArrayBufferArray;
47  
48 enum SerializationReturnCode {
49     SuccessfullyCompleted,
50     StackOverflowError,
51     InterruptedExecutionError,
52     ValidationError,
53     ExistingExceptionError,
54     UnspecifiedError
55 };
56     
57 enum SerializationErrorMode { NonThrowing, Throwing };
58
59 class ScriptValue;
60 class SharedBuffer;
61
62 class SerializedScriptValue :
63 #if ENABLE(INDEXED_DATABASE)
64     public ThreadSafeRefCounted<SerializedScriptValue> {
65 #else
66     public RefCounted<SerializedScriptValue> {
67 #endif
68 public:
69     static PassRefPtr<SerializedScriptValue> create(JSC::ExecState*, JSC::JSValue, MessagePortArray*, ArrayBufferArray*,
70                                                     SerializationErrorMode = Throwing);
71     static PassRefPtr<SerializedScriptValue> create(JSContextRef, JSValueRef, MessagePortArray*, ArrayBufferArray*, JSValueRef* exception);
72     static PassRefPtr<SerializedScriptValue> create(JSContextRef, JSValueRef, JSValueRef* exception);
73
74     static PassRefPtr<SerializedScriptValue> create(const String&);
75     static PassRefPtr<SerializedScriptValue> adopt(Vector<uint8_t>& buffer)
76     {
77         return adoptRef(new SerializedScriptValue(buffer));
78     }
79
80     static PassRefPtr<SerializedScriptValue> create();
81     static SerializedScriptValue* nullValue();
82     static PassRefPtr<SerializedScriptValue> undefinedValue();
83     static PassRefPtr<SerializedScriptValue> booleanValue(bool value);
84
85     String toString();
86     
87     JSC::JSValue deserialize(JSC::ExecState*, JSC::JSGlobalObject*, MessagePortArray*, SerializationErrorMode = Throwing);
88     JSValueRef deserialize(JSContextRef, JSValueRef* exception, MessagePortArray*);
89     JSValueRef deserialize(JSContextRef, JSValueRef* exception);
90
91 #if ENABLE(INSPECTOR)
92     ScriptValue deserializeForInspector(ScriptState*);
93 #endif
94
95     const Vector<uint8_t>& data() { return m_data; }
96     const Vector<String>& blobURLs() const { return m_blobURLs; }
97
98 #if ENABLE(INDEXED_DATABASE)
99     static PassRefPtr<SerializedScriptValue> create(JSC::ExecState*, JSC::JSValue);
100     static PassRefPtr<SerializedScriptValue> createFromWire(const String& data);
101     String toWireString() const;
102     static PassRefPtr<SerializedScriptValue> numberValue(double value);
103     JSC::JSValue deserialize(JSC::ExecState*, JSC::JSGlobalObject*);
104 #endif
105
106     ~SerializedScriptValue();
107
108 private:
109     typedef Vector<WTF::ArrayBufferContents> ArrayBufferContentsArray;
110     static void maybeThrowExceptionIfSerializationFailed(JSC::ExecState*, SerializationReturnCode);
111     static bool serializationDidCompleteSuccessfully(SerializationReturnCode);
112     static PassOwnPtr<ArrayBufferContentsArray> transferArrayBuffers(ArrayBufferArray&, SerializationReturnCode&);
113
114     SerializedScriptValue(Vector<unsigned char>&);
115     SerializedScriptValue(Vector<unsigned char>&, Vector<String>& blobURLs);
116     SerializedScriptValue(Vector<unsigned char>&, Vector<String>& blobURLs, PassOwnPtr<ArrayBufferContentsArray>);
117     Vector<unsigned char> m_data;
118     OwnPtr<ArrayBufferContentsArray> m_arrayBufferContentsArray;
119     Vector<String> m_blobURLs;
120 };
121
122 }
123
124 #endif // SerializedScriptValue_h