src/third_party/WebKit/Source/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 "bindings/v8/ScriptValue.h"
  35 #include "wtf/HashMap.h"
  36 #include "wtf/ThreadSafeRefCounted.h"
  37 #include <v8.h>
  38
  39 namespace blink {
  40
  41 class WebBlobInfo;
  42
  43 }
  44
  45 namespace WTF {
  46
  47 class ArrayBuffer;
  48 class ArrayBufferContents;
  49
  50 }
  51
  52 namespace WebCore {
  53
  54 class BlobDataHandle;
  55 class ExceptionState;
  56 class MessagePort;
  57
  58 typedef Vector<RefPtr<MessagePort>, 1> MessagePortArray;
  59 typedef Vector<RefPtr<WTF::ArrayBuffer>, 1> ArrayBufferArray;
  60 typedef HashMap<String, RefPtr<BlobDataHandle> > BlobDataHandleMap;
  61 typedef Vector<blink::WebBlobInfo> WebBlobInfoArray;
  62
  63 class SerializedScriptValue FINAL : public ThreadSafeRefCounted<SerializedScriptValue> {
  64 public:
  65     // Increment this for each incompatible change to the wire format.
  66     // Version 2: Added StringUCharTag for UChar v8 strings.
  67     // Version 3: Switched to using uuids as blob data identifiers.
  68     // Version 4: Extended File serialization to be complete.
  69     // Version 5: Added CryptoKeyTag for Key objects.
  70     // Version 6: Added indexed serialization for File, Blob, and FileList.
  71     static const uint32_t wireFormatVersion = 6;
  72
  73     ~SerializedScriptValue();
  74
  75     // If a serialization error occurs (e.g., cyclic input value) this
  76     // function returns an empty representation, schedules a V8 exception to
  77     // be thrown using v8::ThrowException(), and sets |didThrow|. In this case
  78     // the caller must not invoke any V8 operations until control returns to
  79     // V8. When serialization is successful, |didThrow| is false.
  80     static PassRefPtr<SerializedScriptValue> create(v8::Handle<v8::Value>, MessagePortArray*, ArrayBufferArray*, ExceptionState&, v8::Isolate*);
  81     static PassRefPtr<SerializedScriptValue> createFromWire(const String&);
  82     static PassRefPtr<SerializedScriptValue> createFromWireBytes(const Vector<uint8_t>&);
  83     static PassRefPtr<SerializedScriptValue> create(const String&);
  84     static PassRefPtr<SerializedScriptValue> create(const String&, v8::Isolate*);
  85     static PassRefPtr<SerializedScriptValue> create();
  86     static PassRefPtr<SerializedScriptValue> create(const ScriptValue&, WebBlobInfoArray*, ExceptionState&, v8::Isolate*);
  87
  88     // Never throws exceptions.
  89     static PassRefPtr<SerializedScriptValue> createAndSwallowExceptions(v8::Handle<v8::Value>, v8::Isolate*);
  90
  91     static PassRefPtr<SerializedScriptValue> nullValue();
  92
  93     String toWireString() const { return m_data; }
  94     void toWireBytes(Vector<char>&) const;
  95
  96     // Deserializes the value (in the current context). Returns a null value in
  97     // case of failure.
  98     v8::Handle<v8::Value> deserialize(MessagePortArray* = 0);
  99     v8::Handle<v8::Value> deserialize(v8::Isolate*, MessagePortArray* = 0, const WebBlobInfoArray* = 0);
 100
 101     // Helper function which pulls the values out of a JS sequence and into a MessagePortArray.
 102     // Also validates the elements per sections 4.1.13 and 4.1.15 of the WebIDL spec and section 8.3.3
 103     // of the HTML5 spec and generates exceptions as appropriate.
 104     // Returns true if the array was filled, or false if the passed value was not of an appropriate type.
 105     static bool extractTransferables(v8::Local<v8::Value>, int, MessagePortArray&, ArrayBufferArray&, ExceptionState&, v8::Isolate*);
 106
 107     // Only reflects the truth if the SSV was created by walking a v8 value, not reliable
 108     // if the SSV was created createdFromWire(data).
 109     bool containsBlobs() const { return !m_blobDataHandles.isEmpty(); }
 110
 111     // Informs the V8 about external memory allocated and owned by this object. Large values should contribute
 112     // to GC counters to eventually trigger a GC, otherwise flood of postMessage() can cause OOM.
 113     // Ok to invoke multiple times (only adds memory once).
 114     // The memory registration is revoked automatically in destructor.
 115     void registerMemoryAllocatedWithCurrentScriptContext();
 116
 117 private:
 118     enum StringDataMode {
 119         StringValue,
 120         WireData
 121     };
 122     typedef Vector<WTF::ArrayBufferContents, 1> ArrayBufferContentsArray;
 123
 124     SerializedScriptValue();
 125     SerializedScriptValue(v8::Handle<v8::Value>, MessagePortArray*, ArrayBufferArray*, WebBlobInfoArray*, ExceptionState&, v8::Isolate*);
 126     explicit SerializedScriptValue(const String& wireData);
 127
 128     static PassOwnPtr<ArrayBufferContentsArray> transferArrayBuffers(ArrayBufferArray&, ExceptionState&, v8::Isolate*);
 129
 130     String m_data;
 131     OwnPtr<ArrayBufferContentsArray> m_arrayBufferContentsArray;
 132     BlobDataHandleMap m_blobDataHandles;
 133     intptr_t m_externallyAllocatedMemory;
 134 };
 135
 136 } // namespace WebCore
 137
 138 #endif // SerializedScriptValue_h