compiler/main/DynFlags.hs

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