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 
33 namespace WebCore {
34 
35 class BackForwardList;
36 class HistoryItem;
37 class Page;
38 
39 class BackForwardController {
40     WTF_MAKE_NONCOPYABLE(BackForwardController); WTF_MAKE_FAST_ALLOCATED;
41 public:
42     BackForwardController(Page*, PassRefPtr<BackForwardList>);
43     ~BackForwardController();
44 
client()45     BackForwardList* client() const { return m_client.get(); }
46 
47     bool canGoBackOrForward(int distance) const;
48     void goBackOrForward(int distance);
49 
50     bool goBack();
51     bool goForward();
52 
53     void addItem(PassRefPtr<HistoryItem>);
54     void setCurrentItem(HistoryItem*);
55 
56     int count() const;
57     int backCount() const;
58     int forwardCount() const;
59 
60     HistoryItem* itemAtIndex(int);
61 
62     bool isActive();
63 
64     void close();
65 
backItem()66     HistoryItem* backItem() { return itemAtIndex(-1); }
currentItem()67     HistoryItem* currentItem() { return itemAtIndex(0); }
forwardItem()68     HistoryItem* forwardItem() { return itemAtIndex(1); }
69 
70 private:
71     Page* m_page;
72     RefPtr<BackForwardList> m_client;
73 };
74 
75 } // namespace WebCore
76 
77 #endif // BackForwardController_h
78