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