Merge pull request #499 from DougGregor/syntax-decl-cleanup

[Syntax] Clean up syntax grammar for declaration nodes

Author: DougGregor

Examples/CodeGenerationUsingSwiftSyntaxBuilder.swift

@@ -13,7 +13,7 @@ import SwiftSyntaxBuilder
 let source = SourceFile {
   ImportDecl(path: "Foundation")
   ImportDecl(path: "UIKit")
-  ClassDecl(classOrActorKeyword: .class, identifier: "SomeViewController", membersBuilder: {
+  ClassDecl(classKeyword: .class, identifier: "SomeViewController", membersBuilder: {
     VariableDecl(.let, name: "tableView", type: "UITableView")
   })
 }

Sources/SwiftSyntax/gyb_generated/Misc.swift

@@ -577,6 +577,12 @@ extension SyntaxNode {
     return PoundSourceLocationArgsSyntax(asSyntaxData)
   }
 
+  public var isDeclModifierDetail: Bool { return raw.kind == .declModifierDetail }
+  public var asDeclModifierDetail: DeclModifierDetailSyntax? {
+    guard isDeclModifierDetail else { return nil }
+    return DeclModifierDetailSyntax(asSyntaxData)
+  }
+
   public var isDeclModifier: Bool { return raw.kind == .declModifier }
   public var asDeclModifier: DeclModifierSyntax? {
     guard isDeclModifier else { return nil }
@@ -607,6 +613,12 @@ extension SyntaxNode {
     return ClassDeclSyntax(asSyntaxData)
   }
 
+  public var isActorDecl: Bool { return raw.kind == .actorDecl }
+  public var asActorDecl: ActorDeclSyntax? {
+    guard isActorDecl else { return nil }
+    return ActorDeclSyntax(asSyntaxData)
+  }
+
   public var isStructDecl: Bool { return raw.kind == .structDecl }
   public var asStructDecl: StructDeclSyntax? {
     guard isStructDecl else { return nil }
@@ -1715,6 +1727,8 @@ extension Syntax {
       return node
     case .poundSourceLocationArgs(let node):
       return node
+    case .declModifierDetail(let node):
+      return node
     case .declModifier(let node):
       return node
     case .inheritedType(let node):
@@ -1725,6 +1739,8 @@ extension Syntax {
       return node
     case .classDecl(let node):
       return node
+    case .actorDecl(let node):
+      return node
     case .structDecl(let node):
       return node
     case .protocolDecl(let node):

Sources/SwiftSyntax/gyb_generated/SyntaxAnyVisitor.swift

@@ -715,6 +715,13 @@ open class SyntaxAnyVisitor: SyntaxVisitor {
   override open func visitPost(_ node: PoundSourceLocationArgsSyntax) {
     visitAnyPost(node._syntaxNode)
   }
+  override open func visit(_ node: DeclModifierDetailSyntax) -> SyntaxVisitorContinueKind {
+    return visitAny(node._syntaxNode)
+  }
+
+  override open func visitPost(_ node: DeclModifierDetailSyntax) {
+    visitAnyPost(node._syntaxNode)
+  }
   override open func visit(_ node: DeclModifierSyntax) -> SyntaxVisitorContinueKind {
     return visitAny(node._syntaxNode)
   }
@@ -750,6 +757,13 @@ open class SyntaxAnyVisitor: SyntaxVisitor {
   override open func visitPost(_ node: ClassDeclSyntax) {
     visitAnyPost(node._syntaxNode)
   }
+  override open func visit(_ node: ActorDeclSyntax) -> SyntaxVisitorContinueKind {
+    return visitAny(node._syntaxNode)
+  }
+
+  override open func visitPost(_ node: ActorDeclSyntax) {
+    visitAnyPost(node._syntaxNode)
+  }
   override open func visit(_ node: StructDeclSyntax) -> SyntaxVisitorContinueKind {
     return visitAny(node._syntaxNode)
   }

Sources/SwiftSyntax/gyb_generated/SyntaxBaseNodes.swift

@@ -56,7 +56,7 @@ public struct DeclSyntax: DeclSyntaxProtocol, SyntaxHashable {
   /// `nil` if the conversion is not possible.
   public init?(_ syntax: Syntax) {
     switch syntax.raw.kind {
-    case .unknownDecl, .typealiasDecl, .associatedtypeDecl, .ifConfigDecl, .poundErrorDecl, .poundWarningDecl, .poundSourceLocation, .classDecl, .structDecl, .protocolDecl, .extensionDecl, .functionDecl, .initializerDecl, .deinitializerDecl, .subscriptDecl, .importDecl, .accessorDecl, .variableDecl, .enumCaseDecl, .enumDecl, .operatorDecl, .precedenceGroupDecl:
+    case .unknownDecl, .typealiasDecl, .associatedtypeDecl, .ifConfigDecl, .poundErrorDecl, .poundWarningDecl, .poundSourceLocation, .classDecl, .actorDecl, .structDecl, .protocolDecl, .extensionDecl, .functionDecl, .initializerDecl, .deinitializerDecl, .subscriptDecl, .importDecl, .accessorDecl, .variableDecl, .enumCaseDecl, .enumDecl, .operatorDecl, .precedenceGroupDecl:
       self._syntaxNode = syntax
     default:
       return nil
@@ -70,7 +70,7 @@ public struct DeclSyntax: DeclSyntaxProtocol, SyntaxHashable {
     // Assert that the kind of the given data matches in debug builds.
 #if DEBUG
     switch data.raw.kind {
-    case .unknownDecl, .typealiasDecl, .associatedtypeDecl, .ifConfigDecl, .poundErrorDecl, .poundWarningDecl, .poundSourceLocation, .classDecl, .structDecl, .protocolDecl, .extensionDecl, .functionDecl, .initializerDecl, .deinitializerDecl, .subscriptDecl, .importDecl, .accessorDecl, .variableDecl, .enumCaseDecl, .enumDecl, .operatorDecl, .precedenceGroupDecl:
+    case .unknownDecl, .typealiasDecl, .associatedtypeDecl, .ifConfigDecl, .poundErrorDecl, .poundWarningDecl, .poundSourceLocation, .classDecl, .actorDecl, .structDecl, .protocolDecl, .extensionDecl, .functionDecl, .initializerDecl, .deinitializerDecl, .subscriptDecl, .importDecl, .accessorDecl, .variableDecl, .enumCaseDecl, .enumDecl, .operatorDecl, .precedenceGroupDecl:
       break
     default:
       fatalError("Unable to create DeclSyntax from \(data.raw.kind)")

Sources/SwiftSyntax/gyb_generated/SyntaxBuilders.swift

@@ -3238,6 +3238,9 @@ public struct TypealiasDeclSyntaxBuilder {
     if (layout[3] == nil) {
       layout[3] = RawSyntax.missingToken(TokenKind.identifier(""))
     }
+    if (layout[5] == nil) {
+      layout[5] = RawSyntax.missing(SyntaxKind.typeInitializerClause)
+    }
 
     return .forRoot(RawSyntax.createAndCalcLength(kind: .typealiasDecl,
       layout: layout, presence: .present))
@@ -3875,29 +3878,73 @@ extension PoundSourceLocationArgsSyntax {
   }
 }
 
-public struct DeclModifierSyntaxBuilder {
+public struct DeclModifierDetailSyntaxBuilder {
   private var layout =
-    Array<RawSyntax?>(repeating: nil, count: 4)
+    Array<RawSyntax?>(repeating: nil, count: 3)
 
   internal init() {}
 
-  public mutating func useName(_ node: TokenSyntax) {
-    let idx = DeclModifierSyntax.Cursor.name.rawValue
+  public mutating func useLeftParen(_ node: TokenSyntax) {
+    let idx = DeclModifierDetailSyntax.Cursor.leftParen.rawValue
+    layout[idx] = node.raw
+  }
+
+  public mutating func useDetail(_ node: TokenSyntax) {
+    let idx = DeclModifierDetailSyntax.Cursor.detail.rawValue
     layout[idx] = node.raw
   }
 
-  public mutating func useDetailLeftParen(_ node: TokenSyntax) {
-    let idx = DeclModifierSyntax.Cursor.detailLeftParen.rawValue
+  public mutating func useRightParen(_ node: TokenSyntax) {
+    let idx = DeclModifierDetailSyntax.Cursor.rightParen.rawValue
     layout[idx] = node.raw
   }
 
-  public mutating func useDetail(_ node: TokenSyntax) {
-    let idx = DeclModifierSyntax.Cursor.detail.rawValue
+  internal mutating func buildData() -> SyntaxData {
+    if (layout[0] == nil) {
+      layout[0] = RawSyntax.missingToken(TokenKind.leftParen)
+    }
+    if (layout[1] == nil) {
+      layout[1] = RawSyntax.missingToken(TokenKind.identifier(""))
+    }
+    if (layout[2] == nil) {
+      layout[2] = RawSyntax.missingToken(TokenKind.rightParen)
+    }
+
+    return .forRoot(RawSyntax.createAndCalcLength(kind: .declModifierDetail,
+      layout: layout, presence: .present))
+  }
+}
+
+extension DeclModifierDetailSyntax {
+  /// Creates a `DeclModifierDetailSyntax` using the provided build function.
+  /// - Parameter:
+  ///   - build: A closure that will be invoked in order to initialize
+  ///            the fields of the syntax node.
+  ///            This closure is passed a `DeclModifierDetailSyntaxBuilder` which you can use to
+  ///            incrementally build the structure of the node.
+  /// - Returns: A `DeclModifierDetailSyntax` with all the fields populated in the builder
+  ///            closure.
+  public init(_ build: (inout DeclModifierDetailSyntaxBuilder) -> Void) {
+    var builder = DeclModifierDetailSyntaxBuilder()
+    build(&builder)
+    let data = builder.buildData()
+    self.init(data)
+  }
+}
+
+public struct DeclModifierSyntaxBuilder {
+  private var layout =
+    Array<RawSyntax?>(repeating: nil, count: 2)
+
+  internal init() {}
+
+  public mutating func useName(_ node: TokenSyntax) {
+    let idx = DeclModifierSyntax.Cursor.name.rawValue
     layout[idx] = node.raw
   }
 
-  public mutating func useDetailRightParen(_ node: TokenSyntax) {
-    let idx = DeclModifierSyntax.Cursor.detailRightParen.rawValue
+  public mutating func useDetail(_ node: DeclModifierDetailSyntax) {
+    let idx = DeclModifierSyntax.Cursor.detail.rawValue
     layout[idx] = node.raw
   }
 
@@ -4051,8 +4098,8 @@ public struct ClassDeclSyntaxBuilder {
     }
   }
 
-  public mutating func useClassOrActorKeyword(_ node: TokenSyntax) {
-    let idx = ClassDeclSyntax.Cursor.classOrActorKeyword.rawValue
+  public mutating func useClassKeyword(_ node: TokenSyntax) {
+    let idx = ClassDeclSyntax.Cursor.classKeyword.rawValue
     layout[idx] = node.raw
   }
 
@@ -4114,6 +4161,97 @@ extension ClassDeclSyntax {
   }
 }
 
+public struct ActorDeclSyntaxBuilder {
+  private var layout =
+    Array<RawSyntax?>(repeating: nil, count: 8)
+
+  internal init() {}
+
+  public mutating func addAttribute(_ elt: Syntax) {
+    let idx = ActorDeclSyntax.Cursor.attributes.rawValue
+    if let list = layout[idx] {
+      layout[idx] = list.appending(elt.raw)
+    } else {
+      layout[idx] = RawSyntax.create(kind: SyntaxKind.attributeList,
+        layout: [elt.raw], length: elt.raw.totalLength,
+        presence: SourcePresence.present)
+    }
+  }
+
+  public mutating func addModifier(_ elt: DeclModifierSyntax) {
+    let idx = ActorDeclSyntax.Cursor.modifiers.rawValue
+    if let list = layout[idx] {
+      layout[idx] = list.appending(elt.raw)
+    } else {
+      layout[idx] = RawSyntax.create(kind: SyntaxKind.modifierList,
+        layout: [elt.raw], length: elt.raw.totalLength,
+        presence: SourcePresence.present)
+    }
+  }
+
+  public mutating func useActorKeyword(_ node: TokenSyntax) {
+    let idx = ActorDeclSyntax.Cursor.actorKeyword.rawValue
+    layout[idx] = node.raw
+  }
+
+  public mutating func useIdentifier(_ node: TokenSyntax) {
+    let idx = ActorDeclSyntax.Cursor.identifier.rawValue
+    layout[idx] = node.raw
+  }
+
+  public mutating func useGenericParameterClause(_ node: GenericParameterClauseSyntax) {
+    let idx = ActorDeclSyntax.Cursor.genericParameterClause.rawValue
+    layout[idx] = node.raw
+  }
+
+  public mutating func useInheritanceClause(_ node: TypeInheritanceClauseSyntax) {
+    let idx = ActorDeclSyntax.Cursor.inheritanceClause.rawValue
+    layout[idx] = node.raw
+  }
+
+  public mutating func useGenericWhereClause(_ node: GenericWhereClauseSyntax) {
+    let idx = ActorDeclSyntax.Cursor.genericWhereClause.rawValue
+    layout[idx] = node.raw
+  }
+
+  public mutating func useMembers(_ node: MemberDeclBlockSyntax) {
+    let idx = ActorDeclSyntax.Cursor.members.rawValue
+    layout[idx] = node.raw
+  }
+
+  internal mutating func buildData() -> SyntaxData {
+    if (layout[2] == nil) {
+      layout[2] = RawSyntax.missingToken(TokenKind.contextualKeyword(""))
+    }
+    if (layout[3] == nil) {
+      layout[3] = RawSyntax.missingToken(TokenKind.identifier(""))
+    }
+    if (layout[7] == nil) {
+      layout[7] = RawSyntax.missing(SyntaxKind.memberDeclBlock)
+    }
+
+    return .forRoot(RawSyntax.createAndCalcLength(kind: .actorDecl,
+      layout: layout, presence: .present))
+  }
+}
+
+extension ActorDeclSyntax {
+  /// Creates a `ActorDeclSyntax` using the provided build function.
+  /// - Parameter:
+  ///   - build: A closure that will be invoked in order to initialize
+  ///            the fields of the syntax node.
+  ///            This closure is passed a `ActorDeclSyntaxBuilder` which you can use to
+  ///            incrementally build the structure of the node.
+  /// - Returns: A `ActorDeclSyntax` with all the fields populated in the builder
+  ///            closure.
+  public init(_ build: (inout ActorDeclSyntaxBuilder) -> Void) {
+    var builder = ActorDeclSyntaxBuilder()
+    build(&builder)
+    let data = builder.buildData()
+    self.init(data)
+  }
+}
+
 public struct StructDeclSyntaxBuilder {
   private var layout =
     Array<RawSyntax?>(repeating: nil, count: 8)
@@ -4752,7 +4890,7 @@ extension FunctionDeclSyntax {
 
 public struct InitializerDeclSyntaxBuilder {
   private var layout =
-    Array<RawSyntax?>(repeating: nil, count: 9)
+    Array<RawSyntax?>(repeating: nil, count: 8)
 
   internal init() {}
 
@@ -4793,13 +4931,8 @@ public struct InitializerDeclSyntaxBuilder {
     layout[idx] = node.raw
   }
 
-  public mutating func useParameters(_ node: ParameterClauseSyntax) {
-    let idx = InitializerDeclSyntax.Cursor.parameters.rawValue
-    layout[idx] = node.raw
-  }
-
-  public mutating func useThrowsOrRethrowsKeyword(_ node: TokenSyntax) {
-    let idx = InitializerDeclSyntax.Cursor.throwsOrRethrowsKeyword.rawValue
+  public mutating func useSignature(_ node: FunctionSignatureSyntax) {
+    let idx = InitializerDeclSyntax.Cursor.signature.rawValue
     layout[idx] = node.raw
   }
 
@@ -4818,7 +4951,7 @@ public struct InitializerDeclSyntaxBuilder {
       layout[2] = RawSyntax.missingToken(TokenKind.initKeyword)
     }
     if (layout[5] == nil) {
-      layout[5] = RawSyntax.missing(SyntaxKind.parameterClause)
+      layout[5] = RawSyntax.missing(SyntaxKind.functionSignature)
     }
 
     return .forRoot(RawSyntax.createAndCalcLength(kind: .initializerDecl,
@@ -4885,9 +5018,6 @@ public struct DeinitializerDeclSyntaxBuilder {
     if (layout[2] == nil) {
       layout[2] = RawSyntax.missingToken(TokenKind.deinitKeyword)
     }
-    if (layout[3] == nil) {
-      layout[3] = RawSyntax.missing(SyntaxKind.codeBlock)
-    }
 
     return .forRoot(RawSyntax.createAndCalcLength(kind: .deinitializerDecl,
       layout: layout, presence: .present))
@@ -5004,7 +5134,7 @@ extension SubscriptDeclSyntax {
 
 public struct AccessLevelModifierSyntaxBuilder {
   private var layout =
-    Array<RawSyntax?>(repeating: nil, count: 4)
+    Array<RawSyntax?>(repeating: nil, count: 2)
 
   internal init() {}
 
@@ -5013,21 +5143,11 @@ public struct AccessLevelModifierSyntaxBuilder {
     layout[idx] = node.raw
   }
 
-  public mutating func useLeftParen(_ node: TokenSyntax) {
-    let idx = AccessLevelModifierSyntax.Cursor.leftParen.rawValue
-    layout[idx] = node.raw
-  }
-
-  public mutating func useModifier(_ node: TokenSyntax) {
+  public mutating func useModifier(_ node: DeclModifierDetailSyntax) {
     let idx = AccessLevelModifierSyntax.Cursor.modifier.rawValue
     layout[idx] = node.raw
   }
 
-  public mutating func useRightParen(_ node: TokenSyntax) {
-    let idx = AccessLevelModifierSyntax.Cursor.rightParen.rawValue
-    layout[idx] = node.raw
-  }
-
   internal mutating func buildData() -> SyntaxData {
     if (layout[0] == nil) {
       layout[0] = RawSyntax.missingToken(TokenKind.identifier(""))