7c756821c6e69a306a3a886aa009206c3482a571
[WebKit-https.git] / Source / WebCore / bindings / js / SerializedScriptValue.h
1 /*
2  * Copyright (C) 2009, 2013, 2016 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 #pragma once
28
29 #include <bindings/ScriptValue.h>
30 #include <heap/Strong.h>
31 #include <runtime/ArrayBuffer.h>
32 #include <runtime/JSCJSValue.h>
33 #include <wtf/Forward.h>
34 #include <wtf/RefCounted.h>
35 #include <wtf/text/WTFString.h>
36
37 typedef const struct OpaqueJSContext* JSContextRef;
38 typedef const struct OpaqueJSValue* JSValueRef;
39
40 namespace WebCore {
41
42 class IDBValue;
43 class MessagePort;
44 typedef Vector<RefPtr<MessagePort>, 1> MessagePortArray;
45 typedef Vector<RefPtr<JSC::ArrayBuffer>, 1> ArrayBufferArray;
46  
47 enum SerializationReturnCode {
48     SuccessfullyCompleted,
49     StackOverflowError,
50     InterruptedExecutionError,
51     ValidationError,
52     ExistingExceptionError,
53     DataCloneError,
54     UnspecifiedError
55 };
56     
57 enum SerializationErrorMode { NonThrowing, Throwing };
58
59 class SharedBuffer;
60
61 class SerializedScriptValue : public ThreadSafeRefCounted<SerializedScriptValue> {
62 public:
63     WEBCORE_EXPORT static RefPtr<SerializedScriptValue> create(JSC::ExecState*, JSC::JSValue, MessagePortArray*, ArrayBufferArray*, SerializationErrorMode = Throwing);
64
65     WEBCORE_EXPORT static RefPtr<SerializedScriptValue> create(StringView);
66     static Ref<SerializedScriptValue> adopt(Vector<uint8_t>&& buffer)
67     {
68         return adoptRef(*new SerializedScriptValue(WTFMove(buffer)));
69     }
70
71     static Ref<SerializedScriptValue> nullValue();
72
73     WEBCORE_EXPORT JSC::JSValue deserialize(JSC::ExecState*, JSC::JSGlobalObject*, MessagePortArray*, SerializationErrorMode = Throwing);
74     JSC::JSValue deserialize(JSC::ExecState*, JSC::JSGlobalObject*, MessagePortArray*, SerializationErrorMode, const Vector<String>& blobURLs, const Vector<String>& blobFilePaths);
75
76     static uint32_t wireFormatVersion();
77
78     String toString();
79
80     // API implementation helpers. These don't expose special behavior for ArrayBuffers or MessagePorts.
81     WEBCORE_EXPORT static RefPtr<SerializedScriptValue> create(JSContextRef, JSValueRef, JSValueRef* exception);
82     WEBCORE_EXPORT JSValueRef deserialize(JSContextRef, JSValueRef* exception);
83
84     const Vector<uint8_t>& data() const { return m_data; }
85     bool hasBlobURLs() const { return !m_blobURLs.isEmpty(); }
86
87 #if ENABLE(INDEXED_DATABASE)
88     Vector<String> blobURLsIsolatedCopy() const;
89     void writeBlobsToDiskForIndexedDB(std::function<void (const IDBValue&)> completionHandler);
90     IDBValue writeBlobsToDiskForIndexedDBSynchronously();
91 #endif // ENABLE(INDEXED_DATABASE)
92
93     static Ref<SerializedScriptValue> createFromWireBytes(Vector<uint8_t>&& data)
94     {
95         return adoptRef(*new SerializedScriptValue(WTFMove(data)));
96     }
97     const Vector<uint8_t>& toWireBytes() const { return m_data; }
98
99     WEBCORE_EXPORT ~SerializedScriptValue();
100
101 private:
102     typedef Vector<JSC::ArrayBufferContents> ArrayBufferContentsArray;
103     static void maybeThrowExceptionIfSerializationFailed(JSC::ExecState*, SerializationReturnCode);
104     static bool serializationDidCompleteSuccessfully(SerializationReturnCode);
105     static std::unique_ptr<ArrayBufferContentsArray> transferArrayBuffers(JSC::ExecState*, ArrayBufferArray&, SerializationReturnCode&);
106
107     WEBCORE_EXPORT SerializedScriptValue(Vector<unsigned char>&&);
108     SerializedScriptValue(Vector<unsigned char>&&, const Vector<String>& blobURLs, std::unique_ptr<ArrayBufferContentsArray>&&);
109
110     Vector<unsigned char> m_data;
111     std::unique_ptr<ArrayBufferContentsArray> m_arrayBufferContentsArray;
112
113     Vector<String> m_blobURLs;
114 };
115
116 }