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.

Mercurial (a3f183201f7f)

VCS Links

BaseEventFlags

EventFlags

GetModifiersName

InternalUIEvent

Modifier

NativeEventData

WidgetEvent

WidgetEventTime

WidgetGUIEvent

WidgetInputEvent

Macros

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 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* 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_BasicEvents_h__
#define mozilla_BasicEvents_h__

#include <stdint.h>

#include "mozilla/dom/EventTarget.h"
#include "mozilla/EventForwards.h"
#include "mozilla/TimeStamp.h"
#include "nsCOMPtr.h"
#include "nsAtom.h"
#include "nsISupportsImpl.h"
#include "nsIWidget.h"
#include "nsString.h"
#include "Units.h"

#ifdef DEBUG
#include "nsXULAppAPI.h"
#endif // #ifdef DEBUG

namespace IPC {
template<typename T>
struct ParamTraits;
} // namespace IPC

namespace mozilla {

/******************************************************************************
 * mozilla::BaseEventFlags
 *
 * BaseEventFlags must be a POD struct for safe to use memcpy (including
 * in ParamTraits<BaseEventFlags>).  So don't make virtual methods, constructor,
 * destructor and operators.
 * This is necessary for VC which is NOT C++0x compiler.
 ******************************************************************************/

struct BaseEventFlags
{
public:
  // If mIsTrusted is true, the event is a trusted event.  Otherwise, it's
  // an untrusted event.
  bool    mIsTrusted : 1;
  // If mInBubblingPhase is true, the event is in bubbling phase or target
  // phase.
  bool    mInBubblingPhase : 1;
  // If mInCapturePhase is true, the event is in capture phase or target phase.
  bool    mInCapturePhase : 1;
  // If mInSystemGroup is true, the event is being dispatched in system group.
  bool    mInSystemGroup: 1;
  // If mCancelable is true, the event can be consumed.  I.e., calling
  // dom::Event::PreventDefault() can prevent the default action.
  bool    mCancelable : 1;
  // If mBubbles is true, the event can bubble.  Otherwise, cannot be handled
  // in bubbling phase.
  bool    mBubbles : 1;
  // If mPropagationStopped is true, dom::Event::StopPropagation() or
  // dom::Event::StopImmediatePropagation() has been called.
  bool    mPropagationStopped : 1;
  // If mImmediatePropagationStopped is true,
  // dom::Event::StopImmediatePropagation() has been called.
  // Note that mPropagationStopped must be true when this is true.
  bool    mImmediatePropagationStopped : 1;
  // If mDefaultPrevented is true, the event has been consumed.
  // E.g., dom::Event::PreventDefault() has been called or
  // the default action has been performed.
  bool    mDefaultPrevented : 1;
  // If mDefaultPreventedByContent is true, the event has been
  // consumed by content.
  // Note that mDefaultPrevented must be true when this is true.
  bool    mDefaultPreventedByContent : 1;
  // If mDefaultPreventedByChrome is true, the event has been
  // consumed by chrome.
  // Note that mDefaultPrevented must be true when this is true.
  bool    mDefaultPreventedByChrome : 1;
  // mMultipleActionsPrevented may be used when default handling don't want to
  // be prevented, but only one of the event targets should handle the event.
  // For example, when a <label> element is in another <label> element and
  // the first <label> element is clicked, that one may set this true.
  // Then, the second <label> element won't handle the event.
  bool    mMultipleActionsPrevented : 1;
  // If mIsBeingDispatched is true, the DOM event created from the event is
  // dispatching into the DOM tree and not completed.
  bool    mIsBeingDispatched : 1;
  // If mDispatchedAtLeastOnce is true, the event has been dispatched
  // as a DOM event and the dispatch has been completed.
  bool    mDispatchedAtLeastOnce : 1;
  // If mIsSynthesizedForTests is true, the event has been synthesized for
  // automated tests or something hacky approach of an add-on.
  bool    mIsSynthesizedForTests : 1;
  // If mExceptionWasRaised is true, one of the event handlers has raised an
  // exception.
  bool    mExceptionWasRaised : 1;
  // If mRetargetToNonNativeAnonymous is true and the target is in a non-native
  // native anonymous subtree, the event target is set to mOriginalTarget.
  bool    mRetargetToNonNativeAnonymous : 1;
  // If mNoContentDispatch is true, the event is never dispatched to the
  // event handlers which are added to the contents, onfoo attributes and
  // properties.  Note that this flag is ignored when
  // EventChainPreVisitor::mForceContentDispatch is set true.  For exapmle,
  // window and document object sets it true.  Therefore, web applications
  // can handle the event if they add event listeners to the window or the
  // document.
  // XXX This is an ancient and broken feature, don't use this for new bug
  //     as far as possible.
  bool    mNoContentDispatch : 1;
  // If mOnlyChromeDispatch is true, the event is dispatched to only chrome.
  bool    mOnlyChromeDispatch : 1;
  // Indicates if the key combination is reserved by chrome.  This is set by
  // MarkAsReservedByChrome().
  bool mIsReservedByChrome : 1;
  // If mOnlySystemGroupDispatchInContent is true, event listeners added to
  // the default group for non-chrome EventTarget won't be called.
  // Be aware, if this is true, EventDispatcher needs to check if each event
  // listener is added to chrome node, so, don't set this to true for the
  // events which are fired a lot of times like eMouseMove.
  bool    mOnlySystemGroupDispatchInContent : 1;
  // The event's action will be handled by APZ. The main thread should not
  // perform its associated action. This is currently only relevant for
  // wheel and touch events.
  bool mHandledByAPZ : 1;
  // True if the event is currently being handled by an event listener that
  // was registered as a passive listener.
  bool mInPassiveListener: 1;
  // If mComposed is true, the event fired by nodes in shadow DOM can cross the
  // boundary of shadow DOM and light DOM.
  bool mComposed : 1;
  // Similar to mComposed. Set it to true to allow events cross the boundary
  // between native non-anonymous content and native anonymouse content
  bool mComposedInNativeAnonymousContent : 1;
  // Set to true for events which are suppressed or delayed so that later a
  // DelayedEvent of it is dispatched. This is used when parent side process
  // the key event after content side, and may drop the event if the event
  // was suppressed or delayed in contents side.
  // It is also set to true for the events (in a DelayedInputEvent), which will
  // be dispatched afterwards.
  bool mIsSuppressedOrDelayed : 1;
  // Certain mouse events can be marked as positionless to return 0 from
  // coordinate related getters.
  bool mIsPositionless : 1;

  // Flags managing state of propagation between processes.
  // Note the the following flags shouldn't be referred directly.  Use utility
  // methods instead.

  // If mNoRemoteProcessDispatch is true, the event is not allowed to be sent
  // to remote process.
  bool mNoRemoteProcessDispatch : 1;
  // If mWantReplyFromContentProcess is true, the event will be redispatched
  // in the parent process after the content process has handled it. Useful
  // for when the parent process need the know first how the event was used
  // by content before handling it itself.
  bool mWantReplyFromContentProcess : 1;
  // If mPostedToRemoteProcess is true, the event has been posted to the
  // remote process (but it's not handled yet if it's not a duplicated event
  // instance).
  bool mPostedToRemoteProcess : 1;

  // If the event is being handled in target phase, returns true.
  inline bool InTargetPhase() const
  {
    return (mInBubblingPhase && mInCapturePhase);
  }

  /**
   * Helper methods for methods of DOM Event.
   */
  inline void StopPropagation()
  {
    mPropagationStopped = true;
  }
  inline void StopImmediatePropagation()
  {
    StopPropagation();
    mImmediatePropagationStopped = true;
  }
  inline void PreventDefault(bool aCalledByDefaultHandler = true)
  {
    if (!mCancelable) {
      return;
    }
    mDefaultPrevented = true;
    // Note that even if preventDefault() has already been called by chrome,
    // a call of preventDefault() by content needs to overwrite
    // mDefaultPreventedByContent to true because in such case, defaultPrevented
    // must be true when web apps check it after they call preventDefault().
    if (aCalledByDefaultHandler) {
      mDefaultPreventedByChrome = true;
    } else {
      mDefaultPreventedByContent = true;
    }
  }
  // This should be used only before dispatching events into the DOM tree.
  inline void PreventDefaultBeforeDispatch()
  {
    if (!mCancelable) {
      return;
    }
    mDefaultPrevented = true;
  }
  inline bool DefaultPrevented() const
  {
    return mDefaultPrevented;
  }
  inline bool DefaultPreventedByContent() const
  {
    MOZ_ASSERT(!mDefaultPreventedByContent || DefaultPrevented());
    return mDefaultPreventedByContent;
  }
  inline bool IsTrusted() const
  {
    return mIsTrusted;
  }
  inline bool PropagationStopped() const
  {
    return mPropagationStopped;
  }

  // Helper methods to access flags managing state of propagation between
  // processes.

  /**
   * Prevent to be dispatched to remote process.
   */
  inline void StopCrossProcessForwarding()
  {
    MOZ_ASSERT(!mPostedToRemoteProcess);
    mNoRemoteProcessDispatch = true;
    mWantReplyFromContentProcess = false;
  }
  /**
   * Return true if the event shouldn't be dispatched to remote process.
   */
  inline bool IsCrossProcessForwardingStopped() const
  {
    return mNoRemoteProcessDispatch;
  }
  /**
   * Mark the event as waiting reply from remote process.
   * If the caller needs to win other keyboard event handlers in chrome,
   * the caller should call StopPropagation() too.
   * Otherwise, if the caller just needs to know if the event is consumed by
   * either content or chrome, it should just call this because the event
   * may be reserved by chrome and it needs to be dispatched into the DOM
   * tree in chrome for checking if it's reserved before being sent to any
   * remote processes.
   */
  inline void MarkAsWaitingReplyFromRemoteProcess()
  {
    MOZ_ASSERT(!mPostedToRemoteProcess);
    mNoRemoteProcessDispatch = false;
    mWantReplyFromContentProcess = true;
  }
  /**
   * Reset "waiting reply from remote process" state.  This is useful when
   * you dispatch a copy of an event coming from different process.
   */
  inline void ResetWaitingReplyFromRemoteProcessState()
  {
    if (IsWaitingReplyFromRemoteProcess()) {
      // FYI: mWantReplyFromContentProcess is also used for indicating
      //      "handled in remote process" state.  Therefore, only when
      //      IsWaitingReplyFromRemoteProcess() returns true, this should
      //      reset the flag.
      mWantReplyFromContentProcess = false;
    }
  }
  /**
   * Return true if the event handler should wait reply event.  I.e., if this
   * returns true, any event handler should do nothing with the event.
   */
  inline bool IsWaitingReplyFromRemoteProcess() const
  {
    return !mNoRemoteProcessDispatch && mWantReplyFromContentProcess;
  }
  /**
   * Mark the event as already handled in the remote process.  This should be
   * called when initializing reply events.
   */
  inline void MarkAsHandledInRemoteProcess()
  {
    mNoRemoteProcessDispatch = true;
    mWantReplyFromContentProcess = true;
    mPostedToRemoteProcess = false;
  }
  /**
   * Return true if the event has already been handled in the remote process.
   */
  inline bool IsHandledInRemoteProcess() const
  {
    return mNoRemoteProcessDispatch && mWantReplyFromContentProcess;
  }
  /**
   * Return true if the event should be sent back to its parent process.
   */
  inline bool WantReplyFromContentProcess() const
  {
    MOZ_ASSERT(!XRE_IsParentProcess());
    return IsWaitingReplyFromRemoteProcess();
  }
  /**
   * Mark the event has already posted to a remote process.
   */
  inline void MarkAsPostedToRemoteProcess()
  {
    MOZ_ASSERT(!IsCrossProcessForwardingStopped());
    mPostedToRemoteProcess = true;
  }
  /**
   * Reset the cross process dispatching state.  This should be used when a
   * process receives the event because the state is in the sender.
   */
  inline void ResetCrossProcessDispatchingState()
  {
    MOZ_ASSERT(!IsCrossProcessForwardingStopped());
    mPostedToRemoteProcess = false;
    // Ignore propagation state in the different process if it's marked as
    // "waiting reply from remote process" because the process needs to
    // stop propagation in the process until receiving a reply event.
    if (IsWaitingReplyFromRemoteProcess()) {
      mPropagationStopped = mImmediatePropagationStopped = false;
    }
  }
  /**
   * Return true if the event has been posted to a remote process.
   * Note that MarkAsPostedToRemoteProcess() is called by
   * ParamTraits<mozilla::WidgetEvent>.  Therefore, it *might* be possible
   * that posting the event failed even if this returns true.  But that must
   * really rare.  If that'd be problem for you, you should unmark this in
   * TabParent or somewhere.
   */
  inline bool HasBeenPostedToRemoteProcess() const
  {
    return mPostedToRemoteProcess;
  }
  /**
   * Mark the event is reserved by chrome.  I.e., shouldn't be dispatched to
   * content because it shouldn't be cancelable.
   */
  inline void MarkAsReservedByChrome()
  {
    MOZ_ASSERT(!mPostedToRemoteProcess);
    mIsReservedByChrome = true;
    // For reserved commands (such as Open New Tab), we don't need to wait for
    // the content to answer, neither to give a chance for content to override
    // its behavior.
    StopCrossProcessForwarding();
    // If the event is reserved by chrome, we shouldn't expose the event to
    // web contents because such events shouldn't be cancelable.  So, it's not
    // good behavior to fire such events but to ignore the defaultPrevented
    // attribute value in chrome.
    mOnlySystemGroupDispatchInContent = true;
  }
  /**
   * Return true if the event is reserved by chrome.
   */
  inline bool IsReservedByChrome() const
  {
    MOZ_ASSERT(!mIsReservedByChrome ||
               (IsCrossProcessForwardingStopped() &&
                mOnlySystemGroupDispatchInContent));
    return mIsReservedByChrome;
  }

  inline void Clear()
  {
    SetRawFlags(0);
  }
  // Get if either the instance's bit or the aOther's bit is true, the
  // instance's bit becomes true.  In other words, this works like:
  // eventFlags |= aOther;
  inline void Union(const BaseEventFlags& aOther)
  {
    RawFlags rawFlags = GetRawFlags() | aOther.GetRawFlags();
    SetRawFlags(rawFlags);
  }

private:
  typedef uint32_t RawFlags;

  inline void SetRawFlags(RawFlags aRawFlags)
  {
    static_assert(sizeof(BaseEventFlags) <= sizeof(RawFlags),
      "mozilla::EventFlags must not be bigger than the RawFlags");
    memcpy(this, &aRawFlags, sizeof(BaseEventFlags));
  }
  inline RawFlags GetRawFlags() const
  {
    RawFlags result = 0;
    memcpy(&result, this, sizeof(BaseEventFlags));
    return result;
  }
};

/******************************************************************************
 * mozilla::EventFlags
 ******************************************************************************/

struct EventFlags : public BaseEventFlags
{
  EventFlags()
  {
    Clear();
  }
};

/******************************************************************************
 * mozilla::WidgetEventTime
 ******************************************************************************/

class WidgetEventTime
{
public:
  // Elapsed time, in milliseconds, from a platform-specific zero time
  // to the time the message was created
  uint64_t mTime;
  // Timestamp when the message was created. Set in parallel to 'time' until we
  // determine if it is safe to drop 'time' (see bug 77992).
  TimeStamp mTimeStamp;

  WidgetEventTime()
    : mTime(0)
    , mTimeStamp(TimeStamp::Now())
  {
  }

  WidgetEventTime(uint64_t aTime,
                  TimeStamp aTimeStamp)
    : mTime(aTime)
    , mTimeStamp(aTimeStamp)
  {
  }

  void AssignEventTime(const WidgetEventTime& aOther)
  {
    mTime = aOther.mTime;
    mTimeStamp = aOther.mTimeStamp;
  }
};

/******************************************************************************
 * mozilla::WidgetEvent
 ******************************************************************************/

class WidgetEvent : public WidgetEventTime
{
private:
  void SetDefaultCancelableAndBubbles()
  {
    switch (mClass) {
      case eEditorInputEventClass:
        mFlags.mCancelable = false;
        mFlags.mBubbles = mFlags.mIsTrusted;
        break;
      case eMouseEventClass:
        mFlags.mCancelable = (mMessage != eMouseEnter &&
                              mMessage != eMouseLeave);
        mFlags.mBubbles = (mMessage != eMouseEnter &&
                           mMessage != eMouseLeave);
        break;
      case ePointerEventClass:
        mFlags.mCancelable = (mMessage != ePointerEnter &&
                              mMessage != ePointerLeave &&
                              mMessage != ePointerCancel &&
                              mMessage != ePointerGotCapture &&
                              mMessage != ePointerLostCapture);
        mFlags.mBubbles = (mMessage != ePointerEnter &&
                           mMessage != ePointerLeave);
        break;
      case eDragEventClass:
        mFlags.mCancelable = (mMessage != eDragExit &&
                              mMessage != eDragLeave &&
                              mMessage != eDragEnd);
        mFlags.mBubbles = true;
        break;
      case eSMILTimeEventClass:
        mFlags.mCancelable = false;
        mFlags.mBubbles = false;
        break;
      case eTransitionEventClass:
      case eAnimationEventClass:
        mFlags.mCancelable = false;
        mFlags.mBubbles = true;
        break;
      case eCompositionEventClass:
        // XXX compositionstart is cancelable in draft of DOM3 Events.
        //     However, it doesn't make sense for us, we cannot cancel
        //     composition when we send compositionstart event.
        mFlags.mCancelable = false;
        mFlags.mBubbles = true;
        break;
      default:
        if (mMessage == eResize) {
          mFlags.mCancelable = false;
        } else {
          mFlags.mCancelable = true;
        }
        mFlags.mBubbles = true;
        break;
    }
  }

protected:
  WidgetEvent(bool aIsTrusted,
              EventMessage aMessage,
              EventClassID aEventClassID)
    : WidgetEventTime()
    , mClass(aEventClassID)
    , mMessage(aMessage)
    , mRefPoint(0, 0)
    , mLastRefPoint(0, 0)
    , mFocusSequenceNumber(0)
    , mSpecifiedEventType(nullptr)
  {
    MOZ_COUNT_CTOR(WidgetEvent);
    mFlags.Clear();
    mFlags.mIsTrusted = aIsTrusted;
    SetDefaultCancelableAndBubbles();
    SetDefaultComposed();
    SetDefaultComposedInNativeAnonymousContent();
  }

  WidgetEvent()
    : WidgetEventTime()
  {
    MOZ_COUNT_CTOR(WidgetEvent);
  }

public:
  WidgetEvent(bool aIsTrusted, EventMessage aMessage)
    : WidgetEvent(aIsTrusted, aMessage, eBasicEventClass)
  {
  }

  virtual ~WidgetEvent()
  {
    MOZ_COUNT_DTOR(WidgetEvent);
  }

  WidgetEvent(const WidgetEvent& aOther)
    : WidgetEventTime()
  {
    MOZ_COUNT_CTOR(WidgetEvent);
    *this = aOther;
  }

  virtual WidgetEvent* Duplicate() const
  {
    MOZ_ASSERT(mClass == eBasicEventClass,
               "Duplicate() must be overridden by sub class");
    WidgetEvent* result = new WidgetEvent(false, mMessage);
    result->AssignEventData(*this, true);
    result->mFlags = mFlags;
    return result;
  }

  EventClassID mClass;
  EventMessage mMessage;
  // Relative to the widget of the event, or if there is no widget then it is
  // in screen coordinates. Not modified by layout code.
  LayoutDeviceIntPoint mRefPoint;
  // The previous mRefPoint, if known, used to calculate mouse movement deltas.
  LayoutDeviceIntPoint mLastRefPoint;
  // The sequence number of the last potentially focus changing event handled
  // by APZ. This is used to track when that event has been processed by content,
  // and focus can be reconfirmed for async keyboard scrolling.
  uint64_t mFocusSequenceNumber;
  // See BaseEventFlags definition for the detail.
  BaseEventFlags mFlags;

  // If JS creates an event with unknown event type or known event type but
  // for different event interface, the event type is stored to this.
  // NOTE: This is always used if the instance is a WidgetCommandEvent instance.
  RefPtr<nsAtom> mSpecifiedEventType;

  // nsAtom isn't available on non-main thread due to unsafe.  Therefore,
  // mSpecifiedEventTypeString is used instead of mSpecifiedEventType if
  // the event is created in non-main thread.
  nsString mSpecifiedEventTypeString;

  // Event targets, needed by DOM Events
  // Note that when you need event target for DOM event, you should use
  // Get*DOMEventTarget() instead of accessing these members directly.
  nsCOMPtr<dom::EventTarget> mTarget;
  nsCOMPtr<dom::EventTarget> mCurrentTarget;
  nsCOMPtr<dom::EventTarget> mOriginalTarget;

  dom::EventTarget* GetDOMEventTarget() const;
  dom::EventTarget* GetCurrentDOMEventTarget() const;
  dom::EventTarget* GetOriginalDOMEventTarget() const;

  void AssignEventData(const WidgetEvent& aEvent, bool aCopyTargets)
  {
    // mClass should be initialized with the constructor.
    // mMessage should be initialized with the constructor.
    mRefPoint = aEvent.mRefPoint;
    // mLastRefPoint doesn't need to be copied.
    mFocusSequenceNumber = aEvent.mFocusSequenceNumber;
    AssignEventTime(aEvent);
    // mFlags should be copied manually if it's necessary.
    mSpecifiedEventType = aEvent.mSpecifiedEventType;
    // mSpecifiedEventTypeString should be copied manually if it's necessary.
    mTarget = aCopyTargets ? aEvent.mTarget : nullptr;
    mCurrentTarget = aCopyTargets ? aEvent.mCurrentTarget : nullptr;
    mOriginalTarget = aCopyTargets ? aEvent.mOriginalTarget : nullptr;
  }

  /**
   * Helper methods for methods of DOM Event.
   */
  void StopPropagation() { mFlags.StopPropagation(); }
  void StopImmediatePropagation() { mFlags.StopImmediatePropagation(); }
  void PreventDefault(bool aCalledByDefaultHandler = true,
                      nsIPrincipal* aPrincipal = nullptr);

  void PreventDefaultBeforeDispatch() { mFlags.PreventDefaultBeforeDispatch(); }
  bool DefaultPrevented() const { return mFlags.DefaultPrevented(); }
  bool DefaultPreventedByContent() const
  {
    return mFlags.DefaultPreventedByContent();
  }
  bool IsTrusted() const { return mFlags.IsTrusted(); }
  bool PropagationStopped() const { return mFlags.PropagationStopped(); }

  /**
   * Prevent to be dispatched to remote process.
   */
  inline void StopCrossProcessForwarding()
  {
    mFlags.StopCrossProcessForwarding();
  }
  /**
   * Return true if the event shouldn't be dispatched to remote process.
   */
  inline bool IsCrossProcessForwardingStopped() const
  {
    return mFlags.IsCrossProcessForwardingStopped();
  }
  /**
   * Mark the event as waiting reply from remote process.
   * Note that this also stops immediate propagation in current process.
   */
  inline void MarkAsWaitingReplyFromRemoteProcess()
  {
    mFlags.MarkAsWaitingReplyFromRemoteProcess();
  }
  /**
   * Reset "waiting reply from remote process" state.  This is useful when
   * you dispatch a copy of an event coming from different process.
   */
  inline void ResetWaitingReplyFromRemoteProcessState()
  {
    mFlags.ResetWaitingReplyFromRemoteProcessState();
  }
  /**
   * Return true if the event handler should wait reply event.  I.e., if this
   * returns true, any event handler should do nothing with the event.
   */
  inline bool IsWaitingReplyFromRemoteProcess() const
  {
    return mFlags.IsWaitingReplyFromRemoteProcess();
  }
  /**
   * Mark the event as already handled in the remote process.  This should be
   * called when initializing reply events.
   */
  inline void MarkAsHandledInRemoteProcess()
  {
    mFlags.MarkAsHandledInRemoteProcess();
  }
  /**
   * Return true if the event has already been handled in the remote process.
   * I.e., if this returns true, the event is a reply event.
   */
  inline bool IsHandledInRemoteProcess() const
  {
    return mFlags.IsHandledInRemoteProcess();
  }
  /**
   * Return true if the event should be sent back to its parent process.
   * So, usual event handlers shouldn't call this.
   */
  inline bool WantReplyFromContentProcess() const
  {
    return mFlags.WantReplyFromContentProcess();
  }
  /**
   * Mark the event has already posted to a remote process.
   */
  inline void MarkAsPostedToRemoteProcess()
  {
    mFlags.MarkAsPostedToRemoteProcess();
  }
  /**
   * Reset the cross process dispatching state.  This should be used when a
   * process receives the event because the state is in the sender.
   */
  inline void ResetCrossProcessDispatchingState()
  {
    mFlags.ResetCrossProcessDispatchingState();
  }
  /**
   * Return true if the event has been posted to a remote process.
   */
  inline bool HasBeenPostedToRemoteProcess() const
  {
    return mFlags.HasBeenPostedToRemoteProcess();
  }
  /**
   * Mark the event is reserved by chrome.  I.e., shouldn't be dispatched to
   * content because it shouldn't be cancelable.
   */
  inline void MarkAsReservedByChrome()
  {
    mFlags.MarkAsReservedByChrome();
  }
  /**
   * Return true if the event is reserved by chrome.
   */
  inline bool IsReservedByChrome() const
  {
    return mFlags.IsReservedByChrome();
  }

  /**
   * Utils for checking event types
   */

  /**
   * As*Event() returns the pointer of the instance only when the instance is
   * the class or one of its derived class.
   */
#define NS_ROOT_EVENT_CLASS(aPrefix, aName)
#define NS_EVENT_CLASS(aPrefix, aName) \
  virtual aPrefix##aName* As##aName(); \
  const aPrefix##aName* As##aName() const;

#include "mozilla/EventClassList.h"

#undef NS_EVENT_CLASS
#undef NS_ROOT_EVENT_CLASS

  /**
   * Returns true if the event is a query content event.
   */
  bool IsQueryContentEvent() const;
  /**
   * Returns true if the event is a selection event.
   */
  bool IsSelectionEvent() const;
  /**
   * Returns true if the event is a content command event.
   */
  bool IsContentCommandEvent() const;
  /**
   * Returns true if the event is a native event deliverer event for plugin.
   */
  bool IsNativeEventDelivererForPlugin() const;

  /**
   * Returns true if the event mMessage is one of mouse events.
   */
  bool HasMouseEventMessage() const;
  /**
   * Returns true if the event mMessage is one of drag events.
   */
  bool HasDragEventMessage() const;
  /**
   * Returns true if aMessage or mMessage is one of key events.
   */
  static bool IsKeyEventMessage(EventMessage aMessage);
  bool HasKeyEventMessage() const
  {
    return IsKeyEventMessage(mMessage);
  }
  /**
   * Returns true if the event mMessage is one of composition events or text
   * event.
   */
  bool HasIMEEventMessage() const;
  /**
   * Returns true if the event mMessage is one of plugin activation events.
   */
  bool HasPluginActivationEventMessage() const;

  /**
   * Returns true if the event can be sent to remote process.
   */
  bool CanBeSentToRemoteProcess() const;
  /**
   * Returns true if the original target is a remote process and the event
   * will be posted to the remote process later.
   */
  bool WillBeSentToRemoteProcess() const;
  /**
   * Returns true if the event is native event deliverer event for plugin and
   * it should be retarted to focused document.
   */
  bool IsRetargetedNativeEventDelivererForPlugin() const;
  /**
   * Returns true if the event is native event deliverer event for plugin and
   * it should NOT be retarted to focused document.
   */
  bool IsNonRetargetedNativeEventDelivererForPlugin() const;
  /**
   * Returns true if the event is related to IME handling.  It includes
   * IME events, query content events and selection events.
   * Be careful when you use this.
   */
  bool IsIMERelatedEvent() const;

  /**
   * Whether the event should be handled by the frame of the mouse cursor
   * position or not.  When it should be handled there (e.g., the mouse events),
   * this returns true.
   */
  bool IsUsingCoordinates() const;
  /**
   * Whether the event should be handled by the focused DOM window in the
   * same top level window's or not.  E.g., key events, IME related events
   * (including the query content events, they are used in IME transaction)
   * should be handled by the (last) focused window rather than the dispatched
   * window.
   *
   * NOTE: Even if this returns true, the event isn't going to be handled by the
   * application level active DOM window which is on another top level window.
   * So, when the event is fired on a deactive window, the event is going to be
   * handled by the last focused DOM window in the last focused window.
   */
  bool IsTargetedAtFocusedWindow() const;
  /**
   * Whether the event should be handled by the focused content or not.  E.g.,
   * key events, IME related events and other input events which are not handled
   * by the frame of the mouse cursor position.
   *
   * NOTE: Even if this returns true, the event isn't going to be handled by the
   * application level active DOM window which is on another top level window.
   * So, when the event is fired on a deactive window, the event is going to be
   * handled by the last focused DOM element of the last focused DOM window in
   * the last focused window.
   */
  bool IsTargetedAtFocusedContent() const;
  /**
   * Whether the event should cause a DOM event.
   */
  bool IsAllowedToDispatchDOMEvent() const;
  /**
   * Whether the event should be dispatched in system group.
   */
  bool IsAllowedToDispatchInSystemGroup() const;
  /**
   * Initialize mComposed
   */
  void SetDefaultComposed()
  {
    switch (mClass) {
      case eCompositionEventClass:
        mFlags.mComposed = mMessage == eCompositionStart ||
                           mMessage == eCompositionUpdate ||
                           mMessage == eCompositionEnd;
        break;
      case eDragEventClass:
        // All drag & drop events are composed
        mFlags.mComposed = mMessage == eDrag || mMessage == eDragEnd ||
                           mMessage == eDragEnter || mMessage == eDragExit ||
                           mMessage == eDragLeave || mMessage == eDragOver ||
                           mMessage == eDragStart || mMessage == eDrop;
        break;
      case eEditorInputEventClass:
        mFlags.mComposed = mMessage == eEditorInput;
        break;
      case eFocusEventClass:
        mFlags.mComposed = mMessage == eBlur || mMessage == eFocus;
        break;
      case eKeyboardEventClass:
        mFlags.mComposed = mMessage == eKeyDown || mMessage == eKeyUp ||
                           mMessage == eKeyPress;
        break;
      case eMouseEventClass:
        mFlags.mComposed = mMessage == eMouseClick ||
                           mMessage == eMouseDoubleClick ||
                           mMessage == eMouseAuxClick ||
                           mMessage == eMouseDown || mMessage == eMouseUp ||
                           mMessage == eMouseEnter || mMessage == eMouseLeave ||
                           mMessage == eMouseOver || mMessage == eMouseOut ||
                           mMessage == eMouseMove || mMessage == eContextMenu;
        break;
      case ePointerEventClass:
        // All pointer events are composed
        mFlags.mComposed = mMessage == ePointerDown ||
                           mMessage == ePointerMove || mMessage == ePointerUp ||
                           mMessage == ePointerCancel ||
                           mMessage == ePointerOver ||
                           mMessage == ePointerOut ||
                           mMessage == ePointerEnter ||
                           mMessage == ePointerLeave ||
                           mMessage == ePointerGotCapture ||
                           mMessage == ePointerLostCapture;
        break;
      case eTouchEventClass:
        // All touch events are composed
        mFlags.mComposed = mMessage == eTouchStart || mMessage == eTouchEnd ||
                           mMessage == eTouchMove || mMessage == eTouchCancel;
        break;
      case eUIEventClass:
        mFlags.mComposed = mMessage == eLegacyDOMFocusIn ||
                           mMessage == eLegacyDOMFocusOut ||
                           mMessage == eLegacyDOMActivate;
        break;
      case eWheelEventClass:
        // All wheel events are composed
        mFlags.mComposed = mMessage == eWheel;
        break;
      default:
        mFlags.mComposed = false;
        break;
    }
  }

  void SetComposed(const nsAString& aEventTypeArg)
  {
    mFlags.mComposed = // composition events
                       aEventTypeArg.EqualsLiteral("compositionstart") ||
                       aEventTypeArg.EqualsLiteral("compositionupdate") ||
                       aEventTypeArg.EqualsLiteral("compositionend") ||
                       // drag and drop events
                       aEventTypeArg.EqualsLiteral("dragstart") ||
                       aEventTypeArg.EqualsLiteral("drag") ||
                       aEventTypeArg.EqualsLiteral("dragenter") ||
                       aEventTypeArg.EqualsLiteral("dragexit") ||
                       aEventTypeArg.EqualsLiteral("dragleave") ||
                       aEventTypeArg.EqualsLiteral("dragover") ||
                       aEventTypeArg.EqualsLiteral("drop") ||
                       aEventTypeArg.EqualsLiteral("dropend") ||
                       // editor input events
                       aEventTypeArg.EqualsLiteral("input") ||
                       aEventTypeArg.EqualsLiteral("beforeinput") ||
                       // focus events
                       aEventTypeArg.EqualsLiteral("blur") ||
                       aEventTypeArg.EqualsLiteral("focus") ||
                       aEventTypeArg.EqualsLiteral("focusin") ||
                       aEventTypeArg.EqualsLiteral("focusout") ||
                       // keyboard events
                       aEventTypeArg.EqualsLiteral("keydown") ||
                       aEventTypeArg.EqualsLiteral("keyup") ||
                       aEventTypeArg.EqualsLiteral("keypress") ||
                       // mouse events
                       aEventTypeArg.EqualsLiteral("click") ||
                       aEventTypeArg.EqualsLiteral("dblclick") ||
                       aEventTypeArg.EqualsLiteral("mousedown") ||
                       aEventTypeArg.EqualsLiteral("mouseup") ||
                       aEventTypeArg.EqualsLiteral("mouseenter") ||
                       aEventTypeArg.EqualsLiteral("mouseleave") ||
                       aEventTypeArg.EqualsLiteral("mouseover") ||
                       aEventTypeArg.EqualsLiteral("mouseout") ||
                       aEventTypeArg.