Make a way to test display-list drawing
[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 #ifndef Internals_h
28 #define Internals_h
29
30 #include "CSSComputedStyleDeclaration.h"
31 #include "ContextDestructionObserver.h"
32 #include "ExceptionCodePlaceholder.h"
33 #include "NodeList.h"
34 #include "PageConsoleClient.h"
35 #include "ScriptState.h"
36 #include <bindings/ScriptValue.h>
37 #include <runtime/ArrayBuffer.h>
38 #include <runtime/Float32Array.h>
39 #include <wtf/RefCounted.h>
40 #include <wtf/text/WTFString.h>
41
42 namespace WebCore {
43
44 class AudioContext;
45 class ClientRect;
46 class ClientRectList;
47 class DOMPath;
48 class DOMStringList;
49 class DOMURL;
50 class DOMWindow;
51 class Document;
52 class Element;
53 class File;
54 class Frame;
55 class HTMLMediaElement;
56 class InspectorStubFrontend;
57 class InternalSettings;
58 class MallocStatistics;
59 class MediaSession;
60 class MemoryInfo;
61 class MockPageOverlay;
62 class Node;
63 class Page;
64 class Range;
65 class RenderedDocumentMarker;
66 class ScriptExecutionContext;
67 class SerializedScriptValue;
68 class SourceBuffer;
69 class TimeRanges;
70 class TypeConversions;
71 class XMLHttpRequest;
72
73 #if ENABLE(CONTENT_FILTERING)
74 class MockContentFilterSettings;
75 #endif
76
77 typedef int ExceptionCode;
78
79 class Internals : public RefCounted<Internals>
80                 , public ContextDestructionObserver {
81 public:
82     static Ref<Internals> create(Document*);
83     virtual ~Internals();
84
85     static void resetToConsistentState(Page*);
86
87     String elementRenderTreeAsText(Element*, ExceptionCode&);
88     bool hasPausedImageAnimations(Element*, ExceptionCode&);
89
90     String address(Node*);
91     bool nodeNeedsStyleRecalc(Node*, ExceptionCode&);
92     String description(Deprecated::ScriptValue);
93
94     bool isPreloaded(const String& url);
95     bool isLoadingFromMemoryCache(const String& url);
96     String xhrResponseSource(XMLHttpRequest*);
97     bool isSharingStyleSheetContents(Element* linkA, Element* linkB);
98     bool isStyleSheetLoadingSubresources(Element* link);
99     void setOverrideCachePolicy(const String&);
100     void setOverrideResourceLoadPriority(const String&);
101     void setStrictRawResourceValidationPolicyDisabled(bool);
102
103     void clearMemoryCache();
104     void pruneMemoryCacheToSize(unsigned size);
105     unsigned memoryCacheSize() const;
106
107     size_t imageFrameIndex(Element*, ExceptionCode&);
108
109     void clearPageCache();
110     unsigned pageCacheSize() const;
111
112     RefPtr<CSSComputedStyleDeclaration> computedStyleIncludingVisitedInfo(Node*, ExceptionCode&) const;
113
114     Node* ensureShadowRoot(Element* host, ExceptionCode&);
115     Node* ensureUserAgentShadowRoot(Element* host, ExceptionCode&);
116     Node* createShadowRoot(Element* host, ExceptionCode&);
117     Node* shadowRoot(Element* host, ExceptionCode&);
118     String shadowRootType(const Node*, ExceptionCode&) const;
119     Element* includerFor(Node*, ExceptionCode&);
120     String shadowPseudoId(Element*, ExceptionCode&);
121     void setShadowPseudoId(Element*, const String&, ExceptionCode&);
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*, ExceptionCode&);
144     Node* parentTreeScope(Node*, ExceptionCode&);
145
146     bool attached(Node*, ExceptionCode&);
147
148     String visiblePlaceholder(Element*);
149     void selectColorInColorChooser(Element*, const String& colorValue);
150     Vector<String> formControlStateOfPreviousHistoryItem(ExceptionCode&);
151     void setFormControlStateOfPreviousHistoryItem(const Vector<String>&, ExceptionCode&);
152
153     Ref<ClientRect> absoluteCaretBounds(ExceptionCode&);
154
155     Ref<ClientRect> boundingBox(Element*, ExceptionCode&);
156
157     Ref<ClientRectList> inspectorHighlightRects(ExceptionCode&);
158     String inspectorHighlightObject(ExceptionCode&);
159
160     unsigned markerCountForNode(Node*, const String&, ExceptionCode&);
161     RefPtr<Range> markerRangeForNode(Node*, const String& markerType, unsigned index, ExceptionCode&);
162     String markerDescriptionForNode(Node*, const String& markerType, unsigned index, ExceptionCode&);
163     String dumpMarkerRects(const String& markerType, ExceptionCode&);
164     void addTextMatchMarker(const Range*, bool isActive);
165     void setMarkedTextMatchesAreHighlighted(bool, ExceptionCode&);
166
167     void invalidateFontCache();
168
169     void setScrollViewPosition(long x, long y, ExceptionCode&);
170     void setViewBaseBackgroundColor(const String& colorValue, ExceptionCode&);
171
172     void setPagination(const String& mode, int gap, ExceptionCode& ec) { setPagination(mode, gap, 0, ec); }
173     void setPagination(const String& mode, int gap, int pageLength, ExceptionCode&);
174     String configurationForViewport(float devicePixelRatio, int deviceWidth, int deviceHeight, int availableWidth, int availableHeight, ExceptionCode&);
175
176     bool wasLastChangeUserEdit(Element* textField, ExceptionCode&);
177     bool elementShouldAutoComplete(Element* inputElement, ExceptionCode&);
178     void setEditingValue(Element* inputElement, const String&, ExceptionCode&);
179     void setAutofilled(Element*, bool enabled, ExceptionCode&);
180     void setShowAutoFillButton(Element*, bool enabled, ExceptionCode&);
181     void scrollElementToRect(Element*, long x, long y, long w, long h, ExceptionCode&);
182
183     void paintControlTints(ExceptionCode&);
184
185     RefPtr<Range> rangeFromLocationAndLength(Element* scope, int rangeLocation, int rangeLength, ExceptionCode&);
186     unsigned locationFromRange(Element* scope, const Range*, ExceptionCode&);
187     unsigned lengthFromRange(Element* scope, const Range*, ExceptionCode&);
188     String rangeAsText(const Range*, ExceptionCode&);
189     RefPtr<Range> subrange(Range*, int rangeLocation, int rangeLength, ExceptionCode&);
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(Deprecated::ScriptValue = Deprecated::ScriptValue());
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     bool isOverwriteModeEnabled(ExceptionCode&);
224     void toggleOverwriteModeEnabled(ExceptionCode&);
225
226     unsigned countMatchesForText(const String&, unsigned findOptions, const String& markMatches, ExceptionCode&);
227
228     unsigned numberOfScrollableAreas(ExceptionCode&);
229
230     bool isPageBoxVisible(int pageNumber, ExceptionCode&);
231
232     static const char* internalsId;
233
234     InternalSettings* settings() const;
235     unsigned workerThreadCount() const;
236
237     void setBatteryStatus(const String& eventType, bool charging, double chargingTime, double dischargingTime, double level, ExceptionCode&);
238
239     void setDeviceProximity(const String& eventType, double value, double min, double max, ExceptionCode&);
240
241     enum {
242         // Values need to be kept in sync with Internals.idl.
243         LAYER_TREE_INCLUDES_VISIBLE_RECTS = 1,
244         LAYER_TREE_INCLUDES_TILE_CACHES = 2,
245         LAYER_TREE_INCLUDES_REPAINT_RECTS = 4,
246         LAYER_TREE_INCLUDES_PAINTING_PHASES = 8,
247         LAYER_TREE_INCLUDES_CONTENT_LAYERS = 16
248     };
249     String layerTreeAsText(Document*, unsigned flags, ExceptionCode&) const;
250     String layerTreeAsText(Document*, ExceptionCode&) const;
251     String repaintRectsAsText(ExceptionCode&) const;
252     String scrollingStateTreeAsText(ExceptionCode&) const;
253     String mainThreadScrollingReasons(ExceptionCode&) const;
254     RefPtr<ClientRectList> nonFastScrollableRects(ExceptionCode&) const;
255
256     void setElementUsesDisplayListDrawing(Element*, bool usesDisplayListDrawing, ExceptionCode&);
257
258     enum {
259         // Values need to be kept in sync with Internals.idl.
260         DISPLAY_LIST_INCLUDES_PLATFORM_OPERATIONS = 1,
261     };
262     String displayListForElement(Element*, unsigned flags, ExceptionCode&);
263     String displayListForElement(Element*, ExceptionCode&);
264
265     void garbageCollectDocumentResources(ExceptionCode&) const;
266
267     void allowRoundingHacks() const;
268
269     void insertAuthorCSS(const String&, ExceptionCode&) const;
270     void insertUserCSS(const String&, ExceptionCode&) const;
271
272     const ProfilesArray& consoleProfiles() const;
273
274     unsigned numberOfLiveNodes() const;
275     unsigned numberOfLiveDocuments() const;
276
277     RefPtr<DOMWindow> openDummyInspectorFrontend(const String& url);
278     void closeDummyInspectorFrontend();
279     void setJavaScriptProfilingEnabled(bool enabled, ExceptionCode&);
280     void setInspectorIsUnderTest(bool isUnderTest, ExceptionCode&);
281
282     String counterValue(Element*);
283
284     int pageNumber(Element*, float pageWidth = 800, float pageHeight = 600);
285     Vector<String> shortcutIconURLs() const;
286
287     int numberOfPages(float pageWidthInPixels = 800, float pageHeightInPixels = 600);
288     String pageProperty(String, int, ExceptionCode& = ASSERT_NO_EXCEPTION) const;
289     String pageSizeAndMarginsInPixels(int, int, int, int, int, int, int, ExceptionCode& = ASSERT_NO_EXCEPTION) const;
290
291     void setPageScaleFactor(float scaleFactor, int x, int y, ExceptionCode&);
292     void setPageZoomFactor(float zoomFactor, ExceptionCode&);
293     void setTextZoomFactor(float zoomFactor, ExceptionCode&);
294
295     void setUseFixedLayout(bool useFixedLayout, ExceptionCode&);
296     void setFixedLayoutSize(int width, int height, ExceptionCode&);
297
298     void setHeaderHeight(float);
299     void setFooterHeight(float);
300
301     void setTopContentInset(float);
302
303 #if ENABLE(FULLSCREEN_API)
304     void webkitWillEnterFullScreenForElement(Element*);
305     void webkitDidEnterFullScreenForElement(Element*);
306     void webkitWillExitFullScreenForElement(Element*);
307     void webkitDidExitFullScreenForElement(Element*);
308 #endif
309
310     WEBCORE_TESTSUPPORT_EXPORT void setApplicationCacheOriginQuota(unsigned long long);
311
312     void registerURLSchemeAsBypassingContentSecurityPolicy(const String& scheme);
313     void removeURLSchemeRegisteredAsBypassingContentSecurityPolicy(const String& scheme);
314
315     Ref<MallocStatistics> mallocStatistics() const;
316     Ref<TypeConversions> typeConversions() const;
317     Ref<MemoryInfo> memoryInfo() const;
318
319     Vector<String> getReferencedFilePaths() const;
320
321     void startTrackingRepaints(ExceptionCode&);
322     void stopTrackingRepaints(ExceptionCode&);
323
324     void startTrackingLayerFlushes(ExceptionCode&);
325     unsigned long layerFlushCount(ExceptionCode&);
326     
327     void startTrackingStyleRecalcs(ExceptionCode&);
328     unsigned long styleRecalcCount(ExceptionCode&);
329
330     void startTrackingCompositingUpdates(ExceptionCode&);
331     unsigned long compositingUpdateCount(ExceptionCode&);
332
333     void updateLayoutIgnorePendingStylesheetsAndRunPostLayoutTasks(ExceptionCode&);
334     void updateLayoutIgnorePendingStylesheetsAndRunPostLayoutTasks(Node*, ExceptionCode&);
335     unsigned layoutCount() const;
336
337     RefPtr<ArrayBuffer> serializeObject(PassRefPtr<SerializedScriptValue>) const;
338     RefPtr<SerializedScriptValue> deserializeBuffer(PassRefPtr<ArrayBuffer>) const;
339
340     bool isFromCurrentWorld(Deprecated::ScriptValue) const;
341
342     void setUsesOverlayScrollbars(bool enabled);
343
344     String getCurrentCursorInfo(ExceptionCode&);
345
346     String markerTextForListItem(Element*, ExceptionCode&);
347
348     String toolTipFromElement(Element*, ExceptionCode&) const;
349
350     void forceReload(bool endToEnd);
351
352     void enableAutoSizeMode(bool enabled, int minimumWidth, int minimumHeight, int maximumWidth, int maximumHeight);
353
354 #if ENABLE(ENCRYPTED_MEDIA_V2)
355     void initializeMockCDM();
356 #endif
357
358 #if ENABLE(SPEECH_SYNTHESIS)
359     void enableMockSpeechSynthesizer();
360 #endif
361
362 #if ENABLE(MEDIA_STREAM)
363     void enableMockRTCPeerConnectionHandler();
364     void setMockMediaCaptureDevicesEnabled(bool);
365 #endif
366
367     String getImageSourceURL(Element*, ExceptionCode&);
368
369 #if ENABLE(VIDEO)
370     void simulateAudioInterruption(Node*);
371     bool mediaElementHasCharacteristic(Node*, const String&, ExceptionCode&);
372 #endif
373
374     bool isSelectPopupVisible(Node*);
375
376     String captionsStyleSheetOverride(ExceptionCode&);
377     void setCaptionsStyleSheetOverride(const String&, ExceptionCode&);
378     void setPrimaryAudioTrackLanguageOverride(const String&, ExceptionCode&);
379     void setCaptionDisplayMode(const String&, ExceptionCode&);
380
381 #if ENABLE(VIDEO)
382     Ref<TimeRanges> createTimeRanges(Float32Array* startTimes, Float32Array* endTimes);
383     double closestTimeToTimeRanges(double time, TimeRanges*);
384 #endif
385
386     Ref<ClientRect> selectionBounds(ExceptionCode&);
387
388 #if ENABLE(VIBRATION)
389     bool isVibrating();
390 #endif
391
392     bool isPluginUnavailabilityIndicatorObscured(Element*, ExceptionCode&);
393     bool isPluginSnapshotted(Element*, ExceptionCode&);
394
395 #if ENABLE(MEDIA_SOURCE)
396     WEBCORE_TESTSUPPORT_EXPORT void initializeMockMediaSource();
397     Vector<String> bufferedSamplesForTrackID(SourceBuffer*, const AtomicString&);
398     void setShouldGenerateTimestamps(SourceBuffer*, bool);
399 #endif
400
401 #if ENABLE(VIDEO)
402     void beginMediaSessionInterruption(const String&, ExceptionCode&);
403     void endMediaSessionInterruption(const String&);
404     void applicationDidEnterForeground() const;
405     void applicationWillEnterBackground() const;
406     void setMediaSessionRestrictions(const String& mediaType, const String& restrictions, ExceptionCode&);
407     void setMediaElementRestrictions(HTMLMediaElement*, const String& restrictions, ExceptionCode&);
408     void postRemoteControlCommand(const String&, ExceptionCode&);
409     bool elementIsBlockingDisplaySleep(Element*) const;
410 #endif
411
412 #if ENABLE(MEDIA_SESSION)
413     void sendMediaSessionStartOfInterruptionNotification(const String&);
414     void sendMediaSessionEndOfInterruptionNotification(const String&);
415     String mediaSessionCurrentState(MediaSession*) const;
416     double mediaElementPlayerVolume(HTMLMediaElement*) const;
417     void sendMediaControlEvent(const String&);
418 #endif
419
420 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
421     void setMockMediaPlaybackTargetPickerEnabled(bool);
422     void setMockMediaPlaybackTargetPickerState(const String& deviceName, const String& deviceState, ExceptionCode&);
423 #endif
424
425 #if ENABLE(WEB_AUDIO)
426     void setAudioContextRestrictions(AudioContext*, const String& restrictions, ExceptionCode&);
427 #endif
428
429     void simulateSystemSleep() const;
430     void simulateSystemWake() const;
431
432     RefPtr<MockPageOverlay> installMockPageOverlay(const String& overlayType, ExceptionCode&);
433     String pageOverlayLayerTreeAsText(ExceptionCode&) const;
434
435     void setPageMuted(bool);
436     bool isPagePlayingAudio();
437
438     void setPageDefersLoading(bool);
439
440     RefPtr<File> createFile(const String&);
441     void queueMicroTask(int);
442     bool testPreloaderSettingViewport();
443
444 #if ENABLE(CONTENT_FILTERING)
445     MockContentFilterSettings& mockContentFilterSettings();
446 #endif
447
448 #if ENABLE(CSS_SCROLL_SNAP)
449     String scrollSnapOffsets(Element*, ExceptionCode&);
450 #endif
451
452     String pathStringWithShrinkWrappedRects(Vector<double> rectComponents, double radius, ExceptionCode&);
453
454     String getCurrentMediaControlsStatusForElement(HTMLMediaElement*);
455
456     String userVisibleString(const DOMURL*);
457     void setShowAllPlugins(bool);
458
459 #if ENABLE(STREAMS_API)
460     bool isReadableStreamDisturbed(ScriptState&, JSC::JSValue);
461 #endif
462
463 private:
464     explicit Internals(Document*);
465     Document* contextDocument() const;
466     Frame* frame() const;
467
468     RenderedDocumentMarker* markerAt(Node*, const String& markerType, unsigned index, ExceptionCode&);
469
470     std::unique_ptr<InspectorStubFrontend> m_inspectorFrontend;
471 };
472
473 } // namespace WebCore
474
475 #endif