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