fcdaf03d3b2fac8524ca87038c6393451931093b
[WebKit-https.git] / Source / WebKit / UIProcess / WebBackForwardList.h
1 /*
2  * Copyright (C) 2010, 2011 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 #pragma once
27
28 #include "APIObject.h"
29 #include "WebBackForwardListItem.h"
30 #include "WebPageProxy.h"
31 #include <wtf/Ref.h>
32 #include <wtf/Vector.h>
33
34 namespace WebKit {
35
36 struct BackForwardListState;
37
38 class WebBackForwardList : public API::ObjectImpl<API::Object::Type::BackForwardList> {
39 public:
40     static Ref<WebBackForwardList> create(WebPageProxy& page)
41     {
42         return adoptRef(*new WebBackForwardList(page));
43     }
44     void pageClosed();
45
46     virtual ~WebBackForwardList();
47
48     void addItem(WebBackForwardListItem*);
49     void goToItem(WebBackForwardListItem&);
50     void removeAllItems();
51     void clear();
52
53     WebBackForwardListItem* currentItem() const;
54     WebBackForwardListItem* backItem() const;
55     WebBackForwardListItem* forwardItem() const;
56     WebBackForwardListItem* itemAtIndex(int) const;
57
58     const BackForwardListItemVector& entries() const { return m_entries; }
59
60     uint32_t currentIndex() const { return m_currentIndex; }
61     int backListCount() const;
62     int forwardListCount() const;
63
64     Ref<API::Array> backList() const;
65     Ref<API::Array> forwardList() const;
66
67     Ref<API::Array> backListAsAPIArrayWithLimit(unsigned limit) const;
68     Ref<API::Array> forwardListAsAPIArrayWithLimit(unsigned limit) const;
69
70     BackForwardListState backForwardListState(WTF::Function<bool (WebBackForwardListItem&)>&&) const;
71     void restoreFromState(BackForwardListState);
72
73     Vector<BackForwardListItemState> itemStates() const;
74
75 private:
76     explicit WebBackForwardList(WebPageProxy&);
77
78     void didRemoveItem(WebBackForwardListItem&);
79
80     WebPageProxy* m_page;
81     BackForwardListItemVector m_entries;
82     
83     // FIXME: m_currentIndex should be a std::optional<size_t>
84     bool m_hasCurrentIndex;
85     size_t m_currentIndex;
86     size_t m_capacity;
87 };
88
89 } // namespace WebKit