add javaMain module and remove duplication (#275)

javaMain is an abstraction for both jvm and android modules

Author: oshai

build.gradle.kts

@@ -90,7 +90,12 @@ kotlin {
                 implementation(kotlin("test-annotations-common"))
             }
         }
+        // common to jvm and android
+        val javaMain by creating {
+            dependsOn(commonMain)
+        }
         val jvmMain by getting {
+            dependsOn(javaMain)
             dependencies {
                 compileOnly("org.slf4j:slf4j-api:${extra["slf4j_version"]}")
             }
@@ -109,7 +114,9 @@ kotlin {
                 implementation("org.slf4j:jul-to-slf4j:${extra["slf4j_version"]}")
             }
         }
-        val androidMain by getting {}
+        val androidMain by getting {
+            dependsOn(javaMain)
+        }
         val androidTest by getting {
             dependencies {
                 implementation(kotlin("test"))

src/androidMain/kotlin/io/github/oshai/KLogger.kt

@@ -40,34 +40,34 @@ public actual interface KLogger {
   public actual fun error(t: Throwable?, msg: () -> Any?)
 
   /** Lazy add a log message if isTraceEnabled is true */
-  public actual fun trace(marker: io.github.oshai.Marker?, msg: () -> Any?)
+  public actual fun trace(marker: Marker?, msg: () -> Any?)
 
   /** Lazy add a log message if isDebugEnabled is true */
-  public actual fun debug(marker: io.github.oshai.Marker?, msg: () -> Any?)
+  public actual fun debug(marker: Marker?, msg: () -> Any?)
 
   /** Lazy add a log message if isInfoEnabled is true */
-  public actual fun info(marker: io.github.oshai.Marker?, msg: () -> Any?)
+  public actual fun info(marker: Marker?, msg: () -> Any?)
 
   /** Lazy add a log message if isWarnEnabled is true */
-  public actual fun warn(marker: io.github.oshai.Marker?, msg: () -> Any?)
+  public actual fun warn(marker: Marker?, msg: () -> Any?)
 
   /** Lazy add a log message if isErrorEnabled is true */
-  public actual fun error(marker: io.github.oshai.Marker?, msg: () -> Any?)
+  public actual fun error(marker: Marker?, msg: () -> Any?)
 
   /** Lazy add a log message with throwable payload if isTraceEnabled is true */
-  public actual fun trace(marker: io.github.oshai.Marker?, t: Throwable?, msg: () -> Any?)
+  public actual fun trace(marker: Marker?, t: Throwable?, msg: () -> Any?)
 
   /** Lazy add a log message with throwable payload if isDebugEnabled is true */
-  public actual fun debug(marker: io.github.oshai.Marker?, t: Throwable?, msg: () -> Any?)
+  public actual fun debug(marker: Marker?, t: Throwable?, msg: () -> Any?)
 
   /** Lazy add a log message with throwable payload if isInfoEnabled is true */
-  public actual fun info(marker: io.github.oshai.Marker?, t: Throwable?, msg: () -> Any?)
+  public actual fun info(marker: Marker?, t: Throwable?, msg: () -> Any?)
 
   /** Lazy add a log message with throwable payload if isWarnEnabled is true */
-  public actual fun warn(marker: io.github.oshai.Marker?, t: Throwable?, msg: () -> Any?)
+  public actual fun warn(marker: Marker?, t: Throwable?, msg: () -> Any?)
 
   /** Lazy add a log message with throwable payload if isErrorEnabled is true */
-  public actual fun error(marker: io.github.oshai.Marker?, t: Throwable?, msg: () -> Any?)
+  public actual fun error(marker: Marker?, t: Throwable?, msg: () -> Any?)
 
   /** Add a log message with all the supplied parameters along with method name */
   public actual fun entry(vararg argArray: Any?)

src/androidMain/kotlin/io/github/oshai/KotlinLogging.kt

@@ -1,3 +1,3 @@
 package io.github.oshai.internal
 
-public actual typealias ErrorMessageProducer = DefaultErrorMessageProducer
+internal actual typealias ErrorMessageProducer = DefaultErrorMessageProducer

src/androidMain/kotlin/io/github/oshai/internal/ErrorMessageProducer.kt

@@ -0,0 +1,9 @@
+package io.github.oshai.internal
+
+import io.github.oshai.KLogger
+
+@Suppress("NOTHING_TO_INLINE")
+internal actual object KLoggerFactory {
+
+  internal actual inline fun logger(name: String): KLogger = KLoggerAndroid(name)
+}

src/androidMain/kotlin/io/github/oshai/internal/KLoggerFactory.kt

@@ -141,3 +141,123 @@ public fun KLogger.isEnabledForLevel(level: Level): Boolean {
     else -> throw IllegalArgumentException("Level [$level] not recognized.")
   }
 }
+
+@Suppress("TooManyFunctions")
+public interface ActualKLogger {
+
+  /**
+   * Return the name of this `Logger` instance.
+   * @return name of this logger instance
+   */
+  public val name: String
+
+  /** Lazy add a log message if isTraceEnabled is true */
+  public fun trace(msg: () -> Any?)
+
+  /** Lazy add a log message if isDebugEnabled is true */
+  public fun debug(msg: () -> Any?)
+
+  /** Lazy add a log message if isInfoEnabled is true */
+  public fun info(msg: () -> Any?)
+
+  /** Lazy add a log message if isWarnEnabled is true */
+  public fun warn(msg: () -> Any?)
+
+  /** Lazy add a log message if isErrorEnabled is true */
+  public fun error(msg: () -> Any?)
+
+  /** Lazy add a log message with throwable payload if isTraceEnabled is true */
+  public fun trace(t: Throwable?, msg: () -> Any?)
+
+  /** Lazy add a log message with throwable payload if isDebugEnabled is true */
+  public fun debug(t: Throwable?, msg: () -> Any?)
+
+  /** Lazy add a log message with throwable payload if isInfoEnabled is true */
+  public fun info(t: Throwable?, msg: () -> Any?)
+
+  /** Lazy add a log message with throwable payload if isWarnEnabled is true */
+  public fun warn(t: Throwable?, msg: () -> Any?)
+
+  /** Lazy add a log message with throwable payload if isErrorEnabled is true */
+  public fun error(t: Throwable?, msg: () -> Any?)
+
+  /** Lazy add a log message if isTraceEnabled is true */
+  public fun trace(marker: Marker?, msg: () -> Any?)
+
+  /** Lazy add a log message if isDebugEnabled is true */
+  public fun debug(marker: Marker?, msg: () -> Any?)
+
+  /** Lazy add a log message if isInfoEnabled is true */
+  public fun info(marker: Marker?, msg: () -> Any?)
+
+  /** Lazy add a log message if isWarnEnabled is true */
+  public fun warn(marker: Marker?, msg: () -> Any?)
+
+  /** Lazy add a log message if isErrorEnabled is true */
+  public fun error(marker: Marker?, msg: () -> Any?)
+
+  /** Lazy add a log message with throwable payload if isTraceEnabled is true */
+  public fun trace(marker: Marker?, t: Throwable?, msg: () -> Any?)
+
+  /** Lazy add a log message with throwable payload if isDebugEnabled is true */
+  public fun debug(marker: Marker?, t: Throwable?, msg: () -> Any?)
+
+  /** Lazy add a log message with throwable payload if isInfoEnabled is true */
+  public fun info(marker: Marker?, t: Throwable?, msg: () -> Any?)
+
+  /** Lazy add a log message with throwable payload if isWarnEnabled is true */
+  public fun warn(marker: Marker?, t: Throwable?, msg: () -> Any?)
+
+  /** Lazy add a log message with throwable payload if isErrorEnabled is true */
+  public fun error(marker: Marker?, t: Throwable?, msg: () -> Any?)
+
+  /** Add a log message with all the supplied parameters along with method name */
+  public fun entry(vararg argArray: Any?)
+
+  /** Add log message indicating exit of a method */
+  public fun exit()
+
+  /** Add a log message with the return value of a method */
+  public fun <T> exit(result: T): T where T : Any?
+
+  /** Add a log message indicating an exception will be thrown along with the stack trace. */
+  public fun <T> throwing(throwable: T): T where T : Throwable
+
+  /** Add a log message indicating an exception is caught along with the stack trace. */
+  public fun <T> catching(throwable: T) where T : Throwable
+
+  /**
+   * Is the logger instance enabled for the TRACE level?
+   *
+   * @return True if this Logger is enabled for the TRACE level, false otherwise.
+   */
+  public val isTraceEnabled: Boolean
+
+  /**
+   * Is the logger instance enabled for the DEBUG level?
+   *
+   * @return True if this Logger is enabled for the DEBUG level, false otherwise.
+   */
+  public val isDebugEnabled: Boolean
+
+  /**
+   * Is the logger instance enabled for the INFO level?
+   *
+   * @return True if this Logger is enabled for the INFO level, false otherwise.
+   */
+  public val isInfoEnabled: Boolean
+
+  /**
+   * Is the logger instance enabled for the WARN level?
+   *
+   * @return True if this Logger is enabled for the WARN level, false otherwise.
+   */
+  public val isWarnEnabled: Boolean
+
+  /**
+   * Is the logger instance enabled for the ERROR level?
+   *
+   * @return True if this Logger is enabled for the ERROR level, false otherwise.
+   */
+  public val isErrorEnabled: Boolean
+}

src/androidMain/kotlin/io/github/oshai/internal/KLoggerNameResolver.kt

@@ -3,5 +3,5 @@ package io.github.oshai
 /** A platform independent factory to create markers. */
 public object KMarkerFactory {
 
-  public fun getMarker(name: String): io.github.oshai.Marker = io.github.oshai.SimpleMarker(name)
+  public fun getMarker(name: String): Marker = SimpleMarker(name)
 }

src/commonMain/kotlin/io/github/oshai/KLogger.kt

@@ -1,13 +1,24 @@
 package io.github.oshai
 
-public expect object KotlinLogging {
+import io.github.oshai.internal.KLoggerFactory
+import io.github.oshai.internal.KLoggerNameResolver
+
+public object KotlinLogging {
   /**
    * This method allow defining the logger in a file in the following way:
    * ```
-   * val logger = KotlinLogging.logger {}
+   * private val logger = KotlinLogging.logger {}
    * ```
    */
-  public fun logger(func: () -> Unit): KLogger
+  public fun logger(func: () -> Unit): KLogger = logger(KLoggerNameResolver.name(func))
 
-  public fun logger(name: String): KLogger
+  /**
+   * This method allow defining the logger in a file in the following way:
+   * ```
+   * private val logger = KotlinLogging.logger("io.github.oshai.MyLogger")
+   * ```
+   * In most cases the name represents the package notation of the file that the logger is defined
+   * in.
+   */
+  public fun logger(name: String): KLogger = KLoggerFactory.logger(name)
 }

src/commonMain/kotlin/io/github/oshai/KMarkerFactory.kt

@@ -6,6 +6,6 @@ public interface Marker {
   public fun getName(): String
 }
 
-internal data class SimpleMarker(private val name: String) : io.github.oshai.Marker {
+internal data class SimpleMarker(private val name: String) : Marker {
   override fun getName(): String = this.name
 }