code.vuplus.com Git - vuplus_webkit/blob - 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 "SerializedScriptValue.h"
  36 #include <wtf/Noncopyable.h>
  37 #include <wtf/RefPtr.h>
  38
  39 namespace WebCore {
  40
  41 class Frame;
  42 class HistoryItem;
  43 class SerializedScriptValue;
  44 class StringWithDirection;
  45
  46 class HistoryController {
  47     WTF_MAKE_NONCOPYABLE(HistoryController);
  48 public:
  49     enum HistoryUpdateType { UpdateAll, UpdateAllExceptBackForwardList };
  50
  51     HistoryController(Frame*);
  52     ~HistoryController();
  53
  54     void saveScrollPositionAndViewStateToItem(HistoryItem*);
  55     void restoreScrollPositionAndViewState();
  56
  57     void updateBackForwardListForFragmentScroll();
  58
  59     void saveDocumentState();
  60     void saveDocumentAndScrollState();
  61     void restoreDocumentState();
  62
  63     void invalidateCurrentItemCachedPage();
  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 StringWithDirection&);
  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     void setDefersLoading(bool);
  88
  89 private:
  90     friend class Page;
  91     bool shouldStopLoadingForHistoryItem(HistoryItem*) const;
  92     void goToItem(HistoryItem*, FrameLoadType);
  93
  94     void initializeItem(HistoryItem*);
  95     PassRefPtr<HistoryItem> createItem();
  96     PassRefPtr<HistoryItem> createItemTree(Frame* targetFrame, bool clipAtTarget);
  97
  98     void recursiveSetProvisionalItem(HistoryItem*, HistoryItem*, FrameLoadType);
  99     void recursiveGoToItem(HistoryItem*, HistoryItem*, FrameLoadType);
 100     bool isReplaceLoadTypeWithProvisionalItem(FrameLoadType);
 101     void recursiveUpdateForCommit();
 102     void recursiveUpdateForSameDocumentNavigation();
 103     bool itemsAreClones(HistoryItem*, HistoryItem*) const;
 104     bool currentFramesMatchItem(HistoryItem*) const;
 105     void updateBackForwardListClippedAtTarget(bool doClip);
 106     void updateCurrentItem();
 107
 108     Frame* m_frame;
 109
 110     RefPtr<HistoryItem> m_currentItem;
 111     RefPtr<HistoryItem> m_previousItem;
 112     RefPtr<HistoryItem> m_provisionalItem;
 113
 114     bool m_frameLoadComplete;
 115
 116     bool m_defersLoading;
 117     RefPtr<HistoryItem> m_deferredItem;
 118     FrameLoadType m_deferredFrameLoadType;
 119 };
 120
 121 } // namespace WebCore
 122
 123 #endif // HistoryController_h