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     enum HistoryUpdateType { UpdateAll, UpdateAllExceptBackForwardList };

    47 

    48     HistoryController(Frame*);

    49     ~HistoryController();

    50 

    51     void saveScrollPositionAndViewStateToItem(HistoryItem*);

    52     void restoreScrollPositionAndViewState();

    53 

    54     void updateBackForwardListForFragmentScroll();

    55 

    56     void saveDocumentState();

    57     void saveDocumentAndScrollState();

    58     void restoreDocumentState();

    59 

    60     void invalidateCurrentItemCachedPage();

    61 

    62     void goToItem(HistoryItem*, FrameLoadType);

    63 

    64     void updateForBackForwardNavigation();

    65     void updateForReload();

    66     void updateForStandardLoad(HistoryUpdateType updateType = UpdateAll);

    67     void updateForRedirectWithLockedBackForwardList();

    68     void updateForClientRedirect();

    69     void updateForCommit();

    70     void updateForSameDocumentNavigation();

    71     void updateForFrameLoadCompleted();

    72 

    73     HistoryItem* currentItem() const { return m_currentItem.get(); }

    74     void setCurrentItem(HistoryItem*);

    75     void setCurrentItemTitle(const String&);

    76     bool currentItemShouldBeReplaced() const;

    77 

    78     HistoryItem* provisionalItem() const { return m_provisionalItem.get(); }

    79     void setProvisionalItem(HistoryItem*);

    80 

    81     void pushState(PassRefPtr<SerializedScriptValue>, const String& title, const String& url);

    82     void replaceState(PassRefPtr<SerializedScriptValue>, const String& title, const String& url);

    83 

    84 private:

    85     PassRefPtr<HistoryItem> createItem(bool useOriginal);

    86     PassRefPtr<HistoryItem> createItemTree(Frame* targetFrame, bool clipAtTarget);

    87 

    88     void recursiveGoToItem(HistoryItem*, HistoryItem*, FrameLoadType);

    89     bool childFramesMatchItem(HistoryItem*) const;

    90     void updateBackForwardListClippedAtTarget(bool doClip);

    91 

    92     Frame* m_frame;

    93 

    94     RefPtr<HistoryItem> m_currentItem;

    95     RefPtr<HistoryItem> m_previousItem;

    96     RefPtr<HistoryItem> m_provisionalItem;

    97 };

    98 

    99 } // namespace WebCore

   100 

   101 #endif // HistoryController_h