2011-03-08 Jer Noble <jer.noble@apple.com>
[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 #define FOR_EACH_WEBKIT_BOOL_PREFERENCE(macro) \
40     macro(JavaScriptEnabled, javaScriptEnabled, Bool, bool, true) \
41     macro(LoadsImagesAutomatically, loadsImagesAutomatically, Bool, bool, true) \
42     macro(PluginsEnabled, pluginsEnabled, Bool, bool, true) \
43     macro(JavaEnabled, javaEnabled, Bool, bool, true) \
44     macro(OfflineWebApplicationCacheEnabled, offlineWebApplicationCacheEnabled, Bool, bool, false) \
45     macro(LocalStorageEnabled, localStorageEnabled, Bool, bool, true) \
46     macro(DatabasesEnabled, databasesEnabled, Bool, bool, true) \
47     macro(XSSAuditorEnabled, xssAuditorEnabled, Bool, bool, true) \
48     macro(FrameFlatteningEnabled, frameFlatteningEnabled, Bool, bool, false) \
49     macro(DeveloperExtrasEnabled, developerExtrasEnabled, Bool, bool, false) \
50     macro(PrivateBrowsingEnabled, privateBrowsingEnabled, Bool, bool, false) \
51     macro(TextAreasAreResizable, textAreasAreResizable, Bool, bool, true) \
52     macro(JavaScriptCanOpenWindowsAutomatically, javaScriptCanOpenWindowsAutomatically, Bool, bool, true) \
53     macro(HyperlinkAuditingEnabled, hyperlinkAuditingEnabled, Bool, bool, true) \
54     macro(NeedsSiteSpecificQuirks, needsSiteSpecificQuirks, Bool, bool, false) \
55     macro(AcceleratedCompositingEnabled, acceleratedCompositingEnabled, Bool, bool, true) \
56     macro(AcceleratedDrawingEnabled, acceleratedDrawingEnabled, Bool, bool, false) \
57     macro(CompositingBordersVisible, compositingBordersVisible, Bool, bool, false) \
58     macro(CompositingRepaintCountersVisible, compositingRepaintCountersVisible, Bool, bool, false) \
59     macro(WebGLEnabled, webGLEnabled, Bool, bool, false) \
60     macro(ForceFTPDirectoryListings, forceFTPDirectoryListings, Bool, bool, false) \
61     macro(TabsToLinks, tabsToLinks, Bool, bool, false) \
62     macro(DNSPrefetchingEnabled, dnsPrefetchingEnabled, Bool, bool, false) \
63     macro(WebArchiveDebugModeEnabled, webArchiveDebugModeEnabled, Bool, bool, false) \
64     macro(LocalFileContentSniffingEnabled, localFileContentSniffingEnabled, Bool, bool, false) \
65     macro(UsesPageCache, usesPageCache, Bool, bool, true) \
66     macro(AuthorAndUserStylesEnabled, authorAndUserStylesEnabled, Bool, bool, true) \
67     macro(PaginateDuringLayoutEnabled, paginateDuringLayoutEnabled, Bool, bool, false) \
68     macro(DOMPasteAllowed, domPasteAllowed, Bool, bool, false) \
69     macro(JavaScriptCanAccessClipboard, javaScriptCanAccessClipboard, Bool, bool, false) \
70     macro(ShouldPrintBackgrounds, shouldPrintBackgrounds, Bool, bool, false) \
71     macro(FullScreenEnabled, fullScreenEnabled, Bool, bool, false) \
72     \
73
74 #define FOR_EACH_WEBKIT_DOUBLE_PREFERENCE(macro) \
75     macro(PDFScaleFactor, pdfScaleFactor, Double, double, 0) \
76     \
77
78 #define FOR_EACH_WEBKIT_UINT32_PREFERENCE(macro) \
79     macro(FontSmoothingLevel, fontSmoothingLevel, UInt32, uint32_t, FontSmoothingLevelMedium) \
80     macro(MinimumFontSize, minimumFontSize, UInt32, uint32_t, 0) \
81     macro(MinimumLogicalFontSize, minimumLogicalFontSize, UInt32, uint32_t, 9) \
82     macro(DefaultFontSize, defaultFontSize, UInt32, uint32_t, 16) \
83     macro(DefaultFixedFontSize, defaultFixedFontSize, UInt32, uint32_t, 13) \
84     macro(PDFDisplayMode, pdfDisplayMode, UInt32, uint32_t, 1) \
85     \
86
87 #if PLATFORM(WIN)
88
89 #define FOR_EACH_WEBKIT_FONT_FAMILY_PREFERENCE(macro) \
90     macro(StandardFontFamily, standardFontFamily, String, String, "Times New Roman") \
91     macro(CursiveFontFamily, cursiveFontFamily, String, String, "Comic Sans MS") \
92     macro(FantasyFontFamily, fantasyFontFamily, String, String, "Comic Sans MS") \
93     macro(FixedFontFamily, fixedFontFamily, String, String, "Courier New") \
94     macro(SansSerifFontFamily, sansSerifFontFamily, String, String, "Arial") \
95     macro(SerifFontFamily, serifFontFamily, String, String, "Times New Roman") \
96     \
97
98 #elif PLATFORM(MAC)
99
100 #define FOR_EACH_WEBKIT_FONT_FAMILY_PREFERENCE(macro) \
101     macro(StandardFontFamily, standardFontFamily, String, String, "Times") \
102     macro(CursiveFontFamily, cursiveFontFamily, String, String, "Apple Chancery") \
103     macro(FantasyFontFamily, fantasyFontFamily, String, String, "Papyrus") \
104     macro(FixedFontFamily, fixedFontFamily, String, String, "Courier") \
105     macro(SansSerifFontFamily, sansSerifFontFamily, String, String, "Helvetica") \
106     macro(SerifFontFamily, serifFontFamily, String, String, "Times") \
107     \
108
109 #elif PLATFORM(QT) || PLATFORM(GTK)
110
111 #define FOR_EACH_WEBKIT_FONT_FAMILY_PREFERENCE(macro) \
112     macro(StandardFontFamily, standardFontFamily, String, String, "Times") \
113     macro(CursiveFontFamily, cursiveFontFamily, String, String, "Comic Sans MS") \
114     macro(FantasyFontFamily, fantasyFontFamily, String, String, "Impact") \
115     macro(FixedFontFamily, fixedFontFamily, String, String, "Courier New") \
116     macro(SansSerifFontFamily, sansSerifFontFamily, String, String, "Helvetica") \
117     macro(SerifFontFamily, serifFontFamily, String, String, "Times") \
118     \
119
120 #endif
121
122 #define FOR_EACH_WEBKIT_STRING_PREFERENCE(macro) \
123     FOR_EACH_WEBKIT_FONT_FAMILY_PREFERENCE(macro) \
124     macro(DefaultTextEncodingName, defaultTextEncodingName, String, String, "ISO-8859-1") \
125     macro(FTPDirectoryTemplatePath, ftpDirectoryTemplatePath, String, String, "") \
126     \
127
128
129 #define FOR_EACH_WEBKIT_PREFERENCE(macro) \
130     FOR_EACH_WEBKIT_BOOL_PREFERENCE(macro) \
131     FOR_EACH_WEBKIT_DOUBLE_PREFERENCE(macro) \
132     FOR_EACH_WEBKIT_UINT32_PREFERENCE(macro) \
133     FOR_EACH_WEBKIT_STRING_PREFERENCE(macro) \
134     \
135
136 namespace WebPreferencesKey {
137
138 #define DECLARE_KEY_GETTERS(KeyUpper, KeyLower, TypeName, Type, DefaultValue) const String& KeyLower##Key();
139
140     FOR_EACH_WEBKIT_PREFERENCE(DECLARE_KEY_GETTERS)
141
142 #undef DECLARE_KEY_GETTERS
143
144 } // namespace WebPreferencesKey
145
146 struct WebPreferencesStore {
147     WebPreferencesStore();
148
149     void encode(CoreIPC::ArgumentEncoder* encoder) const;
150     static bool decode(CoreIPC::ArgumentDecoder*, WebPreferencesStore&);
151
152     // NOTE: The getters in this class have non-standard names to aid in the use of the preference macros.
153
154     bool setStringValueForKey(const String& key, const String& value);
155     String getStringValueForKey(const String& key) const;
156
157     bool setBoolValueForKey(const String& key, bool value);
158     bool getBoolValueForKey(const String& key) const;
159
160     bool setUInt32ValueForKey(const String& key, uint32_t value);
161     uint32_t getUInt32ValueForKey(const String& key) const;
162
163     bool setDoubleValueForKey(const String& key, double value);
164     double getDoubleValueForKey(const String& key) const;
165
166     static void overrideXSSAuditorEnabledForTestRunner(bool);
167     static void removeTestRunnerOverrides();
168
169     HashMap<String, String> m_stringValues;
170     HashMap<String, bool> m_boolValues;
171     HashMap<String, uint32_t> m_uint32Values;
172     HashMap<String, double> m_doubleValues;
173 };
174
175 } // namespace WebKit
176
177 #endif // WebPreferencesStore_h