OLD | NEW |
1 // Copyright (c) 2011 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2011 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 CHROME_COMMON_JSON_PREF_STORE_H_ | 5 #ifndef CHROME_COMMON_JSON_PREF_STORE_H_ |
6 #define CHROME_COMMON_JSON_PREF_STORE_H_ | 6 #define CHROME_COMMON_JSON_PREF_STORE_H_ |
7 #pragma once | 7 #pragma once |
8 | 8 |
9 #include <string> | 9 #include <string> |
10 | 10 |
11 #include "base/basictypes.h" | 11 #include "base/basictypes.h" |
12 #include "base/file_path.h" | 12 #include "base/file_path.h" |
13 #include "base/memory/scoped_ptr.h" | 13 #include "base/memory/scoped_ptr.h" |
14 #include "base/observer_list.h" | 14 #include "base/observer_list.h" |
15 #include "chrome/common/important_file_writer.h" | 15 #include "chrome/common/important_file_writer.h" |
16 #include "chrome/common/persistent_pref_store.h" | 16 #include "chrome/common/persistent_pref_store.h" |
17 | 17 |
18 namespace base { | 18 namespace base { |
| 19 class DictionaryValue; |
19 class MessageLoopProxy; | 20 class MessageLoopProxy; |
| 21 class Value; |
20 } | 22 } |
21 | 23 |
22 class DictionaryValue; | |
23 class FilePath; | 24 class FilePath; |
24 class Value; | |
25 | 25 |
26 // A writable PrefStore implementation that is used for user preferences. | 26 // A writable PrefStore implementation that is used for user preferences. |
27 class JsonPrefStore : public PersistentPrefStore, | 27 class JsonPrefStore : public PersistentPrefStore, |
28 public ImportantFileWriter::DataSerializer { | 28 public ImportantFileWriter::DataSerializer { |
29 public: | 29 public: |
30 // |file_message_loop_proxy| is the MessageLoopProxy for a thread on which | 30 // |file_message_loop_proxy| is the MessageLoopProxy for a thread on which |
31 // file I/O can be done. | 31 // file I/O can be done. |
32 JsonPrefStore(const FilePath& pref_filename, | 32 JsonPrefStore(const FilePath& pref_filename, |
33 base::MessageLoopProxy* file_message_loop_proxy); | 33 base::MessageLoopProxy* file_message_loop_proxy); |
34 virtual ~JsonPrefStore(); | 34 virtual ~JsonPrefStore(); |
35 | 35 |
36 // PrefStore overrides: | 36 // PrefStore overrides: |
37 virtual ReadResult GetValue(const std::string& key, | 37 virtual ReadResult GetValue(const std::string& key, |
38 const Value** result) const; | 38 const base::Value** result) const; |
39 virtual void AddObserver(PrefStore::Observer* observer); | 39 virtual void AddObserver(PrefStore::Observer* observer); |
40 virtual void RemoveObserver(PrefStore::Observer* observer); | 40 virtual void RemoveObserver(PrefStore::Observer* observer); |
41 virtual bool IsInitializationComplete() const; | 41 virtual bool IsInitializationComplete() const; |
42 | 42 |
43 // PersistentPrefStore overrides: | 43 // PersistentPrefStore overrides: |
44 virtual ReadResult GetMutableValue(const std::string& key, Value** result); | 44 virtual ReadResult GetMutableValue(const std::string& key, |
45 virtual void SetValue(const std::string& key, Value* value); | 45 base::Value** result); |
46 virtual void SetValueSilently(const std::string& key, Value* value); | 46 virtual void SetValue(const std::string& key, base::Value* value); |
| 47 virtual void SetValueSilently(const std::string& key, base::Value* value); |
47 virtual void RemoveValue(const std::string& key); | 48 virtual void RemoveValue(const std::string& key); |
48 virtual bool ReadOnly() const; | 49 virtual bool ReadOnly() const; |
49 virtual PrefReadError ReadPrefs(); | 50 virtual PrefReadError ReadPrefs(); |
50 virtual void ReadPrefsAsync(ReadErrorDelegate* error_delegate); | 51 virtual void ReadPrefsAsync(ReadErrorDelegate* error_delegate); |
51 virtual bool WritePrefs(); | 52 virtual bool WritePrefs(); |
52 virtual void ScheduleWritePrefs(); | 53 virtual void ScheduleWritePrefs(); |
53 virtual void CommitPendingWrite(); | 54 virtual void CommitPendingWrite(); |
54 virtual void ReportValueChanged(const std::string& key); | 55 virtual void ReportValueChanged(const std::string& key); |
55 | 56 |
56 // This method is called after JSON file has been read. Method takes | 57 // This method is called after JSON file has been read. Method takes |
57 // ownership of the |value| pointer. Note, this method is used with | 58 // ownership of the |value| pointer. Note, this method is used with |
58 // asynchronous file reading, so class exposes it only for the internal needs. | 59 // asynchronous file reading, so class exposes it only for the internal needs. |
59 // (read: do not call it manually). | 60 // (read: do not call it manually). |
60 void OnFileRead(Value* value_owned, PrefReadError error, bool no_dir); | 61 void OnFileRead(base::Value* value_owned, PrefReadError error, bool no_dir); |
61 | 62 |
62 private: | 63 private: |
63 // ImportantFileWriter::DataSerializer overrides: | 64 // ImportantFileWriter::DataSerializer overrides: |
64 virtual bool SerializeData(std::string* output); | 65 virtual bool SerializeData(std::string* output); |
65 | 66 |
66 FilePath path_; | 67 FilePath path_; |
67 scoped_refptr<base::MessageLoopProxy> file_message_loop_proxy_; | 68 scoped_refptr<base::MessageLoopProxy> file_message_loop_proxy_; |
68 | 69 |
69 scoped_ptr<DictionaryValue> prefs_; | 70 scoped_ptr<base::DictionaryValue> prefs_; |
70 | 71 |
71 bool read_only_; | 72 bool read_only_; |
72 | 73 |
73 // Helper for safely writing pref data. | 74 // Helper for safely writing pref data. |
74 ImportantFileWriter writer_; | 75 ImportantFileWriter writer_; |
75 | 76 |
76 ObserverList<PrefStore::Observer, true> observers_; | 77 ObserverList<PrefStore::Observer, true> observers_; |
77 | 78 |
78 scoped_ptr<ReadErrorDelegate> error_delegate_; | 79 scoped_ptr<ReadErrorDelegate> error_delegate_; |
79 | 80 |
80 bool initialized_; | 81 bool initialized_; |
81 | 82 |
82 DISALLOW_COPY_AND_ASSIGN(JsonPrefStore); | 83 DISALLOW_COPY_AND_ASSIGN(JsonPrefStore); |
83 }; | 84 }; |
84 | 85 |
85 #endif // CHROME_COMMON_JSON_PREF_STORE_H_ | 86 #endif // CHROME_COMMON_JSON_PREF_STORE_H_ |
OLD | NEW |