blob: 13f0d5c57dc0b986c9c016e7404b6c71a5345440 [file] [log] [blame]
// 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.
#include <string>
#include <vector>
#include "base/basictypes.h"
#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"
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 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);
// Content's embedder API should only be used by content.
ContentClient* GetContentClient();
// 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 {
virtual ~ContentClient();
ContentBrowserClient* browser() { return browser_; }
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 and saveable
// url schemes early on in the startup sequence.
virtual void AddAdditionalSchemes(
std::vector<std::string>* standard_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.
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;
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 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