summaryrefslogtreecommitdiffstats
path: root/chrome/browser/debugger/devtools_manager.h
blob: fe6fc4f8e07b25e64f75129e3d1dae421124f45f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
// Copyright (c) 2009 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_DEBUGGER_DEVTOOLS_MANAGER_H_
#define CHROME_BROWSER_DEBUGGER_DEVTOOLS_MANAGER_H_

#include <map>

#include "base/basictypes.h"
#include "base/scoped_ptr.h"
#include "chrome/browser/debugger/devtools_client_host.h"
#include "chrome/common/notification_service.h"

namespace IPC {
class Message;
}

class DevToolsClientHost;
class NavigationController;
class NotificationRegistrar;
class RenderViewHost;
class WebContents;

// This class is a singleton that manages DevToolsClientHost instances and
// routes messages between developer tools clients and agents.
class DevToolsManager : public NotificationObserver,
                        public DevToolsClientHost::CloseListener {
 public:
  DevToolsManager();
  virtual ~DevToolsManager();

  // Returns DevToolsClientHost registered for |web_contents| or NULL if
  // there is no alive DevToolsClientHost registered for |web_contents|.
  DevToolsClientHost* GetDevToolsClientHostFor(const WebContents& web_contents);

  // Registers new DevToolsClientHost for |web_contents|. There must be no
  // other DevToolsClientHosts registered for the WebContents at the moment.
  void RegisterDevToolsClientHostFor(const WebContents& web_contents,
                                     DevToolsClientHost* client_host);

  void ForwardToDevToolsAgent(const RenderViewHost& client_rvh,
                              const IPC::Message& message);
  void ForwardToDevToolsAgent(const DevToolsClientHost& from,
                              const IPC::Message& message);
  void ForwardToDevToolsClient(const RenderViewHost& from,
                               const IPC::Message& message);

  void OpenDevToolsWindow(WebContents* wc);

  // Starts element inspection in the devtools client.
  // Creates one by means of OpenDevToolsWindow if no client
  // exists.
  void InspectElement(WebContents* web_contents, int x, int y);

  // Sends 'Attach' message to the agent using |target_host| in case
  // there is a DevToolsClientHost registered for the |web_contents|.
  void SendAttachToAgent(
      const WebContents& web_contents,
      RenderViewHost* target_host);

private:
  // NotificationObserver override.
  virtual void Observe(NotificationType type,
                       const NotificationSource& source,
                       const NotificationDetails& details);

  // DevToolsClientHost::CloseListener override.
  // This method will remove all references from the manager to the
  // DevToolsClientHost and unregister all listeners related to the
  // DevToolsClientHost.
  virtual void ClientHostClosing(DevToolsClientHost* host);

  // Returns NavigationController for the tab that is inspected by devtools
  // client hosted by DevToolsClientHost.
  NavigationController* GetDevToolsAgentNavigationController(
      const DevToolsClientHost& client_host);

  void UnregisterDevToolsClientHost(
      DevToolsClientHost* client_host,
      NavigationController* navigation_controller);
  void StartListening(NavigationController* navigation_controller);
  void StopListening(NavigationController* navigation_controller);
  void SendDetachToAgent(const WebContents& web_contents);

  // This object is not NULL iff there is at least one registered
  // DevToolsClientHost.
  scoped_ptr<NotificationRegistrar> web_contents_listeners_;

  // These two maps are for tracking dependencies between inspected tabs and
  // their DevToolsClientHosts. They are usful for routing devtools messages
  // and allow us to have at most one devtools client host per tab. We use
  // NavigationController* as key because it survives crosee-site navigation in
  // cases when tab contents may change.
  //
  // DevToolsManager start listening to DevToolsClientHosts when they are put
  // into these maps and removes them when they are closing.
  typedef std::map<const NavigationController*,
                   DevToolsClientHost*> ClientHostMap;
  ClientHostMap navcontroller_to_client_host_;

  typedef std::map<const DevToolsClientHost*,
                   NavigationController*> NavControllerMap;
  NavControllerMap client_host_to_navcontroller_;

  DISALLOW_COPY_AND_ASSIGN(DevToolsManager);
};

#endif  // CHROME_BROWSER_DEBUGGER_DEVTOOLS_MANAGER_H_