Skip to content

Run Windows games on Apple Silicon — free, open source, with an open compatibility database that tells you what actually works.

cli: env KEY= removes the variable on bottles and pins

Gauthier Piarretteae3b9054e274
diff --git a/Sources/HighballKit/EnvAssignment.swift b/Sources/HighballKit/EnvAssignment.swift
new file mode 100644
index 0000000..0e74ec8
--- /dev/null
+++ b/Sources/HighballKit/EnvAssignment.swift
@@ -0,0 +1,21 @@
+import Foundation
+
+/// One `KEY=VALUE` assignment from the CLI. An empty value removes the key, so a user can
+/// undo `env FOO=bar` with `env FOO=`. Swift's `split` drops the empty trailing piece, which
+/// is why `KEY=` used to be rejected as "not KEY=VALUE".
+public enum EnvAssignment {
+ public static func parse(_ text: String) -> (key: String, value: String)? {
+ guard let eq = text.firstIndex(of: "=") else { return nil }
+ let key = String(text[..<eq])
+ guard !key.isEmpty else { return nil }
+ return (key, String(text[text.index(after: eq)...]))
+ }
+
+ /// Applies the assignment to `environment`; returns false when the text is not `KEY=VALUE`.
+ @discardableResult
+ public static func apply(_ text: String, to environment: inout [String: String]) -> Bool {
+ guard let (key, value) = parse(text) else { return false }
+ if value.isEmpty { environment.removeValue(forKey: key) } else { environment[key] = value }
+ return true
+ }
+}
diff --git a/Sources/highball/main.swift b/Sources/highball/main.swift
index 0a1d698..c9ca6a2 100644
--- a/Sources/highball/main.swift
+++ b/Sources/highball/main.swift
@@ -134,7 +134,7 @@ struct Bottle: AsyncParsableCommand {
}
struct Set: AsyncParsableCommand {
- static let configuration = CommandConfiguration(abstract: "Change a bottle setting: engine, renderer, winver, sync, hud, avx, dpi, dxvkasync, dlloverrides, env KEY=VALUE")
+ static let configuration = CommandConfiguration(abstract: "Change a bottle setting: engine, renderer, winver, sync, hud, avx, dpi, dxvkasync, dlloverrides, env KEY=VALUE (empty VALUE removes)")
@Argument var name: String
@Argument var setting: String
@Argument var value: String
@@ -169,9 +169,7 @@ struct Bottle: AsyncParsableCommand {
let eng = try EngineStore().engine(b.settings.engineID)
try await WineRunner(engine: eng, bottle: b).setDpi(logPixels: scale)
case "env":
- let parts = value.split(separator: "=", maxSplits: 1).map(String.init)
- guard parts.count == 2 else { fail("env expects KEY=VALUE") }
- b.settings.environment[parts[0]] = parts[1]
+ guard EnvAssignment.apply(value, to: &b.settings.environment) else { fail("env expects KEY=VALUE (empty VALUE removes)") }
default: fail("unknown setting \(setting)")
}
try bs.update(b)
@@ -296,11 +294,7 @@ struct PinCommand: AsyncParsableCommand {
else if let r = HighballKit.Renderer(rawValue: v) { b.settings.pins[i].renderer = r }
else { fail("bad renderer \(v)") }
case "env":
- guard let v = value.first else { fail("env expects KEY=VALUE") }
- let parts = v.split(separator: "=", maxSplits: 1).map(String.init)
- guard parts.count == 2 else { fail("env expects KEY=VALUE") }
- if parts[1].isEmpty { b.settings.pins[i].environment.removeValue(forKey: parts[0]) }
- else { b.settings.pins[i].environment[parts[0]] = parts[1] }
+ guard let v = value.first, EnvAssignment.apply(v, to: &b.settings.pins[i].environment) else { fail("env expects KEY=VALUE (empty VALUE removes)") }
default: fail("unknown setting \(setting) (args, renderer, env)")
}
try bs.update(b)
diff --git a/Tests/HighballKitTests/EnvAssignmentTests.swift b/Tests/HighballKitTests/EnvAssignmentTests.swift
new file mode 100644
index 0000000..7d1ade6
--- /dev/null
+++ b/Tests/HighballKitTests/EnvAssignmentTests.swift
@@ -0,0 +1,26 @@
+import XCTest
+@testable import HighballKit
+
+final class EnvAssignmentTests: XCTestCase {
+ func testSetsAndKeepsEqualsInValue() {
+ var env: [String: String] = [:]
+ XCTAssertTrue(EnvAssignment.apply("WINEDLLPATH_PREPEND=/a:/b", to: &env))
+ XCTAssertTrue(EnvAssignment.apply("X=a=b", to: &env))
+ XCTAssertEqual(env, ["WINEDLLPATH_PREPEND": "/a:/b", "X": "a=b"])
+ }
+
+ func testEmptyValueRemovesTheKey() {
+ var env = ["WINEDEBUG": "+loaddll", "KEEP": "1"]
+ XCTAssertTrue(EnvAssignment.apply("WINEDEBUG=", to: &env))
+ XCTAssertEqual(env, ["KEEP": "1"])
+ XCTAssertTrue(EnvAssignment.apply("MISSING=", to: &env))
+ XCTAssertEqual(env, ["KEEP": "1"])
+ }
+
+ func testRejectsTextWithoutKeyOrEquals() {
+ var env: [String: String] = [:]
+ XCTAssertFalse(EnvAssignment.apply("WINEDEBUG", to: &env))
+ XCTAssertFalse(EnvAssignment.apply("=x", to: &env))
+ XCTAssertTrue(env.isEmpty)
+ }
+}