Remove JVM specific API usage in common code

dewantawsif · dewantawsif · commit d25b04b2c3fe · 2025-07-22T00:51:46.000+06:00
Adding non-JVM targets will result in compilation failure
diff --git a/.gitignore b/.gitignore
@@ -38,3 +38,6 @@ local.properties
 *.iml
 .idea/
 captures/
+
+# Kotlin
+.kotlin/
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -1,6 +1,12 @@
 import org.jlleitschuh.gradle.ktlint.reporter.ReporterType
 
 plugins {
+  alias(libs.plugins.android.application) apply false
+  alias(libs.plugins.android.library) apply false
+  alias(libs.plugins.kotlin.android) apply false
+  alias(libs.plugins.kotlin.jvm) apply false
+  alias(libs.plugins.kotlin.multiplatform) apply false
+
   alias(libs.plugins.ktlint)
 }
 
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -1,5 +1,6 @@
 [versions]
 kotlin = "2.2.0"
+kotlinx-atomicfu = "0.29.0"
 androidGradlePlugin = "8.11.1"
 mavenPublish = "0.25.3"
 ktlint = "13.0.0"
@@ -11,6 +12,7 @@ dokka = "1.9.10"
 [libraries]
 kotlin-stdlib = { module = "org.jetbrains.kotlin:kotlin-stdlib", version.ref = "kotlin" }
 kotlin-test = { module = "org.jetbrains.kotlin:kotlin-test", version.ref = "kotlin" }
+kotlinx-atomicfu = { module = "org.jetbrains.kotlinx:atomicfu", version.ref = "kotlinx-atomicfu" }
 appcompat = { module = "androidx.appcompat:appcompat", version.ref = "appcompat" }
 truthish = { module = "com.varabyte.truthish:truthish", version.ref = "truthish" }
 
diff --git a/jvm-utils/.gitignore b/jvm-utils/.gitignore
@@ -0,0 +1 @@
+/build
diff --git a/jvm-utils/build.gradle.kts b/jvm-utils/build.gradle.kts
@@ -0,0 +1,15 @@
+plugins {
+  id("java-library")
+  alias(libs.plugins.kotlin.jvm)
+}
+
+java {
+  sourceCompatibility = JavaVersion.VERSION_1_8
+  targetCompatibility = JavaVersion.VERSION_1_8
+}
+
+kotlin {
+  compilerOptions {
+    jvmTarget = org.jetbrains.kotlin.gradle.dsl.JvmTarget.JVM_1_8
+  }
+}
diff --git a/jvm-utils/src/main/kotlin/logcat/utils.kt b/jvm-utils/src/main/kotlin/logcat/utils.kt
@@ -0,0 +1,24 @@
+package logcat
+
+import java.io.PrintWriter
+import java.io.StringWriter
+
+fun Throwable.customJvmStackTraceToString(): String {
+  val stringWriter = StringWriter(256)
+  val printWriter = PrintWriter(stringWriter, false)
+  printStackTrace(printWriter)
+  printWriter.flush()
+  return stringWriter.toString()
+}
+
+fun Any.jvmOuterClassSimpleName(): String {
+  val javaClass = this::class.java
+  val fullClassName = javaClass.name
+  val outerClassName = fullClassName.substringBefore('$')
+  val simplerOuterClassName = outerClassName.substringAfterLast('.')
+  return if (simplerOuterClassName.isEmpty()) {
+    fullClassName
+  } else {
+    simplerOuterClassName.removeSuffix("Kt")
+  }
+}
diff --git a/logcat/build.gradle.kts b/logcat/build.gradle.kts
@@ -1,11 +1,13 @@
+@file:Suppress("UnstableApiUsage")
+
 import com.vanniktech.maven.publish.JavadocJar
 import com.vanniktech.maven.publish.KotlinMultiplatform
 import com.vanniktech.maven.publish.SonatypeHost
 import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 
 plugins {
-  alias(libs.plugins.android.library)
   alias(libs.plugins.kotlin.multiplatform)
+  alias(libs.plugins.android.library)
   alias(libs.plugins.maven.publish)
   alias(libs.plugins.binary.compatibility.validator)
   alias(libs.plugins.dokka)
@@ -26,22 +28,38 @@ kotlin {
     }
   }
 
+  compilerOptions {
+    freeCompilerArgs.add("-Xexpect-actual-classes")
+  }
+
   sourceSets {
-    val commonMain by getting {
+    applyDefaultHierarchyTemplate()
+
+    commonMain {
       dependencies {
         implementation(libs.kotlin.stdlib)
+        implementation(libs.kotlinx.atomicfu)
       }
     }
-    
-    val commonTest by getting {
+
+    commonTest {
       dependencies {
         implementation(libs.kotlin.test)
         implementation(libs.truthish)
       }
     }
-    
-    val androidMain by getting
-    val jvmMain by getting
+
+    androidMain {
+      dependencies {
+        implementation(project(":jvm-utils"))
+      }
+    }
+
+    jvmMain {
+      dependencies {
+        implementation(project(":jvm-utils"))
+      }
+    }
   }
 }
 
diff --git a/logcat/src/androidMain/kotlin/logcat/BackwardCompatLogcat.android.kt b/logcat/src/androidMain/kotlin/logcat/BackwardCompatLogcat.android.kt
@@ -0,0 +1,8 @@
+@file:JvmName("LogcatKt")
+
+package logcat
+
+import kotlin.jvm.JvmName
+
+@PublishedApi
+internal actual fun Any.outerClassSimpleNameInternalOnlyDoNotUseKThxBye(): String = jvmOuterClassSimpleName()
diff --git a/logcat/src/androidMain/kotlin/logcat/Throwables.android.kt b/logcat/src/androidMain/kotlin/logcat/Throwables.android.kt
@@ -0,0 +1,7 @@
+@file:JvmName("ThrowablesKt")
+
+package logcat
+
+import kotlin.jvm.JvmName
+
+actual fun Throwable.asLog(): String = customJvmStackTraceToString()
diff --git a/logcat/src/androidMain/kotlin/logcat/internal/copyOnWriteArrayList.android.kt b/logcat/src/androidMain/kotlin/logcat/internal/copyOnWriteArrayList.android.kt
@@ -0,0 +1,5 @@
+package logcat.internal
+
+import java.util.concurrent.CopyOnWriteArrayList
+
+internal actual fun <T> copyOnWriteArrayList(): MutableList<T> = CopyOnWriteArrayList()
diff --git a/logcat/src/commonMain/kotlin/logcat/BackwardCompatLogcat.kt b/logcat/src/commonMain/kotlin/logcat/BackwardCompatLogcat.kt
@@ -1,17 +1,5 @@
-@file:JvmName("LogcatKt")
-
 package logcat
 
 // Kept here for backward compat purposes
 @PublishedApi
-internal fun Any.outerClassSimpleNameInternalOnlyDoNotUseKThxBye(): String {
-  val javaClass = this::class.java
-  val fullClassName = javaClass.name
-  val outerClassName = fullClassName.substringBefore('$')
-  val simplerOuterClassName = outerClassName.substringAfterLast('.')
-  return if (simplerOuterClassName.isEmpty()) {
-    fullClassName
-  } else {
-    simplerOuterClassName.removeSuffix("Kt")
-  }
-}
+internal expect fun Any.outerClassSimpleNameInternalOnlyDoNotUseKThxBye(): String
diff --git a/logcat/src/commonMain/kotlin/logcat/Logcat.kt b/logcat/src/commonMain/kotlin/logcat/Logcat.kt
@@ -3,6 +3,7 @@
 package logcat
 
 import logcat.LogPriority.DEBUG
+import kotlin.jvm.JvmName
 
 /**
  * A tiny Kotlin API for cheap logging on top of Android's normal `Log` class.
diff --git a/logcat/src/commonMain/kotlin/logcat/LogcatLogger.kt b/logcat/src/commonMain/kotlin/logcat/LogcatLogger.kt
@@ -1,8 +1,12 @@
 package logcat
 
+import kotlinx.atomicfu.locks.SynchronizedObject
+import kotlinx.atomicfu.locks.synchronized
 import logcat.LogcatLogger.Companion.install
 import logcat.LogcatLogger.Companion.uninstall
-import java.util.concurrent.CopyOnWriteArrayList
+import logcat.internal.copyOnWriteArrayList
+import kotlin.concurrent.Volatile
+import kotlin.jvm.JvmStatic
 
 /**
  * Logger that [logcat] delegates to. Call [install] to install a new logger, the default is a
@@ -29,12 +33,12 @@ interface LogcatLogger {
 
   companion object {
     @JvmStatic
-    val loggers: MutableList<LogcatLogger> = CopyOnWriteArrayList()
+    val loggers: MutableList<LogcatLogger> = copyOnWriteArrayList()
 
     @Volatile
     private var installedThrowable: Throwable? = null
 
-    private val installLock = Any()
+    private val installLock = SynchronizedObject()
 
     @JvmStatic
     val isInstalled: Boolean
diff --git a/logcat/src/commonMain/kotlin/logcat/Throwables.kt b/logcat/src/commonMain/kotlin/logcat/Throwables.kt
@@ -1,20 +1,10 @@
 package logcat
 
-import java.io.PrintWriter
-import java.io.StringWriter
-
 /**
- * Utility to turn a [Throwable] into a loggable string.
+ * Converts a [Throwable] into a loggable string representation.
  *
- * The implementation is based on Timber.getStackTraceString(). It's different
- * from [android.util.Log.getStackTraceString] in the following ways:
- * - No silent swallowing of UnknownHostException.
- * - The buffer size is 256 bytes instead of the default 16 bytes.
+ * On non-JVM platforms, this function delegates to [kotlin.stackTraceToString].
+ * On the JVM, it mimics the behavior of [kotlin.stackTraceToString] but uses a larger
+ * buffer (256 bytes instead of the default 16) in the internal `StringWriter` for better performance.
  */
-fun Throwable.asLog(): String {
-  val stringWriter = StringWriter(256)
-  val printWriter = PrintWriter(stringWriter, false)
-  printStackTrace(printWriter)
-  printWriter.flush()
-  return stringWriter.toString()
-}
+expect fun Throwable.asLog(): String
diff --git a/logcat/src/commonMain/kotlin/logcat/internal/copyOnWriteArrayList.kt b/logcat/src/commonMain/kotlin/logcat/internal/copyOnWriteArrayList.kt
@@ -0,0 +1,4 @@
+package logcat.internal
+
+
+internal expect fun <T> copyOnWriteArrayList(): MutableList<T>
diff --git a/logcat/src/jvmMain/kotlin/logcat/BackwardCompatLogcat.jvm.kt b/logcat/src/jvmMain/kotlin/logcat/BackwardCompatLogcat.jvm.kt
@@ -0,0 +1,8 @@
+@file:JvmName("LogcatKt")
+
+package logcat
+
+import kotlin.jvm.JvmName
+
+@PublishedApi
+internal actual fun Any.outerClassSimpleNameInternalOnlyDoNotUseKThxBye(): String = jvmOuterClassSimpleName()
diff --git a/logcat/src/jvmMain/kotlin/logcat/Throwables.jvm.kt b/logcat/src/jvmMain/kotlin/logcat/Throwables.jvm.kt
@@ -0,0 +1,7 @@
+@file:JvmName("ThrowablesKt")
+
+package logcat
+
+import kotlin.jvm.JvmName
+
+actual fun Throwable.asLog() = customJvmStackTraceToString()
diff --git a/logcat/src/jvmMain/kotlin/logcat/internal/copyOnWriteArrayList.jvm.kt b/logcat/src/jvmMain/kotlin/logcat/internal/copyOnWriteArrayList.jvm.kt
@@ -0,0 +1,5 @@
+package logcat.internal
+
+import java.util.concurrent.CopyOnWriteArrayList
+
+internal actual fun <T> copyOnWriteArrayList(): MutableList<T> = CopyOnWriteArrayList()
diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -17,7 +17,8 @@ dependencyResolutionManagement {
 }
 
 include(
-    ":logcat",
-    ":sample",
-    ":sample-jvm"
+  ":jvm-utils",
+  ":logcat",
+  ":sample",
+  ":sample-jvm"
 )
