Move nameForDiagnostics from RawTokenKind to TokenKind

Author: ahoppen

CodeGeneration/Sources/generate-swiftsyntax/templates/swiftsyntax/TokenKindFile.swift

@@ -96,6 +96,23 @@ let tokenKindFile = SourceFileSyntax {
       }
     }
 
+    try! VariableDeclSyntax("public var nameForDiagnostics: String") {
+      try! SwitchExprSyntax("switch self") {
+        SwitchCaseSyntax("case .eof:") {
+          StmtSyntax(#"return "end of file""#)
+        }
+
+        for token in SYNTAX_TOKENS where token.swiftKind != "keyword" {
+          SwitchCaseSyntax("case .\(raw: token.swiftKind):") {
+            StmtSyntax("return #\"\(raw: token.nameForDiagnostics)\"#")
+          }
+        }
+        SwitchCaseSyntax("case .keyword(let keyword):") {
+          StmtSyntax("return String(syntaxText: keyword.defaultText)")
+        }
+      }
+    }
+
     try VariableDeclSyntax(
       """
       /// Returns `true` if the token is a Swift keyword.
@@ -287,23 +304,6 @@ let tokenKindFile = SourceFileSyntax {
       }
     }
 
-    try! VariableDeclSyntax("public var nameForDiagnostics: String") {
-      try! SwitchExprSyntax("switch self.base") {
-        SwitchCaseSyntax("case .eof:") {
-          StmtSyntax(#"return "end of file""#)
-        }
-
-        for token in SYNTAX_TOKENS where token.swiftKind != "keyword" {
-          SwitchCaseSyntax("case .\(raw: token.swiftKind):") {
-            StmtSyntax("return #\"\(raw: token.nameForDiagnostics)\"#")
-          }
-        }
-        SwitchCaseSyntax("case .keyword:") {
-          StmtSyntax("return String(syntaxText: self.keyword.defaultText)")
-        }
-      }
-    }
-
     try! VariableDeclSyntax(
       """
       /// Returns `true` if the token is a Swift keyword.

Sources/SwiftParserDiagnostics/MissingNodesError.swift

@@ -42,7 +42,7 @@ fileprivate enum NodesDescriptionPart {
       if let childName = token.childNameInParent {
         return childName
       }
-      return token.tokenKind.decomposeToRaw().rawKind.nameForDiagnostics
+      return token.tokenKind.nameForDiagnostics
     case .node(let node):
       var walk: Syntax = node
       while true {

Sources/SwiftParserDiagnostics/ParseDiagnosticsGenerator.swift

@@ -251,7 +251,7 @@ public class ParseDiagnosticsGenerator: SyntaxAnyVisitor {
         unexpectedTokenCondition: { AsyncEffectSpecifier(token: $0) != nil },
         correctTokens: [node.asyncSpecifier],
         message: { AsyncMustPrecedeThrows(asyncKeywords: $0, throwsKeyword: throwsSpecifier) },
-        moveFixIt: { MoveTokensInFrontOfFixIt(movedTokens: $0, inFrontOf: throwsSpecifier.rawTokenKind) },
+        moveFixIt: { MoveTokensInFrontOfFixIt(movedTokens: $0, inFrontOf: throwsSpecifier.tokenKind) },
         removeRedundantFixIt: { RemoveRedundantFixIt(removeTokens: $0) }
       )
     }

Sources/SwiftParserDiagnostics/ParserDiagnosticMessages.swift

@@ -490,7 +490,7 @@ public struct MoveTokensAfterFixIt: ParserFixIt {
   public let movedTokens: [TokenSyntax]
 
   /// The token after which `movedTokens` should be moved
-  public let after: RawTokenKind
+  public let after: TokenKind
 
   public var message: String {
     "move \(nodesDescription(movedTokens, format: false)) after '\(after.nameForDiagnostics)'"
@@ -502,7 +502,7 @@ public struct MoveTokensInFrontOfFixIt: ParserFixIt {
   public let movedTokens: [TokenSyntax]
 
   /// The token after which 'try' should be moved
-  public let inFrontOf: RawTokenKind
+  public let inFrontOf: TokenKind
 
   public var message: String {
     "move \(nodesDescription(movedTokens, format: false)) in front of '\(inFrontOf.nameForDiagnostics)'"

Sources/SwiftParserDiagnostics/PresenceUtils.swift

@@ -52,7 +52,7 @@ class PresentMaker: SyntaxRewriter {
       if let text = text, (!text.isEmpty || rawKind == .stringSegment) {  // string segments can have empty text
         presentToken = TokenSyntax(token.tokenKind, presence: .present)
       } else {
-        let newKind = TokenKind.fromRaw(kind: rawKind, text: rawKind.defaultText.map(String.init) ?? "<#\(rawKind.nameForDiagnostics)#>")
+        let newKind = TokenKind.fromRaw(kind: rawKind, text: rawKind.defaultText.map(String.init) ?? "<#\(token.tokenKind.nameForDiagnostics)#>")
         presentToken = TokenSyntax(newKind, leadingTrivia: token.leadingTrivia, trailingTrivia: token.trailingTrivia, presence: .present)
       }
       return BasicFormat().visit(presentToken)

Sources/SwiftSyntax/generated/TokenKind.swift

@@ -279,6 +279,105 @@ public enum TokenKind: Hashable {
     }
   }
 
+  public var nameForDiagnostics: String {
+    switch self {
+    case .eof: 
+      return "end of file"
+    case .wildcard: 
+      return #"wildcard"#
+    case .leftParen: 
+      return #"("#
+    case .rightParen: 
+      return #")"#
+    case .leftBrace: 
+      return #"{"#
+    case .rightBrace: 
+      return #"}"#
+    case .leftSquareBracket: 
+      return #"["#
+    case .rightSquareBracket: 
+      return #"]"#
+    case .leftAngle: 
+      return #"<"#
+    case .rightAngle: 
+      return #">"#
+    case .period: 
+      return #"."#
+    case .comma: 
+      return #","#
+    case .ellipsis: 
+      return #"..."#
+    case .colon: 
+      return #":"#
+    case .semicolon: 
+      return #";"#
+    case .equal: 
+      return #"="#
+    case .atSign: 
+      return #"@"#
+    case .pound: 
+      return #"#"#
+    case .prefixAmpersand: 
+      return #"&"#
+    case .arrow: 
+      return #"->"#
+    case .backtick: 
+      return #"`"#
+    case .backslash: 
+      return #"\"#
+    case .exclamationMark: 
+      return #"!"#
+    case .postfixQuestionMark: 
+      return #"?"#
+    case .infixQuestionMark: 
+      return #"?"#
+    case .stringQuote: 
+      return #"""#
+    case .singleQuote: 
+      return #"'"#
+    case .multilineStringQuote: 
+      return #"""""#
+    case .poundSourceLocationKeyword: 
+      return #"#sourceLocation"#
+    case .poundIfKeyword: 
+      return #"#if"#
+    case .poundElseKeyword: 
+      return #"#else"#
+    case .poundElseifKeyword: 
+      return #"#elseif"#
+    case .poundEndifKeyword: 
+      return #"#endif"#
+    case .poundAvailableKeyword: 
+      return #"#available"#
+    case .poundUnavailableKeyword: 
+      return #"#unavailable"#
+    case .integerLiteral: 
+      return #"integer literal"#
+    case .floatingLiteral: 
+      return #"floating literal"#
+    case .regexLiteral: 
+      return #"regex literal"#
+    case .unknown: 
+      return #"token"#
+    case .identifier: 
+      return #"identifier"#
+    case .binaryOperator: 
+      return #"binary operator"#
+    case .postfixOperator: 
+      return #"postfix operator"#
+    case .prefixOperator: 
+      return #"prefix operator"#
+    case .dollarIdentifier: 
+      return #"dollar identifier"#
+    case .rawStringDelimiter: 
+      return #"raw string delimiter"#
+    case .stringSegment: 
+      return #"string segment"#
+    case .keyword(let keyword): 
+      return String(syntaxText: keyword.defaultText)
+    }
+  }
+  
   /// Returns `true` if the token is a Swift keyword.
   ///
   /// Keywords are reserved unconditionally for use by Swift and may not
@@ -996,105 +1095,6 @@ public struct RawTokenKind: Equatable, Hashable {
     }
   }
 
-  public var nameForDiagnostics: String {
-    switch self.base {
-    case .eof: 
-      return "end of file"
-    case .wildcard: 
-      return #"wildcard"#
-    case .leftParen: 
-      return #"("#
-    case .rightParen: 
-      return #")"#
-    case .leftBrace: 
-      return #"{"#
-    case .rightBrace: 
-      return #"}"#
-    case .leftSquareBracket: 
-      return #"["#
-    case .rightSquareBracket: 
-      return #"]"#
-    case .leftAngle: 
-      return #"<"#
-    case .rightAngle: 
-      return #">"#
-    case .period: 
-      return #"."#
-    case .comma: 
-      return #","#
-    case .ellipsis: 
-      return #"..."#
-    case .colon: 
-      return #":"#
-    case .semicolon: 
-      return #";"#
-    case .equal: 
-      return #"="#
-    case .atSign: 
-      return #"@"#
-    case .pound: 
-      return #"#"#
-    case .prefixAmpersand: 
-      return #"&"#
-    case .arrow: 
-      return #"->"#
-    case .backtick: 
-      return #"`"#
-    case .backslash: 
-      return #"\"#
-    case .exclamationMark: 
-      return #"!"#
-    case .postfixQuestionMark: 
-      return #"?"#
-    case .infixQuestionMark: 
-      return #"?"#
-    case .stringQuote: 
-      return #"""#
-    case .singleQuote: 
-      return #"'"#
-    case .multilineStringQuote: 
-      return #"""""#
-    case .poundSourceLocationKeyword: 
-      return #"#sourceLocation"#
-    case .poundIfKeyword: 
-      return #"#if"#
-    case .poundElseKeyword: 
-      return #"#else"#
-    case .poundElseifKeyword: 
-      return #"#elseif"#
-    case .poundEndifKeyword: 
-      return #"#endif"#
-    case .poundAvailableKeyword: 
-      return #"#available"#
-    case .poundUnavailableKeyword: 
-      return #"#unavailable"#
-    case .integerLiteral: 
-      return #"integer literal"#
-    case .floatingLiteral: 
-      return #"floating literal"#
-    case .regexLiteral: 
-      return #"regex literal"#
-    case .unknown: 
-      return #"token"#
-    case .identifier: 
-      return #"identifier"#
-    case .binaryOperator: 
-      return #"binary operator"#
-    case .postfixOperator: 
-      return #"postfix operator"#
-    case .prefixOperator: 
-      return #"prefix operator"#
-    case .dollarIdentifier: 
-      return #"dollar identifier"#
-    case .rawStringDelimiter: 
-      return #"raw string delimiter"#
-    case .stringSegment: 
-      return #"string segment"#
-    case .keyword: 
-      return String(syntaxText: self.keyword.defaultText)
-    }
-  }
-  
   /// Returns `true` if the token is a Swift keyword.
   ///
   /// Keywords are reserved unconditionally for use by Swift and may not