Add Stable Presentation Compiler

presentation-compiler/src/main/dotty/tools/pc/AutoImports.scala

@@ -19,7 +19,7 @@ import dotty.tools.pc.utils.MtagsEnrichments.*
 
 import org.eclipse.lsp4j as l
 
-object AutoImports extends AutoImportsBackticks:
+object AutoImports:
 
   object AutoImport:
     def renameConfigMap(config: PresentationCompilerConfig)(using
@@ -199,7 +199,7 @@ object AutoImports extends AutoImportsBackticks:
               (
                 SymbolIdent.Select(
                   ownerImport.ident,
-                  symbol.nameBacktickedImport
+                  symbol.nameBackticked(false)
                 ),
                 ownerImport.importSel,
               )
@@ -233,7 +233,7 @@ object AutoImports extends AutoImportsBackticks:
                 symbol,
                 SymbolIdent.Select(
                   SymbolIdent.direct(rename),
-                  symbol.nameBacktickedImport
+                  symbol.nameBackticked(false)
                 ),
                 importSel
               )
@@ -272,7 +272,7 @@ object AutoImports extends AutoImportsBackticks:
           .map {
             case ImportSel.Direct(sym) => importName(sym)
             case ImportSel.Rename(sym, rename) =>
-              s"${importName(sym.owner)}.{${sym.nameBacktickedImport} => $rename}"
+              s"${importName(sym.owner)}.{${sym.nameBackticked(false)} => $rename}"
           }
           .map(sel => s"${indent}import $sel")
           .mkString(topPadding, "\n", "\n")
@@ -283,8 +283,8 @@ object AutoImports extends AutoImportsBackticks:
 
     private def importName(sym: Symbol): String =
       if indexedContext.importContext.toplevelClashes(sym) then
-        s"_root_.${sym.fullNameBacktickedImport}"
-      else sym.fullNameBacktickedImport
+        s"_root_.${sym.fullNameBackticked(false)}"
+      else sym.fullNameBackticked(false)
   end AutoImportsGenerator
 
   private def autoImportPosition(
@@ -361,9 +361,12 @@ object AutoImports extends AutoImportsBackticks:
               else
                 ScriptFirstImportPosition.scalaCliScStartOffset(text, comments)
 
-            scriptOffset.getOrElse(
-              pos.source.lineToOffset(tmpl.self.srcPos.line)
-            )
+            scriptOffset.getOrElse {
+              val tmplPoint = tmpl.self.srcPos.span.point
+              if tmplPoint >= 0 && tmplPoint < pos.source.length
+              then pos.source.lineToOffset(tmpl.self.srcPos.line)
+              else 0
+            }
         new AutoImportPosition(offset, text, false)
       }
     end forScript
@@ -388,11 +391,3 @@ object AutoImports extends AutoImportsBackticks:
   end autoImportPosition
 
 end AutoImports
-
-trait AutoImportsBackticks:
-  // Avoids backticketing import parts that match soft keywords
-  extension (sym: Symbol)(using Context)
-    def fullNameBacktickedImport: String =
-      sym.fullNameBackticked(KeywordWrapper.Scala3SoftKeywords)
-    def nameBacktickedImport: String =
-      sym.nameBackticked(KeywordWrapper.Scala3SoftKeywords)

presentation-compiler/src/main/dotty/tools/pc/ExtractMethodProvider.scala

@@ -2,6 +2,7 @@ package dotty.tools.pc
 
 import java.nio.file.Paths
 
+import scala.meta.internal.metals.ReportContext
 import scala.meta.internal.pc.ExtractMethodUtils
 import scala.meta.pc.OffsetParams
 import scala.meta.pc.RangeParams
@@ -33,7 +34,8 @@ final class ExtractMethodProvider(
     driver: InteractiveDriver,
     search: SymbolSearch,
     noIndent: Boolean
-) extends ExtractMethodUtils:
+)(using ReportContext)
+    extends ExtractMethodUtils:
 
   def extractMethod(): List[TextEdit] =
     val text = range.text()

presentation-compiler/src/main/dotty/tools/pc/IndexedContext.scala

@@ -136,18 +136,21 @@ object IndexedContext:
   )
 
   private def extractNames(ctx: Context): Names =
+    def isAccessibleFromSafe(sym: Symbol, site: Type): Boolean =
+      try sym.isAccessibleFrom(site, superAccess = false)
+      catch
+        case NonFatal(e) =>
+          false
 
     def accessibleSymbols(site: Type, tpe: Type)(using
         Context
     ): List[Symbol] =
-      tpe.decls.toList.filter(sym =>
-        sym.isAccessibleFrom(site, superAccess = false)
-      )
+      tpe.decls.toList.filter(sym => isAccessibleFromSafe(sym, site))
 
     def accesibleMembers(site: Type)(using Context): List[Symbol] =
       site.allMembers
         .filter(denot =>
-          try denot.symbol.isAccessibleFrom(site, superAccess = false)
+          try isAccessibleFromSafe(denot.symbol, site)
           catch
             case NonFatal(e) =>
               false

presentation-compiler/src/main/dotty/tools/pc/InferredTypeProvider.scala

@@ -3,6 +3,7 @@ package dotty.tools.pc
 import java.nio.file.Paths
 
 import scala.annotation.tailrec
+import scala.meta.internal.metals.ReportContext
 import scala.meta.pc.OffsetParams
 import scala.meta.pc.PresentationCompilerConfig
 import scala.meta.pc.SymbolSearch
@@ -50,7 +51,7 @@ final class InferredTypeProvider(
     driver: InteractiveDriver,
     config: PresentationCompilerConfig,
     symbolSearch: SymbolSearch
-):
+)(using ReportContext):
 
   case class AdjustTypeOpts(
       text: String,

presentation-compiler/src/main/dotty/tools/pc/PcCollector.scala

@@ -91,18 +91,22 @@ abstract class PcCollector[T](
         else pos1
 
       val pos =
-        if sourceText(pos0.`end` - 1) == ',' then pos0.withEnd(pos0.`end` - 1)
+        if pos0.end > 0 && sourceText(pos0.end - 1) == ',' then
+          pos0.withEnd(pos0.end - 1)
         else pos0
       val isBackticked =
-        sourceText(pos.start) == '`' && sourceText(pos.end - 1) == '`'
+        sourceText(pos.start) == '`' &&
+          pos.end > 0 &&
+          sourceText(pos.end - 1) == '`'
       // when the old name contains backticks, the position is incorrect
       val isOldNameBackticked = sourceText(pos.start) != '`' &&
+        pos.start > 0 &&
         sourceText(pos.start - 1) == '`' &&
         sourceText(pos.end) == '`'
       if isBackticked && forRename then
-        (pos.withStart(pos.start + 1).withEnd(pos.`end` - 1), true)
+        (pos.withStart(pos.start + 1).withEnd(pos.end - 1), true)
       else if isOldNameBackticked then
-        (pos.withStart(pos.start - 1).withEnd(pos.`end` + 1), false)
+        (pos.withStart(pos.start - 1).withEnd(pos.end + 1), false)
       else (pos, false)
   end adjust
 

presentation-compiler/src/main/dotty/tools/pc/SemanticdbSymbols.scala

@@ -6,7 +6,7 @@ import dotty.tools.dotc.core.Contexts.*
 import dotty.tools.dotc.core.Flags.*
 import dotty.tools.dotc.core.Names.*
 import dotty.tools.dotc.core.Symbols.*
-import dotty.tools.dotc.semanticdb._
+import dotty.tools.dotc.semanticdb.*
 
 object SemanticdbSymbols:
 

presentation-compiler/src/main/dotty/tools/pc/completions/CompletionProvider.scala

@@ -218,14 +218,18 @@ class CompletionProvider(
         case _ =>
           false
 
+    lazy val backtickSoftKeyword = path match
+      case (_: Select) :: _ => false
+      case _ => true
+
     def mkItemWithImports(
         v: CompletionValue.Workspace | CompletionValue.Extension |
           CompletionValue.Interpolator
     ) =
       val sym = v.symbol
       path match
         case (_: Ident) :: (_: Import) :: _ =>
-          mkItem(sym.fullNameBackticked)
+          mkItem(sym.fullNameBackticked(backtickSoftKeyword = false))
         case _ =>
           autoImports.editsForSymbol(v.importSymbol) match
             case Some(edits) =>
@@ -239,7 +243,9 @@ class CompletionProvider(
                 case _ =>
                   mkItem(
                     v.insertText.getOrElse(
-                      ident.backticked + completionTextSuffix
+                      ident.backticked(
+                        backtickSoftKeyword
+                      ) + completionTextSuffix
                     ),
                     edits.edits,
                     range = v.range
@@ -249,14 +255,18 @@ class CompletionProvider(
               r match
                 case IndexedContext.Result.InScope =>
                   mkItem(
-                    ident.backticked + completionTextSuffix
+                    ident.backticked(backtickSoftKeyword) + completionTextSuffix
                   )
                 case _ if isInStringInterpolation =>
                   mkItem(
                     "{" + sym.fullNameBackticked + completionTextSuffix + "}"
                   )
                 case _ =>
-                  mkItem(sym.fullNameBackticked + completionTextSuffix)
+                  mkItem(
+                    sym.fullNameBackticked(
+                      backtickSoftKeyword
+                    ) + completionTextSuffix
+                  )
               end match
           end match
       end match
@@ -268,7 +278,8 @@ class CompletionProvider(
       case v: CompletionValue.Interpolator if v.isWorkspace || v.isExtension =>
         mkItemWithImports(v)
       case _ =>
-        val insert = completion.insertText.getOrElse(ident.backticked)
+        val insert =
+          completion.insertText.getOrElse(ident.backticked(backtickSoftKeyword))
         mkItem(
           insert + completionTextSuffix,
           range = completion.range

presentation-compiler/src/main/dotty/tools/pc/completions/Completions.scala

@@ -579,7 +579,7 @@ class Completions(
               ).map(visit).forall(_ == true),
         )
         Some(search.search(query, buildTargetIdentifier, visitor))
-      case CompletionKind.Members if query.nonEmpty =>
+      case CompletionKind.Members =>
         val visitor = new CompilerSearchVisitor(sym =>
           if sym.is(ExtensionMethod) &&
             qualType.widenDealias <:< sym.extensionParam.info.widenDealias
@@ -592,8 +592,6 @@ class Completions(
           else false,
         )
         Some(search.searchMethods(query, buildTargetIdentifier, visitor))
-      case CompletionKind.Members => // query.isEmpry
-        Some(SymbolSearch.Result.INCOMPLETE)
     end match
   end enrichWithSymbolSearch
 

presentation-compiler/src/main/dotty/tools/pc/completions/OverrideCompletions.scala

@@ -4,6 +4,7 @@ package completions
 import java.util as ju
 
 import scala.jdk.CollectionConverters._
+import scala.meta.internal.metals.ReportContext
 import scala.meta.pc.OffsetParams
 import scala.meta.pc.PresentationCompilerConfig
 import scala.meta.pc.PresentationCompilerConfig.OverrideDefFormat
@@ -52,7 +53,7 @@ object OverrideCompletions:
       config: PresentationCompilerConfig,
       autoImportsGen: AutoImportsGenerator,
       fallbackName: Option[String]
-  ): List[CompletionValue] =
+  )(using ReportContext): List[CompletionValue] =
     import indexedContext.ctx
     val clazz = td.symbol.asClass
     val syntheticCoreMethods: Set[Name] =
@@ -133,7 +134,7 @@ object OverrideCompletions:
       driver: InteractiveDriver,
       search: SymbolSearch,
       config: PresentationCompilerConfig
-  ): ju.List[l.TextEdit] =
+  )(using ReportContext): ju.List[l.TextEdit] =
     object FindTypeDef:
       def unapply(path: List[Tree])(using Context): Option[TypeDef] = path match
         // class <<Foo>> extends ... {}
@@ -225,7 +226,7 @@ object OverrideCompletions:
       config: PresentationCompilerConfig
   )(
       defn: TargetDef
-  )(using Context): List[l.TextEdit] =
+  )(using Context, ReportContext): List[l.TextEdit] =
     def calcIndent(
         defn: TargetDef,
         decls: List[Symbol],
@@ -391,7 +392,7 @@ object OverrideCompletions:
       config: PresentationCompilerConfig,
       autoImportsGen: AutoImportsGenerator,
       shouldAddOverrideKwd: Boolean
-  )(using Context): CompletionValue.Override =
+  )(using Context, ReportContext): CompletionValue.Override =
     val renames = AutoImport.renameConfigMap(config)
     val printer = MetalsPrinter.standard(
       indexedContext,

presentation-compiler/src/main/dotty/tools/pc/printer/DotcPrinter.scala

@@ -65,6 +65,15 @@ object DotcPrinter:
     def fullName(sym: Symbol): String =
       fullNameString(sym)
 
+    override def toTextRef(tp: SingletonType): Text = controlled {
+      tp match
+        case tp: TermRef if !printDebug && tp.symbol.is(Package) =>
+          toTextPrefix(tp.prefix) ~
+            tp.symbol.name.stripModuleClassSuffix.toString()
+        case _ =>
+          super.toTextRef(tp)
+    }
+
     override def toText(tp: Type): Text =
       // Override the behavior for `AppliedType` because
       // `toText` in RefinedPrinter doesn't pretty print AppliedType

presentation-compiler/src/main/dotty/tools/pc/printer/MetalsPrinter.scala

@@ -2,8 +2,13 @@ package dotty.tools.pc.printer
 
 import scala.collection.mutable
 import scala.meta.internal.jdk.CollectionConverters.*
+import scala.meta.internal.metals.Report
+import scala.meta.internal.metals.ReportContext
 import scala.meta.pc.SymbolDocumentation
 import scala.meta.pc.SymbolSearch
+import scala.util.Failure
+import scala.util.Success
+import scala.util.Try
 
 import dotty.tools.dotc.core.Contexts.Context
 import dotty.tools.dotc.core.Flags
@@ -28,7 +33,8 @@ class MetalsPrinter(
     includeDefaultParam: MetalsPrinter.IncludeDefaultParam =
       IncludeDefaultParam.ResolveLater,
 )(using
-    Context
+    Context,
+    ReportContext
 ):
 
   private val methodFlags =
@@ -63,8 +69,26 @@ class MetalsPrinter(
       case _ => None
 
   def tpe(tpe: Type): String =
-    val short = names.shortType(tpe)
+    val short = Try(names.shortType(tpe)) match
+      case Success(short) => short
+      case Failure(e) =>
+        val reportContext = summon[ReportContext]
+        val report = Report(
+          "short-name-error",
+          s"""|Error while printing type, could not create short name for type:
+              |
+              |$tpe
+              |
+              |Exception:
+              |${e.getMessage}
+              |${e.getStackTrace.mkString("\n")}
+              |""".stripMargin,
+          tpe.typeSymbol.name.show
+        )
+        reportContext.unsanitized.create(report, ifVerbose = false)
+        tpe
     dotcPrinter.tpe(short)
+  end tpe
 
   def hoverSymbol(sym: Symbol, info: Type)(using Context): String =
     val typeSymbol = info.typeSymbol
@@ -322,7 +346,7 @@ class MetalsPrinter(
       index: Int,
       defaultValues: => Seq[SymbolDocumentation],
       nameToInfo: Map[Name, Type]
-  ): String =
+  )(using ReportContext): String =
     val docInfo = defaultValues.lift(index)
     val rawKeywordName = dotcPrinter.name(param)
     val keywordName = docInfo match
@@ -409,7 +433,7 @@ object MetalsPrinter:
       symbolSearch: SymbolSearch,
       includeDefaultParam: IncludeDefaultParam,
       renames: Map[Symbol, String] = Map.empty
-  ): MetalsPrinter =
+  )(using ReportContext): MetalsPrinter =
     import indexed.ctx
     MetalsPrinter(
       new ShortenedNames(indexed, renames),
@@ -423,7 +447,7 @@ object MetalsPrinter:
       indexed: IndexedContext,
       symbolSearch: SymbolSearch,
       includeDefaultParam: IncludeDefaultParam
-  ): MetalsPrinter =
+  )(using ReportContext): MetalsPrinter =
     import shortenedNames.indexedContext.ctx
     MetalsPrinter(
       shortenedNames,