Packages

package cmd

Source
package.scala
Linear Supertypes
AnyRef, Any
Content Hierarchy
SpecReferenceInstancePropertyCommandLineCommandLineConfig
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. cmd
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. class CommandLine extends CommandLineConfig

    An instance of a command line, parsed according to a Spec.

  2. trait CommandLineConfig extends AnyRef
  3. abstract class FromString[+T] extends PartialFunction[String, T]

    A general mechanism for defining how a command line argument (always a String) is transformed into an arbitrary type.

    A general mechanism for defining how a command line argument (always a String) is transformed into an arbitrary type. A few example instances are in the companion object, but in general either IntFromString will suffice or you'll want custom transformers.

  4. trait Instance extends Spec

    The trait mixed into each instance of a specification.

    The trait mixed into each instance of a specification.

    See also

    Reference

  5. trait Interpolation extends AnyRef

    Interpolation logic for generated files.

    Interpolation logic for generated files. The idea is to be able to write in terms of @@THIS@@ and @@THAT@@ and the reference specification knows enough to perform the substitutions. Warrants expansion.

  6. trait Property extends Reference
  7. class PropertyMapper extends ((String, String)) ⇒ List[String]

    Contains logic for translating a property key/value pair into equivalent command line arguments.

    Contains logic for translating a property key/value pair into equivalent command line arguments. The default settings will translate, given programInfo.runner == "foo" :

    foo.bar=true to --bar // if --bar is unary foo.bar=quux to --bar quux // if --bar is binary

  8. trait Reference extends Spec

    Mixes in the specification trait and uses the vals therein to side-effect private accumulators.

    Mixes in the specification trait and uses the vals therein to side-effect private accumulators. From this emerges formatted help, lists of unary and binary arguments, an apply which can creates instances of the specification, and etc.

    See also

    Instance

  9. trait Spec extends AnyRef

    This trait works together with others in scala.tools.cmd to allow declaratively specifying a command line program, with many attendant benefits.

    This trait works together with others in scala.tools.cmd to allow declaratively specifying a command line program, with many attendant benefits. See scala.tools.cmd.DemoSpec for an example.

Value Members

  1. def fromArgs(args: List[String]): String
  2. def fromOpt(s: String): String
  3. implicit def implicitConversions: implicitConversions
  4. implicit def postfixOps: postfixOps
  5. def returning[T](x: T)(f: (T) ⇒ Unit): T
  6. def runAndExit(body: ⇒ Unit): Nothing
  7. def stripQuotes(s: String): String
  8. def toArgs(line: String): List[String]
  9. def toOpt(s: String): String
  10. object CommandLineParser

    A simple (overly so) command line parser.

    A simple (overly so) command line parser. !!! This needs a thorough test suite to make sure quoting is done correctly and portably.

  11. object FromString
  12. object Interpolation
  13. object Meta

    Meta-options for command line tools.

    Meta-options for command line tools. We could have all kinds of additional goodness here, but for now it's completion and script generation. See Demo for example usage.

  14. object Opt

    Machinery for what amounts to a command line specification DSL.

    Machinery for what amounts to a command line specification DSL. It is designed so the same specification trait can be used for two different purposes: generating a singleton specification object (trait Reference) and providing well typed vals for every configurable option in response to any given set of arguments (trait Instance).

  15. object Reference
  16. object Spec

Inherited from AnyRef

Inherited from Any

Ungrouped