Retrieve favicons from history as NavigationEntries are converted from TabNav...

chrome/browser/ui/toolbar/back_forward_menu_model.h

 // Copyright (c) 2010 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_UI_TOOLBAR_BACK_FORWARD_MENU_MODEL_H_
 #define CHROME_BROWSER_UI_TOOLBAR_BACK_FORWARD_MENU_MODEL_H_
 #pragma once
 
+#include <set>
 #include <string>
 
 #include "app/menus/menu_model.h"
 #include "base/basictypes.h"
 #include "base/gtest_prod_util.h"
 #include "base/string16.h"
+#include "chrome/browser/favicon_service.h"
 #include "webkit/glue/window_open_disposition.h"
 
 class Browser;
 class SkBitmap;
 class TabContents;
 class NavigationEntry;
 
 ///////////////////////////////////////////////////////////////////////////////
 //
 // BackForwardMenuModel
@@ skipping 21 matching lines @@
   // out the total number of items to show.
   virtual int GetItemCount() const;
   virtual ItemType GetTypeAt(int index) const;
   virtual int GetCommandIdAt(int index) const;
   virtual string16 GetLabelAt(int index) const;
   virtual bool IsItemDynamicAt(int index) const;
   virtual bool GetAcceleratorAt(int index,
                                 menus::Accelerator* accelerator) const;
   virtual bool IsItemCheckedAt(int index) const;
   virtual int GetGroupIdAt(int index) const;
-  virtual bool GetIconAt(int index, SkBitmap* icon) const;
+  virtual bool GetIconAt(int index, SkBitmap* icon);
   virtual menus::ButtonMenuItemModel* GetButtonMenuItemAt(int index) const;
   virtual bool IsEnabledAt(int index) const;
   virtual MenuModel* GetSubmenuModelAt(int index) const;
   virtual void HighlightChangedTo(int index);
   virtual void ActivatedAt(int index);
   virtual void ActivatedAtWithDisposition(int index, int disposition);
   virtual void MenuWillShow();
 
   // Is the item at |index| a separator?
   bool IsSeparator(int index) const;
 
+  // Set the delegate for triggering OnIconChanged.
+  virtual void SetDelegate(Delegate* delegate);
+
  private:
+  // Requests a favicon from the FaviconService. Called by GetIconAt if the
+  // NavigationEntry has an invalid favicon.
+  void FetchFavicon(NavigationEntry* entry, int index);
+  // Callback from the favicon service.
+  void OnFavIconDataAvailable(FaviconService::Handle handle,
+                                      bool know_favicon,
+                                      scoped_refptr<RefCountedMemory> data,
+                                      bool expired,
+                                      GURL icon_url);
   // Allows the unit test to use its own dummy tab contents.
   void set_test_tab_contents(TabContents* test_tab_contents) {
     test_tab_contents_ = test_tab_contents;
   }
 
   // Returns how many history items the menu should show. For example, if the
   // navigation controller of the current tab has a current entry index of 5 and
   // forward_direction_ is false (we are the back button delegate) then this
   // function will return 5 (representing 0-4). If forward_direction_ is
   // true (we are the forward button delegate), then this function will return
@@ skipping 74 matching lines @@
 
   Browser* browser_;
 
   // The unit tests will provide their own TabContents to use.
   TabContents* test_tab_contents_;
 
   // Represents whether this is the delegate for the forward button or the
   // back button.
   ModelType model_type_;
 
+  // Keeps track of which favicons have already been requested from the history
+  // to prevent duplicate requests, identified by NavigationEntry->unique_id().
+  std::set<int> requested_favicons_;
+
+  // Delegate from menus::MenuModel so we can trigger OnIconChanged.
+  Delegate* delegate_;
+
   friend class BackFwdMenuModelTest;
   FRIEND_TEST_ALL_PREFIXES(BackFwdMenuModelTest, BasicCase);
   FRIEND_TEST_ALL_PREFIXES(BackFwdMenuModelTest, MaxItemsTest);
   FRIEND_TEST_ALL_PREFIXES(BackFwdMenuModelTest, ChapterStops);
+  FRIEND_TEST_ALL_PREFIXES(BackFwdMenuModelTest, FaviconLoadTest);
+
+  // Used for loading favicons from history.
+  CancelableRequestConsumerTSimple<int> load_consumer_;
 
   DISALLOW_COPY_AND_ASSIGN(BackForwardMenuModel);
 };
 
 #endif  // CHROME_BROWSER_UI_TOOLBAR_BACK_FORWARD_MENU_MODEL_H_