Merge pull request #1817 from kimdv/kimdv/1756-generate-deprecated-children

Generate deprecated children

Author: kimdv

CodeGeneration/Sources/SyntaxSupport/AttributeNodes.swift

@@ -169,7 +169,8 @@ public let ATTRIBUTE_NODES: [Node] = [
       ),
       Child(
         name: "AvailabilityArguments",
-        kind: .collection(kind: .availabilitySpecList, collectionElementName: "AvailabilityArgument")
+        deprecatedName: "AvailabilityList",
+        kind: .collection(kind: .availabilitySpecList, collectionElementName: "AvailabilityArgument", deprecatedCollectionElementName: "Availability")
       ),
       Child(
         name: "Semicolon",
@@ -229,7 +230,8 @@ public let ATTRIBUTE_NODES: [Node] = [
       ),
       Child(
         name: "Platforms",
-        kind: .collection(kind: .availabilityVersionRestrictionList, collectionElementName: "Platform"),
+        deprecatedName: "VersionList",
+        kind: .collection(kind: .availabilityVersionRestrictionList, collectionElementName: "Platform", deprecatedCollectionElementName: "Availability"),
         documentation: "The list of OS versions in which the declaration became ABI stable."
       ),
     ]

CodeGeneration/Sources/SyntaxSupport/Child.swift

@@ -30,7 +30,7 @@ public enum ChildKind {
   /// The child always contains a node that matches one of the `choices`.
   case nodeChoices(choices: [Child])
   /// The child is a collection of `kind`.
-  case collection(kind: SyntaxNodeKind, collectionElementName: String)
+  case collection(kind: SyntaxNodeKind, collectionElementName: String, deprecatedCollectionElementName: String? = nil)
   /// The child is a token that matches one of the given `choices`.
   /// If `requiresLeadingSpace` or `requiresTrailingSpace` is not `nil`, it
   /// overrides the default leading/trailing space behavior of the token.
@@ -57,6 +57,7 @@ public enum ChildKind {
 /// restricted subset of acceptable kinds or texts.
 public class Child {
   public let name: String
+  public let deprecatedName: String?
   public let kind: ChildKind
   public let nameForDiagnostics: String?
   public let documentation: String?
@@ -71,7 +72,7 @@ public class Child {
       return kind
     case .nodeChoices:
       return .syntax
-    case .collection(kind: let kind, collectionElementName: _):
+    case .collection(kind: let kind, _, _):
       return kind
     case .token:
       return .token
@@ -83,6 +84,14 @@ public class Child {
     return lowercaseFirstWord(name: name)
   }
 
+  /// The deprecated name of this child that's suitable to be used for variable or enum case names.
+  public var deprecatedVarName: String? {
+    guard let deprecatedName = deprecatedName else {
+      return nil
+    }
+    return lowercaseFirstWord(name: deprecatedName)
+  }
+
   /// If the child ends with "token" in the kind, it's considered a token node.
   /// Grab the existing reference to that token from the global list.
   public var tokenKind: String? {
@@ -118,7 +127,7 @@ public class Child {
   /// Whether this child has syntax kind `UnexpectedNodes`.
   public var isUnexpectedNodes: Bool {
     switch kind {
-    case .collection(kind: .unexpectedNodes, collectionElementName: _):
+    case .collection(kind: .unexpectedNodes, _, _):
       return true
     default:
       return false
@@ -133,7 +142,7 @@ public class Child {
       return choices.isEmpty
     case .node(let kind):
       return kind.isBase
-    case .collection(kind: let kind, collectionElementName: _):
+    case .collection(let kind, _, _):
       return kind.isBase
     case .token:
       return false
@@ -153,6 +162,7 @@ public class Child {
   /// identifiers) inherit the syntax classification.
   init(
     name: String,
+    deprecatedName: String? = nil,
     kind: ChildKind,
     nameForDiagnostics: String? = nil,
     documentation: String? = nil,
@@ -165,6 +175,7 @@ public class Child {
       precondition(firstCharInName.isUppercase == true, "The first letter of a child’s name should be uppercase")
     }
     self.name = name
+    self.deprecatedName = deprecatedName
     self.kind = kind
     self.nameForDiagnostics = nameForDiagnostics
     self.documentation = documentation

CodeGeneration/Sources/SyntaxSupport/DeclNodes.swift

@@ -649,6 +649,7 @@ public let DECL_NODES: [Node] = [
       ),
       Child(
         name: "Placeholder",
+        deprecatedName: "Identifier",
         kind: .token(choices: [.token(tokenKind: "IdentifierToken")]),
         documentation: """
           The actual editor placeholder that starts with `<#` and ends with `#>`.
@@ -863,6 +864,7 @@ public let DECL_NODES: [Node] = [
       ),
       Child(
         name: "GenericParameterClause",
+        deprecatedName: "GenericParameters",
         kind: .node(kind: .genericParameterClause),
         nameForDiagnostics: "generic parameter clause",
         documentation: "The generic parameters, if any, for this enum declaration.",
@@ -1205,6 +1207,7 @@ public let DECL_NODES: [Node] = [
       ),
       Child(
         name: "ImportKeyword",
+        deprecatedName: "ImportTok",
         kind: .token(choices: [.keyword(text: "import")]),
         documentation: "The `import` keyword for this declaration."
       ),
@@ -1909,6 +1912,7 @@ public let DECL_NODES: [Node] = [
     children: [
       Child(
         name: "HigherThanOrLowerThanKeyword",
+        deprecatedName: "HigherThanOrLowerThan",
         kind: .token(choices: [.keyword(text: "higherThan"), .keyword(text: "lowerThan")]),
         documentation: "The relation to specified other precedence groups.",
         classification: "Keyword"

CodeGeneration/Sources/SyntaxSupport/ExprNodes.swift

@@ -48,6 +48,7 @@ public let EXPR_NODES: [Node] = [
     children: [
       Child(
         name: "LeftSquare",
+        deprecatedName: "LeftSquareBracket",
         kind: .token(choices: [.token(tokenKind: "LeftSquareToken")])
       ),
       Child(
@@ -57,6 +58,7 @@ public let EXPR_NODES: [Node] = [
       ),
       Child(
         name: "RightSquare",
+        deprecatedName: "RightSquareBracket",
         kind: .token(choices: [.token(tokenKind: "RightSquareToken")])
       ),
     ]
@@ -1777,6 +1779,7 @@ public let EXPR_NODES: [Node] = [
       ),
       Child(
         name: "Elements",
+        deprecatedName: "ElementList",
         kind: .collection(kind: .tupleExprElementList, collectionElementName: "Element"),
         isIndented: true
       ),

CodeGeneration/Sources/SyntaxSupport/GenericNodes.swift

@@ -45,7 +45,8 @@ public let GENERIC_NODES: [Node] = [
       ),
       Child(
         name: "Parameters",
-        kind: .collection(kind: .genericParameterList, collectionElementName: "Parameter")
+        deprecatedName: "GenericParameterList",
+        kind: .collection(kind: .genericParameterList, collectionElementName: "Parameter", deprecatedCollectionElementName: "GenericParameter")
       ),
       Child(
         name: "GenericWhereClause",

CodeGeneration/Sources/SyntaxSupport/Node.swift

@@ -115,20 +115,32 @@ public class Node {
       childrenWithUnexpected =
         children.enumerated().flatMap { (i, child) -> [Child] in
           let unexpectedName: String
+          let unexpectedDeprecatedName: String?
+
           if i == 0 {
             unexpectedName = "UnexpectedBefore\(child.name)"
+            unexpectedDeprecatedName = child.deprecatedName.map { "UnexpectedBefore\($0)" }
           } else {
             unexpectedName = "UnexpectedBetween\(children[i - 1].name)And\(child.name)"
+            if let deprecatedName = children[i - 1].deprecatedName {
+              unexpectedDeprecatedName = "UnexpectedBetween\(deprecatedName)And\(child.deprecatedName ?? child.name)"
+            } else if let deprecatedName = child.deprecatedName {
+              unexpectedDeprecatedName = "UnexpectedBetween\(children[i - 1].name)And\(deprecatedName)"
+            } else {
+              unexpectedDeprecatedName = nil
+            }
           }
           let unexpectedBefore = Child(
             name: unexpectedName,
+            deprecatedName: unexpectedDeprecatedName,
             kind: .collection(kind: .unexpectedNodes, collectionElementName: unexpectedName),
             isOptional: true
           )
           return [unexpectedBefore, child]
         } + [
           Child(
             name: "UnexpectedAfter\(children.last!.name)",
+            deprecatedName: children.last!.deprecatedName.map { "UnexpectedAfter\($0)" },
             kind: .collection(kind: .unexpectedNodes, collectionElementName: "UnexpectedAfter\(children.last!.name)"),
             isOptional: true
           )

CodeGeneration/Sources/SyntaxSupport/StmtNodes.swift

@@ -27,6 +27,7 @@ public let STMT_NODES: [Node] = [
       ),
       Child(
         name: "AvailabilityArguments",
+        deprecatedName: "AvailabilitySpec",
         kind: .collection(kind: .availabilitySpecList, collectionElementName: "AvailabilityArgument")
       ),
       Child(

CodeGeneration/Sources/SyntaxSupport/TypeNodes.swift

@@ -19,6 +19,7 @@ public let TYPE_NODES: [Node] = [
     children: [
       Child(
         name: "LeftSquare",
+        deprecatedName: "LeftSquareBracket",
         kind: .token(choices: [.token(tokenKind: "LeftSquareToken")])
       ),
       Child(
@@ -27,6 +28,7 @@ public let TYPE_NODES: [Node] = [
       ),
       Child(
         name: "RightSquare",
+        deprecatedName: "RightSquareBracket",
         kind: .token(choices: [.token(tokenKind: "RightSquareToken")])
       ),
     ]
@@ -144,6 +146,7 @@ public let TYPE_NODES: [Node] = [
     children: [
       Child(
         name: "LeftSquare",
+        deprecatedName: "LeftSquareBracket",
         kind: .token(choices: [.token(tokenKind: "LeftSquareToken")])
       ),
       Child(
@@ -162,6 +165,7 @@ public let TYPE_NODES: [Node] = [
       ),
       Child(
         name: "RightSquare",
+        deprecatedName: "RightSquareBracket",
         kind: .token(choices: [.token(tokenKind: "RightSquareToken")])
       ),
     ]
@@ -184,7 +188,8 @@ public let TYPE_NODES: [Node] = [
       ),
       Child(
         name: "Parameters",
-        kind: .collection(kind: .tupleTypeElementList, collectionElementName: "Parameter"),
+        deprecatedName: "arguments",
+        kind: .collection(kind: .tupleTypeElementList, collectionElementName: "Parameter", deprecatedCollectionElementName: "Argument"),
         isIndented: true
       ),
       Child(
@@ -331,6 +336,7 @@ public let TYPE_NODES: [Node] = [
     children: [
       Child(
         name: "GenericParameterClause",
+        deprecatedName: "GenericParameters",
         kind: .node(kind: .genericParameterClause)
       ),
       Child(

CodeGeneration/Sources/Utils/SyntaxBuildableChild.swift

@@ -33,7 +33,7 @@ public extension Child {
       buildableKind = .node(kind: kind)
     case .nodeChoices:
       buildableKind = .node(kind: .syntax)
-    case .collection(kind: let kind, collectionElementName: _):
+    case .collection(let kind, _, _):
       buildableKind = .node(kind: kind)
     case .token:
       buildableKind = .token(tokenKind: self.tokenKind!)

CodeGeneration/Sources/generate-swiftsyntax/GenerateSwiftSyntax.swift

@@ -102,6 +102,7 @@ struct GenerateSwiftSyntax: ParsableCommand {
         GeneratedFileSpec(swiftSyntaxGeneratedDir + ["Keyword.swift"], keywordFile),
         GeneratedFileSpec(swiftSyntaxGeneratedDir + ["raw", "RawSyntaxNodes.swift"], rawSyntaxNodesFile),
         GeneratedFileSpec(swiftSyntaxGeneratedDir + ["raw", "RawSyntaxValidation.swift"], rawSyntaxValidationFile),
+        GeneratedFileSpec(swiftSyntaxGeneratedDir + ["RenamedChildrenCompatibility.swift"], renamedChildrenCompatibilityFile),
         GeneratedFileSpec(swiftSyntaxGeneratedDir + ["SyntaxAnyVisitor.swift"], syntaxAnyVisitorFile),
         GeneratedFileSpec(swiftSyntaxGeneratedDir + ["SyntaxBaseNodes.swift"], syntaxBaseNodesFile),
         GeneratedFileSpec(swiftSyntaxGeneratedDir + ["SyntaxCollections.swift"], syntaxCollectionsFile),
@@ -123,6 +124,7 @@ struct GenerateSwiftSyntax: ParsableCommand {
           swiftSyntaxBuilderGeneratedDir + ["SyntaxExpressibleByStringInterpolationConformances.swift"],
           syntaxExpressibleByStringInterpolationConformancesFile
         ),
+        GeneratedFileSpec(swiftSyntaxBuilderGeneratedDir + ["RenamedChildrenBuilderCompatibility.swift"], renamedChildrenBuilderCompatibilityFile),
       ]
       + BASE_KIND_FILES.map { baseKind in
         GeneratedFileSpec(swiftSyntaxGeneratedDir + ["syntaxNodes", baseKind.value], syntaxNode(emitKind: baseKind.key))