2011-01-07 Adam Barth <abarth@webkit.org>
[WebKit-https.git] / Source / WebCore / bindings / js / ScriptValue.h
1 /*
2  * Copyright (c) 2008, 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 "JSDOMBinding.h"
35 #include "PlatformString.h"
36 #include "ScriptState.h"
37 #include <runtime/JSValue.h>
38 #include <runtime/Protect.h>
39 #include <wtf/PassRefPtr.h>
40
41 namespace WebCore {
42
43 class InspectorValue;
44 class SerializedScriptValue;
45
46 class ScriptValue {
47 public:
48     ScriptValue(JSC::JSValue value = JSC::JSValue()) : m_value(value) {}
49     virtual ~ScriptValue() {}
50
51     JSC::JSValue jsValue() const { return m_value.get(); }
52     bool getString(ScriptState*, String& result) const;
53     String toString(ScriptState* scriptState) const { return ustringToString(m_value.get().toString(scriptState)); }
54     bool isEqual(ScriptState*, const ScriptValue&) const;
55     bool isNull() const;
56     bool isUndefined() const;
57     bool isObject() const;
58     bool isFunction() const;
59     bool hasNoValue() const { return m_value == JSC::JSValue(); }
60
61     bool operator==(const ScriptValue& other) const { return m_value == other.m_value; }
62
63     PassRefPtr<SerializedScriptValue> serialize(ScriptState*);
64     static ScriptValue deserialize(ScriptState*, SerializedScriptValue*);
65
66     static ScriptValue undefined() { return ScriptValue(JSC::jsUndefined()); }
67
68 #if ENABLE(INSPECTOR)
69     PassRefPtr<InspectorValue> toInspectorValue(ScriptState*) const;
70 #endif
71
72 private:
73     JSC::ProtectedJSValue m_value;
74 };
75
76 } // namespace WebCore
77
78 #endif // ScriptValue_h