DynFlags.hs 95.9 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 36 37 38 39
        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,
40 41
        opt_L, opt_P, opt_F, opt_c, opt_m, opt_a, opt_l,
        opt_windres, opt_lo, opt_lc,
42 43


44
        -- ** Manipulating DynFlags
45
        defaultDynFlags,                -- Settings -> DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
46 47
        initDynFlags,                   -- DynFlags -> IO DynFlags

48
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
49
        getVerbFlags,
Ian Lynagh's avatar
Ian Lynagh committed
50 51 52
        updOptLevel,
        setTmpDir,
        setPackageName,
53
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
54

55
        -- ** Parsing DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
56
        parseDynamicFlags,
57
        parseDynamicNoPackageFlags,
58
        allFlags,
59

60
        supportedLanguagesAndExtensions,
61 62

        -- ** DynFlag C compiler options
63
        picCCOpts,
64 65 66 67 68 69

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

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

#include "HsVersions.h"

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

Ian Lynagh's avatar
Ian Lynagh committed
101
#ifdef GHCI
102
import System.IO.Unsafe	( unsafePerformIO )
Ian Lynagh's avatar
Ian Lynagh committed
103
#endif
104
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
105
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
106

107
import Data.Char
108
import Data.List
109 110
import Data.Map (Map)
import qualified Data.Map as Map
111 112
import Data.Set (Set)
import qualified Data.Set as Set
Ian Lynagh's avatar
Ian Lynagh committed
113
import System.FilePath
114
import System.IO        ( stderr, hPutChar )
115

116 117 118
-- -----------------------------------------------------------------------------
-- DynFlags

119
-- | Enumerates the simple on-or-off dynamic flags
120 121 122 123
data DynFlag

   -- debugging flags
   = Opt_D_dump_cmm
124
   | Opt_D_dump_raw_cmm
125
   | Opt_D_dump_cmmz
126
   | Opt_D_dump_cmmz_pretty
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141
   -- 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
142
   | Opt_D_dump_cps_cmm
143
   | Opt_D_dump_cvt_cmm
144
   | Opt_D_dump_asm
145 146
   | Opt_D_dump_asm_native
   | Opt_D_dump_asm_liveness
147
   | Opt_D_dump_asm_coalesce
148 149 150
   | Opt_D_dump_asm_regalloc
   | Opt_D_dump_asm_regalloc_stages
   | Opt_D_dump_asm_conflicts
151
   | Opt_D_dump_asm_stats
152
   | Opt_D_dump_asm_expanded
153
   | Opt_D_dump_llvm
154
   | Opt_D_dump_core_stats
155 156 157 158 159 160
   | Opt_D_dump_cpranal
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_flatC
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
161
   | Opt_D_dump_rule_firings
162
   | Opt_D_dump_rule_rewrites
163 164 165 166 167
   | Opt_D_dump_occur_anal
   | Opt_D_dump_parsed
   | Opt_D_dump_rn
   | Opt_D_dump_simpl
   | Opt_D_dump_simpl_iterations
168
   | Opt_D_dump_simpl_phases
169 170 171 172 173 174 175 176 177 178 179 180 181
   | 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
182
   | Opt_D_dump_cs_trace	-- Constraint solver in type checker
183 184
   | Opt_D_dump_tc_trace
   | Opt_D_dump_if_trace
185
   | Opt_D_dump_vt_trace
186 187 188
   | Opt_D_dump_splices
   | Opt_D_dump_BCOs
   | Opt_D_dump_vect
andy@galois.com's avatar
andy@galois.com committed
189
   | Opt_D_dump_hpc
pepe's avatar
pepe committed
190
   | Opt_D_dump_rtti
191 192 193 194 195 196
   | 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
197
   | Opt_D_dump_mod_cycles
198
   | Opt_D_dump_view_pattern_commoning
199
   | Opt_D_faststring_stats
Ian Lynagh's avatar
Ian Lynagh committed
200
   | Opt_DumpToFile                     -- ^ Append dump output to files instead of stdout.
Simon Marlow's avatar
Simon Marlow committed
201
   | Opt_D_no_debug_output
202 203 204
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
205
   | Opt_DoAsmLinting
206

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

241 242
   | Opt_PrintExplicitForalls

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

264 265 266 267 268
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
269 270 271 272 273
   -- profiling opts
   | Opt_AutoSccsOnAllToplevs
   | Opt_AutoSccsOnExportedToplevs
   | Opt_AutoSccsOnIndividualCafs

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

	-- temporary flags
   | Opt_RunCPS
304 305
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
306
   | Opt_AutoLinkPackages
307
   | Opt_ImplicitImportQualified
308
   | Opt_TryNewCodeGen
309 310 311 312 313 314

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
315
   | Opt_KeepRawTokenStream
316
   | Opt_KeepLlvmFiles
317

318
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
319

320 321
data Language = Haskell98 | Haskell2010

322
data ExtensionFlag
323 324 325 326 327 328 329
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
330
   | Opt_RelaxedPolyRec		-- Deprecated
331 332 333 334
   | Opt_ExtendedDefaultRules           -- Use GHC's extended rules for defaulting
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
   | Opt_GHCForeignImportPrim
benl's avatar
benl committed
335
   | Opt_ParallelArrays                 -- Syntactic support for parallel arrays
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
   | Opt_Arrows                         -- Arrow-notation syntax
   | Opt_TemplateHaskell
   | Opt_QuasiQuotes
   | Opt_ImplicitParams
   | Opt_Generics			-- "Derivable type classes"
   | 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
352
   | Opt_GADTSyntax
353
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
354
   | Opt_DoAndIfThenElse
355
   | Opt_RebindableSyntax
356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376

   | Opt_StandaloneDeriving
   | Opt_DeriveDataTypeable
   | Opt_DeriveFunctor
   | Opt_DeriveTraversable
   | Opt_DeriveFoldable

   | 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
377
   | Opt_MonadComprehensions
378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
   | 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
394
   | Opt_NondecreasingIndentation
395
   | Opt_RelaxedLayout
396 397
   deriving (Eq, Show)

398 399
-- | 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
400
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
401 402 403
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
404
  hscOutName            :: String,      -- ^ Name of the output file
405
  extCoreName           :: String,      -- ^ Name of the .hcr output file
406
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
407 408 409
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
410
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
411
  ruleCheck             :: Maybe String,
412
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
413

414 415 416
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
417 418
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
  			   	 	--   See CoreMonad.FloatOutSwitches
419

Ian Lynagh's avatar
Ian Lynagh committed
420
  targetPlatform        :: Platform.Platform, -- ^ The platform we're compiling for. Used by the NCG.
421
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
422 423 424
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
425
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
426

427 428
  dphBackend            :: DPHBackend,

429
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
430 431

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

436 437 438
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

439
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
440
  objectDir             :: Maybe String,
441
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
442 443
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
444

Ian Lynagh's avatar
Ian Lynagh committed
445 446 447
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
448

Ian Lynagh's avatar
Ian Lynagh committed
449 450 451
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
452

453
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
454 455
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
456

457 458
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
459 460 461 462 463 464 465
  dumpPrefixForce       :: Maybe FilePath,

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

466
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
467
  rtsOptsEnabled        :: RtsOptsEnabled,
468

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

471
  settings              :: Settings,
472

473 474 475 476 477 478
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

479
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
480
  extraPkgConfs         :: [FilePath],
481
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
482
        -- they appeared.
483

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

487
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
488
  -- NB. do not modify this field, it is calculated by
489
  -- Packages.initPackages and Packages.updatePackages.
490
  pkgDatabase           :: Maybe [PackageConfig],
Ian Lynagh's avatar
Ian Lynagh committed
491
  pkgState              :: PackageState,
492

493 494 495 496
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
497
  dirsToClean           :: IORef (Map FilePath FilePath),
498

499 500 501 502 503
  -- 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),

504
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
505
  flags                 :: [DynFlag],
506
  -- Don't change this without updating extensionFlags:
507
  language              :: Maybe Language,
508 509 510 511 512
  -- 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
513

514
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
515 516 517
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
518 519
 }

520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542
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
543 544 545 546 547 548 549 550 551 552 553 554 555
  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

556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597
 }

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)
598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617
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)
618

619 620 621
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

622 623
-- | The target code type of the compilation (if any).
--
624 625 626
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
627 628 629 630
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
631 632 633
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
634
--
635 636 637 638 639 640
--  * 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.)
641
--
642
data HscTarget
643 644
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
645
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
646 647 648
  | HscJava        -- ^ Generate Java bytecode.
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
649 650
  deriving (Eq, Show)

Ian Lynagh's avatar
Ian Lynagh committed
651 652 653 654 655 656 657 658
showHscTargetFlag :: HscTarget -> String
showHscTargetFlag HscC           = "-fvia-c"
showHscTargetFlag HscAsm         = "-fasm"
showHscTargetFlag HscLlvm        = "-fllvm"
showHscTargetFlag HscJava        = panic "No flag for HscJava"
showHscTargetFlag HscInterpreted = "-fbyte-code"
showHscTargetFlag HscNothing     = "-fno-code"

659
-- | Will this target result in an object file on the disk?
660 661 662
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
663
isObjectTarget HscLlvm  = True
664 665 666 667 668 669 670 671
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.
672
data GhcMode
673 674 675
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
676 677
  deriving Eq

678 679 680 681 682
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

683 684 685 686
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

687 688 689 690
-- | 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
691 692
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
693
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
694
  deriving (Eq, Show)
695 696 697

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

700 701 702
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
703 704 705
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.
706

707 708
data PackageFlag
  = ExposePackage  String
709
  | ExposePackageId String
710 711
  | HidePackage    String
  | IgnorePackage  String
712
  deriving Eq
713

twanvl's avatar
twanvl committed
714
defaultHscTarget :: HscTarget
715 716
defaultHscTarget = defaultObjectTarget

717
-- | The 'HscTarget' value corresponding to the default way to create
718
-- object files on the current platform.
twanvl's avatar
twanvl committed
719
defaultObjectTarget :: HscTarget
720
defaultObjectTarget
721
  | cGhcUnregisterised    == "YES"      =  HscC
Ian Lynagh's avatar
Ian Lynagh committed
722
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
723
  | otherwise                           =  HscLlvm
724

725 726 727 728 729
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
730
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll
731
  deriving (Show)
Ian Lynagh's avatar
Ian Lynagh committed
732

733
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
734
initDynFlags :: DynFlags -> IO DynFlags
735 736 737
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
738
 refFilesToClean <- newIORef []
739
 refDirsToClean <- newIORef Map.empty
740
 refGeneratedDumps <- newIORef Set.empty
741
 return dflags{
742 743 744
        ways            = ways,
        buildTag        = mkBuildTag (filter (not . wayRTSOnly) ways),
        rtsBuildTag     = mkBuildTag ways,
745
        filesToClean    = refFilesToClean,
746 747
        dirsToClean     = refDirsToClean,
        generatedDumps   = refGeneratedDumps
Ian Lynagh's avatar
Ian Lynagh committed
748
        }
749

750 751
-- | The normal 'DynFlags'. Note that they is not suitable for use in this form
-- and must be fully initialized by 'GHC.newSession' first.
752 753
defaultDynFlags :: Settings -> DynFlags
defaultDynFlags mySettings =
754
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
755 756 757 758 759 760 761
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
762
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
763
        maxSimplIterations      = 4,
764
        shouldDumpSimplPhase    = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
765 766 767
        ruleCheck               = Nothing,
        specConstrThreshold     = Just 200,
        specConstrCount         = Just 3,
768
        liberateCaseThreshold   = Just 200,
769
        floatLamArgs            = Just 0,	-- Default: float only if no fvs
770 771
        strictnessBefore        = [],

772
        targetPlatform          = defaultTargetPlatform,
Ian Lynagh's avatar
Ian Lynagh committed
773 774 775 776 777 778
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

chak@cse.unsw.edu.au.'s avatar
chak@cse.unsw.edu.au. committed
779
        dphBackend              = DPHNone,
780

Ian Lynagh's avatar
Ian Lynagh committed
781 782 783
        thisPackage             = mainPackageId,

        objectDir               = Nothing,
784
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
785 786 787 788 789 790 791 792 793
        hiDir                   = Nothing,
        stubDir                 = Nothing,

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

        outputFile              = Nothing,
        outputHi                = Nothing,
794
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
795 796 797 798 799 800
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
801
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
802
        rtsOptsEnabled          = RtsOptsSafeOnly,
Ian Lynagh's avatar
Ian Lynagh committed
803 804 805 806 807

        hpcDir                  = ".hpc",

        extraPkgConfs           = [],
        packageFlags            = [],
808 809
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
810
        ways                    = panic "defaultDynFlags: No ways",
Ian Lynagh's avatar
Ian Lynagh committed
811 812
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
813
        splitInfo               = Nothing,
814
        settings                = mySettings,
815 816 817 818 819 820
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        -- end of ghc -M values
821 822
        filesToClean   = panic "defaultDynFlags: No filesToClean",
        dirsToClean    = panic "defaultDynFlags: No dirsToClean",
823
        generatedDumps = panic "defaultDynFlags: No generatedDumps",
Ian Lynagh's avatar
Ian Lynagh committed
824
        haddockOptions = Nothing,
825
        flags = defaultFlags,
826
        language = Nothing,
827 828
        extensions = [],
        extensionFlags = flattenExtensionFlags Nothing [],
829

Ian Lynagh's avatar
Ian Lynagh committed
830
        log_action = \severity srcSpan style msg ->
831
                        case severity of
832 833 834
                          SevOutput -> printSDoc msg style
                          SevInfo   -> printErrs msg style
                          SevFatal  -> printErrs msg style
835
                          _         -> do 
836
                                hPutChar stderr '\n'
837
                                printErrs (mkLocMessage srcSpan msg) style
838 839 840
                     -- 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.
841 842
      }

Ian Lynagh's avatar
Ian Lynagh committed
843
{-
844 845
Note [Verbosity levels]
~~~~~~~~~~~~~~~~~~~~~~~
Ian Lynagh's avatar
Ian Lynagh committed
846
    0   |   print errors & warnings only
847 848 849 850 851 852 853
    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"
-}

854 855 856 857 858
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
859 860 861
flattenExtensionFlags :: Maybe Language -> [OnOff ExtensionFlag]
                      -> [ExtensionFlag]
flattenExtensionFlags ml = foldr f defaultExtensionFlags
862 863
    where f (On f)  flags = f : delete f flags
          f (Off f) flags =     delete f flags
864 865 866
          defaultExtensionFlags = languageExtensions ml

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

868
languageExtensions Nothing
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
869
    -- Nothing => the default case
870 871 872
    = 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
873
      -- In due course I'd like Opt_MonoLocalBinds to be on by default
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
874
      -- But NB it's implied by GADTs etc
Ian Lynagh's avatar
Ian Lynagh committed
875
      -- SLPJ September 2010
876
    : Opt_NondecreasingIndentation -- This has been on by default for some time
877
    : languageExtensions (Just Haskell2010)
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
878

879 880 881 882
languageExtensions (Just Haskell98)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_NPlusKPatterns,
883 884 885 886 887 888 889 890
       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
891

892 893 894 895 896 897 898
languageExtensions (Just Haskell2010)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_DatatypeContexts,
       Opt_EmptyDataDecls,
       Opt_ForeignFunctionInterface,
       Opt_PatternGuards,
Ian Lynagh's avatar
Ian Lynagh committed
899
       Opt_DoAndIfThenElse,
900
       Opt_RelaxedPolyRec]
901

902
-- | Test whether a 'DynFlag' is set
903 904
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)
905

906
-- | Set a 'DynFlag'
907 908
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }
909

910
-- | Unset a 'DynFlag'
911 912
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }
913

914
-- | Test whether a 'ExtensionFlag' is set
915
xopt :: ExtensionFlag -> DynFlags -> Bool
916
xopt f dflags = f `elem` extensionFlags dflags
917

918
-- | Set a 'ExtensionFlag'
919
xopt_set :: DynFlags -> ExtensionFlag -> DynFlags
920 921 922 923
xopt_set dfs f
    = let onoffs = On f : extensions dfs
      in dfs { extensions = onoffs,
               extensionFlags = flattenExtensionFlags (language dfs) onoffs }
924

925
-- | Unset a 'ExtensionFlag'