Playback controls refer to wrong element when playing multiple items in a page.
[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 class MediaSessionMetadata;
51 }
52 #endif
53
54 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
55 #include "MediaPlaybackTargetContext.h"
56 #endif
57
58 #if PLATFORM(IOS)
59 #include "PlatformLayer.h"
60 #define NSResponder WAKResponder
61 #ifndef __OBJC__
62 class WAKResponder;
63 #else
64 @class WAKResponder;
65 #endif
66 #endif
67
68 OBJC_CLASS NSResponder;
69
70 namespace WebCore {
71
72 class AccessibilityObject;
73 class ColorChooser;
74 class ColorChooserClient;
75 class DateTimeChooser;
76 class DateTimeChooserClient;
77 class Element;
78 class FileChooser;
79 class FileIconLoader;
80 class FloatRect;
81 class Frame;
82 class Geolocation;
83 class GraphicsContext3D;
84 class GraphicsLayer;
85 class GraphicsLayerFactory;
86 class HTMLInputElement;
87 class HTMLMediaElement;
88 class HTMLVideoElement;
89 class HitTestResult;
90 class IntRect;
91 class NavigationAction;
92 class Node;
93 class Page;
94 class PopupMenuClient;
95 class SecurityOrigin;
96 class ViewportConstraints;
97 class Widget;
98
99 #if ENABLE(VIDEO) && USE(GSTREAMER)
100 class MediaPlayerRequestInstallMissingPluginsCallback;
101 #endif
102
103 struct DateTimeChooserParameters;
104 struct FrameLoadRequest;
105 struct GraphicsDeviceAdapter;
106 struct ViewportArguments;
107 struct WindowFeatures;
108
109 class WEBCORE_EXPORT ChromeClient {
110 public:
111     virtual void chromeDestroyed() = 0;
112
113     virtual void setWindowRect(const FloatRect&) = 0;
114     virtual FloatRect windowRect() = 0;
115
116     virtual FloatRect pageRect() = 0;
117
118     virtual void focus() = 0;
119     virtual void unfocus() = 0;
120
121     virtual bool canTakeFocus(FocusDirection) = 0;
122     virtual void takeFocus(FocusDirection) = 0;
123
124     virtual void focusedElementChanged(Element*) = 0;
125     virtual void focusedFrameChanged(Frame*) = 0;
126
127     // The Frame pointer provides the ChromeClient with context about which
128     // Frame wants to create the new Page. Also, the newly created window
129     // should not be shown to the user until the ChromeClient of the newly
130     // created Page has its show method called.
131     // The FrameLoadRequest parameter is only for ChromeClient to check if the
132     // request could be fulfilled. The ChromeClient should not load the request.
133     virtual Page* createWindow(Frame*, const FrameLoadRequest&, const WindowFeatures&, const NavigationAction&) = 0;
134     virtual void show() = 0;
135
136     virtual bool canRunModal() = 0;
137     virtual void runModal() = 0;
138
139     virtual void setToolbarsVisible(bool) = 0;
140     virtual bool toolbarsVisible() = 0;
141
142     virtual void setStatusbarVisible(bool) = 0;
143     virtual bool statusbarVisible() = 0;
144
145     virtual void setScrollbarsVisible(bool) = 0;
146     virtual bool scrollbarsVisible() = 0;
147
148     virtual void setMenubarVisible(bool) = 0;
149     virtual bool menubarVisible() = 0;
150
151     virtual void setResizable(bool) = 0;
152
153     virtual void addMessageToConsole(MessageSource, MessageLevel, const String& message, unsigned lineNumber, unsigned columnNumber, const String& sourceID) = 0;
154
155     virtual bool canRunBeforeUnloadConfirmPanel() = 0;
156     virtual bool runBeforeUnloadConfirmPanel(const String& message, Frame*) = 0;
157
158     virtual void closeWindowSoon() = 0;
159
160     virtual void runJavaScriptAlert(Frame*, const String&) = 0;
161     virtual bool runJavaScriptConfirm(Frame*, const String&) = 0;
162     virtual bool runJavaScriptPrompt(Frame*, const String& message, const String& defaultValue, String& result) = 0;
163     virtual void setStatusbarText(const String&) = 0;
164     virtual KeyboardUIMode keyboardUIMode() = 0;
165
166     // Methods used by HostWindow.
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 #if USE(COORDINATED_GRAPHICS)
173     virtual void delegatedScrollRequested(const IntPoint&) = 0;
174 #endif
175     virtual IntPoint screenToRootView(const IntPoint&) const = 0;
176     virtual IntRect rootViewToScreen(const IntRect&) const = 0;
177 #if PLATFORM(IOS)
178     virtual IntPoint accessibilityScreenToRootView(const IntPoint&) const = 0;
179     virtual IntRect rootViewToAccessibilityScreen(const IntRect&) const = 0;
180 #endif    
181     virtual PlatformPageClient platformPageClient() const = 0;
182     virtual void scrollbarsModeDidChange() const = 0;
183 #if ENABLE(CURSOR_SUPPORT)
184     virtual void setCursor(const Cursor&) = 0;
185     virtual void setCursorHiddenUntilMouseMoves(bool) = 0;
186 #endif
187 #if ENABLE(REQUEST_ANIMATION_FRAME) && !USE(REQUEST_ANIMATION_FRAME_TIMER)
188     virtual void scheduleAnimation() = 0;
189 #endif
190     // End methods used by HostWindow.
191
192     virtual FloatSize screenSize() const { return const_cast<ChromeClient*>(this)->windowRect().size(); }
193     virtual FloatSize availableScreenSize() const { return const_cast<ChromeClient*>(this)->windowRect().size(); }
194
195     virtual void dispatchViewportPropertiesDidChange(const ViewportArguments&) const { }
196
197     virtual void contentsSizeChanged(Frame*, const IntSize&) const = 0;
198     virtual void scrollRectIntoView(const IntRect&) const { }; // Currently only Mac has a non empty implementation.
199
200     virtual bool shouldUnavailablePluginMessageBeButton(RenderEmbeddedObject::PluginUnavailabilityReason) const { return false; }
201     virtual void unavailablePluginButtonClicked(Element*, RenderEmbeddedObject::PluginUnavailabilityReason) const { }
202     virtual void mouseDidMoveOverElement(const HitTestResult&, unsigned modifierFlags) = 0;
203
204     virtual void setToolTip(const String&, TextDirection) = 0;
205
206     virtual void print(Frame*) = 0;
207
208     virtual Color underlayColor() const { return Color(); }
209
210     virtual void pageExtendedBackgroundColorDidChange(Color) const { }
211
212     virtual void exceededDatabaseQuota(Frame*, const String& databaseName, DatabaseDetails) = 0;
213
214     // Callback invoked when the application cache fails to save a cache object
215     // because storing it would grow the database file past its defined maximum
216     // size or past the amount of free space on the device. 
217     // The chrome client would need to take some action such as evicting some
218     // old caches.
219     virtual void reachedMaxAppCacheSize(int64_t spaceNeeded) = 0;
220
221     // Callback invoked when the application cache origin quota is reached. This
222     // means that the resources attempting to be cached via the manifest are
223     // more than allowed on this origin. This callback allows the chrome client
224     // to take action, such as prompting the user to ask to increase the quota
225     // for this origin. The totalSpaceNeeded parameter is the total amount of
226     // storage, in bytes, needed to store the new cache along with all of the
227     // other existing caches for the origin that would not be replaced by
228     // the new cache.
229     virtual void reachedApplicationCacheOriginQuota(SecurityOrigin*, int64_t totalSpaceNeeded) = 0;
230
231 #if ENABLE(DASHBOARD_SUPPORT)
232     virtual void annotatedRegionsChanged();
233 #endif
234
235     virtual bool shouldReplaceWithGeneratedFileForUpload(const String& path, String& generatedFilename);
236     virtual String generateReplacementFile(const String& path);
237
238 #if ENABLE(IOS_TOUCH_EVENTS)
239     virtual void didPreventDefaultForEvent() = 0;
240 #endif
241
242     virtual std::chrono::milliseconds eventThrottlingDelay() { return 0ms; };
243
244 #if PLATFORM(IOS)
245     virtual void didReceiveMobileDocType(bool) = 0;
246     virtual void setNeedsScrollNotifications(Frame*, bool) = 0;
247     virtual void observedContentChange(Frame*) = 0;
248     virtual void clearContentChangeObservers(Frame*) = 0;
249     virtual void notifyRevealedSelectionByScrollingFrame(Frame*) = 0;
250
251     enum LayoutType { NormalLayout, Scroll };
252     virtual void didLayout(LayoutType = NormalLayout) = 0;
253     virtual void didStartOverflowScroll() = 0;
254     virtual void didEndOverflowScroll() = 0;
255
256     // FIXME: Remove this functionality. This functionality was added to workaround an issue (<rdar://problem/5973875>)
257     // where the unconfirmed text in a text area would be removed when a person clicks in the text area before a
258     // suggestion is shown. We should fix this issue in <rdar://problem/5975559>.
259     virtual void suppressFormNotifications() = 0;
260     virtual void restoreFormNotifications() = 0;
261
262     virtual void didFlushCompositingLayers() { }
263
264     virtual bool fetchCustomFixedPositionLayoutRect(IntRect&) { return false; }
265
266     virtual void updateViewportConstrainedLayers(HashMap<PlatformLayer*, std::unique_ptr<ViewportConstraints>>&, HashMap<PlatformLayer*, PlatformLayer*>&) { }
267
268     virtual void addOrUpdateScrollingLayer(Node*, PlatformLayer* scrollingLayer, PlatformLayer* contentsLayer, const IntSize& scrollSize, bool allowHorizontalScrollbar, bool allowVerticalScrollbar) = 0;
269     virtual void removeScrollingLayer(Node*, PlatformLayer* scrollingLayer, PlatformLayer* contentsLayer) = 0;
270
271     virtual void webAppOrientationsUpdated() = 0;
272     virtual void showPlaybackTargetPicker(bool hasVideo) = 0;
273 #endif
274
275 #if ENABLE(ORIENTATION_EVENTS)
276     virtual int deviceOrientation() const = 0;
277 #endif
278
279 #if ENABLE(INPUT_TYPE_COLOR)
280     virtual std::unique_ptr<ColorChooser> createColorChooser(ColorChooserClient*, const Color&) = 0;
281 #endif
282
283     virtual void runOpenPanel(Frame*, PassRefPtr<FileChooser>) = 0;
284     // Asynchronous request to load an icon for specified filenames.
285     virtual void loadIconForFiles(const Vector<String>&, FileIconLoader*) = 0;
286         
287     virtual void elementDidFocus(const Node*) { };
288     virtual void elementDidBlur(const Node*) { };
289     virtual void elementDidRefocus(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 RefPtr<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(HTMLMediaElementEnums::VideoFullscreenMode) { return false; }
342 #if ENABLE(VIDEO)
343     virtual void enterVideoFullscreenForVideoElement(HTMLVideoElement&, HTMLMediaElementEnums::VideoFullscreenMode) { }
344     virtual void setUpPlaybackControlsManager(HTMLMediaElement&) { }
345     virtual void clearPlaybackControlsManager() { }
346 #endif
347     virtual void exitVideoFullscreenForVideoElement(WebCore::HTMLVideoElement&) { }
348     virtual void exitVideoFullscreenToModeWithoutAnimation(WebCore::HTMLVideoElement&, HTMLMediaElementEnums::VideoFullscreenMode /*targetMode*/) { }
349     virtual bool requiresFullscreenForVideoPlayback() { return false; } 
350
351 #if ENABLE(FULLSCREEN_API)
352     virtual bool supportsFullScreenForElement(const Element*, bool) { return false; }
353     virtual void enterFullScreenForElement(Element*) { }
354     virtual void exitFullScreenForElement(Element*) { }
355     virtual void setRootFullScreenLayer(GraphicsLayer*) { }
356 #endif
357
358 #if USE(COORDINATED_GRAPHICS)
359     virtual IntRect visibleRectForTiledBackingStore() const { return IntRect(); }
360 #endif
361
362 #if PLATFORM(COCOA)
363     virtual NSResponder *firstResponder() { return 0; }
364     virtual void makeFirstResponder(NSResponder *) { }
365     // Focuses on the containing view associated with this page.
366     virtual void makeFirstResponder() { }
367 #endif
368
369 #if PLATFORM(IOS)
370     // FIXME: Come up with a more descriptive name for this function and make it platform independent (if possible).
371     virtual bool isStopping() = 0;
372 #endif
373
374     virtual void enableSuddenTermination() { }
375     virtual void disableSuddenTermination() { }
376
377 #if PLATFORM(WIN)
378     virtual void setLastSetCursorToCurrentCursor() = 0;
379     virtual void AXStartFrameLoad() = 0;
380     virtual void AXFinishFrameLoad() = 0;
381 #endif
382
383 #if ENABLE(TOUCH_EVENTS)
384     virtual void needTouchEvents(bool) = 0;
385 #endif
386
387     virtual bool selectItemWritingDirectionIsNatural() = 0;
388     virtual bool selectItemAlignmentFollowsMenuWritingDirection() = 0;
389     // Checks if there is an opened popup, called by RenderMenuList::showPopup().
390     virtual bool hasOpenedPopup() const = 0;
391     virtual RefPtr<PopupMenu> createPopupMenu(PopupMenuClient*) const = 0;
392     virtual RefPtr<SearchPopupMenu> createSearchPopupMenu(PopupMenuClient*) const = 0;
393
394     virtual void postAccessibilityNotification(AccessibilityObject*, AXObjectCache::AXNotification) { }
395
396     virtual void notifyScrollerThumbIsVisibleInRect(const IntRect&) { }
397     virtual void recommendedScrollbarStyleDidChange(ScrollbarStyle) { }
398
399     virtual WTF::Optional<ScrollbarOverlayStyle> preferredScrollbarOverlayStyle() { return ScrollbarOverlayStyleDefault; }
400
401     virtual void wheelEventHandlersChanged(bool hasHandlers) = 0;
402         
403     virtual bool isSVGImageChromeClient() const { return false; }
404
405 #if ENABLE(POINTER_LOCK)
406     virtual bool requestPointerLock() { return false; }
407     virtual void requestPointerUnlock() { }
408     virtual bool isPointerLocked() { return false; }
409 #endif
410
411     virtual FloatSize minimumWindowSize() const { return FloatSize(100, 100); };
412
413     virtual bool isEmptyChromeClient() const { return false; }
414
415     virtual String plugInStartLabelTitle(const String& mimeType) const { UNUSED_PARAM(mimeType); return String(); }
416     virtual String plugInStartLabelSubtitle(const String& mimeType) const { UNUSED_PARAM(mimeType); return String(); }
417     virtual String plugInExtraStyleSheet() const { return String(); }
418     virtual String plugInExtraScript() const { return String(); }
419
420     virtual void didAssociateFormControls(const Vector<RefPtr<Element>>&) { };
421     virtual bool shouldNotifyOnFormChanges() { return false; };
422
423     virtual void didAddHeaderLayer(GraphicsLayer*) { }
424     virtual void didAddFooterLayer(GraphicsLayer*) { }
425
426     virtual bool shouldUseTiledBackingForFrameView(const FrameView*) const { return false; }
427
428     virtual void isPlayingMediaDidChange(MediaProducer::MediaStateFlags, uint64_t) { }
429
430 #if ENABLE(MEDIA_SESSION)
431     virtual void hasMediaSessionWithActiveMediaElementsDidChange(bool) { }
432     virtual void mediaSessionMetadataDidChange(const WebCore::MediaSessionMetadata&) { }
433     virtual void focusedContentMediaElementDidChange(uint64_t) { }
434 #endif
435
436     virtual void setPageActivityState(PageActivityState::Flags) { }
437
438 #if ENABLE(SUBTLE_CRYPTO)
439     virtual bool wrapCryptoKey(const Vector<uint8_t>&, Vector<uint8_t>&) const { return false; }
440     virtual bool unwrapCryptoKey(const Vector<uint8_t>&, Vector<uint8_t>&) const { return false; }
441 #endif
442
443 #if ENABLE(TELEPHONE_NUMBER_DETECTION) && PLATFORM(MAC)
444     virtual void handleTelephoneNumberClick(const String&, const WebCore::IntPoint&) { }
445 #endif
446 #if ENABLE(SERVICE_CONTROLS)
447     virtual void handleSelectionServiceClick(WebCore::FrameSelection&, const Vector<String>&, const WebCore::IntPoint&) { }
448     virtual bool hasRelevantSelectionServices(bool /* isTextOnly */) const { return false; }
449 #endif
450
451     virtual bool shouldDispatchFakeMouseMoveEvents() const { return true; }
452
453     virtual void handleAutoFillButtonClick(HTMLInputElement&) { }
454
455 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
456     virtual void addPlaybackTargetPickerClient(uint64_t /*contextId*/) { }
457     virtual void removePlaybackTargetPickerClient(uint64_t /*contextId*/) { }
458     virtual void showPlaybackTargetPicker(uint64_t /*contextId*/, const WebCore::IntPoint&, bool /* isVideo */) { }
459     virtual void playbackTargetPickerClientStateDidChange(uint64_t /*contextId*/, MediaProducer::MediaStateFlags) { }
460     virtual void setMockMediaPlaybackTargetPickerEnabled(bool)  { }
461     virtual void setMockMediaPlaybackTargetPickerState(const String&, WebCore::MediaPlaybackTargetContext::State) { }
462 #endif
463
464     virtual void imageOrMediaDocumentSizeChanged(const WebCore::IntSize&) { }
465
466 #if ENABLE(VIDEO) && USE(GSTREAMER)
467     virtual void requestInstallMissingMediaPlugins(const String& /*details*/, const String& /*description*/, MediaPlayerRequestInstallMissingPluginsCallback&) { }
468 #endif
469
470     virtual void didInvalidateDocumentMarkerRects() { }
471
472 protected:
473     virtual ~ChromeClient() { }
474 };
475
476 }
477 #endif // ChromeClient_h