DynFlags.hs 54.3 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
50
	machdepCCOpts, picCCOpts
51
52
53
54
  ) where

#include "HsVersions.h"

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

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

85
import Data.Char	( isUpper, toLower )
86
87
import System.IO        ( hPutStrLn, stderr )

88
89
90
91
92
93
94
-- -----------------------------------------------------------------------------
-- DynFlags

data DynFlag

   -- debugging flags
   = Opt_D_dump_cmm
95
   | Opt_D_dump_cps_cmm
96
97
98
99
100
101
102
   | Opt_D_dump_asm
   | Opt_D_dump_cpranal
   | Opt_D_dump_deriv
   | Opt_D_dump_ds
   | Opt_D_dump_flatC
   | Opt_D_dump_foreign
   | Opt_D_dump_inlinings
103
   | Opt_D_dump_rule_firings
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
   | 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
127
   | Opt_D_dump_hpc
128
129
130
131
132
133
   | 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
134
   | Opt_D_dump_mod_cycles
135
   | Opt_D_faststring_stats
136
137
138
139
140
141
142
   | Opt_DoCoreLinting
   | Opt_DoStgLinting
   | Opt_DoCmmLinting

   | Opt_WarnIsError		-- -Werror; makes warnings fatal
   | Opt_WarnDuplicateExports
   | Opt_WarnHiShadows
143
   | Opt_WarnImplicitPrelude
144
145
146
147
148
149
150
151
152
   | Opt_WarnIncompletePatterns
   | Opt_WarnIncompletePatternsRecUpd
   | Opt_WarnMissingFields
   | Opt_WarnMissingMethods
   | Opt_WarnMissingSigs
   | Opt_WarnNameShadowing
   | Opt_WarnOverlappingPatterns
   | Opt_WarnSimplePatterns
   | Opt_WarnTypeDefaults
153
   | Opt_WarnMonomorphism
154
155
156
157
158
159
   | Opt_WarnUnusedBinds
   | Opt_WarnUnusedImports
   | Opt_WarnUnusedMatches
   | Opt_WarnDeprecations
   | Opt_WarnDodgyImports
   | Opt_WarnOrphans
160
   | Opt_WarnTabs
161
162
163
164
165
166

   -- language opts
   | Opt_AllowOverlappingInstances
   | Opt_AllowUndecidableInstances
   | Opt_AllowIncoherentInstances
   | Opt_MonomorphismRestriction
167
   | Opt_MonoPatBinds
168
   | Opt_ExtendedDefaultRules		-- Use GHC's extended rules for defaulting
169
170
   | Opt_GlasgowExts
   | Opt_FFI
Ian Lynagh's avatar
Ian Lynagh committed
171
   | Opt_UnliftedFFITypes
172
173
   | Opt_PArr				-- Syntactic support for parallel arrays
   | Opt_Arrows				-- Arrow-notation syntax
174
175
176
177
178
   | Opt_TH
   | Opt_ImplicitParams
   | Opt_Generics
   | Opt_ImplicitPrelude 
   | Opt_ScopedTypeVariables
Ian Lynagh's avatar
Ian Lynagh committed
179
180
181
   | Opt_UnboxedTuples
   | Opt_ExpressionSignaturesUnboxedTuples
   | Opt_TypeSynonymUnboxedTuples
simonpj@microsoft.com's avatar
simonpj@microsoft.com committed
182
   | Opt_BangPatterns
183
   | Opt_TypeFamilies
184
   | Opt_OverloadedStrings
185
   | Opt_DisambiguateRecordFields
186
   | Opt_RecordWildCards
187
   | Opt_RecordPuns
188
189
   | Opt_GADTs
   | Opt_RelaxedPolyRec			-- -X=RelaxedPolyRec
190
   | Opt_TypeSynonymInstances
Ian Lynagh's avatar
Ian Lynagh committed
191
   | Opt_FlexibleContexts
192
   | Opt_FlexibleInstances
Ian Lynagh's avatar
Ian Lynagh committed
193
   | Opt_MultiParamTypeClasses
194
   | Opt_FunctionalDependencies
Ian Lynagh's avatar
Ian Lynagh committed
195
   | Opt_UnicodeSyntax
Ian Lynagh's avatar
Ian Lynagh committed
196
   | Opt_PolymorphicComponents
197
   | Opt_ExistentialQuantification
198
   | Opt_MagicHash
Ian Lynagh's avatar
Ian Lynagh committed
199
   | Opt_EmptyDataDecls
Ian Lynagh's avatar
Ian Lynagh committed
200
   | Opt_KindSignatures
Ian Lynagh's avatar
Ian Lynagh committed
201
   | Opt_PatternSignatures
Ian Lynagh's avatar
Ian Lynagh committed
202
   | Opt_ParallelListComp
203
   | Opt_GeneralizedNewtypeDeriving
Ian Lynagh's avatar
Ian Lynagh committed
204
   | Opt_RecursiveDo
Ian Lynagh's avatar
Ian Lynagh committed
205
   | Opt_PatternGuards
206
   | Opt_PartiallyAppliedClosedTypeSynonyms
207
208
   | Opt_Rank2Types
   | Opt_RankNTypes
Ian Lynagh's avatar
Ian Lynagh committed
209
   | Opt_TypeOperators
210

211
212
   | Opt_PrintExplicitForalls

213
214
215
216
   -- optimisation opts
   | Opt_Strictness
   | Opt_FullLaziness
   | Opt_CSE
217
218
   | Opt_LiberateCase
   | Opt_SpecConstr
219
220
221
222
   | Opt_IgnoreInterfacePragmas
   | Opt_OmitInterfacePragmas
   | Opt_DoLambdaEtaExpansion
   | Opt_IgnoreAsserts
223
   | Opt_IgnoreBreakpoints
224
225
226
   | Opt_DoEtaReduction
   | Opt_CaseMerge
   | Opt_UnboxStrictFields
227
   | Opt_DictsCheap
228
   | Opt_RewriteRules
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
229
   | Opt_Vectorise
230
231
232
233

   -- misc opts
   | Opt_Cpp
   | Opt_Pp
234
   | Opt_ForceRecomp
235
236
237
238
239
240
241
   | Opt_DryRun
   | Opt_DoAsmMangling
   | Opt_ExcessPrecision
   | Opt_ReadUserPackageConf
   | Opt_NoHsMain
   | Opt_SplitObjs
   | Opt_StgStats
242
   | Opt_HideAllPackages
243
   | Opt_PrintBindResult
244
   | Opt_Haddock
245
   | Opt_Hpc_No_Auto
246
   | Opt_BreakOnException
247
248
249
250
251
252
253
254
255

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

   deriving (Eq)
256
 
257
258
259
260
261
262
263
264
265
266
267
268
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,
269
270

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

272
273
274
  stolen_x86_regs	:: Int,		
  cmdlineHcIncludes	:: [String],	-- -#includes
  importPaths		:: [FilePath],
275
  mainModIs		:: Module,
276
  mainFunIs		:: Maybe String,
277
278
  ctxtStkDepth	        :: Int,		-- Typechecker context stack depth

Simon Marlow's avatar
Simon Marlow committed
279
  thisPackage		:: PackageId,
280
281
282
283
284
285
286

  -- 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.
287
288
289
290
  objectDir		:: Maybe String,
  hiDir			:: Maybe String,
  stubDir		:: Maybe String,

291
292
293
  objectSuf		:: String,
  hcSuf			:: String,
  hiSuf			:: String,
294
295
296
297

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

298
299
300
301
  includePaths		:: [String],
  libraryPaths		:: [String],
  frameworkPaths	:: [String],  	-- used on darwin only
  cmdlineFrameworks	:: [String],	-- ditto
302
  tmpDir		:: String,	-- no trailing '/'
303
  
304
305
306
  ghcUsagePath          :: FilePath,    -- Filled in by SysTools
  ghciUsagePath         :: FilePath,    -- ditto

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

309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
  -- 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_dll		:: [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]),
330
331
  pgm_T                 :: String,
  pgm_sysman            :: String,
332

333
  --  Package flags
334
  extraPkgConfs		:: [FilePath],
335
336
  topDir                :: FilePath,    -- filled in by SysTools
  systemPackageConfig   :: FilePath,    -- ditto
337
338
339
340
341
342
	-- 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

343
344
345
346
  -- Package state
  -- NB. do not modify this field, it is calculated by 
  -- Packages.initPackages and Packages.updatePackages.
  pkgDatabase           :: Maybe (UniqFM InstalledPackageInfo),
347
348
349
  pkgState		:: PackageState,

  -- hsc dynamic flags
350
351
352
353
  flags      		:: [DynFlag],
  
  -- message output
  log_action            :: Severity -> SrcSpan -> PprStyle -> Message -> IO ()
354
355
356
357
358
359
360
361
362
363
 }

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

364
365
366
367
368
369
370
371
372
373
374
375
-- | 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.
376
data GhcMode
377
378
379
  = CompManager         -- ^ --make, GHCi, etc.
  | OneShot		-- ^ ghc -c Foo.hs
  | MkDepend            -- ^ ghc -M, see Finder for why we need this
380
381
382
383
384
385
  deriving Eq

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

386
-- | What kind of linking to do.
387
data GhcLink	-- What to do in the link step, if there is one
388
389
390
  = NoLink		-- Don't link at all
  | LinkBinary		-- Link object code into a binary
  | LinkInMemory        -- Use the in-memory dynamic linker
391
  | LinkDynLib		-- Link objects into a dynamic lib (DLL on Windows, DSO on ELF platforms)
392
  deriving Eq
393
394
395
396
397
398
399
400
401

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

data PackageFlag
  = ExposePackage  String
  | HidePackage    String
  | IgnorePackage  String
402
  deriving Eq
403

404
405
406
407
408
defaultHscTarget = defaultObjectTarget

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

Simon Marlow's avatar
Simon Marlow committed
444
	thisPackage		= mainPackageId,
445

446
447
448
449
	objectDir		= Nothing,
	hiDir			= Nothing,
	stubDir			= Nothing,

450
451
452
	objectSuf		= phaseInputExt StopLn,
	hcSuf			= phaseInputExt HCc,
	hiSuf			= "hi",
453
454
455

	outputFile		= Nothing,
	outputHi		= Nothing,
456
457
458
459
	includePaths		= [],
	libraryPaths		= [],
	frameworkPaths		= [],
	cmdlineFrameworks	= [],
460
	tmpDir			= cDEFAULT_TMPDIR,
461
	
andy@galois.com's avatar
andy@galois.com committed
462
463
        hpcDir		        = ".hpc",

464
465
466
467
468
469
470
471
472
473
474
475
	opt_L			= [],
	opt_P			= [],
	opt_F			= [],
	opt_c			= [],
	opt_a			= [],
	opt_m			= [],
	opt_l			= [],
	opt_dll			= [],
	opt_dep			= [],
	
	extraPkgConfs		= [],
	packageFlags		= [],
476
477
        pkgDatabase             = Nothing,
        pkgState                = panic "no package state yet: call GHC.setSessionDynFlags",
478
479
480
	flags = [ 
    	    Opt_ReadUserPackageConf,
    
481
482
483
484
	    Opt_MonoPatBinds, 	-- Experimentally, I'm making this non-standard
				-- behaviour the default, to see if anyone notices
				-- SLPJ July 06

485
486
    	    Opt_ImplicitPrelude,
    	    Opt_MonomorphismRestriction,
487

488
489
    	    Opt_DoAsmMangling,
    
490
	    -- on by default:
491
492
493
494
	    Opt_PrintBindResult ]
	    ++ [f | (ns,f) <- optLevelFlags, 0 `elem` ns]
	    	    -- The default -O0 options
	    ++ standardWarnings,
495
496
497
498
499
500
               
        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))
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
      }

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

532
533
534
535
setObjectDir  f d = d{ objectDir  = f}
setHiDir      f d = d{ hiDir      = f}
setStubDir    f d = d{ stubDir    = f}

536
537
setObjectSuf  f d = d{ objectSuf  = f}
setHiSuf      f d = d{ hiSuf      = f}
538
539
540
541
setHcSuf      f d = d{ hcSuf      = f}

setOutputFile f d = d{ outputFile = f}
setOutputHi   f d = d{ outputHi   = f}
542
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
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590

-- 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}
addOptdll f d = d{ opt_dll = f : opt_dll 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
591
  = dfs2{ optLevel = final_n }
592
  where
593
   final_n = max 0 (min 2 n)	-- Clamp to 0 <= n <= 2
594
595
596
   dfs1 = foldr (flip dopt_unset) dfs  remove_dopts
   dfs2 = foldr (flip dopt_set)   dfs1 extra_dopts

597
598
   extra_dopts  = [ f | (ns,f) <- optLevelFlags, final_n `elem` ns ]
   remove_dopts = [ f | (ns,f) <- optLevelFlags, final_n `notElem` ns ]
599
	
600
601
602
603
optLevelFlags :: [([Int], DynFlag)]
optLevelFlags
  = [ ([0],	Opt_IgnoreInterfacePragmas)
    , ([0],     Opt_OmitInterfacePragmas)
604

605
    , ([1,2],	Opt_IgnoreAsserts)
606
607
    , ([1,2],	Opt_RewriteRules)	-- Off for -O0; see Note [Scoping for Builtin rules]
					-- 		in PrelRules
608
609
610
611
612
    , ([1,2],	Opt_DoEtaReduction)
    , ([1,2],	Opt_CaseMerge)
    , ([1,2],	Opt_Strictness)
    , ([1,2],	Opt_CSE)
    , ([1,2],	Opt_FullLaziness)
613

614
615
616
617
618
619
620
621
    , ([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.
622
623
624
625
626
627
628
629
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
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
    ]

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

-- -----------------------------------------------------------------------------
-- 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
679
680
  | CoreDoNothing 		 -- Useful when building up 
  | CoreDoPasses [CoreToDo] 	 -- lists of these things
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696

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:
697
698
699
runWhen :: Bool -> CoreToDo -> CoreToDo
runWhen True  do_this = do_this
runWhen False do_this = CoreDoNothing
700
701
702
703
704
705
706
707
708
709
710

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
711
712
    spec_constr   = dopt Opt_SpecConstr dflags
    liberate_case = dopt Opt_LiberateCase dflags
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
    rule_check    = ruleCheck dflags

    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
736
737
            NoCaseOfCase,	-- Don't do case-of-case transformations.
				-- This makes full laziness work better
738
739
740
741
742
743
744
	    MaxSimplifierIterations max_iter
	],

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

745
	runWhen full_laziness (CoreDoFloatOutwards (FloatOutSw False False)),
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783

	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
784
	CoreDoOldStrictness,
785
#endif
786
787
788
789
790
791
792
793
794
795
796
	runWhen strictness (CoreDoPasses [
		CoreDoStrictness,
		CoreDoWorkerWrapper,
		CoreDoGlomBinds,
		CoreDoSimplify (SimplPhase 0) [
		   MaxSimplifierIterations max_iter
		]]),

	runWhen full_laziness 
	  (CoreDoFloatOutwards (FloatOutSw False    -- Not lambdas
					   True)),  -- Float constants
797
798
799
800
801
802
803
		-- 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)


804
805
806
807
	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
808
809
810

	CoreDoFloatInwards,

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

813
814
815
816
817
		-- Case-liberation for -O2.  This should be after
		-- strictness analysis and the simplification which follows it.
	runWhen liberate_case (CoreDoPasses [
	    CoreLiberateCase,
	    CoreDoSimplify (SimplPhase 0) [
818
		  MaxSimplifierIterations max_iter
819
	    ] ]),	-- Run the simplifier after LiberateCase to vastly 
820
821
822
			-- reduce the possiblility of shadowing
			-- Reason: see Note [Shadowing] in SpecConstr.lhs

823
	runWhen spec_constr CoreDoSpecConstr,
824
825

	-- Final clean-up simplification:
826
     	CoreDoSimplify (SimplPhase 0) [
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
	  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

857
858
859
860
861
862
863
864
865
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

866
867
868
869
870
871
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) )
872
  ,  ( "v"		, OptIntSuffix setVerbosity )
873

874
875
876
877
878
879
880
881
882
883
884
885
886
887
        ------- 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) )  
888
  ,  ( "optc"		, HasArg (upd . addOptc) )  
889
890
891
892
893
894
  ,  ( "optm"		, HasArg (upd . addOptm) )  
  ,  ( "opta"		, HasArg (upd . addOpta) )  
  ,  ( "optl"		, HasArg (upd . addOptl) )  
  ,  ( "optdll"		, HasArg (upd . addOptdll) )  
  ,  ( "optdep"		, HasArg (upd . addOptdep) )

895
896
897
898
  ,  ( "split-objs"	, NoArg (if can_split
				    then setDynFlag Opt_SplitObjs
				    else return ()) )

899
900
901
	-------- Linking ----------------------------------------------------
  ,  ( "c"		, NoArg (upd $ \d -> d{ ghcLink=NoLink } ))
  ,  ( "no-link"	, NoArg (upd $ \d -> d{ ghcLink=NoLink } )) -- Dep.
902
  ,  ( "shared"		, NoArg (upd $ \d -> d{ ghcLink=LinkDynLib } ))
903
904
905
906
907
908
909
910
911
912
913
914

	------- Libraries ---------------------------------------------------
  ,  ( "L"		, Prefix addLibraryPath )
  ,  ( "l"		, AnySuffix (\s -> do upd (addOptl s)
					      upd (addOptdll s)))

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

	------- Output Redirection ------------------------------------------
915
  ,  ( "odir"		, HasArg (upd . setObjectDir  . Just))
916
917
918
919
920
921
922
  ,  ( "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))
923
  ,  ( "stubdir"	, HasArg (upd . setStubDir . Just))
924
925

	------- Keeping temporary files -------------------------------------
Ian Lynagh's avatar
Ian Lynagh committed
926
927
928
929
930
931
932
933
934
     -- 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))
935
936
937
938

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

942
943
944
	------- recompilation checker (DEPRECATED, use -fforce-recomp) -----
  ,  ( "recomp"		, NoArg (unSetDynFlag Opt_ForceRecomp) )
  ,  ( "no-recomp"  	, NoArg (setDynFlag   Opt_ForceRecomp) )
945
946
947
948

        ------- Packages ----------------------------------------------------
  ,  ( "package-conf"   , HasArg extraPkgConf_ )
  ,  ( "no-user-package-conf", NoArg (unSetDynFlag Opt_ReadUserPackageConf) )
949
  ,  ( "package-name"   , HasArg (upd . setPackageName) )
950
951
  ,  ( "package"        , HasArg exposePackage )
  ,  ( "hide-package"   , HasArg hidePackage )
952
  ,  ( "hide-all-packages", NoArg (setDynFlag Opt_HideAllPackages) )
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
  ,  ( "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)
968
  ,  ( "ddump-cps-cmm",        	 setDumpFlag Opt_D_dump_cps_cmm)
969
970
971
972
973
974
975
  ,  ( "ddump-asm",          	 setDumpFlag Opt_D_dump_asm)
  ,  ( "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)
976
  ,  ( "ddump-rule-firings",   	 setDumpFlag Opt_D_dump_rule_firings)
977
978
979
980
981
982
983
984
985
986
987
988
989
990
  ,  ( "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)
991
992
  ,  ( "ddump-rn-trace",         setDumpFlag Opt_D_dump_rn_trace)
  ,  ( "ddump-if-trace",         setDumpFlag Opt_D_dump_if_trace)
993
994
  ,  ( "ddump-tc-trace",         setDumpFlag Opt_D_dump_tc_trace)
  ,  ( "ddump-splices",          setDumpFlag Opt_D_dump_splices)
995
  ,  ( "ddump-rn-stats",         setDumpFlag Opt_D_dump_rn_stats)
996
997
998
999
1000
1001
1002
  ,  ( "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)
1003
  ,  ( "ddump-minimal-imports",  setDumpFlag Opt_D_dump_minimal_imports)
1004
  ,  ( "ddump-vect",         	 setDumpFlag Opt_D_dump_vect)
andy@galois.com's avatar
andy@galois.com committed
1005
  ,  ( "ddump-hpc",         	 setDumpFlag Opt_D_dump_hpc)
1006
  ,  ( "ddump-mod-cycles",     	 setDumpFlag Opt_D_dump_mod_cycles)
andy@galois.com's avatar
andy@galois.com committed
1007
  
1008
  ,  ( "ddump-hi-diffs",         NoArg (setDynFlag Opt_D_dump_hi_diffs))
1009
1010
1011
  ,  ( "dcore-lint",       	 NoArg (setDynFlag Opt_DoCoreLinting))
  ,  ( "dstg-lint",        	 NoArg (setDynFlag Opt_DoStgLinting))
  ,  ( "dcmm-lint",		 NoArg (setDynFlag Opt_DoCmmLinting))
1012
  ,  ( "dshow-passes",           NoArg (do setDynFlag Opt_ForceRecomp
1013
				           setVerbosity (Just 2)) )
1014
  ,  ( "dfaststring-stats",	 NoArg (setDynFlag Opt_D_faststring_stats))
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029

	------ 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 */
  ,  ( "w"		, NoArg (mapM_ unSetDynFlag minusWallOpts) )

	------ Optimisation flags ------------------------------------------
1030
1031
1032
1033
  ,  ( "O"	, NoArg (upd (setOptLevel 1)))
  ,  ( "Onot"	, NoArg (upd (setOptLevel 0)))
  ,  ( "O"	, OptIntSuffix (\mb_n -> upd (setOptLevel (mb_n `orElse` 1))))
		-- If the number is missing, use 1
1034

1035
1036
  ,  ( "fmax-simplifier-iterations", IntSuffix (\n -> 
		upd (\dfs -> dfs{ maxSimplIterations = n })) )
1037
1038
1039
1040
1041

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

1042
1043
  ,  ( "frule-check", SepArg (\s -> upd (\dfs -> dfs{ ruleCheck = Just s })))
  ,  ( "fcontext-stack"	, IntSuffix $ \n -> upd $ \dfs -> dfs{ ctxtStkDepth = n })
1044
1045
1046

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

1047
  ,  ( "fasm",		NoArg (setObjTarget HscAsm) )
1048
1049
1050
  ,  ( "fvia-c",	NoArg (setObjTarget HscC) )
  ,  ( "fvia-C",	NoArg (setObjTarget HscC) )

1051
  ,  ( "fno-code",	NoArg (setTarget HscNothing))
1052
1053
  ,  ( "fbyte-code",    NoArg (setTarget HscInterpreted) )
  ,  ( "fobject-code",  NoArg (setTarget defaultHscTarget) )
1054
1055
1056
1057
1058

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

	-- the rest of the -f* and -fno-* flags
1059
1060
1061
1062
  ,  ( "f",		PrefixPred (isFlag fFlags)   (\f -> setDynFlag   (getFlag fFlags f)) )
  ,  ( "f", 		PrefixPred (isNoFlag fFlags) (\f -> unSetDynFlag (getNoFlag fFlags f)) )

	-- For now, allow -X flags with -f; ToDo: report this as deprecated
1063
  ,  ( "f",		PrefixPred (isFlag xFlags) (\f ->  setDynFlag (getFlag xFlags f)) )
1064
  ,  ( "f", 		PrefixPred (isNoFlag xFlags) (\f -> unSetDynFlag (getNoFlag xFlags f)) )
1065
1066
1067
1068

	-- the rest of the -X* and -Xno-* flags
  ,  ( "X",		PrefixPred (isFlag xFlags)   (\f -> setDynFlag   (getFlag xFlags f)) )
  ,  ( "X", 		PrefixPred (isNoFlag xFlags) (\f -> unSetDynFlag (getNoFlag xFlags f)) )
1069
1070
1071
1072
1073
1074
1075
 ]

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

fFlags = [
  ( "warn-duplicate-exports",    	Opt_WarnDuplicateExports ),
  ( "warn-hi-shadowing",         	Opt_WarnHiShadows ),
1076
  ( "warn-implicit-prelude",            Opt_WarnImplicitPrelude ),
1077
1078
1079
1080
1081
1082
1083
1084
1085
  ( "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 ),
1086
  ( "warn-monomorphism-restriction",   	Opt_WarnMonomorphism ),
1087
1088
1089
1090
1091
  ( "warn-unused-binds",         	Opt_WarnUnusedBinds ),
  ( "warn-unused-imports",       	Opt_WarnUnusedImports ),
  ( "warn-unused-matches",       	Opt_WarnUnusedMatches ),
  ( "warn-deprecations",         	Opt_WarnDeprecations ),
  ( "warn-orphans",	         	Opt_WarnOrphans ),
1092
  ( "warn-tabs",	         	Opt_WarnTabs ),
1093
  ( "print-explicit-foralls", Opt_PrintExplicitForalls ),
1094
1095
  ( "strictness",			Opt_Strictness ),
  ( "full-laziness",			Opt_FullLaziness ),
1096
1097
  ( "liberate-case",			Opt_LiberateCase ),
  ( "spec-constr",			Opt_SpecConstr ),
1098
1099
1100
1101
1102
  ( "cse",				Opt_CSE ),
  ( "ignore-interface-pragmas",		Opt_IgnoreInterfacePragmas ),
  ( "omit-interface-pragmas",		Opt_OmitInterfacePragmas ),
  ( "do-lambda-eta-expansion",		Opt_DoLambdaEtaExpansion ),
  ( "ignore-asserts",			Opt_IgnoreAsserts ),
1103
  ( "ignore-breakpoints",               Opt_IgnoreBreakpoints),
1104
1105
1106
  ( "do-eta-reduction",			Opt_DoEtaReduction ),
  ( "case-merge",			Opt_CaseMerge ),
  ( "unbox-strict-fields",		Opt_UnboxStrictFields ),
1107
  ( "dicts-cheap",			Opt_DictsCheap ),
1108
  ( "excess-precision",			Opt_ExcessPrecision ),
1109
  ( "asm-mangling",			Opt_DoAsmMangling ),
1110
  ( "print-bind-result",		Opt_PrintBindResult ),
1111
  ( "force-recomp",			Opt_ForceRecomp ),
1112
  ( "hpc-no-auto",			Opt_Hpc_No_Auto ),
1113
  ( "rewrite-rules",			Opt_RewriteRules ),
rl@cse.unsw.edu.au's avatar
rl@cse.unsw.edu.au committed
1114
1115
  ( "break-on-exception",               Opt_BreakOnException ),
  ( "vectorise",                        Opt_Vectorise )
1116
1117
  ]

1118

1119
1120
1121
-- These -X<blah> flags can all be reversed with -Xno-<blah>
xFlags :: [(String, DynFlag)]
xFlags = [
Ian Lynagh's avatar
Ian Lynagh committed
1122
  ( "CPP",                              Opt_Cpp ),
Ian Lynagh's avatar
Ian Lynagh committed
1123
  ( "PatternGuards",                    Opt_PatternGuards ),
Ian Lynagh's avatar
Ian Lynagh committed
1124
  ( "UnicodeSyntax",                    Opt_UnicodeSyntax ),
1125
  ( "MagicHash",                        Opt_MagicHash ),
Ian Lynagh's avatar
Ian Lynagh committed
1126
  ( "PolymorphicComponents",            Opt_PolymorphicComponents ),
1127
  ( "ExistentialQuantification",        Opt_ExistentialQuantification ),
Ian Lynagh's avatar
Ian Lynagh committed
1128
  ( "KindSignatures",                   Opt_KindSignatures ),
Ian Lynagh's avatar
Ian Lynagh committed
1129
  ( "PatternSignatures",                Opt_PatternSignatures ),
Ian Lynagh's avatar
Ian Lynagh committed
1130
  ( "EmptyDataDecls",                   Opt_EmptyDataDecls ),
Ian Lynagh's avatar
Ian Lynagh committed
1131
  ( "ParallelListComp",                 Opt_ParallelListComp ),
1132
1133
  ( "FI",				Opt_FFI ),  -- support `-ffi'...
  ( "FFI",				Opt_FFI ),  -- ...and also `-fffi'
Ian Lynagh's avatar
Ian Lynagh committed
1134
  ( "ForeignFunctionInterface",		Opt_FFI ),
Ian Lynagh's avatar
Ian Lynagh committed
1135
  ( "UnliftedFFITypes",                 Opt_UnliftedFFITypes ),
1136

1137
  ( "PartiallyAppliedClosedTypeSynonyms", Opt_PartiallyAppliedClosedTypeSynonyms ),
1138
1139
  ( "Rank2Types",                       Opt_Rank2Types ),
  ( "RankNTypes",                       Opt_RankNTypes ),
Ian Lynagh's avatar
Ian Lynagh committed
1140
  ( "TypeOperators",                    Opt_TypeOperators ),
Ian Lynagh's avatar
Ian Lynagh committed
1141
  ( "RecursiveDo",                      Opt_RecursiveDo ),
1142
1143
1144
  ( "Arrows",				Opt_Arrows ), -- arrow syntax
  ( "Parr",				Opt_PArr ),

Ian Lynagh's avatar
Ian Lynagh committed
1145
  ( "TH",				Opt_TH ), -- support -fth
1146
1147
1148
1149
1150
1151
  ( "TemplateHaskelll",			Opt_TH ),

  ( "Generics",  			Opt_Generics ),

  ( "ImplicitPrelude",  		Opt_ImplicitPrelude ),	-- On by default

1152
1153
1154
1155
  ( "RecordWildCards",			Opt_RecordWildCards ),
  ( "RecordPuns",			Opt_RecordPuns ),
  ( "DisambiguateRecordFields",		Opt_DisambiguateRecordFields ),

1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
  ( "OverloadedStrings",		Opt_OverloadedStrings ),
  ( "GADTs",		  		Opt_GADTs ),
  ( "TypeFamilies",	  		Opt_TypeFamilies ),
  ( "BangPatterns",	  		Opt_BangPatterns ),
  ( "MonomorphismRestriction",		Opt_MonomorphismRestriction ),	-- On by default
  ( "MonoPatBinds",			Opt_MonoPatBinds ),		-- On by default (which is not strictly H98)
  ( "RelaxedPolyRec", 			Opt_RelaxedPolyRec),
  ( "ExtendedDefaultRules",		Opt_ExtendedDefaultRules ),
  ( "ImplicitParams",			Opt_ImplicitParams ),
  ( "ScopedTypeVariables",  		Opt_ScopedTypeVariables ),
Ian Lynagh's avatar
Ian Lynagh committed
1166
1167
1168
  ( "UnboxedTuples",                Opt_UnboxedTuples ),
  ( "ExpressionSignaturesUnboxedTuples", Opt_ExpressionSignaturesUnboxedTuples ),
  ( "TypeSynonymUnboxedTuples",     Opt_TypeSynonymUnboxedTuples ),
1169
  ( "TypeSynonymInstances",         Opt_TypeSynonymInstances ),
Ian Lynagh's avatar
Ian Lynagh committed
1170
  ( "FlexibleContexts",             Opt_FlexibleContexts ),
1171
  ( "FlexibleInstances",            Opt_FlexibleInstances ),
Ian Lynagh's avatar
Ian Lynagh committed
1172
  ( "MultiParamTypeClasses",        Opt_MultiParamTypeClasses ),
1173
  ( "FunctionalDependencies",        Opt_FunctionalDependencies ),
1174
  ( "GeneralizedNewtypeDeriving",   Opt_GeneralizedNewtypeDeriving ),
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
  ( "AllowOverlappingInstances", 	Opt_AllowOverlappingInstances ),
  ( "AllowUndecidableInstances", 	Opt_AllowUndecidableInstances ),
  ( "AllowIncoherentInstances", 	Opt_AllowIncoherentInstances )
  ]

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

glasgowExtsFlags = [ Opt_GlasgowExts 
1186
           , Opt_PrintExplicitForalls
1187
		   , Opt_FFI 
Ian Lynagh's avatar
Ian Lynagh committed
1188
           , Opt_UnliftedFFITypes
1189
		   , Opt_GADTs
1190
1191
		   , Opt_ImplicitParams 
		   , Opt_ScopedTypeVariables
Ian Lynagh's avatar
Ian Lynagh committed
1192
1193
1194
           , Opt_UnboxedTuples
           , Opt_ExpressionSignaturesUnboxedTuples
           , Opt_TypeSynonymUnboxedTuples
1195
           , Opt_TypeSynonymInstances
Ian Lynagh's avatar
Ian Lynagh committed
1196
           , Opt_FlexibleContexts
1197
           , Opt_FlexibleInstances
Ian Lynagh's avatar
Ian Lynagh committed
1198
           , Opt_MultiParamTypeClasses
1199
           , Opt_FunctionalDependencies
1200
		   , Opt_MagicHash
Ian Lynagh's avatar
Ian Lynagh committed
1201
           , Opt_PolymorphicComponents
1202
           , Opt_ExistentialQuantification
Ian Lynagh's avatar
Ian Lynagh committed
1203
           , Opt_UnicodeSyntax
Ian Lynagh's avatar
Ian Lynagh committed
1204
           , Opt_PatternGuards
1205
           , Opt_PartiallyAppliedClosedTypeSynonyms
1206
           , Opt_RankNTypes
Ian Lynagh's avatar
Ian Lynagh committed
1207
           , Opt_TypeOperators
Ian Lynagh's avatar
Ian Lynagh committed
1208
           , Opt_RecursiveDo
Ian Lynagh's avatar
Ian Lynagh committed
1209
           , Opt_ParallelListComp
Ian Lynagh's avatar
Ian Lynagh committed
1210
           , Opt_EmptyDataDecls
Ian Lynagh's avatar
Ian Lynagh committed
1211
           , Opt_KindSignatures
Ian Lynagh's avatar
Ian Lynagh committed
1212
           , Opt_PatternSignatures
1213
           , Opt_GeneralizedNewtypeDeriving
1214
1215
1216
1217
1218
1219
		   , Opt_TypeFamilies ]

------------------
isNoFlag, isFlag :: [(String,a)] -> String -> Bool

isFlag flags f = is_flag flags (normaliseFlag f)
1220

1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
isNoFlag flags no_f
  | Just f <- noFlag_maybe (normaliseFlag no_f) = is_flag flags f
  | otherwise					= False

is_flag flags nf = any (\(ff,_) -> normaliseFlag ff == nf) flags
	-- nf is normalised alreadly

------------------
getFlag, getNoFlag :: [(String,a)] -> String -> a

getFlag flags f = get_flag flags (normaliseFlag f)

1233
getNoFlag flags f = get_flag flags (fromJust (noFlag_maybe (normaliseFlag f)))
1234
1235
			-- The flag should be a no-flag already

1236
1237
1238
get_flag flags nf = case [ opt | (ff, opt) <- flags, normaliseFlag ff == nf] of
			(o:os) -> o
			[]     -> panic ("get_flag " ++ nf)
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253

------------------
noFlag_maybe :: String -> Maybe String
-- The input is normalised already
noFlag_maybe ('n' : 'o' : f) = Just f
noFlag_maybe other	     = Nothing

normaliseFlag :: String -> String
-- Normalise a option flag by
--	* map to lower case
--	* removing hyphens
-- Thus: -X=overloaded-strings or -XOverloadedStrings
normaliseFlag []      = []
normaliseFlag ('-':s) = normaliseFlag s
normaliseFlag (c:s)   = toLower c : normaliseFlag s
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273

-- -----------------------------------------------------------------------------
-- Parsing the dynamic flags.

parseDynamicFlags :: DynFlags -> [String] -> IO (DynFlags,[String])
parseDynamicFlags dflags args = do
  let ((leftover,errs),dflags') 
	  = runCmdLine (processArgs dynamic_flags args) dflags
  when (not (null errs)) $ do
    throwDyn (UsageError (unlines errs))
  return (dflags', leftover)


type DynP = CmdLineP DynFlags

upd :: (DynFlags -> DynFlags) -> DynP ()
upd f = do 
   dfs <- getCmdLineState
   putCmdLineState $! (f dfs)

1274
--------------------------
1275
setDynFlag, unSetDynFlag :: DynFlag -> DynP ()
1276
1277
1278
1279
1280
1281
1282
setDynFlag f = upd (\dfs -> foldl dopt_set (dopt_set dfs f) deps)
  where
    deps = [ d | (f', ds) <- impliedFlags, f' == f, d <- ds ]
	-- When you set f, set the ones it implies
	-- When you un-set f, however, we don't un-set the things it implies
	--	(except for -fno-glasgow-exts, which is treated specially)

1283
1284
unSetDynFlag f = upd (\dfs -> dopt_unset dfs f)

1285
--------------------------
1286
1287
setDumpFlag :: DynFlag -> OptKind DynP
setDumpFlag dump_flag 
1288
  = NoArg (setDynFlag Opt_ForceRecomp >> setDynFlag dump_flag)
1289
1290
1291
	-- Whenver we -ddump, switch off the recompilation checker,
	-- else you don't see the dump!

1292
1293
setVerbosity :: Maybe Int -> DynP ()
setVerbosity mb_n = upd (\dfs -> dfs{ verbosity = mb_n `orElse` 3 })
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304

addCmdlineHCInclude a = upd (\s -> s{cmdlineHcIncludes =  a : cmdlineHcIncludes s})

extraPkgConf_  p = upd (\s -> s{ extraPkgConfs = p : extraPkgConfs s })

exposePackage p = 
  upd (\s -> s{ packageFlags = ExposePackage p : packageFlags s })
hidePackage p = 
  upd (\s -> s{ packageFlags = HidePackage p : packageFlags s })
ignorePackage p = 
  upd (\s -> s{ packageFlags = IgnorePackage p : packageFlags s })
1305

Simon Marlow's avatar
Simon Marlow committed
1306
1307
1308
1309
setPackageName p
  | Nothing <- unpackPackageId pid
  = throwDyn (CmdLineError ("cannot parse \'" ++ p ++ "\' as a package identifier"))
  | otherwise
1310
  = \s -> s{ thisPackage = pid }
Simon Marlow's avatar
Simon Marlow committed
1311
1312
  where
        pid = stringToPackageId p
1313

1314
1315