[WebKit2] Rework WebPreferencesStore to allow easier overriding of defaults
[WebKit-https.git] / Source / WebKit2 / Shared / WebPreferencesStore.cpp
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 #include "config.h"
27 #include "WebPreferencesStore.h"
28
29 #include "FontSmoothingLevel.h"
30 #include "WebCoreArgumentCoders.h"
31 #include <WebCore/Settings.h>
32 #include <wtf/NeverDestroyed.h>
33
34 #if PLATFORM(IOS)
35 #import <WebKitSystemInterfaceIOS.h>
36 #endif
37
38 namespace WebKit {
39
40 namespace WebPreferencesKey {
41
42 #define DEFINE_KEY_GETTERS(KeyUpper, KeyLower, TypeName, Type, DefaultValue) \
43         const String& KeyLower##Key() \
44         { \
45             static NeverDestroyed<String> key(ASCIILiteral(#KeyUpper)); \
46             return key; \
47         }
48
49     FOR_EACH_WEBKIT_PREFERENCE(DEFINE_KEY_GETTERS)
50
51 #undef DEFINE_KEY_GETTERS
52
53 } // namespace WebPreferencesKey
54
55 typedef HashMap<String, bool> BoolOverridesMap;
56
57 static BoolOverridesMap& boolTestRunnerOverridesMap()
58 {
59     static NeverDestroyed<BoolOverridesMap> map;
60     return map;
61 }
62
63 void WebPreferencesStore::Value::encode(IPC::ArgumentEncoder& encoder) const
64 {
65     encoder.encodeEnum(m_type);
66     
67     switch (m_type) {
68     case Type::None:
69         break;
70     case Type::String:
71         encoder << m_string;
72         break;
73     case Type::Bool:
74         encoder << m_bool;
75         break;
76     case Type::UInt32:
77         encoder << m_uint32;
78         break;
79     case Type::Double:
80         encoder << m_double;
81         break;
82     }
83 }
84
85 bool WebPreferencesStore::Value::decode(IPC::ArgumentDecoder& decoder, Value& result)
86 {
87     Value::Type type;
88     if (!decoder.decodeEnum(type))
89         return false;
90     
91     switch (type) {
92     case Type::None:
93         break;
94     case Type::String: {
95         String value;
96         if (!decoder.decode(value))
97             return false;
98         result = Value(value);
99         break;
100     }
101     case Type::Bool: {
102         bool value;
103         if (!decoder.decode(value))
104             return false;
105         result = Value(value);
106         break;
107     }
108     case Type::UInt32: {
109         uint32_t value;
110         if (!decoder.decode(value))
111             return false;
112         result = Value(value);
113         break;
114     }
115     case Type::Double: {
116         double value;
117         if (!decoder.decode(value))
118             return false;
119         result = Value(value);
120         break;
121     }
122     default:
123         return false;
124     }
125
126     return true;
127 }
128
129 WebPreferencesStore::WebPreferencesStore()
130 {
131 }
132
133 void WebPreferencesStore::encode(IPC::ArgumentEncoder& encoder) const
134 {
135     encoder << m_values;
136     encoder << m_overridenDefaults;
137 }
138
139 bool WebPreferencesStore::decode(IPC::ArgumentDecoder& decoder, WebPreferencesStore& result)
140 {
141     if (!decoder.decode(result.m_values))
142         return false;
143     if (!decoder.decode(result.m_overridenDefaults))
144         return false;
145     return true;
146 }
147
148 void WebPreferencesStore::overrideBoolValueForKey(const String& key, bool value)
149 {
150     boolTestRunnerOverridesMap().set(key, value);
151 }
152
153 void WebPreferencesStore::removeTestRunnerOverrides()
154 {
155     boolTestRunnerOverridesMap().clear();
156 }
157
158 template <typename T> struct ToType { };
159
160 template<> struct ToType<String> { static const auto value = WebPreferencesStore::Value::Type::String; };
161 template<> struct ToType<bool> { static const auto value = WebPreferencesStore::Value::Type::Bool; };
162 template<> struct ToType<uint32_t> { static const auto value = WebPreferencesStore::Value::Type::UInt32; };
163 template<> struct ToType<double> { static const auto value = WebPreferencesStore::Value::Type::Double; };
164
165
166 template<typename MappedType> MappedType as(const WebPreferencesStore::Value&);
167
168 template<> String as<String>(const WebPreferencesStore::Value& value) { return value.asString(); }
169 template<> bool as<bool>(const WebPreferencesStore::Value& value) { return value.asBool(); }
170 template<> uint32_t as<uint32_t>(const WebPreferencesStore::Value& value) { return value.asUInt32(); }
171 template<> double as<double>(const WebPreferencesStore::Value& value) { return value.asDouble(); }
172
173
174 static WebPreferencesStore::ValueMap& defaults()
175 {
176     static NeverDestroyed<WebPreferencesStore::ValueMap> defaults;
177     if (defaults.get().isEmpty()) {
178 #define DEFINE_DEFAULTS(KeyUpper, KeyLower, TypeName, Type, DefaultValue) defaults.get().set(WebPreferencesKey::KeyLower##Key(), WebPreferencesStore::Value((Type)DefaultValue));
179         FOR_EACH_WEBKIT_PREFERENCE(DEFINE_DEFAULTS)
180 #undef DEFINE_DEFAULTS
181     }
182
183     return defaults;
184 }
185
186 template<typename MappedType>
187 static MappedType valueForKey(const WebPreferencesStore::ValueMap& values, const WebPreferencesStore::ValueMap& overridenDefaults, const String& key)
188 {
189     auto valuesIt = values.find(key);
190     if (valuesIt != values.end() && valuesIt->value.type() == ToType<MappedType>::value)
191         return as<MappedType>(valuesIt->value);
192
193     auto overridenDefaultsIt = overridenDefaults.find(key);
194     if (overridenDefaultsIt != overridenDefaults.end() && overridenDefaultsIt->value.type() == ToType<MappedType>::value)
195         return as<MappedType>(overridenDefaultsIt->value);
196
197     auto defaultsMap = defaults();
198     auto defaultsIt = defaultsMap.find(key);
199     if (defaultsIt != defaultsMap.end() && defaultsIt->value.type() == ToType<MappedType>::value)
200         return as<MappedType>(defaultsIt->value);
201
202     return MappedType();
203 }
204
205 template<typename MappedType>
206 static bool setValueForKey(WebPreferencesStore::ValueMap& map, const WebPreferencesStore::ValueMap& overridenDefaults, const String& key, const MappedType& value)
207 {
208     MappedType existingValue = valueForKey<MappedType>(map, overridenDefaults, key);
209     if (existingValue == value)
210         return false;
211
212     map.set(key, WebPreferencesStore::Value(value));
213     return true;
214 }
215
216 bool WebPreferencesStore::setStringValueForKey(const String& key, const String& value)
217 {
218     return setValueForKey<String>(m_values, m_overridenDefaults, key, value);
219 }
220
221 String WebPreferencesStore::getStringValueForKey(const String& key) const
222 {
223     return valueForKey<String>(m_values, m_overridenDefaults, key);
224 }
225
226 bool WebPreferencesStore::setBoolValueForKey(const String& key, bool value)
227 {
228     return setValueForKey<bool>(m_values, m_overridenDefaults, key, value);
229 }
230
231 bool WebPreferencesStore::getBoolValueForKey(const String& key) const
232 {
233     // FIXME: Extend overriding to other key types used from TestRunner.
234     auto it = boolTestRunnerOverridesMap().find(key);
235     if (it != boolTestRunnerOverridesMap().end())
236         return it->value;
237
238     return valueForKey<bool>(m_values, m_overridenDefaults, key);
239 }
240
241 bool WebPreferencesStore::setUInt32ValueForKey(const String& key, uint32_t value) 
242 {
243     return setValueForKey<uint32_t>(m_values, m_overridenDefaults, key, value);
244 }
245
246 uint32_t WebPreferencesStore::getUInt32ValueForKey(const String& key) const
247 {
248     return valueForKey<uint32_t>(m_values, m_overridenDefaults, key);
249 }
250
251 bool WebPreferencesStore::setDoubleValueForKey(const String& key, double value) 
252 {
253     return setValueForKey<double>(m_values, m_overridenDefaults, key, value);
254 }
255
256 double WebPreferencesStore::getDoubleValueForKey(const String& key) const
257 {
258     return valueForKey<double>(m_values, m_overridenDefaults, key);
259 }
260
261 // Overriden Defaults
262
263 void WebPreferencesStore::setOverrideDefaultsStringValueForKey(const String& key, String value)
264 {
265     m_overridenDefaults.set(key, Value(value));
266 }
267
268 void WebPreferencesStore::setOverrideDefaultsBoolValueForKey(const String& key, bool value)
269 {
270     m_overridenDefaults.set(key, Value(value));
271 }
272
273 void WebPreferencesStore::setOverrideDefaultsUInt32ValueForKey(const String& key, uint32_t value)
274 {
275     m_overridenDefaults.set(key, Value(value));
276 }
277
278 void WebPreferencesStore::setOverrideDefaultsDoubleValueForKey(const String& key, double value)
279 {
280     m_overridenDefaults.set(key, Value(value));
281 }
282
283 } // namespace WebKit