File: pref_service_factory.h

package info (click to toggle)
chromium 138.0.7204.183-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-proposed-updates
  • size: 6,080,960 kB
  • sloc: cpp: 34,937,079; ansic: 7,176,967; javascript: 4,110,704; python: 1,419,954; asm: 946,768; xml: 739,971; pascal: 187,324; sh: 89,623; perl: 88,663; objc: 79,944; sql: 50,304; cs: 41,786; fortran: 24,137; makefile: 21,811; php: 13,980; tcl: 13,166; yacc: 8,925; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (95 lines) | stat: -rw-r--r-- 2,950 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
// Copyright 2013 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_PREFS_PREF_SERVICE_FACTORY_H_
#define COMPONENTS_PREFS_PREF_SERVICE_FACTORY_H_

#include "base/functional/callback.h"
#include "base/memory/ref_counted.h"
#include "components/prefs/persistent_pref_store.h"
#include "components/prefs/pref_registry.h"
#include "components/prefs/pref_store.h"
#include "components/prefs/pref_value_store.h"
#include "components/prefs/prefs_export.h"

class PrefService;

namespace base {
class FilePath;
class SequencedTaskRunner;
}

// A class that allows convenient building of PrefService.
class COMPONENTS_PREFS_EXPORT PrefServiceFactory {
 public:
  PrefServiceFactory();

  PrefServiceFactory(const PrefServiceFactory&) = delete;
  PrefServiceFactory& operator=(const PrefServiceFactory&) = delete;

  virtual ~PrefServiceFactory();

  // Functions for setting the various parameters of the PrefService to build.
  void set_managed_prefs(scoped_refptr<PrefStore> prefs) {
    managed_prefs_.swap(prefs);
  }

  void set_supervised_user_prefs(scoped_refptr<PrefStore> prefs) {
    supervised_user_prefs_.swap(prefs);
  }

  void set_extension_prefs(scoped_refptr<PrefStore> prefs) {
    extension_prefs_.swap(prefs);
  }

  void set_command_line_prefs(scoped_refptr<PrefStore> prefs) {
    command_line_prefs_.swap(prefs);
  }

  void set_user_prefs(scoped_refptr<PersistentPrefStore> prefs) {
    user_prefs_.swap(prefs);
  }

  void set_recommended_prefs(scoped_refptr<PrefStore> prefs) {
    recommended_prefs_.swap(prefs);
  }

  // Sets up error callback for the PrefService.  A do-nothing default is
  // provided if this is not called. This callback is always invoked (async or
  // not) on the sequence on which Create is invoked.
  void set_read_error_callback(
      base::RepeatingCallback<void(PersistentPrefStore::PrefReadError)>
          read_error_callback) {
    read_error_callback_ = std::move(read_error_callback);
  }

  // Specifies to use an actual file-backed user pref store.
  void SetUserPrefsFile(const base::FilePath& prefs_file,
                        base::SequencedTaskRunner* task_runner);

  void set_async(bool async) {
    async_ = async;
  }

  // Creates a PrefService object initialized with the parameters from
  // this factory.
  std::unique_ptr<PrefService> Create(
      scoped_refptr<PrefRegistry> pref_registry);

 protected:
  scoped_refptr<PrefStore> managed_prefs_;
  scoped_refptr<PrefStore> supervised_user_prefs_;
  scoped_refptr<PrefStore> extension_prefs_;
  scoped_refptr<PrefStore> command_line_prefs_;
  scoped_refptr<PersistentPrefStore> user_prefs_;
  scoped_refptr<PrefStore> recommended_prefs_;

  base::RepeatingCallback<void(PersistentPrefStore::PrefReadError)>
      read_error_callback_;

  // Defaults to false.
  bool async_;
};

#endif  // COMPONENTS_PREFS_PREF_SERVICE_FACTORY_H_