Event improvements
[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-2017 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 #pragma once
25
26 #include "DOMHighResTimeStamp.h"
27 #include "EventInit.h"
28 #include "EventInterfaces.h"
29 #include "ExceptionOr.h"
30 #include "ScriptWrappable.h"
31 #include <wtf/MonotonicTime.h>
32 #include <wtf/TypeCasts.h>
33 #include <wtf/text/AtomicString.h>
34
35 namespace WebCore {
36
37 class EventPath;
38 class EventTarget;
39 class ScriptExecutionContext;
40
41 enum EventInterface {
42
43 #define DOM_EVENT_INTERFACE_DECLARE(name) name##InterfaceType,
44 DOM_EVENT_INTERFACES_FOR_EACH(DOM_EVENT_INTERFACE_DECLARE)
45 #undef DOM_EVENT_INTERFACE_DECLARE
46
47 };
48
49 class Event : public ScriptWrappable, public RefCounted<Event> {
50 public:
51     enum class IsTrusted { No, Yes };
52
53     enum PhaseType { 
54         NONE = 0,
55         CAPTURING_PHASE = 1,
56         AT_TARGET = 2,
57         BUBBLING_PHASE = 3
58     };
59
60     WEBCORE_EXPORT static Ref<Event> create(const AtomicString& type, bool canBubble, bool cancelable);
61     static Ref<Event> createForBindings();
62     static Ref<Event> create(const AtomicString& type, const EventInit&, IsTrusted = IsTrusted::No);
63
64     virtual ~Event();
65
66     WEBCORE_EXPORT void initEvent(const AtomicString& type, bool canBubble, bool cancelable);
67
68     bool isInitialized() const { return m_isInitialized; }
69
70     const AtomicString& type() const { return m_type; }
71     void setType(const AtomicString& type) { m_type = type; }
72     
73     EventTarget* target() const { return m_target.get(); }
74     void setTarget(RefPtr<EventTarget>&&);
75
76     EventTarget* currentTarget() const { return m_currentTarget.get(); }
77     void setCurrentTarget(EventTarget*);
78
79     unsigned short eventPhase() const { return m_eventPhase; }
80     void setEventPhase(PhaseType phase) { m_eventPhase = phase; }
81
82     bool bubbles() const { return m_canBubble; }
83     bool cancelable() const { return m_cancelable; }
84     WEBCORE_EXPORT bool composed() const;
85
86     DOMHighResTimeStamp timeStampForBindings(ScriptExecutionContext&) const;
87     MonotonicTime timeStamp() const { return m_createTime; }
88
89     void setEventPath(const EventPath& path) { m_eventPath = &path; }
90     Vector<EventTarget*> composedPath() const;
91
92     void stopPropagation() { m_propagationStopped = true; }
93     void stopImmediatePropagation() { m_immediatePropagationStopped = true; }
94
95     bool isTrusted() const { return m_isTrusted; }
96     void setUntrusted() { m_isTrusted = false; }
97
98     bool legacyReturnValue() const { return !m_wasCanceled; }
99     void setLegacyReturnValue(bool returnValue) { m_wasCanceled = !returnValue; }
100
101     virtual EventInterface eventInterface() const { return EventInterfaceType; }
102
103     virtual bool isBeforeTextInsertedEvent() const { return false; }
104     virtual bool isBeforeUnloadEvent() const { return false; }
105     virtual bool isClipboardEvent() const { return false; }
106     virtual bool isCompositionEvent() const { return false; }
107     virtual bool isErrorEvent() const { return false; }
108     virtual bool isFocusEvent() const { return false; }
109     virtual bool isInputEvent() const { return false; }
110     virtual bool isKeyboardEvent() const { return false; }
111     virtual bool isMouseEvent() const { return false; }
112     virtual bool isTextEvent() const { return false; }
113     virtual bool isTouchEvent() const { return false; }
114     virtual bool isUIEvent() const { return false; }
115     virtual bool isVersionChangeEvent() const { return false; }
116     virtual bool isWheelEvent() const { return false; }
117
118     bool propagationStopped() const { return m_propagationStopped || m_immediatePropagationStopped; }
119     bool immediatePropagationStopped() const { return m_immediatePropagationStopped; }
120
121     void resetBeforeDispatch();
122     void resetAfterDispatch();
123
124     bool defaultPrevented() const { return m_wasCanceled; }
125     void preventDefault();
126
127     bool defaultHandled() const { return m_defaultHandled; }
128     void setDefaultHandled() { m_defaultHandled = true; }
129
130     void setInPassiveListener(bool value) { m_isExecutingPassiveEventListener = value; }
131
132     bool cancelBubble() const { return propagationStopped(); }
133     void setCancelBubble(bool);
134
135     Event* underlyingEvent() const { return m_underlyingEvent.get(); }
136     void setUnderlyingEvent(Event*);
137
138     // Returns true if the dispatch flag is set.
139     // https://dom.spec.whatwg.org/#dispatch-flag
140     bool isBeingDispatched() const { return eventPhase(); }
141
142     virtual EventTarget* relatedTarget() const { return nullptr; }
143     virtual void setRelatedTarget(EventTarget&) { }
144
145 protected:
146     explicit Event(IsTrusted = IsTrusted::No);
147     Event(const AtomicString& type, bool canBubble, bool cancelable);
148     Event(const AtomicString& type, bool canBubble, bool cancelable, MonotonicTime timestamp);
149     Event(const AtomicString& type, const EventInit&, IsTrusted);
150
151     virtual void receivedTarget() { }
152
153 private:
154     AtomicString m_type;
155
156     bool m_isInitialized { false };
157     bool m_canBubble { false };
158     bool m_cancelable { false };
159     bool m_composed { false };
160
161     bool m_propagationStopped { false };
162     bool m_immediatePropagationStopped { false };
163     bool m_wasCanceled { false };
164     bool m_defaultHandled { false };
165     bool m_isTrusted { false };
166     bool m_isExecutingPassiveEventListener { false };
167
168     PhaseType m_eventPhase { NONE };
169     RefPtr<EventTarget> m_currentTarget;
170     const EventPath* m_eventPath { nullptr };
171     RefPtr<EventTarget> m_target;
172     MonotonicTime m_createTime;
173
174     RefPtr<Event> m_underlyingEvent;
175 };
176
177 inline void Event::preventDefault()
178 {
179     if (m_cancelable && !m_isExecutingPassiveEventListener)
180         m_wasCanceled = true;
181     // FIXME: Specification suggests we log something to the console when preventDefault is called but
182     // doesn't do anything because the event is not cancelable or is executing passive event listeners.
183 }
184
185 inline void Event::setCancelBubble(bool cancel)
186 {
187     if (cancel)
188         m_propagationStopped = true;
189 }
190
191 } // namespace WebCore
192
193 #define SPECIALIZE_TYPE_TRAITS_EVENT(ToValueTypeName) \
194 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ToValueTypeName) \
195     static bool isType(const WebCore::Event& event) { return event.is##ToValueTypeName(); } \
196 SPECIALIZE_TYPE_TRAITS_END()