Make a way to test display-list drawing
[WebKit-https.git] / Source / WebCore / testing / Internals.idl
1 /*
2  * Copyright (C) 2012 Google Inc. All rights reserved.
3  * Copyright (C) 2013-2015 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 enum MediaSessionInterruptingCategory {
49     "content",
50     "transient",
51     "transient-solo"
52 };
53
54 enum MediaControlEvent {
55     "play-pause",
56     "next-track",
57     "previous-track"
58 };
59
60 [
61     NoInterfaceObject,
62 ] interface Internals {
63     DOMString address(Node node);
64     [RaisesException] boolean nodeNeedsStyleRecalc(Node node);
65     DOMString description(any value);
66
67     // Animated image pausing testing.
68     [RaisesException] boolean hasPausedImageAnimations(Element element);
69
70     [RaisesException] DOMString elementRenderTreeAsText(Element element);
71     boolean isPreloaded(DOMString url);
72     boolean isLoadingFromMemoryCache(DOMString url);
73     DOMString xhrResponseSource(XMLHttpRequest xhr);
74     boolean isSharingStyleSheetContents(Element linkA, Element linkB);
75     boolean isStyleSheetLoadingSubresources(Element link);
76     void clearMemoryCache();
77     void pruneMemoryCacheToSize(long size);
78     long memoryCacheSize();
79     void setOverrideCachePolicy(CachePolicy policy);
80     void setOverrideResourceLoadPriority(ResourceLoadPriority priority);
81     void setStrictRawResourceValidationPolicyDisabled(boolean disabled);
82
83     void clearPageCache();
84     unsigned int pageCacheSize();
85
86     [RaisesException] CSSStyleDeclaration computedStyleIncludingVisitedInfo(Node node);
87
88     [RaisesException] Node ensureShadowRoot(Element host);
89     [RaisesException] Node ensureUserAgentShadowRoot(Element host);
90     [RaisesException] Node createShadowRoot(Element host);
91     [RaisesException] Node shadowRoot(Element host);
92
93     [RaisesException] DOMString shadowRootType(Node root);
94     [RaisesException] Element includerFor(Node node);
95     [RaisesException] DOMString shadowPseudoId(Element element);
96     [RaisesException] void setShadowPseudoId(Element element, DOMString id);
97     [RaisesException] Node treeScopeRootNode(Node node);
98     [RaisesException] Node parentTreeScope(Node node);
99
100     // Spatial Navigation testing
101     [RaisesException] unsigned long lastSpatialNavigationCandidateCount();
102
103     // CSS Animation testing.
104     unsigned long numberOfActiveAnimations();
105     [RaisesException] void suspendAnimations();
106     [RaisesException] void resumeAnimations();
107     [RaisesException] boolean animationsAreSuspended();
108     [RaisesException] boolean pauseAnimationAtTimeOnElement(DOMString animationName, unrestricted double pauseTime, Element element);
109     [RaisesException] boolean pauseAnimationAtTimeOnPseudoElement(DOMString animationName, unrestricted double pauseTime, Element element, DOMString pseudoId);
110
111     // CSS Transition testing.
112     [RaisesException] boolean pauseTransitionAtTimeOnElement(DOMString propertyName, unrestricted double pauseTime, Element element);
113     [RaisesException] boolean pauseTransitionAtTimeOnPseudoElement(DOMString property, unrestricted double pauseTime, Element element, DOMString pseudoId);
114
115     [RaisesException] boolean attached(Node node);
116
117     DOMString visiblePlaceholder(Element element);
118     void selectColorInColorChooser(Element element, DOMString colorValue);
119     [RaisesException] DOMString[] formControlStateOfPreviousHistoryItem();
120     [RaisesException] void setFormControlStateOfPreviousHistoryItem(sequence<DOMString> values);
121
122     [RaisesException] ClientRect absoluteCaretBounds();
123
124     [RaisesException] ClientRect boundingBox(Element element);
125
126     [RaisesException] ClientRectList inspectorHighlightRects();
127     [RaisesException] DOMString inspectorHighlightObject();
128
129     [RaisesException] unsigned long markerCountForNode(Node node, DOMString markerType);
130     [RaisesException] Range markerRangeForNode(Node node, DOMString markerType, unsigned long index);
131     [RaisesException] DOMString markerDescriptionForNode(Node node, DOMString markerType, unsigned long index);
132     [RaisesException] DOMString dumpMarkerRects(DOMString markerType);
133     void addTextMatchMarker(Range range, boolean isActive);
134     [RaisesException] void setMarkedTextMatchesAreHighlighted(boolean flag);
135
136     void invalidateFontCache();
137
138     [RaisesException] void setScrollViewPosition(long x, long y);
139
140     [RaisesException] void setViewBaseBackgroundColor(DOMString colorValue);
141
142     [RaisesException] void setPagination(DOMString mode, long gap, optional long pageLength);
143
144     [RaisesException] DOMString configurationForViewport(unrestricted float devicePixelRatio,
145                                        long deviceWidth,
146                                        long deviceHeight,
147                                        long availableWidth,
148                                        long availableHeight);
149
150     [RaisesException] boolean wasLastChangeUserEdit(Element textField);
151     [RaisesException] boolean elementShouldAutoComplete(Element inputElement);
152     [RaisesException] void setEditingValue(Element inputElement, DOMString value);
153     [RaisesException] void setAutofilled(Element inputElement, boolean enabled);
154     [RaisesException] void setShowAutoFillButton(Element inputElement, boolean enabled);
155     [RaisesException] unsigned long countMatchesForText(DOMString text, unsigned long findOptions, DOMString markMatches);
156
157     [RaisesException] void paintControlTints();
158
159     [RaisesException] void scrollElementToRect(Element element, long x, long y, long w, long h);
160
161     [RaisesException] Range rangeFromLocationAndLength(Element scope, long rangeLocation, long rangeLength);
162     [RaisesException] unsigned long locationFromRange(Element scope, Range range);
163     [RaisesException] unsigned long lengthFromRange(Element scope, Range range);
164     [RaisesException] DOMString rangeAsText(Range range);
165     [RaisesException] Range subrange(Range range, long rangeLocation, long rangeLength);
166     [RaisesException] Range rangeForDictionaryLookupAtLocation(long x, long y);
167
168     [RaisesException] void setDelegatesScrolling(boolean enabled);
169
170     [RaisesException] long lastSpellCheckRequestSequence();
171     [RaisesException] long lastSpellCheckProcessedSequence();
172
173     sequence<DOMString> userPreferredLanguages();
174     void setUserPreferredLanguages(sequence<DOMString> languages);
175
176     sequence<DOMString> userPreferredAudioCharacteristics();
177     void setUserPreferredAudioCharacteristic(DOMString characteristic);
178
179     [RaisesException] unsigned long wheelEventHandlerCount();
180     [RaisesException] unsigned long touchEventHandlerCount();
181
182     [RaisesException] NodeList nodesFromRect(Document document, long x, long y,
183         unsigned long topPadding, unsigned long rightPadding, unsigned long bottomPadding, unsigned long leftPadding,
184         boolean ignoreClipping, boolean allowShadowContent, boolean allowChildFrameContent);
185
186     // Calling parserMetaData() with no arguments gets the metadata for the script of the current scope.
187     DOMString parserMetaData(optional any func);
188
189     void updateEditorUINowIfScheduled();
190
191     [RaisesException] boolean hasSpellingMarker(long from, long length);
192     [RaisesException] boolean hasGrammarMarker(long from, long length);
193     [RaisesException] boolean hasAutocorrectedMarker(long from, long length);
194     [RaisesException] void setContinuousSpellCheckingEnabled(boolean enabled);
195     [RaisesException] void setAutomaticQuoteSubstitutionEnabled(boolean enabled);
196     [RaisesException] void setAutomaticLinkDetectionEnabled(boolean enabled);
197     [RaisesException] void setAutomaticDashSubstitutionEnabled(boolean enabled);
198     [RaisesException] void setAutomaticTextReplacementEnabled(boolean enabled);
199     [RaisesException] void setAutomaticSpellingCorrectionEnabled(boolean enabled);
200
201     [RaisesException] boolean isOverwriteModeEnabled();
202     [RaisesException] void toggleOverwriteModeEnabled();
203
204     [RaisesException] unsigned long numberOfScrollableAreas();
205
206     [RaisesException] boolean isPageBoxVisible(long pageNumber);
207
208     [RaisesException] unsigned long imageFrameIndex(Element element);
209
210     readonly attribute InternalSettings settings;
211     readonly attribute unsigned long workerThreadCount;
212
213     // Flags for layerTreeAsText.
214     const unsigned short LAYER_TREE_INCLUDES_VISIBLE_RECTS = 1;
215     const unsigned short LAYER_TREE_INCLUDES_TILE_CACHES = 2;
216     const unsigned short LAYER_TREE_INCLUDES_REPAINT_RECTS = 4;
217     const unsigned short LAYER_TREE_INCLUDES_PAINTING_PHASES = 8;
218     const unsigned short LAYER_TREE_INCLUDES_CONTENT_LAYERS = 16;
219     [RaisesException] DOMString layerTreeAsText(Document document, optional unsigned short flags);
220
221     [RaisesException] DOMString scrollingStateTreeAsText();
222     [RaisesException] DOMString mainThreadScrollingReasons(); // FIXME: rename to synchronousScrollingReasons().
223     [RaisesException] ClientRectList nonFastScrollableRects();
224
225     [RaisesException] DOMString repaintRectsAsText();
226
227     // These throw if the element does not have a compositing layer.
228     [RaisesException] void setElementUsesDisplayListDrawing(Element element, boolean usesDisplayListDrawing);
229
230     // Flags for displayListForElement.
231     const unsigned short DISPLAY_LIST_INCLUDES_PLATFORM_OPERATIONS = 1;
232     [RaisesException] DOMString displayListForElement(Element element, optional unsigned short flags);
233
234     [RaisesException] void garbageCollectDocumentResources();
235
236     void allowRoundingHacks();
237
238     [RaisesException] void insertAuthorCSS(DOMString css);
239     [RaisesException] void insertUserCSS(DOMString css);
240
241 #if defined(ENABLE_BATTERY_STATUS) && ENABLE_BATTERY_STATUS
242     [RaisesException] void setBatteryStatus(DOMString eventType, boolean charging, unrestricted double chargingTime, unrestricted double dischargingTime, unrestricted double level);
243 #endif
244
245 #if defined(ENABLE_PROXIMITY_EVENTS) && ENABLE_PROXIMITY_EVENTS
246     [RaisesException] void setDeviceProximity(DOMString eventType, unrestricted double value, unrestricted double min, unrestricted double max);
247 #endif
248
249     // As per spec: http://www.w3.org/TR/WebIDL/#idl-sequence
250     // "Sequences must not be used as the type of an attribute, constant or exception field."
251     // FIXME: this will lead to BUG internals.consoleProfiles !== internals.consoleProfiles as profile will always returns new array.
252     readonly attribute ScriptProfile[] consoleProfiles;
253
254     unsigned long numberOfLiveNodes();
255     unsigned long numberOfLiveDocuments();
256     DOMWindow openDummyInspectorFrontend(DOMString url);
257     void closeDummyInspectorFrontend();
258     [RaisesException] void setJavaScriptProfilingEnabled(boolean creates);
259     [RaisesException] void setInspectorIsUnderTest(boolean isUnderTest);
260
261     DOMString counterValue(Element element);
262     long pageNumber(Element element, optional unrestricted float pageWidth, optional unrestricted float pageHeight);
263     DOMString[] shortcutIconURLs();
264     long numberOfPages(optional unrestricted double pageWidthInPixels, optional unrestricted double pageHeightInPixels);
265     [RaisesException] DOMString pageProperty(DOMString propertyName, long pageNumber);
266     [RaisesException] DOMString pageSizeAndMarginsInPixels(long pageIndex, long width, long height, long marginTop, long marginRight, long marginBottom, long marginLeft);
267
268     [RaisesException] void setPageScaleFactor(unrestricted float scaleFactor, long x, long y);
269     [RaisesException] void setPageZoomFactor(unrestricted float zoomFactor);
270     [RaisesException] void setTextZoomFactor(unrestricted float zoomFactor);
271
272     [RaisesException] void setUseFixedLayout(boolean useFixedLayout);
273     [RaisesException] void setFixedLayoutSize(long width, long height);
274
275     void setHeaderHeight(unrestricted float height);
276     void setFooterHeight(unrestricted float height);
277
278     void setTopContentInset(unrestricted float contentInset);
279
280 #if defined(ENABLE_FULLSCREEN_API) && ENABLE_FULLSCREEN_API
281     void webkitWillEnterFullScreenForElement(Element element);
282     void webkitDidEnterFullScreenForElement(Element element);
283     void webkitWillExitFullScreenForElement(Element element);
284     void webkitDidExitFullScreenForElement(Element element);
285 #endif
286
287     void setApplicationCacheOriginQuota(unsigned long long quota);
288
289     void registerURLSchemeAsBypassingContentSecurityPolicy(DOMString scheme);
290     void removeURLSchemeRegisteredAsBypassingContentSecurityPolicy(DOMString scheme);
291
292     MallocStatistics mallocStatistics();
293     TypeConversions typeConversions();
294     MemoryInfo memoryInfo();
295
296     DOMString[] getReferencedFilePaths();
297
298     // These functions both reset the tracked repaint rects. They are intended to be used in the following order:
299     //  startTrackingRepaints, repaintRectsAsText, stopTrackingRepaints.
300     [RaisesException] void startTrackingRepaints();
301     [RaisesException] void stopTrackingRepaints();
302
303     [RaisesException] void startTrackingLayerFlushes();
304     [RaisesException] unsigned long layerFlushCount();
305
306     // Query if a timer is currently throttled, to debug timer throttling.
307     [RaisesException] boolean isTimerThrottled(long timerHandle);
308
309     boolean isRequestAnimationFrameThrottled();
310     boolean areTimersThrottled();
311
312     [RaisesException] void startTrackingStyleRecalcs();
313     [RaisesException] unsigned long styleRecalcCount();
314
315     [RaisesException] void startTrackingCompositingUpdates();
316     [RaisesException] unsigned long compositingUpdateCount();
317
318     // |node| should be Document, HTMLIFrameElement, or unspecified.
319     // If |node| is an HTMLIFrameElement, it assumes node.contentDocument is
320     // specified without security checks. Unspecified means this document.
321     [RaisesException] void updateLayoutIgnorePendingStylesheetsAndRunPostLayoutTasks(optional Node node);
322
323     readonly attribute unsigned long layoutCount;
324
325     // Returns a string with information about the mouse cursor used at the specified client location.
326     [RaisesException] DOMString getCurrentCursorInfo();
327
328     [RaisesException] DOMString markerTextForListItem(Element element);
329
330     [RaisesException] DOMString toolTipFromElement(Element element);
331
332     SerializedScriptValue deserializeBuffer(ArrayBuffer buffer);
333     ArrayBuffer serializeObject(SerializedScriptValue obj);
334
335     boolean isFromCurrentWorld(any obj);
336
337     void setUsesOverlayScrollbars(boolean enabled);
338
339     void forceReload(boolean endToEnd);
340
341     void enableAutoSizeMode(boolean enabled, long minimumWidth, long minimumHeight, long maximumWidth, long maximumHeight);
342
343     [Conditional=VIDEO] void simulateAudioInterruption(Node node);
344     [Conditional=VIDEO, RaisesException] boolean mediaElementHasCharacteristic(Node node, DOMString characteristic);
345
346     [Conditional=ENCRYPTED_MEDIA_V2] void initializeMockCDM();
347
348     [Conditional=SPEECH_SYNTHESIS] void enableMockSpeechSynthesizer();
349
350     [RaisesException] DOMString getImageSourceURL(Element element);
351
352     [Conditional=VIDEO_TRACK, RaisesException] DOMString captionsStyleSheetOverride();
353     [Conditional=VIDEO_TRACK, RaisesException] void setCaptionsStyleSheetOverride(DOMString override);
354     [Conditional=VIDEO_TRACK, RaisesException] void setPrimaryAudioTrackLanguageOverride(DOMString language);
355     [Conditional=VIDEO_TRACK, RaisesException] void setCaptionDisplayMode(DOMString mode);
356
357     [Conditional=VIDEO] TimeRanges createTimeRanges(Float32Array startTimes, Float32Array
358      endTimes);
359     [Conditional=VIDEO] unrestricted double closestTimeToTimeRanges(unrestricted double time, TimeRanges ranges);
360
361     boolean isSelectPopupVisible(Node node);
362
363 #if defined(ENABLE_VIBRATION) && ENABLE_VIBRATION
364     boolean isVibrating();
365 #endif
366
367     [RaisesException] boolean isPluginUnavailabilityIndicatorObscured(Element element);
368     [RaisesException] boolean isPluginSnapshotted(Element element);
369
370     [RaisesException] ClientRect selectionBounds();
371
372     [Conditional=MEDIA_SOURCE] void initializeMockMediaSource();
373     [Conditional=MEDIA_SOURCE] DOMString[] bufferedSamplesForTrackID(SourceBuffer buffer, DOMString trackID);
374     [Conditional=MEDIA_SOURCE] void setShouldGenerateTimestamps(SourceBuffer buffer, boolean flag);
375
376     [Conditional=VIDEO, RaisesException] void beginMediaSessionInterruption(DOMString interruptionType);
377     [Conditional=VIDEO] void endMediaSessionInterruption(DOMString flags);
378     [Conditional=MEDIA_SESSION] void sendMediaSessionStartOfInterruptionNotification(MediaSessionInterruptingCategory category);
379     [Conditional=MEDIA_SESSION] void sendMediaSessionEndOfInterruptionNotification(MediaSessionInterruptingCategory category);
380     [Conditional=MEDIA_SESSION] DOMString mediaSessionCurrentState(MediaSession session);
381     [Conditional=MEDIA_SESSION] double mediaElementPlayerVolume(HTMLMediaElement element);
382     [Conditional=MEDIA_SESSION] void sendMediaControlEvent(MediaControlEvent event);
383     [Conditional=VIDEO] void applicationDidEnterForeground();
384     [Conditional=VIDEO] void applicationWillEnterBackground();
385     [Conditional=VIDEO, RaisesException] void setMediaSessionRestrictions(DOMString mediaType, DOMString restrictions);
386     [Conditional=VIDEO, RaisesException] void setMediaElementRestrictions(HTMLMediaElement element, DOMString restrictions);
387     [Conditional=WEB_AUDIO, RaisesException] void setAudioContextRestrictions(AudioContext context, DOMString restrictions);
388     [Conditional=VIDEO, RaisesException] void postRemoteControlCommand(DOMString command);
389     [Conditional=WIRELESS_PLAYBACK_TARGET] void setMockMediaPlaybackTargetPickerEnabled(boolean enabled);
390     [Conditional=WIRELESS_PLAYBACK_TARGET, RaisesException] void setMockMediaPlaybackTargetPickerState(DOMString deviceName, DOMString deviceState);
391     [Conditional=MEDIA_STREAM] void setMockMediaCaptureDevicesEnabled(boolean enabled);
392
393     [Conditional=VIDEO] void simulateSystemSleep();
394     [Conditional=VIDEO] void simulateSystemWake();
395     [Conditional=VIDEO] boolean elementIsBlockingDisplaySleep(Element element);
396
397     [RaisesException] MockPageOverlay installMockPageOverlay(PageOverlayType type);
398     [RaisesException] DOMString pageOverlayLayerTreeAsText();
399
400     void setPageMuted(boolean muted);
401     boolean isPagePlayingAudio();
402
403     void setPageDefersLoading(boolean defersLoading);
404
405     File createFile(DOMString url);
406     void queueMicroTask(long testNumber);
407     boolean testPreloaderSettingViewport();
408
409     [Conditional=CONTENT_FILTERING] readonly attribute MockContentFilterSettings mockContentFilterSettings;
410
411 #if defined(ENABLE_CSS_SCROLL_SNAP) && ENABLE_CSS_SCROLL_SNAP
412     [RaisesException] DOMString scrollSnapOffsets(Element element);
413 #endif
414
415     [RaisesException] DOMString pathStringWithShrinkWrappedRects(sequence<double> rectComponents, double radius);
416
417     [Conditional=VIDEO] DOMString getCurrentMediaControlsStatusForElement(HTMLMediaElement element);
418
419     DOMString userVisibleString(DOMURL url);
420
421     void setShowAllPlugins(boolean showAll);
422
423     [Conditional=STREAMS_API, CallWith=ScriptState] boolean isReadableStreamDisturbed(any stream);
424 };