DynFlags.hs 149 KB
Newer Older
dterei's avatar
dterei committed
1
-------------------------------------------------------------------------------
2
--
dterei's avatar
dterei committed
3 4 5 6 7 8
-- | 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.
9 10 11
--
-- (c) The University of Glasgow 2005
--
dterei's avatar
dterei committed
12
-------------------------------------------------------------------------------
13

14 15 16
{-# OPTIONS -fno-cse #-}
-- -fno-cse is needed for GLOBAL_VAR's to behave properly

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

51 52
        printOutputForUser, printInfoForUser,

53
        Way(..), mkBuildTag, wayRTSOnly, addWay', updateWays,
54
        wayGeneralFlags, wayUnsetGeneralFlags,
ian@well-typed.com's avatar
ian@well-typed.com committed
55

56
        -- ** Safe Haskell
57
        SafeHaskellMode(..),
58
        safeHaskellOn, safeImportsOn, safeLanguageOn, safeInferOn,
59
        packageTrustOn,
60
        safeDirectImpsReq, safeImplicitImpsReq,
61
        unsafeFlags,
62

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


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

86
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
87
        getVerbFlags,
Ian Lynagh's avatar
Ian Lynagh committed
88 89 90 91
        updOptLevel,
        setTmpDir,
        setPackageName,

92
        -- ** Parsing DynFlags
93 94
        parseDynamicFlagsCmdLine,
        parseDynamicFilePragma,
95 96 97
        parseDynamicFlagsFull,

        -- ** Available DynFlags
98
        allFlags,
99 100 101
        flagsAll,
        flagsDynamic,
        flagsPackage,
102

103
        supportedLanguagesAndExtensions,
104
        languageExtensions,
105

106
        -- ** DynFlags C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
107
        picCCOpts, picPOpts,
108 109 110 111 112 113

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

        -- * Compiler configuration suitable for display to the user
114 115
        compilerInfo,

116
#ifdef GHCI
dterei's avatar
dterei committed
117
-- Only in stage 2 can we be sure that the RTS
118
-- exposes the appropriate runtime boolean
119
        rtsIsProfiled,
120
#endif
121 122

#include "../includes/dist-derivedconstants/header/GHCConstantsHaskellExports.hs"
123
        bLOCK_SIZE_W,
124
        wORD_SIZE_IN_BITS,
125 126
        tAG_MASK,
        mAX_PTR_TAG,
127
        tARGET_MIN_INT, tARGET_MAX_INT, tARGET_MAX_WORD,
128

129 130
        unsafeGlobalDynFlags, setUnsafeGlobalDynFlags,

131 132 133
        -- * SSE
        isSse2Enabled,
        isSse4_2Enabled,
134 135 136

        -- * Linker information
        LinkerInfo(..),
137 138 139 140
  ) where

#include "HsVersions.h"

141
import Platform
142
import PlatformConstants
143
import Module
Simon Marlow's avatar
Simon Marlow committed
144
import PackageConfig
145
import {-# SOURCE #-} PrelNames ( mAIN )
146
import {-# SOURCE #-} Packages (PackageState)
Ian Lynagh's avatar
Ian Lynagh committed
147
import DriverPhases     ( Phase(..), phaseInputExt )
148 149
import Config
import CmdLineParser
150
import Constants
151
import Panic
152
import Util
153
import Maybes           ( orElse )
154
import MonadUtils
155
import qualified Pretty
156
import SrcLoc
157
import FastString
Simon Marlow's avatar
Simon Marlow committed
158
import Outputable
Ian Lynagh's avatar
Ian Lynagh committed
159
#ifdef GHCI
Ian Lynagh's avatar
Ian Lynagh committed
160
import Foreign.C        ( CInt(..) )
Ian Lynagh's avatar
Ian Lynagh committed
161
#endif
162
import {-# SOURCE #-} ErrUtils ( Severity(..), MsgDoc, mkLocMessage )
163

164
import System.IO.Unsafe ( unsafePerformIO )
165
import Data.IORef
ian@well-typed.com's avatar
ian@well-typed.com committed
166
import Control.Monad
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
167

168
import Data.Bits
169
import Data.Char
170
import Data.Int
171
import Data.List
172 173
import Data.Map (Map)
import qualified Data.Map as Map
174
import Data.Maybe
175 176
import Data.Set (Set)
import qualified Data.Set as Set
177
import Data.Word
Ian Lynagh's avatar
Ian Lynagh committed
178
import System.FilePath
179
import System.IO
180
import System.IO.Error
181

182 183 184
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

185 186
import GHC.Foreign (withCString, peekCString)

187 188 189
-- -----------------------------------------------------------------------------
-- DynFlags

190
data DumpFlag
191 192 193

   -- debugging flags
   = Opt_D_dump_cmm
194 195 196 197 198 199
   | 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
200
   | Opt_D_dump_cmm_sink
201 202 203 204 205 206
   | 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
207
   | Opt_D_dump_asm
208 209 210 211 212
   | 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
213
   | Opt_D_dump_asm_stats
214
   | Opt_D_dump_asm_expanded
215
   | Opt_D_dump_llvm
216
   | Opt_D_dump_core_stats
217 218 219 220
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
221
   | Opt_D_dump_rule_firings
222
   | Opt_D_dump_rule_rewrites
223
   | Opt_D_dump_simpl_trace
224 225 226
   | Opt_D_dump_occur_anal
   | Opt_D_dump_parsed
   | Opt_D_dump_rn
227
   | Opt_D_dump_core_pipeline -- TODO FIXME: dump after simplifier stats
228 229
   | Opt_D_dump_simpl
   | Opt_D_dump_simpl_iterations
230
   | Opt_D_dump_simpl_phases
231 232 233 234 235 236 237 238 239 240 241 242 243
   | Opt_D_dump_spec
   | Opt_D_dump_prep
   | Opt_D_dump_stg
   | Opt_D_dump_stranal
   | 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
244
   | Opt_D_dump_cs_trace -- Constraint solver in type checker
245 246
   | Opt_D_dump_tc_trace
   | Opt_D_dump_if_trace
247
   | Opt_D_dump_vt_trace
248 249 250
   | Opt_D_dump_splices
   | Opt_D_dump_BCOs
   | Opt_D_dump_vect
251
   | Opt_D_dump_ticked
pepe's avatar
pepe committed
252
   | Opt_D_dump_rtti
253 254 255 256
   | Opt_D_source_stats
   | Opt_D_verbose_stg2stg
   | Opt_D_dump_hi
   | Opt_D_dump_hi_diffs
257
   | Opt_D_dump_mod_cycles
258
   | Opt_D_dump_view_pattern_commoning
259 260 261 262 263 264 265 266
   | Opt_D_verbose_core2core

   deriving (Eq, Show, Enum)

-- | Enumerates the simple on-or-off dynamic flags
data GeneralFlag

   = Opt_DumpToFile                     -- ^ Append dump output to files instead of stdout.
267
   | Opt_D_faststring_stats
268
   | Opt_D_dump_minimal_imports
269 270 271
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
272
   | Opt_DoAsmLinting
273
   | Opt_NoLlvmMangler                 -- hidden flag
274

Ian Lynagh's avatar
Ian Lynagh committed
275
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
276

277 278
   | Opt_PrintExplicitForalls

279 280
   -- optimisation opts
   | Opt_Strictness
281
   | Opt_LateDmdAnal
282 283
   | Opt_KillAbsence
   | Opt_KillOneShot
284
   | Opt_FullLaziness
285 286
   | Opt_FloatIn
   | Opt_Specialise
287
   | Opt_StaticArgumentTransformation
288
   | Opt_CSE
289 290
   | Opt_LiberateCase
   | Opt_SpecConstr
291 292 293 294 295
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
296
   | Opt_UnboxSmallStrictFields
297
   | Opt_DictsCheap
298
   | Opt_EnableRewriteRules             -- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
299
   | Opt_Vectorise
300
   | Opt_VectorisationAvoidance
Ian Lynagh's avatar
Ian Lynagh committed
301 302
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
303
   | Opt_PedanticBottoms                -- Be picky about how we treat bottom
304
   | Opt_LlvmTBAA                       -- Use LLVM TBAA infastructure for improving AA (hidden flag)
305
   | Opt_IrrefutableTuples
306
   | Opt_CmmSink
307
   | Opt_CmmElimCommonBlocks
308
   | Opt_OmitYields
309
   | Opt_SimpleListLiterals
310
   | Opt_FunToThunk               -- allow WwLib.mkWorkerArgs to remove all value lambdas
311 312
   | Opt_DictsStrict                     -- be strict in argument dictionaries
   | Opt_DmdTxDictSel              -- use a special demand transformer for dictionary selectors
313
   | Opt_Loopification                  -- See Note [Self-recursive tail calls]
314

315 316 317 318 319
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
320 321
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
322
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
323

324 325
   -- misc opts
   | Opt_Pp
326
   | Opt_ForceRecomp
327
   | Opt_ExcessPrecision
328
   | Opt_EagerBlackHoling
329 330 331
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
332
   | Opt_HideAllPackages
333
   | Opt_PrintBindResult
334
   | Opt_Haddock
David Waern's avatar
David Waern committed
335
   | Opt_HaddockOptions
336
   | Opt_Hpc_No_Auto
337
   | Opt_BreakOnException
338
   | Opt_BreakOnError
339
   | Opt_PrintEvldWithShow
340
   | Opt_PrintBindContents
341 342
   | Opt_GenManifest
   | Opt_EmbedManifest
343
   | Opt_EmitExternalCore
Ian Lynagh's avatar
Ian Lynagh committed
344
   | Opt_SharedImplib
345
   | Opt_BuildingCabalPackage
346
   | Opt_IgnoreDotGhci
347
   | Opt_GhciSandbox
Ian Lynagh's avatar
Ian Lynagh committed
348
   | Opt_GhciHistory
349
   | Opt_HelpfulErrors
350
   | Opt_DeferTypeErrors
Ian Lynagh's avatar
Ian Lynagh committed
351
   | Opt_Parallel
Ian Lynagh's avatar
Ian Lynagh committed
352
   | Opt_GranMacros
Ian Lynagh's avatar
Ian Lynagh committed
353
   | Opt_PIC
354
   | Opt_SccProfilingOn
ian@well-typed.com's avatar
ian@well-typed.com committed
355
   | Opt_Ticky
nfrisby's avatar
nfrisby committed
356 357 358
   | Opt_Ticky_Allocd
   | Opt_Ticky_LNE
   | Opt_Ticky_Dyn_Thunk
ian@well-typed.com's avatar
ian@well-typed.com committed
359
   | Opt_Static
360
   | Opt_RPath
361
   | Opt_RelativeDynlibPaths
ian@well-typed.com's avatar
ian@well-typed.com committed
362
   | Opt_Hpc
363
   | Opt_FlatCache
364

365 366 367 368
   -- PreInlining is on by default. The option is there just to see how
   -- bad things get if you turn it off!
   | Opt_SimplPreInlining

369
   -- output style opts
370 371
   | Opt_ErrorSpans -- Include full span info in error messages,
                    -- instead of just the start position.
372
   | Opt_PprCaseAsLet
373

374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390
   -- 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

391
   -- temporary flags
392
   | Opt_RunCPS
393
   | Opt_RunCPSZ
394
   | Opt_AutoLinkPackages
395
   | Opt_ImplicitImportQualified
396 397 398 399 400 401

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
402
   | Opt_KeepRawTokenStream
403
   | Opt_KeepLlvmFiles
404

405 406
   | Opt_BuildDynamicToo

407
   -- safe haskell flags
dterei's avatar
dterei committed
408
   | Opt_DistrustAllPackages
409 410
   | Opt_PackageTrust

411
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
412

413 414
data WarningFlag =
     Opt_WarnDuplicateExports
415
   | Opt_WarnDuplicateConstraints
416 417 418 419 420
   | Opt_WarnHiShadows
   | Opt_WarnImplicitPrelude
   | Opt_WarnIncompletePatterns
   | Opt_WarnIncompleteUniPatterns
   | Opt_WarnIncompletePatternsRecUpd
421
   | Opt_WarnOverflowedLiterals
422
   | Opt_WarnEmptyEnumerations
423 424 425 426 427 428 429 430 431 432 433 434 435 436
   | Opt_WarnMissingFields
   | Opt_WarnMissingImportList
   | Opt_WarnMissingMethods
   | Opt_WarnMissingSigs
   | Opt_WarnMissingLocalSigs
   | Opt_WarnNameShadowing
   | Opt_WarnOverlappingPatterns
   | Opt_WarnTypeDefaults
   | Opt_WarnMonomorphism
   | Opt_WarnUnusedBinds
   | Opt_WarnUnusedImports
   | Opt_WarnUnusedMatches
   | Opt_WarnWarningsDeprecations
   | Opt_WarnDeprecatedFlags
437
   | Opt_WarnAMP
438 439 440 441 442 443 444 445 446 447 448 449
   | Opt_WarnDodgyExports
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
   | Opt_WarnAutoOrphans
   | Opt_WarnIdentities
   | Opt_WarnTabs
   | Opt_WarnUnrecognisedPragmas
   | Opt_WarnDodgyForeignImports
   | Opt_WarnLazyUnliftedBindings
   | Opt_WarnUnusedDoBind
   | Opt_WarnWrongDoBind
   | Opt_WarnAlternativeLayoutRuleTransitional
450 451
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
452
   | Opt_WarnPointlessPragmas
453
   | Opt_WarnUnsupportedCallingConventions
454
   | Opt_WarnUnsupportedLlvmVersion
455
   | Opt_WarnInlineRuleShadowing
456
   deriving (Eq, Show, Enum)
457

458
data Language = Haskell98 | Haskell2010
459
   deriving Enum
460

461
-- | The various Safe Haskell modes
462 463
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
464
   | Sf_Unsafe
465 466
   | Sf_Trustworthy
   | Sf_Safe
467
   | Sf_SafeInferred
468 469
   deriving (Eq)

Ian Lynagh's avatar
Ian Lynagh committed
470
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
471 472 473 474 475
    show Sf_None         = "None"
    show Sf_Unsafe       = "Unsafe"
    show Sf_Trustworthy  = "Trustworthy"
    show Sf_Safe         = "Safe"
    show Sf_SafeInferred = "Safe-Inferred"
Ian Lynagh's avatar
Ian Lynagh committed
476

477
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
478
    ppr = text . show
479

480
data ExtensionFlag
481 482 483 484 485 486 487
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
488 489
   | Opt_RelaxedPolyRec           -- Deprecated
   | Opt_ExtendedDefaultRules     -- Use GHC's extended rules for defaulting
490 491
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
492
   | Opt_InterruptibleFFI
493
   | Opt_CApiFFI
494
   | Opt_GHCForeignImportPrim
thoughtpolice's avatar
thoughtpolice committed
495
   | Opt_JavaScriptFFI
496 497
   | Opt_ParallelArrays           -- Syntactic support for parallel arrays
   | Opt_Arrows                   -- Arrow-notation syntax
498 499 500 501 502
   | Opt_TemplateHaskell
   | Opt_QuasiQuotes
   | Opt_ImplicitParams
   | Opt_ImplicitPrelude
   | Opt_ScopedTypeVariables
503
   | Opt_AllowAmbiguousTypes
504 505 506 507
   | Opt_UnboxedTuples
   | Opt_BangPatterns
   | Opt_TypeFamilies
   | Opt_OverloadedStrings
508
   | Opt_OverloadedLists
509
   | Opt_NumDecimals
510 511 512 513 514
   | Opt_DisambiguateRecordFields
   | Opt_RecordWildCards
   | Opt_RecordPuns
   | Opt_ViewPatterns
   | Opt_GADTs
Ian Lynagh's avatar
Ian Lynagh committed
515
   | Opt_GADTSyntax
516
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
517
   | Opt_DoAndIfThenElse
518
   | Opt_RebindableSyntax
519
   | Opt_ConstraintKinds
dreixel's avatar
dreixel committed
520
   | Opt_PolyKinds                -- Kind polymorphism
dreixel's avatar
dreixel committed
521
   | Opt_DataKinds                -- Datatype promotion
522
   | Opt_InstanceSigs
523

524 525
   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
526
   | Opt_AutoDeriveTypeable       -- Automatic derivation of Typeable
527 528 529
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable
530
   | Opt_DeriveGeneric            -- Allow deriving Generic/1
dreixel's avatar
dreixel committed
531
   | Opt_DefaultSignatures        -- Allow extra signatures for defmeths
532 533 534 535 536 537

   | Opt_TypeSynonymInstances
   | Opt_FlexibleContexts
   | Opt_FlexibleInstances
   | Opt_ConstrainedClassMethods
   | Opt_MultiParamTypeClasses
538
   | Opt_NullaryTypeClasses
539 540 541 542 543 544
   | Opt_FunctionalDependencies
   | Opt_UnicodeSyntax
   | Opt_ExistentialQuantification
   | Opt_MagicHash
   | Opt_EmptyDataDecls
   | Opt_KindSignatures
545
   | Opt_RoleAnnotations
546 547
   | Opt_ParallelListComp
   | Opt_TransformListComp
548
   | Opt_MonadComprehensions
549 550 551 552 553 554 555 556 557
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
558
   | Opt_ExplicitNamespaces
559 560 561 562 563
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
564
   | Opt_NondecreasingIndentation
565
   | Opt_RelaxedLayout
566
   | Opt_TraditionalRecordSyntax
567
   | Opt_LambdaCase
568
   | Opt_MultiWayIf
569
   | Opt_TypeHoles
570
   | Opt_NegativeLiterals
571
   | Opt_EmptyCase
572
   deriving (Eq, Enum, Show)
573

574
-- | Contains not only a collection of 'GeneralFlag's but also a plethora of
575
-- information relating to the compilation of a single file or GHC session
576
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
577 578 579
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
580
  settings              :: Settings,
581
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
582 583 584
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
585
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
586
  ruleCheck             :: Maybe String,
587
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
588

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

593 594
  maxRelevantBinds      :: Maybe Int,   -- ^ Maximum number of bindings from the type envt
                                        --   to show in type error messages
595
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
596 597
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
598 599
  specConstrRecursive   :: Int,         -- ^ Max number of specialisations for recursive types
                                        --   Not optional; otherwise ForceSpecConstr can diverge.
600
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
601
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
602
                                        --   See CoreMonad.FloatOutSwitches
603

604
  historySize           :: Int,
605

606
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
607 608 609
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
610
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
611

612
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
613 614

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

619 620 621
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

622
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
623
  objectDir             :: Maybe String,
624
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
625 626
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
627
  dumpDir               :: Maybe String,
628

Ian Lynagh's avatar
Ian Lynagh committed
629 630 631
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
632

633 634 635 636
  canGenerateDynamicToo :: IORef Bool,
  dynObjectSuf          :: String,
  dynHiSuf              :: String,

637 638 639 640 641 642 643 644
  -- 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
645
  outputFile            :: Maybe String,
ian@well-typed.com's avatar
ian@well-typed.com committed
646
  dynOutputFile         :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
647 648
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
649

650
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
651 652
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
653

654 655
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
656 657
  dumpPrefixForce       :: Maybe FilePath,

658
  ldInputs              :: [Option],
659

Ian Lynagh's avatar
Ian Lynagh committed
660 661 662 663 664
  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

665
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
666
  rtsOptsEnabled        :: RtsOptsEnabled,
667

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

670 671 672 673
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

674 675 676 677 678 679
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

680
  --  Package flags
681
  extraPkgConfs         :: [PkgConfRef] -> [PkgConfRef],
682
        -- ^ The @-package-db@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
683
        -- they appeared.
684

Ian Lynagh's avatar
Ian Lynagh committed
685
  packageFlags          :: [PackageFlag],
686
        -- ^ The @-package@ and @-hide-package@ flags from the command-line
687

688
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
689
  -- NB. do not modify this field, it is calculated by
690
  -- Packages.initPackages and Packages.updatePackages.
691
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
692
  pkgState              :: PackageState,
693

694 695 696 697
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
698
  dirsToClean           :: IORef (Map FilePath FilePath),
699
  filesToNotIntermediateClean :: IORef [FilePath],
700 701
  -- The next available suffix to uniquely name a temp file, updated atomically
  nextTempSuffix        :: IORef Int,
702

703 704 705 706 707
  -- Names of files which were generated from -ddump-to-file; used to
  -- track which ones we need to truncate because it's our first run
  -- through
  generatedDumps        :: IORef (Set FilePath),

708
  -- hsc dynamic flags
709 710
  dumpFlags             :: IntSet,
  generalFlags          :: IntSet,
711
  warningFlags          :: IntSet,
712
  -- Don't change this without updating extensionFlags:
713
  language              :: Maybe Language,
714 715
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
716 717 718
  -- We store the location of where some extension and flags were turned on so
  -- we can produce accurate error messages when Safe Haskell fails due to
  -- them.
719 720
  thOnLoc               :: SrcSpan,
  newDerivOnLoc         :: SrcSpan,
721
  pkgTrustOnLoc         :: SrcSpan,
722 723
  warnSafeOnLoc         :: SrcSpan,
  warnUnsafeOnLoc       :: SrcSpan,
724 725 726 727
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
728
  extensionFlags        :: IntSet,
Ian Lynagh's avatar
Ian Lynagh committed
729

730 731 732 733 734 735 736 737 738
  -- Unfolding control
  -- See Note [Discounts and thresholds] in CoreUnfold
  ufCreationThreshold   :: Int,
  ufUseThreshold        :: Int,
  ufFunAppDiscount      :: Int,
  ufDictDiscount        :: Int,
  ufKeenessFactor       :: Float,
  ufDearOp              :: Int,

739 740
  maxWorkerArgs         :: Int,

741 742
  ghciHistSize          :: Int,

743
  -- | MsgDoc output action: use "ErrUtils" instead of this if you can
744
  log_action            :: LogAction,
745 746
  flushOut              :: FlushOut,
  flushErr              :: FlushErr,
David Waern's avatar
David Waern committed
747

748
  haddockOptions        :: Maybe String,
749
  ghciScripts           :: [String],
750

751 752
  -- Output style options
  pprUserLength         :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
753
  pprCols               :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
754
  traceLevel            :: Int, -- Standard level is 1. Less verbose is 0.
755

756 757
  useUnicodeQuotes      :: Bool,

758
  -- | what kind of {-# SCC #-} to add automatically
759 760
  profAuto              :: ProfAuto,

761
  interactivePrint      :: Maybe String,
762

763
  llvmVersion           :: IORef Int,
764

765
  nextWrapperNum        :: IORef (ModuleEnv Int),
tibbe's avatar
tibbe committed
766 767

  -- | Machine dependant flags (-m<blah> stuff)
768 769 770 771
  sseVersion            :: Maybe (Int, Int),  -- (major, minor)

  -- | Run-time linker information (what options we need, etc.)
  rtldFlags             :: IORef (Maybe LinkerInfo)
772 773
 }

774 775 776
class HasDynFlags m where
    getDynFlags :: m DynFlags

Ian Lynagh's avatar
Ian Lynagh committed
777 778
class ContainsDynFlags t where
    extractDynFlags :: t -> DynFlags
779
    replaceDynFlags :: t -> DynFlags -> t
Ian Lynagh's avatar
Ian Lynagh committed
780

781 782 783 784 785
data ProfAuto
  = NoProfAuto         -- ^ no SCC annotations added
  | ProfAutoAll        -- ^ top-level and nested functions are annotated
  | ProfAutoTop        -- ^ top-level functions annotated only
  | ProfAutoExports    -- ^ exported functions annotated only
786
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
787
  deriving (Enum)
788

789
data Settings = Settings {
790
  sTargetPlatform        :: Platform,    -- Filled in by SysTools
791 792 793 794 795 796 797 798 799
  sGhcUsagePath          :: FilePath,    -- Filled in by SysTools
  sGhciUsagePath         :: FilePath,    -- ditto
  sTopDir                :: FilePath,
  sTmpDir                :: String,      -- no trailing '/'
  -- You shouldn't need to look things up in rawSettings directly.
  -- They should have their own fields instead.
  sRawSettings           :: [(String, String)],
  sExtraGccViaCFlags     :: [String],
  sSystemPackageConfig   :: FilePath,
800 801
  sLdSupportsCompactUnwind :: Bool,
  sLdSupportsBuildId       :: Bool,
802
  sLdSupportsFilelist      :: Bool,
ian@well-typed.com's avatar