Merge pull request #1216 from DougGregor/accessor-decl-interpolation

Accessor decl interpolation

Author: DougGregor

CodeGeneration/Sources/SyntaxSupport/gyb_generated/DeclNodes.swift

@@ -1026,6 +1026,7 @@ public let DECL_NODES: [Node] = [
        traits: [
          "Attributed"
        ],
+       parserFunction: "parseAccessorDecl",
        children: [
          Child(name: "Attributes",
                kind: "AttributeList",

Sources/SwiftParser/Declarations.swift

@@ -1543,12 +1543,14 @@ extension Parser {
     var token: RawTokenSyntax
   }
 
-  mutating func parseAccessorIntroducer() -> AccessorIntroducer? {
+  mutating func parseAccessorIntroducer(
+    forcedKind: (AccessorKind, TokenConsumptionHandle)? = nil
+  ) -> AccessorIntroducer? {
     // Check there is an identifier before consuming
     var look = self.lookahead()
     let _ = look.consumeAttributeList()
     let hasModifier = look.consume(ifAny: [.contextualKeyword(.mutating), .contextualKeyword(.nonmutating), .contextualKeyword(.__consuming)]) != nil
-    guard let (kind, handle) = look.at(anyIn: AccessorKind.self) else {
+    guard let (kind, handle) = look.at(anyIn: AccessorKind.self) ?? forcedKind else {
       return nil
     }
 
@@ -1611,15 +1613,18 @@ extension Parser {
     return specifiers
   }
 
-  /// Parse the body of a variable declaration. This can include explicit
-  /// getters, setters, and observers, or the body of a computed property.
+  /// Parse an accessor.
+  mutating func parseAccessorDecl() -> RawAccessorDeclSyntax {
+    let forcedHandle = TokenConsumptionHandle(tokenKind: .contextualKeyword(.get), missing: true)
+    let introducer = parseAccessorIntroducer(forcedKind: (.get, forcedHandle))!
+    return parseAccessorDecl(introducer: introducer)
+  }
+
+  /// Parse an accessor once we know we have an introducer
   ///
   /// Grammar
   /// =======
   ///
-  ///     getter-setter-block → code-block
-  ///     getter-setter-block → { getter-clause setter-clause opt }
-  ///     getter-setter-block → { setter-clause getter-clause }
   ///     getter-clause → attributes opt mutation-modifier opt get code-block
   ///     setter-clause → attributes opt mutation-modifier opt set setter-name opt code-block
   ///     setter-name → ( identifier )
@@ -1631,6 +1636,63 @@ extension Parser {
   ///     willSet-didSet-block → { didSet-clause willSet-clause opt }
   ///     willSet-clause → attributes opt willSet setter-name opt code-block
   ///     didSet-clause → attributes opt didSet setter-name opt code-block
+  private mutating func parseAccessorDecl(
+    introducer: AccessorIntroducer
+  ) -> RawAccessorDeclSyntax {
+    // 'set' and 'willSet' can have an optional name.  This isn't valid in a
+    // protocol, but we parse and then reject it for better QoI.
+    //
+    //     set-name    ::= '(' identifier ')'
+    let parameter: RawAccessorParameterSyntax?
+    if [AccessorKind.set, .willSet, .didSet].contains(introducer.kind), let lparen = self.consume(if: .leftParen) {
+      let (unexpectedBeforeName, name) = self.expectIdentifier()
+      let (unexpectedBeforeRParen, rparen) = self.expect(.rightParen)
+      parameter = RawAccessorParameterSyntax(
+        leftParen: lparen,
+        unexpectedBeforeName,
+        name: name,
+        unexpectedBeforeRParen,
+        rightParen: rparen,
+        arena: self.arena
+      )
+    } else {
+      parameter = nil
+    }
+
+    // Next, parse effects specifiers. While it's only valid to have them
+    // on 'get' accessors, we also emit diagnostics if they show up on others.
+    let asyncKeyword: RawTokenSyntax?
+    let throwsKeyword: RawTokenSyntax?
+    if self.at(anyIn: EffectsSpecifier.self) != nil {
+      asyncKeyword = self.parseEffectsSpecifier()
+      throwsKeyword = self.parseEffectsSpecifier()
+    } else {
+      asyncKeyword = nil
+      throwsKeyword = nil
+    }
+
+    let body = self.parseOptionalCodeBlock()
+    return RawAccessorDeclSyntax(
+      attributes: introducer.attributes,
+      modifier: introducer.modifier,
+      accessorKind: introducer.token,
+      parameter: parameter,
+      asyncKeyword: asyncKeyword,
+      throwsKeyword: throwsKeyword,
+      body: body,
+      arena: self.arena
+    )
+  }
+
+  /// Parse the body of a variable declaration. This can include explicit
+  /// getters, setters, and observers, or the body of a computed property.
+  ///
+  /// Grammar
+  /// =======
+  ///
+  ///     getter-setter-block → code-block
+  ///     getter-setter-block → { getter-clause setter-clause opt }
+  ///     getter-setter-block → { setter-clause getter-clause }
   @_spi(RawSyntax)
   public mutating func parseGetSet() -> RawSubscriptDeclSyntax.Accessor {
     // Parse getter and setter.
@@ -1685,52 +1747,7 @@ extension Parser {
           )
         }
 
-        // 'set' and 'willSet' can have an optional name.  This isn't valid in a
-        // protocol, but we parse and then reject it for better QoI.
-        //
-        //     set-name    ::= '(' identifier ')'
-        let parameter: RawAccessorParameterSyntax?
-        if [AccessorKind.set, .willSet, .didSet].contains(introducer.kind), let lparen = self.consume(if: .leftParen) {
-          let (unexpectedBeforeName, name) = self.expectIdentifier()
-          let (unexpectedBeforeRParen, rparen) = self.expect(.rightParen)
-          parameter = RawAccessorParameterSyntax(
-            leftParen: lparen,
-            unexpectedBeforeName,
-            name: name,
-            unexpectedBeforeRParen,
-            rightParen: rparen,
-            arena: self.arena
-          )
-        } else {
-          parameter = nil
-        }
-
-        // Next, parse effects specifiers. While it's only valid to have them
-        // on 'get' accessors, we also emit diagnostics if they show up on others.
-        let asyncKeyword: RawTokenSyntax?
-        let throwsKeyword: RawTokenSyntax?
-        if self.at(anyIn: EffectsSpecifier.self) != nil {
-          asyncKeyword = self.parseEffectsSpecifier()
-          throwsKeyword = self.parseEffectsSpecifier()
-        } else {
-          asyncKeyword = nil
-          throwsKeyword = nil
-        }
-
-        let body = self.parseOptionalCodeBlock()
-
-        elements.append(
-          RawAccessorDeclSyntax(
-            attributes: introducer.attributes,
-            modifier: introducer.modifier,
-            accessorKind: introducer.token,
-            parameter: parameter,
-            asyncKeyword: asyncKeyword,
-            throwsKeyword: throwsKeyword,
-            body: body,
-            arena: self.arena
-          )
-        )
+        elements.append(parseAccessorDecl(introducer: introducer))
       }
     }
 

Sources/SwiftParser/generated/Parser+Entry.swift

@@ -43,6 +43,14 @@ public protocol SyntaxParseable: SyntaxProtocol {
   static func parse(from parser: inout Parser) -> Self
 }
 
+extension AccessorDeclSyntax: SyntaxParseable {
+  public static func parse(from parser: inout Parser) -> Self {
+    let node = parser.parseAccessorDecl()
+    let raw = RawSyntax(parser.parseRemainder(into: node))
+    return Syntax(raw: raw).cast(Self.self)
+  }
+}
+
 extension AttributeSyntax: SyntaxParseable {
   public static func parse(from parser: inout Parser) -> Self {
     let node = parser.parseAttribute()

Sources/SwiftSyntaxBuilder/generated/SyntaxExpressibleByStringInterpolationConformances.swift

@@ -26,7 +26,12 @@ extension SyntaxParseable {
   }
 }
 
-extension AccessorDeclSyntax: SyntaxExpressibleByStringInterpolation { 
+extension AccessorDeclSyntax: SyntaxExpressibleByStringInterpolation {
+  public init(stringInterpolationOrThrow stringInterpolation: SyntaxStringInterpolation) throws {
+    self = try performParse(source: stringInterpolation.sourceText, parse: { parser in 
+        return Self.parse(from: &parser)
+      })
+  }
 }
 
 extension ActorDeclSyntax: SyntaxExpressibleByStringInterpolation { 

Sources/_SwiftSyntaxMacros/PeerDeclarationMacro.swift

@@ -15,7 +15,7 @@ public protocol PeerDeclarationMacro: DeclarationMacro {
   /// particular expansion context.
   ///
   /// The macro expansion can introduce "peer" declarations that sit alongside
-  /// the
+  /// the given declaration.
   static func expansion(
     of node: CustomAttributeSyntax,
     attachedTo declaration: DeclSyntax,

Tests/SwiftSyntaxBuilderTest/StringInterpolation.swift

@@ -421,4 +421,22 @@ final class StringInterpolationTests: XCTestCase {
       """
     )
   }
+
+  func testAccessorInterpolation() {
+    let setter: AccessorDeclSyntax =
+      """
+      set(newValue) {
+        _storage = newValue
+      }
+      """
+    XCTAssertTrue(setter.is(AccessorDeclSyntax.self))
+    AssertStringsEqualWithDiff(
+      setter.description,
+      """
+      set(newValue) {
+        _storage = newValue
+      }
+      """
+    )
+  }
 }

gyb_syntax_support/DeclNodes.py

@@ -555,6 +555,7 @@
 
     Node('AccessorDecl', name_for_diagnostics='accessor', kind='Decl',
          traits=['Attributed'],
+         parser_function='parseAccessorDecl',
          children=[
              Child('Attributes', kind='AttributeList', name_for_diagnostics='attributes',
                    collection_element_name='Attribute', is_optional=True),