content/common/devtools_messages.h

   1 // Copyright (c) 2012 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 // Developer tools consist of the following parts:
   6 //
   7 // DevToolsAgent lives in the renderer of an inspected page and provides access
   8 // to the pages resources, DOM, v8 etc. by means of IPC messages.
   9 //
  10 // DevToolsClient is a thin delegate that lives in the tools front-end
  11 // renderer and converts IPC messages to frontend method calls and allows the
  12 // frontend to send messages to the DevToolsAgent.
  13 //
  14 // All the messages are routed through browser process. There is a
  15 // DevToolsManager living in the browser process that is responsible for
  16 // routing logistics. It is also capable of sending direct messages to the
  17 // agent rather than forwarding messages between agents and clients only.
  18 //
  19 // Chain of communication between the components may be described by the
  20 // following diagram:
  21 //  ----------------------------
  22 // | (tools frontend            |
  23 // | renderer process)          |
  24 // |                            |            --------------------
  25 // |tools    <--> DevToolsClient+<-- IPC -->+ (browser process)  |
  26 // |frontend                    |           |                    |
  27 //  ----------------------------             ---------+----------
  28 //                                                    ^
  29 //                                                    |
  30 //                                                   IPC
  31 //                                                    |
  32 //                                                    v
  33 //                          --------------------------+--------
  34 //                         | inspected page <--> DevToolsAgent |
  35 //                         |                                   |
  36 //                         | (inspected page renderer process) |
  37 //                          -----------------------------------
  38 //
  39 // This file describes developer tools message types.
  40
  41 // Multiply-included message file, no standard include guard.
  42 #include <map>
  43 #include <string>
  44
  45 #include "content/common/content_export.h"
  46 #include "content/public/common/common_param_traits.h"
  47 #include "content/public/common/console_message_level.h"
  48 #include "ipc/ipc_message_macros.h"
  49
  50 #undef IPC_MESSAGE_EXPORT
  51 #define IPC_MESSAGE_EXPORT CONTENT_EXPORT
  52
  53 #define IPC_MESSAGE_START DevToolsMsgStart
  54
  55 // These are messages sent from DevToolsAgent to DevToolsClient through the
  56 // browser.
  57 // WebKit-level transport.
  58
  59 // Sends response from the agent to the client. Supports chunked encoding.
  60 // First (the only) chunk arrives with the |total_size| != 0,
  61 // remaining chunks arrive with |total_size| == 0.
  62 IPC_MESSAGE_ROUTED2(DevToolsClientMsg_DispatchOnInspectorFrontend,
  63                     std::string /* message */,
  64                     uint32 /* total_size */)
  65
  66 //-----------------------------------------------------------------------------
  67 // These are messages sent from DevToolsClient to DevToolsAgent through the
  68 // browser.
  69 // Tells agent that there is a client host connected to it.
  70 IPC_MESSAGE_ROUTED1(DevToolsAgentMsg_Attach,
  71                     std::string /* host_id */)
  72
  73 // Tells agent that a client host was disconnected from another agent and
  74 // connected to this one.
  75 IPC_MESSAGE_ROUTED2(DevToolsAgentMsg_Reattach,
  76                     std::string /* host_id */,
  77                     std::string /* agent_state */)
  78
  79 // Tells agent that there is no longer a client host connected to it.
  80 IPC_MESSAGE_ROUTED0(DevToolsAgentMsg_Detach)
  81
  82 // WebKit-level transport.
  83 IPC_MESSAGE_ROUTED1(DevToolsAgentMsg_DispatchOnInspectorBackend,
  84                     std::string /* message */)
  85
  86 // Inspect element with the given coordinates.
  87 IPC_MESSAGE_ROUTED3(DevToolsAgentMsg_InspectElement,
  88                     std::string /* host_id */,
  89                     int /* x */,
  90                     int /* y */)
  91
  92 // Add message to the devtools console.
  93 IPC_MESSAGE_ROUTED2(DevToolsAgentMsg_AddMessageToConsole,
  94                     content::ConsoleMessageLevel /* level */,
  95                     std::string /* message */)
  96
  97 //-----------------------------------------------------------------------------
  98 // These are messages sent from the browser to the renderer.
  99
 100 // RenderViewHostDelegate::RenderViewCreated method sends this message to a
 101 // new renderer to notify it that it will host developer tools UI and should
 102 // set up all neccessary bindings and create DevToolsClient instance that
 103 // will handle communication with inspected page DevToolsAgent.
 104 IPC_MESSAGE_ROUTED0(DevToolsMsg_SetupDevToolsClient)
 105
 106
 107 //-----------------------------------------------------------------------------
 108 // These are messages sent from the renderer to the browser.
 109
 110 // Transport from Inspector frontend to frontend host.
 111 IPC_MESSAGE_ROUTED1(DevToolsHostMsg_DispatchOnEmbedder,
 112                     std::string /* message */)
 113
 114 // Updates agent runtime state stored in devtools manager in order to support
 115 // cross-navigation instrumentation.
 116 IPC_MESSAGE_ROUTED1(DevToolsHostMsg_SaveAgentRuntimeState,
 117                     std::string /* state */)
 118
 119 //-----------------------------------------------------------------------------
 120 // These are messages sent from the GPU process to the inspected renderer.
 121
 122 IPC_STRUCT_BEGIN(GpuTaskInfo)
 123   IPC_STRUCT_MEMBER(double, timestamp)
 124   IPC_STRUCT_MEMBER(int, phase)
 125   IPC_STRUCT_MEMBER(bool, foreign)
 126   IPC_STRUCT_MEMBER(uint64, gpu_memory_used_bytes)
 127   IPC_STRUCT_MEMBER(uint64, gpu_memory_limit_bytes)
 128 IPC_STRUCT_END()
 129
 130 // Recorded events are passed in chunks to the renderer process.
 131 IPC_MESSAGE_ROUTED1(DevToolsAgentMsg_GpuTasksChunk,
 132                     std::vector<GpuTaskInfo> /* gpu_tasks */)
 133
 134 //-----------------------------------------------------------------------------
 135 // These are messages sent from the inspected page renderer to the worker
 136 // renderer.