/**************************************************************************/ /* export_plugin.cpp */ /**************************************************************************/ /* This file is part of: */ /* GODOT ENGINE */ /* https://godotengine.org */ /**************************************************************************/ /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */ /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */ /* */ /* Permission is hereby granted, free of charge, to any person obtaining */ /* a copy of this software and associated documentation files (the */ /* "Software"), to deal in the Software without restriction, including */ /* without limitation the rights to use, copy, modify, merge, publish, */ /* distribute, sublicense, and/or sell copies of the Software, and to */ /* permit persons to whom the Software is furnished to do so, subject to */ /* the following conditions: */ /* */ /* The above copyright notice and this permission notice shall be */ /* included in all copies or substantial portions of the Software. */ /* */ /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */ /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */ /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */ /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */ /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */ /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */ /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ /**************************************************************************/ #include "export_plugin.h" #include "logo_svg.gen.h" #include "run_icon_svg.gen.h" #include "core/io/json.h" #include "core/string/translation.h" #include "editor/editor_node.h" #include "editor/editor_paths.h" #include "editor/editor_scale.h" #include "editor/export/editor_export.h" #include "editor/plugins/script_editor_plugin.h" #include "modules/modules_enabled.gen.h" // For mono and svg. #ifdef MODULE_SVG_ENABLED #include "modules/svg/image_loader_svg.h" #endif void EditorExportPlatformIOS::get_preset_features(const Ref &p_preset, List *r_features) const { // Vulkan and OpenGL ES 3.0 both mandate ETC2 support. r_features->push_back("etc2"); r_features->push_back("astc"); Vector architectures = _get_preset_architectures(p_preset); for (int i = 0; i < architectures.size(); ++i) { r_features->push_back(architectures[i]); } } Vector EditorExportPlatformIOS::_get_supported_architectures() const { Vector archs; archs.push_back(ExportArchitecture("arm64", true)); return archs; } struct IconInfo { const char *preset_key; const char *idiom; const char *export_name; const char *actual_size_side; const char *scale; const char *unscaled_size; const bool force_opaque; }; static const IconInfo icon_infos[] = { // Home screen on iPhone { PNAME("icons/iphone_120x120"), "iphone", "Icon-120.png", "120", "2x", "60x60", false }, { PNAME("icons/iphone_120x120"), "iphone", "Icon-120.png", "120", "3x", "40x40", false }, { PNAME("icons/iphone_180x180"), "iphone", "Icon-180.png", "180", "3x", "60x60", false }, // Home screen on iPad { PNAME("icons/ipad_76x76"), "ipad", "Icon-76.png", "76", "1x", "76x76", false }, { PNAME("icons/ipad_152x152"), "ipad", "Icon-152.png", "152", "2x", "76x76", false }, { PNAME("icons/ipad_167x167"), "ipad", "Icon-167.png", "167", "2x", "83.5x83.5", false }, // App Store { PNAME("icons/app_store_1024x1024"), "ios-marketing", "Icon-1024.png", "1024", "1x", "1024x1024", true }, // Spotlight { PNAME("icons/spotlight_40x40"), "ipad", "Icon-40.png", "40", "1x", "40x40", false }, { PNAME("icons/spotlight_80x80"), "iphone", "Icon-80.png", "80", "2x", "40x40", false }, { PNAME("icons/spotlight_80x80"), "ipad", "Icon-80.png", "80", "2x", "40x40", false }, // Settings { PNAME("icons/settings_58x58"), "iphone", "Icon-58.png", "58", "2x", "29x29", false }, { PNAME("icons/settings_58x58"), "ipad", "Icon-58.png", "58", "2x", "29x29", false }, { PNAME("icons/settings_87x87"), "iphone", "Icon-87.png", "87", "3x", "29x29", false }, // Notification { PNAME("icons/notification_40x40"), "iphone", "Icon-40.png", "40", "2x", "20x20", false }, { PNAME("icons/notification_40x40"), "ipad", "Icon-40.png", "40", "2x", "20x20", false }, { PNAME("icons/notification_60x60"), "iphone", "Icon-60.png", "60", "3x", "20x20", false } }; struct LoadingScreenInfo { const char *preset_key; const char *export_name; int width = 0; int height = 0; bool rotate = false; }; static const LoadingScreenInfo loading_screen_infos[] = { { PNAME("landscape_launch_screens/iphone_2436x1125"), "Default-Landscape-X.png", 2436, 1125, false }, { PNAME("landscape_launch_screens/iphone_2208x1242"), "Default-Landscape-736h@3x.png", 2208, 1242, false }, { PNAME("landscape_launch_screens/ipad_1024x768"), "Default-Landscape.png", 1024, 768, false }, { PNAME("landscape_launch_screens/ipad_2048x1536"), "Default-Landscape@2x.png", 2048, 1536, false }, { PNAME("portrait_launch_screens/iphone_640x960"), "Default-480h@2x.png", 640, 960, false }, { PNAME("portrait_launch_screens/iphone_640x1136"), "Default-568h@2x.png", 640, 1136, false }, { PNAME("portrait_launch_screens/iphone_750x1334"), "Default-667h@2x.png", 750, 1334, false }, { PNAME("portrait_launch_screens/iphone_1125x2436"), "Default-Portrait-X.png", 1125, 2436, false }, { PNAME("portrait_launch_screens/ipad_768x1024"), "Default-Portrait.png", 768, 1024, false }, { PNAME("portrait_launch_screens/ipad_1536x2048"), "Default-Portrait@2x.png", 1536, 2048, false }, { PNAME("portrait_launch_screens/iphone_1242x2208"), "Default-Portrait-736h@3x.png", 1242, 2208, false } }; String EditorExportPlatformIOS::get_export_option_warning(const EditorExportPreset *p_preset, const StringName &p_name) const { if (p_preset) { if (p_name == "application/app_store_team_id") { String team_id = p_preset->get("application/app_store_team_id"); if (team_id.is_empty()) { return TTR("App Store Team ID not specified.") + "\n"; } } else if (p_name == "application/bundle_identifier") { String identifier = p_preset->get("application/bundle_identifier"); String pn_err; if (!is_package_name_valid(identifier, &pn_err)) { return TTR("Invalid Identifier:") + " " + pn_err; } } } return String(); } bool EditorExportPlatformIOS::get_export_option_visibility(const EditorExportPreset *p_preset, const String &p_option) const { if (p_preset) { bool sb = p_preset->get("storyboard/use_launch_screen_storyboard"); if (!sb && p_option != "storyboard/use_launch_screen_storyboard" && p_option.begins_with("storyboard/")) { return false; } } return true; } void EditorExportPlatformIOS::get_export_options(List *r_options) const { r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "custom_template/debug", PROPERTY_HINT_GLOBAL_FILE, "*.zip"), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "custom_template/release", PROPERTY_HINT_GLOBAL_FILE, "*.zip"), "")); Vector architectures = _get_supported_architectures(); for (int i = 0; i < architectures.size(); ++i) { r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, vformat("%s/%s", PNAME("architectures"), architectures[i].name)), architectures[i].is_default)); } r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/app_store_team_id"), "", false, true)); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/provisioning_profile_uuid_debug", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_SECRET), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/code_sign_identity_debug", PROPERTY_HINT_PLACEHOLDER_TEXT, "iPhone Developer"), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "application/export_method_debug", PROPERTY_HINT_ENUM, "App Store,Development,Ad-Hoc,Enterprise"), 1)); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/provisioning_profile_uuid_release", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_SECRET), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/code_sign_identity_release", PROPERTY_HINT_PLACEHOLDER_TEXT, "iPhone Distribution"), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "application/export_method_release", PROPERTY_HINT_ENUM, "App Store,Development,Ad-Hoc,Enterprise"), 0)); r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "application/targeted_device_family", PROPERTY_HINT_ENUM, "iPhone,iPad,iPhone & iPad"), 2)); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/bundle_identifier", PROPERTY_HINT_PLACEHOLDER_TEXT, "com.example.game"), "", false, true)); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/signature"), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/short_version"), "1.0")); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "application/version", PROPERTY_HINT_PLACEHOLDER_TEXT, "Leave empty to use project version"), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "application/icon_interpolation", PROPERTY_HINT_ENUM, "Nearest neighbor,Bilinear,Cubic,Trilinear,Lanczos"), 4)); r_options->push_back(ExportOption(PropertyInfo(Variant::INT, "application/launch_screens_interpolation", PROPERTY_HINT_ENUM, "Nearest neighbor,Bilinear,Cubic,Trilinear,Lanczos"), 4)); r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "application/export_project_only"), false)); Vector found_plugins = get_plugins(); for (int i = 0; i < found_plugins.size(); i++) { r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, vformat("%s/%s", PNAME("plugins"), found_plugins[i].name)), false)); } HashSet plist_keys; for (int i = 0; i < found_plugins.size(); i++) { // Editable plugin plist values PluginConfigIOS plugin = found_plugins[i]; for (const KeyValue &E : plugin.plist) { switch (E.value.type) { case PluginConfigIOS::PlistItemType::STRING_INPUT: { String preset_name = "plugins_plist/" + E.key; if (!plist_keys.has(preset_name)) { r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, preset_name), E.value.value)); plist_keys.insert(preset_name); } } break; default: continue; } } } plugins_changed.clear(); plugins = found_plugins; r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "capabilities/access_wifi"), false)); r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "capabilities/push_notifications"), false)); r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "user_data/accessible_from_files_app"), false)); r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "user_data/accessible_from_itunes_sharing"), false)); 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"), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::DICTIONARY, "privacy/camera_usage_description_localized", PROPERTY_HINT_LOCALIZABLE_STRING), Dictionary())); 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"), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::DICTIONARY, "privacy/microphone_usage_description_localized", PROPERTY_HINT_LOCALIZABLE_STRING), Dictionary())); 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"), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::DICTIONARY, "privacy/photolibrary_usage_description_localized", PROPERTY_HINT_LOCALIZABLE_STRING), Dictionary())); HashSet used_names; for (uint64_t i = 0; i < sizeof(icon_infos) / sizeof(icon_infos[0]); ++i) { if (!used_names.has(icon_infos[i].preset_key)) { used_names.insert(icon_infos[i].preset_key); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, icon_infos[i].preset_key, PROPERTY_HINT_FILE, "*.png,*.jpg,*.jpeg"), "")); } } r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "storyboard/use_launch_screen_storyboard"), false, true)); 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)); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "storyboard/custom_image@2x", PROPERTY_HINT_FILE, "*.png,*.jpg,*.jpeg"), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, "storyboard/custom_image@3x", PROPERTY_HINT_FILE, "*.png,*.jpg,*.jpeg"), "")); r_options->push_back(ExportOption(PropertyInfo(Variant::BOOL, "storyboard/use_custom_bg_color"), false)); r_options->push_back(ExportOption(PropertyInfo(Variant::COLOR, "storyboard/custom_bg_color"), Color())); for (uint64_t i = 0; i < sizeof(loading_screen_infos) / sizeof(loading_screen_infos[0]); ++i) { r_options->push_back(ExportOption(PropertyInfo(Variant::STRING, loading_screen_infos[i].preset_key, PROPERTY_HINT_FILE, "*.png,*.jpg,*.jpeg"), "")); } } void EditorExportPlatformIOS::_fix_config_file(const Ref &p_preset, Vector &pfile, const IOSConfigData &p_config, bool p_debug) { static const String export_method_string[] = { "app-store", "development", "ad-hoc", "enterprise" }; static const String storyboard_image_scale_mode[] = { "center", "scaleAspectFit", "scaleAspectFill", "scaleToFill" }; 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"); 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"); bool dbg_manual = !p_preset->get_or_env("application/provisioning_profile_uuid_debug", ENV_IOS_PROFILE_UUID_DEBUG).operator String().is_empty() || (dbg_sign_id != "iPhone Developer"); bool rel_manual = !p_preset->get_or_env("application/provisioning_profile_uuid_release", ENV_IOS_PROFILE_UUID_RELEASE).operator String().is_empty() || (rel_sign_id != "iPhone Distribution"); String str; String strnew; str.parse_utf8((const char *)pfile.ptr(), pfile.size()); Vector lines = str.split("\n"); for (int i = 0; i < lines.size(); i++) { if (lines[i].find("$binary") != -1) { strnew += lines[i].replace("$binary", p_config.binary_name) + "\n"; } else if (lines[i].find("$modules_buildfile") != -1) { strnew += lines[i].replace("$modules_buildfile", p_config.modules_buildfile) + "\n"; } else if (lines[i].find("$modules_fileref") != -1) { strnew += lines[i].replace("$modules_fileref", p_config.modules_fileref) + "\n"; } else if (lines[i].find("$modules_buildphase") != -1) { strnew += lines[i].replace("$modules_buildphase", p_config.modules_buildphase) + "\n"; } else if (lines[i].find("$modules_buildgrp") != -1) { strnew += lines[i].replace("$modules_buildgrp", p_config.modules_buildgrp) + "\n"; } else if (lines[i].find("$name") != -1) { strnew += lines[i].replace("$name", p_config.pkg_name) + "\n"; } else if (lines[i].find("$bundle_identifier") != -1) { strnew += lines[i].replace("$bundle_identifier", p_preset->get("application/bundle_identifier")) + "\n"; } else if (lines[i].find("$short_version") != -1) { strnew += lines[i].replace("$short_version", p_preset->get("application/short_version")) + "\n"; } else if (lines[i].find("$version") != -1) { strnew += lines[i].replace("$version", p_preset->get_version("application/version")) + "\n"; } else if (lines[i].find("$signature") != -1) { strnew += lines[i].replace("$signature", p_preset->get("application/signature")) + "\n"; } else if (lines[i].find("$team_id") != -1) { strnew += lines[i].replace("$team_id", p_preset->get("application/app_store_team_id")) + "\n"; } else if (lines[i].find("$default_build_config") != -1) { strnew += lines[i].replace("$default_build_config", p_debug ? "Debug" : "Release") + "\n"; } else if (lines[i].find("$export_method") != -1) { int export_method = p_preset->get(p_debug ? "application/export_method_debug" : "application/export_method_release"); strnew += lines[i].replace("$export_method", export_method_string[export_method]) + "\n"; } else if (lines[i].find("$provisioning_profile_uuid_release") != -1) { strnew += lines[i].replace("$provisioning_profile_uuid_release", p_preset->get_or_env("application/provisioning_profile_uuid_release", ENV_IOS_PROFILE_UUID_RELEASE)) + "\n"; } else if (lines[i].find("$provisioning_profile_uuid_debug") != -1) { strnew += lines[i].replace("$provisioning_profile_uuid_debug", p_preset->get_or_env("application/provisioning_profile_uuid_debug", ENV_IOS_PROFILE_UUID_DEBUG)) + "\n"; } else if (lines[i].find("$code_sign_style_debug") != -1) { if (dbg_manual) { strnew += lines[i].replace("$code_sign_style_debug", "Manual") + "\n"; } else { strnew += lines[i].replace("$code_sign_style_debug", "Automatic") + "\n"; } } else if (lines[i].find("$code_sign_style_release") != -1) { if (rel_manual) { strnew += lines[i].replace("$code_sign_style_release", "Manual") + "\n"; } else { strnew += lines[i].replace("$code_sign_style_release", "Automatic") + "\n"; } } else if (lines[i].find("$provisioning_profile_uuid") != -1) { String uuid = p_debug ? p_preset->get_or_env("application/provisioning_profile_uuid_debug", ENV_IOS_PROFILE_UUID_DEBUG) : p_preset->get_or_env("application/provisioning_profile_uuid_release", ENV_IOS_PROFILE_UUID_RELEASE); strnew += lines[i].replace("$provisioning_profile_uuid", uuid) + "\n"; } else if (lines[i].find("$code_sign_identity_debug") != -1) { strnew += lines[i].replace("$code_sign_identity_debug", dbg_sign_id) + "\n"; } else if (lines[i].find("$code_sign_identity_release") != -1) { strnew += lines[i].replace("$code_sign_identity_release", rel_sign_id) + "\n"; } else if (lines[i].find("$additional_plist_content") != -1) { strnew += lines[i].replace("$additional_plist_content", p_config.plist_content) + "\n"; } else if (lines[i].find("$godot_archs") != -1) { strnew += lines[i].replace("$godot_archs", p_config.architectures) + "\n"; } else if (lines[i].find("$linker_flags") != -1) { strnew += lines[i].replace("$linker_flags", p_config.linker_flags) + "\n"; } else if (lines[i].find("$targeted_device_family") != -1) { String xcode_value; switch ((int)p_preset->get("application/targeted_device_family")) { case 0: // iPhone xcode_value = "1"; break; case 1: // iPad xcode_value = "2"; break; case 2: // iPhone & iPad xcode_value = "1,2"; break; } strnew += lines[i].replace("$targeted_device_family", xcode_value) + "\n"; } else if (lines[i].find("$cpp_code") != -1) { strnew += lines[i].replace("$cpp_code", p_config.cpp_code) + "\n"; } else if (lines[i].find("$docs_in_place") != -1) { strnew += lines[i].replace("$docs_in_place", ((bool)p_preset->get("user_data/accessible_from_files_app")) ? "" : "") + "\n"; } else if (lines[i].find("$docs_sharing") != -1) { strnew += lines[i].replace("$docs_sharing", ((bool)p_preset->get("user_data/accessible_from_itunes_sharing")) ? "" : "") + "\n"; } else if (lines[i].find("$entitlements_push_notifications") != -1) { bool is_on = p_preset->get("capabilities/push_notifications"); strnew += lines[i].replace("$entitlements_push_notifications", is_on ? "aps-environmentdevelopment" : "") + "\n"; } else if (lines[i].find("$required_device_capabilities") != -1) { String capabilities; // I've removed armv7 as we can run on 64bit only devices // Note that capabilities listed here are requirements for the app to be installed. // They don't enable anything. Vector capabilities_list = p_config.capabilities; if ((bool)p_preset->get("capabilities/access_wifi") && !capabilities_list.has("wifi")) { capabilities_list.push_back("wifi"); } for (int idx = 0; idx < capabilities_list.size(); idx++) { capabilities += "" + capabilities_list[idx] + "\n"; } strnew += lines[i].replace("$required_device_capabilities", capabilities); } else if (lines[i].find("$interface_orientations") != -1) { String orientations; const DisplayServer::ScreenOrientation screen_orientation = DisplayServer::ScreenOrientation(int(GLOBAL_GET("display/window/handheld/orientation"))); switch (screen_orientation) { case DisplayServer::SCREEN_LANDSCAPE: orientations += "UIInterfaceOrientationLandscapeLeft\n"; break; case DisplayServer::SCREEN_PORTRAIT: orientations += "UIInterfaceOrientationPortrait\n"; break; case DisplayServer::SCREEN_REVERSE_LANDSCAPE: orientations += "UIInterfaceOrientationLandscapeRight\n"; break; case DisplayServer::SCREEN_REVERSE_PORTRAIT: orientations += "UIInterfaceOrientationPortraitUpsideDown\n"; break; case DisplayServer::SCREEN_SENSOR_LANDSCAPE: // Allow both landscape orientations depending on sensor direction. orientations += "UIInterfaceOrientationLandscapeLeft\n"; orientations += "UIInterfaceOrientationLandscapeRight\n"; break; case DisplayServer::SCREEN_SENSOR_PORTRAIT: // Allow both portrait orientations depending on sensor direction. orientations += "UIInterfaceOrientationPortrait\n"; orientations += "UIInterfaceOrientationPortraitUpsideDown\n"; break; case DisplayServer::SCREEN_SENSOR: // Allow all screen orientations depending on sensor direction. orientations += "UIInterfaceOrientationLandscapeLeft\n"; orientations += "UIInterfaceOrientationLandscapeRight\n"; orientations += "UIInterfaceOrientationPortrait\n"; orientations += "UIInterfaceOrientationPortraitUpsideDown\n"; break; } strnew += lines[i].replace("$interface_orientations", orientations); } else if (lines[i].find("$camera_usage_description") != -1) { String description = p_preset->get("privacy/camera_usage_description"); strnew += lines[i].replace("$camera_usage_description", description) + "\n"; } else if (lines[i].find("$microphone_usage_description") != -1) { String description = p_preset->get("privacy/microphone_usage_description"); strnew += lines[i].replace("$microphone_usage_description", description) + "\n"; } else if (lines[i].find("$photolibrary_usage_description") != -1) { String description = p_preset->get("privacy/photolibrary_usage_description"); strnew += lines[i].replace("$photolibrary_usage_description", description) + "\n"; } else if (lines[i].find("$plist_launch_screen_name") != -1) { bool is_on = p_preset->get("storyboard/use_launch_screen_storyboard"); String value = is_on ? "UILaunchStoryboardName\nLaunch Screen" : ""; strnew += lines[i].replace("$plist_launch_screen_name", value) + "\n"; } else if (lines[i].find("$pbx_launch_screen_file_reference") != -1) { bool is_on = p_preset->get("storyboard/use_launch_screen_storyboard"); String value = is_on ? "90DD2D9D24B36E8000717FE1 = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = file.storyboard; path = \"Launch Screen.storyboard\"; sourceTree = \"\"; };" : ""; strnew += lines[i].replace("$pbx_launch_screen_file_reference", value) + "\n"; } else if (lines[i].find("$pbx_launch_screen_copy_files") != -1) { bool is_on = p_preset->get("storyboard/use_launch_screen_storyboard"); String value = is_on ? "90DD2D9D24B36E8000717FE1 /* Launch Screen.storyboard */," : ""; strnew += lines[i].replace("$pbx_launch_screen_copy_files", value) + "\n"; } else if (lines[i].find("$pbx_launch_screen_build_phase") != -1) { bool is_on = p_preset->get("storyboard/use_launch_screen_storyboard"); String value = is_on ? "90DD2D9E24B36E8000717FE1 /* Launch Screen.storyboard in Resources */," : ""; strnew += lines[i].replace("$pbx_launch_screen_build_phase", value) + "\n"; } else if (lines[i].find("$pbx_launch_screen_build_reference") != -1) { bool is_on = p_preset->get("storyboard/use_launch_screen_storyboard"); String value = is_on ? "90DD2D9E24B36E8000717FE1 /* Launch Screen.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 90DD2D9D24B36E8000717FE1 /* Launch Screen.storyboard */; };" : ""; strnew += lines[i].replace("$pbx_launch_screen_build_reference", value) + "\n"; } else if (lines[i].find("$pbx_launch_image_usage_setting") != -1) { bool is_on = p_preset->get("storyboard/use_launch_screen_storyboard"); String value = is_on ? "" : "ASSETCATALOG_COMPILER_LAUNCHIMAGE_NAME = LaunchImage;"; strnew += lines[i].replace("$pbx_launch_image_usage_setting", value) + "\n"; } else if (lines[i].find("$launch_screen_image_mode") != -1) { int image_scale_mode = p_preset->get("storyboard/image_scale_mode"); String value; switch (image_scale_mode) { case 0: { String logo_path = GLOBAL_GET("application/boot_splash/image"); bool is_on = GLOBAL_GET("application/boot_splash/fullsize"); // If custom logo is not specified, Godot does not scale default one, so we should do the same. value = (is_on && logo_path.length() > 0) ? "scaleAspectFit" : "center"; } break; default: { value = storyboard_image_scale_mode[image_scale_mode - 1]; } } strnew += lines[i].replace("$launch_screen_image_mode", value) + "\n"; } else if (lines[i].find("$launch_screen_background_color") != -1) { bool use_custom = p_preset->get("storyboard/use_custom_bg_color"); Color color = use_custom ? p_preset->get("storyboard/custom_bg_color") : GLOBAL_GET("application/boot_splash/bg_color"); const String value_format = "red=\"$red\" green=\"$green\" blue=\"$blue\" alpha=\"$alpha\""; Dictionary value_dictionary; value_dictionary["red"] = color.r; value_dictionary["green"] = color.g; value_dictionary["blue"] = color.b; value_dictionary["alpha"] = color.a; String value = value_format.format(value_dictionary, "$_"); strnew += lines[i].replace("$launch_screen_background_color", value) + "\n"; } else if (lines[i].find("$pbx_locale_file_reference") != -1) { String locale_files; Vector translations = GLOBAL_GET("internationalization/locale/translations"); if (translations.size() > 0) { HashSet languages; for (const String &E : translations) { Ref tr = ResourceLoader::load(E); if (tr.is_valid() && tr->get_locale() != "en") { languages.insert(tr->get_locale()); } } int index = 0; for (const String &lang : languages) { locale_files += "D0BCFE4518AEBDA2004A" + itos(index).pad_zeros(4) + " /* " + lang + " */ = {isa = PBXFileReference; lastKnownFileType = text.plist.strings; name = " + lang + "; path = " + lang + ".lproj/InfoPlist.strings; sourceTree = \"\"; };\n"; index++; } } strnew += lines[i].replace("$pbx_locale_file_reference", locale_files); } else if (lines[i].find("$pbx_locale_build_reference") != -1) { String locale_files; Vector translations = GLOBAL_GET("internationalization/locale/translations"); if (translations.size() > 0) { HashSet languages; for (const String &E : translations) { Ref tr = ResourceLoader::load(E); if (tr.is_valid() && tr->get_locale() != "en") { languages.insert(tr->get_locale()); } } int index = 0; for (const String &lang : languages) { locale_files += "D0BCFE4518AEBDA2004A" + itos(index).pad_zeros(4) + " /* " + lang + " */,\n"; index++; } } strnew += lines[i].replace("$pbx_locale_build_reference", locale_files); } else if (lines[i].find("$swift_runtime_migration") != -1) { String value = !p_config.use_swift_runtime ? "" : "LastSwiftMigration = 1250;"; strnew += lines[i].replace("$swift_runtime_migration", value) + "\n"; } else if (lines[i].find("$swift_runtime_build_settings") != -1) { String value = !p_config.use_swift_runtime ? "" : R"( CLANG_ENABLE_MODULES = YES; SWIFT_OBJC_BRIDGING_HEADER = "$binary/dummy.h"; SWIFT_VERSION = 5.0; )"; value = value.replace("$binary", p_config.binary_name); strnew += lines[i].replace("$swift_runtime_build_settings", value) + "\n"; } else if (lines[i].find("$swift_runtime_fileref") != -1) { String value = !p_config.use_swift_runtime ? "" : R"( 90B4C2AA2680BC560039117A /* dummy.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "dummy.h"; sourceTree = ""; }; 90B4C2B52680C7E90039117A /* dummy.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = "dummy.swift"; sourceTree = ""; }; )"; strnew += lines[i].replace("$swift_runtime_fileref", value) + "\n"; } else if (lines[i].find("$swift_runtime_binary_files") != -1) { String value = !p_config.use_swift_runtime ? "" : R"( 90B4C2AA2680BC560039117A /* dummy.h */, 90B4C2B52680C7E90039117A /* dummy.swift */, )"; strnew += lines[i].replace("$swift_runtime_binary_files", value) + "\n"; } else if (lines[i].find("$swift_runtime_buildfile") != -1) { String value = !p_config.use_swift_runtime ? "" : "90B4C2B62680C7E90039117A /* dummy.swift in Sources */ = {isa = PBXBuildFile; fileRef = 90B4C2B52680C7E90039117A /* dummy.swift */; };"; strnew += lines[i].replace("$swift_runtime_buildfile", value) + "\n"; } else if (lines[i].find("$swift_runtime_build_phase") != -1) { String value = !p_config.use_swift_runtime ? "" : "90B4C2B62680C7E90039117A /* dummy.swift */,"; strnew += lines[i].replace("$swift_runtime_build_phase", value) + "\n"; } else { strnew += lines[i] + "\n"; } } // !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... // should apply the same fix in our macOS export. CharString cs = strnew.utf8(); pfile.resize(cs.size() - 1); for (int i = 0; i < cs.size() - 1; i++) { pfile.write[i] = cs[i]; } } String EditorExportPlatformIOS::_get_additional_plist_content() { Vector> export_plugins = EditorExport::get_singleton()->get_export_plugins(); String result; for (int i = 0; i < export_plugins.size(); ++i) { result += export_plugins[i]->get_ios_plist_content(); } return result; } String EditorExportPlatformIOS::_get_linker_flags() { Vector> export_plugins = EditorExport::get_singleton()->get_export_plugins(); String result; for (int i = 0; i < export_plugins.size(); ++i) { String flags = export_plugins[i]->get_ios_linker_flags(); if (flags.length() == 0) { continue; } if (result.length() > 0) { result += ' '; } result += flags; } // the flags will be enclosed in quotes, so need to escape them return result.replace("\"", "\\\""); } String EditorExportPlatformIOS::_get_cpp_code() { Vector> export_plugins = EditorExport::get_singleton()->get_export_plugins(); String result; for (int i = 0; i < export_plugins.size(); ++i) { result += export_plugins[i]->get_ios_cpp_code(); } return result; } void EditorExportPlatformIOS::_blend_and_rotate(Ref &p_dst, Ref &p_src, bool p_rot) { ERR_FAIL_COND(p_dst.is_null()); ERR_FAIL_COND(p_src.is_null()); int sw = p_rot ? p_src->get_height() : p_src->get_width(); int sh = p_rot ? p_src->get_width() : p_src->get_height(); int x_pos = (p_dst->get_width() - sw) / 2; int y_pos = (p_dst->get_height() - sh) / 2; int xs = (x_pos >= 0) ? 0 : -x_pos; int ys = (y_pos >= 0) ? 0 : -y_pos; if (sw + x_pos > p_dst->get_width()) { sw = p_dst->get_width() - x_pos; } if (sh + y_pos > p_dst->get_height()) { sh = p_dst->get_height() - y_pos; } for (int y = ys; y < sh; y++) { for (int x = xs; x < sw; x++) { Color sc = p_rot ? p_src->get_pixel(p_src->get_width() - y - 1, x) : p_src->get_pixel(x, y); Color dc = p_dst->get_pixel(x_pos + x, y_pos + y); dc.r = (double)(sc.a * sc.r + dc.a * (1.0 - sc.a) * dc.r); dc.g = (double)(sc.a * sc.g + dc.a * (1.0 - sc.a) * dc.g); dc.b = (double)(sc.a * sc.b + dc.a * (1.0 - sc.a) * dc.b); dc.a = (double)(sc.a + dc.a * (1.0 - sc.a)); p_dst->set_pixel(x_pos + x, y_pos + y, dc); } } } Error EditorExportPlatformIOS::_export_icons(const Ref &p_preset, const String &p_iconset_dir) { String json_description = "{\"images\":["; String sizes; Ref da = DirAccess::open(p_iconset_dir); ERR_FAIL_COND_V_MSG(da.is_null(), ERR_CANT_OPEN, "Cannot open directory '" + p_iconset_dir + "'."); Color boot_bg_color = GLOBAL_GET("application/boot_splash/bg_color"); for (uint64_t i = 0; i < (sizeof(icon_infos) / sizeof(icon_infos[0])); ++i) { IconInfo info = icon_infos[i]; int side_size = String(info.actual_size_side).to_int(); String icon_path = p_preset->get(info.preset_key); if (icon_path.length() == 0) { // Resize main app icon icon_path = GLOBAL_GET("application/config/icon"); Ref img = memnew(Image); Error err = ImageLoader::load_image(icon_path, img); if (err != OK) { add_message(EXPORT_MESSAGE_ERROR, TTR("Export Icons"), vformat("Invalid icon (%s): '%s'.", info.preset_key, icon_path)); return ERR_UNCONFIGURED; } else if (info.force_opaque && img->detect_alpha() != Image::ALPHA_NONE) { add_message(EXPORT_MESSAGE_WARNING, TTR("Export Icons"), vformat("Icon (%s) must be opaque.", info.preset_key)); img->resize(side_size, side_size, (Image::Interpolation)(p_preset->get("application/icon_interpolation").operator int())); Ref new_img = Image::create_empty(side_size, side_size, false, Image::FORMAT_RGBA8); new_img->fill(boot_bg_color); _blend_and_rotate(new_img, img, false); err = new_img->save_png(p_iconset_dir + info.export_name); } else { img->resize(side_size, side_size, (Image::Interpolation)(p_preset->get("application/icon_interpolation").operator int())); err = img->save_png(p_iconset_dir + info.export_name); } if (err) { add_message(EXPORT_MESSAGE_ERROR, TTR("Export Icons"), vformat("Failed to export icon (%s): '%s'.", info.preset_key, icon_path)); return err; } } else { // Load custom icon and resize if required Ref img = memnew(Image); Error err = ImageLoader::load_image(icon_path, img); if (err != OK) { add_message(EXPORT_MESSAGE_ERROR, TTR("Export Icons"), vformat("Invalid icon (%s): '%s'.", info.preset_key, icon_path)); return ERR_UNCONFIGURED; } else if (info.force_opaque && img->detect_alpha() != Image::ALPHA_NONE) { add_message(EXPORT_MESSAGE_WARNING, TTR("Export Icons"), vformat("Icon (%s) must be opaque.", info.preset_key)); img->resize(side_size, side_size, (Image::Interpolation)(p_preset->get("application/icon_interpolation").operator int())); Ref new_img = Image::create_empty(side_size, side_size, false, Image::FORMAT_RGBA8); new_img->fill(boot_bg_color); _blend_and_rotate(new_img, img, false); err = new_img->save_png(p_iconset_dir + info.export_name); } else if (img->get_width() != side_size || img->get_height() != side_size) { add_message(EXPORT_MESSAGE_WARNING, TTR("Export Icons"), vformat("Icon (%s): '%s' has incorrect size %s and was automatically resized to %s.", info.preset_key, icon_path, img->get_size(), Vector2i(side_size, side_size))); img->resize(side_size, side_size, (Image::Interpolation)(p_preset->get("application/icon_interpolation").operator int())); err = img->save_png(p_iconset_dir + info.export_name); } else { err = da->copy(icon_path, p_iconset_dir + info.export_name); } if (err) { add_message(EXPORT_MESSAGE_ERROR, TTR("Export Icons"), vformat("Failed to export icon (%s): '%s'.", info.preset_key, icon_path)); return err; } } sizes += String(info.actual_size_side) + "\n"; if (i > 0) { json_description += ","; } json_description += String("{"); json_description += String("\"idiom\":") + "\"" + info.idiom + "\","; json_description += String("\"size\":") + "\"" + info.unscaled_size + "\","; json_description += String("\"scale\":") + "\"" + info.scale + "\","; json_description += String("\"filename\":") + "\"" + info.export_name + "\""; json_description += String("}"); } json_description += "]}"; Ref json_file = FileAccess::open(p_iconset_dir + "Contents.json", FileAccess::WRITE); ERR_FAIL_COND_V(json_file.is_null(), ERR_CANT_CREATE); CharString json_utf8 = json_description.utf8(); json_file->store_buffer((const uint8_t *)json_utf8.get_data(), json_utf8.length()); Ref sizes_file = FileAccess::open(p_iconset_dir + "sizes", FileAccess::WRITE); ERR_FAIL_COND_V(sizes_file.is_null(), ERR_CANT_CREATE); CharString sizes_utf8 = sizes.utf8(); sizes_file->store_buffer((const uint8_t *)sizes_utf8.get_data(), sizes_utf8.length()); return OK; } Error EditorExportPlatformIOS::_export_loading_screen_file(const Ref &p_preset, const String &p_dest_dir) { const String custom_launch_image_2x = p_preset->get("storyboard/custom_image@2x"); const String custom_launch_image_3x = p_preset->get("storyboard/custom_image@3x"); if (custom_launch_image_2x.length() > 0 && custom_launch_image_3x.length() > 0) { Ref image; String image_path = p_dest_dir.path_join("splash@2x.png"); image.instantiate(); Error err = ImageLoader::load_image(custom_launch_image_2x, image); if (err) { image.unref(); return err; } if (image->save_png(image_path) != OK) { return ERR_FILE_CANT_WRITE; } image.unref(); image_path = p_dest_dir.path_join("splash@3x.png"); image.instantiate(); err = ImageLoader::load_image(custom_launch_image_3x, image); if (err) { image.unref(); return err; } if (image->save_png(image_path) != OK) { return ERR_FILE_CANT_WRITE; } } else { Ref splash; const String splash_path = GLOBAL_GET("application/boot_splash/image"); if (!splash_path.is_empty()) { splash.instantiate(); const Error err = ImageLoader::load_image(splash_path, splash); if (err) { splash.unref(); } } if (splash.is_null()) { splash = Ref(memnew(Image(boot_splash_png))); } // Using same image for both @2x and @3x // because Godot's own boot logo uses single image for all resolutions. // Also not using @1x image, because devices using this image variant // are not supported by iOS 9, which is minimal target. const String splash_png_path_2x = p_dest_dir.path_join("splash@2x.png"); const String splash_png_path_3x = p_dest_dir.path_join("splash@3x.png"); if (splash->save_png(splash_png_path_2x) != OK) { return ERR_FILE_CANT_WRITE; } if (splash->save_png(splash_png_path_3x) != OK) { return ERR_FILE_CANT_WRITE; } } return OK; } Error EditorExportPlatformIOS::_export_loading_screen_images(const Ref &p_preset, const String &p_dest_dir) { Ref da = DirAccess::open(p_dest_dir); ERR_FAIL_COND_V_MSG(da.is_null(), ERR_CANT_OPEN, "Cannot open directory '" + p_dest_dir + "'."); for (uint64_t i = 0; i < sizeof(loading_screen_infos) / sizeof(loading_screen_infos[0]); ++i) { LoadingScreenInfo info = loading_screen_infos[i]; String loading_screen_file = p_preset->get(info.preset_key); Color boot_bg_color = GLOBAL_GET("application/boot_splash/bg_color"); String boot_logo_path = GLOBAL_GET("application/boot_splash/image"); bool boot_logo_scale = GLOBAL_GET("application/boot_splash/fullsize"); if (loading_screen_file.size() > 0) { // Load custom loading screens, and resize if required. Ref img = memnew(Image); Error err = ImageLoader::load_image(loading_screen_file, img); if (err != OK) { ERR_PRINT("Invalid loading screen (" + String(info.preset_key) + "): '" + loading_screen_file + "'."); return ERR_UNCONFIGURED; } if (img->get_width() != info.width || img->get_height() != info.height) { 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) + "."); float aspect_ratio = (float)img->get_width() / (float)img->get_height(); if (boot_logo_scale) { if (info.height * aspect_ratio <= info.width) { img->resize(info.height * aspect_ratio, info.height, (Image::Interpolation)(p_preset->get("application/launch_screens_interpolation").operator int())); } else { img->resize(info.width, info.width / aspect_ratio, (Image::Interpolation)(p_preset->get("application/launch_screens_interpolation").operator int())); } } Ref new_img = Image::create_empty(info.width, info.height, false, Image::FORMAT_RGBA8); new_img->fill(boot_bg_color); _blend_and_rotate(new_img, img, false); err = new_img->save_png(p_dest_dir + info.export_name); } else { err = da->copy(loading_screen_file, p_dest_dir + info.export_name); } if (err) { String err_str = String("Failed to export loading screen (") + info.preset_key + ") from path '" + loading_screen_file + "'."; ERR_PRINT(err_str.utf8().get_data()); return err; } } else { // Generate loading screen from the splash screen Ref img = Image::create_empty(info.width, info.height, false, Image::FORMAT_RGBA8); img->fill(boot_bg_color); Ref img_bs; if (boot_logo_path.length() > 0) { img_bs = Ref(memnew(Image)); ImageLoader::load_image(boot_logo_path, img_bs); } if (!img_bs.is_valid()) { img_bs = Ref(memnew(Image(boot_splash_png))); } if (img_bs.is_valid()) { float aspect_ratio = (float)img_bs->get_width() / (float)img_bs->get_height(); if (info.rotate) { if (boot_logo_scale) { if (info.width * aspect_ratio <= info.height) { img_bs->resize(info.width * aspect_ratio, info.width, (Image::Interpolation)(p_preset->get("application/launch_screens_interpolation").operator int())); } else { img_bs->resize(info.height, info.height / aspect_ratio, (Image::Interpolation)(p_preset->get("application/launch_screens_interpolation").operator int())); } } } else { if (boot_logo_scale) { if (info.height * aspect_ratio <= info.width) { img_bs->resize(info.height * aspect_ratio, info.height, (Image::Interpolation)(p_preset->get("application/launch_screens_interpolation").operator int())); } else { img_bs->resize(info.width, info.width / aspect_ratio, (Image::Interpolation)(p_preset->get("application/launch_screens_interpolation").operator int())); } } } _blend_and_rotate(img, img_bs, info.rotate); } Error err = img->save_png(p_dest_dir + info.export_name); if (err) { String err_str = String("Failed to export loading screen (") + info.preset_key + ") from splash screen."; WARN_PRINT(err_str.utf8().get_data()); } } } return OK; } Error EditorExportPlatformIOS::_walk_dir_recursive(Ref &p_da, FileHandler p_handler, void *p_userdata) { Vector dirs; String current_dir = p_da->get_current_dir(); p_da->list_dir_begin(); String path = p_da->get_next(); while (!path.is_empty()) { if (p_da->current_is_dir()) { if (path != "." && path != "..") { dirs.push_back(path); } } else { Error err = p_handler(current_dir.path_join(path), p_userdata); if (err) { p_da->list_dir_end(); return err; } } path = p_da->get_next(); } p_da->list_dir_end(); for (int i = 0; i < dirs.size(); ++i) { String dir = dirs[i]; p_da->change_dir(dir); Error err = _walk_dir_recursive(p_da, p_handler, p_userdata); p_da->change_dir(".."); if (err) { return err; } } return OK; } struct CodesignData { const Ref &preset; bool debug = false; CodesignData(const Ref &p_preset, bool p_debug) : preset(p_preset), debug(p_debug) { } }; Error EditorExportPlatformIOS::_codesign(String p_file, void *p_userdata) { if (p_file.ends_with(".dylib")) { CodesignData *data = static_cast(p_userdata); print_line(String("Signing ") + p_file); String sign_id; if (data->debug) { sign_id = data->preset->get("application/code_sign_identity_debug").operator String().is_empty() ? "iPhone Developer" : data->preset->get("application/code_sign_identity_debug"); } else { sign_id = data->preset->get("application/code_sign_identity_release").operator String().is_empty() ? "iPhone Distribution" : data->preset->get("application/code_sign_identity_release"); } List codesign_args; codesign_args.push_back("-f"); codesign_args.push_back("-s"); codesign_args.push_back(sign_id); codesign_args.push_back(p_file); String str; Error err = OS::get_singleton()->execute("codesign", codesign_args, &str, nullptr, true); print_verbose("codesign (" + p_file + "):\n" + str); return err; } return OK; } struct PbxId { private: static char _hex_char(uint8_t four_bits) { if (four_bits < 10) { return ('0' + four_bits); } return 'A' + (four_bits - 10); } static String _hex_pad(uint32_t num) { Vector ret; ret.resize(sizeof(num) * 2); for (uint64_t i = 0; i < sizeof(num) * 2; ++i) { uint8_t four_bits = (num >> (sizeof(num) * 8 - (i + 1) * 4)) & 0xF; ret.write[i] = _hex_char(four_bits); } return String::utf8(ret.ptr(), ret.size()); } public: uint32_t high_bits; uint32_t mid_bits; uint32_t low_bits; String str() const { return _hex_pad(high_bits) + _hex_pad(mid_bits) + _hex_pad(low_bits); } PbxId &operator++() { low_bits++; if (!low_bits) { mid_bits++; if (!mid_bits) { high_bits++; } } return *this; } }; struct ExportLibsData { Vector lib_paths; String dest_dir; }; void EditorExportPlatformIOS::_add_assets_to_project(const Ref &p_preset, Vector &p_project_data, const Vector &p_additional_assets) { // that is just a random number, we just need Godot IDs not to clash with // existing IDs in the project. PbxId current_id = { 0x58938401, 0, 0 }; String pbx_files; String pbx_frameworks_build; String pbx_frameworks_refs; String pbx_resources_build; String pbx_resources_refs; String pbx_embeded_frameworks; const String file_info_format = String("$build_id = {isa = PBXBuildFile; fileRef = $ref_id; };\n") + "$ref_id = {isa = PBXFileReference; lastKnownFileType = $file_type; name = \"$name\"; path = \"$file_path\"; sourceTree = \"\"; };\n"; for (int i = 0; i < p_additional_assets.size(); ++i) { String additional_asset_info_format = file_info_format; String build_id = (++current_id).str(); String ref_id = (++current_id).str(); String framework_id = ""; const IOSExportAsset &asset = p_additional_assets[i]; String type; if (asset.exported_path.ends_with(".framework")) { if (asset.should_embed) { additional_asset_info_format += "$framework_id = {isa = PBXBuildFile; fileRef = $ref_id; settings = {ATTRIBUTES = (CodeSignOnCopy, ); }; };\n"; framework_id = (++current_id).str(); pbx_embeded_frameworks += framework_id + ",\n"; } type = "wrapper.framework"; } else if (asset.exported_path.ends_with(".xcframework")) { if (asset.should_embed) { additional_asset_info_format += "$framework_id = {isa = PBXBuildFile; fileRef = $ref_id; settings = {ATTRIBUTES = (CodeSignOnCopy, ); }; };\n"; framework_id = (++current_id).str(); pbx_embeded_frameworks += framework_id + ",\n"; } type = "wrapper.xcframework"; } else if (asset.exported_path.ends_with(".dylib")) { type = "compiled.mach-o.dylib"; } else if (asset.exported_path.ends_with(".a")) { type = "archive.ar"; } else { type = "file"; } String &pbx_build = asset.is_framework ? pbx_frameworks_build : pbx_resources_build; String &pbx_refs = asset.is_framework ? pbx_frameworks_refs : pbx_resources_refs; if (pbx_build.length() > 0) { pbx_build += ",\n"; pbx_refs += ",\n"; } pbx_build += build_id; pbx_refs += ref_id; Dictionary format_dict; format_dict["build_id"] = build_id; format_dict["ref_id"] = ref_id; format_dict["name"] = asset.exported_path.get_file(); format_dict["file_path"] = asset.exported_path; format_dict["file_type"] = type; if (framework_id.length() > 0) { format_dict["framework_id"] = framework_id; } pbx_files += additional_asset_info_format.format(format_dict, "$_"); } // Note, frameworks like gamekit are always included in our project.pbxprof file // even if turned off in capabilities. String str = String::utf8((const char *)p_project_data.ptr(), p_project_data.size()); str = str.replace("$additional_pbx_files", pbx_files); str = str.replace("$additional_pbx_frameworks_build", pbx_frameworks_build); str = str.replace("$additional_pbx_frameworks_refs", pbx_frameworks_refs); str = str.replace("$additional_pbx_resources_build", pbx_resources_build); str = str.replace("$additional_pbx_resources_refs", pbx_resources_refs); str = str.replace("$pbx_embeded_frameworks", pbx_embeded_frameworks); CharString cs = str.utf8(); p_project_data.resize(cs.size() - 1); for (int i = 0; i < cs.size() - 1; i++) { p_project_data.write[i] = cs[i]; } } 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 &r_exported_assets) { String binary_name = p_out_dir.get_file().get_basename(); Ref da = DirAccess::create_for_path(p_asset); if (da.is_null()) { ERR_FAIL_V_MSG(ERR_CANT_CREATE, "Can't create directory: " + p_asset + "."); } bool file_exists = da->file_exists(p_asset); bool dir_exists = da->dir_exists(p_asset); if (!file_exists && !dir_exists) { return ERR_FILE_NOT_FOUND; } String base_dir = p_asset.get_base_dir().replace("res://", ""); String destination_dir; String destination; String asset_path; bool create_framework = false; if (p_is_framework && p_asset.ends_with(".dylib")) { // For iOS we need to turn .dylib into .framework // to be able to send application to AppStore asset_path = String("dylibs").path_join(base_dir); String file_name; if (!p_custom_file_name) { file_name = p_asset.get_basename().get_file(); } else { file_name = *p_custom_file_name; } String framework_name = file_name + ".framework"; asset_path = asset_path.path_join(framework_name); destination_dir = p_out_dir.path_join(asset_path); destination = destination_dir.path_join(file_name); create_framework = true; } else if (p_is_framework && (p_asset.ends_with(".framework") || p_asset.ends_with(".xcframework"))) { asset_path = String("dylibs").path_join(base_dir); String file_name; if (!p_custom_file_name) { file_name = p_asset.get_file(); } else { file_name = *p_custom_file_name; } asset_path = asset_path.path_join(file_name); destination_dir = p_out_dir.path_join(asset_path); destination = destination_dir; } else { asset_path = base_dir; String file_name; if (!p_custom_file_name) { file_name = p_asset.get_file(); } else { file_name = *p_custom_file_name; } destination_dir = p_out_dir.path_join(asset_path); asset_path = asset_path.path_join(file_name); destination = p_out_dir.path_join(asset_path); } Ref filesystem_da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM); ERR_FAIL_COND_V_MSG(filesystem_da.is_null(), ERR_CANT_CREATE, "Cannot create DirAccess for path '" + p_out_dir + "'."); if (!filesystem_da->dir_exists(destination_dir)) { Error make_dir_err = filesystem_da->make_dir_recursive(destination_dir); if (make_dir_err) { return make_dir_err; } } Error err = dir_exists ? da->copy_dir(p_asset, destination) : da->copy(p_asset, destination); if (err) { return err; } IOSExportAsset exported_asset = { binary_name.path_join(asset_path), p_is_framework, p_should_embed }; r_exported_assets.push_back(exported_asset); if (create_framework) { String file_name; if (!p_custom_file_name) { file_name = p_asset.get_basename().get_file(); } else { file_name = *p_custom_file_name; } String framework_name = file_name + ".framework"; // Performing `install_name_tool -id @rpath/{name}.framework/{name} ./{name}` on dylib { List install_name_args; install_name_args.push_back("-id"); install_name_args.push_back(String("@rpath").path_join(framework_name).path_join(file_name)); install_name_args.push_back(destination); OS::get_singleton()->execute("install_name_tool", install_name_args); } // Creating Info.plist { String info_plist_format = "\n" "\n" "\n" "\n" "CFBundleShortVersionString\n" "1.0\n" "CFBundleIdentifier\n" "com.gdextension.framework.$name\n" "CFBundleName\n" "$name\n" "CFBundleExecutable\n" "$name\n" "DTPlatformName\n" "iphoneos\n" "CFBundleInfoDictionaryVersion\n" "6.0\n" "CFBundleVersion\n" "1\n" "CFBundlePackageType\n" "FMWK\n" "MinimumOSVersion\n" "10.0\n" "\n" ""; String info_plist = info_plist_format.replace("$name", file_name); Ref f = FileAccess::open(destination_dir.path_join("Info.plist"), FileAccess::WRITE); if (f.is_valid()) { f->store_string(info_plist); } } } return OK; } Error EditorExportPlatformIOS::_export_additional_assets(const String &p_out_dir, const Vector &p_assets, bool p_is_framework, bool p_should_embed, Vector &r_exported_assets) { for (int f_idx = 0; f_idx < p_assets.size(); ++f_idx) { String asset = p_assets[f_idx]; if (!asset.begins_with("res://")) { // either SDK-builtin or already a part of the export template IOSExportAsset exported_asset = { asset, p_is_framework, p_should_embed }; r_exported_assets.push_back(exported_asset); } else { Error err = _copy_asset(p_out_dir, asset, nullptr, p_is_framework, p_should_embed, r_exported_assets); ERR_FAIL_COND_V(err, err); } } return OK; } Error EditorExportPlatformIOS::_export_additional_assets(const String &p_out_dir, const Vector &p_libraries, Vector &r_exported_assets) { Vector> export_plugins = EditorExport::get_singleton()->get_export_plugins(); for (int i = 0; i < export_plugins.size(); i++) { Vector linked_frameworks = export_plugins[i]->get_ios_frameworks(); Error err = _export_additional_assets(p_out_dir, linked_frameworks, true, false, r_exported_assets); ERR_FAIL_COND_V(err, err); Vector embedded_frameworks = export_plugins[i]->get_ios_embedded_frameworks(); err = _export_additional_assets(p_out_dir, embedded_frameworks, true, true, r_exported_assets); ERR_FAIL_COND_V(err, err); Vector project_static_libs = export_plugins[i]->get_ios_project_static_libs(); for (int j = 0; j < project_static_libs.size(); j++) { project_static_libs.write[j] = project_static_libs[j].get_file(); // Only the file name as it's copied to the project } err = _export_additional_assets(p_out_dir, project_static_libs, true, false, r_exported_assets); ERR_FAIL_COND_V(err, err); Vector ios_bundle_files = export_plugins[i]->get_ios_bundle_files(); err = _export_additional_assets(p_out_dir, ios_bundle_files, false, false, r_exported_assets); ERR_FAIL_COND_V(err, err); } Vector library_paths; for (int i = 0; i < p_libraries.size(); ++i) { library_paths.push_back(p_libraries[i].path); } Error err = _export_additional_assets(p_out_dir, library_paths, true, true, r_exported_assets); ERR_FAIL_COND_V(err, err); return OK; } Vector EditorExportPlatformIOS::_get_preset_architectures(const Ref &p_preset) const { Vector all_archs = _get_supported_architectures(); Vector enabled_archs; for (int i = 0; i < all_archs.size(); ++i) { bool is_enabled = p_preset->get("architectures/" + all_archs[i].name); if (is_enabled) { enabled_archs.push_back(all_archs[i].name); } } return enabled_archs; } Error EditorExportPlatformIOS::_export_ios_plugins(const Ref &p_preset, IOSConfigData &p_config_data, const String &dest_dir, Vector &r_exported_assets, bool p_debug) { String plugin_definition_cpp_code; String plugin_initialization_cpp_code; String plugin_deinitialization_cpp_code; Vector plugin_linked_dependencies; Vector plugin_embedded_dependencies; Vector plugin_files; Vector enabled_plugins = get_enabled_plugins(p_preset); Vector added_linked_dependenciy_names; Vector added_embedded_dependenciy_names; HashMap plist_values; HashSet plugin_linker_flags; Error err; for (int i = 0; i < enabled_plugins.size(); i++) { PluginConfigIOS plugin = enabled_plugins[i]; // Export plugin binary. String plugin_main_binary = PluginConfigIOS::get_plugin_main_binary(plugin, p_debug); String plugin_binary_result_file = plugin.binary.get_file(); // We shouldn't embed .xcframework that contains static libraries. // Static libraries are not embedded anyway. err = _copy_asset(dest_dir, plugin_main_binary, &plugin_binary_result_file, true, false, r_exported_assets); ERR_FAIL_COND_V(err, err); // Adding dependencies. // Use separate container for names to check for duplicates. for (int j = 0; j < plugin.linked_dependencies.size(); j++) { String dependency = plugin.linked_dependencies[j]; String name = dependency.get_file(); if (added_linked_dependenciy_names.has(name)) { continue; } added_linked_dependenciy_names.push_back(name); plugin_linked_dependencies.push_back(dependency); } for (int j = 0; j < plugin.system_dependencies.size(); j++) { String dependency = plugin.system_dependencies[j]; String name = dependency.get_file(); if (added_linked_dependenciy_names.has(name)) { continue; } added_linked_dependenciy_names.push_back(name); plugin_linked_dependencies.push_back(dependency); } for (int j = 0; j < plugin.embedded_dependencies.size(); j++) { String dependency = plugin.embedded_dependencies[j]; String name = dependency.get_file(); if (added_embedded_dependenciy_names.has(name)) { continue; } added_embedded_dependenciy_names.push_back(name); plugin_embedded_dependencies.push_back(dependency); } plugin_files.append_array(plugin.files_to_copy); // Capabilities // Also checking for duplicates. for (int j = 0; j < plugin.capabilities.size(); j++) { String capability = plugin.capabilities[j]; if (p_config_data.capabilities.has(capability)) { continue; } p_config_data.capabilities.push_back(capability); } // Linker flags // Checking duplicates for (int j = 0; j < plugin.linker_flags.size(); j++) { String linker_flag = plugin.linker_flags[j]; plugin_linker_flags.insert(linker_flag); } // Plist // Using hash map container to remove duplicates for (const KeyValue &E : plugin.plist) { String key = E.key; const PluginConfigIOS::PlistItem &item = E.value; String value; switch (item.type) { case PluginConfigIOS::PlistItemType::STRING_INPUT: { String preset_name = "plugins_plist/" + key; String input_value = p_preset->get(preset_name); value = "" + input_value + ""; } break; default: value = item.value; break; } if (key.is_empty() || value.is_empty()) { continue; } String plist_key = "" + key + ""; plist_values[plist_key] = value; } // CPP Code String definition_comment = "// Plugin: " + plugin.name + "\n"; String initialization_method = plugin.initialization_method + "();\n"; String deinitialization_method = plugin.deinitialization_method + "();\n"; plugin_definition_cpp_code += definition_comment + "extern void " + initialization_method + "extern void " + deinitialization_method + "\n"; plugin_initialization_cpp_code += "\t" + initialization_method; plugin_deinitialization_cpp_code += "\t" + deinitialization_method; if (plugin.use_swift_runtime) { p_config_data.use_swift_runtime = true; } } // Updating `Info.plist` { for (const KeyValue &E : plist_values) { String key = E.key; String value = E.value; if (key.is_empty() || value.is_empty()) { continue; } p_config_data.plist_content += key + value + "\n"; } } // Export files { // Export linked plugin dependency err = _export_additional_assets(dest_dir, plugin_linked_dependencies, true, false, r_exported_assets); ERR_FAIL_COND_V(err, err); // Export embedded plugin dependency err = _export_additional_assets(dest_dir, plugin_embedded_dependencies, true, true, r_exported_assets); ERR_FAIL_COND_V(err, err); // Export plugin files err = _export_additional_assets(dest_dir, plugin_files, false, false, r_exported_assets); ERR_FAIL_COND_V(err, err); } // Update CPP { Dictionary plugin_format; plugin_format["definition"] = plugin_definition_cpp_code; plugin_format["initialization"] = plugin_initialization_cpp_code; plugin_format["deinitialization"] = plugin_deinitialization_cpp_code; String plugin_cpp_code = "\n// Godot Plugins\n" "void godot_ios_plugins_initialize();\n" "void godot_ios_plugins_deinitialize();\n" "// Exported Plugins\n\n" "$definition" "// Use Plugins\n" "void godot_ios_plugins_initialize() {\n" "$initialization" "}\n\n" "void godot_ios_plugins_deinitialize() {\n" "$deinitialization" "}\n"; p_config_data.cpp_code += plugin_cpp_code.format(plugin_format, "$_"); } // Update Linker Flag Values { String result_linker_flags = " "; for (const String &E : plugin_linker_flags) { const String &flag = E; if (flag.length() == 0) { continue; } if (result_linker_flags.length() > 0) { result_linker_flags += ' '; } result_linker_flags += flag; } result_linker_flags = result_linker_flags.replace("\"", "\\\""); p_config_data.linker_flags += result_linker_flags; } return OK; } Error EditorExportPlatformIOS::export_project(const Ref &p_preset, bool p_debug, const String &p_path, int p_flags) { return _export_project_helper(p_preset, p_debug, p_path, p_flags, false, false); } Error EditorExportPlatformIOS::_export_project_helper(const Ref &p_preset, bool p_debug, const String &p_path, int p_flags, bool p_simulator, bool p_skip_ipa) { ExportNotifier notifier(*this, p_preset, p_debug, p_path, p_flags); String src_pkg_name; String dest_dir = p_path.get_base_dir() + "/"; String binary_name = p_path.get_file().get_basename(); bool export_project_only = p_preset->get("application/export_project_only"); EditorProgress ep("export", export_project_only ? TTR("Exporting for iOS (Project Files Only)") : TTR("Exporting for iOS"), export_project_only ? 2 : 5, true); String team_id = p_preset->get("application/app_store_team_id"); ERR_FAIL_COND_V_MSG(team_id.length() == 0, ERR_CANT_OPEN, "App Store Team ID not specified - cannot configure the project."); if (p_debug) { src_pkg_name = p_preset->get("custom_template/debug"); } else { src_pkg_name = p_preset->get("custom_template/release"); } if (src_pkg_name.is_empty()) { String err; src_pkg_name = find_export_template("ios.zip", &err); if (src_pkg_name.is_empty()) { add_message(EXPORT_MESSAGE_ERROR, TTR("Prepare Templates"), TTR("Export template not found.")); return ERR_FILE_NOT_FOUND; } } if (!DirAccess::exists(dest_dir)) { return ERR_FILE_BAD_PATH; } { Ref da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM); if (da.is_valid()) { String current_dir = da->get_current_dir(); // remove leftovers from last export so they don't interfere // in case some files are no longer needed if (da->change_dir(dest_dir + binary_name + ".xcodeproj") == OK) { da->erase_contents_recursive(); } if (da->change_dir(dest_dir + binary_name) == OK) { da->erase_contents_recursive(); } da->change_dir(current_dir); if (!da->dir_exists(dest_dir + binary_name)) { Error err = da->make_dir(dest_dir + binary_name); if (err) { return err; } } } } if (ep.step("Making .pck", 0)) { return ERR_SKIP; } String pack_path = dest_dir + binary_name + ".pck"; Vector libraries; Error err = save_pack(p_preset, p_debug, pack_path, &libraries); if (err) { return err; } if (ep.step("Extracting and configuring Xcode project", 1)) { return ERR_SKIP; } String library_to_use = "libgodot.ios." + String(p_debug ? "debug" : "release") + ".xcframework"; print_line("Static framework: " + library_to_use); String pkg_name; if (String(GLOBAL_GET("application/config/name")) != "") { pkg_name = String(GLOBAL_GET("application/config/name")); } else { pkg_name = "Unnamed"; } bool found_library = false; const String project_file = "godot_ios.xcodeproj/project.pbxproj"; HashSet files_to_parse; files_to_parse.insert("godot_ios/godot_ios-Info.plist"); files_to_parse.insert(project_file); files_to_parse.insert("godot_ios/export_options.plist"); files_to_parse.insert("godot_ios/dummy.cpp"); files_to_parse.insert("godot_ios.xcodeproj/project.xcworkspace/contents.xcworkspacedata"); files_to_parse.insert("godot_ios.xcodeproj/xcshareddata/xcschemes/godot_ios.xcscheme"); files_to_parse.insert("godot_ios/godot_ios.entitlements"); files_to_parse.insert("godot_ios/Launch Screen.storyboard"); IOSConfigData config_data = { pkg_name, binary_name, _get_additional_plist_content(), String(" ").join(_get_preset_architectures(p_preset)), _get_linker_flags(), _get_cpp_code(), "", "", "", "", Vector(), false }; Vector assets; Ref tmp_app_path = DirAccess::create_for_path(dest_dir); ERR_FAIL_COND_V(tmp_app_path.is_null(), ERR_CANT_CREATE); print_line("Unzipping..."); Ref io_fa; zlib_filefunc_def io = zipio_create_io(&io_fa); unzFile src_pkg_zip = unzOpen2(src_pkg_name.utf8().get_data(), &io); if (!src_pkg_zip) { add_message(EXPORT_MESSAGE_ERROR, TTR("Prepare Templates"), TTR("Could not open export template (not a zip file?): \"%s\".", src_pkg_name)); return ERR_CANT_OPEN; } err = _export_ios_plugins(p_preset, config_data, dest_dir + binary_name, assets, p_debug); ERR_FAIL_COND_V(err, err); //export rest of the files int ret = unzGoToFirstFile(src_pkg_zip); Vector project_file_data; while (ret == UNZ_OK) { #if defined(MACOS_ENABLED) || defined(LINUXBSD_ENABLED) bool is_execute = false; #endif //get filename unz_file_info info; char fname[16384]; ret = unzGetCurrentFileInfo(src_pkg_zip, &info, fname, 16384, nullptr, 0, nullptr, 0); if (ret != UNZ_OK) { break; } String file = String::utf8(fname); print_line("READ: " + file); Vector data; data.resize(info.uncompressed_size); //read unzOpenCurrentFile(src_pkg_zip); unzReadCurrentFile(src_pkg_zip, data.ptrw(), data.size()); unzCloseCurrentFile(src_pkg_zip); //write if (files_to_parse.has(file)) { _fix_config_file(p_preset, data, config_data, p_debug); } else if (file.begins_with("libgodot.ios")) { if (!file.begins_with(library_to_use) || file.ends_with(String("/empty"))) { ret = unzGoToNextFile(src_pkg_zip); continue; //ignore! } found_library = true; #if defined(MACOS_ENABLED) || defined(LINUXBSD_ENABLED) is_execute = true; #endif file = file.replace(library_to_use, binary_name + ".xcframework"); } if (file == project_file) { project_file_data = data; } ///@TODO need to parse logo files if (data.size() > 0) { file = file.replace("godot_ios", binary_name); print_line("ADDING: " + file + " size: " + itos(data.size())); /* write it into our folder structure */ file = dest_dir + file; /* make sure this folder exists */ String dir_name = file.get_base_dir(); if (!tmp_app_path->dir_exists(dir_name)) { print_line("Creating " + dir_name); Error dir_err = tmp_app_path->make_dir_recursive(dir_name); if (dir_err) { ERR_PRINT("Can't create '" + dir_name + "'."); unzClose(src_pkg_zip); return ERR_CANT_CREATE; } } /* write the file */ { Ref f = FileAccess::open(file, FileAccess::WRITE); if (f.is_null()) { ERR_PRINT("Can't write '" + file + "'."); unzClose(src_pkg_zip); return ERR_CANT_CREATE; }; f->store_buffer(data.ptr(), data.size()); } #if defined(MACOS_ENABLED) || defined(LINUXBSD_ENABLED) if (is_execute) { // we need execute rights on this file chmod(file.utf8().get_data(), 0755); } #endif } ret = unzGoToNextFile(src_pkg_zip); } /* we're done with our source zip */ unzClose(src_pkg_zip); if (!found_library) { ERR_PRINT("Requested template library '" + library_to_use + "' not found. It might be missing from your template archive."); return ERR_FILE_NOT_FOUND; } Dictionary appnames = GLOBAL_GET("application/config/name_localized"); Dictionary camera_usage_descriptions = p_preset->get("privacy/camera_usage_description_localized"); Dictionary microphone_usage_descriptions = p_preset->get("privacy/microphone_usage_description_localized"); Dictionary photolibrary_usage_descriptions = p_preset->get("privacy/photolibrary_usage_description_localized"); Vector translations = GLOBAL_GET("internationalization/locale/translations"); if (translations.size() > 0) { { String fname = dest_dir + binary_name + "/en.lproj"; tmp_app_path->make_dir_recursive(fname); Ref f = FileAccess::open(fname + "/InfoPlist.strings", FileAccess::WRITE); f->store_line("/* Localized versions of Info.plist keys */"); f->store_line(""); f->store_line("CFBundleDisplayName = \"" + GLOBAL_GET("application/config/name").operator String() + "\";"); f->store_line("NSCameraUsageDescription = \"" + p_preset->get("privacy/camera_usage_description").operator String() + "\";"); f->store_line("NSMicrophoneUsageDescription = \"" + p_preset->get("privacy/microphone_usage_description").operator String() + "\";"); f->store_line("NSPhotoLibraryUsageDescription = \"" + p_preset->get("privacy/photolibrary_usage_description").operator String() + "\";"); } HashSet languages; for (const String &E : translations) { Ref tr = ResourceLoader::load(E); if (tr.is_valid() && tr->get_locale() != "en") { languages.insert(tr->get_locale()); } } for (const String &lang : languages) { String fname = dest_dir + binary_name + "/" + lang + ".lproj"; tmp_app_path->make_dir_recursive(fname); Ref f = FileAccess::open(fname + "/InfoPlist.strings", FileAccess::WRITE); f->store_line("/* Localized versions of Info.plist keys */"); f->store_line(""); if (appnames.has(lang)) { f->store_line("CFBundleDisplayName = \"" + appnames[lang].operator String() + "\";"); } if (camera_usage_descriptions.has(lang)) { f->store_line("NSCameraUsageDescription = \"" + camera_usage_descriptions[lang].operator String() + "\";"); } if (microphone_usage_descriptions.has(lang)) { f->store_line("NSMicrophoneUsageDescription = \"" + microphone_usage_descriptions[lang].operator String() + "\";"); } if (photolibrary_usage_descriptions.has(lang)) { f->store_line("NSPhotoLibraryUsageDescription = \"" + photolibrary_usage_descriptions[lang].operator String() + "\";"); } } } // Copy project static libs to the project Vector> export_plugins = EditorExport::get_singleton()->get_export_plugins(); for (int i = 0; i < export_plugins.size(); i++) { Vector project_static_libs = export_plugins[i]->get_ios_project_static_libs(); for (int j = 0; j < project_static_libs.size(); j++) { const String &static_lib_path = project_static_libs[j]; String dest_lib_file_path = dest_dir + static_lib_path.get_file(); Error lib_copy_err = tmp_app_path->copy(static_lib_path, dest_lib_file_path); if (lib_copy_err != OK) { ERR_PRINT("Can't copy '" + static_lib_path + "'."); return lib_copy_err; } } } String iconset_dir = dest_dir + binary_name + "/Images.xcassets/AppIcon.appiconset/"; err = OK; if (!tmp_app_path->dir_exists(iconset_dir)) { err = tmp_app_path->make_dir_recursive(iconset_dir); } if (err) { return err; } err = _export_icons(p_preset, iconset_dir); if (err) { return err; } { bool use_storyboard = p_preset->get("storyboard/use_launch_screen_storyboard"); String launch_image_path = dest_dir + binary_name + "/Images.xcassets/LaunchImage.launchimage/"; String splash_image_path = dest_dir + binary_name + "/Images.xcassets/SplashImage.imageset/"; Ref launch_screen_da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM); if (launch_screen_da.is_null()) { return ERR_CANT_CREATE; } if (use_storyboard) { print_line("Using Launch Storyboard"); if (launch_screen_da->change_dir(launch_image_path) == OK) { launch_screen_da->erase_contents_recursive(); launch_screen_da->remove(launch_image_path); } err = _export_loading_screen_file(p_preset, splash_image_path); } else { print_line("Using Launch Images"); const String launch_screen_path = dest_dir + binary_name + "/Launch Screen.storyboard"; launch_screen_da->remove(launch_screen_path); if (launch_screen_da->change_dir(splash_image_path) == OK) { launch_screen_da->erase_contents_recursive(); launch_screen_da->remove(splash_image_path); } err = _export_loading_screen_images(p_preset, launch_image_path); } } if (err) { return err; } print_line("Exporting additional assets"); _export_additional_assets(dest_dir + binary_name, libraries, assets); _add_assets_to_project(p_preset, project_file_data, assets); String project_file_name = dest_dir + binary_name + ".xcodeproj/project.pbxproj"; { Ref f = FileAccess::open(project_file_name, FileAccess::WRITE); if (f.is_null()) { ERR_PRINT("Can't write '" + project_file_name + "'."); return ERR_CANT_CREATE; }; f->store_buffer(project_file_data.ptr(), project_file_data.size()); } #ifdef MACOS_ENABLED { if (ep.step("Code-signing dylibs", 2)) { return ERR_SKIP; } Ref dylibs_dir = DirAccess::open(dest_dir + binary_name + "/dylibs"); ERR_FAIL_COND_V(dylibs_dir.is_null(), ERR_CANT_OPEN); CodesignData codesign_data(p_preset, p_debug); err = _walk_dir_recursive(dylibs_dir, _codesign, &codesign_data); if (err != OK) { add_message(EXPORT_MESSAGE_ERROR, TTR("Code Signing"), TTR("Code signing failed, see editor log for details.")); return err; } } if (export_project_only) { return OK; } if (ep.step("Making .xcarchive", 3)) { return ERR_SKIP; } String archive_path = p_path.get_basename() + ".xcarchive"; List archive_args; archive_args.push_back("-project"); archive_args.push_back(dest_dir + binary_name + ".xcodeproj"); archive_args.push_back("-scheme"); archive_args.push_back(binary_name); archive_args.push_back("-sdk"); if (p_simulator) { archive_args.push_back("iphonesimulator"); } else { archive_args.push_back("iphoneos"); } archive_args.push_back("-configuration"); archive_args.push_back(p_debug ? "Debug" : "Release"); archive_args.push_back("-destination"); if (p_simulator) { archive_args.push_back("generic/platform=iOS Simulator"); } else { archive_args.push_back("generic/platform=iOS"); } archive_args.push_back("archive"); archive_args.push_back("-allowProvisioningUpdates"); archive_args.push_back("-archivePath"); archive_args.push_back(archive_path); String archive_str; err = OS::get_singleton()->execute("xcodebuild", archive_args, &archive_str, nullptr, true); ERR_FAIL_COND_V(err, err); print_line("xcodebuild (.xcarchive):\n" + archive_str); if (!archive_str.contains("** ARCHIVE SUCCEEDED **")) { add_message(EXPORT_MESSAGE_ERROR, TTR("Xcode Build"), TTR("Xcode project build failed, see editor log for details.")); return FAILED; } if (!p_skip_ipa) { if (ep.step("Making .ipa", 4)) { return ERR_SKIP; } List export_args; export_args.push_back("-exportArchive"); export_args.push_back("-archivePath"); export_args.push_back(archive_path); export_args.push_back("-exportOptionsPlist"); export_args.push_back(dest_dir + binary_name + "/export_options.plist"); export_args.push_back("-allowProvisioningUpdates"); export_args.push_back("-exportPath"); export_args.push_back(dest_dir); String export_str; err = OS::get_singleton()->execute("xcodebuild", export_args, &export_str, nullptr, true); ERR_FAIL_COND_V(err, err); print_line("xcodebuild (.ipa):\n" + export_str); if (!export_str.contains("** EXPORT SUCCEEDED **")) { add_message(EXPORT_MESSAGE_ERROR, TTR("Xcode Build"), TTR(".ipa export failed, see editor log for details.")); return FAILED; } } #else add_message(EXPORT_MESSAGE_WARNING, TTR("Xcode Build"), TTR(".ipa can only be built on macOS. Leaving Xcode project without building the package.")); #endif return OK; } bool EditorExportPlatformIOS::has_valid_export_configuration(const Ref &p_preset, String &r_error, bool &r_missing_templates, bool p_debug) const { #ifdef MODULE_MONO_ENABLED // Don't check for additional errors, as this particular error cannot be resolved. r_error += TTR("Exporting to iOS is currently not supported in Godot 4 when using C#/.NET. Use Godot 3 to target iOS with C#/Mono instead.") + "\n"; r_error += TTR("If this project does not use C#, use a non-C# editor build to export the project.") + "\n"; return false; #else String err; bool valid = false; // Look for export templates (first official, and if defined custom templates). bool dvalid = exists_export_template("ios.zip", &err); bool rvalid = dvalid; // Both in the same ZIP. if (p_preset->get("custom_template/debug") != "") { dvalid = FileAccess::exists(p_preset->get("custom_template/debug")); if (!dvalid) { err += TTR("Custom debug template not found.") + "\n"; } } if (p_preset->get("custom_template/release") != "") { rvalid = FileAccess::exists(p_preset->get("custom_template/release")); if (!rvalid) { err += TTR("Custom release template not found.") + "\n"; } } valid = dvalid || rvalid; r_missing_templates = !valid; if (!err.is_empty()) { r_error = err; } return valid; #endif // !MODULE_MONO_ENABLED } bool EditorExportPlatformIOS::has_valid_project_configuration(const Ref &p_preset, String &r_error) const { String err; bool valid = true; // Validate the project configuration. List options; get_export_options(&options); for (const EditorExportPlatform::ExportOption &E : options) { if (get_export_option_visibility(p_preset.ptr(), E.option.name)) { String warn = get_export_option_warning(p_preset.ptr(), E.option.name); if (!warn.is_empty()) { err += warn + "\n"; if (E.required) { valid = false; } } } } const String etc_error = test_etc2(); if (!etc_error.is_empty()) { valid = false; err += etc_error; } if (!err.is_empty()) { r_error = err; } return valid; } int EditorExportPlatformIOS::get_options_count() const { MutexLock lock(device_lock); return devices.size(); } String EditorExportPlatformIOS::get_options_tooltip() const { return TTR("Select device from the list"); } Ref EditorExportPlatformIOS::get_option_icon(int p_index) const { MutexLock lock(device_lock); Ref icon; if (p_index >= 0 || p_index < devices.size()) { Ref theme = EditorNode::get_singleton()->get_editor_theme(); if (theme.is_valid()) { if (devices[p_index].simulator) { icon = theme->get_icon("IOSSimulator", "EditorIcons"); } else if (devices[p_index].wifi) { icon = theme->get_icon("IOSDeviceWireless", "EditorIcons"); } else { icon = theme->get_icon("IOSDeviceWired", "EditorIcons"); } } } return icon; } String EditorExportPlatformIOS::get_option_label(int p_index) const { ERR_FAIL_INDEX_V(p_index, devices.size(), ""); MutexLock lock(device_lock); return devices[p_index].name; } String EditorExportPlatformIOS::get_option_tooltip(int p_index) const { ERR_FAIL_INDEX_V(p_index, devices.size(), ""); MutexLock lock(device_lock); return "UUID: " + devices[p_index].id; } bool EditorExportPlatformIOS::is_package_name_valid(const String &p_package, String *r_error) const { String pname = p_package; if (pname.length() == 0) { if (r_error) { *r_error = TTR("Identifier is missing."); } return false; } for (int i = 0; i < pname.length(); i++) { char32_t c = pname[i]; if (!(is_ascii_alphanumeric_char(c) || c == '-' || c == '.')) { if (r_error) { *r_error = vformat(TTR("The character '%s' is not allowed in Identifier."), String::chr(c)); } return false; } } return true; } #ifdef MACOS_ENABLED void EditorExportPlatformIOS::_check_for_changes_poll_thread(void *ud) { EditorExportPlatformIOS *ea = static_cast(ud); while (!ea->quit_request.is_set()) { // Nothing to do if we already know the plugins have changed. if (!ea->plugins_changed.is_set()) { MutexLock lock(ea->plugins_lock); Vector loaded_plugins = get_plugins(); if (ea->plugins.size() != loaded_plugins.size()) { ea->plugins_changed.set(); } else { for (int i = 0; i < ea->plugins.size(); i++) { if (ea->plugins[i].name != loaded_plugins[i].name || ea->plugins[i].last_updated != loaded_plugins[i].last_updated) { ea->plugins_changed.set(); break; } } } } // Check for devices updates. Vector ldevices; // Enum real devices. String idepl = EDITOR_GET("export/ios/ios_deploy"); if (idepl.is_empty()) { idepl = "ios-deploy"; } { String devices; List args; args.push_back("-c"); args.push_back("-timeout"); args.push_back("1"); args.push_back("-j"); args.push_back("-u"); args.push_back("-I"); int ec = 0; Error err = OS::get_singleton()->execute(idepl, args, &devices, &ec, true); if (err == OK && ec == 0) { Ref json; json.instantiate(); devices = "{ \"devices\":[" + devices.replace("}{", "},{") + "]}"; err = json->parse(devices); if (err == OK) { Dictionary data = json->get_data(); Array devices = data["devices"]; for (int i = 0; i < devices.size(); i++) { Dictionary device_event = devices[i]; if (device_event["Event"] == "DeviceDetected") { Dictionary device_info = device_event["Device"]; Device nd; nd.id = device_info["DeviceIdentifier"]; nd.name = device_info["DeviceName"].operator String() + " (connected through " + device_event["Interface"].operator String() + ")"; nd.wifi = device_event["Interface"] == "WIFI"; nd.simulator = false; ldevices.push_back(nd); } } } } } // Enum simulators if (FileAccess::exists("/usr/bin/xcrun") || FileAccess::exists("/bin/xcrun")) { String devices; List args; args.push_back("simctl"); args.push_back("list"); args.push_back("devices"); args.push_back("-j"); int ec = 0; Error err = OS::get_singleton()->execute("xcrun", args, &devices, &ec, true); if (err == OK && ec == 0) { Ref json; json.instantiate(); err = json->parse(devices); if (err == OK) { Dictionary data = json->get_data(); Dictionary devices = data["devices"]; for (const Variant *key = devices.next(nullptr); key; key = devices.next(key)) { Array os_devices = devices[*key]; for (int i = 0; i < os_devices.size(); i++) { Dictionary device_info = os_devices[i]; if (device_info["isAvailable"].operator bool() && device_info["state"] == "Booted") { Device nd; nd.id = device_info["udid"]; nd.name = device_info["name"].operator String() + " (simulator)"; nd.simulator = true; ldevices.push_back(nd); } } } } } } // Update device list. { MutexLock lock(ea->device_lock); bool different = false; if (ea->devices.size() != ldevices.size()) { different = true; } else { for (int i = 0; i < ea->devices.size(); i++) { if (ea->devices[i].id != ldevices[i].id) { different = true; break; } } } if (different) { ea->devices = ldevices; ea->devices_changed.set(); } } uint64_t sleep = 200; uint64_t wait = 3000000; uint64_t time = OS::get_singleton()->get_ticks_usec(); while (OS::get_singleton()->get_ticks_usec() - time < wait) { OS::get_singleton()->delay_usec(1000 * sleep); if (ea->quit_request.is_set()) { break; } } } } #endif Error EditorExportPlatformIOS::run(const Ref &p_preset, int p_device, int p_debug_flags) { #ifdef MACOS_ENABLED ERR_FAIL_INDEX_V(p_device, devices.size(), ERR_INVALID_PARAMETER); String can_export_error; bool can_export_missing_templates; if (!can_export(p_preset, can_export_error, can_export_missing_templates)) { add_message(EXPORT_MESSAGE_ERROR, TTR("Run"), can_export_error); return ERR_UNCONFIGURED; } MutexLock lock(device_lock); EditorProgress ep("run", vformat(TTR("Running on %s"), devices[p_device].name), 3); String id = "tmpexport." + uitos(OS::get_singleton()->get_unix_time()); Ref filesystem_da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM); ERR_FAIL_COND_V_MSG(filesystem_da.is_null(), ERR_CANT_CREATE, "Cannot create DirAccess for path '" + EditorPaths::get_singleton()->get_cache_dir() + "'."); filesystem_da->make_dir_recursive(EditorPaths::get_singleton()->get_cache_dir().path_join(id)); String tmp_export_path = EditorPaths::get_singleton()->get_cache_dir().path_join(id).path_join("export.ipa"); #define CLEANUP_AND_RETURN(m_err) \ { \ if (filesystem_da->change_dir(EditorPaths::get_singleton()->get_cache_dir().path_join(id)) == OK) { \ filesystem_da->erase_contents_recursive(); \ filesystem_da->change_dir(".."); \ filesystem_da->remove(id); \ } \ return m_err; \ } \ ((void)0) Device dev = devices[p_device]; // Export before sending to device. Error err = _export_project_helper(p_preset, true, tmp_export_path, p_debug_flags, dev.simulator, true); if (err != OK) { CLEANUP_AND_RETURN(err); } Vector cmd_args_list; String host = EDITOR_GET("network/debug/remote_host"); int remote_port = (int)EDITOR_GET("network/debug/remote_port"); if (p_debug_flags & DEBUG_FLAG_REMOTE_DEBUG_LOCALHOST) { host = "localhost"; } if (p_debug_flags & DEBUG_FLAG_DUMB_CLIENT) { int port = EDITOR_GET("filesystem/file_server/port"); String passwd = EDITOR_GET("filesystem/file_server/password"); cmd_args_list.push_back("--remote-fs"); cmd_args_list.push_back(host + ":" + itos(port)); if (!passwd.is_empty()) { cmd_args_list.push_back("--remote-fs-password"); cmd_args_list.push_back(passwd); } } if (p_debug_flags & DEBUG_FLAG_REMOTE_DEBUG) { cmd_args_list.push_back("--remote-debug"); cmd_args_list.push_back(get_debug_protocol() + host + ":" + String::num(remote_port)); List breakpoints; ScriptEditor::get_singleton()->get_breakpoints(&breakpoints); if (breakpoints.size()) { cmd_args_list.push_back("--breakpoints"); String bpoints; for (const List::Element *E = breakpoints.front(); E; E = E->next()) { bpoints += E->get().replace(" ", "%20"); if (E->next()) { bpoints += ","; } } cmd_args_list.push_back(bpoints); } } if (p_debug_flags & DEBUG_FLAG_VIEW_COLLISIONS) { cmd_args_list.push_back("--debug-collisions"); } if (p_debug_flags & DEBUG_FLAG_VIEW_NAVIGATION) { cmd_args_list.push_back("--debug-navigation"); } if (dev.simulator) { // Deploy and run on simulator. if (ep.step("Installing to simulator...", 3)) { CLEANUP_AND_RETURN(ERR_SKIP); } else { List args; args.push_back("simctl"); args.push_back("install"); args.push_back(dev.id); args.push_back(EditorPaths::get_singleton()->get_cache_dir().path_join(id).path_join("export.xcarchive/Products/Applications/export.app")); String log; int ec; err = OS::get_singleton()->execute("xcrun", args, &log, &ec, true); if (err != OK) { add_message(EXPORT_MESSAGE_WARNING, TTR("Run"), TTR("Could not start simctl executable.")); CLEANUP_AND_RETURN(err); } if (ec != 0) { print_line("simctl install:\n" + log); add_message(EXPORT_MESSAGE_ERROR, TTR("Run"), TTR("Installation failed, see editor log for details.")); CLEANUP_AND_RETURN(ERR_UNCONFIGURED); } } if (ep.step("Running on simulator...", 4)) { CLEANUP_AND_RETURN(ERR_SKIP); } else { List args; args.push_back("simctl"); args.push_back("launch"); args.push_back(dev.id); args.push_back(p_preset->get("application/bundle_identifier")); for (const String &E : cmd_args_list) { args.push_back(E); } String log; int ec; err = OS::get_singleton()->execute("xcrun", args, &log, &ec, true); if (err != OK) { add_message(EXPORT_MESSAGE_WARNING, TTR("Run"), TTR("Could not start simctl executable.")); CLEANUP_AND_RETURN(err); } if (ec != 0) { print_line("simctl launch:\n" + log); add_message(EXPORT_MESSAGE_ERROR, TTR("Run"), TTR("Running failed, see editor log for details.")); } } } else { // Deploy and run on real device. if (ep.step("Installing and running on device...", 4)) { CLEANUP_AND_RETURN(ERR_SKIP); } else { List args; args.push_back("-u"); args.push_back("-I"); args.push_back("--id"); args.push_back(dev.id); args.push_back("--justlaunch"); args.push_back("--bundle"); args.push_back(EditorPaths::get_singleton()->get_cache_dir().path_join(id).path_join("export.xcarchive/Products/Applications/export.app")); String app_args; for (const String &E : cmd_args_list) { app_args += E + " "; } if (!app_args.is_empty()) { args.push_back("--args"); args.push_back(app_args); } String idepl = EDITOR_GET("export/ios/ios_deploy"); if (idepl.is_empty()) { idepl = "ios-deploy"; } String log; int ec; err = OS::get_singleton()->execute(idepl, args, &log, &ec, true); if (err != OK) { add_message(EXPORT_MESSAGE_WARNING, TTR("Run"), TTR("Could not start ios-deploy executable.")); CLEANUP_AND_RETURN(err); } if (ec != 0) { print_line("ios-deploy:\n" + log); add_message(EXPORT_MESSAGE_ERROR, TTR("Run"), TTR("Installation/running failed, see editor log for details.")); CLEANUP_AND_RETURN(ERR_UNCONFIGURED); } } } CLEANUP_AND_RETURN(OK); #undef CLEANUP_AND_RETURN #else return ERR_UNCONFIGURED; #endif } EditorExportPlatformIOS::EditorExportPlatformIOS() { if (EditorNode::get_singleton()) { #ifdef MODULE_SVG_ENABLED Ref img = memnew(Image); const bool upsample = !Math::is_equal_approx(Math::round(EDSCALE), EDSCALE); ImageLoaderSVG::create_image_from_string(img, _ios_logo_svg, EDSCALE, upsample, false); logo = ImageTexture::create_from_image(img); ImageLoaderSVG::create_image_from_string(img, _ios_run_icon_svg, EDSCALE, upsample, false); run_icon = ImageTexture::create_from_image(img); #endif plugins_changed.set(); devices_changed.set(); #ifdef MACOS_ENABLED check_for_changes_thread.start(_check_for_changes_poll_thread, this); #endif } } EditorExportPlatformIOS::~EditorExportPlatformIOS() { #ifdef MACOS_ENABLED quit_request.set(); if (check_for_changes_thread.is_started()) { check_for_changes_thread.wait_to_finish(); } #endif }