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