DynFlags.hs 93.5 KB
Newer Older
1 2 3
{-# OPTIONS_GHC -w #-}
-- Temporary, until rtsIsProfiled is fixed

4
-- |
5 6 7 8 9 10
-- Dynamic flags
--
--
-- (c) The University of Glasgow 2005
--

11
-- Most flags are dynamic flags, which means they can change from
12 13 14
-- 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.
15
module DynFlags (
16
        -- * Dynamic flags and associated configuration types
Ian Lynagh's avatar
Ian Lynagh committed
17
        DynFlag(..),
18
        ExtensionFlag(..),
19
        glasgowExtsFlags,
20 21 22 23 24 25
        dopt,
        dopt_set,
        dopt_unset,
        xopt,
        xopt_set,
        xopt_unset,
Ian Lynagh's avatar
Ian Lynagh committed
26
        DynFlags(..),
Ian Lynagh's avatar
Ian Lynagh committed
27
        RtsOptsEnabled(..),
Ian Lynagh's avatar
Ian Lynagh committed
28 29 30 31
        HscTarget(..), isObjectTarget, defaultObjectTarget,
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
Ian Lynagh's avatar
Ian Lynagh committed
32
        Option(..), showOpt,
Ian Lynagh's avatar
Ian Lynagh committed
33
        DynLibLoader(..),
34
        fFlags, fLangFlags, xFlags,
35
        dphPackage,
36
        wayNames,
37

38
        -- ** Manipulating DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
39 40 41
        defaultDynFlags,                -- DynFlags
        initDynFlags,                   -- DynFlags -> IO DynFlags

42
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
Ian Lynagh's avatar
Ian Lynagh committed
43 44 45 46
        getVerbFlag,
        updOptLevel,
        setTmpDir,
        setPackageName,
47
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
48

49
        -- ** Parsing DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
50
        parseDynamicFlags,
51
        parseDynamicNoPackageFlags,
52
        allFlags,
53

54
        supportedLanguagesAndExtensions,
55 56

        -- ** DynFlag C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
57
        machdepCCOpts, picCCOpts,
58 59 60 61 62 63

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

        -- * Compiler configuration suitable for display to the user
64
        Printable(..),
65 66 67 68 69 70
        compilerInfo
#ifdef GHCI
-- Only in stage 2 can we be sure that the RTS 
-- exposes the appropriate runtime boolean
        , rtsIsProfiled
#endif
71 72 73 74
  ) where

#include "HsVersions.h"

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

96
import System.IO.Unsafe	( unsafePerformIO )
97
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
98
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
99

100
import Data.Char
101
import Data.List
102 103
import Data.Map (Map)
import qualified Data.Map as Map
Ian Lynagh's avatar
Ian Lynagh committed
104
import System.FilePath
105
import System.IO        ( stderr, hPutChar )
106

107 108 109
-- -----------------------------------------------------------------------------
-- DynFlags

110
-- | Enumerates the simple on-or-off dynamic flags
111 112 113 114
data DynFlag

   -- debugging flags
   = Opt_D_dump_cmm
115
   | Opt_D_dump_cmmz
116
   | Opt_D_dump_cmmz_pretty
117
   | Opt_D_dump_cps_cmm
118
   | Opt_D_dump_cvt_cmm
119
   | Opt_D_dump_asm
120 121
   | Opt_D_dump_asm_native
   | Opt_D_dump_asm_liveness
122
   | Opt_D_dump_asm_coalesce
123 124 125
   | Opt_D_dump_asm_regalloc
   | Opt_D_dump_asm_regalloc_stages
   | Opt_D_dump_asm_conflicts
126
   | Opt_D_dump_asm_stats
127
   | Opt_D_dump_asm_expanded
128
   | Opt_D_dump_llvm
129 130 131 132 133 134
   | Opt_D_dump_cpranal
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_flatC
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
135
   | Opt_D_dump_rule_firings
136 137 138 139 140
   | Opt_D_dump_occur_anal
   | Opt_D_dump_parsed
   | Opt_D_dump_rn
   | Opt_D_dump_simpl
   | Opt_D_dump_simpl_iterations
141
   | Opt_D_dump_simpl_phases
142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
   | 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
   | Opt_D_dump_tc_trace
   | Opt_D_dump_if_trace
   | Opt_D_dump_splices
   | Opt_D_dump_BCOs
   | Opt_D_dump_vect
andy@galois.com's avatar
andy@galois.com committed
160
   | Opt_D_dump_hpc
pepe's avatar
pepe committed
161
   | Opt_D_dump_rtti
162 163 164 165 166 167
   | 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
168
   | Opt_D_dump_mod_cycles
169
   | Opt_D_dump_view_pattern_commoning
170
   | Opt_D_faststring_stats
Ian Lynagh's avatar
Ian Lynagh committed
171
   | Opt_DumpToFile                     -- ^ Append dump output to files instead of stdout.
Simon Marlow's avatar
Simon Marlow committed
172
   | Opt_D_no_debug_output
173 174 175
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting
Ben.Lippmeier@anu.edu.au's avatar
Ben.Lippmeier@anu.edu.au committed
176
   | Opt_DoAsmLinting
177

Ian Lynagh's avatar
Ian Lynagh committed
178
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
179 180
   | Opt_WarnDuplicateExports
   | Opt_WarnHiShadows
181
   | Opt_WarnImplicitPrelude
182 183 184
   | Opt_WarnIncompletePatterns
   | Opt_WarnIncompletePatternsRecUpd
   | Opt_WarnMissingFields
185
   | Opt_WarnMissingImportList
186 187
   | Opt_WarnMissingMethods
   | Opt_WarnMissingSigs
188
   | Opt_WarnMissingLocalSigs
189 190 191
   | Opt_WarnNameShadowing
   | Opt_WarnOverlappingPatterns
   | Opt_WarnTypeDefaults
192
   | Opt_WarnMonomorphism
193 194 195
   | Opt_WarnUnusedBinds
   | Opt_WarnUnusedImports
   | Opt_WarnUnusedMatches
Ian Lynagh's avatar
Ian Lynagh committed
196
   | Opt_WarnWarningsDeprecations
197
   | Opt_WarnDeprecatedFlags
198
   | Opt_WarnDodgyExports
199 200
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
201
   | Opt_WarnAutoOrphans
202
   | Opt_WarnIdentities
203
   | Opt_WarnTabs
204
   | Opt_WarnUnrecognisedPragmas
205
   | Opt_WarnDodgyForeignImports
206
   | Opt_WarnLazyUnliftedBindings
207 208
   | Opt_WarnUnusedDoBind
   | Opt_WarnWrongDoBind
209
   | Opt_WarnAlternativeLayoutRuleTransitional
210

211 212
   | Opt_PrintExplicitForalls

213 214 215
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
216 217
   | Opt_FloatIn
   | Opt_Specialise
218
   | Opt_StaticArgumentTransformation
219
   | Opt_CSE
220 221
   | Opt_LiberateCase
   | Opt_SpecConstr
222 223 224 225 226
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
227
   | Opt_MethodSharing	-- Now a no-op; remove in GHC 7.2
228
   | Opt_DictsCheap
229
   | Opt_EnableRewriteRules		-- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
230
   | Opt_Vectorise
Ian Lynagh's avatar
Ian Lynagh committed
231 232
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
233

234 235 236 237 238
   -- Interface files
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_ExposeAllUnfoldings

Ian Lynagh's avatar
Ian Lynagh committed
239 240 241 242 243
   -- profiling opts
   | Opt_AutoSccsOnAllToplevs
   | Opt_AutoSccsOnExportedToplevs
   | Opt_AutoSccsOnIndividualCafs

244 245
   -- misc opts
   | Opt_Pp
246
   | Opt_ForceRecomp
247 248 249
   | Opt_DryRun
   | Opt_DoAsmMangling
   | Opt_ExcessPrecision
250
   | Opt_EagerBlackHoling
251 252 253 254
   | Opt_ReadUserPackageConf
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
255
   | Opt_HideAllPackages
256
   | Opt_PrintBindResult
257
   | Opt_Haddock
David Waern's avatar
David Waern committed
258
   | Opt_HaddockOptions
259
   | Opt_Hpc_No_Auto
260
   | Opt_BreakOnException
261
   | Opt_BreakOnError
262
   | Opt_PrintEvldWithShow
263
   | Opt_PrintBindContents
264 265
   | Opt_GenManifest
   | Opt_EmbedManifest
266
   | Opt_EmitExternalCore
Ian Lynagh's avatar
Ian Lynagh committed
267
   | Opt_SharedImplib
268
   | Opt_BuildingCabalPackage
269
   | Opt_SSE2
270
   | Opt_GhciSandbox
271 272 273

	-- temporary flags
   | Opt_RunCPS
274 275
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
276
   | Opt_AutoLinkPackages
277
   | Opt_ImplicitImportQualified
278
   | Opt_TryNewCodeGen
279 280 281 282 283 284 285

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepRawSFiles
   | Opt_KeepTmpFiles
Jedai's avatar
Jedai committed
286
   | Opt_KeepRawTokenStream
287
   | Opt_KeepLlvmFiles
288

289
   deriving (Eq, Show)
Ian Lynagh's avatar
Ian Lynagh committed
290

291 292
data Language = Haskell98 | Haskell2010

293
data ExtensionFlag
294 295 296 297 298 299 300
   = Opt_Cpp
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
   | Opt_MonomorphismRestriction
   | Opt_MonoPatBinds
   | Opt_MonoLocalBinds
301
   | Opt_RelaxedPolyRec		-- Deprecated
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
   | Opt_ExtendedDefaultRules           -- Use GHC's extended rules for defaulting
   | Opt_ForeignFunctionInterface
   | Opt_UnliftedFFITypes
   | Opt_GHCForeignImportPrim
   | Opt_PArr                           -- Syntactic support for parallel arrays
   | 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
   | Opt_NPlusKPatterns
Ian Lynagh's avatar
Ian Lynagh committed
324
   | Opt_DoAndIfThenElse
325
   | Opt_RebindableSyntax
326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363

   | 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
   | 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_NewQualifiedOperators
   | Opt_ExplicitForAll
   | Opt_AlternativeLayoutRule
   | Opt_AlternativeLayoutRuleTransitional
   | Opt_DatatypeContexts
364
   | Opt_RelaxedLayout
365 366
   deriving (Eq, Show)

367 368
-- | 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
369
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
370 371 372
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  hscTarget             :: HscTarget,
373
  hscOutName            :: String,      -- ^ Name of the output file
374
  extCoreName           :: String,      -- ^ Name of the .hcr output file
375
  verbosity             :: Int,         -- ^ Verbosity level: see Note [Verbosity levels]
376 377 378
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
379
  shouldDumpSimplPhase  :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
380
  ruleCheck             :: Maybe String,
381
  strictnessBefore      :: [Int],       -- ^ Additional demand analysis
382

383 384 385
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
386 387
  floatLamArgs          :: Maybe Int,   -- ^ Arg count for lambda floating
  			   	 	--   See CoreMonad.FloatOutSwitches
388

389
#ifndef OMIT_NATIVE_CODEGEN
390
  targetPlatform	:: Platform,	-- ^ The platform we're compiling for. Used by the NCG.
391
#endif
Ian Lynagh's avatar
Ian Lynagh committed
392
  stolen_x86_regs       :: Int,
393
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
394 395 396
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
397
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
398

399 400
  dphBackend            :: DPHBackend,

401
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
402 403

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

408 409 410
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

411
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
412
  objectDir             :: Maybe String,
413
  dylibInstallName      :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
414 415
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
416

Ian Lynagh's avatar
Ian Lynagh committed
417 418 419
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
420

Ian Lynagh's avatar
Ian Lynagh committed
421 422 423
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
424

425
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
426 427
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
428

429 430
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
431 432 433 434 435 436 437 438
  dumpPrefixForce       :: Maybe FilePath,

  includePaths          :: [String],
  libraryPaths          :: [String],
  frameworkPaths        :: [String],    -- used on darwin only
  cmdlineFrameworks     :: [String],    -- ditto
  tmpDir                :: String,      -- no trailing '/'

439 440
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto
441
  rtsOpts               :: Maybe String,
Ian Lynagh's avatar
Ian Lynagh committed
442
  rtsOptsEnabled        :: RtsOptsEnabled,
443

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

446
  -- options for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
447 448 449 450 451 452 453 454
  opt_L                 :: [String],
  opt_P                 :: [String],
  opt_F                 :: [String],
  opt_c                 :: [String],
  opt_m                 :: [String],
  opt_a                 :: [String],
  opt_l                 :: [String],
  opt_windres           :: [String],
455 456
  opt_lo                :: [String], -- LLVM: llvm optimiser
  opt_lc                :: [String], -- LLVM: llc static compiler
457 458

  -- commands for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
459 460 461 462 463 464 465 466 467
  pgm_L                 :: String,
  pgm_P                 :: (String,[Option]),
  pgm_F                 :: String,
  pgm_c                 :: (String,[Option]),
  pgm_m                 :: (String,[Option]),
  pgm_s                 :: (String,[Option]),
  pgm_a                 :: (String,[Option]),
  pgm_l                 :: (String,[Option]),
  pgm_dll               :: (String,[Option]),
468 469
  pgm_T                 :: String,
  pgm_sysman            :: String,
470
  pgm_windres           :: String,
471 472
  pgm_lo                :: (String,[Option]), -- LLVM: opt llvm optimiser
  pgm_lc                :: (String,[Option]), -- LLVM: llc static compiler
473

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

480
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
481
  extraPkgConfs         :: [FilePath],
482 483
  topDir                :: FilePath,    -- filled in by SysTools
  systemPackageConfig   :: FilePath,    -- ditto
484
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
485
        -- they appeared.
486

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

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

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

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

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

  haddockOptions :: Maybe String
516 517
 }

518 519 520
wayNames :: DynFlags -> [WayName]
wayNames = map wayName . ways

521 522
-- | The target code type of the compilation (if any).
--
523 524 525
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
526 527 528 529
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
530 531 532
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
533
--
534 535 536 537 538 539
--  * 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.)
540
--
541
data HscTarget
542 543
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
544
  | HscLlvm        -- ^ Generate assembly using the llvm code generator.
545 546 547
  | HscJava        -- ^ Generate Java bytecode.
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
548 549
  deriving (Eq, Show)

550
-- | Will this target result in an object file on the disk?
551 552 553
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
554
isObjectTarget HscLlvm  = True
555 556 557 558 559 560 561 562
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.
563
data GhcMode
564 565 566
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
567 568
  deriving Eq

569 570 571 572 573
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

574 575 576 577
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

578 579 580 581
-- | 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
582 583
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
584
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
585
  deriving (Eq, Show)
586 587 588

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

591 592 593
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
594 595 596
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.
597

598 599
data PackageFlag
  = ExposePackage  String
600
  | ExposePackageId String
601 602
  | HidePackage    String
  | IgnorePackage  String
603
  deriving Eq
604

twanvl's avatar
twanvl committed
605
defaultHscTarget :: HscTarget
606 607
defaultHscTarget = defaultObjectTarget

608
-- | The 'HscTarget' value corresponding to the default way to create
609
-- object files on the current platform.
twanvl's avatar
twanvl committed
610
defaultObjectTarget :: HscTarget
611
defaultObjectTarget
Ian Lynagh's avatar
Ian Lynagh committed
612 613
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
  | otherwise                           =  HscC
614

615 616 617 618 619
data DynLibLoader
  = Deployable
  | SystemDependent
  deriving Eq

Ian Lynagh's avatar
Ian Lynagh committed
620 621
data RtsOptsEnabled = RtsOptsNone | RtsOptsSafeOnly | RtsOptsAll

622
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
623
initDynFlags :: DynFlags -> IO DynFlags
624 625 626
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
627
 refFilesToClean <- newIORef []
628
 refDirsToClean <- newIORef Map.empty
629
 return dflags{
630 631 632
        ways            = ways,
        buildTag        = mkBuildTag (filter (not . wayRTSOnly) ways),
        rtsBuildTag     = mkBuildTag ways,
633 634
        filesToClean    = refFilesToClean,
        dirsToClean     = refDirsToClean
Ian Lynagh's avatar
Ian Lynagh committed
635
        }
636

637 638
-- | The normal 'DynFlags'. Note that they is not suitable for use in this form
-- and must be fully initialized by 'GHC.newSession' first.
twanvl's avatar
twanvl committed
639
defaultDynFlags :: DynFlags
640 641
defaultDynFlags =
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
642 643 644 645 646 647 648
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
649
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
650
        maxSimplIterations      = 4,
651
        shouldDumpSimplPhase    = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
652 653 654
        ruleCheck               = Nothing,
        specConstrThreshold     = Just 200,
        specConstrCount         = Just 3,
655
        liberateCaseThreshold   = Just 200,
656
        floatLamArgs            = Just 0,	-- Default: float only if no fvs
657 658
        strictnessBefore        = [],

659
#ifndef OMIT_NATIVE_CODEGEN
660
        targetPlatform          = defaultTargetPlatform,
661
#endif
Ian Lynagh's avatar
Ian Lynagh committed
662 663 664 665 666 667 668
        stolen_x86_regs         = 4,
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

669 670
        dphBackend              = DPHPar,

Ian Lynagh's avatar
Ian Lynagh committed
671 672 673
        thisPackage             = mainPackageId,

        objectDir               = Nothing,
674
        dylibInstallName        = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
675 676 677 678 679 680 681 682 683
        hiDir                   = Nothing,
        stubDir                 = Nothing,

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

        outputFile              = Nothing,
        outputHi                = Nothing,
684
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
685 686 687 688 689 690 691
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
        tmpDir                  = cDEFAULT_TMPDIR,
692
        rtsOpts                 = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
693
        rtsOptsEnabled          = RtsOptsSafeOnly,
Ian Lynagh's avatar
Ian Lynagh committed
694 695 696 697 698

        hpcDir                  = ".hpc",

        opt_L                   = [],
        opt_P                   = (if opt_PIC
699
                                   then ["-D__PIC__", "-U __PIC__"] -- this list is reversed
Ian Lynagh's avatar
Ian Lynagh committed
700 701 702 703 704 705
                                   else []),
        opt_F                   = [],
        opt_c                   = [],
        opt_a                   = [],
        opt_m                   = [],
        opt_l                   = [],
706
        opt_windres             = [],
707 708
        opt_lo                  = [],
        opt_lc                  = [],
Ian Lynagh's avatar
Ian Lynagh committed
709 710 711

        extraPkgConfs           = [],
        packageFlags            = [],
712 713
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
714
        ways                    = panic "defaultDynFlags: No ways",
Ian Lynagh's avatar
Ian Lynagh committed
715 716
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
717
        splitInfo               = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
718 719 720 721
        -- initSysTools fills all these in
        ghcUsagePath            = panic "defaultDynFlags: No ghciUsagePath",
        ghciUsagePath           = panic "defaultDynFlags: No ghciUsagePath",
        topDir                  = panic "defaultDynFlags: No topDir",
722
        systemPackageConfig     = panic  "no systemPackageConfig: call GHC.setSessionDynFlags",
Ian Lynagh's avatar
Ian Lynagh committed
723 724 725 726 727 728 729 730 731 732 733 734
        pgm_L                   = panic "defaultDynFlags: No pgm_L",
        pgm_P                   = panic "defaultDynFlags: No pgm_P",
        pgm_F                   = panic "defaultDynFlags: No pgm_F",
        pgm_c                   = panic "defaultDynFlags: No pgm_c",
        pgm_m                   = panic "defaultDynFlags: No pgm_m",
        pgm_s                   = panic "defaultDynFlags: No pgm_s",
        pgm_a                   = panic "defaultDynFlags: No pgm_a",
        pgm_l                   = panic "defaultDynFlags: No pgm_l",
        pgm_dll                 = panic "defaultDynFlags: No pgm_dll",
        pgm_T                   = panic "defaultDynFlags: No pgm_T",
        pgm_sysman              = panic "defaultDynFlags: No pgm_sysman",
        pgm_windres             = panic "defaultDynFlags: No pgm_windres",
735 736
        pgm_lo                  = panic "defaultDynFlags: No pgm_lo",
        pgm_lc                  = panic "defaultDynFlags: No pgm_lc",
Ian Lynagh's avatar
Ian Lynagh committed
737
        -- end of initSysTools values
738 739 740 741 742 743
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        -- end of ghc -M values
744 745
        filesToClean   = panic "defaultDynFlags: No filesToClean",
        dirsToClean    = panic "defaultDynFlags: No dirsToClean",
Ian Lynagh's avatar
Ian Lynagh committed
746
        haddockOptions = Nothing,
747
        flags = defaultFlags,
748
        language = Nothing,
749 750
        extensions = [],
        extensionFlags = flattenExtensionFlags Nothing [],
751

Ian Lynagh's avatar
Ian Lynagh committed
752
        log_action = \severity srcSpan style msg ->
753
                        case severity of
754 755 756 757
                          SevOutput -> printOutput (msg style)
                          SevInfo   -> printErrs (msg style)
                          SevFatal  -> printErrs (msg style)
                          _         -> do 
758 759 760 761 762
                                hPutChar stderr '\n'
                                printErrs ((mkLocMessage srcSpan msg) style)
                     -- 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.
763 764
      }

Ian Lynagh's avatar
Ian Lynagh committed
765
{-
766 767
Note [Verbosity levels]
~~~~~~~~~~~~~~~~~~~~~~~
Ian Lynagh's avatar
Ian Lynagh committed
768
    0   |   print errors & warnings only
769 770 771 772 773 774 775
    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"
-}

776 777 778 779 780
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
781 782 783
flattenExtensionFlags :: Maybe Language -> [OnOff ExtensionFlag]
                      -> [ExtensionFlag]
flattenExtensionFlags ml = foldr f defaultExtensionFlags
784 785
    where f (On f)  flags = f : delete f flags
          f (Off f) flags =     delete f flags
786 787 788
          defaultExtensionFlags = languageExtensions ml

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

790
languageExtensions Nothing
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
791
    -- Nothing => the default case
792 793 794
    = 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
795
      -- In due course I'd like Opt_MonoLocalBinds to be on by default
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
796
      -- But NB it's implied by GADTs etc
Ian Lynagh's avatar
Ian Lynagh committed
797
      -- SLPJ September 2010
798
    : Opt_RelaxedLayout -- This has been on by default for some time
799
    : languageExtensions (Just Haskell2010)
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
800

801 802 803 804 805
languageExtensions (Just Haskell98)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_NPlusKPatterns,
       Opt_DatatypeContexts]
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
806

807 808 809 810 811 812 813
languageExtensions (Just Haskell2010)
    = [Opt_ImplicitPrelude,
       Opt_MonomorphismRestriction,
       Opt_DatatypeContexts,
       Opt_EmptyDataDecls,
       Opt_ForeignFunctionInterface,
       Opt_PatternGuards,
Ian Lynagh's avatar
Ian Lynagh committed
814
       Opt_DoAndIfThenElse,
815
       Opt_RelaxedPolyRec]
816

817
-- | Test whether a 'DynFlag' is set
818 819
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)
820

821
-- | Set a 'DynFlag'
822 823
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }
824

825
-- | Unset a 'DynFlag'
826 827
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }
828

829
-- | Test whether a 'ExtensionFlag' is set
830
xopt :: ExtensionFlag -> DynFlags -> Bool
831
xopt f dflags = f `elem` extensionFlags dflags
832

833
-- | Set a 'ExtensionFlag'
834
xopt_set :: DynFlags -> ExtensionFlag -> DynFlags
835 836 837 838
xopt_set dfs f
    = let onoffs = On f : extensions dfs
      in dfs { extensions = onoffs,
               extensionFlags = flattenExtensionFlags (language dfs) onoffs }
839

840
-- | Unset a 'ExtensionFlag'
841
xopt_unset :: DynFlags -> ExtensionFlag -> DynFlags
842 843 844 845
xopt_unset dfs