Speech Recognition API: Safeguarding against page closes during startup

chrome/browser/speech/speech_recognition_bubble.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_SPEECH_SPEECH_RECOGNITION_BUBBLE_H_
 #define CHROME_BROWSER_SPEECH_SPEECH_RECOGNITION_BUBBLE_H_
 
 #include <vector>
 
 #include "base/memory/scoped_ptr.h"
@@ skipping 37 matching lines @@
     // The InfoBubble window is no longer visible on screen and the caller can
     // free the InfoBubble instance. This callback is not issued if the bubble
     // got closed because the object was destroyed by the caller.
     virtual void InfoBubbleFocusChanged() = 0;
 
    protected:
     virtual ~Delegate() {
     }
   };
 
-  // Factory method to create new instances.
+  // Factory methods to create new instances.
   // Creates the bubble, call |Show| to display it on screen.
+
   // |web_contents| is the WebContents hosting the page.
   // |element_rect| is the display bounds of the html element requesting speech
   // recognition (in page coordinates).
-  static SpeechRecognitionBubble* Create(content::WebContents* web_contents,
-                                         Delegate* delegate,
-                                         const gfx::Rect& element_rect);
-
-  // This is implemented by platform specific code to create the underlying
-  // bubble window. Not to be called directly by users of this class.
-  static SpeechRecognitionBubble* CreateNativeBubble(
-      content::WebContents* web_contents,
+  // This should ONLY be called from for tests

[sky, 2014/02/12 18:12:18]

Isn't there a way to make the tests go through the same Create? I don't like
double the functions like this.

+  static SpeechRecognitionBubble* Create(
+      content::WebContents*,
       Delegate* delegate,
       const gfx::Rect& element_rect);
 
+  // |render_process_id| and |render_view_id| is used to extract the
+  // correct WebContents.
+  // |element_rect| is the display bounds of the html element requesting speech
+  // recognition (in page coordinates).
+  static SpeechRecognitionBubble* Create(
+      int render_process_id,
+      int render_view_id,
+      Delegate* delegate,
+      const gfx::Rect& element_rect);
+
+  // These are implemented by platform specific code to create the underlying
+  // bubble window. Not to be called directly by users of this class.
+  static SpeechRecognitionBubble* CreateNativeBubble(
+      content::WebContents*,
+      Delegate* delegate,
+      const gfx::Rect& element_rect);
+  static SpeechRecognitionBubble* CreateNativeBubble(
+      int render_process_id,
+      int render_view_id,
+      Delegate* delegate,
+      const gfx::Rect& element_rect);
+
   // |Create| uses the currently registered FactoryMethod to create the
   // SpeechRecognitionBubble instances. FactoryMethod is intended for testing.
   typedef SpeechRecognitionBubble* (*FactoryMethod)(content::WebContents*,
                                                     Delegate*,
                                                     const gfx::Rect&);
   // Sets the factory used by the static method Create. SpeechRecognitionBubble
   // does not take ownership of |factory|. A value of NULL results in a
   // SpeechRecognitionBubble being created directly.
 #if defined(UNIT_TEST)
   static void set_factory(FactoryMethod factory) { factory_ = factory; }
@@ skipping 44 matching lines @@
  public:
   // The current display mode of the bubble, useful only for the platform
   // specific implementation.
   enum DisplayMode {
     DISPLAY_MODE_WARM_UP,
     DISPLAY_MODE_RECORDING,
     DISPLAY_MODE_RECOGNIZING,
     DISPLAY_MODE_MESSAGE
   };
 
-  explicit SpeechRecognitionBubbleBase(content::WebContents* web_contents);
+  // Only for tests
+  explicit SpeechRecognitionBubbleBase(content::WebContents* test_web_contents);
+
+  SpeechRecognitionBubbleBase(int render_process_id, int render_view_id);
   virtual ~SpeechRecognitionBubbleBase();
 
   // SpeechRecognitionBubble methods
   virtual void SetWarmUpMode() OVERRIDE;
   virtual void SetRecordingMode() OVERRIDE;
   virtual void SetRecognizingMode() OVERRIDE;
   virtual void SetMessage(const base::string16& text) OVERRIDE;
   virtual void SetInputVolume(float volume, float noise_volume) OVERRIDE;
   virtual content::WebContents* GetWebContents() OVERRIDE;
 
  protected:
   // Updates the platform specific UI layout for the current display mode.
   virtual void UpdateLayout() = 0;
 
   // Overridden by subclasses to copy |icon_image()| to the screen.
   virtual void UpdateImage() = 0;
 
   DisplayMode display_mode() const { return display_mode_; }
 
   const base::string16& message_text() const { return message_text_; }
 
   gfx::ImageSkia icon_image();
 
  private:
+  void Initialize();
+
   void DoRecognizingAnimationStep();
   void DoWarmingUpAnimationStep();
   void SetImage(const gfx::ImageSkia& image);
 
   void DrawVolumeOverlay(SkCanvas* canvas,
                          const gfx::ImageSkia& image_skia,
                          float volume);
 
   // Task factory used for animation timer.
   base::WeakPtrFactory<SpeechRecognitionBubbleBase> weak_factory_;
   int animation_step_;  // Current index/step of the animation.
 
   DisplayMode display_mode_;
   base::string16 message_text_;  // Text displayed in DISPLAY_MODE_MESSAGE
 
   // The current microphone image with volume level indication.
   scoped_ptr<SkBitmap> mic_image_;
   // A temporary buffer image used in creating the above mic image.
   scoped_ptr<SkBitmap> buffer_image_;
+
   // WebContents in which this this bubble gets displayed.
-  content::WebContents* web_contents_;
+  content::WebContents* test_web_contents_;
+  int render_process_id_;
+  int render_view_id_;
+
   // The current image displayed in the bubble's icon widget.
   gfx::ImageSkia icon_image_;
   // The scale factor used for the web-contents.
   float scale_;
 
   DISALLOW_COPY_AND_ASSIGN(SpeechRecognitionBubbleBase);
 };
 
 // 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 SpeechRecognitionBubble::Delegate SpeechRecognitionBubbleDelegate;
 
 #endif  // CHROME_BROWSER_SPEECH_SPEECH_RECOGNITION_BUBBLE_H_