15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef BASE_PREFS_PREF_STORE_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define BASE_PREFS_PREF_STORE_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/basictypes.h" 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/ref_counted.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/prefs/base_prefs_export.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace base { 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Value; 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This is an abstract interface for reading and writing from/to a persistent 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// preference store, used by PrefService. An implementation using a JSON file 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// can be found in JsonPrefStore, while an implementation without any backing 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// store for testing can be found in TestingPrefStore. Furthermore, there is 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// CommandLinePrefStore, which bridges command line options to preferences and 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// ConfigurationPolicyPrefStore, which is used for hooking up configuration 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// policy with the preference subsystem. 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class BASE_PREFS_EXPORT PrefStore : public base::RefCounted<PrefStore> { 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Observer interface for monitoring PrefStore. 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) class BASE_PREFS_EXPORT Observer { 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called when the value for the given |key| in the store changes. 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnPrefValueChanged(const std::string& key) = 0; 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Notification about the PrefStore being fully initialized. 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnInitializationCompleted(bool succeeded) = 0; 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~Observer() {} 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PrefStore() {} 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Add and remove observers. 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void AddObserver(Observer* observer) {} 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void RemoveObserver(Observer* observer) {} 44424c4d7b64af9d0d8fd9624f381f469654d5e3d2Torne (Richard Coles) virtual bool HasObservers() const; 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Whether the store has completed all asynchronous initialization. 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool IsInitializationComplete() const; 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Get the value for a given preference |key| and stores it in |*result|. 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |*result| is only modified if the return value is true and if |result| 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // is not NULL. Ownership of the |*result| value remains with the PrefStore. 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool GetValue(const std::string& key, 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const base::Value** result) const = 0; 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) friend class base::RefCounted<PrefStore>; 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~PrefStore() {} 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(PrefStore); 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // BASE_PREFS_PREF_STORE_H_ 64