compiler/main/CmdLineParser.hs

   1 -----------------------------------------------------------------------------
   2 --
   3 -- Command-line parser
   4 --
   5 -- This is an abstract command-line parser used by both StaticFlags and
   6 -- DynFlags.
   7 --
   8 -- (c) The University of Glasgow 2005
   9 --
  10 -----------------------------------------------------------------------------
  11
  12 module CmdLineParser (
  13         processArgs, OptKind(..),
  14         CmdLineP(..), getCmdLineState, putCmdLineState
  15   ) where
  16
  17 #include "HsVersions.h"
  18
  19 import Util     ( maybePrefixMatch, notNull, removeSpaces )
  20 #ifdef DEBUG
  21 import Panic    ( assertPanic )
  22 #endif
  23
  24 data OptKind m          -- Suppose the flag is -f
  25         = NoArg (m ())                  -- -f all by itself
  26         | HasArg    (String -> m ())    -- -farg or -f arg
  27         | SepArg    (String -> m ())    -- -f arg
  28         | Prefix    (String -> m ())    -- -farg
  29         | OptPrefix (String -> m ())    -- -f or -farg (i.e. the arg is optional)
  30         | OptIntSuffix (Maybe Int -> m ())      -- -f or -f=n; pass n to fn
  31         | IntSuffix (Int -> m ())               -- -f or -f=n; pass n to fn
  32         | PassFlag  (String -> m ())    -- -f; pass "-f" fn
  33         | AnySuffix (String -> m ())    -- -f or -farg; pass entire "-farg" to fn
  34         | PrefixPred    (String -> Bool) (String -> m ())
  35         | AnySuffixPred (String -> Bool) (String -> m ())
  36
  37 processArgs :: Monad m
  38             => [(String, OptKind m)]    -- cmdline parser spec
  39             -> [String]                 -- args
  40             -> m (
  41                 [String],  -- spare args
  42                 [String]   -- errors
  43                 )
  44 processArgs spec args = process spec args [] []
  45   where
  46     process _spec [] spare errs =
  47       return (reverse spare, reverse errs)
  48
  49     process spec (dash_arg@('-':arg):args) spare errs =
  50       case findArg spec arg of
  51         Just (rest,action) ->
  52            case processOneArg action rest arg args of
  53              Left err            -> process spec args spare (err:errs)
  54              Right (action,rest) -> action >> process spec rest spare errs
  55         Nothing -> process spec args (dash_arg:spare) errs
  56
  57     process spec (arg:args) spare errs =
  58       process spec args (arg:spare) errs
  59
  60
  61 processOneArg :: OptKind m -> String -> String -> [String]
  62               -> Either String (m (), [String])
  63 processOneArg action rest arg args
  64   = let dash_arg = '-' : arg
  65         rest_no_eq = dropEq rest
  66     in case action of
  67         NoArg  a -> ASSERT(null rest) Right (a, args)
  68
  69         HasArg f | notNull rest_no_eq -> Right (f rest_no_eq, args)
  70                  | otherwise    -> case args of
  71                                     [] -> missingArgErr dash_arg
  72                                     (arg1:args1) -> Right (f arg1, args1)
  73
  74         SepArg f -> case args of
  75                         [] -> unknownFlagErr dash_arg
  76                         (arg1:args1) -> Right (f arg1, args1)
  77
  78         Prefix f | notNull rest_no_eq -> Right (f rest_no_eq, args)
  79                  | otherwise  -> unknownFlagErr dash_arg
  80
  81         PrefixPred p f | notNull rest_no_eq -> Right (f rest_no_eq, args)
  82                        | otherwise          -> unknownFlagErr dash_arg
  83
  84         PassFlag f  | notNull rest -> unknownFlagErr dash_arg
  85                     | otherwise    -> Right (f dash_arg, args)
  86
  87         OptIntSuffix f | null rest                     -> Right (f Nothing,  args)
  88                        | Just n <- parseInt rest_no_eq -> Right (f (Just n), args)
  89                        | otherwise -> Left ("malformed integer argument in " ++ dash_arg)
  90
  91         IntSuffix f | Just n <- parseInt rest_no_eq -> Right (f n, args)
  92                     | otherwise -> Left ("malformed integer argument in " ++ dash_arg)
  93
  94         OptPrefix f       -> Right (f rest_no_eq, args)
  95         AnySuffix f       -> Right (f dash_arg, args)
  96         AnySuffixPred p f -> Right (f dash_arg, args)
  97
  98
  99 findArg :: [(String,OptKind a)] -> String -> Maybe (String,OptKind a)
 100 findArg spec arg
 101   = case [ (removeSpaces rest, k)
 102          | (pat,k)   <- spec,
 103            Just rest <- [maybePrefixMatch pat arg],
 104            arg_ok k rest arg ]
 105     of
 106         []      -> Nothing
 107         (one:_) -> Just one
 108
 109 arg_ok (NoArg _)            rest arg = null rest
 110 arg_ok (HasArg _)           rest arg = True
 111 arg_ok (SepArg _)           rest arg = null rest
 112 arg_ok (Prefix _)           rest arg = notNull rest
 113 arg_ok (PrefixPred p _)     rest arg = notNull rest && p (dropEq rest)
 114 arg_ok (OptIntSuffix _)     rest arg = True
 115 arg_ok (IntSuffix _)        rest arg = True
 116 arg_ok (OptPrefix _)        rest arg = True
 117 arg_ok (PassFlag _)         rest arg = null rest
 118 arg_ok (AnySuffix _)        rest arg = True
 119 arg_ok (AnySuffixPred p _)  rest arg = p arg
 120
 121 parseInt :: String -> Maybe Int
 122 -- Looks for "433" or "=342", with no trailing gubbins
 123 --   n or =n      => Just n
 124 --   gibberish    => Nothing
 125 parseInt s = case reads s of
 126                 ((n,""):_) -> Just n
 127                 other      -> Nothing
 128
 129 dropEq :: String -> String
 130 -- Discards a leading equals sign
 131 dropEq ('=' : s) = s
 132 dropEq s         = s
 133
 134 unknownFlagErr :: String -> Either String a
 135 unknownFlagErr f = Left ("unrecognised flag: " ++ f)
 136
 137 missingArgErr :: String -> Either String a
 138 missingArgErr f = Left ("missing argument for flag: " ++ f)
 139
 140 -- -----------------------------------------------------------------------------
 141 -- A state monad for use in the command-line parser
 142
 143 newtype CmdLineP s a = CmdLineP { runCmdLine :: s -> (a, s) }
 144
 145 instance Monad (CmdLineP s) where
 146         return a = CmdLineP $ \s -> (a, s)
 147         m >>= k  = CmdLineP $ \s -> let
 148                 (a, s') = runCmdLine m s
 149                 in runCmdLine (k a) s'
 150
 151 getCmdLineState   = CmdLineP $ \s -> (s,s)
 152 putCmdLineState s = CmdLineP $ \_ -> ((),s)