DynFlags.hs 60.3 KB
Newer Older
1

2
{-# OPTIONS -fno-warn-missing-fields #-}
3
4
5
6
7
8
9
10
11
12
13
14
15
-----------------------------------------------------------------------------
--
-- Dynamic flags
--
-- Most flags are dynamic flags, which means they can change from
-- compilation to compilation using OPTIONS_GHC pragmas, and in a
-- multi-session GHC each session can be using different dynamic
-- flags.  Dynamic flags can also be set at the prompt in GHCi.
--
-- (c) The University of Glasgow 2005
--
-----------------------------------------------------------------------------

16
{-# OPTIONS -w #-}
17
18
19
-- The above warning supression flag is a temporary kludge.
-- While working on this module you are encouraged to remove it and fix
-- any warnings in the module. See
Ian Lynagh's avatar
Ian Lynagh committed
20
--     http://hackage.haskell.org/trac/ghc/wiki/Commentary/CodingStyle#Warnings
21
22
-- for details

23
24
25
26
module DynFlags (
	-- Dynamic flags
	DynFlag(..),
	DynFlags(..),
27
	HscTarget(..), isObjectTarget, defaultObjectTarget,
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
	GhcMode(..), isOneShot,
	GhcLink(..), isNoLink,
	PackageFlag(..),
	Option(..),

	-- Configuration of the core-to-core and stg-to-stg phases
	CoreToDo(..),
	StgToDo(..),
	SimplifierSwitch(..), 
	SimplifierMode(..), FloatOutSwitches(..),
	getCoreToDo, getStgToDo,
	
	-- Manipulating DynFlags
	defaultDynFlags,		-- DynFlags
	initDynFlags,			-- DynFlags -> IO DynFlags

	dopt,				-- DynFlag -> DynFlags -> Bool
	dopt_set, dopt_unset,		-- DynFlags -> DynFlag -> DynFlags
	getOpts,			-- (DynFlags -> [a]) -> IO [a]
	getVerbFlag,
	updOptLevel,
49
	setTmpDir,
50
	setPackageName,
51
52
53
	
	-- parsing DynFlags
	parseDynamicFlags,
54
        allFlags,
55
56

	-- misc stuff
Ian Lynagh's avatar
Ian Lynagh committed
57
58
	machdepCCOpts, picCCOpts,
    supportedLanguages,
59
    compilerInfo,
60
61
62
63
  ) where

#include "HsVersions.h"

64
import Module		( Module, mkModuleName, mkModule, ModLocation )
Simon Marlow's avatar
Simon Marlow committed
65
import PackageConfig
66
import PrelNames	( mAIN )
Simon Marlow's avatar
Simon Marlow committed
67
68
69
70
#ifdef i386_TARGET_ARCH
import StaticFlags	( opt_Static )
#endif
import StaticFlags	( opt_PIC, WayName(..), v_Ways, v_Build_tag,
71
			  v_RTS_Build_tag )
72
73
74
75
import {-# SOURCE #-} Packages (PackageState)
import DriverPhases	( Phase(..), phaseInputExt )
import Config
import CmdLineParser
76
import Constants	( mAX_CONTEXT_REDUCTION_DEPTH )
77
import Panic		( panic, GhcException(..) )
78
import UniqFM           ( UniqFM )
79
import Util
80
import Maybes		( orElse, fromJust )
81
import SrcLoc           ( SrcSpan )
Simon Marlow's avatar
Simon Marlow committed
82
83
import Outputable
import {-# SOURCE #-} ErrUtils ( Severity(..), Message, mkLocMessage )
84

Simon Marlow's avatar
Simon Marlow committed
85
86
87
import Data.IORef	( readIORef )
import Control.Exception ( throwDyn )
import Control.Monad	( when )
88
#ifdef mingw32_TARGET_OS
89
import Data.List	( isPrefixOf )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
90
91
#else
import Util		( split )
92
#endif
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
93

94
import Data.Char	( isUpper )
95
96
import System.IO        ( hPutStrLn, stderr )

97
98
99
100
101
102
103
-- -----------------------------------------------------------------------------
-- DynFlags

data DynFlag

   -- debugging flags
   = Opt_D_dump_cmm
104
   | Opt_D_dump_cmmz
105
   | Opt_D_dump_cps_cmm
106
   | Opt_D_dump_cvt_cmm
107
   | Opt_D_dump_asm
108
109
   | Opt_D_dump_asm_native
   | Opt_D_dump_asm_liveness
110
   | Opt_D_dump_asm_coalesce
111
112
113
   | Opt_D_dump_asm_regalloc
   | Opt_D_dump_asm_regalloc_stages
   | Opt_D_dump_asm_conflicts
114
   | Opt_D_dump_asm_stats
115
116
117
118
119
120
   | Opt_D_dump_cpranal
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_flatC
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
121
   | Opt_D_dump_rule_firings
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
   | Opt_D_dump_occur_anal
   | Opt_D_dump_parsed
   | Opt_D_dump_rn
   | Opt_D_dump_simpl
   | Opt_D_dump_simpl_iterations
   | 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
145
   | Opt_D_dump_hpc
146
147
148
149
150
151
   | 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
152
   | Opt_D_dump_mod_cycles
153
   | Opt_D_faststring_stats
154
   | Opt_DumpToFile			-- ^ Append dump output to files instead of stdout.
155
156
157
158
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting

159
   | Opt_WarnIsError			-- -Werror; makes warnings fatal
160
161
   | Opt_WarnDuplicateExports
   | Opt_WarnHiShadows
162
   | Opt_WarnImplicitPrelude
163
164
165
166
167
168
169
170
171
   | Opt_WarnIncompletePatterns
   | Opt_WarnIncompletePatternsRecUpd
   | Opt_WarnMissingFields
   | Opt_WarnMissingMethods
   | Opt_WarnMissingSigs
   | Opt_WarnNameShadowing
   | Opt_WarnOverlappingPatterns
   | Opt_WarnSimplePatterns
   | Opt_WarnTypeDefaults
172
   | Opt_WarnMonomorphism
173
174
175
176
177
178
   | Opt_WarnUnusedBinds
   | Opt_WarnUnusedImports
   | Opt_WarnUnusedMatches
   | Opt_WarnDeprecations
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
179
   | Opt_WarnTabs
180
181

   -- language opts
182
183
184
   | Opt_OverlappingInstances
   | Opt_UndecidableInstances
   | Opt_IncoherentInstances
185
   | Opt_MonomorphismRestriction
186
   | Opt_MonoPatBinds
187
   | Opt_ExtendedDefaultRules		-- Use GHC's extended rules for defaulting
188
   | Opt_ForeignFunctionInterface
Ian Lynagh's avatar
Ian Lynagh committed
189
   | Opt_UnliftedFFITypes
190
191
   | Opt_PArr				-- Syntactic support for parallel arrays
   | Opt_Arrows				-- Arrow-notation syntax
192
   | Opt_TemplateHaskell
193
194
195
196
   | Opt_ImplicitParams
   | Opt_Generics
   | Opt_ImplicitPrelude 
   | Opt_ScopedTypeVariables
Ian Lynagh's avatar
Ian Lynagh committed
197
   | Opt_UnboxedTuples
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
198
   | Opt_BangPatterns
199
   | Opt_TypeFamilies
200
   | Opt_OverloadedStrings
201
   | Opt_DisambiguateRecordFields
202
   | Opt_RecordWildCards
203
   | Opt_RecordPuns
204
   | Opt_GADTs
205
   | Opt_RelaxedPolyRec
206
   | Opt_StandaloneDeriving
207
   | Opt_DeriveDataTypeable
208
   | Opt_TypeSynonymInstances
Ian Lynagh's avatar
Ian Lynagh committed
209
   | Opt_FlexibleContexts
210
   | Opt_FlexibleInstances
211
   | Opt_ConstrainedClassMethods
Ian Lynagh's avatar
Ian Lynagh committed
212
   | Opt_MultiParamTypeClasses
213
   | Opt_FunctionalDependencies
Ian Lynagh's avatar
Ian Lynagh committed
214
   | Opt_UnicodeSyntax
Ian Lynagh's avatar
Ian Lynagh committed
215
   | Opt_PolymorphicComponents
216
   | Opt_ExistentialQuantification
217
   | Opt_MagicHash
Ian Lynagh's avatar
Ian Lynagh committed
218
   | Opt_EmptyDataDecls
Ian Lynagh's avatar
Ian Lynagh committed
219
   | Opt_KindSignatures
Ian Lynagh's avatar
Ian Lynagh committed
220
   | Opt_PatternSignatures
Ian Lynagh's avatar
Ian Lynagh committed
221
   | Opt_ParallelListComp
222
   | Opt_GeneralizedNewtypeDeriving
Ian Lynagh's avatar
Ian Lynagh committed
223
   | Opt_RecursiveDo
Ian Lynagh's avatar
Ian Lynagh committed
224
   | Opt_PatternGuards
225
   | Opt_PartiallyAppliedClosedTypeSynonyms
226
227
   | Opt_Rank2Types
   | Opt_RankNTypes
Ian Lynagh's avatar
Ian Lynagh committed
228
   | Opt_TypeOperators
229

230
231
   | Opt_PrintExplicitForalls

232
233
234
235
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
   | Opt_CSE
236
237
   | Opt_LiberateCase
   | Opt_SpecConstr
238
239
240
241
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
242
   | Opt_IgnoreBreakpoints
243
244
245
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
246
   | Opt_DictsCheap
247
   | Opt_RewriteRules
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
248
   | Opt_Vectorise
249
250
   | Opt_RegsGraph			-- do graph coloring register allocation
   | Opt_RegsIterative			-- do iterative coalescing graph coloring register allocation
251
252
253
254

   -- misc opts
   | Opt_Cpp
   | Opt_Pp
255
   | Opt_ForceRecomp
256
257
258
259
260
261
262
   | Opt_DryRun
   | Opt_DoAsmMangling
   | Opt_ExcessPrecision
   | Opt_ReadUserPackageConf
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
263
   | Opt_HideAllPackages
264
   | Opt_PrintBindResult
265
   | Opt_Haddock
266
   | Opt_Hpc_No_Auto
267
   | Opt_BreakOnException
268
   | Opt_BreakOnError
269
270
   | Opt_GenManifest
   | Opt_EmbedManifest
271
272
   | Opt_RunCPSZ
   | Opt_ConvertToZipCfgAndBack
273
274
275
276
277
278
279
280

   -- keeping stuff
   | Opt_KeepHiDiffs
   | Opt_KeepHcFiles
   | Opt_KeepSFiles
   | Opt_KeepRawSFiles
   | Opt_KeepTmpFiles

281
   deriving (Eq, Show)
282
 
283
284
285
286
287
288
289
290
291
292
293
294
data DynFlags = DynFlags {
  ghcMode		:: GhcMode,
  ghcLink		:: GhcLink,
  coreToDo   		:: Maybe [CoreToDo], -- reserved for -Ofile
  stgToDo    		:: Maybe [StgToDo],  -- similarly
  hscTarget    		:: HscTarget,
  hscOutName 		:: String,  	-- name of the output file
  extCoreName		:: String,	-- name of the .core output file
  verbosity  		:: Int,	 	-- verbosity level
  optLevel		:: Int,		-- optimisation level
  maxSimplIterations    :: Int,		-- max simplifier iterations
  ruleCheck		:: Maybe String,
295
296

  specThreshold		:: Int,		-- Threshold for function specialisation
297

298
299
300
  stolen_x86_regs	:: Int,		
  cmdlineHcIncludes	:: [String],	-- -#includes
  importPaths		:: [FilePath],
301
  mainModIs		:: Module,
302
  mainFunIs		:: Maybe String,
303
304
  ctxtStkDepth	        :: Int,		-- Typechecker context stack depth

Simon Marlow's avatar
Simon Marlow committed
305
  thisPackage		:: PackageId,
306
307
308
309
310
311
312

  -- ways
  wayNames		:: [WayName],	-- way flags from the cmd line
  buildTag		:: String,	-- the global "way" (eg. "p" for prof)
  rtsBuildTag		:: String,	-- the RTS "way"
  
  -- paths etc.
313
314
315
316
  objectDir		:: Maybe String,
  hiDir			:: Maybe String,
  stubDir		:: Maybe String,

317
318
319
  objectSuf		:: String,
  hcSuf			:: String,
  hiSuf			:: String,
320
321
322
323

  outputFile		:: Maybe String,
  outputHi		:: Maybe String,

324
325
326
327
328
329
330
331
  -- | This is set by DriverPipeline.runPipeline based on where
  --	its output is going.
  dumpPrefix		:: Maybe FilePath,

  -- | Override the dumpPrefix set by runPipeline.
  --	Set by -ddump-file-prefix
  dumpPrefixForce	:: Maybe FilePath,

332
333
334
335
  includePaths		:: [String],
  libraryPaths		:: [String],
  frameworkPaths	:: [String],  	-- used on darwin only
  cmdlineFrameworks	:: [String],	-- ditto
336
  tmpDir		:: String,	-- no trailing '/'
337
  
338
339
340
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto

andy@galois.com's avatar
andy@galois.com committed
341
342
  hpcDir		:: String,	-- ^ path to store the .mix files

343
344
345
346
347
348
349
350
351
  -- options for particular phases
  opt_L			:: [String],
  opt_P			:: [String],
  opt_F			:: [String],
  opt_c			:: [String],
  opt_m			:: [String],
  opt_a			:: [String],
  opt_l			:: [String],
  opt_dep		:: [String],
352
  opt_windres		:: [String],
353
354
355
356
357
358
359
360
361
362
363

  -- commands for particular phases
  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]),
364
365
  pgm_T                 :: String,
  pgm_sysman            :: String,
366
  pgm_windres           :: String,
367

368
  --  Package flags
369
  extraPkgConfs		:: [FilePath],
370
371
  topDir                :: FilePath,    -- filled in by SysTools
  systemPackageConfig   :: FilePath,    -- ditto
372
373
374
375
376
377
	-- The -package-conf flags given on the command line, in the order
	-- they appeared.

  packageFlags		:: [PackageFlag],
	-- The -package and -hide-package flags from the command-line

378
379
380
381
  -- Package state
  -- NB. do not modify this field, it is calculated by 
  -- Packages.initPackages and Packages.updatePackages.
  pkgDatabase           :: Maybe (UniqFM InstalledPackageInfo),
382
383
384
  pkgState		:: PackageState,

  -- hsc dynamic flags
385
386
387
388
  flags      		:: [DynFlag],
  
  -- message output
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO ()
389
390
391
392
393
394
395
396
397
398
 }

data HscTarget
  = HscC
  | HscAsm
  | HscJava
  | HscInterpreted
  | HscNothing
  deriving (Eq, Show)

399
400
401
402
403
404
405
406
407
408
409
410
-- | will this target result in an object file on the disk?
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.
411
data GhcMode
412
413
414
  = CompManager         -- ^ --make, GHCi, etc.
  | OneShot		-- ^ ghc -c Foo.hs
  | MkDepend            -- ^ ghc -M, see Finder for why we need this
415
416
417
418
419
420
  deriving Eq

isOneShot :: GhcMode -> Bool
isOneShot OneShot = True
isOneShot _other  = False

421
-- | What kind of linking to do.
422
data GhcLink	-- What to do in the link step, if there is one
423
424
425
  = NoLink		-- Don't link at all
  | LinkBinary		-- Link object code into a binary
  | LinkInMemory        -- Use the in-memory dynamic linker
426
  | LinkDynLib		-- Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
427
  deriving Eq
428
429
430
431
432
433
434
435
436

isNoLink :: GhcLink -> Bool
isNoLink NoLink = True
isNoLink other  = False

data PackageFlag
  = ExposePackage  String
  | HidePackage    String
  | IgnorePackage  String
437
  deriving Eq
438

439
440
441
442
443
defaultHscTarget = defaultObjectTarget

-- | the 'HscTarget' value corresponding to the default way to create
-- object files on the current platform.
defaultObjectTarget
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
  | cGhcWithNativeCodeGen == "YES" 	=  HscAsm
  | otherwise				=  HscC

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
 return dflags{
	wayNames	= ways,
	buildTag	= build_tag,
	rtsBuildTag	= rts_build_tag
	}

defaultDynFlags =
     DynFlags {
460
461
	ghcMode			= CompManager,
	ghcLink			= LinkBinary,
462
463
464
465
466
467
468
469
470
	coreToDo 		= Nothing,
	stgToDo			= Nothing, 
	hscTarget		= defaultHscTarget, 
	hscOutName		= "", 
	extCoreName		= "",
	verbosity		= 0, 
	optLevel		= 0,
	maxSimplIterations	= 4,
	ruleCheck		= Nothing,
471
	specThreshold		= 200,
472
473
474
	stolen_x86_regs		= 4,
	cmdlineHcIncludes	= [],
	importPaths		= ["."],
475
	mainModIs		= mAIN,
476
	mainFunIs		= Nothing,
477
478
	ctxtStkDepth		= mAX_CONTEXT_REDUCTION_DEPTH,

Simon Marlow's avatar
Simon Marlow committed
479
	thisPackage		= mainPackageId,
480

481
482
483
484
	objectDir		= Nothing,
	hiDir			= Nothing,
	stubDir			= Nothing,

485
486
487
	objectSuf		= phaseInputExt StopLn,
	hcSuf			= phaseInputExt HCc,
	hiSuf			= "hi",
488
489
490

	outputFile		= Nothing,
	outputHi		= Nothing,
491
492
	dumpPrefix		= Nothing,
	dumpPrefixForce		= Nothing,
493
494
495
496
	includePaths		= [],
	libraryPaths		= [],
	frameworkPaths		= [],
	cmdlineFrameworks	= [],
497
	tmpDir			= cDEFAULT_TMPDIR,
498
	
andy@galois.com's avatar
andy@galois.com committed
499
500
        hpcDir		        = ".hpc",

501
	opt_L			= [],
502
503
504
	opt_P			= (if opt_PIC
				   then ["-D__PIC__"]
				   else []),
505
506
507
508
509
510
	opt_F			= [],
	opt_c			= [],
	opt_a			= [],
	opt_m			= [],
	opt_l			= [],
	opt_dep			= [],
511
        opt_windres             = [],
512
513
514
	
	extraPkgConfs		= [],
	packageFlags		= [],
515
516
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
517
518
519
	flags = [ 
    	    Opt_ReadUserPackageConf,
    
520
521
522
523
	    Opt_MonoPatBinds, 	-- Experimentally, I'm making this non-standard
				-- behaviour the default, to see if anyone notices
				-- SLPJ July 06

524
525
    	    Opt_ImplicitPrelude,
    	    Opt_MonomorphismRestriction,
526

527
528
    	    Opt_DoAsmMangling,
    
529
530
531
            Opt_GenManifest,
            Opt_EmbedManifest,

532
	    -- on by default:
533
534
535
536
	    Opt_PrintBindResult ]
	    ++ [f | (ns,f) <- optLevelFlags, 0 `elem` ns]
	    	    -- The default -O0 options
	    ++ standardWarnings,
537
538
539
540
541
542
               
        log_action = \severity srcSpan style msg -> 
                        case severity of
                          SevInfo  -> hPutStrLn stderr (show (msg style))
                          SevFatal -> hPutStrLn stderr (show (msg style))
                          _        -> hPutStrLn stderr ('\n':show ((mkLocMessage srcSpan msg) style))
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
      }

{- 
    Verbosity levels:
	
    0	|   print errors & warnings only
    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"
-}

dopt :: DynFlag -> DynFlags -> Bool
dopt f dflags  = f `elem` (flags dflags)

dopt_set :: DynFlags -> DynFlag -> DynFlags
dopt_set dfs f = dfs{ flags = f : flags dfs }

dopt_unset :: DynFlags -> DynFlag -> DynFlags
dopt_unset dfs f = dfs{ flags = filter (/= f) (flags dfs) }

getOpts :: DynFlags -> (DynFlags -> [a]) -> [a]
getOpts dflags opts = reverse (opts dflags)
	-- We add to the options from the front, so we need to reverse the list

getVerbFlag :: DynFlags -> String
getVerbFlag dflags 
  | verbosity dflags >= 3  = "-v" 
  | otherwise =  ""

574
575
576
577
setObjectDir  f d = d{ objectDir  = f}
setHiDir      f d = d{ hiDir      = f}
setStubDir    f d = d{ stubDir    = f}

578
579
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
580
581
582
583
setHcSuf      f d = d{ hcSuf      = f}

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

585
586
setDumpPrefixForce f d = d { dumpPrefixForce = f}

587
588
589
590
591
592
593
594
595
596
597
598
-- 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,[])}
599
setPgmwindres f d = d{ pgm_windres = f}
600
601
602
603
604
605
606
607
608

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}
addOptdep f d = d{ opt_dep = f : opt_dep d}
609
addOptwindres f d = d{ opt_windres = f : opt_windres d}
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635

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

-- -----------------------------------------------------------------------------
-- Command-line options

-- When invoking external tools as part of the compilation pipeline, we
-- 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
-- between filepaths and 'other stuff'. [The reason being, of course, that
-- this type gives us a handle on transforming filenames, and filenames only,
-- to whatever format they're expected to be on a particular platform.]

data Option
 = FileOption -- an entry that _contains_ filename(s) / filepaths.
              String  -- a non-filepath prefix that shouldn't be 
		      -- transformed (e.g., "/out=")
 	      String  -- the filepath/filename portion
 | Option     String
 
-----------------------------------------------------------------------------
-- Setting the optimisation level

updOptLevel :: Int -> DynFlags -> DynFlags
-- Set dynflags appropriate to the optimisation level
updOptLevel n dfs
636
  = dfs2{ optLevel = final_n }
637
  where
638
   final_n = max 0 (min 2 n)	-- Clamp to 0 <= n <= 2
639
640
641
   dfs1 = foldr (flip dopt_unset) dfs  remove_dopts
   dfs2 = foldr (flip dopt_set)   dfs1 extra_dopts

642
643
   extra_dopts  = [ f | (ns,f) <- optLevelFlags, final_n `elem` ns ]
   remove_dopts = [ f | (ns,f) <- optLevelFlags, final_n `notElem` ns ]
644
	
645
646
647
648
optLevelFlags :: [([Int], DynFlag)]
optLevelFlags
  = [ ([0],	Opt_IgnoreInterfacePragmas)
    , ([0],     Opt_OmitInterfacePragmas)
649

650
    , ([1,2],	Opt_IgnoreAsserts)
651
652
    , ([1,2],	Opt_RewriteRules)	-- Off for -O0; see Note [Scoping for Builtin rules]
					-- 		in PrelRules
653
654
655
656
657
    , ([1,2],	Opt_DoEtaReduction)
    , ([1,2],	Opt_CaseMerge)
    , ([1,2],	Opt_Strictness)
    , ([1,2],	Opt_CSE)
    , ([1,2],	Opt_FullLaziness)
658

659
660
661
662
663
664
665
666
    , ([2],	Opt_LiberateCase)
    , ([2],	Opt_SpecConstr)

    , ([0,1,2], Opt_DoLambdaEtaExpansion)
		-- 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.
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
    ]

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

standardWarnings
    = [ Opt_WarnDeprecations,
	Opt_WarnOverlappingPatterns,
	Opt_WarnMissingFields,
	Opt_WarnMissingMethods,
	Opt_WarnDuplicateExports
      ]

minusWOpts
    = standardWarnings ++ 
      [	Opt_WarnUnusedBinds,
	Opt_WarnUnusedMatches,
	Opt_WarnUnusedImports,
	Opt_WarnIncompletePatterns,
	Opt_WarnDodgyImports
      ]

minusWallOpts
    = minusWOpts ++
      [	Opt_WarnTypeDefaults,
	Opt_WarnNameShadowing,
	Opt_WarnMissingSigs,
	Opt_WarnHiShadows,
	Opt_WarnOrphans
      ]

698
699
700
701
702
703
704
705
706
707
-- minuswRemovesOpts should be every warning option
minuswRemovesOpts
    = minusWallOpts ++
      [Opt_WarnImplicitPrelude,
       Opt_WarnIncompletePatternsRecUpd,
       Opt_WarnSimplePatterns,
       Opt_WarnMonomorphism,
       Opt_WarnTabs
      ]

708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
-- -----------------------------------------------------------------------------
-- CoreToDo:  abstraction of core-to-core passes to run.

data CoreToDo		-- These are diff core-to-core passes,
			-- which may be invoked in any order,
  			-- as many times as you like.

  = CoreDoSimplify	-- The core-to-core simplifier.
	SimplifierMode
	[SimplifierSwitch]
			-- Each run of the simplifier can take a different
			-- set of simplifier-specific flags.
  | CoreDoFloatInwards
  | CoreDoFloatOutwards FloatOutSwitches
  | CoreLiberateCase
  | CoreDoPrintCore
  | CoreDoStaticArgs
  | CoreDoStrictness
  | CoreDoWorkerWrapper
  | CoreDoSpecialising
  | CoreDoSpecConstr
  | CoreDoOldStrictness
  | CoreDoGlomBinds
  | CoreCSE
  | CoreDoRuleCheck Int{-CompilerPhase-} String	-- Check for non-application of rules 
						-- matching this string
734
  | CoreDoVectorisation
735
736
  | CoreDoNothing 		 -- Useful when building up 
  | CoreDoPasses [CoreToDo] 	 -- lists of these things
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752

data SimplifierMode 		-- See comments in SimplMonad
  = SimplGently
  | SimplPhase Int

data SimplifierSwitch
  = MaxSimplifierIterations Int
  | NoCaseOfCase

data FloatOutSwitches
  = FloatOutSw  Bool 	-- True <=> float lambdas to top level
		Bool	-- True <=> float constants to top level,
			-- 	    even if they do not escape a lambda


-- The core-to-core pass ordering is derived from the DynFlags:
753
754
755
runWhen :: Bool -> CoreToDo -> CoreToDo
runWhen True  do_this = do_this
runWhen False do_this = CoreDoNothing
756
757
758
759
760
761
762
763
764
765
766

getCoreToDo :: DynFlags -> [CoreToDo]
getCoreToDo dflags
  | Just todo <- coreToDo dflags = todo -- set explicitly by user
  | otherwise = core_todo
  where
    opt_level  	  = optLevel dflags
    max_iter   	  = maxSimplIterations dflags
    strictness    = dopt Opt_Strictness dflags
    full_laziness = dopt Opt_FullLaziness dflags
    cse           = dopt Opt_CSE dflags
767
768
    spec_constr   = dopt Opt_SpecConstr dflags
    liberate_case = dopt Opt_LiberateCase dflags
769
    rule_check    = ruleCheck dflags
770
    vectorisation = dopt Opt_Vectorise dflags
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792

    core_todo = 
     if opt_level == 0 then
      [
	CoreDoSimplify (SimplPhase 0) [
	    MaxSimplifierIterations max_iter
	]
      ]
     else {- opt_level >= 1 -} [ 

	-- initial simplify: mk specialiser happy: minimum effort please
	CoreDoSimplify SimplGently [
			-- 	Simplify "gently"
			-- Don't inline anything till full laziness has bitten
			-- In particular, inlining wrappers inhibits floating
			-- e.g. ...(case f x of ...)...
			--  ==> ...(case (case x of I# x# -> fw x#) of ...)...
			--  ==> ...(case x of I# x# -> case fw x# of ...)...
			-- and now the redex (f x) isn't floatable any more
			-- Similarly, don't apply any rules until after full 
			-- laziness.  Notably, list fusion can prevent floating.

simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
793
794
            NoCaseOfCase,	-- Don't do case-of-case transformations.
				-- This makes full laziness work better
795
796
797
	    MaxSimplifierIterations max_iter
	],

798
799
800
801
802
803
804
805
806

        -- We run vectorisation here for now, but we might also try to run
        -- it later
        runWhen vectorisation (CoreDoPasses [
                  CoreDoVectorisation,
                  CoreDoSimplify SimplGently
                                  [NoCaseOfCase,
                                   MaxSimplifierIterations max_iter]]),

807
808
809
810
	-- Specialisation is best done before full laziness
	-- so that overloaded functions have all their dictionary lambdas manifest
	CoreDoSpecialising,

811
	runWhen full_laziness (CoreDoFloatOutwards (FloatOutSw False False)),
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849

	CoreDoFloatInwards,

	CoreDoSimplify (SimplPhase 2) [
		-- Want to run with inline phase 2 after the specialiser to give
		-- maximum chance for fusion to work before we inline build/augment
		-- in phase 1.  This made a difference in 'ansi' where an 
		-- overloaded function wasn't inlined till too late.
	   MaxSimplifierIterations max_iter
	],
	case rule_check of { Just pat -> CoreDoRuleCheck 2 pat; Nothing -> CoreDoNothing },

	CoreDoSimplify (SimplPhase 1) [
		-- Need inline-phase2 here so that build/augment get 
		-- inlined.  I found that spectral/hartel/genfft lost some useful
		-- strictness in the function sumcode' if augment is not inlined
		-- before strictness analysis runs
	   MaxSimplifierIterations max_iter
	],
	case rule_check of { Just pat -> CoreDoRuleCheck 1 pat; Nothing -> CoreDoNothing },

	CoreDoSimplify (SimplPhase 0) [
		-- Phase 0: allow all Ids to be inlined now
		-- This gets foldr inlined before strictness analysis

	   MaxSimplifierIterations 3
		-- At least 3 iterations because otherwise we land up with
		-- huge dead expressions because of an infelicity in the 
		-- simpifier.   
		--	let k = BIG in foldr k z xs
		-- ==>  let k = BIG in letrec go = \xs -> ...(k x).... in go xs
		-- ==>  let k = BIG in letrec go = \xs -> ...(BIG x).... in go xs
		-- Don't stop now!

	],
	case rule_check of { Just pat -> CoreDoRuleCheck 0 pat; Nothing -> CoreDoNothing },

#ifdef OLD_STRICTNESS
850
	CoreDoOldStrictness,
851
#endif
852
853
854
855
856
857
858
859
860
861
862
	runWhen strictness (CoreDoPasses [
		CoreDoStrictness,
		CoreDoWorkerWrapper,
		CoreDoGlomBinds,
		CoreDoSimplify (SimplPhase 0) [
		   MaxSimplifierIterations max_iter
		]]),

	runWhen full_laziness 
	  (CoreDoFloatOutwards (FloatOutSw False    -- Not lambdas
					   True)),  -- Float constants
863
864
865
866
867
868
869
		-- nofib/spectral/hartel/wang doubles in speed if you
		-- do full laziness late in the day.  It only happens
		-- after fusion and other stuff, so the early pass doesn't
		-- catch it.  For the record, the redex is 
		--	  f_el22 (f_el21 r_midblock)


870
871
872
873
	runWhen cse CoreCSE,
		-- We want CSE to follow the final full-laziness pass, because it may
		-- succeed in commoning up things floated out by full laziness.
		-- CSE used to rely on the no-shadowing invariant, but it doesn't any more
874
875
876

	CoreDoFloatInwards,

877
	case rule_check of { Just pat -> CoreDoRuleCheck 0 pat; Nothing -> CoreDoNothing },
878

879
880
881
882
883
		-- Case-liberation for -O2.  This should be after
		-- strictness analysis and the simplification which follows it.
	runWhen liberate_case (CoreDoPasses [
	    CoreLiberateCase,
	    CoreDoSimplify (SimplPhase 0) [
884
		  MaxSimplifierIterations max_iter
885
	    ] ]),	-- Run the simplifier after LiberateCase to vastly 
886
887
888
			-- reduce the possiblility of shadowing
			-- Reason: see Note [Shadowing] in SpecConstr.lhs

889
	runWhen spec_constr CoreDoSpecConstr,
890
891

	-- Final clean-up simplification:
892
     	CoreDoSimplify (SimplPhase 0) [
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
	  MaxSimplifierIterations max_iter
	]
     ]

-- -----------------------------------------------------------------------------
-- StgToDo:  abstraction of stg-to-stg passes to run.

data StgToDo
  = StgDoMassageForProfiling  -- should be (next to) last
  -- There's also setStgVarInfo, but its absolute "lastness"
  -- is so critical that it is hardwired in (no flag).
  | D_stg_stats

getStgToDo :: DynFlags -> [StgToDo]
getStgToDo dflags
  | Just todo <- stgToDo dflags = todo -- set explicitly by user
  | otherwise = todo2
  where
	stg_stats = dopt Opt_StgStats dflags

	todo1 = if stg_stats then [D_stg_stats] else []

	todo2 | WayProf `elem` wayNames dflags
	      = StgDoMassageForProfiling : todo1
	      | otherwise
	      = todo1

-- -----------------------------------------------------------------------------
-- DynFlags parser

923
924
925
926
927
928
929
930
931
allFlags :: [String]
allFlags = map ('-':) $
           [ name | (name, optkind) <- dynamic_flags, ok optkind ] ++
           map ("fno-"++) flags ++
           map ("f"++) flags
    where ok (PrefixPred _ _) = False
          ok _ = True
          flags = map fst fFlags

932
933
934
935
936
937
dynamic_flags :: [(String, OptKind DynP)]
dynamic_flags = [
     ( "n"              , NoArg  (setDynFlag Opt_DryRun) )
  ,  ( "cpp"		, NoArg  (setDynFlag Opt_Cpp))
  ,  ( "F"		, NoArg  (setDynFlag Opt_Pp))
  ,  ( "#include"	, HasArg (addCmdlineHCInclude) )
938
  ,  ( "v"		, OptIntSuffix setVerbosity )
939

940
941
942
943
944
945
946
947
948
949
        ------- Specific phases  --------------------------------------------
  ,  ( "pgmL"           , HasArg (upd . setPgmL) )  
  ,  ( "pgmP"           , HasArg (upd . setPgmP) )  
  ,  ( "pgmF"           , HasArg (upd . setPgmF) )  
  ,  ( "pgmc"           , HasArg (upd . setPgmc) )  
  ,  ( "pgmm"           , HasArg (upd . setPgmm) )  
  ,  ( "pgms"           , HasArg (upd . setPgms) )  
  ,  ( "pgma"           , HasArg (upd . setPgma) )  
  ,  ( "pgml"           , HasArg (upd . setPgml) )  
  ,  ( "pgmdll"		, HasArg (upd . setPgmdll) )
950
  ,  ( "pgmwindres"     , HasArg (upd . setPgmwindres) )
951
952
953
954

  ,  ( "optL"		, HasArg (upd . addOptL) )  
  ,  ( "optP"		, HasArg (upd . addOptP) )  
  ,  ( "optF"           , HasArg (upd . addOptF) )  
955
  ,  ( "optc"		, HasArg (upd . addOptc) )  
956
957
958
959
  ,  ( "optm"		, HasArg (upd . addOptm) )  
  ,  ( "opta"		, HasArg (upd . addOpta) )  
  ,  ( "optl"		, HasArg (upd . addOptl) )  
  ,  ( "optdep"		, HasArg (upd . addOptdep) )
960
  ,  ( "optwindres"     , HasArg (upd . addOptwindres) )
961

962
963
964
965
  ,  ( "split-objs"	, NoArg (if can_split
				    then setDynFlag Opt_SplitObjs
				    else return ()) )

966
967
968
	-------- Linking ----------------------------------------------------
  ,  ( "c"		, NoArg (upd $ \d -> d{ ghcLink=NoLink } ))
  ,  ( "no-link"	, NoArg (upd $ \d -> d{ ghcLink=NoLink } )) -- Dep.
969
  ,  ( "shared"		, NoArg (upd $ \d -> d{ ghcLink=LinkDynLib } ))
970
971
972

	------- Libraries ---------------------------------------------------
  ,  ( "L"		, Prefix addLibraryPath )
973
  ,  ( "l"		, AnySuffix (\s -> do upd (addOptl s)))
974
975
976
977
978
979
980

	------- Frameworks --------------------------------------------------
        -- -framework-path should really be -F ...
  ,  ( "framework-path" , HasArg addFrameworkPath )
  ,  ( "framework"	, HasArg (upd . addCmdlineFramework) )

	------- Output Redirection ------------------------------------------
981
  ,  ( "odir"		, HasArg (upd . setObjectDir  . Just))
982
983
984
985
986
987
988
  ,  ( "o"		, SepArg (upd . setOutputFile . Just))
  ,  ( "ohi"		, HasArg (upd . setOutputHi   . Just ))
  ,  ( "osuf"		, HasArg (upd . setObjectSuf))
  ,  ( "hcsuf"		, HasArg (upd . setHcSuf))
  ,  ( "hisuf"		, HasArg (upd . setHiSuf))
  ,  ( "hidir"		, HasArg (upd . setHiDir . Just))
  ,  ( "tmpdir"		, HasArg (upd . setTmpDir))
989
  ,  ( "stubdir"	, HasArg (upd . setStubDir . Just))
990
  ,  ( "ddump-file-prefix", HasArg (upd . setDumpPrefixForce . Just))
991
992

	------- Keeping temporary files -------------------------------------
Ian Lynagh's avatar
Ian Lynagh committed
993
994
995
996
997
998
999
1000
1001
     -- These can be singular (think ghc -c) or plural (think ghc --make)
  ,  ( "keep-hc-file"    , NoArg (setDynFlag Opt_KeepHcFiles))
  ,  ( "keep-hc-files"   , NoArg (setDynFlag Opt_KeepHcFiles))
  ,  ( "keep-s-file"     , NoArg (setDynFlag Opt_KeepSFiles))
  ,  ( "keep-s-files"    , NoArg (setDynFlag Opt_KeepSFiles))
  ,  ( "keep-raw-s-file" , NoArg (setDynFlag Opt_KeepRawSFiles))
  ,  ( "keep-raw-s-files", NoArg (setDynFlag Opt_KeepRawSFiles))
     -- This only makes sense as plural
  ,  ( "keep-tmp-files"  , NoArg (setDynFlag Opt_KeepTmpFiles))
1002
1003
1004
1005

	------- Miscellaneous ----------------------------------------------
  ,  ( "no-hs-main"     , NoArg (setDynFlag Opt_NoHsMain))
  ,  ( "main-is"   	, SepArg setMainIs )
1006
  ,  ( "haddock"	, NoArg (setDynFlag Opt_Haddock) )
andy@galois.com's avatar
andy@galois.com committed
1007
  ,  ( "hpcdir"		, SepArg setOptHpcDir )
1008

1009
1010
1011
	------- recompilation checker (DEPRECATED, use -fforce-recomp) -----
  ,  ( "recomp"		, NoArg (unSetDynFlag Opt_ForceRecomp) )
  ,  ( "no-recomp"  	, NoArg (setDynFlag   Opt_ForceRecomp) )
1012
1013
1014
1015

        ------- Packages ----------------------------------------------------
  ,  ( "package-conf"   , HasArg extraPkgConf_ )
  ,  ( "no-user-package-conf", NoArg (unSetDynFlag Opt_ReadUserPackageConf) )
1016
  ,  ( "package-name"   , HasArg (upd . setPackageName) )
1017
1018
  ,  ( "package"        , HasArg exposePackage )
  ,  ( "hide-package"   , HasArg hidePackage )
1019
  ,  ( "hide-all-packages", NoArg (setDynFlag Opt_HideAllPackages) )
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
  ,  ( "ignore-package" , HasArg ignorePackage )
  ,  ( "syslib"         , HasArg exposePackage )  -- for compatibility

	------ HsCpp opts ---------------------------------------------------
  ,  ( "D",		AnySuffix (upd . addOptP) )
  ,  ( "U",		AnySuffix (upd . addOptP) )

	------- Include/Import Paths ----------------------------------------
  ,  ( "I" 		, Prefix    addIncludePath)
  ,  ( "i"		, OptPrefix addImportPath )

	------ Debugging ----------------------------------------------------
  ,  ( "dstg-stats",	NoArg (setDynFlag Opt_StgStats))

  ,  ( "ddump-cmm",         	 setDumpFlag Opt_D_dump_cmm)
1035
  ,  ( "ddump-cmmz",         	 setDumpFlag Opt_D_dump_cmmz)
1036
  ,  ( "ddump-cps-cmm",        	 setDumpFlag Opt_D_dump_cps_cmm)
1037
  ,  ( "ddump-cvt-cmm",        	 setDumpFlag Opt_D_dump_cvt_cmm)
1038
  ,  ( "ddump-asm",          	 setDumpFlag Opt_D_dump_asm)
1039
1040
  ,  ( "ddump-asm-native",       setDumpFlag Opt_D_dump_asm_native)
  ,  ( "ddump-asm-liveness",     setDumpFlag Opt_D_dump_asm_liveness)
1041
  ,  ( "ddump-asm-coalesce",     setDumpFlag Opt_D_dump_asm_coalesce)
1042
  ,  ( "ddump-asm-regalloc",     setDumpFlag Opt_D_dump_asm_regalloc)
1043
  ,  ( "ddump-asm-conflicts",    setDumpFlag Opt_D_dump_asm_conflicts)
1044
1045
  ,  ( "ddump-asm-regalloc-stages",
                                 setDumpFlag Opt_D_dump_asm_regalloc_stages)
1046
  ,  ( "ddump-asm-stats",        setDumpFlag Opt_D_dump_asm_stats)
1047
1048
1049
1050
1051
1052
  ,  ( "ddump-cpranal",      	 setDumpFlag Opt_D_dump_cpranal)
  ,  ( "ddump-deriv",        	 setDumpFlag Opt_D_dump_deriv)
  ,  ( "ddump-ds",           	 setDumpFlag Opt_D_dump_ds)
  ,  ( "ddump-flatC",        	 setDumpFlag Opt_D_dump_flatC)
  ,  ( "ddump-foreign",      	 setDumpFlag Opt_D_dump_foreign)
  ,  ( "ddump-inlinings",    	 setDumpFlag Opt_D_dump_inlinings)
1053
  ,  ( "ddump-rule-firings",   	 setDumpFlag Opt_D_dump_rule_firings)
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
  ,  ( "ddump-occur-anal",   	 setDumpFlag Opt_D_dump_occur_anal)
  ,  ( "ddump-parsed",       	 setDumpFlag Opt_D_dump_parsed)
  ,  ( "ddump-rn",           	 setDumpFlag Opt_D_dump_rn)
  ,  ( "ddump-simpl",        	 setDumpFlag Opt_D_dump_simpl)
  ,  ( "ddump-simpl-iterations", setDumpFlag Opt_D_dump_simpl_iterations)
  ,  ( "ddump-spec",         	 setDumpFlag Opt_D_dump_spec)
  ,  ( "ddump-prep",          	 setDumpFlag Opt_D_dump_prep)
  ,  ( "ddump-stg",          	 setDumpFlag Opt_D_dump_stg)
  ,  ( "ddump-stranal",      	 setDumpFlag Opt_D_dump_stranal)
  ,  ( "ddump-tc",           	 setDumpFlag Opt_D_dump_tc)
  ,  ( "ddump-types",        	 setDumpFlag Opt_D_dump_types)
  ,  ( "ddump-rules",        	 setDumpFlag Opt_D_dump_rules)
  ,  ( "ddump-cse",          	 setDumpFlag Opt_D_dump_cse)
  ,  ( "ddump-worker-wrapper",   setDumpFlag Opt_D_dump_worker_wrapper)
1068
1069
  ,  ( "ddump-rn-trace",         setDumpFlag Opt_D_dump_rn_trace)
  ,  ( "ddump-if-trace",         setDumpFlag Opt_D_dump_if_trace)
1070
1071
  ,  ( "ddump-tc-trace",         setDumpFlag Opt_D_dump_tc_trace)
  ,  ( "ddump-splices",          setDumpFlag Opt_D_dump_splices)
1072
  ,  ( "ddump-rn-stats",         setDumpFlag Opt_D_dump_rn_stats)
1073
1074
1075
1076
1077
1078
1079
  ,  ( "ddump-opt-cmm",          setDumpFlag Opt_D_dump_opt_cmm)
  ,  ( "ddump-simpl-stats",      setDumpFlag Opt_D_dump_simpl_stats)
  ,  ( "ddump-bcos",             setDumpFlag Opt_D_dump_BCOs)
  ,  ( "dsource-stats",          setDumpFlag Opt_D_source_stats)
  ,  ( "dverbose-core2core",     setDumpFlag Opt_D_verbose_core2core)
  ,  ( "dverbose-stg2stg",       setDumpFlag Opt_D_verbose_stg2stg)
  ,  ( "ddump-hi",               setDumpFlag Opt_D_dump_hi)
1080
  ,  ( "ddump-minimal-imports",  setDumpFlag Opt_D_dump_minimal_imports)
1081
  ,  ( "ddump-vect",         	 setDumpFlag Opt_D_dump_vect)
andy@galois.com's avatar
andy@galois.com committed
1082
  ,  ( "ddump-hpc",         	 setDumpFlag Opt_D_dump_hpc)
1083
  ,  ( "ddump-mod-cycles",     	 setDumpFlag Opt_D_dump_mod_cycles)
1084
  ,  ( "ddump-to-file",          setDumpFlag Opt_DumpToFile)
1085
  ,  ( "ddump-hi-diffs",         NoArg (setDynFlag Opt_D_dump_hi_diffs))
1086
1087
1088
  ,  ( "dcore-lint",       	 NoArg (setDynFlag Opt_DoCoreLinting))
  ,  ( "dstg-lint",        	 NoArg (setDynFlag Opt_DoStgLinting))
  ,  ( "dcmm-lint",		 NoArg (setDynFlag Opt_DoCmmLinting))
1089
  ,  ( "dshow-passes",           NoArg (do setDynFlag Opt_ForceRecomp
1090
				           setVerbosity (Just 2)) )
1091
  ,  ( "dfaststring-stats",	 NoArg (setDynFlag Opt_D_faststring_stats))
1092
1093
1094
1095
1096
1097
1098

	------ Machine dependant (-m<blah>) stuff ---------------------------

  ,  ( "monly-2-regs", 	NoArg (upd (\s -> s{stolen_x86_regs = 2}) ))
  ,  ( "monly-3-regs", 	NoArg (upd (\s -> s{stolen_x86_regs = 3}) ))
  ,  ( "monly-4-regs", 	NoArg (upd (\s -> s{stolen_x86_regs = 4}) ))

Ian Lynagh's avatar
Ian Lynagh committed
1099
1100
1101
1102
1103
1104
1105
     ------ Warning opts -------------------------------------------------
  ,  ( "W"     , NoArg (mapM_ setDynFlag   minusWOpts)    )
  ,  ( "Werror", NoArg (setDynFlag         Opt_WarnIsError) )
  ,  ( "Wwarn" , NoArg (unSetDynFlag       Opt_WarnIsError) )
  ,  ( "Wall"  , NoArg (mapM_ setDynFlag   minusWallOpts) )
  ,  ( "Wnot"  , NoArg (mapM_ unSetDynFlag minusWallOpts) ) -- DEPRECATED
  ,  ( "w"     , NoArg (mapM_ unSetDynFlag minuswRemovesOpts) )
1106
1107

	------ Optimisation flags ------------------------------------------
1108
  ,  ( "O"	, NoArg (upd (setOptLevel 1)))
1109
  ,  ( "Onot"	, NoArg (upd (setOptLevel 0))) -- deprecated
1110
1111
  ,  ( "O"	, OptIntSuffix (\mb_n -> upd (setOptLevel (mb_n `orElse` 1))))
		-- If the number is missing, use 1
1112

1113
1114
  ,  ( "fmax-simplifier-iterations", IntSuffix (\n -> 
		upd (\dfs -> dfs{ maxSimplIterations = n })) )
1115
1116
1117
1118
1119

	-- liberate-case-threshold is an old flag for '-fspec-threshold'
  ,  ( "fspec-threshold",          IntSuffix (\n -> upd (\dfs -> dfs{ specThreshold = n })))
  ,  ( "fliberate-case-threshold", IntSuffix (\n -> upd (\dfs -> dfs{ specThreshold = n })))

1120
1121
  ,  ( "frule-check", SepArg (\s -> upd (\dfs -> dfs{ ruleCheck = Just s })))
  ,  ( "fcontext-stack"	, IntSuffix $ \n -> upd $ \dfs -> dfs{ ctxtStkDepth = n })
1122
1123
1124

        ------ Compiler flags -----------------------------------------------

1125
1126
1127
  ,  ( "fasm",             NoArg (setObjTarget HscAsm) )
  ,  ( "fvia-c",           NoArg (setObjTarget HscC) )
  ,  ( "fvia-C",           NoArg (setObjTarget HscC) )
1128

1129
1130
1131
  ,  ( "fno-code",         NoArg (setTarget HscNothing))
  ,  ( "fbyte-code",       NoArg (setTarget HscInterpreted) )
  ,  ( "fobject-code",     NoArg (setTarget defaultHscTarget) )
1132
1133
1134
1135

  ,  ( "fglasgow-exts",    NoArg (mapM_ setDynFlag   glasgowExtsFlags) )
  ,  ( "fno-glasgow-exts", NoArg (mapM_ unSetDynFlag glasgowExtsFlags) )

1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
     -- the rest of the -f* and -fno-* flags
  ,  ( "f",                PrefixPred (isFlag   fFlags)
                           (\f -> setDynFlag   (getFlag   fFlags f)) )
  ,  ( "f",                PrefixPred (isPrefFlag "no-" fFlags)
                           (\f -> unSetDynFlag (getPrefFlag "no-" fFlags f)) )

     -- the -X* and -XNo* flags
  ,  ( "X",                PrefixPred (isFlag   xFlags)
                           (\f -> setDynFlag   (getFlag   xFlags f)) )
  ,  ( "X",                PrefixPred (isPrefFlag "No" xFlags)
                           (\f -> unSetDynFlag (getPrefFlag "No" xFlags f)) )
1147
1148
1149
1150
1151
 ]

-- these -f<blah> flags can all be reversed with -fno-<blah>

fFlags = [
1152
1153
1154
  ( "warn-dodgy-imports",               Opt_WarnDodgyImports ),
  ( "warn-duplicate-exports",           Opt_WarnDuplicateExports ),
  ( "warn-hi-shadowing",                Opt_WarnHiShadows ),
1155
  ( "warn-implicit-prelude",            Opt_WarnImplicitPrelude ),
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
  ( "warn-incomplete-patterns",         Opt_WarnIncompletePatterns ),
  ( "warn-incomplete-record-updates",   Opt_WarnIncompletePatternsRecUpd ),
  ( "warn-missing-fields",              Opt_WarnMissingFields ),
  ( "warn-missing-methods",             Opt_WarnMissingMethods ),
  ( "warn-missing-signatures",          Opt_WarnMissingSigs ),
  ( "warn-name-shadowing",              Opt_WarnNameShadowing ),
  ( "warn-overlapping-patterns",        Opt_WarnOverlappingPatterns ),
  ( "warn-simple-patterns",             Opt_WarnSimplePatterns ),
  ( "warn-type-defaults",               Opt_WarnTypeDefaults ),
  ( "warn-monomorphism-restriction",    Opt_WarnMonomorphism ),
  ( "warn-unused-binds",                Opt_WarnUnusedBinds ),
  ( "warn-unused-imports",              Opt_WarnUnusedImports ),
  ( "warn-unused-matches",              Opt_WarnUnusedMatches ),
  ( "warn-deprecations",                Opt_WarnDeprecations ),
  ( "warn-orphans",                     Opt_WarnOrphans ),
  ( "warn-tabs",                        Opt_WarnTabs ),
  ( "print-explicit-foralls",           Opt_PrintExplicitForalls ),
  ( "strictness",                       Opt_Strictness ),
  ( "full-laziness",                    Opt_FullLaziness ),
  ( "liberate-case",                    Opt_LiberateCase ),
  ( "spec-constr",                      Opt_SpecConstr ),
  ( "cse",                              Opt_CSE ),
  ( "ignore-interface-pragmas",         Opt_IgnoreInterfacePragmas ),
  ( "omit-interface-pragmas",           Opt_OmitInterfacePragmas ),
  ( "do-lambda-eta-expansion",          Opt_DoLambdaEtaExpansion ),
  ( "ignore-asserts",                   Opt_IgnoreAsserts ),
1182
  ( "ignore-breakpoints",               Opt_IgnoreBreakpoints),
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
  ( "do-eta-reduction",                 Opt_DoEtaReduction ),
  ( "case-merge",                       Opt_CaseMerge ),
  ( "unbox-strict-fields",              Opt_UnboxStrictFields ),
  ( "dicts-cheap",                      Opt_DictsCheap ),
  ( "excess-precision",                 Opt_ExcessPrecision ),
  ( "asm-mangling",                     Opt_DoAsmMangling ),
  ( "print-bind-result",                Opt_PrintBindResult ),
  ( "force-recomp",                     Opt_ForceRecomp ),
  ( "hpc-no-auto",                      Opt_Hpc_No_Auto ),
  ( "rewrite-rules",                    Opt_RewriteRules ),
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
1193
  ( "break-on-exception",               Opt_BreakOnException ),
1194
  ( "break-on-error",                   Opt_BreakOnError ),
1195
1196
  ( "run-cps",                          Opt_RunCPSZ ),
  ( "convert-to-zipper-and-back",       Opt_ConvertToZipCfgAndBack),
1197
  ( "vectorise",                        Opt_Vectorise ),
1198
  ( "regs-graph",                       Opt_RegsGraph),
1199
  ( "regs-iterative",                   Opt_RegsIterative),
1200
  -- Deprecated in favour of -XTemplateHaskell:
1201
  ( "th",                               Opt_TemplateHaskell ),
1202
  -- Deprecated in favour of -XForeignFunctionInterface:
1203
  ( "fi",                               Opt_ForeignFunctionInterface ),
1204
  -- Deprecated in favour of -XForeignFunctionInterface:
1205
  ( "ffi",                              Opt_ForeignFunctionInterface ),
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
  -- Deprecated in favour of -XArrows:
  ( "arrows",                           Opt_Arrows ),
  -- Deprecated in favour of -XGenerics:
  ( "generics",                         Opt_Generics ),
  -- Deprecated in favour of -XImplicitPrelude:
  ( "implicit-prelude",                 Opt_ImplicitPrelude ),
  -- Deprecated in favour of -XBangPatterns:
  ( "bang-patterns",                    Opt_BangPatterns ),
  -- Deprecated in favour of -XMonomorphismRestriction:
  ( "monomorphism-restriction",         Opt_MonomorphismRestriction ),
  -- Deprecated in favour of -XMonoPatBinds:
  ( "mono-pat-binds",                   Opt_MonoPatBinds ),
  -- Deprecated in favour of -XExtendedDefaultRules:
  ( "extended-default-rules",           Opt_ExtendedDefaultRules ),
  -- Deprecated in favour of -XImplicitParams:
  ( "implicit-params",                  Opt_ImplicitParams ),
  -- Deprecated in favour of -XScopedTypeVariables:
  ( "scoped-type-variables",            Opt_ScopedTypeVariables ),
1224
1225
  -- Deprecated in favour of -XPArr:
  ( "parr",                             Opt_PArr ),
1226
  -- Deprecated in favour of -XOverlappingInstances:
Ian Lynagh's avatar
Ian Lynagh committed
1227
  ( "allow-overlapping-instances",      Opt_OverlappingInstances ),
1228
  -- Deprecated in favour of -XUndecidableInstances:
Ian Lynagh's avatar
Ian Lynagh committed
1229
  ( "allow-undecidable-instances",      Opt_UndecidableInstances ),
1230
  -- Deprecated in favour of -XIncoherentInstances:
1231
1232
1233
  ( "allow-incoherent-instances",       Opt_IncoherentInstances ),
  ( "gen-manifest",                     Opt_GenManifest ),
  ( "embed-manifest",                   Opt_EmbedManifest )
1234
1235
  ]

Ian Lynagh's avatar
Ian Lynagh committed
1236
1237
supportedLanguages :: [String]
supportedLanguages = map fst xFlags
1238

1239
-- These -X<blah> flags can all be reversed with -XNo<blah>
1240
1241
xFlags :: [(String, DynFlag)]
xFlags = [
Ian Lynagh's avatar
Ian Lynagh committed
1242
  ( "CPP",                              Opt_Cpp ),
Ian Lynagh's avatar
Ian Lynagh committed
1243
  ( "PatternGuards",                    Opt_PatternGuards ),
Ian Lynagh's avatar
Ian Lynagh committed
1244
  ( "UnicodeSyntax",                    Opt_UnicodeSyntax ),
1245
  ( "MagicHash",                        Opt_MagicHash ),
Ian Lynagh's avatar
Ian Lynagh committed
1246
  ( "PolymorphicComponents",            Opt_PolymorphicComponents ),
1247
  ( "ExistentialQuantification",        Opt_ExistentialQuantification ),
Ian Lynagh's avatar
Ian Lynagh committed
1248
  ( "KindSignatures",                   Opt_KindSignatures ),
Ian Lynagh's avatar
Ian Lynagh committed
1249
  ( "PatternSignatures",                Opt_PatternSignatures ),
Ian Lynagh's avatar
Ian Lynagh committed
1250
  ( "EmptyDataDecls",                   Opt_EmptyDataDecls ),
Ian Lynagh's avatar
Ian Lynagh committed
1251
  ( "ParallelListComp",                 Opt_ParallelListComp ),
1252
  ( "ForeignFunctionInterface",         Opt_ForeignFunctionInterface ),
Ian Lynagh's avatar
Ian Lynagh committed
1253
  ( "UnliftedFFITypes",                 Opt_UnliftedFFITypes ),
1254
1255
  ( "PartiallyAppliedClosedTypeSynonyms",
    Opt_PartiallyAppliedClosedTypeSynonyms ),
1256
1257
  ( "Rank2Types",                       Opt_Rank2Types ),
  ( "RankNTypes",                       Opt_RankNTypes ),
Ian Lynagh's avatar
Ian Lynagh committed
1258
  ( "TypeOperators",                    Opt_TypeOperators ),
Ian Lynagh's avatar
Ian Lynagh committed
1259
  ( "RecursiveDo",                      Opt_RecursiveDo ),
1260
  ( "Arrows",                           Opt_Arrows ),
1261
  ( "PArr",                             Opt_PArr ),
1262
  ( "TemplateHaskell",                  Opt_TemplateHaskell ),
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
  ( "Generics",                         Opt_Generics ),
  -- On by default:
  ( "ImplicitPrelude",                  Opt_ImplicitPrelude ),
  ( "RecordWildCards",                  Opt_RecordWildCards ),
  ( "RecordPuns",                       Opt_RecordPuns ),
  ( "DisambiguateRecordFields",         Opt_DisambiguateRecordFields ),
  ( "OverloadedStrings",                Opt_OverloadedStrings ),
  ( "GADTs",                            Opt_GADTs ),
  ( "TypeFamilies",                     Opt_TypeFamilies ),
  ( "BangPatterns",                     Opt_BangPatterns ),
  -- On by default:
  ( "MonomorphismRestriction",          Opt_MonomorphismRestriction ),
  -- On by default (which is not strictly H98):
  ( "MonoPatBinds",                     Opt_MonoPatBinds ),
  ( "RelaxedPolyRec",                   Opt_RelaxedPolyRec),
  ( "ExtendedDefaultRules",             Opt_ExtendedDefaultRules ),
  ( "ImplicitParams",                   Opt_ImplicitParams ),
  ( "ScopedTypeVariables",              Opt_ScopedTypeVariables ),
  ( "UnboxedTuples",                    Opt_UnboxedTuples ),
  ( "StandaloneDeriving",               Opt_StandaloneDeriving ),
  ( "DeriveDataTypeable",               Opt_DeriveDataTypeable ),
  ( "TypeSynonymInstances",             Opt_TypeSynonymInstances</