[project @ 2000-09-07 16:31:45 by simonpj]
[ghc-hetmet.git] / ghc / compiler / main / CmdLineOpts.lhs
1 %
2 % (c) The AQUA Project, Glasgow University, 1996-98
3 %
4 \section[CmdLineOpts]{Things to do with command-line options}
5
6 \begin{code}
7 module CmdLineOpts (
8         CoreToDo(..),
9         SimplifierSwitch(..),
10         StgToDo(..),
11         SwitchResult(..),
12         classifyOpts,
13
14         intSwitchSet,
15         switchIsOn,
16
17         src_filename,
18
19         -- debugging opts
20         opt_D_dump_absC,
21         opt_D_dump_asm,
22         opt_D_dump_cpranal,
23         opt_D_dump_cse,
24         opt_D_dump_deriv,
25         opt_D_dump_ds,
26         opt_D_dump_flatC,
27         opt_D_dump_foreign,
28         opt_D_dump_inlinings,
29         opt_D_dump_occur_anal,
30         opt_D_dump_parsed,
31         opt_D_dump_realC,
32         opt_D_dump_rn,
33         opt_D_dump_rules,
34         opt_D_dump_simpl,
35         opt_D_dump_simpl_iterations,
36         opt_D_dump_simpl_stats,
37         opt_D_dump_spec,
38         opt_D_dump_stg,
39         opt_D_dump_stranal,
40         opt_D_dump_tc,
41         opt_D_dump_types,
42         opt_D_dump_usagesp,
43         opt_D_dump_worker_wrapper,
44         opt_D_show_passes,
45         opt_D_dump_rn_trace,
46         opt_D_dump_rn_stats,
47         opt_D_dump_stix,
48         opt_D_dump_minimal_imports,
49         opt_D_source_stats,
50         opt_D_verbose_core2core,
51         opt_D_verbose_stg2stg,
52         opt_DoCoreLinting,
53         opt_DoStgLinting,
54         opt_DoUSPLinting,
55         opt_PprStyle_Debug,
56         opt_PprStyle_NoPrags,
57         opt_PprUserLength,
58
59         -- warning opts
60         opt_WarnDuplicateExports,
61         opt_WarnHiShadows,
62         opt_WarnIncompletePatterns,
63         opt_WarnMissingFields,
64         opt_WarnMissingMethods,
65         opt_WarnMissingSigs,
66         opt_WarnNameShadowing,
67         opt_WarnOverlappingPatterns,
68         opt_WarnSimplePatterns,
69         opt_WarnTypeDefaults,
70         opt_WarnUnusedBinds,
71         opt_WarnUnusedImports,
72         opt_WarnUnusedMatches,
73         opt_WarnDeprecations,
74
75         -- profiling opts
76         opt_AutoSccsOnAllToplevs,
77         opt_AutoSccsOnExportedToplevs,
78         opt_AutoSccsOnIndividualCafs,
79         opt_AutoSccsOnDicts,
80         opt_SccProfilingOn,
81         opt_DoTickyProfiling,
82
83         -- language opts
84         opt_AllStrict,
85         opt_DictsStrict,
86         opt_MaxContextReductionDepth,
87         opt_AllowOverlappingInstances,
88         opt_AllowUndecidableInstances,
89         opt_GlasgowExts,
90         opt_IrrefutableTuples,
91         opt_NumbersStrict,
92         opt_Parallel,
93         opt_SMP,
94
95         -- optimisation opts
96         opt_DoEtaReduction,
97         opt_DoSemiTagging,
98         opt_FoldrBuildOn,
99         opt_LiberateCaseThreshold,
100         opt_StgDoLetNoEscapes,
101         opt_UnfoldCasms,
102         opt_UsageSPOn,
103         opt_UnboxStrictFields,
104         opt_SimplNoPreInlining,
105         opt_SimplDoEtaReduction,
106         opt_SimplDoLambdaEtaExpansion,
107         opt_SimplCaseOfCase,
108         opt_SimplCaseMerge,
109         opt_SimplPedanticBottoms,
110         opt_SimplExcessPrecision,
111
112         -- Unfolding control
113         opt_UF_HiFileThreshold,
114         opt_UF_CreationThreshold,
115         opt_UF_UseThreshold,
116         opt_UF_ScrutConDiscount,
117         opt_UF_FunAppDiscount,
118         opt_UF_PrimArgDiscount,
119         opt_UF_KeenessFactor,
120         opt_UF_CheapOp,
121         opt_UF_DearOp,
122
123         -- misc opts
124         opt_InPackage,
125         opt_EmitCExternDecls,
126         opt_EnsureSplittableC,
127         opt_GranMacros,
128         opt_HiMap,
129         opt_HiMapSep,
130         opt_HiVersion,
131         opt_HistorySize,
132         opt_IgnoreAsserts,
133         opt_IgnoreIfacePragmas,
134         opt_NoHiCheck,
135         opt_NoImplicitPrelude,
136         opt_OmitBlackHoling,
137         opt_OmitInterfacePragmas,
138         opt_ProduceExportCStubs,
139         opt_ProduceExportHStubs,
140         opt_HiFile,
141         opt_HiDir,
142         opt_HiSuf,
143         opt_NoPruneTyDecls,
144         opt_NoPruneDecls,
145         opt_ReportCompile,
146         opt_SourceUnchanged,
147         opt_Static,
148         opt_Unregisterised,
149         opt_Verbose,
150
151         opt_OutputLanguage,
152         opt_OutputFile,
153
154         -- Code generation
155         opt_UseVanillaRegs,
156         opt_UseFloatRegs,
157         opt_UseDoubleRegs,
158         opt_UseLongRegs
159     ) where
160
161 #include "HsVersions.h"
162
163 import Array    ( array, (//) )
164 import GlaExts
165 import Argv
166 import Constants        -- Default values for some flags
167
168 import FastString       ( headFS )
169 import Maybes           ( assocMaybe, firstJust, maybeToBool )
170 import Panic            ( panic, panic# )
171
172 #if __GLASGOW_HASKELL__ < 301
173 import ArrBase  ( Array(..) )
174 #else
175 import PrelArr  ( Array(..) )
176 #endif
177 \end{code}
178
179 A command-line {\em switch} is (generally) either on or off; e.g., the
180 ``verbose'' (-v) switch is either on or off.
181
182 A list of {\em ToDo}s is things to be done in a particular part of
183 processing.  A (fictitious) example for the Core-to-Core simplifier
184 might be: run the simplifier, then run the strictness analyser, then
185 run the simplifier again (three ``todos'').
186
187 There are three ``to-do processing centers'' at the moment.  In the
188 main loop (\tr{main/Main.lhs}), in the Core-to-Core processing loop
189 (\tr{simplCore/SimplCore.lhs), and in the STG-to-STG processing loop
190 (\tr{simplStg/SimplStg.lhs}).
191
192
193 %************************************************************************
194 %*                                                                      *
195 \subsection{Datatypes associated with command-line options}
196 %*                                                                      *
197 %************************************************************************
198
199 \begin{code}
200 data SwitchResult
201   = SwBool      Bool            -- on/off
202   | SwString    FAST_STRING     -- nothing or a String
203   | SwInt       Int             -- nothing or an Int
204 \end{code}
205
206 \begin{code}
207 data CoreToDo           -- These are diff core-to-core passes,
208                         -- which may be invoked in any order,
209                         -- as many times as you like.
210
211   = CoreDoSimplify      -- The core-to-core simplifier.
212         (SimplifierSwitch -> SwitchResult)
213                         -- Each run of the simplifier can take a different
214                         -- set of simplifier-specific flags.
215   | CoreDoFloatInwards
216   | CoreDoFloatOutwards Bool    -- True <=> float lambdas to top level
217   | CoreLiberateCase
218   | CoreDoPrintCore
219   | CoreDoStaticArgs
220   | CoreDoStrictness
221   | CoreDoWorkerWrapper
222   | CoreDoSpecialising
223   | CoreDoUSPInf
224   | CoreDoCPResult 
225   | CoreDoGlomBinds
226   | CoreCSE
227 \end{code}
228
229 \begin{code}
230 data StgToDo
231   = StgDoStaticArgs
232   | StgDoLambdaLift
233   | StgDoMassageForProfiling  -- should be (next to) last
234   -- There's also setStgVarInfo, but its absolute "lastness"
235   -- is so critical that it is hardwired in (no flag).
236   | D_stg_stats
237 \end{code}
238
239 \begin{code}
240 data SimplifierSwitch
241   = MaxSimplifierIterations Int
242   | SimplInlinePhase Int
243   | DontApplyRules
244   | NoCaseOfCase
245   | SimplLetToCase
246 \end{code}
247
248 %************************************************************************
249 %*                                                                      *
250 \subsection{Classifying command-line options}
251 %*                                                                      *
252 %************************************************************************
253
254 \begin{code}
255 lookUp           :: FAST_STRING -> Bool
256 lookup_int       :: String -> Maybe Int
257 lookup_def_int   :: String -> Int -> Int
258 lookup_def_float :: String -> Float -> Float
259 lookup_str       :: String -> Maybe String
260
261 lookUp     sw = maybeToBool (assoc_opts sw)
262         
263 lookup_str sw = firstJust (map (startsWith sw) unpacked_opts)
264
265 lookup_int sw = case (lookup_str sw) of
266                   Nothing -> Nothing
267                   Just xx -> Just (read xx)
268
269 lookup_def_int sw def = case (lookup_str sw) of
270                             Nothing -> def              -- Use default
271                             Just xx -> read xx
272
273 lookup_def_char sw def = case (lookup_str sw) of
274                             Just (xx:_) -> xx
275                             _           -> def          -- Use default
276
277 lookup_def_float sw def = case (lookup_str sw) of
278                             Nothing -> def              -- Use default
279                             Just xx -> read xx
280
281 assoc_opts    = assocMaybe [ (a, True) | a <- argv ]
282 unpacked_opts = map _UNPK_ argv
283
284 {-
285  Putting the compiler options into temporary at-files
286  may turn out to be necessary later on if we turn hsc into
287  a pure Win32 application where I think there's a command-line
288  length limit of 255. unpacked_opts understands the @ option.
289
290 assoc_opts    = assocMaybe [ (_PK_ a, True) | a <- unpacked_opts ]
291
292 unpacked_opts :: [String]
293 unpacked_opts =
294   concat $
295   map (expandAts) $
296   map _UNPK_ argv
297   where
298    expandAts ('@':fname) = words (unsafePerformIO (readFile fname))
299    expandAts l = [l]
300 -}
301 \end{code}
302
303 \begin{code}
304 src_filename :: FAST_STRING
305 src_filename = case argv of
306                   filename : rest | headFS filename /= '-' -> filename
307                   otherwise -> panic "no filename"
308 \end{code}
309
310 \begin{code}
311 -- debugging opts
312 opt_D_dump_all   {- do not -}   = lookUp  SLIT("-ddump-all")
313 opt_D_dump_most  {- export -}   = opt_D_dump_all  || lookUp  SLIT("-ddump-most")
314
315 opt_D_dump_absC                 = opt_D_dump_all  || lookUp  SLIT("-ddump-absC")
316 opt_D_dump_asm                  = opt_D_dump_all  || lookUp  SLIT("-ddump-asm")
317 opt_D_dump_cpranal              = opt_D_dump_most || lookUp  SLIT("-ddump-cpranal")
318 opt_D_dump_deriv                = opt_D_dump_most || lookUp  SLIT("-ddump-deriv")
319 opt_D_dump_ds                   = opt_D_dump_most || lookUp  SLIT("-ddump-ds")
320 opt_D_dump_flatC                = opt_D_dump_all  || lookUp  SLIT("-ddump-flatC")
321 opt_D_dump_foreign              = opt_D_dump_most || lookUp  SLIT("-ddump-foreign-stubs")
322 opt_D_dump_inlinings            = opt_D_dump_all  || lookUp  SLIT("-ddump-inlinings")
323 opt_D_dump_occur_anal           = opt_D_dump_all  || lookUp  SLIT("-ddump-occur-anal")
324 opt_D_dump_parsed               = opt_D_dump_most || lookUp  SLIT("-ddump-parsed")
325 opt_D_dump_realC                = opt_D_dump_all  || lookUp  SLIT("-ddump-realC")
326 opt_D_dump_rn                   = opt_D_dump_most || lookUp  SLIT("-ddump-rn")
327 opt_D_dump_simpl                = opt_D_dump_most || lookUp  SLIT("-ddump-simpl")
328 opt_D_dump_simpl_iterations     = opt_D_dump_all  || lookUp  SLIT("-ddump-simpl-iterations")
329 opt_D_dump_spec                 = opt_D_dump_most || lookUp  SLIT("-ddump-spec")
330 opt_D_dump_stg                  = opt_D_dump_most || lookUp  SLIT("-ddump-stg")
331 opt_D_dump_stranal              = opt_D_dump_most || lookUp  SLIT("-ddump-stranal")
332 opt_D_dump_tc                   = opt_D_dump_most || lookUp  SLIT("-ddump-tc")
333 opt_D_dump_types                = opt_D_dump_most || lookUp  SLIT("-ddump-types")
334 opt_D_dump_rules                = opt_D_dump_most || lookUp  SLIT("-ddump-rules")
335 opt_D_dump_usagesp              = opt_D_dump_most || lookUp  SLIT("-ddump-usagesp")
336 opt_D_dump_cse                  = opt_D_dump_most || lookUp  SLIT("-ddump-cse")
337 opt_D_dump_worker_wrapper       = opt_D_dump_most || lookUp  SLIT("-ddump-workwrap")
338 opt_D_show_passes               = opt_D_dump_most || lookUp  SLIT("-dshow-passes")
339 opt_D_dump_rn_trace             = opt_D_dump_all  || lookUp  SLIT("-ddump-rn-trace")
340 opt_D_dump_rn_stats             = opt_D_dump_most || lookUp  SLIT("-ddump-rn-stats")
341 opt_D_dump_stix                 = opt_D_dump_all  || lookUp  SLIT("-ddump-stix")
342 opt_D_dump_simpl_stats          = opt_D_dump_most || lookUp  SLIT("-ddump-simpl-stats")
343 opt_D_source_stats              = opt_D_dump_most || lookUp  SLIT("-dsource-stats")
344 opt_D_verbose_core2core         = opt_D_dump_all  || lookUp  SLIT("-dverbose-simpl")
345 opt_D_verbose_stg2stg           = opt_D_dump_all  || lookUp  SLIT("-dverbose-stg")
346 opt_D_dump_minimal_imports      = lookUp  SLIT("-ddump-minimal-imports")
347
348 opt_DoCoreLinting               = lookUp  SLIT("-dcore-lint")
349 opt_DoStgLinting                = lookUp  SLIT("-dstg-lint")
350 opt_DoUSPLinting                = lookUp  SLIT("-dusagesp-lint")
351 opt_PprStyle_NoPrags            = lookUp  SLIT("-dppr-noprags")
352 opt_PprStyle_Debug              = lookUp  SLIT("-dppr-debug")
353 opt_PprUserLength               = lookup_def_int "-dppr-user-length" 5 --ToDo: give this a name
354
355 -- warning opts
356 opt_WarnDuplicateExports        = lookUp  SLIT("-fwarn-duplicate-exports")
357 opt_WarnHiShadows               = lookUp  SLIT("-fwarn-hi-shadowing")
358 opt_WarnIncompletePatterns      = lookUp  SLIT("-fwarn-incomplete-patterns")
359 opt_WarnMissingFields           = lookUp  SLIT("-fwarn-missing-fields")
360 opt_WarnMissingMethods          = lookUp  SLIT("-fwarn-missing-methods")
361 opt_WarnMissingSigs             = lookUp  SLIT("-fwarn-missing-signatures")
362 opt_WarnNameShadowing           = lookUp  SLIT("-fwarn-name-shadowing")
363 opt_WarnOverlappingPatterns     = lookUp  SLIT("-fwarn-overlapping-patterns")
364 opt_WarnSimplePatterns          = lookUp  SLIT("-fwarn-simple-patterns")
365 opt_WarnTypeDefaults            = lookUp  SLIT("-fwarn-type-defaults")
366 opt_WarnUnusedBinds             = lookUp  SLIT("-fwarn-unused-binds")
367 opt_WarnUnusedImports           = lookUp  SLIT("-fwarn-unused-imports")
368 opt_WarnUnusedMatches           = lookUp  SLIT("-fwarn-unused-matches")
369 opt_WarnDeprecations            = lookUp  SLIT("-fwarn-deprecations")
370
371 -- profiling opts
372 opt_AutoSccsOnAllToplevs        = lookUp  SLIT("-fauto-sccs-on-all-toplevs")
373 opt_AutoSccsOnExportedToplevs   = lookUp  SLIT("-fauto-sccs-on-exported-toplevs")
374 opt_AutoSccsOnIndividualCafs    = lookUp  SLIT("-fauto-sccs-on-individual-cafs")
375 opt_AutoSccsOnDicts             = lookUp  SLIT("-fauto-sccs-on-dicts")
376 opt_SccProfilingOn              = lookUp  SLIT("-fscc-profiling")
377 opt_DoTickyProfiling            = lookUp  SLIT("-fticky-ticky")
378
379 -- language opts
380 opt_AllStrict                   = lookUp  SLIT("-fall-strict")
381 opt_DictsStrict                 = lookUp  SLIT("-fdicts-strict")
382 opt_AllowOverlappingInstances   = lookUp  SLIT("-fallow-overlapping-instances")
383 opt_AllowUndecidableInstances   = lookUp  SLIT("-fallow-undecidable-instances")
384 opt_GlasgowExts                 = lookUp  SLIT("-fglasgow-exts")
385 opt_IrrefutableTuples           = lookUp  SLIT("-firrefutable-tuples")
386 opt_MaxContextReductionDepth    = lookup_def_int "-fcontext-stack" mAX_CONTEXT_REDUCTION_DEPTH
387 opt_NumbersStrict               = lookUp  SLIT("-fnumbers-strict")
388 opt_Parallel                    = lookUp  SLIT("-fparallel")
389 opt_SMP                         = lookUp  SLIT("-fsmp")
390
391 -- optimisation opts
392 opt_DoEtaReduction              = lookUp  SLIT("-fdo-eta-reduction")
393 opt_DoSemiTagging               = lookUp  SLIT("-fsemi-tagging")
394 opt_FoldrBuildOn                = lookUp  SLIT("-ffoldr-build-on")
395 opt_LiberateCaseThreshold       = lookup_def_int "-fliberate-case-threshold" (10::Int)
396 opt_StgDoLetNoEscapes           = lookUp  SLIT("-flet-no-escape")
397 opt_UnfoldCasms                 = lookUp SLIT("-funfold-casms-in-hi-file")
398 opt_UsageSPOn                   = lookUp  SLIT("-fusagesp-on")
399 opt_UnboxStrictFields           = lookUp  SLIT("-funbox-strict-fields")
400
401 {-
402    The optional '-inpackage=P' flag tells what package 
403    we are compiling this module for.
404    The Prelude, for example is compiled with '-package prelude'
405 -}
406 opt_InPackage                   = case lookup_str "-inpackage=" of
407                                     Just p  -> _PK_ p
408                                     Nothing -> SLIT("Main")     -- The package name if none is specified
409
410 opt_EmitCExternDecls            = lookUp  SLIT("-femit-extern-decls")
411 opt_EnsureSplittableC           = lookUp  SLIT("-fglobalise-toplev-names")
412 opt_GranMacros                  = lookUp  SLIT("-fgransim")
413 opt_HiMap                       = lookup_str "-himap="       -- file saying where to look for .hi files
414 opt_HiMapSep                    = lookup_def_char "-himap-sep=" ':'
415 opt_HiVersion                   = lookup_def_int "-fhi-version=" 0 -- what version we're compiling.
416 opt_HistorySize                 = lookup_def_int "-fhistory-size" 20
417 opt_IgnoreAsserts               = lookUp  SLIT("-fignore-asserts")
418 opt_IgnoreIfacePragmas          = lookUp  SLIT("-fignore-interface-pragmas")
419 opt_NoHiCheck                   = lookUp  SLIT("-fno-hi-version-check")
420 opt_NoImplicitPrelude           = lookUp  SLIT("-fno-implicit-prelude")
421 opt_OmitBlackHoling             = lookUp  SLIT("-dno-black-holing")
422 opt_OmitInterfacePragmas        = lookUp  SLIT("-fomit-interface-pragmas")
423 opt_ProduceExportCStubs         = lookup_str "-F="
424 opt_ProduceExportHStubs         = lookup_str "-FH="
425
426 -- where to generate the .hi file
427 opt_HiFile                      = lookup_str "-hifile="
428 opt_HiDir                       = lookup_str "-hidir="
429 opt_HiSuf                       = lookup_str "-hisuf="
430
431 -- Language for output: "C", "asm", "java", maybe more
432 -- Nothing => don't output anything
433 opt_OutputLanguage :: Maybe String
434 opt_OutputLanguage = lookup_str "-olang="
435
436 opt_OutputFile :: String
437 opt_OutputFile     = case lookup_str "-ofile=" of
438                         Nothing -> panic "No output file specified (-ofile=xxx)"
439                         Just f  -> f
440
441 -- Simplifier switches
442 opt_SimplNoPreInlining          = lookUp SLIT("-fno-pre-inlining")
443         -- NoPreInlining is there just to see how bad things
444         -- get if you don't do it!
445 opt_SimplDoEtaReduction         = lookUp SLIT("-fdo-eta-reduction")
446 opt_SimplDoLambdaEtaExpansion   = lookUp SLIT("-fdo-lambda-eta-expansion")
447 opt_SimplCaseOfCase             = lookUp SLIT("-fcase-of-case")
448 opt_SimplCaseMerge              = lookUp SLIT("-fcase-merge")
449 opt_SimplPedanticBottoms        = lookUp SLIT("-fpedantic-bottoms")
450 opt_SimplExcessPrecision        = lookUp SLIT("-fexcess-precision")
451
452 -- Unfolding control
453 opt_UF_HiFileThreshold          = lookup_def_int "-funfolding-interface-threshold" (45::Int)
454 opt_UF_CreationThreshold        = lookup_def_int "-funfolding-creation-threshold"  (45::Int)
455 opt_UF_UseThreshold             = lookup_def_int "-funfolding-use-threshold"       (8::Int)     -- Discounts can be big
456 opt_UF_ScrutConDiscount         = lookup_def_int "-funfolding-con-discount"        (2::Int)
457 opt_UF_FunAppDiscount           = lookup_def_int "-funfolding-fun-discount"        (6::Int)     -- It's great to inline a fn
458 opt_UF_PrimArgDiscount          = lookup_def_int "-funfolding-prim-discount"       (1::Int)
459 opt_UF_KeenessFactor            = lookup_def_float "-funfolding-keeness-factor"    (1.5::Float)
460
461 opt_UF_CheapOp  = ( 1 :: Int)   -- Only one instruction; and the args are charged for
462 opt_UF_DearOp   = ( 4 :: Int)
463                         
464 opt_ReportCompile               = lookUp SLIT("-freport-compile")
465 opt_NoPruneDecls                = lookUp SLIT("-fno-prune-decls")
466 opt_NoPruneTyDecls              = lookUp SLIT("-fno-prune-tydecls")
467 opt_SourceUnchanged             = lookUp SLIT("-fsource-unchanged")
468 opt_Static                      = lookUp SLIT("-static")
469 opt_Unregisterised              = lookUp SLIT("-funregisterised")
470 opt_Verbose                     = lookUp SLIT("-v")
471
472 opt_UseVanillaRegs | opt_Unregisterised = 0
473                    | otherwise          = mAX_Real_Vanilla_REG
474 opt_UseFloatRegs   | opt_Unregisterised = 0
475                    | otherwise          = mAX_Real_Float_REG
476 opt_UseDoubleRegs  | opt_Unregisterised = 0
477                    | otherwise          = mAX_Real_Double_REG
478 opt_UseLongRegs    | opt_Unregisterised = 0
479                    | otherwise          = mAX_Real_Long_REG
480 \end{code}
481
482 \begin{code}
483 classifyOpts :: ([CoreToDo],    -- Core-to-Core processing spec
484                  [StgToDo])     -- STG-to-STG   processing spec
485
486 classifyOpts = sep argv [] [] -- accumulators...
487   where
488     sep :: [FAST_STRING]                 -- cmd-line opts (input)
489         -> [CoreToDo] -> [StgToDo]       -- to_do accumulators
490         -> ([CoreToDo], [StgToDo])       -- result
491
492     sep [] core_td stg_td -- all done!
493       = (reverse core_td, reverse stg_td)
494
495 #       define CORE_TD(to_do) sep opts (to_do:core_td) stg_td
496 #       define STG_TD(to_do)  sep opts core_td (to_do:stg_td)
497
498     sep (opt1:opts) core_td stg_td
499       = case (_UNPK_ opt1) of -- the non-"just match a string" options are at the end...
500           ',' : _       -> sep opts core_td stg_td -- it is for the parser
501
502           "-fsimplify"  -> -- gather up SimplifierSwitches specially...
503                            simpl_sep opts defaultSimplSwitches core_td stg_td
504
505           "-ffloat-inwards"  -> CORE_TD(CoreDoFloatInwards)
506           "-ffloat-outwards"      -> CORE_TD(CoreDoFloatOutwards False)
507           "-ffloat-outwards-full" -> CORE_TD(CoreDoFloatOutwards True)
508           "-fliberate-case"  -> CORE_TD(CoreLiberateCase)
509           "-fcse"            -> CORE_TD(CoreCSE)
510           "-fglom-binds"     -> CORE_TD(CoreDoGlomBinds)
511           "-fprint-core"     -> CORE_TD(CoreDoPrintCore)
512           "-fstatic-args"    -> CORE_TD(CoreDoStaticArgs)
513           "-fstrictness"     -> CORE_TD(CoreDoStrictness)
514           "-fworker-wrapper" -> CORE_TD(CoreDoWorkerWrapper)
515           "-fspecialise"     -> CORE_TD(CoreDoSpecialising)
516           "-fusagesp"        -> CORE_TD(CoreDoUSPInf)
517           "-fcpr-analyse"    -> CORE_TD(CoreDoCPResult)
518
519           "-fstg-static-args" -> STG_TD(StgDoStaticArgs)
520           "-dstg-stats"       -> STG_TD(D_stg_stats)
521           "-flambda-lift"     -> STG_TD(StgDoLambdaLift)
522           "-fmassage-stg-for-profiling" -> STG_TD(StgDoMassageForProfiling)
523
524           _ -> -- NB: the driver is really supposed to handle bad options
525                sep opts core_td stg_td
526
527     ----------------
528
529     simpl_sep :: [FAST_STRING]            -- cmd-line opts (input)
530               -> [SimplifierSwitch]       -- simplifier-switch accumulator
531               -> [CoreToDo] -> [StgToDo]  -- to_do accumulators
532               -> ([CoreToDo], [StgToDo])  -- result
533
534         -- "simpl_sep" tailcalls "sep" once it's seen one set
535         -- of SimplifierSwitches for a CoreDoSimplify.
536
537 #ifdef DEBUG
538     simpl_sep input@[] simpl_sw core_td stg_td
539       = panic "simpl_sep []"
540 #endif
541
542         -- The SimplifierSwitches should be delimited by "[" and "]".
543
544     simpl_sep (opt1:opts) simpl_sw core_td stg_td
545       = case (_UNPK_ opt1) of
546           "[" -> simpl_sep opts simpl_sw core_td stg_td
547           "]" -> let
548                     this_simpl = CoreDoSimplify (isAmongSimpl simpl_sw)
549                  in
550                  sep opts (this_simpl : core_td) stg_td
551
552           opt -> case matchSimplSw opt of
553                         Just sw -> simpl_sep opts (sw:simpl_sw) core_td stg_td
554                         Nothing -> simpl_sep opts simpl_sw      core_td stg_td
555
556 matchSimplSw opt
557   = firstJust   [ matchSwInt  opt "-fmax-simplifier-iterations"         MaxSimplifierIterations
558                 , matchSwInt  opt "-finline-phase"                      SimplInlinePhase
559                 , matchSwBool opt "-fno-rules"                          DontApplyRules
560                 , matchSwBool opt "-fno-case-of-case"                   NoCaseOfCase
561                 , matchSwBool opt "-flet-to-case"                       SimplLetToCase
562                 ]
563
564 matchSwBool :: String -> String -> a -> Maybe a
565 matchSwBool opt str sw | opt == str = Just sw
566                        | otherwise  = Nothing
567
568 matchSwInt :: String -> String -> (Int -> a) -> Maybe a
569 matchSwInt opt str sw = case startsWith str opt of
570                             Just opt_left -> Just (sw (read opt_left))
571                             Nothing       -> Nothing
572 \end{code}
573
574 %************************************************************************
575 %*                                                                      *
576 \subsection{Switch ordering}
577 %*                                                                      *
578 %************************************************************************
579
580 In spite of the @Produce*@ constructor, these things behave just like
581 enumeration types.
582
583 \begin{code}
584 instance Eq SimplifierSwitch where
585     a == b = tagOf_SimplSwitch a _EQ_ tagOf_SimplSwitch b
586
587 instance Ord SimplifierSwitch where
588     a <  b  = tagOf_SimplSwitch a _LT_ tagOf_SimplSwitch b
589     a <= b  = tagOf_SimplSwitch a _LE_ tagOf_SimplSwitch b
590
591
592 tagOf_SimplSwitch (SimplInlinePhase _)          = ILIT(1)
593 tagOf_SimplSwitch (MaxSimplifierIterations _)   = ILIT(2)
594 tagOf_SimplSwitch DontApplyRules                = ILIT(3)
595 tagOf_SimplSwitch SimplLetToCase                = ILIT(4)
596 tagOf_SimplSwitch NoCaseOfCase                  = ILIT(5)
597
598 -- If you add anything here, be sure to change lAST_SIMPL_SWITCH_TAG, too!
599
600 lAST_SIMPL_SWITCH_TAG = 5
601 \end{code}
602
603 %************************************************************************
604 %*                                                                      *
605 \subsection{Switch lookup}
606 %*                                                                      *
607 %************************************************************************
608
609 \begin{code}
610 isAmongSimpl :: [SimplifierSwitch] -> SimplifierSwitch -> SwitchResult
611
612 isAmongSimpl on_switches                -- Switches mentioned later occur *earlier*
613                                         -- in the list; defaults right at the end.
614   = let
615         tidied_on_switches = foldl rm_dups [] on_switches
616                 -- The fold*l* ensures that we keep the latest switches;
617                 -- ie the ones that occur earliest in the list.
618
619         sw_tbl :: Array Int SwitchResult
620         sw_tbl = (array (0, lAST_SIMPL_SWITCH_TAG) -- bounds...
621                         all_undefined)
622                  // defined_elems
623
624         all_undefined = [ (i, SwBool False) | i <- [0 .. lAST_SIMPL_SWITCH_TAG ] ]
625
626         defined_elems = map mk_assoc_elem tidied_on_switches
627     in
628     -- (avoid some unboxing, bounds checking, and other horrible things:)
629 #if __GLASGOW_HASKELL__ < 405
630     case sw_tbl of { Array bounds_who_needs_'em stuff ->
631 #else
632     case sw_tbl of { Array _ _ stuff ->
633 #endif
634     \ switch ->
635         case (indexArray# stuff (tagOf_SimplSwitch switch)) of
636 #if __GLASGOW_HASKELL__ < 400
637           Lift v -> v
638 #elif __GLASGOW_HASKELL__ < 403
639           (# _, v #) -> v
640 #else
641           (# v #) -> v
642 #endif
643     }
644   where
645     mk_assoc_elem k@(MaxSimplifierIterations lvl) = (IBOX(tagOf_SimplSwitch k), SwInt lvl)
646     mk_assoc_elem k@(SimplInlinePhase n)          = (IBOX(tagOf_SimplSwitch k), SwInt n)
647     mk_assoc_elem k                               = (IBOX(tagOf_SimplSwitch k), SwBool True) -- I'm here, Mom!
648
649     -- cannot have duplicates if we are going to use the array thing
650     rm_dups switches_so_far switch
651       = if switch `is_elem` switches_so_far
652         then switches_so_far
653         else switch : switches_so_far
654       where
655         sw `is_elem` []     = False
656         sw `is_elem` (s:ss) = (tagOf_SimplSwitch sw) _EQ_ (tagOf_SimplSwitch s)
657                             || sw `is_elem` ss
658 \end{code}
659
660 Default settings for simplifier switches
661
662 \begin{code}
663 defaultSimplSwitches = [MaxSimplifierIterations 1]
664 \end{code}
665
666 %************************************************************************
667 %*                                                                      *
668 \subsection{Misc functions for command-line options}
669 %*                                                                      *
670 %************************************************************************
671
672
673 \begin{code}
674 switchIsOn :: (switch -> SwitchResult) -> switch -> Bool
675
676 switchIsOn lookup_fn switch
677   = case (lookup_fn switch) of
678       SwBool False -> False
679       _            -> True
680
681 intSwitchSet :: (switch -> SwitchResult)
682              -> (Int -> switch)
683              -> Maybe Int
684
685 intSwitchSet lookup_fn switch
686   = case (lookup_fn (switch (panic "intSwitchSet"))) of
687       SwInt int -> Just int
688       _         -> Nothing
689 \end{code}
690
691 \begin{code}
692 startsWith :: String -> String -> Maybe String
693 -- startsWith pfx (pfx++rest) = Just rest
694
695 startsWith []     str = Just str
696 startsWith (c:cs) (s:ss)
697   = if c /= s then Nothing else startsWith cs ss
698 startsWith  _     []  = Nothing
699
700 endsWith  :: String -> String -> Maybe String
701 endsWith cs ss
702   = case (startsWith (reverse cs) (reverse ss)) of
703       Nothing -> Nothing
704       Just rs -> Just (reverse rs)
705 \end{code}