1 -----------------------------------------------------------------------------
2 -- $Id: DriverFlags.hs,v 1.14 2000/10/31 17:30:17 simonpj Exp $
6 -- (c) Simon Marlow 2000
8 -----------------------------------------------------------------------------
10 module DriverFlags where
12 #include "HsVersions.h"
14 import PackageMaintenance
17 import TmpFiles ( v_TmpDir )
29 -----------------------------------------------------------------------------
32 -- Flag parsing is now done in stages:
34 -- * parse the initial list of flags and remove any flags understood
35 -- by the driver only. Determine whether we're in multi-compilation
36 -- or single-compilation mode.
38 -- * gather the list of "static" hsc flags, and assign them to the global
39 -- static hsc flags variable.
41 -- * build the inital DynFlags from the remaining flags.
43 -- * complain if we've got any flags left over.
45 -- * for each source file: grab the OPTIONS, and build a new DynFlags
46 -- to pass to the compiler.
48 -----------------------------------------------------------------------------
49 -- Process command-line
52 = NoArg (IO ()) -- flag with no argument
53 | HasArg (String -> IO ()) -- flag has an argument (maybe prefix)
54 | SepArg (String -> IO ()) -- flag has a separate argument
55 | Prefix (String -> IO ()) -- flag is a prefix only
56 | OptPrefix (String -> IO ()) -- flag may be a prefix
57 | AnySuffix (String -> IO ()) -- flag is a prefix, pass whole arg to fn
58 | PassFlag (String -> IO ()) -- flag with no arg, pass flag to fn
59 | PrefixPred (String -> Bool) (String -> IO ())
60 | AnySuffixPred (String -> Bool) (String -> IO ())
62 processArgs :: [(String,OptKind)] -> [String] -> [String]
63 -> IO [String] -- returns spare args
64 processArgs _spec [] spare = return (reverse spare)
65 processArgs spec args@(('-':arg):args') spare = do
66 case findArg spec arg of
68 do args' <- processOneArg action rest args
69 processArgs spec args' spare
71 processArgs spec args' (('-':arg):spare)
72 processArgs spec (arg:args) spare =
73 processArgs spec args (arg:spare)
75 processOneArg :: OptKind -> String -> [String] -> IO [String]
76 processOneArg action rest (dash_arg@('-':arg):args) =
80 then io >> return args
81 else unknownFlagErr dash_arg
85 then fio rest >> return args
87 [] -> unknownFlagErr dash_arg
88 (arg1:args1) -> fio arg1 >> return args1
92 [] -> unknownFlagErr dash_arg
93 (arg1:args1) -> fio arg1 >> return args1
97 then fio rest >> return args
98 else unknownFlagErr dash_arg
102 then fio rest >> return args
103 else unknownFlagErr dash_arg
105 OptPrefix fio -> fio rest >> return args
107 AnySuffix fio -> fio dash_arg >> return args
109 AnySuffixPred p fio -> fio dash_arg >> return args
113 then unknownFlagErr dash_arg
114 else fio dash_arg >> return args
116 findArg :: [(String,OptKind)] -> String -> Maybe (String,OptKind)
118 = case [ (remove_spaces rest, k)
119 | (pat,k) <- spec, Just rest <- [my_prefix_match pat arg],
125 arg_ok (NoArg _) rest arg = null rest
126 arg_ok (HasArg _) rest arg = True
127 arg_ok (SepArg _) rest arg = null rest
128 arg_ok (Prefix _) rest arg = not (null rest)
129 arg_ok (PrefixPred p _) rest arg = not (null rest) && p rest
130 arg_ok (OptPrefix _) rest arg = True
131 arg_ok (PassFlag _) rest arg = null rest
132 arg_ok (AnySuffix _) rest arg = not (null rest)
133 arg_ok (AnySuffixPred p _) rest arg = not (null rest) && p arg
135 -----------------------------------------------------------------------------
138 -- note that ordering is important in the following list: any flag which
139 -- is a prefix flag (i.e. HasArg, Prefix, OptPrefix, AnySuffix) will override
140 -- flags further down the list with the same prefix.
143 [ ------- help -------------------------------------------------------
144 ( "?" , NoArg long_usage)
145 , ( "-help" , NoArg long_usage)
148 ------- version ----------------------------------------------------
149 , ( "-version" , NoArg (do hPutStrLn stdout (cProjectName
150 ++ ", version " ++ version_str)
151 exitWith ExitSuccess))
152 , ( "-numeric-version", NoArg (do hPutStrLn stdout version_str
153 exitWith ExitSuccess))
155 ------- verbosity ----------------------------------------------------
156 , ( "v" , NoArg (writeIORef v_Verbose True) )
157 , ( "n" , NoArg (writeIORef v_Dry_run True) )
159 ------- recompilation checker --------------------------------------
160 , ( "recomp" , NoArg (writeIORef v_Recomp True) )
161 , ( "no-recomp" , NoArg (writeIORef v_Recomp False) )
163 ------- ways --------------------------------------------------------
164 , ( "prof" , NoArg (addNoDups v_Ways WayProf) )
165 , ( "unreg" , NoArg (addNoDups v_Ways WayUnreg) )
166 , ( "dll" , NoArg (addNoDups v_Ways WayDll) )
167 , ( "ticky" , NoArg (addNoDups v_Ways WayTicky) )
168 , ( "parallel" , NoArg (addNoDups v_Ways WayPar) )
169 , ( "gransim" , NoArg (addNoDups v_Ways WayGran) )
170 , ( "smp" , NoArg (addNoDups v_Ways WaySMP) )
171 , ( "debug" , NoArg (addNoDups v_Ways WayDebug) )
174 ------ Debugging ----------------------------------------------------
175 , ( "dppr-noprags", PassFlag (add v_Opt_C) )
176 , ( "dppr-debug", PassFlag (add v_Opt_C) )
177 , ( "dppr-user-length", AnySuffix (add v_Opt_C) )
178 -- rest of the debugging flags are dynamic
180 ------- Interface files ---------------------------------------------
181 , ( "hi" , NoArg (writeIORef v_ProduceHi True) )
182 , ( "nohi" , NoArg (writeIORef v_ProduceHi False) )
184 --------- Profiling --------------------------------------------------
185 , ( "auto-dicts" , NoArg (add v_Opt_C "-fauto-sccs-on-dicts") )
186 , ( "auto-all" , NoArg (add v_Opt_C "-fauto-sccs-on-all-toplevs") )
187 , ( "auto" , NoArg (add v_Opt_C "-fauto-sccs-on-exported-toplevs") )
188 , ( "caf-all" , NoArg (add v_Opt_C "-fauto-sccs-on-individual-cafs") )
189 -- "ignore-sccs" doesn't work (ToDo)
191 , ( "no-auto-dicts" , NoArg (add v_Anti_opt_C "-fauto-sccs-on-dicts") )
192 , ( "no-auto-all" , NoArg (add v_Anti_opt_C "-fauto-sccs-on-all-toplevs") )
193 , ( "no-auto" , NoArg (add v_Anti_opt_C "-fauto-sccs-on-exported-toplevs") )
194 , ( "no-caf-all" , NoArg (add v_Anti_opt_C "-fauto-sccs-on-individual-cafs") )
196 ------- Miscellaneous -----------------------------------------------
197 , ( "no-link-chk" , NoArg (return ()) ) -- ignored for backwards compat
199 ------- Output Redirection ------------------------------------------
200 , ( "odir" , HasArg (writeIORef v_Output_dir . Just) )
201 , ( "o" , SepArg (writeIORef v_Output_file . Just) )
202 , ( "osuf" , HasArg (writeIORef v_Output_suf . Just) )
203 , ( "hisuf" , HasArg (writeIORef v_Hi_suf) )
204 , ( "tmpdir" , HasArg (writeIORef v_TmpDir . (++ "/")) )
205 , ( "ohi" , HasArg (\s -> case s of
206 "-" -> writeIORef v_Hi_on_stdout True
207 _ -> writeIORef v_Output_hi (Just s)) )
210 , ( "keep-hc-file" , AnySuffix (\_ -> writeIORef v_Keep_hc_files True) )
211 , ( "keep-s-file" , AnySuffix (\_ -> writeIORef v_Keep_s_files True) )
212 , ( "keep-raw-s-file", AnySuffix (\_ -> writeIORef v_Keep_raw_s_files True) )
213 , ( "keep-tmp-files" , AnySuffix (\_ -> writeIORef v_Keep_tmp_files True) )
215 , ( "split-objs" , NoArg (if can_split
216 then do writeIORef v_Split_object_files True
217 add v_Opt_C "-fglobalise-toplev-names"
218 -- TODO!!!!! add opt_c "-DUSE_SPLIT_MARKERS"
219 else hPutStrLn stderr
220 "warning: don't know how to split \
221 \object files on this architecture"
224 ------- Include/Import Paths ----------------------------------------
225 , ( "i" , OptPrefix (addToDirList v_Import_paths) )
226 , ( "I" , Prefix (addToDirList v_Include_paths) )
228 ------- Libraries ---------------------------------------------------
229 , ( "L" , Prefix (addToDirList v_Library_paths) )
230 , ( "l" , Prefix (add v_Cmdline_libraries) )
232 ------- Packages ----------------------------------------------------
233 , ( "package-name" , HasArg (\s -> add v_Opt_C ("-inpackage="++s)) )
235 , ( "package" , HasArg (addPackage) )
236 , ( "syslib" , HasArg (addPackage) ) -- for compatibility w/ old vsns
238 , ( "-list-packages" , NoArg (listPackages) )
239 , ( "-add-package" , NoArg (newPackage) )
240 , ( "-delete-package" , SepArg (deletePackage) )
242 ------- Specific phases --------------------------------------------
243 , ( "pgmL" , HasArg (writeIORef v_Pgm_L) )
244 , ( "pgmP" , HasArg (writeIORef v_Pgm_P) )
245 , ( "pgmc" , HasArg (writeIORef v_Pgm_c) )
246 , ( "pgmm" , HasArg (writeIORef v_Pgm_m) )
247 , ( "pgms" , HasArg (writeIORef v_Pgm_s) )
248 , ( "pgma" , HasArg (writeIORef v_Pgm_a) )
249 , ( "pgml" , HasArg (writeIORef v_Pgm_l) )
251 , ( "optdep" , HasArg (add v_Opt_dep) )
252 , ( "optl" , HasArg (add v_Opt_l) )
253 , ( "optdll" , HasArg (add v_Opt_dll) )
255 ------ Warning opts -------------------------------------------------
256 , ( "W" , NoArg (writeIORef v_Warning_opt W_) )
257 , ( "Wall" , NoArg (writeIORef v_Warning_opt W_all) )
258 , ( "Wnot" , NoArg (writeIORef v_Warning_opt W_not) )
259 , ( "w" , NoArg (writeIORef v_Warning_opt W_not) )
261 ----- Linker --------------------------------------------------------
262 , ( "static" , NoArg (writeIORef v_Static True) )
264 ------ Compiler flags -----------------------------------------------
265 , ( "O2-for-C" , NoArg (writeIORef v_minus_o2_for_C True) )
266 , ( "O" , OptPrefix (setOptLevel) )
268 , ( "fasm" , OptPrefix (\_ -> writeIORef v_Hsc_Lang HscAsm) )
270 , ( "fvia-c" , NoArg (writeIORef v_Hsc_Lang HscC) )
271 , ( "fvia-C" , NoArg (writeIORef v_Hsc_Lang HscC) )
273 , ( "fno-asm-mangling" , NoArg (writeIORef v_Do_asm_mangling False) )
275 , ( "fmax-simplifier-iterations",
276 Prefix (writeIORef v_MaxSimplifierIterations . read) )
278 , ( "fusagesp" , NoArg (do writeIORef v_UsageSPInf True
279 add v_Opt_C "-fusagesp-on") )
281 , ( "fexcess-precision" , NoArg (do writeIORef v_Excess_precision True
282 add v_Opt_C "-fexcess-precision"))
284 -- flags that are "active negatives"
285 , ( "fno-implicit-prelude" , PassFlag (add v_Opt_C) )
286 , ( "fno-prune-tydecls" , PassFlag (add v_Opt_C) )
287 , ( "fno-prune-instdecls" , PassFlag (add v_Opt_C) )
288 , ( "fno-pre-inlining" , PassFlag (add v_Opt_C) )
290 -- All other "-fno-<blah>" options cancel out "-f<blah>" on the hsc cmdline
291 , ( "fno-", PrefixPred (\s -> isStaticHscFlag ("f"++s))
292 (\s -> add v_Anti_opt_C ("-f"++s)) )
294 -- Pass all remaining "-f<blah>" options to hsc
295 , ( "f", AnySuffixPred (isStaticHscFlag) (add v_Opt_C) )
298 -----------------------------------------------------------------------------
299 -- parse the dynamic arguments
301 GLOBAL_VAR(v_InitDynFlags, error "no InitDynFlags", DynFlags)
302 GLOBAL_VAR(v_DynFlags, error "no DynFlags", DynFlags)
305 dfs <- readIORef v_DynFlags
306 writeIORef v_DynFlags dfs{ flags = f : flags dfs }
309 dfs <- readIORef v_DynFlags
310 writeIORef v_DynFlags dfs{ flags = filter (/= f) (flags dfs) }
314 ( "cpp", NoArg (updateState (\s -> s{ cpp_flag = True })) )
315 , ( "#include", HasArg (addCmdlineHCInclude) )
317 , ( "optL", HasArg (addOpt_L) )
318 , ( "optP", HasArg (addOpt_P) )
319 , ( "optc", HasArg (addOpt_c) )
320 , ( "optm", HasArg (addOpt_m) )
321 , ( "opta", HasArg (addOpt_a) )
323 ------ HsCpp opts ---------------------------------------------------
324 , ( "D", Prefix (\s -> addOpt_P ("-D'"++s++"'") ) )
325 , ( "U", Prefix (\s -> addOpt_P ("-U'"++s++"'") ) )
327 ------ Debugging ----------------------------------------------------
328 , ( "dstg-stats", NoArg (writeIORef v_StgStats True) )
330 , ( "ddump-all", NoArg (setDynFlag Opt_D_dump_all) )
331 , ( "ddump-most", NoArg (setDynFlag Opt_D_dump_most) )
332 , ( "ddump-absC", NoArg (setDynFlag Opt_D_dump_absC) )
333 , ( "ddump-asm", NoArg (setDynFlag Opt_D_dump_asm) )
334 , ( "ddump-cpranal", NoArg (setDynFlag Opt_D_dump_cpranal) )
335 , ( "ddump-deriv", NoArg (setDynFlag Opt_D_dump_deriv) )
336 , ( "ddump-ds", NoArg (setDynFlag Opt_D_dump_ds) )
337 , ( "ddump-flatC", NoArg (setDynFlag Opt_D_dump_flatC) )
338 , ( "ddump-foreign", NoArg (setDynFlag Opt_D_dump_foreign) )
339 , ( "ddump-inlinings", NoArg (setDynFlag Opt_D_dump_inlinings) )
340 , ( "ddump-occur-anal", NoArg (setDynFlag Opt_D_dump_occur_anal) )
341 , ( "ddump-parsed", NoArg (setDynFlag Opt_D_dump_parsed) )
342 , ( "ddump-realC", NoArg (setDynFlag Opt_D_dump_realC) )
343 , ( "ddump-rn", NoArg (setDynFlag Opt_D_dump_rn) )
344 , ( "ddump-simpl", NoArg (setDynFlag Opt_D_dump_simpl) )
345 , ( "ddump-simpl-iterations", NoArg (setDynFlag Opt_D_dump_simpl_iterations) )
346 , ( "ddump-spec", NoArg (setDynFlag Opt_D_dump_spec) )
347 , ( "ddump-stg", NoArg (setDynFlag Opt_D_dump_stg) )
348 , ( "ddump-stranal", NoArg (setDynFlag Opt_D_dump_stranal) )
349 , ( "ddump-tc", NoArg (setDynFlag Opt_D_dump_tc) )
350 , ( "ddump-types", NoArg (setDynFlag Opt_D_dump_types) )
351 , ( "ddump-rules", NoArg (setDynFlag Opt_D_dump_rules) )
352 , ( "ddump-usagesp", NoArg (setDynFlag Opt_D_dump_usagesp) )
353 , ( "ddump-cse", NoArg (setDynFlag Opt_D_dump_cse) )
354 , ( "ddump-worker-wrapper", NoArg (setDynFlag Opt_D_dump_worker_wrapper) )
355 , ( "dshow-passes", NoArg (setDynFlag Opt_D_show_passes) )
356 , ( "ddump-rn-trace", NoArg (setDynFlag Opt_D_dump_rn_trace) )
357 , ( "ddump-rn-stats", NoArg (setDynFlag Opt_D_dump_rn_stats) )
358 , ( "ddump-stix", NoArg (setDynFlag Opt_D_dump_stix) )
359 , ( "ddump-simpl-stats", NoArg (setDynFlag Opt_D_dump_simpl_stats) )
360 , ( "dsource-stats", NoArg (setDynFlag Opt_D_source_stats) )
361 , ( "dverbose-core2core", NoArg (setDynFlag Opt_D_verbose_core2core) )
362 , ( "dverbose-stg2stg", NoArg (setDynFlag Opt_D_verbose_stg2stg) )
363 , ( "ddump-hi-diffs", NoArg (setDynFlag Opt_D_dump_hi_diffs) )
364 , ( "ddump-minimal-imports", NoArg (setDynFlag Opt_D_dump_minimal_imports) )
365 , ( "dcore-lint", NoArg (setDynFlag Opt_DoCoreLinting) )
366 , ( "dstg-lint", NoArg (setDynFlag Opt_DoStgLinting) )
367 , ( "dusagesp-lint", NoArg (setDynFlag Opt_DoUSPLinting) )
369 ------ Warnings ----------------------------------------------------
371 , ( "fwarn-duplicate-exports", NoArg (setDynFlag Opt_WarnDuplicateExports) )
372 , ( "fwarn-hi-shadowing", NoArg (setDynFlag Opt_WarnHiShadows) )
373 , ( "fwarn-incomplete-patterns", NoArg (setDynFlag Opt_WarnIncompletePatterns) )
374 , ( "fwarn-missing-fields", NoArg (setDynFlag Opt_WarnMissingFields) )
375 , ( "fwarn-missing-methods", NoArg (setDynFlag Opt_WarnMissingMethods))
376 , ( "fwarn-missing-signatures", NoArg (setDynFlag Opt_WarnMissingSigs) )
377 , ( "fwarn-name-shadowing", NoArg (setDynFlag Opt_WarnNameShadowing) )
378 , ( "fwarn-overlapping-patterns", NoArg (setDynFlag Opt_WarnOverlappingPatterns ) )
379 , ( "fwarn-simple-patterns", NoArg (setDynFlag Opt_WarnSimplePatterns))
380 , ( "fwarn-type-defaults", NoArg (setDynFlag Opt_WarnTypeDefaults) )
381 , ( "fwarn-unused-binds", NoArg (setDynFlag Opt_WarnUnusedBinds) )
382 , ( "fwarn-unused-imports", NoArg (setDynFlag Opt_WarnUnusedImports) )
383 , ( "fwarn-unused-matches", NoArg (setDynFlag Opt_WarnUnusedMatches) )
384 , ( "fwarn-deprecations", NoArg (setDynFlag Opt_WarnDeprecations) )
386 ------ Machine dependant (-m<blah>) stuff ---------------------------
388 , ( "monly-2-regs", NoArg (updateState (\s -> s{stolen_x86_regs = 2}) ))
389 , ( "monly-3-regs", NoArg (updateState (\s -> s{stolen_x86_regs = 3}) ))
390 , ( "monly-4-regs", NoArg (updateState (\s -> s{stolen_x86_regs = 4}) ))
392 ------ Compiler flags -----------------------------------------------
394 , ( "fglasgow-exts", NoArg (setDynFlag Opt_GlasgowExts) )
395 , ( "fno-implicit-prelude", NoArg (setDynFlag Opt_NoImplicitPrelude) )
397 , ( "fallow-overlapping-instances",
398 NoArg (setDynFlag Opt_AllowOverlappingInstances) )
400 , ( "fallow-undecidable-instances",
401 NoArg (setDynFlag Opt_AllowUndecidableInstances) )
403 , ( "fgenerics", NoArg (setDynFlag Opt_Generics) )
405 , ( "freport-compile", NoArg (setDynFlag Opt_ReportCompile) )
408 -----------------------------------------------------------------------------
409 -- convert sizes like "3.5M" into integers
411 decodeSize :: String -> Integer
413 | c == "" = truncate n
414 | c == "K" || c == "k" = truncate (n * 1000)
415 | c == "M" || c == "m" = truncate (n * 1000 * 1000)
416 | c == "G" || c == "g" = truncate (n * 1000 * 1000 * 1000)
417 | otherwise = throwDyn (OtherError ("can't decode size: " ++ str))
418 where (m, c) = span pred str
420 pred c = isDigit c || c == '.'
422 floatOpt :: IORef Double -> String -> IO ()
424 = writeIORef ref (read str :: Double)
426 -----------------------------------------------------------------------------
427 -- Build the Hsc static command line opts
429 buildStaticHscOpts :: IO [String]
430 buildStaticHscOpts = do
432 opt_C_ <- getStaticOpts v_Opt_C -- misc hsc opts
435 minus_o <- readIORef v_OptLevel
436 let optimisation_opts =
438 0 -> hsc_minusNoO_flags
439 1 -> hsc_minusO_flags
440 2 -> hsc_minusO2_flags
441 _ -> error "unknown opt level"
444 let stg_opts = [ "-flet-no-escape" ]
445 -- let-no-escape always on for now
447 -- take into account -fno-* flags by removing the equivalent -f*
448 -- flag from our list.
449 anti_flags <- getStaticOpts v_Anti_opt_C
450 let basic_opts = opt_C_ ++ optimisation_opts ++ stg_opts
451 filtered_opts = filter (`notElem` anti_flags) basic_opts
454 let hi_vers = "-fhi-version="++cProjectVersionInt
456 static <- (do s <- readIORef v_Static; if s then return "-static"
459 return ( filtered_opts ++ [ hi_vers, static, verb ] )