Skip to content
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.

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

Allow unicode chars in package-name in driver #1367

Merged
merged 1 commit into from
May 31, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 5 additions & 4 deletions Sources/SwiftDriver/Driver/Driver.swift
Original file line number Diff line number Diff line change
Expand Up @@ -698,11 +698,12 @@ public struct Driver {
// Compute debug information output.
self.debugInfo = Self.computeDebugInfo(&parsedOptions, diagnosticsEngine: diagnosticEngine)

// Validate package name; if package name is nil, it will be checked
// in the frontend during type check on `package` symbols
// Error if package-name is passed but the input is empty; if
// package-name is not passed but `package` decls exist, error
// will occur during the frontend type check.
self.packageName = parsedOptions.getLastArgument(.packageName)?.asSingle
if let packageName = packageName, !packageName.sd_isSwiftIdentifier {
diagnosticsEngine.emit(.error_bad_package_name(packageName))
if let packageName = packageName, packageName.isEmpty {
diagnosticsEngine.emit(.error_empty_package_name)
}

// Determine the module we're building and whether/how the module file itself will be emitted.
Expand Down
7 changes: 2 additions & 5 deletions Sources/SwiftDriver/Utilities/Diagnostics.swift
Original file line number Diff line number Diff line change
Expand Up @@ -123,11 +123,8 @@ extension Diagnostic.Message {
return .error("bad module alias \"\(arg)\"")
}

static func error_bad_package_name(_ packageName: String) -> Diagnostic.Message {
if packageName.isEmpty {
return .error("package name is empty; pass a non-empty string or remove \'-package-name\'")
}
return .error("package name \"\(packageName)\" is not a valid identifier")
static var error_empty_package_name: Diagnostic.Message {
return .error("package-name is empty")
}

static var error_hermetic_seal_cannot_have_library_evolution: Diagnostic.Message {
Expand Down
21 changes: 11 additions & 10 deletions Tests/SwiftDriverTests/SwiftDriverTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -690,25 +690,26 @@ final class SwiftDriverTests: XCTestCase {
}

func testPackageNameFlag() throws {
// -package-name mypkg (valid string)
try assertNoDriverDiagnostics(args: "swiftc", "file.swift", "bar.swift", "-module-name", "MyModule", "-package-name", "mypkg", "-emit-module", "-emit-module-path", "../../path/to/MyModule.swiftmodule") { driver in
XCTAssertEqual(driver.packageName, "mypkg")
// -package-name com.perf.my-pkg (valid string)
try assertNoDriverDiagnostics(args: "swiftc", "file.swift", "bar.swift", "-module-name", "MyModule", "-package-name", "com.perf.my-pkg", "-emit-module", "-emit-module-path", "../../path/to/MyModule.swiftmodule") { driver in
XCTAssertEqual(driver.packageName, "com.perf.my-pkg")
XCTAssertEqual(driver.moduleOutputInfo.output, .topLevel(try VirtualPath.intern(path: "../../path/to/MyModule.swiftmodule")))
}

// -package-name is not passed
// -package-name is not passed and file doesn't contain `package` decls; should pass
try assertNoDriverDiagnostics(args: "swiftc", "file.swift") { driver in
XCTAssertNil(driver.packageName)
XCTAssertEqual(driver.moduleOutputInfo.name, "file")
}
}

func testPackageNameDiags() throws {
try assertDriverDiagnostics(args: ["swiftc", "file.swift", "-package-name", ""]) {
$1.expect(.error("package name is empty; pass a non-empty string or remove \'-package-name\'"))
// -package-name 123a!@#$ (valid string)
try assertNoDriverDiagnostics(args: "swiftc", "file.swift", "-module-name", "Foo", "-package-name", "123a!@#$") { driver in
XCTAssertEqual(driver.packageName, "123a!@#$")
}
try assertDriverDiagnostics(args: ["swiftc", "file.swift", "-module-name", "Foo", "-package-name", "123a!@#$"]) {
$1.expect(.error("package name \"123a!@#$\" is not a valid identifier"))

// -package-name input is an empty string
try assertDriverDiagnostics(args: "swiftc", "file.swift", "-package-name", "") {
$1.expect(.error("package-name is empty"))
}
}

Expand Down