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