Getting started with macros?

Ron_Olson · 2023-02-03T18:35:25.375Z

Hi all. TIL Swift has macros per the newsletter I got. Are these C-style macros or something more Swift-y? Is there a page I can check out for getting started; my searches all come up with random SO pages that don’t seem a great way to get one’s feet wet with them.

Finagolfin · 2023-02-03T19:52:33.132Z

Some light reading for you.

Douglas_Gregor · 2023-02-03T19:56:54.307Z

Hello!

We're working on a macros feature for Swift. It's still experimental and going through a bunch of design evolution. Since it can be hard to track what's going on with the development of major features. I'm writing up a gist to help give an overview.

Here is a Swift Macros Dashboard.

Doug

mayoff · 2023-02-04T00:15:10.715Z

I know it would be more work for you but I would love it if the dashboard had more info about what's actually implemented so far. For example, swift-DEVELOPMENT-SNAPSHOT-2023-02-02-a.xctoolchain (the latest atm) doesn't appear to support @attached(peer).

hborla · 2023-02-04T00:37:25.167Z

I believe peer macros are the last major part of the attached macro proposal that is not implemented. I'm working on that, and I expect to have an initial implementation landed under the Macros experimental feature flag early next week!

Douglas_Gregor · 2023-02-04T21:58:11.282Z

mayoff:

I know it would be more work for you but I would love it if the dashboard had more info about what's actually implemented so far. For example, swift-DEVELOPMENT-SNAPSHOT-2023-02-02-a.xctoolchain (the latest atm) doesn't appear to support @attached(peer).

I added some details to the gist about what's expected to work (or not).

Doug

taylorswift · 2023-02-05T20:54:05.127Z

hborla:

I expect to have an initial implementation landed under the Macros experimental feature flag early next week!

is there a centralized guide for how to use the feature flags in SPM projects, and which ones are available for which nightly toolchain?

hborla · 2023-02-06T01:04:34.253Z

taylorswift:

is there a centralized guide for how to use the feature flags in SPM projects

SE-0362 describes the -enable-experimental-feature mechanism and how to use it with SPM. You can also find the SwiftSetting.enableExperimentalFeature documentation in the SPM repository: https://github.com/apple/swift-package-manager/blob/main/Sources/PackageDescription/BuildSettings.swift#L341

taylorswift:

and which ones are available for which nightly toolchain?

I believe the only source of this information today is in the Swift repository for the tag of a given development snapshot in the Features.def file that declares these experimental features. For example, here's the Features.def file in the source code for the February 4th snapshot: https://github.com/apple/swift/blob/swift-DEVELOPMENT-SNAPSHOT-2023-02-04-a/include/swift/Basic/Features.def. Everything declared with EXPERIMENTAL_FEATURE is available to use via -enable-experimental-feature in this snapshot.

filip-sakel · 2023-02-06T03:10:27.538Z

I think @Douglas_Gregor’s macro example repository also requires another flag (to dynamically load the plugins, IIRC?). Is that also required as an unsafe flag or can we just use the experimental feature flag for macros?

Douglas_Gregor · 2023-02-06T20:15:23.418Z

filip-sakel:

I think @Douglas_Gregor’s macro example repository also requires another flag (to dynamically load the plugins, IIRC?). Is that also required as an unsafe flag or can we just use the experimental feature flag for macros?

Yeah, there are other flags to load the compiler "plugin". I wasn't able to express all of the right flags and dependencies in SwiftPM, so the sample project is using Xcode's project model for the moment. It should be straightforward to implement the same set of dependencies in CMake, for example, but for SwiftPM we need an actual implementation of the manifest changes.

Doug