Add BubbleManager to manage bubbles and ChromeBubbleManager for events.

chrome/browser/ui/website_settings/permission_bubble_manager.h

 // Copyright 2014 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_UI_WEBSITE_SETTINGS_PERMISSION_BUBBLE_MANAGER_H_
 #define CHROME_BROWSER_UI_WEBSITE_SETTINGS_PERMISSION_BUBBLE_MANAGER_H_
 
 #include <vector>
 
 #include "base/gtest_prod_util.h"
 #include "base/memory/weak_ptr.h"
 #include "base/observer_list.h"
-#include "chrome/browser/ui/website_settings/permission_bubble_view.h"
+#include "components/bubble/bubble_manager.h"
 #include "content/public/browser/web_contents_observer.h"
 #include "content/public/browser/web_contents_user_data.h"
 
+class BubbleManager;
 class PermissionBubbleRequest;
 
+// TODO(hcarmona): Rename to PermissionRequestQueue or PermissionRequestManager.
+
 // Provides access to permissions bubbles. Allows clients to add a request
 // callback interface to the existing permission bubble configuration.
 // Depending on the situation and policy, that may add new UI to an existing
 // permission bubble, create and show a new permission bubble, or provide no
 // visible UI action at all. (In that case, the request will be immediately
 // informed that the permission request failed.)
 //
 // A PermissionBubbleManager is associated with a particular WebContents.
 // Requests attached to a particular WebContents' PBM must outlive it.
 //
 // The PermissionBubbleManager should be addressed on the UI thread.
 class PermissionBubbleManager
     : public content::WebContentsObserver,
-      public content::WebContentsUserData<PermissionBubbleManager>,
-      public PermissionBubbleView::Delegate {
+      public content::WebContentsUserData<PermissionBubbleManager> {
  public:
   class Observer {
    public:
     virtual ~Observer();
     virtual void OnBubbleAdded();
   };
 
   enum AutoResponseType {
     NONE,
     ACCEPT_ALL,
@@ skipping 17 matching lines @@
 
   // Cancels an outstanding request. This may have different effects depending
   // on what is going on with the bubble. If the request is pending, it will be
   // removed and never shown. If the request is showing, it will continue to be
   // shown, but the user's action won't be reported back to the request object.
   // In some circumstances, we can remove the request from the bubble, and may
   // do so. The request will have RequestFinished executed on it if it is found,
   // at which time the caller is free to delete the request.
   virtual void CancelRequest(PermissionBubbleRequest* request);
 
-  // Hides the bubble.
-  void HideBubble();
-
-  // Will show a permission bubble if there is a pending permission request on
-  // the web contents that the PermissionBubbleManager belongs to.
-  void DisplayPendingRequests(Browser* browser);
-
-  // Will reposition the bubble (may change parent if necessary).
-  void UpdateAnchorPosition();
-
-  // True if a permission bubble is currently visible.
-  // TODO(hcarmona): Remove this as part of the bubble API work.
-  bool IsBubbleVisible();
-
-  // Get the native window of the bubble.
-  // TODO(hcarmona): Remove this as part of the bubble API work.
-  gfx::NativeWindow GetBubbleWindow();
-
   // Controls whether incoming permission requests require user gestures.
   // If |required| is false, requests will be displayed as soon as they come in.
   // If |required| is true, requests will be silently queued until a request
   // comes in with a user gesture.
   void RequireUserGesture(bool required);
 
   // For observing the status of the permission bubble manager.
   void AddObserver(Observer* observer);
   void RemoveObserver(Observer* observer);
 
   // Do NOT use this methods in production code. Use this methods in browser
   // tests that need to accept or deny permissions when requested in
   // JavaScript. Your test needs to set this appropriately, and then the bubble
   // will proceed as desired as soon as Show() is called.
   void set_auto_response_for_test(AutoResponseType response) {
     auto_response_for_test_ = response;
   }
 
+  const std::vector<PermissionBubbleRequest*>& requests() const {
+    return requests_;
+  }
+
+  const std::vector<bool>& accept_states() const { return accept_states_; }
+
+  void ToggleAccept(int request_index, bool new_value);
+  void Accept();
+  void Deny();
+  void Closing();
+
+  // Finalize the pending permissions. Called after the bubble is closed.
+  void DidClose();
+
  private:
   // TODO(felt): Update testing so that it doesn't involve a lot of friends.
   friend class DownloadRequestLimiterTest;
   friend class GeolocationBrowserTest;
   friend class GeolocationPermissionContextTests;
   friend class MockPermissionBubbleView;
   friend class PermissionBubbleManagerTest;
   friend class PermissionContextBaseTests;
   friend class content::WebContentsUserData<PermissionBubbleManager>;
   FRIEND_TEST_ALL_PREFIXES(DownloadTest, TestMultipleDownloadsBubble);
 
   explicit PermissionBubbleManager(content::WebContents* web_contents);
 
   // WebContentsObserver:
   void DidNavigateMainFrame(
       const content::LoadCommittedDetails& details,
       const content::FrameNavigateParams& params) override;
   void DocumentOnLoadCompletedInMainFrame() override;
   void DocumentLoadedInFrame(
       content::RenderFrameHost* render_frame_host) override;
 
   // If a page on which permissions requests are pending is navigated,
   // they will be finalized as if canceled by the user.

[msw, 2015/08/13 03:37:21]

Is simulating cancellation by the user really necessary? (perhaps this could be
removed and left to the BubbleManager)

-  void NavigationEntryCommitted(
-      const content::LoadCommittedDetails& details) override;
   void WebContentsDestroyed() override;
 
-  // PermissionBubbleView::Delegate:
-  void ToggleAccept(int request_index, bool new_value) override;
-  void Accept() override;
-  void Deny() override;
-  void Closing() override;
-
-  // Posts a task which will allow the bubble to become visible if it is needed.
   void ScheduleShowBubble();
 
   // Shows the bubble if it is not already visible and there are pending
   // requests.
   void TriggerShowBubble();
 
-  // Finalize the pending permissions request.
-  void FinalizeBubble();
+  // Closes the bubble.

[msw, 2015/08/13 03:37:21]

comment not necessary.

+  void CloseBubble();
 
   // Cancel any pending requests. This is called if the WebContents
   // on which permissions calls are pending is destroyed or navigated away
   // from the requesting page.
   void CancelPendingQueues();
 
   // Returns whether or not |request| has already been added to |queue|.
   // |same_object| must be non-null.  It will be set to true if |request|
   // is the same object as an existing request in |queue|, false otherwise.
   bool ExistingRequest(PermissionBubbleRequest* request,
                        const std::vector<PermissionBubbleRequest*>& queue,
                        bool* same_object);
 
   // Returns true if |queue| contains a request which was generated by a user
   // gesture.  Returns false otherwise.
   bool HasUserGestureRequest(
       const std::vector<PermissionBubbleRequest*>& queue);
 
+  BubbleManager* GetBubbleManager();
+
   void NotifyBubbleAdded();
 
   void DoAutoResponseForTesting();
 
+  // True if a permission bubble is currently visible.
+  bool IsBubbleVisible();
+
   // Whether to delay displaying the bubble until a request with a user gesture.
   // False by default, unless RequireUserGesture(bool) changes the value.
   bool require_user_gesture_;
 
   // Factory to be used to create views when needed.
-  PermissionBubbleView::Factory view_factory_;
-
-  // The UI surface to be used to display the permissions requests.
-  scoped_ptr<PermissionBubbleView> view_;
+  // TODO(hcarmona): Investigate not using a factory, currently used for tests.
+  base::Callback<scoped_ptr<BubbleUI>(PermissionBubbleManager*)> ui_factory_;
+  BubbleReference active_bubble_;
 
   std::vector<PermissionBubbleRequest*> requests_;
   std::vector<PermissionBubbleRequest*> queued_requests_;
   std::vector<PermissionBubbleRequest*> queued_frame_requests_;
 
   // URL of the main frame in the WebContents to which this manager is attached.
   // TODO(gbillock): if there are iframes in the page, we need to deal with it.
   GURL request_url_;
   bool main_frame_has_fully_loaded_;
 
   std::vector<bool> accept_states_;
 
   base::ObserverList<Observer> observer_list_;
   AutoResponseType auto_response_for_test_;
 
   base::WeakPtrFactory<PermissionBubbleManager> weak_factory_;
+
+  DISALLOW_COPY_AND_ASSIGN(PermissionBubbleManager);
 };
 
 #endif  // CHROME_BROWSER_UI_WEBSITE_SETTINGS_PERMISSION_BUBBLE_MANAGER_H_