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 [],
 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       -- In due course I'd like Opt_MonoLocalBinds to be on by default
 799       -- SLPJ September 2010
 800     : languageExtensions (Just Haskell2010)
 801 languageExtensions (Just Haskell98)
 802     = [Opt_ImplicitPrelude,
 803        Opt_MonomorphismRestriction,
 804        Opt_NPlusKPatterns,
 805        Opt_DatatypeContexts]
 806 languageExtensions (Just Haskell2010)
 807     = [Opt_ImplicitPrelude,
 808        Opt_MonomorphismRestriction,
 809        Opt_DatatypeContexts,
 810        Opt_EmptyDataDecls,
 811        Opt_ForeignFunctionInterface,
 812        Opt_PatternGuards,
 813        Opt_DoAndIfThenElse,
 814        Opt_RelaxedPolyRec]
 815
 816 -- The DOpt class is a temporary workaround, to avoid having to do
 817 -- a mass-renaming dopt->lopt at the moment
 818 class DOpt a where
 819     dopt :: a -> DynFlags -> Bool
 820     dopt_set :: DynFlags -> a -> DynFlags
 821     dopt_unset :: DynFlags -> a -> DynFlags
 822
 823 instance DOpt DynFlag where
 824     dopt = dopt'
 825     dopt_set = dopt_set'
 826     dopt_unset = dopt_unset'
 827
 828 instance DOpt ExtensionFlag where
 829     dopt = lopt
 830     dopt_set = lopt_set
 831     dopt_unset = lopt_unset
 832
 833 -- | Test whether a 'DynFlag' is set
 834 dopt' :: DynFlag -> DynFlags -> Bool
 835 dopt' f dflags  = f `elem` (flags dflags)
 836
 837 -- | Set a 'DynFlag'
 838 dopt_set' :: DynFlags -> DynFlag -> DynFlags
 839 dopt_set' dfs f = dfs{ flags = f : flags dfs }
 840
 841 -- | Unset a 'DynFlag'
 842 dopt_unset' :: DynFlags -> DynFlag -> DynFlags
 843 dopt_unset' dfs f = dfs{ flags = filter (/= f) (flags dfs) }
 844
 845 -- | Test whether a 'ExtensionFlag' is set
 846 lopt :: ExtensionFlag -> DynFlags -> Bool
 847 lopt f dflags = case extensionFlags dflags of
 848                 Left _ -> panic ("Testing for extension flag " ++ show f ++ " before flattening")
 849                 Right flags -> f `elem` flags
 850
 851 -- | Set a 'ExtensionFlag'
 852 lopt_set :: DynFlags -> ExtensionFlag -> DynFlags
 853 lopt_set dfs f = case extensionFlags dfs of
 854                  Left onoffs -> dfs { extensionFlags = Left (On f : onoffs) }
 855                  Right _ -> panic ("Setting extension flag " ++ show f ++ " after flattening")
 856
 857 -- | Set a 'ExtensionFlag'
 858 lopt_set_flattened :: DynFlags -> ExtensionFlag -> DynFlags
 859 lopt_set_flattened dfs f = case extensionFlags dfs of
 860                            Left _ ->
 861                                panic ("Setting extension flag " ++ show f ++ " before flattening, but expected flattened")
 862                            Right flags ->
 863                                dfs { extensionFlags = Right (f : delete f flags) }
 864
 865 -- | Unset a 'ExtensionFlag'
 866 lopt_unset :: DynFlags -> ExtensionFlag -> DynFlags
 867 lopt_unset dfs f = case extensionFlags dfs of
 868                    Left onoffs -> dfs { extensionFlags = Left (Off f : onoffs) }
 869                    Right _ -> panic ("Unsetting extension flag " ++ show f ++ " after flattening")
 870
 871 -- | Unset a 'ExtensionFlag'
 872 lopt_unset_flattened :: DynFlags -> ExtensionFlag -> DynFlags
 873 lopt_unset_flattened dfs f = case extensionFlags dfs of
 874                              Left _ ->
 875                                  panic ("Unsetting extension flag " ++ show f ++ " before flattening, but expected flattened")
 876                              Right flags ->
 877                                  dfs { extensionFlags = Right (delete f flags) }
 878
 879 -- | Retrieve the options corresponding to a particular @opt_*@ field in the correct order
 880 getOpts :: DynFlags             -- ^ 'DynFlags' to retrieve the options from
 881         -> (DynFlags -> [a])    -- ^ Relevant record accessor: one of the @opt_*@ accessors
 882         -> [a]                  -- ^ Correctly ordered extracted options
 883 getOpts dflags opts = reverse (opts dflags)
 884         -- We add to the options from the front, so we need to reverse the list
 885
 886 -- | Gets the verbosity flag for the current verbosity level. This is fed to
 887 -- other tools, so GHC-specific verbosity flags like @-ddump-most@ are not included
 888 getVerbFlag :: DynFlags -> String
 889 getVerbFlag dflags
 890   | verbosity dflags >= 3  = "-v"
 891   | otherwise =  ""
 892
 893 setObjectDir, setHiDir, setStubDir, setOutputDir, setDylibInstallName,
 894          setObjectSuf, setHiSuf, setHcSuf, parseDynLibLoaderMode,
 895          setPgmP, addOptl, addOptP,
 896          addCmdlineFramework, addHaddockOpts
 897    :: String -> DynFlags -> DynFlags
 898 setOutputFile, setOutputHi, setDumpPrefixForce
 899    :: Maybe String -> DynFlags -> DynFlags
 900
 901 setObjectDir  f d = d{ objectDir  = Just f}
 902 setHiDir      f d = d{ hiDir      = Just f}
 903 setStubDir    f d = d{ stubDir    = Just f, includePaths = f : includePaths d }
 904   -- -stubdir D adds an implicit -I D, so that gcc can find the _stub.h file
 905   -- \#included from the .hc file when compiling with -fvia-C.
 906 setOutputDir  f = setObjectDir f . setHiDir f . setStubDir f
 907 setDylibInstallName  f d = d{ dylibInstallName = Just f}
 908
 909 setObjectSuf  f d = d{ objectSuf  = f}
 910 setHiSuf      f d = d{ hiSuf      = f}
 911 setHcSuf      f d = d{ hcSuf      = f}
 912
 913 setOutputFile f d = d{ outputFile = f}
 914 setOutputHi   f d = d{ outputHi   = f}
 915
 916 parseDynLibLoaderMode f d =
 917  case splitAt 8 f of
 918    ("deploy", "")       -> d{ dynLibLoader = Deployable }
 919    ("sysdep", "")       -> d{ dynLibLoader = SystemDependent }
 920    _                    -> ghcError (CmdLineError ("Unknown dynlib loader: " ++ f))
 921
 922 setDumpPrefixForce f d = d { dumpPrefixForce = f}
 923
 924 -- XXX HACK: Prelude> words "'does not' work" ===> ["'does","not'","work"]
 925 -- Config.hs should really use Option.
 926 setPgmP   f d = let (pgm:args) = words f in d{ pgm_P   = (pgm, map Option args)}
 927 addOptl   f d = d{ opt_l   = f : opt_l d}
 928 addOptP   f d = d{ opt_P   = f : opt_P d}
 929
 930
 931 setDepMakefile :: FilePath -> DynFlags -> DynFlags
 932 setDepMakefile f d = d { depMakefile = deOptDep f }
 933
 934 setDepIncludePkgDeps :: Bool -> DynFlags -> DynFlags
 935 setDepIncludePkgDeps b d = d { depIncludePkgDeps = b }
 936
 937 addDepExcludeMod :: String -> DynFlags -> DynFlags
 938 addDepExcludeMod m d
 939     = d { depExcludeMods = mkModuleName (deOptDep m) : depExcludeMods d }
 940
 941 addDepSuffix :: FilePath -> DynFlags -> DynFlags
 942 addDepSuffix s d = d { depSuffixes = deOptDep s : depSuffixes d }
 943
 944 -- XXX Legacy code:
 945 -- We used to use "-optdep-flag -optdeparg", so for legacy applications
 946 -- we need to strip the "-optdep" off of the arg
 947 deOptDep :: String -> String
 948 deOptDep x = case stripPrefix "-optdep" x of
 949              Just rest -> rest
 950              Nothing -> x
 951
 952 addCmdlineFramework f d = d{ cmdlineFrameworks = f : cmdlineFrameworks d}
 953
 954 addHaddockOpts f d = d{ haddockOptions = Just f}
 955
 956 -- -----------------------------------------------------------------------------
 957 -- Command-line options
 958
 959 -- | When invoking external tools as part of the compilation pipeline, we
 960 -- pass these a sequence of options on the command-line. Rather than
 961 -- just using a list of Strings, we use a type that allows us to distinguish
 962 -- between filepaths and 'other stuff'. The reason for this is that
 963 -- this type gives us a handle on transforming filenames, and filenames only,
 964 -- to whatever format they're expected to be on a particular platform.
 965 data Option
 966  = FileOption -- an entry that _contains_ filename(s) / filepaths.
 967               String  -- a non-filepath prefix that shouldn't be
 968                       -- transformed (e.g., "/out=")
 969               String  -- the filepath/filename portion
 970  | Option     String
 971
 972 showOpt :: Option -> String
 973 showOpt (FileOption pre f) = pre ++ f
 974 showOpt (Option s)  = s
 975
 976 -----------------------------------------------------------------------------
 977 -- Setting the optimisation level
 978
 979 updOptLevel :: Int -> DynFlags -> DynFlags
 980 -- ^ Sets the 'DynFlags' to be appropriate to the optimisation level
 981 updOptLevel n dfs
 982   = dfs2{ optLevel = final_n }
 983   where
 984    final_n = max 0 (min 2 n)    -- Clamp to 0 <= n <= 2
 985    dfs1 = foldr (flip dopt_unset) dfs  remove_dopts
 986    dfs2 = foldr (flip dopt_set)   dfs1 extra_dopts
 987
 988    extra_dopts  = [ f | (ns,f) <- optLevelFlags, final_n `elem` ns ]
 989    remove_dopts = [ f | (ns,f) <- optLevelFlags, final_n `notElem` ns ]
 990
 991 -- -----------------------------------------------------------------------------
 992 -- StgToDo:  abstraction of stg-to-stg passes to run.
 993
 994 data StgToDo
 995   = StgDoMassageForProfiling  -- should be (next to) last
 996   -- There's also setStgVarInfo, but its absolute "lastness"
 997   -- is so critical that it is hardwired in (no flag).
 998   | D_stg_stats
 999
1000 getStgToDo :: DynFlags -> [StgToDo]
1001 getStgToDo dflags
1002   = todo2
1003   where
1004         stg_stats = dopt Opt_StgStats dflags
1005
1006         todo1 = if stg_stats then [D_stg_stats] else []
1007
1008         todo2 | WayProf `elem` wayNames dflags
1009               = StgDoMassageForProfiling : todo1
1010               | otherwise
1011               = todo1
1012
1013 {- **********************************************************************
1014 %*                                                                      *
1015                 DynFlags parser
1016 %*                                                                      *
1017 %********************************************************************* -}
1018
1019 -- -----------------------------------------------------------------------------
1020 -- Parsing the dynamic flags.
1021
1022 -- | Parse dynamic flags from a list of command line arguments.  Returns the
1023 -- the parsed 'DynFlags', the left-over arguments, and a list of warnings.
1024 -- Throws a 'UsageError' if errors occurred during parsing (such as unknown
1025 -- flags or missing arguments).
1026 parseDynamicFlags :: Monad m =>
1027                      DynFlags -> [Located String]
1028                   -> m (DynFlags, [Located String], [Located String])
1029                      -- ^ Updated 'DynFlags', left-over arguments, and
1030                      -- list of warnings.
1031 parseDynamicFlags dflags args = parseDynamicFlags_ dflags args True
1032
1033 -- | Like 'parseDynamicFlags' but does not allow the package flags (-package,
1034 -- -hide-package, -ignore-package, -hide-all-packages, -package-conf).
1035 parseDynamicNoPackageFlags :: Monad m =>
1036                      DynFlags -> [Located String]
1037                   -> m (DynFlags, [Located String], [Located String])
1038                      -- ^ Updated 'DynFlags', left-over arguments, and
1039                      -- list of warnings.
1040 parseDynamicNoPackageFlags dflags args = parseDynamicFlags_ dflags args False
1041
1042 parseDynamicFlags_ :: Monad m =>
1043                       DynFlags -> [Located String] -> Bool
1044                   -> m (DynFlags, [Located String], [Located String])
1045 parseDynamicFlags_ dflags0 args pkg_flags = do
1046   -- XXX Legacy support code
1047   -- We used to accept things like
1048   --     optdep-f  -optdepdepend
1049   --     optdep-f  -optdep depend
1050   --     optdep -f -optdepdepend
1051   --     optdep -f -optdep depend
1052   -- but the spaces trip up proper argument handling. So get rid of them.
1053   let f (L p "-optdep" : L _ x : xs) = (L p ("-optdep" ++ x)) : f xs
1054       f (x : xs) = x : f xs
1055       f xs = xs
1056       args' = f args
1057
1058       -- Note: -ignore-package (package_flags) must precede -i* (dynamic_flags)
1059       flag_spec | pkg_flags = package_flags ++ dynamic_flags
1060                 | otherwise = dynamic_flags
1061
1062   let ((leftover, errs, warns), dflags1)
1063           = runCmdLine (processArgs flag_spec args') dflags0
1064   when (not (null errs)) $ ghcError $ errorsToGhcException errs
1065
1066   -- Cannot use -fPIC with registerised -fvia-C, because the mangler
1067   -- isn't up to the job.  We know that if hscTarget == HscC, then the
1068   -- user has explicitly used -fvia-C, because -fasm is the default,
1069   -- unless there is no NCG on this platform.  The latter case is
1070   -- checked when the -fPIC flag is parsed.
1071   --
1072   let (pic_warns, dflags2)
1073         | opt_PIC && hscTarget dflags1 == HscC && cGhcUnregisterised == "NO"
1074         = ([L noSrcSpan $ "Warning: -fvia-C is incompatible with -fPIC; ignoring -fvia-C"],
1075                 dflags1{ hscTarget = HscAsm })
1076 #if !(x86_64_TARGET_ARCH && linux_TARGET_OS)
1077         | (not opt_Static || opt_PIC) && hscTarget dflags1 == HscLlvm
1078         = ([L noSrcSpan $ "Warning: -fllvm is incompatible with -fPIC and -"
1079                 ++ "dynamic on this platform;\n              ignoring -fllvm"],
1080                 dflags1{ hscTarget = HscAsm })
1081 #endif
1082         | otherwise = ([], dflags1)
1083
1084   return (dflags2, leftover, pic_warns ++ warns)
1085
1086
1087 {- **********************************************************************
1088 %*                                                                      *
1089                 DynFlags specifications
1090 %*                                                                      *
1091 %********************************************************************* -}
1092
1093 allFlags :: [String]
1094 allFlags = map ('-':) $
1095            [ flagName flag | flag <- dynamic_flags, ok (flagOptKind flag) ] ++
1096            map ("fno-"++) flags ++
1097            map ("f"++) flags ++
1098            map ("f"++) flags' ++
1099            map ("X"++) supportedExtensions
1100     where ok (PrefixPred _ _) = False
1101           ok _ = True
1102           flags = [ name | (name, _, _) <- fFlags ]
1103           flags' = [ name | (name, _, _) <- fLangFlags ]
1104
1105 --------------- The main flags themselves ------------------
1106 dynamic_flags :: [Flag (CmdLineP DynFlags)]
1107 dynamic_flags = [
1108     Flag "n"        (NoArg (setDynFlag Opt_DryRun))
1109   , Flag "cpp"      (NoArg (setExtensionFlag Opt_Cpp))
1110   , Flag "F"        (NoArg (setDynFlag Opt_Pp))
1111   , Flag "#include"
1112          (HasArg (\s -> do { addCmdlineHCInclude s
1113                            ; addWarn "-#include and INCLUDE pragmas are deprecated: They no longer have any effect" }))
1114   , Flag "v"        (OptIntSuffix setVerbosity)
1115
1116         ------- Specific phases  --------------------------------------------
1117     -- need to appear before -pgmL to be parsed as LLVM flags.
1118   , Flag "pgmlo"          (hasArg (\f d -> d{ pgm_lo  = (f,[])}))
1119   , Flag "pgmlc"          (hasArg (\f d -> d{ pgm_lc  = (f,[])}))
1120   , Flag "pgmL"           (hasArg (\f d -> d{ pgm_L   = f}))
1121   , Flag "pgmP"           (hasArg setPgmP)
1122   , Flag "pgmF"           (hasArg (\f d -> d{ pgm_F   = f}))
1123   , Flag "pgmc"           (hasArg (\f d -> d{ pgm_c   = (f,[])}))
1124   , Flag "pgmm"           (hasArg (\f d -> d{ pgm_m   = (f,[])}))
1125   , Flag "pgms"           (hasArg (\f d -> d{ pgm_s   = (f,[])}))
1126   , Flag "pgma"           (hasArg (\f d -> d{ pgm_a   = (f,[])}))
1127   , Flag "pgml"           (hasArg (\f d -> d{ pgm_l   = (f,[])}))
1128   , Flag "pgmdll"         (hasArg (\f d -> d{ pgm_dll = (f,[])}))
1129   , Flag "pgmwindres"     (hasArg (\f d -> d{ pgm_windres = f}))
1130
1131     -- need to appear before -optl/-opta to be parsed as LLVM flags.
1132   , Flag "optlo"          (hasArg (\f d -> d{ opt_lo  = f : opt_lo d}))
1133   , Flag "optlc"          (hasArg (\f d -> d{ opt_lc  = f : opt_lc d}))
1134   , Flag "optL"           (hasArg (\f d -> d{ opt_L   = f : opt_L d}))
1135   , Flag "optP"           (hasArg addOptP)
1136   , Flag "optF"           (hasArg (\f d -> d{ opt_F   = f : opt_F d}))
1137   , Flag "optc"           (hasArg (\f d -> d{ opt_c   = f : opt_c d}))
1138   , Flag "optm"           (hasArg (\f d -> d{ opt_m   = f : opt_m d}))
1139   , Flag "opta"           (hasArg (\f d -> d{ opt_a   = f : opt_a d}))
1140   , Flag "optl"           (hasArg addOptl)
1141   , Flag "optwindres"     (hasArg (\f d -> d{ opt_windres = f : opt_windres d}))
1142
1143   , Flag "split-objs"
1144          (NoArg (if can_split
1145                  then setDynFlag Opt_SplitObjs
1146                  else addWarn "ignoring -fsplit-objs"))
1147
1148         -------- ghc -M -----------------------------------------------------
1149   , Flag "dep-suffix"     (hasArg addDepSuffix)
1150   , Flag "optdep-s"       (hasArgDF addDepSuffix "Use -dep-suffix instead")
1151   , Flag "dep-makefile"   (hasArg setDepMakefile)
1152   , Flag "optdep-f"       (hasArgDF setDepMakefile "Use -dep-makefile instead")
1153   , Flag "optdep-w"       (NoArg  (deprecate "doesn't do anything"))
1154   , Flag "include-pkg-deps"         (noArg (setDepIncludePkgDeps True))
1155   , Flag "optdep--include-prelude"  (noArgDF (setDepIncludePkgDeps True) "Use -include-pkg-deps instead")
1156   , Flag "optdep--include-pkg-deps" (noArgDF (setDepIncludePkgDeps True) "Use -include-pkg-deps instead")
1157   , Flag "exclude-module"           (hasArg addDepExcludeMod)
1158   , Flag "optdep--exclude-module"   (hasArgDF addDepExcludeMod "Use -exclude-module instead")
1159   , Flag "optdep-x"                 (hasArgDF addDepExcludeMod "Use -exclude-module instead")
1160
1161         -------- Linking ----------------------------------------------------
1162   , Flag "no-link"            (noArg (\d -> d{ ghcLink=NoLink }))
1163   , Flag "shared"             (noArg (\d -> d{ ghcLink=LinkDynLib }))
1164   , Flag "dynload"            (hasArg parseDynLibLoaderMode)
1165   , Flag "dylib-install-name" (hasArg setDylibInstallName)
1166
1167         ------- Libraries ---------------------------------------------------
1168   , Flag "L"   (Prefix    addLibraryPath)
1169   , Flag "l"   (AnySuffix (upd . addOptl))
1170
1171         ------- Frameworks --------------------------------------------------
1172         -- -framework-path should really be -F ...
1173   , Flag "framework-path" (HasArg addFrameworkPath)
1174   , Flag "framework"      (hasArg addCmdlineFramework)
1175
1176         ------- Output Redirection ------------------------------------------
1177   , Flag "odir"              (hasArg setObjectDir)
1178   , Flag "o"                 (SepArg (upd . setOutputFile . Just))
1179   , Flag "ohi"               (hasArg (setOutputHi . Just ))
1180   , Flag "osuf"              (hasArg setObjectSuf)
1181   , Flag "hcsuf"             (hasArg setHcSuf)
1182   , Flag "hisuf"             (hasArg setHiSuf)
1183   , Flag "hidir"             (hasArg setHiDir)
1184   , Flag "tmpdir"            (hasArg setTmpDir)
1185   , Flag "stubdir"           (hasArg setStubDir)
1186   , Flag "outputdir"         (hasArg setOutputDir)
1187   , Flag "ddump-file-prefix" (hasArg (setDumpPrefixForce . Just))
1188
1189         ------- Keeping temporary files -------------------------------------
1190      -- These can be singular (think ghc -c) or plural (think ghc --make)
1191   , Flag "keep-hc-file"     (NoArg (setDynFlag Opt_KeepHcFiles))
1192   , Flag "keep-hc-files"    (NoArg (setDynFlag Opt_KeepHcFiles))
1193   , Flag "keep-s-file"      (NoArg (setDynFlag Opt_KeepSFiles))
1194   , Flag "keep-s-files"     (NoArg (setDynFlag Opt_KeepSFiles))
1195   , Flag "keep-raw-s-file"  (NoArg (setDynFlag Opt_KeepRawSFiles))
1196   , Flag "keep-raw-s-files" (NoArg (setDynFlag Opt_KeepRawSFiles))
1197   , Flag "keep-llvm-file"   (NoArg (setDynFlag Opt_KeepLlvmFiles))
1198   , Flag "keep-llvm-files"  (NoArg (setDynFlag Opt_KeepLlvmFiles))
1199      -- This only makes sense as plural
1200   , Flag "keep-tmp-files"   (NoArg (setDynFlag Opt_KeepTmpFiles))
1201
1202         ------- Miscellaneous ----------------------------------------------
1203   , Flag "no-auto-link-packages" (NoArg (unSetDynFlag Opt_AutoLinkPackages))
1204   , Flag "no-hs-main"     (NoArg (setDynFlag Opt_NoHsMain))
1205   , Flag "with-rtsopts"   (HasArg setRtsOpts)
1206   , Flag "rtsopts"        (NoArg (setRtsOptsEnabled RtsOptsAll))
1207   , Flag "rtsopts=all"    (NoArg (setRtsOptsEnabled RtsOptsAll))
1208   , Flag "rtsopts=some"   (NoArg (setRtsOptsEnabled RtsOptsSafeOnly))
1209   , Flag "rtsopts=none"   (NoArg (setRtsOptsEnabled RtsOptsNone))
1210   , Flag "no-rtsopts"     (NoArg (setRtsOptsEnabled RtsOptsNone))
1211   , Flag "main-is"        (SepArg setMainIs)
1212   , Flag "haddock"        (NoArg (setDynFlag Opt_Haddock))
1213   , Flag "haddock-opts"   (hasArg addHaddockOpts)
1214   , Flag "hpcdir"         (SepArg setOptHpcDir)
1215
1216         ------- recompilation checker --------------------------------------
1217   , Flag "recomp"         (NoArg (do { unSetDynFlag Opt_ForceRecomp
1218                                      ; deprecate "Use -fno-force-recomp instead" }))
1219   , Flag "no-recomp"      (NoArg (do { setDynFlag Opt_ForceRecomp
1220                                      ; deprecate "Use -fforce-recomp instead" }))
1221
1222         ------ HsCpp opts ---------------------------------------------------
1223   , Flag "D"              (AnySuffix (upd . addOptP))
1224   , Flag "U"              (AnySuffix (upd . addOptP))
1225
1226         ------- Include/Import Paths ----------------------------------------
1227   , Flag "I"              (Prefix    addIncludePath)
1228   , Flag "i"              (OptPrefix addImportPath)
1229
1230         ------ Debugging ----------------------------------------------------
1231   , Flag "dstg-stats"     (NoArg (setDynFlag Opt_StgStats))
1232
1233   , Flag "ddump-cmm"               (setDumpFlag Opt_D_dump_cmm)
1234   , Flag "ddump-cmmz"              (setDumpFlag Opt_D_dump_cmmz)
1235   , Flag "ddump-cmmz-pretty"       (setDumpFlag Opt_D_dump_cmmz_pretty)
1236   , Flag "ddump-cps-cmm"           (setDumpFlag Opt_D_dump_cps_cmm)
1237   , Flag "ddump-cvt-cmm"           (setDumpFlag Opt_D_dump_cvt_cmm)
1238   , Flag "ddump-asm"               (setDumpFlag Opt_D_dump_asm)
1239   , Flag "ddump-asm-native"        (setDumpFlag Opt_D_dump_asm_native)
1240   , Flag "ddump-asm-liveness"      (setDumpFlag Opt_D_dump_asm_liveness)
1241   , Flag "ddump-asm-coalesce"      (setDumpFlag Opt_D_dump_asm_coalesce)
1242   , Flag "ddump-asm-regalloc"      (setDumpFlag Opt_D_dump_asm_regalloc)
1243   , Flag "ddump-asm-conflicts"     (setDumpFlag Opt_D_dump_asm_conflicts)
1244   , Flag "ddump-asm-regalloc-stages" (setDumpFlag Opt_D_dump_asm_regalloc_stages)
1245   , Flag "ddump-asm-stats"         (setDumpFlag Opt_D_dump_asm_stats)
1246   , Flag "ddump-asm-expanded"      (setDumpFlag Opt_D_dump_asm_expanded)
1247   , Flag "ddump-llvm"              (NoArg (do { setObjTarget HscLlvm
1248                                               ; setDumpFlag' Opt_D_dump_llvm}))
1249   , Flag "ddump-cpranal"           (setDumpFlag Opt_D_dump_cpranal)
1250   , Flag "ddump-deriv"             (setDumpFlag Opt_D_dump_deriv)
1251   , Flag "ddump-ds"                (setDumpFlag Opt_D_dump_ds)
1252   , Flag "ddump-flatC"             (setDumpFlag Opt_D_dump_flatC)
1253   , Flag "ddump-foreign"           (setDumpFlag Opt_D_dump_foreign)
1254   , Flag "ddump-inlinings"         (setDumpFlag Opt_D_dump_inlinings)
1255   , Flag "ddump-rule-firings"      (setDumpFlag Opt_D_dump_rule_firings)
1256   , Flag "ddump-occur-anal"        (setDumpFlag Opt_D_dump_occur_anal)
1257   , Flag "ddump-parsed"            (setDumpFlag Opt_D_dump_parsed)
1258   , Flag "ddump-rn"                (setDumpFlag Opt_D_dump_rn)
1259   , Flag "ddump-simpl"             (setDumpFlag Opt_D_dump_simpl)
1260   , Flag "ddump-simpl-iterations"  (setDumpFlag Opt_D_dump_simpl_iterations)
1261   , Flag "ddump-simpl-phases"      (OptPrefix setDumpSimplPhases)
1262   , Flag "ddump-spec"              (setDumpFlag Opt_D_dump_spec)
1263   , Flag "ddump-prep"              (setDumpFlag Opt_D_dump_prep)
1264   , Flag "ddump-stg"               (setDumpFlag Opt_D_dump_stg)
1265   , Flag "ddump-stranal"           (setDumpFlag Opt_D_dump_stranal)
1266   , Flag "ddump-tc"                (setDumpFlag Opt_D_dump_tc)
1267   , Flag "ddump-types"             (setDumpFlag Opt_D_dump_types)
1268   , Flag "ddump-rules"             (setDumpFlag Opt_D_dump_rules)
1269   , Flag "ddump-cse"               (setDumpFlag Opt_D_dump_cse)
1270   , Flag "ddump-worker-wrapper"    (setDumpFlag Opt_D_dump_worker_wrapper)
1271   , Flag "ddump-rn-trace"          (setDumpFlag Opt_D_dump_rn_trace)
1272   , Flag "ddump-if-trace"          (setDumpFlag Opt_D_dump_if_trace)
1273   , Flag "ddump-tc-trace"          (setDumpFlag Opt_D_dump_tc_trace)
1274   , Flag "ddump-splices"           (setDumpFlag Opt_D_dump_splices)
1275   , Flag "ddump-rn-stats"          (setDumpFlag Opt_D_dump_rn_stats)
1276   , Flag "ddump-opt-cmm"           (setDumpFlag Opt_D_dump_opt_cmm)
1277   , Flag "ddump-simpl-stats"       (setDumpFlag Opt_D_dump_simpl_stats)
1278   , Flag "ddump-bcos"              (setDumpFlag Opt_D_dump_BCOs)
1279   , Flag "dsource-stats"           (setDumpFlag Opt_D_source_stats)
1280   , Flag "dverbose-core2core"      (NoArg (do { setVerbosity (Just 2)
1281                                               ; setVerboseCore2Core }))
1282   , Flag "dverbose-stg2stg"        (setDumpFlag Opt_D_verbose_stg2stg)
1283   , Flag "ddump-hi"                (setDumpFlag Opt_D_dump_hi)
1284   , Flag "ddump-minimal-imports"   (setDumpFlag Opt_D_dump_minimal_imports)
1285   , Flag "ddump-vect"              (setDumpFlag Opt_D_dump_vect)
1286   , Flag "ddump-hpc"               (setDumpFlag Opt_D_dump_hpc)
1287   , Flag "ddump-mod-cycles"        (setDumpFlag Opt_D_dump_mod_cycles)
1288   , Flag "ddump-view-pattern-commoning" (setDumpFlag Opt_D_dump_view_pattern_commoning)
1289   , Flag "ddump-to-file"           (setDumpFlag Opt_DumpToFile)
1290   , Flag "ddump-hi-diffs"          (setDumpFlag Opt_D_dump_hi_diffs)
1291   , Flag "ddump-rtti"              (setDumpFlag Opt_D_dump_rtti)
1292   , Flag "dcore-lint"              (NoArg (setDynFlag Opt_DoCoreLinting))
1293   , Flag "dstg-lint"               (NoArg (setDynFlag Opt_DoStgLinting))
1294   , Flag "dcmm-lint"               (NoArg (setDynFlag Opt_DoCmmLinting))
1295   , Flag "dasm-lint"               (NoArg (setDynFlag Opt_DoAsmLinting))
1296   , Flag "dshow-passes"            (NoArg (do forceRecompile
1297                                               setVerbosity (Just 2)))
1298   , Flag "dfaststring-stats"       (NoArg (setDynFlag Opt_D_faststring_stats))
1299
1300         ------ Machine dependant (-m<blah>) stuff ---------------------------
1301
1302   , Flag "monly-2-regs" (noArg (\s -> s{stolen_x86_regs = 2}))
1303   , Flag "monly-3-regs" (noArg (\s -> s{stolen_x86_regs = 3}))
1304   , Flag "monly-4-regs" (noArg (\s -> s{stolen_x86_regs = 4}))
1305   , Flag "msse2"        (NoArg (setDynFlag Opt_SSE2))
1306
1307      ------ Warning opts -------------------------------------------------
1308   , Flag "W"      (NoArg (mapM_ setDynFlag   minusWOpts))
1309   , Flag "Werror" (NoArg (setDynFlag         Opt_WarnIsError))
1310   , Flag "Wwarn"  (NoArg (unSetDynFlag       Opt_WarnIsError))
1311   , Flag "Wall"   (NoArg (mapM_ setDynFlag   minusWallOpts))
1312   , Flag "Wnot"   (NoArg (do { mapM_ unSetDynFlag minusWallOpts
1313                              ; deprecate "Use -w instead" }))
1314   , Flag "w"      (NoArg (mapM_ unSetDynFlag minuswRemovesOpts))
1315
1316         ------ Optimisation flags ------------------------------------------
1317   , Flag "O"      (noArg (setOptLevel 1))
1318   , Flag "Onot"   (noArgDF (setOptLevel 0) "Use -O0 instead")
1319   , Flag "Odph"   (noArg setDPHOpt)
1320   , Flag "O"      (OptIntSuffix (\mb_n -> upd (setOptLevel (mb_n `orElse` 1))))
1321                 -- If the number is missing, use 1
1322
1323   , Flag "fsimplifier-phases"          (intSuffix (\n d -> d{ simplPhases = n }))
1324   , Flag "fmax-simplifier-iterations"  (intSuffix (\n d -> d{ maxSimplIterations = n }))
1325   , Flag "fspec-constr-threshold"      (intSuffix (\n d -> d{ specConstrThreshold = Just n }))
1326   , Flag "fno-spec-constr-threshold"   (noArg (\d -> d{ specConstrThreshold = Nothing }))
1327   , Flag "fspec-constr-count"          (intSuffix (\n d -> d{ specConstrCount = Just n }))
1328   , Flag "fno-spec-constr-count"       (noArg (\d -> d{ specConstrCount = Nothing }))
1329   , Flag "fliberate-case-threshold"    (intSuffix (\n d -> d{ liberateCaseThreshold = Just n }))
1330   , Flag "fno-liberate-case-threshold" (noArg (\d -> d{ liberateCaseThreshold = Nothing }))
1331   , Flag "frule-check"                 (SepArg (\s -> upd (\d -> d{ ruleCheck = Just s })))
1332   , Flag "fcontext-stack"              (intSuffix (\n d -> d{ ctxtStkDepth = n }))
1333   , Flag "fstrictness-before"          (intSuffix (\n d -> d{ strictnessBefore = n : strictnessBefore d }))
1334
1335         ------ Profiling ----------------------------------------------------
1336
1337   -- XXX Should the -f* flags be deprecated?
1338   -- They don't seem to be documented
1339   , Flag "fauto-sccs-on-all-toplevs"       (NoArg (setDynFlag Opt_AutoSccsOnAllToplevs))
1340   , Flag "auto-all"                        (NoArg (setDynFlag Opt_AutoSccsOnAllToplevs))
1341   , Flag "no-auto-all"                     (NoArg (unSetDynFlag Opt_AutoSccsOnAllToplevs))
1342   , Flag "fauto-sccs-on-exported-toplevs"  (NoArg (setDynFlag Opt_AutoSccsOnExportedToplevs))
1343   , Flag "auto"                            (NoArg (setDynFlag Opt_AutoSccsOnExportedToplevs))
1344   , Flag "no-auto"                         (NoArg (unSetDynFlag Opt_AutoSccsOnExportedToplevs))
1345   , Flag "fauto-sccs-on-individual-cafs"   (NoArg (setDynFlag Opt_AutoSccsOnIndividualCafs))
1346   , Flag "caf-all"                         (NoArg (setDynFlag Opt_AutoSccsOnIndividualCafs))
1347   , Flag "no-caf-all"                      (NoArg (unSetDynFlag Opt_AutoSccsOnIndividualCafs))
1348
1349         ------ DPH flags ----------------------------------------------------
1350
1351   , Flag "fdph-seq"         (NoArg (setDPHBackend DPHSeq))
1352   , Flag "fdph-par"         (NoArg (setDPHBackend DPHPar))
1353   , Flag "fdph-this"        (NoArg (setDPHBackend DPHThis))
1354
1355         ------ Compiler flags -----------------------------------------------
1356
1357   , Flag "fasm"             (NoArg (setObjTarget HscAsm))
1358   , Flag "fvia-c"           (NoArg (setObjTarget HscC >>
1359          (addWarn "The -fvia-c flag will be removed in a future GHC release")))
1360   , Flag "fvia-C"           (NoArg (setObjTarget HscC >>
1361          (addWarn "The -fvia-C flag will be removed in a future GHC release")))
1362   , Flag "fllvm"            (NoArg (setObjTarget HscLlvm))
1363
1364   , Flag "fno-code"         (NoArg (do upd $ \d -> d{ ghcLink=NoLink }
1365                                        setTarget HscNothing))
1366   , Flag "fbyte-code"       (NoArg (setTarget HscInterpreted))
1367   , Flag "fobject-code"     (NoArg (setTarget defaultHscTarget))
1368   , Flag "fglasgow-exts"    (NoArg enableGlasgowExts)
1369   , Flag "fno-glasgow-exts" (NoArg disableGlasgowExts)
1370  ]
1371  ++ map (mkFlag True  "f"    setDynFlag  ) fFlags
1372  ++ map (mkFlag False "fno-" unSetDynFlag) fFlags
1373  ++ map (mkFlag True  "f"    setExtensionFlag  ) fLangFlags
1374  ++ map (mkFlag False "fno-" unSetExtensionFlag) fLangFlags
1375  ++ map (mkFlag True  "X"    setExtensionFlag  ) xFlags
1376  ++ map (mkFlag False "XNo"  unSetExtensionFlag) xFlags
1377  ++ map (mkFlag True  "X"    setLanguage) languageFlags
1378
1379 package_flags :: [Flag (CmdLineP DynFlags)]
1380 package_flags = [
1381         ------- Packages ----------------------------------------------------
1382     Flag "package-conf"         (HasArg extraPkgConf_)
1383   , Flag "no-user-package-conf" (NoArg (unSetDynFlag Opt_ReadUserPackageConf))
1384   , Flag "package-name"         (hasArg setPackageName)
1385   , Flag "package-id"           (HasArg exposePackageId)
1386   , Flag "package"              (HasArg exposePackage)
1387   , Flag "hide-package"         (HasArg hidePackage)
1388   , Flag "hide-all-packages"    (NoArg (setDynFlag Opt_HideAllPackages))
1389   , Flag "ignore-package"       (HasArg ignorePackage)
1390   , Flag "syslib"               (HasArg (\s -> do { exposePackage s
1391                                                   ; deprecate "Use -package instead" }))
1392   ]
1393
1394 type FlagSpec flag
1395    = ( String   -- Flag in string form
1396      , flag     -- Flag in internal form
1397      , Bool -> DynP ())  -- Extra action to run when the flag is found
1398                          -- Typically, emit a warning or error
1399                          -- True  <=> we are turning the flag on
1400                          -- False <=> we are turning the flag off
1401
1402
1403 mkFlag :: Bool                  -- ^ True <=> it should be turned on
1404        -> String                -- ^ The flag prefix
1405        -> (flag -> DynP ())     -- ^ What to do when the flag is found
1406        -> FlagSpec flag         -- ^ Specification of this particular flag
1407        -> Flag (CmdLineP DynFlags)
1408 mkFlag turnOn flagPrefix f (name, flag, extra_action)
1409     = Flag (flagPrefix ++ name) (NoArg (f flag >> extra_action turnOn))
1410
1411 deprecatedForExtension :: String -> Bool -> DynP ()
1412 deprecatedForExtension lang turn_on
1413     = deprecate ("use -X"  ++ flag ++ " or pragma {-# LANGUAGE " ++ flag ++ " #-} instead")
1414     where
1415       flag | turn_on    = lang
1416            | otherwise = "No"++lang
1417
1418 useInstead :: String -> Bool -> DynP ()
1419 useInstead flag turn_on
1420   = deprecate ("Use -f" ++ no ++ flag ++ " instead")
1421   where
1422     no = if turn_on then "" else "no-"
1423
1424 nop :: Bool -> DynP ()
1425 nop _ = return ()
1426
1427 -- | These @-f\<blah\>@ flags can all be reversed with @-fno-\<blah\>@
1428 fFlags :: [FlagSpec DynFlag]
1429 fFlags = [
1430   ( "warn-dodgy-foreign-imports",       Opt_WarnDodgyForeignImports, nop ),
1431   ( "warn-dodgy-exports",               Opt_WarnDodgyExports, nop ),
1432   ( "warn-dodgy-imports",               Opt_WarnDodgyImports, nop ),
1433   ( "warn-duplicate-exports",           Opt_WarnDuplicateExports, nop ),
1434   ( "warn-hi-shadowing",                Opt_WarnHiShadows, nop ),
1435   ( "warn-implicit-prelude",            Opt_WarnImplicitPrelude, nop ),
1436   ( "warn-incomplete-patterns",         Opt_WarnIncompletePatterns, nop ),
1437   ( "warn-incomplete-record-updates",   Opt_WarnIncompletePatternsRecUpd, nop ),
1438   ( "warn-missing-fields",              Opt_WarnMissingFields, nop ),
1439   ( "warn-missing-import-lists",        Opt_WarnMissingImportList, nop ),
1440   ( "warn-missing-methods",             Opt_WarnMissingMethods, nop ),
1441   ( "warn-missing-signatures",          Opt_WarnMissingSigs, nop ),
1442   ( "warn-name-shadowing",              Opt_WarnNameShadowing, nop ),
1443   ( "warn-overlapping-patterns",        Opt_WarnOverlappingPatterns, nop ),
1444   ( "warn-simple-patterns",             Opt_WarnSimplePatterns, nop ),
1445   ( "warn-type-defaults",               Opt_WarnTypeDefaults, nop ),
1446   ( "warn-monomorphism-restriction",    Opt_WarnMonomorphism, nop ),
1447   ( "warn-unused-binds",                Opt_WarnUnusedBinds, nop ),
1448   ( "warn-unused-imports",              Opt_WarnUnusedImports, nop ),
1449   ( "warn-unused-matches",              Opt_WarnUnusedMatches, nop ),
1450   ( "warn-warnings-deprecations",       Opt_WarnWarningsDeprecations, nop ),
1451   ( "warn-deprecations",                Opt_WarnWarningsDeprecations, nop ),
1452   ( "warn-deprecated-flags",            Opt_WarnDeprecatedFlags, nop ),
1453   ( "warn-orphans",                     Opt_WarnOrphans, nop ),
1454   ( "warn-tabs",                        Opt_WarnTabs, nop ),
1455   ( "warn-unrecognised-pragmas",        Opt_WarnUnrecognisedPragmas, nop ),
1456   ( "warn-lazy-unlifted-bindings",      Opt_WarnLazyUnliftedBindings, nop),
1457   ( "warn-unused-do-bind",              Opt_WarnUnusedDoBind, nop ),
1458   ( "warn-wrong-do-bind",               Opt_WarnWrongDoBind, nop ),
1459   ( "warn-alternative-layout-rule-transitional", Opt_WarnAlternativeLayoutRuleTransitional, nop ),
1460   ( "print-explicit-foralls",           Opt_PrintExplicitForalls, nop ),
1461   ( "strictness",                       Opt_Strictness, nop ),
1462   ( "specialise",                       Opt_Specialise, nop ),
1463   ( "float-in",                         Opt_FloatIn, nop ),
1464   ( "static-argument-transformation",   Opt_StaticArgumentTransformation, nop ),
1465   ( "full-laziness",                    Opt_FullLaziness, nop ),
1466   ( "liberate-case",                    Opt_LiberateCase, nop ),
1467   ( "spec-constr",                      Opt_SpecConstr, nop ),
1468   ( "cse",                              Opt_CSE, nop ),
1469   ( "ignore-interface-pragmas",         Opt_IgnoreInterfacePragmas, nop ),
1470   ( "omit-interface-pragmas",           Opt_OmitInterfacePragmas, nop ),
1471   ( "expose-all-unfoldings",            Opt_ExposeAllUnfoldings, nop ),
1472   ( "do-lambda-eta-expansion",          Opt_DoLambdaEtaExpansion, nop ),
1473   ( "ignore-asserts",                   Opt_IgnoreAsserts, nop ),
1474   ( "do-eta-reduction",                 Opt_DoEtaReduction, nop ),
1475   ( "case-merge",                       Opt_CaseMerge, nop ),
1476   ( "unbox-strict-fields",              Opt_UnboxStrictFields, nop ),
1477   ( "method-sharing",                   Opt_MethodSharing, nop ),
1478   ( "dicts-cheap",                      Opt_DictsCheap, nop ),
1479   ( "excess-precision",                 Opt_ExcessPrecision, nop ),
1480   ( "eager-blackholing",                Opt_EagerBlackHoling, nop ),
1481   ( "asm-mangling",                     Opt_DoAsmMangling, nop ),
1482   ( "print-bind-result",                Opt_PrintBindResult, nop ),
1483   ( "force-recomp",                     Opt_ForceRecomp, nop ),
1484   ( "hpc-no-auto",                      Opt_Hpc_No_Auto, nop ),
1485   ( "rewrite-rules",                    Opt_EnableRewriteRules, useInstead "enable-rewrite-rules" ),
1486   ( "enable-rewrite-rules",             Opt_EnableRewriteRules, nop ),
1487   ( "break-on-exception",               Opt_BreakOnException, nop ),
1488   ( "break-on-error",                   Opt_BreakOnError, nop ),
1489   ( "print-evld-with-show",             Opt_PrintEvldWithShow, nop ),
1490   ( "print-bind-contents",              Opt_PrintBindContents, nop ),
1491   ( "run-cps",                          Opt_RunCPS, nop ),
1492   ( "run-cpsz",                         Opt_RunCPSZ, nop ),
1493   ( "new-codegen",                      Opt_TryNewCodeGen, nop ),
1494   ( "convert-to-zipper-and-back",       Opt_ConvertToZipCfgAndBack, nop ),
1495   ( "vectorise",                        Opt_Vectorise, nop ),
1496   ( "regs-graph",                       Opt_RegsGraph, nop ),
1497   ( "regs-iterative",                   Opt_RegsIterative, nop ),
1498   ( "gen-manifest",                     Opt_GenManifest, nop ),
1499   ( "embed-manifest",                   Opt_EmbedManifest, nop ),
1500   ( "ext-core",                         Opt_EmitExternalCore, nop ),
1501   ( "shared-implib",                    Opt_SharedImplib, nop ),
1502   ( "building-cabal-package",           Opt_BuildingCabalPackage, nop ),
1503   ( "implicit-import-qualified",        Opt_ImplicitImportQualified, nop )
1504   ]
1505
1506 -- | These @-f\<blah\>@ flags can all be reversed with @-fno-\<blah\>@
1507 fLangFlags :: [FlagSpec ExtensionFlag]
1508 fLangFlags = [
1509   ( "th",                               Opt_TemplateHaskell,
1510     deprecatedForExtension "TemplateHaskell" >> checkTemplateHaskellOk ),
1511   ( "fi",                               Opt_ForeignFunctionInterface,
1512     deprecatedForExtension "ForeignFunctionInterface" ),
1513   ( "ffi",                              Opt_ForeignFunctionInterface,
1514     deprecatedForExtension "ForeignFunctionInterface" ),
1515   ( "arrows",                           Opt_Arrows,
1516     deprecatedForExtension "Arrows" ),
1517   ( "generics",                         Opt_Generics,
1518     deprecatedForExtension "Generics" ),
1519   ( "implicit-prelude",                 Opt_ImplicitPrelude,
1520     deprecatedForExtension "ImplicitPrelude" ),
1521   ( "bang-patterns",                    Opt_BangPatterns,
1522     deprecatedForExtension "BangPatterns" ),
1523   ( "monomorphism-restriction",         Opt_MonomorphismRestriction,
1524     deprecatedForExtension "MonomorphismRestriction" ),
1525   ( "mono-pat-binds",                   Opt_MonoPatBinds,
1526     deprecatedForExtension "MonoPatBinds" ),
1527   ( "extended-default-rules",           Opt_ExtendedDefaultRules,
1528     deprecatedForExtension "ExtendedDefaultRules" ),
1529   ( "implicit-params",                  Opt_ImplicitParams,
1530     deprecatedForExtension "ImplicitParams" ),
1531   ( "scoped-type-variables",            Opt_ScopedTypeVariables,
1532     deprecatedForExtension "ScopedTypeVariables" ),
1533   ( "parr",                             Opt_PArr,
1534     deprecatedForExtension "PArr" ),
1535   ( "allow-overlapping-instances",      Opt_OverlappingInstances,
1536     deprecatedForExtension "OverlappingInstances" ),
1537   ( "allow-undecidable-instances",      Opt_UndecidableInstances,
1538     deprecatedForExtension "UndecidableInstances" ),
1539   ( "allow-incoherent-instances",       Opt_IncoherentInstances,
1540     deprecatedForExtension "IncoherentInstances" )
1541   ]
1542
1543 supportedLanguages :: [String]
1544 supportedLanguages = [ name | (name, _, _) <- languageFlags ]
1545
1546 supportedExtensions :: [String]
1547 supportedExtensions = [ name' | (name, _, _) <- xFlags, name' <- [name, "No" ++ name] ]
1548
1549 supportedLanguagesAndExtensions :: [String]
1550 supportedLanguagesAndExtensions = supportedLanguages ++ supportedExtensions
1551
1552 -- | These -X<blah> flags cannot be reversed with -XNo<blah>
1553 languageFlags :: [FlagSpec Language]
1554 languageFlags = [
1555   ( "Haskell98",                        Haskell98, nop ),
1556   ( "Haskell2010",                      Haskell2010, nop )
1557   ]
1558
1559 -- | These -X<blah> flags can all be reversed with -XNo<blah>
1560 xFlags :: [FlagSpec ExtensionFlag]
1561 xFlags = [
1562   ( "CPP",                              Opt_Cpp, nop ),
1563   ( "PostfixOperators",                 Opt_PostfixOperators, nop ),
1564   ( "TupleSections",                    Opt_TupleSections, nop ),
1565   ( "PatternGuards",                    Opt_PatternGuards, nop ),
1566   ( "UnicodeSyntax",                    Opt_UnicodeSyntax, nop ),
1567   ( "MagicHash",                        Opt_MagicHash, nop ),
1568   ( "PolymorphicComponents",            Opt_PolymorphicComponents, nop ),
1569   ( "ExistentialQuantification",        Opt_ExistentialQuantification, nop ),
1570   ( "KindSignatures",                   Opt_KindSignatures, nop ),
1571   ( "EmptyDataDecls",                   Opt_EmptyDataDecls, nop ),
1572   ( "ParallelListComp",                 Opt_ParallelListComp, nop ),
1573   ( "TransformListComp",                Opt_TransformListComp, nop ),
1574   ( "ForeignFunctionInterface",         Opt_ForeignFunctionInterface, nop ),
1575   ( "UnliftedFFITypes",                 Opt_UnliftedFFITypes, nop ),
1576   ( "GHCForeignImportPrim",             Opt_GHCForeignImportPrim, nop ),
1577   ( "LiberalTypeSynonyms",              Opt_LiberalTypeSynonyms, nop ),
1578   ( "Rank2Types",                       Opt_Rank2Types, nop ),
1579   ( "RankNTypes",                       Opt_RankNTypes, nop ),
1580   ( "ImpredicativeTypes",               Opt_ImpredicativeTypes,
1581         \_ -> deprecate "impredicative polymorphism will be simplified or removed in GHC 6.14" ),
1582   ( "TypeOperators",                    Opt_TypeOperators, nop ),
1583   ( "RecursiveDo",                      Opt_RecursiveDo,
1584     deprecatedForExtension "DoRec"),
1585   ( "DoRec",                            Opt_DoRec, nop ),
1586   ( "Arrows",                           Opt_Arrows, nop ),
1587   ( "PArr",                             Opt_PArr, nop ),
1588   ( "TemplateHaskell",                  Opt_TemplateHaskell, checkTemplateHaskellOk ),
1589   ( "QuasiQuotes",                      Opt_QuasiQuotes, nop ),
1590   ( "Generics",                         Opt_Generics, nop ),
1591   ( "ImplicitPrelude",                  Opt_ImplicitPrelude, nop ),
1592   ( "RecordWildCards",                  Opt_RecordWildCards, nop ),
1593   ( "NamedFieldPuns",                   Opt_RecordPuns, nop ),
1594   ( "RecordPuns",                       Opt_RecordPuns,
1595     deprecatedForExtension "NamedFieldPuns" ),
1596   ( "DisambiguateRecordFields",         Opt_DisambiguateRecordFields, nop ),
1597   ( "OverloadedStrings",                Opt_OverloadedStrings, nop ),
1598   ( "GADTs",                            Opt_GADTs, nop ),
1599   ( "ViewPatterns",                     Opt_ViewPatterns, nop ),
1600   ( "TypeFamilies",                     Opt_TypeFamilies, nop ),
1601   ( "BangPatterns",                     Opt_BangPatterns, nop ),
1602   ( "MonomorphismRestriction",          Opt_MonomorphismRestriction, nop ),
1603   ( "NPlusKPatterns",                   Opt_NPlusKPatterns, nop ),
1604   ( "DoAndIfThenElse",                  Opt_DoAndIfThenElse, nop ),
1605   ( "MonoPatBinds",                     Opt_MonoPatBinds, nop ),
1606   ( "ExplicitForAll",                   Opt_ExplicitForAll, nop ),
1607   ( "AlternativeLayoutRule",            Opt_AlternativeLayoutRule, nop ),
1608   ( "AlternativeLayoutRuleTransitional",Opt_AlternativeLayoutRuleTransitional, nop ),
1609   ( "DatatypeContexts",                 Opt_DatatypeContexts, nop ),
1610   ( "MonoLocalBinds",                   Opt_MonoLocalBinds, nop ),
1611   ( "RelaxedPolyRec",                   Opt_RelaxedPolyRec,
1612     \ turn_on -> if not turn_on
1613                  then deprecate "You can't turn off RelaxedPolyRec any more"
1614                  else return () ),
1615   ( "ExtendedDefaultRules",             Opt_ExtendedDefaultRules, nop ),
1616   ( "ImplicitParams",                   Opt_ImplicitParams, nop ),
1617   ( "ScopedTypeVariables",              Opt_ScopedTypeVariables, nop ),
1618
1619   ( "PatternSignatures",                Opt_ScopedTypeVariables,
1620     deprecatedForExtension "ScopedTypeVariables" ),
1621
1622   ( "UnboxedTuples",                    Opt_UnboxedTuples, nop ),
1623   ( "StandaloneDeriving",               Opt_StandaloneDeriving, nop ),
1624   ( "DeriveDataTypeable",               Opt_DeriveDataTypeable, nop ),
1625   ( "DeriveFunctor",                    Opt_DeriveFunctor, nop ),
1626   ( "DeriveTraversable",                Opt_DeriveTraversable, nop ),
1627   ( "DeriveFoldable",                   Opt_DeriveFoldable, nop ),
1628   ( "TypeSynonymInstances",             Opt_TypeSynonymInstances, nop ),
1629   ( "FlexibleContexts",                 Opt_FlexibleContexts, nop ),
1630   ( "FlexibleInstances",                Opt_FlexibleInstances, nop ),
1631   ( "ConstrainedClassMethods",          Opt_ConstrainedClassMethods, nop ),
1632   ( "MultiParamTypeClasses",            Opt_MultiParamTypeClasses, nop ),
1633   ( "FunctionalDependencies",           Opt_FunctionalDependencies, nop ),
1634   ( "GeneralizedNewtypeDeriving",       Opt_GeneralizedNewtypeDeriving, nop ),
1635   ( "OverlappingInstances",             Opt_OverlappingInstances, nop ),
1636   ( "UndecidableInstances",             Opt_UndecidableInstances, nop ),
1637   ( "IncoherentInstances",              Opt_IncoherentInstances, nop ),
1638   ( "PackageImports",                   Opt_PackageImports, nop ),
1639   ( "NewQualifiedOperators",            Opt_NewQualifiedOperators,
1640     \_ -> deprecate "The new qualified operator syntax was rejected by Haskell'" )
1641   ]
1642
1643 defaultFlags :: [DynFlag]
1644 defaultFlags
1645   = [ Opt_AutoLinkPackages,
1646       Opt_ReadUserPackageConf,
1647
1648       Opt_MethodSharing,
1649
1650       Opt_DoAsmMangling,
1651
1652       Opt_SharedImplib,
1653
1654       Opt_GenManifest,
1655       Opt_EmbedManifest,
1656       Opt_PrintBindContents
1657     ]
1658
1659     ++ [f | (ns,f) <- optLevelFlags, 0 `elem` ns]
1660              -- The default -O0 options
1661
1662     ++ standardWarnings
1663
1664 impliedFlags :: [(ExtensionFlag, ExtensionFlag)]
1665 impliedFlags
1666   = [ (Opt_RankNTypes,                Opt_ExplicitForAll)
1667     , (Opt_Rank2Types,                Opt_ExplicitForAll)
1668     , (Opt_ScopedTypeVariables,       Opt_ExplicitForAll)
1669     , (Opt_LiberalTypeSynonyms,       Opt_ExplicitForAll)
1670     , (Opt_ExistentialQuantification, Opt_ExplicitForAll)
1671     , (Opt_PolymorphicComponents,     Opt_ExplicitForAll)
1672
1673     , (Opt_GADTs,                  Opt_MonoLocalBinds)
1674     , (Opt_TypeFamilies,           Opt_MonoLocalBinds)
1675     , (Opt_FunctionalDependencies, Opt_MonoLocalBinds)
1676
1677     , (Opt_TypeFamilies,        Opt_KindSignatures)  -- Type families use kind signatures
1678                                                      -- all over the place
1679
1680     , (Opt_ImpredicativeTypes,  Opt_RankNTypes)
1681
1682         -- Record wild-cards implies field disambiguation
1683         -- Otherwise if you write (C {..}) you may well get
1684         -- stuff like " 'a' not in scope ", which is a bit silly
1685         -- if the compiler has just filled in field 'a' of constructor 'C'
1686     , (Opt_RecordWildCards,     Opt_DisambiguateRecordFields)
1687   ]
1688
1689 optLevelFlags :: [([Int], DynFlag)]
1690 optLevelFlags
1691   = [ ([0],     Opt_IgnoreInterfacePragmas)
1692     , ([0],     Opt_OmitInterfacePragmas)
1693
1694     , ([1,2],   Opt_IgnoreAsserts)
1695     , ([1,2],   Opt_EnableRewriteRules)  -- Off for -O0; see Note [Scoping for Builtin rules]
1696                                          --              in PrelRules
1697     , ([1,2],   Opt_DoEtaReduction)
1698     , ([1,2],   Opt_CaseMerge)
1699     , ([1,2],   Opt_Strictness)
1700     , ([1,2],   Opt_CSE)
1701     , ([1,2],   Opt_FullLaziness)
1702     , ([1,2],   Opt_Specialise)
1703     , ([1,2],   Opt_FloatIn)
1704
1705     , ([2],     Opt_LiberateCase)
1706     , ([2],     Opt_SpecConstr)
1707     , ([2],     Opt_RegsGraph)
1708
1709 --     , ([2],     Opt_StaticArgumentTransformation)
1710 -- Max writes: I think it's probably best not to enable SAT with -O2 for the
1711 -- 6.10 release. The version of SAT in HEAD at the moment doesn't incorporate
1712 -- several improvements to the heuristics, and I'm concerned that without
1713 -- those changes SAT will interfere with some attempts to write "high
1714 -- performance Haskell", as we saw in some posts on Haskell-Cafe earlier
1715 -- this year. In particular, the version in HEAD lacks the tail call
1716 -- criterion, so many things that look like reasonable loops will be
1717 -- turned into functions with extra (unneccesary) thunk creation.
1718
1719     , ([0,1,2], Opt_DoLambdaEtaExpansion)
1720                 -- This one is important for a tiresome reason:
1721                 -- we want to make sure that the bindings for data
1722                 -- constructors are eta-expanded.  This is probably
1723                 -- a good thing anyway, but it seems fragile.
1724     ]
1725
1726 -- -----------------------------------------------------------------------------
1727 -- Standard sets of warning options
1728
1729 standardWarnings :: [DynFlag]
1730 standardWarnings
1731     = [ Opt_WarnWarningsDeprecations,
1732         Opt_WarnDeprecatedFlags,
1733         Opt_WarnUnrecognisedPragmas,
1734         Opt_WarnOverlappingPatterns,
1735         Opt_WarnMissingFields,
1736         Opt_WarnMissingMethods,
1737         Opt_WarnDuplicateExports,
1738         Opt_WarnLazyUnliftedBindings,
1739         Opt_WarnDodgyForeignImports,
1740         Opt_WarnWrongDoBind,
1741         Opt_WarnAlternativeLayoutRuleTransitional
1742       ]
1743
1744 minusWOpts :: [DynFlag]
1745 minusWOpts
1746     = standardWarnings ++
1747       [ Opt_WarnUnusedBinds,
1748         Opt_WarnUnusedMatches,
1749         Opt_WarnUnusedImports,
1750         Opt_WarnIncompletePatterns,
1751         Opt_WarnDodgyExports,
1752         Opt_WarnDodgyImports
1753       ]
1754
1755 minusWallOpts :: [DynFlag]
1756 minusWallOpts
1757     = minusWOpts ++
1758       [ Opt_WarnTypeDefaults,
1759         Opt_WarnNameShadowing,
1760         Opt_WarnMissingSigs,
1761         Opt_WarnHiShadows,
1762         Opt_WarnOrphans,
1763         Opt_WarnUnusedDoBind
1764       ]
1765
1766 -- minuswRemovesOpts should be every warning option
1767 minuswRemovesOpts :: [DynFlag]
1768 minuswRemovesOpts
1769     = minusWallOpts ++
1770       [Opt_WarnImplicitPrelude,
1771        Opt_WarnIncompletePatternsRecUpd,
1772        Opt_WarnSimplePatterns,
1773        Opt_WarnMonomorphism,
1774        Opt_WarnUnrecognisedPragmas,
1775        Opt_WarnTabs
1776       ]
1777
1778 enableGlasgowExts :: DynP ()
1779 enableGlasgowExts = do setDynFlag Opt_PrintExplicitForalls
1780                        mapM_ setExtensionFlag glasgowExtsFlags
1781
1782 disableGlasgowExts :: DynP ()
1783 disableGlasgowExts = do unSetDynFlag Opt_PrintExplicitForalls
1784                         mapM_ unSetExtensionFlag glasgowExtsFlags
1785
1786 glasgowExtsFlags :: [ExtensionFlag]
1787 glasgowExtsFlags = [
1788              Opt_ForeignFunctionInterface
1789            , Opt_UnliftedFFITypes
1790            , Opt_GADTs
1791            , Opt_ImplicitParams
1792            , Opt_ScopedTypeVariables
1793            , Opt_UnboxedTuples
1794            , Opt_TypeSynonymInstances
1795            , Opt_StandaloneDeriving
1796            , Opt_DeriveDataTypeable
1797            , Opt_DeriveFunctor
1798            , Opt_DeriveFoldable
1799            , Opt_DeriveTraversable
1800            , Opt_FlexibleContexts
1801            , Opt_FlexibleInstances
1802            , Opt_ConstrainedClassMethods
1803            , Opt_MultiParamTypeClasses
1804            , Opt_FunctionalDependencies
1805            , Opt_MagicHash
1806            , Opt_PolymorphicComponents
1807            , Opt_ExistentialQuantification
1808            , Opt_UnicodeSyntax
1809            , Opt_PostfixOperators
1810            , Opt_PatternGuards
1811            , Opt_LiberalTypeSynonyms
1812            , Opt_RankNTypes
1813            , Opt_TypeOperators
1814            , Opt_DoRec
1815            , Opt_ParallelListComp
1816            , Opt_EmptyDataDecls
1817            , Opt_KindSignatures
1818            , Opt_GeneralizedNewtypeDeriving
1819            , Opt_TypeFamilies ]
1820
1821 #ifdef GHCI
1822 -- Consult the RTS to find whether GHC itself has been built profiled
1823 -- If so, you can't use Template Haskell
1824 foreign import ccall unsafe "rts_isProfiled" rtsIsProfiledIO :: IO CInt
1825
1826 rtsIsProfiled :: Bool
1827 rtsIsProfiled = unsafePerformIO rtsIsProfiledIO /= 0
1828
1829 checkTemplateHaskellOk :: Bool -> DynP ()
1830 checkTemplateHaskellOk turn_on
1831   | turn_on && rtsIsProfiled
1832   = addErr "You can't use Template Haskell with a profiled compiler"
1833   | otherwise
1834   = return ()
1835 #else
1836 -- In stage 1 we don't know that the RTS has rts_isProfiled,
1837 -- so we simply say "ok".  It doesn't matter because TH isn't
1838 -- available in stage 1 anyway.
1839 checkTemplateHaskellOk turn_on = return ()
1840 #endif
1841
1842 {- **********************************************************************
1843 %*                                                                      *
1844                 DynFlags constructors
1845 %*                                                                      *
1846 %********************************************************************* -}
1847
1848 type DynP = EwM (CmdLineP DynFlags)
1849
1850 upd :: (DynFlags -> DynFlags) -> DynP ()
1851 upd f = liftEwM (do { dfs <- getCmdLineState
1852                     ; putCmdLineState $! (f dfs) })
1853
1854 --------------- Constructor functions for OptKind -----------------
1855 noArg :: (DynFlags -> DynFlags) -> OptKind (CmdLineP DynFlags)
1856 noArg fn = NoArg (upd fn)
1857
1858 noArgDF :: (DynFlags -> DynFlags) -> String -> OptKind (CmdLineP DynFlags)
1859 noArgDF fn deprec = NoArg (upd fn >> deprecate deprec)
1860
1861 hasArg :: (String -> DynFlags -> DynFlags) -> OptKind (CmdLineP DynFlags)
1862 hasArg fn = HasArg (upd . fn)
1863
1864 hasArgDF :: (String -> DynFlags -> DynFlags) -> String -> OptKind (CmdLineP DynFlags)
1865 hasArgDF fn deprec = HasArg (\s -> do { upd (fn s)
1866                                       ; deprecate deprec })
1867
1868 intSuffix :: (Int -> DynFlags -> DynFlags) -> OptKind (CmdLineP DynFlags)
1869 intSuffix fn = IntSuffix (\n -> upd (fn n))
1870
1871 setDumpFlag :: DynFlag -> OptKind (CmdLineP DynFlags)
1872 setDumpFlag dump_flag = NoArg (setDumpFlag' dump_flag)
1873
1874 --------------------------
1875 setDynFlag, unSetDynFlag :: DynFlag -> DynP ()
1876 setDynFlag   f = upd (\dfs -> dopt_set dfs f)
1877 unSetDynFlag f = upd (\dfs -> dopt_unset dfs f)
1878
1879 --------------------------
1880 setLanguage :: Language -> DynP ()
1881 setLanguage l = upd (\dfs -> dfs { language = Just l })
1882
1883 --------------------------
1884 setExtensionFlag, unSetExtensionFlag :: ExtensionFlag -> DynP ()
1885 setExtensionFlag f = do { upd (\dfs -> lopt_set dfs f)
1886                         ; mapM_ setExtensionFlag deps }
1887   where
1888     deps = [ d | (f', d) <- impliedFlags, f' == f ]
1889         -- When you set f, set the ones it implies
1890         -- NB: use setExtensionFlag recursively, in case the implied flags
1891         --     implies further flags
1892         -- When you un-set f, however, we don't un-set the things it implies
1893         --      (except for -fno-glasgow-exts, which is treated specially)
1894
1895 unSetExtensionFlag f = upd (\dfs -> lopt_unset dfs f)
1896
1897 --------------------------
1898 setDumpFlag' :: DynFlag -> DynP ()
1899 setDumpFlag' dump_flag
1900   = do { setDynFlag dump_flag
1901        ; when want_recomp forceRecompile }
1902   where
1903         -- Certain dumpy-things are really interested in what's going
1904         -- on during recompilation checking, so in those cases we
1905         -- don't want to turn it off.
1906     want_recomp = dump_flag `notElem` [Opt_D_dump_if_trace,
1907                                        Opt_D_dump_hi_diffs]
1908
1909 forceRecompile :: DynP ()
1910 -- Whenver we -ddump, force recompilation (by switching off the
1911 -- recompilation checker), else you don't see the dump! However,
1912 -- don't switch it off in --make mode, else *everything* gets
1913 -- recompiled which probably isn't what you want
1914 forceRecompile = do { dfs <- liftEwM getCmdLineState
1915                     ; when (force_recomp dfs) (setDynFlag Opt_ForceRecomp) }
1916         where
1917           force_recomp dfs = isOneShot (ghcMode dfs)
1918
1919 setVerboseCore2Core :: DynP ()
1920 setVerboseCore2Core = do forceRecompile
1921                          setDynFlag Opt_D_verbose_core2core
1922                          upd (\dfs -> dfs { shouldDumpSimplPhase = Nothing })
1923
1924
1925 setDumpSimplPhases :: String -> DynP ()
1926 setDumpSimplPhases s = do forceRecompile
1927                           upd (\dfs -> dfs { shouldDumpSimplPhase = Just spec })
1928   where
1929     spec = case s of { ('=' : s') -> s';  _ -> s }
1930
1931 setVerbosity :: Maybe Int -> DynP ()
1932 setVerbosity mb_n = upd (\dfs -> dfs{ verbosity = mb_n `orElse` 3 })
1933
1934 addCmdlineHCInclude :: String -> DynP ()
1935 addCmdlineHCInclude a = upd (\s -> s{cmdlineHcIncludes =  a : cmdlineHcIncludes s})
1936
1937 extraPkgConf_ :: FilePath -> DynP ()
1938 extraPkgConf_  p = upd (\s -> s{ extraPkgConfs = p : extraPkgConfs s })
1939
1940 exposePackage, exposePackageId, hidePackage, ignorePackage :: String -> DynP ()
1941 exposePackage p =
1942   upd (\s -> s{ packageFlags = ExposePackage p : packageFlags s })
1943 exposePackageId p =
1944   upd (\s -> s{ packageFlags = ExposePackageId p : packageFlags s })
1945 hidePackage p =
1946   upd (\s -> s{ packageFlags = HidePackage p : packageFlags s })
1947 ignorePackage p =
1948   upd (\s -> s{ packageFlags = IgnorePackage p : packageFlags s })
1949
1950 setPackageName :: String -> DynFlags -> DynFlags
1951 setPackageName p s =  s{ thisPackage = stringToPackageId p }
1952
1953 -- If we're linking a binary, then only targets that produce object
1954 -- code are allowed (requests for other target types are ignored).
1955 setTarget :: HscTarget -> DynP ()
1956 setTarget l = upd set
1957   where
1958    set dfs
1959      | ghcLink dfs /= LinkBinary || isObjectTarget l  = dfs{ hscTarget = l }
1960      | otherwise = dfs
1961
1962 -- Changes the target only if we're compiling object code.  This is
1963 -- used by -fasm and -fvia-C, which switch from one to the other, but
1964 -- not from bytecode to object-code.  The idea is that -fasm/-fvia-C
1965 -- can be safely used in an OPTIONS_GHC pragma.
1966 setObjTarget :: HscTarget -> DynP ()
1967 setObjTarget l = upd set
1968   where
1969    set dfs
1970      | isObjectTarget (hscTarget dfs) = dfs { hscTarget = l }
1971      | otherwise = dfs
1972
1973 setOptLevel :: Int -> DynFlags -> DynFlags
1974 setOptLevel n dflags
1975    | hscTarget dflags == HscInterpreted && n > 0
1976         = dflags
1977             -- not in IO any more, oh well:
1978             -- putStr "warning: -O conflicts with --interactive; -O ignored.\n"
1979    | otherwise
1980         = updOptLevel n dflags
1981
1982
1983 -- -Odph is equivalent to
1984 --
1985 --    -O2                               optimise as much as possible
1986 --    -fno-method-sharing               sharing specialisation defeats fusion
1987 --                                      sometimes
1988 --    -fdicts-cheap                     always inline dictionaries
1989 --    -fmax-simplifier-iterations20     this is necessary sometimes
1990 --    -fsimplifier-phases=3             we use an additional simplifier phase
1991 --                                      for fusion
1992 --    -fno-spec-constr-threshold        run SpecConstr even for big loops
1993 --    -fno-spec-constr-count            SpecConstr as much as possible
1994 --    -finline-enough-args              hack to prevent excessive inlining
1995 --
1996 setDPHOpt :: DynFlags -> DynFlags
1997 setDPHOpt dflags = setOptLevel 2 (dflags { maxSimplIterations  = 20
1998                                          , simplPhases         = 3
1999                                          , specConstrThreshold = Nothing
2000                                          , specConstrCount     = Nothing
2001                                          })
2002                    `dopt_set`   Opt_DictsCheap
2003                    `dopt_unset` Opt_MethodSharing
2004
2005 data DPHBackend = DPHPar
2006                 | DPHSeq
2007                 | DPHThis
2008         deriving(Eq, Ord, Enum, Show)
2009
2010 setDPHBackend :: DPHBackend -> DynP ()
2011 setDPHBackend backend
2012   = do
2013       upd $ \dflags -> dflags { dphBackend = backend }
2014       mapM_ exposePackage (dph_packages backend)
2015   where
2016     dph_packages DPHThis = []
2017     dph_packages DPHPar  = ["dph-prim-par", "dph-par"]
2018     dph_packages DPHSeq  = ["dph-prim-seq", "dph-seq"]
2019
2020 dphPackage :: DynFlags -> PackageId
2021 dphPackage dflags = case dphBackend dflags of
2022                       DPHPar  -> dphParPackageId
2023                       DPHSeq  -> dphSeqPackageId
2024                       DPHThis -> thisPackage dflags
2025
2026 setMainIs :: String -> DynP ()
2027 setMainIs arg
2028   | not (null main_fn) && isLower (head main_fn)
2029      -- The arg looked like "Foo.Bar.baz"
2030   = upd $ \d -> d{ mainFunIs = Just main_fn,
2031                    mainModIs = mkModule mainPackageId (mkModuleName main_mod) }
2032
2033   | isUpper (head arg)  -- The arg looked like "Foo" or "Foo.Bar"
2034   = upd $ \d -> d{ mainModIs = mkModule mainPackageId (mkModuleName arg) }
2035
2036   | otherwise                   -- The arg looked like "baz"
2037   = upd $ \d -> d{ mainFunIs = Just arg }
2038   where
2039     (main_mod, main_fn) = splitLongestPrefix arg (== '.')
2040
2041 -----------------------------------------------------------------------------
2042 -- Paths & Libraries
2043
2044 addImportPath, addLibraryPath, addIncludePath, addFrameworkPath :: FilePath -> DynP ()
2045
2046 -- -i on its own deletes the import paths
2047 addImportPath "" = upd (\s -> s{importPaths = []})
2048 addImportPath p  = upd (\s -> s{importPaths = importPaths s ++ splitPathList p})
2049
2050
2051 addLibraryPath p =
2052   upd (\s -> s{libraryPaths = libraryPaths s ++ splitPathList p})
2053
2054 addIncludePath p =
2055   upd (\s -> s{includePaths = includePaths s ++ splitPathList p})
2056
2057 addFrameworkPath p =
2058   upd (\s -> s{frameworkPaths = frameworkPaths s ++ splitPathList p})
2059
2060 #ifndef mingw32_TARGET_OS
2061 split_marker :: Char
2062 split_marker = ':'   -- not configurable (ToDo)
2063 #endif
2064
2065 splitPathList :: String -> [String]
2066 splitPathList s = filter notNull (splitUp s)
2067                 -- empty paths are ignored: there might be a trailing
2068                 -- ':' in the initial list, for example.  Empty paths can
2069                 -- cause confusion when they are translated into -I options
2070                 -- for passing to gcc.
2071   where
2072 #ifndef mingw32_TARGET_OS
2073     splitUp xs = split split_marker xs
2074 #else
2075      -- Windows: 'hybrid' support for DOS-style paths in directory lists.
2076      --
2077      -- That is, if "foo:bar:baz" is used, this interpreted as
2078      -- consisting of three entries, 'foo', 'bar', 'baz'.
2079      -- However, with "c:/foo:c:\\foo;x:/bar", this is interpreted
2080      -- as 3 elts, "c:/foo", "c:\\foo", "x:/bar"
2081      --
2082      -- Notice that no attempt is made to fully replace the 'standard'
2083      -- split marker ':' with the Windows / DOS one, ';'. The reason being
2084      -- that this will cause too much breakage for users & ':' will
2085      -- work fine even with DOS paths, if you're not insisting on being silly.
2086      -- So, use either.
2087     splitUp []             = []
2088     splitUp (x:':':div:xs) | div `elem` dir_markers
2089                            = ((x:':':div:p): splitUp rs)
2090                            where
2091                               (p,rs) = findNextPath xs
2092           -- we used to check for existence of the path here, but that
2093           -- required the IO monad to be threaded through the command-line
2094           -- parser which is quite inconvenient.  The
2095     splitUp xs = cons p (splitUp rs)
2096                where
2097                  (p,rs) = findNextPath xs
2098
2099                  cons "" xs = xs
2100                  cons x  xs = x:xs
2101
2102     -- will be called either when we've consumed nought or the
2103     -- "<Drive>:/" part of a DOS path, so splitting is just a Q of
2104     -- finding the next split marker.
2105     findNextPath xs =
2106         case break (`elem` split_markers) xs of
2107            (p, _:ds) -> (p, ds)
2108            (p, xs)   -> (p, xs)
2109
2110     split_markers :: [Char]
2111     split_markers = [':', ';']
2112
2113     dir_markers :: [Char]
2114     dir_markers = ['/', '\\']
2115 #endif
2116
2117 -- -----------------------------------------------------------------------------
2118 -- tmpDir, where we store temporary files.
2119
2120 setTmpDir :: FilePath -> DynFlags -> DynFlags
2121 setTmpDir dir dflags = dflags{ tmpDir = normalise dir }
2122   -- we used to fix /cygdrive/c/.. on Windows, but this doesn't
2123   -- seem necessary now --SDM 7/2/2008
2124
2125 -----------------------------------------------------------------------------
2126 -- RTS opts
2127
2128 setRtsOpts :: String -> DynP ()
2129 setRtsOpts arg  = upd $ \ d -> d {rtsOpts = Just arg}
2130
2131 setRtsOptsEnabled :: RtsOptsEnabled -> DynP ()
2132 setRtsOptsEnabled arg  = upd $ \ d -> d {rtsOptsEnabled = arg}
2133
2134 -----------------------------------------------------------------------------
2135 -- Hpc stuff
2136
2137 setOptHpcDir :: String -> DynP ()
2138 setOptHpcDir arg  = upd $ \ d -> d{hpcDir = arg}
2139
2140 -----------------------------------------------------------------------------
2141 -- Via-C compilation stuff
2142
2143 -- There are some options that we need to pass to gcc when compiling
2144 -- Haskell code via C, but are only supported by recent versions of
2145 -- gcc.  The configure script decides which of these options we need,
2146 -- and puts them in the file "extra-gcc-opts" in $topdir, which is
2147 -- read before each via-C compilation.  The advantage of having these
2148 -- in a separate file is that the file can be created at install-time
2149 -- depending on the available gcc version, and even re-generated  later
2150 -- if gcc is upgraded.
2151 --
2152 -- The options below are not dependent on the version of gcc, only the
2153 -- platform.
2154
2155 machdepCCOpts :: DynFlags -> ([String], -- flags for all C compilations
2156                               [String]) -- for registerised HC compilations
2157 machdepCCOpts dflags = let (flagsAll, flagsRegHc) = machdepCCOpts' dflags
2158                        in (cCcOpts ++ flagsAll, flagsRegHc)
2159
2160 machdepCCOpts' :: DynFlags -> ([String], -- flags for all C compilations
2161                                [String]) -- for registerised HC compilations
2162 machdepCCOpts' _dflags
2163 #if alpha_TARGET_ARCH
2164         =       ( ["-w", "-mieee"
2165 #ifdef HAVE_THREADED_RTS_SUPPORT
2166                     , "-D_REENTRANT"
2167 #endif
2168                    ], [] )
2169         -- For now, to suppress the gcc warning "call-clobbered
2170         -- register used for global register variable", we simply
2171         -- disable all warnings altogether using the -w flag. Oh well.
2172
2173 #elif hppa_TARGET_ARCH
2174         -- ___HPUX_SOURCE, not _HPUX_SOURCE, is #defined if -ansi!
2175         -- (very nice, but too bad the HP /usr/include files don't agree.)
2176         = ( ["-D_HPUX_SOURCE"], [] )
2177
2178 #elif m68k_TARGET_ARCH
2179       -- -fno-defer-pop : for the .hc files, we want all the pushing/
2180       --    popping of args to routines to be explicit; if we let things
2181       --    be deferred 'til after an STGJUMP, imminent death is certain!
2182       --
2183       -- -fomit-frame-pointer : *don't*
2184       --     It's better to have a6 completely tied up being a frame pointer
2185       --     rather than let GCC pick random things to do with it.
2186       --     (If we want to steal a6, then we would try to do things
2187       --     as on iX86, where we *do* steal the frame pointer [%ebp].)
2188         = ( [], ["-fno-defer-pop", "-fno-omit-frame-pointer"] )
2189
2190 #elif i386_TARGET_ARCH
2191       -- -fno-defer-pop : basically the same game as for m68k
2192       --
2193       -- -fomit-frame-pointer : *must* in .hc files; because we're stealing
2194       --   the fp (%ebp) for our register maps.
2195         =  let n_regs = stolen_x86_regs _dflags
2196            in
2197                     (
2198                       [ if opt_Static then "-DDONT_WANT_WIN32_DLL_SUPPORT" else ""
2199                       ],
2200                       [ "-fno-defer-pop",
2201                         "-fomit-frame-pointer",
2202                         -- we want -fno-builtin, because when gcc inlines
2203                         -- built-in functions like memcpy() it tends to
2204                         -- run out of registers, requiring -monly-n-regs
2205                         "-fno-builtin",
2206                         "-DSTOLEN_X86_REGS="++show n_regs ]
2207                     )
2208
2209 #elif ia64_TARGET_ARCH
2210         = ( [], ["-fomit-frame-pointer", "-G0"] )
2211
2212 #elif x86_64_TARGET_ARCH
2213         = (
2214                 [],
2215                 ["-fomit-frame-pointer",
2216                  "-fno-asynchronous-unwind-tables",
2217                         -- the unwind tables are unnecessary for HC code,
2218                         -- and get in the way of -split-objs.  Another option
2219                         -- would be to throw them away in the mangler, but this
2220                         -- is easier.
2221                  "-fno-builtin"
2222                         -- calling builtins like strlen() using the FFI can
2223                         -- cause gcc to run out of regs, so use the external
2224                         -- version.
2225                 ] )
2226
2227 #elif sparc_TARGET_ARCH
2228         = ( [], ["-w"] )
2229         -- For now, to suppress the gcc warning "call-clobbered
2230         -- register used for global register variable", we simply
2231         -- disable all warnings altogether using the -w flag. Oh well.
2232
2233 #elif powerpc_apple_darwin_TARGET
2234       -- -no-cpp-precomp:
2235       --     Disable Apple's precompiling preprocessor. It's a great thing
2236       --     for "normal" programs, but it doesn't support register variable
2237       --     declarations.
2238         = ( [], ["-no-cpp-precomp"] )
2239 #else
2240         = ( [], [] )
2241 #endif
2242
2243 picCCOpts :: DynFlags -> [String]
2244 picCCOpts _dflags
2245 #if darwin_TARGET_OS
2246       -- Apple prefers to do things the other way round.
2247       -- PIC is on by default.
2248       -- -mdynamic-no-pic:
2249       --     Turn off PIC code generation.
2250       -- -fno-common:
2251       --     Don't generate "common" symbols - these are unwanted
2252       --     in dynamic libraries.
2253
2254     | opt_PIC
2255         = ["-fno-common", "-U __PIC__","-D__PIC__"]
2256     | otherwise
2257         = ["-mdynamic-no-pic"]
2258 #elif mingw32_TARGET_OS
2259       -- no -fPIC for Windows
2260     | opt_PIC
2261         = ["-U __PIC__","-D__PIC__"]
2262     | otherwise
2263         = []
2264 #else
2265       -- we need -fPIC for C files when we are compiling with -dynamic,
2266       -- otherwise things like stub.c files don't get compiled
2267       -- correctly.  They need to reference data in the Haskell
2268       -- objects, but can't without -fPIC.  See
2269       -- http://hackage.haskell.org/trac/ghc/wiki/Commentary/PositionIndependentCode
2270     | opt_PIC || not opt_Static
2271         = ["-fPIC", "-U __PIC__", "-D__PIC__"]
2272     | otherwise
2273         = []
2274 #endif
2275
2276 -- -----------------------------------------------------------------------------
2277 -- Splitting
2278
2279 can_split :: Bool
2280 can_split = cSplitObjs == "YES"
2281
2282 -- -----------------------------------------------------------------------------
2283 -- Compiler Info
2284
2285 data Printable = String String
2286                | FromDynFlags (DynFlags -> String)
2287
2288 compilerInfo :: [(String, Printable)]
2289 compilerInfo = [("Project name",                String cProjectName),
2290                 ("Project version",             String cProjectVersion),
2291                 ("Booter version",              String cBooterVersion),
2292                 ("Stage",                       String cStage),
2293                 ("Build platform",              String cBuildPlatform),
2294                 ("Host platform",               String cHostPlatform),
2295                 ("Target platform",             String cTargetPlatform),
2296                 ("Have interpreter",            String cGhcWithInterpreter),
2297                 ("Object splitting",            String cSplitObjs),
2298                 ("Have native code generator",  String cGhcWithNativeCodeGen),
2299                 ("Have llvm code generator",    String cGhcWithLlvmCodeGen),
2300                 ("Support SMP",                 String cGhcWithSMP),
2301                 ("Unregisterised",              String cGhcUnregisterised),
2302                 ("Tables next to code",         String cGhcEnableTablesNextToCode),
2303                 ("RTS ways",                    String cGhcRTSWays),
2304                 ("Leading underscore",          String cLeadingUnderscore),
2305                 ("Debug on",                    String (show debugIsOn)),
2306                 ("LibDir",                      FromDynFlags topDir),
2307                 ("Global Package DB",           FromDynFlags systemPackageConfig)
2308                ]
2309