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