Split the frame tree logic out of HistoryItem

Source/core/loader/HistoryController.h

 /*
  * Copyright (C) 2006, 2007, 2008, 2009 Apple Inc. All rights reserved.
  * Copyright (C) 2008, 2009 Torch Mobile Inc. All rights reserved. (http://www.torchmobile.com/)
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  *
  * 1.  Redistributions of source code must retain the above copyright
  *     notice, this list of conditions and the following disclaimer.
@@ skipping 14 matching lines @@
  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
 #ifndef HistoryController_h
 #define HistoryController_h
 
 #include "core/history/HistoryItem.h"
 #include "core/loader/FrameLoaderTypes.h"
+#include "wtf/HashMap.h"
 #include "wtf/Noncopyable.h"
 #include "wtf/RefPtr.h"
 #include "wtf/text/WTFString.h"
 
 namespace WebCore {
 
 class Frame;
+class HistoryEntry;
+class Page;
 class SerializedScriptValue;
 
+
+class HistoryEntryItem {
+public:
+    static PassOwnPtr<HistoryEntryItem> create(HistoryEntry*, HistoryItem*);
+    ~HistoryEntryItem() { }
+
+    HistoryEntryItem* addChild(PassRefPtr<HistoryItem>);
+    PassOwnPtr<HistoryEntryItem> cloneAndReplace(HistoryEntry*, HistoryItem* newItem, HistoryItem* oldItem, bool clipAtTarget);
+    HistoryItem* value() { return m_value.get(); }
+    const Vector<OwnPtr<HistoryEntryItem> >& children() const;
+
+private:
+    HistoryEntryItem(HistoryEntry*, HistoryItem*);
+
+    Vector<OwnPtr<HistoryEntryItem> > m_children;
+    RefPtr<HistoryItem> m_value;
+    HistoryEntry* m_entry;
+};
+
+class HistoryEntry {
+public:
+    static PassOwnPtr<HistoryEntry> create(HistoryItem* root);
+    PassOwnPtr<HistoryEntry> cloneAndReplace(HistoryItem* newItem, HistoryItem* oldItem, bool clipAtTarget);
+
+    HistoryEntryItem* entryForFrame(Frame*);
+    HistoryItem* itemForFrame(Frame*);
+    HistoryItem* root();
+    HistoryEntryItem* rootEntry();
+
+    HistoryItemVector childrenForItem(HistoryItem*);
+
+private:
+    friend class HistoryEntryItem;
+
+    HistoryEntry() { }
+    explicit HistoryEntry(HistoryItem* root);
+
+    OwnPtr<HistoryEntryItem> m_root;
+    HashMap<String, HistoryEntryItem*> m_framesToItems;
+};
+
 class HistoryController {
     WTF_MAKE_NONCOPYABLE(HistoryController);
 public:
-    explicit HistoryController(Frame*);
+    explicit HistoryController(Page*);
     ~HistoryController();
 
     void clearScrollPositionAndViewState();
-    void restoreScrollPositionAndViewState();
+    void restoreScrollPositionAndViewState(Frame*);
 
-    void updateBackForwardListForFragmentScroll();
+    void updateBackForwardListForFragmentScroll(Frame*);
 
-    void saveDocumentAndScrollState();
-    void restoreDocumentState();
+    void saveDocumentAndScrollState(Frame*);
+    void restoreDocumentState(Frame*);
 
-    void updateForCommit();
-    void updateForSameDocumentNavigation();
+    void updateForCommit(Frame*);
+    void updateForSameDocumentNavigation(Frame*);
 
-    HistoryItem* currentItem() const { return m_currentItem.get(); }
-    void setCurrentItem(HistoryItem*);
-    bool currentItemShouldBeReplaced() const;
+    PassRefPtr<HistoryItem> currentItemForExport(Frame*);
+    PassRefPtr<HistoryItem> previousItemForExport(Frame*);
+    PassRefPtr<HistoryItem> provisionalItemForExport(Frame*);
 
-    HistoryItem* previousItem() const { return m_previousItem.get(); }
+    HistoryItem* currentItem(Frame*) const;
+    bool currentItemShouldBeReplaced(Frame*) const;
 
-    HistoryItem* provisionalItem() const { return m_provisionalItem.get(); }
-    void setProvisionalItem(HistoryItem*);
+    HistoryItem* previousItem() const { return m_previousEntry->root(); }
 
-    void pushState(PassRefPtr<SerializedScriptValue>, const String& url);
-    void replaceState(PassRefPtr<SerializedScriptValue>, const String& url);
+    HistoryItem* provisionalItem(Frame*) const;
+    void clearProvisionalEntry();
+
+    void pushState(Frame*, PassRefPtr<SerializedScriptValue>, const String& url);
+    void replaceState(Frame*, PassRefPtr<SerializedScriptValue>, const String& url);
 
     void setDefersLoading(bool);
 
 private:
     friend class Page;
-    bool shouldStopLoadingForHistoryItem(HistoryItem*) const;
     void goToItem(HistoryItem*);
+    void goToEntry(PassOwnPtr<HistoryEntry>);
 
-    void initializeItem(HistoryItem*);
-    PassRefPtr<HistoryItem> createItem();
-    PassRefPtr<HistoryItem> createItemTree(Frame* targetFrame, bool clipAtTarget);
+    void initializeItem(HistoryItem*, Frame*);
+    PassRefPtr<HistoryItem> createItem(Frame*);
+    HistoryItem* createItemTree(Frame* targetFrame, bool clipAtTarget);
 
-    void updateForStandardLoad();
-    void updateForInitialLoadInChildFrame();
+    void updateForStandardLoad(Frame*);
+    void updateForInitialLoadInChildFrame(Frame*);
 
-    void recursiveSetProvisionalItem(HistoryItem*, HistoryItem*);
-    void recursiveGoToItem(HistoryItem*, HistoryItem*);
-    void recursiveUpdateForCommit();
-    void recursiveUpdateForSameDocumentNavigation();
-    bool itemsAreClones(HistoryItem*, HistoryItem*) const;
-    bool currentFramesMatchItem(HistoryItem*) const;
+    void createNewBackForwardItem(Frame*, bool doClip);
+    void updateWithoutCreatingNewBackForwardItem(Frame*);
 
-    void createNewBackForwardItem(bool doClip);
-    void updateWithoutCreatingNewBackForwardItem();
+    PassRefPtr<HistoryItem> itemForExport(HistoryEntryItem*);
 
-    void clearProvisionalItemsInAllFrames();
+    Page* m_page;
 
-    Frame* m_frame;
-
-    RefPtr<HistoryItem> m_currentItem;
-    RefPtr<HistoryItem> m_previousItem;
-    RefPtr<HistoryItem> m_provisionalItem;
+    OwnPtr<HistoryEntry> m_currentEntry;
+    OwnPtr<HistoryEntry> m_previousEntry;
+    OwnPtr<HistoryEntry> m_provisionalEntry;
 
     bool m_defersLoading;
     RefPtr<HistoryItem> m_deferredItem;
 };
 
 } // namespace WebCore
 
 #endif // HistoryController_h