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