2011-02-04 Charlie Reis <creis@chromium.org>
[WebKit.git] / Source / WebCore / loader / HistoryController.h
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 {
45     WTF_MAKE_NONCOPYABLE(HistoryController);
46 public:
47     enum HistoryUpdateType { UpdateAll, UpdateAllExceptBackForwardList };
48
49     HistoryController(Frame*);
50     ~HistoryController();
51
52     void saveScrollPositionAndViewStateToItem(HistoryItem*);
53     void restoreScrollPositionAndViewState();
54
55     void updateBackForwardListForFragmentScroll();
56
57     void saveDocumentState();
58     void saveDocumentAndScrollState();
59     void restoreDocumentState();
60
61     void invalidateCurrentItemCachedPage();
62
63     void goToItem(HistoryItem*, FrameLoadType);
64
65     void updateForBackForwardNavigation();
66     void updateForReload();
67     void updateForStandardLoad(HistoryUpdateType updateType = UpdateAll);
68     void updateForRedirectWithLockedBackForwardList();
69     void updateForClientRedirect();
70     void updateForCommit();
71     void updateForSameDocumentNavigation();
72     void updateForFrameLoadCompleted();
73
74     HistoryItem* currentItem() const { return m_currentItem.get(); }
75     void setCurrentItem(HistoryItem*);
76     void setCurrentItemTitle(const String&);
77     bool currentItemShouldBeReplaced() const;
78
79     HistoryItem* previousItem() const { return m_previousItem.get(); }
80
81     HistoryItem* provisionalItem() const { return m_provisionalItem.get(); }
82     void setProvisionalItem(HistoryItem*);
83
84     void pushState(PassRefPtr<SerializedScriptValue>, const String& title, const String& url);
85     void replaceState(PassRefPtr<SerializedScriptValue>, const String& title, const String& url);
86
87 private:
88     void initializeItem(HistoryItem*);
89     PassRefPtr<HistoryItem> createItem();
90     PassRefPtr<HistoryItem> createItemTree(Frame* targetFrame, bool clipAtTarget);
91
92     void recursiveSetProvisionalItem(HistoryItem*, HistoryItem*, FrameLoadType);
93     void recursiveGoToItem(HistoryItem*, HistoryItem*, FrameLoadType);
94     bool isReplaceLoadTypeWithProvisionalItem(FrameLoadType);
95     void recursiveUpdateForCommit();
96     void recursiveUpdateForSameDocumentNavigation();
97     bool itemsAreClones(HistoryItem*, HistoryItem*) const;
98     bool currentFramesMatchItem(HistoryItem*) const;
99     void updateBackForwardListClippedAtTarget(bool doClip);
100     void updateCurrentItem();
101
102     Frame* m_frame;
103
104     RefPtr<HistoryItem> m_currentItem;
105     RefPtr<HistoryItem> m_previousItem;
106     RefPtr<HistoryItem> m_provisionalItem;
107
108     bool m_frameLoadComplete;
109 };
110
111 } // namespace WebCore
112
113 #endif // HistoryController_h