Data.Conf

This modules contains the conf Megaparsec parser for .conf files and Pretty instance.

Entry-points

conf :: Parser Conf

The .conf parser

See Text.Megaparsec

pPrintConf :: Conf -> Doc

Pretty-prints a Conf to a Doc

pPrint restricted to Conf

print (pPrintConf c)

See Text.PrettyPrint

runParser

Arguments

:: Parsec e s a

Parser to run

-> String

Name of source file

-> s

Input for parser

-> Either (ParseError (Token s) e) a

runParser p file input runs parser p on the input list of tokens input, obtained from source file. The file is only used in error messages and may be the empty string. Returns either a ParseError (Left) or a value of type a (Right).

parseFromFile p file = runParser p file <$> readFile file

Types

type Conf = [ConfStatement]

data ConfStatement

Constructors

ConfStatementComment Comment

ConfStatementBlock Block

ConfStatementEmptyLine

We store empty lines while parsing so we can reconstruct the document when pretty-printing

ConfStatementExpression Expression

Instances

Eq ConfStatement

Methods

(==) :: ConfStatement -> ConfStatement -> Bool

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

Show ConfStatement

Methods

showsPrec :: Int -> ConfStatement -> ShowS

show :: ConfStatement -> String

showList :: [ConfStatement] -> ShowS

data Block

Constructors

Block [Text] [ConfStatement]

Instances

Eq Block

Methods

(==) :: Block -> Block -> Bool

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

Show Block

Methods

showsPrec :: Int -> Block -> ShowS

show :: Block -> String

showList :: [Block] -> ShowS

data Comment

Constructors

Comment Text

Instances

Eq Comment

Methods

(==) :: Comment -> Comment -> Bool

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

Show Comment

Methods

showsPrec :: Int -> Comment -> ShowS

show :: Comment -> String

showList :: [Comment] -> ShowS

data Expression

Constructors

Expression Text [Text]

Instances

Eq Expression

Methods

(==) :: Expression -> Expression -> Bool

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

Show Expression

Methods

showsPrec :: Int -> Expression -> ShowS

show :: Expression -> String

showList :: [Expression] -> ShowS

Parser

confStatement :: Parser ConfStatement

confStatementLines :: Parser [ConfStatement]

block :: Parser Block

expression :: Parser Expression

argument :: Parser Text

Pretty-printer

class Pretty a where

Pretty printing class. The precedence level is used in a similar way as in the Show class. Minimal complete definition is either pPrintPrec or pPrint.

Minimal complete definition

pPrintPrec | pPrint

Methods

pPrintPrec :: PrettyLevel -> Rational -> a -> Doc

pPrint :: a -> Doc

pPrintList :: PrettyLevel -> [a] -> Doc

Instances

Pretty Bool

Methods

pPrintPrec :: PrettyLevel -> Rational -> Bool -> Doc

pPrint :: Bool -> Doc

pPrintList :: PrettyLevel -> [Bool] -> Doc

Pretty Char

Methods

pPrintPrec :: PrettyLevel -> Rational -> Char -> Doc

pPrint :: Char -> Doc

pPrintList :: PrettyLevel -> [Char] -> Doc

Pretty Double

Methods

pPrintPrec :: PrettyLevel -> Rational -> Double -> Doc

pPrint :: Double -> Doc

pPrintList :: PrettyLevel -> [Double] -> Doc

Pretty Float

Methods

pPrintPrec :: PrettyLevel -> Rational -> Float -> Doc

pPrint :: Float -> Doc

pPrintList :: PrettyLevel -> [Float] -> Doc

Pretty Int

Methods

pPrintPrec :: PrettyLevel -> Rational -> Int -> Doc

pPrint :: Int -> Doc

pPrintList :: PrettyLevel -> [Int] -> Doc

Pretty Integer

Methods

pPrintPrec :: PrettyLevel -> Rational -> Integer -> Doc

pPrint :: Integer -> Doc

pPrintList :: PrettyLevel -> [Integer] -> Doc

Pretty Ordering

Methods

pPrintPrec :: PrettyLevel -> Rational -> Ordering -> Doc

pPrint :: Ordering -> Doc

pPrintList :: PrettyLevel -> [Ordering] -> Doc

Pretty ()

Methods

pPrintPrec :: PrettyLevel -> Rational -> () -> Doc

pPrint :: () -> Doc

pPrintList :: PrettyLevel -> [()] -> Doc

Pretty a => Pretty [a]

Methods

pPrintPrec :: PrettyLevel -> Rational -> [a] -> Doc

pPrint :: [a] -> Doc

pPrintList :: PrettyLevel -> [[a]] -> Doc

Pretty a => Pretty (Maybe a)

Methods

pPrintPrec :: PrettyLevel -> Rational -> Maybe a -> Doc

pPrint :: Maybe a -> Doc

pPrintList :: PrettyLevel -> [Maybe a] -> Doc

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

Methods

pPrintPrec :: PrettyLevel -> Rational -> Either a b -> Doc

pPrint :: Either a b -> Doc

pPrintList :: PrettyLevel -> [Either a b] -> Doc

(Pretty a, Pretty b) => Pretty (a, b)

Methods

pPrintPrec :: PrettyLevel -> Rational -> (a, b) -> Doc

pPrint :: (a, b) -> Doc

pPrintList :: PrettyLevel -> [(a, b)] -> Doc

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

Methods

pPrintPrec :: PrettyLevel -> Rational -> (a, b, c) -> Doc

pPrint :: (a, b, c) -> Doc

pPrintList :: PrettyLevel -> [(a, b, c)] -> Doc

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

Methods

pPrintPrec :: PrettyLevel -> Rational -> (a, b, c, d) -> Doc

pPrint :: (a, b, c, d) -> Doc

pPrintList :: PrettyLevel -> [(a, b, c, d)] -> Doc

(Pretty a, Pretty b, Pretty c, Pretty d, Pretty e) => Pretty (a, b, c, d, e)

Methods

pPrintPrec :: PrettyLevel -> Rational -> (a, b, c, d, e) -> Doc

pPrint :: (a, b, c, d, e) -> Doc

pPrintList :: PrettyLevel -> [(a, b, c, d, e)] -> Doc

(Pretty a, Pretty b, Pretty c, Pretty d, Pretty e, Pretty f) => Pretty (a, b, c, d, e, f)

Methods

pPrintPrec :: PrettyLevel -> Rational -> (a, b, c, d, e, f) -> Doc

pPrint :: (a, b, c, d, e, f) -> Doc

pPrintList :: PrettyLevel -> [(a, b, c, d, e, f)] -> Doc

(Pretty a, Pretty b, Pretty c, Pretty d, Pretty e, Pretty f, Pretty g) => Pretty (a, b, c, d, e, f, g)

Methods

pPrintPrec :: PrettyLevel -> Rational -> (a, b, c, d, e, f, g) -> Doc

pPrint :: (a, b, c, d, e, f, g) -> Doc

pPrintList :: PrettyLevel -> [(a, b, c, d, e, f, g)] -> Doc

(Pretty a, Pretty b, Pretty c, Pretty d, Pretty e, Pretty f, Pretty g, Pretty h) => Pretty (a, b, c, d, e, f, g, h)

Methods

pPrintPrec :: PrettyLevel -> Rational -> (a, b, c, d, e, f, g, h) -> Doc

pPrint :: (a, b, c, d, e, f, g, h) -> Doc

pPrintList :: PrettyLevel -> [(a, b, c, d, e, f, g, h)] -> Doc

pPrint :: Pretty a => a -> Doc