Merge pull request #43 from square/py/logcat_filter_tags

isLoggable takes a priority and a tag, allows skipping logging based on tags

Author: pyricau

CHANGELOG.md

@@ -1,6 +1,14 @@
 Change Log
 ==========
 
+Next version
+-------------
+
+_20XX-XX-XX_
+
+* `isLoggable` now takes a priority and a tag, which allows skipping logging based on tags.
+
+
 Version 0.3
 -------------
 

logcat/api/android/logcat.api

@@ -5,6 +5,7 @@ public final class logcat/AndroidLogcatLogger : logcat/LogcatLogger {
 	public synthetic fun <init> (Llogcat/LogPriority;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public static final fun installOnDebuggableApp (Landroid/app/Application;Llogcat/LogPriority;)V
 	public fun isLoggable (Llogcat/LogPriority;)Z
+	public fun isLoggable (Llogcat/LogPriority;Ljava/lang/String;)Z
 	public fun log (Llogcat/LogPriority;Ljava/lang/String;Ljava/lang/String;)V
 }
 
@@ -47,6 +48,7 @@ public abstract interface class logcat/LogcatLogger {
 	public static fun install ()V
 	public static fun isInstalled ()Z
 	public abstract fun isLoggable (Llogcat/LogPriority;)Z
+	public abstract fun isLoggable (Llogcat/LogPriority;Ljava/lang/String;)Z
 	public abstract fun log (Llogcat/LogPriority;Ljava/lang/String;Ljava/lang/String;)V
 	public static fun setObserver (Llogcat/LogcatObserver;)V
 	public static fun uninstall ()V
@@ -65,6 +67,7 @@ public final class logcat/LogcatLogger$Companion {
 
 public final class logcat/LogcatLogger$DefaultImpls {
 	public static fun isLoggable (Llogcat/LogcatLogger;Llogcat/LogPriority;)Z
+	public static fun isLoggable (Llogcat/LogcatLogger;Llogcat/LogPriority;Ljava/lang/String;)Z
 }
 
 public abstract interface class logcat/LogcatObserver {
@@ -75,6 +78,7 @@ public abstract interface class logcat/LogcatObserver {
 public final class logcat/PrintLogger : logcat/LogcatLogger {
 	public static final field INSTANCE Llogcat/PrintLogger;
 	public fun isLoggable (Llogcat/LogPriority;)Z
+	public fun isLoggable (Llogcat/LogPriority;Ljava/lang/String;)Z
 	public fun log (Llogcat/LogPriority;Ljava/lang/String;Ljava/lang/String;)V
 }
 

logcat/api/jvm/logcat.api

@@ -28,6 +28,7 @@ public abstract interface class logcat/LogcatLogger {
 	public static fun install ()V
 	public static fun isInstalled ()Z
 	public abstract fun isLoggable (Llogcat/LogPriority;)Z
+	public abstract fun isLoggable (Llogcat/LogPriority;Ljava/lang/String;)Z
 	public abstract fun log (Llogcat/LogPriority;Ljava/lang/String;Ljava/lang/String;)V
 	public static fun setObserver (Llogcat/LogcatObserver;)V
 	public static fun uninstall ()V
@@ -46,6 +47,7 @@ public final class logcat/LogcatLogger$Companion {
 
 public final class logcat/LogcatLogger$DefaultImpls {
 	public static fun isLoggable (Llogcat/LogcatLogger;Llogcat/LogPriority;)Z
+	public static fun isLoggable (Llogcat/LogcatLogger;Llogcat/LogPriority;Ljava/lang/String;)Z
 }
 
 public abstract interface class logcat/LogcatObserver {
@@ -56,6 +58,7 @@ public abstract interface class logcat/LogcatObserver {
 public final class logcat/PrintLogger : logcat/LogcatLogger {
 	public static final field INSTANCE Llogcat/PrintLogger;
 	public fun isLoggable (Llogcat/LogPriority;)Z
+	public fun isLoggable (Llogcat/LogPriority;Ljava/lang/String;)Z
 	public fun log (Llogcat/LogPriority;Ljava/lang/String;Ljava/lang/String;)V
 }
 

logcat/src/androidMain/kotlin/logcat/AndroidLogcatLogger.kt

@@ -27,8 +27,10 @@ class AndroidLogcatLogger(minPriority: LogPriority = DEBUG) : LogcatLogger {
 
   private val minPriorityInt: Int = minPriority.priorityInt
 
-  override fun isLoggable(priority: LogPriority): Boolean =
-    priority.priorityInt >= minPriorityInt
+  override fun isLoggable(
+    priority: LogPriority,
+    tag: String
+  ): Boolean = priority.priorityInt >= minPriorityInt
 
   override fun log(
     priority: LogPriority,
@@ -77,7 +79,10 @@ class AndroidLogcatLogger(minPriority: LogPriority = DEBUG) : LogcatLogger {
 
   companion object {
     @JvmStatic
-    fun installOnDebuggableApp(application: Application, minPriority: LogPriority = VERBOSE) {
+    fun installOnDebuggableApp(
+      application: Application,
+      minPriority: LogPriority = VERBOSE
+    ) {
       if (!LogcatLogger.isInstalled && application.isDebuggableApp) {
         LogcatLogger.install()
         LogcatLogger.loggers += AndroidLogcatLogger(minPriority)

logcat/src/commonMain/kotlin/logcat/Logcat.kt

@@ -61,10 +61,10 @@ inline fun Any.logcat(
   if (!LogcatLogger.isInstalled) {
     return
   }
-  val loggers = LogcatLogger.loggers.filter { it.isLoggable(priority) }
   @OptIn(InternalLogcatApi::class)
+  val tagOrCaller = tag ?: outerClassSimpleName()
+  val loggers = LogcatLogger.loggers.filter { it.isLoggable(priority, tagOrCaller) }
   if (loggers.isNotEmpty()) {
-    val tagOrCaller = tag ?: outerClassSimpleName()
     val observer = LogcatLogger.observer
     observer?.beforeLog(priority, tagOrCaller)
     val evaluatedMessage = message()
@@ -88,7 +88,7 @@ inline fun logcat(
   if (!LogcatLogger.isInstalled) {
     return
   }
-  val loggers = LogcatLogger.loggers.filter { it.isLoggable(priority) }
+  val loggers = LogcatLogger.loggers.filter { it.isLoggable(priority, tag) }
   if (loggers.isNotEmpty()) {
     val observer = LogcatLogger.observer
     observer?.beforeLog(priority, tag)

logcat/src/commonMain/kotlin/logcat/LogcatLogger.kt

@@ -17,11 +17,20 @@ import kotlin.concurrent.Volatile
  */
 interface LogcatLogger {
 
+  @Deprecated(
+    "Override the method that takes priority and tag instead",
+    ReplaceWith("isLoggable(priority, tag)")
+  )
+  fun isLoggable(priority: LogPriority) = true
+
   /**
-   * Whether a log with the provided priority should be logged and the corresponding message
+   * Whether a log with the provided priority and tag should be logged and the corresponding message
    * providing lambda evaluated. Called by [logcat].
    */
-  fun isLoggable(priority: LogPriority) = true
+  fun isLoggable(
+    priority: LogPriority,
+    tag: String
+  ) = isLoggable(priority)
 
   /**
    * Write a log to its destination. Called by [logcat].
@@ -96,11 +105,14 @@ interface LogcatLogger {
 
           private lateinit var localLoggers: List<LogcatLogger>
 
-          override fun isLoggable(priority: LogPriority): Boolean {
+          override fun isLoggable(
+            priority: LogPriority,
+            tag: String
+          ): Boolean {
             if (!isInstalled) {
               return false
             }
-            val filteredLoggers = loggers.filter { it.isLoggable(priority) }
+            val filteredLoggers = loggers.filter { it.isLoggable(priority, tag) }
             localLoggers = filteredLoggers
             return filteredLoggers.isNotEmpty()
           }

logcat/src/commonTest/kotlin/logcat/TestLogcatLogger.kt

@@ -1,7 +1,10 @@
 package logcat
 
 class TestLogcatLogger : LogcatLogger {
-  override fun isLoggable(priority: LogPriority): Boolean {
+  override fun isLoggable(
+    priority: LogPriority,
+    tag: String
+  ): Boolean {
     latestPriority = priority
     return shouldLog
   }