Merge pull request #305 from jpsim/jp-fix-missing-enum-case-objc-docs

fix ObjC enum cases not being documented
jpsim · Dec 1, 2016 · 69ef6f6 · 69ef6f6
2 parents 93454d8 + 9763f2c
commit 69ef6f6
Show file tree

Hide file tree

Showing 6 changed files with 365 additions and 44 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,7 +10,9 @@
 
 ##### Bug Fixes
 
-* None.
+* Fix Objective-C enum cases not being documented.  
+  [JP Simard](https://github.com/jpsim)
+  [#304](https://github.com/jpsim/SourceKitten/issues/304)
 
 ## 0.15.1
 

diff --git a/Source/SourceKittenFramework/Clang+SourceKitten.swift b/Source/SourceKittenFramework/Clang+SourceKitten.swift
@@ -94,17 +94,8 @@ extension CXCursor {
     }
 
     func name() -> String {
-        let spelling = clang_getCursorSpelling(self).str()!
         let type = objCKind()
-        if let usrString = usr(), spelling.isEmpty && type == .enum {
-            // libClang considers enums declared like `typedef enum {} name;` rather than `NS_ENUM()`
-            // to have a cursor spelling of "" (empty string). So we parse the USR to extract the actual name.
-            let prefix = "c:@EA@"
-            assert(usrString.hasPrefix(prefix))
-            let index = usrString.index(usrString.startIndex,
-                                        offsetBy: prefix.lengthOfBytes(using: .utf8))
-            return usrString.substring(from: index)
-        } else if type == .category, let usrNSString = usr() as NSString? {
+        if type == .category, let usrNSString = usr() as NSString? {
             let ext = (usrNSString.range(of: "c:objc(ext)").location == 0)
             let regex = try! NSRegularExpression(pattern: "(\\w+)@(\\w+)", options: [])
             let range = NSRange(location: 0, length: usrNSString.length)
@@ -116,7 +107,9 @@ extension CXCursor {
             } else {
                 fatalError("Couldn't get category name")
             }
-        } else if type == .methodInstance {
+        }
+        let spelling = clang_getCursorSpelling(self).str()!
+        if type == .methodInstance {
             return "-" + spelling
         } else if type == .methodClass {
             return "+" + spelling

diff --git a/Source/SourceKittenFramework/ClangTranslationUnit.swift b/Source/SourceKittenFramework/ClangTranslationUnit.swift
@@ -64,6 +64,7 @@ public struct ClangTranslationUnit {
         clangTranslationUnits = headerFiles.map { clangIndex.open(file: $0, args: cStringCompilerArguments) }
         declarations = clangTranslationUnits
             .flatMap { $0.cursor().flatMap({ SourceDeclaration(cursor: $0, compilerArguments: compilerArguments) }) }
+            .rejectEmptyDuplicateEnums()
             .distinct()
             .sorted()
             .groupBy { $0.location.file }

diff --git a/Source/SourceKittenFramework/SourceDeclaration.swift b/Source/SourceKittenFramework/SourceDeclaration.swift
@@ -147,6 +147,20 @@ extension Sequence where Iterator.Element == SourceDeclaration {
         }
         return filter { !propertyGetterSetterUSRs.contains($0.usr!) }
     }
+
+    /// Reject one of an enum duplicate pair that's empty if the other isn't.
+    func rejectEmptyDuplicateEnums() -> [SourceDeclaration] {
+        let enums = filter { $0.type == .enum }
+        let enumUSRs = enums.map { $0.usr! }
+        let dupedEmptyUSRs = enumUSRs.filter { usr in
+            let enumsForUSR = enums.filter { $0.usr == usr }
+            let childCounts = Set(enumsForUSR.map({ $0.children.count }))
+            return childCounts.count > 1 && childCounts.contains(0)
+        }
+        return filter {
+            $0.type != .enum || !dupedEmptyUSRs.contains($0.usr!) || !$0.children.isEmpty
+        }
+    }
 }
 
 extension SourceDeclaration: Hashable {

diff --git a/Tests/SourceKittenFrameworkTests/Fixtures/CommandantSPM.json b/Tests/SourceKittenFrameworkTests/Fixtures/CommandantSPM.json
@@ -790,6 +790,9 @@
           },
           {
             "key.annotated_decl" : "<RelatedName usr=\"s:F6Resultoi2eeuRxS_14ResultProtocolwx5Errors9Equatablewx5ValueS2_rFTxx_Sb\">==&lt;T : ResultProtocol where T.Value : Equatable, T.Error : Equatable&gt;(_: T, _: T) -&gt; Bool<\/RelatedName>"
+          },
+          {
+            "key.annotated_decl" : "<RelatedName usr=\"s:ZFO6Result7NoErroroi2eeFTS0_S0__Sb\">==(_: NoError, _: NoError) -&gt; Bool<\/RelatedName>"
           }
         ],
         "key.bodyoffset" : 633,