Addressing post-review feedback on r235619.
[WebKit-https.git] / Source / WebCore / testing / Internals.h
1 /*
2  * Copyright (C) 2012 Google Inc. All rights reserved.
3  * Copyright (C) 2013-2017 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 #pragma once
28
29 #include "CSSComputedStyleDeclaration.h"
30 #include "ContextDestructionObserver.h"
31 #include "ExceptionOr.h"
32 #include "JSDOMPromiseDeferred.h"
33 #include "OrientationNotifier.h"
34 #include "PageConsoleClient.h"
35 #include "RealtimeMediaSource.h"
36 #include <JavaScriptCore/Float32Array.h>
37 #include <wtf/Optional.h>
38
39 #if ENABLE(MEDIA_SESSION)
40 #include "MediaSessionInterruptionProvider.h"
41 #endif
42
43 #if ENABLE(VIDEO)
44 #include "MediaElementSession.h"
45 #endif
46
47 namespace WebCore {
48
49 class AnimationTimeline;
50 class AudioContext;
51 class CacheStorageConnection;
52 class DOMRect;
53 class DOMRectList;
54 class DOMURL;
55 class DOMWindow;
56 class Document;
57 class Element;
58 class ExtendableEvent;
59 class FetchResponse;
60 class File;
61 class Frame;
62 class GCObservation;
63 class HTMLAnchorElement;
64 class HTMLImageElement;
65 class HTMLInputElement;
66 class HTMLLinkElement;
67 class HTMLMediaElement;
68 class HTMLPictureElement;
69 class HTMLSelectElement;
70 class ImageData;
71 class InspectorStubFrontend;
72 class InternalSettings;
73 class MallocStatistics;
74 class MediaSession;
75 class MediaStream;
76 class MediaStreamTrack;
77 class MemoryInfo;
78 class MockCDMFactory;
79 class MockContentFilterSettings;
80 class MockAuthenticatorCoordinator;
81 class MockPageOverlay;
82 class MockPaymentCoordinator;
83 class NodeList;
84 class Page;
85 class RTCPeerConnection;
86 class Range;
87 class RenderedDocumentMarker;
88 class SVGSVGElement;
89 class SerializedScriptValue;
90 class SourceBuffer;
91 class StringCallback;
92 class StyleSheet;
93 class TimeRanges;
94 class TypeConversions;
95 class VoidCallback;
96 class WebGLRenderingContext;
97 class XMLHttpRequest;
98
99 #if ENABLE(SERVICE_WORKER)
100 class ServiceWorker;
101 #endif
102
103 class Internals final : public RefCounted<Internals>, private ContextDestructionObserver
104 #if ENABLE(MEDIA_STREAM)
105     , private RealtimeMediaSource::Observer
106 #endif
107     {
108 public:
109     static Ref<Internals> create(Document&);
110     virtual ~Internals();
111
112     static void resetToConsistentState(Page&);
113
114     ExceptionOr<String> elementRenderTreeAsText(Element&);
115     bool hasPausedImageAnimations(Element&);
116
117     bool isPaintingFrequently(Element&);
118     void incrementFrequentPaintCounter(Element&);
119
120     String address(Node&);
121     bool nodeNeedsStyleRecalc(Node&);
122     String styleChangeType(Node&);
123     String description(JSC::JSValue);
124
125     bool isPreloaded(const String& url);
126     bool isLoadingFromMemoryCache(const String& url);
127     String fetchResponseSource(FetchResponse&);
128     String xhrResponseSource(XMLHttpRequest&);
129     bool isSharingStyleSheetContents(HTMLLinkElement&, HTMLLinkElement&);
130     bool isStyleSheetLoadingSubresources(HTMLLinkElement&);
131     enum class CachePolicy { UseProtocolCachePolicy, ReloadIgnoringCacheData, ReturnCacheDataElseLoad, ReturnCacheDataDontLoad };
132     void setOverrideCachePolicy(CachePolicy);
133     ExceptionOr<void> setCanShowModalDialogOverride(bool allow);
134     enum class ResourceLoadPriority { ResourceLoadPriorityVeryLow, ResourceLoadPriorityLow, ResourceLoadPriorityMedium, ResourceLoadPriorityHigh, ResourceLoadPriorityVeryHigh };
135     void setOverrideResourceLoadPriority(ResourceLoadPriority);
136     void setStrictRawResourceValidationPolicyDisabled(bool);
137
138     void clearMemoryCache();
139     void pruneMemoryCacheToSize(unsigned size);
140     void destroyDecodedDataForAllImages();
141     unsigned memoryCacheSize() const;
142
143     unsigned imageFrameIndex(HTMLImageElement&);
144     void setImageFrameDecodingDuration(HTMLImageElement&, float duration);
145     void resetImageAnimation(HTMLImageElement&);
146     bool isImageAnimating(HTMLImageElement&);
147     void setClearDecoderAfterAsyncFrameRequestForTesting(HTMLImageElement&, bool enabled);
148     unsigned imageDecodeCount(HTMLImageElement&);
149     unsigned pdfDocumentCachingCount(HTMLImageElement&);
150     void setLargeImageAsyncDecodingEnabledForTesting(HTMLImageElement&, bool enabled);
151     void setForceUpdateImageDataEnabledForTesting(HTMLImageElement&, bool enabled);
152
153     void setGridMaxTracksLimit(unsigned);
154
155     void clearPageCache();
156     unsigned pageCacheSize() const;
157
158     void disableTileSizeUpdateDelay();
159
160     void setSpeculativeTilingDelayDisabledForTesting(bool);
161
162     Ref<CSSComputedStyleDeclaration> computedStyleIncludingVisitedInfo(Element&) const;
163
164     Node* ensureUserAgentShadowRoot(Element& host);
165     Node* shadowRoot(Element& host);
166     ExceptionOr<String> shadowRootType(const Node&) const;
167     String shadowPseudoId(Element&);
168     void setShadowPseudoId(Element&, const String&);
169
170     // CSS Deferred Parsing Testing
171     unsigned deferredStyleRulesCount(StyleSheet&);
172     unsigned deferredGroupRulesCount(StyleSheet&);
173     unsigned deferredKeyframesRulesCount(StyleSheet&);
174
175     // DOMTimers throttling testing.
176     ExceptionOr<bool> isTimerThrottled(int timeoutId);
177     bool isRequestAnimationFrameThrottled() const;
178     double requestAnimationFrameInterval() const;
179     bool scriptedAnimationsAreSuspended() const;
180     bool areTimersThrottled() const;
181
182     enum EventThrottlingBehavior { Responsive, Unresponsive };
183     void setEventThrottlingBehaviorOverride(std::optional<EventThrottlingBehavior>);
184     std::optional<EventThrottlingBehavior> eventThrottlingBehaviorOverride() const;
185
186     // Spatial Navigation testing.
187     ExceptionOr<unsigned> lastSpatialNavigationCandidateCount() const;
188
189     // CSS Animation testing.
190     unsigned numberOfActiveAnimations() const;
191     ExceptionOr<bool> animationsAreSuspended() const;
192     ExceptionOr<void> suspendAnimations() const;
193     ExceptionOr<void> resumeAnimations() const;
194     ExceptionOr<bool> pauseAnimationAtTimeOnElement(const String& animationName, double pauseTime, Element&);
195     ExceptionOr<bool> pauseAnimationAtTimeOnPseudoElement(const String& animationName, double pauseTime, Element&, const String& pseudoId);
196     double animationsInterval() const;
197
198     // CSS Transition testing.
199     ExceptionOr<bool> pauseTransitionAtTimeOnElement(const String& propertyName, double pauseTime, Element&);
200     ExceptionOr<bool> pauseTransitionAtTimeOnPseudoElement(const String& property, double pauseTime, Element&, const String& pseudoId);
201
202     // For animations testing, we need a way to get at pseudo elements.
203     ExceptionOr<RefPtr<Element>> pseudoElement(Element&, const String&);
204
205     Node* treeScopeRootNode(Node&);
206     Node* parentTreeScope(Node&);
207
208     String visiblePlaceholder(Element&);
209     void selectColorInColorChooser(HTMLInputElement&, const String& colorValue);
210     ExceptionOr<Vector<String>> formControlStateOfPreviousHistoryItem();
211     ExceptionOr<void> setFormControlStateOfPreviousHistoryItem(const Vector<String>&);
212
213     ExceptionOr<Ref<DOMRect>> absoluteCaretBounds();
214
215     Ref<DOMRect> boundingBox(Element&);
216
217     ExceptionOr<Ref<DOMRectList>> inspectorHighlightRects();
218     ExceptionOr<String> inspectorHighlightObject();
219
220     ExceptionOr<unsigned> markerCountForNode(Node&, const String&);
221     ExceptionOr<RefPtr<Range>> markerRangeForNode(Node&, const String& markerType, unsigned index);
222     ExceptionOr<String> markerDescriptionForNode(Node&, const String& markerType, unsigned index);
223     ExceptionOr<String> dumpMarkerRects(const String& markerType);
224     void addTextMatchMarker(const Range&, bool isActive);
225     ExceptionOr<void> setMarkedTextMatchesAreHighlighted(bool);
226
227     void invalidateFontCache();
228     void setFontSmoothingEnabled(bool);
229
230     ExceptionOr<void> setLowPowerModeEnabled(bool);
231
232     ExceptionOr<void> setScrollViewPosition(int x, int y);
233     ExceptionOr<void> unconstrainedScrollTo(Element&, double x, double y);
234
235     ExceptionOr<Ref<DOMRect>> layoutViewportRect();
236     ExceptionOr<Ref<DOMRect>> visualViewportRect();
237
238     ExceptionOr<void> setViewBaseBackgroundColor(const String& colorValue);
239
240     ExceptionOr<void> setPagination(const String& mode, int gap, int pageLength);
241     ExceptionOr<void> setPaginationLineGridEnabled(bool);
242     ExceptionOr<String> configurationForViewport(float devicePixelRatio, int deviceWidth, int deviceHeight, int availableWidth, int availableHeight);
243
244     ExceptionOr<bool> wasLastChangeUserEdit(Element& textField);
245     bool elementShouldAutoComplete(HTMLInputElement&);
246     void setEditingValue(HTMLInputElement&, const String&);
247     void setAutofilled(HTMLInputElement&, bool enabled);
248     enum class AutoFillButtonType { None, Contacts, Credentials, StrongPassword };
249     void setShowAutoFillButton(HTMLInputElement&, AutoFillButtonType);
250     AutoFillButtonType autoFillButtonType(const HTMLInputElement&);
251     AutoFillButtonType lastAutoFillButtonType(const HTMLInputElement&);
252     ExceptionOr<void> scrollElementToRect(Element&, int x, int y, int w, int h);
253
254     ExceptionOr<String> autofillFieldName(Element&);
255
256     ExceptionOr<void> invalidateControlTints();
257
258     RefPtr<Range> rangeFromLocationAndLength(Element& scope, int rangeLocation, int rangeLength);
259     unsigned locationFromRange(Element& scope, const Range&);
260     unsigned lengthFromRange(Element& scope, const Range&);
261     String rangeAsText(const Range&);
262     Ref<Range> subrange(Range&, int rangeLocation, int rangeLength);
263     ExceptionOr<RefPtr<Range>> rangeForDictionaryLookupAtLocation(int x, int y);
264     RefPtr<Range> rangeOfStringNearLocation(const Range&, const String&, unsigned);
265
266     ExceptionOr<void> setDelegatesScrolling(bool enabled);
267
268     ExceptionOr<int> lastSpellCheckRequestSequence();
269     ExceptionOr<int> lastSpellCheckProcessedSequence();
270
271     Vector<String> userPreferredLanguages() const;
272     void setUserPreferredLanguages(const Vector<String>&);
273
274     Vector<String> userPreferredAudioCharacteristics() const;
275     void setUserPreferredAudioCharacteristic(const String&);
276
277     ExceptionOr<unsigned> wheelEventHandlerCount();
278     ExceptionOr<unsigned> touchEventHandlerCount();
279
280     ExceptionOr<Ref<DOMRectList>> touchEventRectsForEvent(const String&);
281     ExceptionOr<Ref<DOMRectList>> passiveTouchEventListenerRects();
282
283     ExceptionOr<RefPtr<NodeList>> nodesFromRect(Document&, int x, int y, unsigned topPadding, unsigned rightPadding, unsigned bottomPadding, unsigned leftPadding, bool ignoreClipping, bool allowUserAgentShadowContent, bool allowChildFrameContent) const;
284
285     String parserMetaData(JSC::JSValue = JSC::JSValue::JSUndefined);
286
287     void updateEditorUINowIfScheduled();
288
289     bool sentenceRetroCorrectionEnabled() const
290     {
291 #if PLATFORM(MAC) && __MAC_OS_X_VERSION_MIN_REQUIRED >= 101400
292         return true;
293 #else
294         return false;
295 #endif
296     }
297     bool hasSpellingMarker(int from, int length);
298     bool hasGrammarMarker(int from, int length);
299     bool hasAutocorrectedMarker(int from, int length);
300     void setContinuousSpellCheckingEnabled(bool);
301     void setAutomaticQuoteSubstitutionEnabled(bool);
302     void setAutomaticLinkDetectionEnabled(bool);
303     void setAutomaticDashSubstitutionEnabled(bool);
304     void setAutomaticTextReplacementEnabled(bool);
305     void setAutomaticSpellingCorrectionEnabled(bool);
306
307     void handleAcceptedCandidate(const String& candidate, unsigned location, unsigned length);
308
309     bool isOverwriteModeEnabled();
310     void toggleOverwriteModeEnabled();
311
312     ExceptionOr<RefPtr<Range>> rangeOfString(const String&, RefPtr<Range>&&, const Vector<String>& findOptions);
313     ExceptionOr<unsigned> countMatchesForText(const String&, const Vector<String>& findOptions, const String& markMatches);
314     ExceptionOr<unsigned> countFindMatches(const String&, const Vector<String>& findOptions);
315
316     unsigned numberOfScrollableAreas();
317
318     ExceptionOr<bool> isPageBoxVisible(int pageNumber);
319
320     static const char* internalsId;
321
322     InternalSettings* settings() const;
323     unsigned workerThreadCount() const;
324     ExceptionOr<bool> areSVGAnimationsPaused() const;
325     ExceptionOr<double> svgAnimationsInterval(SVGSVGElement&) const;
326
327     enum {
328         // Values need to be kept in sync with Internals.idl.
329         LAYER_TREE_INCLUDES_VISIBLE_RECTS = 1,
330         LAYER_TREE_INCLUDES_TILE_CACHES = 2,
331         LAYER_TREE_INCLUDES_REPAINT_RECTS = 4,
332         LAYER_TREE_INCLUDES_PAINTING_PHASES = 8,
333         LAYER_TREE_INCLUDES_CONTENT_LAYERS = 16,
334         LAYER_TREE_INCLUDES_ACCELERATES_DRAWING = 32,
335         LAYER_TREE_INCLUDES_BACKING_STORE_ATTACHED = 64,
336     };
337     ExceptionOr<String> layerTreeAsText(Document&, unsigned short flags) const;
338     ExceptionOr<uint64_t> layerIDForElement(Element&);
339     ExceptionOr<String> repaintRectsAsText() const;
340     ExceptionOr<String> scrollingStateTreeAsText() const;
341     ExceptionOr<String> mainThreadScrollingReasons() const;
342     ExceptionOr<Ref<DOMRectList>> nonFastScrollableRects() const;
343
344     ExceptionOr<void> setElementUsesDisplayListDrawing(Element&, bool usesDisplayListDrawing);
345     ExceptionOr<void> setElementTracksDisplayListReplay(Element&, bool isTrackingReplay);
346
347     enum {
348         // Values need to be kept in sync with Internals.idl.
349         DISPLAY_LIST_INCLUDES_PLATFORM_OPERATIONS = 1,
350     };
351     ExceptionOr<String> displayListForElement(Element&, unsigned short flags);
352     ExceptionOr<String> replayDisplayListForElement(Element&, unsigned short flags);
353
354     ExceptionOr<void> garbageCollectDocumentResources() const;
355
356     void beginSimulatedMemoryPressure();
357     void endSimulatedMemoryPressure();
358     bool isUnderMemoryPressure();
359
360     ExceptionOr<void> insertAuthorCSS(const String&) const;
361     ExceptionOr<void> insertUserCSS(const String&) const;
362
363     unsigned numberOfLiveNodes() const;
364     unsigned numberOfLiveDocuments() const;
365     unsigned referencingNodeCount(const Document&) const;
366
367 #if ENABLE(INTERSECTION_OBSERVER)
368     unsigned numberOfIntersectionObservers(const Document&) const;
369 #endif
370
371     uint64_t documentIdentifier(const Document&) const;
372     bool isDocumentAlive(uint64_t documentIdentifier) const;
373
374     String serviceWorkerClientIdentifier(const Document&) const;
375
376     RefPtr<WindowProxy> openDummyInspectorFrontend(const String& url);
377     void closeDummyInspectorFrontend();
378     ExceptionOr<void> setInspectorIsUnderTest(bool);
379
380     String counterValue(Element&);
381
382     int pageNumber(Element&, float pageWidth = 800, float pageHeight = 600);
383     Vector<String> shortcutIconURLs() const;
384
385     int numberOfPages(float pageWidthInPixels = 800, float pageHeightInPixels = 600);
386     ExceptionOr<String> pageProperty(const String& propertyName, int pageNumber) const;
387     ExceptionOr<String> pageSizeAndMarginsInPixels(int pageNumber, int width, int height, int marginTop, int marginRight, int marginBottom, int marginLeft) const;
388
389     ExceptionOr<float> pageScaleFactor() const;
390
391     ExceptionOr<void> setPageScaleFactor(float scaleFactor, int x, int y);
392     ExceptionOr<void> setPageZoomFactor(float);
393     ExceptionOr<void> setTextZoomFactor(float);
394
395     ExceptionOr<void> setUseFixedLayout(bool);
396     ExceptionOr<void> setFixedLayoutSize(int width, int height);
397     ExceptionOr<void> setViewExposedRect(float left, float top, float width, float height);
398     void setPrinting(int width, int height);
399
400     void setHeaderHeight(float);
401     void setFooterHeight(float);
402
403     void setTopContentInset(float);
404
405 #if ENABLE(FULLSCREEN_API)
406     void webkitWillEnterFullScreenForElement(Element&);
407     void webkitDidEnterFullScreenForElement(Element&);
408     void webkitWillExitFullScreenForElement(Element&);
409     void webkitDidExitFullScreenForElement(Element&);
410     bool isAnimatingFullScreen() const;
411 #endif
412
413     struct FullscreenInsets {
414         float top { 0 };
415         float left { 0 };
416         float bottom { 0 };
417         float right { 0 };
418     };
419     void setFullscreenInsets(FullscreenInsets);
420     void setFullscreenAutoHideDuration(double);
421     void setFullscreenControlsHidden(bool);
422
423     WEBCORE_TESTSUPPORT_EXPORT void setApplicationCacheOriginQuota(unsigned long long);
424
425     void registerURLSchemeAsBypassingContentSecurityPolicy(const String& scheme);
426     void removeURLSchemeRegisteredAsBypassingContentSecurityPolicy(const String& scheme);
427
428     void registerDefaultPortForProtocol(unsigned short port, const String& protocol);
429
430     Ref<MallocStatistics> mallocStatistics() const;
431     Ref<TypeConversions> typeConversions() const;
432     Ref<MemoryInfo> memoryInfo() const;
433
434     Vector<String> getReferencedFilePaths() const;
435
436     ExceptionOr<void> startTrackingRepaints();
437     ExceptionOr<void> stopTrackingRepaints();
438
439     ExceptionOr<void> startTrackingLayerFlushes();
440     ExceptionOr<unsigned> layerFlushCount();
441
442     ExceptionOr<void> startTrackingStyleRecalcs();
443     ExceptionOr<unsigned> styleRecalcCount();
444     unsigned lastStyleUpdateSize() const;
445
446     ExceptionOr<void> startTrackingCompositingUpdates();
447     ExceptionOr<unsigned> compositingUpdateCount();
448
449     enum CompositingPolicy { Normal, Conservative };
450     ExceptionOr<void> setCompositingPolicyOverride(std::optional<CompositingPolicy>);
451     ExceptionOr<std::optional<CompositingPolicy>> compositingPolicyOverride() const;
452
453     ExceptionOr<void> updateLayoutIgnorePendingStylesheetsAndRunPostLayoutTasks(Node*);
454     unsigned layoutCount() const;
455
456     Ref<ArrayBuffer> serializeObject(const RefPtr<SerializedScriptValue>&) const;
457     Ref<SerializedScriptValue> deserializeBuffer(ArrayBuffer&) const;
458
459     bool isFromCurrentWorld(JSC::JSValue) const;
460
461     void setUsesOverlayScrollbars(bool);
462     void setUsesMockScrollAnimator(bool);
463
464     ExceptionOr<String> getCurrentCursorInfo();
465
466     String markerTextForListItem(Element&);
467
468     String toolTipFromElement(Element&) const;
469
470     void forceReload(bool endToEnd);
471     void reloadExpiredOnly();
472
473     void enableAutoSizeMode(bool enabled, int minimumWidth, int minimumHeight, int maximumWidth, int maximumHeight);
474
475 #if ENABLE(LEGACY_ENCRYPTED_MEDIA)
476     void initializeMockCDM();
477 #endif
478
479 #if ENABLE(ENCRYPTED_MEDIA)
480     Ref<MockCDMFactory> registerMockCDM();
481 #endif
482
483     void enableMockMediaCapabilities();
484
485 #if ENABLE(SPEECH_SYNTHESIS)
486     void enableMockSpeechSynthesizer();
487 #endif
488
489 #if ENABLE(MEDIA_STREAM)
490     void setMockMediaCaptureDevicesEnabled(bool);
491 #endif
492
493 #if ENABLE(WEB_RTC)
494     void emulateRTCPeerConnectionPlatformEvent(RTCPeerConnection&, const String& action);
495     void useMockRTCPeerConnectionFactory(const String&);
496     void setICECandidateFiltering(bool);
497     void setEnumeratingAllNetworkInterfacesEnabled(bool);
498     void stopPeerConnection(RTCPeerConnection&);
499     void applyRotationForOutgoingVideoSources(RTCPeerConnection&);
500 #endif
501
502     String getImageSourceURL(Element&);
503
504 #if ENABLE(VIDEO)
505     Vector<String> mediaResponseSources(HTMLMediaElement&);
506     Vector<String> mediaResponseContentRanges(HTMLMediaElement&);
507     void simulateAudioInterruption(HTMLMediaElement&);
508     ExceptionOr<bool> mediaElementHasCharacteristic(HTMLMediaElement&, const String&);
509     void beginSimulatedHDCPError(HTMLMediaElement&);
510     void endSimulatedHDCPError(HTMLMediaElement&);
511
512     bool elementShouldBufferData(HTMLMediaElement&);
513 #endif
514
515     bool isSelectPopupVisible(HTMLSelectElement&);
516
517     ExceptionOr<String> captionsStyleSheetOverride();
518     ExceptionOr<void> setCaptionsStyleSheetOverride(const String&);
519     ExceptionOr<void> setPrimaryAudioTrackLanguageOverride(const String&);
520     ExceptionOr<void> setCaptionDisplayMode(const String&);
521
522 #if ENABLE(VIDEO)
523     Ref<TimeRanges> createTimeRanges(Float32Array& startTimes, Float32Array& endTimes);
524     double closestTimeToTimeRanges(double time, TimeRanges&);
525 #endif
526
527     ExceptionOr<Ref<DOMRect>> selectionBounds();
528
529     ExceptionOr<bool> isPluginUnavailabilityIndicatorObscured(Element&);
530     ExceptionOr<String> unavailablePluginReplacementText(Element&);
531     bool isPluginSnapshotted(Element&);
532
533 #if ENABLE(MEDIA_SOURCE)
534     WEBCORE_TESTSUPPORT_EXPORT void initializeMockMediaSource();
535     Vector<String> bufferedSamplesForTrackID(SourceBuffer&, const AtomicString&);
536     Vector<String> enqueuedSamplesForTrackID(SourceBuffer&, const AtomicString&);
537     void setShouldGenerateTimestamps(SourceBuffer&, bool);
538 #endif
539
540 #if ENABLE(VIDEO)
541     ExceptionOr<void> beginMediaSessionInterruption(const String&);
542     void endMediaSessionInterruption(const String&);
543     void applicationWillBecomeInactive();
544     void applicationDidBecomeActive();
545     void applicationWillEnterForeground(bool suspendedUnderLock) const;
546     void applicationDidEnterBackground(bool suspendedUnderLock) const;
547     ExceptionOr<void> setMediaSessionRestrictions(const String& mediaType, StringView restrictionsString);
548     ExceptionOr<String> mediaSessionRestrictions(const String& mediaType) const;
549     void setMediaElementRestrictions(HTMLMediaElement&, StringView restrictionsString);
550     ExceptionOr<void> postRemoteControlCommand(const String&, float argument);
551     bool elementIsBlockingDisplaySleep(HTMLMediaElement&) const;
552 #endif
553
554 #if ENABLE(MEDIA_SESSION)
555     void sendMediaSessionStartOfInterruptionNotification(MediaSessionInterruptingCategory);
556     void sendMediaSessionEndOfInterruptionNotification(MediaSessionInterruptingCategory);
557     String mediaSessionCurrentState(MediaSession&) const;
558     double mediaElementPlayerVolume(HTMLMediaElement&) const;
559     enum class MediaControlEvent { PlayPause, NextTrack, PreviousTrack };
560     void sendMediaControlEvent(MediaControlEvent);
561 #endif
562
563 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
564     void setMockMediaPlaybackTargetPickerEnabled(bool);
565     ExceptionOr<void> setMockMediaPlaybackTargetPickerState(const String& deviceName, const String& deviceState);
566 #endif
567
568 #if ENABLE(WEB_AUDIO)
569     void setAudioContextRestrictions(AudioContext&, StringView restrictionsString);
570 #endif
571
572     void simulateSystemSleep() const;
573     void simulateSystemWake() const;
574
575     enum class PageOverlayType { View, Document };
576     ExceptionOr<Ref<MockPageOverlay>> installMockPageOverlay(PageOverlayType);
577     ExceptionOr<String> pageOverlayLayerTreeAsText(unsigned short flags) const;
578
579     void setPageMuted(StringView);
580     String pageMediaState();
581
582     void setPageDefersLoading(bool);
583     ExceptionOr<bool> pageDefersLoading();
584
585     RefPtr<File> createFile(const String&);
586     void queueMicroTask(int);
587     bool testPreloaderSettingViewport();
588
589 #if ENABLE(CONTENT_FILTERING)
590     MockContentFilterSettings& mockContentFilterSettings();
591 #endif
592
593 #if ENABLE(CSS_SCROLL_SNAP)
594     ExceptionOr<String> scrollSnapOffsets(Element&);
595     void setPlatformMomentumScrollingPredictionEnabled(bool);
596 #endif
597
598     ExceptionOr<String> pathStringWithShrinkWrappedRects(const Vector<double>& rectComponents, double radius);
599
600     String getCurrentMediaControlsStatusForElement(HTMLMediaElement&);
601
602     String userVisibleString(const DOMURL&);
603     void setShowAllPlugins(bool);
604
605     String resourceLoadStatisticsForOrigin(const String& origin);
606     void setResourceLoadStatisticsEnabled(bool);
607     void setUserGrantsStorageAccess(bool);
608
609 #if ENABLE(STREAMS_API)
610     bool isReadableStreamDisturbed(JSC::ExecState&, JSC::JSValue);
611     JSC::JSValue cloneArrayBuffer(JSC::ExecState&, JSC::JSValue, JSC::JSValue, JSC::JSValue);
612 #endif
613
614     String composedTreeAsText(Node&);
615
616     bool isProcessingUserGesture();
617     double lastHandledUserGestureTimestamp();
618
619     void withUserGesture(RefPtr<VoidCallback>&&);
620
621     RefPtr<GCObservation> observeGC(JSC::JSValue);
622
623     enum class UserInterfaceLayoutDirection : uint8_t { LTR, RTL };
624     void setUserInterfaceLayoutDirection(UserInterfaceLayoutDirection);
625
626     bool userPrefersReducedMotion() const;
627
628     void reportBacktrace();
629
630     enum class BaseWritingDirection { Natural, Ltr, Rtl };
631     void setBaseWritingDirection(BaseWritingDirection);
632
633 #if ENABLE(POINTER_LOCK)
634     bool pageHasPendingPointerLock() const;
635     bool pageHasPointerLock() const;
636 #endif
637
638     Vector<String> accessKeyModifiers() const;
639
640     void setQuickLookPassword(const String&);
641
642     void setAsRunningUserScripts(Document&);
643
644 #if ENABLE(WEBGL)
645     void simulateWebGLContextChanged(WebGLRenderingContext&);
646     void failNextGPUStatusCheck(WebGLRenderingContext&);
647 #endif
648
649     void setPageVisibility(bool isVisible);
650     void setPageIsFocusedAndActive(bool);
651
652
653 #if ENABLE(WEB_RTC)
654     void setH264HardwareEncoderAllowed(bool allowed);
655 #endif
656
657 #if ENABLE(MEDIA_STREAM)
658     void setCameraMediaStreamTrackOrientation(MediaStreamTrack&, int orientation);
659     ExceptionOr<void> setMediaDeviceState(const String& id, const String& property, bool value);
660     unsigned long trackAudioSampleCount() const { return m_trackAudioSampleCount; }
661     unsigned long trackVideoSampleCount() const { return m_trackVideoSampleCount; }
662     void observeMediaStreamTrack(MediaStreamTrack&);
663     using TrackFramePromise = DOMPromiseDeferred<IDLInterface<ImageData>>;
664     void grabNextMediaStreamTrackFrame(TrackFramePromise&&);
665     void delayMediaStreamTrackSamples(MediaStreamTrack&, float);
666     void setMediaStreamTrackMuted(MediaStreamTrack&, bool);
667     void removeMediaStreamTrack(MediaStream&, MediaStreamTrack&);
668     void simulateMediaStreamTrackCaptureSourceFailure(MediaStreamTrack&);
669     void setMediaStreamTrackIdentifier(MediaStreamTrack&, String&& id);
670 #endif
671
672     String audioSessionCategory() const;
673     double preferredAudioBufferSize() const;
674
675     void clearCacheStorageMemoryRepresentation(DOMPromiseDeferred<void>&&);
676     void cacheStorageEngineRepresentation(DOMPromiseDeferred<IDLDOMString>&&);
677     void setResponseSizeWithPadding(FetchResponse&, uint64_t size);
678     uint64_t responseSizeWithPadding(FetchResponse&) const;
679
680     void setConsoleMessageListener(RefPtr<StringCallback>&&);
681
682 #if ENABLE(SERVICE_WORKER)
683     using HasRegistrationPromise = DOMPromiseDeferred<IDLBoolean>;
684     void hasServiceWorkerRegistration(const String& clientURL, HasRegistrationPromise&&);
685     void terminateServiceWorker(ServiceWorker&);
686     bool hasServiceWorkerConnection();
687 #endif
688
689 #if ENABLE(APPLE_PAY)
690     MockPaymentCoordinator& mockPaymentCoordinator() const;
691 #endif
692
693     String timelineDescription(AnimationTimeline&);
694     void pauseTimeline(AnimationTimeline&);
695     void setTimelineCurrentTime(AnimationTimeline&, double);
696
697     void testIncomingSyncIPCMessageWhileWaitingForSyncReply();
698
699 #if ENABLE(WEB_AUTHN)
700     MockAuthenticatorCoordinator& mockAuthenticatorCoordinator() const;
701 #endif
702
703     bool isSystemPreviewLink(Element&) const;
704     bool isSystemPreviewImage(Element&) const;
705
706     bool usingAppleInternalSDK() const;
707
708     struct NowPlayingState {
709         String title;
710         double duration;
711         double elapsedTime;
712         uint64_t uniqueIdentifier;
713         bool hasActiveSession;
714         bool registeredAsNowPlayingApplication;
715     };
716     ExceptionOr<NowPlayingState> nowPlayingState() const;
717
718 #if ENABLE(VIDEO)
719     using PlaybackControlsPurpose = MediaElementSession::PlaybackControlsPurpose;
720     RefPtr<HTMLMediaElement> bestMediaElementForShowingPlaybackControlsManager(PlaybackControlsPurpose);
721
722     using MediaSessionState = PlatformMediaSession::State;
723     MediaSessionState mediaSessionState(HTMLMediaElement&);
724 #endif
725
726     void setCaptureExtraNetworkLoadMetricsEnabled(bool);
727     String ongoingLoadsDescriptions() const;
728
729     void reloadWithoutContentExtensions();
730
731     void setUseSystemAppearance(bool);
732
733     size_t pluginCount();
734
735     void notifyResourceLoadObserver();
736
737     unsigned primaryScreenDisplayID();
738         
739 private:
740     explicit Internals(Document&);
741     Document* contextDocument() const;
742     Frame* frame() const;
743
744     ExceptionOr<RenderedDocumentMarker*> markerAt(Node&, const String& markerType, unsigned index);
745
746     // RealtimeMediaSource::Observer API
747 #if ENABLE(MEDIA_STREAM)
748     void videoSampleAvailable(MediaSample&) final;
749     void audioSamplesAvailable(const MediaTime&, const PlatformAudioData&, const AudioStreamDescription&, size_t) final { m_trackAudioSampleCount++; }
750
751     OrientationNotifier m_orientationNotifier;
752     unsigned long m_trackVideoSampleCount { 0 };
753     unsigned long m_trackAudioSampleCount { 0 };
754     RefPtr<MediaStreamTrack> m_track;
755     std::optional<TrackFramePromise> m_nextTrackFramePromise;
756 #endif
757
758     std::unique_ptr<InspectorStubFrontend> m_inspectorFrontend;
759     RefPtr<CacheStorageConnection> m_cacheStorageConnection;
760
761 #if ENABLE(APPLE_PAY)
762     MockPaymentCoordinator* m_mockPaymentCoordinator { nullptr };
763 #endif
764
765 #if ENABLE(WEB_AUTHN)
766     WeakPtr<MockAuthenticatorCoordinator> m_mockAuthenticatorCoordinator;
767 #endif
768 };
769
770 } // namespace WebCore