Introduce structures to reduce the number of arguments in the FaviconService methods.

chrome/browser/favicon/favicon_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_FAVICON_FAVICON_SERVICE_H_
 #define CHROME_BROWSER_FAVICON_FAVICON_SERVICE_H_
 
 #include <vector>
 
 #include "base/callback.h"
@@ skipping 13 matching lines @@
 //
 // This service is thread safe. Each request callback is invoked in the
 // thread that made the request.
 class FaviconService : public CancelableRequestProvider,
                        public ProfileKeyedService {
  public:
   explicit FaviconService(HistoryService* history_service);
 
   virtual ~FaviconService();
 
+  // Auxiliary argument structure for requesting favicons.

[James Hawkins, 2012/09/05 22:02:58]

Why is this necessary?

[Leandro Graciá Gil, 2012/09/05 22:04:28]

I could remove this case and leave only the URL ones if you prefer. Just wanted
to make the change consistent.

[James Hawkins, 2012/09/05 22:11:49]

Yes, please remove.  The FaviconForURLParams is a temporary solution until we
solve the underlying issue.

+  struct FaviconParams {
+    FaviconParams(const GURL& icon_url,
+                  history::IconType icon_type,
+                  int desired_size_in_dip,
+                  CancelableRequestConsumerBase* consumer)
+        : icon_url(icon_url),
+          icon_type(icon_type),
+          desired_size_in_dip(desired_size_in_dip),
+          consumer(consumer) {
+    }
+
+    GURL icon_url;
+    history::IconType icon_type;
+    int desired_size_in_dip;
+    CancelableRequestConsumerBase* consumer;
+  };
+
+  // Auxiliary argument structure for requesting favicons for URLs.
+  struct FaviconForURLParams {
+    FaviconForURLParams(Profile* profile,
+                        const GURL& page_url,
+                        int icon_types,
+                        int desired_size_in_dip,
+                        CancelableRequestConsumerBase* consumer)
+        : profile(profile),
+          page_url(page_url),
+          icon_types(icon_types),
+          desired_size_in_dip(desired_size_in_dip),
+          consumer(consumer) {
+    }
+
+    Profile* profile;
+    GURL page_url;
+    int icon_types;
+    int desired_size_in_dip;
+    CancelableRequestConsumerBase* consumer;
+  };
+
   // Callback for GetFaviconImage() and GetFaviconImageForURL().
   // |FaviconImageResult::image| is constructed from the bitmaps for the
   // passed in URL and icon types which most which closely match the passed in
   // |desired_size_in_dip| at the scale factors supported by the current
   // platform (eg MacOS).
   // |FaviconImageResult::icon_url| is the favicon that the favicon bitmaps in
   // |image| originate from.
   // TODO(pkotwicz): Enable constructing |image| from bitmaps from several
   // icon URLs.
   typedef base::Callback<void(Handle, const history::FaviconImageResult&)>
@@ skipping 34 matching lines @@
 
   typedef CancelableRequest<FaviconResultsCallback> GetFaviconRequest;
 
   // Requests the favicon at |icon_url| of |icon_type| whose size most closely
   // matches |desired_size_in_dip|. |consumer| is notified when the bits have
   // been fetched. |icon_url| is the URL of the icon itself, e.g.
   // <http://www.google.com/favicon.ico>.
   // Each of the three methods below differs in the format of the callback and
   // the requested scale factors. All of the scale factors supported by the
   // current platform (eg MacOS) are requested for GetFaviconImage().
-  Handle GetFaviconImage(const GURL& icon_url,
-                         history::IconType icon_type,
-                         int desired_size_in_dip,
-                         CancelableRequestConsumerBase* consumer,
+  Handle GetFaviconImage(const FaviconParams& params,
                          const FaviconImageCallback& callback);
 
-  Handle GetRawFavicon(const GURL& icon_url,
-                       history::IconType icon_type,
-                       int desired_size_in_dip,
+  Handle GetRawFavicon(const FaviconParams& params,
                        ui::ScaleFactor desired_scale_factor,
-                       CancelableRequestConsumerBase* consumer,
                        const FaviconRawCallback& callback);
 
-  Handle GetFavicon(const GURL& icon_url,
-                    history::IconType icon_type,
-                    int desired_size_in_dip,
+  Handle GetFavicon(const FaviconParams& params,
                     const std::vector<ui::ScaleFactor>& desired_scale_factors,
-                    CancelableRequestConsumerBase* consumer,
                     const FaviconResultsCallback& callback);
 
   // Fetches the |icon_type| of favicon at |icon_url|, sending the results to
   // the given |callback|. If the favicon has previously been set via
   // SetFavicon(), then the favicon URL for |page_url| and all redirects is set
   // to |icon_url|. If the favicon has not been set, the database is not
   // updated.
   Handle UpdateFaviconMappingAndFetch(const GURL& page_url,
                                       const GURL& icon_url,
                                       history::IconType icon_type,
                                       CancelableRequestConsumerBase* consumer,
                                       const FaviconResultsCallback& callback);
 
   // Requests the favicons of any of |icon_types| whose pixel sizes most
   // closely match |desired_size_in_dip| and desired scale factors for a web
   // page URL. |consumer| is notified when the bits have been fetched.
   // |icon_types| can be any combination of IconType value, but only one icon
   // will be returned in the priority of TOUCH_PRECOMPOSED_ICON, TOUCH_ICON
   // and FAVICON. Each of the three methods below differs in the format of the
   // callback and the requested scale factors. All of the scale factors
   // supported by the current platform (eg MacOS) are requested for
   // GetFaviconImageForURL().
-  Handle GetFaviconImageForURL(Profile* profile,
-                               const GURL& page_url,
-                               int icon_types,
-                               int desired_size_in_dip,
-                               CancelableRequestConsumerBase* consumer,
+  Handle GetFaviconImageForURL(const FaviconForURLParams& params,
                                const FaviconImageCallback& callback);
 
-  Handle GetRawFaviconForURL(Profile* profile,
-                             const GURL& page_url,
-                             int icon_types,
-                             int desired_size_in_dip,
+  Handle GetRawFaviconForURL(const FaviconForURLParams& params,
                              ui::ScaleFactor desired_scale_factor,
-                             CancelableRequestConsumerBase* consumer,
                              const FaviconRawCallback& callback);
 
   Handle GetFaviconForURL(
-      Profile* profile,
-      const GURL& page_url,
-      int icon_types,
-      int desired_size_in_dip,
+      const FaviconForURLParams& params,
       const std::vector<ui::ScaleFactor>& desired_scale_factors,
-      CancelableRequestConsumerBase* consumer,
       const FaviconResultsCallback& callback);
 
   // Requests the favicon for |favicon_id| which most closely matches
   // |desired_size_in_dip| and |desired_scale_factor|. The |consumer| is
   // notified when the bits have been fetched.
   Handle GetRawFaviconForID(history::FaviconID favicon_id,
                             int desired_size_in_dip,
                             ui::ScaleFactor desired_scale_factor,
                             CancelableRequestConsumerBase* consumer,
                             const FaviconRawCallback& callback);
@@ skipping 22 matching lines @@
 
  private:
   HistoryService* history_service_;
 
   // Helper to forward an empty result if we cannot get the history service.
   void ForwardEmptyResultAsync(GetFaviconRequest* request);
 
   // Helper function for GetFaviconImageForURL(), GetRawFaviconForURL() and
   // GetFaviconForURL().
   Handle GetFaviconForURLImpl(
-      Profile* profile,
-      const GURL& page_url,
-      int icon_types,
-      int desired_size_in_dip,
+      const FaviconForURLParams& params,
       const std::vector<ui::ScaleFactor>& desired_scale_factors,
-      CancelableRequestConsumerBase* consumer,
       GetFaviconRequest* request);
 
   // Intermediate callback for GetFaviconImage() and GetFaviconImageForURL()
   // so that history service can deal solely with FaviconResultsCallback.
   // Builds history::FaviconImageResult from |favicon_bitmap_results| and runs
   // |callback|.
   void GetFaviconImageCallback(
       int desired_size_in_dip,
       FaviconImageCallback callback,
       Handle handle,
       std::vector<history::FaviconBitmapResult> favicon_bitmap_results,
       history::IconURLSizesMap icon_url_sizes_map);
 
   // Intermediate callback for GetRawFavicon() and GetRawFaviconForURL()
   // so that history service can deal solely with FaviconResultsCallback.
   // Resizes history::FaviconBitmapResult if necessary and runs |callback|.
   void GetRawFaviconCallback(
       int desired_size_in_dip,
       ui::ScaleFactor desired_scale_factor,
       FaviconRawCallback callback,
       Handle handle,
       std::vector<history::FaviconBitmapResult> favicon_bitmap_results,
       history::IconURLSizesMap icon_url_sizes_map);
 
   DISALLOW_COPY_AND_ASSIGN(FaviconService);
 };
 
 #endif  // CHROME_BROWSER_FAVICON_FAVICON_SERVICE_H_