blob: 0a6eb603e1ec27da924da6fde5999d687c758c35 (
plain)
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
96
97
98
99
100
101
102
103
104
105
106
107
108
|
// Copyright 2014 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef COMPONENTS_KEYED_SERVICE_CONTENT_BROWSER_CONTEXT_DEPENDENCY_MANAGER_H_
#define COMPONENTS_KEYED_SERVICE_CONTENT_BROWSER_CONTEXT_DEPENDENCY_MANAGER_H_
#include <memory>
#include "base/callback_forward.h"
#include "base/callback_list.h"
#include "components/keyed_service/core/dependency_manager.h"
#include "components/keyed_service/core/keyed_service_export.h"
class BrowserContextKeyedBaseFactory;
namespace base {
template <typename T>
struct DefaultSingletonTraits;
} // namespace base
namespace content {
class BrowserContext;
}
namespace user_prefs {
class PrefRegistrySyncable;
}
// A singleton that listens for context destruction notifications and
// rebroadcasts them to each BrowserContextKeyedBaseFactory in a safe order
// based on the stated dependencies by each service.
class KEYED_SERVICE_EXPORT BrowserContextDependencyManager
: public DependencyManager {
public:
// Registers profile-specific preferences for all services via |registry|.
// |context| should be the BrowserContext containing |registry| and is used as
// a key to prevent multiple registrations on the same BrowserContext in
// tests.
void RegisterProfilePrefsForServices(
content::BrowserContext* context,
user_prefs::PrefRegistrySyncable* registry);
// Called by each BrowserContext to alert us of its creation. Several
// services want to be started when a context is created. If you want your
// KeyedService to be started with the BrowserContext, override
// BrowserContextKeyedBaseFactory::ServiceIsCreatedWithBrowserContext() to
// return true. This method also registers any service-related preferences
// for non-incognito profiles.
void CreateBrowserContextServices(content::BrowserContext* context);
// Similar to CreateBrowserContextServices(), except this is used for creating
// test BrowserContexts - these contexts will not create services for any
// BrowserContextKeyedBaseFactories that return true from
// ServiceIsNULLWhileTesting().
void CreateBrowserContextServicesForTest(content::BrowserContext* context);
// Called by each BrowserContext to alert us that we should destroy services
// associated with it.
void DestroyBrowserContextServices(content::BrowserContext* context);
// Registers a |callback| that will be called just before executing
// CreateBrowserContextServices() or CreateBrowserContextServicesForTest().
// This can be useful in browser tests which wish to substitute test or mock
// builders for the keyed services.
std::unique_ptr<
base::CallbackList<void(content::BrowserContext*)>::Subscription>
RegisterWillCreateBrowserContextServicesCallbackForTesting(
const base::Callback<void(content::BrowserContext*)>& callback);
// Runtime assertion called as a part of GetServiceForBrowserContext() to
// check if |context| is considered stale. This will NOTREACHED() or
// base::debug::DumpWithoutCrashing() depending on the DCHECK_IS_ON() value.
void AssertBrowserContextWasntDestroyed(
content::BrowserContext* context) const;
// Marks |context| as live (i.e., not stale). This method can be called as a
// safeguard against |AssertBrowserContextWasntDestroyed()| checks going off
// due to |context| aliasing a BrowserContext instance from a prior
// construction (i.e., 0xWhatever might be created, be destroyed, and then a
// new BrowserContext object might be created at 0xWhatever).
void MarkBrowserContextLive(content::BrowserContext* context);
static BrowserContextDependencyManager* GetInstance();
private:
friend class BrowserContextDependencyManagerUnittests;
friend struct base::DefaultSingletonTraits<BrowserContextDependencyManager>;
// Helper function used by CreateBrowserContextServices[ForTest].
void DoCreateBrowserContextServices(content::BrowserContext* context,
bool is_testing_context);
BrowserContextDependencyManager();
~BrowserContextDependencyManager() override;
#ifndef NDEBUG
// DependencyManager:
void DumpContextDependencies(base::SupportsUserData* context) const final;
#endif // NDEBUG
// A list of callbacks to call just before executing
// CreateBrowserContextServices() or CreateBrowserContextServicesForTest().
base::CallbackList<void(content::BrowserContext*)>
will_create_browser_context_services_callbacks_;
};
#endif // COMPONENTS_KEYED_SERVICE_CONTENT_BROWSER_CONTEXT_DEPENDENCY_MANAGER_H_
|
