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