content/common/input_messages.h

   1 // Copyright (c) 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 // IPC messages for input events and other messages that require processing in
   6 // order relative to input events.
   7 // Multiply-included message file, hence no include guard.
   8
   9 #include "base/strings/string16.h"
  10 #include "content/common/content_export.h"
  11 #include "content/common/content_param_traits.h"
  12 #include "content/common/edit_command.h"
  13 #include "content/common/input/input_event.h"
  14 #include "content/common/input/input_event_ack_state.h"
  15 #include "content/common/input/input_param_traits.h"
  16 #include "content/common/input/synthetic_gesture_packet.h"
  17 #include "content/common/input/synthetic_gesture_params.h"
  18 #include "content/common/input/synthetic_pinch_gesture_params.h"
  19 #include "content/common/input/synthetic_smooth_scroll_gesture_params.h"
  20 #include "content/common/input/synthetic_tap_gesture_params.h"
  21 #include "content/public/common/common_param_traits.h"
  22 #include "content/common/input/touch_action.h"
  23 #include "ipc/ipc_message_macros.h"
  24 #include "third_party/WebKit/public/web/WebInputEvent.h"
  25 #include "ui/events/latency_info.h"
  26 #include "ui/gfx/point.h"
  27 #include "ui/gfx/rect.h"
  28
  29 #undef IPC_MESSAGE_EXPORT
  30 #define IPC_MESSAGE_EXPORT CONTENT_EXPORT
  31
  32 #ifdef IPC_MESSAGE_START
  33 #error IPC_MESSAGE_START
  34 #endif
  35
  36 #define IPC_MESSAGE_START InputMsgStart
  37
  38 IPC_ENUM_TRAITS_MAX_VALUE(content::InputEventAckState,
  39                           content::INPUT_EVENT_ACK_STATE_MAX)
  40 IPC_ENUM_TRAITS_MAX_VALUE(
  41     content::SyntheticGestureParams::GestureSourceType,
  42     content::SyntheticGestureParams::GESTURE_SOURCE_TYPE_MAX)
  43 IPC_ENUM_TRAITS_MAX_VALUE(
  44     content::SyntheticGestureParams::GestureType,
  45     content::SyntheticGestureParams::SYNTHETIC_GESTURE_TYPE_MAX)
  46 IPC_ENUM_TRAITS_VALIDATE(content::TouchAction, (
  47     value >= 0 &&
  48     value <= content::TOUCH_ACTION_MAX &&
  49     (!(value & content::TOUCH_ACTION_NONE) ||
  50         (value == content::TOUCH_ACTION_NONE)) &&
  51     (!(value & content::TOUCH_ACTION_PINCH_ZOOM) ||
  52         (value == content::TOUCH_ACTION_MANIPULATION))))
  53
  54 IPC_STRUCT_TRAITS_BEGIN(content::EditCommand)
  55   IPC_STRUCT_TRAITS_MEMBER(name)
  56   IPC_STRUCT_TRAITS_MEMBER(value)
  57 IPC_STRUCT_TRAITS_END()
  58
  59 IPC_STRUCT_TRAITS_BEGIN(content::InputEvent)
  60   IPC_STRUCT_TRAITS_MEMBER(web_event)
  61   IPC_STRUCT_TRAITS_MEMBER(latency_info)
  62   IPC_STRUCT_TRAITS_MEMBER(is_keyboard_shortcut)
  63 IPC_STRUCT_TRAITS_END()
  64
  65 IPC_STRUCT_TRAITS_BEGIN(content::SyntheticGestureParams)
  66   IPC_STRUCT_TRAITS_MEMBER(gesture_source_type)
  67 IPC_STRUCT_TRAITS_END()
  68
  69 IPC_STRUCT_TRAITS_BEGIN(content::SyntheticSmoothScrollGestureParams)
  70   IPC_STRUCT_TRAITS_PARENT(content::SyntheticGestureParams)
  71   IPC_STRUCT_TRAITS_MEMBER(anchor)
  72   IPC_STRUCT_TRAITS_MEMBER(distances)
  73   IPC_STRUCT_TRAITS_MEMBER(prevent_fling)
  74   IPC_STRUCT_TRAITS_MEMBER(speed_in_pixels_s)
  75 IPC_STRUCT_TRAITS_END()
  76
  77 IPC_STRUCT_TRAITS_BEGIN(content::SyntheticPinchGestureParams)
  78   IPC_STRUCT_TRAITS_PARENT(content::SyntheticGestureParams)
  79   IPC_STRUCT_TRAITS_MEMBER(zoom_in)
  80   IPC_STRUCT_TRAITS_MEMBER(total_num_pixels_covered)
  81   IPC_STRUCT_TRAITS_MEMBER(anchor)
  82   IPC_STRUCT_TRAITS_MEMBER(relative_pointer_speed_in_pixels_s)
  83 IPC_STRUCT_TRAITS_END()
  84
  85 IPC_STRUCT_TRAITS_BEGIN(content::SyntheticTapGestureParams)
  86   IPC_STRUCT_TRAITS_PARENT(content::SyntheticGestureParams)
  87   IPC_STRUCT_TRAITS_MEMBER(position)
  88   IPC_STRUCT_TRAITS_MEMBER(duration_ms)
  89 IPC_STRUCT_TRAITS_END()
  90
  91 // Sends an input event to the render widget.
  92 IPC_MESSAGE_ROUTED3(InputMsg_HandleInputEvent,
  93                     IPC::WebInputEventPointer /* event */,
  94                     ui::LatencyInfo /* latency_info */,
  95                     bool /* is_keyboard_shortcut */)
  96
  97 // Sends the cursor visibility state to the render widget.
  98 IPC_MESSAGE_ROUTED1(InputMsg_CursorVisibilityChange,
  99                     bool /* is_visible */)
 100
 101 // This message notifies the renderer that the next key event is bound to one
 102 // or more pre-defined edit commands. If the next key event is not handled
 103 // by webkit, the specified edit commands shall be executed against current
 104 // focused frame.
 105 // Parameters
 106 // * edit_commands (see chrome/common/edit_command_types.h)
 107 //   Contains one or more edit commands.
 108 // See third_party/WebKit/Source/WebCore/editing/EditorCommand.cpp for detailed
 109 // definition of webkit edit commands.
 110 //
 111 // This message must be sent just before sending a key event.
 112 IPC_MESSAGE_ROUTED1(InputMsg_SetEditCommandsForNextKeyEvent,
 113                     std::vector<content::EditCommand> /* edit_commands */)
 114
 115 // Message payload is the name/value of a WebCore edit command to execute.
 116 IPC_MESSAGE_ROUTED2(InputMsg_ExecuteEditCommand,
 117                     std::string, /* name */
 118                     std::string /* value */)
 119
 120 IPC_MESSAGE_ROUTED0(InputMsg_MouseCaptureLost)
 121
 122 // TODO(darin): figure out how this meshes with RestoreFocus
 123 IPC_MESSAGE_ROUTED1(InputMsg_SetFocus,
 124                     bool /* enable */)
 125
 126 // Tells the renderer to scroll the currently focused node into rect only if
 127 // the currently focused node is a Text node (textfield, text area or content
 128 // editable divs).
 129 IPC_MESSAGE_ROUTED1(InputMsg_ScrollFocusedEditableNodeIntoRect, gfx::Rect)
 130
 131 // These messages are typically generated from context menus and request the
 132 // renderer to apply the specified operation to the current selection.
 133 IPC_MESSAGE_ROUTED0(InputMsg_Undo)
 134 IPC_MESSAGE_ROUTED0(InputMsg_Redo)
 135 IPC_MESSAGE_ROUTED0(InputMsg_Cut)
 136 IPC_MESSAGE_ROUTED0(InputMsg_Copy)
 137 #if defined(OS_MACOSX)
 138 IPC_MESSAGE_ROUTED0(InputMsg_CopyToFindPboard)
 139 #endif
 140 IPC_MESSAGE_ROUTED0(InputMsg_Paste)
 141 IPC_MESSAGE_ROUTED0(InputMsg_PasteAndMatchStyle)
 142 // Replaces the selected region or a word around the cursor with the
 143 // specified string.
 144 IPC_MESSAGE_ROUTED1(InputMsg_Replace,
 145                     base::string16)
 146 // Replaces the misspelling in the selected region with the specified string.
 147 IPC_MESSAGE_ROUTED1(InputMsg_ReplaceMisspelling,
 148                     base::string16)
 149 IPC_MESSAGE_ROUTED0(InputMsg_Delete)
 150 IPC_MESSAGE_ROUTED0(InputMsg_SelectAll)
 151
 152 IPC_MESSAGE_ROUTED0(InputMsg_Unselect)
 153
 154 // Requests the renderer to select the region between two points.
 155 // Expects a SelectRange_ACK message when finished.
 156 IPC_MESSAGE_ROUTED2(InputMsg_SelectRange,
 157                     gfx::Point /* start */,
 158                     gfx::Point /* end */)
 159
 160 // Requests the renderer to move the caret selection toward the point.
 161 // Expects a MoveCaret_ACK message when finished.
 162 IPC_MESSAGE_ROUTED1(InputMsg_MoveCaret,
 163                     gfx::Point /* location */)
 164
 165 #if defined(OS_ANDROID)
 166 // Sent when the user clicks on the find result bar to activate a find result.
 167 // The point (x,y) is in fractions of the content document's width and height.
 168 IPC_MESSAGE_ROUTED3(InputMsg_ActivateNearestFindResult,
 169                     int /* request_id */,
 170                     float /* x */,
 171                     float /* y */)
 172 #endif
 173
 174 IPC_MESSAGE_ROUTED0(InputMsg_SyntheticGestureCompleted);
 175
 176 // -----------------------------------------------------------------------------
 177 // Messages sent from the renderer to the browser.
 178
 179 // Acknowledges receipt of a InputMsg_HandleInputEvent message.
 180 IPC_MESSAGE_ROUTED3(InputHostMsg_HandleInputEvent_ACK,
 181                     blink::WebInputEvent::Type,
 182                     content::InputEventAckState /* ack_result */,
 183                     ui::LatencyInfo /* latency_info */)
 184
 185 IPC_MESSAGE_ROUTED1(InputHostMsg_QueueSyntheticGesture,
 186                     content::SyntheticGesturePacket)
 187
 188 // Notifies the allowed touch actions for a new touch point.
 189 IPC_MESSAGE_ROUTED1(InputHostMsg_SetTouchAction,
 190                     content::TouchAction /* touch_action */)
 191
 192 // Adding a new message? Stick to the sort order above: first platform
 193 // independent InputMsg, then ifdefs for platform specific InputMsg, then
 194 // platform independent InputHostMsg, then ifdefs for platform specific
 195 // InputHostMsg.