Packages

  • package root

    This is the documentation for Chisel.

    This is the documentation for Chisel.

    Package structure

    The chisel3 package presents the public API of Chisel. It contains the concrete core types UInt, SInt, Bool, Clock, and Reg, the abstract types Bits, Aggregate, and Data, and the aggregate types Bundle and Vec.

    The Chisel package is a compatibility layer that attempts to provide chisel2 compatibility in chisel3.

    Utility objects and methods are found in the util package.

    The testers package defines the basic interface for chisel testers.

    Definition Classes
    root
  • package chisel3

    This package contains the main chisel3 API.

    This package contains the main chisel3 API.

    Definition Classes
    root
  • package testing
    Definition Classes
    chisel3
  • package scalatest
    Definition Classes
    testing
  • FileCheck
  • HasConfigMap
  • TestingDirectory

trait HasConfigMap extends TestSuiteMixin

A Scalatest test suite mix-in that provides access to command line options.

This expose any keys/values passed using the -D<key>=<value command line option to the test via a Map.

For example, you can invoke Scalatest passing the foo=bar option like so:

./mill 'chisel[2.13.16].test.testOnly' fooTest -Dfoo=bar

Inside your test, if the configMap member function is accessed this will return:

Map(foo -> bar)

This is intended to be a building block of more complicated tests that want to customize their execution via the command line. It is advisable to use this sparingly as tests are generally not intended to change when you run them.

Self Type
HasConfigMap with TestSuite
Source
HasConfigMap.scala
Linear Supertypes
TestSuiteMixin, SuiteMixin, AnyRef, Any
Known Subclasses
ChiselSim, HasCliOptions
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HasConfigMap
  2. TestSuiteMixin
  3. SuiteMixin
  4. AnyRef
  5. 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

Abstract Value Members

  1. abstract def expectedTestCount(filter: Filter): Int
    Definition Classes
    SuiteMixin
  2. abstract def nestedSuites: IndexedSeq[Suite]
    Definition Classes
    SuiteMixin
  3. abstract def rerunner: Option[String]
    Definition Classes
    SuiteMixin
  4. abstract def run(testName: Option[String], args: Args): Status
    Definition Classes
    SuiteMixin
  5. abstract def runNestedSuites(args: Args): Status
    Attributes
    protected
    Definition Classes
    SuiteMixin
  6. abstract def runTest(testName: String, args: Args): Status
    Attributes
    protected
    Definition Classes
    SuiteMixin
  7. abstract def runTests(testName: Option[String], args: Args): Status
    Attributes
    protected
    Definition Classes
    SuiteMixin
  8. abstract def suiteId: String
    Definition Classes
    SuiteMixin
  9. abstract def suiteName: String
    Definition Classes
    SuiteMixin
  10. abstract def tags: Map[String, Set[String]]
    Definition Classes
    SuiteMixin
  11. abstract def testDataFor(testName: String, theConfigMap: ConfigMap): TestData
    Definition Classes
    SuiteMixin
  12. abstract def testNames: Set[String]
    Definition Classes
    SuiteMixin
  13. abstract val styleName: String
    Definition Classes
    SuiteMixin
    Annotations
    @deprecated
    Deprecated

    (Since version 3.1.0) The styleName lifecycle method has been deprecated and will be removed in a future version of ScalaTest with no replacement.

Concrete 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 HasConfigMap toany2stringadd[HasConfigMap] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (HasConfigMap, B)
    Implicit
    This member is added by an implicit conversion from HasConfigMap toArrowAssoc[HasConfigMap] 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 configMap: ConfigMap

    Return the config map which contains all command line options passed to Scalatest.

    Return the config map which contains all command line options passed to Scalatest.

    This is only valid during a test. It will be None if used outside a test.

    Exceptions thrown

    RuntimeException if called outside a Scalatest test

  9. def ensuring(cond: (HasConfigMap) => Boolean, msg: => Any): HasConfigMap
    Implicit
    This member is added by an implicit conversion from HasConfigMap toEnsuring[HasConfigMap] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (HasConfigMap) => Boolean): HasConfigMap
    Implicit
    This member is added by an implicit conversion from HasConfigMap toEnsuring[HasConfigMap] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): HasConfigMap
    Implicit
    This member is added by an implicit conversion from HasConfigMap toEnsuring[HasConfigMap] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): HasConfigMap
    Implicit
    This member is added by an implicit conversion from HasConfigMap toEnsuring[HasConfigMap] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  27. def withFixture(test: (HasConfigMap.this)#NoArgTest): Outcome
    Definition Classes
    HasConfigMap → TestSuiteMixin

Deprecated Value Members

  1. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from HasConfigMap toStringFormat[HasConfigMap] 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): (HasConfigMap, B)
    Implicit
    This member is added by an implicit conversion from HasConfigMap toArrowAssoc[HasConfigMap] 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 TestSuiteMixin

Inherited from SuiteMixin

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromHasConfigMap to any2stringadd[HasConfigMap]

Inherited by implicit conversion StringFormat fromHasConfigMap to StringFormat[HasConfigMap]

Inherited by implicit conversion Ensuring fromHasConfigMap to Ensuring[HasConfigMap]

Inherited by implicit conversion ArrowAssoc fromHasConfigMap to ArrowAssoc[HasConfigMap]

Ungrouped