Allow using categories in the def file to reintroduce methods in the class

^KT-71624

Author: timofey-solonin

kotlin-native/Interop/Indexer/src/main/kotlin/org/jetbrains/kotlin/native/interop/indexer/Indexer.kt

@@ -447,7 +447,10 @@ public open class NativeIndexImpl(val library: NativeLibrary, val verbose: Boole
                 val categoryClassName = clang_getCursorDisplayName(categoryClassCursor).convertAndDispose()
                 if (className == categoryClassName) {
                     val categoryFile = getContainingFile(childCursor)
-                    if (clang_File_isEqual(categoryFile, classFile) != 0) {
+                    val isCategoryInTheSameFileAsClass = clang_File_isEqual(categoryFile, classFile) != 0
+                    val isCategoryFromDefFile = library.allowIncludingObjCCategoriesFromDefFile
+                            && clang_Location_isFromMainFile(clang_getCursorLocation(childCursor)) != 0
+                    if (isCategoryInTheSameFileAsClass || isCategoryFromDefFile) {
                         result += childCursor
                     }
                 }

kotlin-native/Interop/Indexer/src/main/kotlin/org/jetbrains/kotlin/native/interop/indexer/NativeIndex.kt

@@ -116,6 +116,7 @@ data class NativeLibrary(
         val headerExclusionPolicy: HeaderExclusionPolicy,
         val headerFilter: NativeLibraryHeaderFilter,
         val objCClassesIncludingCategories: Set<String>,
+        val allowIncludingObjCCategoriesFromDefFile: Boolean,
 ) : Compilation
 
 data class IndexerResult(val index: NativeIndex, val compilation: CompilationWithPCH)

kotlin-native/Interop/StubGenerator/src/org/jetbrains/kotlin/native/interop/gen/jvm/main.kt

@@ -595,7 +595,8 @@ internal fun buildNativeLibrary(
             excludeSystemLibs = excludeSystemLibs,
             headerExclusionPolicy = headerExclusionPolicy,
             headerFilter = headerFilter,
-            objCClassesIncludingCategories = objCClassesIncludingCategories
+            objCClassesIncludingCategories = objCClassesIncludingCategories,
+            allowIncludingObjCCategoriesFromDefFile = def.config.allowIncludingObjCCategoriesFromDefFile,
     )
 }
 

native/native.tests/testData/CInterop/frameworkIncludeCategories/cases/smoke5/contents.gold.txt

@@ -0,0 +1,45 @@
+library {
+  // module name: <dependency.def>
+
+  library fragment {
+    // package name: dependency
+
+    // class name: dependency/MyClass
+    // class name: dependency/MyClass.Companion
+    // class name: dependency/MyClassMeta
+    // class name: dependency/MyProtocolProtocol
+    // class name: dependency/MyProtocolProtocolMeta
+
+    @kotlinx/cinterop/ExternalObjCClass
+    public open class dependency/MyClass : kotlinx/cinterop/ObjCObjectBase {
+
+      protected /* secondary */ constructor()
+
+      // companion object: Companion
+
+      // nested class: Companion
+    }
+
+    public final companion object dependency/MyClass.Companion : dependency/MyClassMeta, kotlinx/cinterop/ObjCClassOf<dependency/MyClass> {
+
+      private constructor()
+    }
+
+    @kotlinx/cinterop/ExternalObjCClass
+    public open class dependency/MyClassMeta : kotlinx/cinterop/ObjCObjectBaseMeta {
+
+      protected /* secondary */ constructor()
+    }
+
+    @kotlinx/cinterop/ExternalObjCClass(protocolGetter = "kniprot_dependency0_MyProtocol")
+    public abstract interface dependency/MyProtocolProtocol : kotlinx/cinterop/ObjCObject {
+
+      @kotlinx/cinterop/ObjCMethod(selector = "wasInMyClass", encoding = "v16@0:8", isStret = false)
+      public abstract fun wasInMyClass(): kotlin/Unit
+    }
+
+    @kotlinx/cinterop/ExternalObjCClass(protocolGetter = "kniprot_dependency0_MyProtocol")
+    public abstract interface dependency/MyProtocolProtocolMeta : kotlinx/cinterop/ObjCClass /* = kotlinx/cinterop/ObjCObjectMeta^ */ {
+    }
+  }
+}

native/native.tests/testData/CInterop/frameworkIncludeCategories/cases/smoke5/dependency.def

@@ -0,0 +1,5 @@
+# In Apple frameworks methods are sometimes moved from class declaration into a protocol and the class conforms to the protocol in an extension
+# This is a binary incompatible change in cinterop klibs
+language = Objective-C
+modules=dependency4
+objcClassesIncludingCategories = MyClass

native/native.tests/testData/CInterop/frameworkIncludeCategories/cases/smoke6/contents.gold.txt

@@ -0,0 +1,55 @@
+library {
+  // module name: <dependency.def>
+
+  library fragment {
+    // package name: dependency
+
+    // class name: dependency/MyClass
+    // class name: dependency/MyClass.Companion
+    // class name: dependency/MyClassMeta
+    // class name: dependency/MyProtocolProtocol
+    // class name: dependency/MyProtocolProtocolMeta
+
+    @kotlinx/cinterop/ExternalObjCClass
+    public open class dependency/MyClass : kotlinx/cinterop/ObjCObjectBase {
+
+      protected /* secondary */ constructor()
+
+      @kotlinx/cinterop/ObjCMethod(selector = "wasInMyClass", encoding = "v16@0:8", isStret = false)
+      public open external fun wasInMyClass(): kotlin/Unit
+
+      // companion object: Companion
+
+      // nested class: Companion
+    }
+
+    public final companion object dependency/MyClass.Companion : dependency/MyClassMeta, kotlinx/cinterop/ObjCClassOf<dependency/MyClass> {
+
+      private constructor()
+    }
+
+    @kotlinx/cinterop/ExternalObjCClass
+    public open class dependency/MyClassMeta : kotlinx/cinterop/ObjCObjectBaseMeta {
+
+      protected /* secondary */ constructor()
+    }
+
+    @kotlinx/cinterop/ExternalObjCClass(protocolGetter = "kniprot_dependency0_MyProtocol")
+    public abstract interface dependency/MyProtocolProtocol : kotlinx/cinterop/ObjCObject {
+
+      @kotlinx/cinterop/ObjCMethod(selector = "wasInMyClass", encoding = "v16@0:8", isStret = false)
+      public abstract fun wasInMyClass(): kotlin/Unit
+    }
+
+    @kotlinx/cinterop/ExternalObjCClass(protocolGetter = "kniprot_dependency0_MyProtocol")
+    public abstract interface dependency/MyProtocolProtocolMeta : kotlinx/cinterop/ObjCClass /* = kotlinx/cinterop/ObjCObjectMeta^ */ {
+    }
+
+    package {
+
+      @kotlinx/cinterop/ObjCMethod(selector = "wasInMyClass", encoding = "v16@0:8", isStret = false)
+      @kotlin/Deprecated(message = "Use instance method instead", replaceWith = kotlin/ReplaceWith(imports = [], expression = ""), level = kotlin/DeprecationLevel.WARNING)
+      public final external fun dependency/MyClass.wasInMyClass(): kotlin/Unit
+    }
+  }
+}

native/native.tests/testData/CInterop/frameworkIncludeCategories/cases/smoke6/dependency.def

@@ -0,0 +1,9 @@
+# We use the category in the def file to add back the method
+language = Objective-C
+modules=dependency4
+objcClassesIncludingCategories = MyClass
+allowIncludingObjCCategoriesFromDefFile = true
+---
+@interface MyClass (K)
+-(void) wasInMyClass;
+@end

native/native.tests/testData/CInterop/frameworkIncludeCategories/dependency4.framework/Headers/dependency4.h

@@ -0,0 +1,9 @@
+@protocol MyProtocol
+-(void) wasInMyClass;
+@end
+
+@interface MyClass
+@end
+
+@interface MyClass () <MyProtocol>
+@end

native/native.tests/testData/CInterop/frameworkIncludeCategories/dependency4.framework/Modules/module.modulemap

@@ -0,0 +1,6 @@
+framework module dependency4 {
+  umbrella header "dependency4.h"
+
+  export *
+  module * { export * }
+}

native/native.tests/tests-gen/org/jetbrains/kotlin/konan/test/blackbox/CInteropIncludeCategoriesTestGenerated.java

@@ -140,6 +140,10 @@ class DefFile(val file:File?, val config:DefFileConfig, val manifestAddendProper
             properties.getSpaceSeparated("objcClassesIncludingCategories")
         }
 
+        val allowIncludingObjCCategoriesFromDefFile by lazy {
+            properties.getProperty("allowIncludingObjCCategoriesFromDefFile")?.toBoolean() ?: false
+        }
+
         val userSetupHint by lazy {
             properties.getProperty("userSetupHint")
         }