d366b3067c126bed40e39d7ebb6d8264d58908ba
[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 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 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 <bindings/ScriptValue.h>
32 #include <heap/Strong.h>
33 #include <runtime/ArrayBuffer.h>
34 #include <runtime/JSCJSValue.h>
35 #include <wtf/Forward.h>
36 #include <wtf/PassRefPtr.h>
37 #include <wtf/RefCounted.h>
38 #include <wtf/text/WTFString.h>
39
40 typedef const struct OpaqueJSContext* JSContextRef;
41 typedef const struct OpaqueJSValue* JSValueRef;
42
43 namespace WebCore {
44
45 class MessagePort;
46 typedef Vector<RefPtr<MessagePort>, 1> MessagePortArray;
47 typedef Vector<RefPtr<JSC::ArrayBuffer>, 1> ArrayBufferArray;
48  
49 enum SerializationReturnCode {
50     SuccessfullyCompleted,
51     StackOverflowError,
52     InterruptedExecutionError,
53     ValidationError,
54     ExistingExceptionError,
55     DataCloneError,
56     UnspecifiedError
57 };
58     
59 enum SerializationErrorMode { NonThrowing, Throwing };
60
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     WEBCORE_EXPORT static PassRefPtr<SerializedScriptValue> create(JSC::ExecState*, JSC::JSValue, MessagePortArray*, ArrayBufferArray*, SerializationErrorMode = Throwing);
71
72     WEBCORE_EXPORT static PassRefPtr<SerializedScriptValue> create(const String&);
73     static PassRefPtr<SerializedScriptValue> adopt(Vector<uint8_t>& buffer)
74     {
75         return adoptRef(new SerializedScriptValue(buffer));
76     }
77
78     static PassRefPtr<SerializedScriptValue> nullValue();
79
80     WEBCORE_EXPORT JSC::JSValue deserialize(JSC::ExecState*, JSC::JSGlobalObject*, MessagePortArray*, SerializationErrorMode = Throwing);
81
82     static uint32_t wireFormatVersion();
83
84     String toString();
85
86     // API implementation helpers. These don't expose special behavior for ArrayBuffers or MessagePorts.
87     WEBCORE_EXPORT static PassRefPtr<SerializedScriptValue> create(JSContextRef, JSValueRef, JSValueRef* exception);
88     WEBCORE_EXPORT JSValueRef deserialize(JSContextRef, JSValueRef* exception);
89
90     const Vector<uint8_t>& data() const { return m_data; }
91     bool hasBlobURLs() const { return !m_blobURLs.isEmpty(); }
92     void blobURLs(Vector<String>&) const;
93
94 #if ENABLE(INDEXED_DATABASE)
95     // FIXME: Get rid of these. The only caller immediately deserializes the result, so it's a very roundabout way to create a JSValue.
96     static PassRefPtr<SerializedScriptValue> numberValue(double value);
97     static PassRefPtr<SerializedScriptValue> undefinedValue();
98 #endif
99
100     static PassRefPtr<SerializedScriptValue> createFromWireBytes(const Vector<uint8_t>& data)
101     {
102         return adoptRef(new SerializedScriptValue(data));
103     }
104     const Vector<uint8_t>& toWireBytes() const { return m_data; }
105
106     WEBCORE_EXPORT ~SerializedScriptValue();
107
108 private:
109     typedef Vector<JSC::ArrayBufferContents> ArrayBufferContentsArray;
110     static void maybeThrowExceptionIfSerializationFailed(JSC::ExecState*, SerializationReturnCode);
111     static bool serializationDidCompleteSuccessfully(SerializationReturnCode);
112     static std::unique_ptr<ArrayBufferContentsArray> transferArrayBuffers(JSC::ExecState*, ArrayBufferArray&, SerializationReturnCode&);
113     void addBlobURL(const String&);
114
115     SerializedScriptValue(const Vector<unsigned char>&);
116     WEBCORE_EXPORT SerializedScriptValue(Vector<unsigned char>&);
117     SerializedScriptValue(Vector<unsigned char>&, Vector<String>& blobURLs);
118     SerializedScriptValue(Vector<unsigned char>&, Vector<String>& blobURLs, std::unique_ptr<ArrayBufferContentsArray>);
119
120     Vector<unsigned char> m_data;
121     std::unique_ptr<ArrayBufferContentsArray> m_arrayBufferContentsArray;
122     Vector<Vector<uint16_t>> m_blobURLs;
123 };
124
125 }
126
127 #endif // SerializedScriptValue_h