Simplify ExecuteJavaScript* functions.

content/public/test/browser_test_utils.h

 // Copyright (c) 2012 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 CONTENT_PUBLIC_TEST_BROWSER_TEST_UTILS_H_
 #define CONTENT_PUBLIC_TEST_BROWSER_TEST_UTILS_H_
 
 #include <queue>
 #include <string>
 #include <vector>
@@ skipping 60 matching lines @@
                         const gfx::Point& point);
 
 // Sends a key press asynchronously.
 void SimulateKeyPress(WebContents* web_contents,
                       ui::KeyboardCode key,
                       bool control,
                       bool shift,
                       bool alt,
                       bool command);
 
+// Allow ExecuteScript* methods to target either a WebContents or a
+// RenderViewHost.  Targetting a WebContents means executing script in the
+// RenderViewHost returned by WebContents::GetRenderViewHost(), which is the
+// "current" RenderViewHost.  Pass a specific RenderViewHost to target, for
+// example, a "swapped-out" RenderViewHost.
+namespace internal {
+class ToRenderViewHost {
+ public:
+  ToRenderViewHost(WebContents* web_contents);
+  ToRenderViewHost(RenderViewHost* render_view_host);
+
+  RenderViewHost* render_view_host() const { return render_view_host_; }
+
+ private:
+  RenderViewHost* render_view_host_;
+};
+}  // namespace internal
+
 // Executes the passed |script| in the frame pointed to by |frame_xpath| (use
 // empty string for main frame).  The |script| should not invoke
 // domAutomationController.send(); otherwise, your test will hang or be flaky.
 // If you want to extract a result, use one of the below functions.
 // Returns true on success.
-bool ExecuteJavaScript(RenderViewHost* render_view_host,
-                       const std::string& frame_xpath,
-                       const std::string& script) WARN_UNUSED_RESULT;
+bool ExecuteScriptInFrame(const internal::ToRenderViewHost& adapter,
+                          const std::string& frame_xpath,
+                          const std::string& script) WARN_UNUSED_RESULT;
 
 // The following methods executes the passed |script| in the frame pointed to by
 // |frame_xpath| (use empty string for main frame) and sets |result| to the
-// value returned by the script evaluation.
-// They return true on success, false if the script evaluation failed or did not
+// value passed to "window.domAutomationController.send" by the executed script.
+// They return true on success, false if the script execution failed or did not
 // evaluate to the expected type.
-bool ExecuteJavaScriptAndExtractInt(RenderViewHost* render_view_host,
-                                    const std::string& frame_xpath,
-                                    const std::string& script,
-                                    int* result) WARN_UNUSED_RESULT;
-bool ExecuteJavaScriptAndExtractBool(RenderViewHost* render_view_host,
-                                     const std::string& frame_xpath,
-                                     const std::string& script,
-                                     bool* result) WARN_UNUSED_RESULT;
-bool ExecuteJavaScriptAndExtractString(
-    RenderViewHost* render_view_host,
+bool ExecuteScriptInFrameAndExtractInt(
+    const internal::ToRenderViewHost& adapter,
+    const std::string& frame_xpath,
+    const std::string& script,
+    int* result) WARN_UNUSED_RESULT;
+bool ExecuteScriptInFrameAndExtractBool(
+    const internal::ToRenderViewHost& adapter,
+    const std::string& frame_xpath,
+    const std::string& script,
+    bool* result) WARN_UNUSED_RESULT;
+bool ExecuteScriptInFrameAndExtractString(
+    const internal::ToRenderViewHost& adapter,
     const std::string& frame_xpath,
     const std::string& script,
     std::string* result) WARN_UNUSED_RESULT;
 
+// Top-frame script execution helpers (a.k.a., the common case):
+bool ExecuteScript(const internal::ToRenderViewHost& adapter,
+                   const std::string& script) WARN_UNUSED_RESULT;
+bool ExecuteScriptAndExtractInt(const internal::ToRenderViewHost& adapter,
+                                const std::string& script,
+                                int* result) WARN_UNUSED_RESULT;
+bool ExecuteScriptAndExtractBool(const internal::ToRenderViewHost& adapter,
+                                 const std::string& script,
+                                 bool* result) WARN_UNUSED_RESULT;
+bool ExecuteScriptAndExtractString(const internal::ToRenderViewHost& adapter,
+                                   const std::string& script,
+                                   std::string* result) WARN_UNUSED_RESULT;
+
 // Returns the cookies for the given url.
 std::string GetCookies(BrowserContext* browser_context, const GURL& url);
 
 // Sets a cookie for the given url. Returns true on success.
 bool SetCookie(BrowserContext* browser_context,
                const GURL& url,
                const std::string& value);
 
 // Watches title changes on a tab, blocking until an expected title is set.
 class TitleWatcher : public NotificationObserver {
@@ skipping 60 matching lines @@
   std::queue<std::string> message_queue_;
   bool waiting_for_message_;
   scoped_refptr<MessageLoopRunner> message_loop_runner_;
 
   DISALLOW_COPY_AND_ASSIGN(DOMMessageQueue);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_PUBLIC_TEST_BROWSER_TEST_UTILS_H_