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