bea7d0f0823cb31469b88e2f41bc04707d188f87
[WebKit-https.git] / Source / WebCore / bindings / v8 / V8Utilities.h
1 /*
2  * Copyright (C) 2006, 2007, 2008, 2009 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 V8Utilities_h
32 #define V8Utilities_h
33
34 #include <wtf/Forward.h>
35 #include <v8.h>
36
37 #include "OwnHandle.h"
38
39 namespace WebCore {
40
41     class EventListener;
42     class Frame;
43     class KURL;
44     class ScriptExecutionContext;
45     class ScriptState;
46
47     // Use an array to hold dependents. It works like a ref-counted scheme. A value can be added more than once to the DOM object.
48     void createHiddenDependency(v8::Handle<v8::Object>, v8::Local<v8::Value>, int cacheIndex);
49     void removeHiddenDependency(v8::Handle<v8::Object>, v8::Local<v8::Value>, int cacheIndex);
50
51     // Combo create/remove, for generated event-handler-setter bindings:
52     void transferHiddenDependency(v8::Handle<v8::Object>, EventListener* oldValue, v8::Local<v8::Value> newValue, int cacheIndex);
53
54     bool shouldAllowNavigation(Frame*);
55     KURL completeURL(const String& relativeURL);
56
57     ScriptExecutionContext* getScriptExecutionContext();
58
59     void throwTypeMismatchException();
60
61     enum CallbackAllowedValueFlag {
62         CallbackAllowUndefined = 1,
63         CallbackAllowNull = 1 << 1
64     };
65
66     typedef unsigned CallbackAllowedValueFlags;
67
68     class V8LocalContext {
69     public:
70         V8LocalContext();
71         virtual ~V8LocalContext();
72     private:
73         v8::HandleScope m_handleScope;
74         v8::Persistent<v8::Context> m_context;
75     };
76
77     // 'FunctionOnly' is assumed for the created callback.
78     template <typename V8CallbackType>
79     PassRefPtr<V8CallbackType> createFunctionOnlyCallback(v8::Local<v8::Value> value, bool& succeeded, CallbackAllowedValueFlags acceptedValues = 0)
80     {
81         succeeded = true;
82
83         if (value->IsUndefined() && (acceptedValues & CallbackAllowUndefined))
84             return 0;
85
86         if (value->IsNull() && (acceptedValues & CallbackAllowNull))
87             return 0;
88
89         if (!value->IsFunction()) {
90             succeeded = false;
91             throwTypeMismatchException();
92             return 0;
93         }
94
95         return V8CallbackType::create(value, getScriptExecutionContext());
96     }
97
98 } // namespace WebCore
99
100 #endif // V8Utilities_h