ea9609603f90c18ea8145e5a125bf31ec15793a6
[WebKit-https.git] / Source / WebCore / testing / Internals.idl
1 /*
2  * Copyright (C) 2012 Google Inc. All rights reserved.
3  * Copyright (C) 2013 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 [
28     NoInterfaceObject,
29 ] interface Internals {
30     DOMString address(Node node);
31     DOMString description(any value);
32
33     [RaisesException] DOMString elementRenderTreeAsText(Element element);
34     boolean isPreloaded(DOMString url);
35     boolean isLoadingFromMemoryCache(DOMString url);
36
37     [RaisesException] CSSStyleDeclaration computedStyleIncludingVisitedInfo(Node node);
38
39     [RaisesException] Node ensureShadowRoot(Element host);
40     [RaisesException] Node createShadowRoot(Element host);
41     [RaisesException] Node shadowRoot(Element host);
42
43     [RaisesException] DOMString shadowRootType(Node root);
44     [RaisesException] Element includerFor(Node node);
45     [RaisesException] DOMString shadowPseudoId(Element element);
46     [RaisesException] void setShadowPseudoId(Element element, DOMString id);
47     [RaisesException] Node treeScopeRootNode(Node node);
48     [RaisesException] Node parentTreeScope(Node node);
49
50     // Spatial Navigation testing
51     [RaisesException] unsigned long lastSpatialNavigationCandidateCount();
52
53     // CSS Animation testing.
54     unsigned long numberOfActiveAnimations();
55     [RaisesException] void suspendAnimations();
56     [RaisesException] void resumeAnimations();
57     [RaisesException] boolean animationsAreSuspended();
58     [RaisesException] boolean pauseAnimationAtTimeOnElement(DOMString animationName, unrestricted double pauseTime, Element element);
59     [RaisesException] boolean pauseAnimationAtTimeOnPseudoElement(DOMString animationName, unrestricted double pauseTime, Element element, DOMString pseudoId);
60
61     // CSS Transition testing.
62     [RaisesException] boolean pauseTransitionAtTimeOnElement(DOMString propertyName, unrestricted double pauseTime, Element element);
63     [RaisesException] boolean pauseTransitionAtTimeOnPseudoElement(DOMString property, unrestricted double pauseTime, Element element, DOMString pseudoId);
64
65     [RaisesException] boolean attached(Node node);
66
67     DOMString visiblePlaceholder(Element element);
68 #if defined(ENABLE_INPUT_TYPE_COLOR) && ENABLE_INPUT_TYPE_COLOR
69     void selectColorInColorChooser(Element element, DOMString colorValue);
70 #endif
71     [RaisesException] DOMString[] formControlStateOfPreviousHistoryItem();
72     [RaisesException] void setFormControlStateOfPreviousHistoryItem(sequence<DOMString> values);
73
74     [RaisesException] ClientRect absoluteCaretBounds();
75
76     [RaisesException] ClientRect boundingBox(Element element);
77
78     [RaisesException] ClientRectList inspectorHighlightRects();
79     [RaisesException] DOMString inspectorHighlightObject();
80
81     [RaisesException] unsigned long markerCountForNode(Node node, DOMString markerType);
82     [RaisesException] Range markerRangeForNode(Node node, DOMString markerType, unsigned long index);
83     [RaisesException] DOMString markerDescriptionForNode(Node node, DOMString markerType, unsigned long index);
84     void addTextMatchMarker(Range range, boolean isActive);
85     [RaisesException] void setMarkedTextMatchesAreHighlighted(boolean flag);
86
87     void invalidateFontCache();
88
89     [RaisesException] void setScrollViewPosition(long x, long y);
90
91     [RaisesException] void setPagination(DOMString mode, long gap, optional long pageLength);
92
93     [RaisesException] DOMString configurationForViewport(unrestricted float devicePixelRatio,
94                                        long deviceWidth,
95                                        long deviceHeight,
96                                        long availableWidth,
97                                        long availableHeight);
98
99     [RaisesException] boolean wasLastChangeUserEdit(Element textField);
100     [RaisesException] boolean elementShouldAutoComplete(Element inputElement);
101     [RaisesException] DOMString suggestedValue(Element inputElement);
102     [RaisesException] void setSuggestedValue(Element inputElement, DOMString value);
103     [RaisesException] void setEditingValue(Element inputElement, DOMString value);
104     [RaisesException] void setAutofilled(Element inputElement, boolean enabled);
105     [RaisesException] unsigned long countMatchesForText(DOMString text, unsigned long findOptions, DOMString markMatches);
106
107     [RaisesException] void paintControlTints();
108
109     [RaisesException] void scrollElementToRect(Element element, long x, long y, long w, long h);
110
111     [RaisesException] Range rangeFromLocationAndLength(Element scope, long rangeLocation, long rangeLength);
112     [RaisesException] unsigned long locationFromRange(Element scope, Range range);
113     [RaisesException] unsigned long lengthFromRange(Element scope, Range range);
114     [RaisesException] DOMString rangeAsText(Range range);
115
116     [RaisesException] void setDelegatesScrolling(boolean enabled);
117
118     [RaisesException] long lastSpellCheckRequestSequence();
119     [RaisesException] long lastSpellCheckProcessedSequence();
120
121     sequence<DOMString> userPreferredLanguages();
122     void setUserPreferredLanguages(sequence<DOMString> languages);
123
124     [RaisesException] unsigned long wheelEventHandlerCount();
125     [RaisesException] unsigned long touchEventHandlerCount();
126
127     [RaisesException] NodeList nodesFromRect(Document document, long x, long y,
128         unsigned long topPadding, unsigned long rightPadding, unsigned long bottomPadding, unsigned long leftPadding,
129         boolean ignoreClipping, boolean allowShadowContent, boolean allowChildFrameContent);
130
131     // Calling parserMetaData() with no arguments gets the metadata for the script of the current scope.
132     DOMString parserMetaData(optional any func);
133
134     void updateEditorUINowIfScheduled();
135
136     Node findEditingDeleteButton();
137
138     [RaisesException] boolean hasSpellingMarker(long from, long length);
139     [RaisesException] boolean hasGrammarMarker(long from, long length);
140     [RaisesException] boolean hasAutocorrectedMarker(long from, long length);
141     [RaisesException] void setContinuousSpellCheckingEnabled(boolean enabled);
142     [RaisesException] void setAutomaticQuoteSubstitutionEnabled(boolean enabled);
143     [RaisesException] void setAutomaticLinkDetectionEnabled(boolean enabled);
144     [RaisesException] void setAutomaticDashSubstitutionEnabled(boolean enabled);
145     [RaisesException] void setAutomaticTextReplacementEnabled(boolean enabled);
146     [RaisesException] void setAutomaticSpellingCorrectionEnabled(boolean enabled);
147
148     [RaisesException] boolean isOverwriteModeEnabled();
149     [RaisesException] void toggleOverwriteModeEnabled();
150
151     [RaisesException] unsigned long numberOfScrollableAreas();
152
153     [RaisesException] boolean isPageBoxVisible(long pageNumber);
154
155     readonly attribute InternalSettings settings;
156     readonly attribute unsigned long workerThreadCount;
157
158     // Flags for layerTreeAsText.
159     const unsigned short LAYER_TREE_INCLUDES_VISIBLE_RECTS = 1;
160     const unsigned short LAYER_TREE_INCLUDES_TILE_CACHES = 2;
161     const unsigned short LAYER_TREE_INCLUDES_REPAINT_RECTS = 4;
162     const unsigned short LAYER_TREE_INCLUDES_PAINTING_PHASES = 8;
163     const unsigned short LAYER_TREE_INCLUDES_CONTENT_LAYERS = 16;
164     [RaisesException] DOMString layerTreeAsText(Document document, optional unsigned short flags);
165
166     [RaisesException] DOMString scrollingStateTreeAsText();
167     [RaisesException] DOMString mainThreadScrollingReasons(); // FIXME: rename to synchronousScrollingReasons().
168     [RaisesException] ClientRectList nonFastScrollableRects();
169
170     [RaisesException] DOMString repaintRectsAsText();
171
172     [RaisesException] void garbageCollectDocumentResources();
173
174     void allowRoundingHacks();
175
176     [RaisesException] void insertAuthorCSS(DOMString css);
177     [RaisesException] void insertUserCSS(DOMString css);
178
179 #if defined(ENABLE_BATTERY_STATUS) && ENABLE_BATTERY_STATUS
180     [RaisesException] void setBatteryStatus(DOMString eventType, boolean charging, unrestricted double chargingTime, unrestricted double dischargingTime, unrestricted double level);
181 #endif
182
183 #if defined(ENABLE_PROXIMITY_EVENTS) && ENABLE_PROXIMITY_EVENTS
184     [RaisesException] void setDeviceProximity(DOMString eventType, unrestricted double value, unrestricted double min, unrestricted double max);
185 #endif
186
187     // As per spec: http://www.w3.org/TR/WebIDL/#idl-sequence
188     // "Sequences must not be used as the type of an attribute, constant or exception field."
189     // FIXME: this will lead to BUG interals.consoleProfiles !== interals.consoleProfiles as profile will always returns new array.
190     readonly attribute ScriptProfile[] consoleProfiles;
191
192     unsigned long numberOfLiveNodes();
193     unsigned long numberOfLiveDocuments();
194     [Conditional=INSPECTOR] sequence<DOMString> consoleMessageArgumentCounts();
195     [Conditional=INSPECTOR] DOMWindow openDummyInspectorFrontend(DOMString url);
196     [Conditional=INSPECTOR] void closeDummyInspectorFrontend();
197     [Conditional=INSPECTOR, RaisesException] void setJavaScriptProfilingEnabled(boolean creates);
198     [Conditional=INSPECTOR, RaisesException] void setInspectorIsUnderTest(boolean isUnderTest);
199
200     DOMString counterValue(Element element);
201     long pageNumber(Element element, optional unrestricted float pageWidth, optional unrestricted float pageHeight);
202     DOMString[] shortcutIconURLs();
203     DOMString[] allIconURLs();
204     long numberOfPages(optional unrestricted double pageWidthInPixels, optional unrestricted double pageHeightInPixels);
205     [RaisesException] DOMString pageProperty(DOMString propertyName, long pageNumber);
206     [RaisesException] DOMString pageSizeAndMarginsInPixels(long pageIndex, long width, long height, long marginTop, long marginRight, long marginBottom, long marginLeft);
207
208     [RaisesException] void setPageScaleFactor(unrestricted float scaleFactor, long x, long y);
209     [RaisesException] void setPageZoomFactor(unrestricted float zoomFactor);
210
211     void setHeaderHeight(unrestricted float height);
212     void setFooterHeight(unrestricted float height);
213
214     void setTopContentInset(unrestricted float contentInset);
215
216 #if defined(ENABLE_FULLSCREEN_API) && ENABLE_FULLSCREEN_API
217     void webkitWillEnterFullScreenForElement(Element element);
218     void webkitDidEnterFullScreenForElement(Element element);
219     void webkitWillExitFullScreenForElement(Element element);
220     void webkitDidExitFullScreenForElement(Element element);
221 #endif
222
223     void setApplicationCacheOriginQuota(unsigned long long quota);
224
225     void registerURLSchemeAsBypassingContentSecurityPolicy(DOMString scheme);
226     void removeURLSchemeRegisteredAsBypassingContentSecurityPolicy(DOMString scheme);
227
228     MallocStatistics mallocStatistics();
229     TypeConversions typeConversions();
230     MemoryInfo memoryInfo();
231
232     DOMString[] getReferencedFilePaths();
233
234     // These functions both reset the tracked repaint rects. They are inteded to be used in the following order:
235     //  startTrackingRepaints, repaintRectsAsText, stopTrackingRepaints.
236     [RaisesException] void startTrackingRepaints();
237     [RaisesException] void stopTrackingRepaints();
238
239     // |node| should be Document, HTMLIFrameElement, or unspecified.
240     // If |node| is an HTMLIFrameElement, it assumes node.contentDocument is
241     // specified without security checks. Unspecified means this document.
242     [RaisesException] void updateLayoutIgnorePendingStylesheetsAndRunPostLayoutTasks(optional Node node);
243
244     // Returns a string with information about the mouse cursor used at the specified client location.
245     [RaisesException] DOMString getCurrentCursorInfo();
246
247     [RaisesException] DOMString markerTextForListItem(Element element);
248
249     SerializedScriptValue deserializeBuffer(ArrayBuffer buffer);
250     ArrayBuffer serializeObject(SerializedScriptValue obj);
251
252     void setUsesOverlayScrollbars(boolean enabled);
253
254     void forceReload(boolean endToEnd);
255
256     [Conditional=VIDEO] void simulateAudioInterruption(Node node);
257
258     [Conditional=ENCRYPTED_MEDIA_V2] void initializeMockCDM();
259
260     [Conditional=SPEECH_SYNTHESIS] void enableMockSpeechSynthesizer();
261
262     [RaisesException] DOMString getImageSourceURL(Element element);
263
264     [Conditional=VIDEO_TRACK, RaisesException] DOMString captionsStyleSheetOverride();
265     [Conditional=VIDEO_TRACK, RaisesException] void setCaptionsStyleSheetOverride(DOMString override);
266     [Conditional=VIDEO_TRACK, RaisesException] void setPrimaryAudioTrackLanguageOverride(DOMString language);
267     [Conditional=VIDEO_TRACK, RaisesException] void setCaptionDisplayMode(DOMString mode);
268
269     [Conditional=VIDEO] TimeRanges createTimeRanges(Float32Array startTimes, Float32Array
270      endTimes);
271     [Conditional=VIDEO] unrestricted double closestTimeToTimeRanges(unrestricted double time, TimeRanges ranges);
272
273     boolean isSelectPopupVisible(Node node);
274
275 #if defined(ENABLE_VIBRATION) && ENABLE_VIBRATION
276     boolean isVibrating();
277 #endif
278
279     [RaisesException] boolean isPluginUnavailabilityIndicatorObscured(Element element);
280     [RaisesException] boolean isPluginSnapshotted(Element element);
281
282     [RaisesException] ClientRect selectionBounds();
283
284     [Conditional=MEDIA_SOURCE] void initializeMockMediaSource();
285     [Conditional=MEDIA_SOURCE] DOMString[] bufferedSamplesForTrackID(SourceBuffer buffer, DOMString trackID);
286
287     [Conditional=VIDEO] void beginMediaSessionInterruption();
288     [Conditional=VIDEO] void endMediaSessionInterruption(DOMString flags);
289     [Conditional=VIDEO] void applicationWillEnterForeground();
290     [Conditional=VIDEO] void applicationWillEnterBackground();
291     [Conditional=VIDEO, RaisesException] void setMediaSessionRestrictions(DOMString mediaType, DOMString restrictions);
292     [Conditional=VIDEO, RaisesException] void postRemoteControlCommand(DOMString command);
293     
294     [Conditional=VIDEO] void simulateSystemSleep();
295     [Conditional=VIDEO] void simulateSystemWake();
296 };