Move URL from WebCore to WTF
[WebKit-https.git] / Source / WebKit / WebProcess / WebCoreSupport / WebChromeClient.h
1 /*
2  * Copyright (C) 2010-2017 Apple Inc. All rights reserved.
3  * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
15  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
16  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
18  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
19  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
20  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
21  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
22  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
23  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
24  * THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #pragma once
28
29 #include <WebCore/ChromeClient.h>
30
31 namespace WebKit {
32
33 class WebFrame;
34 class WebPage;
35
36 class WebChromeClient final : public WebCore::ChromeClient {
37 public:
38     WebChromeClient(WebPage&);
39
40     WebPage& page() const { return m_page; }
41
42 private:
43     ~WebChromeClient();
44
45     void didInsertMenuElement(WebCore::HTMLMenuElement&);
46     void didRemoveMenuElement(WebCore::HTMLMenuElement&);
47     void didInsertMenuItemElement(WebCore::HTMLMenuItemElement&);
48     void didRemoveMenuItemElement(WebCore::HTMLMenuItemElement&);
49
50     void chromeDestroyed() final;
51     
52     void setWindowRect(const WebCore::FloatRect&) final;
53     WebCore::FloatRect windowRect() final;
54     
55     WebCore::FloatRect pageRect() final;
56     
57     void focus() final;
58     void unfocus() final;
59     
60     bool canTakeFocus(WebCore::FocusDirection) final;
61     void takeFocus(WebCore::FocusDirection) final;
62
63     void focusedElementChanged(WebCore::Element*) final;
64     void focusedFrameChanged(WebCore::Frame*) final;
65
66     // The Frame pointer provides the ChromeClient with context about which
67     // Frame wants to create the new Page.  Also, the newly created window
68     // should not be shown to the user until the ChromeClient of the newly
69     // created Page has its show method called.
70     WebCore::Page* createWindow(WebCore::Frame&, const WebCore::FrameLoadRequest&, const WebCore::WindowFeatures&, const WebCore::NavigationAction&) final;
71     void show() final;
72     
73     bool canRunModal() final;
74     void runModal() final;
75
76     void reportProcessCPUTime(Seconds, WebCore::ActivityStateForCPUSampling) final;
77     
78     void setToolbarsVisible(bool) final;
79     bool toolbarsVisible() final;
80     
81     void setStatusbarVisible(bool) final;
82     bool statusbarVisible() final;
83     
84     void setScrollbarsVisible(bool) final;
85     bool scrollbarsVisible() final;
86     
87     void setMenubarVisible(bool) final;
88     bool menubarVisible() final;
89     
90     void setResizable(bool) final;
91     
92     void addMessageToConsole(JSC::MessageSource, JSC::MessageLevel, const String& message, unsigned lineNumber, unsigned columnNumber, const String& sourceID) final;
93     
94     bool canRunBeforeUnloadConfirmPanel() final;
95     bool runBeforeUnloadConfirmPanel(const String& message, WebCore::Frame&) final;
96     
97     void closeWindowSoon() final;
98     
99     void runJavaScriptAlert(WebCore::Frame&, const String&) final;
100     bool runJavaScriptConfirm(WebCore::Frame&, const String&) final;
101     bool runJavaScriptPrompt(WebCore::Frame&, const String& message, const String& defaultValue, String& result) final;
102     void setStatusbarText(const String&) final;
103
104     WebCore::KeyboardUIMode keyboardUIMode() final;
105
106     // HostWindow member function finals.
107     void invalidateRootView(const WebCore::IntRect&) final;
108     void invalidateContentsAndRootView(const WebCore::IntRect&) final;
109     void invalidateContentsForSlowScroll(const WebCore::IntRect&) final;
110     void scroll(const WebCore::IntSize& scrollDelta, const WebCore::IntRect& scrollRect, const WebCore::IntRect& clipRect) final;
111
112     WebCore::IntPoint screenToRootView(const WebCore::IntPoint&) const final;
113     WebCore::IntRect rootViewToScreen(const WebCore::IntRect&) const final;
114
115 #if PLATFORM(IOS_FAMILY)
116     WebCore::IntPoint accessibilityScreenToRootView(const WebCore::IntPoint&) const final;
117     WebCore::IntRect rootViewToAccessibilityScreen(const WebCore::IntRect&) const final;
118 #endif
119
120     PlatformPageClient platformPageClient() const final;
121     void contentsSizeChanged(WebCore::Frame&, const WebCore::IntSize&) const final;
122     void scrollRectIntoView(const WebCore::IntRect&) const final; // Currently only Mac has a non empty implementation.
123
124     bool shouldUnavailablePluginMessageBeButton(WebCore::RenderEmbeddedObject::PluginUnavailabilityReason) const final;
125     void unavailablePluginButtonClicked(WebCore::Element&, WebCore::RenderEmbeddedObject::PluginUnavailabilityReason) const final;
126
127     void mouseDidMoveOverElement(const WebCore::HitTestResult&, unsigned modifierFlags) final;
128
129     void setToolTip(const String&, WebCore::TextDirection) final;
130     
131     void print(WebCore::Frame&) final;
132
133     void exceededDatabaseQuota(WebCore::Frame&, const String& databaseName, WebCore::DatabaseDetails) final;
134
135     void reachedMaxAppCacheSize(int64_t spaceNeeded) final;
136     void reachedApplicationCacheOriginQuota(WebCore::SecurityOrigin&, int64_t spaceNeeded) final;
137
138 #if ENABLE(DASHBOARD_SUPPORT)
139     void annotatedRegionsChanged() final;
140 #endif
141
142     bool shouldReplaceWithGeneratedFileForUpload(const String& path, String& generatedFilename) final;
143     String generateReplacementFile(const String& path) final;
144     
145 #if ENABLE(INPUT_TYPE_COLOR)
146     std::unique_ptr<WebCore::ColorChooser> createColorChooser(WebCore::ColorChooserClient&, const WebCore::Color&) final;
147 #endif
148
149 #if ENABLE(DATALIST_ELEMENT)
150     std::unique_ptr<WebCore::DataListSuggestionPicker> createDataListSuggestionPicker(WebCore::DataListSuggestionsClient&) final;
151 #endif
152
153 #if ENABLE(IOS_TOUCH_EVENTS)
154     void didPreventDefaultForEvent() final;
155 #endif
156
157 #if PLATFORM(IOS_FAMILY)
158     void didReceiveMobileDocType(bool) final;
159     void setNeedsScrollNotifications(WebCore::Frame&, bool) final;
160     void observedContentChange(WebCore::Frame&) final;
161     void clearContentChangeObservers(WebCore::Frame&) final;
162     void notifyRevealedSelectionByScrollingFrame(WebCore::Frame&) final;
163     bool isStopping() final;
164
165     void didLayout(LayoutType = NormalLayout) final;
166     void didStartOverflowScroll() final;
167     void didEndOverflowScroll() final;
168     bool hasStablePageScaleFactor() const final;
169
170     // FIXME: See <rdar://problem/5975559>
171     void suppressFormNotifications() final;
172     void restoreFormNotifications() final;
173
174     void addOrUpdateScrollingLayer(WebCore::Node*, PlatformLayer* scrollingLayer, PlatformLayer* contentsLayer, const WebCore::IntSize& scrollSize, bool allowHorizontalScrollbar, bool allowVerticalScrollbar) final;
175     void removeScrollingLayer(WebCore::Node*, PlatformLayer* scrollingLayer, PlatformLayer* contentsLayer) final;
176
177     void webAppOrientationsUpdated() final;
178     void showPlaybackTargetPicker(bool hasVideo, WebCore::RouteSharingPolicy, const String&) final;
179
180     Seconds eventThrottlingDelay() final;
181
182     void associateEditableImageWithAttachment(WebCore::GraphicsLayer::EmbeddedViewID, const String& attachmentID) final;
183     void didCreateEditableImage(WebCore::GraphicsLayer::EmbeddedViewID) final;
184     void didDestroyEditableImage(WebCore::GraphicsLayer::EmbeddedViewID) final;
185 #endif
186
187 #if ENABLE(ORIENTATION_EVENTS)
188     int deviceOrientation() const final;
189 #endif
190
191     void runOpenPanel(WebCore::Frame&, WebCore::FileChooser&) final;
192     void showShareSheet(WebCore::ShareDataWithParsedURL&, WTF::CompletionHandler<void(bool)>&&) final;
193     void loadIconForFiles(const Vector<String>&, WebCore::FileIconLoader&) final;
194
195 #if !PLATFORM(IOS_FAMILY)
196     void setCursor(const WebCore::Cursor&) final;
197     void setCursorHiddenUntilMouseMoves(bool) final;
198 #endif
199
200 #if ENABLE(POINTER_LOCK)
201     bool requestPointerLock() final;
202     void requestPointerUnlock() final;
203 #endif
204
205     void didAssociateFormControls(const Vector<RefPtr<WebCore::Element>>&) final;
206     bool shouldNotifyOnFormChanges() final;
207
208     bool selectItemWritingDirectionIsNatural() final;
209     bool selectItemAlignmentFollowsMenuWritingDirection() final;
210     RefPtr<WebCore::PopupMenu> createPopupMenu(WebCore::PopupMenuClient&) const final;
211     RefPtr<WebCore::SearchPopupMenu> createSearchPopupMenu(WebCore::PopupMenuClient&) const final;
212
213     WebCore::GraphicsLayerFactory* graphicsLayerFactory() const final;
214     void attachRootGraphicsLayer(WebCore::Frame&, WebCore::GraphicsLayer*) final;
215     void attachViewOverlayGraphicsLayer(WebCore::Frame&, WebCore::GraphicsLayer*) final;
216     void setNeedsOneShotDrawingSynchronization() final;
217     void scheduleCompositingLayerFlush() final;
218     bool adjustLayerFlushThrottling(WebCore::LayerFlushThrottleState::Flags) final;
219
220     void contentRuleListNotification(const URL&, const HashSet<std::pair<String, String>>&) final;
221
222 #if PLATFORM(WIN)
223     void setLastSetCursorToCurrentCursor() final { }
224     void AXStartFrameLoad() final { }
225     void AXFinishFrameLoad() final { }
226 #endif
227
228 #if USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)
229     RefPtr<WebCore::DisplayRefreshMonitor> createDisplayRefreshMonitor(WebCore::PlatformDisplayID) const final;
230 #endif
231
232     CompositingTriggerFlags allowedCompositingTriggers() const final
233     {
234         return static_cast<CompositingTriggerFlags>(
235             ThreeDTransformTrigger |
236             VideoTrigger |
237             PluginTrigger|
238             CanvasTrigger |
239 #if PLATFORM(MAC) || PLATFORM(IOS_FAMILY)
240             ScrollableNonMainFrameTrigger |
241 #endif
242 #if PLATFORM(IOS_FAMILY)
243             AnimatedOpacityTrigger | // Allow opacity animations to trigger compositing mode for iPhone: <rdar://problem/7830677>
244 #endif
245             AnimationTrigger);
246     }
247
248     bool layerTreeStateIsFrozen() const final;
249     bool layerFlushThrottlingIsActive() const final;
250
251 #if ENABLE(ASYNC_SCROLLING)
252     RefPtr<WebCore::ScrollingCoordinator> createScrollingCoordinator(WebCore::Page&) const final;
253 #endif
254
255 #if PLATFORM(IOS_FAMILY)
256     void elementDidRefocus(WebCore::Element&) final;
257 #endif
258
259 #if (PLATFORM(IOS_FAMILY) && HAVE(AVKIT)) || (PLATFORM(MAC) && ENABLE(VIDEO_PRESENTATION_MODE))
260     bool supportsVideoFullscreen(WebCore::HTMLMediaElementEnums::VideoFullscreenMode) final;
261     bool supportsVideoFullscreenStandby() final;
262     void setUpPlaybackControlsManager(WebCore::HTMLMediaElement&) final;
263     void clearPlaybackControlsManager() final;
264     void enterVideoFullscreenForVideoElement(WebCore::HTMLVideoElement&, WebCore::HTMLMediaElementEnums::VideoFullscreenMode, bool standby) final;
265     void exitVideoFullscreenForVideoElement(WebCore::HTMLVideoElement&) final;
266 #endif
267
268 #if PLATFORM(MAC) && ENABLE(VIDEO_PRESENTATION_MODE)
269     void exitVideoFullscreenToModeWithoutAnimation(WebCore::HTMLVideoElement&, WebCore::HTMLMediaElementEnums::VideoFullscreenMode) final;
270 #endif
271
272 #if ENABLE(FULLSCREEN_API)
273     bool supportsFullScreenForElement(const WebCore::Element&, bool withKeyboard) final;
274     void enterFullScreenForElement(WebCore::Element&) final;
275     void exitFullScreenForElement(WebCore::Element*) final;
276 #endif
277
278 #if PLATFORM(COCOA)
279     void elementDidFocus(WebCore::Element&) final;
280     void elementDidBlur(WebCore::Element&) final;
281
282     void makeFirstResponder() final;
283     void assistiveTechnologyMakeFirstResponder() final;
284 #endif
285
286     void enableSuddenTermination() final;
287     void disableSuddenTermination() final;
288
289 #if PLATFORM(IOS_FAMILY)
290     WebCore::FloatSize screenSize() const final;
291     WebCore::FloatSize availableScreenSize() const final;
292     WebCore::FloatSize overrideScreenSize() const final;
293 #endif
294
295     void dispatchDisabledAdaptationsDidChange(const OptionSet<WebCore::DisabledAdaptations>&) const final;
296     void dispatchViewportPropertiesDidChange(const WebCore::ViewportArguments&) const final;
297
298     void notifyScrollerThumbIsVisibleInRect(const WebCore::IntRect&) final;
299     void recommendedScrollbarStyleDidChange(WebCore::ScrollbarStyle newStyle) final;
300
301     std::optional<WebCore::ScrollbarOverlayStyle> preferredScrollbarOverlayStyle() final;
302
303     WebCore::Color underlayColor() const final;
304
305     void pageExtendedBackgroundColorDidChange(WebCore::Color) const final;
306     
307     void wheelEventHandlersChanged(bool) final;
308
309     String plugInStartLabelTitle(const String& mimeType) const final;
310     String plugInStartLabelSubtitle(const String& mimeType) const final;
311     String plugInExtraStyleSheet() const final;
312     String plugInExtraScript() const final;
313
314     void didAddHeaderLayer(WebCore::GraphicsLayer&) final;
315     void didAddFooterLayer(WebCore::GraphicsLayer&) final;
316
317     bool shouldUseTiledBackingForFrameView(const WebCore::FrameView&) const final;
318
319     void isPlayingMediaDidChange(WebCore::MediaProducer::MediaStateFlags, uint64_t) final;
320     void handleAutoplayEvent(WebCore::AutoplayEvent, OptionSet<WebCore::AutoplayEventFlags>) final;
321
322 #if ENABLE(MEDIA_SESSION)
323     void hasMediaSessionWithActiveMediaElementsDidChange(bool) final;
324     void mediaSessionMetadataDidChange(const WebCore::MediaSessionMetadata&) final;
325     void focusedContentMediaElementDidChange(uint64_t) final;
326 #endif
327
328 #if ENABLE(WEB_CRYPTO)
329     bool wrapCryptoKey(const Vector<uint8_t>&, Vector<uint8_t>&) const final;
330     bool unwrapCryptoKey(const Vector<uint8_t>&, Vector<uint8_t>&) const final;
331 #endif
332
333     String signedPublicKeyAndChallengeString(unsigned keySizeIndex, const String& challengeString, const URL&) const final;
334
335 #if ENABLE(TELEPHONE_NUMBER_DETECTION) && PLATFORM(MAC)
336     void handleTelephoneNumberClick(const String& number, const WebCore::IntPoint&) final;
337 #endif
338
339 #if ENABLE(SERVICE_CONTROLS)
340     void handleSelectionServiceClick(WebCore::FrameSelection&, const Vector<String>& telephoneNumbers, const WebCore::IntPoint&) final;
341     bool hasRelevantSelectionServices(bool isTextOnly) const final;
342 #endif
343
344     bool shouldDispatchFakeMouseMoveEvents() const final;
345
346     void handleAutoFillButtonClick(WebCore::HTMLInputElement&) final;
347
348     void inputElementDidResignStrongPasswordAppearance(WebCore::HTMLInputElement&) final;
349
350 #if ENABLE(WIRELESS_PLAYBACK_TARGET) && !PLATFORM(IOS_FAMILY)
351     void addPlaybackTargetPickerClient(uint64_t /*contextId*/) final;
352     void removePlaybackTargetPickerClient(uint64_t /*contextId*/) final;
353     void showPlaybackTargetPicker(uint64_t contextId, const WebCore::IntPoint&, bool) final;
354     void playbackTargetPickerClientStateDidChange(uint64_t, WebCore::MediaProducer::MediaStateFlags) final;
355     void setMockMediaPlaybackTargetPickerEnabled(bool) final;
356     void setMockMediaPlaybackTargetPickerState(const String&, WebCore::MediaPlaybackTargetContext::State) final;
357 #endif
358
359     void imageOrMediaDocumentSizeChanged(const WebCore::IntSize&) final;
360
361     RefPtr<WebCore::Icon> createIconForFiles(const Vector<String>& filenames) final;
362
363 #if ENABLE(VIDEO) && USE(GSTREAMER)
364     void requestInstallMissingMediaPlugins(const String& /*details*/, const String& /*description*/, WebCore::MediaPlayerRequestInstallMissingPluginsCallback&) final;
365 #endif
366
367     void didInvalidateDocumentMarkerRects() final;
368
369 #if ENABLE(RESOURCE_LOAD_STATISTICS)
370     void hasStorageAccess(String&& subFrameHost, String&& topFrameHost, uint64_t frameID, uint64_t pageID, WTF::CompletionHandler<void (bool)>&&) final;
371     void requestStorageAccess(String&& subFrameHost, String&& topFrameHost, uint64_t frameID, uint64_t pageID, WTF::CompletionHandler<void (bool)>&&) final;
372 #endif
373
374     String m_cachedToolTip;
375     mutable RefPtr<WebFrame> m_cachedFrameSetLargestFrame;
376     mutable bool m_cachedMainFrameHasHorizontalScrollbar { false };
377     mutable bool m_cachedMainFrameHasVerticalScrollbar { false };
378
379     WebPage& m_page;
380 };
381
382 } // namespace WebKit