[Refactor] Change FaviconService API to take in a desired pixel size

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"
 #include "base/containers/hash_tables.h"
 #include "base/memory/ref_counted.h"
 #include "base/task/cancelable_task_tracker.h"
 #include "components/favicon_base/favicon_callback.h"
 #include "components/favicon_base/favicon_types.h"
 #include "components/keyed_service/core/keyed_service.h"
 
 class FaviconClient;
 class GURL;
 class HistoryService;
 struct ImportedFaviconUsage;
 class Profile;
 
 // The favicon service provides methods to access favicons. It calls the history
-// backend behind the scenes.
+// backend behind the scenes. The callbacks are run asynchronously, even in the
+// case of an error.
 class FaviconService : public KeyedService {
  public:
   // TODO(jif): Remove usage of Profile. http://crbug.com/378208.
   // The FaviconClient must outlive the constructed FaviconService.
   FaviconService(Profile* profile, FaviconClient* favicon_client);
 
   virtual ~FaviconService();
 
-  // Auxiliary argument structure for requesting favicons for URLs.
-  struct FaviconForPageURLParams {
-    FaviconForPageURLParams(const GURL& page_url,
-                            int icon_types,
-                            int desired_size_in_dip)
-        : page_url(page_url),
-          icon_types(icon_types),
-          desired_size_in_dip(desired_size_in_dip) {}
-
-    GURL page_url;
-    int icon_types;
-    int desired_size_in_dip;
-  };
-
   // We usually pass parameters with pointer to avoid copy. This function is a
   // helper to run FaviconResultsCallback with pointer parameters.
   static void FaviconResultsCallbackRunner(
       const favicon_base::FaviconResultsCallback& callback,
       const std::vector<favicon_base::FaviconRawBitmapResult>* results);
 
-  // The first argument of |callback| is a |const FaviconImageResult&|. Of which
-  // |FaviconImageResult::image| is constructed from the bitmaps for the
-  // passed in URL and icon types which most wich closely match the passed in
-  // |desired_size_in_dip| at the resource scale factors supported by the
-  // current platform (eg MacOS) in addition to 1x.
-  // |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.
+  //////////////////////////////////////////////////////////////////////////////
+  // Methods to request favicon bitmaps from the history backend for |icon_url|.
+  // |icon_url| is the URL of the icon itself.
+  // (e.g. <http://www.google.com/favicon.ico>)
 
-  // Requests the favicon at |icon_url| of |icon_type| whose size most closely
-  // matches |desired_size_in_dip|. If |desired_size_in_dip| is 0, the largest
-  // favicon bitmap at |icon_url| is returned. |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 scales. All of the resource scale factors supported by the
-  // current platform (eg MacOS) are requested for GetFaviconImage().
+  // Requests the favicon at |icon_url| of type favicon_base::FAVICON and of
+  // size gfx::kFaviconSize. The returned gfx::Image is populated with
+  // representations for all of the scale factors supported by the platform
+  // (e.g. MacOS). If data is unavailable for some or all of the scale factors,
+  // the bitmaps with the best matching sizes are resized.
   base::CancelableTaskTracker::TaskId GetFaviconImage(
       const GURL& icon_url,
-      favicon_base::IconType icon_type,
-      int desired_size_in_dip,
       const favicon_base::FaviconImageCallback& callback,
       base::CancelableTaskTracker* tracker);
 
+  // Requests the favicon at |icon_url| of |icon_type| of size
+  // |desired_size_in_pixel|. If there is no favicon of size
+  // |desired_size_in_pixel|, the favicon bitmap which best matches
+  // |desired_size_in_pixel| is resized. If |desired_size_in_pixel| is 0,
+  // the largest favicon bitmap is returned.
   base::CancelableTaskTracker::TaskId GetRawFavicon(
       const GURL& icon_url,
       favicon_base::IconType icon_type,
-      int desired_size_in_dip,
-      float desired_favicon_scale,
+      int desired_size_in_pixel,
       const favicon_base::FaviconRawBitmapCallback& callback,
       base::CancelableTaskTracker* tracker);
 
   // The first argument for |callback| is the set of bitmaps for the passed in
   // URL and icon types whose pixel sizes best match the passed in
   // |desired_size_in_dip| at the resource scale factors supported by the
   // current platform (eg MacOS) in addition to 1x. The vector has at most one
   // result for each of the resource scale factors. There are less entries if a
   // single/ result is the best bitmap to use for several resource scale
   // factors.
   base::CancelableTaskTracker::TaskId GetFavicon(
       const GURL& icon_url,
       favicon_base::IconType icon_type,
       int desired_size_in_dip,
       const favicon_base::FaviconResultsCallback& callback,
       base::CancelableTaskTracker* tracker);
 
+  //////////////////////////////////////////////////////////////////////////////
+  // Methods to request favicon bitmaps from the history backend for |page_url|.
+  // |page_url| is the web page the favicon is associated with.
+  // (e.g. <http://www.google.com>)
+
+  // Requests the favicon for the page at |page_url| of type
+  // favicon_base::FAVICON and of size gfx::kFaviconSize. The returned
+  // gfx::Image is populated with representations for all of the scale factors
+  // supported by the platform (e.g. MacOS). If data is unavailable for some or
+  // all of the scale factors, the bitmaps with the best matching sizes are
+  // resized.
+  base::CancelableTaskTracker::TaskId GetFaviconImageForPageURL(
+      const GURL& page_url,
+      const favicon_base::FaviconImageCallback& callback,
+      base::CancelableTaskTracker* tracker);
+
+  // Requests the favicon for the page at |page_url| with one of |icon_types|
+  // and with |desired_size_in_pixel|. |icon_types| can be any combination of
+  // IconTypes. If favicon bitmaps for several IconTypes are available, the
+  // favicon bitmap is chosen in the priority of TOUCH_PRECOMPOSED_ICON,
+  // TOUCH_ICON and FAVICON. If there is no favicon bitmap of size
+  // |desired_size_in_pixel|, the favicon bitmap which best matches
+  // |desired_size_in_pixel| is resized. If |desired_size_in_pixel| is 0,
+  // the largest favicon bitmap is returned. Results with a higher priority
+  // IconType are preferred over an exact match of the favicon bitmap size.
+  base::CancelableTaskTracker::TaskId GetRawFaviconForPageURL(
+      const GURL& page_url,
+      int icon_types,
+      int desired_size_in_pixel,
+      const favicon_base::FaviconRawBitmapCallback& callback,
+      base::CancelableTaskTracker* tracker);
+
+  // See HistoryService::GetLargestFaviconForPageURL().
+  base::CancelableTaskTracker::TaskId GetLargestRawFaviconForPageURL(
+      const GURL& page_url,
+      const std::vector<int>& icon_types,
+      int minimum_size_in_pixels,
+      const favicon_base::FaviconRawBitmapCallback& callback,
+      base::CancelableTaskTracker* tracker);
+
+  base::CancelableTaskTracker::TaskId GetFaviconForPageURL(
+      const GURL& page_url,
+      int icon_types,
+      int desired_size_in_dip,
+      const favicon_base::FaviconResultsCallback& callback,
+      base::CancelableTaskTracker* tracker);
+
   // Set the favicon mappings to |page_url| for |icon_types| in the history
   // database.
   // Sample |icon_urls|:
   //  { ICON_URL1 -> TOUCH_ICON, known to the database,
   //    ICON_URL2 -> TOUCH_ICON, not known to the database,
   //    ICON_URL3 -> TOUCH_PRECOMPOSED_ICON, known to the database }
   // The new mappings are computed from |icon_urls| with these rules:
   // 1) Any urls in |icon_urls| which are not already known to the database are
   //    rejected.
   //    Sample new mappings to |page_url|: { ICON_URL1, ICON_URL3 }
   // 2) If |icon_types| has multiple types, the mappings are only set for the
   //    largest icon type.
   //    Sample new mappings to |page_url|: { ICON_URL3 }
   // |icon_types| can only have multiple IconTypes if
   // |icon_types| == TOUCH_ICON | TOUCH_PRECOMPOSED_ICON.
   // The favicon bitmaps which most closely match |desired_size_in_dip|
   // at the reosurce scale factors supported by the current platform (eg MacOS)
   // in addition to 1x from the favicons which were just mapped to |page_url|
   // are returned. If |desired_size_in_dip| is 0, the largest favicon bitmap is
   // returned.
   base::CancelableTaskTracker::TaskId UpdateFaviconMappingsAndFetch(
       const GURL& page_url,
       const std::vector<GURL>& icon_urls,
       int icon_types,
       int desired_size_in_dip,
       const favicon_base::FaviconResultsCallback& callback,
       base::CancelableTaskTracker* tracker);
 
-  // Requests the favicons of any of |icon_types| whose pixel sizes most
-  // closely match |desired_size_in_dip| and desired scale for a web
-  // page URL. If |desired_size_in_dip| is 0, the largest favicon for the web
-  // page URL is returned. |callback| is run 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 scales. All of the resource scale factors
-  // supported by the current platform (eg MacOS) are requested for
-  // GetFaviconImageForPageURL().
-  // Note. |callback| is always run asynchronously.
-  base::CancelableTaskTracker::TaskId GetFaviconImageForPageURL(
-      const FaviconForPageURLParams& params,
-      const favicon_base::FaviconImageCallback& callback,
-      base::CancelableTaskTracker* tracker);
-
-  base::CancelableTaskTracker::TaskId GetRawFaviconForPageURL(
-      const FaviconForPageURLParams& params,
-      float desired_favicon_scale,
-      const favicon_base::FaviconRawBitmapCallback& callback,
-      base::CancelableTaskTracker* tracker);
-
-  // See HistoryService::GetLargestFaviconForPageURL().
-  base::CancelableTaskTracker::TaskId GetLargestRawFaviconForPageURL(
-      const GURL& page_url,
-      const std::vector<int>& icon_types,
-      int minimum_size_in_pixels,
-      const favicon_base::FaviconRawBitmapCallback& callback,
-      base::CancelableTaskTracker* tracker);
-
-  base::CancelableTaskTracker::TaskId GetFaviconForPageURL(
-      const FaviconForPageURLParams& params,
-      const favicon_base::FaviconResultsCallback& callback,
-      base::CancelableTaskTracker* tracker);
-
   // Used to request a bitmap for the favicon with |favicon_id| which is not
   // resized from the size it is stored at in the database. If there are
   // multiple favicon bitmaps for |favicon_id|, the largest favicon bitmap is
   // returned.
   base::CancelableTaskTracker::TaskId GetLargestRawFaviconForID(
       favicon_base::FaviconID favicon_id,
       const favicon_base::FaviconRawBitmapCallback& callback,
       base::CancelableTaskTracker* tracker);
 
   // Marks all types of favicon for the page as being out of date.
@@ skipping 46 matching lines @@
  private:
   typedef uint32 MissingFaviconURLHash;
   base::hash_set<MissingFaviconURLHash> missing_favicon_urls_;
   HistoryService* history_service_;
   Profile* profile_;
   FaviconClient* favicon_client_;
 
   // Helper function for GetFaviconImageForPageURL(), GetRawFaviconForPageURL()
   // and GetFaviconForPageURL().
   base::CancelableTaskTracker::TaskId GetFaviconForPageURLImpl(
-      const FaviconForPageURLParams& params,
+      const GURL& page_url,
+      int icon_types,
       const std::vector<int>& desired_sizes_in_pixel,
       const favicon_base::FaviconResultsCallback& callback,
       base::CancelableTaskTracker* tracker);
 
   // Intermediate callback for GetFaviconImage() and GetFaviconImageForPageURL()
   // so that history service can deal solely with FaviconResultsCallback.
   // Builds favicon_base::FaviconImageResult from |favicon_bitmap_results| and
   // runs |callback|.
   void RunFaviconImageCallbackWithBitmapResults(
       const favicon_base::FaviconImageCallback& callback,
       int desired_size_in_dip,
       const std::vector<favicon_base::FaviconRawBitmapResult>&
           favicon_bitmap_results);
 
   // Intermediate callback for GetRawFavicon() and GetRawFaviconForPageURL()
   // so that history service can deal solely with FaviconResultsCallback.
   // Resizes favicon_base::FaviconRawBitmapResult if necessary and runs
   // |callback|.
   void RunFaviconRawBitmapCallbackWithBitmapResults(
       const favicon_base::FaviconRawBitmapCallback& callback,
       int desired_size_in_pixel,
       const std::vector<favicon_base::FaviconRawBitmapResult>&
           favicon_bitmap_results);
 
   DISALLOW_COPY_AND_ASSIGN(FaviconService);
 };
 
 #endif  // CHROME_BROWSER_FAVICON_FAVICON_SERVICE_H_