Add support for expanding entities.

Author: pdvrieze

core/android/api/coreAndroid.api

@@ -1,18 +1,22 @@
 public final class nl/adaptivity/xmlutil/core/AndroidStreamingFactory : nl/adaptivity/xmlutil/XmlStreamingFactory {
 	public fun <init> ()V
-	public fun newReader (Ljava/io/InputStream;)Lnl/adaptivity/xmlutil/XmlReader;
-	public fun newReader (Ljava/io/InputStream;Ljava/lang/String;)Lnl/adaptivity/xmlutil/XmlReader;
-	public fun newReader (Ljava/io/Reader;)Lnl/adaptivity/xmlutil/XmlReader;
+	public fun newReader (Ljava/io/InputStream;Ljava/lang/String;Z)Lnl/adaptivity/xmlutil/XmlReader;
+	public fun newReader (Ljava/io/InputStream;Z)Lnl/adaptivity/xmlutil/XmlReader;
+	public fun newReader (Ljava/io/Reader;Z)Lnl/adaptivity/xmlutil/XmlReader;
 	public fun newReader (Ljavax/xml/transform/Source;)Lnl/adaptivity/xmlutil/XmlReader;
 	public fun newWriter (Ljava/io/OutputStream;Ljava/lang/String;ZLnl/adaptivity/xmlutil/XmlDeclMode;)Lnl/adaptivity/xmlutil/XmlWriter;
 	public fun newWriter (Ljava/io/Writer;ZLnl/adaptivity/xmlutil/XmlDeclMode;)Lnl/adaptivity/xmlutil/XmlWriter;
 	public fun newWriter (Ljavax/xml/transform/Result;ZLnl/adaptivity/xmlutil/XmlDeclMode;)Lnl/adaptivity/xmlutil/XmlWriter;
 }
 
 public final class nl/adaptivity/xmlutil/core/AndroidXmlReader : nl/adaptivity/xmlutil/XmlReader {
-	public fun <init> (Ljava/io/InputStream;Ljava/lang/String;)V
+	public fun <init> (Ljava/io/InputStream;Ljava/lang/String;Z)V
+	public synthetic fun <init> (Ljava/io/InputStream;Ljava/lang/String;ZILkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public fun <init> (Ljava/io/Reader;)V
+	public fun <init> (Ljava/io/Reader;Z)V
+	public synthetic fun <init> (Ljava/io/Reader;ZILkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public fun <init> (Lorg/xmlpull/v1/XmlPullParser;)V
+	public fun <init> (Lorg/xmlpull/v1/XmlPullParser;Z)V
 	public fun close ()V
 	public fun getAttributeCount ()I
 	public fun getAttributeLocalName (I)Ljava/lang/String;
@@ -23,6 +27,7 @@ public final class nl/adaptivity/xmlutil/core/AndroidXmlReader : nl/adaptivity/x
 	public fun getDepth ()I
 	public fun getEncoding ()Ljava/lang/String;
 	public fun getEventType ()Lnl/adaptivity/xmlutil/EventType;
+	public final fun getExpandEntities ()Z
 	public fun getExtLocationInfo ()Lnl/adaptivity/xmlutil/XmlReader$LocationInfo;
 	public fun getLocalName ()Ljava/lang/String;
 	public fun getLocationInfo ()Ljava/lang/String;

core/android/src/main/kotlin/nl/adaptivity/xmlutil/core/AndroidStreamingFactory.kt

@@ -1,21 +1,21 @@
 /*
- * Copyright (c) 2024.
+ * Copyright (c) 2024-2025.
  *
  * 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
- * with the License.  You should have received a copy of the license with the source distribution.
- * Alternatively, you may obtain a copy of the License at
+ * This file is licenced to you under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance
+ * with the License.  You should have  received a copy of the license
+ * with the source distribution. Alternatively, you may obtain a copy
+ * of the License at
  *
  *   http://www.apache.org/licenses/LICENSE-2.0
  *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ * implied.  See the License for the specific language governing
+ * permissions and limitations under the License.
  */
 
 package nl.adaptivity.xmlutil.core
@@ -61,32 +61,32 @@ public class AndroidStreamingFactory : XmlStreamingFactory {
     }
 
     @Throws(XmlException::class)
-    override fun newReader(reader: Reader): XmlReader {
+    override fun newReader(reader: Reader, expandEntities: Boolean): XmlReader {
         try {
-            return AndroidXmlReader(reader)
+            return AndroidXmlReader(reader, expandEntities)
         } catch (e: XmlPullParserException) {
             throw XmlException(e)
         }
 
     }
 
     @Throws(XmlException::class)
-    override fun newReader(inputStream: InputStream): XmlReader {
+    override fun newReader(inputStream: InputStream, expandEntities: Boolean): XmlReader {
         try {
             val parser = XmlPullParserFactory.newInstance().newPullParser().also {
                 it.setInput(inputStream, null)
             }
-            return AndroidXmlReader(parser)
+            return AndroidXmlReader(parser, expandEntities)
         } catch (e: XmlPullParserException) {
             throw XmlException(e)
         }
 
     }
 
     @Throws(XmlException::class)
-    override fun newReader(inputStream: InputStream, encoding: String): XmlReader {
+    override fun newReader(inputStream: InputStream, encoding: String, expandEntities: Boolean): XmlReader {
         try {
-            return AndroidXmlReader(inputStream, encoding)
+            return AndroidXmlReader(inputStream, encoding, expandEntities)
         } catch (e: XmlPullParserException) {
             throw XmlException(e)
         }

core/android/src/main/kotlin/nl/adaptivity/xmlutil/core/AndroidXmlReader.kt

@@ -1,21 +1,21 @@
 /*
- * Copyright (c) 2024.
+ * Copyright (c) 2024-2025.
  *
  * 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
- * with the License.  You should have received a copy of the license with the source distribution.
- * Alternatively, you may obtain a copy of the License at
+ * This file is licenced to you under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance
+ * with the License.  You should have  received a copy of the license
+ * with the source distribution. Alternatively, you may obtain a copy
+ * of the License at
  *
  *   http://www.apache.org/licenses/LICENSE-2.0
  *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ * implied.  See the License for the specific language governing
+ * permissions and limitations under the License.
  */
 
 package nl.adaptivity.xmlutil.core
@@ -29,17 +29,20 @@ import java.io.Reader
 /**
  * And XMLReader implementation that works on Android
  */
-public class AndroidXmlReader(public val parser: XmlPullParser) : XmlReader {
+public class AndroidXmlReader(public val parser: XmlPullParser, public val expandEntities: Boolean) : XmlReader {
     override var isStarted: Boolean = false
         private set
 
-    private constructor() : this(XmlPullParserFactory.newInstance().apply { isNamespaceAware = true }.newPullParser())
+    public constructor(parser: XmlPullParser): this(parser, false)
 
-    public constructor(reader: Reader) : this() {
+    private constructor(expandEntities: Boolean) : this(XmlPullParserFactory.newInstance().apply { isNamespaceAware = true }.newPullParser(), expandEntities)
+
+    @JvmOverloads
+    public constructor(reader: Reader, expandEntities: Boolean = false) : this(expandEntities) {
         parser.setInput(reader)
     }
 
-    public constructor(input: InputStream, encoding: String) : this() {
+    public constructor(input: InputStream, encoding: String, expandEntities: Boolean = false) : this(expandEntities) {
         parser.setInput(input, encoding)
     }
 
@@ -67,13 +70,15 @@ public class AndroidXmlReader(public val parser: XmlPullParser) : XmlReader {
             }
             else -> n
         }
-        return DELEGATE_TO_LOCAL[nextToken].also {
+        return delegateToLocal(nextToken).also {
             eventType = it
             if (it == EventType.START_DOCUMENT) version = parser.getAttributeValue(null, "version")
             isStarted = true
         }
     }
 
+    private fun delegateToLocal(nextToken: Int): EventType = when { else -> DELEGATE_TO_LOCAL[nextToken] }
+
     @Throws(XmlException::class)
     override fun nextTag(): EventType {
         var et = next()
@@ -202,6 +207,8 @@ public class AndroidXmlReader(public val parser: XmlPullParser) : XmlReader {
 
         @Suppress("UNCHECKED_CAST")
         private val DELEGATE_TO_LOCAL = arrayOfNulls<EventType>(11) as Array<EventType>
+        @Suppress("UNCHECKED_CAST")
+        private val DELEGATE_TO_LOCAL_EXPANDED: Array<EventType>
 
         private val LOCAL_TO_DELEGATE: IntArray = IntArray(12)
 
@@ -218,6 +225,13 @@ public class AndroidXmlReader(public val parser: XmlPullParser) : XmlReader {
             DELEGATE_TO_LOCAL[XmlPullParser.START_TAG] = EventType.START_ELEMENT
             DELEGATE_TO_LOCAL[XmlPullParser.TEXT] = EventType.TEXT
 
+            DELEGATE_TO_LOCAL_EXPANDED = Array<EventType>(11) {
+                when (val v = DELEGATE_TO_LOCAL[it]) {
+                    EventType.ENTITY_REF -> EventType.TEXT
+                    else -> v
+                }
+            }
+
             LOCAL_TO_DELEGATE[EventType.CDSECT.ordinal] = XmlPullParser.CDSECT
             LOCAL_TO_DELEGATE[EventType.COMMENT.ordinal] = XmlPullParser.COMMENT
             LOCAL_TO_DELEGATE[EventType.DOCDECL.ordinal] = XmlPullParser.DOCDECL