DynFlags.hs 172 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(..),
40
        FlagSpec(..),
Ian Lynagh's avatar
Ian Lynagh committed
41
        HasDynFlags(..), ContainsDynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
42
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
43
        HscTarget(..), isObjectTarget, defaultObjectTarget,
44
        targetRetainsAllBindings,
Ian Lynagh's avatar
Ian Lynagh committed
45 46
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
47
        PackageFlag(..), PackageArg(..), ModRenaming(..),
48
        PkgConfRef(..),
Ian Lynagh's avatar
Ian Lynagh committed
49
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
50
        DynLibLoader(..),
51
        fFlags, fWarningFlags, fLangFlags, xFlags,
52
        dynFlagDependencies,
53
        tablesNextToCode, mkTablesNextToCode,
Edward Z. Yang's avatar
Edward Z. Yang committed
54
        SigOf, getSigOf,
55
        checkOptLevel,
56

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

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

67
        -- ** System tool settings and locations
68
        Settings(..),
69
        targetPlatform, programName, projectVersion,
70
        ghcUsagePath, ghciUsagePath, topDir, tmpDir, rawSettings,
Edsko de Vries's avatar
Edsko de Vries committed
71
        versionedAppDir,
72 73
        extraGccViaCFlags, systemPackageConfig,
        pgm_L, pgm_P, pgm_F, pgm_c, pgm_s, pgm_a, pgm_l, pgm_dll, pgm_T,
74
        pgm_sysman, pgm_windres, pgm_libtool, pgm_lo, pgm_lc,
Ian Lynagh's avatar
Ian Lynagh committed
75
        opt_L, opt_P, opt_F, opt_c, opt_a, opt_l,
76
        opt_windres, opt_lo, opt_lc,
77 78


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

91
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
92
        getVerbFlags,
Ian Lynagh's avatar
Ian Lynagh committed
93 94
        updOptLevel,
        setTmpDir,
95
        setPackageKey,
Edsko de Vries's avatar
Edsko de Vries committed
96
        interpretPackageEnv,
Ian Lynagh's avatar
Ian Lynagh committed
97

98
        -- ** Parsing DynFlags
99 100
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
101 102 103
        parseDynamicFlagsFull,

        -- ** Available DynFlags
104
        allFlags,
105 106 107
        flagsAll,
        flagsDynamic,
        flagsPackage,
108
        flagsForCompletion,
109

110
        supportedLanguagesAndExtensions,
111
        languageExtensions,
112

113
        -- ** DynFlags C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
114
        picCCOpts, picPOpts,
115 116 117 118 119 120

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

        -- * Compiler configuration suitable for display to the user
121 122
        compilerInfo,

123
#ifdef GHCI
124
        rtsIsProfiled,
125
#endif
126
        dynamicGhc,
127 128

#include "../includes/dist-derivedconstants/header/GHCConstantsHaskellExports.hs"
129
        bLOCK_SIZE_W,
130
        wORD_SIZE_IN_BITS,
131 132
        tAG_MASK,
        mAX_PTR_TAG,
133
        tARGET_MIN_INT, tARGET_MAX_INT, tARGET_MAX_WORD,
134

135 136
        unsafeGlobalDynFlags, setUnsafeGlobalDynFlags,

137
        -- * SSE and AVX
138
        isSseEnabled,
139 140
        isSse2Enabled,
        isSse4_2Enabled,
141 142
        isAvxEnabled,
        isAvx2Enabled,
143 144 145 146
        isAvx512cdEnabled,
        isAvx512erEnabled,
        isAvx512fEnabled,
        isAvx512pfEnabled,
147

Austin Seipp's avatar
Austin Seipp committed
148
        -- * Linker/compiler information
149
        LinkerInfo(..),
Austin Seipp's avatar
Austin Seipp committed
150
        CompilerInfo(..),
151 152 153 154
  ) where

#include "HsVersions.h"

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

181
import System.IO.Unsafe ( unsafePerformIO )
182
import Data.IORef
183
import Control.Arrow ((&&&))
ian@well-typed.com's avatar
ian@well-typed.com committed
184
import Control.Monad
Edsko de Vries's avatar
Edsko de Vries committed
185
import Control.Exception (throwIO)
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
186

187
import Data.Bits
188
import Data.Char
189
import Data.Int
190
import Data.List
191 192
import Data.Map (Map)
import qualified Data.Map as Map
193 194
import Data.Set (Set)
import qualified Data.Set as Set
195
import Data.Word
Ian Lynagh's avatar
Ian Lynagh committed
196
import System.FilePath
Edsko de Vries's avatar
Edsko de Vries committed
197 198
import System.Directory
import System.Environment (getEnv)
199
import System.IO
200
import System.IO.Error
201 202
import Text.ParserCombinators.ReadP hiding (char)
import Text.ParserCombinators.ReadP as R
203

204 205 206
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

207 208
import GHC.Foreign (withCString, peekCString)

209 210 211 212 213 214 215 216 217 218 219 220 221
-- Note [Updating flag description in the User's Guide]
-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--
-- If you modify anything in this file please make sure that your changes are
-- described in the User's Guide. Usually at least two sections need to be
-- updated:
--
--  * Flag Reference section in docs/users-guide/flags.xml lists all available
--    flags together with a short description
--
--  * Flag description in docs/users_guide/using.xml provides a detailed
--    explanation of flags' usage.

222 223 224 225 226 227 228 229 230 231 232 233
-- Note [Supporting CLI completion]
-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--
-- The command line interface completion (in for example bash) is an easy way
-- for the developer to learn what flags are available from GHC.
-- GHC helps by separating which flags are available when compiling with GHC,
-- and which flags are available when using GHCi.
-- A flag is assumed to either work in both these modes, or only in one of them.
-- When adding or changing a flag, please consider for which mode the flag will
-- have effect, and annotate it accordingly. For Flags use defFlag, defGhcFlag,
-- defGhciFlag, and for FlagSpec use flagSpec or flagGhciSpec.

234 235 236
-- -----------------------------------------------------------------------------
-- DynFlags

237
data DumpFlag
238
-- See Note [Updating flag description in the User's Guide]
239 240 241

   -- debugging flags
   = Opt_D_dump_cmm
242 243 244 245 246
   | 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
247
   | Opt_D_dump_cmm_switch
248
   | Opt_D_dump_cmm_proc
249
   | Opt_D_dump_cmm_sink
250 251 252 253 254 255
   | 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
256
   | Opt_D_dump_asm
257 258 259 260 261
   | 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
262
   | Opt_D_dump_asm_stats
263
   | Opt_D_dump_asm_expanded
264
   | Opt_D_dump_llvm
265
   | Opt_D_dump_core_stats
266 267 268 269
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
270
   | Opt_D_dump_rule_firings
271
   | Opt_D_dump_rule_rewrites
272
   | Opt_D_dump_simpl_trace
273 274 275 276 277 278 279 280
   | 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
281
   | Opt_D_dump_call_arity
282
   | Opt_D_dump_stranal
Joachim Breitner's avatar
Joachim Breitner committed
283
   | Opt_D_dump_strsigs
284 285 286 287 288 289 290 291 292
   | 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
293
   | Opt_D_dump_cs_trace -- Constraint solver in type checker
294 295
   | Opt_D_dump_tc_trace
   | Opt_D_dump_if_trace
296
   | Opt_D_dump_vt_trace
297
   | Opt_D_dump_splices
298
   | Opt_D_th_dec_file
299 300
   | Opt_D_dump_BCOs
   | Opt_D_dump_vect
301
   | Opt_D_dump_ticked
pepe's avatar
pepe committed
302
   | Opt_D_dump_rtti
303 304 305 306
   | Opt_D_source_stats
   | Opt_D_verbose_stg2stg
   | Opt_D_dump_hi
   | Opt_D_dump_hi_diffs
307
   | Opt_D_dump_mod_cycles
308
   | Opt_D_dump_mod_map
309
   | Opt_D_dump_view_pattern_commoning
310
   | Opt_D_verbose_core2core
311
   | Opt_D_dump_debug
312 313 314 315 316

   deriving (Eq, Show, Enum)

-- | Enumerates the simple on-or-off dynamic flags
data GeneralFlag
317
-- See Note [Updating flag description in the User's Guide]
318 319

   = Opt_DumpToFile                     -- ^ Append dump output to files instead of stdout.
320
   | Opt_D_faststring_stats
321
   | Opt_D_dump_minimal_imports
322 323 324
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
325
   | Opt_DoAsmLinting
Peter Wortmann's avatar
Peter Wortmann committed
326
   | Opt_DoAnnotationLinting
327
   | Opt_NoLlvmMangler                 -- hidden flag
328

Ian Lynagh's avatar
Ian Lynagh committed
329
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
330

331
   | Opt_PrintExplicitForalls
unknown's avatar
unknown committed
332
   | Opt_PrintExplicitKinds
333
   | Opt_PrintUnicodeSyntax
334

335
   -- optimisation opts
336
   | Opt_CallArity
337
   | Opt_Strictness
338
   | Opt_LateDmdAnal
339 340
   | Opt_KillAbsence
   | Opt_KillOneShot
341
   | Opt_FullLaziness
342 343
   | Opt_FloatIn
   | Opt_Specialise
344
   | Opt_SpecialiseAggressively
345
   | Opt_StaticArgumentTransformation
346
   | Opt_CSE
347 348
   | Opt_LiberateCase
   | Opt_SpecConstr
349 350 351 352 353
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
354
   | Opt_UnboxSmallStrictFields
355
   | Opt_DictsCheap
356
   | Opt_EnableRewriteRules             -- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
357
   | Opt_Vectorise
358
   | Opt_VectorisationAvoidance
Ian Lynagh's avatar
Ian Lynagh committed
359 360
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
361
   | Opt_PedanticBottoms                -- Be picky about how we treat bottom
362
   | Opt_LlvmTBAA                       -- Use LLVM TBAA infastructure for improving AA (hidden flag)
363
   | Opt_LlvmPassVectorsInRegisters     -- Pass SIMD vectors in registers (requires a patched LLVM) (hidden flag)
364
   | Opt_IrrefutableTuples
365
   | Opt_CmmSink
366
   | Opt_CmmElimCommonBlocks
367
   | Opt_OmitYields
368
   | Opt_SimpleListLiterals
369
   | Opt_FunToThunk               -- allow WwLib.mkWorkerArgs to remove all value lambdas
370 371
   | Opt_DictsStrict                     -- be strict in argument dictionaries
   | Opt_DmdTxDictSel              -- use a special demand transformer for dictionary selectors
372
   | Opt_Loopification                  -- See Note [Self-recursive tail calls]
373

374 375 376 377
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings
378
   | Opt_WriteInterface -- forces .hi files to be written even with -fno-code
379

Ian Lynagh's avatar
Ian Lynagh committed
380 381
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
382
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
383

384 385
   -- misc opts
   | Opt_Pp
386
   | Opt_ForceRecomp
387
   | Opt_ExcessPrecision
388
   | Opt_EagerBlackHoling
389 390 391
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
392
   | Opt_HideAllPackages
393
   | Opt_PrintBindResult
394
   | Opt_Haddock
David Waern's avatar
David Waern committed
395
   | Opt_HaddockOptions
396
   | Opt_BreakOnException
397
   | Opt_BreakOnError
398
   | Opt_PrintEvldWithShow
399
   | Opt_PrintBindContents
400 401
   | Opt_GenManifest
   | Opt_EmbedManifest
Ian Lynagh's avatar
Ian Lynagh committed
402
   | Opt_SharedImplib
403
   | Opt_BuildingCabalPackage
404
   | Opt_IgnoreDotGhci
405
   | Opt_GhciSandbox
Ian Lynagh's avatar
Ian Lynagh committed
406
   | Opt_GhciHistory
407
   | Opt_HelpfulErrors
408
   | Opt_DeferTypeErrors
409
   | Opt_DeferTypedHoles
Ian Lynagh's avatar
Ian Lynagh committed
410
   | Opt_Parallel
Ian Lynagh's avatar
Ian Lynagh committed
411
   | Opt_PIC
412
   | Opt_SccProfilingOn
ian@well-typed.com's avatar
ian@well-typed.com committed
413
   | Opt_Ticky
nfrisby's avatar
nfrisby committed
414 415 416
   | Opt_Ticky_Allocd
   | Opt_Ticky_LNE
   | Opt_Ticky_Dyn_Thunk
ian@well-typed.com's avatar
ian@well-typed.com committed
417
   | Opt_Static
418
   | Opt_RPath
419
   | Opt_RelativeDynlibPaths
ian@well-typed.com's avatar
ian@well-typed.com committed
420
   | Opt_Hpc
421
   | Opt_FlatCache
422

423 424 425 426
   -- PreInlining is on by default. The option is there just to see how
   -- bad things get if you turn it off!
   | Opt_SimplPreInlining

427
   -- output style opts
428 429
   | Opt_ErrorSpans -- Include full span info in error messages,
                    -- instead of just the start position.
430
   | Opt_PprCaseAsLet
Peter Wortmann's avatar
Peter Wortmann committed
431
   | Opt_PprShowTicks
432

433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
   -- 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

450
   -- temporary flags
451
   | Opt_AutoLinkPackages
452
   | Opt_ImplicitImportQualified
453 454 455 456 457 458

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
459
   | Opt_KeepRawTokenStream
460
   | Opt_KeepLlvmFiles
461

462 463
   | Opt_BuildDynamicToo

464
   -- safe haskell flags
dterei's avatar
dterei committed
465
   | Opt_DistrustAllPackages
466 467
   | Opt_PackageTrust

Peter Wortmann's avatar
Peter Wortmann committed
468 469 470
   -- debugging flags
   | Opt_Debug

471
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
472

473
data WarningFlag =
474
-- See Note [Updating flag description in the User's Guide]
475
     Opt_WarnDuplicateExports
476
   | Opt_WarnDuplicateConstraints
477
   | Opt_WarnRedundantConstraints
478 479 480 481 482
   | Opt_WarnHiShadows
   | Opt_WarnImplicitPrelude
   | Opt_WarnIncompletePatterns
   | Opt_WarnIncompleteUniPatterns
   | Opt_WarnIncompletePatternsRecUpd
483
   | Opt_WarnOverflowedLiterals
484
   | Opt_WarnEmptyEnumerations
485 486 487 488 489 490 491 492 493
   | Opt_WarnMissingFields
   | Opt_WarnMissingImportList
   | Opt_WarnMissingMethods
   | Opt_WarnMissingSigs
   | Opt_WarnMissingLocalSigs
   | Opt_WarnNameShadowing
   | Opt_WarnOverlappingPatterns
   | Opt_WarnTypeDefaults
   | Opt_WarnMonomorphism
494 495 496
   | Opt_WarnUnusedTopBinds
   | Opt_WarnUnusedLocalBinds
   | Opt_WarnUnusedPatternBinds
497 498
   | Opt_WarnUnusedImports
   | Opt_WarnUnusedMatches
499
   | Opt_WarnContextQuantification
500 501
   | Opt_WarnWarningsDeprecations
   | Opt_WarnDeprecatedFlags
502
   | Opt_WarnAMP
503 504 505 506 507 508 509 510 511 512 513
   | Opt_WarnDodgyExports
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
   | Opt_WarnAutoOrphans
   | Opt_WarnIdentities
   | Opt_WarnTabs
   | Opt_WarnUnrecognisedPragmas
   | Opt_WarnDodgyForeignImports
   | Opt_WarnUnusedDoBind
   | Opt_WarnWrongDoBind
   | Opt_WarnAlternativeLayoutRuleTransitional
514 515
   | Opt_WarnUnsafe
   | Opt_WarnSafe
516
   | Opt_WarnTrustworthySafe
Ian Lynagh's avatar
Ian Lynagh committed
517
   | Opt_WarnPointlessPragmas
518
   | Opt_WarnUnsupportedCallingConventions
519
   | Opt_WarnUnsupportedLlvmVersion
520
   | Opt_WarnInlineRuleShadowing
521
   | Opt_WarnTypedHoles
thomasw's avatar
thomasw committed
522
   | Opt_WarnPartialTypeSignatures
523
   | Opt_WarnMissingExportedSigs
carlostome's avatar
carlostome committed
524
   | Opt_WarnUntickedPromotedConstructors
525
   | Opt_WarnDerivingTypeable
526
   deriving (Eq, Show, Enum)
527

528
data Language = Haskell98 | Haskell2010
529
   deriving Enum
530

531
-- | The various Safe Haskell modes
532 533
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
534
   | Sf_Unsafe
535 536 537 538
   | Sf_Trustworthy
   | Sf_Safe
   deriving (Eq)

Ian Lynagh's avatar
Ian Lynagh committed
539
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
540 541 542 543
    show Sf_None         = "None"
    show Sf_Unsafe       = "Unsafe"
    show Sf_Trustworthy  = "Trustworthy"
    show Sf_Safe         = "Safe"
Ian Lynagh's avatar
Ian Lynagh committed
544

545
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
546
    ppr = text . show
547

548
data ExtensionFlag
549
-- See Note [Updating flag description in the User's Guide]
550 551 552 553 554 555 556
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
557 558
   | Opt_RelaxedPolyRec           -- Deprecated
   | Opt_ExtendedDefaultRules     -- Use GHC's extended rules for defaulting
559 560
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
561
   | Opt_InterruptibleFFI
562
   | Opt_CApiFFI
563
   | Opt_GHCForeignImportPrim
thoughtpolice's avatar
thoughtpolice committed
564
   | Opt_JavaScriptFFI
565 566
   | Opt_ParallelArrays           -- Syntactic support for parallel arrays
   | Opt_Arrows                   -- Arrow-notation syntax
567 568 569 570 571
   | Opt_TemplateHaskell
   | Opt_QuasiQuotes
   | Opt_ImplicitParams
   | Opt_ImplicitPrelude
   | Opt_ScopedTypeVariables
572
   | Opt_AllowAmbiguousTypes
573 574 575 576
   | Opt_UnboxedTuples
   | Opt_BangPatterns
   | Opt_TypeFamilies
   | Opt_OverloadedStrings
577
   | Opt_OverloadedLists
578
   | Opt_NumDecimals
579 580 581 582 583
   | Opt_DisambiguateRecordFields
   | Opt_RecordWildCards
   | Opt_RecordPuns
   | Opt_ViewPatterns
   | Opt_GADTs
Ian Lynagh's avatar
Ian Lynagh committed
584
   | Opt_GADTSyntax
585
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
586
   | Opt_DoAndIfThenElse
587
   | Opt_RebindableSyntax
588
   | Opt_ConstraintKinds
dreixel's avatar
dreixel committed
589
   | Opt_PolyKinds                -- Kind polymorphism
dreixel's avatar
dreixel committed
590
   | Opt_DataKinds                -- Datatype promotion
591
   | Opt_InstanceSigs
592

593 594
   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
595
   | Opt_AutoDeriveTypeable       -- Automatic derivation of Typeable
596 597 598
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable
599
   | Opt_DeriveGeneric            -- Allow deriving Generic/1
dreixel's avatar
dreixel committed
600
   | Opt_DefaultSignatures        -- Allow extra signatures for defmeths
601
   | Opt_DeriveAnyClass           -- Allow deriving any class
602 603 604 605 606 607

   | Opt_TypeSynonymInstances
   | Opt_FlexibleContexts
   | Opt_FlexibleInstances
   | Opt_ConstrainedClassMethods
   | Opt_MultiParamTypeClasses
608
   | Opt_NullaryTypeClasses
609 610 611 612 613 614
   | Opt_FunctionalDependencies
   | Opt_UnicodeSyntax
   | Opt_ExistentialQuantification
   | Opt_MagicHash
   | Opt_EmptyDataDecls
   | Opt_KindSignatures
615
   | Opt_RoleAnnotations
616 617
   | Opt_ParallelListComp
   | Opt_TransformListComp
618
   | Opt_MonadComprehensions
619 620 621 622 623 624 625 626 627
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
628
   | Opt_ExplicitNamespaces
629 630 631 632 633
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
634
   | Opt_NondecreasingIndentation
635
   | Opt_RelaxedLayout
636
   | Opt_TraditionalRecordSyntax
637
   | Opt_LambdaCase
638
   | Opt_MultiWayIf
639
   | Opt_BinaryLiterals
640
   | Opt_NegativeLiterals
641
   | Opt_EmptyCase
cactus's avatar
cactus committed
642
   | Opt_PatternSynonyms
thomasw's avatar
thomasw committed
643
   | Opt_PartialTypeSignatures
644
   | Opt_NamedWildCards
Facundo Domínguez's avatar
Facundo Domínguez committed
645
   | Opt_StaticPointers
646
   deriving (Eq, Enum, Show)
647

Edward Z. Yang's avatar
Edward Z. Yang committed
648
type SigOf = Map ModuleName Module
649 650

getSigOf :: DynFlags -> ModuleName -> Maybe Module
Edward Z. Yang's avatar
Edward Z. Yang committed
651
getSigOf dflags n = Map.lookup n (sigOf dflags)
652

653
-- | Contains not only a collection of 'GeneralFlag's but also a plethora of
654
-- information relating to the compilation of a single file or GHC session
655
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
656 657 658
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
659
  settings              :: Settings,
660 661
  -- See Note [Signature parameters in TcGblEnv and DynFlags]
  sigOf                 :: SigOf,       -- ^ Compiling an hs-boot against impl.
662
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
663 664 665
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
Ian Lynagh's avatar
Ian Lynagh committed
666
  ruleCheck             :: Maybe String,
667
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
668

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

673 674 675
  enableTimeStats       :: Bool,        -- ^ Enable RTS timing statistics?
  ghcHeapSize           :: Maybe Int,   -- ^ The heap size to set.

676 677
  maxRelevantBinds      :: Maybe Int,   -- ^ Maximum number of bindings from the type envt
                                        --   to show in type error messages
678
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
679 680
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
681 682
  specConstrRecursive   :: Int,         -- ^ Max number of specialisations for recursive types
                                        --   Not optional; otherwise ForceSpecConstr can diverge.
683
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
684
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
685
                                        --   See CoreMonad.FloatOutSwitches
686

687
  historySize           :: Int,
688

689
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
690 691 692
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
693
  reductionDepth        :: IntWithInf,   -- ^ Typechecker maximum stack depth
694 695
  solverIterations      :: IntWithInf,   -- ^ Number of iterations in the constraints solver
                                         --   Typically only 1 is needed
696

697
  thisPackage           :: PackageKey,   -- ^ name of package currently being compiled
698 699

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

704 705 706
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

707
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
708
  objectDir             :: Maybe String,
709
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
710 711
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
712
  dumpDir               :: Maybe String,
713

Ian Lynagh's avatar
Ian Lynagh committed
714 715 716
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
717

718 719 720 721
  canGenerateDynamicToo :: IORef Bool,
  dynObjectSuf          :: String,
  dynHiSuf              :: String,

722 723 724 725 726 727 728 729
  -- 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
730
  outputFile            :: Maybe String,