add -fsimpleopt-before-flatten
[ghc-hetmet.git] / compiler / main / DynFlags.hs
1 -- |
2 -- Dynamic flags
3 --
4 --
5 -- (c) The University of Glasgow 2005
6 --
7
8 -- Most flags are dynamic flags, which means they can change from
9 -- compilation to compilation using @OPTIONS_GHC@ pragmas, and in a
10 -- multi-session GHC each session can be using different dynamic
11 -- flags.  Dynamic flags can also be set at the prompt in GHCi.
12 module DynFlags (
13         -- * Dynamic flags and associated configuration types
14         DynFlag(..),
15         ExtensionFlag(..),
16         glasgowExtsFlags,
17         dopt,
18         dopt_set,
19         dopt_unset,
20         xopt,
21         xopt_set,
22         xopt_unset,
23         DynFlags(..),
24         RtsOptsEnabled(..),
25         HscTarget(..), isObjectTarget, defaultObjectTarget,
26         GhcMode(..), isOneShot,
27         GhcLink(..), isNoLink,
28         PackageFlag(..),
29         Option(..), showOpt,
30         DynLibLoader(..),
31         fFlags, fLangFlags, xFlags,
32         DPHBackend(..), dphPackageMaybe,
33         wayNames,
34
35         Settings(..),
36         ghcUsagePath, ghciUsagePath, topDir, tmpDir, rawSettings,
37         extraGccViaCFlags, systemPackageConfig,
38         pgm_L, pgm_P, pgm_F, pgm_c, pgm_s, pgm_a, pgm_l, pgm_dll, pgm_T,
39         pgm_sysman, pgm_windres, pgm_lo, pgm_lc,
40         opt_L, opt_P, opt_F, opt_c, opt_m, opt_a, opt_l,
41         opt_windres, opt_lo, opt_lc,
42
43
44         -- ** Manipulating DynFlags
45         defaultDynFlags,                -- Settings -> DynFlags
46         initDynFlags,                   -- DynFlags -> IO DynFlags
47
48         getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
49         getVerbFlags,
50         updOptLevel,
51         setTmpDir,
52         setPackageName,
53         doingTickyProfiling,
54
55         -- ** Parsing DynFlags
56         parseDynamicFlags,
57         parseDynamicNoPackageFlags,
58         allFlags,
59
60         supportedLanguagesAndExtensions,
61
62         -- ** DynFlag C compiler options
63         machdepCCOpts, picCCOpts,
64
65         -- * Configuration of the stg-to-stg passes
66         StgToDo(..),
67         getStgToDo,
68
69         -- * Compiler configuration suitable for display to the user
70         compilerInfo
71 #ifdef GHCI
72 -- Only in stage 2 can we be sure that the RTS 
73 -- exposes the appropriate runtime boolean
74         , rtsIsProfiled
75 #endif
76   ) where
77
78 #include "HsVersions.h"
79
80 #ifndef OMIT_NATIVE_CODEGEN
81 import Platform
82 #endif
83 import Module
84 import PackageConfig
85 import PrelNames        ( mAIN )
86 import StaticFlags
87 import {-# SOURCE #-} Packages (PackageState)
88 import DriverPhases     ( Phase(..), phaseInputExt )
89 import Config
90 import CmdLineParser
91 import Constants        ( mAX_CONTEXT_REDUCTION_DEPTH )
92 import Panic
93 import Util
94 import Maybes           ( orElse )
95 import SrcLoc
96 import FastString
97 import Outputable
98 #ifdef GHCI
99 import Foreign.C        ( CInt )
100 #endif
101 import {-# SOURCE #-} ErrUtils ( Severity(..), Message, mkLocMessage )
102
103 #ifdef GHCI
104 import System.IO.Unsafe ( unsafePerformIO )
105 #endif
106 import Data.IORef
107 import Control.Monad    ( when )
108
109 import Data.Char
110 import Data.List
111 import Data.Map (Map)
112 import qualified Data.Map as Map
113 -- import Data.Maybe
114 import System.FilePath
115 import System.IO        ( stderr, hPutChar )
116
117 -- -----------------------------------------------------------------------------
118 -- DynFlags
119
120 -- | Enumerates the simple on-or-off dynamic flags
121 data DynFlag
122
123    -- debugging flags
124    = Opt_D_dump_cmm
125    | Opt_D_dump_raw_cmm
126    | Opt_D_dump_cmmz
127    | Opt_D_dump_cmmz_pretty
128    | Opt_D_dump_cps_cmm
129    | Opt_D_dump_cvt_cmm
130    | Opt_D_dump_asm
131    | Opt_D_dump_asm_native
132    | Opt_D_dump_asm_liveness
133    | Opt_D_dump_asm_coalesce
134    | Opt_D_dump_asm_regalloc
135    | Opt_D_dump_asm_regalloc_stages
136    | Opt_D_dump_asm_conflicts
137    | Opt_D_dump_asm_stats
138    | Opt_D_dump_asm_expanded
139    | Opt_D_dump_llvm
140    | Opt_D_dump_core_stats
141    | Opt_D_dump_cpranal
142    | Opt_D_dump_deriv
143    | Opt_D_dump_ds
144    | Opt_D_dump_flatC
145    | Opt_D_dump_foreign
146    | Opt_D_dump_inlinings
147    | Opt_D_dump_rule_firings
148    | Opt_D_dump_rule_rewrites
149    | Opt_D_dump_occur_anal
150    | Opt_D_dump_parsed
151    | Opt_D_dump_rn
152    | Opt_D_dump_simpl
153    | Opt_D_dump_simpl_iterations
154    | Opt_D_dump_simpl_phases
155    | Opt_D_dump_spec
156    | Opt_D_dump_prep
157    | Opt_D_dump_stg
158    | Opt_D_dump_stranal
159    | Opt_D_dump_tc
160    | Opt_D_dump_types
161    | Opt_D_dump_rules
162    | Opt_D_dump_cse
163    | Opt_D_dump_worker_wrapper
164    | Opt_D_dump_rn_trace
165    | Opt_D_dump_rn_stats
166    | Opt_D_dump_opt_cmm
167    | Opt_D_dump_simpl_stats
168    | Opt_D_dump_cs_trace        -- Constraint solver in type checker
169    | Opt_D_dump_tc_trace
170    | Opt_D_dump_if_trace
171    | Opt_D_dump_vt_trace
172    | Opt_D_dump_splices
173    | Opt_D_dump_BCOs
174    | Opt_D_dump_vect
175    | Opt_D_dump_hpc
176    | Opt_D_dump_rtti
177    | Opt_D_source_stats
178    | Opt_D_verbose_core2core
179    | Opt_D_verbose_stg2stg
180    | Opt_D_dump_hi
181    | Opt_D_dump_hi_diffs
182    | Opt_D_dump_minimal_imports
183    | Opt_D_dump_mod_cycles
184    | Opt_D_dump_view_pattern_commoning
185    | Opt_D_faststring_stats
186    | Opt_DumpToFile                     -- ^ Append dump output to files instead of stdout.
187    | Opt_D_no_debug_output
188    | Opt_DoCoreLinting
189    | Opt_DoStgLinting
190    | Opt_DoCmmLinting
191    | Opt_DoAsmLinting
192
193    | Opt_F_coqpass                      -- run the core-to-core coqPass, but don't change anything (just "parse/unparse")
194    | Opt_F_skolemize                    -- run the core-to-core coqPass, skolemizing the proof
195    | Opt_F_flatten                      -- run the core-to-core coqPass, flattening the proof
196    | Opt_F_simpleopt_before_flatten     -- run the "simplPgmOpt" before the coqPass
197    | Opt_D_dump_proofs                  -- dump natural deduction typing proof of the coqpass input
198    | Opt_D_coqpass                      -- run the core-to-string coqPass and dumps the result
199
200    | Opt_WarnIsError                    -- -Werror; makes warnings fatal
201    | Opt_WarnDuplicateExports
202    | Opt_WarnHiShadows
203    | Opt_WarnImplicitPrelude
204    | Opt_WarnIncompletePatterns
205    | Opt_WarnIncompleteUniPatterns
206    | Opt_WarnIncompletePatternsRecUpd
207    | Opt_WarnMissingFields
208    | Opt_WarnMissingImportList
209    | Opt_WarnMissingMethods
210    | Opt_WarnMissingSigs
211    | Opt_WarnMissingLocalSigs
212    | Opt_WarnNameShadowing
213    | Opt_WarnOverlappingPatterns
214    | Opt_WarnTypeDefaults
215    | Opt_WarnMonomorphism
216    | Opt_WarnUnusedBinds
217    | Opt_WarnUnusedImports
218    | Opt_WarnUnusedMatches
219    | Opt_WarnWarningsDeprecations
220    | Opt_WarnDeprecatedFlags
221    | Opt_WarnDodgyExports
222    | Opt_WarnDodgyImports
223    | Opt_WarnOrphans
224    | Opt_WarnAutoOrphans
225    | Opt_WarnIdentities
226    | Opt_WarnTabs
227    | Opt_WarnUnrecognisedPragmas
228    | Opt_WarnDodgyForeignImports
229    | Opt_WarnLazyUnliftedBindings
230    | Opt_WarnUnusedDoBind
231    | Opt_WarnWrongDoBind
232    | Opt_WarnAlternativeLayoutRuleTransitional
233
234    | Opt_PrintExplicitForalls
235
236    -- optimisation opts
237    | Opt_Strictness
238    | Opt_FullLaziness
239    | Opt_FloatIn
240    | Opt_Specialise
241    | Opt_StaticArgumentTransformation
242    | Opt_CSE
243    | Opt_LiberateCase
244    | Opt_SpecConstr
245    | Opt_DoLambdaEtaExpansion
246    | Opt_IgnoreAsserts
247    | Opt_DoEtaReduction
248    | Opt_CaseMerge
249    | Opt_UnboxStrictFields
250    | Opt_MethodSharing  -- Now a no-op; remove in GHC 7.2
251    | Opt_DictsCheap
252    | Opt_EnableRewriteRules             -- Apply rewrite rules during simplification
253    | Opt_Vectorise
254    | Opt_RegsGraph                      -- do graph coloring register allocation
255    | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
256
257    -- Interface files
258    | Opt_IgnoreInterfacePragmas
259    | Opt_OmitInterfacePragmas
260    | Opt_ExposeAllUnfoldings
261
262    -- profiling opts
263    | Opt_AutoSccsOnAllToplevs
264    | Opt_AutoSccsOnExportedToplevs
265    | Opt_AutoSccsOnIndividualCafs
266
267    -- misc opts
268    | Opt_Pp
269    | Opt_ForceRecomp
270    | Opt_DryRun
271    | Opt_ExcessPrecision
272    | Opt_EagerBlackHoling
273    | Opt_ReadUserPackageConf
274    | Opt_NoHsMain
275    | Opt_SplitObjs
276    | Opt_StgStats
277    | Opt_HideAllPackages
278    | Opt_PrintBindResult
279    | Opt_Haddock
280    | Opt_HaddockOptions
281    | Opt_Hpc_No_Auto
282    | Opt_BreakOnException
283    | Opt_BreakOnError
284    | Opt_PrintEvldWithShow
285    | Opt_PrintBindContents
286    | Opt_GenManifest
287    | Opt_EmbedManifest
288    | Opt_EmitExternalCore
289    | Opt_SharedImplib
290    | Opt_BuildingCabalPackage
291    | Opt_SSE2
292    | Opt_GhciSandbox
293    | Opt_HelpfulErrors
294
295         -- temporary flags
296    | Opt_RunCPS
297    | Opt_RunCPSZ
298    | Opt_ConvertToZipCfgAndBack
299    | Opt_AutoLinkPackages
300    | Opt_ImplicitImportQualified
301    | Opt_TryNewCodeGen
302
303    -- keeping stuff
304    | Opt_KeepHiDiffs
305    | Opt_KeepHcFiles
306    | Opt_KeepSFiles
307    | Opt_KeepTmpFiles
308    | Opt_KeepRawTokenStream
309    | Opt_KeepLlvmFiles
310
311    deriving (Eq, Show)
312
313 data Language = Haskell98 | Haskell2010
314
315 data ExtensionFlag
316    = Opt_Cpp
317    | Opt_OverlappingInstances
318    | Opt_UndecidableInstances
319    | Opt_IncoherentInstances
320    | Opt_MonomorphismRestriction
321    | Opt_MonoPatBinds
322    | Opt_MonoLocalBinds
323    | Opt_RelaxedPolyRec         -- Deprecated
324    | Opt_ExtendedDefaultRules           -- Use GHC's extended rules for defaulting
325    | Opt_ForeignFunctionInterface
326    | Opt_UnliftedFFITypes
327    | Opt_GHCForeignImportPrim
328    | Opt_ParallelArrays                 -- Syntactic support for parallel arrays
329    | Opt_Arrows                         -- Arrow-notation syntax
330    | Opt_ModalTypes                     -- Heterogeneous Metaprogramming (modal types, brackets, escape, CSP)
331    | Opt_TemplateHaskell
332    | Opt_QuasiQuotes
333    | Opt_ImplicitParams
334    | Opt_Generics                       -- "Derivable type classes"
335    | Opt_ImplicitPrelude
336    | Opt_ScopedTypeVariables
337    | Opt_UnboxedTuples
338    | Opt_BangPatterns
339    | Opt_TypeFamilies
340    | Opt_OverloadedStrings
341    | Opt_DisambiguateRecordFields
342    | Opt_RecordWildCards
343    | Opt_RecordPuns
344    | Opt_ViewPatterns
345    | Opt_GADTs
346    | Opt_GADTSyntax
347    | Opt_NPlusKPatterns
348    | Opt_DoAndIfThenElse
349    | Opt_RebindableSyntax
350
351    | Opt_StandaloneDeriving
352    | Opt_DeriveDataTypeable
353    | Opt_DeriveFunctor
354    | Opt_DeriveTraversable
355    | Opt_DeriveFoldable
356
357    | Opt_TypeSynonymInstances
358    | Opt_FlexibleContexts
359    | Opt_FlexibleInstances
360    | Opt_ConstrainedClassMethods
361    | Opt_MultiParamTypeClasses
362    | Opt_FunctionalDependencies
363    | Opt_UnicodeSyntax
364    | Opt_PolymorphicComponents
365    | Opt_ExistentialQuantification
366    | Opt_MagicHash
367    | Opt_EmptyDataDecls
368    | Opt_KindSignatures
369    | Opt_ParallelListComp
370    | Opt_TransformListComp
371    | Opt_GeneralizedNewtypeDeriving
372    | Opt_RecursiveDo
373    | Opt_DoRec
374    | Opt_PostfixOperators
375    | Opt_TupleSections
376    | Opt_PatternGuards
377    | Opt_LiberalTypeSynonyms
378    | Opt_Rank2Types
379    | Opt_RankNTypes
380    | Opt_ImpredicativeTypes
381    | Opt_TypeOperators
382    | Opt_PackageImports
383    | Opt_ExplicitForAll
384    | Opt_AlternativeLayoutRule
385    | Opt_AlternativeLayoutRuleTransitional
386    | Opt_DatatypeContexts
387    | Opt_NondecreasingIndentation
388    | Opt_RelaxedLayout
389    deriving (Eq, Show)
390
391 -- | Contains not only a collection of 'DynFlag's but also a plethora of
392 -- information relating to the compilation of a single file or GHC session
393 data DynFlags = DynFlags {
394   ghcMode               :: GhcMode,
395   ghcLink               :: GhcLink,
396   hscTarget             :: HscTarget,
397   hscOutName            :: String,      -- ^ Name of the output file
398   extCoreName           :: String,      -- ^ Name of the .hcr output file
399   verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
400   optLevel              :: Int,         -- ^ Optimisation level
401   simplPhases           :: Int,         -- ^ Number of simplifier phases
402   maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
403   shouldDumpSimplPhase  :: Maybe String,
404   ruleCheck             :: Maybe String,
405   strictnessBefore      :: [Int],       -- ^ Additional demand analysis
406
407   specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
408   specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
409   liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
410   floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
411                                         --   See CoreMonad.FloatOutSwitches
412
413 #ifndef OMIT_NATIVE_CODEGEN
414   targetPlatform        :: Platform,    -- ^ The platform we're compiling for. Used by the NCG.
415 #endif
416   cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
417   importPaths           :: [FilePath],
418   mainModIs             :: Module,
419   mainFunIs             :: Maybe String,
420   ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
421
422   dphBackend            :: DPHBackend,
423
424   thisPackage           :: PackageId,   -- ^ name of package currently being compiled
425
426   -- ways
427   ways                  :: [Way],       -- ^ Way flags from the command line
428   buildTag              :: String,      -- ^ The global \"way\" (e.g. \"p\" for prof)
429   rtsBuildTag           :: String,      -- ^ The RTS \"way\"
430
431   -- For object splitting
432   splitInfo             :: Maybe (String,Int),
433
434   -- paths etc.
435   objectDir             :: Maybe String,
436   dylibInstallName      :: Maybe String,
437   hiDir                 :: Maybe String,
438   stubDir               :: Maybe String,
439
440   objectSuf             :: String,
441   hcSuf                 :: String,
442   hiSuf                 :: String,
443
444   outputFile            :: Maybe String,
445   outputHi              :: Maybe String,
446   dynLibLoader          :: DynLibLoader,
447
448   -- | This is set by 'DriverPipeline.runPipeline' based on where
449   --    its output is going.
450   dumpPrefix            :: Maybe FilePath,
451
452   -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
453   --    Set by @-ddump-file-prefix@
454   dumpPrefixForce       :: Maybe FilePath,
455
456   includePaths          :: [String],
457   libraryPaths          :: [String],
458   frameworkPaths        :: [String],    -- used on darwin only
459   cmdlineFrameworks     :: [String],    -- ditto
460
461   rtsOpts               :: Maybe String,
462   rtsOptsEnabled        :: RtsOptsEnabled,
463
464   hpcDir                :: String,      -- ^ Path to store the .mix files
465
466   settings              :: Settings,
467
468   --  For ghc -M
469   depMakefile           :: FilePath,
470   depIncludePkgDeps     :: Bool,
471   depExcludeMods        :: [ModuleName],
472   depSuffixes           :: [String],
473
474   --  Package flags
475   extraPkgConfs         :: [FilePath],
476         -- ^ The @-package-conf@ flags given on the command line, in the order
477         -- they appeared.
478
479   packageFlags          :: [PackageFlag],
480         -- ^ The @-package@ and @-hide-package@ flags from the command-line
481
482   -- Package state
483   -- NB. do not modify this field, it is calculated by
484   -- Packages.initPackages and Packages.updatePackages.
485   pkgDatabase           :: Maybe [PackageConfig],
486   pkgState              :: PackageState,
487
488   -- Temporary files
489   -- These have to be IORefs, because the defaultCleanupHandler needs to
490   -- know what to clean when an exception happens
491   filesToClean          :: IORef [FilePath],
492   dirsToClean           :: IORef (Map FilePath FilePath),
493
494   -- hsc dynamic flags
495   flags                 :: [DynFlag],
496   -- Don't change this without updating extensionFlags:
497   language              :: Maybe Language,
498   -- Don't change this without updating extensionFlags:
499   extensions            :: [OnOff ExtensionFlag],
500   -- extensionFlags should always be equal to
501   --     flattenExtensionFlags language extensions
502   extensionFlags        :: [ExtensionFlag],
503
504   -- | Message output action: use "ErrUtils" instead of this if you can
505   log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),
506
507   haddockOptions :: Maybe String
508  }
509
510 data Settings = Settings {
511   sGhcUsagePath          :: FilePath,    -- Filled in by SysTools
512   sGhciUsagePath         :: FilePath,    -- ditto
513   sTopDir                :: FilePath,
514   sTmpDir                :: String,      -- no trailing '/'
515   -- You shouldn't need to look things up in rawSettings directly.
516   -- They should have their own fields instead.
517   sRawSettings           :: [(String, String)],
518   sExtraGccViaCFlags     :: [String],
519   sSystemPackageConfig   :: FilePath,
520   -- commands for particular phases
521   sPgm_L                 :: String,
522   sPgm_P                 :: (String,[Option]),
523   sPgm_F                 :: String,
524   sPgm_c                 :: (String,[Option]),
525   sPgm_s                 :: (String,[Option]),
526   sPgm_a                 :: (String,[Option]),
527   sPgm_l                 :: (String,[Option]),
528   sPgm_dll               :: (String,[Option]),
529   sPgm_T                 :: String,
530   sPgm_sysman            :: String,
531   sPgm_windres           :: String,
532   sPgm_lo                :: (String,[Option]), -- LLVM: opt llvm optimiser
533   sPgm_lc                :: (String,[Option]), -- LLVM: llc static compiler
534   -- options for particular phases
535   sOpt_L                 :: [String],
536   sOpt_P                 :: [String],
537   sOpt_F                 :: [String],
538   sOpt_c                 :: [String],
539   sOpt_m                 :: [String],
540   sOpt_a                 :: [String],
541   sOpt_l                 :: [String],
542   sOpt_windres           :: [String],
543   sOpt_lo                :: [String], -- LLVM: llvm optimiser
544   sOpt_lc                :: [String]  -- LLVM: llc static compiler
545
546  }
547
548 ghcUsagePath          :: DynFlags -> FilePath
549 ghcUsagePath dflags = sGhcUsagePath (settings dflags)
550 ghciUsagePath         :: DynFlags -> FilePath
551 ghciUsagePath dflags = sGhciUsagePath (settings dflags)
552 topDir                :: DynFlags -> FilePath
553 topDir dflags = sTopDir (settings dflags)
554 tmpDir                :: DynFlags -> String
555 tmpDir dflags = sTmpDir (settings dflags)
556 rawSettings           :: DynFlags -> [(String, String)]
557 rawSettings dflags = sRawSettings (settings dflags)
558 extraGccViaCFlags     :: DynFlags -> [String]
559 extraGccViaCFlags dflags = sExtraGccViaCFlags (settings dflags)
560 systemPackageConfig   :: DynFlags -> FilePath
561 systemPackageConfig dflags = sSystemPackageConfig (settings dflags)
562 pgm_L                 :: DynFlags -> String
563 pgm_L dflags = sPgm_L (settings dflags)
564 pgm_P                 :: DynFlags -> (String,[Option])
565 pgm_P dflags = sPgm_P (settings dflags)
566 pgm_F                 :: DynFlags -> String
567 pgm_F dflags = sPgm_F (settings dflags)
568 pgm_c                 :: DynFlags -> (String,[Option])
569 pgm_c dflags = sPgm_c (settings dflags)
570 pgm_s                 :: DynFlags -> (String,[Option])
571 pgm_s dflags = sPgm_s (settings dflags)
572 pgm_a                 :: DynFlags -> (String,[Option])
573 pgm_a dflags = sPgm_a (settings dflags)
574 pgm_l                 :: DynFlags -> (String,[Option])
575 pgm_l dflags = sPgm_l (settings dflags)
576 pgm_dll               :: DynFlags -> (String,[Option])
577 pgm_dll dflags = sPgm_dll (settings dflags)
578 pgm_T                 :: DynFlags -> String
579 pgm_T dflags = sPgm_T (settings dflags)
580 pgm_sysman            :: DynFlags -> String
581 pgm_sysman dflags = sPgm_sysman (settings dflags)
582 pgm_windres           :: DynFlags -> String
583 pgm_windres dflags = sPgm_windres (settings dflags)
584 pgm_lo                :: DynFlags -> (String,[Option])
585 pgm_lo dflags = sPgm_lo (settings dflags)
586 pgm_lc                :: DynFlags -> (String,[Option])
587 pgm_lc dflags = sPgm_lc (settings dflags)
588 opt_L                 :: DynFlags -> [String]
589 opt_L dflags = sOpt_L (settings dflags)
590 opt_P                 :: DynFlags -> [String]
591 opt_P dflags = sOpt_P (settings dflags)
592 opt_F                 :: DynFlags -> [String]
593 opt_F dflags = sOpt_F (settings dflags)
594 opt_c                 :: DynFlags -> [String]
595 opt_c dflags = sOpt_c (settings dflags)
596 opt_m                 :: DynFlags -> [String]
597 opt_m dflags = sOpt_m (settings dflags)
598 opt_a                 :: DynFlags -> [String]
599 opt_a dflags = sOpt_a (settings dflags)
600 opt_l                 :: DynFlags -> [String]
601 opt_l dflags = sOpt_l (settings dflags)
602 opt_windres           :: DynFlags -> [String]
603 opt_windres dflags = sOpt_windres (settings dflags)
604 opt_lo                :: DynFlags -> [String]
605 opt_lo dflags = sOpt_lo (settings dflags)
606 opt_lc                :: DynFlags -> [String]
607 opt_lc dflags = sOpt_lc (settings dflags)
608
609 wayNames :: DynFlags -> [WayName]
610 wayNames = map wayName . ways
611
612 -- | The target code type of the compilation (if any).
613 --
614 -- Whenever you change the target, also make sure to set 'ghcLink' to
615 -- something sensible.
616 --
617 -- 'HscNothing' can be used to avoid generating any output, however, note
618 -- that:
619 --
620 --  * This will not run the desugaring step, thus no warnings generated in
621 --    this step will be output.  In particular, this includes warnings related
622 --    to pattern matching.  You can run the desugarer manually using
623 --    'GHC.desugarModule'.
624 --
625 --  * If a program uses Template Haskell the typechecker may try to run code
626 --    from an imported module.  This will fail if no code has been generated
627 --    for this module.  You can use 'GHC.needsTemplateHaskell' to detect
628 --    whether this might be the case and choose to either switch to a
629 --    different target or avoid typechecking such modules.  (The latter may
630 --    preferable for security reasons.)
631 --
632 data HscTarget
633   = HscC           -- ^ Generate C code.
634   | HscAsm         -- ^ Generate assembly using the native code generator.
635   | HscLlvm        -- ^ Generate assembly using the llvm code generator.
636   | HscJava        -- ^ Generate Java bytecode.
637   | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
638   | HscNothing     -- ^ Don't generate any code.  See notes above.
639   deriving (Eq, Show)
640
641 -- | Will this target result in an object file on the disk?
642 isObjectTarget :: HscTarget -> Bool
643 isObjectTarget HscC     = True
644 isObjectTarget HscAsm   = True
645 isObjectTarget HscLlvm  = True
646 isObjectTarget _        = False
647
648 -- | The 'GhcMode' tells us whether we're doing multi-module
649 -- compilation (controlled via the "GHC" API) or one-shot
650 -- (single-module) compilation.  This makes a difference primarily to
651 -- the "Finder": in one-shot mode we look for interface files for
652 -- imported modules, but in multi-module mode we look for source files
653 -- in order to check whether they need to be recompiled.
654 data GhcMode
655   = CompManager         -- ^ @\-\-make@, GHCi, etc.
656   | OneShot             -- ^ @ghc -c Foo.hs@
657   | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
658   deriving Eq
659
660 instance Outputable GhcMode where
661   ppr CompManager = ptext (sLit "CompManager")
662   ppr OneShot     = ptext (sLit "OneShot")
663   ppr MkDepend    = ptext (sLit "MkDepend")
664
665 isOneShot :: GhcMode -> Bool
666 isOneShot OneShot = True
667 isOneShot _other  = False
668
669 -- | What to do in the link step, if there is one.
670 data GhcLink
671   = NoLink              -- ^ Don't link at all
672   | LinkBinary          -- ^ Link object code into a binary
673   | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
674                         --   bytecode and object code).
675   | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
676   deriving (Eq, Show)
677
678 isNoLink :: GhcLink -> Bool
679 isNoLink NoLink = True
680 isNoLink _      = False
681
682 -- Is it worth evaluating this Bool and caching it in the DynFlags value
683 -- during initDynFlags?
684 doingTickyProfiling :: DynFlags -> Bool
685 doingTickyProfiling _ = opt_Ticky
686   -- XXX -ticky is a static flag, because it implies -debug which is also
687   -- static.  If the way flags were made dynamic, we could fix this.
688
689 data PackageFlag
690   = ExposePackage  String
691   | ExposePackageId String
692   | HidePackage    String
693   | IgnorePackage  String
694   deriving Eq
695
696 defaultHscTarget :: HscTarget
697 defaultHscTarget = defaultObjectTarget
698
699 -- | The 'HscTarget' value corresponding to the default way to create
700 -- object files on the current platform.
701 defaultObjectTarget :: HscTarget
702 defaultObjectTarget
703   | cGhcWithNativeCodeGen == "YES"      =  HscAsm
704   | otherwise                           =  HscC
705
706 data DynLibLoader
707   = Deployable
708   | SystemDependent
709   deriving Eq
710
711 data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll
712   deriving (Show)
713
714 -- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
715 initDynFlags :: DynFlags -> IO DynFlags
716 initDynFlags dflags = do
717  -- someday these will be dynamic flags
718  ways <- readIORef v_Ways
719  refFilesToClean <- newIORef []
720  refDirsToClean <- newIORef Map.empty
721  return dflags{
722         ways            = ways,
723         buildTag        = mkBuildTag (filter (not . wayRTSOnly) ways),
724         rtsBuildTag     = mkBuildTag ways,
725         filesToClean    = refFilesToClean,
726         dirsToClean     = refDirsToClean
727         }
728
729 -- | The normal 'DynFlags'. Note that they is not suitable for use in this form
730 -- and must be fully initialized by 'GHC.newSession' first.
731 defaultDynFlags :: Settings -> DynFlags
732 defaultDynFlags mySettings =
733      DynFlags {
734         ghcMode                 = CompManager,
735         ghcLink                 = LinkBinary,
736         hscTarget               = defaultHscTarget,
737         hscOutName              = "",
738         extCoreName             = "",
739         verbosity               = 0,
740         optLevel                = 0,
741         simplPhases             = 2,
742         maxSimplIterations      = 4,
743         shouldDumpSimplPhase    = Nothing,
744         ruleCheck               = Nothing,
745         specConstrThreshold     = Just 200,
746         specConstrCount         = Just 3,
747         liberateCaseThreshold   = Just 200,
748         floatLamArgs            = Just 0,       -- Default: float only if no fvs
749         strictnessBefore        = [],
750
751 #ifndef OMIT_NATIVE_CODEGEN
752         targetPlatform          = defaultTargetPlatform,
753 #endif
754         cmdlineHcIncludes       = [],
755         importPaths             = ["."],
756         mainModIs               = mAIN,
757         mainFunIs               = Nothing,
758         ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,
759
760         dphBackend              = DPHNone,
761
762         thisPackage             = mainPackageId,
763
764         objectDir               = Nothing,
765         dylibInstallName        = Nothing,
766         hiDir                   = Nothing,
767         stubDir                 = Nothing,
768
769         objectSuf               = phaseInputExt StopLn,
770         hcSuf                   = phaseInputExt HCc,
771         hiSuf                   = "hi",
772
773         outputFile              = Nothing,
774         outputHi                = Nothing,
775         dynLibLoader            = SystemDependent,
776         dumpPrefix              = Nothing,
777         dumpPrefixForce         = Nothing,
778         includePaths            = [],
779         libraryPaths            = [],
780         frameworkPaths          = [],
781         cmdlineFrameworks       = [],
782         rtsOpts                 = Nothing,
783         rtsOptsEnabled          = RtsOptsSafeOnly,
784
785         hpcDir                  = ".hpc",
786
787         extraPkgConfs           = [],
788         packageFlags            = [],
789         pkgDatabase             = Nothing,
790         pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
791         ways                    = panic "defaultDynFlags: No ways",
792         buildTag                = panic "defaultDynFlags: No buildTag",
793         rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
794         splitInfo               = Nothing,
795         settings                = mySettings,
796         -- ghc -M values
797         depMakefile       = "Makefile",
798         depIncludePkgDeps = False,
799         depExcludeMods    = [],
800         depSuffixes       = [],
801         -- end of ghc -M values
802         filesToClean   = panic "defaultDynFlags: No filesToClean",
803         dirsToClean    = panic "defaultDynFlags: No dirsToClean",
804         haddockOptions = Nothing,
805         flags = defaultFlags,
806         language = Nothing,
807         extensions = [],
808         extensionFlags = flattenExtensionFlags Nothing [],
809
810         log_action = \severity srcSpan style msg ->
811                         case severity of
812                           SevOutput -> printOutput (msg style)
813                           SevInfo   -> printErrs (msg style)
814                           SevFatal  -> printErrs (msg style)
815                           _         -> do 
816                                 hPutChar stderr '\n'
817                                 printErrs ((mkLocMessage srcSpan msg) style)
818                      -- careful (#2302): printErrs prints in UTF-8, whereas
819                      -- converting to string first and using hPutStr would
820                      -- just emit the low 8 bits of each unicode char.
821       }
822
823 {-
824 Note [Verbosity levels]
825 ~~~~~~~~~~~~~~~~~~~~~~~
826     0   |   print errors & warnings only
827     1   |   minimal verbosity: print "compiling M ... done." for each module.
828     2   |   equivalent to -dshow-passes
829     3   |   equivalent to existing "ghc -v"
830     4   |   "ghc -v -ddump-most"
831     5   |   "ghc -v -ddump-all"
832 -}
833
834 data OnOff a = On a
835              | Off a
836
837 -- OnOffs accumulate in reverse order, so we use foldr in order to
838 -- process them in the right order
839 flattenExtensionFlags :: Maybe Language -> [OnOff ExtensionFlag]
840                       -> [ExtensionFlag]
841 flattenExtensionFlags ml = foldr f defaultExtensionFlags
842     where f (On f)  flags = f : delete f flags
843           f (Off f) flags =     delete f flags
844           defaultExtensionFlags = languageExtensions ml
845
846 languageExtensions :: Maybe Language -> [ExtensionFlag]
847
848 languageExtensions Nothing
849     -- Nothing => the default case
850     = Opt_MonoPatBinds   -- Experimentally, I'm making this non-standard
851                          -- behaviour the default, to see if anyone notices
852                          -- SLPJ July 06
853       -- In due course I'd like Opt_MonoLocalBinds to be on by default
854       -- But NB it's implied by GADTs etc
855       -- SLPJ September 2010
856     : Opt_NondecreasingIndentation -- This has been on by default for some time
857     : languageExtensions (Just Haskell2010)
858
859 languageExtensions (Just Haskell98)
860     = [Opt_ImplicitPrelude,
861        Opt_MonomorphismRestriction,
862        Opt_NPlusKPatterns,
863        Opt_DatatypeContexts,
864        Opt_NondecreasingIndentation
865            -- strictly speaking non-standard, but we always had this
866            -- on implicitly before the option was added in 7.1, and
867            -- turning it off breaks code, so we're keeping it on for
868            -- backwards compatibility.  Cabal uses -XHaskell98 by
869            -- default unless you specify another language.
870       ]
871
872 languageExtensions (Just Haskell2010)
873     = [Opt_ImplicitPrelude,
874        Opt_MonomorphismRestriction,
875        Opt_DatatypeContexts,
876        Opt_EmptyDataDecls,
877        Opt_ForeignFunctionInterface,
878        Opt_PatternGuards,
879        Opt_DoAndIfThenElse,
880        Opt_RelaxedPolyRec]
881
882 -- | Test whether a 'DynFlag' is set
883 dopt :: DynFlag -> DynFlags -> Bool
884 dopt f dflags  = f `elem` (flags dflags)
885
886 -- | Set a 'DynFlag'
887 dopt_set :: DynFlags -> DynFlag -> DynFlags
888 dopt_set dfs f = dfs{ flags = f : flags dfs }
889
890 -- | Unset a 'DynFlag'
891 dopt_unset :: DynFlags -> DynFlag -> DynFlags
892 dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }
893
894 -- | Test whether a 'ExtensionFlag' is set
895 xopt :: ExtensionFlag -> DynFlags -> Bool
896 xopt f dflags = f `elem` extensionFlags dflags
897
898 -- | Set a 'ExtensionFlag'
899 xopt_set :: DynFlags -> ExtensionFlag -> DynFlags
900 xopt_set dfs f
901     = let onoffs = On f : extensions dfs
902       in dfs { extensions = onoffs,
903                extensionFlags = flattenExtensionFlags (language dfs) onoffs }
904
905 -- | Unset a 'ExtensionFlag'
906 xopt_unset :: DynFlags -> ExtensionFlag -> DynFlags
907 xopt_unset dfs f
908     = let onoffs = Off f : extensions dfs
909       in dfs { extensions = onoffs,
910                extensionFlags = flattenExtensionFlags (language dfs) onoffs }
911
912 setLanguage :: Language -> DynP ()
913 setLanguage l = upd f
914     where f dfs = let mLang = Just l
915                       oneoffs = extensions dfs
916                   in dfs {
917                          language = mLang,
918                          extensionFlags = flattenExtensionFlags mLang oneoffs
919                      }
920
921 -- | Retrieve the options corresponding to a particular @opt_*@ field in the correct order
922 getOpts :: DynFlags             -- ^ 'DynFlags' to retrieve the options from
923         -> (DynFlags -> [a])    -- ^ Relevant record accessor: one of the @opt_*@ accessors
924         -> [a]                  -- ^ Correctly ordered extracted options
925 getOpts dflags opts = reverse (opts dflags)
926         -- We add to the options from the front, so we need to reverse the list
927
928 -- | Gets the verbosity flag for the current verbosity level. This is fed to
929 -- other tools, so GHC-specific verbosity flags like @-ddump-most@ are not included
930 getVerbFlags :: DynFlags -> [String]
931 getVerbFlags dflags
932   | verbosity dflags >= 4 = ["-v"]
933   | otherwise             = []
934
935 setObjectDir, setHiDir, setStubDir, setOutputDir, setDylibInstallName,
936          setObjectSuf, setHiSuf, setHcSuf, parseDynLibLoaderMode,
937          setPgmP, addOptl, addOptP,
938          addCmdlineFramework, addHaddockOpts
939    :: String -> DynFlags -> DynFlags
940 setOutputFile, setOutputHi, setDumpPrefixForce
941    :: Maybe String -> DynFlags -> DynFlags
942
943 setObjectDir  f d = d{ objectDir  = Just f}
944 setHiDir      f d = d{ hiDir      = Just f}
945 setStubDir    f d = d{ stubDir    = Just f, includePaths = f : includePaths d }
946   -- -stubdir D adds an implicit -I D, so that gcc can find the _stub.h file
947   -- \#included from the .hc file when compiling via C (i.e. unregisterised
948   -- builds).
949 setOutputDir  f = setObjectDir f . setHiDir f . setStubDir f
950 setDylibInstallName  f d = d{ dylibInstallName = Just f}
951
952 setObjectSuf  f d = d{ objectSuf  = f}
953 setHiSuf      f d = d{ hiSuf      = f}
954 setHcSuf      f d = d{ hcSuf      = f}
955
956 setOutputFile f d = d{ outputFile = f}
957 setOutputHi   f d = d{ outputHi   = f}
958
959 parseDynLibLoaderMode f d =
960  case splitAt 8 f of
961    ("deploy", "")       -> d{ dynLibLoader = Deployable }
962    ("sysdep", "")       -> d{ dynLibLoader = SystemDependent }
963    _                    -> ghcError (CmdLineError ("Unknown dynlib loader: " ++ f))
964
965 setDumpPrefixForce f d = d { dumpPrefixForce = f}
966
967 -- XXX HACK: Prelude> words "'does not' work" ===> ["'does","not'","work"]
968 -- Config.hs should really use Option.
969 setPgmP   f = let (pgm:args) = words f in alterSettings (\s -> s { sPgm_P   = (pgm, map Option args)})
970 addOptl   f = alterSettings (\s -> s { sOpt_l   = f : sOpt_l s})
971 addOptP   f = alterSettings (\s -> s { sOpt_P   = f : sOpt_P s})
972
973
974 setDepMakefile :: FilePath -> DynFlags -> DynFlags
975 setDepMakefile f d = d { depMakefile = deOptDep f }
976
977 setDepIncludePkgDeps :: Bool -> DynFlags -> DynFlags
978 setDepIncludePkgDeps b d = d { depIncludePkgDeps = b }
979
980 addDepExcludeMod :: String -> DynFlags -> DynFlags
981 addDepExcludeMod m d
982     = d { depExcludeMods = mkModuleName (deOptDep m) : depExcludeMods d }
983
984 addDepSuffix :: FilePath -> DynFlags -> DynFlags
985 addDepSuffix s d = d { depSuffixes = deOptDep s : depSuffixes d }
986
987 -- XXX Legacy code:
988 -- We used to use "-optdep-flag -optdeparg", so for legacy applications
989 -- we need to strip the "-optdep" off of the arg
990 deOptDep :: String -> String
991 deOptDep x = case stripPrefix "-optdep" x of
992              Just rest -> rest
993              Nothing -> x
994
995 addCmdlineFramework f d = d{ cmdlineFrameworks = f : cmdlineFrameworks d}
996
997 addHaddockOpts f d = d{ haddockOptions = Just f}
998
999 -- -----------------------------------------------------------------------------
1000 -- Command-line options
1001
1002 -- | When invoking external tools as part of the compilation pipeline, we
1003 -- pass these a sequence of options on the command-line. Rather than
1004 -- just using a list of Strings, we use a type that allows us to distinguish
1005 -- between filepaths and 'other stuff'. The reason for this is that
1006 -- this type gives us a handle on transforming filenames, and filenames only,
1007 -- to whatever format they're expected to be on a particular platform.
1008 data Option
1009  = FileOption -- an entry that _contains_ filename(s) / filepaths.
1010               String  -- a non-filepath prefix that shouldn't be
1011                       -- transformed (e.g., "/out=")
1012               String  -- the filepath/filename portion
1013  | Option     String
1014
1015 showOpt :: Option -> String
1016 showOpt (FileOption pre f) = pre ++ f
1017 showOpt (Option s)  = s
1018
1019 -----------------------------------------------------------------------------
1020 -- Setting the optimisation level
1021
1022 updOptLevel :: Int -> DynFlags -> DynFlags
1023 -- ^ Sets the 'DynFlags' to be appropriate to the optimisation level
1024 updOptLevel n dfs
1025   = dfs2{ optLevel = final_n }
1026   where
1027    final_n = max 0 (min 2 n)    -- Clamp to 0 <= n <= 2
1028    dfs1 = foldr (flip dopt_unset) dfs  remove_dopts
1029    dfs2 = foldr (flip dopt_set)   dfs1 extra_dopts
1030
1031    extra_dopts  = [ f | (ns,f) <- optLevelFlags, final_n `elem` ns ]
1032    remove_dopts = [ f | (ns,f) <- optLevelFlags, final_n `notElem` ns ]
1033
1034 -- -----------------------------------------------------------------------------
1035 -- StgToDo:  abstraction of stg-to-stg passes to run.
1036
1037 data StgToDo
1038   = StgDoMassageForProfiling  -- should be (next to) last
1039   -- There's also setStgVarInfo, but its absolute "lastness"
1040   -- is so critical that it is hardwired in (no flag).
1041   | D_stg_stats
1042
1043 getStgToDo :: DynFlags -> [StgToDo]
1044 getStgToDo dflags
1045   = todo2
1046   where
1047         stg_stats = dopt Opt_StgStats dflags
1048
1049         todo1 = if stg_stats then [D_stg_stats] else []
1050
1051         todo2 | WayProf `elem` wayNames dflags
1052               = StgDoMassageForProfiling : todo1
1053               | otherwise
1054               = todo1
1055
1056 {- **********************************************************************
1057 %*                                                                      *
1058                 DynFlags parser
1059 %*                                                                      *
1060 %********************************************************************* -}
1061
1062 -- -----------------------------------------------------------------------------
1063 -- Parsing the dynamic flags.
1064
1065 -- | Parse dynamic flags from a list of command line arguments.  Returns the
1066 -- the parsed 'DynFlags', the left-over arguments, and a list of warnings.
1067 -- Throws a 'UsageError' if errors occurred during parsing (such as unknown
1068 -- flags or missing arguments).
1069 parseDynamicFlags :: Monad m =>
1070                      DynFlags -> [Located String]
1071                   -> m (DynFlags, [Located String], [Located String])
1072                      -- ^ Updated 'DynFlags', left-over arguments, and
1073                      -- list of warnings.
1074 parseDynamicFlags dflags args = parseDynamicFlags_ dflags args True
1075
1076 -- | Like 'parseDynamicFlags' but does not allow the package flags (-package,
1077 -- -hide-package, -ignore-package, -hide-all-packages, -package-conf).
1078 parseDynamicNoPackageFlags :: Monad m =>
1079                      DynFlags -> [Located String]
1080                   -> m (DynFlags, [Located String], [Located String])
1081                      -- ^ Updated 'DynFlags', left-over arguments, and
1082                      -- list of warnings.
1083 parseDynamicNoPackageFlags dflags args = parseDynamicFlags_ dflags args False
1084
1085 parseDynamicFlags_ :: Monad m =>
1086                       DynFlags -> [Located String] -> Bool
1087                   -> m (DynFlags, [Located String], [Located String])
1088 parseDynamicFlags_ dflags0 args pkg_flags = do
1089   -- XXX Legacy support code
1090   -- We used to accept things like
1091   --     optdep-f  -optdepdepend
1092   --     optdep-f  -optdep depend
1093   --     optdep -f -optdepdepend
1094   --     optdep -f -optdep depend
1095   -- but the spaces trip up proper argument handling. So get rid of them.
1096   let f (L p "-optdep" : L _ x : xs) = (L p ("-optdep" ++ x)) : f xs
1097       f (x : xs) = x : f xs
1098       f xs = xs
1099       args' = f args
1100
1101       -- Note: -ignore-package (package_flags) must precede -i* (dynamic_flags)
1102       flag_spec | pkg_flags = package_flags ++ dynamic_flags
1103                 | otherwise = dynamic_flags
1104
1105   let ((leftover, errs, warns), dflags1)
1106           = runCmdLine (processArgs flag_spec args') dflags0
1107   when (not (null errs)) $ ghcError $ errorsToGhcException errs
1108
1109   let (pic_warns, dflags2)
1110 #if !(x86_64_TARGET_ARCH && linux_TARGET_OS)
1111         | (not opt_Static || opt_PIC) && hscTarget dflags1 == HscLlvm
1112         = ([L noSrcSpan $ "Warning: -fllvm is incompatible with -fPIC and -"
1113                 ++ "dynamic on this platform;\n              ignoring -fllvm"],
1114                 dflags1{ hscTarget = HscAsm })
1115 #endif
1116         | otherwise = ([], dflags1)
1117
1118   return (dflags2, leftover, pic_warns ++ warns)
1119
1120
1121 {- **********************************************************************
1122 %*                                                                      *
1123                 DynFlags specifications
1124 %*                                                                      *
1125 %********************************************************************* -}
1126
1127 allFlags :: [String]
1128 allFlags = map ('-':) $
1129            [ flagName flag | flag <- dynamic_flags, ok (flagOptKind flag) ] ++
1130            map ("fno-"++) flags ++
1131            map ("f"++) flags ++
1132            map ("f"++) flags' ++
1133            map ("X"++) supportedExtensions
1134     where ok (PrefixPred _ _) = False
1135           ok _ = True
1136           flags = [ name | (name, _, _) <- fFlags ]
1137           flags' = [ name | (name, _, _) <- fLangFlags ]
1138
1139 --------------- The main flags themselves ------------------
1140 dynamic_flags :: [Flag (CmdLineP DynFlags)]
1141 dynamic_flags = [
1142     Flag "n"        (NoArg (setDynFlag Opt_DryRun))
1143   , Flag "cpp"      (NoArg (setExtensionFlag Opt_Cpp)) 
1144   , Flag "F"        (NoArg (setDynFlag Opt_Pp)) 
1145   , Flag "#include" 
1146          (HasArg (\s -> do { addCmdlineHCInclude s
1147                            ; addWarn "-#include and INCLUDE pragmas are deprecated: They no longer have any effect" }))
1148   , Flag "v"        (OptIntSuffix setVerbosity)
1149
1150         ------- Specific phases  --------------------------------------------
1151     -- need to appear before -pgmL to be parsed as LLVM flags.
1152   , Flag "pgmlo"          (hasArg (\f -> alterSettings (\s -> s { sPgm_lo  = (f,[])})))
1153   , Flag "pgmlc"          (hasArg (\f -> alterSettings (\s -> s { sPgm_lc  = (f,[])})))
1154   , Flag "pgmL"           (hasArg (\f -> alterSettings (\s -> s { sPgm_L   = f})))
1155   , Flag "pgmP"           (hasArg setPgmP)
1156   , Flag "pgmF"           (hasArg (\f -> alterSettings (\s -> s { sPgm_F   = f})))
1157   , Flag "pgmc"           (hasArg (\f -> alterSettings (\s -> s { sPgm_c   = (f,[])})))
1158   , Flag "pgmm"           (HasArg (\_ -> addWarn "The -keep-raw-s-files flag does nothing; it will be removed in a future GHC release"))
1159   , Flag "pgms"           (hasArg (\f -> alterSettings (\s -> s { sPgm_s   = (f,[])})))
1160   , Flag "pgma"           (hasArg (\f -> alterSettings (\s -> s { sPgm_a   = (f,[])})))
1161   , Flag "pgml"           (hasArg (\f -> alterSettings (\s -> s { sPgm_l   = (f,[])})))
1162   , Flag "pgmdll"         (hasArg (\f -> alterSettings (\s -> s { sPgm_dll = (f,[])})))
1163   , Flag "pgmwindres"     (hasArg (\f -> alterSettings (\s -> s { sPgm_windres = f})))
1164
1165     -- need to appear before -optl/-opta to be parsed as LLVM flags.
1166   , Flag "optlo"          (hasArg (\f -> alterSettings (\s -> s { sOpt_lo  = f : sOpt_lo s})))
1167   , Flag "optlc"          (hasArg (\f -> alterSettings (\s -> s { sOpt_lc  = f : sOpt_lc s})))
1168   , Flag "optL"           (hasArg (\f -> alterSettings (\s -> s { sOpt_L   = f : sOpt_L s})))
1169   , Flag "optP"           (hasArg addOptP)
1170   , Flag "optF"           (hasArg (\f -> alterSettings (\s -> s { sOpt_F   = f : sOpt_F s})))
1171   , Flag "optc"           (hasArg (\f -> alterSettings (\s -> s { sOpt_c   = f : sOpt_c s})))
1172   , Flag "optm"           (hasArg (\f -> alterSettings (\s -> s { sOpt_m   = f : sOpt_m s})))
1173   , Flag "opta"           (hasArg (\f -> alterSettings (\s -> s { sOpt_a   = f : sOpt_a s})))
1174   , Flag "optl"           (hasArg addOptl)
1175   , Flag "optwindres"     (hasArg (\f -> alterSettings (\s -> s { sOpt_windres = f : sOpt_windres s})))
1176
1177   , Flag "split-objs"
1178          (NoArg (if can_split 
1179                  then setDynFlag Opt_SplitObjs
1180                  else addWarn "ignoring -fsplit-objs"))
1181
1182         -------- ghc -M -----------------------------------------------------
1183   , Flag "dep-suffix"     (hasArg addDepSuffix)
1184   , Flag "optdep-s"       (hasArgDF addDepSuffix "Use -dep-suffix instead")
1185   , Flag "dep-makefile"   (hasArg setDepMakefile)
1186   , Flag "optdep-f"       (hasArgDF setDepMakefile "Use -dep-makefile instead")
1187   , Flag "optdep-w"       (NoArg  (deprecate "doesn't do anything"))
1188   , Flag "include-pkg-deps"         (noArg (setDepIncludePkgDeps True))
1189   , Flag "optdep--include-prelude"  (noArgDF (setDepIncludePkgDeps True) "Use -include-pkg-deps instead")
1190   , Flag "optdep--include-pkg-deps" (noArgDF (setDepIncludePkgDeps True) "Use -include-pkg-deps instead")
1191   , Flag "exclude-module"           (hasArg addDepExcludeMod)
1192   , Flag "optdep--exclude-module"   (hasArgDF addDepExcludeMod "Use -exclude-module instead")
1193   , Flag "optdep-x"                 (hasArgDF addDepExcludeMod "Use -exclude-module instead")
1194
1195         -------- Linking ----------------------------------------------------
1196   , Flag "no-link"            (noArg (\d -> d{ ghcLink=NoLink }))
1197   , Flag "shared"             (noArg (\d -> d{ ghcLink=LinkDynLib }))
1198   , Flag "dynload"            (hasArg parseDynLibLoaderMode)
1199   , Flag "dylib-install-name" (hasArg setDylibInstallName)
1200
1201         ------- Libraries ---------------------------------------------------
1202   , Flag "L"   (Prefix    addLibraryPath)
1203   , Flag "l"   (AnySuffix (upd . addOptl))
1204
1205         ------- Frameworks --------------------------------------------------
1206         -- -framework-path should really be -F ...
1207   , Flag "framework-path" (HasArg addFrameworkPath)
1208   , Flag "framework"      (hasArg addCmdlineFramework)
1209
1210         ------- Output Redirection ------------------------------------------
1211   , Flag "odir"              (hasArg setObjectDir)
1212   , Flag "o"                 (SepArg (upd . setOutputFile . Just))
1213   , Flag "ohi"               (hasArg (setOutputHi . Just ))
1214   , Flag "osuf"              (hasArg setObjectSuf)
1215   , Flag "hcsuf"             (hasArg setHcSuf)
1216   , Flag "hisuf"             (hasArg setHiSuf)
1217   , Flag "hidir"             (hasArg setHiDir)
1218   , Flag "tmpdir"            (hasArg setTmpDir)
1219   , Flag "stubdir"           (hasArg setStubDir)
1220   , Flag "outputdir"         (hasArg setOutputDir)
1221   , Flag "ddump-file-prefix" (hasArg (setDumpPrefixForce . Just))
1222
1223         ------- Keeping temporary files -------------------------------------
1224      -- These can be singular (think ghc -c) or plural (think ghc --make)
1225   , Flag "keep-hc-file"     (NoArg (setDynFlag Opt_KeepHcFiles))
1226   , Flag "keep-hc-files"    (NoArg (setDynFlag Opt_KeepHcFiles))
1227   , Flag "keep-s-file"      (NoArg (setDynFlag Opt_KeepSFiles))
1228   , Flag "keep-s-files"     (NoArg (setDynFlag Opt_KeepSFiles))
1229   , Flag "keep-raw-s-file"  (NoArg (addWarn "The -keep-raw-s-file flag does nothing; it will be removed in a future GHC release"))
1230   , Flag "keep-raw-s-files" (NoArg (addWarn "The -keep-raw-s-files flag does nothing; it will be removed in a future GHC release"))
1231   , Flag "keep-llvm-file"   (NoArg (setDynFlag Opt_KeepLlvmFiles))
1232   , Flag "keep-llvm-files"  (NoArg (setDynFlag Opt_KeepLlvmFiles))
1233      -- This only makes sense as plural
1234   , Flag "keep-tmp-files"   (NoArg (setDynFlag Opt_KeepTmpFiles))
1235
1236         ------- Miscellaneous ----------------------------------------------
1237   , Flag "no-auto-link-packages" (NoArg (unSetDynFlag Opt_AutoLinkPackages))
1238   , Flag "no-hs-main"     (NoArg (setDynFlag Opt_NoHsMain))
1239   , Flag "with-rtsopts"   (HasArg setRtsOpts)
1240   , Flag "rtsopts"        (NoArg (setRtsOptsEnabled RtsOptsAll))
1241   , Flag "rtsopts=all"    (NoArg (setRtsOptsEnabled RtsOptsAll))
1242   , Flag "rtsopts=some"   (NoArg (setRtsOptsEnabled RtsOptsSafeOnly))
1243   , Flag "rtsopts=none"   (NoArg (setRtsOptsEnabled RtsOptsNone))
1244   , Flag "no-rtsopts"     (NoArg (setRtsOptsEnabled RtsOptsNone))
1245   , Flag "main-is"        (SepArg setMainIs)
1246   , Flag "haddock"        (NoArg (setDynFlag Opt_Haddock))
1247   , Flag "haddock-opts"   (hasArg addHaddockOpts)
1248   , Flag "hpcdir"         (SepArg setOptHpcDir)
1249
1250         ------- recompilation checker --------------------------------------
1251   , Flag "recomp"         (NoArg (do { unSetDynFlag Opt_ForceRecomp
1252                                      ; deprecate "Use -fno-force-recomp instead" }))
1253   , Flag "no-recomp"      (NoArg (do { setDynFlag Opt_ForceRecomp
1254                                      ; deprecate "Use -fforce-recomp instead" }))
1255
1256         ------ HsCpp opts ---------------------------------------------------
1257   , Flag "D"              (AnySuffix (upd . addOptP))
1258   , Flag "U"              (AnySuffix (upd . addOptP))
1259
1260         ------- Include/Import Paths ----------------------------------------
1261   , Flag "I"              (Prefix    addIncludePath)
1262   , Flag "i"              (OptPrefix addImportPath)
1263
1264         ------ Debugging ----------------------------------------------------
1265   , Flag "dstg-stats"     (NoArg (setDynFlag Opt_StgStats))
1266
1267   , Flag "ddump-cmm"               (setDumpFlag Opt_D_dump_cmm)
1268   , Flag "ddump-raw-cmm"           (setDumpFlag Opt_D_dump_raw_cmm)
1269   , Flag "ddump-cmmz"              (setDumpFlag Opt_D_dump_cmmz)
1270   , Flag "ddump-cmmz-pretty"       (setDumpFlag Opt_D_dump_cmmz_pretty)
1271   , Flag "ddump-core-stats"        (setDumpFlag Opt_D_dump_core_stats)
1272   , Flag "ddump-cps-cmm"           (setDumpFlag Opt_D_dump_cps_cmm)
1273   , Flag "ddump-cvt-cmm"           (setDumpFlag Opt_D_dump_cvt_cmm)
1274   , Flag "ddump-asm"               (setDumpFlag Opt_D_dump_asm)
1275   , Flag "ddump-asm-native"        (setDumpFlag Opt_D_dump_asm_native)
1276   , Flag "ddump-asm-liveness"      (setDumpFlag Opt_D_dump_asm_liveness)
1277   , Flag "ddump-asm-coalesce"      (setDumpFlag Opt_D_dump_asm_coalesce)
1278   , Flag "ddump-asm-regalloc"      (setDumpFlag Opt_D_dump_asm_regalloc)
1279   , Flag "ddump-asm-conflicts"     (setDumpFlag Opt_D_dump_asm_conflicts)
1280   , Flag "ddump-asm-regalloc-stages" (setDumpFlag Opt_D_dump_asm_regalloc_stages)
1281   , Flag "ddump-asm-stats"         (setDumpFlag Opt_D_dump_asm_stats)
1282   , Flag "ddump-asm-expanded"      (setDumpFlag Opt_D_dump_asm_expanded)
1283   , Flag "ddump-llvm"              (NoArg (do { setObjTarget HscLlvm
1284                                               ; setDumpFlag' Opt_D_dump_llvm}))
1285   , Flag "ddump-cpranal"           (setDumpFlag Opt_D_dump_cpranal)
1286   , Flag "ddump-deriv"             (setDumpFlag Opt_D_dump_deriv)
1287   , Flag "ddump-ds"                (setDumpFlag Opt_D_dump_ds)
1288   , Flag "ddump-flatC"             (setDumpFlag Opt_D_dump_flatC)
1289   , Flag "ddump-foreign"           (setDumpFlag Opt_D_dump_foreign)
1290   , Flag "ddump-inlinings"         (setDumpFlag Opt_D_dump_inlinings)
1291   , Flag "ddump-rule-firings"      (setDumpFlag Opt_D_dump_rule_firings)
1292   , Flag "ddump-rule-rewrites"     (setDumpFlag Opt_D_dump_rule_rewrites)
1293   , Flag "ddump-occur-anal"        (setDumpFlag Opt_D_dump_occur_anal)
1294   , Flag "ddump-parsed"            (setDumpFlag Opt_D_dump_parsed)
1295   , Flag "ddump-rn"                (setDumpFlag Opt_D_dump_rn)
1296   , Flag "ddump-simpl"             (setDumpFlag Opt_D_dump_simpl)
1297   , Flag "ddump-simpl-iterations"  (setDumpFlag Opt_D_dump_simpl_iterations)
1298   , Flag "ddump-simpl-phases"      (OptPrefix setDumpSimplPhases)
1299   , Flag "ddump-spec"              (setDumpFlag Opt_D_dump_spec)
1300   , Flag "ddump-prep"              (setDumpFlag Opt_D_dump_prep)
1301   , Flag "ddump-stg"               (setDumpFlag Opt_D_dump_stg)
1302   , Flag "ddump-stranal"           (setDumpFlag Opt_D_dump_stranal)
1303   , Flag "ddump-tc"                (setDumpFlag Opt_D_dump_tc)
1304   , Flag "ddump-types"             (setDumpFlag Opt_D_dump_types)
1305   , Flag "ddump-rules"             (setDumpFlag Opt_D_dump_rules)
1306   , Flag "ddump-cse"               (setDumpFlag Opt_D_dump_cse)
1307   , Flag "ddump-worker-wrapper"    (setDumpFlag Opt_D_dump_worker_wrapper)
1308   , Flag "ddump-rn-trace"          (setDumpFlag Opt_D_dump_rn_trace)
1309   , Flag "ddump-if-trace"          (setDumpFlag Opt_D_dump_if_trace)
1310   , Flag "ddump-cs-trace"          (setDumpFlag Opt_D_dump_cs_trace)
1311   , Flag "ddump-tc-trace"          (setDumpFlag Opt_D_dump_tc_trace)
1312   , Flag "ddump-vt-trace"          (setDumpFlag Opt_D_dump_vt_trace)
1313   , Flag "ddump-splices"           (setDumpFlag Opt_D_dump_splices)
1314   , Flag "ddump-rn-stats"          (setDumpFlag Opt_D_dump_rn_stats)
1315   , Flag "ddump-opt-cmm"           (setDumpFlag Opt_D_dump_opt_cmm)
1316   , Flag "ddump-simpl-stats"       (setDumpFlag Opt_D_dump_simpl_stats)
1317   , Flag "ddump-bcos"              (setDumpFlag Opt_D_dump_BCOs)
1318   , Flag "dsource-stats"           (setDumpFlag Opt_D_source_stats)
1319   , Flag "dverbose-core2core"      (NoArg (do { setVerbosity (Just 2)
1320                                               ; setVerboseCore2Core }))
1321   , Flag "dverbose-stg2stg"        (setDumpFlag Opt_D_verbose_stg2stg)
1322   , Flag "ddump-hi"                (setDumpFlag Opt_D_dump_hi)
1323   , Flag "ddump-minimal-imports"   (setDumpFlag Opt_D_dump_minimal_imports)
1324   , Flag "ddump-vect"              (setDumpFlag Opt_D_dump_vect)
1325   , Flag "ddump-hpc"               (setDumpFlag Opt_D_dump_hpc)
1326   , Flag "ddump-mod-cycles"        (setDumpFlag Opt_D_dump_mod_cycles)
1327   , Flag "ddump-view-pattern-commoning" (setDumpFlag Opt_D_dump_view_pattern_commoning)
1328   , Flag "ddump-to-file"           (setDumpFlag Opt_DumpToFile)
1329   , Flag "ddump-hi-diffs"          (setDumpFlag Opt_D_dump_hi_diffs)
1330   , Flag "ddump-rtti"              (setDumpFlag Opt_D_dump_rtti)
1331   , Flag "dcore-lint"              (NoArg (setDynFlag Opt_DoCoreLinting))
1332   , Flag "dstg-lint"               (NoArg (setDynFlag Opt_DoStgLinting))
1333   , Flag "dcmm-lint"               (NoArg (setDynFlag Opt_DoCmmLinting))
1334   , Flag "dasm-lint"               (NoArg (setDynFlag Opt_DoAsmLinting))
1335   , Flag "dshow-passes"            (NoArg (do forceRecompile
1336                                               setVerbosity (Just 2)))
1337   , Flag "dfaststring-stats"       (NoArg (setDynFlag Opt_D_faststring_stats))
1338
1339         ------ Coq-in-GHC ---------------------------
1340   , Flag "ddump-proofs"            (NoArg (setDynFlag Opt_D_dump_proofs))
1341   , Flag "ddump-coqpass"           (NoArg (setDynFlag Opt_D_coqpass))
1342   , Flag "fcoqpass"                (NoArg (setDynFlag Opt_F_coqpass))
1343   , Flag "fsimpleopt-before-flatten"                (NoArg (setDynFlag Opt_F_simpleopt_before_flatten))
1344   , Flag "fflatten"                (NoArg (do { setDynFlag Opt_F_coqpass ; setDynFlag Opt_F_flatten }))
1345   , Flag "funsafe-skolemize"       (NoArg (do { setDynFlag Opt_F_coqpass ; setDynFlag Opt_F_flatten ; setDynFlag Opt_F_skolemize }))
1346
1347         ------ Machine dependant (-m<blah>) stuff ---------------------------
1348
1349   , Flag "monly-2-regs" (NoArg (addWarn "The -monly-2-regs flag does nothing; it will be removed in a future GHC release"))
1350   , Flag "monly-3-regs" (NoArg (addWarn "The -monly-3-regs flag does nothing; it will be removed in a future GHC release"))
1351   , Flag "monly-4-regs" (NoArg (addWarn "The -monly-4-regs flag does nothing; it will be removed in a future GHC release"))
1352   , Flag "msse2"        (NoArg (setDynFlag Opt_SSE2))
1353
1354      ------ Warning opts -------------------------------------------------
1355   , Flag "W"      (NoArg (mapM_ setDynFlag   minusWOpts))
1356   , Flag "Werror" (NoArg (setDynFlag         Opt_WarnIsError))
1357   , Flag "Wwarn"  (NoArg (unSetDynFlag       Opt_WarnIsError))
1358   , Flag "Wall"   (NoArg (mapM_ setDynFlag   minusWallOpts))
1359   , Flag "Wnot"   (NoArg (do { mapM_ unSetDynFlag minusWallOpts
1360                              ; deprecate "Use -w instead" }))
1361   , Flag "w"      (NoArg (mapM_ unSetDynFlag minuswRemovesOpts))
1362
1363         ------ Optimisation flags ------------------------------------------
1364   , Flag "O"      (noArg (setOptLevel 1))
1365   , Flag "Onot"   (noArgDF (setOptLevel 0) "Use -O0 instead")
1366   , Flag "Odph"   (noArg setDPHOpt)
1367   , Flag "O"      (OptIntSuffix (\mb_n -> upd (setOptLevel (mb_n `orElse` 1))))
1368                 -- If the number is missing, use 1
1369
1370   , Flag "fsimplifier-phases"          (intSuffix (\n d -> d{ simplPhases = n }))
1371   , Flag "fmax-simplifier-iterations"  (intSuffix (\n d -> d{ maxSimplIterations = n }))
1372   , Flag "fspec-constr-threshold"      (intSuffix (\n d -> d{ specConstrThreshold = Just n }))
1373   , Flag "fno-spec-constr-threshold"   (noArg (\d -> d{ specConstrThreshold = Nothing }))
1374   , Flag "fspec-constr-count"          (intSuffix (\n d -> d{ specConstrCount = Just n }))
1375   , Flag "fno-spec-constr-count"       (noArg (\d -> d{ specConstrCount = Nothing }))
1376   , Flag "fliberate-case-threshold"    (intSuffix (\n d -> d{ liberateCaseThreshold = Just n }))
1377   , Flag "fno-liberate-case-threshold" (noArg (\d -> d{ liberateCaseThreshold = Nothing }))
1378   , Flag "frule-check"                 (SepArg (\s -> upd (\d -> d{ ruleCheck = Just s })))
1379   , Flag "fcontext-stack"              (intSuffix (\n d -> d{ ctxtStkDepth = n }))
1380   , Flag "fstrictness-before"          (intSuffix (\n d -> d{ strictnessBefore = n : strictnessBefore d }))
1381   , Flag "ffloat-lam-args"             (intSuffix (\n d -> d{ floatLamArgs = Just n }))
1382   , Flag "ffloat-all-lams"             (noArg (\d -> d{ floatLamArgs = Nothing }))
1383
1384         ------ Profiling ----------------------------------------------------
1385
1386   -- XXX Should the -f* flags be deprecated?
1387   -- They don't seem to be documented
1388   , Flag "fauto-sccs-on-all-toplevs"       (NoArg (setDynFlag Opt_AutoSccsOnAllToplevs))
1389   , Flag "auto-all"                        (NoArg (setDynFlag Opt_AutoSccsOnAllToplevs))
1390   , Flag "no-auto-all"                     (NoArg (unSetDynFlag Opt_AutoSccsOnAllToplevs))
1391   , Flag "fauto-sccs-on-exported-toplevs"  (NoArg (setDynFlag Opt_AutoSccsOnExportedToplevs))
1392   , Flag "auto"                            (NoArg (setDynFlag Opt_AutoSccsOnExportedToplevs))
1393   , Flag "no-auto"                         (NoArg (unSetDynFlag Opt_AutoSccsOnExportedToplevs))
1394   , Flag "fauto-sccs-on-individual-cafs"   (NoArg (setDynFlag Opt_AutoSccsOnIndividualCafs))
1395   , Flag "caf-all"                         (NoArg (setDynFlag Opt_AutoSccsOnIndividualCafs))
1396   , Flag "no-caf-all"                      (NoArg (unSetDynFlag Opt_AutoSccsOnIndividualCafs))
1397
1398         ------ DPH flags ----------------------------------------------------
1399
1400   , Flag "fdph-seq"         (NoArg (setDPHBackend DPHSeq))
1401   , Flag "fdph-par"         (NoArg (setDPHBackend DPHPar))
1402   , Flag "fdph-this"        (NoArg (setDPHBackend DPHThis))
1403   , Flag "fdph-none"        (NoArg (setDPHBackend DPHNone))
1404
1405         ------ Compiler flags -----------------------------------------------
1406
1407   , Flag "fasm"             (NoArg (setObjTarget HscAsm))
1408   , Flag "fvia-c"           (NoArg
1409          (addWarn "The -fvia-c flag does nothing; it will be removed in a future GHC release"))
1410   , Flag "fvia-C"           (NoArg
1411          (addWarn "The -fvia-C flag does nothing; it will be removed in a future GHC release"))
1412   , Flag "fllvm"            (NoArg (setObjTarget HscLlvm))
1413
1414   , Flag "fno-code"         (NoArg (do upd $ \d -> d{ ghcLink=NoLink }
1415                                        setTarget HscNothing))
1416   , Flag "fbyte-code"       (NoArg (setTarget HscInterpreted))
1417   , Flag "fobject-code"     (NoArg (setTarget defaultHscTarget))
1418   , Flag "fglasgow-exts"    (NoArg (enableGlasgowExts >> deprecate "Use individual extensions instead"))
1419   , Flag "fno-glasgow-exts" (NoArg (disableGlasgowExts >> deprecate "Use individual extensions instead"))
1420  ]
1421  ++ map (mkFlag turnOn  "f"    setDynFlag  ) fFlags
1422  ++ map (mkFlag turnOff "fno-" unSetDynFlag) fFlags
1423  ++ map (mkFlag turnOn  "f"    setExtensionFlag  ) fLangFlags
1424  ++ map (mkFlag turnOff "fno-" unSetExtensionFlag) fLangFlags
1425  ++ map (mkFlag turnOn  "X"    setExtensionFlag  ) xFlags
1426  ++ map (mkFlag turnOff "XNo"  unSetExtensionFlag) xFlags
1427  ++ map (mkFlag turnOn  "X"    setLanguage) languageFlags
1428
1429 package_flags :: [Flag (CmdLineP DynFlags)]
1430 package_flags = [
1431         ------- Packages ----------------------------------------------------
1432     Flag "package-conf"         (HasArg extraPkgConf_)
1433   , Flag "no-user-package-conf" (NoArg (unSetDynFlag Opt_ReadUserPackageConf))
1434   , Flag "package-name"         (hasArg setPackageName)
1435   , Flag "package-id"           (HasArg exposePackageId)
1436   , Flag "package"              (HasArg exposePackage)
1437   , Flag "hide-package"         (HasArg hidePackage)
1438   , Flag "hide-all-packages"    (NoArg (setDynFlag Opt_HideAllPackages))
1439   , Flag "ignore-package"       (HasArg ignorePackage)
1440   , Flag "syslib"               (HasArg (\s -> do { exposePackage s
1441                                                   ; deprecate "Use -package instead" }))
1442   ]
1443
1444 type TurnOnFlag = Bool   -- True  <=> we are turning the flag on
1445                          -- False <=> we are turning the flag off
1446 turnOn  :: TurnOnFlag; turnOn = True
1447 turnOff :: TurnOnFlag; turnOff = False
1448
1449 type FlagSpec flag
1450    = ( String   -- Flag in string form
1451      , flag     -- Flag in internal form
1452      , TurnOnFlag -> DynP ())    -- Extra action to run when the flag is found
1453                                  -- Typically, emit a warning or error
1454
1455 mkFlag :: TurnOnFlag            -- ^ True <=> it should be turned on
1456        -> String                -- ^ The flag prefix
1457        -> (flag -> DynP ())     -- ^ What to do when the flag is found
1458        -> FlagSpec flag         -- ^ Specification of this particular flag
1459        -> Flag (CmdLineP DynFlags)
1460 mkFlag turn_on flagPrefix f (name, flag, extra_action)
1461     = Flag (flagPrefix ++ name) (NoArg (f flag >> extra_action turn_on))
1462
1463 deprecatedForExtension :: String -> TurnOnFlag -> DynP ()
1464 deprecatedForExtension lang turn_on
1465     = deprecate ("use -X"  ++ flag ++ " or pragma {-# LANGUAGE " ++ flag ++ " #-} instead")
1466     where 
1467       flag | turn_on    = lang
1468            | otherwise = "No"++lang
1469
1470 useInstead :: String -> TurnOnFlag -> DynP ()
1471 useInstead flag turn_on
1472   = deprecate ("Use -f" ++ no ++ flag ++ " instead")
1473   where
1474     no = if turn_on then "" else "no-"
1475
1476 nop :: TurnOnFlag -> DynP ()
1477 nop _ = return ()
1478
1479 -- | These @-f\<blah\>@ flags can all be reversed with @-fno-\<blah\>@
1480 fFlags :: [FlagSpec DynFlag]
1481 fFlags = [
1482   ( "warn-dodgy-foreign-imports",       Opt_WarnDodgyForeignImports, nop ),
1483   ( "warn-dodgy-exports",               Opt_WarnDodgyExports, nop ),
1484   ( "warn-dodgy-imports",               Opt_WarnDodgyImports, nop ),
1485   ( "warn-duplicate-exports",           Opt_WarnDuplicateExports, nop ),
1486   ( "warn-hi-shadowing",                Opt_WarnHiShadows, nop ),
1487   ( "warn-implicit-prelude",            Opt_WarnImplicitPrelude, nop ),
1488   ( "warn-incomplete-patterns",         Opt_WarnIncompletePatterns, nop ),
1489   ( "warn-incomplete-uni-patterns",     Opt_WarnIncompleteUniPatterns, nop ),
1490   ( "warn-incomplete-record-updates",   Opt_WarnIncompletePatternsRecUpd, nop ),
1491   ( "warn-missing-fields",              Opt_WarnMissingFields, nop ),
1492   ( "warn-missing-import-lists",        Opt_WarnMissingImportList, nop ),
1493   ( "warn-missing-methods",             Opt_WarnMissingMethods, nop ),
1494   ( "warn-missing-signatures",          Opt_WarnMissingSigs, nop ),
1495   ( "warn-missing-local-sigs",          Opt_WarnMissingLocalSigs, nop ),
1496   ( "warn-name-shadowing",              Opt_WarnNameShadowing, nop ),
1497   ( "warn-overlapping-patterns",        Opt_WarnOverlappingPatterns, nop ),
1498   ( "warn-type-defaults",               Opt_WarnTypeDefaults, nop ),
1499   ( "warn-monomorphism-restriction",    Opt_WarnMonomorphism, nop ),
1500   ( "warn-unused-binds",                Opt_WarnUnusedBinds, nop ),
1501   ( "warn-unused-imports",              Opt_WarnUnusedImports, nop ),
1502   ( "warn-unused-matches",              Opt_WarnUnusedMatches, nop ),
1503   ( "warn-warnings-deprecations",       Opt_WarnWarningsDeprecations, nop ),
1504   ( "warn-deprecations",                Opt_WarnWarningsDeprecations, nop ),
1505   ( "warn-deprecated-flags",            Opt_WarnDeprecatedFlags, nop ),
1506   ( "warn-orphans",                     Opt_WarnOrphans, nop ),
1507   ( "warn-identities",                  Opt_WarnIdentities, nop ),
1508   ( "warn-auto-orphans",                Opt_WarnAutoOrphans, nop ),
1509   ( "warn-tabs",                        Opt_WarnTabs, nop ),
1510   ( "warn-unrecognised-pragmas",        Opt_WarnUnrecognisedPragmas, nop ),
1511   ( "warn-lazy-unlifted-bindings",      Opt_WarnLazyUnliftedBindings, nop),
1512   ( "warn-unused-do-bind",              Opt_WarnUnusedDoBind, nop ),
1513   ( "warn-wrong-do-bind",               Opt_WarnWrongDoBind, nop ),
1514   ( "warn-alternative-layout-rule-transitional", Opt_WarnAlternativeLayoutRuleTransitional, nop ),
1515   ( "print-explicit-foralls",           Opt_PrintExplicitForalls, nop ),
1516   ( "strictness",                       Opt_Strictness, nop ),
1517   ( "specialise",                       Opt_Specialise, nop ),
1518   ( "float-in",                         Opt_FloatIn, nop ),
1519   ( "static-argument-transformation",   Opt_StaticArgumentTransformation, nop ),
1520   ( "full-laziness",                    Opt_FullLaziness, nop ),
1521   ( "liberate-case",                    Opt_LiberateCase, nop ),
1522   ( "spec-constr",                      Opt_SpecConstr, nop ),
1523   ( "cse",                              Opt_CSE, nop ),
1524   ( "ignore-interface-pragmas",         Opt_IgnoreInterfacePragmas, nop ),
1525   ( "omit-interface-pragmas",           Opt_OmitInterfacePragmas, nop ),
1526   ( "expose-all-unfoldings",            Opt_ExposeAllUnfoldings, nop ),
1527   ( "do-lambda-eta-expansion",          Opt_DoLambdaEtaExpansion, nop ),
1528   ( "ignore-asserts",                   Opt_IgnoreAsserts, nop ),
1529   ( "do-eta-reduction",                 Opt_DoEtaReduction, nop ),
1530   ( "case-merge",                       Opt_CaseMerge, nop ),
1531   ( "unbox-strict-fields",              Opt_UnboxStrictFields, nop ),
1532   ( "method-sharing",                   Opt_MethodSharing, 
1533      \_ -> deprecate "doesn't do anything any more"),
1534      -- Remove altogether in GHC 7.2
1535   ( "dicts-cheap",                      Opt_DictsCheap, nop ),
1536   ( "excess-precision",                 Opt_ExcessPrecision, nop ),
1537   ( "eager-blackholing",                Opt_EagerBlackHoling, nop ),
1538   ( "print-bind-result",                Opt_PrintBindResult, nop ),
1539   ( "force-recomp",                     Opt_ForceRecomp, nop ),
1540   ( "hpc-no-auto",                      Opt_Hpc_No_Auto, nop ),
1541   ( "rewrite-rules",                    Opt_EnableRewriteRules, useInstead "enable-rewrite-rules" ),
1542   ( "enable-rewrite-rules",             Opt_EnableRewriteRules, nop ),
1543   ( "break-on-exception",               Opt_BreakOnException, nop ),
1544   ( "break-on-error",                   Opt_BreakOnError, nop ),
1545   ( "print-evld-with-show",             Opt_PrintEvldWithShow, nop ),
1546   ( "print-bind-contents",              Opt_PrintBindContents, nop ),
1547   ( "run-cps",                          Opt_RunCPS, nop ),
1548   ( "run-cpsz",                         Opt_RunCPSZ, nop ),
1549   ( "new-codegen",                      Opt_TryNewCodeGen, nop ),
1550   ( "convert-to-zipper-and-back",       Opt_ConvertToZipCfgAndBack, nop ),
1551   ( "vectorise",                        Opt_Vectorise, nop ),
1552   ( "regs-graph",                       Opt_RegsGraph, nop ),
1553   ( "regs-iterative",                   Opt_RegsIterative, nop ),
1554   ( "gen-manifest",                     Opt_GenManifest, nop ),
1555   ( "embed-manifest",                   Opt_EmbedManifest, nop ),
1556   ( "ext-core",                         Opt_EmitExternalCore, nop ),
1557   ( "shared-implib",                    Opt_SharedImplib, nop ),
1558   ( "ghci-sandbox",                     Opt_GhciSandbox, nop ),
1559   ( "helpful-errors",                   Opt_HelpfulErrors, nop ),
1560   ( "building-cabal-package",           Opt_BuildingCabalPackage, nop ),
1561   ( "implicit-import-qualified",        Opt_ImplicitImportQualified, nop )
1562   ]
1563
1564 -- | These @-f\<blah\>@ flags can all be reversed with @-fno-\<blah\>@
1565 fLangFlags :: [FlagSpec ExtensionFlag]
1566 fLangFlags = [
1567   ( "th",                               Opt_TemplateHaskell,
1568     deprecatedForExtension "TemplateHaskell" >> checkTemplateHaskellOk ),
1569   ( "fi",                               Opt_ForeignFunctionInterface,
1570     deprecatedForExtension "ForeignFunctionInterface" ),
1571   ( "ffi",                              Opt_ForeignFunctionInterface,
1572     deprecatedForExtension "ForeignFunctionInterface" ),
1573   ( "arrows",                           Opt_Arrows,
1574     deprecatedForExtension "Arrows" ),
1575   ( "generics",                         Opt_Generics,
1576     deprecatedForExtension "Generics" ),
1577   ( "implicit-prelude",                 Opt_ImplicitPrelude,
1578     deprecatedForExtension "ImplicitPrelude" ),
1579   ( "bang-patterns",                    Opt_BangPatterns,
1580     deprecatedForExtension "BangPatterns" ),
1581   ( "monomorphism-restriction",         Opt_MonomorphismRestriction,
1582     deprecatedForExtension "MonomorphismRestriction" ),
1583   ( "mono-pat-binds",                   Opt_MonoPatBinds,
1584     deprecatedForExtension "MonoPatBinds" ),
1585   ( "extended-default-rules",           Opt_ExtendedDefaultRules,
1586     deprecatedForExtension "ExtendedDefaultRules" ),
1587   ( "implicit-params",                  Opt_ImplicitParams,
1588     deprecatedForExtension "ImplicitParams" ),
1589   ( "scoped-type-variables",            Opt_ScopedTypeVariables,
1590     deprecatedForExtension "ScopedTypeVariables" ),
1591   ( "parr",                             Opt_ParallelArrays,
1592     deprecatedForExtension "ParallelArrays" ),
1593   ( "PArr",                             Opt_ParallelArrays,
1594     deprecatedForExtension "ParallelArrays" ),
1595   ( "allow-overlapping-instances",      Opt_OverlappingInstances,
1596     deprecatedForExtension "OverlappingInstances" ),
1597   ( "allow-undecidable-instances",      Opt_UndecidableInstances,
1598     deprecatedForExtension "UndecidableInstances" ),
1599   ( "allow-incoherent-instances",       Opt_IncoherentInstances,
1600     deprecatedForExtension "IncoherentInstances" )
1601   ]
1602
1603 supportedLanguages :: [String]
1604 supportedLanguages = [ name | (name, _, _) <- languageFlags ]
1605
1606 supportedExtensions :: [String]
1607 supportedExtensions = [ name' | (name, _, _) <- xFlags, name' <- [name, "No" ++ name] ]
1608
1609 supportedLanguagesAndExtensions :: [String]
1610 supportedLanguagesAndExtensions = supportedLanguages ++ supportedExtensions
1611
1612 -- | These -X<blah> flags cannot be reversed with -XNo<blah>
1613 languageFlags :: [FlagSpec Language]
1614 languageFlags = [
1615   ( "Haskell98",                        Haskell98, nop ),
1616   ( "Haskell2010",                      Haskell2010, nop )
1617   ]
1618
1619 -- | These -X<blah> flags can all be reversed with -XNo<blah>
1620 xFlags :: [FlagSpec ExtensionFlag]
1621 xFlags = [
1622   ( "CPP",                              Opt_Cpp, nop ),
1623   ( "PostfixOperators",                 Opt_PostfixOperators, nop ),
1624   ( "TupleSections",                    Opt_TupleSections, nop ),
1625   ( "PatternGuards",                    Opt_PatternGuards, nop ),
1626   ( "UnicodeSyntax",                    Opt_UnicodeSyntax, nop ),
1627   ( "MagicHash",                        Opt_MagicHash, nop ),
1628   ( "PolymorphicComponents",            Opt_PolymorphicComponents, nop ),
1629   ( "ExistentialQuantification",        Opt_ExistentialQuantification, nop ),
1630   ( "KindSignatures",                   Opt_KindSignatures, nop ),
1631   ( "EmptyDataDecls",                   Opt_EmptyDataDecls, nop ),
1632   ( "ParallelListComp",                 Opt_ParallelListComp, nop ),
1633   ( "TransformListComp",                Opt_TransformListComp, nop ),
1634   ( "ForeignFunctionInterface",         Opt_ForeignFunctionInterface, nop ),
1635   ( "UnliftedFFITypes",                 Opt_UnliftedFFITypes, nop ),
1636   ( "GHCForeignImportPrim",             Opt_GHCForeignImportPrim, nop ),
1637   ( "LiberalTypeSynonyms",              Opt_LiberalTypeSynonyms, nop ),
1638   ( "Rank2Types",                       Opt_Rank2Types, nop ),
1639   ( "RankNTypes",                       Opt_RankNTypes, nop ),
1640   ( "ImpredicativeTypes",               Opt_ImpredicativeTypes, nop), 
1641   ( "TypeOperators",                    Opt_TypeOperators, nop ),
1642   ( "RecursiveDo",                      Opt_RecursiveDo,
1643     deprecatedForExtension "DoRec"),
1644   ( "DoRec",                            Opt_DoRec, nop ),
1645   ( "Arrows",                           Opt_Arrows, nop ),
1646   ( "ModalTypes",                       Opt_ModalTypes, nop ),
1647   ( "ParallelArrays",                   Opt_ParallelArrays, nop ),
1648   ( "TemplateHaskell",                  Opt_TemplateHaskell, checkTemplateHaskellOk ),
1649   ( "QuasiQuotes",                      Opt_QuasiQuotes, nop ),
1650   ( "Generics",                         Opt_Generics, nop ),
1651   ( "ImplicitPrelude",                  Opt_ImplicitPrelude, nop ),
1652   ( "RecordWildCards",                  Opt_RecordWildCards, nop ),
1653   ( "NamedFieldPuns",                   Opt_RecordPuns, nop ),
1654   ( "RecordPuns",                       Opt_RecordPuns,
1655     deprecatedForExtension "NamedFieldPuns" ),
1656   ( "DisambiguateRecordFields",         Opt_DisambiguateRecordFields, nop ),
1657   ( "OverloadedStrings",                Opt_OverloadedStrings, nop ),
1658   ( "GADTs",                            Opt_GADTs, nop ),
1659   ( "GADTSyntax",                       Opt_GADTSyntax, nop ),
1660   ( "ViewPatterns",                     Opt_ViewPatterns, nop ),
1661   ( "TypeFamilies",                     Opt_TypeFamilies, nop ),
1662   ( "BangPatterns",                     Opt_BangPatterns, nop ),
1663   ( "MonomorphismRestriction",          Opt_MonomorphismRestriction, nop ),
1664   ( "NPlusKPatterns",                   Opt_NPlusKPatterns, nop ),
1665   ( "DoAndIfThenElse",                  Opt_DoAndIfThenElse, nop ),
1666   ( "RebindableSyntax",                 Opt_RebindableSyntax, nop ),
1667   ( "MonoPatBinds",                     Opt_MonoPatBinds, nop ),
1668   ( "ExplicitForAll",                   Opt_ExplicitForAll, nop ),
1669   ( "AlternativeLayoutRule",            Opt_AlternativeLayoutRule, nop ),
1670   ( "AlternativeLayoutRuleTransitional",Opt_AlternativeLayoutRuleTransitional, nop ),
1671   ( "DatatypeContexts",                 Opt_DatatypeContexts, nop ),
1672   ( "NondecreasingIndentation",         Opt_NondecreasingIndentation, nop ),
1673   ( "RelaxedLayout",                    Opt_RelaxedLayout, nop ),
1674   ( "MonoLocalBinds",                   Opt_MonoLocalBinds, nop ),
1675   ( "RelaxedPolyRec",                   Opt_RelaxedPolyRec, 
1676     \ turn_on -> if not turn_on 
1677                  then deprecate "You can't turn off RelaxedPolyRec any more"
1678                  else return () ),
1679   ( "ExtendedDefaultRules",             Opt_ExtendedDefaultRules, nop ),
1680   ( "ImplicitParams",                   Opt_ImplicitParams, nop ),
1681   ( "ScopedTypeVariables",              Opt_ScopedTypeVariables, nop ),
1682
1683   ( "PatternSignatures",                Opt_ScopedTypeVariables, 
1684     deprecatedForExtension "ScopedTypeVariables" ),
1685
1686   ( "UnboxedTuples",                    Opt_UnboxedTuples, nop ),
1687   ( "StandaloneDeriving",               Opt_StandaloneDeriving, nop ),
1688   ( "DeriveDataTypeable",               Opt_DeriveDataTypeable, nop ),
1689   ( "DeriveFunctor",                    Opt_DeriveFunctor, nop ),
1690   ( "DeriveTraversable",                Opt_DeriveTraversable, nop ),
1691   ( "DeriveFoldable",                   Opt_DeriveFoldable, nop ),
1692   ( "TypeSynonymInstances",             Opt_TypeSynonymInstances, nop ),
1693   ( "FlexibleContexts",                 Opt_FlexibleContexts, nop ),
1694   ( "FlexibleInstances",                Opt_FlexibleInstances, nop ),
1695   ( "ConstrainedClassMethods",          Opt_ConstrainedClassMethods, nop ),
1696   ( "MultiParamTypeClasses",            Opt_MultiParamTypeClasses, nop ),
1697   ( "FunctionalDependencies",           Opt_FunctionalDependencies, nop ),
1698   ( "GeneralizedNewtypeDeriving",       Opt_GeneralizedNewtypeDeriving, nop ),
1699   ( "OverlappingInstances",             Opt_OverlappingInstances, nop ),
1700   ( "UndecidableInstances",             Opt_UndecidableInstances, nop ),
1701   ( "IncoherentInstances",              Opt_IncoherentInstances, nop ),
1702   ( "PackageImports",                   Opt_PackageImports, nop )
1703   ]
1704
1705 defaultFlags :: [DynFlag]
1706 defaultFlags 
1707   = [ Opt_AutoLinkPackages,
1708       Opt_ReadUserPackageConf,
1709
1710       Opt_SharedImplib,
1711
1712 #if GHC_DEFAULT_NEW_CODEGEN
1713       Opt_TryNewCodeGen,
1714 #endif
1715
1716       Opt_GenManifest,
1717       Opt_EmbedManifest,
1718       Opt_PrintBindContents,
1719       Opt_GhciSandbox,
1720       Opt_HelpfulErrors
1721     ]
1722
1723     ++ [f | (ns,f) <- optLevelFlags, 0 `elem` ns]
1724              -- The default -O0 options
1725
1726     ++ standardWarnings
1727
1728 impliedFlags :: [(ExtensionFlag, TurnOnFlag, ExtensionFlag)]
1729 impliedFlags
1730   = [ (Opt_RankNTypes,                turnOn, Opt_ExplicitForAll)
1731     , (Opt_Rank2Types,                turnOn, Opt_ExplicitForAll)
1732     , (Opt_ScopedTypeVariables,       turnOn, Opt_ExplicitForAll)
1733     , (Opt_LiberalTypeSynonyms,       turnOn, Opt_ExplicitForAll)
1734     , (Opt_ExistentialQuantification, turnOn, Opt_ExplicitForAll)
1735     , (Opt_PolymorphicComponents,     turnOn, Opt_ExplicitForAll)
1736     , (Opt_FlexibleInstances,         turnOn, Opt_TypeSynonymInstances)
1737     , (Opt_FunctionalDependencies,    turnOn, Opt_MultiParamTypeClasses)
1738
1739     , (Opt_ModalTypes,                 turnOn,  Opt_RankNTypes)
1740     , (Opt_ModalTypes,                 turnOn,  Opt_ExplicitForAll)
1741     --, (Opt_ModalTypes,                 turnOn,  Opt_RebindableSyntax)
1742     , (Opt_ModalTypes,                 turnOff, Opt_MonomorphismRestriction)
1743
1744     , (Opt_RebindableSyntax, turnOff, Opt_ImplicitPrelude)      -- NB: turn off!
1745
1746     , (Opt_GADTs,            turnOn, Opt_GADTSyntax)
1747     , (Opt_GADTs,            turnOn, Opt_MonoLocalBinds)
1748     , (Opt_TypeFamilies,     turnOn, Opt_MonoLocalBinds)
1749
1750     , (Opt_TypeFamilies,     turnOn, Opt_KindSignatures)  -- Type families use kind signatures
1751                                                      -- all over the place
1752
1753     , (Opt_ImpredicativeTypes,  turnOn, Opt_RankNTypes)
1754
1755         -- Record wild-cards implies field disambiguation
1756         -- Otherwise if you write (C {..}) you may well get
1757         -- stuff like " 'a' not in scope ", which is a bit silly
1758         -- if the compiler has just filled in field 'a' of constructor 'C'
1759     , (Opt_RecordWildCards,     turnOn, Opt_DisambiguateRecordFields)
1760     
1761     , (Opt_ParallelArrays, turnOn, Opt_ParallelListComp)
1762   ]
1763
1764 optLevelFlags :: [([Int], DynFlag)]
1765 optLevelFlags
1766   = [ ([0],     Opt_IgnoreInterfacePragmas)
1767     , ([0],     Opt_OmitInterfacePragmas)
1768
1769     , ([1,2],   Opt_IgnoreAsserts)
1770     , ([1,2],   Opt_EnableRewriteRules)  -- Off for -O0; see Note [Scoping for Builtin rules]
1771                                          --              in PrelRules
1772     , ([1,2],   Opt_DoEtaReduction)
1773     , ([1,2],   Opt_CaseMerge)
1774     , ([1,2],   Opt_Strictness)
1775     , ([1,2],   Opt_CSE)
1776     , ([1,2],   Opt_FullLaziness)
1777     , ([1,2],   Opt_Specialise)
1778     , ([1,2],   Opt_FloatIn)
1779
1780     , ([2],     Opt_LiberateCase)
1781     , ([2],     Opt_SpecConstr)
1782     , ([2],     Opt_RegsGraph)
1783
1784 --     , ([2],     Opt_StaticArgumentTransformation)
1785 -- Max writes: I think it's probably best not to enable SAT with -O2 for the
1786 -- 6.10 release. The version of SAT in HEAD at the moment doesn't incorporate
1787 -- several improvements to the heuristics, and I'm concerned that without
1788 -- those changes SAT will interfere with some attempts to write "high
1789 -- performance Haskell", as we saw in some posts on Haskell-Cafe earlier
1790 -- this year. In particular, the version in HEAD lacks the tail call
1791 -- criterion, so many things that look like reasonable loops will be
1792 -- turned into functions with extra (unneccesary) thunk creation.
1793
1794     , ([0,1,2], Opt_DoLambdaEtaExpansion)
1795                 -- This one is important for a tiresome reason:
1796                 -- we want to make sure that the bindings for data
1797                 -- constructors are eta-expanded.  This is probably
1798                 -- a good thing anyway, but it seems fragile.
1799     ]
1800
1801 -- -----------------------------------------------------------------------------
1802 -- Standard sets of warning options
1803
1804 standardWarnings :: [DynFlag]
1805 standardWarnings
1806     = [ Opt_WarnWarningsDeprecations,
1807         Opt_WarnDeprecatedFlags,
1808         Opt_WarnUnrecognisedPragmas,
1809         Opt_WarnOverlappingPatterns,
1810         Opt_WarnMissingFields,
1811         Opt_WarnMissingMethods,
1812         Opt_WarnDuplicateExports,
1813         Opt_WarnLazyUnliftedBindings,
1814         Opt_WarnDodgyForeignImports,
1815         Opt_WarnWrongDoBind,
1816         Opt_WarnAlternativeLayoutRuleTransitional
1817       ]
1818
1819 minusWOpts :: [DynFlag]
1820 -- Things you get with -W
1821 minusWOpts
1822     = standardWarnings ++
1823       [ Opt_WarnUnusedBinds,
1824         Opt_WarnUnusedMatches,
1825         Opt_WarnUnusedImports,
1826         Opt_WarnIncompletePatterns,
1827         Opt_WarnDodgyExports,
1828         Opt_WarnDodgyImports
1829       ]
1830
1831 minusWallOpts :: [DynFlag]
1832 -- Things you get with -Wall
1833 minusWallOpts
1834     = minusWOpts ++
1835       [ Opt_WarnTypeDefaults,
1836         Opt_WarnNameShadowing,
1837         Opt_WarnMissingSigs,
1838         Opt_WarnHiShadows,
1839         Opt_WarnOrphans,
1840         Opt_WarnUnusedDoBind
1841       ]
1842
1843 minuswRemovesOpts :: [DynFlag]
1844 -- minuswRemovesOpts should be every warning option 
1845 minuswRemovesOpts
1846     = minusWallOpts ++
1847       [Opt_WarnTabs,
1848        Opt_WarnIncompletePatternsRecUpd,
1849        Opt_WarnIncompleteUniPatterns,
1850        Opt_WarnMonomorphism,
1851        Opt_WarnUnrecognisedPragmas,
1852        Opt_WarnAutoOrphans,
1853        Opt_WarnImplicitPrelude
1854      ]       
1855
1856 enableGlasgowExts :: DynP ()
1857 enableGlasgowExts = do setDynFlag Opt_PrintExplicitForalls
1858                        mapM_ setExtensionFlag glasgowExtsFlags
1859
1860 disableGlasgowExts :: DynP ()
1861 disableGlasgowExts = do unSetDynFlag Opt_PrintExplicitForalls
1862                         mapM_ unSetExtensionFlag glasgowExtsFlags
1863
1864 glasgowExtsFlags :: [ExtensionFlag]
1865 glasgowExtsFlags = [
1866              Opt_ForeignFunctionInterface
1867            , Opt_UnliftedFFITypes
1868            , Opt_ImplicitParams
1869            , Opt_ScopedTypeVariables
1870            , Opt_UnboxedTuples
1871            , Opt_TypeSynonymInstances
1872            , Opt_StandaloneDeriving
1873            , Opt_DeriveDataTypeable
1874            , Opt_DeriveFunctor
1875            , Opt_DeriveFoldable
1876            , Opt_DeriveTraversable
1877            , Opt_FlexibleContexts
1878            , Opt_FlexibleInstances
1879            , Opt_ConstrainedClassMethods
1880            , Opt_MultiParamTypeClasses
1881            , Opt_FunctionalDependencies
1882            , Opt_MagicHash
1883            , Opt_PolymorphicComponents
1884            , Opt_ExistentialQuantification
1885            , Opt_UnicodeSyntax
1886            , Opt_PostfixOperators
1887            , Opt_PatternGuards
1888            , Opt_LiberalTypeSynonyms
1889            , Opt_RankNTypes
1890            , Opt_TypeOperators
1891            , Opt_DoRec
1892            , Opt_ParallelListComp
1893            , Opt_EmptyDataDecls
1894            , Opt_KindSignatures
1895            , Opt_GeneralizedNewtypeDeriving ]
1896
1897 #ifdef GHCI
1898 -- Consult the RTS to find whether GHC itself has been built profiled
1899 -- If so, you can't use Template Haskell
1900 foreign import ccall unsafe "rts_isProfiled" rtsIsProfiledIO :: IO CInt
1901
1902 rtsIsProfiled :: Bool
1903 rtsIsProfiled = unsafePerformIO rtsIsProfiledIO /= 0
1904 #endif
1905
1906 checkTemplateHaskellOk :: Bool -> DynP ()
1907 #ifdef GHCI
1908 checkTemplateHaskellOk turn_on
1909   | turn_on && rtsIsProfiled
1910   = addErr "You can't use Template Haskell with a profiled compiler"
1911   | otherwise
1912   = return ()
1913 #else
1914 -- In stage 1 we don't know that the RTS has rts_isProfiled,
1915 -- so we simply say "ok".  It doesn't matter because TH isn't
1916 -- available in stage 1 anyway.
1917 checkTemplateHaskellOk _ = return ()
1918 #endif
1919
1920 {- **********************************************************************
1921 %*                                                                      *
1922                 DynFlags constructors
1923 %*                                                                      *
1924 %********************************************************************* -}
1925
1926 type DynP = EwM (CmdLineP DynFlags)
1927
1928 upd :: (DynFlags -> DynFlags) -> DynP ()
1929 upd f = liftEwM (do { dfs <- getCmdLineState
1930                     ; putCmdLineState $! (f dfs) })
1931
1932 --------------- Constructor functions for OptKind -----------------
1933 noArg :: (DynFlags -> DynFlags) -> OptKind (CmdLineP DynFlags)
1934 noArg fn = NoArg (upd fn)
1935
1936 noArgDF :: (DynFlags -> DynFlags) -> String -> OptKind (CmdLineP DynFlags)
1937 noArgDF fn deprec = NoArg (upd fn >> deprecate deprec)
1938
1939 hasArg :: (String -> DynFlags -> DynFlags) -> OptKind (CmdLineP DynFlags)
1940 hasArg fn = HasArg (upd . fn)
1941
1942 hasArgDF :: (String -> DynFlags -> DynFlags) -> String -> OptKind (CmdLineP DynFlags)
1943 hasArgDF fn deprec = HasArg (\s -> do { upd (fn s)
1944                                       ; deprecate deprec })
1945
1946 intSuffix :: (Int -> DynFlags -> DynFlags) -> OptKind (CmdLineP DynFlags)
1947 intSuffix fn = IntSuffix (\n -> upd (fn n))
1948
1949 setDumpFlag :: DynFlag -> OptKind (CmdLineP DynFlags)
1950 setDumpFlag dump_flag = NoArg (setDumpFlag' dump_flag)
1951
1952 --------------------------
1953 setDynFlag, unSetDynFlag :: DynFlag -> DynP ()
1954 setDynFlag   f = upd (\dfs -> dopt_set dfs f)
1955 unSetDynFlag f = upd (\dfs -> dopt_unset dfs f)
1956
1957 --------------------------
1958 setExtensionFlag, unSetExtensionFlag :: ExtensionFlag -> DynP ()
1959 setExtensionFlag f = do { upd (\dfs -> xopt_set dfs f)
1960                         ; sequence_ deps }
1961   where
1962     deps = [ if turn_on then setExtensionFlag   d
1963                         else unSetExtensionFlag d
1964            | (f', turn_on, d) <- impliedFlags, f' == f ]
1965         -- When you set f, set the ones it implies
1966         -- NB: use setExtensionFlag recursively, in case the implied flags
1967         --     implies further flags
1968
1969 unSetExtensionFlag f = upd (\dfs -> xopt_unset dfs f)
1970    -- When you un-set f, however, we don't un-set the things it implies
1971    --      (except for -fno-glasgow-exts, which is treated specially)
1972
1973 --------------------------
1974 alterSettings :: (Settings -> Settings) -> DynFlags -> DynFlags
1975 alterSettings f dflags = dflags { settings = f (settings dflags) }
1976
1977 --------------------------
1978 setDumpFlag' :: DynFlag -> DynP ()
1979 setDumpFlag' dump_flag
1980   = do { setDynFlag dump_flag
1981        ; when want_recomp forceRecompile }
1982   where
1983         -- Certain dumpy-things are really interested in what's going
1984         -- on during recompilation checking, so in those cases we
1985         -- don't want to turn it off.
1986     want_recomp = dump_flag `notElem` [Opt_D_dump_if_trace,
1987                                        Opt_D_dump_hi_diffs]
1988
1989 forceRecompile :: DynP ()
1990 -- Whenver we -ddump, force recompilation (by switching off the 
1991 -- recompilation checker), else you don't see the dump! However, 
1992 -- don't switch it off in --make mode, else *everything* gets
1993 -- recompiled which probably isn't what you want
1994 forceRecompile = do { dfs <- liftEwM getCmdLineState
1995                     ; when (force_recomp dfs) (setDynFlag Opt_ForceRecomp) }
1996         where
1997           force_recomp dfs = isOneShot (ghcMode dfs)
1998
1999 setVerboseCore2Core :: DynP ()
2000 setVerboseCore2Core = do forceRecompile
2001                          setDynFlag Opt_D_verbose_core2core 
2002                          upd (\dfs -> dfs { shouldDumpSimplPhase = Nothing })
2003                          
2004
2005 setDumpSimplPhases :: String -> DynP ()
2006 setDumpSimplPhases s = do forceRecompile
2007                           upd (\dfs -> dfs { shouldDumpSimplPhase = Just spec })
2008   where
2009     spec = case s of { ('=' : s') -> s';  _ -> s }
2010
2011 setVerbosity :: Maybe Int -> DynP ()
2012 setVerbosity mb_n = upd (\dfs -> dfs{ verbosity = mb_n `orElse` 3 })
2013
2014 addCmdlineHCInclude :: String -> DynP ()
2015 addCmdlineHCInclude a = upd (\s -> s{cmdlineHcIncludes =  a : cmdlineHcIncludes s})
2016
2017 extraPkgConf_ :: FilePath -> DynP ()
2018 extraPkgConf_  p = upd (\s -> s{ extraPkgConfs = p : extraPkgConfs s })
2019
2020 exposePackage, exposePackageId, hidePackage, ignorePackage :: String -> DynP ()
2021 exposePackage p =
2022   upd (\s -> s{ packageFlags = ExposePackage p : packageFlags s })
2023 exposePackageId p =
2024   upd (\s -> s{ packageFlags = ExposePackageId p : packageFlags s })
2025 hidePackage p =
2026   upd (\s -> s{ packageFlags = HidePackage p : packageFlags s })
2027 ignorePackage p =
2028   upd (\s -> s{ packageFlags = IgnorePackage p : packageFlags s })
2029
2030 setPackageName :: String -> DynFlags -> DynFlags
2031 setPackageName p s =  s{ thisPackage = stringToPackageId p }
2032
2033 -- If we're linking a binary, then only targets that produce object
2034 -- code are allowed (requests for other target types are ignored).
2035 setTarget :: HscTarget -> DynP ()
2036 setTarget l = upd set
2037   where
2038    set dfs
2039      | ghcLink dfs /= LinkBinary || isObjectTarget l  = dfs{ hscTarget = l }
2040      | otherwise = dfs
2041
2042 -- Changes the target only if we're compiling object code.  This is
2043 -- used by -fasm and -fllvm, which switch from one to the other, but
2044 -- not from bytecode to object-code.  The idea is that -fasm/-fllvm
2045 -- can be safely used in an OPTIONS_GHC pragma.
2046 setObjTarget :: HscTarget -> DynP ()
2047 setObjTarget l = upd set
2048   where
2049    set dfs
2050      | isObjectTarget (hscTarget dfs) = dfs { hscTarget = l }
2051      | otherwise = dfs
2052
2053 setOptLevel :: Int -> DynFlags -> DynFlags
2054 setOptLevel n dflags
2055    | hscTarget dflags == HscInterpreted && n > 0
2056         = dflags
2057             -- not in IO any more, oh well:
2058             -- putStr "warning: -O conflicts with --interactive; -O ignored.\n"
2059    | otherwise
2060         = updOptLevel n dflags
2061
2062
2063 -- -Odph is equivalent to
2064 --
2065 --    -O2                               optimise as much as possible
2066 --    -fmax-simplifier-iterations20     this is necessary sometimes
2067 --    -fsimplifier-phases=3             we use an additional simplifier phase for fusion
2068 --
2069 setDPHOpt :: DynFlags -> DynFlags
2070 setDPHOpt dflags = setOptLevel 2 (dflags { maxSimplIterations  = 20
2071                                          , simplPhases         = 3
2072                                          })
2073
2074 -- Determines the package used by the vectoriser for the symbols of the vectorised code.
2075 -- 'DPHNone' indicates that no data-parallel backend library is available; hence, the
2076 -- vectoriser cannot be used.
2077 --
2078 data DPHBackend = DPHPar    -- "dph-par"
2079                 | DPHSeq    -- "dph-seq"
2080                 | DPHThis   -- the currently compiled package
2081                 | DPHNone   -- no DPH library available
2082         deriving(Eq, Ord, Enum, Show)
2083
2084 setDPHBackend :: DPHBackend -> DynP ()
2085 setDPHBackend backend = upd $ \dflags -> dflags { dphBackend = backend }
2086
2087 -- Query the DPH backend package to be used by the vectoriser and desugaring of DPH syntax.
2088 --
2089 dphPackageMaybe :: DynFlags -> Maybe PackageId
2090 dphPackageMaybe dflags 
2091   = case dphBackend dflags of
2092       DPHPar  -> Just dphParPackageId
2093       DPHSeq  -> Just dphSeqPackageId
2094       DPHThis -> Just (thisPackage dflags)
2095       DPHNone -> Nothing
2096
2097 setMainIs :: String -> DynP ()
2098 setMainIs arg
2099   | not (null main_fn) && isLower (head main_fn)
2100      -- The arg looked like "Foo.Bar.baz"
2101   = upd $ \d -> d{ mainFunIs = Just main_fn,
2102                    mainModIs = mkModule mainPackageId (mkModuleName main_mod) }
2103
2104   | isUpper (head arg)  -- The arg looked like "Foo" or "Foo.Bar"
2105   = upd $ \d -> d{ mainModIs = mkModule mainPackageId (mkModuleName arg) }
2106
2107   | otherwise                   -- The arg looked like "baz"
2108   = upd $ \d -> d{ mainFunIs = Just arg }
2109   where
2110     (main_mod, main_fn) = splitLongestPrefix arg (== '.')
2111
2112 -----------------------------------------------------------------------------
2113 -- Paths & Libraries
2114
2115 addImportPath, addLibraryPath, addIncludePath, addFrameworkPath :: FilePath -> DynP ()
2116
2117 -- -i on its own deletes the import paths
2118 addImportPath "" = upd (\s -> s{importPaths = []})
2119 addImportPath p  = upd (\s -> s{importPaths = importPaths s ++ splitPathList p})
2120
2121
2122 addLibraryPath p =
2123   upd (\s -> s{libraryPaths = libraryPaths s ++ splitPathList p})
2124
2125 addIncludePath p =
2126   upd (\s -> s{includePaths = includePaths s ++ splitPathList p})
2127
2128 addFrameworkPath p =
2129   upd (\s -> s{frameworkPaths = frameworkPaths s ++ splitPathList p})
2130
2131 #ifndef mingw32_TARGET_OS
2132 split_marker :: Char
2133 split_marker = ':'   -- not configurable (ToDo)
2134 #endif
2135
2136 splitPathList :: String -> [String]
2137 splitPathList s = filter notNull (splitUp s)
2138                 -- empty paths are ignored: there might be a trailing
2139                 -- ':' in the initial list, for example.  Empty paths can
2140                 -- cause confusion when they are translated into -I options
2141                 -- for passing to gcc.
2142   where
2143 #ifndef mingw32_TARGET_OS
2144     splitUp xs = split split_marker xs
2145 #else
2146      -- Windows: 'hybrid' support for DOS-style paths in directory lists.
2147      --
2148      -- That is, if "foo:bar:baz" is used, this interpreted as
2149      -- consisting of three entries, 'foo', 'bar', 'baz'.
2150      -- However, with "c:/foo:c:\\foo;x:/bar", this is interpreted
2151      -- as 3 elts, "c:/foo", "c:\\foo", "x:/bar"
2152      --
2153      -- Notice that no attempt is made to fully replace the 'standard'
2154      -- split marker ':' with the Windows / DOS one, ';'. The reason being
2155      -- that this will cause too much breakage for users & ':' will
2156      -- work fine even with DOS paths, if you're not insisting on being silly.
2157      -- So, use either.
2158     splitUp []             = []
2159     splitUp (x:':':div:xs) | div `elem` dir_markers
2160                            = ((x:':':div:p): splitUp rs)
2161                            where
2162                               (p,rs) = findNextPath xs
2163           -- we used to check for existence of the path here, but that
2164           -- required the IO monad to be threaded through the command-line
2165           -- parser which is quite inconvenient.  The
2166     splitUp xs = cons p (splitUp rs)
2167                where
2168                  (p,rs) = findNextPath xs
2169
2170                  cons "" xs = xs
2171                  cons x  xs = x:xs
2172
2173     -- will be called either when we've consumed nought or the
2174     -- "<Drive>:/" part of a DOS path, so splitting is just a Q of
2175     -- finding the next split marker.
2176     findNextPath xs =
2177         case break (`elem` split_markers) xs of
2178            (p, _:ds) -> (p, ds)
2179            (p, xs)   -> (p, xs)
2180
2181     split_markers :: [Char]
2182     split_markers = [':', ';']
2183
2184     dir_markers :: [Char]
2185     dir_markers = ['/', '\\']
2186 #endif
2187
2188 -- -----------------------------------------------------------------------------
2189 -- tmpDir, where we store temporary files.
2190
2191 setTmpDir :: FilePath -> DynFlags -> DynFlags
2192 setTmpDir dir = alterSettings (\s -> s { sTmpDir = normalise dir })
2193   -- we used to fix /cygdrive/c/.. on Windows, but this doesn't
2194   -- seem necessary now --SDM 7/2/2008
2195
2196 -----------------------------------------------------------------------------
2197 -- RTS opts
2198
2199 setRtsOpts :: String -> DynP ()
2200 setRtsOpts arg  = upd $ \ d -> d {rtsOpts = Just arg}
2201
2202 setRtsOptsEnabled :: RtsOptsEnabled -> DynP ()
2203 setRtsOptsEnabled arg  = upd $ \ d -> d {rtsOptsEnabled = arg}
2204
2205 -----------------------------------------------------------------------------
2206 -- Hpc stuff
2207
2208 setOptHpcDir :: String -> DynP ()
2209 setOptHpcDir arg  = upd $ \ d -> d{hpcDir = arg}
2210
2211 -----------------------------------------------------------------------------
2212 -- Via-C compilation stuff
2213
2214 -- There are some options that we need to pass to gcc when compiling
2215 -- Haskell code via C, but are only supported by recent versions of
2216 -- gcc.  The configure script decides which of these options we need,
2217 -- and puts them in the "settings" file in $topdir. The advantage of
2218 -- having these in a separate file is that the file can be created at
2219 -- install-time depending on the available gcc version, and even
2220 -- re-generated later if gcc is upgraded.
2221 --
2222 -- The options below are not dependent on the version of gcc, only the
2223 -- platform.
2224
2225 machdepCCOpts :: DynFlags -> [String] -- flags for all C compilations
2226 machdepCCOpts _ = cCcOpts ++ machdepCCOpts'
2227
2228 machdepCCOpts' :: [String] -- flags for all C compilations
2229 machdepCCOpts'
2230 #if alpha_TARGET_ARCH
2231         =       ["-w", "-mieee"
2232 #ifdef HAVE_THREADED_RTS_SUPPORT
2233                     , "-D_REENTRANT"
2234 #endif
2235                    ]
2236         -- For now, to suppress the gcc warning "call-clobbered
2237         -- register used for global register variable", we simply
2238         -- disable all warnings altogether using the -w flag. Oh well.
2239
2240 #elif hppa_TARGET_ARCH
2241         -- ___HPUX_SOURCE, not _HPUX_SOURCE, is #defined if -ansi!
2242         -- (very nice, but too bad the HP /usr/include files don't agree.)
2243         = ["-D_HPUX_SOURCE"]
2244
2245 #elif i386_TARGET_ARCH
2246       -- -fno-defer-pop : basically the same game as for m68k
2247       --
2248       -- -fomit-frame-pointer : *must* in .hc files; because we're stealing
2249       --   the fp (%ebp) for our register maps.
2250         =  if opt_Static then ["-DDONT_WANT_WIN32_DLL_SUPPORT"] else []
2251
2252 #else
2253         = []
2254 #endif
2255
2256 picCCOpts :: DynFlags -> [String]
2257 picCCOpts _dflags
2258 #if darwin_TARGET_OS
2259       -- Apple prefers to do things the other way round.
2260       -- PIC is on by default.
2261       -- -mdynamic-no-pic:
2262       --     Turn off PIC code generation.
2263       -- -fno-common:
2264       --     Don't generate "common" symbols - these are unwanted
2265       --     in dynamic libraries.
2266
2267     | opt_PIC
2268         = ["-fno-common", "-U __PIC__","-D__PIC__"]
2269     | otherwise
2270         = ["-mdynamic-no-pic"]
2271 #elif mingw32_TARGET_OS
2272       -- no -fPIC for Windows
2273     | opt_PIC
2274         = ["-U __PIC__","-D__PIC__"]
2275     | otherwise
2276         = []
2277 #else
2278       -- we need -fPIC for C files when we are compiling with -dynamic,
2279       -- otherwise things like stub.c files don't get compiled
2280       -- correctly.  They need to reference data in the Haskell
2281       -- objects, but can't without -fPIC.  See
2282       -- http://hackage.haskell.org/trac/ghc/wiki/Commentary/PositionIndependentCode
2283     | opt_PIC || not opt_Static
2284         = ["-fPIC", "-U __PIC__", "-D__PIC__"]
2285     | otherwise
2286         = []
2287 #endif
2288
2289 -- -----------------------------------------------------------------------------
2290 -- Splitting
2291
2292 can_split :: Bool
2293 can_split = cSupportsSplitObjs == "YES"
2294
2295 -- -----------------------------------------------------------------------------
2296 -- Compiler Info
2297
2298 compilerInfo :: DynFlags -> [(String, String)]
2299 compilerInfo dflags
2300     = -- We always make "Project name" be first to keep parsing in
2301       -- other languages simple, i.e. when looking for other fields,
2302       -- you don't have to worry whether there is a leading '[' or not
2303       ("Project name",                 cProjectName)
2304       -- Next come the settings, so anything else can be overridden
2305       -- in the settings file (as "lookup" uses the first match for the
2306       -- key)
2307     : rawSettings dflags
2308    ++ [("Project version",             cProjectVersion),
2309        ("Booter version",              cBooterVersion),
2310        ("Stage",                       cStage),
2311        ("Build platform",              cBuildPlatformString),
2312        ("Host platform",               cHostPlatformString),
2313        ("Target platform",             cTargetPlatformString),
2314        ("Have interpreter",            cGhcWithInterpreter),
2315        ("Object splitting supported",  cSupportsSplitObjs),
2316        ("Have native code generator",  cGhcWithNativeCodeGen),
2317        ("Support SMP",                 cGhcWithSMP),
2318        ("Unregisterised",              cGhcUnregisterised),
2319        ("Tables next to code",         cGhcEnableTablesNextToCode),
2320        ("RTS ways",                    cGhcRTSWays),
2321        ("Leading underscore",          cLeadingUnderscore),
2322        ("Debug on",                    show debugIsOn),
2323        ("LibDir",                      topDir dflags),
2324        ("Global Package DB",           systemPackageConfig dflags),
2325        ("C compiler flags",            show cCcOpts),
2326        ("Gcc Linker flags",            show cGccLinkerOpts),
2327        ("Ld Linker flags",             show cLdLinkerOpts)
2328       ]
2329