Return a keyPathInParent for syntax collections

Previously, `keyPathInParent` returned `nil` for nodes that occurred in `SyntaxCollection`s. Return a subscript-based key path instead.

rdar://111944659

Author: ahoppen

Sources/SwiftSyntax/Syntax.swift

@@ -20,7 +20,7 @@ public enum SyntaxNodeStructure {
   /// The node contains a fixed number of children which can be accessed by these key paths.
   case layout([AnyKeyPath])
 
-  /// The node is a `SyntaxCollection` of the given type.
+  /// The node is a `SyntaxCollection` with elements of the given type.
   case collection(SyntaxProtocol.Type)
 
   /// The node can contain a single node with one of the listed types.
@@ -299,10 +299,14 @@ public extension SyntaxProtocol {
     guard let parent = self.parent else {
       return nil
     }
-    guard case .layout(let childrenKeyPaths) = parent.kind.syntaxNodeType.structure else {
-      return nil
+    switch parent.kind.syntaxNodeType.structure {
+    case .layout(let childrenKeyPaths):
+      return childrenKeyPaths[data.indexInParent]
+    case .collection(_):
+      return (parent.asProtocol(SyntaxProtocol.self) as! any SyntaxCollection).keyPath(for: self.indexInParent)
+    case .choices:
+      preconditionFailure("The parent of a syntax node should always be a concrete node and not one with choices")
     }
-    return childrenKeyPaths[data.indexInParent]
   }
 
   @available(*, deprecated, message: "Use previousToken(viewMode:) instead")
@@ -823,3 +827,12 @@ extension ReversedTokenSequence: CustomReflectable {
 /// replaced by the ``Syntax`` type.
 @available(*, unavailable, message: "use 'Syntax' instead")
 public struct SyntaxNode {}
+
+extension SyntaxCollection {
+  /// Implementation detail of ``SyntaxProtocol/keyPathInParent``.
+  ///
+  /// I couldn't find a way to express this without an extension on ``SyntaxCollection``.
+  fileprivate func keyPath(for index: SyntaxChildrenIndex) -> AnyKeyPath {
+    return \Self[index]
+  }
+}

Tests/SwiftSyntaxTest/SyntaxCollectionsTests.swift

@@ -146,4 +146,17 @@ public class SyntaxCollectionsTests: XCTestCase {
     XCTAssertEqual("\(relems[1])", "1")
     XCTAssertEqual("\(relems[0])", "2")
   }
+
+  public func testKeyPathInParent() throws {
+    let arrayElementList = ArrayElementListSyntax([
+      integerLiteralElement(0),
+      integerLiteralElement(1),
+      integerLiteralElement(2),
+    ])
+
+    let element = arrayElementList[1]
+    let keyPath = try XCTUnwrap(element.keyPathInParent)
+    XCTAssert(type(of: keyPath).rootType == ArrayElementListSyntax.self)
+    XCTAssert(type(of: keyPath).valueType == ArrayElementSyntax.self)
+  }
 }