DynFlags.hs 173 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,
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)
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 FastString
Simon Marlow's avatar
Simon Marlow committed
172
import Outputable
Ian Lynagh's avatar
Ian Lynagh committed
173
#ifdef GHCI
Ian Lynagh's avatar
Ian Lynagh committed
174
import Foreign.C        ( CInt(..) )
175
import System.IO.Unsafe ( unsafeDupablePerformIO )
Ian Lynagh's avatar
Ian Lynagh committed
176
#endif
177
import {-# SOURCE #-} ErrUtils ( Severity(..), MsgDoc, mkLocMessage )
178

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

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

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

205 206
import GHC.Foreign (withCString, peekCString)

207 208 209 210 211 212 213 214 215 216 217 218 219
-- 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.

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

232 233 234
-- -----------------------------------------------------------------------------
-- DynFlags

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

   -- debugging flags
   = Opt_D_dump_cmm
240 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
   | Opt_D_dump_cmm_proc
246
   | Opt_D_dump_cmm_sink
247 248 249 250 251 252
   | 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
253
   | Opt_D_dump_asm
254 255 256 257 258
   | 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
259
   | Opt_D_dump_asm_stats
260
   | Opt_D_dump_asm_expanded
261
   | Opt_D_dump_llvm
262
   | Opt_D_dump_core_stats
263 264 265 266
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
267
   | Opt_D_dump_rule_firings
268
   | Opt_D_dump_rule_rewrites
269
   | Opt_D_dump_simpl_trace
270 271 272 273 274 275 276 277
   | 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
278
   | Opt_D_dump_call_arity
279
   | Opt_D_dump_stranal
Joachim Breitner's avatar
Joachim Breitner committed
280
   | Opt_D_dump_strsigs
281 282 283 284 285 286 287 288 289
   | 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
290
   | Opt_D_dump_cs_trace -- Constraint solver in type checker
291 292
   | Opt_D_dump_tc_trace
   | Opt_D_dump_if_trace
293
   | Opt_D_dump_vt_trace
294
   | Opt_D_dump_splices
295
   | Opt_D_th_dec_file
296 297
   | Opt_D_dump_BCOs
   | Opt_D_dump_vect
298
   | Opt_D_dump_ticked
pepe's avatar
pepe committed
299
   | Opt_D_dump_rtti
300 301 302 303
   | Opt_D_source_stats
   | Opt_D_verbose_stg2stg
   | Opt_D_dump_hi
   | Opt_D_dump_hi_diffs
304
   | Opt_D_dump_mod_cycles
305
   | Opt_D_dump_mod_map
306
   | Opt_D_dump_view_pattern_commoning
307
   | Opt_D_verbose_core2core
308
   | Opt_D_dump_debug
309 310 311 312 313

   deriving (Eq, Show, Enum)

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

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

Ian Lynagh's avatar
Ian Lynagh committed
326
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
327

328
   | Opt_PrintExplicitForalls
unknown's avatar
unknown committed
329
   | Opt_PrintExplicitKinds
330

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

370 371 372 373
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings
374
   | Opt_WriteInterface -- forces .hi files to be written even with -fno-code
375

Ian Lynagh's avatar
Ian Lynagh committed
376 377
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
378
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
379

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

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

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

429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445
   -- 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

446
   -- temporary flags
447
   | Opt_AutoLinkPackages
448
   | Opt_ImplicitImportQualified
449 450 451 452 453 454

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
455
   | Opt_KeepRawTokenStream
456
   | Opt_KeepLlvmFiles
457

458 459
   | Opt_BuildDynamicToo

460
   -- safe haskell flags
dterei's avatar
dterei committed
461
   | Opt_DistrustAllPackages
462 463
   | Opt_PackageTrust

Peter Wortmann's avatar
Peter Wortmann committed
464 465 466
   -- debugging flags
   | Opt_Debug

467
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
468

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

524
data Language = Haskell98 | Haskell2010
525
   deriving Enum
526

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

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

541
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
542
    ppr = text . show
543

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

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

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

644 645 646 647 648 649 650 651 652 653 654
data SigOf = NotSigOf
           | SigOf Module
           | SigOfMap (Map ModuleName Module)

getSigOf :: DynFlags -> ModuleName -> Maybe Module
getSigOf dflags n =
    case sigOf dflags of
        NotSigOf -> Nothing
        SigOf m -> Just m
        SigOfMap m -> Map.lookup n m

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

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

675 676 677
  enableTimeStats       :: Bool,        -- ^ Enable RTS timing statistics?
  ghcHeapSize           :: Maybe Int,   -- ^ The heap size to set.

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

689
  historySize           :: Int,
690

691
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
692 693 694
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
695
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
696
  tyFunStkDepth         :: Int,         -- ^ Typechecker type function stack depth
697

698
  thisPackage           :: PackageKey,   -- ^ name of package currently being compiled
699 700

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

705 706 707
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

708
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
709
  objectDir             :: Maybe String,
710
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
711 712
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
713
  dumpDir               :: Maybe String,
714

Ian Lynagh's avatar
Ian Lynagh committed
715 716 717
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
718

719 720 721 722
  canGenerateDynamicToo :: IORef Bool,
  dynObjectSuf          :: String,
  dynHiSuf              :: String,

723 724 725 726 727 728 729 730
  -- 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
731
  outputFile            :: Maybe String,
ian@well-typed.com's avatar
ian@well-typed.com committed
732
  dynOutputFile         :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
733 734
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
735

736
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
737 738
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
739

740 741
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
742 743
  dumpPrefixForce       :: Maybe FilePath,

744
  ldInputs              :: [Option],
745

Ian Lynagh's avatar
Ian Lynagh committed
746 747 748 749 750
  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

751
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
752
  rtsOptsEnabled        :: RtsOptsEnabled,
753

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

756 757 758 759
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

760 761 762
  -- GHC API hooks
  hooks                 :: Hooks,

763 764 765 766 767 768
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

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

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

779
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
780
  -- NB. do not modify this field, it is calculated by
Edward Z. Yang's avatar
Edward Z. Yang committed
781
  -- Packages.initPackages
782
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
783
  pkgState              :: PackageState,
784