Allow the ChromeClient to provide a custom ScrollingCoordinator
[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 "ConsoleAPITypes.h"
27 #include "ConsoleTypes.h"
28 #include "Cursor.h"
29 #include "FocusDirection.h"
30 #include "FrameLoader.h"
31 #include "GraphicsContext.h"
32 #include "HostWindow.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 <wtf/Forward.h>
41 #include <wtf/PassOwnPtr.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&, bool immediate) = 0;
161     virtual void invalidateContentsAndRootView(const IntRect&, bool immediate) = 0;
162     virtual void invalidateContentsForSlowScroll(const IntRect&, bool immediate) = 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     virtual PlatformPageClient platformPageClient() const = 0;
170     virtual void scrollbarsModeDidChange() const = 0;
171 #if ENABLE(CURSOR_SUPPORT)
172     virtual void setCursor(const Cursor&) = 0;
173     virtual void setCursorHiddenUntilMouseMoves(bool) = 0;
174 #endif
175 #if ENABLE(REQUEST_ANIMATION_FRAME) && !USE(REQUEST_ANIMATION_FRAME_TIMER)
176     virtual void scheduleAnimation() = 0;
177 #endif
178     // End methods used by HostWindow.
179
180     virtual void dispatchViewportPropertiesDidChange(const ViewportArguments&) const { }
181
182     virtual void contentsSizeChanged(Frame*, const IntSize&) const = 0;
183     virtual void layoutUpdated(Frame*) const { }
184     virtual void scrollRectIntoView(const IntRect&) const { }; // Currently only Mac has a non empty implementation.
185
186     virtual bool shouldUnavailablePluginMessageBeButton(RenderEmbeddedObject::PluginUnavailabilityReason) const { return false; }
187     virtual void unavailablePluginButtonClicked(Element*, RenderEmbeddedObject::PluginUnavailabilityReason) const { }
188     virtual void mouseDidMoveOverElement(const HitTestResult&, unsigned modifierFlags) = 0;
189
190     virtual void setToolTip(const String&, TextDirection) = 0;
191
192     virtual void print(Frame*) = 0;
193
194     virtual Color underlayColor() const { return Color(); }
195
196 #if ENABLE(SQL_DATABASE)
197     virtual void exceededDatabaseQuota(Frame*, const String& databaseName, DatabaseDetails) = 0;
198 #endif
199
200     // Callback invoked when the application cache fails to save a cache object
201     // because storing it would grow the database file past its defined maximum
202     // size or past the amount of free space on the device. 
203     // The chrome client would need to take some action such as evicting some
204     // old caches.
205     virtual void reachedMaxAppCacheSize(int64_t spaceNeeded) = 0;
206
207     // Callback invoked when the application cache origin quota is reached. This
208     // means that the resources attempting to be cached via the manifest are
209     // more than allowed on this origin. This callback allows the chrome client
210     // to take action, such as prompting the user to ask to increase the quota
211     // for this origin. The totalSpaceNeeded parameter is the total amount of
212     // storage, in bytes, needed to store the new cache along with all of the
213     // other existing caches for the origin that would not be replaced by
214     // the new cache.
215     virtual void reachedApplicationCacheOriginQuota(SecurityOrigin*, int64_t totalSpaceNeeded) = 0;
216
217 #if ENABLE(DASHBOARD_SUPPORT) || ENABLE(DRAGGABLE_REGION)
218     virtual void annotatedRegionsChanged();
219 #endif
220
221     virtual void populateVisitedLinks();
222
223     virtual FloatRect customHighlightRect(Node*, const AtomicString& type, const FloatRect& lineRect);
224     virtual void paintCustomHighlight(Node*, const AtomicString& type, const FloatRect& boxRect, const FloatRect& lineRect, bool behindText, bool entireLine);
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 #if PLATFORM(IOS)
234     virtual void didReceiveMobileDocType() = 0;
235     virtual void setNeedsScrollNotifications(Frame*, bool) = 0;
236     virtual void observedContentChange(Frame*) = 0;
237     virtual void clearContentChangeObservers(Frame*) = 0;
238     virtual void notifyRevealedSelectionByScrollingFrame(Frame*) = 0;
239
240     enum LayoutType { NormalLayout, Scroll };
241     virtual void didLayout(LayoutType = NormalLayout) = 0;
242     virtual void didStartOverflowScroll() = 0;
243     virtual void didEndOverflowScroll() = 0;
244
245     // FIXME: Remove this functionality. This functionality was added to workaround an issue (<rdar://problem/5973875>)
246     // where the unconfirmed text in a text area would be removed when a person clicks in the text area before a
247     // suggestion is shown. We should fix this issue in <rdar://problem/5975559>.
248     virtual void suppressFormNotifications() = 0;
249     virtual void restoreFormNotifications() = 0;
250
251     virtual void didFlushCompositingLayers() { }
252
253     virtual bool fetchCustomFixedPositionLayoutRect(IntRect&) { return false; }
254
255     // FIXME: Use std::unique_ptr instead of OwnPtr.
256     virtual void updateViewportConstrainedLayers(HashMap<PlatformLayer*, OwnPtr<ViewportConstraints>>&, HashMap<PlatformLayer*, PlatformLayer*>&) { }
257
258     virtual void addOrUpdateScrollingLayer(Node*, PlatformLayer* scrollingLayer, PlatformLayer* contentsLayer, const IntSize& scrollSize, bool allowHorizontalScrollbar, bool allowVerticalScrollbar) = 0;
259     virtual void removeScrollingLayer(Node*, PlatformLayer* scrollingLayer, PlatformLayer* contentsLayer) = 0;
260
261     virtual void webAppOrientationsUpdated() = 0;
262 #endif
263
264 #if ENABLE(INPUT_TYPE_COLOR)
265     virtual PassOwnPtr<ColorChooser> createColorChooser(ColorChooserClient*, const Color&) = 0;
266 #endif
267
268 #if ENABLE(DATE_AND_TIME_INPUT_TYPES) && !PLATFORM(IOS)
269     virtual PassRefPtr<DateTimeChooser> openDateTimeChooser(DateTimeChooserClient*, const DateTimeChooserParameters&) = 0;
270 #endif
271
272     virtual void runOpenPanel(Frame*, PassRefPtr<FileChooser>) = 0;
273     // Asynchronous request to load an icon for specified filenames.
274     virtual void loadIconForFiles(const Vector<String>&, FileIconLoader*) = 0;
275
276 #if ENABLE(DIRECTORY_UPLOAD)
277     // Asychronous request to enumerate all files in a directory chosen by the user.
278     virtual void enumerateChosenDirectory(FileChooser*) = 0;
279 #endif
280
281     // Notification that the given form element has changed. This function
282     // will be called frequently, so handling should be very fast.
283     virtual void formStateDidChange(const Node*) = 0;
284         
285     virtual void elementDidFocus(const Node*) { };
286     virtual void elementDidBlur(const Node*) { };
287     
288     virtual bool shouldPaintEntireContents() const { return false; }
289
290 #if USE(ACCELERATED_COMPOSITING)
291     // Allows ports to customize the type of graphics layers created by this page.
292     virtual GraphicsLayerFactory* graphicsLayerFactory() const { return 0; }
293
294     // Pass 0 as the GraphicsLayer to detatch the root layer.
295     virtual void attachRootGraphicsLayer(Frame*, GraphicsLayer*) = 0;
296     // Sets a flag to specify that the next time content is drawn to the window,
297     // the changes appear on the screen in synchrony with updates to GraphicsLayers.
298     virtual void setNeedsOneShotDrawingSynchronization() = 0;
299     // Sets a flag to specify that the view needs to be updated, so we need
300     // to do an eager layout before the drawing.
301     virtual void scheduleCompositingLayerFlush() = 0;
302     // Returns whether or not the client can render the composited layer,
303     // regardless of the settings.
304     virtual bool allowsAcceleratedCompositing() const { return true; }
305
306     enum CompositingTrigger {
307         ThreeDTransformTrigger = 1 << 0,
308         VideoTrigger = 1 << 1,
309         PluginTrigger = 1 << 2,
310         CanvasTrigger = 1 << 3,
311         AnimationTrigger = 1 << 4,
312         FilterTrigger = 1 << 5,
313         ScrollableInnerFrameTrigger = 1 << 6,
314         AnimatedOpacityTrigger = 1 << 7,
315         AllTriggers = 0xFFFFFFFF
316     };
317     typedef unsigned CompositingTriggerFlags;
318
319     // Returns a bitfield indicating conditions that can trigger the compositor.
320     virtual CompositingTriggerFlags allowedCompositingTriggers() const { return static_cast<CompositingTriggerFlags>(AllTriggers); }
321     
322     // Returns true if layer tree updates are disabled.
323     virtual bool layerTreeStateIsFrozen() const { return false; }
324 #endif
325
326     virtual PassRefPtr<ScrollingCoordinator> createScrollingCoordinator(Page*) const { return nullptr; }
327
328 #if PLATFORM(WIN) && USE(AVFOUNDATION)
329     virtual GraphicsDeviceAdapter* graphicsDeviceAdapter() const { return 0; }
330 #endif
331
332     virtual bool supportsFullscreenForNode(const Node*) { return false; }
333     virtual void enterFullscreenForNode(Node*) { }
334     virtual void exitFullscreenForNode(Node*) { }
335     virtual bool requiresFullscreenForVideoPlayback() { return false; } 
336
337 #if ENABLE(FULLSCREEN_API)
338     virtual bool supportsFullScreenForElement(const Element*, bool) { return false; }
339     virtual void enterFullScreenForElement(Element*) { }
340     virtual void exitFullScreenForElement(Element*) { }
341     virtual void setRootFullScreenLayer(GraphicsLayer*) { }
342 #endif
343
344 #if USE(TILED_BACKING_STORE)
345     virtual IntRect visibleRectForTiledBackingStore() const { return IntRect(); }
346 #endif
347
348 #if PLATFORM(MAC)
349     virtual NSResponder *firstResponder() { return 0; }
350     virtual void makeFirstResponder(NSResponder *) { }
351     // Focuses on the containing view associated with this page.
352     virtual void makeFirstResponder() { }
353 #endif
354
355 #if PLATFORM(IOS)
356     // FIXME: Come up with a more descriptive name for this function and make it platform independent (if possible).
357     virtual bool isStopping() = 0;
358 #endif
359
360     virtual void enableSuddenTermination() { }
361     virtual void disableSuddenTermination() { }
362
363 #if PLATFORM(WIN)
364     virtual void setLastSetCursorToCurrentCursor() = 0;
365     virtual void AXStartFrameLoad() = 0;
366     virtual void AXFinishFrameLoad() = 0;
367 #endif
368
369 #if ENABLE(TOUCH_EVENTS)
370     virtual void needTouchEvents(bool) = 0;
371 #endif
372
373     virtual bool selectItemWritingDirectionIsNatural() = 0;
374     virtual bool selectItemAlignmentFollowsMenuWritingDirection() = 0;
375     // Checks if there is an opened popup, called by RenderMenuList::showPopup().
376     virtual bool hasOpenedPopup() const = 0;
377     virtual PassRefPtr<PopupMenu> createPopupMenu(PopupMenuClient*) const = 0;
378     virtual PassRefPtr<SearchPopupMenu> createSearchPopupMenu(PopupMenuClient*) const = 0;
379
380     virtual void postAccessibilityNotification(AccessibilityObject*, AXObjectCache::AXNotification) { }
381
382     virtual void notifyScrollerThumbIsVisibleInRect(const IntRect&) { }
383     virtual void recommendedScrollbarStyleDidChange(int /*newStyle*/) { }
384
385     enum DialogType {
386         AlertDialog = 0,
387         ConfirmDialog = 1,
388         PromptDialog = 2,
389         HTMLDialog = 3
390     };
391     virtual bool shouldRunModalDialogDuringPageDismissal(const DialogType&, const String& dialogMessage, FrameLoader::PageDismissalType) const { UNUSED_PARAM(dialogMessage); return true; }
392
393     virtual void numWheelEventHandlersChanged(unsigned) = 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 logDiagnosticMessage(const String& message, const String& description, const String& status) { UNUSED_PARAM(message); UNUSED_PARAM(description); UNUSED_PARAM(status); }
404
405     virtual FloatSize minimumWindowSize() const { return FloatSize(100, 100); };
406
407     virtual bool isEmptyChromeClient() const { return false; }
408
409     virtual String plugInStartLabelTitle(const String& mimeType) const { UNUSED_PARAM(mimeType); return String(); }
410     virtual String plugInStartLabelSubtitle(const String& mimeType) const { UNUSED_PARAM(mimeType); return String(); }
411     virtual String plugInExtraStyleSheet() const { return String(); }
412     virtual String plugInExtraScript() const { return String(); }
413
414     virtual void didAssociateFormControls(const Vector<RefPtr<Element>>&) { };
415     virtual bool shouldNotifyOnFormChanges() { return false; };
416
417     virtual void didAddHeaderLayer(GraphicsLayer*) { }
418     virtual void didAddFooterLayer(GraphicsLayer*) { }
419
420     virtual bool shouldUseTiledBackingForFrameView(const FrameView*) const { return false; }
421
422     // These methods are used to report pages that are performing
423     // some task that we consider to be "active", and so the user
424     // would likely want the page to remain running uninterrupted.
425     virtual void incrementActivePageCount() { }
426     virtual void decrementActivePageCount() { }
427
428 protected:
429     virtual ~ChromeClient() { }
430 };
431
432 }
433 #endif // ChromeClient_h