Make bridgingPrecompiledHeader a let constant

Author: cltnschlosser

Sources/SwiftDriver/Driver/Driver.swift

@@ -9,6 +9,8 @@
 // See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
 //
 //===----------------------------------------------------------------------===//
+
+import Foundation
 import TSCBasic
 import TSCUtility
 
@@ -125,7 +127,7 @@ public struct Driver {
   public let importedObjCHeader: VirtualPath?
 
   /// The path to the pch for the imported Objective-C header.
-  public var bridgingPrecompiledHeader: VirtualPath?
+  public let bridgingPrecompiledHeader: VirtualPath?
 
   /// Path to the dependencies file.
   public let dependenciesFilePath: VirtualPath?
@@ -292,6 +294,7 @@ public struct Driver {
     self.sdkPath = Self.computeSDKPath(&parsedOptions, compilerMode: compilerMode, toolchain: toolchain, diagnosticsEngine: diagnosticEngine, env: env)
 
     self.importedObjCHeader = try Self.computeImportedObjCHeader(&parsedOptions, compilerMode: compilerMode, diagnosticEngine: diagnosticEngine)
+    self.bridgingPrecompiledHeader = try Self.computeBridgingPrecompiledHeader(&parsedOptions, importedObjCHeader: importedObjCHeader)
 
     self.enabledSanitizers = try Self.parseSanitizerArgValues(&parsedOptions, diagnosticEngine: diagnosticEngine, toolchain: toolchain, targetTriple: targetTriple)
 
@@ -1335,11 +1338,39 @@ extension Driver {
       diagnosticEngine.emit(.error_bridging_header_module_interface)
     }
 
-    return try VirtualPath(path: objcHeaderPathArg.asSingle)
+    let objcHeader = try VirtualPath(path: objcHeaderPathArg.asSingle)
+    
+    if objcHeader.extension != FileType.objcHeader.rawValue {
+      diagnosticEngine.emit(.error_objc_header_not_header)
+    }
+    
+    return objcHeader
+  }
+  
+  /// Compute the path of the generated bridging PCH for the Objective-C header.
+  static func computeBridgingPrecompiledHeader(_ parsedOptions: inout ParsedOptions, importedObjCHeader: VirtualPath?) throws -> VirtualPath? {
+    guard let input = importedObjCHeader,
+      parsedOptions.hasFlag(positive: .enableBridgingPch, negative: .disableBridgingPch, default: true) else {
+        return nil
+    }
+    // FIXME: should have '-.*' at the end of the filename, similar to llvm::sys::fs::createTemporaryFile
+    let pchFileName = input.basenameWithoutExt.appendingFileTypeExtension(.pch)
+    let output: VirtualPath
+    if let outputDirectory = parsedOptions.getLastArgument(.pchOutputDir)?.asSingle {
+      let outputPath = (outputDirectory as NSString).appendingPathComponent(pchFileName)
+      output = try VirtualPath(path: outputPath)
+    } else {
+      output = .temporary(RelativePath(pchFileName))
+    }
+    return output
   }
 }
 
 extension Diagnostic.Message {
+  static var error_objc_header_not_header: Diagnostic.Message {
+    .error("ObjC header needs to be .h file")
+  }
+  
   static var error_framework_bridging_header: Diagnostic.Message {
     .error("using bridging headers with framework targets is unsupported")
   }

Sources/SwiftDriver/Jobs/CompileJob.swift

@@ -26,7 +26,7 @@ extension Driver {
   }
 
   /// Add the compiler inputs for a frontend compilation job, and return the corresponding primary set of outputs.
-  mutating func addCompileInputs(primaryInputs: [TypedVirtualPath], inputs: inout [TypedVirtualPath], commandLine: inout [Job.ArgTemplate]) -> [TypedVirtualPath] {
+  func addCompileInputs(primaryInputs: [TypedVirtualPath], inputs: inout [TypedVirtualPath], commandLine: inout [Job.ArgTemplate]) -> [TypedVirtualPath] {
     // Collect the set of input files that are part of the Swift compilation.
     let swiftInputFiles: [TypedVirtualPath] = inputFiles.compactMap { inputFile in
       if inputFile.type.isPartOfSwiftCompilation {

Sources/SwiftDriver/Jobs/GeneratePCHJob.swift

@@ -15,7 +15,7 @@ import TSCBasic
 import TSCUtility
 
 extension Driver {
-  mutating func generatePCHJob(input: TypedVirtualPath) throws -> Job {
+  mutating func generatePCHJob(input: TypedVirtualPath, output: TypedVirtualPath) throws -> Job {
     var inputs = [TypedVirtualPath]()
     var outputs = [TypedVirtualPath]()
 
@@ -25,6 +25,8 @@ extension Driver {
     commandLine.appendPath(input.file)
     commandLine.appendFlag(.emitPch)
 
+    outputs.append(output)
+    
     try addCommonFrontendOptions(commandLine: &commandLine)
 
     if let importedObjCHeader = importedObjCHeader {
@@ -34,6 +36,7 @@ extension Driver {
 
     try commandLine.appendLast(.indexStorePath, from: &parsedOptions)
 
+    // TODO: Should this just be pch output with extension changed?
     if parsedOptions.hasArgument(.serializeDiagnostics), let outputDirectory = parsedOptions.getLastArgument(.pchOutputDir)?.asSingle {
       commandLine.appendFlag(.serializeDiagnosticsPath)
       let path: VirtualPath
@@ -52,20 +55,12 @@ extension Driver {
       outputs.append(.init(file: path, type: .diagnostics))
     }
 
-    // FIXME: should have '-.*' at the end of the filename, similar to llvm::sys::fs::createTemporaryFile
-    let pchFileName = input.file.basenameWithoutExt.appendingFileTypeExtension(.pch)
-    let output: VirtualPath
-    if let outputDirectory = parsedOptions.getLastArgument(.pchOutputDir)?.asSingle {
-      let outputPath = (outputDirectory as NSString).appendingPathComponent(pchFileName)
-      output = try VirtualPath(path: outputPath)
+    if parsedOptions.hasArgument(.pchOutputDir) {
       try commandLine.appendLast(.pchOutputDir, from: &parsedOptions)
     } else {
-      output = .temporary(RelativePath(pchFileName))
       commandLine.appendFlag(.o)
-      commandLine.appendPath(output)
+      commandLine.appendPath(output.file)
     }
-    outputs.append(.init(file: output, type: .pch))
-    bridgingPrecompiledHeader = output
 
     return Job(
       kind: .generatePCH,

Sources/SwiftDriver/Jobs/Planning.swift

@@ -47,9 +47,9 @@ extension Driver {
     }
 
     if let importedObjCHeader = importedObjCHeader,
-        parsedOptions.hasFlag(positive: .enableBridgingPch, negative: .disableBridgingPch, default: true),
-        importedObjCHeader.extension == FileType.objcHeader.rawValue {
-        jobs.append(try generatePCHJob(input: .init(file: importedObjCHeader, type: .objcHeader)))
+      let bridgingPrecompiledHeader = bridgingPrecompiledHeader {
+      jobs.append(try generatePCHJob(input: .init(file: importedObjCHeader, type: .objcHeader),
+                                     output: .init(file: bridgingPrecompiledHeader, type: .pch)))
     }
 
     // If we should create emit module job, do so.

Tests/SwiftDriverTests/SwiftDriverTests.swift

@@ -1337,10 +1337,10 @@ final class SwiftDriverTests: XCTestCase {
       XCTAssertEqual(plannedJobs[0].inputs[0].file, .relative(RelativePath("TestInputHeader.h")))
       XCTAssertEqual(plannedJobs[0].inputs[0].type, .objcHeader)
       XCTAssertEqual(plannedJobs[0].outputs.count, 2)
-      XCTAssertEqual(plannedJobs[0].outputs[0].file, .temporary(RelativePath("TestInputHeader.dia")))
-      XCTAssertEqual(plannedJobs[0].outputs[0].type, .diagnostics)
-      XCTAssertEqual(plannedJobs[0].outputs[1].file, try VirtualPath(path: "/pch/TestInputHeader.pch"))
-      XCTAssertEqual(plannedJobs[0].outputs[1].type, .pch)
+      XCTAssertEqual(plannedJobs[0].outputs[0].file, try VirtualPath(path: "/pch/TestInputHeader.pch"))
+      XCTAssertEqual(plannedJobs[0].outputs[0].type, .pch)
+      XCTAssertEqual(plannedJobs[0].outputs[1].file, .temporary(RelativePath("TestInputHeader.dia")))
+      XCTAssertEqual(plannedJobs[0].outputs[1].type, .diagnostics)
       XCTAssert(plannedJobs[0].commandLine.contains(.flag("-serialize-diagnostics-path")))
       XCTAssert(plannedJobs[0].commandLine.contains(.path(.temporary(RelativePath("TestInputHeader.dia")))))
       XCTAssert(plannedJobs[0].commandLine.contains(.flag("-emit-pch")))
@@ -1363,10 +1363,10 @@ final class SwiftDriverTests: XCTestCase {
       XCTAssertEqual(plannedJobs[0].inputs[0].file, .relative(RelativePath("TestInputHeader.h")))
       XCTAssertEqual(plannedJobs[0].inputs[0].type, .objcHeader)
       XCTAssertEqual(plannedJobs[0].outputs.count, 2)
-      XCTAssertNotNil(plannedJobs[0].outputs[0].file.name.range(of: #"/pch/TestInputHeader-.*.dia"#, options: .regularExpression))
-      XCTAssertEqual(plannedJobs[0].outputs[0].type, .diagnostics)
-      XCTAssertEqual(plannedJobs[0].outputs[1].file, try VirtualPath(path: "/pch/TestInputHeader.pch"))
-      XCTAssertEqual(plannedJobs[0].outputs[1].type, .pch)
+      XCTAssertEqual(plannedJobs[0].outputs[0].file, try VirtualPath(path: "/pch/TestInputHeader.pch"))
+      XCTAssertEqual(plannedJobs[0].outputs[0].type, .pch)
+      XCTAssertNotNil(plannedJobs[0].outputs[1].file.name.range(of: #"/pch/TestInputHeader-.*.dia"#, options: .regularExpression))
+      XCTAssertEqual(plannedJobs[0].outputs[1].type, .diagnostics)
       XCTAssert(plannedJobs[0].commandLine.contains(.flag("-serialize-diagnostics-path")))
       XCTAssert(plannedJobs[0].commandLine.contains {
         guard case .path(let path) = $0 else { return false }