[Web IDL] Specify default values for optional parameters of type 'float' / 'unrestric...
[WebKit.git] / Source / WebCore / testing / Internals.idl
1 /*
2  * Copyright (C) 2012 Google Inc. All rights reserved.
3  * Copyright (C) 2013-2015 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 // These map to ResourceRequestCachePolicy.
33 enum CachePolicy {
34     "UseProtocolCachePolicy",
35     "ReloadIgnoringCacheData",
36     "ReturnCacheDataElseLoad",
37     "ReturnCacheDataDontLoad"
38 };
39
40 enum ResourceLoadPriority {
41     "ResourceLoadPriorityVeryLow",
42     "ResourceLoadPriorityLow",
43     "ResourceLoadPriorityMedium",
44     "ResourceLoadPriorityHigh",
45     "ResourceLoadPriorityVeryHigh"
46 };
47
48 enum MediaSessionInterruptingCategory {
49     "content",
50     "transient",
51     "transient-solo"
52 };
53
54 enum MediaControlEvent {
55     "play-pause",
56     "next-track",
57     "previous-track"
58 };
59
60 enum AutoFillButtonType {
61     "AutoFillButtonTypeNone",
62     "AutoFillButtonTypeContacts",
63     "AutoFillButtonTypeCredentials"
64 };
65
66 [
67     ExportMacro=WEBCORE_TESTSUPPORT_EXPORT,
68     NoInterfaceObject,
69 ] interface Internals {
70     DOMString address(Node node);
71     boolean nodeNeedsStyleRecalc(Node node);
72     DOMString styleChangeType(Node node);
73     DOMString description(any value);
74
75     // Animated image pausing testing.
76     boolean hasPausedImageAnimations(Element element);
77
78     [RaisesException] DOMString elementRenderTreeAsText(Element element);
79     boolean isPreloaded(DOMString url);
80     boolean isLoadingFromMemoryCache(DOMString url);
81     DOMString xhrResponseSource(XMLHttpRequest xhr);
82     boolean isSharingStyleSheetContents(HTMLLinkElement a, HTMLLinkElement b);
83     boolean isStyleSheetLoadingSubresources(HTMLLinkElement link);
84     void clearMemoryCache();
85     void pruneMemoryCacheToSize(long size);
86     long memoryCacheSize();
87     void setOverrideCachePolicy(CachePolicy policy);
88     void setOverrideResourceLoadPriority(ResourceLoadPriority priority);
89     void setStrictRawResourceValidationPolicyDisabled(boolean disabled);
90
91     void clearPageCache();
92     unsigned long pageCacheSize();
93
94     CSSStyleDeclaration computedStyleIncludingVisitedInfo(Node node);
95
96     [RaisesException] Node ensureShadowRoot(Element host);
97     Node ensureUserAgentShadowRoot(Element host);
98     [RaisesException] Node createShadowRoot(Element host);
99     Node shadowRoot(Element host);
100
101     [RaisesException] DOMString shadowRootType(Node root);
102     DOMString shadowPseudoId(Element element);
103     void setShadowPseudoId(Element element, DOMString id);
104     Node treeScopeRootNode(Node node);
105     Node parentTreeScope(Node node);
106
107     // Spatial Navigation testing
108     [RaisesException] unsigned long lastSpatialNavigationCandidateCount();
109
110     // CSS Animation testing.
111     unsigned long numberOfActiveAnimations();
112     [RaisesException] void suspendAnimations();
113     [RaisesException] void resumeAnimations();
114     [RaisesException] boolean animationsAreSuspended();
115     [RaisesException] boolean pauseAnimationAtTimeOnElement(DOMString animationName, unrestricted double pauseTime, Element element);
116     [RaisesException] boolean pauseAnimationAtTimeOnPseudoElement(DOMString animationName, unrestricted double pauseTime, Element element, DOMString pseudoId);
117
118     // CSS Transition testing.
119     [RaisesException] boolean pauseTransitionAtTimeOnElement(DOMString propertyName, unrestricted double pauseTime, Element element);
120     [RaisesException] boolean pauseTransitionAtTimeOnPseudoElement(DOMString property, unrestricted double pauseTime, Element element, DOMString pseudoId);
121
122     DOMString visiblePlaceholder(Element element);
123     void selectColorInColorChooser(HTMLInputElement element, DOMString colorValue);
124     [RaisesException] DOMString[] formControlStateOfPreviousHistoryItem();
125     [RaisesException] void setFormControlStateOfPreviousHistoryItem(sequence<DOMString> values);
126
127     [RaisesException] ClientRect absoluteCaretBounds();
128
129     ClientRect boundingBox(Element element);
130
131     [RaisesException] ClientRectList inspectorHighlightRects();
132     [RaisesException] DOMString inspectorHighlightObject();
133
134     [RaisesException] unsigned long markerCountForNode(Node node, DOMString markerType);
135     [RaisesException] Range markerRangeForNode(Node node, DOMString markerType, unsigned long index);
136     [RaisesException] DOMString markerDescriptionForNode(Node node, DOMString markerType, unsigned long index);
137     [RaisesException] DOMString dumpMarkerRects(DOMString markerType);
138     void addTextMatchMarker(Range range, boolean isActive);
139     [RaisesException] void setMarkedTextMatchesAreHighlighted(boolean flag);
140
141     void invalidateFontCache();
142
143     [RaisesException] void setScrollViewPosition(long x, long y);
144
145     [RaisesException] void setViewBaseBackgroundColor(DOMString colorValue);
146
147     [RaisesException] void setPagination(DOMString mode, long gap, optional long pageLength);
148     [RaisesException] void setPaginationLineGridEnabled(boolean enabled);
149
150     [RaisesException] DOMString configurationForViewport(unrestricted float devicePixelRatio,
151                                        long deviceWidth,
152                                        long deviceHeight,
153                                        long availableWidth,
154                                        long availableHeight);
155
156     [RaisesException] boolean wasLastChangeUserEdit(Element textField);
157     boolean elementShouldAutoComplete(HTMLInputElement inputElement);
158     void setEditingValue(HTMLInputElement inputElement, DOMString value);
159     void setAutofilled(HTMLInputElement inputElement, boolean enabled);
160     void setShowAutoFillButton(HTMLInputElement inputElement, AutoFillButtonType autoFillButtonType);
161     [RaisesException] unsigned long countMatchesForText(DOMString text, unsigned long findOptions, DOMString markMatches);
162
163     [RaisesException] DOMString autofillFieldName(Element formControlElement);
164
165     [RaisesException] void paintControlTints();
166
167     [RaisesException] void scrollElementToRect(Element element, long x, long y, long w, long h);
168
169     Range rangeFromLocationAndLength(Element scope, long rangeLocation, long rangeLength);
170     unsigned long locationFromRange(Element scope, Range range);
171     unsigned long lengthFromRange(Element scope, Range range);
172     DOMString rangeAsText(Range range);
173     Range subrange(Range range, long rangeLocation, long rangeLength);
174     [RaisesException] Range rangeForDictionaryLookupAtLocation(long x, long y);
175
176     [RaisesException] void setDelegatesScrolling(boolean enabled);
177
178     [RaisesException] long lastSpellCheckRequestSequence();
179     [RaisesException] long lastSpellCheckProcessedSequence();
180
181     sequence<DOMString> userPreferredLanguages();
182     void setUserPreferredLanguages(sequence<DOMString> languages);
183
184     sequence<DOMString> userPreferredAudioCharacteristics();
185     void setUserPreferredAudioCharacteristic(DOMString characteristic);
186
187     [RaisesException] unsigned long wheelEventHandlerCount();
188     [RaisesException] unsigned long touchEventHandlerCount();
189
190     [RaisesException] NodeList nodesFromRect(Document document, long x, long y,
191         unsigned long topPadding, unsigned long rightPadding, unsigned long bottomPadding, unsigned long leftPadding,
192         boolean ignoreClipping, boolean allowShadowContent, boolean allowChildFrameContent);
193
194     // Calling parserMetaData() with no arguments gets the metadata for the script of the current scope.
195     DOMString parserMetaData(optional any func);
196
197     void updateEditorUINowIfScheduled();
198
199     [RaisesException] boolean hasSpellingMarker(long from, long length);
200     [RaisesException] boolean hasGrammarMarker(long from, long length);
201     [RaisesException] boolean hasAutocorrectedMarker(long from, long length);
202     [RaisesException] void setContinuousSpellCheckingEnabled(boolean enabled);
203     [RaisesException] void setAutomaticQuoteSubstitutionEnabled(boolean enabled);
204     [RaisesException] void setAutomaticLinkDetectionEnabled(boolean enabled);
205     [RaisesException] void setAutomaticDashSubstitutionEnabled(boolean enabled);
206     [RaisesException] void setAutomaticTextReplacementEnabled(boolean enabled);
207     [RaisesException] void setAutomaticSpellingCorrectionEnabled(boolean enabled);
208
209     [RaisesException] void handleAcceptedCandidate(DOMString candidate);
210
211     [RaisesException] boolean isOverwriteModeEnabled();
212     [RaisesException] void toggleOverwriteModeEnabled();
213
214     [RaisesException] unsigned long numberOfScrollableAreas();
215
216     [RaisesException] boolean isPageBoxVisible(long pageNumber);
217
218     unsigned long imageFrameIndex(HTMLImageElement element);
219
220     readonly attribute InternalSettings settings;
221     readonly attribute unsigned long workerThreadCount;
222
223     // Flags for layerTreeAsText.
224     const unsigned short LAYER_TREE_INCLUDES_VISIBLE_RECTS = 1;
225     const unsigned short LAYER_TREE_INCLUDES_TILE_CACHES = 2;
226     const unsigned short LAYER_TREE_INCLUDES_REPAINT_RECTS = 4;
227     const unsigned short LAYER_TREE_INCLUDES_PAINTING_PHASES = 8;
228     const unsigned short LAYER_TREE_INCLUDES_CONTENT_LAYERS = 16;
229     [RaisesException] DOMString layerTreeAsText(Document document, optional unsigned short flags = 0);
230
231     [RaisesException] DOMString scrollingStateTreeAsText();
232     [RaisesException] DOMString mainThreadScrollingReasons(); // FIXME: rename to synchronousScrollingReasons().
233     [RaisesException] ClientRectList nonFastScrollableRects();
234
235     [RaisesException] DOMString repaintRectsAsText();
236
237     // These throw if the element does not have a compositing layer.
238     [RaisesException] void setElementUsesDisplayListDrawing(Element element, boolean usesDisplayListDrawing);
239     [RaisesException] void setElementTracksDisplayListReplay(Element element, boolean trackReplay);
240
241     // Flags for displayListForElement.
242     const unsigned short DISPLAY_LIST_INCLUDES_PLATFORM_OPERATIONS = 1;
243     // Returns the recorded display list.
244     [RaisesException] DOMString displayListForElement(Element element, optional unsigned short flags = 0);
245     // Returns the display list that was actually painted.
246     [RaisesException] DOMString replayDisplayListForElement(Element element, optional unsigned short flags = 0);
247
248     [RaisesException] void garbageCollectDocumentResources();
249
250     [RaisesException] void insertAuthorCSS(DOMString css);
251     [RaisesException] void insertUserCSS(DOMString css);
252
253 #if defined(ENABLE_BATTERY_STATUS) && ENABLE_BATTERY_STATUS
254     [RaisesException] void setBatteryStatus(DOMString eventType, boolean charging, unrestricted double chargingTime, unrestricted double dischargingTime, unrestricted double level);
255 #endif
256
257 #if defined(ENABLE_PROXIMITY_EVENTS) && ENABLE_PROXIMITY_EVENTS
258     [RaisesException] void setDeviceProximity(DOMString eventType, unrestricted double value, unrestricted double min, unrestricted double max);
259 #endif
260
261     // As per spec: http://www.w3.org/TR/WebIDL/#idl-sequence
262     // "Sequences must not be used as the type of an attribute, constant or exception field."
263     // FIXME: this will lead to BUG internals.consoleProfiles !== internals.consoleProfiles as profile will always returns new array.
264     readonly attribute ScriptProfile[] consoleProfiles;
265
266     unsigned long numberOfLiveNodes();
267     unsigned long numberOfLiveDocuments();
268     DOMWindow openDummyInspectorFrontend(DOMString url);
269     void closeDummyInspectorFrontend();
270     [RaisesException] void setLegacyJavaScriptProfilingEnabled(boolean enabled);
271     [RaisesException] void setInspectorIsUnderTest(boolean isUnderTest);
272
273     DOMString counterValue(Element element);
274     long pageNumber(Element element, optional unrestricted float pageWidth = 800, optional unrestricted float pageHeight = 600);
275     DOMString[] shortcutIconURLs();
276     long numberOfPages(optional unrestricted double pageWidthInPixels, optional unrestricted double pageHeightInPixels);
277     [RaisesException] DOMString pageProperty(DOMString propertyName, long pageNumber);
278     [RaisesException] DOMString pageSizeAndMarginsInPixels(long pageIndex, long width, long height, long marginTop, long marginRight, long marginBottom, long marginLeft);
279
280     [RaisesException] void setPageScaleFactor(unrestricted float scaleFactor, long x, long y);
281     [RaisesException] void setPageZoomFactor(unrestricted float zoomFactor);
282     [RaisesException] void setTextZoomFactor(unrestricted float zoomFactor);
283
284     [RaisesException] void setUseFixedLayout(boolean useFixedLayout);
285     [RaisesException] void setFixedLayoutSize(long width, long height);
286
287     [RaisesException] void setViewExposedRect(unrestricted float x, unrestricted float y, unrestricted float width, unrestricted float height);
288
289     void setHeaderHeight(unrestricted float height);
290     void setFooterHeight(unrestricted float height);
291
292     void setTopContentInset(unrestricted float contentInset);
293
294 #if defined(ENABLE_FULLSCREEN_API) && ENABLE_FULLSCREEN_API
295     void webkitWillEnterFullScreenForElement(Element element);
296     void webkitDidEnterFullScreenForElement(Element element);
297     void webkitWillExitFullScreenForElement(Element element);
298     void webkitDidExitFullScreenForElement(Element element);
299 #endif
300
301     void setApplicationCacheOriginQuota(unsigned long long quota);
302
303     void registerURLSchemeAsBypassingContentSecurityPolicy(DOMString scheme);
304     void removeURLSchemeRegisteredAsBypassingContentSecurityPolicy(DOMString scheme);
305
306     MallocStatistics mallocStatistics();
307     TypeConversions typeConversions();
308     MemoryInfo memoryInfo();
309
310     DOMString[] getReferencedFilePaths();
311
312     // These functions both reset the tracked repaint rects. They are intended to be used in the following order:
313     //  startTrackingRepaints, repaintRectsAsText, stopTrackingRepaints.
314     [RaisesException] void startTrackingRepaints();
315     [RaisesException] void stopTrackingRepaints();
316
317     [RaisesException] void startTrackingLayerFlushes();
318     [RaisesException] unsigned long layerFlushCount();
319
320     // Query if a timer is currently throttled, to debug timer throttling.
321     [RaisesException] boolean isTimerThrottled(long timerHandle);
322
323     boolean isRequestAnimationFrameThrottled();
324     boolean areTimersThrottled();
325
326     [RaisesException] void startTrackingStyleRecalcs();
327     [RaisesException] unsigned long styleRecalcCount();
328
329     [RaisesException] void startTrackingCompositingUpdates();
330     [RaisesException] unsigned long compositingUpdateCount();
331
332     // |node| should be Document, HTMLIFrameElement, or unspecified.
333     // If |node| is an HTMLIFrameElement, it assumes node.contentDocument is
334     // specified without security checks. Unspecified or null means this document.
335     [RaisesException] void updateLayoutIgnorePendingStylesheetsAndRunPostLayoutTasks(optional Node? node);
336
337     readonly attribute unsigned long layoutCount;
338
339     // Returns a string with information about the mouse cursor used at the specified client location.
340     [RaisesException] DOMString getCurrentCursorInfo();
341
342     DOMString markerTextForListItem(Element element);
343
344     DOMString toolTipFromElement(Element element);
345
346     SerializedScriptValue deserializeBuffer(ArrayBuffer buffer);
347     ArrayBuffer serializeObject(SerializedScriptValue obj);
348
349     boolean isFromCurrentWorld(any obj);
350
351     void setUsesOverlayScrollbars(boolean enabled);
352     void setUsesMockScrollAnimator(boolean enabled);
353
354     void forceReload(boolean endToEnd);
355
356     void enableAutoSizeMode(boolean enabled, long minimumWidth, long minimumHeight, long maximumWidth, long maximumHeight);
357
358     [Conditional=VIDEO] void simulateAudioInterruption(HTMLMediaElement element);
359     [Conditional=VIDEO, RaisesException] boolean mediaElementHasCharacteristic(HTMLMediaElement element, DOMString characteristic);
360
361     [Conditional=ENCRYPTED_MEDIA_V2] void initializeMockCDM();
362
363     [Conditional=SPEECH_SYNTHESIS] void enableMockSpeechSynthesizer();
364
365     DOMString getImageSourceURL(Element element);
366
367     [Conditional=VIDEO_TRACK, RaisesException] DOMString captionsStyleSheetOverride();
368     [Conditional=VIDEO_TRACK, RaisesException] void setCaptionsStyleSheetOverride(DOMString override);
369     [Conditional=VIDEO_TRACK, RaisesException] void setPrimaryAudioTrackLanguageOverride(DOMString language);
370     [Conditional=VIDEO_TRACK, RaisesException] void setCaptionDisplayMode(DOMString mode);
371
372     [Conditional=VIDEO] TimeRanges createTimeRanges(Float32Array startTimes, Float32Array
373      endTimes);
374     [Conditional=VIDEO] unrestricted double closestTimeToTimeRanges(unrestricted double time, TimeRanges ranges);
375
376     boolean isSelectPopupVisible(HTMLSelectElement element);
377
378 #if defined(ENABLE_VIBRATION) && ENABLE_VIBRATION
379     boolean isVibrating();
380 #endif
381
382     [RaisesException] boolean isPluginUnavailabilityIndicatorObscured(Element element);
383     boolean isPluginSnapshotted(Element element);
384
385     [RaisesException] ClientRect selectionBounds();
386
387     [Conditional=MEDIA_SOURCE] void initializeMockMediaSource();
388     [Conditional=MEDIA_SOURCE] DOMString[] bufferedSamplesForTrackID(SourceBuffer buffer, DOMString trackID);
389     [Conditional=MEDIA_SOURCE] void setShouldGenerateTimestamps(SourceBuffer buffer, boolean flag);
390
391     [Conditional=VIDEO, RaisesException] void beginMediaSessionInterruption(DOMString interruptionType);
392     [Conditional=VIDEO] void endMediaSessionInterruption(DOMString flags);
393     [Conditional=MEDIA_SESSION] void sendMediaSessionStartOfInterruptionNotification(MediaSessionInterruptingCategory category);
394     [Conditional=MEDIA_SESSION] void sendMediaSessionEndOfInterruptionNotification(MediaSessionInterruptingCategory category);
395     [Conditional=MEDIA_SESSION] DOMString mediaSessionCurrentState(MediaSession session);
396     [Conditional=MEDIA_SESSION] double mediaElementPlayerVolume(HTMLMediaElement element);
397     [Conditional=MEDIA_SESSION] void sendMediaControlEvent(MediaControlEvent event);
398     [Conditional=VIDEO] void applicationDidEnterForeground();
399     [Conditional=VIDEO] void applicationWillEnterBackground();
400     [Conditional=VIDEO, RaisesException] void setMediaSessionRestrictions(DOMString mediaType, DOMString restrictions);
401     [Conditional=VIDEO] void setMediaElementRestrictions(HTMLMediaElement element, DOMString restrictions);
402     [Conditional=WEB_AUDIO] void setAudioContextRestrictions(AudioContext context, DOMString restrictions);
403     [Conditional=VIDEO, RaisesException] void postRemoteControlCommand(DOMString command);
404     [Conditional=WIRELESS_PLAYBACK_TARGET] void setMockMediaPlaybackTargetPickerEnabled(boolean enabled);
405     [Conditional=WIRELESS_PLAYBACK_TARGET, RaisesException] void setMockMediaPlaybackTargetPickerState(DOMString deviceName, DOMString deviceState);
406     [Conditional=MEDIA_STREAM] void setMockMediaCaptureDevicesEnabled(boolean enabled);
407
408     [Conditional=VIDEO] void simulateSystemSleep();
409     [Conditional=VIDEO] void simulateSystemWake();
410     [Conditional=VIDEO] boolean elementIsBlockingDisplaySleep(HTMLMediaElement element);
411
412     [RaisesException] MockPageOverlay installMockPageOverlay(PageOverlayType type);
413     [RaisesException] DOMString pageOverlayLayerTreeAsText();
414
415     void setPageMuted(boolean muted);
416     boolean isPagePlayingAudio();
417
418     void setPageDefersLoading(boolean defersLoading);
419
420     File createFile(DOMString url);
421     void queueMicroTask(long testNumber);
422     boolean testPreloaderSettingViewport();
423
424     [Conditional=CONTENT_FILTERING] readonly attribute MockContentFilterSettings mockContentFilterSettings;
425
426 #if defined(ENABLE_CSS_SCROLL_SNAP) && ENABLE_CSS_SCROLL_SNAP
427     [RaisesException] DOMString scrollSnapOffsets(Element element);
428 #endif
429
430     [RaisesException] DOMString pathStringWithShrinkWrappedRects(sequence<double> rectComponents, double radius);
431
432     [Conditional=VIDEO] DOMString getCurrentMediaControlsStatusForElement(HTMLMediaElement element);
433
434     DOMString userVisibleString(DOMURL url);
435
436     void setShowAllPlugins(boolean showAll);
437
438     [Conditional=STREAMS_API, CallWith=ScriptState] boolean isReadableStreamDisturbed(any stream);
439
440     DOMString resourceLoadStatisticsForOrigin(DOMString domain);
441     void setResourceLoadStatisticsEnabled(boolean enable);
442
443     [RaisesException] void setCanShowModalDialogOverride(boolean allow);
444
445     DOMString composedTreeAsText(Node parent);
446
447     void setViewportForceAlwaysUserScalable(boolean scalable);
448     void setLinkPreloadSupport(boolean scalable);
449 };