[Sync] Componentize synced_tab_delegate

components/sync_sessions/synced_tab_delegate.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_SYNC_GLUE_SYNCED_TAB_DELEGATE_H__
-#define CHROME_BROWSER_SYNC_GLUE_SYNCED_TAB_DELEGATE_H__
+#ifndef COMPONENTS_SYNC_SESSIONS_SYNCED_TAB_DELEGATE_H__
+#define COMPONENTS_SYNC_SESSIONS_SYNCED_TAB_DELEGATE_H__
 
 #include <string>
 #include <vector>
 
 #include "base/memory/scoped_ptr.h"
+#include "components/sessions/core/serialized_navigation_entry.h"
 #include "components/sessions/core/session_id.h"
 #include "components/sync_driver/sessions/synced_window_delegates_getter.h"
+#include "ui/base/page_transition_types.h"

[skym, 2015/10/16 16:55:47]

Errr, what? I thought ui/ dependencies in components/ was forbidden. I'm
confused.

[Nicolas Zea, 2015/10/20 23:14:42]

We can include ui/, just not content/ or chrome/

+#include "url/gurl.h"
 
 class Profile;
 
-namespace content {
-class NavigationEntry;
-class WebContents;
+namespace sync_sessions {
+class SyncSessionsClient;
 }
 
 namespace browser_sync {
 class SyncedWindowDelegate;
 
 // A SyncedTabDelegate is used to insulate the sync code from depending
 // directly on WebContents, NavigationController, and the extensions TabHelper.
 class SyncedTabDelegate {
  public:
   virtual ~SyncedTabDelegate();
 
   // Methods from TabContents.
-
   virtual SessionID::id_type GetWindowId() const = 0;
   virtual SessionID::id_type GetSessionId() const = 0;
   virtual bool IsBeingDestroyed() const = 0;
-  virtual Profile* profile() const = 0;
 
   // Method derived from extensions TabHelper.
-
   virtual std::string GetExtensionAppId() const = 0;
 
   // Methods from NavigationController.
   virtual bool IsInitialBlankNavigation() const = 0;
   virtual int GetCurrentEntryIndex() const = 0;
   virtual int GetEntryCount() const = 0;
-  virtual int GetPendingEntryIndex() const = 0;
-  virtual content::NavigationEntry* GetPendingEntry() const = 0;
-  virtual content::NavigationEntry* GetEntryAtIndex(int i) const = 0;
-  virtual content::NavigationEntry* GetActiveEntry() const = 0;
-
-  // The idea here is that GetEntryAtIndex may not always return the pending
-  // entry when asked for the entry at the pending index. These convinience
-  // methods will check for this case and then call the correct entry accessor.
-  content::NavigationEntry* GetCurrentEntryMaybePending() const;
-  content::NavigationEntry* GetEntryAtIndexMaybePending(int i) const;
+  virtual GURL GetVirtualURLAtIndex(int i) const = 0;
+  virtual GURL GetFaviconURLAtIndex(int i) const = 0;
+  virtual ui::PageTransition GetTransitionAtIndex(int i) const = 0;
+  virtual void GetSerializedNavigationAtIndex(
+      int i,
+      sessions::SerializedNavigationEntry* serialized_entry) const = 0;
 
   // Supervised user related methods.
-
   virtual bool ProfileIsSupervised() const = 0;
-  virtual const std::vector<const content::NavigationEntry*>*
-      GetBlockedNavigations() const = 0;
+  virtual const std::vector<const sessions::SerializedNavigationEntry*>*
+  GetBlockedNavigations() const = 0;
 
   virtual bool IsPinned() const = 0;
   virtual bool HasWebContents() const = 0;

[blundell, 2015/10/16 10:41:26]

drive-by nit: This method should be renamed, assuming it's actually still needed
in this interface.

[Nicolas Zea, 2015/10/20 23:14:42]

It is in fact still used (although this made me realized IsPinned could be
removed). Renamed to IsFullyLoaded, and added comment about what its for.

-  virtual content::WebContents* GetWebContents() const = 0;
 
   // Session sync related methods.
   virtual int GetSyncId() const = 0;
   virtual void SetSyncId(int sync_id) = 0;
 
-  // Returns true if this tab should be synchronized.
-  bool ShouldSync() const;
-
   // Sets the window getter. This must be called before any of the sync or
-  // supervised user methods on this class are called. It is currently set when
-  // the SyncTabDelegate is retrieved from WebContents via ImplFromWebContents.
+  // supervised user methods on this class are called. It must be set when
+  // the SyncTabDelegate implementation is accessed from Sync.
   void SetSyncedWindowGetter(scoped_ptr<SyncedWindowDelegatesGetter> getter);
 
-  // Returns the SyncedTabDelegate associated with WebContents.
-  static SyncedTabDelegate* ImplFromWebContents(
-      content::WebContents* web_contents);
+  // Get the synced window delegate for this tab.
+  const SyncedWindowDelegate* GetSyncedWindowDelegate() const;
 
  protected:
   SyncedTabDelegate();
 
-  // Overridden by the tests to avoid interaction with static state.
-  virtual const SyncedWindowDelegate* GetSyncedWindowDelegate() const;
-
  private:
   // A getter for accessing the associated SyncedWindowDelegate.
   scoped_ptr<SyncedWindowDelegatesGetter> synced_window_getter_;
 };
 
 }  // namespace browser_sync
 
-#endif  // CHROME_BROWSER_SYNC_GLUE_SYNCED_TAB_DELEGATE_H__
+#endif  // COMPONENTS_SYNC_SESSIONS_SYNCED_TAB_DELEGATE_H__