Clean up DOMTimer related settings
[WebKit-https.git] / Source / WebCore / page / Settings.h
1 /*
2  * Copyright (C) 2003, 2006, 2007, 2008, 2009, 2011, 2012, 2013 Apple Inc. All rights reserved.
3  *           (C) 2006 Graham Dennis (graham.dennis@gmail.com)
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  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
25  */
26
27 #ifndef Settings_h
28 #define Settings_h
29
30 #include "EditingBehaviorTypes.h"
31 #include "FontRenderingMode.h"
32 #include "IntSize.h"
33 #include "URL.h"
34 #include "SecurityOrigin.h"
35 #include "SettingsMacros.h"
36 #include "Timer.h"
37 #include <chrono>
38 #include <runtime/RuntimeFlags.h>
39 #include <unicode/uscript.h>
40 #include <wtf/HashMap.h>
41 #include <wtf/RefCounted.h>
42 #include <wtf/text/AtomicString.h>
43 #include <wtf/text/AtomicStringHash.h>
44
45 namespace WebCore {
46
47 class FontGenericFamilies;
48 class Page;
49
50 enum EditableLinkBehavior {
51     EditableLinkDefaultBehavior,
52     EditableLinkAlwaysLive,
53     EditableLinkOnlyLiveWithShiftKey,
54     EditableLinkLiveWhenNotFocused,
55     EditableLinkNeverLive
56 };
57
58 enum TextDirectionSubmenuInclusionBehavior {
59     TextDirectionSubmenuNeverIncluded,
60     TextDirectionSubmenuAutomaticallyIncluded,
61     TextDirectionSubmenuAlwaysIncluded
62 };
63
64 enum DebugOverlayRegionFlags {
65     NonFastScrollableRegion = 1 << 0,
66     WheelEventHandlerRegion = 1 << 1,
67 };
68
69 typedef unsigned DebugOverlayRegions;
70
71 class Settings : public RefCounted<Settings> {
72     WTF_MAKE_NONCOPYABLE(Settings); WTF_MAKE_FAST_ALLOCATED;
73 public:
74     static PassRefPtr<Settings> create(Page*);
75     ~Settings();
76
77     void pageDestroyed() { m_page = nullptr; }
78
79     WEBCORE_EXPORT void setStandardFontFamily(const AtomicString&, UScriptCode = USCRIPT_COMMON);
80     WEBCORE_EXPORT const AtomicString& standardFontFamily(UScriptCode = USCRIPT_COMMON) const;
81
82     WEBCORE_EXPORT void setFixedFontFamily(const AtomicString&, UScriptCode = USCRIPT_COMMON);
83     WEBCORE_EXPORT const AtomicString& fixedFontFamily(UScriptCode = USCRIPT_COMMON) const;
84
85     WEBCORE_EXPORT void setSerifFontFamily(const AtomicString&, UScriptCode = USCRIPT_COMMON);
86     WEBCORE_EXPORT const AtomicString& serifFontFamily(UScriptCode = USCRIPT_COMMON) const;
87
88     WEBCORE_EXPORT void setSansSerifFontFamily(const AtomicString&, UScriptCode = USCRIPT_COMMON);
89     WEBCORE_EXPORT const AtomicString& sansSerifFontFamily(UScriptCode = USCRIPT_COMMON) const;
90
91     WEBCORE_EXPORT void setCursiveFontFamily(const AtomicString&, UScriptCode = USCRIPT_COMMON);
92     WEBCORE_EXPORT const AtomicString& cursiveFontFamily(UScriptCode = USCRIPT_COMMON) const;
93
94     WEBCORE_EXPORT void setFantasyFontFamily(const AtomicString&, UScriptCode = USCRIPT_COMMON);
95     WEBCORE_EXPORT const AtomicString& fantasyFontFamily(UScriptCode = USCRIPT_COMMON) const;
96
97     WEBCORE_EXPORT void setPictographFontFamily(const AtomicString&, UScriptCode = USCRIPT_COMMON);
98     WEBCORE_EXPORT const AtomicString& pictographFontFamily(UScriptCode = USCRIPT_COMMON) const;
99
100 #if ENABLE(TEXT_AUTOSIZING)
101     void setTextAutosizingEnabled(bool);
102     bool textAutosizingEnabled() const { return m_textAutosizingEnabled; }
103
104     void setTextAutosizingFontScaleFactor(float);
105     float textAutosizingFontScaleFactor() const { return m_textAutosizingFontScaleFactor; }
106
107     // Only set by Layout Tests, and only used if textAutosizingEnabled() returns true.
108     void setTextAutosizingWindowSizeOverride(const IntSize&);
109     const IntSize& textAutosizingWindowSizeOverride() const { return m_textAutosizingWindowSizeOverride; }
110 #endif
111
112     // Only set by Layout Tests.
113     WEBCORE_EXPORT void setMediaTypeOverride(const String&);
114     const String& mediaTypeOverride() const { return m_mediaTypeOverride; }
115
116     // Unlike areImagesEnabled, this only suppresses the network load of
117     // the image URL.  A cached image will still be rendered if requested.
118     WEBCORE_EXPORT void setLoadsImagesAutomatically(bool);
119     bool loadsImagesAutomatically() const { return m_loadsImagesAutomatically; }
120
121     // Clients that execute script should call ScriptController::canExecuteScripts()
122     // instead of this function. ScriptController::canExecuteScripts() checks the
123     // HTML sandbox, plug-in sandboxing, and other important details.
124     bool isScriptEnabled() const { return m_isScriptEnabled; }
125     WEBCORE_EXPORT void setScriptEnabled(bool);
126
127     SETTINGS_GETTERS_AND_SETTERS
128
129     WEBCORE_EXPORT void setJavaEnabled(bool);
130     bool isJavaEnabled() const { return m_isJavaEnabled; }
131
132     // This settings is only consulted if isJavaEnabled() returns true;
133     WEBCORE_EXPORT void setJavaEnabledForLocalFiles(bool);
134     bool isJavaEnabledForLocalFiles() const { return m_isJavaEnabledForLocalFiles; }
135
136     WEBCORE_EXPORT void setImagesEnabled(bool);
137     bool areImagesEnabled() const { return m_areImagesEnabled; }
138
139     WEBCORE_EXPORT void setPluginsEnabled(bool);
140     bool arePluginsEnabled() const { return m_arePluginsEnabled; }
141
142     // When this option is set, WebCore will avoid storing any record of browsing activity
143     // that may persist on disk or remain displayed when the option is reset.
144     // This option does not affect the storage of such information in RAM.
145     // The following functions respect this setting:
146     //  - HTML5/DOM Storage
147     //  - Icon Database
148     //  - Console Messages
149     //  - MemoryCache
150     //  - Application Cache
151     //  - Back/Forward Page History
152     //  - Page Search Results
153     //  - HTTP Cookies
154     //  - Plug-ins (that support NPNVprivateModeBool)
155     void setPrivateBrowsingEnabled(bool);
156
157     WEBCORE_EXPORT void setDNSPrefetchingEnabled(bool);
158     bool dnsPrefetchingEnabled() const { return m_dnsPrefetchingEnabled; }
159
160     WEBCORE_EXPORT void setUserStyleSheetLocation(const URL&);
161     const URL& userStyleSheetLocation() const { return m_userStyleSheetLocation; }
162
163     WEBCORE_EXPORT void setNeedsAdobeFrameReloadingQuirk(bool);
164     bool needsAcrobatFrameReloadingQuirk() const { return m_needsAdobeFrameReloadingQuirk; }
165
166     WEBCORE_EXPORT void setMinimumDOMTimerInterval(double); // Initialized to DOMTimer::defaultMinimumInterval().
167     WEBCORE_EXPORT double minimumDOMTimerInterval() const { return m_minimumDOMTimerInterval; }
168
169     void setDOMTimerAlignmentInterval(double);
170     double domTimerAlignmentInterval() const { return m_domTimerAlignmentInterval; }
171
172     WEBCORE_EXPORT void setLayoutInterval(std::chrono::milliseconds);
173     std::chrono::milliseconds layoutInterval() const { return m_layoutInterval; }
174
175 #if ENABLE(HIDDEN_PAGE_DOM_TIMER_THROTTLING)
176     bool hiddenPageDOMTimerThrottlingEnabled() const { return m_hiddenPageDOMTimerThrottlingEnabled; }
177     WEBCORE_EXPORT void setHiddenPageDOMTimerThrottlingEnabled(bool);
178 #endif
179
180     WEBCORE_EXPORT void setUsesPageCache(bool);
181     bool usesPageCache() const { return m_usesPageCache; }
182         
183     void setFontRenderingMode(FontRenderingMode mode);
184     FontRenderingMode fontRenderingMode() const;
185
186     WEBCORE_EXPORT void setShowTiledScrollingIndicator(bool);
187     bool showTiledScrollingIndicator() const { return m_showTiledScrollingIndicator; }
188
189 #if PLATFORM(WIN)
190     static void setShouldUseHighResolutionTimers(bool);
191     static bool shouldUseHighResolutionTimers() { return gShouldUseHighResolutionTimers; }
192 #endif
193
194     WEBCORE_EXPORT void setBackgroundShouldExtendBeyondPage(bool);
195     bool backgroundShouldExtendBeyondPage() const { return m_backgroundShouldExtendBeyondPage; }
196
197 #if USE(AVFOUNDATION)
198     WEBCORE_EXPORT static void setAVFoundationEnabled(bool flag);
199     static bool isAVFoundationEnabled() { return gAVFoundationEnabled; }
200 #endif
201
202 #if PLATFORM(COCOA)
203     WEBCORE_EXPORT static void setQTKitEnabled(bool flag);
204     static bool isQTKitEnabled() { return gQTKitEnabled; }
205 #endif
206
207     static const unsigned defaultMaximumHTMLParserDOMTreeDepth = 512;
208
209     WEBCORE_EXPORT static void setMockScrollbarsEnabled(bool flag);
210     WEBCORE_EXPORT static bool mockScrollbarsEnabled();
211
212     WEBCORE_EXPORT static void setUsesOverlayScrollbars(bool flag);
213     static bool usesOverlayScrollbars();
214
215 #if ENABLE(TOUCH_EVENTS)
216     void setTouchEventEmulationEnabled(bool enabled) { m_touchEventEmulationEnabled = enabled; }
217     bool isTouchEventEmulationEnabled() const { return m_touchEventEmulationEnabled; }
218 #endif
219
220     WEBCORE_EXPORT void setStorageBlockingPolicy(SecurityOrigin::StorageBlockingPolicy);
221     SecurityOrigin::StorageBlockingPolicy storageBlockingPolicy() const { return m_storageBlockingPolicy; }
222
223     WEBCORE_EXPORT void setScrollingPerformanceLoggingEnabled(bool);
224     bool scrollingPerformanceLoggingEnabled() { return m_scrollingPerformanceLoggingEnabled; }
225
226     WEBCORE_EXPORT static void setShouldRespectPriorityInCSSAttributeSetters(bool);
227     static bool shouldRespectPriorityInCSSAttributeSetters();
228
229     void setTimeWithoutMouseMovementBeforeHidingControls(double time) { m_timeWithoutMouseMovementBeforeHidingControls = time; }
230     double timeWithoutMouseMovementBeforeHidingControls() const { return m_timeWithoutMouseMovementBeforeHidingControls; }
231
232     bool hiddenPageCSSAnimationSuspensionEnabled() const { return m_hiddenPageCSSAnimationSuspensionEnabled; }
233     WEBCORE_EXPORT void setHiddenPageCSSAnimationSuspensionEnabled(bool);
234
235     WEBCORE_EXPORT void setFontFallbackPrefersPictographs(bool);
236     bool fontFallbackPrefersPictographs() const { return m_fontFallbackPrefersPictographs; }
237
238     static bool lowPowerVideoAudioBufferSizeEnabled() { return gLowPowerVideoAudioBufferSizeEnabled; }
239     WEBCORE_EXPORT static void setLowPowerVideoAudioBufferSizeEnabled(bool);
240
241 #if PLATFORM(IOS)
242     WEBCORE_EXPORT static void setAudioSessionCategoryOverride(unsigned);
243     static unsigned audioSessionCategoryOverride();
244
245     WEBCORE_EXPORT static void setNetworkDataUsageTrackingEnabled(bool);
246     static bool networkDataUsageTrackingEnabled();
247
248     WEBCORE_EXPORT static void setNetworkInterfaceName(const String&);
249     static const String& networkInterfaceName();
250
251     static void setAVKitEnabled(bool flag) { gAVKitEnabled = flag; }
252     static bool avKitEnabled() { return gAVKitEnabled; }
253
254     static void setShouldOptOutOfNetworkStateObservation(bool flag) { gShouldOptOutOfNetworkStateObservation = flag; }
255     static bool shouldOptOutOfNetworkStateObservation() { return gShouldOptOutOfNetworkStateObservation; }
256
257     static void setShouldManageAudioSessionCategory(bool flag) { gManageAudioSession = flag; }
258     static bool shouldManageAudioSessionCategory() { return gManageAudioSession; }
259 #endif
260
261 #if ENABLE(ENCRYPTED_MEDIA_V2)
262     void setMediaKeysStorageDirectory(const String& directory) { m_mediaKeysStorageDirectory = directory; }
263     const String& mediaKeysStorageDirectory() const { return m_mediaKeysStorageDirectory; }
264 #endif
265
266 private:
267     explicit Settings(Page*);
268
269     void initializeDefaultFontFamilies();
270
271     Page* m_page;
272
273     String m_mediaTypeOverride;
274     URL m_userStyleSheetLocation;
275     const std::unique_ptr<FontGenericFamilies> m_fontGenericFamilies;
276     SecurityOrigin::StorageBlockingPolicy m_storageBlockingPolicy;
277     std::chrono::milliseconds m_layoutInterval;
278     double m_minimumDOMTimerInterval;
279     double m_domTimerAlignmentInterval;
280
281 #if ENABLE(TEXT_AUTOSIZING)
282     float m_textAutosizingFontScaleFactor;
283     IntSize m_textAutosizingWindowSizeOverride;
284     bool m_textAutosizingEnabled : 1;
285 #endif
286
287     SETTINGS_MEMBER_VARIABLES
288
289     bool m_isJavaEnabled : 1;
290     bool m_isJavaEnabledForLocalFiles : 1;
291     bool m_loadsImagesAutomatically : 1;
292     bool m_areImagesEnabled : 1;
293     bool m_arePluginsEnabled : 1;
294     bool m_isScriptEnabled : 1;
295     bool m_needsAdobeFrameReloadingQuirk : 1;
296     bool m_usesPageCache : 1;
297     unsigned m_fontRenderingMode : 1;
298     bool m_showTiledScrollingIndicator : 1;
299     bool m_backgroundShouldExtendBeyondPage : 1;
300     bool m_dnsPrefetchingEnabled : 1;
301
302 #if ENABLE(TOUCH_EVENTS)
303     bool m_touchEventEmulationEnabled : 1;
304 #endif
305     bool m_scrollingPerformanceLoggingEnabled : 1;
306
307     double m_timeWithoutMouseMovementBeforeHidingControls;
308
309     Timer m_setImageLoadingSettingsTimer;
310     void imageLoadingSettingsTimerFired();
311
312 #if ENABLE(HIDDEN_PAGE_DOM_TIMER_THROTTLING)
313     bool m_hiddenPageDOMTimerThrottlingEnabled : 1;
314 #endif
315     bool m_hiddenPageCSSAnimationSuspensionEnabled : 1;
316     bool m_fontFallbackPrefersPictographs : 1;
317
318 #if USE(AVFOUNDATION)
319     WEBCORE_EXPORT static bool gAVFoundationEnabled;
320 #endif
321
322 #if PLATFORM(COCOA)
323     WEBCORE_EXPORT static bool gQTKitEnabled;
324 #endif
325         
326     static bool gMockScrollbarsEnabled;
327     static bool gUsesOverlayScrollbars;
328
329 #if PLATFORM(WIN)
330     static bool gShouldUseHighResolutionTimers;
331 #endif
332     static bool gShouldRespectPriorityInCSSAttributeSetters;
333 #if PLATFORM(IOS)
334     static bool gNetworkDataUsageTrackingEnabled;
335     WEBCORE_EXPORT static bool gAVKitEnabled;
336     WEBCORE_EXPORT static bool gShouldOptOutOfNetworkStateObservation;
337     WEBCORE_EXPORT static bool gManageAudioSession;
338 #endif
339
340 #if ENABLE(ENCRYPTED_MEDIA_V2)
341     String m_mediaKeysStorageDirectory;
342 #endif
343
344     static bool gLowPowerVideoAudioBufferSizeEnabled;
345 };
346
347 } // namespace WebCore
348
349 #endif