Flatten TokenSpec class hierarchy in CodeGeneration

Author: ahoppen

CodeGeneration/Sources/SyntaxSupport/TokenSpec.swift

@@ -11,154 +11,113 @@
 //===----------------------------------------------------------------------===//
 
 /// Represents the specification for a Token in the TokenSyntax file.
-public class TokenSpec {
+public struct TokenSpec {
   public let name: String
   public let nameForDiagnostics: String
   public let text: String?
+  public let isPunctuation: Bool
   public let associatedValueClass: String?
 
   public var swiftKind: String {
     return lowercaseFirstWord(name: self.name)
   }
 
-  init(
+  private init(
     name: String,
     nameForDiagnostics: String,
     text: String? = nil,
+    isPunctuation: Bool,
     associatedValueClass: String? = nil
   ) {
     self.name = name
     self.nameForDiagnostics = nameForDiagnostics
     self.text = text
+    self.isPunctuation = isPunctuation
     self.associatedValueClass = associatedValueClass
   }
-}
-
-public class PoundSpec: TokenSpec {
-  init(
-    name: String,
-    nameForDiagnostics: String? = nil,
-    text: String
-  ) {
-    super.init(
-      name: name,
-      nameForDiagnostics: nameForDiagnostics ?? text,
-      text: text
-    )
-  }
-}
 
-public class PoundObjectLiteralSpec: PoundSpec {
-  let `protocol`: String
-
-  init(
-    name: String,
-    text: String,
-    nameForDiagnostics: String,
-    `protocol`: String
-  ) {
-    self.`protocol` = `protocol`
-    super.init(
+  static func punctuator(name: String, text: String) -> TokenSpec {
+    return TokenSpec(
       name: name,
-      nameForDiagnostics: nameForDiagnostics,
-      text: text
+      nameForDiagnostics: text,
+      text: text,
+      isPunctuation: true,
+      associatedValueClass: nil
     )
   }
-}
-
-public class PoundConfigSpec: PoundSpec {}
 
-public class PoundDirectiveSpec: PoundSpec {
-  init(
-    name: String,
-    text: String
-  ) {
-    super.init(
+  static func poundKeyword(name: String, text: String) -> TokenSpec {
+    return TokenSpec(
       name: name,
-      text: text
+      nameForDiagnostics: text,
+      text: text,
+      isPunctuation: false,
+      associatedValueClass: nil
     )
   }
-}
 
-public class PoundConditionalDirectiveSpec: PoundDirectiveSpec {
-  override init(
-    name: String,
-    text: String
-  ) {
-    super.init(
+  static func other(name: String, nameForDiagnostics: String, text: String? = nil, associatedValueClass: String? = nil) -> TokenSpec {
+    TokenSpec(
       name: name,
-      text: text
+      nameForDiagnostics: nameForDiagnostics,
+      text: text,
+      isPunctuation: false,
+      associatedValueClass: associatedValueClass
     )
-  }
-}
 
-public class PunctuatorSpec: TokenSpec {
-  init(
-    name: String,
-    text: String
-  ) {
-    super.init(
-      name: name,
-      nameForDiagnostics: text,
-      text: text
-    )
   }
 }
 
-public class LiteralSpec: TokenSpec {}
-
-public class MiscSpec: TokenSpec {}
-
 public let SYNTAX_TOKENS: [TokenSpec] = [
-  PunctuatorSpec(name: "Arrow", text: "->"),
-  PunctuatorSpec(name: "AtSign", text: "@"),
-  PunctuatorSpec(name: "Backslash", text: "\\"),
-  PunctuatorSpec(name: "Backtick", text: "`"),
-  MiscSpec(name: "BinaryOperator", nameForDiagnostics: "binary operator"),
-  PunctuatorSpec(name: "Colon", text: ":"),
-  PunctuatorSpec(name: "Comma", text: ","),
-  MiscSpec(name: "DollarIdentifier", nameForDiagnostics: "dollar identifier"),
-  PunctuatorSpec(name: "Ellipsis", text: "..."),
-  MiscSpec(name: "EndOfFile", nameForDiagnostics: "end of file", text: ""),
-  PunctuatorSpec(name: "Equal", text: "="),
-  PunctuatorSpec(name: "ExclamationMark", text: "!"),
-  MiscSpec(name: "ExtendedRegexDelimiter", nameForDiagnostics: "extended delimiter"),
-  LiteralSpec(name: "FloatingLiteral", nameForDiagnostics: "floating literal"),
-  MiscSpec(name: "Identifier", nameForDiagnostics: "identifier"),
-  PunctuatorSpec(name: "InfixQuestionMark", text: "?"),
-  LiteralSpec(name: "IntegerLiteral", nameForDiagnostics: "integer literal"),
-  MiscSpec(name: "Keyword", nameForDiagnostics: "keyword", associatedValueClass: "Keyword"),
-  PunctuatorSpec(name: "LeftAngle", text: "<"),
-  PunctuatorSpec(name: "LeftBrace", text: "{"),
-  PunctuatorSpec(name: "LeftParen", text: "("),
-  PunctuatorSpec(name: "LeftSquare", text: "["),
-  PunctuatorSpec(name: "MultilineStringQuote", text: "\"\"\""),
-  PunctuatorSpec(name: "Period", text: "."),
-  MiscSpec(name: "PostfixOperator", nameForDiagnostics: "postfix operator"),
-  PunctuatorSpec(name: "PostfixQuestionMark", text: "?"),
-  PunctuatorSpec(name: "Pound", text: "#"),
-  PoundConfigSpec(name: "PoundAvailable", text: "#available"),
-  PoundConditionalDirectiveSpec(name: "PoundElse", text: "#else"),
-  PoundConditionalDirectiveSpec(name: "PoundElseif", text: "#elseif"),
-  PoundConditionalDirectiveSpec(name: "PoundEndif", text: "#endif"),
-  PoundConditionalDirectiveSpec(name: "PoundIf", text: "#if"),
-  PoundDirectiveSpec(name: "PoundSourceLocation", text: "#sourceLocation"),
-  PoundConfigSpec(name: "PoundUnavailable", text: "#unavailable"),
-  PunctuatorSpec(name: "PrefixAmpersand", text: "&"),
-  MiscSpec(name: "PrefixOperator", nameForDiagnostics: "prefix operator"),
-  MiscSpec(name: "RawStringDelimiter", nameForDiagnostics: "raw string delimiter"),
-  MiscSpec(name: "RegexLiteralPattern", nameForDiagnostics: "regex pattern"),
-  PunctuatorSpec(name: "RegexSlash", text: "/"),
-  PunctuatorSpec(name: "RightAngle", text: ">"),
-  PunctuatorSpec(name: "RightBrace", text: "}"),
-  PunctuatorSpec(name: "RightParen", text: ")"),
-  PunctuatorSpec(name: "RightSquare", text: "]"),
-  PunctuatorSpec(name: "Semicolon", text: ";"),
-  PunctuatorSpec(name: "SingleQuote", text: "\'"),
-  PunctuatorSpec(name: "StringQuote", text: "\""),
-  MiscSpec(name: "StringSegment", nameForDiagnostics: "string segment"),
-  MiscSpec(name: "Unknown", nameForDiagnostics: "token"),
-  MiscSpec(name: "Wildcard", nameForDiagnostics: "wildcard", text: "_"),
+  .punctuator(name: "Arrow", text: "->"),
+  .punctuator(name: "AtSign", text: "@"),
+  .punctuator(name: "Backslash", text: "\\"),
+  .punctuator(name: "Backtick", text: "`"),
+  .other(name: "BinaryOperator", nameForDiagnostics: "binary operator"),
+  .punctuator(name: "Colon", text: ":"),
+  .punctuator(name: "Comma", text: ","),
+  .other(name: "DollarIdentifier", nameForDiagnostics: "dollar identifier"),
+  .punctuator(name: "Ellipsis", text: "..."),
+  .other(name: "EndOfFile", nameForDiagnostics: "end of file", text: ""),
+  .punctuator(name: "Equal", text: "="),
+  .punctuator(name: "ExclamationMark", text: "!"),
+  .other(name: "ExtendedRegexDelimiter", nameForDiagnostics: "extended delimiter"),
+  .other(name: "FloatingLiteral", nameForDiagnostics: "floating literal"),
+  .other(name: "Identifier", nameForDiagnostics: "identifier"),
+  .punctuator(name: "InfixQuestionMark", text: "?"),
+  .other(name: "IntegerLiteral", nameForDiagnostics: "integer literal"),
+  .other(name: "Keyword", nameForDiagnostics: "keyword", associatedValueClass: "Keyword"),
+  .punctuator(name: "LeftAngle", text: "<"),
+  .punctuator(name: "LeftBrace", text: "{"),
+  .punctuator(name: "LeftParen", text: "("),
+  .punctuator(name: "LeftSquare", text: "["),
+  .punctuator(name: "MultilineStringQuote", text: "\"\"\""),
+  .punctuator(name: "Period", text: "."),
+  .other(name: "PostfixOperator", nameForDiagnostics: "postfix operator"),
+  .punctuator(name: "PostfixQuestionMark", text: "?"),
+  .punctuator(name: "Pound", text: "#"),
+  .poundKeyword(name: "PoundAvailable", text: "#available"),
+  .poundKeyword(name: "PoundElse", text: "#else"),
+  .poundKeyword(name: "PoundElseif", text: "#elseif"),
+  .poundKeyword(name: "PoundEndif", text: "#endif"),
+  .poundKeyword(name: "PoundIf", text: "#if"),
+  .poundKeyword(name: "PoundSourceLocation", text: "#sourceLocation"),
+  .poundKeyword(name: "PoundUnavailable", text: "#unavailable"),
+  .punctuator(name: "PrefixAmpersand", text: "&"),
+  .other(name: "PrefixOperator", nameForDiagnostics: "prefix operator"),
+  .other(name: "RawStringDelimiter", nameForDiagnostics: "raw string delimiter"),
+  .other(name: "RegexLiteralPattern", nameForDiagnostics: "regex pattern"),
+  .punctuator(name: "RegexSlash", text: "/"),
+  .punctuator(name: "RightAngle", text: ">"),
+  .punctuator(name: "RightBrace", text: "}"),
+  .punctuator(name: "RightParen", text: ")"),
+  .punctuator(name: "RightSquare", text: "]"),
+  .punctuator(name: "Semicolon", text: ";"),
+  .punctuator(name: "SingleQuote", text: "\'"),
+  .punctuator(name: "StringQuote", text: "\""),
+  .other(name: "StringSegment", nameForDiagnostics: "string segment"),
+  .other(name: "Unknown", nameForDiagnostics: "token"),
+  .other(name: "Wildcard", nameForDiagnostics: "wildcard", text: "_"),
 ]
 
 public let SYNTAX_TOKEN_MAP = Dictionary(

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

@@ -99,7 +99,7 @@ let tokenKindFile = SourceFileSyntax(leadingTrivia: copyrightHeader) {
       try SwitchExprSyntax("switch self") {
         for token in SYNTAX_TOKENS {
           SwitchCaseSyntax("case .\(raw: token.swiftKind):") {
-            StmtSyntax("return \(raw: type(of: token) == PunctuatorSpec.self)")
+            StmtSyntax("return \(raw: token.isPunctuation)")
           }
         }
       }
@@ -177,7 +177,7 @@ let tokenKindFile = SourceFileSyntax(leadingTrivia: copyrightHeader) {
       try! SwitchExprSyntax("switch self") {
         for token in SYNTAX_TOKENS {
           SwitchCaseSyntax("case .\(raw: token.swiftKind):") {
-            StmtSyntax("return \(raw: type(of: token) == PunctuatorSpec.self)")
+            StmtSyntax("return \(raw: token.isPunctuation)")
           }
         }
       }