3339466abe369b8e5249a28c67de513233cd1c6f
[WebKit-https.git] / Source / WebCore / testing / Internals.h
1 /*
2  * Copyright (C) 2012 Google Inc. All rights reserved.
3  * Copyright (C) 2013, 2014 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/PassRefPtr.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 DOMWindow;
50 class Document;
51 class Element;
52 class File;
53 class Frame;
54 class HTMLMediaElement;
55 class InspectorFrontendChannelDummy;
56 class InspectorFrontendClientDummy;
57 class InternalSettings;
58 class MallocStatistics;
59 class MediaSession;
60 class MemoryInfo;
61 class Node;
62 class Page;
63 class Range;
64 class RenderedDocumentMarker;
65 class ScriptExecutionContext;
66 class SerializedScriptValue;
67 class SourceBuffer;
68 class TimeRanges;
69 class TypeConversions;
70 class XMLHttpRequest;
71
72 #if ENABLE(CONTENT_FILTERING)
73 class MockContentFilterSettings;
74 #endif
75
76 typedef int ExceptionCode;
77
78 class Internals : public RefCounted<Internals>
79                 , public ContextDestructionObserver {
80 public:
81     static PassRefPtr<Internals> create(Document*);
82     virtual ~Internals();
83
84     static void resetToConsistentState(Page*);
85
86     String elementRenderTreeAsText(Element*, ExceptionCode&);
87     bool hasPausedImageAnimations(Element*, ExceptionCode&);
88
89     String address(Node*);
90     bool nodeNeedsStyleRecalc(Node*, ExceptionCode&);
91     String description(Deprecated::ScriptValue);
92
93     bool isPreloaded(const String& url);
94     bool isLoadingFromMemoryCache(const String& url);
95     String xhrResponseSource(XMLHttpRequest*);
96     bool isSharingStyleSheetContents(Element* linkA, Element* linkB);
97     bool isStyleSheetLoadingSubresources(Element* link);
98     void setOverrideCachePolicy(const String&);
99     void setOverrideResourceLoadPriority(const String&);
100     void setStrictRawResourceValidationPolicyDisabled(bool);
101
102     void clearMemoryCache();
103     void pruneMemoryCacheToSize(unsigned size);
104     unsigned memoryCacheSize() const;
105
106     void clearPageCache();
107     unsigned pageCacheSize() const;
108
109     PassRefPtr<CSSComputedStyleDeclaration> computedStyleIncludingVisitedInfo(Node*, ExceptionCode&) const;
110
111     Node* ensureShadowRoot(Element* host, ExceptionCode&);
112     Node* ensureUserAgentShadowRoot(Element* host, ExceptionCode&);
113     Node* createShadowRoot(Element* host, ExceptionCode&);
114     Node* shadowRoot(Element* host, ExceptionCode&);
115     String shadowRootType(const Node*, ExceptionCode&) const;
116     Element* includerFor(Node*, ExceptionCode&);
117     String shadowPseudoId(Element*, ExceptionCode&);
118     void setShadowPseudoId(Element*, const String&, ExceptionCode&);
119
120     // DOMTimers throttling testing.
121     bool isTimerThrottled(int timeoutId, ExceptionCode&);
122     bool isRequestAnimationFrameThrottled() const;
123     bool areTimersThrottled() const;
124
125     // Spatial Navigation testing.
126     unsigned lastSpatialNavigationCandidateCount(ExceptionCode&) const;
127
128     // CSS Animation testing.
129     unsigned numberOfActiveAnimations() const;
130     bool animationsAreSuspended(ExceptionCode&) const;
131     void suspendAnimations(ExceptionCode&) const;
132     void resumeAnimations(ExceptionCode&) const;
133     bool pauseAnimationAtTimeOnElement(const String& animationName, double pauseTime, Element*, ExceptionCode&);
134     bool pauseAnimationAtTimeOnPseudoElement(const String& animationName, double pauseTime, Element*, const String& pseudoId, ExceptionCode&);
135
136     // CSS Transition testing.
137     bool pauseTransitionAtTimeOnElement(const String& propertyName, double pauseTime, Element*, ExceptionCode&);
138     bool pauseTransitionAtTimeOnPseudoElement(const String& property, double pauseTime, Element*, const String& pseudoId, ExceptionCode&);
139
140     Node* treeScopeRootNode(Node*, ExceptionCode&);
141     Node* parentTreeScope(Node*, ExceptionCode&);
142
143     bool attached(Node*, ExceptionCode&);
144
145     String visiblePlaceholder(Element*);
146 #if ENABLE(INPUT_TYPE_COLOR)
147     void selectColorInColorChooser(Element*, const String& colorValue);
148 #endif
149     Vector<String> formControlStateOfPreviousHistoryItem(ExceptionCode&);
150     void setFormControlStateOfPreviousHistoryItem(const Vector<String>&, ExceptionCode&);
151
152     Ref<ClientRect> absoluteCaretBounds(ExceptionCode&);
153
154     Ref<ClientRect> boundingBox(Element*, ExceptionCode&);
155
156     Ref<ClientRectList> inspectorHighlightRects(ExceptionCode&);
157     String inspectorHighlightObject(ExceptionCode&);
158
159     unsigned markerCountForNode(Node*, const String&, ExceptionCode&);
160     PassRefPtr<Range> markerRangeForNode(Node*, const String& markerType, unsigned index, ExceptionCode&);
161     String markerDescriptionForNode(Node*, const String& markerType, unsigned index, 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     PassRefPtr<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     PassRefPtr<Range> subrange(Range* 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     PassRefPtr<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     Vector<String> consoleMessageArgumentCounts() const;
267     PassRefPtr<DOMWindow> openDummyInspectorFrontend(const String& url);
268     void closeDummyInspectorFrontend();
269     void setJavaScriptProfilingEnabled(bool enabled, ExceptionCode&);
270     void setInspectorIsUnderTest(bool isUnderTest, ExceptionCode&);
271
272     String counterValue(Element*);
273
274     int pageNumber(Element*, float pageWidth = 800, float pageHeight = 600);
275     Vector<String> shortcutIconURLs() const;
276
277     int numberOfPages(float pageWidthInPixels = 800, float pageHeightInPixels = 600);
278     String pageProperty(String, int, ExceptionCode& = ASSERT_NO_EXCEPTION) const;
279     String pageSizeAndMarginsInPixels(int, int, int, int, int, int, int, ExceptionCode& = ASSERT_NO_EXCEPTION) const;
280
281     void setPageScaleFactor(float scaleFactor, int x, int y, ExceptionCode&);
282     void setPageZoomFactor(float zoomFactor, ExceptionCode&);
283     void setTextZoomFactor(float zoomFactor, ExceptionCode&);
284
285     void setUseFixedLayout(bool useFixedLayout, ExceptionCode&);
286     void setFixedLayoutSize(int width, int height, ExceptionCode&);
287
288     void setHeaderHeight(float);
289     void setFooterHeight(float);
290
291     void setTopContentInset(float);
292
293 #if ENABLE(FULLSCREEN_API)
294     void webkitWillEnterFullScreenForElement(Element*);
295     void webkitDidEnterFullScreenForElement(Element*);
296     void webkitWillExitFullScreenForElement(Element*);
297     void webkitDidExitFullScreenForElement(Element*);
298 #endif
299
300     WEBCORE_TESTSUPPORT_EXPORT void setApplicationCacheOriginQuota(unsigned long long);
301
302     void registerURLSchemeAsBypassingContentSecurityPolicy(const String& scheme);
303     void removeURLSchemeRegisteredAsBypassingContentSecurityPolicy(const String& scheme);
304
305     PassRefPtr<MallocStatistics> mallocStatistics() const;
306     PassRefPtr<TypeConversions> typeConversions() const;
307     PassRefPtr<MemoryInfo> memoryInfo() const;
308
309     Vector<String> getReferencedFilePaths() const;
310
311     void startTrackingRepaints(ExceptionCode&);
312     void stopTrackingRepaints(ExceptionCode&);
313
314     void startTrackingLayerFlushes(ExceptionCode&);
315     unsigned long layerFlushCount(ExceptionCode&);
316     
317     void startTrackingStyleRecalcs(ExceptionCode&);
318     unsigned long styleRecalcCount(ExceptionCode&);
319
320     void startTrackingCompositingUpdates(ExceptionCode&);
321     unsigned long compositingUpdateCount(ExceptionCode&);
322
323     void updateLayoutIgnorePendingStylesheetsAndRunPostLayoutTasks(ExceptionCode&);
324     void updateLayoutIgnorePendingStylesheetsAndRunPostLayoutTasks(Node*, ExceptionCode&);
325     unsigned layoutCount() const;
326
327     PassRefPtr<ArrayBuffer> serializeObject(PassRefPtr<SerializedScriptValue>) const;
328     PassRefPtr<SerializedScriptValue> deserializeBuffer(PassRefPtr<ArrayBuffer>) const;
329
330     bool isFromCurrentWorld(Deprecated::ScriptValue) const;
331
332     void setUsesOverlayScrollbars(bool enabled);
333
334     String getCurrentCursorInfo(ExceptionCode&);
335
336     String markerTextForListItem(Element*, ExceptionCode&);
337
338     String toolTipFromElement(Element*, ExceptionCode&) const;
339
340     void forceReload(bool endToEnd);
341
342 #if ENABLE(ENCRYPTED_MEDIA_V2)
343     void initializeMockCDM();
344 #endif
345
346 #if ENABLE(SPEECH_SYNTHESIS)
347     void enableMockSpeechSynthesizer();
348 #endif
349
350 #if ENABLE(MEDIA_STREAM)
351     void enableMockRTCPeerConnectionHandler();
352 #endif
353
354     String getImageSourceURL(Element*, ExceptionCode&);
355
356 #if ENABLE(VIDEO)
357     void simulateAudioInterruption(Node*);
358     bool mediaElementHasCharacteristic(Node*, const String&, ExceptionCode&);
359 #endif
360
361     bool isSelectPopupVisible(Node*);
362
363     String captionsStyleSheetOverride(ExceptionCode&);
364     void setCaptionsStyleSheetOverride(const String&, ExceptionCode&);
365     void setPrimaryAudioTrackLanguageOverride(const String&, ExceptionCode&);
366     void setCaptionDisplayMode(const String&, ExceptionCode&);
367
368 #if ENABLE(VIDEO)
369     PassRefPtr<TimeRanges> createTimeRanges(Float32Array* startTimes, Float32Array* endTimes);
370     double closestTimeToTimeRanges(double time, TimeRanges*);
371 #endif
372
373     Ref<ClientRect> selectionBounds(ExceptionCode&);
374
375 #if ENABLE(VIBRATION)
376     bool isVibrating();
377 #endif
378
379     bool isPluginUnavailabilityIndicatorObscured(Element*, ExceptionCode&);
380     bool isPluginSnapshotted(Element*, ExceptionCode&);
381
382 #if ENABLE(MEDIA_SOURCE)
383     WEBCORE_TESTSUPPORT_EXPORT void initializeMockMediaSource();
384     Vector<String> bufferedSamplesForTrackID(SourceBuffer*, const AtomicString&);
385     void setShouldGenerateTimestamps(SourceBuffer*, bool);
386 #endif
387
388 #if ENABLE(VIDEO)
389     void beginMediaSessionInterruption();
390     void endMediaSessionInterruption(const String&);
391     void applicationWillEnterForeground() const;
392     void applicationWillEnterBackground() const;
393     void setMediaSessionRestrictions(const String& mediaType, const String& restrictions, ExceptionCode&);
394     void setMediaElementRestrictions(HTMLMediaElement*, const String& restrictions, ExceptionCode&);
395     void postRemoteControlCommand(const String&, ExceptionCode&);
396     bool elementIsBlockingDisplaySleep(Element*) const;
397 #endif
398
399 #if ENABLE(MEDIA_SESSION)
400     void sendMediaSessionStartOfInterruptionNotification(const String&);
401     void sendMediaSessionEndOfInterruptionNotification(const String&);
402     String mediaSessionCurrentState(MediaSession*) const;
403     double mediaElementPlayerVolume(HTMLMediaElement*) const;
404     void sendMediaControlEvent(const String&);
405 #endif
406
407 #if ENABLE(WEB_AUDIO)
408     void setAudioContextRestrictions(AudioContext*, const String& restrictions, ExceptionCode&);
409 #endif
410
411     void simulateSystemSleep() const;
412     void simulateSystemWake() const;
413
414     void installMockPageOverlay(const String& overlayType, ExceptionCode&);
415     String pageOverlayLayerTreeAsText(ExceptionCode&) const;
416
417     void setPageMuted(bool);
418     bool isPagePlayingAudio();
419
420     RefPtr<File> createFile(const String&);
421     void queueMicroTask(int);
422     bool testPreloaderSettingViewport();
423
424 #if ENABLE(CONTENT_FILTERING)
425     MockContentFilterSettings& mockContentFilterSettings();
426 #endif
427
428 #if ENABLE(CSS_SCROLL_SNAP)
429     String scrollSnapOffsets(Element*, ExceptionCode&);
430 #endif
431
432     String pathStringWithShrinkWrappedRects(Vector<double> rectComponents, double radius, ExceptionCode&);
433
434     String getCurrentMediaControlsStatusForElement(HTMLMediaElement*);
435
436 private:
437     explicit Internals(Document*);
438     Document* contextDocument() const;
439     Frame* frame() const;
440
441     RenderedDocumentMarker* markerAt(Node*, const String& markerType, unsigned index, ExceptionCode&);
442
443     RefPtr<DOMWindow> m_frontendWindow;
444     std::unique_ptr<InspectorFrontendClientDummy> m_frontendClient;
445     std::unique_ptr<InspectorFrontendChannelDummy> m_frontendChannel;
446 };
447
448 } // namespace WebCore
449
450 #endif