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