Reviewed by Alexey Proskuryakov.
[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 DedicatedWorkerContext;
42     class DOMApplicationCache;
43     class DOMWindow;
44     class Event;
45     class EventListener;
46     class EventSource;
47     class MessagePort;
48     class Node;
49     class Notification;
50     class SVGElementInstance;
51     class ScriptExecutionContext;
52     class SharedWorker;
53     class SharedWorkerContext;
54     class WebSocket;
55     class Worker;
56     class XMLHttpRequest;
57     class XMLHttpRequestUpload;
58
59     typedef int ExceptionCode;
60
61     class EventTarget {
62     public:
63         virtual EventSource* toEventSource();
64         virtual MessagePort* toMessagePort();
65         virtual Node* toNode();
66         virtual DOMWindow* toDOMWindow();
67         virtual XMLHttpRequest* toXMLHttpRequest();
68         virtual XMLHttpRequestUpload* toXMLHttpRequestUpload();
69 #if ENABLE(OFFLINE_WEB_APPLICATIONS)
70         virtual DOMApplicationCache* toDOMApplicationCache();
71 #endif
72 #if ENABLE(SVG)
73         virtual SVGElementInstance* toSVGElementInstance();
74 #endif
75 #if ENABLE(WORKERS)
76         virtual Worker* toWorker();
77         virtual DedicatedWorkerContext* toDedicatedWorkerContext();
78 #endif
79 #if ENABLE(SHARED_WORKERS)
80         virtual SharedWorker* toSharedWorker();
81         virtual SharedWorkerContext* toSharedWorkerContext();
82 #endif
83 #if ENABLE(WEB_SOCKETS)
84         virtual WebSocket* toWebSocket();
85 #endif
86
87 #if ENABLE(NOTIFICATIONS)
88         virtual Notification* toNotification();
89 #endif
90
91         virtual ScriptExecutionContext* scriptExecutionContext() const = 0;
92
93         virtual void addEventListener(const AtomicString& eventType, PassRefPtr<EventListener>, bool useCapture) = 0;
94         virtual void removeEventListener(const AtomicString& eventType, EventListener*, bool useCapture) = 0;
95         virtual bool dispatchEvent(PassRefPtr<Event>, ExceptionCode&) = 0;
96
97         void ref() { refEventTarget(); }
98         void deref() { derefEventTarget(); }
99
100         // Handlers to do/undo actions on the target node before an event is dispatched to it and after the event
101         // has been dispatched.  The data pointer is handed back by the preDispatch and passed to postDispatch.
102         virtual void* preDispatchEventHandler(Event*) { return 0; }
103         virtual void postDispatchEventHandler(Event*, void* /*dataFromPreDispatch*/) { }
104
105     protected:
106         virtual ~EventTarget();
107
108     private:
109         virtual void refEventTarget() = 0;
110         virtual void derefEventTarget() = 0;
111     };
112
113     void forbidEventDispatch();
114     void allowEventDispatch();
115
116 #ifndef NDEBUG
117     bool eventDispatchForbidden();
118 #else
119     inline void forbidEventDispatch() { }
120     inline void allowEventDispatch() { }
121 #endif
122
123 }
124
125 #endif