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