DynFlags.hs 172 KB
Newer Older
1 2
{-# LANGUAGE CPP #-}

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

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

19
module DynFlags (
20
        -- * Dynamic flags and associated configuration types
21
        DumpFlag(..),
22
        GeneralFlag(..),
23
        WarningFlag(..),
24
        ExtensionFlag(..),
25
        Language(..),
26
        PlatformConstants(..),
Ian Lynagh's avatar
Ian Lynagh committed
27
        FatalMessager, LogAction, FlushOut(..), FlushErr(..),
28
        ProfAuto(..),
29
        glasgowExtsFlags,
30
        dopt, dopt_set, dopt_unset,
31 32 33
        gopt, gopt_set, gopt_unset,
        wopt, wopt_set, wopt_unset,
        xopt, xopt_set, xopt_unset,
34
        lang_set,
35
        useUnicodeSyntax,
36 37
        whenGeneratingDynamicToo, ifGeneratingDynamicToo,
        whenCannotGenerateDynamicToo,
38
        dynamicTooMkDynamicDynFlags,
Ian Lynagh's avatar
Ian Lynagh committed
39
        DynFlags(..),
40
        FlagSpec(..),
Ian Lynagh's avatar
Ian Lynagh committed
41
        HasDynFlags(..), ContainsDynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
42
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
43
        HscTarget(..), isObjectTarget, defaultObjectTarget,
44
        targetRetainsAllBindings,
Ian Lynagh's avatar
Ian Lynagh committed
45 46
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
47
        PackageFlag(..), PackageArg(..), ModRenaming(..),
48
        PkgConfRef(..),
Ian Lynagh's avatar
Ian Lynagh committed
49
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
50
        DynLibLoader(..),
51
        fFlags, fWarningFlags, fLangFlags, xFlags,
52
        dynFlagDependencies,
53
        tablesNextToCode, mkTablesNextToCode,
Edward Z. Yang's avatar
Edward Z. Yang committed
54
        SigOf, getSigOf,
55

56
        Way(..), mkBuildTag, wayRTSOnly, addWay', updateWays,
57
        wayGeneralFlags, wayUnsetGeneralFlags,
ian@well-typed.com's avatar
ian@well-typed.com committed
58

59
        -- ** Safe Haskell
60
        SafeHaskellMode(..),
61
        safeHaskellOn, safeImportsOn, safeLanguageOn, safeInferOn,
62
        packageTrustOn,
63
        safeDirectImpsReq, safeImplicitImpsReq,
64
        unsafeFlags, unsafeFlagsForInfer,
65

66
        -- ** System tool settings and locations
67
        Settings(..),
68
        targetPlatform, programName, projectVersion,
69
        ghcUsagePath, ghciUsagePath, topDir, tmpDir, rawSettings,
Edsko de Vries's avatar
Edsko de Vries committed
70
        versionedAppDir,
71 72
        extraGccViaCFlags, systemPackageConfig,
        pgm_L, pgm_P, pgm_F, pgm_c, pgm_s, pgm_a, pgm_l, pgm_dll, pgm_T,
73
        pgm_sysman, pgm_windres, pgm_libtool, pgm_lo, pgm_lc,
Ian Lynagh's avatar
Ian Lynagh committed
74
        opt_L, opt_P, opt_F, opt_c, opt_a, opt_l,
75
        opt_windres, opt_lo, opt_lc,
76 77


78
        -- ** Manipulating DynFlags
79
        defaultDynFlags,                -- Settings -> DynFlags
80
        defaultWays,
ian@well-typed.com's avatar
ian@well-typed.com committed
81
        interpWays,
Ian Lynagh's avatar
Ian Lynagh committed
82
        initDynFlags,                   -- DynFlags -> IO DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
83
        defaultFatalMessager,
84
        defaultLogAction,
85
        defaultLogActionHPrintDoc,
86
        defaultLogActionHPutStrDoc,
87 88
        defaultFlushOut,
        defaultFlushErr,
Ian Lynagh's avatar
Ian Lynagh committed
89

90
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
91
        getVerbFlags,
Ian Lynagh's avatar
Ian Lynagh committed
92 93
        updOptLevel,
        setTmpDir,
94
        setPackageKey,
Edsko de Vries's avatar
Edsko de Vries committed
95
        interpretPackageEnv,
Ian Lynagh's avatar
Ian Lynagh committed
96

97
        -- ** Parsing DynFlags
98 99
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
100 101 102
        parseDynamicFlagsFull,

        -- ** Available DynFlags
103
        allFlags,
104 105 106
        flagsAll,
        flagsDynamic,
        flagsPackage,
107
        flagsForCompletion,
108

109
        supportedLanguagesAndExtensions,
110
        languageExtensions,
111

112
        -- ** DynFlags C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
113
        picCCOpts, picPOpts,
114 115 116 117 118 119

        -- * Configuration of the stg-to-stg passes
        StgToDo(..),
        getStgToDo,

        -- * Compiler configuration suitable for display to the user
120 121
        compilerInfo,

122
#ifdef GHCI
123
        rtsIsProfiled,
124
#endif
125
        dynamicGhc,
126 127

#include "../includes/dist-derivedconstants/header/GHCConstantsHaskellExports.hs"
128
        bLOCK_SIZE_W,
129
        wORD_SIZE_IN_BITS,
130 131
        tAG_MASK,
        mAX_PTR_TAG,
132
        tARGET_MIN_INT, tARGET_MAX_INT, tARGET_MAX_WORD,
133

134 135
        unsafeGlobalDynFlags, setUnsafeGlobalDynFlags,

136
        -- * SSE and AVX
137
        isSseEnabled,
138 139
        isSse2Enabled,
        isSse4_2Enabled,
140 141
        isAvxEnabled,
        isAvx2Enabled,
142 143 144 145
        isAvx512cdEnabled,
        isAvx512erEnabled,
        isAvx512fEnabled,
        isAvx512pfEnabled,
146

Austin Seipp's avatar
Austin Seipp committed
147
        -- * Linker/compiler information
148
        LinkerInfo(..),
Austin Seipp's avatar
Austin Seipp committed
149
        CompilerInfo(..),
150 151 152 153
  ) where

#include "HsVersions.h"

154
import Platform
155
import PlatformConstants
156
import Module
Simon Marlow's avatar
Simon Marlow committed
157
import PackageConfig
158
import {-# SOURCE #-} Hooks
159
import {-# SOURCE #-} PrelNames ( mAIN )
160
import {-# SOURCE #-} Packages (PackageState, emptyPackageState)
Ian Lynagh's avatar
Ian Lynagh committed
161
import DriverPhases     ( Phase(..), phaseInputExt )
162 163
import Config
import CmdLineParser
164
import Constants
165
import Panic
166
import Util
Edsko de Vries's avatar
Edsko de Vries committed
167
import Maybes
168
import MonadUtils
169
import qualified Pretty
170
import SrcLoc
171
import BasicTypes       ( IntWithInf, treatZeroAsInf )
172
import FastString
Simon Marlow's avatar
Simon Marlow committed
173
import Outputable
Ian Lynagh's avatar
Ian Lynagh committed
174
#ifdef GHCI
Ian Lynagh's avatar
Ian Lynagh committed
175
import Foreign.C        ( CInt(..) )
176
import System.IO.Unsafe ( unsafeDupablePerformIO )
Ian Lynagh's avatar
Ian Lynagh committed
177
#endif
178
import {-# SOURCE #-} ErrUtils ( Severity(..), MsgDoc, mkLocMessage )
179

180
import System.IO.Unsafe ( unsafePerformIO )
181
import Data.IORef
182
import Control.Arrow ((&&&))
ian@well-typed.com's avatar
ian@well-typed.com committed
183
import Control.Monad
Edsko de Vries's avatar
Edsko de Vries committed
184
import Control.Exception (throwIO)
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
185

186
import Data.Bits
187
import Data.Char
188
import Data.Int
189
import Data.List
190 191
import Data.Map (Map)
import qualified Data.Map as Map
192 193
import Data.Set (Set)
import qualified Data.Set as Set
194
import Data.Word
Ian Lynagh's avatar
Ian Lynagh committed
195
import System.FilePath
Edsko de Vries's avatar
Edsko de Vries committed
196 197
import System.Directory
import System.Environment (getEnv)
198
import System.IO
199
import System.IO.Error
200 201
import Text.ParserCombinators.ReadP hiding (char)
import Text.ParserCombinators.ReadP as R
202

203 204 205
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

206 207
import GHC.Foreign (withCString, peekCString)

208 209 210 211 212 213 214 215 216 217 218 219 220
-- 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:
--
--  * Flag Reference section in docs/users-guide/flags.xml lists all available
--    flags together with a short description
--
--  * Flag description in docs/users_guide/using.xml provides a detailed
--    explanation of flags' usage.

221 222 223 224 225 226 227 228 229 230 231 232
-- 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.

233 234 235
-- -----------------------------------------------------------------------------
-- DynFlags

236
data DumpFlag
237
-- See Note [Updating flag description in the User's Guide]
238 239 240

   -- debugging flags
   = Opt_D_dump_cmm
241 242 243 244 245
   | Opt_D_dump_cmm_raw
   -- All of the cmm subflags (there are a lot!)  Automatically
   -- enabled if you run -ddump-cmm
   | Opt_D_dump_cmm_cfg
   | Opt_D_dump_cmm_cbe
246
   | Opt_D_dump_cmm_switch
247
   | Opt_D_dump_cmm_proc
248
   | Opt_D_dump_cmm_sink
249 250 251 252 253 254
   | Opt_D_dump_cmm_sp
   | Opt_D_dump_cmm_procmap
   | Opt_D_dump_cmm_split
   | Opt_D_dump_cmm_info
   | Opt_D_dump_cmm_cps
   -- end cmm subflags
255
   | Opt_D_dump_asm
256 257 258 259 260
   | 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
261
   | Opt_D_dump_asm_stats
262
   | Opt_D_dump_asm_expanded
263
   | Opt_D_dump_llvm
264
   | Opt_D_dump_core_stats
265 266 267 268
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
269
   | Opt_D_dump_rule_firings
270
   | Opt_D_dump_rule_rewrites
271
   | Opt_D_dump_simpl_trace
272 273 274 275 276 277 278 279
   | Opt_D_dump_occur_anal
   | Opt_D_dump_parsed
   | Opt_D_dump_rn
   | Opt_D_dump_simpl
   | Opt_D_dump_simpl_iterations
   | Opt_D_dump_spec
   | Opt_D_dump_prep
   | Opt_D_dump_stg
280
   | Opt_D_dump_call_arity
281
   | Opt_D_dump_stranal
Joachim Breitner's avatar
Joachim Breitner committed
282
   | Opt_D_dump_strsigs
283 284 285 286 287 288 289 290 291
   | Opt_D_dump_tc
   | 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
292
   | Opt_D_dump_cs_trace -- Constraint solver in type checker
293 294
   | Opt_D_dump_tc_trace
   | Opt_D_dump_if_trace
295
   | Opt_D_dump_vt_trace
296
   | Opt_D_dump_splices
297
   | Opt_D_th_dec_file
298 299
   | Opt_D_dump_BCOs
   | Opt_D_dump_vect
300
   | Opt_D_dump_ticked
pepe's avatar
pepe committed
301
   | Opt_D_dump_rtti
302 303 304 305
   | Opt_D_source_stats
   | Opt_D_verbose_stg2stg
   | Opt_D_dump_hi
   | Opt_D_dump_hi_diffs
306
   | Opt_D_dump_mod_cycles
307
   | Opt_D_dump_mod_map
308
   | Opt_D_dump_view_pattern_commoning
309
   | Opt_D_verbose_core2core
310
   | Opt_D_dump_debug
311 312 313 314 315

   deriving (Eq, Show, Enum)

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

   = Opt_DumpToFile                     -- ^ Append dump output to files instead of stdout.
319
   | Opt_D_faststring_stats
320
   | Opt_D_dump_minimal_imports
321 322 323
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
324
   | Opt_DoAsmLinting
Peter Wortmann's avatar
Peter Wortmann committed
325
   | Opt_DoAnnotationLinting
326
   | Opt_NoLlvmMangler                 -- hidden flag
327

Ian Lynagh's avatar
Ian Lynagh committed
328
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
329

330
   | Opt_PrintExplicitForalls
unknown's avatar
unknown committed
331
   | Opt_PrintExplicitKinds
332
   | Opt_PrintUnicodeSyntax
333

334
   -- optimisation opts
335
   | Opt_CallArity
336
   | Opt_Strictness
337
   | Opt_LateDmdAnal
338 339
   | Opt_KillAbsence
   | Opt_KillOneShot
340
   | Opt_FullLaziness
341 342
   | Opt_FloatIn
   | Opt_Specialise
343
   | Opt_SpecialiseAggressively
344
   | Opt_StaticArgumentTransformation
345
   | Opt_CSE
346 347
   | Opt_LiberateCase
   | Opt_SpecConstr
348 349 350 351 352
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
353
   | Opt_UnboxSmallStrictFields
354
   | Opt_DictsCheap
355
   | Opt_EnableRewriteRules             -- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
356
   | Opt_Vectorise
357
   | Opt_VectorisationAvoidance
Ian Lynagh's avatar
Ian Lynagh committed
358 359
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
360
   | Opt_PedanticBottoms                -- Be picky about how we treat bottom
361
   | Opt_LlvmTBAA                       -- Use LLVM TBAA infastructure for improving AA (hidden flag)
362
   | Opt_LlvmPassVectorsInRegisters     -- Pass SIMD vectors in registers (requires a patched LLVM) (hidden flag)
363
   | Opt_IrrefutableTuples
364
   | Opt_CmmSink
365
   | Opt_CmmElimCommonBlocks
366
   | Opt_OmitYields
367
   | Opt_SimpleListLiterals
368
   | Opt_FunToThunk               -- allow WwLib.mkWorkerArgs to remove all value lambdas
369 370
   | Opt_DictsStrict                     -- be strict in argument dictionaries
   | Opt_DmdTxDictSel              -- use a special demand transformer for dictionary selectors
371
   | Opt_Loopification                  -- See Note [Self-recursive tail calls]
372

373 374 375 376
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings
377
   | Opt_WriteInterface -- forces .hi files to be written even with -fno-code
378

Ian Lynagh's avatar
Ian Lynagh committed
379 380
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
381
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
382

383 384
   -- misc opts
   | Opt_Pp
385
   | Opt_ForceRecomp
386
   | Opt_ExcessPrecision
387
   | Opt_EagerBlackHoling
388 389 390
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
391
   | Opt_HideAllPackages
392
   | Opt_PrintBindResult
393
   | Opt_Haddock
David Waern's avatar
David Waern committed
394
   | Opt_HaddockOptions
395
   | Opt_BreakOnException
396
   | Opt_BreakOnError
397
   | Opt_PrintEvldWithShow
398
   | Opt_PrintBindContents
399 400
   | Opt_GenManifest
   | Opt_EmbedManifest
Ian Lynagh's avatar
Ian Lynagh committed
401
   | Opt_SharedImplib
402
   | Opt_BuildingCabalPackage
403
   | Opt_IgnoreDotGhci
404
   | Opt_GhciSandbox
Ian Lynagh's avatar
Ian Lynagh committed
405
   | Opt_GhciHistory
406
   | Opt_HelpfulErrors
407
   | Opt_DeferTypeErrors
408
   | Opt_DeferTypedHoles
Ian Lynagh's avatar
Ian Lynagh committed
409
   | Opt_Parallel
Ian Lynagh's avatar
Ian Lynagh committed
410
   | Opt_PIC
411
   | Opt_SccProfilingOn
ian@well-typed.com's avatar
ian@well-typed.com committed
412
   | Opt_Ticky
nfrisby's avatar
nfrisby committed
413 414 415
   | Opt_Ticky_Allocd
   | Opt_Ticky_LNE
   | Opt_Ticky_Dyn_Thunk
ian@well-typed.com's avatar
ian@well-typed.com committed
416
   | Opt_Static
417
   | Opt_RPath
418
   | Opt_RelativeDynlibPaths
ian@well-typed.com's avatar
ian@well-typed.com committed
419
   | Opt_Hpc
420
   | Opt_FlatCache
421

422 423 424 425
   -- PreInlining is on by default. The option is there just to see how
   -- bad things get if you turn it off!
   | Opt_SimplPreInlining

426
   -- output style opts
427 428
   | Opt_ErrorSpans -- Include full span info in error messages,
                    -- instead of just the start position.
429
   | Opt_PprCaseAsLet
Peter Wortmann's avatar
Peter Wortmann committed
430
   | Opt_PprShowTicks
431

432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448
   -- 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
   | Opt_SuppressTypeSignatures
   -- Suppress unique ids on variables.
   -- Except for uniques, as some simplifier phases introduce new
   -- variables that have otherwise identical names.
   | Opt_SuppressUniques

449
   -- temporary flags
450
   | Opt_AutoLinkPackages
451
   | Opt_ImplicitImportQualified
452 453 454 455 456 457

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
458
   | Opt_KeepRawTokenStream
459
   | Opt_KeepLlvmFiles
460

461 462
   | Opt_BuildDynamicToo

463
   -- safe haskell flags
dterei's avatar
dterei committed
464
   | Opt_DistrustAllPackages
465 466
   | Opt_PackageTrust

Peter Wortmann's avatar
Peter Wortmann committed
467 468 469
   -- debugging flags
   | Opt_Debug

470
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
471

472
data WarningFlag =
473
-- See Note [Updating flag description in the User's Guide]
474
     Opt_WarnDuplicateExports
475
   | Opt_WarnDuplicateConstraints
476
   | Opt_WarnRedundantConstraints
477 478 479 480 481
   | Opt_WarnHiShadows
   | Opt_WarnImplicitPrelude
   | Opt_WarnIncompletePatterns
   | Opt_WarnIncompleteUniPatterns
   | Opt_WarnIncompletePatternsRecUpd
482
   | Opt_WarnOverflowedLiterals
483
   | Opt_WarnEmptyEnumerations
484 485 486 487 488 489 490 491 492
   | Opt_WarnMissingFields
   | Opt_WarnMissingImportList
   | Opt_WarnMissingMethods
   | Opt_WarnMissingSigs
   | Opt_WarnMissingLocalSigs
   | Opt_WarnNameShadowing
   | Opt_WarnOverlappingPatterns
   | Opt_WarnTypeDefaults
   | Opt_WarnMonomorphism
493 494 495
   | Opt_WarnUnusedTopBinds
   | Opt_WarnUnusedLocalBinds
   | Opt_WarnUnusedPatternBinds
496 497
   | Opt_WarnUnusedImports
   | Opt_WarnUnusedMatches
498
   | Opt_WarnContextQuantification
499 500
   | Opt_WarnWarningsDeprecations
   | Opt_WarnDeprecatedFlags
501
   | Opt_WarnAMP
502 503 504 505 506 507 508 509 510 511 512
   | Opt_WarnDodgyExports
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
   | Opt_WarnAutoOrphans
   | Opt_WarnIdentities
   | Opt_WarnTabs
   | Opt_WarnUnrecognisedPragmas
   | Opt_WarnDodgyForeignImports
   | Opt_WarnUnusedDoBind
   | Opt_WarnWrongDoBind
   | Opt_WarnAlternativeLayoutRuleTransitional
513 514
   | Opt_WarnUnsafe
   | Opt_WarnSafe
515
   | Opt_WarnTrustworthySafe
Ian Lynagh's avatar
Ian Lynagh committed
516
   | Opt_WarnPointlessPragmas
517
   | Opt_WarnUnsupportedCallingConventions
518
   | Opt_WarnUnsupportedLlvmVersion
519
   | Opt_WarnInlineRuleShadowing
520
   | Opt_WarnTypedHoles
thomasw's avatar
thomasw committed
521
   | Opt_WarnPartialTypeSignatures
522
   | Opt_WarnMissingExportedSigs
carlostome's avatar
carlostome committed
523
   | Opt_WarnUntickedPromotedConstructors
524
   | Opt_WarnDerivingTypeable
525
   deriving (Eq, Show, Enum)
526

527
data Language = Haskell98 | Haskell2010
528
   deriving Enum
529

530
-- | The various Safe Haskell modes
531 532
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
533
   | Sf_Unsafe
534 535 536 537
   | Sf_Trustworthy
   | Sf_Safe
   deriving (Eq)

Ian Lynagh's avatar
Ian Lynagh committed
538
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
539 540 541 542
    show Sf_None         = "None"
    show Sf_Unsafe       = "Unsafe"
    show Sf_Trustworthy  = "Trustworthy"
    show Sf_Safe         = "Safe"
Ian Lynagh's avatar
Ian Lynagh committed
543

544
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
545
    ppr = text . show
546

547
data ExtensionFlag
548
-- See Note [Updating flag description in the User's Guide]
549 550 551 552 553 554 555
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
556 557
   | Opt_RelaxedPolyRec           -- Deprecated
   | Opt_ExtendedDefaultRules     -- Use GHC's extended rules for defaulting
558 559
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
560
   | Opt_InterruptibleFFI
561
   | Opt_CApiFFI
562
   | Opt_GHCForeignImportPrim
thoughtpolice's avatar
thoughtpolice committed
563
   | Opt_JavaScriptFFI
564 565
   | Opt_ParallelArrays           -- Syntactic support for parallel arrays
   | Opt_Arrows                   -- Arrow-notation syntax
566 567 568 569 570
   | Opt_TemplateHaskell
   | Opt_QuasiQuotes
   | Opt_ImplicitParams
   | Opt_ImplicitPrelude
   | Opt_ScopedTypeVariables
571
   | Opt_AllowAmbiguousTypes
572 573 574 575
   | Opt_UnboxedTuples
   | Opt_BangPatterns
   | Opt_TypeFamilies
   | Opt_OverloadedStrings
576
   | Opt_OverloadedLists
577
   | Opt_NumDecimals
578 579 580 581 582
   | Opt_DisambiguateRecordFields
   | Opt_RecordWildCards
   | Opt_RecordPuns
   | Opt_ViewPatterns
   | Opt_GADTs
Ian Lynagh's avatar
Ian Lynagh committed
583
   | Opt_GADTSyntax
584
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
585
   | Opt_DoAndIfThenElse
586
   | Opt_RebindableSyntax
587
   | Opt_ConstraintKinds
dreixel's avatar
dreixel committed
588
   | Opt_PolyKinds                -- Kind polymorphism
dreixel's avatar
dreixel committed
589
   | Opt_DataKinds                -- Datatype promotion
590
   | Opt_InstanceSigs
591

592 593
   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
594
   | Opt_AutoDeriveTypeable       -- Automatic derivation of Typeable
595 596 597
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable
598
   | Opt_DeriveGeneric            -- Allow deriving Generic/1
dreixel's avatar
dreixel committed
599
   | Opt_DefaultSignatures        -- Allow extra signatures for defmeths
600
   | Opt_DeriveAnyClass           -- Allow deriving any class
601 602 603 604 605 606

   | Opt_TypeSynonymInstances
   | Opt_FlexibleContexts
   | Opt_FlexibleInstances
   | Opt_ConstrainedClassMethods
   | Opt_MultiParamTypeClasses
607
   | Opt_NullaryTypeClasses
608 609 610 611 612 613
   | Opt_FunctionalDependencies
   | Opt_UnicodeSyntax
   | Opt_ExistentialQuantification
   | Opt_MagicHash
   | Opt_EmptyDataDecls
   | Opt_KindSignatures
614
   | Opt_RoleAnnotations
615 616
   | Opt_ParallelListComp
   | Opt_TransformListComp
617
   | Opt_MonadComprehensions
618 619 620 621 622 623 624 625 626
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
627
   | Opt_ExplicitNamespaces
628 629 630 631 632
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
633
   | Opt_NondecreasingIndentation
634
   | Opt_RelaxedLayout
635
   | Opt_TraditionalRecordSyntax
636
   | Opt_LambdaCase
637
   | Opt_MultiWayIf
638
   | Opt_BinaryLiterals
639
   | Opt_NegativeLiterals
640
   | Opt_EmptyCase
cactus's avatar
cactus committed
641
   | Opt_PatternSynonyms
thomasw's avatar
thomasw committed
642
   | Opt_PartialTypeSignatures
643
   | Opt_NamedWildCards
Facundo Domínguez's avatar
Facundo Domínguez committed
644
   | Opt_StaticPointers
645
   deriving (Eq, Enum, Show)
646

Edward Z. Yang's avatar
Edward Z. Yang committed
647
type SigOf = Map ModuleName Module
648 649

getSigOf :: DynFlags -> ModuleName -> Maybe Module
Edward Z. Yang's avatar
Edward Z. Yang committed
650
getSigOf dflags n = Map.lookup n (sigOf dflags)
651

652
-- | Contains not only a collection of 'GeneralFlag's but also a plethora of
653
-- information relating to the compilation of a single file or GHC session
654
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
655 656 657
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
658
  settings              :: Settings,
659 660
  -- See Note [Signature parameters in TcGblEnv and DynFlags]
  sigOf                 :: SigOf,       -- ^ Compiling an hs-boot against impl.
661
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
662 663 664
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
Ian Lynagh's avatar
Ian Lynagh committed
665
  ruleCheck             :: Maybe String,
666
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
667

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

672 673 674
  enableTimeStats       :: Bool,        -- ^ Enable RTS timing statistics?
  ghcHeapSize           :: Maybe Int,   -- ^ The heap size to set.

675 676
  maxRelevantBinds      :: Maybe Int,   -- ^ Maximum number of bindings from the type envt
                                        --   to show in type error messages
677
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
678 679
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
680 681
  specConstrRecursive   :: Int,         -- ^ Max number of specialisations for recursive types
                                        --   Not optional; otherwise ForceSpecConstr can diverge.
682
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
683
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
684
                                        --   See CoreMonad.FloatOutSwitches
685

686
  historySize           :: Int,
687

688
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
689 690 691
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
692
  reductionDepth        :: IntWithInf,   -- ^ Typechecker maximum stack depth
693

694
  thisPackage           :: PackageKey,   -- ^ name of package currently being compiled
695 696

  -- ways
697
  ways                  :: [Way],       -- ^ Way flags from the command line
698 699
  buildTag              :: String,      -- ^ The global \"way\" (e.g. \"p\" for prof)
  rtsBuildTag           :: String,      -- ^ The RTS \"way\"
Ian Lynagh's avatar
Ian Lynagh committed
700

701 702 703
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

704
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
705
  objectDir             :: Maybe String,
706
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
707 708
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
709
  dumpDir               :: Maybe String,
710

Ian Lynagh's avatar
Ian Lynagh committed
711 712 713
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
714

715 716 717 718
  canGenerateDynamicToo :: IORef Bool,
  dynObjectSuf          :: String,
  dynHiSuf              :: String,

719 720 721 722 723 724 725 726
  -- Packages.isDllName needs to know whether a call is within a
  -- single DLL or not. Normally it does this by seeing if the call
  -- is to the same package, but for the ghc package, we split the
  -- package between 2 DLLs. The dllSplit tells us which sets of
  -- modules are in which package.
  dllSplitFile          :: Maybe FilePath,
  dllSplit              :: Maybe [Set String],

Ian Lynagh's avatar
Ian Lynagh committed
727
  outputFile            :: Maybe String,
ian@well-typed.com's avatar
ian@well-typed.com committed
728
  dynOutputFile         :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
729 730
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
731

732
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
733 734
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
735

736 737
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
738 739
  dumpPrefixForce       :: Maybe FilePath,

740
  ldInputs              :: [Option],
741

Ian Lynagh's avatar
Ian Lynagh committed
742 743 744 745 746
  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

747
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
748
  rtsOptsEnabled        :: RtsOptsEnabled,
749

750
  hpcDir                :: String,      -- ^ Path to store the .mix files
andy@galois.com's avatar
andy@galois.com committed
751

752 753 754 755
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

756 757 758
  -- GHC API hooks
  hooks                 :: Hooks,

759 760 761 762 763 764
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

765
  --  Package flags
766
  extraPkgConfs         :: [PkgConfRef] -> [PkgConfRef],
767
        -- ^ The @-package-db@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
768
        -- they appeared.
769

Ian Lynagh's avatar
Ian Lynagh committed
770
  packageFlags          :: [PackageFlag],
771
        -- ^ The @-package@ and @-hide-package@ flags from the command-line
Edsko de Vries's avatar
Edsko de Vries committed
772 773
  packageEnv            :: Maybe FilePath,
        -- ^ Filepath to the package environment file (if overriding default)
774

775
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
776
  -- NB. do not modify this field, it is calculated by