Michael Tsai - Blog - Improving the Usability of C Libraries in Swift (opens in new tab)

Doug Gregor:

The Swift code above has a very “C” feel to it. It has global function calls with prefixed names like wgpuInstanceCreateSurface and global integer constants like WGPUStatus_Error. It pervasively uses unsafe pointers, some of which are managed with explicit reference counting, where the user provides calls to wpuXYZAddRef and wgpuXYZRelease functions. It works, but it doesn’t feel like Swift, and inherits various safety problems of C.

Fortunately, we can improve this situation, providing a safer and more ergonomic interface to WebGPU from Swift that feels like it belongs in Swift. More importantly, we can do so without changing the WebGPU implementation: Swift provides a suite of annotations that you can apply to C headers to improve the way in which the C APIs are expressed in Swift. These annotations describe common conventions in C that match up with Swift constructs, projecting a more Swift-friendly interface on top of the C code.

[…]

The problem of needing to layer information on top of existing C headers is not a new one. As noted earlier, Swift relies on a Clang feature called API notes to let us express this same information in a separate file, so we don’t have to edit the header.

Previously:

• Swift Proposal: InlineArray
• C String Functions in Swift: a malloc’y Story
• C String Functions in Swift
• Swift Tip: OpaquePointer vs. UnsafePointer
• Swift Imports Fixed-size C Arrays As Tuples
• Unsafe Swift: Using Pointers and Interacting With C
• Passing an Array of Strings From Swift to C
• Swift and C Libraries

C Programming Language Clang Language Design Programming Swift Programming Language

Comments