54435b87ab8cb35cdc168079f59932d154bf66fe
[WebKit-https.git] / Source / WebKit2 / UIProcess / WebPreferences.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 WebPreferences_h
27 #define WebPreferences_h
28
29 #include "APIExperimentalFeature.h"
30 #include "APIObject.h"
31 #include "FontSmoothingLevel.h"
32 #include "WebPreferencesDefinitions.h"
33 #include "WebPreferencesStore.h"
34 #include <wtf/HashSet.h>
35 #include <wtf/PassRefPtr.h>
36 #include <wtf/RefPtr.h>
37
38 #define DECLARE_PREFERENCE_GETTER_AND_SETTERS(KeyUpper, KeyLower, TypeName, Type, DefaultValue, HumanReadableName, HumanReadableDescription) \
39     void set##KeyUpper(const Type& value); \
40     Type KeyLower() const;
41
42 namespace WebKit {
43
44 class WebPageProxy;
45
46 class WebPreferences : public API::ObjectImpl<API::Object::Type::Preferences> {
47 public:
48     static Ref<WebPreferences> create(const String& identifier, const String& keyPrefix, const String& globalDebugKeyPrefix);
49     static PassRefPtr<WebPreferences> createWithLegacyDefaults(const String& identifier, const String& keyPrefix, const String& globalDebugKeyPrefix);
50
51     explicit WebPreferences(const String& identifier, const String& keyPrefix, const String& globalDebugKeyPrefix);
52     WebPreferences(const WebPreferences&);
53
54     virtual ~WebPreferences();
55
56     PassRefPtr<WebPreferences> copy() const;
57
58     void addPage(WebPageProxy&);
59     void removePage(WebPageProxy&);
60
61     const WebPreferencesStore& store() const { return m_store; }
62
63     FOR_EACH_WEBKIT_PREFERENCE(DECLARE_PREFERENCE_GETTER_AND_SETTERS)
64     FOR_EACH_WEBKIT_DEBUG_PREFERENCE(DECLARE_PREFERENCE_GETTER_AND_SETTERS)
65     FOR_EACH_WEBKIT_EXPERIMENTAL_FEATURE_PREFERENCE(DECLARE_PREFERENCE_GETTER_AND_SETTERS)
66
67     static const Vector<RefPtr<API::Object>>& experimentalFeatures();
68     bool isEnabledForFeature(const API::ExperimentalFeature&) const;
69     void setEnabledForFeature(bool, const API::ExperimentalFeature&);
70     void enableAllExperimentalFeatures();
71
72     // Exposed for WebKitTestRunner use only.
73     void forceUpdate() { update(); }
74
75     static bool anyPagesAreUsingPrivateBrowsing();
76
77 private:
78     void platformInitializeStore();
79
80     void update();
81
82     void updateStringValueForKey(const String& key, const String& value);
83     void updateBoolValueForKey(const String& key, bool value);
84     void updateBoolValueForExperimentalFeatureKey(const String& key, bool value);
85     void updateUInt32ValueForKey(const String& key, uint32_t value);
86     void updateDoubleValueForKey(const String& key, double value);
87     void updateFloatValueForKey(const String& key, float value);
88     void platformUpdateStringValueForKey(const String& key, const String& value);
89     void platformUpdateBoolValueForKey(const String& key, bool value);
90     void platformUpdateUInt32ValueForKey(const String& key, uint32_t value);
91     void platformUpdateDoubleValueForKey(const String& key, double value);
92     void platformUpdateFloatValueForKey(const String& key, float value);
93
94     void updatePrivateBrowsingValue(bool value);
95
96     void setPeerConnectionAndMediaStreamEnabled(bool value);
97
98     void registerDefaultBoolValueForKey(const String&, bool);
99     void registerDefaultUInt32ValueForKey(const String&, uint32_t);
100
101     bool platformGetStringUserValueForKey(const String& key, String& userValue);
102     bool platformGetBoolUserValueForKey(const String&, bool&);
103     bool platformGetUInt32UserValueForKey(const String&, uint32_t&);
104     bool platformGetDoubleUserValueForKey(const String&, double&);
105
106     const String m_identifier;
107     const String m_keyPrefix;
108     const String m_globalDebugKeyPrefix;
109     WebPreferencesStore m_store;
110
111     HashSet<WebPageProxy*> m_pages;
112 };
113
114 } // namespace WebKit
115
116 #endif // WebPreferences_h