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
|
/*
* Copyright (C) 2023 Igalia S.L. 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 "DOMPromiseProxy.h"
#include "EventTarget.h"
#include "JSDOMPromise.h"
#include "LocalDOMWindowProperty.h"
#include "NavigationHistoryEntry.h"
#include "NavigationTransition.h"
#include <JavaScriptCore/JSCJSValue.h>
namespace WebCore {
class HistoryItem;
class Navigation final : public RefCounted<Navigation>, public EventTarget, public ContextDestructionObserver, public LocalDOMWindowProperty {
WTF_MAKE_ISO_ALLOCATED(Navigation);
public:
~Navigation();
static Ref<Navigation> create(ScriptExecutionContext* context, LocalDOMWindow& window) { return adoptRef(*new Navigation(context, window)); }
using RefCounted<Navigation>::ref;
using RefCounted<Navigation>::deref;
enum class HistoryBehavior : uint8_t {
Auto,
Push,
Replace,
};
struct UpdateCurrentEntryOptions {
JSC::JSValue state;
};
struct Options {
JSC::JSValue info;
};
struct NavigateOptions : Options {
JSC::JSValue state;
HistoryBehavior history;
};
struct ReloadOptions : Options {
JSC::JSValue state;
};
struct Result {
RefPtr<DOMPromise> committed;
RefPtr<DOMPromise> finished;
};
const Vector<Ref<NavigationHistoryEntry>>& entries() const;
NavigationHistoryEntry* currentEntry() const;
RefPtr<NavigationTransition> transition() { return m_transition; };
bool canGoBack() const { return m_canGoBack; };
bool canGoForward() const { return m_canGoForward; };
void initializeEntries(const Ref<HistoryItem>& currentItem, const Vector<Ref<HistoryItem>> &items);
Result navigate(const String& url, NavigateOptions&&, Ref<DeferredPromise>&&, Ref<DeferredPromise>&&);
Result reload(ReloadOptions&&, Ref<DeferredPromise>&&, Ref<DeferredPromise>&&);
Result traverseTo(const String& key, Options&&, Ref<DeferredPromise>&&, Ref<DeferredPromise>&&);
Result back(Options&&, Ref<DeferredPromise>&&, Ref<DeferredPromise>&&);
Result forward(Options&&, Ref<DeferredPromise>&&, Ref<DeferredPromise>&&);
void updateCurrentEntry(UpdateCurrentEntryOptions&&);
private:
Navigation(ScriptExecutionContext*, LocalDOMWindow&);
EventTargetInterface eventTargetInterface() const final;
ScriptExecutionContext* scriptExecutionContext() const final;
void refEventTarget() final { ref(); }
void derefEventTarget() final { deref(); }
bool hasEntriesAndEventsDisabled() const;
int m_currentEntryIndex { -1 };
RefPtr<NavigationTransition> m_transition;
bool m_canGoBack { false };
bool m_canGoForward { false };
Vector<Ref<NavigationHistoryEntry>> m_entries;
};
} // namespace WebCore
|
