OLD | NEW |
1 // Copyright 2014 The Chromium Authors. All rights reserved. | 1 // Copyright 2014 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef EXTENSIONS_BROWSER_EXTENSION_PREF_VALUE_MAP_H_ | 5 #ifndef EXTENSIONS_BROWSER_EXTENSION_PREF_VALUE_MAP_H_ |
6 #define EXTENSIONS_BROWSER_EXTENSION_PREF_VALUE_MAP_H_ | 6 #define EXTENSIONS_BROWSER_EXTENSION_PREF_VALUE_MAP_H_ |
7 | 7 |
8 #include <map> | 8 #include <map> |
9 #include <set> | 9 #include <set> |
10 #include <string> | 10 #include <string> |
11 | 11 |
12 #include "base/observer_list.h" | 12 #include "base/observer_list.h" |
13 #include "base/prefs/pref_value_map.h" | 13 #include "base/prefs/pref_value_map.h" |
14 #include "base/time/time.h" | 14 #include "base/time/time.h" |
15 #include "base/values.h" | 15 #include "base/values.h" |
16 #include "components/browser_context_keyed_service/browser_context_keyed_service
.h" | 16 #include "components/keyed_service/core/keyed_service.h" |
17 #include "extensions/browser/extension_prefs_scope.h" | 17 #include "extensions/browser/extension_prefs_scope.h" |
18 | 18 |
19 // Non-persistent data container that is shared by ExtensionPrefStores. All | 19 // Non-persistent data container that is shared by ExtensionPrefStores. All |
20 // extension pref values (incognito and regular) are stored herein and | 20 // extension pref values (incognito and regular) are stored herein and |
21 // provided to ExtensionPrefStores. | 21 // provided to ExtensionPrefStores. |
22 // | 22 // |
23 // The semantics of the ExtensionPrefValueMap are: | 23 // The semantics of the ExtensionPrefValueMap are: |
24 // - A regular setting applies to regular browsing sessions as well as incognito | 24 // - A regular setting applies to regular browsing sessions as well as incognito |
25 // browsing sessions. | 25 // browsing sessions. |
26 // - An incognito setting applies only to incognito browsing sessions, not to | 26 // - An incognito setting applies only to incognito browsing sessions, not to |
(...skipping 19 matching lines...) Expand all Loading... |
46 // 1 | - | 3 | 4 | 5 | - | 5 | 4 | 46 // 1 | - | 3 | 4 | 5 | - | 5 | 4 |
47 // 1 | - | - | - | - | 6 | 1 | 6 | 47 // 1 | - | - | - | - | 6 | 1 | 6 |
48 // 1 | 2 | - | 4 | - | 6 | 4 | 6 | 48 // 1 | 2 | - | 4 | - | 6 | 4 | 6 |
49 // 1 | 2 | 3 | - | 5 | 6 | 5 | 6 | 49 // 1 | 2 | 3 | - | 5 | 6 | 5 | 6 |
50 // | 50 // |
51 // A = extension A, B = extension B, E = effective value | 51 // A = extension A, B = extension B, E = effective value |
52 // .reg = regular value | 52 // .reg = regular value |
53 // .reg_only = regular-only value | 53 // .reg_only = regular-only value |
54 // .inc = incognito value | 54 // .inc = incognito value |
55 // Extension B has higher precedence than A. | 55 // Extension B has higher precedence than A. |
56 class ExtensionPrefValueMap : public BrowserContextKeyedService { | 56 class ExtensionPrefValueMap : public KeyedService { |
57 public: | 57 public: |
58 // Observer interface for monitoring ExtensionPrefValueMap. | 58 // Observer interface for monitoring ExtensionPrefValueMap. |
59 class Observer { | 59 class Observer { |
60 public: | 60 public: |
61 // Called when the value for the given |key| set by one of the extensions | 61 // Called when the value for the given |key| set by one of the extensions |
62 // changes. This does not necessarily mean that the effective value has | 62 // changes. This does not necessarily mean that the effective value has |
63 // changed. | 63 // changed. |
64 virtual void OnPrefValueChanged(const std::string& key) = 0; | 64 virtual void OnPrefValueChanged(const std::string& key) = 0; |
65 // Notification about the ExtensionPrefValueMap being fully initialized. | 65 // Notification about the ExtensionPrefValueMap being fully initialized. |
66 virtual void OnInitializationCompleted() = 0; | 66 virtual void OnInitializationCompleted() = 0; |
67 // Called when the ExtensionPrefValueMap is being destroyed. When called, | 67 // Called when the ExtensionPrefValueMap is being destroyed. When called, |
68 // observers must unsubscribe. | 68 // observers must unsubscribe. |
69 virtual void OnExtensionPrefValueMapDestruction() = 0; | 69 virtual void OnExtensionPrefValueMapDestruction() = 0; |
70 | 70 |
71 protected: | 71 protected: |
72 virtual ~Observer() {} | 72 virtual ~Observer() {} |
73 }; | 73 }; |
74 | 74 |
75 ExtensionPrefValueMap(); | 75 ExtensionPrefValueMap(); |
76 virtual ~ExtensionPrefValueMap(); | 76 virtual ~ExtensionPrefValueMap(); |
77 | 77 |
78 // BrowserContextKeyedService implementation. | 78 // KeyedService implementation. |
79 virtual void Shutdown() OVERRIDE; | 79 virtual void Shutdown() OVERRIDE; |
80 | 80 |
81 // Set an extension preference |value| for |key| of extension |ext_id|. | 81 // Set an extension preference |value| for |key| of extension |ext_id|. |
82 // Takes ownership of |value|. | 82 // Takes ownership of |value|. |
83 // Note that regular extension pref values need to be reported to | 83 // Note that regular extension pref values need to be reported to |
84 // incognito and to regular ExtensionPrefStores. | 84 // incognito and to regular ExtensionPrefStores. |
85 // Precondition: the extension must be registered. | 85 // Precondition: the extension must be registered. |
86 void SetExtensionPref(const std::string& ext_id, | 86 void SetExtensionPref(const std::string& ext_id, |
87 const std::string& key, | 87 const std::string& key, |
88 extensions::ExtensionPrefsScope scope, | 88 extensions::ExtensionPrefsScope scope, |
(...skipping 107 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
196 // being destroyed. In tests, it isn't called, so the notification must | 196 // being destroyed. In tests, it isn't called, so the notification must |
197 // be done in the destructor. This bit tracks whether it has been done yet. | 197 // be done in the destructor. This bit tracks whether it has been done yet. |
198 bool destroyed_; | 198 bool destroyed_; |
199 | 199 |
200 ObserverList<Observer, true> observers_; | 200 ObserverList<Observer, true> observers_; |
201 | 201 |
202 DISALLOW_COPY_AND_ASSIGN(ExtensionPrefValueMap); | 202 DISALLOW_COPY_AND_ASSIGN(ExtensionPrefValueMap); |
203 }; | 203 }; |
204 | 204 |
205 #endif // EXTENSIONS_BROWSER_EXTENSION_PREF_VALUE_MAP_H_ | 205 #endif // EXTENSIONS_BROWSER_EXTENSION_PREF_VALUE_MAP_H_ |
OLD | NEW |