blob: 42d4ba1d35866f66e70bf6a050893679156f832a [file] [log] [blame]
* Copyright 2012 Google Inc. All Rights Reserved.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* See the License for the specific language governing permissions and
* limitations under the License.
#include <string>
#include "cobalt/export.h"
namespace cobalt {
namespace deprecated {
// Abstract base class for handling per-platform details.
// Each platform must implement a PlatformDelegate that derives from this
// class, and performs any required startup and shutdown operations.
// The factory method PlatformDelegate::Create() will be called, which should
// construct the derived class.
class COBALT_EXPORT PlatformDelegate {
// Must be first method called by main()
static void Init();
// Must be called during AtExit callback or before exit.
static void Teardown();
static PlatformDelegate* Get() { return instance_; }
// Gets the system language.
// NOTE: should be in the format described by bcp47.
// Example: "en-US" or "de"
virtual std::string GetSystemLanguage();
// Some platforms swap the meaning of the 'Enter' and 'Back' keys in
// certain regions.
virtual bool AreKeysReversed() const;
virtual std::string GetPlatformName() const = 0;
virtual bool IsUserLogRegistrationSupported() const;
// Thread-safe registration of a user log index, associating it with the
// specified label and memory address. This is used by some platforms to
// provide additional context with crashes.
// Returns true if the registration is successful.
virtual bool RegisterUserLog(int user_log_index, const char* label,
const void* address, size_t size) const;
virtual bool DeregisterUserLog(int user_log_index) const;
// Returns a string in the form of "1920x1080" to inform the player to use the
// returned resolution instead of the window size as the maximum resolution of
// video being played.
std::string GetVideoContainerSizeOverride() const {
return video_container_size_override_;
void SetVideoContainerSizeOverride(
const std::string& video_container_size_override);
const std::string& dir_source_root() const { return dir_source_root_; }
const std::string& game_content_path() const { return game_content_path_; }
const std::string& screenshot_output_path() const {
return screenshot_output_path_;
const std::string& logging_output_path() const {
return logging_output_path_;
const std::string& temp_path() const { return temp_path_; }
// Class can only be created via Init() / Teardown().
virtual ~PlatformDelegate() = 0;
std::string dir_source_root_;
std::string game_content_path_;
std::string screenshot_output_path_;
std::string logging_output_path_;
std::string temp_path_;
std::string video_container_size_override_;
// Each platform implements the Create() function to return its own
// class derived from PlatformDelegate.
static PlatformDelegate* Create();
static PlatformDelegate* instance_;
} // namespace deprecated
} // namespace cobalt