Move favicon from TabContents to TabContentsWrapper.

chrome/browser/favicon_tab_helper.h

 // Copyright (c) 2011 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_HELPER_H__
-#define CHROME_BROWSER_FAVICON_HELPER_H__
+#ifndef CHROME_BROWSER_FAVICON_TAB_HELPER_H__
+#define CHROME_BROWSER_FAVICON_TAB_HELPER_H__
 #pragma once
 
 #include <map>
 
 #include "base/basictypes.h"
 #include "base/callback.h"
 #include "base/memory/ref_counted.h"
 #include "chrome/browser/favicon_service.h"
-#include "chrome/common/ref_counted_util.h"
 #include "content/browser/cancelable_request.h"
 #include "content/browser/tab_contents/tab_contents_observer.h"
 #include "googleurl/src/gurl.h"
 
 class NavigationEntry;
-class Profile;
 class RefCountedMemory;
 class SkBitmap;
 class TabContents;
 
-// FaviconHelper is used to fetch the favicon for TabContents.
+// FaviconTabHelper is used to fetch the favicon for TabContents.
 //
 // 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.
 //
 // After the navigation two types of events are delivered (which is
 // first depends upon who is faster): notification from the history
@@ skipping 21 matching lines @@
 //   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 the favicon SetFaviconImageData is invoked,
 // at which point we update the favicon of the NavigationEntry and notify
 // the database to save the favicon.
 
-class FaviconHelper : public TabContentsObserver {
+class FaviconTabHelper : public TabContentsObserver {
  public:
-  explicit FaviconHelper(TabContents* tab_contents);
-  virtual ~FaviconHelper();
+  explicit FaviconTabHelper(TabContents* tab_contents);
+  virtual ~FaviconTabHelper();
 
-  // Initiates loading the favicon for the specified url.
-  void FetchFavicon(const GURL& url);
+  // Returns the favicon for this tab, or an isNull() bitmap if the tab does not
+  // have a favicon. The default implementation uses the current navigation
+  // entry.
+  SkBitmap GetFavicon() const;
+
+  // Returns true if we are not using the default favicon.
+  bool FaviconIsValid() const;
+
+  // Returns whether the favicon should be displayed. If this returns false, no
+  // space is provided for the favicon, and the favicon is never displayed.
+  virtual bool ShouldDisplayFavicon();
+
+  // Saves the favicon for the current page.
+  void SaveFavicon();
 
   // Initiates loading an image from given |image_url|. Returns a download id
   // for caller to track the request. When download completes, |callback| is
   // called with the three params: the download_id, a boolean flag to indicate
   // whether the download succeeds and a SkBitmap as the downloaded image.
   // Note that |image_size| is a hint for images with multiple sizes. The
   // downloaded image is not resized to the given image_size. If 0 is passed,
   // the first frame of the image is returned.
   typedef Callback3<int, bool, const SkBitmap&>::Type ImageDownloadCallback;
   int DownloadImage(const GURL& image_url, int image_size,
@@ skipping 11 matching lines @@
                     ImageDownloadCallback* callback)
         : url(url),
           image_url(image_url),
           callback(callback) {}
 
     GURL url;
     GURL image_url;
     ImageDownloadCallback* callback;
   };
 
-  // TabContentsObserver implementation.
-  virtual bool OnMessageReceived(const IPC::Message& message);
+  // TabContentsObserver overrides.
+  virtual void NavigateToPendingEntry(
+      const GURL& url,
+      NavigationController::ReloadType reload_type) OVERRIDE;
+  virtual void DidNavigateMainFramePostCommit(
+      const NavigationController::LoadCommittedDetails& details,
+      const ViewHostMsg_FrameNavigate_Params& params) OVERRIDE;
+  virtual bool OnMessageReceived(const IPC::Message& message) OVERRIDE;
 
   void OnDidDownloadFavicon(int id,
                             const GURL& image_url,
                             bool errored,
                             const SkBitmap& image);
 
+  // Initiates loading the favicon for the specified url.
+  void FetchFavicon(const GURL& url);
+
   // 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.
   NavigationEntry* GetEntry();
 
-  Profile* profile();
-
   FaviconService* GetFaviconService();
 
   // See description above class for details.
   void OnFaviconDataForInitialURL(FaviconService::Handle handle,
                                   history::FaviconData favicon);
 
   // If the favicon has expired, asks the renderer to download the favicon.
   // Otherwise asks history to update the mapping between page url and icon
   // url with a callback to OnFaviconData when done.
   void DownloadFaviconOrAskHistory(NavigationEntry* entry);
@@ skipping 42 matching lines @@
   // Whether the favicon is out of date. If true, it means history knows about
   // the favicon, but we need to download the favicon because the icon has
   // expired.
   // See "Favicon Details" in tab_contents.cc for more details.
   bool favicon_expired_;
 
   // Requests to the renderer to download favicons.
   typedef std::map<int, DownloadRequest> DownloadRequests;
   DownloadRequests download_requests_;
 
-  DISALLOW_COPY_AND_ASSIGN(FaviconHelper);
+  DISALLOW_COPY_AND_ASSIGN(FaviconTabHelper);
 };
 
-#endif  // CHROME_BROWSER_FAVICON_HELPER_H__
+#endif  // CHROME_BROWSER_FAVICON_TAB_HELPER_H__