DynFlags.hs 218 KB
Newer Older
1
{-# LANGUAGE CPP #-}
2
{-# LANGUAGE FlexibleInstances #-}
3

dterei's avatar
dterei committed
4
-------------------------------------------------------------------------------
5
--
dterei's avatar
dterei committed
6 7 8 9 10 11
-- | 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.
12 13 14
--
-- (c) The University of Glasgow 2005
--
dterei's avatar
dterei committed
15
-------------------------------------------------------------------------------
16

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

20
module DynFlags (
21
        -- * Dynamic flags and associated configuration types
22
        DumpFlag(..),
23
        GeneralFlag(..),
24
        WarningFlag(..), WarnReason(..),
25
        Language(..),
26
        PlatformConstants(..),
Ian Lynagh's avatar
Ian Lynagh committed
27
        FatalMessager, LogAction, FlushOut(..), FlushErr(..),
28
        ProfAuto(..),
29
        glasgowExtsFlags,
30
        warningGroups, warningHierarchies,
Sylvain Henry's avatar
Sylvain Henry committed
31
        hasPprDebug, hasNoDebugOutput, hasNoStateHack, hasNoOptCoercion,
32
        dopt, dopt_set, dopt_unset,
triple's avatar
triple committed
33
        gopt, gopt_set, gopt_unset, setGeneralFlag', unSetGeneralFlag',
34
        wopt, wopt_set, wopt_unset,
35
        wopt_fatal,
36
        xopt, xopt_set, xopt_unset,
37
        lang_set,
38
        useUnicodeSyntax,
39 40
        whenGeneratingDynamicToo, ifGeneratingDynamicToo,
        whenCannotGenerateDynamicToo,
41
        dynamicTooMkDynamicDynFlags,
Ian Lynagh's avatar
Ian Lynagh committed
42
        DynFlags(..),
43
        FlagSpec(..),
Ian Lynagh's avatar
Ian Lynagh committed
44
        HasDynFlags(..), ContainsDynFlags(..),
45
        OverridingBool(..), overrideWith,
Ian Lynagh's avatar
Ian Lynagh committed
46
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
47
        HscTarget(..), isObjectTarget, defaultObjectTarget,
48
        targetRetainsAllBindings,
Ian Lynagh's avatar
Ian Lynagh committed
49 50
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
51
        PackageFlag(..), PackageArg(..), ModRenaming(..),
52
        IgnorePackageFlag(..), TrustFlag(..),
53
        PkgConfRef(..),
Ian Lynagh's avatar
Ian Lynagh committed
54
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
55
        DynLibLoader(..),
56 57
        fFlags, fLangFlags, xFlags,
        wWarningFlags,
58
        dynFlagDependencies,
59
        tablesNextToCode, mkTablesNextToCode,
Ben Gamari's avatar
Ben Gamari committed
60
        makeDynFlagsConsistent,
61

62
        Way(..), mkBuildTag, wayRTSOnly, addWay', updateWays,
63
        wayGeneralFlags, wayUnsetGeneralFlags,
ian@well-typed.com's avatar
ian@well-typed.com committed
64

65 66
        thisPackage, thisComponentId, thisUnitIdInsts,

67
        -- ** Safe Haskell
68
        SafeHaskellMode(..),
69
        safeHaskellOn, safeImportsOn, safeLanguageOn, safeInferOn,
70
        packageTrustOn,
71
        safeDirectImpsReq, safeImplicitImpsReq,
72
        unsafeFlags, unsafeFlagsForInfer,
73

74
        -- ** System tool settings and locations
75
        Settings(..),
76
        targetPlatform, programName, projectVersion,
77
        ghcUsagePath, ghciUsagePath, topDir, tmpDir, rawSettings,
Edsko de Vries's avatar
Edsko de Vries committed
78
        versionedAppDir,
79 80
        extraGccViaCFlags, systemPackageConfig,
        pgm_L, pgm_P, pgm_F, pgm_c, pgm_s, pgm_a, pgm_l, pgm_dll, pgm_T,
81 82
        pgm_windres, pgm_libtool, pgm_lo, pgm_lc, pgm_i,
        opt_L, opt_P, opt_F, opt_c, opt_a, opt_l, opt_i,
83
        opt_windres, opt_lo, opt_lc,
84 85


86
        -- ** Manipulating DynFlags
87
        defaultDynFlags,                -- Settings -> DynFlags
88
        defaultWays,
ian@well-typed.com's avatar
ian@well-typed.com committed
89
        interpWays,
90
        interpreterProfiled, interpreterDynamic,
Ian Lynagh's avatar
Ian Lynagh committed
91
        initDynFlags,                   -- DynFlags -> IO DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
92
        defaultFatalMessager,
93
        defaultLogAction,
94
        defaultLogActionHPrintDoc,
95
        defaultLogActionHPutStrDoc,
96 97
        defaultFlushOut,
        defaultFlushErr,
Ian Lynagh's avatar
Ian Lynagh committed
98

99
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
100
        getVerbFlags,
Ian Lynagh's avatar
Ian Lynagh committed
101 102
        updOptLevel,
        setTmpDir,
103
        setUnitId,
Edsko de Vries's avatar
Edsko de Vries committed
104
        interpretPackageEnv,
Edward Z. Yang's avatar
Edward Z. Yang committed
105
        canonicalizeHomeModule,
Ian Lynagh's avatar
Ian Lynagh committed
106

107
        -- ** Parsing DynFlags
108 109
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
110 111 112
        parseDynamicFlagsFull,

        -- ** Available DynFlags
113
        allNonDeprecatedFlags,
114 115 116
        flagsAll,
        flagsDynamic,
        flagsPackage,
117
        flagsForCompletion,
118

119
        supportedLanguagesAndExtensions,
120
        languageExtensions,
121

122
        -- ** DynFlags C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
123
        picCCOpts, picPOpts,
124 125

        -- * Compiler configuration suitable for display to the user
126 127 128
        compilerInfo,

        rtsIsProfiled,
129
        dynamicGhc,
130

131
#include "GHCConstantsHaskellExports.hs"
132
        bLOCK_SIZE_W,
133
        wORD_SIZE_IN_BITS,
134 135
        tAG_MASK,
        mAX_PTR_TAG,
136
        tARGET_MIN_INT, tARGET_MAX_INT, tARGET_MAX_WORD,
137

138 139
        unsafeGlobalDynFlags, setUnsafeGlobalDynFlags,

140
        -- * SSE and AVX
141
        isSseEnabled,
142 143
        isSse2Enabled,
        isSse4_2Enabled,
144 145
        isAvxEnabled,
        isAvx2Enabled,
146 147 148 149
        isAvx512cdEnabled,
        isAvx512erEnabled,
        isAvx512fEnabled,
        isAvx512pfEnabled,
150

Austin Seipp's avatar
Austin Seipp committed
151
        -- * Linker/compiler information
152
        LinkerInfo(..),
Austin Seipp's avatar
Austin Seipp committed
153
        CompilerInfo(..),
154 155 156 157
  ) where

#include "HsVersions.h"

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

185
import System.IO.Unsafe ( unsafePerformIO )
186
import Data.IORef
187
import Control.Arrow ((&&&))
ian@well-typed.com's avatar
ian@well-typed.com committed
188
import Control.Monad
189 190 191 192
import Control.Monad.Trans.Class
import Control.Monad.Trans.Writer
import Control.Monad.Trans.Reader
import Control.Monad.Trans.Except
193
import Control.Exception (throwIO)
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
194

195
import Data.Ord
196
import Data.Bits
197
import Data.Char
198
import Data.Int
199
import Data.List
200 201
import Data.Map (Map)
import qualified Data.Map as Map
202 203
import Data.Set (Set)
import qualified Data.Set as Set
204
import Data.Word
Ian Lynagh's avatar
Ian Lynagh committed
205
import System.FilePath
Edsko de Vries's avatar
Edsko de Vries committed
206 207
import System.Directory
import System.Environment (getEnv)
208
import System.IO
209
import System.IO.Error
210 211
import Text.ParserCombinators.ReadP hiding (char)
import Text.ParserCombinators.ReadP as R
212

213 214
import EnumSet (EnumSet)
import qualified EnumSet
215

216
import GHC.Foreign (withCString, peekCString)
217
import qualified GHC.LanguageExtensions as LangExt
218

219
import Foreign (Ptr) -- needed for 2nd stage
Moritz Angermann's avatar
Moritz Angermann committed
220

221 222 223 224 225 226 227
-- 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:
--
228 229
--  * Flag Reference section generated from the modules in
--    utils/mkUserGuidePart/Options
230
--
231
--  * Flag description in docs/users_guide/using.rst provides a detailed
232 233
--    explanation of flags' usage.

234 235 236 237 238 239 240 241 242 243 244 245
-- 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.

246 247 248 249 250 251 252
-- Note [Adding a language extension]
-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--
-- There are a few steps to adding (or removing) a language extension,
--
--  * Adding the extension to GHC.LanguageExtensions
--
253 254
--    The Extension type in libraries/ghc-boot-th/GHC/LanguageExtensions/Type.hs
--    is the canonical list of language extensions known by GHC.
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
--
--  * Adding a flag to DynFlags.xFlags
--
--    This is fairly self-explanatory. The name should be concise, memorable,
--    and consistent with any previous implementations of the similar idea in
--    other Haskell compilers.
--
--  * Adding the flag to the documentation
--
--    This is the same as any other flag. See
--    Note [Updating flag description in the User's Guide]
--
--  * Adding the flag to Cabal
--
--    The Cabal library has its own list of all language extensions supported
--    by all major compilers. This is the list that user code being uploaded
--    to Hackage is checked against to ensure language extension validity.
--    Consequently, it is very important that this list remains up-to-date.
--
--    To this end, there is a testsuite test (testsuite/tests/driver/T4437.hs)
--    whose job it is to ensure these GHC's extensions are consistent with
--    Cabal.
--
--    The recommended workflow is,
--
--     1. Temporarily add your new language extension to the
--        expectedGhcOnlyExtensions list in T4437 to ensure the test doesn't
--        break while Cabal is updated.
--
--     2. After your GHC change is accepted, submit a Cabal pull request adding
--        your new extension to Cabal's list (found in
--        Cabal/Language/Haskell/Extension.hs).
--
--     3. After your Cabal change is accepted, let the GHC developers know so
--        they can update the Cabal submodule and remove the extensions from
--        expectedGhcOnlyExtensions.
--
--  * Adding the flag to the GHC Wiki
--
--    There is a change log tracking language extension additions and removals
--    on the GHC wiki:  https://ghc.haskell.org/trac/ghc/wiki/LanguagePragmaHistory
--
--  See Trac #4437 and #8176.

299 300 301
-- -----------------------------------------------------------------------------
-- DynFlags

302
data DumpFlag
303
-- See Note [Updating flag description in the User's Guide]
304 305 306

   -- debugging flags
   = Opt_D_dump_cmm
307
   | Opt_D_dump_cmm_from_stg
308
   | Opt_D_dump_cmm_raw
309 310 311 312
   | Opt_D_dump_cmm_verbose
   -- All of the cmm subflags (there are a lot!) automatically
   -- enabled if you run -ddump-cmm-verbose
   -- Each flag corresponds to exact stage of Cmm pipeline.
313 314
   | Opt_D_dump_cmm_cfg
   | Opt_D_dump_cmm_cbe
315
   | Opt_D_dump_cmm_switch
316 317
   | Opt_D_dump_cmm_proc
   | Opt_D_dump_cmm_sp
318 319
   | Opt_D_dump_cmm_sink
   | Opt_D_dump_cmm_caf
320 321 322 323 324
   | Opt_D_dump_cmm_procmap
   | Opt_D_dump_cmm_split
   | Opt_D_dump_cmm_info
   | Opt_D_dump_cmm_cps
   -- end cmm subflags
325
   | Opt_D_dump_asm
326 327 328 329 330
   | 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
331
   | Opt_D_dump_asm_stats
332
   | Opt_D_dump_asm_expanded
333
   | Opt_D_dump_llvm
334
   | Opt_D_dump_core_stats
335 336 337 338
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
339
   | Opt_D_dump_rule_firings
340
   | Opt_D_dump_rule_rewrites
341
   | Opt_D_dump_simpl_trace
342 343
   | Opt_D_dump_occur_anal
   | Opt_D_dump_parsed
344
   | Opt_D_dump_parsed_ast
345
   | Opt_D_dump_rn
346
   | Opt_D_dump_rn_ast
Edward Z. Yang's avatar
Edward Z. Yang committed
347
   | Opt_D_dump_shape
348 349 350 351 352
   | Opt_D_dump_simpl
   | Opt_D_dump_simpl_iterations
   | Opt_D_dump_spec
   | Opt_D_dump_prep
   | Opt_D_dump_stg
353
   | Opt_D_dump_call_arity
354
   | Opt_D_dump_stranal
manav's avatar
manav committed
355
   | Opt_D_dump_str_signatures
356
   | Opt_D_dump_tc
357
   | Opt_D_dump_tc_ast
358 359 360 361 362 363 364 365
   | 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
366
   | Opt_D_dump_cs_trace -- Constraint solver in type checker
367
   | Opt_D_dump_tc_trace
368
   | Opt_D_dump_ec_trace -- Pattern match exhaustiveness checker
369
   | Opt_D_dump_if_trace
370
   | Opt_D_dump_vt_trace
371
   | Opt_D_dump_splices
372
   | Opt_D_th_dec_file
373 374
   | Opt_D_dump_BCOs
   | Opt_D_dump_vect
375
   | Opt_D_dump_ticked
pepe's avatar
pepe committed
376
   | Opt_D_dump_rtti
377 378 379 380
   | Opt_D_source_stats
   | Opt_D_verbose_stg2stg
   | Opt_D_dump_hi
   | Opt_D_dump_hi_diffs
381
   | Opt_D_dump_mod_cycles
382
   | Opt_D_dump_mod_map
383
   | Opt_D_dump_view_pattern_commoning
384
   | Opt_D_verbose_core2core
385
   | Opt_D_dump_debug
386
   | Opt_D_dump_json
Sylvain Henry's avatar
Sylvain Henry committed
387 388
   | Opt_D_ppr_debug
   | Opt_D_no_debug_output
389 390 391 392
   deriving (Eq, Show, Enum)

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

   = Opt_DumpToFile                     -- ^ Append dump output to files instead of stdout.
396
   | Opt_D_faststring_stats
397
   | Opt_D_dump_minimal_imports
398 399 400
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
401
   | Opt_DoAsmLinting
Peter Wortmann's avatar
Peter Wortmann committed
402
   | Opt_DoAnnotationLinting
403
   | Opt_NoLlvmMangler                 -- hidden flag
404

Ian Lynagh's avatar
Ian Lynagh committed
405
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
406
   | Opt_ShowWarnGroups                 -- Show the group a warning belongs to
407
   | Opt_HideSourcePaths                -- Hide module source/object paths
408

409
   | Opt_PrintExplicitForalls
unknown's avatar
unknown committed
410
   | Opt_PrintExplicitKinds
411
   | Opt_PrintExplicitCoercions
412
   | Opt_PrintExplicitRuntimeReps
413
   | Opt_PrintEqualityRelations
414
   | Opt_PrintUnicodeSyntax
415
   | Opt_PrintExpandedSynonyms
416
   | Opt_PrintPotentialInstances
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
417
   | Opt_PrintTypecheckerElaboration
418

419
   -- optimisation opts
420
   | Opt_CallArity
421
   | Opt_Strictness
422
   | Opt_LateDmdAnal
423 424
   | Opt_KillAbsence
   | Opt_KillOneShot
425
   | Opt_FullLaziness
426 427
   | Opt_FloatIn
   | Opt_Specialise
428
   | Opt_SpecialiseAggressively
429
   | Opt_CrossModuleSpecialise
430
   | Opt_StaticArgumentTransformation
431
   | Opt_CSE
432
   | Opt_StgCSE
433 434
   | Opt_LiberateCase
   | Opt_SpecConstr
Simon Peyton Jones's avatar
Simon Peyton Jones committed
435
   | Opt_SpecConstrKeen
436 437 438 439
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
Sylvain Henry's avatar
Sylvain Henry committed
440
   | Opt_CaseFolding                    -- Constant folding through case-expressions
441
   | Opt_UnboxStrictFields
442
   | Opt_UnboxSmallStrictFields
443
   | Opt_DictsCheap
444
   | Opt_EnableRewriteRules             -- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
445
   | Opt_Vectorise
446
   | Opt_VectorisationAvoidance
Ian Lynagh's avatar
Ian Lynagh committed
447 448
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
449
   | Opt_PedanticBottoms                -- Be picky about how we treat bottom
450
   | Opt_LlvmTBAA                       -- Use LLVM TBAA infastructure for improving AA (hidden flag)
451
   | Opt_LlvmPassVectorsInRegisters     -- Pass SIMD vectors in registers (requires a patched LLVM) (hidden flag)
452
   | Opt_LlvmFillUndefWithGarbage       -- Testing for undef bugs (hidden flag)
453
   | Opt_IrrefutableTuples
454
   | Opt_CmmSink
455
   | Opt_CmmElimCommonBlocks
456
   | Opt_OmitYields
457
   | Opt_FunToThunk               -- allow WwLib.mkWorkerArgs to remove all value lambdas
458 459
   | Opt_DictsStrict                     -- be strict in argument dictionaries
   | Opt_DmdTxDictSel              -- use a special demand transformer for dictionary selectors
460
   | Opt_Loopification                  -- See Note [Self-recursive tail calls]
461
   | Opt_CprAnal
462
   | Opt_WorkerWrapper
463
   | Opt_SolveConstantDicts
464

465 466 467 468
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings
469
   | Opt_WriteInterface -- forces .hi files to be written even with -fno-code
470

Ian Lynagh's avatar
Ian Lynagh committed
471 472
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
473
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
474

475 476
   -- misc opts
   | Opt_Pp
477
   | Opt_ForceRecomp
478
   | Opt_ExcessPrecision
479
   | Opt_EagerBlackHoling
480 481
   | Opt_NoHsMain
   | Opt_SplitObjs
482
   | Opt_SplitSections
483
   | Opt_StgStats
484
   | Opt_HideAllPackages
485
   | Opt_HideAllPluginPackages
486
   | Opt_PrintBindResult
487
   | Opt_Haddock
David Waern's avatar
David Waern committed
488
   | Opt_HaddockOptions
489
   | Opt_BreakOnException
490
   | Opt_BreakOnError
491
   | Opt_PrintEvldWithShow
492
   | Opt_PrintBindContents
493 494
   | Opt_GenManifest
   | Opt_EmbedManifest
Ian Lynagh's avatar
Ian Lynagh committed
495
   | Opt_SharedImplib
496
   | Opt_BuildingCabalPackage
497
   | Opt_IgnoreDotGhci
498
   | Opt_GhciSandbox
Ian Lynagh's avatar
Ian Lynagh committed
499
   | Opt_GhciHistory
500
   | Opt_LocalGhciHistory
501
   | Opt_HelpfulErrors
502
   | Opt_DeferTypeErrors
503
   | Opt_DeferTypedHoles
504
   | Opt_DeferOutOfScopeVariables
Ian Lynagh's avatar
Ian Lynagh committed
505
   | Opt_PIC
506
   | Opt_SccProfilingOn
ian@well-typed.com's avatar
ian@well-typed.com committed
507
   | Opt_Ticky
nfrisby's avatar
nfrisby committed
508 509 510
   | Opt_Ticky_Allocd
   | Opt_Ticky_LNE
   | Opt_Ticky_Dyn_Thunk
511
   | Opt_RPath
512
   | Opt_RelativeDynlibPaths
ian@well-typed.com's avatar
ian@well-typed.com committed
513
   | Opt_Hpc
514
   | Opt_FlatCache
515
   | Opt_ExternalInterpreter
Simon Marlow's avatar
Simon Marlow committed
516
   | Opt_OptimalApplicativeDo
517
   | Opt_VersionMacros
Simon Marlow's avatar
Simon Marlow committed
518
   | Opt_WholeArchiveHsLibs
519

520 521 522 523
   -- PreInlining is on by default. The option is there just to see how
   -- bad things get if you turn it off!
   | Opt_SimplPreInlining

524
   -- output style opts
525 526
   | Opt_ErrorSpans -- Include full span info in error messages,
                    -- instead of just the start position.
Rufflewind's avatar
Rufflewind committed
527
   | Opt_DiagnosticsShowCaret -- Show snippets of offending code
528
   | Opt_PprCaseAsLet
Peter Wortmann's avatar
Peter Wortmann committed
529
   | Opt_PprShowTicks
530
   | Opt_ShowHoleConstraints
531

532 533 534 535 536 537 538 539 540 541 542
   -- 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
543 544
   | Opt_SuppressUnfoldings
   -- Suppress the details of even stable unfoldings
545 546 547 548 549
   | Opt_SuppressTypeSignatures
   -- Suppress unique ids on variables.
   -- Except for uniques, as some simplifier phases introduce new
   -- variables that have otherwise identical names.
   | Opt_SuppressUniques
550
   | Opt_SuppressTicks     -- Replaces Opt_PprShowTicks
551

552
   -- temporary flags
553
   | Opt_AutoLinkPackages
554
   | Opt_ImplicitImportQualified
555 556 557 558 559 560

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
561
   | Opt_KeepRawTokenStream
562
   | Opt_KeepLlvmFiles
563 564
   | Opt_KeepHiFiles
   | Opt_KeepOFiles
565

566 567
   | Opt_BuildDynamicToo

568
   -- safe haskell flags
dterei's avatar
dterei committed
569
   | Opt_DistrustAllPackages
570
   | Opt_PackageTrust
Sylvain Henry's avatar
Sylvain Henry committed
571 572 573

   | Opt_G_NoStateHack
   | Opt_G_NoOptCoercion
574
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
575

576 577 578 579
-- | Used when outputting warnings: if a reason is given, it is
-- displayed. If a warning isn't controlled by a flag, this is made
-- explicit at the point of use.
data WarnReason = NoReason | Reason !WarningFlag
Richard Eisenberg's avatar
Richard Eisenberg committed
580 581 582 583
  deriving Show

instance Outputable WarnReason where
  ppr = text . show
584

585 586 587 588
instance ToJson WarnReason where
  json NoReason = JSNull
  json (Reason wf) = JSString (show wf)

589
data WarningFlag =
590
-- See Note [Updating flag description in the User's Guide]
591
     Opt_WarnDuplicateExports
592
   | Opt_WarnDuplicateConstraints
593
   | Opt_WarnRedundantConstraints
594 595 596 597 598
   | Opt_WarnHiShadows
   | Opt_WarnImplicitPrelude
   | Opt_WarnIncompletePatterns
   | Opt_WarnIncompleteUniPatterns
   | Opt_WarnIncompletePatternsRecUpd
599
   | Opt_WarnOverflowedLiterals
600
   | Opt_WarnEmptyEnumerations
601 602 603
   | Opt_WarnMissingFields
   | Opt_WarnMissingImportList
   | Opt_WarnMissingMethods
manav's avatar
manav committed
604 605
   | Opt_WarnMissingSignatures
   | Opt_WarnMissingLocalSignatures
606 607 608 609
   | Opt_WarnNameShadowing
   | Opt_WarnOverlappingPatterns
   | Opt_WarnTypeDefaults
   | Opt_WarnMonomorphism
610 611 612
   | Opt_WarnUnusedTopBinds
   | Opt_WarnUnusedLocalBinds
   | Opt_WarnUnusedPatternBinds
613 614
   | Opt_WarnUnusedImports
   | Opt_WarnUnusedMatches
615 616
   | Opt_WarnUnusedTypePatterns
   | Opt_WarnUnusedForalls
617 618
   | Opt_WarnWarningsDeprecations
   | Opt_WarnDeprecatedFlags
619
   | Opt_WarnAMP -- Introduced in GHC 7.8, obsolete since 7.10
620
   | Opt_WarnMissingMonadFailInstances -- since 8.0
621
   | Opt_WarnSemigroup -- since 8.0
622 623 624 625 626 627 628 629 630 631 632
   | Opt_WarnDodgyExports
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
   | Opt_WarnAutoOrphans
   | Opt_WarnIdentities
   | Opt_WarnTabs
   | Opt_WarnUnrecognisedPragmas
   | Opt_WarnDodgyForeignImports
   | Opt_WarnUnusedDoBind
   | Opt_WarnWrongDoBind
   | Opt_WarnAlternativeLayoutRuleTransitional
633 634
   | Opt_WarnUnsafe
   | Opt_WarnSafe
635
   | Opt_WarnTrustworthySafe
636 637
   | Opt_WarnMissedSpecs
   | Opt_WarnAllMissedSpecs
638
   | Opt_WarnUnsupportedCallingConventions
639
   | Opt_WarnUnsupportedLlvmVersion
640
   | Opt_WarnInlineRuleShadowing
641
   | Opt_WarnTypedHoles
thomasw's avatar
thomasw committed
642
   | Opt_WarnPartialTypeSignatures
manav's avatar
manav committed
643
   | Opt_WarnMissingExportedSignatures
carlostome's avatar
carlostome committed
644
   | Opt_WarnUntickedPromotedConstructors
645
   | Opt_WarnDerivingTypeable
646
   | Opt_WarnDeferredTypeErrors
647
   | Opt_WarnDeferredOutOfScopeVariables
648
   | Opt_WarnNonCanonicalMonadInstances   -- since 8.0
649
   | Opt_WarnNonCanonicalMonadFailInstances -- since 8.0
650
   | Opt_WarnNonCanonicalMonoidInstances  -- since 8.0
manav's avatar
manav committed
651
   | Opt_WarnMissingPatternSynonymSignatures -- since 8.0
652
   | Opt_WarnUnrecognisedWarningFlags     -- since 8.0
653
   | Opt_WarnSimplifiableClassConstraints -- Since 8.2
654
   | Opt_WarnCPPUndef                     -- Since 8.2
Richard Eisenberg's avatar
Richard Eisenberg committed
655
   | Opt_WarnUnbangedStrictPatterns       -- Since 8.2
Yuras's avatar
Yuras committed
656
   | Opt_WarnMissingHomeModules           -- Since 8.2
657
   deriving (Eq, Show, Enum)
658

659
data Language = Haskell98 | Haskell2010
Oleg Grenrus's avatar
Oleg Grenrus committed
660 661 662 663
   deriving (Eq, Enum, Show)

instance Outputable Language where
    ppr = text . show
664

665
-- | The various Safe Haskell modes
666 667
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
668
   | Sf_Unsafe
669 670 671 672
   | Sf_Trustworthy
   | Sf_Safe
   deriving (Eq)

Ian Lynagh's avatar
Ian Lynagh committed
673
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
674 675 676 677
    show Sf_None         = "None"
    show Sf_Unsafe       = "Unsafe"
    show Sf_Trustworthy  = "Trustworthy"
    show Sf_Safe         = "Safe"
Ian Lynagh's avatar
Ian Lynagh committed
678

679
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
680
    ppr = text . show
681

682
-- | Contains not only a collection of 'GeneralFlag's but also a plethora of
683
-- information relating to the compilation of a single file or GHC session
684
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
685 686 687
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
688
  settings              :: Settings,
689
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
690
  optLevel              :: Int,         -- ^ Optimisation level
691
  debugLevel            :: Int,         -- ^ How much debug information to produce
692 693
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
694
  maxPmCheckIterations  :: Int,         -- ^ Max no iterations for pm checking
Ian Lynagh's avatar
Ian Lynagh committed
695
  ruleCheck             :: Maybe String,
696
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
697

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

702 703 704
  enableTimeStats       :: Bool,        -- ^ Enable RTS timing statistics?
  ghcHeapSize           :: Maybe Int,   -- ^ The heap size to set.

705 706
  maxRelevantBinds      :: Maybe Int,   -- ^ Maximum number of bindings from the type envt
                                        --   to show in type error messages
707 708
  maxUncoveredPatterns  :: Int,         -- ^ Maximum number of unmatched patterns to show
                                        --   in non-exhaustiveness warnings
709
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
710 711
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
712 713
  specConstrRecursive   :: Int,         -- ^ Max number of specialisations for recursive types
                                        --   Not optional; otherwise ForceSpecConstr can diverge.
714
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
715