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