DynFlags.hs 58 KB
Newer Older
1

2
{-# OPTIONS -fno-warn-missing-fields #-}
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
-----------------------------------------------------------------------------
--
-- 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
--
-----------------------------------------------------------------------------

module DynFlags (
	-- Dynamic flags
	DynFlag(..),
	DynFlags(..),
20
	HscTarget(..), isObjectTarget, defaultObjectTarget,
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
	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,
42
	setTmpDir,
43
	setPackageName,
44
45
46
	
	-- parsing DynFlags
	parseDynamicFlags,
47
        allFlags,
48
49

	-- misc stuff
Ian Lynagh's avatar
Ian Lynagh committed
50
51
	machdepCCOpts, picCCOpts,
    supportedLanguages,
52
    compilerInfo,
53
54
55
56
  ) where

#include "HsVersions.h"

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

Simon Marlow's avatar
Simon Marlow committed
78
79
80
import Data.IORef	( readIORef )
import Control.Exception ( throwDyn )
import Control.Monad	( when )
81
#ifdef mingw32_TARGET_OS
82
import Data.List	( isPrefixOf )
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
83
84
#else
import Util		( split )
85
#endif
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
86

87
import Data.Char	( isUpper, toLower )
88
89
import System.IO        ( hPutStrLn, stderr )

90
91
92
93
94
95
96
-- -----------------------------------------------------------------------------
-- DynFlags

data DynFlag

   -- debugging flags
   = Opt_D_dump_cmm
97
   | Opt_D_dump_cps_cmm
98
   | Opt_D_dump_asm
99
100
101
102
103
104
   | Opt_D_dump_asm_native
   | Opt_D_dump_asm_liveness
   | Opt_D_dump_asm_coalesce
   | Opt_D_dump_asm_regalloc
   | Opt_D_dump_asm_regalloc_stages
   | Opt_D_dump_asm_conflicts
105
106
107
108
109
110
   | Opt_D_dump_cpranal
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_flatC
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
111
   | Opt_D_dump_rule_firings
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
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
   | 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
135
   | Opt_D_dump_hpc
136
137
138
139
140
141
   | 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
142
   | Opt_D_dump_mod_cycles
143
   | Opt_D_faststring_stats
144
145
146
147
148
149
150
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting

   | Opt_WarnIsError		-- -Werror; makes warnings fatal
   | Opt_WarnDuplicateExports
   | Opt_WarnHiShadows
151
   | Opt_WarnImplicitPrelude
152
153
154
155
156
157
158
159
160
   | Opt_WarnIncompletePatterns
   | Opt_WarnIncompletePatternsRecUpd
   | Opt_WarnMissingFields
   | Opt_WarnMissingMethods
   | Opt_WarnMissingSigs
   | Opt_WarnNameShadowing
   | Opt_WarnOverlappingPatterns
   | Opt_WarnSimplePatterns
   | Opt_WarnTypeDefaults
161
   | Opt_WarnMonomorphism
162
163
164
165
166
167
   | Opt_WarnUnusedBinds
   | Opt_WarnUnusedImports
   | Opt_WarnUnusedMatches
   | Opt_WarnDeprecations
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
168
   | Opt_WarnTabs
169
170

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

219
220
   | Opt_PrintExplicitForalls

221
222
223
224
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
   | Opt_CSE
225
226
   | Opt_LiberateCase
   | Opt_SpecConstr
227
228
229
230
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
231
   | Opt_IgnoreBreakpoints
232
233
234
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
235
   | Opt_DictsCheap
236
   | Opt_RewriteRules
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
237
   | Opt_Vectorise
238
   | Opt_RegsGraph
239
240
241
242

   -- misc opts
   | Opt_Cpp
   | Opt_Pp
243
   | Opt_ForceRecomp
244
245
246
247
248
249
250
   | Opt_DryRun
   | Opt_DoAsmMangling
   | Opt_ExcessPrecision
   | Opt_ReadUserPackageConf
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
251
   | Opt_HideAllPackages
252
   | Opt_PrintBindResult
253
   | Opt_Haddock
254
   | Opt_Hpc_No_Auto
255
   | Opt_BreakOnException
256
257
258
259
260
261
262
263
264

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

   deriving (Eq)
265
 
266
267
268
269
270
271
272
273
274
275
276
277
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,
278
279

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

281
282
283
  stolen_x86_regs	:: Int,		
  cmdlineHcIncludes	:: [String],	-- -#includes
  importPaths		:: [FilePath],
284
  mainModIs		:: Module,
285
  mainFunIs		:: Maybe String,
286
287
  ctxtStkDepth	        :: Int,		-- Typechecker context stack depth

Simon Marlow's avatar
Simon Marlow committed
288
  thisPackage		:: PackageId,
289
290
291
292
293
294
295

  -- 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.
296
297
298
299
  objectDir		:: Maybe String,
  hiDir			:: Maybe String,
  stubDir		:: Maybe String,

300
301
302
  objectSuf		:: String,
  hcSuf			:: String,
  hiSuf			:: String,
303
304
305
306

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

307
308
309
310
  includePaths		:: [String],
  libraryPaths		:: [String],
  frameworkPaths	:: [String],  	-- used on darwin only
  cmdlineFrameworks	:: [String],	-- ditto
311
  tmpDir		:: String,	-- no trailing '/'
312
  
313
314
315
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto

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

318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
  -- 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],

  -- 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]),
338
339
  pgm_T                 :: String,
  pgm_sysman            :: String,
340

341
  --  Package flags
342
  extraPkgConfs		:: [FilePath],
343
344
  topDir                :: FilePath,    -- filled in by SysTools
  systemPackageConfig   :: FilePath,    -- ditto
345
346
347
348
349
350
	-- 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

351
352
353
354
  -- Package state
  -- NB. do not modify this field, it is calculated by 
  -- Packages.initPackages and Packages.updatePackages.
  pkgDatabase           :: Maybe (UniqFM InstalledPackageInfo),
355
356
357
  pkgState		:: PackageState,

  -- hsc dynamic flags
358
359
360
361
  flags      		:: [DynFlag],
  
  -- message output
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO ()
362
363
364
365
366
367
368
369
370
371
 }

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

372
373
374
375
376
377
378
379
380
381
382
383
-- | 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.
384
data GhcMode
385
386
387
  = CompManager         -- ^ --make, GHCi, etc.
  | OneShot		-- ^ ghc -c Foo.hs
  | MkDepend            -- ^ ghc -M, see Finder for why we need this
388
389
390
391
392
393
  deriving Eq

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

394
-- | What kind of linking to do.
395
data GhcLink	-- What to do in the link step, if there is one
396
397
398
  = NoLink		-- Don't link at all
  | LinkBinary		-- Link object code into a binary
  | LinkInMemory        -- Use the in-memory dynamic linker
399
  | LinkDynLib		-- Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
400
  deriving Eq
401
402
403
404
405
406
407
408
409

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

data PackageFlag
  = ExposePackage  String
  | HidePackage    String
  | IgnorePackage  String
410
  deriving Eq
411

412
413
414
415
416
defaultHscTarget = defaultObjectTarget

-- | the 'HscTarget' value corresponding to the default way to create
-- object files on the current platform.
defaultObjectTarget
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
  | 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 {
433
434
	ghcMode			= CompManager,
	ghcLink			= LinkBinary,
435
436
437
438
439
440
441
442
443
	coreToDo 		= Nothing,
	stgToDo			= Nothing, 
	hscTarget		= defaultHscTarget, 
	hscOutName		= "", 
	extCoreName		= "",
	verbosity		= 0, 
	optLevel		= 0,
	maxSimplIterations	= 4,
	ruleCheck		= Nothing,
444
	specThreshold		= 200,
445
446
447
	stolen_x86_regs		= 4,
	cmdlineHcIncludes	= [],
	importPaths		= ["."],
448
	mainModIs		= mAIN,
449
	mainFunIs		= Nothing,
450
451
	ctxtStkDepth		= mAX_CONTEXT_REDUCTION_DEPTH,

Simon Marlow's avatar
Simon Marlow committed
452
	thisPackage		= mainPackageId,
453

454
455
456
457
	objectDir		= Nothing,
	hiDir			= Nothing,
	stubDir			= Nothing,

458
459
460
	objectSuf		= phaseInputExt StopLn,
	hcSuf			= phaseInputExt HCc,
	hiSuf			= "hi",
461
462
463

	outputFile		= Nothing,
	outputHi		= Nothing,
464
465
466
467
	includePaths		= [],
	libraryPaths		= [],
	frameworkPaths		= [],
	cmdlineFrameworks	= [],
468
	tmpDir			= cDEFAULT_TMPDIR,
469
	
andy@galois.com's avatar
andy@galois.com committed
470
471
        hpcDir		        = ".hpc",

472
	opt_L			= [],
473
474
475
	opt_P			= (if opt_PIC
				   then ["-D__PIC__"]
				   else []),
476
477
478
479
480
481
482
483
484
	opt_F			= [],
	opt_c			= [],
	opt_a			= [],
	opt_m			= [],
	opt_l			= [],
	opt_dep			= [],
	
	extraPkgConfs		= [],
	packageFlags		= [],
485
486
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
487
488
489
	flags = [ 
    	    Opt_ReadUserPackageConf,
    
490
491
492
493
	    Opt_MonoPatBinds, 	-- Experimentally, I'm making this non-standard
				-- behaviour the default, to see if anyone notices
				-- SLPJ July 06

494
495
    	    Opt_ImplicitPrelude,
    	    Opt_MonomorphismRestriction,
496

497
498
    	    Opt_DoAsmMangling,
    
499
	    -- on by default:
500
501
502
503
	    Opt_PrintBindResult ]
	    ++ [f | (ns,f) <- optLevelFlags, 0 `elem` ns]
	    	    -- The default -O0 options
	    ++ standardWarnings,
504
505
506
507
508
509
               
        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))
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
      }

{- 
    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 =  ""

541
542
543
544
setObjectDir  f d = d{ objectDir  = f}
setHiDir      f d = d{ hiDir      = f}
setStubDir    f d = d{ stubDir    = f}

545
546
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
547
548
549
550
setHcSuf      f d = d{ hcSuf      = f}

setOutputFile f d = d{ outputFile = f}
setOutputHi   f d = d{ outputHi   = f}
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
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,[])}

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}

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
599
  = dfs2{ optLevel = final_n }
600
  where
601
   final_n = max 0 (min 2 n)	-- Clamp to 0 <= n <= 2
602
603
604
   dfs1 = foldr (flip dopt_unset) dfs  remove_dopts
   dfs2 = foldr (flip dopt_set)   dfs1 extra_dopts

605
606
   extra_dopts  = [ f | (ns,f) <- optLevelFlags, final_n `elem` ns ]
   remove_dopts = [ f | (ns,f) <- optLevelFlags, final_n `notElem` ns ]
607
	
608
609
610
611
optLevelFlags :: [([Int], DynFlag)]
optLevelFlags
  = [ ([0],	Opt_IgnoreInterfacePragmas)
    , ([0],     Opt_OmitInterfacePragmas)
612

613
    , ([1,2],	Opt_IgnoreAsserts)
614
615
    , ([1,2],	Opt_RewriteRules)	-- Off for -O0; see Note [Scoping for Builtin rules]
					-- 		in PrelRules
616
617
618
619
620
    , ([1,2],	Opt_DoEtaReduction)
    , ([1,2],	Opt_CaseMerge)
    , ([1,2],	Opt_Strictness)
    , ([1,2],	Opt_CSE)
    , ([1,2],	Opt_FullLaziness)
621

622
623
624
625
626
627
628
629
    , ([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.
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
    ]

-- -----------------------------------------------------------------------------
-- 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
      ]

661
662
663
664
665
666
667
668
669
670
-- minuswRemovesOpts should be every warning option
minuswRemovesOpts
    = minusWallOpts ++
      [Opt_WarnImplicitPrelude,
       Opt_WarnIncompletePatternsRecUpd,
       Opt_WarnSimplePatterns,
       Opt_WarnMonomorphism,
       Opt_WarnTabs
      ]

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
-- -----------------------------------------------------------------------------
-- 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
697
  | CoreDoVectorisation
698
699
  | CoreDoNothing 		 -- Useful when building up 
  | CoreDoPasses [CoreToDo] 	 -- lists of these things
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715

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:
716
717
718
runWhen :: Bool -> CoreToDo -> CoreToDo
runWhen True  do_this = do_this
runWhen False do_this = CoreDoNothing
719
720
721
722
723
724
725
726
727
728
729

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
730
731
    spec_constr   = dopt Opt_SpecConstr dflags
    liberate_case = dopt Opt_LiberateCase dflags
732
    rule_check    = ruleCheck dflags
733
    vectorisation = dopt Opt_Vectorise dflags
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755

    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
756
757
            NoCaseOfCase,	-- Don't do case-of-case transformations.
				-- This makes full laziness work better
758
759
760
	    MaxSimplifierIterations max_iter
	],

761
762
763
764
765
766
767
768
769

        -- 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]]),

770
771
772
773
	-- Specialisation is best done before full laziness
	-- so that overloaded functions have all their dictionary lambdas manifest
	CoreDoSpecialising,

774
	runWhen full_laziness (CoreDoFloatOutwards (FloatOutSw False False)),
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812

	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
813
	CoreDoOldStrictness,
814
#endif
815
816
817
818
819
820
821
822
823
824
825
	runWhen strictness (CoreDoPasses [
		CoreDoStrictness,
		CoreDoWorkerWrapper,
		CoreDoGlomBinds,
		CoreDoSimplify (SimplPhase 0) [
		   MaxSimplifierIterations max_iter
		]]),

	runWhen full_laziness 
	  (CoreDoFloatOutwards (FloatOutSw False    -- Not lambdas
					   True)),  -- Float constants
826
827
828
829
830
831
832
		-- 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)


833
834
835
836
	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
837
838
839

	CoreDoFloatInwards,

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

842
843
844
845
846
		-- Case-liberation for -O2.  This should be after
		-- strictness analysis and the simplification which follows it.
	runWhen liberate_case (CoreDoPasses [
	    CoreLiberateCase,
	    CoreDoSimplify (SimplPhase 0) [
847
		  MaxSimplifierIterations max_iter
848
	    ] ]),	-- Run the simplifier after LiberateCase to vastly 
849
850
851
			-- reduce the possiblility of shadowing
			-- Reason: see Note [Shadowing] in SpecConstr.lhs

852
	runWhen spec_constr CoreDoSpecConstr,
853
854

	-- Final clean-up simplification:
855
     	CoreDoSimplify (SimplPhase 0) [
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
	  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

886
887
888
889
890
891
892
893
894
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

895
896
897
898
899
900
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) )
901
  ,  ( "v"		, OptIntSuffix setVerbosity )
902

903
904
905
906
907
908
909
910
911
912
913
914
915
916
        ------- 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) )

  ,  ( "optL"		, HasArg (upd . addOptL) )  
  ,  ( "optP"		, HasArg (upd . addOptP) )  
  ,  ( "optF"           , HasArg (upd . addOptF) )  
917
  ,  ( "optc"		, HasArg (upd . addOptc) )  
918
919
920
921
922
  ,  ( "optm"		, HasArg (upd . addOptm) )  
  ,  ( "opta"		, HasArg (upd . addOpta) )  
  ,  ( "optl"		, HasArg (upd . addOptl) )  
  ,  ( "optdep"		, HasArg (upd . addOptdep) )

923
924
925
926
  ,  ( "split-objs"	, NoArg (if can_split
				    then setDynFlag Opt_SplitObjs
				    else return ()) )

927
928
929
	-------- Linking ----------------------------------------------------
  ,  ( "c"		, NoArg (upd $ \d -> d{ ghcLink=NoLink } ))
  ,  ( "no-link"	, NoArg (upd $ \d -> d{ ghcLink=NoLink } )) -- Dep.
930
  ,  ( "shared"		, NoArg (upd $ \d -> d{ ghcLink=LinkDynLib } ))
931
932
933

	------- Libraries ---------------------------------------------------
  ,  ( "L"		, Prefix addLibraryPath )
934
  ,  ( "l"		, AnySuffix (\s -> do upd (addOptl s)))
935
936
937
938
939
940
941

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

	------- Output Redirection ------------------------------------------
942
  ,  ( "odir"		, HasArg (upd . setObjectDir  . Just))
943
944
945
946
947
948
949
  ,  ( "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))
950
  ,  ( "stubdir"	, HasArg (upd . setStubDir . Just))
951
952

	------- Keeping temporary files -------------------------------------
Ian Lynagh's avatar
Ian Lynagh committed
953
954
955
956
957
958
959
960
961
     -- 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))
962
963
964
965

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

969
970
971
	------- recompilation checker (DEPRECATED, use -fforce-recomp) -----
  ,  ( "recomp"		, NoArg (unSetDynFlag Opt_ForceRecomp) )
  ,  ( "no-recomp"  	, NoArg (setDynFlag   Opt_ForceRecomp) )
972
973
974
975

        ------- Packages ----------------------------------------------------
  ,  ( "package-conf"   , HasArg extraPkgConf_ )
  ,  ( "no-user-package-conf", NoArg (unSetDynFlag Opt_ReadUserPackageConf) )
976
  ,  ( "package-name"   , HasArg (upd . setPackageName) )
977
978
  ,  ( "package"        , HasArg exposePackage )
  ,  ( "hide-package"   , HasArg hidePackage )
979
  ,  ( "hide-all-packages", NoArg (setDynFlag Opt_HideAllPackages) )
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
  ,  ( "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)
995
  ,  ( "ddump-cps-cmm",        	 setDumpFlag Opt_D_dump_cps_cmm)
996
  ,  ( "ddump-asm",          	 setDumpFlag Opt_D_dump_asm)
997
998
999
1000
1001
1002
1003
  ,  ( "ddump-asm-native",       setDumpFlag Opt_D_dump_asm_native)
  ,  ( "ddump-asm-liveness",     setDumpFlag Opt_D_dump_asm_liveness)
  ,  ( "ddump-asm-coalesce",     setDumpFlag Opt_D_dump_asm_coalesce)
  ,  ( "ddump-asm-regalloc",     setDumpFlag Opt_D_dump_asm_regalloc)
  ,  ( "ddump-asm-conflicts",    setDumpFlag Opt_D_dump_asm_conflicts)
  ,  ( "ddump-asm-regalloc-stages",
                                 setDumpFlag Opt_D_dump_asm_regalloc_stages)
1004
1005
1006
1007
1008
1009
  ,  ( "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)
1010
  ,  ( "ddump-rule-firings",   	 setDumpFlag Opt_D_dump_rule_firings)
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
  ,  ( "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)
1025
1026
  ,  ( "ddump-rn-trace",         setDumpFlag Opt_D_dump_rn_trace)
  ,  ( "ddump-if-trace",         setDumpFlag Opt_D_dump_if_trace)
1027
1028
  ,  ( "ddump-tc-trace",         setDumpFlag Opt_D_dump_tc_trace)
  ,  ( "ddump-splices",          setDumpFlag Opt_D_dump_splices)
1029
  ,  ( "ddump-rn-stats",         setDumpFlag Opt_D_dump_rn_stats)
1030
1031
1032
1033
1034
1035
1036
  ,  ( "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)
1037
  ,  ( "ddump-minimal-imports",  setDumpFlag Opt_D_dump_minimal_imports)
1038
  ,  ( "ddump-vect",         	 setDumpFlag Opt_D_dump_vect)
andy@galois.com's avatar
andy@galois.com committed
1039
  ,  ( "ddump-hpc",         	 setDumpFlag Opt_D_dump_hpc)
1040
  ,  ( "ddump-mod-cycles",     	 setDumpFlag Opt_D_dump_mod_cycles)
andy@galois.com's avatar
andy@galois.com committed
1041
  
1042
  ,  ( "ddump-hi-diffs",         NoArg (setDynFlag Opt_D_dump_hi_diffs))
1043
1044
1045
  ,  ( "dcore-lint",       	 NoArg (setDynFlag Opt_DoCoreLinting))
  ,  ( "dstg-lint",        	 NoArg (setDynFlag Opt_DoStgLinting))
  ,  ( "dcmm-lint",		 NoArg (setDynFlag Opt_DoCmmLinting))
1046
  ,  ( "dshow-passes",           NoArg (do setDynFlag Opt_ForceRecomp
1047
				           setVerbosity (Just 2)) )
1048
  ,  ( "dfaststring-stats",	 NoArg (setDynFlag Opt_D_faststring_stats))
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060

	------ 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}) ))

	------ Warning opts -------------------------------------------------
  ,  ( "W"		, NoArg (mapM_ setDynFlag   minusWOpts)    )
  ,  ( "Werror"		, NoArg (setDynFlag   	    Opt_WarnIsError) )
  ,  ( "Wall"		, NoArg (mapM_ setDynFlag   minusWallOpts) )
  ,  ( "Wnot"		, NoArg (mapM_ unSetDynFlag minusWallOpts) ) /* DEPREC */
1061
  ,  ( "w"		, NoArg (mapM_ unSetDynFlag minuswRemovesOpts) )
1062
1063

	------ Optimisation flags ------------------------------------------
1064
  ,  ( "O"	, NoArg (upd (setOptLevel 1)))
1065
  ,  ( "Onot"	, NoArg (upd (setOptLevel 0))) -- deprecated
1066
1067
  ,  ( "O"	, OptIntSuffix (\mb_n -> upd (setOptLevel (mb_n `orElse` 1))))
		-- If the number is missing, use 1
1068

1069
1070
  ,  ( "fmax-simplifier-iterations", IntSuffix (\n -> 
		upd (\dfs -> dfs{ maxSimplIterations = n })) )
1071
1072
1073
1074
1075

	-- 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 })))

1076
1077
  ,  ( "frule-check", SepArg (\s -> upd (\dfs -> dfs{ ruleCheck = Just s })))
  ,  ( "fcontext-stack"	, IntSuffix $ \n -> upd $ \dfs -> dfs{ ctxtStkDepth = n })
1078
1079
1080

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

1081
1082
1083
  ,  ( "fasm",             NoArg (setObjTarget HscAsm) )
  ,  ( "fvia-c",           NoArg (setObjTarget HscC) )
  ,  ( "fvia-C",           NoArg (setObjTarget HscC) )
1084

1085
1086
1087
  ,  ( "fno-code",         NoArg (setTarget HscNothing))
  ,  ( "fbyte-code",       NoArg (setTarget HscInterpreted) )
  ,  ( "fobject-code",     NoArg (setTarget defaultHscTarget) )
1088
1089
1090
1091

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

1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
     -- 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)) )
1103
1104
1105
1106
1107
 ]

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

fFlags = [
1108
1109
1110
  ( "warn-dodgy-imports",               Opt_WarnDodgyImports ),
  ( "warn-duplicate-exports",           Opt_WarnDuplicateExports ),
  ( "warn-hi-shadowing",                Opt_WarnHiShadows ),
1111
  ( "warn-implicit-prelude",            Opt_WarnImplicitPrelude ),
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
  ( "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 ),
1138
  ( "ignore-breakpoints",               Opt_IgnoreBreakpoints),
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
  ( "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
1149
  ( "break-on-exception",               Opt_BreakOnException ),
1150
  ( "vectorise",                        Opt_Vectorise ),
1151
  ( "regs-graph",                       Opt_RegsGraph),
1152
  -- Deprecated in favour of -XTemplateHaskell:
1153
  ( "th",                               Opt_TemplateHaskell ),
1154
  -- Deprecated in favour of -XForeignFunctionInterface:
1155
  ( "fi",                               Opt_ForeignFunctionInterface ),
1156
  -- Deprecated in favour of -XForeignFunctionInterface:
1157
  ( "ffi",                              Opt_ForeignFunctionInterface ),
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
  -- 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 ),
1176
1177
  -- Deprecated in favour of -XPArr:
  ( "parr",                             Opt_PArr ),
1178
  -- Deprecated in favour of -XOverlappingInstances:
Ian Lynagh's avatar
Ian Lynagh committed
1179
  ( "allow-overlapping-instances",      Opt_OverlappingInstances ),
1180
  -- Deprecated in favour of -XUndecidableInstances:
Ian Lynagh's avatar
Ian Lynagh committed
1181
  ( "allow-undecidable-instances",      Opt_UndecidableInstances ),
1182
  -- Deprecated in favour of -XIncoherentInstances:
Ian Lynagh's avatar
Ian Lynagh committed
1183
  ( "allow-incoherent-instances",       Opt_IncoherentInstances )
1184
1185
  ]

Ian Lynagh's avatar
Ian Lynagh committed
1186
1187
supportedLanguages :: [String]
supportedLanguages = map fst xFlags
1188

1189
-- These -X<blah> flags can all be reversed with -XNo<blah>
1190
1191
xFlags :: [(String, DynFlag)]
xFlags = [
Ian Lynagh's avatar
Ian Lynagh committed
1192
  ( "CPP",                              Opt_Cpp ),
Ian Lynagh's avatar
Ian Lynagh committed
1193
  ( "PatternGuards",                    Opt_PatternGuards ),
Ian Lynagh's avatar
Ian Lynagh committed
1194
  ( "UnicodeSyntax",                    Opt_UnicodeSyntax ),
1195
  ( "MagicHash",                        Opt_MagicHash ),
Ian Lynagh's avatar
Ian Lynagh committed
1196
  ( "PolymorphicComponents",            Opt_PolymorphicComponents ),
1197
  ( "ExistentialQuantification",        Opt_ExistentialQuantification ),
Ian Lynagh's avatar
Ian Lynagh committed
1198
  ( "KindSignatures",                   Opt_KindSignatures ),
Ian Lynagh's avatar
Ian Lynagh committed
1199
  ( "PatternSignatures",                Opt_PatternSignatures ),
Ian Lynagh's avatar
Ian Lynagh committed
1200
  ( "EmptyDataDecls",                   Opt_EmptyDataDecls ),
Ian Lynagh's avatar
Ian Lynagh committed
1201
  ( "ParallelListComp",                 Opt_ParallelListComp ),
1202
  ( "ForeignFunctionInterface",         Opt_ForeignFunctionInterface ),
Ian Lynagh's avatar
Ian Lynagh committed
1203
  ( "UnliftedFFITypes",                 Opt_UnliftedFFITypes ),
1204
1205
  ( "PartiallyAppliedClosedTypeSynonyms",
    Opt_PartiallyAppliedClosedTypeSynonyms ),
1206
1207
  ( "Rank2Types",                       Opt_Rank2Types ),
  ( "RankNTypes",                       Opt_RankNTypes ),
Ian Lynagh's avatar
Ian Lynagh committed
1208
  ( "TypeOperators",                    Opt_TypeOperators ),
Ian Lynagh's avatar
Ian Lynagh committed
1209
  ( "RecursiveDo",                      Opt_RecursiveDo ),
1210
  ( "Arrows",                           Opt_Arrows ),
1211
  ( "PArr",                             Opt_PArr ),
1212
  ( "TemplateHaskell",                  Opt_TemplateHaskell ),
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
  ( "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 ),
  ( "FlexibleContexts",                 Opt_FlexibleContexts ),
  ( "FlexibleInstances",                Opt_FlexibleInstances ),
  ( "ConstrainedClassMethods",          Opt_ConstrainedClassMethods ),
  ( "MultiParamTypeClasses",            Opt_MultiParamTypeClasses ),
  ( "FunctionalDependencies",           Opt_FunctionalDependencies ),
  ( "GeneralizedNewtypeDeriving",       Opt_GeneralizedNewtypeDeriving ),
1241
1242
1243
  ( "OverlappingInstances",             Opt_OverlappingInstances ),
  ( "UndecidableInstances",             Opt_UndecidableInstances ),
  ( "IncoherentInstances",              Opt_IncoherentInstances )
1244
1245
1246
1247
1248
1249
1250
  ]

impliedFlags :: [(DynFlag, [DynFlag])]
impliedFlags = [
  ( Opt_GADTs, [Opt_RelaxedPolyRec] )	-- We want type-sig variables to be completely rigid for GADTs
  ]

1251
1252
glasgowExtsFlags = [
             Opt_PrintExplicitForalls
1253
           , Opt_ForeignFunctionInterface
Ian Lynagh's avatar
Ian Lynagh committed
1254
           , Opt_UnliftedFFITypes
1255
		   , Opt_GADTs
1256
1257
		   , Opt_ImplicitParams 
		   , Opt_ScopedTypeVariables
Ian Lynagh's avatar
Ian Lynagh committed
1258
           , Opt_UnboxedTuples
1259
           , Opt_TypeSynonymInstances
1260
           , Opt_StandaloneDeriving
1261
           , Opt_DeriveDataTypeable
Ian Lynagh's avatar
Ian Lynagh committed
1262
           , Opt_FlexibleContexts
1263
           , Opt_FlexibleInstances
1264
           , Opt_ConstrainedClassMethods
Ian Lynagh's avatar
Ian Lynagh committed
1265
           , Opt_MultiParamTypeClasses
1266
           , Opt_FunctionalDependencies
1267
		   , Opt_MagicHash
Ian Lynagh's avatar
Ian Lynagh committed
1268
           , Opt_PolymorphicComponents
1269
           , Opt_ExistentialQuantification
Ian Lynagh's avatar
Ian Lynagh committed
1270
           , Opt_UnicodeSyntax
Ian Lynagh's avatar
Ian Lynagh committed
1271
           , Opt_PatternGuards
1272
           , Opt_PartiallyAppliedClosedTypeSynonyms
1273
           , Opt_RankNTypes
Ian Lynagh's avatar
Ian Lynagh committed
1274
           , Opt_TypeOperators
Ian Lynagh's avatar
Ian Lynagh committed
1275
           , Opt_RecursiveDo
Ian Lynagh's avatar
Ian Lynagh committed
1276
           , Opt_ParallelListComp
Ian Lynagh's avatar
Ian Lynagh committed
1277
           , Opt_EmptyDataDecls
Ian Lynagh's avatar
Ian Lynagh committed
1278
           , Opt_KindSignatures
Ian Lynagh's avatar
Ian Lynagh committed
1279
           , Opt_PatternSignatures
1280
           , Opt_GeneralizedNewtypeDeriving
1281
1282
1283
		   , Opt_TypeFamilies ]

------------------
1284
1285
isFlag :: [(String,a)] -> String -> Bool
isFlag flags f = any (\(ff,_) -> ff == f) flags
1286

1287
1288
1289
1290
isPrefFlag :: String -> [(String,a)] -> String -> Bool
isPrefFlag pref flags no_f
  | Just f <- maybePrefixMatch pref no_f = isFlag flags f
  | otherwise                            = False
1291
1292

------------------
1293
1294
1295
1296
1297
1298
1299
1300
getFlag :: [(String,a)] -> String -> a
getFlag flags f = case [ opt | (ff, opt) <- flags, ff == f] of
                      (o:os) -> o
                      []     -> panic ("get_flag " ++ f)

getPrefFlag :: String -> [(String,a)] -> String -> a
getPrefFlag pref flags f = getFlag flags (fromJust (maybePrefixMatch pref f))
-- We should only be passed flags which match the prefix