testing_pref_store.h revision 72a454cd3513ac24fbdd0e0cb9ad70b86a99b801
172a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen// Copyright (c) 2011 The Chromium Authors. All rights reserved. 221d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen// Use of this source code is governed by a BSD-style license that can be 321d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen// found in the LICENSE file. 421d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen 521d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen#ifndef CHROME_BROWSER_PREFS_TESTING_PREF_STORE_H_ 621d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen#define CHROME_BROWSER_PREFS_TESTING_PREF_STORE_H_ 721d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen#pragma once 821d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen 921d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen#include "base/basictypes.h" 1021d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen#include "base/observer_list.h" 1121d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen#include "base/scoped_ptr.h" 1221d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen#include "chrome/browser/prefs/pref_value_map.h" 1321d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen#include "chrome/common/persistent_pref_store.h" 1421d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen 1521d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsenclass DictionaryValue; 1621d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen 1721d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen// |TestingPrefStore| is a preference store implementation that allows tests to 1821d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen// explicitly manipulate the contents of the store, triggering notifications 1921d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen// where appropriate. 2021d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsenclass TestingPrefStore : public PersistentPrefStore { 2121d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen public: 2221d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen TestingPrefStore(); 2372a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen virtual ~TestingPrefStore(); 2421d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen 2521d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen // Overriden from PrefStore. 2621d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen virtual ReadResult GetValue(const std::string& key, Value** result) const; 2721d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen virtual void AddObserver(PrefStore::Observer* observer); 2821d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen virtual void RemoveObserver(PrefStore::Observer* observer); 2972a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen virtual bool IsInitializationComplete() const; 3021d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen 3121d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen // PersistentPrefStore overrides: 3221d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen virtual void SetValue(const std::string& key, Value* value); 3321d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen virtual void SetValueSilently(const std::string& key, Value* value); 3421d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen virtual void RemoveValue(const std::string& key); 3572a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen virtual bool ReadOnly() const; 3621d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen virtual PersistentPrefStore::PrefReadError ReadPrefs(); 3721d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen virtual bool WritePrefs(); 3821d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen virtual void ScheduleWritePrefs() {} 3921d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen 4021d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen // Marks the store as having completed initialization. 4121d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen void SetInitializationCompleted(); 4221d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen 4321d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen // Used for tests to trigger notifications explicitly. 4421d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen void NotifyPrefValueChanged(const std::string& key); 4521d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen void NotifyInitializationCompleted(); 4621d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen 4721d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen // Some convenience getters/setters. 4821d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen void SetString(const std::string& key, const std::string& value); 4921d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen void SetInteger(const std::string& key, int value); 5021d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen void SetBoolean(const std::string& key, bool value); 5121d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen 5221d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen bool GetString(const std::string& key, std::string* value) const; 5321d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen bool GetInteger(const std::string& key, int* value) const; 5421d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen bool GetBoolean(const std::string& key, bool* value) const; 5521d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen 5621d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen // Getter and Setter methods for setting and getting the state of the 5721d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen // |TestingPrefStore|. 5872a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen virtual void set_read_only(bool read_only); 5972a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen virtual void set_prefs_written(bool status); 6072a454cd3513ac24fbdd0e0cb9ad70b86a99b801Kristian Monsen virtual bool get_prefs_written(); 6121d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen 6221d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen private: 6321d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen // Stores the preference values. 6421d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen PrefValueMap prefs_; 6521d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen 6621d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen // Flag that indicates if the PrefStore is read-only 6721d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen bool read_only_; 6821d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen 6921d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen // Flag that indicates if the method WritePrefs was called. 7021d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen bool prefs_written_; 7121d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen 7221d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen // Whether initialization has been completed. 7321d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen bool init_complete_; 7421d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen 7521d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen ObserverList<PrefStore::Observer, true> observers_; 7621d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen 7721d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen DISALLOW_COPY_AND_ASSIGN(TestingPrefStore); 7821d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen}; 7921d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen 8021d179b334e59e9a3bfcaed4c4430bef1bc5759dKristian Monsen#endif // CHROME_BROWSER_PREFS_TESTING_PREF_STORE_H_ 81