HistoryController.h [plain text]
#pragma once
#include "FrameLoaderTypes.h"
#include <wtf/Noncopyable.h>
#include <wtf/RefPtr.h>
#include <wtf/text/WTFString.h>
namespace WebCore {
class Frame;
class HistoryItem;
class SerializedScriptValue;
struct StringWithDirection;
class HistoryController {
WTF_MAKE_NONCOPYABLE(HistoryController);
WTF_MAKE_FAST_ALLOCATED;
public:
enum HistoryUpdateType { UpdateAll, UpdateAllExceptBackForwardList };
explicit HistoryController(Frame&);
~HistoryController();
WEBCORE_EXPORT void saveScrollPositionAndViewStateToItem(HistoryItem*);
void clearScrollPositionAndViewState();
WEBCORE_EXPORT void restoreScrollPositionAndViewState();
void updateBackForwardListForFragmentScroll();
void saveDocumentState();
WEBCORE_EXPORT void saveDocumentAndScrollState();
void restoreDocumentState();
void invalidateCurrentItemCachedPage();
void updateForBackForwardNavigation();
void updateForReload();
void updateForStandardLoad(HistoryUpdateType updateType = UpdateAll);
void updateForRedirectWithLockedBackForwardList();
void updateForClientRedirect();
void updateForCommit();
void updateForSameDocumentNavigation();
void updateForFrameLoadCompleted();
HistoryItem* currentItem() const { return m_currentItem.get(); }
void setCurrentItem(HistoryItem*);
void setCurrentItemTitle(const StringWithDirection&);
bool currentItemShouldBeReplaced() const;
WEBCORE_EXPORT void replaceCurrentItem(HistoryItem*);
HistoryItem* previousItem() const { return m_previousItem.get(); }
void clearPreviousItem();
HistoryItem* provisionalItem() const { return m_provisionalItem.get(); }
void setProvisionalItem(HistoryItem*);
void pushState(RefPtr<SerializedScriptValue>&&, const String& title, const String& url);
void replaceState(RefPtr<SerializedScriptValue>&&, const String& title, const String& url);
void setDefersLoading(bool);
private:
friend class Page;
bool shouldStopLoadingForHistoryItem(HistoryItem&) const;
void goToItem(HistoryItem&, FrameLoadType);
void initializeItem(HistoryItem&);
Ref<HistoryItem> createItem();
Ref<HistoryItem> createItemTree(Frame& targetFrame, bool clipAtTarget);
void recursiveSetProvisionalItem(HistoryItem&, HistoryItem*);
void recursiveGoToItem(HistoryItem&, HistoryItem*, FrameLoadType);
bool isReplaceLoadTypeWithProvisionalItem(FrameLoadType);
bool isReloadTypeWithProvisionalItem(FrameLoadType);
void recursiveUpdateForCommit();
void recursiveUpdateForSameDocumentNavigation();
bool itemsAreClones(HistoryItem&, HistoryItem*) const;
bool currentFramesMatchItem(HistoryItem*) const;
void updateBackForwardListClippedAtTarget(bool doClip);
void updateCurrentItem();
Frame& m_frame;
RefPtr<HistoryItem> m_currentItem;
RefPtr<HistoryItem> m_previousItem;
RefPtr<HistoryItem> m_provisionalItem;
bool m_frameLoadComplete;
bool m_defersLoading;
RefPtr<HistoryItem> m_deferredItem;
FrameLoadType m_deferredFrameLoadType;
};
}