7b9555d85010718f93df822717456f3d5eb29e71
[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 #define FOR_EACH_WEBKIT_BOOL_PREFERENCE(macro) \
46     macro(JavaScriptEnabled, javaScriptEnabled, Bool, bool, true) \
47     macro(LoadsImagesAutomatically, loadsImagesAutomatically, Bool, bool, true) \
48     macro(LoadsSiteIconsIgnoringImageLoadingPreference, loadsSiteIconsIgnoringImageLoadingPreference, Bool, bool, false) \
49     macro(PluginsEnabled, pluginsEnabled, Bool, bool, true) \
50     macro(JavaEnabled, javaEnabled, Bool, bool, true) \
51     macro(OfflineWebApplicationCacheEnabled, offlineWebApplicationCacheEnabled, Bool, bool, false) \
52     macro(LocalStorageEnabled, localStorageEnabled, Bool, bool, true) \
53     macro(DatabasesEnabled, databasesEnabled, Bool, bool, true) \
54     macro(XSSAuditorEnabled, xssAuditorEnabled, Bool, bool, true) \
55     macro(FrameFlatteningEnabled, frameFlatteningEnabled, Bool, bool, false) \
56     macro(DeveloperExtrasEnabled, developerExtrasEnabled, Bool, bool, false) \
57     macro(PrivateBrowsingEnabled, privateBrowsingEnabled, Bool, bool, false) \
58     macro(TextAreasAreResizable, textAreasAreResizable, Bool, bool, true) \
59     macro(JavaScriptCanOpenWindowsAutomatically, javaScriptCanOpenWindowsAutomatically, Bool, bool, true) \
60     macro(HyperlinkAuditingEnabled, hyperlinkAuditingEnabled, Bool, bool, true) \
61     macro(NeedsSiteSpecificQuirks, needsSiteSpecificQuirks, Bool, bool, false) \
62     macro(AcceleratedCompositingEnabled, acceleratedCompositingEnabled, Bool, bool, true) \
63     macro(AcceleratedDrawingEnabled, acceleratedDrawingEnabled, Bool, bool, false) \
64     macro(CanvasUsesAcceleratedDrawing, canvasUsesAcceleratedDrawing, Bool, bool, true) \
65     macro(CompositingBordersVisible, compositingBordersVisible, Bool, bool, false) \
66     macro(CompositingRepaintCountersVisible, compositingRepaintCountersVisible, Bool, bool, false) \
67     macro(WebGLEnabled, webGLEnabled, Bool, bool, false) \
68     macro(ForceFTPDirectoryListings, forceFTPDirectoryListings, Bool, bool, false) \
69     macro(TabsToLinks, tabsToLinks, Bool, bool, false) \
70     macro(DNSPrefetchingEnabled, dnsPrefetchingEnabled, Bool, bool, false) \
71     macro(WebArchiveDebugModeEnabled, webArchiveDebugModeEnabled, Bool, bool, false) \
72     macro(LocalFileContentSniffingEnabled, localFileContentSniffingEnabled, Bool, bool, false) \
73     macro(UsesPageCache, usesPageCache, Bool, bool, true) \
74     macro(AuthorAndUserStylesEnabled, authorAndUserStylesEnabled, Bool, bool, true) \
75     macro(PaginateDuringLayoutEnabled, paginateDuringLayoutEnabled, Bool, bool, false) \
76     macro(DOMPasteAllowed, domPasteAllowed, Bool, bool, false) \
77     macro(JavaScriptCanAccessClipboard, javaScriptCanAccessClipboard, Bool, bool, false) \
78     macro(ShouldPrintBackgrounds, shouldPrintBackgrounds, Bool, bool, false) \
79     macro(FullScreenEnabled, fullScreenEnabled, Bool, bool, false) \
80     macro(WebSecurityEnabled, webSecurityEnabled, Bool, bool, true) \
81     macro(AllowUniversalAccessFromFileURLs, allowUniversalAccessFromFileURLs, Bool, bool, false) \
82     macro(AllowFileAccessFromFileURLs, allowFileAccessFromFileURLs, Bool, bool, false) \
83     macro(AVFoundationEnabled, isAVFoundationEnabled, Bool, bool, DEFAULT_WEBKIT_AVFOUNDATION_ENABLED) \
84     macro(Hixie76WebSocketProtocolEnabled, hixie76WebSocketProtocolEnabled, Bool, bool, true) \
85     macro(MediaPlaybackRequiresUserGesture, mediaPlaybackRequiresUserGesture, Bool, bool, false) \
86     macro(MediaPlaybackAllowsInline, mediaPlaybackAllowsInline, Bool, bool, true) \
87     macro(InspectorStartsAttached, inspectorStartsAttached, Bool, bool, true) \
88     macro(ShowsToolTipOverTruncatedText, showsToolTipOverTruncatedText, Bool, bool, false) \
89     \
90
91 #define FOR_EACH_WEBKIT_DOUBLE_PREFERENCE(macro) \
92     macro(PDFScaleFactor, pdfScaleFactor, Double, double, 0) \
93     \
94
95 #if PLATFORM(WIN)
96 #define DEFAULT_WEBKIT_FONT_SMOOTHING_LEVEL FontSmoothingLevelWindows
97 #else
98 #define DEFAULT_WEBKIT_FONT_SMOOTHING_LEVEL FontSmoothingLevelMedium
99 #endif
100
101 #define FOR_EACH_WEBKIT_UINT32_PREFERENCE(macro) \
102     macro(FontSmoothingLevel, fontSmoothingLevel, UInt32, uint32_t, DEFAULT_WEBKIT_FONT_SMOOTHING_LEVEL) \
103     macro(MinimumFontSize, minimumFontSize, UInt32, uint32_t, 0) \
104     macro(MinimumLogicalFontSize, minimumLogicalFontSize, UInt32, uint32_t, 9) \
105     macro(DefaultFontSize, defaultFontSize, UInt32, uint32_t, 16) \
106     macro(DefaultFixedFontSize, defaultFixedFontSize, UInt32, uint32_t, 13) \
107     macro(LayoutFallbackWidth, layoutFallbackWidth, UInt32, uint32_t, 980) \
108     macro(DeviceDPI, deviceDPI, UInt32, uint32_t, 240) \
109     macro(DeviceWidth, deviceWidth, UInt32, uint32_t, 480) \
110     macro(DeviceHeight, deviceHeight, UInt32, uint32_t, 854) \
111     macro(PDFDisplayMode, pdfDisplayMode, UInt32, uint32_t, 1) \
112     macro(EditableLinkBehavior, editableLinkBehavior, UInt32, uint32_t, WebCore::EditableLinkNeverLive) \
113     \
114
115 #if PLATFORM(WIN)
116
117 #define FOR_EACH_WEBKIT_FONT_FAMILY_PREFERENCE(macro) \
118     macro(StandardFontFamily, standardFontFamily, String, String, "Times New Roman") \
119     macro(CursiveFontFamily, cursiveFontFamily, String, String, "Comic Sans MS") \
120     macro(FantasyFontFamily, fantasyFontFamily, String, String, "Comic Sans MS") \
121     macro(FixedFontFamily, fixedFontFamily, String, String, "Courier New") \
122     macro(SansSerifFontFamily, sansSerifFontFamily, String, String, "Arial") \
123     macro(SerifFontFamily, serifFontFamily, String, String, "Times New Roman") \
124     macro(PictographFontFamily, pictographFontFamily, String, String, "Times New Roman") \
125     \
126
127 #elif PLATFORM(MAC)
128
129 #define FOR_EACH_WEBKIT_FONT_FAMILY_PREFERENCE(macro) \
130     macro(StandardFontFamily, standardFontFamily, String, String, "Times") \
131     macro(CursiveFontFamily, cursiveFontFamily, String, String, "Apple Chancery") \
132     macro(FantasyFontFamily, fantasyFontFamily, String, String, "Papyrus") \
133     macro(FixedFontFamily, fixedFontFamily, String, String, "Courier") \
134     macro(SansSerifFontFamily, sansSerifFontFamily, String, String, "Helvetica") \
135     macro(SerifFontFamily, serifFontFamily, String, String, "Times") \
136     macro(PictographFontFamily, pictographFontFamily, String, String, "Apple Color Emoji") \
137     \
138
139 #elif PLATFORM(QT) || PLATFORM(GTK)
140
141 #define FOR_EACH_WEBKIT_FONT_FAMILY_PREFERENCE(macro) \
142     macro(StandardFontFamily, standardFontFamily, String, String, "Times") \
143     macro(CursiveFontFamily, cursiveFontFamily, String, String, "Comic Sans MS") \
144     macro(FantasyFontFamily, fantasyFontFamily, String, String, "Impact") \
145     macro(FixedFontFamily, fixedFontFamily, String, String, "Courier New") \
146     macro(SansSerifFontFamily, sansSerifFontFamily, String, String, "Helvetica") \
147     macro(SerifFontFamily, serifFontFamily, String, String, "Times") \
148     macro(PictographFontFamily, pictographFontFamily, String, String, "Times") \
149     \
150
151 #endif
152
153 #define FOR_EACH_WEBKIT_STRING_PREFERENCE(macro) \
154     FOR_EACH_WEBKIT_FONT_FAMILY_PREFERENCE(macro) \
155     macro(DefaultTextEncodingName, defaultTextEncodingName, String, String, "ISO-8859-1") \
156     macro(FTPDirectoryTemplatePath, ftpDirectoryTemplatePath, String, String, "") \
157     \
158
159
160 #define FOR_EACH_WEBKIT_PREFERENCE(macro) \
161     FOR_EACH_WEBKIT_BOOL_PREFERENCE(macro) \
162     FOR_EACH_WEBKIT_DOUBLE_PREFERENCE(macro) \
163     FOR_EACH_WEBKIT_UINT32_PREFERENCE(macro) \
164     FOR_EACH_WEBKIT_STRING_PREFERENCE(macro) \
165     \
166
167 namespace WebPreferencesKey {
168
169 #define DECLARE_KEY_GETTERS(KeyUpper, KeyLower, TypeName, Type, DefaultValue) const String& KeyLower##Key();
170
171     FOR_EACH_WEBKIT_PREFERENCE(DECLARE_KEY_GETTERS)
172
173 #undef DECLARE_KEY_GETTERS
174
175 } // namespace WebPreferencesKey
176
177 struct WebPreferencesStore {
178     WebPreferencesStore();
179
180     void encode(CoreIPC::ArgumentEncoder* encoder) const;
181     static bool decode(CoreIPC::ArgumentDecoder*, WebPreferencesStore&);
182
183     // NOTE: The getters in this class have non-standard names to aid in the use of the preference macros.
184
185     bool setStringValueForKey(const String& key, const String& value);
186     String getStringValueForKey(const String& key) const;
187
188     bool setBoolValueForKey(const String& key, bool value);
189     bool getBoolValueForKey(const String& key) const;
190
191     bool setUInt32ValueForKey(const String& key, uint32_t value);
192     uint32_t getUInt32ValueForKey(const String& key) const;
193
194     bool setDoubleValueForKey(const String& key, double value);
195     double getDoubleValueForKey(const String& key) const;
196
197     static void overrideXSSAuditorEnabledForTestRunner(bool);
198     static void removeTestRunnerOverrides();
199
200     HashMap<String, String> m_stringValues;
201     HashMap<String, bool> m_boolValues;
202     HashMap<String, uint32_t> m_uint32Values;
203     HashMap<String, double> m_doubleValues;
204 };
205
206 } // namespace WebKit
207
208 #endif // WebPreferencesStore_h