DynFlags.hs 101 KB
Newer Older
1
-- |
2 3 4 5 6 7
-- Dynamic flags
--
--
-- (c) The University of Glasgow 2005
--

8
-- Most flags are dynamic flags, which means they can change from
9 10 11
-- compilation to compilation using @OPTIONS_GHC@ pragmas, and in a
-- multi-session GHC each session can be using different dynamic
-- flags.  Dynamic flags can also be set at the prompt in GHCi.
12
module DynFlags (
13
        -- * Dynamic flags and associated configuration types
Ian Lynagh's avatar
Ian Lynagh committed
14
        DynFlag(..),
15
        ExtensionFlag(..),
16
        glasgowExtsFlags,
17 18 19 20 21 22
        dopt,
        dopt_set,
        dopt_unset,
        xopt,
        xopt_set,
        xopt_unset,
Ian Lynagh's avatar
Ian Lynagh committed
23
        DynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
24
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
25 26 27 28
        HscTarget(..), isObjectTarget, defaultObjectTarget,
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
Ian Lynagh's avatar
Ian Lynagh committed
29
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
30
        DynLibLoader(..),
31
        fFlags, fLangFlags, xFlags,
32
        DPHBackend(..), dphPackageMaybe,
33
        wayNames,
34 35

        -- ** SafeHaskell
36
        SafeHaskellMode(..),
37
        safeHaskellOn, safeImportsRequired,
38

39 40 41 42 43
        Settings(..),
        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,
44 45
        opt_L, opt_P, opt_F, opt_c, opt_m, opt_a, opt_l,
        opt_windres, opt_lo, opt_lc,
46 47


48
        -- ** Manipulating DynFlags
49
        defaultDynFlags,                -- Settings -> DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
50 51
        initDynFlags,                   -- DynFlags -> IO DynFlags

52
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
53
        getVerbFlags,
Ian Lynagh's avatar
Ian Lynagh committed
54 55 56
        updOptLevel,
        setTmpDir,
        setPackageName,
57
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
58

59
        -- ** Parsing DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
60
        parseDynamicFlags,
61
        parseDynamicNoPackageFlags,
62
        allFlags,
63

64
        supportedLanguagesAndExtensions,
65 66

        -- ** DynFlag C compiler options
67
        picCCOpts,
68 69 70 71 72 73

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

        -- * Compiler configuration suitable for display to the user
74 75 76 77 78 79
        compilerInfo
#ifdef GHCI
-- Only in stage 2 can we be sure that the RTS 
-- exposes the appropriate runtime boolean
        , rtsIsProfiled
#endif
80 81 82 83
  ) where

#include "HsVersions.h"

84
import Platform
85
import Module
Simon Marlow's avatar
Simon Marlow committed
86
import PackageConfig
87
import PrelNames        ( mAIN )
88
import StaticFlags
89
import {-# SOURCE #-} Packages (PackageState)
Ian Lynagh's avatar
Ian Lynagh committed
90
import DriverPhases     ( Phase(..), phaseInputExt )
91 92
import Config
import CmdLineParser
Ian Lynagh's avatar
Ian Lynagh committed
93
import Constants        ( mAX_CONTEXT_REDUCTION_DEPTH )
94
import Panic
95
import Util
96
import Maybes           ( orElse )
97
import SrcLoc
98
import FastString
Simon Marlow's avatar
Simon Marlow committed
99
import Outputable
Ian Lynagh's avatar
Ian Lynagh committed
100
#ifdef GHCI
101
import Foreign.C	( CInt )
Ian Lynagh's avatar
Ian Lynagh committed
102
#endif
Simon Marlow's avatar
Simon Marlow committed
103
import {-# SOURCE #-} ErrUtils ( Severity(..), Message, mkLocMessage )
104

Ian Lynagh's avatar
Ian Lynagh committed
105
#ifdef GHCI
106
import System.IO.Unsafe	( unsafePerformIO )
Ian Lynagh's avatar
Ian Lynagh committed
107
#endif
108
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
109
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
110

111
import Data.Char
112
import Data.List
113 114
import Data.Map (Map)
import qualified Data.Map as Map
115 116
import Data.Set (Set)
import qualified Data.Set as Set
Ian Lynagh's avatar
Ian Lynagh committed
117
import System.FilePath
118
import System.IO        ( stderr, hPutChar )
119

120 121 122
-- -----------------------------------------------------------------------------
-- DynFlags

123
-- | Enumerates the simple on-or-off dynamic flags
124 125 126 127
data DynFlag

   -- debugging flags
   = Opt_D_dump_cmm
128
   | Opt_D_dump_raw_cmm
129
   | Opt_D_dump_cmmz
130
   | Opt_D_dump_cmmz_pretty
131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
   -- All of the cmmz subflags (there are a lot!)  Automatically
   -- enabled if you run -ddump-cmmz
   | Opt_D_dump_cmmz_cbe
   | Opt_D_dump_cmmz_proc
   | Opt_D_dump_cmmz_spills
   | Opt_D_dump_cmmz_rewrite
   | Opt_D_dump_cmmz_dead
   | Opt_D_dump_cmmz_stub
   | Opt_D_dump_cmmz_sp
   | Opt_D_dump_cmmz_procmap
   | Opt_D_dump_cmmz_split
   | Opt_D_dump_cmmz_lower
   | Opt_D_dump_cmmz_info
   | Opt_D_dump_cmmz_cafs
   -- end cmmz subflags
146
   | Opt_D_dump_cps_cmm
147
   | Opt_D_dump_cvt_cmm
148
   | Opt_D_dump_asm
149 150
   | Opt_D_dump_asm_native
   | Opt_D_dump_asm_liveness
151
   | Opt_D_dump_asm_coalesce
152 153 154
   | Opt_D_dump_asm_regalloc
   | Opt_D_dump_asm_regalloc_stages
   | Opt_D_dump_asm_conflicts
155
   | Opt_D_dump_asm_stats
156
   | Opt_D_dump_asm_expanded
157
   | Opt_D_dump_llvm
158
   | Opt_D_dump_core_stats
159 160 161 162 163 164
   | Opt_D_dump_cpranal
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_flatC
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
165
   | Opt_D_dump_rule_firings
166
   | Opt_D_dump_rule_rewrites
167 168 169
   | Opt_D_dump_occur_anal
   | Opt_D_dump_parsed
   | Opt_D_dump_rn
170
   | Opt_D_dump_core_pipeline -- TODO FIXME: dump after simplifier stats
171 172
   | Opt_D_dump_simpl
   | Opt_D_dump_simpl_iterations
173
   | Opt_D_dump_simpl_phases
174 175 176 177 178 179 180 181 182 183 184 185 186
   | 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
187
   | Opt_D_dump_cs_trace	-- Constraint solver in type checker
188 189
   | Opt_D_dump_tc_trace
   | Opt_D_dump_if_trace
190
   | Opt_D_dump_vt_trace
191 192 193
   | Opt_D_dump_splices
   | Opt_D_dump_BCOs
   | Opt_D_dump_vect
andy@galois.com's avatar
andy@galois.com committed
194
   | Opt_D_dump_hpc
pepe's avatar
pepe committed
195
   | Opt_D_dump_rtti
196 197 198 199 200 201
   | Opt_D_source_stats
   | Opt_D_verbose_core2core
   | Opt_D_verbose_stg2stg
   | Opt_D_dump_hi
   | Opt_D_dump_hi_diffs
   | Opt_D_dump_minimal_imports
202
   | Opt_D_dump_mod_cycles
203
   | Opt_D_dump_view_pattern_commoning
204
   | Opt_D_faststring_stats
Ian Lynagh's avatar
Ian Lynagh committed
205
   | Opt_DumpToFile                     -- ^ Append dump output to files instead of stdout.
Simon Marlow's avatar
Simon Marlow committed
206
   | Opt_D_no_debug_output
207 208 209
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
210
   | Opt_DoAsmLinting
211

Ian Lynagh's avatar
Ian Lynagh committed
212
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
213 214
   | Opt_WarnDuplicateExports
   | Opt_WarnHiShadows
215
   | Opt_WarnImplicitPrelude
216
   | Opt_WarnIncompletePatterns
217
   | Opt_WarnIncompleteUniPatterns
218 219
   | Opt_WarnIncompletePatternsRecUpd
   | Opt_WarnMissingFields
220
   | Opt_WarnMissingImportList
221 222
   | Opt_WarnMissingMethods
   | Opt_WarnMissingSigs
223
   | Opt_WarnMissingLocalSigs
224 225 226
   | Opt_WarnNameShadowing
   | Opt_WarnOverlappingPatterns
   | Opt_WarnTypeDefaults
227
   | Opt_WarnMonomorphism
228 229 230
   | Opt_WarnUnusedBinds
   | Opt_WarnUnusedImports
   | Opt_WarnUnusedMatches
Ian Lynagh's avatar
Ian Lynagh committed
231
   | Opt_WarnWarningsDeprecations
232
   | Opt_WarnDeprecatedFlags
233
   | Opt_WarnDodgyExports
234 235
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
236
   | Opt_WarnAutoOrphans
237
   | Opt_WarnIdentities
238
   | Opt_WarnTabs
239
   | Opt_WarnUnrecognisedPragmas
240
   | Opt_WarnDodgyForeignImports
241
   | Opt_WarnLazyUnliftedBindings
242 243
   | Opt_WarnUnusedDoBind
   | Opt_WarnWrongDoBind
244
   | Opt_WarnAlternativeLayoutRuleTransitional
245

246 247
   | Opt_PrintExplicitForalls

248 249 250
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
251 252
   | Opt_FloatIn
   | Opt_Specialise
253
   | Opt_StaticArgumentTransformation
254
   | Opt_CSE
255 256
   | Opt_LiberateCase
   | Opt_SpecConstr
257 258 259 260 261
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
262
   | Opt_MethodSharing	-- Now a no-op; remove in GHC 7.2
263
   | Opt_DictsCheap
264
   | Opt_EnableRewriteRules		-- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
265
   | Opt_Vectorise
Ian Lynagh's avatar
Ian Lynagh committed
266 267
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
268

269 270 271 272 273
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
274 275 276 277 278
   -- profiling opts
   | Opt_AutoSccsOnAllToplevs
   | Opt_AutoSccsOnExportedToplevs
   | Opt_AutoSccsOnIndividualCafs

279 280
   -- misc opts
   | Opt_Pp
281
   | Opt_ForceRecomp
282
   | Opt_ExcessPrecision
283
   | Opt_EagerBlackHoling
284 285 286 287
   | Opt_ReadUserPackageConf
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
288
   | Opt_HideAllPackages
289
   | Opt_PrintBindResult
290
   | Opt_Haddock
David Waern's avatar
David Waern committed
291
   | Opt_HaddockOptions
292
   | Opt_Hpc_No_Auto
293
   | Opt_BreakOnException
294
   | Opt_BreakOnError
295
   | Opt_PrintEvldWithShow
296
   | Opt_PrintBindContents
297 298
   | Opt_GenManifest
   | Opt_EmbedManifest
299
   | Opt_EmitExternalCore
Ian Lynagh's avatar
Ian Lynagh committed
300
   | Opt_SharedImplib
301
   | Opt_BuildingCabalPackage
302
   | Opt_SSE2
303
   | Opt_GhciSandbox
304
   | Opt_HelpfulErrors
305 306 307

	-- temporary flags
   | Opt_RunCPS
308 309
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
310
   | Opt_AutoLinkPackages
311
   | Opt_ImplicitImportQualified
312
   | Opt_TryNewCodeGen
313 314 315 316 317 318

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
319
   | Opt_KeepRawTokenStream
320
   | Opt_KeepLlvmFiles
321

322
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
323

324 325
data Language = Haskell98 | Haskell2010

326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
-- | The various SafeHaskell modes
data SafeHaskellMode
   = Sf_None
   | Sf_SafeImports
   | Sf_SafeLanguage
   | Sf_Trustworthy
   | Sf_TrustworthyWithSafeLanguage
   | Sf_Safe
   deriving (Eq)

instance Show SafeHaskellMode where
    show Sf_None = "None"
    show Sf_SafeImports = "SafeImports"
    show Sf_SafeLanguage = "SafeLanguage"
    show Sf_Trustworthy = "Trustworthy"
    show Sf_TrustworthyWithSafeLanguage = "Trustworthy + SafeLanguage"
    show Sf_Safe = "Safe"

344
data ExtensionFlag
345 346 347 348 349 350 351
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
352
   | Opt_RelaxedPolyRec		-- Deprecated
353 354 355 356
   | Opt_ExtendedDefaultRules           -- Use GHC's extended rules for defaulting
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
   | Opt_GHCForeignImportPrim
benl's avatar
benl committed
357
   | Opt_ParallelArrays                 -- Syntactic support for parallel arrays
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372
   | Opt_Arrows                         -- Arrow-notation syntax
   | Opt_TemplateHaskell
   | Opt_QuasiQuotes
   | Opt_ImplicitParams
   | Opt_ImplicitPrelude
   | Opt_ScopedTypeVariables
   | Opt_UnboxedTuples
   | Opt_BangPatterns
   | Opt_TypeFamilies
   | Opt_OverloadedStrings
   | Opt_DisambiguateRecordFields
   | Opt_RecordWildCards
   | Opt_RecordPuns
   | Opt_ViewPatterns
   | Opt_GADTs
Ian Lynagh's avatar
Ian Lynagh committed
373
   | Opt_GADTSyntax
374
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
375
   | Opt_DoAndIfThenElse
376
   | Opt_RebindableSyntax
377 378 379 380 381 382

   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable
383
   | Opt_DeriveGeneric            -- Allow deriving Generic/1
dreixel's avatar
dreixel committed
384 385
   | Opt_DefaultSignatures        -- Allow extra signatures for defmeths
   | Opt_Generics                 -- Old generic classes, now deprecated
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400

   | Opt_TypeSynonymInstances
   | Opt_FlexibleContexts
   | Opt_FlexibleInstances
   | Opt_ConstrainedClassMethods
   | Opt_MultiParamTypeClasses
   | Opt_FunctionalDependencies
   | Opt_UnicodeSyntax
   | Opt_PolymorphicComponents
   | Opt_ExistentialQuantification
   | Opt_MagicHash
   | Opt_EmptyDataDecls
   | Opt_KindSignatures
   | Opt_ParallelListComp
   | Opt_TransformListComp
401
   | Opt_MonadComprehensions
402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417
   | Opt_GeneralizedNewtypeDeriving
   | Opt_RecursiveDo
   | Opt_DoRec
   | Opt_PostfixOperators
   | Opt_TupleSections
   | Opt_PatternGuards
   | Opt_LiberalTypeSynonyms
   | Opt_Rank2Types
   | Opt_RankNTypes
   | Opt_ImpredicativeTypes
   | Opt_TypeOperators
   | Opt_PackageImports
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
418
   | Opt_NondecreasingIndentation
419
   | Opt_RelaxedLayout
420 421
   deriving (Eq, Show)

422 423
-- | Contains not only a collection of 'DynFlag's but also a plethora of
-- information relating to the compilation of a single file or GHC session
424
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
425 426 427
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
428
  hscOutName            :: String,      -- ^ Name of the output file
429
  extCoreName           :: String,      -- ^ Name of the .hcr output file
430
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
431 432 433
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
434
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
435
  ruleCheck             :: Maybe String,
436
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
437

438 439 440
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
441 442
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
  			   	 	--   See CoreMonad.FloatOutSwitches
443

Ian Lynagh's avatar
Ian Lynagh committed
444
  targetPlatform        :: Platform.Platform, -- ^ The platform we're compiling for. Used by the NCG.
445
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
446 447 448
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
449
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
450

451 452
  dphBackend            :: DPHBackend,

453
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
454 455

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

460 461 462
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

463
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
464
  objectDir             :: Maybe String,
465
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
466 467
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
468

Ian Lynagh's avatar
Ian Lynagh committed
469 470 471
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
472

Ian Lynagh's avatar
Ian Lynagh committed
473 474 475
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
476

477
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
478 479
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
480

481 482
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
483 484 485 486 487 488 489
  dumpPrefixForce       :: Maybe FilePath,

  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto

490
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
491
  rtsOptsEnabled        :: RtsOptsEnabled,
492

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

495 496 497 498
  -- Plugins
  pluginModNames        :: [ModuleName],
  pluginModNameOpts     :: [(ModuleName,String)],

499
  settings              :: Settings,
500

501 502 503 504 505 506
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

507
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
508
  extraPkgConfs         :: [FilePath],
509
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
510
        -- they appeared.
511

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

515
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
516
  -- NB. do not modify this field, it is calculated by
517
  -- Packages.initPackages and Packages.updatePackages.
518
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
519
  pkgState              :: PackageState,
520

521 522 523 524
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
525
  dirsToClean           :: IORef (Map FilePath FilePath),
526

527 528 529 530 531
  -- 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),

532
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
533
  flags                 :: [DynFlag],
534
  -- Don't change this without updating extensionFlags:
535
  language              :: Maybe Language,
536 537
  -- | Safe Haskell mode
  safeHaskell           :: SafeHaskellMode,
538 539 540 541 542
  -- Don't change this without updating extensionFlags:
  extensions            :: [OnOff ExtensionFlag],
  -- extensionFlags should always be equal to
  --     flattenExtensionFlags language extensions
  extensionFlags        :: [ExtensionFlag],
Ian Lynagh's avatar
Ian Lynagh committed
543

544
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
545 546 547
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
548 549
 }

550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
data Settings = Settings {
  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,
  -- 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
573 574 575 576 577 578 579 580 581 582 583 584 585
  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_m                 :: [String],
  sOpt_a                 :: [String],
  sOpt_l                 :: [String],
  sOpt_windres           :: [String],
  sOpt_lo                :: [String], -- LLVM: llvm optimiser
  sOpt_lc                :: [String]  -- LLVM: llc static compiler

586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627
 }

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
pgm_sysman dflags = sPgm_sysman (settings dflags)
pgm_windres           :: DynFlags -> String
pgm_windres dflags = sPgm_windres (settings dflags)
pgm_lo                :: DynFlags -> (String,[Option])
pgm_lo dflags = sPgm_lo (settings dflags)
pgm_lc                :: DynFlags -> (String,[Option])
pgm_lc dflags = sPgm_lc (settings dflags)
628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647
opt_L                 :: DynFlags -> [String]
opt_L dflags = sOpt_L (settings dflags)
opt_P                 :: DynFlags -> [String]
opt_P dflags = sOpt_P (settings dflags)
opt_F                 :: DynFlags -> [String]
opt_F dflags = sOpt_F (settings dflags)
opt_c                 :: DynFlags -> [String]
opt_c dflags = sOpt_c (settings dflags)
opt_m                 :: DynFlags -> [String]
opt_m dflags = sOpt_m (settings dflags)
opt_a                 :: DynFlags -> [String]
opt_a dflags = sOpt_a (settings dflags)
opt_l                 :: DynFlags -> [String]
opt_l dflags = sOpt_l (settings dflags)
opt_windres           :: DynFlags -> [String]
opt_windres dflags = sOpt_windres (settings dflags)
opt_lo                :: DynFlags -> [String]
opt_lo dflags = sOpt_lo (settings dflags)
opt_lc                :: DynFlags -> [String]
opt_lc dflags = sOpt_lc (settings dflags)
648

649 650 651
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

652 653
-- | The target code type of the compilation (if any).
--
654 655 656
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
657 658 659 660
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
661 662 663
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
664
--
665 666 667 668 669 670
--  * If a program uses Template Haskell the typechecker may try to run code
--    from an imported module.  This will fail if no code has been generated
--    for this module.  You can use 'GHC.needsTemplateHaskell' to detect
--    whether this might be the case and choose to either switch to a
--    different target or avoid typechecking such modules.  (The latter may
--    preferable for security reasons.)
671
--
672
data HscTarget
673 674
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
675
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
676 677
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
678 679
  deriving (Eq, Show)

Ian Lynagh's avatar
Ian Lynagh committed
680 681 682 683 684 685 686
showHscTargetFlag :: HscTarget -> String
showHscTargetFlag HscC           = "-fvia-c"
showHscTargetFlag HscAsm         = "-fasm"
showHscTargetFlag HscLlvm        = "-fllvm"
showHscTargetFlag HscInterpreted = "-fbyte-code"
showHscTargetFlag HscNothing     = "-fno-code"

687
-- | Will this target result in an object file on the disk?
688 689 690
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
691
isObjectTarget HscLlvm  = True
692 693 694 695 696 697 698 699
isObjectTarget _        = False

-- | The 'GhcMode' tells us whether we're doing multi-module
-- compilation (controlled via the "GHC" API) or one-shot
-- (single-module) compilation.  This makes a difference primarily to
-- the "Finder": in one-shot mode we look for interface files for
-- imported modules, but in multi-module mode we look for source files
-- in order to check whether they need to be recompiled.
700
data GhcMode
701 702 703
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
704 705
  deriving Eq

706 707 708 709 710
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

711 712 713 714
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

715 716 717 718
-- | What to do in the link step, if there is one.
data GhcLink
  = NoLink              -- ^ Don't link at all
  | LinkBinary          -- ^ Link object code into a binary
719 720
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
721
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
722
  deriving (Eq, Show)
723 724 725

isNoLink :: GhcLink -> Bool
isNoLink NoLink = True
twanvl's avatar
twanvl committed
726
isNoLink _      = False
727

728 729 730
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
731 732 733
doingTickyProfiling _ = opt_Ticky
  -- XXX -ticky is a static flag, because it implies -debug which is also
  -- static.  If the way flags were made dynamic, we could fix this.
734

735 736
data PackageFlag
  = ExposePackage  String
737
  | ExposePackageId String
738 739
  | HidePackage    String
  | IgnorePackage  String
740
  deriving Eq
741

twanvl's avatar
twanvl committed
742
defaultHscTarget :: HscTarget
743 744
defaultHscTarget = defaultObjectTarget

745
-- | The 'HscTarget' value corresponding to the default way to create
746
-- object files on the current platform.
twanvl's avatar
twanvl committed
747
defaultObjectTarget :: HscTarget
748
defaultObjectTarget
749
  | cGhcUnregisterised    == "YES"      =  HscC
Ian Lynagh's avatar
Ian Lynagh committed
750
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
751
  | otherwise                           =  HscLlvm
752

753 754 755 756 757
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
758
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll
759
  deriving (Show)
Ian Lynagh's avatar
Ian Lynagh committed
760

761
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
762
initDynFlags :: DynFlags -> IO DynFlags
763 764 765
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
766
 refFilesToClean <- newIORef []
767
 refDirsToClean <- newIORef Map.empty
768
 refGeneratedDumps <- newIORef Set.empty
769
 return dflags{
770 771 772
        ways            = ways,
        buildTag        = mkBuildTag (filter (not . wayRTSOnly) ways),
        rtsBuildTag     = mkBuildTag ways,
773
        filesToClean    = refFilesToClean,
774 775
        dirsToClean     = refDirsToClean,
        generatedDumps   = refGeneratedDumps
Ian Lynagh's avatar
Ian Lynagh committed
776
        }
777

778 779
-- | The normal 'DynFlags'. Note that they is not suitable for use in this form
-- and must be fully initialized by 'GHC.newSession' first.
780 781
defaultDynFlags :: Settings -> DynFlags
defaultDynFlags mySettings =
782
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
783 784 785 786 787 788 789
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
790
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
791
        maxSimplIterations      = 4,
792
        shouldDumpSimplPhase    = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
793
        ruleCheck               = Nothing,
794
        specConstrThreshold     = Just 2000,
Ian Lynagh's avatar
Ian Lynagh committed
795
        specConstrCount         = Just 3,
796
        liberateCaseThreshold   = Just 2000,
797
        floatLamArgs            = Just 0,	-- Default: float only if no fvs
798 799
        strictnessBefore        = [],

800
        targetPlatform          = defaultTargetPlatform,
Ian Lynagh's avatar
Ian Lynagh committed
801 802 803 804 805 806
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
807
        dphBackend              = DPHNone,
808

Ian Lynagh's avatar
Ian Lynagh committed
809 810 811
        thisPackage             = mainPackageId,

        objectDir               = Nothing,
812
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
813 814 815 816 817 818 819
        hiDir                   = Nothing,
        stubDir                 = Nothing,

        objectSuf               = phaseInputExt StopLn,
        hcSuf                   = phaseInputExt HCc,
        hiSuf                   = "hi",

820 821 822
        pluginModNames          = [],
        pluginModNameOpts       = [],

Ian Lynagh's avatar
Ian Lynagh committed
823 824
        outputFile              = Nothing,
        outputHi                = Nothing,
825
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
826 827 828 829 830 831
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
832
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
833
        rtsOptsEnabled          = RtsOptsSafeOnly,
Ian Lynagh's avatar
Ian Lynagh committed
834 835 836 837 838

        hpcDir                  = ".hpc",

        extraPkgConfs           = [],
        packageFlags            = [],
839 840
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
841
        ways                    = panic "defaultDynFlags: No ways",
Ian Lynagh's avatar
Ian Lynagh committed
842 843
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
844
        splitInfo               = Nothing,
845
        settings                = mySettings,
846 847 848 849 850 851
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        -- end of ghc -M values
852 853
        filesToClean   = panic "defaultDynFlags: No filesToClean",
        dirsToClean    = panic "defaultDynFlags: No dirsToClean",
854
        generatedDumps = panic "defaultDynFlags: No generatedDumps",
Ian Lynagh's avatar
Ian Lynagh committed
855
        haddockOptions = Nothing,
856
        flags = defaultFlags,
857
        language = Nothing,
858
        safeHaskell = Sf_None,
859 860
        extensions = [],
        extensionFlags = flattenExtensionFlags Nothing [],
861

Ian Lynagh's avatar
Ian Lynagh committed
862
        log_action = \severity srcSpan style msg ->
863
                        case severity of
864 865 866
                          SevOutput -> printSDoc msg style
                          SevInfo   -> printErrs msg style
                          SevFatal  -> printErrs msg style
867
                          _         -> do 
868
                                hPutChar stderr '\n'
869
                                printErrs (mkLocMessage srcSpan msg) style
870 871 872
                     -- careful (#2302): printErrs prints in UTF-8, whereas
                     -- converting to string first and using hPutStr would
                     -- just emit the low 8 bits of each unicode char.
873 874
      }

Ian Lynagh's avatar
Ian Lynagh committed
875
{-
876 877
Note [Verbosity levels]
~~~~~~~~~~~~~~~~~~~~~~~
Ian Lynagh's avatar
Ian Lynagh committed
878
    0   |   print errors & warnings only
879 880 881 882 883 884 885
    1   |   minimal verbosity: print "compiling M ... done." for each module.
    2   |   equivalent to -dshow-passes
    3   |   equivalent to existing "ghc -v"
    4   |   "ghc -v -ddump-most"
    5   |   "ghc -v -ddump-all"
-}

886 887 888 889 890
data OnOff a = On a
             | Off a

-- OnOffs accumulate in reverse order, so we use foldr in order to
-- process them in the right order
891 892 893
flattenExtensionFlags :: Maybe Language -> [OnOff ExtensionFlag]
                      -> [ExtensionFlag]
flattenExtensionFlags ml = foldr f defaultExtensionFlags
894 895
    where f (On f)  flags = f : delete f flags
          f (Off f) flags =     delete f flags
896 897 898
          defaultExtensionFlags = languageExtensions ml

languageExtensions :: Maybe Language -> [ExtensionFlag]
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
899

900
languageExtensions Nothing
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
901
    -- Nothing => the default case
902 903 904
    = Opt_MonoPatBinds   -- Experimentally, I'm making this non-standard
                         -- behaviour the default, to see if anyone notices
                         -- SLPJ July 06
Ian Lynagh's avatar
Ian Lynagh committed
905
      -- In due course I'd like Opt_MonoLocalBinds to be on by default
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
906
      -- But NB it's implied by GADTs etc
Ian Lynagh's avatar
Ian Lynagh committed
907
      -- SLPJ September 2010
908
    : Opt_NondecreasingIndentation -- This has been on by default for some time
909 910 911 912 913
    : delete Opt_DatatypeContexts  -- The Haskell' committee decided to
                                   -- remove datatype contexts from the
                                   -- language:
   -- http://www.haskell.org/pipermail/haskell-prime/2011-January/003335.html
      (languageExtensions (Just Haskell2010))
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
914

915 916 917 918
languageExtensions (Just Haskell98)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_NPlusKPatterns,
919 920 921 922 923 924 925 926
       Opt_DatatypeContexts,
       Opt_NondecreasingIndentation
           -- strictly speaking non-standard, but we always had this
           -- on implicitly before the option was added in 7.1, and
           -- turning it off breaks code, so we're keeping it on for
           -- backwards compatibility.  Cabal uses -XHaskell98 by
           -- default unless you specify another language.
      ]
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
927

928 929 930 931 932 933 934
languageExtensions (Just Haskell2010)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_DatatypeContexts,
       Opt_EmptyDataDecls,
       Opt_ForeignFunctionInterface,
       Opt_PatternGuards,
Ian Lynagh's avatar
Ian Lynagh committed
935
       Opt_DoAndIfThenElse,
936
       Opt_RelaxedPolyRec]
937