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