c6d07ce027a02d296528a4f2d378064274746ce9
[ghc.git] / 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     (
14       processArgs, OptKind(..),
15       CmdLineP(..), getCmdLineState, putCmdLineState,
16       Flag(..),
17       errorsToGhcException,
18
19       EwM, addErr, addWarn, getArg, getCurLoc, liftEwM, deprecate
20     ) where
21
22 #include "HsVersions.h"
23
24 import Util
25 import Outputable
26 import Panic
27 import Bag
28 import SrcLoc
29
30 import Data.List
31
32
33 --------------------------------------------------------
34 --         The Flag and OptKind types
35 --------------------------------------------------------
36
37 data Flag m = Flag
38     {   flagName    :: String,   -- Flag, without the leading "-"
39         flagOptKind :: OptKind m -- What to do if we see it
40     }
41
42 data OptKind m                             -- Suppose the flag is -f
43     = NoArg     (EwM m ())                 -- -f all by itself
44     | HasArg    (String -> EwM m ())       -- -farg or -f arg
45     | SepArg    (String -> EwM m ())       -- -f arg
46     | Prefix    (String -> EwM m ())       -- -farg
47     | OptPrefix (String -> EwM m ())       -- -f or -farg (i.e. the arg is optional)
48     | OptIntSuffix (Maybe Int -> EwM m ()) -- -f or -f=n; pass n to fn
49     | IntSuffix (Int -> EwM m ())          -- -f or -f=n; pass n to fn
50     | PassFlag  (String -> EwM m ())       -- -f; pass "-f" fn
51     | AnySuffix (String -> EwM m ())       -- -f or -farg; pass entire "-farg" to fn
52     | PrefixPred    (String -> Bool) (String -> EwM m ())
53     | AnySuffixPred (String -> Bool) (String -> EwM m ())
54
55
56 --------------------------------------------------------
57 --         The EwM monad
58 --------------------------------------------------------
59
60 type Err   = Located String
61 type Warn  = Located String
62 type Errs  = Bag Err
63 type Warns = Bag Warn
64
65 -- EwM ("errors and warnings monad") is a monad
66 -- transformer for m that adds an (err, warn) state
67 newtype EwM m a = EwM { unEwM :: Located String -- Current parse arg
68                               -> Errs -> Warns
69                               -> m (Errs, Warns, a) }
70
71 instance Monad m => Monad (EwM m) where
72     (EwM f) >>= k = EwM (\l e w -> do (e', w', r) <- f l e w
73                                       unEwM (k r) l e' w')
74     return v = EwM (\_ e w -> return (e, w, v))
75
76 setArg :: Monad m => Located String -> EwM m () -> EwM m ()
77 setArg l (EwM f) = EwM (\_ es ws -> f l es ws)
78
79 addErr :: Monad m => String -> EwM m ()
80 addErr e = EwM (\(L loc _) es ws -> return (es `snocBag` L loc e, ws, ()))
81
82 addWarn :: Monad m => String -> EwM m ()
83 addWarn msg = EwM (\(L loc _) es ws -> return (es, ws `snocBag` L loc msg, ()))
84
85 deprecate :: Monad m => String -> EwM m ()
86 deprecate s = do
87     arg <- getArg
88     addWarn (arg ++ " is deprecated: " ++ s)
89
90 getArg :: Monad m => EwM m String
91 getArg = EwM (\(L _ arg) es ws -> return (es, ws, arg))
92
93 getCurLoc :: Monad m => EwM m SrcSpan
94 getCurLoc = EwM (\(L loc _) es ws -> return (es, ws, loc))
95
96 liftEwM :: Monad m => m a -> EwM m a
97 liftEwM action = EwM (\_ es ws -> do { r <- action; return (es, ws, r) })
98
99
100 --------------------------------------------------------
101 -- A state monad for use in the command-line parser
102 --------------------------------------------------------
103
104 -- (CmdLineP s) typically instantiates the 'm' in (EwM m) and (OptKind m)
105 newtype CmdLineP s a = CmdLineP { runCmdLine :: s -> (a, s) }
106
107 instance Monad (CmdLineP s) where
108     m >>= k = CmdLineP $ \s ->
109                   let (a, s') = runCmdLine m s
110                   in runCmdLine (k a) s'
111
112     return a = CmdLineP $ \s -> (a, s)
113
114 getCmdLineState :: CmdLineP s s
115 getCmdLineState   = CmdLineP $ \s -> (s,s)
116 putCmdLineState :: s -> CmdLineP s ()
117 putCmdLineState s = CmdLineP $ \_ -> ((),s)
118
119
120 --------------------------------------------------------
121 --         Processing arguments
122 --------------------------------------------------------
123
124 processArgs :: Monad m
125             => [Flag m]               -- cmdline parser spec
126             -> [Located String]       -- args
127             -> m ( [Located String],  -- spare args
128                    [Located String],  -- errors
129                    [Located String] ) -- warnings
130 processArgs spec args = do
131     (errs, warns, spare) <- unEwM action (panic "processArgs: no arg yet")
132                                   emptyBag emptyBag
133     return (spare, bagToList errs, bagToList warns)
134   where
135     action = process args []
136
137     -- process :: [Located String] -> [Located String] -> EwM m [Located String]
138     process [] spare = return (reverse spare)
139
140     process (locArg@(L _ ('-' : arg)) : args) spare =
141         case findArg spec arg of
142             Just (rest, opt_kind) ->
143                 case processOneArg opt_kind rest arg args of
144                     Left err ->
145                         let b = process args spare
146                         in (setArg locArg $ addErr err) >> b
147
148                     Right (action,rest) ->
149                         let b = process rest spare
150                         in (setArg locArg $ action) >> b
151
152             Nothing -> process args (locArg : spare)
153
154     process (arg : args) spare = process args (arg : spare)
155
156
157 processOneArg :: OptKind m -> String -> String -> [Located String]
158               -> Either String (EwM m (), [Located String])
159 processOneArg opt_kind rest arg args
160   = let dash_arg = '-' : arg
161         rest_no_eq = dropEq rest
162     in case opt_kind of
163         NoArg  a -> ASSERT(null rest) Right (a, args)
164
165         HasArg f | notNull rest_no_eq -> Right (f rest_no_eq, args)
166                  | otherwise -> case args of
167                                     []               -> missingArgErr dash_arg
168                                     (L _ arg1:args1) -> Right (f arg1, args1)
169
170         SepArg f -> case args of
171                         []               -> unknownFlagErr dash_arg
172                         (L _ arg1:args1) -> Right (f arg1, args1)
173
174         Prefix f | notNull rest_no_eq -> Right (f rest_no_eq, args)
175                  | otherwise          -> unknownFlagErr dash_arg
176
177         PrefixPred _ f | notNull rest_no_eq -> Right (f rest_no_eq, args)
178                        | otherwise          -> unknownFlagErr dash_arg
179
180         PassFlag f  | notNull rest -> unknownFlagErr dash_arg
181                     | otherwise    -> Right (f dash_arg, args)
182
183         OptIntSuffix f | null rest                     -> Right (f Nothing,  args)
184                        | Just n <- parseInt rest_no_eq -> Right (f (Just n), args)
185                        | otherwise -> Left ("malformed integer argument in " ++ dash_arg)
186
187         IntSuffix f | Just n <- parseInt rest_no_eq -> Right (f n, args)
188                     | otherwise -> Left ("malformed integer argument in " ++ dash_arg)
189
190         OptPrefix f       -> Right (f rest_no_eq, args)
191         AnySuffix f       -> Right (f dash_arg, args)
192         AnySuffixPred _ f -> Right (f dash_arg, args)
193
194
195 findArg :: [Flag m] -> String -> Maybe (String, OptKind m)
196 findArg spec arg =
197     case [ (removeSpaces rest, optKind)
198          | flag <- spec,
199            let optKind  = flagOptKind flag,
200            Just rest <- [stripPrefix (flagName flag) arg],
201            arg_ok optKind rest arg ]
202     of
203         []      -> Nothing
204         (one:_) -> Just one
205
206 arg_ok :: OptKind t -> [Char] -> String -> Bool
207 arg_ok (NoArg           _)  rest _   = null rest
208 arg_ok (HasArg          _)  _    _   = True
209 arg_ok (SepArg          _)  rest _   = null rest
210 arg_ok (Prefix          _)  rest _   = notNull rest
211 arg_ok (PrefixPred p    _)  rest _   = notNull rest && p (dropEq rest)
212 arg_ok (OptIntSuffix    _)  _    _   = True
213 arg_ok (IntSuffix       _)  _    _   = True
214 arg_ok (OptPrefix       _)  _    _   = True
215 arg_ok (PassFlag        _)  rest _   = null rest
216 arg_ok (AnySuffix       _)  _    _   = True
217 arg_ok (AnySuffixPred p _)  _    arg = p arg
218
219 -- | Parse an Int
220 --
221 -- Looks for "433" or "=342", with no trailing gubbins
222 --   * n or =n      => Just n
223 --   * gibberish    => Nothing
224 parseInt :: String -> Maybe Int
225 parseInt s = case reads s of
226                  ((n,""):_) -> Just n
227                  _          -> Nothing
228
229 -- | Discards a leading equals sign
230 dropEq :: String -> String
231 dropEq ('=' : s) = s
232 dropEq s         = s
233
234 unknownFlagErr :: String -> Either String a
235 unknownFlagErr f = Left ("unrecognised flag: " ++ f)
236
237 missingArgErr :: String -> Either String a
238 missingArgErr f = Left ("missing argument for flag: " ++ f)
239
240 --------------------------------------------------------
241 -- Utils
242 --------------------------------------------------------
243
244 errorsToGhcException :: [Located String] -> GhcException
245 errorsToGhcException errs =
246     UsageError $
247         intercalate "\n" [ showUserSpan True l ++ ": " ++ e | L l e <- errs ]
248