Merge pull request #2386 from apple/resultDependsOn

meg-gupta · web-flow · commit ab4b2bd54cd9 · 2023-12-06T22:12:28.000-08:00
Add initial support for _resultDependsOn
diff --git a/CodeGeneration/Sources/SyntaxSupport/KeywordSpec.swift b/CodeGeneration/Sources/SyntaxSupport/KeywordSpec.swift
@@ -239,6 +239,7 @@ public enum Keyword: CaseIterable {
   case renamed
   case `repeat`
   case required
+  case _resultDependsOn
   case _resultDependsOnSelf
   case `rethrows`
   case retroactive
@@ -611,6 +612,8 @@ public enum Keyword: CaseIterable {
       return KeywordSpec("repeat", isLexerClassified: true)
     case .required:
       return KeywordSpec("required")
+    case ._resultDependsOn:
+      return KeywordSpec("_resultDependsOn", experimentalFeature: .nonEscapableTypes)
     case ._resultDependsOnSelf:
       return KeywordSpec("_resultDependsOnSelf", experimentalFeature: .nonEscapableTypes)
     case .rethrows:
diff --git a/CodeGeneration/Sources/SyntaxSupport/TypeNodes.swift b/CodeGeneration/Sources/SyntaxSupport/TypeNodes.swift
@@ -52,6 +52,7 @@ public let TYPE_NODES: [Node] = [
           .keyword(._const),
           .keyword(.borrowing),
           .keyword(.consuming),
+          .keyword(._resultDependsOn),
         ]),
         isOptional: true
       ),
diff --git a/Sources/SwiftParser/Declarations.swift b/Sources/SwiftParser/Declarations.swift
@@ -18,7 +18,7 @@ extension DeclarationModifier {
     case .__consuming, .__setter_access, ._const, ._local, .async,
       .borrowing, .class, .consuming, .convenience, .distributed, .dynamic,
       .final, .indirect, .infix, .isolated, .lazy, .mutating, .nonmutating,
-      .optional, .override, .postfix, .prefix, .reasync, ._resultDependsOnSelf, .required,
+      .optional, .override, .postfix, .prefix, .reasync, ._resultDependsOn, ._resultDependsOnSelf, .required,
       .rethrows, .static, .weak:
       return false
     case .fileprivate, .internal, .nonisolated, .package, .open, .private,
diff --git a/Sources/SwiftParser/Patterns.swift b/Sources/SwiftParser/Patterns.swift
@@ -354,6 +354,7 @@ extension Parser.Lookahead {
         && !self.at(.keyword(.__owned))
         && !self.at(.keyword(.borrowing))
         && !self.at(.keyword(.consuming))
+        && !(experimentalFeatures.contains(.nonEscapableTypes) && self.at(.keyword(._resultDependsOn)))
       {
         return true
       }
diff --git a/Sources/SwiftParser/TokenPrecedence.swift b/Sources/SwiftParser/TokenPrecedence.swift
@@ -230,7 +230,7 @@ enum TokenPrecedence: Comparable {
       // Declaration Modifiers
       .__consuming, .final, .required, .optional, .lazy, .dynamic, .infix, .postfix, .prefix, .mutating, .nonmutating, .convenience, .override, .package, .open,
       .__setter_access, .indirect, .isolated, .nonisolated, .distributed, ._local,
-      .inout, ._mutating, ._borrow, ._borrowing, .borrowing, ._consuming, .consuming, .consume, ._resultDependsOnSelf,
+      .inout, ._mutating, ._borrow, ._borrowing, .borrowing, ._consuming, .consuming, .consume, ._resultDependsOnSelf, ._resultDependsOn,
       // Accessors
       .get, .set, .didSet, .willSet, .unsafeAddress, .addressWithOwner, .addressWithNativeOwner, .unsafeMutableAddress,
       .mutableAddressWithOwner, .mutableAddressWithNativeOwner, ._read, ._modify,
diff --git a/Sources/SwiftParser/TokenSpecSet.swift b/Sources/SwiftParser/TokenSpecSet.swift
@@ -376,6 +376,7 @@ enum DeclarationModifier: TokenSpecSet {
   case `static`
   case unowned
   case weak
+  case _resultDependsOn
   case _resultDependsOnSelf
 
   init?(lexeme: Lexer.Lexeme, experimentalFeatures: Parser.ExperimentalFeatures) {
@@ -415,6 +416,7 @@ enum DeclarationModifier: TokenSpecSet {
     case TokenSpec(.static): self = .static
     case TokenSpec(.unowned): self = .unowned
     case TokenSpec(.weak): self = .weak
+    case TokenSpec(._resultDependsOn) where experimentalFeatures.contains(.nonEscapableTypes): self = ._resultDependsOn
     case TokenSpec(._resultDependsOnSelf) where experimentalFeatures.contains(.nonEscapableTypes): self = ._resultDependsOnSelf
     default: return nil
     }
@@ -457,6 +459,7 @@ enum DeclarationModifier: TokenSpecSet {
     case .static: return .keyword(.static)
     case .unowned: return TokenSpec(.unowned, recoveryPrecedence: .declKeyword)
     case .weak: return TokenSpec(.weak, recoveryPrecedence: .declKeyword)
+    case ._resultDependsOn: return TokenSpec(._resultDependsOn, recoveryPrecedence: .declKeyword)
     case ._resultDependsOnSelf: return TokenSpec(._resultDependsOnSelf, recoveryPrecedence: .declKeyword)
     }
   }
diff --git a/Sources/SwiftParser/generated/Parser+TokenSpecSet.swift b/Sources/SwiftParser/generated/Parser+TokenSpecSet.swift
@@ -183,6 +183,8 @@ extension AttributedTypeSyntax {
     case _const
     case borrowing
     case consuming
+    @_spi(ExperimentalLanguageFeatures)
+    case _resultDependsOn
     
     init?(lexeme: Lexer.Lexeme, experimentalFeatures: Parser.ExperimentalFeatures) {
       switch PrepareForKeywordMatch(lexeme) {
@@ -200,6 +202,8 @@ extension AttributedTypeSyntax {
         self = .borrowing
       case TokenSpec(.consuming):
         self = .consuming
+      case TokenSpec(._resultDependsOn) where experimentalFeatures.contains(.nonEscapableTypes):
+        self = ._resultDependsOn
       default:
         return nil
       }
@@ -221,6 +225,8 @@ extension AttributedTypeSyntax {
         return .keyword(.borrowing)
       case .consuming:
         return .keyword(.consuming)
+      case ._resultDependsOn:
+        return .keyword(._resultDependsOn)
       }
     }
     
@@ -244,6 +250,8 @@ extension AttributedTypeSyntax {
         return .keyword(.borrowing)
       case .consuming:
         return .keyword(.consuming)
+      case ._resultDependsOn:
+        return .keyword(._resultDependsOn)
       }
     }
   }
diff --git a/Sources/SwiftSyntax/generated/Keyword.swift b/Sources/SwiftSyntax/generated/Keyword.swift
@@ -182,6 +182,8 @@ public enum Keyword: UInt8, Hashable {
   case `repeat`
   case required
   @_spi(ExperimentalLanguageFeatures)
+  case _resultDependsOn
+  @_spi(ExperimentalLanguageFeatures)
   case _resultDependsOnSelf
   case `rethrows`
   case retroactive
@@ -688,6 +690,8 @@ public enum Keyword: UInt8, Hashable {
         self = ._objcRuntimeName
       case "addressWithOwner":
         self = .addressWithOwner
+      case "_resultDependsOn":
+        self = ._resultDependsOn
       default:
         return nil
       }
@@ -946,6 +950,7 @@ public enum Keyword: UInt8, Hashable {
       "renamed", 
       "repeat", 
       "required", 
+      "_resultDependsOn", 
       "_resultDependsOnSelf", 
       "rethrows", 
       "retroactive", 
diff --git a/Sources/SwiftSyntax/generated/raw/RawSyntaxValidation.swift b/Sources/SwiftSyntax/generated/raw/RawSyntaxValidation.swift
@@ -386,7 +386,8 @@ func validateLayout(layout: RawSyntaxBuffer, as kind: SyntaxKind) {
             .keyword("isolated"), 
             .keyword("_const"), 
             .keyword("borrowing"), 
-            .keyword("consuming")
+            .keyword("consuming"), 
+            .keyword("_resultDependsOn")
           ]))
     assertNoError(kind, 2, verify(layout[2], as: RawUnexpectedNodesSyntax?.self))
     assertNoError(kind, 3, verify(layout[3], as: RawAttributeListSyntax.self))
diff --git a/Sources/SwiftSyntax/generated/syntaxNodes/SyntaxNodesAB.swift b/Sources/SwiftSyntax/generated/syntaxNodes/SyntaxNodesAB.swift
@@ -3257,7 +3257,7 @@ public struct AttributeSyntax: SyntaxProtocol, SyntaxHashable, _LeafSyntaxNodePr
 
 /// ### Children
 /// 
-///  - `specifier`: (`inout` | `__shared` | `__owned` | `isolated` | `_const` | `borrowing` | `consuming`)?
+///  - `specifier`: (`inout` | `__shared` | `__owned` | `isolated` | `_const` | `borrowing` | `consuming` | `_resultDependsOn`)?
 ///  - `attributes`: ``AttributeListSyntax``
 ///  - `baseType`: ``TypeSyntax``
 public struct AttributedTypeSyntax: TypeSyntaxProtocol, SyntaxHashable, _LeafTypeSyntaxNodeProtocol {
@@ -3336,6 +3336,7 @@ public struct AttributedTypeSyntax: TypeSyntaxProtocol, SyntaxHashable, _LeafTyp
   ///  - `_const`
   ///  - `borrowing`
   ///  - `consuming`
+  ///  - `_resultDependsOn`
   public var specifier: TokenSyntax? {
     get {
       return Syntax(self).child(at: 1)?.cast(TokenSyntax.self)
diff --git a/Tests/SwiftParserTest/DeclarationTests.swift b/Tests/SwiftParserTest/DeclarationTests.swift
@@ -3120,4 +3120,26 @@ final class DeclarationTests: ParserTestCase {
       experimentalFeatures: .nonEscapableTypes
     )
   }
+
+  func testResultDependsOn() {
+    assertParse(
+      """
+        class Klass {}
+        func testTypeSpecifier(x : _resultDependsOn Klass) -> Builtin.NativeObject {
+          return Builtin.unsafeCastToNativeObject(x)
+        }
+      """,
+      experimentalFeatures: .nonEscapableTypes
+    )
+
+    assertParse(
+      """
+        class Klass {}
+        func testMultipleTypeSpecifier(x : _resultDependsOn Klass, y : _resultDependsOn Klass) -> (Builtin.NativeObject, Builtin.NativeObject) {
+          return (Builtin.unsafeCastToNativeObject(x), Builtin.unsafeCastToNativeObject(x))
+        }
+      """,
+      experimentalFeatures: .nonEscapableTypes
+    )
+  }
 }

Original file line number	Diff line number	Diff line change
`@@ -354,6 +354,7 @@ extension Parser.Lookahead {`
`354`	`354`	`&& !self.at(.keyword(.__owned))`
`355`	`355`	`&& !self.at(.keyword(.borrowing))`
`356`	`356`	`&& !self.at(.keyword(.consuming))`
	`357`	`+ && !(experimentalFeatures.contains(.nonEscapableTypes) && self.at(.keyword(._resultDependsOn)))`
`357`	`358`	`{`
`358`	`359`	`return true`
`359`	`360`	`}`
Original file line number	Diff line number	Diff line change
`@@ -183,6 +183,8 @@ extension AttributedTypeSyntax {`
`183`	`183`	`case _const`
`184`	`184`	`case borrowing`
`185`	`185`	`case consuming`
	`186`	`+ @_spi(ExperimentalLanguageFeatures)`
	`187`	`+ case _resultDependsOn`
`186`	`188`
`187`	`189`	`init?(lexeme: Lexer.Lexeme, experimentalFeatures: Parser.ExperimentalFeatures) {`
`188`	`190`	`switch PrepareForKeywordMatch(lexeme) {`
`@@ -200,6 +202,8 @@ extension AttributedTypeSyntax {`
`200`	`202`	`self = .borrowing`
`201`	`203`	`case TokenSpec(.consuming):`
`202`	`204`	`self = .consuming`
	`205`	`+ case TokenSpec(._resultDependsOn) where experimentalFeatures.contains(.nonEscapableTypes):`
	`206`	`+ self = ._resultDependsOn`
`203`	`207`	`default:`
`204`	`208`	`return nil`
`205`	`209`	`}`
`@@ -221,6 +225,8 @@ extension AttributedTypeSyntax {`
`221`	`225`	`return .keyword(.borrowing)`
`222`	`226`	`case .consuming:`
`223`	`227`	`return .keyword(.consuming)`
	`228`	`+ case ._resultDependsOn:`
	`229`	`+ return .keyword(._resultDependsOn)`
`224`	`230`	`}`
`225`	`231`	`}`
`226`	`232`
`@@ -244,6 +250,8 @@ extension AttributedTypeSyntax {`
`244`	`250`	`return .keyword(.borrowing)`
`245`	`251`	`case .consuming:`
`246`	`252`	`return .keyword(.consuming)`
	`253`	`+ case ._resultDependsOn:`
	`254`	`+ return .keyword(._resultDependsOn)`
`247`	`255`	`}`
`248`	`256`	`}`
`249`	`257`	`}`