compiler/main/DynFlags.hs

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