Packages

case class InfoModeAnnotation(modeName: String = "use") extends NoTargetAnnotation with FirrtlOption with Product with Serializable

Sets the info mode style

  • set with --info-mode
Source
FirrtlAnnotations.scala
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. InfoModeAnnotation
  2. Serializable
  3. FirrtlOption
  4. Unserializable
  5. NoTargetAnnotation
  6. Annotation
  7. Product
  8. Equals
  9. AnyRef
  10. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new InfoModeAnnotation(modeName: String = "use")

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from InfoModeAnnotation toany2stringadd[InfoModeAnnotation] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (InfoModeAnnotation, B)
    Implicit
    This member is added by an implicit conversion from InfoModeAnnotation toArrowAssoc[InfoModeAnnotation] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def ensuring(cond: (InfoModeAnnotation) => Boolean, msg: => Any): InfoModeAnnotation
    Implicit
    This member is added by an implicit conversion from InfoModeAnnotation toEnsuring[InfoModeAnnotation] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (InfoModeAnnotation) => Boolean): InfoModeAnnotation
    Implicit
    This member is added by an implicit conversion from InfoModeAnnotation toEnsuring[InfoModeAnnotation] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): InfoModeAnnotation
    Implicit
    This member is added by an implicit conversion from InfoModeAnnotation toEnsuring[InfoModeAnnotation] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): InfoModeAnnotation
    Implicit
    This member is added by an implicit conversion from InfoModeAnnotation toEnsuring[InfoModeAnnotation] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. val modeName: String
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. def productElementNames: Iterator[String]
    Definition Classes
    Product
  21. def serialize: String

    Optional pretty print

    Optional pretty print

    Definition Classes
    Annotation
    Note

    rarely used

  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def toInfoMode(infoSource: Option[String] = None): InfoMode

    Return the Parser.InfoMode equivalent for this Annotation

    Return the Parser.InfoMode equivalent for this Annotation

    infoSource

    the name of a file to use for "gen" or "append" info modes

  24. def update(renames: RenameMap): Seq[NoTargetAnnotation]

    Update the target based on how signals are renamed

    Update the target based on how signals are renamed

    Definition Classes
    NoTargetAnnotationAnnotation
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from InfoModeAnnotation toStringFormat[InfoModeAnnotation] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  2. def [B](y: B): (InfoModeAnnotation, B)
    Implicit
    This member is added by an implicit conversion from InfoModeAnnotation toArrowAssoc[InfoModeAnnotation] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Serializable

Inherited from FirrtlOption

Inherited from Unserializable

Inherited from NoTargetAnnotation

Inherited from Annotation

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromInfoModeAnnotation to any2stringadd[InfoModeAnnotation]

Inherited by implicit conversion StringFormat fromInfoModeAnnotation to StringFormat[InfoModeAnnotation]

Inherited by implicit conversion Ensuring fromInfoModeAnnotation to Ensuring[InfoModeAnnotation]

Inherited by implicit conversion ArrowAssoc fromInfoModeAnnotation to ArrowAssoc[InfoModeAnnotation]

Ungrouped