[WebKit on watchOS] Upstream watchOS source additions to OpenSource (Part 3)
[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 MockCredentialsMessenger;
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, StrongConfirmationPassword };
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> paintControlTints();
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     RefPtr<WindowProxy> openDummyInspectorFrontend(const String& url);
368     void closeDummyInspectorFrontend();
369     ExceptionOr<void> setInspectorIsUnderTest(bool);
370
371     String counterValue(Element&);
372
373     int pageNumber(Element&, float pageWidth = 800, float pageHeight = 600);
374     Vector<String> shortcutIconURLs() const;
375
376     int numberOfPages(float pageWidthInPixels = 800, float pageHeightInPixels = 600);
377     ExceptionOr<String> pageProperty(const String& propertyName, int pageNumber) const;
378     ExceptionOr<String> pageSizeAndMarginsInPixels(int pageNumber, int width, int height, int marginTop, int marginRight, int marginBottom, int marginLeft) const;
379
380     ExceptionOr<float> pageScaleFactor() const;
381
382     ExceptionOr<void> setPageScaleFactor(float scaleFactor, int x, int y);
383     ExceptionOr<void> setPageZoomFactor(float);
384     ExceptionOr<void> setTextZoomFactor(float);
385
386     ExceptionOr<void> setUseFixedLayout(bool);
387     ExceptionOr<void> setFixedLayoutSize(int width, int height);
388     ExceptionOr<void> setViewExposedRect(float left, float top, float width, float height);
389     void setPrinting(int width, int height);
390
391     void setHeaderHeight(float);
392     void setFooterHeight(float);
393
394     void setTopContentInset(float);
395
396 #if ENABLE(FULLSCREEN_API)
397     void webkitWillEnterFullScreenForElement(Element&);
398     void webkitDidEnterFullScreenForElement(Element&);
399     void webkitWillExitFullScreenForElement(Element&);
400     void webkitDidExitFullScreenForElement(Element&);
401     bool isAnimatingFullScreen() const;
402 #endif
403
404     void setFullscreenInsetTop(double);
405     void setFullscreenAutoHideDelay(double);
406
407     WEBCORE_TESTSUPPORT_EXPORT void setApplicationCacheOriginQuota(unsigned long long);
408
409     void registerURLSchemeAsBypassingContentSecurityPolicy(const String& scheme);
410     void removeURLSchemeRegisteredAsBypassingContentSecurityPolicy(const String& scheme);
411
412     void registerDefaultPortForProtocol(unsigned short port, const String& protocol);
413
414     Ref<MallocStatistics> mallocStatistics() const;
415     Ref<TypeConversions> typeConversions() const;
416     Ref<MemoryInfo> memoryInfo() const;
417
418     Vector<String> getReferencedFilePaths() const;
419
420     ExceptionOr<void> startTrackingRepaints();
421     ExceptionOr<void> stopTrackingRepaints();
422
423     ExceptionOr<void> startTrackingLayerFlushes();
424     ExceptionOr<unsigned> layerFlushCount();
425
426     ExceptionOr<void> startTrackingStyleRecalcs();
427     ExceptionOr<unsigned> styleRecalcCount();
428     unsigned lastStyleUpdateSize() const;
429
430     ExceptionOr<void> startTrackingCompositingUpdates();
431     ExceptionOr<unsigned> compositingUpdateCount();
432
433     ExceptionOr<void> updateLayoutIgnorePendingStylesheetsAndRunPostLayoutTasks(Node*);
434     unsigned layoutCount() const;
435
436     Ref<ArrayBuffer> serializeObject(const RefPtr<SerializedScriptValue>&) const;
437     Ref<SerializedScriptValue> deserializeBuffer(ArrayBuffer&) const;
438
439     bool isFromCurrentWorld(JSC::JSValue) const;
440
441     void setUsesOverlayScrollbars(bool);
442     void setUsesMockScrollAnimator(bool);
443
444     ExceptionOr<String> getCurrentCursorInfo();
445
446     String markerTextForListItem(Element&);
447
448     String toolTipFromElement(Element&) const;
449
450     void forceReload(bool endToEnd);
451     void reloadExpiredOnly();
452
453     void enableAutoSizeMode(bool enabled, int minimumWidth, int minimumHeight, int maximumWidth, int maximumHeight);
454
455 #if ENABLE(LEGACY_ENCRYPTED_MEDIA)
456     void initializeMockCDM();
457 #endif
458
459 #if ENABLE(ENCRYPTED_MEDIA)
460     Ref<MockCDMFactory> registerMockCDM();
461 #endif
462
463 #if ENABLE(SPEECH_SYNTHESIS)
464     void enableMockSpeechSynthesizer();
465 #endif
466
467 #if ENABLE(MEDIA_STREAM)
468     void setMockMediaCaptureDevicesEnabled(bool);
469 #endif
470
471 #if ENABLE(WEB_RTC)
472     void emulateRTCPeerConnectionPlatformEvent(RTCPeerConnection&, const String& action);
473     void useMockRTCPeerConnectionFactory(const String&);
474     void setICECandidateFiltering(bool);
475     void setEnumeratingAllNetworkInterfacesEnabled(bool);
476     void stopPeerConnection(RTCPeerConnection&);
477     void applyRotationForOutgoingVideoSources(RTCPeerConnection&);
478 #endif
479
480     String getImageSourceURL(Element&);
481
482 #if ENABLE(VIDEO)
483     Vector<String> mediaResponseSources(HTMLMediaElement&);
484     Vector<String> mediaResponseContentRanges(HTMLMediaElement&);
485     void simulateAudioInterruption(HTMLMediaElement&);
486     ExceptionOr<bool> mediaElementHasCharacteristic(HTMLMediaElement&, const String&);
487     void beginSimulatedHDCPError(HTMLMediaElement&);
488     void endSimulatedHDCPError(HTMLMediaElement&);
489
490     bool elementShouldBufferData(HTMLMediaElement&);
491 #endif
492
493     bool isSelectPopupVisible(HTMLSelectElement&);
494
495     ExceptionOr<String> captionsStyleSheetOverride();
496     ExceptionOr<void> setCaptionsStyleSheetOverride(const String&);
497     ExceptionOr<void> setPrimaryAudioTrackLanguageOverride(const String&);
498     ExceptionOr<void> setCaptionDisplayMode(const String&);
499
500 #if ENABLE(VIDEO)
501     Ref<TimeRanges> createTimeRanges(Float32Array& startTimes, Float32Array& endTimes);
502     double closestTimeToTimeRanges(double time, TimeRanges&);
503 #endif
504
505     ExceptionOr<Ref<DOMRect>> selectionBounds();
506
507     ExceptionOr<bool> isPluginUnavailabilityIndicatorObscured(Element&);
508     ExceptionOr<String> unavailablePluginReplacementText(Element&);
509     bool isPluginSnapshotted(Element&);
510
511 #if ENABLE(MEDIA_SOURCE)
512     WEBCORE_TESTSUPPORT_EXPORT void initializeMockMediaSource();
513     Vector<String> bufferedSamplesForTrackID(SourceBuffer&, const AtomicString&);
514     Vector<String> enqueuedSamplesForTrackID(SourceBuffer&, const AtomicString&);
515     void setShouldGenerateTimestamps(SourceBuffer&, bool);
516 #endif
517
518 #if ENABLE(VIDEO)
519     ExceptionOr<void> beginMediaSessionInterruption(const String&);
520     void endMediaSessionInterruption(const String&);
521     void applicationWillBecomeInactive();
522     void applicationDidBecomeActive();
523     void applicationWillEnterForeground(bool suspendedUnderLock) const;
524     void applicationDidEnterBackground(bool suspendedUnderLock) const;
525     ExceptionOr<void> setMediaSessionRestrictions(const String& mediaType, StringView restrictionsString);
526     ExceptionOr<String> mediaSessionRestrictions(const String& mediaType) const;
527     void setMediaElementRestrictions(HTMLMediaElement&, StringView restrictionsString);
528     ExceptionOr<void> postRemoteControlCommand(const String&, float argument);
529     bool elementIsBlockingDisplaySleep(HTMLMediaElement&) const;
530 #endif
531
532 #if ENABLE(MEDIA_SESSION)
533     void sendMediaSessionStartOfInterruptionNotification(MediaSessionInterruptingCategory);
534     void sendMediaSessionEndOfInterruptionNotification(MediaSessionInterruptingCategory);
535     String mediaSessionCurrentState(MediaSession&) const;
536     double mediaElementPlayerVolume(HTMLMediaElement&) const;
537     enum class MediaControlEvent { PlayPause, NextTrack, PreviousTrack };
538     void sendMediaControlEvent(MediaControlEvent);
539 #endif
540
541 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
542     void setMockMediaPlaybackTargetPickerEnabled(bool);
543     ExceptionOr<void> setMockMediaPlaybackTargetPickerState(const String& deviceName, const String& deviceState);
544 #endif
545
546 #if ENABLE(WEB_AUDIO)
547     void setAudioContextRestrictions(AudioContext&, StringView restrictionsString);
548 #endif
549
550     void simulateSystemSleep() const;
551     void simulateSystemWake() const;
552
553     enum class PageOverlayType { View, Document };
554     ExceptionOr<Ref<MockPageOverlay>> installMockPageOverlay(PageOverlayType);
555     ExceptionOr<String> pageOverlayLayerTreeAsText(unsigned short flags) const;
556
557     void setPageMuted(StringView);
558     String pageMediaState();
559
560     void setPageDefersLoading(bool);
561     ExceptionOr<bool> pageDefersLoading();
562
563     RefPtr<File> createFile(const String&);
564     void queueMicroTask(int);
565     bool testPreloaderSettingViewport();
566
567 #if ENABLE(CONTENT_FILTERING)
568     MockContentFilterSettings& mockContentFilterSettings();
569 #endif
570
571 #if ENABLE(CSS_SCROLL_SNAP)
572     ExceptionOr<String> scrollSnapOffsets(Element&);
573     void setPlatformMomentumScrollingPredictionEnabled(bool);
574 #endif
575
576     ExceptionOr<String> pathStringWithShrinkWrappedRects(const Vector<double>& rectComponents, double radius);
577
578     String getCurrentMediaControlsStatusForElement(HTMLMediaElement&);
579
580     String userVisibleString(const DOMURL&);
581     void setShowAllPlugins(bool);
582
583     String resourceLoadStatisticsForOrigin(const String& origin);
584     void setResourceLoadStatisticsEnabled(bool);
585     void setUserGrantsStorageAccess(bool);
586
587 #if ENABLE(STREAMS_API)
588     bool isReadableStreamDisturbed(JSC::ExecState&, JSC::JSValue);
589     JSC::JSValue cloneArrayBuffer(JSC::ExecState&, JSC::JSValue, JSC::JSValue, JSC::JSValue);
590 #endif
591
592     String composedTreeAsText(Node&);
593
594     bool isProcessingUserGesture();
595     double lastHandledUserGestureTimestamp();
596
597     void withUserGesture(RefPtr<VoidCallback>&&);
598
599     RefPtr<GCObservation> observeGC(JSC::JSValue);
600
601     enum class UserInterfaceLayoutDirection { LTR, RTL };
602     void setUserInterfaceLayoutDirection(UserInterfaceLayoutDirection);
603
604     bool userPrefersReducedMotion() const;
605
606     void reportBacktrace();
607
608     enum class BaseWritingDirection { Natural, Ltr, Rtl };
609     void setBaseWritingDirection(BaseWritingDirection);
610
611 #if ENABLE(POINTER_LOCK)
612     bool pageHasPendingPointerLock() const;
613     bool pageHasPointerLock() const;
614 #endif
615
616     Vector<String> accessKeyModifiers() const;
617
618     void setQuickLookPassword(const String&);
619
620     void setAsRunningUserScripts(Document&);
621
622 #if ENABLE(WEBGL)
623     void simulateWebGLContextChanged(WebGLRenderingContext&);
624     void failNextGPUStatusCheck(WebGLRenderingContext&);
625 #endif
626
627     void setPageVisibility(bool isVisible);
628
629 #if ENABLE(WEB_RTC)
630     void setH264HardwareEncoderAllowed(bool allowed);
631 #endif
632
633 #if ENABLE(MEDIA_STREAM)
634     void setCameraMediaStreamTrackOrientation(MediaStreamTrack&, int orientation);
635     ExceptionOr<void> setMediaDeviceState(const String& id, const String& property, bool value);
636     unsigned long trackAudioSampleCount() const { return m_trackAudioSampleCount; }
637     unsigned long trackVideoSampleCount() const { return m_trackVideoSampleCount; }
638     void observeMediaStreamTrack(MediaStreamTrack&);
639     using TrackFramePromise = DOMPromiseDeferred<IDLInterface<ImageData>>;
640     void grabNextMediaStreamTrackFrame(TrackFramePromise&&);
641     void delayMediaStreamTrackSamples(MediaStreamTrack&, float);
642     void setMediaStreamTrackMuted(MediaStreamTrack&, bool);
643     void removeMediaStreamTrack(MediaStream&, MediaStreamTrack&);
644     void simulateMediaStreamTrackCaptureSourceFailure(MediaStreamTrack&);
645     void setMediaStreamTrackIdentifier(MediaStreamTrack&, String&& id);
646 #endif
647
648     String audioSessionCategory() const;
649
650     void clearCacheStorageMemoryRepresentation(DOMPromiseDeferred<void>&&);
651     void cacheStorageEngineRepresentation(DOMPromiseDeferred<IDLDOMString>&&);
652     void setResponseSizeWithPadding(FetchResponse&, uint64_t size);
653     uint64_t responseSizeWithPadding(FetchResponse&) const;
654
655     void setConsoleMessageListener(RefPtr<StringCallback>&&);
656
657 #if ENABLE(SERVICE_WORKER)
658     using HasRegistrationPromise = DOMPromiseDeferred<IDLBoolean>;
659     void hasServiceWorkerRegistration(const String& clientURL, HasRegistrationPromise&&);
660     void terminateServiceWorker(ServiceWorker&);
661     bool hasServiceWorkerConnection();
662 #endif
663
664 #if ENABLE(APPLE_PAY)
665     MockPaymentCoordinator& mockPaymentCoordinator() const;
666 #endif
667
668     String timelineDescription(AnimationTimeline&);
669     void pauseTimeline(AnimationTimeline&);
670     void setTimelineCurrentTime(AnimationTimeline&, double);
671
672     void testIncomingSyncIPCMessageWhileWaitingForSyncReply();
673
674 #if ENABLE(WEB_AUTHN)
675     MockCredentialsMessenger& mockCredentialsMessenger() const;
676 #endif
677
678     String systemPreviewRelType();
679     bool isSystemPreviewLink(Element&) const;
680     bool isSystemPreviewImage(Element&) const;
681
682     bool usingAppleInternalSDK() const;
683
684     struct NowPlayingState {
685         String title;
686         double duration;
687         double elapsedTime;
688         uint64_t uniqueIdentifier;
689         bool hasActiveSession;
690         bool registeredAsNowPlayingApplication;
691     };
692     ExceptionOr<NowPlayingState> nowPlayingState() const;
693
694     using PlaybackControlsPurpose = MediaElementSession::PlaybackControlsPurpose;
695     HTMLMediaElement* bestMediaElementForShowingPlaybackControlsManager(PlaybackControlsPurpose);
696
697 private:
698     explicit Internals(Document&);
699     Document* contextDocument() const;
700     Frame* frame() const;
701
702     ExceptionOr<RenderedDocumentMarker*> markerAt(Node&, const String& markerType, unsigned index);
703
704     // RealtimeMediaSource::Observer API
705 #if ENABLE(MEDIA_STREAM)
706     void videoSampleAvailable(MediaSample&) final;
707     void audioSamplesAvailable(const MediaTime&, const PlatformAudioData&, const AudioStreamDescription&, size_t) final { m_trackAudioSampleCount++; }
708
709     OrientationNotifier m_orientationNotifier;
710     unsigned long m_trackVideoSampleCount { 0 };
711     unsigned long m_trackAudioSampleCount { 0 };
712     RefPtr<MediaStreamTrack> m_track;
713     std::optional<TrackFramePromise> m_nextTrackFramePromise;
714 #endif
715
716     std::unique_ptr<InspectorStubFrontend> m_inspectorFrontend;
717     RefPtr<CacheStorageConnection> m_cacheStorageConnection;
718
719 #if ENABLE(APPLE_PAY)
720     MockPaymentCoordinator* m_mockPaymentCoordinator { nullptr };
721 #endif
722
723 #if ENABLE(WEB_AUTHN)
724     std::unique_ptr<MockCredentialsMessenger> m_mockCredentialsMessenger;
725 #endif
726 };
727
728 } // namespace WebCore