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