Allow chromedriver to install an extension and get all installed extension IDs.

chrome/test/automation/automation_json_requests.h

 // Copyright (c) 2011 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_TEST_AUTOMATION_AUTOMATION_JSON_REQUESTS_H_
 #define CHROME_TEST_AUTOMATION_AUTOMATION_JSON_REQUESTS_H_
 #pragma once
 
 #include <string>
 #include <vector>
 
 #include "base/compiler_specific.h"
 #include "base/file_path.h"
+#include "chrome/browser/automation/automation_provider_json.h"
 #include "chrome/common/automation_constants.h"
 #include "ui/base/keycodes/keyboard_codes.h"
 
 class AutomationMessageSender;
 class FilePath;
 
 namespace base {
 class DictionaryValue;
 class ListValue;
 class Value;
 }
 
 struct WebKeyEvent {
   WebKeyEvent(automation::KeyEventTypes type,
               ui::KeyboardCode key_code,
               const std::string& unmodified_text,
               const std::string& modified_text,
               int modifiers);
 
   automation::KeyEventTypes type;
   ui::KeyboardCode key_code;
   std::string unmodified_text;
   std::string modified_text;
   int modifiers;
 };
 
+struct WebViewLocator {
+  enum Type {
+    kTypeIndexPair = 0,
+    kTypeViewId,
+  };
+  struct IndexPair {
+    int browser_index;
+    int tab_index;
+  };
+  struct Locator {
+    Locator() { }
+    ~Locator() { }
+
+    IndexPair index_pair;
+    AutomationId view_id;
+  };
+
+  WebViewLocator(){}
+  ~WebViewLocator(){}
+  void UpdateDictionary(base::DictionaryValue* dict) const;
+
+  Type type;
+  Locator locator;
+};
+
+struct WebViewId {
+  enum Type {
+    kTypeTabId = 0,
+    kTypeViewId,
+    kMaxTypes
+  };
+  struct Id {
+    Id() { }
+    ~Id() { }
+
+    int tab_id;
+    AutomationId view_id;
+  };
+
+  static WebViewId ForTab(int tab_id) {
+    WebViewId id;
+    id.type = kTypeTabId;
+    id.id.tab_id = tab_id;
+    return id;
+  }
+
+  static WebViewId ForView(const AutomationId& view_id) {
+    WebViewId id;
+    id.type = kTypeViewId;
+    id.id.view_id = view_id;
+    return id;
+  }
+
+  WebViewId() { }
+  ~WebViewId() {}
+  bool IsValid() const {
+    if (type == kTypeTabId) {
+      return id.tab_id != 0;
+    }
+    if (type == kTypeViewId) {
+      return id.view_id.is_valid();
+    }
+    return false;
+  }
+  void UpdateDictionary(base::DictionaryValue* dictionary) const;
+
+  Type type;
+  Id id;
+};
+
+struct WebViewInfo {
+  WebViewInfo(AutomationId::Type type,
+              const WebViewId& view_id,
+              const std::string& extension_id);
+  ~WebViewInfo();
+
+  AutomationId::Type type;
+  WebViewId view_id;
+  std::string extension_id;
+};
+
 // Sends a JSON request to the chrome automation provider. Returns true
 // if the JSON request was successfully sent and the reply was received.
 // If true, |success| will be set to whether the JSON request was
 // completed successfully by the automation provider.
 bool SendAutomationJSONRequest(AutomationMessageSender* sender,
                                const std::string& request,
                                int timeout_ms,
                                std::string* reply,
                                bool* success) WARN_UNUSED_RESULT;
 
@@ skipping 32 matching lines @@
     const std::string& url,
     int navigation_count,
     AutomationMsg_NavigationResponseValues* nav_response,
     std::string* error_msg) WARN_UNUSED_RESULT;
 
 // Requests the given javascript to be executed in the frame specified by the
 // given xpath. Returns true on success. If true, |result| will be set to the
 // result of the execution and ownership will be given to the caller.
 bool SendExecuteJavascriptJSONRequest(
     AutomationMessageSender* sender,
-    int browser_index,
-    int tab_index,
+    const WebViewLocator& locator,
     const std::string& frame_xpath,
     const std::string& javascript,
     base::Value** result,
     std::string* error_msg) WARN_UNUSED_RESULT;
 
 // Requests the specified tab to go forward. Waits for the load to complete.
 // Returns true on success.
 bool SendGoForwardJSONRequest(
     AutomationMessageSender* sender,
     int browser_index,
@@ skipping 19 matching lines @@
 // Requests a snapshot of the entire page to be saved to the given path
 // in PNG format.
 // Returns true on success.
 bool SendCaptureEntirePageJSONRequest(
     AutomationMessageSender* sender,
     int browser_index,
     int tab_index,
     const FilePath& path,
     std::string* error_msg) WARN_UNUSED_RESULT;
 
-// Requests the url of the specified tab. Returns true on success.
-bool SendGetTabURLJSONRequest(
-    AutomationMessageSender* sender,
-    int browser_index,
-    int tab_index,
-    std::string* url,
-    std::string* error_msg) WARN_UNUSED_RESULT;
-
-// Requests the title of the specified tab. Returns true on success.
-bool SendGetTabTitleJSONRequest(
-    AutomationMessageSender* sender,
-    int browser_index,
-    int tab_index,
-    std::string* tab_title,
-    std::string* error_msg) WARN_UNUSED_RESULT;
-
 // Requests all the cookies for the given URL. On success returns true and
 // caller takes ownership of |cookies|, which is a list of all the cookies in
 // dictionary format.
 bool SendGetCookiesJSONRequest(
     AutomationMessageSender* sender,
     const std::string& url,
     base::ListValue** cookies,
     std::string* error_msg) WARN_UNUSED_RESULT;
 
 // Requests deletion of the cookie with the given name and URL. Returns true
 // on success.
 bool SendDeleteCookieJSONRequest(
     AutomationMessageSender* sender,
     const std::string& url,
     const std::string& cookie_name,
     std::string* error_msg) WARN_UNUSED_RESULT;
 
 // Requests setting the given cookie for the given URL. Returns true on
 // success. The caller retains ownership of |cookie_dict|.
 bool SendSetCookieJSONRequest(
     AutomationMessageSender* sender,
     const std::string& url,
     base::DictionaryValue* cookie_dict,
     std::string* error_msg) WARN_UNUSED_RESULT;
 
 // Requests the IDs for all open tabs. Returns true on success.
 bool SendGetTabIdsJSONRequest(
     AutomationMessageSender* sender,
-    std::vector<int>* tab_ids,
+    std::vector<WebViewInfo>* views,
+    std::string* error_msg) WARN_UNUSED_RESULT;
+
+// Requests info for all open views. Returns true on success.
+bool SendGetWebViewsJSONRequest(
+    AutomationMessageSender* sender,
+    std::vector<WebViewInfo>* views,
     std::string* error_msg) WARN_UNUSED_RESULT;
 
 // Requests whether the given tab ID is valid. Returns true on success.
 bool SendIsTabIdValidJSONRequest(
     AutomationMessageSender* sender,
-    int tab_id,
+    const WebViewId& view_id,
     bool* is_valid,
     std::string* error_msg) WARN_UNUSED_RESULT;
 
+// Requests whether the given view ID is valid. Returns true on success.
+bool SendDoesViewExistJSONRequest(
+    AutomationMessageSender* sender,
+    const WebViewId& view_id,
+    bool* does_exist,
+    std::string* error_msg) WARN_UNUSED_RESULT;
+
 // Requests to close the given tab. Returns true on success.
 bool SendCloseTabJSONRequest(
     AutomationMessageSender* sender,
     int browser_index,
     int tab_index,
     std::string* error_msg) WARN_UNUSED_RESULT;
 
 // Requests to send the WebKit event for a mouse move to the given
 // coordinate in the specified tab. Returns true on success.
 bool SendMouseMoveJSONRequest(
     AutomationMessageSender* sender,
-    int browser_index,
-    int tab_index,
+    const WebViewLocator& locator,
     int x,
     int y,
     std::string* error_msg) WARN_UNUSED_RESULT;
 
 // Requests to send the WebKit events for a mouse click at the given
 // coordinate in the specified tab. Returns true on success.
 bool SendMouseClickJSONRequest(
     AutomationMessageSender* sender,
-    int browser_index,
-    int tab_index,
+    const WebViewLocator& locator,
     automation::MouseButton button,
     int x,
     int y,
     std::string* error_msg) WARN_UNUSED_RESULT;
 
 // Requests to send the WebKit events for a mouse drag from the start to end
 // coordinates given in the specified tab. Returns true on success.
 bool SendMouseDragJSONRequest(
     AutomationMessageSender* sender,
-    int browser_index,
-    int tab_index,
+    const WebViewLocator& locator,
     int start_x,
     int start_y,
     int end_x,
     int end_y,
     std::string* error_msg) WARN_UNUSED_RESULT;
 
 // Requests to send the WebKit event for a mouse button down at the given
 // coordinate in the specified tab. Returns true on success.
 bool SendMouseButtonDownJSONRequest(
     AutomationMessageSender* sender,
-    int browser_index,
-    int tab_index,
+    const WebViewLocator& locator,
     int x,
     int y,
     std::string* error_msg) WARN_UNUSED_RESULT;
 
 // Requests to send the WebKit event for a mouse button up at the given
 // coordinate in the specified tab. Returns true on success.
 bool SendMouseButtonUpJSONRequest(
     AutomationMessageSender* sender,
-    int browser_index,
-    int tab_index,
+    const WebViewLocator& locator,
     int x,
     int y,
     std::string* error_msg) WARN_UNUSED_RESULT;
 
 // Requests to send the WebKit event for a mouse double click at the given
 // coordinate in the specified tab. Returns true on success.
 bool SendMouseDoubleClickJSONRequest(
     AutomationMessageSender* sender,
-    int browser_index,
-    int tab_index,
+    const WebViewLocator& locator,
     int x,
     int y,
     std::string* error_msg) WARN_UNUSED_RESULT;
 
 // Requests to send the WebKit event for the given |WebKeyEvent| in a
 // specified tab. Returns true on success.
 bool SendWebKeyEventJSONRequest(
     AutomationMessageSender* sender,
-    int browser_index,
-    int tab_index,
+    const WebViewLocator& locator,
     const WebKeyEvent& key_event,
     std::string* error_msg) WARN_UNUSED_RESULT;
 
 // Requests to send the key event for the given keycode+modifiers to a
 // browser window containing the specified tab. Returns true on success.
 bool SendNativeKeyEventJSONRequest(
     AutomationMessageSender* sender,
     int browser_index,
     int tab_index,
     ui::KeyboardCode key_code,
     int modifiers,
     std::string* error_msg) WARN_UNUSED_RESULT;
 
 // Requests to drag and drop the file paths at the given coordinate in the
 // specified tab. Returns true on success.
 bool SendDragAndDropFilePathsJSONRequest(
     AutomationMessageSender* sender,
-    int browser_index,
-    int tab_index,
+    const WebViewLocator& locator,
     int x,
     int y,
     const std::vector<FilePath::StringType>& paths,
     std::string* error_msg) WARN_UNUSED_RESULT;
 
 // Requests to get the active JavaScript modal dialog's message. Returns true
 // on success.
 bool SendGetAppModalDialogMessageJSONRequest(
     AutomationMessageSender* sender,
     std::string* message,
@@ skipping 34 matching lines @@
 // Requests that the given extension be installed. If |with_ui| is false,
 // the extension will be installed silently. Returns true on success.
 bool SendInstallExtensionJSONRequest(
     AutomationMessageSender* sender,
     const FilePath& path,
     bool with_ui,
     std::string* extension_id,
     std::string* error_msg) WARN_UNUSED_RESULT;
 
 #endif  // CHROME_TEST_AUTOMATION_AUTOMATION_JSON_REQUESTS_H_