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