1 /*
2  * Copyright (C) 2006, 2010 Apple Inc. All rights reserved.
3  * Copyright (C) 2008 Torch Mobile Inc. All rights reserved. (http://www.torchmobile.com/)
4  * Copyright (C) 2009 Google, Inc. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
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  *
15  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
16  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
19  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
22  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
23  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  */
27 
28 #ifndef BackForwardListImpl_h
29 #define BackForwardListImpl_h
30 
31 #include "BackForwardList.h"
32 #include <wtf/HashSet.h>
33 #include <wtf/Vector.h>
34 
35 namespace WebCore {
36 
37 class Page;
38 
39 typedef Vector<RefPtr<HistoryItem> > HistoryItemVector;
40 typedef HashSet<RefPtr<HistoryItem> > HistoryItemHashSet;
41 
42 // FIXME: After renaming BackForwardList to BackForwardClient,
43 // rename this to BackForwardList.
44 class BackForwardListImpl : public BackForwardList {
45 public:
create(Page * page)46     static PassRefPtr<BackForwardListImpl> create(Page* page) { return adoptRef(new BackForwardListImpl(page)); }
47     virtual ~BackForwardListImpl();
48 
page()49     Page* page() { return m_page; }
50 
51     virtual void addItem(PassRefPtr<HistoryItem>);
52     void goBack();
53     void goForward();
54     virtual void goToItem(HistoryItem*);
55 
56     HistoryItem* backItem();
57     HistoryItem* currentItem();
58     HistoryItem* forwardItem();
59     virtual HistoryItem* itemAtIndex(int);
60 
61     void backListWithLimit(int, HistoryItemVector&);
62     void forwardListWithLimit(int, HistoryItemVector&);
63 
64     int capacity();
65     void setCapacity(int);
66     bool enabled();
67     void setEnabled(bool);
68     virtual int backListCount();
69     virtual int forwardListCount();
70     bool containsItem(HistoryItem*);
71 
72     virtual void close();
73     bool closed();
74 
75     void removeItem(HistoryItem*);
76     HistoryItemVector& entries();
77 
78 private:
79     BackForwardListImpl(Page*);
80 
isActive()81     virtual bool isActive() { return enabled() && capacity(); }
82 
83     Page* m_page;
84     HistoryItemVector m_entries;
85     HistoryItemHashSet m_entryHash;
86     unsigned m_current;
87     unsigned m_capacity;
88     bool m_closed;
89     bool m_enabled;
90 };
91 
92 } // namespace WebCore
93 
94 #endif // BackForwardListImpl_h
95