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