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