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