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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
// Copyright (c) 2012 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 CONTENT_PUBLIC_COMMON_CONTENT_CLIENT_H_
#define CONTENT_PUBLIC_COMMON_CONTENT_CLIENT_H_
#include <set>
#include <string>
#include <vector>
#include "base/strings/string16.h"
#include "base/strings/string_piece.h"
#include "build/build_config.h"
#include "content/common/content_export.h"
#include "ui/base/layout.h"
#include "url/url_util.h"
class GURL;
namespace base {
class RefCountedStaticMemory;
}
namespace IPC {
class Message;
}
namespace gfx {
class Image;
}
namespace gpu {
struct GPUInfo;
}
namespace sandbox {
class TargetPolicy;
}
namespace content {
class ContentBrowserClient;
class ContentClient;
class ContentGpuClient;
class ContentPluginClient;
class ContentRendererClient;
class ContentUtilityClient;
struct PepperPluginInfo;
// Setter and getter for the client. The client should be set early, before any
// content code is called.
CONTENT_EXPORT void SetContentClient(ContentClient* client);
#if defined(CONTENT_IMPLEMENTATION)
// Content's embedder API should only be used by content.
ContentClient* GetContentClient();
#endif
// Used for tests to override the relevant embedder interfaces. Each method
// returns the old value.
CONTENT_EXPORT ContentBrowserClient* SetBrowserClientForTesting(
ContentBrowserClient* b);
CONTENT_EXPORT ContentRendererClient* SetRendererClientForTesting(
ContentRendererClient* r);
CONTENT_EXPORT ContentUtilityClient* SetUtilityClientForTesting(
ContentUtilityClient* u);
// Interface that the embedder implements.
class CONTENT_EXPORT ContentClient {
public:
ContentClient();
virtual ~ContentClient();
ContentBrowserClient* browser() { return browser_; }
ContentGpuClient* gpu() { return gpu_; }
ContentPluginClient* plugin() { return plugin_; }
ContentRendererClient* renderer() { return renderer_; }
ContentUtilityClient* utility() { return utility_; }
// Sets the currently active URL. Use GURL() to clear the URL.
virtual void SetActiveURL(const GURL& url) {}
// Sets the data on the current gpu.
virtual void SetGpuInfo(const gpu::GPUInfo& gpu_info) {}
// Gives the embedder a chance to register its own pepper plugins.
virtual void AddPepperPlugins(
std::vector<content::PepperPluginInfo>* plugins) {}
// Gives the embedder a chance to register its own standard, referrer and
// saveable url schemes early on in the startup sequence.
virtual void AddAdditionalSchemes(
std::vector<url::SchemeWithType>* standard_schemes,
std::vector<url::SchemeWithType>* referrer_schemes,
std::vector<std::string>* savable_schemes) {}
// Returns whether the given message should be sent in a swapped out renderer.
virtual bool CanSendWhileSwappedOut(const IPC::Message* message);
// Returns a string describing the embedder product name and version,
// of the form "productname/version", with no other slashes.
// Used as part of the user agent string.
virtual std::string GetProduct() const;
// Returns the user agent. Content may cache this value.
virtual std::string GetUserAgent() const;
// Returns a string resource given its id.
virtual base::string16 GetLocalizedString(int message_id) const;
// Return the contents of a resource in a StringPiece given the resource id.
virtual base::StringPiece GetDataResource(
int resource_id,
ui::ScaleFactor scale_factor) const;
// Returns the raw bytes of a scale independent data resource.
virtual base::RefCountedStaticMemory* GetDataResourceBytes(
int resource_id) const;
// Returns a native image given its id.
virtual gfx::Image& GetNativeImageNamed(int resource_id) const;
// Called by content::GetProcessTypeNameInEnglish for process types that it
// doesn't know about because they're from the embedder.
virtual std::string GetProcessTypeNameInEnglish(int type);
#if defined(OS_MACOSX) && !defined(OS_IOS)
// Allows the embedder to define a new |sandbox_type| by mapping it to the
// resource ID corresponding to the sandbox profile to use. The legal values
// for |sandbox_type| are defined by the embedder and should start with
// SandboxType::SANDBOX_TYPE_AFTER_LAST_TYPE. Returns false if no sandbox
// profile for the given |sandbox_type| exists. Otherwise,
// |sandbox_profile_resource_id| is set to the resource ID corresponding to
// the sandbox profile to use and true is returned.
virtual bool GetSandboxProfileForSandboxType(
int sandbox_type,
int* sandbox_profile_resource_id) const;
#endif
// Gives the embedder a chance to register additional schemes and origins
// that need to be considered trustworthy.
// See https://www.w3.org/TR/powerful-features/#is-origin-trustworthy.
virtual void AddSecureSchemesAndOrigins(std::set<std::string>* schemes,
std::set<GURL>* origins) {}
// Gives the embedder a chance to register additional schemes that
// should be allowed to register service workers. Only secure and
// trustworthy schemes should be added.
virtual void AddServiceWorkerSchemes(std::set<std::string>* schemes) {}
// Returns true if the embedder wishes to supplement the site isolation policy
// used by the content layer. Returning true enables the infrastructure for
// out-of-process iframes, and causes the content layer to consult
// ContentBrowserClient::DoesSiteRequireDedicatedProcess() when making process
// model decisions.
virtual bool IsSupplementarySiteIsolationModeEnabled();
// Returns the public key to be used for origin trials, or an empty string if
// origin trials are not enabled in this context.
virtual base::StringPiece GetOriginTrialPublicKey();
private:
friend class ContentClientInitializer; // To set these pointers.
friend class InternalTestInitializer;
// The embedder API for participating in browser logic.
ContentBrowserClient* browser_;
// The embedder API for participating in gpu logic.
ContentGpuClient* gpu_;
// The embedder API for participating in plugin logic.
ContentPluginClient* plugin_;
// The embedder API for participating in renderer logic.
ContentRendererClient* renderer_;
// The embedder API for participating in utility logic.
ContentUtilityClient* utility_;
};
} // namespace content
#endif // CONTENT_PUBLIC_COMMON_CONTENT_CLIENT_H_
|
