142be5a6bf8a24c136ccbda619590bc302c8c7b3
[WebKit-https.git] / 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 "DOMDataStore.h"
35 #include "Event.h"
36 #include "Node.h"
37 #include "NodeFilter.h"
38 #include "PlatformString.h"
39 #include "V8CustomXPathNSResolver.h"
40 #include "V8DOMMap.h"
41 #include "V8IsolatedContext.h"
42 #include "V8Utilities.h"
43 #include "WrapperTypeInfo.h"
44 #include <v8.h>
45 #include <wtf/MainThread.h>
46 #include <wtf/PassRefPtr.h>
47
48 namespace WebCore {
49
50     class DOMWindow;
51     class EventTarget;
52     class Frame;
53     class Node;
54     class V8PerContextData;
55     class V8Proxy;
56     class WorkerContext;
57     class XPathResolver;
58
59     enum ListenerLookupType {
60         ListenerFindOnly,
61         ListenerFindOrCreate,
62     };
63
64     class V8DOMWrapper {
65     public:
66 #ifndef NDEBUG
67         // Checks if a v8 value can be a DOM wrapper
68         static bool maybeDOMWrapper(v8::Handle<v8::Value>);
69 #endif
70
71         // Sets contents of a DOM wrapper.
72         static void setDOMWrapper(v8::Handle<v8::Object> object, WrapperTypeInfo* type, void* cptr)
73         {
74             ASSERT(object->InternalFieldCount() >= 2);
75             object->SetPointerInInternalField(v8DOMWrapperObjectIndex, cptr);
76             object->SetPointerInInternalField(v8DOMWrapperTypeIndex, type);
77         }
78
79         static v8::Handle<v8::Object> lookupDOMWrapper(v8::Handle<v8::FunctionTemplate> functionTemplate, v8::Handle<v8::Object> object)
80         {
81             return object.IsEmpty() ? object : object->FindInstanceInPrototypeChain(functionTemplate);
82         }
83
84         static WrapperTypeInfo* domWrapperType(v8::Handle<v8::Object>);
85
86         static v8::Handle<v8::Value> convertEventTargetToV8Object(PassRefPtr<EventTarget> eventTarget, v8::Isolate* isolate = 0)
87         {
88             return convertEventTargetToV8Object(eventTarget.get(), isolate);
89         }
90
91         static v8::Handle<v8::Value> convertEventTargetToV8Object(EventTarget*, v8::Isolate* = 0);
92
93         static PassRefPtr<EventListener> getEventListener(v8::Local<v8::Value> value, bool isAttribute, ListenerLookupType lookup);
94
95         // XPath-related utilities
96         static RefPtr<XPathNSResolver> getXPathNSResolver(v8::Handle<v8::Value> value, V8Proxy* proxy = 0);
97
98         // Wrap JS node filter in C++.
99         static PassRefPtr<NodeFilter> wrapNativeNodeFilter(v8::Handle<v8::Value>);
100
101         static v8::Local<v8::Function> constructorForType(WrapperTypeInfo*, DOMWindow*);
102 #if ENABLE(WORKERS)
103         static v8::Local<v8::Function> constructorForType(WrapperTypeInfo*, WorkerContext*);
104 #endif
105
106         template<typename T>
107         static v8::Persistent<v8::Object> setJSWrapperForDOMObject(PassRefPtr<T>, v8::Handle<v8::Object>, v8::Isolate* = 0);
108         template<typename T>
109         static v8::Persistent<v8::Object> setJSWrapperForActiveDOMObject(PassRefPtr<T>, v8::Handle<v8::Object>, v8::Isolate* = 0);
110         static v8::Persistent<v8::Object> setJSWrapperForDOMNode(PassRefPtr<Node>, v8::Handle<v8::Object>, v8::Isolate* = 0);
111         static v8::Persistent<v8::Object> setJSWrapperForActiveDOMNode(PassRefPtr<Node>, v8::Handle<v8::Object>, v8::Isolate* = 0);
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> getCachedWrapper(Node* node)
130         {
131             ASSERT(isMainThread());
132             if (LIKELY(!DOMWrapperWorld::count())) {
133                 v8::Persistent<v8::Object>* wrapper = node->wrapper();
134                 if (LIKELY(!!wrapper))
135                     return *wrapper;
136             }
137
138             V8IsolatedContext* context = V8IsolatedContext::getEntered();
139             if (LIKELY(!context)) {
140                 v8::Persistent<v8::Object>* wrapper = node->wrapper();
141                 if (!wrapper)
142                     return v8::Handle<v8::Object>();
143                 return *wrapper;
144             }
145             DOMDataStore* store = context->world()->domDataStore();
146             DOMNodeMapping& domNodeMap = node->isActiveNode() ? store->activeDomNodeMap() : store->domNodeMap();
147             return domNodeMap.get(node);
148         }
149     private:
150         static V8PerContextData* perContextData(V8Proxy*);
151 #if ENABLE(WORKERS)
152         static V8PerContextData* perContextData(WorkerContext*);
153 #endif
154     };
155
156     template<typename T>
157     v8::Persistent<v8::Object> V8DOMWrapper::setJSWrapperForDOMObject(PassRefPtr<T> object, v8::Handle<v8::Object> wrapper, v8::Isolate* isolate)
158     {
159         v8::Persistent<v8::Object> wrapperHandle = v8::Persistent<v8::Object>::New(wrapper);
160         ASSERT(maybeDOMWrapper(wrapperHandle));
161         ASSERT(!domWrapperType(wrapperHandle)->toActiveDOMObjectFunction);
162         getDOMObjectMap(isolate).set(object.leakRef(), wrapperHandle);
163         return wrapperHandle;
164     }
165
166     template<typename T>
167     v8::Persistent<v8::Object> V8DOMWrapper::setJSWrapperForActiveDOMObject(PassRefPtr<T> object, v8::Handle<v8::Object> wrapper, v8::Isolate* isolate)
168     {
169         v8::Persistent<v8::Object> wrapperHandle = v8::Persistent<v8::Object>::New(wrapper);
170         ASSERT(maybeDOMWrapper(wrapperHandle));
171         ASSERT(domWrapperType(wrapperHandle)->toActiveDOMObjectFunction);
172         getActiveDOMObjectMap(isolate).set(object.leakRef(), wrapperHandle);
173         return wrapperHandle;
174     }
175 }
176
177 #endif // V8DOMWrapper_h