Allow the automation provider to accept an ID for performing render-view

chrome/browser/automation/testing_automation_provider.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_BROWSER_AUTOMATION_TESTING_AUTOMATION_PROVIDER_H_
 #define CHROME_BROWSER_AUTOMATION_TESTING_AUTOMATION_PROVIDER_H_
 #pragma once
 
 #include <map>
 #include <string>
@@ skipping 628 matching lines @@
   void InstallExtension(base::DictionaryValue* args,
                         IPC::Message* reply_message);
 
   // Get info about all intalled extensions.
   // Uses the JSON interface for input/output.
   void GetExtensionsInfo(base::DictionaryValue* args,
                          IPC::Message* reply_message);
 
   // Uninstalls the extension with the given id.
   // Uses the JSON interface for input/output.
-  void UninstallExtensionById(Browser* browser,
-                              base::DictionaryValue* args,
+  void UninstallExtensionById(base::DictionaryValue* args,
                               IPC::Message* reply_message);
 
   // Set extension states:
   //   Enable/disable extension.
   //   Allow/disallow extension in incognito mode.
   // Uses the JSON interface for input/output.
-  void SetExtensionStateById(Browser* browser,
-                             base::DictionaryValue* args,
+  void SetExtensionStateById(base::DictionaryValue* args,
                              IPC::Message* reply_message);
 
   // Trigger page action asynchronously in the active tab.
   // Uses the JSON interface for input/output.
   void TriggerPageActionById(base::DictionaryValue* args,
                              IPC::Message* reply_message);
 
   // Trigger browser action asynchronously in the active tab.
   // Uses the JSON interface for input/output.
   void TriggerBrowserActionById(base::DictionaryValue* args,
@@ skipping 214 matching lines @@
   // the handle number assigned by the automation system.
   // Example:
   //   input: { "tab_id": 1,     // optional
   //            "tab_handle": 3  // optional
   //          }
   //   output: { "windex": 1, "tab_index": 5 }
   void GetIndicesFromTab(base::DictionaryValue* args,
                          IPC::Message* reply_message);
 
   // Navigates to the given URL. Uses the JSON interface.
+  // The pair |windex| and |tab_index| or the single |auto_id| must be given
+  // to specify the tab.
   // Example:
   //   input: { "windex": 1,
   //            "tab_index": 3,
+  //            "auto_id": { "type": 0, "id": "awoein" },
   //            "url": "http://www.google.com",
   //            "navigation_count": 1  // number of navigations to wait for
   //          }
   //   output: { "result": AUTOMATION_MSG_NAVIGATION_SUCCESS }
   void NavigateToURL(base::DictionaryValue* args, IPC::Message* reply_message);
 
   // Executes javascript in the specified frame. Uses the JSON interface.
   // Waits for a result from the |DOMAutomationController|. The javascript
   // must send a string.
+  // The pair |windex| and |tab_index| or the single |auto_id| must be given
+  // to specify the tab.
   // Example:
   //   input: { "windex": 1,
   //            "tab_index": 1,
+  //            "auto_id": { "type": 0, "id": "awoein" },
   //            "frame_xpath": "//frames[1]",
   //            "javascript":
   //                "window.domAutomationController.send(window.name)",
   //           }
   //   output: { "result": "My Window Name" }
   // This and some following methods have a suffix of JSON to distingush them
   // from already existing methods which perform the same function, but use
   // custom IPC messages instead of the JSON IPC message. These functions will
   // eventually be replaced with the JSON ones and the JSON suffix will be
   // dropped.
@@ skipping 11 matching lines @@
   //            }
   //            "frame_xpath": "//frames[1]",
   //            "javascript":
   //                "window.domAutomationController.send(window.name)",
   //           }
   //   output: { "result": "My Window Name" }
   void ExecuteJavascriptInRenderView(
       base::DictionaryValue* args, IPC::Message* reply_message);
 
   // Goes forward in the specified tab. Uses the JSON interface.
+  // The pair |windex| and |tab_index| or the single |auto_id| must be given
+  // to specify the tab.
   // Example:
-  //   input: { "windex": 1, "tab_index": 1 }
+  //   input: { "windex": 1,
+  //            "tab_index": 1,
+  //            "auto_id": { "type": 0, "id": "awoein" }
+  //          }
   //   output: { "did_go_forward": true,                      // optional
   //             "result": AUTOMATION_MSG_NAVIGATION_SUCCESS  // optional
   //           }
   void GoForward(base::DictionaryValue* args, IPC::Message* reply_message);
 
   // Goes back in the specified tab. Uses the JSON interface.
+  // The pair |windex| and |tab_index| or the single |auto_id| must be given
+  // to specify the tab.
   // Example:
-  //   input: { "windex": 1, "tab_index": 1 }
+  //   input: { "windex": 1,
+  //            "tab_index": 1,
+  //            "auto_id": { "type": 0, "id": "awoein" }
+  //          }
   //   output: { "did_go_back": true,                         // optional
   //             "result": AUTOMATION_MSG_NAVIGATION_SUCCESS  // optional
   //           }
   void GoBack(base::DictionaryValue* args, IPC::Message* reply_message);
 
   // Reload the specified tab. Uses the JSON interface.
+  // The pair |windex| and |tab_index| or the single |auto_id| must be given
+  // to specify the tab.
   // Example:
-  //   input: { "windex": 1, "tab_index": 1 }
+  //   input: { "windex": 1,
+  //            "tab_index": 1,
+  //            "auto_id": { "type": 0, "id": "awoein" }
+  //          }
   //   output: { "result": AUTOMATION_MSG_NAVIGATION_SUCCESS  // optional }
   void ReloadJSON(base::DictionaryValue* args, IPC::Message* reply_message);
 
-  // Get the current url of the specified tab. Uses the JSON interface.
-  // Example:
-  //   input: { "windex": 1, "tab_index": 1 }
-  //   output: { "url": "http://www.google.com" }
-  void GetTabURLJSON(base::DictionaryValue* args, IPC::Message* reply_message);
-
-  // Get the current url of the specified tab. Uses the JSON interface.
-  // Example:
-  //   input: { "windex": 1, "tab_index": 1 }
-  //   output: { "title": "Google" }
-  void GetTabTitleJSON(base::DictionaryValue* args,
-                       IPC::Message* reply_message);
-
   // Captures the entire page of the the specified tab, including the
   // non-visible portions of the page, and saves the PNG to a file.
+  // The pair |windex| and |tab_index| or the single |auto_id| must be given
+  // to specify the tab.
   // Example:
-  //   input: { "windex": 1, "tab_index": 1, "path":"/tmp/foo.png"}
+  //   input: { "windex": 1,
+  //            "tab_index": 1,
+  //            "auto_id": { "type": 0, "id": "awoein" },
+  //            "path": "/tmp/foo.png"
+  //          }
   //   output: none
   void CaptureEntirePageJSON(
       base::DictionaryValue* args, IPC::Message* reply_message);
 
   // Gets the cookies for the given URL. Uses the JSON interface.
   // "expiry" refers to the amount of seconds since the Unix epoch. If omitted,
   // the cookie is valid for the duration of the browser session.
   // Example:
   //   input: { "url": "http://www.google.com" }
   //   output: { "cookies": [
@@ skipping 40 matching lines @@
   //              "secure": false,              // optional
   //              "expiry": 1401982012          // optional
   //            }
   //          }
   //   output: none
   void SetCookieJSON(base::DictionaryValue* args, IPC::Message* reply_message);
 
   // Gets the ID for every open tab. This ID is unique per session.
   // Example:
   //   input: none
-  //   output: { "ids": [4124, 213, 1] }
+  //   output: { "ids": [213, 1] }
   void GetTabIds(base::DictionaryValue* args, IPC::Message* reply_message);
 
+  // Gets info about all open views. Each view ID is unique per session.
+  // Example:
+  //   input: none
+  //   output: { "views": [
+  //               {
+  //                 "auto_id": { "type": 0, "id": "awoein" },
+  //                 "extension_id": "askjeoias3"  // optional
+  //               }
+  //             ]
+  //           }
+  void GetViews(base::DictionaryValue* args, IPC::Message* reply_message);
+
   // Checks if the given tab ID refers to an open tab.
   // Example:
   //   input: { "id": 41 }
   //   output: { "is_valid": false }
   void IsTabIdValid(base::DictionaryValue* args, IPC::Message* reply_message);
 
+  // Checks if the given automation ID refers to an actual object.
+  // Example:
+  //   input: { "auto_id": { "type": 0, "id": "awoein" } }
+  //   output: { "does_exist": false }
+  void DoesAutomationObjectExist(
+      base::DictionaryValue* args, IPC::Message* reply_message);
+
   // Closes the specified tab.
+  // The pair |windex| and |tab_index| or the single |auto_id| must be given
+  // to specify the tab.
   // Example:
-  //   input: { "windex": 1, "tab_index": 1 }
+  //   input: { "windex": 1,
+  //            "tab_index": 1,
+  //            "auto_id": { "type": 0, "id": "awoein" }
+  //          }
   //   output: none
   void CloseTabJSON(base::DictionaryValue* args, IPC::Message* reply_message);
 
   // Sends the WebKit events for a mouse click at a given coordinate.
+  // The pair |windex| and |tab_index| or the single |auto_id| must be given
+  // to specify the render view.
   // Example:
   //   input: { "windex": 1,
   //            "tab_index": 1,
+  //            "auto_id": { "type": 0, "id": "awoein" },
   //            "button": automation::kLeftButton,
   //            "x": 100,
   //            "y": 100
   //          }
   //   output: none
   void WebkitMouseClick(base::DictionaryValue* args,
                         IPC::Message* message);
 
   // Sends the WebKit event for a mouse move to a given coordinate.
+  // The pair |windex| and |tab_index| or the single |auto_id| must be given
+  // to specify the render view.
   // Example:
   //   input: { "windex": 1,
   //            "tab_index": 1,
+  //            "auto_id": { "type": 0, "id": "awoein" },
   //            "x": 100,
   //            "y": 100
   //          }
   //   output: none
   void WebkitMouseMove(base::DictionaryValue* args,
                        IPC::Message* message);
 
   // Sends the WebKit events for a mouse drag between two coordinates.
+  // The pair |windex| and |tab_index| or the single |auto_id| must be given
+  // to specify the render view.
   // Example:
   //   input: { "windex": 1,
   //            "tab_index": 1,
+  //            "auto_id": { "type": 0, "id": "awoein" },
   //            "start_x": 100,
   //            "start_y": 100,
   //            "end_x": 100,
   //            "end_y": 100
   //          }
   //   output: none
   void WebkitMouseDrag(base::DictionaryValue* args,
                        IPC::Message* message);
 
   // Sends the WebKit events for a mouse button down at a given coordinate.
+  // The pair |windex| and |tab_index| or the single |auto_id| must be given
+  // to specify the render view.
   // Example:
   //   input: { "windex": 1,
   //            "tab_index": 1,
+  //            "auto_id": { "type": 0, "id": "awoein" },
   //            "x": 100,
   //            "y": 100
   //          }
   //   output: none
   void WebkitMouseButtonDown(base::DictionaryValue* args,
                              IPC::Message* message);
 
   // Sends the WebKit events for a mouse button up at a given coordinate.
+  // The pair |windex| and |tab_index| or the single |auto_id| must be given
+  // to specify the render view.
   // Example:
   //   input: { "windex": 1,
   //            "tab_index": 1,
+  //            "auto_id": { "type": 0, "id": "awoein" },
   //            "x": 100,
   //            "y": 100
   //          }
   //   output: none
   void WebkitMouseButtonUp(base::DictionaryValue* args,
                            IPC::Message* message);
 
   // Sends the WebKit events for a mouse double click at a given coordinate.
+  // The pair |windex| and |tab_index| or the single |auto_id| must be given
+  // to specify the render view.
   // Example:
   //   input: { "windex": 1,
   //            "tab_index": 1,
+  //            "auto_id": { "type": 0, "id": "awoein" },
   //            "x": 100,
   //            "y": 100
   //          }
   //   output: none
   void WebkitMouseDoubleClick(base::DictionaryValue* args,
                               IPC::Message* message);
 
   // Drag and drop file paths at a given coordinate.
+  // The pair |windex| and |tab_index| or the single |auto_id| must be given
+  // to specify the render view.
   // Example:
   //   input: { "windex": 1,
   //            "tab_index": 1,
+  //            "auto_id": { "type": 0, "id": "awoein" },
   //            "x": 100,
   //            "y": 100,
   //            "paths": [
   //              "/tmp/file.txt"
   //            ],
   //          }
   //   output: none
   void DragAndDropFilePaths(base::DictionaryValue* args,
                             IPC::Message* message);
 
   // Sends the WebKit key event with the specified properties.
+  // The pair |windex| and |tab_index| or the single |auto_id| must be given
+  // to specify the render view.
   // Example:
   //   input: { "windex": 1,
   //            "tab_index": 1,
+  //            "auto_id": { "type": 0, "id": "awoein" },
   //            "type": automation::kRawKeyDownType,
   //            "nativeKeyCode": ui::VKEY_X,
   //            "windowsKeyCode": ui::VKEY_X,
   //            "unmodifiedText": "x",
   //            "text": "X",
   //            "modifiers": automation::kShiftKeyMask,
   //            "isSystemKey": false
   //          }
   //   output: none
   void SendWebkitKeyEvent(base::DictionaryValue* args,
                           IPC::Message* message);
 
   // Sends the key event from the OS level to the browser window,
   // allowing it to be preprocessed by some external application (ie. IME).
   // Will switch to the tab specified by tab_index before sending the event.
+  // The pair |windex| and |tab_index| or the single |auto_id| must be given
+  // to specify the tab.
   // Example:
   //   input: { "windex": 1,
   //            "tab_index": 1,
+  //            "auto_id": { "type": 0, "id": "awoein" },
   //            "keyCode": ui::VKEY_X,
   //            "modifiers": automation::kShiftKeyMask,
   //          }
   //   output: none
   void SendOSLevelKeyEventToTab(base::DictionaryValue* args,
                                 IPC::Message* message);
 
   // Method used as a Task that sends a success AutomationJSONReply.
   void SendSuccessReply(IPC::Message* reply_message);
 
   // Gets the active JavaScript modal dialog's message.
   // Example:
   //   input: none
   //   output: { "message": "This is an alert!" }
   void GetAppModalDialogMessage(
       base::DictionaryValue* args, IPC::Message* reply_message);
 
   // Accepts or dismisses the active JavaScript modal dialog. If optional
   // prompt text is given, it will be used as the result of the prompt dialog.
   // Example:
   //   input: { "accept": true,
   //            "prompt_text": "hello"  // optional
   //          }
   //   output: none
   void AcceptOrDismissAppModalDialog(
       base::DictionaryValue* args, IPC::Message* reply_message);
 
   // Activates the given tab.
+  // The pair |windex| and |tab_index| or the single |auto_id| must be given
+  // to specify the tab.
   // Example:
   //   input: { "windex": 1,
   //            "tab_index": 1,
+  //            "auto_id": { "type": 0, "id": "awoein" }
   //          }
   //   output: none
   void ActivateTabJSON(base::DictionaryValue* args, IPC::Message* message);
 
   // Gets the version of ChromeDriver automation supported by this server.
   // Example:
   //   input: none
   //   output: { "version": 1 }
   void GetChromeDriverAutomationVersion(base::DictionaryValue* args,
                                         IPC::Message* message);
@@ skipping 222 matching lines @@
   // Used to enumerate browser profiles.
   scoped_refptr<ImporterList> importer_list_;
 
   // The stored data for the ImportSettings operation.
   ImportSettingsData import_settings_data_;
 
   DISALLOW_COPY_AND_ASSIGN(TestingAutomationProvider);
 };
 
 #endif  // CHROME_BROWSER_AUTOMATION_TESTING_AUTOMATION_PROVIDER_H_