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(..),
158 159 160 161
  ) where

#include "HsVersions.h"

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

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

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

218 219
import EnumSet (EnumSet)
import qualified EnumSet
220

221
import GHC.Foreign (withCString, peekCString)
222
import qualified GHC.LanguageExtensions as LangExt
223

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

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

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

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

304 305 306
-- -----------------------------------------------------------------------------
-- DynFlags

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

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

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

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

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

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

424
   -- optimisation opts
425
   | Opt_CallArity
426
   | Opt_Strictness
427
   | Opt_LateDmdAnal
428 429
   | Opt_KillAbsence
   | Opt_KillOneShot
430
   | Opt_FullLaziness
431 432
   | Opt_FloatIn
   | Opt_Specialise
433
   | Opt_SpecialiseAggressively
434
   | Opt_CrossModuleSpecialise
435
   | Opt_StaticArgumentTransformation
436
   | Opt_CSE
437
   | Opt_StgCSE
438 439
   | Opt_LiberateCase
   | Opt_SpecConstr
Simon Peyton Jones's avatar
Simon Peyton Jones committed
440
   | Opt_SpecConstrKeen
441 442 443 444
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
Sylvain Henry's avatar
Sylvain Henry committed
445
   | Opt_CaseFolding                    -- Constant folding through case-expressions
446
   | Opt_UnboxStrictFields
447
   | Opt_UnboxSmallStrictFields
448
   | Opt_DictsCheap
449
   | Opt_EnableRewriteRules             -- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
450
   | Opt_Vectorise
451
   | Opt_VectorisationAvoidance
Ian Lynagh's avatar
Ian Lynagh committed
452 453
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
454
   | Opt_PedanticBottoms                -- Be picky about how we treat bottom
455
   | Opt_LlvmTBAA                       -- Use LLVM TBAA infastructure for improving AA (hidden flag)
456
   | Opt_LlvmPassVectorsInRegisters     -- Pass SIMD vectors in registers (requires a patched LLVM) (hidden flag)
457
   | Opt_LlvmFillUndefWithGarbage       -- Testing for undef bugs (hidden flag)
458
   | Opt_IrrefutableTuples
459
   | Opt_CmmSink
460
   | Opt_CmmElimCommonBlocks
461
   | Opt_OmitYields
462
   | Opt_FunToThunk               -- allow WwLib.mkWorkerArgs to remove all value lambdas
463 464
   | Opt_DictsStrict                     -- be strict in argument dictionaries
   | Opt_DmdTxDictSel              -- use a special demand transformer for dictionary selectors
465
   | Opt_Loopification                  -- See Note [Self-recursive tail calls]
466
   | Opt_CprAnal
467
   | Opt_WorkerWrapper
468
   | Opt_SolveConstantDicts
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
Ian Lynagh's avatar
Ian Lynagh committed
510
   | Opt_PIC
511
   | Opt_SccProfilingOn
ian@well-typed.com's avatar
ian@well-typed.com committed
512
   | Opt_Ticky
nfrisby's avatar
nfrisby committed
513 514 515
   | Opt_Ticky_Allocd
   | Opt_Ticky_LNE
   | Opt_Ticky_Dyn_Thunk
516
   | Opt_RPath
517
   | Opt_RelativeDynlibPaths
ian@well-typed.com's avatar
ian@well-typed.com committed
518
   | Opt_Hpc
519
   | Opt_FlatCache
520
   | Opt_ExternalInterpreter
Simon Marlow's avatar
Simon Marlow committed
521
   | Opt_OptimalApplicativeDo
522
   | Opt_VersionMacros
Simon Marlow's avatar
Simon Marlow committed
523
   | Opt_WholeArchiveHsLibs
524

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

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

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

557
   -- temporary flags
558
   | Opt_AutoLinkPackages
559
   | Opt_ImplicitImportQualified
560 561 562 563 564 565

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

571 572
   | Opt_BuildDynamicToo

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

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

581 582 583 584
-- | 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
585 586 587 588
  deriving Show

instance Outputable WarnReason where
  ppr = text . show
589

590 591 592 593
instance ToJson WarnReason where
  json NoReason = JSNull
  json (Reason wf) = JSString (show wf)

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

664
data Language = Haskell98 | Haskell2010
Oleg Grenrus's avatar
Oleg Grenrus committed
665 666 667 668
   deriving (Eq, Enum, Show)

instance Outputable Language where
    ppr = text . show
669

670
-- | The various Safe Haskell modes
671 672
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
673
   | Sf_Unsafe
674 675 676 677
   | Sf_Trustworthy
   | Sf_Safe
   deriving (Eq)

Ian Lynagh's avatar
Ian Lynagh committed
678
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
679 680 681 682
    show Sf_None         = "None"
    show Sf_Unsafe       = "Unsafe"
    show Sf_Trustworthy  = "Trustworthy"
    show Sf_Safe         = "Safe"
Ian Lynagh's avatar
Ian Lynagh committed
683

684
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
685
    ppr = text . show
686

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

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

707 708 709
  enableTimeStats       :: Bool,        -- ^ Enable RTS timing statistics?
  ghcHeapSize           :: Maybe Int,   -- ^ The heap size to set.

710 711
  maxRelevantBinds      :: Maybe Int,   -- ^ Maximum number of bindings from the type envt
                                        --   to show in type error messages
712 713
  maxValidSubstitutions :: Maybe Int,   -- ^ Maximum number of substitutions
                                        --   to show in type error messages
714 715
  maxUncoveredPatterns  :: Int,         -- ^ Maximum number of unmatched patterns to show
                                        --   in non-exhaustiveness warnings
dterei's avatar