scallop

Type Members

sealed trait CliOption extends AnyRef
class LazyMap[A, +B] extends Map[A, B]

A class, that lazily encapsulates a map inside.
case class LongNamedPropertyOption(name: String, descr: String, converter: ValueConverter[_], keyName: String, valueName: String, hidden: Boolean) extends CliOption with Product with Serializable
case class NumberArgOption(name: String, required: Boolean, descr: String, converter: ValueConverter[Long], validator: (scala.reflect.api.JavaUniverse.TypeTag[_], Any) ⇒ Boolean, default: () ⇒ Option[Long], hidden: Boolean) extends CliOption with Product with Serializable
case class PropertyOption(name: String, short: Char, descr: String, converter: ValueConverter[_], keyName: String, valueName: String, hidden: Boolean) extends CliOption with Product with Serializable
case class Scallop(args: Seq[String] = Nil, opts: List[CliOption] = Nil, mainOpts: List[String] = Nil, vers: Option[String] = None, bann: Option[String] = None, foot: Option[String] = None, descr: String = "", helpWidth: Option[Int] = None, shortSubcommandsHelp: Boolean = false, appendDefaultToDescription: Boolean = false, subbuilders: List[(String, Scallop)] = Nil, parent: Option[Scallop] = None) extends Product with Serializable

The main builder class.
The main builder class.
args
Arguments to parse.
opts
Options definitions.
mainOpts
Names of options, that are to be printed first in the help printout
vers
Version string to display in help.
bann
Banner (summary of this program and command-line usage) to display in help.
foot
Footer - displayed after options.
descr
Short description - used for subcommands
helpWidth
Width, to which the help output will be formatted (note that banner, footer, version and description are not affected!)
shortSubcommandsHelp
If true, then help output from this builder wouldn't list full help for subcommands, only short description
subbuilders
subcommands in this builder
abstract class ScallopConf extends ScallopConfValidations
trait ScallopConfValidations extends AnyRef

Helper trait for generaton of validate methods on ScallopConf.
abstract class ScallopOption[A] extends AnyRef

A class to hold a reference to not-yet-computed option values.
A class to hold a reference to not-yet-computed option values.
Basically, this is a lazy option - it batches up all operations, and evaluates the value only as the last resort.
case class SimpleOption(name: String, short: Option[Char], descr: String, required: Boolean, converter: ValueConverter[_], default: () ⇒ Option[Any], validator: (scala.reflect.api.JavaUniverse.TypeTag[_], Any) ⇒ Boolean, argName: String, hidden: Boolean, noshort: Boolean) extends CliOption with Product with Serializable
class Subcommand extends ScallopConf
case class ToggleOption(name: String, default: () ⇒ Option[Boolean], short: Option[Char], noshort: Boolean, prefix: String, descrYes: String, descrNo: String, hidden: Boolean) extends CliOption with Product with Serializable
case class TrailingArgsOption(name: String, required: Boolean, descr: String, converter: ValueConverter[_], validator: (scala.reflect.api.JavaUniverse.TypeTag[_], Any) ⇒ Boolean, default: () ⇒ Option[Any], hidden: Boolean) extends CliOption with Product with Serializable
trait ValueConverter[A] extends AnyRef

Converter from list of plain strings to something meaningful.

Value Members

object ArgType extends Enumeration

An enumeration of possible arg types by number of arguments they can take.
object Formatter
object Scallop extends Serializable

The creator and god of all parsers :)
object TrailingArgumentsParser

Parses the trailing arguments (including the arguments to last option).
Parses the trailing arguments (including the arguments to last option). Uses simple backtraking algorithm.
implicit val bigDecimalConverter: ValueConverter[BigDecimal]
implicit val bigIntConverter: ValueConverter[BigInt]
implicit val byteConverter: ValueConverter[Byte]
implicit val byteListConverter: ValueConverter[List[Byte]]
implicit val bytePropsConverter: ValueConverter[Map[String, Byte]]
implicit val charConverter: ValueConverter[Char]
implicit val charPropsConverter: ValueConverter[Map[String, Char]]
implicit val doubleConverter: ValueConverter[Double]
implicit val doubleListConverter: ValueConverter[List[Double]]
implicit val doublePropsConverter: ValueConverter[Map[String, Double]]
package exceptions
implicit val fileConverter: ValueConverter[File]
implicit val flagConverter: ValueConverter[Boolean]
implicit val floatConverter: ValueConverter[Float]
implicit val floatListConverter: ValueConverter[List[Float]]
implicit val floatPropsConverter: ValueConverter[Map[String, Float]]
implicit val intConverter: ValueConverter[Int]
implicit val intListConverter: ValueConverter[List[Int]]
implicit val intPropsConverter: ValueConverter[Map[String, Int]]
def listArgConverter[A](conv: (String) ⇒ A)(implicit tt: scala.reflect.api.JavaUniverse.TypeTag[List[A]]): ValueConverter[List[A]]
implicit val longConverter: ValueConverter[Long]
implicit val longListConverter: ValueConverter[List[Long]]
implicit val longPropsConverter: ValueConverter[Map[String, Long]]
def numberHandler[T](name: String): PartialFunction[Throwable, Either[String, Option[T]]]

Handler function for numeric types which expects a NumberFormatException and prints a more helpful error message.
Handler function for numeric types which expects a NumberFormatException and prints a more helpful error message.
name
the type name to display
def optDefault[A](default: A)(implicit conv: ValueConverter[A]): ValueConverter[A]
object overrideColorOutput extends DynamicVariable[Option[Boolean]]
implicit val pathConverter: ValueConverter[Path]
def propsConverter[A](conv: ValueConverter[A])(implicit tt: scala.reflect.api.JavaUniverse.TypeTag[Map[String, A]]): ValueConverter[Map[String, A]]
implicit val shortConverter: ValueConverter[Short]
implicit val shortListConverter: ValueConverter[List[Short]]
implicit val shortPropsConverter: ValueConverter[Map[String, Short]]
def singleArgConverter[A](conv: (String) ⇒ A, handler: PartialFunction[Throwable, Either[String, Option[A]]] = PartialFunction.empty)(implicit tt: scala.reflect.api.JavaUniverse.TypeTag[A]): ValueConverter[A]

Create a converter for an argument with a single value.
Create a converter for an argument with a single value.
conv
the conversion function to use, which may throw an exception on error
handler
an error handler function for writing custom error messages
implicit val stringConverter: ValueConverter[String]
implicit val stringListConverter: ValueConverter[List[String]]
implicit val stringPropsConverter: ValueConverter[Map[String, String]]
val tallyConverter: ValueConverter[Int]
object throwError extends DynamicVariable[Boolean]

Convenience variable to permit testing.
implicit val uriConverter: ValueConverter[URI]
implicit val urlConverter: ValueConverter[URL]

package scallop

Type Members

sealed trait CliOption extends AnyRef

class LazyMap[A, +B] extends Map[A, B]

case class LongNamedPropertyOption(name: String, descr: String, converter: ValueConverter[_], keyName: String, valueName: String, hidden: Boolean) extends CliOption with Product with Serializable

case class NumberArgOption(name: String, required: Boolean, descr: String, converter: ValueConverter[Long], validator: (scala.reflect.api.JavaUniverse.TypeTag[_], Any) ⇒ Boolean, default: () ⇒ Option[Long], hidden: Boolean) extends CliOption with Product with Serializable

case class PropertyOption(name: String, short: Char, descr: String, converter: ValueConverter[_], keyName: String, valueName: String, hidden: Boolean) extends CliOption with Product with Serializable

abstract class ScallopConf extends ScallopConfValidations

trait ScallopConfValidations extends AnyRef

abstract class ScallopOption[A] extends AnyRef

class Subcommand extends ScallopConf

case class ToggleOption(name: String, default: () ⇒ Option[Boolean], short: Option[Char], noshort: Boolean, prefix: String, descrYes: String, descrNo: String, hidden: Boolean) extends CliOption with Product with Serializable

case class TrailingArgsOption(name: String, required: Boolean, descr: String, converter: ValueConverter[_], validator: (scala.reflect.api.JavaUniverse.TypeTag[_], Any) ⇒ Boolean, default: () ⇒ Option[Any], hidden: Boolean) extends CliOption with Product with Serializable

trait ValueConverter[A] extends AnyRef

Value Members

object ArgType extends Enumeration

object Formatter

object Scallop extends Serializable

object TrailingArgumentsParser

implicit val bigDecimalConverter: ValueConverter[BigDecimal]

implicit val bigIntConverter: ValueConverter[BigInt]

implicit val byteConverter: ValueConverter[Byte]

implicit val byteListConverter: ValueConverter[List[Byte]]

implicit val bytePropsConverter: ValueConverter[Map[String, Byte]]

implicit val charConverter: ValueConverter[Char]

implicit val charPropsConverter: ValueConverter[Map[String, Char]]

implicit val doubleConverter: ValueConverter[Double]

implicit val doubleListConverter: ValueConverter[List[Double]]

implicit val doublePropsConverter: ValueConverter[Map[String, Double]]

package exceptions

implicit val fileConverter: ValueConverter[File]

implicit val flagConverter: ValueConverter[Boolean]

implicit val floatConverter: ValueConverter[Float]

implicit val floatListConverter: ValueConverter[List[Float]]

implicit val floatPropsConverter: ValueConverter[Map[String, Float]]

implicit val intConverter: ValueConverter[Int]

implicit val intListConverter: ValueConverter[List[Int]]

implicit val intPropsConverter: ValueConverter[Map[String, Int]]

def listArgConverter[A](conv: (String) ⇒ A)(implicit tt: scala.reflect.api.JavaUniverse.TypeTag[List[A]]): ValueConverter[List[A]]

implicit val longConverter: ValueConverter[Long]

implicit val longListConverter: ValueConverter[List[Long]]

implicit val longPropsConverter: ValueConverter[Map[String, Long]]

def numberHandler[T](name: String): PartialFunction[Throwable, Either[String, Option[T]]]

def optDefault[A](default: A)(implicit conv: ValueConverter[A]): ValueConverter[A]

object overrideColorOutput extends DynamicVariable[Option[Boolean]]

implicit val pathConverter: ValueConverter[Path]

def propsConverter[A](conv: ValueConverter[A])(implicit tt: scala.reflect.api.JavaUniverse.TypeTag[Map[String, A]]): ValueConverter[Map[String, A]]

implicit val shortConverter: ValueConverter[Short]

implicit val shortListConverter: ValueConverter[List[Short]]

implicit val shortPropsConverter: ValueConverter[Map[String, Short]]

def singleArgConverter[A](conv: (String) ⇒ A, handler: PartialFunction[Throwable, Either[String, Option[A]]] = PartialFunction.empty)(implicit tt: scala.reflect.api.JavaUniverse.TypeTag[A]): ValueConverter[A]

implicit val stringConverter: ValueConverter[String]

implicit val stringListConverter: ValueConverter[List[String]]

implicit val stringPropsConverter: ValueConverter[Map[String, String]]

val tallyConverter: ValueConverter[Int]

object throwError extends DynamicVariable[Boolean]

implicit val uriConverter: ValueConverter[URI]

implicit val urlConverter: ValueConverter[URL]

Inherited from AnyRef

Inherited from Any

Ungrouped