Deprecate everything in package firrtl (#4878)

Previously, we tried to avoid this by deprecating any imports from the
firrtl package, but this missed things. Instead, we deprecate every
public class, object, and trait.

Also delete the previous attempt using the DeprecateSFCComponent in the
compiler plugin. It is now redundant.

Author: jackkoenig

build.mill

@@ -77,7 +77,7 @@ object v extends Module {
 
   val scala2WarnConf = Seq(
     "msg=APIs in chisel3.internal:s",
-    "msg=Importing from firrtl:s",
+    "msg=All APIs in package firrtl:s",
     "msg=migration to the MLIR:s",
     "msg=method hasDefiniteSize in trait IterableOnceOps is deprecated:s", // replacement `knownSize` is not in 2.12
     "msg=object JavaConverters in package collection is deprecated:s",

firrtl/src/main/scala/firrtl/AttributeAnnotation.scala

@@ -7,6 +7,7 @@ import firrtl.annotations.{Named, SingleTargetAnnotation}
   * @param target       target component to tag with attribute
   * @param description  Attribute string to add to target
   */
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 case class AttributeAnnotation(target: Named, description: String) extends SingleTargetAnnotation[Named] {
   def duplicate(n: Named): AttributeAnnotation = this.copy(target = n, description = description)
 }

firrtl/src/main/scala/firrtl/Compiler.scala

@@ -5,9 +5,11 @@ package firrtl
 import firrtl.annotations._
 
 /** Container of all annotations for a Firrtl compiler */
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 class AnnotationSeq private (underlying: Seq[Annotation]) {
   def toSeq: Seq[Annotation] = underlying
 }
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 object AnnotationSeq {
   def apply(xs: Seq[Annotation]): AnnotationSeq = new AnnotationSeq(xs)
 }

firrtl/src/main/scala/firrtl/Emitter.scala

@@ -9,6 +9,7 @@ import firrtl.stage.FirrtlOptions
 import firrtl.stage.FirrtlOptionsView
 
 // ***** Annotations for results of emission *****
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 sealed abstract class EmittedComponent {
   def name: String
 
@@ -17,9 +18,11 @@ sealed abstract class EmittedComponent {
   def outputSuffix: String
 }
 
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 sealed abstract class EmittedCircuit extends EmittedComponent
 
 /** Traits for Annotations containing emitted components */
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 trait EmittedAnnotation[T <: EmittedComponent] extends NoTargetAnnotation with CustomFileEmission {
   val value: T
 
@@ -30,20 +33,27 @@ trait EmittedAnnotation[T <: EmittedComponent] extends NoTargetAnnotation with C
   override protected val suffix: Option[String] = Some(value.outputSuffix)
 }
 
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 sealed trait EmittedCircuitAnnotation[T <: EmittedCircuit] extends EmittedAnnotation[T] {
   override def getBytes = value.value.getBytes
 }
 
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 case class EmittedFirrtlCircuitAnnotation(value: EmittedFirrtlCircuit)
     extends EmittedCircuitAnnotation[EmittedFirrtlCircuit]
 
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 final case class EmittedFirrtlCircuit(name: String, value: String, outputSuffix: String) extends EmittedCircuit
 
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 final case class EmittedBtor2Circuit(name: String, value: String, outputSuffix: String) extends EmittedCircuit
 
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 case class EmittedBtor2CircuitAnnotation(value: EmittedBtor2Circuit)
     extends EmittedCircuitAnnotation[EmittedBtor2Circuit]
 
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 final case class EmittedVerilogCircuit(name: String, value: String, outputSuffix: String) extends EmittedCircuit
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 case class EmittedVerilogCircuitAnnotation(value: EmittedVerilogCircuit)
     extends EmittedCircuitAnnotation[EmittedVerilogCircuit]

firrtl/src/main/scala/firrtl/FirrtlException.scala

@@ -9,6 +9,7 @@ import scala.util.control.NoStackTrace
   * These exceptions indicate a problem due to bad input and thus do not include a stack trace.
   * This can be extended by custom transform writers.
   */
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 class FirrtlUserException(message: String, cause: Throwable = null)
     extends RuntimeException(message, cause)
     with NoStackTrace

firrtl/src/main/scala/firrtl/Parser.scala

@@ -2,6 +2,7 @@
 
 package firrtl
 
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 object Parser {
 
   sealed abstract class InfoMode

firrtl/src/main/scala/firrtl/PrimOps.scala

@@ -6,6 +6,7 @@ import logger.LazyLogging
 import firrtl.ir._
 
 /** Definitions and Utility functions for [[ir.PrimOp]]s */
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 object PrimOps extends LazyLogging {
 
   /** Addition */

firrtl/src/main/scala/firrtl/RenameMap.scala

@@ -9,6 +9,7 @@ import firrtl.renamemap._
 
 import scala.collection.mutable
 
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 object RenameMap {
   def apply(map: collection.Map[Named, Seq[Named]], circuitName: String): RenameMap =
     MutableRenameMap.fromNamed(map, circuitName)
@@ -31,6 +32,7 @@ object RenameMap {
   * @define noteDistinct @note Rename to/tos will be made distinct
   */
 // TODO This should probably be refactored into immutable and mutable versions
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 sealed trait RenameMap {
 
   // Records the name of the circuit to which this rename map applies.  This is
@@ -521,6 +523,7 @@ sealed trait RenameMap {
 
 // This must be in same file as RenameMap because RenameMap is sealed
 package object renamemap {
+  @deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
   object MutableRenameMap {
     def fromNamed(map: collection.Map[Named, Seq[Named]], circuitName: String): MutableRenameMap = {
       val rm = new MutableRenameMap(circuitName)
@@ -538,6 +541,7 @@ package object renamemap {
     def apply(circuitName: String): MutableRenameMap = new MutableRenameMap(circuitName)
   }
 
+  @deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
   final class MutableRenameMap private[firrtl] (
     override protected val circuitName: String,
     protected val _underlying: mutable.HashMap[CompleteTarget, Seq[CompleteTarget]] =

firrtl/src/main/scala/firrtl/Utils.scala

@@ -6,6 +6,7 @@ import firrtl.ir._
 
 import _root_.logger.LazyLogging
 
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 object Utils extends LazyLogging {
 
   /** Unwind the causal chain until we hit the initial exception (which may be the first).

firrtl/src/main/scala/firrtl/WIR.scala

@@ -4,20 +4,26 @@ package firrtl
 
 import firrtl.ir._
 
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 abstract class MPortDir extends FirrtlNode
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 case object MInfer extends MPortDir {
   def serialize: String = "infer"
 }
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 case object MRead extends MPortDir {
   def serialize: String = "read"
 }
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 case object MWrite extends MPortDir {
   def serialize: String = "write"
 }
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 case object MReadWrite extends MPortDir {
   def serialize: String = "rdwr"
 }
 
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 case class CDefMemory(
   info:           Info,
   name:           String,
@@ -39,6 +45,7 @@ case class CDefMemory(
   def foreachString(f: String => Unit):           Unit = f(name)
   def foreachInfo(f:   Info => Unit):             Unit = f(info)
 }
+@deprecated("All APIs in package firrtl are deprecated.", "Chisel 7.0.0")
 case class CDefMPort(info: Info, name: String, tpe: Type, mem: String, exps: Seq[Expression], direction: MPortDir)
     extends Statement
     with HasInfo