An object's structure should reference the global object responsible for its creation
[WebKit-https.git] / Source / WebCore / bindings / js / JSDOMBinding.h
1 /*
2  *  Copyright (C) 1999-2001 Harri Porten (porten@kde.org)
3  *  Copyright (C) 2003, 2004, 2005, 2006, 2008, 2009 Apple Inc. All rights reserved.
4  *  Copyright (C) 2007 Samuel Weinig <sam@webkit.org>
5  *  Copyright (C) 2009 Google, Inc. All rights reserved.
6  *
7  *  This library is free software; you can redistribute it and/or
8  *  modify it under the terms of the GNU Lesser General Public
9  *  License as published by the Free Software Foundation; either
10  *  version 2 of the License, or (at your option) any later version.
11  *
12  *  This library is distributed in the hope that it will be useful,
13  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  *  Lesser General Public License for more details.
16  *
17  *  You should have received a copy of the GNU Lesser General Public
18  *  License along with this library; if not, write to the Free Software
19  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
20  */
21
22 #ifndef JSDOMBinding_h
23 #define JSDOMBinding_h
24
25 #include "JSDOMGlobalObject.h"
26 #include "JSDOMWrapper.h"
27 #include "DOMWrapperWorld.h"
28 #include "Document.h"
29 #include "Element.h"
30 #include "StyleBase.h"
31 #include <heap/Weak.h>
32 #include <runtime/FunctionPrototype.h>
33 #include <runtime/Lookup.h>
34 #include <runtime/ObjectPrototype.h>
35 #include <wtf/Forward.h>
36 #include <wtf/Noncopyable.h>
37
38 namespace WebCore {
39
40     class Frame;
41     class KURL;
42
43     typedef int ExceptionCode;
44
45     // Base class for all constructor objects in the JSC bindings.
46     class DOMConstructorObject : public JSDOMWrapper {
47     public:
48         static JSC::Structure* createStructure(JSC::JSGlobalData& globalData, JSC::JSGlobalObject* globalObject, JSC::JSValue prototype)
49         {
50             return JSC::Structure::create(globalData, globalObject, prototype, JSC::TypeInfo(JSC::ObjectType, StructureFlags), AnonymousSlotCount, &s_info);
51         }
52
53     protected:
54         static const unsigned StructureFlags = JSC::ImplementsHasInstance | JSC::OverridesVisitChildren | JSDOMWrapper::StructureFlags;
55         DOMConstructorObject(JSC::Structure* structure, JSDOMGlobalObject* globalObject)
56             : JSDOMWrapper(structure, globalObject)
57         {
58         }
59     };
60
61     // Constructors using this base class depend on being in a Document and
62     // can never be used from a WorkerContext.
63     class DOMConstructorWithDocument : public DOMConstructorObject {
64     public:
65         Document* document() const
66         {
67             return static_cast<Document*>(scriptExecutionContext());
68         }
69
70     protected:
71         DOMConstructorWithDocument(JSC::Structure* structure, JSDOMGlobalObject* globalObject)
72             : DOMConstructorObject(structure, globalObject)
73         {
74             ASSERT(globalObject->scriptExecutionContext()->isDocument());
75         }
76     };
77     
78     JSC::Structure* getCachedDOMStructure(JSDOMGlobalObject*, const JSC::ClassInfo*);
79     JSC::Structure* cacheDOMStructure(JSDOMGlobalObject*, JSC::Structure*, const JSC::ClassInfo*);
80
81     inline JSDOMGlobalObject* deprecatedGlobalObjectForPrototype(JSC::ExecState* exec)
82     {
83         // FIXME: Callers to this function should be using the global object
84         // from which the object is being created, instead of assuming the lexical one.
85         // e.g. subframe.document.body should use the subframe's global object, not the lexical one.
86         return static_cast<JSDOMGlobalObject*>(exec->lexicalGlobalObject());
87     }
88
89     template<class WrapperClass> inline JSC::Structure* getDOMStructure(JSC::ExecState* exec, JSDOMGlobalObject* globalObject)
90     {
91         if (JSC::Structure* structure = getCachedDOMStructure(globalObject, &WrapperClass::s_info))
92             return structure;
93         return cacheDOMStructure(globalObject, WrapperClass::createStructure(exec->globalData(), globalObject, WrapperClass::createPrototype(exec, globalObject)), &WrapperClass::s_info);
94     }
95
96     template<class WrapperClass> inline JSC::Structure* deprecatedGetDOMStructure(JSC::ExecState* exec)
97     {
98         // FIXME: This function is wrong.  It uses the wrong global object for creating the prototype structure.
99         return getDOMStructure<WrapperClass>(exec, deprecatedGlobalObjectForPrototype(exec));
100     }
101
102     template<class WrapperClass> inline JSC::JSObject* getDOMPrototype(JSC::ExecState* exec, JSC::JSGlobalObject* globalObject)
103     {
104         return static_cast<JSC::JSObject*>(asObject(getDOMStructure<WrapperClass>(exec, static_cast<JSDOMGlobalObject*>(globalObject))->storedPrototype()));
105     }
106
107     // Overload these functions to provide a fast path for wrapper access.
108     inline JSDOMWrapper* getInlineCachedWrapper(DOMWrapperWorld*, void*) { return 0; }
109     inline bool setInlineCachedWrapper(DOMWrapperWorld*, void*, JSDOMWrapper*) { return false; }
110     inline bool clearInlineCachedWrapper(DOMWrapperWorld*, void*, JSDOMWrapper*) { return false; }
111
112     // Overload these functions to provide a custom WeakHandleOwner.
113     inline JSC::WeakHandleOwner* wrapperOwner(DOMWrapperWorld* world, void*) { return world->defaultWrapperOwner(); }
114     inline void* wrapperContext(DOMWrapperWorld*, void* domObject) { return domObject; }
115
116     template <typename DOMClass> inline JSDOMWrapper* getCachedWrapper(DOMWrapperWorld* world, DOMClass* domObject)
117     {
118         if (JSDOMWrapper* wrapper = getInlineCachedWrapper(world, domObject))
119             return wrapper;
120         return world->m_wrappers.get(domObject).get();
121     }
122
123     template <typename DOMClass> inline void cacheWrapper(DOMWrapperWorld* world, DOMClass* domObject, JSDOMWrapper* wrapper)
124     {
125         if (setInlineCachedWrapper(world, domObject, wrapper))
126             return;
127         ASSERT(!world->m_wrappers.contains(domObject));
128         world->m_wrappers.set(domObject, JSC::Weak<JSDOMWrapper>(*world->globalData(), wrapper, wrapperOwner(world, domObject), wrapperContext(world, domObject)));
129     }
130
131     template <typename DOMClass> inline void uncacheWrapper(DOMWrapperWorld* world, DOMClass* domObject, JSDOMWrapper* wrapper)
132     {
133         if (clearInlineCachedWrapper(world, domObject, wrapper))
134             return;
135         ASSERT(world->m_wrappers.find(domObject)->second.get() == wrapper);
136         world->m_wrappers.remove(domObject);
137     }
138     
139     #define CREATE_DOM_WRAPPER(exec, globalObject, className, object) createWrapper<JS##className>(exec, globalObject, static_cast<className*>(object))
140     template<class WrapperClass, class DOMClass> inline JSDOMWrapper* createWrapper(JSC::ExecState* exec, JSDOMGlobalObject* globalObject, DOMClass* node)
141     {
142         ASSERT(node);
143         ASSERT(!getCachedWrapper(currentWorld(exec), node));
144         WrapperClass* wrapper = WrapperClass::create(getDOMStructure<WrapperClass>(exec, globalObject), globalObject, node);
145         // FIXME: The entire function can be removed, once we fix caching.
146         // This function is a one-off hack to make Nodes cache in the right global object.
147         cacheWrapper(currentWorld(exec), node, wrapper);
148         return wrapper;
149     }
150
151     template<class WrapperClass, class DOMClass> inline JSC::JSValue wrap(JSC::ExecState* exec, JSDOMGlobalObject* globalObject, DOMClass* domObject)
152     {
153         if (!domObject)
154             return JSC::jsNull();
155         if (JSDOMWrapper* wrapper = getCachedWrapper(currentWorld(exec), domObject))
156             return wrapper;
157         return createWrapper<WrapperClass>(exec, globalObject, domObject);
158     }
159
160     inline void* root(Node* node)
161     {
162         if (node->inDocument())
163             return node->document();
164
165         while (node->parentOrHostNode())
166             node = node->parentOrHostNode();
167         return node;
168     }
169
170     inline void* root(StyleBase* styleBase)
171     {
172         while (styleBase->parent())
173             styleBase = styleBase->parent();
174
175         if (Node* node = styleBase->node())
176             return root(node);
177         return styleBase;
178     }
179
180     const JSC::HashTable* getHashTableForGlobalData(JSC::JSGlobalData&, const JSC::HashTable* staticTable);
181
182     void reportException(JSC::ExecState*, JSC::JSValue exception);
183     void reportCurrentException(JSC::ExecState*);
184
185     // Convert a DOM implementation exception code into a JavaScript exception in the execution state.
186     void setDOMException(JSC::ExecState*, ExceptionCode);
187
188     JSC::JSValue jsString(JSC::ExecState*, const String&); // empty if the string is null
189     JSC::JSValue jsStringSlowCase(JSC::ExecState*, JSStringCache&, StringImpl*);
190     JSC::JSValue jsString(JSC::ExecState*, const KURL&); // empty if the URL is null
191     inline JSC::JSValue jsString(JSC::ExecState* exec, const AtomicString& s)
192     { 
193         return jsString(exec, s.string());
194     }
195         
196     JSC::JSValue jsStringOrNull(JSC::ExecState*, const String&); // null if the string is null
197     JSC::JSValue jsStringOrNull(JSC::ExecState*, const KURL&); // null if the URL is null
198
199     JSC::JSValue jsStringOrUndefined(JSC::ExecState*, const String&); // undefined if the string is null
200     JSC::JSValue jsStringOrUndefined(JSC::ExecState*, const KURL&); // undefined if the URL is null
201
202     JSC::JSValue jsStringOrFalse(JSC::ExecState*, const String&); // boolean false if the string is null
203     JSC::JSValue jsStringOrFalse(JSC::ExecState*, const KURL&); // boolean false if the URL is null
204
205     // See JavaScriptCore for explanation: Should be used for any string that is already owned by another
206     // object, to let the engine know that collecting the JSString wrapper is unlikely to save memory.
207     JSC::JSValue jsOwnedStringOrNull(JSC::ExecState*, const String&); 
208
209     String identifierToString(const JSC::Identifier&);
210     String ustringToString(const JSC::UString&);
211     JSC::UString stringToUString(const String&);
212
213     AtomicString identifierToAtomicString(const JSC::Identifier&);
214     AtomicString ustringToAtomicString(const JSC::UString&);
215     AtomicStringImpl* findAtomicString(const JSC::Identifier&);
216
217     String valueToStringWithNullCheck(JSC::ExecState*, JSC::JSValue); // null if the value is null
218     String valueToStringWithUndefinedOrNullCheck(JSC::ExecState*, JSC::JSValue); // null if the value is null or undefined
219
220     inline int32_t finiteInt32Value(JSC::JSValue value, JSC::ExecState* exec, bool& okay)
221     {
222         double number = value.toNumber(exec);
223         okay = isfinite(number);
224         return JSC::toInt32(number);
225     }
226
227     // Returns a Date instance for the specified value, or null if the value is NaN or infinity.
228     JSC::JSValue jsDateOrNull(JSC::ExecState*, double);
229     // NaN if the value can't be converted to a date.
230     double valueToDate(JSC::ExecState*, JSC::JSValue);
231
232     template <typename T>
233     inline JSC::JSValue toJS(JSC::ExecState* exec, JSDOMGlobalObject* globalObject, PassRefPtr<T> ptr)
234     {
235         return toJS(exec, globalObject, ptr.get());
236     }
237
238     // Validates that the passed object is a sequence type per section 4.1.13 of the WebIDL spec.
239     JSC::JSObject* toJSSequence(JSC::ExecState*, JSC::JSValue, unsigned&);
240
241     bool checkNodeSecurity(JSC::ExecState*, Node*);
242
243     // Helpers for Window, History, and Location classes to implement cross-domain policy.
244     // Besides the cross-domain check, they need non-caching versions of staticFunctionGetter for
245     // because we do not want current property values involved at all.
246     // FIXME: These functions should be named frameAllowsAccessFrom, because the access is *to* the frame.
247     bool allowsAccessFromFrame(JSC::ExecState*, Frame*);
248     bool allowsAccessFromFrame(JSC::ExecState*, Frame*, String& message);
249     DOMWindow* activeDOMWindow(JSC::ExecState*);
250     DOMWindow* firstDOMWindow(JSC::ExecState*);
251
252     void printErrorMessageForFrame(Frame*, const String& message);
253     JSC::JSValue objectToStringFunctionGetter(JSC::ExecState*, JSC::JSValue, const JSC::Identifier& propertyName);
254
255     Frame* toDynamicFrame(JSC::ExecState*);
256
257     inline JSC::JSValue jsString(JSC::ExecState* exec, const String& s)
258     {
259         StringImpl* stringImpl = s.impl();
260         if (!stringImpl || !stringImpl->length())
261             return jsEmptyString(exec);
262
263         if (stringImpl->length() == 1 && stringImpl->characters()[0] <= 0xFF)
264             return jsString(exec, stringToUString(s));
265
266         JSStringCache& stringCache = currentWorld(exec)->m_stringCache;
267         JSStringCache::iterator it = stringCache.find(stringImpl);
268         if (it != stringCache.end())
269             return it->second.get();
270
271         return jsStringSlowCase(exec, stringCache, stringImpl);
272     }
273
274     inline DOMObjectWrapperMap& domObjectWrapperMapFor(JSC::ExecState* exec)
275     {
276         return currentWorld(exec)->m_wrappers;
277     }
278
279     inline String ustringToString(const JSC::UString& u)
280     {
281         return u.impl();
282     }
283
284     inline JSC::UString stringToUString(const String& s)
285     {
286         return JSC::UString(s.impl());
287     }
288
289     inline String identifierToString(const JSC::Identifier& i)
290     {
291         return i.impl();
292     }
293
294     inline AtomicString ustringToAtomicString(const JSC::UString& u)
295     {
296         return AtomicString(u.impl());
297     }
298
299     inline AtomicString identifierToAtomicString(const JSC::Identifier& identifier)
300     {
301         return AtomicString(identifier.impl());
302     }
303
304 } // namespace WebCore
305
306 #endif // JSDOMBinding_h