1/* 2 * Copyright (C) 2006, 2007, 2008, 2009 Apple Inc. All rights reserved. 3 * Copyright (C) 2008, 2009 Torch Mobile Inc. All rights reserved. (http://www.torchmobile.com/) 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 3. Neither the name of Apple Computer, Inc. ("Apple") nor the names of 15 * its contributors may be used to endorse or promote products derived 16 * from this software without specific prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY 19 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 20 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 21 * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY 22 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 23 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 24 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 25 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 26 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 27 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28 */ 29 30#ifndef HistoryController_h 31#define HistoryController_h 32 33#include "FrameLoaderTypes.h" 34#include "SerializedScriptValue.h" 35#include <wtf/Noncopyable.h> 36#include <wtf/RefPtr.h> 37#include <wtf/text/WTFString.h> 38 39namespace WebCore { 40 41class Frame; 42class HistoryItem; 43class SerializedScriptValue; 44class StringWithDirection; 45 46class HistoryController { 47 WTF_MAKE_NONCOPYABLE(HistoryController); 48public: 49 enum HistoryUpdateType { UpdateAll, UpdateAllExceptBackForwardList }; 50 51 explicit HistoryController(Frame*); 52 ~HistoryController(); 53 54 void saveScrollPositionAndViewStateToItem(HistoryItem*); 55 void clearScrollPositionAndViewState(); 56 void restoreScrollPositionAndViewState(); 57 58 void updateBackForwardListForFragmentScroll(); 59 60 void saveDocumentState(); 61 void saveDocumentAndScrollState(); 62 void restoreDocumentState(); 63 64 void invalidateCurrentItemCachedPage(); 65 66 void updateForBackForwardNavigation(); 67 void updateForReload(); 68 void updateForStandardLoad(HistoryUpdateType updateType = UpdateAll); 69 void updateForRedirectWithLockedBackForwardList(); 70 void updateForClientRedirect(); 71 void updateForCommit(); 72 void updateForSameDocumentNavigation(); 73 void updateForFrameLoadCompleted(); 74 75 HistoryItem* currentItem() const { return m_currentItem.get(); } 76 void setCurrentItem(HistoryItem*); 77 void setCurrentItemTitle(const StringWithDirection&); 78 bool currentItemShouldBeReplaced() const; 79 80 HistoryItem* previousItem() const { return m_previousItem.get(); } 81 82 HistoryItem* provisionalItem() const { return m_provisionalItem.get(); } 83 void setProvisionalItem(HistoryItem*); 84 85 void pushState(PassRefPtr<SerializedScriptValue>, const String& title, const String& url); 86 void replaceState(PassRefPtr<SerializedScriptValue>, const String& title, const String& url); 87 88 void setDefersLoading(bool); 89 90private: 91 friend class Page; 92 bool shouldStopLoadingForHistoryItem(HistoryItem*) const; 93 void goToItem(HistoryItem*, FrameLoadType); 94 95 void initializeItem(HistoryItem*); 96 PassRefPtr<HistoryItem> createItem(); 97 PassRefPtr<HistoryItem> createItemTree(Frame* targetFrame, bool clipAtTarget); 98 99 void recursiveSetProvisionalItem(HistoryItem*, HistoryItem*, FrameLoadType); 100 void recursiveGoToItem(HistoryItem*, HistoryItem*, FrameLoadType); 101 bool isReplaceLoadTypeWithProvisionalItem(FrameLoadType); 102 bool isReloadTypeWithProvisionalItem(FrameLoadType); 103 void recursiveUpdateForCommit(); 104 void recursiveUpdateForSameDocumentNavigation(); 105 bool itemsAreClones(HistoryItem*, HistoryItem*) const; 106 bool currentFramesMatchItem(HistoryItem*) const; 107 void updateBackForwardListClippedAtTarget(bool doClip); 108 void updateCurrentItem(); 109 110 Frame* m_frame; 111 112 RefPtr<HistoryItem> m_currentItem; 113 RefPtr<HistoryItem> m_previousItem; 114 RefPtr<HistoryItem> m_provisionalItem; 115 116 bool m_frameLoadComplete; 117 118 bool m_defersLoading; 119 RefPtr<HistoryItem> m_deferredItem; 120 FrameLoadType m_deferredFrameLoadType; 121}; 122 123} // namespace WebCore 124 125#endif // HistoryController_h 126