changes: make mtags compile in dotty, changes metals code and adds new based on comment collection commit

Author: rochala

build.sbt

@@ -28,6 +28,7 @@ val `scala3-bench-run` = Build.`scala3-bench-run`
 val dist = Build.dist
 val `community-build` = Build.`community-build`
 val `sbt-community-build` = Build.`sbt-community-build`
+val `scala3-presentation-compiler` = Build.`scala3-presentation-compiler`
 
 val sjsSandbox = Build.sjsSandbox
 val sjsJUnitTests = Build.sjsJUnitTests

presentation-compiler/src/main/scala/meta/internal/mtags/MtagsEnrichments.scala

@@ -28,8 +28,11 @@ import dotty.tools.dotc.util.SourcePosition
 import dotty.tools.dotc.util.Spans
 import dotty.tools.dotc.util.Spans.Span
 import org.eclipse.{lsp4j as l}
+import dotty.tools.dotc.semanticdb.SymbolInformation
+import scala.meta.internal.metals.WorkspaceSymbolQuery
+import dotty.tools.dotc.semanticdb.SymbolInformation.Kind
 
-object MtagsEnrichments extends ScalametaCommonEnrichments:
+object MtagsEnrichments extends CommonMtagsEnrichments:
 
   extension (driver: InteractiveDriver)
 
@@ -155,7 +158,7 @@ object MtagsEnrichments extends ScalametaCommonEnrichments:
     def isStale: Boolean =
       sym.sourcePos.span.exists && {
         val source = ctx.source
-        if source ne sym.source then
+        if (source ne sym.source) && source.path == sym.source.path then
           !source.content.startsWith(
             sym.decodedName.toString(),
             sym.sourcePos.span.point,
@@ -270,4 +273,16 @@ object MtagsEnrichments extends ScalametaCommonEnrichments:
           AppliedType(tycon, params.map(_.metalsDealias))
         case dealised => dealised
 
+  extension (query: WorkspaceSymbolQuery)
+    def matches(info: SymbolInformation) =
+      info.kind.isRelevantKind && query.matches(info.symbol)
+
+  extension (kind: Kind)
+    def isRelevantKind: Boolean =
+      kind match
+        case Kind.OBJECT | Kind.PACKAGE_OBJECT | Kind.CLASS | Kind.TRAIT |
+            Kind.INTERFACE | Kind.METHOD | Kind.TYPE =>
+          true
+        case _ => false
+
 end MtagsEnrichments

presentation-compiler/src/main/scala/meta/internal/pc/AutoImports.scala

@@ -16,6 +16,7 @@ import dotty.tools.dotc.core.Symbols.*
 import dotty.tools.dotc.util.SourcePosition
 import dotty.tools.dotc.util.Spans
 import org.eclipse.{lsp4j as l}
+import dotty.tools.dotc.core.Comments.Comment
 
 object AutoImports extends AutoImportsBackticks:
 
@@ -90,13 +91,14 @@ object AutoImports extends AutoImportsBackticks:
       pos: SourcePosition,
       text: String,
       tree: Tree,
+      comments: List[Comment],
       indexedContext: IndexedContext,
       config: PresentationCompilerConfig,
   ): AutoImportsGenerator =
 
     import indexedContext.ctx
 
-    val importPos = autoImportPosition(pos, text, tree)
+    val importPos = autoImportPosition(pos, text, tree, comments)
     val renameConfig: Map[Symbol, String] = AutoImport.renameConfigMap(config)
 
     val renames =
@@ -288,6 +290,7 @@ object AutoImports extends AutoImportsBackticks:
       pos: SourcePosition,
       text: String,
       tree: Tree,
+      comments: List[Comment],
   )(using Context): AutoImportPosition =
 
     @tailrec
@@ -314,16 +317,23 @@ object AutoImports extends AutoImportsBackticks:
           }.headOption
         case _ => None
 
+    def skipUsingDirectivesOffset =
+      comments
+        .takeWhile(comment =>
+          !comment.isDocComment && comment.span.end < firstObjectBody(tree)
+            .fold(0)(_.span.start)
+        )
+        .lastOption
+        .fold(0)(_.span.end + 1)
+
     def forScalaSource: Option[AutoImportPosition] =
       lastPackageDef(None, tree).map { pkg =>
         val lastImportStatement =
           pkg.stats.takeWhile(_.isInstanceOf[Import]).lastOption
         val (lineNumber, padTop) = lastImportStatement match
           case Some(stm) => (stm.endPos.line + 1, false)
           case None if pkg.pid.symbol.isEmptyPackage =>
-            val offset =
-              ScriptFirstImportPosition.skipUsingDirectivesOffset(text)
-            (pos.source.offsetToLine(offset), false)
+            (pos.source.offsetToLine(skipUsingDirectivesOffset), false)
           case None =>
             val pos = pkg.pid.endPos
             val line =
@@ -346,8 +356,9 @@ object AutoImports extends AutoImportsBackticks:
           case None =>
             val scriptOffset =
               if isAmmonite then
-                ScriptFirstImportPosition.ammoniteScStartOffset(text)
-              else ScriptFirstImportPosition.scalaCliScStartOffset(text)
+                ScriptFirstImportPosition.ammoniteScStartOffset(text, comments)
+              else
+                ScriptFirstImportPosition.scalaCliScStartOffset(text, comments)
 
             scriptOffset.getOrElse(
               pos.source.lineToOffset(tmpl.self.srcPos.line)
@@ -360,7 +371,7 @@ object AutoImports extends AutoImportsBackticks:
 
     def fileStart =
       AutoImportPosition(
-        ScriptFirstImportPosition.skipUsingDirectivesOffset(text),
+        skipUsingDirectivesOffset,
         0,
         padTop = false,
       )

presentation-compiler/src/main/scala/meta/internal/pc/AutoImportsProvider.scala

@@ -82,6 +82,7 @@ final class AutoImportsProvider(
                 correctedPos,
                 params.text,
                 tree,
+                unit.comments,
                 indexedContext.importContext,
                 config,
               )

presentation-compiler/src/main/scala/meta/internal/pc/HoverProvider.scala

@@ -183,30 +183,16 @@ end HoverProvider
 object SelectDynamicExtractor:
   def unapply(path: List[Tree])(using Context) =
     path match
-      // the same tests as below, since 3.3.1-RC1 path starts with Select
-      case Select(_, _) :: Apply(
-            Select(Apply(reflSel, List(sel)), n),
-            List(Literal(Constant(name: String))),
-          ) :: _
-          if (n == nme.selectDynamic || n == nme.applyDynamic) &&
-            nme.reflectiveSelectable == reflSel.symbol.name =>
-        Some(sel, n, name)
       // tests `structural-types` and `structural-types1` in HoverScala3TypeSuite
-      case Apply(
+      case Select(_, _) :: Apply(
             Select(Apply(reflSel, List(sel)), n),
             List(Literal(Constant(name: String))),
           ) :: _
           if (n == nme.selectDynamic || n == nme.applyDynamic) &&
             nme.reflectiveSelectable == reflSel.symbol.name =>
         Some(sel, n, name)
-      // the same tests as below, since 3.3.1-RC1 path starts with Select
-      case Select(_, _) :: Apply(
-            Select(sel, n),
-            List(Literal(Constant(name: String))),
-          ) :: _ if n == nme.selectDynamic || n == nme.applyDynamic =>
-        Some(sel, n, name)
       // tests `selectable`,  `selectable2` and `selectable-full` in HoverScala3TypeSuite
-      case Apply(
+      case Select(_, _) :: Apply(
             Select(sel, n),
             List(Literal(Constant(name: String))),
           ) :: _ if n == nme.selectDynamic || n == nme.applyDynamic =>

presentation-compiler/src/main/scala/meta/internal/pc/InferredTypeProvider.scala

@@ -79,6 +79,7 @@ final class InferredTypeProvider(
       pos,
       params.text,
       unit.tpdTree,
+      unit.comments,
       indexedCtx,
       config,
     )

presentation-compiler/src/main/scala/meta/internal/pc/PcCollector.scala

@@ -247,8 +247,10 @@ abstract class PcCollector[T](
     def collectParams(
         extMethods: ExtMethods
     ): Option[ExtensionParamOccurence] =
-      MetalsNavigateAST
-        .pathToExtensionParam(pos.span, extMethods)(using compilatonUnitContext)
+      NavigateAST
+        .pathTo(pos.span, extMethods.paramss.flatten)(using
+          compilatonUnitContext
+        )
         .collectFirst {
           case v: untpd.ValOrTypeDef =>
             ExtensionParamOccurence(

presentation-compiler/src/main/scala/meta/internal/pc/PcInlineValueProviderImpl.scala

@@ -92,7 +92,6 @@ final class PcInlineValueProviderImpl(
           case _ => false
 
   end referenceRequiresBrackets
-  // format: on
 
   private def adjustRhs(pos: SourcePosition) =
     def extend(point: Int, acceptedChar: Char, step: Int): Int =

presentation-compiler/src/main/scala/meta/internal/pc/ScalaPresentationCompiler.scala

@@ -9,7 +9,7 @@ import java.util.concurrent.ExecutorService
 import java.util.concurrent.ScheduledExecutorService
 import java.{util as ju}
 
-import scala.collection.JavaConverters.*
+import scala.jdk.CollectionConverters._
 import scala.concurrent.ExecutionContext
 import scala.concurrent.ExecutionContextExecutor
 
@@ -18,12 +18,12 @@ import scala.meta.internal.metals.EmptyReportContext
 import scala.meta.internal.metals.ReportContext
 import scala.meta.internal.metals.ReportLevel
 import scala.meta.internal.metals.StdReportContext
-import scala.meta.internal.mtags.BuildInfo
 import scala.meta.internal.pc.completions.CompletionProvider
 import scala.meta.internal.pc.completions.OverrideCompletions
 import scala.meta.pc.*
 
 import dotty.tools.dotc.reporting.StoreReporter
+import dotty.tools.pc.util.BuildInfo
 import org.eclipse.lsp4j.DocumentHighlight
 import org.eclipse.lsp4j.TextEdit
 import org.eclipse.{lsp4j as l}
@@ -42,7 +42,7 @@ case class ScalaPresentationCompiler(
 
   def this() = this("", Nil, Nil)
 
-  val scalaVersion = BuildInfo.scalaCompilerVersion
+  val scalaVersion = BuildInfo.scalaVersion
 
   private val forbiddenOptions = Set("-print-lines", "-print-tasty")
   private val forbiddenDoubleOptions = Set("-release")

presentation-compiler/src/main/scala/meta/internal/pc/ScriptFirstImportPosition.scala

@@ -0,0 +1,44 @@
+package scala.meta.internal.pc
+
+import dotty.tools.dotc.core.Comments.Comment
+import dotty.tools.dotc.ast.tpd.*
+
+object ScriptFirstImportPosition:
+
+  val usingDirectives: List[String] = List("// using", "//> using")
+  val ammHeaders: List[String] = List("// scala", "// ammonite")
+
+  def ammoniteScStartOffset(
+      text: String,
+      comments: List[Comment],
+  ): Option[Int] =
+    findStartOffset(text, comments, commentQuery = "/*<start>*/", ammHeaders)
+
+  def scalaCliScStartOffset(
+      text: String,
+      comments: List[Comment],
+  ): Option[Int] =
+    findStartOffset(
+      text,
+      comments,
+      commentQuery = "/*<script>*/",
+      usingDirectives,
+    )
+
+  def findStartOffset(
+      text: String,
+      comments: List[Comment],
+      commentQuery: String,
+      excludedComments: List[String],
+  ): Option[Int] =
+    val startComment =
+      Option(comments.indexWhere(_.raw == commentQuery)).filter(_ >= 0)
+    startComment.flatMap { startIndex =>
+      val commentsInsideScript = comments.drop(startIndex + 1)
+      val (headers, rest) =
+        commentsInsideScript.span(comment =>
+          excludedComments.exists(comment.raw.startsWith)
+        )
+      if headers.isEmpty then Some(comments(startIndex).span.end + 1)
+      else headers.lastOption.map(_.span.end + 1)
+    }