Merge pull request scala#352 from scala/backport-lts-3.3-22915

tgodzik · web-flow · commit e105bdc161a4 · 2025-04-28T10:41:08.000+02:00
Backport "pc: Properly adjust indentation when inlining blocks" to 3.3 LTS
diff --git a/presentation-compiler/src/main/dotty/tools/pc/PcInlineValueProvider.scala b/presentation-compiler/src/main/dotty/tools/pc/PcInlineValueProvider.scala
@@ -16,17 +16,76 @@ import dotty.tools.dotc.core.StdNames
 import dotty.tools.dotc.core.Symbols.Symbol
 import dotty.tools.dotc.interactive.Interactive
 import dotty.tools.dotc.interactive.InteractiveDriver
+import dotty.tools.dotc.util.SourceFile
 import dotty.tools.dotc.util.SourcePosition
 import dotty.tools.pc.utils.InteractiveEnrichments.*
 import dotty.tools.pc.IndexedContext.Result
 
 import org.eclipse.lsp4j as l
 
-final class PcInlineValueProviderImpl(
+final class PcInlineValueProvider(
     driver: InteractiveDriver,
     val params: OffsetParams
-) extends WithSymbolSearchCollector[Option[Occurence]](driver, params)
-    with InlineValueProvider:
+) extends WithSymbolSearchCollector[Option[Occurence]](driver, params):
+
+  // We return a result or an error
+  def getInlineTextEdits(): Either[String, List[l.TextEdit]] =
+    defAndRefs() match {
+      case Right((defn, refs)) =>
+        val edits =
+          if (defn.shouldBeRemoved) {
+            val defEdit = definitionTextEdit(defn)
+            val refsEdits = refs.map(referenceTextEdit(defn))
+            defEdit :: refsEdits
+          } else refs.map(referenceTextEdit(defn))
+        Right(edits)
+      case Left(error) => Left(error)
+    }
+
+  private def referenceTextEdit(
+      definition: Definition
+  )(ref: Reference): l.TextEdit =
+    if (definition.requiresBrackets && ref.requiresBrackets)
+      new l.TextEdit(
+        ref.range,
+        s"""(${ref.rhs})"""
+      )
+    else new l.TextEdit(ref.range, ref.rhs)
+
+  private def definitionTextEdit(definition: Definition): l.TextEdit =
+    new l.TextEdit(
+      extend(
+        definition.rangeOffsets.start,
+        definition.rangeOffsets.end,
+        definition.range
+      ),
+      ""
+    )
+
+  private def extend(
+      startOffset: Int,
+      endOffset: Int,
+      range: l.Range
+  ): l.Range = {
+    val (startWithSpace, endWithSpace): (Int, Int) =
+      extendRangeToIncludeWhiteCharsAndTheFollowingNewLine(
+        text
+      )(startOffset, endOffset)
+    val startPos = new l.Position(
+      range.getStart.getLine,
+      range.getStart.getCharacter - (startOffset - startWithSpace)
+    )
+    val endPos =
+      if (endWithSpace - 1 >= 0 && text(endWithSpace - 1) == '\n')
+        new l.Position(range.getEnd.getLine + 1, 0)
+      else
+        new l.Position(
+          range.getEnd.getLine,
+          range.getEnd.getCharacter + endWithSpace - endOffset
+        )
+
+    new l.Range(startPos, endPos)
+  }
 
   val position: l.Position = pos.toLsp.getStart().nn
 
@@ -41,7 +100,7 @@ final class PcInlineValueProviderImpl(
         Some(Occurence(tree, parent, adjustedPos))
       case _ => None
 
-  override def defAndRefs(): Either[String, (Definition, List[Reference])] =
+  def defAndRefs(): Either[String, (Definition, List[Reference])] =
     val newctx = driver.currentCtx.fresh.setCompilationUnit(unit)
     val allOccurences = result().flatten
     for
@@ -60,7 +119,6 @@ final class PcInlineValueProviderImpl(
       val defPos = definition.tree.sourcePos
       val defEdit = Definition(
         defPos.toLsp,
-        adjustRhs(definition.tree.rhs.sourcePos),
         RangeOffset(defPos.start, defPos.end),
         definitionRequiresBrackets(definition.tree.rhs)(using newctx),
         deleteDefinition
@@ -70,6 +128,18 @@ final class PcInlineValueProviderImpl(
     end for
   end defAndRefs
 
+  private def stripIndentPrefix(rhs: String, refIndent: String, defIndent: String): String =
+    val rhsLines = rhs.split("\n").toList
+    rhsLines match
+      case h :: Nil => rhs
+      case h :: t =>
+        val noPrefixH = h.stripPrefix(refIndent)
+        if noPrefixH.startsWith("{") then
+          noPrefixH ++ t.map(refIndent ++ _.stripPrefix(defIndent)).mkString("\n","\n", "")
+        else
+          (("  " ++ h) :: t).map(refIndent ++ _.stripPrefix(defIndent)).mkString("\n", "\n", "")
+      case Nil => rhs
+
   private def definitionRequiresBrackets(tree: Tree)(using Context): Boolean =
     NavigateAST
       .untypedPath(tree.span)
@@ -102,12 +172,12 @@ final class PcInlineValueProviderImpl(
 
   end referenceRequiresBrackets
 
-  private def adjustRhs(pos: SourcePosition) =
+  private def extendWithSurroundingParens(pos: SourcePosition) =
+    /** Move `point` by `step` as long as the character at `point` is `acceptedChar` */
     def extend(point: Int, acceptedChar: Char, step: Int): Int =
       val newPoint = point + step
-      if newPoint > 0 && newPoint < text.length && text(
-          newPoint
-        ) == acceptedChar
+      if newPoint > 0 && newPoint < text.length &&
+        text(newPoint) == acceptedChar
       then extend(newPoint, acceptedChar, step)
       else point
     val adjustedStart = extend(pos.start, '(', -1)
@@ -139,7 +209,7 @@ final class PcInlineValueProviderImpl(
       .exists(e => e.isTerm)
     def allreferences = allOccurences.filterNot(_.isDefn)
     def inlineAll() =
-      makeRefsEdits(allreferences, symbols).map((true, _))
+      makeRefsEdits(allreferences, symbols, definition).map((true, _))
     if definition.tree.sourcePos.toLsp.encloses(position)
     then if defIsLocal then inlineAll() else Left(Errors.notLocal)
     else
@@ -150,14 +220,28 @@ final class PcInlineValueProviderImpl(
             ref <- list
               .find(_.pos.toLsp.encloses(position))
               .toRight(Errors.didNotFindReference)
-            refEdits <- makeRefsEdits(List(ref), symbols)
+            refEdits <- makeRefsEdits(List(ref), symbols, definition)
           yield (false, refEdits)
     end if
   end getReferencesToInline
 
+  extension (pos: SourcePosition)
+    def startColumnIndentPadding: String = {
+      val source = pos.source
+      val offset = pos.start
+      var idx = source.startOfLine(offset)
+      val pad = new StringBuilder
+      while (idx != offset && idx < source.content().length && source.content()(idx).isWhitespace) {
+        pad.append(if (idx < source.content().length && source.content()(idx) == '\t') '\t' else ' ')
+        idx += 1
+      }
+      pad.result()
+    }
+
   private def makeRefsEdits(
       refs: List[Occurence],
-      symbols: Set[Symbol]
+      symbols: Set[Symbol],
+      definition: DefinitionTree
   ): Either[String, List[Reference]] =
     val newctx = driver.currentCtx.fresh.setCompilationUnit(unit)
     def buildRef(occurrence: Occurence): Either[String, Reference] =
@@ -178,6 +262,11 @@ final class PcInlineValueProviderImpl(
         Right(
           Reference(
             occurrence.pos.toLsp,
+            stripIndentPrefix(
+              extendWithSurroundingParens(definition.tree.rhs.sourcePos),
+              occurrence.tree.startPos.startColumnIndentPadding,
+              definition.tree.startPos.startColumnIndentPadding
+            ),
             occurrence.parent.map(p =>
               RangeOffset(p.sourcePos.start, p.sourcePos.end)
             ),
@@ -196,7 +285,7 @@ final class PcInlineValueProviderImpl(
     )
   end makeRefsEdits
 
-end PcInlineValueProviderImpl
+end PcInlineValueProvider
 
 case class Occurence(tree: Tree, parent: Option[Tree], pos: SourcePosition):
   def isDefn =
@@ -205,3 +294,19 @@ case class Occurence(tree: Tree, parent: Option[Tree], pos: SourcePosition):
       case _ => false
 
 case class DefinitionTree(tree: ValDef, pos: SourcePosition)
+
+case class RangeOffset(start: Int, end: Int)
+
+case class Definition(
+    range: l.Range,
+    rangeOffsets: RangeOffset,
+    requiresBrackets: Boolean,
+    shouldBeRemoved: Boolean
+)
+
+case class Reference(
+    range: l.Range,
+    rhs: String,
+    parentOffsets: Option[RangeOffset],
+    requiresBrackets: Boolean
+)
diff --git a/presentation-compiler/src/main/dotty/tools/pc/ScalaPresentationCompiler.scala b/presentation-compiler/src/main/dotty/tools/pc/ScalaPresentationCompiler.scala
@@ -355,7 +355,7 @@ case class ScalaPresentationCompiler(
     val empty: Either[String, List[l.TextEdit]] = Right(List())
     (compilerAccess
       .withInterruptableCompiler(empty, params.token()) { pc =>
-        new PcInlineValueProviderImpl(pc.compiler(), params)
+        new PcInlineValueProvider(pc.compiler(), params)
           .getInlineTextEdits()
       }(params.toQueryContext))
       .thenApply {
diff --git a/presentation-compiler/test/dotty/tools/pc/tests/edit/InlineValueSuite.scala b/presentation-compiler/test/dotty/tools/pc/tests/edit/InlineValueSuite.scala
@@ -228,7 +228,8 @@ class InlineValueSuite extends BaseCodeActionSuite with CommonMtagsEnrichments:
          |  for {
          |    i <- List(1,2,3)
          |  } yield i + 1
-         |val b = (for {
+         |val b = (
+         |  for {
          |    i <- List(1,2,3)
          |  } yield i + 1).map(_ + 1)
          |}""".stripMargin
@@ -407,6 +408,52 @@ class InlineValueSuite extends BaseCodeActionSuite with CommonMtagsEnrichments:
       InlineErrors.variablesAreShadowed("T.a")
     )
 
+  @Test def `i7137` =
+    checkEdit(
+      """|object O {
+         |  def foo = {
+         |    val newValue =
+         |      val x = true
+         |      x
+         |    val xx =new<<V>>alue
+         |  }
+         |}
+         |""".stripMargin,
+      """|object O {
+         |  def foo = {
+         |    val xx =
+         |      val x = true
+         |      x
+         |  }
+         |}
+         |""".stripMargin
+    )
+
+  @Test def `i7137a` =
+      checkEdit(
+        """|object O {
+            |  def foo = {
+            |    val newValue = {
+            |      val x = true
+            |      x
+            |    }
+            |    def bar =
+            |      val xx = new<<V>>alue
+            |  }
+            |}
+            |""".stripMargin,
+        """|object O {
+            |  def foo = {
+            |    def bar =
+            |      val xx = {
+            |        val x = true
+            |        x
+            |      }
+            |  }
+            |}
+            |""".stripMargin
+      )
+
   def checkEdit(
       original: String,
       expected: String,
