The Swift binding

Clunkyard's Swift API calls the shared core through its generated C ABI. The generator emits subsystem methods, records and conformance bridges from protocol/v2/api.json. The run loop and exception mapping are written by hand. Protocol parsing, tracking, physics and act serialization stay in the core.

Install with make install SDK=/opt/clunkyard/sdk. Build a robot with:

swiftc -O -parse-as-library -I/opt/clunkyard/sdk/bindings/swift bot.swift \
  -L/opt/clunkyard/sdk/bindings/swift -lClunkyardSwift \
  -L/opt/clunkyard/sdk/lib -Xlinker -l:libclunkyard.a -lm -ldl -lpthread -o bot

Properties and methods throw CoreError, which carries the core status. Optional results are nil. Lists and text are owned Swift values. Records use C layouts; snake-case fields also have camelCase accessors. Enum values are Int32 constants, allowing unknown values to reach the core for validation. Controls take named optional fields and merge within the turn. Getter methods such as drive.getThrottle() read pending controls. Throw Forfeit(code,message) to forfeit; other callback errors are logged with a stack trace before sending the controls already set. play(lines) uses an in-memory core session.

A tiny robot

import Clunkyard
@main final class Bot:Robot {
    override func onTurn() throws {
        guard let target=try sensors.nearest else {
            try drive.set(throttle:0.75,turn:0.25)
            try scanner.set(heading:me.heading,arc:40)
            try status.set(text:"SEARCH",value:scanner.last.arc)
            return
        }
        let power=try gun.powerForFlightTime(target.range,1),aim=try gun.lead(target,power)
        try gun.aim(heading:aim?.heading ?? target.bearing,pitch:aim?.pitch ?? target.elevation)
        if try gun.canFire(power,10) {try gun.fire(power:power)}
        try drive.set(throttle:0.5,turn:angles.clamp(angles.angleDiff(target.bearing,me.heading),-1,1))
        try scanner.set(heading:target.bearing,arc:10)
        try status.set(text:"TRACK",value:target.range)
    }
    static func main() throws {try Bot().run()}
}

make test SDK=... compares the Swift wrappers with every API vector, including exact floating-point bits and act lines.

Names

Every entry of the robot API 2.0.0 in Swift. names.md has every language side by side.

Download this page as Markdown