Throttle RequestAnimationFrame in subframes that are outside the viewport
[WebKit-https.git] / Source / WebCore / testing / Internals.idl
1 /*
2  * Copyright (C) 2012 Google Inc. All rights reserved.
3  * Copyright (C) 2013, 2014 Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer.
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
16  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
19  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 enum PageOverlayType {
28 "view",
29 "document"
30 };
31
32 // These map to ResourceRequestCachePolicy.
33 enum CachePolicy {
34     "UseProtocolCachePolicy",
35     "ReloadIgnoringCacheData",
36     "ReturnCacheDataElseLoad",
37     "ReturnCacheDataDontLoad"
38 };
39
40 enum ResourceLoadPriority {
41     "ResourceLoadPriorityVeryLow",
42     "ResourceLoadPriorityLow",
43     "ResourceLoadPriorityMedium",
44     "ResourceLoadPriorityHigh",
45     "ResourceLoadPriorityVeryHigh"
46 };
47
48 [
49     NoInterfaceObject,
50 ] interface Internals {
51     DOMString address(Node node);
52     [RaisesException] boolean nodeNeedsStyleRecalc(Node node);
53     DOMString description(any value);
54
55     // Animated image pausing testing.
56     [RaisesException] boolean hasPausedImageAnimations(Element element);
57
58     [RaisesException] DOMString elementRenderTreeAsText(Element element);
59     boolean isPreloaded(DOMString url);
60     boolean isLoadingFromMemoryCache(DOMString url);
61     DOMString xhrResponseSource(XMLHttpRequest xhr);
62     void clearMemoryCache();
63     void pruneMemoryCacheToSize(long size);
64     long memoryCacheSize();
65     void setOverrideCachePolicy(CachePolicy policy);
66     void setOverrideResourceLoadPriority(ResourceLoadPriority priority);
67
68     void clearPageCache();
69     unsigned int pageCacheSize();
70
71     [RaisesException] CSSStyleDeclaration computedStyleIncludingVisitedInfo(Node node);
72
73     [RaisesException] Node ensureShadowRoot(Element host);
74     [RaisesException] Node createShadowRoot(Element host);
75     [RaisesException] Node shadowRoot(Element host);
76
77     [RaisesException] DOMString shadowRootType(Node root);
78     [RaisesException] Element includerFor(Node node);
79     [RaisesException] DOMString shadowPseudoId(Element element);
80     [RaisesException] void setShadowPseudoId(Element element, DOMString id);
81     [RaisesException] Node treeScopeRootNode(Node node);
82     [RaisesException] Node parentTreeScope(Node node);
83
84     // Spatial Navigation testing
85     [RaisesException] unsigned long lastSpatialNavigationCandidateCount();
86
87     // CSS Animation testing.
88     unsigned long numberOfActiveAnimations();
89     [RaisesException] void suspendAnimations();
90     [RaisesException] void resumeAnimations();
91     [RaisesException] boolean animationsAreSuspended();
92     [RaisesException] boolean pauseAnimationAtTimeOnElement(DOMString animationName, unrestricted double pauseTime, Element element);
93     [RaisesException] boolean pauseAnimationAtTimeOnPseudoElement(DOMString animationName, unrestricted double pauseTime, Element element, DOMString pseudoId);
94
95     // CSS Transition testing.
96     [RaisesException] boolean pauseTransitionAtTimeOnElement(DOMString propertyName, unrestricted double pauseTime, Element element);
97     [RaisesException] boolean pauseTransitionAtTimeOnPseudoElement(DOMString property, unrestricted double pauseTime, Element element, DOMString pseudoId);
98
99     [RaisesException] boolean attached(Node node);
100
101     DOMString visiblePlaceholder(Element element);
102 #if defined(ENABLE_INPUT_TYPE_COLOR) && ENABLE_INPUT_TYPE_COLOR
103     void selectColorInColorChooser(Element element, DOMString colorValue);
104 #endif
105     [RaisesException] DOMString[] formControlStateOfPreviousHistoryItem();
106     [RaisesException] void setFormControlStateOfPreviousHistoryItem(sequence<DOMString> values);
107
108     [RaisesException] ClientRect absoluteCaretBounds();
109
110     [RaisesException] ClientRect boundingBox(Element element);
111
112     [RaisesException] ClientRectList inspectorHighlightRects();
113     [RaisesException] DOMString inspectorHighlightObject();
114
115     [RaisesException] unsigned long markerCountForNode(Node node, DOMString markerType);
116     [RaisesException] Range markerRangeForNode(Node node, DOMString markerType, unsigned long index);
117     [RaisesException] DOMString markerDescriptionForNode(Node node, DOMString markerType, unsigned long index);
118     void addTextMatchMarker(Range range, boolean isActive);
119     [RaisesException] void setMarkedTextMatchesAreHighlighted(boolean flag);
120
121     void invalidateFontCache();
122
123     [RaisesException] void setScrollViewPosition(long x, long y);
124
125     [RaisesException] void setViewBaseBackgroundColor(DOMString colorValue);
126
127     [RaisesException] void setPagination(DOMString mode, long gap, optional long pageLength);
128
129     [RaisesException] DOMString configurationForViewport(unrestricted float devicePixelRatio,
130                                        long deviceWidth,
131                                        long deviceHeight,
132                                        long availableWidth,
133                                        long availableHeight);
134
135     [RaisesException] boolean wasLastChangeUserEdit(Element textField);
136     [RaisesException] boolean elementShouldAutoComplete(Element inputElement);
137     [RaisesException] void setEditingValue(Element inputElement, DOMString value);
138     [RaisesException] void setAutofilled(Element inputElement, boolean enabled);
139     [RaisesException] void setShowAutoFillButton(Element inputElement, boolean enabled);
140     [RaisesException] unsigned long countMatchesForText(DOMString text, unsigned long findOptions, DOMString markMatches);
141
142     [RaisesException] void paintControlTints();
143
144     [RaisesException] void scrollElementToRect(Element element, long x, long y, long w, long h);
145
146     [RaisesException] Range rangeFromLocationAndLength(Element scope, long rangeLocation, long rangeLength);
147     [RaisesException] unsigned long locationFromRange(Element scope, Range range);
148     [RaisesException] unsigned long lengthFromRange(Element scope, Range range);
149     [RaisesException] DOMString rangeAsText(Range range);
150     [RaisesException] Range subrange(Range range, long rangeLocation, long rangeLength);
151     [RaisesException] Range rangeForDictionaryLookupAtLocation(long x, long y);
152
153     [RaisesException] void setDelegatesScrolling(boolean enabled);
154
155     [RaisesException] long lastSpellCheckRequestSequence();
156     [RaisesException] long lastSpellCheckProcessedSequence();
157
158     sequence<DOMString> userPreferredLanguages();
159     void setUserPreferredLanguages(sequence<DOMString> languages);
160
161     [RaisesException] unsigned long wheelEventHandlerCount();
162     [RaisesException] unsigned long touchEventHandlerCount();
163
164     [RaisesException] NodeList nodesFromRect(Document document, long x, long y,
165         unsigned long topPadding, unsigned long rightPadding, unsigned long bottomPadding, unsigned long leftPadding,
166         boolean ignoreClipping, boolean allowShadowContent, boolean allowChildFrameContent);
167
168     // Calling parserMetaData() with no arguments gets the metadata for the script of the current scope.
169     DOMString parserMetaData(optional any func);
170
171     void updateEditorUINowIfScheduled();
172
173     [RaisesException] boolean hasSpellingMarker(long from, long length);
174     [RaisesException] boolean hasGrammarMarker(long from, long length);
175     [RaisesException] boolean hasAutocorrectedMarker(long from, long length);
176     [RaisesException] void setContinuousSpellCheckingEnabled(boolean enabled);
177     [RaisesException] void setAutomaticQuoteSubstitutionEnabled(boolean enabled);
178     [RaisesException] void setAutomaticLinkDetectionEnabled(boolean enabled);
179     [RaisesException] void setAutomaticDashSubstitutionEnabled(boolean enabled);
180     [RaisesException] void setAutomaticTextReplacementEnabled(boolean enabled);
181     [RaisesException] void setAutomaticSpellingCorrectionEnabled(boolean enabled);
182
183     [RaisesException] boolean isOverwriteModeEnabled();
184     [RaisesException] void toggleOverwriteModeEnabled();
185
186     [RaisesException] unsigned long numberOfScrollableAreas();
187
188     [RaisesException] boolean isPageBoxVisible(long pageNumber);
189
190     readonly attribute InternalSettings settings;
191     readonly attribute unsigned long workerThreadCount;
192
193     // Flags for layerTreeAsText.
194     const unsigned short LAYER_TREE_INCLUDES_VISIBLE_RECTS = 1;
195     const unsigned short LAYER_TREE_INCLUDES_TILE_CACHES = 2;
196     const unsigned short LAYER_TREE_INCLUDES_REPAINT_RECTS = 4;
197     const unsigned short LAYER_TREE_INCLUDES_PAINTING_PHASES = 8;
198     const unsigned short LAYER_TREE_INCLUDES_CONTENT_LAYERS = 16;
199     [RaisesException] DOMString layerTreeAsText(Document document, optional unsigned short flags);
200
201     [RaisesException] DOMString scrollingStateTreeAsText();
202     [RaisesException] DOMString mainThreadScrollingReasons(); // FIXME: rename to synchronousScrollingReasons().
203     [RaisesException] ClientRectList nonFastScrollableRects();
204
205     [RaisesException] DOMString repaintRectsAsText();
206
207     [RaisesException] void garbageCollectDocumentResources();
208
209     void allowRoundingHacks();
210
211     [RaisesException] void insertAuthorCSS(DOMString css);
212     [RaisesException] void insertUserCSS(DOMString css);
213
214 #if defined(ENABLE_BATTERY_STATUS) && ENABLE_BATTERY_STATUS
215     [RaisesException] void setBatteryStatus(DOMString eventType, boolean charging, unrestricted double chargingTime, unrestricted double dischargingTime, unrestricted double level);
216 #endif
217
218 #if defined(ENABLE_PROXIMITY_EVENTS) && ENABLE_PROXIMITY_EVENTS
219     [RaisesException] void setDeviceProximity(DOMString eventType, unrestricted double value, unrestricted double min, unrestricted double max);
220 #endif
221
222     // As per spec: http://www.w3.org/TR/WebIDL/#idl-sequence
223     // "Sequences must not be used as the type of an attribute, constant or exception field."
224     // FIXME: this will lead to BUG internals.consoleProfiles !== internals.consoleProfiles as profile will always returns new array.
225     readonly attribute ScriptProfile[] consoleProfiles;
226
227     unsigned long numberOfLiveNodes();
228     unsigned long numberOfLiveDocuments();
229     sequence<DOMString> consoleMessageArgumentCounts();
230     DOMWindow openDummyInspectorFrontend(DOMString url);
231     void closeDummyInspectorFrontend();
232     [RaisesException] void setJavaScriptProfilingEnabled(boolean creates);
233     [RaisesException] void setInspectorIsUnderTest(boolean isUnderTest);
234
235     DOMString counterValue(Element element);
236     long pageNumber(Element element, optional unrestricted float pageWidth, optional unrestricted float pageHeight);
237     DOMString[] shortcutIconURLs();
238     long numberOfPages(optional unrestricted double pageWidthInPixels, optional unrestricted double pageHeightInPixels);
239     [RaisesException] DOMString pageProperty(DOMString propertyName, long pageNumber);
240     [RaisesException] DOMString pageSizeAndMarginsInPixels(long pageIndex, long width, long height, long marginTop, long marginRight, long marginBottom, long marginLeft);
241
242     [RaisesException] void setPageScaleFactor(unrestricted float scaleFactor, long x, long y);
243     [RaisesException] void setPageZoomFactor(unrestricted float zoomFactor);
244
245     [RaisesException] void setUseFixedLayout(boolean useFixedLayout);
246     [RaisesException] void setFixedLayoutSize(long width, long height);
247
248     void setHeaderHeight(unrestricted float height);
249     void setFooterHeight(unrestricted float height);
250
251     void setTopContentInset(unrestricted float contentInset);
252
253 #if defined(ENABLE_FULLSCREEN_API) && ENABLE_FULLSCREEN_API
254     void webkitWillEnterFullScreenForElement(Element element);
255     void webkitDidEnterFullScreenForElement(Element element);
256     void webkitWillExitFullScreenForElement(Element element);
257     void webkitDidExitFullScreenForElement(Element element);
258 #endif
259
260     void setApplicationCacheOriginQuota(unsigned long long quota);
261
262     void registerURLSchemeAsBypassingContentSecurityPolicy(DOMString scheme);
263     void removeURLSchemeRegisteredAsBypassingContentSecurityPolicy(DOMString scheme);
264
265     MallocStatistics mallocStatistics();
266     TypeConversions typeConversions();
267     MemoryInfo memoryInfo();
268
269     DOMString[] getReferencedFilePaths();
270
271     // These functions both reset the tracked repaint rects. They are intended to be used in the following order:
272     //  startTrackingRepaints, repaintRectsAsText, stopTrackingRepaints.
273     [RaisesException] void startTrackingRepaints();
274     [RaisesException] void stopTrackingRepaints();
275
276     [RaisesException] void startTrackingLayerFlushes();
277     [RaisesException] unsigned long layerFlushCount();
278
279     // Query if a timer is currently throttled, to debug timer throttling.
280     [RaisesException] boolean isTimerThrottled(long timerHandle);
281
282     boolean isRequestAnimationFrameThrottled();
283
284     [RaisesException] void startTrackingStyleRecalcs();
285     [RaisesException] unsigned long styleRecalcCount();
286
287     [RaisesException] void startTrackingCompositingUpdates();
288     [RaisesException] unsigned long compositingUpdateCount();
289
290     // |node| should be Document, HTMLIFrameElement, or unspecified.
291     // If |node| is an HTMLIFrameElement, it assumes node.contentDocument is
292     // specified without security checks. Unspecified means this document.
293     [RaisesException] void updateLayoutIgnorePendingStylesheetsAndRunPostLayoutTasks(optional Node node);
294
295     // Returns a string with information about the mouse cursor used at the specified client location.
296     [RaisesException] DOMString getCurrentCursorInfo();
297
298     [RaisesException] DOMString markerTextForListItem(Element element);
299
300     [RaisesException] DOMString toolTipFromElement(Element element);
301
302     SerializedScriptValue deserializeBuffer(ArrayBuffer buffer);
303     ArrayBuffer serializeObject(SerializedScriptValue obj);
304
305     void setUsesOverlayScrollbars(boolean enabled);
306
307     void forceReload(boolean endToEnd);
308
309     [Conditional=VIDEO] void simulateAudioInterruption(Node node);
310     [Conditional=VIDEO, RaisesException] boolean mediaElementHasCharacteristic(Node node, DOMString characteristic);
311
312     [Conditional=ENCRYPTED_MEDIA_V2] void initializeMockCDM();
313
314     [Conditional=SPEECH_SYNTHESIS] void enableMockSpeechSynthesizer();
315
316     [RaisesException] DOMString getImageSourceURL(Element element);
317
318     [Conditional=VIDEO_TRACK, RaisesException] DOMString captionsStyleSheetOverride();
319     [Conditional=VIDEO_TRACK, RaisesException] void setCaptionsStyleSheetOverride(DOMString override);
320     [Conditional=VIDEO_TRACK, RaisesException] void setPrimaryAudioTrackLanguageOverride(DOMString language);
321     [Conditional=VIDEO_TRACK, RaisesException] void setCaptionDisplayMode(DOMString mode);
322
323     [Conditional=VIDEO] TimeRanges createTimeRanges(Float32Array startTimes, Float32Array
324      endTimes);
325     [Conditional=VIDEO] unrestricted double closestTimeToTimeRanges(unrestricted double time, TimeRanges ranges);
326
327     boolean isSelectPopupVisible(Node node);
328
329 #if defined(ENABLE_VIBRATION) && ENABLE_VIBRATION
330     boolean isVibrating();
331 #endif
332
333     [RaisesException] boolean isPluginUnavailabilityIndicatorObscured(Element element);
334     [RaisesException] boolean isPluginSnapshotted(Element element);
335
336     [RaisesException] ClientRect selectionBounds();
337
338     [Conditional=MEDIA_SOURCE] void initializeMockMediaSource();
339     [Conditional=MEDIA_SOURCE] DOMString[] bufferedSamplesForTrackID(SourceBuffer buffer, DOMString trackID);
340
341     [Conditional=VIDEO] void beginMediaSessionInterruption();
342     [Conditional=VIDEO] void endMediaSessionInterruption(DOMString flags);
343     [Conditional=VIDEO] void applicationWillEnterForeground();
344     [Conditional=VIDEO] void applicationWillEnterBackground();
345     [Conditional=VIDEO, RaisesException] void setMediaSessionRestrictions(DOMString mediaType, DOMString restrictions);
346     [Conditional=VIDEO, RaisesException] void setMediaElementRestrictions(HTMLMediaElement element, DOMString restrictions);
347     [Conditional=WEB_AUDIO, RaisesException] void setAudioContextRestrictions(AudioContext context, DOMString restrictions);
348     [Conditional=VIDEO, RaisesException] void postRemoteControlCommand(DOMString command);
349     
350     [Conditional=VIDEO] void simulateSystemSleep();
351     [Conditional=VIDEO] void simulateSystemWake();
352     [Conditional=VIDEO] boolean elementIsBlockingDisplaySleep(Element element);
353
354     [RaisesException] void installMockPageOverlay(PageOverlayType type);
355     [RaisesException] DOMString pageOverlayLayerTreeAsText();
356
357     void setPageMuted(boolean muted);
358     boolean isPagePlayingAudio();
359     
360     File createFile(DOMString url);
361     void queueMicroTask(long testNumber);
362     boolean testPreloaderSettingViewport();
363
364     [Conditional=CONTENT_FILTERING] readonly attribute MockContentFilterSettings mockContentFilterSettings;
365
366 #if defined(ENABLE_CSS_SCROLL_SNAP) && ENABLE_CSS_SCROLL_SNAP
367     [RaisesException] DOMString scrollSnapOffsets(Element element);
368 #endif
369 };