Scala3doc/doc context

scala3doc/src/dotty/dokka/DocContext.scala

@@ -1,5 +1,105 @@
 package dotty.dokka
 
+import org.jetbrains.dokka._
+import org.jetbrains.dokka.DokkaSourceSetImpl
+import org.jetbrains.dokka.plugability.DokkaContext
+import java.io.File
+import collection.JavaConverters._
+import dotty.dokka.site.StaticSiteContext
 import dotty.tools.dotc.core.Contexts._
+import java.io.ByteArrayOutputStream
+import java.io.PrintStream
 
-type DocContext = Context
+type CompilerContext = dotty.tools.dotc.core.Contexts.Context
+
+given compilerContext(using docContext: DocContext) as CompilerContext =
+  docContext.compilerContext
+
+given docContextFromDokka(using dokkaContext: DokkaContext) as DocContext =
+  dokkaContext.getConfiguration.asInstanceOf[DocContext]
+
+val report = dotty.tools.dotc.report
+
+def throwableToString(t: Throwable)(using CompilerContext): String =
+  if ctx.settings.verbose.value then
+    val os = new ByteArrayOutputStream
+    t.printStackTrace(new PrintStream(os))
+    os.toString()
+  else s"${t.getClass.getName}: ${t.getMessage}"
+
+// TODO (https://github.com/lampepfl/scala3doc/issues/238): provide proper error handling
+private def createMessage(
+  msg: String, file: File, e: Throwable | Null)(using CompilerContext): String =
+    val localizedMessage = s"$file: $msg"
+    e match
+      case null => localizedMessage
+      case throwable: Throwable =>
+         s"$localizedMessage \ncaused by: ${throwableToString(throwable)}"
+
+extension (r: report.type):
+  def error(m: String, f: File, e: Throwable | Null = null)(using CompilerContext): Unit =
+    r.error(createMessage(m, f, e))
+
+  def warn(m: String, f: File, e: Throwable)(using CompilerContext): Unit =
+    r.warning(createMessage(m, f, e))
+
+  def warn(m: String, f: File)(using CompilerContext): Unit =
+    r.warning(createMessage(m, f, null))
+
+
+case class DocContext(args: Scala3doc.Args, compilerContext: CompilerContext)
+  extends DokkaConfiguration:
+    override def getOutputDir: File = args.output
+    override def getCacheRoot: File = null
+    override def getOfflineMode: Boolean = false
+    override def getFailOnWarning: Boolean = false
+    override def getSourceSets: JList[DokkaSourceSet] = JList(mkSourceSet)
+    override def getModules: JList[DokkaConfiguration.DokkaModuleDescription] = JList()
+    override def getPluginsClasspath: JList[File] = JList()
+    override def getModuleName(): String = "ModuleName"
+    override def getModuleVersion(): String = ""
+
+    lazy val sourceLinks: SourceLinks = SourceLinks.load(using this)
+
+    lazy val displaySourceSets = getSourceSets.toDisplaySourceSet
+
+    val logger = new Scala3DocDokkaLogger(using compilerContext)
+
+    lazy val staticSiteContext = args.docsRoot.map(path => StaticSiteContext(
+        File(path).getAbsoluteFile(),
+        Set(mkSourceSet.asInstanceOf[SourceSetWrapper]),
+        args,
+        sourceLinks
+      )(using compilerContext))
+
+    override def getPluginsConfiguration: JList[DokkaConfiguration.PluginConfiguration] =
+      JList()
+
+    val mkSourceSet: DokkaSourceSet =
+      new DokkaSourceSetImpl(
+        /*displayName=*/ args.name,
+        /*sourceSetID=*/ new DokkaSourceSetID(args.name, "main"),
+        /*classpath=*/ JList(),
+        /*sourceRoots=*/ JSet(),
+        /*dependentSourceSets=*/ JSet(),
+        /*samples=*/ JSet(),
+        /*includes=*/ JSet(),
+        /*includeNonPublic=*/ true,
+        /* changed because of exception in reportUndocumentedTransformer - there's 'when' which doesnt match because it contains only KotlinVisbility cases */
+        /*reportUndocumented=*/ false,
+        // Now all our packages are empty from dokka perspective
+        /*skipEmptyPackages=*/ false,
+        /*skipDeprecated=*/ true,
+        /*jdkVersion=*/ 8,
+        /*sourceLinks=*/ JSet(),
+        /*perPackageOptions=*/ JList(),
+        /*externalDocumentationLinks=*/ JSet(),
+        /*languageVersion=*/ null,
+        /*apiVersion=*/ null,
+        /*noStdlibLink=*/ true,
+        /*noJdkLink=*/  true,
+        /*suppressedFiles=*/  JSet(),
+        /*suppressedFiles=*/  Platform.jvm
+      ).asInstanceOf[DokkaSourceSet] // Why I do need to cast here? Kotlin magic?
+
+    val sourceSet = mkSourceSet.asInstanceOf[SourceSetWrapper]

scala3doc/src/dotty/dokka/DottyDokkaPlugin.scala

@@ -23,9 +23,9 @@ import dotty.dokka.model.api._
 import org.jetbrains.dokka.CoreExtensions
 import org.jetbrains.dokka.base.DokkaBase
 
+import dotty.dokka.site.NavigationCreator
 import dotty.dokka.site.SitePagesCreator
 import dotty.dokka.site.StaticSiteContext
-import dotty.dokka.site.RootIndexPageCreator
 import dotty.dokka.site.SiteResourceManager
 import dotty.dokka.site.StaticSiteLocationProviderFactory
 
@@ -49,7 +49,7 @@ class DottyDokkaPlugin extends DokkaJavaPlugin:
   // Just turn off another translator since multiple overrides does not work
   val disableDescriptorTranslator = extend(
     _.extensionPoint(CoreExtensions.INSTANCE.getSourceToDocumentableTranslator)
-    .fromRecipe(ctx => new ScalaModuleProvider(using ctx.docContext))
+    .fromRecipe { case ctx @ given DokkaContext => new ScalaModuleProvider }
     .overrideExtension(dokkaBase.getDescriptorToDocumentableTranslator)
     .name("disableDescriptorTranslator")
   )
@@ -63,14 +63,14 @@ class DottyDokkaPlugin extends DokkaJavaPlugin:
 
   val ourSignatureProvider = extend(
     _.extensionPoint(dokkaBase.getSignatureProvider)
-      .fromRecipe(ctx =>
-        new ScalaSignatureProvider(ctx.single(dokkaBase.getCommentsToContentConverter), ctx.getLogger)
-      ).overrideExtension(dokkaBase.getKotlinSignatureProvider)
+      .fromRecipe{ case ctx @ given DokkaContext =>
+        new ScalaSignatureProvider(ctx.single(dokkaBase.getCommentsToContentConverter))
+      }.overrideExtension(dokkaBase.getKotlinSignatureProvider)
   )
 
   val scalaResourceInstaller = extend(
     _.extensionPoint(dokkaBase.getHtmlPreprocessors)
-      .fromRecipe(ctx => new ScalaResourceInstaller(ctx.args))
+      .fromRecipe{ case ctx @ given DokkaContext => new ScalaResourceInstaller }
       .after(dokkaBase.getCustomResourceInstaller)
   )
 
@@ -83,17 +83,14 @@ class DottyDokkaPlugin extends DokkaJavaPlugin:
 
   val scalaDocumentableToPageTranslator = extend(
     _.extensionPoint(CoreExtensions.INSTANCE.getDocumentableToPageTranslator)
-      .fromRecipe(ctx =>
+      .fromRecipe { case ctx @ given DokkaContext =>
           new DocumentableToPageTranslator {
             override def invoke(module: DModule): ModulePageNode = ScalaPageCreator(
               ctx.single(dokkaBase.getCommentsToContentConverter),
-              ctx.single(dokkaBase.getSignatureProvider),
-              ctx.getConfiguration.asInstanceOf[DottyDokkaConfig].sourceLinks,
-              ctx.getLogger
+              ctx.single(dokkaBase.getSignatureProvider)
             ).pageForModule(module)
           }
-      )
-      .overrideExtension(dokkaBase.getDocumentableToPageTranslator)
+      }.overrideExtension(dokkaBase.getDocumentableToPageTranslator)
   )
 
   val packageHierarchyTransformer = extend(
@@ -111,7 +108,7 @@ class DottyDokkaPlugin extends DokkaJavaPlugin:
 
   val ourRenderer = extend(
     _.extensionPoint(CoreExtensions.INSTANCE.getRenderer)
-      .fromRecipe(ctx => ScalaHtmlRenderer(ctx, ctx.args))
+      .fromRecipe { case ctx @ given DokkaContext => new ScalaHtmlRenderer }
       .overrideExtension(dokkaBase.getHtmlRenderer)
   )
 
@@ -129,7 +126,7 @@ class DottyDokkaPlugin extends DokkaJavaPlugin:
 
   val customDocumentationProvider = extend(
     _.extensionPoint(dokkaBase.getHtmlPreprocessors)
-      .fromRecipe(c => SitePagesCreator(c.siteContext))
+      .fromRecipe{ case c @ given DokkaContext => new SitePagesCreator }
       .name("customDocumentationProvider")
       .ordered(
         before = Seq(
@@ -142,39 +139,36 @@ class DottyDokkaPlugin extends DokkaJavaPlugin:
       )
   )
 
-  val customIndexRootProvider = extend(
+  val customNavigation = extend(
     _.extensionPoint(dokkaBase.getHtmlPreprocessors)
-      .fromRecipe(c => RootIndexPageCreator(c.siteContext))
-      .name("customIndexRootProvider")
+      .fromRecipe{ case c @ given DokkaContext => new NavigationCreator }
+      .name("customNavigation")
       .ordered(
         before = Seq(
           dokkaBase.getScriptsInstaller,
           dokkaBase.getStylesInstaller,
         ),
-        after = Seq(dokkaBase.getNavigationPageInstaller)
+        after = Seq(customDocumentationProvider.getValue)
       )
+      .overrideExtension(dokkaBase.getNavigationPageInstaller)
   )
 
   val customDocumentationResources = extend(
     _.extensionPoint(dokkaBase.getHtmlPreprocessors)
-    .fromRecipe(c => SiteResourceManager(c.siteContext))
+    .fromRecipe{ case c @ given DokkaContext => new SiteResourceManager }
       .name("customDocumentationResources")
       .after(
-        scalaEmbeddedResourceAppender.getValue
+        scalaEmbeddedResourceAppender.getValue,
+        customDocumentationProvider.getValue
       )
   )
 
   val locationProvider = extend(
     _.extensionPoint(dokkaBase.getLocationProviderFactory)
-      .fromRecipe(StaticSiteLocationProviderFactory(_))
+      .fromRecipe { case c @ given DokkaContext => new StaticSiteLocationProviderFactory }
       .overrideExtension(dokkaBase.getLocationProvider)
   )
 
-extension (ctx: DokkaContext):
-  def siteContext: Option[StaticSiteContext] = ctx.getConfiguration.asInstanceOf[DottyDokkaConfig].staticSiteContext
-  def args: Scala3doc.Args = ctx.getConfiguration.asInstanceOf[DottyDokkaConfig].args
-  def docContext = ctx.getConfiguration.asInstanceOf[DottyDokkaConfig].docContext
-
 // TODO (https://github.com/lampepfl/scala3doc/issues/232): remove once problem is fixed in Dokka
 extension [T]  (builder: ExtensionBuilder[T]):
   def ordered(before: Seq[Extension[_, _, _]], after: Seq[Extension[_, _, _]]): ExtensionBuilder[T] =

scala3doc/src/dotty/dokka/Main.scala

@@ -13,7 +13,6 @@ import java.nio.file.Files
 
 import dotty.tools.dotc.config.Settings._
 import dotty.tools.dotc.config.CommonScalaSettings
-import dotty.tools.dotc.report
 import dotty.tools.dotc.core.Contexts._
 
 /** Main class for the doctool.
@@ -25,7 +24,7 @@ import dotty.tools.dotc.core.Contexts._
   *
   * - [](package.DottyDokkaPlugin) is our class that Dokka calls back and which
   *   actually generates the documentation.
-  * - [](package.DottyDokkaConfig) is our config for Dokka.
+  * - [](package.DocContext) is our config for Dokka
   */
 object Main:
   def main(args: Array[String]): Unit =

scala3doc/src/dotty/dokka/Scala3doc.scala

@@ -13,10 +13,10 @@ import java.nio.file.Files
 
 import dotty.tools.dotc.config.Settings._
 import dotty.tools.dotc.config.CommonScalaSettings
-import dotty.tools.dotc.report
 import dotty.tools.dotc.reporting.Reporter
 
-class Scala3DocDokkaLogger(using DocContext) extends DokkaLogger:
+
+class Scala3DocDokkaLogger(using CompilerContext) extends DokkaLogger:
   def debug(msg: String): Unit = report.debuglog(msg)
 
   // We do not want errors from dokka (that are) not critical to fail our runs
@@ -67,7 +67,7 @@ object Scala3doc:
     revision: Option[String] = None
   )
 
-  def run(args: Array[String])(using DocContext): Reporter =
+  def run(args: Array[String])(using ctx: CompilerContext): Reporter =
     val parsedArgs = Scala3docArgs.extract(args.toList)
 
     def listTastyFiles(f: File): Seq[File] =
@@ -77,18 +77,19 @@ object Scala3doc:
       )
     val tastyFiles = parsedArgs.tastyFiles ++ parsedArgs.tastyDirs.flatMap(listTastyFiles)
 
-    val reporter = summon[DocContext].reporter
-    if !reporter.hasErrors then
+    if !ctx.reporter.hasErrors then
       val updatedArgs = parsedArgs.copy(tastyDirs = Nil, tastyFiles = tastyFiles)
 
       if (parsedArgs.output.exists()) IO.delete(parsedArgs.output)
 
       run(updatedArgs)
       report.inform("Done")
     else report.error("Failure")
-    reporter
+    ctx.reporter
+
 
-  private [dokka] def run(args: Args)(using DocContext) =
-    new DokkaGenerator(new DottyDokkaConfig(args, summon[DocContext]), new Scala3DocDokkaLogger).generate()
+  private [dokka] def run(args: Args)(using ctx: CompilerContext) =
+    val docContext = new DocContext(args, ctx)
+    new DokkaGenerator(docContext, docContext.logger).generate()
 
 

scala3doc/src/dotty/dokka/Scala3docArgs.scala

@@ -13,8 +13,6 @@ import java.nio.file.Files
 
 import dotty.tools.dotc.config.Settings._
 import dotty.tools.dotc.config.CommonScalaSettings
-import dotty.tools.dotc.report
-import dotty.tools.dotc.core.Contexts._
 import dotty.dokka.Scala3doc._
 
 class Scala3docArgs extends SettingGroup with CommonScalaSettings:
@@ -37,7 +35,7 @@ class Scala3docArgs extends SettingGroup with CommonScalaSettings:
     StringSetting("-revision", "revision", "Revision (branch or ref) used to build project project", "")
 
 object Scala3docArgs:
-  def extract(args: List[String])(using Context) =
+  def extract(args: List[String])(using CompilerContext) =
     val inst = new Scala3docArgs
     import inst._
     val initialSummary =