Objective-C API: Rename JSValue.h/APIJSValue.h to JSCJSValue.h/JSValue.h
[WebKit-https.git] / Source / WebCore / bindings / js / ScriptValue.h
1 /*
2  * Copyright (c) 2008, 2011 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 ScriptValue_h
32 #define ScriptValue_h
33
34 #include "SerializedScriptValue.h"
35 #include "ScriptState.h"
36 #include <heap/Strong.h>
37 #include <heap/StrongInlines.h>
38 #include <runtime/JSCJSValue.h>
39 #include <runtime/Operations.h>
40 #include <wtf/PassRefPtr.h>
41 #include <wtf/text/WTFString.h>
42
43 namespace WebCore {
44
45 class InspectorValue;
46 class SerializedScriptValue;
47
48 class ScriptValue {
49 public:
50     ScriptValue() { }
51     ScriptValue(JSC::JSGlobalData& globalData, JSC::JSValue value) : m_value(globalData, value) {}
52     virtual ~ScriptValue() {}
53
54     JSC::JSValue jsValue() const { return m_value.get(); }
55     bool getString(ScriptState*, String& result) const;
56     String toString(ScriptState*) const;
57     bool isEqual(ScriptState*, const ScriptValue&) const;
58     bool isNull() const;
59     bool isUndefined() const;
60     bool isObject() const;
61     bool isFunction() const;
62     bool hasNoValue() const { return !m_value; }
63
64     void clear() { m_value.clear(); }
65
66     bool operator==(const ScriptValue& other) const { return m_value == other.m_value; }
67
68     PassRefPtr<SerializedScriptValue> serialize(ScriptState*, SerializationErrorMode = Throwing);
69     PassRefPtr<SerializedScriptValue> serialize(ScriptState*, MessagePortArray*, ArrayBufferArray*, bool&);
70     static ScriptValue deserialize(ScriptState*, SerializedScriptValue*, SerializationErrorMode = Throwing);
71
72 #if ENABLE(INSPECTOR)
73     PassRefPtr<InspectorValue> toInspectorValue(ScriptState*) const;
74 #endif
75
76 private:
77     JSC::Strong<JSC::Unknown> m_value;
78 };
79
80 } // namespace WebCore
81
82 #endif // ScriptValue_h