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
|
// Copyright 2014 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef WebLocalFrame_h
#define WebLocalFrame_h
#include "WebFrame.h"
#include "WebFrameLoadType.h"
namespace blink {
enum class WebAppBannerPromptReply;
enum class WebSandboxFlags;
enum class WebTreeScopeType;
class WebAutofillClient;
class WebContentSettingsClient;
class WebDevToolsAgent;
class WebDevToolsAgentClient;
class WebFrameClient;
class WebNode;
class WebScriptExecutionCallback;
class WebSuspendableTask;
class WebTestInterfaceFactory;
struct WebPrintPresetOptions;
// Interface for interacting with in process frames. This contains methods that
// require interacting with a frame's document.
// FIXME: Move lots of methods from WebFrame in here.
class WebLocalFrame : public WebFrame {
public:
// Creates a WebFrame. Delete this WebFrame by calling WebFrame::close().
// It is valid to pass a null client pointer.
BLINK_EXPORT static WebLocalFrame* create(WebTreeScopeType, WebFrameClient*);
// Returns the WebFrame associated with the current V8 context. This
// function can return 0 if the context is associated with a Document that
// is not currently being displayed in a Frame.
BLINK_EXPORT static WebLocalFrame* frameForCurrentContext();
// Returns the frame corresponding to the given context. This can return 0
// if the context is detached from the frame, or if the context doesn't
// correspond to a frame (e.g., workers).
BLINK_EXPORT static WebLocalFrame* frameForContext(v8::Local<v8::Context>);
// Returns the frame inside a given frame or iframe element. Returns 0 if
// the given element is not a frame, iframe or if the frame is empty.
BLINK_EXPORT static WebLocalFrame* fromFrameOwnerElement(const WebElement&);
// Initialization ---------------------------------------------------------
// Used when we might swap from a remote frame to a local frame.
// Creates a provisional, semi-attached frame that will be fully
// swapped into the frame tree if it commits.
virtual void initializeToReplaceRemoteFrame(WebRemoteFrame*, const WebString& name, WebSandboxFlags) = 0;
virtual void setAutofillClient(WebAutofillClient*) = 0;
virtual WebAutofillClient* autofillClient() = 0;
virtual void setDevToolsAgentClient(WebDevToolsAgentClient*) = 0;
virtual WebDevToolsAgent* devToolsAgent() = 0;
// Navigation Ping --------------------------------------------------------
virtual void sendPings(const WebNode& contextNode, const WebURL& destinationURL) = 0;
// Navigation ----------------------------------------------------------
// Returns a WebURLRequest corresponding to the load of the WebHistoryItem.
virtual WebURLRequest requestFromHistoryItem(const WebHistoryItem&, WebURLRequest::CachePolicy)
const = 0;
// Returns a WebURLRequest corresponding to the reload of the current
// HistoryItem.
virtual WebURLRequest requestForReload(WebFrameLoadType,
const WebURL& overrideURL = WebURL()) const = 0;
// Load the given URL. For history navigations, a valid WebHistoryItem
// should be given, as well as a WebHistoryLoadType.
// TODO(clamy): Remove the reload, reloadWithOverrideURL, loadHistoryItem
// loadRequest functions in WebFrame once RenderFrame only calls loadRequest.
virtual void load(const WebURLRequest&, WebFrameLoadType = WebFrameLoadType::Standard,
const WebHistoryItem& = WebHistoryItem(),
WebHistoryLoadType = WebHistoryDifferentDocumentLoad) = 0;
// Navigation State -------------------------------------------------------
// Returns true if the current frame's load event has not completed.
virtual bool isLoading() const = 0;
// Returns true if any resource load is currently in progress. Exposed
// primarily for use in layout tests. You probably want isLoading()
// instead.
virtual bool isResourceLoadInProgress() const = 0;
// Returns true if there is a pending redirect or location change.
// This could be caused by:
// * an HTTP Refresh header
// * an X-Frame-Options header
// * the respective http-equiv meta tags
// * window.location value being mutated
// * CSP policy block
// * reload
// * form submission
virtual bool isNavigationScheduled() const = 0;
// Override the normal rules for whether a load has successfully committed
// in this frame. Used to propagate state when this frame has navigated
// cross process.
virtual void setCommittedFirstRealLoad() = 0;
// Orientation Changes ----------------------------------------------------
// Notify the frame that the screen orientation has changed.
virtual void sendOrientationChangeEvent() = 0;
// Printing ------------------------------------------------------------
// Returns true on success and sets the out parameter to the print preset options for the document.
virtual bool getPrintPresetOptionsForPlugin(const WebNode&, WebPrintPresetOptions*) = 0;
// Returns true if not printing this frame.
virtual bool isPrinting() const = 0;
// Scripting --------------------------------------------------------------
// Executes script in the context of the current page and returns the value
// that the script evaluated to with callback. Script execution can be
// suspend.
virtual void requestExecuteScriptAndReturnValue(const WebScriptSource&,
bool userGesture, WebScriptExecutionCallback*) = 0;
// worldID must be > 0 (as 0 represents the main world).
// worldID must be < EmbedderWorldIdLimit, high number used internally.
virtual void requestExecuteScriptInIsolatedWorld(
int worldID, const WebScriptSource* sourceIn, unsigned numSources,
int extensionGroup, bool userGesture, WebScriptExecutionCallback*) = 0;
// Run the task when the context of the current page is not suspended
// otherwise run it on context resumed.
// Method takes ownership of the passed task.
virtual void requestRunTask(WebSuspendableTask*) const = 0;
// Associates an isolated world with human-readable name which is useful for
// extension debugging.
virtual void setIsolatedWorldHumanReadableName(int worldID, const WebString&) = 0;
// Selection --------------------------------------------------------------
// Moves the selection extent point. This function does not allow the
// selection to collapse. If the new extent is set to the same position as
// the current base, this function will do nothing.
virtual void moveRangeSelectionExtent(const WebPoint&) = 0;
// Focus ------------------------------------------------------------------
// Called when this frame loses focus to a frame in another process.
virtual void clearFocus() = 0;
// Content Settings -------------------------------------------------------
virtual void setContentSettingsClient(WebContentSettingsClient*) = 0;
// App banner -------------------------------------------------------------
// Request to show an application install banner for the given |platforms|.
// The implementation can request the embedder to cancel the call by setting
// |cancel| to true.
virtual void willShowInstallBannerPrompt(int requestId, const WebVector<WebString>& platforms, WebAppBannerPromptReply*) = 0;
// Image reload -----------------------------------------------------------
// If the provided node is an image, reload the image disabling Lo-Fi.
virtual void reloadImage(const WebNode&) = 0;
// Feature usage logging --------------------------------------------------
virtual void didCallAddSearchProvider() = 0;
virtual void didCallIsSearchProviderInstalled() = 0;
// Testing ----------------------------------------------------------------
// Registers a test interface factory. Takes ownership of the factory.
virtual void registerTestInterface(const WebString& name, WebTestInterfaceFactory*) = 0;
// Iframe sandbox ---------------------------------------------------------
// Returns the effective sandbox flags which are inherited from their parent frame.
virtual WebSandboxFlags effectiveSandboxFlags() const = 0;
protected:
explicit WebLocalFrame(WebTreeScopeType scope) : WebFrame(scope) { }
};
} // namespace blink
#endif // WebLocalFrame_h
|
