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