3c74910206bef273efafc1e6723d5db09126cec6
[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 ClientRect;
45 class ClientRectList;
46 class DOMStringList;
47 class DOMWindow;
48 class Document;
49 class Element;
50 class Frame;
51 class InspectorFrontendChannelDummy;
52 class InspectorFrontendClientDummy;
53 class InternalSettings;
54 class MallocStatistics;
55 class MemoryInfo;
56 class Node;
57 class Page;
58 class Range;
59 class RenderedDocumentMarker;
60 class ScriptExecutionContext;
61 class SerializedScriptValue;
62 class SourceBuffer;
63 class TimeRanges;
64 class TypeConversions;
65
66 typedef int ExceptionCode;
67
68 class Internals : public RefCounted<Internals>
69                 , public ContextDestructionObserver {
70 public:
71     static PassRefPtr<Internals> create(Document*);
72     virtual ~Internals();
73
74     static void resetToConsistentState(Page*);
75
76     String elementRenderTreeAsText(Element*, ExceptionCode&);
77
78     String address(Node*);
79     bool nodeNeedsStyleRecalc(Node*, ExceptionCode&);
80     String description(Deprecated::ScriptValue);
81
82     bool isPreloaded(const String& url);
83     bool isLoadingFromMemoryCache(const String& url);
84
85     PassRefPtr<CSSComputedStyleDeclaration> computedStyleIncludingVisitedInfo(Node*, ExceptionCode&) const;
86
87     Node* ensureShadowRoot(Element* host, ExceptionCode&);
88     Node* createShadowRoot(Element* host, ExceptionCode&);
89     Node* shadowRoot(Element* host, ExceptionCode&);
90     String shadowRootType(const Node*, ExceptionCode&) const;
91     Element* includerFor(Node*, ExceptionCode&);
92     String shadowPseudoId(Element*, ExceptionCode&);
93     void setShadowPseudoId(Element*, const String&, ExceptionCode&);
94
95     // Spatial Navigation testing.
96     unsigned lastSpatialNavigationCandidateCount(ExceptionCode&) const;
97
98     // CSS Animation testing.
99     unsigned numberOfActiveAnimations() const;
100     bool animationsAreSuspended(ExceptionCode&) const;
101     void suspendAnimations(ExceptionCode&) const;
102     void resumeAnimations(ExceptionCode&) const;
103     bool pauseAnimationAtTimeOnElement(const String& animationName, double pauseTime, Element*, ExceptionCode&);
104     bool pauseAnimationAtTimeOnPseudoElement(const String& animationName, double pauseTime, Element*, const String& pseudoId, ExceptionCode&);
105
106     // CSS Transition testing.
107     bool pauseTransitionAtTimeOnElement(const String& propertyName, double pauseTime, Element*, ExceptionCode&);
108     bool pauseTransitionAtTimeOnPseudoElement(const String& property, double pauseTime, Element*, const String& pseudoId, ExceptionCode&);
109
110     Node* treeScopeRootNode(Node*, ExceptionCode&);
111     Node* parentTreeScope(Node*, ExceptionCode&);
112
113     bool attached(Node*, ExceptionCode&);
114
115     String visiblePlaceholder(Element*);
116 #if ENABLE(INPUT_TYPE_COLOR)
117     void selectColorInColorChooser(Element*, const String& colorValue);
118 #endif
119     Vector<String> formControlStateOfPreviousHistoryItem(ExceptionCode&);
120     void setFormControlStateOfPreviousHistoryItem(const Vector<String>&, ExceptionCode&);
121
122     PassRefPtr<ClientRect> absoluteCaretBounds(ExceptionCode&);
123
124     PassRefPtr<ClientRect> boundingBox(Element*, ExceptionCode&);
125
126     PassRefPtr<ClientRectList> inspectorHighlightRects(ExceptionCode&);
127     String inspectorHighlightObject(ExceptionCode&);
128
129     unsigned markerCountForNode(Node*, const String&, ExceptionCode&);
130     PassRefPtr<Range> markerRangeForNode(Node*, const String& markerType, unsigned index, ExceptionCode&);
131     String markerDescriptionForNode(Node*, const String& markerType, unsigned index, ExceptionCode&);
132     void addTextMatchMarker(const Range*, bool isActive);
133     void setMarkedTextMatchesAreHighlighted(bool, ExceptionCode&);
134
135     void invalidateFontCache();
136
137     void setScrollViewPosition(long x, long y, ExceptionCode&);
138     void setPagination(const String& mode, int gap, ExceptionCode& ec) { setPagination(mode, gap, 0, ec); }
139     void setPagination(const String& mode, int gap, int pageLength, ExceptionCode&);
140     String configurationForViewport(float devicePixelRatio, int deviceWidth, int deviceHeight, int availableWidth, int availableHeight, ExceptionCode&);
141
142     bool wasLastChangeUserEdit(Element* textField, ExceptionCode&);
143     bool elementShouldAutoComplete(Element* inputElement, ExceptionCode&);
144     void setEditingValue(Element* inputElement, const String&, ExceptionCode&);
145     void setAutofilled(Element*, bool enabled, ExceptionCode&);
146     void scrollElementToRect(Element*, long x, long y, long w, long h, ExceptionCode&);
147
148     void paintControlTints(ExceptionCode&);
149
150     PassRefPtr<Range> rangeFromLocationAndLength(Element* scope, int rangeLocation, int rangeLength, ExceptionCode&);
151     unsigned locationFromRange(Element* scope, const Range*, ExceptionCode&);
152     unsigned lengthFromRange(Element* scope, const Range*, ExceptionCode&);
153     String rangeAsText(const Range*, ExceptionCode&);
154
155     void setDelegatesScrolling(bool enabled, ExceptionCode&);
156
157     int lastSpellCheckRequestSequence(ExceptionCode&);
158     int lastSpellCheckProcessedSequence(ExceptionCode&);
159
160     Vector<String> userPreferredLanguages() const;
161     void setUserPreferredLanguages(const Vector<String>&);
162
163     unsigned wheelEventHandlerCount(ExceptionCode&);
164     unsigned touchEventHandlerCount(ExceptionCode&);
165
166     PassRefPtr<NodeList> nodesFromRect(Document*, int x, int y, unsigned topPadding, unsigned rightPadding,
167         unsigned bottomPadding, unsigned leftPadding, bool ignoreClipping, bool allowShadowContent, bool allowChildFrameContent, ExceptionCode&) const;
168
169     String parserMetaData(Deprecated::ScriptValue = Deprecated::ScriptValue());
170
171     Node* findEditingDeleteButton();
172     void updateEditorUINowIfScheduled();
173
174     bool hasSpellingMarker(int from, int length, ExceptionCode&);
175     bool hasGrammarMarker(int from, int length, ExceptionCode&);
176     bool hasAutocorrectedMarker(int from, int length, ExceptionCode&);
177     void setContinuousSpellCheckingEnabled(bool enabled, ExceptionCode&);
178     void setAutomaticQuoteSubstitutionEnabled(bool enabled, ExceptionCode&);
179     void setAutomaticLinkDetectionEnabled(bool enabled, ExceptionCode&);
180     void setAutomaticDashSubstitutionEnabled(bool enabled, ExceptionCode&);
181     void setAutomaticTextReplacementEnabled(bool enabled, ExceptionCode&);
182     void setAutomaticSpellingCorrectionEnabled(bool enabled, ExceptionCode&);
183
184     bool isOverwriteModeEnabled(ExceptionCode&);
185     void toggleOverwriteModeEnabled(ExceptionCode&);
186
187     unsigned countMatchesForText(const String&, unsigned findOptions, const String& markMatches, ExceptionCode&);
188
189     unsigned numberOfScrollableAreas(ExceptionCode&);
190
191     bool isPageBoxVisible(int pageNumber, ExceptionCode&);
192
193     static const char* internalsId;
194
195     InternalSettings* settings() const;
196     unsigned workerThreadCount() const;
197
198     void setBatteryStatus(const String& eventType, bool charging, double chargingTime, double dischargingTime, double level, ExceptionCode&);
199
200     void setDeviceProximity(const String& eventType, double value, double min, double max, ExceptionCode&);
201
202     enum {
203         // Values need to be kept in sync with Internals.idl.
204         LAYER_TREE_INCLUDES_VISIBLE_RECTS = 1,
205         LAYER_TREE_INCLUDES_TILE_CACHES = 2,
206         LAYER_TREE_INCLUDES_REPAINT_RECTS = 4,
207         LAYER_TREE_INCLUDES_PAINTING_PHASES = 8,
208         LAYER_TREE_INCLUDES_CONTENT_LAYERS = 16
209     };
210     String layerTreeAsText(Document*, unsigned flags, ExceptionCode&) const;
211     String layerTreeAsText(Document*, ExceptionCode&) const;
212     String repaintRectsAsText(ExceptionCode&) const;
213     String scrollingStateTreeAsText(ExceptionCode&) const;
214     String mainThreadScrollingReasons(ExceptionCode&) const;
215     PassRefPtr<ClientRectList> nonFastScrollableRects(ExceptionCode&) const;
216
217     void garbageCollectDocumentResources(ExceptionCode&) const;
218
219     void allowRoundingHacks() const;
220
221     void insertAuthorCSS(const String&, ExceptionCode&) const;
222     void insertUserCSS(const String&, ExceptionCode&) const;
223
224     const ProfilesArray& consoleProfiles() const;
225
226     unsigned numberOfLiveNodes() const;
227     unsigned numberOfLiveDocuments() const;
228
229 #if ENABLE(INSPECTOR)
230     Vector<String> consoleMessageArgumentCounts() const;
231     PassRefPtr<DOMWindow> openDummyInspectorFrontend(const String& url);
232     void closeDummyInspectorFrontend();
233     void setJavaScriptProfilingEnabled(bool enabled, ExceptionCode&);
234     void setInspectorIsUnderTest(bool isUnderTest, ExceptionCode&);
235 #endif
236
237     String counterValue(Element*);
238
239     int pageNumber(Element*, float pageWidth = 800, float pageHeight = 600);
240     Vector<String> shortcutIconURLs() const;
241     Vector<String> allIconURLs() const;
242
243     int numberOfPages(float pageWidthInPixels = 800, float pageHeightInPixels = 600);
244     String pageProperty(String, int, ExceptionCode& = ASSERT_NO_EXCEPTION) const;
245     String pageSizeAndMarginsInPixels(int, int, int, int, int, int, int, ExceptionCode& = ASSERT_NO_EXCEPTION) const;
246
247     void setPageScaleFactor(float scaleFactor, int x, int y, ExceptionCode&);
248     void setPageZoomFactor(float zoomFactor, ExceptionCode&);
249
250     void setHeaderHeight(float);
251     void setFooterHeight(float);
252
253     void setTopContentInset(float);
254
255 #if ENABLE(FULLSCREEN_API)
256     void webkitWillEnterFullScreenForElement(Element*);
257     void webkitDidEnterFullScreenForElement(Element*);
258     void webkitWillExitFullScreenForElement(Element*);
259     void webkitDidExitFullScreenForElement(Element*);
260 #endif
261
262     void setApplicationCacheOriginQuota(unsigned long long);
263
264     void registerURLSchemeAsBypassingContentSecurityPolicy(const String& scheme);
265     void removeURLSchemeRegisteredAsBypassingContentSecurityPolicy(const String& scheme);
266
267     PassRefPtr<MallocStatistics> mallocStatistics() const;
268     PassRefPtr<TypeConversions> typeConversions() const;
269     PassRefPtr<MemoryInfo> memoryInfo() const;
270
271     Vector<String> getReferencedFilePaths() const;
272
273     void startTrackingRepaints(ExceptionCode&);
274     void stopTrackingRepaints(ExceptionCode&);
275     void updateLayoutIgnorePendingStylesheetsAndRunPostLayoutTasks(ExceptionCode&);
276     void updateLayoutIgnorePendingStylesheetsAndRunPostLayoutTasks(Node*, ExceptionCode&);
277
278     PassRefPtr<ArrayBuffer> serializeObject(PassRefPtr<SerializedScriptValue>) const;
279     PassRefPtr<SerializedScriptValue> deserializeBuffer(PassRefPtr<ArrayBuffer>) const;
280
281     void setUsesOverlayScrollbars(bool enabled);
282
283     String getCurrentCursorInfo(ExceptionCode&);
284
285     String markerTextForListItem(Element*, ExceptionCode&);
286
287     void forceReload(bool endToEnd);
288
289 #if ENABLE(ENCRYPTED_MEDIA_V2)
290     void initializeMockCDM();
291 #endif
292
293 #if ENABLE(SPEECH_SYNTHESIS)
294     void enableMockSpeechSynthesizer();
295 #endif
296
297 #if ENABLE(MEDIA_STREAM)
298     void enableMockRTCPeerConnectionHandler();
299 #endif
300
301     String getImageSourceURL(Element*, ExceptionCode&);
302
303 #if ENABLE(VIDEO)
304     void simulateAudioInterruption(Node*);
305     bool mediaElementHasCharacteristic(Node*, const String&, ExceptionCode&);
306 #endif
307
308     bool isSelectPopupVisible(Node*);
309
310     String captionsStyleSheetOverride(ExceptionCode&);
311     void setCaptionsStyleSheetOverride(const String&, ExceptionCode&);
312     void setPrimaryAudioTrackLanguageOverride(const String&, ExceptionCode&);
313     void setCaptionDisplayMode(const String&, ExceptionCode&);
314
315 #if ENABLE(VIDEO)
316     PassRefPtr<TimeRanges> createTimeRanges(Float32Array* startTimes, Float32Array* endTimes);
317     double closestTimeToTimeRanges(double time, TimeRanges*);
318 #endif
319
320     PassRefPtr<ClientRect> selectionBounds(ExceptionCode&);
321
322 #if ENABLE(VIBRATION)
323     bool isVibrating();
324 #endif
325
326     bool isPluginUnavailabilityIndicatorObscured(Element*, ExceptionCode&);
327     bool isPluginSnapshotted(Element*, ExceptionCode&);
328
329 #if ENABLE(MEDIA_SOURCE)
330     void initializeMockMediaSource();
331     Vector<String> bufferedSamplesForTrackID(SourceBuffer*, const AtomicString&);
332 #endif
333
334 #if ENABLE(VIDEO)
335     void beginMediaSessionInterruption();
336     void endMediaSessionInterruption(const String&);
337     void applicationWillEnterForeground() const;
338     void applicationWillEnterBackground() const;
339     void setMediaSessionRestrictions(const String& mediaType, const String& restrictions, ExceptionCode&);
340     void postRemoteControlCommand(const String&, ExceptionCode&);
341 #endif
342
343     void simulateSystemSleep() const;
344     void simulateSystemWake() const;
345
346     void installMockPageOverlay(const String& overlayType, ExceptionCode&);
347     String pageOverlayLayerTreeAsText(ExceptionCode&) const;
348
349 private:
350     explicit Internals(Document*);
351     Document* contextDocument() const;
352     Frame* frame() const;
353     Vector<String> iconURLs(Document*, int iconTypesMask) const;
354
355     RenderedDocumentMarker* markerAt(Node*, const String& markerType, unsigned index, ExceptionCode&);
356 #if ENABLE(INSPECTOR)
357     RefPtr<DOMWindow> m_frontendWindow;
358     std::unique_ptr<InspectorFrontendClientDummy> m_frontendClient;
359     std::unique_ptr<InspectorFrontendChannelDummy> m_frontendChannel;
360 #endif
361 };
362
363 } // namespace WebCore
364
365 #endif