https://bugs.webkit.org/show_bug.cgi?id=73503
[WebKit-https.git] / Source / WebCore / bindings / v8 / SerializedScriptValue.h
1 /*
2  * Copyright (C) 2009, 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 SerializedScriptValue_h
32 #define SerializedScriptValue_h
33
34 #include "ArrayBuffer.h"
35 #include "ScriptValue.h"
36 #include <v8.h>
37 #include <wtf/Threading.h>
38
39 namespace WebCore {
40
41 class MessagePort;
42
43 typedef Vector<RefPtr<MessagePort>, 1> MessagePortArray;
44 typedef Vector<RefPtr<WTF::ArrayBuffer>, 1> ArrayBufferArray;
45
46 class SerializedScriptValue : public ThreadSafeRefCounted<SerializedScriptValue> {
47 public:
48     static void deserializeAndSetProperty(v8::Handle<v8::Object>, const char* propertyName,
49                                           v8::PropertyAttribute, SerializedScriptValue*);
50     static void deserializeAndSetProperty(v8::Handle<v8::Object>, const char* propertyName,
51                                           v8::PropertyAttribute, PassRefPtr<SerializedScriptValue>);
52
53     // If a serialization error occurs (e.g., cyclic input value) this
54     // function returns an empty representation, schedules a V8 exception to
55     // be thrown using v8::ThrowException(), and sets |didThrow|. In this case
56     // the caller must not invoke any V8 operations until control returns to
57     // V8. When serialization is successful, |didThrow| is false.
58     static PassRefPtr<SerializedScriptValue> create(v8::Handle<v8::Value>,
59                                                     MessagePortArray*, ArrayBufferArray*,
60                                                     bool& didThrow);
61     static PassRefPtr<SerializedScriptValue> create(v8::Handle<v8::Value>);
62     static PassRefPtr<SerializedScriptValue> createFromWire(const String& data);
63     static PassRefPtr<SerializedScriptValue> create(const String& data);
64     static PassRefPtr<SerializedScriptValue> create();
65
66     static SerializedScriptValue* nullValue();
67     static PassRefPtr<SerializedScriptValue> undefinedValue();
68     static PassRefPtr<SerializedScriptValue> booleanValue(bool value);
69
70     PassRefPtr<SerializedScriptValue> release();
71
72     String toWireString() const { return m_data; }
73
74     // Deserializes the value (in the current context). Returns a null value in
75     // case of failure.
76     v8::Handle<v8::Value> deserialize(MessagePortArray* = 0);
77
78 private:
79     enum StringDataMode {
80         StringValue,
81         WireData
82     };
83     typedef Vector<WTF::ArrayBufferContents, 1> ArrayBufferContentsArray;
84
85     SerializedScriptValue();
86     SerializedScriptValue(v8::Handle<v8::Value>, MessagePortArray*, ArrayBufferArray*, bool& didThrow);
87     explicit SerializedScriptValue(const String& wireData);
88
89     static PassOwnPtr<ArrayBufferContentsArray> transferArrayBuffers(ArrayBufferArray&, bool& didThrow);
90
91     String m_data;
92     OwnPtr<ArrayBufferContentsArray> m_arrayBufferContentsArray;
93 };
94
95 } // namespace WebCore
96
97 #endif // SerializedScriptValue_h