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