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