[Cocoa] Deactivate the audio session before the WebProcess suspends.
[WebKit-https.git] / Source / WebCore / testing / InternalSettings.h
1 /*
2  * Copyright (C) 2012 Google Inc. All rights reserved.
3  * Copyright (C) 2013-2016 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 #pragma once
28
29 // FIXME (121927): This include should not be needed.
30 #include <wtf/text/AtomicStringHash.h>
31
32 #include "EditingBehaviorTypes.h"
33 #include "ExceptionOr.h"
34 #include "FontGenericFamilies.h"
35 #include "IntSize.h"
36 #include "InternalSettingsGenerated.h"
37 #include "SecurityOrigin.h"
38 #include "Settings.h"
39 #include "WritingMode.h"
40
41 namespace WebCore {
42
43 class Page;
44 class Settings;
45
46 class InternalSettings : public InternalSettingsGenerated {
47 public:
48     static Ref<InternalSettings> create(Page*);
49     static InternalSettings* from(Page*);
50     void hostDestroyed();
51     void resetToConsistentState();
52
53     ExceptionOr<void> setUsesOverlayScrollbars(bool);
54     ExceptionOr<void> setTouchEventEmulationEnabled(bool);
55     ExceptionOr<void> setStandardFontFamily(const String& family, const String& script);
56     ExceptionOr<void> setSerifFontFamily(const String& family, const String& script);
57     ExceptionOr<void> setSansSerifFontFamily(const String& family, const String& script);
58     ExceptionOr<void> setFixedFontFamily(const String& family, const String& script);
59     ExceptionOr<void> setCursiveFontFamily(const String& family, const String& script);
60     ExceptionOr<void> setFantasyFontFamily(const String& family, const String& script);
61     ExceptionOr<void> setPictographFontFamily(const String& family, const String& script);
62     ExceptionOr<void> setTextAutosizingEnabled(bool);
63     ExceptionOr<void> setTextAutosizingWindowSizeOverride(int width, int height);
64     ExceptionOr<void> setTextAutosizingFontScaleFactor(float);
65     ExceptionOr<void> setMediaTypeOverride(const String&);
66     ExceptionOr<void> setCanStartMedia(bool);
67     ExceptionOr<void> setAllowsAirPlayForMediaPlayback(bool);
68     ExceptionOr<void> setMediaCaptureRequiresSecureConnection(bool);
69
70     ExceptionOr<void> setEditingBehavior(const String&);
71     ExceptionOr<void> setPreferMIMETypeForImages(bool);
72     ExceptionOr<void> setPDFImageCachingPolicy(const String&);
73     ExceptionOr<void> setShouldDisplayTrackKind(const String& kind, bool enabled);
74     ExceptionOr<bool> shouldDisplayTrackKind(const String& kind);
75     ExceptionOr<void> setUseDarkAppearance(bool);
76     ExceptionOr<void> setStorageBlockingPolicy(const String&);
77     ExceptionOr<void> setImagesEnabled(bool);
78     ExceptionOr<void> setMinimumTimerInterval(double intervalInSeconds);
79     ExceptionOr<void> setDefaultVideoPosterURL(const String&);
80     ExceptionOr<void> setForcePendingWebGLPolicy(bool);
81     ExceptionOr<void> setTimeWithoutMouseMovementBeforeHidingControls(double);
82     ExceptionOr<void> setUseLegacyBackgroundSizeShorthandBehavior(bool);
83     ExceptionOr<void> setAutoscrollForDragAndDropEnabled(bool);
84     ExceptionOr<void> setFontFallbackPrefersPictographs(bool);
85     enum class FontLoadTimingOverride { Block, Swap, Failure };
86     ExceptionOr<void> setFontLoadTimingOverride(const FontLoadTimingOverride&);
87     ExceptionOr<void> setShouldIgnoreFontLoadCompletions(bool);
88     ExceptionOr<void> setQuickTimePluginReplacementEnabled(bool);
89     ExceptionOr<void> setYouTubeFlashPluginReplacementEnabled(bool);
90     ExceptionOr<void> setBackgroundShouldExtendBeyondPage(bool);
91     ExceptionOr<void> setShouldConvertPositionStyleOnCopy(bool);
92     ExceptionOr<void> setScrollingTreeIncludesFrames(bool);
93     ExceptionOr<void> setAllowUnclampedScrollPosition(bool);
94     ExceptionOr<void> setAllowsInlineMediaPlayback(bool);
95     ExceptionOr<void> setAllowsInlineMediaPlaybackAfterFullscreen(bool);
96     ExceptionOr<void> setInlineMediaPlaybackRequiresPlaysInlineAttribute(bool);
97     ExceptionOr<String> userInterfaceDirectionPolicy();
98     ExceptionOr<void> setUserInterfaceDirectionPolicy(const String&);
99     ExceptionOr<String> systemLayoutDirection();
100     ExceptionOr<void> setSystemLayoutDirection(const String&);
101     ExceptionOr<void> setShouldMockBoldSystemFontForAccessibility(bool);
102     ExceptionOr<void> setShouldManageAudioSessionCategory(bool);
103     ExceptionOr<void> setCustomPasteboardDataEnabled(bool);
104     ExceptionOr<void> setAccessibilityEventsEnabled(bool);
105     ExceptionOr<void> setIncompleteImageBorderEnabled(bool);
106
107     using FrameFlatteningValue = FrameFlattening;
108     ExceptionOr<void> setFrameFlattening(FrameFlatteningValue);
109     
110     static void setAllowsAnySSLCertificate(bool);
111
112     ExceptionOr<bool> deferredCSSParserEnabled();
113     ExceptionOr<void> setDeferredCSSParserEnabled(bool);
114
115     enum class ForcedAccessibilityValue { System, On, Off };
116     ForcedAccessibilityValue forcedColorsAreInvertedAccessibilityValue() const;
117     void setForcedColorsAreInvertedAccessibilityValue(ForcedAccessibilityValue);
118     ForcedAccessibilityValue forcedDisplayIsMonochromeAccessibilityValue() const;
119     void setForcedDisplayIsMonochromeAccessibilityValue(ForcedAccessibilityValue);
120     ForcedAccessibilityValue forcedPrefersReducedMotionAccessibilityValue() const;
121     void setForcedPrefersReducedMotionAccessibilityValue(ForcedAccessibilityValue);
122
123     // RuntimeEnabledFeatures.
124     static void setIndexedDBWorkersEnabled(bool);
125     static void setWebGL2Enabled(bool);
126     static void setWebGPUEnabled(bool);
127     static void setWebVREnabled(bool);
128     static void setScreenCaptureEnabled(bool);
129
130     static bool webAnimationsCSSIntegrationEnabled();
131
132     void setShouldDeactivateAudioSession(bool);
133
134 private:
135     explicit InternalSettings(Page*);
136
137     Settings& settings() const;
138     static const char* supplementName();
139
140     class Backup {
141     public:
142         explicit Backup(Settings&);
143         void restoreTo(Settings&);
144
145         EditingBehaviorType m_originalEditingBehavior;
146
147         // Initially empty, only used if changed by a test.
148         ScriptFontFamilyMap m_standardFontFamilies;
149         ScriptFontFamilyMap m_fixedFontFamilies;
150         ScriptFontFamilyMap m_serifFontFamilies;
151         ScriptFontFamilyMap m_sansSerifFontFamilies;
152         ScriptFontFamilyMap m_cursiveFontFamilies;
153         ScriptFontFamilyMap m_fantasyFontFamilies;
154         ScriptFontFamilyMap m_pictographFontFamilies;
155
156 #if ENABLE(TEXT_AUTOSIZING)
157         bool m_originalTextAutosizingEnabled;
158         IntSize m_originalTextAutosizingWindowSizeOverride;
159 #endif
160
161         String m_originalMediaTypeOverride;
162         bool m_originalCanvasUsesAcceleratedDrawing;
163         bool m_originalMockScrollbarsEnabled;
164         bool m_originalUsesOverlayScrollbars;
165         bool m_imagesEnabled;
166         bool m_preferMIMETypeForImages;
167         Seconds m_minimumDOMTimerInterval;
168 #if ENABLE(VIDEO_TRACK)
169         bool m_shouldDisplaySubtitles;
170         bool m_shouldDisplayCaptions;
171         bool m_shouldDisplayTextDescriptions;
172 #endif
173         String m_defaultVideoPosterURL;
174         bool m_forcePendingWebGLPolicy;
175         Seconds m_originalTimeWithoutMouseMovementBeforeHidingControls;
176         bool m_useLegacyBackgroundSizeShorthandBehavior;
177         bool m_autoscrollForDragAndDropEnabled;
178         bool m_quickTimePluginReplacementEnabled;
179         bool m_youTubeFlashPluginReplacementEnabled;
180         bool m_shouldConvertPositionStyleOnCopy;
181         bool m_fontFallbackPrefersPictographs;
182         bool m_shouldIgnoreFontLoadCompletions;
183         bool m_backgroundShouldExtendBeyondPage;
184         SecurityOrigin::StorageBlockingPolicy m_storageBlockingPolicy;
185         bool m_scrollingTreeIncludesFrames;
186 #if ENABLE(TOUCH_EVENTS)
187         bool m_touchEventEmulationEnabled;
188 #endif
189 #if ENABLE(WIRELESS_PLAYBACK_TARGET)
190         bool m_allowsAirPlayForMediaPlayback;
191 #endif
192         bool m_allowsInlineMediaPlayback;
193         bool m_allowsInlineMediaPlaybackAfterFullscreen;
194         bool m_inlineMediaPlaybackRequiresPlaysInlineAttribute;
195         bool m_deferredCSSParserEnabled;
196         bool m_inputEventsEnabled;
197         bool m_incompleteImageBorderEnabled;
198 #if ENABLE(ACCESSIBILITY_EVENTS)
199         bool m_accessibilityEventsEnabled;
200 #endif
201         bool m_shouldDeactivateAudioSession;
202         UserInterfaceDirectionPolicy m_userInterfaceDirectionPolicy;
203         TextDirection m_systemLayoutDirection;
204         PDFImageCachingPolicy m_pdfImageCachingPolicy;
205         Settings::ForcedAccessibilityValue m_forcedColorsAreInvertedAccessibilityValue;
206         Settings::ForcedAccessibilityValue m_forcedDisplayIsMonochromeAccessibilityValue;
207         Settings::ForcedAccessibilityValue m_forcedPrefersReducedMotionAccessibilityValue;
208         Settings::FontLoadTimingOverride m_fontLoadTimingOverride;
209         FrameFlattening m_frameFlattening;
210
211         // Runtime enabled settings.
212         bool m_indexedDBWorkersEnabled;
213         bool m_webGL2Enabled;
214         bool m_webVREnabled;
215         bool m_setScreenCaptureEnabled;
216         
217         bool m_shouldMockBoldSystemFontForAccessibility;
218 #if USE(AUDIO_SESSION)
219         bool m_shouldManageAudioSessionCategory;
220 #endif
221         bool m_customPasteboardDataEnabled;
222     };
223
224     Page* m_page;
225     Backup m_backup;
226 };
227
228 } // namespace WebCore