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_PUBLIC_BROWSER_DEVTOOLS_AGENT_HOST_H_ 6 #define CONTENT_PUBLIC_BROWSER_DEVTOOLS_AGENT_HOST_H_ 7 8 #include <string> 9 #include <vector> 10 11 #include "base/basictypes.h" 12 #include "base/memory/ref_counted.h" 13 #include "content/common/content_export.h" 14 15 namespace content { 16 17 class DevToolsExternalAgentProxyDelegate; 18 class RenderViewHost; 19 class WebContents; 20 21 // Describes interface for managing devtools agents from browser process. 22 class CONTENT_EXPORT DevToolsAgentHost 23 : public base::RefCounted<DevToolsAgentHost> { 24 public: 25 // Returns DevToolsAgentHost with a given |id| or NULL of it does not exist. 26 static scoped_refptr<DevToolsAgentHost> GetForId(const std::string& id); 27 28 // Returns DevToolsAgentHost that can be used for inspecting |web_contents|. 29 // New DevToolsAgentHost will be created if it does not exist. 30 static scoped_refptr<DevToolsAgentHost> GetOrCreateFor( 31 WebContents* web_contents); 32 33 // Returns DevToolsAgentHost that can be used for inspecting |rvh|. 34 // New DevToolsAgentHost will be created if it does not exist. 35 static scoped_refptr<DevToolsAgentHost> GetOrCreateFor(RenderViewHost* rvh); 36 37 // Returns true iff an instance of DevToolsAgentHost for the |rvh| 38 // does exist. 39 static bool HasFor(RenderViewHost* rvh); 40 41 // Returns DevToolsAgentHost that can be used for inspecting shared worker 42 // with given worker process host id and routing id. 43 static scoped_refptr<DevToolsAgentHost> GetForWorker(int worker_process_id, 44 int worker_route_id); 45 46 // Creates DevToolsAgentHost that communicates to the target by means of 47 // provided |delegate|. |delegate| ownership is passed to the created agent 48 // host. 49 static scoped_refptr<DevToolsAgentHost> Create( 50 DevToolsExternalAgentProxyDelegate* delegate); 51 52 static bool IsDebuggerAttached(WebContents* web_contents); 53 54 // Returns a list of all existing RenderViewHost's that can be debugged. 55 static std::vector<RenderViewHost*> GetValidRenderViewHosts(); 56 57 // Returns true if there is a client attached. 58 virtual bool IsAttached() = 0; 59 60 // Starts inspecting element at position (|x|, |y|) in the specified page. 61 virtual void InspectElement(int x, int y) = 0; 62 63 // Returns the unique id of the agent. 64 virtual std::string GetId() = 0; 65 66 // Returns render view host instance for this host if any. 67 virtual RenderViewHost* GetRenderViewHost() = 0; 68 69 // Temporarily detaches render view host from this host. Must be followed by 70 // a call to ConnectRenderViewHost (may leak the host instance otherwise). 71 virtual void DisconnectRenderViewHost() = 0; 72 73 // Attaches render view host to this host. 74 virtual void ConnectRenderViewHost(RenderViewHost* rvh) = 0; 75 76 // Returns true if DevToolsAgentHost is for worker. 77 virtual bool IsWorker() const = 0; 78 79 protected: 80 friend class base::RefCounted<DevToolsAgentHost>; ~DevToolsAgentHost()81 virtual ~DevToolsAgentHost() {} 82 }; 83 84 } // namespace content 85 86 #endif // CONTENT_PUBLIC_BROWSER_DEVTOOLS_AGENT_HOST_H_ 87