Move WebCore into Source
[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 <runtime/Completion.h>
30 #include <runtime/Lookup.h>
31 #include <runtime/WeakGCMap.h>
32 #include <wtf/Forward.h>
33 #include <wtf/Noncopyable.h>
34
35 namespace JSC {
36     class JSGlobalData;
37     class DebuggerCallFrame;
38 }
39
40 namespace WebCore {
41
42     class Document;
43     class Frame;
44     class JSNode;
45     class KURL;
46     class Node;
47     class ScriptController;
48     class ScriptCachedFrameData;
49
50     typedef int ExceptionCode;
51
52     // FIXME: This class should collapse into DOMObject once all DOMObjects are
53     // updated to store a globalObject pointer.
54     class DOMObjectWithGlobalPointer : public DOMObject {
55     public:
56         JSDOMGlobalObject* globalObject() const
57         {
58             return static_cast<JSDOMGlobalObject*>(DOMObject::globalObject());
59         }
60
61         ScriptExecutionContext* scriptExecutionContext() const
62         {
63             // FIXME: Should never be 0, but can be due to bug 27640.
64             return globalObject()->scriptExecutionContext();
65         }
66
67         static PassRefPtr<JSC::Structure> createStructure(JSC::JSValue prototype)
68         {
69             return JSC::Structure::create(prototype, JSC::TypeInfo(JSC::ObjectType, StructureFlags), AnonymousSlotCount);
70         }
71
72     protected:
73         DOMObjectWithGlobalPointer(NonNullPassRefPtr<JSC::Structure> structure, JSDOMGlobalObject* globalObject)
74             : DOMObject(globalObject, structure)
75         {
76             // FIXME: This ASSERT is valid, but fires in fast/dom/gc-6.html when trying to create
77             // new JavaScript objects on detached windows due to DOMWindow::document()
78             // needing to reach through the frame to get to the Document*.  See bug 27640.
79             // ASSERT(globalObject->scriptExecutionContext());
80         }
81     };
82
83     // Base class for all constructor objects in the JSC bindings.
84     class DOMConstructorObject : public DOMObjectWithGlobalPointer {
85     public:
86         static PassRefPtr<JSC::Structure> createStructure(JSC::JSValue prototype)
87         {
88             return JSC::Structure::create(prototype, JSC::TypeInfo(JSC::ObjectType, StructureFlags), AnonymousSlotCount);
89         }
90
91     protected:
92         static const unsigned StructureFlags = JSC::ImplementsHasInstance | JSC::OverridesMarkChildren | DOMObjectWithGlobalPointer::StructureFlags;
93         DOMConstructorObject(NonNullPassRefPtr<JSC::Structure> structure, JSDOMGlobalObject* globalObject)
94             : DOMObjectWithGlobalPointer(structure, globalObject)
95         {
96         }
97     };
98
99     // Constructors using this base class depend on being in a Document and
100     // can never be used from a WorkerContext.
101     class DOMConstructorWithDocument : public DOMConstructorObject {
102     public:
103         Document* document() const
104         {
105             return static_cast<Document*>(scriptExecutionContext());
106         }
107
108     protected:
109         DOMConstructorWithDocument(NonNullPassRefPtr<JSC::Structure> structure, JSDOMGlobalObject* globalObject)
110             : DOMConstructorObject(structure, globalObject)
111         {
112             ASSERT(globalObject->scriptExecutionContext()->isDocument());
113         }
114     };
115
116     DOMObject* getCachedDOMObjectWrapper(JSC::ExecState*, void* objectHandle);
117     bool hasCachedDOMObjectWrapper(JSC::JSGlobalData*, void* objectHandle);
118     void cacheDOMObjectWrapper(JSC::ExecState*, void* objectHandle, DOMObject* wrapper);
119     void forgetDOMNode(JSNode* wrapper, Node* node, Document* document);
120     void forgetDOMObject(DOMObject* wrapper, void* objectHandle);
121
122     JSNode* getCachedDOMNodeWrapper(JSC::ExecState*, Document*, Node*);
123     void cacheDOMNodeWrapper(JSC::ExecState*, Document*, Node*, JSNode* wrapper);
124     void updateDOMNodeDocument(Node*, Document* oldDocument, Document* newDocument);
125
126     void markDOMNodesForDocument(JSC::MarkStack&, Document*);
127     void markActiveObjectsForContext(JSC::MarkStack&, JSC::JSGlobalData&, ScriptExecutionContext*);
128     void markDOMObjectWrapper(JSC::MarkStack&, JSC::JSGlobalData& globalData, void* object);
129     void markDOMNodeWrapper(JSC::MarkStack& markStack, Document* document, Node* node);
130     bool hasCachedDOMObjectWrapperUnchecked(JSC::JSGlobalData*, void* objectHandle);
131     bool hasCachedDOMNodeWrapperUnchecked(Document*, Node*);
132
133     JSC::Structure* getCachedDOMStructure(JSDOMGlobalObject*, const JSC::ClassInfo*);
134     JSC::Structure* cacheDOMStructure(JSDOMGlobalObject*, NonNullPassRefPtr<JSC::Structure>, const JSC::ClassInfo*);
135
136     inline JSDOMGlobalObject* deprecatedGlobalObjectForPrototype(JSC::ExecState* exec)
137     {
138         // FIXME: Callers to this function should be using the global object
139         // from which the object is being created, instead of assuming the lexical one.
140         // e.g. subframe.document.body should use the subframe's global object, not the lexical one.
141         return static_cast<JSDOMGlobalObject*>(exec->lexicalGlobalObject());
142     }
143
144     template<class WrapperClass> inline JSC::Structure* getDOMStructure(JSC::ExecState* exec, JSDOMGlobalObject* globalObject)
145     {
146         if (JSC::Structure* structure = getCachedDOMStructure(globalObject, &WrapperClass::s_info))
147             return structure;
148         return cacheDOMStructure(globalObject, WrapperClass::createStructure(WrapperClass::createPrototype(exec, globalObject)), &WrapperClass::s_info);
149     }
150     template<class WrapperClass> inline JSC::Structure* deprecatedGetDOMStructure(JSC::ExecState* exec)
151     {
152         // FIXME: This function is wrong.  It uses the wrong global object for creating the prototype structure.
153         return getDOMStructure<WrapperClass>(exec, deprecatedGlobalObjectForPrototype(exec));
154     }
155     template<class WrapperClass> inline JSC::JSObject* getDOMPrototype(JSC::ExecState* exec, JSC::JSGlobalObject* globalObject)
156     {
157         return static_cast<JSC::JSObject*>(asObject(getDOMStructure<WrapperClass>(exec, static_cast<JSDOMGlobalObject*>(globalObject))->storedPrototype()));
158     }
159     #define CREATE_DOM_OBJECT_WRAPPER(exec, globalObject, className, object) createDOMObjectWrapper<JS##className>(exec, globalObject, static_cast<className*>(object))
160     template<class WrapperClass, class DOMClass> inline DOMObject* createDOMObjectWrapper(JSC::ExecState* exec, JSDOMGlobalObject* globalObject, DOMClass* object)
161     {
162         ASSERT(object);
163         ASSERT(!getCachedDOMObjectWrapper(exec, object));
164         // FIXME: new (exec) could use a different globalData than the globalData this wrapper is cached on.
165         WrapperClass* wrapper = new (exec) WrapperClass(getDOMStructure<WrapperClass>(exec, globalObject), globalObject, object);
166         cacheDOMObjectWrapper(exec, object, wrapper);
167         return wrapper;
168     }
169     template<class WrapperClass, class DOMClass> inline JSC::JSValue getDOMObjectWrapper(JSC::ExecState* exec, JSDOMGlobalObject* globalObject, DOMClass* object)
170     {
171         if (!object)
172             return JSC::jsNull();
173         if (DOMObject* wrapper = getCachedDOMObjectWrapper(exec, object))
174             return wrapper;
175         return createDOMObjectWrapper<WrapperClass>(exec, globalObject, object);
176     }
177
178     #define CREATE_DOM_NODE_WRAPPER(exec, globalObject, className, object) createDOMNodeWrapper<JS##className>(exec, globalObject, static_cast<className*>(object))
179     template<class WrapperClass, class DOMClass> inline JSNode* createDOMNodeWrapper(JSC::ExecState* exec, JSDOMGlobalObject* globalObject, DOMClass* node)
180     {
181         ASSERT(node);
182         ASSERT(!getCachedDOMNodeWrapper(exec, node->document(), node));
183         WrapperClass* wrapper = new (exec) WrapperClass(getDOMStructure<WrapperClass>(exec, globalObject), globalObject, node);
184         // FIXME: The entire function can be removed, once we fix caching.
185         // This function is a one-off hack to make Nodes cache in the right global object.
186         cacheDOMNodeWrapper(exec, node->document(), node, wrapper);
187         return wrapper;
188     }
189     template<class WrapperClass, class DOMClass> inline JSC::JSValue getDOMNodeWrapper(JSC::ExecState* exec, JSDOMGlobalObject* globalObject, DOMClass* node)
190     {
191         if (!node)
192             return JSC::jsNull();
193         if (JSC::JSCell* wrapper = getCachedDOMNodeWrapper(exec, node->document(), node))
194             return wrapper;
195         return createDOMNodeWrapper<WrapperClass>(exec, globalObject, node);
196     }
197
198     const JSC::HashTable* getHashTableForGlobalData(JSC::JSGlobalData&, const JSC::HashTable* staticTable);
199
200     void reportException(JSC::ExecState*, JSC::JSValue exception);
201     void reportCurrentException(JSC::ExecState*);
202
203     // Convert a DOM implementation exception code into a JavaScript exception in the execution state.
204     void setDOMException(JSC::ExecState*, ExceptionCode);
205
206     JSC::JSValue jsString(JSC::ExecState*, const String&); // empty if the string is null
207     JSC::JSValue jsStringSlowCase(JSC::ExecState*, JSStringCache&, StringImpl*);
208     JSC::JSValue jsString(JSC::ExecState*, const KURL&); // empty if the URL is null
209     inline JSC::JSValue jsString(JSC::ExecState* exec, const AtomicString& s)
210     { 
211         return jsString(exec, s.string());
212     }
213         
214     JSC::JSValue jsStringOrNull(JSC::ExecState*, const String&); // null if the string is null
215     JSC::JSValue jsStringOrNull(JSC::ExecState*, const KURL&); // null if the URL is null
216
217     JSC::JSValue jsStringOrUndefined(JSC::ExecState*, const String&); // undefined if the string is null
218     JSC::JSValue jsStringOrUndefined(JSC::ExecState*, const KURL&); // undefined if the URL is null
219
220     JSC::JSValue jsStringOrFalse(JSC::ExecState*, const String&); // boolean false if the string is null
221     JSC::JSValue jsStringOrFalse(JSC::ExecState*, const KURL&); // boolean false if the URL is null
222
223     // See JavaScriptCore for explanation: Should be used for any string that is already owned by another
224     // object, to let the engine know that collecting the JSString wrapper is unlikely to save memory.
225     JSC::JSValue jsOwnedStringOrNull(JSC::ExecState*, const String&); 
226
227     String identifierToString(const JSC::Identifier&);
228     String ustringToString(const JSC::UString&);
229     JSC::UString stringToUString(const String&);
230
231     AtomicString identifierToAtomicString(const JSC::Identifier&);
232     AtomicString ustringToAtomicString(const JSC::UString&);
233     AtomicStringImpl* findAtomicString(const JSC::Identifier&);
234
235     String valueToStringWithNullCheck(JSC::ExecState*, JSC::JSValue); // null if the value is null
236     String valueToStringWithUndefinedOrNullCheck(JSC::ExecState*, JSC::JSValue); // null if the value is null or undefined
237
238     inline int32_t finiteInt32Value(JSC::JSValue value, JSC::ExecState* exec, bool& okay)
239     {
240         double number = value.toNumber(exec);
241         okay = isfinite(number);
242         return JSC::toInt32(number);
243     }
244
245     // Returns a Date instance for the specified value, or null if the value is NaN or infinity.
246     JSC::JSValue jsDateOrNull(JSC::ExecState*, double);
247     // NaN if the value can't be converted to a date.
248     double valueToDate(JSC::ExecState*, JSC::JSValue);
249
250     // FIXME: These are a stop-gap until all toJS calls can be converted to pass a globalObject
251     template <typename T>
252     inline JSC::JSValue toJS(JSC::ExecState* exec, T* ptr)
253     {
254         return toJS(exec, deprecatedGlobalObjectForPrototype(exec), ptr);
255     }
256     template <typename T>
257     inline JSC::JSValue toJS(JSC::ExecState* exec, PassRefPtr<T> ptr)
258     {
259         return toJS(exec, deprecatedGlobalObjectForPrototype(exec), ptr.get());
260     }
261     template <typename T>
262     inline JSC::JSValue toJSNewlyCreated(JSC::ExecState* exec, T* ptr)
263     {
264         return toJSNewlyCreated(exec, deprecatedGlobalObjectForPrototype(exec), ptr);
265     }
266
267     template <typename T>
268     inline JSC::JSValue toJS(JSC::ExecState* exec, JSDOMGlobalObject* globalObject, PassRefPtr<T> ptr)
269     {
270         return toJS(exec, globalObject, ptr.get());
271     }
272
273     // Validates that the passed object is a sequence type per section 4.1.13 of the WebIDL spec.
274     JSC::JSObject* toJSSequence(JSC::ExecState*, JSC::JSValue, unsigned&);
275
276     bool checkNodeSecurity(JSC::ExecState*, Node*);
277
278     // Helpers for Window, History, and Location classes to implement cross-domain policy.
279     // Besides the cross-domain check, they need non-caching versions of staticFunctionGetter for
280     // because we do not want current property values involved at all.
281     // FIXME: These functions should be named frameAllowsAccessFrom, because the access is *to* the frame.
282     bool allowsAccessFromFrame(JSC::ExecState*, Frame*);
283     bool allowsAccessFromFrame(JSC::ExecState*, Frame*, String& message);
284     DOMWindow* activeDOMWindow(JSC::ExecState*);
285     DOMWindow* firstDOMWindow(JSC::ExecState*);
286
287     void printErrorMessageForFrame(Frame*, const String& message);
288     JSC::JSValue objectToStringFunctionGetter(JSC::ExecState*, JSC::JSValue, const JSC::Identifier& propertyName);
289
290     Frame* toDynamicFrame(JSC::ExecState*);
291     bool processingUserGesture();
292     
293     inline JSC::JSValue jsString(JSC::ExecState* exec, const String& s)
294     {
295         StringImpl* stringImpl = s.impl();
296         if (!stringImpl || !stringImpl->length())
297             return jsEmptyString(exec);
298
299         if (stringImpl->length() == 1 && stringImpl->characters()[0] <= 0xFF)
300             return jsString(exec, stringToUString(s));
301
302         JSStringCache& stringCache = currentWorld(exec)->m_stringCache;
303         if (JSC::JSString* wrapper = stringCache.get(stringImpl))
304             return wrapper;
305
306         return jsStringSlowCase(exec, stringCache, stringImpl);
307     }
308
309     inline DOMObjectWrapperMap& domObjectWrapperMapFor(JSC::ExecState* exec)
310     {
311         return currentWorld(exec)->m_wrappers;
312     }
313
314     inline String ustringToString(const JSC::UString& u)
315     {
316         return u.impl();
317     }
318
319     inline JSC::UString stringToUString(const String& s)
320     {
321         return JSC::UString(s.impl());
322     }
323
324     inline String identifierToString(const JSC::Identifier& i)
325     {
326         return i.impl();
327     }
328
329     inline AtomicString ustringToAtomicString(const JSC::UString& u)
330     {
331         return AtomicString(u.impl());
332     }
333
334     inline AtomicString identifierToAtomicString(const JSC::Identifier& identifier)
335     {
336         return AtomicString(identifier.impl());
337     }
338
339 } // namespace WebCore
340
341 #endif // JSDOMBinding_h