d784737c68f963a2bf61471ee4dd244f7a082a34
[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     [RaisesException] void setScrollViewPosition(long x, long y);
88
89     [RaisesException] void setPagination(DOMString mode, long gap, optional long pageLength);
90
91     [RaisesException] DOMString configurationForViewport(unrestricted float devicePixelRatio,
92                                        long deviceWidth,
93                                        long deviceHeight,
94                                        long availableWidth,
95                                        long availableHeight);
96
97     [RaisesException] boolean wasLastChangeUserEdit(Element textField);
98     [RaisesException] boolean elementShouldAutoComplete(Element inputElement);
99     [RaisesException] DOMString suggestedValue(Element inputElement);
100     [RaisesException] void setSuggestedValue(Element inputElement, DOMString value);
101     [RaisesException] void setEditingValue(Element inputElement, DOMString value);
102     [RaisesException] void setAutofilled(Element inputElement, boolean enabled);
103     [RaisesException] unsigned long countMatchesForText(DOMString text, unsigned long findOptions, DOMString markMatches);
104
105     [RaisesException] void paintControlTints();
106
107     [RaisesException] void scrollElementToRect(Element element, long x, long y, long w, long h);
108
109     [RaisesException] Range rangeFromLocationAndLength(Element scope, long rangeLocation, long rangeLength);
110     [RaisesException] unsigned long locationFromRange(Element scope, Range range);
111     [RaisesException] unsigned long lengthFromRange(Element scope, Range range);
112     [RaisesException] DOMString rangeAsText(Range range);
113
114     [RaisesException] void setDelegatesScrolling(boolean enabled);
115
116     [RaisesException] long lastSpellCheckRequestSequence();
117     [RaisesException] long lastSpellCheckProcessedSequence();
118
119     sequence<DOMString> userPreferredLanguages();
120     void setUserPreferredLanguages(sequence<DOMString> languages);
121
122     [RaisesException] unsigned long wheelEventHandlerCount();
123     [RaisesException] unsigned long touchEventHandlerCount();
124
125     [RaisesException] NodeList nodesFromRect(Document document, long x, long y,
126         unsigned long topPadding, unsigned long rightPadding, unsigned long bottomPadding, unsigned long leftPadding,
127         boolean ignoreClipping, boolean allowShadowContent, boolean allowChildFrameContent);
128
129     // Calling parserMetaData() with no arguments gets the metadata for the script of the current scope.
130     DOMString parserMetaData(optional any func);
131
132     void updateEditorUINowIfScheduled();
133
134     Node findEditingDeleteButton();
135
136     [RaisesException] boolean hasSpellingMarker(long from, long length);
137     [RaisesException] boolean hasGrammarMarker(long from, long length);
138     [RaisesException] boolean hasAutocorrectedMarker(long from, long length);
139     [RaisesException] void setContinuousSpellCheckingEnabled(boolean enabled);
140     [RaisesException] void setAutomaticQuoteSubstitutionEnabled(boolean enabled);
141     [RaisesException] void setAutomaticLinkDetectionEnabled(boolean enabled);
142     [RaisesException] void setAutomaticDashSubstitutionEnabled(boolean enabled);
143     [RaisesException] void setAutomaticTextReplacementEnabled(boolean enabled);
144     [RaisesException] void setAutomaticSpellingCorrectionEnabled(boolean enabled);
145
146     [RaisesException] boolean isOverwriteModeEnabled();
147     [RaisesException] void toggleOverwriteModeEnabled();
148
149     [RaisesException] unsigned long numberOfScrollableAreas();
150
151     [RaisesException] boolean isPageBoxVisible(long pageNumber);
152
153     readonly attribute InternalSettings settings;
154     readonly attribute unsigned long workerThreadCount;
155
156     // Flags for layerTreeAsText.
157     const unsigned short LAYER_TREE_INCLUDES_VISIBLE_RECTS = 1;
158     const unsigned short LAYER_TREE_INCLUDES_TILE_CACHES = 2;
159     const unsigned short LAYER_TREE_INCLUDES_REPAINT_RECTS = 4;
160     const unsigned short LAYER_TREE_INCLUDES_PAINTING_PHASES = 8;
161     const unsigned short LAYER_TREE_INCLUDES_CONTENT_LAYERS = 16;
162     [RaisesException] DOMString layerTreeAsText(Document document, optional unsigned short flags);
163
164     [RaisesException] DOMString scrollingStateTreeAsText();
165     [RaisesException] DOMString mainThreadScrollingReasons(); // FIXME: rename to synchronousScrollingReasons().
166     [RaisesException] ClientRectList nonFastScrollableRects();
167
168     [RaisesException] DOMString repaintRectsAsText();
169
170     [RaisesException] void garbageCollectDocumentResources();
171
172     void allowRoundingHacks();
173
174     [RaisesException] void insertAuthorCSS(DOMString css);
175     [RaisesException] void insertUserCSS(DOMString css);
176
177 #if defined(ENABLE_BATTERY_STATUS) && ENABLE_BATTERY_STATUS
178     [RaisesException] void setBatteryStatus(DOMString eventType, boolean charging, unrestricted double chargingTime, unrestricted double dischargingTime, unrestricted double level);
179 #endif
180
181 #if defined(ENABLE_PROXIMITY_EVENTS) && ENABLE_PROXIMITY_EVENTS
182     [RaisesException] void setDeviceProximity(DOMString eventType, unrestricted double value, unrestricted double min, unrestricted double max);
183 #endif
184
185     // As per spec: http://www.w3.org/TR/WebIDL/#idl-sequence
186     // "Sequences must not be used as the type of an attribute, constant or exception field."
187     // FIXME: this will lead to BUG interals.consoleProfiles !== interals.consoleProfiles as profile will always returns new array.
188     readonly attribute ScriptProfile[] consoleProfiles;
189
190     unsigned long numberOfLiveNodes();
191     unsigned long numberOfLiveDocuments();
192     [Conditional=INSPECTOR] sequence<DOMString> consoleMessageArgumentCounts();
193     [Conditional=INSPECTOR] DOMWindow openDummyInspectorFrontend(DOMString url);
194     [Conditional=INSPECTOR] void closeDummyInspectorFrontend();
195     [Conditional=INSPECTOR, RaisesException] void setJavaScriptProfilingEnabled(boolean creates);
196     [Conditional=INSPECTOR, RaisesException] void setInspectorIsUnderTest(boolean isUnderTest);
197
198     DOMString counterValue(Element element);
199     long pageNumber(Element element, optional unrestricted float pageWidth, optional unrestricted float pageHeight);
200     DOMString[] shortcutIconURLs();
201     DOMString[] allIconURLs();
202     long numberOfPages(optional unrestricted double pageWidthInPixels, optional unrestricted double pageHeightInPixels);
203     [RaisesException] DOMString pageProperty(DOMString propertyName, long pageNumber);
204     [RaisesException] DOMString pageSizeAndMarginsInPixels(long pageIndex, long width, long height, long marginTop, long marginRight, long marginBottom, long marginLeft);
205
206     [RaisesException] void setPageScaleFactor(unrestricted float scaleFactor, long x, long y);
207     [RaisesException] void setPageZoomFactor(unrestricted float zoomFactor);
208
209     void setHeaderHeight(unrestricted float height);
210     void setFooterHeight(unrestricted float height);
211
212     void setTopContentInset(unrestricted float contentInset);
213
214 #if defined(ENABLE_FULLSCREEN_API) && ENABLE_FULLSCREEN_API
215     void webkitWillEnterFullScreenForElement(Element element);
216     void webkitDidEnterFullScreenForElement(Element element);
217     void webkitWillExitFullScreenForElement(Element element);
218     void webkitDidExitFullScreenForElement(Element element);
219 #endif
220
221     void setApplicationCacheOriginQuota(unsigned long long quota);
222
223     void registerURLSchemeAsBypassingContentSecurityPolicy(DOMString scheme);
224     void removeURLSchemeRegisteredAsBypassingContentSecurityPolicy(DOMString scheme);
225
226     MallocStatistics mallocStatistics();
227     TypeConversions typeConversions();
228     MemoryInfo memoryInfo();
229
230     DOMString[] getReferencedFilePaths();
231
232     // These functions both reset the tracked repaint rects. They are inteded to be used in the following order:
233     //  startTrackingRepaints, repaintRectsAsText, stopTrackingRepaints.
234     [RaisesException] void startTrackingRepaints();
235     [RaisesException] void stopTrackingRepaints();
236
237     // |node| should be Document, HTMLIFrameElement, or unspecified.
238     // If |node| is an HTMLIFrameElement, it assumes node.contentDocument is
239     // specified without security checks. Unspecified means this document.
240     [RaisesException] void updateLayoutIgnorePendingStylesheetsAndRunPostLayoutTasks(optional Node node);
241
242     // Returns a string with information about the mouse cursor used at the specified client location.
243     [RaisesException] DOMString getCurrentCursorInfo();
244
245     [RaisesException] DOMString markerTextForListItem(Element element);
246
247     SerializedScriptValue deserializeBuffer(ArrayBuffer buffer);
248     ArrayBuffer serializeObject(SerializedScriptValue obj);
249
250     void setUsesOverlayScrollbars(boolean enabled);
251
252     void forceReload(boolean endToEnd);
253
254     [Conditional=VIDEO] void simulateAudioInterruption(Node node);
255
256     [Conditional=ENCRYPTED_MEDIA_V2] void initializeMockCDM();
257
258     [Conditional=SPEECH_SYNTHESIS] void enableMockSpeechSynthesizer();
259
260     [RaisesException] DOMString getImageSourceURL(Element element);
261
262     [Conditional=VIDEO_TRACK, RaisesException] DOMString captionsStyleSheetOverride();
263     [Conditional=VIDEO_TRACK, RaisesException] void setCaptionsStyleSheetOverride(DOMString override);
264     [Conditional=VIDEO_TRACK, RaisesException] void setPrimaryAudioTrackLanguageOverride(DOMString language);
265     [Conditional=VIDEO_TRACK, RaisesException] void setCaptionDisplayMode(DOMString mode);
266
267     [Conditional=VIDEO] TimeRanges createTimeRanges(Float32Array startTimes, Float32Array
268      endTimes);
269     [Conditional=VIDEO] unrestricted double closestTimeToTimeRanges(unrestricted double time, TimeRanges ranges);
270
271     boolean isSelectPopupVisible(Node node);
272
273 #if defined(ENABLE_VIBRATION) && ENABLE_VIBRATION
274     boolean isVibrating();
275 #endif
276
277     [RaisesException] boolean isPluginUnavailabilityIndicatorObscured(Element element);
278     [RaisesException] boolean isPluginSnapshotted(Element element);
279
280     [RaisesException] ClientRect selectionBounds();
281
282     [Conditional=MEDIA_SOURCE] void initializeMockMediaSource();
283     [Conditional=MEDIA_SOURCE] DOMString[] bufferedSamplesForTrackID(SourceBuffer buffer, DOMString trackID);
284
285     [Conditional=VIDEO] void beginMediaSessionInterruption();
286     [Conditional=VIDEO] void endMediaSessionInterruption(DOMString flags);
287     [Conditional=VIDEO] void applicationWillEnterForeground();
288     [Conditional=VIDEO] void applicationWillEnterBackground();
289     [Conditional=VIDEO, RaisesException] void setMediaSessionRestrictions(DOMString mediaType, DOMString restrictions);
290     [Conditional=VIDEO, RaisesException] void postRemoteControlCommand(DOMString command);
291     
292     [Conditional=VIDEO] void simulateSystemSleep();
293     [Conditional=VIDEO] void simulateSystemWake();
294 };