Decouple TabRestoreService from Browser

chrome/browser/sessions/tab_restore_service.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_SESSIONS_TAB_RESTORE_SERVICE_H_
 #define CHROME_BROWSER_SESSIONS_TAB_RESTORE_SERVICE_H_
 #pragma once
 
 #include <list>
 #include <set>
 #include <vector>
 
 #include "base/observer_list.h"
 #include "base/time.h"
 #include "chrome/browser/sessions/base_session_service.h"
 #include "chrome/browser/sessions/session_id.h"
 #include "chrome/browser/sessions/session_types.h"
 #include "content/browser/in_process_webkit/session_storage_namespace.h"
 
-class Browser;
 class NavigationController;
 class Profile;
+class TabRestoreServiceDelegate;
 class TabRestoreServiceObserver;
 struct SessionWindow;
 
 // TabRestoreService is responsible for maintaining the most recently closed
 // tabs and windows. When a tab is closed
 // TabRestoreService::CreateHistoricalTab is invoked and a Tab is created to
 // represent the tab. Similarly, when a browser is closed, BrowserClosing is
 // invoked and a Window is created to represent the window.
 //
 // To restore a tab/window from the TabRestoreService invoke RestoreEntryById
@@ skipping 87 matching lines @@
   explicit TabRestoreService(Profile* profile,
                              TimeFactory* time_factory_ = NULL);
 
   // Adds/removes an observer. TabRestoreService does not take ownership of
   // the observer.
   void AddObserver(TabRestoreServiceObserver* observer);
   void RemoveObserver(TabRestoreServiceObserver* observer);
 
   // Creates a Tab to represent |tab| and notifies observers the list of
   // entries has changed.
-  void CreateHistoricalTab(NavigationController* tab);
+  void CreateHistoricalTab(NavigationController* tab, int index);
 
-  // Invoked when a browser is closing. If |browser| is a tabbed browser with
+  // Invoked when a browser is closing. If |delegate| is a tabbed browser with
   // at least one tab, a Window is created, added to entries and observers are
   // notified.
-  void BrowserClosing(Browser* browser);
+  void BrowserClosing(TabRestoreServiceDelegate* delegate);
 
   // Invoked when the browser is done closing.
-  void BrowserClosed(Browser* browser);
+  void BrowserClosed(TabRestoreServiceDelegate* delegate);
 
   // Removes all entries from the list and notifies observers the list
   // of tabs has changed.
   void ClearEntries();
 
   // Returns the entries, ordered with most recently closed entries at the
   // front.
   virtual const Entries& entries() const;
 
   // Restores the most recently closed entry. Does nothing if there are no
   // entries to restore. If the most recently restored entry is a tab, it is
-  // added to |browser|.
-  void RestoreMostRecentEntry(Browser* browser);
+  // added to |delegate|.
+  void RestoreMostRecentEntry(TabRestoreServiceDelegate* delegate);
 
   // Restores an entry by id. If there is no entry with an id matching |id|,
   // this does nothing. If |replace_existing_tab| is true and id identifies a
-  // tab, the newly created tab replaces the selected tab in |browser|. If
-  // |browser| is NULL, this creates a new window for the entry.
-  void RestoreEntryById(Browser* browser,
+  // tab, the newly created tab replaces the selected tab in |delegate|. If
+  // |delegate| is NULL, this creates a new window for the entry.
+  void RestoreEntryById(TabRestoreServiceDelegate* delegate,
                         SessionID::id_type id,
                         bool replace_existing_tab);
 
   // Loads the tabs and previous session. This does nothing if the tabs
   // from the previous session have already been loaded.
   void LoadTabsFromLastSession();
 
   // Max number of entries we'll keep around.
   static const size_t kMaxEntries;
 
@@ skipping 19 matching lines @@
     // Indicates we finished loading the last tabs (but not necessarily the
     // last session).
     LOADED_LAST_TABS     = 1 << 3,
 
     // Indicates we finished loading the last session (but not necessarily the
     // last tabs).
     LOADED_LAST_SESSION  = 1 << 4
   };
 
   // Populates the tab's navigations from the NavigationController, and its
-  // browser_id and tabstrip_index from the browser.
+  // browser_id and pinned state from the browser.
   void PopulateTab(Tab* tab,
-                   Browser* browser,
+                   int index,
+                   TabRestoreServiceDelegate* delegate,
                    NavigationController* controller);
 
   // Notifies observers the tabs have changed.
   void NotifyTabsChanged();
 
   // Adds |entry| to the list of entries and takes ownership. If |prune| is true
   // |PruneAndNotify| is invoked. If |to_front| is true the entry is added to
   // the front, otherwise the back. Normal closes go to the front, but
   // tab/window closes from the previous session are added to the back.
   void AddEntry(Entry* entry, bool prune, bool to_front);
@@ skipping 42 matching lines @@
       Handle handle,
       scoped_refptr<InternalGetCommandsRequest> request);
 
   // Populates |loaded_entries| with Entries from |request|.
   void CreateEntriesFromCommands(
       scoped_refptr<InternalGetCommandsRequest> request,
       std::vector<Entry*>* loaded_entries);
 
   // This is a helper function for RestoreEntryById() for restoring a single
   // tab. If |replace_existing_tab| is true, the newly created tab replaces the
-  // selected tab in |browser|. If |browser| is NULL, this creates a new window
-  // for the entry. This returns the Browser into which the tab was restored.
-  Browser* RestoreTab(const Tab& tab,
-                      Browser* browser,
-                      bool replace_existing_tab);
+  // selected tab in |delegate|. If |delegate| is NULL, this creates a new
+  // window for the entry. This returns the TabRestoreServiceDelegate into which
+  // the tab was restored.
+  TabRestoreServiceDelegate* RestoreTab(const Tab& tab,
+                                        TabRestoreServiceDelegate* delegate,
+                                        bool replace_existing_tab);
 
   // Returns true if |tab| has more than one navigation. If |tab| has more
   // than one navigation |tab->current_navigation_index| is constrained based
   // on the number of navigations.
   bool ValidateTab(Tab* tab);
 
   // Validates all entries in |entries|, deleting any with no navigations.
   // This also deletes any entries beyond the max number of entries we can
   // hold.
   void ValidateAndDeleteEmptyEntries(std::vector<Entry*>* entries);
@@ skipping 36 matching lines @@
   bool reached_max_;
 
   // The number of entries to write.
   int entries_to_write_;
 
   // Number of entries we've written.
   int entries_written_;
 
   ObserverList<TabRestoreServiceObserver> observer_list_;
 
-  // Set of tabs that we've received a BrowserClosing method for but no
-  // corresponding BrowserClosed. We cache the set of browsers closing to
+  // Set of delegates that we've received a BrowserClosing method for but no
+  // corresponding BrowserClosed. We cache the set of delegates closing to
   // avoid creating historical tabs for them.
-  std::set<Browser*> closing_browsers_;
+  std::set<TabRestoreServiceDelegate*> closing_delegates_;
 
   // Used when loading previous tabs/session.
   CancelableRequestConsumer load_consumer_;
 
   // Results from previously closed tabs/sessions is first added here. When
   // the results from both us and the session restore service have finished
   // loading LoadStateChanged is invoked, which adds these entries to
   // entries_.
   std::vector<Entry*> staging_entries_;
 
   TimeFactory* time_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(TabRestoreService);
 };
 
 #endif  // CHROME_BROWSER_SESSIONS_TAB_RESTORE_SERVICE_H_
-