Removes usage of NavigationEntry from favicon_handler.*

chrome/browser/favicon/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 CHROME_BROWSER_FAVICON_FAVICON_HANDLER_H_
 #define CHROME_BROWSER_FAVICON_FAVICON_HANDLER_H_
 
 #include <deque>
 #include <map>
 #include <vector>
@@ skipping 10 matching lines @@
 #include "url/gurl.h"
 
 class FaviconClient;
 class FaviconDriver;
 class SkBitmap;
 
 namespace base {
 class RefCountedMemory;
 }
 
-namespace content {
-class NavigationEntry;
-}
-
-// FaviconHandler works with FaviconTabHelper to fetch the specific type of
+// FaviconHandler works with FaviconDriver to fetch the specific type of
 // favicon.
 //
 // FetchFavicon requests the favicon from the favicon service which in turn
 // requests the favicon from the history database. At this point
 // we only know the URL of the page, and not necessarily the url of the
 // favicon. To ensure we handle reloading stale favicons as well as
 // reloading a favicon on page reload we always request the favicon from
-// history regardless of whether the NavigationEntry has a favicon.
+// history regardless of whether the active favicon is valid.
 //
 // After the navigation two types of events are delivered (which is
 // first depends upon who is faster): notification from the history
 // db on our request for the favicon
 // (OnFaviconDataForInitialURLFromFaviconService), or a message from the
 // renderer giving us the URL of the favicon for the page (SetFaviconURL).
 // . If the history db has a valid up to date favicon for the page, we update
 //   the NavigationEntry and use the favicon.

[blundell, 2014/05/12 07:52:19]

s/NavigationEntry/current page

[jif, 2014/05/12 18:07:41]

Done.

 // . When we receive the favicon url if it matches that of the NavigationEntry
 //   and the NavigationEntry's favicon is set, we do nothing (everything is
 //   ok).
 // . On the other hand if the database does not know the favicon for url, or
 //   the favicon is out date, or the URL from the renderer does not match that
-//   NavigationEntry we proceed to DownloadFaviconOrAskHistory. Before we
+//   of the current page we proceed to DownloadFaviconOrAskHistory. Before we
 //   invoke DownloadFaviconOrAskHistory we wait until we've received both
 //   the favicon url and the callback from history. We wait to ensure we
 //   truly know both the favicon url and the state of the database.
 //
 // DownloadFaviconOrAskHistory does the following:
 // . If we have a valid favicon, but it is expired we ask the renderer to
 //   download the favicon.
 // . Otherwise we ask the history database to update the mapping from
 //   page url to favicon url and call us back with the favicon. Remember, it is
 //   possible for the db to already have the favicon, just not the mapping
 //   between page to favicon url. The callback for this is OnFaviconData.
 //
 // OnFaviconData either updates the favicon of the NavigationEntry (if the
 // db knew about the favicon), or requests the renderer to download the
 // favicon.
 //
 // 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 favicon of the NavigationEntry and notifies the database to save the
-// favicon.
+// the page's favicon and notifies the database to save the favicon.
 
 class FaviconHandler {
  public:
   enum Type {
     FAVICON,
     TOUCH,
   };
 
   FaviconHandler(FaviconClient* client,
                  FaviconDriver* driver,
@@ skipping 25 matching lines @@
 
   // For testing.
   const std::vector<content::FaviconURL>& image_urls() const {
     return image_urls_;
   }
 
  protected:
   // These virtual methods make FaviconHandler testable and are overridden by
   // TestFaviconHandler.
 
-  // Return the NavigationEntry for the active entry, or NULL if the active
-  // entries URL does not match that of the URL last passed to FetchFavicon.
-  virtual content::NavigationEntry* GetEntry();
-
   // Asks the render to download favicon, returns the request id.
   virtual int DownloadFavicon(const GURL& image_url, int max_bitmap_size);
 
   // Ask the favicon from history
   virtual void UpdateFaviconMappingAndFetch(
       const GURL& page_url,
       const GURL& icon_url,
       favicon_base::IconType icon_type,
       const FaviconService::FaviconResultsCallback& callback,
       base::CancelableTaskTracker* tracker);
@@ skipping 85 matching lines @@
                               const gfx::Image& image,
                               float score,
                               favicon_base::IconType icon_type);
 
   // Sets the image data for the favicon.
   void SetFavicon(const GURL& url,
                   const GURL& icon_url,
                   const gfx::Image& image,
                   favicon_base::IconType icon_type);
 
-  // Sets the favicon's data on the NavigationEntry.
-  // If the WebContents has a delegate, it is invalidated (INVALIDATE_TYPE_TAB).
-  void SetFaviconOnNavigationEntry(
-      content::NavigationEntry* entry,
-      const std::vector<favicon_base::FaviconBitmapResult>&
-          favicon_bitmap_results);
-  void SetFaviconOnNavigationEntry(content::NavigationEntry* entry,
-                                   const GURL& icon_url,
-                                   const gfx::Image& image);
+  // Sets the favicon's data.
+  void SetFaviconOnActivePage(const std::vector<
+      favicon_base::FaviconBitmapResult>& favicon_bitmap_results);
+  void SetFaviconOnActivePage(const GURL& icon_url, const gfx::Image& image);
 
   // Return the current candidate if any.
   content::FaviconURL* current_candidate() {
     return (!image_urls_.empty()) ? &image_urls_.front() : NULL;
   }
 
+  // Returns wheter the page's url changed since the favicon was requested.

[blundell, 2014/05/12 07:52:19]

s/wheter/whether

[jif, 2014/05/12 18:07:41]

Done.

+  bool PageChangedSinceFaviconWasRequested();
+
   // Returns the preferred size of the image. 0 means no preference (any size
   // will do).
   int preferred_icon_size() const {
     if (download_largest_icon_)
       return 0;
     return icon_types_ == favicon_base::FAVICON ? gfx::kFaviconSize : 0;
   }
 
   // Sorts the entries in |image_urls_| by icon size in descending order.
   // Additionally removes any entries whose sizes are all greater than the max
@@ skipping 40 matching lines @@
   // Best image we've seen so far.  As images are downloaded from the page they
   // are stored here. When there is an exact match, or no more images are
   // available the favicon service and the NavigationEntry are updated (assuming
   // the image is for a favicon).
   FaviconCandidate best_favicon_candidate_;
 
   DISALLOW_COPY_AND_ASSIGN(FaviconHandler);
 };
 
 #endif  // CHROME_BROWSER_FAVICON_FAVICON_HANDLER_H_