DRAFT CL: Add FrameNavigationEntry and track subframe session histories.

content/browser/frame_host/navigation_entry_impl.h

 // Copyright 2013 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 CONTENT_BROWSER_FRAME_HOST_NAVIGATION_ENTRY_IMPL_H_
 #define CONTENT_BROWSER_FRAME_HOST_NAVIGATION_ENTRY_IMPL_H_
 
 #include "base/basictypes.h"
 #include "base/memory/ref_counted.h"
+#include "base/memory/scoped_vector.h"
 #include "base/time/time.h"
 #include "content/browser/frame_host/frame_navigation_entry.h"
+#include "content/browser/frame_host/frame_tree_node.h"
 #include "content/browser/site_instance_impl.h"
 #include "content/common/frame_message_enums.h"
 #include "content/public/browser/favicon_status.h"
 #include "content/public/browser/global_request_id.h"
 #include "content/public/browser/navigation_entry.h"
 #include "content/public/common/page_state.h"
 #include "content/public/common/ssl_status.h"
 
 namespace content {
 class NavigationControllerImpl;
 struct CommitNavigationParams;
 struct CommonNavigationParams;
 struct HistoryNavigationParams;
 struct StartNavigationParams;
 
 class CONTENT_EXPORT NavigationEntryImpl
     : public NON_EXPORTED_BASE(NavigationEntry) {
  public:
   // Represents a tree of FrameNavigationEntries that make up this joint session
   // history item.  The tree currently only tracks the main frame.
   // TODO(creis): Populate the tree with subframe entries in --site-per-process.
   struct TreeNode {
-    TreeNode(FrameNavigationEntry* frame_entry);
+    TreeNode(NavigationEntryImpl* entry,
+             FrameNavigationEntry* frame_entry);
     ~TreeNode();
 
     // Returns a deep copy of the tree with copies of each node's
     // FrameNavigationEntries.  We do not yet share FrameNavigationEntries
     // across trees.
     // TODO(creis): For --site-per-process, share FrameNavigationEntries between
     // NavigationEntries of the same tab.
     TreeNode* Clone() const;
 
+    void SetFrameEntry(FrameNavigationEntry* new_frame_entry);
+
+    // Pointer to the NavigationEntry that owns us.
+    // TODO(creis): Remove this.
+    NavigationEntryImpl* entry;
+
     // Ref counted pointer that keeps the FrameNavigationEntry alive as long as
     // it is needed by this node's NavigationEntry.
     scoped_refptr<FrameNavigationEntry> frame_entry;
+
+    // List of child TreeNodes, which will be deleted when this node is.
+    ScopedVector<TreeNode> children;
   };
 
   static NavigationEntryImpl* FromNavigationEntry(NavigationEntry* entry);
 
   // The value of bindings() before it is set during commit.
   static int kInvalidBindings;
 
   NavigationEntryImpl();
   NavigationEntryImpl(SiteInstanceImpl* instance,
                       int page_id,
@@ skipping 51 matching lines @@
                     const base::string16& data) override;
   bool GetExtraData(const std::string& key,
                     base::string16* data) const override;
   void ClearExtraData(const std::string& key) override;
   void SetHttpStatusCode(int http_status_code) override;
   int GetHttpStatusCode() const override;
   void SetRedirectChain(const std::vector<GURL>& redirects) override;
   const std::vector<GURL>& GetRedirectChain() const override;
   bool IsRestored() const override;
 
+  TreeNode* root_node() const {
+    return frame_tree_.get();
+  }
+
   // Creates a copy of this NavigationEntryImpl that can be modified
   // independently from the original.  Does not copy any value that would be
   // cleared in ResetForCommit.
   // TODO(creis): Once we start sharing FrameNavigationEntries between
   // NavigationEntryImpls, we will need to support two versions of Clone: one
   // that shares the existing FrameNavigationEntries (for use within the same
   // tab) and one that draws them from a different pool (for use in a new tab).
   NavigationEntryImpl* Clone() const;
 
+  // Clears the frame tree before adding new TreeNodes to it.
+  void ResetFrameTree();
+
+  TreeNode* GetTreeNodeForFrame(FrameTreeNode* frame_tree_node);
+
+  // Returns the FrameNavigationEntry corresponding to |frame_tree_node|.
+  FrameNavigationEntry* GetFrameEntryForFrame(FrameTreeNode* frame_tree_node);
+
   // Once a navigation entry is committed, we should no longer track several
   // pieces of non-persisted state, as documented on the members below.
   void ResetForCommit();
 
   void set_unique_id(int unique_id) {
     unique_id_ = unique_id;
   }
 
   // The SiteInstance represents which pages must share processes. This is a
   // reference counted pointer to a shared SiteInstance.
   //
   // Note that the SiteInstance should usually not be changed after it is set,
   // but this may happen if the NavigationEntry was cloned and needs to use a
   // different SiteInstance.
+  // TODO(creis): This should live on the FNE, not here.
   void set_site_instance(SiteInstanceImpl* site_instance);
   SiteInstanceImpl* site_instance() const {
     return frame_tree_->frame_entry->site_instance();
   }
 
   // The |source_site_instance| is used to identify the SiteInstance of the
   // frame that initiated the navigation.
   void set_source_site_instance(SiteInstanceImpl* source_site_instance);
   SiteInstanceImpl* source_site_instance() const {
     return source_site_instance_.get();
@@ skipping 92 matching lines @@
 
   // Whether this (pending) navigation should clear the session history. Resets
   // to false after commit.
   bool should_clear_history_list() const {
     return should_clear_history_list_;
   }
   void set_should_clear_history_list(bool should_clear_history_list) {
     should_clear_history_list_ = should_clear_history_list;
   }
 
-  // Indicates which FrameTreeNode to navigate.  Currently only used if the
-  // --site-per-process flag is passed.
-  int64 frame_tree_node_id() const {
-    return frame_tree_node_id_;
-  }
-  void set_frame_tree_node_id(int64 frame_tree_node_id) {
-    frame_tree_node_id_ = frame_tree_node_id;
-  }
-
   // Returns the history URL for a data URL to use in Blink.
   GURL GetHistoryURLForDataURL() const;
 
   CommonNavigationParams ConstructCommonNavigationParams(
+      const FrameNavigationEntry& frame_entry,
       FrameMsg_Navigate_Type::Value navigation_type) const;
   CommitNavigationParams ConstructCommitNavigationParams(
       base::TimeTicks navigation_start) const;
+  // TODO(creis): NavigationEntry should not depend on NavigationController.
   HistoryNavigationParams ConstructHistoryNavigationParams(
+      const FrameNavigationEntry& frame_entry,
       NavigationControllerImpl* controller) const;
   StartNavigationParams ConstructStartNavigationParams() const;
 
 #if defined(OS_ANDROID)
   base::TimeTicks intent_received_timestamp() const {
     return intent_received_timestamp_;
   }
 
   void set_intent_received_timestamp(
       const base::TimeTicks intent_received_timestamp) {
     intent_received_timestamp_ = intent_received_timestamp;
   }
 #endif
 
  private:
   // WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
   // Session/Tab restore save portions of this class so that it can be recreated
   // later. If you add a new field that needs to be persisted you'll have to
   // update SessionService/TabRestoreService and Android WebView
   // state_serializer.cc appropriately.
   // For all new fields, update |Clone| and possibly |ResetForCommit|.
   // WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
 
+  typedef base::hash_map<int64, TreeNode*> FramesToItems;
+  FramesToItems frames_to_items_;
+
+  typedef base::hash_map<std::string, TreeNode*> UniqueNamesToItems;
+  UniqueNamesToItems unique_names_to_items_;
+
   // Tree of FrameNavigationEntries, one for each frame on the page.
   // TODO(creis): Once FrameNavigationEntries can be shared across multiple
   // NavigationEntries, we will need to update Session/Tab restore.  For now,
   // each NavigationEntry's tree has its own unshared FrameNavigationEntries.
   scoped_ptr<TreeNode> frame_tree_;
 
   // See the accessors above for descriptions.
   int unique_id_;
   // TODO(creis): Persist bindings_. http://crbug.com/173672.
   int bindings_;
   PageType page_type_;
   GURL virtual_url_;
   bool update_virtual_url_with_url_;
   base::string16 title_;
   FaviconStatus favicon_;
-  PageState page_state_;
   int32 page_id_;
   SSLStatus ssl_;
   ui::PageTransition transition_type_;
   GURL user_typed_url_;
   bool has_post_data_;
   int64 post_id_;
   RestoreType restore_type_;
   GURL original_request_url_;
   bool is_overriding_user_agent_;
   base::Time timestamp_;
@@ skipping 70 matching lines @@
   bool should_clear_history_list_;
 
   // Set when this entry should be able to access local file:// resources. This
   // value is not needed after the entry commits and is not persisted.
   bool can_load_local_resources_;
 
   // If not empty, the name of the frame to navigate. This field is not
   // persisted, because it is currently only used in tests.
   std::string frame_to_navigate_;
 
-  // If not -1, this indicates which FrameTreeNode to navigate.  This field is
-  // not persisted because it is experimental and only used when the
-  // --site-per-process flag is passed.  It is cleared in |ResetForCommit|
-  // because we only use it while the navigation is pending.
-  // TODO(creis): Move this to FrameNavigationEntry.
-  int64 frame_tree_node_id_;
-
 #if defined(OS_ANDROID)
   // The time at which Chrome received the Android Intent that triggered this
   // URL load operation. Reset at commit and not persisted.
   base::TimeTicks intent_received_timestamp_;
 #endif
 
   // Used to store extra data to support browser features. This member is not
   // persisted, unless specific data is taken out/put back in at save/restore
   // time (see TabNavigation for an example of this).
   std::map<std::string, base::string16> extra_data_;
 
   DISALLOW_COPY_AND_ASSIGN(NavigationEntryImpl);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_BROWSER_FRAME_HOST_NAVIGATION_ENTRY_IMPL_H_