chisel6.4.0 < Back


# Packages

-  package root
  Definition Classes
    root
-  package firrtl
  Definition Classes
    root
-  package options
  Definition Classes
    firrtl
-  package internal
  Definition Classes
    options
-  package phases
  Definition Classes
    options
- BareShell
- BufferedCustomFileEmission
- CustomFileEmission
- Dependency
- DependencyAPI
- DependencyManager
- DependencyManagerException
- DependencyManagerUtils
- DoNotTerminateOnExit
- DuplicateHandling
- ExceptOnError
- ExitCode
- ExitFailure
- ExitSuccess
- GeneralError
- HasShellOptions
- IdentityLike
- InputAnnotationFileAnnotation
- OptionsException
- OptionsHelpException
- OptionsView
- OutputAnnotationFileAnnotation
- Phase
- PhaseException
- PhaseManager
- PhasePrerequisiteException
- ProgramArgsAnnotation
- RegisteredLibrary
- Shell
- ShellOption
- Stage
- StageError
- StageMain
- StageOption
- StageOptions
- StageOptionsView
- StageUtils
- TargetDirAnnotation
- TransformLike
- Translator
- Unserializable
- Viewer

c

firrtl.options

# Shell

###

#### class Shell extends BareShell

A utility for working with command line options. This comes prepopulated with common options for most uses.

Source
  Shell.scala

Linear Supertypes
BareShell, AnyRef, Any
Type Hierarchy

Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. Shell
2. BareShell
3. AnyRef
4. 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 Shell(applicationName: String)

   applicationName

     the application associated with these command line options

### 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 Shell toany2stringadd[Shell] performed by method any2stringadd in scala.Predef.
   Definition Classes
     any2stringadd
4.  def ->[B](y: B): (Shell, B)
   Implicit
     This member is added by an implicit conversion from Shell toArrowAssoc[Shell] performed by method ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline()
5.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
6.  val applicationName: String
   Definition Classes
     BareShell
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 ensuring(cond: (Shell) => Boolean, msg: => Any): Shell
   Implicit
     This member is added by an implicit conversion from Shell toEnsuring[Shell] performed by method Ensuring in scala.Predef.
   Definition Classes
     Ensuring
10.  def ensuring(cond: (Shell) => Boolean): Shell
    Implicit
      This member is added by an implicit conversion from Shell toEnsuring[Shell] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
11.  def ensuring(cond: Boolean, msg: => Any): Shell
    Implicit
      This member is added by an implicit conversion from Shell toEnsuring[Shell] performed by method Ensuring in scala.Predef.
    Definition Classes
      Ensuring
12.  def ensuring(cond: Boolean): Shell
    Implicit
      This member is added by an implicit conversion from Shell toEnsuring[Shell] 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.  def parse(args: Array[String], initAnnos: AnnotationSeq = Seq.empty): AnnotationSeq

    The AnnotationSeq generated from command line arguments

    The AnnotationSeq generated from command line arguments

    This requires lazy evaluation as subclasses will mixin new command line options via methods of Shell.parser

    Definition Classes
      BareShell
23.  val parser: OptionParser[AnnotationSeq] with DuplicateHandling with ExceptOnError

    Command line argument parser (OptionParser) with modifications

    Command line argument parser (OptionParser) with modifications

    Attributes
      protected
    Definition Classes
      BareShell
24.  def parserSetup(): Unit

    This method can be overriden to do some work everytime before parsing runs, e.g., to add options to the parser.

    This method can be overriden to do some work everytime before parsing runs, e.g., to add options to the parser.

    Attributes
      protected
    Definition Classes
      Shell → BareShell
25.  final lazy val registeredLibraries: Seq[RegisteredLibrary]

    Contains all discovered RegisteredLibrary

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

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion any2stringadd fromShell to any2stringadd[Shell]

### Inherited by implicit conversion StringFormat fromShell to StringFormat[Shell]

### Inherited by implicit conversion Ensuring fromShell to Ensuring[Shell]

### Inherited by implicit conversion ArrowAssoc fromShell to ArrowAssoc[Shell]

### Ungrouped