Fixes and optimization

- Cache dri -> path transformations
- compute graphs on demand not on initialization
- change writter to writer

Author: romanowski

scala3doc/src/dotty/dokka/DRI.scala

@@ -17,5 +17,8 @@ final case class DRI(
 
   def isStaticFile = symbolUUID == staticFileSymbolUUID
 
+  def asFileLocation: String = location.replace(".","/")
+
 object DRI:
-  def forPath(path: Path) = DRI(location = path.toString, symbolUUID = staticFileSymbolUUID)
+  def forPath(path: Path) =
+    DRI(location = path.toString, symbolUUID = staticFileSymbolUUID)

scala3doc/src/dotty/dokka/SourceLinks.scala

@@ -156,7 +156,6 @@ object SourceLinks:
       revision: Option[String],
       projectRoot: Path)(
       using Context): SourceLinks =
-    // TODO ...
     val mappings = configs.map(str => str -> SourceLink.parse(str, revision))
 
     val errors = mappings.collect {

scala3doc/src/dotty/dokka/model/api/api.scala

@@ -129,8 +129,8 @@ extension (s: Signature)
 
 case class LinkToType(signature: Signature, dri: DRI, kind: Kind)
 case class HierarchyGraph(edges: Seq[(LinkToType, LinkToType)]):
-  def vertecies: Seq[LinkToType] = edges.flatten((a, b) => Seq(a, b)).distinct
-  val verteciesWithId: Map[LinkToType, Int] = vertecies.zipWithIndex.toMap
+  private def vertecies: Seq[LinkToType] = edges.flatten((a, b) => Seq(a, b)).distinct
+  def verteciesWithId: Map[LinkToType, Int] = vertecies.zipWithIndex.toMap
   def +(edge: (LinkToType, LinkToType)): HierarchyGraph = HierarchyGraph((edges :+ edge).distinct)
   def ++(edges: Seq[(LinkToType, LinkToType)]): HierarchyGraph = edges.foldLeft(this) {
     case (acc, edge) => acc + edge

scala3doc/src/dotty/dokka/site/StaticSiteContext.scala

@@ -143,7 +143,7 @@ class StaticSiteContext(
       val strippedIndexes = trySuffix("index.html") ++ trySuffix("index.md")
 
       (Seq(baseFile, mdFile) ++ strippedIndexes).filter(Files.exists(_)).map(driFor)
-    }.toOption
+    }.toOption.filter(_.nonEmpty)
     pathsDri.getOrElse(memberLinkResolver(link).toList)
 
   def driFor(dest: Path): DRI =

scala3doc/src/dotty/dokka/tasty/TastyParser.scala

@@ -83,7 +83,8 @@ case class DokkaTastyInspector()(using ctx: DocContext) extends DocTastyInspecto
       import symOps._
       Try(QueryParser(link).readQuery()).toOption.flatMap(q =>
         MemberLookup.lookupOpt(q, None).map{ case (sym, _) => sym.dri}
-    )
+      )
+
     ctx.staticSiteContext.foreach(_.memberLinkResolver = driFor)
 
     var alreadyProcessed = false

scala3doc/src/dotty/renderers/HtmlRenderer.scala

@@ -25,7 +25,7 @@ case class Page(link: Link, content: Member | ResolvedTemplate | String, childre
     case _ => true
 
 class HtmlRenderer(rootPackage: Member, val members: Map[DRI, Member])(using ctx: DocContext)
-  extends SiteRenderer, Resources, Locations, Writter:
+  extends SiteRenderer, Resources, Locations, Writer:
   private val args = summon[DocContext].args
   val staticSite = summon[DocContext].staticSiteContext
 

scala3doc/src/dotty/renderers/Locations.scala

@@ -20,21 +20,28 @@ val UnresolvedLocationLink = "#"
 trait Locations(using ctx: DocContext):
   def members: Map[DRI, Member]
 
+  var cache = new JHashMap[DRI, Seq[String]]()
+
   // TODO verify if location exisits
   def rawLocation(dri: DRI): Seq[String] =
-    dri match
-      case `docsDRI` => List("docs", "index")
-      case `docsRootDRI` => List("index")
-      case `apiPageDRI` => List("api", "index")
-      case dri if dri.isStaticFile =>
-        Paths.get(dri.location).iterator.asScala.map(_.toString).toList
-      case dri =>
-        val loc = dri.location
-        val fqn = loc.split(Array('.')).toList match
-          case List("<empty>") => List("index")
-          case other => other
-
-        Seq("api") ++ fqn
+    cache.get(dri) match
+      case null =>
+        val path = dri match
+          case `docsDRI` => List("docs", "index")
+          case `docsRootDRI` => List("index")
+          case `apiPageDRI` => List("api", "index")
+          case dri if dri.isStaticFile =>
+            Paths.get(dri.location).iterator.asScala.map(_.toString).toList
+          case dri =>
+            val loc = dri.location
+            val fqn = loc.split(Array('.')).toList match
+              case List("<empty>") => List("index")
+              case other => other
+
+            Seq("api") ++ fqn
+        cache.put(dri, path)
+        path
+      case cached => cached
 
   private def unknownPage(dri: DRI): String =
     // TODO we should switch that to warning probably or has dedicated setting
@@ -93,17 +100,12 @@ trait Locations(using ctx: DocContext):
     }
 
     //TODO #263: Add anchor support
-    def constructPathForScaladoc(dri: DRI): String = {
-      val location = dri.location.replace(".","/")
-      val anchor = dri.anchor
-      docURL + location + extension
-    }
+    def constructPathForScaladoc(dri: DRI): String =
+      docURL + dri.asFileLocation + extension
 
-    def constructPathForScala3doc(dri: DRI): String = {
-      val location = dri.location.replace(".","/")
-      val anchor = dri.anchor
-      docURL + location + extension
-    }
+    // TODO Add tests for it!
+    def constructPathForScala3doc(dri: DRI): String =
+      docURL + dri.asFileLocation + extension + "#" + dri.anchor
 
     link.kind match {
       case DocumentationKind.Javadoc => constructPathForJavadoc(dri)

scala3doc/src/dotty/renderers/Resources.scala

@@ -22,7 +22,7 @@ enum Resource(val path: String):
   case File(override val path: String, file: Path) extends Resource(path)
   case URL(url: String) extends Resource(url)
 
-trait Resources(using ctx: DocContext) extends Locations, Writter:
+trait Resources(using ctx: DocContext) extends Locations, Writer:
   private def dynamicJsData =
     // If data at any point will become more complex we should use a proper mapping
     val data: Map[String, Map[String, String]] =
@@ -109,7 +109,7 @@ trait Resources(using ctx: DocContext) extends Locations, Writter:
     def processPage(page: Page): Seq[PageEntry] =
       val res =  page.content match
         case m: Member =>
-          val descr = m.dri.location.replace("/", ".")
+          val descr = m.dri.asFileLocation
           def processMember(member: Member): Seq[PageEntry] =
             val signatureBuilder = ScalaSignatureProvider.rawSignature(member, InlineSignatureBuilder()).asInstanceOf[InlineSignatureBuilder]
             val sig = Signature(member.kind.name, " ") ++ Seq(Link(member.name, member.dri)) ++ signatureBuilder.names.reverse

scala3doc/src/dotty/renderers/SiteRenderer.scala

@@ -29,7 +29,7 @@ trait SiteRenderer(using DocContext) extends Locations:
 
   def siteContent(pageDri: DRI, content: ResolvedTemplate): AppliedTag =
     import content.ctx
-    def tryAsDri(str: String) = // TODO Does not seem to work with links to API :(
+    def tryAsDri(str: String) =
       val (path, prefix) = str match
         case HashRegex(path, prefix) => (path, prefix)
         case _ => (str, "")
@@ -51,5 +51,5 @@ trait SiteRenderer(using DocContext) extends Locations:
       Try(new URL(link)).getOrElse {
         if(link.startsWith("/")) element.attr("src", resolveLink(pageDri, link.drop(1)))
       }
-    }// forrach does not work here
+    }// foreach does not work here
     raw(document.outerHtml())

scala3doc/src/dotty/renderers/Writter.scala

@@ -9,7 +9,7 @@ import java.io.File
 import HTML._
 
 // TODO be more clever about writting - make it much faster!
-trait Writter(using ctx: DocContext) extends Locations:
+trait Writer(using ctx: DocContext) extends Locations:
   private val args = summon[DocContext].args
 
   private def dest(path: String) =

scala3doc/test-documentations/basic/docs/Adoc.md

@@ -3,4 +3,6 @@ title: Adoc
 ---
 # Header in Adoc
 
+[[tests.site.SomeClass]]
+
 And a text!

scala3doc/test/dotty/dokka/site/SiteGeneratationTest.scala

@@ -32,7 +32,6 @@ class SiteGeneratationTest extends BaseHtmlTest:
       }
 
   def testDocPages()(using ProjectContext) =
-    checkFile("docs/Adoc.html")(title = "Adoc", header = "Header in Adoc", parents = Seq(projectName))
     checkFile("docs/Adoc.html")(title = "Adoc", header = "Header in Adoc", parents = Seq(projectName))
     checkFile("docs/dir/index.html")(title = "A directory", header = "A directory", parents = Seq(projectName))
     checkFile("docs/dir/nested.html")(
@@ -69,6 +68,10 @@ class SiteGeneratationTest extends BaseHtmlTest:
     testDocIndexPage()
     testMainIndexPage()
     testApiPages()
+
+    withHtmlFile("docs/Adoc.html"){ content  =>
+        content.assertAttr("p a","href", "../api/tests/site/SomeClass.html")
+      }
   }
 
   @Test