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 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 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 BackForwardList_h
29#define BackForwardList_h
30
31#include "BackForwardClient.h"
32#include <wtf/HashSet.h>
33#include <wtf/Vector.h>
34
35namespace WebCore {
36
37class Page;
38
39typedef Vector<RefPtr<HistoryItem>> HistoryItemVector;
40typedef HashSet<RefPtr<HistoryItem>> HistoryItemHashSet;
41
42class BackForwardList : public BackForwardClient {
43public:
44    static PassRefPtr<BackForwardList> create(Page* page) { return adoptRef(new BackForwardList(page)); }
45    virtual ~BackForwardList();
46
47    Page* page() { return m_page; }
48
49    virtual void addItem(PassRefPtr<HistoryItem>) override;
50    void goBack();
51    void goForward();
52    virtual void goToItem(HistoryItem*) override;
53
54    HistoryItem* backItem();
55    HistoryItem* currentItem();
56    HistoryItem* forwardItem();
57    virtual HistoryItem* itemAtIndex(int) override;
58
59    void backListWithLimit(int, HistoryItemVector&);
60    void forwardListWithLimit(int, HistoryItemVector&);
61
62    int capacity();
63    void setCapacity(int);
64    bool enabled();
65    void setEnabled(bool);
66    virtual int backListCount() override;
67    virtual int forwardListCount() override;
68    bool containsItem(HistoryItem*);
69
70    virtual void close() override;
71    bool closed();
72
73    void removeItem(HistoryItem*);
74    HistoryItemVector& entries();
75
76#if PLATFORM(IOS)
77    virtual unsigned current() override;
78    virtual void setCurrent(unsigned newCurrent) override;
79
80    virtual bool clearAllPageCaches() override;
81#endif
82
83private:
84    explicit BackForwardList(Page*);
85
86    Page* m_page;
87    HistoryItemVector m_entries;
88    HistoryItemHashSet m_entryHash;
89    unsigned m_current;
90    unsigned m_capacity;
91    bool m_closed;
92    bool m_enabled;
93};
94
95} // namespace WebCore
96
97#endif // BackForwardList_h
98