Skip to content

Commit

Permalink
improvement: Add separate option for decorations for evidence params
Browse files Browse the repository at this point in the history
  • Loading branch information
@jkciesluk
jkciesluk committed Mar 12, 2024
1 parent d8475d9 commit 4559f71
Show file tree
Hide file tree
Showing 11 changed files with 175 additions and 51 deletions.
1 change: 1 addition & 0 deletions metals-bench/src/main/scala/bench/InlayHintsBench.scala
View file
Expand Up @@ -94,6 +94,7 @@ class InlayHintsBench extends PcBenchmark {
true,
true,
true,
true,
)
pc.inlayHints(pcParams).get().asScala.toList
}
Expand Down
1 change: 1 addition & 0 deletions metals/src/main/scala/scala/meta/internal/metals/Compilers.scala
View file
Expand Up @@ -616,6 +616,7 @@ class Compilers(
userConfig().showInferredType.contains("true"),
implicitParameters = userConfig().showImplicitArguments,
implicitConversions = userConfig().showImplicitConversionsAndClasses,
contextBounds = userConfig().showEvidenceParams,
)

pc
Expand Down
14 changes: 14 additions & 0 deletions metals/src/main/scala/scala/meta/internal/metals/UserConfiguration.scala
View file
Expand Up @@ -44,6 +44,7 @@ case class UserConfiguration(
showInferredType: Option[String] = None,
showImplicitArguments: Boolean = false,
showImplicitConversionsAndClasses: Boolean = false,
showEvidenceParams: Boolean = false,
enableStripMarginOnTypeFormatting: Boolean = true,
enableIndentOnPaste: Boolean = false,
enableSemanticHighlighting: Boolean = true,
Expand Down Expand Up @@ -260,6 +261,16 @@ object UserConfiguration {
|shown in the hover.
|""".stripMargin,
),
UserConfigurationOption(
"show-evidence-params",
"false",
"false",
"Should display context bounds evidence parameters at usage sites",
"""|When this option is enabled, each place where a context bound is used has it
|displayed either as additional decorations if they are supported by the editor or
|shown in the hover.
|""".stripMargin,
),
UserConfigurationOption(
"enable-semantic-highlighting",
"true",
Expand Down Expand Up @@ -538,6 +549,8 @@ object UserConfiguration {
getBooleanKey("show-implicit-arguments").getOrElse(false)
val showImplicitConversionsAndClasses =
getBooleanKey("show-implicit-conversions-and-classes").getOrElse(false)
val showEvidenceParams =
getBooleanKey("show-evidence-params").getOrElse(false)
val enableStripMarginOnTypeFormatting =
getBooleanKey("enable-strip-margin-on-type-formatting").getOrElse(true)
val enableIndentOnPaste =
Expand Down Expand Up @@ -609,6 +622,7 @@ object UserConfiguration {
showInferredType,
showImplicitArguments,
showImplicitConversionsAndClasses,
showEvidenceParams,
enableStripMarginOnTypeFormatting,
enableIndentOnPaste,
enableSemanticHighlighting,
Expand Down
4 changes: 4 additions & 0 deletions mtags-interfaces/src/main/java/scala/meta/pc/InlayHintsParams.java
View file
Expand Up @@ -29,4 +29,8 @@ public interface InlayHintsParams extends RangeParams {
*/
boolean implicitConversions();

default boolean contextBounds() {
return false;
}

}
3 changes: 2 additions & 1 deletion mtags-shared/src/main/scala/scala/meta/internal/metals/CompilerInlayHintsParams.scala
View file
Expand Up @@ -10,7 +10,8 @@ case class CompilerInlayHintsParams(
inferredTypes: Boolean,
typeParameters: Boolean,
implicitParameters: Boolean,
implicitConversions: Boolean
implicitConversions: Boolean,
override val contextBounds: Boolean
) extends InlayHintsParams {
override def uri(): URI = rangeParams.uri
override def text(): String = rangeParams.text
Expand Down
56 changes: 36 additions & 20 deletions mtags/src/main/scala-2/scala/meta/internal/pc/PcInlayHintsProvider.scala
View file
Expand Up @@ -57,17 +57,24 @@ final class PcInlayHintsProvider(
LabelPart(")") :: Nil,
InlayHintKind.Parameter
)
case ImplicitParameters(symbols, pos, allImplicit)
if params.implicitParameters() =>
val labelParts = symbols.map(s => List(labelPart(s, s.decodedName)))
val label =
if (allImplicit) labelParts.separated("(", ", ", ")")
else labelParts.separated(", ")
inlayHints.add(
adjustPos(pos).focusEnd.toLsp,
label,
InlayHintKind.Parameter
)
case ImplicitParameters(args, pos, allImplicit)
if params.implicitParameters() || params.contextBounds() =>
val symbols = args.collect {
case (arg, false) if params.implicitParameters() => arg
case (arg, true) if params.contextBounds() => arg
}
if (symbols.isEmpty) inlayHints
else {
val labelParts = symbols.map(s => List(labelPart(s, s.decodedName)))
val label =
if (allImplicit) labelParts.separated("(", ", ", ")")
else labelParts.separated(", ")
inlayHints.add(
adjustPos(pos).focusEnd.toLsp,
label,
InlayHintKind.Parameter
)
}
case ValueOf(label, pos) if params.implicitParameters() =>
inlayHints.add(
adjustPos(pos).focusEnd.toLsp,
Expand Down Expand Up @@ -160,23 +167,32 @@ final class PcInlayHintsProvider(
fun.pos.isOffset && fun.symbol != null && fun.symbol.isImplicit
}
object ImplicitParameters {
def unapply(tree: Tree): Option[(List[Symbol], Position, Boolean)] =
def unapply(
tree: Tree
): Option[(List[(Symbol, Boolean)], Position, Boolean)] =
tree match {
case Apply(_, args)
case Apply(fun, args)
if args.exists(isSyntheticArg) && !tree.pos.isOffset =>
val (implicitArgs, providedArgs) = args.partition(isSyntheticArg)
val (implicitArgs0, providedArgs) = fun.tpe match {
case mt: MethodType =>
args.zip(mt.params).partition { case (arg, _) =>
isSyntheticArg(arg)
}
case _ => (Nil, Nil)
}
val implicitArgs = implicitArgs0.map { case (arg, sym) =>
(arg.symbol, isContextBoundParam(sym))
}
val allImplicit = providedArgs.isEmpty
val pos = providedArgs.lastOption.fold(tree.pos)(_.pos)
Some(
implicitArgs.map(_.symbol),
pos,
allImplicit
)
val pos = providedArgs.lastOption.fold(tree.pos)(_._1.pos)
Some((implicitArgs, pos, allImplicit))
case _ => None
}

private def isSyntheticArg(arg: Tree): Boolean =
arg.pos.isOffset && arg.symbol != null && arg.symbol.isImplicit
private def isContextBoundParam(sym: Symbol) =
sym.name.toString.startsWith(nme.EVIDENCE_PARAM_PREFIX)
}

object ValueOf {
Expand Down
51 changes: 33 additions & 18 deletions mtags/src/main/scala-3/scala/meta/internal/pc/PcInlayHintsProvider.scala
View file
Expand Up @@ -13,6 +13,8 @@ import dotty.tools.dotc.ast.tpd
import dotty.tools.dotc.ast.tpd.*
import dotty.tools.dotc.core.Contexts.Context
import dotty.tools.dotc.core.Flags
import dotty.tools.dotc.core.NameKinds
import dotty.tools.dotc.core.Names.Name
import dotty.tools.dotc.core.StdNames.*
import dotty.tools.dotc.core.Symbols.*
import dotty.tools.dotc.core.Types.*
Expand Down Expand Up @@ -73,17 +75,23 @@ class PcInlayHintsProvider(
LabelPart(")") :: Nil,
InlayHintKind.Parameter,
)
case ImplicitParameters(symbols, pos, allImplicit)
if params.implicitParameters() =>
val labelParts = symbols.map(s => List(labelPart(s, s.decodedName)))
val label =
if allImplicit then labelParts.separated("(using ", ", ", ")")
else labelParts.separated(", ")
inlayHints.add(
adjustPos(pos).toLsp,
label,
InlayHintKind.Parameter,
)
case ImplicitParameters(args, pos, allImplicit)
if params.implicitParameters() || params.contextBounds() =>
val symbols = args.collect {
case (arg, false) if params.implicitParameters() => arg
case (arg, true) if params.contextBounds() => arg
}
if symbols.isEmpty then inlayHints
else
val labelParts = symbols.map(s => List(labelPart(s, s.decodedName)))
val label =
if allImplicit then labelParts.separated("(using ", ", ", ")")
else labelParts.separated(", ")
inlayHints.add(
adjustPos(pos).toLsp,
label,
InlayHintKind.Parameter,
)
case ValueOf(label, pos) if params.implicitParameters() =>
inlayHints.add(
adjustPos(pos).toLsp,
Expand Down Expand Up @@ -214,19 +222,26 @@ object ImplicitParameters:
tree match
case Apply(fun, args)
if args.exists(isSyntheticArg) && !tree.sourcePos.span.isZeroExtent =>
val (implicitArgs, providedArgs) = args.partition(isSyntheticArg)
val allImplicit = providedArgs.isEmpty || providedArgs.forall {
case Ident(name) => name == nme.MISSING
case _ => false
}
val pos = implicitArgs.head.sourcePos
Some(implicitArgs.map(_.symbol), pos, allImplicit)
val (implicitArgs0, providedArgs) = fun.typeOpt.paramNamess match
case head :: _ =>
args.zip(head).partition((arg, _) => isSyntheticArg(arg))
case Nil => (Nil, Nil)
val pos = implicitArgs0.head._1.sourcePos

val implicitArgs = implicitArgs0.map((arg, name) => (arg.symbol, isContextBoundParam(name)))
val allImplicit = providedArgs.isEmpty || providedArgs.forall {
case (Ident(name), _) => name == nme.MISSING
case _ => false
}
Some(implicitArgs, pos, allImplicit)
case _ => None

private def isSyntheticArg(tree: Tree)(using Context) = tree match
case tree: Ident =>
tree.span.isSynthetic && tree.symbol.isOneOf(Flags.GivenOrImplicit)
case _ => false
private def isContextBoundParam(name: Name) =
name.toString.startsWith(NameKinds.ContextBoundParamName.separator)
end ImplicitParameters

object ValueOf:
Expand Down
16 changes: 11 additions & 5 deletions tests/cross/src/main/scala/tests/BaseInlayHintsSuite.scala
View file
Expand Up @@ -15,7 +15,12 @@ class BaseInlayHintsSuite extends BasePCSuite {
name: TestOptions,
base: String,
expected: String,
compat: Map[String, String] = Map.empty
compat: Map[String, String] = Map.empty,
showInferredType: Boolean = true,
showTypeArguments: Boolean = true,
showImplicitArguments: Boolean = true,
showImplicitConversions: Boolean = true,
showContextBounds: Boolean = true
)(implicit location: Location): Unit =
test(name) {
def pkgWrap(text: String) =
Expand All @@ -31,10 +36,11 @@ class BaseInlayHintsSuite extends BasePCSuite {
)
val pcParams = CompilerInlayHintsParams(
rangeParams,
true,
true,
true,
true
showInferredType,
showTypeArguments,
showImplicitArguments,
showImplicitConversions,
showContextBounds
)

val inlayHints = presentationCompiler
Expand Down
76 changes: 70 additions & 6 deletions tests/cross/src/test/scala/tests/pc/InlayHintsSuite.scala
View file
Expand Up @@ -848,7 +848,25 @@ class InlayHintsSuite extends BaseInlayHintsSuite {
|""".stripMargin
)

// TODO: Add a separate option for hints for context bounds
check(
"context-bounds".tag(IgnoreScala2.and(IgnoreForScala3CompilerPC)),
"""|package example
|object O {
| given Int = 1
| def test[T: Ordering](x: T)(using Int) = ???
| test(1)
|}
|""".stripMargin,
"""|package example
|object O {
| given Int = 1
| def test[T: Ordering](x: T)(using Int)/*: Nothing<<scala/Nothing#>>*/ = ???
| test/*[Int<<scala/Int#>>]*/(1)/*(using given_Int<<(2:8)>>)*/
|}
|""".stripMargin,
showContextBounds = false
)

check(
"context-bounds1".tag(IgnoreScala2.and(IgnoreForScala3CompilerPC)),
"""|package example
Expand Down Expand Up @@ -892,7 +910,24 @@ class InlayHintsSuite extends BaseInlayHintsSuite {
)

check(
"context-bounds3".tag(IgnoreScala2.and(IgnoreForScala3CompilerPC)),
"context-bounds3".tag(IgnoreForScala3CompilerPC),
"""|package example
|object O {
| def test[T: Ordering](x: T) = ???
| test(1)
|}
|""".stripMargin,
"""|package example
|object O {
| def test[T: Ordering](x: T)/*: Nothing<<scala/Nothing#>>*/ = ???
| test/*[Int<<scala/Int#>>]*/(1)
|}
|""".stripMargin,
showContextBounds = false
)

check(
"context-bounds4".tag(IgnoreScala2.and(IgnoreForScala3CompilerPC)),
"""|package example
|object O {
| def test[T: Ordering](x: T)(using Int) = ???
Expand All @@ -908,7 +943,7 @@ class InlayHintsSuite extends BaseInlayHintsSuite {
)

check(
"context-bounds4".tag(IgnoreForScala3CompilerPC),
"context-bounds5".tag(IgnoreForScala3CompilerPC),
"""|package example
|object O {
| implicit val i: Int = 123
Expand All @@ -920,17 +955,46 @@ class InlayHintsSuite extends BaseInlayHintsSuite {
|object O {
| implicit val i: Int = 123
| def test[T: Ordering](x: T)(implicit v: Int)/*: Nothing<<scala/Nothing#>>*/ = ???
| test/*[Int<<scala/Int#>>]*/(1)/*(Int<<scala/math/Ordering.Int.>>, i<<(2:15)>>)*/
| test/*[Int<<scala/Int#>>]*/(1)/*(Int<<scala/math/Ordering.Int.>>)*/
|}
|""".stripMargin,
compat = Map(
"3" -> """|package example
|object O {
| implicit val i: Int = 123
| def test[T: Ordering](x: T)(implicit v: Int)/*: Nothing<<scala/Nothing#>>*/ = ???
| test/*[Int<<scala/Int#>>]*/(1)/*(using Int<<scala/math/Ordering.Int.>>, i<<(2:15)>>)*/
| test/*[Int<<scala/Int#>>]*/(1)/*(using Int<<scala/math/Ordering.Int.>>)*/
|}
|""".stripMargin
)
),
showImplicitArguments = false
)

check(
"context-bounds6".tag(IgnoreForScala3CompilerPC),
"""|package example
|object O {
| implicit val i: Int = 123
| def test[T: Ordering](x: T)(y: T) = ???
| test(1)(2)
|}
|""".stripMargin,
"""|package example
|object O {
| implicit val i: Int = 123
| def test[T: Ordering](x: T)(y: T)/*: Nothing<<scala/Nothing#>>*/ = ???
| test/*[Int<<scala/Int#>>]*/(1)(2)/*(Int<<scala/math/Ordering.Int.>>)*/
|}
|""".stripMargin,
compat = Map(
"3" -> """|package example
|object O {
| implicit val i: Int = 123
| def test[T: Ordering](x: T)(y: T)/*: Nothing<<scala/Nothing#>>*/ = ???
| test/*[Int<<scala/Int#>>]*/(1)(2)/*(using Int<<scala/math/Ordering.Int.>>)*/
|}
|""".stripMargin
),
showImplicitArguments = false
)
}
1 change: 1 addition & 0 deletions tests/unit/src/main/scala/tests/BaseInlayHintsExpectSuite.scala
View file
Expand Up @@ -38,6 +38,7 @@ abstract class BaseInlayHintsExpectSuite(
true,
true,
true,
true,
)
val inlayHints =
compiler.inlayHints(pcParams).get().asScala.toList
Expand Down
3 changes: 2 additions & 1 deletion tests/unit/src/main/scala/tests/BaseInlayHintsLspSuite.scala
View file
Expand Up @@ -23,7 +23,8 @@ abstract class BaseInlayHintsLspSuite(name: String, scalaVersion: String)
.getOrElse("""{
| "show-implicit-arguments": true,
| "show-implicit-conversions-and-classes": true,
| "show-inferred-type": "true"
| "show-inferred-type": "true",
| "show-evidence-params": true
|}
|""".stripMargin)
val fileName = "Main.scala"
Expand Down

0 comments on commit 4559f71

Please sign in to comment.