chisel
7.9.0+2-5294dafe-SNAPSHOT
API
Generated with
chisel/firrtl/firrtl.options/DuplicateHandling

DuplicateHandling

firrtl.options.DuplicateHandling
trait DuplicateHandling extends OptionParser[AnnotationSeq]

A modified OptionParser with mutable termination and additional checks

Attributes

Deprecated
[Since version Chisel 7.0.0] All APIs in package firrtl are deprecated.
Source
OptionParser.scala
Graph
Supertypes
class OptionParser[AnnotationSeq]
class OptionDefCallback[AnnotationSeq]
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

override def parse(args: Seq[String], init: AnnotationSeq): Option[AnnotationSeq]

parses the given args.

parses the given args.

Attributes

Definition Classes
OptionParser
Source
OptionParser.scala

Inherited methods

def arg[A : Read](name: String): OptionDef[A, AnnotationSeq]

adds an argument invoked by an option without - or --.

adds an argument invoked by an option without - or --.

Value parameters

name

name in the usage text

Attributes

Inherited from:
OptionParser
Source
OptionParser.scala
def checkConfig(f: AnnotationSeq => Either[String, Unit]): OptionDef[Unit, AnnotationSeq]

adds final check.

adds final check.

Attributes

Inherited from:
OptionParser
Source
OptionParser.scala
def cmd(name: String): OptionDef[Unit, AnnotationSeq]

adds a command invoked by an option without - or --.

adds a command invoked by an option without - or --.

Value parameters

name

name of the command

Attributes

Inherited from:
OptionParser
Source
OptionParser.scala
def displayToErr(msg: String): Unit

Attributes

Inherited from:
OptionParser
Source
OptionParser.scala
def displayToOut(msg: String): Unit

Attributes

Inherited from:
OptionParser
Source
OptionParser.scala
def errorOnUnknownArgument: Boolean

Attributes

Inherited from:
OptionParser
Source
OptionParser.scala
def failure(msg: String): Either[String, Unit]

call this to express failure in custom validation.

call this to express failure in custom validation.

Attributes

Inherited from:
OptionParser
Source
OptionParser.scala
def head(xs: String*): OptionDef[Unit, AnnotationSeq]

adds usage text.

adds usage text.

Attributes

Inherited from:
OptionParser
Source
OptionParser.scala
def header: String

Attributes

Inherited from:
OptionParser
Source
OptionParser.scala
def help(x: Char, name: String): OptionDef[Unit, AnnotationSeq]

adds an option invoked by -x or --name that displays usage text and exits.

adds an option invoked by -x or --name that displays usage text and exits.

Value parameters

name

name of the option

x

name of the short option

Attributes

Inherited from:
OptionParser
Source
OptionParser.scala
def help(name: String): OptionDef[Unit, AnnotationSeq]

adds an option invoked by --name that displays usage text and exits.

adds an option invoked by --name that displays usage text and exits.

Value parameters

name

name of the option

Attributes

Inherited from:
OptionParser
Source
OptionParser.scala
protected def makeDef[A : Read](kind: OptionDefKind, name: String): OptionDef[A, AnnotationSeq]

Attributes

Inherited from:
OptionParser
Source
OptionParser.scala
def note(x: String): OptionDef[Unit, AnnotationSeq]

adds usage text.

adds usage text.

Attributes

Inherited from:
OptionParser
Source
OptionParser.scala
def opt[A : Read](x: Char, name: String): OptionDef[A, AnnotationSeq]

adds an option invoked by -x value or --name value.

adds an option invoked by -x value or --name value.

Value parameters

name

name of the option

x

name of the short option

Attributes

Inherited from:
OptionParser
Source
OptionParser.scala
def opt[A : Read](name: String): OptionDef[A, AnnotationSeq]

adds an option invoked by --name x.

adds an option invoked by --name x.

Value parameters

name

name of the option

Attributes

Inherited from:
OptionParser
Source
OptionParser.scala
def renderingMode: RenderingMode

Attributes

Inherited from:
OptionParser
Source
OptionParser.scala
def reportError(msg: String): Unit

Attributes

Inherited from:
OptionParser
Source
OptionParser.scala
def reportWarning(msg: String): Unit

Attributes

Inherited from:
OptionParser
Source
OptionParser.scala
def showUsageOnError: Option[Boolean]

Attributes

Inherited from:
OptionParser
Source
OptionParser.scala
def success: Either[String, Unit]

call this to express success in custom validation.

call this to express success in custom validation.

Attributes

Inherited from:
OptionParser
Source
OptionParser.scala
def terminate(exitState: Either[String, Unit]): Unit

Attributes

Inherited from:
OptionParser
Source
OptionParser.scala
def usage: String

Attributes

Inherited from:
OptionParser
Source
OptionParser.scala
def version(x: Char, name: String): OptionDef[Unit, AnnotationSeq]

adds an option invoked by -x or --name that displays header text and exits.

adds an option invoked by -x or --name that displays header text and exits.

Value parameters

name

name of the option

x

name of the short option

Attributes

Inherited from:
OptionParser
Source
OptionParser.scala
def version(name: String): OptionDef[Unit, AnnotationSeq]

adds an option invoked by --name that displays header text and exits.

adds an option invoked by --name that displays header text and exits.

Value parameters

name

name of the option

Attributes

Inherited from:
OptionParser
Source
OptionParser.scala

Inherited fields

protected val options: ListBuffer[OptionDef[_, AnnotationSeq]]

Attributes

Inherited from:
OptionParser
Source
OptionParser.scala
Generated with