mirror of
https://github.com/godotengine/godot.git
synced 2024-12-15 10:12:40 +08:00
107 lines
5.4 KiB
C++
107 lines
5.4 KiB
C++
/*************************************************************************/
|
|
/* godot_plugin_config.h */
|
|
/*************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/*************************************************************************/
|
|
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
|
|
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
|
|
/* */
|
|
/* Permission is hereby granted, free of charge, to any person obtaining */
|
|
/* a copy of this software and associated documentation files (the */
|
|
/* "Software"), to deal in the Software without restriction, including */
|
|
/* without limitation the rights to use, copy, modify, merge, publish, */
|
|
/* distribute, sublicense, and/or sell copies of the Software, and to */
|
|
/* permit persons to whom the Software is furnished to do so, subject to */
|
|
/* the following conditions: */
|
|
/* */
|
|
/* The above copyright notice and this permission notice shall be */
|
|
/* included in all copies or substantial portions of the Software. */
|
|
/* */
|
|
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
|
|
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
|
|
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
|
|
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
|
|
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
|
|
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
|
|
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
|
|
/*************************************************************************/
|
|
|
|
#ifndef ANDROID_GODOT_PLUGIN_CONFIG_H
|
|
#define ANDROID_GODOT_PLUGIN_CONFIG_H
|
|
|
|
#include "core/config/project_settings.h"
|
|
#include "core/error/error_list.h"
|
|
#include "core/io/config_file.h"
|
|
#include "core/string/ustring.h"
|
|
|
|
/*
|
|
The `config` section and fields are required and defined as follow:
|
|
- **name**: name of the plugin.
|
|
- **binary_type**: can be either `local` or `remote`. The type affects the **binary** field.
|
|
- **binary**:
|
|
- if **binary_type** is `local`, then this should be the filename of the plugin `aar` file in the `res://android/plugins` directory (e.g: `MyPlugin.aar`).
|
|
- if **binary_type** is `remote`, then this should be a declaration for a remote gradle binary (e.g: "org.godot.example:my-plugin:0.0.0").
|
|
|
|
The `dependencies` section and fields are optional and defined as follow:
|
|
- **local**: contains a list of local `.aar` binary files the plugin depends on. The local binary dependencies must also be located in the `res://android/plugins` directory.
|
|
- **remote**: contains a list of remote binary gradle dependencies for the plugin.
|
|
- **custom_maven_repos**: contains a list of urls specifying custom maven repos required for the plugin's dependencies.
|
|
|
|
See https://github.com/godotengine/godot/issues/38157#issuecomment-618773871
|
|
*/
|
|
struct PluginConfigAndroid {
|
|
inline static const char *PLUGIN_CONFIG_EXT = ".gdap";
|
|
|
|
inline static const char *CONFIG_SECTION = "config";
|
|
inline static const char *CONFIG_NAME_KEY = "name";
|
|
inline static const char *CONFIG_BINARY_TYPE_KEY = "binary_type";
|
|
inline static const char *CONFIG_BINARY_KEY = "binary";
|
|
|
|
inline static const char *DEPENDENCIES_SECTION = "dependencies";
|
|
inline static const char *DEPENDENCIES_LOCAL_KEY = "local";
|
|
inline static const char *DEPENDENCIES_REMOTE_KEY = "remote";
|
|
inline static const char *DEPENDENCIES_CUSTOM_MAVEN_REPOS_KEY = "custom_maven_repos";
|
|
|
|
inline static const char *BINARY_TYPE_LOCAL = "local";
|
|
inline static const char *BINARY_TYPE_REMOTE = "remote";
|
|
|
|
inline 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.
|
|
uint64_t last_updated = 0;
|
|
|
|
// Required config section
|
|
String name;
|
|
String binary_type;
|
|
String binary;
|
|
|
|
// Optional dependencies section
|
|
Vector<String> local_dependencies;
|
|
Vector<String> remote_dependencies;
|
|
Vector<String> custom_maven_repos;
|
|
|
|
static String resolve_local_dependency_path(String plugin_config_dir, String dependency_path);
|
|
|
|
static PluginConfigAndroid resolve_prebuilt_plugin(PluginConfigAndroid prebuilt_plugin, String plugin_config_dir);
|
|
|
|
static Vector<PluginConfigAndroid> get_prebuilt_plugins(String plugins_base_dir);
|
|
|
|
static bool is_plugin_config_valid(PluginConfigAndroid plugin_config);
|
|
|
|
static uint64_t get_plugin_modification_time(const PluginConfigAndroid &plugin_config, const String &config_path);
|
|
|
|
static PluginConfigAndroid load_plugin_config(Ref<ConfigFile> config_file, const String &path);
|
|
|
|
static String get_plugins_binaries(String binary_type, Vector<PluginConfigAndroid> plugins_configs);
|
|
|
|
static String get_plugins_custom_maven_repos(Vector<PluginConfigAndroid> plugins_configs);
|
|
|
|
static String get_plugins_names(Vector<PluginConfigAndroid> plugins_configs);
|
|
};
|
|
|
|
#endif // GODOT_PLUGIN_CONFIG_H
|