diff options
Diffstat (limited to 'WebCore/bindings/js/kjs_binding.h')
| -rw-r--r-- | WebCore/bindings/js/kjs_binding.h | 152 |
1 files changed, 152 insertions, 0 deletions
diff --git a/WebCore/bindings/js/kjs_binding.h b/WebCore/bindings/js/kjs_binding.h new file mode 100644 index 0000000..fb95652 --- /dev/null +++ b/WebCore/bindings/js/kjs_binding.h @@ -0,0 +1,152 @@ +/* + * Copyright (C) 1999-2001 Harri Porten (porten@kde.org) + * Copyright (C) 2003, 2004, 2005, 2006, 2008 Apple Inc. All rights reserved. + * Copyright (C) 2007 Samuel Weinig <sam@webkit.org> + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; either + * version 2 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + */ + +#ifndef kjs_binding_h +#define kjs_binding_h + +#include <kjs/function.h> +#include <kjs/interpreter.h> +#include <kjs/lookup.h> +#include <wtf/Noncopyable.h> + +#if PLATFORM(MAC) +#include <JavaScriptCore/runtime.h> +#endif + +namespace WebCore { + + class AtomicString; + class Document; + class Event; + class Frame; + class KURL; + class Node; + class String; + class JSNode; + + typedef int ExceptionCode; + +#if ENABLE(SVG) + class SVGElement; +#endif + + // Base class for all objects in this binding except Window. + class DOMObject : public KJS::JSObject { + protected: + explicit DOMObject(KJS::JSValue* prototype) // FIXME: this should take a JSObject once JSLocation has a real prototype + : JSObject(prototype) + { + // DOMObject destruction is not thread-safe because DOMObjects wrap + // unsafe WebCore DOM data structures. + KJS::Collector::collectOnMainThreadOnly(this); + } + +#ifndef NDEBUG + virtual ~DOMObject(); +#endif + + private: + DOMObject(); + }; + + class ScriptInterpreter : public KJS::Interpreter { + public: + static DOMObject* getDOMObject(void* objectHandle); + static void putDOMObject(void* objectHandle, DOMObject*); + static void forgetDOMObject(void* objectHandle); + + static JSNode* getDOMNodeForDocument(Document*, Node*); + static void putDOMNodeForDocument(Document*, Node*, JSNode* nodeWrapper); + static void forgetDOMNodeForDocument(Document*, Node*); + static void forgetAllDOMNodesForDocument(Document*); + static void updateDOMNodeDocument(Node*, Document* oldDoc, Document* newDoc); + static void markDOMNodesForDocument(Document*); + }; + + // Retrieve from cache, or create, a JS wrapper for a DOM object. + template<class DOMObj, class JSDOMObj, class JSDOMObjPrototype> inline KJS::JSValue* cacheDOMObject(KJS::ExecState* exec, DOMObj* domObj) + { + if (!domObj) + return KJS::jsNull(); + if (DOMObject* ret = ScriptInterpreter::getDOMObject(domObj)) + return ret; + DOMObject* ret = new JSDOMObj(JSDOMObjPrototype::self(exec), domObj); + ScriptInterpreter::putDOMObject(domObj, ret); + return ret; + } + +#if ENABLE(SVG) + // Retrieve from cache, or create, a JS wrapper for an SVG DOM object. + template<class DOMObj, class JSDOMObj, class JSDOMObjPrototype> inline KJS::JSValue* cacheSVGDOMObject(KJS::ExecState* exec, DOMObj* domObj, SVGElement* context) + { + if (!domObj) + return KJS::jsNull(); + if (DOMObject* ret = ScriptInterpreter::getDOMObject(domObj)) + return ret; + DOMObject* ret = new JSDOMObj(JSDOMObjPrototype::self(exec), domObj, context); + ScriptInterpreter::putDOMObject(domObj, ret); + return ret; + } +#endif + + // Convert a DOM implementation exception code into a JavaScript exception in the execution state. + void setDOMException(KJS::ExecState*, ExceptionCode); + + // Helper class to call setDOMException on exit without adding lots of separate calls to that function. + class DOMExceptionTranslator : Noncopyable { + public: + explicit DOMExceptionTranslator(KJS::ExecState* exec) : m_exec(exec), m_code(0) { } + ~DOMExceptionTranslator() { setDOMException(m_exec, m_code); } + operator ExceptionCode&() { return m_code; } + private: + KJS::ExecState* m_exec; + ExceptionCode m_code; + }; + + KJS::JSValue* jsStringOrNull(const String&); // null if the string is null + KJS::JSValue* jsStringOrNull(const KURL&); // null if the URL is null + + KJS::JSValue* jsStringOrUndefined(const String&); // undefined if the string is null + KJS::JSValue* jsStringOrUndefined(const KURL&); // undefined if the URL is null + + KJS::JSValue* jsStringOrFalse(const String&); // boolean false if the string is null + KJS::JSValue* jsStringOrFalse(const KURL&); // boolean false if the URL is null + + // See JavaScriptCore for explanation: Should be used for any UString that is already owned by another + // object, to let the engine know that collecting the JSString wrapper is unlikely to save memory. + KJS::JSValue* jsOwnedStringOrNull(const KJS::UString&); + + String valueToStringWithNullCheck(KJS::ExecState*, KJS::JSValue*); // null String if the value is null + String valueToStringWithUndefinedOrNullCheck(KJS::ExecState*, KJS::JSValue*); // null String if the value is null or undefined + + template <typename T> inline KJS::JSValue* toJS(KJS::ExecState* exec, PassRefPtr<T> ptr) { return toJS(exec, ptr.get()); } + + // Helpers for Window, History, and Location classes to implement cross-domain policy. + // Besides the cross-domain check, they need non-caching versions of staticFunctionGetter for + // because we do not want current property values involved at all. + bool allowsAccessFromFrame(KJS::ExecState*, Frame*); + bool allowsAccessFromFrame(KJS::ExecState*, Frame*, String& message); + void printErrorMessageForFrame(Frame*, const String& message); + KJS::JSValue* nonCachingStaticFunctionGetter(KJS::ExecState*, KJS::JSObject*, const KJS::Identifier& propertyName, const KJS::PropertySlot&); + KJS::JSValue* objectToStringFunctionGetter(KJS::ExecState*, KJS::JSObject*, const KJS::Identifier& propertyName, const KJS::PropertySlot&); + +} // namespace WebCore + +#endif // kjs_binding_h |