Merge pull request #449 from johnfairh/objc-swift-decls

Fix generic Swift declaration generation from ObjC
jpsim · Nov 29, 2017 · 5114805 · 5114805
2 parents c297619 + 459cfb8
commit 5114805
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 19 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,7 +11,8 @@
 
 ##### Bug Fixes
 
-* None.
+* Fix Swift declarations when generating Objective-C docs for generic types.  
+  [John Fairhurst](https://github.com/johnfairh)
 
 ## 0.18.4
 

diff --git a/Source/SourceKittenFramework/Clang+SourceKitten.swift b/Source/SourceKittenFramework/Clang+SourceKitten.swift
@@ -212,21 +212,9 @@ extension CXCursor {
             return nil
         }
 
-        // SourceKit with Xcode 9+ doesn't escape ampersands in its XML output, so let's sanitize the XML ourselves.
-        func fixAmpersandInXML(_ xml: String) -> String {
-            return xml.replacingOccurrences(of: " & ", with: " &amp; ")
-        }
-
         let cursorInfo = Request.cursorInfo(file: swiftUUID, offset: usrOffset, arguments: compilerArguments).send()
-        if let docsXML = cursorInfo[SwiftDocKey.fullXMLDocs.rawValue] as? String,
-            case let fixedDocsXML = fixAmpersandInXML(docsXML),
-           let swiftDeclaration = SWXMLHash.parse(fixedDocsXML).children.first?["Declaration"].element?.text {
-                return swiftDeclaration
-        }
-
         if let annotatedDeclarationXML = cursorInfo[SwiftDocKey.annotatedDeclaration.rawValue] as? String,
-            case let fixedAnnotatedDeclarationXML = fixAmpersandInXML(annotatedDeclarationXML),
-           let swiftDeclaration = SWXMLHash.parse(fixedAnnotatedDeclarationXML).element?.recursiveText {
+           let swiftDeclaration = SWXMLHash.parse(annotatedDeclarationXML).element?.recursiveText {
                 return swiftDeclaration
         }
 

diff --git a/Tests/SourceKittenFrameworkTests/Fixtures/Realm@swift-3.2.json b/Tests/SourceKittenFrameworkTests/Fixtures/Realm@swift-3.2.json
@@ -838,7 +838,7 @@
               "key.usr" : "c:objc(cs)RLMArray(cm)new"
             }
           ],
-          "key.swift_declaration" : "class RLMArray",
+          "key.swift_declaration" : "class RLMArray<RLMObjectType> : NSObject, RLMCollection, NSFastEnumeration where RLMObjectType : RLMObject",
           "key.unavailable_message" : "",
           "key.usr" : "c:objc(cs)RLMArray"
         },
@@ -5487,7 +5487,7 @@
               "key.parsed_declaration" : "- (nonnull RLMResults<RLMObjectType> *)objectsWithPredicate:\n    (nonnull NSPredicate *)predicate;",
               "key.parsed_scope.end" : 132,
               "key.parsed_scope.start" : 132,
-              "key.swift_declaration" : "func objects(with predicate: NSPredicate) -> RLMResults",
+              "key.swift_declaration" : "func objects(with predicate: NSPredicate) -> RLMResults<RLMObjectType>",
               "key.unavailable_message" : "",
               "key.usr" : "c:objc(cs)RLMResults(im)objectsWithPredicate:"
             },
@@ -5532,7 +5532,7 @@
               "key.parsed_declaration" : "- (nonnull RLMResults<RLMObjectType> *)\nsortedResultsUsingProperty:(nonnull NSString *)property\n                 ascending:(BOOL)ascending;",
               "key.parsed_scope.end" : 142,
               "key.parsed_scope.start" : 142,
-              "key.swift_declaration" : "func sortedResults(usingProperty property: String, ascending: Bool) -> RLMResults",
+              "key.swift_declaration" : "func sortedResults(usingProperty property: String, ascending: Bool) -> RLMResults<RLMObjectType>",
               "key.unavailable_message" : "",
               "key.usr" : "c:objc(cs)RLMResults(im)sortedResultsUsingProperty:ascending:"
             },
@@ -5568,7 +5568,7 @@
               "key.parsed_declaration" : "- (nonnull RLMResults<RLMObjectType> *)sortedResultsUsingDescriptors:\n    (nonnull NSArray *)properties;",
               "key.parsed_scope.end" : 151,
               "key.parsed_scope.start" : 151,
-              "key.swift_declaration" : "func sortedResults(usingDescriptors properties: [Any]) -> RLMResults",
+              "key.swift_declaration" : "func sortedResults(usingDescriptors properties: [Any]) -> RLMResults<RLMObjectType>",
               "key.unavailable_message" : "",
               "key.usr" : "c:objc(cs)RLMResults(im)sortedResultsUsingDescriptors:"
             },
@@ -5790,7 +5790,7 @@
               "key.usr" : "c:objc(cs)RLMResults(cm)new"
             }
           ],
-          "key.swift_declaration" : "class RLMResults",
+          "key.swift_declaration" : "class RLMResults<RLMObjectType> : NSObject, RLMCollection, NSFastEnumeration where RLMObjectType : RLMObject",
           "key.unavailable_message" : "",
           "key.usr" : "c:objc(cs)RLMResults"
         }