b416e32af4a6d3d2acde6631e362c37764a7ff98
[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 <wtf/ArrayBuffer.h>
35 #include <wtf/Float32Array.h>
36 #include <wtf/PassRefPtr.h>
37 #include <wtf/RefCounted.h>
38 #include <wtf/text/WTFString.h>
39
40 namespace WebCore {
41
42 class ClientRect;
43 class ClientRectList;
44 class DOMStringList;
45 class DOMWindow;
46 class Document;
47 class DocumentMarker;
48 class Element;
49 class Frame;
50 class InspectorFrontendChannelDummy;
51 class InternalSettings;
52 class Node;
53 class Page;
54 class PagePopupController;
55 class Range;
56 class ScriptExecutionContext;
57 class ShadowRoot;
58 class WebKitPoint;
59 class MallocStatistics;
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     size_t numberOfScopedHTMLStyleChildren(const Node*, ExceptionCode&) const;
82     PassRefPtr<CSSComputedStyleDeclaration> computedStyleIncludingVisitedInfo(Node*, ExceptionCode&) const;
83
84 #if ENABLE(SHADOW_DOM)
85     typedef ShadowRoot ShadowRootIfShadowDOMEnabledOrNode;
86 #else
87     typedef Node ShadowRootIfShadowDOMEnabledOrNode;
88 #endif
89     ShadowRootIfShadowDOMEnabledOrNode* ensureShadowRoot(Element* host, ExceptionCode&);
90     ShadowRootIfShadowDOMEnabledOrNode* createShadowRoot(Element* host, ExceptionCode&);
91     ShadowRootIfShadowDOMEnabledOrNode* shadowRoot(Element* host, ExceptionCode&);
92     String shadowRootType(const Node*, ExceptionCode&) const;
93     bool hasShadowInsertionPoint(const Node*, ExceptionCode&) const;
94     bool hasContentElement(const Node*, ExceptionCode&) const;
95     size_t countElementShadow(const Node*, ExceptionCode&) const;
96     Element* includerFor(Node*, ExceptionCode&);
97     String shadowPseudoId(Element*, ExceptionCode&);
98     void setShadowPseudoId(Element*, const String&, ExceptionCode&);
99
100     // CSS Animation testing.
101     unsigned numberOfActiveAnimations() const;
102     void suspendAnimations(Document*, ExceptionCode&) const;
103     void resumeAnimations(Document*, ExceptionCode&) const;
104     bool pauseAnimationAtTimeOnElement(const String& animationName, double pauseTime, Element*, ExceptionCode&);
105     bool pauseAnimationAtTimeOnPseudoElement(const String& animationName, double pauseTime, Element*, const String& pseudoId, ExceptionCode&);
106
107     // CSS Transition testing.
108     bool pauseTransitionAtTimeOnElement(const String& propertyName, double pauseTime, Element*, ExceptionCode&);
109     bool pauseTransitionAtTimeOnPseudoElement(const String& property, double pauseTime, Element*, const String& pseudoId, ExceptionCode&);
110
111     PassRefPtr<Element> createContentElement(ExceptionCode&);
112     bool isValidContentSelect(Element* insertionPoint, ExceptionCode&);
113     Node* treeScopeRootNode(Node*, ExceptionCode&);
114     Node* parentTreeScope(Node*, ExceptionCode&);
115     bool hasSelectorForIdInShadow(Element* host, const String& idValue, ExceptionCode&);
116     bool hasSelectorForClassInShadow(Element* host, const String& className, ExceptionCode&);
117     bool hasSelectorForAttributeInShadow(Element* host, const String& attributeName, ExceptionCode&);
118     bool hasSelectorForPseudoClassInShadow(Element* host, const String& pseudoClass, ExceptionCode&);
119
120     bool attached(Node*, ExceptionCode&);
121
122     // FIXME: Rename these functions if walker is prefered.
123     Node* nextSiblingByWalker(Node*, ExceptionCode&);
124     Node* firstChildByWalker(Node*, ExceptionCode&);
125     Node* lastChildByWalker(Node*, ExceptionCode&);
126     Node* nextNodeByWalker(Node*, ExceptionCode&);
127     Node* previousNodeByWalker(Node*, ExceptionCode&);
128
129     String visiblePlaceholder(Element*);
130 #if ENABLE(INPUT_TYPE_COLOR)
131     void selectColorInColorChooser(Element*, const String& colorValue);
132 #endif
133     Vector<String> formControlStateOfPreviousHistoryItem(ExceptionCode&);
134     void setFormControlStateOfPreviousHistoryItem(const Vector<String>&, ExceptionCode&);
135     void setEnableMockPagePopup(bool, ExceptionCode&);
136 #if ENABLE(PAGE_POPUP)
137     PassRefPtr<PagePopupController> pagePopupController();
138 #endif
139
140     PassRefPtr<ClientRect> absoluteCaretBounds(ExceptionCode&);
141
142     PassRefPtr<ClientRect> boundingBox(Element*, ExceptionCode&);
143
144     PassRefPtr<ClientRectList> inspectorHighlightRects(Document*, ExceptionCode&);
145
146     unsigned markerCountForNode(Node*, const String&, ExceptionCode&);
147     PassRefPtr<Range> markerRangeForNode(Node*, const String& markerType, unsigned index, ExceptionCode&);
148     String markerDescriptionForNode(Node*, const String& markerType, unsigned index, ExceptionCode&);
149     void addTextMatchMarker(const Range*, bool isActive);
150
151     void setScrollViewPosition(Document*, long x, long y, ExceptionCode&);
152     void setPagination(Document* document, const String& mode, int gap, ExceptionCode& ec) { setPagination(document, mode, gap, 0, ec); }
153     void setPagination(Document*, const String& mode, int gap, int pageLength, ExceptionCode&);
154     String configurationForViewport(Document*, float devicePixelRatio, int deviceWidth, int deviceHeight, int availableWidth, int availableHeight, ExceptionCode&);
155
156     bool wasLastChangeUserEdit(Element* textField, ExceptionCode&);
157     bool elementShouldAutoComplete(Element* inputElement, ExceptionCode&);
158     String suggestedValue(Element* inputElement, ExceptionCode&);
159     void setSuggestedValue(Element* inputElement, const String&, ExceptionCode&);
160     void setEditingValue(Element* inputElement, const String&, ExceptionCode&);
161     void setAutofilled(Element*, bool enabled, ExceptionCode&);
162     void scrollElementToRect(Element*, long x, long y, long w, long h, ExceptionCode&);
163
164     void paintControlTints(Document*, ExceptionCode&);
165
166     PassRefPtr<Range> rangeFromLocationAndLength(Element* scope, int rangeLocation, int rangeLength, ExceptionCode&);
167     unsigned locationFromRange(Element* scope, const Range*, ExceptionCode&);
168     unsigned lengthFromRange(Element* scope, const Range*, ExceptionCode&);
169     String rangeAsText(const Range*, ExceptionCode&);
170
171     void setDelegatesScrolling(bool enabled, Document*, ExceptionCode&);
172 #if ENABLE(TOUCH_ADJUSTMENT)
173     PassRefPtr<WebKitPoint> touchPositionAdjustedToBestClickableNode(long x, long y, long width, long height, Document*, ExceptionCode&);
174     Node* touchNodeAdjustedToBestClickableNode(long x, long y, long width, long height, Document*, ExceptionCode&);
175     PassRefPtr<WebKitPoint> touchPositionAdjustedToBestContextMenuNode(long x, long y, long width, long height, Document*, ExceptionCode&);
176     Node* touchNodeAdjustedToBestContextMenuNode(long x, long y, long width, long height, Document*, ExceptionCode&);
177     PassRefPtr<ClientRect> bestZoomableAreaForTouchPoint(long x, long y, long width, long height, Document*, ExceptionCode&);
178 #endif
179
180     int lastSpellCheckRequestSequence(Document*, ExceptionCode&);
181     int lastSpellCheckProcessedSequence(Document*, ExceptionCode&);
182
183     Vector<String> userPreferredLanguages() const;
184     void setUserPreferredLanguages(const Vector<String>&);
185
186     unsigned wheelEventHandlerCount(Document*, ExceptionCode&);
187     unsigned touchEventHandlerCount(Document*, ExceptionCode&);
188 #if ENABLE(TOUCH_EVENT_TRACKING)
189     PassRefPtr<ClientRectList> touchEventTargetClientRects(Document*, ExceptionCode&);
190 #endif
191
192     PassRefPtr<NodeList> nodesFromRect(Document*, int x, int y, unsigned topPadding, unsigned rightPadding,
193         unsigned bottomPadding, unsigned leftPadding, bool ignoreClipping, bool allowShadowContent, bool allowChildFrameContent, ExceptionCode&) const;
194
195     void emitInspectorDidBeginFrame();
196     void emitInspectorDidCancelFrame();
197
198     bool hasSpellingMarker(Document*, int from, int length, ExceptionCode&);
199     bool hasGrammarMarker(Document*, int from, int length, ExceptionCode&);
200     bool hasAutocorrectedMarker(Document*, int from, int length, ExceptionCode&);
201     void setContinuousSpellCheckingEnabled(bool enabled, ExceptionCode&);
202     void setAutomaticQuoteSubstitutionEnabled(bool enabled, ExceptionCode&);
203     void setAutomaticLinkDetectionEnabled(bool enabled, ExceptionCode&);
204     void setAutomaticDashSubstitutionEnabled(bool enabled, ExceptionCode&);
205     void setAutomaticTextReplacementEnabled(bool enabled, ExceptionCode&);
206     void setAutomaticSpellingCorrectionEnabled(bool enabled, ExceptionCode&);
207
208     bool isOverwriteModeEnabled(Document*, ExceptionCode&);
209     void toggleOverwriteModeEnabled(Document*, ExceptionCode&);
210
211     unsigned numberOfScrollableAreas(Document*, ExceptionCode&);
212
213     bool isPageBoxVisible(Document*, int pageNumber, ExceptionCode&);
214
215     static const char* internalsId;
216
217     InternalSettings* settings() const;
218     unsigned workerThreadCount() const;
219
220     void setBatteryStatus(Document*, const String& eventType, bool charging, double chargingTime, double dischargingTime, double level, ExceptionCode&);
221
222     void setNetworkInformation(Document*, const String& eventType, double bandwidth, bool metered, ExceptionCode&);
223
224     void setDeviceProximity(Document*, const String& eventType, double value, double min, double max, ExceptionCode&);
225
226     enum {
227         // Values need to be kept in sync with Internals.idl.
228         LAYER_TREE_INCLUDES_VISIBLE_RECTS = 1,
229         LAYER_TREE_INCLUDES_TILE_CACHES = 2,
230         LAYER_TREE_INCLUDES_REPAINT_RECTS = 4,
231         LAYER_TREE_INCLUDES_PAINTING_PHASES = 8
232     };
233     String layerTreeAsText(Document*, unsigned flags, ExceptionCode&) const;
234     String layerTreeAsText(Document*, ExceptionCode&) const;
235     String repaintRectsAsText(Document*, ExceptionCode&) const;
236     String scrollingStateTreeAsText(Document*, ExceptionCode&) const;
237     String mainThreadScrollingReasons(Document*, ExceptionCode&) const;
238     PassRefPtr<ClientRectList> nonFastScrollableRects(Document*, ExceptionCode&) const;
239
240     void garbageCollectDocumentResources(Document*, ExceptionCode&) const;
241
242     void allowRoundingHacks() const;
243
244     void insertAuthorCSS(Document*, const String&) const;
245     void insertUserCSS(Document*, const String&) const;
246
247 #if ENABLE(INSPECTOR)
248     unsigned numberOfLiveNodes() const;
249     unsigned numberOfLiveDocuments() const;
250     Vector<String> consoleMessageArgumentCounts(Document*) const;
251     PassRefPtr<DOMWindow> openDummyInspectorFrontend(const String& url);
252     void closeDummyInspectorFrontend();
253     void setInspectorResourcesDataSizeLimits(int maximumResourcesContentSize, int maximumSingleResourceContentSize, ExceptionCode&);
254     void setJavaScriptProfilingEnabled(bool enabled, ExceptionCode&);
255 #endif
256
257     String counterValue(Element*);
258
259     int pageNumber(Element*, float pageWidth = 800, float pageHeight = 600);
260     Vector<String> shortcutIconURLs(Document*) const;
261     Vector<String> allIconURLs(Document*) const;
262
263     int numberOfPages(float pageWidthInPixels = 800, float pageHeightInPixels = 600);
264     String pageProperty(String, int, ExceptionCode& = ASSERT_NO_EXCEPTION) const;
265     String pageSizeAndMarginsInPixels(int, int, int, int, int, int, int, ExceptionCode& = ASSERT_NO_EXCEPTION) const;
266
267     void setPageScaleFactor(float scaleFactor, int x, int y, ExceptionCode&);
268
269     void setHeaderHeight(Document*, float);
270     void setFooterHeight(Document*, float);
271
272 #if ENABLE(FULLSCREEN_API)
273     void webkitWillEnterFullScreenForElement(Document*, Element*);
274     void webkitDidEnterFullScreenForElement(Document*, Element*);
275     void webkitWillExitFullScreenForElement(Document*, Element*);
276     void webkitDidExitFullScreenForElement(Document*, Element*);
277 #endif
278
279     void registerURLSchemeAsBypassingContentSecurityPolicy(const String& scheme);
280     void removeURLSchemeRegisteredAsBypassingContentSecurityPolicy(const String& scheme);
281
282     PassRefPtr<MallocStatistics> mallocStatistics() const;
283     PassRefPtr<TypeConversions> typeConversions() const;
284
285     Vector<String> getReferencedFilePaths() const;
286
287     void startTrackingRepaints(Document*, ExceptionCode&);
288     void stopTrackingRepaints(Document*, ExceptionCode&);
289
290     PassRefPtr<ArrayBuffer> serializeObject(PassRefPtr<SerializedScriptValue>) const;
291     PassRefPtr<SerializedScriptValue> deserializeBuffer(PassRefPtr<ArrayBuffer>) const;
292
293     void setUsesOverlayScrollbars(bool enabled);
294
295     String getCurrentCursorInfo(Document*, ExceptionCode&);
296
297     String markerTextForListItem(Element*, ExceptionCode&);
298
299     void forceReload(bool endToEnd);
300
301 #if ENABLE(ENCRYPTED_MEDIA_V2)
302     void initializeMockCDM();
303 #endif
304
305 #if ENABLE(SPEECH_SYNTHESIS)
306     void enableMockSpeechSynthesizer();
307 #endif
308
309     String getImageSourceURL(Element*, ExceptionCode&);
310
311 #if ENABLE(VIDEO)
312     void simulateAudioInterruption(Node*);
313 #endif
314
315     bool isSelectPopupVisible(Node*);
316
317     String captionsStyleSheetOverride(ExceptionCode&);
318     void setCaptionsStyleSheetOverride(const String&, ExceptionCode&);
319     void setPrimaryAudioTrackLanguageOverride(const String&, ExceptionCode&);
320     void setCaptionDisplayMode(const String&, ExceptionCode&);
321
322 #if ENABLE(VIDEO)
323     PassRefPtr<TimeRanges> createTimeRanges(Float32Array* startTimes, Float32Array* endTimes);
324     double closestTimeToTimeRanges(double time, TimeRanges*);
325 #endif
326
327     PassRefPtr<ClientRect> selectionBounds(ExceptionCode&);
328
329 private:
330     explicit Internals(Document*);
331     Document* contextDocument() const;
332     Frame* frame() const;
333     Vector<String> iconURLs(Document*, int iconTypesMask) const;
334
335     DocumentMarker* markerAt(Node*, const String& markerType, unsigned index, ExceptionCode&);
336 #if ENABLE(INSPECTOR)
337     RefPtr<DOMWindow> m_frontendWindow;
338     OwnPtr<InspectorFrontendChannelDummy> m_frontendChannel;
339 #endif
340 };
341
342 } // namespace WebCore
343
344 #endif