06b829529bbae930f8a52efc71bb22cc0cf3795d
[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 #if ENABLE(INPUT_TYPE_COLOR)
146     void selectColorInColorChooser(Element*, const String& colorValue);
147 #endif
148     Vector<String> formControlStateOfPreviousHistoryItem(ExceptionCode&);
149     void setFormControlStateOfPreviousHistoryItem(const Vector<String>&, ExceptionCode&);
150
151     Ref<ClientRect> absoluteCaretBounds(ExceptionCode&);
152
153     Ref<ClientRect> boundingBox(Element*, ExceptionCode&);
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(long x, long y, ExceptionCode&);
168     void setViewBaseBackgroundColor(const String& colorValue, ExceptionCode&);
169
170     void setPagination(const String& mode, int gap, ExceptionCode& ec) { setPagination(mode, gap, 0, ec); }
171     void setPagination(const String& mode, int gap, int pageLength, 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(Element* inputElement, ExceptionCode&);
176     void setEditingValue(Element* inputElement, const String&, ExceptionCode&);
177     void setAutofilled(Element*, bool enabled, ExceptionCode&);
178     void setShowAutoFillButton(Element*, bool enabled, ExceptionCode&);
179     void scrollElementToRect(Element*, long x, long y, long w, long h, ExceptionCode&);
180
181     void paintControlTints(ExceptionCode&);
182
183     RefPtr<Range> rangeFromLocationAndLength(Element* scope, int rangeLocation, int rangeLength, ExceptionCode&);
184     unsigned locationFromRange(Element* scope, const Range*, ExceptionCode&);
185     unsigned lengthFromRange(Element* scope, const Range*, ExceptionCode&);
186     String rangeAsText(const Range*, ExceptionCode&);
187     RefPtr<Range> subrange(Range*, int rangeLocation, int rangeLength, ExceptionCode&);
188     RefPtr<Range> rangeForDictionaryLookupAtLocation(int x, int y, ExceptionCode&);
189
190     void setDelegatesScrolling(bool enabled, ExceptionCode&);
191
192     int lastSpellCheckRequestSequence(ExceptionCode&);
193     int lastSpellCheckProcessedSequence(ExceptionCode&);
194
195     Vector<String> userPreferredLanguages() const;
196     void setUserPreferredLanguages(const Vector<String>&);
197
198     Vector<String> userPreferredAudioCharacteristics() const;
199     void setUserPreferredAudioCharacteristic(const String&);
200
201     unsigned wheelEventHandlerCount(ExceptionCode&);
202     unsigned touchEventHandlerCount(ExceptionCode&);
203
204     RefPtr<NodeList> nodesFromRect(Document*, int x, int y, unsigned topPadding, unsigned rightPadding,
205         unsigned bottomPadding, unsigned leftPadding, bool ignoreClipping, bool allowShadowContent, bool allowChildFrameContent, ExceptionCode&) const;
206
207     String parserMetaData(Deprecated::ScriptValue = Deprecated::ScriptValue());
208
209     void updateEditorUINowIfScheduled();
210
211     bool hasSpellingMarker(int from, int length, ExceptionCode&);
212     bool hasGrammarMarker(int from, int length, ExceptionCode&);
213     bool hasAutocorrectedMarker(int from, int length, ExceptionCode&);
214     void setContinuousSpellCheckingEnabled(bool enabled, ExceptionCode&);
215     void setAutomaticQuoteSubstitutionEnabled(bool enabled, ExceptionCode&);
216     void setAutomaticLinkDetectionEnabled(bool enabled, ExceptionCode&);
217     void setAutomaticDashSubstitutionEnabled(bool enabled, ExceptionCode&);
218     void setAutomaticTextReplacementEnabled(bool enabled, ExceptionCode&);
219     void setAutomaticSpellingCorrectionEnabled(bool enabled, ExceptionCode&);
220
221     bool isOverwriteModeEnabled(ExceptionCode&);
222     void toggleOverwriteModeEnabled(ExceptionCode&);
223
224     unsigned countMatchesForText(const String&, unsigned findOptions, const String& markMatches, ExceptionCode&);
225
226     unsigned numberOfScrollableAreas(ExceptionCode&);
227
228     bool isPageBoxVisible(int pageNumber, ExceptionCode&);
229
230     static const char* internalsId;
231
232     InternalSettings* settings() const;
233     unsigned workerThreadCount() const;
234
235     void setBatteryStatus(const String& eventType, bool charging, double chargingTime, double dischargingTime, double level, ExceptionCode&);
236
237     void setDeviceProximity(const String& eventType, double value, double min, double max, ExceptionCode&);
238
239     enum {
240         // Values need to be kept in sync with Internals.idl.
241         LAYER_TREE_INCLUDES_VISIBLE_RECTS = 1,
242         LAYER_TREE_INCLUDES_TILE_CACHES = 2,
243         LAYER_TREE_INCLUDES_REPAINT_RECTS = 4,
244         LAYER_TREE_INCLUDES_PAINTING_PHASES = 8,
245         LAYER_TREE_INCLUDES_CONTENT_LAYERS = 16
246     };
247     String layerTreeAsText(Document*, unsigned flags, ExceptionCode&) const;
248     String layerTreeAsText(Document*, 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 garbageCollectDocumentResources(ExceptionCode&) const;
255
256     void allowRoundingHacks() const;
257
258     void insertAuthorCSS(const String&, ExceptionCode&) const;
259     void insertUserCSS(const String&, ExceptionCode&) const;
260
261     const ProfilesArray& consoleProfiles() const;
262
263     unsigned numberOfLiveNodes() const;
264     unsigned numberOfLiveDocuments() const;
265
266     RefPtr<DOMWindow> openDummyInspectorFrontend(const String& url);
267     void closeDummyInspectorFrontend();
268     void setJavaScriptProfilingEnabled(bool enabled, ExceptionCode&);
269     void setInspectorIsUnderTest(bool isUnderTest, ExceptionCode&);
270
271     String counterValue(Element*);
272
273     int pageNumber(Element*, float pageWidth = 800, float pageHeight = 600);
274     Vector<String> shortcutIconURLs() const;
275
276     int numberOfPages(float pageWidthInPixels = 800, float pageHeightInPixels = 600);
277     String pageProperty(String, int, ExceptionCode& = ASSERT_NO_EXCEPTION) const;
278     String pageSizeAndMarginsInPixels(int, int, int, int, int, int, int, ExceptionCode& = ASSERT_NO_EXCEPTION) const;
279
280     void setPageScaleFactor(float scaleFactor, int x, int y, ExceptionCode&);
281     void setPageZoomFactor(float zoomFactor, ExceptionCode&);
282     void setTextZoomFactor(float zoomFactor, ExceptionCode&);
283
284     void setUseFixedLayout(bool useFixedLayout, ExceptionCode&);
285     void setFixedLayoutSize(int width, int height, ExceptionCode&);
286
287     void setHeaderHeight(float);
288     void setFooterHeight(float);
289
290     void setTopContentInset(float);
291
292 #if ENABLE(FULLSCREEN_API)
293     void webkitWillEnterFullScreenForElement(Element*);
294     void webkitDidEnterFullScreenForElement(Element*);
295     void webkitWillExitFullScreenForElement(Element*);
296     void webkitDidExitFullScreenForElement(Element*);
297 #endif
298
299     WEBCORE_TESTSUPPORT_EXPORT void setApplicationCacheOriginQuota(unsigned long long);
300
301     void registerURLSchemeAsBypassingContentSecurityPolicy(const String& scheme);
302     void removeURLSchemeRegisteredAsBypassingContentSecurityPolicy(const String& scheme);
303
304     Ref<MallocStatistics> mallocStatistics() const;
305     Ref<TypeConversions> typeConversions() const;
306     Ref<MemoryInfo> memoryInfo() const;
307
308     Vector<String> getReferencedFilePaths() const;
309
310     void startTrackingRepaints(ExceptionCode&);
311     void stopTrackingRepaints(ExceptionCode&);
312
313     void startTrackingLayerFlushes(ExceptionCode&);
314     unsigned long layerFlushCount(ExceptionCode&);
315     
316     void startTrackingStyleRecalcs(ExceptionCode&);
317     unsigned long styleRecalcCount(ExceptionCode&);
318
319     void startTrackingCompositingUpdates(ExceptionCode&);
320     unsigned long compositingUpdateCount(ExceptionCode&);
321
322     void updateLayoutIgnorePendingStylesheetsAndRunPostLayoutTasks(ExceptionCode&);
323     void updateLayoutIgnorePendingStylesheetsAndRunPostLayoutTasks(Node*, ExceptionCode&);
324     unsigned layoutCount() const;
325
326     RefPtr<ArrayBuffer> serializeObject(PassRefPtr<SerializedScriptValue>) const;
327     RefPtr<SerializedScriptValue> deserializeBuffer(PassRefPtr<ArrayBuffer>) const;
328
329     bool isFromCurrentWorld(Deprecated::ScriptValue) const;
330
331     void setUsesOverlayScrollbars(bool enabled);
332
333     String getCurrentCursorInfo(ExceptionCode&);
334
335     String markerTextForListItem(Element*, ExceptionCode&);
336
337     String toolTipFromElement(Element*, ExceptionCode&) const;
338
339     void forceReload(bool endToEnd);
340
341 #if ENABLE(ENCRYPTED_MEDIA_V2)
342     void initializeMockCDM();
343 #endif
344
345 #if ENABLE(SPEECH_SYNTHESIS)
346     void enableMockSpeechSynthesizer();
347 #endif
348
349 #if ENABLE(MEDIA_STREAM)
350     void enableMockRTCPeerConnectionHandler();
351 #endif
352
353     String getImageSourceURL(Element*, ExceptionCode&);
354
355 #if ENABLE(VIDEO)
356     void simulateAudioInterruption(Node*);
357     bool mediaElementHasCharacteristic(Node*, const String&, ExceptionCode&);
358 #endif
359
360     bool isSelectPopupVisible(Node*);
361
362     String captionsStyleSheetOverride(ExceptionCode&);
363     void setCaptionsStyleSheetOverride(const String&, ExceptionCode&);
364     void setPrimaryAudioTrackLanguageOverride(const String&, ExceptionCode&);
365     void setCaptionDisplayMode(const String&, ExceptionCode&);
366
367 #if ENABLE(VIDEO)
368     Ref<TimeRanges> createTimeRanges(Float32Array* startTimes, Float32Array* endTimes);
369     double closestTimeToTimeRanges(double time, TimeRanges*);
370 #endif
371
372     Ref<ClientRect> selectionBounds(ExceptionCode&);
373
374 #if ENABLE(VIBRATION)
375     bool isVibrating();
376 #endif
377
378     bool isPluginUnavailabilityIndicatorObscured(Element*, ExceptionCode&);
379     bool isPluginSnapshotted(Element*, ExceptionCode&);
380
381 #if ENABLE(MEDIA_SOURCE)
382     WEBCORE_TESTSUPPORT_EXPORT void initializeMockMediaSource();
383     Vector<String> bufferedSamplesForTrackID(SourceBuffer*, const AtomicString&);
384     void setShouldGenerateTimestamps(SourceBuffer*, bool);
385 #endif
386
387 #if ENABLE(VIDEO)
388     void beginMediaSessionInterruption(const String&, ExceptionCode&);
389     void endMediaSessionInterruption(const String&);
390     void applicationDidEnterForeground() const;
391     void applicationWillEnterBackground() const;
392     void setMediaSessionRestrictions(const String& mediaType, const String& restrictions, ExceptionCode&);
393     void setMediaElementRestrictions(HTMLMediaElement*, const String& restrictions, ExceptionCode&);
394     void postRemoteControlCommand(const String&, ExceptionCode&);
395     bool elementIsBlockingDisplaySleep(Element*) const;
396 #endif
397
398 #if ENABLE(MEDIA_SESSION)
399     void sendMediaSessionStartOfInterruptionNotification(const String&);
400     void sendMediaSessionEndOfInterruptionNotification(const String&);
401     String mediaSessionCurrentState(MediaSession*) const;
402     double mediaElementPlayerVolume(HTMLMediaElement*) const;
403     void sendMediaControlEvent(const String&);
404 #endif
405
406 #if ENABLE(WEB_AUDIO)
407     void setAudioContextRestrictions(AudioContext*, const String& restrictions, ExceptionCode&);
408 #endif
409
410     void simulateSystemSleep() const;
411     void simulateSystemWake() const;
412
413     void installMockPageOverlay(const String& overlayType, ExceptionCode&);
414     String pageOverlayLayerTreeAsText(ExceptionCode&) const;
415
416     void setPageMuted(bool);
417     bool isPagePlayingAudio();
418
419     void setPageDefersLoading(bool);
420
421     RefPtr<File> createFile(const String&);
422     void queueMicroTask(int);
423     bool testPreloaderSettingViewport();
424
425 #if ENABLE(CONTENT_FILTERING)
426     MockContentFilterSettings& mockContentFilterSettings();
427 #endif
428
429 #if ENABLE(CSS_SCROLL_SNAP)
430     String scrollSnapOffsets(Element*, ExceptionCode&);
431 #endif
432
433     String pathStringWithShrinkWrappedRects(Vector<double> rectComponents, double radius, ExceptionCode&);
434
435     String getCurrentMediaControlsStatusForElement(HTMLMediaElement*);
436
437     String userVisibleString(const DOMURL*);
438     void setShowAllPlugins(bool);
439
440 private:
441     explicit Internals(Document*);
442     Document* contextDocument() const;
443     Frame* frame() const;
444
445     RenderedDocumentMarker* markerAt(Node*, const String& markerType, unsigned index, ExceptionCode&);
446
447     std::unique_ptr<InspectorStubFrontend> m_inspectorFrontend;
448 };
449
450 } // namespace WebCore
451
452 #endif