compiler/main/DynFlags.hs

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