Use immtuable.Seq for attributes

lrytz · lrytz · commit b2bdff63cefa · 2025-05-21T12:04:46.000+02:00
diff --git a/build.sbt b/build.sbt
@@ -71,10 +71,40 @@ lazy val xml = crossProject(JSPlatform, JVMPlatform, NativePlatform)
       Seq( // exclusions for all Scala versions
         // new method in `Node` with return type `immutable.Seq`
         ProblemFilters.exclude[ReversedMissingMethodProblem]("scala.xml.Node.child"),
+
         // these used to be declared methods, but are now bridges without generic signature
         ProblemFilters.exclude[IncompatibleSignatureProblem]("scala.xml.Node.nonEmptyChildren"),
         ProblemFilters.exclude[IncompatibleSignatureProblem]("scala.xml.Group.child"),
         ProblemFilters.exclude[IncompatibleSignatureProblem]("scala.xml.SpecialNode.child"),
+
+        // new methods with return type immutable.Seq
+        ProblemFilters.exclude[ReversedMissingMethodProblem]("scala.xml.Attribute.apply"),
+        ProblemFilters.exclude[ReversedMissingMethodProblem]("scala.xml.Attribute.value"),
+        ProblemFilters.exclude[ReversedMissingMethodProblem]("scala.xml.MetaData.apply"),
+        ProblemFilters.exclude[ReversedMissingMethodProblem]("scala.xml.MetaData.value"),
+
+        // Synthetic static accessors (for Java interop) have a changed return type
+        ProblemFilters.exclude[IncompatibleResultTypeProblem]("scala.xml.Null.apply"),
+        ProblemFilters.exclude[IncompatibleResultTypeProblem]("scala.xml.Null.value"),
+
+        // used to be a declared method, now a bridge without generic signature
+        ProblemFilters.exclude[IncompatibleSignatureProblem]("scala.xml.MetaData.apply"),
+        ProblemFilters.exclude[IncompatibleSignatureProblem]("scala.xml.Null.apply"),
+        ProblemFilters.exclude[IncompatibleSignatureProblem]("scala.xml.Null.value"),
+        ProblemFilters.exclude[IncompatibleSignatureProblem]("scala.xml.PrefixedAttribute.apply"),
+        ProblemFilters.exclude[IncompatibleSignatureProblem]("scala.xml.PrefixedAttribute.value"),
+        ProblemFilters.exclude[IncompatibleSignatureProblem]("scala.xml.UnprefixedAttribute.apply"),
+        ProblemFilters.exclude[IncompatibleSignatureProblem]("scala.xml.UnprefixedAttribute.value"),
+
+        // Option[c.Seq] => Option[i.Seq] results in a changed generic signature
+        ProblemFilters.exclude[IncompatibleSignatureProblem]("scala.xml.MetaData.get"),
+        ProblemFilters.exclude[IncompatibleSignatureProblem]("scala.xml.Null.get"),
+        ProblemFilters.exclude[IncompatibleSignatureProblem]("scala.xml.Node.attribute"),
+
+        // trait Attribute now extends trait ScalaVersionSpecificMetaData to ensure the previous signatures
+        // with return type `collection.Seq` remain valid.
+        // (trait Attribute extends MetaData, but that parent is not present in bytecode because it's a class.)
+        ProblemFilters.exclude[InheritedNewAbstractMethodProblem]("scala.xml.Attribute.apply"),
       ) ++ (CrossVersion.partialVersion(scalaVersion.value) match {
         case Some((3, _)) => Seq( // Scala 3-specific exclusions
         )
diff --git a/shared/src/main/scala-2.12/scala/xml/ScalaVersionSpecific.scala b/shared/src/main/scala-2.12/scala/xml/ScalaVersionSpecific.scala
@@ -34,4 +34,6 @@ private[xml] trait ScalaVersionSpecificNodeBuffer { self: NodeBuffer =>
   override def stringPrefix: String = "NodeBuffer"
 }
 
-private[xml] trait ScalaVersionSpecificNode {self: Node => }
+private[xml] trait ScalaVersionSpecificNode { self: Node => }
+
+private[xml] trait ScalaVersionSpecificMetaData { self: MetaData => }
diff --git a/shared/src/main/scala-2.13+/scala/xml/ScalaVersionSpecific.scala b/shared/src/main/scala-2.13+/scala/xml/ScalaVersionSpecific.scala
@@ -60,3 +60,11 @@ private[xml] trait ScalaVersionSpecificNode { self: Node =>
   def child: scala.collection.Seq[Node]
   def nonEmptyChildren: scala.collection.Seq[Node]
 }
+
+private[xml] trait ScalaVersionSpecificMetaData { self: MetaData =>
+  def apply(key: String): scala.collection.Seq[Node]
+  def apply(namespace_uri: String, owner: Node, key: String): scala.collection.Seq[Node]
+  def apply(namespace_uri: String, scp: NamespaceBinding, k: String): scala.collection.Seq[Node]
+
+  def value: scala.collection.Seq[Node]
+}
diff --git a/shared/src/main/scala-2/scala/xml/ScalaVersionSpecificReturnTypes.scala b/shared/src/main/scala-2/scala/xml/ScalaVersionSpecificReturnTypes.scala
@@ -28,7 +28,6 @@ private[xml] object ScalaVersionSpecificReturnTypes { // should be
   type NullNext = scala.Null
   type NullKey = scala.Null
   type NullValue = scala.Null
-  type NullApply1 = scala.collection.Seq[Node]        // scala.Null
   type NullApply3 = scala.Null
   type NullRemove = Null.type
   type SpecialNodeChild = Nil.type
diff --git a/shared/src/main/scala-3/scala/xml/ScalaVersionSpecificReturnTypes.scala b/shared/src/main/scala-3/scala/xml/ScalaVersionSpecificReturnTypes.scala
@@ -27,9 +27,8 @@ private[xml] object ScalaVersionSpecificReturnTypes {          // should be
   type NullGetNamespace = String                               // scala.Null
   type NullNext = MetaData                                     // scala.Null
   type NullKey = String                                        // scala.Null
-  type NullValue = scala.collection.Seq[Node]                  // scala.Null
-  type NullApply1 = scala.collection.Seq[Node]                 // scala.Null
-  type NullApply3 = scala.collection.Seq[Node]                 // scala.Null
+  type NullValue = scala.collection.immutable.Seq[Node]        // scala.Null
+  type NullApply3 = scala.collection.immutable.Seq[Node]       // scala.Null
   type NullRemove = MetaData                                   // Null.type
   type SpecialNodeChild = scala.collection.immutable.Seq[Node] // Nil.type
   type GroupChild = scala.collection.immutable.Seq[Node]       // Nothing
diff --git a/shared/src/main/scala/scala/xml/Attribute.scala b/shared/src/main/scala/scala/xml/Attribute.scala
@@ -53,14 +53,14 @@ object Attribute {
  *
  *  @author  Burak Emir
  */
-trait Attribute extends MetaData {
+trait Attribute extends MetaData with ScalaVersionSpecificMetaData {
   def pre: String // will be null if unprefixed
   override val key: String
-  override val value: Seq[Node]
+  override val value: ScalaVersionSpecific.SeqOfNode
   override val next: MetaData
 
-  override def apply(key: String): Seq[Node]
-  override def apply(namespace: String, scope: NamespaceBinding, key: String): Seq[Node]
+  override def apply(key: String): ScalaVersionSpecific.SeqOfNode
+  override def apply(namespace: String, scope: NamespaceBinding, key: String): ScalaVersionSpecific.SeqOfNode
   override def copy(next: MetaData): Attribute
 
   override def remove(key: String): MetaData =
diff --git a/shared/src/main/scala/scala/xml/Elem.scala b/shared/src/main/scala/scala/xml/Elem.scala
@@ -30,7 +30,7 @@ object Elem {
   def unapplySeq(n: Node): Option[(String, String, MetaData, NamespaceBinding, ScalaVersionSpecific.SeqOfNode)] =
     n match {
       case _: SpecialNode | _: Group => None
-      case _                         => Some((n.prefix, n.label, n.attributes, n.scope, n.child.toSeq))
+      case _                         => Some((n.prefix, n.label, n.attributes, n.scope, n.child))
     }
 }
 
diff --git a/shared/src/main/scala/scala/xml/MetaData.scala b/shared/src/main/scala/scala/xml/MetaData.scala
@@ -85,6 +85,7 @@ abstract class MetaData
   with Iterable[MetaData]
   with Equality
   with Serializable
+  with ScalaVersionSpecificMetaData
 {
   private[xml] def isNull: Boolean = this.eq(Null)
 
@@ -106,7 +107,7 @@ abstract class MetaData
    * @param  key
    * @return value as Seq[Node] if key is found, null otherwise
    */
-  def apply(key: String): Seq[Node]
+  def apply(key: String): ScalaVersionSpecific.SeqOfNode
 
   /**
    * convenience method, same as `apply(namespace, owner.scope, key)`.
@@ -115,7 +116,7 @@ abstract class MetaData
    *  @param owner the element owning this attribute list
    *  @param key   the attribute key
    */
-  final def apply(namespace_uri: String, owner: Node, key: String): Seq[Node] =
+  final def apply(namespace_uri: String, owner: Node, key: String): ScalaVersionSpecific.SeqOfNode =
     apply(namespace_uri, owner.scope, key)
 
   /**
@@ -126,7 +127,7 @@ abstract class MetaData
    * @param  k   to be looked for
    * @return value as Seq[Node] if key is found, null otherwise
    */
-  def apply(namespace_uri: String, scp: NamespaceBinding, k: String): Seq[Node]
+  def apply(namespace_uri: String, scp: NamespaceBinding, k: String): ScalaVersionSpecific.SeqOfNode
 
   /**
    * returns a copy of this MetaData item with next field set to argument.
@@ -168,7 +169,7 @@ abstract class MetaData
   def key: String
 
   /** returns value of this MetaData item */
-  def value: Seq[Node]
+  def value: ScalaVersionSpecific.SeqOfNode
 
   /**
    * Returns a String containing "prefix:key" if the first key is
@@ -194,10 +195,10 @@ abstract class MetaData
    * @param  key
    * @return value in Some(Seq[Node]) if key is found, None otherwise
    */
-  final def get(key: String): Option[Seq[Node]] = Option(apply(key))
+  final def get(key: String): Option[ScalaVersionSpecific.SeqOfNode] = Option(apply(key))
 
   /** same as get(uri, owner.scope, key) */
-  final def get(uri: String, owner: Node, key: String): Option[Seq[Node]] =
+  final def get(uri: String, owner: Node, key: String): Option[ScalaVersionSpecific.SeqOfNode] =
     get(uri, owner.scope, key)
 
   /**
@@ -208,7 +209,7 @@ abstract class MetaData
    * @param  key to be looked fore
    * @return value as `Some[Seq[Node]]` if key is found, None otherwise
    */
-  final def get(uri: String, scope: NamespaceBinding, key: String): Option[Seq[Node]] =
+  final def get(uri: String, scope: NamespaceBinding, key: String): Option[ScalaVersionSpecific.SeqOfNode] =
     Option(apply(uri, scope, key))
 
   protected def toString1: String = sbToString(toString1)
diff --git a/shared/src/main/scala/scala/xml/Node.scala b/shared/src/main/scala/scala/xml/Node.scala
@@ -29,7 +29,7 @@ object Node {
   val EmptyNamespace: String = ""
 
   def unapplySeq(n: Node): Some[(String, MetaData, ScalaVersionSpecific.SeqOfNode)] =
-    Some((n.label, n.attributes, n.child.toSeq))
+    Some((n.label, n.attributes, n.child))
 }
 
 /**
@@ -92,7 +92,7 @@ abstract class Node extends NodeSeq with ScalaVersionSpecificNode {
    * @return value of `UnprefixedAttribute` with given key
    *         in attributes, if it exists, otherwise `null`.
    */
-  final def attribute(key: String): Option[Seq[Node]] = attributes.get(key)
+  final def attribute(key: String): Option[ScalaVersionSpecific.SeqOfNode] = attributes.get(key)
 
   /**
    * Convenience method, looks up a prefixed attribute in attributes of this node.
@@ -103,7 +103,7 @@ abstract class Node extends NodeSeq with ScalaVersionSpecificNode {
    * @return value of `PrefixedAttribute` with given namespace
    *         and given key, otherwise `'''null'''`.
    */
-  final def attribute(uri: String, key: String): Option[Seq[Node]] =
+  final def attribute(uri: String, key: String): Option[ScalaVersionSpecific.SeqOfNode] =
     attributes.get(uri, this, key)
 
   /**
diff --git a/shared/src/main/scala/scala/xml/Null.scala b/shared/src/main/scala/scala/xml/Null.scala
@@ -49,7 +49,7 @@ case object Null extends MetaData {
   override protected def basisForHashCode: Seq[Any] = Nil
 
   override def apply(namespace: String, scope: NamespaceBinding, key: String): ScalaVersionSpecificReturnTypes.NullApply3 = null
-  override def apply(key: String): ScalaVersionSpecificReturnTypes.NullApply1 =
+  override def apply(key: String): ScalaVersionSpecific.SeqOfNode =
     if (Utility.isNameStart(key.head)) null
     else throw new IllegalArgumentException(s"not a valid attribute name '$key', so can never match !")
 
diff --git a/shared/src/main/scala/scala/xml/PrefixedAttribute.scala b/shared/src/main/scala/scala/xml/PrefixedAttribute.scala
@@ -27,11 +27,13 @@ import scala.collection.Seq
 class PrefixedAttribute(
   override val pre: String,
   override val key: String,
-  override val value: Seq[Node],
+  _value: Seq[Node],
   val next1: MetaData
 )
   extends Attribute
 {
+  override val value: ScalaVersionSpecific.SeqOfNode = if (_value == null) null else _value.toSeq
+
   override val next: MetaData = if (value != null) next1 else next1.remove(key)
 
   /** same as this(pre, key, Text(value), next), or no attribute if value is null */
@@ -53,12 +55,12 @@ class PrefixedAttribute(
     owner.getNamespace(pre)
 
   /** forwards the call to next (because caller looks for unprefixed attribute */
-  override def apply(key: String): Seq[Node] = next(key)
+  override def apply(key: String): ScalaVersionSpecific.SeqOfNode = next(key)
 
   /**
    * gets attribute value of qualified (prefixed) attribute with given key
    */
-  override def apply(namespace: String, scope: NamespaceBinding, key: String): Seq[Node] =
+  override def apply(namespace: String, scope: NamespaceBinding, key: String): ScalaVersionSpecific.SeqOfNode =
     if (key == this.key && scope.getURI(pre) == namespace)
       value
     else
diff --git a/shared/src/main/scala/scala/xml/QNode.scala b/shared/src/main/scala/scala/xml/QNode.scala
@@ -21,5 +21,5 @@ package xml
  */
 object QNode {
   def unapplySeq(n: Node): Some[(String, String, MetaData, ScalaVersionSpecific.SeqOfNode)] =
-    Some((n.scope.getURI(n.prefix), n.label, n.attributes, n.child.toSeq))
+    Some((n.scope.getURI(n.prefix), n.label, n.attributes, n.child))
 }
diff --git a/shared/src/main/scala/scala/xml/UnprefixedAttribute.scala b/shared/src/main/scala/scala/xml/UnprefixedAttribute.scala
@@ -23,11 +23,13 @@ import scala.collection.Seq
 // Note: used by the Scala compiler.
 class UnprefixedAttribute(
   override val key: String,
-  override val value: Seq[Node],
+  _value: Seq[Node],
   next1: MetaData
 )
   extends Attribute
 {
+  override val value: ScalaVersionSpecific.SeqOfNode = if (_value == null) null else _value.toSeq
+
   final override val pre: scala.Null = null
   override val next: MetaData = if (value != null) next1 else next1.remove(key)
 
@@ -50,7 +52,7 @@ class UnprefixedAttribute(
    * @param  key
    * @return value as Seq[Node] if key is found, null otherwise
    */
-  override def apply(key: String): Seq[Node] =
+  override def apply(key: String): ScalaVersionSpecific.SeqOfNode =
     if (key == this.key) value else next(key)
 
   /**
@@ -61,7 +63,7 @@ class UnprefixedAttribute(
    * @param  key
    * @return ..
    */
-  override def apply(namespace: String, scope: NamespaceBinding, key: String): Seq[Node] =
+  override def apply(namespace: String, scope: NamespaceBinding, key: String): ScalaVersionSpecific.SeqOfNode =
     next(namespace, scope, key)
 }
 object UnprefixedAttribute {

Original file line number	Diff line number	Diff line change
`@@ -34,4 +34,6 @@ private[xml] trait ScalaVersionSpecificNodeBuffer { self: NodeBuffer =>`
`34`	`34`	`override def stringPrefix: String = "NodeBuffer"`
`35`	`35`	`}`
`36`	`36`
`37`		`-private[xml] trait ScalaVersionSpecificNode {self: Node => }`
	`37`	`+private[xml] trait ScalaVersionSpecificNode { self: Node => }`
	`38`	`+`
	`39`	`+private[xml] trait ScalaVersionSpecificMetaData { self: MetaData => }`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ object Elem {`
`30`	`30`	`def unapplySeq(n: Node): Option[(String, String, MetaData, NamespaceBinding, ScalaVersionSpecific.SeqOfNode)] =`
`31`	`31`	`n match {`
`32`	`32`	`case _: SpecialNode \| _: Group => None`
`33`		`- case _ => Some((n.prefix, n.label, n.attributes, n.scope, n.child.toSeq))`
	`33`	`+ case _ => Some((n.prefix, n.label, n.attributes, n.scope, n.child))`
`34`	`34`	`}`
`35`	`35`	`}`
`36`	`36`