Introduce GeolocationPermissionRequestID, a wrapper struct to contain the (render process ID, rende…

chrome/browser/geolocation/geolocation_infobar_queue_controller.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_GEOLOCATION_GEOLOCATION_INFOBAR_QUEUE_CONTROLLER_H_
 #define CHROME_BROWSER_GEOLOCATION_GEOLOCATION_INFOBAR_QUEUE_CONTROLLER_H_
 
 #include "base/bind.h"
 #include "content/public/browser/notification_observer.h"
 #include "content/public/browser/notification_registrar.h"
 
 class GURL;
 class GeolocationConfirmInfoBarDelegate;
 class InfoBarTabHelper;
 class Profile;
+namespace content {
+struct GeolocationPermissionRequestID;
+}
 
 // This class controls the geolocation infobar queue per profile, and it's
 // used by GeolocationPermissionContext.
 // An alternate approach would be to have this queue per tab, and use
 // notifications to broadcast when permission is set / listen to notification to
 // cancel pending requests. This may be specially useful if there are other
 // things listening for such notifications.
 // For the time being this class is self-contained and it doesn't seem pulling
 // the notification infrastructure would simplify.
 class GeolocationInfoBarQueueController : content::NotificationObserver {
  public:
   typedef base::Callback<void(bool /* allowed */)> PermissionDecidedCallback;
 
   explicit GeolocationInfoBarQueueController(Profile* profile);
   virtual ~GeolocationInfoBarQueueController();
 
   // The InfoBar will be displayed immediately if the tab is not already
   // displaying one, otherwise it'll be queued.
-  void CreateInfoBarRequest(int render_process_id,
-                            int render_view_id,
-                            int bridge_id,
+  void CreateInfoBarRequest(const content::GeolocationPermissionRequestID& id,
                             const GURL& requesting_frame,
                             const GURL& embedder,
                             PermissionDecidedCallback callback);
 
   // Cancels a specific infobar request.
-  void CancelInfoBarRequest(int render_process_id,
-                            int render_view_id,
-                            int bridge_id);
+  void CancelInfoBarRequest(const content::GeolocationPermissionRequestID& id);
 
   // Called by the InfoBarDelegate to notify permission has been set.
   // It'll notify and dismiss any other pending InfoBar request for the same
   // |requesting_frame| and embedder.
-  void OnPermissionSet(int render_process_id,
-                       int render_view_id,
-                       int bridge_id,
+  void OnPermissionSet(const content::GeolocationPermissionRequestID& id,
                        const GURL& requesting_frame,
                        const GURL& embedder,
                        bool update_content_setting,
                        bool allowed);
 
   // content::NotificationObserver
   virtual void Observe(int type,
                        const content::NotificationSource& source,
                        const content::NotificationDetails& details) OVERRIDE;
 
  protected:
   // Create an Infobar delegate to ask the whether the requesting frame
   // url should be granted geolocation permission. Overrided in
   // derived classes to implement alternative UI.
   virtual GeolocationConfirmInfoBarDelegate* CreateInfoBarDelegate(
       InfoBarTabHelper* infobar_helper,
       GeolocationInfoBarQueueController* controller,
-      int render_process_id,
-      int render_view_id,
-      int bridge_id,
+      const content::GeolocationPermissionRequestID& id,
       const GURL& requesting_frame_url,
       const std::string& display_languages);
 
  private:
   struct PendingInfoBarRequest;
   class RequestEquals;
 
   typedef std::vector<PendingInfoBarRequest> PendingInfoBarRequests;
 
-  // Shows the first pending infobar for this tab, if any.
-  void ShowQueuedInfoBar(int render_process_id, int render_view_id,
-                         InfoBarTabHelper* helper);
+  // Returns true if a geolocation infobar is already visible for the tab
+  // corresponding to |id|.
+  bool AlreadyShowingInfoBarForTab(

[John Knottenbelt, 2012/10/24 10:59:10]

Can you make this method const?

[Peter Kasting, 2012/10/24 19:50:48]

Yes.  Will fix.

+      const content::GeolocationPermissionRequestID& id);
 
-  // Removes any pending requests for a given tab.
-  void ClearPendingInfoBarRequestsForTab(int render_process_id,
-                                         int render_view_id);
+  // Shows the next pending infobar for the tab corresponding to |id|, if any.
+  // Note that this may not be the pending request whose ID is |id| if other
+  // requests are higher in the queue.  Returns whether an infobar was shown.
+  bool ShowQueuedInfoBarForTab(
+      const content::GeolocationPermissionRequestID& id);
 
-  InfoBarTabHelper* GetInfoBarHelper(int render_process_id, int render_view_id);
-  bool AlreadyShowingInfoBar(int render_process_id, int render_view_id);
+  void ClearPendingInfoBarRequestsForTab(
+      const content::GeolocationPermissionRequestID& id);
+
+  InfoBarTabHelper* GetInfoBarHelper(
+      const content::GeolocationPermissionRequestID& id);
 
   void RegisterForInfoBarNotifications(InfoBarTabHelper* helper);
   void UnregisterForInfoBarNotifications(InfoBarTabHelper* helper);
 
   content::NotificationRegistrar registrar_;
 
   Profile* const profile_;
   PendingInfoBarRequests pending_infobar_requests_;
 };
 
 #endif  // CHROME_BROWSER_GEOLOCATION_GEOLOCATION_INFOBAR_QUEUE_CONTROLLER_H_