DynFlags.hs 95 KB
Newer Older
1
-- |
2 3 4 5 6 7
-- Dynamic flags
--
--
-- (c) The University of Glasgow 2005
--

8
-- Most flags are dynamic flags, which means they can change from
9 10 11
-- compilation to compilation using @OPTIONS_GHC@ pragmas, and in a
-- multi-session GHC each session can be using different dynamic
-- flags.  Dynamic flags can also be set at the prompt in GHCi.
12
module DynFlags (
13
        -- * Dynamic flags and associated configuration types
Ian Lynagh's avatar
Ian Lynagh committed
14
        DynFlag(..),
15
        ExtensionFlag(..),
16
        glasgowExtsFlags,
17 18 19 20 21 22
        dopt,
        dopt_set,
        dopt_unset,
        xopt,
        xopt_set,
        xopt_unset,
Ian Lynagh's avatar
Ian Lynagh committed
23
        DynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
24
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
25 26 27 28
        HscTarget(..), isObjectTarget, defaultObjectTarget,
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
Ian Lynagh's avatar
Ian Lynagh committed
29
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
30
        DynLibLoader(..),
31
        fFlags, fLangFlags, xFlags,
32
        DPHBackend(..), dphPackageMaybe,
33
        wayNames,
34

35 36 37 38 39
        Settings(..),
        ghcUsagePath, ghciUsagePath, topDir, tmpDir, rawSettings,
        extraGccViaCFlags, systemPackageConfig,
        pgm_L, pgm_P, pgm_F, pgm_c, pgm_s, pgm_a, pgm_l, pgm_dll, pgm_T,
        pgm_sysman, pgm_windres, pgm_lo, pgm_lc,
40 41
        opt_L, opt_P, opt_F, opt_c, opt_m, opt_a, opt_l,
        opt_windres, opt_lo, opt_lc,
42 43


44
        -- ** Manipulating DynFlags
45
        defaultDynFlags,                -- Settings -> DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
46 47
        initDynFlags,                   -- DynFlags -> IO DynFlags

48
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
49
        getVerbFlags,
Ian Lynagh's avatar
Ian Lynagh committed
50 51 52
        updOptLevel,
        setTmpDir,
        setPackageName,
53
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
54

55
        -- ** Parsing DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
56
        parseDynamicFlags,
57
        parseDynamicNoPackageFlags,
58
        allFlags,
59

60
        supportedLanguagesAndExtensions,
61 62

        -- ** DynFlag C compiler options
63
        picCCOpts,
64 65 66 67 68 69

        -- * Configuration of the stg-to-stg passes
        StgToDo(..),
        getStgToDo,

        -- * Compiler configuration suitable for display to the user
70 71 72 73 74 75
        compilerInfo
#ifdef GHCI
-- Only in stage 2 can we be sure that the RTS 
-- exposes the appropriate runtime boolean
        , rtsIsProfiled
#endif
76 77 78 79
  ) where

#include "HsVersions.h"

80
import Platform
81
import Module
Simon Marlow's avatar
Simon Marlow committed
82
import PackageConfig
83
import PrelNames        ( mAIN )
84
import StaticFlags
85
import {-# SOURCE #-} Packages (PackageState)
Ian Lynagh's avatar
Ian Lynagh committed
86
import DriverPhases     ( Phase(..), phaseInputExt )
87 88
import Config
import CmdLineParser
Ian Lynagh's avatar
Ian Lynagh committed
89
import Constants        ( mAX_CONTEXT_REDUCTION_DEPTH )
90
import Panic
91
import Util
92
import Maybes           ( orElse )
93
import SrcLoc
94
import FastString
Simon Marlow's avatar
Simon Marlow committed
95
import Outputable
Ian Lynagh's avatar
Ian Lynagh committed
96
#ifdef GHCI
97
import Foreign.C	( CInt )
Ian Lynagh's avatar
Ian Lynagh committed
98
#endif
Simon Marlow's avatar
Simon Marlow committed
99
import {-# SOURCE #-} ErrUtils ( Severity(..), Message, mkLocMessage )
100

Ian Lynagh's avatar
Ian Lynagh committed
101
#ifdef GHCI
102
import System.IO.Unsafe	( unsafePerformIO )
Ian Lynagh's avatar
Ian Lynagh committed
103
#endif
104
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
105
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
106

107
import Data.Char
108
import Data.List
109 110
import Data.Map (Map)
import qualified Data.Map as Map
Ian Lynagh's avatar
Ian Lynagh committed
111
import Distribution.System
Ian Lynagh's avatar
Ian Lynagh committed
112
import System.FilePath
113
import System.IO        ( stderr, hPutChar )
114

115 116 117
-- -----------------------------------------------------------------------------
-- DynFlags

118
-- | Enumerates the simple on-or-off dynamic flags
119 120 121 122
data DynFlag

   -- debugging flags
   = Opt_D_dump_cmm
123
   | Opt_D_dump_raw_cmm
124
   | Opt_D_dump_cmmz
125
   | Opt_D_dump_cmmz_pretty
126
   | Opt_D_dump_cps_cmm
127
   | Opt_D_dump_cvt_cmm
128
   | Opt_D_dump_asm
129 130
   | Opt_D_dump_asm_native
   | Opt_D_dump_asm_liveness
131
   | Opt_D_dump_asm_coalesce
132 133 134
   | Opt_D_dump_asm_regalloc
   | Opt_D_dump_asm_regalloc_stages
   | Opt_D_dump_asm_conflicts
135
   | Opt_D_dump_asm_stats
136
   | Opt_D_dump_asm_expanded
137
   | Opt_D_dump_llvm
138
   | Opt_D_dump_core_stats
139 140 141 142 143 144
   | Opt_D_dump_cpranal
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_flatC
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
145
   | Opt_D_dump_rule_firings
146
   | Opt_D_dump_rule_rewrites
147 148 149 150 151
   | Opt_D_dump_occur_anal
   | Opt_D_dump_parsed
   | Opt_D_dump_rn
   | Opt_D_dump_simpl
   | Opt_D_dump_simpl_iterations
152
   | Opt_D_dump_simpl_phases
153 154 155 156 157 158 159 160 161 162 163 164 165
   | Opt_D_dump_spec
   | Opt_D_dump_prep
   | Opt_D_dump_stg
   | Opt_D_dump_stranal
   | Opt_D_dump_tc
   | Opt_D_dump_types
   | Opt_D_dump_rules
   | Opt_D_dump_cse
   | Opt_D_dump_worker_wrapper
   | Opt_D_dump_rn_trace
   | Opt_D_dump_rn_stats
   | Opt_D_dump_opt_cmm
   | Opt_D_dump_simpl_stats
166
   | Opt_D_dump_cs_trace	-- Constraint solver in type checker
167 168
   | Opt_D_dump_tc_trace
   | Opt_D_dump_if_trace
169
   | Opt_D_dump_vt_trace
170 171 172
   | Opt_D_dump_splices
   | Opt_D_dump_BCOs
   | Opt_D_dump_vect
andy@galois.com's avatar
andy@galois.com committed
173
   | Opt_D_dump_hpc
pepe's avatar
pepe committed
174
   | Opt_D_dump_rtti
175 176 177 178 179 180
   | Opt_D_source_stats
   | Opt_D_verbose_core2core
   | Opt_D_verbose_stg2stg
   | Opt_D_dump_hi
   | Opt_D_dump_hi_diffs
   | Opt_D_dump_minimal_imports
181
   | Opt_D_dump_mod_cycles
182
   | Opt_D_dump_view_pattern_commoning
183
   | Opt_D_faststring_stats
Ian Lynagh's avatar
Ian Lynagh committed
184
   | Opt_DumpToFile                     -- ^ Append dump output to files instead of stdout.
Simon Marlow's avatar
Simon Marlow committed
185
   | Opt_D_no_debug_output
186 187 188
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
189
   | Opt_DoAsmLinting
190

Ian Lynagh's avatar
Ian Lynagh committed
191
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
192 193
   | Opt_WarnDuplicateExports
   | Opt_WarnHiShadows
194
   | Opt_WarnImplicitPrelude
195
   | Opt_WarnIncompletePatterns
196
   | Opt_WarnIncompleteUniPatterns
197 198
   | Opt_WarnIncompletePatternsRecUpd
   | Opt_WarnMissingFields
199
   | Opt_WarnMissingImportList
200 201
   | Opt_WarnMissingMethods
   | Opt_WarnMissingSigs
202
   | Opt_WarnMissingLocalSigs
203 204 205
   | Opt_WarnNameShadowing
   | Opt_WarnOverlappingPatterns
   | Opt_WarnTypeDefaults
206
   | Opt_WarnMonomorphism
207 208 209
   | Opt_WarnUnusedBinds
   | Opt_WarnUnusedImports
   | Opt_WarnUnusedMatches
Ian Lynagh's avatar
Ian Lynagh committed
210
   | Opt_WarnWarningsDeprecations
211
   | Opt_WarnDeprecatedFlags
212
   | Opt_WarnDodgyExports
213 214
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
215
   | Opt_WarnAutoOrphans
216
   | Opt_WarnIdentities
217
   | Opt_WarnTabs
218
   | Opt_WarnUnrecognisedPragmas
219
   | Opt_WarnDodgyForeignImports
220
   | Opt_WarnLazyUnliftedBindings
221 222
   | Opt_WarnUnusedDoBind
   | Opt_WarnWrongDoBind
223
   | Opt_WarnAlternativeLayoutRuleTransitional
224

225 226
   | Opt_PrintExplicitForalls

227 228 229
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
230 231
   | Opt_FloatIn
   | Opt_Specialise
232
   | Opt_StaticArgumentTransformation
233
   | Opt_CSE
234 235
   | Opt_LiberateCase
   | Opt_SpecConstr
236 237 238 239 240
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
241
   | Opt_MethodSharing	-- Now a no-op; remove in GHC 7.2
242
   | Opt_DictsCheap
243
   | Opt_EnableRewriteRules		-- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
244
   | Opt_Vectorise
Ian Lynagh's avatar
Ian Lynagh committed
245 246
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
247

248 249 250 251 252
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
253 254 255 256 257
   -- profiling opts
   | Opt_AutoSccsOnAllToplevs
   | Opt_AutoSccsOnExportedToplevs
   | Opt_AutoSccsOnIndividualCafs

258 259
   -- misc opts
   | Opt_Pp
260
   | Opt_ForceRecomp
261 262
   | Opt_DryRun
   | Opt_ExcessPrecision
263
   | Opt_EagerBlackHoling
264 265 266 267
   | Opt_ReadUserPackageConf
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
268
   | Opt_HideAllPackages
269
   | Opt_PrintBindResult
270
   | Opt_Haddock
David Waern's avatar
David Waern committed
271
   | Opt_HaddockOptions
272
   | Opt_Hpc_No_Auto
273
   | Opt_BreakOnException
274
   | Opt_BreakOnError
275
   | Opt_PrintEvldWithShow
276
   | Opt_PrintBindContents
277 278
   | Opt_GenManifest
   | Opt_EmbedManifest
279
   | Opt_EmitExternalCore
Ian Lynagh's avatar
Ian Lynagh committed
280
   | Opt_SharedImplib
281
   | Opt_BuildingCabalPackage
282
   | Opt_SSE2
283
   | Opt_GhciSandbox
284
   | Opt_HelpfulErrors
285 286 287

	-- temporary flags
   | Opt_RunCPS
288 289
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
290
   | Opt_AutoLinkPackages
291
   | Opt_ImplicitImportQualified
292
   | Opt_TryNewCodeGen
293 294 295 296 297 298

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
299
   | Opt_KeepRawTokenStream
300
   | Opt_KeepLlvmFiles
301

302
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
303

304 305
data Language = Haskell98 | Haskell2010

306
data ExtensionFlag
307 308 309 310 311 312 313
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
314
   | Opt_RelaxedPolyRec		-- Deprecated
315 316 317 318
   | Opt_ExtendedDefaultRules           -- Use GHC's extended rules for defaulting
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
   | Opt_GHCForeignImportPrim
benl's avatar
benl committed
319
   | Opt_ParallelArrays                 -- Syntactic support for parallel arrays
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
   | Opt_Arrows                         -- Arrow-notation syntax
   | Opt_TemplateHaskell
   | Opt_QuasiQuotes
   | Opt_ImplicitParams
   | Opt_ImplicitPrelude
   | Opt_ScopedTypeVariables
   | Opt_UnboxedTuples
   | Opt_BangPatterns
   | Opt_TypeFamilies
   | Opt_OverloadedStrings
   | Opt_DisambiguateRecordFields
   | Opt_RecordWildCards
   | Opt_RecordPuns
   | Opt_ViewPatterns
   | Opt_GADTs
Ian Lynagh's avatar
Ian Lynagh committed
335
   | Opt_GADTSyntax
336
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
337
   | Opt_DoAndIfThenElse
338
   | Opt_RebindableSyntax
339 340 341 342 343 344

   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable
345 346 347
   | Opt_DeriveRepresentable            -- Allow deriving Representable0/1
   | Opt_DefaultSignatures              -- Allow extra signatures for defmeths
   | Opt_Generics                       -- Generic deriving mechanism
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362

   | Opt_TypeSynonymInstances
   | Opt_FlexibleContexts
   | Opt_FlexibleInstances
   | Opt_ConstrainedClassMethods
   | Opt_MultiParamTypeClasses
   | Opt_FunctionalDependencies
   | Opt_UnicodeSyntax
   | Opt_PolymorphicComponents
   | Opt_ExistentialQuantification
   | Opt_MagicHash
   | Opt_EmptyDataDecls
   | Opt_KindSignatures
   | Opt_ParallelListComp
   | Opt_TransformListComp
363
   | Opt_MonadComprehensions
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_DoRec
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_Rank2Types
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
380
   | Opt_NondecreasingIndentation
381
   | Opt_RelaxedLayout
382 383
   deriving (Eq, Show)

384 385
-- | Contains not only a collection of 'DynFlag's but also a plethora of
-- information relating to the compilation of a single file or GHC session
386
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
387 388 389
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
390
  hscOutName            :: String,      -- ^ Name of the output file
391
  extCoreName           :: String,      -- ^ Name of the .hcr output file
392
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
393 394 395
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
396
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
397
  ruleCheck             :: Maybe String,
398
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
399

400 401 402
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
403 404
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
  			   	 	--   See CoreMonad.FloatOutSwitches
405

Ian Lynagh's avatar
Ian Lynagh committed
406
  targetPlatform        :: Platform.Platform, -- ^ The platform we're compiling for. Used by the NCG.
407
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
408 409 410
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
411
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
412

413 414
  dphBackend            :: DPHBackend,

415
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
416 417

  -- ways
418
  ways                  :: [Way],       -- ^ Way flags from the command line
419 420
  buildTag              :: String,      -- ^ The global \"way\" (e.g. \"p\" for prof)
  rtsBuildTag           :: String,      -- ^ The RTS \"way\"
Ian Lynagh's avatar
Ian Lynagh committed
421

422 423 424
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

425
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
426
  objectDir             :: Maybe String,
427
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
428 429
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
430

Ian Lynagh's avatar
Ian Lynagh committed
431 432 433
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
434

Ian Lynagh's avatar
Ian Lynagh committed
435 436 437
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
438

439
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
440 441
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
442

443 444
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
445 446 447 448 449 450 451
  dumpPrefixForce       :: Maybe FilePath,

  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

452
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
453
  rtsOptsEnabled        :: RtsOptsEnabled,
454

455
  hpcDir                :: String,      -- ^ Path to store the .mix files
andy@galois.com's avatar
andy@galois.com committed
456

457
  settings              :: Settings,
458

459 460 461 462 463 464
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

465
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
466
  extraPkgConfs         :: [FilePath],
467
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
468
        -- they appeared.
469

Ian Lynagh's avatar
Ian Lynagh committed
470
  packageFlags          :: [PackageFlag],
471
        -- ^ The @-package@ and @-hide-package@ flags from the command-line
472

473
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
474
  -- NB. do not modify this field, it is calculated by
475
  -- Packages.initPackages and Packages.updatePackages.
476
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
477
  pkgState              :: PackageState,
478

479 480 481 482
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
483
  dirsToClean           :: IORef (Map FilePath FilePath),
484

485
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
486
  flags                 :: [DynFlag],
487
  -- Don't change this without updating extensionFlags:
488
  language              :: Maybe Language,
489 490 491 492 493
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
  extensionFlags        :: [ExtensionFlag],
Ian Lynagh's avatar
Ian Lynagh committed
494

495
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
496 497 498
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
499 500
 }

501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523
data Settings = Settings {
  sGhcUsagePath          :: FilePath,    -- Filled in by SysTools
  sGhciUsagePath         :: FilePath,    -- ditto
  sTopDir                :: FilePath,
  sTmpDir                :: String,      -- no trailing '/'
  -- You shouldn't need to look things up in rawSettings directly.
  -- They should have their own fields instead.
  sRawSettings           :: [(String, String)],
  sExtraGccViaCFlags     :: [String],
  sSystemPackageConfig   :: FilePath,
  -- commands for particular phases
  sPgm_L                 :: String,
  sPgm_P                 :: (String,[Option]),
  sPgm_F                 :: String,
  sPgm_c                 :: (String,[Option]),
  sPgm_s                 :: (String,[Option]),
  sPgm_a                 :: (String,[Option]),
  sPgm_l                 :: (String,[Option]),
  sPgm_dll               :: (String,[Option]),
  sPgm_T                 :: String,
  sPgm_sysman            :: String,
  sPgm_windres           :: String,
  sPgm_lo                :: (String,[Option]), -- LLVM: opt llvm optimiser
524 525 526 527 528 529 530 531 532 533 534 535 536
  sPgm_lc                :: (String,[Option]), -- LLVM: llc static compiler
  -- options for particular phases
  sOpt_L                 :: [String],
  sOpt_P                 :: [String],
  sOpt_F                 :: [String],
  sOpt_c                 :: [String],
  sOpt_m                 :: [String],
  sOpt_a                 :: [String],
  sOpt_l                 :: [String],
  sOpt_windres           :: [String],
  sOpt_lo                :: [String], -- LLVM: llvm optimiser
  sOpt_lc                :: [String]  -- LLVM: llc static compiler

537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578
 }

ghcUsagePath          :: DynFlags -> FilePath
ghcUsagePath dflags = sGhcUsagePath (settings dflags)
ghciUsagePath         :: DynFlags -> FilePath
ghciUsagePath dflags = sGhciUsagePath (settings dflags)
topDir                :: DynFlags -> FilePath
topDir dflags = sTopDir (settings dflags)
tmpDir                :: DynFlags -> String
tmpDir dflags = sTmpDir (settings dflags)
rawSettings           :: DynFlags -> [(String, String)]
rawSettings dflags = sRawSettings (settings dflags)
extraGccViaCFlags     :: DynFlags -> [String]
extraGccViaCFlags dflags = sExtraGccViaCFlags (settings dflags)
systemPackageConfig   :: DynFlags -> FilePath
systemPackageConfig dflags = sSystemPackageConfig (settings dflags)
pgm_L                 :: DynFlags -> String
pgm_L dflags = sPgm_L (settings dflags)
pgm_P                 :: DynFlags -> (String,[Option])
pgm_P dflags = sPgm_P (settings dflags)
pgm_F                 :: DynFlags -> String
pgm_F dflags = sPgm_F (settings dflags)
pgm_c                 :: DynFlags -> (String,[Option])
pgm_c dflags = sPgm_c (settings dflags)
pgm_s                 :: DynFlags -> (String,[Option])
pgm_s dflags = sPgm_s (settings dflags)
pgm_a                 :: DynFlags -> (String,[Option])
pgm_a dflags = sPgm_a (settings dflags)
pgm_l                 :: DynFlags -> (String,[Option])
pgm_l dflags = sPgm_l (settings dflags)
pgm_dll               :: DynFlags -> (String,[Option])
pgm_dll dflags = sPgm_dll (settings dflags)
pgm_T                 :: DynFlags -> String
pgm_T dflags = sPgm_T (settings dflags)
pgm_sysman            :: DynFlags -> String
pgm_sysman dflags = sPgm_sysman (settings dflags)
pgm_windres           :: DynFlags -> String
pgm_windres dflags = sPgm_windres (settings dflags)
pgm_lo                :: DynFlags -> (String,[Option])
pgm_lo dflags = sPgm_lo (settings dflags)
pgm_lc                :: DynFlags -> (String,[Option])
pgm_lc dflags = sPgm_lc (settings dflags)
579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598
opt_L                 :: DynFlags -> [String]
opt_L dflags = sOpt_L (settings dflags)
opt_P                 :: DynFlags -> [String]
opt_P dflags = sOpt_P (settings dflags)
opt_F                 :: DynFlags -> [String]
opt_F dflags = sOpt_F (settings dflags)
opt_c                 :: DynFlags -> [String]
opt_c dflags = sOpt_c (settings dflags)
opt_m                 :: DynFlags -> [String]
opt_m dflags = sOpt_m (settings dflags)
opt_a                 :: DynFlags -> [String]
opt_a dflags = sOpt_a (settings dflags)
opt_l                 :: DynFlags -> [String]
opt_l dflags = sOpt_l (settings dflags)
opt_windres           :: DynFlags -> [String]
opt_windres dflags = sOpt_windres (settings dflags)
opt_lo                :: DynFlags -> [String]
opt_lo dflags = sOpt_lo (settings dflags)
opt_lc                :: DynFlags -> [String]
opt_lc dflags = sOpt_lc (settings dflags)
599

600 601 602
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

603 604
-- | The target code type of the compilation (if any).
--
605 606 607
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
608 609 610 611
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
612 613 614
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
615
--
616 617 618 619 620 621
--  * If a program uses Template Haskell the typechecker may try to run code
--    from an imported module.  This will fail if no code has been generated
--    for this module.  You can use 'GHC.needsTemplateHaskell' to detect
--    whether this might be the case and choose to either switch to a
--    different target or avoid typechecking such modules.  (The latter may
--    preferable for security reasons.)
622
--
623
data HscTarget
624 625
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
626
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
627 628 629
  | HscJava        -- ^ Generate Java bytecode.
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
630 631
  deriving (Eq, Show)

Ian Lynagh's avatar
Ian Lynagh committed
632 633 634 635 636 637 638 639
showHscTargetFlag :: HscTarget -> String
showHscTargetFlag HscC           = "-fvia-c"
showHscTargetFlag HscAsm         = "-fasm"
showHscTargetFlag HscLlvm        = "-fllvm"
showHscTargetFlag HscJava        = panic "No flag for HscJava"
showHscTargetFlag HscInterpreted = "-fbyte-code"
showHscTargetFlag HscNothing     = "-fno-code"

640
-- | Will this target result in an object file on the disk?
641 642 643
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
644
isObjectTarget HscLlvm  = True
645 646 647 648 649 650 651 652
isObjectTarget _        = False

-- | The 'GhcMode' tells us whether we're doing multi-module
-- compilation (controlled via the "GHC" API) or one-shot
-- (single-module) compilation.  This makes a difference primarily to
-- the "Finder": in one-shot mode we look for interface files for
-- imported modules, but in multi-module mode we look for source files
-- in order to check whether they need to be recompiled.
653
data GhcMode
654 655 656
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
657 658
  deriving Eq

659 660 661 662 663
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

664 665 666 667
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

668 669 670 671
-- | What to do in the link step, if there is one.
data GhcLink
  = NoLink              -- ^ Don't link at all
  | LinkBinary          -- ^ Link object code into a binary
672 673
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
674
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
675
  deriving (Eq, Show)
676 677 678

isNoLink :: GhcLink -> Bool
isNoLink NoLink = True
twanvl's avatar
twanvl committed
679
isNoLink _      = False
680

681 682 683
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
684 685 686
doingTickyProfiling _ = opt_Ticky
  -- XXX -ticky is a static flag, because it implies -debug which is also
  -- static.  If the way flags were made dynamic, we could fix this.
687

688 689
data PackageFlag
  = ExposePackage  String
690
  | ExposePackageId String
691 692
  | HidePackage    String
  | IgnorePackage  String
693
  deriving Eq
694

twanvl's avatar
twanvl committed
695
defaultHscTarget :: HscTarget
696 697
defaultHscTarget = defaultObjectTarget

698
-- | The 'HscTarget' value corresponding to the default way to create
699
-- object files on the current platform.
twanvl's avatar
twanvl committed
700
defaultObjectTarget :: HscTarget
701
defaultObjectTarget
702
  | cGhcUnregisterised    == "YES"      =  HscC
Ian Lynagh's avatar
Ian Lynagh committed
703
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
704
  | otherwise                           =  HscLlvm
705

706 707 708 709 710
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
711
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll
712
  deriving (Show)
Ian Lynagh's avatar
Ian Lynagh committed
713

714
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
715
initDynFlags :: DynFlags -> IO DynFlags
716 717 718
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
719
 refFilesToClean <- newIORef []
720
 refDirsToClean <- newIORef Map.empty
721
 return dflags{
722 723 724
        ways            = ways,
        buildTag        = mkBuildTag (filter (not . wayRTSOnly) ways),
        rtsBuildTag     = mkBuildTag ways,
725 726
        filesToClean    = refFilesToClean,
        dirsToClean     = refDirsToClean
Ian Lynagh's avatar
Ian Lynagh committed
727
        }
728

729 730
-- | The normal 'DynFlags'. Note that they is not suitable for use in this form
-- and must be fully initialized by 'GHC.newSession' first.
731 732
defaultDynFlags :: Settings -> DynFlags
defaultDynFlags mySettings =
733
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
734 735 736 737 738 739 740
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
741
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
742
        maxSimplIterations      = 4,
743
        shouldDumpSimplPhase    = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
744 745 746
        ruleCheck               = Nothing,
        specConstrThreshold     = Just 200,
        specConstrCount         = Just 3,
747
        liberateCaseThreshold   = Just 200,
748
        floatLamArgs            = Just 0,	-- Default: float only if no fvs
749 750
        strictnessBefore        = [],

751
        targetPlatform          = defaultTargetPlatform,
Ian Lynagh's avatar
Ian Lynagh committed
752 753 754 755 756 757
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
758
        dphBackend              = DPHNone,
759

Ian Lynagh's avatar
Ian Lynagh committed
760 761 762
        thisPackage             = mainPackageId,

        objectDir               = Nothing,
763
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
764 765 766 767 768 769 770 771 772
        hiDir                   = Nothing,
        stubDir                 = Nothing,

        objectSuf               = phaseInputExt StopLn,
        hcSuf                   = phaseInputExt HCc,
        hiSuf                   = "hi",

        outputFile              = Nothing,
        outputHi                = Nothing,
773
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
774 775 776 777 778 779
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
780
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
781
        rtsOptsEnabled          = RtsOptsSafeOnly,
Ian Lynagh's avatar
Ian Lynagh committed
782 783 784 785 786

        hpcDir                  = ".hpc",

        extraPkgConfs           = [],
        packageFlags            = [],
787 788
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
789
        ways                    = panic "defaultDynFlags: No ways",
Ian Lynagh's avatar
Ian Lynagh committed
790 791
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
792
        splitInfo               = Nothing,
793
        settings                = mySettings,
794 795 796 797 798 799
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        -- end of ghc -M values
800 801
        filesToClean   = panic "defaultDynFlags: No filesToClean",
        dirsToClean    = panic "defaultDynFlags: No dirsToClean",
Ian Lynagh's avatar
Ian Lynagh committed
802
        haddockOptions = Nothing,
803
        flags = defaultFlags,
804
        language = Nothing,
805 806
        extensions = [],
        extensionFlags = flattenExtensionFlags Nothing [],
807

Ian Lynagh's avatar
Ian Lynagh committed
808
        log_action = \severity srcSpan style msg ->
809
                        case severity of
810 811 812 813
                          SevOutput -> printOutput (msg style)
                          SevInfo   -> printErrs (msg style)
                          SevFatal  -> printErrs (msg style)
                          _         -> do 
814 815 816 817 818
                                hPutChar stderr '\n'
                                printErrs ((mkLocMessage srcSpan msg) style)
                     -- careful (#2302): printErrs prints in UTF-8, whereas
                     -- converting to string first and using hPutStr would
                     -- just emit the low 8 bits of each unicode char.
819 820
      }

Ian Lynagh's avatar
Ian Lynagh committed
821
{-
822 823
Note [Verbosity levels]
~~~~~~~~~~~~~~~~~~~~~~~
Ian Lynagh's avatar
Ian Lynagh committed
824
    0   |   print errors & warnings only
825 826 827 828 829 830 831
    1   |   minimal verbosity: print "compiling M ... done." for each module.
    2   |   equivalent to -dshow-passes
    3   |   equivalent to existing "ghc -v"
    4   |   "ghc -v -ddump-most"
    5   |   "ghc -v -ddump-all"
-}

832 833 834 835 836
data OnOff a = On a
             | Off a

-- OnOffs accumulate in reverse order, so we use foldr in order to
-- process them in the right order
837 838 839
flattenExtensionFlags :: Maybe Language -> [OnOff ExtensionFlag]
                      -> [ExtensionFlag]
flattenExtensionFlags ml = foldr f defaultExtensionFlags
840 841
    where f (On f)  flags = f : delete f flags
          f (Off f) flags =     delete f flags
842 843 844
          defaultExtensionFlags = languageExtensions ml

languageExtensions :: Maybe Language -> [ExtensionFlag]
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
845

846
languageExtensions Nothing
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
847
    -- Nothing => the default case
848 849 850
    = Opt_MonoPatBinds   -- Experimentally, I'm making this non-standard
                         -- behaviour the default, to see if anyone notices
                         -- SLPJ July 06
Ian Lynagh's avatar
Ian Lynagh committed
851
      -- In due course I'd like Opt_MonoLocalBinds to be on by default
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
852
      -- But NB it's implied by GADTs etc
Ian Lynagh's avatar
Ian Lynagh committed
853
      -- SLPJ September 2010
854
    : Opt_NondecreasingIndentation -- This has been on by default for some time
855
    : languageExtensions (Just Haskell2010)
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
856

857 858 859 860
languageExtensions (Just Haskell98)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_NPlusKPatterns,
861 862 863 864 865 866 867 868
       Opt_DatatypeContexts,
       Opt_NondecreasingIndentation
           -- strictly speaking non-standard, but we always had this
           -- on implicitly before the option was added in 7.1, and
           -- turning it off breaks code, so we're keeping it on for
           -- backwards compatibility.  Cabal uses -XHaskell98 by
           -- default unless you specify another language.
      ]
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
869

870 871 872 873 874 875 876
languageExtensions (Just Haskell2010)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_DatatypeContexts,
       Opt_EmptyDataDecls,
       Opt_ForeignFunctionInterface,
       Opt_PatternGuards,
Ian Lynagh's avatar
Ian Lynagh committed
877
       Opt_DoAndIfThenElse,
878
       Opt_RelaxedPolyRec]
879

880
-- | Test whether a 'DynFlag' is set
881 882
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)
883

884
-- | Set a 'DynFlag'
885 886
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }
887

888
-- | Unset a 'DynFlag'
889 890
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }
891

892
-- | Test whether a 'ExtensionFlag' is set
893
xopt :: ExtensionFlag -> DynFlags -> Bool
894
xopt f dflags = f `elem` extensionFlags dflags
895

896
-- | Set a 'ExtensionFlag'
897
xopt_set :: DynFlags -> ExtensionFlag -> DynFlags
898 899 900 901
xopt_set dfs f
    = let onoffs = On f : extensions dfs
      in dfs { extensions = onoffs,
               extensionFlags = flattenExtensionFlags (language dfs) onoffs }
902

903
-- | Unset a 'ExtensionFlag'
904
xopt_unset :: DynFlags -> ExtensionFlag -> DynFlags
905 906 907 908
xopt_unset dfs f
    = let onoffs = Off f : extensions dfs
      in dfs { extensions = onoffs,
               extensionFlags = flattenExtensionFlags (language dfs) onoffs }
909

910 911 912 913 914 915 916 917
setLanguage :: Language -> DynP ()
setLanguage l = upd f
    where f dfs = let mLang = Just l
                      oneoffs = extensions dfs
                  in dfs {
                         language = mLang,
                         extensionFlags = flattenExtensionFlags mLang oneoffs
                     }
918

919 920 921 922
-- | Retrieve the options corresponding to a particular @opt_*@ field in the correct order
getOpts :: DynFlags             -- ^ 'DynFlags' to retrieve the options from
        -> (DynFlags -> [a])    -- ^ Relevant record accessor: one of the @opt_*@ accessors
        -> [a]                  -- ^ Correctly ordered extracted options