editor_export_plugin.cpp 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372
  1. /**************************************************************************/
  2. /* editor_export_plugin.cpp */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #include "editor_export_plugin.h"
  31. #include "core/config/project_settings.h"
  32. #include "editor/export/editor_export_platform.h"
  33. void EditorExportPlugin::set_export_preset(const Ref<EditorExportPreset> &p_preset) {
  34. if (p_preset.is_valid()) {
  35. export_preset = p_preset;
  36. }
  37. }
  38. Ref<EditorExportPreset> EditorExportPlugin::get_export_preset() const {
  39. return export_preset;
  40. }
  41. Ref<EditorExportPlatform> EditorExportPlugin::get_export_platform() const {
  42. if (export_preset.is_valid()) {
  43. return export_preset->get_platform();
  44. } else {
  45. return Ref<EditorExportPlatform>();
  46. }
  47. }
  48. void EditorExportPlugin::add_file(const String &p_path, const Vector<uint8_t> &p_file, bool p_remap) {
  49. ExtraFile ef;
  50. ef.data = p_file;
  51. ef.path = p_path;
  52. ef.remap = p_remap;
  53. extra_files.push_back(ef);
  54. }
  55. void EditorExportPlugin::add_shared_object(const String &p_path, const Vector<String> &p_tags, const String &p_target) {
  56. shared_objects.push_back(SharedObject(p_path, p_tags, p_target));
  57. }
  58. void EditorExportPlugin::_add_shared_object(const SharedObject &p_shared_object) {
  59. shared_objects.push_back(p_shared_object);
  60. }
  61. void EditorExportPlugin::add_ios_framework(const String &p_path) {
  62. ios_frameworks.push_back(p_path);
  63. }
  64. void EditorExportPlugin::add_ios_embedded_framework(const String &p_path) {
  65. ios_embedded_frameworks.push_back(p_path);
  66. }
  67. Vector<String> EditorExportPlugin::get_ios_frameworks() const {
  68. return ios_frameworks;
  69. }
  70. Vector<String> EditorExportPlugin::get_ios_embedded_frameworks() const {
  71. return ios_embedded_frameworks;
  72. }
  73. void EditorExportPlugin::add_ios_plist_content(const String &p_plist_content) {
  74. ios_plist_content += p_plist_content + "\n";
  75. }
  76. String EditorExportPlugin::get_ios_plist_content() const {
  77. return ios_plist_content;
  78. }
  79. void EditorExportPlugin::add_ios_linker_flags(const String &p_flags) {
  80. if (ios_linker_flags.length() > 0) {
  81. ios_linker_flags += ' ';
  82. }
  83. ios_linker_flags += p_flags;
  84. }
  85. String EditorExportPlugin::get_ios_linker_flags() const {
  86. return ios_linker_flags;
  87. }
  88. void EditorExportPlugin::add_ios_bundle_file(const String &p_path) {
  89. ios_bundle_files.push_back(p_path);
  90. }
  91. Vector<String> EditorExportPlugin::get_ios_bundle_files() const {
  92. return ios_bundle_files;
  93. }
  94. void EditorExportPlugin::add_ios_cpp_code(const String &p_code) {
  95. ios_cpp_code += p_code;
  96. }
  97. String EditorExportPlugin::get_ios_cpp_code() const {
  98. return ios_cpp_code;
  99. }
  100. void EditorExportPlugin::add_macos_plugin_file(const String &p_path) {
  101. macos_plugin_files.push_back(p_path);
  102. }
  103. const Vector<String> &EditorExportPlugin::get_macos_plugin_files() const {
  104. return macos_plugin_files;
  105. }
  106. void EditorExportPlugin::add_ios_project_static_lib(const String &p_path) {
  107. ios_project_static_libs.push_back(p_path);
  108. }
  109. Vector<String> EditorExportPlugin::get_ios_project_static_libs() const {
  110. return ios_project_static_libs;
  111. }
  112. Variant EditorExportPlugin::get_option(const StringName &p_name) const {
  113. ERR_FAIL_COND_V(export_preset.is_null(), Variant());
  114. return export_preset->get(p_name);
  115. }
  116. String EditorExportPlugin::_has_valid_export_configuration(const Ref<EditorExportPlatform> &p_export_platform, const Ref<EditorExportPreset> &p_preset) {
  117. String warning;
  118. if (!supports_platform(p_export_platform)) {
  119. warning += vformat(TTR("Plugin \"%s\" is not supported on \"%s\""), get_name(), p_export_platform->get_name());
  120. warning += "\n";
  121. return warning;
  122. }
  123. set_export_preset(p_preset);
  124. List<EditorExportPlatform::ExportOption> options;
  125. _get_export_options(p_export_platform, &options);
  126. for (const EditorExportPlatform::ExportOption &E : options) {
  127. String option_warning = _get_export_option_warning(p_export_platform, E.option.name);
  128. if (!option_warning.is_empty()) {
  129. warning += option_warning + "\n";
  130. }
  131. }
  132. return warning;
  133. }
  134. void EditorExportPlugin::_export_file_script(const String &p_path, const String &p_type, const Vector<String> &p_features) {
  135. GDVIRTUAL_CALL(_export_file, p_path, p_type, p_features);
  136. }
  137. void EditorExportPlugin::_export_begin_script(const Vector<String> &p_features, bool p_debug, const String &p_path, int p_flags) {
  138. GDVIRTUAL_CALL(_export_begin, p_features, p_debug, p_path, p_flags);
  139. }
  140. void EditorExportPlugin::_export_end_script() {
  141. GDVIRTUAL_CALL(_export_end);
  142. }
  143. // Customization
  144. bool EditorExportPlugin::_begin_customize_resources(const Ref<EditorExportPlatform> &p_platform, const Vector<String> &p_features) {
  145. bool ret = false;
  146. GDVIRTUAL_CALL(_begin_customize_resources, p_platform, p_features, ret);
  147. return ret;
  148. }
  149. Ref<Resource> EditorExportPlugin::_customize_resource(const Ref<Resource> &p_resource, const String &p_path) {
  150. Ref<Resource> ret;
  151. GDVIRTUAL_CALL(_customize_resource, p_resource, p_path, ret);
  152. return ret;
  153. }
  154. bool EditorExportPlugin::_begin_customize_scenes(const Ref<EditorExportPlatform> &p_platform, const Vector<String> &p_features) {
  155. bool ret = false;
  156. GDVIRTUAL_CALL(_begin_customize_scenes, p_platform, p_features, ret);
  157. return ret;
  158. }
  159. Node *EditorExportPlugin::_customize_scene(Node *p_root, const String &p_path) {
  160. Node *ret = nullptr;
  161. GDVIRTUAL_CALL(_customize_scene, p_root, p_path, ret);
  162. return ret;
  163. }
  164. uint64_t EditorExportPlugin::_get_customization_configuration_hash() const {
  165. uint64_t ret = 0;
  166. GDVIRTUAL_CALL(_get_customization_configuration_hash, ret);
  167. return ret;
  168. }
  169. void EditorExportPlugin::_end_customize_scenes() {
  170. GDVIRTUAL_CALL(_end_customize_scenes);
  171. }
  172. void EditorExportPlugin::_end_customize_resources() {
  173. GDVIRTUAL_CALL(_end_customize_resources);
  174. }
  175. String EditorExportPlugin::get_name() const {
  176. String ret;
  177. GDVIRTUAL_CALL(_get_name, ret);
  178. return ret;
  179. }
  180. bool EditorExportPlugin::supports_platform(const Ref<EditorExportPlatform> &p_export_platform) const {
  181. bool ret = false;
  182. GDVIRTUAL_CALL(_supports_platform, p_export_platform, ret);
  183. return ret;
  184. }
  185. PackedStringArray EditorExportPlugin::get_export_features(const Ref<EditorExportPlatform> &p_export_platform, bool p_debug) const {
  186. return _get_export_features(p_export_platform, p_debug);
  187. }
  188. PackedStringArray EditorExportPlugin::get_android_dependencies(const Ref<EditorExportPlatform> &p_export_platform, bool p_debug) const {
  189. PackedStringArray ret;
  190. GDVIRTUAL_CALL(_get_android_dependencies, p_export_platform, p_debug, ret);
  191. return ret;
  192. }
  193. PackedStringArray EditorExportPlugin::get_android_dependencies_maven_repos(const Ref<EditorExportPlatform> &p_export_platform, bool p_debug) const {
  194. PackedStringArray ret;
  195. GDVIRTUAL_CALL(_get_android_dependencies_maven_repos, p_export_platform, p_debug, ret);
  196. return ret;
  197. }
  198. PackedStringArray EditorExportPlugin::get_android_libraries(const Ref<EditorExportPlatform> &p_export_platform, bool p_debug) const {
  199. PackedStringArray ret;
  200. GDVIRTUAL_CALL(_get_android_libraries, p_export_platform, p_debug, ret);
  201. return ret;
  202. }
  203. String EditorExportPlugin::get_android_manifest_activity_element_contents(const Ref<EditorExportPlatform> &p_export_platform, bool p_debug) const {
  204. String ret;
  205. GDVIRTUAL_CALL(_get_android_manifest_activity_element_contents, p_export_platform, p_debug, ret);
  206. return ret;
  207. }
  208. String EditorExportPlugin::get_android_manifest_application_element_contents(const Ref<EditorExportPlatform> &p_export_platform, bool p_debug) const {
  209. String ret;
  210. GDVIRTUAL_CALL(_get_android_manifest_application_element_contents, p_export_platform, p_debug, ret);
  211. return ret;
  212. }
  213. String EditorExportPlugin::get_android_manifest_element_contents(const Ref<EditorExportPlatform> &p_export_platform, bool p_debug) const {
  214. String ret;
  215. GDVIRTUAL_CALL(_get_android_manifest_element_contents, p_export_platform, p_debug, ret);
  216. return ret;
  217. }
  218. PackedStringArray EditorExportPlugin::_get_export_features(const Ref<EditorExportPlatform> &p_platform, bool p_debug) const {
  219. PackedStringArray ret;
  220. GDVIRTUAL_CALL(_get_export_features, p_platform, p_debug, ret);
  221. return ret;
  222. }
  223. void EditorExportPlugin::_get_export_options(const Ref<EditorExportPlatform> &p_platform, List<EditorExportPlatform::ExportOption> *r_options) const {
  224. TypedArray<Dictionary> ret;
  225. GDVIRTUAL_CALL(_get_export_options, p_platform, ret);
  226. for (int i = 0; i < ret.size(); i++) {
  227. Dictionary option = ret[i];
  228. ERR_CONTINUE_MSG(!option.has("option"), "Missing required element 'option'");
  229. ERR_CONTINUE_MSG(!option.has("default_value"), "Missing required element 'default_value'");
  230. PropertyInfo property_info = PropertyInfo::from_dict(option["option"]);
  231. Variant default_value = option["default_value"];
  232. bool update_visibility = option.has("update_visibility") && option["update_visibility"];
  233. r_options->push_back(EditorExportPlatform::ExportOption(property_info, default_value, update_visibility));
  234. }
  235. }
  236. bool EditorExportPlugin::_should_update_export_options(const Ref<EditorExportPlatform> &p_platform) const {
  237. bool ret = false;
  238. GDVIRTUAL_CALL(_should_update_export_options, p_platform, ret);
  239. return ret;
  240. }
  241. bool EditorExportPlugin::_get_export_option_visibility(const Ref<EditorExportPlatform> &p_export_platform, const String &p_option_name) const {
  242. bool ret = true;
  243. GDVIRTUAL_CALL(_get_export_option_visibility, p_export_platform, p_option_name, ret);
  244. return ret;
  245. }
  246. String EditorExportPlugin::_get_export_option_warning(const Ref<EditorExportPlatform> &p_export_platform, const String &p_option_name) const {
  247. String ret;
  248. GDVIRTUAL_CALL(_get_export_option_warning, p_export_platform, p_option_name, ret);
  249. return ret;
  250. }
  251. Dictionary EditorExportPlugin::_get_export_options_overrides(const Ref<EditorExportPlatform> &p_platform) const {
  252. Dictionary ret;
  253. GDVIRTUAL_CALL(_get_export_options_overrides, p_platform, ret);
  254. return ret;
  255. }
  256. void EditorExportPlugin::_export_file(const String &p_path, const String &p_type, const HashSet<String> &p_features) {
  257. }
  258. void EditorExportPlugin::_export_begin(const HashSet<String> &p_features, bool p_debug, const String &p_path, int p_flags) {
  259. }
  260. void EditorExportPlugin::_export_end() {}
  261. void EditorExportPlugin::skip() {
  262. skipped = true;
  263. }
  264. void EditorExportPlugin::_bind_methods() {
  265. ClassDB::bind_method(D_METHOD("add_shared_object", "path", "tags", "target"), &EditorExportPlugin::add_shared_object);
  266. ClassDB::bind_method(D_METHOD("add_ios_project_static_lib", "path"), &EditorExportPlugin::add_ios_project_static_lib);
  267. ClassDB::bind_method(D_METHOD("add_file", "path", "file", "remap"), &EditorExportPlugin::add_file);
  268. ClassDB::bind_method(D_METHOD("add_ios_framework", "path"), &EditorExportPlugin::add_ios_framework);
  269. ClassDB::bind_method(D_METHOD("add_ios_embedded_framework", "path"), &EditorExportPlugin::add_ios_embedded_framework);
  270. ClassDB::bind_method(D_METHOD("add_ios_plist_content", "plist_content"), &EditorExportPlugin::add_ios_plist_content);
  271. ClassDB::bind_method(D_METHOD("add_ios_linker_flags", "flags"), &EditorExportPlugin::add_ios_linker_flags);
  272. ClassDB::bind_method(D_METHOD("add_ios_bundle_file", "path"), &EditorExportPlugin::add_ios_bundle_file);
  273. ClassDB::bind_method(D_METHOD("add_ios_cpp_code", "code"), &EditorExportPlugin::add_ios_cpp_code);
  274. ClassDB::bind_method(D_METHOD("add_macos_plugin_file", "path"), &EditorExportPlugin::add_macos_plugin_file);
  275. ClassDB::bind_method(D_METHOD("skip"), &EditorExportPlugin::skip);
  276. ClassDB::bind_method(D_METHOD("get_option", "name"), &EditorExportPlugin::get_option);
  277. ClassDB::bind_method(D_METHOD("get_export_preset"), &EditorExportPlugin::get_export_preset);
  278. ClassDB::bind_method(D_METHOD("get_export_platform"), &EditorExportPlugin::get_export_platform);
  279. GDVIRTUAL_BIND(_export_file, "path", "type", "features");
  280. GDVIRTUAL_BIND(_export_begin, "features", "is_debug", "path", "flags");
  281. GDVIRTUAL_BIND(_export_end);
  282. GDVIRTUAL_BIND(_begin_customize_resources, "platform", "features");
  283. GDVIRTUAL_BIND(_customize_resource, "resource", "path");
  284. GDVIRTUAL_BIND(_begin_customize_scenes, "platform", "features");
  285. GDVIRTUAL_BIND(_customize_scene, "scene", "path");
  286. GDVIRTUAL_BIND(_get_customization_configuration_hash);
  287. GDVIRTUAL_BIND(_end_customize_scenes);
  288. GDVIRTUAL_BIND(_end_customize_resources);
  289. GDVIRTUAL_BIND(_get_export_options, "platform");
  290. GDVIRTUAL_BIND(_get_export_options_overrides, "platform");
  291. GDVIRTUAL_BIND(_should_update_export_options, "platform");
  292. GDVIRTUAL_BIND(_get_export_option_visibility, "platform", "option");
  293. GDVIRTUAL_BIND(_get_export_option_warning, "platform", "option");
  294. GDVIRTUAL_BIND(_get_export_features, "platform", "debug");
  295. GDVIRTUAL_BIND(_get_name);
  296. GDVIRTUAL_BIND(_supports_platform, "platform");
  297. GDVIRTUAL_BIND(_get_android_dependencies, "platform", "debug");
  298. GDVIRTUAL_BIND(_get_android_dependencies_maven_repos, "platform", "debug");
  299. GDVIRTUAL_BIND(_get_android_libraries, "platform", "debug");
  300. GDVIRTUAL_BIND(_get_android_manifest_activity_element_contents, "platform", "debug");
  301. GDVIRTUAL_BIND(_get_android_manifest_application_element_contents, "platform", "debug");
  302. GDVIRTUAL_BIND(_get_android_manifest_element_contents, "platform", "debug");
  303. }