// SPDX-License-Identifier: Apache-2.0

package chisel3.internal

import scala.annotation.tailrec
import scala.collection.mutable.{ArrayBuffer, LinkedHashMap, LinkedHashSet}
import scala.util.Try
import scala.util.control.{NoStackTrace, NonFatal}
import scala.util.matching.Regex
import _root_.logger.Logger
import java.io.File
import java.nio.file.{FileSystems, PathMatcher, Paths}
import java.util.regex.PatternSyntaxException
import scala.io.Source

import chisel3.experimental.{NoSourceInfo, SourceInfo, SourceLine, UnlocatableSourceInfo}

object ExceptionHelpers {

  /** Root packages that are not typically relevant to Chisel user code. */
  final val packageTrimlist: Set[String] = Set("chisel3", "scala", "java", "jdk", "sun", "sbt")

  /** The object name of Chisel's internal `Builder`. */
  final val builderName: String = chisel3.internal.Builder.getClass.getName

  /** Return a stack trace element that looks like `... (someMessage)`.
    * @param message an optional message to include
    */
  def ellipsis(message: Option[String] = None): StackTraceElement =
    new StackTraceElement("..", " ", message.getOrElse(""), -1)

  /** Utility methods that can be added to exceptions.
    */
  implicit class ThrowableHelpers(throwable: Throwable) {

    /** For an exception, mutably trim a stack trace to user code only.
      *
      * This does the following actions to the stack trace:
      *
      *   1. From the top, remove elements while the (root) package matches the packageTrimlist
      *   2. Optionally, from the bottom, remove elements until the class matches an anchor
      *   3. From the anchor (or the bottom), remove elements while the (root) package matches the packageTrimlist
      *
      * @param packageTrimlist packages that should be removed from the stack trace
      * @param anchor an optional class name at which user execution might begin, e.g., a main object
      * @return nothing as this mutates the exception directly
      */
    def trimStackTraceToUserCode(
      packageTrimlist: Set[String] = packageTrimlist,
      anchor:          Option[String] = Some(builderName)
    ): Unit = {
      def inTrimlist(ste: StackTraceElement) = {
        val packageName = ste.getClassName().takeWhile(_ != '.')
        packageTrimlist.contains(packageName)
      }

      val trimStackTrace =
        (a: Array[StackTraceElement]) => {
          // Step 1: Remove elements from the top in the package trimlist
          //         Only include ellipsis at top if something is dropped from top
          val droppedFromTop = inTrimlist(a.head)
          val trimmed =
            a.dropWhile(inTrimlist)
              // Step 2: Optionally remove elements from the bottom until the anchor
              .reverse
              .dropWhile(ste => anchor.map(b => !ste.getClassName.startsWith(b)).getOrElse(false))
              // Step 3: Remove elements from the bottom in the package trimlist
              .dropWhile(inTrimlist)
              // Step 4: Reverse back to the original order
              .reverse
              .toArray
          // Step 5: Add ellipsis stack trace elements and "--full-stacktrace" info
          val withEllipses =
            Option.when(droppedFromTop)(ellipsis()) ++:
              trimmed :+
              ellipsis() :+
              ellipsis(
                Some("Stack trace trimmed to user code only. Rerun with --full-stacktrace to see the full stack trace")
              )
          // Step 6: Mutate the stack trace in this exception
          throwable.setStackTrace(withEllipses)
        }

      val stackTrace = throwable.getStackTrace
      if (stackTrace.nonEmpty) {
        trimStackTrace(stackTrace)
      }
    }

  }
}

/** Filter for warnings that can suppress, keep as warning, or elevate to error
  *
  * May filter on source file or message, a None filter means "match everything"
  */
private[chisel3] case class WarningFilter(
  src:    Option[PathMatcher],
  id:     Option[WarningID.WarningID],
  action: WarningFilter.Action) {

  /** Does this filter apply to the warning? */
  def applies(warning: Warning): Boolean = {
    // Option.forall matches if None which is intentional
    val idMatch = this.id.forall(_ == warning.id)
    // Using def so that srcMatch won't run unless necessary
    def srcMatch = this.src match {
      case None => true // No src regex means match all
      case Some(srcGlob) =>
        val filename = warning.info.filenameOption
        filename match {
          case Some(filename) => srcGlob.matches(Paths.get(filename))
          case None           => false
        }
    }
    idMatch && srcMatch
  }
}
private[chisel3] object WarningFilter {
  sealed trait Action
  case object Suppress extends Action
  case object Warn extends Action
  case object Error extends Action

  // Some helpers for error reporting
  private def actionOneOf = "must be one of ':e, :w, or :s'."
  private def categoryOneOf = "must be one of 'any', 'src', or 'id'."

  // TODO find a better way to deal with line and column
  private def srcGlobDefault(base: String): String = base //s"**/$base"

  /** Parse a String into a [[WarningFilter]]
    *
    * @param value String to parse
    * @return Left on failure with index of invalid character and a message or Right of successfully built Warning Filters
    */
  def parse(value: String): Either[(Int, String), WarningFilter] = {
    val actionIdx = value.lastIndexOf(':')
    if (actionIdx < 0) {
      return Left(value.size - 1 -> s"Filter '$value' is missing an action, $actionOneOf")
    }
    val (filterStr, actionStr) = value.splitAt(actionIdx)
    val action: Action = actionStr match {
      case ":e" => Error
      case ":w" => Warn
      case ":s" => Suppress
      case other =>
        return Left(actionIdx -> s"Invalid action '$other', $actionOneOf")
    }
    val filterParts: List[String] = filterStr.split("&").toList
    // Add index for adding a carat in error reporting
    val partsWithIndex: List[(Int, String)] =
      filterParts
        .mapAccumulate(0) { case (idx, s) => (idx + 1 + s.length, (idx, s)) } // + 1 for removed '&'
        ._2

    // Find and record the parts
    var any:     Boolean = false
    var srcGlob: Option[PathMatcher] = None
    var id:      Option[WarningID.WarningID] = None
    for ((idx, str) <- partsWithIndex) {
      val catIdx = str.indexOf('=')
      val (category, remainder) = if (catIdx < 0) (str, "") else str.splitAt(catIdx + 1) // +1 to include = in cat
      val regex = category match {
        case "any" =>
          // Any must be unique
          if (srcGlob.nonEmpty || id.nonEmpty || any) return Left(idx -> "'any' cannot be combined with other filters.")
          if (catIdx != -1) return Left(idx -> "'any' cannot have modifiers.")
          any = true
        // Note that split puts '=' with the category instead of regex
        case "src=" =>
          if (any) return Left(idx -> "'any' cannot be combined with other filters.")
          if (srcGlob.nonEmpty) return Left(idx -> s"Cannot have duplicates of the same category.")
          val filesystem = FileSystems.getDefault()
          try {
            // Add defaults to make API more friendly
            srcGlob = Some(filesystem.getPathMatcher("glob:" + srcGlobDefault(remainder)))
          } catch {
            case NonFatal(_) =>
              val jdx = idx + "src=".length
              return Left(jdx -> s"Invalid glob expression: '$remainder'")
          }
        case "id=" =>
          if (id.nonEmpty) return Left(idx -> s"Cannot have duplicates of the same category.")
          val warningId =
            for {
              value <- remainder.toIntOption
              // Check for all digits because we don't want leading + or -
              if remainder.forall(_.isDigit)
              // Notably, maxId is 1 larger than the actual max id.
              if value > 0 && value < WarningID.maxId
            } yield WarningID(value)
          warningId match {
            case None =>
              val jdx = idx + "id=".length
              return Left(
                jdx -> s"Warning ID must be an integer in range [1, ${WarningID.maxId - 1}], got '$remainder'."
              )
            case Some(value) =>
              id = Some(value)
          }
        case other =>
          val cleanCat = if (other.last == '=') other.init else other // Drop trailing =
          return Left(idx -> s"Invalid category '$cleanCat', $categoryOneOf")
      }
    }
    Right(WarningFilter(srcGlob, id, action))
  }
}

private[chisel3] class Errors(message: String) extends chisel3.ChiselException(message) with NoStackTrace

private[chisel3] object throwException {
  def apply(s: String, t: Throwable = null): Nothing =
    throw new chisel3.ChiselException(s, t)
}

private[chisel3] sealed trait UseColor
private[chisel3] object UseColor {
  case object Enabled extends UseColor
  case object Disabled extends UseColor
  case class Error(value: String) extends UseColor

  val envVar = "CHISEL_USE_COLOR"

  val value: UseColor = sys.env.get(envVar) match {
    case None =>
      val detect = System.console() != null && sys.env.get("TERM").exists(_ != "dumb")
      if (detect) Enabled else Disabled
    case Some("true")  => Enabled
    case Some("false") => Disabled
    case Some(other)   => Error(other)
  }

  def useColor: Boolean = value match {
    case Enabled  => true
    case Disabled => false
    case Error(_) => false
  }
}

/** Records and reports runtime errors and warnings. */
private[chisel3] object ErrorLog {
  def withColor(color: String, message: String): String =
    if (UseColor.useColor) color + message + Console.RESET else message
  val depTag = "[" + withColor(Console.BLUE, "deprecated") + "]"
  val warnTag = "[" + withColor(Console.YELLOW, "warn") + "]"
  val errTag = "[" + withColor(Console.RED, "error") + "]"
}

private[chisel3] class ErrorLog(
  warningFilters:    Seq[WarningFilter],
  sourceRoots:       Seq[File],
  throwOnFirstError: Boolean) {
  import ErrorLog.withColor

  private def getErrorLineInFile(sl: SourceLine): List[String] = {
    def tryFileInSourceRoot(sourceRoot: File): Option[List[String]] = {
      try {
        val file = new File(sourceRoot, sl.filename)
        val lines = Source.fromFile(file).getLines()
        var i = 0
        while (i < (sl.line - 1) && lines.hasNext) {
          lines.next()
          i += 1
        }
        val line = lines.next()
        val caretLine = (" " * (sl.col - 1)) + "^"
        Some(line :: caretLine :: Nil)
      } catch {
        case scala.util.control.NonFatal(_) => None
      }
    }
    val sourceRootsWithDefault = if (sourceRoots.nonEmpty) sourceRoots else Seq(new File("."))
    // View allows us to search the directories one at a time and early out
    sourceRootsWithDefault.view.map(tryFileInSourceRoot(_)).collectFirst { case Some(value) => value }.getOrElse(Nil)
  }

  /** Returns an appropriate location string for the provided source info.
    * If the source info is of `NoSourceInfo` type, the source location is looked up via stack trace.
    * If the source info is `None`, an empty string is returned.
    */
  private def errorLocationString(si: Option[SourceInfo]): String = {
    si match {
      case Some(sl: SourceLine) => sl.serialize
      case Some(_: NoSourceInfo) => "(unknown)"
      case None => ""
    }
  }

  // TODO refactor this to just hold more information in the ErrorEntry and do extra processing at report time
  // id is optional because it has only been applied to warnings, TODO apply to errors
  private def logWarningOrError(msg: String, si: Option[SourceInfo], isFatal: Boolean): Unit = {
    val location = errorLocationString(si)
    val sourceLineAndCaret = si.collect { case sl: SourceLine => getErrorLineInFile(sl) }.getOrElse(Nil)
    val fullMessage = if (location.isEmpty) msg else s"$location: $msg"
    val errorLines = fullMessage :: sourceLineAndCaret
    val entry = ErrorEntry(errorLines, isFatal)
    if (throwOnFirstError && isFatal) {
      throwException(entry.serialize(includeTag = false))
    }
    errors += entry
  }

  /** Log an error message */
  def error(m: String, si: SourceInfo): Unit = {
    logWarningOrError(m, Some(si), true)
  }

  /** Log a warning, will have warning filters applied before logging */
  def warning(warning: Warning): Unit = {
    val action =
      warningFilters.collectFirst { case wf if wf.applies(warning) => wf.action }
        .getOrElse(WarningFilter.Warn) // Default is to warn
    val doReport: Option[Boolean] = action match {
      case WarningFilter.Error    => Some(true)
      case WarningFilter.Warn     => Some(false)
      case WarningFilter.Suppress => None
    }
    doReport.foreach { isFatal =>
      logWarningOrError(warning.msg, Some(warning.info), isFatal)
    }
  }

  /** Log a deprecation warning message */
  def deprecated(m: String, location: Option[String]): Unit = {
    val sourceLoc = location match {
      case Some(loc) => loc
      case None      => errorLocationString(Some(UnlocatableSourceInfo))
    }

    val thisEntry = (m, sourceLoc)
    deprecations += ((thisEntry, deprecations.getOrElse(thisEntry, 0) + 1))
  }

  /** Throw an exception if any errors have yet occurred. */
  def checkpoint(logger: Logger): Unit = {
    UseColor.value match {
      case UseColor.Error(value) =>
        logger.error(
          s"[error] Invalid value for environment variable '${UseColor.envVar}', must be 'true', 'false', or not set!"
        )
      case _ =>
    }

    deprecations.foreach {
      case ((message, sourceLoc), count) =>
        logger.warn(s"${ErrorLog.depTag} $sourceLoc ($count calls): $message")
    }
    errors.foreach(e => logger.error(e.serialize(includeTag = true)))

    if (!deprecations.isEmpty) {
      logger.warn(
        s"${ErrorLog.warnTag} " + withColor(
          Console.YELLOW,
          s"There were ${deprecations.size} deprecated function(s) used." +
            " These may stop compiling in a future release - you are encouraged to fix these issues."
        )
      )
      logger.warn(
        s"${ErrorLog.warnTag} Line numbers for deprecations reported by Chisel may be inaccurate; enable scalac compiler deprecation warnings via either of the following methods:"
      )
      logger.warn(s"${ErrorLog.warnTag}   In the sbt interactive console, enter:")
      logger.warn(s"""${ErrorLog.warnTag}     set scalacOptions in ThisBuild ++= Seq("-unchecked", "-deprecation")""")
      logger.warn(s"${ErrorLog.warnTag}   or, in your build.sbt, add the line:")
      logger.warn(s"""${ErrorLog.warnTag}     scalacOptions := Seq("-unchecked", "-deprecation")""")
    }

    val allErrors = errors.filter(_.isFatal)
    val allWarnings = errors.filter(!_.isFatal)

    if (!allWarnings.isEmpty && !allErrors.isEmpty) {
      logger.warn(
        s"${ErrorLog.errTag} There were " + withColor(Console.RED, s"${allErrors.size} error(s)") + " and " + withColor(
          Console.YELLOW,
          s"${allWarnings.size} warning(s)"
        ) + " during hardware elaboration."
      )
    } else if (!allWarnings.isEmpty) {
      logger.warn(
        s"${ErrorLog.warnTag} There were " + withColor(
          Console.YELLOW,
          s"${allWarnings.size} warning(s)"
        ) + " during hardware elaboration."
      )
    } else if (!allErrors.isEmpty) {
      logger.warn(
        s"${ErrorLog.errTag} There were " + withColor(
          Console.RED,
          s"${allErrors.size} error(s)"
        ) + " during hardware elaboration."
      )
    }

    if (!allErrors.isEmpty) {
      throw new Errors(
        "Fatal errors during hardware elaboration. Look above for error list. " +
          "Rerun with --throw-on-first-error if you wish to see a stack trace."
      )
    } else {
      // No fatal errors, clear accumulated warnings since they've been reported
      errors.clear()
    }
  }

  private val errors = LinkedHashSet[ErrorEntry]()
  private val deprecations = LinkedHashMap[(String, String), Int]()

  private val startTime = System.currentTimeMillis
  private def elapsedTime: Long = System.currentTimeMillis - startTime
}

// id is optional because it has only been applied to warnings, TODO apply to errors
private case class ErrorEntry(lines: Seq[String], isFatal: Boolean) {
  def tag = if (isFatal) ErrorLog.errTag else ErrorLog.warnTag

  def serialize(includeTag: Boolean): String = {
    val linesx = if (includeTag) lines.map(s"$tag " + _) else lines
    linesx.mkString("\n")
  }
}
