Implementation of AutomationEventQueue and associated framework to support generic non-blocking aut…

chrome/browser/automation/testing_automation_provider.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 CHROME_BROWSER_AUTOMATION_TESTING_AUTOMATION_PROVIDER_H_
 #define CHROME_BROWSER_AUTOMATION_TESTING_AUTOMATION_PROVIDER_H_
 #pragma once
 
 #include <map>
 #include <string>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/compiler_specific.h"
 #include "base/memory/scoped_ptr.h"
+#include "chrome/browser/automation/automation_event_observer.h"
+#include "chrome/browser/automation/automation_event_queue.h"
 #include "chrome/browser/automation/automation_provider.h"
 #include "chrome/browser/automation/automation_provider_json.h"
 #include "chrome/browser/history/history.h"
 #include "chrome/browser/importer/importer_list_observer.h"
 #include "chrome/browser/sync/profile_sync_service_harness.h"
 #include "chrome/browser/ui/browser_list.h"
 #include "content/public/browser/notification_registrar.h"
 #include "content/public/common/page_type.h"
 #include "content/public/common/security_style.h"
 #include "net/base/cert_status_flags.h"
@@ skipping 911 matching lines @@
   //   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.
   // TODO(kkania): Replace the non-JSON counterparts and drop the JSON suffix.
   void ExecuteJavascriptJSON(
       base::DictionaryValue* args, IPC::Message* reply_message);
 
+  // Creates a DomRaisedEventObserver associated with the AutomationEventQueue.
+  // Example:
+  //   input: { "event_name": "login complete",
+  //            "windex": 1,
+  //            "tab_index": 1,
+  //            "frame_xpath": "//frames[1]",
+  //          }
+  //   output: { "observer_id": 1 }
+  void AddDomRaisedEventObserver(
+      base::DictionaryValue* args, IPC::Message* reply_message);
+
+  // Removes an event observer associated with the AutomationEventQueue.
+  // Example:
+  //   input: { "observer_id": 1 }
+  //   output: none
+  void RemoveEventObserver(
+      base::DictionaryValue* args, IPC::Message* reply_message);
+
+  // Retrieves an event from the AutomationEventQueue.
+  // Blocks if 'blocking' is true, otherwise returns immediately.
+  // Example:
+  //   input: { "observer_id": 1,
+  //            "blocking": true,
+  //          }
+  //   output: { "type": "raised",
+  //             "name": "login complete"
+  //             "id": 1,
+  //           }
+  void GetNextEvent(base::DictionaryValue* args, IPC::Message* reply_message);
+
+  // Removes all events and observers attached to the AutomationEventQueue.
+  // Example:
+  //   input: none
+  //   output: none
+  void ClearEventQueue(
+      base::DictionaryValue* args, IPC::Message* reply_message);
+
   // Executes javascript in the specified frame of a render view.
   // Uses the JSON interface. Waits for a result from the
   // |DOMAutomationController|. The javascript must send a string.
   // Example:
   //   input: { "view": {
   //              "render_process_id": 1,
   //              "render_view_id": 2,
   //            }
   //            "frame_xpath": "//frames[1]",
   //            "javascript":
@@ skipping 599 matching lines @@
   HistoryService::Handle redirect_query_;
 
   content::NotificationRegistrar registrar_;
 
   // Used to enumerate browser profiles.
   scoped_refptr<ImporterList> importer_list_;
 
   // The stored data for the ImportSettings operation.
   ImportSettingsData import_settings_data_;
 
+  // The automation event observer queue. It is lazily created when an observer
+  // is added to avoid overhead when not needed.
+  scoped_ptr<AutomationEventQueue> automation_event_queue_;
+
   DISALLOW_COPY_AND_ASSIGN(TestingAutomationProvider);
 };
 
 #endif  // CHROME_BROWSER_AUTOMATION_TESTING_AUTOMATION_PROVIDER_H_