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

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

66 67
        thisPackage, thisComponentId, thisUnitIdInsts,

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

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

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


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

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

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

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

123
        supportedLanguagesAndExtensions,
124
        languageExtensions,
125

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

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

        rtsIsProfiled,
133
        dynamicGhc,
134

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

142 143
        unsafeGlobalDynFlags, setUnsafeGlobalDynFlags,

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

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

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

#include "HsVersions.h"

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

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

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

222 223
import EnumSet (EnumSet)
import qualified EnumSet
224

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

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

230 231 232 233 234 235 236
-- 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:
--
237 238
--  * Flag Reference section generated from the modules in
--    utils/mkUserGuidePart/Options
239
--
240
--  * Flag description in docs/users_guide/using.rst provides a detailed
241 242
--    explanation of flags' usage.

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_stranal
manav's avatar
manav committed
364
   | Opt_D_dump_str_signatures
365
   | Opt_D_dump_tc
366
   | Opt_D_dump_tc_ast
367 368 369 370 371 372 373 374
   | 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
375
   | Opt_D_dump_cs_trace -- Constraint solver in type checker
376
   | Opt_D_dump_tc_trace
377
   | Opt_D_dump_ec_trace -- Pattern match exhaustiveness checker
378
   | Opt_D_dump_if_trace
379
   | Opt_D_dump_vt_trace
380
   | Opt_D_dump_splices
381
   | Opt_D_th_dec_file
382 383
   | Opt_D_dump_BCOs
   | Opt_D_dump_vect
384
   | Opt_D_dump_ticked
pepe's avatar
pepe committed
385
   | Opt_D_dump_rtti
386 387 388 389
   | Opt_D_source_stats
   | Opt_D_verbose_stg2stg
   | Opt_D_dump_hi
   | Opt_D_dump_hi_diffs
390
   | Opt_D_dump_mod_cycles
391
   | Opt_D_dump_mod_map
392
   | Opt_D_dump_view_pattern_commoning
393
   | Opt_D_verbose_core2core
394
   | Opt_D_dump_debug
395
   | Opt_D_dump_json
Sylvain Henry's avatar
Sylvain Henry committed
396 397
   | Opt_D_ppr_debug
   | Opt_D_no_debug_output
398 399 400 401
   deriving (Eq, Show, Enum)

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

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

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

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

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

475 476 477 478
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings
479
   | Opt_WriteInterface -- forces .hi files to be written even with -fno-code
480

Ian Lynagh's avatar
Ian Lynagh committed
481 482
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
483
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
484

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

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

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

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

562
   -- temporary flags
563
   | Opt_AutoLinkPackages
564
   | Opt_ImplicitImportQualified
565 566 567 568 569 570

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
571
   | Opt_KeepRawTokenStream
572
   | Opt_KeepLlvmFiles
573 574
   | Opt_KeepHiFiles
   | Opt_KeepOFiles
575

576 577
   | Opt_BuildDynamicToo

578
   -- safe haskell flags
dterei's avatar
dterei committed
579
   | Opt_DistrustAllPackages
580
   | Opt_PackageTrust
Sylvain Henry's avatar
Sylvain Henry committed
581 582 583

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

586 587 588
-- | 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.
589 590 591 592 593 594
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
595 596 597 598
  deriving Show

instance Outputable WarnReason where
  ppr = text . show
599

600 601 602
instance ToJson WarnReason where
  json NoReason = JSNull
  json (Reason wf) = JSString (show wf)
603 604
  json (ErrReason Nothing) = JSString "Opt_WarnIsError"
  json (ErrReason (Just wf)) = JSString (show wf)
605

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

676
data Language = Haskell98 | Haskell2010
Oleg Grenrus's avatar
Oleg Grenrus committed
677 678 679 680
   deriving (Eq, Enum, Show)

instance Outputable Language where
    ppr = text . show
681

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

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

696
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
697
    ppr = text . show
698

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