Merge pull request #3 from GoodNotes/code-wasm-compatibility

Project WASM compatibility first step

Author: pedrovgs

.github/workflows/wasm.yml

@@ -2,21 +2,45 @@ name: wasm
 
 on:
   push:
-  pull_request:
+
+env:
+  # Required Swift toolchain version for WASM builds
+  # Must match REQUIRED_TOOLCHAIN_VERSION in scripts/build-and-test-wasm.sh
+  SWIFT_TOOLCHAIN_VERSION: "DEVELOPMENT-SNAPSHOT-2025-11-03-a"
+  # Checksum for the WASM SDK (from SwiftWasm release page)
+  SWIFT_WASM_SDK_CHECKSUM: "879c08f24c36e20e0b3d1fadc37f4c34c089c72caa018aec726d9e0bf84ea6ff"
 
 jobs:
   build:
-    runs-on: macos-latest
-
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
 
-      # Use Swift 6.0.3 to match the pinned SDK version in build-and-test-wasm.sh
-      # The script will automatically install the 6.0.3-RELEASE WASM SDK
-      - name: Install Swift
-        uses: swift-actions/setup-swift@v2
-        with:
-          swift-version: "6.1"
+      # Install the specific Swift development snapshot required for WASM builds
+      # Toolchain comes from swift.org, SDK comes from SwiftWasm
+      - name: Install Swift Toolchain
+        run: |
+          SWIFT_URL="https://download.swift.org/development/ubuntu2404/swift-${SWIFT_TOOLCHAIN_VERSION}/swift-${SWIFT_TOOLCHAIN_VERSION}-ubuntu24.04.tar.gz"
+          echo "Downloading Swift toolchain from: $SWIFT_URL"
+          mkdir -p /opt/swift
+          curl -sL "$SWIFT_URL" | tar xz --strip-components=1 -C /opt/swift
+          echo "/opt/swift/usr/bin" >> $GITHUB_PATH
+
+      - name: Verify Swift Installation
+        run: swift --version
+
+      # Install the matching WASM SDK from SwiftWasm
+      - name: Install WASM SDK
+        run: |
+          SDK_URL="https://github.com/swiftwasm/swift/releases/download/swift-wasm-${SWIFT_TOOLCHAIN_VERSION}/swift-wasm-${SWIFT_TOOLCHAIN_VERSION}-wasm32-unknown-wasip1-threads.artifactbundle.zip"
+          echo "Installing WASM SDK from: $SDK_URL"
+          swift sdk install "$SDK_URL" --checksum "$SWIFT_WASM_SDK_CHECKSUM"
+          echo "Installed SDKs:"
+          swift sdk list
+
+      # Set environment variable to signal the correct toolchain is installed
+      - name: Set Toolchain Environment
+        run: echo "SWIFT_WASM_TOOLCHAIN_VERIFIED=1" >> $GITHUB_ENV
 
       # Wasmtime is required because `swift test` doesn't work for WebAssembly targets.
       # For WASM, we must build tests separately and run them with a WASM runtime.

Package.resolved

@@ -12,7 +12,7 @@ let package = Package(
     ],
     dependencies: [
         .package(url: "https://github.com/apple/swift-collections", from: "1.0.0"),
-        .package(url: "https://github.com/GoodNotes/CLAPACK", branch: "eigen-support"),
+        .package(url: "https://github.com/goodnotes/CLAPACK", branch: "eigen-support"),
     ],
     targets: [
         .target(

Package.swift

@@ -24,9 +24,22 @@ extension MfArray: CustomStringConvertible{
         var shape = self.shape
         var strides = self.strides
 
+        #if os(WASI)
+        let formatter: NumberFormatter? = nil
+        #else
         let formatter = NumberFormatter()
         formatter.positivePrefix = formatter.plusSign
         formatter.maximumFractionDigits = self.storedType == .Float ? 7 : 14
+        #endif
+
+        func imagString(_ value: Any) -> String{
+            #if os(WASI)
+            // Avoid NumberFormatter on WASI (Foundation formatter crashes in wasm)
+            return "\(value)"
+            #else
+            return formatter.string(for: value) ?? "\(value)"
+            #endif
+        }
 
         if self.size > 1000{//if size > 1000, some elements left out will be viewed
             let flattenLOIndSeq = FlattenLOIndSequence(storedSize: self.storedSize, shape: &shape, strides: &strides)
@@ -39,7 +52,7 @@ extension MfArray: CustomStringConvertible{
                         desc += "\t\(flattenData[flattenIndex + self.offsetIndex]),\t"
                     }
                     else{
-                        desc += "\t\(flattenData[flattenIndex + self.offsetIndex]) \(formatter.string(for: flattenImagData![flattenIndex + self.offsetIndex]) ?? "")j,\t"
+                        desc += "\t\(flattenData[flattenIndex + self.offsetIndex]) \(imagString(flattenImagData![flattenIndex + self.offsetIndex]))j,\t"
                     }
 
                     if indices.last! == shape.last! - 1{
@@ -81,7 +94,7 @@ extension MfArray: CustomStringConvertible{
                     desc += "\t\(flattenData[ret.flattenIndex + self.offsetIndex]),\t"
                 }
                 else{
-                    desc += "\t\(flattenData[ret.flattenIndex + self.offsetIndex]) \(formatter.string(for: flattenImagData![ret.flattenIndex + self.offsetIndex]) ?? "")j,\t"
+                    desc += "\t\(flattenData[ret.flattenIndex + self.offsetIndex]) \(imagString(flattenImagData![ret.flattenIndex + self.offsetIndex]))j,\t"
                 }
 
                 if ret.indices.last! == shape.last! - 1{

Sources/Matft/core/general/print.swift

@@ -7,8 +7,9 @@
 //
 
 import Foundation
-import Accelerate
+#if canImport(CoreML)
 import CoreML
+#endif
 
 open class MfArray: MfArrayProtocol{
     public typealias MFDATA = MfData
@@ -111,6 +112,7 @@ open class MfArray: MfArrayProtocol{
         self.mfstructure = mfstructure//mfstructure will be copied because mfstructure is struct
     }
 
+    #if canImport(CoreML)
     /// Create a VIEW or Copy mfarray from MLShapedArray
     /// - Parameters:
     ///    - base: A base MLShapedArray
@@ -126,6 +128,7 @@ open class MfArray: MfArrayProtocol{
         self.mfdata = mfdata
         self.mfstructure = MfStructure(shape: base.shape.map{ Int(truncating: $0) }, strides: base.strides.map{ Int(truncating: $0) })
     }
+    #endif
 
     deinit {
         self.base = nil

Sources/Matft/core/object/mfarray.swift

@@ -7,7 +7,6 @@
 //
 
 import Foundation
-import Accelerate
 
 internal enum MfDataSource{
     case mfdata
@@ -72,7 +71,7 @@ public class MfData: MfDataProtocol{
         case .Double:
             // dynamic allocation
             self.data_real = allocate_doubledata_from_flattenArray(&flatten_realArray, toBool: mftype == .Bool)
-            self.data_imag = allocate_floatdata_from_flattenArray(&flatten_imagArray, toBool: mftype == .Bool)
+            self.data_imag = allocate_doubledata_from_flattenArray(&flatten_imagArray, toBool: mftype == .Bool)
         }
         self.storedSize = flatten_realArray.count
         self.mftype = mftype
@@ -106,18 +105,18 @@ public class MfData: MfDataProtocol{
 
                 if let data_imag_ptr = data_imag_ptr{
                     self.data_imag = allocate_unsafeMRPtr(type: Float.self, count: storedSize)
-                    memcpy(self.data_imag, data_imag_ptr, self.storedByteSize)
+                    memcpy(self.data_imag!, data_imag_ptr, self.storedByteSize)
                 }
                 else{
                     self.data_imag = nil
                 }
             case .Double:
                 self.data_real = allocate_unsafeMRPtr(type: Double.self, count: storedSize)
                 memcpy(self.data_real, data_real_ptr, self.storedByteSize)
-                
+
                 if let data_imag_ptr = data_imag_ptr{
                     self.data_imag = allocate_unsafeMRPtr(type: Double.self, count: storedSize)
-                    memcpy(self.data_imag, data_imag_ptr, self.storedByteSize)
+                    memcpy(self.data_imag!, data_imag_ptr, self.storedByteSize)
                 }
                 else{
                     self.data_imag = nil

Sources/Matft/core/object/mfdata.swift

@@ -73,8 +73,12 @@ internal func shape2size(_ shape: inout [Int]) -> Int{
 ///   - mforder: Order
 /// - Returns: A strides array
 internal func shape2strides(_ shape: inout [Int], mforder: MfOrder) -> [Int]{
+    guard !shape.isEmpty else {
+        return []
+    }
+
     var ret = Array<Int>(repeating: 0, count: shape.count)
-    
+
     switch mforder {
     case .Row://, .None:
         var prevAxisNum = shape2size(&shape)

Sources/Matft/core/object/mfstructure.swift

@@ -7,8 +7,9 @@
 //
 
 import Foundation
-import Accelerate
+#if canImport(CoreML)
 import CoreML
+#endif
 
 public enum MfType: Int{
     case None
@@ -65,6 +66,7 @@ public enum MfType: Int{
         return MfType.mftype(value: value as Any)
     }
 
+    #if canImport(CoreML)
     @available(macOS 10.13, *)
     @available(iOS 14.0, *)
     static internal func mftype(value: MLMultiArrayDataType) -> MfType{
@@ -77,6 +79,7 @@ public enum MfType: Int{
             return .Object // Not supported
         }
     }
+    #endif
 
     static public func priority(_ a: MfType, _ b: MfType) -> MfType{
         if a.rawValue < b.rawValue{

Sources/Matft/core/object/mftype.swift

@@ -6,12 +6,16 @@
 //
 
 import Foundation
+#if canImport(CoreML)
 import CoreML
+#endif
 
 public protocol MfDataBasable {}
 
 extension MfData: MfDataBasable{}
 
+#if canImport(CoreML)
 @available(macOS 10.13, *)
 @available(iOS 14.0, *)
 extension MLMultiArray: MfDataBasable{}
+#endif

Sources/Matft/core/protocol/mfdataProtocol.swift

@@ -7,7 +7,53 @@
 //
 
 import Foundation
+#if canImport(Accelerate)
 import Accelerate
+#else
+/// Fallback complex type for non-Apple platforms (split complex format for Float)
+public struct DSPSplitComplex {
+    public var realp: UnsafeMutablePointer<Float>
+    public var imagp: UnsafeMutablePointer<Float>
+
+    public init(realp: UnsafeMutablePointer<Float>, imagp: UnsafeMutablePointer<Float>) {
+        self.realp = realp
+        self.imagp = imagp
+    }
+}
+
+/// Fallback complex type for non-Apple platforms (split complex format for Double)
+public struct DSPDoubleSplitComplex {
+    public var realp: UnsafeMutablePointer<Double>
+    public var imagp: UnsafeMutablePointer<Double>
+
+    public init(realp: UnsafeMutablePointer<Double>, imagp: UnsafeMutablePointer<Double>) {
+        self.realp = realp
+        self.imagp = imagp
+    }
+}
+
+/// Fallback complex type for non-Apple platforms (interleaved complex format for Float)
+public struct DSPComplex {
+    public var real: Float
+    public var imag: Float
+
+    public init(real: Float, imag: Float) {
+        self.real = real
+        self.imag = imag
+    }
+}
+
+/// Fallback complex type for non-Apple platforms (interleaved complex format for Double)
+public struct DSPDoubleComplex {
+    public var real: Double
+    public var imag: Double
+
+    public init(real: Double, imag: Double) {
+        self.real = real
+        self.imag = imag
+    }
+}
+#endif
 /*
 public protocol MfTypable: Numeric{}