Scaladoc: Fix locations of members with slashes

Author: pikinier20

scaladoc-testcases/src/tests/externalLocations/externalStubs.scala

@@ -0,0 +1,5 @@
+package tests.externalStubs
+
+trait \/
+
+trait /\

scaladoc-testcases/src/tests/externalLocations/scaladoc2.scala

@@ -1,6 +1,8 @@
-package tests.externalScaladoc2
+package tests
+package externalScaladoc2
 
 import scala.util.matching.*
+import externalStubs._
 
 class Test {
   def a: String = ???
@@ -10,5 +12,7 @@ class Test {
   def c: Regex.Match = ???
 }
 
+class Test2 extends \/ with /\
+
 abstract class MySeq[T] extends scala.collection.immutable.Seq[T]
 

scaladoc-testcases/src/tests/externalLocations/scaladoc3.scala

@@ -1,6 +1,8 @@
-package tests.externalScaladoc3
+package tests
+package externalScaladoc3
 
 import scala.util.matching.*
+import externalStubs._
 
 class Test {
   def a: String = ???
@@ -10,3 +12,5 @@ class Test {
   def c: Regex.Match = ???
 }
 
+class Test2 extends \/ with /\
+

scaladoc-testcases/src/tests/slashMembers.scala

@@ -0,0 +1,8 @@
+package tests
+package slashMembers
+
+class A
+
+trait \/
+
+trait /\

scaladoc/src/dotty/tools/scaladoc/renderers/Locations.scala

@@ -13,6 +13,7 @@ import java.nio.file.Path
 import java.nio.file.Files
 import java.io.File
 import scala.util.matching._
+import dotty.tools.scaladoc.util.Escape._
 
 val UnresolvedLocationLink = "#"
 

scaladoc/src/dotty/tools/scaladoc/tasty/SymOps.scala

@@ -261,7 +261,7 @@ class SymOpsWithLinkCache:
         else
           (sym.className, sym.anchor)
 
-        val location = sym.packageNameSplitted ++ className
+        val location = (sym.packageNameSplitted ++ className).map(escapeFilename(_))
 
         val externalLink = {
             import reflect._

scaladoc/src/dotty/tools/scaladoc/util/escape.scala

@@ -1,4 +1,11 @@
 package dotty.tools.scaladoc.util
 
 object Escape:
-  def escapeUrl(url: String) = url.replace("#","%23")
+  def escapeUrl(url: String) = url
+    .replace("#","%23")
+
+  def escapeFilename(filename: String) =
+    val escaped = filename
+      .replace("/", "$div")
+      .replace("\\", "$bslash")
+    if escaped != filename then escaped + "$" else escaped

scaladoc/test/dotty/tools/scaladoc/ExternalLocationProviderIntegrationTest.scala

@@ -25,23 +25,33 @@ class JavadocExternalLocationProviderIntegrationTest extends ExternalLocationPro
 
 class Scaladoc2ExternalLocationProviderIntegrationTest extends ExternalLocationProviderIntegrationTest(
   "externalScaladoc2",
-  List(".*scala.*::scaladoc2::https://www.scala-lang.org/api/current/"),
+  List(
+    ".*scala/.*::scaladoc2::https://www.scala-lang.org/api/current/",
+    ".*externalStubs.*::scaladoc2::https://external.stubs/api/"
+  ),
   List(
     "https://www.scala-lang.org/api/current/scala/util/matching/Regex$$Match.html",
     "https://www.scala-lang.org/api/current/scala/Predef$.html#String",
     "https://www.scala-lang.org/api/current/scala/collection/immutable/Map.html",
     "https://www.scala-lang.org/api/current/scala/collection/IterableOnceOps.html#addString(b:StringBuilder,start:String,sep:String,end:String):StringBuilder",
-    "https://www.scala-lang.org/api/current/scala/collection/IterableOnceOps.html#mkString(start:String,sep:String,end:String):String"
+    "https://www.scala-lang.org/api/current/scala/collection/IterableOnceOps.html#mkString(start:String,sep:String,end:String):String",
+    "https://external.stubs/api/tests/externalStubs/$div$bslash$.html",
+    "https://external.stubs/api/tests/externalStubs/$bslash$div$.html"
   )
 )
 
 class Scaladoc3ExternalLocationProviderIntegrationTest extends ExternalLocationProviderIntegrationTest(
   "externalScaladoc3",
-  List(".*scala.*::scaladoc3::https://dotty.epfl.ch/api/"),
+  List(
+    ".*scala/.*::scaladoc3::https://dotty.epfl.ch/api/",
+    ".*externalStubs.*::scaladoc3::https://external.stubs/api/"
+  ),
   List(
     "https://dotty.epfl.ch/api/scala/collection/immutable/Map.html",
     "https://dotty.epfl.ch/api/scala/Predef$.html#String-0",
-    "https://dotty.epfl.ch/api/scala/util/matching/Regex$$Match.html"
+    "https://dotty.epfl.ch/api/scala/util/matching/Regex$$Match.html",
+    "https://external.stubs/api/tests/externalStubs/$div$bslash$.html",
+    "https://external.stubs/api/tests/externalStubs/$bslash$div$.html"
   )
 )