Merge pull request #10902 from dotty-staging/fix-#10810

Better error diagnostics and other fixes for extension methods

Author: odersky

compiler/src/dotty/tools/dotc/core/Decorators.scala

@@ -56,6 +56,10 @@ object Decorators {
         termName(chars, 0, len)
       case name: TypeName => s.concat(name.toTermName)
       case _ => termName(s.concat(name.toString))
+
+    def indented(width: Int): String =
+      val padding = " " * width
+      padding + s.replace("\n", "\n" + padding)
   end extension
 
   /** Implements a findSymbol method on iterators of Symbols that

compiler/src/dotty/tools/dotc/core/NameOps.scala

@@ -137,21 +137,6 @@ object NameOps {
       else name.toTermName
     }
 
-    /** Does the name match `extension`? */
-    def isExtension: Boolean = name match
-      case name: SimpleName =>
-        name.length == "extension".length && name.startsWith("extension")
-      case _ => false
-
-    /** Does this name start with `extension_`? */
-    def isExtensionName: Boolean = name match
-      case name: SimpleName => name.startsWith("extension_")
-      case _ => false
-
-    // TODO: Drop next 3 methods once extension names have stabilized
-    /** Add an `extension_` in front of this name */
-    def toExtensionName(using Context): SimpleName = "extension_".concat(name)
-
     /** The expanded name.
      *  This is the fully qualified name of `base` with `ExpandPrefixName` as separator,
      *  followed by `kind` and the name.

compiler/src/dotty/tools/dotc/transform/PostTyper.scala

@@ -383,8 +383,7 @@ class PostTyper extends MacroTransform with IdentityDenotTransformer { thisPhase
 
           def checkIdent(sel: untpd.ImportSelector): Unit =
             if !exprTpe.member(sel.name).exists
-               && !exprTpe.member(sel.name.toTypeName).exists
-               && !exprTpe.member(sel.name.toExtensionName).exists then
+               && !exprTpe.member(sel.name.toTypeName).exists then
               report.error(NotAMember(exprTpe, sel.name, "value"), sel.imported.srcPos)
             if seen.contains(sel.name) then
               report.error(ImportRenamedTwice(sel.imported), sel.imported.srcPos)

compiler/src/dotty/tools/dotc/typer/Applications.scala

@@ -2153,19 +2153,11 @@ trait Applications extends Compatibility {
         (tree, currentPt)
 
     val (core, pt1) = normalizePt(methodRef, pt)
-    val app = withMode(Mode.SynthesizeExtMethodReceiver) {
+    withMode(Mode.SynthesizeExtMethodReceiver) {
       typed(
         untpd.Apply(core, untpd.TypedSplice(receiver, isExtensionReceiver = true) :: Nil),
         pt1, ctx.typerState.ownedVars)
     }
-    def isExtension(tree: Tree): Boolean = methPart(tree) match {
-      case Inlined(call, _, _) => isExtension(call)
-      case tree @ Select(qual, nme.apply) => tree.symbol.is(ExtensionMethod) || isExtension(qual)
-      case tree => tree.symbol.is(ExtensionMethod)
-    }
-    if (!isExtension(app))
-      report.error(em"not an extension method: $methodRef", receiver.srcPos)
-    app
   }
 
   def isApplicableExtensionMethod(ref: TermRef, receiver: Type)(using Context) =

compiler/src/dotty/tools/dotc/typer/ErrorReporting.scala

@@ -13,6 +13,7 @@ import util.SrcPos
 import config.Feature
 import java.util.regex.Matcher.quoteReplacement
 import reporting._
+import collection.mutable
 
 import scala.util.matching.Regex
 
@@ -133,26 +134,47 @@ object ErrorReporting {
       if Feature.migrateTo3 then "\nThis patch can be inserted automatically under -rewrite."
       else ""
 
+    def whyFailedStr(fail: FailedExtension) =
+      i"""    failed with
+         |
+         |${fail.whyFailed.message.indented(8)}"""
+
     def selectErrorAddendum
       (tree: untpd.RefTree, qual1: Tree, qualType: Type, suggestImports: Type => String)
       (using Context): String =
-      val attempts: List[Tree] = qual1.getAttachment(Typer.HiddenSearchFailure) match
-        case Some(failures) =>
-          for failure <- failures
-              if !failure.reason.isInstanceOf[Implicits.NoMatchingImplicits]
-          yield failure.tree
-        case _ => Nil
+
+      val attempts = mutable.ListBuffer[(Tree, String)]()
+      val nested = mutable.ListBuffer[NestedFailure]()
+      for
+        failures <- qual1.getAttachment(Typer.HiddenSearchFailure)
+        failure <- failures
+      do
+        failure.reason match
+          case fail: NestedFailure => nested += fail
+          case fail: FailedExtension => attempts += ((failure.tree, whyFailedStr(fail)))
+          case fail: Implicits.NoMatchingImplicits => // do nothing
+          case _ => attempts += ((failure.tree, ""))
       if qualType.derivesFrom(defn.DynamicClass) then
         "\npossible cause: maybe a wrong Dynamic method signature?"
       else if attempts.nonEmpty then
-        val attemptStrings = attempts.map(_.showIndented(4)).distinct
+        val attemptStrings =
+          attempts.toList
+            .map((tree, whyFailed) => (tree.showIndented(4), whyFailed))
+            .distinctBy(_._1)
+            .map((treeStr, whyFailed) =>
+              i"""
+                 |    $treeStr$whyFailed""")
         val extMethods =
           if attemptStrings.length > 1 then "Extension methods were"
           else "An extension method was"
         i""".
            |$extMethods tried, but could not be fully constructed:
+           |$attemptStrings%\n%"""
+      else if nested.nonEmpty then
+        i""".
+           |Extension methods were tried, but the search failed with:
            |
-           |    $attemptStrings%\nor\n    %"""
+           |    ${nested.head.explanation}"""
       else if tree.hasAttachment(desugar.MultiLineInfix) then
         i""".
            |Note that `${tree.name}` is treated as an infix operator in Scala 3.

compiler/src/dotty/tools/dotc/typer/Implicits.scala

@@ -76,9 +76,9 @@ object Implicits:
    */
   def hasExtMethod(tp: Type, expected: Type)(using Context) = expected match
     case selProto @ SelectionProto(selName: TermName, _, _, _) =>
-         tp.memberBasedOnFlags(selName, required = ExtensionMethod).exists
-      || tp.memberBasedOnFlags(selProto.extensionName, required = ExtensionMethod).exists
-    case _ => false
+      tp.memberBasedOnFlags(selName, required = ExtensionMethod).exists
+    case _ =>
+      false
 
   def strictEquality(using Context): Boolean =
     ctx.mode.is(Mode.StrictEquality) || Feature.enabled(nme.strictEquality)
@@ -513,9 +513,19 @@ object Implicits:
       em"${err.refStr(ref)} produces a diverging implicit search when trying to $qualify"
   }
 
-  class FailedExtension(extApp: Tree, val expectedType: Type) extends SearchFailureType:
+  /** A search failure type for attempted ill-typed extension method calls */
+  class FailedExtension(extApp: Tree, val expectedType: Type, val whyFailed: Message) extends SearchFailureType:
     def argument = EmptyTree
     def explanation(using Context) = em"$extApp does not $qualify"
+
+   /** A search failure type for aborted searches of extension methods, typically
+    *  because of a cyclic reference or similar.
+    */
+  class NestedFailure(_msg: Message, val expectedType: Type) extends SearchFailureType:
+    def argument = EmptyTree
+    override def msg(using Context) = _msg
+    def explanation(using Context) = msg.toString
+
 end Implicits
 
 import Implicits._
@@ -1013,12 +1023,7 @@ trait Implicits:
           pt match
             case selProto @ SelectionProto(selName: TermName, mbrType, _, _) if cand.isExtension =>
               def tryExtension(using Context) =
-                val xname =
-                  if ref.memberBasedOnFlags(selProto.extensionName, required = ExtensionMethod).exists then
-                    selProto.extensionName
-                  else
-                    selName
-                extMethodApply(untpd.Select(untpdGenerated, xname), argument, mbrType)
+                extMethodApply(untpd.Select(untpdGenerated, selName), argument, mbrType)
               if cand.isConversion then
                 val extensionCtx, conversionCtx = ctx.fresh.setNewTyperState()
                 val extensionResult = tryExtension(using extensionCtx)

compiler/src/dotty/tools/dotc/typer/ProtoTypes.scala

@@ -147,11 +147,6 @@ object ProtoTypes {
   abstract case class SelectionProto(name: Name, memberProto: Type, compat: Compatibility, privateOK: Boolean)
   extends CachedProxyType with ProtoType with ValueTypeOrProto {
 
-    private var myExtensionName: TermName = null
-    def extensionName(using Context): TermName =
-      if myExtensionName == null then myExtensionName = name.toExtensionName
-      myExtensionName
-
     /** Is the set of members of this type unknown? This is the case if:
      *  1. The type has Nothing or Wildcard as a prefix or underlying type
      *  2. The type has an uninstantiated TypeVar as a prefix or underlying type,
@@ -447,8 +442,7 @@ object ProtoTypes {
       ctx.typer.isApplicableType(tp, argType :: Nil, resultType) || {
         resType match {
           case selProto @ SelectionProto(selName: TermName, mbrType, _, _) =>
-               ctx.typer.hasExtensionMethodNamed(tp, selName, argType, mbrType)
-            || ctx.typer.hasExtensionMethodNamed(tp, selProto.extensionName, argType, mbrType)
+            ctx.typer.hasExtensionMethodNamed(tp, selName, argType, mbrType)
               //.reporting(i"has ext $tp $name $argType $mbrType: $result")
           case _ =>
             false

compiler/src/dotty/tools/dotc/typer/Typer.scala

@@ -3348,11 +3348,8 @@ class Typer extends Namer
     // implicit conversion to the receiver type.
     def sharpenedPt = pt match
       case pt: SelectionProto
-      if pt.name.isExtensionName
-         || pt.memberProto.revealIgnored.isExtensionApplyProto =>
-        pt.deepenProto
-      case _ =>
-        pt
+      if pt.memberProto.revealIgnored.isExtensionApplyProto => pt.deepenProto
+      case _ => pt
 
     def adaptNoArgs(wtp: Type): Tree = {
       val ptNorm = underlyingApplied(pt)
@@ -3499,24 +3496,27 @@ class Typer extends Namer
       // try an extension method in scope
       pt match {
         case selProto @ SelectionProto(selName: TermName, mbrType, _, _) =>
+
           def tryExtension(using Context): Tree =
-            try
-              findRef(selName, WildcardType, ExtensionMethod, EmptyFlags, tree.srcPos) match
-                case ref: TermRef =>
-                  extMethodApply(untpd.ref(ref).withSpan(tree.span), tree, mbrType)
-                case _ => findRef(selProto.extensionName, WildcardType, ExtensionMethod, EmptyFlags, tree.srcPos) match
-                  case ref: TermRef =>
-                    extMethodApply(untpd.ref(ref).withSpan(tree.span), tree, mbrType)
-                  case _ => EmptyTree
-            catch case ex: TypeError => errorTree(tree, ex, tree.srcPos)
-          val nestedCtx = ctx.fresh.setNewTyperState()
-          val app = tryExtension(using nestedCtx)
-          if (!app.isEmpty && !nestedCtx.reporter.hasErrors) {
-            nestedCtx.typerState.commit()
-            return ExtMethodApply(app)
-          }
-          else if !app.isEmpty then
-            rememberSearchFailure(tree, SearchFailure(app.withType(FailedExtension(app, pt))))
+            findRef(selName, WildcardType, ExtensionMethod, EmptyFlags, tree.srcPos) match
+              case ref: TermRef =>
+                extMethodApply(untpd.ref(ref).withSpan(tree.span), tree, mbrType)
+              case _ =>
+                EmptyTree
+
+          try
+            val nestedCtx = ctx.fresh.setNewTyperState()
+            val app = tryExtension(using nestedCtx)
+            if !app.isEmpty && !nestedCtx.reporter.hasErrors then
+              nestedCtx.typerState.commit()
+              return ExtMethodApply(app)
+            else
+              for err <- nestedCtx.reporter.allErrors.take(1) do
+                rememberSearchFailure(tree,
+                  SearchFailure(app.withType(FailedExtension(app, pt, err.msg))))
+          catch case ex: TypeError =>
+            rememberSearchFailure(tree,
+              SearchFailure(tree.withType(NestedFailure(ex.toMessage, pt))))
         case _ =>
       }
 

tests/neg/enum-values.check

@@ -6,7 +6,10 @@
    |                                         meaning a values array is not defined.
    |                                         An extension method was tried, but could not be fully constructed:
    |
-   |                                             example.Extensions.values(Tag)
+   |                                             example.Extensions.values(Tag)    failed with
+   |
+   |                                                 Found:    example.Tag.type
+   |                                                 Required: Nothing
 -- [E008] Not Found Error: tests/neg/enum-values.scala:33:50 -----------------------------------------------------------
 33 |  val listlikes: Array[ListLike[?]]    = ListLike.values // error
    |                                         ^^^^^^^^^^^^^^^
@@ -15,7 +18,10 @@
    |                                         meaning a values array is not defined.
    |                                         An extension method was tried, but could not be fully constructed:
    |
-   |                                             example.Extensions.values(ListLike)
+   |                                             example.Extensions.values(ListLike)    failed with
+   |
+   |                                                 Found:    example.ListLike.type
+   |                                                 Required: Nothing
 -- [E008] Not Found Error: tests/neg/enum-values.scala:34:52 -----------------------------------------------------------
 34 |  val typeCtorsK: Array[TypeCtorsK[?]] = TypeCtorsK.values // error
    |                                         ^^^^^^^^^^^^^^^^^
@@ -24,7 +30,10 @@
    |                                         meaning a values array is not defined.
    |                                         An extension method was tried, but could not be fully constructed:
    |
-   |                                             example.Extensions.values(TypeCtorsK)
+   |                                             example.Extensions.values(TypeCtorsK)    failed with
+   |
+   |                                                 Found:    example.TypeCtorsK.type
+   |                                                 Required: Nothing
 -- [E008] Not Found Error: tests/neg/enum-values.scala:36:6 ------------------------------------------------------------
 36 |  Tag.valueOf("Int") // error
    |  ^^^^^^^^^^^
@@ -54,7 +63,10 @@
    |  value values is not a member of object example.NotAnEnum.
    |  An extension method was tried, but could not be fully constructed:
    |
-   |      example.Extensions.values(NotAnEnum)
+   |      example.Extensions.values(NotAnEnum)    failed with
+   |
+   |          Found:    example.NotAnEnum.type
+   |          Required: Nothing
 -- [E008] Not Found Error: tests/neg/enum-values.scala:41:12 -----------------------------------------------------------
 41 |  NotAnEnum.valueOf("Foo") // error
    |  ^^^^^^^^^^^^^^^^^

tests/neg/i10870.check

@@ -0,0 +1,7 @@
+-- [E008] Not Found Error: tests/neg/i10870.scala:10:16 ----------------------------------------------------------------
+10 |    def x = b.a.x  // error
+   |            ^^^^^
+   |            value x is not a member of A.
+   |            Extension methods were tried, but the search failed with:
+   |
+   |                Overloaded or recursive method x needs return type