Fix symbol link parsing bug for disambiguated subtraction operators (#…

…739) rdar://113870038 Co-authored-by: Pat Shaughnessy <[email protected]>
swiftlang · Nov 8, 2023 · c7dad6b · c7dad6b
1 parent 4e9d7f8
commit c7dad6b
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 4 deletions.
diff --git a/Sources/SwiftDocC/Infrastructure/Link Resolution/PathHierarchy+PathComponent.swift b/Sources/SwiftDocC/Infrastructure/Link Resolution/PathHierarchy+PathComponent.swift
@@ -108,10 +108,11 @@ extension PathHierarchy {
         if let dashIndex = name.lastIndex(of: "-") {
             let kind = String(name[dashIndex...].dropFirst())
             let name = String(name[..<dashIndex])
-            if let languagePrefix = knownLanguagePrefixes.first(where: { kind.starts(with: $0) }) {
-                return PathComponent(full: full, name: name, kind: String(kind.dropFirst(languagePrefix.count)), hash: hash)
-            } else {
+            if knownSymbolKinds.contains(kind) {
                 return PathComponent(full: full, name: name, kind: kind, hash: hash)
+            } else if let languagePrefix = knownLanguagePrefixes.first(where: { kind.starts(with: $0) }) {
+                let kindWithoutLanguage = String(kind.dropFirst(languagePrefix.count))
+                return PathComponent(full: full, name: name, kind: kindWithoutLanguage, hash: hash)
             }
         }
         return PathComponent(full: full, name: name, kind: nil, hash: hash)

diff --git a/Tests/SwiftDocCTests/Infrastructure/DocumentationContext/DocumentationContextTests.swift b/Tests/SwiftDocCTests/Infrastructure/DocumentationContext/DocumentationContextTests.swift
@@ -1667,14 +1667,17 @@ let expected = """
             try """
             # ``Operators/MyNumber``
             
-            A documentation extension that curates symbosl with characters not allowed in a resolved reference URL.
+            A documentation extension that curates symbols with characters not allowed in a resolved reference URL.
 
             ## Topics
 
             - ``<(_:_:)``
             - ``>(_:_:)``
             - ``<=(_:_:)``
             - ``>=(_:_:)``
+            - ``-(_:_:)-22pw2``
+            - ``-(_:)-9xdx0``
+            - ``-=(_:_:)-7w3vn``
             """.write(to: root.appendingPathComponent("doc-extension.md"), atomically: true, encoding: .utf8)
         }
 

diff --git a/Tests/SwiftDocCTests/Infrastructure/PathHierarchyTests.swift b/Tests/SwiftDocCTests/Infrastructure/PathHierarchyTests.swift
@@ -1332,6 +1332,14 @@ class PathHierarchyTests: XCTestCase {
         XCTAssertEqual(try tree.findSymbol(path: "<=(_:_:)", parent: myNumberID).identifier.precise, "s:SLsE2leoiySbx_xtFZ::SYNTHESIZED::s:9Operators8MyNumberV")
         XCTAssertEqual(try tree.findSymbol(path: ">=(_:_:)", parent: myNumberID).identifier.precise, "s:SLsE2geoiySbx_xtFZ::SYNTHESIZED::s:9Operators8MyNumberV")
 
+        XCTAssertEqual(try tree.findSymbol(path: "-(_:_:)-22pw2", parent: myNumberID).identifier.precise, "s:9Operators8MyNumberV1soiyA2C_ACtFZ")
+        XCTAssertEqual(try tree.findSymbol(path: "-(_:)-9xdx0", parent: myNumberID).identifier.precise, "s:s13SignedNumericPsE1sopyxxFZ::SYNTHESIZED::s:9Operators8MyNumberV")
+        XCTAssertEqual(try tree.findSymbol(path: "-=(_:_:)-7w3vn", parent: myNumberID).identifier.precise, "s:s18AdditiveArithmeticPsE2seoiyyxz_xtFZ::SYNTHESIZED::s:9Operators8MyNumberV")
+
+        XCTAssertEqual(try tree.findSymbol(path: "-(_:_:)-func.op", parent: myNumberID).identifier.precise, "s:9Operators8MyNumberV1soiyA2C_ACtFZ")
+        XCTAssertEqual(try tree.findSymbol(path: "-(_:)-func.op", parent: myNumberID).identifier.precise, "s:s13SignedNumericPsE1sopyxxFZ::SYNTHESIZED::s:9Operators8MyNumberV")
+        XCTAssertEqual(try tree.findSymbol(path: "-=(_:_:)-func.op", parent: myNumberID).identifier.precise, "s:s18AdditiveArithmeticPsE2seoiyyxz_xtFZ::SYNTHESIZED::s:9Operators8MyNumberV")
+
         let paths = tree.caseInsensitiveDisambiguatedPaths()
 
         // Unmodified operator name in URL
@@ -1622,6 +1630,8 @@ class PathHierarchyTests: XCTestCase {
         assertParsedPathComponents("path-swift.type.property-hash", [("path", "type.property", "hash")])
         assertParsedPathComponents("path-type.property", [("path", "type.property", nil)])
         assertParsedPathComponents("path-swift.type.property", [("path", "type.property", nil)])
+
+        assertParsedPathComponents("-(_:_:)-hash", [("-(_:_:)", nil, "hash")])
     }
 
     // MARK: Test helpers