From 1946f94d34a929055c2f0d2dd231c5f5e634c536 Mon Sep 17 00:00:00 2001 From: Felix Mulder Date: Thu, 15 Sep 2016 19:20:11 +0200 Subject: Change layout of ErrorMessages --- src/dotty/tools/dotc/reporting/ErrorMessages.scala | 117 +++++++++++++++++++++ src/dotty/tools/dotc/reporting/Examples.scala | 106 ------------------- src/dotty/tools/dotc/reporting/Reporter.scala | 18 ++-- 3 files changed, 126 insertions(+), 115 deletions(-) create mode 100644 src/dotty/tools/dotc/reporting/ErrorMessages.scala delete mode 100644 src/dotty/tools/dotc/reporting/Examples.scala (limited to 'src/dotty/tools/dotc/reporting') diff --git a/src/dotty/tools/dotc/reporting/ErrorMessages.scala b/src/dotty/tools/dotc/reporting/ErrorMessages.scala new file mode 100644 index 000000000..7186ccbe2 --- /dev/null +++ b/src/dotty/tools/dotc/reporting/ErrorMessages.scala @@ -0,0 +1,117 @@ +package dotty.tools +package dotc +package reporting + +import dotc.core._ +import Contexts.Context, Decorators._, Symbols._ +import dotc.printing.SyntaxHighlighting._ +import util.{SourcePosition, NoSourcePosition} + +object ErrorMessages { + import dotc.ast.Trees._ + import dotc.ast.untpd + + implicit class ShouldExplainCtx(val c: Context) extends AnyVal { + def shouldExplain(expl: ErrorMessage): Boolean = { + implicit val ctx = c + expl match { + case _: NoExplanation => false + case expl if ctx.settings.explainerrors.value => true + case _ => false + } + } + } + + trait ErrorMessage { + def kind: String + def msg: String + def explanation: String + } + + case class NoExplanation(msg: String)(implicit val kind: String) extends ErrorMessage { + val explanation = "" + } + + object Syntax { + implicit val kind: String = "Syntax" + implicit def stringToErrorMessage(s: String): ErrorMessage = NoExplanation(s) + + abstract class EmptyCatchOrFinallyBlock(tryBody: untpd.Tree)(implicit ctx: Context, val kind: String) extends ErrorMessage { + val explanation = { + val tryString = tryBody match { + case Block(Nil, untpd.EmptyTree) => "{}" + case _ => tryBody.show + } + + val code1 = + s"""|try $tryString catch { + | case t: Throwable => ??? + |}""".stripMargin + + val code2 = + s"""|try $tryString finally { + | // perform your cleanup here! + |}""".stripMargin + + hl"""|Explanation: + |============ + |A ${"try"} expression should be followed by some mechanism to handle any exceptions + |thrown. Typically a ${"catch"} expression follows the ${"try"} and pattern matches + |on any expected exceptions. For example: + | + |$code1 + | + |It is also possible to follow a ${"try"} immediately by a ${"finally"} - letting the + |exception propagate - but still allowing for some clean up in ${"finally"}: + | + |$code2 + """.stripMargin + } + } + + case class EmptyCatchBlock(tryBody: untpd.Tree)(implicit ctx: Context, override val kind: String) + extends EmptyCatchOrFinallyBlock(tryBody) { + val msg = + hl"""The ${"catch"} block does not contain a valid expression, try adding a case like - `${"case e: Exception =>"}` to the block""" + } + + case class EmptyCatchAndFinallyBlock(tryBody: untpd.Tree)(implicit ctx: Context, override val kind: String) + extends EmptyCatchOrFinallyBlock(tryBody) { + val msg = + hl"""A ${"try"} without ${"catch"} or ${"finally"} is equivalent to putting its body in a block; no exceptions are handled.""" + } + } + + object Type { + implicit val kind: String = "Type" + implicit def stringToErrorMessage(s: String): ErrorMessage = NoExplanation(s) + + case class DuplicateBind(bind: untpd.Bind, tree: untpd.CaseDef)(implicit ctx: Context, val kind: String) extends ErrorMessage { + val msg = + em"duplicate pattern variable: `${bind.name}`" + + val explanation = { + val pat = tree.pat.show + val guard = tree.guard match { + case untpd.EmptyTree => "" + case guard => s"if ${guard.show}" + } + + val body = tree.body match { + case Block(Nil, untpd.EmptyTree) => "" + case body => s" ${body.show}" + } + + val caseDef = s"case $pat$guard => $body" + + hl"""|Explanation + |=========== + |For each ${"case"} bound variable names have to be unique. In: + | + |$caseDef + | + |`${bind.name}` is not unique. Rename one of the binds!""".stripMargin + } + } + } +} diff --git a/src/dotty/tools/dotc/reporting/Examples.scala b/src/dotty/tools/dotc/reporting/Examples.scala deleted file mode 100644 index 652620e29..000000000 --- a/src/dotty/tools/dotc/reporting/Examples.scala +++ /dev/null @@ -1,106 +0,0 @@ -package dotty.tools -package dotc -package reporting - -import dotc.core._ -import Contexts.Context, Decorators._, Symbols._ -import dotc.printing.SyntaxHighlighting._ -import util.{SourcePosition, NoSourcePosition} - -object ErrorExplanations { - import dotc.ast.Trees._ - import dotc.ast.untpd - - implicit def stringToExplanation(s: String) = NoExplanation(s) - - implicit class ShouldExplainCtx(val c: Context) extends AnyVal { - def shouldExplain(expl: Explanation): Boolean = { - implicit val ctx = c - expl match { - case _: NoExplanation => false - case expl if ctx.settings.explainerrors.value => true - case _ => false - } - } - } - - trait Explanation { - def msg: String - def explanation: String - } - - case class NoExplanation(msg: String) extends Explanation { - val explanation = "" - } - - abstract class EmptyCatchOrFinallyBlock(tryBody: untpd.Tree)(implicit ctx: Context) extends Explanation { - val explanation = { - val tryString = tryBody match { - case Block(Nil, untpd.EmptyTree) => "{}" - case _ => tryBody.show - } - - val code1 = - s"""|try $tryString catch { - | case t: Throwable => ??? - |}""".stripMargin - - val code2 = - s"""|try $tryString finally { - | // perform your cleanup here! - |}""".stripMargin - - hl"""|Explanation: - |============ - |A ${"try"} expression should be followed by some mechanism to handle any exceptions - |thrown. Typically a ${"catch"} expression follows the ${"try"} and pattern matches - |on any expected exceptions. For example: - | - |$code1 - | - |It is also possible to follow a ${"try"} immediately by a ${"finally"} - letting the - |exception propagate - but still allowing for some clean up in ${"finally"}: - | - |$code2 - """.stripMargin - } - } - - case class EmptyCatchBlock(tryBody: untpd.Tree)(implicit ctx: Context) extends EmptyCatchOrFinallyBlock(tryBody) { - val msg = - hl"""The ${"catch"} block does not contain a valid expression, try adding a case like - `${"case e: Exception =>"}` to the block""" - } - - case class EmptyCatchAndFinallyBlock(tryBody: untpd.Tree)(implicit ctx: Context) extends EmptyCatchOrFinallyBlock(tryBody) { - val msg = - hl"""A ${"try"} without ${"catch"} or ${"finally"} is equivalent to putting its body in a block; no exceptions are handled.""" - } - - case class DuplicateBind(bind: untpd.Bind, tree: untpd.CaseDef)(implicit ctx: Context) extends Explanation { - val msg = - em"duplicate pattern variable: `${bind.name}`" - - val explanation = { - val pat = tree.pat.show - val guard = tree.guard match { - case untpd.EmptyTree => "" - case guard => s"if ${guard.show}" - } - - val body = tree.body match { - case Block(Nil, untpd.EmptyTree) => "" - case body => s" ${body.show}" - } - - val caseDef = s"case $pat$guard => $body" - - hl"""|Explanation - |=========== - |For each ${"case"} bound variable names have to be unique. In: - | - |$caseDef - | - |`${bind.name}` is not unique. Rename one of the binds!""".stripMargin - } - } -} diff --git a/src/dotty/tools/dotc/reporting/Reporter.scala b/src/dotty/tools/dotc/reporting/Reporter.scala index eb9a10a59..401938859 100644 --- a/src/dotty/tools/dotc/reporting/Reporter.scala +++ b/src/dotty/tools/dotc/reporting/Reporter.scala @@ -13,7 +13,7 @@ import java.lang.System.currentTimeMillis import core.Mode import interfaces.Diagnostic.{ERROR, WARNING, INFO} import dotty.tools.dotc.core.Symbols.Symbol -import ErrorExplanations._ +import ErrorMessages._ object Reporter { class Error(msgFn: => String, pos: SourcePosition) extends Diagnostic(msgFn, pos, ERROR) @@ -96,10 +96,10 @@ trait Reporting { this: Context => def warning(msg: => String, pos: SourcePosition = NoSourcePosition): Unit = reporter.report(new Warning(msg, pos)) - def explainWarning(expl: => Explanation, pos: SourcePosition = NoSourcePosition): Unit = { - warning(expl.msg, pos) - if (this.shouldExplain(expl)) - reporter.report(new Info(expl.explanation, NoSourcePosition)) + def explainWarning(err: => ErrorMessage, pos: SourcePosition = NoSourcePosition): Unit = { + warning(err.msg, pos) + if (this.shouldExplain(err)) + reporter.report(new Info(err.explanation, NoSourcePosition)) } def strictWarning(msg: => String, pos: SourcePosition = NoSourcePosition): Unit = @@ -111,10 +111,10 @@ trait Reporting { this: Context => reporter.report(new Error(msg, pos)) } - def explainError(expl: => Explanation, pos: SourcePosition = NoSourcePosition): Unit = { - error(expl.msg, pos) - if (this.shouldExplain(expl)) - reporter.report(new Info(expl.explanation, NoSourcePosition)) + def explainError(err: => ErrorMessage, pos: SourcePosition = NoSourcePosition): Unit = { + error(err.msg, pos) + if (this.shouldExplain(err)) + reporter.report(new Info(err.explanation, NoSourcePosition)) } def errorOrMigrationWarning(msg: => String, pos: SourcePosition = NoSourcePosition): Unit = -- cgit v1.2.3