compiler/main/DynFlags.hs

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