Listen for tab close notifications and cancel active speech sessions.

chrome/browser/speech/speech_input_bubble_controller.h

 // Copyright (c) 2010 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_SPEECH_SPEECH_INPUT_BUBBLE_CONTROLLER_H_
 #define CHROME_BROWSER_SPEECH_SPEECH_INPUT_BUBBLE_CONTROLLER_H_
 
 #include <map>
 
 #include "base/basictypes.h"
 #include "base/ref_counted.h"
 #include "base/scoped_ptr.h"
 #include "chrome/browser/speech/speech_input_bubble.h"
+#include "chrome/common/notification_observer.h"
 
 namespace gfx {
 class Rect;
 }
+class NotificationRegistrar;
 
 namespace speech_input {
 
 // This class handles the speech input popup UI on behalf of SpeechInputManager.
 // SpeechInputManager invokes methods in the IO thread and this class processes
 // those requests in the UI thread. There could be multiple bubble objects alive
 // at the same time but only one of them is visible to the user. User actions on
 // that bubble are reported to the delegate.
 class SpeechInputBubbleController
     : public base::RefCountedThreadSafe<SpeechInputBubbleController>,
-      public SpeechInputBubbleDelegate {
+      public SpeechInputBubbleDelegate,
+      public NotificationObserver {
  public:
   // All methods of this delegate are called in the IO thread.
   class Delegate {
    public:
     // Invoked when the user clicks on a button in the speech input UI.
     virtual void InfoBubbleButtonClicked(int caller_id,
                                          SpeechInputBubble::Button button) = 0;
 
     // Invoked when the user clicks outside the speech input info bubble causing
     // it to close and input focus to change.
@@ skipping 27 matching lines @@
 
   // Updates the current captured audio volume displayed on screen.
   void SetBubbleInputVolume(int caller_id, float volume);
 
   void CloseBubble(int caller_id);
 
   // SpeechInputBubble::Delegate methods.
   virtual void InfoBubbleButtonClicked(SpeechInputBubble::Button button);
   virtual void InfoBubbleFocusChanged();
 
+  // NotificationObserver implementation.
+  virtual void Observe(NotificationType type,
+                       const NotificationSource& source,
+                       const NotificationDetails& details);
+
  private:
   // The various calls received by this object and handled in the UI thread.
   enum RequestType {
     REQUEST_SET_RECORDING_MODE,
     REQUEST_SET_RECOGNIZING_MODE,
     REQUEST_SET_MESSAGE,
     REQUEST_SET_INPUT_VOLUME,
     REQUEST_CLOSE,
   };
 
+  enum ManageSubscriptionAction {
+    BUBBLE_ADDED,
+    BUBBLE_REMOVED
+  };
+
   void InvokeDelegateButtonClicked(int caller_id,
                                    SpeechInputBubble::Button button);
   void InvokeDelegateFocusChanged(int caller_id);
   void ProcessRequestInUiThread(int caller_id,
                                 RequestType type,
                                 const string16& text,
                                 float volume);
 
+  // Called whenever a bubble was added to or removed from the list. If the
+  // bubble was being added, this method registers for close notifications with
+  // the TabContents if this was the first bubble for the tab. Similarly if the
+  // bubble was being removed, this method unregisters from TabContents if this
+  // was the last bubble associated with that tab.
+  void UpdateTabContentsSubscription(int caller_id,
+                                     ManageSubscriptionAction action);
+
+  // Whether the given bubble (IDed by caller_id) is the only one in our list
+  // linked to that TabContents. Returns false if there are more such bubbles
+  // in our list.
+  bool IsOnlyBubbleForTab(int caller_id);

[bulach, 2011/01/06 14:31:44]

remove?

[Satish, 2011/01/07 10:57:34]

Done.

+
   // Only accessed in the IO thread.
   Delegate* delegate_;
 
   //*** The following are accessed only in the UI thread.
 
   // The caller id for currently visible bubble (since only one bubble is
   // visible at any time).
   int current_bubble_caller_id_;
 
   // Map of caller-ids to bubble objects. The bubbles are weak pointers owned by
   // this object and get destroyed by |CloseBubble|.
-  std::map<int, SpeechInputBubble*> bubbles_;
+  typedef std::map<int, SpeechInputBubble*> BubbleCallerIdMap;
+  BubbleCallerIdMap bubbles_;
+
+  scoped_ptr<NotificationRegistrar> registrar_;
 };
 
 // This typedef is to workaround the issue with certain versions of
 // Visual Studio where it gets confused between multiple Delegate
 // classes and gives a C2500 error. (I saw this error on the try bots -
 // the workaround was not needed for my machine).
 typedef SpeechInputBubbleController::Delegate
     SpeechInputBubbleControllerDelegate;
 
 }  // namespace speech_input
 
 #endif  // CHROME_BROWSER_SPEECH_SPEECH_INPUT_BUBBLE_CONTROLLER_H_