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