DynFlags.hs 93.1 KB
Newer Older
1

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

9
-- Most flags are dynamic flags, which means they can change from
10
11
12
-- 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.
13
module DynFlags (
14
        -- * Dynamic flags and associated configuration types
Ian Lynagh's avatar
Ian Lynagh committed
15
16
17
18
19
20
21
22
        DynFlag(..),
        DynFlags(..),
        HscTarget(..), isObjectTarget, defaultObjectTarget,
        GhcMode(..), isOneShot,
        GhcLink(..), isNoLink,
        PackageFlag(..),
        Option(..),
        DynLibLoader(..),
23
        fFlags, xFlags,
24
        dphPackage,
25

26
        -- ** Manipulating DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
27
28
29
30
31
        defaultDynFlags,                -- DynFlags
        initDynFlags,                   -- DynFlags -> IO DynFlags

        dopt,                           -- DynFlag -> DynFlags -> Bool
        dopt_set, dopt_unset,           -- DynFlags -> DynFlag -> DynFlags
32
        getOpts,                        -- DynFlags -> (DynFlags -> [a]) -> [a]
Ian Lynagh's avatar
Ian Lynagh committed
33
        getVerbFlag,
34
        getMainFun,
Ian Lynagh's avatar
Ian Lynagh committed
35
36
37
        updOptLevel,
        setTmpDir,
        setPackageName,
38
        doingTickyProfiling,
Ian Lynagh's avatar
Ian Lynagh committed
39

40
        -- ** Parsing DynFlags
Ian Lynagh's avatar
Ian Lynagh committed
41
        parseDynamicFlags,
42
        parseDynamicNoPackageFlags,
43
        allFlags,
44

45
46
47
        supportedLanguages, languageOptions,

        -- ** DynFlag C compiler options
Ian Lynagh's avatar
Ian Lynagh committed
48
        machdepCCOpts, picCCOpts,
49
50
51
52
53
54
55
56
57
58
59
60
61
62

        -- * Configuration of the core-to-core passes
        CoreToDo(..),
        SimplifierMode(..),
        SimplifierSwitch(..),
        FloatOutSwitches(..),
        getCoreToDo,

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

        -- * Compiler configuration suitable for display to the user
        compilerInfo
63
64
65
66
  ) where

#include "HsVersions.h"

67
#ifndef OMIT_NATIVE_CODEGEN
68
import Platform
69
#endif
70
import Module
Simon Marlow's avatar
Simon Marlow committed
71
import PackageConfig
72
73
74
import PrelNames        ( mAIN, main_RDR_Unqual )
import RdrName          ( RdrName, mkRdrUnqual )
import OccName          ( mkVarOccFS )
Ian Lynagh's avatar
Ian Lynagh committed
75
#if defined(i386_TARGET_ARCH) || (!defined(mingw32_TARGET_OS) && !defined(darwin_TARGET_OS))
Ian Lynagh's avatar
Ian Lynagh committed
76
import StaticFlags      ( opt_Static )
Simon Marlow's avatar
Simon Marlow committed
77
#endif
Ian Lynagh's avatar
Ian Lynagh committed
78
79
import StaticFlags      ( opt_PIC, WayName(..), v_Ways, v_Build_tag,
                          v_RTS_Build_tag )
80
import {-# SOURCE #-} Packages (PackageState)
Ian Lynagh's avatar
Ian Lynagh committed
81
import DriverPhases     ( Phase(..), phaseInputExt )
82
83
import Config
import CmdLineParser
Ian Lynagh's avatar
Ian Lynagh committed
84
import Constants        ( mAX_CONTEXT_REDUCTION_DEPTH )
85
import Panic
86
import UniqFM           ( UniqFM )
87
import Util
88
import Maybes           ( orElse )
89
import SrcLoc
90
import FastString
91
import FiniteMap
Simon Marlow's avatar
Simon Marlow committed
92
93
import Outputable
import {-# SOURCE #-} ErrUtils ( Severity(..), Message, mkLocMessage )
94

95
import Data.IORef
Ian Lynagh's avatar
Ian Lynagh committed
96
import Control.Monad    ( when )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
97

98
import Data.Char
99
import Data.List        ( intersperse )
Ian Lynagh's avatar
Ian Lynagh committed
100
import System.FilePath
101
import System.IO        ( stderr, hPutChar )
102

103
104
105
-- -----------------------------------------------------------------------------
-- DynFlags

106
-- | Enumerates the simple on-or-off dynamic flags
107
108
109
110
data DynFlag

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

Ian Lynagh's avatar
Ian Lynagh committed
172
   | Opt_WarnIsError                    -- -Werror; makes warnings fatal
173
174
   | Opt_WarnDuplicateExports
   | Opt_WarnHiShadows
175
   | Opt_WarnImplicitPrelude
176
177
178
179
180
181
182
183
184
   | Opt_WarnIncompletePatterns
   | Opt_WarnIncompletePatternsRecUpd
   | Opt_WarnMissingFields
   | Opt_WarnMissingMethods
   | Opt_WarnMissingSigs
   | Opt_WarnNameShadowing
   | Opt_WarnOverlappingPatterns
   | Opt_WarnSimplePatterns
   | Opt_WarnTypeDefaults
185
   | Opt_WarnMonomorphism
186
187
188
   | Opt_WarnUnusedBinds
   | Opt_WarnUnusedImports
   | Opt_WarnUnusedMatches
Ian Lynagh's avatar
Ian Lynagh committed
189
   | Opt_WarnWarningsDeprecations
190
   | Opt_WarnDeprecatedFlags
191
192
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
193
   | Opt_WarnTabs
194
   | Opt_WarnUnrecognisedPragmas
195
   | Opt_WarnDodgyForeignImports
196
197

   -- language opts
198
199
200
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
201
   | Opt_MonomorphismRestriction
202
   | Opt_MonoPatBinds
Ian Lynagh's avatar
Ian Lynagh committed
203
   | Opt_ExtendedDefaultRules           -- Use GHC's extended rules for defaulting
204
   | Opt_ForeignFunctionInterface
Ian Lynagh's avatar
Ian Lynagh committed
205
   | Opt_UnliftedFFITypes
Ian Lynagh's avatar
Ian Lynagh committed
206
207
   | Opt_PArr                           -- Syntactic support for parallel arrays
   | Opt_Arrows                         -- Arrow-notation syntax
208
   | Opt_TemplateHaskell
209
   | Opt_QuasiQuotes
210
   | Opt_ImplicitParams
211
   | Opt_Generics			-- "Derivable type classes"
Ian Lynagh's avatar
Ian Lynagh committed
212
   | Opt_ImplicitPrelude
213
   | Opt_ScopedTypeVariables
Ian Lynagh's avatar
Ian Lynagh committed
214
   | Opt_UnboxedTuples
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
215
   | Opt_BangPatterns
216
   | Opt_TypeFamilies
217
   | Opt_OverloadedStrings
218
   | Opt_DisambiguateRecordFields
219
   | Opt_RecordWildCards
220
   | Opt_RecordPuns
221
   | Opt_ViewPatterns
222
   | Opt_GADTs
223
   | Opt_RelaxedPolyRec
224
   | Opt_StandaloneDeriving
225
   | Opt_DeriveDataTypeable
226
   | Opt_DeriveFunctor
227
   | Opt_TypeSynonymInstances
Ian Lynagh's avatar
Ian Lynagh committed
228
   | Opt_FlexibleContexts
229
   | Opt_FlexibleInstances
230
   | Opt_ConstrainedClassMethods
Ian Lynagh's avatar
Ian Lynagh committed
231
   | Opt_MultiParamTypeClasses
232
   | Opt_FunctionalDependencies
Ian Lynagh's avatar
Ian Lynagh committed
233
   | Opt_UnicodeSyntax
Ian Lynagh's avatar
Ian Lynagh committed
234
   | Opt_PolymorphicComponents
235
   | Opt_ExistentialQuantification
236
   | Opt_MagicHash
Ian Lynagh's avatar
Ian Lynagh committed
237
   | Opt_EmptyDataDecls
Ian Lynagh's avatar
Ian Lynagh committed
238
   | Opt_KindSignatures
Ian Lynagh's avatar
Ian Lynagh committed
239
   | Opt_ParallelListComp
240
   | Opt_TransformListComp
241
   | Opt_GeneralizedNewtypeDeriving
Ian Lynagh's avatar
Ian Lynagh committed
242
   | Opt_RecursiveDo
243
   | Opt_PostfixOperators
Ian Lynagh's avatar
Ian Lynagh committed
244
   | Opt_PatternGuards
245
   | Opt_LiberalTypeSynonyms
246
247
   | Opt_Rank2Types
   | Opt_RankNTypes
248
   | Opt_ImpredicativeTypes
Ian Lynagh's avatar
Ian Lynagh committed
249
   | Opt_TypeOperators
250
   | Opt_PackageImports
251
   | Opt_NewQualifiedOperators
252

253
254
   | Opt_PrintExplicitForalls

255
256
257
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
258
   | Opt_StaticArgumentTransformation
259
   | Opt_CSE
260
261
   | Opt_LiberateCase
   | Opt_SpecConstr
262
263
264
265
266
267
268
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
269
   | Opt_MethodSharing
270
   | Opt_DictsCheap
271
   | Opt_InlineIfEnoughArgs
272
   | Opt_EnableRewriteRules		-- Apply rewrite rules during simplification
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
273
   | Opt_Vectorise
Ian Lynagh's avatar
Ian Lynagh committed
274
275
   | Opt_RegsGraph                      -- do graph coloring register allocation
   | Opt_RegsIterative                  -- do iterative coalescing graph coloring register allocation
276

Ian Lynagh's avatar
Ian Lynagh committed
277
278
279
280
281
   -- profiling opts
   | Opt_AutoSccsOnAllToplevs
   | Opt_AutoSccsOnExportedToplevs
   | Opt_AutoSccsOnIndividualCafs

282
283
284
   -- misc opts
   | Opt_Cpp
   | Opt_Pp
285
   | Opt_ForceRecomp
286
287
288
   | Opt_DryRun
   | Opt_DoAsmMangling
   | Opt_ExcessPrecision
289
   | Opt_EagerBlackHoling
290
291
292
293
   | Opt_ReadUserPackageConf
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
294
   | Opt_HideAllPackages
295
   | Opt_PrintBindResult
296
   | Opt_Haddock
David Waern's avatar
David Waern committed
297
   | Opt_HaddockOptions
298
   | Opt_Hpc_No_Auto
299
   | Opt_BreakOnException
300
   | Opt_BreakOnError
301
   | Opt_PrintEvldWithShow
302
   | Opt_PrintBindContents
303
304
   | Opt_GenManifest
   | Opt_EmbedManifest
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
319

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

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

324
325
-- | 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
326
data DynFlags = DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
327
328
329
330
331
  ghcMode               :: GhcMode,
  ghcLink               :: GhcLink,
  coreToDo              :: Maybe [CoreToDo], -- reserved for -Ofile
  stgToDo               :: Maybe [StgToDo],  -- similarly
  hscTarget             :: HscTarget,
332
  hscOutName            :: String,      -- ^ Name of the output file
333
  extCoreName           :: String,      -- ^ Name of the .hcr output file
334
335
336
337
  verbosity             :: Int,         -- ^ Verbosity level: see "DynFlags#verbosity_levels"
  optLevel              :: Int,         -- ^ Optimisation level
  simplPhases           :: Int,         -- ^ Number of simplifier phases
  maxSimplIterations    :: Int,         -- ^ Max simplifier iterations
338
  shouldDumpSimplPhase  :: SimplifierMode -> Bool,
Ian Lynagh's avatar
Ian Lynagh committed
339
  ruleCheck             :: Maybe String,
340

341
342
343
  specConstrThreshold   :: Maybe Int,   -- ^ Threshold for SpecConstr
  specConstrCount       :: Maybe Int,   -- ^ Max number of specialisations for any one function
  liberateCaseThreshold :: Maybe Int,   -- ^ Threshold for LiberateCase
344

345
#ifndef OMIT_NATIVE_CODEGEN
346
  targetPlatform	:: Platform,	-- ^ The platform we're compiling for. Used by the NCG.
347
#endif
Ian Lynagh's avatar
Ian Lynagh committed
348
  stolen_x86_regs       :: Int,
349
  cmdlineHcIncludes     :: [String],    -- ^ @\-\#includes@
Ian Lynagh's avatar
Ian Lynagh committed
350
351
352
  importPaths           :: [FilePath],
  mainModIs             :: Module,
  mainFunIs             :: Maybe String,
353
  ctxtStkDepth          :: Int,         -- ^ Typechecker context stack depth
354

355
356
  dphBackend            :: DPHBackend,

357
  thisPackage           :: PackageId,   -- ^ name of package currently being compiled
358
359

  -- ways
360
361
362
  wayNames              :: [WayName],   -- ^ Way flags from the command line
  buildTag              :: String,      -- ^ The global \"way\" (e.g. \"p\" for prof)
  rtsBuildTag           :: String,      -- ^ The RTS \"way\"
Ian Lynagh's avatar
Ian Lynagh committed
363

364
365
366
  -- For object splitting
  splitInfo             :: Maybe (String,Int),

367
  -- paths etc.
Ian Lynagh's avatar
Ian Lynagh committed
368
369
370
  objectDir             :: Maybe String,
  hiDir                 :: Maybe String,
  stubDir               :: Maybe String,
371

Ian Lynagh's avatar
Ian Lynagh committed
372
373
374
  objectSuf             :: String,
  hcSuf                 :: String,
  hiSuf                 :: String,
375

Ian Lynagh's avatar
Ian Lynagh committed
376
377
378
  outputFile            :: Maybe String,
  outputHi              :: Maybe String,
  dynLibLoader          :: DynLibLoader,
379

380
  -- | This is set by 'DriverPipeline.runPipeline' based on where
Ian Lynagh's avatar
Ian Lynagh committed
381
382
  --    its output is going.
  dumpPrefix            :: Maybe FilePath,
383

384
385
  -- | Override the 'dumpPrefix' set by 'DriverPipeline.runPipeline'.
  --    Set by @-ddump-file-prefix@
Ian Lynagh's avatar
Ian Lynagh committed
386
387
388
389
390
391
392
393
  dumpPrefixForce       :: Maybe FilePath,

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

394
395
396
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto

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

399
  -- options for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
400
401
402
403
404
405
406
407
  opt_L                 :: [String],
  opt_P                 :: [String],
  opt_F                 :: [String],
  opt_c                 :: [String],
  opt_m                 :: [String],
  opt_a                 :: [String],
  opt_l                 :: [String],
  opt_windres           :: [String],
408
409

  -- commands for particular phases
Ian Lynagh's avatar
Ian Lynagh committed
410
411
412
413
414
415
416
417
418
  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]),
419
420
  pgm_T                 :: String,
  pgm_sysman            :: String,
421
  pgm_windres           :: String,
422

423
424
425
426
427
428
  --  For ghc -M
  depMakefile           :: FilePath,
  depIncludePkgDeps     :: Bool,
  depExcludeMods        :: [ModuleName],
  depSuffixes           :: [String],

429
  --  Package flags
Ian Lynagh's avatar
Ian Lynagh committed
430
  extraPkgConfs         :: [FilePath],
431
432
  topDir                :: FilePath,    -- filled in by SysTools
  systemPackageConfig   :: FilePath,    -- ditto
433
        -- ^ The @-package-conf@ flags given on the command line, in the order
Ian Lynagh's avatar
Ian Lynagh committed
434
        -- they appeared.
435

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

439
  -- Package state
Ian Lynagh's avatar
Ian Lynagh committed
440
  -- NB. do not modify this field, it is calculated by
441
  -- Packages.initPackages and Packages.updatePackages.
442
  pkgDatabase           :: Maybe (UniqFM PackageConfig),
Ian Lynagh's avatar
Ian Lynagh committed
443
  pkgState              :: PackageState,
444

445
446
447
448
449
450
  -- Temporary files
  -- These have to be IORefs, because the defaultCleanupHandler needs to
  -- know what to clean when an exception happens
  filesToClean          :: IORef [FilePath],
  dirsToClean           :: IORef (FiniteMap FilePath FilePath),

451
  -- hsc dynamic flags
Ian Lynagh's avatar
Ian Lynagh committed
452
453
  flags                 :: [DynFlag],

454
  -- | Message output action: use "ErrUtils" instead of this if you can
David Waern's avatar
David Waern committed
455
456
457
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO (),

  haddockOptions :: Maybe String
458
459
 }

460
461
-- | The target code type of the compilation (if any).
--
462
463
464
-- Whenever you change the target, also make sure to set 'ghcLink' to
-- something sensible.
--
465
466
467
468
-- 'HscNothing' can be used to avoid generating any output, however, note
-- that:
--
--  * This will not run the desugaring step, thus no warnings generated in
469
470
471
--    this step will be output.  In particular, this includes warnings related
--    to pattern matching.  You can run the desugarer manually using
--    'GHC.desugarModule'.
472
--
473
474
475
476
477
478
--  * 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.)
479
--
480
data HscTarget
481
482
483
484
485
  = HscC           -- ^ Generate C code.
  | HscAsm         -- ^ Generate assembly using the native code generator.
  | HscJava        -- ^ Generate Java bytecode.
  | HscInterpreted -- ^ Generate bytecode.  (Requires 'LinkInMemory')
  | HscNothing     -- ^ Don't generate any code.  See notes above.
486
487
  deriving (Eq, Show)

488
-- | Will this target result in an object file on the disk?
489
490
491
492
493
494
495
496
497
498
499
isObjectTarget :: HscTarget -> Bool
isObjectTarget HscC     = True
isObjectTarget HscAsm   = True
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.
500
data GhcMode
501
502
503
  = CompManager         -- ^ @\-\-make@, GHCi, etc.
  | OneShot             -- ^ @ghc -c Foo.hs@
  | MkDepend            -- ^ @ghc -M@, see "Finder" for why we need this
504
505
  deriving Eq

506
507
508
509
510
instance Outputable GhcMode where
  ppr CompManager = ptext (sLit "CompManager")
  ppr OneShot     = ptext (sLit "OneShot")
  ppr MkDepend    = ptext (sLit "MkDepend")

511
512
513
514
isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

515
516
517
518
-- | 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
519
520
  | LinkInMemory        -- ^ Use the in-memory dynamic linker (works for both
                        --   bytecode and object code).
521
  | LinkDynLib          -- ^ Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
522
  deriving (Eq, Show)
523
524
525

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

528
529
530
531
532
-- Is it worth evaluating this Bool and caching it in the DynFlags value
-- during initDynFlags?
doingTickyProfiling :: DynFlags -> Bool
doingTickyProfiling dflags = WayTicky `elem` wayNames dflags

533
534
535
536
data PackageFlag
  = ExposePackage  String
  | HidePackage    String
  | IgnorePackage  String
537
  deriving Eq
538

twanvl's avatar
twanvl committed
539
defaultHscTarget :: HscTarget
540
541
defaultHscTarget = defaultObjectTarget

542
-- | The 'HscTarget' value corresponding to the default way to create
543
-- object files on the current platform.
twanvl's avatar
twanvl committed
544
defaultObjectTarget :: HscTarget
545
defaultObjectTarget
Ian Lynagh's avatar
Ian Lynagh committed
546
547
  | cGhcWithNativeCodeGen == "YES"      =  HscAsm
  | otherwise                           =  HscC
548

549
550
551
552
553
554
data DynLibLoader
  = Deployable
  | Wrapped (Maybe String)
  | SystemDependent
  deriving Eq

555
-- | Used by 'GHC.newSession' to partially initialize a new 'DynFlags' value
twanvl's avatar
twanvl committed
556
initDynFlags :: DynFlags -> IO DynFlags
557
558
559
560
561
initDynFlags dflags = do
 -- someday these will be dynamic flags
 ways <- readIORef v_Ways
 build_tag <- readIORef v_Build_tag
 rts_build_tag <- readIORef v_RTS_Build_tag
562
563
 refFilesToClean <- newIORef []
 refDirsToClean <- newIORef emptyFM
564
 return dflags{
Ian Lynagh's avatar
Ian Lynagh committed
565
566
        wayNames        = ways,
        buildTag        = build_tag,
567
568
569
        rtsBuildTag     = rts_build_tag,
        filesToClean    = refFilesToClean,
        dirsToClean     = refDirsToClean
Ian Lynagh's avatar
Ian Lynagh committed
570
        }
571

572
573
-- | 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
574
defaultDynFlags :: DynFlags
575
576
defaultDynFlags =
     DynFlags {
Ian Lynagh's avatar
Ian Lynagh committed
577
578
579
580
581
582
583
584
585
        ghcMode                 = CompManager,
        ghcLink                 = LinkBinary,
        coreToDo                = Nothing,
        stgToDo                 = Nothing,
        hscTarget               = defaultHscTarget,
        hscOutName              = "",
        extCoreName             = "",
        verbosity               = 0,
        optLevel                = 0,
586
        simplPhases             = 2,
Ian Lynagh's avatar
Ian Lynagh committed
587
        maxSimplIterations      = 4,
588
        shouldDumpSimplPhase    = const False,
Ian Lynagh's avatar
Ian Lynagh committed
589
590
591
        ruleCheck               = Nothing,
        specConstrThreshold     = Just 200,
        specConstrCount         = Just 3,
592
        liberateCaseThreshold   = Just 200,
593
#ifndef OMIT_NATIVE_CODEGEN
594
        targetPlatform          = defaultTargetPlatform,
595
#endif
Ian Lynagh's avatar
Ian Lynagh committed
596
597
598
599
600
601
602
        stolen_x86_regs         = 4,
        cmdlineHcIncludes       = [],
        importPaths             = ["."],
        mainModIs               = mAIN,
        mainFunIs               = Nothing,
        ctxtStkDepth            = mAX_CONTEXT_REDUCTION_DEPTH,

603
604
        dphBackend              = DPHPar,

Ian Lynagh's avatar
Ian Lynagh committed
605
606
607
608
609
610
611
612
613
614
615
616
        thisPackage             = mainPackageId,

        objectDir               = Nothing,
        hiDir                   = Nothing,
        stubDir                 = Nothing,

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

        outputFile              = Nothing,
        outputHi                = Nothing,
617
        dynLibLoader            = SystemDependent,
Ian Lynagh's avatar
Ian Lynagh committed
618
619
620
621
622
623
624
625
626
627
628
629
        dumpPrefix              = Nothing,
        dumpPrefixForce         = Nothing,
        includePaths            = [],
        libraryPaths            = [],
        frameworkPaths          = [],
        cmdlineFrameworks       = [],
        tmpDir                  = cDEFAULT_TMPDIR,

        hpcDir                  = ".hpc",

        opt_L                   = [],
        opt_P                   = (if opt_PIC
630
                                   then ["-D__PIC__", "-U __PIC__"] -- this list is reversed
Ian Lynagh's avatar
Ian Lynagh committed
631
632
633
634
635
636
                                   else []),
        opt_F                   = [],
        opt_c                   = [],
        opt_a                   = [],
        opt_m                   = [],
        opt_l                   = [],
637
        opt_windres             = [],
Ian Lynagh's avatar
Ian Lynagh committed
638
639
640

        extraPkgConfs           = [],
        packageFlags            = [],
641
642
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
Ian Lynagh's avatar
Ian Lynagh committed
643
644
645
        wayNames                = panic "defaultDynFlags: No wayNames",
        buildTag                = panic "defaultDynFlags: No buildTag",
        rtsBuildTag             = panic "defaultDynFlags: No rtsBuildTag",
646
        splitInfo               = Nothing,
Ian Lynagh's avatar
Ian Lynagh committed
647
648
649
650
        -- initSysTools fills all these in
        ghcUsagePath            = panic "defaultDynFlags: No ghciUsagePath",
        ghciUsagePath           = panic "defaultDynFlags: No ghciUsagePath",
        topDir                  = panic "defaultDynFlags: No topDir",
651
        systemPackageConfig     = panic  "no systemPackageConfig: call GHC.setSessionDynFlags",
Ian Lynagh's avatar
Ian Lynagh committed
652
653
654
655
656
657
658
659
660
661
662
663
664
        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",
        -- end of initSysTools values
665
666
667
668
669
670
        -- ghc -M values
        depMakefile       = "Makefile",
        depIncludePkgDeps = False,
        depExcludeMods    = [],
        depSuffixes       = [],
        -- end of ghc -M values
671
672
        filesToClean   = panic "defaultDynFlags: No filesToClean",
        dirsToClean    = panic "defaultDynFlags: No dirsToClean",
Ian Lynagh's avatar
Ian Lynagh committed
673
        haddockOptions = Nothing,
674
        flags = [
675
            Opt_AutoLinkPackages,
676
677
678
679
680
681
682
683
684
            Opt_ReadUserPackageConf,

            Opt_MonoPatBinds,   -- Experimentally, I'm making this non-standard
                                -- behaviour the default, to see if anyone notices
                                -- SLPJ July 06

            Opt_ImplicitPrelude,
            Opt_MonomorphismRestriction,

685
686
            Opt_MethodSharing,

687
688
            Opt_DoAsmMangling,

689
            Opt_GenManifest,
690
691
            Opt_EmbedManifest,
            Opt_PrintBindContents
692
693
694
695
696
            ]
            ++ [f | (ns,f) <- optLevelFlags, 0 `elem` ns]
                    -- The default -O0 options
            ++ standardWarnings,

Ian Lynagh's avatar
Ian Lynagh committed
697
        log_action = \severity srcSpan style msg ->
698
                        case severity of
699
700
701
702
703
704
705
706
                          SevInfo  -> printErrs (msg style)
                          SevFatal -> printErrs (msg style)
                          _        -> do 
                                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.
707
708
      }

Ian Lynagh's avatar
Ian Lynagh committed
709
{-
710
    #verbosity_levels#
711
    Verbosity levels:
Ian Lynagh's avatar
Ian Lynagh committed
712
713

    0   |   print errors & warnings only
714
715
716
717
718
719
720
    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"
-}

721
-- | Test whether a 'DynFlag' is set
722
723
724
dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)

725
-- | Set a 'DynFlag'
726
727
728
dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }

729
-- | Unset a 'DynFlag'
730
731
732
dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }

733
734
735
736
-- | Retrieve the options corresponding to a particular @opt_*@ field in the correct order
getOpts :: DynFlags             -- ^ 'DynFlags' to retrieve the options from
        -> (DynFlags -> [a])    -- ^ Relevant record accessor: one of the @opt_*@ accessors
        -> [a]                  -- ^ Correctly ordered extracted options
737
getOpts dflags opts = reverse (opts dflags)
Ian Lynagh's avatar
Ian Lynagh committed
738
        -- We add to the options from the front, so we need to reverse the list
739

740
741
-- | Gets the verbosity flag for the current verbosity level. This is fed to
-- other tools, so GHC-specific verbosity flags like @-ddump-most@ are not included
742
getVerbFlag :: DynFlags -> String
Ian Lynagh's avatar
Ian Lynagh committed
743
744
getVerbFlag dflags
  | verbosity dflags >= 3  = "-v"
745
746
  | otherwise =  ""

Simon Marlow's avatar
Simon Marlow committed
747
748
setObjectDir, setHiDir, setStubDir, setOutputDir,
         setObjectSuf, setHiSuf, setHcSuf, parseDynLibLoaderMode,
twanvl's avatar
twanvl committed
749
         setPgmP, setPgmL, setPgmF, setPgmc, setPgmm, setPgms, setPgma, setPgml, setPgmdll, setPgmwindres,
750
         addOptL, addOptP, addOptF, addOptc, addOptm, addOpta, addOptl, addOptwindres,
twanvl's avatar
twanvl committed
751
752
753
754
755
         addCmdlineFramework, addHaddockOpts
   :: String -> DynFlags -> DynFlags
setOutputFile, setOutputHi, setDumpPrefixForce
   :: Maybe String -> DynFlags -> DynFlags

756
757
758
759
setObjectDir  f d = d{ objectDir  = Just f}
setHiDir      f d = d{ hiDir      = Just f}
setStubDir    f d = d{ stubDir    = Just f, includePaths = f : includePaths d }
  -- -stubdir D adds an implicit -I D, so that gcc can find the _stub.h file
Thomas Schilling's avatar
Thomas Schilling committed
760
  -- \#included from the .hc file when compiling with -fvia-C.
Simon Marlow's avatar
Simon Marlow committed
761
setOutputDir  f = setObjectDir f . setHiDir f . setStubDir f
762

763
764
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
765
766
767
768
setHcSuf      f d = d{ hcSuf      = f}

setOutputFile f d = d{ outputFile = f}
setOutputHi   f d = d{ outputHi   = f}
769

770
771
772
773
774
775
776
parseDynLibLoaderMode f d =
 case splitAt 8 f of
   ("deploy", "")       -> d{ dynLibLoader = Deployable }
   ("sysdep", "")       -> d{ dynLibLoader = SystemDependent }
   ("wrapped", "")      -> d{ dynLibLoader = Wrapped Nothing }
   ("wrapped:", "hard") -> d{ dynLibLoader = Wrapped Nothing }
   ("wrapped:", flex)   -> d{ dynLibLoader = Wrapped (Just flex) }
777
   _                    -> ghcError (CmdLineError ("Unknown dynlib loader: " ++ f))
778

779
780
setDumpPrefixForce f d = d { dumpPrefixForce = f}

781
782
783
784
785
786
787
788
789
790
791
792
-- XXX HACK: Prelude> words "'does not' work" ===> ["'does","not'","work"]
-- Config.hs should really use Option.
setPgmP   f d = let (pgm:args) = words f in d{ pgm_P   = (pgm, map Option args)}

setPgmL   f d = d{ pgm_L   = f}
setPgmF   f d = d{ pgm_F   = f}
setPgmc   f d = d{ pgm_c   = (f,[])}
setPgmm   f d = d{ pgm_m   = (f,[])}
setPgms   f d = d{ pgm_s   = (f,[])}
setPgma   f d = d{ pgm_a   = (f,[])}
setPgml   f d = d{ pgm_l   = (f,[])}
setPgmdll f d = d{ pgm_dll = (f,[])}
793
setPgmwindres f d = d{ pgm_windres = f}
794
795
796
797
798
799
800
801

addOptL   f d = d{ opt_L   = f : opt_L d}
addOptP   f d = d{ opt_P   = f : opt_P d}
addOptF   f d = d{ opt_F   = f : opt_F d}
addOptc   f d = d{ opt_c   = f : opt_c d}
addOptm   f d = d{ opt_m   = f : opt_m d}
addOpta   f d = d{ opt_a   = f : opt_a d}
addOptl   f d = d{ opt_l   = f : opt_l d}
802
addOptwindres f d = d{ opt_windres = f : opt_windres d}
803

804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
setDepMakefile :: FilePath -> DynFlags -> DynFlags
setDepMakefile f d = d { depMakefile = deOptDep f }

setDepIncludePkgDeps :: Bool -> DynFlags -> DynFlags
setDepIncludePkgDeps b d = d { depIncludePkgDeps = b }

addDepExcludeMod :: String -> DynFlags -> DynFlags
addDepExcludeMod m d
    = d { depExcludeMods = mkModuleName (deOptDep m) : depExcludeMods d }

addDepSuffix :: FilePath -> DynFlags -> DynFlags
addDepSuffix s d = d { depSuffixes = deOptDep s : depSuffixes d }

-- XXX Legacy code:
-- We used to use "-optdep-flag -optdeparg", so for legacy applications
-- we need to strip the "-optdep" off of the arg
deOptDep :: String -> String
deOptDep x = case maybePrefixMatch "-optdep" x of
             Just rest -> rest
             Nothing -> x

825
826
addCmdlineFramework f d = d{ cmdlineFrameworks = f : cmdlineFrameworks d}

David Waern's avatar
David Waern committed
827
828
addHaddockOpts f d = d{ haddockOptions = Just f}

829
830
831
-- -----------------------------------------------------------------------------
-- Command-line options

832
-- | When invoking external tools as part of the compilation pipeline, we
833
834
-- pass these a sequence of options on the command-line. Rather than
-- just using a list of Strings, we use a type that allows us to distinguish
835
-- between filepaths and 'other stuff'. The reason for this is that
836
-- this type gives us a handle on transforming filenames, and filenames only,
837
-- to whatever format they're expected to be on a particular platform.
838
839
data Option
 = FileOption -- an entry that _contains_ filename(s) / filepaths.
Ian Lynagh's avatar
Ian Lynagh committed
840
841
842
              String  -- a non-filepath prefix that shouldn't be
                      -- transformed (e.g., "/out=")
              String  -- the filepath/filename portion
843
 | Option     String
Ian Lynagh's avatar
Ian Lynagh committed
844

845
846
847
848
-----------------------------------------------------------------------------
-- Setting the optimisation level

updOptLevel :: Int -> DynFlags -> DynFlags
849
-- ^ Sets the 'DynFlags' to be appropriate to the optimisation level
850
updOptLevel n dfs
851
  = dfs2{ optLevel = final_n }
852
  where
Ian Lynagh's avatar
Ian Lynagh committed
853
   final_n = max 0 (min 2 n)    -- Clamp to 0 <= n <= 2
854
855
856
   dfs1 = foldr (flip dopt_unset) dfs  remove_dopts
   dfs2 = foldr (flip dopt_set)   dfs1 extra_dopts

857
858
   extra_dopts  = [ f | (ns,f) <- optLevelFlags, final_n `elem` ns ]
   remove_dopts = [ f | (ns,f) <- optLevelFlags, final_n `notElem` ns ]
Ian Lynagh's avatar
Ian Lynagh committed
859

860
861
optLevelFlags :: [([Int], DynFlag)]
optLevelFlags
Ian Lynagh's avatar
Ian Lynagh committed
862
  = [ ([0],     Opt_IgnoreInterfacePragmas)
863
    , ([0],     Opt_OmitInterfacePragmas)
864

Ian Lynagh's avatar
Ian Lynagh committed
865
    , ([1,2],   Opt_IgnoreAsserts)
866
867
    , ([1,2],   Opt_EnableRewriteRules)  -- Off for -O0; see Note [Scoping for Builtin rules]
                                         --              in PrelRules
Ian Lynagh's avatar
Ian Lynagh committed
868
869
870
871
872
    , ([1,2],   Opt_DoEtaReduction)
    , ([1,2],   Opt_CaseMerge)
    , ([1,2],   Opt_Strictness)
    , ([1,2],   Opt_CSE)
    , ([1,2],   Opt_FullLaziness)
873

Ian Lynagh's avatar
Ian Lynagh committed
874
875
    , ([2],     Opt_LiberateCase)
    , ([2],     Opt_SpecConstr)
876
877
878
879
880
881
882
883
884
885

--     , ([2],     Opt_StaticArgumentTransformation)
-- Max writes: I think it's probably best not to enable SAT with -O2 for the
-- 6.10 release. The version of SAT in HEAD at the moment doesn't incorporate
-- several improvements to the heuristics, and I'm concerned that without
-- those changes SAT will interfere with some attempts to write "high
-- performance Haskell", as we saw in some posts on Haskell-Cafe earlier
-- this year. In particular, the version in HEAD lacks the tail call
-- criterion, so many things that look like reasonable loops will be
-- turned into functions with extra (unneccesary) thunk creation.
886
887

    , ([0,1,2], Opt_DoLambdaEtaExpansion)
Ian Lynagh's avatar
Ian Lynagh committed
888
889
890
891
                -- This one is important for a tiresome reason:
                -- we want to make sure that the bindings for data
                -- constructors are eta-expanded.  This is probably
                -- a good thing anyway, but it seems fragile.
892
893
894
895
896
    ]

-- -----------------------------------------------------------------------------
-- Standard sets of warning options

twanvl's avatar
twanvl committed
897
standardWarnings :: [DynFlag]
898
standardWarnings
Ian Lynagh's avatar
Ian Lynagh committed
899
    = [ Opt_WarnWarningsDeprecations,
900
        Opt_WarnDeprecatedFlags,
901
        Opt_WarnUnrecognisedPragmas,
Ian Lynagh's avatar
Ian Lynagh committed
902
903
904
        Opt_WarnOverlappingPatterns,
        Opt_WarnMissingFields,
        Opt_WarnMissingMethods,
905
906
        Opt_WarnDuplicateExports,
        Opt_WarnDodgyForeignImports
907
908
      ]

twanvl's avatar
twanvl committed
909
minusWOpts :: [DynFlag]
910
minusWOpts
Ian Lynagh's avatar
Ian Lynagh committed
911
912
913
914
915
916
    = standardWarnings ++
      [ Opt_WarnUnusedBinds,
        Opt_WarnUnusedMatches,
        Opt_WarnUnusedImports,
        Opt_WarnIncompletePatterns,
        Opt_WarnDodgyImports
917
918
      ]

twanvl's avatar
twanvl committed
919
minusWallOpts :: [DynFlag]
920
921
minusWallOpts
    = minusWOpts ++
Ian Lynagh's avatar
Ian Lynagh committed
922
923
924
925
926
      [ Opt_WarnTypeDefaults,
        Opt_WarnNameShadowing,
        Opt_WarnMissingSigs,
        Opt_WarnHiShadows,
        Opt_WarnOrphans
927
928
      ]

929
-- minuswRemovesOpts should be every warning option
twanvl's avatar
twanvl committed
930
minuswRemovesOpts :: [DynFlag]
931
932
933
934
935
936
minuswRemovesOpts
    = minusWallOpts ++
      [Opt_WarnImplicitPrelude,
       Opt_WarnIncompletePatternsRecUpd,
       Opt_WarnSimplePatterns,
       Opt_WarnMonomorphism,
937
       Opt_WarnUnrecognisedPragmas,
938
939
940
       Opt_WarnTabs
      ]

941
942
943
-- -----------------------------------------------------------------------------
-- CoreToDo:  abstraction of core-to-core passes to run.

Ian Lynagh's avatar
Ian Lynagh committed
944
945
946
data CoreToDo           -- These are diff core-to-core passes,
                        -- which may be invoked in any order,
                        -- as many times as you like.
947

Ian Lynagh's avatar
Ian Lynagh committed
948
949
950
951
952
  = CoreDoSimplify      -- The core-to-core simplifier.
        SimplifierMode
        [SimplifierSwitch]
                        -- Each run of the simplifier can take a different
                        -- set of simplifier-specific flags.
953
954
955
956
957
958
959
960
961
962
963
964
  | CoreDoFloatInwards
  | CoreDoFloatOutwards FloatOutSwitches
  | CoreLiberateCase
  | CoreDoPrintCore
  | CoreDoStaticArgs
  | CoreDoStrictness
  | CoreDoWorkerWrapper
  | CoreDoSpecialising
  | CoreDoSpecConstr
  | CoreDoOldStrictness
  | CoreDoGlomBinds
  | CoreCSE
Ian Lynagh's avatar
Ian Lynagh committed
965
966
  | CoreDoRuleCheck Int{-CompilerPhase-} String -- Check for non-application of rules
                                                -- matching this string
967
  | CoreDoVectorisation PackageId
Ian Lynagh's avatar
Ian Lynagh committed
968
969
  | CoreDoNothing                -- Useful when building up
  | CoreDoPasses [CoreToDo]      -- lists of these things
970

971

Ian Lynagh's avatar
Ian Lynagh committed
972
data SimplifierMode             -- See comments in SimplMonad
973
  = SimplGently
974
  | SimplPhase Int [String]
975

976
977
978
979
980
instance Outputable SimplifierMode where
    ppr SimplGently       = ptext (sLit "gentle")
    ppr (SimplPhase n ss) = int n <+> brackets (text (concat $ intersperse "," ss))


981
982
983
984
data SimplifierSwitch
  = MaxSimplifierIterations Int
  | NoCaseOfCase

985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002

data FloatOutSwitches = FloatOutSwitches {
        floatOutLambdas :: Bool,     -- ^ True <=> float lambdas to top level
        floatOutConstants :: Bool    -- ^ True <=> float constants to top level,
                                     --            even if they do not escape a lambda
    }

instance Outputable FloatOutSwitches where
    ppr = pprFloatOutSwitches

pprFloatOutSwitches :: FloatOutSwitches -> SDoc
pprFloatOutSwitches sw = pp_not (floatOutLambdas sw) <+> text "lambdas" <> comma
                     <+> pp_not (floatOutConstants sw) <+> text "constants"
  where
    pp_not True  = empty
    pp_not False = text "not"

-- | Switches that specify the minimum amount of floating out
1003
1004
-- gentleFloatOutSwitches :: FloatOutSwitches
-- gentleFloatOutSwitches = FloatOutSwitches False False
1005
1006
1007
1008

-- | Switches that do not specify floating out of lambdas, just of constants
constantsOnlyFloatOutSwitches :: FloatOutSwitches
constantsOnlyFloatOutSwitches = FloatOutSwitches False True
1009
1010
1011


-- The core-to-core pass ordering is derived from the DynFlags: