Add SDL2 as XCFramework on Apple platforms + fix Windows build (#24)

* Add xcframework build script

* Update build script to include module map

* xcframework

* Working macOS

* Working assembled

* Add link + update makefile

* Update tests

* Update macos pipeline

* Update to macOS 13

* Publish XCFramework

* Progress

* Fix exported import

* Fix target naming

* Package dependency fixes

* Imports

* Fix linux tests

* Working windows install script

* Update win ci

* Update win ci

* Update README

Author: ctreffs

.github/workflows/ci-macos.yml

@@ -9,40 +9,19 @@ on:
 
 jobs:
   macos-test-build-release-xcode:
-    runs-on: macos-latest
+    runs-on: macos-13
     strategy:
       matrix:
-        xcode: ["14.2"]
+        xcode: ["14.3.1"]
     steps:
       - name: Checkout
-        uses: actions/checkout@v3.5.2
+        uses: actions/checkout@v3.5.3
 
       - name: Select Xcode ${{ matrix.xcode }}
         run: sudo xcode-select -s /Applications/Xcode_${{ matrix.xcode }}.app
-      
-      - name: Restore cached Homebrew dependencies
-        uses: actions/cache@v3.3.1
-        with:
-          path: |
-            ~/Library/Caches/Homebrew/sdl2--*
-            ~/Library/Caches/Homebrew/downloads/*--sdl2-*
-          key: ${{ runner.os }}-brew-sdl2-${{ hashFiles('.github/brew-formulae') }}
-          restore-keys: ${{ runner.os }}-brew-sdl2-
-
-      - name: Restore cached SPM dependencies
-        uses: actions/cache@v3.3.1
-        with:
-          path: |
-            .build/repositories
-          key: ${{ runner.os }}-spm-repos-${{ hashFiles('**/Package.resolved') }}
-          restore-keys: |
-            ${{ runner.os }}-spm-repos-
-
-      - name: Install dependencies
-        run: brew install sdl2
 
       - name: Test
-        run: make test
+        run: swift test
         env:
           DEVELOPER_DIR: /Applications/Xcode_${{ matrix.xcode }}.app/Contents/Developer
 
@@ -56,7 +35,7 @@ jobs:
             .build/**/*.xctest
 
       - name: Build Release
-        run: make build-release
+        run: swift build -c release
         env:
           DEVELOPER_DIR: /Applications/Xcode_${{ matrix.xcode }}.app/Contents/Developer
 
@@ -73,3 +52,16 @@ jobs:
             .build/**/*.dylib
             .build/**/*.dSYM 
             .build/**/*.json
+
+      - name: Zip XCFramework
+        run: |
+          zip -q -9 -r SDL2.xcframework.zip SDL2.xcframework
+          echo "`swift package compute-checksum SDL2.xcframework.zip`" > SDL2.xcframework.checksum.txt
+
+      - name: Publish XCFramework
+        uses: actions/upload-artifact@v3.1.2
+        with:
+          name: build-artifacts-${{ matrix.xcode }}-${{ github.run_id }}
+          path: |
+            SDL2.xcframework.zip
+            SDL2.xcframework.checksum.txt

.github/workflows/ci-windows.yml

@@ -23,22 +23,39 @@ jobs:
         uses: actions/cache@v3.3.1
         with:
           key: windows-x64-vcpkg
-          path: C:/vcpkg/
+          path: C:\vcpkg\installed\x64-windows
 
       - name: Build & Test
         shell: pwsh
         run: |
+          vcpkg integrate powershell
+
           # install dependencies
-          vcpkg install sdl2[core,vulkan] pkgconf --recurse --triplet x64-windows
-          vcpkg integrate install
+          vcpkg install sdl2[core,vulkan] --recurse --triplet x64-windows --no-print-usage
+          vcpkg install pkgconf --triplet x64-windows --no-print-usage
           
           # setup pkgconf environment
           $env:Path += ";C:\vcpkg\installed\x64-windows\tools\pkgconf\"
-          $env:PKG_CONFIG_PATH=$VCPKG_DIR+'\installed\x64-windows\tools\pkgconf\;C:\vcpkg\packages\sdl2_x64-windows\debug\lib\pkgconfig\'
+          $env:PKG_CONFIG_PATH = "C:\vcpkg\installed\x64-windows\lib\pkgconfig\"
+
+          # generate windows header
+          $includedir = (pkgconf --variable includedir sdl2).Trim()
+          Write-Output ('#include "' + $includedir + '/SDL2/SDL.h"') > Sources/CSDL2/windows_generated.h
+          Write-Output ('#include "' + $includedir + '/SDL2/SDL_vulkan.h"') >> Sources/CSDL2/windows_generated.h
 
           # build
           swift build
 
+          # copy SDL libraries
+          $bindir = ((pkgconf --variable exec_prefix sdl2).Trim() + "/bin")
+          $libdir = (pkgconf --variable libdir sdl2).Trim()
+          foreach ($config in "debug", "release") {
+              $path = ".build/$config"
+              if (Test-Path -Path $path) {
+                  Copy-Item ($bindir + '/SDL2.dll') $path
+                  Copy-Item ($libdir + '/SDL2.lib') $path
+              }
+          }
+
           # test
           swift test
-          

.gitignore

@@ -103,3 +103,6 @@ Temporary Items
 timeline.xctimeline
 vcs.xml
 xcuserdata/
+*.zip
+vcpkg/
+Sources/CSDL2/windows_generated.h

.swiftlint.yml

@@ -1,47 +1,7 @@
-lint-fix:
-	swiftlint fix --format
-
-lintErrorOnly:
-	@swiftlint lint --quiet | grep error
-
-genLinuxTests:
-	swift test --generate-linuxmain
-	swiftlint autocorrect --format --path Tests/
-
-.PHONY: test
-test:
-	swift test
-
-.PHONY: build-release
-build-release:
-	swift build -c release
-
-submodule:
-	git submodule update --init --recursive
-	
-clean:
-	swift package reset
-	rm -rdf .swiftpm/xcode
-	rm -rdf .build/
-	rm Package.resolved
-	rm .DS_Store
-
-cleanArtifacts:
-	swift package clean
+SWIFT_PACKAGE_VERSION := $(shell swift package tools-version)
 
-latest:
-	swift package update
-
-resolve:
-	swift package resolve
-
-genXcode:
-	swift package generate-xcodeproj --enable-code-coverage --skip-extra-files 
-
-genXcodeOpen: genXcode
-	open *.xcodeproj
-
-precommit: lint genLinuxTests
-
-testReadme:
-	markdown-link-check -p -v ./README.md
+# Lint fix and format code.
+.PHONY: lint-fix
+lint-fix:
+	mint run swiftlint --fix --quiet
+	mint run swiftformat --quiet --swiftversion ${SWIFT_PACKAGE_VERSION} .

Makefile

@@ -0,0 +1,2 @@
+realm/SwiftLint@0.51.0
+nicklockwood/SwiftFormat@0.51.7

Mintfile

@@ -1,32 +1,40 @@
-// swift-tools-version:5.5
+// swift-tools-version:5.6
 import PackageDescription
 
 let package = Package(
-    name: "SDL2",
+    name: "SDL",
+    platforms: [
+        .macOS(.v11),
+        .iOS(.v13),
+        .tvOS(.v13),
+    ],
     products: [
-        .library(name: "SDL2",
-                 targets: ["SDL2"]),
-        .executable(name: "MinimalApp",
-                    targets: ["Minimal"]),
-        .executable(name: "MetalApp",
-                    targets: ["MetalApp"])
+        .library(name: "SDL",
+                 targets: ["SDL"]),
     ],
     targets: [
+        .target(name: "SDL",
+                dependencies: [
+                    .target(name: "SDL2-apple", condition: .when(platforms: [.macOS, .iOS, .tvOS])),
+                    .target(name: "CSDL2", condition: .when(platforms: [.linux, .windows])),
+                ],
+                path: "Sources/SDL2"),
+        .testTarget(name: "SDLTests", dependencies: ["SDL"]),
+        .binaryTarget(name: "SDL2-apple", path: "SDL2.xcframework"),
         .systemLibrary(
             name: "CSDL2",
             pkgConfig: "sdl2",
             providers: [
-                .brew(["sdl2"]),
                 .apt(["libsdl2-dev"])
-        ]),
-        .target(name: "SDL2", dependencies: ["CSDL2"]),
-        .executableTarget(name: "Minimal", dependencies: ["SDL2"], path: "Sources/Demos/Minimal"),
+                //,.vcpkg(["sdl2[core,vulkan]"])
+                ]
+        ),
+        .executableTarget(name: "Minimal", dependencies: ["SDL"], path: "Sources/Demos/Minimal"),
         .executableTarget(
             name: "MetalApp",
-            dependencies: ["SDL2"],
+            dependencies: ["SDL"],
             path: "Sources/Demos/MetalApp",
             swiftSettings: [.define("METAL_ENABLED", .when(platforms: [.macOS]))]
         ),
-        .testTarget(name: "CSDL2Tests", dependencies: ["CSDL2"])
     ]
 )

Package.swift

@@ -25,19 +25,19 @@ These instructions will get your copy of the project up and running on your loca
 
 ### 💻 Installing
 
-Swift SDL2 is available for all platforms that support [Swift 5.1](https://swift.org/) and higher and the [Swift Package Manager (SPM)](https://github.com/apple/swift-package-manager).
+Swift SDL2 is available for all platforms that support [Swift 5.6](https://swift.org/) and higher and the [Swift Package Manager (SPM)](https://github.com/apple/swift-package-manager).
 
 Extend the following lines in your `Package.swift` file or use it to create a new project.
 
 ```swift
-// swift-tools-version:5.1
+// swift-tools-version:5.6
 
 import PackageDescription
 
 let package = Package(
     name: "YourPackageName",
     dependencies: [
-        .package(url: "https://github.com/ctreffs/SwiftSDL2.git", from: "1.2.0")
+        .package(url: "https://github.com/ctreffs/SwiftSDL2.git", from: "1.4.0")
     ],
     targets: [
         .target(
@@ -47,20 +47,27 @@ let package = Package(
 )
 
 ```
+Depending on your platform several extra steps have to be taken to SDL2 to compile.
 
-Since it's a system library wrapper you need to install the SDL2 library either via
+### Apple
 
-```sh
-brew install sdl2
-```
+For Apple platforms (macOS, iOS, tvOS) SDL2 is provided using an XCFramework so mo extra steps are needed.
+
+### Linux
 
-or 
+On Linux platforms you are required to use the following command to install SDL2 as a system package:
 
 ```sh
 apt-get install libsdl2-dev
 ```
 
-depending on your platform.
+### Windows
+
+Since Windows is a fairly new platform for Swift development there are some manual steps to perform before you can use the package.
+All the following steps assume you have a working swift environment on your Windows machine.
+If not follow the [instructions on how to install Swift on Windows](https://www.swift.org/download/#windows).
+
+You can quickly test this package is working by running the `./buildPackageWin.ps1` powershell script.
 
 ## 📝 Code Example
 
@@ -69,7 +76,7 @@ depending on your platform.
 A minimal example is located at [Sources/Demos/Minimal](Sources/Demos/Minimal).   
 
 ```swift
-import SDL2
+import SDL
 
 // Initialize SDL video systems
 guard SDL_Init(SDL_INIT_VIDEO) == 0 else {