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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
// 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 EXTENSIONS_BROWSER_BROWSER_CONTEXT_KEYED_API_FACTORY_H_
#define EXTENSIONS_BROWSER_BROWSER_CONTEXT_KEYED_API_FACTORY_H_
#include "components/keyed_service/content/browser_context_dependency_manager.h"
#include "components/keyed_service/content/browser_context_keyed_service_factory.h"
#include "components/keyed_service/core/keyed_service.h"
#include "extensions/browser/extension_system_provider.h"
#include "extensions/browser/extensions_browser_client.h"
namespace extensions {
template <typename T>
class BrowserContextKeyedAPIFactory;
// Instantiations of BrowserContextKeyedAPIFactory should use this base class
// and also define a static const char* service_name() function (used in the
// BrowserContextKeyedBaseFactory constructor). These fields should
// be accessible to the BrowserContextKeyedAPIFactory for the service.
class BrowserContextKeyedAPI : public KeyedService {
protected:
// Defaults for flags that control BrowserContextKeyedAPIFactory behavior.
// These can be overridden by subclasses to change that behavior.
// See BrowserContextKeyedBaseFactory for usage.
// These flags affect what instance is returned when Get() is called
// on an incognito profile. By default, it returns NULL. If
// kServiceRedirectedInIncognito is true, it returns the instance for the
// corresponding regular profile. If kServiceHasOwnInstanceInIncognito
// is true, it returns a separate instance.
static const bool kServiceRedirectedInIncognito = false;
static const bool kServiceHasOwnInstanceInIncognito = false;
// If set to false, don't start the service at BrowserContext creation time.
// (The default differs from the BrowserContextKeyedBaseFactory default,
// because historically, BrowserContextKeyedAPIs often do tasks at startup.)
static const bool kServiceIsCreatedWithBrowserContext = true;
// If set to true, GetForProfile returns NULL for TestingBrowserContexts.
static const bool kServiceIsNULLWhileTesting = false;
// Users of this factory template must define a GetFactoryInstance()
// and manage their own instances (typically using LazyInstance or
// Singleton), because those cannot be included in more than one
// translation unit (and thus cannot be initialized in a header file).
//
// In the header file, declare GetFactoryInstance(), e.g.:
// class HistoryAPI {
// ...
// public:
// static BrowserContextKeyedAPIFactory<HistoryAPI>* GetFactoryInstance();
// };
//
// In the cc file, provide the implementation, e.g.:
// static base::LazyInstance<BrowserContextKeyedAPIFactory<HistoryAPI> >
// g_factory = LAZY_INSTANCE_INITIALIZER;
//
// // static
// BrowserContextKeyedAPIFactory<HistoryAPI>*
// HistoryAPI::GetFactoryInstance() {
// return g_factory.Pointer();
// }
};
// A template for factories for KeyedServices that manage extension APIs. T is
// a KeyedService that uses this factory template instead of its own separate
// factory definition to manage its per-profile instances.
template <typename T>
class BrowserContextKeyedAPIFactory : public BrowserContextKeyedServiceFactory {
public:
static T* Get(content::BrowserContext* context) {
return static_cast<T*>(
T::GetFactoryInstance()->GetServiceForBrowserContext(context, true));
}
// Declare dependencies on other factories.
// By default, ExtensionSystemFactory is the only dependency; however,
// specializations can override this. Declare your specialization in
// your header file after the BrowserContextKeyedAPI class definition.
// Then in the cc file (or inline in the header), define it, e.g.:
// template <>
// void BrowserContextKeyedAPIFactory<
// PushMessagingAPI>::DeclareFactoryDependencies() {
// DependsOn(ExtensionsBrowserClient::Get()->GetExtensionSystemFactory());
// DependsOn(ProfileSyncServiceFactory::GetInstance());
// }
void DeclareFactoryDependencies() {
DependsOn(ExtensionsBrowserClient::Get()->GetExtensionSystemFactory());
}
BrowserContextKeyedAPIFactory()
: BrowserContextKeyedServiceFactory(
T::service_name(),
BrowserContextDependencyManager::GetInstance()) {
DeclareFactoryDependencies();
}
virtual ~BrowserContextKeyedAPIFactory() {}
private:
// BrowserContextKeyedServiceFactory implementation.
virtual KeyedService* BuildServiceInstanceFor(
content::BrowserContext* context) const OVERRIDE {
return new T(context);
}
// BrowserContextKeyedBaseFactory implementation.
// These can be effectively overridden with template specializations.
virtual content::BrowserContext* GetBrowserContextToUse(
content::BrowserContext* context) const OVERRIDE {
if (T::kServiceRedirectedInIncognito)
return ExtensionsBrowserClient::Get()->GetOriginalContext(context);
if (T::kServiceHasOwnInstanceInIncognito)
return context;
return BrowserContextKeyedServiceFactory::GetBrowserContextToUse(context);
}
virtual bool ServiceIsCreatedWithBrowserContext() const OVERRIDE {
return T::kServiceIsCreatedWithBrowserContext;
}
virtual bool ServiceIsNULLWhileTesting() const OVERRIDE {
return T::kServiceIsNULLWhileTesting;
}
DISALLOW_COPY_AND_ASSIGN(BrowserContextKeyedAPIFactory);
};
} // namespace extensions
#endif // EXTENSIONS_BROWSER_BROWSER_CONTEXT_KEYED_API_FACTORY_H_
|
