Add ParseException

buenaflor · Aug 2, 2023 · 9d81d79 · 9d81d79
1 parent ef2a620
commit 9d81d79
Show file tree

Hide file tree

Showing 9 changed files with 21 additions and 3 deletions.
diff --git a/api/src/commonMain/kotlin/com/buenaflor/kflogger/parser/KDefaultPrintfMessageParser.kt b/api/src/commonMain/kotlin/com/buenaflor/kflogger/parser/KDefaultPrintfMessageParser.kt
@@ -10,6 +10,7 @@ package com.buenaflor.kflogger.parser
  * This class is immutable and thread safe (and any subclasses must also be so).
  */
 public expect class KDefaultPrintfMessageParser private constructor() : KPrintfMessageParser {
+    @Throws(KParseException::class)
     override fun parsePrintfTerm(
         builder: KMessageBuilder<*>?,
         index: Int,

diff --git a/api/src/commonMain/kotlin/com/buenaflor/kflogger/parser/KMessageParser.kt b/api/src/commonMain/kotlin/com/buenaflor/kflogger/parser/KMessageParser.kt
@@ -31,7 +31,7 @@ public expect abstract class KMessageParser() {
    * Implementations of this method are required to invoke the [MessageBuilder.addParameterImpl]
    * method of the supplied builder once for each parameter place-holder in the message.
    */
-  // TODO KFlogger : @Throws(com.buenaflor.kflogger.parser.ParseException::class)
+  @Throws(KParseException::class)
   protected abstract fun <T> parseImpl(builder: KMessageBuilder<T>?)
 
   /**

diff --git a/api/src/commonMain/kotlin/com/buenaflor/kflogger/parser/KParseException.kt b/api/src/commonMain/kotlin/com/buenaflor/kflogger/parser/KParseException.kt
@@ -0,0 +1,3 @@
+package com.buenaflor.kflogger.parser
+
+public expect class KParseException : RuntimeException
diff --git a/api/src/commonMain/kotlin/com/buenaflor/kflogger/parser/KPrintfMessageParser.kt b/api/src/commonMain/kotlin/com/buenaflor/kflogger/parser/KPrintfMessageParser.kt
@@ -46,6 +46,7 @@ public expect abstract class KPrintfMessageParser() : KMessageParser {
      * @param formatStart the index of the (first) format character in the term.
      * @return the index after the last character of the term.
      */
+    @Throws(KParseException::class)
     protected abstract fun parsePrintfTerm(
         builder: KMessageBuilder<*>?,
         index: Int,
@@ -55,9 +56,10 @@ public expect abstract class KPrintfMessageParser() : KMessageParser {
         formatStart: Int
     ): Int
 
-    final override fun unescape(out: StringBuilder?, message: String?, start: Int, end: Int)
+    public final override fun unescape(out: StringBuilder?, message: String?, start: Int, end: Int)
 
-    final override fun <T> parseImpl(builder: KMessageBuilder<T>?)
+    @Throws(KParseException::class)
+    protected final override fun <T> parseImpl(builder: KMessageBuilder<T>?)
 
     public companion object {
         /**
@@ -71,6 +73,7 @@ public expect abstract class KPrintfMessageParser() : KMessageParser {
          * found).
          */
         // VisibleForTesting
+        @Throws(KParseException::class)
         internal fun nextPrintfTerm(message: String, pos: Int): Int
 
         /**

diff --git a/api/src/commonTest/kotlin/com.buenaflor.kflogger/parser/KPrintfMessageParserTest.kt b/api/src/commonTest/kotlin/com.buenaflor.kflogger/parser/KPrintfMessageParserTest.kt
@@ -38,5 +38,6 @@ class KPrintfMessageParserTest {
     fun testNotCrashing() {
         // This test is to ensure that the code compiles and does not crash.
         messageParser.unescape(StringBuilder(), "", 0, 0)
+
     }
 }
diff --git a/api/src/iosMain/kotlin/com/buenaflor/kflogger/parser/KMessageParser.darwin.kt b/api/src/iosMain/kotlin/com/buenaflor/kflogger/parser/KMessageParser.darwin.kt
@@ -31,6 +31,7 @@ public actual abstract class KMessageParser {
    * Implementations of this method are required to invoke the [MessageBuilder.addParameterImpl]
    * method of the supplied builder once for each parameter place-holder in the message.
    */
+  @Throws(KParseException::class)
   protected actual abstract fun <T> parseImpl(builder: KMessageBuilder<T>?)
 
   /**

diff --git a/api/src/iosMain/kotlin/com/buenaflor/kflogger/parser/KParseException.darwin.kt b/api/src/iosMain/kotlin/com/buenaflor/kflogger/parser/KParseException.darwin.kt
@@ -0,0 +1,3 @@
+package com.buenaflor.kflogger.parser
+
+public actual class KParseException : RuntimeException()
diff --git a/api/src/iosMain/kotlin/com/buenaflor/kflogger/parser/KPrintfMessageParser.darwin.kt b/api/src/iosMain/kotlin/com/buenaflor/kflogger/parser/KPrintfMessageParser.darwin.kt
@@ -46,6 +46,7 @@ public actual abstract class KPrintfMessageParser : KMessageParser() {
      * @param formatStart the index of the (first) format character in the term.
      * @return the index after the last character of the term.
      */
+    @Throws(KParseException::class)
     protected actual abstract fun parsePrintfTerm(
         builder: KMessageBuilder<*>?,
         index: Int,
@@ -59,6 +60,7 @@ public actual abstract class KPrintfMessageParser : KMessageParser() {
         TODO()
     }
 
+    @Throws(KParseException::class)
     actual final override fun <T> parseImpl(builder: KMessageBuilder<T>?) {
         TODO()
     }
@@ -77,6 +79,7 @@ public actual abstract class KPrintfMessageParser : KMessageParser() {
          * found).
          */
         // VisibleForTesting
+        @Throws(KParseException::class)
         internal actual fun nextPrintfTerm(message: String, pos: Int): Int {
             TODO()
         }

diff --git a/api/src/jvmMain/kotlin/com/buenaflor/kflogger/parser/KParseException.jvm.kt b/api/src/jvmMain/kotlin/com/buenaflor/kflogger/parser/KParseException.jvm.kt
@@ -0,0 +1,3 @@
+package com.buenaflor.kflogger.parser
+
+public actual typealias KParseException = ParseException