Merge pull request #10340 from dotty-staging/load-stdlib

Scala3doc: fix issues with loading stdlib

Author: abgruszecki

.github/workflows/scala3doc.yaml

@@ -57,6 +57,9 @@ jobs:
       - name: Generate Scala 3 documentation
         run: ./project/scripts/sbt scala3doc/generateScala3Documentation
 
+      - name: Generate Scala 3 stdlib documentation
+        run: ./project/scripts/sbt scala3doc/generateScala3StdlibDocumentation
+
       - name: Generate documentation for example project using dotty-sbt
         run: ./project/scripts/sbt "sbt-dotty/scripted sbt-dotty/scala3doc"
 

compiler/src/scala/quoted/internal/impl/QuoteContextImpl.scala

@@ -2001,16 +2001,16 @@ class QuoteContextImpl private (ctx: Context) extends QuoteContext, QuoteUnpickl
 
     object TypeBounds extends TypeBoundsModule:
       def apply(low: TypeRepr, hi: TypeRepr): TypeBounds = Types.TypeBounds(low, hi)
-      def unapply(x: TypeBounds): Option[(TypeRepr, TypeRepr)] = Some((x.low, x.hi))
+      def unapply(x: TypeBounds): Option[(TypeRepr, TypeRepr)] = Some((x.low.stripLazyRef, x.hi.stripLazyRef))
       def empty: TypeBounds = Types .TypeBounds.empty
       def upper(hi: TypeRepr): TypeBounds = Types .TypeBounds.upper(hi)
       def lower(lo: TypeRepr): TypeBounds = Types .TypeBounds.lower(lo)
     end TypeBounds
 
     object TypeBoundsMethodsImpl extends TypeBoundsMethods:
       extension (self: TypeBounds):
-        def low: TypeRepr = self.lo
-        def hi: TypeRepr = self.hi
+        def low: TypeRepr = self.lo.stripLazyRef
+        def hi: TypeRepr = self.hi.stripLazyRef
       end extension
     end TypeBoundsMethodsImpl
 

project/Build.scala

@@ -1160,7 +1160,9 @@ object Build {
   val testcasesOutputDir = taskKey[String]("Root directory where tests classses are generated")
   val testcasesSourceRoot = taskKey[String]("Root directory where tests sources are generated")
   val generateSelfDocumentation = taskKey[Unit]("Generate example documentation")
+  // Note: the two tasks below should be one, but a bug in Tasty prevents that
   val generateScala3Documentation = taskKey[Unit]("Generate documentation for dotty lib")
+  val generateScala3StdlibDocumentation = taskKey[Unit]("Generate documentation for Scala3 standard library")
   val generateTestcasesDocumentation  = taskKey[Unit]("Generate documentation for testcases, usefull for debugging tests")
   lazy val `scala3doc` = project.in(file("scala3doc")).asScala3doc
   lazy val `scala3doc-testcases` = project.in(file("scala3doc-testcases")).asScala3docTestcases
@@ -1506,15 +1508,24 @@ object Build {
               (`scala3-interfaces`/Compile/products).value,
               (`tasty-core-bootstrapped`/Compile/products).value,
               (`scala3-library-bootstrapped`/Compile/products).value,
-              // TODO we can't load stdlib from Tasty
-              // (`stdlib-bootstrapped`/Compile/products).value,
             ).flatten
 
             val roots = joinProducts(dottyJars)
 
             if (dottyJars.isEmpty) Def.task { streams.value.log.error("Dotty lib wasn't found") }
             else generateDocumentation(roots, "Scala 3", "scala3", "-p scala3doc/scala3-docs --projectLogo scala3doc/scala3-docs/logo.svg  --revision master")
           }.value,
+
+          generateScala3StdlibDocumentation:= Def.taskDyn {
+            val dottyJars: Seq[java.io.File] = Seq(
+              (`stdlib-bootstrapped`/Compile/products).value,
+            ).flatten
+
+            val roots = joinProducts(dottyJars)
+
+            if (dottyJars.isEmpty) Def.task { streams.value.log.error("Dotty lib wasn't found") }
+            else generateDocumentation(roots, "Scala 3", "scala3-stdlib", "-p scala3doc/scala3-docs --syntax wiki --projectLogo scala3doc/scala3-docs/logo.svg  --revision master")
+          }.value,
           generateTestcasesDocumentation := Def.taskDyn {
             generateDocumentation(Build.testcasesOutputDir.in(Test).value, "Scala3doc testcases", "testcases", "--revision master")
           }.value,

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

@@ -104,7 +104,7 @@ trait TypesSupport:
       case r: Refinement => { //(parent, name, info)
         def getRefinementInformation(t: TypeRepr): List[TypeRepr] = t match {
           case r: Refinement => getRefinementInformation(r.parent) :+ r
-          case tr: TypeRef => List(tr)
+          case t => List(t)
         }
 
         def getParamBounds(t: PolyType): List[JProjection] = commas(

scala3doc/src/dotty/dokka/tasty/comments/MemberLookup.scala

@@ -64,11 +64,19 @@ trait MemberLookup {
     import dotty.tools.dotc
     given dotc.core.Contexts.Context = rootContext.asInstanceOf
     val sym = rsym.asInstanceOf[dotc.core.Symbols.Symbol]
-    val members = sym.info.decls.iterator
+    val members = sym.info.decls.iterator.filter(_.isCompleted)
     // println(s"members of ${sym.show} : ${members.map(_.show).mkString(", ")}")
     members.asInstanceOf[Iterator[Symbol]]
   }
 
+  private def hackIsNotAbsent(using QuoteContext)(rsym: qctx.reflect.Symbol) = {
+    import qctx.reflect._
+    import dotty.tools.dotc
+    given dotc.core.Contexts.Context = rootContext.asInstanceOf
+    val sym = rsym.asInstanceOf[dotc.core.Symbols.Symbol]
+    sym.isCompleted
+  }
+
   private def localLookup(using QuoteContext)(query: String, owner: qctx.reflect.Symbol): Option[qctx.reflect.Symbol] = {
     import qctx.reflect._
 
@@ -116,7 +124,7 @@ trait MemberLookup {
     else
       owner.tree match {
         case tree: ClassDef =>
-          findMatch(tree.body.iterator.collect { case t: Definition => t.symbol })
+          findMatch(tree.body.iterator.collect { case t: Definition if hackIsNotAbsent(t.symbol) => t.symbol })
         case _ =>
           findMatch(hackMembersOf(owner))
       }

scala3doc/src/dotty/dokka/tasty/comments/wiki/Converter.scala

@@ -113,8 +113,20 @@ class Converter(val repr: Repr) extends BaseConverter {
           resolveLinkQuery(target, Some(body).filter(!_.isEmpty))
       })
 
-    case _: (Superscript | Subscript | RepresentationLink | HtmlTag) =>
-      sys.error("not yet supported: Superscript | Subscript | RepresentationLink | HtmlTag")
+    case Superscript(i) =>
+      def name = inl.getClass.getSimpleName
+      println(s"WARN: not yet supported: $name")
+      emitInline(i)
+
+    case Subscript(i) =>
+      def name = inl.getClass.getSimpleName
+      println(s"WARN: not yet supported: $name")
+      emitInline(i)
+
+    case _: (RepresentationLink | HtmlTag) =>
+      def name = inl.getClass.getSimpleName
+      println(s"WARN: not yet supported: $name")
+      name // doesn't compile if name is a val
   }
 
   def convertInline(inl: Inline): Seq[dkkd.DocTag] =

scala3doc/test/dotty/dokka/tasty/comments/MemberLookupTests.scala

@@ -22,7 +22,9 @@ class LookupTestCases[Q <: QuoteContext](val q: QuoteContext) {
     )
 
     cases.foreach { case (query, Sym(sym)) =>
-      val Some((lookedUp, _)) = MemberLookup.lookupOpt(parseQuery(query), None)
+      val lookupRes = MemberLookup.lookupOpt(parseQuery(query), None)
+      assertTrue(s"Couldn't look up: $query", lookupRes.nonEmpty)
+      val Some((lookedUp, _)) = lookupRes
       assertSame(query, sym, lookedUp)
     }
   }