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