inject custom toolchain and make it work

Author: Karim Alweheshy

test/internal/pbxproj_partials/write_pbxproj_prefix_tests.bzl

@@ -266,6 +266,8 @@ def write_pbxproj_prefix_test_suite(name):
             "some/path/to/index_import",
             # resolvedRepositoriesFile
             "some/path/to/resolved_repositories_file",
+            # customToolchainID
+            "com.rules_xcodeproj.BazelRulesXcodeProj.16B40",
             # minimumXcodeVersion
             "14.2.1",
             # importIndexBuildIndexstores
@@ -332,6 +334,8 @@ def write_pbxproj_prefix_test_suite(name):
             "some/path/to/index_import",
             # resolvedRepositoriesFile
             "some/path/to/resolved_repositories_file",
+            # customToolchainID
+            "com.rules_xcodeproj.BazelRulesXcodeProj.16B40",
             # minimumXcodeVersion
             "14.2.1",
             # importIndexBuildIndexstores

tools/BUILD

@@ -179,6 +179,8 @@ _XCSCHEMES = [
                 "bazel-out/darwin_arm64-opt-exec-2B5CBBC6/bin/external/_main~non_module_deps~rules_xcodeproj_index_import/index-import",
                 # resolvedRepositoriesFile
                 "bazel-out/darwin_arm64-dbg/bin/external/_main~internal~rules_xcodeproj_generated/generator/tools/generators/xcodeproj/xcodeproj_pbxproj_partials/resolved_repositories",
+                # customToolchainID
+                "com.rules_xcodeproj.BazelRulesXcodeProj.16B40",
                 # minimumXcodeVersion
                 "14.0",
                 # defaultXcodeConfiguration

tools/generators/pbxproj_prefix/src/Generator/Arguments.swift

@@ -42,6 +42,9 @@ setting.
         )
         var resolvedRepositoriesFile: URL
 
+        @Argument(help: "The custom toolchain ID.")
+        var customToolchainID: String
+
         @Argument(help: """
 Minimum Xcode version that the generated project supports.
 """)

tools/generators/pbxproj_prefix/src/Generator/Environment.swift

@@ -37,7 +37,8 @@ extension Generator {
             _ projectDir: String,
             _ resolvedRepositories: String,
             _ workspace: String,
-            _ createBuildSettingsAttribute: CreateBuildSettingsAttribute
+            _ createBuildSettingsAttribute: CreateBuildSettingsAttribute,
+            _ customToolchainID: String
         ) -> String
 
         let pbxProjectPrefixPartial: (

tools/generators/pbxproj_prefix/src/Generator/Generator.swift

@@ -62,7 +62,8 @@ struct Generator {
                     ),
                     /*workspace:*/ arguments.workspace,
                     /*createBuildSettingsAttribute:*/
-                        environment.createBuildSettingsAttribute
+                        environment.createBuildSettingsAttribute,
+                    /*customToolchainID:*/ arguments.customToolchainID
             ),
             /*compatibilityVersion:*/ environment.compatibilityVersion(
                 arguments.minimumXcodeVersion

tools/generators/pbxproj_prefix/src/Generator/PBXProjectBuildSettings.swift

@@ -25,7 +25,8 @@ extension Generator {
         projectDir: String,
         resolvedRepositories: String,
         workspace: String,
-        createBuildSettingsAttribute: CreateBuildSettingsAttribute
+        createBuildSettingsAttribute: CreateBuildSettingsAttribute,
+        customToolchainID: String
     ) -> String {
         return createBuildSettingsAttribute(buildSettings: [
             .init(key: "ALWAYS_SEARCH_USER_PATHS", value: "NO"),
@@ -70,7 +71,6 @@ extension Generator {
                 key: "BUILD_WORKSPACE_DIRECTORY",
                 value: #""$(SRCROOT)""#
             ),
-            .init(key: "CC", value: #""$(BAZEL_INTEGRATION_DIR)/clang.sh""#),
             .init(key: "CLANG_ENABLE_OBJC_ARC", value: "YES"),
             .init(key: "CLANG_MODULES_AUTOLINK", value: "NO"),
             .init(key: "CODE_SIGNING_ALLOWED", value: "NO"),
@@ -80,23 +80,14 @@ extension Generator {
                 value: #""$(BUILD_DIR)/$(BAZEL_PACKAGE_BIN_DIR)""#
             ),
             .init(key: "COPY_PHASE_STRIP", value: "NO"),
-            .init(key: "CXX", value: #""$(BAZEL_INTEGRATION_DIR)/clang.sh""#),
             .init(key: "DEBUG_INFORMATION_FORMAT", value: "dwarf"),
             .init(key: "DSTROOT", value: #""$(PROJECT_TEMP_DIR)""#),
             .init(key: "ENABLE_DEBUG_DYLIB", value: "NO"),
             .init(key: "ENABLE_DEFAULT_SEARCH_PATHS", value: "NO"),
             .init(key: "ENABLE_STRICT_OBJC_MSGSEND", value: "YES"),
             .init(key: "ENABLE_USER_SCRIPT_SANDBOXING", value: "NO"),
             .init(key: "GCC_OPTIMIZATION_LEVEL", value: "0"),
-            .init(key: "LD", value: #""$(BAZEL_INTEGRATION_DIR)/ld""#),
-            .init(
-                key: "LDPLUSPLUS",
-                value: #""$(BAZEL_INTEGRATION_DIR)/ld""#
-            ),
-            .init(
-                key: "LIBTOOL",
-                value: #""$(BAZEL_INTEGRATION_DIR)/libtool""#
-            ),
+            .init(key: "TOOLCHAINS", value: customToolchainID),
             .init(
                 key: "IMPORT_INDEX_BUILD_INDEXSTORES",
                 value: importIndexBuildIndexstores ? "YES" : "NO"
@@ -135,13 +126,8 @@ extension Generator {
             .init(key: "RULES_XCODEPROJ_BUILD_MODE", value: "bazel"),
             .init(key: "SRCROOT", value: workspace.pbxProjEscaped),
             .init(key: "SUPPORTS_MACCATALYST", value: "NO"),
-            .init(
-                key: "SWIFT_EXEC",
-                value: #""$(BAZEL_INTEGRATION_DIR)/swiftc""#
-            ),
             .init(key: "SWIFT_OBJC_INTERFACE_HEADER_NAME", value: #""""#),
             .init(key: "SWIFT_OPTIMIZATION_LEVEL", value: #""-Onone""#),
-            .init(key: "SWIFT_USE_INTEGRATED_DRIVER", value: "NO"),
             .init(key: "SWIFT_VERSION", value: "5.0"),
             .init(key: "TAPI_EXEC", value: "/usr/bin/true"),
             .init(

tools/generators/pbxproj_prefix/test/PBXProjectBuildSettingsTests.swift

@@ -32,14 +32,12 @@ class PBXProjectBuildSettingsTests: XCTestCase {
 				BUILD_DIR = "$(SYMROOT)/$(CONFIGURATION)$(EFFECTIVE_PLATFORM_NAME)";
 				BUILD_MARKER_FILE = "$(OBJROOT)/build_marker";
 				BUILD_WORKSPACE_DIRECTORY = "$(SRCROOT)";
-				CC = "$(BAZEL_INTEGRATION_DIR)/clang.sh";
 				CLANG_ENABLE_OBJC_ARC = YES;
 				CLANG_MODULES_AUTOLINK = NO;
 				CODE_SIGNING_ALLOWED = NO;
 				CODE_SIGN_STYLE = Manual;
 				CONFIGURATION_BUILD_DIR = "$(BUILD_DIR)/$(BAZEL_PACKAGE_BIN_DIR)";
 				COPY_PHASE_STRIP = NO;
-				CXX = "$(BAZEL_INTEGRATION_DIR)/clang.sh";
 				DEBUG_INFORMATION_FORMAT = dwarf;
 				DSTROOT = "$(PROJECT_TEMP_DIR)";
 				ENABLE_DEBUG_DYLIB = NO;
@@ -53,22 +51,18 @@ class PBXProjectBuildSettingsTests: XCTestCase {
 				INDEX_IMPORT = "$(BAZEL_EXTERNAL)/index-import";
 				INSTALL_PATH = "$(BAZEL_PACKAGE_BIN_DIR)/$(TARGET_NAME)/bin";
 				INTERNAL_DIR = "$(PROJECT_FILE_PATH)/rules_xcodeproj";
-				LD = "$(BAZEL_INTEGRATION_DIR)/ld";
-				LDPLUSPLUS = "$(BAZEL_INTEGRATION_DIR)/ld";
 				LD_DYLIB_INSTALL_NAME = "";
 				LD_OBJC_ABI_VERSION = "";
 				LD_RUNPATH_SEARCH_PATHS = "";
-				LIBTOOL = "$(BAZEL_INTEGRATION_DIR)/libtool";
+				TOOLCHAINS = "com.rules_xcodeproj.BazelRulesXcodeProj.16B40";
 				ONLY_ACTIVE_ARCH = YES;
 				PROJECT_DIR = "/some/project dir";
 				RESOLVED_REPOSITORIES = "\"\" \"/tmp/workspace\"";
 				RULES_XCODEPROJ_BUILD_MODE = bazel;
 				SRCROOT = "/Users/TimApple/Star Board";
 				SUPPORTS_MACCATALYST = NO;
-				SWIFT_EXEC = "$(BAZEL_INTEGRATION_DIR)/swiftc";
 				SWIFT_OBJC_INTERFACE_HEADER_NAME = "";
 				SWIFT_OPTIMIZATION_LEVEL = "-Onone";
-				SWIFT_USE_INTEGRATED_DRIVER = NO;
 				SWIFT_VERSION = 5.0;
 				TAPI_EXEC = /usr/bin/true;
 				TARGET_TEMP_DIR = "$(PROJECT_TEMP_DIR)/$(BAZEL_PACKAGE_BIN_DIR)/$(COMPILE_TARGET_NAME)";
@@ -88,7 +82,8 @@ class PBXProjectBuildSettingsTests: XCTestCase {
             projectDir: projectDir,
             resolvedRepositories: resolvedRepositories,
             workspace: workspace,
-            createBuildSettingsAttribute: CreateBuildSettingsAttribute()
+            createBuildSettingsAttribute: CreateBuildSettingsAttribute(),
+            customToolchainID: "com.rules_xcodeproj.BazelRulesXcodeProj.16B40"
         )
 
         // Assert

tools/swiftc_stub/main.swift

@@ -5,6 +5,11 @@ import Foundation
 enum PathKey: String {
     case emitModulePath = "-emit-module-path"
     case emitObjCHeaderPath = "-emit-objc-header-path"
+    case emitModuleSourceInfoPath = "-emit-module-source-info-path"
+    case serializeDiagnosticsPath = "-serialize-diagnostics-path"
+    case emitDependenciesPath = "-emit-dependencies-path"
+    case emitABIDescriptorPath = "-emit-abi-descriptor-path"
+    case emitModuleDocPath = "-emit-module-doc-path"
     case outputFileMap = "-output-file-map"
     case sdk = "-sdk"
 }
@@ -75,17 +80,17 @@ extension URL {
     }
 }
 
-/// Touch the Xcode-required `.d` files
+/// Touch the Xcode-required `.d` and `-master-emit-module.d` files
 func touchDepsFiles(isWMO: Bool, paths: [PathKey: URL]) throws {
     guard let outputFileMapPath = paths[PathKey.outputFileMap] else { return }
 
     if isWMO {
-        let dPath = String(
-            outputFileMapPath.path.dropLast("-OutputFileMap.json".count) +
-            "-master.d"
-        )
-        var url = URL(fileURLWithPath: dPath)
-        try url.touch()
+        let pathNoExtension = String(outputFileMapPath.path.dropLast("-OutputFileMap.json".count))
+        var masterDFilePath = URL(fileURLWithPath: pathNoExtension + "-master.d")
+        try masterDFilePath.touch()
+
+        var dFilePath = URL(fileURLWithPath: pathNoExtension + ".d")
+        try dFilePath.touch()
     } else {
         let data = try Data(contentsOf: outputFileMapPath)
         let outputFileMapRaw = try JSONSerialization.jsonObject(
@@ -98,23 +103,28 @@ func touchDepsFiles(isWMO: Bool, paths: [PathKey: URL]) throws {
         }
 
         for entry in outputFileMap.values {
-            guard let dPath = entry["dependencies"] as? String else {
-                continue
+            if let dPath = entry["dependencies"] as? String {
+                var url = URL(fileURLWithPath: dPath)
+                try url.touch()
             }
-            var url = URL(fileURLWithPath: dPath)
-            try url.touch()
+            if let dPath = entry["emit-module-dependencies"] as? String {
+                var url = URL(fileURLWithPath: dPath)
+                try url.touch()
+            }
+            continue
         }
     }
 }
 
-/// Touch the Xcode-required `.swift{module,doc,sourceinfo}` files
+/// Touch the Xcode-required `-master-emit-module.d`, `.{d,abi.json}` and `.swift{module,doc,sourceinfo}` files
 func touchSwiftmoduleArtifacts(paths: [PathKey: URL]) throws {
     if var swiftmodulePath = paths[PathKey.emitModulePath] {
-        var swiftdocPath = swiftmodulePath.deletingPathExtension()
+        let pathNoExtension = swiftmodulePath.deletingPathExtension()
+        var swiftdocPath = pathNoExtension
             .appendingPathExtension("swiftdoc")
-        var swiftsourceinfoPath = swiftmodulePath.deletingPathExtension()
+        var swiftsourceinfoPath = pathNoExtension
             .appendingPathExtension("swiftsourceinfo")
-        var swiftinterfacePath = swiftmodulePath.deletingPathExtension()
+        var swiftinterfacePath = pathNoExtension
             .appendingPathExtension("swiftinterface")
 
         try swiftmodulePath.touch()
@@ -126,6 +136,29 @@ func touchSwiftmoduleArtifacts(paths: [PathKey: URL]) throws {
     if var generatedHeaderPath = paths[PathKey.emitObjCHeaderPath] {
         try generatedHeaderPath.touch()
     }
+
+    if var path = paths[PathKey.emitModuleSourceInfoPath] {
+        try path.touch()
+    }
+
+    if var path = paths[PathKey.serializeDiagnosticsPath] {
+        try path.touch()
+    }
+
+    if var path = paths[PathKey.emitDependenciesPath] {
+        try path.touch()
+    }
+
+    if var path = paths[PathKey.emitABIDescriptorPath] {
+        try path.touch()
+    }
+
+    if var path = paths[PathKey.emitModuleDocPath] {
+        var swiftModulePath = path.deletingPathExtension()
+            .appendingPathExtension("swiftmodule")
+        try swiftModulePath.touch()
+        try path.touch()
+    }
 }
 
 func runSubProcess(executable: String, args: [String]) throws -> Int32 {

xcodeproj/internal/BUILD

@@ -1,4 +1,5 @@
 load("@bazel_skylib//:bzl_library.bzl", "bzl_library")
+load("//xcodeproj/internal:custom_toolchain.bzl", "custom_toolchain")
 
 bzl_library(
     name = "bazel_tools",
@@ -46,3 +47,16 @@ filegroup(
     tags = ["manual"],
     visibility = ["//:__subpackages__"],
 )
+
+custom_toolchain(
+    name = "rulesxcodeproj_toolchain",
+    overrides = {
+        # Use universal_swiftc_stub for all tools
+        "//" + package_name() + "/bazel_integration_files:clang_binary": "clang,clang++,cc,c++",
+        "//" + package_name() + "/bazel_integration_files:libtool_binary": "libtool",
+        "//" + package_name() + "/bazel_integration_files:ld_binary": "ld",
+        "//tools/swiftc_stub:universal_swiftc_stub": "swiftc,swift-frontend",
+    },
+    toolchain_name = "BazelRulesXcodeProj",
+    visibility = ["//visibility:public"],
+)

xcodeproj/internal/bazel_integration_files/BUILD

@@ -132,8 +132,29 @@ fi
     ],
 )
 
-# Release
+filegroup(
+    name = "libtool_binary",
+    srcs = ["libtool"],
+    tags = ["manual"],
+    # This is made public for internal use only
+    visibility = ["//:__subpackages__"],
+)
 
+filegroup(
+    name = "ld_binary",
+    srcs = ["ld"],
+    tags = ["manual"],
+    visibility = ["//:__subpackages__"],
+)
+
+filegroup(
+    name = "clang_binary",
+    srcs = ["clang.sh"],
+    tags = ["manual"],
+    visibility = ["//:__subpackages__"],
+)
+
+# Release
 filegroup(
     name = "release_files",
     srcs = glob(

xcodeproj/internal/bazel_integration_files/ld

@@ -7,6 +7,11 @@ passthrough_args=("${@:1}")
 while test $# -gt 0
 do
   case $1 in
+  -version_details)
+    # Pass through for version details
+    exec "$(xcrun --find ld)" -version_details
+    ;;
+
   *_dependency_info.dat)
     ld_version=$(ld -v 2>&1 | grep ^@)
     printf "\0%s\0" "$ld_version" > "$1"

xcodeproj/internal/pbxproj_partials.bzl

@@ -658,6 +658,7 @@ def _write_pbxproj_prefix(
         ),
         colorize,
         config,
+        custom_toolchain_id,
         default_xcode_configuration,
         execution_root_file,
         generator_name,
@@ -681,6 +682,7 @@ def _write_pbxproj_prefix(
         apple_platform_to_platform_name: Exposed for testing. Don't set.
         colorize: A `bool` indicating whether to colorize the output.
         config: The name of the `.bazelrc` config.
+        custom_toolchain_id: The custom toolchain ID.
         default_xcode_configuration: The name of the the Xcode configuration to
             use when building, if not overridden by custom schemes.
         execution_root_file: A `File` containing the absolute path to the Bazel
@@ -740,6 +742,9 @@ def _write_pbxproj_prefix(
     # resolvedRepositoriesFile
     args.add(resolved_repositories_file)
 
+    # customToolchainID
+    args.add(custom_toolchain_id)
+
     # minimumXcodeVersion
     args.add(minimum_xcode_version)