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