bf5634f5c82a71333aafc48163d3e446a2f7e243
[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 "HostWindow.h"
32 #include "LayerFlushThrottleState.h"
33 #include "PopupMenu.h"
34 #include "PopupMenuClient.h"
35 #include "RenderEmbeddedObject.h"
36 #include "ScrollTypes.h"
37 #include "ScrollingCoordinator.h"
38 #include "SearchPopupMenu.h"
39 #include "WebCoreKeyboardUIMode.h"
40 #include <runtime/ConsoleTypes.h>
41 #include <wtf/Forward.h>
42 #include <wtf/Vector.h>
43
44 #if PLATFORM(IOS)
45 #include "PlatformLayer.h"
46 #define NSResponder WAKResponder
47 #ifndef __OBJC__
48 class WAKResponder;
49 #else
50 @class WAKResponder;
51 #endif
52 #endif
53
54 #if ENABLE(SQL_DATABASE)
55 #include "DatabaseDetails.h"
56 #endif
57
58 OBJC_CLASS NSResponder;
59
60 namespace WebCore {
61
62 class AccessibilityObject;
63 class ColorChooser;
64 class ColorChooserClient;
65 class DateTimeChooser;
66 class DateTimeChooserClient;
67 class Element;
68 class FileChooser;
69 class FileIconLoader;
70 class FloatRect;
71 class Frame;
72 class Geolocation;
73 class GraphicsContext3D;
74 class GraphicsLayer;
75 class GraphicsLayerFactory;
76 class HTMLInputElement;
77 class HitTestResult;
78 class IntRect;
79 class NavigationAction;
80 class Node;
81 class Page;
82 class PopupMenuClient;
83 class SecurityOrigin;
84 class ViewportConstraints;
85 class Widget;
86
87 struct DateTimeChooserParameters;
88 struct FrameLoadRequest;
89 struct GraphicsDeviceAdapter;
90 struct ViewportArguments;
91 struct WindowFeatures;
92
93 class ChromeClient {
94 public:
95     virtual void chromeDestroyed() = 0;
96
97     virtual void setWindowRect(const FloatRect&) = 0;
98     virtual FloatRect windowRect() = 0;
99
100     virtual FloatRect pageRect() = 0;
101
102     virtual void focus() = 0;
103     virtual void unfocus() = 0;
104
105     virtual bool canTakeFocus(FocusDirection) = 0;
106     virtual void takeFocus(FocusDirection) = 0;
107
108     virtual void focusedElementChanged(Element*) = 0;
109     virtual void focusedFrameChanged(Frame*) = 0;
110
111     // The Frame pointer provides the ChromeClient with context about which
112     // Frame wants to create the new Page. Also, the newly created window
113     // should not be shown to the user until the ChromeClient of the newly
114     // created Page has its show method called.
115     // The FrameLoadRequest parameter is only for ChromeClient to check if the
116     // request could be fulfilled. The ChromeClient should not load the request.
117     virtual Page* createWindow(Frame*, const FrameLoadRequest&, const WindowFeatures&, const NavigationAction&) = 0;
118     virtual void show() = 0;
119
120     virtual bool canRunModal() = 0;
121     virtual void runModal() = 0;
122
123     virtual void setToolbarsVisible(bool) = 0;
124     virtual bool toolbarsVisible() = 0;
125
126     virtual void setStatusbarVisible(bool) = 0;
127     virtual bool statusbarVisible() = 0;
128
129     virtual void setScrollbarsVisible(bool) = 0;
130     virtual bool scrollbarsVisible() = 0;
131
132     virtual void setMenubarVisible(bool) = 0;
133     virtual bool menubarVisible() = 0;
134
135     virtual void setResizable(bool) = 0;
136
137     virtual void addMessageToConsole(MessageSource, MessageLevel, const String& message, unsigned lineNumber, unsigned columnNumber, const String& sourceID) = 0;
138     // FIXME: Remove this MessageType variant once all the clients are updated.
139     virtual void addMessageToConsole(MessageSource source, MessageType, MessageLevel level, const String& message, unsigned lineNumber, unsigned columnNumber, const String& sourceID)
140     {
141         addMessageToConsole(source, level, message, lineNumber, columnNumber, sourceID);
142     }
143
144     virtual bool canRunBeforeUnloadConfirmPanel() = 0;
145     virtual bool runBeforeUnloadConfirmPanel(const String& message, Frame*) = 0;
146
147     virtual void closeWindowSoon() = 0;
148
149     virtual void runJavaScriptAlert(Frame*, const String&) = 0;
150     virtual bool runJavaScriptConfirm(Frame*, const String&) = 0;
151     virtual bool runJavaScriptPrompt(Frame*, const String& message, const String& defaultValue, String& result) = 0;
152     virtual void setStatusbarText(const String&) = 0;
153     virtual bool shouldInterruptJavaScript() = 0;
154     virtual KeyboardUIMode keyboardUIMode() = 0;
155
156     virtual IntRect windowResizerRect() const = 0;
157
158     // Methods used by HostWindow.
159     virtual bool supportsImmediateInvalidation() { return false; }
160     virtual void invalidateRootView(const IntRect&) = 0;
161     virtual void invalidateContentsAndRootView(const IntRect&) = 0;
162     virtual void invalidateContentsForSlowScroll(const IntRect&) = 0;
163     virtual void scroll(const IntSize&, const IntRect&, const IntRect&) = 0;
164 #if USE(TILED_BACKING_STORE)
165     virtual void delegatedScrollRequested(const IntPoint&) = 0;
166 #endif
167     virtual IntPoint screenToRootView(const IntPoint&) const = 0;
168     virtual IntRect rootViewToScreen(const IntRect&) const = 0;
169 #if PLATFORM(IOS)
170     virtual IntPoint accessibilityScreenToRootView(const IntPoint&) const = 0;
171     virtual IntRect rootViewToAccessibilityScreen(const IntRect&) const = 0;
172 #endif    
173     virtual PlatformPageClient platformPageClient() const = 0;
174     virtual void scrollbarsModeDidChange() const = 0;
175 #if ENABLE(CURSOR_SUPPORT)
176     virtual void setCursor(const Cursor&) = 0;
177     virtual void setCursorHiddenUntilMouseMoves(bool) = 0;
178 #endif
179 #if ENABLE(REQUEST_ANIMATION_FRAME) && !USE(REQUEST_ANIMATION_FRAME_TIMER)
180     virtual void scheduleAnimation() = 0;
181 #endif
182     // End methods used by HostWindow.
183
184     virtual FloatSize screenSize() const { return const_cast<ChromeClient*>(this)->windowRect().size(); }
185     virtual FloatSize availableScreenSize() const { return const_cast<ChromeClient*>(this)->windowRect().size(); }
186
187     virtual void dispatchViewportPropertiesDidChange(const ViewportArguments&) const { }
188
189     virtual void contentsSizeChanged(Frame*, const IntSize&) const = 0;
190     virtual void scrollRectIntoView(const IntRect&) const { }; // Currently only Mac has a non empty implementation.
191
192     virtual bool shouldUnavailablePluginMessageBeButton(RenderEmbeddedObject::PluginUnavailabilityReason) const { return false; }
193     virtual void unavailablePluginButtonClicked(Element*, RenderEmbeddedObject::PluginUnavailabilityReason) const { }
194     virtual void mouseDidMoveOverElement(const HitTestResult&, unsigned modifierFlags) = 0;
195
196     virtual void setToolTip(const String&, TextDirection) = 0;
197
198     virtual void print(Frame*) = 0;
199
200     virtual Color underlayColor() const { return Color(); }
201
202     virtual void pageExtendedBackgroundColorDidChange(Color) const { }
203
204 #if ENABLE(SQL_DATABASE)
205     virtual void exceededDatabaseQuota(Frame*, const String& databaseName, DatabaseDetails) = 0;
206 #endif
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 void populateVisitedLinks();
230
231     virtual bool shouldReplaceWithGeneratedFileForUpload(const String& path, String& generatedFilename);
232     virtual String generateReplacementFile(const String& path);
233
234 #if ENABLE(IOS_TOUCH_EVENTS)
235     virtual void didPreventDefaultForEvent() = 0;
236 #endif
237
238     virtual std::chrono::milliseconds eventThrottlingDelay() { return std::chrono::milliseconds::zero(); };
239
240 #if PLATFORM(IOS)
241     virtual void didReceiveMobileDocType(bool) = 0;
242     virtual void setNeedsScrollNotifications(Frame*, bool) = 0;
243     virtual void observedContentChange(Frame*) = 0;
244     virtual void clearContentChangeObservers(Frame*) = 0;
245     virtual void notifyRevealedSelectionByScrollingFrame(Frame*) = 0;
246
247     enum LayoutType { NormalLayout, Scroll };
248     virtual void didLayout(LayoutType = NormalLayout) = 0;
249     virtual void didStartOverflowScroll() = 0;
250     virtual void didEndOverflowScroll() = 0;
251
252     // FIXME: Remove this functionality. This functionality was added to workaround an issue (<rdar://problem/5973875>)
253     // where the unconfirmed text in a text area would be removed when a person clicks in the text area before a
254     // suggestion is shown. We should fix this issue in <rdar://problem/5975559>.
255     virtual void suppressFormNotifications() = 0;
256     virtual void restoreFormNotifications() = 0;
257
258     virtual void didFlushCompositingLayers() { }
259
260     virtual bool fetchCustomFixedPositionLayoutRect(IntRect&) { return false; }
261
262     virtual void updateViewportConstrainedLayers(HashMap<PlatformLayer*, std::unique_ptr<ViewportConstraints>>&, HashMap<PlatformLayer*, PlatformLayer*>&) { }
263
264     virtual void addOrUpdateScrollingLayer(Node*, PlatformLayer* scrollingLayer, PlatformLayer* contentsLayer, const IntSize& scrollSize, bool allowHorizontalScrollbar, bool allowVerticalScrollbar) = 0;
265     virtual void removeScrollingLayer(Node*, PlatformLayer* scrollingLayer, PlatformLayer* contentsLayer) = 0;
266
267     virtual void webAppOrientationsUpdated() = 0;
268     virtual void showPlaybackTargetPicker(bool hasVideo) = 0;
269 #endif
270
271 #if ENABLE(ORIENTATION_EVENTS)
272     virtual int deviceOrientation() const = 0;
273 #endif
274
275 #if ENABLE(INPUT_TYPE_COLOR)
276     virtual std::unique_ptr<ColorChooser> createColorChooser(ColorChooserClient*, const Color&) = 0;
277 #endif
278
279 #if ENABLE(DATE_AND_TIME_INPUT_TYPES) && !PLATFORM(IOS)
280     virtual PassRefPtr<DateTimeChooser> openDateTimeChooser(DateTimeChooserClient*, const DateTimeChooserParameters&) = 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     
290     virtual bool shouldPaintEntireContents() const { return false; }
291     virtual bool hasStablePageScaleFactor() const { return true; }
292
293     // Allows ports to customize the type of graphics layers created by this page.
294     virtual GraphicsLayerFactory* graphicsLayerFactory() const { return nullptr; }
295
296 #if USE(REQUEST_ANIMATION_FRAME_DISPLAY_MONITOR)
297     virtual PassRefPtr<DisplayRefreshMonitor> createDisplayRefreshMonitor(PlatformDisplayID) const { return nullptr; }
298 #endif
299
300     // Pass 0 as the GraphicsLayer to detatch the root layer.
301     virtual void attachRootGraphicsLayer(Frame*, GraphicsLayer*) = 0;
302     virtual void attachViewOverlayGraphicsLayer(Frame*, GraphicsLayer*) = 0;
303     // Sets a flag to specify that the next time content is drawn to the window,
304     // the changes appear on the screen in synchrony with updates to GraphicsLayers.
305     virtual void setNeedsOneShotDrawingSynchronization() = 0;
306     // Sets a flag to specify that the view needs to be updated, so we need
307     // to do an eager layout before the drawing.
308     virtual void scheduleCompositingLayerFlush() = 0;
309     // Returns whether or not the client can render the composited layer,
310     // regardless of the settings.
311     virtual bool allowsAcceleratedCompositing() const { return true; }
312
313     enum CompositingTrigger {
314         ThreeDTransformTrigger = 1 << 0,
315         VideoTrigger = 1 << 1,
316         PluginTrigger = 1 << 2,
317         CanvasTrigger = 1 << 3,
318         AnimationTrigger = 1 << 4,
319         FilterTrigger = 1 << 5,
320         ScrollableInnerFrameTrigger = 1 << 6,
321         AnimatedOpacityTrigger = 1 << 7,
322         AllTriggers = 0xFFFFFFFF
323     };
324     typedef unsigned CompositingTriggerFlags;
325
326     // Returns a bitfield indicating conditions that can trigger the compositor.
327     virtual CompositingTriggerFlags allowedCompositingTriggers() const { return static_cast<CompositingTriggerFlags>(AllTriggers); }
328     
329     // Returns true if layer tree updates are disabled.
330     virtual bool layerTreeStateIsFrozen() const { return false; }
331
332     virtual bool adjustLayerFlushThrottling(LayerFlushThrottleState::Flags) { return false; }
333
334     virtual PassRefPtr<ScrollingCoordinator> createScrollingCoordinator(Page*) const { return nullptr; }
335
336 #if PLATFORM(WIN) && USE(AVFOUNDATION)
337     virtual GraphicsDeviceAdapter* graphicsDeviceAdapter() const { return 0; }
338 #endif
339
340     virtual bool supportsVideoFullscreen() { return false; }
341     virtual void enterVideoFullscreenForVideoElement(HTMLVideoElement*) { }
342     virtual void exitVideoFullscreen() { }
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(TILED_BACKING_STORE)
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 PassRefPtr<PopupMenu> createPopupMenu(PopupMenuClient*) const = 0;
386     virtual PassRefPtr<SearchPopupMenu> createSearchPopupMenu(PopupMenuClient*) const = 0;
387
388     virtual void postAccessibilityNotification(AccessibilityObject*, AXObjectCache::AXNotification) { }
389
390     virtual void notifyScrollerThumbIsVisibleInRect(const IntRect&) { }
391     virtual void recommendedScrollbarStyleDidChange(int /*newStyle*/) { }
392
393     enum DialogType {
394         AlertDialog = 0,
395         ConfirmDialog = 1,
396         PromptDialog = 2,
397         HTMLDialog = 3
398     };
399     virtual bool shouldRunModalDialogDuringPageDismissal(const DialogType&, const String& dialogMessage, FrameLoader::PageDismissalType) const { UNUSED_PARAM(dialogMessage); return true; }
400
401     virtual void numWheelEventHandlersChanged(unsigned) = 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 void didBeginTrackingPotentialLongMousePress(const IntPoint& mouseDownPosition, const HitTestResult&) { UNUSED_PARAM(mouseDownPosition); }
412     virtual void didRecognizeLongMousePress() { }
413     virtual void didCancelTrackingPotentialLongMousePress() { }
414
415     virtual void logDiagnosticMessage(const String& message, const String& description, const String& status) { UNUSED_PARAM(message); UNUSED_PARAM(description); UNUSED_PARAM(status); }
416
417     virtual FloatSize minimumWindowSize() const { return FloatSize(100, 100); };
418
419     virtual bool isEmptyChromeClient() const { return false; }
420
421     virtual String plugInStartLabelTitle(const String& mimeType) const { UNUSED_PARAM(mimeType); return String(); }
422     virtual String plugInStartLabelSubtitle(const String& mimeType) const { UNUSED_PARAM(mimeType); return String(); }
423     virtual String plugInExtraStyleSheet() const { return String(); }
424     virtual String plugInExtraScript() const { return String(); }
425
426     virtual void didAssociateFormControls(const Vector<RefPtr<Element>>&) { };
427     virtual bool shouldNotifyOnFormChanges() { return false; };
428
429     virtual void didAddHeaderLayer(GraphicsLayer*) { }
430     virtual void didAddFooterLayer(GraphicsLayer*) { }
431
432     virtual bool shouldUseTiledBackingForFrameView(const FrameView*) const { return false; }
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 protected:
440     virtual ~ChromeClient() { }
441 };
442
443 }
444 #endif // ChromeClient_h