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

chrome/browser/automation/automation_event_queue.h

Index: chrome/browser/automation/automation_event_queue.h
diff --git a/chrome/browser/automation/automation_event_queue.h b/chrome/browser/automation/automation_event_queue.h
new file mode 100644
index 0000000000000000000000000000000000000000..f138c2ecd101b88817e8156d18c2732d871a70b3
--- /dev/null
+++ b/chrome/browser/automation/automation_event_queue.h
@@ -0,0 +1,74 @@
+// 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_AUTOMATION_EVENT_QUEUE_H_
+#define CHROME_BROWSER_AUTOMATION_AUTOMATION_EVENT_QUEUE_H_
+
+#include <list>
+#include <map>
+
+#include "base/memory/scoped_ptr.h"
+#include "base/values.h"
+
+class AutomationEventObserver;
+class AutomationJSONReply;
+
+// AutomationEventQueue maintains a queue of unhandled automation events.
+class AutomationEventQueue {
+ public:
+  AutomationEventQueue();
+  virtual ~AutomationEventQueue();
+
+  // AutomationEvent stores return data dictionay for a single event.
+  class AutomationEvent {
+   public:
+    AutomationEvent(int observer_id, DictionaryValue* event_value);
+    virtual ~AutomationEvent() {}
+
+    int GetId() const { return observer_id_; }
+    DictionaryValue* GetValue() { return event_value_.get(); }
+    DictionaryValue* ReleaseValue() { return event_value_.release(); }
+
+   private:
+    int observer_id_;
+    scoped_ptr<DictionaryValue> event_value_;
+  };
+
+  void GetNextEvent(AutomationJSONReply* reply,
+                    int observer_id,
+                    bool blocking);
+  void NotifyEvent(AutomationEvent* event);
+  void Clear();
+  bool IsEmpty() const;
+  AutomationEvent* PopEvent();
+  AutomationEvent* PopEvent(int observer_id);
+
+  int AddObserver(AutomationEventObserver* observer);
+  bool RemoveObserver(int observer_id);
+
+ private:
+  class CompareEventId {
+   public:
+    explicit CompareEventId(int id);
+    bool operator()(AutomationEvent* event) const;
+
+   private:
+    int id_;
+  };
+
+  void ClearEvents();
+  void ClearObservers();
+  bool CheckReturnEvent();
+
+  std::list<AutomationEvent*> event_queue_;
+  std::map<int, AutomationEventObserver*> observers_;
+  int observer_id_count_;
+
+  scoped_ptr<AutomationJSONReply> wait_automation_reply_;

[Nirnimesh, 2012/03/01 10:34:12]

Add comment describing what these are for

[craigdh, 2012/03/01 21:34:18]

Done.

+  int wait_observer_id_;
+
+  DISALLOW_COPY_AND_ASSIGN(AutomationEventQueue);
+};
+
+#endif  // CHROME_BROWSER_AUTOMATION_AUTOMATION_EVENT_QUEUE_H_