Skip to content

Use untpd.Tree instead of tpd.Tree for SelectionRangeProvider #22702

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 6, 2025
Merged

Use untpd.Tree instead of tpd.Tree for SelectionRangeProvider #22702

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
90ebd6f
Use untpd.Tree instead of tpd.Tree for SelectionRangeProvider
rochala Mar 4, 2025
af12fac
Refactor
rochala May 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 27 additions & 26 deletions presentation-compiler/src/main/dotty/tools/pc/SelectionRangeProvider.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ import java.util as ju
import scala.jdk.CollectionConverters._
import scala.meta.pc.OffsetParams

import dotty.tools.dotc.ast.tpd
import dotty.tools.dotc.ast.untpd.*
import dotty.tools.dotc.ast.NavigateAST
import dotty.tools.dotc.core.Contexts.Context
import dotty.tools.dotc.interactive.Interactive
import dotty.tools.dotc.interactive.InteractiveDriver
Expand All @@ -23,10 +24,7 @@ import org.eclipse.lsp4j.SelectionRange
* @param compiler Metals Global presentation compiler wrapper.
* @param params offset params converted from the selectionRange params.
*/
class SelectionRangeProvider(
driver: InteractiveDriver,
params: ju.List[OffsetParams]
):
class SelectionRangeProvider(driver: InteractiveDriver, params: ju.List[OffsetParams]):

/**
* Get the seletion ranges for the provider params
Expand All @@ -44,10 +42,13 @@ class SelectionRangeProvider(
val source = SourceFile.virtual(filePath.toString, text)
driver.run(uri, source)
val pos = driver.sourcePosition(param)
val path =
Interactive.pathTo(driver.openedTrees(uri), pos)(using ctx)
val unit = driver.compilationUnits(uri)

val bareRanges = path
val untpdPath: List[Tree] = NavigateAST
.pathTo(pos.span, List(unit.untpdTree), true).collect:
case untpdTree: Tree => untpdTree

val bareRanges = untpdPath
.flatMap(selectionRangesFromTree(pos))

val comments =
Expand Down Expand Up @@ -78,31 +79,31 @@ class SelectionRangeProvider(
end selectionRange

/** Given a tree, create a seq of [[SelectionRange]]s corresponding to that tree. */
private def selectionRangesFromTree(pos: SourcePosition)(tree: tpd.Tree)(using Context) =
private def selectionRangesFromTree(pos: SourcePosition)(tree: Tree)(using Context) =
def toSelectionRange(srcPos: SourcePosition) =
val selectionRange = new SelectionRange()
selectionRange.setRange(srcPos.toLsp)
selectionRange

val treeSelectionRange = toSelectionRange(tree.sourcePos)
val treeSelectionRange = Seq(toSelectionRange(tree.sourcePos))

def allArgsSelectionRange(args: List[Tree]): Option[SelectionRange] =
args match
case Nil => None
case list =>
val srcPos = list.head.sourcePos
val lastSpan = list.last.span
val allArgsSrcPos = SourcePosition(srcPos.source, srcPos.span union lastSpan, srcPos.outer)
if allArgsSrcPos.contains(pos) then Some(toSelectionRange(allArgsSrcPos))
else None

tree match
case tpd.DefDef(name, paramss, tpt, rhs) =>
// If source position is within a parameter list, add a selection range covering that whole list.
val selectedParams =
paramss
.iterator
.flatMap: // parameter list to a sourcePosition covering the whole list
case Seq(param) => Some(param.sourcePos)
case params @ Seq(head, tail*) =>
val srcPos = head.sourcePos
val lastSpan = tail.last.span
Some(SourcePosition(srcPos.source, srcPos.span union lastSpan, srcPos.outer))
case Seq() => None
.find(_.contains(pos))
.map(toSelectionRange)
selectedParams ++ Seq(treeSelectionRange)
case _ => Seq(treeSelectionRange)
case DefDef(_, paramss, _, _) => paramss.flatMap(allArgsSelectionRange) ++ treeSelectionRange
case Apply(_, args) => allArgsSelectionRange(args) ++ treeSelectionRange
case TypeApply(_, args) => allArgsSelectionRange(args) ++ treeSelectionRange
case UnApply(_, _, pattern) => allArgsSelectionRange(pattern) ++ treeSelectionRange
case Function(args, body) => allArgsSelectionRange(args) ++ treeSelectionRange
case _ => treeSelectionRange

private def setParent(
child: SelectionRange,
Expand Down
121 changes: 120 additions & 1 deletion presentation-compiler/test/dotty/tools/pc/tests/SelectionRangeSuite.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,12 @@ class SelectionRangeSuite extends BaseSelectionRangeSuite:
| b <- Some(2)
| } yield a + b
|}""".stripMargin,
"""|object Main extends App {
| val total = for {
| >>region>>a <- Some(1)<<region<<
| b <- Some(2)
| } yield a + b
|}""".stripMargin,
"""|object Main extends App {
| val total = >>region>>for {
| a <- Some(1)
Expand Down Expand Up @@ -102,7 +108,7 @@ class SelectionRangeSuite extends BaseSelectionRangeSuite:
)
)

@Test def `function params` =
@Test def `function-params-1` =
check(
"""|object Main extends App {
| def func(a@@: Int, b: Int) =
Expand All @@ -124,6 +130,32 @@ class SelectionRangeSuite extends BaseSelectionRangeSuite:
)
)

@Test def `function-params-2` =
check(
"""|object Main extends App {
| val func = (a@@: Int, b: Int) =>
| a + b
|}""".stripMargin,
List[String](
"""|object Main extends App {
| val func = (>>region>>a: Int<<region<<, b: Int) =>
| a + b
|}""".stripMargin,
"""|object Main extends App {
| val func = (>>region>>a: Int, b: Int<<region<<) =>
| a + b
|}""".stripMargin,
"""|object Main extends App {
| val func = >>region>>(a: Int, b: Int) =>
| a + b<<region<<
|}""".stripMargin,
"""|object Main extends App {
| >>region>>val func = (a: Int, b: Int) =>
| a + b<<region<<
|}""".stripMargin
)
)

@Test def `def - type params` =
check(
"object Main extends App { def foo[Type@@ <: T1, B](hi: Int, b: Int, c:Int) = ??? }",
Expand All @@ -133,3 +165,90 @@ class SelectionRangeSuite extends BaseSelectionRangeSuite:
"object Main extends App { >>region>>def foo[Type <: T1, B](hi: Int, b: Int, c:Int) = ???<<region<< }"
)
)


@Test def `arithmetic` =
check(
"""|object Main extends App {
| def x = 12 * (34 + 5@@6)
|}""".stripMargin,
List(
"""|object Main extends App {
| def x = 12 * (34 + >>region>>56<<region<<)
|}""".stripMargin,
"""|object Main extends App {
| def x = 12 * (>>region>>34 + 56<<region<<)
|}""".stripMargin,
"""|object Main extends App {
| def x = 12 * >>region>>(34 + 56)<<region<<
|}""".stripMargin,
"""|object Main extends App {
| def x = >>region>>12 * (34 + 56)<<region<<
|}""".stripMargin
)
)

@Test def `function` =
check(
"val hello = (aaa: Int, bb@@b: Int, ccc: Int) => ???",
List(
"val hello = (aaa: Int, >>region>>bbb: Int<<region<<, ccc: Int) => ???",
"val hello = (>>region>>aaa: Int, bbb: Int, ccc: Int<<region<<) => ???",
"val hello = >>region>>(aaa: Int, bbb: Int, ccc: Int) => ???<<region<<",
">>region>>val hello = (aaa: Int, bbb: Int, ccc: Int) => ???<<region<<",
)
)

@Test def `defdef` =
check(
"def hello(aaa: Int, bb@@b: Int, ccc: Int) = ???",
List(
"def hello(aaa: Int, >>region>>bbb: Int<<region<<, ccc: Int) = ???",
"def hello(>>region>>aaa: Int, bbb: Int, ccc: Int<<region<<) = ???",
">>region>>def hello(aaa: Int, bbb: Int, ccc: Int) = ???<<region<<",
)
)

@Test def `apply` =
check(
"def hello = List(111, 2@@22, 333)",
List(
"def hello = List(111, >>region>>222<<region<<, 333)",
"def hello = List(>>region>>111, 222, 333<<region<<)",
"def hello = >>region>>List(111, 222, 333)<<region<<",
">>region>>def hello = List(111, 222, 333)<<region<<",
)
)

@Test def `type-apply` =
check(
"def hello = Map[String, I@@nt]()",
List(
"def hello = Map[String, >>region>>Int<<region<<]()",
"def hello = Map[>>region>>String, Int<<region<<]()",
"def hello = >>region>>Map[String, Int]<<region<<()",
"def hello = >>region>>Map[String, Int]()<<region<<",
">>region>>def hello = Map[String, Int]()<<region<<",
)
)

@Test def `unapply` =
check(
"val List(aaa, b@@bb, ccc) = List(111, 222, 333)",
List(
"val List(aaa, >>region>>bbb<<region<<, ccc) = List(111, 222, 333)",
"val List(>>region>>aaa, bbb, ccc<<region<<) = List(111, 222, 333)",
"val >>region>>List(aaa, bbb, ccc)<<region<< = List(111, 222, 333)",
">>region>>val List(aaa, bbb, ccc) = List(111, 222, 333)<<region<<",
)
)

@Test def `single` =
check(
"def hello = List(2@@22)",
List(
"def hello = List(>>region>>222<<region<<)",
"def hello = >>region>>List(222)<<region<<",
">>region>>def hello = List(222)<<region<<",
)
)
4 changes: 4 additions & 0 deletions project/Build.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1514,6 +1514,10 @@ object Build {
ivyConfigurations += SourceDeps.hide,
transitiveClassifiers := Seq("sources"),
scalacOptions ++= Seq("-source", "3.3"), // To avoid fatal migration warnings
publishLocal := publishLocal.dependsOn( // It is best to publish all together. It is not rare to make changes in both compiler / presentation compiler and it can get misaligned
`scala3-compiler-bootstrapped` / publishLocal,
`scala3-library-bootstrapped` / publishLocal,
).value,
Compile / scalacOptions ++= Seq("-Yexplicit-nulls", "-Wsafe-init"),
Compile / sourceGenerators += Def.task {
val s = streams.value
Expand Down
Loading