Fix #25: move doc related structures to DocBase

To access `DocBase`: `ctx.docbase.docstring(...)`

Author: felixmulder

dottydoc/jvm/src/dotty/tools/dottydoc/core/DocASTPhase.scala

@@ -37,7 +37,7 @@ class DocASTPhase extends Phase {
 
   /** Build documentation hierarchy from existing tree */
   def collect(tree: Tree, prev: List[String] = Nil)(implicit ctx: Context): Entity = track(tree.symbol, ctx) {
-    val implicitlyAddedMembers = ctx.base.defs(tree.symbol)
+    val implicitlyAddedMembers = ctx.docbase.defs(tree.symbol)
 
     def collectList(xs: List[Tree], ps: List[String])(implicit ctx: Context): List[Entity] =
       xs.map(collect(_, ps)).filter(_ != NonEntity)
@@ -169,7 +169,7 @@ class DocASTPhase extends Phase {
     commentParser.clear()
 
     // (5) Update Doc AST in ctx.base
-    for (kv <- packages) ctx.base.packages += kv
+    for (kv <- packages) ctx.docbase.packages += kv
 
     // Return super's result
     compUnits

dottydoc/jvm/src/dotty/tools/dottydoc/core/DocImplicitsPhase.scala

@@ -19,7 +19,7 @@ class DocImplicitsPhase extends MiniPhaseTransform { thisTransformer =>
       tree.vparamss(0).length == 1       // should only take one arg, since it has to be a transformation
     ) {
       val convertee = tree.vparamss(0)(0).symbol.info.widenDealias.finalResultType.typeSymbol // the pimped type (i.e. `class`)
-      ctx.base.addDef(convertee, tree.symbol.info.widenDealias.finalResultType.typeSymbol)
+      ctx.docbase.addDef(convertee, tree.symbol.info.widenDealias.finalResultType.typeSymbol)
     }
 
     tree

dottydoc/jvm/src/dotty/tools/dottydoc/core/MiniPhaseTransform.scala

@@ -43,17 +43,17 @@ object transform {
     override def runOn(units: List[CompilationUnit])(implicit ctx: Context): List[CompilationUnit] = {
       for {
         rootName    <- rootPackages
-        pack        =  ctx.base.packages[Package](rootName)
+        pack        =  ctx.docbase.packages[Package](rootName)
         transformed =  performPackageTransform(pack)
-      } yield ctx.base.packages(rootName) = transformed
+      } yield ctx.docbase.packages(rootName) = transformed
       super.runOn(units)
     }
 
     private def rootPackages(implicit ctx: Context): List[String] = {
       var currentDepth = Int.MaxValue
       var packs = List.empty[String]
 
-      for (key <- ctx.base.packages.keys) {
+      for (key <- ctx.docbase.packages.keys) {
         val keyDepth = key.split("\\.").length
         packs =
           if (keyDepth < currentDepth) {

dottydoc/jvm/src/dotty/tools/dottydoc/core/PrintPhase.scala

@@ -16,7 +16,7 @@ class PrintPhase extends Phase {
 
   override def runOn(units: List[CompilationUnit])(implicit ctx: Context): List[CompilationUnit] = {
     val compUnits = super.runOn(units)
-    val packages = ctx.base.packages[Package].toMap
+    val packages = ctx.docbase.packages[Package].toMap
 
     val outputDir = {
       val out = ctx.settings.DocOutput.value

dottydoc/jvm/src/dotty/tools/dottydoc/core/TypeLinkingPhases.scala

@@ -16,12 +16,12 @@ import util.internal.setters._
 
 class LinkReturnTypes extends DocMiniPhase with TypeLinker {
   override def transformDef(implicit ctx: Context) = { case df: DefImpl =>
-    val returnValue = linkReference(df, df.returnValue, ctx.base.packages[Package].toMap)
+    val returnValue = linkReference(df, df.returnValue, ctx.docbase.packages[Package].toMap)
     df.copy(returnValue = returnValue)
   }
 
   override def transformVal(implicit ctx: Context) = { case vl: ValImpl =>
-    val returnValue = linkReference(vl, vl.returnValue, ctx.base.packages[Package].toMap)
+    val returnValue = linkReference(vl, vl.returnValue, ctx.docbase.packages[Package].toMap)
     vl.copy(returnValue = returnValue)
   }
 }
@@ -30,7 +30,7 @@ class LinkParamListTypes extends DocMiniPhase with TypeLinker {
   override def transformDef(implicit ctx: Context) = { case df: DefImpl =>
     val newParamLists = for {
       ParamListImpl(list, isImplicit) <- df.paramLists
-      newList = list.map(linkReference(df, _, ctx.base.packages[Package].toMap))
+      newList = list.map(linkReference(df, _, ctx.docbase.packages[Package].toMap))
     } yield ParamListImpl(newList.asInstanceOf[List[NamedReference]], isImplicit)
 
     df.copy(paramLists = newParamLists)

dottydoc/jvm/src/dotty/tools/dottydoc/model/comment/CommentExpander.scala

@@ -77,7 +77,7 @@ trait CommentExpander {
 
   def cookedDocComment(sym: Symbol, docStr: String = "")(implicit ctx: Context): String = cookedDocComments.getOrElseUpdate(sym, {
     var ownComment =
-      if (docStr.length == 0) ctx.base.docstring(sym).map(c => template(c.chrs)).getOrElse("")
+      if (docStr.length == 0) ctx.docbase.docstring(sym).map(c => template(c.chrs)).getOrElse("")
       else template(docStr)
     ownComment = replaceInheritDocToInheritdoc(ownComment)
 
@@ -287,7 +287,7 @@ trait CommentExpander {
   def defineVariables(sym: Symbol)(implicit ctx: Context) = {
     val Trim = "(?s)^[\\s&&[^\n\r]]*(.*?)\\s*$".r
 
-    val raw = ctx.base.docstring(sym).map(_.chrs).getOrElse("")
+    val raw = ctx.docbase.docstring(sym).map(_.chrs).getOrElse("")
     defs(sym) ++= defines(raw).map {
       str => {
         val start = skipWhitespace(str, "@define".length)
@@ -328,7 +328,7 @@ trait CommentExpander {
    *  the position of the doc comment of the overridden version is returned instead.
    */
   def docCommentPos(sym: Symbol)(implicit ctx: Context): Position =
-    ctx.base.docstring(sym).map(_.pos).getOrElse(NoPosition)
+    ctx.docbase.docstring(sym).map(_.pos).getOrElse(NoPosition)
 
   /** A version which doesn't consider self types, as a temporary measure:
    *  an infinite loop has broken out between superComment and cookedDocComment

dottydoc/jvm/src/dotty/tools/dottydoc/model/parsers.scala

@@ -23,7 +23,7 @@ object parsers {
      * which can then be awaited near the end of the run - before the pickling.
      */
     def parseHtml(sym: Symbol, entity: Entity, packages: Map[String, Package])(implicit ctx: Context): (String, Option[Comment]) = {
-      val cmt = ctx.base.docstring(sym).map { d =>
+      val cmt = ctx.docbase.docstring(sym).map { d =>
         val expanded = expand(sym)
         val body = parse(entity, packages, clean(expanded), expanded, d.pos)
         val summary = body.summary.map(_.toHtml(entity)).getOrElse("")
@@ -43,7 +43,7 @@ object parsers {
       }
 
       val path = entity.path.mkString(".")
-      if (!commentCache.contains(path) || ctx.base.docstring(symbol).isDefined)
+      if (!commentCache.contains(path) || ctx.docbase.docstring(symbol).isDefined)
         commentCache = commentCache + (path -> commentParser)
     }
 

src/dotty/tools/dotc/core/Contexts.scala

@@ -532,6 +532,9 @@ object Contexts {
     /** The symbol loaders */
     val loaders = new SymbolLoaders
 
+    /** Documentation base */
+    val docbase = new DocBase
+
     /** The platform, initialized by `initPlatform()`. */
     private var _platform: Platform = _
 
@@ -568,15 +571,22 @@ object Contexts {
     def squashed(p: Phase): Phase = {
       allPhases.find(_.period.containsPhaseId(p.id)).getOrElse(NoPhase)
     }
+  }
 
-    val _docstrings: mutable.Map[Symbol, Comment] =
+  class DocBase {
+    private[this] val _docstrings: mutable.Map[Symbol, Comment] =
       mutable.Map.empty
 
     def docstring(sym: Symbol): Option[Comment] = _docstrings.get(sym)
 
     def addDocstring(sym: Symbol, doc: Option[Comment]): Unit =
       doc.map(d => _docstrings += (sym -> d))
 
+    /*
+     * Dottydoc places instances of `Package` in this map - but we do not want
+     * to depend on `dottydoc` for the compiler, as such this is defined as a
+     * map of `String -> AnyRef`
+     */
     private[this] val _packages: mutable.Map[String, AnyRef] = mutable.Map.empty
     def packages[A]: mutable.Map[String, A] = _packages.asInstanceOf[mutable.Map[String, A]]
 

src/dotty/tools/dotc/typer/Namer.scala

@@ -426,7 +426,7 @@ class Namer { typer: Typer =>
   }
 
   def setDocstring(sym: Symbol, tree: Tree)(implicit ctx: Context) = tree match {
-    case t: MemberDef => ctx.base.addDocstring(sym, t.rawComment)
+    case t: MemberDef => ctx.docbase.addDocstring(sym, t.rawComment)
     case _ => ()
   }