DevTools: extract DevToolsWindowBase, leave docking, unload and factory logic in DevToolsWindow.

R=dgozman@chromium.org, vsevik@chromium.org
TBR=jam for chrome/chrome.gyp

Review URL: https://codereview.chromium.org/253823005

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@266873 0039d316-1c4b-4281-b951-d872f2087c98

chrome/browser/devtools/devtools_sanity_browsertest.cc

@@ -89,14 +89,14 @@ void RunTestFunction(DevToolsWindow* window, const char* test_name) {
   // files have been loaded) and has runTest method.
   ASSERT_TRUE(
       content::ExecuteScriptAndExtractString(
-          window->GetRenderViewHost(),
+          window->web_contents()->GetRenderViewHost(),
           "window.domAutomationController.send("
           "    '' + (window.uiTests && (typeof uiTests.runTest)));",
           &result));
 
   ASSERT_EQ("function", result) << "DevTools front-end is broken.";
   ASSERT_TRUE(content::ExecuteScriptAndExtractString(
-      window->GetRenderViewHost(),
+      window->web_contents()->GetRenderViewHost(),
       base::StringPrintf("uiTests.runTest('%s')", test_name),
       &result));
   EXPECT_EQ("[OK]", result);
@@ -539,7 +539,7 @@ class WorkerDevToolsSanityTest : public InProcessBrowserTest {
             worker_data->worker_process_id,
             worker_data->worker_route_id));
     window_ = DevToolsWindow::OpenDevToolsWindowForWorker(profile, agent_host);
-    RenderViewHost* client_rvh = window_->GetRenderViewHost();
+    RenderViewHost* client_rvh = window_->web_contents()->GetRenderViewHost();
     WebContents* client_contents = WebContents::FromRenderViewHost(client_rvh);
     content::WaitForLoadStop(client_contents);
   }
@@ -871,7 +871,7 @@ IN_PROC_BROWSER_TEST_F(DevToolsSanityTest, TestPageWithNoJavaScript) {
   std::string result;
   ASSERT_TRUE(
       content::ExecuteScriptAndExtractString(
-          window_->GetRenderViewHost(),
+          window_->web_contents()->GetRenderViewHost(),
           "window.domAutomationController.send("
           "    '' + (window.uiTests && (typeof uiTests.runTest)));",
           &result));

chrome/browser/devtools/devtools_window.h

@@ -5,62 +5,29 @@
 #ifndef CHROME_BROWSER_DEVTOOLS_DEVTOOLS_WINDOW_H_
 #define CHROME_BROWSER_DEVTOOLS_DEVTOOLS_WINDOW_H_
 
-#include <string>
-#include <vector>
-
-#include "base/basictypes.h"
-#include "base/memory/scoped_ptr.h"
-#include "base/memory/weak_ptr.h"
-#include "base/strings/string16.h"
-#include "chrome/browser/devtools/device/devtools_android_bridge.h"
 #include "chrome/browser/devtools/devtools_contents_resizing_strategy.h"
-#include "chrome/browser/devtools/devtools_embedder_message_dispatcher.h"
-#include "chrome/browser/devtools/devtools_file_helper.h"
-#include "chrome/browser/devtools/devtools_file_system_indexer.h"
-#include "chrome/browser/devtools/devtools_targets_ui.h"
 #include "chrome/browser/devtools/devtools_toggle_action.h"
-#include "content/public/browser/devtools_client_host.h"
-#include "content/public/browser/devtools_frontend_host_delegate.h"
-#include "content/public/browser/notification_observer.h"
-#include "content/public/browser/notification_registrar.h"
+#include "chrome/browser/devtools/devtools_window_base.h"
 #include "content/public/browser/web_contents_delegate.h"
-#include "ui/gfx/size.h"
 
 class Browser;
 class BrowserWindow;
 class DevToolsControllerTest;
 class DevToolsEventForwarder;
-class Profile;
-
-namespace base {
-class Value;
-}
 
 namespace content {
 class DevToolsAgentHost;
-class DevToolsClientHost;
-struct FileChooserParams;
 struct NativeWebKeyboardEvent;
 class RenderViewHost;
-class WebContents;
-}
-
-namespace IPC {
-class Message;
 }
 
 namespace user_prefs {
 class PrefRegistrySyncable;
 }
 
-class DevToolsWindow : private content::NotificationObserver,
-                       private content::WebContentsDelegate,
-                       private content::DevToolsFrontendHostDelegate,
-                       private DevToolsEmbedderMessageDispatcher::Delegate,
-                       private DevToolsAndroidBridge::DeviceCountListener {
+class DevToolsWindow : public DevToolsWindowBase,
+                       public content::WebContentsDelegate {
  public:
-  typedef base::Callback<void(bool)> InfoBarCallback;
-
   static const char kDevToolsApp[];
 
   virtual ~DevToolsWindow();
@@ -122,14 +89,8 @@ class DevToolsWindow : private content::NotificationObserver,
   static void InspectElement(
       content::RenderViewHost* inspected_rvh, int x, int y);
 
-  // content::DevToolsFrontendHostDelegate:
-  virtual void InspectedContentsClosing() OVERRIDE;
-
-  content::WebContents* web_contents() { return web_contents_; }
   Browser* browser() { return browser_; }  // For tests.
 
-  content::RenderViewHost* GetRenderViewHost();
-
   // Inspected WebContents is placed over DevTools WebContents in docked mode.
   // The following method returns the resizing strategy of inspected
   // WebContents relative to DevTools WebContents.
@@ -267,15 +228,14 @@ class DevToolsWindow : private content::NotificationObserver,
       bool force_open,
       const DevToolsToggleAction& action);
 
-  // content::NotificationObserver:
-  virtual void Observe(int type,
-                       const content::NotificationSource& source,
-                       const content::NotificationDetails& details) OVERRIDE;
+  // content::DevToolsFrontendHostDelegate override:
+  virtual void InspectedContentsClosing() OVERRIDE;
 
   // content::WebContentsDelegate:
   virtual content::WebContents* OpenURLFromTab(
       content::WebContents* source,
       const content::OpenURLParams& params) OVERRIDE;
+  virtual void ActivateContents(content::WebContents* contents) OVERRIDE;
   virtual void AddNewContents(content::WebContents* source,
                               content::WebContents* new_contents,
                               WindowOpenDisposition disposition,
@@ -308,12 +268,8 @@ class DevToolsWindow : private content::NotificationObserver,
       content::WebContents* source,
       const blink::WebGestureEvent& event) OVERRIDE;
 
-  // content::DevToolsFrontendHostDelegate override:
-  virtual void DispatchOnEmbedder(const std::string& message) OVERRIDE;
-
   // DevToolsEmbedderMessageDispatcher::Delegate overrides:
   virtual void ActivateWindow() OVERRIDE;
-  virtual void ActivateContents(content::WebContents* contents) OVERRIDE;
   virtual void CloseWindow() OVERRIDE;
   virtual void SetContentsInsets(
       int left, int top, int right, int bottom) OVERRIDE;
@@ -323,58 +279,11 @@ class DevToolsWindow : private content::NotificationObserver,
   virtual void MoveWindow(int x, int y) OVERRIDE;
   virtual void SetIsDocked(bool is_docked) OVERRIDE;
   virtual void OpenInNewTab(const std::string& url) OVERRIDE;
-  virtual void SaveToFile(const std::string& url,
-                          const std::string& content,
-                          bool save_as) OVERRIDE;
-  virtual void AppendToFile(const std::string& url,
-                            const std::string& content) OVERRIDE;
-  virtual void RequestFileSystems() OVERRIDE;
-  virtual void AddFileSystem() OVERRIDE;
-  virtual void RemoveFileSystem(const std::string& file_system_path) OVERRIDE;
-  virtual void UpgradeDraggedFileSystemPermissions(
-      const std::string& file_system_url) OVERRIDE;
-  virtual void IndexPath(int request_id,
-                         const std::string& file_system_path) OVERRIDE;
-  virtual void StopIndexing(int request_id) OVERRIDE;
-  virtual void SearchInPath(int request_id,
-                            const std::string& file_system_path,
-                            const std::string& query) OVERRIDE;
   virtual void SetWhitelistedShortcuts(const std::string& message) OVERRIDE;
-  virtual void ZoomIn() OVERRIDE;
-  virtual void ZoomOut() OVERRIDE;
-  virtual void ResetZoom() OVERRIDE;
-  virtual void OpenUrlOnRemoteDeviceAndInspect(const std::string& browser_id,
-                                               const std::string& url) OVERRIDE;
-  virtual void StartRemoteDevicesListener() OVERRIDE;
-  virtual void StopRemoteDevicesListener() OVERRIDE;
-  virtual void EnableRemoteDeviceCounter(bool enable) OVERRIDE;
-
-  // DevToolsAndroidBridge::DeviceCountListener override:
-  virtual void DeviceCountChanged(int count) OVERRIDE;
-
-  // Forwards discovered devices to frontend.
-  virtual void PopulateRemoteDevices(const std::string& source,
-                                     scoped_ptr<base::ListValue> targets);
-
-  // DevToolsFileHelper callbacks.
-  void FileSavedAs(const std::string& url);
-  void CanceledFileSaveAs(const std::string& url);
-  void AppendedTo(const std::string& url);
-  void FileSystemsLoaded(
-      const std::vector<DevToolsFileHelper::FileSystem>& file_systems);
-  void FileSystemAdded(const DevToolsFileHelper::FileSystem& file_system);
-  void IndexingTotalWorkCalculated(int request_id,
-                                   const std::string& file_system_path,
-                                   int total_work);
-  void IndexingWorked(int request_id,
-                      const std::string& file_system_path,
-                      int worked);
-  void IndexingDone(int request_id, const std::string& file_system_path);
-  void SearchCompleted(int request_id,
-                       const std::string& file_system_path,
-                       const std::vector<std::string>& file_paths);
-  void ShowDevToolsConfirmInfoBar(const base::string16& message,
-                                  const InfoBarCallback& callback);
+
+  // DevToolsWindowBase overrides
+  virtual void AddDevToolsExtensionsToClient() OVERRIDE;
+  virtual void DocumentOnLoadCompletedInMainFrame() OVERRIDE;
 
   void CreateDevToolsBrowser();
   BrowserWindow* GetInspectedBrowserWindow();
@@ -383,49 +292,24 @@ class DevToolsWindow : private content::NotificationObserver,
   void DoAction(const DevToolsToggleAction& action);
   void LoadCompleted();
   void SetIsDockedAndShowImmediatelyForTest(bool is_docked);
-  void UpdateTheme();
-  void AddDevToolsExtensionsToClient();
-  void CallClientFunction(const std::string& function_name,
-                          const base::Value* arg1,
-                          const base::Value* arg2,
-                          const base::Value* arg3);
   void UpdateBrowserToolbar();
   content::WebContents* GetInspectedWebContents();
-  void DocumentOnLoadCompletedInMainFrame();
 
   class InspectedWebContentsObserver;
   scoped_ptr<InspectedWebContentsObserver> inspected_contents_observer_;
-  class FrontendWebContentsObserver;
-  friend class FrontendWebContentsObserver;
-  scoped_ptr<FrontendWebContentsObserver> frontend_contents_observer_;
 
-  Profile* profile_;
-  content::WebContents* web_contents_;
   Browser* browser_;
   bool is_docked_;
   const bool can_dock_;
-  bool device_listener_enabled_;
   LoadState load_state_;
   DevToolsToggleAction action_on_load_;
   bool ignore_set_is_docked_;
-  content::NotificationRegistrar registrar_;
-  scoped_ptr<content::DevToolsClientHost> frontend_host_;
-  scoped_ptr<DevToolsFileHelper> file_helper_;
-  scoped_refptr<DevToolsFileSystemIndexer> file_system_indexer_;
-  typedef std::map<
-      int,
-      scoped_refptr<DevToolsFileSystemIndexer::FileSystemIndexingJob> >
-      IndexingJobsMap;
-  IndexingJobsMap indexing_jobs_;
   DevToolsContentsResizingStrategy contents_resizing_strategy_;
   // True if we're in the process of handling a beforeunload event originating
   // from the inspected webcontents, see InterceptPageBeforeUnload for details.
   bool intercepted_page_beforeunload_;
   base::Closure load_completed_callback_;
 
-  scoped_ptr<DevToolsRemoteTargetsUIHandler> remote_targets_handler_;
-  scoped_ptr<DevToolsEmbedderMessageDispatcher> embedder_message_dispatcher_;
-  base::WeakPtrFactory<DevToolsWindow> weak_factory_;
   base::TimeTicks inspect_element_start_time_;
   scoped_ptr<DevToolsEventForwarder> event_forwarder_;
 

chrome/browser/devtools/devtools_window_base.h

+// Copyright (c) 2014 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_DEVTOOLS_DEVTOOLS_WINDOW_BASE_H_
+#define CHROME_BROWSER_DEVTOOLS_DEVTOOLS_WINDOW_BASE_H_
+
+#include <string>
+#include <vector>
+
+#include "base/basictypes.h"
+#include "base/memory/scoped_ptr.h"
+#include "base/memory/weak_ptr.h"
+#include "base/strings/string16.h"
+#include "chrome/browser/devtools/device/devtools_android_bridge.h"
+#include "chrome/browser/devtools/devtools_embedder_message_dispatcher.h"
+#include "chrome/browser/devtools/devtools_file_helper.h"
+#include "chrome/browser/devtools/devtools_file_system_indexer.h"
+#include "chrome/browser/devtools/devtools_targets_ui.h"
+#include "content/public/browser/devtools_client_host.h"
+#include "content/public/browser/devtools_frontend_host_delegate.h"
+#include "content/public/browser/notification_observer.h"
+#include "content/public/browser/notification_registrar.h"
+#include "ui/gfx/size.h"
+
+class Profile;
+
+namespace content {
+class DevToolsClientHost;
+struct FileChooserParams;
+class WebContents;
+}
+
+// Base implementation of DevTools bindings around front-end.
+class DevToolsWindowBase : public content::NotificationObserver,
+                           public content::DevToolsFrontendHostDelegate,
+                           public DevToolsEmbedderMessageDispatcher::Delegate,
+                           public DevToolsAndroidBridge::DeviceCountListener {
+ public:
+  virtual ~DevToolsWindowBase();
+
+  content::WebContents* web_contents() { return web_contents_; }
+
+  // content::NotificationObserver:
+  virtual void Observe(int type,
+                       const content::NotificationSource& source,
+                       const content::NotificationDetails& details) OVERRIDE;
+
+  // content::DevToolsFrontendHostDelegate override:
+  virtual void InspectedContentsClosing() OVERRIDE;
+  virtual void DispatchOnEmbedder(const std::string& message) OVERRIDE;
+
+  // DevToolsEmbedderMessageDispatcher::Delegate overrides:
+  virtual void ActivateWindow() OVERRIDE;
+  virtual void CloseWindow() OVERRIDE;
+  virtual void SetContentsInsets(
+      int left, int top, int right, int bottom) OVERRIDE;
+  virtual void SetContentsResizingStrategy(
+      const gfx::Insets& insets, const gfx::Size& min_size) OVERRIDE;
+  virtual void InspectElementCompleted() OVERRIDE;
+  virtual void MoveWindow(int x, int y) OVERRIDE;
+  virtual void SetIsDocked(bool is_docked) OVERRIDE;
+  virtual void OpenInNewTab(const std::string& url) OVERRIDE;
+  virtual void SaveToFile(const std::string& url,
+                          const std::string& content,
+                          bool save_as) OVERRIDE;
+  virtual void AppendToFile(const std::string& url,
+                            const std::string& content) OVERRIDE;
+  virtual void RequestFileSystems() OVERRIDE;
+  virtual void AddFileSystem() OVERRIDE;
+  virtual void RemoveFileSystem(const std::string& file_system_path) OVERRIDE;
+  virtual void UpgradeDraggedFileSystemPermissions(
+      const std::string& file_system_url) OVERRIDE;
+  virtual void IndexPath(int request_id,
+                         const std::string& file_system_path) OVERRIDE;
+  virtual void StopIndexing(int request_id) OVERRIDE;
+  virtual void SearchInPath(int request_id,
+                            const std::string& file_system_path,
+                            const std::string& query) OVERRIDE;
+  virtual void SetWhitelistedShortcuts(const std::string& message) OVERRIDE;
+  virtual void ZoomIn() OVERRIDE;
+  virtual void ZoomOut() OVERRIDE;
+  virtual void ResetZoom() OVERRIDE;
+  virtual void OpenUrlOnRemoteDeviceAndInspect(const std::string& browser_id,
+                                               const std::string& url) OVERRIDE;
+  virtual void StartRemoteDevicesListener() OVERRIDE;
+  virtual void StopRemoteDevicesListener() OVERRIDE;
+  virtual void EnableRemoteDeviceCounter(bool enable) OVERRIDE;
+
+  // DevToolsAndroidBridge::DeviceCountListener override:
+  virtual void DeviceCountChanged(int count) OVERRIDE;
+
+  // Forwards discovered devices to frontend.
+  virtual void PopulateRemoteDevices(const std::string& source,
+                                     scoped_ptr<base::ListValue> targets);
+
+ protected:
+  DevToolsWindowBase(content::WebContents* web_contents,
+                     const GURL& frontend_url);
+
+  virtual void AddDevToolsExtensionsToClient();
+  virtual void DocumentOnLoadCompletedInMainFrame();
+  void CallClientFunction(const std::string& function_name,
+                          const base::Value* arg1,
+                          const base::Value* arg2,
+                          const base::Value* arg3);
+  Profile* profile() { return profile_; }
+  content::DevToolsClientHost* frontend_host() { return frontend_host_.get(); }
+
+ private:
+  typedef base::Callback<void(bool)> InfoBarCallback;
+
+  // DevToolsFileHelper callbacks.
+  void FileSavedAs(const std::string& url);
+  void CanceledFileSaveAs(const std::string& url);
+  void AppendedTo(const std::string& url);
+  void FileSystemsLoaded(
+      const std::vector<DevToolsFileHelper::FileSystem>& file_systems);
+  void FileSystemAdded(const DevToolsFileHelper::FileSystem& file_system);
+  void IndexingTotalWorkCalculated(int request_id,
+                                   const std::string& file_system_path,
+                                   int total_work);
+  void IndexingWorked(int request_id,
+                      const std::string& file_system_path,
+                      int worked);
+  void IndexingDone(int request_id, const std::string& file_system_path);
+  void SearchCompleted(int request_id,
+                       const std::string& file_system_path,
+                       const std::vector<std::string>& file_paths);
+  void ShowDevToolsConfirmInfoBar(const base::string16& message,
+                                  const InfoBarCallback& callback);
+
+  // Theme and extensions support.
+  GURL ApplyThemeToURL(const GURL& base_url);
+  void UpdateTheme();
+
+  class FrontendWebContentsObserver;
+  friend class FrontendWebContentsObserver;
+  scoped_ptr<FrontendWebContentsObserver> frontend_contents_observer_;
+
+  Profile* profile_;
+  content::WebContents* web_contents_;
+  bool device_listener_enabled_;
+  content::NotificationRegistrar registrar_;
+  scoped_ptr<content::DevToolsClientHost> frontend_host_;
+  scoped_ptr<DevToolsFileHelper> file_helper_;
+  scoped_refptr<DevToolsFileSystemIndexer> file_system_indexer_;
+  typedef std::map<
+      int,
+      scoped_refptr<DevToolsFileSystemIndexer::FileSystemIndexingJob> >
+      IndexingJobsMap;
+  IndexingJobsMap indexing_jobs_;
+
+  scoped_ptr<DevToolsRemoteTargetsUIHandler> remote_targets_handler_;
+  scoped_ptr<DevToolsEmbedderMessageDispatcher> embedder_message_dispatcher_;
+  base::WeakPtrFactory<DevToolsWindowBase> weak_factory_;
+
+  DISALLOW_COPY_AND_ASSIGN(DevToolsWindowBase);
+};
+
+#endif  // CHROME_BROWSER_DEVTOOLS_DEVTOOLS_WINDOW_BASE_H_

chrome/chrome.gyp

@@ -186,6 +186,8 @@
             'browser/devtools/devtools_toggle_action.h',
             'browser/devtools/devtools_window.cc',
             'browser/devtools/devtools_window.h',
+            'browser/devtools/devtools_window_base.cc',
+            'browser/devtools/devtools_window_base.h',
             'browser/devtools/remote_debugging_server.cc',
             'browser/devtools/remote_debugging_server.h',
           ],
@@ -200,6 +202,7 @@
                 'browser/devtools/devtools_file_system_indexer.cc',
                 'browser/devtools/devtools_target_impl.cc',
                 'browser/devtools/devtools_window.cc',
+                'browser/devtools/devtools_window_base.cc',
                 'browser/devtools/remote_debugging_server.cc',
               ],
             }],