Web Inspector: NMI: migrate core instrumentation code to WTF namespace
[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 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 "EventNames.h"
29 #include <wtf/HashMap.h>
30 #include <wtf/ListHashSet.h>
31 #include <wtf/RefCounted.h>
32 #include <wtf/text/AtomicString.h>
33
34 namespace WebCore {
35
36 class Clipboard;
37 class EventTarget;
38 class EventDispatcher;
39 class HTMLIFrameElement;
40
41 struct EventInit {
42     EventInit();
43      
44     bool bubbles;
45     bool cancelable;
46 };
47
48 class Event : public RefCounted<Event> {
49 public:
50     enum PhaseType { 
51         NONE                = 0,
52         CAPTURING_PHASE     = 1, 
53         AT_TARGET           = 2,
54         BUBBLING_PHASE      = 3 
55     };
56
57     enum EventType {
58         MOUSEDOWN           = 1,
59         MOUSEUP             = 2,
60         MOUSEOVER           = 4,
61         MOUSEOUT            = 8,
62         MOUSEMOVE           = 16,
63         MOUSEDRAG           = 32,
64         CLICK               = 64,
65         DBLCLICK            = 128,
66         KEYDOWN             = 256,
67         KEYUP               = 512,
68         KEYPRESS            = 1024,
69         DRAGDROP            = 2048,
70         FOCUS               = 4096,
71         BLUR                = 8192,
72         SELECT              = 16384,
73         CHANGE              = 32768
74     };
75
76     static PassRefPtr<Event> create()
77     {
78         return adoptRef(new Event);
79     }
80     static PassRefPtr<Event> create(const AtomicString& type, bool canBubble, bool cancelable)
81     {
82         return adoptRef(new Event(type, canBubble, cancelable));
83     }
84
85     static PassRefPtr<Event> create(const AtomicString& type, const EventInit& initializer)
86     {
87         return adoptRef(new Event(type, initializer));
88     }
89
90     virtual ~Event();
91
92     void initEvent(const AtomicString& type, bool canBubble, bool cancelable);
93
94     const AtomicString& type() const { return m_type; }
95     
96     EventTarget* target() const { return m_target.get(); }
97     void setTarget(PassRefPtr<EventTarget>);
98
99     EventTarget* currentTarget() const { return m_currentTarget; }
100     void setCurrentTarget(EventTarget* currentTarget) { m_currentTarget = currentTarget; }
101
102     unsigned short eventPhase() const { return m_eventPhase; }
103     void setEventPhase(unsigned short eventPhase) { m_eventPhase = eventPhase; }
104
105     bool bubbles() const { return m_canBubble; }
106     bool cancelable() const { return m_cancelable; }
107     DOMTimeStamp timeStamp() const { return m_createTime; }
108
109     void stopPropagation() { m_propagationStopped = true; }
110     void stopImmediatePropagation() { m_immediatePropagationStopped = true; }
111     
112     // IE Extensions
113     EventTarget* srcElement() const { return target(); } // MSIE extension - "the object that fired the event"
114
115     bool returnValue() const { return !defaultPrevented(); }
116     void setReturnValue(bool returnValue) { setDefaultPrevented(!returnValue); }
117
118     Clipboard* clipboardData() const { return isClipboardEvent() ? clipboard() : 0; }
119
120     virtual const AtomicString& interfaceName() const;
121     bool hasInterface(const AtomicString&) const;
122
123     // These events are general classes of events.
124     virtual bool isUIEvent() const;
125     virtual bool isMouseEvent() const;
126     virtual bool isKeyboardEvent() const;
127     virtual bool isTouchEvent() const;
128
129     // Drag events are a subset of mouse events.
130     virtual bool isDragEvent() const;
131
132     // These events lack a DOM interface.
133     virtual bool isClipboardEvent() const;
134     virtual bool isBeforeTextInsertedEvent() const;
135
136     bool propagationStopped() const { return m_propagationStopped || m_immediatePropagationStopped; }
137     bool immediatePropagationStopped() const { return m_immediatePropagationStopped; }
138
139     bool defaultPrevented() const { return m_defaultPrevented; }
140     void preventDefault()
141     {
142         if (m_cancelable)
143             m_defaultPrevented = true;
144     }
145     void setDefaultPrevented(bool defaultPrevented) { m_defaultPrevented = defaultPrevented; }
146
147     bool defaultHandled() const { return m_defaultHandled; }
148     void setDefaultHandled() { m_defaultHandled = true; }
149
150     bool cancelBubble() const { return m_cancelBubble; }
151     void setCancelBubble(bool cancel) { m_cancelBubble = cancel; }
152
153     Event* underlyingEvent() const { return m_underlyingEvent.get(); }
154     void setUnderlyingEvent(PassRefPtr<Event>);
155
156     virtual bool storesResultAsString() const;
157     virtual void storeResult(const String&);
158
159     virtual Clipboard* clipboard() const { return 0; }
160
161     bool isBeingDispatched() const { return eventPhase(); }
162
163     virtual void reportMemoryUsage(MemoryObjectInfo*) const;
164
165     virtual PassRefPtr<Event> cloneFor(HTMLIFrameElement*) const;
166
167 protected:
168     Event();
169     Event(const AtomicString& type, bool canBubble, bool cancelable);
170     Event(const AtomicString& type, const EventInit&);
171
172     virtual void receivedTarget();
173     bool dispatched() const { return m_target; }
174
175 private:
176     AtomicString m_type;
177     bool m_canBubble;
178     bool m_cancelable;
179
180     bool m_propagationStopped;
181     bool m_immediatePropagationStopped;
182     bool m_defaultPrevented;
183     bool m_defaultHandled;
184     bool m_cancelBubble;
185
186     unsigned short m_eventPhase;
187     EventTarget* m_currentTarget;
188     RefPtr<EventTarget> m_target;
189     DOMTimeStamp m_createTime;
190
191     RefPtr<Event> m_underlyingEvent;
192 };
193
194 } // namespace WebCore
195
196 #endif // Event_h