Unreviewed, rolling out r105497.
[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(AcceleratedDrawingEnabled, acceleratedDrawingEnabled, Bool, bool, false) \
70     macro(CanvasUsesAcceleratedDrawing, canvasUsesAcceleratedDrawing, Bool, bool, true) \
71     macro(CompositingBordersVisible, compositingBordersVisible, Bool, bool, false) \
72     macro(CompositingRepaintCountersVisible, compositingRepaintCountersVisible, Bool, bool, false) \
73     macro(CSSCustomFilterEnabled, cssCustomFilterEnabled, Bool, bool, true) \
74     macro(WebGLEnabled, webGLEnabled, Bool, bool, false) \
75     macro(ForceFTPDirectoryListings, forceFTPDirectoryListings, Bool, bool, false) \
76     macro(TabsToLinks, tabsToLinks, Bool, bool, DEFAULT_WEBKIT_TABSTOLINKS_ENABLED) \
77     macro(DNSPrefetchingEnabled, dnsPrefetchingEnabled, Bool, bool, false) \
78     macro(WebArchiveDebugModeEnabled, webArchiveDebugModeEnabled, Bool, bool, false) \
79     macro(LocalFileContentSniffingEnabled, localFileContentSniffingEnabled, Bool, bool, false) \
80     macro(UsesPageCache, usesPageCache, Bool, bool, true) \
81     macro(PageCacheSupportsPlugins, pageCacheSupportsPlugins, Bool, bool, true) \
82     macro(AuthorAndUserStylesEnabled, authorAndUserStylesEnabled, Bool, bool, true) \
83     macro(PaginateDuringLayoutEnabled, paginateDuringLayoutEnabled, Bool, bool, false) \
84     macro(DOMPasteAllowed, domPasteAllowed, Bool, bool, false) \
85     macro(JavaScriptCanAccessClipboard, javaScriptCanAccessClipboard, Bool, bool, false) \
86     macro(ShouldPrintBackgrounds, shouldPrintBackgrounds, Bool, bool, false) \
87     macro(FullScreenEnabled, fullScreenEnabled, Bool, bool, false) \
88     macro(WebSecurityEnabled, webSecurityEnabled, Bool, bool, true) \
89     macro(AllowUniversalAccessFromFileURLs, allowUniversalAccessFromFileURLs, Bool, bool, false) \
90     macro(AllowFileAccessFromFileURLs, allowFileAccessFromFileURLs, Bool, bool, false) \
91     macro(AVFoundationEnabled, isAVFoundationEnabled, Bool, bool, DEFAULT_WEBKIT_AVFOUNDATION_ENABLED) \
92     macro(Hixie76WebSocketProtocolEnabled, hixie76WebSocketProtocolEnabled, Bool, bool, true) \
93     macro(MediaPlaybackRequiresUserGesture, mediaPlaybackRequiresUserGesture, Bool, bool, false) \
94     macro(MediaPlaybackAllowsInline, mediaPlaybackAllowsInline, Bool, bool, true) \
95     macro(InspectorStartsAttached, inspectorStartsAttached, Bool, bool, true) \
96     macro(ShowsToolTipOverTruncatedText, showsToolTipOverTruncatedText, Bool, bool, false) \
97     macro(MockScrollbarsEnabled, mockScrollbarsEnabled, Bool, bool, false) \
98     macro(WebAudioEnabled, webAudioEnabled, Bool, bool, false) \
99     macro(ApplicationChromeModeEnabled, applicationChromeMode, Bool, bool, false) \
100     macro(SuppressIncrementalRendering, suppressIncrementalRendering, Bool, bool, false) \
101     macro(BackspaceKeyNavigationEnabled, backspaceKeyNavigationEnabled, Bool, bool, true) \
102     macro(CaretBrowsingEnabled, caretBrowsingEnabled, Bool, bool, false) \
103     macro(ShouldDisplaySubtitles, shouldDisplaySubtitles, Bool, bool, false) \
104     macro(ShouldDisplayCaptions, shouldDisplayCaptions, Bool, bool, false) \
105     macro(ShouldDisplayTextDescriptions, shouldDisplayTextDescriptions, Bool, bool, false) \
106     macro(NotificationsEnabled, notificationsEnabled, Bool, bool, true) \
107     \
108
109 #define FOR_EACH_WEBKIT_DOUBLE_PREFERENCE(macro) \
110     macro(PDFScaleFactor, pdfScaleFactor, Double, double, 0) \
111     \
112
113 #if PLATFORM(WIN)
114 #define DEFAULT_WEBKIT_FONT_SMOOTHING_LEVEL FontSmoothingLevelWindows
115 #else
116 #define DEFAULT_WEBKIT_FONT_SMOOTHING_LEVEL FontSmoothingLevelMedium
117 #endif
118
119 #define FOR_EACH_WEBKIT_UINT32_PREFERENCE(macro) \
120     macro(FontSmoothingLevel, fontSmoothingLevel, UInt32, uint32_t, DEFAULT_WEBKIT_FONT_SMOOTHING_LEVEL) \
121     macro(MinimumFontSize, minimumFontSize, UInt32, uint32_t, 0) \
122     macro(MinimumLogicalFontSize, minimumLogicalFontSize, UInt32, uint32_t, 9) \
123     macro(DefaultFontSize, defaultFontSize, UInt32, uint32_t, 16) \
124     macro(DefaultFixedFontSize, defaultFixedFontSize, UInt32, uint32_t, 13) \
125     macro(LayoutFallbackWidth, layoutFallbackWidth, UInt32, uint32_t, 980) \
126     macro(DeviceDPI, deviceDPI, UInt32, uint32_t, 240) \
127     macro(DeviceWidth, deviceWidth, UInt32, uint32_t, 480) \
128     macro(DeviceHeight, deviceHeight, UInt32, uint32_t, 854) \
129     macro(PDFDisplayMode, pdfDisplayMode, UInt32, uint32_t, 1) \
130     macro(EditableLinkBehavior, editableLinkBehavior, UInt32, uint32_t, WebCore::EditableLinkNeverLive) \
131     \
132
133 #if PLATFORM(WIN)
134
135 #define FOR_EACH_WEBKIT_FONT_FAMILY_PREFERENCE(macro) \
136     macro(StandardFontFamily, standardFontFamily, String, String, "Times New Roman") \
137     macro(CursiveFontFamily, cursiveFontFamily, String, String, "Comic Sans MS") \
138     macro(FantasyFontFamily, fantasyFontFamily, String, String, "Comic Sans MS") \
139     macro(FixedFontFamily, fixedFontFamily, String, String, "Courier New") \
140     macro(SansSerifFontFamily, sansSerifFontFamily, String, String, "Arial") \
141     macro(SerifFontFamily, serifFontFamily, String, String, "Times New Roman") \
142     macro(PictographFontFamily, pictographFontFamily, String, String, "Times New Roman") \
143     \
144
145 #elif PLATFORM(MAC)
146
147 #define FOR_EACH_WEBKIT_FONT_FAMILY_PREFERENCE(macro) \
148     macro(StandardFontFamily, standardFontFamily, String, String, "Times") \
149     macro(CursiveFontFamily, cursiveFontFamily, String, String, "Apple Chancery") \
150     macro(FantasyFontFamily, fantasyFontFamily, String, String, "Papyrus") \
151     macro(FixedFontFamily, fixedFontFamily, String, String, "Courier") \
152     macro(SansSerifFontFamily, sansSerifFontFamily, String, String, "Helvetica") \
153     macro(SerifFontFamily, serifFontFamily, String, String, "Times") \
154     macro(PictographFontFamily, pictographFontFamily, String, String, "Apple Color Emoji") \
155     \
156
157 #elif PLATFORM(QT) || PLATFORM(GTK) || PLATFORM(EFL)
158
159 #define FOR_EACH_WEBKIT_FONT_FAMILY_PREFERENCE(macro) \
160     macro(StandardFontFamily, standardFontFamily, String, String, "Times") \
161     macro(CursiveFontFamily, cursiveFontFamily, String, String, "Comic Sans MS") \
162     macro(FantasyFontFamily, fantasyFontFamily, String, String, "Impact") \
163     macro(FixedFontFamily, fixedFontFamily, String, String, "Courier New") \
164     macro(SansSerifFontFamily, sansSerifFontFamily, String, String, "Helvetica") \
165     macro(SerifFontFamily, serifFontFamily, String, String, "Times") \
166     macro(PictographFontFamily, pictographFontFamily, String, String, "Times") \
167     \
168
169 #endif
170
171 #define FOR_EACH_WEBKIT_STRING_PREFERENCE(macro) \
172     FOR_EACH_WEBKIT_FONT_FAMILY_PREFERENCE(macro) \
173     macro(DefaultTextEncodingName, defaultTextEncodingName, String, String, "ISO-8859-1") \
174     macro(FTPDirectoryTemplatePath, ftpDirectoryTemplatePath, String, String, "") \
175     \
176
177
178 #define FOR_EACH_WEBKIT_PREFERENCE(macro) \
179     FOR_EACH_WEBKIT_BOOL_PREFERENCE(macro) \
180     FOR_EACH_WEBKIT_DOUBLE_PREFERENCE(macro) \
181     FOR_EACH_WEBKIT_UINT32_PREFERENCE(macro) \
182     FOR_EACH_WEBKIT_STRING_PREFERENCE(macro) \
183     \
184
185 namespace WebPreferencesKey {
186
187 #define DECLARE_KEY_GETTERS(KeyUpper, KeyLower, TypeName, Type, DefaultValue) const String& KeyLower##Key();
188
189 FOR_EACH_WEBKIT_PREFERENCE(DECLARE_KEY_GETTERS)
190
191 #undef DECLARE_KEY_GETTERS
192
193 } // namespace WebPreferencesKey
194
195 struct WebPreferencesStore {
196     WebPreferencesStore();
197
198     void encode(CoreIPC::ArgumentEncoder*) const;
199     static bool decode(CoreIPC::ArgumentDecoder*, WebPreferencesStore&);
200
201     // NOTE: The getters in this class have non-standard names to aid in the use of the preference macros.
202
203     bool setStringValueForKey(const String& key, const String& value);
204     String getStringValueForKey(const String& key) const;
205
206     bool setBoolValueForKey(const String& key, bool value);
207     bool getBoolValueForKey(const String& key) const;
208
209     bool setUInt32ValueForKey(const String& key, uint32_t value);
210     uint32_t getUInt32ValueForKey(const String& key) const;
211
212     bool setDoubleValueForKey(const String& key, double value);
213     double getDoubleValueForKey(const String& key) const;
214
215     static void overrideXSSAuditorEnabledForTestRunner(bool);
216     static void removeTestRunnerOverrides();
217
218     HashMap<String, String> m_stringValues;
219     HashMap<String, bool> m_boolValues;
220     HashMap<String, uint32_t> m_uint32Values;
221     HashMap<String, double> m_doubleValues;
222 };
223
224 } // namespace WebKit
225
226 #endif // WebPreferencesStore_h