WebKitTestRunner needs layoutTestController.elementDoesAutoCompleteForElementWithId
[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     OmitConstructor
29 ] interface Internals {
30     DOMString address(in Node node);
31
32     DOMString elementRenderTreeAsText(in Element element) raises(DOMException);
33     boolean isPreloaded(in DOMString url);
34     boolean isLoadingFromMemoryCache(in DOMString url);
35
36     unsigned long numberOfScopedHTMLStyleChildren(in Node scope) raises(DOMException);
37     CSSStyleDeclaration computedStyleIncludingVisitedInfo(in Node node) raises(DOMException);
38
39 #if defined(ENABLE_SHADOW_DOM) && ENABLE_SHADOW_DOM
40     ShadowRoot ensureShadowRoot(in Element host) raises (DOMException);
41     ShadowRoot createShadowRoot(in Element host) raises (DOMException);
42     ShadowRoot shadowRoot(in Element host) raises (DOMException);
43     ShadowRoot youngestShadowRoot(in Element host) raises (DOMException);
44     ShadowRoot oldestShadowRoot(in Element host) raises (DOMException);
45     ShadowRoot youngerShadowRoot(in Node root) raises (DOMException);
46     ShadowRoot olderShadowRoot(in Node root) raises (DOMException);
47 #else
48     Node ensureShadowRoot(in Element host) raises (DOMException);
49     Node createShadowRoot(in Element host) raises (DOMException);
50     Node shadowRoot(in Element host) raises (DOMException);
51     Node youngestShadowRoot(in Element host) raises (DOMException);
52     Node oldestShadowRoot(in Element host) raises (DOMException);
53     Node youngerShadowRoot(in Node root) raises (DOMException);
54 #endif
55     DOMString shadowRootType(in Node root) raises (DOMException);
56     boolean hasShadowInsertionPoint(in Node root) raises (DOMException);
57     boolean hasContentElement(in Node root) raises (DOMException);
58     unsigned long countElementShadow(in Node Root) raises (DOMException);
59     Element includerFor(in Node node) raises (DOMException);
60     DOMString shadowPseudoId(in Element element) raises (DOMException);
61     void setShadowPseudoId(in Element element, in DOMString id) raises (DOMException);
62     Element createContentElement() raises(DOMException);
63     boolean isValidContentSelect(in Element contentElement) raises(DOMException);
64     Node treeScopeRootNode(in Node node) raises (DOMException);
65     Node parentTreeScope(in Node node) raises (DOMException);
66     boolean hasSelectorForIdInShadow(in Element host, in DOMString id) raises (DOMException);
67     boolean hasSelectorForClassInShadow(in Element host, in DOMString className) raises (DOMException);
68     boolean hasSelectorForAttributeInShadow(in Element host, in DOMString attributeName) raises (DOMException);
69     boolean hasSelectorForPseudoClassInShadow(in Element host, in DOMString pseudoClass) raises (DOMException);
70
71     // CSS Animation testing.
72     unsigned long numberOfActiveAnimations();
73     void suspendAnimations(in Document document) raises (DOMException);
74     void resumeAnimations(in Document document) raises (DOMException);
75     boolean pauseAnimationAtTimeOnElement(in DOMString animationName, in double pauseTime, in Element element) raises (DOMException);
76     boolean pauseAnimationAtTimeOnPseudoElement(in DOMString animationName, in double pauseTime, in Element element, in DOMString pseudoId) raises (DOMException);
77
78     // CSS Transition testing.
79     boolean pauseTransitionAtTimeOnElement(in DOMString propertyName, in double pauseTime, in Element element) raises (DOMException);
80     boolean pauseTransitionAtTimeOnPseudoElement(in DOMString property, in double pauseTime, in Element element, in DOMString pseudoId) raises (DOMException);
81
82     Node nextSiblingByWalker(in Node node) raises(DOMException);
83     Node firstChildByWalker(in Node node) raises(DOMException);
84     Node lastChildByWalker(in Node node) raises(DOMException);
85     Node nextNodeByWalker(in Node node) raises(DOMException);
86     Node previousNodeByWalker(in Node node) raises(DOMException);
87
88     boolean attached(in Node node) raises(DOMException);
89
90     DOMString visiblePlaceholder(in Element element);
91 #if defined(ENABLE_INPUT_TYPE_COLOR) && ENABLE_INPUT_TYPE_COLOR
92     void selectColorInColorChooser(in Element element, in DOMString colorValue);
93 #endif
94     DOMString[] formControlStateOfPreviousHistoryItem() raises(DOMException);
95     void setFormControlStateOfPreviousHistoryItem(in sequence<DOMString> values) raises(DOMException);
96     void setEnableMockPagePopup(in boolean enabled) raises(DOMException);
97 #if defined(ENABLE_PAGE_POPUP) && ENABLE_PAGE_POPUP
98     readonly attribute PagePopupController pagePopupController;
99 #endif
100
101     ClientRect absoluteCaretBounds() raises(DOMException);
102
103     ClientRect boundingBox(in Element element) raises(DOMException);
104
105     ClientRectList inspectorHighlightRects(in Document document) raises (DOMException);
106
107     void setBackgroundBlurOnNode(in Node node, in long blurLength) raises(DOMException);
108
109     unsigned long markerCountForNode(in Node node, in DOMString markerType) raises(DOMException);
110     Range markerRangeForNode(in Node node, in DOMString markerType, in unsigned long index) raises(DOMException);
111     DOMString markerDescriptionForNode(in Node node, in DOMString markerType, in unsigned long index) raises(DOMException);
112     void addTextMatchMarker(in Range range, in boolean isActive);
113
114     void setScrollViewPosition(in Document document, in long x, in long y) raises(DOMException);
115
116     void setPagination(in Document document, in DOMString mode, in long gap, in [Optional] long pageLength) raises(DOMException);
117
118     DOMString configurationForViewport(in Document document,
119                                        in float devicePixelRatio,
120                                        in long deviceWidth,
121                                        in long deviceHeight,
122                                        in long availableWidth,
123                                        in long availableHeight) raises(DOMException);
124
125     boolean wasLastChangeUserEdit(in Element textField) raises (DOMException);
126     boolean elementShouldAutoComplete(in Element inputElement) raises (DOMException);
127     DOMString suggestedValue(in Element inputElement) raises (DOMException);
128     void setSuggestedValue(in Element inputElement, in DOMString value) raises (DOMException);
129     void setEditingValue(in Element inputElement, in DOMString value) raises (DOMException);
130     void setAutofilled(in Element inputElement, in boolean enabled) raises(DOMException);
131
132     void paintControlTints(in Document document) raises (DOMException);
133
134     void scrollElementToRect(in Element element, in long x, in long y, in long w, in long h) raises (DOMException);
135
136     Range rangeFromLocationAndLength(in Element scope, in long rangeLocation, in long rangeLength) raises (DOMException);
137     unsigned long locationFromRange(in Element scope, in Range range) raises (DOMException);
138     unsigned long lengthFromRange(in Element scope, in Range range) raises (DOMException);
139     DOMString rangeAsText(in Range range) raises (DOMException);
140
141     void setDelegatesScrolling(in boolean enabled, in Document document) raises (DOMException);
142 #if defined(ENABLE_TOUCH_ADJUSTMENT) && ENABLE_TOUCH_ADJUSTMENT
143     WebKitPoint touchPositionAdjustedToBestClickableNode(in long x, in long y, in long width, in long height, in Document document) raises (DOMException);
144     Node touchNodeAdjustedToBestClickableNode(in long x, in long y, in long width, in long height, in Document document) raises (DOMException);
145     WebKitPoint touchPositionAdjustedToBestContextMenuNode(in long x, in long y, in long width, in long height, in Document document) raises (DOMException);
146     Node touchNodeAdjustedToBestContextMenuNode(in long x, in long y, in long width, in long height, in Document document) raises (DOMException);
147     ClientRect bestZoomableAreaForTouchPoint(in long x, in long y, in long width, in long height, in Document document) raises (DOMException);
148 #endif
149
150     long lastSpellCheckRequestSequence(in Document document) raises (DOMException);
151     long lastSpellCheckProcessedSequence(in Document document) raises (DOMException);
152
153     sequence<DOMString> userPreferredLanguages();
154     void setUserPreferredLanguages(in sequence<DOMString> languages);
155
156     unsigned long wheelEventHandlerCount(in Document document) raises (DOMException);
157     unsigned long touchEventHandlerCount(in Document document) raises (DOMException);
158 #if defined(ENABLE_TOUCH_EVENT_TRACKING) && ENABLE_TOUCH_EVENT_TRACKING
159     ClientRectList touchEventTargetClientRects(in Document document) raises (DOMException);
160 #endif
161
162     NodeList nodesFromRect(in Document document, in long x, in long y,
163         in unsigned long topPadding, in unsigned long rightPadding, in unsigned long bottomPadding, in unsigned long leftPadding,
164         in boolean ignoreClipping, in boolean allowShadowContent, in boolean allowChildFrameContent) raises (DOMException);
165
166     void emitInspectorDidBeginFrame();
167     void emitInspectorDidCancelFrame();
168
169     boolean hasSpellingMarker(in Document document, in long from, in long length) raises (DOMException);
170     boolean hasGrammarMarker(in Document document, in long from, in long length) raises (DOMException);
171     boolean hasAutocorrectedMarker(in Document document, in long from, in long length) raises (DOMException);
172
173     unsigned long numberOfScrollableAreas(in Document document) raises (DOMException);
174
175     boolean isPageBoxVisible(in Document document, in long pageNumber) raises (DOMException);
176
177     readonly attribute InternalSettings settings;
178     readonly attribute unsigned long workerThreadCount;
179
180     // Flags for layerTreeAsText.
181     const unsigned short LAYER_TREE_INCLUDES_VISIBLE_RECTS = 1;
182     const unsigned short LAYER_TREE_INCLUDES_TILE_CACHES = 2;
183     const unsigned short LAYER_TREE_INCLUDES_REPAINT_RECTS = 4;
184     DOMString layerTreeAsText(in Document document, in [Optional] unsigned short flags) raises (DOMException);
185
186     DOMString scrollingStateTreeAsText(in Document document) raises (DOMException);
187     DOMString mainThreadScrollingReasons(in Document document) raises (DOMException);
188     ClientRectList nonFastScrollableRects(in Document document) raises (DOMException);
189
190     DOMString repaintRectsAsText(in Document document) raises (DOMException);
191
192     void garbageCollectDocumentResources(in Document document) raises (DOMException);
193
194     void allowRoundingHacks();
195
196     void insertAuthorCSS(in Document document, in DOMString css);
197     void insertUserCSS(in Document document, in DOMString css);
198
199 #if defined(ENABLE_BATTERY_STATUS) && ENABLE_BATTERY_STATUS
200     void setBatteryStatus(in Document document, in DOMString eventType, in boolean charging, in double chargingTime, in double dischargingTime, in double level) raises (DOMException);
201 #endif
202
203 #if defined(ENABLE_NETWORK_INFO) && ENABLE_NETWORK_INFO
204     void setNetworkInformation(in Document document, in DOMString eventType, in double bandwidth, in boolean metered) raises (DOMException);
205 #endif
206
207 #if defined(ENABLE_PROXIMITY_EVENTS) && ENABLE_PROXIMITY_EVENTS
208     void setDeviceProximity(in Document document, in DOMString eventType, in double value, in double min, in double max) raises (DOMException);
209 #endif
210
211     [Conditional=INSPECTOR] unsigned long numberOfLiveNodes();
212     [Conditional=INSPECTOR] unsigned long numberOfLiveDocuments();
213     [Conditional=INSPECTOR] sequence<DOMString> consoleMessageArgumentCounts(in Document document);
214     [Conditional=INSPECTOR] DOMWindow openDummyInspectorFrontend(in DOMString url);
215     [Conditional=INSPECTOR] void closeDummyInspectorFrontend();
216     [Conditional=INSPECTOR] void setInspectorResourcesDataSizeLimits(in long maximumResourcesContentSize, in long maximumSingleResourceContentSize) raises(DOMException);
217     [Conditional=INSPECTOR] void setJavaScriptProfilingEnabled(in boolean creates) raises(DOMException);
218
219     DOMString counterValue(in Element element);
220     long pageNumber(in Element element, in [Optional] float pageWidth, in [Optional] float pageHeight);
221     DOMString[] shortcutIconURLs(in Document document);
222     DOMString[] allIconURLs(in Document document);
223     long numberOfPages(in [Optional] double pageWidthInPixels, in [Optional] double pageHeightInPixels);
224     DOMString pageProperty(in DOMString propertyName, in long pageNumber) raises (DOMException);
225     DOMString pageSizeAndMarginsInPixels(in long pageIndex, in long width, in long height, in long marginTop, in long marginRight, in long marginBottom, in long marginLeft) raises (DOMException);
226
227     void setPageScaleFactor(in float scaleFactor, in long x, in long y) raises(DOMException);
228
229 #if defined(ENABLE_FULLSCREEN_API) && ENABLE_FULLSCREEN_API
230     void webkitWillEnterFullScreenForElement(in Document document, in Element element);
231     void webkitDidEnterFullScreenForElement(in Document document, in Element element);
232     void webkitWillExitFullScreenForElement(in Document document, in Element element);
233     void webkitDidExitFullScreenForElement(in Document document, in Element element);
234 #endif
235
236     void registerURLSchemeAsBypassingContentSecurityPolicy(in DOMString scheme);
237     void removeURLSchemeRegisteredAsBypassingContentSecurityPolicy(in DOMString scheme);
238
239     MallocStatistics mallocStatistics();
240     TypeConversions typeConversions();
241
242     DOMString[] getReferencedFilePaths();
243
244     // These functions both reset the tracked repaint rects. They are inteded to be used in the following order:
245     //  startTrackingRepaints, repaintRectsAsText, stopTrackingRepaints.
246     void startTrackingRepaints(in Document document) raises (DOMException);
247     void stopTrackingRepaints(in Document document) raises (DOMException);
248
249     // Returns a string with information about the mouse cursor used at the specified client location.
250     DOMString getCurrentCursorInfo(in Document document) raises (DOMException);
251
252     DOMString markerTextForListItem(in Element element) raises (DOMException);
253
254     SerializedScriptValue deserializeBuffer(in ArrayBuffer buffer);
255     ArrayBuffer serializeObject(in SerializedScriptValue obj);
256
257     void setUsesOverlayScrollbars(in boolean enabled);
258
259     [Conditional=ENCRYPTED_MEDIA_V2] void initializeMockCDM();
260
261     [Conditional=SPEECH_SYNTHESIS] void enableMockSpeechSynthesizer();
262 };