Provide actual support for ExtLocationInfo

pdvrieze · Feb 14, 2024 · 38c9320 · 38c9320
1 parent cfc50ba
commit 38c9320
Show file tree

Hide file tree

Showing 8 changed files with 74 additions and 16 deletions.
diff --git a/core/api/android/core.api b/core/api/android/core.api
@@ -22,6 +22,7 @@ public final class nl/adaptivity/xmlutil/AndroidXmlReader : nl/adaptivity/xmluti
 	public fun getDepth ()I
 	public fun getEncoding ()Ljava/lang/String;
 	public fun getEventType ()Lnl/adaptivity/xmlutil/EventType;
+	public fun getExtLocationInfo ()Lnl/adaptivity/xmlutil/XmlReader$LocationInfo;
 	public fun getLocalName ()Ljava/lang/String;
 	public fun getLocationInfo ()Ljava/lang/String;
 	public fun getNamespaceContext ()Lnl/adaptivity/xmlutil/IterableNamespaceContext;
@@ -100,6 +101,7 @@ public final class nl/adaptivity/xmlutil/DomReader : nl/adaptivity/xmlutil/XmlRe
 	public fun getDepth ()I
 	public fun getEncoding ()Ljava/lang/String;
 	public fun getEventType ()Lnl/adaptivity/xmlutil/EventType;
+	public fun getExtLocationInfo ()Lnl/adaptivity/xmlutil/XmlReader$LocationInfo;
 	public fun getLocalName ()Ljava/lang/String;
 	public fun getLocationInfo ()Ljava/lang/String;
 	public fun getNamespaceContext ()Lnl/adaptivity/xmlutil/IterableNamespaceContext;
@@ -617,8 +619,9 @@ public final class nl/adaptivity/xmlutil/XmlReader$DefaultImpls {
 	public static fun require (Lnl/adaptivity/xmlutil/XmlReader;Lnl/adaptivity/xmlutil/EventType;Ljavax/xml/namespace/QName;)V
 }
 
-public final class nl/adaptivity/xmlutil/XmlReader$ExtLocationInfo {
+public final class nl/adaptivity/xmlutil/XmlReader$ExtLocationInfo : nl/adaptivity/xmlutil/XmlReader$LocationInfo {
 	public fun <init> (III)V
+	public fun toString ()Ljava/lang/String;
 }
 
 public abstract interface class nl/adaptivity/xmlutil/XmlReader$LocationInfo {
@@ -905,6 +908,7 @@ public final class nl/adaptivity/xmlutil/core/KtXmlReader : nl/adaptivity/xmluti
 	public fun getDepth ()I
 	public fun getEncoding ()Ljava/lang/String;
 	public fun getEventType ()Lnl/adaptivity/xmlutil/EventType;
+	public fun getExtLocationInfo ()Lnl/adaptivity/xmlutil/XmlReader$LocationInfo;
 	public final fun getLineNumber ()I
 	public fun getLocalName ()Ljava/lang/String;
 	public fun getLocationInfo ()Ljava/lang/String;

diff --git a/core/api/jvm/core.api b/core/api/jvm/core.api
@@ -13,6 +13,7 @@ public final class nl/adaptivity/xmlutil/DomReader : nl/adaptivity/xmlutil/XmlRe
 	public fun getDepth ()I
 	public fun getEncoding ()Ljava/lang/String;
 	public fun getEventType ()Lnl/adaptivity/xmlutil/EventType;
+	public fun getExtLocationInfo ()Lnl/adaptivity/xmlutil/XmlReader$LocationInfo;
 	public fun getLocalName ()Ljava/lang/String;
 	public fun getLocationInfo ()Ljava/lang/String;
 	public fun getNamespaceContext ()Lnl/adaptivity/xmlutil/IterableNamespaceContext;
@@ -176,6 +177,7 @@ public final class nl/adaptivity/xmlutil/StAXReader : nl/adaptivity/xmlutil/XmlR
 	public fun getDepth ()I
 	public fun getEncoding ()Ljava/lang/String;
 	public fun getEventType ()Lnl/adaptivity/xmlutil/EventType;
+	public fun getExtLocationInfo ()Lnl/adaptivity/xmlutil/XmlReader$LocationInfo;
 	public fun getLocalName ()Ljava/lang/String;
 	public final fun getLocation ()Ljavax/xml/stream/Location;
 	public fun getLocationInfo ()Ljava/lang/String;
@@ -640,8 +642,9 @@ public final class nl/adaptivity/xmlutil/XmlReader$DefaultImpls {
 	public static fun require (Lnl/adaptivity/xmlutil/XmlReader;Lnl/adaptivity/xmlutil/EventType;Ljavax/xml/namespace/QName;)V
 }
 
-public final class nl/adaptivity/xmlutil/XmlReader$ExtLocationInfo {
+public final class nl/adaptivity/xmlutil/XmlReader$ExtLocationInfo : nl/adaptivity/xmlutil/XmlReader$LocationInfo {
 	public fun <init> (III)V
+	public fun toString ()Ljava/lang/String;
 }
 
 public abstract interface class nl/adaptivity/xmlutil/XmlReader$LocationInfo {
@@ -928,6 +931,7 @@ public final class nl/adaptivity/xmlutil/core/KtXmlReader : nl/adaptivity/xmluti
 	public fun getDepth ()I
 	public fun getEncoding ()Ljava/lang/String;
 	public fun getEventType ()Lnl/adaptivity/xmlutil/EventType;
+	public fun getExtLocationInfo ()Lnl/adaptivity/xmlutil/XmlReader$LocationInfo;
 	public final fun getLineNumber ()I
 	public fun getLocalName ()Ljava/lang/String;
 	public fun getLocationInfo ()Ljava/lang/String;

diff --git a/core/src/androidMain/kotlin/nl/adaptivity/xmlutil/AndroidXmlReader.kt b/core/src/androidMain/kotlin/nl/adaptivity/xmlutil/AndroidXmlReader.kt
@@ -1,7 +1,7 @@
 /*
- * Copyright (c) 2018.
+ * Copyright (c) 2024.
  *
- * This file is part of XmlUtil.
+ * This file is part of xmlutil.
  *
  * This file is licenced to you under the Apache License, Version 2.0 (the
  * "License"); you may not use this file except in compliance
@@ -129,13 +129,22 @@ public class AndroidXmlReader(public val parser: XmlPullParser) : XmlReader {
         return null
     }
 
+    @Deprecated("Use extLocationInfo as that allows more detailed information", ReplaceWith("extLocationInfo?.toString()"))
     override val locationInfo: String
         get() = buildString {
             append(parser.lineNumber)
             append(':')
             append(parser.columnNumber)
         }
 
+    override val extLocationInfo: XmlReader.LocationInfo
+        get() = XmlReader.ExtLocationInfo(
+            col = parser.columnNumber,
+            line = parser.lineNumber,
+            offset = -1
+        )
+
+
     override val standalone: Boolean
         get() = parser.getProperty("xmldecl-standalone") as Boolean
 

diff --git a/core/src/commonMain/kotlin/nl/adaptivity/xmlutil/DomReader.kt b/core/src/commonMain/kotlin/nl/adaptivity/xmlutil/DomReader.kt
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023.
+ * Copyright (c) 2024.
  *
  * This file is part of xmlutil.
  *
@@ -120,9 +120,8 @@ public class DomReader(public val delegate: Node2) : XmlReader {
 
         }
 
-    override val locationInfo: String
+    override val extLocationInfo: XmlReader.LocationInfo
         get() {
-
             fun <A : Appendable> helper(node: Node2?, result: A): A = when (node?.nodetype) {
                 null, NodeType.DOCUMENT_NODE
                 -> result
@@ -136,9 +135,16 @@ public class DomReader(public val delegate: Node2) : XmlReader {
                 else -> helper(node.parentNode, result).apply { append("/.") }
             }
 
-            return helper(current, StringBuilder()).toString()
+            return XmlReader.StringLocationInfo(helper(current, StringBuilder()).toString())
         }
 
+    @Deprecated(
+        "Use extLocationInfo as that allows more detailed information",
+        replaceWith = ReplaceWith("extLocationInfo?.toString()")
+    )
+    override val locationInfo: String
+        get() = extLocationInfo.toString()
+
     private val requireCurrent get() = current ?: throw IllegalStateException("No current element")
     private val requireCurrentElem get() = currentElement ?: throw IllegalStateException("No current element")
 

diff --git a/core/src/commonMain/kotlin/nl/adaptivity/xmlutil/XmlReader.kt b/core/src/commonMain/kotlin/nl/adaptivity/xmlutil/XmlReader.kt
@@ -166,7 +166,24 @@ public interface XmlReader : Closeable, Iterator<EventType> {
     /**
      * Extended location info that actually provides column, line, and or file/string offset information
      */
-    public class ExtLocationInfo(private val col: Int, private val line: Int, private val offset:Int)
+    public class ExtLocationInfo(private val col: Int, private val line: Int, private val offset: Int) : LocationInfo {
+        override fun toString(): String = buildString {
+            when {
+                line >= 0 -> {
+                    append(line)
+                    if (col >= 0) {
+                        append(':')
+                        append(col)
+                    }
+                }
+
+                offset >= 0 -> append('@').append(offset)
+
+                else -> append("<unknown>")
+            }
+
+        }
+    }
 }
 
 public val XmlReader.attributes: Array<out XmlEvent.Attribute>

diff --git a/core/src/commonMain/kotlin/nl/adaptivity/xmlutil/core/KtXmlReader.kt b/core/src/commonMain/kotlin/nl/adaptivity/xmlutil/core/KtXmlReader.kt
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023.
+ * Copyright (c) 2024.
  *
  * This file is part of xmlutil.
  *
@@ -37,6 +37,7 @@ public class KtXmlReader internal constructor(
 
     private var line = 1
     private var column = 0
+    private var offset = 0
 
     private var _eventType: EventType? = null //START_DOCUMENT // Already have this state
     public override val eventType: EventType
@@ -692,6 +693,7 @@ public class KtXmlReader internal constructor(
         }
 
         peekCount--
+        offset++
         column++
         if (result == '\n'.code) {
             line++
@@ -812,6 +814,9 @@ public class KtXmlReader internal constructor(
     override val locationInfo: String
         get() = "$line:$column"
 
+    override val extLocationInfo: XmlReader.LocationInfo
+        get() = XmlReader.ExtLocationInfo(col = column, line = line, offset = offset)
+
     public fun getLineNumber(): Int {
         return line
     }

diff --git a/core/src/jvmMain/kotlin/nl/adaptivity/xmlutil/StAXReader.kt b/core/src/jvmMain/kotlin/nl/adaptivity/xmlutil/StAXReader.kt
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023.
+ * Copyright (c) 2024.
  *
  * This file is part of xmlutil.
  *
@@ -126,12 +126,26 @@ public class StAXReader(private val delegate: XMLStreamReader) : XmlReader {
         return delegate.namespaceContext.getPrefix(namespaceUri)
     }
 
+    @Deprecated(
+        "Use extLocationInfo as that allows more detailed information",
+        replaceWith = ReplaceWith("extLocationInfo?.toString()")
+    )
     override val locationInfo: String?
         get() {
             val location = delegate.location
             return location?.toString()
         }
 
+    override val extLocationInfo: XmlReader.LocationInfo?
+        get() {
+            val l = delegate.location ?: return null
+            return XmlReader.ExtLocationInfo(
+                col = l.columnNumber,
+                line =  l.lineNumber,
+                offset = l.characterOffset,
+            )
+        }
+
     public val location: Location
         @Deprecated("")
         get() = delegate.location

diff --git a/...tion/src/commonMain/kotlin/nl/adaptivity/xmlutil/serialization/structure/XmlDescriptor.kt b/...tion/src/commonMain/kotlin/nl/adaptivity/xmlutil/serialization/structure/XmlDescriptor.kt
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2023.
+ * Copyright (c) 2024.
  *
  * This file is part of xmlutil.
  *
@@ -436,11 +436,11 @@ public sealed class XmlValueDescriptor(
                 defaultValue(xmlCodecBase.serializersModule, xmlCodecBase.config, deserializer)
 
             xmlCodecBase is XmlDecoderBase ->
-                deserializer.deserialize(xmlCodecBase.StringDecoder(this, default))
+                deserializer.deserialize(xmlCodecBase.StringDecoder(this, XmlReader.ExtLocationInfo(0,0,0), default))
 
             else -> xmlCodecBase.run {
                 val dec = XmlDecoderBase(serializersModule, config, CompactFragment("").getXmlReader())
-                    .StringDecoder(this@XmlValueDescriptor, default)
+                    .StringDecoder(this@XmlValueDescriptor, XmlReader.ExtLocationInfo(0,0,0), default)
 
                 deserializer.deserialize(dec)
             }
@@ -461,8 +461,7 @@ public sealed class XmlValueDescriptor(
 
             effectiveOutputKind.let { it == OutputKind.Attribute || it == OutputKind.Text } -> {
                 val xmlDecoderBase: XmlDecoderBase = XmlDecoderBase(serializersModule, config, CompactFragment(default).getXmlReader())
-                val dec = xmlDecoderBase
-                    .StringDecoder(this, default)
+                val dec = xmlDecoderBase.StringDecoder(this, XmlReader.ExtLocationInfo(0, 0, 0), default)
                 deserializer.deserialize(dec)
             }