Remove ENABLE(SQL_DATABASE) guards
[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 "HTMLMediaElement.h"
33 #include "HostWindow.h"
34 #include "LayerFlushThrottleState.h"
35 #include "PageThrottler.h"
36 #include "PopupMenu.h"
37 #include "PopupMenuClient.h"
38 #include "RenderEmbeddedObject.h"
39 #include "ScrollTypes.h"
40 #include "ScrollingCoordinator.h"
41 #include "SearchPopupMenu.h"
42 #include "WebCoreKeyboardUIMode.h"
43 #include <runtime/ConsoleTypes.h>
44 #include <wtf/Forward.h>
45 #include <wtf/Vector.h>
46
47 #if PLATFORM(IOS)
48 #include "PlatformLayer.h"
49 #define NSResponder WAKResponder
50 #ifndef __OBJC__
51 class WAKResponder;
52 #else
53 @class WAKResponder;
54 #endif
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 HTMLVideoElement;
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 WEBCORE_EXPORT 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     virtual void exceededDatabaseQuota(Frame*, const String& databaseName, DatabaseDetails) = 0;
205
206     // Callback invoked when the application cache fails to save a cache object
207     // because storing it would grow the database file past its defined maximum
208     // size or past the amount of free space on the device. 
209     // The chrome client would need to take some action such as evicting some
210     // old caches.
211     virtual void reachedMaxAppCacheSize(int64_t spaceNeeded) = 0;
212
213     // Callback invoked when the application cache origin quota is reached. This
214     // means that the resources attempting to be cached via the manifest are
215     // more than allowed on this origin. This callback allows the chrome client
216     // to take action, such as prompting the user to ask to increase the quota
217     // for this origin. The totalSpaceNeeded parameter is the total amount of
218     // storage, in bytes, needed to store the new cache along with all of the
219     // other existing caches for the origin that would not be replaced by
220     // the new cache.
221     virtual void reachedApplicationCacheOriginQuota(SecurityOrigin*, int64_t totalSpaceNeeded) = 0;
222
223 #if ENABLE(DASHBOARD_SUPPORT)
224     virtual void annotatedRegionsChanged();
225 #endif
226
227     virtual bool shouldReplaceWithGeneratedFileForUpload(const String& path, String& generatedFilename);
228     virtual String generateReplacementFile(const String& path);
229
230 #if ENABLE(IOS_TOUCH_EVENTS)
231     virtual void didPreventDefaultForEvent() = 0;
232 #endif
233
234     virtual std::chrono::milliseconds eventThrottlingDelay() { return std::chrono::milliseconds::zero(); };
235
236 #if PLATFORM(IOS)
237     virtual void didReceiveMobileDocType(bool) = 0;
238     virtual void setNeedsScrollNotifications(Frame*, bool) = 0;
239     virtual void observedContentChange(Frame*) = 0;
240     virtual void clearContentChangeObservers(Frame*) = 0;
241     virtual void notifyRevealedSelectionByScrollingFrame(Frame*) = 0;
242
243     enum LayoutType { NormalLayout, Scroll };
244     virtual void didLayout(LayoutType = NormalLayout) = 0;
245     virtual void didStartOverflowScroll() = 0;
246     virtual void didEndOverflowScroll() = 0;
247
248     // FIXME: Remove this functionality. This functionality was added to workaround an issue (<rdar://problem/5973875>)
249     // where the unconfirmed text in a text area would be removed when a person clicks in the text area before a
250     // suggestion is shown. We should fix this issue in <rdar://problem/5975559>.
251     virtual void suppressFormNotifications() = 0;
252     virtual void restoreFormNotifications() = 0;
253
254     virtual void didFlushCompositingLayers() { }
255
256     virtual bool fetchCustomFixedPositionLayoutRect(IntRect&) { return false; }
257
258     virtual void updateViewportConstrainedLayers(HashMap<PlatformLayer*, std::unique_ptr<ViewportConstraints>>&, HashMap<PlatformLayer*, PlatformLayer*>&) { }
259
260     virtual void addOrUpdateScrollingLayer(Node*, PlatformLayer* scrollingLayer, PlatformLayer* contentsLayer, const IntSize& scrollSize, bool allowHorizontalScrollbar, bool allowVerticalScrollbar) = 0;
261     virtual void removeScrollingLayer(Node*, PlatformLayer* scrollingLayer, PlatformLayer* contentsLayer) = 0;
262
263     virtual void webAppOrientationsUpdated() = 0;
264     virtual void showPlaybackTargetPicker(bool hasVideo) = 0;
265 #endif
266
267 #if ENABLE(ORIENTATION_EVENTS)
268     virtual int deviceOrientation() const = 0;
269 #endif
270
271 #if ENABLE(INPUT_TYPE_COLOR)
272     virtual std::unique_ptr<ColorChooser> createColorChooser(ColorChooserClient*, const Color&) = 0;
273 #endif
274
275 #if ENABLE(DATE_AND_TIME_INPUT_TYPES) && !PLATFORM(IOS)
276     virtual PassRefPtr<DateTimeChooser> openDateTimeChooser(DateTimeChooserClient*, const DateTimeChooserParameters&) = 0;
277 #endif
278
279     virtual void runOpenPanel(Frame*, PassRefPtr<FileChooser>) = 0;
280     // Asynchronous request to load an icon for specified filenames.
281     virtual void loadIconForFiles(const Vector<String>&, FileIconLoader*) = 0;
282         
283     virtual void elementDidFocus(const Node*) { };
284     virtual void elementDidBlur(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 PassRefPtr<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*, HTMLMediaElement::VideoFullscreenMode) { }
339 #endif
340     virtual void exitVideoFullscreen() { }
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(TILED_BACKING_STORE)
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 PassRefPtr<PopupMenu> createPopupMenu(PopupMenuClient*) const = 0;
384     virtual PassRefPtr<SearchPopupMenu> createSearchPopupMenu(PopupMenuClient*) const = 0;
385
386     virtual void postAccessibilityNotification(AccessibilityObject*, AXObjectCache::AXNotification) { }
387
388     virtual void notifyScrollerThumbIsVisibleInRect(const IntRect&) { }
389     virtual void recommendedScrollbarStyleDidChange(int /*newStyle*/) { }
390
391     enum DialogType {
392         AlertDialog = 0,
393         ConfirmDialog = 1,
394         PromptDialog = 2,
395         HTMLDialog = 3
396     };
397     virtual bool shouldRunModalDialogDuringPageDismissal(const DialogType&, const String& dialogMessage, FrameLoader::PageDismissalType) const { UNUSED_PARAM(dialogMessage); return true; }
398
399     virtual void numWheelEventHandlersChanged(unsigned) = 0;
400         
401     virtual bool isSVGImageChromeClient() const { return false; }
402
403 #if ENABLE(POINTER_LOCK)
404     virtual bool requestPointerLock() { return false; }
405     virtual void requestPointerUnlock() { }
406     virtual bool isPointerLocked() { return false; }
407 #endif
408
409     virtual void didBeginTrackingPotentialLongMousePress(const IntPoint& mouseDownPosition, const HitTestResult&) { UNUSED_PARAM(mouseDownPosition); }
410     virtual void didRecognizeLongMousePress() { }
411     virtual void didCancelTrackingPotentialLongMousePress() { }
412
413     virtual FloatSize minimumWindowSize() const { return FloatSize(100, 100); };
414
415     virtual bool isEmptyChromeClient() const { return false; }
416
417     virtual String plugInStartLabelTitle(const String& mimeType) const { UNUSED_PARAM(mimeType); return String(); }
418     virtual String plugInStartLabelSubtitle(const String& mimeType) const { UNUSED_PARAM(mimeType); return String(); }
419     virtual String plugInExtraStyleSheet() const { return String(); }
420     virtual String plugInExtraScript() const { return String(); }
421
422     virtual void didAssociateFormControls(const Vector<RefPtr<Element>>&) { };
423     virtual bool shouldNotifyOnFormChanges() { return false; };
424
425     virtual void didAddHeaderLayer(GraphicsLayer*) { }
426     virtual void didAddFooterLayer(GraphicsLayer*) { }
427
428     virtual bool shouldUseTiledBackingForFrameView(const FrameView*) const { return false; }
429
430     virtual void isPlayingAudioDidChange(bool) { }
431     virtual void setPageActivityState(PageActivityState::Flags) { }
432
433 #if ENABLE(SUBTLE_CRYPTO)
434     virtual bool wrapCryptoKey(const Vector<uint8_t>&, Vector<uint8_t>&) const { return false; }
435     virtual bool unwrapCryptoKey(const Vector<uint8_t>&, Vector<uint8_t>&) const { return false; }
436 #endif
437
438 #if ENABLE(TELEPHONE_NUMBER_DETECTION) && PLATFORM(MAC)
439     virtual void handleTelephoneNumberClick(const String&, const WebCore::IntPoint&) { }
440 #endif
441 #if ENABLE(SERVICE_CONTROLS)
442     virtual void handleSelectionServiceClick(WebCore::FrameSelection&, const Vector<String>&, const WebCore::IntPoint&) { }
443     virtual bool hasRelevantSelectionServices(bool /* isTextOnly */) const { return false; }
444 #endif
445
446     virtual bool shouldDispatchFakeMouseMoveEvents() const { return true; }
447
448 protected:
449     virtual ~ChromeClient() { }
450 };
451
452 }
453 #endif // ChromeClient_h