Merge pull request #1576 from ahoppen/ahoppen/5.9/update-basic-format

[5.9] Update BasicFormat

Author: ahoppen

CodeGeneration/Package.swift

@@ -11,8 +11,8 @@ let package = Package(
     .executable(name: "generate-swiftsyntax", targets: ["generate-swiftsyntax"])
   ],
   dependencies: [
-    .package(url: "https://github.com/apple/swift-syntax.git", revision: "39b3336c3f3bfcd4ddbcbf6a111d8814ffe542f3"),
-    .package(url: "https://github.com/apple/swift-argument-parser.git", .upToNextMinor(from: "1.2.2")),
+    .package(url: "https://github.com/apple/swift-syntax.git", revision: "c7087adb193b26f02b59d21cd06d17ec202d1bf5"),
+    .package(url: "https://github.com/apple/swift-argument-parser.git", from: "1.2.2"),
   ],
   targets: [
     .executableTarget(

CodeGeneration/Sources/SyntaxSupport/CommonNodes.swift

@@ -144,6 +144,7 @@ public let COMMON_NODES: [Node] = [
   Node(
     name: "MissingDecl",
     nameForDiagnostics: "declaration",
+    description: "In case the source code is missing a declaration, this node stands in place of the missing declaration.",
     kind: "Decl",
     traits: [
       "Attributed"
@@ -152,44 +153,108 @@ public let COMMON_NODES: [Node] = [
       Child(
         name: "Attributes",
         kind: .collection(kind: "AttributeList", collectionElementName: "Attribute"),
+        description: "If there were standalone attributes without a declaration to attach them to, the `MissingDeclSyntax` will contain these.",
         isOptional: true
       ),
       Child(
         name: "Modifiers",
         kind: .collection(kind: "ModifierList", collectionElementName: "Modifier"),
+        description: "If there were standalone modifiers without a declaration to attach them to, the `MissingDeclSyntax` will contain these.",
         isOptional: true
       ),
+      Child(
+        name: "Placeholder",
+        kind: .token(choices: [.token(tokenKind: "IdentifierToken")], requiresLeadingSpace: false, requiresTrailingSpace: false),
+        description: """
+          A placeholder, i.e. `<#decl#>` that can be inserted into the source code to represent the missing declaration.
+          This token should always have `presence = .missing`.
+          """
+      ),
     ]
   ),
 
   Node(
     name: "MissingExpr",
     nameForDiagnostics: "expression",
-    kind: "Expr"
+    description: "In case the source code is missing a expression, this node stands in place of the missing expression.",
+    kind: "Expr",
+    children: [
+      Child(
+        name: "Placeholder",
+        kind: .token(choices: [.token(tokenKind: "IdentifierToken")], requiresLeadingSpace: false, requiresTrailingSpace: false),
+        description: """
+          A placeholder, i.e. `<#expression#>` that can be inserted into the source code to represent the missing expression.
+          This token should always have `presence = .missing`.
+          """
+      )
+    ]
   ),
 
   Node(
     name: "MissingPattern",
     nameForDiagnostics: "pattern",
-    kind: "Pattern"
+    description: "In case the source code is missing a pattern, this node stands in place of the missing pattern.",
+    kind: "Pattern",
+    children: [
+      Child(
+        name: "Placeholder",
+        kind: .token(choices: [.token(tokenKind: "IdentifierToken")], requiresLeadingSpace: false, requiresTrailingSpace: false),
+        description: """
+          A placeholder, i.e. `<#pattern#>` that can be inserted into the source code to represent the missing pattern.
+          This token should always have `presence = .missing`.
+          """
+      )
+    ]
   ),
 
   Node(
     name: "MissingStmt",
     nameForDiagnostics: "statement",
-    kind: "Stmt"
+    description: "In case the source code is missing a statement, this node stands in place of the missing statement.",
+    kind: "Stmt",
+    children: [
+      Child(
+        name: "Placeholder",
+        kind: .token(choices: [.token(tokenKind: "IdentifierToken")], requiresLeadingSpace: false, requiresTrailingSpace: false),
+        description: """
+          A placeholder, i.e. `<#statement#>` that can be inserted into the source code to represent the missing pattern.
+          This token should always have `presence = .missing`.
+          """
+      )
+    ]
   ),
 
   Node(
     name: "Missing",
     nameForDiagnostics: nil,
-    kind: "Syntax"
+    description: "In case the source code is missing a syntax node, this node stands in place of the missing node.",
+    kind: "Syntax",
+    children: [
+      Child(
+        name: "Placeholder",
+        kind: .token(choices: [.token(tokenKind: "IdentifierToken")], requiresLeadingSpace: false, requiresTrailingSpace: false),
+        description: """
+          A placeholder, i.e. `<#syntax#>` that can be inserted into the source code to represent the missing pattern.
+          This token should always have `presence = .missing`
+          """
+      )
+    ]
   ),
 
   Node(
     name: "MissingType",
     nameForDiagnostics: "type",
-    kind: "Type"
+    description: "In case the source code is missing a type, this node stands in place of the missing type.",
+    kind: "Type",
+    children: [
+      Child(
+        name: "Placeholder",
+        kind: .token(choices: [.token(tokenKind: "IdentifierToken")], requiresLeadingSpace: false, requiresTrailingSpace: false),
+        description: """
+          A placeholder, i.e. `<#type#>` that can be inserted into the source code to represent the missing type. This token should always have `presence = .missing`.
+          """
+      )
+    ]
   ),
 
   Node(

CodeGeneration/Sources/SyntaxSupport/Trivia.swift

@@ -15,7 +15,6 @@ public class Trivia {
   public let comment: String
   public let characters: [Character]
   public let swiftCharacters: [Character]
-  public let isNewLine: Bool
   public let isComment: Bool
 
   public var lowerName: String { lowercaseFirstWord(name: name) }
@@ -36,17 +35,23 @@ public class Trivia {
 
   public var isCollection: Bool { charactersLen > 0 }
 
+  public var isBlank: Bool {
+    characters.contains { $0.isWhitespace }
+  }
+
+  public var isNewLine: Bool {
+    characters.contains { $0.isNewline }
+  }
+
   init(
     name: String,
     comment: String,
     characters: [Character] = [],
     swiftCharacters: [Character] = [],
-    isNewLine: Bool = false,
     isComment: Bool = false
   ) {
     self.name = name
     self.comment = comment
-    self.isNewLine = isNewLine
     self.isComment = isComment
     self.characters = characters
 
@@ -86,8 +91,7 @@ public let TRIVIAS: [Trivia] = [
     ],
     swiftCharacters: [
       Character("\r")
-    ],
-    isNewLine: true
+    ]
   ),
 
   Trivia(
@@ -100,8 +104,7 @@ public let TRIVIAS: [Trivia] = [
     swiftCharacters: [
       Character("\r"),
       Character("\n"),
-    ],
-    isNewLine: true
+    ]
   ),
 
   Trivia(
@@ -142,8 +145,7 @@ public let TRIVIAS: [Trivia] = [
     ],
     swiftCharacters: [
       Character("\n")
-    ],
-    isNewLine: true
+    ]
   ),
 
   Trivia(

CodeGeneration/Sources/Utils/CodeGenerationFormat.swift

@@ -15,7 +15,13 @@ import SwiftSyntax
 
 /// A format style for files generated by CodeGeneration.
 public class CodeGenerationFormat: BasicFormat {
-  public override var indentation: TriviaPiece { .spaces(indentationLevel * 2) }
+  public init() {
+    super.init(indentationWidth: .spaces(2))
+  }
+
+  var indentedNewline: Trivia {
+    .newline + currentIndentationLevel
+  }
 
   public override func visit(_ node: ArrayElementListSyntax) -> ArrayElementListSyntax {
     let children = node.children(viewMode: .all)
@@ -66,7 +72,7 @@ public class CodeGenerationFormat: BasicFormat {
 
   public override func visit(_ node: MemberDeclListItemSyntax) -> MemberDeclListItemSyntax {
     let formatted = super.visit(node)
-    if node.indexInParent != 0 && !node.decl.is(EnumCaseDeclSyntax.self) {
+    if node != node.parent?.children(viewMode: .sourceAccurate).first?.as(MemberDeclListItemSyntax.self) && !node.decl.is(EnumCaseDeclSyntax.self) {
       return ensuringTwoLeadingNewlines(node: formatted)
     } else {
       return formatted
@@ -92,26 +98,26 @@ public class CodeGenerationFormat: BasicFormat {
   }
 
   private func ensuringTwoLeadingNewlines<NodeType: SyntaxProtocol>(node: NodeType) -> NodeType {
-    if node.leadingTrivia?.first?.isNewline ?? false {
-      return node.with(\.leadingTrivia, indentedNewline + (node.leadingTrivia ?? []))
+    if node.leadingTrivia.first?.isNewline ?? false {
+      return node.with(\.leadingTrivia, indentedNewline + node.leadingTrivia)
     } else {
-      return node.with(\.leadingTrivia, indentedNewline + indentedNewline + (node.leadingTrivia ?? []))
+      return node.with(\.leadingTrivia, indentedNewline + indentedNewline + node.leadingTrivia)
     }
   }
 
   private func formatChildrenSeparatedByNewline<SyntaxType: SyntaxProtocol>(children: SyntaxChildren, elementType: SyntaxType.Type) -> [SyntaxType] {
-    indentationLevel += 1
+    increaseIndentationLevel()
     var formattedChildren = children.map {
       self.visit($0).as(SyntaxType.self)!
     }
     formattedChildren = formattedChildren.map {
-      if $0.leadingTrivia?.first?.isNewline == true {
+      if $0.leadingTrivia.first?.isNewline == true {
         return $0
       } else {
-        return $0.with(\.leadingTrivia, indentedNewline + ($0.leadingTrivia ?? []))
+        return $0.with(\.leadingTrivia, indentedNewline + $0.leadingTrivia)
       }
     }
-    indentationLevel -= 1
+    decreaseIndentationLevel()
     if !formattedChildren.isEmpty {
       formattedChildren[formattedChildren.count - 1] = formattedChildren[formattedChildren.count - 1].with(\.trailingTrivia, indentedNewline)
     }

CodeGeneration/Sources/generate-swiftsyntax/GenerateSwiftSyntax.swift

@@ -80,7 +80,7 @@ struct GenerateSwiftSyntax: ParsableCommand {
     let fileSpecs: [GeneratedFileSpec] =
       [
         // SwiftBasicFormat
-        GeneratedFileSpec(swiftBasicFormatGeneratedDir + ["BasicFormat.swift"], basicFormatFile),
+        GeneratedFileSpec(swiftBasicFormatGeneratedDir + ["BasicFormat+Extensions.swift"], basicFormatExtensionsFile),
 
         // IDEUtils
         GeneratedFileSpec(swiftIdeUtilsGeneratedDir + ["SyntaxClassification.swift"], syntaxClassificationFile),