wip

Author: aciidgh

Sources/Build/BuildDelegate.swift

@@ -195,6 +195,8 @@ public struct BuildDescription: Codable {
     /// The map of test discovery commands.
     let testDiscoveryCommands: [CommandName: TestDiscoveryTool]
 
+    let copyCommands: [CommandName: CopyTool]
+
     /// The built test products.
     public let builtTestProducts: [BuiltTestProduct]
 
@@ -204,7 +206,11 @@ public struct BuildDescription: Codable {
     /// The list of executable products in the root package.
     public let rootExecutables: [String]
 
-    public init(plan: BuildPlan, testDiscoveryCommands: [CommandName: TestDiscoveryTool]) {
+    public init(
+        plan: BuildPlan,
+        testDiscoveryCommands: [CommandName: TestDiscoveryTool],
+        copyCommands: [CommandName: CopyTool]
+    ) {
         let buildConfig = plan.buildParameters.configuration.dirname
 
         swiftTargetMap = Dictionary(uniqueKeysWithValues: plan.targetMap.values.compactMap{
@@ -213,6 +219,7 @@ public struct BuildDescription: Codable {
         })
 
         self.testDiscoveryCommands = testDiscoveryCommands
+        self.copyCommands = copyCommands
 
         self.builtTestProducts = plan.buildProducts.filter{ $0.product.type == .test }.map { desc in
             // FIXME(perf): Provide faster lookups.
@@ -309,6 +316,32 @@ final class PackageStructureCommand: CustomLLBuildCommand {
     }
 }
 
+final class CopyCommand: CustomLLBuildCommand {
+    override func execute(_ command: SPMLLBuild.Command) -> Bool {
+        // This tool will never run without the build description.
+        let buildDescription = ctx.buildDescription!
+        guard let tool = buildDescription.copyCommands[command.name] else {
+            print("command \(command.name) not registered")
+            return false
+        }
+
+        do {
+            let input = tool.inputs[0]
+            let output = tool.outputs[0]
+            try localFileSystem.createDirectory(AbsolutePath(output).parentDirectory, recursive: true)
+
+            // FIXME: We should shim this through our FileSystem APIs.
+            try? FileManager.default.removeItem(atPath: output)
+            try FileManager.default.copyItem(atPath: input, toPath: output)
+        } catch {
+            // FIXME: Shouldn't use "print" here.
+            print("error:", error)
+            return false
+        }
+        return true
+    }
+}
+
 private let newLineByte: UInt8 = 10
 public final class BuildDelegate: BuildSystemDelegate, SwiftCompilerOutputParserDelegate {
     private let diagnostics: DiagnosticsEngine
@@ -352,6 +385,8 @@ public final class BuildDelegate: BuildSystemDelegate, SwiftCompilerOutputParser
             return InProcessTool(buildExecutionContext, type: TestDiscoveryCommand.self)
         case PackageStructureTool.name:
             return InProcessTool(buildExecutionContext, type: PackageStructureCommand.self)
+        case CopyTool.name:
+            return InProcessTool(buildExecutionContext, type: CopyCommand.self)
         default:
             return nil
         }

Sources/Build/BuildPlan.swift

@@ -504,6 +504,9 @@ public final class SwiftTargetBuildDescription {
     /// These are the source files generated during the build.
     private var derivedSources: Sources
 
+    /// Path to the bundle generated for this module (if any).
+    let bundlePath: AbsolutePath?
+
     /// The list of all source files in the target, including the derived ones.
     var sources: [AbsolutePath] { target.sources.paths + derivedSources.paths }
 
@@ -567,6 +570,9 @@ public final class SwiftTargetBuildDescription {
         self.fs = fs
         self.tempsPath = buildParameters.buildPath.appending(component: target.c99name + ".build")
         self.derivedSources = Sources(paths: [], root: tempsPath.appending(component: "DerivedSources"))
+        self.bundlePath = target.underlyingTarget.bundleName
+            .map{ $0 + buildParameters.triple.nsbundleExtension }
+            .map(buildParameters.buildPath.appending(component:))
 
         if shouldEmitObjCCompatibilityHeader {
             self.moduleMap = try self.generateModuleMap()
@@ -578,10 +584,10 @@ public final class SwiftTargetBuildDescription {
     /// Generate the resource bundle accessor, if appropriate.
     private func generateResourceAccessor() throws {
         // Do nothing if we're not generating a bundle.
-        guard let bundleName = target.underlyingTarget.bundleName else { return }
+        guard let bundlePath = self.bundlePath else { return }
 
         // Compute the basename of the bundle.
-        let bundleBasename = bundleName + buildParameters.triple.nsbundleExtension
+        let bundleBasename = bundlePath.basename
 
         let stream = BufferedOutputByteStream()
         stream <<< """
@@ -602,8 +608,13 @@ public final class SwiftTargetBuildDescription {
         // Write this file out.
         // FIXME: We should generate this file during the actual build.
         let path = derivedSources.root.appending(subpath)
-
         try fs.createDirectory(path.parentDirectory, recursive: true)
+
+        // Return early if the contents are identical.
+        if fs.isFile(path), try fs.readFileContents(path) == stream.bytes {
+            return
+        }
+
         try fs.writeFileContents(path, bytes: stream.bytes)
     }
 

Sources/Build/ToolProtocol.swift

@@ -52,6 +52,19 @@ public struct TestDiscoveryTool: ToolProtocol, Codable {
     }
 }
 
+public struct CopyTool: ToolProtocol, Codable {
+    static let name: String = "copy-tool"
+
+    public let inputs: [String]
+    public let outputs: [String]
+
+    public func append(to stream: OutputByteStream) {
+        stream <<< "    tool: \(Self.name)\n"
+        stream <<< "    inputs: " <<< Format.asJSON(inputs) <<< "\n"
+        stream <<< "    outputs: " <<< Format.asJSON(outputs) <<< "\n"
+    }
+}
+
 /// Package strcuture tool is used to determine if the package has changed in some way
 /// that requires regenerating the build manifest file. This allows us to skip a lot of
 /// redundent work (package graph loading, build planning, manifest generation) during

Sources/Build/llbuild.swift

@@ -210,6 +210,8 @@ public final class LLBuildManifestGenerator {
     /// Map of command -> tool that is used during the build for in-process tools.
     public private(set) var testDiscoveryCommands: [String: TestDiscoveryTool] = [:]
 
+    public private(set) var copyCommands: [String: CopyTool] = [:]
+
     /// Create a llbuild target for a product description.
     private func createProductTarget(_ buildProduct: ProductBuildDescription) -> Target {
         let tool: ToolProtocol
@@ -310,9 +312,34 @@ public final class LLBuildManifestGenerator {
             buildTarget.cmds.insert(Command(name: target.wrappedModuleOutputPath.pathString, tool: modulewrapTool))
         }
 
+        createResourcesBundle(for: target, buildTarget: &buildTarget)
+
         return buildTarget
     }
 
+    private func createResourcesBundle(
+        for target: SwiftTargetBuildDescription,
+        buildTarget: inout Target
+    )  {
+        guard let bundlePath = target.bundlePath else { return }
+
+        var cmds: [Command] = []
+
+        for item in target.target.underlyingTarget.resources {
+            switch item.rule {
+            case .copy, .process:
+                let output = bundlePath.appending(component: item.path.basename)
+                let tool = CopyTool(inputs: [item.path.pathString], outputs: [output.pathString])
+                let cmd = Command(name: output.pathString, tool: tool)
+                copyCommands[cmd.name] = tool
+                cmds.append(cmd)
+            }
+        }
+
+        buildTarget.cmds += cmds
+        buildTarget.outputs += cmds.flatMap{ $0.tool.outputs }
+    }
+
     /// Create a llbuild target for a Clang target description.
     private func createClangCompileTarget(_ target: ClangTargetBuildDescription) throws -> Target {
 

Sources/Commands/SwiftTool.swift

@@ -674,7 +674,11 @@ public class SwiftTool<Options: ToolOptions> {
         try llbuild.generateManifest(at: plan.buildParameters.llbuildManifest)
 
         // Create the build description.
-        let buildDescription = BuildDescription(plan: plan, testDiscoveryCommands: llbuild.testDiscoveryCommands)
+        let buildDescription = BuildDescription(
+            plan: plan,
+            testDiscoveryCommands: llbuild.testDiscoveryCommands,
+            copyCommands: llbuild.copyCommands
+        )
         try localFileSystem.createDirectory(plan.buildParameters.buildDescriptionPath.parentDirectory, recursive: true)
         try buildDescription.write(to: plan.buildParameters.buildDescriptionPath)
         return buildDescription

Sources/PackageLoading/PackageBuilder.swift

@@ -718,6 +718,7 @@ public final class PackageBuilder {
 
         // Create the build setting assignment table for this target.
         let buildSettings = try self.buildSettings(for: manifestTarget, targetRoot: potentialModule.path)
+        let resources = self.computeResources(for: manifestTarget, targetRoot: potentialModule.path)
 
         // Create and return the right kind of target depending on what kind of sources we found.
         if clangSources.isEmpty {
@@ -729,7 +730,7 @@ public final class PackageBuilder {
             var bundleName: String?
             // FIXME: This needs to depend on if we have *any* resources, not just explicitly
             // declared ones.
-            if manifestTarget?.resources.isEmpty == false {
+            if !resources.isEmpty {
                 bundleName = manifest.name + "_" + potentialModule.name
             }
 
@@ -740,6 +741,7 @@ public final class PackageBuilder {
                 platforms: self.platforms(),
                 isTest: potentialModule.isTest,
                 sources: Sources(paths: swiftSources, root: potentialModule.path),
+                resources: resources,
                 dependencies: moduleDependencies,
                 productDependencies: productDeps,
                 swiftVersion: try swiftVersion(),
@@ -768,6 +770,23 @@ public final class PackageBuilder {
         }
     }
 
+    /// Compute the resources in the target.
+    // FIXME: This is prelimary logic just to get things started.
+    func computeResources(
+        for target: TargetDescription?,
+        targetRoot: AbsolutePath
+    ) -> [Resource] {
+        guard let target = target else { return [] }
+        var result: [Resource] = []
+
+        for resource in target.resources {
+            let path = targetRoot.appending(RelativePath(resource.path))
+            result += [Resource(rule: resource.rule, path: path)]
+        }
+
+        return result
+    }
+
     /// Creates build setting assignment table for the given target.
     func buildSettings(for target: TargetDescription?, targetRoot: AbsolutePath) throws -> BuildSettings.AssignmentTable {
         var table = BuildSettings.AssignmentTable()

Sources/PackageModel/CMakeLists.txt

@@ -14,6 +14,7 @@ add_library(PackageModel
   Platform.swift
   Product.swift
   ResolvedModels.swift
+  Resources.swift
   Sources.swift
   Target.swift
   ToolsVersion.swift)

Sources/PackageModel/Resource.swift

@@ -0,0 +1,27 @@
+/*
+ This source file is part of the Swift.org open source project
+
+ Copyright (c) 2014 - 2019 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 Swift project authors
+*/
+
+import TSCBasic
+
+/// An individual resource file and its corresponding rule.
+public struct Resource {
+    public typealias Rule = TargetDescription.Resource.Rule
+
+    /// The rule associated with this resource.
+    public let rule: Rule
+
+    /// The path of the resource file.
+    public let path: AbsolutePath
+
+    public init(rule: Rule, path: AbsolutePath) {
+        self.rule = rule
+        self.path = path
+    }
+}

Sources/PackageModel/Target.swift

@@ -46,6 +46,9 @@ public class Target: ObjectIdentifierProtocol {
     /// The sources for the target.
     public let sources: Sources
 
+    /// The resource files in the target.
+    public let resources: [Resource]
+
     /// The list of platforms that are supported by this target.
     public let platforms: [SupportedPlatform]
 
@@ -63,6 +66,7 @@ public class Target: ObjectIdentifierProtocol {
         platforms: [SupportedPlatform],
         type: Kind,
         sources: Sources,
+        resources: [Resource] = [],
         dependencies: [Target],
         productDependencies: [(name: String, package: String?)] = [],
         buildSettings: BuildSettings.AssignmentTable
@@ -72,6 +76,7 @@ public class Target: ObjectIdentifierProtocol {
         self.platforms = platforms
         self.type = type
         self.sources = sources
+        self.resources = resources
         self.dependencies = dependencies
         self.productDependencies = productDependencies
         self.c99name = self.name.spm_mangledToC99ExtendedIdentifier()
@@ -136,6 +141,7 @@ public class SwiftTarget: Target {
         platforms: [SupportedPlatform] = [],
         isTest: Bool = false,
         sources: Sources,
+        resources: [Resource] = [],
         dependencies: [Target] = [],
         productDependencies: [(name: String, package: String?)] = [],
         swiftVersion: SwiftLanguageVersion,
@@ -149,6 +155,7 @@ public class SwiftTarget: Target {
             platforms: platforms,
             type: type,
             sources: sources,
+            resources: resources,
             dependencies: dependencies,
             productDependencies: productDependencies,
             buildSettings: buildSettings