Move Xcode build phase script logic to a separate Python script.

Author: arik-so

src/scripts/build_individual_libldk.py

@@ -47,8 +47,8 @@ def run(config: ScriptConfig):
 		lipo_binary_directory = config.LIPO_BINARY_OUTPUT_DIRECTORY
 	lipo_binary_output_path = os.path.join(lipo_binary_directory, 'libldk.a')
 
-	print(individual_architecture_binary_directory)
-	print(lipo_binary_directory)
+	print('Building lipo binary into', lipo_binary_output_path)
+
 	os.makedirs(lipo_binary_directory, exist_ok=True)
 
 	child_environment = dict(os.environ)
@@ -92,7 +92,7 @@ def run(config: ScriptConfig):
 
 		# stop the complaints about directories not being empty
 		if os.path.isdir(cargo_target_directory):
-			shutil.rmtree(cargo_target_directory)
+			shutil.rmtree(cargo_target_directory, ignore_errors=True)
 		subprocess.check_call([CARGO_PATH, 'clean'], cwd=config.LDK_C_BINDINGS_DIRECTORY)
 
 		# cargo build -Z build-std=panic_abort,std --features "std" --target "${RUST_ARCH}-apple-${RUST_TARGET_OS}" $RUST_CONFIGURATION_FLAG

src/scripts/prepare_headers.py renamed to src/scripts/copy_c_files.py

@@ -10,11 +10,11 @@ def run(config: ScriptConfig):
 		os.path.join(config.LDK_C_BINDINGS_BASE, 'ldk-net'),
 	]
 
-	header_destination_directory = os.path.realpath(
-		os.path.join(os.path.dirname(__file__), '../../xcode/LDKFramework/headers')
-	)
+	header_destination_directory = config.C_FILE_OUTPUT_DIRECTORY
 	os.makedirs(header_destination_directory, exist_ok=True)
 
+	print('Copying headers to', header_destination_directory)
+
 	for current_directory in header_directories:
 		for current_file in os.listdir(current_directory):
 
@@ -26,9 +26,10 @@ def run(config: ScriptConfig):
 			if not os.path.isfile(current_path):
 				continue
 
+			print('Copying', current_path)
 			subprocess.check_call(['cp', current_path, header_destination_directory])
 
 
 if __name__ == '__main__':
-	script_config = ScriptConfig.parse(allow_ldk_argument=True)
+	script_config = ScriptConfig.parse(allow_ldk_argument=True, parse_as_xcode_invocation=True)
 	run(script_config)

src/scripts/generate_xcframework.py

@@ -59,7 +59,7 @@ def run(config: ScriptConfig):
 
 		# create clean derived data directory
 		if os.path.exists(derived_data_directory):
-			shutil.rmtree(derived_data_directory)
+			shutil.rmtree(derived_data_directory, ignore_errors=True)
 		os.makedirs(derived_data_directory, exist_ok=False)
 
 		child_environment['LDK_C_BINDINGS_BINARY_DIRECTORY'] = lipo_binary_directory
@@ -86,7 +86,7 @@ def run(config: ScriptConfig):
 		)
 
 		# clean up the derived data
-		shutil.rmtree(derived_data_directory)
+		shutil.rmtree(derived_data_directory, ignore_errors=True)
 
 		# XCFRAMEWORK_INPUT_FLAGS="${XCFRAMEWORK_INPUT_FLAGS}-framework ${CURRENT_ARCHIVE_PATH}.xcarchive/Products/Library/Frameworks/LDKFramework.framework "
 		framework_input_flags += [
@@ -96,7 +96,7 @@ def run(config: ScriptConfig):
 
 	# xcodebuild -create-xcframework ${XCFRAMEWORK_INPUT_FLAGS} -output ${XCFRAMEWORK_OUTPUT_PATH}"
 	if os.path.exists(xcframework_output_path):
-		shutil.rmtree(xcframework_output_path)
+		shutil.rmtree(xcframework_output_path, ignore_errors=True)
 
 	subprocess.check_call(
 		['xcodebuild', '-create-xcframework', *framework_input_flags, '-output', xcframework_output_path]

src/scripts/prepare_xcode_project.py

@@ -0,0 +1,49 @@
+import os
+import sys
+
+from script_config import ScriptConfig
+import copy_c_files
+import build_individual_libldk
+
+
+
+def run(config: ScriptConfig):
+	print('Preparing Xcode project…')
+	project_directory = os.getenv('PROJECT_DIR')
+
+	bindings_binary_directory = os.getenv('LDK_C_BINDINGS_BINARY_DIRECTORY')
+	forced_rebuild_override_directory = os.getenv('LDK_C_BINDINGS_BINARY_FORCED_REBUILD_OUTPUT_DIRECTORY')
+
+	print('PROJECT_DIR:', project_directory)
+	print('LDK_C_BINDINGS_BINARY_DIRECTORY:', bindings_binary_directory)
+	print('LDK_C_BINDINGS_BINARY_FORCED_REBUILD_OUTPUT_DIRECTORY:', forced_rebuild_override_directory)
+
+	# step 1: copy C files, *.h and *.c
+	copy_c_files.run(config)
+
+	if bindings_binary_directory and forced_rebuild_override_directory:
+		print('LDK_C_BINDINGS_BINARY_DIRECTORY and LDK_C_BINDINGS_BINARY_FORCED_REBUILD_OUTPUT_DIRECTORY may not both be set at the same time!')
+		sys.exit(1)
+
+	if not bindings_binary_directory and not forced_rebuild_override_directory:
+		print('One of LDK_C_BINDINGS_BINARY_DIRECTORY and LDK_C_BINDINGS_BINARY_FORCED_REBUILD_OUTPUT_DIRECTORY must be set!')
+		sys.exit(1)
+
+	if not forced_rebuild_override_directory:
+		print('LDK_C_BINDINGS_BINARY_FORCED_REBUILD_OUTPUT_DIRECTORY not set: binary rebuild not necessary.')
+		return
+
+	# if and only if and if only LDK_C_BINDINGS_BINARY_FORCED_REBUILD_OUTPUT_DIRECTORY is set, we build the individual libldk
+	config.LIPO_BINARY_OUTPUT_DIRECTORY = forced_rebuild_override_directory
+	# TODO: detect if there's already a libldk.a in that directory and then not do the build
+	build_individual_libldk.run(config)
+
+
+if __name__ == '__main__':
+	script_config = ScriptConfig.parse(
+		allow_ldk_argument=False,
+		parse_configuration=True,
+		parse_lipo_output_directory=True,
+		parse_as_xcode_invocation=True
+	)
+	run(script_config)

src/scripts/script_config.py

@@ -32,9 +32,10 @@ def __init__(self):
 		self.RUST_CONFIGURATION: str = ''
 		self.RUST_CONFIGURATION_FLAG: str = ''
 		self.LIPO_BINARY_OUTPUT_DIRECTORY: str = ''
+		self.C_FILE_OUTPUT_DIRECTORY: str = ''
 
 	@classmethod
-	def parse(cls, allow_ldk_argument=True, parse_configuration=False, parse_lipo_output_directory=False):
+	def parse(cls, allow_ldk_argument=True, parse_configuration=False, parse_lipo_output_directory=False, parse_as_xcode_invocation=False):
 
 		ldk_directory_string = os.getenv('LDK_C_BINDINGS_BASE')
 		if allow_ldk_argument and len(sys.argv) > 1:
@@ -76,4 +77,23 @@ def parse(cls, allow_ldk_argument=True, parse_configuration=False, parse_lipo_ou
 		if parse_lipo_output_directory:
 			config.LIPO_BINARY_OUTPUT_DIRECTORY = os.getenv('LDK_C_BINDINGS_BINARY_DIRECTORY')
 
+		if parse_as_xcode_invocation:
+			# this script is being called from xcode
+			# that means we might get a PROJECT_DIR and a PLATFORM, ARCHS, etc.
+
+			# parse C file destination directory
+			config.C_FILE_OUTPUT_DIRECTORY = os.path.join(os.path.dirname(__file__), '../../xcode/LDKFramework/headers')
+			project_directory = os.getenv('PROJECT_DIR')
+			if project_directory:
+				config.C_FILE_OUTPUT_DIRECTORY = os.path.join(os.path.realpath(project_directory), 'headers')
+
+			# parse build config aspect
+			platform = os.getenv('PLATFORM_NAME')
+			llvm_target_triple_suffix = os.getenv('LLVM_TARGET_TRIPLE_SUFFIX')
+			architectures = os.getenv('ARCHS').split(' ')
+			ldkBuildConfig = BuildConfig(platform, llvm_target_triple_suffix, architectures)
+			config.LIBLDK_BUILD_CONFIGURATIONS = [ldkBuildConfig]
+
+			pass
+
 		return config