DXR is a code search and navigation tool aimed at making sense of large projects. It supports full-text and regex searches as well as structural queries.

Implementation

Mercurial (ca88b9fad7d5)

VCS Links

Line Code
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef mozilla_DOMEventTargetHelper_h_
#define mozilla_DOMEventTargetHelper_h_

#include "nsCOMPtr.h"
#include "nsGkAtoms.h"
#include "nsCycleCollectionParticipant.h"
#include "nsPIDOMWindow.h"
#include "nsIScriptGlobalObject.h"
#include "nsIScriptContext.h"
#include "nsIWeakReferenceUtils.h"
#include "MainThreadUtils.h"
#include "mozilla/Attributes.h"
#include "mozilla/EventListenerManager.h"
#include "mozilla/dom/EventTarget.h"

struct JSCompartment;
class nsIDocument;

namespace mozilla {

class ErrorResult;

#define NS_DOMEVENTTARGETHELPER_IID                  \
  {                                                  \
    0xa28385c6, 0x9451, 0x4d7e, {                    \
      0xa3, 0xdd, 0xf4, 0xb6, 0x87, 0x2f, 0xa4, 0x76 \
    }                                                \
  }

class DOMEventTargetHelper : public dom::EventTarget {
 public:
  DOMEventTargetHelper()
      : mParentObject(nullptr),
        mOwnerWindow(nullptr),
        mHasOrHasHadOwnerWindow(false),
        mIsKeptAlive(false) {}
  explicit DOMEventTargetHelper(nsPIDOMWindowInner* aWindow)
      : mParentObject(nullptr),
        mOwnerWindow(nullptr),
        mHasOrHasHadOwnerWindow(false),
        mIsKeptAlive(false) {
    BindToOwner(aWindow);
  }
  explicit DOMEventTargetHelper(nsIGlobalObject* aGlobalObject)
      : mParentObject(nullptr),
        mOwnerWindow(nullptr),
        mHasOrHasHadOwnerWindow(false),
        mIsKeptAlive(false) {
    BindToOwner(aGlobalObject);
  }
  explicit DOMEventTargetHelper(DOMEventTargetHelper* aOther)
      : mParentObject(nullptr),
        mOwnerWindow(nullptr),
        mHasOrHasHadOwnerWindow(false),
        mIsKeptAlive(false) {
    BindToOwner(aOther);
  }

  NS_DECL_CYCLE_COLLECTING_ISUPPORTS
  NS_DECL_CYCLE_COLLECTION_SKIPPABLE_SCRIPT_HOLDER_CLASS(DOMEventTargetHelper)

  NS_DECL_NSIDOMEVENTTARGET

  virtual EventListenerManager* GetExistingListenerManager() const override;
  virtual EventListenerManager* GetOrCreateListenerManager() override;

  using dom::EventTarget::RemoveEventListener;
  virtual void AddEventListener(
      const nsAString& aType, dom::EventListener* aListener,
      const dom::AddEventListenerOptionsOrBoolean& aOptions,
      const dom::Nullable<bool>& aWantsUntrusted, ErrorResult& aRv) override;

  NS_DECLARE_STATIC_IID_ACCESSOR(NS_DOMEVENTTARGETHELPER_IID)

  void GetParentObject(nsIScriptGlobalObject** aParentObject) {
    if (mParentObject) {
      CallQueryInterface(mParentObject, aParentObject);
    } else {
      *aParentObject = nullptr;
    }
  }

  static DOMEventTargetHelper* FromSupports(nsISupports* aSupports) {
    dom::EventTarget* target = static_cast<dom::EventTarget*>(aSupports);
#ifdef DEBUG
    {
      nsCOMPtr<dom::EventTarget> target_qi = do_QueryInterface(aSupports);

      // If this assertion fires the QI implementation for the object in
      // question doesn't use the EventTarget pointer as the
      // nsISupports pointer. That must be fixed, or we'll crash...
      NS_ASSERTION(target_qi == target, "Uh, fix QI!");
    }
#endif

    return static_cast<DOMEventTargetHelper*>(target);
  }

  bool HasListenersFor(const nsAString& aType) {
    return mListenerManager && mListenerManager->HasListenersFor(aType);
  }

  bool HasListenersFor(nsAtom* aTypeWithOn) {
    return mListenerManager && mListenerManager->HasListenersFor(aTypeWithOn);
  }

  virtual nsPIDOMWindowOuter* GetOwnerGlobalForBindings() override {
    return nsPIDOMWindowOuter::GetFromCurrentInner(GetOwner());
  }

  nsresult CheckInnerWindowCorrectness() const {
    NS_ENSURE_STATE(!mHasOrHasHadOwnerWindow || mOwnerWindow);
    if (mOwnerWindow && !mOwnerWindow->IsCurrentInnerWindow()) {
      return NS_ERROR_FAILURE;
    }
    return NS_OK;
  }

  nsPIDOMWindowInner* GetOwner() const { return mOwnerWindow; }
  // Like GetOwner, but only returns non-null if the window being returned is
  // current (in the "current document" sense of the HTML spec).
  nsPIDOMWindowInner* GetWindowIfCurrent() const;
  // Returns the document associated with this event target, if that document is
  // the current document of its browsing context.  Will return null otherwise.
  nsIDocument* GetDocumentIfCurrent() const;
  void BindToOwner(nsIGlobalObject* aOwner);
  void BindToOwner(nsPIDOMWindowInner* aOwner);
  void BindToOwner(DOMEventTargetHelper* aOther);
  virtual void DisconnectFromOwner();
  using EventTarget::GetParentObject;
  virtual nsIGlobalObject* GetOwnerGlobal() const override {
    return mParentObject;
  }
  bool HasOrHasHadOwner() { return mHasOrHasHadOwnerWindow; }

  virtual void EventListenerAdded(nsAtom* aType) override;
  virtual void EventListenerAdded(const nsAString& aType) override;

  virtual void EventListenerRemoved(nsAtom* aType) override;
  virtual void EventListenerRemoved(const nsAString& aType) override;

  virtual void EventListenerWasAdded(const nsAString& aType, ErrorResult& aRv,
                                     JSCompartment* aCompartment = nullptr) {}
  virtual void EventListenerWasRemoved(const nsAString& aType, ErrorResult& aRv,
                                       JSCompartment* aCompartment = nullptr) {}

  // Dispatch a trusted, non-cancellable and non-bubbling event to |this|.
  nsresult DispatchTrustedEvent(const nsAString& aEventName);

 protected:
  virtual ~DOMEventTargetHelper();

  nsresult WantsUntrusted(bool* aRetVal);

  void MaybeUpdateKeepAlive();
  void MaybeDontKeepAlive();

  // If this method returns true your object is kept alive until it returns
  // false. You can use this method instead using
  // NS_IMPL_CYCLE_COLLECTION_CAN_SKIP_BEGIN macro.
  virtual bool IsCertainlyAliveForCC() const { return mIsKeptAlive; }

  RefPtr<EventListenerManager> mListenerManager;
  // Make |event| trusted and dispatch |aEvent| to |this|.
  nsresult DispatchTrustedEvent(nsIDOMEvent* aEvent);

  virtual void LastRelease() {}

  void KeepAliveIfHasListenersFor(const nsAString& aType);
  void KeepAliveIfHasListenersFor(nsAtom* aType);

  void IgnoreKeepAliveIfHasListenersFor(const nsAString& aType);
  void IgnoreKeepAliveIfHasListenersFor(nsAtom* aType);

 private:
  // The parent global object.  The global will clear this when
  // it is destroyed by calling DisconnectFromOwner().
  nsIGlobalObject* MOZ_NON_OWNING_REF mParentObject;
  // mParentObject pre QI-ed and cached (inner window)
  // (it is needed for off main thread access)
  // It is obtained in BindToOwner and reset in DisconnectFromOwner.
  nsPIDOMWindowInner* MOZ_NON_OWNING_REF mOwnerWindow;
  bool mHasOrHasHadOwnerWindow;

  struct {
    nsTArray<nsString> mStrings;
    nsTArray<RefPtr<nsAtom>> mAtoms;
  } mKeepingAliveTypes;

  bool mIsKeptAlive;
};

NS_DEFINE_STATIC_IID_ACCESSOR(DOMEventTargetHelper, NS_DOMEVENTTARGETHELPER_IID)

}  // namespace mozilla

// WebIDL event handlers
#define IMPL_EVENT_HANDLER(_event)                                          \
  inline mozilla::dom::EventHandlerNonNull* GetOn##_event() {               \
    if (NS_IsMainThread()) {                                                \
      return GetEventHandler(nsGkAtoms::on##_event, EmptyString());         \
    }                                                                       \
    return GetEventHandler(nullptr, NS_LITERAL_STRING(#_event));            \
  }                                                                         \
  inline void SetOn##_event(mozilla::dom::EventHandlerNonNull* aCallback) { \
    if (NS_IsMainThread()) {                                                \
      SetEventHandler(nsGkAtoms::on##_event, EmptyString(), aCallback);     \
    } else {                                                                \
      SetEventHandler(nullptr, NS_LITERAL_STRING(#_event), aCallback);      \
    }                                                                       \
  }

/* Use this macro to declare functions that forward the behavior of this
 * interface to another object.
 * This macro doesn't forward GetEventTargetParent because sometimes subclasses
 * want to override it.
 */
#define NS_FORWARD_NSIDOMEVENTTARGET_NOGETEVENTTARGETPARENT(_to)               \
  NS_IMETHOD AddEventListener(const nsAString& type,                           \
                              nsIDOMEventListener* listener, bool useCapture,  \
                              bool wantsUntrusted, uint8_t _argc) override {   \
    return _to AddEventListener(type, listener, useCapture, wantsUntrusted,    \
                                _argc);                                        \
  }                                                                            \
  NS_IMETHOD AddSystemEventListener(                                           \
      const nsAString& type, nsIDOMEventListener* listener, bool aUseCapture,  \
      bool aWantsUntrusted, uint8_t _argc) override {                          \
    return _to AddSystemEventListener(type, listener, aUseCapture,             \
                                      aWantsUntrusted, _argc);                 \
  }                                                                            \
  NS_IMETHOD RemoveEventListener(                                              \
      const nsAString& type, nsIDOMEventListener* listener, bool useCapture)   \
      override {                                                               \
    return _to RemoveEventListener(type, listener, useCapture);                \
  }                                                                            \
  NS_IMETHOD RemoveSystemEventListener(                                        \
      const nsAString& type, nsIDOMEventListener* listener, bool aUseCapture)  \
      override {                                                               \
    return _to RemoveSystemEventListener(type, listener, aUseCapture);         \
  }                                                                            \
  NS_IMETHOD DispatchEvent(nsIDOMEvent* evt, bool* _retval) override {         \
    return _to DispatchEvent(evt, _retval);                                    \
  }                                                                            \
  virtual mozilla::dom::EventTarget* GetTargetForDOMEvent() {                  \
    return _to GetTargetForDOMEvent();                                         \
  }                                                                            \
  virtual mozilla::dom::EventTarget* GetTargetForEventTargetChain() {          \
    return _to GetTargetForEventTargetChain();                                 \
  }                                                                            \
  virtual nsresult WillHandleEvent(mozilla::EventChainPostVisitor& aVisitor) { \
    return _to WillHandleEvent(aVisitor);                                      \
  }                                                                            \
  virtual nsresult PostHandleEvent(mozilla::EventChainPostVisitor& aVisitor) { \
    return _to PostHandleEvent(aVisitor);                                      \
  }                                                                            \
  virtual nsresult DispatchDOMEvent(                                           \
      mozilla::WidgetEvent* aEvent, nsIDOMEvent* aDOMEvent,                    \
      nsPresContext* aPresContext, nsEventStatus* aEventStatus) {              \
    return _to DispatchDOMEvent(aEvent, aDOMEvent, aPresContext,               \
                                aEventStatus);                                 \
  }                                                                            \
  virtual mozilla::EventListenerManager* GetOrCreateListenerManager() {        \
    return _to GetOrCreateListenerManager();                                   \
  }                                                                            \
  virtual mozilla::EventListenerManager* GetExistingListenerManager() const {  \
    return _to GetExistingListenerManager();                                   \
  }                                                                            \
  virtual nsIScriptContext* GetContextForEventHandlers(nsresult* aRv) {        \
    return _to GetContextForEventHandlers(aRv);                                \
  }

#define NS_REALLY_FORWARD_NSIDOMEVENTTARGET(_class)                   \
  using _class::AddEventListener;                                     \
  using _class::RemoveEventListener;                                  \
  NS_FORWARD_NSIDOMEVENTTARGET(_class::)                              \
  virtual mozilla::EventListenerManager* GetOrCreateListenerManager() \
      override {                                                      \
    return _class::GetOrCreateListenerManager();                      \
  }                                                                   \
  virtual mozilla::EventListenerManager* GetExistingListenerManager() \
      const override {                                                \
    return _class::GetExistingListenerManager();                      \
  }

#endif  // mozilla_DOMEventTargetHelper_h_