Componentize FaviconTabHelper

components/favicon/core/favicon_driver.h

 // Copyright 2014 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_DRIVER_H_
 #define COMPONENTS_FAVICON_CORE_FAVICON_DRIVER_H_
 
 #include "base/macros.h"
+#include "base/observer_list.h"
 #include "base/strings/string16.h"
 
 class GURL;
 
 namespace gfx {
 class Image;
 }
 
 namespace favicon {
 
-// Interface that allows Favicon core code to interact with its driver (i.e.,
-// obtain information from it and give information to it). A concrete
-// implementation must be provided by the driver.
+class FaviconDriverObserver;
+
+// Interface that allows favicon core code to obtain information about the
+// current page. This is partially implemented by FaviconDriverImpl, and
+// concrete implementation should be based on that class instead of directly
+// subclassing FaviconDriver.
 class FaviconDriver {
  public:
+  // Adds/Removes an observer.
+  void AddObserver(FaviconDriverObserver* observer);
+  void RemoveObserver(FaviconDriverObserver* observer);
+
+  // Initiates loading the favicon for the specified url.
+  virtual void FetchFavicon(const GURL& url) = 0;
+
+  // Saves the favicon for the current page.
+  virtual void SaveFavicon() = 0;
+
+  // Returns the favicon for this tab, or IDR_DEFAULT_FAVICON if the tab does
+  // not have a favicon. The default implementation uses the current navigation
+  // entry. Returns an empty bitmap if there are no navigation entries, which
+  // should rarely happen.
+  virtual gfx::Image GetFavicon() const = 0;
+
+  // Returns true if we have the favicon for the page.
+  virtual bool FaviconIsValid() const = 0;
+
   // Starts the download for the given favicon. When finished, the driver
   // will call OnDidDownloadFavicon() with the results.
   // Returns the unique id of the download request. The id will be passed
   // in OnDidDownloadFavicon().
   // Bitmaps with pixel sizes larger than |max_bitmap_size| are filtered out
   // from the bitmap results. If there are no bitmap results <=
   // |max_bitmap_size|, the smallest bitmap is resized to |max_bitmap_size| and
   // is the only result. A |max_bitmap_size| of 0 means unlimited.
   virtual int StartDownload(const GURL& url, int max_bitmap_size) = 0;
 
@@ skipping 33 matching lines @@
   virtual void SetActiveFaviconImage(const gfx::Image& image) = 0;
 
   // Notifies the driver a favicon image is available. |image| is not
   // necessarily 16x16. |icon_url| is the url the image is from. If
   // |is_active_favicon| is true the image corresponds to the favicon
   // (possibly empty) of the page.
   virtual void OnFaviconAvailable(const gfx::Image& image,
                                   const GURL& icon_url,
                                   bool is_active_favicon) = 0;
 
-  // Sends notification that the current page favicon has changed.
-  // |icon_url_changed| is true if the URL of the favicon changed in addition to
-  // the favicon image.
-  virtual void NotifyFaviconUpdated(bool icon_url_changed) = 0;
+  // Returns whether the driver is waiting for a download to complete or for
+  // data from the FaviconService. Reserved for testing.
+  virtual bool HasPendingTasksForTest() = 0;
 
  protected:
-  FaviconDriver() {}
-  virtual ~FaviconDriver() {}
+  FaviconDriver();
+  virtual ~FaviconDriver();
+
+  // Informs FaviconDriverObservers that favicon |image| has been retrieved from
+  // either website or cached storage.
+  void NotifyFaviconAvailable(const gfx::Image& image);
+
+  // Informs FaviconDriverObservers that favicon has changed for the current
+  // page. |icon_url_changed| is true if the favicon URL has also changed since
+  // the last call.
+  virtual void NotifyFaviconUpdated(bool icon_url_changed);
 
  private:
+  ObserverList<FaviconDriverObserver> observer_list_;
+
   DISALLOW_COPY_AND_ASSIGN(FaviconDriver);
 };
 
 }  // namespace favicon
 
 #endif  // COMPONENTS_FAVICON_CORE_FAVICON_DRIVER_H_