Add optimized fullscreen mode.
[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 #ifndef ChromeClient_h
23 #define ChromeClient_h
24
25 #include "AXObjectCache.h"
26 #include "Cursor.h"
27 #include "DisplayRefreshMonitor.h"
28 #include "FocusDirection.h"
29 #include "FrameLoader.h"
30 #include "GraphicsContext.h"
31 #include "HTMLMediaElement.h"
32 #include "HostWindow.h"
33 #include "LayerFlushThrottleState.h"
34 #include "PopupMenu.h"
35 #include "PopupMenuClient.h"
36 #include "RenderEmbeddedObject.h"
37 #include "ScrollTypes.h"
38 #include "ScrollingCoordinator.h"
39 #include "SearchPopupMenu.h"
40 #include "WebCoreKeyboardUIMode.h"
41 #include <runtime/ConsoleTypes.h>
42 #include <wtf/Forward.h>
43 #include <wtf/Vector.h>
44
45 #if PLATFORM(IOS)
46 #include "PlatformLayer.h"
47 #define NSResponder WAKResponder
48 #ifndef __OBJC__
49 class WAKResponder;
50 #else
51 @class WAKResponder;
52 #endif
53 #endif
54
55 #if ENABLE(SQL_DATABASE)
56 #include "DatabaseDetails.h"
57 #endif
58
59 OBJC_CLASS NSResponder;
60
61 namespace WebCore {
62
63 class AccessibilityObject;
64 class ColorChooser;
65 class ColorChooserClient;
66 class DateTimeChooser;
67 class DateTimeChooserClient;
68 class Element;
69 class FileChooser;
70 class FileIconLoader;
71 class FloatRect;
72 class Frame;
73 class Geolocation;
74 class GraphicsContext3D;
75 class GraphicsLayer;
76 class GraphicsLayerFactory;
77 class HTMLInputElement;
78 class HitTestResult;
79 class IntRect;
80 class NavigationAction;
81 class Node;
82 class Page;
83 class PopupMenuClient;
84 class SecurityOrigin;
85 class ViewportConstraints;
86 class Widget;
87
88 struct DateTimeChooserParameters;
89 struct FrameLoadRequest;
90 struct GraphicsDeviceAdapter;
91 struct ViewportArguments;
92 struct WindowFeatures;
93
94 class ChromeClient {
95 public:
96     virtual void chromeDestroyed() = 0;
97
98     virtual void setWindowRect(const FloatRect&) = 0;
99     virtual FloatRect windowRect() = 0;
100
101     virtual FloatRect pageRect() = 0;
102
103     virtual void focus() = 0;
104     virtual void unfocus() = 0;
105
106     virtual bool canTakeFocus(FocusDirection) = 0;
107     virtual void takeFocus(FocusDirection) = 0;
108
109     virtual void focusedElementChanged(Element*) = 0;
110     virtual void focusedFrameChanged(Frame*) = 0;
111
112     // The Frame pointer provides the ChromeClient with context about which
113     // Frame wants to create the new Page. Also, the newly created window
114     // should not be shown to the user until the ChromeClient of the newly
115     // created Page has its show method called.
116     // The FrameLoadRequest parameter is only for ChromeClient to check if the
117     // request could be fulfilled. The ChromeClient should not load the request.
118     virtual Page* createWindow(Frame*, const FrameLoadRequest&, const WindowFeatures&, const NavigationAction&) = 0;
119     virtual void show() = 0;
120
121     virtual bool canRunModal() = 0;
122     virtual void runModal() = 0;
123
124     virtual void setToolbarsVisible(bool) = 0;
125     virtual bool toolbarsVisible() = 0;
126
127     virtual void setStatusbarVisible(bool) = 0;
128     virtual bool statusbarVisible() = 0;
129
130     virtual void setScrollbarsVisible(bool) = 0;
131     virtual bool scrollbarsVisible() = 0;
132
133     virtual void setMenubarVisible(bool) = 0;
134     virtual bool menubarVisible() = 0;
135
136     virtual void setResizable(bool) = 0;
137
138     virtual void addMessageToConsole(MessageSource, MessageLevel, const String& message, unsigned lineNumber, unsigned columnNumber, const String& sourceID) = 0;
139     // FIXME: Remove this MessageType variant once all the clients are updated.
140     virtual void addMessageToConsole(MessageSource source, MessageType, MessageLevel level, const String& message, unsigned lineNumber, unsigned columnNumber, const String& sourceID)
141     {
142         addMessageToConsole(source, level, message, lineNumber, columnNumber, sourceID);
143     }
144
145     virtual bool canRunBeforeUnloadConfirmPanel() = 0;
146     virtual bool runBeforeUnloadConfirmPanel(const String& message, Frame*) = 0;
147
148     virtual void closeWindowSoon() = 0;
149
150     virtual void runJavaScriptAlert(Frame*, const String&) = 0;
151     virtual bool runJavaScriptConfirm(Frame*, const String&) = 0;
152     virtual bool runJavaScriptPrompt(Frame*, const String& message, const String& defaultValue, String& result) = 0;
153     virtual void setStatusbarText(const String&) = 0;
154     virtual bool shouldInterruptJavaScript() = 0;
155     virtual KeyboardUIMode keyboardUIMode() = 0;
156
157     virtual IntRect windowResizerRect() const = 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(TILED_BACKING_STORE)
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 #if ENABLE(SQL_DATABASE)
206     virtual void exceededDatabaseQuota(Frame*, const String& databaseName, DatabaseDetails) = 0;
207 #endif
208
209     // Callback invoked when the application cache fails to save a cache object
210     // because storing it would grow the database file past its defined maximum
211     // size or past the amount of free space on the device. 
212     // The chrome client would need to take some action such as evicting some
213     // old caches.
214     virtual void reachedMaxAppCacheSize(int64_t spaceNeeded) = 0;
215
216     // Callback invoked when the application cache origin quota is reached. This
217     // means that the resources attempting to be cached via the manifest are
218     // more than allowed on this origin. This callback allows the chrome client
219     // to take action, such as prompting the user to ask to increase the quota
220     // for this origin. The totalSpaceNeeded parameter is the total amount of
221     // storage, in bytes, needed to store the new cache along with all of the
222     // other existing caches for the origin that would not be replaced by
223     // the new cache.
224     virtual void reachedApplicationCacheOriginQuota(SecurityOrigin*, int64_t totalSpaceNeeded) = 0;
225
226 #if ENABLE(DASHBOARD_SUPPORT)
227     virtual void annotatedRegionsChanged();
228 #endif
229
230     virtual void populateVisitedLinks();
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 std::chrono::milliseconds eventThrottlingDelay() { return std::chrono::milliseconds::zero(); };
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) = 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(DATE_AND_TIME_INPUT_TYPES) && !PLATFORM(IOS)
281     virtual PassRefPtr<DateTimeChooser> openDateTimeChooser(DateTimeChooserClient*, const DateTimeChooserParameters&) = 0;
282 #endif
283
284     virtual void runOpenPanel(Frame*, PassRefPtr<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(const Node*) { };
289     virtual void elementDidBlur(const Node*) { };
290     
291     virtual bool shouldPaintEntireContents() const { return false; }
292     virtual bool hasStablePageScaleFactor() const { return true; }
293
294     // Allows ports to customize the type of graphics layers created by this page.
295     virtual GraphicsLayerFactory* graphicsLayerFactory() const { return nullptr; }
296
297 #if USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)
298     virtual PassRefPtr<DisplayRefreshMonitor> createDisplayRefreshMonitor(PlatformDisplayID) const { return nullptr; }
299 #endif
300
301     // Pass 0 as the GraphicsLayer to detatch the root layer.
302     virtual void attachRootGraphicsLayer(Frame*, GraphicsLayer*) = 0;
303     virtual void attachViewOverlayGraphicsLayer(Frame*, GraphicsLayer*) = 0;
304     // Sets a flag to specify that the next time content is drawn to the window,
305     // the changes appear on the screen in synchrony with updates to GraphicsLayers.
306     virtual void setNeedsOneShotDrawingSynchronization() = 0;
307     // Sets a flag to specify that the view needs to be updated, so we need
308     // to do an eager layout before the drawing.
309     virtual void scheduleCompositingLayerFlush() = 0;
310     // Returns whether or not the client can render the composited layer,
311     // regardless of the settings.
312     virtual bool allowsAcceleratedCompositing() const { return true; }
313
314     enum CompositingTrigger {
315         ThreeDTransformTrigger = 1 << 0,
316         VideoTrigger = 1 << 1,
317         PluginTrigger = 1 << 2,
318         CanvasTrigger = 1 << 3,
319         AnimationTrigger = 1 << 4,
320         FilterTrigger = 1 << 5,
321         ScrollableInnerFrameTrigger = 1 << 6,
322         AnimatedOpacityTrigger = 1 << 7,
323         AllTriggers = 0xFFFFFFFF
324     };
325     typedef unsigned CompositingTriggerFlags;
326
327     // Returns a bitfield indicating conditions that can trigger the compositor.
328     virtual CompositingTriggerFlags allowedCompositingTriggers() const { return static_cast<CompositingTriggerFlags>(AllTriggers); }
329     
330     // Returns true if layer tree updates are disabled.
331     virtual bool layerTreeStateIsFrozen() const { return false; }
332
333     virtual bool adjustLayerFlushThrottling(LayerFlushThrottleState::Flags) { return false; }
334
335     virtual PassRefPtr<ScrollingCoordinator> createScrollingCoordinator(Page*) const { return nullptr; }
336
337 #if PLATFORM(WIN) && USE(AVFOUNDATION)
338     virtual GraphicsDeviceAdapter* graphicsDeviceAdapter() const { return 0; }
339 #endif
340
341     virtual bool supportsVideoFullscreen() { return false; }
342     virtual void enterVideoFullscreenForVideoElement(HTMLVideoElement*, HTMLMediaElement::VideoFullscreenMode) { }
343     virtual void exitVideoFullscreen() { }
344     virtual bool requiresFullscreenForVideoPlayback() { return false; } 
345
346 #if ENABLE(FULLSCREEN_API)
347     virtual bool supportsFullScreenForElement(const Element*, bool) { return false; }
348     virtual void enterFullScreenForElement(Element*) { }
349     virtual void exitFullScreenForElement(Element*) { }
350     virtual void setRootFullScreenLayer(GraphicsLayer*) { }
351 #endif
352
353 #if USE(TILED_BACKING_STORE)
354     virtual IntRect visibleRectForTiledBackingStore() const { return IntRect(); }
355 #endif
356
357 #if PLATFORM(COCOA)
358     virtual NSResponder *firstResponder() { return 0; }
359     virtual void makeFirstResponder(NSResponder *) { }
360     // Focuses on the containing view associated with this page.
361     virtual void makeFirstResponder() { }
362 #endif
363
364 #if PLATFORM(IOS)
365     // FIXME: Come up with a more descriptive name for this function and make it platform independent (if possible).
366     virtual bool isStopping() = 0;
367 #endif
368
369     virtual void enableSuddenTermination() { }
370     virtual void disableSuddenTermination() { }
371
372 #if PLATFORM(WIN)
373     virtual void setLastSetCursorToCurrentCursor() = 0;
374     virtual void AXStartFrameLoad() = 0;
375     virtual void AXFinishFrameLoad() = 0;
376 #endif
377
378 #if ENABLE(TOUCH_EVENTS)
379     virtual void needTouchEvents(bool) = 0;
380 #endif
381
382     virtual bool selectItemWritingDirectionIsNatural() = 0;
383     virtual bool selectItemAlignmentFollowsMenuWritingDirection() = 0;
384     // Checks if there is an opened popup, called by RenderMenuList::showPopup().
385     virtual bool hasOpenedPopup() const = 0;
386     virtual PassRefPtr<PopupMenu> createPopupMenu(PopupMenuClient*) const = 0;
387     virtual PassRefPtr<SearchPopupMenu> createSearchPopupMenu(PopupMenuClient*) const = 0;
388
389     virtual void postAccessibilityNotification(AccessibilityObject*, AXObjectCache::AXNotification) { }
390
391     virtual void notifyScrollerThumbIsVisibleInRect(const IntRect&) { }
392     virtual void recommendedScrollbarStyleDidChange(int /*newStyle*/) { }
393
394     enum DialogType {
395         AlertDialog = 0,
396         ConfirmDialog = 1,
397         PromptDialog = 2,
398         HTMLDialog = 3
399     };
400     virtual bool shouldRunModalDialogDuringPageDismissal(const DialogType&, const String& dialogMessage, FrameLoader::PageDismissalType) const { UNUSED_PARAM(dialogMessage); return true; }
401
402     virtual void numWheelEventHandlersChanged(unsigned) = 0;
403         
404     virtual bool isSVGImageChromeClient() const { return false; }
405
406 #if ENABLE(POINTER_LOCK)
407     virtual bool requestPointerLock() { return false; }
408     virtual void requestPointerUnlock() { }
409     virtual bool isPointerLocked() { return false; }
410 #endif
411
412     virtual void didBeginTrackingPotentialLongMousePress(const IntPoint& mouseDownPosition, const HitTestResult&) { UNUSED_PARAM(mouseDownPosition); }
413     virtual void didRecognizeLongMousePress() { }
414     virtual void didCancelTrackingPotentialLongMousePress() { }
415
416     virtual void logDiagnosticMessage(const String& message, const String& description, const String& status) { UNUSED_PARAM(message); UNUSED_PARAM(description); UNUSED_PARAM(status); }
417
418     virtual FloatSize minimumWindowSize() const { return FloatSize(100, 100); };
419
420     virtual bool isEmptyChromeClient() const { return false; }
421
422     virtual String plugInStartLabelTitle(const String& mimeType) const { UNUSED_PARAM(mimeType); return String(); }
423     virtual String plugInStartLabelSubtitle(const String& mimeType) const { UNUSED_PARAM(mimeType); return String(); }
424     virtual String plugInExtraStyleSheet() const { return String(); }
425     virtual String plugInExtraScript() const { return String(); }
426
427     virtual void didAssociateFormControls(const Vector<RefPtr<Element>>&) { };
428     virtual bool shouldNotifyOnFormChanges() { return false; };
429
430     virtual void didAddHeaderLayer(GraphicsLayer*) { }
431     virtual void didAddFooterLayer(GraphicsLayer*) { }
432
433     virtual bool shouldUseTiledBackingForFrameView(const FrameView*) const { return false; }
434
435     virtual void isPlayingAudioDidChange(bool) { }
436
437 #if ENABLE(SUBTLE_CRYPTO)
438     virtual bool wrapCryptoKey(const Vector<uint8_t>&, Vector<uint8_t>&) const { return false; }
439     virtual bool unwrapCryptoKey(const Vector<uint8_t>&, Vector<uint8_t>&) const { return false; }
440 #endif
441
442 #if ENABLE(TELEPHONE_NUMBER_DETECTION) && PLATFORM(MAC)
443     virtual void handleTelephoneNumberClick(const String&, const WebCore::IntPoint&) { }
444 #endif
445 #if ENABLE(SERVICE_CONTROLS)
446     virtual void handleSelectionServiceClick(WebCore::FrameSelection&, const Vector<String>&, const WebCore::IntPoint&) { }
447     virtual bool hasRelevantSelectionServices(bool /* isTextOnly */) const { return false; }
448 #endif
449
450 protected:
451     virtual ~ChromeClient() { }
452 };
453
454 }
455 #endif // ChromeClient_h