Add Swift Package Manager support and fix Makefile build directory path

Author: Gioee

.gitignore

@@ -8,4 +8,5 @@
 /dist
 *.sqlite
 *.a
-.vscode
+.vscode
+.build

Makefile

@@ -197,7 +197,7 @@ endif
 	$(STRIP)
 
 # Object files
-$(BUILD_DIR)/%.o: %.c build/llama.cpp.stamp
+$(BUILD_DIR)/%.o: %.c $(BUILD_DIR)/llama.cpp.stamp
 	$(CC) $(CFLAGS) -O3 -fPIC -c $< -o $@
 
 test: $(TARGET)
@@ -209,25 +209,25 @@ ifeq ($(PLATFORM),windows)
 else
     ARGS = -- -j$(CPUS)
 endif
-build/llama.cpp.stamp:
+$(BUILD_DIR)/llama.cpp.stamp:
 	cmake -B $(BUILD_LLAMA) $(LLAMA_OPTIONS) $(LLAMA_DIR)
 	cmake --build $(BUILD_LLAMA) --config Release $(LLAMA_ARGS) $(ARGS)
 	cmake --install $(BUILD_LLAMA) --prefix $(BUILD_GGML)
 	touch $@
 
-build/whisper.cpp.stamp: build/llama.cpp.stamp
+$(BUILD_DIR)/whisper.cpp.stamp: $(BUILD_DIR)/llama.cpp.stamp
 	cmake -Dggml_DIR=$(shell pwd)/$(BUILD_GGML)/lib/cmake/ggml -B $(BUILD_WHISPER) $(WHISPER_OPTIONS) $(WHISPER_DIR)
 	cmake --build $(BUILD_WHISPER) --config Release $(WHISPER_ARGS) $(ARGS)
 	touch $@
 
-build/miniaudio.stamp:
+$(BUILD_DIR)/miniaudio.stamp:
 	cmake -B $(BUILD_MINIAUDIO) $(MINIAUDIO_OPTIONS) $(MINIAUDIO_DIR)
 	cmake --build $(BUILD_MINIAUDIO) --config Release $(MINIAUDIO_ARGS) $(ARGS)
 	touch $@
 
-$(LLAMA_LIBS): build/llama.cpp.stamp
-$(WHISPER_LIBS): build/whisper.cpp.stamp
-$(MINIAUDIO_LIBS): build/miniaudio.stamp
+$(LLAMA_LIBS): $(BUILD_DIR)/llama.cpp.stamp
+$(WHISPER_LIBS): $(BUILD_DIR)/whisper.cpp.stamp
+$(MINIAUDIO_LIBS): $(BUILD_DIR)/miniaudio.stamp
 
 # Tools
 version:

Package.swift

@@ -0,0 +1,33 @@
+// swift-tools-version: 6.1
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+    name: "ai",
+    platforms: [.macOS(.v11), .iOS(.v11)],
+    products: [
+        // Products can be used to vend plugins, making them visible to other packages.
+        .plugin(
+            name: "aiPlugin",
+            targets: ["aiPlugin"]),
+        .library(
+            name: "ai",
+            targets: ["ai"])
+    ],
+    targets: [
+        // Build tool plugin that invokes the Makefile
+        .plugin(
+            name: "aiPlugin",
+            capability: .buildTool(),
+            path: "packages/swift/plugin"
+        ),
+        // ai library target
+        .target(
+            name: "ai",
+            dependencies: [],
+            path: "packages/swift/extension",
+            plugins: ["aiPlugin"]
+        ),
+    ]
+)

README.md

@@ -30,14 +30,27 @@ Download the appropriate pre-built binary for your platform from the official [R
 - Android
 - iOS
 
-### Loading the Extension
-
-```sql
--- In SQLite CLI
-.load ./ai
-
--- In SQL
-SELECT load_extension('./ai');
+### Swift Package
+
+You can [add this repository as a package dependency to your Swift project](https://developer.apple.com/documentation/xcode/adding-package-dependencies-to-your-app#Add-a-package-dependency). After adding the package, you'll need to set up SQLite with extension loading by following steps 4 and 5 of [this guide](https://github.com/sqliteai/sqlite-extensions-guide/blob/main/platforms/ios.md#4-set-up-sqlite-with-extension-loading).
+
+Here's an example of how to use the package:
+```swift
+import ai
+
+...
+
+var db: OpaquePointer?
+sqlite3_open(":memory:", &db)
+sqlite3_enable_load_extension(db, 1)
+var errMsg: UnsafeMutablePointer<Int8>? = nil
+sqlite3_load_extension(db, ai.path, nil, &errMsg)
+var stmt: OpaquePointer?
+sqlite3_prepare_v2(db, "SELECT ai_version()", -1, &stmt, nil)
+defer { sqlite3_finalize(stmt) }
+sqlite3_step(stmt)
+log("ai_version(): \(String(cString: sqlite3_column_text(stmt, 0)))")
+sqlite3_close(db)
 ```
 
 ### Python Package
@@ -50,6 +63,15 @@ pip install sqlite-ai
 
 For usage details and examples, see the [Python package documentation](./packages/python/README.md).
 
+### Loading the Extension
+
+```sql
+-- In SQLite CLI
+.load ./ai
+
+-- In SQL
+SELECT load_extension('./ai');
+```
 
 ## Getting Started
 

packages/swift/extension/ai.swift

@@ -0,0 +1,19 @@
+// ai.swift
+// This file serves as a placeholder for the ai target.
+// The actual SQLite extension is built using the Makefile through the build plugin.
+
+import Foundation
+
+/// Placeholder structure for ai
+public struct ai {
+    /// Returns the path to the built ai dylib inside the XCFramework
+    public static var path: String {
+        #if os(macOS)
+        return "ai.xcframework/macos-arm64_x86_64/ai.framework/ai"
+        #elseif targetEnvironment(simulator)
+        return "ai.xcframework/ios-arm64_x86_64-simulator/ai.framework/ai"
+        #else
+        return "ai.xcframework/ios-arm64/ai.framework/ai"
+        #endif
+    }
+}

packages/swift/plugin/ai.swift

@@ -0,0 +1,61 @@
+import PackagePlugin
+import Foundation
+
+@main
+struct ai: BuildToolPlugin {
+    /// Entry point for creating build commands for targets in Swift packages.
+    func createBuildCommands(context: PluginContext, target: Target) async throws -> [Command] {
+        let packageDirectory = context.package.directoryURL
+        let outputDirectory = context.pluginWorkDirectoryURL
+        return createaiBuildCommands(packageDirectory: packageDirectory, outputDirectory: outputDirectory)
+    }
+}
+
+#if canImport(XcodeProjectPlugin)
+import XcodeProjectPlugin
+
+extension ai: XcodeBuildToolPlugin {
+    // Entry point for creating build commands for targets in Xcode projects.
+    func createBuildCommands(context: XcodePluginContext, target: XcodeTarget) throws -> [Command] {
+        let outputDirectory = context.pluginWorkDirectoryURL
+        return createaiBuildCommands(packageDirectory: nil, outputDirectory: outputDirectory)
+    }
+}
+
+#endif
+
+/// Shared function to create ai build commands
+func createaiBuildCommands(packageDirectory: URL?, outputDirectory: URL) -> [Command] {
+
+    // For Xcode projects, use current directory; for Swift packages, use provided packageDirectory
+    let workingDirectory = packageDirectory?.path ?? "$(pwd)"
+    let packageDirInfo = packageDirectory != nil ? "Package directory: \(packageDirectory!.path)" : "Working directory: $(pwd)"
+
+    return [
+        .prebuildCommand(
+            displayName: "Building ai XCFramework",
+            executable: URL(fileURLWithPath: "/bin/bash"),
+            arguments: [
+                "-c",
+                """
+                set -e
+                echo "Starting ai XCFramework prebuild..."
+                echo "\(packageDirInfo)"
+                
+                # Clean and create output directory
+                rm -rf "\(outputDirectory.path)"
+                mkdir -p "\(outputDirectory.path)"
+                
+                # Copy source to writable location first due to sandbox restrictions
+                cp -R "\(workingDirectory)" "\(outputDirectory.path)/src" && \
+                cd "\(outputDirectory.path)/src" && \
+                echo "Building XCFramework..." && \
+                PATH="/usr/local/bin:/opt/homebrew/bin:/usr/bin:/bin:/opt/local/bin:/usr/sbin:/sbin:$PATH" make xcframework DIST_DIR="\(outputDirectory.path)" LLAMA="-DGGML_NATIVE=OFF -DGGML_METAL=ON -DGGML_ACCELERATE=ON -DGGML_BLAS=ON -DGGML_BLAS_VENDOR=Apple" WHISPER="-DWHISPER_COREML=ON -DWHISPER_COREML_ALLOW_FALLBACK=ON" && \
+                rm -rf "\(outputDirectory.path)/src" && \
+                echo "XCFramework build completed successfully!"
+                """
+            ],
+            outputFilesDirectory: outputDirectory
+        )
+    ]
+}