Home | History | Annotate | Download | only in v8 
      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 WebCore {
     39 
     40 class SerializedScriptValue : public ThreadSafeRefCounted<SerializedScriptValue> {
     41 public:
     42     static void deserializeAndSetProperty(v8::Handle<v8::Object>, const char* propertyName,
     43                                           v8::PropertyAttribute, SerializedScriptValue*);
     44     static void deserializeAndSetProperty(v8::Handle<v8::Object>, const char* propertyName,
     45                                           v8::PropertyAttribute, PassRefPtr<SerializedScriptValue>);
     46 
     47     // If a serialization error occurs (e.g., cyclic input value) this
     48     // function returns an empty representation, schedules a V8 exception to
     49     // be thrown using v8::ThrowException(), and sets |didThrow|. In this case
     50     // the caller must not invoke any V8 operations until control returns to
     51     // V8. When serialization is successful, |didThrow| is false.
     52     static PassRefPtr<SerializedScriptValue> create(v8::Handle<v8::Value> value, bool& didThrow);
     53     static PassRefPtr<SerializedScriptValue> create(v8::Handle<v8::Value>);
     54     static PassRefPtr<SerializedScriptValue> createFromWire(String data);
     55     static PassRefPtr<SerializedScriptValue> create(String data);
     56     static PassRefPtr<SerializedScriptValue> create();
     57 
     58     static SerializedScriptValue* nullValue();
     59     static SerializedScriptValue* undefinedValue();
     60 
     61     PassRefPtr<SerializedScriptValue> release();
     62 
     63     String toWireString() const { return m_data; }
     64 
     65     // Deserializes the value (in the current context). Returns a null value in
     66     // case of failure.
     67     v8::Handle<v8::Value> deserialize();
     68 
     69 private:
     70     enum StringDataMode {
     71         StringValue,
     72         WireData
     73     };
     74 
     75     SerializedScriptValue();
     76     SerializedScriptValue(v8::Handle<v8::Value>, bool& didThrow);
     77     explicit SerializedScriptValue(String wireData);
     78 
     79     String m_data;
     80 };
     81 
     82 } // namespace WebCore
     83 
     84 #endif // SerializedScriptValue_h
     85