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