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