เขียนมาโครนิพจน์แบบอิสระ

การตั้งค่าโครงการ

// Package.swift (excerpt)
.macro(
  name: "MyMacros",
  dependencies: [
    .product(name: "SwiftSyntaxMacros", package: "swift-syntax"),
    .product(name: "SwiftCompilerPlugin", package: "swift-syntax")
  ]
)

การประกาศมาโคร

@freestanding(expression)
public macro stringify<T>(_ value: T) -> (T, String)
  = #externalMacro(module: "MyMacros", type: "StringifyMacro")

การนำชนิดมาโครไปใช้งาน

import SwiftSyntaxMacros
import SwiftSyntax

struct StringifyMacro: ExpressionMacro {
  static func expansion(
    of node: some FreestandingMacroExpansionSyntax,
    in context: some MacroExpansionContext
  ) throws -> ExprSyntax {
    guard let arg = node.arguments.first?.expression else {
      throw MacroError.message("Need an argument")
    }
    return "(\(arg), \(literal: arg.description))"
  }
}

การลงทะเบียนปลั๊กอิน

import SwiftCompilerPlugin

@main
struct MyPlugin: CompilerPlugin {
  let providingMacros: [Macro.Type] = [
    StringifyMacro.self
  ]
}

การใช้มาโคร

import MyMacros
let (value, source) = #stringify(2 + 3)
print(value)   // 5
print(source)  // "2 + 3"

การสร้าง ExprSyntax

// The expansion returns a tuple literal
return "((\(arg)), \(literal: arg.description))"

การเข้าถึงอาร์กิวเมนต์ของมาโคร

let args = node.arguments
for arg in args {
  print(arg.label?.text ?? "_", arg.expression)
}

การสร้างข้อความวินิจฉัย

context.diagnose(Diagnostic(
  node: node,
  message: MyDiagnostic.missingArgument
))

โหนดไวยากรณ์ของ SwiftSyntax

import SwiftSyntax
let expr: ExprSyntax = "1 + 2"
print(type(of: expr)) // BinaryOperatorExprSyntax

การป้องกันการชนกันของชื่อในมาโคร

// Macro-generated variables get unique names internally
// preventing accidental shadowing in user code

การขยายมาโครใน Xcode

#stringify(40 + 2)
// Xcode expands to: (40 + 2, "40 + 2")

ตรวจสอบความเข้าใจ

ทบทวนบทเรียน