export_plugin.cpp 73 KB

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