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