Safe Haskell	None
Language	Haskell2010

CmdLineParser

Description

Command-line parser

This is an abstract command-line parser used by DynFlags.

(c) The University of Glasgow 2005

Synopsis

processArgs :: Monad m => [Flag m] -> [Located String] -> m ([Located String], [Err], [Warn])
data OptKind m
- = NoArg (EwM m ())
- | HasArg (String -> EwM m ())
- | SepArg (String -> EwM m ())
- | Prefix (String -> EwM m ())
- | OptPrefix (String -> EwM m ())
- | OptIntSuffix (Maybe Int -> EwM m ())
- | IntSuffix (Int -> EwM m ())
- | FloatSuffix (Float -> EwM m ())
- | PassFlag (String -> EwM m ())
- | AnySuffix (String -> EwM m ())
- | PrefixPred (String -> Bool) (String -> EwM m ())
- | AnySuffixPred (String -> Bool) (String -> EwM m ())
data GhcFlagMode
- = OnlyGhc
- | OnlyGhci
- | AllModes
- | HiddenFlag
newtype CmdLineP s a = CmdLineP {
- runCmdLine :: s -> (a, s)
}
getCmdLineState :: CmdLineP s s
putCmdLineState :: s -> CmdLineP s ()
data Flag m = Flag {
- flagName :: String
- flagOptKind :: OptKind m
- flagGhcMode :: GhcFlagMode
}
defFlag :: String -> OptKind m -> Flag m
defGhcFlag :: String -> OptKind m -> Flag m
defGhciFlag :: String -> OptKind m -> Flag m
defHiddenFlag :: String -> OptKind m -> Flag m
errorsToGhcException :: [(String, String)] -> GhcException
newtype Err = Err {
- errMsg :: Located String
}
data Warn = Warn {
- warnReason :: WarnReason
- warnMsg :: Located String
}
data WarnReason
- = NoReason
- | ReasonDeprecatedFlag
- | ReasonUnrecognisedFlag
data EwM m a
runEwM :: EwM m a -> m (Errs, Warns, a)
addErr :: Monad m => String -> EwM m ()
addWarn :: Monad m => String -> EwM m ()
addFlagWarn :: Monad m => WarnReason -> String -> EwM m ()
getArg :: Monad m => EwM m String
getCurLoc :: Monad m => EwM m SrcSpan
liftEwM :: Monad m => m a -> EwM m a
deprecate :: Monad m => String -> EwM m ()

Documentation

processArgs :: Monad m => [Flag m] -> [Located String] -> m ([Located String], [Err], [Warn]) Source #

data OptKind m Source #

Constructors

NoArg (EwM m ())
HasArg (String -> EwM m ())
SepArg (String -> EwM m ())
Prefix (String -> EwM m ())
OptPrefix (String -> EwM m ())
OptIntSuffix (Maybe Int -> EwM m ())
IntSuffix (Int -> EwM m ())
FloatSuffix (Float -> EwM m ())
PassFlag (String -> EwM m ())
AnySuffix (String -> EwM m ())
PrefixPred (String -> Bool) (String -> EwM m ())
AnySuffixPred (String -> Bool) (String -> EwM m ())

data GhcFlagMode Source #

GHC flag modes describing when a flag has an effect.

Constructors

OnlyGhc	The flag only affects the non-interactive GHC
OnlyGhci	The flag only affects the interactive GHC
AllModes	The flag affects multiple ghc modes
HiddenFlag	This flag should not be seen in cli completion

newtype CmdLineP s a Source #

Constructors

CmdLineP
Fields runCmdLine :: s -> (a, s)

Instances

Monad (CmdLineP s) Source #
Instance details Methods (>>=) :: CmdLineP s a -> (a -> CmdLineP s b) -> CmdLineP s b # (>>) :: CmdLineP s a -> CmdLineP s b -> CmdLineP s b # return :: a -> CmdLineP s a # fail :: String -> CmdLineP s a #
Functor (CmdLineP s) Source #
Instance details Methods fmap :: (a -> b) -> CmdLineP s a -> CmdLineP s b # (<$) :: a -> CmdLineP s b -> CmdLineP s a #
Applicative (CmdLineP s) Source #
Instance details Methods pure :: a -> CmdLineP s a # (<>) :: CmdLineP s (a -> b) -> CmdLineP s a -> CmdLineP s b # liftA2 :: (a -> b -> c) -> CmdLineP s a -> CmdLineP s b -> CmdLineP s c # (>) :: CmdLineP s a -> CmdLineP s b -> CmdLineP s b # (<*) :: CmdLineP s a -> CmdLineP s b -> CmdLineP s a #

getCmdLineState :: CmdLineP s s Source #

putCmdLineState :: s -> CmdLineP s () Source #

data Flag m Source #

Constructors

Flag
Fields flagName :: String flagOptKind :: OptKind m flagGhcMode :: GhcFlagMode

defFlag :: String -> OptKind m -> Flag m Source #

defGhcFlag :: String -> OptKind m -> Flag m Source #

defGhciFlag :: String -> OptKind m -> Flag m Source #

defHiddenFlag :: String -> OptKind m -> Flag m Source #

errorsToGhcException :: [(String, String)] -> GhcException Source #

newtype Err Source #

A command-line error message

Constructors

Err
Fields errMsg :: Located String

data Warn Source #

A command-line warning message and the reason it arose

Constructors

Warn
Fields warnReason :: WarnReason warnMsg :: Located String

data WarnReason Source #

Used when filtering warnings: if a reason is given it can be filtered out when displaying.

Constructors

NoReason
ReasonDeprecatedFlag
ReasonUnrecognisedFlag

Instances

Eq WarnReason Source #
Instance details Methods (==) :: WarnReason -> WarnReason -> Bool # (/=) :: WarnReason -> WarnReason -> Bool #
Show WarnReason Source #
Instance details Methods showsPrec :: Int -> WarnReason -> ShowS # show :: WarnReason -> String # showList :: [WarnReason] -> ShowS #
Outputable WarnReason Source #
Instance details Methods ppr :: WarnReason -> SDoc Source # pprPrec :: Rational -> WarnReason -> SDoc Source #
ToJson WarnReason Source #
Instance details Methods json :: WarnReason -> JsonDoc Source #

data EwM m a Source #

Instances

Monad m => Monad (EwM m) Source #
Instance details Methods (>>=) :: EwM m a -> (a -> EwM m b) -> EwM m b # (>>) :: EwM m a -> EwM m b -> EwM m b # return :: a -> EwM m a # fail :: String -> EwM m a #
Monad m => Functor (EwM m) Source #
Instance details Methods fmap :: (a -> b) -> EwM m a -> EwM m b # (<$) :: a -> EwM m b -> EwM m a #
Monad m => Applicative (EwM m) Source #
Instance details Methods pure :: a -> EwM m a # (<>) :: EwM m (a -> b) -> EwM m a -> EwM m b # liftA2 :: (a -> b -> c) -> EwM m a -> EwM m b -> EwM m c # (>) :: EwM m a -> EwM m b -> EwM m b # (<*) :: EwM m a -> EwM m b -> EwM m a #

runEwM :: EwM m a -> m (Errs, Warns, a) Source #

addErr :: Monad m => String -> EwM m () Source #

addWarn :: Monad m => String -> EwM m () Source #

addFlagWarn :: Monad m => WarnReason -> String -> EwM m () Source #

getArg :: Monad m => EwM m String Source #

getCurLoc :: Monad m => EwM m SrcSpan Source #

liftEwM :: Monad m => m a -> EwM m a Source #

deprecate :: Monad m => String -> EwM m () Source #