WebCore/bindings/v8/V8DOMWrapper.h - platform/external/webkit - Git at Google

 /*
  * Copyright (C) 2009 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
  * met:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
  *     * Redistributions in binary form must reproduce the above
  * copyright notice, this list of conditions and the following disclaimer
  * in the documentation and/or other materials provided with the
  * distribution.
  *     * Neither the name of Google Inc. nor the names of its
  * contributors may be used to endorse or promote products derived from
  * this software without specific prior written permission.
  *
  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */

 #ifndef V8DOMWrapper_h
 #define V8DOMWrapper_h

 #include "Document.h"
 #include "Event.h"
 #include "Node.h"
 #include "NodeFilter.h"
 #include "PlatformString.h" // for WebCore::String
 #include "V8CustomXPathNSResolver.h"
 #include "V8DOMMap.h"
 #include "V8Event.h"
 #include "V8Index.h"
 #include "V8Utilities.h"
 #include "V8XPathNSResolver.h"
 #include "XPathNSResolver.h"
 #include <v8.h>

 namespace WebCore {

     // FIXME: This probably aren't all needed.
     class CSSRule;
     class CSSRuleList;
     class CSSStyleDeclaration;
     class CSSValue;
     class CSSValueList;
     class ClientRectList;
     class DOMImplementation;
     class DOMWindow;
     class Document;
     class Element;
     class Event;
     class EventListener;
     class EventTarget;
     class Frame;
     class HTMLCollection;
     class HTMLDocument;
     class HTMLElement;
     class HTMLOptionsCollection;
     class MediaList;
     class MimeType;
     class MimeTypeArray;
     class NamedNodeMap;
     class Navigator;
     class Node;
     class NodeFilter;
     class NodeList;
     class Plugin;
     class PluginArray;
     class SVGElement;
 #if ENABLE(SVG)
     class SVGElementInstance;
 #endif
     class Screen;
     class ScriptExecutionContext;
 #if ENABLE(DOM_STORAGE)
     class Storage;
     class StorageEvent;
 #endif
     class String;
     class StyleSheet;
     class StyleSheetList;
     class V8EventListener;
     class V8ObjectEventListener;
     class V8Proxy;
 #if ENABLE(WEB_SOCKETS)
     class WebSocket;
 #endif
     class WorkerContext;

     enum ListenerLookupType {
         ListenerFindOnly,
         ListenerFindOrCreate,
     };

     class V8DOMWrapper {
     public:
 #ifndef NDEBUG
         // Checks if a v8 value can be a DOM wrapper
         static bool maybeDOMWrapper(v8::Handle<v8::Value>);
 #endif

         // Sets contents of a DOM wrapper.
         static void setDOMWrapper(v8::Handle<v8::Object> object, int type, void* cptr)
         {
             ASSERT(object->InternalFieldCount() >= 2);
             object->SetPointerInInternalField(v8DOMWrapperObjectIndex, cptr);
             object->SetInternalField(v8DOMWrapperTypeIndex, v8::Integer::New(type));
         }

         static v8::Handle<v8::Object> lookupDOMWrapper(v8::Handle<v8::FunctionTemplate> functionTemplate, v8::Handle<v8::Object> object)
         {
             return object.IsEmpty() ? object : object->FindInstanceInPrototypeChain(functionTemplate);
         }

         static V8ClassIndex::V8WrapperType domWrapperType(v8::Handle<v8::Object>);

         static v8::Handle<v8::Value> convertEventTargetToV8Object(PassRefPtr<EventTarget> eventTarget)
         {
             return convertEventTargetToV8Object(eventTarget.get());
         }

         static v8::Handle<v8::Value> convertEventTargetToV8Object(EventTarget*);

         static PassRefPtr<EventListener> getEventListener(Node* node, v8::Local<v8::Value> value, bool isAttribute, ListenerLookupType lookup);

         static PassRefPtr<EventListener> getEventListener(SVGElementInstance* element, v8::Local<v8::Value> value, bool isAttribute, ListenerLookupType lookup);

         static PassRefPtr<EventListener> getEventListener(AbstractWorker* worker, v8::Local<v8::Value> value, bool isAttribute, ListenerLookupType lookup);

 #if ENABLE(NOTIFICATIONS)
         static PassRefPtr<EventListener> getEventListener(Notification* notification, v8::Local<v8::Value> value, bool isAttribute, ListenerLookupType lookup);
 #endif

         static PassRefPtr<EventListener> getEventListener(WorkerContext* workerContext, v8::Local<v8::Value> value, bool isAttribute, ListenerLookupType lookup);

         static PassRefPtr<EventListener> getEventListener(XMLHttpRequestUpload* upload, v8::Local<v8::Value> value, bool isAttribute, ListenerLookupType lookup);

 #if ENABLE(EVENTSOURCE)
         static PassRefPtr<EventListener> getEventListener(EventSource* eventTarget, v8::Local<v8::Value> value, bool isAttribute, ListenerLookupType lookup);
 #endif

         static PassRefPtr<EventListener> getEventListener(EventTarget* eventTarget, v8::Local<v8::Value> value, bool isAttribute, ListenerLookupType lookup);

         static PassRefPtr<EventListener> getEventListener(V8Proxy* proxy, v8::Local<v8::Value> value, bool isAttribute, ListenerLookupType lookup);

 #if ENABLE(XPATH)
         // XPath-related utilities
         static RefPtr<XPathNSResolver> getXPathNSResolver(v8::Handle<v8::Value> value, V8Proxy* proxy = 0)
         {
             RefPtr<XPathNSResolver> resolver;
             if (V8XPathNSResolver::HasInstance(value))
                 resolver = V8XPathNSResolver::toNative(v8::Handle<v8::Object>::Cast(value));
             else if (value->IsObject())
                 resolver = V8CustomXPathNSResolver::create(proxy, value->ToObject());
             return resolver;
         }
 #endif

         // Wrap JS node filter in C++.
         static PassRefPtr<NodeFilter> wrapNativeNodeFilter(v8::Handle<v8::Value>);

         static v8::Local<v8::Function> getConstructorForContext(V8ClassIndex::V8WrapperType, v8::Handle<v8::Context>);
         static v8::Local<v8::Function> getConstructor(V8ClassIndex::V8WrapperType, v8::Handle<v8::Value> objectPrototype);
         static v8::Local<v8::Function> getConstructor(V8ClassIndex::V8WrapperType, DOMWindow*);
         static v8::Local<v8::Function> getConstructor(V8ClassIndex::V8WrapperType, WorkerContext*);

         // Set JS wrapper of a DOM object, the caller in charge of increase ref.
         static void setJSWrapperForDOMObject(void*, v8::Persistent<v8::Object>);
         static void setJSWrapperForActiveDOMObject(void*, v8::Persistent<v8::Object>);
         static void setJSWrapperForDOMNode(Node*, v8::Persistent<v8::Object>);

         // Check whether a V8 value is a wrapper of type |classType|.
         static bool isWrapperOfType(v8::Handle<v8::Value>, V8ClassIndex::V8WrapperType);

 #if ENABLE(3D_CANVAS)
         static void setIndexedPropertiesToExternalArray(v8::Handle<v8::Object>,
                                                         int,
                                                         void*,
                                                         int);
 #endif
         // Set hidden references in a DOMWindow object of a frame.
         static void setHiddenWindowReference(Frame*, const int internalIndex, v8::Handle<v8::Object>);

         static v8::Local<v8::Object> instantiateV8Object(V8Proxy* proxy, V8ClassIndex::V8WrapperType type, void* impl);
         static v8::Local<v8::Object> instantiateV8ObjectInWorkerContext(V8ClassIndex::V8WrapperType type, void* impl);

         static v8::Handle<v8::Object> getWrapper(Node*);
     };

 }

 #endif // V8DOMWrapper_h
	/*
	* Copyright (C) 2009 Google Inc. All rights reserved.
	*
	* Redistribution and use in source and binary forms, with or without
	* modification, are permitted provided that the following conditions are
	* met:
	*
	* * Redistributions of source code must retain the above copyright
	* notice, this list of conditions and the following disclaimer.
	* * Redistributions in binary form must reproduce the above
	* copyright notice, this list of conditions and the following disclaimer
	* in the documentation and/or other materials provided with the
	* distribution.
	* * Neither the name of Google Inc. nor the names of its
	* contributors may be used to endorse or promote products derived from
	* this software without specific prior written permission.
	*
	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
	* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
	* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	*/

	#ifndef V8DOMWrapper_h
	#define V8DOMWrapper_h

	#include "Document.h"
	#include "Event.h"
	#include "Node.h"
	#include "NodeFilter.h"
	#include "PlatformString.h" // for WebCore::String
	#include "V8CustomXPathNSResolver.h"
	#include "V8DOMMap.h"
	#include "V8Event.h"
	#include "V8Index.h"
	#include "V8Utilities.h"
	#include "V8XPathNSResolver.h"
	#include "XPathNSResolver.h"
	#include <v8.h>

	namespace WebCore {

	// FIXME: This probably aren't all needed.
	class CSSRule;
	class CSSRuleList;
	class CSSStyleDeclaration;
	class CSSValue;
	class CSSValueList;
	class ClientRectList;
	class DOMImplementation;
	class DOMWindow;
	class Document;
	class Element;
	class Event;
	class EventListener;
	class EventTarget;
	class Frame;
	class HTMLCollection;
	class HTMLDocument;
	class HTMLElement;
	class HTMLOptionsCollection;
	class MediaList;
	class MimeType;
	class MimeTypeArray;
	class NamedNodeMap;
	class Navigator;
	class Node;
	class NodeFilter;
	class NodeList;
	class Plugin;
	class PluginArray;
	class SVGElement;
	#if ENABLE(SVG)
	class SVGElementInstance;
	#endif
	class Screen;
	class ScriptExecutionContext;
	#if ENABLE(DOM_STORAGE)
	class Storage;
	class StorageEvent;
	#endif
	class String;
	class StyleSheet;
	class StyleSheetList;
	class V8EventListener;
	class V8ObjectEventListener;
	class V8Proxy;
	#if ENABLE(WEB_SOCKETS)
	class WebSocket;
	#endif
	class WorkerContext;

	enum ListenerLookupType {
	ListenerFindOnly,
	ListenerFindOrCreate,
	};

	class V8DOMWrapper {
	public:
	#ifndef NDEBUG
	// Checks if a v8 value can be a DOM wrapper
	static bool maybeDOMWrapper(v8::Handle<v8::Value>);
	#endif

	// Sets contents of a DOM wrapper.
	static void setDOMWrapper(v8::Handle<v8::Object> object, int type, void* cptr)
	{
	ASSERT(object->InternalFieldCount() >= 2);
	object->SetPointerInInternalField(v8DOMWrapperObjectIndex, cptr);
	object->SetInternalField(v8DOMWrapperTypeIndex, v8::Integer::New(type));
	}

	static v8::Handle<v8::Object> lookupDOMWrapper(v8::Handle<v8::FunctionTemplate> functionTemplate, v8::Handle<v8::Object> object)
	{
	return object.IsEmpty() ? object : object->FindInstanceInPrototypeChain(functionTemplate);
	}

	static V8ClassIndex::V8WrapperType domWrapperType(v8::Handle<v8::Object>);

	static v8::Handle<v8::Value> convertEventTargetToV8Object(PassRefPtr<EventTarget> eventTarget)
	{
	return convertEventTargetToV8Object(eventTarget.get());
	}

	static v8::Handle<v8::Value> convertEventTargetToV8Object(EventTarget*);

	static PassRefPtr<EventListener> getEventListener(Node* node, v8::Local<v8::Value> value, bool isAttribute, ListenerLookupType lookup);

	static PassRefPtr<EventListener> getEventListener(SVGElementInstance* element, v8::Local<v8::Value> value, bool isAttribute, ListenerLookupType lookup);

	static PassRefPtr<EventListener> getEventListener(AbstractWorker* worker, v8::Local<v8::Value> value, bool isAttribute, ListenerLookupType lookup);

	#if ENABLE(NOTIFICATIONS)
	static PassRefPtr<EventListener> getEventListener(Notification* notification, v8::Local<v8::Value> value, bool isAttribute, ListenerLookupType lookup);
	#endif

	static PassRefPtr<EventListener> getEventListener(WorkerContext* workerContext, v8::Local<v8::Value> value, bool isAttribute, ListenerLookupType lookup);

	static PassRefPtr<EventListener> getEventListener(XMLHttpRequestUpload* upload, v8::Local<v8::Value> value, bool isAttribute, ListenerLookupType lookup);

	#if ENABLE(EVENTSOURCE)
	static PassRefPtr<EventListener> getEventListener(EventSource* eventTarget, v8::Local<v8::Value> value, bool isAttribute, ListenerLookupType lookup);
	#endif

	static PassRefPtr<EventListener> getEventListener(EventTarget* eventTarget, v8::Local<v8::Value> value, bool isAttribute, ListenerLookupType lookup);

	static PassRefPtr<EventListener> getEventListener(V8Proxy* proxy, v8::Local<v8::Value> value, bool isAttribute, ListenerLookupType lookup);

	#if ENABLE(XPATH)
	// XPath-related utilities
	static RefPtr<XPathNSResolver> getXPathNSResolver(v8::Handle<v8::Value> value, V8Proxy* proxy = 0)
	{
	RefPtr<XPathNSResolver> resolver;
	if (V8XPathNSResolver::HasInstance(value))
	resolver = V8XPathNSResolver::toNative(v8::Handle<v8::Object>::Cast(value));
	else if (value->IsObject())
	resolver = V8CustomXPathNSResolver::create(proxy, value->ToObject());
	return resolver;
	}
	#endif

	// Wrap JS node filter in C++.
	static PassRefPtr<NodeFilter> wrapNativeNodeFilter(v8::Handle<v8::Value>);

	static v8::Local<v8::Function> getConstructorForContext(V8ClassIndex::V8WrapperType, v8::Handle<v8::Context>);
	static v8::Local<v8::Function> getConstructor(V8ClassIndex::V8WrapperType, v8::Handle<v8::Value> objectPrototype);
	static v8::Local<v8::Function> getConstructor(V8ClassIndex::V8WrapperType, DOMWindow*);
	static v8::Local<v8::Function> getConstructor(V8ClassIndex::V8WrapperType, WorkerContext*);

	// Set JS wrapper of a DOM object, the caller in charge of increase ref.
	static void setJSWrapperForDOMObject(void*, v8::Persistent<v8::Object>);
	static void setJSWrapperForActiveDOMObject(void*, v8::Persistent<v8::Object>);
	static void setJSWrapperForDOMNode(Node*, v8::Persistent<v8::Object>);

	// Check whether a V8 value is a wrapper of type \|classType\|.
	static bool isWrapperOfType(v8::Handle<v8::Value>, V8ClassIndex::V8WrapperType);

	#if ENABLE(3D_CANVAS)
	static void setIndexedPropertiesToExternalArray(v8::Handle<v8::Object>,
	int,
	void*,
	int);
	#endif
	// Set hidden references in a DOMWindow object of a frame.
	static void setHiddenWindowReference(Frame*, const int internalIndex, v8::Handle<v8::Object>);

	static v8::Local<v8::Object> instantiateV8Object(V8Proxy* proxy, V8ClassIndex::V8WrapperType type, void* impl);
	static v8::Local<v8::Object> instantiateV8ObjectInWorkerContext(V8ClassIndex::V8WrapperType type, void* impl);

	static v8::Handle<v8::Object> getWrapper(Node*);
	};

	}

	#endif // V8DOMWrapper_h