Home | History | Annotate | Download | only in js 
      1 /*
      2  * Copyright (C) 2009 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 COMPUTER, 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 COMPUTER, 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 #ifndef SerializedScriptValue_h
     28 #define SerializedScriptValue_h
     29 
     30 #include <heap/Strong.h>
     31 #include <runtime/JSValue.h>
     32 #include <wtf/Forward.h>
     33 #include <wtf/PassRefPtr.h>
     34 #include <wtf/RefCounted.h>
     35 
     36 typedef const struct OpaqueJSContext* JSContextRef;
     37 typedef const struct OpaqueJSValue* JSValueRef;
     38 
     39 namespace WebCore {
     40 
     41 
     42 enum SerializationReturnCode {
     43     SuccessfullyCompleted,
     44     StackOverflowError,
     45     InterruptedExecutionError,
     46     ValidationError,
     47     ExistingExceptionError,
     48     UnspecifiedError
     49 };
     50 
     51 enum SerializationErrorMode { NonThrowing, Throwing };
     52 
     53 class SharedBuffer;
     54 
     55 class SerializedScriptValue : public RefCounted<SerializedScriptValue> {
     56 public:
     57     static PassRefPtr<SerializedScriptValue> create(JSC::ExecState*, JSC::JSValue, SerializationErrorMode = Throwing);
     58     static PassRefPtr<SerializedScriptValue> create(JSContextRef, JSValueRef value, JSValueRef* exception);
     59     static PassRefPtr<SerializedScriptValue> create(String string);
     60     static PassRefPtr<SerializedScriptValue> adopt(Vector<uint8_t>& buffer)
     61     {
     62         return adoptRef(new SerializedScriptValue(buffer));
     63     }
     64 
     65     static PassRefPtr<SerializedScriptValue> create();
     66     static SerializedScriptValue* nullValue();
     67 
     68     String toString();
     69 
     70     JSC::JSValue deserialize(JSC::ExecState*, JSC::JSGlobalObject*, SerializationErrorMode = Throwing);
     71     JSValueRef deserialize(JSContextRef, JSValueRef* exception);
     72 
     73     const Vector<uint8_t>& data() { return m_data; }
     74 
     75     ~SerializedScriptValue();
     76 
     77 private:
     78     static void maybeThrowExceptionIfSerializationFailed(JSC::ExecState*, SerializationReturnCode);
     79     static bool serializationDidCompleteSuccessfully(SerializationReturnCode);
     80 
     81     SerializedScriptValue(Vector<unsigned char>&);
     82     Vector<unsigned char> m_data;
     83 };
     84 
     85 }
     86 
     87 #endif // SerializedScriptValue_h
     88