import os import platform import shutil import subprocess import sys import methods # NOTE: The multiprocessing module is not compatible with SCons due to conflict on cPickle compatibility_platform_aliases = { "osx": "macos", "iphone": "ios", "x11": "linuxbsd", "javascript": "web", } # CPU architecture options. architectures = ["x86_32", "x86_64", "arm32", "arm64", "rv64", "ppc64", "wasm32", "loongarch64"] architecture_aliases = { "x86": "x86_32", "x64": "x86_64", "amd64": "x86_64", "armv7": "arm32", "armv8": "arm64", "arm64v8": "arm64", "aarch64": "arm64", "rv": "rv64", "riscv": "rv64", "riscv64": "rv64", "ppc64le": "ppc64", "loong64": "loongarch64", } def detect_arch(): host_machine = platform.machine().lower() if host_machine in architectures: return host_machine elif host_machine in architecture_aliases.keys(): return architecture_aliases[host_machine] elif "86" in host_machine: # Catches x86, i386, i486, i586, i686, etc. return "x86_32" else: methods.print_warning(f'Unsupported CPU architecture: "{host_machine}". Falling back to x86_64.') return "x86_64" def validate_arch(arch, platform_name, supported_arches): if arch not in supported_arches: methods.print_error( 'Unsupported CPU architecture "%s" for %s. Supported architectures are: %s.' % (arch, platform_name, ", ".join(supported_arches)) ) sys.exit(255) def get_build_version(short): import version name = "custom_build" if os.getenv("BUILD_NAME") is not None: name = os.getenv("BUILD_NAME") v = "%d.%d" % (version.major, version.minor) if version.patch > 0: v += ".%d" % version.patch status = version.status if not short: if os.getenv("GODOT_VERSION_STATUS") is not None: status = str(os.getenv("GODOT_VERSION_STATUS")) v += ".%s.%s" % (status, name) return v def lipo(prefix, suffix): from pathlib import Path target_bin = "" lipo_command = ["lipo", "-create"] arch_found = 0 for arch in architectures: bin_name = prefix + "." + arch + suffix if Path(bin_name).is_file(): target_bin = bin_name lipo_command += [bin_name] arch_found += 1 if arch_found > 1: target_bin = prefix + ".fat" + suffix lipo_command += ["-output", target_bin] subprocess.run(lipo_command) return target_bin def get_mvk_sdk_path(osname): def int_or_zero(i): try: return int(i) except (TypeError, ValueError): return 0 def ver_parse(a): return [int_or_zero(i) for i in a.split(".")] dirname = os.path.expanduser("~/VulkanSDK") if not os.path.exists(dirname): return "" ver_min = ver_parse("1.3.231.0") ver_num = ver_parse("0.0.0.0") files = os.listdir(dirname) lib_name_out = dirname for file in files: if os.path.isdir(os.path.join(dirname, file)): ver_comp = ver_parse(file) if ver_comp > ver_num and ver_comp >= ver_min: # Try new SDK location. lib_name = os.path.join(os.path.join(dirname, file), "macOS/lib/MoltenVK.xcframework/" + osname + "/") if os.path.isfile(os.path.join(lib_name, "libMoltenVK.a")): ver_num = ver_comp lib_name_out = os.path.join(os.path.join(dirname, file), "macOS/lib/MoltenVK.xcframework") else: # Try old SDK location. lib_name = os.path.join( os.path.join(dirname, file), "MoltenVK/MoltenVK.xcframework/" + osname + "/" ) if os.path.isfile(os.path.join(lib_name, "libMoltenVK.a")): ver_num = ver_comp lib_name_out = os.path.join(os.path.join(dirname, file), "MoltenVK/MoltenVK.xcframework") return lib_name_out def detect_mvk(env, osname): mvk_list = [ get_mvk_sdk_path(osname), "/opt/homebrew/Frameworks/MoltenVK.xcframework", "/usr/local/homebrew/Frameworks/MoltenVK.xcframework", "/opt/local/Frameworks/MoltenVK.xcframework", ] if env["vulkan_sdk_path"] != "": mvk_list.insert(0, os.path.expanduser(env["vulkan_sdk_path"])) mvk_list.insert( 0, os.path.join(os.path.expanduser(env["vulkan_sdk_path"]), "macOS/lib/MoltenVK.xcframework"), ) mvk_list.insert( 0, os.path.join(os.path.expanduser(env["vulkan_sdk_path"]), "MoltenVK/MoltenVK.xcframework"), ) for mvk_path in mvk_list: if mvk_path and os.path.isfile(os.path.join(mvk_path, f"{osname}/libMoltenVK.a")): print(f"MoltenVK found at: {mvk_path}") return mvk_path return "" def combine_libs_apple_embedded(target, source, env): lib_path = target[0].srcnode().abspath if "osxcross" in env: libtool = "$APPLE_TOOLCHAIN_PATH/usr/bin/${apple_target_triple}libtool" else: libtool = "$APPLE_TOOLCHAIN_PATH/usr/bin/libtool" env.Execute( libtool + ' -static -o "' + lib_path + '" ' + " ".join([('"' + lib.srcnode().abspath + '"') for lib in source]) ) def generate_bundle_apple_embedded(platform, framework_dir, framework_dir_sim, use_mkv, target, source, env): bin_dir = env.Dir("#bin").abspath # Template bundle. app_prefix = "godot." + platform rel_prefix = "libgodot." + platform + "." + "template_release" dbg_prefix = "libgodot." + platform + "." + "template_debug" if env.dev_build: app_prefix += ".dev" rel_prefix += ".dev" dbg_prefix += ".dev" if env["precision"] == "double": app_prefix += ".double" rel_prefix += ".double" dbg_prefix += ".double" # Lipo template libraries. # # env.extra_suffix contains ".simulator" when building for simulator, # but it's undesired when calling lipo() extra_suffix = env.extra_suffix.replace(".simulator", "") rel_target_bin = lipo(bin_dir + "/" + rel_prefix, extra_suffix + ".a") dbg_target_bin = lipo(bin_dir + "/" + dbg_prefix, extra_suffix + ".a") rel_target_bin_sim = lipo(bin_dir + "/" + rel_prefix, ".simulator" + extra_suffix + ".a") dbg_target_bin_sim = lipo(bin_dir + "/" + dbg_prefix, ".simulator" + extra_suffix + ".a") # Assemble Xcode project bundle. app_dir = env.Dir("#bin/" + platform + "_xcode").abspath templ = env.Dir("#misc/dist/apple_embedded_xcode").abspath if os.path.exists(app_dir): shutil.rmtree(app_dir) shutil.copytree(templ, app_dir) if rel_target_bin != "": print(f' Copying "{platform}" release framework') shutil.copy( rel_target_bin, app_dir + "/libgodot." + platform + ".release.xcframework/" + framework_dir + "/libgodot.a" ) if dbg_target_bin != "": print(f' Copying "{platform}" debug framework') shutil.copy( dbg_target_bin, app_dir + "/libgodot." + platform + ".debug.xcframework/" + framework_dir + "/libgodot.a" ) if rel_target_bin_sim != "": print(f' Copying "{platform}" (simulator) release framework') shutil.copy( rel_target_bin_sim, app_dir + "/libgodot." + platform + ".release.xcframework/" + framework_dir_sim + "/libgodot.a", ) if dbg_target_bin_sim != "": print(f' Copying "{platform}" (simulator) debug framework') shutil.copy( dbg_target_bin_sim, app_dir + "/libgodot." + platform + ".debug.xcframework/" + framework_dir_sim + "/libgodot.a", ) # Remove other platform xcframeworks for entry in os.listdir(app_dir): if entry.startswith("libgodot.") and entry.endswith(".xcframework"): parts = entry.split(".") if len(parts) >= 3 and parts[1] != platform: full_path = os.path.join(app_dir, entry) shutil.rmtree(full_path) if use_mkv: mvk_path = detect_mvk(env, "ios-arm64") if mvk_path != "": shutil.copytree(mvk_path, app_dir + "/MoltenVK.xcframework") # ZIP Xcode project bundle. zip_dir = env.Dir("#bin/" + (app_prefix + extra_suffix).replace(".", "_")).abspath shutil.make_archive(zip_dir, "zip", root_dir=app_dir) shutil.rmtree(app_dir) def setup_swift_builder(env, apple_platform, sdk_path, current_path, bridging_header_filename, all_swift_files): from SCons.Script import Action, Builder if apple_platform == "macos": target_suffix = "macosx10.9" elif apple_platform == "ios": target_suffix = "ios14.0" # iOS 14.0 needed for SwiftUI lifecycle elif apple_platform == "iossimulator": target_suffix = "ios14.0-simulator" # iOS 14.0 needed for SwiftUI lifecycle elif apple_platform == "visionos": target_suffix = "xros26.0" elif apple_platform == "visionossimulator": target_suffix = "xros26.0-simulator" else: raise Exception("Invalid platform argument passed to detect_darwin_sdk_path") swiftc_target = env["arch"] + "-apple-" + target_suffix env["ALL_SWIFT_FILES"] = all_swift_files env["CURRENT_PATH"] = current_path frontend_path = "$APPLE_TOOLCHAIN_PATH/usr/bin/swift-frontend" bridging_header_path = current_path + "/" + bridging_header_filename env["SWIFTC"] = frontend_path + " -frontend -c" # Swift compiler env["SWIFTCFLAGS"] = [ "-cxx-interoperability-mode=default", "-emit-object", "-target", swiftc_target, "-sdk", sdk_path, "-import-objc-header", bridging_header_path, "-swift-version", "6", "-parse-as-library", "-module-name", "godot_swift_module", "-I./", # Pass the current directory as the header root so bridging headers can include files from any point of the hierarchy ] if env["debug_symbols"]: env.Append(SWIFTCFLAGS=["-g"]) if env["optimize"] in ["speed", "speed_trace"]: env.Append(SWIFTCFLAGS=["-O"]) elif env["optimize"] == "size": env.Append(SWIFTCFLAGS=["-Osize"]) elif env["optimize"] in ["debug", "none"]: env.Append(SWIFTCFLAGS=["-Onone"]) def generate_swift_action(source, target, env, for_signature): fullpath_swift_files = [env["CURRENT_PATH"] + "/" + file for file in env["ALL_SWIFT_FILES"]] fullpath_swift_files.remove(source[0].abspath) fullpath_swift_files_string = '"' + '" "'.join(fullpath_swift_files) + '"' compile_command = "$SWIFTC " + fullpath_swift_files_string + " -primary-file $SOURCE -o $TARGET $SWIFTCFLAGS" swift_comdstr = env.get("SWIFTCOMSTR") if swift_comdstr is not None: swift_action = Action(compile_command, cmdstr=swift_comdstr) else: swift_action = Action(compile_command) return swift_action # Define Builder for Swift files swift_builder = Builder( generator=generate_swift_action, suffix=env["OBJSUFFIX"], src_suffix=".swift", emitter=methods.redirect_emitter ) env.Append(BUILDERS={"Swift": swift_builder}) env["BUILDERS"]["Library"].add_src_builder("Swift") env["BUILDERS"]["Object"].add_action(".swift", Action(generate_swift_action, generator=1))