Enable explicit api mode (#534)

* Enable explicit API mode and deprecate unintentionally public API
* Cleanup some compilation warnings

Author: fzhinkin

atomicfu/api/atomicfu.klib.api

@@ -1,8 +1,6 @@
 // Klib ABI Dump
 // Targets: [androidNativeArm32, androidNativeArm64, androidNativeX64, androidNativeX86, iosArm64, iosSimulatorArm64, iosX64, js, linuxArm32Hfp, linuxArm64, linuxX64, macosArm64, macosX64, mingwX64, tvosArm64, tvosSimulatorArm64, tvosX64, wasmJs, wasmWasi, watchosArm32, watchosArm64, watchosDeviceArm64, watchosSimulatorArm64, watchosX64]
 // Alias: native => [androidNativeArm32, androidNativeArm64, androidNativeX64, androidNativeX86, iosArm64, iosSimulatorArm64, iosX64, linuxArm32Hfp, linuxArm64, linuxX64, macosArm64, macosX64, mingwX64, tvosArm64, tvosSimulatorArm64, tvosX64, watchosArm32, watchosArm64, watchosDeviceArm64, watchosSimulatorArm64, watchosX64]
-// Alias: androidNative => [androidNativeArm32, androidNativeArm64, androidNativeX64, androidNativeX86]
-// Alias: apple => [iosArm64, iosSimulatorArm64, iosX64, macosArm64, macosX64, tvosArm64, tvosSimulatorArm64, tvosX64, watchosArm32, watchosArm64, watchosDeviceArm64, watchosSimulatorArm64, watchosX64]
 // Rendering settings:
 // - Signature version: 2
 // - Show manifest properties: true
@@ -303,10 +301,6 @@ open annotation class kotlinx.atomicfu.locks/ExperimentalThreadBlockingApi : kot
 final class kotlinx.atomicfu.locks/NativeMutexNode { // kotlinx.atomicfu.locks/NativeMutexNode|null[0]
     constructor <init>() // kotlinx.atomicfu.locks/NativeMutexNode.<init>|<init>(){}[0]
 
-    final var next // kotlinx.atomicfu.locks/NativeMutexNode.next|{}next[0]
-        final fun <get-next>(): kotlinx.atomicfu.locks/NativeMutexNode? // kotlinx.atomicfu.locks/NativeMutexNode.next.<get-next>|<get-next>(){}[0]
-        final fun <set-next>(kotlinx.atomicfu.locks/NativeMutexNode?) // kotlinx.atomicfu.locks/NativeMutexNode.next.<set-next>|<set-next>(kotlinx.atomicfu.locks.NativeMutexNode?){}[0]
-
     final fun lock() // kotlinx.atomicfu.locks/NativeMutexNode.lock|lock(){}[0]
     final fun unlock() // kotlinx.atomicfu.locks/NativeMutexNode.unlock|unlock(){}[0]
 }
@@ -340,12 +334,6 @@ final inline fun <#A: kotlin/Any?> (kotlinx.atomicfu.locks/SynchronizedObject).k
 // Targets: [native]
 final inline fun <#A: kotlin/Any?> kotlinx.atomicfu.locks/synchronized(kotlinx.atomicfu.locks/SynchronizedObject, kotlin/Function0<#A>): #A // kotlinx.atomicfu.locks/synchronized|synchronized(kotlinx.atomicfu.locks.SynchronizedObject;kotlin.Function0<0:0>){0§<kotlin.Any?>}[0]
 
-// Targets: [apple]
-final fun kotlinx.atomicfu.locks/pthreadCondAttrSetClock(kotlinx.cinterop/CPointer<platform.posix/_opaque_pthread_condattr_t>): kotlin/Int // kotlinx.atomicfu.locks/pthreadCondAttrSetClock|pthreadCondAttrSetClock(kotlinx.cinterop.CPointer<platform.posix._opaque_pthread_condattr_t>){}[0]
-
-// Targets: [androidNative, mingwX64]
-final fun kotlinx.atomicfu.locks/createThreadId(): kotlin/Long // kotlinx.atomicfu.locks/createThreadId|createThreadId(){}[0]
-
 // Targets: [js, wasmJs, wasmWasi]
 final class kotlinx.atomicfu.locks/ReentrantLock { // kotlinx.atomicfu.locks/ReentrantLock|null[0]
     constructor <init>() // kotlinx.atomicfu.locks/ReentrantLock.<init>|<init>(){}[0]

atomicfu/build.gradle.kts

@@ -146,6 +146,12 @@ kotlin {
             }
         }
     }
+
+    explicitApi()
+    compilerOptions {
+        freeCompilerArgs.add("-Xexpect-actual-classes")
+        freeCompilerArgs.add("-Xdont-warn-on-error-suppression")
+    }
 }
 
 val transformer: Configuration by configurations.creating

atomicfu/src/androidNativeMain/kotlin/kotlinx/atomicfu/locks/NativeMutexNode.kt

@@ -12,8 +12,8 @@ import kotlinx.cinterop.ptr
 import platform.posix.*
 
 @OptIn(ExperimentalForeignApi::class, UnsafeNumber::class)
-actual class NativeMutexNode {
-    actual var next: NativeMutexNode? = null
+public actual class NativeMutexNode {
+    internal actual var next: NativeMutexNode? = null
 
     private val arena: Arena = Arena()
     private val cond: pthread_cond_t = arena.alloc()
@@ -28,11 +28,11 @@ actual class NativeMutexNode {
         require(pthread_mutex_init(mutex.ptr, attr.ptr) == 0)
     }
 
-    actual fun lock() {
+    public actual fun lock() {
         pthread_mutex_lock(mutex.ptr)
     }
 
-    actual fun unlock() {
+    public actual fun unlock() {
         pthread_mutex_unlock(mutex.ptr)
     }
 
@@ -54,4 +54,4 @@ actual class NativeMutexNode {
 
 private val threadCounter = atomic(0L)
 
-actual fun createThreadId(): Long = threadCounter.incrementAndGet()
+internal actual fun createThreadId(): Long = threadCounter.incrementAndGet()

atomicfu/src/appleMain/kotlin/kotlinx/atomicfu/locks/NativeMutexNode.kt

@@ -34,8 +34,8 @@ import platform.posix.qos_class_self
 import platform.posix.PTHREAD_MUTEX_ERRORCHECK
 
 @OptIn(ExperimentalForeignApi::class)
-actual class NativeMutexNode {
-    actual var next: NativeMutexNode? = null
+public actual class NativeMutexNode {
+    internal actual var next: NativeMutexNode? = null
 
     private val arena: Arena = Arena()
     private val cond: pthread_cond_t = arena.alloc()
@@ -55,11 +55,11 @@ actual class NativeMutexNode {
         require(pthread_mutex_init(mutex.ptr, attr.ptr) == 0)
     }
 
-    actual fun lock() {
+    public actual fun lock() {
         pthread_mutex_lock(mutex.ptr)
     }
 
-    actual fun unlock() {
+    public actual fun unlock() {
         pthread_mutex_unlock(mutex.ptr)
     }
 

atomicfu/src/appleMain/kotlin/kotlinx/atomicfu/locks/PosixParkingDelegator.kt

@@ -10,4 +10,4 @@ import platform.posix.*
 internal actual val posixGetTimeClockId: Int
     get() = CLOCK_REALTIME
 
-actual fun pthreadCondAttrSetClock(attr: CPointer<pthread_condattr_t>): Int = 0
+internal actual fun pthreadCondAttrSetClock(attr: CPointer<pthread_condattr_t>): Int = 0

atomicfu/src/commonMain/kotlin/kotlinx/atomicfu/AtomicFU.common.kt

@@ -109,6 +109,7 @@ public expect fun atomic(initial: Boolean): AtomicBoolean
 /**
  * Creates array of AtomicRef<T> of specified size, where each element is initialised with null value
  */
+@Suppress("DEPRECATION")
 @OptionalJsName(ATOMIC_ARRAY_OF_NULLS)
 public fun <T> atomicArrayOfNulls(size: Int): AtomicArray<T?> = AtomicArray(size)
 
@@ -507,7 +508,7 @@ public inline fun AtomicLong.updateAndGet(function: (Long) -> Long): Long {
 /**
  * Creates a new array of AtomicInt values of the specified size, where each element is initialised with 0
  */
-@OptionalJsName(ATOMIC_INT_ARRAY)
+@Suppress("DEPRECATION") @OptionalJsName(ATOMIC_INT_ARRAY)
 public class AtomicIntArray(size: Int) {
     private val array = Array(size) { atomic(0) }
 
@@ -524,7 +525,7 @@ public class AtomicIntArray(size: Int) {
 /**
  * Creates a new array of AtomicLong values of the specified size, where each element is initialised with 0L
  */
-@OptionalJsName(ATOMIC_LONG_ARRAY)
+@Suppress("DEPRECATION") @OptionalJsName(ATOMIC_LONG_ARRAY)
 public class AtomicLongArray(size: Int) {
     private val array = Array(size) { atomic(0L) }
 
@@ -541,7 +542,7 @@ public class AtomicLongArray(size: Int) {
 /**
  * Creates a new array of AtomicBoolean values of the specified size, where each element is initialised with false
  */
-@OptionalJsName(ATOMIC_BOOLEAN_ARRAY)
+@Suppress("DEPRECATION") @OptionalJsName(ATOMIC_BOOLEAN_ARRAY)
 public class AtomicBooleanArray(size: Int) {
     private val array = Array(size) { atomic(false) }
 
@@ -556,7 +557,7 @@ public class AtomicBooleanArray(size: Int) {
 
 // ==================================== AtomicArray ====================================
 
-@OptionalJsName(ATOMIC_REF_ARRAY)
+@Suppress("DEPRECATION") @OptionalJsName(ATOMIC_REF_ARRAY)
 public class AtomicArray<T> internal constructor(size: Int) {
     private val array = Array(size) { atomic<T?>(null) }
 

atomicfu/src/commonMain/kotlin/kotlinx/atomicfu/OptionalJsName.kt

@@ -14,4 +14,5 @@ package kotlinx.atomicfu
     AnnotationTarget.PROPERTY_GETTER,
     AnnotationTarget.PROPERTY_SETTER
 )
-expect annotation class OptionalJsName(val name: String)
+@Deprecated("The annotation was intended for internal use only and will be hidden in the future release.")
+public expect annotation class OptionalJsName(val name: String)

atomicfu/src/commonMain/kotlin/kotlinx/atomicfu/Trace.common.kt

@@ -65,7 +65,7 @@ public expect val traceFormatDefault: TraceFormat
 /**
  * Base class for implementations of `Trace`.
  */
-@OptionalJsName(TRACE_BASE_CONSTRUCTOR)
+@Suppress("DEPRECATION") @OptionalJsName(TRACE_BASE_CONSTRUCTOR)
 public open class TraceBase internal constructor() {
     /**
      * Accepts the logging [event] and appends it to the trace.
@@ -103,4 +103,4 @@ public open class TraceBase internal constructor() {
      * NOP tracing.
      */
     public object None : TraceBase()
-}
+}

atomicfu/src/commonMain/kotlin/kotlinx/atomicfu/TraceFormat.kt

@@ -12,11 +12,13 @@ import kotlin.js.JsName
 /**
  * Trace string formatter.
  */
+@Suppress("DEPRECATION")
 @OptionalJsName(TRACE_FORMAT_CLASS)
 public open class TraceFormat {
     /**
      * Formats trace at the given [index] with the given [event] of Any type.
      */
+    @Suppress("DEPRECATION")
     @OptionalJsName(TRACE_FORMAT_FORMAT_FUNCTION)
     public open fun format(index: Int, event: Any): String = "$index: $event"
 }
@@ -28,4 +30,4 @@ public open class TraceFormat {
 public inline fun TraceFormat(crossinline format: (index: Int, event: Any) -> String): TraceFormat =
     object : TraceFormat() {
         override fun format(index: Int, event: Any): String = format(index, event)
-    }
+    }

atomicfu/src/commonMain/kotlin/kotlinx/atomicfu/locks/Synchronized.common.kt

@@ -9,9 +9,9 @@ public expect open class SynchronizedObject() // marker abstract class
 public expect fun reentrantLock(): ReentrantLock
 
 public expect class ReentrantLock() {
-    fun lock(): Unit
-    fun tryLock(): Boolean
-    fun unlock(): Unit
+    public fun lock(): Unit
+    public fun tryLock(): Boolean
+    public fun unlock(): Unit
 }
 
 public expect inline fun <T> ReentrantLock.withLock(block: () -> T): T

atomicfu/src/concurrentMain/kotlin/kotlinx/atomicfu/locks/ParkingSupport.kt

@@ -41,7 +41,7 @@ import kotlin.time.TimeMark
  * it is advised to use a higher level concurrency API like `kotlinx.coroutines`
  */
 @ExperimentalThreadBlockingApi
-expect object ParkingSupport {
+public expect object ParkingSupport {
 
     /**
      * Parks the current thread for [timeout] duration.
@@ -53,7 +53,7 @@ expect object ParkingSupport {
      * - (Only on JVM) The thread was interrupted. The interrupted flag stays set after wakeup.
      * A future call to [park] this thread will return immediately, unless the `Thread.interrupted` flag is cleared.
      */
-    fun park(timeout: Duration)
+    public fun park(timeout: Duration)
 
     /**
      * Parks the current thread until [deadline] is reached.
@@ -65,7 +65,7 @@ expect object ParkingSupport {
      * - (Only on JVM) The thread was interrupted. The interrupted flag stays set after wakeup.
      * A future call to [park] this thread will return immediately, unless the `Thread.interrupted` flag is cleared.
      */
-    fun parkUntil(deadline: TimeMark)
+    public fun parkUntil(deadline: TimeMark)
 
     /**
      * Unparks the thread corresponding to [handle].
@@ -76,7 +76,7 @@ expect object ParkingSupport {
      * Meaning, when two consecutive [unpark] calls are made while the corresponding thread is not parked,
      * only the next park call will return immediately — [unpark] calls are not accumulated.
      */
-    fun unpark(handle: ParkingHandle)
+    public fun unpark(handle: ParkingHandle)
 
     /**
      * Returns the [ParkingHandle] corresponding to the current thread.
@@ -89,7 +89,7 @@ expect object ParkingSupport {
      * Note: this function returns a different [ParkingHandle] for each thread.
      * Therefore, caching a single parking handle for multiple threads will lead to unexpected behaviour.
      */
-    fun currentThreadHandle(): ParkingHandle
+    public fun currentThreadHandle(): ParkingHandle
 }
 
 /**
@@ -100,7 +100,7 @@ expect object ParkingSupport {
  * on how to use [ParkingHandle] and how parking works in general.
  */
 @ExperimentalThreadBlockingApi
-expect class ParkingHandle
+public expect class ParkingHandle
 
 /**
  * Marks [ParkingHandle] and [ParkingSupport] API as experimental.