• Home
• org.scala-lang
• scala3-doc_3.0.0-M1
• 3.0.0-M1-bin-20201023-6098ec2-NIGHTLY
• source code
• DocDriver.scala

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

dotty.tools.dottydoc.DocDriver.scala Maven / Gradle / Ivy

package dotty.tools
package dottydoc

import java.io.File

import dotty.tools.dottydoc.util.syntax._
import core.ContextDottydoc
import dotc.core.Contexts._
import dotc.reporting.Reporter
import dotc.{ Compiler, Driver }
import dotc.config._
import dotc.core.Comments.ContextDoc
import dotc.report
import staticsite.Site

/** `DocDriver` implements the main entry point to the Dotty documentation
 *  tool. It's methods are used by the external scala and java APIs.
 */
class DocDriver extends Driver {
  import java.util.{ Map => JMap }
  import model.JavaConverters._

  override def setup(args: Array[String], rootCtx: Context): (List[String], Context) = {
    val ctx     = rootCtx.fresh
    val summary = CompilerCommand.distill(args)(using ctx)

    ctx.setSettings(summary.sstate)
    ctx.setSetting(ctx.settings.YcookComments, true)
    ctx.setSetting(ctx.settings.YnoInline, true)
    ctx.setProperty(ContextDoc, new ContextDottydoc)

    val fileNames = CompilerCommand.checkUsage(summary, sourcesRequired)(using ctx)
    fromTastySetup(fileNames, ctx)
  }

  override def newCompiler(using Context): Compiler = new DocCompiler

  override def process(args: Array[String], rootCtx: Context): Reporter = {
    val (filesToDocument, ictx) = setup(args, initCtx.fresh)

    implicit val ctx: Context = ictx
    val reporter = doCompile(newCompiler, filesToDocument)

    val siteRoot = File(ctx.settings.siteRoot.value)
    val projectName = ctx.settings.projectName.value
    val projectVersion = ctx.settings.projectVersion.value
    val projectUrl = Option(ctx.settings.projectUrl.value).filter(_.nonEmpty)
    val projectLogo = Option(ctx.settings.projectLogo.value).filter(_.nonEmpty)
    val docSnapshot = ctx.settings.docSnapshot.value

    val baseUrl = ""
    val outDir = File(siteRoot, "_site")
    val snapshotFolderName = if projectVersion.endsWith("NIGHTLY") then "nightly" else projectVersion
    val snapshotOutDir = File(outDir, snapshotFolderName)
    val snapshotBaseUrl = s"$baseUrl/$snapshotFolderName"

    if (projectName.isEmpty)
      report.error(s"Site project name not set. Use `-project