export_plugin.cpp 75 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882
  1. /*************************************************************************/
  2. /* export_plugin.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
  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 "export_plugin.h"
  31. #include "core/string/translation.h"
  32. #include "editor/editor_node.h"
  33. void EditorExportPlatformIOS::get_preset_features(const Ref<EditorExportPreset> &p_preset, List<String> *r_features) const {
  34. String driver = ProjectSettings::get_singleton()->get("rendering/driver/driver_name");
  35. // Vulkan and OpenGL ES 3.0 both mandate ETC2 support.
  36. r_features->push_back("etc2");
  37. Vector<String> architectures = _get_preset_architectures(p_preset);
  38. for (int i = 0; i < architectures.size(); ++i) {
  39. r_features->push_back(architectures[i]);
  40. }
  41. }
  42. Vector<EditorExportPlatformIOS::ExportArchitecture> EditorExportPlatformIOS::_get_supported_architectures() const {
  43. Vector<ExportArchitecture> archs;
  44. archs.push_back(ExportArchitecture("arm64", true));
  45. return archs;
  46. }
  47. struct LoadingScreenInfo {
  48. const char *preset_key;
  49. const char *export_name;
  50. int width = 0;
  51. int height = 0;
  52. bool rotate = false;
  53. };
  54. static const LoadingScreenInfo loading_screen_infos[] = {
  55. { PNAME("landscape_launch_screens/iphone_2436x1125"), "Default-Landscape-X.png", 2436, 1125, false },
  56. { PNAME("landscape_launch_screens/iphone_2208x1242"), "[email protected]", 2208, 1242, false },
  57. { PNAME("landscape_launch_screens/ipad_1024x768"), "Default-Landscape.png", 1024, 768, false },
  58. { PNAME("landscape_launch_screens/ipad_2048x1536"), "[email protected]", 2048, 1536, false },
  59. { PNAME("portrait_launch_screens/iphone_640x960"), "[email protected]", 640, 960, true },
  60. { PNAME("portrait_launch_screens/iphone_640x1136"), "[email protected]", 640, 1136, true },
  61. { PNAME("portrait_launch_screens/iphone_750x1334"), "[email protected]", 750, 1334, true },
  62. { PNAME("portrait_launch_screens/iphone_1125x2436"), "Default-Portrait-X.png", 1125, 2436, true },
  63. { PNAME("portrait_launch_screens/ipad_768x1024"), "Default-Portrait.png", 768, 1024, true },
  64. { PNAME("portrait_launch_screens/ipad_1536x2048"), "[email protected]", 1536, 2048, true },
  65. { PNAME("portrait_launch_screens/iphone_1242x2208"), "[email protected]", 1242, 2208, true }
  66. };
  67. void EditorExportPlatformIOS::get_export_options(List<ExportOption> *r_options) {
  68. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "custom_template/debug", PROPERTY_HINT_GLOBAL_FILE, "*.zip"), ""));
  69. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "custom_template/release", PROPERTY_HINT_GLOBAL_FILE, "*.zip"), ""));
  70. Vector<ExportArchitecture> architectures = _get_supported_architectures();
  71. for (int i = 0; i < architectures.size(); ++i) {
  72. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, vformat("%s/%s", PNAME("architectures"), architectures[i].name)), architectures[i].is_default));
  73. }
  74. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/app_store_team_id"), ""));
  75. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/provisioning_profile_uuid_debug"), ""));
  76. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/code_sign_identity_debug", PROPERTY_HINT_PLACEHOLDER_TEXT, "iPhone Developer"), ""));
  77. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "application/export_method_debug", PROPERTY_HINT_ENUM, "App Store,Development,Ad-Hoc,Enterprise"), 1));
  78. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/provisioning_profile_uuid_release"), ""));
  79. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/code_sign_identity_release", PROPERTY_HINT_PLACEHOLDER_TEXT, "iPhone Distribution"), ""));
  80. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "application/export_method_release", PROPERTY_HINT_ENUM, "App Store,Development,Ad-Hoc,Enterprise"), 0));
  81. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "application/targeted_device_family", PROPERTY_HINT_ENUM, "iPhone,iPad,iPhone & iPad"), 2));
  82. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/bundle_identifier", PROPERTY_HINT_PLACEHOLDER_TEXT, "com.example.game"), ""));
  83. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/signature"), ""));
  84. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/short_version"), "1.0"));
  85. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/version"), "1.0"));
  86. Vector<PluginConfigIOS> found_plugins = get_plugins();
  87. for (int i = 0; i < found_plugins.size(); i++) {
  88. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, vformat("%s/%s", PNAME("plugins"), found_plugins[i].name)), false));
  89. }
  90. HashSet<String> plist_keys;
  91. for (int i = 0; i < found_plugins.size(); i++) {
  92. // Editable plugin plist values
  93. PluginConfigIOS plugin = found_plugins[i];
  94. for (const KeyValue<String, PluginConfigIOS::PlistItem> &E : plugin.plist) {
  95. switch (E.value.type) {
  96. case PluginConfigIOS::PlistItemType::STRING_INPUT: {
  97. String preset_name = "plugins_plist/" + E.key;
  98. if (!plist_keys.has(preset_name)) {
  99. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, preset_name), E.value.value));
  100. plist_keys.insert(preset_name);
  101. }
  102. } break;
  103. default:
  104. continue;
  105. }
  106. }
  107. }
  108. plugins_changed.clear();
  109. plugins = found_plugins;
  110. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "capabilities/access_wifi"), false));
  111. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "capabilities/push_notifications"), false));
  112. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "user_data/accessible_from_files_app"), false));
  113. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "user_data/accessible_from_itunes_sharing"), false));
  114. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "privacy/camera_usage_description", PROPERTY_HINT_PLACEHOLDER_TEXT, "Provide a message if you need to use the camera"), ""));
  115. r_options->push_back(ExportOption(PropertyInfo(Variant::DICTIONARY, "privacy/camera_usage_description_localized", PROPERTY_HINT_LOCALIZABLE_STRING), Dictionary()));
  116. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "privacy/microphone_usage_description", PROPERTY_HINT_PLACEHOLDER_TEXT, "Provide a message if you need to use the microphone"), ""));
  117. r_options->push_back(ExportOption(PropertyInfo(Variant::DICTIONARY, "privacy/microphone_usage_description_localized", PROPERTY_HINT_LOCALIZABLE_STRING), Dictionary()));
  118. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "privacy/photolibrary_usage_description", PROPERTY_HINT_PLACEHOLDER_TEXT, "Provide a message if you need access to the photo library"), ""));
  119. r_options->push_back(ExportOption(PropertyInfo(Variant::DICTIONARY, "privacy/photolibrary_usage_description_localized", PROPERTY_HINT_LOCALIZABLE_STRING), Dictionary()));
  120. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "icons/iphone_120x120", PROPERTY_HINT_FILE, "*.png"), "")); // Home screen on iPhone/iPod Touch with Retina display
  121. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "icons/iphone_180x180", PROPERTY_HINT_FILE, "*.png"), "")); // Home screen on iPhone with Retina HD display
  122. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "icons/ipad_76x76", PROPERTY_HINT_FILE, "*.png"), "")); // Home screen on iPad
  123. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "icons/ipad_152x152", PROPERTY_HINT_FILE, "*.png"), "")); // Home screen on iPad with Retina display
  124. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "icons/ipad_167x167", PROPERTY_HINT_FILE, "*.png"), "")); // Home screen on iPad Pro
  125. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "icons/app_store_1024x1024", PROPERTY_HINT_FILE, "*.png"), "")); // App Store
  126. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "icons/spotlight_40x40", PROPERTY_HINT_FILE, "*.png"), "")); // Spotlight
  127. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "icons/spotlight_80x80", PROPERTY_HINT_FILE, "*.png"), "")); // Spotlight on devices with Retina display
  128. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "storyboard/use_launch_screen_storyboard"), false));
  129. r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "storyboard/image_scale_mode", PROPERTY_HINT_ENUM, "Same as Logo,Center,Scale to Fit,Scale to Fill,Scale"), 0));
  130. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "storyboard/custom_image@2x", PROPERTY_HINT_FILE, "*.png"), ""));
  131. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "storyboard/custom_image@3x", PROPERTY_HINT_FILE, "*.png"), ""));
  132. r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "storyboard/use_custom_bg_color"), false));
  133. r_options->push_back(ExportOption(PropertyInfo(Variant::COLOR, "storyboard/custom_bg_color"), Color()));
  134. for (uint64_t i = 0; i < sizeof(loading_screen_infos) / sizeof(loading_screen_infos[0]); ++i) {
  135. r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, loading_screen_infos[i].preset_key, PROPERTY_HINT_FILE, "*.png"), ""));
  136. }
  137. }
  138. void EditorExportPlatformIOS::_fix_config_file(const Ref<EditorExportPreset> &p_preset, Vector<uint8_t> &pfile, const IOSConfigData &p_config, bool p_debug) {
  139. static const String export_method_string[] = {
  140. "app-store",
  141. "development",
  142. "ad-hoc",
  143. "enterprise"
  144. };
  145. static const String storyboard_image_scale_mode[] = {
  146. "center",
  147. "scaleAspectFit",
  148. "scaleAspectFill",
  149. "scaleToFill"
  150. };
  151. String dbg_sign_id = p_preset->get("application/code_sign_identity_debug").operator String().is_empty() ? "iPhone Developer" : p_preset->get("application/code_sign_identity_debug");
  152. String rel_sign_id = p_preset->get("application/code_sign_identity_release").operator String().is_empty() ? "iPhone Distribution" : p_preset->get("application/code_sign_identity_release");
  153. bool dbg_manual = !p_preset->get("application/provisioning_profile_uuid_debug").operator String().is_empty() || (dbg_sign_id != "iPhone Developer");
  154. bool rel_manual = !p_preset->get("application/provisioning_profile_uuid_release").operator String().is_empty() || (rel_sign_id != "iPhone Distribution");
  155. String str;
  156. String strnew;
  157. str.parse_utf8((const char *)pfile.ptr(), pfile.size());
  158. Vector<String> lines = str.split("\n");
  159. for (int i = 0; i < lines.size(); i++) {
  160. if (lines[i].find("$binary") != -1) {
  161. strnew += lines[i].replace("$binary", p_config.binary_name) + "\n";
  162. } else if (lines[i].find("$modules_buildfile") != -1) {
  163. strnew += lines[i].replace("$modules_buildfile", p_config.modules_buildfile) + "\n";
  164. } else if (lines[i].find("$modules_fileref") != -1) {
  165. strnew += lines[i].replace("$modules_fileref", p_config.modules_fileref) + "\n";
  166. } else if (lines[i].find("$modules_buildphase") != -1) {
  167. strnew += lines[i].replace("$modules_buildphase", p_config.modules_buildphase) + "\n";
  168. } else if (lines[i].find("$modules_buildgrp") != -1) {
  169. strnew += lines[i].replace("$modules_buildgrp", p_config.modules_buildgrp) + "\n";
  170. } else if (lines[i].find("$name") != -1) {
  171. strnew += lines[i].replace("$name", p_config.pkg_name) + "\n";
  172. } else if (lines[i].find("$bundle_identifier") != -1) {
  173. strnew += lines[i].replace("$bundle_identifier", p_preset->get("application/bundle_identifier")) + "\n";
  174. } else if (lines[i].find("$short_version") != -1) {
  175. strnew += lines[i].replace("$short_version", p_preset->get("application/short_version")) + "\n";
  176. } else if (lines[i].find("$version") != -1) {
  177. strnew += lines[i].replace("$version", p_preset->get("application/version")) + "\n";
  178. } else if (lines[i].find("$signature") != -1) {
  179. strnew += lines[i].replace("$signature", p_preset->get("application/signature")) + "\n";
  180. } else if (lines[i].find("$team_id") != -1) {
  181. strnew += lines[i].replace("$team_id", p_preset->get("application/app_store_team_id")) + "\n";
  182. } else if (lines[i].find("$default_build_config") != -1) {
  183. strnew += lines[i].replace("$default_build_config", p_debug ? "Debug" : "Release") + "\n";
  184. } else if (lines[i].find("$export_method") != -1) {
  185. int export_method = p_preset->get(p_debug ? "application/export_method_debug" : "application/export_method_release");
  186. strnew += lines[i].replace("$export_method", export_method_string[export_method]) + "\n";
  187. } else if (lines[i].find("$provisioning_profile_uuid_release") != -1) {
  188. strnew += lines[i].replace("$provisioning_profile_uuid_release", p_preset->get("application/provisioning_profile_uuid_release")) + "\n";
  189. } else if (lines[i].find("$provisioning_profile_uuid_debug") != -1) {
  190. strnew += lines[i].replace("$provisioning_profile_uuid_debug", p_preset->get("application/provisioning_profile_uuid_debug")) + "\n";
  191. } else if (lines[i].find("$code_sign_style_debug") != -1) {
  192. if (dbg_manual) {
  193. strnew += lines[i].replace("$code_sign_style_debug", "Manual") + "\n";
  194. } else {
  195. strnew += lines[i].replace("$code_sign_style_debug", "Automatic") + "\n";
  196. }
  197. } else if (lines[i].find("$code_sign_style_release") != -1) {
  198. if (rel_manual) {
  199. strnew += lines[i].replace("$code_sign_style_release", "Manual") + "\n";
  200. } else {
  201. strnew += lines[i].replace("$code_sign_style_release", "Automatic") + "\n";
  202. }
  203. } else if (lines[i].find("$provisioning_profile_uuid") != -1) {
  204. String uuid = p_debug ? p_preset->get("application/provisioning_profile_uuid_debug") : p_preset->get("application/provisioning_profile_uuid_release");
  205. strnew += lines[i].replace("$provisioning_profile_uuid", uuid) + "\n";
  206. } else if (lines[i].find("$code_sign_identity_debug") != -1) {
  207. strnew += lines[i].replace("$code_sign_identity_debug", dbg_sign_id) + "\n";
  208. } else if (lines[i].find("$code_sign_identity_release") != -1) {
  209. strnew += lines[i].replace("$code_sign_identity_release", rel_sign_id) + "\n";
  210. } else if (lines[i].find("$additional_plist_content") != -1) {
  211. strnew += lines[i].replace("$additional_plist_content", p_config.plist_content) + "\n";
  212. } else if (lines[i].find("$godot_archs") != -1) {
  213. strnew += lines[i].replace("$godot_archs", p_config.architectures) + "\n";
  214. } else if (lines[i].find("$linker_flags") != -1) {
  215. strnew += lines[i].replace("$linker_flags", p_config.linker_flags) + "\n";
  216. } else if (lines[i].find("$targeted_device_family") != -1) {
  217. String xcode_value;
  218. switch ((int)p_preset->get("application/targeted_device_family")) {
  219. case 0: // iPhone
  220. xcode_value = "1";
  221. break;
  222. case 1: // iPad
  223. xcode_value = "2";
  224. break;
  225. case 2: // iPhone & iPad
  226. xcode_value = "1,2";
  227. break;
  228. }
  229. strnew += lines[i].replace("$targeted_device_family", xcode_value) + "\n";
  230. } else if (lines[i].find("$cpp_code") != -1) {
  231. strnew += lines[i].replace("$cpp_code", p_config.cpp_code) + "\n";
  232. } else if (lines[i].find("$docs_in_place") != -1) {
  233. strnew += lines[i].replace("$docs_in_place", ((bool)p_preset->get("user_data/accessible_from_files_app")) ? "<true/>" : "<false/>") + "\n";
  234. } else if (lines[i].find("$docs_sharing") != -1) {
  235. strnew += lines[i].replace("$docs_sharing", ((bool)p_preset->get("user_data/accessible_from_itunes_sharing")) ? "<true/>" : "<false/>") + "\n";
  236. } else if (lines[i].find("$entitlements_push_notifications") != -1) {
  237. bool is_on = p_preset->get("capabilities/push_notifications");
  238. strnew += lines[i].replace("$entitlements_push_notifications", is_on ? "<key>aps-environment</key><string>development</string>" : "") + "\n";
  239. } else if (lines[i].find("$required_device_capabilities") != -1) {
  240. String capabilities;
  241. // I've removed armv7 as we can run on 64bit only devices
  242. // Note that capabilities listed here are requirements for the app to be installed.
  243. // They don't enable anything.
  244. Vector<String> capabilities_list = p_config.capabilities;
  245. if ((bool)p_preset->get("capabilities/access_wifi") && !capabilities_list.has("wifi")) {
  246. capabilities_list.push_back("wifi");
  247. }
  248. for (int idx = 0; idx < capabilities_list.size(); idx++) {
  249. capabilities += "<string>" + capabilities_list[idx] + "</string>\n";
  250. }
  251. strnew += lines[i].replace("$required_device_capabilities", capabilities);
  252. } else if (lines[i].find("$interface_orientations") != -1) {
  253. String orientations;
  254. const DisplayServer::ScreenOrientation screen_orientation =
  255. DisplayServer::ScreenOrientation(int(GLOBAL_GET("display/window/handheld/orientation")));
  256. switch (screen_orientation) {
  257. case DisplayServer::SCREEN_LANDSCAPE:
  258. orientations += "<string>UIInterfaceOrientationLandscapeLeft</string>\n";
  259. break;
  260. case DisplayServer::SCREEN_PORTRAIT:
  261. orientations += "<string>UIInterfaceOrientationPortrait</string>\n";
  262. break;
  263. case DisplayServer::SCREEN_REVERSE_LANDSCAPE:
  264. orientations += "<string>UIInterfaceOrientationLandscapeRight</string>\n";
  265. break;
  266. case DisplayServer::SCREEN_REVERSE_PORTRAIT:
  267. orientations += "<string>UIInterfaceOrientationPortraitUpsideDown</string>\n";
  268. break;
  269. case DisplayServer::SCREEN_SENSOR_LANDSCAPE:
  270. // Allow both landscape orientations depending on sensor direction.
  271. orientations += "<string>UIInterfaceOrientationLandscapeLeft</string>\n";
  272. orientations += "<string>UIInterfaceOrientationLandscapeRight</string>\n";
  273. break;
  274. case DisplayServer::SCREEN_SENSOR_PORTRAIT:
  275. // Allow both portrait orientations depending on sensor direction.
  276. orientations += "<string>UIInterfaceOrientationPortrait</string>\n";
  277. orientations += "<string>UIInterfaceOrientationPortraitUpsideDown</string>\n";
  278. break;
  279. case DisplayServer::SCREEN_SENSOR:
  280. // Allow all screen orientations depending on sensor direction.
  281. orientations += "<string>UIInterfaceOrientationLandscapeLeft</string>\n";
  282. orientations += "<string>UIInterfaceOrientationLandscapeRight</string>\n";
  283. orientations += "<string>UIInterfaceOrientationPortrait</string>\n";
  284. orientations += "<string>UIInterfaceOrientationPortraitUpsideDown</string>\n";
  285. break;
  286. }
  287. strnew += lines[i].replace("$interface_orientations", orientations);
  288. } else if (lines[i].find("$camera_usage_description") != -1) {
  289. String description = p_preset->get("privacy/camera_usage_description");
  290. strnew += lines[i].replace("$camera_usage_description", description) + "\n";
  291. } else if (lines[i].find("$microphone_usage_description") != -1) {
  292. String description = p_preset->get("privacy/microphone_usage_description");
  293. strnew += lines[i].replace("$microphone_usage_description", description) + "\n";
  294. } else if (lines[i].find("$photolibrary_usage_description") != -1) {
  295. String description = p_preset->get("privacy/photolibrary_usage_description");
  296. strnew += lines[i].replace("$photolibrary_usage_description", description) + "\n";
  297. } else if (lines[i].find("$plist_launch_screen_name") != -1) {
  298. bool is_on = p_preset->get("storyboard/use_launch_screen_storyboard");
  299. String value = is_on ? "<key>UILaunchStoryboardName</key>\n<string>Launch Screen</string>" : "";
  300. strnew += lines[i].replace("$plist_launch_screen_name", value) + "\n";
  301. } else if (lines[i].find("$pbx_launch_screen_file_reference") != -1) {
  302. bool is_on = p_preset->get("storyboard/use_launch_screen_storyboard");
  303. String value = is_on ? "90DD2D9D24B36E8000717FE1 = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = file.storyboard; path = \"Launch Screen.storyboard\"; sourceTree = \"<group>\"; };" : "";
  304. strnew += lines[i].replace("$pbx_launch_screen_file_reference", value) + "\n";
  305. } else if (lines[i].find("$pbx_launch_screen_copy_files") != -1) {
  306. bool is_on = p_preset->get("storyboard/use_launch_screen_storyboard");
  307. String value = is_on ? "90DD2D9D24B36E8000717FE1 /* Launch Screen.storyboard */," : "";
  308. strnew += lines[i].replace("$pbx_launch_screen_copy_files", value) + "\n";
  309. } else if (lines[i].find("$pbx_launch_screen_build_phase") != -1) {
  310. bool is_on = p_preset->get("storyboard/use_launch_screen_storyboard");
  311. String value = is_on ? "90DD2D9E24B36E8000717FE1 /* Launch Screen.storyboard in Resources */," : "";
  312. strnew += lines[i].replace("$pbx_launch_screen_build_phase", value) + "\n";
  313. } else if (lines[i].find("$pbx_launch_screen_build_reference") != -1) {
  314. bool is_on = p_preset->get("storyboard/use_launch_screen_storyboard");
  315. String value = is_on ? "90DD2D9E24B36E8000717FE1 /* Launch Screen.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 90DD2D9D24B36E8000717FE1 /* Launch Screen.storyboard */; };" : "";
  316. strnew += lines[i].replace("$pbx_launch_screen_build_reference", value) + "\n";
  317. } else if (lines[i].find("$pbx_launch_image_usage_setting") != -1) {
  318. bool is_on = p_preset->get("storyboard/use_launch_screen_storyboard");
  319. String value = is_on ? "" : "ASSETCATALOG_COMPILER_LAUNCHIMAGE_NAME = LaunchImage;";
  320. strnew += lines[i].replace("$pbx_launch_image_usage_setting", value) + "\n";
  321. } else if (lines[i].find("$launch_screen_image_mode") != -1) {
  322. int image_scale_mode = p_preset->get("storyboard/image_scale_mode");
  323. String value;
  324. switch (image_scale_mode) {
  325. case 0: {
  326. String logo_path = ProjectSettings::get_singleton()->get("application/boot_splash/image");
  327. bool is_on = ProjectSettings::get_singleton()->get("application/boot_splash/fullsize");
  328. // If custom logo is not specified, Godot does not scale default one, so we should do the same.
  329. value = (is_on && logo_path.length() > 0) ? "scaleAspectFit" : "center";
  330. } break;
  331. default: {
  332. value = storyboard_image_scale_mode[image_scale_mode - 1];
  333. }
  334. }
  335. strnew += lines[i].replace("$launch_screen_image_mode", value) + "\n";
  336. } else if (lines[i].find("$launch_screen_background_color") != -1) {
  337. bool use_custom = p_preset->get("storyboard/use_custom_bg_color");
  338. Color color = use_custom ? p_preset->get("storyboard/custom_bg_color") : ProjectSettings::get_singleton()->get("application/boot_splash/bg_color");
  339. const String value_format = "red=\"$red\" green=\"$green\" blue=\"$blue\" alpha=\"$alpha\"";
  340. Dictionary value_dictionary;
  341. value_dictionary["red"] = color.r;
  342. value_dictionary["green"] = color.g;
  343. value_dictionary["blue"] = color.b;
  344. value_dictionary["alpha"] = color.a;
  345. String value = value_format.format(value_dictionary, "$_");
  346. strnew += lines[i].replace("$launch_screen_background_color", value) + "\n";
  347. } else if (lines[i].find("$pbx_locale_file_reference") != -1) {
  348. String locale_files;
  349. Vector<String> translations = ProjectSettings::get_singleton()->get("internationalization/locale/translations");
  350. if (translations.size() > 0) {
  351. int index = 0;
  352. for (const String &E : translations) {
  353. Ref<Translation> tr = ResourceLoader::load(E);
  354. if (tr.is_valid()) {
  355. String lang = tr->get_locale();
  356. locale_files += "D0BCFE4518AEBDA2004A" + itos(index).pad_zeros(4) + " /* " + lang + " */ = {isa = PBXFileReference; lastKnownFileType = text.plist.strings; name = " + lang + "; path = " + lang + ".lproj/InfoPlist.strings; sourceTree = \"<group>\"; };";
  357. }
  358. index++;
  359. }
  360. }
  361. strnew += lines[i].replace("$pbx_locale_file_reference", locale_files);
  362. } else if (lines[i].find("$pbx_locale_build_reference") != -1) {
  363. String locale_files;
  364. Vector<String> translations = ProjectSettings::get_singleton()->get("internationalization/locale/translations");
  365. if (translations.size() > 0) {
  366. int index = 0;
  367. for (const String &E : translations) {
  368. Ref<Translation> tr = ResourceLoader::load(E);
  369. if (tr.is_valid()) {
  370. String lang = tr->get_locale();
  371. locale_files += "D0BCFE4518AEBDA2004A" + itos(index).pad_zeros(4) + " /* " + lang + " */,";
  372. }
  373. index++;
  374. }
  375. }
  376. strnew += lines[i].replace("$pbx_locale_build_reference", locale_files);
  377. } else if (lines[i].find("$swift_runtime_migration") != -1) {
  378. String value = !p_config.use_swift_runtime ? "" : "LastSwiftMigration = 1250;";
  379. strnew += lines[i].replace("$swift_runtime_migration", value) + "\n";
  380. } else if (lines[i].find("$swift_runtime_build_settings") != -1) {
  381. String value = !p_config.use_swift_runtime ? "" : R"(
  382. CLANG_ENABLE_MODULES = YES;
  383. SWIFT_OBJC_BRIDGING_HEADER = "$binary/dummy.h";
  384. SWIFT_VERSION = 5.0;
  385. )";
  386. value = value.replace("$binary", p_config.binary_name);
  387. strnew += lines[i].replace("$swift_runtime_build_settings", value) + "\n";
  388. } else if (lines[i].find("$swift_runtime_fileref") != -1) {
  389. String value = !p_config.use_swift_runtime ? "" : R"(
  390. 90B4C2AA2680BC560039117A /* dummy.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "dummy.h"; sourceTree = "<group>"; };
  391. 90B4C2B52680C7E90039117A /* dummy.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "dummy.swift"; sourceTree = "<group>"; };
  392. )";
  393. strnew += lines[i].replace("$swift_runtime_fileref", value) + "\n";
  394. } else if (lines[i].find("$swift_runtime_binary_files") != -1) {
  395. String value = !p_config.use_swift_runtime ? "" : R"(
  396. 90B4C2AA2680BC560039117A /* dummy.h */,
  397. 90B4C2B52680C7E90039117A /* dummy.swift */,
  398. )";
  399. strnew += lines[i].replace("$swift_runtime_binary_files", value) + "\n";
  400. } else if (lines[i].find("$swift_runtime_buildfile") != -1) {
  401. String value = !p_config.use_swift_runtime ? "" : "90B4C2B62680C7E90039117A /* dummy.swift in Sources */ = {isa = PBXBuildFile; fileRef = 90B4C2B52680C7E90039117A /* dummy.swift */; };";
  402. strnew += lines[i].replace("$swift_runtime_buildfile", value) + "\n";
  403. } else if (lines[i].find("$swift_runtime_build_phase") != -1) {
  404. String value = !p_config.use_swift_runtime ? "" : "90B4C2B62680C7E90039117A /* dummy.swift */,";
  405. strnew += lines[i].replace("$swift_runtime_build_phase", value) + "\n";
  406. } else {
  407. strnew += lines[i] + "\n";
  408. }
  409. }
  410. // !BAS! I'm assuming the 9 in the original code was a typo. I've added -1 or else it seems to also be adding our terminating zero...
  411. // should apply the same fix in our macOS export.
  412. CharString cs = strnew.utf8();
  413. pfile.resize(cs.size() - 1);
  414. for (int i = 0; i < cs.size() - 1; i++) {
  415. pfile.write[i] = cs[i];
  416. }
  417. }
  418. String EditorExportPlatformIOS::_get_additional_plist_content() {
  419. Vector<Ref<EditorExportPlugin>> export_plugins = EditorExport::get_singleton()->get_export_plugins();
  420. String result;
  421. for (int i = 0; i < export_plugins.size(); ++i) {
  422. result += export_plugins[i]->get_ios_plist_content();
  423. }
  424. return result;
  425. }
  426. String EditorExportPlatformIOS::_get_linker_flags() {
  427. Vector<Ref<EditorExportPlugin>> export_plugins = EditorExport::get_singleton()->get_export_plugins();
  428. String result;
  429. for (int i = 0; i < export_plugins.size(); ++i) {
  430. String flags = export_plugins[i]->get_ios_linker_flags();
  431. if (flags.length() == 0) {
  432. continue;
  433. }
  434. if (result.length() > 0) {
  435. result += ' ';
  436. }
  437. result += flags;
  438. }
  439. // the flags will be enclosed in quotes, so need to escape them
  440. return result.replace("\"", "\\\"");
  441. }
  442. String EditorExportPlatformIOS::_get_cpp_code() {
  443. Vector<Ref<EditorExportPlugin>> export_plugins = EditorExport::get_singleton()->get_export_plugins();
  444. String result;
  445. for (int i = 0; i < export_plugins.size(); ++i) {
  446. result += export_plugins[i]->get_ios_cpp_code();
  447. }
  448. return result;
  449. }
  450. void EditorExportPlatformIOS::_blend_and_rotate(Ref<Image> &p_dst, Ref<Image> &p_src, bool p_rot) {
  451. ERR_FAIL_COND(p_dst.is_null());
  452. ERR_FAIL_COND(p_src.is_null());
  453. int sw = p_rot ? p_src->get_height() : p_src->get_width();
  454. int sh = p_rot ? p_src->get_width() : p_src->get_height();
  455. int x_pos = (p_dst->get_width() - sw) / 2;
  456. int y_pos = (p_dst->get_height() - sh) / 2;
  457. int xs = (x_pos >= 0) ? 0 : -x_pos;
  458. int ys = (y_pos >= 0) ? 0 : -y_pos;
  459. if (sw + x_pos > p_dst->get_width()) {
  460. sw = p_dst->get_width() - x_pos;
  461. }
  462. if (sh + y_pos > p_dst->get_height()) {
  463. sh = p_dst->get_height() - y_pos;
  464. }
  465. for (int y = ys; y < sh; y++) {
  466. for (int x = xs; x < sw; x++) {
  467. Color sc = p_rot ? p_src->get_pixel(p_src->get_width() - y - 1, x) : p_src->get_pixel(x, y);
  468. Color dc = p_dst->get_pixel(x_pos + x, y_pos + y);
  469. dc.r = (double)(sc.a * sc.r + dc.a * (1.0 - sc.a) * dc.r);
  470. dc.g = (double)(sc.a * sc.g + dc.a * (1.0 - sc.a) * dc.g);
  471. dc.b = (double)(sc.a * sc.b + dc.a * (1.0 - sc.a) * dc.b);
  472. dc.a = (double)(sc.a + dc.a * (1.0 - sc.a));
  473. p_dst->set_pixel(x_pos + x, y_pos + y, dc);
  474. }
  475. }
  476. }
  477. struct IconInfo {
  478. const char *preset_key;
  479. const char *idiom;
  480. const char *export_name;
  481. const char *actual_size_side;
  482. const char *scale;
  483. const char *unscaled_size;
  484. };
  485. static const IconInfo icon_infos[] = {
  486. // Home screen on iPhone
  487. { "icons/iphone_120x120", "iphone", "Icon-120.png", "120", "2x", "60x60" },
  488. { "icons/iphone_120x120", "iphone", "Icon-120.png", "120", "3x", "40x40" },
  489. { "icons/iphone_180x180", "iphone", "Icon-180.png", "180", "3x", "60x60" },
  490. // Home screen on iPad
  491. { "icons/ipad_76x76", "ipad", "Icon-76.png", "76", "1x", "76x76" },
  492. { "icons/ipad_152x152", "ipad", "Icon-152.png", "152", "2x", "76x76" },
  493. { "icons/ipad_167x167", "ipad", "Icon-167.png", "167", "2x", "83.5x83.5" },
  494. // App Store
  495. { "icons/app_store_1024x1024", "ios-marketing", "Icon-1024.png", "1024", "1x", "1024x1024" },
  496. // Spotlight
  497. { "icons/spotlight_40x40", "ipad", "Icon-40.png", "40", "1x", "40x40" },
  498. { "icons/spotlight_80x80", "iphone", "Icon-80.png", "80", "2x", "40x40" },
  499. { "icons/spotlight_80x80", "ipad", "Icon-80.png", "80", "2x", "40x40" }
  500. };
  501. Error EditorExportPlatformIOS::_export_icons(const Ref<EditorExportPreset> &p_preset, const String &p_iconset_dir) {
  502. String json_description = "{\"images\":[";
  503. String sizes;
  504. Ref<DirAccess> da = DirAccess::open(p_iconset_dir);
  505. ERR_FAIL_COND_V_MSG(da.is_null(), ERR_CANT_OPEN, "Cannot open directory '" + p_iconset_dir + "'.");
  506. for (uint64_t i = 0; i < (sizeof(icon_infos) / sizeof(icon_infos[0])); ++i) {
  507. IconInfo info = icon_infos[i];
  508. int side_size = String(info.actual_size_side).to_int();
  509. String icon_path = p_preset->get(info.preset_key);
  510. if (icon_path.length() == 0) {
  511. // Resize main app icon
  512. icon_path = ProjectSettings::get_singleton()->get("application/config/icon");
  513. Ref<Image> img = memnew(Image);
  514. Error err = ImageLoader::load_image(icon_path, img);
  515. if (err != OK) {
  516. ERR_PRINT("Invalid icon (" + String(info.preset_key) + "): '" + icon_path + "'.");
  517. return ERR_UNCONFIGURED;
  518. }
  519. img->resize(side_size, side_size);
  520. err = img->save_png(p_iconset_dir + info.export_name);
  521. if (err) {
  522. String err_str = String("Failed to export icon(" + String(info.preset_key) + "): '" + icon_path + "'.");
  523. ERR_PRINT(err_str.utf8().get_data());
  524. return err;
  525. }
  526. } else {
  527. // Load custom icon and resize if required
  528. Ref<Image> img = memnew(Image);
  529. Error err = ImageLoader::load_image(icon_path, img);
  530. if (err != OK) {
  531. ERR_PRINT("Invalid icon (" + String(info.preset_key) + "): '" + icon_path + "'.");
  532. return ERR_UNCONFIGURED;
  533. }
  534. if (img->get_width() != side_size || img->get_height() != side_size) {
  535. WARN_PRINT("Icon (" + String(info.preset_key) + "): '" + icon_path + "' has incorrect size (" + String::num_int64(img->get_width()) + "x" + String::num_int64(img->get_height()) + ") and was automatically resized to " + String::num_int64(side_size) + "x" + String::num_int64(side_size) + ".");
  536. img->resize(side_size, side_size);
  537. err = img->save_png(p_iconset_dir + info.export_name);
  538. } else {
  539. err = da->copy(icon_path, p_iconset_dir + info.export_name);
  540. }
  541. if (err) {
  542. String err_str = String("Failed to export icon(" + String(info.preset_key) + "): '" + icon_path + "'.");
  543. ERR_PRINT(err_str.utf8().get_data());
  544. return err;
  545. }
  546. }
  547. sizes += String(info.actual_size_side) + "\n";
  548. if (i > 0) {
  549. json_description += ",";
  550. }
  551. json_description += String("{");
  552. json_description += String("\"idiom\":") + "\"" + info.idiom + "\",";
  553. json_description += String("\"size\":") + "\"" + info.unscaled_size + "\",";
  554. json_description += String("\"scale\":") + "\"" + info.scale + "\",";
  555. json_description += String("\"filename\":") + "\"" + info.export_name + "\"";
  556. json_description += String("}");
  557. }
  558. json_description += "]}";
  559. Ref<FileAccess> json_file = FileAccess::open(p_iconset_dir + "Contents.json", FileAccess::WRITE);
  560. ERR_FAIL_COND_V(json_file.is_null(), ERR_CANT_CREATE);
  561. CharString json_utf8 = json_description.utf8();
  562. json_file->store_buffer((const uint8_t *)json_utf8.get_data(), json_utf8.length());
  563. Ref<FileAccess> sizes_file = FileAccess::open(p_iconset_dir + "sizes", FileAccess::WRITE);
  564. ERR_FAIL_COND_V(sizes_file.is_null(), ERR_CANT_CREATE);
  565. CharString sizes_utf8 = sizes.utf8();
  566. sizes_file->store_buffer((const uint8_t *)sizes_utf8.get_data(), sizes_utf8.length());
  567. return OK;
  568. }
  569. Error EditorExportPlatformIOS::_export_loading_screen_file(const Ref<EditorExportPreset> &p_preset, const String &p_dest_dir) {
  570. const String custom_launch_image_2x = p_preset->get("storyboard/custom_image@2x");
  571. const String custom_launch_image_3x = p_preset->get("storyboard/custom_image@3x");
  572. if (custom_launch_image_2x.length() > 0 && custom_launch_image_3x.length() > 0) {
  573. Ref<Image> image;
  574. String image_path = p_dest_dir.plus_file("[email protected]");
  575. image.instantiate();
  576. Error err = image->load(custom_launch_image_2x);
  577. if (err) {
  578. image.unref();
  579. return err;
  580. }
  581. if (image->save_png(image_path) != OK) {
  582. return ERR_FILE_CANT_WRITE;
  583. }
  584. image.unref();
  585. image_path = p_dest_dir.plus_file("[email protected]");
  586. image.instantiate();
  587. err = image->load(custom_launch_image_3x);
  588. if (err) {
  589. image.unref();
  590. return err;
  591. }
  592. if (image->save_png(image_path) != OK) {
  593. return ERR_FILE_CANT_WRITE;
  594. }
  595. } else {
  596. Ref<Image> splash;
  597. const String splash_path = ProjectSettings::get_singleton()->get("application/boot_splash/image");
  598. if (!splash_path.is_empty()) {
  599. splash.instantiate();
  600. const Error err = splash->load(splash_path);
  601. if (err) {
  602. splash.unref();
  603. }
  604. }
  605. if (splash.is_null()) {
  606. splash = Ref<Image>(memnew(Image(boot_splash_png)));
  607. }
  608. // Using same image for both @2x and @3x
  609. // because Godot's own boot logo uses single image for all resolutions.
  610. // Also not using @1x image, because devices using this image variant
  611. // are not supported by iOS 9, which is minimal target.
  612. const String splash_png_path_2x = p_dest_dir.plus_file("[email protected]");
  613. const String splash_png_path_3x = p_dest_dir.plus_file("[email protected]");
  614. if (splash->save_png(splash_png_path_2x) != OK) {
  615. return ERR_FILE_CANT_WRITE;
  616. }
  617. if (splash->save_png(splash_png_path_3x) != OK) {
  618. return ERR_FILE_CANT_WRITE;
  619. }
  620. }
  621. return OK;
  622. }
  623. Error EditorExportPlatformIOS::_export_loading_screen_images(const Ref<EditorExportPreset> &p_preset, const String &p_dest_dir) {
  624. Ref<DirAccess> da = DirAccess::open(p_dest_dir);
  625. ERR_FAIL_COND_V_MSG(da.is_null(), ERR_CANT_OPEN, "Cannot open directory '" + p_dest_dir + "'.");
  626. for (uint64_t i = 0; i < sizeof(loading_screen_infos) / sizeof(loading_screen_infos[0]); ++i) {
  627. LoadingScreenInfo info = loading_screen_infos[i];
  628. String loading_screen_file = p_preset->get(info.preset_key);
  629. Color boot_bg_color = ProjectSettings::get_singleton()->get("application/boot_splash/bg_color");
  630. String boot_logo_path = ProjectSettings::get_singleton()->get("application/boot_splash/image");
  631. bool boot_logo_scale = ProjectSettings::get_singleton()->get("application/boot_splash/fullsize");
  632. if (loading_screen_file.size() > 0) {
  633. // Load custom loading screens, and resize if required.
  634. Ref<Image> img = memnew(Image);
  635. Error err = ImageLoader::load_image(loading_screen_file, img);
  636. if (err != OK) {
  637. ERR_PRINT("Invalid loading screen (" + String(info.preset_key) + "): '" + loading_screen_file + "'.");
  638. return ERR_UNCONFIGURED;
  639. }
  640. if (img->get_width() != info.width || img->get_height() != info.height) {
  641. WARN_PRINT("Loading screen (" + String(info.preset_key) + "): '" + loading_screen_file + "' has incorrect size (" + String::num_int64(img->get_width()) + "x" + String::num_int64(img->get_height()) + ") and was automatically resized to " + String::num_int64(info.width) + "x" + String::num_int64(info.height) + ".");
  642. float aspect_ratio = (float)img->get_width() / (float)img->get_height();
  643. if (boot_logo_scale) {
  644. if (info.height * aspect_ratio <= info.width) {
  645. img->resize(info.height * aspect_ratio, info.height);
  646. } else {
  647. img->resize(info.width, info.width / aspect_ratio);
  648. }
  649. }
  650. Ref<Image> new_img = memnew(Image);
  651. new_img->create(info.width, info.height, false, Image::FORMAT_RGBA8);
  652. new_img->fill(boot_bg_color);
  653. _blend_and_rotate(new_img, img, false);
  654. err = new_img->save_png(p_dest_dir + info.export_name);
  655. } else {
  656. err = da->copy(loading_screen_file, p_dest_dir + info.export_name);
  657. }
  658. if (err) {
  659. String err_str = String("Failed to export loading screen (") + info.preset_key + ") from path '" + loading_screen_file + "'.";
  660. ERR_PRINT(err_str.utf8().get_data());
  661. return err;
  662. }
  663. } else {
  664. // Generate loading screen from the splash screen
  665. Ref<Image> img = memnew(Image);
  666. img->create(info.width, info.height, false, Image::FORMAT_RGBA8);
  667. img->fill(boot_bg_color);
  668. Ref<Image> img_bs;
  669. if (boot_logo_path.length() > 0) {
  670. img_bs = Ref<Image>(memnew(Image));
  671. ImageLoader::load_image(boot_logo_path, img_bs);
  672. }
  673. if (!img_bs.is_valid()) {
  674. img_bs = Ref<Image>(memnew(Image(boot_splash_png)));
  675. }
  676. if (img_bs.is_valid()) {
  677. float aspect_ratio = (float)img_bs->get_width() / (float)img_bs->get_height();
  678. if (info.rotate) {
  679. if (boot_logo_scale) {
  680. if (info.width * aspect_ratio <= info.height) {
  681. img_bs->resize(info.width * aspect_ratio, info.width);
  682. } else {
  683. img_bs->resize(info.height, info.height / aspect_ratio);
  684. }
  685. }
  686. } else {
  687. if (boot_logo_scale) {
  688. if (info.height * aspect_ratio <= info.width) {
  689. img_bs->resize(info.height * aspect_ratio, info.height);
  690. } else {
  691. img_bs->resize(info.width, info.width / aspect_ratio);
  692. }
  693. }
  694. }
  695. _blend_and_rotate(img, img_bs, info.rotate);
  696. }
  697. Error err = img->save_png(p_dest_dir + info.export_name);
  698. if (err) {
  699. String err_str = String("Failed to export loading screen (") + info.preset_key + ") from splash screen.";
  700. WARN_PRINT(err_str.utf8().get_data());
  701. }
  702. }
  703. }
  704. return OK;
  705. }
  706. Error EditorExportPlatformIOS::_walk_dir_recursive(Ref<DirAccess> &p_da, FileHandler p_handler, void *p_userdata) {
  707. Vector<String> dirs;
  708. String current_dir = p_da->get_current_dir();
  709. p_da->list_dir_begin();
  710. String path = p_da->get_next();
  711. while (!path.is_empty()) {
  712. if (p_da->current_is_dir()) {
  713. if (path != "." && path != "..") {
  714. dirs.push_back(path);
  715. }
  716. } else {
  717. Error err = p_handler(current_dir.plus_file(path), p_userdata);
  718. if (err) {
  719. p_da->list_dir_end();
  720. return err;
  721. }
  722. }
  723. path = p_da->get_next();
  724. }
  725. p_da->list_dir_end();
  726. for (int i = 0; i < dirs.size(); ++i) {
  727. String dir = dirs[i];
  728. p_da->change_dir(dir);
  729. Error err = _walk_dir_recursive(p_da, p_handler, p_userdata);
  730. p_da->change_dir("..");
  731. if (err) {
  732. return err;
  733. }
  734. }
  735. return OK;
  736. }
  737. struct CodesignData {
  738. const Ref<EditorExportPreset> &preset;
  739. bool debug = false;
  740. CodesignData(const Ref<EditorExportPreset> &p_preset, bool p_debug) :
  741. preset(p_preset),
  742. debug(p_debug) {
  743. }
  744. };
  745. Error EditorExportPlatformIOS::_codesign(String p_file, void *p_userdata) {
  746. if (p_file.ends_with(".dylib")) {
  747. CodesignData *data = static_cast<CodesignData *>(p_userdata);
  748. print_line(String("Signing ") + p_file);
  749. String sign_id;
  750. if (data->debug) {
  751. sign_id = data->preset->get("application/code_sign_identity_debug").operator String().is_empty() ? "iPhone Developer" : data->preset->get("application/code_sign_identity_debug");
  752. } else {
  753. sign_id = data->preset->get("application/code_sign_identity_release").operator String().is_empty() ? "iPhone Distribution" : data->preset->get("application/code_sign_identity_release");
  754. }
  755. List<String> codesign_args;
  756. codesign_args.push_back("-f");
  757. codesign_args.push_back("-s");
  758. codesign_args.push_back(sign_id);
  759. codesign_args.push_back(p_file);
  760. String str;
  761. Error err = OS::get_singleton()->execute("codesign", codesign_args, &str, nullptr, true);
  762. print_verbose("codesign (" + p_file + "):\n" + str);
  763. return err;
  764. }
  765. return OK;
  766. }
  767. struct PbxId {
  768. private:
  769. static char _hex_char(uint8_t four_bits) {
  770. if (four_bits < 10) {
  771. return ('0' + four_bits);
  772. }
  773. return 'A' + (four_bits - 10);
  774. }
  775. static String _hex_pad(uint32_t num) {
  776. Vector<char> ret;
  777. ret.resize(sizeof(num) * 2);
  778. for (uint64_t i = 0; i < sizeof(num) * 2; ++i) {
  779. uint8_t four_bits = (num >> (sizeof(num) * 8 - (i + 1) * 4)) & 0xF;
  780. ret.write[i] = _hex_char(four_bits);
  781. }
  782. return String::utf8(ret.ptr(), ret.size());
  783. }
  784. public:
  785. uint32_t high_bits;
  786. uint32_t mid_bits;
  787. uint32_t low_bits;
  788. String str() const {
  789. return _hex_pad(high_bits) + _hex_pad(mid_bits) + _hex_pad(low_bits);
  790. }
  791. PbxId &operator++() {
  792. low_bits++;
  793. if (!low_bits) {
  794. mid_bits++;
  795. if (!mid_bits) {
  796. high_bits++;
  797. }
  798. }
  799. return *this;
  800. }
  801. };
  802. struct ExportLibsData {
  803. Vector<String> lib_paths;
  804. String dest_dir;
  805. };
  806. void EditorExportPlatformIOS::_add_assets_to_project(const Ref<EditorExportPreset> &p_preset, Vector<uint8_t> &p_project_data, const Vector<IOSExportAsset> &p_additional_assets) {
  807. // that is just a random number, we just need Godot IDs not to clash with
  808. // existing IDs in the project.
  809. PbxId current_id = { 0x58938401, 0, 0 };
  810. String pbx_files;
  811. String pbx_frameworks_build;
  812. String pbx_frameworks_refs;
  813. String pbx_resources_build;
  814. String pbx_resources_refs;
  815. String pbx_embeded_frameworks;
  816. const String file_info_format = String("$build_id = {isa = PBXBuildFile; fileRef = $ref_id; };\n") +
  817. "$ref_id = {isa = PBXFileReference; lastKnownFileType = $file_type; name = \"$name\"; path = \"$file_path\"; sourceTree = \"<group>\"; };\n";
  818. for (int i = 0; i < p_additional_assets.size(); ++i) {
  819. String additional_asset_info_format = file_info_format;
  820. String build_id = (++current_id).str();
  821. String ref_id = (++current_id).str();
  822. String framework_id = "";
  823. const IOSExportAsset &asset = p_additional_assets[i];
  824. String type;
  825. if (asset.exported_path.ends_with(".framework")) {
  826. if (asset.should_embed) {
  827. additional_asset_info_format += "$framework_id = {isa = PBXBuildFile; fileRef = $ref_id; settings = {ATTRIBUTES = (CodeSignOnCopy, ); }; };\n";
  828. framework_id = (++current_id).str();
  829. pbx_embeded_frameworks += framework_id + ",\n";
  830. }
  831. type = "wrapper.framework";
  832. } else if (asset.exported_path.ends_with(".xcframework")) {
  833. if (asset.should_embed) {
  834. additional_asset_info_format += "$framework_id = {isa = PBXBuildFile; fileRef = $ref_id; settings = {ATTRIBUTES = (CodeSignOnCopy, ); }; };\n";
  835. framework_id = (++current_id).str();
  836. pbx_embeded_frameworks += framework_id + ",\n";
  837. }
  838. type = "wrapper.xcframework";
  839. } else if (asset.exported_path.ends_with(".dylib")) {
  840. type = "compiled.mach-o.dylib";
  841. } else if (asset.exported_path.ends_with(".a")) {
  842. type = "archive.ar";
  843. } else {
  844. type = "file";
  845. }
  846. String &pbx_build = asset.is_framework ? pbx_frameworks_build : pbx_resources_build;
  847. String &pbx_refs = asset.is_framework ? pbx_frameworks_refs : pbx_resources_refs;
  848. if (pbx_build.length() > 0) {
  849. pbx_build += ",\n";
  850. pbx_refs += ",\n";
  851. }
  852. pbx_build += build_id;
  853. pbx_refs += ref_id;
  854. Dictionary format_dict;
  855. format_dict["build_id"] = build_id;
  856. format_dict["ref_id"] = ref_id;
  857. format_dict["name"] = asset.exported_path.get_file();
  858. format_dict["file_path"] = asset.exported_path;
  859. format_dict["file_type"] = type;
  860. if (framework_id.length() > 0) {
  861. format_dict["framework_id"] = framework_id;
  862. }
  863. pbx_files += additional_asset_info_format.format(format_dict, "$_");
  864. }
  865. // Note, frameworks like gamekit are always included in our project.pbxprof file
  866. // even if turned off in capabilities.
  867. String str = String::utf8((const char *)p_project_data.ptr(), p_project_data.size());
  868. str = str.replace("$additional_pbx_files", pbx_files);
  869. str = str.replace("$additional_pbx_frameworks_build", pbx_frameworks_build);
  870. str = str.replace("$additional_pbx_frameworks_refs", pbx_frameworks_refs);
  871. str = str.replace("$additional_pbx_resources_build", pbx_resources_build);
  872. str = str.replace("$additional_pbx_resources_refs", pbx_resources_refs);
  873. str = str.replace("$pbx_embeded_frameworks", pbx_embeded_frameworks);
  874. CharString cs = str.utf8();
  875. p_project_data.resize(cs.size() - 1);
  876. for (int i = 0; i < cs.size() - 1; i++) {
  877. p_project_data.write[i] = cs[i];
  878. }
  879. }
  880. Error EditorExportPlatformIOS::_copy_asset(const String &p_out_dir, const String &p_asset, const String *p_custom_file_name, bool p_is_framework, bool p_should_embed, Vector<IOSExportAsset> &r_exported_assets) {
  881. String binary_name = p_out_dir.get_file().get_basename();
  882. Ref<DirAccess> da = DirAccess::create_for_path(p_asset);
  883. if (da.is_null()) {
  884. ERR_FAIL_V_MSG(ERR_CANT_CREATE, "Can't create directory: " + p_asset + ".");
  885. }
  886. bool file_exists = da->file_exists(p_asset);
  887. bool dir_exists = da->dir_exists(p_asset);
  888. if (!file_exists && !dir_exists) {
  889. return ERR_FILE_NOT_FOUND;
  890. }
  891. String base_dir = p_asset.get_base_dir().replace("res://", "");
  892. String destination_dir;
  893. String destination;
  894. String asset_path;
  895. bool create_framework = false;
  896. if (p_is_framework && p_asset.ends_with(".dylib")) {
  897. // For iOS we need to turn .dylib into .framework
  898. // to be able to send application to AppStore
  899. asset_path = String("dylibs").plus_file(base_dir);
  900. String file_name;
  901. if (!p_custom_file_name) {
  902. file_name = p_asset.get_basename().get_file();
  903. } else {
  904. file_name = *p_custom_file_name;
  905. }
  906. String framework_name = file_name + ".framework";
  907. asset_path = asset_path.plus_file(framework_name);
  908. destination_dir = p_out_dir.plus_file(asset_path);
  909. destination = destination_dir.plus_file(file_name);
  910. create_framework = true;
  911. } else if (p_is_framework && (p_asset.ends_with(".framework") || p_asset.ends_with(".xcframework"))) {
  912. asset_path = String("dylibs").plus_file(base_dir);
  913. String file_name;
  914. if (!p_custom_file_name) {
  915. file_name = p_asset.get_file();
  916. } else {
  917. file_name = *p_custom_file_name;
  918. }
  919. asset_path = asset_path.plus_file(file_name);
  920. destination_dir = p_out_dir.plus_file(asset_path);
  921. destination = destination_dir;
  922. } else {
  923. asset_path = base_dir;
  924. String file_name;
  925. if (!p_custom_file_name) {
  926. file_name = p_asset.get_file();
  927. } else {
  928. file_name = *p_custom_file_name;
  929. }
  930. destination_dir = p_out_dir.plus_file(asset_path);
  931. asset_path = asset_path.plus_file(file_name);
  932. destination = p_out_dir.plus_file(asset_path);
  933. }
  934. Ref<DirAccess> filesystem_da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  935. ERR_FAIL_COND_V_MSG(filesystem_da.is_null(), ERR_CANT_CREATE, "Cannot create DirAccess for path '" + p_out_dir + "'.");
  936. if (!filesystem_da->dir_exists(destination_dir)) {
  937. Error make_dir_err = filesystem_da->make_dir_recursive(destination_dir);
  938. if (make_dir_err) {
  939. return make_dir_err;
  940. }
  941. }
  942. Error err = dir_exists ? da->copy_dir(p_asset, destination) : da->copy(p_asset, destination);
  943. if (err) {
  944. return err;
  945. }
  946. IOSExportAsset exported_asset = { binary_name.plus_file(asset_path), p_is_framework, p_should_embed };
  947. r_exported_assets.push_back(exported_asset);
  948. if (create_framework) {
  949. String file_name;
  950. if (!p_custom_file_name) {
  951. file_name = p_asset.get_basename().get_file();
  952. } else {
  953. file_name = *p_custom_file_name;
  954. }
  955. String framework_name = file_name + ".framework";
  956. // Performing `install_name_tool -id @rpath/{name}.framework/{name} ./{name}` on dylib
  957. {
  958. List<String> install_name_args;
  959. install_name_args.push_back("-id");
  960. install_name_args.push_back(String("@rpath").plus_file(framework_name).plus_file(file_name));
  961. install_name_args.push_back(destination);
  962. OS::get_singleton()->execute("install_name_tool", install_name_args);
  963. }
  964. // Creating Info.plist
  965. {
  966. String info_plist_format = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
  967. "<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/PropertyList-1.0.dtd\">\n"
  968. "<plist version=\"1.0\">\n"
  969. "<dict>\n"
  970. "<key>CFBundleShortVersionString</key>\n"
  971. "<string>1.0</string>\n"
  972. "<key>CFBundleIdentifier</key>\n"
  973. "<string>com.gdnative.framework.$name</string>\n"
  974. "<key>CFBundleName</key>\n"
  975. "<string>$name</string>\n"
  976. "<key>CFBundleExecutable</key>\n"
  977. "<string>$name</string>\n"
  978. "<key>DTPlatformName</key>\n"
  979. "<string>iphoneos</string>\n"
  980. "<key>CFBundleInfoDictionaryVersion</key>\n"
  981. "<string>6.0</string>\n"
  982. "<key>CFBundleVersion</key>\n"
  983. "<string>1</string>\n"
  984. "<key>CFBundlePackageType</key>\n"
  985. "<string>FMWK</string>\n"
  986. "<key>MinimumOSVersion</key>\n"
  987. "<string>10.0</string>\n"
  988. "</dict>\n"
  989. "</plist>";
  990. String info_plist = info_plist_format.replace("$name", file_name);
  991. Ref<FileAccess> f = FileAccess::open(destination_dir.plus_file("Info.plist"), FileAccess::WRITE);
  992. if (f.is_valid()) {
  993. f->store_string(info_plist);
  994. }
  995. }
  996. }
  997. return OK;
  998. }
  999. Error EditorExportPlatformIOS::_export_additional_assets(const String &p_out_dir, const Vector<String> &p_assets, bool p_is_framework, bool p_should_embed, Vector<IOSExportAsset> &r_exported_assets) {
  1000. for (int f_idx = 0; f_idx < p_assets.size(); ++f_idx) {
  1001. String asset = p_assets[f_idx];
  1002. if (!asset.begins_with("res://")) {
  1003. // either SDK-builtin or already a part of the export template
  1004. IOSExportAsset exported_asset = { asset, p_is_framework, p_should_embed };
  1005. r_exported_assets.push_back(exported_asset);
  1006. } else {
  1007. Error err = _copy_asset(p_out_dir, asset, nullptr, p_is_framework, p_should_embed, r_exported_assets);
  1008. ERR_FAIL_COND_V(err, err);
  1009. }
  1010. }
  1011. return OK;
  1012. }
  1013. Error EditorExportPlatformIOS::_export_additional_assets(const String &p_out_dir, const Vector<SharedObject> &p_libraries, Vector<IOSExportAsset> &r_exported_assets) {
  1014. Vector<Ref<EditorExportPlugin>> export_plugins = EditorExport::get_singleton()->get_export_plugins();
  1015. for (int i = 0; i < export_plugins.size(); i++) {
  1016. Vector<String> linked_frameworks = export_plugins[i]->get_ios_frameworks();
  1017. Error err = _export_additional_assets(p_out_dir, linked_frameworks, true, false, r_exported_assets);
  1018. ERR_FAIL_COND_V(err, err);
  1019. Vector<String> embedded_frameworks = export_plugins[i]->get_ios_embedded_frameworks();
  1020. err = _export_additional_assets(p_out_dir, embedded_frameworks, true, true, r_exported_assets);
  1021. ERR_FAIL_COND_V(err, err);
  1022. Vector<String> project_static_libs = export_plugins[i]->get_ios_project_static_libs();
  1023. for (int j = 0; j < project_static_libs.size(); j++) {
  1024. project_static_libs.write[j] = project_static_libs[j].get_file(); // Only the file name as it's copied to the project
  1025. }
  1026. err = _export_additional_assets(p_out_dir, project_static_libs, true, false, r_exported_assets);
  1027. ERR_FAIL_COND_V(err, err);
  1028. Vector<String> ios_bundle_files = export_plugins[i]->get_ios_bundle_files();
  1029. err = _export_additional_assets(p_out_dir, ios_bundle_files, false, false, r_exported_assets);
  1030. ERR_FAIL_COND_V(err, err);
  1031. }
  1032. Vector<String> library_paths;
  1033. for (int i = 0; i < p_libraries.size(); ++i) {
  1034. library_paths.push_back(p_libraries[i].path);
  1035. }
  1036. Error err = _export_additional_assets(p_out_dir, library_paths, true, true, r_exported_assets);
  1037. ERR_FAIL_COND_V(err, err);
  1038. return OK;
  1039. }
  1040. Vector<String> EditorExportPlatformIOS::_get_preset_architectures(const Ref<EditorExportPreset> &p_preset) const {
  1041. Vector<ExportArchitecture> all_archs = _get_supported_architectures();
  1042. Vector<String> enabled_archs;
  1043. for (int i = 0; i < all_archs.size(); ++i) {
  1044. bool is_enabled = p_preset->get("architectures/" + all_archs[i].name);
  1045. if (is_enabled) {
  1046. enabled_archs.push_back(all_archs[i].name);
  1047. }
  1048. }
  1049. return enabled_archs;
  1050. }
  1051. Error EditorExportPlatformIOS::_export_ios_plugins(const Ref<EditorExportPreset> &p_preset, IOSConfigData &p_config_data, const String &dest_dir, Vector<IOSExportAsset> &r_exported_assets, bool p_debug) {
  1052. String plugin_definition_cpp_code;
  1053. String plugin_initialization_cpp_code;
  1054. String plugin_deinitialization_cpp_code;
  1055. Vector<String> plugin_linked_dependencies;
  1056. Vector<String> plugin_embedded_dependencies;
  1057. Vector<String> plugin_files;
  1058. Vector<PluginConfigIOS> enabled_plugins = get_enabled_plugins(p_preset);
  1059. Vector<String> added_linked_dependenciy_names;
  1060. Vector<String> added_embedded_dependenciy_names;
  1061. HashMap<String, String> plist_values;
  1062. HashSet<String> plugin_linker_flags;
  1063. Error err;
  1064. for (int i = 0; i < enabled_plugins.size(); i++) {
  1065. PluginConfigIOS plugin = enabled_plugins[i];
  1066. // Export plugin binary.
  1067. String plugin_main_binary = PluginConfigIOS::get_plugin_main_binary(plugin, p_debug);
  1068. String plugin_binary_result_file = plugin.binary.get_file();
  1069. // We shouldn't embed .xcframework that contains static libraries.
  1070. // Static libraries are not embedded anyway.
  1071. err = _copy_asset(dest_dir, plugin_main_binary, &plugin_binary_result_file, true, false, r_exported_assets);
  1072. ERR_FAIL_COND_V(err, err);
  1073. // Adding dependencies.
  1074. // Use separate container for names to check for duplicates.
  1075. for (int j = 0; j < plugin.linked_dependencies.size(); j++) {
  1076. String dependency = plugin.linked_dependencies[j];
  1077. String name = dependency.get_file();
  1078. if (added_linked_dependenciy_names.has(name)) {
  1079. continue;
  1080. }
  1081. added_linked_dependenciy_names.push_back(name);
  1082. plugin_linked_dependencies.push_back(dependency);
  1083. }
  1084. for (int j = 0; j < plugin.system_dependencies.size(); j++) {
  1085. String dependency = plugin.system_dependencies[j];
  1086. String name = dependency.get_file();
  1087. if (added_linked_dependenciy_names.has(name)) {
  1088. continue;
  1089. }
  1090. added_linked_dependenciy_names.push_back(name);
  1091. plugin_linked_dependencies.push_back(dependency);
  1092. }
  1093. for (int j = 0; j < plugin.embedded_dependencies.size(); j++) {
  1094. String dependency = plugin.embedded_dependencies[j];
  1095. String name = dependency.get_file();
  1096. if (added_embedded_dependenciy_names.has(name)) {
  1097. continue;
  1098. }
  1099. added_embedded_dependenciy_names.push_back(name);
  1100. plugin_embedded_dependencies.push_back(dependency);
  1101. }
  1102. plugin_files.append_array(plugin.files_to_copy);
  1103. // Capabilities
  1104. // Also checking for duplicates.
  1105. for (int j = 0; j < plugin.capabilities.size(); j++) {
  1106. String capability = plugin.capabilities[j];
  1107. if (p_config_data.capabilities.has(capability)) {
  1108. continue;
  1109. }
  1110. p_config_data.capabilities.push_back(capability);
  1111. }
  1112. // Linker flags
  1113. // Checking duplicates
  1114. for (int j = 0; j < plugin.linker_flags.size(); j++) {
  1115. String linker_flag = plugin.linker_flags[j];
  1116. plugin_linker_flags.insert(linker_flag);
  1117. }
  1118. // Plist
  1119. // Using hash map container to remove duplicates
  1120. for (const KeyValue<String, PluginConfigIOS::PlistItem> &E : plugin.plist) {
  1121. String key = E.key;
  1122. const PluginConfigIOS::PlistItem &item = E.value;
  1123. String value;
  1124. switch (item.type) {
  1125. case PluginConfigIOS::PlistItemType::STRING_INPUT: {
  1126. String preset_name = "plugins_plist/" + key;
  1127. String input_value = p_preset->get(preset_name);
  1128. value = "<string>" + input_value + "</string>";
  1129. } break;
  1130. default:
  1131. value = item.value;
  1132. break;
  1133. }
  1134. if (key.is_empty() || value.is_empty()) {
  1135. continue;
  1136. }
  1137. String plist_key = "<key>" + key + "</key>";
  1138. plist_values[plist_key] = value;
  1139. }
  1140. // CPP Code
  1141. String definition_comment = "// Plugin: " + plugin.name + "\n";
  1142. String initialization_method = plugin.initialization_method + "();\n";
  1143. String deinitialization_method = plugin.deinitialization_method + "();\n";
  1144. plugin_definition_cpp_code += definition_comment +
  1145. "extern void " + initialization_method +
  1146. "extern void " + deinitialization_method + "\n";
  1147. plugin_initialization_cpp_code += "\t" + initialization_method;
  1148. plugin_deinitialization_cpp_code += "\t" + deinitialization_method;
  1149. if (plugin.use_swift_runtime) {
  1150. p_config_data.use_swift_runtime = true;
  1151. }
  1152. }
  1153. // Updating `Info.plist`
  1154. {
  1155. for (const KeyValue<String, String> &E : plist_values) {
  1156. String key = E.key;
  1157. String value = E.value;
  1158. if (key.is_empty() || value.is_empty()) {
  1159. continue;
  1160. }
  1161. p_config_data.plist_content += key + value + "\n";
  1162. }
  1163. }
  1164. // Export files
  1165. {
  1166. // Export linked plugin dependency
  1167. err = _export_additional_assets(dest_dir, plugin_linked_dependencies, true, false, r_exported_assets);
  1168. ERR_FAIL_COND_V(err, err);
  1169. // Export embedded plugin dependency
  1170. err = _export_additional_assets(dest_dir, plugin_embedded_dependencies, true, true, r_exported_assets);
  1171. ERR_FAIL_COND_V(err, err);
  1172. // Export plugin files
  1173. err = _export_additional_assets(dest_dir, plugin_files, false, false, r_exported_assets);
  1174. ERR_FAIL_COND_V(err, err);
  1175. }
  1176. // Update CPP
  1177. {
  1178. Dictionary plugin_format;
  1179. plugin_format["definition"] = plugin_definition_cpp_code;
  1180. plugin_format["initialization"] = plugin_initialization_cpp_code;
  1181. plugin_format["deinitialization"] = plugin_deinitialization_cpp_code;
  1182. String plugin_cpp_code = "\n// Godot Plugins\n"
  1183. "void godot_ios_plugins_initialize();\n"
  1184. "void godot_ios_plugins_deinitialize();\n"
  1185. "// Exported Plugins\n\n"
  1186. "$definition"
  1187. "// Use Plugins\n"
  1188. "void godot_ios_plugins_initialize() {\n"
  1189. "$initialization"
  1190. "}\n\n"
  1191. "void godot_ios_plugins_deinitialize() {\n"
  1192. "$deinitialization"
  1193. "}\n";
  1194. p_config_data.cpp_code += plugin_cpp_code.format(plugin_format, "$_");
  1195. }
  1196. // Update Linker Flag Values
  1197. {
  1198. String result_linker_flags = " ";
  1199. for (const String &E : plugin_linker_flags) {
  1200. const String &flag = E;
  1201. if (flag.length() == 0) {
  1202. continue;
  1203. }
  1204. if (result_linker_flags.length() > 0) {
  1205. result_linker_flags += ' ';
  1206. }
  1207. result_linker_flags += flag;
  1208. }
  1209. result_linker_flags = result_linker_flags.replace("\"", "\\\"");
  1210. p_config_data.linker_flags += result_linker_flags;
  1211. }
  1212. return OK;
  1213. }
  1214. Error EditorExportPlatformIOS::export_project(const Ref<EditorExportPreset> &p_preset, bool p_debug, const String &p_path, int p_flags) {
  1215. ExportNotifier notifier(*this, p_preset, p_debug, p_path, p_flags);
  1216. String src_pkg_name;
  1217. String dest_dir = p_path.get_base_dir() + "/";
  1218. String binary_name = p_path.get_file().get_basename();
  1219. EditorProgress ep("export", "Exporting for iOS", 5, true);
  1220. String team_id = p_preset->get("application/app_store_team_id");
  1221. ERR_FAIL_COND_V_MSG(team_id.length() == 0, ERR_CANT_OPEN, "App Store Team ID not specified - cannot configure the project.");
  1222. if (p_debug) {
  1223. src_pkg_name = p_preset->get("custom_template/debug");
  1224. } else {
  1225. src_pkg_name = p_preset->get("custom_template/release");
  1226. }
  1227. if (src_pkg_name.is_empty()) {
  1228. String err;
  1229. src_pkg_name = find_export_template("ios.zip", &err);
  1230. if (src_pkg_name.is_empty()) {
  1231. add_message(EXPORT_MESSAGE_ERROR, TTR("Prepare Templates"), TTR("Export template not found."));
  1232. return ERR_FILE_NOT_FOUND;
  1233. }
  1234. }
  1235. if (!DirAccess::exists(dest_dir)) {
  1236. return ERR_FILE_BAD_PATH;
  1237. }
  1238. {
  1239. Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  1240. if (da.is_valid()) {
  1241. String current_dir = da->get_current_dir();
  1242. // remove leftovers from last export so they don't interfere
  1243. // in case some files are no longer needed
  1244. if (da->change_dir(dest_dir + binary_name + ".xcodeproj") == OK) {
  1245. da->erase_contents_recursive();
  1246. }
  1247. if (da->change_dir(dest_dir + binary_name) == OK) {
  1248. da->erase_contents_recursive();
  1249. }
  1250. da->change_dir(current_dir);
  1251. if (!da->dir_exists(dest_dir + binary_name)) {
  1252. Error err = da->make_dir(dest_dir + binary_name);
  1253. if (err) {
  1254. return err;
  1255. }
  1256. }
  1257. }
  1258. }
  1259. if (ep.step("Making .pck", 0)) {
  1260. return ERR_SKIP;
  1261. }
  1262. String pack_path = dest_dir + binary_name + ".pck";
  1263. Vector<SharedObject> libraries;
  1264. Error err = save_pack(p_preset, p_debug, pack_path, &libraries);
  1265. if (err) {
  1266. return err;
  1267. }
  1268. if (ep.step("Extracting and configuring Xcode project", 1)) {
  1269. return ERR_SKIP;
  1270. }
  1271. String library_to_use = "libgodot.ios." + String(p_debug ? "debug" : "release") + ".xcframework";
  1272. print_line("Static framework: " + library_to_use);
  1273. String pkg_name;
  1274. if (String(ProjectSettings::get_singleton()->get("application/config/name")) != "") {
  1275. pkg_name = String(ProjectSettings::get_singleton()->get("application/config/name"));
  1276. } else {
  1277. pkg_name = "Unnamed";
  1278. }
  1279. bool found_library = false;
  1280. const String project_file = "godot_ios.xcodeproj/project.pbxproj";
  1281. HashSet<String> files_to_parse;
  1282. files_to_parse.insert("godot_ios/godot_ios-Info.plist");
  1283. files_to_parse.insert(project_file);
  1284. files_to_parse.insert("godot_ios/export_options.plist");
  1285. files_to_parse.insert("godot_ios/dummy.cpp");
  1286. files_to_parse.insert("godot_ios.xcodeproj/project.xcworkspace/contents.xcworkspacedata");
  1287. files_to_parse.insert("godot_ios.xcodeproj/xcshareddata/xcschemes/godot_ios.xcscheme");
  1288. files_to_parse.insert("godot_ios/godot_ios.entitlements");
  1289. files_to_parse.insert("godot_ios/Launch Screen.storyboard");
  1290. IOSConfigData config_data = {
  1291. pkg_name,
  1292. binary_name,
  1293. _get_additional_plist_content(),
  1294. String(" ").join(_get_preset_architectures(p_preset)),
  1295. _get_linker_flags(),
  1296. _get_cpp_code(),
  1297. "",
  1298. "",
  1299. "",
  1300. "",
  1301. Vector<String>(),
  1302. false
  1303. };
  1304. Vector<IOSExportAsset> assets;
  1305. Ref<DirAccess> tmp_app_path = DirAccess::create_for_path(dest_dir);
  1306. ERR_FAIL_COND_V(tmp_app_path.is_null(), ERR_CANT_CREATE);
  1307. print_line("Unzipping...");
  1308. Ref<FileAccess> io_fa;
  1309. zlib_filefunc_def io = zipio_create_io(&io_fa);
  1310. unzFile src_pkg_zip = unzOpen2(src_pkg_name.utf8().get_data(), &io);
  1311. if (!src_pkg_zip) {
  1312. add_message(EXPORT_MESSAGE_ERROR, TTR("Prepare Templates"), TTR("Could not open export template (not a zip file?): \"%s\".", src_pkg_name));
  1313. return ERR_CANT_OPEN;
  1314. }
  1315. err = _export_ios_plugins(p_preset, config_data, dest_dir + binary_name, assets, p_debug);
  1316. ERR_FAIL_COND_V(err, err);
  1317. //export rest of the files
  1318. int ret = unzGoToFirstFile(src_pkg_zip);
  1319. Vector<uint8_t> project_file_data;
  1320. while (ret == UNZ_OK) {
  1321. #if defined(MACOS_ENABLED) || defined(X11_ENABLED)
  1322. bool is_execute = false;
  1323. #endif
  1324. //get filename
  1325. unz_file_info info;
  1326. char fname[16384];
  1327. ret = unzGetCurrentFileInfo(src_pkg_zip, &info, fname, 16384, nullptr, 0, nullptr, 0);
  1328. if (ret != UNZ_OK) {
  1329. break;
  1330. }
  1331. String file = String::utf8(fname);
  1332. print_line("READ: " + file);
  1333. Vector<uint8_t> data;
  1334. data.resize(info.uncompressed_size);
  1335. //read
  1336. unzOpenCurrentFile(src_pkg_zip);
  1337. unzReadCurrentFile(src_pkg_zip, data.ptrw(), data.size());
  1338. unzCloseCurrentFile(src_pkg_zip);
  1339. //write
  1340. if (files_to_parse.has(file)) {
  1341. _fix_config_file(p_preset, data, config_data, p_debug);
  1342. } else if (file.begins_with("libgodot.ios")) {
  1343. if (!file.begins_with(library_to_use) || file.ends_with(String("/empty"))) {
  1344. ret = unzGoToNextFile(src_pkg_zip);
  1345. continue; //ignore!
  1346. }
  1347. found_library = true;
  1348. #if defined(MACOS_ENABLED) || defined(X11_ENABLED)
  1349. is_execute = true;
  1350. #endif
  1351. file = file.replace(library_to_use, binary_name + ".xcframework");
  1352. }
  1353. if (file == project_file) {
  1354. project_file_data = data;
  1355. }
  1356. ///@TODO need to parse logo files
  1357. if (data.size() > 0) {
  1358. file = file.replace("godot_ios", binary_name);
  1359. print_line("ADDING: " + file + " size: " + itos(data.size()));
  1360. /* write it into our folder structure */
  1361. file = dest_dir + file;
  1362. /* make sure this folder exists */
  1363. String dir_name = file.get_base_dir();
  1364. if (!tmp_app_path->dir_exists(dir_name)) {
  1365. print_line("Creating " + dir_name);
  1366. Error dir_err = tmp_app_path->make_dir_recursive(dir_name);
  1367. if (dir_err) {
  1368. ERR_PRINT("Can't create '" + dir_name + "'.");
  1369. unzClose(src_pkg_zip);
  1370. return ERR_CANT_CREATE;
  1371. }
  1372. }
  1373. /* write the file */
  1374. {
  1375. Ref<FileAccess> f = FileAccess::open(file, FileAccess::WRITE);
  1376. if (f.is_null()) {
  1377. ERR_PRINT("Can't write '" + file + "'.");
  1378. unzClose(src_pkg_zip);
  1379. return ERR_CANT_CREATE;
  1380. };
  1381. f->store_buffer(data.ptr(), data.size());
  1382. }
  1383. #if defined(MACOS_ENABLED) || defined(X11_ENABLED)
  1384. if (is_execute) {
  1385. // we need execute rights on this file
  1386. chmod(file.utf8().get_data(), 0755);
  1387. }
  1388. #endif
  1389. }
  1390. ret = unzGoToNextFile(src_pkg_zip);
  1391. }
  1392. /* we're done with our source zip */
  1393. unzClose(src_pkg_zip);
  1394. if (!found_library) {
  1395. ERR_PRINT("Requested template library '" + library_to_use + "' not found. It might be missing from your template archive.");
  1396. return ERR_FILE_NOT_FOUND;
  1397. }
  1398. Dictionary appnames = ProjectSettings::get_singleton()->get("application/config/name_localized");
  1399. Dictionary camera_usage_descriptions = p_preset->get("privacy/camera_usage_description_localized");
  1400. Dictionary microphone_usage_descriptions = p_preset->get("privacy/microphone_usage_description_localized");
  1401. Dictionary photolibrary_usage_descriptions = p_preset->get("privacy/photolibrary_usage_description_localized");
  1402. Vector<String> translations = ProjectSettings::get_singleton()->get("internationalization/locale/translations");
  1403. if (translations.size() > 0) {
  1404. {
  1405. String fname = dest_dir + binary_name + "/en.lproj";
  1406. tmp_app_path->make_dir_recursive(fname);
  1407. Ref<FileAccess> f = FileAccess::open(fname + "/InfoPlist.strings", FileAccess::WRITE);
  1408. f->store_line("/* Localized versions of Info.plist keys */");
  1409. f->store_line("");
  1410. f->store_line("CFBundleDisplayName = \"" + ProjectSettings::get_singleton()->get("application/config/name").operator String() + "\";");
  1411. f->store_line("NSCameraUsageDescription = \"" + p_preset->get("privacy/camera_usage_description").operator String() + "\";");
  1412. f->store_line("NSMicrophoneUsageDescription = \"" + p_preset->get("privacy/microphone_usage_description").operator String() + "\";");
  1413. f->store_line("NSPhotoLibraryUsageDescription = \"" + p_preset->get("privacy/photolibrary_usage_description").operator String() + "\";");
  1414. }
  1415. for (const String &E : translations) {
  1416. Ref<Translation> tr = ResourceLoader::load(E);
  1417. if (tr.is_valid()) {
  1418. String lang = tr->get_locale();
  1419. String fname = dest_dir + binary_name + "/" + lang + ".lproj";
  1420. tmp_app_path->make_dir_recursive(fname);
  1421. Ref<FileAccess> f = FileAccess::open(fname + "/InfoPlist.strings", FileAccess::WRITE);
  1422. f->store_line("/* Localized versions of Info.plist keys */");
  1423. f->store_line("");
  1424. if (appnames.has(lang)) {
  1425. f->store_line("CFBundleDisplayName = \"" + appnames[lang].operator String() + "\";");
  1426. }
  1427. if (camera_usage_descriptions.has(lang)) {
  1428. f->store_line("NSCameraUsageDescription = \"" + camera_usage_descriptions[lang].operator String() + "\";");
  1429. }
  1430. if (microphone_usage_descriptions.has(lang)) {
  1431. f->store_line("NSMicrophoneUsageDescription = \"" + microphone_usage_descriptions[lang].operator String() + "\";");
  1432. }
  1433. if (photolibrary_usage_descriptions.has(lang)) {
  1434. f->store_line("NSPhotoLibraryUsageDescription = \"" + photolibrary_usage_descriptions[lang].operator String() + "\";");
  1435. }
  1436. }
  1437. }
  1438. }
  1439. // Copy project static libs to the project
  1440. Vector<Ref<EditorExportPlugin>> export_plugins = EditorExport::get_singleton()->get_export_plugins();
  1441. for (int i = 0; i < export_plugins.size(); i++) {
  1442. Vector<String> project_static_libs = export_plugins[i]->get_ios_project_static_libs();
  1443. for (int j = 0; j < project_static_libs.size(); j++) {
  1444. const String &static_lib_path = project_static_libs[j];
  1445. String dest_lib_file_path = dest_dir + static_lib_path.get_file();
  1446. Error lib_copy_err = tmp_app_path->copy(static_lib_path, dest_lib_file_path);
  1447. if (lib_copy_err != OK) {
  1448. ERR_PRINT("Can't copy '" + static_lib_path + "'.");
  1449. return lib_copy_err;
  1450. }
  1451. }
  1452. }
  1453. String iconset_dir = dest_dir + binary_name + "/Images.xcassets/AppIcon.appiconset/";
  1454. err = OK;
  1455. if (!tmp_app_path->dir_exists(iconset_dir)) {
  1456. err = tmp_app_path->make_dir_recursive(iconset_dir);
  1457. }
  1458. if (err) {
  1459. return err;
  1460. }
  1461. err = _export_icons(p_preset, iconset_dir);
  1462. if (err) {
  1463. return err;
  1464. }
  1465. {
  1466. bool use_storyboard = p_preset->get("storyboard/use_launch_screen_storyboard");
  1467. String launch_image_path = dest_dir + binary_name + "/Images.xcassets/LaunchImage.launchimage/";
  1468. String splash_image_path = dest_dir + binary_name + "/Images.xcassets/SplashImage.imageset/";
  1469. Ref<DirAccess> launch_screen_da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
  1470. if (launch_screen_da.is_null()) {
  1471. return ERR_CANT_CREATE;
  1472. }
  1473. if (use_storyboard) {
  1474. print_line("Using Launch Storyboard");
  1475. if (launch_screen_da->change_dir(launch_image_path) == OK) {
  1476. launch_screen_da->erase_contents_recursive();
  1477. launch_screen_da->remove(launch_image_path);
  1478. }
  1479. err = _export_loading_screen_file(p_preset, splash_image_path);
  1480. } else {
  1481. print_line("Using Launch Images");
  1482. const String launch_screen_path = dest_dir + binary_name + "/Launch Screen.storyboard";
  1483. launch_screen_da->remove(launch_screen_path);
  1484. if (launch_screen_da->change_dir(splash_image_path) == OK) {
  1485. launch_screen_da->erase_contents_recursive();
  1486. launch_screen_da->remove(splash_image_path);
  1487. }
  1488. err = _export_loading_screen_images(p_preset, launch_image_path);
  1489. }
  1490. }
  1491. if (err) {
  1492. return err;
  1493. }
  1494. print_line("Exporting additional assets");
  1495. _export_additional_assets(dest_dir + binary_name, libraries, assets);
  1496. _add_assets_to_project(p_preset, project_file_data, assets);
  1497. String project_file_name = dest_dir + binary_name + ".xcodeproj/project.pbxproj";
  1498. {
  1499. Ref<FileAccess> f = FileAccess::open(project_file_name, FileAccess::WRITE);
  1500. if (f.is_null()) {
  1501. ERR_PRINT("Can't write '" + project_file_name + "'.");
  1502. return ERR_CANT_CREATE;
  1503. };
  1504. f->store_buffer(project_file_data.ptr(), project_file_data.size());
  1505. }
  1506. #ifdef MACOS_ENABLED
  1507. {
  1508. if (ep.step("Code-signing dylibs", 2)) {
  1509. return ERR_SKIP;
  1510. }
  1511. Ref<DirAccess> dylibs_dir = DirAccess::open(dest_dir + binary_name + "/dylibs");
  1512. ERR_FAIL_COND_V(dylibs_dir.is_null(), ERR_CANT_OPEN);
  1513. CodesignData codesign_data(p_preset, p_debug);
  1514. err = _walk_dir_recursive(dylibs_dir, _codesign, &codesign_data);
  1515. ERR_FAIL_COND_V(err, err);
  1516. }
  1517. if (ep.step("Making .xcarchive", 3)) {
  1518. return ERR_SKIP;
  1519. }
  1520. String archive_path = p_path.get_basename() + ".xcarchive";
  1521. List<String> archive_args;
  1522. archive_args.push_back("-project");
  1523. archive_args.push_back(dest_dir + binary_name + ".xcodeproj");
  1524. archive_args.push_back("-scheme");
  1525. archive_args.push_back(binary_name);
  1526. archive_args.push_back("-sdk");
  1527. archive_args.push_back("iphoneos");
  1528. archive_args.push_back("-configuration");
  1529. archive_args.push_back(p_debug ? "Debug" : "Release");
  1530. archive_args.push_back("-destination");
  1531. archive_args.push_back("generic/platform=iOS");
  1532. archive_args.push_back("archive");
  1533. archive_args.push_back("-allowProvisioningUpdates");
  1534. archive_args.push_back("-archivePath");
  1535. archive_args.push_back(archive_path);
  1536. String archive_str;
  1537. err = OS::get_singleton()->execute("xcodebuild", archive_args, &archive_str, nullptr, true);
  1538. ERR_FAIL_COND_V(err, err);
  1539. print_line("xcodebuild (.xcarchive):\n" + archive_str);
  1540. if (ep.step("Making .ipa", 4)) {
  1541. return ERR_SKIP;
  1542. }
  1543. List<String> export_args;
  1544. export_args.push_back("-exportArchive");
  1545. export_args.push_back("-archivePath");
  1546. export_args.push_back(archive_path);
  1547. export_args.push_back("-exportOptionsPlist");
  1548. export_args.push_back(dest_dir + binary_name + "/export_options.plist");
  1549. export_args.push_back("-allowProvisioningUpdates");
  1550. export_args.push_back("-exportPath");
  1551. export_args.push_back(dest_dir);
  1552. String export_str;
  1553. err = OS::get_singleton()->execute("xcodebuild", export_args, &export_str, nullptr, true);
  1554. ERR_FAIL_COND_V(err, err);
  1555. print_line("xcodebuild (.ipa):\n" + export_str);
  1556. #else
  1557. print_line(".ipa can only be built on macOS. Leaving Xcode project without building the package.");
  1558. #endif
  1559. return OK;
  1560. }
  1561. bool EditorExportPlatformIOS::can_export(const Ref<EditorExportPreset> &p_preset, String &r_error, bool &r_missing_templates) const {
  1562. String err;
  1563. bool valid = false;
  1564. // Look for export templates (first official, and if defined custom templates).
  1565. bool dvalid = exists_export_template("ios.zip", &err);
  1566. bool rvalid = dvalid; // Both in the same ZIP.
  1567. if (p_preset->get("custom_template/debug") != "") {
  1568. dvalid = FileAccess::exists(p_preset->get("custom_template/debug"));
  1569. if (!dvalid) {
  1570. err += TTR("Custom debug template not found.") + "\n";
  1571. }
  1572. }
  1573. if (p_preset->get("custom_template/release") != "") {
  1574. rvalid = FileAccess::exists(p_preset->get("custom_template/release"));
  1575. if (!rvalid) {
  1576. err += TTR("Custom release template not found.") + "\n";
  1577. }
  1578. }
  1579. valid = dvalid || rvalid;
  1580. r_missing_templates = !valid;
  1581. // Validate the rest of the configuration.
  1582. String team_id = p_preset->get("application/app_store_team_id");
  1583. if (team_id.length() == 0) {
  1584. err += TTR("App Store Team ID not specified - cannot configure the project.") + "\n";
  1585. valid = false;
  1586. }
  1587. String identifier = p_preset->get("application/bundle_identifier");
  1588. String pn_err;
  1589. if (!is_package_name_valid(identifier, &pn_err)) {
  1590. err += TTR("Invalid Identifier:") + " " + pn_err + "\n";
  1591. valid = false;
  1592. }
  1593. const String etc_error = test_etc2();
  1594. if (!etc_error.is_empty()) {
  1595. valid = false;
  1596. err += etc_error;
  1597. }
  1598. if (!err.is_empty()) {
  1599. r_error = err;
  1600. }
  1601. return valid;
  1602. }
  1603. EditorExportPlatformIOS::EditorExportPlatformIOS() {
  1604. logo = ImageTexture::create_from_image(memnew(Image(_ios_logo)));
  1605. plugins_changed.set();
  1606. check_for_changes_thread.start(_check_for_changes_poll_thread, this);
  1607. }
  1608. EditorExportPlatformIOS::~EditorExportPlatformIOS() {
  1609. quit_request.set();
  1610. check_for_changes_thread.wait_to_finish();
  1611. }