compiler/main/DynFlags.hs

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