compiler/main/DynFlags.hs

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