Move errors and warnings out of QuoteContext

Author: nicolasstucki

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

@@ -52,7 +52,7 @@ object Splicer {
       catch {
         case ex: CompilationUnit.SuspendException =>
           throw ex
-        case ex: scala.quoted.StopQuotedContext if ctx.reporter.hasErrors =>
+        case ex: scala.quoted.Reporting.StopQuotedContext if ctx.reporter.hasErrors =>
            // errors have been emitted
           EmptyTree
         case ex: StopInterpretation =>
@@ -389,7 +389,7 @@ object Splicer {
           throw new StopInterpretation(sw.toString, pos)
         case ex: InvocationTargetException =>
           ex.getTargetException match {
-            case ex: scala.quoted.StopQuotedContext =>
+            case ex: scala.quoted.Reporting.StopQuotedContext =>
               throw ex
             case MissingClassDefinedInCurrentRun(sym) =>
               if (ctx.settings.XprintSuspension.value)

docs/docs/reference/metaprogramming/macros.md

@@ -727,14 +727,14 @@ private def showMeExpr(sc: Expr[StringContext], argsExpr: Expr[Seq[Any]])(using
           val showTp = '[Show[$tp]]
           Expr.summon(using showTp) match {
             case Some(showExpr) => '{ $showExpr.show($arg) }
-            case None => qctx.error(s"could not find implicit for ${showTp.show}", arg); '{???}
+            case None => Reporting.error(s"could not find implicit for ${showTp.show}", arg); '{???}
           }
       }
       val newArgsExpr = Varargs(argShowedExprs)
       '{ $sc.s($newArgsExpr: _*) }
     case _ =>
       // `new StringContext(...).showMeExpr(args: _*)` not an explicit `showMeExpr"..."`
-      qctx.error(s"Args must be explicit", argsExpr)
+      Reporting.error(s"Args must be explicit", argsExpr)
       '{???}
   }
 }

docs/docs/reference/metaprogramming/tasty-reflect.md

@@ -46,13 +46,13 @@ def natConstImpl(x: Expr[Int])(using qctx: QuoteContext): Expr[Int] = {
   xTree match {
     case Inlined(_, _, Literal(Constant(n: Int))) =>
       if (n <= 0) {
-        qctx.error("Parameter must be natural number")
+        Reporting.error("Parameter must be natural number")
         '{0}
       } else {
         xTree.seal.cast[Int]
       }
     case _ =>
-      qctx.error("Parameter must be a known constant")
+      Reporting.error("Parameter must be a known constant")
       '{0}
   }
 }

library/src-bootstrapped/dotty/internal/CompileTimeMacros.scala

@@ -8,4 +8,4 @@ object CompileTimeMacros:
       case (Expr.StringContext(Consts(parts)), Varargs(args2)) =>
         Expr(StringContext(parts: _*).s(args2.map(_.show): _*))
       case _ =>
-        qctx.throwError("compiletime.code must be used as a string interpolator `code\"...\"`")
+        Reporting.throwError("compiletime.code must be used as a string interpolator `code\"...\"`")

library/src-bootstrapped/dotty/internal/StringContextMacro.scala

@@ -63,12 +63,12 @@ object StringContextMacro {
 
     val (partsExpr, parts) = strCtxExpr match {
       case Expr.StringContext(p1 @ Consts(p2)) => (p1.toList, p2.toList)
-      case _ => qctx.throwError("Expected statically known String Context", strCtxExpr)
+      case _ => Reporting.throwError("Expected statically known String Context", strCtxExpr)
     }
 
     val args = argsExpr match {
       case Varargs(args) => args
-      case _ => qctx.throwError("Expected statically known argument list", argsExpr)
+      case _ => Reporting.throwError("Expected statically known argument list", argsExpr)
     }
 
     val reporter = new Reporter{

library/src-bootstrapped/scala/quoted/Expr.scala

@@ -43,7 +43,7 @@ class Expr[+T] private[scala] {
    *  Otherwise returns the value.
    */
   final def unliftOrError[U >: T](using qctx: QuoteContext, unlift: Unliftable[U]): U =
-    unlift(this).getOrElse(qctx.throwError(s"Expected a known value. \n\nThe value of: $show\ncould not be unlifted using $unlift", this))
+    unlift(this).getOrElse(Reporting.throwError(s"Expected a known value. \n\nThe value of: $show\ncould not be unlifted using $unlift", this))
 
   /** Pattern matches `this` against `that`. Effectively performing a deep equality check.
    *  It does the equivalent of

library/src-bootstrapped/scala/quoted/QuoteContext.scala

@@ -34,31 +34,10 @@ trait QuoteContext { self =>
     val tasty: self.tasty.type
   }
 
-  /** Report an error at the position of the macro expansion */
-  def error(msg: => String): Unit =
-    tasty.error(msg, tasty.rootPosition)
-
-  /** Report an error at the on the position of `expr` */
-  def error(msg: => String, expr: Expr[Any]): Unit =
-    tasty.error(msg, expr.unseal(using this).pos)
-
-  /** Report an error at the position of the macro expansion and throws a StopQuotedContext */
-  def throwError(msg: => String): Nothing = {
-    error(msg)
-    throw new StopQuotedContext
-  }
-  /** Report an error at the on the position of `expr` and throws a StopQuotedContext */
-  def throwError(msg: => String, expr: Expr[Any]): Nothing = {
-    error(msg, expr)
-    throw new StopQuotedContext
-  }
-
-  /** Report a warning */
-  def warning(msg: => String): Unit =
-    tasty.warning(msg, tasty.rootPosition)
-
-  /** Report a warning at the on the position of `expr` */
-  def warning(msg: => String, expr: Expr[Any]): Unit =
-    tasty.warning(msg, expr.unseal(using this).pos)
+}
 
+object QuoteContext {
+  // TODO remove in 0.26.0
+  @deprecated("Errors and warnings have been moved to scala.quoted.Reporting", "0.25.0")
+  given error_and_warining_on_QuoteContext as Conversion[QuoteContext, Reporting.type] = _ => Reporting
 }

library/src/scala/quoted/Reporting.scala

@@ -0,0 +1,35 @@
+package scala.quoted
+
+object Reporting {
+
+  /** Report an error at the position of the macro expansion */
+  def error(msg: => String)(using qctx: QuoteContext): Unit =
+    qctx.tasty.error(msg, qctx.tasty.rootPosition)
+
+  /** Report an error at the on the position of `expr` */
+  def error(msg: => String, expr: Expr[Any])(using qctx: QuoteContext): Unit =
+    qctx.tasty.error(msg, expr.unseal.pos)
+
+  /** Report an error at the position of the macro expansion and throws a StopQuotedContext */
+  def throwError(msg: => String)(using qctx: QuoteContext): Nothing = {
+    error(msg)
+    throw new StopQuotedContext
+  }
+  /** Report an error at the on the position of `expr` and throws a StopQuotedContext */
+  def throwError(msg: => String, expr: Expr[Any])(using qctx: QuoteContext): Nothing = {
+    error(msg, expr)
+    throw new StopQuotedContext
+  }
+
+  /** Report a warning */
+  def warning(msg: => String)(using qctx: QuoteContext): Unit =
+    qctx.tasty.warning(msg, qctx.tasty.rootPosition)
+
+  /** Report a warning at the on the position of `expr` */
+  def warning(msg: => String, expr: Expr[_])(using qctx: QuoteContext): Unit =
+    qctx.tasty.warning(msg, expr.unseal.pos)
+
+  /** Throwable used to stop the expansion of a macro after an error was reported */
+  class StopQuotedContext extends Throwable
+
+}

library/src/scala/quoted/StopQuotedContext.scala

@@ -7,6 +7,6 @@ object Macro_1 {
 
   def msg(b: Boolean)(using qctx: QuoteContext): Expr[String] =
     if (b) '{"foo(true)"}
-    else { qctx.error("foo cannot be called with false"); '{ ??? } }
+    else { Reporting.error("foo cannot be called with false"); '{ ??? } }
 
 }