src/third_party/WebKit/Source/core/events/EventTarget.h

   1 /*
   2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
   3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
   4  *           (C) 2001 Dirk Mueller (mueller@kde.org)
   5  * Copyright (C) 2004, 2005, 2006, 2007, 2008 Apple Inc. All rights reserved.
   6  * Copyright (C) 2006 Alexey Proskuryakov (ap@webkit.org)
   7  *           (C) 2007, 2008 Nikolas Zimmermann <zimmermann@kde.org>
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  22  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  23  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  24  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  25  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  26  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  *
  30  */
  31
  32 #ifndef EventTarget_h
  33 #define EventTarget_h
  34
  35 #include "core/events/EventListenerMap.h"
  36 #include "core/events/ThreadLocalEventNames.h"
  37 #include "wtf/Forward.h"
  38
  39 namespace WebCore {
  40
  41 class ApplicationCache;
  42 class AudioContext;
  43 class DOMWindow;
  44 class DedicatedWorkerGlobalScope;
  45 class Event;
  46 class EventListener;
  47 class EventSource;
  48 class ExceptionState;
  49 class FileReader;
  50 class FileWriter;
  51 class IDBDatabase;
  52 class IDBRequest;
  53 class IDBTransaction;
  54 class MIDIAccess;
  55 class MIDIInput;
  56 class MIDIPort;
  57 class MediaController;
  58 class MediaStream;
  59 class MessagePort;
  60 class NamedFlow;
  61 class Node;
  62 class Notification;
  63 class SVGElementInstance;
  64 class ExecutionContext;
  65 class ScriptProcessorNode;
  66 class SharedWorker;
  67 class SharedWorkerGlobalScope;
  68 class TextTrack;
  69 class TextTrackCue;
  70 class WebSocket;
  71 class Worker;
  72 class XMLHttpRequest;
  73 class XMLHttpRequestUpload;
  74
  75 struct FiringEventIterator {
  76     FiringEventIterator(const AtomicString& eventType, size_t& iterator, size_t& end)
  77         : eventType(eventType)
  78         , iterator(iterator)
  79         , end(end)
  80     {
  81     }
  82
  83     const AtomicString& eventType;
  84     size_t& iterator;
  85     size_t& end;
  86 };
  87 typedef Vector<FiringEventIterator, 1> FiringEventIteratorVector;
  88
  89 struct EventTargetData {
  90     WTF_MAKE_NONCOPYABLE(EventTargetData); WTF_MAKE_FAST_ALLOCATED;
  91 public:
  92     EventTargetData();
  93     ~EventTargetData();
  94
  95     EventListenerMap eventListenerMap;
  96     OwnPtr<FiringEventIteratorVector> firingEventIterators;
  97 };
  98
  99 class EventTarget {
 100 public:
 101     void ref() { refEventTarget(); }
 102     void deref() { derefEventTarget(); }
 103
 104     virtual const AtomicString& interfaceName() const = 0;
 105     virtual ExecutionContext* executionContext() const = 0;
 106
 107     virtual Node* toNode();
 108     virtual DOMWindow* toDOMWindow();
 109     virtual MessagePort* toMessagePort();
 110
 111     virtual bool addEventListener(const AtomicString& eventType, PassRefPtr<EventListener>, bool useCapture);
 112     virtual bool removeEventListener(const AtomicString& eventType, EventListener*, bool useCapture);
 113     virtual void removeAllEventListeners();
 114     virtual bool dispatchEvent(PassRefPtr<Event>);
 115     bool dispatchEvent(PassRefPtr<Event>, ExceptionState&); // DOM API
 116     virtual void uncaughtExceptionInEventHandler();
 117
 118     // Used for legacy "onEvent" attribute APIs.
 119     bool setAttributeEventListener(const AtomicString& eventType, PassRefPtr<EventListener>, DOMWrapperWorld* isolatedWorld = 0);
 120     EventListener* getAttributeEventListener(const AtomicString& eventType, DOMWrapperWorld* isolatedWorld = 0);
 121
 122     bool hasEventListeners() const;
 123     bool hasEventListeners(const AtomicString& eventType) const;
 124     bool hasCapturingEventListeners(const AtomicString& eventType);
 125     const EventListenerVector& getEventListeners(const AtomicString& eventType);
 126     Vector<AtomicString> eventTypes();
 127
 128     bool fireEventListeners(Event*);
 129     bool isFiringEventListeners();
 130
 131 protected:
 132     virtual ~EventTarget();
 133
 134     // Subclasses should likely not override these themselves; instead, they should subclass EventTargetWithInlineData.
 135     virtual EventTargetData* eventTargetData() = 0;
 136     virtual EventTargetData& ensureEventTargetData() = 0;
 137
 138 private:
 139     // Subclasses should likely not override these themselves; instead, they should use the REFCOUNTED_EVENT_TARGET() macro.
 140     virtual void refEventTarget() = 0;
 141     virtual void derefEventTarget() = 0;
 142
 143     DOMWindow* executingWindow();
 144     void fireEventListeners(Event*, EventTargetData*, EventListenerVector&);
 145     void countLegacyEvents(const AtomicString& legacyTypeName, EventListenerVector*, EventListenerVector*);
 146
 147     bool clearAttributeEventListener(const AtomicString& eventType, DOMWrapperWorld* isolatedWorld);
 148
 149     friend class EventListenerIterator;
 150 };
 151
 152 class EventTargetWithInlineData : public EventTarget {
 153 protected:
 154     virtual EventTargetData* eventTargetData() OVERRIDE FINAL { return &m_eventTargetData; }
 155     virtual EventTargetData& ensureEventTargetData() OVERRIDE FINAL { return m_eventTargetData; }
 156 private:
 157     EventTargetData m_eventTargetData;
 158 };
 159
 160 // FIXME: These macros should be split into separate DEFINE and DECLARE
 161 // macros to avoid causing so many header includes.
 162 #define DEFINE_ATTRIBUTE_EVENT_LISTENER(attribute) \
 163     EventListener* on##attribute(DOMWrapperWorld* isolatedWorld) { return getAttributeEventListener(EventTypeNames::attribute, isolatedWorld); } \
 164     void setOn##attribute(PassRefPtr<EventListener> listener, DOMWrapperWorld* isolatedWorld = 0) { setAttributeEventListener(EventTypeNames::attribute, listener, isolatedWorld); } \
 165
 166 #define DEFINE_STATIC_ATTRIBUTE_EVENT_LISTENER(attribute) \
 167     static EventListener* on##attribute(EventTarget* eventTarget, DOMWrapperWorld* isolatedWorld) { return eventTarget->getAttributeEventListener(EventTypeNames::attribute, isolatedWorld); } \
 168     static void setOn##attribute(EventTarget* eventTarget, PassRefPtr<EventListener> listener, DOMWrapperWorld* isolatedWorld = 0) { eventTarget->setAttributeEventListener(EventTypeNames::attribute, listener, isolatedWorld); } \
 169
 170 #define DEFINE_WINDOW_ATTRIBUTE_EVENT_LISTENER(attribute) \
 171     EventListener* on##attribute(DOMWrapperWorld* isolatedWorld) { return document().getWindowAttributeEventListener(EventTypeNames::attribute, isolatedWorld); } \
 172     void setOn##attribute(PassRefPtr<EventListener> listener, DOMWrapperWorld* isolatedWorld) { document().setWindowAttributeEventListener(EventTypeNames::attribute, listener, isolatedWorld); } \
 173
 174 #define DEFINE_STATIC_WINDOW_ATTRIBUTE_EVENT_LISTENER(attribute) \
 175     static EventListener* on##attribute(EventTarget* eventTarget, DOMWrapperWorld* isolatedWorld) { \
 176         if (Node* node = eventTarget->toNode()) \
 177             return node->document().getWindowAttributeEventListener(EventTypeNames::attribute, isolatedWorld); \
 178         ASSERT(eventTarget->toDOMWindow()); \
 179         return eventTarget->getAttributeEventListener(EventTypeNames::attribute, isolatedWorld); \
 180     } \
 181     static void setOn##attribute(EventTarget* eventTarget, PassRefPtr<EventListener> listener, DOMWrapperWorld* isolatedWorld) { \
 182         if (Node* node = eventTarget->toNode()) \
 183             node->document().setWindowAttributeEventListener(EventTypeNames::attribute, listener, isolatedWorld); \
 184         else { \
 185             ASSERT(eventTarget->toDOMWindow()); \
 186             eventTarget->setAttributeEventListener(EventTypeNames::attribute, listener, isolatedWorld); \
 187         } \
 188     }
 189
 190 #define DEFINE_MAPPED_ATTRIBUTE_EVENT_LISTENER(attribute, eventName) \
 191     EventListener* on##attribute(DOMWrapperWorld* isolatedWorld) { return getAttributeEventListener(EventTypeNames::eventName, isolatedWorld); } \
 192     void setOn##attribute(PassRefPtr<EventListener> listener, DOMWrapperWorld* isolatedWorld) { setAttributeEventListener(EventTypeNames::eventName, listener, isolatedWorld); } \
 193
 194 #define DECLARE_FORWARDING_ATTRIBUTE_EVENT_LISTENER(recipient, attribute) \
 195     EventListener* on##attribute(DOMWrapperWorld* isolatedWorld); \
 196     void setOn##attribute(PassRefPtr<EventListener> listener, DOMWrapperWorld* isolatedWorld);
 197
 198 #define DEFINE_FORWARDING_ATTRIBUTE_EVENT_LISTENER(type, recipient, attribute) \
 199     EventListener* type::on##attribute(DOMWrapperWorld* isolatedWorld) { return recipient ? recipient->getAttributeEventListener(EventTypeNames::attribute, isolatedWorld) : 0; } \
 200     void type::setOn##attribute(PassRefPtr<EventListener> listener, DOMWrapperWorld* isolatedWorld) \
 201     { \
 202         if (recipient) \
 203             recipient->setAttributeEventListener(EventTypeNames::attribute, listener, isolatedWorld); \
 204     }
 205
 206 inline bool EventTarget::isFiringEventListeners()
 207 {
 208     EventTargetData* d = eventTargetData();
 209     if (!d)
 210         return false;
 211     return d->firingEventIterators && !d->firingEventIterators->isEmpty();
 212 }
 213
 214 inline bool EventTarget::hasEventListeners() const
 215 {
 216     // FIXME: We should have a const version of eventTargetData.
 217     if (const EventTargetData* d = const_cast<EventTarget*>(this)->eventTargetData())
 218         return !d->eventListenerMap.isEmpty();
 219     return false;
 220 }
 221
 222 inline bool EventTarget::hasEventListeners(const AtomicString& eventType) const
 223 {
 224     // FIXME: We should have const version of eventTargetData.
 225     if (const EventTargetData* d = const_cast<EventTarget*>(this)->eventTargetData())
 226         return d->eventListenerMap.contains(eventType);
 227     return false;
 228 }
 229
 230 inline bool EventTarget::hasCapturingEventListeners(const AtomicString& eventType)
 231 {
 232     EventTargetData* d = eventTargetData();
 233     if (!d)
 234         return false;
 235     return d->eventListenerMap.containsCapturing(eventType);
 236 }
 237
 238 } // namespace WebCore
 239
 240 #define DEFINE_EVENT_TARGET_REFCOUNTING(baseClass) \
 241 public: \
 242     using baseClass::ref; \
 243     using baseClass::deref; \
 244 private: \
 245     virtual void refEventTarget() OVERRIDE FINAL { ref(); } \
 246     virtual void derefEventTarget() OVERRIDE FINAL { deref(); } \
 247     typedef int thisIsHereToForceASemiColonAfterThisEventTargetMacro
 248
 249 // Use this macro if your EventTarget subclass is also a subclass of WTF::RefCounted.
 250 // A ref-counted class that uses a different method of refcounting should use DEFINE_EVENT_TARGET_REFCOUNTING directly.
 251 // Both of these macros are meant to be placed just before the "public:" section of the class declaration.
 252 #define REFCOUNTED_EVENT_TARGET(className) DEFINE_EVENT_TARGET_REFCOUNTING(RefCounted<className>)
 253
 254 #endif // EventTarget_h