Refactor FaviconDriver::OnFaviconAvailable()

components/favicon/core/favicon_handler.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_HANDLER_H_
 #define COMPONENTS_FAVICON_CORE_FAVICON_HANDLER_H_
 
 #include <map>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/callback_forward.h"
 #include "base/memory/ref_counted.h"
 #include "base/task/cancelable_task_tracker.h"
+#include "components/favicon/core/favicon_driver_observer.h"
 #include "components/favicon/core/favicon_url.h"
 #include "components/favicon_base/favicon_callback.h"
 #include "ui/gfx/favicon_size.h"
 #include "ui/gfx/image/image.h"
 #include "url/gurl.h"
 
 class SkBitmap;
 
 namespace base {
 class RefCountedMemory;
@@ skipping 46 matching lines @@
 //
 // When the renderer downloads favicons, it considers the entire list of
 // favicon candidates, if |download_largest_favicon_| is true, the largest
 // favicon will be used, otherwise the one that best matches the preferred size
 // is chosen (or the first one if there is no preferred  size). Once the
 // matching favicon has been determined, SetFavicon is called which updates
 // the page's favicon and notifies the database to save the favicon.
 
 class FaviconHandler {
  public:
-  enum Type {
-    // Selects the icon URL of type favicon_base::FAVICON with bitmaps whose
-    // edge sizes most closely match "16 * favicon_base::GetFaviconScales()".
-    // When favicon_base::GetFaviconScales() returns multiple scales, the ideal
-    // match is a .ico file.
-    FAVICON,
-
-    // Selects the icon URL of type favicon_base::FAVICON with the largest
-    // bitmap.
-    LARGEST_FAVICON,
-
-    // Selects the icon URL of type favicon_base::TOUCH_ICON or
-    // favicon_base::TOUCH_PRECOMPOSED_ICON with the largest bitmap.
-    LARGEST_TOUCH
-  };
-
   FaviconHandler(FaviconService* service,
                  FaviconDriver* driver,
-                 Type handler_type);
+                 FaviconDriverObserver::NotificationIconType handler_type);
   virtual ~FaviconHandler();
 
   // Returns the bit mask of favicon_base::IconType based on the handler's type.
-  static int GetIconTypesFromHandlerType(Type icon_type);
+  static int GetIconTypesFromHandlerType(
+      FaviconDriverObserver::NotificationIconType handler_type);
 
   // Initiates loading the favicon for the specified url.
   void FetchFavicon(const GURL& url);
 
   // Message Handler.  Must be public, because also called from
   // PrerenderContents. Collects the |image_urls| list.
   void OnUpdateFaviconURL(const GURL& page_url,
                           const std::vector<favicon::FaviconURL>& candidates);
 
   // Called when the history request for favicon data mapped to |url_| has
@@ skipping 113 matching lines @@
   bool UpdateFaviconCandidate(const GURL& image_url,
                               const gfx::Image& image,
                               float score,
                               favicon_base::IconType icon_type);
 
   // Sets the image data for the favicon.
   void SetFavicon(const GURL& icon_url,
                   const gfx::Image& image,
                   favicon_base::IconType icon_type);
 
-  // Notifies |driver_| favicon available. See
-  // FaviconDriver::NotifyFaviconAvailable() for |is_active_favicon| in detail.
-  void NotifyFaviconAvailable(
+  // Notifies |driver_| that FaviconHandler found an icon which matches the
+  // |handler_type_| criteria. NotifyFaviconUpdated() can be called multiple
+  // times for the same page if:
+  // - a better match is found for |handler_type_| (e.g. newer bitmap data)
+  // - Javascript changes the page's icon URLs.
+  void NotifyFaviconUpdated(
       const std::vector<favicon_base::FaviconRawBitmapResult>&
           favicon_bitmap_results);
-  void NotifyFaviconAvailable(const GURL& icon_url,
-                              favicon_base::IconType icon_type,
-                              const gfx::Image& image);
+  void NotifyFaviconUpdated(const GURL& icon_url,
+                            favicon_base::IconType icon_type,
+                            const gfx::Image& image);
 
   // Return the current candidate if any.
   favicon::FaviconURL* current_candidate() {
     return current_candidate_index_ < image_urls_.size()
                ? &image_urls_[current_candidate_index_]
                : nullptr;
   }
 
   // Returns the preferred size of the image. 0 means no preference (any size
   // will do).
   int preferred_icon_size() const {
     return download_largest_icon_ ? 0 : gfx::kFaviconSize;
   }
 
   // Used for FaviconService requests.
   base::CancelableTaskTracker cancelable_task_tracker_;
 
+  FaviconDriverObserver::NotificationIconType handler_type_;
+
   // URL of the page we're requesting the favicon for.
   GURL url_;
 
   // Whether we got data back for the initial request to the FaviconService.
   bool got_favicon_from_history_;
 
   // Whether the history data returned in
   // OnFaviconDataForInitialURLFromFaviconService() is out of date or is known
   // to be incomplete. If true, it means there is a favicon mapped to |url_| in
   // history, but we need to redownload the icon URLs because the icon in the
@@ skipping 39 matching lines @@
   // available the favicon service and the current page are updated (assuming
   // the image is for a favicon).
   FaviconCandidate best_favicon_candidate_;
 
   DISALLOW_COPY_AND_ASSIGN(FaviconHandler);
 };
 
 }  // namespace favicon
 
 #endif  // COMPONENTS_FAVICON_CORE_FAVICON_HANDLER_H_