Test Russian ".рф" domain support
[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 DOMURL;
50 class DOMWindow;
51 class Document;
52 class Element;
53 class File;
54 class Frame;
55 class HTMLMediaElement;
56 class InspectorFrontendChannelDummy;
57 class InspectorFrontendClientDummy;
58 class InternalSettings;
59 class MallocStatistics;
60 class MediaSession;
61 class MemoryInfo;
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 PassRefPtr<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     void clearPageCache();
108     unsigned pageCacheSize() const;
109
110     PassRefPtr<CSSComputedStyleDeclaration> computedStyleIncludingVisitedInfo(Node*, ExceptionCode&) const;
111
112     Node* ensureShadowRoot(Element* host, ExceptionCode&);
113     Node* ensureUserAgentShadowRoot(Element* host, ExceptionCode&);
114     Node* createShadowRoot(Element* host, ExceptionCode&);
115     Node* shadowRoot(Element* host, ExceptionCode&);
116     String shadowRootType(const Node*, ExceptionCode&) const;
117     Element* includerFor(Node*, ExceptionCode&);
118     String shadowPseudoId(Element*, ExceptionCode&);
119     void setShadowPseudoId(Element*, const String&, ExceptionCode&);
120
121     // DOMTimers throttling testing.
122     bool isTimerThrottled(int timeoutId, ExceptionCode&);
123     bool isRequestAnimationFrameThrottled() const;
124     bool areTimersThrottled() const;
125
126     // Spatial Navigation testing.
127     unsigned lastSpatialNavigationCandidateCount(ExceptionCode&) const;
128
129     // CSS Animation testing.
130     unsigned numberOfActiveAnimations() const;
131     bool animationsAreSuspended(ExceptionCode&) const;
132     void suspendAnimations(ExceptionCode&) const;
133     void resumeAnimations(ExceptionCode&) const;
134     bool pauseAnimationAtTimeOnElement(const String& animationName, double pauseTime, Element*, ExceptionCode&);
135     bool pauseAnimationAtTimeOnPseudoElement(const String& animationName, double pauseTime, Element*, const String& pseudoId, ExceptionCode&);
136
137     // CSS Transition testing.
138     bool pauseTransitionAtTimeOnElement(const String& propertyName, double pauseTime, Element*, ExceptionCode&);
139     bool pauseTransitionAtTimeOnPseudoElement(const String& property, double pauseTime, Element*, const String& pseudoId, ExceptionCode&);
140
141     Node* treeScopeRootNode(Node*, ExceptionCode&);
142     Node* parentTreeScope(Node*, ExceptionCode&);
143
144     bool attached(Node*, ExceptionCode&);
145
146     String visiblePlaceholder(Element*);
147 #if ENABLE(INPUT_TYPE_COLOR)
148     void selectColorInColorChooser(Element*, const String& colorValue);
149 #endif
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     PassRefPtr<Range> markerRangeForNode(Node*, const String& markerType, unsigned index, ExceptionCode&);
162     String markerDescriptionForNode(Node*, const String& markerType, unsigned index, ExceptionCode&);
163     void addTextMatchMarker(const Range*, bool isActive);
164     void setMarkedTextMatchesAreHighlighted(bool, ExceptionCode&);
165
166     void invalidateFontCache();
167
168     void setScrollViewPosition(long x, long y, ExceptionCode&);
169     void setViewBaseBackgroundColor(const String& colorValue, ExceptionCode&);
170
171     void setPagination(const String& mode, int gap, ExceptionCode& ec) { setPagination(mode, gap, 0, ec); }
172     void setPagination(const String& mode, int gap, int pageLength, ExceptionCode&);
173     String configurationForViewport(float devicePixelRatio, int deviceWidth, int deviceHeight, int availableWidth, int availableHeight, ExceptionCode&);
174
175     bool wasLastChangeUserEdit(Element* textField, ExceptionCode&);
176     bool elementShouldAutoComplete(Element* inputElement, ExceptionCode&);
177     void setEditingValue(Element* inputElement, const String&, ExceptionCode&);
178     void setAutofilled(Element*, bool enabled, ExceptionCode&);
179     void setShowAutoFillButton(Element*, bool enabled, ExceptionCode&);
180     void scrollElementToRect(Element*, long x, long y, long w, long h, ExceptionCode&);
181
182     void paintControlTints(ExceptionCode&);
183
184     PassRefPtr<Range> rangeFromLocationAndLength(Element* scope, int rangeLocation, int rangeLength, ExceptionCode&);
185     unsigned locationFromRange(Element* scope, const Range*, ExceptionCode&);
186     unsigned lengthFromRange(Element* scope, const Range*, ExceptionCode&);
187     String rangeAsText(const Range*, ExceptionCode&);
188     PassRefPtr<Range> subrange(Range* range, int rangeLocation, int rangeLength, ExceptionCode&);
189     RefPtr<Range> rangeForDictionaryLookupAtLocation(int x, int y, ExceptionCode&);
190
191     void setDelegatesScrolling(bool enabled, ExceptionCode&);
192
193     int lastSpellCheckRequestSequence(ExceptionCode&);
194     int lastSpellCheckProcessedSequence(ExceptionCode&);
195
196     Vector<String> userPreferredLanguages() const;
197     void setUserPreferredLanguages(const Vector<String>&);
198
199     Vector<String> userPreferredAudioCharacteristics() const;
200     void setUserPreferredAudioCharacteristic(const String&);
201
202     unsigned wheelEventHandlerCount(ExceptionCode&);
203     unsigned touchEventHandlerCount(ExceptionCode&);
204
205     PassRefPtr<NodeList> nodesFromRect(Document*, int x, int y, unsigned topPadding, unsigned rightPadding,
206         unsigned bottomPadding, unsigned leftPadding, bool ignoreClipping, bool allowShadowContent, bool allowChildFrameContent, ExceptionCode&) const;
207
208     String parserMetaData(Deprecated::ScriptValue = Deprecated::ScriptValue());
209
210     void updateEditorUINowIfScheduled();
211
212     bool hasSpellingMarker(int from, int length, ExceptionCode&);
213     bool hasGrammarMarker(int from, int length, ExceptionCode&);
214     bool hasAutocorrectedMarker(int from, int length, ExceptionCode&);
215     void setContinuousSpellCheckingEnabled(bool enabled, ExceptionCode&);
216     void setAutomaticQuoteSubstitutionEnabled(bool enabled, ExceptionCode&);
217     void setAutomaticLinkDetectionEnabled(bool enabled, ExceptionCode&);
218     void setAutomaticDashSubstitutionEnabled(bool enabled, ExceptionCode&);
219     void setAutomaticTextReplacementEnabled(bool enabled, ExceptionCode&);
220     void setAutomaticSpellingCorrectionEnabled(bool enabled, ExceptionCode&);
221
222     bool isOverwriteModeEnabled(ExceptionCode&);
223     void toggleOverwriteModeEnabled(ExceptionCode&);
224
225     unsigned countMatchesForText(const String&, unsigned findOptions, const String& markMatches, ExceptionCode&);
226
227     unsigned numberOfScrollableAreas(ExceptionCode&);
228
229     bool isPageBoxVisible(int pageNumber, ExceptionCode&);
230
231     static const char* internalsId;
232
233     InternalSettings* settings() const;
234     unsigned workerThreadCount() const;
235
236     void setBatteryStatus(const String& eventType, bool charging, double chargingTime, double dischargingTime, double level, ExceptionCode&);
237
238     void setDeviceProximity(const String& eventType, double value, double min, double max, ExceptionCode&);
239
240     enum {
241         // Values need to be kept in sync with Internals.idl.
242         LAYER_TREE_INCLUDES_VISIBLE_RECTS = 1,
243         LAYER_TREE_INCLUDES_TILE_CACHES = 2,
244         LAYER_TREE_INCLUDES_REPAINT_RECTS = 4,
245         LAYER_TREE_INCLUDES_PAINTING_PHASES = 8,
246         LAYER_TREE_INCLUDES_CONTENT_LAYERS = 16
247     };
248     String layerTreeAsText(Document*, unsigned flags, ExceptionCode&) const;
249     String layerTreeAsText(Document*, ExceptionCode&) const;
250     String repaintRectsAsText(ExceptionCode&) const;
251     String scrollingStateTreeAsText(ExceptionCode&) const;
252     String mainThreadScrollingReasons(ExceptionCode&) const;
253     RefPtr<ClientRectList> nonFastScrollableRects(ExceptionCode&) const;
254
255     void garbageCollectDocumentResources(ExceptionCode&) const;
256
257     void allowRoundingHacks() const;
258
259     void insertAuthorCSS(const String&, ExceptionCode&) const;
260     void insertUserCSS(const String&, ExceptionCode&) const;
261
262     const ProfilesArray& consoleProfiles() const;
263
264     unsigned numberOfLiveNodes() const;
265     unsigned numberOfLiveDocuments() const;
266
267     Vector<String> consoleMessageArgumentCounts() const;
268     PassRefPtr<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     PassRefPtr<MallocStatistics> mallocStatistics() const;
307     PassRefPtr<TypeConversions> typeConversions() const;
308     PassRefPtr<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     PassRefPtr<ArrayBuffer> serializeObject(PassRefPtr<SerializedScriptValue>) const;
329     PassRefPtr<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 #if ENABLE(ENCRYPTED_MEDIA_V2)
344     void initializeMockCDM();
345 #endif
346
347 #if ENABLE(SPEECH_SYNTHESIS)
348     void enableMockSpeechSynthesizer();
349 #endif
350
351 #if ENABLE(MEDIA_STREAM)
352     void enableMockRTCPeerConnectionHandler();
353 #endif
354
355     String getImageSourceURL(Element*, ExceptionCode&);
356
357 #if ENABLE(VIDEO)
358     void simulateAudioInterruption(Node*);
359     bool mediaElementHasCharacteristic(Node*, const String&, ExceptionCode&);
360 #endif
361
362     bool isSelectPopupVisible(Node*);
363
364     String captionsStyleSheetOverride(ExceptionCode&);
365     void setCaptionsStyleSheetOverride(const String&, ExceptionCode&);
366     void setPrimaryAudioTrackLanguageOverride(const String&, ExceptionCode&);
367     void setCaptionDisplayMode(const String&, ExceptionCode&);
368
369 #if ENABLE(VIDEO)
370     PassRefPtr<TimeRanges> createTimeRanges(Float32Array* startTimes, Float32Array* endTimes);
371     double closestTimeToTimeRanges(double time, TimeRanges*);
372 #endif
373
374     Ref<ClientRect> selectionBounds(ExceptionCode&);
375
376 #if ENABLE(VIBRATION)
377     bool isVibrating();
378 #endif
379
380     bool isPluginUnavailabilityIndicatorObscured(Element*, ExceptionCode&);
381     bool isPluginSnapshotted(Element*, ExceptionCode&);
382
383 #if ENABLE(MEDIA_SOURCE)
384     WEBCORE_TESTSUPPORT_EXPORT void initializeMockMediaSource();
385     Vector<String> bufferedSamplesForTrackID(SourceBuffer*, const AtomicString&);
386     void setShouldGenerateTimestamps(SourceBuffer*, bool);
387 #endif
388
389 #if ENABLE(VIDEO)
390     void beginMediaSessionInterruption();
391     void endMediaSessionInterruption(const String&);
392     void applicationWillEnterForeground() const;
393     void applicationWillEnterBackground() const;
394     void setMediaSessionRestrictions(const String& mediaType, const String& restrictions, ExceptionCode&);
395     void setMediaElementRestrictions(HTMLMediaElement*, const String& restrictions, ExceptionCode&);
396     void postRemoteControlCommand(const String&, ExceptionCode&);
397     bool elementIsBlockingDisplaySleep(Element*) const;
398 #endif
399
400 #if ENABLE(MEDIA_SESSION)
401     void sendMediaSessionStartOfInterruptionNotification(const String&);
402     void sendMediaSessionEndOfInterruptionNotification(const String&);
403     String mediaSessionCurrentState(MediaSession*) const;
404     double mediaElementPlayerVolume(HTMLMediaElement*) const;
405     void sendMediaControlEvent(const String&);
406 #endif
407
408 #if ENABLE(WEB_AUDIO)
409     void setAudioContextRestrictions(AudioContext*, const String& restrictions, ExceptionCode&);
410 #endif
411
412     void simulateSystemSleep() const;
413     void simulateSystemWake() const;
414
415     void installMockPageOverlay(const String& overlayType, ExceptionCode&);
416     String pageOverlayLayerTreeAsText(ExceptionCode&) const;
417
418     void setPageMuted(bool);
419     bool isPagePlayingAudio();
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
439 private:
440     explicit Internals(Document*);
441     Document* contextDocument() const;
442     Frame* frame() const;
443
444     RenderedDocumentMarker* markerAt(Node*, const String& markerType, unsigned index, ExceptionCode&);
445
446     RefPtr<DOMWindow> m_frontendWindow;
447     std::unique_ptr<InspectorFrontendClientDummy> m_frontendClient;
448     std::unique_ptr<InspectorFrontendChannelDummy> m_frontendChannel;
449 };
450
451 } // namespace WebCore
452
453 #endif