Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(62)

Unified Diff: chrome/browser/prefs/pref_service.h

Issue 10828345: Extract PrefServiceBase into chrome/browser/api. Use in api and autofill. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Created 8 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: chrome/browser/prefs/pref_service.h
diff --git a/chrome/browser/prefs/pref_service.h b/chrome/browser/prefs/pref_service.h
index 1d43a8a1d4a44f2b06e0e0abfc3aa9e9edd6f60c..bc63f7b2bf8609dbcd9a1b4d1fa091c61cc06ace 100644
--- a/chrome/browser/prefs/pref_service.h
+++ b/chrome/browser/prefs/pref_service.h
@@ -17,11 +17,10 @@
#include "base/memory/ref_counted.h"
#include "base/memory/scoped_ptr.h"
#include "base/threading/non_thread_safe.h"
-#include "base/values.h"
+#include "chrome/browser/api/prefs/pref_service_base.h"
class CommandLine;
class DefaultPrefStore;
-class FilePath;
class PersistentPrefStore;
class PrefModelAssociator;
class PrefNotifier;
@@ -42,20 +41,11 @@ class PolicyService;
}
namespace subtle {
-class PrefMemberBase;
class ScopedUserPrefUpdateBase;
};
-class PrefService : public base::NonThreadSafe {
+class PrefService : public PrefServiceBase, public base::NonThreadSafe {
public:
- // Enum used when registering preferences to determine if it should be synced
- // or not. This is only used for profile prefs, not local state prefs.
- // See the Register*Pref methods for profile prefs below.
- enum PrefSyncStatus {
- UNSYNCABLE_PREF,
- SYNCABLE_PREF
- };
-
enum PrefInitializationStatus {
INITIALIZATION_STATUS_WAITING,
INITIALIZATION_STATUS_SUCCESS,
@@ -177,140 +167,109 @@ class PrefService : public base::NonThreadSafe {
// values while the importer process is running. Returns true on success.
bool ReloadPersistentPrefs();
- // Returns true if the preference for the given preference name is available
- // and is managed.
- bool IsManagedPreference(const char* pref_name) const;
-
- // Returns |true| if a preference with the given name is available and its
- // value can be changed by the user.
- bool IsUserModifiablePreference(const char* pref_name) const;
-
// Lands pending writes to disk. This should only be used if we need to save
// immediately (basically, during shutdown).
void CommitPendingWrite();
- // Make the PrefService aware of a pref.
- // TODO(zea): split local state and profile prefs into their own subclasses.
- // ---------- Local state prefs ----------
- void RegisterBooleanPref(const char* path, bool default_value);
- void RegisterIntegerPref(const char* path, int default_value);
- void RegisterDoublePref(const char* path, double default_value);
- void RegisterStringPref(const char* path, const std::string& default_value);
- void RegisterFilePathPref(const char* path, const FilePath& default_value);
- void RegisterListPref(const char* path);
- void RegisterDictionaryPref(const char* path);
- // These take ownership of the default_value:
- void RegisterListPref(const char* path,
- base::ListValue* default_value);
- void RegisterDictionaryPref(const char* path,
- base::DictionaryValue* default_value);
- // These variants use a default value from the locale dll instead.
- void RegisterLocalizedBooleanPref(const char* path,
- int locale_default_message_id);
- void RegisterLocalizedIntegerPref(const char* path,
- int locale_default_message_id);
- void RegisterLocalizedDoublePref(const char* path,
- int locale_default_message_id);
- void RegisterLocalizedStringPref(const char* path,
- int locale_default_message_id);
- void RegisterInt64Pref(const char* path, int64 default_value);
-
- // ---------- Profile prefs ----------
- // Profile prefs must specify whether the pref should be synchronized across
- // machines or not (see PrefSyncStatus enum above).
- void RegisterBooleanPref(const char* path,
- bool default_value,
- PrefSyncStatus sync_status);
- void RegisterIntegerPref(const char* path,
- int default_value,
- PrefSyncStatus sync_status);
- void RegisterDoublePref(const char* path,
- double default_value,
- PrefSyncStatus sync_status);
- void RegisterStringPref(const char* path,
- const std::string& default_value,
- PrefSyncStatus sync_status);
- void RegisterFilePathPref(const char* path,
- const FilePath& default_value,
- PrefSyncStatus sync_status);
- void RegisterListPref(const char* path, PrefSyncStatus sync_status);
- void RegisterDictionaryPref(const char* path, PrefSyncStatus sync_status);
- // These take ownership of the default_value:
- void RegisterListPref(const char* path,
- base::ListValue* default_value,
- PrefSyncStatus sync_status);
- void RegisterDictionaryPref(const char* path,
- base::DictionaryValue* default_value,
- PrefSyncStatus sync_status);
- // These variants use a default value from the locale dll instead.
- void RegisterLocalizedBooleanPref(const char* path,
- int locale_default_message_id,
- PrefSyncStatus sync_status);
- void RegisterLocalizedIntegerPref(const char* path,
- int locale_default_message_id,
- PrefSyncStatus sync_status);
- void RegisterLocalizedDoublePref(const char* path,
- int locale_default_message_id,
- PrefSyncStatus sync_status);
- void RegisterLocalizedStringPref(const char* path,
- int locale_default_message_id,
- PrefSyncStatus sync_status);
- void RegisterInt64Pref(const char* path,
- int64 default_value,
- PrefSyncStatus sync_status);
- void RegisterUint64Pref(const char* path,
- uint64 default_value,
- PrefSyncStatus sync_status);
- // Unregisters a preference.
- void UnregisterPreference(const char* path);
-
- // If the path is valid and the value at the end of the path matches the type
- // specified, it will return the specified value. Otherwise, the default
- // value (set when the pref was registered) will be returned.
- bool GetBoolean(const char* path) const;
- int GetInteger(const char* path) const;
- double GetDouble(const char* path) const;
- std::string GetString(const char* path) const;
- FilePath GetFilePath(const char* path) const;
-
- // Returns the branch if it exists, or the registered default value otherwise.
- // Note that |path| must point to a registered preference. In that case, these
- // functions will never return NULL.
- const base::DictionaryValue* GetDictionary(const char* path) const;
- const base::ListValue* GetList(const char* path) const;
-
- // Returns the value of the given preference, from the user pref store. If
- // the preference is not set in the user pref store, returns NULL.
- const base::Value* GetUserPrefValue(const char* path) const;
-
- // Returns the default value of the given preference. |path| must point to a
- // registered preference. In that case, will never return NULL.
- const base::Value* GetDefaultPrefValue(const char* path) const;
-
- // Removes a user pref and restores the pref to its default value.
- void ClearPref(const char* path);
-
- // If the path is valid (i.e., registered), update the pref value in the user
- // prefs.
- // To set the value of dictionary or list values in the pref tree use
- // Set(), but to modify the value of a dictionary or list use either
- // ListPrefUpdate or DictionaryPrefUpdate from scoped_user_pref_update.h.
- void Set(const char* path, const base::Value& value);
- void SetBoolean(const char* path, bool value);
- void SetInteger(const char* path, int value);
- void SetDouble(const char* path, double value);
- void SetString(const char* path, const std::string& value);
- void SetFilePath(const char* path, const FilePath& value);
-
- // Int64 helper methods that actually store the given value as a string.
- // Note that if obtaining the named value via GetDictionary or GetList, the
- // Value type will be TYPE_STRING.
- void SetInt64(const char* path, int64 value);
- int64 GetInt64(const char* path) const;
-
- // As above, but for unsigned values.
- void SetUint64(const char* path, uint64 value);
- uint64 GetUint64(const char* path) const;
+ // PrefServiceBase implementation.
+ virtual bool IsManagedPreference(const char* pref_name) const OVERRIDE;
+ virtual bool IsUserModifiablePreference(const char* pref_name) const OVERRIDE;
+ virtual void RegisterBooleanPref(const char* path,
+ bool default_value) OVERRIDE;
+ virtual void RegisterIntegerPref(const char* path,
+ int default_value) OVERRIDE;
+ virtual void RegisterDoublePref(const char* path,
+ double default_value) OVERRIDE;
+ virtual void RegisterStringPref(const char* path,
+ const std::string& default_value) OVERRIDE;
+ virtual void RegisterFilePathPref(const char* path,
+ const FilePath& default_value) OVERRIDE;
+ virtual void RegisterListPref(const char* path) OVERRIDE;
+ virtual void RegisterDictionaryPref(const char* path) OVERRIDE;
+ virtual void RegisterListPref(const char* path,
+ base::ListValue* default_value) OVERRIDE;
+ virtual void RegisterDictionaryPref(
+ const char* path, base::DictionaryValue* default_value) OVERRIDE;
+ virtual void RegisterLocalizedBooleanPref(
+ const char* path, int locale_default_message_id) OVERRIDE;
+ virtual void RegisterLocalizedIntegerPref(
+ const char* path, int locale_default_message_id) OVERRIDE;
+ virtual void RegisterLocalizedDoublePref(
+ const char* path, int locale_default_message_id) OVERRIDE;
+ virtual void RegisterLocalizedStringPref(
+ const char* path, int locale_default_message_id) OVERRIDE;
+ virtual void RegisterInt64Pref(const char* path,
+ int64 default_value) OVERRIDE;
+ virtual void RegisterBooleanPref(const char* path,
+ bool default_value,
+ PrefSyncStatus sync_status) OVERRIDE;
+ virtual void RegisterIntegerPref(const char* path,
+ int default_value,
+ PrefSyncStatus sync_status) OVERRIDE;
+ virtual void RegisterDoublePref(const char* path,
+ double default_value,
+ PrefSyncStatus sync_status) OVERRIDE;
+ virtual void RegisterStringPref(const char* path,
+ const std::string& default_value,
+ PrefSyncStatus sync_status) OVERRIDE;
+ virtual void RegisterFilePathPref(const char* path,
+ const FilePath& default_value,
+ PrefSyncStatus sync_status) OVERRIDE;
+ virtual void RegisterListPref(const char* path,
+ PrefSyncStatus sync_status) OVERRIDE;
+ virtual void RegisterDictionaryPref(const char* path,
+ PrefSyncStatus sync_status) OVERRIDE;
+ virtual void RegisterListPref(const char* path,
+ base::ListValue* default_value,
+ PrefSyncStatus sync_status) OVERRIDE;
+ virtual void RegisterDictionaryPref(const char* path,
+ base::DictionaryValue* default_value,
+ PrefSyncStatus sync_status) OVERRIDE;
+ virtual void RegisterLocalizedBooleanPref(
+ const char* path,
+ int locale_default_message_id,
+ PrefSyncStatus sync_status) OVERRIDE;
+ virtual void RegisterLocalizedIntegerPref(
+ const char* path,
+ int locale_default_message_id,
+ PrefSyncStatus sync_status) OVERRIDE;
+ virtual void RegisterLocalizedDoublePref(
+ const char* path,
+ int locale_default_message_id,
+ PrefSyncStatus sync_status) OVERRIDE;
+ virtual void RegisterLocalizedStringPref(
+ const char* path,
+ int locale_default_message_id,
+ PrefSyncStatus sync_status) OVERRIDE;
+ virtual void RegisterInt64Pref(const char* path,
+ int64 default_value,
+ PrefSyncStatus sync_status) OVERRIDE;
+ virtual void RegisterUint64Pref(const char* path,
+ uint64 default_value,
+ PrefSyncStatus sync_status) OVERRIDE;
+ virtual void UnregisterPreference(const char* path) OVERRIDE;
+ virtual bool GetBoolean(const char* path) const OVERRIDE;
+ virtual int GetInteger(const char* path) const OVERRIDE;
+ virtual double GetDouble(const char* path) const OVERRIDE;
+ virtual std::string GetString(const char* path) const OVERRIDE;
+ virtual FilePath GetFilePath(const char* path) const OVERRIDE;
+ virtual const base::DictionaryValue* GetDictionary(
+ const char* path) const OVERRIDE;
+ virtual const base::ListValue* GetList(const char* path) const OVERRIDE;
+ virtual const base::Value* GetUserPrefValue(const char* path) const OVERRIDE;
+ virtual const base::Value* GetDefaultPrefValue(
+ const char* path) const OVERRIDE;
+ virtual void ClearPref(const char* path) OVERRIDE;
+ virtual void Set(const char* path, const base::Value& value) OVERRIDE;
+ virtual void SetBoolean(const char* path, bool value) OVERRIDE;
+ virtual void SetInteger(const char* path, int value) OVERRIDE;
+ virtual void SetDouble(const char* path, double value) OVERRIDE;
+ virtual void SetString(const char* path, const std::string& value) OVERRIDE;
+ virtual void SetFilePath(const char* path, const FilePath& value) OVERRIDE;
+ virtual void SetInt64(const char* path, int64 value) OVERRIDE;
+ virtual int64 GetInt64(const char* path) const OVERRIDE;
+ virtual void SetUint64(const char* path, uint64 value) OVERRIDE;
+ virtual uint64 GetUint64(const char* path) const OVERRIDE;
// Returns true if a value has been set for the specified path.
// NOTE: this is NOT the same as FindPreference. In particular
@@ -364,31 +323,19 @@ class PrefService : public base::NonThreadSafe {
friend class PrefServiceMockBuilder;
- // Registration of pref change observers must be done using the
- // PrefChangeRegistrar, which is declared as a friend here to grant it
- // access to the otherwise protected members Add/RemovePrefObserver.
- // PrefMember registers for preferences changes notification directly to
- // avoid the storage overhead of the registrar, so its base class must be
- // declared as a friend, too.
- friend class PrefChangeRegistrar;
- friend class subtle::PrefMemberBase;
-
// Give access to ReportUserPrefChanged() and GetMutableUserPref().
friend class subtle::ScopedUserPrefUpdateBase;
+ // PrefServiceBase implementation (protected in base, private here).
+ virtual void AddPrefObserver(const char* path,
+ content::NotificationObserver* obs) OVERRIDE;
+ virtual void RemovePrefObserver(const char* path,
+ content::NotificationObserver* obs) OVERRIDE;
+
// Sends notification of a changed preference. This needs to be called by
// a ScopedUserPrefUpdate if a DictionaryValue or ListValue is changed.
void ReportUserPrefChanged(const std::string& key);
- // If the pref at the given path changes, we call the observer's Observe
- // method with PREF_CHANGED. Note that observers should not call these methods
- // directly but rather use a PrefChangeRegistrar to make sure the observer
- // gets cleaned up properly.
- virtual void AddPrefObserver(const char* path,
- content::NotificationObserver* obs);
- virtual void RemovePrefObserver(const char* path,
- content::NotificationObserver* obs);
-
// Registers a new preference at |path|. The |default_value| must not be
// NULL as it determines the preference value's type.
// RegisterPreference must not be called twice for the same path.

Powered by Google App Engine
This is Rietveld 408576698