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