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 "PlatformString.h" 35 #include <wtf/Noncopyable.h> 36 #include <wtf/RefPtr.h> 37 38 namespace WebCore { 39 40 class Frame; 41 class HistoryItem; 42 class SerializedScriptValue; 43 44 class HistoryController : public Noncopyable { 45 public: 46 HistoryController(Frame*); 47 ~HistoryController(); 48 49 void saveScrollPositionAndViewStateToItem(HistoryItem*); 50 void restoreScrollPositionAndViewState(); 51 52 void updateBackForwardListForFragmentScroll(); 53 54 void saveDocumentState(); 55 void saveDocumentAndScrollState(); 56 void restoreDocumentState(); 57 58 void invalidateCurrentItemCachedPage(); 59 60 void goToItem(HistoryItem*, FrameLoadType); 61 bool urlsMatchItem(HistoryItem*) const; 62 63 void updateForBackForwardNavigation(); 64 void updateForReload(); 65 void updateForStandardLoad(); 66 void updateForRedirectWithLockedBackForwardList(); 67 void updateForClientRedirect(); 68 void updateForCommit(); 69 void updateForSameDocumentNavigation(); 70 void updateForFrameLoadCompleted(); 71 72 HistoryItem* currentItem() const { return m_currentItem.get(); } 73 void setCurrentItem(HistoryItem*); 74 void setCurrentItemTitle(const String&); 75 76 HistoryItem* provisionalItem() const { return m_provisionalItem.get(); } 77 void setProvisionalItem(HistoryItem*); 78 79 void pushState(PassRefPtr<SerializedScriptValue>, const String& title, const String& url); 80 void replaceState(PassRefPtr<SerializedScriptValue>, const String& title, const String& url); 81 82 private: 83 PassRefPtr<HistoryItem> createItem(bool useOriginal); 84 PassRefPtr<HistoryItem> createItemTree(Frame* targetFrame, bool clipAtTarget); 85 86 void recursiveGoToItem(HistoryItem*, HistoryItem*, FrameLoadType); 87 bool childFramesMatchItem(HistoryItem*) const; 88 void updateBackForwardListClippedAtTarget(bool doClip); 89 90 Frame* m_frame; 91 92 RefPtr<HistoryItem> m_currentItem; 93 RefPtr<HistoryItem> m_previousItem; 94 RefPtr<HistoryItem> m_provisionalItem; 95 }; 96 97 } // namespace WebCore 98 99 #endif // HistoryController_h 100
