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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
/*
* Copyright (C) 2010-2022 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 "DownloadID.h"
#include "IdentifierTypes.h"
#include "PolicyDecision.h"
#include "ShareableBitmap.h"
#include "TransactionID.h"
#include "WKBase.h"
#include "WebFrameLoaderClient.h"
#include <JavaScriptCore/ConsoleTypes.h>
#include <JavaScriptCore/JSBase.h>
#include <WebCore/FrameLoaderClient.h>
#include <WebCore/FrameLoaderTypes.h>
#include <WebCore/HitTestRequest.h>
#include <wtf/Forward.h>
#include <wtf/HashMap.h>
#include <wtf/RefPtr.h>
#include <wtf/RetainPtr.h>
#include <wtf/WeakPtr.h>
namespace API {
class Array;
}
namespace WebCore {
class CertificateInfo;
class Frame;
class HTMLFrameOwnerElement;
class IntPoint;
class IntRect;
}
namespace WebKit {
class InjectedBundleCSSStyleDeclarationHandle;
class InjectedBundleHitTestResult;
class InjectedBundleNodeHandle;
class InjectedBundleRangeHandle;
class InjectedBundleScriptWorld;
class WebImage;
class WebPage;
struct FrameInfoData;
struct WebsitePoliciesData;
class WebFrame : public API::ObjectImpl<API::Object::Type::BundleFrame>, public CanMakeWeakPtr<WebFrame> {
public:
static Ref<WebFrame> create() { return adoptRef(*new WebFrame); }
static Ref<WebFrame> createSubframe(WebPage*, const AtomString& frameName, WebCore::HTMLFrameOwnerElement*);
~WebFrame();
void initWithCoreMainFrame(WebPage&, WebCore::Frame&);
// Called when the FrameLoaderClient (and therefore the WebCore::Frame) is being torn down.
void invalidate();
WebPage* page() const;
static WebFrame* fromCoreFrame(const WebCore::Frame&);
WebCore::Frame* coreFrame() const;
FrameInfoData info() const;
WebCore::FrameIdentifier frameID() const { return m_frameID; }
enum class ForNavigationAction { No, Yes };
uint64_t setUpPolicyListener(WebCore::PolicyCheckIdentifier, WebCore::FramePolicyFunction&&, ForNavigationAction);
void invalidatePolicyListeners();
void didReceivePolicyDecision(uint64_t listenerID, PolicyDecision&&);
FormSubmitListenerIdentifier setUpWillSubmitFormListener(CompletionHandler<void()>&&);
void continueWillSubmitForm(FormSubmitListenerIdentifier);
void startDownload(const WebCore::ResourceRequest&, const String& suggestedName = { });
void convertMainResourceLoadToDownload(WebCore::DocumentLoader*, const WebCore::ResourceRequest&, const WebCore::ResourceResponse&);
void addConsoleMessage(MessageSource, MessageLevel, const String&, uint64_t requestID = 0);
String source() const;
String contentsAsString() const;
String selectionAsString() const;
WebCore::IntSize size() const;
// WKBundleFrame API and SPI functions
bool isMainFrame() const;
String name() const;
URL url() const;
WebCore::CertificateInfo certificateInfo() const;
String innerText() const;
bool isFrameSet() const;
WebFrame* parentFrame() const;
Ref<API::Array> childFrames();
JSGlobalContextRef jsContext();
JSGlobalContextRef jsContextForWorld(InjectedBundleScriptWorld*);
JSGlobalContextRef jsContextForServiceWorkerWorld(InjectedBundleScriptWorld*);
WebCore::IntRect contentBounds() const;
WebCore::IntRect visibleContentBounds() const;
WebCore::IntRect visibleContentBoundsExcludingScrollbars() const;
WebCore::IntSize scrollOffset() const;
bool hasHorizontalScrollbar() const;
bool hasVerticalScrollbar() const;
static constexpr OptionSet<WebCore::HitTestRequest::Type> defaultHitTestRequestTypes()
{
return {{
WebCore::HitTestRequest::Type::ReadOnly,
WebCore::HitTestRequest::Type::Active,
WebCore::HitTestRequest::Type::IgnoreClipping,
WebCore::HitTestRequest::Type::AllowChildFrameContent,
WebCore::HitTestRequest::Type::DisallowUserAgentShadowContent,
}};
}
RefPtr<InjectedBundleHitTestResult> hitTest(const WebCore::IntPoint, OptionSet<WebCore::HitTestRequest::Type> = defaultHitTestRequestTypes()) const;
bool getDocumentBackgroundColor(double* red, double* green, double* blue, double* alpha);
bool containsAnyFormElements() const;
bool containsAnyFormControls() const;
void stopLoading();
void setAccessibleName(const AtomString&);
static WebFrame* frameForContext(JSContextRef);
static WebFrame* contentFrameForWindowOrFrameElement(JSContextRef, JSValueRef);
JSValueRef jsWrapperForWorld(InjectedBundleCSSStyleDeclarationHandle*, InjectedBundleScriptWorld*);
JSValueRef jsWrapperForWorld(InjectedBundleNodeHandle*, InjectedBundleScriptWorld*);
JSValueRef jsWrapperForWorld(InjectedBundleRangeHandle*, InjectedBundleScriptWorld*);
static String counterValue(JSObjectRef element);
String layerTreeAsText() const;
unsigned pendingUnloadCount() const;
bool allowsFollowingLink(const URL&) const;
String provisionalURL() const;
String suggestedFilenameForResourceWithURL(const URL&) const;
String mimeTypeForResourceWithURL(const URL&) const;
void setTextDirection(const String&);
void documentLoaderDetached(uint64_t navigationID);
// Simple listener class used by plug-ins to know when frames finish or fail loading.
class LoadListener : public CanMakeWeakPtr<LoadListener> {
public:
virtual ~LoadListener() { }
virtual void didFinishLoad(WebFrame*) = 0;
virtual void didFailLoad(WebFrame*, bool wasCancelled) = 0;
};
void setLoadListener(LoadListener* loadListener) { m_loadListener = loadListener; }
LoadListener* loadListener() const { return m_loadListener.get(); }
#if PLATFORM(COCOA)
typedef bool (*FrameFilterFunction)(WKBundleFrameRef, WKBundleFrameRef subframe, void* context);
RetainPtr<CFDataRef> webArchiveData(FrameFilterFunction, void* context);
#endif
RefPtr<WebImage> createSelectionSnapshot() const;
#if PLATFORM(IOS_FAMILY)
TransactionID firstLayerTreeTransactionIDAfterDidCommitLoad() const { return m_firstLayerTreeTransactionIDAfterDidCommitLoad; }
void setFirstLayerTreeTransactionIDAfterDidCommitLoad(TransactionID transactionID) { m_firstLayerTreeTransactionIDAfterDidCommitLoad = transactionID; }
#endif
WebFrameLoaderClient* frameLoaderClient() const;
#if ENABLE(APP_BOUND_DOMAINS)
bool shouldEnableInAppBrowserPrivacyProtections();
void setIsNavigatingToAppBoundDomain(std::optional<NavigatingToAppBoundDomain> isNavigatingToAppBoundDomain) { m_isNavigatingToAppBoundDomain = isNavigatingToAppBoundDomain; };
std::optional<NavigatingToAppBoundDomain> isNavigatingToAppBoundDomain() const { return m_isNavigatingToAppBoundDomain; }
std::optional<NavigatingToAppBoundDomain> isTopFrameNavigatingToAppBoundDomain() const;
#endif
private:
WebFrame();
WeakPtr<WebCore::Frame> m_coreFrame;
struct PolicyCheck {
WebCore::PolicyCheckIdentifier corePolicyIdentifier;
ForNavigationAction forNavigationAction { ForNavigationAction::No };
WebCore::FramePolicyFunction policyFunction;
};
HashMap<uint64_t, PolicyCheck> m_pendingPolicyChecks;
HashMap<FormSubmitListenerIdentifier, CompletionHandler<void()>> m_willSubmitFormCompletionHandlers;
std::optional<DownloadID> m_policyDownloadID;
WeakPtr<LoadListener> m_loadListener;
WebCore::FrameIdentifier m_frameID;
#if PLATFORM(IOS_FAMILY)
TransactionID m_firstLayerTreeTransactionIDAfterDidCommitLoad;
#endif
std::optional<NavigatingToAppBoundDomain> m_isNavigatingToAppBoundDomain;
};
} // namespace WebKit
|
