e81ac3a25fff0edb56c34f185619eda59eb02a93
[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 garbageCollectDocumentResources(ExceptionCode&) const;
257
258     void allowRoundingHacks() const;
259
260     void insertAuthorCSS(const String&, ExceptionCode&) const;
261     void insertUserCSS(const String&, ExceptionCode&) const;
262
263     const ProfilesArray& consoleProfiles() const;
264
265     unsigned numberOfLiveNodes() const;
266     unsigned numberOfLiveDocuments() const;
267
268     RefPtr<DOMWindow> openDummyInspectorFrontend(const String& url);
269     void closeDummyInspectorFrontend();
270     void setJavaScriptProfilingEnabled(bool enabled, ExceptionCode&);
271     void setInspectorIsUnderTest(bool isUnderTest, ExceptionCode&);
272
273     String counterValue(Element*);
274
275     int pageNumber(Element*, float pageWidth = 800, float pageHeight = 600);
276     Vector<String> shortcutIconURLs() const;
277
278     int numberOfPages(float pageWidthInPixels = 800, float pageHeightInPixels = 600);
279     String pageProperty(String, int, ExceptionCode& = ASSERT_NO_EXCEPTION) const;
280     String pageSizeAndMarginsInPixels(int, int, int, int, int, int, int, ExceptionCode& = ASSERT_NO_EXCEPTION) const;
281
282     void setPageScaleFactor(float scaleFactor, int x, int y, ExceptionCode&);
283     void setPageZoomFactor(float zoomFactor, ExceptionCode&);
284     void setTextZoomFactor(float zoomFactor, ExceptionCode&);
285
286     void setUseFixedLayout(bool useFixedLayout, ExceptionCode&);
287     void setFixedLayoutSize(int width, int height, ExceptionCode&);
288
289     void setHeaderHeight(float);
290     void setFooterHeight(float);
291
292     void setTopContentInset(float);
293
294 #if ENABLE(FULLSCREEN_API)
295     void webkitWillEnterFullScreenForElement(Element*);
296     void webkitDidEnterFullScreenForElement(Element*);
297     void webkitWillExitFullScreenForElement(Element*);
298     void webkitDidExitFullScreenForElement(Element*);
299 #endif
300
301     WEBCORE_TESTSUPPORT_EXPORT void setApplicationCacheOriginQuota(unsigned long long);
302
303     void registerURLSchemeAsBypassingContentSecurityPolicy(const String& scheme);
304     void removeURLSchemeRegisteredAsBypassingContentSecurityPolicy(const String& scheme);
305
306     Ref<MallocStatistics> mallocStatistics() const;
307     Ref<TypeConversions> typeConversions() const;
308     Ref<MemoryInfo> memoryInfo() const;
309
310     Vector<String> getReferencedFilePaths() const;
311
312     void startTrackingRepaints(ExceptionCode&);
313     void stopTrackingRepaints(ExceptionCode&);
314
315     void startTrackingLayerFlushes(ExceptionCode&);
316     unsigned long layerFlushCount(ExceptionCode&);
317     
318     void startTrackingStyleRecalcs(ExceptionCode&);
319     unsigned long styleRecalcCount(ExceptionCode&);
320
321     void startTrackingCompositingUpdates(ExceptionCode&);
322     unsigned long compositingUpdateCount(ExceptionCode&);
323
324     void updateLayoutIgnorePendingStylesheetsAndRunPostLayoutTasks(ExceptionCode&);
325     void updateLayoutIgnorePendingStylesheetsAndRunPostLayoutTasks(Node*, ExceptionCode&);
326     unsigned layoutCount() const;
327
328     RefPtr<ArrayBuffer> serializeObject(PassRefPtr<SerializedScriptValue>) const;
329     RefPtr<SerializedScriptValue> deserializeBuffer(PassRefPtr<ArrayBuffer>) const;
330
331     bool isFromCurrentWorld(Deprecated::ScriptValue) const;
332
333     void setUsesOverlayScrollbars(bool enabled);
334
335     String getCurrentCursorInfo(ExceptionCode&);
336
337     String markerTextForListItem(Element*, ExceptionCode&);
338
339     String toolTipFromElement(Element*, ExceptionCode&) const;
340
341     void forceReload(bool endToEnd);
342
343     void enableAutoSizeMode(bool enabled, int minimumWidth, int minimumHeight, int maximumWidth, int maximumHeight);
344
345 #if ENABLE(ENCRYPTED_MEDIA_V2)
346     void initializeMockCDM();
347 #endif
348
349 #if ENABLE(SPEECH_SYNTHESIS)
350     void enableMockSpeechSynthesizer();
351 #endif
352
353 #if ENABLE(MEDIA_STREAM)
354     void enableMockRTCPeerConnectionHandler();
355     void setMockMediaCaptureDevicesEnabled(bool);
356 #endif
357
358     String getImageSourceURL(Element*, ExceptionCode&);
359
360 #if ENABLE(VIDEO)
361     void simulateAudioInterruption(Node*);
362     bool mediaElementHasCharacteristic(Node*, const String&, ExceptionCode&);
363 #endif
364
365     bool isSelectPopupVisible(Node*);
366
367     String captionsStyleSheetOverride(ExceptionCode&);
368     void setCaptionsStyleSheetOverride(const String&, ExceptionCode&);
369     void setPrimaryAudioTrackLanguageOverride(const String&, ExceptionCode&);
370     void setCaptionDisplayMode(const String&, ExceptionCode&);
371
372 #if ENABLE(VIDEO)
373     Ref<TimeRanges> createTimeRanges(Float32Array* startTimes, Float32Array* endTimes);
374     double closestTimeToTimeRanges(double time, TimeRanges*);
375 #endif
376
377     Ref<ClientRect> selectionBounds(ExceptionCode&);
378
379 #if ENABLE(VIBRATION)
380     bool isVibrating();
381 #endif
382
383     bool isPluginUnavailabilityIndicatorObscured(Element*, ExceptionCode&);
384     bool isPluginSnapshotted(Element*, ExceptionCode&);
385
386 #if ENABLE(MEDIA_SOURCE)
387     WEBCORE_TESTSUPPORT_EXPORT void initializeMockMediaSource();
388     Vector<String> bufferedSamplesForTrackID(SourceBuffer*, const AtomicString&);
389     void setShouldGenerateTimestamps(SourceBuffer*, bool);
390 #endif
391
392 #if ENABLE(VIDEO)
393     void beginMediaSessionInterruption(const String&, ExceptionCode&);
394     void endMediaSessionInterruption(const String&);
395     void applicationDidEnterForeground() const;
396     void applicationWillEnterBackground() const;
397     void setMediaSessionRestrictions(const String& mediaType, const String& restrictions, ExceptionCode&);
398     void setMediaElementRestrictions(HTMLMediaElement*, const String& restrictions, ExceptionCode&);
399     void postRemoteControlCommand(const String&, ExceptionCode&);
400     bool elementIsBlockingDisplaySleep(Element*) const;
401 #endif
402
403 #if ENABLE(MEDIA_SESSION)
404     void sendMediaSessionStartOfInterruptionNotification(const String&);
405     void sendMediaSessionEndOfInterruptionNotification(const String&);
406     String mediaSessionCurrentState(MediaSession*) const;
407     double mediaElementPlayerVolume(HTMLMediaElement*) const;
408     void sendMediaControlEvent(const String&);
409 #endif
410
411 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
412     void setMockMediaPlaybackTargetPickerEnabled(bool);
413     void setMockMediaPlaybackTargetPickerState(const String& deviceName, const String& deviceState, ExceptionCode&);
414 #endif
415
416 #if ENABLE(WEB_AUDIO)
417     void setAudioContextRestrictions(AudioContext*, const String& restrictions, ExceptionCode&);
418 #endif
419
420     void simulateSystemSleep() const;
421     void simulateSystemWake() const;
422
423     RefPtr<MockPageOverlay> installMockPageOverlay(const String& overlayType, ExceptionCode&);
424     String pageOverlayLayerTreeAsText(ExceptionCode&) const;
425
426     void setPageMuted(bool);
427     bool isPagePlayingAudio();
428
429     void setPageDefersLoading(bool);
430
431     RefPtr<File> createFile(const String&);
432     void queueMicroTask(int);
433     bool testPreloaderSettingViewport();
434
435 #if ENABLE(CONTENT_FILTERING)
436     MockContentFilterSettings& mockContentFilterSettings();
437 #endif
438
439 #if ENABLE(CSS_SCROLL_SNAP)
440     String scrollSnapOffsets(Element*, ExceptionCode&);
441 #endif
442
443     String pathStringWithShrinkWrappedRects(Vector<double> rectComponents, double radius, ExceptionCode&);
444
445     String getCurrentMediaControlsStatusForElement(HTMLMediaElement*);
446
447     String userVisibleString(const DOMURL*);
448     void setShowAllPlugins(bool);
449
450 #if ENABLE(STREAMS_API)
451     bool isReadableStreamDisturbed(ScriptState&, JSC::JSValue);
452 #endif
453
454 private:
455     explicit Internals(Document*);
456     Document* contextDocument() const;
457     Frame* frame() const;
458
459     RenderedDocumentMarker* markerAt(Node*, const String& markerType, unsigned index, ExceptionCode&);
460
461     std::unique_ptr<InspectorStubFrontend> m_inspectorFrontend;
462 };
463
464 } // namespace WebCore
465
466 #endif