Add OPENATTRIBUTEGRAPH_LIB_SWIFT_PATH config

Author: Kyle-Ye

Package.swift

@@ -17,16 +17,6 @@ func envEnable(_ key: String, default defaultValue: Bool = false) -> Bool {
     }
 }
 
-func detectIncludePath() -> String {
-    if let path = Context.environment["SWIFT_TOOLCHAIN_PATH"] {
-        return path + "/usr/lib/swift"
-    }
-    let swiftBinPath = Context.environment["_"] ?? "/usr/bin/swift"
-    let swiftBinURL = URL(fileURLWithPath: swiftBinPath)
-    let SDKPath = swiftBinURL.deletingLastPathComponent().deletingLastPathComponent().deletingLastPathComponent().path
-    return SDKPath.appending("/usr/lib/swift")
-}
-
 #if os(macOS)
 // NOTE: #if os(macOS) check is not accurate if we are cross compiling for Linux platform. So we add an env key to specify it.
 let buildForDarwinPlatform = envEnable("OPENSWIFTUI_BUILD_FOR_DARWIN_PLATFORM", default: true)
@@ -44,10 +34,22 @@ let isSPIBuild = envEnable("SPI_BUILD")
 
 let isXcodeEnv = Context.environment["__CFBundleIdentifier"] == "com.apple.dt.Xcode"
 let development = envEnable("OPENATTRIBUTEGRAPH_DEVELOPMENT", default: false)
-let includePath = detectIncludePath()
+
+// From Swift toolchain being installed or from Swift SDK.
+func detectLibSwiftPath() -> String {
+    guard let libSwiftPath = Context.environment["OPENATTRIBUTEGRAPH_LIB_SWIFT_PATH"] else {
+        // Fallback when LIB_SWIFT_PATH is not set
+        let swiftBinPath = Context.environment["OPENATTRIBUTEGRAPH_BIN_SWIFT_PATH"] ?? Context.environment["_"] ?? "/usr/bin/swift"
+        let swiftBinURL = URL(fileURLWithPath: swiftBinPath)
+        let SDKPath = swiftBinURL.deletingLastPathComponent().deletingLastPathComponent().deletingLastPathComponent().path
+        return SDKPath.appending("/usr/lib/swift")
+    }
+    return libSwiftPath
+}
+let libSwiftPath = detectLibSwiftPath()
 
 var sharedCSettings: [CSetting] = [
-    .unsafeFlags(["-I", includePath], .when(platforms: .nonDarwinPlatforms)),
+    .unsafeFlags(["-I", libSwiftPath], .when(platforms: .nonDarwinPlatforms)),
     .define("NDEBUG", .when(configuration: .release)),
 ]
 

README.md

@@ -50,19 +50,25 @@ For a simpler setup, you can use the prebuilt XCFramework available on the [rele
 
 The current suggested toolchain to build the project is Swift 6.1.2 / Xcode 16.4.
 
-### Usage with ```swiftly````
+### Set up LIB_SWIFT_PATH on non-Darwin platform
 
-If you have installed [Swiftly](https://github.com/swiftlang/swiftly) for managing your installed swift toolchains (Linux) set the following variable to your shell:
+If your swift binary path is located in your `<toolchain>/usr/bin/swift` (eg. installed by [swiftbox](https://github.com/stevapple/swiftbox)), no setup is required since the swift bin location be detected by `_` environment automatically.
 
-```bash
-export SWIFT_TOOLCHAIN_PATH="$(swiftly use --print-location)"
-```
+Otherwise set up it manully by exporting `LIB_SWIFT_PATH` environment variable.
+
+> The following command assume you already have [swiftly](https://github.com/swiftlang/swiftly) installed.
 
-```fish
-set -gx SWIFT_TOOLCHAIN_PATH (swiftly use --print-location)
+```shell
+export OPENATTRIBUTEGRAPH_LIB_SWIFT_PATH="$(swiftly use --print-location)/usr/lib/swift"
+# Or use the swift_static path
+export OPENATTRIBUTEGRAPH_LIB_SWIFT_PATH="$(swiftly use --print-location)/usr/lib/swift_static"
 ```
 
-Then run `swift build`
+Alternatively, you can set the path directly to the Swift SDK location. For example:
+
+```shell
+export OPENATTRIBUTEGRAPH_LIB_SWIFT_PATH=~/.swiftpm/swift-sdks/swift-6.1.3-RELEASE_static-linux-0.0.1.artifactbundle/swift-6.1.3-RELEASE_static-linux-0.0.1/swift-linux-musl/musl-1.2.5.sdk/aarch64/usr/lib/swift_static
+```
 
 ## License