Rename FaviconBitmapXxx to FaviconRawBitmapXxx

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 12 matching lines @@
 
 // The favicon service provides methods to access favicons. It calls the history
 // backend behind the scenes.
 class FaviconService : public KeyedService {
  public:
   explicit FaviconService(Profile* profile);
 
   virtual ~FaviconService();
 
   // Auxiliary argument structure for requesting favicons for URLs.
-  struct FaviconForURLParams {
-    FaviconForURLParams(const GURL& page_url,
-                        int icon_types,
-                        int desired_size_in_dip)
+  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::FaviconBitmapResult>* results);
+      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 which closely match the passed in
   // |desired_size_in_dip| at the 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.
@@ skipping 11 matching lines @@
       favicon_base::IconType icon_type,
       int desired_size_in_dip,
       const favicon_base::FaviconImageCallback& callback,
       base::CancelableTaskTracker* tracker);
 
   base::CancelableTaskTracker::TaskId GetRawFavicon(
       const GURL& icon_url,
       favicon_base::IconType icon_type,
       int desired_size_in_dip,
       ui::ScaleFactor desired_scale_factor,
-      const favicon_base::FaviconRawCallback& callback,
+      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 scale factors supported by the current
   // platform (eg MacOS) in addition to 1x. The vector has at most one result
   // for each of the scale factors. There are less entries if a single result
   // is the best bitmap to use for several scale factors.
   base::CancelableTaskTracker::TaskId GetFavicon(
       const GURL& icon_url,
@@ skipping 32 matching lines @@
 
   // 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. 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 scale factors. All of the scale factors
   // supported by the current platform (eg MacOS) are requested for
-  // GetFaviconImageForURL().
+  // GetFaviconImageForPageURL().
   // Note. |callback| is always run asynchronously.
-  base::CancelableTaskTracker::TaskId GetFaviconImageForURL(
-      const FaviconForURLParams& params,
+  base::CancelableTaskTracker::TaskId GetFaviconImageForPageURL(
+      const FaviconForPageURLParams& params,
       const favicon_base::FaviconImageCallback& callback,
       base::CancelableTaskTracker* tracker);
 
-  base::CancelableTaskTracker::TaskId GetRawFaviconForURL(
-      const FaviconForURLParams& params,
+  base::CancelableTaskTracker::TaskId GetRawFaviconForPageURL(
+      const FaviconForPageURLParams& params,
       ui::ScaleFactor desired_scale_factor,
-      const favicon_base::FaviconRawCallback& callback,
+      const favicon_base::FaviconRawBitmapCallback& callback,
       base::CancelableTaskTracker* tracker);
 
-  // See HistoryService::GetLargestFaviconForURL().
-  base::CancelableTaskTracker::TaskId GetLargestRawFaviconForURL(
+  // See HistoryService::GetLargestFaviconForPageURL().
+  base::CancelableTaskTracker::TaskId GetLargestRawFaviconForPageURL(
       Profile* profile,
       const GURL& page_url,
       const std::vector<int>& icon_types,
       int minimum_size_in_pixels,
-      const favicon_base::FaviconRawCallback& callback,
+      const favicon_base::FaviconRawBitmapCallback& callback,
       base::CancelableTaskTracker* tracker);
 
-  base::CancelableTaskTracker::TaskId GetFaviconForURL(
-      const FaviconForURLParams& params,
+  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::FaviconRawCallback& callback,
+      const favicon_base::FaviconRawBitmapCallback& callback,
       base::CancelableTaskTracker* tracker);
 
   // Marks all types of favicon for the page as being out of date.
   void SetFaviconOutOfDateForPage(const GURL& page_url);
 
   // Clones all icons from an existing page. This associates the icons from
   // |old_page_url| with |new_page_url|, provided |new_page_url| has no
   // recorded associations to any other icons.
   // Needed if you want to declare favicons (tentatively) in advance, before a
   // page is ever visited.
@@ skipping 35 matching lines @@
   void UnableToDownloadFavicon(const GURL& icon_url);
   bool WasUnableToDownloadFavicon(const GURL& icon_url) const;
   void ClearUnableToDownloadFavicons();
 
  private:
   typedef uint32 MissingFaviconURLHash;
   base::hash_set<MissingFaviconURLHash> missing_favicon_urls_;
   HistoryService* history_service_;
   Profile* profile_;
 
-  // Helper function for GetFaviconImageForURL(), GetRawFaviconForURL() and
-  // GetFaviconForURL().
-  base::CancelableTaskTracker::TaskId GetFaviconForURLImpl(
-      const FaviconForURLParams& params,
+  // Helper function for GetFaviconImageForPageURL(), GetRawFaviconForPageURL()
+  // and GetFaviconForPageURL().
+  base::CancelableTaskTracker::TaskId GetFaviconForPageURLImpl(
+      const FaviconForPageURLParams& params,
       const std::vector<ui::ScaleFactor>& desired_scale_factors,
       const favicon_base::FaviconResultsCallback& callback,
       base::CancelableTaskTracker* tracker);
 
-  // Intermediate callback for GetFaviconImage() and GetFaviconImageForURL()
+  // 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|.
+  // runs |callback|.
   void RunFaviconImageCallbackWithBitmapResults(
-      const  favicon_base::FaviconImageCallback& callback,
+      const favicon_base::FaviconImageCallback& callback,
       int desired_size_in_dip,
-      const std::vector<favicon_base::FaviconBitmapResult>&
+      const std::vector<favicon_base::FaviconRawBitmapResult>&
           favicon_bitmap_results);
 
-  // Intermediate callback for GetRawFavicon() and GetRawFaviconForURL()
+  // Intermediate callback for GetRawFavicon() and GetRawFaviconForPageURL()
   // so that history service can deal solely with FaviconResultsCallback.
-  // Resizes favicon_base::FaviconBitmapResult if necessary and runs |callback|.
-  void RunFaviconRawCallbackWithBitmapResults(
-      const  favicon_base::FaviconRawCallback& callback,
+  // Resizes favicon_base::FaviconRawBitmapResult if necessary and runs
+  // |callback|.
+  void RunFaviconRawBitmapCallbackWithBitmapResults(
+      const favicon_base::FaviconRawBitmapCallback& callback,
       int desired_size_in_dip,
       ui::ScaleFactor desired_scale_factor,
-      const std::vector<favicon_base::FaviconBitmapResult>&
+      const std::vector<favicon_base::FaviconRawBitmapResult>&
           favicon_bitmap_results);
 
   DISALLOW_COPY_AND_ASSIGN(FaviconService);
 };
 
 #endif  // CHROME_BROWSER_FAVICON_FAVICON_SERVICE_H_