Message decoding functions should take a MessageDecoder reference
[WebKit-https.git] / Source / WebKit2 / Shared / WebPreferencesStore.h
1 /*
2  * Copyright (C) 2010, 2011, 2012 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(GTK)
40 #define DEFAULT_WEBKIT_TABSTOLINKS_ENABLED true
41 #else
42 #define DEFAULT_WEBKIT_TABSTOLINKS_ENABLED false
43 #endif
44
45 #if ENABLE(SMOOTH_SCROLLING) && !PLATFORM(QT)
46 #define DEFAULT_WEBKIT_SCROLL_ANIMATOR_ENABLED true
47 #else
48 #define DEFAULT_WEBKIT_SCROLL_ANIMATOR_ENABLED false
49 #endif
50
51 #if PLATFORM(MAC) && __MAC_OS_X_VERSION_MIN_REQUIRED >= 1090
52 #define DEFAULT_SCREEN_FONT_SUBSTITUTION_ENABLED false
53 #else
54 #define DEFAULT_SCREEN_FONT_SUBSTITUTION_ENABLED true
55 #endif
56
57 #define FOR_EACH_WEBKIT_BOOL_PREFERENCE(macro) \
58     macro(JavaScriptEnabled, javaScriptEnabled, Bool, bool, true) \
59     macro(LoadsImagesAutomatically, loadsImagesAutomatically, Bool, bool, true) \
60     macro(LoadsSiteIconsIgnoringImageLoadingPreference, loadsSiteIconsIgnoringImageLoadingPreference, Bool, bool, false) \
61     macro(PluginsEnabled, pluginsEnabled, Bool, bool, true) \
62     macro(JavaEnabled, javaEnabled, Bool, bool, true) \
63     macro(JavaEnabledForLocalFiles, javaEnabledForLocalFiles, Bool, bool, true) \
64     macro(OfflineWebApplicationCacheEnabled, offlineWebApplicationCacheEnabled, Bool, bool, false) \
65     macro(LocalStorageEnabled, localStorageEnabled, Bool, bool, true) \
66     macro(DatabasesEnabled, databasesEnabled, Bool, bool, true) \
67     macro(XSSAuditorEnabled, xssAuditorEnabled, Bool, bool, true) \
68     macro(FrameFlatteningEnabled, frameFlatteningEnabled, Bool, bool, false) \
69     macro(DeveloperExtrasEnabled, developerExtrasEnabled, Bool, bool, false) \
70     macro(JavaScriptExperimentsEnabled, javaScriptExperimentsEnabled, Bool, bool, false) \
71     macro(PrivateBrowsingEnabled, privateBrowsingEnabled, Bool, bool, false) \
72     macro(TextAreasAreResizable, textAreasAreResizable, Bool, bool, true) \
73     macro(JavaScriptCanOpenWindowsAutomatically, javaScriptCanOpenWindowsAutomatically, Bool, bool, true) \
74     macro(HyperlinkAuditingEnabled, hyperlinkAuditingEnabled, Bool, bool, true) \
75     macro(NeedsSiteSpecificQuirks, needsSiteSpecificQuirks, Bool, bool, false) \
76     macro(AcceleratedCompositingEnabled, acceleratedCompositingEnabled, Bool, bool, true) \
77     macro(ForceCompositingMode, forceCompositingMode, Bool, bool, false) \
78     macro(AcceleratedDrawingEnabled, acceleratedDrawingEnabled, Bool, bool, false) \
79     macro(CanvasUsesAcceleratedDrawing, canvasUsesAcceleratedDrawing, Bool, bool, true) \
80     macro(CompositingBordersVisible, compositingBordersVisible, Bool, bool, false) \
81     macro(CompositingRepaintCountersVisible, compositingRepaintCountersVisible, Bool, bool, false) \
82     macro(TiledScrollingIndicatorVisible, tiledScrollingIndicatorVisible, Bool, bool, false) \
83     macro(CSSCustomFilterEnabled, cssCustomFilterEnabled, Bool, bool, true) \
84     macro(WebGLEnabled, webGLEnabled, Bool, bool, false) \
85     macro(Accelerated2dCanvasEnabled, accelerated2dCanvasEnabled, Bool, bool, false) \
86     macro(CSSRegionsEnabled, cssRegionsEnabled, Bool, bool, true) \
87     macro(CSSGridLayoutEnabled, cssGridLayoutEnabled, Bool, bool, false) \
88     macro(RegionBasedColumnsEnabled, regionBasedColumnsEnabled, Bool, bool, false) \
89     macro(ForceFTPDirectoryListings, forceFTPDirectoryListings, Bool, bool, false) \
90     macro(TabsToLinks, tabsToLinks, Bool, bool, DEFAULT_WEBKIT_TABSTOLINKS_ENABLED) \
91     macro(DNSPrefetchingEnabled, dnsPrefetchingEnabled, Bool, bool, false) \
92     macro(WebArchiveDebugModeEnabled, webArchiveDebugModeEnabled, Bool, bool, false) \
93     macro(LocalFileContentSniffingEnabled, localFileContentSniffingEnabled, Bool, bool, false) \
94     macro(UsesPageCache, usesPageCache, Bool, bool, true) \
95     macro(PageCacheSupportsPlugins, pageCacheSupportsPlugins, Bool, bool, true) \
96     macro(AuthorAndUserStylesEnabled, authorAndUserStylesEnabled, Bool, bool, true) \
97     macro(PaginateDuringLayoutEnabled, paginateDuringLayoutEnabled, Bool, bool, false) \
98     macro(DOMPasteAllowed, domPasteAllowed, Bool, bool, false) \
99     macro(JavaScriptCanAccessClipboard, javaScriptCanAccessClipboard, Bool, bool, false) \
100     macro(ShouldPrintBackgrounds, shouldPrintBackgrounds, Bool, bool, false) \
101     macro(FullScreenEnabled, fullScreenEnabled, Bool, bool, false) \
102     macro(WebSecurityEnabled, webSecurityEnabled, Bool, bool, true) \
103     macro(AllowUniversalAccessFromFileURLs, allowUniversalAccessFromFileURLs, Bool, bool, false) \
104     macro(AllowFileAccessFromFileURLs, allowFileAccessFromFileURLs, Bool, bool, false) \
105     macro(AVFoundationEnabled, isAVFoundationEnabled, Bool, bool, true) \
106     macro(MediaPlaybackRequiresUserGesture, mediaPlaybackRequiresUserGesture, Bool, bool, false) \
107     macro(MediaPlaybackAllowsInline, mediaPlaybackAllowsInline, Bool, bool, true) \
108     macro(InspectorStartsAttached, inspectorStartsAttached, Bool, bool, true) \
109     macro(InspectorUsesWebKitUserInterface, inspectorUsesWebKitUserInterface, Bool, bool, false) \
110     macro(ShowsToolTipOverTruncatedText, showsToolTipOverTruncatedText, Bool, bool, false) \
111     macro(MockScrollbarsEnabled, mockScrollbarsEnabled, Bool, bool, false) \
112     macro(WebAudioEnabled, webAudioEnabled, Bool, bool, false) \
113     macro(ApplicationChromeModeEnabled, applicationChromeMode, Bool, bool, false) \
114     macro(SuppressesIncrementalRendering, suppressesIncrementalRendering, Bool, bool, false) \
115     macro(BackspaceKeyNavigationEnabled, backspaceKeyNavigationEnabled, Bool, bool, true) \
116     macro(CaretBrowsingEnabled, caretBrowsingEnabled, Bool, bool, false) \
117     macro(ShouldDisplaySubtitles, shouldDisplaySubtitles, Bool, bool, false) \
118     macro(ShouldDisplayCaptions, shouldDisplayCaptions, Bool, bool, false) \
119     macro(ShouldDisplayTextDescriptions, shouldDisplayTextDescriptions, Bool, bool, false) \
120     macro(NotificationsEnabled, notificationsEnabled, Bool, bool, true) \
121     macro(ShouldRespectImageOrientation, shouldRespectImageOrientation, Bool, bool, false) \
122     macro(WantsBalancedSetDefersLoadingBehavior, wantsBalancedSetDefersLoadingBehavior, Bool, bool, false) \
123     macro(RequestAnimationFrameEnabled, requestAnimationFrameEnabled, Bool, bool, true) \
124     macro(DiagnosticLoggingEnabled, diagnosticLoggingEnabled, Bool, bool, false) \
125     macro(AsynchronousPluginInitializationEnabled, asynchronousPluginInitializationEnabled, Bool, bool, false) \
126     macro(AsynchronousPluginInitializationEnabledForAllPlugins, asynchronousPluginInitializationEnabledForAllPlugins, Bool, bool, false) \
127     macro(ArtificialPluginInitializationDelayEnabled, artificialPluginInitializationDelayEnabled, Bool, bool, false) \
128     macro(TabToLinksEnabled, tabToLinksEnabled, Bool, bool, false) \
129     macro(InteractiveFormValidationEnabled, interactiveFormValidationEnabled, Bool, bool, false) \
130     macro(ScrollingPerformanceLoggingEnabled, scrollingPerformanceLoggingEnabled, Bool, bool, false) \
131     macro(StorageBlockingPolicy, storageBlockingPolicy, UInt32, uint32_t, 0) \
132     macro(ScrollAnimatorEnabled, scrollAnimatorEnabled, Bool, bool, DEFAULT_WEBKIT_SCROLL_ANIMATOR_ENABLED) \
133     macro(ScreenFontSubstitutionEnabled, screenFontSubstitutionEnabled, Bool, bool, DEFAULT_SCREEN_FONT_SUBSTITUTION_ENABLED) \
134     macro(CookieEnabled, cookieEnabled, Bool, bool, true) \
135     macro(PlugInSnapshottingEnabled, plugInSnapshottingEnabled, Bool, bool, false) \
136     macro(PDFPluginEnabled, pdfPluginEnabled, Bool, bool, false) \
137     macro(UsesEncodingDetector, usesEncodingDetector, Bool, bool, false) \
138     macro(TextAutosizingEnabled, textAutosizingEnabled, Bool, bool, false) \
139     macro(AggressiveTileRetentionEnabled, aggressiveTileRetentionEnabled, Bool, bool, false) \
140     macro(QTKitEnabled, isQTKitEnabled, Bool, bool, true) \
141     macro(LogsPageMessagesToSystemConsoleEnabled, logsPageMessagesToSystemConsoleEnabled, Bool, bool, false) \
142     macro(PageVisibilityBasedProcessSuppressionEnabled, pageVisibilityBasedProcessSuppressionEnabled, Bool, bool, false) \
143     \
144
145 #define FOR_EACH_WEBKIT_DOUBLE_PREFERENCE(macro) \
146     macro(PDFScaleFactor, pdfScaleFactor, Double, double, 0) \
147     \
148
149 #define FOR_EACH_WEBKIT_FLOAT_PREFERENCE(macro) \
150     \
151
152 #define FOR_EACH_WEBKIT_UINT32_PREFERENCE(macro) \
153     macro(FontSmoothingLevel, fontSmoothingLevel, UInt32, uint32_t, FontSmoothingLevelMedium) \
154     macro(MinimumFontSize, minimumFontSize, UInt32, uint32_t, 0) \
155     macro(MinimumLogicalFontSize, minimumLogicalFontSize, UInt32, uint32_t, 9) \
156     macro(DefaultFontSize, defaultFontSize, UInt32, uint32_t, 16) \
157     macro(DefaultFixedFontSize, defaultFixedFontSize, UInt32, uint32_t, 13) \
158     macro(LayoutFallbackWidth, layoutFallbackWidth, UInt32, uint32_t, 980) \
159     macro(DeviceWidth, deviceWidth, UInt32, uint32_t, 0) \
160     macro(DeviceHeight, deviceHeight, UInt32, uint32_t, 0) \
161     macro(PDFDisplayMode, pdfDisplayMode, UInt32, uint32_t, 1) \
162     macro(EditableLinkBehavior, editableLinkBehavior, UInt32, uint32_t, WebCore::EditableLinkNeverLive) \
163     macro(InspectorAttachedHeight, inspectorAttachedHeight, UInt32, uint32_t, 300) \
164     \
165
166 #if PLATFORM(MAC)
167
168 #define FOR_EACH_WEBKIT_FONT_FAMILY_PREFERENCE(macro) \
169     macro(StandardFontFamily, standardFontFamily, String, String, "Times") \
170     macro(CursiveFontFamily, cursiveFontFamily, String, String, "Apple Chancery") \
171     macro(FantasyFontFamily, fantasyFontFamily, String, String, "Papyrus") \
172     macro(FixedFontFamily, fixedFontFamily, String, String, "Courier") \
173     macro(SansSerifFontFamily, sansSerifFontFamily, String, String, "Helvetica") \
174     macro(SerifFontFamily, serifFontFamily, String, String, "Times") \
175     macro(PictographFontFamily, pictographFontFamily, String, String, "Apple Color Emoji") \
176     \
177
178 #elif PLATFORM(QT) || PLATFORM(GTK) || PLATFORM(EFL)
179
180 #define FOR_EACH_WEBKIT_FONT_FAMILY_PREFERENCE(macro) \
181     macro(StandardFontFamily, standardFontFamily, String, String, "Times") \
182     macro(CursiveFontFamily, cursiveFontFamily, String, String, "Comic Sans MS") \
183     macro(FantasyFontFamily, fantasyFontFamily, String, String, "Impact") \
184     macro(FixedFontFamily, fixedFontFamily, String, String, "Courier New") \
185     macro(SansSerifFontFamily, sansSerifFontFamily, String, String, "Helvetica") \
186     macro(SerifFontFamily, serifFontFamily, String, String, "Times") \
187     macro(PictographFontFamily, pictographFontFamily, String, String, "Times") \
188     \
189
190 #endif
191
192 #define FOR_EACH_WEBKIT_STRING_PREFERENCE(macro) \
193     FOR_EACH_WEBKIT_FONT_FAMILY_PREFERENCE(macro) \
194     macro(DefaultTextEncodingName, defaultTextEncodingName, String, String, "ISO-8859-1") \
195     macro(FTPDirectoryTemplatePath, ftpDirectoryTemplatePath, String, String, "") \
196     \
197
198
199 #define FOR_EACH_WEBKIT_PREFERENCE(macro) \
200     FOR_EACH_WEBKIT_BOOL_PREFERENCE(macro) \
201     FOR_EACH_WEBKIT_DOUBLE_PREFERENCE(macro) \
202     FOR_EACH_WEBKIT_FLOAT_PREFERENCE(macro) \
203     FOR_EACH_WEBKIT_UINT32_PREFERENCE(macro) \
204     FOR_EACH_WEBKIT_STRING_PREFERENCE(macro) \
205     \
206
207 namespace WebPreferencesKey {
208
209 #define DECLARE_KEY_GETTERS(KeyUpper, KeyLower, TypeName, Type, DefaultValue) const String& KeyLower##Key();
210
211 FOR_EACH_WEBKIT_PREFERENCE(DECLARE_KEY_GETTERS)
212
213 #undef DECLARE_KEY_GETTERS
214
215 } // namespace WebPreferencesKey
216
217 struct WebPreferencesStore {
218     WebPreferencesStore();
219
220     void encode(CoreIPC::ArgumentEncoder&) const;
221     static bool decode(CoreIPC::ArgumentDecoder&, WebPreferencesStore&);
222
223     // NOTE: The getters in this class have non-standard names to aid in the use of the preference macros.
224
225     bool setStringValueForKey(const String& key, const String& value);
226     String getStringValueForKey(const String& key) const;
227
228     bool setBoolValueForKey(const String& key, bool value);
229     bool getBoolValueForKey(const String& key) const;
230
231     bool setUInt32ValueForKey(const String& key, uint32_t value);
232     uint32_t getUInt32ValueForKey(const String& key) const;
233
234     bool setDoubleValueForKey(const String& key, double value);
235     double getDoubleValueForKey(const String& key) const;
236
237     bool setFloatValueForKey(const String& key, float value);
238     float getFloatValueForKey(const String& key) const;
239
240     // For WebKitTestRunner usage.
241     static void overrideBoolValueForKey(const String& key, bool value);
242     static void removeTestRunnerOverrides();
243
244     HashMap<String, String> m_stringValues;
245     HashMap<String, bool> m_boolValues;
246     HashMap<String, uint32_t> m_uint32Values;
247     HashMap<String, double> m_doubleValues;
248     HashMap<String, float> m_floatValues;
249 };
250
251 } // namespace WebKit
252
253 #endif // WebPreferencesStore_h