DynFlags.hs 146 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 35
        whenGeneratingDynamicToo, ifGeneratingDynamicToo,
        whenCannotGenerateDynamicToo,
        doDynamicToo,
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 69
        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,
        pgm_sysman, pgm_windres, 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 83
        defaultFlushOut,
        defaultFlushErr,
Ian Lynagh's avatar
Ian Lynagh committed
84

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

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

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

102
        supportedLanguagesAndExtensions,
103

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

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

        -- * Compiler configuration suitable for display to the user
112 113
        compilerInfo,

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

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

127 128
        unsafeGlobalDynFlags, setUnsafeGlobalDynFlags,

129 130 131
        -- * SSE
        isSse2Enabled,
        isSse4_2Enabled,
132 133 134

        -- * Linker information
        LinkerInfo(..),
135 136 137 138
  ) where

#include "HsVersions.h"

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

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

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

180 181 182
import Data.IntSet (IntSet)
import qualified Data.IntSet as IntSet

183 184
import GHC.Foreign (withCString, peekCString)

185 186 187
-- -----------------------------------------------------------------------------
-- DynFlags

188
data DumpFlag
189 190 191

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

Ian Lynagh's avatar
Ian Lynagh committed
273
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
274

275 276
   | Opt_PrintExplicitForalls

277 278
   -- optimisation opts
   | Opt_Strictness
279 280
   | Opt_KillAbsence
   | Opt_KillOneShot
281
   | Opt_FullLaziness
282 283
   | Opt_FloatIn
   | Opt_Specialise
284
   | Opt_StaticArgumentTransformation
285
   | Opt_CSE
286 287
   | Opt_LiberateCase
   | Opt_SpecConstr
288 289 290 291 292
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
293
   | Opt_UnboxSmallStrictFields
294
   | Opt_DictsCheap
295
   | Opt_EnableRewriteRules             -- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
296
   | Opt_Vectorise
297
   | Opt_VectorisationAvoidance
Ian Lynagh's avatar
Ian Lynagh committed
298 299
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
300
   | Opt_PedanticBottoms                -- Be picky about how we treat bottom
301
   | Opt_LlvmTBAA                       -- Use LLVM TBAA infastructure for improving AA (hidden flag)
302
   | Opt_IrrefutableTuples
303
   | Opt_CmmSink
304
   | Opt_CmmElimCommonBlocks
305
   | Opt_OmitYields
306
   | Opt_SimpleListLiterals
307
   | Opt_FunToThunk               -- allow WwLib.mkWorkerArgs to remove all value lambdas
308

309 310 311 312 313
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
314 315
   -- profiling opts
   | Opt_AutoSccsOnIndividualCafs
316
   | Opt_ProfCountEntries
Ian Lynagh's avatar
Ian Lynagh committed
317

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

359 360 361 362
   -- PreInlining is on by default. The option is there just to see how
   -- bad things get if you turn it off!
   | Opt_SimplPreInlining

363
   -- output style opts
364 365
   | Opt_ErrorSpans -- Include full span info in error messages,
                    -- instead of just the start position.
366
   | Opt_PprCaseAsLet
367

368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
   -- 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

385
   -- temporary flags
386
   | Opt_RunCPS
387
   | Opt_RunCPSZ
388
   | Opt_AutoLinkPackages
389
   | Opt_ImplicitImportQualified
390 391 392 393 394 395

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
396
   | Opt_KeepRawTokenStream
397
   | Opt_KeepLlvmFiles
398

399 400
   | Opt_BuildDynamicToo

401
   -- safe haskell flags
dterei's avatar
dterei committed
402
   | Opt_DistrustAllPackages
403 404
   | Opt_PackageTrust

405
   deriving (Eq, Show, Enum)
Ian Lynagh's avatar
Ian Lynagh committed
406

407 408
data WarningFlag =
     Opt_WarnDuplicateExports
409
   | Opt_WarnDuplicateConstraints
410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
   | Opt_WarnHiShadows
   | Opt_WarnImplicitPrelude
   | Opt_WarnIncompletePatterns
   | Opt_WarnIncompleteUniPatterns
   | Opt_WarnIncompletePatternsRecUpd
   | 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
   | Opt_WarnDodgyExports
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
   | Opt_WarnAutoOrphans
   | Opt_WarnIdentities
   | Opt_WarnTabs
   | Opt_WarnUnrecognisedPragmas
   | Opt_WarnDodgyForeignImports
   | Opt_WarnLazyUnliftedBindings
   | Opt_WarnUnusedDoBind
   | Opt_WarnWrongDoBind
   | Opt_WarnAlternativeLayoutRuleTransitional
441 442
   | Opt_WarnUnsafe
   | Opt_WarnSafe
Ian Lynagh's avatar
Ian Lynagh committed
443
   | Opt_WarnPointlessPragmas
444
   | Opt_WarnUnsupportedCallingConventions
445
   | Opt_WarnUnsupportedLlvmVersion
446
   | Opt_WarnInlineRuleShadowing
447
   | Opt_WarnTypeableInstances
448
   deriving (Eq, Show, Enum)
449

450
data Language = Haskell98 | Haskell2010
451
   deriving Enum
452

453
-- | The various Safe Haskell modes
454 455
data SafeHaskellMode
   = Sf_None
dterei's avatar
dterei committed
456
   | Sf_Unsafe
457 458
   | Sf_Trustworthy
   | Sf_Safe
459
   | Sf_SafeInferred
460 461
   deriving (Eq)

Ian Lynagh's avatar
Ian Lynagh committed
462
instance Show SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
463 464 465 466 467
    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
468

469
instance Outputable SafeHaskellMode where
Ian Lynagh's avatar
Ian Lynagh committed
470
    ppr = text . show
471

472
data ExtensionFlag
473 474 475 476 477 478 479
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
480 481
   | Opt_RelaxedPolyRec           -- Deprecated
   | Opt_ExtendedDefaultRules     -- Use GHC's extended rules for defaulting
482 483
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
484
   | Opt_InterruptibleFFI
485
   | Opt_CApiFFI
486
   | Opt_GHCForeignImportPrim
487 488
   | Opt_ParallelArrays           -- Syntactic support for parallel arrays
   | Opt_Arrows                   -- Arrow-notation syntax
489 490 491 492 493
   | Opt_TemplateHaskell
   | Opt_QuasiQuotes
   | Opt_ImplicitParams
   | Opt_ImplicitPrelude
   | Opt_ScopedTypeVariables
494
   | Opt_AllowAmbiguousTypes
495 496 497 498
   | Opt_UnboxedTuples
   | Opt_BangPatterns
   | Opt_TypeFamilies
   | Opt_OverloadedStrings
499
   | Opt_OverloadedLists
500 501 502 503 504
   | Opt_DisambiguateRecordFields
   | Opt_RecordWildCards
   | Opt_RecordPuns
   | Opt_ViewPatterns
   | Opt_GADTs
Ian Lynagh's avatar
Ian Lynagh committed
505
   | Opt_GADTSyntax
506
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
507
   | Opt_DoAndIfThenElse
508
   | Opt_RebindableSyntax
509
   | Opt_ConstraintKinds
dreixel's avatar
dreixel committed
510
   | Opt_PolyKinds                -- Kind polymorphism
dreixel's avatar
dreixel committed
511
   | Opt_DataKinds                -- Datatype promotion
512 513
   | Opt_InstanceSigs
 
514 515
   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
516
   | Opt_AutoDeriveTypeable       -- Automatic derivation of Typeable
517 518 519
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable
520
   | Opt_DeriveGeneric            -- Allow deriving Generic/1
dreixel's avatar
dreixel committed
521
   | Opt_DefaultSignatures        -- Allow extra signatures for defmeths
522 523 524 525 526 527

   | Opt_TypeSynonymInstances
   | Opt_FlexibleContexts
   | Opt_FlexibleInstances
   | Opt_ConstrainedClassMethods
   | Opt_MultiParamTypeClasses
528
   | Opt_NullaryTypeClasses
529 530 531 532 533 534 535 536
   | Opt_FunctionalDependencies
   | Opt_UnicodeSyntax
   | Opt_ExistentialQuantification
   | Opt_MagicHash
   | Opt_EmptyDataDecls
   | Opt_KindSignatures
   | Opt_ParallelListComp
   | Opt_TransformListComp
537
   | Opt_MonadComprehensions
538 539 540 541 542 543 544 545 546
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
547
   | Opt_ExplicitNamespaces
548 549 550 551 552
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
553
   | Opt_NondecreasingIndentation
554
   | Opt_RelaxedLayout
555
   | Opt_TraditionalRecordSyntax
556
   | Opt_LambdaCase
557
   | Opt_MultiWayIf
558
   | Opt_TypeHoles
559
   | Opt_EmptyCase
560
   deriving (Eq, Enum, Show)
561

562
-- | Contains not only a collection of 'GeneralFlag's but also a plethora of
563
-- information relating to the compilation of a single file or GHC session
564
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
565 566 567
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
568
  settings              :: Settings,
569
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
570 571 572
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
573
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
574
  ruleCheck             :: Maybe String,
575
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
576

577
  simplTickFactor       :: Int,         -- ^ Multiplier for simplifier ticks
578 579
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
580 581
  specConstrRecursive   :: Int,         -- ^ Max number of specialisations for recursive types
                                        --   Not optional; otherwise ForceSpecConstr can diverge.
582
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
583
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
584
                                        --   See CoreMonad.FloatOutSwitches
585
  historySize           :: Int,
586

587
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
588 589 590
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
591
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
592

593
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
594 595

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

600 601 602
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

603
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
604
  objectDir             :: Maybe String,
605
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
606 607
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
608
  dumpDir               :: Maybe String,
609

Ian Lynagh's avatar
Ian Lynagh committed
610 611 612
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
613

614 615 616 617
  canGenerateDynamicToo :: IORef Bool,
  dynObjectSuf          :: String,
  dynHiSuf              :: String,

618 619 620 621 622 623 624 625
  -- 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
626
  outputFile            :: Maybe String,
ian@well-typed.com's avatar
ian@well-typed.com committed
627
  dynOutputFile         :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
628 629
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
630

631
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
632 633
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
634

635 636
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
637 638
  dumpPrefixForce       :: Maybe FilePath,

639
  ldInputs              :: [Option],
640

Ian Lynagh's avatar
Ian Lynagh committed
641 642 643 644 645
  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

646
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
647
  rtsOptsEnabled        :: RtsOptsEnabled,
648

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

651 652 653 654
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

655 656 657 658 659 660
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

661
  --  Package flags
662
  extraPkgConfs         :: [PkgConfRef] -> [PkgConfRef],
663
        -- ^ The @-package-db@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
664
        -- they appeared.
665

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

669
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
670
  -- NB. do not modify this field, it is calculated by
671
  -- Packages.initPackages and Packages.updatePackages.
672
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
673
  pkgState              :: PackageState,
674

675 676 677 678
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
679
  dirsToClean           :: IORef (Map FilePath FilePath),
680 681
  filesToNotIntermediateClean :: IORef [FilePath],

682

683 684 685 686 687
  -- 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),

688
  -- hsc dynamic flags
689 690
  dumpFlags             :: IntSet,
  generalFlags          :: IntSet,
691
  warningFlags          :: IntSet,
692
  -- Don't change this without updating extensionFlags:
693
  language              :: Maybe Language,
694 695
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
696 697 698
  -- 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.
699 700
  thOnLoc               :: SrcSpan,
  newDerivOnLoc         :: SrcSpan,
701
  pkgTrustOnLoc         :: SrcSpan,
702 703
  warnSafeOnLoc         :: SrcSpan,
  warnUnsafeOnLoc       :: SrcSpan,
704 705 706 707
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
708
  extensionFlags        :: IntSet,
Ian Lynagh's avatar
Ian Lynagh committed
709

710 711 712 713 714 715 716 717 718
  -- Unfolding control
  -- See Note [Discounts and thresholds] in CoreUnfold
  ufCreationThreshold   :: Int,
  ufUseThreshold        :: Int,
  ufFunAppDiscount      :: Int,
  ufDictDiscount        :: Int,
  ufKeenessFactor       :: Float,
  ufDearOp              :: Int,

719 720
  maxWorkerArgs         :: Int,

721 722
  ghciHistSize          :: Int,

723
  -- | MsgDoc output action: use "ErrUtils" instead of this if you can
724
  log_action            :: LogAction,
725 726
  flushOut              :: FlushOut,
  flushErr              :: FlushErr,
David Waern's avatar
David Waern committed
727

728
  haddockOptions        :: Maybe String,
729
  ghciScripts           :: [String],
730

731 732
  -- Output style options
  pprUserLength         :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
733
  pprCols               :: Int,
Ian Lynagh's avatar
Ian Lynagh committed
734
  traceLevel            :: Int, -- Standard level is 1. Less verbose is 0.
735

736 737
  useUnicodeQuotes      :: Bool,

738
  -- | what kind of {-# SCC #-} to add automatically
739 740
  profAuto              :: ProfAuto,

741
  interactivePrint      :: Maybe String,
742

743
  llvmVersion           :: IORef Int,
744

tibbe's avatar
tibbe committed
745 746 747
  nextWrapperNum        :: IORef Int,

  -- | Machine dependant flags (-m<blah> stuff)
748 749 750 751
  sseVersion            :: Maybe (Int, Int),  -- (major, minor)

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

754 755 756
class HasDynFlags m where
    getDynFlags :: m DynFlags

Ian Lynagh's avatar
Ian Lynagh committed
757 758
class ContainsDynFlags t where
    extractDynFlags :: t -> DynFlags
759
    replaceDynFlags :: t -> DynFlags -> t
Ian Lynagh's avatar
Ian Lynagh committed
760

761 762 763 764 765
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
766
  | ProfAutoCalls      -- ^ annotate call-sites
Simon Marlow's avatar
Simon Marlow committed
767
  deriving (Enum)
768

769
data Settings = Settings {
770
  sTargetPlatform        :: Platform,    -- Filled in by SysTools
771 772 773 774 775 776 777 778 779
  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,
780 781
  sLdSupportsCompactUnwind :: Bool,
  sLdSupportsBuildId       :: Bool,
782
  sLdSupportsFilelist      :: Bool,
783
  sLdIsGnuLd               :: Bool,
784 785 786 787 788 789 790 791 792 793 794 795 796
  -- commands for particular phases
  sPgm_L                 :: String,
  sPgm_P                 :: (String,[Option]),
  sPgm_F                 :: String,
  sPgm_c                 :: (String,[Option]),
  sPgm_s                 :: (String,[Option]),
  sPgm_a                 :: (String,[Option]),
  sPgm_l                 :: (String,[Option]),
  sPgm_dll               :: (String,[Option]),
  sPgm_T                 :: String,
  sPgm_sysman            :: String,
  sPgm_windres           :: String,
  sPgm_lo                :: (String,[Option]), -- LLVM: opt llvm optimiser
797 798 799 800 801 802 803 804 805 806
  sPgm_lc                :: (String,[Option]), -- LLVM: llc static compiler
  -- options for particular phases
  sOpt_L                 :: [String],
  sOpt_P                 :: [String],
  sOpt_F                 :: [String],
  sOpt_c                 :: [String],
  sOpt_a                 :: [String],
  sOpt_l                 :: [String],
  sOpt_windres           :: [String],
  sOpt_lo                :: [String], -- LLVM: llvm optimiser
807
  sOpt_lc                :: [String], -- LLVM: llc static compiler
808

809
  sPlatformConstants     :: PlatformConstants
810 811
 }

812 813 814
targetPlatform :: DynFlags -> Platform
targetPlatform dflags = sTargetPlatform (settings dflags)

815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854
ghcUsagePath          :: DynFlags -> FilePath
ghcUsagePath dflags = sGhcUsagePath (settings dflags)
ghciUsagePath         :: DynFlags -> FilePath
ghciUsagePath dflags = sGhciUsagePath (settings dflags)
topDir                :: DynFlags -> FilePath
topDir dflags = sTopDir (settings dflags)
tmpDir                :: DynFlags -> String
tmpDir dflags = sTmpDir (settings dflags)
rawSettings           :: DynFlags -> [(String, String)]
rawSettings dflags = sRawSettings (settings dflags)
extraGccViaCFlags     :: DynFlags -> [String]
extraGccViaCFlags dflags = sExtraGccViaCFlags (settings dflags)
systemPackageConfig   :: DynFlags -> FilePath
systemPackageConfig dflags = sSystemPackageConfig (settings dflags)
pgm_L                 :: DynFlags -> String
pgm_L dflags = sPgm_L (settings dflags)
pgm_P                 :: DynFlags -> (String,[Option])
pgm_P dflags = sPgm_P (settings dflags)
pgm_F                 :: DynFlags -> String
pgm_F dflags = sPgm_F (settings dflags)
pgm_c                 :: DynFlags -> (String,[Option])
pgm_c dflags = sPgm_c (settings dflags)
pgm_s                 :: DynFlags -> (String,[Option])
pgm_s dflags = sPgm_s (settings dflags)
pgm_a                 :: DynFlags -> (String,[Option])
pgm_a dflags = sPgm_a (settings dflags)
pgm_l                 :: DynFlags -> (String,[Option])
pgm_l dflags = sPgm_l (settings dflags)
pgm_dll               :: DynFlags -> (String,[Option])
pgm_dll dflags = sPgm_dll (settings dflags)
pgm_T                 :: DynFlags -> String
pgm_T dflags = sPgm_T (settings dflags)
pgm_sysman            :: DynFlags -> String