Skip to content

Commit 7c33774

Browse files
nicolasstuckinicolasstucki
authored
Merge pull request #6820 from dotty-staging/quote-error-on-quote-context
Move macro error reporting to QuoteContext
2 parents dfa1a91 + cfedcd8 commit 7c33774

File tree

16 files changed

+122
-83
lines changed

16 files changed

+122
-83
lines changed

‎community-build/community-projects/scalatest

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

Lines changed: 7 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -45,16 +45,6 @@ object Splicer {
4545
interpretedExpr.fold(tree)(x => PickledQuotes.quotedExprToTree(x))
4646
}
4747
catch {
48-
case ex: scala.quoted.QuoteError =>
49-
val pos1 = ex.from match {
50-
case None => pos
51-
case Some(expr) =>
52-
val reflect: scala.tasty.Reflection = ReflectionImpl(ctx)
53-
import reflect._
54-
expr.unseal.underlyingArgument.pos.asInstanceOf[SourcePosition]
55-
}
56-
ctx.error(ex.getMessage, pos1)
57-
EmptyTree
5848
case NonFatal(ex) =>
5949
val msg =
6050
s"""Failed to evaluate macro.
@@ -205,19 +195,13 @@ object Splicer {
205195
sw.write("\n")
206196
throw new StopInterpretation(sw.toString, pos)
207197
case ex: InvocationTargetException =>
208-
ex.getCause match {
209-
case cause: scala.quoted.QuoteError =>
210-
throw cause
211-
case _ =>
212-
val sw = new StringWriter()
213-
sw.write("An exception occurred while executing macro expansion\n")
214-
sw.write(ex.getTargetException.getMessage)
215-
sw.write("\n")
216-
ex.getTargetException.printStackTrace(new PrintWriter(sw))
217-
sw.write("\n")
218-
throw new StopInterpretation(sw.toString, pos)
219-
}
220-
198+
val sw = new StringWriter()
199+
sw.write("An exception occurred while executing macro expansion\n")
200+
sw.write(ex.getTargetException.getMessage)
201+
sw.write("\n")
202+
ex.getTargetException.printStackTrace(new PrintWriter(sw))
203+
sw.write("\n")
204+
throw new StopInterpretation(sw.toString, pos)
221205
}
222206
}
223207

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

Lines changed: 30 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -53,28 +53,25 @@ object StringContextMacro {
5353
def restoreReported() : Unit
5454
}
5555

56-
/** Retrieves a String from an Expr containing it
57-
*
58-
* @param expression the Expr containing the String
59-
* @return the String contained in the given Expr
60-
* quotes an error if the given Expr does not contain a String
61-
*/
62-
private def literalToString(expression : Expr[String]) given (ctx: QuoteContext) : String = expression match {
63-
case Const(string : String) => string
64-
case _ => QuoteError("Expected statically known literal", expression)
65-
}
66-
6756
/** Retrieves the parts from a StringContext, given inside an Expr, and returns them as a list of Expr of String
6857
*
6958
* @param strCtxExpr the Expr containing the StringContext
7059
* @return a list of Expr containing Strings, each corresponding to one parts of the given StringContext
7160
* quotes an error if the given Expr does not correspond to a StringContext
7261
*/
73-
def getPartsExprs(strCtxExpr : Expr[scala.StringContext]) given QuoteContext: List[Expr[String]] = {
62+
def getPartsExprs(strCtxExpr : Expr[scala.StringContext]) given (qctx: QuoteContext): Option[(List[Expr[String]], List[String])] = {
63+
def notStatic = {
64+
qctx.error("Expected statically known String Context", strCtxExpr)
65+
None
66+
}
67+
def splitParts(seq: Expr[Seq[String]]) = (seq, seq) match {
68+
case (ExprSeq(p1), ConstSeq(p2)) => Some((p1.toList, p2.toList))
69+
case _ => notStatic
70+
}
7471
strCtxExpr match {
75-
case '{ StringContext(${ExprSeq(parts)}: _*) } => parts.toList
76-
case '{ new StringContext(${ExprSeq(parts)}: _*) } => parts.toList
77-
case _ => QuoteError("Expected statically known String Context", strCtxExpr)
72+
case '{ StringContext($parts: _*) } => splitParts(parts)
73+
case '{ new StringContext($parts: _*) } => splitParts(parts)
74+
case _ => notStatic
7875
}
7976
}
8077

@@ -84,11 +81,14 @@ object StringContextMacro {
8481
* @return a list of Expr containing arguments
8582
* quotes an error if the given Expr does not contain a list of arguments
8683
*/
87-
def getArgsExprs(argsExpr: Expr[Seq[Any]]) given (qctx: QuoteContext): List[Expr[Any]] = {
84+
def getArgsExprs(argsExpr: Expr[Seq[Any]]) given (qctx: QuoteContext): Option[List[Expr[Any]]] = {
8885
import qctx.tasty._
8986
argsExpr.unseal.underlyingArgument match {
90-
case Typed(Repeated(args, _), _) => args.map(_.seal)
91-
case tree => QuoteError("Expected statically known argument list", argsExpr)
87+
case Typed(Repeated(args, _), _) =>
88+
Some(args.map(_.seal))
89+
case tree =>
90+
qctx.error("Expected statically known argument list", argsExpr)
91+
None
9292
}
9393
}
9494

@@ -102,8 +102,14 @@ object StringContextMacro {
102102
import qctx.tasty._
103103
val sourceFile = strCtxExpr.unseal.pos.sourceFile
104104

105-
val partsExpr = getPartsExprs(strCtxExpr)
106-
val args = getArgsExprs(argsExpr)
105+
val (partsExpr, parts) = getPartsExprs(strCtxExpr) match {
106+
case Some(x) => x
107+
case None => return '{""}
108+
}
109+
val args = getArgsExprs(argsExpr) match {
110+
case Some(args) => args
111+
case None => return '{""}
112+
}
107113

108114
val reporter = new Reporter{
109115
private[this] var reported = false
@@ -148,7 +154,7 @@ object StringContextMacro {
148154
}
149155
}
150156

151-
interpolate(partsExpr, args, argsExpr, reporter)
157+
interpolate(parts, args, argsExpr, reporter)
152158
}
153159

154160
/** Helper function for the interpolate function above
@@ -158,7 +164,7 @@ object StringContextMacro {
158164
* @param reporter the reporter to return any error/warning when a problem is encountered
159165
* @return the Expr containing the formatted and interpolated String or an error/warning report if the parameters are not correct
160166
*/
161-
def interpolate(partsExpr : List[Expr[String]], args : List[Expr[Any]], argsExpr: Expr[Seq[Any]], reporter : Reporter) given (qctx: QuoteContext) : Expr[String] = {
167+
def interpolate(parts0 : List[String], args : List[Expr[Any]], argsExpr: Expr[Seq[Any]], reporter : Reporter) given (qctx: QuoteContext) : Expr[String] = {
162168
import qctx.tasty._
163169

164170
/** Checks if the number of arguments are the same as the number of formatting strings
@@ -721,10 +727,10 @@ object StringContextMacro {
721727
val argument = args.size
722728

723729
// check validity of formatting
724-
checkSizes(partsExpr.size - 1, argument)
730+
checkSizes(parts0.size - 1, argument)
725731

726732
// add default format
727-
val parts = addDefaultFormat(partsExpr.map(literalToString))
733+
val parts = addDefaultFormat(parts0)
728734

729735
if (!parts.isEmpty && !reporter.hasReported()) {
730736
if (parts.size == 1 && args.size == 0 && parts.head.size != 0){

‎library/src/scala/quoted/QuoteError.scala renamed to ‎library/src-non-bootstrapped/scala/quoted/QuoteError.scala

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,10 @@ package scala.quoted
33
/** Throwing this error in the implementation of a macro
44
* will result in a compilation error with the given message.
55
*/
6+
@deprecated("", "0.17")
67
class QuoteError(message: String, val from: Option[Expr[_]]) extends Throwable(message)
78

9+
@deprecated("", "0.17")
810
object QuoteError {
911
/** Throws a QuoteError with the given message */
1012
def apply(message: => String): Nothing = throw new QuoteError(message, None)

‎library/src/scala/quoted/QuoteContext.scala

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,30 @@ class QuoteContext(val tasty: scala.tasty.Reflection) {
2222
tpe.unseal.show(syntaxHighlight)
2323
}
2424

25+
/** Report an error */
26+
def error(msg: => String): Unit = {
27+
import tasty._
28+
tasty.error(msg, rootPosition) given rootContext
29+
}
30+
31+
/** Report an error at the on the position of `expr` */
32+
def error(msg: => String, expr: Expr[_]): Unit = {
33+
import tasty._
34+
tasty.error(msg, expr.unseal.pos) given rootContext
35+
}
36+
37+
/** Report a warning */
38+
def warning(msg: => String): Unit = {
39+
import tasty._
40+
tasty.warning(msg, rootPosition) given rootContext
41+
}
42+
43+
/** Report a warning at the on the position of `expr` */
44+
def warning(msg: => String, expr: Expr[_]): Unit = {
45+
import tasty._
46+
tasty.warning(msg, expr.unseal.pos) given rootContext
47+
}
48+
2549
}
2650

2751
object QuoteContext {

‎tests/neg-macros/quote-error-2/Macro_1.scala

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ object Macro_1 {
55
def fooImpl(b: Boolean) given QuoteContext: Expr[Unit] =
66
'{println(${msg(b)})}
77

8-
def msg(b: Boolean) given QuoteContext: Expr[String] =
8+
def msg(b: Boolean) given (qctx: QuoteContext): Expr[String] =
99
if (b) '{"foo(true)"}
10-
else QuoteError("foo cannot be called with false")
10+
else { qctx.error("foo cannot be called with false"); '{ ??? } }
1111

1212
}

‎tests/neg-macros/quote-error/Macro_1.scala

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import quoted._
22

33
object Macro_1 {
44
inline def foo(inline b: Boolean): Unit = ${fooImpl(b)}
5-
def fooImpl(b: Boolean) given QuoteContext: Expr[Unit] =
5+
def fooImpl(b: Boolean) given (qctx: QuoteContext): Expr[Unit] =
66
if (b) '{println("foo(true)")}
7-
else QuoteError("foo cannot be called with false")
7+
else { qctx.error("foo cannot be called with false"); '{ ??? } }
88
}

‎tests/neg-with-compiler/i5941/macro_1.scala

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ object Lens {
3333
apply($getter)(setter)
3434
}
3535
case _ =>
36-
QuoteError("Unsupported syntax. Example: `GenLens[Address](_.streetNumber)`")
36+
qctx.error("Unsupported syntax. Example: `GenLens[Address](_.streetNumber)`")
37+
'{???}
3738
}
3839
}
3940
}

‎tests/run-macros/f-interpolation-1/FQuote_1.scala

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@ object FQuote {
3939
values.forall(isStringConstant) =>
4040
values.collect { case Literal(Constant(value: String)) => value }
4141
case tree =>
42-
QuoteError(s"String literal expected, but ${tree.showExtractors} found")
42+
qctx.error(s"String literal expected, but ${tree.showExtractors} found")
43+
return '{???}
4344
}
4445

4546
// [a0, ...]: Any*

‎tests/run-macros/f-interpolator-neg/Macros_1.scala

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ object Macro {
2121
}
2222
}
2323

24-
def fooErrorsImpl(parts : Seq[Expr[String]], args: Seq[Expr[Any]], argsExpr: Expr[Seq[Any]]) given QuoteContext= {
24+
def fooErrorsImpl(parts0: Seq[Expr[String]], args: Seq[Expr[Any]], argsExpr: Expr[Seq[Any]]) given QuoteContext= {
2525
val errors = List.newBuilder[Expr[(Boolean, Int, Int, Int, String)]]
2626
// true if error, false if warning
2727
// 0 if part, 1 if arg, 2 if strCtx, 3 if args
@@ -67,6 +67,7 @@ object Macro {
6767
reported = oldReported
6868
}
6969
}
70+
val parts = parts0.map { case Const(s) => s }
7071
dotty.internal.StringContextMacro.interpolate(parts.toList, args.toList, argsExpr, reporter) // Discard result
7172
errors.result().toExprOfList
7273
}

‎tests/run-macros/i5941/macro_1.scala

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,8 @@ object Lens {
5353
apply($getter)(setter)
5454
}
5555
case _ =>
56-
QuoteError("Unsupported syntax. Example: `GenLens[Address](_.streetNumber)`")
56+
qctx.error("Unsupported syntax. Example: `GenLens[Address](_.streetNumber)`")
57+
'{???}
5758
}
5859
}
5960
}
@@ -93,8 +94,10 @@ object Iso {
9394
// 1. S must be a case class
9495
// 2. A must be a tuple
9596
// 3. The parameters of S must match A
96-
if (tpS.classSymbol.flatMap(cls => if (cls.flags.is(Flags.Case)) Some(true) else None).isEmpty)
97-
QuoteError("Only support generation for case classes")
97+
if (tpS.classSymbol.flatMap(cls => if (cls.flags.is(Flags.Case)) Some(true) else None).isEmpty) {
98+
qctx.error("Only support generation for case classes")
99+
return '{???}
100+
}
98101

99102
val cls = tpS.classSymbol.get
100103

@@ -103,14 +106,16 @@ object Iso {
103106
case Type.TypeRef(name, prefix) => Type.TermRef(prefix, name)
104107
}
105108

106-
if (cls.caseFields.size != 1)
107-
QuoteError("Use GenIso.fields for case classes more than one parameter")
109+
if (cls.caseFields.size != 1) {
110+
qctx.error("Use GenIso.fields for case classes more than one parameter")
111+
return '{???}
112+
}
108113

109114
val fieldTp = tpS.memberType(cls.caseFields.head)
110-
if (!(fieldTp =:= tpA))
111-
QuoteError(s"The type of case class field $fieldTp does not match $tpA")
112-
113-
'{
115+
if (!(fieldTp =:= tpA)) {
116+
qctx.error(s"The type of case class field $fieldTp does not match $tpA")
117+
'{???}
118+
} else '{
114119
// (p: S) => p._1
115120
val to = (p: S) => ${ Select.unique(('p).unseal, "_1").seal.cast[A] }
116121
// (p: A) => S(p)
@@ -134,8 +139,10 @@ object Iso {
134139
else if (tpS.classSymbol.flatMap(cls => if (cls.flags.is(Flags.Case)) Some(true) else None).nonEmpty) {
135140
val cls = tpS.classSymbol.get
136141

137-
if (cls.caseFields.size != 0)
138-
QuoteError("Use GenIso.fields for case classes more than one parameter")
142+
if (cls.caseFields.size != 0) {
143+
qctx.error("Use GenIso.fields for case classes more than one parameter")
144+
return '{???}
145+
}
139146

140147
val companion = tpS match {
141148
case Type.SymRef(sym, prefix) => Type.TermRef(prefix, sym.name)
@@ -149,7 +156,8 @@ object Iso {
149156
}
150157
}
151158
else {
152-
QuoteError("Only support generation for case classes or singleton types")
159+
qctx.error("Only support generation for case classes or singleton types")
160+
'{???}
153161
}
154162
}
155163

‎tests/run-macros/tasty-interpolation-1/Macro.scala

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,18 +31,21 @@ object FooIntepolator extends MacroStringInterpolator[String] {
3131
// TODO put this class in the stdlib or separate project?
3232
abstract class MacroStringInterpolator[T] {
3333

34-
final def apply(strCtxExpr: Expr[StringContext], argsExpr: Expr[Seq[Any]]) given QuoteContext: Expr[T] = {
34+
final def apply(strCtxExpr: Expr[StringContext], argsExpr: Expr[Seq[Any]]) given (qctx: QuoteContext): Expr[T] = {
3535
try interpolate(strCtxExpr, argsExpr)
3636
catch {
3737
case ex: NotStaticlyKnownError =>
3838
// TODO use ex.expr to recover the position
39-
QuoteError(ex.getMessage)
39+
qctx.error(ex.getMessage)
40+
'{???}
4041
case ex: StringContextError =>
4142
// TODO use ex.idx to recover the position
42-
QuoteError(ex.getMessage)
43+
qctx.error(ex.getMessage)
44+
'{???}
4345
case ex: ArgumentError =>
4446
// TODO use ex.idx to recover the position
45-
QuoteError(ex.getMessage)
47+
qctx.error(ex.getMessage)
48+
'{???}
4649
}
4750
}
4851

‎tests/run-macros/tasty-macro-const/quoted_1.scala

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,15 @@ object Macros {
99
val xTree: Term = x.unseal
1010
xTree match {
1111
case Inlined(_, _, Literal(Constant(n: Int))) =>
12-
if (n <= 0)
13-
QuoteError("Parameter must be natural number")
14-
xTree.seal.cast[Int]
12+
if (n <= 0) {
13+
qctx.error("Parameter must be natural number")
14+
'{0}
15+
} else {
16+
xTree.seal.cast[Int]
17+
}
1518
case _ =>
16-
QuoteError("Parameter must be a known constant")
19+
qctx.error("Parameter must be a known constant")
20+
'{0}
1721
}
1822
}
1923

‎tests/run-macros/xml-interpolation-1/XmlQuote_1.scala

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,6 @@ object XmlQuote {
1616
given (qctx: QuoteContext): Expr[Xml] = {
1717
import qctx.tasty._
1818

19-
def abort(msg: String): Nothing =
20-
QuoteError(msg)
21-
2219
// for debugging purpose
2320
def pp(tree: Tree): Unit = {
2421
println(tree.showExtractors)
@@ -52,7 +49,8 @@ object XmlQuote {
5249
values.forall(isStringConstant) =>
5350
values.collect { case Literal(Constant(value: String)) => value }
5451
case tree =>
55-
abort(s"String literal expected, but ${tree.showExtractors} found")
52+
qctx.error(s"String literal expected, but ${tree.showExtractors} found")
53+
return '{ ??? }
5654
}
5755

5856
// [a0, ...]: Any*

0 commit comments

Comments
 (0)