initial import
[vuplus_webkit] / Source / WebCore / bindings / v8 / V8DOMWrapper.h
1 /*
2  * Copyright (C) 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 V8DOMWrapper_h
32 #define V8DOMWrapper_h
33
34 #include "Event.h"
35 #include "IsolatedWorld.h"
36 #include "Node.h"
37 #include "NodeFilter.h"
38 #include "PlatformString.h"
39 #include "V8CustomXPathNSResolver.h"
40 #include "V8Event.h"
41 #include "V8Utilities.h"
42 #include "V8XPathNSResolver.h"
43 #include "WrapperTypeInfo.h"
44 #include "XPathNSResolver.h"
45 #include <v8.h>
46 #include <wtf/MainThread.h>
47
48 namespace WebCore {
49
50     class DOMWindow;
51     class EventTarget;
52     class Frame;
53     class Node;
54     class V8Proxy;
55     class WorkerContext;
56
57     enum ListenerLookupType {
58         ListenerFindOnly,
59         ListenerFindOrCreate,
60     };
61
62     class V8DOMWrapper {
63     public:
64 #ifndef NDEBUG
65         // Checks if a v8 value can be a DOM wrapper
66         static bool maybeDOMWrapper(v8::Handle<v8::Value>);
67 #endif
68
69         // Sets contents of a DOM wrapper.
70         static void setDOMWrapper(v8::Handle<v8::Object> object, WrapperTypeInfo* type, void* cptr)
71         {
72             ASSERT(object->InternalFieldCount() >= 2);
73             object->SetPointerInInternalField(v8DOMWrapperObjectIndex, cptr);
74             object->SetPointerInInternalField(v8DOMWrapperTypeIndex, type);
75         }
76
77         static v8::Handle<v8::Object> lookupDOMWrapper(v8::Handle<v8::FunctionTemplate> functionTemplate, v8::Handle<v8::Object> object)
78         {
79             return object.IsEmpty() ? object : object->FindInstanceInPrototypeChain(functionTemplate);
80         }
81
82         static WrapperTypeInfo* domWrapperType(v8::Handle<v8::Object>);
83
84         static v8::Handle<v8::Value> convertEventTargetToV8Object(PassRefPtr<EventTarget> eventTarget)
85         {
86             return convertEventTargetToV8Object(eventTarget.get());
87         }
88
89         static v8::Handle<v8::Value> convertEventTargetToV8Object(EventTarget*);
90
91         static PassRefPtr<EventListener> getEventListener(v8::Local<v8::Value> value, bool isAttribute, ListenerLookupType lookup);
92
93 #if ENABLE(XPATH)
94         // XPath-related utilities
95         static RefPtr<XPathNSResolver> getXPathNSResolver(v8::Handle<v8::Value> value, V8Proxy* proxy = 0);
96 #endif
97
98         // Wrap JS node filter in C++.
99         static PassRefPtr<NodeFilter> wrapNativeNodeFilter(v8::Handle<v8::Value>);
100
101         static v8::Local<v8::Function> getConstructorForContext(WrapperTypeInfo*, v8::Handle<v8::Context>);
102         static v8::Local<v8::Function> getConstructor(WrapperTypeInfo*, v8::Handle<v8::Value> objectPrototype);
103         static v8::Local<v8::Function> getConstructor(WrapperTypeInfo*, DOMWindow*);
104 #if ENABLE(WORKERS)
105         static v8::Local<v8::Function> getConstructor(WrapperTypeInfo*, WorkerContext*);
106 #endif
107
108         // Set JS wrapper of a DOM object, the caller in charge of increase ref.
109         static void setJSWrapperForDOMObject(void*, v8::Persistent<v8::Object>);
110         static void setJSWrapperForActiveDOMObject(void*, v8::Persistent<v8::Object>);
111         static void setJSWrapperForDOMNode(Node*, v8::Persistent<v8::Object>);
112
113         static bool isValidDOMObject(v8::Handle<v8::Value>);
114
115         // Check whether a V8 value is a wrapper of type |classType|.
116         static bool isWrapperOfType(v8::Handle<v8::Value>, WrapperTypeInfo*);
117
118         // Proper object lifetime support.
119         //
120         // Helper functions to make sure the child object stays alive
121         // while the parent is alive. Using the name more than once
122         // overwrites previous references making it possible to free
123         // old children.
124         static void setNamedHiddenReference(v8::Handle<v8::Object> parent, const char* name, v8::Handle<v8::Value> child);
125         static void setNamedHiddenWindowReference(Frame*, const char*, v8::Handle<v8::Value>);
126
127         static v8::Local<v8::Object> instantiateV8Object(V8Proxy* proxy, WrapperTypeInfo*, void* impl);
128
129         static v8::Handle<v8::Object> getWrapper(Node* node)
130         {
131             ASSERT(isMainThread());
132             if (LIKELY(!IsolatedWorld::count())) {
133                 v8::Persistent<v8::Object>* wrapper = node->wrapper();
134                 if (wrapper)
135                     return *wrapper;
136             }
137             return getWrapperSlow(node);
138         }
139
140     private:
141         static v8::Handle<v8::Object> getWrapperSlow(Node*);
142     };
143
144 }
145
146 #endif // V8DOMWrapper_h