1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
|
/*
* Copyright (C) 2010, 2011 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
* THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
* THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include "APIObject.h"
#include "WebBackForwardListItem.h"
#include <WebCore/BackForwardItemIdentifier.h>
#include <wtf/Ref.h>
#include <wtf/Vector.h>
#include <wtf/WeakPtr.h>
namespace API {
class Array;
}
namespace WebKit {
class WebPageProxy;
struct BackForwardListState;
struct WebBackForwardListCounts;
class WebBackForwardList : public API::ObjectImpl<API::Object::Type::BackForwardList> {
public:
static Ref<WebBackForwardList> create(WebPageProxy& page)
{
return adoptRef(*new WebBackForwardList(page));
}
void pageClosed();
virtual ~WebBackForwardList();
WebBackForwardListItem* itemForID(WebCore::BackForwardItemIdentifier);
void addItem(Ref<WebBackForwardListItem>&&);
void goToItem(WebBackForwardListItem&);
void removeAllItems();
void clear();
WebBackForwardListItem* currentItem() const;
RefPtr<WebBackForwardListItem> protectedCurrentItem() const;
WebBackForwardListItem* provisionalItem() const;
WebBackForwardListItem* backItem() const;
WebBackForwardListItem* forwardItem() const;
WebBackForwardListItem* itemAtIndex(int) const;
RefPtr<WebBackForwardListItem> goBackItemSkippingItemsWithoutUserGesture() const;
RefPtr<WebBackForwardListItem> goForwardItemSkippingItemsWithoutUserGesture() const;
const BackForwardListItemVector& entries() const { return m_entries; }
unsigned backListCount() const;
unsigned forwardListCount() const;
WebBackForwardListCounts counts() const;
Ref<API::Array> backList() const;
Ref<API::Array> forwardList() const;
Ref<API::Array> backListAsAPIArrayWithLimit(unsigned limit) const;
Ref<API::Array> forwardListAsAPIArrayWithLimit(unsigned limit) const;
BackForwardListState backForwardListState(WTF::Function<bool (WebBackForwardListItem&)>&&) const;
void restoreFromState(BackForwardListState);
void setItemsAsRestoredFromSession();
void setItemsAsRestoredFromSessionIf(NOESCAPE Function<bool(WebBackForwardListItem&)>&&);
void goToProvisionalItem(WebBackForwardListItem&);
void clearProvisionalItem(WebBackForwardListFrameItem&);
void commitProvisionalItem();
Ref<FrameState> completeFrameStateForNavigation(Ref<FrameState>&&);
#if !LOG_DISABLED
String loggingString();
#endif
private:
explicit WebBackForwardList(WebPageProxy&);
void didRemoveItem(WebBackForwardListItem&);
void goToItemInternal(WebBackForwardListItem&, std::optional<size_t>& indexToUpdate);
std::optional<size_t> provisionalOrCurrentIndex() const { return m_provisionalIndex ? m_provisionalIndex : m_currentIndex; }
void setProvisionalOrCurrentIndex(size_t);
RefPtr<WebPageProxy> protectedPage();
WeakPtr<WebPageProxy> m_page;
BackForwardListItemVector m_entries;
std::optional<size_t> m_currentIndex;
std::optional<size_t> m_provisionalIndex;
};
} // namespace WebKit
|
