src/content/renderer/devtools/devtools_agent.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 #ifndef CONTENT_RENDERER_DEVTOOLS_DEVTOOLS_AGENT_H_
   6 #define CONTENT_RENDERER_DEVTOOLS_DEVTOOLS_AGENT_H_
   7
   8 #include <string>
   9 #include <vector>
  10
  11 #include "base/atomicops.h"
  12 #include "base/basictypes.h"
  13 #include "base/memory/weak_ptr.h"
  14 #include "base/time/time.h"
  15 #include "content/public/common/console_message_level.h"
  16 #include "content/public/renderer/render_view_observer.h"
  17 #include "third_party/WebKit/public/web/WebDevToolsAgentClient.h"
  18
  19 namespace blink {
  20 class WebDevToolsAgent;
  21 }
  22
  23 struct GpuTaskInfo;
  24
  25 namespace content {
  26 class RenderViewImpl;
  27
  28 // DevToolsAgent belongs to the inspectable RenderView and provides Glue's
  29 // agents with the communication capabilities. All messages from/to Glue's
  30 // agents infrastructure are flowing through this communication agent.
  31 // There is a corresponding DevToolsClient object on the client side.
  32 class DevToolsAgent : public RenderViewObserver,
  33                       public base::SupportsWeakPtr<DevToolsAgent>,
  34                       public blink::WebDevToolsAgentClient {
  35  public:
  36   explicit DevToolsAgent(RenderViewImpl* render_view);
  37   virtual ~DevToolsAgent();
  38
  39   // Returns agent instance for its host id.
  40   static DevToolsAgent* FromHostId(int host_id);
  41
  42   blink::WebDevToolsAgent* GetWebAgent();
  43
  44   bool IsAttached();
  45
  46  private:
  47   // RenderView::Observer implementation.
  48   virtual bool OnMessageReceived(const IPC::Message& message) OVERRIDE;
  49
  50   // WebDevToolsAgentClient implementation
  51   virtual void sendMessageToInspectorFrontend(const blink::WebString& data);
  52
  53   virtual int hostIdentifier() OVERRIDE;
  54   virtual void saveAgentRuntimeState(const blink::WebString& state) OVERRIDE;
  55   virtual blink::WebDevToolsAgentClient::WebKitClientMessageLoop*
  56       createClientMessageLoop() OVERRIDE;
  57   virtual void visitAllocatedObjects(AllocatedObjectVisitor* visitor) OVERRIDE;
  58
  59   typedef void (*TraceEventCallback)(
  60       char phase, const unsigned char*, const char* name, unsigned long long id,
  61       int numArgs, const char* const* argNames, const unsigned char* argTypes,
  62       const unsigned long long* argValues,
  63       unsigned char flags, double timestamp);
  64   virtual void resetTraceEventCallback() OVERRIDE;
  65   virtual void setTraceEventCallback(const blink::WebString& category_filter,
  66                                      TraceEventCallback cb) OVERRIDE;
  67   virtual void enableTracing(const blink::WebString& category_filter) OVERRIDE;
  68   virtual void disableTracing() OVERRIDE;
  69   virtual void startGPUEventsRecording() OVERRIDE;
  70   virtual void stopGPUEventsRecording() OVERRIDE;
  71
  72   virtual void enableDeviceEmulation(
  73       const blink::WebDeviceEmulationParams& params) OVERRIDE;
  74   virtual void disableDeviceEmulation() OVERRIDE;
  75   virtual void setTouchEventEmulationEnabled(bool enabled,
  76                                              bool allow_pinch) OVERRIDE;
  77
  78   void OnAttach();
  79   void OnReattach(const std::string& agent_state);
  80   void OnDetach();
  81   void OnDispatchOnInspectorBackend(const std::string& message);
  82   void OnInspectElement(int x, int y);
  83   void OnAddMessageToConsole(ConsoleMessageLevel level,
  84                              const std::string& message);
  85   void OnGpuTasksChunk(const std::vector<GpuTaskInfo>& tasks);
  86   void ContinueProgram();
  87   void OnSetupDevToolsClient();
  88
  89   static void TraceEventCallbackWrapper(
  90       base::TimeTicks timestamp,
  91       char phase,
  92       const unsigned char* category_group_enabled,
  93       const char* name,
  94       unsigned long long id,
  95       int num_args,
  96       const char* const arg_names[],
  97       const unsigned char arg_types[],
  98       const unsigned long long arg_values[],
  99       unsigned char flags);
 100
 101   bool is_attached_;
 102   bool is_devtools_client_;
 103   int32 gpu_route_id_;
 104
 105   static base::subtle::AtomicWord /* TraceEventCallback */ event_callback_;
 106
 107   DISALLOW_COPY_AND_ASSIGN(DevToolsAgent);
 108 };
 109
 110 }  // namespace content
 111
 112 #endif  // CONTENT_RENDERER_DEVTOOLS_DEVTOOLS_AGENT_H_