File: browser_state_dependency_manager.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 (85 lines) | stat: -rw-r--r-- 3,444 bytes parent folder | download | duplicates (8)
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
// Copyright 2014 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_KEYED_SERVICE_IOS_BROWSER_STATE_DEPENDENCY_MANAGER_H_
#define COMPONENTS_KEYED_SERVICE_IOS_BROWSER_STATE_DEPENDENCY_MANAGER_H_

#include "base/callback_list.h"
#include "components/keyed_service/core/dependency_manager.h"
#include "components/keyed_service/core/keyed_service_export.h"

namespace base {
template <typename T>
struct DefaultSingletonTraits;
}  // namespace base

namespace web {
class BrowserState;
}

namespace user_prefs {
class PrefRegistrySyncable;
}

// A singleton that listens for context destruction notifications and
// rebroadcasts them to each KeyedServiceBaseFactory in a safe order
// based on the stated dependencies by each service.
class KEYED_SERVICE_EXPORT BrowserStateDependencyManager
    : public DependencyManager {
 public:
  static BrowserStateDependencyManager* GetInstance();

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

  // Registers context-specific preferences for all services via |registry|.
  void RegisterBrowserStatePrefsForServices(
      user_prefs::PrefRegistrySyncable* registry);

  // Called by each BrowserState to alert us of its creation. Service that
  // want to be started when BrowserState is created should override the
  // ServiceIsCreatedWithBrowserState() method in their factory. Preferences
  // registration also happens during that method call.
  void CreateBrowserStateServices(web::BrowserState* context);

  // Similar to CreateBrowserStateServices(), except this is used for creating
  // test BrowserStates - these contexts will not create services for any
  // BrowserStateKeyedBaseFactories that return true from
  // ServiceIsNULLWhileTesting().
  void CreateBrowserStateServicesForTest(web::BrowserState* context);

  // Called by each BrowserState to alert us that we should destroy services
  // associated with it.
  void DestroyBrowserStateServices(web::BrowserState* context);

  // Runtime assertion called as a part of GetServiceForBrowserState() to check
  // if |context| is considered stale. This will NOTREACHED() or
  // base::debug::DumpWithoutCrashing() depending on the DCHECK_IS_ON() value.
  void AssertBrowserStateWasntDestroyed(web::BrowserState* context) const;

  // Marks |context| as live (i.e., not stale). This method can be called as a
  // safeguard against |AssertBrowserStateWasntDestroyed()| checks going off
  // due to |context| aliasing a BrowserState instance from a prior construction
  // (i.e., 0xWhatever might be created, be destroyed, and then a new
  // BrowserState object might be created at 0xWhatever).
  void MarkBrowserStateLive(web::BrowserState* context);

 private:
  friend struct base::DefaultSingletonTraits<BrowserStateDependencyManager>;

  BrowserStateDependencyManager();
  ~BrowserStateDependencyManager() override;

  // Helper function used by CreateBrowserStateServices[ForTest].
  void DoCreateBrowserStateServices(web::BrowserState* context,
                                    bool is_testing_context);

#ifndef NDEBUG
  // DependencyManager:
  void DumpContextDependencies(void* context) const final;
#endif  // NDEBUG
};

#endif  // COMPONENTS_KEYED_SERVICE_IOS_BROWSER_STATE_DEPENDENCY_MANAGER_H_