DynFlags.hs 173 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,
54
        SigOf(..), getSigOf,
55

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

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

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


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

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

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

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

109
        supportedLanguagesAndExtensions,
110
        languageExtensions,
111

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

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

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

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

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

134 135
        unsafeGlobalDynFlags, setUnsafeGlobalDynFlags,

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

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

#include "HsVersions.h"

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

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

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

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

206 207
import GHC.Foreign (withCString, peekCString)

208 209 210 211 212 213 214 215 216 217 218 219 220
-- 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.

221 222 223 224 225 226 227 228 229 230 231 232
-- 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.

233 234 235
-- -----------------------------------------------------------------------------
-- DynFlags

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

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

   deriving (Eq, Show, Enum)

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

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

Ian Lynagh's avatar
Ian Lynagh committed
327
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
328

329
   | Opt_PrintExplicitForalls
unknown's avatar
unknown committed
330
   | Opt_PrintExplicitKinds
331

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

371 372 373 374
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings
375
   | Opt_WriteInterface -- forces .hi files to be written even with -fno-code
376

Ian Lynagh's avatar
Ian Lynagh committed
377 378
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
379
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
380

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

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

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

430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
   -- 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

447
   -- temporary flags
448
   | Opt_AutoLinkPackages
449
   | Opt_ImplicitImportQualified
450 451 452 453 454 455

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
456
   | Opt_KeepRawTokenStream
457
   | Opt_KeepLlvmFiles
458

459 460
   | Opt_BuildDynamicToo

461
   -- safe haskell flags
dterei's avatar
dterei committed
462
   | Opt_DistrustAllPackages
463 464
   | Opt_PackageTrust

Peter Wortmann's avatar
Peter Wortmann committed
465 466 467
   -- debugging flags
   | Opt_Debug

468
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
469

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

525
data Language = Haskell98 | Haskell2010
526
   deriving Enum
527

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

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

542
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
543
    ppr = text . show
544

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

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

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

645 646 647 648 649 650 651 652 653 654 655
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

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

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

676 677 678
  enableTimeStats       :: Bool,        -- ^ Enable RTS timing statistics?
  ghcHeapSize           :: Maybe Int,   -- ^ The heap size to set.

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

690
  historySize           :: Int,
691

692
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
693 694 695
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
696
  reductionDepth        :: IntWithInf,   -- ^ Typechecker maximum stack depth
697

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

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

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

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

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

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

723 724 725 726 727 728 729 730
  -- 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
731
  outputFile            :: Maybe String,
ian@well-typed.com's avatar
ian@well-typed.com committed
732
  dynOutputFile         :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
733 734
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
735

736
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
737 738
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
739

740 741
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
742 743
  dumpPrefixForce       :: Maybe FilePath,

744
  ldInputs              :: [Option],
745

Ian Lynagh's avatar
Ian Lynagh committed
746 747 748 749 750
  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

751
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
752
  rtsOptsEnabled        :: RtsOptsEnabled,
753

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

756 757 758 759
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

760 761 762
  -- GHC API hooks
  hooks                 :: Hooks,

763 764 765 766 767 768
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

769
  --  Package flags
770
  extraPkgConfs         :: [PkgConfRef] -> [PkgConfRef],
771
        -- ^ The @-package-db@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
772
        -- they appeared.
773

Ian Lynagh's avatar
Ian Lynagh committed
774
  packageFlags          :: [PackageFlag],
775
        -- ^ The @-package@ and @-hide-package@ flags from the command-line
Edsko de Vries's avatar
Edsko de Vries committed
776 777
  packageEnv            :: Maybe FilePath,
        -- ^ Filepath to the package environment file (if overriding default)
778

779
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
780
  -- NB. do not modify this field, it is calculated by
Edward Z. Yang's avatar
Edward Z. Yang committed
781
  -- Packages.initPackages
782
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
783
  pkgState              :: PackageState,
784

785 786 787