Merge pull request #684 from lrytz/safeToString-backport

Backport stack safe toString to 1.x

Author: lrytz

.github/workflows/ci.yml

@@ -0,0 +1,25 @@
+name: test
+on:
+push:
+branches:
+ - main
+pull_request:
+jobs:
+test:
+strategy:
+fail-fast: false
+matrix:
+java: [8, 11, 17]
+scala: [2.11.x, 2.12.x, 2.13.x]
+runs-on: ubuntu-latest
+steps:
+ - uses: actions/checkout@v2
+with:
+fetch-depth: 0
+ - uses: actions/setup-java@v3
+with:
+distribution: temurin
+java-version: ${{matrix.java}}
+cache: sbt
+ - name: Test
+run: sbt ++${{matrix.scala}} test versionPolicyCheck package

.github/workflows/release.yml

@@ -0,0 +1,21 @@
+name: Release
+on:
+push:
+tags: ["*"]
+jobs:
+publish:
+runs-on: ubuntu-latest
+steps:
+ - uses: actions/checkout@v2
+with:
+fetch-depth: 0
+ - uses: actions/setup-java@v2
+with:
+distribution: temurin
+java-version: 8
+ - run: sbt versionCheck ci-release
+env:
+PGP_PASSPHRASE: ${{secrets.PGP_PASSPHRASE}}
+PGP_SECRET: ${{secrets.PGP_SECRET}}
+SONATYPE_PASSWORD: ${{secrets.SONATYPE_PASSWORD}}
+SONATYPE_USERNAME: ${{secrets.SONATYPE_USERNAME}}

.travis.yml

@@ -1,37 +1,55 @@
 importsbtcrossproject.CrossPlugin.autoImport.{crossProject, CrossType}
 
+publish / skip :=true// root project
+
+ThisBuild/ startYear :=Some(2002)
+ThisBuild/ licenses += (("Apache-2.0", url("https://www.apache.org/licenses/LICENSE-2.0")))
+
+// because it doesn't declare it itself
+ThisBuild/ libraryDependencySchemes +="org.scala-js"%%"scalajs-library"%"semver-spec"
+ThisBuild/ apiURL :=Some(url("https://javadoc.io/doc/org.scala-lang.modules/scala-xml_2.13/"))
+
+lazyvalconfigSettings:Seq[Setting[?]] =Seq(
+ unmanagedSourceDirectories ++={
+ unmanagedSourceDirectories.value.flatMap{dir =>
+defforVersion(version: String):File= file(dir.getPath ++"-"++ version)
+CrossVersion.partialVersion(scalaVersion.value) match{
+caseSome((2, 13)) =>Seq(forVersion("2.13"))
+case _ =>Seq(forVersion("2.11-2.12"))
+ }
+ }
+ }
+)
+
 lazyvalxml= crossProject(JSPlatform, JVMPlatform)
  .withoutSuffixFor(JVMPlatform)
  .crossType(CrossType.Full)
  .in(file("."))
  .settings(ScalaModulePlugin.scalaModuleSettings)
- .jvmSettings(ScalaModulePlugin.scalaModuleSettingsJVM)
+ .jvmSettings(ScalaModulePlugin.scalaModuleOsgiSettings)
  .settings(
  name :="scala-xml",
+ scalaModuleAutomaticModuleName :=Some("scala.xml"),
+ crossScalaVersions :=Seq("2.13.11", "2.12.18", "2.11.12"),
+ scalaVersion :="2.12.18",
 
-// Compiler team advised avoiding the -Xfuture option for releases.
-// The output with -Xfuture should be periodically checked, though.
- scalacOptions ++="-deprecation:false -feature -Xlint:-stars-align,-nullary-unit,_".split("\\s+").to[Seq],
- scalacOptions in Test+="-Xxml:coalescing",
+ scalacOptions ++=Seq("-deprecation:false", "-feature", "-Xlint:-stars-align,-nullary-unit,_"),
 
- scalaModuleMimaPreviousVersion :={
-if (System.getenv("SCALAJS_VERSION") =="1.0.1") None
-elseSome("1.2.0")
- },
+Test/ scalacOptions +="-Xxml:coalescing",
 
- unmanagedSourceDirectories in Compile++={
- (unmanagedSourceDirectories in Compile).value.map{dir =>
-valsv= scalaVersion.value
-CrossVersion.partialVersion(sv) match{
-caseSome((2, 13)) => file(dir.getPath ++"-2.13")
-case _ => file(dir.getPath ++"-2.11-2.12")
- }
- }
- },
+ headerLicense :=Some(HeaderLicense.Custom(
+s"""|Scala (https://www.scala-lang.org)
+ |
+ |Copyright EPFL and Lightbend, Inc.
+ |
+ |Licensed under Apache License 2.0
+ |(http://www.apache.org/licenses/LICENSE-2.0).
+ |
+ |See the NOTICE file distributed with this work for
+ |additional information regarding copyright ownership.
+ |""".stripMargin)),
 
- apiURL :=Some(
- url(s"""https://scala.github.io/scala-xml/api/${"-.*".r.replaceAllIn(version.value, "")}/""")
- ),
+ versionPolicyIntention :=Compatibility.BinaryCompatible,
 
  apiMappings ++= scalaInstance.value.libraryJars.filter{file =>
  file.getName.startsWith("scala-library") && file.getName.endsWith(".jar")
@@ -47,7 +65,7 @@ lazy val xml = crossProject(JSPlatform, JVMPlatform)
  file(jarPath)
 -> url("http://docs.oracle.com/javase/8/docs/api")
  )
- }getOrElse{
+ }.getOrElse{
 // If everything fails, jam in Java 11 modules.
 Map(
  file("/modules/java.base")
@@ -58,16 +76,20 @@ lazy val xml = crossProject(JSPlatform, JVMPlatform)
  }
  }
  )
+ .settings(
+ inConfig(Compile)(configSettings) ++ inConfig(Test)(configSettings)
+ )
  .jvmSettings(
 OsgiKeys.exportPackage :=Seq(s"scala.xml.*;version=${version.value}"),
 
- libraryDependencies +="junit"%"junit"%"4.13"%"test",
- libraryDependencies +="com.novocode"%"junit-interface"%"0.11"%"test",
- libraryDependencies +="org.apache.commons"%"commons-lang3"%"3.9"%"test",
- libraryDependencies += ("org.scala-lang"%"scala-compiler"% scalaVersion.value %"test").exclude("org.scala-lang.modules", s"scala-xml_${scalaBinaryVersion.value}")
+ libraryDependencies +="junit"%"junit"%"4.13.2"%Test,
+ libraryDependencies +="com.github.sbt"%"junit-interface"%"0.13.3"%Test,
+ libraryDependencies +="org.apache.commons"%"commons-lang3"%"3.12.0"%Test,
+ libraryDependencies += ("org.scala-lang"%"scala-compiler"% scalaVersion.value %Test).exclude("org.scala-lang.modules", s"scala-xml_${scalaBinaryVersion.value}")
  )
  .jsSettings(
+ crossScalaVersions := crossScalaVersions.value.filterNot(_.startsWith("2.11")),
 // Scala.js cannot run forked tests
-fork in Test:=false
+Test/ fork:=false
  )
- .jsConfigure(_.enablePlugins(ScalaJSJUnitPlugin))
+ .jsEnablePlugins(ScalaJSJUnitPlugin)

build.sbt

@@ -1 +1 @@
-sbt.version=1.3.13
+sbt.version=1.9.2

build.sh

@@ -1,6 +1,6 @@
-valscalaJSVersion=
-Option(System.getenv("SCALAJS_VERSION")).filter(_.nonEmpty).getOrElse("0.6.33")
-
-addSbtPlugin("org.scala-lang.modules"%"sbt-scala-module"%"2.1.3")
-addSbtPlugin("org.portable-scala"%"sbt-scalajs-crossproject"%"1.0.0")
-addSbtPlugin("org.scala-js"%"sbt-scalajs"%scalaJSVersion)
+addSbtPlugin("org.scala-lang.modules"%"sbt-scala-module"%"3.1.0")
+addSbtPlugin("org.portable-scala"%"sbt-scalajs-crossproject"%"1.3.2")
+addSbtPlugin("org.portable-scala"%"sbt-scala-native-crossproject"%"1.3.2")
+addSbtPlugin("org.scala-js"%"sbt-scalajs"%"1.13.2")
+addSbtPlugin("org.scala-native"%"sbt-scala-native"%"0.4.14")
+addSbtPlugin("de.heikoseeberger"%"sbt-header"%"5.10.0")

project/build.properties

@@ -9,6 +9,7 @@
 packagescala
 packagexml
 
+importscala.annotation.tailrec
 importscala.collection.mutable
 importscala.language.implicitConversions
 importscala.collection.Seq
@@ -187,9 +188,7 @@ object Utility extends AnyRef with parsing.TokenTests{
 decodeEntities: Boolean=true,
 preserveWhitespace: Boolean=false,
 minimizeTags: Boolean=false):StringBuilder=
-{
  serialize(x, pscope, sb, stripComments, decodeEntities, preserveWhitespace, if (minimizeTags) MinimizeMode.AlwayselseMinimizeMode.Never)
- }
 
 /**
  * Serialize an XML Node to a StringBuilder.
@@ -206,35 +205,66 @@ object Utility extends AnyRef with parsing.TokenTests{
 stripComments: Boolean=false,
 decodeEntities: Boolean=true,
 preserveWhitespace: Boolean=false,
-minimizeTags: MinimizeMode.Value=MinimizeMode.Default):StringBuilder=
-{
- x match{
-casec: Comment=>if (!stripComments) c buildString sb; sb
-cases: SpecialNode=> s buildString sb
-caseg: Group=>
-for (c <- g.nodes) serialize(c, g.scope, sb, stripComments, decodeEntities, preserveWhitespace, minimizeTags); sb
-caseel: Elem=>
-// print tag with namespace declarations
- sb.append('<')
- el.nameToString(sb)
-if (el.attributes ne null) el.attributes.buildString(sb)
- el.scope.buildString(sb, pscope)
-if (el.child.isEmpty &&
- (minimizeTags ==MinimizeMode.Always||
- (minimizeTags ==MinimizeMode.Default&& el.minimizeEmpty))){
-// no children, so use short form: <xyz .../>
- sb.append("/>")
- } else{
-// children, so use long form: <xyz ...>...</xyz>
- sb.append('>')
- sequenceToXML(el.child, el.scope, sb, stripComments, decodeEntities, preserveWhitespace, minimizeTags)
- sb.append("</")
- el.nameToString(sb)
- sb.append('>')
- }
-case _ =>thrownewIllegalArgumentException("Don't know how to serialize a "+ x.getClass.getName)
- }
+minimizeTags: MinimizeMode.Value=MinimizeMode.Default
+ ):StringBuilder={
+ serializeImpl(List(x), pscope, false, stripComments, minimizeTags, sb)
+ sb
+ }
+
+privatedefserializeImpl(
+ns: Seq[Node],
+pscope: NamespaceBinding,
+spaced: Boolean,
+stripComments: Boolean,
+minimizeTags: MinimizeMode.Value,
+sb: StringBuilder
+ ):Unit={
+@tailrec defser(nss: List[List[Node]], pscopes: List[NamespaceBinding], spaced: List[Boolean], toClose: List[Node]):Unit= nss match{
+caseList(Nil) =>
+caseNil:: rests =>
+if (toClose.head !=null){
+ sb.append("</")
+ toClose.head.nameToString(sb)
+ sb.append('>')
+ }
+ ser(rests, pscopes.tail, spaced.tail, toClose.tail)
+case (n :: ns) :: r =>
+defsp():Unit=if (ns.nonEmpty && spaced.head) sb.append(' ')
+ n match{
+casec: Comment=>
+if (!stripComments){
+ c.buildString(sb)
+ sp()
+ }
+ ser(ns :: r, pscopes, spaced, toClose)
+cases: SpecialNode=>
+ s.buildString(sb)
+ sp()
+ ser(ns :: r, pscopes, spaced, toClose)
+caseg: Group=>
+ ser(g.nodes.toList :: ns :: r, g.scope :: pscopes, false:: spaced, null:: toClose)
+casee: Elem=>
+ sb.append('<')
+ e.nameToString(sb)
+if (e.attributes.ne(null)) e.attributes.buildString(sb)
+ e.scope.buildString(sb, pscopes.head)
+if (e.child.isEmpty &&
+ (minimizeTags ==MinimizeMode.Always||
+ (minimizeTags ==MinimizeMode.Default&& e.minimizeEmpty))){
+// no children, so use short form: <xyz .../>
+ sb.append("/>")
+ sp()
+ ser(ns :: r, pscopes, spaced, toClose)
+ } else{
+ sb.append('>')
+valcsp= e.child.forall(isAtomAndNotText)
+ ser(e.child.toList :: ns :: r, e.scope :: pscopes, csp :: spaced, e :: toClose)
+ }
+case n =>thrownewIllegalArgumentException("Don't know how to serialize a "+ n.getClass.getName)
+ }
  }
+ ser(List(ns.toList), List(pscope), List(spaced), Nil)
+ }
 
 defsequenceToXML(
 children: Seq[Node],
@@ -243,20 +273,11 @@ object Utility extends AnyRef with parsing.TokenTests{
 stripComments: Boolean=false,
 decodeEntities: Boolean=true,
 preserveWhitespace: Boolean=false,
-minimizeTags: MinimizeMode.Value=MinimizeMode.Default):Unit=
-{
-if (children.isEmpty) return
-elseif (children forall isAtomAndNotText){// add space
-valit= children.iterator
-valf= it.next()
- serialize(f, pscope, sb, stripComments, decodeEntities, preserveWhitespace, minimizeTags)
-while (it.hasNext){
-valx= it.next()
- sb.append(' ')
- serialize(x, pscope, sb, stripComments, decodeEntities, preserveWhitespace, minimizeTags)
- }
- } else children foreach{serialize(_, pscope, sb, stripComments, decodeEntities, preserveWhitespace, minimizeTags) }
- }
+minimizeTags: MinimizeMode.Value=MinimizeMode.Default
+ ):Unit=if (children.nonEmpty){
+valspaced= children.forall(isAtomAndNotText)
+ serializeImpl(children, pscope, spaced, stripComments, minimizeTags, sb)
+ }
 
 /**
  * Returns prefix of qualified name if any.