WebRTC: Implement MediaEndpointPeerConnection::createOffer()
[WebKit-https.git] / Source / WebCore / testing / Internals.h
1 /*
2  * Copyright (C) 2012 Google Inc. All rights reserved.
3  * Copyright (C) 2013-2015 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 "ScriptState.h"
36 #include <bindings/ScriptValue.h>
37 #include <runtime/ArrayBuffer.h>
38 #include <runtime/Float32Array.h>
39 #include <wtf/RefCounted.h>
40 #include <wtf/text/WTFString.h>
41
42 namespace WebCore {
43
44 class AudioContext;
45 class ClientRect;
46 class ClientRectList;
47 class DOMPath;
48 class DOMStringList;
49 class DOMURL;
50 class DOMWindow;
51 class Document;
52 class Element;
53 class File;
54 class Frame;
55 class HTMLMediaElement;
56 class InspectorStubFrontend;
57 class InternalSettings;
58 class MallocStatistics;
59 class MediaSession;
60 class MemoryInfo;
61 class MockPageOverlay;
62 class Node;
63 class Page;
64 class Range;
65 class RenderedDocumentMarker;
66 class ScriptExecutionContext;
67 class SerializedScriptValue;
68 class SourceBuffer;
69 class TimeRanges;
70 class TypeConversions;
71 class XMLHttpRequest;
72
73 #if ENABLE(CONTENT_FILTERING)
74 class MockContentFilterSettings;
75 #endif
76
77 typedef int ExceptionCode;
78
79 class Internals : public RefCounted<Internals>
80                 , public ContextDestructionObserver {
81 public:
82     static Ref<Internals> create(Document*);
83     virtual ~Internals();
84
85     static void resetToConsistentState(Page*);
86
87     String elementRenderTreeAsText(Element*, ExceptionCode&);
88     bool hasPausedImageAnimations(Element*, ExceptionCode&);
89
90     String address(Node*);
91     bool nodeNeedsStyleRecalc(Node*, ExceptionCode&);
92     String styleChangeType(Node*, ExceptionCode&);
93     String description(Deprecated::ScriptValue);
94
95     bool isPreloaded(const String& url);
96     bool isLoadingFromMemoryCache(const String& url);
97     String xhrResponseSource(XMLHttpRequest*);
98     bool isSharingStyleSheetContents(Element* linkA, Element* linkB);
99     bool isStyleSheetLoadingSubresources(Element* link);
100     void setOverrideCachePolicy(const String&);
101     void setCanShowModalDialogOverride(bool allow, ExceptionCode&);
102     void setOverrideResourceLoadPriority(const String&);
103     void setStrictRawResourceValidationPolicyDisabled(bool);
104
105     void clearMemoryCache();
106     void pruneMemoryCacheToSize(unsigned size);
107     unsigned memoryCacheSize() const;
108
109     size_t imageFrameIndex(Element*, ExceptionCode&);
110
111     void clearPageCache();
112     unsigned pageCacheSize() const;
113
114     RefPtr<CSSComputedStyleDeclaration> computedStyleIncludingVisitedInfo(Node*, ExceptionCode&) const;
115
116     Node* ensureShadowRoot(Element* host, ExceptionCode&);
117     Node* ensureUserAgentShadowRoot(Element* host, ExceptionCode&);
118     Node* createShadowRoot(Element* host, ExceptionCode&);
119     Node* shadowRoot(Element* host, ExceptionCode&);
120     String shadowRootType(const Node*, ExceptionCode&) const;
121     Element* includerFor(Node*, ExceptionCode&);
122     String shadowPseudoId(Element*, ExceptionCode&);
123     void setShadowPseudoId(Element*, const String&, ExceptionCode&);
124
125     // DOMTimers throttling testing.
126     bool isTimerThrottled(int timeoutId, ExceptionCode&);
127     bool isRequestAnimationFrameThrottled() const;
128     bool areTimersThrottled() const;
129
130     // Spatial Navigation testing.
131     unsigned lastSpatialNavigationCandidateCount(ExceptionCode&) const;
132
133     // CSS Animation testing.
134     unsigned numberOfActiveAnimations() const;
135     bool animationsAreSuspended(ExceptionCode&) const;
136     void suspendAnimations(ExceptionCode&) const;
137     void resumeAnimations(ExceptionCode&) const;
138     bool pauseAnimationAtTimeOnElement(const String& animationName, double pauseTime, Element*, ExceptionCode&);
139     bool pauseAnimationAtTimeOnPseudoElement(const String& animationName, double pauseTime, Element*, const String& pseudoId, ExceptionCode&);
140
141     // CSS Transition testing.
142     bool pauseTransitionAtTimeOnElement(const String& propertyName, double pauseTime, Element*, ExceptionCode&);
143     bool pauseTransitionAtTimeOnPseudoElement(const String& property, double pauseTime, Element*, const String& pseudoId, ExceptionCode&);
144
145     Node* treeScopeRootNode(Node*, ExceptionCode&);
146     Node* parentTreeScope(Node*, ExceptionCode&);
147
148     bool attached(Node*, ExceptionCode&);
149
150     String visiblePlaceholder(Element*);
151     void selectColorInColorChooser(Element*, const String& colorValue);
152     Vector<String> formControlStateOfPreviousHistoryItem(ExceptionCode&);
153     void setFormControlStateOfPreviousHistoryItem(const Vector<String>&, ExceptionCode&);
154
155     Ref<ClientRect> absoluteCaretBounds(ExceptionCode&);
156
157     Ref<ClientRect> boundingBox(Element*, ExceptionCode&);
158
159     Ref<ClientRectList> inspectorHighlightRects(ExceptionCode&);
160     String inspectorHighlightObject(ExceptionCode&);
161
162     unsigned markerCountForNode(Node*, const String&, ExceptionCode&);
163     RefPtr<Range> markerRangeForNode(Node*, const String& markerType, unsigned index, ExceptionCode&);
164     String markerDescriptionForNode(Node*, const String& markerType, unsigned index, ExceptionCode&);
165     String dumpMarkerRects(const String& markerType, ExceptionCode&);
166     void addTextMatchMarker(const Range*, bool isActive);
167     void setMarkedTextMatchesAreHighlighted(bool, ExceptionCode&);
168
169     void invalidateFontCache();
170
171     void setScrollViewPosition(long x, long y, ExceptionCode&);
172     void setViewBaseBackgroundColor(const String& colorValue, ExceptionCode&);
173
174     void setPagination(const String& mode, int gap, ExceptionCode& ec) { setPagination(mode, gap, 0, ec); }
175     void setPagination(const String& mode, int gap, int pageLength, ExceptionCode&);
176     void setPaginationLineGridEnabled(bool, ExceptionCode&);
177     String configurationForViewport(float devicePixelRatio, int deviceWidth, int deviceHeight, int availableWidth, int availableHeight, ExceptionCode&);
178
179     bool wasLastChangeUserEdit(Element* textField, ExceptionCode&);
180     bool elementShouldAutoComplete(Element* inputElement, ExceptionCode&);
181     void setEditingValue(Element* inputElement, const String&, ExceptionCode&);
182     void setAutofilled(Element*, bool enabled, ExceptionCode&);
183     void setShowAutoFillButton(Element*, const String& autoFillButtonType, ExceptionCode&);
184     void scrollElementToRect(Element*, long x, long y, long w, long h, ExceptionCode&);
185
186     String autofillFieldName(Element*, ExceptionCode&);
187
188     void paintControlTints(ExceptionCode&);
189
190     RefPtr<Range> rangeFromLocationAndLength(Element* scope, int rangeLocation, int rangeLength, ExceptionCode&);
191     unsigned locationFromRange(Element* scope, const Range*, ExceptionCode&);
192     unsigned lengthFromRange(Element* scope, const Range*, ExceptionCode&);
193     String rangeAsText(const Range*, ExceptionCode&);
194     RefPtr<Range> subrange(Range*, int rangeLocation, int rangeLength, ExceptionCode&);
195     RefPtr<Range> rangeForDictionaryLookupAtLocation(int x, int y, ExceptionCode&);
196
197     void setDelegatesScrolling(bool enabled, ExceptionCode&);
198
199     int lastSpellCheckRequestSequence(ExceptionCode&);
200     int lastSpellCheckProcessedSequence(ExceptionCode&);
201
202     Vector<String> userPreferredLanguages() const;
203     void setUserPreferredLanguages(const Vector<String>&);
204
205     Vector<String> userPreferredAudioCharacteristics() const;
206     void setUserPreferredAudioCharacteristic(const String&);
207
208     unsigned wheelEventHandlerCount(ExceptionCode&);
209     unsigned touchEventHandlerCount(ExceptionCode&);
210
211     RefPtr<NodeList> nodesFromRect(Document*, int x, int y, unsigned topPadding, unsigned rightPadding,
212         unsigned bottomPadding, unsigned leftPadding, bool ignoreClipping, bool allowShadowContent, bool allowChildFrameContent, ExceptionCode&) const;
213
214     String parserMetaData(Deprecated::ScriptValue = Deprecated::ScriptValue());
215
216     void updateEditorUINowIfScheduled();
217
218     bool hasSpellingMarker(int from, int length, ExceptionCode&);
219     bool hasGrammarMarker(int from, int length, ExceptionCode&);
220     bool hasAutocorrectedMarker(int from, int length, ExceptionCode&);
221     void setContinuousSpellCheckingEnabled(bool enabled, ExceptionCode&);
222     void setAutomaticQuoteSubstitutionEnabled(bool enabled, ExceptionCode&);
223     void setAutomaticLinkDetectionEnabled(bool enabled, ExceptionCode&);
224     void setAutomaticDashSubstitutionEnabled(bool enabled, ExceptionCode&);
225     void setAutomaticTextReplacementEnabled(bool enabled, ExceptionCode&);
226     void setAutomaticSpellingCorrectionEnabled(bool enabled, ExceptionCode&);
227
228     void handleAcceptedCandidate(const String& candidate, ExceptionCode&);
229
230     bool isOverwriteModeEnabled(ExceptionCode&);
231     void toggleOverwriteModeEnabled(ExceptionCode&);
232
233     unsigned countMatchesForText(const String&, unsigned findOptions, const String& markMatches, ExceptionCode&);
234
235     unsigned numberOfScrollableAreas(ExceptionCode&);
236
237     bool isPageBoxVisible(int pageNumber, ExceptionCode&);
238
239     static const char* internalsId;
240
241     InternalSettings* settings() const;
242     unsigned workerThreadCount() const;
243
244     void setBatteryStatus(const String& eventType, bool charging, double chargingTime, double dischargingTime, double level, ExceptionCode&);
245
246     void setDeviceProximity(const String& eventType, double value, double min, double max, ExceptionCode&);
247
248     enum {
249         // Values need to be kept in sync with Internals.idl.
250         LAYER_TREE_INCLUDES_VISIBLE_RECTS = 1,
251         LAYER_TREE_INCLUDES_TILE_CACHES = 2,
252         LAYER_TREE_INCLUDES_REPAINT_RECTS = 4,
253         LAYER_TREE_INCLUDES_PAINTING_PHASES = 8,
254         LAYER_TREE_INCLUDES_CONTENT_LAYERS = 16
255     };
256     String layerTreeAsText(Document*, unsigned flags, ExceptionCode&) const;
257     String layerTreeAsText(Document*, ExceptionCode&) const;
258     String repaintRectsAsText(ExceptionCode&) const;
259     String scrollingStateTreeAsText(ExceptionCode&) const;
260     String mainThreadScrollingReasons(ExceptionCode&) const;
261     RefPtr<ClientRectList> nonFastScrollableRects(ExceptionCode&) const;
262
263     void setElementUsesDisplayListDrawing(Element*, bool usesDisplayListDrawing, ExceptionCode&);
264     void setElementTracksDisplayListReplay(Element*, bool isTrackingReplay, ExceptionCode&);
265
266     enum {
267         // Values need to be kept in sync with Internals.idl.
268         DISPLAY_LIST_INCLUDES_PLATFORM_OPERATIONS = 1,
269     };
270     String displayListForElement(Element*, unsigned flags, ExceptionCode&);
271     String displayListForElement(Element*, ExceptionCode&);
272
273     String replayDisplayListForElement(Element*, unsigned flags, ExceptionCode&);
274     String replayDisplayListForElement(Element*, ExceptionCode&);
275
276     void garbageCollectDocumentResources(ExceptionCode&) const;
277
278     void insertAuthorCSS(const String&, ExceptionCode&) const;
279     void insertUserCSS(const String&, ExceptionCode&) const;
280
281     const ProfilesArray& consoleProfiles() const;
282
283     unsigned numberOfLiveNodes() const;
284     unsigned numberOfLiveDocuments() const;
285
286     RefPtr<DOMWindow> openDummyInspectorFrontend(const String& url);
287     void closeDummyInspectorFrontend();
288     void setLegacyJavaScriptProfilingEnabled(bool enabled, ExceptionCode&);
289     void setInspectorIsUnderTest(bool isUnderTest, ExceptionCode&);
290
291     String counterValue(Element*);
292
293     int pageNumber(Element*, float pageWidth = 800, float pageHeight = 600);
294     Vector<String> shortcutIconURLs() const;
295
296     int numberOfPages(float pageWidthInPixels = 800, float pageHeightInPixels = 600);
297     String pageProperty(String, int, ExceptionCode& = ASSERT_NO_EXCEPTION) const;
298     String pageSizeAndMarginsInPixels(int, int, int, int, int, int, int, ExceptionCode& = ASSERT_NO_EXCEPTION) const;
299
300     void setPageScaleFactor(float scaleFactor, int x, int y, ExceptionCode&);
301     void setPageZoomFactor(float zoomFactor, ExceptionCode&);
302     void setTextZoomFactor(float zoomFactor, ExceptionCode&);
303
304     void setUseFixedLayout(bool useFixedLayout, ExceptionCode&);
305     void setFixedLayoutSize(int width, int height, ExceptionCode&);
306
307     void setHeaderHeight(float);
308     void setFooterHeight(float);
309
310     void setTopContentInset(float);
311
312 #if ENABLE(FULLSCREEN_API)
313     void webkitWillEnterFullScreenForElement(Element*);
314     void webkitDidEnterFullScreenForElement(Element*);
315     void webkitWillExitFullScreenForElement(Element*);
316     void webkitDidExitFullScreenForElement(Element*);
317 #endif
318
319     WEBCORE_TESTSUPPORT_EXPORT void setApplicationCacheOriginQuota(unsigned long long);
320
321     void registerURLSchemeAsBypassingContentSecurityPolicy(const String& scheme);
322     void removeURLSchemeRegisteredAsBypassingContentSecurityPolicy(const String& scheme);
323
324     Ref<MallocStatistics> mallocStatistics() const;
325     Ref<TypeConversions> typeConversions() const;
326     Ref<MemoryInfo> memoryInfo() const;
327
328     Vector<String> getReferencedFilePaths() const;
329
330     void startTrackingRepaints(ExceptionCode&);
331     void stopTrackingRepaints(ExceptionCode&);
332
333     void startTrackingLayerFlushes(ExceptionCode&);
334     unsigned long layerFlushCount(ExceptionCode&);
335     
336     void startTrackingStyleRecalcs(ExceptionCode&);
337     unsigned long styleRecalcCount(ExceptionCode&);
338
339     void startTrackingCompositingUpdates(ExceptionCode&);
340     unsigned long compositingUpdateCount(ExceptionCode&);
341
342     void updateLayoutIgnorePendingStylesheetsAndRunPostLayoutTasks(ExceptionCode&);
343     void updateLayoutIgnorePendingStylesheetsAndRunPostLayoutTasks(Node*, ExceptionCode&);
344     unsigned layoutCount() const;
345
346     RefPtr<ArrayBuffer> serializeObject(PassRefPtr<SerializedScriptValue>) const;
347     RefPtr<SerializedScriptValue> deserializeBuffer(PassRefPtr<ArrayBuffer>) const;
348
349     bool isFromCurrentWorld(Deprecated::ScriptValue) const;
350
351     void setUsesOverlayScrollbars(bool enabled);
352     void setUsesMockScrollAnimator(bool enabled);
353
354     String getCurrentCursorInfo(ExceptionCode&);
355
356     String markerTextForListItem(Element*, ExceptionCode&);
357
358     String toolTipFromElement(Element*, ExceptionCode&) const;
359
360     void forceReload(bool endToEnd);
361
362     void enableAutoSizeMode(bool enabled, int minimumWidth, int minimumHeight, int maximumWidth, int maximumHeight);
363
364 #if ENABLE(ENCRYPTED_MEDIA_V2)
365     void initializeMockCDM();
366 #endif
367
368 #if ENABLE(SPEECH_SYNTHESIS)
369     void enableMockSpeechSynthesizer();
370 #endif
371
372 #if ENABLE(MEDIA_STREAM)
373     void enableMockMediaEndpoint();
374     void enableMockRTCPeerConnectionHandler();
375     void setMockMediaCaptureDevicesEnabled(bool);
376 #endif
377
378     String getImageSourceURL(Element*, ExceptionCode&);
379
380 #if ENABLE(VIDEO)
381     void simulateAudioInterruption(Node*);
382     bool mediaElementHasCharacteristic(Node*, const String&, ExceptionCode&);
383 #endif
384
385     bool isSelectPopupVisible(Node*);
386
387     String captionsStyleSheetOverride(ExceptionCode&);
388     void setCaptionsStyleSheetOverride(const String&, ExceptionCode&);
389     void setPrimaryAudioTrackLanguageOverride(const String&, ExceptionCode&);
390     void setCaptionDisplayMode(const String&, ExceptionCode&);
391
392 #if ENABLE(VIDEO)
393     Ref<TimeRanges> createTimeRanges(Float32Array* startTimes, Float32Array* endTimes);
394     double closestTimeToTimeRanges(double time, TimeRanges*);
395 #endif
396
397     Ref<ClientRect> selectionBounds(ExceptionCode&);
398
399 #if ENABLE(VIBRATION)
400     bool isVibrating();
401 #endif
402
403     bool isPluginUnavailabilityIndicatorObscured(Element*, ExceptionCode&);
404     bool isPluginSnapshotted(Element*, ExceptionCode&);
405
406 #if ENABLE(MEDIA_SOURCE)
407     WEBCORE_TESTSUPPORT_EXPORT void initializeMockMediaSource();
408     Vector<String> bufferedSamplesForTrackID(SourceBuffer*, const AtomicString&);
409     void setShouldGenerateTimestamps(SourceBuffer*, bool);
410 #endif
411
412 #if ENABLE(VIDEO)
413     void beginMediaSessionInterruption(const String&, ExceptionCode&);
414     void endMediaSessionInterruption(const String&);
415     void applicationDidEnterForeground() const;
416     void applicationWillEnterBackground() const;
417     void setMediaSessionRestrictions(const String& mediaType, const String& restrictions, ExceptionCode&);
418     void setMediaElementRestrictions(HTMLMediaElement*, const String& restrictions, ExceptionCode&);
419     void postRemoteControlCommand(const String&, ExceptionCode&);
420     bool elementIsBlockingDisplaySleep(Element*) const;
421 #endif
422
423 #if ENABLE(MEDIA_SESSION)
424     void sendMediaSessionStartOfInterruptionNotification(const String&);
425     void sendMediaSessionEndOfInterruptionNotification(const String&);
426     String mediaSessionCurrentState(MediaSession*) const;
427     double mediaElementPlayerVolume(HTMLMediaElement*) const;
428     void sendMediaControlEvent(const String&);
429 #endif
430
431 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
432     void setMockMediaPlaybackTargetPickerEnabled(bool);
433     void setMockMediaPlaybackTargetPickerState(const String& deviceName, const String& deviceState, ExceptionCode&);
434 #endif
435
436 #if ENABLE(WEB_AUDIO)
437     void setAudioContextRestrictions(AudioContext*, const String& restrictions, ExceptionCode&);
438 #endif
439
440     void simulateSystemSleep() const;
441     void simulateSystemWake() const;
442
443     RefPtr<MockPageOverlay> installMockPageOverlay(const String& overlayType, ExceptionCode&);
444     String pageOverlayLayerTreeAsText(ExceptionCode&) const;
445
446     void setPageMuted(bool);
447     bool isPagePlayingAudio();
448
449     void setPageDefersLoading(bool);
450
451     RefPtr<File> createFile(const String&);
452     void queueMicroTask(int);
453     bool testPreloaderSettingViewport();
454
455 #if ENABLE(CONTENT_FILTERING)
456     MockContentFilterSettings& mockContentFilterSettings();
457 #endif
458
459 #if ENABLE(CSS_SCROLL_SNAP)
460     String scrollSnapOffsets(Element*, ExceptionCode&);
461 #endif
462
463     String pathStringWithShrinkWrappedRects(Vector<double> rectComponents, double radius, ExceptionCode&);
464
465     String getCurrentMediaControlsStatusForElement(HTMLMediaElement*);
466
467     String userVisibleString(const DOMURL*);
468     void setShowAllPlugins(bool);
469
470     String resourceLoadStatisticsForOrigin(String origin);
471     void setResourceLoadStatisticsEnabled(bool);
472
473 #if ENABLE(STREAMS_API)
474     bool isReadableStreamDisturbed(ScriptState&, JSC::JSValue);
475 #endif
476
477     String composedTreeAsText(Node*);
478
479 private:
480     explicit Internals(Document*);
481     Document* contextDocument() const;
482     Frame* frame() const;
483
484     RenderedDocumentMarker* markerAt(Node*, const String& markerType, unsigned index, ExceptionCode&);
485
486     std::unique_ptr<InspectorStubFrontend> m_inspectorFrontend;
487 };
488
489 } // namespace WebCore
490
491 #endif