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