15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2011 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) 52a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#ifndef BASE_PREFS_PREF_NOTIFIER_IMPL_H_ 62a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#define BASE_PREFS_PREF_NOTIFIER_IMPL_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <list> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/callback.h" 122a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "base/compiler_specific.h" 137d4cd473f85ac64c3747c96c277f9e506a0d2246Torne (Richard Coles)#include "base/containers/hash_tables.h" 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/observer_list.h" 152a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "base/prefs/base_prefs_export.h" 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/prefs/pref_notifier.h" 172a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#include "base/prefs/pref_observer.h" 18c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)#include "base/threading/thread_checker.h" 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class PrefService; 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// The PrefNotifier implementation used by the PrefService. 232a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)class BASE_PREFS_EXPORT PrefNotifierImpl 24c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) : public NON_EXPORTED_BASE(PrefNotifier) { 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PrefNotifierImpl(); 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) explicit PrefNotifierImpl(PrefService* pref_service); 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~PrefNotifierImpl(); 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // If the pref at the given path changes, we call the observer's 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // OnPreferenceChanged method. 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void AddPrefObserver(const char* path, PrefObserver* observer); 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void RemovePrefObserver(const char* path, PrefObserver* observer); 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // We run the callback once, when initialization completes. The bool 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // parameter will be set to true for successful initialization, 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // false for unsuccessful. 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void AddInitObserver(base::Callback<void(bool)> observer); 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetPrefService(PrefService* pref_service); 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) protected: 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // PrefNotifier overrides. 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnPreferenceChanged(const std::string& pref_name) OVERRIDE; 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnInitializationCompleted(bool succeeded) OVERRIDE; 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // A map from pref names to a list of observers. Observers get fired in the 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // order they are added. These should only be accessed externally for unit 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // testing. 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef ObserverList<PrefObserver> PrefObserverList; 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef base::hash_map<std::string, PrefObserverList*> PrefObserverMap; 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef std::list<base::Callback<void(bool)> > PrefInitObserverList; 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const PrefObserverMap* pref_observers() const { return &pref_observers_; } 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // For the given pref_name, fire any observer of the pref. Virtual so it can 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // be mocked for unit testing. 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void FireObservers(const std::string& path); 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Weak reference; the notifier is owned by the PrefService. 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PrefService* pref_service_; 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PrefObserverMap pref_observers_; 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) PrefInitObserverList init_observers_; 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 68c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) base::ThreadChecker thread_checker_; 69c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(PrefNotifierImpl); 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 732a99a7e74a7f215066514fe81d2bfa6639d9edddTorne (Richard Coles)#endif // BASE_PREFS_PREF_NOTIFIER_IMPL_H_ 74