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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim:set ts=2 sw=2 sts=2 et cindent: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef mozilla_dom_NavigateEvent_h_
#define mozilla_dom_NavigateEvent_h_
#include "js/RootingAPI.h"
#include "js/Value.h"
#include "mozilla/AlreadyAddRefed.h"
#include "mozilla/RefPtr.h"
#include "mozilla/dom/AbortController.h"
#include "mozilla/dom/BindingDeclarations.h"
#include "mozilla/dom/Event.h"
#include "mozilla/dom/NavigateEventBinding.h"
#include "mozilla/dom/NavigationPrecommitControllerBinding.h"
#include "nsCycleCollectionParticipant.h"
namespace mozilla::dom {
class AbortController;
class AbortSignal;
class FormData;
class NavigationDestination;
struct NavigationInterceptOptions;
enum class NavigationType : uint8_t;
// https://html.spec.whatwg.org/#the-navigateevent-interface
class NavigateEvent final : public Event {
public:
NS_DECL_ISUPPORTS_INHERITED
NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS_INHERITED(NavigateEvent, Event)
virtual JSObject* WrapObjectInternal(
JSContext* aCx, JS::Handle<JSObject*> aGivenProto) override;
static already_AddRefed<NavigateEvent> Constructor(
const GlobalObject& aGlobal, const nsAString& aType,
const NavigateEventInit& aEventInitDict);
static already_AddRefed<NavigateEvent> Constructor(
EventTarget* aEventTarget, const nsAString& aType,
const NavigateEventInit& aEventInitDict);
static already_AddRefed<NavigateEvent> Constructor(
EventTarget* aEventTarget, const nsAString& aType,
const NavigateEventInit& aEventInitDict,
nsIStructuredCloneContainer* aClassicHistoryAPIState,
AbortController* aAbortController);
enum NavigationType NavigationType() const;
void SetNavigationType(enum NavigationType aNavigationType);
already_AddRefed<NavigationDestination> Destination() const;
bool CanIntercept() const;
bool UserInitiated() const;
bool HashChange() const;
AbortSignal* Signal() const;
already_AddRefed<FormData> GetFormData() const;
void GetDownloadRequest(nsAString& aDownloadRequest) const;
void GetInfo(JSContext* aCx, JS::MutableHandle<JS::Value> aInfo) const;
void SetInfo(JS::Value aInfo) { mInfo = aInfo; }
bool HasUAVisualTransition() const;
Element* GetSourceElement() const;
void Intercept(const NavigationInterceptOptions& aOptions, ErrorResult& aRv);
MOZ_CAN_RUN_SCRIPT
void Scroll(ErrorResult& aRv);
void InitNavigateEvent(const NavigateEventInit& aEventInitDict);
void SetCanIntercept(bool aCanIntercept);
enum class InterceptionState : uint8_t {
None,
Intercepted,
Committed,
Scrolled,
Finished
};
InterceptionState InterceptionState() const;
void SetInterceptionState(enum InterceptionState aInterceptionState);
nsIStructuredCloneContainer* ClassicHistoryAPIState() const;
nsTArray<RefPtr<NavigationInterceptHandler>>& NavigationHandlerList();
dom::AbortController* AbortController() const;
bool IsBeingDispatched() const;
MOZ_CAN_RUN_SCRIPT
void Finish(bool aDidFulfill);
nsTArray<RefPtr<NavigationPrecommitHandler>>&
NavigationPrecommitHandlerList() {
return mNavigationPrecommitHandlerList;
}
void PerformSharedChecks(ErrorResult& aRv);
Document* GetAssociatedDocument() const;
void Cancel();
private:
MOZ_CAN_RUN_SCRIPT
void PotentiallyResetFocus();
MOZ_CAN_RUN_SCRIPT
void PotentiallyProcessScrollBehavior();
MOZ_CAN_RUN_SCRIPT
void ProcessScrollBehavior();
explicit NavigateEvent(EventTarget* aOwner);
~NavigateEvent();
enum NavigationType mNavigationType {};
RefPtr<NavigationDestination> mDestination;
bool mCanIntercept = false;
bool mUserInitiated = false;
bool mHashChange = false;
RefPtr<AbortSignal> mSignal;
RefPtr<FormData> mFormData;
nsString mDownloadRequest;
JS::Heap<JS::Value> mInfo;
bool mHasUAVisualTransition = false;
RefPtr<Element> mSourceElement;
uint32_t mLastScrollGeneration = 0;
nsTArray<RefPtr<NavigationPrecommitHandler>> mNavigationPrecommitHandlerList;
// https://html.spec.whatwg.org/multipage/nav-history-apis.html#the-navigateevent-interface:navigateevent-2
enum InterceptionState mInterceptionState = InterceptionState::None;
// https://html.spec.whatwg.org/multipage/nav-history-apis.html#the-navigateevent-interface:navigateevent-3
nsTArray<RefPtr<NavigationInterceptHandler>> mNavigationHandlerList;
// https://html.spec.whatwg.org/multipage/nav-history-apis.html#the-navigateevent-interface:navigateevent-4
Maybe<NavigationFocusReset> mFocusResetBehavior;
// https://html.spec.whatwg.org/multipage/nav-history-apis.html#the-navigateevent-interface:navigateevent-5
Maybe<NavigationScrollBehavior> mScrollBehavior;
// https://html.spec.whatwg.org/multipage/nav-history-apis.html#the-navigateevent-interface:navigateevent-6
RefPtr<dom::AbortController> mAbortController;
// https://html.spec.whatwg.org/multipage/nav-history-apis.html#the-navigateevent-interface:navigateevent-7
nsCOMPtr<nsIStructuredCloneContainer> mClassicHistoryAPIState;
};
} // namespace mozilla::dom
#endif // mozilla_dom_NavigateEvent_h_
|
