Merge pull request #1130 from DougGregor/macro-decl-definition-syntax

[Macros] Adjust macro declaration syntax to match the latest pitch.

Author: DougGregor

CodeGeneration/Sources/SyntaxSupport/gyb_generated/DeclNodes.swift

@@ -1543,40 +1543,14 @@ public let DECL_NODES: [Node] = [
                  Child(name: "ValueLike",
                        kind: "TypeAnnotation")
                ]),
-         Child(name: "Equal",
-               kind: "EqualToken",
-               tokenChoices: [
-                 "Equal"
-               ]),
-         Child(name: "ExternalName",
-               kind: "ExternalMacroName",
+         Child(name: "Definition",
+               kind: "InitializerClause",
                isOptional: true),
          Child(name: "GenericWhereClause",
                kind: "GenericWhereClause",
                isOptional: true)
        ]),
 
-  Node(name: "ExternalMacroName",
-       nameForDiagnostics: "external macro name",
-       kind: "Syntax",
-       children: [
-         Child(name: "ModuleName",
-               kind: "IdentifierToken",
-               tokenChoices: [
-                 "Identifier"
-               ]),
-         Child(name: "Period",
-               kind: "PeriodToken",
-               tokenChoices: [
-                 "Period"
-               ]),
-         Child(name: "MacroTypeName",
-               kind: "IdentifierToken",
-               tokenChoices: [
-                 "Identifier"
-               ])
-       ]),
-
   Node(name: "MacroExpansionDecl",
        nameForDiagnostics: "pound literal declaration",
        kind: "Decl",

Sources/SwiftParser/Declarations.swift

@@ -2039,18 +2039,16 @@ extension Parser {
       signature = .functionLike(self.parseFunctionSignature())
     }
 
-    // External macro name
-    let (unexpectedBeforeEqual, equal) = self.expect(.equal)
-    let (unexpectedBeforeModuleName, moduleName) = self.expectIdentifier()
-    let (unexpectedBeforePeriod, period) = self.expect(.period)
-    let (unexpectedBeforeMacroTypeName, macroTypeName) = self.expectIdentifier()
-
-    let externalMacroName = RawExternalMacroNameSyntax(
-      unexpectedBeforeModuleName, moduleName: moduleName,
-      unexpectedBeforePeriod, period: period,
-      unexpectedBeforeMacroTypeName, macroTypeName: macroTypeName,
-      arena: self.arena
-    )
+    // Initializer, if any.
+    let definition: RawInitializerClauseSyntax?
+    if let equal = self.consume(if: .equal) {
+      let expr = self.parseExpression()
+      definition = RawInitializerClauseSyntax(
+        equal: equal, value: expr, arena: self.arena
+      )
+    } else {
+      definition = nil
+    }
 
     // Parse a 'where' clause if present.
     let whereClause: RawGenericWhereClauseSyntax?
@@ -2065,8 +2063,7 @@ extension Parser {
       unexpectedBeforeIntroducerKeyword, macroKeyword: introducerKeyword,
       unexpectedBeforeName, identifier: name,
       genericParameterClause: genericParams,
-      signature: signature, unexpectedBeforeEqual, equal: equal,
-      externalName: externalMacroName,
+      signature: signature, definition: definition,
       genericWhereClause: whereClause,
       arena: self.arena
     )

Sources/SwiftSyntax/Documentation.docc/gyb_generated/SwiftSyntax.md

@@ -354,7 +354,6 @@ allows Swift tools to parse, inspect, generate, and transform Swift source code.
 - <doc:SwiftSyntax/PrecedenceGroupNameElementSyntax>
 - <doc:SwiftSyntax/PrecedenceGroupAssignmentSyntax>
 - <doc:SwiftSyntax/PrecedenceGroupAssociativitySyntax>
-- <doc:SwiftSyntax/ExternalMacroNameSyntax>
 - <doc:SwiftSyntax/TokenListSyntax>
 - <doc:SwiftSyntax/NonEmptyTokenListSyntax>
 - <doc:SwiftSyntax/CustomAttributeSyntax>

Sources/SwiftSyntax/Raw/gyb_generated/RawSyntaxNodes.swift

@@ -10878,17 +10878,15 @@ public struct RawMacroDeclSyntax: RawDeclSyntaxNodeProtocol {
     genericParameterClause: RawGenericParameterClauseSyntax?,
     _ unexpectedBetweenGenericParameterClauseAndSignature: RawUnexpectedNodesSyntax? = nil,
     signature: Signature,
-    _ unexpectedBetweenSignatureAndEqual: RawUnexpectedNodesSyntax? = nil,
-    equal: RawTokenSyntax,
-    _ unexpectedBetweenEqualAndExternalName: RawUnexpectedNodesSyntax? = nil,
-    externalName: RawExternalMacroNameSyntax?,
-    _ unexpectedBetweenExternalNameAndGenericWhereClause: RawUnexpectedNodesSyntax? = nil,
+    _ unexpectedBetweenSignatureAndDefinition: RawUnexpectedNodesSyntax? = nil,
+    definition: RawInitializerClauseSyntax?,
+    _ unexpectedBetweenDefinitionAndGenericWhereClause: RawUnexpectedNodesSyntax? = nil,
     genericWhereClause: RawGenericWhereClauseSyntax?,
     _ unexpectedAfterGenericWhereClause: RawUnexpectedNodesSyntax? = nil,
     arena: __shared SyntaxArena
   ) {
     let raw = RawSyntax.makeLayout(
-      kind: .macroDecl, uninitializedCount: 19, arena: arena) { layout in
+      kind: .macroDecl, uninitializedCount: 17, arena: arena) { layout in
       layout.initialize(repeating: nil)
       layout[0] = unexpectedBeforeAttributes?.raw
       layout[1] = attributes?.raw
@@ -10902,13 +10900,11 @@ public struct RawMacroDeclSyntax: RawDeclSyntaxNodeProtocol {
       layout[9] = genericParameterClause?.raw
       layout[10] = unexpectedBetweenGenericParameterClauseAndSignature?.raw
       layout[11] = signature.raw
-      layout[12] = unexpectedBetweenSignatureAndEqual?.raw
-      layout[13] = equal.raw
-      layout[14] = unexpectedBetweenEqualAndExternalName?.raw
-      layout[15] = externalName?.raw
-      layout[16] = unexpectedBetweenExternalNameAndGenericWhereClause?.raw
-      layout[17] = genericWhereClause?.raw
-      layout[18] = unexpectedAfterGenericWhereClause?.raw
+      layout[12] = unexpectedBetweenSignatureAndDefinition?.raw
+      layout[13] = definition?.raw
+      layout[14] = unexpectedBetweenDefinitionAndGenericWhereClause?.raw
+      layout[15] = genericWhereClause?.raw
+      layout[16] = unexpectedAfterGenericWhereClause?.raw
     }
     self.init(raw: raw)
   }
@@ -10949,96 +10945,20 @@ public struct RawMacroDeclSyntax: RawDeclSyntaxNodeProtocol {
   public var signature: RawSyntax {
     layoutView.children[11]!
   }
-  public var unexpectedBetweenSignatureAndEqual: RawUnexpectedNodesSyntax? {
+  public var unexpectedBetweenSignatureAndDefinition: RawUnexpectedNodesSyntax? {
     layoutView.children[12].map(RawUnexpectedNodesSyntax.init(raw:))
   }
-  public var equal: RawTokenSyntax {
-    layoutView.children[13].map(RawTokenSyntax.init(raw:))!
+  public var definition: RawInitializerClauseSyntax? {
+    layoutView.children[13].map(RawInitializerClauseSyntax.init(raw:))
   }
-  public var unexpectedBetweenEqualAndExternalName: RawUnexpectedNodesSyntax? {
+  public var unexpectedBetweenDefinitionAndGenericWhereClause: RawUnexpectedNodesSyntax? {
     layoutView.children[14].map(RawUnexpectedNodesSyntax.init(raw:))
   }
-  public var externalName: RawExternalMacroNameSyntax? {
-    layoutView.children[15].map(RawExternalMacroNameSyntax.init(raw:))
-  }
-  public var unexpectedBetweenExternalNameAndGenericWhereClause: RawUnexpectedNodesSyntax? {
-    layoutView.children[16].map(RawUnexpectedNodesSyntax.init(raw:))
-  }
   public var genericWhereClause: RawGenericWhereClauseSyntax? {
-    layoutView.children[17].map(RawGenericWhereClauseSyntax.init(raw:))
+    layoutView.children[15].map(RawGenericWhereClauseSyntax.init(raw:))
   }
   public var unexpectedAfterGenericWhereClause: RawUnexpectedNodesSyntax? {
-    layoutView.children[18].map(RawUnexpectedNodesSyntax.init(raw:))
-  }
-}
-
-@_spi(RawSyntax)
-public struct RawExternalMacroNameSyntax: RawSyntaxNodeProtocol {
-
-  @_spi(RawSyntax)
-  public var layoutView: RawSyntaxLayoutView {
-    return raw.layoutView!
-  }
-
-  public static func isKindOf(_ raw: RawSyntax) -> Bool {
-    return raw.kind == .externalMacroName
-  }
-
-  public var raw: RawSyntax
-  init(raw: RawSyntax) {
-    assert(Self.isKindOf(raw))
-    self.raw = raw
-  }
-
-  public init?<Node: RawSyntaxNodeProtocol>(_ other: Node) {
-    guard Self.isKindOf(other.raw) else { return nil }
-    self.init(raw: other.raw)
-  }
-
-  public init(
-    _ unexpectedBeforeModuleName: RawUnexpectedNodesSyntax? = nil,
-    moduleName: RawTokenSyntax,
-    _ unexpectedBetweenModuleNameAndPeriod: RawUnexpectedNodesSyntax? = nil,
-    period: RawTokenSyntax,
-    _ unexpectedBetweenPeriodAndMacroTypeName: RawUnexpectedNodesSyntax? = nil,
-    macroTypeName: RawTokenSyntax,
-    _ unexpectedAfterMacroTypeName: RawUnexpectedNodesSyntax? = nil,
-    arena: __shared SyntaxArena
-  ) {
-    let raw = RawSyntax.makeLayout(
-      kind: .externalMacroName, uninitializedCount: 7, arena: arena) { layout in
-      layout.initialize(repeating: nil)
-      layout[0] = unexpectedBeforeModuleName?.raw
-      layout[1] = moduleName.raw
-      layout[2] = unexpectedBetweenModuleNameAndPeriod?.raw
-      layout[3] = period.raw
-      layout[4] = unexpectedBetweenPeriodAndMacroTypeName?.raw
-      layout[5] = macroTypeName.raw
-      layout[6] = unexpectedAfterMacroTypeName?.raw
-    }
-    self.init(raw: raw)
-  }
-
-  public var unexpectedBeforeModuleName: RawUnexpectedNodesSyntax? {
-    layoutView.children[0].map(RawUnexpectedNodesSyntax.init(raw:))
-  }
-  public var moduleName: RawTokenSyntax {
-    layoutView.children[1].map(RawTokenSyntax.init(raw:))!
-  }
-  public var unexpectedBetweenModuleNameAndPeriod: RawUnexpectedNodesSyntax? {
-    layoutView.children[2].map(RawUnexpectedNodesSyntax.init(raw:))
-  }
-  public var period: RawTokenSyntax {
-    layoutView.children[3].map(RawTokenSyntax.init(raw:))!
-  }
-  public var unexpectedBetweenPeriodAndMacroTypeName: RawUnexpectedNodesSyntax? {
-    layoutView.children[4].map(RawUnexpectedNodesSyntax.init(raw:))
-  }
-  public var macroTypeName: RawTokenSyntax {
-    layoutView.children[5].map(RawTokenSyntax.init(raw:))!
-  }
-  public var unexpectedAfterMacroTypeName: RawUnexpectedNodesSyntax? {
-    layoutView.children[6].map(RawUnexpectedNodesSyntax.init(raw:))
+    layoutView.children[16].map(RawUnexpectedNodesSyntax.init(raw:))
   }
 }
 

Sources/SwiftSyntax/Raw/gyb_generated/RawSyntaxValidation.swift

@@ -1588,7 +1588,7 @@ func validateLayout(layout: RawSyntaxBuffer, as kind: SyntaxKind) {
     assertNoError(kind, 6, verify(layout[6], as: RawUnexpectedNodesSyntax?.self))
     break
   case .macroDecl:
-    assert(layout.count == 19)
+    assert(layout.count == 17)
     assertNoError(kind, 0, verify(layout[0], as: RawUnexpectedNodesSyntax?.self))
     assertNoError(kind, 1, verify(layout[1], as: RawAttributeListSyntax?.self))
     assertNoError(kind, 2, verify(layout[2], as: RawUnexpectedNodesSyntax?.self))
@@ -1605,22 +1605,10 @@ func validateLayout(layout: RawSyntaxBuffer, as kind: SyntaxKind) {
       verify(layout[11], as: RawSyntax.self),
     ])
     assertNoError(kind, 12, verify(layout[12], as: RawUnexpectedNodesSyntax?.self))
-    assertNoError(kind, 13, verify(layout[13], as: RawTokenSyntax.self))
+    assertNoError(kind, 13, verify(layout[13], as: RawInitializerClauseSyntax?.self))
     assertNoError(kind, 14, verify(layout[14], as: RawUnexpectedNodesSyntax?.self))
-    assertNoError(kind, 15, verify(layout[15], as: RawExternalMacroNameSyntax?.self))
+    assertNoError(kind, 15, verify(layout[15], as: RawGenericWhereClauseSyntax?.self))
     assertNoError(kind, 16, verify(layout[16], as: RawUnexpectedNodesSyntax?.self))
-    assertNoError(kind, 17, verify(layout[17], as: RawGenericWhereClauseSyntax?.self))
-    assertNoError(kind, 18, verify(layout[18], as: RawUnexpectedNodesSyntax?.self))
-    break
-  case .externalMacroName:
-    assert(layout.count == 7)
-    assertNoError(kind, 0, verify(layout[0], as: RawUnexpectedNodesSyntax?.self))
-    assertNoError(kind, 1, verify(layout[1], as: RawTokenSyntax.self))
-    assertNoError(kind, 2, verify(layout[2], as: RawUnexpectedNodesSyntax?.self))
-    assertNoError(kind, 3, verify(layout[3], as: RawTokenSyntax.self))
-    assertNoError(kind, 4, verify(layout[4], as: RawUnexpectedNodesSyntax?.self))
-    assertNoError(kind, 5, verify(layout[5], as: RawTokenSyntax.self))
-    assertNoError(kind, 6, verify(layout[6], as: RawUnexpectedNodesSyntax?.self))
     break
   case .macroExpansionDecl:
     assert(layout.count == 17)

Sources/SwiftSyntax/gyb_generated/Misc.swift

@@ -177,7 +177,6 @@ extension Syntax {
       .node(PrecedenceGroupAssignmentSyntax.self),
       .node(PrecedenceGroupAssociativitySyntax.self),
       .node(MacroDeclSyntax.self),
-      .node(ExternalMacroNameSyntax.self),
       .node(MacroExpansionDeclSyntax.self),
       .node(TokenListSyntax.self),
       .node(NonEmptyTokenListSyntax.self),
@@ -464,7 +463,6 @@ extension SyntaxKind {
     case .precedenceGroupAssignment: return PrecedenceGroupAssignmentSyntax.self
     case .precedenceGroupAssociativity: return PrecedenceGroupAssociativitySyntax.self
     case .macroDecl: return MacroDeclSyntax.self
-    case .externalMacroName: return ExternalMacroNameSyntax.self
     case .macroExpansionDecl: return MacroExpansionDeclSyntax.self
     case .tokenList: return TokenListSyntax.self
     case .nonEmptyTokenList: return NonEmptyTokenListSyntax.self
@@ -911,8 +909,6 @@ extension SyntaxKind {
       return "'associativity' property of precedencegroup"
     case .macroDecl:
       return "macro"
-    case .externalMacroName:
-      return "external macro name"
     case .macroExpansionDecl:
       return "pound literal declaration"
     case .tokenList:

Sources/SwiftSyntax/gyb_generated/SyntaxAnyVisitor.swift

@@ -1181,13 +1181,6 @@ open class SyntaxAnyVisitor: SyntaxVisitor {
   override open func visitPost(_ node: MacroDeclSyntax) {
     visitAnyPost(node._syntaxNode)
   }
-  override open func visit(_ node: ExternalMacroNameSyntax) -> SyntaxVisitorContinueKind {
-    return visitAny(node._syntaxNode)
-  }
-
-  override open func visitPost(_ node: ExternalMacroNameSyntax) {
-    visitAnyPost(node._syntaxNode)
-  }
   override open func visit(_ node: MacroExpansionDeclSyntax) -> SyntaxVisitorContinueKind {
     return visitAny(node._syntaxNode)
   }

Sources/SwiftSyntax/gyb_generated/SyntaxEnum.swift

@@ -177,7 +177,6 @@ public enum SyntaxEnum {
   case precedenceGroupAssignment(PrecedenceGroupAssignmentSyntax)
   case precedenceGroupAssociativity(PrecedenceGroupAssociativitySyntax)
   case macroDecl(MacroDeclSyntax)
-  case externalMacroName(ExternalMacroNameSyntax)
   case macroExpansionDecl(MacroExpansionDeclSyntax)
   case tokenList(TokenListSyntax)
   case nonEmptyTokenList(NonEmptyTokenListSyntax)
@@ -625,8 +624,6 @@ public extension Syntax {
       return .precedenceGroupAssociativity(PrecedenceGroupAssociativitySyntax(self)!)
     case .macroDecl:
       return .macroDecl(MacroDeclSyntax(self)!)
-    case .externalMacroName:
-      return .externalMacroName(ExternalMacroNameSyntax(self)!)
     case .macroExpansionDecl:
       return .macroExpansionDecl(MacroExpansionDeclSyntax(self)!)
     case .tokenList: