DynFlags.hs 158 KB
Newer Older
1 2
{-# LANGUAGE CPP #-}

dterei's avatar
dterei committed
3
-------------------------------------------------------------------------------
4
--
dterei's avatar
dterei committed
5 6 7 8 9 10
-- | Dynamic flags
--
-- Most flags are dynamic flags, which means they can change from 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.
11 12 13
--
-- (c) The University of Glasgow 2005
--
dterei's avatar
dterei committed
14
-------------------------------------------------------------------------------
15

16
{-# OPTIONS_GHC -fno-cse #-}
17 18
-- -fno-cse is needed for GLOBAL_VAR's to behave properly

19
module DynFlags (
20
        -- * Dynamic flags and associated configuration types
21
        DumpFlag(..),
22
        GeneralFlag(..),
23
        WarningFlag(..),
24
        ExtensionFlag(..),
25
        Language(..),
26
        PlatformConstants(..),
Ian Lynagh's avatar
Ian Lynagh committed
27
        FatalMessager, LogAction, FlushOut(..), FlushErr(..),
28
        ProfAuto(..),
29
        glasgowExtsFlags,
30
        dopt, dopt_set, dopt_unset,
31 32 33
        gopt, gopt_set, gopt_unset,
        wopt, wopt_set, wopt_unset,
        xopt, xopt_set, xopt_unset,
34
        lang_set,
35
        useUnicodeSyntax,
36 37
        whenGeneratingDynamicToo, ifGeneratingDynamicToo,
        whenCannotGenerateDynamicToo,
38
        dynamicTooMkDynamicDynFlags,
Ian Lynagh's avatar
Ian Lynagh committed
39
        DynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
40
        HasDynFlags(..), ContainsDynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
41
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
42
        HscTarget(..), isObjectTarget, defaultObjectTarget,
43
        targetRetainsAllBindings,
Ian Lynagh's avatar
Ian Lynagh committed
44 45
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
46
        PackageFlag(..), PackageArg(..), ModRenaming,
47
        PkgConfRef(..),
Ian Lynagh's avatar
Ian Lynagh committed
48
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
49
        DynLibLoader(..),
50
        fFlags, fWarningFlags, fLangFlags, xFlags,
51
        dynFlagDependencies,
52
        tablesNextToCode, mkTablesNextToCode,
53
        SigOf(..), getSigOf,
54

55
        Way(..), mkBuildTag, wayRTSOnly, addWay', updateWays,
56
        wayGeneralFlags, wayUnsetGeneralFlags,
ian@well-typed.com's avatar
ian@well-typed.com committed
57

58
        -- ** Safe Haskell
59
        SafeHaskellMode(..),
60
        safeHaskellOn, safeImportsOn, safeLanguageOn, safeInferOn,
61
        packageTrustOn,
62
        safeDirectImpsReq, safeImplicitImpsReq,
63
        unsafeFlags, unsafeFlagsForInfer,
64

65
        -- ** System tool settings and locations
66
        Settings(..),
67
        targetPlatform,
68 69 70
        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,
71
        pgm_sysman, pgm_windres, pgm_libtool, pgm_lo, pgm_lc,
Ian Lynagh's avatar
Ian Lynagh committed
72
        opt_L, opt_P, opt_F, opt_c, opt_a, opt_l,
73
        opt_windres, opt_lo, opt_lc,
74 75


76
        -- ** Manipulating DynFlags
77
        defaultDynFlags,                -- Settings -> DynFlags
78
        defaultWays,
ian@well-typed.com's avatar
ian@well-typed.com committed
79
        interpWays,
Ian Lynagh's avatar
Ian Lynagh committed
80
        initDynFlags,                   -- DynFlags -> IO DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
81
        defaultFatalMessager,
82
        defaultLogAction,
83
        defaultLogActionHPrintDoc,
84
        defaultLogActionHPutStrDoc,
85 86
        defaultFlushOut,
        defaultFlushErr,
Ian Lynagh's avatar
Ian Lynagh committed
87

88
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
89
        getVerbFlags,
Ian Lynagh's avatar
Ian Lynagh committed
90 91
        updOptLevel,
        setTmpDir,
92
        setPackageKey,
Ian Lynagh's avatar
Ian Lynagh committed
93

94
        -- ** Parsing DynFlags
95 96
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
97 98 99
        parseDynamicFlagsFull,

        -- ** Available DynFlags
100
        allFlags,
101 102 103
        flagsAll,
        flagsDynamic,
        flagsPackage,
104

105
        supportedLanguagesAndExtensions,
106
        languageExtensions,
107

108
        -- ** DynFlags C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
109
        picCCOpts, picPOpts,
110 111 112 113 114 115

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

        -- * Compiler configuration suitable for display to the user
116 117
        compilerInfo,

118
#ifdef GHCI
119
        rtsIsProfiled,
120
#endif
121
        dynamicGhc,
122 123

#include "../includes/dist-derivedconstants/header/GHCConstantsHaskellExports.hs"
124
        bLOCK_SIZE_W,
125
        wORD_SIZE_IN_BITS,
126 127
        tAG_MASK,
        mAX_PTR_TAG,
128
        tARGET_MIN_INT, tARGET_MAX_INT, tARGET_MAX_WORD,
129

130 131
        unsafeGlobalDynFlags, setUnsafeGlobalDynFlags,

132
        -- * SSE and AVX
133
        isSseEnabled,
134 135
        isSse2Enabled,
        isSse4_2Enabled,
136 137
        isAvxEnabled,
        isAvx2Enabled,
138 139 140 141
        isAvx512cdEnabled,
        isAvx512erEnabled,
        isAvx512fEnabled,
        isAvx512pfEnabled,
142

Austin Seipp's avatar
Austin Seipp committed
143
        -- * Linker/compiler information
144
        LinkerInfo(..),
Austin Seipp's avatar
Austin Seipp committed
145
        CompilerInfo(..),
146 147 148 149
  ) where

#include "HsVersions.h"

150
import Platform
151
import PlatformConstants
152
import Module
Simon Marlow's avatar
Simon Marlow committed
153
import PackageConfig
154
import {-# SOURCE #-} Hooks
155
import {-# SOURCE #-} PrelNames ( mAIN )
156
import {-# SOURCE #-} Packages (PackageState)
Ian Lynagh's avatar
Ian Lynagh committed
157
import DriverPhases     ( Phase(..), phaseInputExt )
158 159
import Config
import CmdLineParser
160
import Constants
161
import Panic
162
import Util
163
import Maybes           ( orElse )
164
import MonadUtils
165
import qualified Pretty
166
import SrcLoc
167
import FastString
Simon Marlow's avatar
Simon Marlow committed
168
import Outputable
Ian Lynagh's avatar
Ian Lynagh committed
169
#ifdef GHCI
Ian Lynagh's avatar
Ian Lynagh committed
170
import Foreign.C        ( CInt(..) )
171
import System.IO.Unsafe ( unsafeDupablePerformIO )
Ian Lynagh's avatar
Ian Lynagh committed
172
#endif
173
import {-# SOURCE #-} ErrUtils ( Severity(..), MsgDoc, mkLocMessage )
174

175
import System.IO.Unsafe ( unsafePerformIO )
176
import Data.IORef
ian@well-typed.com's avatar
ian@well-typed.com committed
177
import Control.Monad
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
178

179
import Data.Bits
180
import Data.Char
181
import Data.Int
182
import Data.List
183 184
import Data.Map (Map)
import qualified Data.Map as Map
185
import Data.Maybe
186 187
import Data.Set (Set)
import qualified Data.Set as Set
188
import Data.Word
Ian Lynagh's avatar
Ian Lynagh committed
189
import System.FilePath
190
import System.IO
191
import System.IO.Error
192 193
import Text.ParserCombinators.ReadP hiding (char)
import Text.ParserCombinators.ReadP as R
194

195 196 197
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

198 199
import GHC.Foreign (withCString, peekCString)

200 201 202
-- -----------------------------------------------------------------------------
-- DynFlags

203
data DumpFlag
204 205 206

   -- debugging flags
   = Opt_D_dump_cmm
207 208 209 210 211 212
   | Opt_D_dump_cmm_raw
   -- All of the cmm subflags (there are a lot!)  Automatically
   -- enabled if you run -ddump-cmm
   | Opt_D_dump_cmm_cfg
   | Opt_D_dump_cmm_cbe
   | Opt_D_dump_cmm_proc
213
   | Opt_D_dump_cmm_sink
214 215 216 217 218 219
   | Opt_D_dump_cmm_sp
   | Opt_D_dump_cmm_procmap
   | Opt_D_dump_cmm_split
   | Opt_D_dump_cmm_info
   | Opt_D_dump_cmm_cps
   -- end cmm subflags
220
   | Opt_D_dump_asm
221 222 223 224 225
   | Opt_D_dump_asm_native
   | Opt_D_dump_asm_liveness
   | Opt_D_dump_asm_regalloc
   | Opt_D_dump_asm_regalloc_stages
   | Opt_D_dump_asm_conflicts
226
   | Opt_D_dump_asm_stats
227
   | Opt_D_dump_asm_expanded
228
   | Opt_D_dump_llvm
229
   | Opt_D_dump_core_stats
230 231 232 233
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
234
   | Opt_D_dump_rule_firings
235
   | Opt_D_dump_rule_rewrites
236
   | Opt_D_dump_simpl_trace
237 238 239 240 241 242 243 244
   | Opt_D_dump_occur_anal
   | Opt_D_dump_parsed
   | Opt_D_dump_rn
   | Opt_D_dump_simpl
   | Opt_D_dump_simpl_iterations
   | Opt_D_dump_spec
   | Opt_D_dump_prep
   | Opt_D_dump_stg
245
   | Opt_D_dump_call_arity
246
   | Opt_D_dump_stranal
Joachim Breitner's avatar
Joachim Breitner committed
247
   | Opt_D_dump_strsigs
248 249 250 251 252 253 254 255 256
   | 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
257
   | Opt_D_dump_cs_trace -- Constraint solver in type checker
258 259
   | Opt_D_dump_tc_trace
   | Opt_D_dump_if_trace
260
   | Opt_D_dump_vt_trace
261 262 263
   | Opt_D_dump_splices
   | Opt_D_dump_BCOs
   | Opt_D_dump_vect
264
   | Opt_D_dump_ticked
pepe's avatar
pepe committed
265
   | Opt_D_dump_rtti
266 267 268 269
   | Opt_D_source_stats
   | Opt_D_verbose_stg2stg
   | Opt_D_dump_hi
   | Opt_D_dump_hi_diffs
270
   | Opt_D_dump_mod_cycles
271
   | Opt_D_dump_mod_map
272
   | Opt_D_dump_view_pattern_commoning
273 274 275 276 277 278 279 280
   | Opt_D_verbose_core2core

   deriving (Eq, Show, Enum)

-- | Enumerates the simple on-or-off dynamic flags
data GeneralFlag

   = Opt_DumpToFile                     -- ^ Append dump output to files instead of stdout.
281
   | Opt_D_faststring_stats
282
   | Opt_D_dump_minimal_imports
283 284 285
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
286
   | Opt_DoAsmLinting
287
   | Opt_NoLlvmMangler                 -- hidden flag
288

Ian Lynagh's avatar
Ian Lynagh committed
289
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
290

291
   | Opt_PrintExplicitForalls
unknown's avatar
unknown committed
292
   | Opt_PrintExplicitKinds
293

294
   -- optimisation opts
295
   | Opt_CallArity
296
   | Opt_Strictness
297
   | Opt_LateDmdAnal
298 299
   | Opt_KillAbsence
   | Opt_KillOneShot
300
   | Opt_FullLaziness
301 302
   | Opt_FloatIn
   | Opt_Specialise
303
   | Opt_SpecialiseAggressively
304
   | Opt_StaticArgumentTransformation
305
   | Opt_CSE
306 307
   | Opt_LiberateCase
   | Opt_SpecConstr
308 309 310 311 312
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
313
   | Opt_UnboxSmallStrictFields
314
   | Opt_DictsCheap
315
   | Opt_EnableRewriteRules             -- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
316
   | Opt_Vectorise
317
   | Opt_VectorisationAvoidance
Ian Lynagh's avatar
Ian Lynagh committed
318 319
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
320
   | Opt_PedanticBottoms                -- Be picky about how we treat bottom
321
   | Opt_LlvmTBAA                       -- Use LLVM TBAA infastructure for improving AA (hidden flag)
322
   | Opt_LlvmPassVectorsInRegisters     -- Pass SIMD vectors in registers (requires a patched LLVM) (hidden flag)
323
   | Opt_IrrefutableTuples
324
   | Opt_CmmSink
325
   | Opt_CmmElimCommonBlocks
326
   | Opt_OmitYields
327
   | Opt_SimpleListLiterals
328
   | Opt_FunToThunk               -- allow WwLib.mkWorkerArgs to remove all value lambdas
329 330
   | Opt_DictsStrict                     -- be strict in argument dictionaries
   | Opt_DmdTxDictSel              -- use a special demand transformer for dictionary selectors
331
   | Opt_Loopification                  -- See Note [Self-recursive tail calls]
332

333 334 335 336
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings
337
   | Opt_WriteInterface -- forces .hi files to be written even with -fno-code
338

Ian Lynagh's avatar
Ian Lynagh committed
339 340
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
341
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
342

343 344
   -- misc opts
   | Opt_Pp
345
   | Opt_ForceRecomp
346
   | Opt_ExcessPrecision
347
   | Opt_EagerBlackHoling
348 349 350
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
351
   | Opt_HideAllPackages
352
   | Opt_PrintBindResult
353
   | Opt_Haddock
David Waern's avatar
David Waern committed
354
   | Opt_HaddockOptions
355
   | Opt_Hpc_No_Auto
356
   | Opt_BreakOnException
357
   | Opt_BreakOnError
358
   | Opt_PrintEvldWithShow
359
   | Opt_PrintBindContents
360 361
   | Opt_GenManifest
   | Opt_EmbedManifest
362
   | Opt_EmitExternalCore
Ian Lynagh's avatar
Ian Lynagh committed
363
   | Opt_SharedImplib
364
   | Opt_BuildingCabalPackage
365
   | Opt_IgnoreDotGhci
366
   | Opt_GhciSandbox
Ian Lynagh's avatar
Ian Lynagh committed
367
   | Opt_GhciHistory
368
   | Opt_HelpfulErrors
369
   | Opt_DeferTypeErrors
Ian Lynagh's avatar
Ian Lynagh committed
370
   | Opt_Parallel
Ian Lynagh's avatar
Ian Lynagh committed
371
   | Opt_GranMacros
Ian Lynagh's avatar
Ian Lynagh committed
372
   | Opt_PIC
373
   | Opt_SccProfilingOn
ian@well-typed.com's avatar
ian@well-typed.com committed
374
   | Opt_Ticky
nfrisby's avatar
nfrisby committed
375 376 377
   | Opt_Ticky_Allocd
   | Opt_Ticky_LNE
   | Opt_Ticky_Dyn_Thunk
ian@well-typed.com's avatar
ian@well-typed.com committed
378
   | Opt_Static
379
   | Opt_RPath
380
   | Opt_RelativeDynlibPaths
ian@well-typed.com's avatar
ian@well-typed.com committed
381
   | Opt_Hpc
382
   | Opt_FlatCache
383

384 385 386 387
   -- PreInlining is on by default. The option is there just to see how
   -- bad things get if you turn it off!
   | Opt_SimplPreInlining

388
   -- output style opts
389 390
   | Opt_ErrorSpans -- Include full span info in error messages,
                    -- instead of just the start position.
391
   | Opt_PprCaseAsLet
392

393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
   -- Suppress all coercions, them replacing with '...'
   | Opt_SuppressCoercions
   | Opt_SuppressVarKinds
   -- Suppress module id prefixes on variables.
   | Opt_SuppressModulePrefixes
   -- Suppress type applications.
   | Opt_SuppressTypeApplications
   -- Suppress info such as arity and unfoldings on identifiers.
   | Opt_SuppressIdInfo
   -- Suppress separate type signatures in core, but leave types on
   -- lambda bound vars
   | Opt_SuppressTypeSignatures
   -- Suppress unique ids on variables.
   -- Except for uniques, as some simplifier phases introduce new
   -- variables that have otherwise identical names.
   | Opt_SuppressUniques

410
   -- temporary flags
411
   | Opt_AutoLinkPackages
412
   | Opt_ImplicitImportQualified
413 414 415 416 417 418

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
419
   | Opt_KeepRawTokenStream
420
   | Opt_KeepLlvmFiles
421

422 423
   | Opt_BuildDynamicToo

424
   -- safe haskell flags
dterei's avatar
dterei committed
425
   | Opt_DistrustAllPackages
426 427
   | Opt_PackageTrust

428
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
429

430 431
data WarningFlag =
     Opt_WarnDuplicateExports
432
   | Opt_WarnDuplicateConstraints
433 434 435 436 437
   | Opt_WarnHiShadows
   | Opt_WarnImplicitPrelude
   | Opt_WarnIncompletePatterns
   | Opt_WarnIncompleteUniPatterns
   | Opt_WarnIncompletePatternsRecUpd
438
   | Opt_WarnOverflowedLiterals
439
   | Opt_WarnEmptyEnumerations
440 441 442 443 444 445 446 447 448 449 450 451
   | Opt_WarnMissingFields
   | Opt_WarnMissingImportList
   | Opt_WarnMissingMethods
   | Opt_WarnMissingSigs
   | Opt_WarnMissingLocalSigs
   | Opt_WarnNameShadowing
   | Opt_WarnOverlappingPatterns
   | Opt_WarnTypeDefaults
   | Opt_WarnMonomorphism
   | Opt_WarnUnusedBinds
   | Opt_WarnUnusedImports
   | Opt_WarnUnusedMatches
452
   | Opt_WarnContextQuantification
453 454
   | Opt_WarnWarningsDeprecations
   | Opt_WarnDeprecatedFlags
455
   | Opt_WarnAMP
456 457 458 459 460 461 462 463 464 465 466
   | Opt_WarnDodgyExports
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
   | Opt_WarnAutoOrphans
   | Opt_WarnIdentities
   | Opt_WarnTabs
   | Opt_WarnUnrecognisedPragmas
   | Opt_WarnDodgyForeignImports
   | Opt_WarnUnusedDoBind
   | Opt_WarnWrongDoBind
   | Opt_WarnAlternativeLayoutRuleTransitional
467 468
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
469
   | Opt_WarnPointlessPragmas
470
   | Opt_WarnUnsupportedCallingConventions
471
   | Opt_WarnUnsupportedLlvmVersion
472
   | Opt_WarnInlineRuleShadowing
473
   | Opt_WarnTypedHoles
474
   deriving (Eq, Show, Enum)
475

476
data Language = Haskell98 | Haskell2010
477
   deriving Enum
478

479
-- | The various Safe Haskell modes
480 481
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
482
   | Sf_Unsafe
483 484 485 486
   | Sf_Trustworthy
   | Sf_Safe
   deriving (Eq)

Ian Lynagh's avatar
Ian Lynagh committed
487
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
488 489 490 491
    show Sf_None         = "None"
    show Sf_Unsafe       = "Unsafe"
    show Sf_Trustworthy  = "Trustworthy"
    show Sf_Safe         = "Safe"
Ian Lynagh's avatar
Ian Lynagh committed
492

493
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
494
    ppr = text . show
495

496
data ExtensionFlag
497 498 499 500 501 502 503
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
504 505
   | Opt_RelaxedPolyRec           -- Deprecated
   | Opt_ExtendedDefaultRules     -- Use GHC's extended rules for defaulting
506 507
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
508
   | Opt_InterruptibleFFI
509
   | Opt_CApiFFI
510
   | Opt_GHCForeignImportPrim
thoughtpolice's avatar
thoughtpolice committed
511
   | Opt_JavaScriptFFI
512 513
   | Opt_ParallelArrays           -- Syntactic support for parallel arrays
   | Opt_Arrows                   -- Arrow-notation syntax
514 515 516 517 518
   | Opt_TemplateHaskell
   | Opt_QuasiQuotes
   | Opt_ImplicitParams
   | Opt_ImplicitPrelude
   | Opt_ScopedTypeVariables
519
   | Opt_AllowAmbiguousTypes
520 521 522 523
   | Opt_UnboxedTuples
   | Opt_BangPatterns
   | Opt_TypeFamilies
   | Opt_OverloadedStrings
524
   | Opt_OverloadedLists
525
   | Opt_NumDecimals
526 527 528 529 530
   | Opt_DisambiguateRecordFields
   | Opt_RecordWildCards
   | Opt_RecordPuns
   | Opt_ViewPatterns
   | Opt_GADTs
Ian Lynagh's avatar
Ian Lynagh committed
531
   | Opt_GADTSyntax
532
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
533
   | Opt_DoAndIfThenElse
534
   | Opt_RebindableSyntax
535
   | Opt_ConstraintKinds
dreixel's avatar
dreixel committed
536
   | Opt_PolyKinds                -- Kind polymorphism
dreixel's avatar
dreixel committed
537
   | Opt_DataKinds                -- Datatype promotion
538
   | Opt_InstanceSigs
539

540 541
   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
542
   | Opt_AutoDeriveTypeable       -- Automatic derivation of Typeable
543 544 545
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable
546
   | Opt_DeriveGeneric            -- Allow deriving Generic/1
dreixel's avatar
dreixel committed
547
   | Opt_DefaultSignatures        -- Allow extra signatures for defmeths
548 549 550 551 552 553

   | Opt_TypeSynonymInstances
   | Opt_FlexibleContexts
   | Opt_FlexibleInstances
   | Opt_ConstrainedClassMethods
   | Opt_MultiParamTypeClasses
554
   | Opt_NullaryTypeClasses
555 556 557 558 559 560
   | Opt_FunctionalDependencies
   | Opt_UnicodeSyntax
   | Opt_ExistentialQuantification
   | Opt_MagicHash
   | Opt_EmptyDataDecls
   | Opt_KindSignatures
561
   | Opt_RoleAnnotations
562 563
   | Opt_ParallelListComp
   | Opt_TransformListComp
564
   | Opt_MonadComprehensions
565 566 567 568 569 570 571 572 573
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
574
   | Opt_ExplicitNamespaces
575 576 577 578 579
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
580
   | Opt_NondecreasingIndentation
581
   | Opt_RelaxedLayout
582
   | Opt_TraditionalRecordSyntax
583
   | Opt_LambdaCase
584
   | Opt_MultiWayIf
585
   | Opt_BinaryLiterals
586
   | Opt_NegativeLiterals
587
   | Opt_EmptyCase
cactus's avatar
cactus committed
588
   | Opt_PatternSynonyms
589
   deriving (Eq, Enum, Show)
590

591 592 593 594 595 596 597 598 599 600 601
data SigOf = NotSigOf
           | SigOf Module
           | SigOfMap (Map ModuleName Module)

getSigOf :: DynFlags -> ModuleName -> Maybe Module
getSigOf dflags n =
    case sigOf dflags of
        NotSigOf -> Nothing
        SigOf m -> Just m
        SigOfMap m -> Map.lookup n m

602
-- | Contains not only a collection of 'GeneralFlag's but also a plethora of
603
-- information relating to the compilation of a single file or GHC session
604
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
605 606 607
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
608
  settings              :: Settings,
609 610
  -- See Note [Signature parameters in TcGblEnv and DynFlags]
  sigOf                 :: SigOf,       -- ^ Compiling an hs-boot against impl.
611
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
612 613 614
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
Ian Lynagh's avatar
Ian Lynagh committed
615
  ruleCheck             :: Maybe String,
616
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
617

618 619
  parMakeCount          :: Maybe Int,   -- ^ The number of modules to compile in parallel
                                        --   in --make mode, where Nothing ==> compile as
parcs's avatar
parcs committed
620 621
                                        --   many in parallel as there are CPUs.

622 623 624
  enableTimeStats       :: Bool,        -- ^ Enable RTS timing statistics?
  ghcHeapSize           :: Maybe Int,   -- ^ The heap size to set.

625 626
  maxRelevantBinds      :: Maybe Int,   -- ^ Maximum number of bindings from the type envt
                                        --   to show in type error messages
627
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
628 629
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
630 631
  specConstrRecursive   :: Int,         -- ^ Max number of specialisations for recursive types
                                        --   Not optional; otherwise ForceSpecConstr can diverge.
632
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
633
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
634
                                        --   See CoreMonad.FloatOutSwitches
635

636
  historySize           :: Int,
637

638
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
639 640 641
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
642
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
643
  tyFunStkDepth         :: Int,         -- ^ Typechecker type function stack depth
644

645
  thisPackage           :: PackageKey,   -- ^ name of package currently being compiled
646 647

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

652 653 654
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

655
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
656
  objectDir             :: Maybe String,
657
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
658 659
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
660
  dumpDir               :: Maybe String,
661

Ian Lynagh's avatar
Ian Lynagh committed
662 663 664
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
665

666 667 668 669
  canGenerateDynamicToo :: IORef Bool,
  dynObjectSuf          :: String,
  dynHiSuf              :: String,

670 671 672 673 674 675 676 677
  -- Packages.isDllName needs to know whether a call is within a
  -- single DLL or not. Normally it does this by seeing if the call
  -- is to the same package, but for the ghc package, we split the
  -- package between 2 DLLs. The dllSplit tells us which sets of
  -- modules are in which package.
  dllSplitFile          :: Maybe FilePath,
  dllSplit              :: Maybe [Set String],

Ian Lynagh's avatar
Ian Lynagh committed
678
  outputFile            :: Maybe String,
ian@well-typed.com's avatar
ian@well-typed.com committed
679
  dynOutputFile         :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
680 681
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
682

683
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
684 685
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
686

687 688
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
689 690
  dumpPrefixForce       :: Maybe FilePath,

691
  ldInputs              :: [Option],
692

Ian Lynagh's avatar
Ian Lynagh committed
693 694 695 696 697
  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

698
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
699
  rtsOptsEnabled        :: RtsOptsEnabled,
700

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

703 704 705 706
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

707 708 709
  -- GHC API hooks
  hooks                 :: Hooks,

710 711 712 713 714 715
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

716
  --  Package flags
717
  extraPkgConfs         :: [PkgConfRef] -> [PkgConfRef],
718
        -- ^ The @-package-db@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
719
        -- they appeared.
720

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

724
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
725
  -- NB. do not modify this field, it is calculated by
726
  -- Packages.initPackages and Packages.updatePackages.
727
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
728
  pkgState              :: PackageState,
729

730 731 732 733
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
734
  dirsToClean           :: IORef (Map FilePath FilePath),
735
  filesToNotIntermediateClean :: IORef [FilePath],
736 737
  -- The next available suffix to uniquely name a temp file, updated atomically
  nextTempSuffix        :: IORef Int,
738

739 740 741 742 743
  -- 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),

744
  -- hsc dynamic flags
745 746
  dumpFlags             :: IntSet,
  generalFlags          :: IntSet,
747
  warningFlags          :: IntSet,
748
  -- Don't change this without updating extensionFlags:
749
  language              :: Maybe Language,
750 751
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
752 753
  safeInfer             :: Bool,
  safeInferred          :: Bool,
754 755 756
  -- We store the location of where some extension and flags were turned on so
  -- we can produce accurate error messages when Safe Haskell fails due to
  -- them.
757 758
  thOnLoc               :: SrcSpan,
  newDerivOnLoc         :: SrcSpan,
759
  overlapInstLoc        :: SrcSpan,
760
  pkgTrustOnLoc         :: SrcSpan,
761 762
  warnSafeOnLoc         :: SrcSpan,
  warnUnsafeOnLoc       :: SrcSpan,
763 764 765 766
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
767
  extensionFlags        :: IntSet,
Ian Lynagh's avatar
Ian Lynagh committed
768

769 770 771 772 773 774 775 776 777
  -- Unfolding control
  -- See Note [Discounts and thresholds] in CoreUnfold
  ufCreationThreshold   :: Int,
  ufUseThreshold        :: Int,
  ufFunAppDiscount      :: Int,
  ufDictDiscount        :: Int,
  ufKeenessFactor       :: Float,
  ufDearOp              :: Int,

778 779
  maxWorkerArgs         :: Int,

780 781
  ghciHistSize          :: Int,

782
  -- | MsgDoc output action: use "ErrUtils" instead of this if you can
783
  log_action            :: LogAction,
784 785
  flushOut              :: FlushOut,
  flushErr              :: FlushErr,
David Waern's avatar
David Waern committed
786

787
  haddockOptions        :: Maybe String,
788
  ghciScripts           :: [String],
789