widget/EventForwards.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_EventForwards_h__
   7 #define mozilla_EventForwards_h__
   8
   9 #include <stdint.h>
  10
  11 #include "nsStringFwd.h"
  12 #include "nsTArray.h"
  13
  14 #ifdef DEBUG
  15 #  include "mozilla/StaticPrefs_dom.h"
  16 #endif  // #ifdef DEBUG
  17
  18 class nsCommandParams;
  19
  20 /**
  21  * XXX Following enums should be in BasicEvents.h.  However, currently, it's
  22  *     impossible to use foward delearation for enum.
  23  */
  24
  25 /**
  26  * Return status for event processors.
  27  */
  28 enum nsEventStatus {
  29   // The event is ignored, do default processing
  30   nsEventStatus_eIgnore,
  31   // The event is consumed, don't do default processing
  32   nsEventStatus_eConsumeNoDefault,
  33   // The event is consumed, but do default processing
  34   nsEventStatus_eConsumeDoDefault,
  35   // Value is not for use, only for serialization
  36   nsEventStatus_eSentinel
  37 };
  38
  39 namespace mozilla {
  40
  41 enum class CanBubble { eYes, eNo };
  42
  43 enum class Cancelable { eYes, eNo };
  44
  45 enum class ChromeOnlyDispatch { eYes, eNo };
  46
  47 enum class Trusted { eYes, eNo };
  48
  49 enum class Composed { eYes, eNo, eDefault };
  50
  51 /**
  52  * Event messages
  53  */
  54
  55 typedef uint16_t EventMessageType;
  56
  57 enum EventMessage : EventMessageType {
  58
  59 #define NS_EVENT_MESSAGE(aMessage) aMessage,
  60 #define NS_EVENT_MESSAGE_FIRST_LAST(aMessage, aFirst, aLast) \
  61   aMessage##First = aFirst, aMessage##Last = aLast,
  62
  63 #include "mozilla/EventMessageList.h"
  64
  65 #undef NS_EVENT_MESSAGE
  66 #undef NS_EVENT_MESSAGE_FIRST_LAST
  67
  68   // For preventing bustage due to "," after the last item.
  69   eEventMessage_MaxValue
  70 };
  71
  72 const char* ToChar(EventMessage aEventMessage);
  73
  74 /**
  75  * Event class IDs
  76  */
  77
  78 typedef uint8_t EventClassIDType;
  79
  80 enum EventClassID : EventClassIDType {
  81 // The event class name will be:
  82 //   eBasicEventClass for WidgetEvent
  83 //   eFooEventClass for WidgetFooEvent or InternalFooEvent
  84 #define NS_ROOT_EVENT_CLASS(aPrefix, aName) eBasic##aName##Class
  85 #define NS_EVENT_CLASS(aPrefix, aName) , e##aName##Class
  86
  87 #include "mozilla/EventClassList.h"
  88
  89 #undef NS_EVENT_CLASS
  90 #undef NS_ROOT_EVENT_CLASS
  91 };
  92
  93 const char* ToChar(EventClassID aEventClassID);
  94
  95 typedef uint16_t Modifiers;
  96
  97 #define NS_DEFINE_KEYNAME(aCPPName, aDOMKeyName) KEY_NAME_INDEX_##aCPPName,
  98
  99 typedef uint16_t KeyNameIndexType;
 100 enum KeyNameIndex : KeyNameIndexType {
 101 #include "mozilla/KeyNameList.h"
 102   // If a DOM keyboard event is synthesized by script, this is used.  Then,
 103   // specified key name should be stored and use it as .key value.
 104   KEY_NAME_INDEX_USE_STRING
 105 };
 106
 107 #undef NS_DEFINE_KEYNAME
 108
 109 const nsCString ToString(KeyNameIndex aKeyNameIndex);
 110
 111 #define NS_DEFINE_PHYSICAL_KEY_CODE_NAME(aCPPName, aDOMCodeName) \
 112   CODE_NAME_INDEX_##aCPPName,
 113
 114 typedef uint8_t CodeNameIndexType;
 115 enum CodeNameIndex : CodeNameIndexType {
 116 #include "mozilla/PhysicalKeyCodeNameList.h"
 117   // If a DOM keyboard event is synthesized by script, this is used.  Then,
 118   // specified code name should be stored and use it as .code value.
 119   CODE_NAME_INDEX_USE_STRING
 120 };
 121
 122 #undef NS_DEFINE_PHYSICAL_KEY_CODE_NAME
 123
 124 const nsCString ToString(CodeNameIndex aCodeNameIndex);
 125
 126 #define NS_DEFINE_INPUTTYPE(aCPPName, aDOMName) e##aCPPName,
 127
 128 typedef uint8_t EditorInputTypeType;
 129 enum class EditorInputType : EditorInputTypeType {
 130 #include "mozilla/InputTypeList.h"
 131   // If a DOM input event is synthesized by script, this is used.  Then,
 132   // specified input type should be stored as string and use it as .inputType
 133   // value.
 134   eUnknown,
 135 };
 136
 137 #undef NS_DEFINE_INPUTTYPE
 138
 139 inline bool ExposesClipboardDataOrDataTransfer(EditorInputType aInputType) {
 140   switch (aInputType) {
 141     case EditorInputType::eInsertFromPaste:
 142     case EditorInputType::eInsertFromPasteAsQuotation:
 143       return true;
 144     default:
 145       return false;
 146   }
 147 }
 148
 149 /**
 150  * IsDataAvailableOnTextEditor() returns true if aInputType on TextEditor
 151  * should have non-null InputEvent.data value.
 152  */
 153 inline bool IsDataAvailableOnTextEditor(EditorInputType aInputType) {
 154   switch (aInputType) {
 155     case EditorInputType::eInsertText:
 156     case EditorInputType::eInsertCompositionText:
 157     case EditorInputType::eInsertFromComposition:  // Only level 2
 158     case EditorInputType::eInsertFromPaste:
 159     case EditorInputType::eInsertFromPasteAsQuotation:
 160     case EditorInputType::eInsertTranspose:
 161     case EditorInputType::eInsertFromDrop:
 162     case EditorInputType::eInsertReplacementText:
 163     case EditorInputType::eInsertFromYank:
 164     case EditorInputType::eFormatSetBlockTextDirection:
 165     case EditorInputType::eFormatSetInlineTextDirection:
 166       return true;
 167     default:
 168       return false;
 169   }
 170 }
 171
 172 /**
 173  * IsDataAvailableOnHTMLEditor() returns true if aInputType on HTMLEditor
 174  * should have non-null InputEvent.data value.
 175  */
 176 inline bool IsDataAvailableOnHTMLEditor(EditorInputType aInputType) {
 177   switch (aInputType) {
 178     case EditorInputType::eInsertText:
 179     case EditorInputType::eInsertCompositionText:
 180     case EditorInputType::eInsertFromComposition:  // Only level 2
 181     case EditorInputType::eFormatSetBlockTextDirection:
 182     case EditorInputType::eFormatSetInlineTextDirection:
 183     case EditorInputType::eInsertLink:
 184     case EditorInputType::eFormatBackColor:
 185     case EditorInputType::eFormatFontColor:
 186     case EditorInputType::eFormatFontName:
 187       return true;
 188     default:
 189       return false;
 190   }
 191 }
 192
 193 /**
 194  * IsDataTransferAvailableOnHTMLEditor() returns true if aInputType on
 195  * HTMLEditor should have non-null InputEvent.dataTransfer value.
 196  */
 197 inline bool IsDataTransferAvailableOnHTMLEditor(EditorInputType aInputType) {
 198   switch (aInputType) {
 199     case EditorInputType::eInsertFromPaste:
 200     case EditorInputType::eInsertFromPasteAsQuotation:
 201     case EditorInputType::eInsertFromDrop:
 202     case EditorInputType::eInsertTranspose:
 203     case EditorInputType::eInsertReplacementText:
 204     case EditorInputType::eInsertFromYank:
 205       return true;
 206     default:
 207       return false;
 208   }
 209 }
 210
 211 /**
 212  * IsCancelableBeforeInputEvent() returns true if `beforeinput` event for
 213  * aInputType should be cancelable.
 214  *
 215  * Input Events Level 1:
 216  *   https://rawgit.com/w3c/input-events/v1/index.html#x5-1-2-attributes
 217  * Input Events Level 2:
 218  *   https://w3c.github.io/input-events/#interface-InputEvent-Attributes
 219  */
 220 inline bool IsCancelableBeforeInputEvent(EditorInputType aInputType) {
 221   switch (aInputType) {
 222     case EditorInputType::eInsertText:
 223       return true;  // In Level 1, undefined.
 224     case EditorInputType::eInsertReplacementText:
 225       return true;  // In Level 1, undefined.
 226     case EditorInputType::eInsertLineBreak:
 227       return true;  // In Level 1, undefined.
 228     case EditorInputType::eInsertParagraph:
 229       return true;  // In Level 1, undefined.
 230     case EditorInputType::eInsertOrderedList:
 231       return true;
 232     case EditorInputType::eInsertUnorderedList:
 233       return true;
 234     case EditorInputType::eInsertHorizontalRule:
 235       return true;
 236     case EditorInputType::eInsertFromYank:
 237       return true;
 238     case EditorInputType::eInsertFromDrop:
 239       return true;
 240     case EditorInputType::eInsertFromPaste:
 241       return true;
 242     case EditorInputType::eInsertFromPasteAsQuotation:
 243       return true;
 244     case EditorInputType::eInsertTranspose:
 245       return true;
 246     case EditorInputType::eInsertCompositionText:
 247       return false;
 248     case EditorInputType::eInsertFromComposition:
 249       MOZ_ASSERT(!StaticPrefs::dom_input_events_conform_to_level_1());
 250       return true;
 251     case EditorInputType::eInsertLink:
 252       return true;
 253     case EditorInputType::eDeleteByComposition:
 254       MOZ_ASSERT(!StaticPrefs::dom_input_events_conform_to_level_1());
 255       return true;
 256     case EditorInputType::eDeleteCompositionText:
 257       MOZ_ASSERT(!StaticPrefs::dom_input_events_conform_to_level_1());
 258       return false;
 259     case EditorInputType::eDeleteWordBackward:
 260       return true;  // In Level 1, undefined.
 261     case EditorInputType::eDeleteWordForward:
 262       return true;  // In Level 1, undefined.
 263     case EditorInputType::eDeleteSoftLineBackward:
 264       return true;  // In Level 1, undefined.
 265     case EditorInputType::eDeleteSoftLineForward:
 266       return true;  // In Level 1, undefined.
 267     case EditorInputType::eDeleteEntireSoftLine:
 268       return true;  // In Level 1, undefined.
 269     case EditorInputType::eDeleteHardLineBackward:
 270       return true;  // In Level 1, undefined.
 271     case EditorInputType::eDeleteHardLineForward:
 272       return true;  // In Level 1, undefined.
 273     case EditorInputType::eDeleteByDrag:
 274       return true;
 275     case EditorInputType::eDeleteByCut:
 276       return true;
 277     case EditorInputType::eDeleteContent:
 278       return true;  // In Level 1, undefined.
 279     case EditorInputType::eDeleteContentBackward:
 280       return true;  // In Level 1, undefined.
 281     case EditorInputType::eDeleteContentForward:
 282       return true;  // In Level 1, undefined.
 283     case EditorInputType::eHistoryUndo:
 284       return true;
 285     case EditorInputType::eHistoryRedo:
 286       return true;
 287     case EditorInputType::eFormatBold:
 288       return true;
 289     case EditorInputType::eFormatItalic:
 290       return true;
 291     case EditorInputType::eFormatUnderline:
 292       return true;
 293     case EditorInputType::eFormatStrikeThrough:
 294       return true;
 295     case EditorInputType::eFormatSuperscript:
 296       return true;
 297     case EditorInputType::eFormatSubscript:
 298       return true;
 299     case EditorInputType::eFormatJustifyFull:
 300       return true;
 301     case EditorInputType::eFormatJustifyCenter:
 302       return true;
 303     case EditorInputType::eFormatJustifyRight:
 304       return true;
 305     case EditorInputType::eFormatJustifyLeft:
 306       return true;
 307     case EditorInputType::eFormatIndent:
 308       return true;
 309     case EditorInputType::eFormatOutdent:
 310       return true;
 311     case EditorInputType::eFormatRemove:
 312       return true;
 313     case EditorInputType::eFormatSetBlockTextDirection:
 314       return true;
 315     case EditorInputType::eFormatSetInlineTextDirection:
 316       return true;
 317     case EditorInputType::eFormatBackColor:
 318       return true;
 319     case EditorInputType::eFormatFontColor:
 320       return true;
 321     case EditorInputType::eFormatFontName:
 322       return true;
 323     case EditorInputType::eUnknown:
 324       // This is not declared by Input Events, but it does not make sense to
 325       // allow web apps to cancel default action without inputType value check.
 326       // If some our specific edit actions should be cancelable, new inputType
 327       // value for them should be declared by the spec.
 328       return false;
 329     default:
 330       MOZ_ASSERT_UNREACHABLE("The new input type is not handled");
 331       return false;
 332   }
 333 }
 334
 335 #define NS_DEFINE_COMMAND(aName, aCommandStr) , aName
 336 #define NS_DEFINE_COMMAND_WITH_PARAM(aName, aCommandStr, aParam) , aName
 337 #define NS_DEFINE_COMMAND_NO_EXEC_COMMAND(aName) , aName
 338
 339 typedef uint8_t CommandInt;
 340 enum class Command : CommandInt {
 341   DoNothing
 342
 343 #include "mozilla/CommandList.h"
 344 };
 345 #undef NS_DEFINE_COMMAND
 346 #undef NS_DEFINE_COMMAND_WITH_PARAM
 347 #undef NS_DEFINE_COMMAND_NO_EXEC_COMMAND
 348
 349 const char* ToChar(Command aCommand);
 350
 351 /**
 352  * Return a command value for aCommandName.
 353  * XXX: Is there a better place to put `Command` related methods instead of
 354  *      global scope in `mozilla` namespace?
 355  *
 356  * @param aCommandName          Should be a XUL command name like "cmd_bold"
 357  *                              (case sensitive).
 358  * @param aCommandparams        Additional parameter value of aCommandName.
 359  *                              Can be nullptr, but if aCommandName requires
 360  *                              additional parameter and sets this to nullptr,
 361  *                              will return Command::DoNothing with warning.
 362  */
 363 Command GetInternalCommand(const char* aCommandName,
 364                            const nsCommandParams* aCommandParams = nullptr);
 365
 366 }  // namespace mozilla
 367
 368 /**
 369  * All header files should include this header instead of *Events.h.
 370  */
 371
 372 namespace mozilla {
 373
 374 #define NS_EVENT_CLASS(aPrefix, aName) class aPrefix##aName;
 375 #define NS_ROOT_EVENT_CLASS(aPrefix, aName) NS_EVENT_CLASS(aPrefix, aName)
 376
 377 #include "mozilla/EventClassList.h"
 378
 379 #undef NS_EVENT_CLASS
 380 #undef NS_ROOT_EVENT_CLASS
 381
 382 // BasicEvents.h
 383 struct BaseEventFlags;
 384 struct EventFlags;
 385
 386 class WidgetEventTime;
 387
 388 class NativeEventData;
 389
 390 // TextEvents.h
 391 enum class AccessKeyType;
 392
 393 struct AlternativeCharCode;
 394 struct ShortcutKeyCandidate;
 395
 396 typedef nsTArray<ShortcutKeyCandidate> ShortcutKeyCandidateArray;
 397 typedef AutoTArray<ShortcutKeyCandidate, 10> AutoShortcutKeyCandidateArray;
 398
 399 // TextRange.h
 400 typedef uint8_t RawTextRangeType;
 401 enum class TextRangeType : RawTextRangeType;
 402
 403 struct TextRangeStyle;
 404 struct TextRange;
 405
 406 class EditCommands;
 407 class TextRangeArray;
 408
 409 // FontRange.h
 410 struct FontRange;
 411
 412 enum MouseButton { eNotPressed = -1, eLeft = 0, eMiddle = 1, eRight = 2 };
 413
 414 enum MouseButtonsFlag {
 415   eNoButtons = 0x00,
 416   eLeftFlag = 0x01,
 417   eRightFlag = 0x02,
 418   eMiddleFlag = 0x04,
 419   // typicall, "back" button being left side of 5-button
 420   // mice, see "buttons" attribute document of DOM3 Events.
 421   e4thFlag = 0x08,
 422   // typicall, "forward" button being right side of 5-button
 423   // mice, see "buttons" attribute document of DOM3 Events.
 424   e5thFlag = 0x10
 425 };
 426
 427 enum class TextRangeType : RawTextRangeType;
 428
 429 }  // namespace mozilla
 430
 431 #endif  // mozilla_EventForwards_h__