Plugin.swift

//===----------------------------------------------------------------------===//
//
// This source file is part of the Swift open source project
//
// Copyright (c) 2025 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//

public import SWBUtil
import SWBCore
import SWBMacro
import SWBProtocol
import Foundation
import SWBTaskConstruction

@PluginExtensionSystemActor public func initializePlugin(_ manager: PluginManager) {
    manager.register(AppleDeveloperDirectoryExtension(), type: DeveloperDirectoryExtensionPoint.self)
    manager.register(ApplePlatformSpecsExtension(), type: SpecificationsExtensionPoint.self)
    manager.register(ActoolInputFileGroupingStrategyExtension(), type: InputFileGroupingStrategyExtensionPoint.self)
    manager.register(ImageScaleFactorsInputFileGroupingStrategyExtension(), type: InputFileGroupingStrategyExtensionPoint.self)
    manager.register(LocalizationInputFileGroupingStrategyExtension(), type: InputFileGroupingStrategyExtensionPoint.self)
    manager.register(XCStringsInputFileGroupingStrategyExtension(), type: InputFileGroupingStrategyExtensionPoint.self)
    manager.register(TaskProducersExtension(), type: TaskProducerExtensionPoint.self)
    manager.register(MacCatalystInfoExtension(), type: SDKVariantInfoExtensionPoint.self)
    manager.register(ApplePlatformInfoExtension(), type: PlatformInfoExtensionPoint.self)
    manager.register(AppleSettingsBuilderExtension(), type: SettingsBuilderExtensionPoint.self)
}

struct AppleDeveloperDirectoryExtension: DeveloperDirectoryExtension {
    func fallbackDeveloperDirectory(hostOperatingSystem: OperatingSystem) async throws -> Path? {
        try await hostOperatingSystem == .macOS ? Xcode.getActiveDeveloperDirectoryPath() : nil
    }
}

struct TaskProducersExtension: TaskProducerExtension {

    func createPreSetupTaskProducers(_ context: TaskProducerContext) -> [any TaskProducer] {
        [DevelopmentAssetsTaskProducer(context)]
    }

    var setupTaskProducers: [any TaskProducerFactory] {
        [RealityAssetsTaskProducerFactory()]
    }

    var unorderedPostSetupTaskProducers: [any TaskProducerFactory] {
        [
            StubBinaryTaskProducerFactory()
        ]
    }

    var unorderedPostBuildPhasesTaskProducers: [any TaskProducerFactory] {
        [
            AppIntentsMetadataTaskProducerFactory()
        ]
    }

    var globalTaskProducers: [any GlobalTaskProducerFactory] {
        [StubBinaryTaskProducerFactory()]
    }
}

struct StubBinaryTaskProducerFactory: TaskProducerFactory, GlobalTaskProducerFactory {
    var name: String {
        "StubBinaryTaskProducer"
    }

    func createTaskProducer(_ context: TargetTaskProducerContext, startPhaseNodes: [PlannedVirtualNode], endPhaseNode: PlannedVirtualNode) -> any TaskProducer {
        StubBinaryTaskProducer(context, phaseStartNodes: startPhaseNodes, phaseEndNode: endPhaseNode)
    }

    func createGlobalTaskProducer(_ globalContext: TaskProducerContext, targetContexts: [TaskProducerContext]) -> any TaskProducer {
        GlobalStubBinaryTaskProducer(context: globalContext, targetContexts: targetContexts)
    }
}

struct AppIntentsMetadataTaskProducerFactory : TaskProducerFactory {
    var name: String {
        "AppIntentsMetadataTaskProducer"
    }

    func createTaskProducer(_ context: TargetTaskProducerContext, startPhaseNodes: [PlannedVirtualNode], endPhaseNode: PlannedVirtualNode) -> any TaskProducer {
        AppIntentsMetadataTaskProducer(context, phaseStartNodes: startPhaseNodes, phaseEndNode: endPhaseNode)
    }
}

struct RealityAssetsTaskProducerFactory: TaskProducerFactory {
    var name: String {
        "RealityAssetsTaskProducer"
    }

    func createTaskProducer(_ context: TargetTaskProducerContext, startPhaseNodes: [PlannedVirtualNode], endPhaseNode: PlannedVirtualNode) -> any TaskProducer {
        RealityAssetsTaskProducer(context, phaseStartNodes: startPhaseNodes, phaseEndNode: endPhaseNode)
    }
}

struct ApplePlatformSpecsExtension: SpecificationsExtension {
    func specificationClasses() -> [any SpecIdentifierType.Type] {
        [
            ActoolCompilerSpec.self,
            AppIntentsMetadataCompilerSpec.self,
            AppIntentsSSUTrainingCompilerSpec.self,
            CoreDataModelCompilerSpec.self,
            CoreMLCompilerSpec.self,
            CopyTiffFileSpec.self,
            CopyXCAppExtensionPointsFileSpec.self,
            DittoToolSpec.self,
            IBStoryboardLinkerCompilerSpec.self,
            IIGCompilerSpec.self,
            IbtoolCompilerSpecNIB.self,
            IbtoolCompilerSpecStoryboard.self,
            InstrumentsPackageBuilderSpec.self,
            IntentsCompilerSpec.self,
            MetalCompilerSpec.self,
            MetalLinkerSpec.self,
            MigCompilerSpec.self,
            OpenCLCompilerSpec.self,
            RealityAssetsCompilerSpec.self,
            ReferenceObjectCompilerSpec.self,
            ResMergerLinkerSpec.self,
            SceneKitToolSpec.self,
            XCStringsCompilerSpec.self,
        ]
    }

    func specificationFiles(resourceSearchPaths: [Path]) -> Bundle? {
        findResourceBundle(nameWhenInstalledInToolchain: "SwiftBuild_SWBApplePlatform", resourceSearchPaths: resourceSearchPaths, defaultBundle: Bundle.module)
    }

    func specificationDomains() -> [String : [String]] {
        var mappings = [
            "macosx": ["darwin"],
            "driverkit": ["darwin"],
            "embedded-shared": ["darwin"],
            "embedded": ["embedded-shared"],
            "embedded-simulator": ["embedded-shared"],
        ]
        for platform in ["iphone", "appletv", "watch", "xr"] {
            mappings["\(platform)os"] = ["\(platform)os-shared", "embedded"]
            mappings["\(platform)simulator"] = ["\(platform)os-shared", "embedded-simulator"]
        }
        return mappings
    }
}

struct ActoolInputFileGroupingStrategyExtension: InputFileGroupingStrategyExtension {
    func groupingStrategies() -> [String: any InputFileGroupingStrategyFactory] {
        struct Factory: InputFileGroupingStrategyFactory {
            func makeStrategy(specIdentifier: String) -> any InputFileGroupingStrategy {
                ActoolInputFileGroupingStrategy(groupIdentifier: specIdentifier)
            }
        }
        return ["actool": Factory()]
    }

    func fileTypesCompilingToSwiftSources() -> [String] {
        return ["folder.abstractassetcatalog"]
    }
}

struct ImageScaleFactorsInputFileGroupingStrategyExtension: InputFileGroupingStrategyExtension {
    func groupingStrategies() -> [String: any InputFileGroupingStrategyFactory] {
        struct Factory: InputFileGroupingStrategyFactory {
            func makeStrategy(specIdentifier: String) -> any InputFileGroupingStrategy {
                ImageScaleFactorsInputFileGroupingStrategy(toolName: specIdentifier)
            }
        }
        return ["image-scale-factors": Factory()]
    }

    func fileTypesCompilingToSwiftSources() -> [String] {
        return []
    }
}

struct LocalizationInputFileGroupingStrategyExtension: InputFileGroupingStrategyExtension {
    func groupingStrategies() -> [String: any InputFileGroupingStrategyFactory] {
        struct Factory: InputFileGroupingStrategyFactory {
            func makeStrategy(specIdentifier: String) -> any InputFileGroupingStrategy {
                LocalizationInputFileGroupingStrategy(toolName: specIdentifier)
            }
        }
        return ["region": Factory()]
    }

    func fileTypesCompilingToSwiftSources() -> [String] {
        return []
    }
}

struct XCStringsInputFileGroupingStrategyExtension: InputFileGroupingStrategyExtension {
    func groupingStrategies() -> [String: any InputFileGroupingStrategyFactory] {
        struct Factory: InputFileGroupingStrategyFactory {
            func makeStrategy(specIdentifier: String) -> any InputFileGroupingStrategy {
                XCStringsInputFileGroupingStrategy(toolName: specIdentifier)
            }
        }
        return ["xcstrings": Factory()]
    }

    func fileTypesCompilingToSwiftSources() -> [String] {
        return []
    }
}

struct ApplePlatformInfoExtension: PlatformInfoExtension {
    func knownDeploymentTargetMacroNames() -> Set<String> {
        [
            "MACOSX_DEPLOYMENT_TARGET",
            "IPHONEOS_DEPLOYMENT_TARGET",
            "TVOS_DEPLOYMENT_TARGET",
            "WATCHOS_DEPLOYMENT_TARGET",
            "DRIVERKIT_DEPLOYMENT_TARGET",
            "XROS_DEPLOYMENT_TARGET",
        ]
    }

    func preferredArchValue(for platformName: String) -> String? {
        // FIXME: rdar://65011964 (Remove PLATFORM_PREFERRED_ARCH)
        // Don't add values for any new platforms
        switch platformName {
        case "macosx", "iphonesimulator", "appletvsimulator", "watchsimulator":
            return "x86_64"
        case "iphoneos", "appletvos", "watchos":
            return "arm64"
        default:
            return nil
        }
    }
}

struct AppleSettingsBuilderExtension: SettingsBuilderExtension {
    func addSDKSettings(_ sdk: SDK, _ variant: SDKVariant?, _ sparseSDKs: [SDK]) throws -> [String : String] {
        guard variant?.llvmTargetTripleVendor == "apple" else {
            return [:]
        }

        return [
            "PER_ARCH_MODULE_FILE_DIR": "$(PER_ARCH_OBJECT_FILE_DIR)",
        ]
    }

    func addBuiltinDefaults(fromEnvironment environment: [String : String], parameters: BuildParameters) throws -> [String : String] { [:] }
    func addOverrides(fromEnvironment: [String : String], parameters: BuildParameters) throws -> [String : String] { [:] }
    func addProductTypeDefaults(productType: ProductTypeSpec) -> [String : String] { [:] }
    func addSDKOverridingSettings(_ sdk: SDK, _ variant: SDKVariant?, _ sparseSDKs: [SDK], specLookupContext: any SWBCore.SpecLookupContext) throws -> [String : String] { [:] }
    func addPlatformSDKSettings(_ platform: SWBCore.Platform?, _ sdk: SDK, _ sdkVariant: SDKVariant?) -> [String : String] { [:] }
    func xcconfigOverrideData(fromParameters: BuildParameters) -> ByteString { ByteString() }
    func getTargetTestingSwiftPluginFlags(_ scope: MacroEvaluationScope, toolchainRegistry: ToolchainRegistry, sdkRegistry: SDKRegistry, activeRunDestination: RunDestinationInfo?, project: SWBCore.Project?) -> [String] { [] }
    func shouldSkipPopulatingValidArchs(platform: SWBCore.Platform) -> Bool { false }
    func shouldDisableXOJITPreviews(platformName: String, sdk: SDK?) -> Bool { false }
    func overridingBuildSettings(_: MacroEvaluationScope, platform: SWBCore.Platform?, productType: ProductTypeSpec) -> [String : String] { [:] }
}