DynFlags.hs 220 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(..),
27
        FatalMessager, LogAction, LogFinaliser, 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(..),
Ian Lynagh's avatar
Ian Lynagh committed
45
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
46
        HscTarget(..), isObjectTarget, defaultObjectTarget,
47
        targetRetainsAllBindings,
Ian Lynagh's avatar
Ian Lynagh committed
48 49
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
50
        PackageFlag(..), PackageArg(..), ModRenaming(..),
51
        packageFlagsChanged,
52
        IgnorePackageFlag(..), TrustFlag(..),
53
        PackageDBFlag(..), 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,
Rufflewind's avatar
Rufflewind committed
61
        shouldUseColor,
62
        positionIndependent,
63

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

67 68
        thisPackage, thisComponentId, thisUnitIdInsts,

Ben Gamari's avatar
Ben Gamari committed
69 70 71
        -- ** Log output
        putLogMsg,

72
        -- ** Safe Haskell
73
        SafeHaskellMode(..),
74
        safeHaskellOn, safeImportsOn, safeLanguageOn, safeInferOn,
75
        packageTrustOn,
76
        safeDirectImpsReq, safeImplicitImpsReq,
77
        unsafeFlags, unsafeFlagsForInfer,
78

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


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

104
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
105
        getVerbFlags,
Ian Lynagh's avatar
Ian Lynagh committed
106 107
        updOptLevel,
        setTmpDir,
108
        setUnitId,
Edsko de Vries's avatar
Edsko de Vries committed
109
        interpretPackageEnv,
Edward Z. Yang's avatar
Edward Z. Yang committed
110
        canonicalizeHomeModule,
Ian Lynagh's avatar
Ian Lynagh committed
111

112
        -- ** Parsing DynFlags
113 114
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
115 116 117
        parseDynamicFlagsFull,

        -- ** Available DynFlags
118
        allNonDeprecatedFlags,
119 120 121
        flagsAll,
        flagsDynamic,
        flagsPackage,
122
        flagsForCompletion,
123

124
        supportedLanguagesAndExtensions,
125
        languageExtensions,
126

127
        -- ** DynFlags C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
128
        picCCOpts, picPOpts,
129 130

        -- * Compiler configuration suitable for display to the user
131 132 133
        compilerInfo,

        rtsIsProfiled,
134
        dynamicGhc,
135

136
#include "GHCConstantsHaskellExports.hs"
137
        bLOCK_SIZE_W,
138
        wORD_SIZE_IN_BITS,
139 140
        tAG_MASK,
        mAX_PTR_TAG,
141
        tARGET_MIN_INT, tARGET_MAX_INT, tARGET_MAX_WORD,
142

143 144
        unsafeGlobalDynFlags, setUnsafeGlobalDynFlags,

145
        -- * SSE and AVX
146
        isSseEnabled,
147 148
        isSse2Enabled,
        isSse4_2Enabled,
149 150
        isAvxEnabled,
        isAvx2Enabled,
151 152 153 154
        isAvx512cdEnabled,
        isAvx512erEnabled,
        isAvx512fEnabled,
        isAvx512pfEnabled,
155

Austin Seipp's avatar
Austin Seipp committed
156
        -- * Linker/compiler information
157
        LinkerInfo(..),
Austin Seipp's avatar
Austin Seipp committed
158
        CompilerInfo(..),
Douglas Wilson's avatar
Douglas Wilson committed
159 160 161

        -- * File cleanup
        FilesToClean(..), emptyFilesToClean
162 163 164 165
  ) where

#include "HsVersions.h"

166
import Platform
167
import PlatformConstants
168
import Module
Simon Marlow's avatar
Simon Marlow committed
169
import PackageConfig
170
import {-# SOURCE #-} Hooks
171
import {-# SOURCE #-} PrelNames ( mAIN )
172
import {-# SOURCE #-} Packages (PackageState, emptyPackageState)
Ian Lynagh's avatar
Ian Lynagh committed
173
import DriverPhases     ( Phase(..), phaseInputExt )
174
import Config
175 176
import CmdLineParser hiding (WarnReason(..))
import qualified CmdLineParser as Cmd
177
import Constants
178
import Panic
Rufflewind's avatar
Rufflewind committed
179
import qualified PprColour as Col
180
import Util
Edsko de Vries's avatar
Edsko de Vries committed
181
import Maybes
182
import MonadUtils
183
import qualified Pretty
184
import SrcLoc
185
import BasicTypes       ( IntWithInf, treatZeroAsInf )
186
import FastString
Simon Marlow's avatar
Simon Marlow committed
187
import Outputable
Ian Lynagh's avatar
Ian Lynagh committed
188
import Foreign.C        ( CInt(..) )
189
import System.IO.Unsafe ( unsafeDupablePerformIO )
Rufflewind's avatar
Rufflewind committed
190
import {-# SOURCE #-} ErrUtils ( Severity(..), MsgDoc, mkLocMessageAnn
191 192
                               , getCaretDiagnostic, dumpSDoc )
import Json
193
import SysTools.Terminal ( stderrSupportsAnsiColors )
194

195
import System.IO.Unsafe ( unsafePerformIO )
196
import Data.IORef
197
import Control.Arrow ((&&&))
ian@well-typed.com's avatar
ian@well-typed.com committed
198
import Control.Monad
199 200 201 202
import Control.Monad.Trans.Class
import Control.Monad.Trans.Writer
import Control.Monad.Trans.Reader
import Control.Monad.Trans.Except
203
import Control.Exception (throwIO)
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
204

205
import Data.Ord
206
import Data.Bits
207
import Data.Char
208
import Data.Int
209
import Data.List
210 211
import Data.Map (Map)
import qualified Data.Map as Map
212 213
import Data.Set (Set)
import qualified Data.Set as Set
214
import Data.Word
Ian Lynagh's avatar
Ian Lynagh committed
215
import System.FilePath
Edsko de Vries's avatar
Edsko de Vries committed
216
import System.Directory
Rufflewind's avatar
Rufflewind committed
217
import System.Environment (getEnv, lookupEnv)
218
import System.IO
219
import System.IO.Error
220 221
import Text.ParserCombinators.ReadP hiding (char)
import Text.ParserCombinators.ReadP as R
222

223 224
import EnumSet (EnumSet)
import qualified EnumSet
225

226
import GHC.Foreign (withCString, peekCString)
227
import qualified GHC.LanguageExtensions as LangExt
228

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

231 232 233 234
-- Note [Updating flag description in the User's Guide]
-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--
-- If you modify anything in this file please make sure that your changes are
Ben Gamari's avatar
Ben Gamari committed
235 236
-- described in the User's Guide. Please update the flag description in the
-- users guide (docs/users_guide) whenever you add or change a flag.
237

238 239 240 241 242 243 244 245 246 247 248 249
-- 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.

250 251 252 253 254 255 256
-- Note [Adding a language extension]
-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--
-- There are a few steps to adding (or removing) a language extension,
--
--  * Adding the extension to GHC.LanguageExtensions
--
257 258
--    The Extension type in libraries/ghc-boot-th/GHC/LanguageExtensions/Type.hs
--    is the canonical list of language extensions known by GHC.
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 299 300 301 302
--
--  * 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.

303 304 305
-- -----------------------------------------------------------------------------
-- DynFlags

306
data DumpFlag
307
-- See Note [Updating flag description in the User's Guide]
308 309 310

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

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

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

Ian Lynagh's avatar
Ian Lynagh committed
409
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
410
   | Opt_ShowWarnGroups                 -- Show the group a warning belongs to
411
   | Opt_HideSourcePaths                -- Hide module source/object paths
412

413
   | Opt_PrintExplicitForalls
unknown's avatar
unknown committed
414
   | Opt_PrintExplicitKinds
415
   | Opt_PrintExplicitCoercions
416
   | Opt_PrintExplicitRuntimeReps
417
   | Opt_PrintEqualityRelations
418
   | Opt_PrintUnicodeSyntax
419
   | Opt_PrintExpandedSynonyms
420
   | Opt_PrintPotentialInstances
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
421
   | Opt_PrintTypecheckerElaboration
422

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

470 471 472 473
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings
474
   | Opt_WriteInterface -- forces .hi files to be written even with -fno-code
475

Ian Lynagh's avatar
Ian Lynagh committed
476 477
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
478
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
479

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

527 528 529 530
   -- PreInlining is on by default. The option is there just to see how
   -- bad things get if you turn it off!
   | Opt_SimplPreInlining

531
   -- output style opts
532 533
   | Opt_ErrorSpans -- Include full span info in error messages,
                    -- instead of just the start position.
Rufflewind's avatar
Rufflewind committed
534
   | Opt_DiagnosticsShowCaret -- Show snippets of offending code
535
   | Opt_PprCaseAsLet
Peter Wortmann's avatar
Peter Wortmann committed
536
   | Opt_PprShowTicks
537
   | Opt_ShowHoleConstraints
538

539 540 541 542 543 544 545 546 547 548 549
   -- 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
550 551
   | Opt_SuppressUnfoldings
   -- Suppress the details of even stable unfoldings
552 553 554 555 556
   | Opt_SuppressTypeSignatures
   -- Suppress unique ids on variables.
   -- Except for uniques, as some simplifier phases introduce new
   -- variables that have otherwise identical names.
   | Opt_SuppressUniques
557
   | Opt_SuppressTicks     -- Replaces Opt_PprShowTicks
558

559
   -- temporary flags
560
   | Opt_AutoLinkPackages
561
   | Opt_ImplicitImportQualified
562 563 564 565 566 567

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
568
   | Opt_KeepRawTokenStream
569
   | Opt_KeepLlvmFiles
570 571
   | Opt_KeepHiFiles
   | Opt_KeepOFiles
572

573 574
   | Opt_BuildDynamicToo

575
   -- safe haskell flags
dterei's avatar
dterei committed
576
   | Opt_DistrustAllPackages
577
   | Opt_PackageTrust
Sylvain Henry's avatar
Sylvain Henry committed
578 579 580

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

583 584 585
-- | 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.
586 587 588 589 590 591
data WarnReason
  = NoReason
  -- | Warning was enabled with the flag
  | Reason !WarningFlag
  -- | Warning was made an error because of -Werror or -Werror=WarningFlag
  | ErrReason !(Maybe WarningFlag)
Richard Eisenberg's avatar
Richard Eisenberg committed
592 593 594 595
  deriving Show

instance Outputable WarnReason where
  ppr = text . show
596

597 598 599
instance ToJson WarnReason where
  json NoReason = JSNull
  json (Reason wf) = JSString (show wf)
600 601
  json (ErrReason Nothing) = JSString "Opt_WarnIsError"
  json (ErrReason (Just wf)) = JSString (show wf)
602

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

673
data Language = Haskell98 | Haskell2010
Oleg Grenrus's avatar
Oleg Grenrus committed
674 675 676 677
   deriving (Eq, Enum, Show)

instance Outputable Language where
    ppr = text . show
678

679
-- | The various Safe Haskell modes
680 681
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
682
   | Sf_Unsafe
683 684 685 686
   | Sf_Trustworthy
   | Sf_Safe
   deriving (Eq)

Ian Lynagh's avatar
Ian Lynagh committed
687
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
688 689 690 691
    show Sf_None         = "None"
    show Sf_Unsafe       = "Unsafe"
    show Sf_Trustworthy  = "Trustworthy"
    show Sf_Safe         = "Safe"
Ian Lynagh's avatar
Ian Lynagh committed
692

693
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
694
    ppr = text . show
695

696
-- | Contains not only a collection of 'GeneralFlag's but also a plethora of
697
-- information relating to the compilation of a single file or GHC session
698
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
699 700 701
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
702
  settings              :: Settings,
703
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
704
  optLevel              :: Int,         -- ^ Optimisation level
705
  debugLevel            :: Int,         -- ^ How much debug information to produce
706 707
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
708
  maxPmCheckIterations  :: Int,         -- ^ Max no iterations for pm checking
Ian Lynagh's avatar
Ian Lynagh committed
709
  ruleCheck             :: Maybe String,
710
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
711

712 713
  parMakeCount          :: Maybe Int,   -- ^ The number of modules to compile in parallel
                                        --   in --make mode, where Nothing ==> compile as