DynFlags.hs 222 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

Moritz Angermann's avatar
Moritz Angermann committed
79 80 81
        -- ** LLVM Targets
        LlvmTarget(..), LlvmTargets,

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

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

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

115
        -- ** Parsing DynFlags
116 117
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
118 119 120
        parseDynamicFlagsFull,

        -- ** Available DynFlags
121
        allNonDeprecatedFlags,
122 123 124
        flagsAll,
        flagsDynamic,
        flagsPackage,
125
        flagsForCompletion,
126

127
        supportedLanguagesAndExtensions,
128
        languageExtensions,
129

130
        -- ** DynFlags C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
131
        picCCOpts, picPOpts,
132 133

        -- * Compiler configuration suitable for display to the user
134 135 136
        compilerInfo,

        rtsIsProfiled,
137
        dynamicGhc,
138

139
#include "GHCConstantsHaskellExports.hs"
140
        bLOCK_SIZE_W,
141
        wORD_SIZE_IN_BITS,
142 143
        tAG_MASK,
        mAX_PTR_TAG,
144
        tARGET_MIN_INT, tARGET_MAX_INT, tARGET_MAX_WORD,
145

146 147
        unsafeGlobalDynFlags, setUnsafeGlobalDynFlags,

148
        -- * SSE and AVX
149
        isSseEnabled,
150 151
        isSse2Enabled,
        isSse4_2Enabled,
152 153
        isAvxEnabled,
        isAvx2Enabled,
154 155 156 157
        isAvx512cdEnabled,
        isAvx512erEnabled,
        isAvx512fEnabled,
        isAvx512pfEnabled,
158

Austin Seipp's avatar
Austin Seipp committed
159
        -- * Linker/compiler information
160
        LinkerInfo(..),
Austin Seipp's avatar
Austin Seipp committed
161
        CompilerInfo(..),
Douglas Wilson's avatar
Douglas Wilson committed
162 163 164

        -- * File cleanup
        FilesToClean(..), emptyFilesToClean
165 166 167 168
  ) where

#include "HsVersions.h"

169 170
import GhcPrelude

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

200
import System.IO.Unsafe ( unsafePerformIO )
201
import Data.IORef
202
import Control.Arrow ((&&&))
ian@well-typed.com's avatar
ian@well-typed.com committed
203
import Control.Monad
204 205 206 207
import Control.Monad.Trans.Class
import Control.Monad.Trans.Writer
import Control.Monad.Trans.Reader
import Control.Monad.Trans.Except
208
import Control.Exception (throwIO)
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
209

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

228 229
import EnumSet (EnumSet)
import qualified EnumSet
230

231
import GHC.Foreign (withCString, peekCString)
232
import qualified GHC.LanguageExtensions as LangExt
233

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

236 237 238 239
-- 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
240 241
-- 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.
242

243 244 245 246 247 248 249 250 251 252 253 254
-- 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.

255 256 257 258 259 260 261
-- Note [Adding a language extension]
-- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
--
-- There are a few steps to adding (or removing) a language extension,
--
--  * Adding the extension to GHC.LanguageExtensions
--
262 263
--    The Extension type in libraries/ghc-boot-th/GHC/LanguageExtensions/Type.hs
--    is the canonical list of language extensions known by GHC.
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 303 304 305 306 307
--
--  * 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.

308 309 310
-- -----------------------------------------------------------------------------
-- DynFlags

311
data DumpFlag
312
-- See Note [Updating flag description in the User's Guide]
313 314 315

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

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

   = Opt_DumpToFile                     -- ^ Append dump output to files instead of stdout.
406
   | Opt_D_faststring_stats
407
   | Opt_D_dump_minimal_imports
408 409 410
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
411
   | Opt_DoAsmLinting
Peter Wortmann's avatar
Peter Wortmann committed
412
   | Opt_DoAnnotationLinting
413
   | Opt_NoLlvmMangler                 -- hidden flag
Moritz Angermann's avatar
Moritz Angermann committed
414
   | Opt_FastLlvm                      -- hidden flag
415

Ian Lynagh's avatar
Ian Lynagh committed
416
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
417
   | Opt_ShowWarnGroups                 -- Show the group a warning belongs to
418
   | Opt_HideSourcePaths                -- Hide module source/object paths
419

420
   | Opt_PrintExplicitForalls
unknown's avatar
unknown committed
421
   | Opt_PrintExplicitKinds
422
   | Opt_PrintExplicitCoercions
423
   | Opt_PrintExplicitRuntimeReps
424
   | Opt_PrintEqualityRelations
425
   | Opt_PrintUnicodeSyntax
426
   | Opt_PrintExpandedSynonyms
427
   | Opt_PrintPotentialInstances
eir@cis.upenn.edu's avatar
eir@cis.upenn.edu committed
428
   | Opt_PrintTypecheckerElaboration
429

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

479 480 481 482
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings
483
   | Opt_WriteInterface -- forces .hi files to be written even with -fno-code
484

Ian Lynagh's avatar
Ian Lynagh committed
485 486
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
487
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
488

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

536 537 538 539
   -- PreInlining is on by default. The option is there just to see how
   -- bad things get if you turn it off!
   | Opt_SimplPreInlining

540
   -- output style opts
541 542
   | Opt_ErrorSpans -- Include full span info in error messages,
                    -- instead of just the start position.
Rufflewind's avatar
Rufflewind committed
543
   | Opt_DiagnosticsShowCaret -- Show snippets of offending code
544
   | Opt_PprCaseAsLet
Peter Wortmann's avatar
Peter Wortmann committed
545
   | Opt_PprShowTicks
546
   | Opt_ShowHoleConstraints
547

548 549 550 551 552 553 554 555 556 557 558
   -- 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
559 560
   | Opt_SuppressUnfoldings
   -- Suppress the details of even stable unfoldings
561 562 563 564 565
   | Opt_SuppressTypeSignatures
   -- Suppress unique ids on variables.
   -- Except for uniques, as some simplifier phases introduce new
   -- variables that have otherwise identical names.
   | Opt_SuppressUniques
566
   | Opt_SuppressTicks     -- Replaces Opt_PprShowTicks
567

568
   -- temporary flags
569
   | Opt_AutoLinkPackages
570
   | Opt_ImplicitImportQualified
571 572 573 574 575 576

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
577
   | Opt_KeepRawTokenStream
578
   | Opt_KeepLlvmFiles
579 580
   | Opt_KeepHiFiles
   | Opt_KeepOFiles
581

582 583
   | Opt_BuildDynamicToo

584
   -- safe haskell flags
dterei's avatar
dterei committed
585
   | Opt_DistrustAllPackages
586
   | Opt_PackageTrust
Sylvain Henry's avatar
Sylvain Henry committed
587 588 589

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

592 593 594
-- | 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.
595 596 597 598 599 600
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
601 602 603 604
  deriving Show

instance Outputable WarnReason where
  ppr = text . show
605

606 607 608
instance ToJson WarnReason where
  json NoReason = JSNull
  json (Reason wf) = JSString (show wf)
609 610
  json (ErrReason Nothing) = JSString "Opt_WarnIsError"
  json (ErrReason (Just wf)) = JSString (show wf)
611

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

683
data Language = Haskell98 | Haskell2010
Oleg Grenrus's avatar
Oleg Grenrus committed
684 685 686 687
   deriving (Eq, Enum, Show)

instance Outputable Language where
    ppr = text . show
688

689
-- | The various Safe Haskell modes
690 691
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
692
   | Sf_Unsafe
693 694 695 696
   | Sf_Trustworthy
   | Sf_Safe
   deriving (Eq)

Ian Lynagh's avatar
Ian Lynagh committed
697
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
698 699 700 701
    show Sf_None         = "None"
    show Sf_Unsafe       = "Unsafe"
    show Sf_Trustworthy  = "Trustworthy"
    show Sf_Safe         = "Safe"
Ian Lynagh's avatar
Ian Lynagh committed
702

703
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
704
    ppr = text . show
705

706
-- | Contains not only a collection of 'GeneralFlag's but also a plethora of
707
-- information relating to the compilation of a single file or GHC session
708
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
709 710 711
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
712
  settings              :: Settings,
Moritz Angermann's avatar
Moritz Angermann committed
713
  llvmTargets           :: LlvmTargets,