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