widget/BasicEvents.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #ifndef mozilla_BasicEvents_h__
   7 #define mozilla_BasicEvents_h__
   8
   9 #include <stdint.h>
  10 #include <type_traits>
  11
  12 #include "mozilla/EventForwards.h"
  13 #include "mozilla/TimeStamp.h"
  14 #include "mozilla/dom/EventTarget.h"
  15 #include "mozilla/layers/LayersTypes.h"
  16 #include "nsCOMPtr.h"
  17 #include "nsAtom.h"
  18 #include "nsISupportsImpl.h"
  19 #include "nsIWidget.h"
  20 #include "nsString.h"
  21 #include "Units.h"
  22
  23 #ifdef DEBUG
  24 #  include "nsXULAppAPI.h"
  25 #endif  // #ifdef DEBUG
  26
  27 class nsIPrincipal;
  28
  29 namespace IPC {
  30 template <typename T>
  31 struct ParamTraits;
  32 }  // namespace IPC
  33
  34 namespace mozilla {
  35
  36 class EventTargetChainItem;
  37
  38 enum class CrossProcessForwarding {
  39   // eStop prevents the event to be sent to remote process.
  40   eStop,
  41   // eAllow keeps current state of the event whether it's sent to remote
  42   // process.  In other words, eAllow does NOT mean that making the event
  43   // sent to remote process when IsCrossProcessForwardingStopped() returns
  44   // true.
  45   eAllow,
  46 };
  47
  48 /******************************************************************************
  49  * mozilla::BaseEventFlags
  50  *
  51  * BaseEventFlags must be a POD struct for safe to use memcpy (including
  52  * in ParamTraits<BaseEventFlags>).  So don't make virtual methods, constructor,
  53  * destructor and operators.
  54  * This is necessary for VC which is NOT C++0x compiler.
  55  ******************************************************************************/
  56
  57 struct BaseEventFlags {
  58  public:
  59   // If mIsTrusted is true, the event is a trusted event.  Otherwise, it's
  60   // an untrusted event.
  61   bool mIsTrusted : 1;
  62   // If mInBubblingPhase is true, the event is in bubbling phase or target
  63   // phase.
  64   bool mInBubblingPhase : 1;
  65   // If mInCapturePhase is true, the event is in capture phase or target phase.
  66   bool mInCapturePhase : 1;
  67   // If mInSystemGroup is true, the event is being dispatched in system group.
  68   bool mInSystemGroup : 1;
  69   // If mCancelable is true, the event can be consumed.  I.e., calling
  70   // dom::Event::PreventDefault() can prevent the default action.
  71   bool mCancelable : 1;
  72   // If mBubbles is true, the event can bubble.  Otherwise, cannot be handled
  73   // in bubbling phase.
  74   bool mBubbles : 1;
  75   // If mPropagationStopped is true, dom::Event::StopPropagation() or
  76   // dom::Event::StopImmediatePropagation() has been called.
  77   bool mPropagationStopped : 1;
  78   // If mImmediatePropagationStopped is true,
  79   // dom::Event::StopImmediatePropagation() has been called.
  80   // Note that mPropagationStopped must be true when this is true.
  81   bool mImmediatePropagationStopped : 1;
  82   // If mDefaultPrevented is true, the event has been consumed.
  83   // E.g., dom::Event::PreventDefault() has been called or
  84   // the default action has been performed.
  85   bool mDefaultPrevented : 1;
  86   // If mDefaultPreventedByContent is true, the event has been
  87   // consumed by content.
  88   // Note that mDefaultPrevented must be true when this is true.
  89   bool mDefaultPreventedByContent : 1;
  90   // If mDefaultPreventedByChrome is true, the event has been
  91   // consumed by chrome.
  92   // Note that mDefaultPrevented must be true when this is true.
  93   bool mDefaultPreventedByChrome : 1;
  94   // mMultipleActionsPrevented may be used when default handling don't want to
  95   // be prevented, but only one of the event targets should handle the event.
  96   // For example, when a <label> element is in another <label> element and
  97   // the first <label> element is clicked, that one may set this true.
  98   // Then, the second <label> element won't handle the event.
  99   bool mMultipleActionsPrevented : 1;
 100   // Similar to above but expected to be used during PreHandleEvent phase.
 101   bool mMultiplePreActionsPrevented : 1;
 102   // If mIsBeingDispatched is true, the DOM event created from the event is
 103   // dispatching into the DOM tree and not completed.
 104   bool mIsBeingDispatched : 1;
 105   // If mDispatchedAtLeastOnce is true, the event has been dispatched
 106   // as a DOM event and the dispatch has been completed in the process.
 107   // So, this is false even if the event has already been dispatched
 108   // in another process.
 109   bool mDispatchedAtLeastOnce : 1;
 110   // If mIsSynthesizedForTests is true, the event has been synthesized for
 111   // automated tests or something hacky approach of an add-on.
 112   bool mIsSynthesizedForTests : 1;
 113   // If mExceptionWasRaised is true, one of the event handlers has raised an
 114   // exception.
 115   bool mExceptionWasRaised : 1;
 116   // If mRetargetToNonNativeAnonymous is true and the target is in a non-native
 117   // native anonymous subtree, the event target is set to mOriginalTarget.
 118   bool mRetargetToNonNativeAnonymous : 1;
 119   // If mNoContentDispatch is true, the event is never dispatched to the
 120   // event handlers which are added to the contents, onfoo attributes and
 121   // properties.  Note that this flag is ignored when
 122   // EventChainPreVisitor::mForceContentDispatch is set true.  For exapmle,
 123   // window and document object sets it true.  Therefore, web applications
 124   // can handle the event if they add event listeners to the window or the
 125   // document.
 126   // XXX This is an ancient and broken feature, don't use this for new bug
 127   //     as far as possible.
 128   bool mNoContentDispatch : 1;
 129   // If mOnlyChromeDispatch is true, the event is dispatched to only chrome.
 130   bool mOnlyChromeDispatch : 1;
 131   // Indicates if the key combination is reserved by chrome.  This is set by
 132   // MarkAsReservedByChrome().
 133   bool mIsReservedByChrome : 1;
 134   // If mOnlySystemGroupDispatchInContent is true, event listeners added to
 135   // the default group for non-chrome EventTarget won't be called.
 136   // Be aware, if this is true, EventDispatcher needs to check if each event
 137   // listener is added to chrome node, so, don't set this to true for the
 138   // events which are fired a lot of times like eMouseMove.
 139   bool mOnlySystemGroupDispatchInContent : 1;
 140   // If mOnlySystemGroupDispatch is true, the event will be dispatched only to
 141   // event listeners added in the system group.
 142   bool mOnlySystemGroupDispatch : 1;
 143   // The event's action will be handled by APZ. The main thread should not
 144   // perform its associated action.
 145   bool mHandledByAPZ : 1;
 146   // True if the event is currently being handled by an event listener that
 147   // was registered as a passive listener.
 148   bool mInPassiveListener : 1;
 149   // If mComposed is true, the event fired by nodes in shadow DOM can cross the
 150   // boundary of shadow DOM and light DOM.
 151   bool mComposed : 1;
 152   // Similar to mComposed. Set it to true to allow events cross the boundary
 153   // between native non-anonymous content and native anonymouse content
 154   bool mComposedInNativeAnonymousContent : 1;
 155   // Set to true for events which are suppressed or delayed so that later a
 156   // DelayedEvent of it is dispatched. This is used when parent side process
 157   // the key event after content side, and may drop the event if the event
 158   // was suppressed or delayed in contents side.
 159   // It is also set to true for the events (in a DelayedInputEvent), which will
 160   // be dispatched afterwards.
 161   bool mIsSuppressedOrDelayed : 1;
 162   // Certain mouse events can be marked as positionless to return 0 from
 163   // coordinate related getters.
 164   bool mIsPositionless : 1;
 165
 166   // Flags managing state of propagation between processes.
 167   // Note the the following flags shouldn't be referred directly.  Use utility
 168   // methods instead.
 169
 170   // If mNoRemoteProcessDispatch is true, the event is not allowed to be sent
 171   // to remote process.
 172   bool mNoRemoteProcessDispatch : 1;
 173   // If mWantReplyFromContentProcess is true, the event will be redispatched
 174   // in the parent process after the content process has handled it. Useful
 175   // for when the parent process need the know first how the event was used
 176   // by content before handling it itself.
 177   bool mWantReplyFromContentProcess : 1;
 178   // If mPostedToRemoteProcess is true, the event has been posted to the
 179   // remote process (but it's not handled yet if it's not a duplicated event
 180   // instance).
 181   bool mPostedToRemoteProcess : 1;
 182   // If mCameFromAnotherProcess is true, the event came from another process.
 183   bool mCameFromAnotherProcess : 1;
 184
 185   // At lease one of the event in the event path had non privileged click
 186   // listener.
 187   bool mHadNonPrivilegedClickListeners : 1;
 188
 189   // If the event is being handled in target phase, returns true.
 190   inline bool InTargetPhase() const {
 191     return (mInBubblingPhase && mInCapturePhase);
 192   }
 193
 194   /**
 195    * Helper methods for methods of DOM Event.
 196    */
 197   inline void StopPropagation() { mPropagationStopped = true; }
 198   inline void StopImmediatePropagation() {
 199     StopPropagation();
 200     mImmediatePropagationStopped = true;
 201   }
 202   inline void PreventDefault(bool aCalledByDefaultHandler = true) {
 203     if (!mCancelable) {
 204       return;
 205     }
 206     mDefaultPrevented = true;
 207     // Note that even if preventDefault() has already been called by chrome,
 208     // a call of preventDefault() by content needs to overwrite
 209     // mDefaultPreventedByContent to true because in such case, defaultPrevented
 210     // must be true when web apps check it after they call preventDefault().
 211     if (aCalledByDefaultHandler) {
 212       StopCrossProcessForwarding();
 213       mDefaultPreventedByChrome = true;
 214     } else {
 215       mDefaultPreventedByContent = true;
 216     }
 217   }
 218   // This should be used only before dispatching events into the DOM tree.
 219   inline void PreventDefaultBeforeDispatch(
 220       CrossProcessForwarding aCrossProcessForwarding) {
 221     if (!mCancelable) {
 222       return;
 223     }
 224     mDefaultPrevented = true;
 225     if (aCrossProcessForwarding == CrossProcessForwarding::eStop) {
 226       StopCrossProcessForwarding();
 227     }
 228   }
 229   inline bool DefaultPrevented() const { return mDefaultPrevented; }
 230   inline bool DefaultPreventedByContent() const {
 231     MOZ_ASSERT(!mDefaultPreventedByContent || DefaultPrevented());
 232     return mDefaultPreventedByContent;
 233   }
 234   inline bool IsTrusted() const { return mIsTrusted; }
 235   inline bool PropagationStopped() const { return mPropagationStopped; }
 236
 237   // Helper methods to access flags managing state of propagation between
 238   // processes.
 239
 240   /**
 241    * Prevent to be dispatched to remote process.
 242    */
 243   inline void StopCrossProcessForwarding() {
 244     MOZ_ASSERT(!mPostedToRemoteProcess);
 245     mNoRemoteProcessDispatch = true;
 246     mWantReplyFromContentProcess = false;
 247   }
 248   /**
 249    * Return true if the event shouldn't be dispatched to remote process.
 250    */
 251   inline bool IsCrossProcessForwardingStopped() const {
 252     return mNoRemoteProcessDispatch;
 253   }
 254   /**
 255    * Mark the event as waiting reply from remote process.
 256    * If the caller needs to win other keyboard event handlers in chrome,
 257    * the caller should call StopPropagation() too.
 258    * Otherwise, if the caller just needs to know if the event is consumed by
 259    * either content or chrome, it should just call this because the event
 260    * may be reserved by chrome and it needs to be dispatched into the DOM
 261    * tree in chrome for checking if it's reserved before being sent to any
 262    * remote processes.
 263    */
 264   inline void MarkAsWaitingReplyFromRemoteProcess() {
 265     MOZ_ASSERT(!mPostedToRemoteProcess);
 266     mNoRemoteProcessDispatch = false;
 267     mWantReplyFromContentProcess = true;
 268   }
 269   /**
 270    * Reset "waiting reply from remote process" state.  This is useful when
 271    * you dispatch a copy of an event coming from different process.
 272    */
 273   inline void ResetWaitingReplyFromRemoteProcessState() {
 274     if (IsWaitingReplyFromRemoteProcess()) {
 275       // FYI: mWantReplyFromContentProcess is also used for indicating
 276       //      "handled in remote process" state.  Therefore, only when
 277       //      IsWaitingReplyFromRemoteProcess() returns true, this should
 278       //      reset the flag.
 279       mWantReplyFromContentProcess = false;
 280     }
 281   }
 282   /**
 283    * Return true if the event handler should wait reply event.  I.e., if this
 284    * returns true, any event handler should do nothing with the event.
 285    */
 286   inline bool IsWaitingReplyFromRemoteProcess() const {
 287     return !mNoRemoteProcessDispatch && mWantReplyFromContentProcess;
 288   }
 289   /**
 290    * Mark the event as already handled in the remote process.  This should be
 291    * called when initializing reply events.
 292    */
 293   inline void MarkAsHandledInRemoteProcess() {
 294     mNoRemoteProcessDispatch = true;
 295     mWantReplyFromContentProcess = true;
 296     mPostedToRemoteProcess = false;
 297   }
 298   /**
 299    * Return true if the event has already been handled in the remote process.
 300    */
 301   inline bool IsHandledInRemoteProcess() const {
 302     return mNoRemoteProcessDispatch && mWantReplyFromContentProcess;
 303   }
 304   /**
 305    * Return true if the event should be sent back to its parent process.
 306    */
 307   inline bool WantReplyFromContentProcess() const {
 308     MOZ_ASSERT(!XRE_IsParentProcess());
 309     return IsWaitingReplyFromRemoteProcess();
 310   }
 311   /**
 312    * Mark the event has already posted to a remote process.
 313    */
 314   inline void MarkAsPostedToRemoteProcess() {
 315     MOZ_ASSERT(!IsCrossProcessForwardingStopped());
 316     mPostedToRemoteProcess = true;
 317   }
 318   /**
 319    * Reset the cross process dispatching state.  This should be used when a
 320    * process receives the event because the state is in the sender.
 321    */
 322   inline void ResetCrossProcessDispatchingState() {
 323     MOZ_ASSERT(!IsCrossProcessForwardingStopped());
 324     mPostedToRemoteProcess = false;
 325     // Ignore propagation state in the remote process if it's marked as
 326     // "waiting reply from remote process" because the process needs to
 327     // stop propagation in the process until receiving a reply event.
 328     // Note that the propagation stopped flag is important for the reply event
 329     // handler in the main process because it's used for making whether it's
 330     // ignored by the remote process or not.
 331     if (!XRE_IsParentProcess() && IsWaitingReplyFromRemoteProcess()) {
 332       mPropagationStopped = mImmediatePropagationStopped = false;
 333     }
 334     // mDispatchedAtLeastOnce indicates the state in current process.
 335     mDispatchedAtLeastOnce = false;
 336   }
 337   /**
 338    * Return true if the event has been posted to a remote process.
 339    * Note that MarkAsPostedToRemoteProcess() is called by
 340    * ParamTraits<mozilla::WidgetEvent>.  Therefore, it *might* be possible
 341    * that posting the event failed even if this returns true.  But that must
 342    * really rare.  If that'd be problem for you, you should unmark this in
 343    * BrowserParent or somewhere.
 344    */
 345   inline bool HasBeenPostedToRemoteProcess() const {
 346     return mPostedToRemoteProcess;
 347   }
 348   /**
 349    * Return true if the event came from another process.
 350    */
 351   inline bool CameFromAnotherProcess() const { return mCameFromAnotherProcess; }
 352   /**
 353    * Mark the event as coming from another process.
 354    */
 355   inline void MarkAsComingFromAnotherProcess() {
 356     mCameFromAnotherProcess = true;
 357   }
 358   /**
 359    * Mark the event is reserved by chrome.  I.e., shouldn't be dispatched to
 360    * content because it shouldn't be cancelable.
 361    */
 362   inline void MarkAsReservedByChrome() {
 363     MOZ_ASSERT(!mPostedToRemoteProcess);
 364     mIsReservedByChrome = true;
 365     // For reserved commands (such as Open New Tab), we don't need to wait for
 366     // the content to answer, neither to give a chance for content to override
 367     // its behavior.
 368     StopCrossProcessForwarding();
 369     // If the event is reserved by chrome, we shouldn't expose the event to
 370     // web contents because such events shouldn't be cancelable.  So, it's not
 371     // good behavior to fire such events but to ignore the defaultPrevented
 372     // attribute value in chrome.
 373     mOnlySystemGroupDispatchInContent = true;
 374   }
 375   /**
 376    * Return true if the event is reserved by chrome.
 377    */
 378   inline bool IsReservedByChrome() const {
 379     MOZ_ASSERT(!mIsReservedByChrome || (IsCrossProcessForwardingStopped() &&
 380                                         mOnlySystemGroupDispatchInContent));
 381     return mIsReservedByChrome;
 382   }
 383
 384   inline void Clear() { SetRawFlags(0); }
 385   // Get if either the instance's bit or the aOther's bit is true, the
 386   // instance's bit becomes true.  In other words, this works like:
 387   // eventFlags |= aOther;
 388   inline void Union(const BaseEventFlags& aOther) {
 389     RawFlags rawFlags = GetRawFlags() | aOther.GetRawFlags();
 390     SetRawFlags(rawFlags);
 391   }
 392
 393  private:
 394   typedef uint64_t RawFlags;
 395
 396   inline void SetRawFlags(RawFlags aRawFlags) {
 397     static_assert(sizeof(BaseEventFlags) <= sizeof(RawFlags),
 398                   "mozilla::EventFlags must not be bigger than the RawFlags");
 399     memcpy(this, &aRawFlags, sizeof(BaseEventFlags));
 400   }
 401   inline RawFlags GetRawFlags() const {
 402     RawFlags result = 0;
 403     memcpy(&result, this, sizeof(BaseEventFlags));
 404     return result;
 405   }
 406 };
 407
 408 /******************************************************************************
 409  * mozilla::EventFlags
 410  ******************************************************************************/
 411
 412 struct EventFlags : public BaseEventFlags {
 413   EventFlags() { Clear(); }
 414 };
 415
 416 /******************************************************************************
 417  * mozilla::WidgetEventTime
 418  ******************************************************************************/
 419
 420 class WidgetEventTime {
 421  public:
 422   // Timestamp when the message was created.
 423   TimeStamp mTimeStamp;
 424
 425   WidgetEventTime() : mTimeStamp(TimeStamp::Now()) {}
 426
 427   explicit WidgetEventTime(TimeStamp aTimeStamp) : mTimeStamp(aTimeStamp) {}
 428
 429   void AssignEventTime(const WidgetEventTime& aOther) {
 430     mTimeStamp = aOther.mTimeStamp;
 431   }
 432 };
 433
 434 /******************************************************************************
 435  * mozilla::WidgetEvent
 436  ******************************************************************************/
 437
 438 class WidgetEvent : public WidgetEventTime {
 439  private:
 440   void SetDefaultCancelableAndBubbles() {
 441     switch (mClass) {
 442       case eEditorInputEventClass:
 443         mFlags.mCancelable = false;
 444         mFlags.mBubbles = mFlags.mIsTrusted;
 445         break;
 446       case eMouseEventClass:
 447         mFlags.mCancelable =
 448             (mMessage != eMouseEnter && mMessage != eMouseLeave);
 449         mFlags.mBubbles = (mMessage != eMouseEnter && mMessage != eMouseLeave);
 450         break;
 451       case ePointerEventClass:
 452         mFlags.mCancelable =
 453             (mMessage != ePointerEnter && mMessage != ePointerLeave &&
 454              mMessage != ePointerCancel && mMessage != ePointerGotCapture &&
 455              mMessage != ePointerLostCapture);
 456         mFlags.mBubbles =
 457             (mMessage != ePointerEnter && mMessage != ePointerLeave);
 458         break;
 459       case eDragEventClass:
 460         mFlags.mCancelable = (mMessage != eDragExit && mMessage != eDragLeave &&
 461                               mMessage != eDragEnd);
 462         mFlags.mBubbles = true;
 463         break;
 464       case eSMILTimeEventClass:
 465         mFlags.mCancelable = false;
 466         mFlags.mBubbles = false;
 467         break;
 468       case eTransitionEventClass:
 469       case eAnimationEventClass:
 470         mFlags.mCancelable = false;
 471         mFlags.mBubbles = true;
 472         break;
 473       case eCompositionEventClass:
 474         // XXX compositionstart is cancelable in draft of DOM3 Events.
 475         //     However, it doesn't make sense for us, we cannot cancel
 476         //     composition when we send compositionstart event.
 477         mFlags.mCancelable = false;
 478         mFlags.mBubbles = true;
 479         break;
 480       default:
 481         if (mMessage == eResize || mMessage == eMozVisualResize ||
 482             mMessage == eMozVisualScroll || mMessage == eEditorInput ||
 483             mMessage == eFormSelect) {
 484           mFlags.mCancelable = false;
 485         } else {
 486           mFlags.mCancelable = true;
 487         }
 488         mFlags.mBubbles = true;
 489         break;
 490     }
 491   }
 492
 493  protected:
 494   WidgetEvent(bool aIsTrusted, EventMessage aMessage,
 495               EventClassID aEventClassID)
 496       : WidgetEventTime(),
 497         mClass(aEventClassID),
 498         mMessage(aMessage),
 499         mRefPoint(0, 0),
 500         mLastRefPoint(0, 0),
 501         mFocusSequenceNumber(0),
 502         mSpecifiedEventType(nullptr),
 503         mPath(nullptr),
 504         mLayersId(layers::LayersId{0}) {
 505     MOZ_COUNT_CTOR(WidgetEvent);
 506     mFlags.Clear();
 507     mFlags.mIsTrusted = aIsTrusted;
 508     SetDefaultCancelableAndBubbles();
 509     SetDefaultComposed();
 510     SetDefaultComposedInNativeAnonymousContent();
 511   }
 512
 513   WidgetEvent() : WidgetEventTime(), mPath(nullptr) {
 514     MOZ_COUNT_CTOR(WidgetEvent);
 515   }
 516
 517  public:
 518   WidgetEvent(bool aIsTrusted, EventMessage aMessage)
 519       : WidgetEvent(aIsTrusted, aMessage, eBasicEventClass) {}
 520
 521   MOZ_COUNTED_DTOR_VIRTUAL(WidgetEvent)
 522
 523   WidgetEvent(const WidgetEvent& aOther) : WidgetEventTime() {
 524     MOZ_COUNT_CTOR(WidgetEvent);
 525     *this = aOther;
 526   }
 527   WidgetEvent& operator=(const WidgetEvent& aOther) = default;
 528
 529   WidgetEvent(WidgetEvent&& aOther)
 530       : WidgetEventTime(std::move(aOther)),
 531         mClass(aOther.mClass),
 532         mMessage(aOther.mMessage),
 533         mRefPoint(std::move(aOther.mRefPoint)),
 534         mLastRefPoint(std::move(aOther.mLastRefPoint)),
 535         mFocusSequenceNumber(aOther.mFocusSequenceNumber),
 536         mFlags(std::move(aOther.mFlags)),
 537         mSpecifiedEventType(std::move(aOther.mSpecifiedEventType)),
 538         mSpecifiedEventTypeString(std::move(aOther.mSpecifiedEventTypeString)),
 539         mTarget(std::move(aOther.mTarget)),
 540         mCurrentTarget(std::move(aOther.mCurrentTarget)),
 541         mOriginalTarget(std::move(aOther.mOriginalTarget)),
 542         mRelatedTarget(std::move(aOther.mRelatedTarget)),
 543         mOriginalRelatedTarget(std::move(aOther.mOriginalRelatedTarget)),
 544         mPath(std::move(aOther.mPath)) {
 545     MOZ_COUNT_CTOR(WidgetEvent);
 546   }
 547   WidgetEvent& operator=(WidgetEvent&& aOther) = default;
 548
 549   virtual WidgetEvent* Duplicate() const {
 550     MOZ_ASSERT(mClass == eBasicEventClass,
 551                "Duplicate() must be overridden by sub class");
 552     WidgetEvent* result = new WidgetEvent(false, mMessage);
 553     result->AssignEventData(*this, true);
 554     result->mFlags = mFlags;
 555     return result;
 556   }
 557
 558   EventClassID mClass;
 559   EventMessage mMessage;
 560   // Relative to the widget of the event, or if there is no widget then it is
 561   // in screen coordinates. Not modified by layout code.
 562   // This is in visual coordinates, i.e. the correct RelativeTo value that
 563   // expresses what this is relative to is `{viewportFrame, Visual}`, where
 564   // `viewportFrame` is the viewport frame of the widget's root document.
 565   LayoutDeviceIntPoint mRefPoint;
 566   // The previous mRefPoint, if known, used to calculate mouse movement deltas.
 567   LayoutDeviceIntPoint mLastRefPoint;
 568   // The sequence number of the last potentially focus changing event handled
 569   // by APZ. This is used to track when that event has been processed by
 570   // content, and focus can be reconfirmed for async keyboard scrolling.
 571   uint64_t mFocusSequenceNumber;
 572   // See BaseEventFlags definition for the detail.
 573   BaseEventFlags mFlags;
 574
 575   // If JS creates an event with unknown event type or known event type but
 576   // for different event interface, the event type is stored to this.
 577   // NOTE: This is always used if the instance is a WidgetCommandEvent instance
 578   //       or "input" event is dispatched with dom::Event class.
 579   RefPtr<nsAtom> mSpecifiedEventType;
 580
 581   // nsAtom isn't available on non-main thread due to unsafe.  Therefore,
 582   // mSpecifiedEventTypeString is used instead of mSpecifiedEventType if
 583   // the event is created in non-main thread.
 584   nsString mSpecifiedEventTypeString;
 585
 586   // Event targets, needed by DOM Events
 587   // Note that when you need event target for DOM event, you should use
 588   // Get*DOMEventTarget() instead of accessing these members directly.
 589   nsCOMPtr<dom::EventTarget> mTarget;
 590   nsCOMPtr<dom::EventTarget> mCurrentTarget;
 591   nsCOMPtr<dom::EventTarget> mOriginalTarget;
 592
 593   /// The possible related target
 594   nsCOMPtr<dom::EventTarget> mRelatedTarget;
 595   nsCOMPtr<dom::EventTarget> mOriginalRelatedTarget;
 596
 597   nsTArray<EventTargetChainItem>* mPath;
 598
 599   // The LayersId of the content process that this event should be
 600   // dispatched to. This field is only used in the chrome process
 601   // and doesn't get remoted to child processes.
 602   layers::LayersId mLayersId;
 603
 604   dom::EventTarget* GetDOMEventTarget() const;
 605   dom::EventTarget* GetCurrentDOMEventTarget() const;
 606   dom::EventTarget* GetOriginalDOMEventTarget() const;
 607
 608   void AssignEventData(const WidgetEvent& aEvent, bool aCopyTargets) {
 609     // mClass should be initialized with the constructor.
 610     // mMessage should be initialized with the constructor.
 611     mRefPoint = aEvent.mRefPoint;
 612     // mLastRefPoint doesn't need to be copied.
 613     mFocusSequenceNumber = aEvent.mFocusSequenceNumber;
 614     // mLayersId intentionally not copied, since it's not used within content
 615     AssignEventTime(aEvent);
 616     // mFlags should be copied manually if it's necessary.
 617     mSpecifiedEventType = aEvent.mSpecifiedEventType;
 618     // mSpecifiedEventTypeString should be copied manually if it's necessary.
 619     mTarget = aCopyTargets ? aEvent.mTarget : nullptr;
 620     mCurrentTarget = aCopyTargets ? aEvent.mCurrentTarget : nullptr;
 621     mOriginalTarget = aCopyTargets ? aEvent.mOriginalTarget : nullptr;
 622     mRelatedTarget = aCopyTargets ? aEvent.mRelatedTarget : nullptr;
 623     mOriginalRelatedTarget =
 624         aCopyTargets ? aEvent.mOriginalRelatedTarget : nullptr;
 625   }
 626
 627   /**
 628    * Helper methods for methods of DOM Event.
 629    */
 630   void StopPropagation() { mFlags.StopPropagation(); }
 631   void StopImmediatePropagation() { mFlags.StopImmediatePropagation(); }
 632   void PreventDefault(bool aCalledByDefaultHandler = true,
 633                       nsIPrincipal* aPrincipal = nullptr);
 634
 635   void PreventDefaultBeforeDispatch(
 636       CrossProcessForwarding aCrossProcessForwarding) {
 637     mFlags.PreventDefaultBeforeDispatch(aCrossProcessForwarding);
 638   }
 639   bool DefaultPrevented() const { return mFlags.DefaultPrevented(); }
 640   bool DefaultPreventedByContent() const {
 641     return mFlags.DefaultPreventedByContent();
 642   }
 643   bool IsTrusted() const { return mFlags.IsTrusted(); }
 644   bool PropagationStopped() const { return mFlags.PropagationStopped(); }
 645
 646   /**
 647    * Prevent to be dispatched to remote process.
 648    */
 649   inline void StopCrossProcessForwarding() {
 650     mFlags.StopCrossProcessForwarding();
 651   }
 652   /**
 653    * Return true if the event shouldn't be dispatched to remote process.
 654    */
 655   inline bool IsCrossProcessForwardingStopped() const {
 656     return mFlags.IsCrossProcessForwardingStopped();
 657   }
 658   /**
 659    * Mark the event as waiting reply from remote process.
 660    * Note that this also stops immediate propagation in current process.
 661    */
 662   inline void MarkAsWaitingReplyFromRemoteProcess() {
 663     mFlags.MarkAsWaitingReplyFromRemoteProcess();
 664   }
 665   /**
 666    * Reset "waiting reply from remote process" state.  This is useful when
 667    * you dispatch a copy of an event coming from different process.
 668    */
 669   inline void ResetWaitingReplyFromRemoteProcessState() {
 670     mFlags.ResetWaitingReplyFromRemoteProcessState();
 671   }
 672   /**
 673    * Return true if the event handler should wait reply event.  I.e., if this
 674    * returns true, any event handler should do nothing with the event.
 675    */
 676   inline bool IsWaitingReplyFromRemoteProcess() const {
 677     return mFlags.IsWaitingReplyFromRemoteProcess();
 678   }
 679   /**
 680    * Mark the event as already handled in the remote process.  This should be
 681    * called when initializing reply events.
 682    */
 683   inline void MarkAsHandledInRemoteProcess() {
 684     mFlags.MarkAsHandledInRemoteProcess();
 685   }
 686   /**
 687    * Return true if the event has already been handled in the remote process.
 688    * I.e., if this returns true, the event is a reply event.
 689    */
 690   inline bool IsHandledInRemoteProcess() const {
 691     return mFlags.IsHandledInRemoteProcess();
 692   }
 693   /**
 694    * Return true if the event should be sent back to its parent process.
 695    * So, usual event handlers shouldn't call this.
 696    */
 697   inline bool WantReplyFromContentProcess() const {
 698     return mFlags.WantReplyFromContentProcess();
 699   }
 700   /**
 701    * Mark the event has already posted to a remote process.
 702    */
 703   inline void MarkAsPostedToRemoteProcess() {
 704     mFlags.MarkAsPostedToRemoteProcess();
 705   }
 706   /**
 707    * Reset the cross process dispatching state.  This should be used when a
 708    * process receives the event because the state is in the sender.
 709    */
 710   inline void ResetCrossProcessDispatchingState() {
 711     mFlags.ResetCrossProcessDispatchingState();
 712   }
 713   /**
 714    * Return true if the event has been posted to a remote process.
 715    */
 716   inline bool HasBeenPostedToRemoteProcess() const {
 717     return mFlags.HasBeenPostedToRemoteProcess();
 718   }
 719   /**
 720    * Return true if the event came from another process.
 721    */
 722   inline bool CameFromAnotherProcess() const {
 723     return mFlags.CameFromAnotherProcess();
 724   }
 725   /**
 726    * Mark the event as coming from another process.
 727    */
 728   inline void MarkAsComingFromAnotherProcess() {
 729     mFlags.MarkAsComingFromAnotherProcess();
 730   }
 731   /**
 732    * Mark the event is reserved by chrome.  I.e., shouldn't be dispatched to
 733    * content because it shouldn't be cancelable.
 734    */
 735   inline void MarkAsReservedByChrome() { mFlags.MarkAsReservedByChrome(); }
 736   /**
 737    * Return true if the event is reserved by chrome.
 738    */
 739   inline bool IsReservedByChrome() const { return mFlags.IsReservedByChrome(); }
 740
 741   /**
 742    * Utils for checking event types
 743    */
 744
 745   /**
 746    * As*Event() returns the pointer of the instance only when the instance is
 747    * the class or one of its derived class.
 748    */
 749 #define NS_ROOT_EVENT_CLASS(aPrefix, aName)
 750 #define NS_EVENT_CLASS(aPrefix, aName) \
 751   virtual aPrefix##aName* As##aName(); \
 752   const aPrefix##aName* As##aName() const;
 753
 754 #include "mozilla/EventClassList.h"
 755
 756 #undef NS_EVENT_CLASS
 757 #undef NS_ROOT_EVENT_CLASS
 758
 759   /**
 760    * Returns true if the event is a query content event.
 761    */
 762   bool IsQueryContentEvent() const;
 763   /**
 764    * Returns true if the event is a selection event.
 765    */
 766   bool IsSelectionEvent() const;
 767   /**
 768    * Returns true if the event is a content command event.
 769    */
 770   bool IsContentCommandEvent() const;
 771
 772   /**
 773    * Returns true if the event mMessage is one of mouse events.
 774    */
 775   bool HasMouseEventMessage() const;
 776   /**
 777    * Returns true if the event mMessage is one of drag events.
 778    */
 779   bool HasDragEventMessage() const;
 780   /**
 781    * Returns true if aMessage or mMessage is one of key events.
 782    */
 783   static bool IsKeyEventMessage(EventMessage aMessage);
 784   bool HasKeyEventMessage() const { return IsKeyEventMessage(mMessage); }
 785   /**
 786    * Returns true if the event mMessage is one of composition events or text
 787    * event.
 788    */
 789   bool HasIMEEventMessage() const;
 790
 791   /**
 792    * Returns true if the event can be sent to remote process.
 793    */
 794   bool CanBeSentToRemoteProcess() const;
 795   /**
 796    * Returns true if the original target is a remote process and the event
 797    * will be posted to the remote process later.
 798    */
 799   bool WillBeSentToRemoteProcess() const;
 800   /**
 801    * Returns true if the event is related to IME handling.  It includes
 802    * IME events, query content events and selection events.
 803    * Be careful when you use this.
 804    */
 805   bool IsIMERelatedEvent() const;
 806
 807   /**
 808    * Whether the event should be handled by the frame of the mouse cursor
 809    * position or not.  When it should be handled there (e.g., the mouse events),
 810    * this returns true.
 811    */
 812   bool IsUsingCoordinates() const;
 813   /**
 814    * Whether the event should be handled by the focused DOM window in the
 815    * same top level window's or not.  E.g., key events, IME related events
 816    * (including the query content events, they are used in IME transaction)
 817    * should be handled by the (last) focused window rather than the dispatched
 818    * window.
 819    *
 820    * NOTE: Even if this returns true, the event isn't going to be handled by the
 821    * application level active DOM window which is on another top level window.
 822    * So, when the event is fired on a deactive window, the event is going to be
 823    * handled by the last focused DOM window in the last focused window.
 824    */
 825   bool IsTargetedAtFocusedWindow() const;
 826   /**
 827    * Whether the event should be handled by the focused content or not.  E.g.,
 828    * key events, IME related events and other input events which are not handled
 829    * by the frame of the mouse cursor position.
 830    *
 831    * NOTE: Even if this returns true, the event isn't going to be handled by the
 832    * application level active DOM window which is on another top level window.
 833    * So, when the event is fired on a deactive window, the event is going to be
 834    * handled by the last focused DOM element of the last focused DOM window in
 835    * the last focused window.
 836    */
 837   bool IsTargetedAtFocusedContent() const;
 838   /**
 839    * Whether the event should cause a DOM event.
 840    */
 841   bool IsAllowedToDispatchDOMEvent() const;
 842   /**
 843    * Whether the event should be dispatched in system group.
 844    */
 845   bool IsAllowedToDispatchInSystemGroup() const;
 846   /**
 847    * Whether the event should be blocked for fingerprinting resistance.
 848    */
 849   bool IsBlockedForFingerprintingResistance() const;
 850   /**
 851    * Initialize mComposed
 852    */
 853   void SetDefaultComposed() {
 854     switch (mClass) {
 855       case eClipboardEventClass:
 856         mFlags.mComposed = true;
 857         break;
 858       case eCompositionEventClass:
 859         mFlags.mComposed =
 860             mMessage == eCompositionStart || mMessage == eCompositionUpdate ||
 861             mMessage == eCompositionChange || mMessage == eCompositionEnd;
 862         break;
 863       case eDragEventClass:
 864         // All drag & drop events are composed
 865         mFlags.mComposed = mMessage == eDrag || mMessage == eDragEnd ||
 866                            mMessage == eDragEnter || mMessage == eDragExit ||
 867                            mMessage == eDragLeave || mMessage == eDragOver ||
 868                            mMessage == eDragStart || mMessage == eDrop;
 869         break;
 870       case eEditorInputEventClass:
 871         mFlags.mComposed =
 872             mMessage == eEditorInput || mMessage == eEditorBeforeInput;
 873         break;
 874       case eFocusEventClass:
 875         mFlags.mComposed = mMessage == eBlur || mMessage == eFocus ||
 876                            mMessage == eFocusOut || mMessage == eFocusIn;
 877         break;
 878       case eKeyboardEventClass:
 879         mFlags.mComposed =
 880             mMessage == eKeyDown || mMessage == eKeyUp || mMessage == eKeyPress;
 881         break;
 882       case eMouseEventClass:
 883         mFlags.mComposed =
 884             mMessage == eMouseClick || mMessage == eMouseDoubleClick ||
 885             mMessage == eMouseAuxClick || mMessage == eMouseDown ||
 886             mMessage == eMouseUp || mMessage == eMouseOver ||
 887             mMessage == eMouseOut || mMessage == eMouseMove ||
 888             mMessage == eContextMenu || mMessage == eXULPopupShowing ||
 889             mMessage == eXULPopupHiding || mMessage == eXULPopupShown ||
 890             mMessage == eXULPopupHidden;
 891         break;
 892       case ePointerEventClass:
 893         // All pointer events are composed
 894         mFlags.mComposed =
 895             mMessage == ePointerDown || mMessage == ePointerMove ||
 896             mMessage == ePointerUp || mMessage == ePointerCancel ||
 897             mMessage == ePointerOver || mMessage == ePointerOut ||
 898             mMessage == ePointerGotCapture || mMessage == ePointerLostCapture;
 899         break;
 900       case eTouchEventClass:
 901         // All touch events are composed
 902         mFlags.mComposed = mMessage == eTouchStart || mMessage == eTouchEnd ||
 903                            mMessage == eTouchMove || mMessage == eTouchCancel;
 904         break;
 905       case eUIEventClass:
 906         mFlags.mComposed = mMessage == eLegacyDOMFocusIn ||
 907                            mMessage == eLegacyDOMFocusOut ||
 908                            mMessage == eLegacyDOMActivate;
 909         break;
 910       case eWheelEventClass:
 911         // All wheel events are composed
 912         mFlags.mComposed = mMessage == eWheel;
 913         break;
 914       case eMouseScrollEventClass:
 915         // Legacy mouse scroll events are composed too, for consistency with
 916         // wheel.
 917         mFlags.mComposed = mMessage == eLegacyMouseLineOrPageScroll ||
 918                            mMessage == eLegacyMousePixelScroll;
 919         break;
 920       default:
 921         mFlags.mComposed = false;
 922         break;
 923     }
 924   }
 925
 926   void SetComposed(const nsAString& aEventTypeArg) {
 927     mFlags.mComposed =  // composition events
 928         aEventTypeArg.EqualsLiteral("compositionstart") ||
 929         aEventTypeArg.EqualsLiteral("compositionupdate") ||
 930         aEventTypeArg.EqualsLiteral("compositionend") ||
 931         aEventTypeArg.EqualsLiteral("text") ||
 932         // drag and drop events
 933         aEventTypeArg.EqualsLiteral("dragstart") ||
 934         aEventTypeArg.EqualsLiteral("drag") ||
 935         aEventTypeArg.EqualsLiteral("dragenter") ||
 936         aEventTypeArg.EqualsLiteral("dragexit") ||
 937         aEventTypeArg.EqualsLiteral("dragleave") ||
 938         aEventTypeArg.EqualsLiteral("dragover") ||
 939         aEventTypeArg.EqualsLiteral("drop") ||
 940         aEventTypeArg.EqualsLiteral("dropend") ||
 941         // editor input events
 942         aEventTypeArg.EqualsLiteral("input") ||
 943         aEventTypeArg.EqualsLiteral("beforeinput") ||
 944         // focus events
 945         aEventTypeArg.EqualsLiteral("blur") ||
 946         aEventTypeArg.EqualsLiteral("focus") ||
 947         aEventTypeArg.EqualsLiteral("focusin") ||
 948         aEventTypeArg.EqualsLiteral("focusout") ||
 949         // keyboard events
 950         aEventTypeArg.EqualsLiteral("keydown") ||
 951         aEventTypeArg.EqualsLiteral("keyup") ||
 952         aEventTypeArg.EqualsLiteral("keypress") ||
 953         // mouse events
 954         aEventTypeArg.EqualsLiteral("click") ||
 955         aEventTypeArg.EqualsLiteral("dblclick") ||
 956         aEventTypeArg.EqualsLiteral("mousedown") ||
 957         aEventTypeArg.EqualsLiteral("mouseup") ||
 958         aEventTypeArg.EqualsLiteral("mouseenter") ||
 959         aEventTypeArg.EqualsLiteral("mouseleave") ||
 960         aEventTypeArg.EqualsLiteral("mouseover") ||
 961         aEventTypeArg.EqualsLiteral("mouseout") ||
 962         aEventTypeArg.EqualsLiteral("mousemove") ||
 963         aEventTypeArg.EqualsLiteral("contextmenu") ||
 964         // pointer events
 965         aEventTypeArg.EqualsLiteral("pointerdown") ||
 966         aEventTypeArg.EqualsLiteral("pointermove") ||
 967         aEventTypeArg.EqualsLiteral("pointerup") ||
 968         aEventTypeArg.EqualsLiteral("pointercancel") ||
 969         aEventTypeArg.EqualsLiteral("pointerover") ||
 970         aEventTypeArg.EqualsLiteral("pointerout") ||
 971         aEventTypeArg.EqualsLiteral("pointerenter") ||
 972         aEventTypeArg.EqualsLiteral("pointerleave") ||
 973         aEventTypeArg.EqualsLiteral("gotpointercapture") ||
 974         aEventTypeArg.EqualsLiteral("lostpointercapture") ||
 975         // touch events
 976         aEventTypeArg.EqualsLiteral("touchstart") ||
 977         aEventTypeArg.EqualsLiteral("touchend") ||
 978         aEventTypeArg.EqualsLiteral("touchmove") ||
 979         aEventTypeArg.EqualsLiteral("touchcancel") ||
 980         // UI legacy events
 981         aEventTypeArg.EqualsLiteral("DOMFocusIn") ||
 982         aEventTypeArg.EqualsLiteral("DOMFocusOut") ||
 983         aEventTypeArg.EqualsLiteral("DOMActivate") ||
 984         // wheel events
 985         aEventTypeArg.EqualsLiteral("wheel");
 986   }
 987
 988   void SetComposed(bool aComposed) { mFlags.mComposed = aComposed; }
 989
 990   void SetDefaultComposedInNativeAnonymousContent() {
 991     // For compatibility concerns, we set mComposedInNativeAnonymousContent to
 992     // false for those events we want to stop propagation.
 993     //
 994     // nsVideoFrame may create anonymous image element which fires eLoad,
 995     // eLoadStart, eLoadEnd, eLoadError. We don't want these events cross
 996     // the boundary of NAC
 997     mFlags.mComposedInNativeAnonymousContent =
 998         mMessage != eLoad && mMessage != eLoadStart && mMessage != eLoadEnd &&
 999         mMessage != eLoadError;
1000   }
1001
1002   bool IsUserAction() const;
1003 };
1004
1005 /******************************************************************************
1006  * mozilla::WidgetGUIEvent
1007  ******************************************************************************/
1008
1009 class WidgetGUIEvent : public WidgetEvent {
1010  protected:
1011   WidgetGUIEvent(bool aIsTrusted, EventMessage aMessage, nsIWidget* aWidget,
1012                  EventClassID aEventClassID)
1013       : WidgetEvent(aIsTrusted, aMessage, aEventClassID), mWidget(aWidget) {}
1014
1015   WidgetGUIEvent() = default;
1016
1017  public:
1018   virtual WidgetGUIEvent* AsGUIEvent() override { return this; }
1019
1020   WidgetGUIEvent(bool aIsTrusted, EventMessage aMessage, nsIWidget* aWidget)
1021       : WidgetEvent(aIsTrusted, aMessage, eGUIEventClass), mWidget(aWidget) {}
1022
1023   virtual WidgetEvent* Duplicate() const override {
1024     MOZ_ASSERT(mClass == eGUIEventClass,
1025                "Duplicate() must be overridden by sub class");
1026     // Not copying widget, it is a weak reference.
1027     WidgetGUIEvent* result = new WidgetGUIEvent(false, mMessage, nullptr);
1028     result->AssignGUIEventData(*this, true);
1029     result->mFlags = mFlags;
1030     return result;
1031   }
1032
1033   // Originator of the event
1034   nsCOMPtr<nsIWidget> mWidget;
1035
1036   void AssignGUIEventData(const WidgetGUIEvent& aEvent, bool aCopyTargets) {
1037     AssignEventData(aEvent, aCopyTargets);
1038     // widget should be initialized with the constructor.
1039   }
1040 };
1041
1042 /******************************************************************************
1043  * mozilla::Modifier
1044  *
1045  * All modifier keys should be defined here.  This is used for managing
1046  * modifier states for DOM Level 3 or later.
1047  ******************************************************************************/
1048
1049 enum Modifier {
1050   MODIFIER_NONE = 0x0000,
1051   MODIFIER_ALT = 0x0001,
1052   MODIFIER_ALTGRAPH = 0x0002,
1053   MODIFIER_CAPSLOCK = 0x0004,
1054   MODIFIER_CONTROL = 0x0008,
1055   MODIFIER_FN = 0x0010,
1056   MODIFIER_FNLOCK = 0x0020,
1057   MODIFIER_META = 0x0040,
1058   MODIFIER_NUMLOCK = 0x0080,
1059   MODIFIER_SCROLLLOCK = 0x0100,
1060   MODIFIER_SHIFT = 0x0200,
1061   MODIFIER_SYMBOL = 0x0400,
1062   MODIFIER_SYMBOLLOCK = 0x0800,
1063   MODIFIER_OS = 0x1000
1064 };
1065
1066 /******************************************************************************
1067  * Modifier key names.
1068  ******************************************************************************/
1069
1070 #define NS_DOM_KEYNAME_ALT "Alt"
1071 #define NS_DOM_KEYNAME_ALTGRAPH "AltGraph"
1072 #define NS_DOM_KEYNAME_CAPSLOCK "CapsLock"
1073 #define NS_DOM_KEYNAME_CONTROL "Control"
1074 #define NS_DOM_KEYNAME_FN "Fn"
1075 #define NS_DOM_KEYNAME_FNLOCK "FnLock"
1076 #define NS_DOM_KEYNAME_META "Meta"
1077 #define NS_DOM_KEYNAME_NUMLOCK "NumLock"
1078 #define NS_DOM_KEYNAME_SCROLLLOCK "ScrollLock"
1079 #define NS_DOM_KEYNAME_SHIFT "Shift"
1080 #define NS_DOM_KEYNAME_SYMBOL "Symbol"
1081 #define NS_DOM_KEYNAME_SYMBOLLOCK "SymbolLock"
1082 #define NS_DOM_KEYNAME_OS "OS"
1083
1084 /******************************************************************************
1085  * mozilla::Modifiers
1086  ******************************************************************************/
1087
1088 typedef uint16_t Modifiers;
1089
1090 class MOZ_STACK_CLASS GetModifiersName final : public nsAutoCString {
1091  public:
1092   explicit GetModifiersName(Modifiers aModifiers) {
1093     if (aModifiers & MODIFIER_ALT) {
1094       AssignLiteral(NS_DOM_KEYNAME_ALT);
1095     }
1096     if (aModifiers & MODIFIER_ALTGRAPH) {
1097       MaybeAppendSeparator();
1098       AppendLiteral(NS_DOM_KEYNAME_ALTGRAPH);
1099     }
1100     if (aModifiers & MODIFIER_CAPSLOCK) {
1101       MaybeAppendSeparator();
1102       AppendLiteral(NS_DOM_KEYNAME_CAPSLOCK);
1103     }
1104     if (aModifiers & MODIFIER_CONTROL) {
1105       MaybeAppendSeparator();
1106       AppendLiteral(NS_DOM_KEYNAME_CONTROL);
1107     }
1108     if (aModifiers & MODIFIER_FN) {
1109       MaybeAppendSeparator();
1110       AppendLiteral(NS_DOM_KEYNAME_FN);
1111     }
1112     if (aModifiers & MODIFIER_FNLOCK) {
1113       MaybeAppendSeparator();
1114       AppendLiteral(NS_DOM_KEYNAME_FNLOCK);
1115     }
1116     if (aModifiers & MODIFIER_META) {
1117       MaybeAppendSeparator();
1118       AppendLiteral(NS_DOM_KEYNAME_META);
1119     }
1120     if (aModifiers & MODIFIER_NUMLOCK) {
1121       MaybeAppendSeparator();
1122       AppendLiteral(NS_DOM_KEYNAME_NUMLOCK);
1123     }
1124     if (aModifiers & MODIFIER_SCROLLLOCK) {
1125       MaybeAppendSeparator();
1126       AppendLiteral(NS_DOM_KEYNAME_SCROLLLOCK);
1127     }
1128     if (aModifiers & MODIFIER_SHIFT) {
1129       MaybeAppendSeparator();
1130       AppendLiteral(NS_DOM_KEYNAME_SHIFT);
1131     }
1132     if (aModifiers & MODIFIER_SYMBOL) {
1133       MaybeAppendSeparator();
1134       AppendLiteral(NS_DOM_KEYNAME_SYMBOL);
1135     }
1136     if (aModifiers & MODIFIER_SYMBOLLOCK) {
1137       MaybeAppendSeparator();
1138       AppendLiteral(NS_DOM_KEYNAME_SYMBOLLOCK);
1139     }
1140     if (aModifiers & MODIFIER_OS) {
1141       MaybeAppendSeparator();
1142       AppendLiteral(NS_DOM_KEYNAME_OS);
1143     }
1144     if (IsEmpty()) {
1145       AssignLiteral("none");
1146     }
1147   }
1148
1149  private:
1150   void MaybeAppendSeparator() {
1151     if (!IsEmpty()) {
1152       AppendLiteral(" | ");
1153     }
1154   }
1155 };
1156
1157 /******************************************************************************
1158  * mozilla::WidgetInputEvent
1159  ******************************************************************************/
1160
1161 class WidgetInputEvent : public WidgetGUIEvent {
1162  protected:
1163   WidgetInputEvent(bool aIsTrusted, EventMessage aMessage, nsIWidget* aWidget,
1164                    EventClassID aEventClassID)
1165       : WidgetGUIEvent(aIsTrusted, aMessage, aWidget, aEventClassID),
1166         mModifiers(0) {}
1167
1168   WidgetInputEvent() : mModifiers(0) {}
1169
1170  public:
1171   virtual WidgetInputEvent* AsInputEvent() override { return this; }
1172
1173   WidgetInputEvent(bool aIsTrusted, EventMessage aMessage, nsIWidget* aWidget)
1174       : WidgetGUIEvent(aIsTrusted, aMessage, aWidget, eInputEventClass),
1175         mModifiers(0) {}
1176
1177   virtual WidgetEvent* Duplicate() const override {
1178     MOZ_ASSERT(mClass == eInputEventClass,
1179                "Duplicate() must be overridden by sub class");
1180     // Not copying widget, it is a weak reference.
1181     WidgetInputEvent* result = new WidgetInputEvent(false, mMessage, nullptr);
1182     result->AssignInputEventData(*this, true);
1183     result->mFlags = mFlags;
1184     return result;
1185   }
1186
1187   /**
1188    * Returns a modifier of "Accel" virtual modifier which is used for shortcut
1189    * key.
1190    */
1191   static Modifier AccelModifier();
1192
1193   /**
1194    * GetModifier() returns a modifier flag which is activated by aDOMKeyName.
1195    */
1196   static Modifier GetModifier(const nsAString& aDOMKeyName);
1197
1198   // true indicates the accel key on the environment is down
1199   bool IsAccel() const { return ((mModifiers & AccelModifier()) != 0); }
1200
1201   // true indicates the shift key is down
1202   bool IsShift() const { return ((mModifiers & MODIFIER_SHIFT) != 0); }
1203   // true indicates the control key is down
1204   bool IsControl() const { return ((mModifiers & MODIFIER_CONTROL) != 0); }
1205   // true indicates the alt key is down
1206   bool IsAlt() const { return ((mModifiers & MODIFIER_ALT) != 0); }
1207   // true indicates the meta key is down (or, on Mac, the Command key)
1208   bool IsMeta() const { return ((mModifiers & MODIFIER_META) != 0); }
1209   // true indicates the win key is down on Windows. Or the Super or Hyper key
1210   // is down on Linux.
1211   bool IsOS() const { return ((mModifiers & MODIFIER_OS) != 0); }
1212   // true indicates the alt graph key is down
1213   // NOTE: on Mac, the option key press causes both IsAlt() and IsAltGrpah()
1214   //       return true.
1215   bool IsAltGraph() const { return ((mModifiers & MODIFIER_ALTGRAPH) != 0); }
1216   // true indicates the CapLock LED is turn on.
1217   bool IsCapsLocked() const { return ((mModifiers & MODIFIER_CAPSLOCK) != 0); }
1218   // true indicates the NumLock LED is turn on.
1219   bool IsNumLocked() const { return ((mModifiers & MODIFIER_NUMLOCK) != 0); }
1220   // true indicates the ScrollLock LED is turn on.
1221   bool IsScrollLocked() const {
1222     return ((mModifiers & MODIFIER_SCROLLLOCK) != 0);
1223   }
1224
1225   // true indicates the Fn key is down, but this is not supported by native
1226   // key event on any platform.
1227   bool IsFn() const { return ((mModifiers & MODIFIER_FN) != 0); }
1228   // true indicates the FnLock LED is turn on, but we don't know such
1229   // keyboards nor platforms.
1230   bool IsFnLocked() const { return ((mModifiers & MODIFIER_FNLOCK) != 0); }
1231   // true indicates the Symbol is down, but this is not supported by native
1232   // key event on any platforms.
1233   bool IsSymbol() const { return ((mModifiers & MODIFIER_SYMBOL) != 0); }
1234   // true indicates the SymbolLock LED is turn on, but we don't know such
1235   // keyboards nor platforms.
1236   bool IsSymbolLocked() const {
1237     return ((mModifiers & MODIFIER_SYMBOLLOCK) != 0);
1238   }
1239
1240   void InitBasicModifiers(bool aCtrlKey, bool aAltKey, bool aShiftKey,
1241                           bool aMetaKey) {
1242     mModifiers = 0;
1243     if (aCtrlKey) {
1244       mModifiers |= MODIFIER_CONTROL;
1245     }
1246     if (aAltKey) {
1247       mModifiers |= MODIFIER_ALT;
1248     }
1249     if (aShiftKey) {
1250       mModifiers |= MODIFIER_SHIFT;
1251     }
1252     if (aMetaKey) {
1253       mModifiers |= MODIFIER_META;
1254     }
1255   }
1256
1257   Modifiers mModifiers;
1258
1259   void AssignInputEventData(const WidgetInputEvent& aEvent, bool aCopyTargets) {
1260     AssignGUIEventData(aEvent, aCopyTargets);
1261
1262     mModifiers = aEvent.mModifiers;
1263   }
1264 };
1265
1266 /******************************************************************************
1267  * mozilla::InternalUIEvent
1268  *
1269  * XXX Why this inherits WidgetGUIEvent rather than WidgetEvent?
1270  ******************************************************************************/
1271
1272 class InternalUIEvent : public WidgetGUIEvent {
1273  protected:
1274   InternalUIEvent() : mDetail(0), mCausedByUntrustedEvent(false) {}
1275
1276   InternalUIEvent(bool aIsTrusted, EventMessage aMessage, nsIWidget* aWidget,
1277                   EventClassID aEventClassID)
1278       : WidgetGUIEvent(aIsTrusted, aMessage, aWidget, aEventClassID),
1279         mDetail(0),
1280         mCausedByUntrustedEvent(false) {}
1281
1282   InternalUIEvent(bool aIsTrusted, EventMessage aMessage,
1283                   EventClassID aEventClassID)
1284       : WidgetGUIEvent(aIsTrusted, aMessage, nullptr, aEventClassID),
1285         mDetail(0),
1286         mCausedByUntrustedEvent(false) {}
1287
1288  public:
1289   virtual InternalUIEvent* AsUIEvent() override { return this; }
1290
1291   /**
1292    * If the UIEvent is caused by another event (e.g., click event),
1293    * aEventCausesThisEvent should be the event.  If there is no such event,
1294    * this should be nullptr.
1295    */
1296   InternalUIEvent(bool aIsTrusted, EventMessage aMessage,
1297                   const WidgetEvent* aEventCausesThisEvent)
1298       : WidgetGUIEvent(aIsTrusted, aMessage, nullptr, eUIEventClass),
1299         mDetail(0),
1300         mCausedByUntrustedEvent(aEventCausesThisEvent &&
1301                                 !aEventCausesThisEvent->IsTrusted()) {}
1302
1303   virtual WidgetEvent* Duplicate() const override {
1304     MOZ_ASSERT(mClass == eUIEventClass,
1305                "Duplicate() must be overridden by sub class");
1306     InternalUIEvent* result = new InternalUIEvent(false, mMessage, nullptr);
1307     result->AssignUIEventData(*this, true);
1308     result->mFlags = mFlags;
1309     return result;
1310   }
1311
1312   int32_t mDetail;
1313   // mCausedByUntrustedEvent is true if the event is caused by untrusted event.
1314   bool mCausedByUntrustedEvent;
1315
1316   // If you check the event is a trusted event and NOT caused by an untrusted
1317   // event, IsTrustable() returns what you expected.
1318   bool IsTrustable() const { return IsTrusted() && !mCausedByUntrustedEvent; }
1319
1320   void AssignUIEventData(const InternalUIEvent& aEvent, bool aCopyTargets) {
1321     AssignGUIEventData(aEvent, aCopyTargets);
1322
1323     mDetail = aEvent.mDetail;
1324     mCausedByUntrustedEvent = aEvent.mCausedByUntrustedEvent;
1325   }
1326 };
1327
1328 }  // namespace mozilla
1329
1330 #endif  // mozilla_BasicEvents_h__