Add configuration to suppress name collision warnings.

touchlab · Nov 27, 2023 · 6933427 · 6933427
1 parent db900c8
commit 6933427
Show file tree

Hide file tree

Showing 4 changed files with 47 additions and 3 deletions.
diff --git a/SKIE/acceptance-tests b/SKIE/acceptance-tests
diff --git a/...s/src/commonMain/kotlin/co/touchlab/skie/configuration/annotations/SuppressSkieWarning.kt b/...s/src/commonMain/kotlin/co/touchlab/skie/configuration/annotations/SuppressSkieWarning.kt
@@ -0,0 +1,12 @@
+package co.touchlab.skie.configuration.annotations
+
+@Target
+annotation class SuppressSkieWarning {
+
+    /**
+     * Suppresses a warning about SKIE renaming a declaration because of a name collision.
+     */
+    @Target(AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY, AnnotationTarget.CONSTRUCTOR)
+    @Retention(AnnotationRetention.BINARY)
+    annotation class NameCollision(val suppress: Boolean = true)
+}
diff --git a/...n/declaration/src/commonMain/kotlin/co/touchlab/skie/configuration/SuppressSkieWarning.kt b/...n/declaration/src/commonMain/kotlin/co/touchlab/skie/configuration/SuppressSkieWarning.kt
@@ -0,0 +1,19 @@
+package co.touchlab.skie.configuration
+
+import co.touchlab.skie.configuration.annotations.SuppressSkieWarning
+
+object SuppressSkieWarning {
+
+    /**
+     * If true, SKIE will not raise a warning that it renamed the given declaration because of a name collision.
+     */
+    object NameCollision : ConfigurationKey.Boolean {
+
+        override val defaultValue: Boolean = false
+
+        override val skieRuntimeValue: Boolean = false
+
+        override fun getAnnotationValue(configurationTarget: ConfigurationTarget): Boolean? =
+            configurationTarget.findAnnotation<SuppressSkieWarning.NameCollision>()?.suppress
+    }
+}
diff --git a/...lin-plugin/src/kgp_common/kotlin/co/touchlab/skie/util/SirDeclaration+resolveCollision.kt b/...lin-plugin/src/kgp_common/kotlin/co/touchlab/skie/util/SirDeclaration+resolveCollision.kt
@@ -2,7 +2,10 @@
 
 package co.touchlab.skie.util
 
+import co.touchlab.skie.configuration.SuppressSkieWarning
+import co.touchlab.skie.configuration.getConfiguration
 import co.touchlab.skie.kir.element.KirCallableDeclaration
+import co.touchlab.skie.kir.element.KirClass
 import co.touchlab.skie.kir.element.KirElement
 import co.touchlab.skie.kir.element.KirEnumEntry
 import co.touchlab.skie.kir.element.classDescriptorOrNull
@@ -114,7 +117,7 @@ private inline fun <T, K : KirElement> T.resolveCollisionWithWarning(
     val newName = getName()
 
     val kirElement = findKirElement()
-    if (kirElement != null) {
+    if (kirElement != null && kirElement.shouldReportCollision) {
         reportCollision(
             originalName = originalName,
             newName = newName,
@@ -132,6 +135,15 @@ private inline fun <T> T.resolveCollision(collisionReasonProvider: T.() -> Strin
     } while (collisionReasonProvider() != null)
 }
 
+context(SirPhase.Context)
+private val KirElement.shouldReportCollision: Boolean
+    get() = when (this) {
+        is KirCallableDeclaration<*> -> !getConfiguration(SuppressSkieWarning.NameCollision)
+        is KirClass -> !getConfiguration(SuppressSkieWarning.NameCollision)
+        is KirEnumEntry -> owner.shouldReportCollision
+        else -> true
+    }
+
 context(SirPhase.Context)
 private fun reportCollision(
     originalName: String,
@@ -142,7 +154,8 @@ private fun reportCollision(
     reporter.warning(
         message = "'$originalName' was renamed to '$newName' because of a name collision with $collisionReason. " +
             "Consider resolving the conflict either by changing the name in Kotlin, or via the @ObjCName annotation. " +
-            "Using renamed declarations from Swift is not recommended because their name will change if the conflict is resolved.",
+            "You can also suppress this warning using the 'SuppressSkieWarning.NameCollision' configuration. " +
+            "However using renamed declarations from Swift is not recommended because their name will change if the conflict is resolved.",
         declaration = declarationDescriptor,
     )
 }