DynFlags.hs 107 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

        -- ** SafeHaskell
36
        SafeHaskellMode(..),
37 38
        safeHaskellOn, safeLanguageOn,
        safeDirectImpsReq, safeImplicitImpsReq,
39

40 41 42 43 44
        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,
45 46
        opt_L, opt_P, opt_F, opt_c, opt_m, opt_a, opt_l,
        opt_windres, opt_lo, opt_lc,
47 48


49
        -- ** Manipulating DynFlags
50
        defaultDynFlags,                -- Settings -> DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
51 52
        initDynFlags,                   -- DynFlags -> IO DynFlags

53
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
54
        getVerbFlags,
Ian Lynagh's avatar
Ian Lynagh committed
55 56 57
        updOptLevel,
        setTmpDir,
        setPackageName,
58
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
59

60
        -- ** Parsing DynFlags
61 62
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
63
        allFlags,
64

65
        supportedLanguagesAndExtensions,
66 67

        -- ** DynFlag C compiler options
68
        picCCOpts,
69 70 71 72 73 74

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

        -- * Compiler configuration suitable for display to the user
75 76 77 78 79 80
        compilerInfo
#ifdef GHCI
-- Only in stage 2 can we be sure that the RTS 
-- exposes the appropriate runtime boolean
        , rtsIsProfiled
#endif
81 82 83 84
  ) where

#include "HsVersions.h"

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

Ian Lynagh's avatar
Ian Lynagh committed
106
#ifdef GHCI
107
import System.IO.Unsafe	( unsafePerformIO )
Ian Lynagh's avatar
Ian Lynagh committed
108
#endif
109
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
110
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
111

112
import Data.Char
113
import Data.List
114 115
import Data.Map (Map)
import qualified Data.Map as Map
116 117
import Data.Set (Set)
import qualified Data.Set as Set
Ian Lynagh's avatar
Ian Lynagh committed
118
import System.FilePath
119
import System.IO        ( stderr, hPutChar )
120

121 122 123
-- -----------------------------------------------------------------------------
-- DynFlags

124
-- | Enumerates the simple on-or-off dynamic flags
125 126 127 128
data DynFlag

   -- debugging flags
   = Opt_D_dump_cmm
129
   | Opt_D_dump_raw_cmm
130
   | Opt_D_dump_cmmz
131
   | Opt_D_dump_cmmz_pretty
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
   -- All of the cmmz subflags (there are a lot!)  Automatically
   -- enabled if you run -ddump-cmmz
   | Opt_D_dump_cmmz_cbe
   | Opt_D_dump_cmmz_proc
   | Opt_D_dump_cmmz_spills
   | Opt_D_dump_cmmz_rewrite
   | Opt_D_dump_cmmz_dead
   | Opt_D_dump_cmmz_stub
   | Opt_D_dump_cmmz_sp
   | Opt_D_dump_cmmz_procmap
   | Opt_D_dump_cmmz_split
   | Opt_D_dump_cmmz_lower
   | Opt_D_dump_cmmz_info
   | Opt_D_dump_cmmz_cafs
   -- end cmmz subflags
147
   | Opt_D_dump_cps_cmm
148
   | Opt_D_dump_cvt_cmm
149
   | Opt_D_dump_asm
150 151
   | Opt_D_dump_asm_native
   | Opt_D_dump_asm_liveness
152
   | Opt_D_dump_asm_coalesce
153 154 155
   | Opt_D_dump_asm_regalloc
   | Opt_D_dump_asm_regalloc_stages
   | Opt_D_dump_asm_conflicts
156
   | Opt_D_dump_asm_stats
157
   | Opt_D_dump_asm_expanded
158
   | Opt_D_dump_llvm
159
   | Opt_D_dump_core_stats
160 161 162 163 164 165
   | Opt_D_dump_cpranal
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_flatC
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
166
   | Opt_D_dump_rule_firings
167
   | Opt_D_dump_rule_rewrites
168 169 170
   | Opt_D_dump_occur_anal
   | Opt_D_dump_parsed
   | Opt_D_dump_rn
171
   | Opt_D_dump_core_pipeline -- TODO FIXME: dump after simplifier stats
172 173
   | Opt_D_dump_simpl
   | Opt_D_dump_simpl_iterations
174
   | Opt_D_dump_simpl_phases
175 176 177 178 179 180 181 182 183 184 185 186 187
   | 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
188
   | Opt_D_dump_cs_trace	-- Constraint solver in type checker
189 190
   | Opt_D_dump_tc_trace
   | Opt_D_dump_if_trace
191
   | Opt_D_dump_vt_trace
192 193 194
   | Opt_D_dump_splices
   | Opt_D_dump_BCOs
   | Opt_D_dump_vect
andy@galois.com's avatar
andy@galois.com committed
195
   | Opt_D_dump_hpc
pepe's avatar
pepe committed
196
   | Opt_D_dump_rtti
197 198 199 200 201 202
   | 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
203
   | Opt_D_dump_mod_cycles
204
   | Opt_D_dump_view_pattern_commoning
205
   | Opt_D_faststring_stats
Ian Lynagh's avatar
Ian Lynagh committed
206
   | Opt_DumpToFile                     -- ^ Append dump output to files instead of stdout.
Simon Marlow's avatar
Simon Marlow committed
207
   | Opt_D_no_debug_output
208 209 210
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
211
   | Opt_DoAsmLinting
212

Ian Lynagh's avatar
Ian Lynagh committed
213
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
214 215
   | Opt_WarnDuplicateExports
   | Opt_WarnHiShadows
216
   | Opt_WarnImplicitPrelude
217
   | Opt_WarnIncompletePatterns
218
   | Opt_WarnIncompleteUniPatterns
219 220
   | Opt_WarnIncompletePatternsRecUpd
   | Opt_WarnMissingFields
221
   | Opt_WarnMissingImportList
222 223
   | Opt_WarnMissingMethods
   | Opt_WarnMissingSigs
224
   | Opt_WarnMissingLocalSigs
225 226 227
   | Opt_WarnNameShadowing
   | Opt_WarnOverlappingPatterns
   | Opt_WarnTypeDefaults
228
   | Opt_WarnMonomorphism
229 230 231
   | Opt_WarnUnusedBinds
   | Opt_WarnUnusedImports
   | Opt_WarnUnusedMatches
Ian Lynagh's avatar
Ian Lynagh committed
232
   | Opt_WarnWarningsDeprecations
233
   | Opt_WarnDeprecatedFlags
234
   | Opt_WarnDodgyExports
235 236
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
237
   | Opt_WarnAutoOrphans
238
   | Opt_WarnIdentities
239
   | Opt_WarnTabs
240
   | Opt_WarnUnrecognisedPragmas
241
   | Opt_WarnDodgyForeignImports
242
   | Opt_WarnLazyUnliftedBindings
243 244
   | Opt_WarnUnusedDoBind
   | Opt_WarnWrongDoBind
245
   | Opt_WarnAlternativeLayoutRuleTransitional
246

247 248
   | Opt_PrintExplicitForalls

249 250 251
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
252 253
   | Opt_FloatIn
   | Opt_Specialise
254
   | Opt_StaticArgumentTransformation
255
   | Opt_CSE
256 257
   | Opt_LiberateCase
   | Opt_SpecConstr
258 259 260 261 262
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
263
   | Opt_MethodSharing	-- Now a no-op; remove in GHC 7.2
264
   | Opt_DictsCheap
265
   | Opt_EnableRewriteRules		-- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
266
   | Opt_Vectorise
Ian Lynagh's avatar
Ian Lynagh committed
267 268
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
269

270 271 272 273 274
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
275 276 277 278 279
   -- profiling opts
   | Opt_AutoSccsOnAllToplevs
   | Opt_AutoSccsOnExportedToplevs
   | Opt_AutoSccsOnIndividualCafs

280 281
   -- misc opts
   | Opt_Pp
282
   | Opt_ForceRecomp
283
   | Opt_ExcessPrecision
284
   | Opt_EagerBlackHoling
285 286 287 288
   | Opt_ReadUserPackageConf
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
289
   | Opt_HideAllPackages
290
   | Opt_DistrustAllPackages
291
   | Opt_PrintBindResult
292
   | Opt_Haddock
David Waern's avatar
David Waern committed
293
   | Opt_HaddockOptions
294
   | Opt_Hpc_No_Auto
295
   | Opt_BreakOnException
296
   | Opt_BreakOnError
297
   | Opt_PrintEvldWithShow
298
   | Opt_PrintBindContents
299 300
   | Opt_GenManifest
   | Opt_EmbedManifest
301
   | Opt_EmitExternalCore
Ian Lynagh's avatar
Ian Lynagh committed
302
   | Opt_SharedImplib
303
   | Opt_BuildingCabalPackage
304
   | Opt_SSE2
305
   | Opt_GhciSandbox
306
   | Opt_HelpfulErrors
307 308 309

	-- temporary flags
   | Opt_RunCPS
310 311
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
312
   | Opt_AutoLinkPackages
313
   | Opt_ImplicitImportQualified
314
   | Opt_TryNewCodeGen
315 316 317 318 319 320

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
321
   | Opt_KeepRawTokenStream
322
   | Opt_KeepLlvmFiles
323

324
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
325

326 327
data Language = Haskell98 | Haskell2010

328 329 330 331 332 333 334 335 336 337
-- | The various SafeHaskell modes
data SafeHaskellMode
   = Sf_None
   | Sf_SafeImports
   | Sf_SafeLanguage
   | Sf_Trustworthy
   | Sf_TrustworthyWithSafeLanguage
   | Sf_Safe
   deriving (Eq)

338 339 340 341 342 343 344
instance Outputable SafeHaskellMode where
    ppr Sf_None = ptext $ sLit "None"
    ppr Sf_SafeImports = ptext $ sLit "SafeImports"
    ppr Sf_SafeLanguage = ptext $ sLit "SafeLanguage"
    ppr Sf_Trustworthy = ptext $ sLit "Trustworthy"
    ppr Sf_TrustworthyWithSafeLanguage = ptext $ sLit "Trustworthy + SafeLanguage"
    ppr Sf_Safe = ptext $ sLit "Safe"
345

346
data ExtensionFlag
347 348 349 350 351 352 353
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
354
   | Opt_RelaxedPolyRec		-- Deprecated
355 356 357 358
   | Opt_ExtendedDefaultRules           -- Use GHC's extended rules for defaulting
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
   | Opt_GHCForeignImportPrim
benl's avatar
benl committed
359
   | Opt_ParallelArrays                 -- Syntactic support for parallel arrays
360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
   | 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
375
   | Opt_GADTSyntax
376
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
377
   | Opt_DoAndIfThenElse
378
   | Opt_RebindableSyntax
379 380 381 382 383 384

   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable
385
   | Opt_DeriveGeneric            -- Allow deriving Generic/1
dreixel's avatar
dreixel committed
386 387
   | Opt_DefaultSignatures        -- Allow extra signatures for defmeths
   | Opt_Generics                 -- Old generic classes, now deprecated
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402

   | 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
403
   | Opt_MonadComprehensions
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419
   | 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
420
   | Opt_NondecreasingIndentation
421
   | Opt_RelaxedLayout
422 423
   deriving (Eq, Show)

424 425
-- | 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
426
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
427 428 429
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
430
  hscOutName            :: String,      -- ^ Name of the output file
431
  extCoreName           :: String,      -- ^ Name of the .hcr output file
432
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
433 434 435
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
436
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
437
  ruleCheck             :: Maybe String,
438
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
439

440 441 442
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
443 444
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
  			   	 	--   See CoreMonad.FloatOutSwitches
445

Ian Lynagh's avatar
Ian Lynagh committed
446
  targetPlatform        :: Platform.Platform, -- ^ The platform we're compiling for. Used by the NCG.
447
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
448 449 450
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
451
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
452

453 454
  dphBackend            :: DPHBackend,

455
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
456 457

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

462 463 464
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

465
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
466
  objectDir             :: Maybe String,
467
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
468 469
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
470

Ian Lynagh's avatar
Ian Lynagh committed
471 472 473
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
474

Ian Lynagh's avatar
Ian Lynagh committed
475 476 477
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
478

479
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
480 481
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
482

483 484
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
485 486 487 488 489 490 491
  dumpPrefixForce       :: Maybe FilePath,

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

492
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
493
  rtsOptsEnabled        :: RtsOptsEnabled,
494

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

497 498 499 500
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

501
  settings              :: Settings,
502

503 504 505 506 507 508
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

509
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
510
  extraPkgConfs         :: [FilePath],
511
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
512
        -- they appeared.
513

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

517
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
518
  -- NB. do not modify this field, it is calculated by
519
  -- Packages.initPackages and Packages.updatePackages.
520
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
521
  pkgState              :: PackageState,
522

523 524 525 526
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
527
  dirsToClean           :: IORef (Map FilePath FilePath),
528

529 530 531 532 533
  -- Names of files which were generated from -ddump-to-file; used to
  -- track which ones we need to truncate because it's our first run
  -- through
  generatedDumps        :: IORef (Set FilePath),

534
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
535
  flags                 :: [DynFlag],
536
  -- Don't change this without updating extensionFlags:
537
  language              :: Maybe Language,
538 539
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
540 541 542 543 544
  -- 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
545

546
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
547 548 549
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
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
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
575 576 577 578 579 580 581 582 583 584 585 586 587
  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

588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629
 }

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)
630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649
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)
650

651 652 653
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

654 655
-- | The target code type of the compilation (if any).
--
656 657 658
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
659 660 661 662
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
663 664 665
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
666
--
667 668 669 670 671 672
--  * 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.)
673
--
674
data HscTarget
675 676
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
677
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
678 679
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
680 681
  deriving (Eq, Show)

Ian Lynagh's avatar
Ian Lynagh committed
682 683 684 685 686 687 688
showHscTargetFlag :: HscTarget -> String
showHscTargetFlag HscC           = "-fvia-c"
showHscTargetFlag HscAsm         = "-fasm"
showHscTargetFlag HscLlvm        = "-fllvm"
showHscTargetFlag HscInterpreted = "-fbyte-code"
showHscTargetFlag HscNothing     = "-fno-code"

689
-- | Will this target result in an object file on the disk?
690 691 692
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
693
isObjectTarget HscLlvm  = True
694 695 696 697 698 699 700 701
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.
702
data GhcMode
703 704 705
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
706 707
  deriving Eq

708 709 710 711 712
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

713 714 715 716
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

717 718 719 720
-- | 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
721 722
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
723
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
724
  deriving (Eq, Show)
725 726 727

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

730 731 732
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
733 734 735
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.
736

737
data PackageFlag
738
  = ExposePackage   String
739
  | ExposePackageId String
740 741 742 743
  | HidePackage     String
  | IgnorePackage   String
  | TrustPackage    String
  | DistrustPackage String
744
  deriving Eq
745

twanvl's avatar
twanvl committed
746
defaultHscTarget :: HscTarget
747 748
defaultHscTarget = defaultObjectTarget

749
-- | The 'HscTarget' value corresponding to the default way to create
750
-- object files on the current platform.
twanvl's avatar
twanvl committed
751
defaultObjectTarget :: HscTarget
752
defaultObjectTarget
753
  | cGhcUnregisterised    == "YES"      =  HscC
Ian Lynagh's avatar
Ian Lynagh committed
754
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
755
  | otherwise                           =  HscLlvm
756

757 758 759 760 761
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
762
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll
763
  deriving (Show)
Ian Lynagh's avatar
Ian Lynagh committed
764

765
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
766
initDynFlags :: DynFlags -> IO DynFlags
767 768 769
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
770
 refFilesToClean <- newIORef []
771
 refDirsToClean <- newIORef Map.empty
772
 refGeneratedDumps <- newIORef Set.empty
773
 return dflags{
774 775 776
        ways            = ways,
        buildTag        = mkBuildTag (filter (not . wayRTSOnly) ways),
        rtsBuildTag     = mkBuildTag ways,
777
        filesToClean    = refFilesToClean,
778 779
        dirsToClean     = refDirsToClean,
        generatedDumps   = refGeneratedDumps
Ian Lynagh's avatar
Ian Lynagh committed
780
        }
781

782 783
-- | The normal 'DynFlags'. Note that they is not suitable for use in this form
-- and must be fully initialized by 'GHC.newSession' first.
784 785
defaultDynFlags :: Settings -> DynFlags
defaultDynFlags mySettings =
786
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
787 788 789 790 791 792 793
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
794
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
795
        maxSimplIterations      = 4,
796
        shouldDumpSimplPhase    = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
797
        ruleCheck               = Nothing,
798
        specConstrThreshold     = Just 2000,
Ian Lynagh's avatar
Ian Lynagh committed
799
        specConstrCount         = Just 3,
800
        liberateCaseThreshold   = Just 2000,
801
        floatLamArgs            = Just 0,	-- Default: float only if no fvs
802 803
        strictnessBefore        = [],

804
        targetPlatform          = defaultTargetPlatform,
Ian Lynagh's avatar
Ian Lynagh committed
805 806 807 808 809 810
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
811
        dphBackend              = DPHNone,
812

Ian Lynagh's avatar
Ian Lynagh committed
813 814 815
        thisPackage             = mainPackageId,

        objectDir               = Nothing,
816
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
817 818 819 820 821 822 823
        hiDir                   = Nothing,
        stubDir                 = Nothing,

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

824 825 826
        pluginModNames          = [],
        pluginModNameOpts       = [],

Ian Lynagh's avatar
Ian Lynagh committed
827 828
        outputFile              = Nothing,
        outputHi                = Nothing,
829
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
830 831 832 833 834 835
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
836
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
837
        rtsOptsEnabled          = RtsOptsSafeOnly,
Ian Lynagh's avatar
Ian Lynagh committed
838 839 840 841 842

        hpcDir                  = ".hpc",

        extraPkgConfs           = [],
        packageFlags            = [],
843 844
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
845
        ways                    = panic "defaultDynFlags: No ways",
Ian Lynagh's avatar
Ian Lynagh committed
846 847
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
848
        splitInfo               = Nothing,
849
        settings                = mySettings,
850 851 852 853 854 855
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        -- end of ghc -M values
856 857
        filesToClean   = panic "defaultDynFlags: No filesToClean",
        dirsToClean    = panic "defaultDynFlags: No dirsToClean",
858
        generatedDumps = panic "defaultDynFlags: No generatedDumps",
Ian Lynagh's avatar
Ian Lynagh committed
859
        haddockOptions = Nothing,
860
        flags = defaultFlags,
861
        language = Nothing,
862
        safeHaskell = Sf_None,
863 864
        extensions = [],
        extensionFlags = flattenExtensionFlags Nothing [],
865

Ian Lynagh's avatar
Ian Lynagh committed
866
        log_action = \severity srcSpan style msg ->
867
                        case severity of
868 869 870
                          SevOutput -> printSDoc msg style
                          SevInfo   -> printErrs msg style
                          SevFatal  -> printErrs msg style
871
                          _         -> do 
872
                                hPutChar stderr '\n'
873
                                printErrs (mkLocMessage srcSpan msg) style
874 875 876
                     -- 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.
877 878
      }

Ian Lynagh's avatar
Ian Lynagh committed
879
{-
880 881
Note [Verbosity levels]
~~~~~~~~~~~~~~~~~~~~~~~
Ian Lynagh's avatar
Ian Lynagh committed
882
    0   |   print errors & warnings only
883 884 885 886 887 888 889
    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"
-}

890 891 892 893 894
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
895 896 897
flattenExtensionFlags :: Maybe Language -> [OnOff ExtensionFlag]
                      -> [ExtensionFlag]
flattenExtensionFlags ml = foldr f defaultExtensionFlags
898 899
    where f (On f)  flags = f : delete f flags
          f (Off f) flags =     delete f flags
900 901 902
          defaultExtensionFlags = languageExtensions ml

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

904
languageExtensions Nothing
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
905
    -- Nothing => the default case
906 907 908
    = 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
909
      -- In due course I'd like Opt_MonoLocalBinds to be on by default
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
910
      -- But NB it's implied by GADTs etc
Ian Lynagh's avatar
Ian Lynagh committed
911
      -- SLPJ September 2010
912
    : Opt_NondecreasingIndentation -- This has been on by default for some time
913 914 915 916 917
    : delete Opt_DatatypeContexts  -- The Haskell' committee decided to
                                   -- remove datatype contexts from the
                                   -- language:
   -- http://www.haskell.org/pipermail/haskell-prime/2011-January/003335.html
      (languageExtensions (Just Haskell2010))
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
918

919 920 921 922
languageExtensions (Just Haskell98)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_NPlusKPatterns,
923 924 925 926 927 928 929 930
       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
931

932 933 934 935 936 937 938
languageExtensions (Just Haskell2010)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_DatatypeContexts,
       Opt_EmptyDataDecls,