| 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
- 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 {}
- data Warn = Warn {}
- data WarnReason
- 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 #
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 |
Constructors
| CmdLineP | |
Fields
| |
Instances
| Monad (CmdLineP s) # | |
| Functor (CmdLineP s) # | |
| Applicative (CmdLineP s) # | |
Defined in CmdLineParser Methods pure :: a -> CmdLineP s a Source # (<*>) :: CmdLineP s (a -> b) -> CmdLineP s a -> CmdLineP s b Source # liftA2 :: (a -> b -> c) -> CmdLineP s a -> CmdLineP s b -> CmdLineP s c Source # (*>) :: CmdLineP s a -> CmdLineP s b -> CmdLineP s b Source # (<*) :: CmdLineP s a -> CmdLineP s b -> CmdLineP s a Source # | |
getCmdLineState :: CmdLineP s s Source #
putCmdLineState :: s -> CmdLineP s () Source #
Constructors
| Flag | |
Fields
| |
errorsToGhcException :: [(String, String)] -> GhcException Source #
A command-line warning message and the reason it arose
Constructors
| Warn | |
Fields
| |
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 # | |
Defined in CmdLineParser | |
| Show WarnReason # | |
Defined in CmdLineParser | |
| Outputable WarnReason # | |
Defined in CmdLineParser | |
| ToJson WarnReason # | |
Defined in CmdLineParser Methods json :: WarnReason -> JsonDoc Source # | |
addFlagWarn :: Monad m => WarnReason -> String -> EwM m () Source #