Class

com.phasmidsoftware.args

SynopsisParser

Related Doc: package args

Permalink

class SynopsisParser extends RegexParsers

Linear Supertypes
RegexParsers, Parsers, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SynopsisParser
  2. RegexParsers
  3. Parsers
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SynopsisParser()

    Permalink

Type Members

  1. type Elem = Char

    Permalink
    Definition Classes
    RegexParsers → Parsers
  2. case class Error extends NoSuccess with Product with Serializable

    Permalink
    Definition Classes
    Parsers
  3. case class Failure extends NoSuccess with Product with Serializable

    Permalink
    Definition Classes
    Parsers
  4. type Input = Reader[Elem]

    Permalink
    Definition Classes
    Parsers
  5. sealed abstract class NoSuccess extends ParseResult[Nothing]

    Permalink
    Definition Classes
    Parsers
  6. trait OnceParser[+T] extends Parser[T]

    Permalink
    Definition Classes
    Parsers
  7. sealed abstract class ParseResult[+T] extends AnyRef

    Permalink
    Definition Classes
    Parsers
  8. abstract class Parser[+T] extends (Input) ⇒ ParseResult[T]

    Permalink
    Definition Classes
    Parsers
  9. case class Success[+T] extends ParseResult[T] with Product with Serializable

    Permalink
    Definition Classes
    Parsers
  10. case class ~[+a, +b] extends Product with Serializable

    Permalink
    Definition Classes
    Parsers

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def OnceParser[T](f: (Input) ⇒ ParseResult[T]): Parser[T] with OnceParser[T]

    Permalink
    Definition Classes
    Parsers
  5. def Parser[T](f: (Input) ⇒ ParseResult[T]): Parser[T]

    Permalink
    Definition Classes
    Parsers
  6. def accept[U](expected: String, f: PartialFunction[Elem, U]): Parser[U]

    Permalink
    Definition Classes
    Parsers
  7. def accept[ES](es: ES)(implicit arg0: (ES) ⇒ List[Elem]): Parser[List[Elem]]

    Permalink
    Definition Classes
    Parsers
  8. implicit def accept(e: Elem): Parser[Elem]

    Permalink
    Definition Classes
    Parsers
  9. def acceptIf(p: (Elem) ⇒ Boolean)(err: (Elem) ⇒ String): Parser[Elem]

    Permalink
    Definition Classes
    Parsers
  10. def acceptMatch[U](expected: String, f: PartialFunction[Elem, U]): Parser[U]

    Permalink
    Definition Classes
    Parsers
  11. def acceptSeq[ES](es: ES)(implicit arg0: (ES) ⇒ Iterable[Elem]): Parser[List[Elem]]

    Permalink
    Definition Classes
    Parsers
  12. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  13. def chainl1[T, U](first: ⇒ Parser[T], p: ⇒ Parser[U], q: ⇒ Parser[(T, U) ⇒ T]): Parser[T]

    Permalink
    Definition Classes
    Parsers
  14. def chainl1[T](p: ⇒ Parser[T], q: ⇒ Parser[(T, T) ⇒ T]): Parser[T]

    Permalink
    Definition Classes
    Parsers
  15. def chainr1[T, U](p: ⇒ Parser[T], q: ⇒ Parser[(T, U) ⇒ U], combine: (T, U) ⇒ U, first: U): Parser[U]

    Permalink
    Definition Classes
    Parsers
  16. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. def commit[T](p: ⇒ Parser[T]): Parser[T]

    Permalink
    Definition Classes
    Parsers
  18. def elem(e: Elem): Parser[Elem]

    Permalink
    Definition Classes
    Parsers
  19. def elem(kind: String, p: (Elem) ⇒ Boolean): Parser[Elem]

    Permalink
    Definition Classes
    Parsers
  20. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  21. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  22. def err(msg: String): Parser[Nothing]

    Permalink
    Definition Classes
    Parsers
  23. def failure(msg: String): Parser[Nothing]

    Permalink
    Definition Classes
    Parsers
  24. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  25. def flag: Parser[Flag]

    Permalink

    A flag ("option") matches a single character which is either a letter or a digit

    A flag ("option") matches a single character which is either a letter or a digit

    returns

    a Parser[Flag]

  26. def flagGroup: Parser[Seq[Element]]

    Permalink

    A "synopsis" of command-line options and their potential argument values.

    A "synopsis" of command-line options and their potential argument values. It matches a dash ('-') followed by a list of optionalOrRequiredElement OR: an optional list of flagWithOrWithoutValue

    returns

    a Parser[Seq[Element]

  27. def flagWithOrWithoutValue: Parser[Element]

    Permalink

    A flagWithOrWithoutValue matches EITHER: a flag (option); OR: a flag (option) followed by a value

    A flagWithOrWithoutValue matches EITHER: a flag (option); OR: a flag (option) followed by a value

    returns

    a Parser[Element] which is EITHER: a Parser[Flag] OR: a Parser[FlagWithValue]

  28. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  29. def guard[T](p: ⇒ Parser[T]): Parser[T]

    Permalink
    Definition Classes
    Parsers
  30. def handleWhiteSpace(source: CharSequence, offset: Int): Int

    Permalink
    Attributes
    protected
    Definition Classes
    RegexParsers
  31. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  32. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  33. implicit def literal(s: String): Parser[String]

    Permalink
    Definition Classes
    RegexParsers
  34. def log[T](p: ⇒ Parser[T])(name: String): Parser[T]

    Permalink
    Definition Classes
    Parsers
  35. def mkList[T]: (~[T, List[T]]) ⇒ List[T]

    Permalink
    Definition Classes
    Parsers
  36. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  37. def not[T](p: ⇒ Parser[T]): Parser[Unit]

    Permalink
    Definition Classes
    Parsers
  38. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  39. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  40. def operand: Parser[Element]

    Permalink
  41. val operandToken: Parser[String]

    Permalink

    A operandToken matches at least one non-space, non-dash, non-bracket symbol

    A operandToken matches at least one non-space, non-dash, non-bracket symbol

    returns

    a Parser[String]

  42. def operands: Parser[Seq[Element]]

    Permalink
  43. def opt[T](p: ⇒ Parser[T]): Parser[Option[T]]

    Permalink
    Definition Classes
    Parsers
  44. def optionalElement: Parser[Element]

    Permalink

    An optionalElement matches a '[' followed by a flagWithOrWithoutValue followed by a ']'

    An optionalElement matches a '[' followed by a flagWithOrWithoutValue followed by a ']'

    returns

    a Parser[OptionalElement]

  45. def optionalElements: Parser[Seq[Element]]

    Permalink

    An optionalElement matches a '[' followed by a flagWithOrWithoutValue followed by a ']'

    An optionalElement matches a '[' followed by a flagWithOrWithoutValue followed by a ']'

    returns

    a Parser[Seq[Element]

  46. def optionalOperand: Parser[Element]

    Permalink
  47. def optionalOrRequiredElement: Parser[Element]

    Permalink

    An optionalOrRequiredElement matches EITHER: an optionalElement OR: a flagWithOrWithoutValue

    An optionalOrRequiredElement matches EITHER: an optionalElement OR: a flagWithOrWithoutValue

    returns

    a Parser[Element] which is EITHER: a Parser[Flag] OR: a Parser[FlagWithValue] OR: a Parser[OptionalElement]

  48. def optionalValue: Parser[Element]

    Permalink

    An optionalValue matches "[" "value" "]"

    An optionalValue matches "[" "value" "]"

    returns

    a Parser[OptionalElement]

  49. def parse[T](p: Parser[T], in: Reader): ParseResult[T]

    Permalink
    Definition Classes
    RegexParsers
  50. def parse[T](p: Parser[T], in: CharSequence): ParseResult[T]

    Permalink
    Definition Classes
    RegexParsers
  51. def parse[T](p: Parser[T], in: Reader[Char]): ParseResult[T]

    Permalink
    Definition Classes
    RegexParsers
  52. def parseAll[T](p: Parser[T], in: CharSequence): ParseResult[T]

    Permalink
    Definition Classes
    RegexParsers
  53. def parseAll[T](p: Parser[T], in: Reader): ParseResult[T]

    Permalink
    Definition Classes
    RegexParsers
  54. def parseAll[T](p: Parser[T], in: Reader[Char]): ParseResult[T]

    Permalink
    Definition Classes
    RegexParsers
  55. def parseOptionalSynopsis(wo: Option[String]): Try[Synopsis]

    Permalink
  56. def parseSynopsis(w: String): Synopsis

    Permalink
  57. def phrase[T](p: Parser[T]): Parser[T]

    Permalink
    Definition Classes
    RegexParsers → Parsers
  58. def positioned[T <: Positional](p: ⇒ Parser[T]): Parser[T]

    Permalink
    Definition Classes
    RegexParsers → Parsers
  59. implicit def regex(r: Regex): Parser[String]

    Permalink
    Definition Classes
    RegexParsers
  60. def rep[T](p: ⇒ Parser[T]): Parser[List[T]]

    Permalink
    Definition Classes
    Parsers
  61. def rep1[T](first: ⇒ Parser[T], p0: ⇒ Parser[T]): Parser[List[T]]

    Permalink
    Definition Classes
    Parsers
    Annotations
    @migration
    Migration

    (Changed in version 2.9.0) The p0 call-by-name arguments is evaluated at most once per constructed Parser object, instead of on every need that arises during parsing.

  62. def rep1[T](p: ⇒ Parser[T]): Parser[List[T]]

    Permalink
    Definition Classes
    Parsers
  63. def rep1sep[T](p: ⇒ Parser[T], q: ⇒ Parser[Any]): Parser[List[T]]

    Permalink
    Definition Classes
    Parsers
  64. def repN[T](num: Int, p: ⇒ Parser[T]): Parser[List[T]]

    Permalink
    Definition Classes
    Parsers
  65. def repsep[T](p: ⇒ Parser[T], q: ⇒ Parser[Any]): Parser[List[T]]

    Permalink
    Definition Classes
    Parsers
  66. def skipWhitespace: Boolean

    Permalink
    Definition Classes
    SynopsisParser → RegexParsers
  67. def success[T](v: T): Parser[T]

    Permalink
    Definition Classes
    Parsers
  68. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  69. def synopsis: Parser[Seq[Element]]

    Permalink

    A "synopsis" of command-line options and their potential argument values.

    A "synopsis" of command-line options and their potential argument values. It matches a dash ('-') followed by a list of optionalOrRequiredElement OR: an optional list of flagWithOrWithoutValue

    returns

    a Parser[Seq[Element]

  70. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  71. def value: Parser[Value]

    Permalink

    A value matches EITHER: a space [which is ignored] followed by a valueToken1 OR: a valueToken2

    A value matches EITHER: a space [which is ignored] followed by a valueToken1 OR: a valueToken2

    returns

    a Parser[Value]

  72. val valueToken1: Parser[String]

    Permalink

    A valueToken1 matches at least one non-space, non-bracket symbol

    A valueToken1 matches at least one non-space, non-bracket symbol

    CONSIDER should not allow "-"

    returns

    a Parser[String]

  73. val valueToken2: Parser[String]

    Permalink

    A valueToken2 matches an uppercase letter followed by any number of non-space, non-bracket symbols

    A valueToken2 matches an uppercase letter followed by any number of non-space, non-bracket symbols

    CONSIDER should not allow "-"

    returns

    a Parser[String]

  74. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  75. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  76. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  77. val whiteSpace: Regex

    Permalink
    Attributes
    protected
    Definition Classes
    RegexParsers

Inherited from RegexParsers

Inherited from Parsers

Inherited from AnyRef

Inherited from Any

Ungrouped