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