Copyright	(c) 2021 Dominik Schrempf
License	GPL-3.0-or-later
Maintainer	dominik.schrempf@gmail.com
Stability	experimental
Portability	portable
Safe Haskell	None
Language	Haskell2010

ELynx.Tools.Options

Contents

Command options
Arguments
Misc

Description

Creation date: Thu Sep 2 19:17:07 2021.

Synopsis

seedOpt :: Parser SeedOpt
executionModeOpt :: Parser ExecutionMode
data GlobalArguments = GlobalArguments {
- verbosity :: Verbosity
- outFileBaseName :: Maybe FilePath
- executionMode :: ExecutionMode
- writeElynxFile :: Bool
}
data Arguments a = Arguments {
- global :: GlobalArguments
- local :: a
}
parseArguments :: forall a. Reproducible a => IO (Arguments a)
elynxParserInfo :: [String] -> [String] -> Parser a -> ParserInfo a
createCommandReproducible :: forall a b. Reproducible a => (a -> b) -> Mod CommandFields b
createCommand :: String -> [String] -> [String] -> Parser a -> (a -> b) -> Mod CommandFields b
elynxFooter :: [Doc]

Command options

seedOpt :: Parser SeedOpt Source #

Seed option for MWC. Defaults to Random.

executionModeOpt :: Parser ExecutionMode Source #

Execution mode option parser.

Arguments

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 :: Verbosity outFileBaseName :: Maybe FilePath executionMode :: ExecutionMode writeElynxFile :: Bool

Instances

Instances details

Eq GlobalArguments Source #
Instance details Defined in ELynx.Tools.Options Methods (==) :: GlobalArguments -> GlobalArguments -> Bool # (/=) :: GlobalArguments -> GlobalArguments -> Bool #
Show GlobalArguments Source #
Instance details Defined in ELynx.Tools.Options Methods showsPrec :: Int -> GlobalArguments -> ShowS # show :: GlobalArguments -> String # showList :: [GlobalArguments] -> ShowS #
Generic GlobalArguments Source #
Instance details Defined in ELynx.Tools.Options Associated Types type Rep GlobalArguments :: Type -> Type # Methods from :: GlobalArguments -> Rep GlobalArguments x # to :: Rep GlobalArguments x -> GlobalArguments #
ToJSON GlobalArguments Source #
Instance details Defined in ELynx.Tools.Options Methods toJSON :: GlobalArguments -> Value # toEncoding :: GlobalArguments -> Encoding # toJSONList :: [GlobalArguments] -> Value # toEncodingList :: [GlobalArguments] -> Encoding #
FromJSON GlobalArguments Source #
Instance details Defined in ELynx.Tools.Options Methods parseJSON :: Value -> Parser GlobalArguments # parseJSONList :: Value -> Parser [GlobalArguments] #
type Rep GlobalArguments Source #
Instance details Defined in ELynx.Tools.Options type Rep GlobalArguments = D1 ('MetaData "GlobalArguments" "ELynx.Tools.Options" "elynx-tools-0.6.1.0-AWjKNFEpQDhHVmYwSmmoU2" 'False) (C1 ('MetaCons "GlobalArguments" 'PrefixI 'True) ((S1 ('MetaSel ('Just "verbosity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Verbosity) :: S1 ('MetaSel ('Just "outFileBaseName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe FilePath))) :: (S1 ('MetaSel ('Just "executionMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ExecutionMode) :*: S1 ('MetaSel ('Just "writeElynxFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))))

data Arguments a Source #

Argument skeleton to be used with all commands.

Constructors

Arguments
Fields global :: GlobalArguments local :: a

Instances

Instances details

Eq a => Eq (Arguments a) Source #
Instance details Defined in ELynx.Tools.Options Methods (==) :: Arguments a -> Arguments a -> Bool # (/=) :: Arguments a -> Arguments a -> Bool #
Show a => Show (Arguments a) Source #
Instance details Defined in ELynx.Tools.Options Methods showsPrec :: Int -> Arguments a -> ShowS # show :: Arguments a -> String # showList :: [Arguments a] -> ShowS #
Generic (Arguments a) Source #
Instance details Defined in ELynx.Tools.Options Associated Types type Rep (Arguments a) :: Type -> Type # Methods from :: Arguments a -> Rep (Arguments a) x # to :: Rep (Arguments a) x -> Arguments a #
ToJSON a => ToJSON (Arguments a) Source #
Instance details Defined in ELynx.Tools.Options Methods toJSON :: Arguments a -> Value # toEncoding :: Arguments a -> Encoding # toJSONList :: [Arguments a] -> Value # toEncodingList :: [Arguments a] -> Encoding #
FromJSON a => FromJSON (Arguments a) Source #
Instance details Defined in ELynx.Tools.Options Methods parseJSON :: Value -> Parser (Arguments a) # parseJSONList :: Value -> Parser [Arguments a] #
Reproducible a => Reproducible (Arguments a) Source #
Instance details Defined in ELynx.Tools.Options Methods inFiles :: Arguments a -> [FilePath] Source # outSuffixes :: Arguments a -> [String] Source # getSeed :: Arguments a -> Maybe SeedOpt Source # setSeed :: Arguments a -> SeedOpt -> Arguments a Source # parser :: Parser (Arguments a) Source # cmdName :: String Source # cmdDsc :: [String] Source # cmdFtr :: [String] Source #
type Rep (Arguments a) Source #
Instance details Defined in ELynx.Tools.Options type Rep (Arguments a) = D1 ('MetaData "Arguments" "ELynx.Tools.Options" "elynx-tools-0.6.1.0-AWjKNFEpQDhHVmYwSmmoU2" 'False) (C1 ('MetaCons "Arguments" 'PrefixI 'True) (S1 ('MetaSel ('Just "global") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 GlobalArguments) :*: S1 ('MetaSel ('Just "local") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))

Misc

parseArguments :: forall a. Reproducible a => IO (Arguments 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.

elynxParserInfo :: [String] -> [String] -> Parser a -> ParserInfo a Source #

ELynx parser info; convenience function.

createCommandReproducible :: forall a b. Reproducible a => (a -> b) -> Mod CommandFields b Source #

Create a command; convenience function.

createCommand :: String -> [String] -> [String] -> Parser a -> (a -> b) -> Mod CommandFields b Source #

Create a command; convenience function.

elynxFooter :: [Doc] Source #

Global ELynx footer.