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 // Returns instance of SequencedTaskRunner which guarantees that file |
32 // file I/O can be done. | 33 // operations on the same file will be executed in sequenced order. |
33 JsonPrefStore(const FilePath& pref_filename, | 34 static scoped_refptr<base::SequencedTaskRunner> GetTaskRunnerForFile( |
akalin
2012/10/19 23:12:21
as discussed, please make this return a raw pointe
zel
2012/10/21 20:03:19
Done.
| |
34 base::MessageLoopProxy* file_message_loop_proxy); | 35 const FilePath& pref_filename, |
36 base::SequencedWorkerPool* worker_pool); | |
37 | |
38 // Creates an instance JsonPrefStore for a given |pref_filename| that will | |
39 // perform all file I/O operations on |sequenced_task_runner|. | |
40 // |sequenced_task_runner| must be a shutdown-blocking task runner, ideally | |
41 // created by GetTaskRunnerForFile() method above. | |
42 static JsonPrefStore* Create( | |
43 const FilePath& pref_filename, | |
44 base::SequencedTaskRunner* sequenced_task_runner); | |
35 | 45 |
36 // PrefStore overrides: | 46 // PrefStore overrides: |
37 virtual ReadResult GetValue(const std::string& key, | 47 virtual ReadResult GetValue(const std::string& key, |
38 const base::Value** result) const OVERRIDE; | 48 const base::Value** result) const OVERRIDE; |
39 virtual void AddObserver(PrefStore::Observer* observer) OVERRIDE; | 49 virtual void AddObserver(PrefStore::Observer* observer) OVERRIDE; |
40 virtual void RemoveObserver(PrefStore::Observer* observer) OVERRIDE; | 50 virtual void RemoveObserver(PrefStore::Observer* observer) OVERRIDE; |
41 virtual size_t NumberOfObservers() const OVERRIDE; | 51 virtual size_t NumberOfObservers() const OVERRIDE; |
42 virtual bool IsInitializationComplete() const OVERRIDE; | 52 virtual bool IsInitializationComplete() const OVERRIDE; |
43 | 53 |
44 // PersistentPrefStore overrides: | 54 // PersistentPrefStore overrides: |
(...skipping 11 matching lines...) Expand all Loading... | |
56 virtual void CommitPendingWrite() OVERRIDE; | 66 virtual void CommitPendingWrite() OVERRIDE; |
57 virtual void ReportValueChanged(const std::string& key) OVERRIDE; | 67 virtual void ReportValueChanged(const std::string& key) OVERRIDE; |
58 | 68 |
59 // This method is called after JSON file has been read. Method takes | 69 // This method is called after JSON file has been read. Method takes |
60 // ownership of the |value| pointer. Note, this method is used with | 70 // ownership of the |value| pointer. Note, this method is used with |
61 // asynchronous file reading, so class exposes it only for the internal needs. | 71 // asynchronous file reading, so class exposes it only for the internal needs. |
62 // (read: do not call it manually). | 72 // (read: do not call it manually). |
63 void OnFileRead(base::Value* value_owned, PrefReadError error, bool no_dir); | 73 void OnFileRead(base::Value* value_owned, PrefReadError error, bool no_dir); |
64 | 74 |
65 private: | 75 private: |
76 // |sequenced_task_runner| is a SequencedTaskRunner on which file I/O can | |
akalin
2012/10/19 23:12:21
remove 'can'
zel
2012/10/21 20:03:19
As I explained, that would be either cause a crash
| |
77 // will be run. | |
78 JsonPrefStore(const FilePath& pref_filename, | |
79 base::SequencedTaskRunner* sequenced_task_runner); | |
66 virtual ~JsonPrefStore(); | 80 virtual ~JsonPrefStore(); |
67 | 81 |
68 // ImportantFileWriter::DataSerializer overrides: | 82 // ImportantFileWriter::DataSerializer overrides: |
69 virtual bool SerializeData(std::string* output) OVERRIDE; | 83 virtual bool SerializeData(std::string* output) OVERRIDE; |
70 | 84 |
71 FilePath path_; | 85 FilePath path_; |
72 scoped_refptr<base::MessageLoopProxy> file_message_loop_proxy_; | 86 const scoped_refptr<base::SequencedTaskRunner> sequenced_task_runner_; |
73 | 87 |
74 scoped_ptr<base::DictionaryValue> prefs_; | 88 scoped_ptr<base::DictionaryValue> prefs_; |
75 | 89 |
76 bool read_only_; | 90 bool read_only_; |
77 | 91 |
78 // Helper for safely writing pref data. | 92 // Helper for safely writing pref data. |
79 ImportantFileWriter writer_; | 93 ImportantFileWriter writer_; |
80 | 94 |
81 ObserverList<PrefStore::Observer, true> observers_; | 95 ObserverList<PrefStore::Observer, true> observers_; |
82 | 96 |
83 scoped_ptr<ReadErrorDelegate> error_delegate_; | 97 scoped_ptr<ReadErrorDelegate> error_delegate_; |
84 | 98 |
85 bool initialized_; | 99 bool initialized_; |
86 PrefReadError read_error_; | 100 PrefReadError read_error_; |
87 | 101 |
88 std::set<std::string> keys_need_empty_value_; | 102 std::set<std::string> keys_need_empty_value_; |
89 | 103 |
90 DISALLOW_COPY_AND_ASSIGN(JsonPrefStore); | 104 DISALLOW_COPY_AND_ASSIGN(JsonPrefStore); |
91 }; | 105 }; |
92 | 106 |
93 #endif // CHROME_COMMON_JSON_PREF_STORE_H_ | 107 #endif // CHROME_COMMON_JSON_PREF_STORE_H_ |
OLD | NEW |