Copyright	(c) Dominik Schrempf 2019
License	GPL-3
Maintainer	dominik.schrempf@gmail.com
Stability	unstable
Portability	portable
Safe Haskell	None
Language	Haskell2010

ELynx.Tools.Options

Contents

Log file
Options
Options meta
Formatting

Description

Creation date: Fri May 3 18:20:11 2019.

Synopsis

logHeader :: String -> IO String
logFooter :: IO String
parseArgumentsWith :: [String] -> [String] -> Parser a -> IO a
data Verbosity
- = Quiet
- | Warning
- | Info
- | Debug
data GlobalArguments = GlobalArguments {
- verbosity :: LogLevel
- outFileBaseName :: Maybe FilePath
}
globalArguments :: Parser GlobalArguments
seedOpt :: Parser (Maybe [Word32])
megaReadM :: Parsec Void String a -> ReadM a
fillParagraph :: String -> Doc

Log file

logHeader :: String -> IO String Source #

Short, globally usable string preceding all logs with obligatory description.

logFooter :: IO String Source #

See logHeader but footer.

Options

parseArgumentsWith :: [String] -> [String] -> Parser a -> IO a Source #

Parse arguments. Provide a global description, header, footer, and so on. Custom additional description (first argument) and footer (second argument) can be provided. print help if needed.

data Verbosity Source #

Verbosity levels.

Constructors

Quiet
Warning
Info
Debug

Instances

Bounded Verbosity Source #
Instance details Defined in ELynx.Tools.Options Methods minBound :: Verbosity # maxBound :: Verbosity #
Enum Verbosity Source #
Instance details Defined in ELynx.Tools.Options Methods succ :: Verbosity -> Verbosity # pred :: Verbosity -> Verbosity # toEnum :: Int -> Verbosity # fromEnum :: Verbosity -> Int # enumFrom :: Verbosity -> [Verbosity] # enumFromThen :: Verbosity -> Verbosity -> [Verbosity] # enumFromTo :: Verbosity -> Verbosity -> [Verbosity] # enumFromThenTo :: Verbosity -> Verbosity -> Verbosity -> [Verbosity] #
Eq Verbosity Source #
Instance details Defined in ELynx.Tools.Options Methods (==) :: Verbosity -> Verbosity -> Bool # (/=) :: Verbosity -> Verbosity -> Bool #
Ord Verbosity Source #
Instance details Defined in ELynx.Tools.Options Methods compare :: Verbosity -> Verbosity -> Ordering # (<) :: Verbosity -> Verbosity -> Bool # (<=) :: Verbosity -> Verbosity -> Bool # (>) :: Verbosity -> Verbosity -> Bool # (>=) :: Verbosity -> Verbosity -> Bool # max :: Verbosity -> Verbosity -> Verbosity # min :: Verbosity -> Verbosity -> Verbosity #
Read Verbosity Source #
Instance details Defined in ELynx.Tools.Options Methods readsPrec :: Int -> ReadS Verbosity # readList :: ReadS [Verbosity] # readPrec :: ReadPrec Verbosity # readListPrec :: ReadPrec [Verbosity] #
Show Verbosity Source #
Instance details Defined in ELynx.Tools.Options Methods showsPrec :: Int -> Verbosity -> ShowS # show :: Verbosity -> String # showList :: [Verbosity] -> ShowS #

data GlobalArguments Source #

A set of global arguments used by all programs. The idea is to provide a common framework for shared arguments.

Constructors

GlobalArguments
Fields verbosity :: LogLevel outFileBaseName :: Maybe FilePath

globalArguments :: Parser GlobalArguments Source #

See GlobalArguments, parser function.

TODO: Provide global --redo, -r option. Only overwrite files if this option is specified.

seedOpt :: Parser (Maybe [Word32]) Source #

Seed option for MWC. Defaults to RANDOM.

Options meta

megaReadM :: Parsec Void String a -> ReadM a Source #

See eitherReader, but for Megaparsec.

Formatting

fillParagraph :: String -> Doc Source #

Fill a string so that it becomes a paragraph with line breaks. Useful for descriptions, headers and footers.