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