Clone children of FrameNavigationEntries for in-page navigations.

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 <stdint.h>
 
 #include "base/macros.h"
@@ skipping 30 matching lines @@
 
     // Returns whether this TreeNode corresponds to |frame_tree_node|.  If this
     // is called on the root TreeNode, then |is_root_tree_node| should be true
     // and we only check if |frame_tree_node| is the main frame.  Otherwise, we
     // check if the unique name matches.
     bool MatchesFrame(FrameTreeNode* frame_tree_node,
                       bool is_root_tree_node) const;
 
     // Recursively makes a deep copy of TreeNode with copies of each of the
     // FrameNavigationEntries in the subtree.  Replaces the TreeNode
-    // corresponding to |frame_tree_node| (and all of its children) with a new
-    // TreeNode for |frame_navigation_entry|.  Pass nullptr for both parameters
-    // to make a complete clone.
+    // corresponding to |target_frame_tree_node|, clearing all of its children
+    // unless |clone_children_of_target| is true.  This function omits any
+    // subframe history items that do not correspond to frames actually in the
+    // current page, using |current_frame_tree_node| (if present).
     // |is_root_tree_node| indicates whether this is being called on the root
     // NavigationEntryImpl::TreeNode.
     // TODO(creis): For --site-per-process, share FrameNavigationEntries between
     // NavigationEntries of the same tab.
     std::unique_ptr<TreeNode> CloneAndReplace(
-        FrameTreeNode* frame_tree_node,
         FrameNavigationEntry* frame_navigation_entry,
+        bool clone_children_of_target,
+        FrameTreeNode* target_frame_tree_node,
+        FrameTreeNode* current_frame_tree_node,
         bool is_root_tree_node) const;
 
     // 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;
   };
 
@@ skipping 68 matching lines @@
                     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;
 
   // 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.
+  // cleared in ResetForCommit.  Unlike |CloneAndReplace|, this does not check
+  // whether the subframe history items are for frames that are still in the
+  // current page.
   std::unique_ptr<NavigationEntryImpl> Clone() const;
 
   // Like |Clone|, but replaces the FrameNavigationEntry corresponding to
-  // |frame_tree_node| (and all its children) with |frame_entry|.
+  // |target_frame_tree_node| with |frame_entry|, clearing all of its children
+  // unless |clone_children_of_target| is true.  This function omits any
+  // subframe history items that do not correspond to frames actually in the
+  // current page, using |root_frame_tree_node| (if present).
+  //
   // 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).
   std::unique_ptr<NavigationEntryImpl> CloneAndReplace(
-      FrameTreeNode* frame_tree_node,
-      FrameNavigationEntry* frame_entry) const;
+      FrameNavigationEntry* frame_entry,
+      bool clone_children_of_target,
+      FrameTreeNode* target_frame_tree_node,
+      FrameTreeNode* root_frame_tree_node) const;
 
   // Helper functions to construct NavigationParameters for a navigation to this
   // NavigationEntry.
   CommonNavigationParams ConstructCommonNavigationParams(
       const FrameNavigationEntry& frame_entry,
       const scoped_refptr<ResourceRequestBodyImpl>& post_body,
       const GURL& dest_url,
       const Referrer& dest_referrer,
       FrameMsg_Navigate_Type::Value navigation_type,
       LoFiState lofi_state,
@@ skipping 340 matching lines @@
   // 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_