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