types

Type Members

1. case class AltNode[A](as: List[OptTree[A]]) extends OptTree[A] with Product with Serializable

   

2. case class AltP[A](p1: Parser[A], p2: Parser[A]) extends Parser[A] with Product with Serializable

   

3. sealed trait ArgPolicy extends AnyRef

   

4. case class ArgReader[A](cr: CReader[A]) extends OptReader[A] with Product with Serializable

   

5. type Args = List[String]

   

6. case class BindP[A, B](p: Parser[A], f: (A) ⇒ Parser[B]) extends Parser[B] with Product with Serializable

   

7. final case class CReader[A](reader: ReadM[A]) extends Product with Serializable

   

8. case class CmdReader[A](ns: List[String], f: (String) ⇒ Option[ParserInfo[A]]) extends OptReader[A] with Product with Serializable

   

9. case class ErrorMsg(msg: String) extends ParseError with Product with Serializable

   

10. sealed trait ExitCode extends AnyRef

    

11. case class ExitFailure(code: Int) extends ExitCode with Product with Serializable

    

12. case class Failure[A](failure: ParserFailure[ParserHelp]) extends ParserResult[A] with Product with Serializable

    

13. case class FlagReader[A](ns: List[OptName], a: A) extends OptReader[A] with Product with Serializable

    

14. case class InfoMsg(msg: String) extends ParseError with Product with Serializable

    

15. case class Leaf[A](a: A) extends OptTree[A] with Product with Serializable

    

16. case class MultNode[A](as: List[OptTree[A]]) extends OptTree[A] with Product with Serializable

    

17. case class MultP[A, B](p1: Parser[(A) ⇒ B], p2: Parser[A]) extends Parser[B] with Product with Serializable

    

18. case class NilP[A](fa: Option[A]) extends Parser[A] with Product with Serializable

    

19. final case class Opt[A](main: OptReader[A], props: OptProperties) extends Product with Serializable

    

    A single option of a parser.

20. final case class OptHelpInfo(multi: Boolean, default: Boolean) extends Product with Serializable

    

21. case class OptLong(name: String) extends OptName with Product with Serializable

    

22. sealed trait OptName extends AnyRef

    

23. case class OptP[A](fa: Opt[A]) extends Parser[A] with Product with Serializable

    

24. final case class OptProperties(visibility: OptVisibility, help: Chunk[org.kiama.output.PrettyPrinter.Doc], metaVar: String, showDefault: Option[String]) extends Product with Serializable

    

    Specification for an individual parser option.

25. sealed trait OptReader[A] extends AnyRef

    

26. case class OptShort(name: Char) extends OptName with Product with Serializable

    

27. sealed trait OptTree[A] extends AnyRef

    

28. sealed trait OptVisibility extends Ordered[OptVisibility]

    

29. case class OptionReader[A](ns: List[OptName], cr: CReader[A], e: ParseError) extends OptReader[A] with Product with Serializable

    

30. sealed trait ParseError extends AnyRef

    

31. sealed trait Parser[A] extends AnyRef

    

32. case class ParserFailure[H](run: (String) ⇒ (H, ExitCode, Int)) extends Product with Serializable

    

33. final case class ParserInfo[A](parser: Parser[A], fullDesc: Boolean, progDesc: Chunk[org.kiama.output.PrettyPrinter.Doc], header: Chunk[org.kiama.output.PrettyPrinter.Doc], footer: Chunk[org.kiama.output.PrettyPrinter.Doc], failureCode: Int, intersperse: Boolean) extends Product with Serializable

    

    A full description for a runnable Parser for a program.

    A full description for a runnable Parser for a program.

    parser

    the option parser for the program

    fullDesc

    whether the help text should contain full documentation

    failureCode

    exit code for a parser failure

34. trait ParserM[R] extends AnyRef

    

35. final case class ParserPrefs(multiSuffix: String, disambiguate: Boolean = false, showHelpOnError: Boolean = false, backtrack: Boolean = false, columns: Int = 80) extends Product with Serializable

    
    multiSuffix

    metavar suffix for multiple options

    disambiguate

    automatically disambiguate abbreviations

    showHelpOnError

    show help text on parse errors

    backtrack

    backtrack to parent parser when a subcommand fails

    columns

    format the help page

36. sealed trait ParserResult[A] extends AnyRef

    

37. final case class ReadM[A](run: ReaderT[[α]\/[ParseError, α], String, A]) extends Product with Serializable

    

    A newtype over the Either monad used by option readers.

38. case class Success[A](a: A) extends ParserResult[A] with Product with Serializable