hack support for member links in static pages

romanowski · romanowski · commit 35598dc7badf · 2020-11-16T10:50:22.000+01:00
To not refactor half of model I needed to use a var that accepts lambda. We should probably find better way to do it (probably by processing TASTY before we start dokka)

Add local alias for DRI
diff --git a/scala3doc/src/dotty/dokka/DottyDokkaPlugin.scala b/scala3doc/src/dotty/dokka/DottyDokkaPlugin.scala
@@ -9,7 +9,6 @@ import org.jetbrains.dokka.transformers.documentation.DocumentableToPageTranslat
 import org.jetbrains.dokka.DokkaConfiguration
 import org.jetbrains.dokka.{ DokkaConfiguration$DokkaSourceSet => DokkaSourceSet }
 import org.jetbrains.dokka.model._
-import org.jetbrains.dokka.links._
 import org.jetbrains.dokka.model.doc._
 import org.jetbrains.dokka.base.parsers._
 import org.jetbrains.dokka.plugability.DokkaContext
diff --git a/scala3doc/src/dotty/dokka/ScalaModuleCreator.scala b/scala3doc/src/dotty/dokka/ScalaModuleCreator.scala
@@ -10,7 +10,6 @@ import dotty.dokka.tasty.{DokkaTastyInspector, SbtDokkaTastyInspector}
 import org.jetbrains.dokka.pages._
 import dotty.dokka.model.api._
 import org.jetbrains.dokka.model._
-import org.jetbrains.dokka.links.DRI
 import org.jetbrains.dokka.base.parsers.MarkdownParser
 import collection.JavaConverters._
 import kotlin.coroutines.Continuation
diff --git a/scala3doc/src/dotty/dokka/compat.scala b/scala3doc/src/dotty/dokka/compat.scala
@@ -1,6 +1,6 @@
 package dotty.dokka
 
-import org.jetbrains.dokka.links.{DRI, PointingToDeclaration}
+import org.jetbrains.dokka.links.PointingToDeclaration
 import org.jetbrains.dokka.DokkaConfiguration
 import org.jetbrains.dokka.DokkaConfiguration$DokkaSourceSet
 import collection.JavaConverters._
@@ -28,6 +28,8 @@ type JMap[K, V] = java.util.Map[K, V]
 type JHashMap[K, V] = java.util.HashMap[K, V]
 type JMapEntry[K, V] = java.util.Map.Entry[K, V]
 
+type DRI = org.jetbrains.dokka.links.DRI
+
 type SourceSetWrapper = DokkaConfiguration$DokkaSourceSet
 type DokkaSourceSet = DokkaConfiguration.DokkaSourceSet
 
diff --git a/scala3doc/src/dotty/dokka/model/api/api.scala b/scala3doc/src/dotty/dokka/model/api/api.scala
@@ -3,10 +3,8 @@ package model
 package api
 
 import org.jetbrains.dokka.DokkaConfiguration$DokkaSourceSet
-import org.jetbrains.dokka.links._
 import org.jetbrains.dokka.model._
 import collection.JavaConverters._
-import org.jetbrains.dokka.links._
 import org.jetbrains.dokka.model.doc._
 import org.jetbrains.dokka.model.properties._
 import org.jetbrains.dokka.pages._
diff --git a/scala3doc/src/dotty/dokka/model/api/internalExtensions.scala b/scala3doc/src/dotty/dokka/model/api/internalExtensions.scala
@@ -3,7 +3,6 @@ package model
 package api
 
 import org.jetbrains.dokka.DokkaConfiguration$DokkaSourceSet
-import org.jetbrains.dokka.links._
 import org.jetbrains.dokka.model.{Projection => JProjection}
 import org.jetbrains.dokka.model.Documentable
 import org.jetbrains.dokka.model.DFunction
@@ -18,7 +17,6 @@ import org.jetbrains.dokka.model.DPackage
 import org.jetbrains.dokka.model.DModule
 
 import collection.JavaConverters._
-import org.jetbrains.dokka.links._
 import org.jetbrains.dokka.model.doc.DocumentationNode
 import org.jetbrains.dokka.model.properties._
 
diff --git a/scala3doc/src/dotty/dokka/model/extras.scala b/scala3doc/src/dotty/dokka/model/extras.scala
@@ -1,12 +1,10 @@
 package dotty.dokka
 
 import org.jetbrains.dokka.DokkaConfiguration$DokkaSourceSet
-import org.jetbrains.dokka.links._
 import org.jetbrains.dokka.model.{Projection => JProjection}
 import org.jetbrains.dokka.model._
 import org.jetbrains.dokka.pages._
 import collection.JavaConverters._
-import org.jetbrains.dokka.links._
 import org.jetbrains.dokka.model.doc._
 import org.jetbrains.dokka.model.properties._
 import dotty.dokka.model.api._
diff --git a/scala3doc/src/dotty/dokka/model/scalaModel.scala b/scala3doc/src/dotty/dokka/model/scalaModel.scala
@@ -1,10 +1,8 @@
 package dotty.dokka
 
 import org.jetbrains.dokka.DokkaConfiguration$DokkaSourceSet
-import org.jetbrains.dokka.links._
 import org.jetbrains.dokka.model._
 import collection.JavaConverters._
-import org.jetbrains.dokka.links._
 import org.jetbrains.dokka.model.doc._
 import org.jetbrains.dokka.model.properties._
 import org.jetbrains.dokka.pages._
diff --git a/scala3doc/src/dotty/dokka/site/LoadedTemplate.scala b/scala3doc/src/dotty/dokka/site/LoadedTemplate.scala
@@ -5,7 +5,6 @@ import java.io.File
 import java.nio.file.Files
 
 import org.jetbrains.dokka.base.renderers.html.{NavigationNode, NavigationPage}
-import org.jetbrains.dokka.links.DRI
 import org.jetbrains.dokka.model.Documentable
 import org.jetbrains.dokka.pages._
 import org.jetbrains.dokka.transformers.pages.PageTransformer
diff --git a/scala3doc/src/dotty/dokka/site/StaticPageNode.scala b/scala3doc/src/dotty/dokka/site/StaticPageNode.scala
@@ -5,7 +5,6 @@ import java.io.File
 import java.nio.file.Files
 
 import org.jetbrains.dokka.base.renderers.html.{NavigationNode, NavigationPage}
-import org.jetbrains.dokka.links.DRI
 import org.jetbrains.dokka.model.Documentable
 import org.jetbrains.dokka.pages._
 import org.jetbrains.dokka.transformers.pages.PageTransformer
diff --git a/scala3doc/src/dotty/dokka/site/StaticSiteContext.scala b/scala3doc/src/dotty/dokka/site/StaticSiteContext.scala
@@ -10,7 +10,6 @@ import java.nio.file.Paths
 import org.jetbrains.dokka.base.parsers.MarkdownParser
 import org.jetbrains.dokka.base.transformers.pages.comments.DocTagToContentConverter
 import org.jetbrains.dokka.DokkaConfiguration
-import org.jetbrains.dokka.links.DRI
 import org.jetbrains.dokka.model.doc.{DocTag, Text}
 import org.jetbrains.dokka.model.properties.PropertyContainer
 import org.jetbrains.dokka.pages.{ContentKind, ContentNode, DCI, PageNode}
@@ -23,6 +22,8 @@ import scala.collection.JavaConverters._
 
 class StaticSiteContext(val root: File, sourceSets: Set[SourceSetWrapper]):
 
+  var memberLinkResolver: String => Option[DRI] = _ => None
+
   def indexPage():Option[StaticPageNode] =
     val files = List(new File(root, "index.html"), new File(root, "index.md")).filter { _.exists() }
     // TODO (https://github.com/lampepfl/scala3doc/issues/238): provide proper error handling
@@ -127,10 +128,14 @@ class StaticSiteContext(val root: File, sourceSets: Set[SourceSetWrapper]):
     dir("docs").flatMap(_.listFiles()).flatMap(loadTemplate(_, isBlog = false))
       ++ dir("blog").flatMap(loadTemplate(_, isBlog = true))
 
-  def driForLink(template: TemplateFile, link: String): Try[DRI] = Try(driFor(
+  def driForLink(template: TemplateFile, link: String): Option[DRI] =
+    val pathDri = Try {
+      val path =
         if link.startsWith("/") then root.toPath.resolve(link.drop(1))
         else template.file.toPath.getParent().resolve(link)
-    ))
+      if Files.exists(path) then Some(driFor(path)) else None
+    }.toOption.flatten
+    pathDri.orElse(memberLinkResolver(link))
 
   def driFor(dest: Path): DRI = mkDRI(s"_.${root.toPath.relativize(dest)}")
 
diff --git a/scala3doc/src/dotty/dokka/site/common.scala b/scala3doc/src/dotty/dokka/site/common.scala
@@ -13,7 +13,6 @@ import com.vladsch.flexmark.ext.tables.TablesExtension
 import com.vladsch.flexmark.ext.yaml.front.matter.{AbstractYamlFrontMatterVisitor, YamlFrontMatterExtension}
 import com.vladsch.flexmark.parser.{Parser, ParserEmulationProfile}
 import com.vladsch.flexmark.util.options.{DataHolder, MutableDataSet}
-import org.jetbrains.dokka.links.{DRI, PointingToDeclaration}
 import org.jetbrains.dokka.model.doc.Text
 
 import scala.collection.JavaConverters._
@@ -84,11 +83,11 @@ def loadTemplateFile(file: File): TemplateFile = {
     case elem: String => elem
     case other => throw new RuntimeException(s"Expected a string setting for $name in $file but got $other")
   }.map(_.stripPrefix("\"").stripSuffix("\""))
-  
+
   def listSetting(settings: Map[String, Object], name: String): Option[List[String]] = settings.get(name).map {
     case elems: List[_] => elems.zipWithIndex.map {
       case (s: String, _) => s
-      case (other, index) => 
+      case (other, index) =>
         throw new RuntimeException(s"Expected a string at index $index for $name in $file but got $other")
     }
     case elem: String => List(elem)
diff --git a/scala3doc/src/dotty/dokka/site/processors.scala b/scala3doc/src/dotty/dokka/site/processors.scala
@@ -6,7 +6,6 @@ import java.nio.file.Files
 import java.nio.file.FileVisitOption
 
 import org.jetbrains.dokka.base.renderers.html.{NavigationNode, NavigationPage}
-import org.jetbrains.dokka.links.DRI
 import org.jetbrains.dokka.model.Documentable
 import org.jetbrains.dokka.pages._
 import org.jetbrains.dokka.transformers.pages.PageTransformer
diff --git a/scala3doc/src/dotty/dokka/tasty/BasicSupport.scala b/scala3doc/src/dotty/dokka/tasty/BasicSupport.scala
@@ -1,6 +1,6 @@
-package dotty.dokka.tasty
+package dotty.dokka
+package tasty
 
-import org.jetbrains.dokka.links._
 import org.jetbrains.dokka.model._
 import collection.JavaConverters._
 import dotty.dokka._
@@ -47,7 +47,4 @@ trait BasicSupport:
     def getAnnotations(): List[Annotation] =
     sym.annots.filterNot(_.symbol.packageName.startsWith("scala.annotation.internal")).map(parseAnnotation).reverse
 
-  private val emptyDRI = DRI.Companion.getTopLevel
-
-
 
diff --git a/scala3doc/src/dotty/dokka/tasty/ClassLikeSupport.scala b/scala3doc/src/dotty/dokka/tasty/ClassLikeSupport.scala
@@ -1,7 +1,6 @@
 package dotty.dokka.tasty
 
 import org.jetbrains.dokka.model.{TypeConstructor => DTypeConstructor, _}
-import org.jetbrains.dokka.links._
 import org.jetbrains.dokka.model.doc._
 import org.jetbrains.dokka.DokkaConfiguration$DokkaSourceSet
 import collection.JavaConverters._
diff --git a/scala3doc/src/dotty/dokka/tasty/PackageSupport.scala b/scala3doc/src/dotty/dokka/tasty/PackageSupport.scala
@@ -2,7 +2,7 @@ package dotty.dokka
 package tasty
 
 import org.jetbrains.dokka.model._
-import org.jetbrains.dokka.links._
+import org.jetbrains.dokka.links.PointingToDeclaration
 import org.jetbrains.dokka.model.properties._
 import org.jetbrains.dokka.model.doc.DocumentationNode
 import dotty.dokka._
diff --git a/scala3doc/src/dotty/dokka/tasty/TastyParser.scala b/scala3doc/src/dotty/dokka/tasty/TastyParser.scala
@@ -6,7 +6,6 @@ import org.jetbrains.dokka.transformers.sources._
 
 import org.jetbrains.dokka.DokkaConfiguration
 import org.jetbrains.dokka.model._
-import org.jetbrains.dokka.links._
 import org.jetbrains.dokka.model.doc._
 import org.jetbrains.dokka.base.parsers._
 import org.jetbrains.dokka.plugability.DokkaContext
@@ -18,6 +17,9 @@ import org.jetbrains.dokka.model.properties.{WithExtraProperties}
 import quoted.QuoteContext
 import scala.tasty.inspector.TastyInspector
 import dotty.dokka.model.api.withNewMembers
+import dotty.dokka.tasty.comments.MemberLookup
+import dotty.dokka.tasty.comments.QueryParser
+import scala.util.Try
 
 /** Responsible for collectively inspecting all the Tasty files we're interested in.
   *
@@ -101,6 +103,18 @@ trait DokkaBaseTastyInspector:
 
   def processCompilationUnit(using qctx: QuoteContext)(root: qctx.reflect.Tree): Unit =
     val parser = new TastyParser(qctx, this, config)
+
+    def driFor(link: String): Option[DRI] =
+      val symOps = new SymOps[qctx.type](qctx)
+      import symOps._
+      Try(QueryParser(link).readQuery()).toOption.flatMap(q =>
+        MemberLookup.lookupOpt(q, None).map{ case (sym, _) => sym.dri}
+      )
+
+    config.staticSiteContext.foreach { p =>
+      val previous = p.memberLinkResolver
+      p.memberLinkResolver = link => previous(link).orElse(driFor(link))
+    }
     topLevels ++= parser.parseRootTree(root.asInstanceOf[parser.qctx.reflect.Tree])
 
   def result(): List[DPackage] =
diff --git a/scala3doc/src/dotty/dokka/transformers/ImplicitMembersExtensionTransformer.scala b/scala3doc/src/dotty/dokka/transformers/ImplicitMembersExtensionTransformer.scala
@@ -5,7 +5,6 @@ import org.jetbrains.dokka.model._
 import collection.JavaConverters
 import collection.JavaConverters._
 import org.jetbrains.dokka.plugability.DokkaContext
-import org.jetbrains.dokka.links.DRI
 import org.jetbrains.dokka.model.properties._
 
 import dotty.dokka.model._
diff --git a/scala3doc/src/dotty/dokka/transformers/InheritanceInformationTransformer.scala b/scala3doc/src/dotty/dokka/transformers/InheritanceInformationTransformer.scala
@@ -4,7 +4,6 @@ import org.jetbrains.dokka.transformers.documentation.DocumentableTransformer
 import org.jetbrains.dokka.model._
 import collection.JavaConverters._
 import org.jetbrains.dokka.plugability.DokkaContext
-import org.jetbrains.dokka.links.DRI
 import org.jetbrains.dokka.model.properties._
 
 import dotty.dokka.model._
diff --git a/scala3doc/src/dotty/dokka/translators/FilterAttributes.scala b/scala3doc/src/dotty/dokka/translators/FilterAttributes.scala
@@ -12,7 +12,6 @@ import org.jetbrains.dokka.model.properties._
 import org.jetbrains.dokka.base.transformers.documentables.CallableExtensions
 import org.jetbrains.dokka.DokkaConfiguration$DokkaSourceSet
 import org.jetbrains.dokka.base.resolvers.anchors._
-import org.jetbrains.dokka.links._
 import org.jetbrains.dokka.model.properties.PropertyContainer
 import org.jetbrains.dokka.model.doc._
 import dotty.dokka.model.api._
diff --git a/scala3doc/src/dotty/dokka/translators/ScalaContentBuilder.scala b/scala3doc/src/dotty/dokka/translators/ScalaContentBuilder.scala
@@ -13,7 +13,6 @@ import org.jetbrains.dokka.model.properties._
 import org.jetbrains.dokka.base.transformers.documentables.CallableExtensions
 import org.jetbrains.dokka.DokkaConfiguration$DokkaSourceSet
 import org.jetbrains.dokka.base.resolvers.anchors._
-import org.jetbrains.dokka.links._
 import org.jetbrains.dokka.model.properties.PropertyContainer
 import org.jetbrains.dokka.model.doc._
 import dotty.dokka.model.api.{Kind => _, Link => SLink, _}
diff --git a/scala3doc/src/dotty/dokka/translators/ScalaPageCreator.scala b/scala3doc/src/dotty/dokka/translators/ScalaPageCreator.scala
@@ -16,9 +16,7 @@ import org.jetbrains.dokka.model.properties._
 import org.jetbrains.dokka.base.transformers.documentables.CallableExtensions
 import org.jetbrains.dokka.DokkaConfiguration$DokkaSourceSet
 import org.jetbrains.dokka.base.resolvers.anchors._
-import org.jetbrains.dokka.links._
 import org.jetbrains.dokka.model.doc._
-import org.jetbrains.dokka.links.DRIKt.getParent
 import dotty.dokka.model.api._
 import dotty.dokka.model.api.Kind
 import dotty.dokka.model.api.Link
diff --git a/scala3doc/src/dotty/dokka/translators/ScalaSignatureProvider.scala b/scala3doc/src/dotty/dokka/translators/ScalaSignatureProvider.scala
@@ -12,7 +12,6 @@ import org.jetbrains.dokka.base.translators.documentables._
 import org.jetbrains.dokka.model.properties.PropertyContainer
 import java.util.function.Consumer
 import kotlin.jvm.functions.Function2
-import org.jetbrains.dokka.links.DRI
 import dotty.dokka.model.api.{Kind, _}
 
 
diff --git a/scala3doc/src/dotty/dokka/translators/ScalaSignatureUtils.scala b/scala3doc/src/dotty/dokka/translators/ScalaSignatureUtils.scala
@@ -2,7 +2,6 @@ package dotty.dokka
 
 import org.jetbrains.dokka.base.signatures._
 import org.jetbrains.dokka.base.translators.documentables.PageContentBuilder
-import org.jetbrains.dokka.links.DRI
 import org.jetbrains.dokka.model._
 import org.jetbrains.dokka.model.properties.WithExtraProperties
 import org.jetbrains.dokka.pages._
diff --git a/scala3doc/src/dotty/dokka/utils.scala b/scala3doc/src/dotty/dokka/utils.scala
@@ -4,7 +4,6 @@ import org.jetbrains.dokka.model.properties._
 import org.jetbrains.dokka.base.signatures._
 import org.jetbrains.dokka.model._
 import org.jetbrains.dokka.pages._
-import org.jetbrains.dokka.links._
 import org.jetbrains.dokka.base.signatures.KotlinSignatureProvider
 import org.jetbrains.dokka.base.transformers.pages.comments.CommentsToContentConverter
 import org.jetbrains.dokka.utilities.DokkaLogger
diff --git a/scala3doc/src/dotty/renderers/DotDiagramBuilder.scala b/scala3doc/src/dotty/renderers/DotDiagramBuilder.scala
@@ -2,7 +2,6 @@ package dotty.dokka
 
 import dotty.dokka.model._
 import org.jetbrains.dokka.model._
-import org.jetbrains.dokka.links.DRI
 import org.jetbrains.dokka.pages._
 import dotty.dokka.model.api.Kind
 import HTML._
diff --git a/scala3doc/src/dotty/renderers/ScalaHtmlRenderer.scala b/scala3doc/src/dotty/renderers/ScalaHtmlRenderer.scala
@@ -16,7 +16,6 @@ import kotlinx.html.Gen_consumer_tagsKt
 import kotlinx.html.ApiKt
 import kotlinx.html.HTMLTag
 import kotlinx.html.DIV
-import org.jetbrains.dokka.links.DRI
 import dotty.dokka.model.api.Link
 import dotty.dokka.model.api.HierarchyGraph
 import org.jetbrains.dokka.base.resolvers.local.LocationProvider
@@ -255,7 +254,7 @@ class ScalaHtmlRenderer(ctx: DokkaContext) extends HtmlRenderer(ctx) {
         def processLocalLink(str: String): String =
           Try(URL(str)).map(_ => str).getOrElse{
           // TODO (https://github.com/lampepfl/scala3doc/issues/238) error handling
-            prc.context.driForLink(prc.template.templateFile, str).toOption
+            prc.context.driForLink(prc.template.templateFile, str)
               .flatMap(dri => Option(getLocationProvider.resolve(dri, sourceSets, page)))
               .getOrElse(str)
           }
