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