Infobar system refactor.

chrome/browser/infobars/infobar_service.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_INFOBARS_INFOBAR_SERVICE_H_
 #define CHROME_BROWSER_INFOBARS_INFOBAR_SERVICE_H_
 
 #include <vector>
 
 #include "base/memory/scoped_ptr.h"
 #include "content/public/browser/notification_observer.h"
 #include "content/public/browser/notification_registrar.h"
 #include "content/public/browser/web_contents_observer.h"
 #include "content/public/browser/web_contents_user_data.h"
 
-class InfoBarDelegate;
+class InfoBar;
 
 // Provides access to creating, removing and enumerating info bars
 // attached to a tab.
 class InfoBarService : public content::WebContentsObserver,
                        public content::NotificationObserver,
                        public content::WebContentsUserData<InfoBarService> {
  public:
   // Changes whether infobars are enabled.  The default is true.
   void set_infobars_enabled(bool enabled) { infobars_enabled_ = enabled; }
 
-  // Adds an InfoBar for the specified |delegate|.
+  // Adds the specified |infobar|, which already owns a delegate.
   //
-  // If infobars are disabled for this tab or the tab already has a delegate
-  // which returns true for InfoBarDelegate::EqualsDelegate(delegate),
-  // |delegate| is closed immediately without being added.
+  // If infobars are disabled for this tab or the tab already has an infobar
+  // whose delegate returns true for
+  // InfoBarDelegate::EqualsDelegate(infobar->delegate()), |infobar| is deleted
+  // immediately without being added.
   //
-  // Returns the delegate if it was successfully added.
-  InfoBarDelegate* AddInfoBar(scoped_ptr<InfoBarDelegate> infobar);
+  // Returns the infobar if it was successfully added.
+  virtual InfoBar* AddInfoBar(scoped_ptr<InfoBar> infobar);
 
-  // Removes the InfoBar for the specified |delegate|.
+  // Removes the specified |infobar|.  This in turn may close immediately or
+  // animate closed; at the end the infobar will delete itself.
   //
   // If infobars are disabled for this tab, this will do nothing, on the
-  // assumption that the matching AddInfoBar() call will have already closed the
-  // delegate (see above).
-  void RemoveInfoBar(InfoBarDelegate* infobar);
+  // assumption that the matching AddInfoBar() call will have already deleted
+  // the infobar (see above).
+  void RemoveInfoBar(InfoBar* infobar);
 
-  // Replaces one infobar with another, without any animation in between.
+  // Replaces one infobar with another, without any animation in between.  This
+  // will result in |old_infobar| being synchronously deleted.
   //
-  // If infobars are disabled for this tab, |new_delegate| is closed immediately
+  // If infobars are disabled for this tab, |new_infobar| is deleted immediately
   // without being added, and nothing else happens.
   //
-  // Returns the new delegate if it was successfully added.
+  // Returns the new infobar if it was successfully added.
   //
   // NOTE: This does not perform any EqualsDelegate() checks like AddInfoBar().
-  InfoBarDelegate* ReplaceInfoBar(InfoBarDelegate* old_infobar,
-                                  scoped_ptr<InfoBarDelegate> new_infobar);
+  InfoBar* ReplaceInfoBar(InfoBar* old_infobar,
+                          scoped_ptr<InfoBar> new_infobar);
 
   // Returns the number of infobars for this tab.
   size_t infobar_count() const { return infobars_.size(); }
 
   // Returns the infobar at the given |index|.  The InfoBarService retains
   // ownership.
   //
   // Warning: Does not sanity check |index|.
-  InfoBarDelegate* infobar_at(size_t index) { return infobars_[index]; }
+  InfoBar* infobar_at(size_t index) { return infobars_[index]; }
 
   // Retrieve the WebContents for the tab this service is associated with.
   content::WebContents* web_contents() {
     return content::WebContentsObserver::web_contents();
   }
 
  private:
   friend class content::WebContentsUserData<InfoBarService>;
 
-  typedef std::vector<InfoBarDelegate*> InfoBars;
+  // InfoBars associated with this InfoBarService.  We own these pointers.
+  // However, this is not a ScopedVector, because we don't delete the infobars
+  // directly once they've been added to this; instead, when we're done with an
+  // infobar, we instruct it to delete itself and then orphan it.  See
+  // RemoveInfoBarInternal().
+  typedef std::vector<InfoBar*> InfoBars;
 
-  // Delegates for InfoBars associated with this InfoBarService.  We do not own
-  // these pointers; they own themselves and are deleted in response to being
-  // closed.
-  // TODO(pkasting): These leak if closed while not visible.
   explicit InfoBarService(content::WebContents* web_contents);
   virtual ~InfoBarService();
 
   // content::WebContentsObserver:
   virtual void RenderProcessGone(base::TerminationStatus status) OVERRIDE;
   virtual bool OnMessageReceived(const IPC::Message& message) OVERRIDE;
 
   // content::NotificationObserver:
   virtual void Observe(int type,
                        const content::NotificationSource& source,
                        const content::NotificationDetails& details) OVERRIDE;
 
-  void RemoveInfoBarInternal(InfoBarDelegate* infobar, bool animate);
+  void RemoveInfoBarInternal(InfoBar* infobar, bool animate);
   void RemoveAllInfoBars(bool animate);
 
   // Message handlers.
   void OnDidBlockDisplayingInsecureContent();
   void OnDidBlockRunningInsecureContent();
 
   InfoBars infobars_;
   bool infobars_enabled_;
 
   content::NotificationRegistrar registrar_;
 
   DISALLOW_COPY_AND_ASSIGN(InfoBarService);
 };
 
 #endif  // CHROME_BROWSER_INFOBARS_INFOBAR_SERVICE_H_