2252c514809818e76fe7843046cfbb5ac2ef439a
[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 #if USE(COORDINATED_GRAPHICS)
113     void delegatedScrollRequested(const WebCore::IntPoint& scrollOffset) final;
114     void resetUpdateAtlasForTesting() final;
115 #endif
116
117     WebCore::IntPoint screenToRootView(const WebCore::IntPoint&) const final;
118     WebCore::IntRect rootViewToScreen(const WebCore::IntRect&) const final;
119
120 #if PLATFORM(IOS)
121     WebCore::IntPoint accessibilityScreenToRootView(const WebCore::IntPoint&) const final;
122     WebCore::IntRect rootViewToAccessibilityScreen(const WebCore::IntRect&) const final;
123 #endif
124
125     PlatformPageClient platformPageClient() const final;
126     void contentsSizeChanged(WebCore::Frame&, const WebCore::IntSize&) const final;
127     void scrollRectIntoView(const WebCore::IntRect&) const final; // Currently only Mac has a non empty implementation.
128
129     bool shouldUnavailablePluginMessageBeButton(WebCore::RenderEmbeddedObject::PluginUnavailabilityReason) const final;
130     void unavailablePluginButtonClicked(WebCore::Element&, WebCore::RenderEmbeddedObject::PluginUnavailabilityReason) const final;
131
132     void mouseDidMoveOverElement(const WebCore::HitTestResult&, unsigned modifierFlags) final;
133
134     void setToolTip(const String&, WebCore::TextDirection) final;
135     
136     void print(WebCore::Frame&) final;
137
138     void testIncomingSyncIPCMessageWhileWaitingForSyncReply() final;
139
140     void exceededDatabaseQuota(WebCore::Frame&, const String& databaseName, WebCore::DatabaseDetails) final;
141
142     void reachedMaxAppCacheSize(int64_t spaceNeeded) final;
143     void reachedApplicationCacheOriginQuota(WebCore::SecurityOrigin&, int64_t spaceNeeded) final;
144
145 #if ENABLE(DASHBOARD_SUPPORT)
146     void annotatedRegionsChanged() final;
147 #endif
148
149     bool shouldReplaceWithGeneratedFileForUpload(const String& path, String& generatedFilename) final;
150     String generateReplacementFile(const String& path) final;
151     
152 #if ENABLE(INPUT_TYPE_COLOR)
153     std::unique_ptr<WebCore::ColorChooser> createColorChooser(WebCore::ColorChooserClient&, const WebCore::Color&) final;
154 #endif
155
156 #if ENABLE(IOS_TOUCH_EVENTS)
157     void didPreventDefaultForEvent() final;
158 #endif
159
160 #if PLATFORM(IOS)
161     void didReceiveMobileDocType(bool) final;
162     void setNeedsScrollNotifications(WebCore::Frame&, bool) final;
163     void observedContentChange(WebCore::Frame&) final;
164     void clearContentChangeObservers(WebCore::Frame&) final;
165     void notifyRevealedSelectionByScrollingFrame(WebCore::Frame&) final;
166     bool isStopping() final;
167
168     void didLayout(LayoutType = NormalLayout) final;
169     void didStartOverflowScroll() final;
170     void didEndOverflowScroll() final;
171     bool hasStablePageScaleFactor() const final;
172
173     // FIXME: See <rdar://problem/5975559>
174     void suppressFormNotifications() final;
175     void restoreFormNotifications() final;
176
177     void addOrUpdateScrollingLayer(WebCore::Node*, PlatformLayer* scrollingLayer, PlatformLayer* contentsLayer, const WebCore::IntSize& scrollSize, bool allowHorizontalScrollbar, bool allowVerticalScrollbar) final;
178     void removeScrollingLayer(WebCore::Node*, PlatformLayer* scrollingLayer, PlatformLayer* contentsLayer) final;
179
180     void webAppOrientationsUpdated() final;
181     void showPlaybackTargetPicker(bool hasVideo) final;
182
183     Seconds eventThrottlingDelay() final;
184 #endif
185
186 #if ENABLE(ORIENTATION_EVENTS)
187     int deviceOrientation() const final;
188 #endif
189
190     void runOpenPanel(WebCore::Frame&, WebCore::FileChooser&) final;
191     void loadIconForFiles(const Vector<String>&, WebCore::FileIconLoader&) final;
192
193 #if !PLATFORM(IOS)
194     void setCursor(const WebCore::Cursor&) final;
195     void setCursorHiddenUntilMouseMoves(bool) final;
196 #endif
197
198 #if ENABLE(POINTER_LOCK)
199     bool requestPointerLock() final;
200     void requestPointerUnlock() final;
201 #endif
202
203     void didAssociateFormControls(const Vector<RefPtr<WebCore::Element>>&) final;
204     bool shouldNotifyOnFormChanges() final;
205
206     bool selectItemWritingDirectionIsNatural() final;
207     bool selectItemAlignmentFollowsMenuWritingDirection() final;
208     RefPtr<WebCore::PopupMenu> createPopupMenu(WebCore::PopupMenuClient&) const final;
209     RefPtr<WebCore::SearchPopupMenu> createSearchPopupMenu(WebCore::PopupMenuClient&) const final;
210
211     WebCore::GraphicsLayerFactory* graphicsLayerFactory() const final;
212     void attachRootGraphicsLayer(WebCore::Frame&, WebCore::GraphicsLayer*) final;
213     void attachViewOverlayGraphicsLayer(WebCore::Frame&, WebCore::GraphicsLayer*) final;
214     void setNeedsOneShotDrawingSynchronization() final;
215     void scheduleCompositingLayerFlush() final;
216     bool adjustLayerFlushThrottling(WebCore::LayerFlushThrottleState::Flags) final;
217
218     void contentRuleListNotification(const WebCore::URL&, const HashSet<std::pair<String, String>>&) final;
219     
220 #if USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)
221     RefPtr<WebCore::DisplayRefreshMonitor> createDisplayRefreshMonitor(WebCore::PlatformDisplayID) const final;
222 #endif
223
224     CompositingTriggerFlags allowedCompositingTriggers() const final
225     {
226         return static_cast<CompositingTriggerFlags>(
227             ThreeDTransformTrigger |
228             VideoTrigger |
229             PluginTrigger|
230             CanvasTrigger |
231 #if PLATFORM(MAC) || PLATFORM(IOS)
232             ScrollableNonMainFrameTrigger |
233 #endif
234 #if PLATFORM(IOS)
235             AnimatedOpacityTrigger | // Allow opacity animations to trigger compositing mode for iPhone: <rdar://problem/7830677>
236 #endif
237             AnimationTrigger);
238     }
239
240     bool layerTreeStateIsFrozen() const final;
241
242 #if ENABLE(ASYNC_SCROLLING)
243     RefPtr<WebCore::ScrollingCoordinator> createScrollingCoordinator(WebCore::Page&) const final;
244 #endif
245
246 #if PLATFORM(IOS)
247     void elementDidRefocus(WebCore::Element&) final;
248 #endif
249
250 #if (PLATFORM(IOS) && HAVE(AVKIT)) || (PLATFORM(MAC) && ENABLE(VIDEO_PRESENTATION_MODE))
251     bool supportsVideoFullscreen(WebCore::HTMLMediaElementEnums::VideoFullscreenMode) final;
252     bool supportsVideoFullscreenStandby() final;
253     void setUpPlaybackControlsManager(WebCore::HTMLMediaElement&) final;
254     void clearPlaybackControlsManager() final;
255     void enterVideoFullscreenForVideoElement(WebCore::HTMLVideoElement&, WebCore::HTMLMediaElementEnums::VideoFullscreenMode, bool standby) final;
256     void exitVideoFullscreenForVideoElement(WebCore::HTMLVideoElement&) final;
257 #endif
258
259 #if PLATFORM(MAC) && ENABLE(VIDEO_PRESENTATION_MODE)
260     void exitVideoFullscreenToModeWithoutAnimation(WebCore::HTMLVideoElement&, WebCore::HTMLMediaElementEnums::VideoFullscreenMode) final;
261 #endif
262
263 #if ENABLE(FULLSCREEN_API)
264     bool supportsFullScreenForElement(const WebCore::Element&, bool withKeyboard) final;
265     void enterFullScreenForElement(WebCore::Element&) final;
266     void exitFullScreenForElement(WebCore::Element*) final;
267 #endif
268
269 #if PLATFORM(COCOA)
270     void elementDidFocus(WebCore::Element&) final;
271     void elementDidBlur(WebCore::Element&) final;
272
273     void makeFirstResponder() final;
274     void assistiveTechnologyMakeFirstResponder() final;
275 #endif
276
277     void enableSuddenTermination() final;
278     void disableSuddenTermination() final;
279
280 #if PLATFORM(IOS)
281     WebCore::FloatSize screenSize() const final;
282     WebCore::FloatSize availableScreenSize() const final;
283 #endif
284
285     void dispatchViewportPropertiesDidChange(const WebCore::ViewportArguments&) const final;
286
287     void notifyScrollerThumbIsVisibleInRect(const WebCore::IntRect&) final;
288     void recommendedScrollbarStyleDidChange(WebCore::ScrollbarStyle newStyle) final;
289
290     std::optional<WebCore::ScrollbarOverlayStyle> preferredScrollbarOverlayStyle() final;
291
292     WebCore::Color underlayColor() const final;
293
294     void pageExtendedBackgroundColorDidChange(WebCore::Color) const final;
295     
296     void wheelEventHandlersChanged(bool) final;
297
298     String plugInStartLabelTitle(const String& mimeType) const final;
299     String plugInStartLabelSubtitle(const String& mimeType) const final;
300     String plugInExtraStyleSheet() const final;
301     String plugInExtraScript() const final;
302
303     void didAddHeaderLayer(WebCore::GraphicsLayer&) final;
304     void didAddFooterLayer(WebCore::GraphicsLayer&) final;
305
306     bool shouldUseTiledBackingForFrameView(const WebCore::FrameView&) const final;
307
308     void isPlayingMediaDidChange(WebCore::MediaProducer::MediaStateFlags, uint64_t) final;
309     void handleAutoplayEvent(WebCore::AutoplayEvent, OptionSet<WebCore::AutoplayEventFlags>) final;
310
311 #if ENABLE(MEDIA_SESSION)
312     void hasMediaSessionWithActiveMediaElementsDidChange(bool) final;
313     void mediaSessionMetadataDidChange(const WebCore::MediaSessionMetadata&) final;
314     void focusedContentMediaElementDidChange(uint64_t) final;
315 #endif
316
317 #if ENABLE(SUBTLE_CRYPTO)
318     bool wrapCryptoKey(const Vector<uint8_t>&, Vector<uint8_t>&) const final;
319     bool unwrapCryptoKey(const Vector<uint8_t>&, Vector<uint8_t>&) const final;
320 #endif
321
322 #if ENABLE(TELEPHONE_NUMBER_DETECTION) && PLATFORM(MAC)
323     void handleTelephoneNumberClick(const String& number, const WebCore::IntPoint&) final;
324 #endif
325
326 #if ENABLE(SERVICE_CONTROLS)
327     void handleSelectionServiceClick(WebCore::FrameSelection&, const Vector<String>& telephoneNumbers, const WebCore::IntPoint&) final;
328     bool hasRelevantSelectionServices(bool isTextOnly) const final;
329 #endif
330
331     bool shouldDispatchFakeMouseMoveEvents() const final;
332
333     void handleAutoFillButtonClick(WebCore::HTMLInputElement&) final;
334
335 #if ENABLE(WIRELESS_PLAYBACK_TARGET) && !PLATFORM(IOS)
336     void addPlaybackTargetPickerClient(uint64_t /*contextId*/) final;
337     void removePlaybackTargetPickerClient(uint64_t /*contextId*/) final;
338     void showPlaybackTargetPicker(uint64_t contextId, const WebCore::IntPoint&, bool) final;
339     void playbackTargetPickerClientStateDidChange(uint64_t, WebCore::MediaProducer::MediaStateFlags) final;
340     void setMockMediaPlaybackTargetPickerEnabled(bool) final;
341     void setMockMediaPlaybackTargetPickerState(const String&, WebCore::MediaPlaybackTargetContext::State) final;
342 #endif
343
344     void imageOrMediaDocumentSizeChanged(const WebCore::IntSize&) final;
345
346     RefPtr<WebCore::Icon> createIconForFiles(const Vector<String>& filenames) final;
347
348 #if ENABLE(VIDEO) && USE(GSTREAMER)
349     void requestInstallMissingMediaPlugins(const String& /*details*/, const String& /*description*/, WebCore::MediaPlayerRequestInstallMissingPluginsCallback&) final;
350 #endif
351
352     void didInvalidateDocumentMarkerRects() final;
353
354 #if HAVE(CFNETWORK_STORAGE_PARTITIONING)
355     void hasStorageAccess(String&& subFrameHost, String&& topFrameHost, uint64_t frameID, uint64_t pageID, WTF::CompletionHandler<void (bool)>&&) final;
356     void requestStorageAccess(String&& subFrameHost, String&& topFrameHost, uint64_t frameID, uint64_t pageID, WTF::CompletionHandler<void (bool)>&&) final;
357 #endif
358
359     String m_cachedToolTip;
360     mutable RefPtr<WebFrame> m_cachedFrameSetLargestFrame;
361     mutable bool m_cachedMainFrameHasHorizontalScrollbar { false };
362     mutable bool m_cachedMainFrameHasVerticalScrollbar { false };
363
364     WebPage& m_page;
365 };
366
367 } // namespace WebKit