playdate-kit/Sources/PlaydateKit/PlaydateKit.swift

//
//  PlaydateKit.swift
//  Swift bindings to the Playdate C API.
//
//  The C API is delivered as a `PlaydateAPI` struct of function pointers that
//  the firmware hands to the game's `eventHandler` entry point. Call
//  `Playdate.initialize(with:)` from that entry point before using any other
//  API in this module.
//

public import CPlaydate

/// The raw C API bootstrap. Everything else in this module (System,
/// Graphics, Sprite, Sound, ...) lives at the top level of the `PlaydateKit`
/// module and requires `initialize(with:)` to have been called first.
public enum Playdate {
    /// The raw C API. Populated by `initialize(with:)`.
    ///
    /// Access is unsynchronized: the Playdate runtime is single-threaded and
    /// the API pointer is written exactly once at startup.
    public internal(set) nonisolated(unsafe) static var api: PlaydateAPI!

    /// The raw C API pointer handed to `initialize(with:)`, for calls that
    /// need to pass the `PlaydateAPI*` back to C.
    public internal(set) nonisolated(unsafe) static var apiPointer: UnsafeMutablePointer<PlaydateAPI>!

    // Sub-API pointers cached once at initialization, so wrapper calls are a
    // single field load off a pointer instead of re-walking `api` per call.
    nonisolated(unsafe) static var systemAPI: UnsafePointer<playdate_sys>!
    nonisolated(unsafe) static var displayAPI: UnsafePointer<playdate_display>!
    nonisolated(unsafe) static var graphicsAPI: UnsafePointer<playdate_graphics>!
    nonisolated(unsafe) static var spriteAPI: UnsafePointer<playdate_sprite>!
    nonisolated(unsafe) static var soundAPI: UnsafePointer<playdate_sound>!
    nonisolated(unsafe) static var fileAPI: UnsafePointer<playdate_file>!
    nonisolated(unsafe) static var jsonAPI: UnsafePointer<playdate_json>!
    nonisolated(unsafe) static var luaAPI: UnsafePointer<playdate_lua>!
    nonisolated(unsafe) static var scoreboardsAPI: UnsafePointer<playdate_scoreboards>!
    nonisolated(unsafe) static var networkAPI: UnsafePointer<playdate_network>!

    // Second-level tables, cached for the same reason. Assigned with
    // optional chaining because partial API tables (e.g. test mocks) may
    // leave some of them null; using an absent table traps at the call
    // site, as before.
    nonisolated(unsafe) static var tilemapAPI: UnsafePointer<playdate_tilemap>!
    nonisolated(unsafe) static var videoAPI: UnsafePointer<playdate_video>!
    nonisolated(unsafe) static var videoStreamAPI: UnsafePointer<playdate_videostream>!
    nonisolated(unsafe) static var channelAPI: UnsafePointer<playdate_sound_channel>!
    nonisolated(unsafe) static var sourceAPI: UnsafePointer<playdate_sound_source>!
    nonisolated(unsafe) static var filePlayerAPI: UnsafePointer<playdate_sound_fileplayer>!
    nonisolated(unsafe) static var sampleAPI: UnsafePointer<playdate_sound_sample>!
    nonisolated(unsafe) static var samplePlayerAPI: UnsafePointer<playdate_sound_sampleplayer>!
    nonisolated(unsafe) static var synthAPI: UnsafePointer<playdate_sound_synth>!
    nonisolated(unsafe) static var instrumentAPI: UnsafePointer<playdate_sound_instrument>!
    nonisolated(unsafe) static var trackAPI: UnsafePointer<playdate_sound_track>!
    nonisolated(unsafe) static var sequenceAPI: UnsafePointer<playdate_sound_sequence>!
    nonisolated(unsafe) static var signalAPI: UnsafePointer<playdate_sound_signal>!
    nonisolated(unsafe) static var lfoAPI: UnsafePointer<playdate_sound_lfo>!
    nonisolated(unsafe) static var envelopeAPI: UnsafePointer<playdate_sound_envelope>!
    nonisolated(unsafe) static var controlSignalAPI: UnsafePointer<playdate_control_signal>!
    nonisolated(unsafe) static var effectAPI: UnsafePointer<playdate_sound_effect>!
    nonisolated(unsafe) static var twoPoleFilterAPI: UnsafePointer<playdate_sound_effect_twopolefilter>!
    nonisolated(unsafe) static var onePoleFilterAPI: UnsafePointer<playdate_sound_effect_onepolefilter>!
    nonisolated(unsafe) static var bitCrusherAPI: UnsafePointer<playdate_sound_effect_bitcrusher>!
    nonisolated(unsafe) static var ringModulatorAPI: UnsafePointer<playdate_sound_effect_ringmodulator>!
    nonisolated(unsafe) static var delayLineAPI: UnsafePointer<playdate_sound_effect_delayline>!
    nonisolated(unsafe) static var overdriveAPI: UnsafePointer<playdate_sound_effect_overdrive>!
    nonisolated(unsafe) static var httpAPI: UnsafePointer<playdate_http>!
    nonisolated(unsafe) static var tcpAPI: UnsafePointer<playdate_tcp>!

    /// Stores the API pointer handed to the game's `eventHandler`.
    ///
    /// Call this first, on the `.initialize` event, before using any other
    /// wrapper in this module.
    public static func initialize(with pointer: UnsafeMutableRawPointer) {
        apiPointer = pointer.assumingMemoryBound(to: PlaydateAPI.self)
        api = apiPointer.pointee
        systemAPI = api.system
        displayAPI = api.display
        graphicsAPI = api.graphics
        spriteAPI = api.sprite
        soundAPI = api.sound
        fileAPI = api.file
        jsonAPI = api.json
        luaAPI = api.lua
        scoreboardsAPI = api.scoreboards
        networkAPI = api.network
        tilemapAPI = graphicsAPI?.pointee.tilemap
        videoAPI = graphicsAPI?.pointee.video
        videoStreamAPI = graphicsAPI?.pointee.videostream
        channelAPI = soundAPI?.pointee.channel
        sourceAPI = soundAPI?.pointee.source
        filePlayerAPI = soundAPI?.pointee.fileplayer
        sampleAPI = soundAPI?.pointee.sample
        samplePlayerAPI = soundAPI?.pointee.sampleplayer
        synthAPI = soundAPI?.pointee.synth
        instrumentAPI = soundAPI?.pointee.instrument
        trackAPI = soundAPI?.pointee.track
        sequenceAPI = soundAPI?.pointee.sequence
        signalAPI = soundAPI?.pointee.signal
        lfoAPI = soundAPI?.pointee.lfo
        envelopeAPI = soundAPI?.pointee.envelope
        controlSignalAPI = soundAPI?.pointee.controlsignal
        effectAPI = soundAPI?.pointee.effect
        twoPoleFilterAPI = effectAPI?.pointee.twopolefilter
        onePoleFilterAPI = effectAPI?.pointee.onepolefilter
        bitCrusherAPI = effectAPI?.pointee.bitcrusher
        ringModulatorAPI = effectAPI?.pointee.ringmodulator
        delayLineAPI = effectAPI?.pointee.delayline
        overdriveAPI = effectAPI?.pointee.overdrive
        httpAPI = networkAPI?.pointee.http
        tcpAPI = networkAPI?.pointee.tcp
    }
}

/// An error reported by the Playdate OS.
public struct PlaydateError: Swift.Error, Sendable {
    public let message: String

    init(message: String) {
        self.message = message
    }

    init(cString: UnsafePointer<CChar>?) {
        self.init(message: String(playdateCString: cString) ?? "unknown error")
    }
}

/// The user's answer to a permission request (microphone, network).
public enum AccessReply: UInt32, Sendable {
    case ask = 0
    case deny = 1
    case allow = 2
}

/// A Swift view of `PDSystemEvent` with the key code folded into the
/// key events.
public enum SystemEvent {
    case initialize
    case initializeLua
    case lock
    case unlock
    case pause
    case resume
    case terminate
    case keyPressed(keyCode: UInt32)
    case keyReleased(keyCode: UInt32)
    case lowPower
    case mirrorStarted
    case mirrorEnded

    public init?(event: PDSystemEvent, argument: UInt32) {
        switch event {
        case kEventInit: self = .initialize
        case kEventInitLua: self = .initializeLua
        case kEventLock: self = .lock
        case kEventUnlock: self = .unlock
        case kEventPause: self = .pause
        case kEventResume: self = .resume
        case kEventTerminate: self = .terminate
        case kEventKeyPressed: self = .keyPressed(keyCode: argument)
        case kEventKeyReleased: self = .keyReleased(keyCode: argument)
        case kEventLowPower: self = .lowPower
        case kEventMirrorStarted: self = .mirrorStarted
        case kEventMirrorEnded: self = .mirrorEnded
        default: return nil
        }
    }
}