compiler/main/DynFlags.hs

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