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
  • trait FileCheck extends AnyRef
    Definition Classes
    testing
  • StringHelpers

implicit class StringHelpers extends AnyRef

Helpers to run FileCheck on a string input.

Source
FileCheck.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StringHelpers
  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

Instance Constructors

  1. new StringHelpers(input: String)

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 StringHelpers toany2stringadd[StringHelpers] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (StringHelpers, B)
    Implicit
    This member is added by an implicit conversion from StringHelpers toArrowAssoc[StringHelpers] 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: (StringHelpers) => Boolean, msg: => Any): StringHelpers
    Implicit
    This member is added by an implicit conversion from StringHelpers toEnsuring[StringHelpers] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (StringHelpers) => Boolean): StringHelpers
    Implicit
    This member is added by an implicit conversion from StringHelpers toEnsuring[StringHelpers] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): StringHelpers
    Implicit
    This member is added by an implicit conversion from StringHelpers toEnsuring[StringHelpers] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): StringHelpers
    Implicit
    This member is added by an implicit conversion from StringHelpers toEnsuring[StringHelpers] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def fileCheck(fileCheckArgs: String*)(check: String)(implicit testingDirectory: HasTestingDirectory): Unit

    Run FileCheck on a string with some options.

    Run FileCheck on a string with some options.

    import chisel3.testing.FileCheck
import chisel3.testing.scalatest.TestingDirectory
import org.scalatest.flatspec.AnyFlatSpec
import org.scalatest.matchers.should.Matchers

class Foo extends AnyFlatSpec with Matchers with FileCheck with TestingDirectory {

  behavior of ("Bar")

  it should "work" in {
    "Hello world!".fileCheck()(
      """|CHECK:      Hello
         |CHECK-SAME: world
         |""".stripMargin
    )
  }

}
    fileCheckArgs

    arguments to pass directly to FileCheck

    check

    a string of checks to pass to FileCheck

    testingDirectory

    an implementation of HasTestingDirectory that controls where intermediary files are written.

    Note

    See [FileCheck Documentation](https://llvm.org/docs/CommandGuide/FileCheck.html) for more information.

  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()

Deprecated Value Members

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

Inherited by implicit conversion StringFormat fromStringHelpers to StringFormat[StringHelpers]

Inherited by implicit conversion Ensuring fromStringHelpers to Ensuring[StringHelpers]

Inherited by implicit conversion ArrowAssoc fromStringHelpers to ArrowAssoc[StringHelpers]

Ungrouped