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            map ("XNo"++) supportedLanguages
1008     where ok (PrefixPred _ _) = False
1009           ok _ = True
1010           flags = [ name | (name, _, _) <- fFlags ]
1011
1012 dynamic_flags :: [Flag DynP]
1013 dynamic_flags = [
1014     Flag "n"              (NoArg  (setDynFlag Opt_DryRun)) Supported
1015   , Flag "cpp"            (NoArg  (setDynFlag Opt_Cpp)) Supported
1016   , Flag "F"              (NoArg  (setDynFlag Opt_Pp)) Supported
1017   , Flag "#include"       (HasArg (addCmdlineHCInclude))
1018                              (Deprecated "No longer has any effect")
1019   , Flag "v"              (OptIntSuffix setVerbosity) Supported
1020
1021         ------- Specific phases  --------------------------------------------
1022   , Flag "pgmL"           (HasArg (upd . setPgmL)) Supported
1023   , Flag "pgmP"           (HasArg (upd . setPgmP)) Supported
1024   , Flag "pgmF"           (HasArg (upd . setPgmF)) Supported
1025   , Flag "pgmc"           (HasArg (upd . setPgmc)) Supported
1026   , Flag "pgmm"           (HasArg (upd . setPgmm)) Supported
1027   , Flag "pgms"           (HasArg (upd . setPgms)) Supported
1028   , Flag "pgma"           (HasArg (upd . setPgma)) Supported
1029   , Flag "pgml"           (HasArg (upd . setPgml)) Supported
1030   , Flag "pgmdll"         (HasArg (upd . setPgmdll)) Supported
1031   , Flag "pgmwindres"     (HasArg (upd . setPgmwindres)) Supported
1032
1033   , Flag "optL"           (HasArg (upd . addOptL)) Supported
1034   , Flag "optP"           (HasArg (upd . addOptP)) Supported
1035   , Flag "optF"           (HasArg (upd . addOptF)) Supported
1036   , Flag "optc"           (HasArg (upd . addOptc)) Supported
1037   , Flag "optm"           (HasArg (upd . addOptm)) Supported
1038   , Flag "opta"           (HasArg (upd . addOpta)) Supported
1039   , Flag "optl"           (HasArg (upd . addOptl)) Supported
1040   , Flag "optwindres"     (HasArg (upd . addOptwindres)) Supported
1041
1042   , Flag "split-objs"
1043          (NoArg (if can_split then setDynFlag Opt_SplitObjs else return ()))
1044          Supported
1045
1046         -------- ghc -M -----------------------------------------------------
1047   , Flag "dep-suffix"               (HasArg (upd . addDepSuffix)) Supported
1048   , Flag "optdep-s"                 (HasArg (upd . addDepSuffix))
1049          (Deprecated "Use -dep-suffix instead")
1050   , Flag "dep-makefile"             (HasArg (upd . setDepMakefile)) Supported
1051   , Flag "optdep-f"                 (HasArg (upd . setDepMakefile))
1052          (Deprecated "Use -dep-makefile instead")
1053   , Flag "optdep-w"                 (NoArg  (return ()))
1054          (Deprecated "-optdep-w doesn't do anything")
1055   , Flag "include-pkg-deps" (NoArg  (upd (setDepIncludePkgDeps True))) Supported
1056   , Flag "optdep--include-prelude"  (NoArg  (upd (setDepIncludePkgDeps True)))
1057          (Deprecated "Use -include-pkg-deps instead")
1058   , Flag "optdep--include-pkg-deps" (NoArg  (upd (setDepIncludePkgDeps True)))
1059          (Deprecated "Use -include-pkg-deps instead")
1060   , Flag "exclude-module"           (HasArg (upd . addDepExcludeMod)) Supported
1061   , Flag "optdep--exclude-module"   (HasArg (upd . addDepExcludeMod))
1062          (Deprecated "Use -exclude-module instead")
1063   , Flag "optdep-x"                 (HasArg (upd . addDepExcludeMod))
1064          (Deprecated "Use -exclude-module instead")
1065
1066         -------- Linking ----------------------------------------------------
1067   , Flag "c"              (NoArg (upd $ \d -> d{ ghcLink=NoLink } ))
1068          Supported
1069   , Flag "no-link"        (NoArg (upd $ \d -> d{ ghcLink=NoLink } ))
1070          (Deprecated "Use -c instead")
1071   , Flag "shared"         (NoArg (upd $ \d -> d{ ghcLink=LinkDynLib } ))
1072          Supported
1073   , Flag "dynload"        (HasArg (upd . parseDynLibLoaderMode))
1074          Supported
1075   , Flag "dylib-install-name" (HasArg (upd . setDylibInstallName)) Supported
1076
1077         ------- Libraries ---------------------------------------------------
1078   , Flag "L"              (Prefix addLibraryPath ) Supported
1079   , Flag "l"              (AnySuffix (\s -> do upd (addOptl s))) Supported
1080
1081         ------- Frameworks --------------------------------------------------
1082         -- -framework-path should really be -F ...
1083   , Flag "framework-path" (HasArg addFrameworkPath ) Supported
1084   , Flag "framework"      (HasArg (upd . addCmdlineFramework)) Supported
1085
1086         ------- Output Redirection ------------------------------------------
1087   , Flag "odir"           (HasArg (upd . setObjectDir)) Supported
1088   , Flag "o"              (SepArg (upd . setOutputFile . Just)) Supported
1089   , Flag "ohi"            (HasArg (upd . setOutputHi   . Just )) Supported
1090   , Flag "osuf"           (HasArg (upd . setObjectSuf)) Supported
1091   , Flag "hcsuf"          (HasArg (upd . setHcSuf)) Supported
1092   , Flag "hisuf"          (HasArg (upd . setHiSuf)) Supported
1093   , Flag "hidir"          (HasArg (upd . setHiDir)) Supported
1094   , Flag "tmpdir"         (HasArg (upd . setTmpDir)) Supported
1095   , Flag "stubdir"        (HasArg (upd . setStubDir)) Supported
1096   , Flag "outputdir"      (HasArg (upd . setOutputDir)) Supported
1097   , Flag "ddump-file-prefix" (HasArg (upd . setDumpPrefixForce . Just))
1098          Supported
1099
1100         ------- Keeping temporary files -------------------------------------
1101      -- These can be singular (think ghc -c) or plural (think ghc --make)
1102   , Flag "keep-hc-file"     (NoArg (setDynFlag Opt_KeepHcFiles)) Supported
1103   , Flag "keep-hc-files"    (NoArg (setDynFlag Opt_KeepHcFiles)) Supported
1104   , Flag "keep-s-file"      (NoArg (setDynFlag Opt_KeepSFiles)) Supported
1105   , Flag "keep-s-files"     (NoArg (setDynFlag Opt_KeepSFiles)) Supported
1106   , Flag "keep-raw-s-file"  (NoArg (setDynFlag Opt_KeepRawSFiles)) Supported
1107   , Flag "keep-raw-s-files" (NoArg (setDynFlag Opt_KeepRawSFiles)) Supported
1108      -- This only makes sense as plural
1109   , Flag "keep-tmp-files"   (NoArg (setDynFlag Opt_KeepTmpFiles)) Supported
1110
1111         ------- Miscellaneous ----------------------------------------------
1112   , Flag "no-auto-link-packages" (NoArg (unSetDynFlag Opt_AutoLinkPackages)) Supported
1113   , Flag "no-hs-main"     (NoArg (setDynFlag Opt_NoHsMain)) Supported
1114   , Flag "with-rtsopts"   (HasArg setRtsOpts) Supported
1115   , Flag "rtsopts"        (NoArg (setDynFlag Opt_RtsOptsEnabled)) Supported
1116   , Flag "no-rtsopts"     (NoArg (unSetDynFlag Opt_RtsOptsEnabled)) Supported
1117   , Flag "main-is"        (SepArg setMainIs ) Supported
1118   , Flag "haddock"        (NoArg (setDynFlag Opt_Haddock)) Supported
1119   , Flag "haddock-opts"   (HasArg (upd . addHaddockOpts)) Supported
1120   , Flag "hpcdir"         (SepArg setOptHpcDir) Supported
1121
1122         ------- recompilation checker --------------------------------------
1123   , Flag "recomp"         (NoArg (unSetDynFlag Opt_ForceRecomp))
1124          (Deprecated "Use -fno-force-recomp instead")
1125   , Flag "no-recomp"      (NoArg (setDynFlag   Opt_ForceRecomp))
1126          (Deprecated "Use -fforce-recomp instead")
1127
1128         ------ HsCpp opts ---------------------------------------------------
1129   , Flag "D"              (AnySuffix (upd . addOptP)) Supported
1130   , Flag "U"              (AnySuffix (upd . addOptP)) Supported
1131
1132         ------- Include/Import Paths ----------------------------------------
1133   , Flag "I"              (Prefix    addIncludePath) Supported
1134   , Flag "i"              (OptPrefix addImportPath ) Supported
1135
1136         ------ Debugging ----------------------------------------------------
1137   , Flag "dstg-stats"     (NoArg (setDynFlag Opt_StgStats)) Supported
1138
1139   , Flag "ddump-cmm"               (setDumpFlag Opt_D_dump_cmm)
1140          Supported
1141   , Flag "ddump-cmmz"              (setDumpFlag Opt_D_dump_cmmz)
1142          Supported
1143   , Flag "ddump-cmmz-pretty"       (setDumpFlag Opt_D_dump_cmmz_pretty)
1144          Supported
1145   , Flag "ddump-cps-cmm"           (setDumpFlag Opt_D_dump_cps_cmm)
1146          Supported
1147   , Flag "ddump-cvt-cmm"           (setDumpFlag Opt_D_dump_cvt_cmm)
1148          Supported
1149   , Flag "ddump-asm"               (setDumpFlag Opt_D_dump_asm)
1150          Supported
1151   , Flag "ddump-asm-native"        (setDumpFlag Opt_D_dump_asm_native)
1152          Supported
1153   , Flag "ddump-asm-liveness"      (setDumpFlag Opt_D_dump_asm_liveness)
1154          Supported
1155   , Flag "ddump-asm-coalesce"      (setDumpFlag Opt_D_dump_asm_coalesce)
1156          Supported
1157   , Flag "ddump-asm-regalloc"      (setDumpFlag Opt_D_dump_asm_regalloc)
1158          Supported
1159   , Flag "ddump-asm-conflicts"     (setDumpFlag Opt_D_dump_asm_conflicts)
1160          Supported
1161   , Flag "ddump-asm-regalloc-stages"
1162                                  (setDumpFlag Opt_D_dump_asm_regalloc_stages)
1163          Supported
1164   , Flag "ddump-asm-stats"         (setDumpFlag Opt_D_dump_asm_stats)
1165          Supported
1166   , Flag "ddump-asm-expanded"      (setDumpFlag Opt_D_dump_asm_expanded)
1167          Supported
1168   , Flag "ddump-cpranal"           (setDumpFlag Opt_D_dump_cpranal)
1169          Supported
1170   , Flag "ddump-deriv"             (setDumpFlag Opt_D_dump_deriv)
1171          Supported
1172   , Flag "ddump-ds"                (setDumpFlag Opt_D_dump_ds)
1173          Supported
1174   , Flag "ddump-flatC"             (setDumpFlag Opt_D_dump_flatC)
1175          Supported
1176   , Flag "ddump-foreign"           (setDumpFlag Opt_D_dump_foreign)
1177          Supported
1178   , Flag "ddump-inlinings"         (setDumpFlag Opt_D_dump_inlinings)
1179          Supported
1180   , Flag "ddump-rule-firings"      (setDumpFlag Opt_D_dump_rule_firings)
1181          Supported
1182   , Flag "ddump-occur-anal"        (setDumpFlag Opt_D_dump_occur_anal)
1183          Supported
1184   , Flag "ddump-parsed"            (setDumpFlag Opt_D_dump_parsed)
1185          Supported
1186   , Flag "ddump-rn"                (setDumpFlag Opt_D_dump_rn)
1187          Supported
1188   , Flag "ddump-simpl"             (setDumpFlag Opt_D_dump_simpl)
1189          Supported
1190   , Flag "ddump-simpl-iterations"  (setDumpFlag Opt_D_dump_simpl_iterations)
1191          Supported
1192   , Flag "ddump-simpl-phases"      (OptPrefix setDumpSimplPhases)
1193          Supported
1194   , Flag "ddump-spec"              (setDumpFlag Opt_D_dump_spec)
1195          Supported
1196   , Flag "ddump-prep"              (setDumpFlag Opt_D_dump_prep)
1197          Supported
1198   , Flag "ddump-stg"               (setDumpFlag Opt_D_dump_stg)
1199          Supported
1200   , Flag "ddump-stranal"           (setDumpFlag Opt_D_dump_stranal)
1201          Supported
1202   , Flag "ddump-tc"                (setDumpFlag Opt_D_dump_tc)
1203          Supported
1204   , Flag "ddump-types"             (setDumpFlag Opt_D_dump_types)
1205          Supported
1206   , Flag "ddump-rules"             (setDumpFlag Opt_D_dump_rules)
1207          Supported
1208   , Flag "ddump-cse"               (setDumpFlag Opt_D_dump_cse)
1209          Supported
1210   , Flag "ddump-worker-wrapper"    (setDumpFlag Opt_D_dump_worker_wrapper)
1211          Supported
1212   , Flag "ddump-rn-trace"          (setDumpFlag Opt_D_dump_rn_trace)
1213          Supported
1214   , Flag "ddump-if-trace"          (setDumpFlag Opt_D_dump_if_trace)
1215          Supported
1216   , Flag "ddump-tc-trace"          (setDumpFlag Opt_D_dump_tc_trace)
1217          Supported
1218   , Flag "ddump-splices"           (setDumpFlag Opt_D_dump_splices)
1219          Supported
1220   , Flag "ddump-rn-stats"          (setDumpFlag Opt_D_dump_rn_stats)
1221          Supported
1222   , Flag "ddump-opt-cmm"           (setDumpFlag Opt_D_dump_opt_cmm)
1223          Supported
1224   , Flag "ddump-simpl-stats"       (setDumpFlag Opt_D_dump_simpl_stats)
1225          Supported
1226   , Flag "ddump-bcos"              (setDumpFlag Opt_D_dump_BCOs)
1227          Supported
1228   , Flag "dsource-stats"           (setDumpFlag Opt_D_source_stats)
1229          Supported
1230   , Flag "dverbose-core2core"      (NoArg (do { setVerbosity (Just 2)
1231                                               ; setVerboseCore2Core }))
1232          Supported
1233   , Flag "dverbose-stg2stg"        (setDumpFlag Opt_D_verbose_stg2stg)
1234          Supported
1235   , Flag "ddump-hi"                (setDumpFlag Opt_D_dump_hi)
1236          Supported
1237   , Flag "ddump-minimal-imports"   (setDumpFlag Opt_D_dump_minimal_imports)
1238          Supported
1239   , Flag "ddump-vect"              (setDumpFlag Opt_D_dump_vect)
1240          Supported
1241   , Flag "ddump-hpc"               (setDumpFlag Opt_D_dump_hpc)
1242          Supported
1243   , Flag "ddump-mod-cycles"        (setDumpFlag Opt_D_dump_mod_cycles)
1244          Supported
1245   , Flag "ddump-view-pattern-commoning" (setDumpFlag Opt_D_dump_view_pattern_commoning)
1246          Supported
1247   , Flag "ddump-to-file"           (setDumpFlag Opt_DumpToFile)
1248          Supported
1249   , Flag "ddump-hi-diffs"          (setDumpFlag Opt_D_dump_hi_diffs)
1250          Supported
1251   , Flag "ddump-rtti"              (setDumpFlag Opt_D_dump_rtti)
1252          Supported
1253
1254   , Flag "dcore-lint"              (NoArg (setDynFlag Opt_DoCoreLinting))
1255          Supported
1256   , Flag "dstg-lint"               (NoArg (setDynFlag Opt_DoStgLinting))
1257          Supported
1258   , Flag "dcmm-lint"               (NoArg (setDynFlag Opt_DoCmmLinting))
1259          Supported
1260   , Flag "dasm-lint"               (NoArg (setDynFlag Opt_DoAsmLinting))
1261          Supported
1262   , Flag "dshow-passes"
1263          (NoArg (do forceRecompile
1264                     setVerbosity (Just 2)))
1265          Supported
1266   , Flag "dfaststring-stats"       (NoArg (setDynFlag Opt_D_faststring_stats))
1267          Supported
1268
1269         ------ Machine dependant (-m<blah>) stuff ---------------------------
1270
1271   , Flag "monly-2-regs" (NoArg (upd (\s -> s{stolen_x86_regs = 2}) ))
1272          Supported
1273   , Flag "monly-3-regs" (NoArg (upd (\s -> s{stolen_x86_regs = 3}) ))
1274          Supported
1275   , Flag "monly-4-regs" (NoArg (upd (\s -> s{stolen_x86_regs = 4}) ))
1276          Supported
1277
1278   , Flag "msse2" (NoArg (setDynFlag Opt_SSE2))
1279          Supported
1280
1281      ------ Warning opts -------------------------------------------------
1282   , Flag "W"      (NoArg (mapM_ setDynFlag   minusWOpts))
1283          Supported
1284   , Flag "Werror" (NoArg (setDynFlag         Opt_WarnIsError))
1285          Supported
1286   , Flag "Wwarn"  (NoArg (unSetDynFlag       Opt_WarnIsError))
1287          Supported
1288   , Flag "Wall"   (NoArg (mapM_ setDynFlag   minusWallOpts))
1289          Supported
1290   , Flag "Wnot"   (NoArg (mapM_ unSetDynFlag minusWallOpts))
1291          (Deprecated "Use -w instead")
1292   , Flag "w"      (NoArg (mapM_ unSetDynFlag minuswRemovesOpts))
1293          Supported
1294
1295         ------ Optimisation flags ------------------------------------------
1296   , Flag "O"      (NoArg (upd (setOptLevel 1))) Supported
1297   , Flag "Onot"   (NoArg (upd (setOptLevel 0)))
1298          (Deprecated "Use -O0 instead")
1299   , Flag "Odph"   (NoArg (upd setDPHOpt)) Supported
1300   , Flag "O"      (OptIntSuffix (\mb_n -> upd (setOptLevel (mb_n `orElse` 1))))
1301          Supported
1302                 -- If the number is missing, use 1
1303
1304   , Flag "fsimplifier-phases"
1305          (IntSuffix (\n -> upd (\dfs -> dfs{ simplPhases = n })))
1306          Supported
1307   , Flag "fmax-simplifier-iterations"
1308          (IntSuffix (\n -> upd (\dfs -> dfs{ maxSimplIterations = n })))
1309          Supported
1310
1311   , Flag "fspec-constr-threshold"
1312          (IntSuffix (\n -> upd (\dfs -> dfs{ specConstrThreshold = Just n })))
1313          Supported
1314   , Flag "fno-spec-constr-threshold"
1315          (NoArg (upd (\dfs -> dfs{ specConstrThreshold = Nothing })))
1316          Supported
1317   , Flag "fspec-constr-count"
1318          (IntSuffix (\n -> upd (\dfs -> dfs{ specConstrCount = Just n })))
1319          Supported
1320   , Flag "fno-spec-constr-count"
1321          (NoArg (upd (\dfs -> dfs{ specConstrCount = Nothing })))
1322          Supported
1323   , Flag "fliberate-case-threshold"
1324          (IntSuffix (\n -> upd (\dfs -> dfs{ liberateCaseThreshold = Just n })))
1325          Supported
1326   , Flag "fno-liberate-case-threshold"
1327          (NoArg (upd (\dfs -> dfs{ liberateCaseThreshold = Nothing })))
1328          Supported
1329
1330   , Flag "frule-check"
1331          (SepArg (\s -> upd (\dfs -> dfs{ ruleCheck = Just s })))
1332          Supported
1333   , Flag "fcontext-stack"
1334          (IntSuffix $ \n -> upd $ \dfs -> dfs{ ctxtStkDepth = n })
1335          Supported
1336
1337   , Flag "fstrictness-before"
1338          (IntSuffix (\n -> upd (\dfs -> dfs{ strictnessBefore = n : strictnessBefore dfs })))
1339          Supported
1340
1341         ------ Profiling ----------------------------------------------------
1342
1343   -- XXX Should the -f* flags be deprecated?
1344   -- They don't seem to be documented
1345   , Flag "fauto-sccs-on-all-toplevs"
1346          (NoArg (setDynFlag Opt_AutoSccsOnAllToplevs))
1347          Supported
1348   , Flag "auto-all"
1349          (NoArg (setDynFlag Opt_AutoSccsOnAllToplevs))
1350          Supported
1351   , Flag "no-auto-all"
1352          (NoArg (unSetDynFlag Opt_AutoSccsOnAllToplevs))
1353          Supported
1354   , Flag "fauto-sccs-on-exported-toplevs"
1355          (NoArg (setDynFlag Opt_AutoSccsOnExportedToplevs))
1356          Supported
1357   , Flag "auto"
1358          (NoArg (setDynFlag Opt_AutoSccsOnExportedToplevs))
1359          Supported
1360   , Flag "no-auto"
1361          (NoArg (unSetDynFlag Opt_AutoSccsOnExportedToplevs))
1362          Supported
1363   , Flag "fauto-sccs-on-individual-cafs"
1364          (NoArg (setDynFlag Opt_AutoSccsOnIndividualCafs))
1365          Supported
1366   , Flag "caf-all"
1367          (NoArg (setDynFlag Opt_AutoSccsOnIndividualCafs))
1368          Supported
1369   , Flag "no-caf-all"
1370          (NoArg (unSetDynFlag Opt_AutoSccsOnIndividualCafs))
1371          Supported
1372
1373         ------ DPH flags ----------------------------------------------------
1374
1375   , Flag "fdph-seq"
1376          (NoArg (setDPHBackend DPHSeq))
1377          Supported
1378   , Flag "fdph-par"
1379          (NoArg (setDPHBackend DPHPar))
1380          Supported
1381   , Flag "fdph-this"
1382          (NoArg (setDPHBackend DPHThis))
1383          Supported
1384
1385         ------ Compiler flags -----------------------------------------------
1386
1387   , Flag "fasm"             (NoArg (setObjTarget HscAsm)) Supported
1388   , Flag "fvia-c"           (NoArg (setObjTarget HscC)) Supported
1389   , Flag "fvia-C"           (NoArg (setObjTarget HscC)) Supported
1390
1391   , Flag "fno-code"         (NoArg (setTarget HscNothing)) Supported
1392   , Flag "fbyte-code"       (NoArg (setTarget HscInterpreted)) Supported
1393   , Flag "fobject-code"     (NoArg (setTarget defaultHscTarget)) Supported
1394
1395   , Flag "fglasgow-exts"    (NoArg (mapM_ setDynFlag   glasgowExtsFlags))
1396          Supported
1397   , Flag "fno-glasgow-exts" (NoArg (mapM_ unSetDynFlag glasgowExtsFlags))
1398          Supported
1399  ]
1400  ++ map (mkFlag True  "f"    setDynFlag  ) fFlags
1401  ++ map (mkFlag False "fno-" unSetDynFlag) fFlags
1402  ++ map (mkFlag True  "X"    setDynFlag  ) xFlags
1403  ++ map (mkFlag False "XNo"  unSetDynFlag) xFlags
1404
1405 package_flags :: [Flag DynP]
1406 package_flags = [
1407         ------- Packages ----------------------------------------------------
1408     Flag "package-conf"   (HasArg extraPkgConf_) Supported
1409   , Flag "no-user-package-conf" (NoArg (unSetDynFlag Opt_ReadUserPackageConf))
1410          Supported
1411   , Flag "package-name"   (HasArg (upd . setPackageName)) Supported
1412   , Flag "package-id"     (HasArg exposePackageId) Supported
1413   , Flag "package"        (HasArg exposePackage) Supported
1414   , Flag "hide-package"   (HasArg hidePackage) Supported
1415   , Flag "hide-all-packages" (NoArg (setDynFlag Opt_HideAllPackages))
1416          Supported
1417   , Flag "ignore-package" (HasArg ignorePackage)
1418          Supported
1419   , Flag "syslib"         (HasArg exposePackage)
1420          (Deprecated "Use -package instead")
1421   ]
1422
1423 mkFlag :: Bool                  -- ^ True <=> it should be turned on
1424        -> String                -- ^ The flag prefix
1425        -> (DynFlag -> DynP ())
1426        -> (String, DynFlag, Bool -> Deprecated)
1427        -> Flag DynP
1428 mkFlag turnOn flagPrefix f (name, dynflag, deprecated)
1429     = Flag (flagPrefix ++ name) (NoArg (f dynflag)) (deprecated turnOn)
1430
1431 deprecatedForLanguage :: String -> Bool -> Deprecated
1432 deprecatedForLanguage lang turn_on
1433     = Deprecated ("use -X"  ++ flag ++ " or pragma {-# LANGUAGE " ++ flag ++ " #-} instead")
1434     where
1435       flag | turn_on    = lang
1436            | otherwise = "No"++lang
1437
1438 useInstead :: String -> Bool -> Deprecated
1439 useInstead flag turn_on
1440   = Deprecated ("Use -f" ++ no ++ flag ++ " instead")
1441   where
1442     no = if turn_on then "" else "no-"
1443
1444 -- | These @-f\<blah\>@ flags can all be reversed with @-fno-\<blah\>@
1445 fFlags :: [(String, DynFlag, Bool -> Deprecated)]
1446 fFlags = [
1447   ( "warn-dodgy-foreign-imports",       Opt_WarnDodgyForeignImports, const Supported ),
1448   ( "warn-dodgy-exports",               Opt_WarnDodgyExports, const Supported ),
1449   ( "warn-dodgy-imports",               Opt_WarnDodgyImports, const Supported ),
1450   ( "warn-duplicate-exports",           Opt_WarnDuplicateExports, const Supported ),
1451   ( "warn-hi-shadowing",                Opt_WarnHiShadows, const Supported ),
1452   ( "warn-implicit-prelude",            Opt_WarnImplicitPrelude, const Supported ),
1453   ( "warn-incomplete-patterns",         Opt_WarnIncompletePatterns, const Supported ),
1454   ( "warn-incomplete-record-updates",   Opt_WarnIncompletePatternsRecUpd, const Supported ),
1455   ( "warn-missing-fields",              Opt_WarnMissingFields, const Supported ),
1456   ( "warn-missing-methods",             Opt_WarnMissingMethods, const Supported ),
1457   ( "warn-missing-signatures",          Opt_WarnMissingSigs, const Supported ),
1458   ( "warn-name-shadowing",              Opt_WarnNameShadowing, const Supported ),
1459   ( "warn-overlapping-patterns",        Opt_WarnOverlappingPatterns, const Supported ),
1460   ( "warn-simple-patterns",             Opt_WarnSimplePatterns, const Supported ),
1461   ( "warn-type-defaults",               Opt_WarnTypeDefaults, const Supported ),
1462   ( "warn-monomorphism-restriction",    Opt_WarnMonomorphism, const Supported ),
1463   ( "warn-unused-binds",                Opt_WarnUnusedBinds, const Supported ),
1464   ( "warn-unused-imports",              Opt_WarnUnusedImports, const Supported ),
1465   ( "warn-unused-matches",              Opt_WarnUnusedMatches, const Supported ),
1466   ( "warn-warnings-deprecations",       Opt_WarnWarningsDeprecations, const Supported ),
1467   ( "warn-deprecations",                Opt_WarnWarningsDeprecations, const Supported ),
1468   ( "warn-deprecated-flags",            Opt_WarnDeprecatedFlags, const Supported ),
1469   ( "warn-orphans",                     Opt_WarnOrphans, const Supported ),
1470   ( "warn-tabs",                        Opt_WarnTabs, const Supported ),
1471   ( "warn-unrecognised-pragmas",        Opt_WarnUnrecognisedPragmas, const Supported ),
1472   ( "warn-lazy-unlifted-bindings",      Opt_WarnLazyUnliftedBindings,
1473     const $ Deprecated "lazy unlifted bindings will be an error in GHC 6.14, and this flag will no longer exist"),
1474   ( "warn-unused-do-bind",              Opt_WarnUnusedDoBind, const Supported ),
1475   ( "warn-wrong-do-bind",               Opt_WarnWrongDoBind, const Supported ),
1476   ( "warn-alternative-layout-rule-transitional", Opt_WarnAlternativeLayoutRuleTransitional, const Supported ),
1477   ( "print-explicit-foralls",           Opt_PrintExplicitForalls, const Supported ),
1478   ( "strictness",                       Opt_Strictness, const Supported ),
1479   ( "specialise",                       Opt_Specialise, const Supported ),
1480   ( "float-in",                         Opt_FloatIn, const Supported ),
1481   ( "static-argument-transformation",   Opt_StaticArgumentTransformation, const Supported ),
1482   ( "full-laziness",                    Opt_FullLaziness, const Supported ),
1483   ( "liberate-case",                    Opt_LiberateCase, const Supported ),
1484   ( "spec-constr",                      Opt_SpecConstr, const Supported ),
1485   ( "cse",                              Opt_CSE, const Supported ),
1486   ( "ignore-interface-pragmas",         Opt_IgnoreInterfacePragmas, const Supported ),
1487   ( "omit-interface-pragmas",           Opt_OmitInterfacePragmas, const Supported ),
1488   ( "expose-all-unfoldings",            Opt_ExposeAllUnfoldings, const Supported ),
1489   ( "do-lambda-eta-expansion",          Opt_DoLambdaEtaExpansion, const Supported ),
1490   ( "ignore-asserts",                   Opt_IgnoreAsserts, const Supported ),
1491   ( "do-eta-reduction",                 Opt_DoEtaReduction, const Supported ),
1492   ( "case-merge",                       Opt_CaseMerge, const Supported ),
1493   ( "unbox-strict-fields",              Opt_UnboxStrictFields, const Supported ),
1494   ( "method-sharing",                   Opt_MethodSharing, const Supported ),
1495   ( "dicts-cheap",                      Opt_DictsCheap, const Supported ),
1496   ( "excess-precision",                 Opt_ExcessPrecision, const Supported ),
1497   ( "eager-blackholing",                Opt_EagerBlackHoling, const Supported ),
1498   ( "asm-mangling",                     Opt_DoAsmMangling, const Supported ),
1499   ( "print-bind-result",                Opt_PrintBindResult, const Supported ),
1500   ( "force-recomp",                     Opt_ForceRecomp, const Supported ),
1501   ( "hpc-no-auto",                      Opt_Hpc_No_Auto, const Supported ),
1502   ( "rewrite-rules",                    Opt_EnableRewriteRules, useInstead "enable-rewrite-rules" ),
1503   ( "enable-rewrite-rules",             Opt_EnableRewriteRules, const Supported ),
1504   ( "break-on-exception",               Opt_BreakOnException, const Supported ),
1505   ( "break-on-error",                   Opt_BreakOnError, const Supported ),
1506   ( "print-evld-with-show",             Opt_PrintEvldWithShow, const Supported ),
1507   ( "print-bind-contents",              Opt_PrintBindContents, const Supported ),
1508   ( "run-cps",                          Opt_RunCPS, const Supported ),
1509   ( "run-cpsz",                         Opt_RunCPSZ, const Supported ),
1510   ( "new-codegen",                      Opt_TryNewCodeGen, const Supported ),
1511   ( "convert-to-zipper-and-back",       Opt_ConvertToZipCfgAndBack, const Supported ),
1512   ( "vectorise",                        Opt_Vectorise, const Supported ),
1513   ( "regs-graph",                       Opt_RegsGraph, const Supported ),
1514   ( "regs-iterative",                   Opt_RegsIterative, const Supported ),
1515   ( "th",                               Opt_TemplateHaskell,
1516     deprecatedForLanguage "TemplateHaskell" ),
1517   ( "fi",                               Opt_ForeignFunctionInterface,
1518     deprecatedForLanguage "ForeignFunctionInterface" ),
1519   ( "ffi",                              Opt_ForeignFunctionInterface,
1520     deprecatedForLanguage "ForeignFunctionInterface" ),
1521   ( "arrows",                           Opt_Arrows,
1522     deprecatedForLanguage "Arrows" ),
1523   ( "generics",                         Opt_Generics,
1524     deprecatedForLanguage "Generics" ),
1525   ( "implicit-prelude",                 Opt_ImplicitPrelude,
1526     deprecatedForLanguage "ImplicitPrelude" ),
1527   ( "bang-patterns",                    Opt_BangPatterns,
1528     deprecatedForLanguage "BangPatterns" ),
1529   ( "monomorphism-restriction",         Opt_MonomorphismRestriction,
1530     deprecatedForLanguage "MonomorphismRestriction" ),
1531   ( "mono-pat-binds",                   Opt_MonoPatBinds,
1532     deprecatedForLanguage "MonoPatBinds" ),
1533   ( "extended-default-rules",           Opt_ExtendedDefaultRules,
1534     deprecatedForLanguage "ExtendedDefaultRules" ),
1535   ( "implicit-params",                  Opt_ImplicitParams,
1536     deprecatedForLanguage "ImplicitParams" ),
1537   ( "scoped-type-variables",            Opt_ScopedTypeVariables,
1538     deprecatedForLanguage "ScopedTypeVariables" ),
1539   ( "parr",                             Opt_PArr,
1540     deprecatedForLanguage "PArr" ),
1541   ( "allow-overlapping-instances",      Opt_OverlappingInstances,
1542     deprecatedForLanguage "OverlappingInstances" ),
1543   ( "allow-undecidable-instances",      Opt_UndecidableInstances,
1544     deprecatedForLanguage "UndecidableInstances" ),
1545   ( "allow-incoherent-instances",       Opt_IncoherentInstances,
1546     deprecatedForLanguage "IncoherentInstances" ),
1547   ( "gen-manifest",                     Opt_GenManifest, const Supported ),
1548   ( "embed-manifest",                   Opt_EmbedManifest, const Supported ),
1549   ( "ext-core",                         Opt_EmitExternalCore, const Supported ),
1550   ( "shared-implib",                    Opt_SharedImplib, const Supported ),
1551   ( "building-cabal-package",           Opt_BuildingCabalPackage, const Supported ),
1552   ( "implicit-import-qualified",        Opt_ImplicitImportQualified, const Supported )
1553   ]
1554
1555 supportedLanguages :: [String]
1556 supportedLanguages = [ name | (name, _, _) <- xFlags ]
1557
1558 -- This may contain duplicates
1559 languageOptions :: [DynFlag]
1560 languageOptions = [ dynFlag | (_, dynFlag, _) <- xFlags ]
1561
1562 -- | These -X<blah> flags can all be reversed with -XNo<blah>
1563 xFlags :: [(String, DynFlag, Bool -> Deprecated)]
1564 xFlags = [
1565   ( "CPP",                              Opt_Cpp, const Supported ),
1566   ( "PostfixOperators",                 Opt_PostfixOperators, const Supported ),
1567   ( "TupleSections",                    Opt_TupleSections, const Supported ),
1568   ( "PatternGuards",                    Opt_PatternGuards, const Supported ),
1569   ( "UnicodeSyntax",                    Opt_UnicodeSyntax, const Supported ),
1570   ( "MagicHash",                        Opt_MagicHash, const Supported ),
1571   ( "PolymorphicComponents",            Opt_PolymorphicComponents, const Supported ),
1572   ( "ExistentialQuantification",        Opt_ExistentialQuantification, const Supported ),
1573   ( "KindSignatures",                   Opt_KindSignatures, const Supported ),
1574   ( "EmptyDataDecls",                   Opt_EmptyDataDecls, const Supported ),
1575   ( "ParallelListComp",                 Opt_ParallelListComp, const Supported ),
1576   ( "TransformListComp",                Opt_TransformListComp, const Supported ),
1577   ( "ForeignFunctionInterface",         Opt_ForeignFunctionInterface, const Supported ),
1578   ( "UnliftedFFITypes",                 Opt_UnliftedFFITypes, const Supported ),
1579   ( "GHCForeignImportPrim",             Opt_GHCForeignImportPrim, const Supported ),
1580   ( "LiberalTypeSynonyms",              Opt_LiberalTypeSynonyms, const Supported ),
1581   ( "Rank2Types",                       Opt_Rank2Types, const Supported ),
1582   ( "RankNTypes",                       Opt_RankNTypes, const Supported ),
1583   ( "ImpredicativeTypes",               Opt_ImpredicativeTypes,
1584         const $ Deprecated "impredicative polymorphism will be simplified or removed in GHC 6.14" ),
1585   ( "TypeOperators",                    Opt_TypeOperators, const Supported ),
1586   ( "RecursiveDo",                      Opt_RecursiveDo,
1587     deprecatedForLanguage "DoRec"),
1588   ( "DoRec",                            Opt_DoRec, const Supported ),
1589   ( "Arrows",                           Opt_Arrows, const Supported ),
1590   ( "PArr",                             Opt_PArr, const Supported ),
1591   ( "TemplateHaskell",                  Opt_TemplateHaskell, const Supported ),
1592   ( "QuasiQuotes",                      Opt_QuasiQuotes, const Supported ),
1593   ( "Generics",                         Opt_Generics, const Supported ),
1594   -- On by default:
1595   ( "ImplicitPrelude",                  Opt_ImplicitPrelude, const Supported ),
1596   ( "RecordWildCards",                  Opt_RecordWildCards, const Supported ),
1597   ( "NamedFieldPuns",                   Opt_RecordPuns, const Supported ),
1598   ( "RecordPuns",                       Opt_RecordPuns,
1599     deprecatedForLanguage "NamedFieldPuns" ),
1600   ( "DisambiguateRecordFields",         Opt_DisambiguateRecordFields, const Supported ),
1601   ( "OverloadedStrings",                Opt_OverloadedStrings, const Supported ),
1602   ( "GADTs",                            Opt_GADTs, const Supported ),
1603   ( "ViewPatterns",                     Opt_ViewPatterns, const Supported ),
1604   ( "TypeFamilies",                     Opt_TypeFamilies, const Supported ),
1605   ( "BangPatterns",                     Opt_BangPatterns, const Supported ),
1606   -- On by default:
1607   ( "MonomorphismRestriction",          Opt_MonomorphismRestriction, const Supported ),
1608   -- On by default:
1609   ( "NPlusKPatterns",                   Opt_NPlusKPatterns, const Supported ),
1610   -- On by default (which is not strictly H98):
1611   ( "MonoPatBinds",                     Opt_MonoPatBinds, const Supported ),
1612   ( "ExplicitForAll",                   Opt_ExplicitForAll, const Supported ),
1613   ( "AlternativeLayoutRule",            Opt_AlternativeLayoutRule, const Supported ),
1614   ( "AlternativeLayoutRuleTransitional",Opt_AlternativeLayoutRuleTransitional, const Supported ),
1615   ( "MonoLocalBinds",                   Opt_MonoLocalBinds, const Supported ),
1616   ( "RelaxedPolyRec",                   Opt_RelaxedPolyRec, const Supported ),
1617   ( "ExtendedDefaultRules",             Opt_ExtendedDefaultRules, const Supported ),
1618   ( "ImplicitParams",                   Opt_ImplicitParams, const Supported ),
1619   ( "ScopedTypeVariables",              Opt_ScopedTypeVariables, const Supported ),
1620
1621   ( "PatternSignatures",                Opt_ScopedTypeVariables,
1622     deprecatedForLanguage "ScopedTypeVariables" ),
1623
1624   ( "UnboxedTuples",                    Opt_UnboxedTuples, const Supported ),
1625   ( "StandaloneDeriving",               Opt_StandaloneDeriving, const Supported ),
1626   ( "DeriveDataTypeable",               Opt_DeriveDataTypeable, const Supported ),
1627   ( "DeriveFunctor",                    Opt_DeriveFunctor, const Supported ),
1628   ( "DeriveTraversable",                Opt_DeriveTraversable, const Supported ),
1629   ( "DeriveFoldable",                   Opt_DeriveFoldable, const Supported ),
1630   ( "TypeSynonymInstances",             Opt_TypeSynonymInstances, const Supported ),
1631   ( "FlexibleContexts",                 Opt_FlexibleContexts, const Supported ),
1632   ( "FlexibleInstances",                Opt_FlexibleInstances, const Supported ),
1633   ( "ConstrainedClassMethods",          Opt_ConstrainedClassMethods, const Supported ),
1634   ( "MultiParamTypeClasses",            Opt_MultiParamTypeClasses, const Supported ),
1635   ( "FunctionalDependencies",           Opt_FunctionalDependencies, const Supported ),
1636   ( "GeneralizedNewtypeDeriving",       Opt_GeneralizedNewtypeDeriving, const Supported ),
1637   ( "OverlappingInstances",             Opt_OverlappingInstances, const Supported ),
1638   ( "UndecidableInstances",             Opt_UndecidableInstances, const Supported ),
1639   ( "IncoherentInstances",              Opt_IncoherentInstances, const Supported ),
1640   ( "PackageImports",                   Opt_PackageImports, const Supported ),
1641   ( "NewQualifiedOperators",            Opt_NewQualifiedOperators, const Supported )
1642   ]
1643
1644 impliedFlags :: [(DynFlag, DynFlag)]
1645 impliedFlags
1646   = [ (Opt_RankNTypes,                Opt_ExplicitForAll)
1647     , (Opt_Rank2Types,                Opt_ExplicitForAll)
1648     , (Opt_ScopedTypeVariables,       Opt_ExplicitForAll)
1649     , (Opt_LiberalTypeSynonyms,       Opt_ExplicitForAll)
1650     , (Opt_ExistentialQuantification, Opt_ExplicitForAll)
1651     , (Opt_PolymorphicComponents,     Opt_ExplicitForAll)
1652
1653     , (Opt_GADTs,               Opt_RelaxedPolyRec)  -- We want type-sig variables to
1654                                                      --      be completely rigid for GADTs
1655
1656     , (Opt_TypeFamilies,        Opt_RelaxedPolyRec)  -- Trac #2944 gives a nice example
1657     , (Opt_TypeFamilies,        Opt_KindSignatures)  -- Type families use kind signatures
1658                                                      -- all over the place
1659
1660     , (Opt_ScopedTypeVariables, Opt_RelaxedPolyRec)  -- Ditto for scoped type variables; see
1661                                                      --      Note [Scoped tyvars] in TcBinds
1662     , (Opt_ImpredicativeTypes,  Opt_RankNTypes)
1663
1664         -- Record wild-cards implies field disambiguation
1665         -- Otherwise if you write (C {..}) you may well get
1666         -- stuff like " 'a' not in scope ", which is a bit silly
1667         -- if the compiler has just filled in field 'a' of constructor 'C'
1668     , (Opt_RecordWildCards,     Opt_DisambiguateRecordFields)
1669   ]
1670
1671 glasgowExtsFlags :: [DynFlag]
1672 glasgowExtsFlags = [
1673              Opt_PrintExplicitForalls
1674            , Opt_ForeignFunctionInterface
1675            , Opt_UnliftedFFITypes
1676            , Opt_GADTs
1677            , Opt_ImplicitParams
1678            , Opt_ScopedTypeVariables
1679            , Opt_UnboxedTuples
1680            , Opt_TypeSynonymInstances
1681            , Opt_StandaloneDeriving
1682            , Opt_DeriveDataTypeable
1683            , Opt_DeriveFunctor
1684            , Opt_DeriveFoldable
1685            , Opt_DeriveTraversable
1686            , Opt_FlexibleContexts
1687            , Opt_FlexibleInstances
1688            , Opt_ConstrainedClassMethods
1689            , Opt_MultiParamTypeClasses
1690            , Opt_FunctionalDependencies
1691            , Opt_MagicHash
1692            , Opt_PolymorphicComponents
1693            , Opt_ExistentialQuantification
1694            , Opt_UnicodeSyntax
1695            , Opt_PostfixOperators
1696            , Opt_PatternGuards
1697            , Opt_LiberalTypeSynonyms
1698            , Opt_RankNTypes
1699            , Opt_TypeOperators
1700            , Opt_DoRec
1701            , Opt_ParallelListComp
1702            , Opt_EmptyDataDecls
1703            , Opt_KindSignatures
1704            , Opt_GeneralizedNewtypeDeriving
1705            , Opt_TypeFamilies ]
1706
1707 -- -----------------------------------------------------------------------------
1708 -- Parsing the dynamic flags.
1709
1710 -- | Parse dynamic flags from a list of command line arguments.  Returns the
1711 -- the parsed 'DynFlags', the left-over arguments, and a list of warnings.
1712 -- Throws a 'UsageError' if errors occurred during parsing (such as unknown
1713 -- flags or missing arguments).
1714 parseDynamicFlags :: Monad m =>
1715                      DynFlags -> [Located String]
1716                   -> m (DynFlags, [Located String], [Located String])
1717                      -- ^ Updated 'DynFlags', left-over arguments, and
1718                      -- list of warnings.
1719 parseDynamicFlags dflags args = parseDynamicFlags_ dflags args True
1720
1721 -- | Like 'parseDynamicFlags' but does not allow the package flags (-package,
1722 -- -hide-package, -ignore-package, -hide-all-packages, -package-conf).
1723 parseDynamicNoPackageFlags :: Monad m =>
1724                      DynFlags -> [Located String]
1725                   -> m (DynFlags, [Located String], [Located String])
1726                      -- ^ Updated 'DynFlags', left-over arguments, and
1727                      -- list of warnings.
1728 parseDynamicNoPackageFlags dflags args = parseDynamicFlags_ dflags args False
1729
1730 parseDynamicFlags_ :: Monad m =>
1731                       DynFlags -> [Located String] -> Bool
1732                   -> m (DynFlags, [Located String], [Located String])
1733 parseDynamicFlags_ dflags0 args pkg_flags = do
1734   -- XXX Legacy support code
1735   -- We used to accept things like
1736   --     optdep-f  -optdepdepend
1737   --     optdep-f  -optdep depend
1738   --     optdep -f -optdepdepend
1739   --     optdep -f -optdep depend
1740   -- but the spaces trip up proper argument handling. So get rid of them.
1741   let f (L p "-optdep" : L _ x : xs) = (L p ("-optdep" ++ x)) : f xs
1742       f (x : xs) = x : f xs
1743       f xs = xs
1744       args' = f args
1745
1746       -- Note: -ignore-package (package_flags) must precede -i* (dynamic_flags)
1747       flag_spec | pkg_flags = package_flags ++ dynamic_flags
1748                 | otherwise = dynamic_flags
1749
1750   let ((leftover, errs, warns), dflags1)
1751           = runCmdLine (processArgs flag_spec args') dflags0
1752   when (not (null errs)) $ ghcError $ errorsToGhcException errs
1753
1754   -- Cannot use -fPIC with registerised -fvia-C, because the mangler
1755   -- isn't up to the job.  We know that if hscTarget == HscC, then the
1756   -- user has explicitly used -fvia-C, because -fasm is the default,
1757   -- unless there is no NCG on this platform.  The latter case is
1758   -- checked when the -fPIC flag is parsed.
1759   --
1760   let (pic_warns, dflags2) =
1761         if opt_PIC && hscTarget dflags1 == HscC && cGhcUnregisterised == "NO"
1762           then ([L noSrcSpan $ "Warning: -fvia-C is incompatible with -fPIC; ignoring -fvia-C"],
1763                 dflags1{ hscTarget = HscAsm })
1764           else ([], dflags1)
1765
1766   return (dflags2, leftover, pic_warns ++ warns)
1767
1768 type DynP = CmdLineP DynFlags
1769
1770 upd :: (DynFlags -> DynFlags) -> DynP ()
1771 upd f = do
1772    dfs <- getCmdLineState
1773    putCmdLineState $! (f dfs)
1774
1775 --------------------------
1776 setDynFlag, unSetDynFlag :: DynFlag -> DynP ()
1777 setDynFlag f = do { upd (\dfs -> dopt_set dfs f)
1778                   ; mapM_ setDynFlag deps }
1779   where
1780     deps = [ d | (f', d) <- impliedFlags, f' == f ]
1781         -- When you set f, set the ones it implies
1782         -- NB: use setDynFlag recursively, in case the implied flags
1783         --     implies further flags
1784         -- When you un-set f, however, we don't un-set the things it implies
1785         --      (except for -fno-glasgow-exts, which is treated specially)
1786
1787 unSetDynFlag f = upd (\dfs -> dopt_unset dfs f)
1788
1789 --------------------------
1790 setDumpFlag :: DynFlag -> OptKind DynP
1791 setDumpFlag dump_flag
1792   = NoArg (do { setDynFlag dump_flag
1793               ; when want_recomp forceRecompile })
1794   where
1795         -- Certain dumpy-things are really interested in what's going
1796         -- on during recompilation checking, so in those cases we
1797         -- don't want to turn it off.
1798     want_recomp = dump_flag `notElem` [Opt_D_dump_if_trace,
1799                                        Opt_D_dump_hi_diffs]
1800
1801 forceRecompile :: DynP ()
1802 -- Whenver we -ddump, force recompilation (by switching off the
1803 -- recompilation checker), else you don't see the dump! However,
1804 -- don't switch it off in --make mode, else *everything* gets
1805 -- recompiled which probably isn't what you want
1806 forceRecompile = do { dfs <- getCmdLineState
1807                     ; when (force_recomp dfs) (setDynFlag Opt_ForceRecomp) }
1808         where
1809           force_recomp dfs = isOneShot (ghcMode dfs)
1810
1811 setVerboseCore2Core :: DynP ()
1812 setVerboseCore2Core = do forceRecompile
1813                          setDynFlag Opt_D_verbose_core2core
1814                          upd (\dfs -> dfs { shouldDumpSimplPhase = Nothing })
1815
1816
1817 setDumpSimplPhases :: String -> DynP ()
1818 setDumpSimplPhases s = do forceRecompile
1819                           upd (\dfs -> dfs { shouldDumpSimplPhase = Just spec })
1820   where
1821     spec = case s of { ('=' : s') -> s';  _ -> s }
1822
1823 setVerbosity :: Maybe Int -> DynP ()
1824 setVerbosity mb_n = upd (\dfs -> dfs{ verbosity = mb_n `orElse` 3 })
1825
1826 addCmdlineHCInclude :: String -> DynP ()
1827 addCmdlineHCInclude a = upd (\s -> s{cmdlineHcIncludes =  a : cmdlineHcIncludes s})
1828
1829 extraPkgConf_ :: FilePath -> DynP ()
1830 extraPkgConf_  p = upd (\s -> s{ extraPkgConfs = p : extraPkgConfs s })
1831
1832 exposePackage, exposePackageId, hidePackage, ignorePackage :: String -> DynP ()
1833 exposePackage p =
1834   upd (\s -> s{ packageFlags = ExposePackage p : packageFlags s })
1835 exposePackageId p =
1836   upd (\s -> s{ packageFlags = ExposePackageId p : packageFlags s })
1837 hidePackage p =
1838   upd (\s -> s{ packageFlags = HidePackage p : packageFlags s })
1839 ignorePackage p =
1840   upd (\s -> s{ packageFlags = IgnorePackage p : packageFlags s })
1841
1842 setPackageName :: String -> DynFlags -> DynFlags
1843 setPackageName p s =  s{ thisPackage = stringToPackageId p }
1844
1845 -- If we're linking a binary, then only targets that produce object
1846 -- code are allowed (requests for other target types are ignored).
1847 setTarget :: HscTarget -> DynP ()
1848 setTarget l = upd set
1849   where
1850    set dfs
1851      | ghcLink dfs /= LinkBinary || isObjectTarget l  = dfs{ hscTarget = l }
1852      | otherwise = dfs
1853
1854 -- Changes the target only if we're compiling object code.  This is
1855 -- used by -fasm and -fvia-C, which switch from one to the other, but
1856 -- not from bytecode to object-code.  The idea is that -fasm/-fvia-C
1857 -- can be safely used in an OPTIONS_GHC pragma.
1858 setObjTarget :: HscTarget -> DynP ()
1859 setObjTarget l = upd set
1860   where
1861    set dfs
1862      | isObjectTarget (hscTarget dfs) = dfs { hscTarget = l }
1863      | otherwise = dfs
1864
1865 setOptLevel :: Int -> DynFlags -> DynFlags
1866 setOptLevel n dflags
1867    | hscTarget dflags == HscInterpreted && n > 0
1868         = dflags
1869             -- not in IO any more, oh well:
1870             -- putStr "warning: -O conflicts with --interactive; -O ignored.\n"
1871    | otherwise
1872         = updOptLevel n dflags
1873
1874
1875 -- -Odph is equivalent to
1876 --
1877 --    -O2                               optimise as much as possible
1878 --    -fno-method-sharing               sharing specialisation defeats fusion
1879 --                                      sometimes
1880 --    -fdicts-cheap                     always inline dictionaries
1881 --    -fmax-simplifier-iterations20     this is necessary sometimes
1882 --    -fsimplifier-phases=3             we use an additional simplifier phase
1883 --                                      for fusion
1884 --    -fno-spec-constr-threshold        run SpecConstr even for big loops
1885 --    -fno-spec-constr-count            SpecConstr as much as possible
1886 --    -finline-enough-args              hack to prevent excessive inlining
1887 --
1888 setDPHOpt :: DynFlags -> DynFlags
1889 setDPHOpt dflags = setOptLevel 2 (dflags { maxSimplIterations  = 20
1890                                          , simplPhases         = 3
1891                                          , specConstrThreshold = Nothing
1892                                          , specConstrCount     = Nothing
1893                                          })
1894                    `dopt_set`   Opt_DictsCheap
1895                    `dopt_unset` Opt_MethodSharing
1896
1897 data DPHBackend = DPHPar
1898                 | DPHSeq
1899                 | DPHThis
1900         deriving(Eq, Ord, Enum, Show)
1901
1902 setDPHBackend :: DPHBackend -> DynP ()
1903 setDPHBackend backend
1904   = do
1905       upd $ \dflags -> dflags { dphBackend = backend }
1906       mapM_ exposePackage (dph_packages backend)
1907   where
1908     dph_packages DPHThis = []
1909     dph_packages DPHPar  = ["dph-prim-par", "dph-par"]
1910     dph_packages DPHSeq  = ["dph-prim-seq", "dph-seq"]
1911
1912 dphPackage :: DynFlags -> PackageId
1913 dphPackage dflags = case dphBackend dflags of
1914                       DPHPar  -> dphParPackageId
1915                       DPHSeq  -> dphSeqPackageId
1916                       DPHThis -> thisPackage dflags
1917
1918 setMainIs :: String -> DynP ()
1919 setMainIs arg
1920   | not (null main_fn) && isLower (head main_fn)
1921      -- The arg looked like "Foo.Bar.baz"
1922   = upd $ \d -> d{ mainFunIs = Just main_fn,
1923                    mainModIs = mkModule mainPackageId (mkModuleName main_mod) }
1924
1925   | isUpper (head arg)  -- The arg looked like "Foo" or "Foo.Bar"
1926   = upd $ \d -> d{ mainModIs = mkModule mainPackageId (mkModuleName arg) }
1927
1928   | otherwise                   -- The arg looked like "baz"
1929   = upd $ \d -> d{ mainFunIs = Just arg }
1930   where
1931     (main_mod, main_fn) = splitLongestPrefix arg (== '.')
1932
1933 -----------------------------------------------------------------------------
1934 -- Paths & Libraries
1935
1936 addImportPath, addLibraryPath, addIncludePath, addFrameworkPath :: FilePath -> DynP ()
1937
1938 -- -i on its own deletes the import paths
1939 addImportPath "" = upd (\s -> s{importPaths = []})
1940 addImportPath p  = upd (\s -> s{importPaths = importPaths s ++ splitPathList p})
1941
1942
1943 addLibraryPath p =
1944   upd (\s -> s{libraryPaths = libraryPaths s ++ splitPathList p})
1945
1946 addIncludePath p =
1947   upd (\s -> s{includePaths = includePaths s ++ splitPathList p})
1948
1949 addFrameworkPath p =
1950   upd (\s -> s{frameworkPaths = frameworkPaths s ++ splitPathList p})
1951
1952 #ifndef mingw32_TARGET_OS
1953 split_marker :: Char
1954 split_marker = ':'   -- not configurable (ToDo)
1955 #endif
1956
1957 splitPathList :: String -> [String]
1958 splitPathList s = filter notNull (splitUp s)
1959                 -- empty paths are ignored: there might be a trailing
1960                 -- ':' in the initial list, for example.  Empty paths can
1961                 -- cause confusion when they are translated into -I options
1962                 -- for passing to gcc.
1963   where
1964 #ifndef mingw32_TARGET_OS
1965     splitUp xs = split split_marker xs
1966 #else
1967      -- Windows: 'hybrid' support for DOS-style paths in directory lists.
1968      --
1969      -- That is, if "foo:bar:baz" is used, this interpreted as
1970      -- consisting of three entries, 'foo', 'bar', 'baz'.
1971      -- However, with "c:/foo:c:\\foo;x:/bar", this is interpreted
1972      -- as 3 elts, "c:/foo", "c:\\foo", "x:/bar"
1973      --
1974      -- Notice that no attempt is made to fully replace the 'standard'
1975      -- split marker ':' with the Windows / DOS one, ';'. The reason being
1976      -- that this will cause too much breakage for users & ':' will
1977      -- work fine even with DOS paths, if you're not insisting on being silly.
1978      -- So, use either.
1979     splitUp []             = []
1980     splitUp (x:':':div:xs) | div `elem` dir_markers
1981                            = ((x:':':div:p): splitUp rs)
1982                            where
1983                               (p,rs) = findNextPath xs
1984           -- we used to check for existence of the path here, but that
1985           -- required the IO monad to be threaded through the command-line
1986           -- parser which is quite inconvenient.  The
1987     splitUp xs = cons p (splitUp rs)
1988                where
1989                  (p,rs) = findNextPath xs
1990
1991                  cons "" xs = xs
1992                  cons x  xs = x:xs
1993
1994     -- will be called either when we've consumed nought or the
1995     -- "<Drive>:/" part of a DOS path, so splitting is just a Q of
1996     -- finding the next split marker.
1997     findNextPath xs =
1998         case break (`elem` split_markers) xs of
1999            (p, _:ds) -> (p, ds)
2000            (p, xs)   -> (p, xs)
2001
2002     split_markers :: [Char]
2003     split_markers = [':', ';']
2004
2005     dir_markers :: [Char]
2006     dir_markers = ['/', '\\']
2007 #endif
2008
2009 -- -----------------------------------------------------------------------------
2010 -- tmpDir, where we store temporary files.
2011
2012 setTmpDir :: FilePath -> DynFlags -> DynFlags
2013 setTmpDir dir dflags = dflags{ tmpDir = normalise dir }
2014   -- we used to fix /cygdrive/c/.. on Windows, but this doesn't
2015   -- seem necessary now --SDM 7/2/2008
2016
2017 -----------------------------------------------------------------------------
2018 -- RTS opts
2019
2020 setRtsOpts :: String -> DynP ()
2021 setRtsOpts arg  = upd $ \ d -> d {rtsOpts = Just arg}
2022
2023 -----------------------------------------------------------------------------
2024 -- Hpc stuff
2025
2026 setOptHpcDir :: String -> DynP ()
2027 setOptHpcDir arg  = upd $ \ d -> d{hpcDir = arg}
2028
2029 -----------------------------------------------------------------------------
2030 -- Via-C compilation stuff
2031
2032 -- There are some options that we need to pass to gcc when compiling
2033 -- Haskell code via C, but are only supported by recent versions of
2034 -- gcc.  The configure script decides which of these options we need,
2035 -- and puts them in the file "extra-gcc-opts" in $topdir, which is
2036 -- read before each via-C compilation.  The advantage of having these
2037 -- in a separate file is that the file can be created at install-time
2038 -- depending on the available gcc version, and even re-generated  later
2039 -- if gcc is upgraded.
2040 --
2041 -- The options below are not dependent on the version of gcc, only the
2042 -- platform.
2043
2044 machdepCCOpts :: DynFlags -> ([String], -- flags for all C compilations
2045                               [String]) -- for registerised HC compilations
2046 machdepCCOpts _dflags
2047 #if alpha_TARGET_ARCH
2048         =       ( ["-w", "-mieee"
2049 #ifdef HAVE_THREADED_RTS_SUPPORT
2050                     , "-D_REENTRANT"
2051 #endif
2052                    ], [] )
2053         -- For now, to suppress the gcc warning "call-clobbered
2054         -- register used for global register variable", we simply
2055         -- disable all warnings altogether using the -w flag. Oh well.
2056
2057 #elif hppa_TARGET_ARCH
2058         -- ___HPUX_SOURCE, not _HPUX_SOURCE, is #defined if -ansi!
2059         -- (very nice, but too bad the HP /usr/include files don't agree.)
2060         = ( ["-D_HPUX_SOURCE"], [] )
2061
2062 #elif m68k_TARGET_ARCH
2063       -- -fno-defer-pop : for the .hc files, we want all the pushing/
2064       --    popping of args to routines to be explicit; if we let things
2065       --    be deferred 'til after an STGJUMP, imminent death is certain!
2066       --
2067       -- -fomit-frame-pointer : *don't*
2068       --     It's better to have a6 completely tied up being a frame pointer
2069       --     rather than let GCC pick random things to do with it.
2070       --     (If we want to steal a6, then we would try to do things
2071       --     as on iX86, where we *do* steal the frame pointer [%ebp].)
2072         = ( [], ["-fno-defer-pop", "-fno-omit-frame-pointer"] )
2073
2074 #elif i386_TARGET_ARCH
2075       -- -fno-defer-pop : basically the same game as for m68k
2076       --
2077       -- -fomit-frame-pointer : *must* in .hc files; because we're stealing
2078       --   the fp (%ebp) for our register maps.
2079         =  let n_regs = stolen_x86_regs _dflags
2080            in
2081                     (
2082 #if darwin_TARGET_OS
2083                       -- By default, gcc on OS X will generate SSE
2084                       -- instructions, which need things 16-byte aligned,
2085                       -- but we don't 16-byte align things. Thus drop
2086                       -- back to generic i686 compatibility. Trac #2983.
2087                       --
2088                       -- Since Snow Leopard (10.6), gcc defaults to x86_64.
2089                       ["-march=i686", "-m32"],
2090 #else
2091                       [ if opt_Static then "-DDONT_WANT_WIN32_DLL_SUPPORT" else ""
2092                       ],
2093 #endif
2094                       [ "-fno-defer-pop",
2095                         "-fomit-frame-pointer",
2096                         -- we want -fno-builtin, because when gcc inlines
2097                         -- built-in functions like memcpy() it tends to
2098                         -- run out of registers, requiring -monly-n-regs
2099                         "-fno-builtin",
2100                         "-DSTOLEN_X86_REGS="++show n_regs ]
2101                     )
2102
2103 #elif ia64_TARGET_ARCH
2104         = ( [], ["-fomit-frame-pointer", "-G0"] )
2105
2106 #elif x86_64_TARGET_ARCH
2107         = (
2108 #if darwin_TARGET_OS
2109             ["-m64"],
2110 #else
2111             [],
2112 #endif
2113                 ["-fomit-frame-pointer",
2114                  "-fno-asynchronous-unwind-tables",
2115                         -- the unwind tables are unnecessary for HC code,
2116                         -- and get in the way of -split-objs.  Another option
2117                         -- would be to throw them away in the mangler, but this
2118                         -- is easier.
2119                  "-fno-builtin"
2120                         -- calling builtins like strlen() using the FFI can
2121                         -- cause gcc to run out of regs, so use the external
2122                         -- version.
2123                 ] )
2124
2125 #elif sparc_TARGET_ARCH
2126         = ( [], ["-w"] )
2127         -- For now, to suppress the gcc warning "call-clobbered
2128         -- register used for global register variable", we simply
2129         -- disable all warnings altogether using the -w flag. Oh well.
2130
2131 #elif powerpc_apple_darwin_TARGET
2132       -- -no-cpp-precomp:
2133       --     Disable Apple's precompiling preprocessor. It's a great thing
2134       --     for "normal" programs, but it doesn't support register variable
2135       --     declarations.
2136         = ( [], ["-no-cpp-precomp"] )
2137 #else
2138         = ( [], [] )
2139 #endif
2140
2141 picCCOpts :: DynFlags -> [String]
2142 picCCOpts _dflags
2143 #if darwin_TARGET_OS
2144       -- Apple prefers to do things the other way round.
2145       -- PIC is on by default.
2146       -- -mdynamic-no-pic:
2147       --     Turn off PIC code generation.
2148       -- -fno-common:
2149       --     Don't generate "common" symbols - these are unwanted
2150       --     in dynamic libraries.
2151
2152     | opt_PIC
2153         = ["-fno-common", "-U __PIC__","-D__PIC__"]
2154     | otherwise
2155         = ["-mdynamic-no-pic"]
2156 #elif mingw32_TARGET_OS
2157       -- no -fPIC for Windows
2158     | opt_PIC
2159         = ["-U __PIC__","-D__PIC__"]
2160     | otherwise
2161         = []
2162 #else
2163     | opt_PIC || not opt_Static
2164         = ["-fPIC", "-U __PIC__", "-D__PIC__"]
2165     | otherwise
2166         = []
2167 #endif
2168
2169 -- -----------------------------------------------------------------------------
2170 -- Splitting
2171
2172 can_split :: Bool
2173 can_split = cSplitObjs == "YES"
2174
2175 -- -----------------------------------------------------------------------------
2176 -- Compiler Info
2177
2178 data Printable = String String
2179                | FromDynFlags (DynFlags -> String)
2180
2181 compilerInfo :: [(String, Printable)]
2182 compilerInfo = [("Project name",                String cProjectName),
2183                 ("Project version",             String cProjectVersion),
2184                 ("Booter version",              String cBooterVersion),
2185                 ("Stage",                       String cStage),
2186                 ("Have interpreter",            String cGhcWithInterpreter),
2187                 ("Object splitting",            String cSplitObjs),
2188                 ("Have native code generator",  String cGhcWithNativeCodeGen),
2189                 ("Support SMP",                 String cGhcWithSMP),
2190                 ("Unregisterised",              String cGhcUnregisterised),
2191                 ("Tables next to code",         String cGhcEnableTablesNextToCode),
2192                 ("RTS ways",                    String cGhcRTSWays),
2193                 ("Leading underscore",          String cLeadingUnderscore),
2194                 ("Debug on",                    String (show debugIsOn)),
2195                 ("LibDir",                      FromDynFlags topDir)
2196                ]
2197