Provide a viewport parameter to disable clipping to the safe area
[WebKit-https.git] / Source / WebCore / page / ChromeClient.h
1 /*
2  * Copyright (C) 2006-2017 Apple, Inc. All rights reserved.
3  * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
4  * Copyright (C) 2012 Samsung Electronics. All rights reserved.
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public License
17  * along with this library; see the file COPYING.LIB.  If not, write to
18  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  * Boston, MA 02110-1301, USA.
20  */
21
22 #pragma once
23
24 #include "AXObjectCache.h"
25 #include "AutoplayEvent.h"
26 #include "Cursor.h"
27 #include "DatabaseDetails.h"
28 #include "DisplayRefreshMonitor.h"
29 #include "FocusDirection.h"
30 #include "FrameLoader.h"
31 #include "GraphicsContext.h"
32 #include "HTMLMediaElementEnums.h"
33 #include "HostWindow.h"
34 #include "Icon.h"
35 #include "LayerFlushThrottleState.h"
36 #include "MediaProducer.h"
37 #include "PopupMenu.h"
38 #include "PopupMenuClient.h"
39 #include "RenderEmbeddedObject.h"
40 #include "ScrollTypes.h"
41 #include "ScrollingCoordinator.h"
42 #include "SearchPopupMenu.h"
43 #include "WebCoreKeyboardUIMode.h"
44 #include <runtime/ConsoleTypes.h>
45 #include <wtf/Forward.h>
46 #include <wtf/Seconds.h>
47 #include <wtf/Vector.h>
48
49 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
50 #include "MediaPlaybackTargetContext.h"
51 #endif
52
53 #if PLATFORM(IOS)
54 #include "PlatformLayer.h"
55 #define NSResponder WAKResponder
56 #ifndef __OBJC__
57 class WAKResponder;
58 #else
59 @class WAKResponder;
60 #endif
61 #endif
62
63 OBJC_CLASS NSResponder;
64
65 namespace WebCore {
66
67 class AccessibilityObject;
68 class ColorChooser;
69 class ColorChooserClient;
70 class DateTimeChooser;
71 class DateTimeChooserClient;
72 class Element;
73 class FileChooser;
74 class FileIconLoader;
75 class FloatRect;
76 class Frame;
77 class Geolocation;
78 class GraphicsLayer;
79 class GraphicsLayerFactory;
80 class HTMLInputElement;
81 class HTMLMediaElement;
82 class HTMLVideoElement;
83 class HitTestResult;
84 class IntRect;
85 class MediaSessionMetadata;
86 class NavigationAction;
87 class Node;
88 class Page;
89 class PopupMenuClient;
90 class SecurityOrigin;
91 class ViewportConstraints;
92 class Widget;
93
94 #if ENABLE(VIDEO) && USE(GSTREAMER)
95 class MediaPlayerRequestInstallMissingPluginsCallback;
96 #endif
97
98 struct DateTimeChooserParameters;
99 struct FrameLoadRequest;
100 struct GraphicsDeviceAdapter;
101 struct ViewportArguments;
102 struct WindowFeatures;
103
104 class WEBCORE_EXPORT ChromeClient {
105 public:
106     virtual void chromeDestroyed() = 0;
107
108     virtual void setWindowRect(const FloatRect&) = 0;
109     virtual FloatRect windowRect() = 0;
110
111     virtual FloatRect pageRect() = 0;
112
113     virtual void focus() = 0;
114     virtual void unfocus() = 0;
115
116     virtual bool canTakeFocus(FocusDirection) = 0;
117     virtual void takeFocus(FocusDirection) = 0;
118
119     virtual void focusedElementChanged(Element*) = 0;
120     virtual void focusedFrameChanged(Frame*) = 0;
121
122     // The Frame pointer provides the ChromeClient with context about which
123     // Frame wants to create the new Page. Also, the newly created window
124     // should not be shown to the user until the ChromeClient of the newly
125     // created Page has its show method called.
126     // The FrameLoadRequest parameter is only for ChromeClient to check if the
127     // request could be fulfilled. The ChromeClient should not load the request.
128     virtual Page* createWindow(Frame&, const FrameLoadRequest&, const WindowFeatures&, const NavigationAction&) = 0;
129     virtual void show() = 0;
130
131     virtual bool canRunModal() = 0;
132     virtual void runModal() = 0;
133
134     virtual void setToolbarsVisible(bool) = 0;
135     virtual bool toolbarsVisible() = 0;
136
137     virtual void setStatusbarVisible(bool) = 0;
138     virtual bool statusbarVisible() = 0;
139
140     virtual void setScrollbarsVisible(bool) = 0;
141     virtual bool scrollbarsVisible() = 0;
142
143     virtual void setMenubarVisible(bool) = 0;
144     virtual bool menubarVisible() = 0;
145
146     virtual void setResizable(bool) = 0;
147
148     virtual void addMessageToConsole(MessageSource, MessageLevel, const String& message, unsigned lineNumber, unsigned columnNumber, const String& sourceID) = 0;
149
150     virtual bool canRunBeforeUnloadConfirmPanel() = 0;
151     virtual bool runBeforeUnloadConfirmPanel(const String& message, Frame&) = 0;
152
153     virtual void closeWindowSoon() = 0;
154
155     virtual void runJavaScriptAlert(Frame&, const String&) = 0;
156     virtual bool runJavaScriptConfirm(Frame&, const String&) = 0;
157     virtual bool runJavaScriptPrompt(Frame&, const String& message, const String& defaultValue, String& result) = 0;
158     virtual void setStatusbarText(const String&) = 0;
159     virtual KeyboardUIMode keyboardUIMode() = 0;
160
161     virtual bool supportsImmediateInvalidation() { return false; }
162     virtual void invalidateRootView(const IntRect&) = 0;
163     virtual void invalidateContentsAndRootView(const IntRect&) = 0;
164     virtual void invalidateContentsForSlowScroll(const IntRect&) = 0;
165     virtual void scroll(const IntSize&, const IntRect&, const IntRect&) = 0;
166
167 #if USE(COORDINATED_GRAPHICS)
168     virtual void delegatedScrollRequested(const IntPoint&) = 0;
169 #endif
170
171     virtual IntPoint screenToRootView(const IntPoint&) const = 0;
172     virtual IntRect rootViewToScreen(const IntRect&) const = 0;
173
174 #if PLATFORM(IOS)
175     virtual IntPoint accessibilityScreenToRootView(const IntPoint&) const = 0;
176     virtual IntRect rootViewToAccessibilityScreen(const IntRect&) const = 0;
177 #endif    
178
179     virtual PlatformPageClient platformPageClient() const = 0;
180     virtual void scrollbarsModeDidChange() const = 0;
181
182 #if ENABLE(CURSOR_SUPPORT)
183     virtual void setCursor(const Cursor&) = 0;
184     virtual void setCursorHiddenUntilMouseMoves(bool) = 0;
185 #endif
186
187 #if !USE(REQUEST_ANIMATION_FRAME_TIMER)
188     virtual void scheduleAnimation() = 0;
189 #endif
190
191     virtual FloatSize screenSize() const { return const_cast<ChromeClient&>(*this).windowRect().size(); }
192     virtual FloatSize availableScreenSize() const { return const_cast<ChromeClient&>(*this).windowRect().size(); }
193
194     virtual void dispatchViewportPropertiesDidChange(const ViewportArguments&) const { }
195
196     virtual void contentsSizeChanged(Frame&, const IntSize&) const = 0;
197     virtual void scrollRectIntoView(const IntRect&) const { }; // Currently only Mac has a non empty implementation.
198
199     virtual bool shouldUnavailablePluginMessageBeButton(RenderEmbeddedObject::PluginUnavailabilityReason) const { return false; }
200     virtual void unavailablePluginButtonClicked(Element&, RenderEmbeddedObject::PluginUnavailabilityReason) const { }
201     virtual void mouseDidMoveOverElement(const HitTestResult&, unsigned modifierFlags) = 0;
202
203     virtual void setToolTip(const String&, TextDirection) = 0;
204
205     virtual void print(Frame&) = 0;
206
207     virtual Color underlayColor() const { return Color(); }
208
209     virtual void pageExtendedBackgroundColorDidChange(Color) const { }
210
211     virtual void exceededDatabaseQuota(Frame&, const String& databaseName, DatabaseDetails) = 0;
212
213     // Callback invoked when the application cache fails to save a cache object
214     // because storing it would grow the database file past its defined maximum
215     // size or past the amount of free space on the device. 
216     // The chrome client would need to take some action such as evicting some
217     // old caches.
218     virtual void reachedMaxAppCacheSize(int64_t spaceNeeded) = 0;
219
220     // Callback invoked when the application cache origin quota is reached. This
221     // means that the resources attempting to be cached via the manifest are
222     // more than allowed on this origin. This callback allows the chrome client
223     // to take action, such as prompting the user to ask to increase the quota
224     // for this origin. The totalSpaceNeeded parameter is the total amount of
225     // storage, in bytes, needed to store the new cache along with all of the
226     // other existing caches for the origin that would not be replaced by
227     // the new cache.
228     virtual void reachedApplicationCacheOriginQuota(SecurityOrigin&, int64_t totalSpaceNeeded) = 0;
229
230 #if ENABLE(DASHBOARD_SUPPORT)
231     virtual void annotatedRegionsChanged();
232 #endif
233
234     virtual bool shouldReplaceWithGeneratedFileForUpload(const String& path, String& generatedFilename);
235     virtual String generateReplacementFile(const String& path);
236
237 #if ENABLE(IOS_TOUCH_EVENTS)
238     virtual void didPreventDefaultForEvent() = 0;
239 #endif
240
241     virtual Seconds eventThrottlingDelay() { return 0_s; };
242
243 #if PLATFORM(IOS)
244     virtual void didReceiveMobileDocType(bool) = 0;
245     virtual void setNeedsScrollNotifications(Frame&, bool) = 0;
246     virtual void observedContentChange(Frame&) = 0;
247     virtual void clearContentChangeObservers(Frame&) = 0;
248     virtual void notifyRevealedSelectionByScrollingFrame(Frame&) = 0;
249
250     enum LayoutType { NormalLayout, Scroll };
251     virtual void didLayout(LayoutType = NormalLayout) = 0;
252     virtual void didStartOverflowScroll() = 0;
253     virtual void didEndOverflowScroll() = 0;
254
255     // FIXME: Remove this functionality. This functionality was added to workaround an issue (<rdar://problem/5973875>)
256     // where the unconfirmed text in a text area would be removed when a person clicks in the text area before a
257     // suggestion is shown. We should fix this issue in <rdar://problem/5975559>.
258     virtual void suppressFormNotifications() = 0;
259     virtual void restoreFormNotifications() = 0;
260
261     virtual void didFlushCompositingLayers() { }
262
263     virtual bool fetchCustomFixedPositionLayoutRect(IntRect&) { return false; }
264
265     virtual void updateViewportConstrainedLayers(HashMap<PlatformLayer*, std::unique_ptr<ViewportConstraints>>&, HashMap<PlatformLayer*, PlatformLayer*>&) { }
266
267     virtual void addOrUpdateScrollingLayer(Node*, PlatformLayer* scrollingLayer, PlatformLayer* contentsLayer, const IntSize& scrollSize, bool allowHorizontalScrollbar, bool allowVerticalScrollbar) = 0;
268     virtual void removeScrollingLayer(Node*, PlatformLayer* scrollingLayer, PlatformLayer* contentsLayer) = 0;
269
270     virtual void webAppOrientationsUpdated() = 0;
271     virtual void showPlaybackTargetPicker(bool hasVideo) = 0;
272 #endif
273
274 #if ENABLE(ORIENTATION_EVENTS)
275     virtual int deviceOrientation() const = 0;
276 #endif
277
278 #if ENABLE(INPUT_TYPE_COLOR)
279     virtual std::unique_ptr<ColorChooser> createColorChooser(ColorChooserClient&, const Color&) = 0;
280 #endif
281
282     virtual void runOpenPanel(Frame&, FileChooser&) = 0;
283     // Asynchronous request to load an icon for specified filenames.
284     virtual void loadIconForFiles(const Vector<String>&, FileIconLoader&) = 0;
285         
286     virtual void elementDidFocus(Element&) { }
287     virtual void elementDidBlur(Element&) { }
288     virtual void elementDidRefocus(Element&) { }
289     
290     virtual bool shouldPaintEntireContents() const { return false; }
291     virtual bool hasStablePageScaleFactor() const { return true; }
292
293     // Allows ports to customize the type of graphics layers created by this page.
294     virtual GraphicsLayerFactory* graphicsLayerFactory() const { return nullptr; }
295
296 #if USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)
297     virtual RefPtr<DisplayRefreshMonitor> createDisplayRefreshMonitor(PlatformDisplayID) const { return nullptr; }
298 #endif
299
300     // Pass nullptr as the GraphicsLayer to detatch the root layer.
301     virtual void attachRootGraphicsLayer(Frame&, GraphicsLayer*) = 0;
302     virtual void attachViewOverlayGraphicsLayer(Frame&, GraphicsLayer*) = 0;
303     // Sets a flag to specify that the next time content is drawn to the window,
304     // the changes appear on the screen in synchrony with updates to GraphicsLayers.
305     virtual void setNeedsOneShotDrawingSynchronization() = 0;
306     // Sets a flag to specify that the view needs to be updated, so we need
307     // to do an eager layout before the drawing.
308     virtual void scheduleCompositingLayerFlush() = 0;
309     // Returns whether or not the client can render the composited layer,
310     // regardless of the settings.
311     virtual bool allowsAcceleratedCompositing() const { return true; }
312
313     enum CompositingTrigger {
314         ThreeDTransformTrigger = 1 << 0,
315         VideoTrigger = 1 << 1,
316         PluginTrigger = 1 << 2,
317         CanvasTrigger = 1 << 3,
318         AnimationTrigger = 1 << 4,
319         FilterTrigger = 1 << 5,
320         ScrollableInnerFrameTrigger = 1 << 6,
321         AnimatedOpacityTrigger = 1 << 7,
322         AllTriggers = 0xFFFFFFFF
323     };
324     typedef unsigned CompositingTriggerFlags;
325
326     // Returns a bitfield indicating conditions that can trigger the compositor.
327     virtual CompositingTriggerFlags allowedCompositingTriggers() const { return static_cast<CompositingTriggerFlags>(AllTriggers); }
328     
329     // Returns true if layer tree updates are disabled.
330     virtual bool layerTreeStateIsFrozen() const { return false; }
331
332     virtual bool adjustLayerFlushThrottling(LayerFlushThrottleState::Flags) { return false; }
333
334     virtual RefPtr<ScrollingCoordinator> createScrollingCoordinator(Page&) const { return nullptr; }
335
336 #if PLATFORM(WIN) && USE(AVFOUNDATION)
337     virtual GraphicsDeviceAdapter* graphicsDeviceAdapter() const { return nullptr; }
338 #endif
339
340     virtual bool supportsVideoFullscreen(HTMLMediaElementEnums::VideoFullscreenMode) { return false; }
341
342 #if ENABLE(VIDEO)
343     virtual void enterVideoFullscreenForVideoElement(HTMLVideoElement&, HTMLMediaElementEnums::VideoFullscreenMode) { }
344     virtual void setUpPlaybackControlsManager(HTMLMediaElement&) { }
345     virtual void clearPlaybackControlsManager() { }
346 #endif
347
348     virtual void exitVideoFullscreenForVideoElement(HTMLVideoElement&) { }
349     virtual void exitVideoFullscreenToModeWithoutAnimation(HTMLVideoElement&, HTMLMediaElementEnums::VideoFullscreenMode) { }
350     virtual bool requiresFullscreenForVideoPlayback() { return false; } 
351
352 #if ENABLE(FULLSCREEN_API)
353     virtual bool supportsFullScreenForElement(const Element&, bool) { return false; }
354     virtual void enterFullScreenForElement(Element&) { }
355     virtual void exitFullScreenForElement(Element*) { }
356     virtual void setRootFullScreenLayer(GraphicsLayer*) { }
357 #endif
358
359 #if USE(COORDINATED_GRAPHICS)
360     virtual IntRect visibleRectForTiledBackingStore() const { return IntRect(); }
361 #endif
362
363 #if PLATFORM(COCOA)
364     virtual NSResponder *firstResponder() { return nullptr; }
365     virtual void makeFirstResponder(NSResponder *) { }
366     // Focuses on the containing view associated with this page.
367     virtual void makeFirstResponder() { }
368 #endif
369
370 #if PLATFORM(IOS)
371     // FIXME: Come up with a more descriptive name for this function and make it platform independent (if possible).
372     virtual bool isStopping() = 0;
373 #endif
374
375     virtual void enableSuddenTermination() { }
376     virtual void disableSuddenTermination() { }
377
378 #if PLATFORM(WIN)
379     virtual void setLastSetCursorToCurrentCursor() = 0;
380     virtual void AXStartFrameLoad() = 0;
381     virtual void AXFinishFrameLoad() = 0;
382 #endif
383
384     virtual bool selectItemWritingDirectionIsNatural() = 0;
385     virtual bool selectItemAlignmentFollowsMenuWritingDirection() = 0;
386     // Checks if there is an opened popup, called by RenderMenuList::showPopup().
387     virtual bool hasOpenedPopup() const = 0;
388     virtual RefPtr<PopupMenu> createPopupMenu(PopupMenuClient&) const = 0;
389     virtual RefPtr<SearchPopupMenu> createSearchPopupMenu(PopupMenuClient&) const = 0;
390
391     virtual void postAccessibilityNotification(AccessibilityObject&, AXObjectCache::AXNotification) { }
392
393     virtual void notifyScrollerThumbIsVisibleInRect(const IntRect&) { }
394     virtual void recommendedScrollbarStyleDidChange(ScrollbarStyle) { }
395
396     virtual std::optional<ScrollbarOverlayStyle> preferredScrollbarOverlayStyle() { return ScrollbarOverlayStyleDefault; }
397
398     virtual void wheelEventHandlersChanged(bool hasHandlers) = 0;
399         
400     virtual bool isSVGImageChromeClient() const { return false; }
401
402 #if ENABLE(POINTER_LOCK)
403     virtual bool requestPointerLock() { return false; }
404     virtual void requestPointerUnlock() { }
405 #endif
406
407     virtual FloatSize minimumWindowSize() const { return FloatSize(100, 100); };
408
409     virtual bool isEmptyChromeClient() const { return false; }
410
411     virtual String plugInStartLabelTitle(const String& mimeType) const { UNUSED_PARAM(mimeType); return String(); }
412     virtual String plugInStartLabelSubtitle(const String& mimeType) const { UNUSED_PARAM(mimeType); return String(); }
413     virtual String plugInExtraStyleSheet() const { return String(); }
414     virtual String plugInExtraScript() const { return String(); }
415
416     virtual void didAssociateFormControls(const Vector<RefPtr<Element>>&) { };
417     virtual bool shouldNotifyOnFormChanges() { return false; };
418
419     virtual void didAddHeaderLayer(GraphicsLayer&) { }
420     virtual void didAddFooterLayer(GraphicsLayer&) { }
421
422     virtual bool shouldUseTiledBackingForFrameView(const FrameView&) const { return false; }
423
424     virtual void isPlayingMediaDidChange(MediaProducer::MediaStateFlags, uint64_t) { }
425     virtual void handleAutoplayEvent(AutoplayEvent) { }
426
427 #if ENABLE(MEDIA_SESSION)
428     virtual void hasMediaSessionWithActiveMediaElementsDidChange(bool) { }
429     virtual void mediaSessionMetadataDidChange(const MediaSessionMetadata&) { }
430     virtual void focusedContentMediaElementDidChange(uint64_t) { }
431 #endif
432
433 #if ENABLE(SUBTLE_CRYPTO)
434     virtual bool wrapCryptoKey(const Vector<uint8_t>&, Vector<uint8_t>&) const { return false; }
435     virtual bool unwrapCryptoKey(const Vector<uint8_t>&, Vector<uint8_t>&) const { return false; }
436 #endif
437
438 #if ENABLE(TELEPHONE_NUMBER_DETECTION) && PLATFORM(MAC)
439     virtual void handleTelephoneNumberClick(const String&, const IntPoint&) { }
440 #endif
441
442 #if ENABLE(SERVICE_CONTROLS)
443     virtual void handleSelectionServiceClick(FrameSelection&, const Vector<String>&, const IntPoint&) { }
444     virtual bool hasRelevantSelectionServices(bool /*isTextOnly*/) const { return false; }
445 #endif
446
447     virtual bool shouldDispatchFakeMouseMoveEvents() const { return true; }
448
449     virtual void handleAutoFillButtonClick(HTMLInputElement&) { }
450
451 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
452     virtual void addPlaybackTargetPickerClient(uint64_t /*contextId*/) { }
453     virtual void removePlaybackTargetPickerClient(uint64_t /*contextId*/) { }
454     virtual void showPlaybackTargetPicker(uint64_t /*contextId*/, const IntPoint&, bool /*isVideo*/) { }
455     virtual void playbackTargetPickerClientStateDidChange(uint64_t /*contextId*/, MediaProducer::MediaStateFlags) { }
456     virtual void setMockMediaPlaybackTargetPickerEnabled(bool)  { }
457     virtual void setMockMediaPlaybackTargetPickerState(const String&, MediaPlaybackTargetContext::State) { }
458 #endif
459
460     virtual void imageOrMediaDocumentSizeChanged(const IntSize&) { }
461
462 #if ENABLE(VIDEO) && USE(GSTREAMER)
463     virtual void requestInstallMissingMediaPlugins(const String& /*details*/, const String& /*description*/, MediaPlayerRequestInstallMissingPluginsCallback&) { }
464 #endif
465
466     virtual void didInvalidateDocumentMarkerRects() { }
467
468     virtual void reportProcessCPUTime(int64_t, ActivityStateForCPUSampling) { }
469     virtual RefPtr<Icon> createIconForFiles(const Vector<String>& /* filenames */) = 0;
470
471     virtual void didChangeClipToSafeArea(bool) { }
472
473 protected:
474     virtual ~ChromeClient() { }
475 };
476
477 } // namespace WebCore