Add test for class change style invalidation optimization
[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 styleChangeType(Node*, ExceptionCode&);
93     String description(Deprecated::ScriptValue);
94
95     bool isPreloaded(const String& url);
96     bool isLoadingFromMemoryCache(const String& url);
97     String xhrResponseSource(XMLHttpRequest*);
98     bool isSharingStyleSheetContents(Element* linkA, Element* linkB);
99     bool isStyleSheetLoadingSubresources(Element* link);
100     void setOverrideCachePolicy(const String&);
101     void setOverrideResourceLoadPriority(const String&);
102     void setStrictRawResourceValidationPolicyDisabled(bool);
103
104     void clearMemoryCache();
105     void pruneMemoryCacheToSize(unsigned size);
106     unsigned memoryCacheSize() const;
107
108     size_t imageFrameIndex(Element*, ExceptionCode&);
109
110     void clearPageCache();
111     unsigned pageCacheSize() const;
112
113     RefPtr<CSSComputedStyleDeclaration> computedStyleIncludingVisitedInfo(Node*, ExceptionCode&) const;
114
115     Node* ensureShadowRoot(Element* host, ExceptionCode&);
116     Node* ensureUserAgentShadowRoot(Element* host, ExceptionCode&);
117     Node* createShadowRoot(Element* host, ExceptionCode&);
118     Node* shadowRoot(Element* host, ExceptionCode&);
119     String shadowRootType(const Node*, ExceptionCode&) const;
120     Element* includerFor(Node*, ExceptionCode&);
121     String shadowPseudoId(Element*, ExceptionCode&);
122     void setShadowPseudoId(Element*, const String&, ExceptionCode&);
123
124     // DOMTimers throttling testing.
125     bool isTimerThrottled(int timeoutId, ExceptionCode&);
126     bool isRequestAnimationFrameThrottled() const;
127     bool areTimersThrottled() const;
128
129     // Spatial Navigation testing.
130     unsigned lastSpatialNavigationCandidateCount(ExceptionCode&) const;
131
132     // CSS Animation testing.
133     unsigned numberOfActiveAnimations() const;
134     bool animationsAreSuspended(ExceptionCode&) const;
135     void suspendAnimations(ExceptionCode&) const;
136     void resumeAnimations(ExceptionCode&) const;
137     bool pauseAnimationAtTimeOnElement(const String& animationName, double pauseTime, Element*, ExceptionCode&);
138     bool pauseAnimationAtTimeOnPseudoElement(const String& animationName, double pauseTime, Element*, const String& pseudoId, ExceptionCode&);
139
140     // CSS Transition testing.
141     bool pauseTransitionAtTimeOnElement(const String& propertyName, double pauseTime, Element*, ExceptionCode&);
142     bool pauseTransitionAtTimeOnPseudoElement(const String& property, double pauseTime, Element*, const String& pseudoId, ExceptionCode&);
143
144     Node* treeScopeRootNode(Node*, ExceptionCode&);
145     Node* parentTreeScope(Node*, ExceptionCode&);
146
147     bool attached(Node*, ExceptionCode&);
148
149     String visiblePlaceholder(Element*);
150     void selectColorInColorChooser(Element*, const String& colorValue);
151     Vector<String> formControlStateOfPreviousHistoryItem(ExceptionCode&);
152     void setFormControlStateOfPreviousHistoryItem(const Vector<String>&, ExceptionCode&);
153
154     Ref<ClientRect> absoluteCaretBounds(ExceptionCode&);
155
156     Ref<ClientRect> boundingBox(Element*, ExceptionCode&);
157
158     Ref<ClientRectList> inspectorHighlightRects(ExceptionCode&);
159     String inspectorHighlightObject(ExceptionCode&);
160
161     unsigned markerCountForNode(Node*, const String&, ExceptionCode&);
162     RefPtr<Range> markerRangeForNode(Node*, const String& markerType, unsigned index, ExceptionCode&);
163     String markerDescriptionForNode(Node*, const String& markerType, unsigned index, ExceptionCode&);
164     String dumpMarkerRects(const String& markerType, ExceptionCode&);
165     void addTextMatchMarker(const Range*, bool isActive);
166     void setMarkedTextMatchesAreHighlighted(bool, ExceptionCode&);
167
168     void invalidateFontCache();
169
170     void setScrollViewPosition(long x, long y, ExceptionCode&);
171     void setViewBaseBackgroundColor(const String& colorValue, ExceptionCode&);
172
173     void setPagination(const String& mode, int gap, ExceptionCode& ec) { setPagination(mode, gap, 0, ec); }
174     void setPagination(const String& mode, int gap, int pageLength, ExceptionCode&);
175     void setPaginationLineGridEnabled(bool, ExceptionCode&);
176     String configurationForViewport(float devicePixelRatio, int deviceWidth, int deviceHeight, int availableWidth, int availableHeight, ExceptionCode&);
177
178     bool wasLastChangeUserEdit(Element* textField, ExceptionCode&);
179     bool elementShouldAutoComplete(Element* inputElement, ExceptionCode&);
180     void setEditingValue(Element* inputElement, const String&, ExceptionCode&);
181     void setAutofilled(Element*, bool enabled, ExceptionCode&);
182     void setShowAutoFillButton(Element*, const String& autoFillButtonType, ExceptionCode&);
183     void scrollElementToRect(Element*, long x, long y, long w, long h, ExceptionCode&);
184
185     void paintControlTints(ExceptionCode&);
186
187     RefPtr<Range> rangeFromLocationAndLength(Element* scope, int rangeLocation, int rangeLength, ExceptionCode&);
188     unsigned locationFromRange(Element* scope, const Range*, ExceptionCode&);
189     unsigned lengthFromRange(Element* scope, const Range*, ExceptionCode&);
190     String rangeAsText(const Range*, ExceptionCode&);
191     RefPtr<Range> subrange(Range*, int rangeLocation, int rangeLength, ExceptionCode&);
192     RefPtr<Range> rangeForDictionaryLookupAtLocation(int x, int y, ExceptionCode&);
193
194     void setDelegatesScrolling(bool enabled, ExceptionCode&);
195
196     int lastSpellCheckRequestSequence(ExceptionCode&);
197     int lastSpellCheckProcessedSequence(ExceptionCode&);
198
199     Vector<String> userPreferredLanguages() const;
200     void setUserPreferredLanguages(const Vector<String>&);
201
202     Vector<String> userPreferredAudioCharacteristics() const;
203     void setUserPreferredAudioCharacteristic(const String&);
204
205     unsigned wheelEventHandlerCount(ExceptionCode&);
206     unsigned touchEventHandlerCount(ExceptionCode&);
207
208     RefPtr<NodeList> nodesFromRect(Document*, int x, int y, unsigned topPadding, unsigned rightPadding,
209         unsigned bottomPadding, unsigned leftPadding, bool ignoreClipping, bool allowShadowContent, bool allowChildFrameContent, ExceptionCode&) const;
210
211     String parserMetaData(Deprecated::ScriptValue = Deprecated::ScriptValue());
212
213     void updateEditorUINowIfScheduled();
214
215     bool hasSpellingMarker(int from, int length, ExceptionCode&);
216     bool hasGrammarMarker(int from, int length, ExceptionCode&);
217     bool hasAutocorrectedMarker(int from, int length, ExceptionCode&);
218     void setContinuousSpellCheckingEnabled(bool enabled, ExceptionCode&);
219     void setAutomaticQuoteSubstitutionEnabled(bool enabled, ExceptionCode&);
220     void setAutomaticLinkDetectionEnabled(bool enabled, ExceptionCode&);
221     void setAutomaticDashSubstitutionEnabled(bool enabled, ExceptionCode&);
222     void setAutomaticTextReplacementEnabled(bool enabled, ExceptionCode&);
223     void setAutomaticSpellingCorrectionEnabled(bool enabled, ExceptionCode&);
224
225     void handleAcceptedCandidate(const String& candidate, ExceptionCode&);
226
227     bool isOverwriteModeEnabled(ExceptionCode&);
228     void toggleOverwriteModeEnabled(ExceptionCode&);
229
230     unsigned countMatchesForText(const String&, unsigned findOptions, const String& markMatches, ExceptionCode&);
231
232     unsigned numberOfScrollableAreas(ExceptionCode&);
233
234     bool isPageBoxVisible(int pageNumber, ExceptionCode&);
235
236     static const char* internalsId;
237
238     InternalSettings* settings() const;
239     unsigned workerThreadCount() const;
240
241     void setBatteryStatus(const String& eventType, bool charging, double chargingTime, double dischargingTime, double level, ExceptionCode&);
242
243     void setDeviceProximity(const String& eventType, double value, double min, double max, ExceptionCode&);
244
245     enum {
246         // Values need to be kept in sync with Internals.idl.
247         LAYER_TREE_INCLUDES_VISIBLE_RECTS = 1,
248         LAYER_TREE_INCLUDES_TILE_CACHES = 2,
249         LAYER_TREE_INCLUDES_REPAINT_RECTS = 4,
250         LAYER_TREE_INCLUDES_PAINTING_PHASES = 8,
251         LAYER_TREE_INCLUDES_CONTENT_LAYERS = 16
252     };
253     String layerTreeAsText(Document*, unsigned flags, ExceptionCode&) const;
254     String layerTreeAsText(Document*, ExceptionCode&) const;
255     String repaintRectsAsText(ExceptionCode&) const;
256     String scrollingStateTreeAsText(ExceptionCode&) const;
257     String mainThreadScrollingReasons(ExceptionCode&) const;
258     RefPtr<ClientRectList> nonFastScrollableRects(ExceptionCode&) const;
259
260     void setElementUsesDisplayListDrawing(Element*, bool usesDisplayListDrawing, ExceptionCode&);
261     void setElementTracksDisplayListReplay(Element*, bool isTrackingReplay, ExceptionCode&);
262
263     enum {
264         // Values need to be kept in sync with Internals.idl.
265         DISPLAY_LIST_INCLUDES_PLATFORM_OPERATIONS = 1,
266     };
267     String displayListForElement(Element*, unsigned flags, ExceptionCode&);
268     String displayListForElement(Element*, ExceptionCode&);
269
270     String replayDisplayListForElement(Element*, unsigned flags, ExceptionCode&);
271     String replayDisplayListForElement(Element*, ExceptionCode&);
272
273     void garbageCollectDocumentResources(ExceptionCode&) const;
274
275     void insertAuthorCSS(const String&, ExceptionCode&) const;
276     void insertUserCSS(const String&, ExceptionCode&) const;
277
278     const ProfilesArray& consoleProfiles() const;
279
280     unsigned numberOfLiveNodes() const;
281     unsigned numberOfLiveDocuments() const;
282
283     RefPtr<DOMWindow> openDummyInspectorFrontend(const String& url);
284     void closeDummyInspectorFrontend();
285     void setLegacyJavaScriptProfilingEnabled(bool enabled, ExceptionCode&);
286     void setInspectorIsUnderTest(bool isUnderTest, ExceptionCode&);
287
288     String counterValue(Element*);
289
290     int pageNumber(Element*, float pageWidth = 800, float pageHeight = 600);
291     Vector<String> shortcutIconURLs() const;
292
293     int numberOfPages(float pageWidthInPixels = 800, float pageHeightInPixels = 600);
294     String pageProperty(String, int, ExceptionCode& = ASSERT_NO_EXCEPTION) const;
295     String pageSizeAndMarginsInPixels(int, int, int, int, int, int, int, ExceptionCode& = ASSERT_NO_EXCEPTION) const;
296
297     void setPageScaleFactor(float scaleFactor, int x, int y, ExceptionCode&);
298     void setPageZoomFactor(float zoomFactor, ExceptionCode&);
299     void setTextZoomFactor(float zoomFactor, ExceptionCode&);
300
301     void setUseFixedLayout(bool useFixedLayout, ExceptionCode&);
302     void setFixedLayoutSize(int width, int height, ExceptionCode&);
303
304     void setHeaderHeight(float);
305     void setFooterHeight(float);
306
307     void setTopContentInset(float);
308
309 #if ENABLE(FULLSCREEN_API)
310     void webkitWillEnterFullScreenForElement(Element*);
311     void webkitDidEnterFullScreenForElement(Element*);
312     void webkitWillExitFullScreenForElement(Element*);
313     void webkitDidExitFullScreenForElement(Element*);
314 #endif
315
316     WEBCORE_TESTSUPPORT_EXPORT void setApplicationCacheOriginQuota(unsigned long long);
317
318     void registerURLSchemeAsBypassingContentSecurityPolicy(const String& scheme);
319     void removeURLSchemeRegisteredAsBypassingContentSecurityPolicy(const String& scheme);
320
321     Ref<MallocStatistics> mallocStatistics() const;
322     Ref<TypeConversions> typeConversions() const;
323     Ref<MemoryInfo> memoryInfo() const;
324
325     Vector<String> getReferencedFilePaths() const;
326
327     void startTrackingRepaints(ExceptionCode&);
328     void stopTrackingRepaints(ExceptionCode&);
329
330     void startTrackingLayerFlushes(ExceptionCode&);
331     unsigned long layerFlushCount(ExceptionCode&);
332     
333     void startTrackingStyleRecalcs(ExceptionCode&);
334     unsigned long styleRecalcCount(ExceptionCode&);
335
336     void startTrackingCompositingUpdates(ExceptionCode&);
337     unsigned long compositingUpdateCount(ExceptionCode&);
338
339     void updateLayoutIgnorePendingStylesheetsAndRunPostLayoutTasks(ExceptionCode&);
340     void updateLayoutIgnorePendingStylesheetsAndRunPostLayoutTasks(Node*, ExceptionCode&);
341     unsigned layoutCount() const;
342
343     RefPtr<ArrayBuffer> serializeObject(PassRefPtr<SerializedScriptValue>) const;
344     RefPtr<SerializedScriptValue> deserializeBuffer(PassRefPtr<ArrayBuffer>) const;
345
346     bool isFromCurrentWorld(Deprecated::ScriptValue) const;
347
348     void setUsesOverlayScrollbars(bool enabled);
349
350     String getCurrentCursorInfo(ExceptionCode&);
351
352     String markerTextForListItem(Element*, ExceptionCode&);
353
354     String toolTipFromElement(Element*, ExceptionCode&) const;
355
356     void forceReload(bool endToEnd);
357
358     void enableAutoSizeMode(bool enabled, int minimumWidth, int minimumHeight, int maximumWidth, int maximumHeight);
359
360 #if ENABLE(ENCRYPTED_MEDIA_V2)
361     void initializeMockCDM();
362 #endif
363
364 #if ENABLE(SPEECH_SYNTHESIS)
365     void enableMockSpeechSynthesizer();
366 #endif
367
368 #if ENABLE(MEDIA_STREAM)
369     void enableMockRTCPeerConnectionHandler();
370     void setMockMediaCaptureDevicesEnabled(bool);
371 #endif
372
373     String getImageSourceURL(Element*, ExceptionCode&);
374
375 #if ENABLE(VIDEO)
376     void simulateAudioInterruption(Node*);
377     bool mediaElementHasCharacteristic(Node*, const String&, ExceptionCode&);
378 #endif
379
380     bool isSelectPopupVisible(Node*);
381
382     String captionsStyleSheetOverride(ExceptionCode&);
383     void setCaptionsStyleSheetOverride(const String&, ExceptionCode&);
384     void setPrimaryAudioTrackLanguageOverride(const String&, ExceptionCode&);
385     void setCaptionDisplayMode(const String&, ExceptionCode&);
386
387 #if ENABLE(VIDEO)
388     Ref<TimeRanges> createTimeRanges(Float32Array* startTimes, Float32Array* endTimes);
389     double closestTimeToTimeRanges(double time, TimeRanges*);
390 #endif
391
392     Ref<ClientRect> selectionBounds(ExceptionCode&);
393
394 #if ENABLE(VIBRATION)
395     bool isVibrating();
396 #endif
397
398     bool isPluginUnavailabilityIndicatorObscured(Element*, ExceptionCode&);
399     bool isPluginSnapshotted(Element*, ExceptionCode&);
400
401 #if ENABLE(MEDIA_SOURCE)
402     WEBCORE_TESTSUPPORT_EXPORT void initializeMockMediaSource();
403     Vector<String> bufferedSamplesForTrackID(SourceBuffer*, const AtomicString&);
404     void setShouldGenerateTimestamps(SourceBuffer*, bool);
405 #endif
406
407 #if ENABLE(VIDEO)
408     void beginMediaSessionInterruption(const String&, ExceptionCode&);
409     void endMediaSessionInterruption(const String&);
410     void applicationDidEnterForeground() const;
411     void applicationWillEnterBackground() const;
412     void setMediaSessionRestrictions(const String& mediaType, const String& restrictions, ExceptionCode&);
413     void setMediaElementRestrictions(HTMLMediaElement*, const String& restrictions, ExceptionCode&);
414     void postRemoteControlCommand(const String&, ExceptionCode&);
415     bool elementIsBlockingDisplaySleep(Element*) const;
416 #endif
417
418 #if ENABLE(MEDIA_SESSION)
419     void sendMediaSessionStartOfInterruptionNotification(const String&);
420     void sendMediaSessionEndOfInterruptionNotification(const String&);
421     String mediaSessionCurrentState(MediaSession*) const;
422     double mediaElementPlayerVolume(HTMLMediaElement*) const;
423     void sendMediaControlEvent(const String&);
424 #endif
425
426 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
427     void setMockMediaPlaybackTargetPickerEnabled(bool);
428     void setMockMediaPlaybackTargetPickerState(const String& deviceName, const String& deviceState, ExceptionCode&);
429 #endif
430
431 #if ENABLE(WEB_AUDIO)
432     void setAudioContextRestrictions(AudioContext*, const String& restrictions, ExceptionCode&);
433 #endif
434
435     void simulateSystemSleep() const;
436     void simulateSystemWake() const;
437
438     RefPtr<MockPageOverlay> installMockPageOverlay(const String& overlayType, ExceptionCode&);
439     String pageOverlayLayerTreeAsText(ExceptionCode&) const;
440
441     void setPageMuted(bool);
442     bool isPagePlayingAudio();
443
444     void setPageDefersLoading(bool);
445
446     RefPtr<File> createFile(const String&);
447     void queueMicroTask(int);
448     bool testPreloaderSettingViewport();
449
450 #if ENABLE(CONTENT_FILTERING)
451     MockContentFilterSettings& mockContentFilterSettings();
452 #endif
453
454 #if ENABLE(CSS_SCROLL_SNAP)
455     String scrollSnapOffsets(Element*, ExceptionCode&);
456 #endif
457
458     String pathStringWithShrinkWrappedRects(Vector<double> rectComponents, double radius, ExceptionCode&);
459
460     String getCurrentMediaControlsStatusForElement(HTMLMediaElement*);
461
462     String userVisibleString(const DOMURL*);
463     void setShowAllPlugins(bool);
464
465 #if ENABLE(STREAMS_API)
466     bool isReadableStreamDisturbed(ScriptState&, JSC::JSValue);
467 #endif
468
469 private:
470     explicit Internals(Document*);
471     Document* contextDocument() const;
472     Frame* frame() const;
473
474     RenderedDocumentMarker* markerAt(Node*, const String& markerType, unsigned index, ExceptionCode&);
475
476     std::unique_ptr<InspectorStubFrontend> m_inspectorFrontend;
477 };
478
479 } // namespace WebCore
480
481 #endif