path: root/src/dotty/tools/dotc/reporting/diagnostic/Message.scala

package dotty.tools
package dotc
package reporting
package diagnostic

import util.SourcePosition
import core.Contexts.Context

import java.util.Optional

object Message {
  val nonSensicalStartTag = "<nonsensical>"
  val nonSensicalEndTag = "</nonsensical>"

  implicit class MessageContext(val c: Context) extends AnyVal {
    def shouldExplain(msg: Message): Boolean = {
      implicit val ctx: Context = c
      msg.explanation match {
        case "" => false
        case _ => ctx.settings.explain.value
      }
    }
  }
}

class Message(
  msgFn: => String,
  val pos: SourcePosition,
  val level: Int,
  val kind: String,
  val explanation: String
) extends Exception with interfaces.Diagnostic {
  import Message._
  private var myMsg: String = null
  private var myIsNonSensical: Boolean = false

  override def position: Optional[interfaces.SourcePosition] =
    if (pos.exists && pos.source.exists) Optional.of(pos) else Optional.empty()

  /** The message to report */
  def message: String = {
    if (myMsg == null) {
      myMsg = msgFn
      if (myMsg.contains(nonSensicalStartTag)) {
        myIsNonSensical = true
        // myMsg might be composed of several d"..." invocations -> nested
        // nonsensical tags possible
        myMsg =
          myMsg
          .replaceAllLiterally(nonSensicalStartTag, "")
          .replaceAllLiterally(nonSensicalEndTag, "")
      }
    }
    myMsg
  }

  /** A message is non-sensical if it contains references to <nonsensical>
   *  tags.  Such tags are inserted by the error diagnostic framework if a
   *  message contains references to internally generated error types. Normally
   *  we want to suppress error messages referring to types like this because
   *  they look weird and are normally follow-up errors to something that was
   *  diagnosed before.
   */
  def isNonSensical = { message; myIsNonSensical }

  override def toString = s"$getClass at $pos: $message"
  override def getMessage() = message
}