Data.Registry.Options.Lexemes

This module parses strings coming from the command line and tries to classify them as:

• option names + their associated values
• flag names
• arguments

It is however not always possible to know if a given list of string is:

• an option name + some values: find --files file1 file2
• a flag name + some arguments: copy --force source target

During lexing we leave this last case as "ambiguous". This will be disambiguated during parsing where we know if a given name is an option or a flag.

Documentation

data Lexemes

This data type helps pre-parsing option names and values

Constructors

Lexemes

Fields

• lexedOptions :: MultiMap Text Text

  list of option names and associated values

• lexedFlags :: [Text]

  list of flag names

• lexedArguments :: [Text]

  list of argument values

• lexedAmbiguous :: Maybe (Text, [Text])

  possible ambiguous case: option + values or flag + arguments

Instances

Monoid Lexemes

Defined in Data.Registry.Options.Lexemes

Methods

mempty :: Lexemes

mappend :: Lexemes -> Lexemes -> Lexemes

mconcat :: [Lexemes] -> Lexemes

Semigroup Lexemes

Defined in Data.Registry.Options.Lexemes

Methods

(<>) :: Lexemes -> Lexemes -> Lexemes

sconcat :: NonEmpty Lexemes -> Lexemes

stimes :: Integral b => b -> Lexemes -> Lexemes

Show Lexemes

Defined in Data.Registry.Options.Lexemes

Methods

showsPrec :: Int -> Lexemes -> ShowS

show :: Lexemes -> String

showList :: [Lexemes] -> ShowS

Eq Lexemes

Defined in Data.Registry.Options.Lexemes

Methods

(==) :: Lexemes -> Lexemes -> Bool

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

union :: Lexemes -> Lexemes -> Lexemes

Concatenate 2 lists of lexemes

override :: Lexemes -> Lexemes -> Lexemes

Override the values from one Lexemes with the values from another This is a bit tricky since ambiguous option/flags coming from the command can eventually be detected to be valid options / flags when parsed as such in the environment or in a config file

Create lexemes

lexArgs :: [Text] -> Lexemes

Lex some input arguments They are first stripped of additional whitespace and empty strings are removed (there shouldn't be any though, coming from the command line)

mkLexemes :: [Text] -> Lexemes

Lex some input arguments

optionLexemes :: Text -> Text -> Lexemes

Create lexemes for an option name + an option value

optionsLexemes :: Text -> [Text] -> Lexemes

Create lexemes for an option name + a list of option values

makeEqualOptionLexeme :: Text -> Lexemes

Create an option for --option=value or -o=value Return mempty if no equal sign is present

makeFlagsLexeme :: Text -> Lexemes

Create lexemes for a list of potentially short flag names e.g. makeFlagsLexeme "-opq" === flagsLexemes ["o", "p", "q"]

flagLexemes :: Text -> Lexemes

Create lexemes for a flag name

flagsLexemes :: [Text] -> Lexemes

Create lexemes for a list of flag names

argLexemes :: Text -> Lexemes

Create lexemes for an argument value

argsLexemes :: [Text] -> Lexemes

Create lexemes for several arguments

ambiguousLexemes :: Text -> [Text] -> Lexemes

Create lexemes an ambiguous flag an its values Later parsing will indicate if the name is an option names and the values the option values or if this is a flag + arguments

getArguments :: Lexemes -> [Text]

Return the possible list of argument values to parse from Note that there can be ambiguous flags

getFlagNames :: Lexemes -> [Text]

Return option/flag names from lexed values

getValue :: Text -> Lexemes -> Maybe (Maybe Text)

Return a value for a given name This can be a value associated to a given option or just a flag name acting as a value to decode (the value can also come from an ambiguous option value)

popOptionValue :: Text -> Lexemes -> Lexemes

Remove the value associated to an option name The value might be: - associated to an option name - the name of a flag - associated to an ambiguous flag name

popArgumentValue :: Lexemes -> Lexemes

Remove an argument value first from the list of arguments if there are some` otherwise remove a value in the list of values associated to an ambiguous flag

popFlag :: Text -> Lexemes -> Lexemes

Remove a flag If the flag is actually an ambiguous flag with some associated values then this means that those values were arguments and need to be treated as such

isDashed :: Text -> Bool

Return True if some text starts with -

isSingleDashed :: Text -> Bool

Return True if some text starts with - but not with `--`

dropDashed :: Text -> Text

Drop dashes in front of a flag name

MultiMap functions

pop :: Ord k => k -> MultiMap k v -> MultiMap k v

Drop the first value associated to a key in the map If a key has no more values drop the key

Orphan instances

(Show k, Show v) => Show (MultiMap k v)

Methods

showsPrec :: Int -> MultiMap k v -> ShowS

show :: MultiMap k v -> String

showList :: [MultiMap k v] -> ShowS

(Eq k, Eq v) => Eq (MultiMap k v)

Methods

(==) :: MultiMap k v -> MultiMap k v -> Bool

(/=) :: MultiMap k v -> MultiMap k v -> Bool