Use is<>() / downcast<>() for Event classes
[WebKit-https.git] / Source / WebCore / dom / Event.h
1 /*
2  * Copyright (C) 2001 Peter Kelly (pmk@post.com)
3  * Copyright (C) 2001 Tobias Anton (anton@stud.fbi.fh-darmstadt.de)
4  * Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
5  * Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2013 Apple Inc. All rights reserved.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public License
18  * along with this library; see the file COPYING.LIB.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20  * Boston, MA 02110-1301, USA.
21  *
22  */
23
24 #ifndef Event_h
25 #define Event_h
26
27 #include "DOMTimeStamp.h"
28 #include "EventInterfaces.h"
29 #include "ScriptWrappable.h"
30 #include <wtf/HashMap.h>
31 #include <wtf/ListHashSet.h>
32 #include <wtf/RefCounted.h>
33 #include <wtf/TypeCasts.h>
34 #include <wtf/text/AtomicString.h>
35
36 namespace WebCore {
37
38 class DataTransfer;
39 class EventTarget;
40 class HTMLIFrameElement;
41
42 struct EventInit {
43     EventInit();
44     EventInit(bool bubbles, bool cancelable);
45
46     bool bubbles;
47     bool cancelable;
48 };
49
50 enum EventInterface {
51
52 #define DOM_EVENT_INTERFACE_DECLARE(name) name##InterfaceType,
53 DOM_EVENT_INTERFACES_FOR_EACH(DOM_EVENT_INTERFACE_DECLARE)
54 #undef DOM_EVENT_INTERFACE_DECLARE
55
56 };
57
58 class Event : public ScriptWrappable, public RefCounted<Event> {
59 public:
60     enum PhaseType { 
61         NONE                = 0,
62         CAPTURING_PHASE     = 1, 
63         AT_TARGET           = 2,
64         BUBBLING_PHASE      = 3 
65     };
66
67     enum EventType {
68         MOUSEDOWN           = 1,
69         MOUSEUP             = 2,
70         MOUSEOVER           = 4,
71         MOUSEOUT            = 8,
72         MOUSEMOVE           = 16,
73         MOUSEDRAG           = 32,
74         CLICK               = 64,
75         DBLCLICK            = 128,
76         KEYDOWN             = 256,
77         KEYUP               = 512,
78         KEYPRESS            = 1024,
79         DRAGDROP            = 2048,
80         FOCUS               = 4096,
81         BLUR                = 8192,
82         SELECT              = 16384,
83         CHANGE              = 32768
84     };
85
86     static PassRefPtr<Event> create()
87     {
88         return adoptRef(new Event);
89     }
90     WEBCORE_EXPORT static PassRefPtr<Event> create(const AtomicString& type, bool canBubble, bool cancelable)
91     {
92         return adoptRef(new Event(type, canBubble, cancelable));
93     }
94
95     static PassRefPtr<Event> create(const AtomicString& type, const EventInit& initializer)
96     {
97         return adoptRef(new Event(type, initializer));
98     }
99
100     virtual ~Event();
101
102     void initEvent(const AtomicString& type, bool canBubble, bool cancelable);
103
104     const AtomicString& type() const { return m_type; }
105     void setType(const AtomicString& type) { m_type = type; }
106     
107     EventTarget* target() const { return m_target.get(); }
108     void setTarget(PassRefPtr<EventTarget>);
109
110     EventTarget* currentTarget() const { return m_currentTarget; }
111     void setCurrentTarget(EventTarget* currentTarget) { m_currentTarget = currentTarget; }
112
113     unsigned short eventPhase() const { return m_eventPhase; }
114     void setEventPhase(unsigned short eventPhase) { m_eventPhase = eventPhase; }
115
116     bool bubbles() const { return m_canBubble; }
117     bool cancelable() const { return m_cancelable; }
118     DOMTimeStamp timeStamp() const { return m_createTime; }
119
120     void stopPropagation() { m_propagationStopped = true; }
121     void stopImmediatePropagation() { m_immediatePropagationStopped = true; }
122     
123     // IE Extensions
124     EventTarget* srcElement() const { return target(); } // MSIE extension - "the object that fired the event"
125
126     bool legacyReturnValue() const { return !defaultPrevented(); }
127     void setLegacyReturnValue(bool returnValue) { setDefaultPrevented(!returnValue); }
128
129     DataTransfer* clipboardData() const { return isClipboardEvent() ? internalDataTransfer() : 0; }
130
131     virtual EventInterface eventInterface() const;
132
133     // These events are general classes of events.
134     virtual bool isUIEvent() const;
135     virtual bool isMouseEvent() const;
136     virtual bool isFocusEvent() const;
137     virtual bool isKeyboardEvent() const;
138     virtual bool isTouchEvent() const;
139
140     // Drag events are a subset of mouse events.
141     virtual bool isDragEvent() const;
142
143     // These events lack a DOM interface.
144     virtual bool isClipboardEvent() const;
145     virtual bool isBeforeTextInsertedEvent() const;
146
147     virtual bool isBeforeUnloadEvent() const;
148
149     virtual bool isErrorEvent() const;
150     virtual bool isTextEvent() const;
151     virtual bool isWheelEvent() const;
152
153     bool propagationStopped() const { return m_propagationStopped || m_immediatePropagationStopped; }
154     bool immediatePropagationStopped() const { return m_immediatePropagationStopped; }
155
156     bool defaultPrevented() const { return m_defaultPrevented; }
157     void preventDefault()
158     {
159         if (m_cancelable)
160             m_defaultPrevented = true;
161     }
162     void setDefaultPrevented(bool defaultPrevented) { m_defaultPrevented = defaultPrevented; }
163
164     bool defaultHandled() const { return m_defaultHandled; }
165     void setDefaultHandled() { m_defaultHandled = true; }
166
167     bool cancelBubble() const { return m_cancelBubble; }
168     void setCancelBubble(bool cancel) { m_cancelBubble = cancel; }
169
170     Event* underlyingEvent() const { return m_underlyingEvent.get(); }
171     void setUnderlyingEvent(PassRefPtr<Event>);
172
173     virtual DataTransfer* internalDataTransfer() const { return 0; }
174
175     bool isBeingDispatched() const { return eventPhase(); }
176
177     virtual PassRefPtr<Event> cloneFor(HTMLIFrameElement*) const;
178
179     virtual EventTarget* relatedTarget() const { return nullptr; }
180
181 protected:
182     Event();
183     Event(const AtomicString& type, bool canBubble, bool cancelable);
184     Event(const AtomicString& type, bool canBubble, bool cancelable, double timestamp);
185     Event(const AtomicString& type, const EventInit&);
186
187     virtual void receivedTarget();
188     bool dispatched() const { return m_target; }
189
190 private:
191     AtomicString m_type;
192     bool m_canBubble;
193     bool m_cancelable;
194
195     bool m_propagationStopped;
196     bool m_immediatePropagationStopped;
197     bool m_defaultPrevented;
198     bool m_defaultHandled;
199     bool m_cancelBubble;
200
201     unsigned short m_eventPhase;
202     EventTarget* m_currentTarget;
203     RefPtr<EventTarget> m_target;
204     DOMTimeStamp m_createTime;
205
206     RefPtr<Event> m_underlyingEvent;
207 };
208
209 } // namespace WebCore
210
211 #define SPECIALIZE_TYPE_TRAITS_EVENT(ToValueTypeName) \
212 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ToValueTypeName) \
213     static bool isType(const WebCore::Event& event) { return event.is##ToValueTypeName(); } \
214 SPECIALIZE_TYPE_TRAITS_END()
215
216 #endif // Event_h