1bde7675a760df6faa6174dcc23ec5d46e78bae8
[WebKit-https.git] / Source / WebCore / testing / Internals.h
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 #pragma once
28
29 #include "CSSComputedStyleDeclaration.h"
30 #include "ContextDestructionObserver.h"
31 #include "PageConsoleClient.h"
32 #include <runtime/Float32Array.h>
33
34 #if ENABLE(MEDIA_SESSION)
35 #include "MediaSessionInterruptionProvider.h"
36 #endif
37
38 namespace WebCore {
39
40 class AudioContext;
41 class ClientRect;
42 class ClientRectList;
43 class DOMURL;
44 class DOMWindow;
45 class Document;
46 class Element;
47 class File;
48 class Frame;
49 class HTMLImageElement;
50 class HTMLInputElement;
51 class HTMLLinkElement;
52 class HTMLMediaElement;
53 class HTMLSelectElement;
54 class InspectorStubFrontend;
55 class InternalSettings;
56 class MallocStatistics;
57 class MediaSession;
58 class MemoryInfo;
59 class MockContentFilterSettings;
60 class MockPageOverlay;
61 class NodeList;
62 class Page;
63 class Range;
64 class RenderedDocumentMarker;
65 class SerializedScriptValue;
66 class SourceBuffer;
67 class TimeRanges;
68 class TypeConversions;
69 class XMLHttpRequest;
70
71 typedef int ExceptionCode;
72
73 enum class InternalsAutoFillButtonType { AutoFillButtonTypeNone, AutoFillButtonTypeContacts, AutoFillButtonTypeCredentials };
74 enum class InternalsCachePolicy { UseProtocolCachePolicy, ReloadIgnoringCacheData, ReturnCacheDataElseLoad, ReturnCacheDataDontLoad };
75 enum class InternalsResourceLoadPriority { ResourceLoadPriorityVeryLow, ResourceLoadPriorityLow, ResourceLoadPriorityMedium, ResourceLoadPriorityHigh, ResourceLoadPriorityVeryHigh };
76 enum class MediaControlEvent { PlayPause, NextTrack, PreviousTrack };
77 enum class PageOverlayType { View, Document };
78
79 class Internals final : public RefCounted<Internals>, private ContextDestructionObserver {
80 public:
81     static Ref<Internals> create(Document&);
82     virtual ~Internals();
83
84     static void resetToConsistentState(Page&);
85
86     String elementRenderTreeAsText(Element&, ExceptionCode&);
87     bool hasPausedImageAnimations(Element&);
88
89     String address(Node&);
90     bool nodeNeedsStyleRecalc(Node&);
91     String styleChangeType(Node&);
92     String description(JSC::JSValue);
93
94     bool isPreloaded(const String& url);
95     bool isLoadingFromMemoryCache(const String& url);
96     String xhrResponseSource(XMLHttpRequest&);
97     bool isSharingStyleSheetContents(HTMLLinkElement&, HTMLLinkElement&);
98     bool isStyleSheetLoadingSubresources(HTMLLinkElement&);
99     void setOverrideCachePolicy(InternalsCachePolicy);
100     void setCanShowModalDialogOverride(bool allow, ExceptionCode&);
101     void setOverrideResourceLoadPriority(InternalsResourceLoadPriority);
102     void setStrictRawResourceValidationPolicyDisabled(bool);
103
104     void clearMemoryCache();
105     void pruneMemoryCacheToSize(unsigned size);
106     unsigned memoryCacheSize() const;
107
108     unsigned imageFrameIndex(HTMLImageElement&);
109
110     void clearPageCache();
111     unsigned pageCacheSize() const;
112
113     RefPtr<CSSComputedStyleDeclaration> computedStyleIncludingVisitedInfo(Node&) const;
114
115     Node* ensureShadowRoot(Element& host, ExceptionCode&);
116     Node* ensureUserAgentShadowRoot(Element& host);
117     Node* createShadowRoot(Element& host, ExceptionCode&);
118     Node* shadowRoot(Element& host);
119     String shadowRootType(const Node&, ExceptionCode&) const;
120     String shadowPseudoId(Element&);
121     void setShadowPseudoId(Element&, const String&);
122
123     // DOMTimers throttling testing.
124     bool isTimerThrottled(int timeoutId, ExceptionCode&);
125     bool isRequestAnimationFrameThrottled() const;
126     bool areTimersThrottled() const;
127
128     // Spatial Navigation testing.
129     unsigned lastSpatialNavigationCandidateCount(ExceptionCode&) const;
130
131     // CSS Animation testing.
132     unsigned numberOfActiveAnimations() const;
133     bool animationsAreSuspended(ExceptionCode&) const;
134     void suspendAnimations(ExceptionCode&) const;
135     void resumeAnimations(ExceptionCode&) const;
136     bool pauseAnimationAtTimeOnElement(const String& animationName, double pauseTime, Element&, ExceptionCode&);
137     bool pauseAnimationAtTimeOnPseudoElement(const String& animationName, double pauseTime, Element&, const String& pseudoId, ExceptionCode&);
138
139     // CSS Transition testing.
140     bool pauseTransitionAtTimeOnElement(const String& propertyName, double pauseTime, Element&, ExceptionCode&);
141     bool pauseTransitionAtTimeOnPseudoElement(const String& property, double pauseTime, Element&, const String& pseudoId, ExceptionCode&);
142
143     Node* treeScopeRootNode(Node&);
144     Node* parentTreeScope(Node&);
145
146     String visiblePlaceholder(Element&);
147     void selectColorInColorChooser(HTMLInputElement&, const String& colorValue);
148     Vector<String> formControlStateOfPreviousHistoryItem(ExceptionCode&);
149     void setFormControlStateOfPreviousHistoryItem(const Vector<String>&, ExceptionCode&);
150
151     Ref<ClientRect> absoluteCaretBounds(ExceptionCode&);
152
153     Ref<ClientRect> boundingBox(Element&);
154
155     Ref<ClientRectList> inspectorHighlightRects(ExceptionCode&);
156     String inspectorHighlightObject(ExceptionCode&);
157
158     unsigned markerCountForNode(Node&, const String&, ExceptionCode&);
159     RefPtr<Range> markerRangeForNode(Node&, const String& markerType, unsigned index, ExceptionCode&);
160     String markerDescriptionForNode(Node&, const String& markerType, unsigned index, ExceptionCode&);
161     String dumpMarkerRects(const String& markerType, ExceptionCode&);
162     void addTextMatchMarker(const Range&, bool isActive);
163     void setMarkedTextMatchesAreHighlighted(bool, ExceptionCode&);
164
165     void invalidateFontCache();
166
167     void setScrollViewPosition(int x, int y, ExceptionCode&);
168     void setViewBaseBackgroundColor(const String& colorValue, ExceptionCode&);
169
170     void setPagination(const String& mode, int gap, int pageLength, ExceptionCode&);
171     void setPaginationLineGridEnabled(bool, ExceptionCode&);
172     String configurationForViewport(float devicePixelRatio, int deviceWidth, int deviceHeight, int availableWidth, int availableHeight, ExceptionCode&);
173
174     bool wasLastChangeUserEdit(Element& textField, ExceptionCode&);
175     bool elementShouldAutoComplete(HTMLInputElement&);
176     void setEditingValue(HTMLInputElement&, const String&);
177     void setAutofilled(HTMLInputElement&, bool enabled);
178     void setShowAutoFillButton(HTMLInputElement&, InternalsAutoFillButtonType);
179     void scrollElementToRect(Element&, int x, int y, int w, int h, ExceptionCode&);
180
181     String autofillFieldName(Element&, ExceptionCode&);
182
183     void paintControlTints(ExceptionCode&);
184
185     RefPtr<Range> rangeFromLocationAndLength(Element& scope, int rangeLocation, int rangeLength);
186     unsigned locationFromRange(Element& scope, const Range&);
187     unsigned lengthFromRange(Element& scope, const Range&);
188     String rangeAsText(const Range&);
189     RefPtr<Range> subrange(Range&, int rangeLocation, int rangeLength);
190     RefPtr<Range> rangeForDictionaryLookupAtLocation(int x, int y, ExceptionCode&);
191
192     void setDelegatesScrolling(bool enabled, ExceptionCode&);
193
194     int lastSpellCheckRequestSequence(ExceptionCode&);
195     int lastSpellCheckProcessedSequence(ExceptionCode&);
196
197     Vector<String> userPreferredLanguages() const;
198     void setUserPreferredLanguages(const Vector<String>&);
199
200     Vector<String> userPreferredAudioCharacteristics() const;
201     void setUserPreferredAudioCharacteristic(const String&);
202
203     unsigned wheelEventHandlerCount(ExceptionCode&);
204     unsigned touchEventHandlerCount(ExceptionCode&);
205
206     RefPtr<NodeList> nodesFromRect(Document&, int x, int y, unsigned topPadding, unsigned rightPadding,
207         unsigned bottomPadding, unsigned leftPadding, bool ignoreClipping, bool allowShadowContent, bool allowChildFrameContent, ExceptionCode&) const;
208
209     String parserMetaData(JSC::JSValue = JSC::JSValue::JSUndefined);
210
211     void updateEditorUINowIfScheduled();
212
213     bool hasSpellingMarker(int from, int length, ExceptionCode&);
214     bool hasGrammarMarker(int from, int length, ExceptionCode&);
215     bool hasAutocorrectedMarker(int from, int length, ExceptionCode&);
216     void setContinuousSpellCheckingEnabled(bool enabled, ExceptionCode&);
217     void setAutomaticQuoteSubstitutionEnabled(bool enabled, ExceptionCode&);
218     void setAutomaticLinkDetectionEnabled(bool enabled, ExceptionCode&);
219     void setAutomaticDashSubstitutionEnabled(bool enabled, ExceptionCode&);
220     void setAutomaticTextReplacementEnabled(bool enabled, ExceptionCode&);
221     void setAutomaticSpellingCorrectionEnabled(bool enabled, ExceptionCode&);
222
223     void handleAcceptedCandidate(const String& candidate, ExceptionCode&);
224
225     bool isOverwriteModeEnabled(ExceptionCode&);
226     void toggleOverwriteModeEnabled(ExceptionCode&);
227
228     unsigned countMatchesForText(const String&, unsigned findOptions, const String& markMatches, ExceptionCode&);
229
230     unsigned numberOfScrollableAreas(ExceptionCode&);
231
232     bool isPageBoxVisible(int pageNumber, ExceptionCode&);
233
234     static const char* internalsId;
235
236     InternalSettings* settings() const;
237     unsigned workerThreadCount() const;
238
239     void setBatteryStatus(const String& eventType, bool charging, double chargingTime, double dischargingTime, double level, ExceptionCode&);
240
241     void setDeviceProximity(const String& eventType, double value, double min, double max, ExceptionCode&);
242
243     enum {
244         // Values need to be kept in sync with Internals.idl.
245         LAYER_TREE_INCLUDES_VISIBLE_RECTS = 1,
246         LAYER_TREE_INCLUDES_TILE_CACHES = 2,
247         LAYER_TREE_INCLUDES_REPAINT_RECTS = 4,
248         LAYER_TREE_INCLUDES_PAINTING_PHASES = 8,
249         LAYER_TREE_INCLUDES_CONTENT_LAYERS = 16
250     };
251     String layerTreeAsText(Document&, unsigned short flags, ExceptionCode&) const;
252     String repaintRectsAsText(ExceptionCode&) const;
253     String scrollingStateTreeAsText(ExceptionCode&) const;
254     String mainThreadScrollingReasons(ExceptionCode&) const;
255     RefPtr<ClientRectList> nonFastScrollableRects(ExceptionCode&) const;
256
257     void setElementUsesDisplayListDrawing(Element&, bool usesDisplayListDrawing, ExceptionCode&);
258     void setElementTracksDisplayListReplay(Element&, bool isTrackingReplay, ExceptionCode&);
259
260     enum {
261         // Values need to be kept in sync with Internals.idl.
262         DISPLAY_LIST_INCLUDES_PLATFORM_OPERATIONS = 1,
263     };
264     String displayListForElement(Element&, unsigned short flags, ExceptionCode&);
265
266     String replayDisplayListForElement(Element&, unsigned short flags, ExceptionCode&);
267
268     void garbageCollectDocumentResources(ExceptionCode&) const;
269
270     void insertAuthorCSS(const String&, ExceptionCode&) const;
271     void insertUserCSS(const String&, ExceptionCode&) const;
272
273     const ProfilesArray& consoleProfiles() const;
274
275     unsigned numberOfLiveNodes() const;
276     unsigned numberOfLiveDocuments() const;
277
278     RefPtr<DOMWindow> openDummyInspectorFrontend(const String& url);
279     void closeDummyInspectorFrontend();
280     void setLegacyJavaScriptProfilingEnabled(bool enabled, ExceptionCode&);
281     void setInspectorIsUnderTest(bool isUnderTest, ExceptionCode&);
282
283     String counterValue(Element&);
284
285     int pageNumber(Element&, float pageWidth = 800, float pageHeight = 600);
286     Vector<String> shortcutIconURLs() const;
287
288     int numberOfPages(float pageWidthInPixels = 800, float pageHeightInPixels = 600);
289     String pageProperty(String, int, ExceptionCode&) const;
290     String pageSizeAndMarginsInPixels(int, int, int, int, int, int, int, ExceptionCode&) const;
291
292     void setPageScaleFactor(float scaleFactor, int x, int y, ExceptionCode&);
293     void setPageZoomFactor(float zoomFactor, ExceptionCode&);
294     void setTextZoomFactor(float zoomFactor, ExceptionCode&);
295
296     void setUseFixedLayout(bool useFixedLayout, ExceptionCode&);
297     void setFixedLayoutSize(int width, int height, ExceptionCode&);
298     void setViewExposedRect(float left, float top, float width, float height, ExceptionCode&);
299
300     void setHeaderHeight(float);
301     void setFooterHeight(float);
302
303     void setTopContentInset(float);
304
305 #if ENABLE(FULLSCREEN_API)
306     void webkitWillEnterFullScreenForElement(Element&);
307     void webkitDidEnterFullScreenForElement(Element&);
308     void webkitWillExitFullScreenForElement(Element&);
309     void webkitDidExitFullScreenForElement(Element&);
310 #endif
311
312     WEBCORE_TESTSUPPORT_EXPORT void setApplicationCacheOriginQuota(unsigned long long);
313
314     void registerURLSchemeAsBypassingContentSecurityPolicy(const String& scheme);
315     void removeURLSchemeRegisteredAsBypassingContentSecurityPolicy(const String& scheme);
316
317     Ref<MallocStatistics> mallocStatistics() const;
318     Ref<TypeConversions> typeConversions() const;
319     Ref<MemoryInfo> memoryInfo() const;
320
321     Vector<String> getReferencedFilePaths() const;
322
323     void startTrackingRepaints(ExceptionCode&);
324     void stopTrackingRepaints(ExceptionCode&);
325
326     void startTrackingLayerFlushes(ExceptionCode&);
327     unsigned layerFlushCount(ExceptionCode&);
328     
329     void startTrackingStyleRecalcs(ExceptionCode&);
330     unsigned styleRecalcCount(ExceptionCode&);
331
332     void startTrackingCompositingUpdates(ExceptionCode&);
333     unsigned compositingUpdateCount(ExceptionCode&);
334
335     void updateLayoutIgnorePendingStylesheetsAndRunPostLayoutTasks(Node*, ExceptionCode&);
336     unsigned layoutCount() const;
337
338     RefPtr<ArrayBuffer> serializeObject(PassRefPtr<SerializedScriptValue>) const;
339     RefPtr<SerializedScriptValue> deserializeBuffer(ArrayBuffer&) const;
340
341     bool isFromCurrentWorld(JSC::JSValue) const;
342
343     void setUsesOverlayScrollbars(bool);
344     void setUsesMockScrollAnimator(bool);
345
346     String getCurrentCursorInfo(ExceptionCode&);
347
348     String markerTextForListItem(Element&);
349
350     String toolTipFromElement(Element&) const;
351
352     void forceReload(bool endToEnd);
353
354     void enableAutoSizeMode(bool enabled, int minimumWidth, int minimumHeight, int maximumWidth, int maximumHeight);
355
356 #if ENABLE(ENCRYPTED_MEDIA_V2)
357     void initializeMockCDM();
358 #endif
359
360 #if ENABLE(SPEECH_SYNTHESIS)
361     void enableMockSpeechSynthesizer();
362 #endif
363
364 #if ENABLE(MEDIA_STREAM)
365     void setMockMediaCaptureDevicesEnabled(bool);
366 #endif
367
368 #if ENABLE(WEB_RTC)
369     void enableMockMediaEndpoint();
370     void enableMockRTCPeerConnectionHandler();
371 #endif
372
373     String getImageSourceURL(Element&);
374
375 #if ENABLE(VIDEO)
376     void simulateAudioInterruption(HTMLMediaElement&);
377     bool mediaElementHasCharacteristic(HTMLMediaElement&, const String&, ExceptionCode&);
378 #endif
379
380     bool isSelectPopupVisible(HTMLSelectElement&);
381
382     String captionsStyleSheetOverride(ExceptionCode&);
383     void setCaptionsStyleSheetOverride(const String&, ExceptionCode&);
384     void setPrimaryAudioTrackLanguageOverride(const String&, ExceptionCode&);
385     void setCaptionDisplayMode(const String&, ExceptionCode&);
386
387 #if ENABLE(VIDEO)
388     Ref<TimeRanges> createTimeRanges(Float32Array* startTimes, Float32Array* endTimes);
389     double closestTimeToTimeRanges(double time, TimeRanges&);
390 #endif
391
392     Ref<ClientRect> selectionBounds(ExceptionCode&);
393
394 #if ENABLE(VIBRATION)
395     bool isVibrating();
396 #endif
397
398     bool isPluginUnavailabilityIndicatorObscured(Element&, ExceptionCode&);
399     bool isPluginSnapshotted(Element&);
400
401 #if ENABLE(MEDIA_SOURCE)
402     WEBCORE_TESTSUPPORT_EXPORT void initializeMockMediaSource();
403     Vector<String> bufferedSamplesForTrackID(SourceBuffer&, const AtomicString&);
404     void setShouldGenerateTimestamps(SourceBuffer&, bool);
405 #endif
406
407 #if ENABLE(VIDEO)
408     void beginMediaSessionInterruption(const String&, ExceptionCode&);
409     void endMediaSessionInterruption(const String&);
410     void applicationDidEnterForeground() const;
411     void applicationWillEnterBackground() const;
412     void setMediaSessionRestrictions(const String& mediaType, const String& restrictions, ExceptionCode&);
413     void setMediaElementRestrictions(HTMLMediaElement&, const String& restrictions);
414     void postRemoteControlCommand(const String&, ExceptionCode&);
415     bool elementIsBlockingDisplaySleep(HTMLMediaElement&) const;
416 #endif
417
418 #if ENABLE(MEDIA_SESSION)
419     void sendMediaSessionStartOfInterruptionNotification(MediaSessionInterruptingCategory);
420     void sendMediaSessionEndOfInterruptionNotification(MediaSessionInterruptingCategory);
421     String mediaSessionCurrentState(MediaSession&) const;
422     double mediaElementPlayerVolume(HTMLMediaElement&) const;
423     void sendMediaControlEvent(MediaControlEvent);
424 #endif
425
426 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
427     void setMockMediaPlaybackTargetPickerEnabled(bool);
428     void setMockMediaPlaybackTargetPickerState(const String& deviceName, const String& deviceState, ExceptionCode&);
429 #endif
430
431 #if ENABLE(WEB_AUDIO)
432     void setAudioContextRestrictions(AudioContext&, const String& restrictions);
433 #endif
434
435     void simulateSystemSleep() const;
436     void simulateSystemWake() const;
437
438     RefPtr<MockPageOverlay> installMockPageOverlay(PageOverlayType, ExceptionCode&);
439     String pageOverlayLayerTreeAsText(ExceptionCode&) const;
440
441     void setPageMuted(bool);
442     bool isPagePlayingAudio();
443
444     void setPageDefersLoading(bool);
445
446     RefPtr<File> createFile(const String&);
447     void queueMicroTask(int);
448     bool testPreloaderSettingViewport();
449
450 #if ENABLE(CONTENT_FILTERING)
451     MockContentFilterSettings& mockContentFilterSettings();
452 #endif
453
454 #if ENABLE(CSS_SCROLL_SNAP)
455     String scrollSnapOffsets(Element&, ExceptionCode&);
456 #endif
457
458     String pathStringWithShrinkWrappedRects(Vector<double> rectComponents, double radius, ExceptionCode&);
459
460     String getCurrentMediaControlsStatusForElement(HTMLMediaElement&);
461
462     String userVisibleString(const DOMURL&);
463     void setShowAllPlugins(bool);
464
465     String resourceLoadStatisticsForOrigin(String origin);
466     void setResourceLoadStatisticsEnabled(bool);
467
468 #if ENABLE(STREAMS_API)
469     bool isReadableStreamDisturbed(JSC::ExecState&, JSC::JSValue);
470 #endif
471
472     String composedTreeAsText(Node&);
473     
474     void setViewportForceAlwaysUserScalable(bool);
475     void setLinkPreloadSupport(bool);
476
477 #if ENABLE(CSS_GRID_LAYOUT)
478     void setCSSGridLayoutEnabled(bool);
479 #endif
480
481 private:
482     explicit Internals(Document&);
483     Document* contextDocument() const;
484     Frame* frame() const;
485
486     RenderedDocumentMarker* markerAt(Node&, const String& markerType, unsigned index, ExceptionCode&);
487
488     std::unique_ptr<InspectorStubFrontend> m_inspectorFrontend;
489 };
490
491 } // namespace WebCore