Merge pull request #1556 from ahoppen/ahoppen/5.9/cherry-pick-2

Cherry-pick multiple PRs to `release/5.9`

Author: ahoppen

BUILD.bazel

@@ -95,14 +95,6 @@ swift_syntax_library(
     ],
 )
 
-swift_syntax_library(
-    name = "SwiftSyntaxParser",
-    deps = [
-        ":SwiftParser",
-        ":SwiftSyntax",
-    ],
-)
-
 swift_syntax_library(
     name = "SwiftRefactor",
     deps = [

CONTRIBUTING.md

@@ -43,11 +43,7 @@ If you can’t find it in your Schemes, you need to manually add it using Produc
 
 ### XCTests
 
-The `SwiftSyntaxParser` module (the legacy parser) of this repository depends on the C++ parser library (`_InternalSwiftSyntaxParser.dylib`) to parse source code.
-The syntax node definitions of that parser library need to match those used by your SwiftSyntax checkout.
-Most of the time, the parser library included in the latest Swift Development Snapshot will fulfill this requirement. 
-
-To run the tests in Xcode, select the latest Swift Development Snapshot in Xcode -> Toolchains, select the SwiftSyntax-Package scheme and hit Product -> Test.
+To run the tests in Xcode, select the SwiftSyntax-Package scheme and hit Product -> Test.
 
 You can also run the tests from the command line using
 ```bash
@@ -68,7 +64,7 @@ Tip: Running SwiftSyntax’s self-parse tests takes the majority of testing time
 
 ### `lit`-based tests
 
-A few tests of the `SwiftSyntaxParser` module (the legacy parser), which test the interaction between SwiftSyntax and the C++ parser library (`_InternalSwiftSyntaxParser.dylib`) are based LLVM’s `lit` and `FileCheck` tools.
+A few tests are based LLVM’s `lit` and `FileCheck` tools.
 To run these, build `FileCheck`, e.g. by building the Swift compiler and run the tests using the following command:
 ```bash
 ./build-script.py test --toolchain /Library/Developer/Toolchains/swift-DEVELOPMENT-SNAPSHOT-<recent date>.xctoolchain/usr --skip-lit-tests --filecheck-exec /path/to/build/Release+Asserts/llvm-macosx-x86_64/bin/FileCheck

CodeGeneration/Sources/SyntaxSupport/Classification.swift

@@ -28,16 +28,15 @@ public class SyntaxClassification {
 public class ChildClassification {
   public let parent: Node
   public let childIndex: Int
-  public let isToken: Bool
-  public let classification: SyntaxClassification?
-  public let force: Bool
+  public let child: Child
+  public var isToken: Bool { child.isToken }
+  public var classification: SyntaxClassification? { child.classification }
+  public var force: Bool { child.forceClassification }
 
   public init(node: Node, childIndex: Int, child: Child) {
     self.parent = node
     self.childIndex = childIndex
-    self.isToken = child.syntaxKind.hasSuffix("Token")
-    self.classification = child.classification
-    self.force = child.forceClassification
+    self.child = child
   }
 }
 

CodeGeneration/Sources/SyntaxSupport/CommonNodes.swift

@@ -83,9 +83,31 @@ public let COMMON_NODES: [Node] = [
     ]
   ),
 
-  // decl-effect-specifiers -> (async | reasync)? (throws | rethrows)?
+  // accessor-effect-specifiers -> (async)? (throws)?
   Node(
-    name: "DeclEffectSpecifiers",
+    name: "AccessorEffectSpecifiers",
+    nameForDiagnostics: "accessor specifiers",
+    kind: "Syntax",
+    traits: [
+      "EffectSpecifiers"
+    ],
+    children: [
+      Child(
+        name: "AsyncSpecifier",
+        kind: .token(choices: [.keyword(text: "async")]),
+        isOptional: true
+      ),
+      Child(
+        name: "ThrowsSpecifier",
+        kind: .token(choices: [.keyword(text: "throws")]),
+        isOptional: true
+      ),
+    ]
+  ),
+
+  // funtion-effect-specifiers -> (async | reasync)? (throws | rethrows)?
+  Node(
+    name: "FunctionEffectSpecifiers",
     nameForDiagnostics: "effect specifiers",
     kind: "Syntax",
     traits: [

CodeGeneration/Sources/SyntaxSupport/DeclNodes.swift

@@ -96,7 +96,7 @@ public let DECL_NODES: [Node] = [
       ),
       Child(
         name: "EffectSpecifiers",
-        kind: .node(kind: "DeclEffectSpecifiers"),
+        kind: .node(kind: "AccessorEffectSpecifiers"),
         isOptional: true
       ),
       Child(
@@ -196,7 +196,7 @@ public let DECL_NODES: [Node] = [
         isOptional: true
       ),
       Child(
-        name: "Members",
+        name: "MemberBlock",
         kind: .node(kind: "MemberDeclBlock")
       ),
     ]
@@ -312,7 +312,7 @@ public let DECL_NODES: [Node] = [
         isOptional: true
       ),
       Child(
-        name: "Members",
+        name: "MemberBlock",
         kind: .node(kind: "MemberDeclBlock")
       ),
     ]
@@ -332,7 +332,7 @@ public let DECL_NODES: [Node] = [
       ),
       Child(
         name: "Detail",
-        kind: .token(choices: [.token(tokenKind: "IdentifierToken"), .keyword(text: "set")])
+        kind: .token(choices: [.token(tokenKind: "IdentifierToken")])
       ),
       Child(
         name: "RightParen",
@@ -348,7 +348,44 @@ public let DECL_NODES: [Node] = [
     children: [
       Child(
         name: "Name",
-        kind: .token(choices: [.keyword(text: "class"), .keyword(text: "convenience"), .keyword(text: "dynamic"), .keyword(text: "final"), .keyword(text: "infix"), .keyword(text: "lazy"), .keyword(text: "optional"), .keyword(text: "override"), .keyword(text: "postfix"), .keyword(text: "prefix"), .keyword(text: "required"), .keyword(text: "static"), .keyword(text: "unowned"), .keyword(text: "weak"), .keyword(text: "private"), .keyword(text: "fileprivate"), .keyword(text: "internal"), .keyword(text: "public"), .keyword(text: "open"), .keyword(text: "mutating"), .keyword(text: "nonmutating"), .keyword(text: "indirect"), .keyword(text: "__consuming"), .keyword(text: "borrowing"), .keyword(text: "consuming"), .keyword(text: "actor"), .keyword(text: "async"), .keyword(text: "distributed"), .keyword(text: "isolated"), .keyword(text: "nonisolated"), .keyword(text: "_const"), .keyword(text: "_local"), .keyword(text: "package")]),
+        kind: .token(choices: [
+          .keyword(text: "__consuming"),
+          .keyword(text: "__setter_access"),
+          .keyword(text: "_const"),
+          .keyword(text: "_local"),
+          .keyword(text: "actor"),
+          .keyword(text: "async"),
+          .keyword(text: "borrowing"),
+          .keyword(text: "class"),
+          .keyword(text: "consuming"),
+          .keyword(text: "convenience"),
+          .keyword(text: "distributed"),
+          .keyword(text: "dynamic"),
+          .keyword(text: "fileprivate"),
+          .keyword(text: "final"),
+          .keyword(text: "indirect"),
+          .keyword(text: "infix"),
+          .keyword(text: "internal"),
+          .keyword(text: "isolated"),
+          .keyword(text: "lazy"),
+          .keyword(text: "mutating"),
+          .keyword(text: "nonisolated"),
+          .keyword(text: "nonmutating"),
+          .keyword(text: "open"),
+          .keyword(text: "optional"),
+          .keyword(text: "override"),
+          .keyword(text: "package"),
+          .keyword(text: "postfix"),
+          .keyword(text: "prefix"),
+          .keyword(text: "private"),
+          .keyword(text: "public"),
+          .keyword(text: "reasync"),
+          .keyword(text: "required"),
+          .keyword(text: "setter_access"),
+          .keyword(text: "static"),
+          .keyword(text: "unowned"),
+          .keyword(text: "weak"),
+        ]),
         classification: "Attribute"
       ),
       Child(
@@ -654,7 +691,7 @@ public let DECL_NODES: [Node] = [
         isOptional: true
       ),
       Child(
-        name: "Members",
+        name: "MemberBlock",
         kind: .node(kind: "MemberDeclBlock"),
         description: "The cases and other members of this enum."
       ),
@@ -709,7 +746,7 @@ public let DECL_NODES: [Node] = [
         isOptional: true
       ),
       Child(
-        name: "Members",
+        name: "MemberBlock",
         kind: .node(kind: "MemberDeclBlock")
       ),
     ]
@@ -842,7 +879,7 @@ public let DECL_NODES: [Node] = [
   ),
 
   // function-signature ->
-  //   '(' parameter-list? ')' decl-effect-specifiers? return-clause?
+  //   '(' parameter-list? ')' function-effect-specifiers? return-clause?
   Node(
     name: "FunctionSignature",
     nameForDiagnostics: "function signature",
@@ -854,7 +891,7 @@ public let DECL_NODES: [Node] = [
       ),
       Child(
         name: "EffectSpecifiers",
-        kind: .node(kind: "DeclEffectSpecifiers"),
+        kind: .node(kind: "FunctionEffectSpecifiers"),
         isOptional: true
       ),
       Child(
@@ -1024,6 +1061,16 @@ public let DECL_NODES: [Node] = [
   Node(
     name: "InitializerDecl",
     nameForDiagnostics: "initializer",
+    description: """
+      An initializer declaration like the following.
+
+      ```swift
+      init(someParameter: Int) {
+      }
+      ```
+
+      The body is optional because this node also represents initializer requirements inside protocols.
+      """,
     kind: "Decl",
     traits: [
       "Attributed"
@@ -1033,43 +1080,51 @@ public let DECL_NODES: [Node] = [
         name: "Attributes",
         kind: .collection(kind: "AttributeList", collectionElementName: "Attribute"),
         nameForDiagnostics: "attributes",
+        description: "Attributes that are attached to the initializer.",
         isOptional: true
       ),
       Child(
         name: "Modifiers",
         kind: .collection(kind: "ModifierList", collectionElementName: "Modifier"),
         nameForDiagnostics: "modifiers",
+        description: "Modifiers attached to the initializer",
         isOptional: true
       ),
       Child(
         name: "InitKeyword",
-        kind: .token(choices: [.keyword(text: "init")])
+        kind: .token(choices: [.keyword(text: "init")]),
+        description: "The init keyword"
       ),
       Child(
         name: "OptionalMark",
         kind: .token(choices: [.token(tokenKind: "PostfixQuestionMarkToken"), .token(tokenKind: "InfixQuestionMarkToken"), .token(tokenKind: "ExclamationMarkToken")]),
+        description: "If the initializer is failable, a question mark to indicate that.",
         isOptional: true
       ),
       Child(
         name: "GenericParameterClause",
         kind: .node(kind: "GenericParameterClause"),
         nameForDiagnostics: "generic parameter clause",
+        description: "Generic parameters of the initializer.",
         isOptional: true
       ),
       Child(
         name: "Signature",
         kind: .node(kind: "FunctionSignature"),
-        nameForDiagnostics: "function signature"
+        nameForDiagnostics: "function signature",
+        description: "The arguments of the initializer. While the function signature allows specifying an return clause, doing so is not semantically valid."
       ),
       Child(
         name: "GenericWhereClause",
         kind: .node(kind: "GenericWhereClause"),
         nameForDiagnostics: "generic where clause",
+        description: "If the initializer had generic parameters, a where clause that can restrict those",
         isOptional: true
       ),
       Child(
         name: "Body",
         kind: .node(kind: "CodeBlock"),
+        description: "The initializer’s body. Missing if the initialier is a requirement of a protocol declaration.",
         isOptional: true
       ),
     ]
@@ -1696,7 +1751,7 @@ public let DECL_NODES: [Node] = [
         isOptional: true
       ),
       Child(
-        name: "Members",
+        name: "MemberBlock",
         kind: .node(kind: "MemberDeclBlock")
       ),
     ]
@@ -1798,7 +1853,7 @@ public let DECL_NODES: [Node] = [
         isOptional: true
       ),
       Child(
-        name: "Members",
+        name: "MemberBlock",
         kind: .node(kind: "MemberDeclBlock")
       ),
     ]

CodeGeneration/Sources/SyntaxSupport/KeywordSpec.swift

@@ -96,7 +96,7 @@ public let KEYWORDS: [KeywordSpec] = [
   KeywordSpec("autoclosure"),
   KeywordSpec("availability"),
   KeywordSpec("available"),
-  KeywordSpec("await"),
+  KeywordSpec("await", requiresTrailingSpace: true),
   KeywordSpec("backDeployed"),
   KeywordSpec("before"),
   KeywordSpec("block"),
@@ -122,7 +122,7 @@ public let KEYWORDS: [KeywordSpec] = [
   KeywordSpec("do", isLexerClassified: true),
   KeywordSpec("dynamic"),
   KeywordSpec("each"),
-  KeywordSpec("else", isLexerClassified: true, requiresTrailingSpace: true),
+  KeywordSpec("else", isLexerClassified: true, requiresLeadingSpace: true, requiresTrailingSpace: true),
   KeywordSpec("enum", isLexerClassified: true, requiresTrailingSpace: true),
   KeywordSpec("escaping"),
   KeywordSpec("exclusivity"),

CodeGeneration/Sources/SyntaxSupport/StmtNodes.swift

@@ -290,18 +290,17 @@ public let STMT_NODES: [Node] = [
       ),
       Child(
         name: "TryKeyword",
-        kind: .node(kind: "TryToken"),
+        kind: .token(choices: [.keyword(text: "try")]),
         isOptional: true
       ),
       Child(
         name: "AwaitKeyword",
         kind: .token(choices: [.keyword(text: "await")]),
-        isOptional: true,
-        classification: "Keyword"
+        isOptional: true
       ),
       Child(
         name: "CaseKeyword",
-        kind: .node(kind: "CaseToken"),
+        kind: .token(choices: [.keyword(text: "case")]),
         isOptional: true
       ),
       Child(

CodeGeneration/Sources/SyntaxSupport/Traits.swift

@@ -41,7 +41,7 @@ public let TRAITS: [Trait] = [
     children: [
       Child(name: "Attributes", kind: .node(kind: "AttributeList"), isOptional: true),
       Child(name: "Modifiers", kind: .node(kind: "ModifierList"), isOptional: true),
-      Child(name: "Members", kind: .node(kind: "MemberDeclBlock")),
+      Child(name: "MemberBlock", kind: .node(kind: "MemberDeclBlock")),
     ]
   ),
   Trait(

CodeGeneration/Sources/Utils/SyntaxBuildableChild.swift

@@ -45,21 +45,34 @@ public extension Child {
     flattened(indentedDocumentation: description ?? "")
   }
 
-  var defaultInitialization: ExprSyntax? {
-    switch kind {
-    case .token(choices: let choices, requiresLeadingSpace: _, requiresTrailingSpace: _):
-      if choices.count == 1, case .keyword(text: let text) = choices.first {
-        var textChoice = text
-        if textChoice == "init" {
-          textChoice = "`init`"
-        }
-        return ExprSyntax(".keyword(.\(raw: textChoice))")
-      } else {
-        return type.defaultInitialization
-      }
-    default:
-      return type.defaultInitialization
+  /// If the child node has a default value, return an expression of the form
+  /// ` = default_value` that can be used as the default value to for a
+  /// function parameter. Otherwise, return `nil`.
+  var defaultInitialization: InitializerClauseSyntax? {
+    if isOptional || isUnexpectedNodes {
+      return InitializerClauseSyntax(value: NilLiteralExprSyntax())
+    }
+    guard let token = token, isToken else {
+      return type.defaultValue.map { InitializerClauseSyntax(value: $0) }
+    }
+    if token.isKeyword {
+      return InitializerClauseSyntax(value: ExprSyntax(".\(raw: token.swiftKind)()"))
+    }
+    if token.text != nil {
+      return InitializerClauseSyntax(value: ExprSyntax(".\(raw: token.swiftKind)Token()"))
+    }
+    guard case .token(let choices, _, _) = kind, choices.count == 1, token.associatedValueClass != nil else {
+      return nil
+    }
+    var textChoice: String
+    switch choices[0] {
+    case .keyword(let text), .token(let text):
+      textChoice = text
+    }
+    if textChoice == "init" {
+      textChoice = "`init`"
     }
+    return InitializerClauseSyntax(value: ExprSyntax(".\(raw: token.swiftKind)(.\(raw: textChoice))"))
   }
 
   /// If this node is a token that can't contain arbitrary text, generate a Swift