Codifies the project's existing style: 4-space indentation, 120-column
lines, ordered imports, one blank line maximum, and private file-scoped
declarations. The force-unwrap/IUO/force-try lint rules stay disabled
because the binding uses those deliberately (the API bootstrap statics,
unsafelyUnwrapped function-pointer calls). Formatting-behavior options
mirror the current layout; the main known divergence is continuation-line
style, where swift-format's fixed indent differs from the paren-aligned
wrapping used in places.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Two hot-path optimizations for the device's Cortex-M7 (and debug simulator
builds):
- The ten sub-API pointers are cached once in Playdate.initialize(with:);
wrapper accessors now return UnsafePointer and call sites read a single
field through it, instead of unwrapping the optional API struct and
copying a whole sub-API struct of function pointers on every call.
Nested sub-APIs (sound classes, effects, video, tilemap, http/tcp)
derive from the cached pointers with one field load.
- String -> C conversions (withPlaydateCString, and a new withPlaydateUTF8
used by the text drawing/measuring APIs) use withUnsafeTemporaryAllocation
instead of building a ContiguousArray, so logging and drawText in the
update loop no longer heap-allocate per call. Verified within the
Embedded Swift subset by the device cross-compile.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The mock allocates real playdate_* structs whose function pointers are
Swift stubs that record their arguments, then hands the fake PlaydateAPI*
to Playdate.initialize(with:). This makes the wrapper plumbing testable on
the host: argument forwarding and type conversion (buttons, colors,
patterns, UTF-8 text), callback trampolines (menu items, sprite update,
audio sources), ownership (bitmaps freed exactly once, table-vended
bitmaps not freed, file handles closed once), collision-info parsing with
system-allocator balance, the JSON tree builder driven by a simulated
parser callback sequence, and regression tests for the CallbackSource
lifecycle fix. Tests run serialized because the recording state is global.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Callback-based sound sources are kept alive in a static registry while the
C side may still invoke their trampoline, but nothing ever removed them:
every callback source leaked its wrapper and closure permanently, and a
source retained only by a transient Channel.default wrapper relied on that
leak for safety. The registry is now the single source of truth and is
purged on Sound.removeSource, Channel.removeSource, and when an owned
channel is freed (its sources can no longer be pulled).
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
- DocC catalog (Sources/PlayDate/PlayDate.docc) with a curated landing
page and a Getting Started article; swift-docc-plugin wired up for
`swift package generate-documentation`, and a GitHub Pages deployment
workflow renders docs on every push to main.
- Examples/HelloPlaydate: a minimal game (bouncing box, crank needle,
button handling, system menu item) whose build.sh compiles the game as
a dylib and produces a runnable simulator .pdx via the SDK's pdc.
Verified: the pdx builds and exports the eventHandler entry point.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
System, Display, Graphics, Sprite, Sound, File, JSON, Lua, Scoreboards,
Network, Rect, SystemEvent, and AccessReply now live at module scope
instead of being nested in the Playdate enum; consumers write
System.log(...) instead of Playdate.System.log(...), and can qualify with
the module name (PlayDate.System) on collision. The Playdate enum remains
only as the raw C API bootstrap (initialize(with:), api, apiPointer), and
Playdate.Error is renamed PlaydateError so no top-level type shadows
Swift.Error.
Breaking change for any existing consumers.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Three jobs in GitHub Actions:
- Build & test on macOS against SDK headers fetched from Panic (cached),
with the pkg-config module generated into PKG_CONFIG_PATH.
- A consumer smoke test (Scripts/consumer-test.sh) generating a scratch
package that depends on play-date, guarding setting propagation.
- An Embedded Swift cross-compile for armv7em-none-none-eabi
(Scripts/build-embedded.sh) on a swift.org snapshot toolchain — the
check that enforces the Embedded Swift subset promise. Verified locally:
the full module compiles for the device triple with no violations.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Wraps all ten subsystems of the Playdate SDK 3.1.1 C API (system, display,
graphics, sprites, sound, file, JSON, Lua, scoreboards, network) in
idiomatic Swift: namespaced APIs, wrapper types with ownership semantics,
closures for callbacks, and typed throws. Written within the Embedded Swift
subset so the same code can target the device.
The SDK headers are resolved through a "playdate" pkg-config module
(Scripts/install-pkgconfig.sh), so the package works as a normal SwiftPM
dependency without unsafe build flags.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
javier
