https://bugs.webkit.org/show_bug.cgi?id=81258
[WebKit-https.git] / Source / WebKit2 / Shared / WebPreferencesStore.h
1 /*
2  * Copyright (C) 2010, 2011 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef WebPreferencesStore_h
27 #define WebPreferencesStore_h
28
29 #include "ArgumentDecoder.h"
30 #include "ArgumentEncoder.h"
31 #include <wtf/HashMap.h>
32 #include <wtf/text/StringHash.h>
33 #include <wtf/text/WTFString.h>
34
35 namespace WebKit {
36
37 // macro(KeyUpper, KeyLower, TypeNameUpper, TypeName, DefaultValue) 
38
39 #if PLATFORM(WIN)
40 #define DEFAULT_WEBKIT_AVFOUNDATION_ENABLED false
41 #else
42 #define DEFAULT_WEBKIT_AVFOUNDATION_ENABLED true
43 #endif
44
45 #if PLATFORM(GTK)
46 #define DEFAULT_WEBKIT_TABSTOLINKS_ENABLED true
47 #else
48 #define DEFAULT_WEBKIT_TABSTOLINKS_ENABLED false
49 #endif
50
51 #define FOR_EACH_WEBKIT_BOOL_PREFERENCE(macro) \
52     macro(JavaScriptEnabled, javaScriptEnabled, Bool, bool, true) \
53     macro(LoadsImagesAutomatically, loadsImagesAutomatically, Bool, bool, true) \
54     macro(LoadsSiteIconsIgnoringImageLoadingPreference, loadsSiteIconsIgnoringImageLoadingPreference, Bool, bool, false) \
55     macro(PluginsEnabled, pluginsEnabled, Bool, bool, true) \
56     macro(JavaEnabled, javaEnabled, Bool, bool, true) \
57     macro(OfflineWebApplicationCacheEnabled, offlineWebApplicationCacheEnabled, Bool, bool, false) \
58     macro(LocalStorageEnabled, localStorageEnabled, Bool, bool, true) \
59     macro(DatabasesEnabled, databasesEnabled, Bool, bool, true) \
60     macro(XSSAuditorEnabled, xssAuditorEnabled, Bool, bool, true) \
61     macro(FrameFlatteningEnabled, frameFlatteningEnabled, Bool, bool, false) \
62     macro(DeveloperExtrasEnabled, developerExtrasEnabled, Bool, bool, false) \
63     macro(PrivateBrowsingEnabled, privateBrowsingEnabled, Bool, bool, false) \
64     macro(TextAreasAreResizable, textAreasAreResizable, Bool, bool, true) \
65     macro(JavaScriptCanOpenWindowsAutomatically, javaScriptCanOpenWindowsAutomatically, Bool, bool, true) \
66     macro(HyperlinkAuditingEnabled, hyperlinkAuditingEnabled, Bool, bool, true) \
67     macro(NeedsSiteSpecificQuirks, needsSiteSpecificQuirks, Bool, bool, false) \
68     macro(AcceleratedCompositingEnabled, acceleratedCompositingEnabled, Bool, bool, true) \
69     macro(ForceCompositingMode, forceCompositingMode, Bool, bool, false) \
70     macro(AcceleratedDrawingEnabled, acceleratedDrawingEnabled, Bool, bool, false) \
71     macro(CanvasUsesAcceleratedDrawing, canvasUsesAcceleratedDrawing, Bool, bool, true) \
72     macro(CompositingBordersVisible, compositingBordersVisible, Bool, bool, false) \
73     macro(CompositingRepaintCountersVisible, compositingRepaintCountersVisible, Bool, bool, false) \
74     macro(CSSCustomFilterEnabled, cssCustomFilterEnabled, Bool, bool, true) \
75     macro(WebGLEnabled, webGLEnabled, Bool, bool, false) \
76     macro(CSSRegionsEnabled, cssRegionsEnabled, Bool, bool, true) \
77     macro(RegionBasedColumnsEnabled, regionBasedColumnsEnabled, Bool, bool, false) \
78     macro(ForceFTPDirectoryListings, forceFTPDirectoryListings, Bool, bool, false) \
79     macro(TabsToLinks, tabsToLinks, Bool, bool, DEFAULT_WEBKIT_TABSTOLINKS_ENABLED) \
80     macro(DNSPrefetchingEnabled, dnsPrefetchingEnabled, Bool, bool, false) \
81     macro(WebArchiveDebugModeEnabled, webArchiveDebugModeEnabled, Bool, bool, false) \
82     macro(LocalFileContentSniffingEnabled, localFileContentSniffingEnabled, Bool, bool, false) \
83     macro(UsesPageCache, usesPageCache, Bool, bool, true) \
84     macro(PageCacheSupportsPlugins, pageCacheSupportsPlugins, Bool, bool, true) \
85     macro(AuthorAndUserStylesEnabled, authorAndUserStylesEnabled, Bool, bool, true) \
86     macro(PaginateDuringLayoutEnabled, paginateDuringLayoutEnabled, Bool, bool, false) \
87     macro(DOMPasteAllowed, domPasteAllowed, Bool, bool, false) \
88     macro(JavaScriptCanAccessClipboard, javaScriptCanAccessClipboard, Bool, bool, false) \
89     macro(ShouldPrintBackgrounds, shouldPrintBackgrounds, Bool, bool, false) \
90     macro(FullScreenEnabled, fullScreenEnabled, Bool, bool, false) \
91     macro(WebSecurityEnabled, webSecurityEnabled, Bool, bool, true) \
92     macro(AllowUniversalAccessFromFileURLs, allowUniversalAccessFromFileURLs, Bool, bool, false) \
93     macro(AllowFileAccessFromFileURLs, allowFileAccessFromFileURLs, Bool, bool, false) \
94     macro(AVFoundationEnabled, isAVFoundationEnabled, Bool, bool, DEFAULT_WEBKIT_AVFOUNDATION_ENABLED) \
95     macro(Hixie76WebSocketProtocolEnabled, hixie76WebSocketProtocolEnabled, Bool, bool, false) \
96     macro(MediaPlaybackRequiresUserGesture, mediaPlaybackRequiresUserGesture, Bool, bool, false) \
97     macro(MediaPlaybackAllowsInline, mediaPlaybackAllowsInline, Bool, bool, true) \
98     macro(InspectorStartsAttached, inspectorStartsAttached, Bool, bool, true) \
99     macro(InspectorUsesWebKitUserInterface, inspectorUsesWebKitUserInterface, Bool, bool, false) \
100     macro(ShowsToolTipOverTruncatedText, showsToolTipOverTruncatedText, Bool, bool, false) \
101     macro(MockScrollbarsEnabled, mockScrollbarsEnabled, Bool, bool, false) \
102     macro(WebAudioEnabled, webAudioEnabled, Bool, bool, false) \
103     macro(ApplicationChromeModeEnabled, applicationChromeMode, Bool, bool, false) \
104     macro(SuppressesIncrementalRendering, suppressesIncrementalRendering, Bool, bool, false) \
105     macro(BackspaceKeyNavigationEnabled, backspaceKeyNavigationEnabled, Bool, bool, true) \
106     macro(CaretBrowsingEnabled, caretBrowsingEnabled, Bool, bool, false) \
107     macro(ShouldDisplaySubtitles, shouldDisplaySubtitles, Bool, bool, false) \
108     macro(ShouldDisplayCaptions, shouldDisplayCaptions, Bool, bool, false) \
109     macro(ShouldDisplayTextDescriptions, shouldDisplayTextDescriptions, Bool, bool, false) \
110     macro(NotificationsEnabled, notificationsEnabled, Bool, bool, true) \
111     \
112
113 #define FOR_EACH_WEBKIT_DOUBLE_PREFERENCE(macro) \
114     macro(PDFScaleFactor, pdfScaleFactor, Double, double, 0) \
115     \
116
117 #if PLATFORM(WIN)
118 #define DEFAULT_WEBKIT_FONT_SMOOTHING_LEVEL FontSmoothingLevelWindows
119 #else
120 #define DEFAULT_WEBKIT_FONT_SMOOTHING_LEVEL FontSmoothingLevelMedium
121 #endif
122
123 #define FOR_EACH_WEBKIT_UINT32_PREFERENCE(macro) \
124     macro(FontSmoothingLevel, fontSmoothingLevel, UInt32, uint32_t, DEFAULT_WEBKIT_FONT_SMOOTHING_LEVEL) \
125     macro(MinimumFontSize, minimumFontSize, UInt32, uint32_t, 0) \
126     macro(MinimumLogicalFontSize, minimumLogicalFontSize, UInt32, uint32_t, 9) \
127     macro(DefaultFontSize, defaultFontSize, UInt32, uint32_t, 16) \
128     macro(DefaultFixedFontSize, defaultFixedFontSize, UInt32, uint32_t, 13) \
129     macro(LayoutFallbackWidth, layoutFallbackWidth, UInt32, uint32_t, 980) \
130     macro(DeviceDPI, deviceDPI, UInt32, uint32_t, 240) \
131     macro(DeviceWidth, deviceWidth, UInt32, uint32_t, 480) \
132     macro(DeviceHeight, deviceHeight, UInt32, uint32_t, 854) \
133     macro(PDFDisplayMode, pdfDisplayMode, UInt32, uint32_t, 1) \
134     macro(EditableLinkBehavior, editableLinkBehavior, UInt32, uint32_t, WebCore::EditableLinkNeverLive) \
135     macro(InspectorAttachedHeight, inspectorAttachedHeight, UInt32, uint32_t, 300) \
136     \
137
138 #if PLATFORM(WIN)
139
140 #define FOR_EACH_WEBKIT_FONT_FAMILY_PREFERENCE(macro) \
141     macro(StandardFontFamily, standardFontFamily, String, String, "Times New Roman") \
142     macro(CursiveFontFamily, cursiveFontFamily, String, String, "Comic Sans MS") \
143     macro(FantasyFontFamily, fantasyFontFamily, String, String, "Comic Sans MS") \
144     macro(FixedFontFamily, fixedFontFamily, String, String, "Courier New") \
145     macro(SansSerifFontFamily, sansSerifFontFamily, String, String, "Arial") \
146     macro(SerifFontFamily, serifFontFamily, String, String, "Times New Roman") \
147     macro(PictographFontFamily, pictographFontFamily, String, String, "Times New Roman") \
148     \
149
150 #elif PLATFORM(MAC)
151
152 #define FOR_EACH_WEBKIT_FONT_FAMILY_PREFERENCE(macro) \
153     macro(StandardFontFamily, standardFontFamily, String, String, "Times") \
154     macro(CursiveFontFamily, cursiveFontFamily, String, String, "Apple Chancery") \
155     macro(FantasyFontFamily, fantasyFontFamily, String, String, "Papyrus") \
156     macro(FixedFontFamily, fixedFontFamily, String, String, "Courier") \
157     macro(SansSerifFontFamily, sansSerifFontFamily, String, String, "Helvetica") \
158     macro(SerifFontFamily, serifFontFamily, String, String, "Times") \
159     macro(PictographFontFamily, pictographFontFamily, String, String, "Apple Color Emoji") \
160     \
161
162 #elif PLATFORM(QT) || PLATFORM(GTK) || PLATFORM(EFL)
163
164 #define FOR_EACH_WEBKIT_FONT_FAMILY_PREFERENCE(macro) \
165     macro(StandardFontFamily, standardFontFamily, String, String, "Times") \
166     macro(CursiveFontFamily, cursiveFontFamily, String, String, "Comic Sans MS") \
167     macro(FantasyFontFamily, fantasyFontFamily, String, String, "Impact") \
168     macro(FixedFontFamily, fixedFontFamily, String, String, "Courier New") \
169     macro(SansSerifFontFamily, sansSerifFontFamily, String, String, "Helvetica") \
170     macro(SerifFontFamily, serifFontFamily, String, String, "Times") \
171     macro(PictographFontFamily, pictographFontFamily, String, String, "Times") \
172     \
173
174 #endif
175
176 #define FOR_EACH_WEBKIT_STRING_PREFERENCE(macro) \
177     FOR_EACH_WEBKIT_FONT_FAMILY_PREFERENCE(macro) \
178     macro(DefaultTextEncodingName, defaultTextEncodingName, String, String, "ISO-8859-1") \
179     macro(FTPDirectoryTemplatePath, ftpDirectoryTemplatePath, String, String, "") \
180     \
181
182
183 #define FOR_EACH_WEBKIT_PREFERENCE(macro) \
184     FOR_EACH_WEBKIT_BOOL_PREFERENCE(macro) \
185     FOR_EACH_WEBKIT_DOUBLE_PREFERENCE(macro) \
186     FOR_EACH_WEBKIT_UINT32_PREFERENCE(macro) \
187     FOR_EACH_WEBKIT_STRING_PREFERENCE(macro) \
188     \
189
190 namespace WebPreferencesKey {
191
192 #define DECLARE_KEY_GETTERS(KeyUpper, KeyLower, TypeName, Type, DefaultValue) const String& KeyLower##Key();
193
194 FOR_EACH_WEBKIT_PREFERENCE(DECLARE_KEY_GETTERS)
195
196 #undef DECLARE_KEY_GETTERS
197
198 } // namespace WebPreferencesKey
199
200 struct WebPreferencesStore {
201     WebPreferencesStore();
202
203     void encode(CoreIPC::ArgumentEncoder*) const;
204     static bool decode(CoreIPC::ArgumentDecoder*, WebPreferencesStore&);
205
206     // NOTE: The getters in this class have non-standard names to aid in the use of the preference macros.
207
208     bool setStringValueForKey(const String& key, const String& value);
209     String getStringValueForKey(const String& key) const;
210
211     bool setBoolValueForKey(const String& key, bool value);
212     bool getBoolValueForKey(const String& key) const;
213
214     bool setUInt32ValueForKey(const String& key, uint32_t value);
215     uint32_t getUInt32ValueForKey(const String& key) const;
216
217     bool setDoubleValueForKey(const String& key, double value);
218     double getDoubleValueForKey(const String& key) const;
219
220     // For WebKitTestRunner usage.
221     static void overrideBoolValueForKey(const String& key, bool value);
222     static void removeTestRunnerOverrides();
223
224     HashMap<String, String> m_stringValues;
225     HashMap<String, bool> m_boolValues;
226     HashMap<String, uint32_t> m_uint32Values;
227     HashMap<String, double> m_doubleValues;
228 };
229
230 } // namespace WebKit
231
232 #endif // WebPreferencesStore_h