[Icons NTP] Refactor large_icon_source to extract the logic shared between desktop and Android to f…

components/favicon/core/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 COMPONENTS_FAVICON_CORE_FAVICON_SERVICE_H_
 #define COMPONENTS_FAVICON_CORE_FAVICON_SERVICE_H_
 
 #include <vector>
 
 #include "base/callback.h"
@@ skipping 102 matching lines @@
       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,
+      int minimum_size_in_pixel,
       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);
 
+  // Requests the best large icon for the page at |page_url| given the requested
+  // |desired_size_in_pixel|. If no good large icon can be found, return the

[huangs, 2015/04/17 03:55:17]

NIT: return --> returns

[beaudoin, 2015/04/17 14:50:52]

Done.

+  // dominant color of a smaller icon, if available.
+  base::CancelableTaskTracker::TaskId getLargeIcon(

[huangs, 2015/04/17 03:55:17]

NIT: Should capitalize => GetLargeIcon(); also fix in comments.

Perhaps rename to GetLargeIconOrDominantColor()?

[beaudoin, 2015/04/17 14:50:52]

Done.

+    const GURL& pageURL,

[huangs, 2015/04/17 03:55:17]

NIT: pageURL --> page_url

[beaudoin, 2015/04/17 14:50:52]

Done.

+    int desired_size_in_pixel,
+    const favicon_base::LargeIconCallback& 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 }
@@ skipping 89 matching lines @@
   // 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);
 
+  // Intermediate callback for getLargeIcon(). Ensures the large icon is the

[huangs, 2015/04/17 03:55:17]

NIT: GetLargeIcon()

[beaudoin, 2015/04/17 14:50:52]

Done.

+  // desired size, if not extract the dominant color and use this for invoking
+  // |callback|.
+  void RunLargeIconCallback(
+      const favicon_base::LargeIconCallback& callback,
+      int desired_size_in_pixel,
+      const favicon_base::FaviconRawBitmapResult& bitmap_result);
+
   base::hash_set<MissingFaviconURLHash> missing_favicon_urls_;
   history::HistoryService* history_service_;
   FaviconClient* favicon_client_;
 
+  // A pre-populated list of the types of icon files to consider when looking
+  // for large icons. Note: this is simply an optimization over populating an
+  // icon type vector on each request.
+  std::vector<int> large_icon_types_;
+
   DISALLOW_COPY_AND_ASSIGN(FaviconService);
 };
 
 }  // namespace favicon
 
 #endif  // COMPONENTS_FAVICON_CORE_FAVICON_SERVICE_H_