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

SLynx.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

Eq a => Eq (Arguments a)
Instance details Defined in ELynx.Tools.Reproduction Methods (==) :: Arguments a -> Arguments a -> Bool # (/=) :: Arguments a -> Arguments a -> Bool #
Show a => Show (Arguments a)
Instance details Defined in ELynx.Tools.Reproduction Methods showsPrec :: Int -> Arguments a -> ShowS # show :: Arguments a -> String # showList :: [Arguments a] -> ShowS #
Generic (Arguments a)
Instance details Defined in ELynx.Tools.Reproduction 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.Reproduction 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.Reproduction Methods parseJSON :: Value -> Parser (Arguments a) # parseJSONList :: Value -> Parser [Arguments a] #
Reproducible a => Reproducible (Arguments a)
Instance details Defined in ELynx.Tools.Reproduction Methods inFiles :: Arguments a -> [FilePath] # outSuffixes :: Arguments a -> [String] # getSeed :: Arguments a -> Maybe Seed # setSeed :: Arguments a -> Vector Word32 -> Arguments a # parser :: Parser (Arguments a) # cmdName :: String # cmdDsc :: [String] # cmdFtr :: [String] #
type Rep (Arguments a)
Instance details Defined in ELynx.Tools.Reproduction type Rep (Arguments a) = D1 (MetaData "Arguments" "ELynx.Tools.Reproduction" "elynx-tools-0.3.3-4ptdTgzOXMa3REnciE49Sc" 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 SLynx commands and their arguments.

Constructors

Concatenate ConcatenateArguments
Examine ExamineArguments
FilterCols FilterColsArguments
FilterRows FilterRowsArguments
Simulate SimulateArguments
SubSample SubSampleArguments
Translate TranslateArguments

Instances

Eq CommandArguments Source #
Instance details Defined in SLynx.Options Methods (==) :: CommandArguments -> CommandArguments -> Bool # (/=) :: CommandArguments -> CommandArguments -> Bool #
Show CommandArguments Source #
Instance details Defined in SLynx.Options Methods showsPrec :: Int -> CommandArguments -> ShowS # show :: CommandArguments -> String # showList :: [CommandArguments] -> ShowS #
Generic CommandArguments Source #
Instance details Defined in SLynx.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 SLynx.Options Methods toJSON :: CommandArguments -> Value # toEncoding :: CommandArguments -> Encoding # toJSONList :: [CommandArguments] -> Value # toEncodingList :: [CommandArguments] -> Encoding #
FromJSON CommandArguments Source #
Instance details Defined in SLynx.Options Methods parseJSON :: Value -> Parser CommandArguments # parseJSONList :: Value -> Parser [CommandArguments] #
Reproducible CommandArguments Source #
Instance details Defined in SLynx.Options Methods inFiles :: CommandArguments -> [FilePath] # outSuffixes :: CommandArguments -> [String] # getSeed :: CommandArguments -> Maybe Seed # setSeed :: CommandArguments -> Vector Word32 -> CommandArguments # parser :: Parser CommandArguments # cmdName :: String # cmdDsc :: [String] # cmdFtr :: [String] #
type Rep CommandArguments Source #
Instance details Defined in SLynx.Options type Rep CommandArguments = D1 (MetaData "CommandArguments" "SLynx.Options" "slynx-0.3.3-KRurgEU1UnyHreJmBktMto" False) ((C1 (MetaCons "Concatenate" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ConcatenateArguments)) :+: (C1 (MetaCons "Examine" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ExamineArguments)) :+: C1 (MetaCons "FilterCols" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilterColsArguments)))) :+: ((C1 (MetaCons "FilterRows" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilterRowsArguments)) :+: C1 (MetaCons "Simulate" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 SimulateArguments))) :+: (C1 (MetaCons "SubSample" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 SubSampleArguments)) :+: C1 (MetaCons "Translate" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TranslateArguments)))))

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.