1/*
2 * Copyright (C) 2006 Apple Computer, 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 BackForwardList_h
29#define BackForwardList_h
30
31#include <wtf/RefCounted.h>
32#include <wtf/PassRefPtr.h>
33#include <wtf/HashSet.h>
34#include <wtf/Vector.h>
35
36namespace WebCore {
37
38class Document;
39class HistoryItem;
40class Page;
41class SerializedScriptValue;
42class String;
43
44typedef Vector<RefPtr<HistoryItem> > HistoryItemVector;
45typedef HashSet<RefPtr<HistoryItem> > HistoryItemHashSet;
46
47#if PLATFORM(CHROMIUM)
48// In the Chromium port, the back/forward list is managed externally.
49// See BackForwardListChromium.cpp
50class BackForwardListClient {
51public:
52    virtual ~BackForwardListClient() {}
53    virtual void addItem(PassRefPtr<HistoryItem>) = 0;
54    virtual void goToItem(HistoryItem*) = 0;
55    virtual HistoryItem* currentItem() = 0;
56    virtual HistoryItem* itemAtIndex(int) = 0;
57    virtual int backListCount() = 0;
58    virtual int forwardListCount() = 0;
59    virtual void close() = 0;
60};
61#endif
62
63class BackForwardList : public RefCounted<BackForwardList> {
64public:
65    static PassRefPtr<BackForwardList> create(Page* page) { return adoptRef(new BackForwardList(page)); }
66    ~BackForwardList();
67
68#if PLATFORM(CHROMIUM)
69    // Must be called before any other methods.
70    void setClient(BackForwardListClient* client) { m_client = client; }
71#endif
72
73    Page* page() { return m_page; }
74
75    void addItem(PassRefPtr<HistoryItem>);
76    void goBack();
77    void goForward();
78    void goToItem(HistoryItem*);
79
80    HistoryItem* backItem();
81    HistoryItem* currentItem();
82    HistoryItem* forwardItem();
83    HistoryItem* itemAtIndex(int);
84
85    void backListWithLimit(int, HistoryItemVector&);
86    void forwardListWithLimit(int, HistoryItemVector&);
87
88    int capacity();
89    void setCapacity(int);
90    bool enabled();
91    void setEnabled(bool);
92    int backListCount();
93    int forwardListCount();
94    bool containsItem(HistoryItem*);
95
96    void close();
97    bool closed();
98
99    void removeItem(HistoryItem*);
100    HistoryItemVector& entries();
101
102    void pushStateItem(PassRefPtr<HistoryItem>);
103
104#if ENABLE(WML)
105    void clearWMLPageHistory();
106#endif
107
108private:
109    BackForwardList(Page*);
110
111    Page* m_page;
112#if PLATFORM(CHROMIUM)
113    BackForwardListClient* m_client;
114#else
115    HistoryItemVector m_entries;
116    HistoryItemHashSet m_entryHash;
117    unsigned m_current;
118#endif
119    unsigned m_capacity;
120    bool m_closed;
121    bool m_enabled;
122};
123
124} //namespace WebCore
125
126#endif
127