Move syntax nodes from gyb to code gen

Author: kimdv

CodeGeneration/Sources/SyntaxSupport/Child.swift

@@ -43,13 +43,22 @@ public enum ChildKind {
       return false
     }
   }
+
+  public var isNodeChoicesEmpty: Bool {
+    if case .nodeChoices(let nodeChoices) = self {
+      return nodeChoices.isEmpty
+    } else {
+      return true
+    }
+  }
 }
 
 /// A child of a node, that may be declared optional or a token with a
 /// restricted subset of acceptable kinds or texts.
 public class Child {
   public let name: String
   public let kind: ChildKind
+  public let nameForDiagnostics: String?
   public let description: String?
   public let forceClassification: Bool
   public let isIndented: Bool
@@ -117,6 +126,25 @@ public class Child {
     syntaxKind == "UnexpectedNodes"
   }
 
+  /// Returns `true` if this child's type is one of the base syntax kinds and
+  /// it has no node choices.
+  public var hasBaseType: Bool {
+    switch kind {
+    case .nodeChoices(let choices):
+      return choices.isEmpty && SYNTAX_BASE_KINDS.contains(syntaxKind)
+    case .node,
+      .collection,
+      .token:
+      return SYNTAX_BASE_KINDS.contains(syntaxKind)
+    }
+  }
+
+  /// Returns `true` if this child's type is one of the base syntax kinds and
+  /// it's optional.
+  public var hasOptionalBaseType: Bool {
+    return hasBaseType && isOptional
+  }
+
   /// If a classification is passed, it specifies the color identifiers in
   /// that subtree should inherit for syntax coloring. Must be a member of
   /// SyntaxClassification in SyntaxClassifier.h.gyb
@@ -125,6 +153,7 @@ public class Child {
   init(
     name: String,
     kind: ChildKind,
+    nameForDiagnostics: String? = nil,
     description: String? = nil,
     isOptional: Bool = false,
     classification: String? = nil,
@@ -134,6 +163,7 @@ public class Child {
   ) {
     self.name = name
     self.kind = kind
+    self.nameForDiagnostics = nameForDiagnostics
     self.description = description
     self.classification = classificationByName(classification)
     self.forceClassification = forceClassification

CodeGeneration/Sources/SyntaxSupport/Node.swift

@@ -33,32 +33,32 @@ public class Node {
   public let elementsSeparatedByNewline: Bool
   public let collectionElement: String
 
-  /// Returns `True` if this node declares one of the base syntax kinds.
+  /// Returns `true` if this node declares one of the base syntax kinds.
   public var isBase: Bool {
     return SYNTAX_BASE_KINDS.contains(syntaxKind)
   }
 
-  /// Returns `True` if this node is a subclass of SyntaxCollection.
+  /// Returns `true` if this node is a subclass of SyntaxCollection.
   public var isSyntaxCollection: Bool {
     return baseKind == "SyntaxCollection"
   }
 
-  /// Returns `True` if this node should have a `validate` method associated.
+  /// Returns `true` if this node should have a `validate` method associated.
   public var requiresValidation: Bool {
     return isBuildable
   }
 
-  /// Returns `True` if this node is an `Unknown` syntax subclass.
+  /// Returns `true` if this node is an `Unknown` syntax subclass.
   public var isUnknown: Bool {
     return syntaxKind.contains("Unknown")
   }
 
-  /// Returns `True` if this node is an `Unknown` syntax subclass.
+  /// Returns `true` if this node is an `Unknown` syntax subclass.
   public var isMissing: Bool {
     return syntaxKind.contains("Missing")
   }
 
-  /// Returns `True` if this node should have a builder associated.
+  /// Returns `true` if this node should have a builder associated.
   public var isBuildable: Bool {
     return !isBase && !isUnknown && !isMissing && !isSyntaxCollection
   }
@@ -77,6 +77,16 @@ public class Node {
     return !isBase
   }
 
+  public var hasOptionalBaseTypeChild: Bool {
+    return children.contains { child in
+      if child.hasOptionalBaseType {
+        return true
+      } else {
+        return false
+      }
+    }
+  }
+
   init(
     name: String,
     nameForDiagnostics: String?,
@@ -102,7 +112,7 @@ public class Node {
 
     if kind == "SyntaxCollection" {
       self.children = children
-    } else {
+    } else if children.count > 0 {
       // Add implicitly generated UnexpectedNodes children between
       // any two defined children
       self.children =
@@ -130,6 +140,10 @@ public class Node {
               isOptional: true
             )
           ] : [])
+    } else {
+      self.children = [
+        Child(name: "Unexpected", kind: .collection(kind: "UnexpectedNodes", collectionElementName: "Unexpected"), isOptional: true)
+      ]
     }
 
     self.nonUnexpectedChildren = children.filter { !$0.isUnexpectedNodes }

CodeGeneration/Sources/SyntaxSupport/gyb_generated/AttributeNodes.swift

@@ -24,6 +24,7 @@ public let ATTRIBUTE_NODES: [Node] = [
                description: "The `@` sign."),
          Child(name: "AttributeName",
                kind: .node(kind: "Type"),
+               nameForDiagnostics: "name",
                description: "The name of the attribute.",
                classification: "Attribute"),
          Child(name: "LeftParen",
@@ -104,6 +105,7 @@ public let ATTRIBUTE_NODES: [Node] = [
        children: [
          Child(name: "Label",
                kind: .token(choices: [.keyword(text: "availability")]),
+               nameForDiagnostics: "label",
                description: "The label of the argument"),
          Child(name: "Colon",
                kind: .token(choices: [.token(tokenKind: "ColonToken")]),
@@ -124,12 +126,14 @@ public let ATTRIBUTE_NODES: [Node] = [
        children: [
          Child(name: "Label",
                kind: .token(choices: [.token(tokenKind: "IdentifierToken"), .keyword(text: "available"), .keyword(text: "exported"), .keyword(text: "kind"), .keyword(text: "spi"), .keyword(text: "spiModule")]),
+               nameForDiagnostics: "label",
                description: "The label of the argument"),
          Child(name: "Colon",
                kind: .token(choices: [.token(tokenKind: "ColonToken")]),
                description: "The colon separating the label and the value"),
          Child(name: "Value",
                kind: .node(kind: "Token"),
+               nameForDiagnostics: "value",
                description: "The value for this argument"),
          Child(name: "TrailingComma",
                kind: .token(choices: [.token(tokenKind: "CommaToken")]),
@@ -147,12 +151,14 @@ public let ATTRIBUTE_NODES: [Node] = [
        children: [
          Child(name: "Label",
                kind: .token(choices: [.keyword(text: "target")]),
+               nameForDiagnostics: "label",
                description: "The label of the argument"),
          Child(name: "Colon",
                kind: .token(choices: [.token(tokenKind: "ColonToken")]),
                description: "The colon separating the label and the value"),
          Child(name: "Declname",
                kind: .node(kind: "DeclName"),
+               nameForDiagnostics: "declaration name",
                description: "The value for this argument"),
          Child(name: "TrailingComma",
                kind: .token(choices: [.token(tokenKind: "CommaToken")]),
@@ -166,9 +172,11 @@ public let ATTRIBUTE_NODES: [Node] = [
        children: [
          Child(name: "DeclBaseName",
                kind: .token(choices: [.token(tokenKind: "IdentifierToken"), .token(tokenKind: "PrefixOperatorToken"), .keyword(text: "init")]),
+               nameForDiagnostics: "base name",
                description: "The base name of the protocol's requirement."),
          Child(name: "DeclNameArguments",
                kind: .node(kind: "DeclNameArguments"),
+               nameForDiagnostics: "arguments",
                description: "The argument labels of the protocol's requirement if it is a function requirement.",
                isOptional: true)
        ]),
@@ -180,15 +188,18 @@ public let ATTRIBUTE_NODES: [Node] = [
        children: [
          Child(name: "Type",
                kind: .node(kind: "Type"),
+               nameForDiagnostics: "type",
                description: "The type for which the method with this attribute implements a requirement."),
          Child(name: "Comma",
                kind: .token(choices: [.token(tokenKind: "CommaToken")]),
                description: "The comma separating the type and method name"),
          Child(name: "DeclBaseName",
                kind: .node(kind: "Token"),
+               nameForDiagnostics: "declaration base name",
                description: "The base name of the protocol's requirement."),
          Child(name: "DeclNameArguments",
                kind: .node(kind: "DeclNameArguments"),
+               nameForDiagnostics: "declaration name arguments",
                description: "The argument labels of the protocol's requirement if it is a function requirement.",
                isOptional: true)
        ]),
@@ -200,6 +211,7 @@ public let ATTRIBUTE_NODES: [Node] = [
        children: [
          Child(name: "Name",
                kind: .token(choices: [.token(tokenKind: "IdentifierToken")]),
+               nameForDiagnostics: "name",
                isOptional: true),
          Child(name: "Colon",
                kind: .token(choices: [.token(tokenKind: "ColonToken")]),
@@ -252,7 +264,8 @@ public let ATTRIBUTE_NODES: [Node] = [
                        kind: .node(kind: "DifferentiabilityParam")),
                  Child(name: "ParameterList",
                        kind: .node(kind: "DifferentiabilityParams"))
-               ]))
+               ]),
+               nameForDiagnostics: "parameters")
        ]),
 
   Node(name: "DifferentiabilityParams",
@@ -326,16 +339,19 @@ public let ATTRIBUTE_NODES: [Node] = [
        children: [
          Child(name: "BaseType",
                kind: .node(kind: "Type"),
+               nameForDiagnostics: "base type",
                description: "The base type of the qualified name, optionally specified.",
                isOptional: true),
          Child(name: "Dot",
                kind: .token(choices: [.token(tokenKind: "PeriodToken")]),
                isOptional: true),
          Child(name: "Name",
                kind: .token(choices: [.token(tokenKind: "IdentifierToken"), .token(tokenKind: "BinaryOperatorToken"), .token(tokenKind: "PrefixOperatorToken"), .token(tokenKind: "PostfixOperatorToken")]),
+               nameForDiagnostics: "base name",
                description: "The base name of the referenced function."),
          Child(name: "Arguments",
                kind: .node(kind: "DeclNameArguments"),
+               nameForDiagnostics: "arguments",
                description: "The argument labels of the referenced function, optionally specified.",
                isOptional: true)
        ]),
@@ -510,7 +526,8 @@ public let ATTRIBUTE_NODES: [Node] = [
        ],
        children: [
          Child(name: "Label",
-               kind: .token(choices: [.keyword(text: "visibility"), .keyword(text: "metadata")])),
+               kind: .token(choices: [.keyword(text: "visibility"), .keyword(text: "metadata")]),
+               nameForDiagnostics: "label"),
          Child(name: "Colon",
                kind: .token(choices: [.token(tokenKind: "ColonToken")])),
          Child(name: "Value",

CodeGeneration/Sources/SyntaxSupport/gyb_generated/AvailabilityNodes.swift

@@ -46,6 +46,7 @@ public let AVAILABILITY_NODES: [Node] = [
        children: [
          Child(name: "Label",
                kind: .token(choices: [.keyword(text: "message"), .keyword(text: "renamed"), .keyword(text: "introduced"), .keyword(text: "obsoleted"), .keyword(text: "deprecated")]),
+               nameForDiagnostics: "label",
                description: "The label of the argument"),
          Child(name: "Colon",
                kind: .token(choices: [.token(tokenKind: "ColonToken")]),
@@ -57,6 +58,7 @@ public let AVAILABILITY_NODES: [Node] = [
                  Child(name: "Version",
                        kind: .node(kind: "VersionTuple"))
                ]),
+               nameForDiagnostics: "value",
                description: "The value of this labeled argument")
        ]),
 
@@ -67,10 +69,12 @@ public let AVAILABILITY_NODES: [Node] = [
        children: [
          Child(name: "Platform",
                kind: .token(choices: [.token(tokenKind: "IdentifierToken")]),
+               nameForDiagnostics: "platform",
                description: "The name of the OS on which the availability should be restricted or 'swift' if the availability should be restricted based on a Swift version.",
                classification: "Keyword"),
          Child(name: "Version",
                kind: .node(kind: "VersionTuple"),
+               nameForDiagnostics: "version",
                isOptional: true)
        ]),
 

CodeGeneration/Sources/SyntaxSupport/gyb_generated/CommonNodes.swift

@@ -113,6 +113,7 @@ public let COMMON_NODES: [Node] = [
                kind: .token(choices: [.token(tokenKind: "LeftBraceToken")])),
          Child(name: "Statements",
                kind: .collection(kind: "CodeBlockItemList", collectionElementName: "Statement"),
+               nameForDiagnostics: "statements",
                isIndented: true),
          Child(name: "RightBrace",
                kind: .token(choices: [.token(tokenKind: "RightBraceToken")]),