2009-07-13 Drew Wilson <atwilson@google.com>
[WebKit-https.git] / WebCore / dom / EventTarget.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2001 Dirk Mueller (mueller@kde.org)
5  * Copyright (C) 2004, 2005, 2006, 2007, 2008 Apple Inc. All rights reserved.
6  * Copyright (C) 2006 Alexey Proskuryakov (ap@webkit.org)
7  *           (C) 2007, 2008 Nikolas Zimmermann <zimmermann@kde.org>
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
22  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
25  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
26  * 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
32 #ifndef EventTarget_h
33 #define EventTarget_h
34
35 #include <wtf/Forward.h>
36
37 namespace WebCore {
38
39     class AbstractWorker;
40     class AtomicString;
41     class DOMApplicationCache;
42     class DOMWindow;
43     class Event;
44     class EventListener;
45     class MessagePort;
46     class Node;
47     class SVGElementInstance;
48     class ScriptExecutionContext;
49     class SharedWorker;
50     class Worker;
51     class WorkerContext;
52     class XMLHttpRequest;
53     class XMLHttpRequestUpload;
54
55     typedef int ExceptionCode;
56
57     class EventTarget {
58     public:
59         virtual MessagePort* toMessagePort();
60         virtual Node* toNode();
61         virtual DOMWindow* toDOMWindow();
62         virtual XMLHttpRequest* toXMLHttpRequest();
63         virtual XMLHttpRequestUpload* toXMLHttpRequestUpload();
64 #if ENABLE(OFFLINE_WEB_APPLICATIONS)
65         virtual DOMApplicationCache* toDOMApplicationCache();
66 #endif
67 #if ENABLE(SVG)
68         virtual SVGElementInstance* toSVGElementInstance();
69 #endif
70 #if ENABLE(WORKERS)
71         virtual Worker* toWorker();
72         virtual WorkerContext* toWorkerContext();
73 #endif
74
75 #if ENABLE(SHARED_WORKERS)
76         virtual SharedWorker* toSharedWorker();
77 #endif
78
79         virtual ScriptExecutionContext* scriptExecutionContext() const = 0;
80
81         virtual void addEventListener(const AtomicString& eventType, PassRefPtr<EventListener>, bool useCapture) = 0;
82         virtual void removeEventListener(const AtomicString& eventType, EventListener*, bool useCapture) = 0;
83         virtual bool dispatchEvent(PassRefPtr<Event>, ExceptionCode&) = 0;
84
85         void ref() { refEventTarget(); }
86         void deref() { derefEventTarget(); }
87
88         // Handlers to do/undo actions on the target node before an event is dispatched to it and after the event
89         // has been dispatched.  The data pointer is handed back by the preDispatch and passed to postDispatch.
90         virtual void* preDispatchEventHandler(Event*) { return 0; }
91         virtual void postDispatchEventHandler(Event*, void* /*dataFromPreDispatch*/) { }
92
93     protected:
94         virtual ~EventTarget();
95
96     private:
97         virtual void refEventTarget() = 0;
98         virtual void derefEventTarget() = 0;
99     };
100
101     void forbidEventDispatch();
102     void allowEventDispatch();
103
104 #ifndef NDEBUG
105     bool eventDispatchForbidden();
106 #else
107     inline void forbidEventDispatch() { }
108     inline void allowEventDispatch() { }
109 #endif
110
111 }
112
113 #endif