Index: base/prefs/persistent_pref_store.h |
diff --git a/base/prefs/persistent_pref_store.h b/base/prefs/persistent_pref_store.h |
index a0fcf6856b6c1c0940d16be9f9cb60ffee126b68..89c7a71961c8a4943f3d6749f34d5ea11fcea20c 100644 |
--- a/base/prefs/persistent_pref_store.h |
+++ b/base/prefs/persistent_pref_store.h |
@@ -2,6 +2,76 @@ |
// Use of this source code is governed by a BSD-style license that can be |
// found in the LICENSE file. |
-// TODO(brettw) remove this forwarding header when prefs is completely moved to |
-// components. |
-#include "components/prefs/persistent_pref_store.h" |
+#ifndef BASE_PREFS_PERSISTENT_PREF_STORE_H_ |
+#define BASE_PREFS_PERSISTENT_PREF_STORE_H_ |
+ |
+#include <string> |
+ |
+#include "base/prefs/base_prefs_export.h" |
+#include "base/prefs/writeable_pref_store.h" |
+ |
+// This interface is complementary to the PrefStore interface, declaring |
+// additional functionality that adds support for setting values and persisting |
+// the data to some backing store. |
+class BASE_PREFS_EXPORT PersistentPrefStore : public WriteablePrefStore { |
+ public: |
+ // Unique integer code for each type of error so we can report them |
+ // distinctly in a histogram. |
+ // NOTE: Don't change the explicit values of the enums as it will change the |
+ // server's meaning of the histogram. |
+ enum PrefReadError { |
+ PREF_READ_ERROR_NONE = 0, |
+ PREF_READ_ERROR_JSON_PARSE = 1, |
+ PREF_READ_ERROR_JSON_TYPE = 2, |
+ PREF_READ_ERROR_ACCESS_DENIED = 3, |
+ PREF_READ_ERROR_FILE_OTHER = 4, |
+ PREF_READ_ERROR_FILE_LOCKED = 5, |
+ PREF_READ_ERROR_NO_FILE = 6, |
+ PREF_READ_ERROR_JSON_REPEAT = 7, |
+ // PREF_READ_ERROR_OTHER = 8, // Deprecated. |
+ PREF_READ_ERROR_FILE_NOT_SPECIFIED = 9, |
+ // Indicates that ReadPrefs() couldn't complete synchronously and is waiting |
+ // for an asynchronous task to complete first. |
+ PREF_READ_ERROR_ASYNCHRONOUS_TASK_INCOMPLETE = 10, |
+ PREF_READ_ERROR_MAX_ENUM |
+ }; |
+ |
+ class ReadErrorDelegate { |
+ public: |
+ virtual ~ReadErrorDelegate() {} |
+ |
+ virtual void OnError(PrefReadError error) = 0; |
+ }; |
+ |
+ // Whether the store is in a pseudo-read-only mode where changes are not |
+ // actually persisted to disk. This happens in some cases when there are |
+ // read errors during startup. |
+ virtual bool ReadOnly() const = 0; |
+ |
+ // Gets the read error. Only valid if IsInitializationComplete() returns true. |
+ virtual PrefReadError GetReadError() const = 0; |
+ |
+ // Reads the preferences from disk. Notifies observers via |
+ // "PrefStore::OnInitializationCompleted" when done. |
+ virtual PrefReadError ReadPrefs() = 0; |
+ |
+ // Reads the preferences from disk asynchronously. Notifies observers via |
+ // "PrefStore::OnInitializationCompleted" when done. Also it fires |
+ // |error_delegate| if it is not NULL and reading error has occurred. |
+ // Owns |error_delegate|. |
+ virtual void ReadPrefsAsync(ReadErrorDelegate* error_delegate) = 0; |
+ |
+ // Lands any pending writes to disk. |
+ virtual void CommitPendingWrite() = 0; |
+ |
+ // Schedule a write if there is any lossy data pending. Unlike |
+ // CommitPendingWrite() this does not immediately sync to disk, instead it |
+ // triggers an eventual write if there is lossy data pending and if there |
+ // isn't one scheduled already. |
+ virtual void SchedulePendingLossyWrites() = 0; |
+ |
+ protected: |
+ ~PersistentPrefStore() override {} |
+}; |
+ |
+#endif // BASE_PREFS_PERSISTENT_PREF_STORE_H_ |