Add parseDeclarationInterfaceNode to parse all declaration contexts

intitni · intitni · commit b17d28252c7a · 2023-11-27T16:30:11.000+08:00
diff --git a/Tool/Sources/FocusedCodeFinder/ObjectiveC/ObjectiveCCodeFinder.swift b/Tool/Sources/FocusedCodeFinder/ObjectiveC/ObjectiveCCodeFinder.swift
@@ -71,11 +71,11 @@ public class ObjectiveCFocusedCodeFinder: KnownLanguageFocusedCodeFinder<
     ) -> NodeInfo? {
         switch ObjectiveCNodeType(rawValue: node.nodeType ?? "") {
         case .classInterface, .categoryInterface:
-            return parseClassInterfaceNode(node, textProvider: textProvider)
+            return parseDeclarationInterfaceNode(node, textProvider: textProvider)
         case .classImplementation, .categoryImplementation:
-            return parseClassImplementationNode(node, textProvider: textProvider)
+            return parseDeclarationInterfaceNode(node, textProvider: textProvider)
         case .protocolDeclaration:
-            return parseProtocolNode(node, textProvider: textProvider)
+            return parseDeclarationInterfaceNode(node, textProvider: textProvider)
         case .methodDefinition:
             return parseMethodDefinitionNode(node, textProvider: textProvider)
         case .functionDefinition:
@@ -89,16 +89,23 @@ public class ObjectiveCFocusedCodeFinder: KnownLanguageFocusedCodeFinder<
         }
     }
 
-    func parseClassInterfaceNode(
+    func parseDeclarationInterfaceNode(
         _ node: ASTNode,
         textProvider: @escaping TextProvider
     ) -> NodeInfo? {
         var name = ""
-        var superClass = ""
         var category = ""
-        var protocols = [String]()
+        /// Attributes, declaration kind, and name.
+        var prefix = ""
+        /// Generics, super class, etc.
+        var extra = ""
+        
         if let nameNode = node.child(byFieldName: "name") {
             name = textProvider(.node(nameNode))
+            prefix = textProvider(.range(
+                range: node.range.notSurpassing(nameNode.range),
+                pointRange: node.pointRange.notSurpassing(nameNode.pointRange)
+            ))
         }
         if let categoryNode = node.child(byFieldName: "category") {
             category = textProvider(.node(categoryNode))
@@ -107,135 +114,45 @@ public class ObjectiveCFocusedCodeFinder: KnownLanguageFocusedCodeFinder<
         for i in 0..<node.childCount {
             guard let childNode = node.child(at: i) else { continue }
             switch ObjectiveCNodeType(rawValue: childNode.nodeType) {
-            case .protocolQualifiers:
-                var protocolNames = [String]()
-                for j in 0..<childNode.childCount {
-                    guard let protocolNode = childNode.child(at: j) else { continue }
-                    guard ObjectiveCNodeType(rawValue: protocolNode.nodeType) == .identifier
-                    else { continue }
-                    protocolNames.append(
-                        textProvider(.node(protocolNode))
-                            .trimmingCharacters(in: .whitespacesAndNewlines)
-                    )
+            case .superclassReference,
+                 .protocolQualifiers,
+                 .parameterizedClassTypeArguments:
+                extra.append(textProvider(.node(childNode)))
+            case .genericsTypeReference:
+                // When it's a category of a generic type, e.g.
+                // @interface __GENERICS(NSArray, ObjectType) (BlocksKit)
+                if let nameNode = childNode.child(byFieldName: "name") {
+                    name = textProvider(.node(nameNode))
                 }
-                protocols = protocolNames.filter { $0 != "," && !$0.isEmpty }
-            case .superclassReference:
-                if let superClassNode = childNode.child(byFieldName: "name") {
-                    superClass = textProvider(.node(superClassNode))
-                        .trimmingCharacters(in: .whitespacesAndNewlines)
-                }
-            default:
-                continue
+                prefix = textProvider(.range(
+                    range: node.range.notSurpassing(childNode.range),
+                    pointRange: node.pointRange.notSurpassing(childNode.pointRange)
+                ))
+            default: continue
             }
         }
 
-        var signature = "@interface \(name)"
-        if !category.isEmpty {
-            signature += " (\(category))"
-        }
-        if !protocols.isEmpty {
-            signature += "<\(protocols.joined(separator: ", "))>"
-        }
-        if !superClass.isEmpty {
-            signature += ": \(superClass)"
-        }
-
-        return .init(
-            node: node,
-            signature: signature,
-            name: name,
-            canBeUsedAsCodeRange: true
-        )
-    }
-
-    func parseClassImplementationNode(
-        _ node: ASTNode,
-        textProvider: @escaping TextProvider
-    ) -> NodeInfo? {
-        var name = ""
-        var superClass = ""
-        var category = ""
-        var protocols = [String]()
-        if let nameNode = node.child(byFieldName: "name") {
-            name = textProvider(.node(nameNode))
-        }
-        if let categoryNode = node.child(byFieldName: "category") {
-            category = textProvider(.node(categoryNode))
-        }
-
-        for i in 0..<node.childCount {
-            guard let childNode = node.child(at: i) else { continue }
-            switch ObjectiveCNodeType(rawValue: childNode.nodeType) {
-            case .protocolQualifiers:
-                var protocolNames = [String]()
-                for j in 0..<childNode.childCount {
-                    guard let protocolNode = childNode.child(at: j) else { continue }
-                    guard ObjectiveCNodeType(rawValue: protocolNode.nodeType) == .identifier
-                    else { continue }
-                    protocolNames.append(
-                        textProvider(.node(protocolNode))
-                            .trimmingCharacters(in: .whitespacesAndNewlines)
-                    )
-                }
-                protocols = protocolNames.filter { $0 != "," && !$0.isEmpty }
-            case .superclassReference:
-                if let superClassNode = childNode.child(byFieldName: "name") {
-                    superClass = textProvider(.node(superClassNode))
-                        .trimmingCharacters(in: .whitespacesAndNewlines)
-                }
-            default:
-                continue
-            }
-        }
+        prefix = prefix.split(separator: "\n")
+            .joined(separator: " ")
+            .trimmingCharacters(in: .whitespacesAndNewlines)
+        
+        extra = extra.split(separator: "\n")
+            .joined(separator: " ")
+            .trimmingCharacters(in: .whitespacesAndNewlines)
 
-        var signature = "@implementation \(name)"
+        var signature = "\(prefix)\(extra)"
         if !category.isEmpty {
             signature += " (\(category))"
         }
-        if !protocols.isEmpty {
-            signature += "<\(protocols.joined(separator: ", "))>"
-        }
-        if !superClass.isEmpty {
-            signature += ": \(superClass)"
-        }
-        return .init(
-            node: node,
-            signature: signature,
-            name: name,
-            canBeUsedAsCodeRange: true
-        )
-    }
 
-    func parseProtocolNode(
-        _ node: ASTNode,
-        textProvider: @escaping TextProvider
-    ) -> NodeInfo? {
-        var name = ""
-        var protocols = [String]()
-        if let nameNode = node.child(byFieldName: "name") {
-            name = textProvider(.node(nameNode))
-        }
-        if let protocolsNode = node.child(byFieldName: "protocols") {
-            for protocolNode in protocolsNode.children {
-                let protocolName = textProvider(.node(protocolNode))
-                if !protocolName.isEmpty {
-                    protocols.append(protocolName)
-                }
-            }
-        }
-
-        var signature = "@protocol \(name)"
-        if !protocols.isEmpty {
-            signature += "<\(protocols.joined(separator: ","))>"
-        }
         return .init(
             node: node,
             signature: signature,
             name: name,
             canBeUsedAsCodeRange: true
         )
     }
-
+    
     func parseMethodDefinitionNode(
         _ node: ASTNode,
         textProvider: @escaping TextProvider
@@ -273,7 +190,7 @@ public class ObjectiveCFocusedCodeFinder: KnownLanguageFocusedCodeFinder<
             signaturePointRange
         ) = node.extractInformationBeforeNode(withFieldName: "body")
         let signature = textProvider(.range(range: signatureRange, pointRange: signaturePointRange))
-            .replacingOccurrences(of: "\n", with: "")
+            .replacingOccurrences(of: "\n", with: " ")
             .trimmingCharacters(in: .whitespacesAndNewlines)
         if signature.isEmpty { return nil }
         return .init(
@@ -342,6 +259,12 @@ extension NSRange {
         let end = Swift.max(lowerBound, Swift.min(upperBound, range.lowerBound))
         return NSRange(location: start, length: end - start)
     }
+
+    func notSurpassing(_ range: NSRange) -> NSRange {
+        let start = lowerBound
+        let end = Swift.max(lowerBound, Swift.min(upperBound, range.upperBound))
+        return NSRange(location: start, length: end - start)
+    }
 }
 
 extension Range where Bound == Point {
@@ -354,5 +277,15 @@ extension Range where Bound == Point {
         }
         return Range(uncheckedBounds: (start, end))
     }
+
+    func notSurpassing(_ range: Range<Bound>) -> Range<Bound> {
+        let start = lowerBound
+        let end = if range.lowerBound >= upperBound {
+            upperBound
+        } else {
+            Swift.max(range.upperBound, lowerBound)
+        }
+        return Range(uncheckedBounds: (start, end))
+    }
 }
 
diff --git a/Tool/Sources/FocusedCodeFinder/ObjectiveC/ObjectiveCSyntax.swift b/Tool/Sources/FocusedCodeFinder/ObjectiveC/ObjectiveCSyntax.swift
@@ -1,9 +1,10 @@
 import Foundation
 
-/// https://github.com/merico-dev/tree-sitter-objc/test/corpus/imports.txt
-/// https://github.com/merico-dev/tree-sitter-objc/test/corpus/expressions.txt
-/// https://github.com/merico-dev/tree-sitter-objc/test/corpus/declarations.txt
-/// https://github.com/merico-dev/tree-sitter-objc/node-types.json
+/// https://github.com/lukepistrol/tree-sitter-objc/blob/feature/spm/test/corpus/imports.txt
+/// https://github.com/lukepistrol/tree-sitter-objc/blob/feature/spm/test/corpus/expressions.txt
+/// https://github.com/lukepistrol/tree-sitter-objc/blob/feature/spm/test/corpus/declarations.txt
+/// https://github.com/lukepistrol/tree-sitter-objc/blob/feature/spm/node-types.json
+/// Some of the test cases are actually incorrect?
 enum ObjectiveCNodeType: String {
     /// The top most item
     case translationUnit = "translation_unit"
@@ -22,26 +23,6 @@ enum ObjectiveCNodeType: String {
     /// + (tr)k1:(t1)a1 : (t2)a2 k2: a3;
     /// @end
     /// ```
-    ///
-    /// will parse into:
-    /// ```
-    /// (translation_unit
-    ///   (class_interface
-    ///     name: (identifier)
-    ///     superclass: (identifier)))              < SuperClass
-    ///     protocols: (protocol_reference_list     < Protocols
-    ///       (identifier)
-    ///       (identifier))))
-    ///     (field_declaration                      < iv1
-    ///       type: (type_identifier)
-    ///       declarator: (field_identifier))
-    ///     (field_declaration                      < iv2
-    ///       type: (type_identifier)
-    ///       declarator: (field_identifier))))
-    ///     (property_declaration ...)              < property value
-    ///     (method_declaration ...)                < method
-    /// ```
-    ///
     case classInterface = "class_interface"
     /// `@implementation`
     case classImplementation = "class_implementation"
@@ -56,52 +37,14 @@ enum ObjectiveCNodeType: String {
     /// ```objc
     /// @class C1, C2;
     /// ```
-    ///
-    /// will parse into:
-    /// ```
-    /// (translation_unit
-    ///   (class_declaration_list
-    ///     (identifier)
-    ///     (identifier)))
-    /// ```
     case classDeclarationList = "class_declaration_list"
     /// ```
     /// + (tr)k1: (t1)a1 : (t2)a2 k2: a3;
     /// ```
-    ///
-    /// will parse into:
-    /// ```
-    /// (property_declaration
-    ///   (readwrite)
-    ///   (copy)
-    ///   type: (type_identifier)                   < type
-    ///   name: (identifier))))                     < name
-    /// ```
     case propertyDeclaration = "property_declaration"
     /// ```objc
     /// + (tr)k1: (t1)a1 : (t2)a2 k2: a3;
     /// ```
-    ///
-    /// will parse into:
-    /// ```
-    /// (method_declaration
-    ///   scope: (class_scope)
-    ///   return_type: (type_descriptor
-    ///   type: (type_identifier))
-    ///   selector: (keyword_selector
-    ///   (keyword_declarator
-    ///       keyword: (identifier)
-    ///       type: (type_descriptor
-    ///           type: (type_identifier))
-    ///       name: (identifier))
-    ///   (keyword_declarator
-    ///       type: (type_descriptor
-    ///           type: (type_identifier))
-    ///       name: (identifier))
-    ///   (keyword_declarator
-    ///       keyword: (identifier)
-    ///       name: (identifier))))))
-    /// ```
     case methodDeclaration = "method_declaration"
     /// `- (rt)sel {}`
     case methodDefinition = "method_definition"
@@ -127,6 +70,12 @@ enum ObjectiveCNodeType: String {
     case protocolQualifiers = "protocol_qualifiers"
     /// Superclass of a type.
     case superclassReference = "superclass_reference"
+    /// The generic type arguments.
+    case parameterizedClassTypeArguments = "parameterized_class_type_arguments"
+    /// `__GENERICS` in category interface and implementation.
+    case genericsTypeReference = "generics_type_reference"
+    /// `IB_DESIGNABLE`, etc. The typo is from the original source.
+    case classInterfaceAttributeSpecifier = "class_interface_attribute_sepcifier"
 }
 
 extension ObjectiveCNodeType {
diff --git a/Tool/Tests/FocusedCodeFinderTests/ObjectiveCFocusedCodeFinderTests.swift b/Tool/Tests/FocusedCodeFinderTests/ObjectiveCFocusedCodeFinderTests.swift
