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