Skip to content

Commit

Permalink
[Plugins] Rename 'PluginConfig' struct to platform specific name
Browse files Browse the repository at this point in the history
  • Loading branch information
@naithar
naithar committed Jan 14, 2021
1 parent cb15abd commit 6492394
Show file tree
Hide file tree
Showing 4 changed files with 149 additions and 114 deletions.
30 changes: 15 additions & 15 deletions platform/android/export/export.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ class EditorExportPlatformAndroid : public EditorExportPlatform {
EditorProgress *ep;
};

Vector<PluginConfig> plugins;
Vector<PluginConfigAndroid> plugins;
String last_plugin_names;
uint64_t last_custom_build_time = 0;
volatile bool plugins_changed;
Expand All @@ -283,7 +283,7 @@ class EditorExportPlatformAndroid : public EditorExportPlatform {
{
// Nothing to do if we already know the plugins have changed.
if (!ea->plugins_changed) {
Vector<PluginConfig> loaded_plugins = get_plugins();
Vector<PluginConfigAndroid> loaded_plugins = get_plugins();

ea->plugins_lock->lock();

Expand Down Expand Up @@ -640,7 +640,7 @@ class EditorExportPlatformAndroid : public EditorExportPlatform {
continue;
}

if (file.ends_with(PLUGIN_CONFIG_EXT)) {
if (file.ends_with(PluginConfigAndroid::PLUGIN_CONFIG_EXT)) {
dir_files.push_back(file);
}
}
Expand All @@ -650,8 +650,8 @@ class EditorExportPlatformAndroid : public EditorExportPlatform {
return dir_files;
}

static Vector<PluginConfig> get_plugins() {
Vector<PluginConfig> loaded_plugins;
static Vector<PluginConfigAndroid> get_plugins() {
Vector<PluginConfigAndroid> loaded_plugins;

String plugins_dir = ProjectSettings::get_singleton()->get_resource_path().plus_file("android/plugins");

Expand All @@ -664,7 +664,7 @@ class EditorExportPlatformAndroid : public EditorExportPlatform {
if (!plugins_filenames.empty()) {
Ref<ConfigFile> config_file = memnew(ConfigFile);
for (int i = 0; i < plugins_filenames.size(); i++) {
PluginConfig config = load_plugin_config(config_file, plugins_dir.plus_file(plugins_filenames[i]));
PluginConfigAndroid config = load_plugin_config(config_file, plugins_dir.plus_file(plugins_filenames[i]));
if (config.valid_config) {
loaded_plugins.push_back(config);
} else {
Expand All @@ -677,11 +677,11 @@ class EditorExportPlatformAndroid : public EditorExportPlatform {
return loaded_plugins;
}

static Vector<PluginConfig> get_enabled_plugins(const Ref<EditorExportPreset> &p_presets) {
Vector<PluginConfig> enabled_plugins;
Vector<PluginConfig> all_plugins = get_plugins();
static Vector<PluginConfigAndroid> get_enabled_plugins(const Ref<EditorExportPreset> &p_presets) {
Vector<PluginConfigAndroid> enabled_plugins;
Vector<PluginConfigAndroid> all_plugins = get_plugins();
for (int i = 0; i < all_plugins.size(); i++) {
PluginConfig plugin = all_plugins[i];
PluginConfigAndroid plugin = all_plugins[i];
bool enabled = p_presets->get("plugins/" + plugin.name);
if (enabled) {
enabled_plugins.push_back(plugin);
Expand Down Expand Up @@ -1655,7 +1655,7 @@ class EditorExportPlatformAndroid : public EditorExportPlatform {
r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "custom_template/use_custom_build"), false));
r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "custom_template/export_format", PROPERTY_HINT_ENUM, "Export APK,Export AAB"), EXPORT_FORMAT_APK));

Vector<PluginConfig> plugins_configs = get_plugins();
Vector<PluginConfigAndroid> plugins_configs = get_plugins();
for (int i = 0; i < plugins_configs.size(); i++) {
print_verbose("Found Android plugin " + plugins_configs[i].name);
r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "plugins/" + plugins_configs[i].name), false));
Expand Down Expand Up @@ -2487,7 +2487,7 @@ class EditorExportPlatformAndroid : public EditorExportPlatform {
}
}

inline bool is_clean_build_required(Vector<PluginConfig> enabled_plugins) {
inline bool is_clean_build_required(Vector<PluginConfigAndroid> enabled_plugins) {
String plugin_names = get_plugins_names(enabled_plugins);
bool first_build = last_custom_build_time == 0;
bool have_plugins_changed = false;
Expand Down Expand Up @@ -2797,9 +2797,9 @@ class EditorExportPlatformAndroid : public EditorExportPlatform {
String sign_flag = should_sign ? "true" : "false";
String zipalign_flag = "true";

Vector<PluginConfig> enabled_plugins = get_enabled_plugins(p_preset);
String local_plugins_binaries = get_plugins_binaries(BINARY_TYPE_LOCAL, enabled_plugins);
String remote_plugins_binaries = get_plugins_binaries(BINARY_TYPE_REMOTE, enabled_plugins);
Vector<PluginConfigAndroid> enabled_plugins = get_enabled_plugins(p_preset);
String local_plugins_binaries = get_plugins_binaries(PluginConfigAndroid::BINARY_TYPE_LOCAL, enabled_plugins);
String remote_plugins_binaries = get_plugins_binaries(PluginConfigAndroid::BINARY_TYPE_REMOTE, enabled_plugins);
String custom_maven_repos = get_plugins_custom_maven_repos(enabled_plugins);
bool clean_build_required = is_clean_build_required(enabled_plugins);

Expand Down
118 changes: 68 additions & 50 deletions platform/android/plugin/godot_plugin_config.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,23 +35,6 @@
#include "core/io/config_file.h"
#include "core/ustring.h"

static const char *PLUGIN_CONFIG_EXT = ".gdap";

static const char *CONFIG_SECTION = "config";
static const char *CONFIG_NAME_KEY = "name";
static const char *CONFIG_BINARY_TYPE_KEY = "binary_type";
static const char *CONFIG_BINARY_KEY = "binary";

static const char *DEPENDENCIES_SECTION = "dependencies";
static const char *DEPENDENCIES_LOCAL_KEY = "local";
static const char *DEPENDENCIES_REMOTE_KEY = "remote";
static const char *DEPENDENCIES_CUSTOM_MAVEN_REPOS_KEY = "custom_maven_repos";

static const char *BINARY_TYPE_LOCAL = "local";
static const char *BINARY_TYPE_REMOTE = "remote";

static const char *PLUGIN_VALUE_SEPARATOR = "|";

/*
The `config` section and fields are required and defined as follow:
- **name**: name of the plugin
Expand All @@ -67,7 +50,25 @@ The `dependencies` section and fields are optional and defined as follow:
See https://github.com/godotengine/godot/issues/38157#issuecomment-618773871
*/
struct PluginConfig {
struct PluginConfigAndroid {

static const char *PLUGIN_CONFIG_EXT;

static const char *CONFIG_SECTION;
static const char *CONFIG_NAME_KEY;
static const char *CONFIG_BINARY_TYPE_KEY;
static const char *CONFIG_BINARY_KEY;

static const char *DEPENDENCIES_SECTION;
static const char *DEPENDENCIES_LOCAL_KEY;
static const char *DEPENDENCIES_REMOTE_KEY;
static const char *DEPENDENCIES_CUSTOM_MAVEN_REPOS_KEY;

static const char *BINARY_TYPE_LOCAL;
static const char *BINARY_TYPE_REMOTE;

static const char *PLUGIN_VALUE_SEPARATOR;

// Set to true when the config file is properly loaded.
bool valid_config = false;
// Unix timestamp of last change to this plugin.
Expand All @@ -84,11 +85,28 @@ struct PluginConfig {
Vector<String> custom_maven_repos;
};

const char *PluginConfigAndroid::PLUGIN_CONFIG_EXT = ".gdap";

const char *PluginConfigAndroid::CONFIG_SECTION = "config";
const char *PluginConfigAndroid::CONFIG_NAME_KEY = "name";
const char *PluginConfigAndroid::CONFIG_BINARY_TYPE_KEY = "binary_type";
const char *PluginConfigAndroid::CONFIG_BINARY_KEY = "binary";

const char *PluginConfigAndroid::DEPENDENCIES_SECTION = "dependencies";
const char *PluginConfigAndroid::DEPENDENCIES_LOCAL_KEY = "local";
const char *PluginConfigAndroid::DEPENDENCIES_REMOTE_KEY = "remote";
const char *PluginConfigAndroid::DEPENDENCIES_CUSTOM_MAVEN_REPOS_KEY = "custom_maven_repos";

const char *PluginConfigAndroid::BINARY_TYPE_LOCAL = "local";
const char *PluginConfigAndroid::BINARY_TYPE_REMOTE = "remote";

const char *PluginConfigAndroid::PLUGIN_VALUE_SEPARATOR = "|";

/*
* Set of prebuilt plugins.
* Currently unused, this is just for future reference:
*/
// static const PluginConfig MY_PREBUILT_PLUGIN = {
// static const PluginConfigAndroid MY_PREBUILT_PLUGIN = {
// /*.valid_config =*/true,
// /*.last_updated =*/0,
// /*.name =*/"GodotPayment",
Expand All @@ -112,9 +130,9 @@ static inline String resolve_local_dependency_path(String plugin_config_dir, Str
return absolute_path;
}

static inline PluginConfig resolve_prebuilt_plugin(PluginConfig prebuilt_plugin, String plugin_config_dir) {
PluginConfig resolved = prebuilt_plugin;
resolved.binary = resolved.binary_type == BINARY_TYPE_LOCAL ? resolve_local_dependency_path(plugin_config_dir, prebuilt_plugin.binary) : prebuilt_plugin.binary;
static inline PluginConfigAndroid resolve_prebuilt_plugin(PluginConfigAndroid prebuilt_plugin, String plugin_config_dir) {
PluginConfigAndroid resolved = prebuilt_plugin;
resolved.binary = resolved.binary_type == PluginConfigAndroid::BINARY_TYPE_LOCAL ? resolve_local_dependency_path(plugin_config_dir, prebuilt_plugin.binary) : prebuilt_plugin.binary;
if (!prebuilt_plugin.local_dependencies.empty()) {
resolved.local_dependencies.clear();
for (int i = 0; i < prebuilt_plugin.local_dependencies.size(); i++) {
Expand All @@ -124,21 +142,21 @@ static inline PluginConfig resolve_prebuilt_plugin(PluginConfig prebuilt_plugin,
return resolved;
}

static inline Vector<PluginConfig> get_prebuilt_plugins(String plugins_base_dir) {
Vector<PluginConfig> prebuilt_plugins;
static inline Vector<PluginConfigAndroid> get_prebuilt_plugins(String plugins_base_dir) {
Vector<PluginConfigAndroid> prebuilt_plugins;
// prebuilt_plugins.push_back(resolve_prebuilt_plugin(MY_PREBUILT_PLUGIN, plugins_base_dir));
return prebuilt_plugins;
}

static inline bool is_plugin_config_valid(PluginConfig plugin_config) {
static inline bool is_plugin_config_valid(PluginConfigAndroid plugin_config) {
bool valid_name = !plugin_config.name.empty();
bool valid_binary_type = plugin_config.binary_type == BINARY_TYPE_LOCAL ||
plugin_config.binary_type == BINARY_TYPE_REMOTE;
bool valid_binary_type = plugin_config.binary_type == PluginConfigAndroid::BINARY_TYPE_LOCAL ||
plugin_config.binary_type == PluginConfigAndroid::BINARY_TYPE_REMOTE;

bool valid_binary = false;
if (valid_binary_type) {
valid_binary = !plugin_config.binary.empty() &&
(plugin_config.binary_type == BINARY_TYPE_REMOTE ||
(plugin_config.binary_type == PluginConfigAndroid::BINARY_TYPE_REMOTE ||
FileAccess::exists(plugin_config.binary));
}

Expand All @@ -154,7 +172,7 @@ static inline bool is_plugin_config_valid(PluginConfig plugin_config) {
return valid_name && valid_binary && valid_binary_type && valid_local_dependencies;
}

static inline uint64_t get_plugin_modification_time(const PluginConfig &plugin_config, const String &config_path) {
static inline uint64_t get_plugin_modification_time(const PluginConfigAndroid &plugin_config, const String &config_path) {
uint64_t last_updated = FileAccess::get_modified_time(config_path);
last_updated = MAX(last_updated, FileAccess::get_modified_time(plugin_config.binary));

Expand All @@ -166,30 +184,30 @@ static inline uint64_t get_plugin_modification_time(const PluginConfig &plugin_c
return last_updated;
}

static inline PluginConfig load_plugin_config(Ref<ConfigFile> config_file, const String &path) {
PluginConfig plugin_config = {};
static inline PluginConfigAndroid load_plugin_config(Ref<ConfigFile> config_file, const String &path) {
PluginConfigAndroid plugin_config = {};

if (config_file.is_valid()) {
Error err = config_file->load(path);
if (err == OK) {
String config_base_dir = path.get_base_dir();

plugin_config.name = config_file->get_value(CONFIG_SECTION, CONFIG_NAME_KEY, String());
plugin_config.binary_type = config_file->get_value(CONFIG_SECTION, CONFIG_BINARY_TYPE_KEY, String());
plugin_config.name = config_file->get_value(PluginConfigAndroid::CONFIG_SECTION, PluginConfigAndroid::CONFIG_NAME_KEY, String());
plugin_config.binary_type = config_file->get_value(PluginConfigAndroid::CONFIG_SECTION, PluginConfigAndroid::CONFIG_BINARY_TYPE_KEY, String());

String binary_path = config_file->get_value(CONFIG_SECTION, CONFIG_BINARY_KEY, String());
plugin_config.binary = plugin_config.binary_type == BINARY_TYPE_LOCAL ? resolve_local_dependency_path(config_base_dir, binary_path) : binary_path;
String binary_path = config_file->get_value(PluginConfigAndroid::CONFIG_SECTION, PluginConfigAndroid::CONFIG_BINARY_KEY, String());
plugin_config.binary = plugin_config.binary_type == PluginConfigAndroid::BINARY_TYPE_LOCAL ? resolve_local_dependency_path(config_base_dir, binary_path) : binary_path;

if (config_file->has_section(DEPENDENCIES_SECTION)) {
Vector<String> local_dependencies_paths = config_file->get_value(DEPENDENCIES_SECTION, DEPENDENCIES_LOCAL_KEY, Vector<String>());
if (config_file->has_section(PluginConfigAndroid::DEPENDENCIES_SECTION)) {
Vector<String> local_dependencies_paths = config_file->get_value(PluginConfigAndroid::DEPENDENCIES_SECTION, PluginConfigAndroid::DEPENDENCIES_LOCAL_KEY, Vector<String>());
if (!local_dependencies_paths.empty()) {
for (int i = 0; i < local_dependencies_paths.size(); i++) {
plugin_config.local_dependencies.push_back(resolve_local_dependency_path(config_base_dir, local_dependencies_paths[i]));
}
}

plugin_config.remote_dependencies = config_file->get_value(DEPENDENCIES_SECTION, DEPENDENCIES_REMOTE_KEY, Vector<String>());
plugin_config.custom_maven_repos = config_file->get_value(DEPENDENCIES_SECTION, DEPENDENCIES_CUSTOM_MAVEN_REPOS_KEY, Vector<String>());
plugin_config.remote_dependencies = config_file->get_value(PluginConfigAndroid::DEPENDENCIES_SECTION, PluginConfigAndroid::DEPENDENCIES_REMOTE_KEY, Vector<String>());
plugin_config.custom_maven_repos = config_file->get_value(PluginConfigAndroid::DEPENDENCIES_SECTION, PluginConfigAndroid::DEPENDENCIES_CUSTOM_MAVEN_REPOS_KEY, Vector<String>());
}

plugin_config.valid_config = is_plugin_config_valid(plugin_config);
Expand All @@ -200,12 +218,12 @@ static inline PluginConfig load_plugin_config(Ref<ConfigFile> config_file, const
return plugin_config;
}

static inline String get_plugins_binaries(String binary_type, Vector<PluginConfig> plugins_configs) {
static inline String get_plugins_binaries(String binary_type, Vector<PluginConfigAndroid> plugins_configs) {
String plugins_binaries;
if (!plugins_configs.empty()) {
Vector<String> binaries;
for (int i = 0; i < plugins_configs.size(); i++) {
PluginConfig config = plugins_configs[i];
PluginConfigAndroid config = plugins_configs[i];
if (!config.valid_config) {
continue;
}
Expand All @@ -214,52 +232,52 @@ static inline String get_plugins_binaries(String binary_type, Vector<PluginConfi
binaries.push_back(config.binary);
}

if (binary_type == BINARY_TYPE_LOCAL) {
if (binary_type == PluginConfigAndroid::BINARY_TYPE_LOCAL) {
binaries.append_array(config.local_dependencies);
}

if (binary_type == BINARY_TYPE_REMOTE) {
if (binary_type == PluginConfigAndroid::BINARY_TYPE_REMOTE) {
binaries.append_array(config.remote_dependencies);
}
}

plugins_binaries = String(PLUGIN_VALUE_SEPARATOR).join(binaries);
plugins_binaries = String(PluginConfigAndroid::PLUGIN_VALUE_SEPARATOR).join(binaries);
}

return plugins_binaries;
}

static inline String get_plugins_custom_maven_repos(Vector<PluginConfig> plugins_configs) {
static inline String get_plugins_custom_maven_repos(Vector<PluginConfigAndroid> plugins_configs) {
String custom_maven_repos;
if (!plugins_configs.empty()) {
Vector<String> repos_urls;
for (int i = 0; i < plugins_configs.size(); i++) {
PluginConfig config = plugins_configs[i];
PluginConfigAndroid config = plugins_configs[i];
if (!config.valid_config) {
continue;
}

repos_urls.append_array(config.custom_maven_repos);
}

custom_maven_repos = String(PLUGIN_VALUE_SEPARATOR).join(repos_urls);
custom_maven_repos = String(PluginConfigAndroid::PLUGIN_VALUE_SEPARATOR).join(repos_urls);
}
return custom_maven_repos;
}

static inline String get_plugins_names(Vector<PluginConfig> plugins_configs) {
static inline String get_plugins_names(Vector<PluginConfigAndroid> plugins_configs) {
String plugins_names;
if (!plugins_configs.empty()) {
Vector<String> names;
for (int i = 0; i < plugins_configs.size(); i++) {
PluginConfig config = plugins_configs[i];
PluginConfigAndroid config = plugins_configs[i];
if (!config.valid_config) {
continue;
}

names.push_back(config.name);
}
plugins_names = String(PLUGIN_VALUE_SEPARATOR).join(names);
plugins_names = String(PluginConfigAndroid::PLUGIN_VALUE_SEPARATOR).join(names);
}

return plugins_names;
Expand Down
Loading

0 comments on commit 6492394

Please sign in to comment.