1/*
2 * Copyright (C) 2010 Apple Inc. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 * 1. Redistributions of source code must retain the above copyright
8 *    notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 *    notice, this list of conditions and the following disclaimer in the
11 *    documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23 * THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#ifndef BackForwardController_h
27#define BackForwardController_h
28
29#include <wtf/Noncopyable.h>
30#include <wtf/Forward.h>
31#include <wtf/RefPtr.h>
32
33namespace WebCore {
34
35class BackForwardList;
36class HistoryItem;
37class Page;
38
39class BackForwardController {
40    WTF_MAKE_NONCOPYABLE(BackForwardController); WTF_MAKE_FAST_ALLOCATED;
41public:
42    ~BackForwardController();
43
44    static PassOwnPtr<BackForwardController> create(Page*, PassRefPtr<BackForwardList>);
45
46    BackForwardList* client() const { return m_client.get(); }
47
48    bool canGoBackOrForward(int distance) const;
49    void goBackOrForward(int distance);
50
51    bool goBack();
52    bool goForward();
53
54    void addItem(PassRefPtr<HistoryItem>);
55    void setCurrentItem(HistoryItem*);
56
57    int count() const;
58    int backCount() const;
59    int forwardCount() const;
60
61    HistoryItem* itemAtIndex(int);
62
63    bool isActive();
64
65    void close();
66
67    HistoryItem* backItem() { return itemAtIndex(-1); }
68    HistoryItem* currentItem() { return itemAtIndex(0); }
69    HistoryItem* forwardItem() { return itemAtIndex(1); }
70
71private:
72    BackForwardController(Page*, PassRefPtr<BackForwardList>);
73
74    Page* m_page;
75    RefPtr<BackForwardList> m_client;
76};
77
78} // namespace WebCore
79
80#endif // BackForwardController_h
81