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

TLynx.Options

Description

Creation date: Sat Sep 7 18:55:03 2019.

Synopsis

data Arguments a = Arguments {
- global :: GlobalArguments
- local :: a
}
data CommandArguments
parseArguments :: Reproducible a => IO (Arguments a)

Documentation

data Arguments a #

Argument skeleton to be used with all commands.

Constructors

Arguments
Fields global :: GlobalArguments local :: a

Instances

Instances details

Eq a => Eq (Arguments a)
Instance details Defined in ELynx.Tools.Options Methods (==) :: Arguments a -> Arguments a -> Bool # (/=) :: Arguments a -> Arguments a -> Bool #
Show a => Show (Arguments a)
Instance details Defined in ELynx.Tools.Options Methods showsPrec :: Int -> Arguments a -> ShowS # show :: Arguments a -> String # showList :: [Arguments a] -> ShowS #
Generic (Arguments a)
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)
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)
Instance details Defined in ELynx.Tools.Options Methods parseJSON :: Value -> Parser (Arguments a) # parseJSONList :: Value -> Parser [Arguments a] #
Reproducible a => Reproducible (Arguments a)
Instance details Defined in ELynx.Tools.Options Methods inFiles :: Arguments a -> [FilePath] # outSuffixes :: Arguments a -> [String] # getSeed :: Arguments a -> Maybe SeedOpt # setSeed :: Arguments a -> SeedOpt -> Arguments a # parser :: Parser (Arguments a) # cmdName :: String # cmdDsc :: [String] # cmdFtr :: [String] #
type Rep (Arguments a)
Instance details Defined in ELynx.Tools.Options type Rep (Arguments a) = D1 ('MetaData "Arguments" "ELynx.Tools.Options" "elynx-tools-0.6.0.0-C9yWy4KiDAwCuzNwLVWAR7" 'False) (C1 ('MetaCons "Arguments" 'PrefixI 'True) (S1 ('MetaSel ('Just "global") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 GlobalArguments) :*: S1 ('MetaSel ('Just "local") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 a)))

data CommandArguments Source #

The different TLynx commands and their arguments.

Constructors

Compare CompareArguments
Connect ConnectArguments
Distance DistanceArguments
Examine ExamineArguments
Shuffle ShuffleArguments
Simulate SimulateArguments

Instances

Instances details

Eq CommandArguments Source #
Instance details Defined in TLynx.Options Methods (==) :: CommandArguments -> CommandArguments -> Bool # (/=) :: CommandArguments -> CommandArguments -> Bool #
Show CommandArguments Source #
Instance details Defined in TLynx.Options Methods showsPrec :: Int -> CommandArguments -> ShowS # show :: CommandArguments -> String # showList :: [CommandArguments] -> ShowS #
Generic CommandArguments Source #
Instance details Defined in TLynx.Options Associated Types type Rep CommandArguments :: Type -> Type # Methods from :: CommandArguments -> Rep CommandArguments x # to :: Rep CommandArguments x -> CommandArguments #
ToJSON CommandArguments Source #
Instance details Defined in TLynx.Options Methods toJSON :: CommandArguments -> Value # toEncoding :: CommandArguments -> Encoding # toJSONList :: [CommandArguments] -> Value # toEncodingList :: [CommandArguments] -> Encoding #
FromJSON CommandArguments Source #
Instance details Defined in TLynx.Options Methods parseJSON :: Value -> Parser CommandArguments # parseJSONList :: Value -> Parser [CommandArguments] #
Reproducible CommandArguments Source #
Instance details Defined in TLynx.Options Methods inFiles :: CommandArguments -> [FilePath] # outSuffixes :: CommandArguments -> [String] # getSeed :: CommandArguments -> Maybe SeedOpt # setSeed :: CommandArguments -> SeedOpt -> CommandArguments # parser :: Parser CommandArguments # cmdName :: String # cmdDsc :: [String] # cmdFtr :: [String] #
type Rep CommandArguments Source #
Instance details Defined in TLynx.Options type Rep CommandArguments = D1 ('MetaData "CommandArguments" "TLynx.Options" "tlynx-0.6.0.0-HofljkDb0GQAc1uqX5sBHh" 'False) ((C1 ('MetaCons "Compare" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CompareArguments)) :+: (C1 ('MetaCons "Connect" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ConnectArguments)) :+: C1 ('MetaCons "Distance" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DistanceArguments)))) :+: (C1 ('MetaCons "Examine" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ExamineArguments)) :+: (C1 ('MetaCons "Shuffle" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ShuffleArguments)) :+: C1 ('MetaCons "Simulate" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SimulateArguments)))))

parseArguments :: Reproducible a => IO (Arguments a) #

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.