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