compiler/main/DynFlags.hs

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