Skip to content

Fixup module source info output #152

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 1, 2020
Merged

Fixup module source info output #152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9688f0c
Fixup module source info output
cltnschlosser Jun 30, 2020
9388a93
testDOTFileEmission add -avoid-emit-module-source-info flag
cltnschlosser Jun 30, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 68 additions & 24 deletions Sources/SwiftDriver/Driver/Driver.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -400,6 +400,13 @@ public struct Driver {
compilerMode: compilerMode,
outputFileMap: self.outputFileMap,
moduleName: moduleOutputInfo.name)
self.moduleSourceInfoPath = try Self.computeModuleSourceInfoOutputPath(
&parsedOptions,
moduleOutputPath: self.moduleOutputInfo.output?.outputPath,
compilerOutputType: compilerOutputType,
compilerMode: compilerMode,
outputFileMap: self.outputFileMap,
moduleName: moduleOutputInfo.name)
self.swiftInterfacePath = try Self.computeSupplementaryOutputPath(
&parsedOptions, type: .swiftInterface, isOutput: .emitModuleInterface,
outputPath: .emitModuleInterfacePath,
Expand All @@ -415,14 +422,6 @@ public struct Driver {
compilerMode: compilerMode,
outputFileMap: self.outputFileMap,
moduleName: moduleOutputInfo.name)
self.moduleSourceInfoPath = try Self.computeSupplementaryOutputPath(
&parsedOptions, type: .swiftSourceInfoFile,
isOutput: .emitModuleSourceInfo,
outputPath: .emitModuleSourceInfoPath,
compilerOutputType: compilerOutputType,
compilerMode: compilerMode,
outputFileMap: self.outputFileMap,
moduleName: moduleOutputInfo.name)
}
}

Expand Down Expand Up @@ -1707,33 +1706,79 @@ extension Driver {
outputFileMap: OutputFileMap?,
moduleName: String
) throws -> VirtualPath? {
// If there is an explicit argument for the output path, use that
if let outputPathArg = parsedOptions.getLastArgument(.emitModuleDocPath) {
// Consume -emit-module-doc if it's there.
_ = parsedOptions.hasArgument(.emitModuleDoc)
return try computeModuleAuxiliaryOutputPath(&parsedOptions,
moduleOutputPath: moduleOutputPath,
type: .swiftDocumentation,
isOutput: .emitModuleDoc,
outputPath: .emitModuleDocPath,
compilerOutputType: compilerOutputType,
compilerMode: compilerMode,
outputFileMap: outputFileMap,
moduleName: moduleName)
}

/// Determine the output path for a module source info.
static func computeModuleSourceInfoOutputPath(
_ parsedOptions: inout ParsedOptions,
moduleOutputPath: VirtualPath?,
compilerOutputType: FileType?,
compilerMode: CompilerMode,
outputFileMap: OutputFileMap?,
moduleName: String
) throws -> VirtualPath? {
guard !parsedOptions.hasArgument(.avoidEmitModuleSourceInfo) else { return nil }
return try computeModuleAuxiliaryOutputPath(&parsedOptions,
moduleOutputPath: moduleOutputPath,
type: .swiftSourceInfoFile,
isOutput: .emitModuleSourceInfo,
outputPath: .emitModuleSourceInfoPath,
compilerOutputType: compilerOutputType,
compilerMode: compilerMode,
outputFileMap: outputFileMap,
moduleName: moduleName)
}


/// Determine the output path for a module auxiliary output.
static func computeModuleAuxiliaryOutputPath(
_ parsedOptions: inout ParsedOptions,
moduleOutputPath: VirtualPath?,
type: FileType,
isOutput: Option?,
outputPath: Option,
compilerOutputType: FileType?,
compilerMode: CompilerMode,
outputFileMap: OutputFileMap?,
moduleName: String
) throws -> VirtualPath? {
// If there is an explicit argument for the output path, use that
if let outputPathArg = parsedOptions.getLastArgument(outputPath) {
// Consume the isOutput argument
if let isOutput = isOutput {
_ = parsedOptions.hasArgument(isOutput)
}
return try VirtualPath(path: outputPathArg.asSingle)
}

// If this is a single-file compile and there is an entry in the
// output file map, use that.
if compilerMode.isSingleCompilation,
let singleOutputPath = outputFileMap?.existingOutputForSingleInput(
outputType: .swiftDocumentation) {
outputType: type) {
return singleOutputPath
}

// If there's a known module output path, put the .swiftdoc file next
// to it.
// If there's a known module output path, put the file next to it.
if let moduleOutputPath = moduleOutputPath {
// Consume -emit-module-doc if it's there.
_ = parsedOptions.hasArgument(.emitModuleDoc)
if let isOutput = isOutput {
_ = parsedOptions.hasArgument(isOutput)
}

return try moduleOutputPath.replacingExtension(with: .swiftDocumentation)
return try moduleOutputPath.replacingExtension(with: type)
}

// If not specifically asked to emit Swift module documentation, don't.
if !parsedOptions.hasArgument(.emitModuleDoc) {
// If the output option was not provided, don't produce this output at all.
guard let isOutput = isOutput, parsedOptions.hasArgument(isOutput) else {
return nil
}

Expand All @@ -1742,14 +1787,13 @@ extension Driver {
let path = try VirtualPath(path: outputPathArg.asSingle)

// If the compiler output is of this type, use the argument directly.
if compilerOutputType == .swiftDocumentation {
if type == compilerOutputType {
return path
}

// Otherwise, put this output alongside the requested output.
return try path.replacingExtension(with: .swiftDocumentation)
return try path.replacingExtension(with: type)
}

return try VirtualPath(path: moduleName.appendingFileTypeExtension(.swiftDocumentation))
return try VirtualPath(path: moduleName.appendingFileTypeExtension(type))
}
}
2 changes: 1 addition & 1 deletion Sources/SwiftDriver/Jobs/FrontendJobHelpers.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ extension Driver {
outputType: .swiftSourceInfoFile,
finalOutputPath: moduleSourceInfoPath,
input: input,
flag: "-emit-module-source-info")
flag: "-emit-module-source-info-path")
addOutputOfType(
outputType: .dependencies,
finalOutputPath: dependenciesFilePath,
Expand Down
73 changes: 52 additions & 21 deletions Tests/SwiftDriverTests/SwiftDriverTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1179,7 +1179,7 @@ final class SwiftDriverTests: XCTestCase {
XCTAssertEqual(plannedJobs[0].inputs.count, 2)
XCTAssertEqual(plannedJobs[0].inputs[0].file, VirtualPath.relative(RelativePath("main.swift")))
XCTAssertEqual(plannedJobs[0].inputs[1].file, VirtualPath.relative(RelativePath("multi-threaded.swift")))
XCTAssertEqual(plannedJobs[0].outputs.count, 2)
XCTAssertEqual(plannedJobs[0].outputs.count, 3)
XCTAssertEqual(plannedJobs[0].outputs[0].file, VirtualPath.relative(RelativePath("test.swiftmodule")))
}
}
Expand Down Expand Up @@ -1217,25 +1217,28 @@ final class SwiftDriverTests: XCTestCase {

func testMergeModulesOnly() throws {
do {
var driver = try Driver(args: ["swiftc", "foo.swift", "bar.swift", "-module-name", "Test", "-emit-module", "-disable-bridging-pch", "-import-objc-header", "TestInputHeader.h", "-emit-dependencies", "-emit-module-doc-path", "/foo/bar/Test.swiftdoc"])
var driver = try Driver(args: ["swiftc", "foo.swift", "bar.swift", "-module-name", "Test", "-emit-module", "-disable-bridging-pch", "-import-objc-header", "TestInputHeader.h", "-emit-dependencies", "-emit-module-doc-path", "/foo/bar/Test.swiftdoc", "-emit-module-source-info-path", "/foo/bar/Test.swiftsourceinfo"])
let plannedJobs = try driver.planBuild()
XCTAssertEqual(plannedJobs.count, 3)
XCTAssertEqual(plannedJobs[0].outputs.count, 3)
XCTAssertEqual(plannedJobs[0].outputs.count, 4)
XCTAssertEqual(plannedJobs[0].outputs[0].file, .temporary(RelativePath("foo.swiftmodule")))
XCTAssertEqual(plannedJobs[0].outputs[1].file, .temporary(RelativePath("foo.swiftdoc")))
XCTAssertEqual(plannedJobs[0].outputs[2].file, .temporary(RelativePath("foo.d")))
XCTAssertEqual(plannedJobs[0].outputs[2].file, .temporary(RelativePath("foo.swiftsourceinfo")))
XCTAssertEqual(plannedJobs[0].outputs[3].file, .temporary(RelativePath("foo.d")))
XCTAssert(plannedJobs[0].commandLine.contains(.flag("-import-objc-header")))

XCTAssertEqual(plannedJobs[1].outputs.count, 3)
XCTAssertEqual(plannedJobs[1].outputs.count, 4)
XCTAssertEqual(plannedJobs[1].outputs[0].file, .temporary(RelativePath("bar.swiftmodule")))
XCTAssertEqual(plannedJobs[1].outputs[1].file, .temporary(RelativePath("bar.swiftdoc")))
XCTAssertEqual(plannedJobs[1].outputs[2].file, .temporary(RelativePath("bar.d")))
XCTAssertEqual(plannedJobs[1].outputs[2].file, .temporary(RelativePath("bar.swiftsourceinfo")))
XCTAssertEqual(plannedJobs[1].outputs[3].file, .temporary(RelativePath("bar.d")))
XCTAssert(plannedJobs[1].commandLine.contains(.flag("-import-objc-header")))

XCTAssertTrue(plannedJobs[2].tool.name.contains("swift"))
XCTAssertEqual(plannedJobs[2].outputs.count, 3)
XCTAssertEqual(plannedJobs[2].outputs.count, 4)
XCTAssertEqual(plannedJobs[2].outputs[0].file, .relative(RelativePath("Test.swiftmodule")))
XCTAssertEqual(plannedJobs[2].outputs[1].file, .absolute(AbsolutePath("/foo/bar/Test.swiftdoc")))
XCTAssertEqual(plannedJobs[2].outputs[2].file, .absolute(AbsolutePath("/foo/bar/Test.swiftsourceinfo")))
XCTAssert(plannedJobs[2].commandLine.contains(.flag("-import-objc-header")))
}

Expand All @@ -1244,9 +1247,10 @@ final class SwiftDriverTests: XCTestCase {
let plannedJobs = try driver.planBuild()
XCTAssertEqual(plannedJobs.count, 3)
XCTAssertTrue(plannedJobs[2].tool.name.contains("swift"))
XCTAssertEqual(plannedJobs[2].outputs.count, 2)
XCTAssertEqual(plannedJobs[2].outputs[0].file, VirtualPath.absolute(AbsolutePath("/foo/bar/Test.swiftmodule")))
XCTAssertEqual(plannedJobs[2].outputs.count, 3)
XCTAssertEqual(plannedJobs[2].outputs[0].file, .absolute(AbsolutePath("/foo/bar/Test.swiftmodule")))
XCTAssertEqual(plannedJobs[2].outputs[1].file, .absolute(AbsolutePath("/foo/bar/Test.swiftdoc")))
XCTAssertEqual(plannedJobs[2].outputs[2].file, .absolute(AbsolutePath("/foo/bar/Test.swiftsourceinfo")))
}

do {
Expand All @@ -1255,9 +1259,10 @@ final class SwiftDriverTests: XCTestCase {
let plannedJobs = try driver.planBuild()
XCTAssertEqual(plannedJobs.count, 3)
XCTAssertTrue(plannedJobs[2].tool.name.contains("swift"))
XCTAssertEqual(plannedJobs[2].outputs.count, 2)
XCTAssertEqual(plannedJobs[2].outputs.count, 3)
XCTAssertEqual(plannedJobs[2].outputs[0].file, .relative(RelativePath("Test.swiftmodule")))
XCTAssertEqual(plannedJobs[2].outputs[1].file, .relative(RelativePath("Test.swiftdoc")))
XCTAssertEqual(plannedJobs[2].outputs[2].file, .relative(RelativePath("Test.swiftsourceinfo")))
}

do {
Expand All @@ -1266,9 +1271,10 @@ final class SwiftDriverTests: XCTestCase {
let plannedJobs = try driver.planBuild()
XCTAssertEqual(plannedJobs.count, 3)
XCTAssertTrue(plannedJobs[2].tool.name.contains("swift"))
XCTAssertEqual(plannedJobs[2].outputs.count, 2)
XCTAssertEqual(plannedJobs[2].outputs.count, 3)
XCTAssertEqual(plannedJobs[2].outputs[0].file, .relative(RelativePath("Test.swiftmodule")))
XCTAssertEqual(plannedJobs[2].outputs[1].file, .relative(RelativePath("Test.swiftdoc")))
XCTAssertEqual(plannedJobs[2].outputs[2].file, .relative(RelativePath("Test.swiftsourceinfo")))
}

do {
Expand Down Expand Up @@ -1572,7 +1578,7 @@ final class SwiftDriverTests: XCTestCase {

func testDOTFileEmission() throws {
var driver = try Driver(args: [
"swiftc", "-emit-executable", "test.swift", "-emit-module"
"swiftc", "-emit-executable", "test.swift", "-emit-module", "-avoid-emit-module-source-info"
])
let plannedJobs = try driver.planBuild()

Expand Down Expand Up @@ -2106,10 +2112,11 @@ final class SwiftDriverTests: XCTestCase {
XCTAssertEqual(plannedJobs[0].kind, .compile)
XCTAssertEqual(plannedJobs[0].inputs.count, 1)
XCTAssertEqual(plannedJobs[0].inputs[0].file, .relative(RelativePath("embed-bitcode.swift")))
XCTAssertEqual(plannedJobs[0].outputs.count, 3)
XCTAssertEqual(plannedJobs[0].outputs.count, 4)
XCTAssertEqual(plannedJobs[0].outputs[0].file, .temporary(RelativePath("embed-bitcode.bc")))
XCTAssertEqual(plannedJobs[0].outputs[1].file, .temporary(RelativePath("embed-bitcode.swiftmodule")))
XCTAssertEqual(plannedJobs[0].outputs[2].file, .temporary(RelativePath("embed-bitcode.swiftdoc")))
XCTAssertEqual(plannedJobs[0].outputs[3].file, .temporary(RelativePath("embed-bitcode.swiftsourceinfo")))

XCTAssertEqual(plannedJobs[1].kind, .backend)
XCTAssertEqual(plannedJobs[1].inputs.count, 1)
Expand All @@ -2120,9 +2127,10 @@ final class SwiftDriverTests: XCTestCase {
XCTAssertEqual(plannedJobs[2].kind, .mergeModule)
XCTAssertEqual(plannedJobs[2].inputs.count, 1)
XCTAssertEqual(plannedJobs[2].inputs[0].file, .temporary(RelativePath("embed-bitcode.swiftmodule")))
XCTAssertEqual(plannedJobs[2].outputs.count, 2)
XCTAssertEqual(plannedJobs[2].outputs.count, 3)
XCTAssertEqual(plannedJobs[2].outputs[0].file, .relative(RelativePath("main.swiftmodule")))
XCTAssertEqual(plannedJobs[2].outputs[1].file, .relative(RelativePath("main.swiftdoc")))
XCTAssertEqual(plannedJobs[2].outputs[2].file, .relative(RelativePath("main.swiftsourceinfo")))
}

do {
Expand Down Expand Up @@ -2153,11 +2161,11 @@ final class SwiftDriverTests: XCTestCase {
XCTAssertEqual(plannedJobs.count, 5)

XCTAssertEqual(plannedJobs[0].kind, .compile)
XCTAssertEqual(plannedJobs[0].outputs.count, 3)
XCTAssertEqual(plannedJobs[0].outputs.count, 4)
XCTAssertEqual(plannedJobs[0].outputs[0].file, .temporary(RelativePath("embed-bitcode.bc")))

XCTAssertEqual(plannedJobs[1].kind, .compile)
XCTAssertEqual(plannedJobs[1].outputs.count, 3)
XCTAssertEqual(plannedJobs[1].outputs.count, 4)
XCTAssertEqual(plannedJobs[1].outputs[0].file, .temporary(RelativePath("empty.bc")))

XCTAssertEqual(plannedJobs[2].kind, .backend)
Expand All @@ -2176,9 +2184,10 @@ final class SwiftDriverTests: XCTestCase {
XCTAssertEqual(plannedJobs[4].inputs.count, 2)
XCTAssertEqual(plannedJobs[4].inputs[0].file, .temporary(RelativePath("embed-bitcode.swiftmodule")))
XCTAssertEqual(plannedJobs[4].inputs[1].file, .temporary(RelativePath("empty.swiftmodule")))
XCTAssertEqual(plannedJobs[4].outputs.count, 2)
XCTAssertEqual(plannedJobs[4].outputs.count, 3)
XCTAssertEqual(plannedJobs[4].outputs[0].file, .relative(RelativePath("ABC.swiftmodule")))
XCTAssertEqual(plannedJobs[4].outputs[1].file, .relative(RelativePath("ABC.swiftdoc")))
XCTAssertEqual(plannedJobs[4].outputs[2].file, .relative(RelativePath("ABC.swiftsourceinfo")))
}

do {
Expand All @@ -2189,7 +2198,7 @@ final class SwiftDriverTests: XCTestCase {
XCTAssertEqual(plannedJobs[0].kind, .compile)
XCTAssertEqual(plannedJobs[0].inputs.count, 1)
XCTAssertEqual(plannedJobs[0].inputs[0].file, .relative(RelativePath("embed-bitcode.swift")))
XCTAssertEqual(plannedJobs[0].outputs.count, 3)
XCTAssertEqual(plannedJobs[0].outputs.count, 4)
XCTAssertEqual(plannedJobs[0].outputs[0].file, .temporary(RelativePath("Swift.bc")))

XCTAssertEqual(plannedJobs[1].kind, .backend)
Expand Down Expand Up @@ -2401,9 +2410,31 @@ final class SwiftDriverTests: XCTestCase {
var driver = try Driver(args: ["swiftc", "-emit-module-source-info", "foo.swift"])
let plannedJobs = try driver.planBuild()
let compileJob = plannedJobs[0]
XCTAssertTrue(compileJob.commandLine.contains(.flag("-emit-module-source-info")))
XCTAssertEqual(compileJob.outputs[0].file, VirtualPath.temporary(RelativePath("foo.o")))
XCTAssertEqual(compileJob.outputs[1].file, VirtualPath.temporary(RelativePath("foo.swiftsourceinfo")))
XCTAssertTrue(compileJob.commandLine.contains(.flag("-emit-module-source-info-path")))
XCTAssertEqual(compileJob.outputs.count, 2)
XCTAssertEqual(compileJob.outputs[0].file, .temporary(RelativePath("foo.o")))
XCTAssertEqual(compileJob.outputs[1].file, .temporary(RelativePath("foo.swiftsourceinfo")))
}
// implicit
do {
var driver = try Driver(args: ["swiftc", "-emit-module", "foo.swift"])
let plannedJobs = try driver.planBuild()
let compileJob = plannedJobs[0]
XCTAssertTrue(compileJob.commandLine.contains(.flag("-emit-module-source-info-path")))
XCTAssertEqual(compileJob.outputs.count, 3)
XCTAssertEqual(compileJob.outputs[0].file, .temporary(RelativePath("foo.swiftmodule")))
XCTAssertEqual(compileJob.outputs[1].file, .temporary(RelativePath("foo.swiftdoc")))
XCTAssertEqual(compileJob.outputs[2].file, .temporary(RelativePath("foo.swiftsourceinfo")))
}
// avoid implicit swiftsourceinfo
do {
var driver = try Driver(args: ["swiftc", "-emit-module", "-avoid-emit-module-source-info", "foo.swift"])
let plannedJobs = try driver.planBuild()
let compileJob = plannedJobs[0]
XCTAssertFalse(compileJob.commandLine.contains(.flag("-emit-module-source-info-path")))
XCTAssertEqual(compileJob.outputs.count, 2)
XCTAssertEqual(compileJob.outputs[0].file, .temporary(RelativePath("foo.swiftmodule")))
XCTAssertEqual(compileJob.outputs[1].file, .temporary(RelativePath("foo.swiftdoc")))
}
}
}
Expand Down