Updates for Xcode 15.3

.github/workflows/test.yml

@@ -9,27 +9,29 @@ on:
 jobs:
   macos:
     name: macOS SPM unit tests
-    runs-on: macos-13
-    env:
-      DEVELOPER_DIR: /Applications/Xcode_15.0.app/Contents/Developer
+    runs-on: macos-14
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: true
+      - uses: maxim-lobanov/setup-xcode@v1
+        with:
+          xcode-version: 15.3
       - name: Set up SDK
-        run: cd sdk && make install
+        run: cd sdk && sudo make install
       - name: Run tests
         run: swift test
 
   macos_raw:
     name: macOS raw build
-    runs-on: macos-13
-    env:
-      DEVELOPER_DIR: /Applications/Xcode_15.0.app/Contents/Developer
+    runs-on: macos-14
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: true
+      - uses: maxim-lobanov/setup-xcode@v1
+        with:
+          xcode-version: 15.3
       - name: Raw build
         run: swift build
 
@@ -38,12 +40,10 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           submodules: true
-      - name: Give up and run in docker
-        run: 'docker run -v `pwd`:`pwd` -w `pwd` --name steamworks --rm swiftlang/swift:nightly-5.9-focal /bin/bash -c "apt-get update; apt-get install make; (cd sdk && make install); swift test -Xswiftc -cxx-interoperability-mode=default"'
-          #      - name: Set up SDK
-          #run: cd sdk && sudo make install
-          #- name: Run tests
-          #run: swift test -Xswiftc -cxx-interoperability-mode=default
+      - name: Set up SDK
+        run: cd sdk && sudo make install
+      - name: Run tests
+        run: swift test -Xswiftc -cxx-interoperability-mode=default

DocIndex/jazzy-custom-groups.yaml

@@ -657,6 +657,9 @@
         - SteamAPICall
         - SteamAPIWarningMessageHook
         - SteamErrMsg
+        - SteamUnsafeMutablePointer
+        - SteamUnsafeMutableRawPointer
+        - SteamUnsafeRawPointer
     - name: Enumerations and Option Sets
       children:
         - AccountType
@@ -676,6 +679,7 @@
         - PlayerResult
         - Result
         - ServerMode
+        - SteamAPIInitResult
         - SteamIPType
         - SteamIPv6ConnectivityProtocol
         - SteamIPv6ConnectivityState
@@ -687,6 +691,7 @@
         - GameID
         - SteamID
         - SteamIPAddress
+        - SteamUncheckedSendable
   - name: Constants
     topics:
     - name: Constants

Makefile

@@ -27,7 +27,7 @@ clean:
 
 # Random flags here to get around crap Linux C++ support
 test_linux:
-	docker run -v `pwd`:`pwd` -w `pwd` --name steamworks --rm swiftlang/swift:nightly-5.9-focal /bin/bash -c "apt-get update; apt-get install make; (cd sdk && make install); swift test -Xswiftc -cxx-interoperability-mode=default"
+	docker run -v `pwd`:`pwd` -w `pwd` --name steamworks --rm swift:5.10 /bin/bash -c "apt-get update; apt-get install make; (cd sdk && make install); swift test  -Xswiftc -cxx-interoperability-mode=default"
 
 shell_linux:
-	docker run -it -v `pwd`:`pwd` -w `pwd` --name steamworks --rm  swiftlang/swift:nightly-5.9-focal /bin/bash
+	docker run -it -v `pwd`:`pwd` -w `pwd` --name steamworks --rm swift:5.10 /bin/bash

Package.resolved

@@ -23,17 +23,17 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/apple/swift-log.git",
       "state" : {
-        "revision" : "532d8b529501fb73a2455b179e0bbb6d49b652ed",
-        "version" : "1.5.3"
+        "revision" : "e97a6fcb1ab07462881ac165fdbb37f067e205d5",
+        "version" : "1.5.4"
       }
     },
     {
       "identity" : "yams",
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/jpsim/Yams.git",
       "state" : {
-        "revision" : "0d9ee7ea8c4ebd4a489ad7a73d5c6cad55d6fed3",
-        "version" : "5.0.6"
+        "revision" : "9234124cff5e22e178988c18d8b95a8ae8007f76",
+        "version" : "5.1.2"
       }
     }
   ],

Package.swift

@@ -49,7 +49,9 @@ import PackageDescription
 // so that Xcode in SPM mode can depend on Steamworks.
 
 var steamworksSwiftFlags: [SwiftSetting] = [
-    .interoperabilityMode(.Cxx)
+    .interoperabilityMode(.Cxx),
+    .enableExperimentalFeature("AccessLevelOnImport"),
+    .enableExperimentalFeature("StrictConcurrency")
 ]
 
 let pkgConfigSetting = "steamworks-swift"
@@ -100,7 +102,7 @@ if !hasPkgConfig {
 let package = Package(
   name: "steamworks-swift",
   platforms: [
-    .macOS("13.0"),
+    .macOS("14.0"),
   ],
   products: [
     .library(

Sources/LibGenerate/DocStructure.swift

@@ -115,6 +115,9 @@ struct DocStructure {
     /// Common Types is a special catch-all
     static let commonTypesHeader = "steamclientpublic.h"
 
+    /// A fabricated header that we use to hold common types purely created by Steamworks-swift
+    static let fakeCommonTypesHeader = "fakecommon.h"
+
     /// 'Primary' headers each generate a section in the docs.
     /// 'Secondary' headers' contents are merged over into their primaries.
     static let secondaryHeaderMap = [
@@ -123,7 +126,10 @@ struct DocStructure {
         "isteamhttp.h" : ["steamhttpenums.h"],
         "isteamnetworkingutils.h" : ["steamnetworkingtypes.h"], /* bit arbitrary */
         "isteamnetworkingsockets.h" : ["steamnetworkingfakeip.h"],
-        commonTypesHeader : ["steamtypes.h", "steamuniverse.h", "steam_api_common.h", "steam_gameserver.h"]
+        commonTypesHeader : [
+            "steamtypes.h", "steamuniverse.h", "steam_api_common.h",
+            "steam_gameserver.h", "steam_api.h", fakeCommonTypesHeader
+        ]
     ]
 
     static let secondaryHeaders = Set(secondaryHeaderMap.values.joined())
@@ -148,8 +154,29 @@ struct DocStructure {
                  filename == Self.commonTypesHeader
     }
 
+    /// List of SwiftType type names found per header file
     typealias SwiftTypeSets = [String : Set<SwiftType>]
 
+    /// Types that need to go into the common types docs that are not found from the Steam headers
+    static let fakeCommonTypes: [(String, Generated.Kind)] = [
+        ("SteamUncheckedSendable", .struct),
+        ("SteamUnsafeRawPointer", .typedef),
+        ("SteamUnsafeMutablePointer", .typedef),
+        ("SteamUnsafeMutableRawPointer", .typedef)
+    ]
+
+    func addFakeCommonTypes(types: SwiftTypeSets) -> SwiftTypeSets {
+        var fakeTypes: Set<SwiftType> = []
+        for (name, kind) in Self.fakeCommonTypes {
+            let swiftType = SwiftType(name)
+            fakeTypes.insert(swiftType)
+            generated.add(type: swiftType, kind: kind)
+        }
+        var types = types
+        types[Self.fakeCommonTypesHeader] = fakeTypes
+        return types
+    }
+
     /// Generate ToC / Index for jazzy/bebop/j2 and docc structured 'semantically',
     /// that is by steam interface.  Broadly use the SDK header files to figure out
     /// which enums/structs etc. are associated with which interfaces, but a fair bit
@@ -235,7 +262,7 @@ struct DocStructure {
 
     /// Add the secondary files' types into their primary files' sets, remove the secondaries from the list
     private func mergeSecondaryHeaders(types: SwiftTypeSets) -> SwiftTypeSets {
-        var result = types
+        var result = addFakeCommonTypes(types: types)
         for (prim, secs) in Self.secondaryHeaderMap {
             for sec in secs {
                 guard let secTypes = result.removeValue(forKey: sec) else {

Sources/LibGenerate/Generated.swift

@@ -44,7 +44,7 @@ final class Generated {
 
     /// Steamworks types that are implemented manually instead of being generated.
     /// They should appear in doc sections driven by the header files.
-    private static var manualTypes: [(String, Kind)] = [
+    private static let manualTypes: [(String, Kind)] = [
         ("SteamID", .struct),
         ("GameID", .struct),
         ("SteamIPAddress", .struct),

Sources/LibGenerate/IO.swift

@@ -7,7 +7,7 @@
 
 import Foundation
 
-final class IO {
+final class IO: Sendable {
     let redistSdkURL: URL
     let swiftOutputDirURL: URL
     let cOutputDirURL: URL
@@ -135,7 +135,7 @@ final class IO {
         //
         \(fileHeaderLicense)
 
-        @_implementationOnly import CSteamworks
+        internal import CSteamworks
         """
     }
 

Sources/LibGenerate/Interfaces.swift

@@ -89,10 +89,14 @@ extension MetadataDB.Interface.Access {
 
         switch self {
         case .instance:
+            let sendableSwiftType = "Steam\(swiftType)"
             decl = """
-                       private let interface: \(swiftType)
+                       private let _interface: \(sendableSwiftType)
+                       private var interface: \(swiftType) {
+                           _interface.base
+                       }
                        init(_ interface: \(swiftType)) {
-                           self.interface = interface
+                           self._interface = .init(interface)
                        }
                    """
         case .user(let accessor), .gameserver(let accessor), .global(let accessor):

Sources/LibGenerate/Metadata.swift

@@ -195,7 +195,7 @@ struct Patch: Codable {
 /// Also fast lookups and central access for weird special cases of knowledge needs
 /// (like 'is this random string an enum?')
 ///
-struct MetadataDB {
+struct MetadataDB: Sendable {
     struct Const {
         let name: SteamHungarianName
         let type: SteamType
@@ -213,7 +213,7 @@ struct MetadataDB {
     /// Indexed by `constname`, filtered by patch exclude-list
     let consts: [SteamHungarianName : Const]
 
-    final class Enum {
+    final class Enum: Sendable {
         let name: SteamType
         let setPassedInTypeName: SwiftNativeType?
         var isSet: Bool { setPassedInTypeName != nil }
@@ -491,7 +491,7 @@ struct MetadataDB {
 /// Sharable reference wrapper around the API metadata
 ///
 /// The API available here is the patched version.
-final class Metadata: CustomStringConvertible {
+final class Metadata: CustomStringConvertible, Sendable {
     let io: IO
     let db: MetadataDB
 
@@ -560,7 +560,7 @@ final class Metadata: CustomStringConvertible {
         """
     }
 
-    static private(set) var shared: Metadata?
+    nonisolated(unsafe) static private(set) var shared: Metadata?
 
     var allEnums: [MetadataDB.Enum] {
         Array(db.enums.values) + Array(nestedEnums.values)

Sources/LibGenerate/Resources/steam_api_patch.yaml

@@ -161,6 +161,8 @@ enums:
   ESteamNetworkingSendFlags:
     is_set: Int32
     prefix: nSteamNetworkingSend
+  ETimelineGameMode:
+    ignore: "In metadata but not header"
   EUGCContentDescriptorID:
     prefix: EUGCContentDescriptor
   EUGCReadAction:

Sources/LibGenerate/SteamSwiftTypes.swift

@@ -10,7 +10,7 @@
 /// A C++ type used in the native Steam API.  Would be understood by the C++ compiler.
 ///
 /// Eg. a straight type name `SteamFoo_t` or a parameter type eg. `const SteamFoo_t *`.
-struct SteamType: StringFungible {
+struct SteamType: StringFungible, Sendable {
     let name: String
 
     init(_ name: String) {
@@ -78,6 +78,14 @@ extension SteamType {
         return SwiftType(name1.replacingOccurrences(of: "_", with: ""))
     }
 
+    var sendableSwiftType: SwiftType {
+        let base = swiftType
+        if base.isSendable {
+            return base
+        }
+        return SwiftType("Steam\(base.name)")
+    }
+
     /// Does this C++ type look like a pointer but is actually something else?
     /// Mostly for `const char *` -> `String`
     fileprivate var isPointerTypePassedByValue: Bool {
@@ -409,6 +417,10 @@ extension SwiftTypeUtils {
     var isOptional: Bool {
         name.hasSuffix("?")
     }
+
+    var isSendable: Bool {
+        !name.re_isMatch("^Unsafe.*Pointer$")
+    }
 }
 
 // MARK: SwiftExpr

Sources/LibGenerate/Structs.swift

@@ -97,7 +97,7 @@ extension MetadataDB.Struct.Field {
     /// Swift structure declaration field
     var declLine: [String] {[
         "/// Steamworks `\(name)`",
-        "public let \(name.swiftName): \(type.swiftType)"
+        "public let \(name.swiftName): \(type.sendableSwiftType)"
     ]}
 
     /// Swift structure initializer lines
@@ -130,7 +130,7 @@ extension MetadataDB.Struct.Field {
     /// Default value setup for memberwise initializer
     var memberwiseParameter: String {
         let initClause = type.swiftTypeInstance.flatMap { " = \($0)"} ?? ""
-        return "\(name.swiftName): \(type.swiftType)\(initClause)"
+        return "\(name.swiftName): \(type.sendableSwiftType)\(initClause)"
     }
 
     /// Initializer line for memberwise initializer

Sources/LibGenerate/Typedefs.swift

@@ -56,12 +56,28 @@ extension MetadataDB.Typedef {
         var decl = """
                    /// Steamworks `\(typedef)`
                    public struct \(swiftType): Hashable, Sendable {
-                       public let value: \(swiftNativeType)
-                       public init(_ value: \(swiftNativeType)) { self.value = value }
-                   }
 
-                   extension \(swiftType): SteamTypeAlias, SteamCreatable {}
                    """
+        if swiftNativeType.isSendable {
+            decl += """
+                        public let value: \(swiftNativeType)
+                        public init(_ value: \(swiftNativeType)) { self.value = value }
+                    }
+                    """
+        } else {
+            decl += """
+                        private let _value: Steam\(swiftNativeType)
+                        public var value: \(swiftNativeType) { _value.base }
+                        public init(_ value: \(swiftNativeType)) { self._value = .init(value) }
+                    }
+                    """
+        }
+        decl += """
+
+
+                extension \(swiftType): SteamTypeAlias, SteamCreatable {}
+                """
+
         if swiftNativeType.isInteger {
             decl += """
 

Sources/Steamworks/Documentation.docc/Generated/Common Types.md

@@ -14,6 +14,9 @@
 - ``SteamAPICall``
 - ``SteamAPIWarningMessageHook``
 - ``SteamErrMsg``
+- ``SteamUnsafeMutablePointer``
+- ``SteamUnsafeMutableRawPointer``
+- ``SteamUnsafeRawPointer``
 
 ### Enumerations and Option Sets
 - ``AccountType``
@@ -33,6 +36,7 @@
 - ``PlayerResult``
 - ``Result``
 - ``ServerMode``
+- ``SteamAPIInitResult``
 - ``SteamIPType``
 - ``SteamIPv6ConnectivityProtocol``
 - ``SteamIPv6ConnectivityState``
@@ -44,3 +48,4 @@
 - ``GameID``
 - ``SteamID``
 - ``SteamIPAddress``
+- ``SteamUncheckedSendable``