Packages

c

chisel3

WhenContext

final class WhenContext extends AnyRef

A WhenContext may represent a when, and elsewhen, or an otherwise. Since FIRRTL does not have an "elsif" statement, alternatives must be mapped to nested if-else statements inside the alternatives of the preceeding condition. In order to emit proper FIRRTL, it is necessary to keep track of the depth of nesting of the FIRRTL whens. Due to the "thin frontend" nature of Chisel3, it is not possible to know if a when or elsewhen has a succeeding elsewhen or otherwise; therefore, this information is added by preprocessing the command queue.

Source
When.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WhenContext
  2. AnyRef
  3. 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

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 WhenContext toany2stringadd[WhenContext] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (WhenContext, B)
    Implicit
    This member is added by an implicit conversion from WhenContext toArrowAssoc[WhenContext] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def active: Boolean
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  9. def elsewhen(elseCond: => Bool)(block: => Any)(implicit sourceInfo: SourceInfo): WhenContext

    This block of logic gets executed if above conditions have been false and this condition is true.

    This block of logic gets executed if above conditions have been false and this condition is true. The lazy argument pattern makes it possible to delay evaluation of cond, emitting the declaration and assignment of the Bool node of the predicate in the correct place.

  10. def ensuring(cond: (WhenContext) => Boolean, msg: => Any): WhenContext
    Implicit
    This member is added by an implicit conversion from WhenContext toEnsuring[WhenContext] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (WhenContext) => Boolean): WhenContext
    Implicit
    This member is added by an implicit conversion from WhenContext toEnsuring[WhenContext] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: => Any): WhenContext
    Implicit
    This member is added by an implicit conversion from WhenContext toEnsuring[WhenContext] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): WhenContext
    Implicit
    This member is added by an implicit conversion from WhenContext toEnsuring[WhenContext] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. def otherwise(block: => Any)(implicit sourceInfo: SourceInfo): Unit

    This block of logic gets executed only if the above conditions were all false.

    This block of logic gets executed only if the above conditions were all false. No additional logic blocks may be appended past the otherwise. The lazy argument pattern makes it possible to delay evaluation of cond, emitting the declaration and assignment of the Bool node of the predicate in the correct place.

  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. 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 WhenContext toStringFormat[WhenContext] 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): (WhenContext, B)
    Implicit
    This member is added by an implicit conversion from WhenContext toArrowAssoc[WhenContext] 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 AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromWhenContext to any2stringadd[WhenContext]

Inherited by implicit conversion StringFormat fromWhenContext to StringFormat[WhenContext]

Inherited by implicit conversion Ensuring fromWhenContext to Ensuring[WhenContext]

Inherited by implicit conversion ArrowAssoc fromWhenContext to ArrowAssoc[WhenContext]

Ungrouped