8abc7fc36cc29182d7ae126a690f2a65a2b445ea
[WebKit-https.git] / Source / WebCore / bindings / js / SerializedScriptValue.h
1 /*
2  * Copyright (C) 2009, 2013 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 "ScriptState.h"
31 #include <heap/Strong.h>
32 #include <runtime/ArrayBuffer.h>
33 #include <runtime/JSCJSValue.h>
34 #include <wtf/Forward.h>
35 #include <wtf/PassRefPtr.h>
36 #include <wtf/RefCounted.h>
37 #include <wtf/text/WTFString.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<JSC::ArrayBuffer>, 1> ArrayBufferArray;
47  
48 enum SerializationReturnCode {
49     SuccessfullyCompleted,
50     StackOverflowError,
51     InterruptedExecutionError,
52     ValidationError,
53     ExistingExceptionError,
54     DataCloneError,
55     UnspecifiedError
56 };
57     
58 enum SerializationErrorMode { NonThrowing, Throwing };
59
60 class ScriptValue;
61 class SharedBuffer;
62
63 class SerializedScriptValue :
64 #if ENABLE(INDEXED_DATABASE)
65     public ThreadSafeRefCounted<SerializedScriptValue> {
66 #else
67     public RefCounted<SerializedScriptValue> {
68 #endif
69 public:
70     static PassRefPtr<SerializedScriptValue> create(JSC::ExecState*, JSC::JSValue, MessagePortArray*, ArrayBufferArray*,
71                                                     SerializationErrorMode = Throwing);
72     static PassRefPtr<SerializedScriptValue> create(JSContextRef, JSValueRef, MessagePortArray*, ArrayBufferArray*, JSValueRef* exception);
73     static PassRefPtr<SerializedScriptValue> create(JSContextRef, JSValueRef, JSValueRef* exception);
74
75     static PassRefPtr<SerializedScriptValue> create(const String&);
76     static PassRefPtr<SerializedScriptValue> adopt(Vector<uint8_t>& buffer)
77     {
78         return adoptRef(new SerializedScriptValue(buffer));
79     }
80
81     static PassRefPtr<SerializedScriptValue> create();
82     static PassRefPtr<SerializedScriptValue> nullValue();
83     static PassRefPtr<SerializedScriptValue> undefinedValue();
84     static PassRefPtr<SerializedScriptValue> booleanValue(bool value);
85
86     static uint32_t wireFormatVersion();
87
88     String toString();
89     
90     JSC::JSValue deserialize(JSC::ExecState*, JSC::JSGlobalObject*, MessagePortArray*, SerializationErrorMode = Throwing);
91     JSValueRef deserialize(JSContextRef, JSValueRef* exception, MessagePortArray*);
92     JSValueRef deserialize(JSContextRef, JSValueRef* exception);
93
94 #if ENABLE(INSPECTOR)
95     ScriptValue deserializeForInspector(JSC::ExecState*);
96 #endif
97
98     const Vector<uint8_t>& data() { return m_data; }
99     const Vector<String>& blobURLs() const { return m_blobURLs; }
100
101 #if ENABLE(INDEXED_DATABASE)
102     static PassRefPtr<SerializedScriptValue> create(JSC::ExecState*, JSC::JSValue);
103     static PassRefPtr<SerializedScriptValue> numberValue(double value);
104     JSC::JSValue deserialize(JSC::ExecState*, JSC::JSGlobalObject*);
105 #endif
106
107     static PassRefPtr<SerializedScriptValue> createFromWireBytes(const Vector<uint8_t>& data)
108     {
109         return adoptRef(new SerializedScriptValue(data));
110     }
111     const Vector<uint8_t>& toWireBytes() const { return m_data; }
112
113     ~SerializedScriptValue();
114
115 private:
116     typedef Vector<JSC::ArrayBufferContents> ArrayBufferContentsArray;
117     static void maybeThrowExceptionIfSerializationFailed(JSC::ExecState*, SerializationReturnCode);
118     static bool serializationDidCompleteSuccessfully(SerializationReturnCode);
119     static PassOwnPtr<ArrayBufferContentsArray> transferArrayBuffers(JSC::ExecState*, ArrayBufferArray&, SerializationReturnCode&);
120
121     SerializedScriptValue(const Vector<unsigned char>&);
122     SerializedScriptValue(Vector<unsigned char>&);
123     SerializedScriptValue(Vector<unsigned char>&, Vector<String>& blobURLs);
124     SerializedScriptValue(Vector<unsigned char>&, Vector<String>& blobURLs, PassOwnPtr<ArrayBufferContentsArray>);
125     Vector<unsigned char> m_data;
126     OwnPtr<ArrayBufferContentsArray> m_arrayBufferContentsArray;
127     Vector<String> m_blobURLs;
128 };
129
130 }
131
132 #endif // SerializedScriptValue_h