[project @ 2005-09-23 10:13:33 by simonmar]
[ghc-hetmet.git] / ghc / compiler / main / DriverPipeline.hs
1 -----------------------------------------------------------------------------
2 --
3 -- GHC Driver
4 --
5 -- (c) The University of Glasgow 2005
6 --
7 -----------------------------------------------------------------------------
8
9 module DriverPipeline (
10         -- Run a series of compilation steps in a pipeline, for a
11         -- collection of source files.
12    oneShot, compileFile,
13
14         -- Interfaces for the batch-mode driver
15    staticLink,
16
17         -- Interfaces for the compilation manager (interpreted/batch-mode)
18    preprocess, 
19    compile, CompResult(..), 
20    link, 
21
22         -- DLL building
23    doMkDLL,
24
25    getOptionsFromStringBuffer,  -- used in module GHC
26    optionsErrorMsgs,            -- ditto
27   ) where
28
29 #include "HsVersions.h"
30
31 import Packages
32 import GetImports
33 import DriverPhases
34 import SysTools         ( newTempName, addFilesToClean, getSysMan, copy )
35 import qualified SysTools       
36 import HscMain
37 import Finder
38 import HscTypes
39 import Outputable
40 import Module
41 import ErrUtils
42 import DynFlags
43 import StaticFlags      ( v_Ld_inputs, opt_Static, WayName(..) )
44 import Config
45 import Panic
46 import Util
47 import StringBuffer     ( hGetStringBuffer )
48 import BasicTypes       ( SuccessFlag(..) )
49 import Maybes           ( expectJust )
50 import Ctype            ( is_ident )
51 import StringBuffer     ( StringBuffer(..), lexemeToString )
52 import ParserCoreUtils  ( getCoreModuleName )
53 import SrcLoc           ( srcLocSpan, mkSrcLoc )
54 import FastString       ( mkFastString )
55 import Bag              ( listToBag, emptyBag )
56 import SrcLoc           ( Located(..) )
57
58 import EXCEPTION
59 import DATA_IOREF       ( readIORef, writeIORef, IORef )
60 import GLAEXTS          ( Int(..) )
61
62 import Directory
63 import System
64 import IO
65 import Monad
66 import Maybe
67
68
69 -- ---------------------------------------------------------------------------
70 -- Pre-process
71
72 -- Just preprocess a file, put the result in a temp. file (used by the
73 -- compilation manager during the summary phase).
74 --
75 -- We return the augmented DynFlags, because they contain the result
76 -- of slurping in the OPTIONS pragmas
77
78 preprocess :: DynFlags -> (FilePath, Maybe Phase) -> IO (DynFlags, FilePath)
79 preprocess dflags (filename, mb_phase) =
80   ASSERT2(isJust mb_phase || isHaskellSrcFilename filename, text filename) 
81   runPipeline anyHsc dflags (filename, mb_phase) Temporary Nothing{-no ModLocation-}
82
83 -- ---------------------------------------------------------------------------
84 -- Compile
85
86 -- Compile a single module, under the control of the compilation manager.
87 --
88 -- This is the interface between the compilation manager and the
89 -- compiler proper (hsc), where we deal with tedious details like
90 -- reading the OPTIONS pragma from the source file, and passing the
91 -- output of hsc through the C compiler.
92
93 -- NB.  No old interface can also mean that the source has changed.
94
95 compile :: HscEnv
96         -> (Messages -> IO ())  -- error message callback
97         -> ModSummary
98         -> Maybe Linkable       -- Just linkable <=> source unchanged
99         -> Maybe ModIface       -- Old interface, if available
100         -> Int -> Int
101         -> IO CompResult
102
103 data CompResult
104    = CompOK   ModDetails        -- New details
105               ModIface          -- New iface
106               (Maybe Linkable)  -- a Maybe, for the same reasons as hm_linkable
107
108    | CompErrs 
109
110
111 compile hsc_env msg_act mod_summary maybe_old_linkable old_iface mod_index nmods = do 
112
113    let dflags0     = hsc_dflags hsc_env
114        this_mod    = ms_mod mod_summary
115        src_flavour = ms_hsc_src mod_summary
116
117        have_object 
118                | Just l <- maybe_old_linkable, isObjectLinkable l = True
119                | otherwise = False
120
121    showPass dflags0 ("Compiling " ++ showModMsg have_object mod_summary)
122
123    let location   = ms_location mod_summary
124    let input_fn   = expectJust "compile:hs" (ml_hs_file location) 
125    let input_fnpp = expectJust "compile:hspp" (ms_hspp_file mod_summary)
126
127    debugTraceMsg dflags0 2 ("compile: input file " ++ input_fnpp)
128
129    -- Add in the OPTIONS from the source file
130    -- This is nasty: we've done this once already, in the compilation manager
131    -- It might be better to cache the flags in the ml_hspp_file field,say
132    let hspp_buf = expectJust "compile:hspp_buf" (ms_hspp_buf mod_summary)
133        opts = getOptionsFromStringBuffer hspp_buf
134    (dflags1,unhandled_flags) <- parseDynamicFlags dflags0 (map snd opts)
135    if (not (null unhandled_flags))
136         then do msg_act (optionsErrorMsgs unhandled_flags opts input_fn)
137                 return CompErrs
138         else do
139
140    let (basename, _) = splitFilename input_fn
141
142   -- We add the directory in which the .hs files resides) to the import path.
143   -- This is needed when we try to compile the .hc file later, if it
144   -- imports a _stub.h file that we created here.
145    let current_dir = directoryOf basename
146        old_paths   = includePaths dflags1
147        dflags      = dflags1 { includePaths = current_dir : old_paths }
148
149    -- Figure out what lang we're generating
150    let hsc_lang = hscMaybeAdjustTarget dflags StopLn src_flavour (hscTarget dflags)
151    -- ... and what the next phase should be
152    let next_phase = hscNextPhase dflags src_flavour hsc_lang
153    -- ... and what file to generate the output into
154    output_fn <- getOutputFilename dflags next_phase 
155                         Temporary basename next_phase (Just location)
156
157    let dflags' = dflags { hscTarget = hsc_lang,
158                                 hscOutName = output_fn,
159                                 hscStubCOutName = basename ++ "_stub.c",
160                                 hscStubHOutName = basename ++ "_stub.h",
161                                 extCoreName = basename ++ ".hcr" }
162
163    -- -no-recomp should also work with --make
164    let do_recomp = dopt Opt_RecompChecking dflags
165        source_unchanged = isJust maybe_old_linkable && do_recomp
166        hsc_env' = hsc_env { hsc_dflags = dflags' }
167        object_filename = ml_obj_file location
168
169    -- run the compiler
170    hsc_result <- hscMain hsc_env' msg_act mod_summary
171                          source_unchanged have_object old_iface
172                          (Just (mod_index, nmods))
173
174    case hsc_result of
175       HscFail -> return CompErrs
176
177       HscNoRecomp details iface -> 
178           ASSERT(isJust maybe_old_linkable)
179           return (CompOK details iface maybe_old_linkable)
180
181       HscRecomp details iface stub_h_exists stub_c_exists maybe_interpreted_code 
182
183         | isHsBoot src_flavour  -- No further compilation to do
184         -> do   case hsc_lang of
185                    HscInterpreted -> return ()
186                    _other -> SysTools.touch dflags' "Touching object file" 
187                                             object_filename
188                 return (CompOK details iface Nothing)
189
190         | otherwise     -- Normal source file
191         -> do
192            stub_unlinked <-
193              if stub_c_exists then do
194                 stub_o <- compileStub dflags' object_filename
195                 return [ DotO stub_o ]
196              else
197                 return []
198
199            (hs_unlinked, unlinked_time) <-
200              case hsc_lang of
201
202                 -- in interpreted mode, just return the compiled code
203                 -- as our "unlinked" object.
204                 HscInterpreted
205                   -> case maybe_interpreted_code of
206 #ifdef GHCI
207                        Just comp_bc -> return ([BCOs comp_bc], ms_hs_date mod_summary)
208                         -- Why do we use the timestamp of the source file here,
209                         -- rather than the current time?  This works better in
210                         -- the case where the local clock is out of sync
211                         -- with the filesystem's clock.  It's just as accurate:
212                         -- if the source is modified, then the linkable will
213                         -- be out of date.
214 #endif
215                        Nothing -> panic "compile: no interpreted code"
216
217                 HscNothing
218                   -> return ([], ms_hs_date mod_summary)
219
220                 -- We're in --make mode: finish the compilation pipeline.
221                 _other
222                   -> do runPipeline StopLn dflags (output_fn,Nothing) Persistent
223                                     (Just location)
224                                 -- The object filename comes from the ModLocation
225
226                         o_time <- getModificationTime object_filename
227                         return ([DotO object_filename], o_time)
228
229            let linkable = LM unlinked_time this_mod
230                              (hs_unlinked ++ stub_unlinked)
231
232            return (CompOK details iface (Just linkable))
233
234 -----------------------------------------------------------------------------
235 -- stub .h and .c files (for foreign export support)
236
237 -- The _stub.c file is derived from the haskell source file (but stored
238 -- in hscStubCOutName in the dflags for some reason, probably historical).
239 -- Consequently, we derive the _stub.o filename from the haskell object
240 -- filename.  
241 --
242 -- This isn't necessarily the same as the object filename we
243 -- would get if we just compiled the _stub.c file using the pipeline.
244 -- For example:
245 --
246 --    ghc src/A.hs -odir obj
247 -- 
248 -- results in obj/A.o, and src/A_stub.c.  If we compile src/A_stub.c with
249 -- -odir obj, we would get obj/src/A_stub.o, which is wrong; we want
250 -- obj/A_stub.o.
251
252 compileStub dflags object_filename = do
253         let (o_base, o_ext) = splitFilename object_filename
254             stub_o = o_base ++ "_stub" `joinFileExt` o_ext
255
256         -- compile the _stub.c file w/ gcc
257         let stub_c = hscStubCOutName dflags
258         runPipeline StopLn dflags (stub_c,Nothing) 
259                 (SpecificFile stub_o) Nothing{-no ModLocation-}
260
261         return stub_o
262
263
264 -- ---------------------------------------------------------------------------
265 -- Link
266
267 link :: GhcMode                 -- interactive or batch
268      -> DynFlags                -- dynamic flags
269      -> Bool                    -- attempt linking in batch mode?
270      -> HomePackageTable        -- what to link
271      -> IO SuccessFlag
272
273 -- For the moment, in the batch linker, we don't bother to tell doLink
274 -- which packages to link -- it just tries all that are available.
275 -- batch_attempt_linking should only be *looked at* in batch mode.  It
276 -- should only be True if the upsweep was successful and someone
277 -- exports main, i.e., we have good reason to believe that linking
278 -- will succeed.
279
280 #ifdef GHCI
281 link Interactive dflags batch_attempt_linking hpt
282     = do -- Not Linking...(demand linker will do the job)
283          return Succeeded
284 #endif
285
286 link JustTypecheck dflags batch_attempt_linking hpt
287    = return Succeeded
288
289 link BatchCompile dflags batch_attempt_linking hpt
290    | batch_attempt_linking
291    = do 
292         let 
293             home_mod_infos = moduleEnvElts hpt
294
295             -- the packages we depend on
296             pkg_deps  = concatMap (dep_pkgs . mi_deps . hm_iface) home_mod_infos
297
298             -- the linkables to link
299             linkables = map (fromJust.hm_linkable) home_mod_infos
300
301         debugTraceMsg dflags 3 "link: linkables are ..."
302         debugTraceMsg dflags 3 (showSDoc (vcat (map ppr linkables)))
303
304         -- check for the -no-link flag
305         if isNoLink (ghcLink dflags)
306           then do debugTraceMsg dflags 3 "link(batch): linking omitted (-c flag given)."
307                   return Succeeded
308           else do
309
310         let getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)
311             obj_files = concatMap getOfiles linkables
312
313             exe_file = exeFileName dflags
314
315         -- if the modification time on the executable is later than the
316         -- modification times on all of the objects, then omit linking
317         -- (unless the -no-recomp flag was given).
318         e_exe_time <- IO.try $ getModificationTime exe_file
319         let linking_needed 
320                 | Left _  <- e_exe_time = True
321                 | Right t <- e_exe_time = 
322                         any (t <) (map linkableTime linkables)
323
324         if dopt Opt_RecompChecking dflags && not linking_needed
325            then do debugTraceMsg dflags 1 (exe_file ++ " is up to date, linking not required.")
326                    return Succeeded
327            else do
328
329         debugTraceMsg dflags 1 "Linking ..."
330
331         -- Don't showPass in Batch mode; doLink will do that for us.
332         staticLink dflags obj_files pkg_deps
333
334         debugTraceMsg dflags 3 "link: done"
335
336         -- staticLink only returns if it succeeds
337         return Succeeded
338
339    | otherwise
340    = do debugTraceMsg dflags 3 "link(batch): upsweep (partially) failed OR"
341         debugTraceMsg dflags 3 "   Main.main not exported; not linking."
342         return Succeeded
343       
344
345 -- -----------------------------------------------------------------------------
346 -- Compile files in one-shot mode.
347
348 oneShot :: DynFlags -> Phase -> [(String, Maybe Phase)] -> IO ()
349 oneShot dflags stop_phase srcs = do
350   o_files <- mapM (compileFile dflags stop_phase) srcs
351   doLink dflags stop_phase o_files
352
353 compileFile :: DynFlags -> Phase -> (FilePath, Maybe Phase) -> IO FilePath
354 compileFile dflags stop_phase (src, mb_phase) = do
355    exists <- doesFileExist src
356    when (not exists) $ 
357         throwDyn (CmdLineError ("does not exist: " ++ src))
358    
359    let
360         split     = dopt Opt_SplitObjs dflags
361         mb_o_file = outputFile dflags
362         ghc_link  = ghcLink dflags      -- Set by -c or -no-link
363
364         -- When linking, the -o argument refers to the linker's output. 
365         -- otherwise, we use it as the name for the pipeline's output.
366         output
367          | StopLn <- stop_phase, not (isNoLink ghc_link) = Persistent
368                 -- -o foo applies to linker
369          | Just o_file <- mb_o_file = SpecificFile o_file
370                 -- -o foo applies to the file we are compiling now
371          | otherwise = Persistent
372
373         stop_phase' = case stop_phase of 
374                         As | split -> SplitAs
375                         other      -> stop_phase
376
377    (_, out_file) <- runPipeline stop_phase' dflags
378                           (src, mb_phase) output Nothing{-no ModLocation-}
379    return out_file
380
381
382 doLink :: DynFlags -> Phase -> [FilePath] -> IO ()
383 doLink dflags stop_phase o_files
384   | not (isStopLn stop_phase)
385   = return ()           -- We stopped before the linking phase
386
387   | otherwise
388   = case ghcLink dflags of
389         NoLink     -> return ()
390         StaticLink -> staticLink dflags o_files link_pkgs
391         MkDLL      -> doMkDLL dflags o_files link_pkgs
392   where
393    -- Always link in the haskell98 package for static linking.  Other
394    -- packages have to be specified via the -package flag.
395     link_pkgs
396           | ExtPackage h98_id <- haskell98PackageId (pkgState dflags) = [h98_id]
397           | otherwise = []
398
399
400 -- ---------------------------------------------------------------------------
401 -- Run a compilation pipeline, consisting of multiple phases.
402
403 -- This is the interface to the compilation pipeline, which runs
404 -- a series of compilation steps on a single source file, specifying
405 -- at which stage to stop.
406
407 -- The DynFlags can be modified by phases in the pipeline (eg. by
408 -- GHC_OPTIONS pragmas), and the changes affect later phases in the
409 -- pipeline.
410
411 data PipelineOutput 
412   = Temporary
413         -- output should be to a temporary file: we're going to
414         -- run more compilation steps on this output later
415   | Persistent
416         -- we want a persistent file, i.e. a file in the current directory
417         -- derived from the input filename, but with the appropriate extension.
418         -- eg. in "ghc -c Foo.hs" the output goes into ./Foo.o.
419   | SpecificFile FilePath
420         -- the output must go into the specified file.
421
422 runPipeline
423   :: Phase                      -- When to stop
424   -> DynFlags                   -- Dynamic flags
425   -> (FilePath,Maybe Phase)     -- Input filename (and maybe -x suffix)
426   -> PipelineOutput             -- Output filename
427   -> Maybe ModLocation          -- A ModLocation, if this is a Haskell module
428   -> IO (DynFlags, FilePath)    -- (final flags, output filename)
429
430 runPipeline stop_phase dflags (input_fn, mb_phase) output maybe_loc
431   = do
432   let (basename, suffix) = splitFilename input_fn
433
434         -- If we were given a -x flag, then use that phase to start from
435       start_phase
436         | Just x_phase <- mb_phase = x_phase
437         | otherwise                = startPhase suffix
438
439   -- We want to catch cases of "you can't get there from here" before
440   -- we start the pipeline, because otherwise it will just run off the
441   -- end.
442   --
443   -- There is a partial ordering on phases, where A < B iff A occurs
444   -- before B in a normal compilation pipeline.
445
446   when (not (start_phase `happensBefore` stop_phase)) $
447         throwDyn (UsageError 
448                     ("cannot compile this file to desired target: "
449                        ++ input_fn))
450
451   -- this is a function which will be used to calculate output file names
452   -- as we go along (we partially apply it to some of its inputs here)
453   let get_output_fn = getOutputFilename dflags stop_phase output basename
454
455   -- Execute the pipeline...
456   (dflags', output_fn, maybe_loc) <- 
457         pipeLoop dflags start_phase stop_phase input_fn 
458                  basename suffix get_output_fn maybe_loc
459
460   -- Sometimes, a compilation phase doesn't actually generate any output
461   -- (eg. the CPP phase when -fcpp is not turned on).  If we end on this
462   -- stage, but we wanted to keep the output, then we have to explicitly
463   -- copy the file.
464   case output of
465     Temporary -> 
466         return (dflags', output_fn)
467     _other ->
468         do final_fn <- get_output_fn stop_phase maybe_loc
469            when (final_fn /= output_fn) $
470                   copy dflags ("Copying `" ++ output_fn ++ "' to `" ++ final_fn
471                         ++ "'") output_fn final_fn
472            return (dflags', final_fn)
473                 
474
475
476 pipeLoop :: DynFlags -> Phase -> Phase 
477          -> FilePath  -> String -> Suffix
478          -> (Phase -> Maybe ModLocation -> IO FilePath)
479          -> Maybe ModLocation
480          -> IO (DynFlags, FilePath, Maybe ModLocation)
481
482 pipeLoop dflags phase stop_phase 
483          input_fn orig_basename orig_suff 
484          orig_get_output_fn maybe_loc
485
486   | phase `eqPhase` stop_phase            -- All done
487   = return (dflags, input_fn, maybe_loc)
488
489   | not (phase `happensBefore` stop_phase)
490         -- Something has gone wrong.  We'll try to cover all the cases when
491         -- this could happen, so if we reach here it is a panic.
492         -- eg. it might happen if the -C flag is used on a source file that
493         -- has {-# OPTIONS -fasm #-}.
494   = panic ("pipeLoop: at phase " ++ show phase ++ 
495            " but I wanted to stop at phase " ++ show stop_phase)
496
497   | otherwise 
498   = do  { (next_phase, dflags', maybe_loc, output_fn)
499                 <- runPhase phase stop_phase dflags orig_basename 
500                             orig_suff input_fn orig_get_output_fn maybe_loc
501         ; pipeLoop dflags' next_phase stop_phase output_fn
502                    orig_basename orig_suff orig_get_output_fn maybe_loc }
503
504 getOutputFilename
505   :: DynFlags -> Phase -> PipelineOutput -> String
506   -> Phase{-next phase-} -> Maybe ModLocation -> IO FilePath
507 getOutputFilename dflags stop_phase output basename
508  = func
509  where
510         hcsuf      = hcSuf dflags
511         odir       = outputDir dflags
512         osuf       = objectSuf dflags
513         keep_hc    = dopt Opt_KeepHcFiles dflags
514         keep_raw_s = dopt Opt_KeepRawSFiles dflags
515         keep_s     = dopt Opt_KeepSFiles dflags
516
517         myPhaseInputExt HCc    = hcsuf
518         myPhaseInputExt StopLn = osuf
519         myPhaseInputExt other  = phaseInputExt other
520
521         func next_phase maybe_location
522            | is_last_phase, Persistent <- output     = persistent_fn
523            | is_last_phase, SpecificFile f <- output = return f
524            | keep_this_output                        = persistent_fn
525            | otherwise                               = newTempName dflags suffix
526            where
527                 is_last_phase = next_phase `eqPhase` stop_phase
528
529                 -- sometimes, we keep output from intermediate stages
530                 keep_this_output = 
531                      case next_phase of
532                              StopLn              -> True
533                              Mangle | keep_raw_s -> True
534                              As     | keep_s     -> True
535                              HCc    | keep_hc    -> True
536                              _other              -> False
537
538                 suffix = myPhaseInputExt next_phase
539
540                 -- persistent object files get put in odir
541                 persistent_fn 
542                    | StopLn <- next_phase = return odir_persistent
543                    | otherwise            = return persistent
544
545                 persistent = basename `joinFileExt` suffix
546
547                 odir_persistent
548                    | Just loc <- maybe_location = ml_obj_file loc
549                    | Just d <- odir = d `joinFileName` persistent
550                    | otherwise      = persistent
551
552
553 -- -----------------------------------------------------------------------------
554 -- Each phase in the pipeline returns the next phase to execute, and the
555 -- name of the file in which the output was placed.
556 --
557 -- We must do things dynamically this way, because we often don't know
558 -- what the rest of the phases will be until part-way through the
559 -- compilation: for example, an {-# OPTIONS -fasm #-} at the beginning
560 -- of a source file can change the latter stages of the pipeline from
561 -- taking the via-C route to using the native code generator.
562
563 runPhase :: Phase       -- Do this phase first
564          -> Phase       -- Stop just before this phase
565          -> DynFlags
566          -> String      -- basename of original input source
567          -> String      -- its extension
568          -> FilePath    -- name of file which contains the input to this phase.
569          -> (Phase -> Maybe ModLocation -> IO FilePath)
570                         -- how to calculate the output filename
571          -> Maybe ModLocation           -- the ModLocation, if we have one
572          -> IO (Phase,                  -- next phase
573                 DynFlags,               -- new dynamic flags
574                 Maybe ModLocation,      -- the ModLocation, if we have one
575                 FilePath)               -- output filename
576
577         -- Invariant: the output filename always contains the output
578         -- Interesting case: Hsc when there is no recompilation to do
579         --                   Then the output filename is still a .o file 
580
581 -------------------------------------------------------------------------------
582 -- Unlit phase 
583
584 runPhase (Unlit sf) _stop dflags _basename _suff input_fn get_output_fn maybe_loc
585   = do let unlit_flags = getOpts dflags opt_L
586        -- The -h option passes the file name for unlit to put in a #line directive
587        output_fn <- get_output_fn (Cpp sf) maybe_loc
588
589        SysTools.runUnlit dflags 
590                 (map SysTools.Option unlit_flags ++
591                           [ SysTools.Option     "-h"
592                           , SysTools.Option     input_fn
593                           , SysTools.FileOption "" input_fn
594                           , SysTools.FileOption "" output_fn
595                           ])
596
597        return (Cpp sf, dflags, maybe_loc, output_fn)
598
599 -------------------------------------------------------------------------------
600 -- Cpp phase : (a) gets OPTIONS out of file
601 --             (b) runs cpp if necessary
602
603 runPhase (Cpp sf) _stop dflags0 basename suff input_fn get_output_fn maybe_loc
604   = do src_opts <- getOptionsFromSource input_fn
605        (dflags,unhandled_flags) <- parseDynamicFlags dflags0 src_opts
606        checkProcessArgsResult unhandled_flags (basename `joinFileExt` suff)
607
608        if not (dopt Opt_Cpp dflags) then
609            -- no need to preprocess CPP, just pass input file along
610            -- to the next phase of the pipeline.
611           return (HsPp sf, dflags, maybe_loc, input_fn)
612         else do
613             output_fn <- get_output_fn (HsPp sf) maybe_loc
614             doCpp dflags True{-raw-} False{-no CC opts-} input_fn output_fn
615             return (HsPp sf, dflags, maybe_loc, output_fn)
616
617 -------------------------------------------------------------------------------
618 -- HsPp phase 
619
620 runPhase (HsPp sf) _stop dflags basename suff input_fn get_output_fn maybe_loc
621   = do if not (dopt Opt_Pp dflags) then
622            -- no need to preprocess, just pass input file along
623            -- to the next phase of the pipeline.
624           return (Hsc sf, dflags, maybe_loc, input_fn)
625         else do
626             let hspp_opts = getOpts dflags opt_F
627             let orig_fn = basename `joinFileExt` suff
628             output_fn <- get_output_fn (Hsc sf) maybe_loc
629             SysTools.runPp dflags
630                            ( [ SysTools.Option     orig_fn
631                              , SysTools.Option     input_fn
632                              , SysTools.FileOption "" output_fn
633                              ] ++
634                              map SysTools.Option hspp_opts
635                            )
636             return (Hsc sf, dflags, maybe_loc, output_fn)
637
638 -----------------------------------------------------------------------------
639 -- Hsc phase
640
641 -- Compilation of a single module, in "legacy" mode (_not_ under
642 -- the direction of the compilation manager).
643 runPhase (Hsc src_flavour) stop dflags0 basename suff input_fn get_output_fn _maybe_loc 
644  = do   -- normal Hsc mode, not mkdependHS
645
646   -- we add the current directory (i.e. the directory in which
647   -- the .hs files resides) to the import path, since this is
648   -- what gcc does, and it's probably what you want.
649         let current_dir = directoryOf basename
650         
651             paths = includePaths dflags0
652             dflags = dflags0 { includePaths = current_dir : paths }
653         
654   -- gather the imports and module name
655         (hspp_buf,mod_name) <- 
656             case src_flavour of
657                 ExtCoreFile -> do {  -- no explicit imports in ExtCore input.
658                                   ; m <- getCoreModuleName input_fn
659                                   ; return (Nothing, mkModule m) }
660
661                 other -> do { buf <- hGetStringBuffer input_fn
662                             ; (_,_,L _ mod_name) <- getImports dflags buf input_fn
663                             ; return (Just buf, mod_name) }
664
665   -- Build a ModLocation to pass to hscMain.
666   -- The source filename is rather irrelevant by now, but it's used
667   -- by hscMain for messages.  hscMain also needs 
668   -- the .hi and .o filenames, and this is as good a way
669   -- as any to generate them, and better than most. (e.g. takes 
670   -- into accout the -osuf flags)
671         location1 <- mkHomeModLocation2 dflags mod_name basename suff
672
673   -- Boot-ify it if necessary
674         let location2 | isHsBoot src_flavour = addBootSuffixLocn location1
675                       | otherwise            = location1 
676                                         
677
678   -- Take -ohi into account if present
679   -- This can't be done in mkHomeModuleLocation because
680   -- it only applies to the module being compiles
681         let ohi = outputHi dflags
682             location3 | Just fn <- ohi = location2{ ml_hi_file = fn }
683                       | otherwise      = location2
684
685   -- Take -o into account if present
686   -- Very like -ohi, but we must *only* do this if we aren't linking
687   -- (If we're linking then the -o applies to the linked thing, not to
688   -- the object file for one module.)
689   -- Note the nasty duplication with the same computation in compileFile above
690         let expl_o_file = outputFile dflags
691             location4 | Just ofile <- expl_o_file
692                       , isNoLink (ghcLink dflags)
693                       = location3 { ml_obj_file = ofile }
694                       | otherwise = location3
695
696   -- Make the ModSummary to hand to hscMain
697         src_timestamp <- getModificationTime (basename `joinFileExt` suff)
698         let
699             unused_field = panic "runPhase:ModSummary field"
700                 -- Some fields are not looked at by hscMain
701             mod_summary = ModSummary {  ms_mod       = mod_name, 
702                                         ms_hsc_src   = src_flavour,
703                                         ms_hspp_file = Just input_fn,
704                                         ms_hspp_buf  = hspp_buf,
705                                         ms_location  = location4,
706                                         ms_hs_date   = src_timestamp,
707                                         ms_obj_date  = Nothing,
708                                         ms_imps      = unused_field,
709                                         ms_srcimps   = unused_field }
710
711             o_file = ml_obj_file location4      -- The real object file
712
713
714   -- Figure out if the source has changed, for recompilation avoidance.
715   --
716   -- Setting source_unchanged to True means that M.o seems
717   -- to be up to date wrt M.hs; so no need to recompile unless imports have
718   -- changed (which the compiler itself figures out).
719   -- Setting source_unchanged to False tells the compiler that M.o is out of
720   -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
721         let do_recomp = dopt Opt_RecompChecking dflags
722         source_unchanged <- 
723           if not do_recomp || not (isStopLn stop)
724                 -- Set source_unchanged to False unconditionally if
725                 --      (a) recompilation checker is off, or
726                 --      (b) we aren't going all the way to .o file (e.g. ghc -S)
727              then return False  
728                 -- Otherwise look at file modification dates
729              else do o_file_exists <- doesFileExist o_file
730                      if not o_file_exists
731                         then return False       -- Need to recompile
732                         else do t2 <- getModificationTime o_file
733                                 if t2 > src_timestamp
734                                   then return True
735                                   else return False
736
737   -- get the DynFlags
738         let hsc_lang = hscMaybeAdjustTarget dflags stop src_flavour (hscTarget dflags)
739         let next_phase = hscNextPhase dflags src_flavour hsc_lang
740         output_fn  <- get_output_fn next_phase (Just location4)
741
742         let dflags' = dflags { hscTarget = hsc_lang,
743                                hscOutName = output_fn,
744                                hscStubCOutName = basename ++ "_stub.c",
745                                hscStubHOutName = basename ++ "_stub.h",
746                                extCoreName = basename ++ ".hcr" }
747
748         hsc_env <- newHscEnv dflags'
749
750   -- Tell the finder cache about this module
751         addHomeModuleToFinder hsc_env mod_name location4
752
753   -- run the compiler!
754         result <- hscMain hsc_env printErrorsAndWarnings
755                           mod_summary source_unchanged 
756                           False         -- No object file
757                           Nothing       -- No iface
758                           Nothing       -- No "module i of n" progress info
759
760         case result of
761
762             HscFail -> throwDyn (PhaseFailed "hsc" (ExitFailure 1))
763
764             HscNoRecomp details iface -> do
765                 SysTools.touch dflags' "Touching object file" o_file
766                         -- The .o file must have a later modification date
767                         -- than the source file (else we wouldn't be in HscNoRecomp)
768                         -- but we touch it anyway, to keep 'make' happy (we think).
769                 return (StopLn, dflags', Just location4, o_file)
770
771             HscRecomp _details _iface 
772                       stub_h_exists stub_c_exists
773                       _maybe_interpreted_code -> do
774
775                 when stub_c_exists $ do
776                         stub_o <- compileStub dflags' o_file
777                         consIORef v_Ld_inputs stub_o
778
779                 -- In the case of hs-boot files, generate a dummy .o-boot 
780                 -- stamp file for the benefit of Make
781                 case src_flavour of
782                   HsBootFile -> SysTools.touch dflags' "Touching object file" o_file
783                   other      -> return ()
784
785                 return (next_phase, dflags', Just location4, output_fn)
786
787 -----------------------------------------------------------------------------
788 -- Cmm phase
789
790 runPhase CmmCpp stop dflags basename suff input_fn get_output_fn maybe_loc
791   = do
792        output_fn <- get_output_fn Cmm maybe_loc
793        doCpp dflags False{-not raw-} True{-include CC opts-} input_fn output_fn 
794        return (Cmm, dflags, maybe_loc, output_fn)
795
796 runPhase Cmm stop dflags basename suff input_fn get_output_fn maybe_loc
797   = do
798         let hsc_lang = hscMaybeAdjustTarget dflags stop HsSrcFile (hscTarget dflags)
799         let next_phase = hscNextPhase dflags HsSrcFile hsc_lang
800         output_fn <- get_output_fn next_phase maybe_loc
801
802         let dflags' = dflags { hscTarget = hsc_lang,
803                                hscOutName = output_fn,
804                                hscStubCOutName = basename ++ "_stub.c",
805                                hscStubHOutName = basename ++ "_stub.h",
806                                extCoreName = basename ++ ".hcr" }
807
808         ok <- hscCmmFile dflags' input_fn
809
810         when (not ok) $ throwDyn (PhaseFailed "cmm" (ExitFailure 1))
811
812         return (next_phase, dflags, maybe_loc, output_fn)
813
814 -----------------------------------------------------------------------------
815 -- Cc phase
816
817 -- we don't support preprocessing .c files (with -E) now.  Doing so introduces
818 -- way too many hacks, and I can't say I've ever used it anyway.
819
820 runPhase cc_phase stop dflags basename suff input_fn get_output_fn maybe_loc
821    | cc_phase `eqPhase` Cc || cc_phase `eqPhase` HCc
822    = do let cc_opts = getOpts dflags opt_c
823             hcc = cc_phase `eqPhase` HCc
824
825         let cmdline_include_paths = includePaths dflags
826
827         -- HC files have the dependent packages stamped into them
828         pkgs <- if hcc then getHCFilePackages input_fn else return []
829
830         -- add package include paths even if we're just compiling .c
831         -- files; this is the Value Add(TM) that using ghc instead of
832         -- gcc gives you :)
833         pkg_include_dirs <- getPackageIncludePath dflags pkgs
834         let include_paths = foldr (\ x xs -> "-I" : x : xs) []
835                               (cmdline_include_paths ++ pkg_include_dirs)
836
837         let (md_c_flags, md_regd_c_flags) = machdepCCOpts dflags
838         let pic_c_flags = picCCOpts dflags
839
840         let verb = getVerbFlag dflags
841
842         pkg_extra_cc_opts <- getPackageExtraCcOpts dflags pkgs
843
844         let split_objs = dopt Opt_SplitObjs dflags
845             split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
846                       | otherwise         = [ ]
847
848         let excessPrecision = dopt Opt_ExcessPrecision dflags
849
850         -- Decide next phase
851         
852         let mangle = dopt Opt_DoAsmMangling dflags
853             next_phase
854                 | hcc && mangle     = Mangle
855                 | otherwise         = As
856         output_fn <- get_output_fn next_phase maybe_loc
857
858         SysTools.runCc dflags (
859                 -- force the C compiler to interpret this file as C when
860                 -- compiling .hc files, by adding the -x c option.
861                 -- Also useful for plain .c files, just in case GHC saw a 
862                 -- -x c option.
863                         [ SysTools.Option "-x", SysTools.Option "c"] ++
864                         [ SysTools.FileOption "" input_fn
865                         , SysTools.Option "-o"
866                         , SysTools.FileOption "" output_fn
867                         ]
868                        ++ map SysTools.Option (
869                           md_c_flags
870                        ++ pic_c_flags
871                        ++ (if hcc && mangle
872                              then md_regd_c_flags
873                              else [])
874                        ++ [ verb, "-S", "-Wimplicit", "-O" ]
875                        ++ [ "-D__GLASGOW_HASKELL__="++cProjectVersionInt ]
876                        ++ cc_opts
877                        ++ split_opt
878                        ++ (if excessPrecision then [] else [ "-ffloat-store" ])
879                        ++ include_paths
880                        ++ pkg_extra_cc_opts
881                        ))
882
883         return (next_phase, dflags, maybe_loc, output_fn)
884
885         -- ToDo: postprocess the output from gcc
886
887 -----------------------------------------------------------------------------
888 -- Mangle phase
889
890 runPhase Mangle stop dflags _basename _suff input_fn get_output_fn maybe_loc
891    = do let mangler_opts = getOpts dflags opt_m
892
893 #if i386_TARGET_ARCH
894         machdep_opts <- return [ show (stolen_x86_regs dflags) ]
895 #else
896         machdep_opts <- return []
897 #endif
898
899         let split = dopt Opt_SplitObjs dflags
900             next_phase
901                 | split = SplitMangle
902                 | otherwise = As
903         output_fn <- get_output_fn next_phase maybe_loc
904
905         SysTools.runMangle dflags (map SysTools.Option mangler_opts
906                           ++ [ SysTools.FileOption "" input_fn
907                              , SysTools.FileOption "" output_fn
908                              ]
909                           ++ map SysTools.Option machdep_opts)
910
911         return (next_phase, dflags, maybe_loc, output_fn)
912
913 -----------------------------------------------------------------------------
914 -- Splitting phase
915
916 runPhase SplitMangle stop dflags _basename _suff input_fn get_output_fn maybe_loc
917   = do  -- tmp_pfx is the prefix used for the split .s files
918         -- We also use it as the file to contain the no. of split .s files (sigh)
919         split_s_prefix <- SysTools.newTempName dflags "split"
920         let n_files_fn = split_s_prefix
921
922         SysTools.runSplit dflags
923                           [ SysTools.FileOption "" input_fn
924                           , SysTools.FileOption "" split_s_prefix
925                           , SysTools.FileOption "" n_files_fn
926                           ]
927
928         -- Save the number of split files for future references
929         s <- readFile n_files_fn
930         let n_files = read s :: Int
931         writeIORef v_Split_info (split_s_prefix, n_files)
932
933         -- Remember to delete all these files
934         addFilesToClean [ split_s_prefix ++ "__" ++ show n ++ ".s"
935                         | n <- [1..n_files]]
936
937         return (SplitAs, dflags, maybe_loc, "**splitmangle**")
938           -- we don't use the filename
939
940 -----------------------------------------------------------------------------
941 -- As phase
942
943 runPhase As stop dflags _basename _suff input_fn get_output_fn maybe_loc
944   = do  let as_opts =  getOpts dflags opt_a
945         let cmdline_include_paths = includePaths dflags
946
947         output_fn <- get_output_fn StopLn maybe_loc
948
949         -- we create directories for the object file, because it
950         -- might be a hierarchical module.
951         createDirectoryHierarchy (directoryOf output_fn)
952
953         SysTools.runAs dflags   
954                        (map SysTools.Option as_opts
955                        ++ [ SysTools.Option ("-I" ++ p) | p <- cmdline_include_paths ]
956                        ++ [ SysTools.Option "-c"
957                           , SysTools.FileOption "" input_fn
958                           , SysTools.Option "-o"
959                           , SysTools.FileOption "" output_fn
960                           ])
961
962         return (StopLn, dflags, maybe_loc, output_fn)
963
964
965 runPhase SplitAs stop dflags basename _suff _input_fn get_output_fn maybe_loc
966   = do  let as_opts = getOpts dflags opt_a
967
968         (split_s_prefix, n) <- readIORef v_Split_info
969
970         let real_odir
971                 | Just d <- outputDir dflags = d
972                 | otherwise                  = basename ++ "_split"
973
974         let assemble_file n
975               = do  let input_s  = split_s_prefix ++ "__" ++ show n ++ ".s"
976                     let output_o = replaceFilenameDirectory
977                                         (basename ++ "__" ++ show n ++ ".o")
978                                          real_odir
979                     let osuf = objectSuf dflags
980                     let real_o = replaceFilenameSuffix output_o osuf
981                     SysTools.runAs dflags
982                                  (map SysTools.Option as_opts ++
983                                     [ SysTools.Option "-c"
984                                     , SysTools.Option "-o"
985                                     , SysTools.FileOption "" real_o
986                                     , SysTools.FileOption "" input_s
987                                     ])
988         
989         mapM_ assemble_file [1..n]
990
991         output_fn <- get_output_fn StopLn maybe_loc
992         return (StopLn, dflags, maybe_loc, output_fn)
993
994 -----------------------------------------------------------------------------
995 -- MoveBinary sort-of-phase
996 -- After having produced a binary, move it somewhere else and generate a
997 -- wrapper script calling the binary. Currently, we need this only in 
998 -- a parallel way (i.e. in GUM), because PVM expects the binary in a
999 -- central directory.
1000 -- This is called from staticLink below, after linking. I haven't made it
1001 -- a separate phase to minimise interfering with other modules, and
1002 -- we don't need the generality of a phase (MoveBinary is always
1003 -- done after linking and makes only sense in a parallel setup)   -- HWL
1004
1005 runPhase_MoveBinary input_fn
1006   = do  
1007         sysMan   <- getSysMan
1008         pvm_root <- getEnv "PVM_ROOT"
1009         pvm_arch <- getEnv "PVM_ARCH"
1010         let 
1011            pvm_executable_base = "=" ++ input_fn
1012            pvm_executable = pvm_root ++ "/bin/" ++ pvm_arch ++ "/" ++ pvm_executable_base
1013         -- nuke old binary; maybe use configur'ed names for cp and rm?
1014         system ("rm -f " ++ pvm_executable)
1015         -- move the newly created binary into PVM land
1016         system ("cp -p " ++ input_fn ++ " " ++ pvm_executable)
1017         -- generate a wrapper script for running a parallel prg under PVM
1018         writeFile input_fn (mk_pvm_wrapper_script pvm_executable pvm_executable_base sysMan)
1019         return True
1020
1021 -- generates a Perl skript starting a parallel prg under PVM
1022 mk_pvm_wrapper_script :: String -> String -> String -> String
1023 mk_pvm_wrapper_script pvm_executable pvm_executable_base sysMan = unlines $
1024  [
1025   "eval 'exec perl -S $0 ${1+\"$@\"}'", 
1026   "  if $running_under_some_shell;",
1027   "# =!=!=!=!=!=!=!=!=!=!=!",
1028   "# This script is automatically generated: DO NOT EDIT!!!",
1029   "# Generated by Glasgow Haskell Compiler",
1030   "# ngoqvam choHbogh vaj' vIHoHnISbej !!!!",
1031   "#",
1032   "$pvm_executable      = '" ++ pvm_executable ++ "';",
1033   "$pvm_executable_base = '" ++ pvm_executable_base ++ "';",
1034   "$SysMan = '" ++ sysMan ++ "';",
1035   "",
1036   {- ToDo: add the magical shortcuts again iff we actually use them -- HWL
1037   "# first, some magical shortcuts to run "commands" on the binary",
1038   "# (which is hidden)",
1039   "if ($#ARGV == 1 && $ARGV[0] eq '+RTS' && $ARGV[1] =~ /^--((size|file|strip|rm|nm).*)/ ) {",
1040   "    local($cmd) = $1;",
1041   "    system("$cmd $pvm_executable");",
1042   "    exit(0); # all done",
1043   "}", -}
1044   "",
1045   "# Now, run the real binary; process the args first",
1046   "$ENV{'PE'} = $pvm_executable_base;", --  ++ pvm_executable_base,
1047   "$debug = '';",
1048   "$nprocessors = 0; # the default: as many PEs as machines in PVM config",
1049   "@nonPVM_args = ();",
1050   "$in_RTS_args = 0;",
1051   "",
1052   "args: while ($a = shift(@ARGV)) {",
1053   "    if ( $a eq '+RTS' ) {",
1054   "     $in_RTS_args = 1;",
1055   "    } elsif ( $a eq '-RTS' ) {",
1056   "     $in_RTS_args = 0;",
1057   "    }",
1058   "    if ( $a eq '-d' && $in_RTS_args ) {",
1059   "     $debug = '-';",
1060   "    } elsif ( $a =~ /^-qN(\\d+)/ && $in_RTS_args ) {",
1061   "     $nprocessors = $1;",
1062   "    } elsif ( $a =~ /^-qp(\\d+)/ && $in_RTS_args ) {",
1063   "     $nprocessors = $1;",
1064   "    } else {",
1065   "     push(@nonPVM_args, $a);",
1066   "    }",
1067   "}",
1068   "",
1069   "local($return_val) = 0;",
1070   "# Start the parallel execution by calling SysMan",
1071   "system(\"$SysMan $debug $pvm_executable $nprocessors @nonPVM_args\");",
1072   "$return_val = $?;",
1073   "# ToDo: fix race condition moving files and flushing them!!",
1074   "system(\"cp $ENV{'HOME'}/$pvm_executable_base.???.gr .\") if -f \"$ENV{'HOME'}/$pvm_executable_base.002.gr\";",
1075   "exit($return_val);"
1076  ]
1077
1078 -----------------------------------------------------------------------------
1079 -- Complain about non-dynamic flags in OPTIONS pragmas
1080
1081 checkProcessArgsResult flags filename
1082   = do when (notNull flags) (throwDyn (ProgramError (
1083           showSDoc (hang (text filename <> char ':')
1084                       4 (text "unknown flags in  {-# OPTIONS #-} pragma:" <+>
1085                           hsep (map text flags)))
1086         )))
1087
1088 -----------------------------------------------------------------------------
1089 -- Look for the /* GHC_PACKAGES ... */ comment at the top of a .hc file
1090
1091 getHCFilePackages :: FilePath -> IO [PackageId]
1092 getHCFilePackages filename =
1093   EXCEPTION.bracket (openFile filename ReadMode) hClose $ \h -> do
1094     l <- hGetLine h
1095     case l of
1096       '/':'*':' ':'G':'H':'C':'_':'P':'A':'C':'K':'A':'G':'E':'S':rest ->
1097           return (map stringToPackageId (words rest))
1098       _other ->
1099           return []
1100
1101 -----------------------------------------------------------------------------
1102 -- Static linking, of .o files
1103
1104 -- The list of packages passed to link is the list of packages on
1105 -- which this program depends, as discovered by the compilation
1106 -- manager.  It is combined with the list of packages that the user
1107 -- specifies on the command line with -package flags.  
1108 --
1109 -- In one-shot linking mode, we can't discover the package
1110 -- dependencies (because we haven't actually done any compilation or
1111 -- read any interface files), so the user must explicitly specify all
1112 -- the packages.
1113
1114 staticLink :: DynFlags -> [FilePath] -> [PackageId] -> IO ()
1115 staticLink dflags o_files dep_packages = do
1116     let verb = getVerbFlag dflags
1117         output_fn = exeFileName dflags
1118
1119     -- get the full list of packages to link with, by combining the
1120     -- explicit packages with the auto packages and all of their
1121     -- dependencies, and eliminating duplicates.
1122
1123     pkg_lib_paths <- getPackageLibraryPath dflags dep_packages
1124     let pkg_lib_path_opts = map ("-L"++) pkg_lib_paths
1125
1126     let lib_paths = libraryPaths dflags
1127     let lib_path_opts = map ("-L"++) lib_paths
1128
1129     pkg_link_opts <- getPackageLinkOpts dflags dep_packages
1130
1131 #ifdef darwin_TARGET_OS
1132     pkg_framework_paths <- getPackageFrameworkPath dflags dep_packages
1133     let pkg_framework_path_opts = map ("-F"++) pkg_framework_paths
1134
1135     let framework_paths = frameworkPaths dflags
1136         framework_path_opts = map ("-F"++) framework_paths
1137
1138     pkg_frameworks <- getPackageFrameworks dflags dep_packages
1139     let pkg_framework_opts = concat [ ["-framework", fw] | fw <- pkg_frameworks ]
1140     
1141     let frameworks = cmdlineFrameworks dflags
1142         framework_opts = concat [ ["-framework", fw] | fw <- reverse frameworks ]
1143          -- reverse because they're added in reverse order from the cmd line
1144 #endif
1145
1146         -- probably _stub.o files
1147     extra_ld_inputs <- readIORef v_Ld_inputs
1148
1149         -- opts from -optl-<blah> (including -l<blah> options)
1150     let extra_ld_opts = getOpts dflags opt_l
1151
1152     let ways = wayNames dflags
1153
1154     -- Here are some libs that need to be linked at the *end* of
1155     -- the command line, because they contain symbols that are referred to
1156     -- by the RTS.  We can't therefore use the ordinary way opts for these.
1157     let
1158         debug_opts | WayDebug `elem` ways = [ 
1159 #if defined(HAVE_LIBBFD)
1160                         "-lbfd", "-liberty"
1161 #endif
1162                          ]
1163                    | otherwise            = []
1164
1165     let
1166         thread_opts | WayThreaded `elem` ways = [ 
1167 #if !defined(mingw32_TARGET_OS) && !defined(freebsd_TARGET_OS)
1168                         "-lpthread"
1169 #endif
1170 #if defined(osf3_TARGET_OS)
1171                         , "-lexc"
1172 #endif
1173                         ]
1174                     | otherwise               = []
1175
1176     let (md_c_flags, _) = machdepCCOpts dflags
1177     SysTools.runLink dflags ( 
1178                        [ SysTools.Option verb
1179                        , SysTools.Option "-o"
1180                        , SysTools.FileOption "" output_fn
1181                        ]
1182                       ++ map SysTools.Option (
1183                          md_c_flags
1184                       ++ o_files
1185                       ++ extra_ld_inputs
1186                       ++ lib_path_opts
1187                       ++ extra_ld_opts
1188 #ifdef darwin_TARGET_OS
1189                       ++ framework_path_opts
1190                       ++ framework_opts
1191 #endif
1192                       ++ pkg_lib_path_opts
1193                       ++ pkg_link_opts
1194 #ifdef darwin_TARGET_OS
1195                       ++ pkg_framework_path_opts
1196                       ++ pkg_framework_opts
1197 #endif
1198                       ++ debug_opts
1199                       ++ thread_opts
1200                     ))
1201
1202     -- parallel only: move binary to another dir -- HWL
1203     when (WayPar `elem` ways)
1204          (do success <- runPhase_MoveBinary output_fn
1205              if success then return ()
1206                         else throwDyn (InstallationError ("cannot move binary to PVM dir")))
1207
1208
1209 exeFileName :: DynFlags -> FilePath
1210 exeFileName dflags
1211   | Just s <- outputFile dflags = s
1212   | otherwise = 
1213 #if defined(mingw32_HOST_OS)
1214         "main.exe"
1215 #else
1216         "a.out"
1217 #endif
1218
1219 -----------------------------------------------------------------------------
1220 -- Making a DLL (only for Win32)
1221
1222 doMkDLL :: DynFlags -> [String] -> [PackageId] -> IO ()
1223 doMkDLL dflags o_files dep_packages = do
1224     let verb = getVerbFlag dflags
1225     let static = opt_Static
1226     let no_hs_main = dopt Opt_NoHsMain dflags
1227     let o_file = outputFile dflags
1228     let output_fn = case o_file of { Just s -> s; Nothing -> "HSdll.dll"; }
1229
1230     pkg_lib_paths <- getPackageLibraryPath dflags dep_packages
1231     let pkg_lib_path_opts = map ("-L"++) pkg_lib_paths
1232
1233     let lib_paths = libraryPaths dflags
1234     let lib_path_opts = map ("-L"++) lib_paths
1235
1236     pkg_link_opts <- getPackageLinkOpts dflags dep_packages
1237
1238         -- probably _stub.o files
1239     extra_ld_inputs <- readIORef v_Ld_inputs
1240
1241         -- opts from -optdll-<blah>
1242     let extra_ld_opts = getOpts dflags opt_dll 
1243
1244     let pstate = pkgState dflags
1245         rts_id | ExtPackage id <- rtsPackageId pstate = id
1246                | otherwise = panic "staticLink: rts package missing"
1247         base_id | ExtPackage id <- basePackageId pstate = id
1248                 | otherwise = panic "staticLink: base package missing"
1249         rts_pkg  = getPackageDetails pstate rts_id
1250         base_pkg = getPackageDetails pstate base_id
1251
1252     let extra_os = if static || no_hs_main
1253                    then []
1254                    else [ head (libraryDirs rts_pkg) ++ "/Main.dll_o",
1255                           head (libraryDirs base_pkg) ++ "/PrelMain.dll_o" ]
1256
1257     let (md_c_flags, _) = machdepCCOpts dflags
1258     SysTools.runMkDLL dflags
1259          ([ SysTools.Option verb
1260           , SysTools.Option "-o"
1261           , SysTools.FileOption "" output_fn
1262           ]
1263          ++ map SysTools.Option (
1264             md_c_flags
1265          ++ o_files
1266          ++ extra_os
1267          ++ [ "--target=i386-mingw32" ]
1268          ++ extra_ld_inputs
1269          ++ lib_path_opts
1270          ++ extra_ld_opts
1271          ++ pkg_lib_path_opts
1272          ++ pkg_link_opts
1273          ++ (if "--def" `elem` (concatMap words extra_ld_opts)
1274                then [ "" ]
1275                else [ "--export-all" ])
1276         ))
1277
1278 -- -----------------------------------------------------------------------------
1279 -- Running CPP
1280
1281 doCpp :: DynFlags -> Bool -> Bool -> FilePath -> FilePath -> IO ()
1282 doCpp dflags raw include_cc_opts input_fn output_fn = do
1283     let hscpp_opts = getOpts dflags opt_P
1284     let cmdline_include_paths = includePaths dflags
1285
1286     pkg_include_dirs <- getPackageIncludePath dflags []
1287     let include_paths = foldr (\ x xs -> "-I" : x : xs) []
1288                           (cmdline_include_paths ++ pkg_include_dirs)
1289
1290     let verb = getVerbFlag dflags
1291
1292     let cc_opts
1293           | not include_cc_opts = []
1294           | otherwise           = (optc ++ md_c_flags)
1295                 where 
1296                       optc = getOpts dflags opt_c
1297                       (md_c_flags, _) = machdepCCOpts dflags
1298
1299     let cpp_prog args | raw       = SysTools.runCpp dflags args
1300                       | otherwise = SysTools.runCc dflags (SysTools.Option "-E" : args)
1301
1302     let target_defs = 
1303           [ "-D" ++ HOST_OS     ++ "_BUILD_OS=1",
1304             "-D" ++ HOST_ARCH   ++ "_BUILD_ARCH=1",
1305             "-D" ++ TARGET_OS   ++ "_HOST_OS=1",
1306             "-D" ++ TARGET_ARCH ++ "_HOST_ARCH=1" ]
1307         -- remember, in code we *compile*, the HOST is the same our TARGET,
1308         -- and BUILD is the same as our HOST.
1309
1310     cpp_prog       ([SysTools.Option verb]
1311                     ++ map SysTools.Option include_paths
1312                     ++ map SysTools.Option hsSourceCppOpts
1313                     ++ map SysTools.Option hscpp_opts
1314                     ++ map SysTools.Option cc_opts
1315                     ++ map SysTools.Option target_defs
1316                     ++ [ SysTools.Option     "-x"
1317                        , SysTools.Option     "c"
1318                        , SysTools.Option     input_fn
1319         -- We hackily use Option instead of FileOption here, so that the file
1320         -- name is not back-slashed on Windows.  cpp is capable of
1321         -- dealing with / in filenames, so it works fine.  Furthermore
1322         -- if we put in backslashes, cpp outputs #line directives
1323         -- with *double* backslashes.   And that in turn means that
1324         -- our error messages get double backslashes in them.
1325         -- In due course we should arrange that the lexer deals
1326         -- with these \\ escapes properly.
1327                        , SysTools.Option     "-o"
1328                        , SysTools.FileOption "" output_fn
1329                        ])
1330
1331 cHaskell1Version = "5" -- i.e., Haskell 98
1332
1333 -- Default CPP defines in Haskell source
1334 hsSourceCppOpts =
1335         [ "-D__HASKELL1__="++cHaskell1Version
1336         , "-D__GLASGOW_HASKELL__="++cProjectVersionInt                          
1337         , "-D__HASKELL98__"
1338         , "-D__CONCURRENT_HASKELL__"
1339         ]
1340
1341 -----------------------------------------------------------------------------
1342 -- Reading OPTIONS pragmas
1343
1344 getOptionsFromSource 
1345         :: String               -- input file
1346         -> IO [String]          -- options, if any
1347 getOptionsFromSource file
1348   = do h <- openFile file ReadMode
1349        look h `finally` hClose h
1350   where
1351         look h = do
1352             r <- tryJust ioErrors (hGetLine h)
1353             case r of
1354               Left e | isEOFError e -> return []
1355                      | otherwise    -> ioError e
1356               Right l' -> do
1357                 let l = removeSpaces l'
1358                 case () of
1359                     () | null l -> look h
1360                        | prefixMatch "#" l -> look h
1361                        | prefixMatch "{-# LINE" l -> look h   -- -}
1362                        | Just opts <- matchOptions l
1363                         -> do rest <- look h
1364                               return (opts ++ rest)
1365                        | otherwise -> return []
1366
1367 getOptionsFromStringBuffer :: StringBuffer -> [(Int,String)]
1368 getOptionsFromStringBuffer buffer@(StringBuffer _ len# _) = 
1369   let 
1370         ls = lines (lexemeToString buffer (I# len#))  -- lazy, so it's ok
1371   in
1372   look 1 ls
1373   where
1374         look i [] = []
1375         look i (l':ls) = do
1376             let l = removeSpaces l'
1377             case () of
1378                 () | null l -> look (i+1) ls
1379                    | prefixMatch "#" l -> look (i+1) ls
1380                    | prefixMatch "{-# LINE" l -> look (i+1) ls   -- -}
1381                    | Just opts <- matchOptions l
1382                         -> zip (repeat i) opts ++ look (i+1) ls
1383                    | otherwise -> []
1384
1385 -- detect {-# OPTIONS_GHC ... #-}.  For the time being, we accept OPTIONS
1386 -- instead of OPTIONS_GHC, but that is deprecated.
1387 matchOptions s
1388   | Just s1 <- maybePrefixMatch "{-#" s -- -} 
1389   = matchOptions1 (removeSpaces s1)
1390   | otherwise
1391   = Nothing
1392  where
1393   matchOptions1 s
1394     | Just s2 <- maybePrefixMatch "OPTIONS" s
1395     = case () of
1396         _ | Just s3 <- maybePrefixMatch "_GHC" s2, not (is_ident (head s3))
1397           -> matchOptions2 s3
1398           | not (is_ident (head s2))
1399           -> matchOptions2 s2
1400           | otherwise
1401           -> Just []  -- OPTIONS_anything is ignored, not treated as start of source
1402     | Just s2 <- maybePrefixMatch "INCLUDE" s, not (is_ident (head s2)),
1403       Just s3 <- maybePrefixMatch "}-#" (reverse s2)
1404     = Just ["-#include", removeSpaces (reverse s3)]
1405     | otherwise = Nothing
1406   matchOptions2 s
1407     | Just s3 <- maybePrefixMatch "}-#" (reverse s) = Just (words (reverse s3))
1408     | otherwise = Nothing
1409
1410
1411 optionsErrorMsgs :: [String] -> [(Int,String)] -> FilePath -> Messages
1412 optionsErrorMsgs unhandled_flags flags_lines filename
1413   = (emptyBag, listToBag (map mkMsg unhandled_flags_lines))
1414   where
1415         unhandled_flags_lines = [ (l,f) | f <- unhandled_flags, 
1416                                           (l,f') <- flags_lines, f == f' ]
1417         mkMsg (line,flag) = 
1418             ErrUtils.mkPlainErrMsg (srcLocSpan loc) $
1419                 text "unknown flag in  {-# OPTIONS #-} pragma:" <+> text flag
1420           where
1421                 loc = mkSrcLoc (mkFastString filename) line 0
1422                 -- ToDo: we need a better SrcSpan here
1423
1424 -- -----------------------------------------------------------------------------
1425 -- Misc.
1426
1427 hscNextPhase :: DynFlags -> HscSource -> HscTarget -> Phase
1428 hscNextPhase dflags HsBootFile hsc_lang  =  StopLn
1429 hscNextPhase dflags other hsc_lang = 
1430   case hsc_lang of
1431         HscC -> HCc
1432         HscAsm | dopt Opt_SplitObjs dflags -> SplitMangle
1433                | otherwise -> As
1434         HscNothing     -> StopLn
1435         HscInterpreted -> StopLn
1436         _other         -> StopLn
1437
1438
1439 hscMaybeAdjustTarget :: DynFlags -> Phase -> HscSource -> HscTarget -> HscTarget
1440 hscMaybeAdjustTarget dflags stop HsBootFile current_hsc_lang 
1441   = HscNothing          -- No output (other than Foo.hi-boot) for hs-boot files
1442 hscMaybeAdjustTarget dflags stop other current_hsc_lang 
1443   = hsc_lang 
1444   where
1445         keep_hc = dopt Opt_KeepHcFiles dflags
1446         hsc_lang
1447                 -- don't change the lang if we're interpreting
1448                  | current_hsc_lang == HscInterpreted = current_hsc_lang
1449
1450                 -- force -fvia-C if we are being asked for a .hc file
1451                  | HCc <- stop = HscC
1452                  | keep_hc     = HscC
1453                 -- otherwise, stick to the plan
1454                  | otherwise = current_hsc_lang
1455
1456 GLOBAL_VAR(v_Split_info, ("",0), (String,Int))
1457         -- The split prefix and number of files