OLD | NEW |
---|---|
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2012 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 | 7 |
8 #include <set> | 8 #include <set> |
9 #include <string> | 9 #include <string> |
10 | 10 |
11 #include "base/basictypes.h" | 11 #include "base/basictypes.h" |
12 #include "base/compiler_specific.h" | 12 #include "base/compiler_specific.h" |
13 #include "base/file_path.h" | 13 #include "base/file_path.h" |
14 #include "base/memory/scoped_ptr.h" | 14 #include "base/memory/scoped_ptr.h" |
15 #include "base/observer_list.h" | 15 #include "base/observer_list.h" |
16 #include "chrome/common/important_file_writer.h" | 16 #include "chrome/common/important_file_writer.h" |
17 #include "chrome/common/persistent_pref_store.h" | 17 #include "chrome/common/persistent_pref_store.h" |
18 | 18 |
19 namespace base { | 19 namespace base { |
20 class DictionaryValue; | 20 class DictionaryValue; |
21 class MessageLoopProxy; | 21 class SequencedWorkerPool; |
22 class SequencedTaskRunner; | |
22 class Value; | 23 class Value; |
23 } | 24 } |
24 | 25 |
25 class FilePath; | 26 class FilePath; |
26 | 27 |
27 // A writable PrefStore implementation that is used for user preferences. | 28 // A writable PrefStore implementation that is used for user preferences. |
28 class JsonPrefStore : public PersistentPrefStore, | 29 class JsonPrefStore : public PersistentPrefStore, |
29 public ImportantFileWriter::DataSerializer { | 30 public ImportantFileWriter::DataSerializer { |
30 public: | 31 public: |
31 // |file_message_loop_proxy| is the MessageLoopProxy for a thread on which | 32 // |worker_pool| is the SequencedWorkerPool on which file I/O can be done. |
32 // file I/O can be done. | 33 // The worker pool will also ensure that write requests for the same file are |
33 JsonPrefStore(const FilePath& pref_filename, | 34 // sequenced properly and that such request block shutdown. |
akalin
2012/10/10 01:43:16
request -> requests
zel
2012/10/10 23:25:00
Done.
| |
34 base::MessageLoopProxy* file_message_loop_proxy); | 35 static JsonPrefStore* Create(const FilePath& pref_filename, |
akalin
2012/10/10 01:43:16
return scoped_ptr?
| |
36 base::SequencedWorkerPool* worker_pool); | |
35 | 37 |
36 // PrefStore overrides: | 38 // PrefStore overrides: |
37 virtual ReadResult GetValue(const std::string& key, | 39 virtual ReadResult GetValue(const std::string& key, |
38 const base::Value** result) const OVERRIDE; | 40 const base::Value** result) const OVERRIDE; |
39 virtual void AddObserver(PrefStore::Observer* observer) OVERRIDE; | 41 virtual void AddObserver(PrefStore::Observer* observer) OVERRIDE; |
40 virtual void RemoveObserver(PrefStore::Observer* observer) OVERRIDE; | 42 virtual void RemoveObserver(PrefStore::Observer* observer) OVERRIDE; |
41 virtual size_t NumberOfObservers() const OVERRIDE; | 43 virtual size_t NumberOfObservers() const OVERRIDE; |
42 virtual bool IsInitializationComplete() const OVERRIDE; | 44 virtual bool IsInitializationComplete() const OVERRIDE; |
43 | 45 |
44 // PersistentPrefStore overrides: | 46 // PersistentPrefStore overrides: |
(...skipping 11 matching lines...) Expand all Loading... | |
56 virtual void CommitPendingWrite() OVERRIDE; | 58 virtual void CommitPendingWrite() OVERRIDE; |
57 virtual void ReportValueChanged(const std::string& key) OVERRIDE; | 59 virtual void ReportValueChanged(const std::string& key) OVERRIDE; |
58 | 60 |
59 // This method is called after JSON file has been read. Method takes | 61 // This method is called after JSON file has been read. Method takes |
60 // ownership of the |value| pointer. Note, this method is used with | 62 // ownership of the |value| pointer. Note, this method is used with |
61 // asynchronous file reading, so class exposes it only for the internal needs. | 63 // asynchronous file reading, so class exposes it only for the internal needs. |
62 // (read: do not call it manually). | 64 // (read: do not call it manually). |
63 void OnFileRead(base::Value* value_owned, PrefReadError error, bool no_dir); | 65 void OnFileRead(base::Value* value_owned, PrefReadError error, bool no_dir); |
64 | 66 |
65 private: | 67 private: |
68 // |task_runner| is the TaskRunner for a thread on which file I/O can be done. | |
69 JsonPrefStore(const FilePath& pref_filename, | |
70 base::SequencedTaskRunner* task_runner); | |
66 virtual ~JsonPrefStore(); | 71 virtual ~JsonPrefStore(); |
67 | 72 |
68 // ImportantFileWriter::DataSerializer overrides: | 73 // ImportantFileWriter::DataSerializer overrides: |
69 virtual bool SerializeData(std::string* output) OVERRIDE; | 74 virtual bool SerializeData(std::string* output) OVERRIDE; |
70 | 75 |
71 FilePath path_; | 76 FilePath path_; |
72 scoped_refptr<base::MessageLoopProxy> file_message_loop_proxy_; | 77 scoped_refptr<base::SequencedTaskRunner> task_runner_; |
akalin
2012/10/10 01:43:16
make this const
zel
2012/10/10 23:25:00
that's not going to work since we use non-const me
akalin
2012/10/12 19:23:57
I meant make the pointer const, like:
'const scop
| |
73 | 78 |
74 scoped_ptr<base::DictionaryValue> prefs_; | 79 scoped_ptr<base::DictionaryValue> prefs_; |
75 | 80 |
76 bool read_only_; | 81 bool read_only_; |
77 | 82 |
78 // Helper for safely writing pref data. | 83 // Helper for safely writing pref data. |
79 ImportantFileWriter writer_; | 84 ImportantFileWriter writer_; |
80 | 85 |
81 ObserverList<PrefStore::Observer, true> observers_; | 86 ObserverList<PrefStore::Observer, true> observers_; |
82 | 87 |
83 scoped_ptr<ReadErrorDelegate> error_delegate_; | 88 scoped_ptr<ReadErrorDelegate> error_delegate_; |
84 | 89 |
85 bool initialized_; | 90 bool initialized_; |
86 PrefReadError read_error_; | 91 PrefReadError read_error_; |
87 | 92 |
88 std::set<std::string> keys_need_empty_value_; | 93 std::set<std::string> keys_need_empty_value_; |
89 | 94 |
90 DISALLOW_COPY_AND_ASSIGN(JsonPrefStore); | 95 DISALLOW_COPY_AND_ASSIGN(JsonPrefStore); |
91 }; | 96 }; |
92 | 97 |
93 #endif // CHROME_COMMON_JSON_PREF_STORE_H_ | 98 #endif // CHROME_COMMON_JSON_PREF_STORE_H_ |
OLD | NEW |