4ce9268bc85b68d1277ddfa037bd227f26650300
[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 EventPath;
40 class EventTarget;
41 class HTMLIFrameElement;
42
43 struct EventInit {
44     bool bubbles { false };
45     bool cancelable { false };
46     bool scoped { false };
47     bool relatedTargetScoped { false };
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 Ref<Event> create(const AtomicString& type, bool canBubble, bool cancelable)
87     {
88         return adoptRef(*new Event(type, canBubble, cancelable));
89     }
90
91     static Ref<Event> createForBindings()
92     {
93         return adoptRef(*new Event);
94     }
95
96     static Ref<Event> createForBindings(const AtomicString& type, const EventInit& initializer)
97     {
98         return adoptRef(*new Event(type, initializer));
99     }
100
101     virtual ~Event();
102
103     void initEvent(const AtomicString& type, bool canBubble, bool cancelable);
104     bool isInitialized() const { return m_isInitialized; }
105
106     const AtomicString& type() const { return m_type; }
107     void setType(const AtomicString& type) { m_type = type; }
108     
109     EventTarget* target() const { return m_target.get(); }
110     void setTarget(RefPtr<EventTarget>&&);
111
112     EventTarget* currentTarget() const { return m_currentTarget; }
113     void setCurrentTarget(EventTarget* currentTarget) { m_currentTarget = currentTarget; }
114
115     unsigned short eventPhase() const { return m_eventPhase; }
116     void setEventPhase(unsigned short eventPhase) { m_eventPhase = eventPhase; }
117
118     bool bubbles() const { return m_canBubble; }
119     bool cancelable() const { return m_cancelable; }
120     bool scoped() const;
121     virtual bool relatedTargetScoped() const { return m_relatedTargetScoped; }
122
123     DOMTimeStamp timeStamp() const { return m_createTime; }
124
125     void setEventPath(const EventPath& path) { m_eventPath = &path; }
126     void clearEventPath() { m_eventPath = nullptr; }
127     Vector<EventTarget*> deepPath() const;
128
129     void stopPropagation() { m_propagationStopped = true; }
130     void stopImmediatePropagation() { m_immediatePropagationStopped = true; }
131
132     bool isTrusted() const { return m_isTrusted; }
133     void setUntrusted() { m_isTrusted = false; }
134     
135     // IE Extensions
136     EventTarget* srcElement() const { return target(); } // MSIE extension - "the object that fired the event"
137
138     bool legacyReturnValue() const { return !defaultPrevented(); }
139     void setLegacyReturnValue(bool returnValue) { setDefaultPrevented(!returnValue); }
140
141     DataTransfer* clipboardData() const { return isClipboardEvent() ? internalDataTransfer() : nullptr; }
142
143     virtual EventInterface eventInterface() const;
144
145     // These events are general classes of events.
146     virtual bool isUIEvent() const;
147     virtual bool isMouseEvent() const;
148     virtual bool isFocusEvent() const;
149     virtual bool isKeyboardEvent() const;
150     virtual bool isTouchEvent() const;
151
152     // Drag events are a subset of mouse events.
153     virtual bool isDragEvent() const;
154
155     // These events lack a DOM interface.
156     virtual bool isClipboardEvent() const;
157     virtual bool isBeforeTextInsertedEvent() const;
158
159     virtual bool isBeforeUnloadEvent() const;
160
161     virtual bool isErrorEvent() const;
162     virtual bool isTextEvent() const;
163     virtual bool isWheelEvent() const;
164
165 #if ENABLE(INDEXED_DATABASE)
166     virtual bool isVersionChangeEvent() const { return false; }
167 #endif
168
169     bool propagationStopped() const { return m_propagationStopped || m_immediatePropagationStopped; }
170     bool immediatePropagationStopped() const { return m_immediatePropagationStopped; }
171
172     bool defaultPrevented() const { return m_defaultPrevented; }
173     void preventDefault()
174     {
175         if (m_cancelable)
176             m_defaultPrevented = true;
177     }
178     void setDefaultPrevented(bool defaultPrevented) { m_defaultPrevented = defaultPrevented; }
179
180     bool defaultHandled() const { return m_defaultHandled; }
181     void setDefaultHandled() { m_defaultHandled = true; }
182
183     bool cancelBubble() const { return m_cancelBubble; }
184     void setCancelBubble(bool cancel) { m_cancelBubble = cancel; }
185
186     Event* underlyingEvent() const { return m_underlyingEvent.get(); }
187     void setUnderlyingEvent(Event*);
188
189     virtual DataTransfer* internalDataTransfer() const { return 0; }
190
191     bool isBeingDispatched() const { return eventPhase(); }
192
193     virtual Ref<Event> cloneFor(HTMLIFrameElement*) const;
194
195     virtual EventTarget* relatedTarget() const { return nullptr; }
196
197 protected:
198     Event();
199     WEBCORE_EXPORT Event(const AtomicString& type, bool canBubble, bool cancelable);
200     Event(const AtomicString& type, bool canBubble, bool cancelable, double timestamp);
201     Event(const AtomicString& type, const EventInit&);
202
203     virtual void receivedTarget();
204     bool dispatched() const { return m_target; }
205
206 private:
207     bool m_isInitialized { false };
208     AtomicString m_type;
209     bool m_canBubble { false };
210     bool m_cancelable { false };
211     bool m_scoped { false };
212     bool m_relatedTargetScoped { false };
213
214     bool m_propagationStopped { false };
215     bool m_immediatePropagationStopped { false };
216     bool m_defaultPrevented { false };
217     bool m_defaultHandled { false };
218     bool m_cancelBubble { false };
219     bool m_isTrusted { false };
220
221     unsigned short m_eventPhase { 0 };
222     EventTarget* m_currentTarget { nullptr };
223     const EventPath* m_eventPath { nullptr };
224     RefPtr<EventTarget> m_target;
225     DOMTimeStamp m_createTime;
226
227     RefPtr<Event> m_underlyingEvent;
228 };
229
230 } // namespace WebCore
231
232 #define SPECIALIZE_TYPE_TRAITS_EVENT(ToValueTypeName) \
233 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ToValueTypeName) \
234     static bool isType(const WebCore::Event& event) { return event.is##ToValueTypeName(); } \
235 SPECIALIZE_TYPE_TRAITS_END()
236
237 #endif // Event_h