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
120
121
122
123
124
125
126
127
128
|
/*
* 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 "AbortController.h"
#include "AbortSignal.h"
#include "DOMFormData.h"
#include "Event.h"
#include "EventInit.h"
#include "JSValueInWrappedObject.h"
#include "LocalDOMWindowProperty.h"
#include "NavigationDestination.h"
#include "NavigationInterceptHandler.h"
#include "NavigationNavigationType.h"
namespace WebCore {
enum class InterceptionState : uint8_t {
Intercepted,
Committed,
Scrolled,
Finished,
};
class NavigateEvent final : public Event {
WTF_MAKE_TZONE_OR_ISO_ALLOCATED(NavigateEvent);
public:
struct Init : EventInit {
NavigationNavigationType navigationType { NavigationNavigationType::Push };
RefPtr<NavigationDestination> destination;
RefPtr<AbortSignal> signal;
RefPtr<DOMFormData> formData;
String downloadRequest;
JSC::JSValue info;
bool canIntercept { false };
bool userInitiated { false };
bool hashChange { false };
bool hasUAVisualTransition { false };
};
enum class NavigationFocusReset : bool {
AfterTransition,
Manual,
};
enum class NavigationScrollBehavior : bool {
AfterTransition,
Manual,
};
struct NavigationInterceptOptions {
RefPtr<NavigationInterceptHandler> handler;
std::optional<NavigationFocusReset> focusReset;
std::optional<NavigationScrollBehavior> scroll;
};
static Ref<NavigateEvent> create(const AtomString& type, const Init&);
static Ref<NavigateEvent> create(const AtomString& type, const Init&, AbortController*);
NavigationNavigationType navigationType() const { return m_navigationType; }
bool canIntercept() const { return m_canIntercept; }
bool userInitiated() const { return m_userInitiated; }
bool hashChange() const { return m_hashChange; }
bool hasUAVisualTransition() const { return m_hasUAVisualTransition; }
NavigationDestination* destination() { return m_destination.get(); }
AbortSignal* signal() { return m_signal.get(); }
DOMFormData* formData() { return m_formData.get(); }
String downloadRequest() { return m_downloadRequest; }
JSC::JSValue info() { return m_info.getValue(); }
JSValueInWrappedObject& infoWrapper() { return m_info; }
ExceptionOr<void> intercept(Document&, NavigationInterceptOptions&&);
ExceptionOr<void> scroll(Document&);
bool wasIntercepted() const { return m_interceptionState.has_value(); }
void setCanIntercept(bool canIntercept) { m_canIntercept = canIntercept; }
void setInterceptionState(InterceptionState interceptionState) { m_interceptionState = interceptionState; }
void finish();
Vector<Ref<NavigationInterceptHandler>>& handlers() { return m_handlers; }
private:
NavigateEvent(const AtomString& type, const Init&, AbortController*);
ExceptionOr<void> sharedChecks(Document&);
NavigationNavigationType m_navigationType;
RefPtr<NavigationDestination> m_destination;
RefPtr<AbortSignal> m_signal;
RefPtr<DOMFormData> m_formData;
String m_downloadRequest;
Vector<Ref<NavigationInterceptHandler>> m_handlers;
JSValueInWrappedObject m_info;
bool m_canIntercept { false };
bool m_userInitiated { false };
bool m_hashChange { false };
bool m_hasUAVisualTransition { false };
std::optional<InterceptionState> m_interceptionState;
std::optional<NavigationFocusReset> m_focusReset;
std::optional<NavigationScrollBehavior> m_scrollBehavior;
RefPtr<AbortController> m_abortController;
};
} // namespace WebCore
|
