Merge branch 'main' into scaladoc-types-rendering-fixes

Author: Florian3k

.vscode-template/settings.json

@@ -9,6 +9,7 @@
     "**/*.class": true,
     "**/*.tasty": true,
     "**/target/": true,
-    "community-build/community-projects": true
+    "community-build/community-projects": true,
+    "tests/pos-with-compiler-cc/dotc/**/*.scala": true
   }
 }

compiler/src/dotty/tools/dotc/inlines/Inlines.scala

@@ -17,7 +17,7 @@ import transform.{PostTyper, Inlining, CrossVersionChecks}
 import staging.StagingLevel
 
 import collection.mutable
-import reporting.trace
+import reporting.{NotConstant, trace}
 import util.Spans.Span
 
 /** Support for querying inlineable methods and for inlining calls to such methods */
@@ -413,7 +413,7 @@ object Inlines:
         if (inlinedMethod == defn.Compiletime_constValue) {
           val constVal = tryConstValue
           if constVal.isEmpty then
-            val msg = em"not a constant type: ${callTypeArgs.head}; cannot take constValue"
+            val msg = NotConstant("cannot take constValue", callTypeArgs.head.tpe)
             return ref(defn.Predef_undefined).withSpan(call.span).withType(ErrorType(msg))
           else
             return constVal

compiler/src/dotty/tools/dotc/reporting/ErrorMessageID.scala

@@ -195,6 +195,7 @@ enum ErrorMessageID(val isActive: Boolean = true) extends java.lang.Enum[ErrorMe
   case MatchTypeScrutineeCannotBeHigherKindedID // errorNumber: 179
   case AmbiguousExtensionMethodID // errorNumber 180
   case UnqualifiedCallToAnyRefMethodID // errorNumber: 181
+  case NotConstantID // errorNumber: 182
 
   def errorNumber = ordinal - 1
 

compiler/src/dotty/tools/dotc/reporting/messages.scala

@@ -2624,6 +2624,13 @@ extends TypeMsg(NotClassTypeID), ShowMatchTrace(tp):
   def msg(using Context) = i"$tp is not a class type"
   def explain(using Context) = ""
 
+class NotConstant(suffix: String, tp: Type)(using Context)
+extends TypeMsg(NotConstantID), ShowMatchTrace(tp):
+  def msg(using Context) =
+    i"$tp is not a constant type"
+    + (if suffix.isEmpty then "" else i"; $suffix")
+  def explain(using Context) = ""
+
 class MissingImplicitArgument(
     arg: tpd.Tree,
     pt: Type,

compiler/src/scala/quoted/runtime/impl/QuoteMatcher.scala

@@ -354,7 +354,7 @@ object QuoteMatcher {
             /* Match new */
             case New(tpt1) =>
               pattern match
-                case New(tpt2) if tpt1.tpe.typeSymbol == tpt2.tpe.typeSymbol => matched
+                case New(tpt2) if tpt1.tpe.dealias.typeSymbol == tpt2.tpe.dealias.typeSymbol => matched
                 case _ => notMatched
 
             /* Match this */

docs/_docs/contributing/setting-up-your-ide.md

@@ -22,26 +22,34 @@ sbt:scala3> projects
 ...
 ```
 
-These duplicated projects can be confusing and cause issues in IDEs.
+These duplicated projects can be confusing and cause issues in IDEs, so it's
+import to import the project in a specific way depending on your editor.
 
 ### Metals
 
 When using Metals, the `-bootstrapped` projects are not exported by default.
 Normally this is fine, but if you're working on certain modules like `scaladoc`
 you'll actually want these modules exported. In order to achieve this you'll
-first want to ensure you're using `sbt` as your build server instead of the
-default Bloop. You can achieve this with the `Metals: Switch Build Server`
-command and then choosing sbt. Once you do this, you'll want to find and change
-the following under `commonBootstrappedSettings` which is found in the
-[`Build.scala`](https://github.com/lampepfl/dotty/blob/main/project/Build.scala)
-file.
+want to make sure you do two things:
+
+1. You'll want to find and change the following under
+    `commonBootstrappedSettings` which is found in the
+    [`Build.scala`](https://github.com/lampepfl/dotty/blob/main/project/Build.scala)
+    file.
 
 ```diff
 
 -    bspEnabled := false,
 +    bspEnabled := true,
 ```
 
+2. Set `sbt` as your build server instead of the default, Bloop. You can achieve
+    this with the `Metals: Switch Build Server` command and then choosing sbt. In
+    VSCode, this looks like this:
+
+![bsp-switch](https://user-images.githubusercontent.com/777748/241986423-0724ae74-0ebd-42ef-a1b7-4d17678992b4.png)
+
+
 ### IntelliJ
 
 In IntelliJ IDEA, we recommend importing the dotty codebase through BSP, then

scaladoc/src/dotty/tools/scaladoc/ScalaModuleProvider.scala

@@ -8,7 +8,7 @@ case class Module(rootPackage: Member, members: Map[DRI, Member])
 
 object ScalaModuleProvider:
   def mkModule()(using ctx: DocContext): Module =
-    val (result, rootDoc) = ScaladocTastyInspector.loadDocs()
+    val (result, rootDoc) = ScaladocTastyInspector().result()
     val (rootPck, rest) = result.partition(_.name == "API")
     val (emptyPackages, nonemptyPackages) = (rest ++ rootPck.flatMap(_.members))
       .filter(p => p.members.nonEmpty || p.docs.nonEmpty).sortBy(_.name)

scaladoc/src/dotty/tools/scaladoc/tasty/TastyParser.scala

@@ -5,7 +5,7 @@ package tasty
 import java.util.regex.Pattern
 
 import scala.util.{Try, Success, Failure}
-import scala.tasty.inspector.{TastyInspector, Inspector, Tasty}
+import scala.tasty.inspector.DocTastyInspector
 import scala.quoted._
 
 import dotty.tools.dotc
@@ -24,12 +24,24 @@ import ScaladocSupport._
   *
   * Delegates most of the work to [[TastyParser]] [[dotty.tools.scaladoc.tasty.TastyParser]].
   */
-case class ScaladocTastyInspector()(using ctx: DocContext) extends Inspector:
+case class ScaladocTastyInspector()(using ctx: DocContext) extends DocTastyInspector:
 
   private val topLevels = Seq.newBuilder[(String, Member)]
   private var rootDoc: Option[Comment] = None
 
-  def inspect(using Quotes)(tastys: List[scala.tasty.inspector.Tasty[quotes.type]]): Unit =
+  def processCompilationUnit(using Quotes)(root: reflect.Tree): Unit = ()
+
+  override def postProcess(using Quotes): Unit =
+    // hack into the compiler to get a list of all top-level trees
+    // in principle, to do this, one would collect trees in processCompilationUnit
+    // however, path-dependent types disallow doing so w/o using casts
+    inline def hackForeachTree(thunk: reflect.Tree => Unit): Unit =
+      given dctx: dotc.core.Contexts.Context = quotes.asInstanceOf[scala.quoted.runtime.impl.QuotesImpl].ctx
+      dctx.run.nn.units.foreach { compilationUnit =>
+        // mirrors code from TastyInspector
+        thunk(compilationUnit.tpdTree.asInstanceOf[reflect.Tree])
+      }
+
     val symbolsToSkip: Set[reflect.Symbol] =
       ctx.args.identifiersToSkip.flatMap { ref =>
         val qrSymbol = reflect.Symbol
@@ -104,8 +116,7 @@ case class ScaladocTastyInspector()(using ctx: DocContext) extends Inspector:
           rootDoc = Some(parseCommentString(using parser.qctx, summon[DocContext])(content, topLevelPck, None))
         }
 
-    for tasty <- tastys do {
-      val root = tasty.ast
+    hackForeachTree { root =>
       if !isSkipped(root.symbol) then
         val treeRoot = root.asInstanceOf[parser.qctx.reflect.Tree]
         processRootDocIfNeeded(treeRoot)
@@ -130,7 +141,23 @@ case class ScaladocTastyInspector()(using ctx: DocContext) extends Inspector:
       topLevels += "scala" -> Member(scalaPckg.fullName, "", scalaPckg.dri, Kind.Package)
       topLevels += mergeAnyRefAliasAndObject(parser)
 
+  def result(): (List[Member], Option[Comment]) =
+    topLevels.clear()
+    rootDoc = None
+    val filePaths = ctx.args.tastyFiles.map(_.getAbsolutePath).toList
+    val classpath = ctx.args.classpath.split(java.io.File.pathSeparator).toList
 
+    if filePaths.nonEmpty then inspectFilesInContext(classpath, filePaths)
+
+    val all = topLevels.result()
+    all.groupBy(_._1).map { case (pckName, members) =>
+      val (pcks, rest) = members.map(_._2).partition(_.kind == Kind.Package)
+      val basePck = pcks.reduce( (p1, p2) =>
+        val withNewMembers = p1.withNewMembers(p2.members)
+        if withNewMembers.docs.isEmpty then withNewMembers.withDocs(p2.docs) else withNewMembers
+      )
+      basePck.withMembers((basePck.members ++ rest).sortBy(_.name))
+    }.toList -> rootDoc
 
   def mergeAnyRefAliasAndObject(parser: TastyParser) =
     import parser.qctx.reflect._
@@ -144,36 +171,6 @@ case class ScaladocTastyInspector()(using ctx: DocContext) extends Inspector:
       kind = Kind.Class(Nil, Nil),
       members = objectMembers
     )
-
-object ScaladocTastyInspector:
-
-  def loadDocs()(using ctx: DocContext): (List[Member], Option[Comment]) =
-    val filePaths = ctx.args.tastyFiles.map(_.getAbsolutePath).toList
-    val classpath = ctx.args.classpath.split(java.io.File.pathSeparator).toList
-
-    val inspector = new ScaladocTastyInspector
-
-    val (tastyPaths, nonTastyPaths) = filePaths.partition(_.endsWith(".tasty"))
-    val (jarPaths, invalidPaths) = nonTastyPaths.partition(_.endsWith(".jar"))
-
-    for invalidPath <- invalidPaths do
-      report.error("File extension is not `tasty` or `jar`: " + invalidPath)
-
-    if tastyPaths.nonEmpty then
-      TastyInspector.inspectAllTastyFiles(tastyPaths, jarPaths, classpath)(inspector)
-
-    val all = inspector.topLevels.result()
-    all.groupBy(_._1).map { case (pckName, members) =>
-      val (pcks, rest) = members.map(_._2).partition(_.kind == Kind.Package)
-      val basePck = pcks.reduce( (p1, p2) =>
-        val withNewMembers = p1.withNewMembers(p2.members)
-        if withNewMembers.docs.isEmpty then withNewMembers.withDocs(p2.docs) else withNewMembers
-      )
-      basePck.withMembers((basePck.members ++ rest).sortBy(_.name))
-    }.toList -> inspector.rootDoc
-
-end ScaladocTastyInspector
-
 /** Parses a single Tasty compilation unit. */
 case class TastyParser(
   qctx: Quotes,

scaladoc/src/scala/tasty/inspector/DocTastyInspector.scala

@@ -0,0 +1,9 @@
+package scala.tasty.inspector
+
+import dotty.tools.dotc.core.Contexts.Context
+
+abstract class DocTastyInspector extends OldTastyInspector:
+  def inspectFilesInDocContext(
+    classpath: List[String],
+    filePaths: List[String])(
+      using Context): Unit = inspectFilesInContext(classpath, filePaths)