Coalpit

Coalpit is a library for building command-line interfaces: the goal is to build interfaces quickly and easily (by deriving those), while keeping them language-agnostic and more user- and shell scripting-friendly than JSON and similar formats.

Documentation

fromDSV :: Coalpit a => Options -> String -> Either String a

Parse a single record from a string.

fromDSVList :: Coalpit a => Options -> String -> Either String [a]

Parse multiple records from a string.

toDSV :: Coalpit a => Options -> a -> String

Serialize a value.

toDSVList :: Coalpit a => Options -> [a] -> String

Serialize multiple values.

dsvFromList :: Options -> [String] -> String

Build a record ("line") out of individual strings, escaping those if needed.

class Coalpit a where

Coalpit class: parsing, printing, usage strings.

Minimal complete definition

Nothing

Methods

coalpitParser :: Options -> Parser a

default coalpitParser :: (Generic a, GCoalpit (Rep a)) => Options -> Parser a

coalpitPrint :: Options -> a -> [String]

default coalpitPrint :: (Generic a, GCoalpit (Rep a)) => Options -> a -> [String]

coalpitDescription :: Options -> [String] -> Proxy a -> Usage

default coalpitDescription :: GCoalpit (Rep a) => Options -> [String] -> Proxy a -> Usage

Instances

Coalpit Version

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser Version

coalpitPrint :: Options -> Version -> [String]

coalpitDescription :: Options -> [String] -> Proxy Version -> Usage

Coalpit ExitCode

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser ExitCode

coalpitPrint :: Options -> ExitCode -> [String]

coalpitDescription :: Options -> [String] -> Proxy ExitCode -> Usage

Coalpit Int16

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser Int16

coalpitPrint :: Options -> Int16 -> [String]

coalpitDescription :: Options -> [String] -> Proxy Int16 -> Usage

Coalpit Int32

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser Int32

coalpitPrint :: Options -> Int32 -> [String]

coalpitDescription :: Options -> [String] -> Proxy Int32 -> Usage

Coalpit Int64

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser Int64

coalpitPrint :: Options -> Int64 -> [String]

coalpitDescription :: Options -> [String] -> Proxy Int64 -> Usage

Coalpit Int8

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser Int8

coalpitPrint :: Options -> Int8 -> [String]

coalpitDescription :: Options -> [String] -> Proxy Int8 -> Usage

Coalpit Rational

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser Rational

coalpitPrint :: Options -> Rational -> [String]

coalpitDescription :: Options -> [String] -> Proxy Rational -> Usage

Coalpit Word16

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser Word16

coalpitPrint :: Options -> Word16 -> [String]

coalpitDescription :: Options -> [String] -> Proxy Word16 -> Usage

Coalpit Word32

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser Word32

coalpitPrint :: Options -> Word32 -> [String]

coalpitDescription :: Options -> [String] -> Proxy Word32 -> Usage

Coalpit Word64

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser Word64

coalpitPrint :: Options -> Word64 -> [String]

coalpitDescription :: Options -> [String] -> Proxy Word64 -> Usage

Coalpit Word8

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser Word8

coalpitPrint :: Options -> Word8 -> [String]

coalpitDescription :: Options -> [String] -> Proxy Word8 -> Usage

Coalpit Ordering

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser Ordering

coalpitPrint :: Options -> Ordering -> [String]

coalpitDescription :: Options -> [String] -> Proxy Ordering -> Usage

Coalpit URI

An URI reference (absolute or relative).

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser URI

coalpitPrint :: Options -> URI -> [String]

coalpitDescription :: Options -> [String] -> Proxy URI -> Usage

Coalpit Scientific

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser Scientific

coalpitPrint :: Options -> Scientific -> [String]

coalpitDescription :: Options -> [String] -> Proxy Scientific -> Usage

Coalpit Day

Uses dateFormat.

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser Day

coalpitPrint :: Options -> Day -> [String]

coalpitDescription :: Options -> [String] -> Proxy Day -> Usage

Coalpit DiffTime

Converts to/from Scientific.

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser DiffTime

coalpitPrint :: Options -> DiffTime -> [String]

coalpitDescription :: Options -> [String] -> Proxy DiffTime -> Usage

Coalpit NominalDiffTime

Converts to/from Scientific.

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser NominalDiffTime

coalpitPrint :: Options -> NominalDiffTime -> [String]

coalpitDescription :: Options -> [String] -> Proxy NominalDiffTime -> Usage

Coalpit UTCTime

Uses dateTimeFormat.

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser UTCTime

coalpitPrint :: Options -> UTCTime -> [String]

coalpitDescription :: Options -> [String] -> Proxy UTCTime -> Usage

Coalpit UniversalTime

Uses dateTimeFormat.

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser UniversalTime

coalpitPrint :: Options -> UniversalTime -> [String]

coalpitDescription :: Options -> [String] -> Proxy UniversalTime -> Usage

Coalpit LocalTime

Uses dateTimeFormat.

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser LocalTime

coalpitPrint :: Options -> LocalTime -> [String]

coalpitDescription :: Options -> [String] -> Proxy LocalTime -> Usage

Coalpit TimeOfDay

Uses timeFormat.

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser TimeOfDay

coalpitPrint :: Options -> TimeOfDay -> [String]

coalpitDescription :: Options -> [String] -> Proxy TimeOfDay -> Usage

Coalpit ZonedTime

Uses dateTimeFormat.

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser ZonedTime

coalpitPrint :: Options -> ZonedTime -> [String]

coalpitDescription :: Options -> [String] -> Proxy ZonedTime -> Usage

Coalpit String

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser String

coalpitPrint :: Options -> String -> [String]

coalpitDescription :: Options -> [String] -> Proxy String -> Usage

Coalpit Integer

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser Integer

coalpitPrint :: Options -> Integer -> [String]

coalpitDescription :: Options -> [String] -> Proxy Integer -> Usage

Coalpit Natural

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser Natural

coalpitPrint :: Options -> Natural -> [String]

coalpitDescription :: Options -> [String] -> Proxy Natural -> Usage

Coalpit ()

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser ()

coalpitPrint :: Options -> () -> [String]

coalpitDescription :: Options -> [String] -> Proxy () -> Usage

Coalpit Bool

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser Bool

coalpitPrint :: Options -> Bool -> [String]

coalpitDescription :: Options -> [String] -> Proxy Bool -> Usage

Coalpit Char

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser Char

coalpitPrint :: Options -> Char -> [String]

coalpitDescription :: Options -> [String] -> Proxy Char -> Usage

Coalpit Double

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser Double

coalpitPrint :: Options -> Double -> [String]

coalpitDescription :: Options -> [String] -> Proxy Double -> Usage

Coalpit Float

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser Float

coalpitPrint :: Options -> Float -> [String]

coalpitDescription :: Options -> [String] -> Proxy Float -> Usage

Coalpit Int

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser Int

coalpitPrint :: Options -> Int -> [String]

coalpitDescription :: Options -> [String] -> Proxy Int -> Usage

Coalpit a => Coalpit (Complex a)

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser (Complex a)

coalpitPrint :: Options -> Complex a -> [String]

coalpitDescription :: Options -> [String] -> Proxy (Complex a) -> Usage

Coalpit a => Coalpit (NonEmpty a)

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser (NonEmpty a)

coalpitPrint :: Options -> NonEmpty a -> [String]

coalpitDescription :: Options -> [String] -> Proxy (NonEmpty a) -> Usage

Coalpit a => Coalpit (Maybe a)

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser (Maybe a)

coalpitPrint :: Options -> Maybe a -> [String]

coalpitDescription :: Options -> [String] -> Proxy (Maybe a) -> Usage

Coalpit a => Coalpit [a]

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser [a]

coalpitPrint :: Options -> [a] -> [String]

coalpitDescription :: Options -> [String] -> Proxy [a] -> Usage

(Coalpit a, Coalpit b) => Coalpit (Either a b)

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser (Either a b)

coalpitPrint :: Options -> Either a b -> [String]

coalpitDescription :: Options -> [String] -> Proxy (Either a b) -> Usage

(Coalpit a, Coalpit b) => Coalpit (a, b)

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser (a, b)

coalpitPrint :: Options -> (a, b) -> [String]

coalpitDescription :: Options -> [String] -> Proxy (a, b) -> Usage

(Coalpit a, Coalpit b, Coalpit c) => Coalpit (a, b, c)

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser (a, b, c)

coalpitPrint :: Options -> (a, b, c) -> [String]

coalpitDescription :: Options -> [String] -> Proxy (a, b, c) -> Usage

(Coalpit a, Coalpit b, Coalpit c, Coalpit d) => Coalpit (a, b, c, d)

Defined in Coalpit

Methods

coalpitParser :: Options -> Parser (a, b, c, d)

coalpitPrint :: Options -> (a, b, c, d) -> [String]

coalpitDescription :: Options -> [String] -> Proxy (a, b, c, d) -> Usage

Usage

usage :: Coalpit a => Options -> Proxy a -> Usage

Compose Usage description.

usageString :: Coalpit a => Options -> Proxy a -> String

Compose a usage string.

data Usage

Usage description: can be translated into help messages or documentation formats.

Constructors

UConstructor String

Data constructor.

URecursive String

Constructor of a recursive data structure (its second appearance in the tree).

USelector Bool String Usage

Record selector.

UOptional Usage

Optional element.

USum Usage Usage

Sum.

UProduct Usage Usage

Product.

UUnit

Unit.

UType String

Type name (e.g., "INT").

Instances

Show Usage

Defined in Coalpit

Methods

showsPrec :: Int -> Usage -> ShowS

show :: Usage -> String

showList :: [Usage] -> ShowS

Options

data SelNamePolicy

How to handle selector names.

Constructors

SNDisable

Do not parse or print selector names

SNAvoid

Allow selector names on parsing, but do not print them

SNPrefer

Allow selector names on parsing, print them

SNRequire

Require selector names on parsing, print them

Instances

Show SelNamePolicy

Defined in Coalpit

Methods

showsPrec :: Int -> SelNamePolicy -> ShowS

show :: SelNamePolicy -> String

showList :: [SelNamePolicy] -> ShowS

Eq SelNamePolicy

Defined in Coalpit

Methods

(==) :: SelNamePolicy -> SelNamePolicy -> Bool

(/=) :: SelNamePolicy -> SelNamePolicy -> Bool

data Options

Printing and parsing options.

Constructors

Options

Fields

• fieldSeparators :: NonEmpty Char

  Separators between fields

• recordSeparators :: NonEmpty Char

  Separators between records (which may correspond to lines)

• conNameMod :: String -> String

  Constructor name modifier

• selNameMod :: String -> String

  Record selector name modifier

• selNamePolicy :: SelNamePolicy
• timeLocale :: TimeLocale
• dateFormat :: String

  See Data.Time.Format.

• timeFormat :: String
• dateTimeFormat :: String
• scientificFormat :: FPFormat
• scientificDecimals :: Maybe Int
• uriUserInfo :: String -> String

  Used to map userinfo parts of URIs.

defOpt :: Options

Default options.

Parsing and composition helpers

escape :: Options -> String -> String

Enquote and escape a string, if it contains any characters that need it.

pString :: Options -> Parsec String m String

Parse a token: either a quoted string or a string without unescaped separators. The opposite of escape.

pFieldSep :: Options -> Parsec String m ()

Parse a field separator.

pRecordSep :: Options -> Parsec String m ()

Parse a record (line) separator.