xref: /aosp_15_r20/external/cronet/components/prefs/pref_change_registrar.cc (revision 6777b5387eb2ff775bb5750e3f5d96f37fb7352b)
1*6777b538SAndroid Build Coastguard Worker // Copyright 2010 The Chromium Authors
2*6777b538SAndroid Build Coastguard Worker // Use of this source code is governed by a BSD-style license that can be
3*6777b538SAndroid Build Coastguard Worker // found in the LICENSE file.
4*6777b538SAndroid Build Coastguard Worker 
5*6777b538SAndroid Build Coastguard Worker #include "components/prefs/pref_change_registrar.h"
6*6777b538SAndroid Build Coastguard Worker 
7*6777b538SAndroid Build Coastguard Worker #include <ostream>
8*6777b538SAndroid Build Coastguard Worker 
9*6777b538SAndroid Build Coastguard Worker #include "base/check.h"
10*6777b538SAndroid Build Coastguard Worker #include "base/functional/bind.h"
11*6777b538SAndroid Build Coastguard Worker #include "base/notreached.h"
12*6777b538SAndroid Build Coastguard Worker #include "components/prefs/pref_service.h"
13*6777b538SAndroid Build Coastguard Worker 
PrefChangeRegistrar()14*6777b538SAndroid Build Coastguard Worker PrefChangeRegistrar::PrefChangeRegistrar() : service_(nullptr) {}
15*6777b538SAndroid Build Coastguard Worker 
~PrefChangeRegistrar()16*6777b538SAndroid Build Coastguard Worker PrefChangeRegistrar::~PrefChangeRegistrar() {
17*6777b538SAndroid Build Coastguard Worker   // If you see an invalid memory access in this destructor, this
18*6777b538SAndroid Build Coastguard Worker   // PrefChangeRegistrar might be subscribed to an OffTheRecordProfileImpl that
19*6777b538SAndroid Build Coastguard Worker   // has been destroyed. This should not happen any more but be warned.
20*6777b538SAndroid Build Coastguard Worker   // Feel free to contact [email protected] in case this happens.
21*6777b538SAndroid Build Coastguard Worker   //
22*6777b538SAndroid Build Coastguard Worker   // This can also happen for non-OTR profiles, when the
23*6777b538SAndroid Build Coastguard Worker   // DestroyProfileOnBrowserClose flag is enabled. In that case, contact
24*6777b538SAndroid Build Coastguard Worker   // [email protected].
25*6777b538SAndroid Build Coastguard Worker   RemoveAll();
26*6777b538SAndroid Build Coastguard Worker }
27*6777b538SAndroid Build Coastguard Worker 
Init(PrefService * service)28*6777b538SAndroid Build Coastguard Worker void PrefChangeRegistrar::Init(PrefService* service) {
29*6777b538SAndroid Build Coastguard Worker   DCHECK(IsEmpty() || service_ == service);
30*6777b538SAndroid Build Coastguard Worker   service_ = service;
31*6777b538SAndroid Build Coastguard Worker }
32*6777b538SAndroid Build Coastguard Worker 
Reset()33*6777b538SAndroid Build Coastguard Worker void PrefChangeRegistrar::Reset() {
34*6777b538SAndroid Build Coastguard Worker   RemoveAll();
35*6777b538SAndroid Build Coastguard Worker   service_ = nullptr;
36*6777b538SAndroid Build Coastguard Worker }
37*6777b538SAndroid Build Coastguard Worker 
Add(const std::string & path,const base::RepeatingClosure & obs)38*6777b538SAndroid Build Coastguard Worker void PrefChangeRegistrar::Add(const std::string& path,
39*6777b538SAndroid Build Coastguard Worker                               const base::RepeatingClosure& obs) {
40*6777b538SAndroid Build Coastguard Worker   Add(path,
41*6777b538SAndroid Build Coastguard Worker       base::BindRepeating(&PrefChangeRegistrar::InvokeUnnamedCallback, obs));
42*6777b538SAndroid Build Coastguard Worker }
43*6777b538SAndroid Build Coastguard Worker 
Add(const std::string & path,const NamedChangeCallback & obs)44*6777b538SAndroid Build Coastguard Worker void PrefChangeRegistrar::Add(const std::string& path,
45*6777b538SAndroid Build Coastguard Worker                               const NamedChangeCallback& obs) {
46*6777b538SAndroid Build Coastguard Worker   if (!service_) {
47*6777b538SAndroid Build Coastguard Worker     NOTREACHED();
48*6777b538SAndroid Build Coastguard Worker     return;
49*6777b538SAndroid Build Coastguard Worker   }
50*6777b538SAndroid Build Coastguard Worker   DCHECK(!IsObserved(path)) << "Already had pref, \"" << path
51*6777b538SAndroid Build Coastguard Worker                             << "\", registered.";
52*6777b538SAndroid Build Coastguard Worker 
53*6777b538SAndroid Build Coastguard Worker   service_->AddPrefObserver(path, this);
54*6777b538SAndroid Build Coastguard Worker   observers_[path] = obs;
55*6777b538SAndroid Build Coastguard Worker }
56*6777b538SAndroid Build Coastguard Worker 
Remove(const std::string & path)57*6777b538SAndroid Build Coastguard Worker void PrefChangeRegistrar::Remove(const std::string& path) {
58*6777b538SAndroid Build Coastguard Worker   DCHECK(IsObserved(path));
59*6777b538SAndroid Build Coastguard Worker 
60*6777b538SAndroid Build Coastguard Worker   observers_.erase(path);
61*6777b538SAndroid Build Coastguard Worker   service_->RemovePrefObserver(path, this);
62*6777b538SAndroid Build Coastguard Worker }
63*6777b538SAndroid Build Coastguard Worker 
RemoveAll()64*6777b538SAndroid Build Coastguard Worker void PrefChangeRegistrar::RemoveAll() {
65*6777b538SAndroid Build Coastguard Worker   for (ObserverMap::const_iterator it = observers_.begin();
66*6777b538SAndroid Build Coastguard Worker        it != observers_.end(); ++it) {
67*6777b538SAndroid Build Coastguard Worker     service_->RemovePrefObserver(it->first, this);
68*6777b538SAndroid Build Coastguard Worker   }
69*6777b538SAndroid Build Coastguard Worker 
70*6777b538SAndroid Build Coastguard Worker   observers_.clear();
71*6777b538SAndroid Build Coastguard Worker }
72*6777b538SAndroid Build Coastguard Worker 
IsEmpty() const73*6777b538SAndroid Build Coastguard Worker bool PrefChangeRegistrar::IsEmpty() const {
74*6777b538SAndroid Build Coastguard Worker   return observers_.empty();
75*6777b538SAndroid Build Coastguard Worker }
76*6777b538SAndroid Build Coastguard Worker 
IsObserved(const std::string & pref)77*6777b538SAndroid Build Coastguard Worker bool PrefChangeRegistrar::IsObserved(const std::string& pref) {
78*6777b538SAndroid Build Coastguard Worker   return observers_.find(pref) != observers_.end();
79*6777b538SAndroid Build Coastguard Worker }
80*6777b538SAndroid Build Coastguard Worker 
OnPreferenceChanged(PrefService * service,const std::string & pref)81*6777b538SAndroid Build Coastguard Worker void PrefChangeRegistrar::OnPreferenceChanged(PrefService* service,
82*6777b538SAndroid Build Coastguard Worker                                               const std::string& pref) {
83*6777b538SAndroid Build Coastguard Worker   if (IsObserved(pref))
84*6777b538SAndroid Build Coastguard Worker     observers_[pref].Run(pref);
85*6777b538SAndroid Build Coastguard Worker }
86*6777b538SAndroid Build Coastguard Worker 
InvokeUnnamedCallback(const base::RepeatingClosure & callback,const std::string & pref_name)87*6777b538SAndroid Build Coastguard Worker void PrefChangeRegistrar::InvokeUnnamedCallback(
88*6777b538SAndroid Build Coastguard Worker     const base::RepeatingClosure& callback,
89*6777b538SAndroid Build Coastguard Worker     const std::string& pref_name) {
90*6777b538SAndroid Build Coastguard Worker   callback.Run();
91*6777b538SAndroid Build Coastguard Worker }
92*6777b538SAndroid Build Coastguard Worker 
prefs()93*6777b538SAndroid Build Coastguard Worker PrefService* PrefChangeRegistrar::prefs() {
94*6777b538SAndroid Build Coastguard Worker   return service_;
95*6777b538SAndroid Build Coastguard Worker }
96*6777b538SAndroid Build Coastguard Worker 
prefs() const97*6777b538SAndroid Build Coastguard Worker const PrefService* PrefChangeRegistrar::prefs() const {
98*6777b538SAndroid Build Coastguard Worker   return service_;
99*6777b538SAndroid Build Coastguard Worker }
100