Skip to content

Avoid useless warnings about priority change in implicit search #20480

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.

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

Closed
wants to merge 4 commits into from
Closed
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
32 changes: 26 additions & 6 deletions compiler/src/dotty/tools/dotc/typer/Implicits.scala
Original file line number Diff line number Diff line change
Expand Up @@ -419,6 +419,12 @@ object Implicits:
sealed abstract class SearchResult extends Showable {
def tree: Tree
def toText(printer: Printer): Text = printer.toText(this)

/** The references that were found, there can be two of them in the case
* of an AmbiguousImplicits failure
*/
def found: List[TermRef]

def recoverWith(other: SearchFailure => SearchResult): SearchResult = this match {
case _: SearchSuccess => this
case fail: SearchFailure => other(fail)
Expand All @@ -434,13 +440,17 @@ object Implicits:
* @param tstate The typer state to be committed if this alternative is chosen
*/
case class SearchSuccess(tree: Tree, ref: TermRef, level: Int, isExtension: Boolean = false)(val tstate: TyperState, val gstate: GadtConstraint)
extends SearchResult with RefAndLevel with Showable
extends SearchResult with RefAndLevel with Showable:
final def found = ref :: Nil

/** A failed search */
case class SearchFailure(tree: Tree) extends SearchResult {
require(tree.tpe.isInstanceOf[SearchFailureType], s"unexpected type for ${tree}")
final def isAmbiguous: Boolean = tree.tpe.isInstanceOf[AmbiguousImplicits | TooUnspecific]
final def reason: SearchFailureType = tree.tpe.asInstanceOf[SearchFailureType]
final def found = tree.tpe match
case tpe: AmbiguousImplicits => tpe.alt1.ref :: tpe.alt2.ref :: Nil
case _ => Nil
}

object SearchFailure {
Expand Down Expand Up @@ -1290,6 +1300,11 @@ trait Implicits:
/** Search a list of eligible implicit references */
private def searchImplicit(eligible: List[Candidate], contextual: Boolean): SearchResult =

// A map that associates a priority change warning (between -source 3.4 and 3.6)
// with a candidate ref mentioned in the warning. We report the associated
// message if the candidate ref is part of the result of the implicit search
var priorityChangeWarnings = mutable.ListBuffer[(TermRef, Message)]()

/** Compare `alt1` with `alt2` to determine which one should be chosen.
*
* @return a number > 0 if `alt1` is preferred over `alt2`
Expand All @@ -1306,6 +1321,8 @@ trait Implicits:
*/
def compareAlternatives(alt1: RefAndLevel, alt2: RefAndLevel): Int =
def comp(using Context) = explore(compare(alt1.ref, alt2.ref, preferGeneral = true))
def warn(msg: Message) =
priorityChangeWarnings += (alt1.ref -> msg) += (alt2.ref -> msg)
if alt1.ref eq alt2.ref then 0
else if alt1.level != alt2.level then alt1.level - alt2.level
else
Expand All @@ -1319,16 +1336,16 @@ trait Implicits:
case 1 => "the first alternative"
case _ => "none - it's ambiguous"
if sv.stable == SourceVersion.`3.5` then
report.warning(
warn(
em"""Given search preference for $pt between alternatives ${alt1.ref} and ${alt2.ref} will change
|Current choice : ${choice(prev)}
|New choice from Scala 3.6: ${choice(cmp)}""", srcPos)
|New choice from Scala 3.6: ${choice(cmp)}""")
prev
else
report.warning(
warn(
em"""Change in given search preference for $pt between alternatives ${alt1.ref} and ${alt2.ref}
|Previous choice : ${choice(prev)}
|New choice from Scala 3.6: ${choice(cmp)}""", srcPos)
|New choice from Scala 3.6: ${choice(cmp)}""")
cmp
else cmp
else cmp
Expand Down Expand Up @@ -1578,7 +1595,10 @@ trait Implicits:
validateOrdering(ord)
throw ex

rank(sort(eligible), NoMatchingImplicitsFailure, Nil)
val result = rank(sort(eligible), NoMatchingImplicitsFailure, Nil)
for (ref, msg) <- priorityChangeWarnings do
if result.found.contains(ref) then report.warning(msg, srcPos)
result
end searchImplicit

def isUnderSpecifiedArgument(tp: Type): Boolean =
Expand Down
2 changes: 1 addition & 1 deletion tests/semanticdb/expect/InventedNames.scala
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ given [T]: Z[T] with

val a = intValue
val b = given_String
//val c = given_Double
val c = given_Double
Copy link
Member

@hamzaremmal hamzaremmal May 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will fail since commit 5a6ca9d also adapted the .expect and .expect.scala files to satisfy the changes in the test

val d = given_List_T[Int]
val e = given_Char
val f = given_Float
Expand Down
Loading