ghc/compiler/main/DriverPipeline.hs

   1 -----------------------------------------------------------------------------
   2 --
   3 -- GHC Driver
   4 --
   5 -- (c) The University of Glasgow 2002
   6 --
   7 -----------------------------------------------------------------------------
   8
   9 #include "../includes/ghcconfig.h"
  10
  11 module DriverPipeline (
  12
  13         -- Interfaces for the batch-mode driver
  14    runPipeline, staticLink,
  15
  16         -- Interfaces for the compilation manager (interpreted/batch-mode)
  17    preprocess,
  18    compile, CompResult(..),
  19    link,
  20
  21         -- DLL building
  22    doMkDLL
  23   ) where
  24
  25 #include "HsVersions.h"
  26
  27 import Packages
  28 import GetImports
  29 import DriverState
  30 import DriverUtil
  31 import DriverMkDepend
  32 import DriverPhases
  33 import DriverFlags
  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 CmdLineOpts
  43 import Config
  44 import RdrName          ( GlobalRdrEnv )
  45 import Panic
  46 import Util
  47 import BasicTypes       ( SuccessFlag(..) )
  48 import Maybes           ( expectJust )
  49
  50 import ParserCoreUtils ( getCoreModuleName )
  51
  52 import EXCEPTION
  53 import DATA_IOREF       ( readIORef, writeIORef )
  54
  55 import Time             ( ClockTime )
  56 import Directory
  57 import System
  58 import IO
  59 import Monad
  60 import Maybe
  61
  62
  63 -- ---------------------------------------------------------------------------
  64 -- Pre-process
  65
  66 -- Just preprocess a file, put the result in a temp. file (used by the
  67 -- compilation manager during the summary phase).
  68
  69 preprocess :: FilePath -> IO FilePath
  70 preprocess filename =
  71   ASSERT(isHaskellSrcFilename filename)
  72   do restoreDynFlags    -- Restore to state of last save
  73      runPipeline (StopBefore Hsc) ("preprocess")
  74         False{-temporary output file-}
  75         Nothing{-no specific output file-}
  76         filename
  77         Nothing{-no ModLocation-}
  78
  79 -- ---------------------------------------------------------------------------
  80 -- Compile
  81
  82 -- Compile a single module, under the control of the compilation manager.
  83 --
  84 -- This is the interface between the compilation manager and the
  85 -- compiler proper (hsc), where we deal with tedious details like
  86 -- reading the OPTIONS pragma from the source file, and passing the
  87 -- output of hsc through the C compiler.
  88
  89 -- The driver sits between 'compile' and 'hscMain', translating calls
  90 -- to the former into calls to the latter, and results from the latter
  91 -- into results from the former.  It does things like preprocessing
  92 -- the .hs file if necessary, and compiling up the .stub_c files to
  93 -- generate Linkables.
  94
  95 -- NB.  No old interface can also mean that the source has changed.
  96
  97 compile :: HscEnv
  98         -> Module
  99         -> ModLocation
 100         -> ClockTime               -- timestamp of original source file
 101         -> Bool                    -- True <=> source unchanged
 102         -> Bool                    -- True <=> have object
 103         -> Maybe ModIface          -- old interface, if available
 104         -> IO CompResult
 105
 106 data CompResult
 107    = CompOK   ModDetails                -- New details
 108               (Maybe GlobalRdrEnv)      -- Lexical environment for the module
 109                                         -- (Maybe because we may have loaded it from
 110                                         --  its precompiled interface)
 111               ModIface                  -- New iface
 112               (Maybe Linkable)  -- New code; Nothing => compilation was not reqd
 113                                 --                      (old code is still valid)
 114
 115    | CompErrs
 116
 117
 118 compile hsc_env this_mod location src_timestamp
 119         source_unchanged have_object
 120         old_iface = do
 121
 122    dyn_flags <- restoreDynFlags         -- Restore to the state of the last save
 123
 124    showPass dyn_flags
 125         (showSDoc (text "Compiling" <+> ppr this_mod))
 126
 127    let verb       = verbosity dyn_flags
 128    let input_fn   = expectJust "compile:hs" (ml_hs_file location)
 129    let input_fnpp = expectJust "compile:hspp" (ml_hspp_file location)
 130    let mod_name   = moduleName this_mod
 131
 132    when (verb >= 2) (hPutStrLn stderr ("compile: input file " ++ input_fnpp))
 133
 134    opts <- getOptionsFromSource input_fnpp
 135    processArgs dynamic_flags opts []
 136    dyn_flags <- getDynFlags
 137
 138    let (basename, _) = splitFilename input_fn
 139
 140    -- figure out what lang we're generating
 141    hsc_lang <- hscMaybeAdjustLang (hscLang dyn_flags)
 142    -- figure out what the next phase should be
 143    next_phase <- hscNextPhase hsc_lang
 144    -- figure out what file to generate the output into
 145    get_output_fn <- genOutputFilenameFunc False Nothing next_phase basename
 146    output_fn <- get_output_fn next_phase (Just location)
 147
 148    let dyn_flags' = dyn_flags { hscLang = hsc_lang,
 149                                 hscOutName = output_fn,
 150                                 hscStubCOutName = basename ++ "_stub.c",
 151                                 hscStubHOutName = basename ++ "_stub.h",
 152                                 extCoreName = basename ++ ".hcr" }
 153
 154    -- -no-recomp should also work with --make
 155    do_recomp <- readIORef v_Recomp
 156    let source_unchanged' = source_unchanged && do_recomp
 157        hsc_env' = hsc_env { hsc_dflags = dyn_flags' }
 158
 159    -- run the compiler
 160    hsc_result <- hscMain hsc_env' printErrorsAndWarnings this_mod location
 161                          source_unchanged' have_object old_iface
 162
 163    case hsc_result of
 164       HscFail -> return CompErrs
 165
 166       HscNoRecomp details iface -> return (CompOK details Nothing iface Nothing)
 167
 168       HscRecomp details rdr_env iface
 169         stub_h_exists stub_c_exists maybe_interpreted_code -> do
 170            let
 171            maybe_stub_o <- compileStub dyn_flags' stub_c_exists
 172            let stub_unlinked = case maybe_stub_o of
 173                                   Nothing -> []
 174                                   Just stub_o -> [ DotO stub_o ]
 175
 176            (hs_unlinked, unlinked_time) <-
 177              case hsc_lang of
 178
 179                 -- in interpreted mode, just return the compiled code
 180                 -- as our "unlinked" object.
 181                 HscInterpreted ->
 182                     case maybe_interpreted_code of
 183 #ifdef GHCI
 184                        Just comp_bc -> return ([BCOs comp_bc], src_timestamp)
 185                         -- Why do we use the timestamp of the source file here,
 186                         -- rather than the current time?  This works better in
 187                         -- the case where the local clock is out of sync
 188                         -- with the filesystem's clock.  It's just as accurate:
 189                         -- if the source is modified, then the linkable will
 190                         -- be out of date.
 191 #endif
 192                        Nothing -> panic "compile: no interpreted code"
 193
 194                 -- we're in batch mode: finish the compilation pipeline.
 195                 _other -> do
 196                    let object_filename = ml_obj_file location
 197
 198                    runPipeline (StopBefore Ln) ""
 199                         True Nothing output_fn (Just location)
 200                         -- the object filename comes from the ModLocation
 201
 202                    o_time <- getModificationTime object_filename
 203                    return ([DotO object_filename], o_time)
 204
 205            let linkable = LM unlinked_time mod_name
 206                              (hs_unlinked ++ stub_unlinked)
 207
 208            return (CompOK details rdr_env iface (Just linkable))
 209
 210 -----------------------------------------------------------------------------
 211 -- stub .h and .c files (for foreign export support)
 212
 213 compileStub dflags stub_c_exists
 214   | not stub_c_exists = return Nothing
 215   | stub_c_exists = do
 216         -- compile the _stub.c file w/ gcc
 217         let stub_c = hscStubCOutName dflags
 218         stub_o <- runPipeline (StopBefore Ln) "stub-compile"
 219                         True{-persistent output-}
 220                         Nothing{-no specific output file-}
 221                         stub_c
 222                         Nothing{-no ModLocation-}
 223         return (Just stub_o)
 224
 225
 226 -- ---------------------------------------------------------------------------
 227 -- Link
 228
 229 link :: GhciMode                -- interactive or batch
 230      -> DynFlags                -- dynamic flags
 231      -> Bool                    -- attempt linking in batch mode?
 232      -> HomePackageTable        -- what to link
 233      -> IO SuccessFlag
 234
 235 -- For the moment, in the batch linker, we don't bother to tell doLink
 236 -- which packages to link -- it just tries all that are available.
 237 -- batch_attempt_linking should only be *looked at* in batch mode.  It
 238 -- should only be True if the upsweep was successful and someone
 239 -- exports main, i.e., we have good reason to believe that linking
 240 -- will succeed.
 241
 242 #ifdef GHCI
 243 link Interactive dflags batch_attempt_linking hpt
 244     = do -- Not Linking...(demand linker will do the job)
 245          return Succeeded
 246 #endif
 247
 248 link Batch dflags batch_attempt_linking hpt
 249    | batch_attempt_linking
 250    = do
 251         let
 252             home_mod_infos = moduleEnvElts hpt
 253
 254             -- the packages we depend on
 255             pkg_deps  = concatMap (dep_pkgs . mi_deps . hm_iface) home_mod_infos
 256
 257             -- the linkables to link
 258             linkables = map hm_linkable home_mod_infos
 259
 260         when (verb >= 3) $ do
 261              hPutStrLn stderr "link: linkables are ..."
 262              hPutStrLn stderr (showSDoc (vcat (map ppr linkables)))
 263
 264         -- check for the -no-link flag
 265         omit_linking <- readIORef v_NoLink
 266         if omit_linking
 267           then do when (verb >= 3) $
 268                     hPutStrLn stderr "link(batch): linking omitted (-no-link flag given)."
 269                   return Succeeded
 270           else do
 271
 272         when (verb >= 1) $
 273              hPutStrLn stderr "Linking ..."
 274
 275         let getOfiles (LM _ _ us) = map nameOfObject (filter isObject us)
 276             obj_files = concatMap getOfiles linkables
 277
 278         -- Don't showPass in Batch mode; doLink will do that for us.
 279         staticLink obj_files pkg_deps
 280
 281         when (verb >= 3) (hPutStrLn stderr "link: done")
 282
 283         -- staticLink only returns if it succeeds
 284         return Succeeded
 285
 286    | otherwise
 287    = do when (verb >= 3) $ do
 288             hPutStrLn stderr "link(batch): upsweep (partially) failed OR"
 289             hPutStrLn stderr "   Main.main not exported; not linking."
 290         return Succeeded
 291    where
 292       verb = verbosity dflags
 293
 294 -- ---------------------------------------------------------------------------
 295 -- Run a compilation pipeline, consisting of multiple phases.
 296
 297 runPipeline
 298   :: GhcMode            -- when to stop
 299   -> String             -- "stop after" flag
 300   -> Bool               -- final output is persistent?
 301   -> Maybe FilePath     -- where to put the output, optionally
 302   -> FilePath           -- input filename
 303   -> Maybe ModLocation  -- a ModLocation for this module, if we have one
 304   -> IO FilePath        -- output filename
 305
 306 runPipeline todo stop_flag keep_output maybe_output_filename input_fn maybe_loc
 307   = do
 308   split <- readIORef v_Split_object_files
 309   let (basename, suffix) = splitFilename input_fn
 310       start_phase = startPhase suffix
 311
 312       stop_phase = case todo of
 313                         StopBefore As | split -> SplitAs
 314                         StopBefore phase      -> phase
 315                         DoMkDependHS          -> Ln
 316                         DoLink                -> Ln
 317                         DoMkDLL               -> Ln
 318
 319   -- We want to catch cases of "you can't get there from here" before
 320   -- we start the pipeline, because otherwise it will just run off the
 321   -- end.
 322   --
 323   -- There is a partial ordering on phases, where A < B iff A occurs
 324   -- before B in a normal compilation pipeline.
 325   --
 326   when (not (start_phase `happensBefore` stop_phase)) $
 327         throwDyn (UsageError
 328                     ("flag `" ++ stop_flag
 329                      ++ "' is incompatible with source file `"
 330                      ++ input_fn ++ "'"))
 331
 332   -- generate a function which will be used to calculate output file names
 333   -- as we go along.
 334   get_output_fn <- genOutputFilenameFunc keep_output maybe_output_filename
 335                         stop_phase basename
 336
 337   -- and execute the pipeline...
 338   (output_fn, maybe_loc) <-
 339         pipeLoop start_phase stop_phase input_fn basename suffix
 340                  get_output_fn maybe_loc
 341
 342   -- sometimes, a compilation phase doesn't actually generate any output
 343   -- (eg. the CPP phase when -fcpp is not turned on).  If we end on this
 344   -- stage, but we wanted to keep the output, then we have to explicitly
 345   -- copy the file.
 346   if keep_output
 347         then do final_fn <- get_output_fn stop_phase maybe_loc
 348                 when (final_fn /= output_fn) $
 349                   copy ("Copying `" ++ output_fn ++ "' to `" ++ final_fn
 350                         ++ "'") output_fn final_fn
 351                 return final_fn
 352         else
 353              return output_fn
 354
 355
 356 pipeLoop :: Phase -> Phase -> FilePath -> String -> Suffix
 357   -> (Phase -> Maybe ModLocation -> IO FilePath)
 358   -> Maybe ModLocation -> IO (FilePath, Maybe ModLocation)
 359
 360 pipeLoop phase stop_phase input_fn orig_basename orig_suff
 361         get_output_fn maybe_loc
 362
 363   | phase == stop_phase  =  return (input_fn, maybe_loc)  -- all done
 364
 365   | not (phase `happensBefore` stop_phase)  =
 366         -- Something has gone wrong.  We'll try to cover all the cases when
 367         -- this could happen, so if we reach here it is a panic.
 368         -- eg. it might happen if the -C flag is used on a source file that
 369         -- has {-# OPTIONS -fasm #-}.
 370         panic ("pipeLoop: at phase " ++ show phase ++
 371                 " but I wanted to stop at phase " ++ show stop_phase)
 372
 373   | otherwise = do
 374         maybe_next_phase <- runPhase phase orig_basename orig_suff input_fn
 375                                 get_output_fn maybe_loc
 376         case maybe_next_phase of
 377           (Nothing, maybe_loc, output_fn) -> do
 378                 -- we stopped early, but return the *final* filename
 379                 -- (it presumably already exists)
 380                 final_fn <- get_output_fn stop_phase maybe_loc
 381                 return (final_fn, maybe_loc)
 382           (Just next_phase, maybe_loc, output_fn) ->
 383                 pipeLoop next_phase stop_phase output_fn
 384                         orig_basename orig_suff get_output_fn maybe_loc
 385
 386
 387 genOutputFilenameFunc :: Bool -> Maybe FilePath -> Phase -> String
 388   -> IO (Phase{-next phase-} -> Maybe ModLocation -> IO FilePath)
 389 genOutputFilenameFunc keep_final_output maybe_output_filename
 390                 stop_phase basename
 391  = do
 392    hcsuf      <- readIORef v_HC_suf
 393    odir       <- readIORef v_Output_dir
 394    osuf       <- readIORef v_Object_suf
 395    keep_hc    <- readIORef v_Keep_hc_files
 396 #ifdef ILX
 397    keep_il    <- readIORef v_Keep_il_files
 398    keep_ilx   <- readIORef v_Keep_ilx_files
 399 #endif
 400    keep_raw_s <- readIORef v_Keep_raw_s_files
 401    keep_s     <- readIORef v_Keep_s_files
 402    let
 403         myPhaseInputExt HCc | Just s <- hcsuf = s
 404         myPhaseInputExt Ln    = osuf
 405         myPhaseInputExt other = phaseInputExt other
 406
 407         func next_phase maybe_location
 408                 | is_last_phase, Just f <- maybe_output_filename = return f
 409                 | is_last_phase && keep_final_output = persistent_fn
 410                 | keep_this_output                   = persistent_fn
 411                 | otherwise                          = newTempName suffix
 412
 413            where
 414                 is_last_phase = next_phase == stop_phase
 415
 416                 -- sometimes, we keep output from intermediate stages
 417                 keep_this_output =
 418                      case next_phase of
 419                              Ln                  -> True
 420                              Mangle | keep_raw_s -> True
 421                              As     | keep_s     -> True
 422                              HCc    | keep_hc    -> True
 423                              _other              -> False
 424
 425                 suffix = myPhaseInputExt next_phase
 426
 427                 -- persistent object files get put in odir
 428                 persistent_fn
 429                    | Ln <- next_phase  = return odir_persistent
 430                    | otherwise         = return persistent
 431
 432                 persistent = basename ++ '.':suffix
 433
 434                 odir_persistent
 435                    | Just loc <- maybe_location = ml_obj_file loc
 436                    | Just d <- odir = replaceFilenameDirectory persistent d
 437                    | otherwise      = persistent
 438
 439    return func
 440
 441
 442 -- -----------------------------------------------------------------------------
 443 -- Each phase in the pipeline returns the next phase to execute, and the
 444 -- name of the file in which the output was placed.
 445 --
 446 -- We must do things dynamically this way, because we often don't know
 447 -- what the rest of the phases will be until part-way through the
 448 -- compilation: for example, an {-# OPTIONS -fasm #-} at the beginning
 449 -- of a source file can change the latter stages of the pipeline from
 450 -- taking the via-C route to using the native code generator.
 451
 452 runPhase :: Phase
 453           -> String     -- basename of original input source
 454           -> String     -- its extension
 455           -> FilePath   -- name of file which contains the input to this phase.
 456           -> (Phase -> Maybe ModLocation -> IO FilePath)
 457                         -- how to calculate the output filename
 458           -> Maybe ModLocation          -- the ModLocation, if we have one
 459           -> IO (Maybe Phase,           -- next phase
 460                  Maybe ModLocation,     -- the ModLocation, if we have one
 461                  FilePath)              -- output filename
 462
 463 -------------------------------------------------------------------------------
 464 -- Unlit phase
 465
 466 runPhase Unlit _basename _suff input_fn get_output_fn maybe_loc
 467   = do unlit_flags <- getOpts opt_L
 468        -- The -h option passes the file name for unlit to put in a #line directive
 469        output_fn <- get_output_fn Cpp maybe_loc
 470
 471        SysTools.runUnlit (map SysTools.Option unlit_flags ++
 472                           [ SysTools.Option     "-h"
 473                           , SysTools.Option     input_fn
 474                           , SysTools.FileOption "" input_fn
 475                           , SysTools.FileOption "" output_fn
 476                           ])
 477
 478        return (Just Cpp, maybe_loc, output_fn)
 479
 480 -------------------------------------------------------------------------------
 481 -- Cpp phase
 482
 483 runPhase Cpp basename suff input_fn get_output_fn maybe_loc
 484   = do src_opts <- getOptionsFromSource input_fn
 485        unhandled_flags <- processArgs dynamic_flags src_opts []
 486        checkProcessArgsResult unhandled_flags basename suff
 487
 488        do_cpp <- dynFlag cppFlag
 489        if not do_cpp then
 490            -- no need to preprocess CPP, just pass input file along
 491            -- to the next phase of the pipeline.
 492           return (Just HsPp, maybe_loc, input_fn)
 493         else do
 494             output_fn <- get_output_fn HsPp maybe_loc
 495             doCpp True{-raw-} False{-no CC opts-} input_fn output_fn
 496             return (Just HsPp, maybe_loc, output_fn)
 497
 498 -------------------------------------------------------------------------------
 499 -- HsPp phase
 500
 501 runPhase HsPp basename suff input_fn get_output_fn maybe_loc
 502   = do do_pp   <- dynFlag ppFlag
 503        if not do_pp then
 504            -- no need to preprocess, just pass input file along
 505            -- to the next phase of the pipeline.
 506           return (Just Hsc, maybe_loc, input_fn)
 507         else do
 508             hspp_opts      <- getOpts opt_F
 509             hs_src_pp_opts <- readIORef v_Hs_source_pp_opts
 510             let orig_fn = basename ++ '.':suff
 511             output_fn <- get_output_fn Hsc maybe_loc
 512             SysTools.runPp ( [ SysTools.Option     orig_fn
 513                              , SysTools.Option     input_fn
 514                              , SysTools.FileOption "" output_fn
 515                              ] ++
 516                              map SysTools.Option hs_src_pp_opts ++
 517                              map SysTools.Option hspp_opts
 518                            )
 519             return (Just Hsc, maybe_loc, output_fn)
 520
 521 -----------------------------------------------------------------------------
 522 -- Hsc phase
 523
 524 -- Compilation of a single module, in "legacy" mode (_not_ under
 525 -- the direction of the compilation manager).
 526 runPhase Hsc basename suff input_fn get_output_fn _maybe_loc = do
 527   todo <- readIORef v_GhcMode
 528   if todo == DoMkDependHS then do
 529        locn <- doMkDependHSPhase basename suff input_fn
 530        return (Nothing, Just locn, input_fn)  -- Ln is a dummy stop phase
 531
 532    else do
 533       -- normal Hsc mode, not mkdependHS
 534
 535   -- we add the current directory (i.e. the directory in which
 536   -- the .hs files resides) to the import path, since this is
 537   -- what gcc does, and it's probably what you want.
 538         let current_dir = directoryOf basename
 539
 540         paths <- readIORef v_Include_paths
 541         writeIORef v_Include_paths (current_dir : paths)
 542
 543   -- gather the imports and module name
 544         (_,_,mod_name) <-
 545             if isExtCoreFilename ('.':suff)
 546              then do
 547                -- no explicit imports in ExtCore input.
 548                m <- getCoreModuleName input_fn
 549                return ([], [], mkModuleName m)
 550              else
 551                getImportsFromFile input_fn
 552
 553   -- build a ModLocation to pass to hscMain.
 554         (mod, location') <- mkHomeModLocation mod_name (basename ++ '.':suff)
 555
 556   -- take -ohi into account if present
 557         ohi <- readIORef v_Output_hi
 558         let location | Just fn <- ohi = location'{ ml_hi_file = fn }
 559                      | otherwise      = location'
 560
 561   -- figure out if the source has changed, for recompilation avoidance.
 562   -- only do this if we're eventually going to generate a .o file.
 563   -- (ToDo: do when generating .hc files too?)
 564   --
 565   -- Setting source_unchanged to True means that M.o seems
 566   -- to be up to date wrt M.hs; so no need to recompile unless imports have
 567   -- changed (which the compiler itself figures out).
 568   -- Setting source_unchanged to False tells the compiler that M.o is out of
 569   -- date wrt M.hs (or M.o doesn't exist) so we must recompile regardless.
 570         do_recomp   <- readIORef v_Recomp
 571         expl_o_file <- readIORef v_Output_file
 572
 573         let o_file -- if the -o option is given and IT IS THE OBJECT FILE FOR
 574                    -- THIS COMPILATION, then use that to determine if the
 575                    -- source is unchanged.
 576                 | Just x <- expl_o_file, todo == StopBefore Ln  =  x
 577                 | otherwise = ml_obj_file location
 578
 579         source_unchanged <-
 580           if not (do_recomp && ( todo == DoLink || todo == StopBefore Ln ))
 581              then return False
 582              else do t1 <- getModificationTime (basename ++ '.':suff)
 583                      o_file_exists <- doesFileExist o_file
 584                      if not o_file_exists
 585                         then return False       -- Need to recompile
 586                         else do t2 <- getModificationTime o_file
 587                                 if t2 > t1
 588                                   then return True
 589                                   else return False
 590
 591   -- get the DynFlags
 592         dyn_flags <- getDynFlags
 593         hsc_lang <- hscMaybeAdjustLang (hscLang dyn_flags)
 594         next_phase <- hscNextPhase hsc_lang
 595         output_fn <- get_output_fn next_phase (Just location)
 596
 597         let dyn_flags' = dyn_flags { hscLang = hsc_lang,
 598                                      hscOutName = output_fn,
 599                                      hscStubCOutName = basename ++ "_stub.c",
 600                                      hscStubHOutName = basename ++ "_stub.h",
 601                                      extCoreName = basename ++ ".hcr" }
 602         hsc_env <- newHscEnv OneShot dyn_flags'
 603
 604   -- run the compiler!
 605         result <- hscMain hsc_env printErrorsAndWarnings mod
 606                           location{ ml_hspp_file=Just input_fn }
 607                           source_unchanged
 608                           False
 609                           Nothing        -- no iface
 610
 611         case result of
 612
 613             HscFail -> throwDyn (PhaseFailed "hsc" (ExitFailure 1))
 614
 615             HscNoRecomp details iface -> do
 616                 SysTools.touch "Touching object file" o_file
 617                 return (Nothing, Just location, output_fn)
 618
 619             HscRecomp _details _rdr_env _iface
 620                       stub_h_exists stub_c_exists
 621                       _maybe_interpreted_code -> do
 622
 623                 -- deal with stubs
 624                 maybe_stub_o <- compileStub dyn_flags' stub_c_exists
 625                 case maybe_stub_o of
 626                       Nothing -> return ()
 627                       Just stub_o -> add v_Ld_inputs stub_o
 628                 case hscLang dyn_flags of
 629                       HscNothing -> return (Nothing, Just location, output_fn)
 630                       _ -> return (Just next_phase, Just location, output_fn)
 631
 632 -----------------------------------------------------------------------------
 633 -- Cmm phase
 634
 635 runPhase CmmCpp basename suff input_fn get_output_fn maybe_loc
 636   = do
 637        output_fn <- get_output_fn Cmm maybe_loc
 638        doCpp False{-not raw-} True{-include CC opts-} input_fn output_fn
 639        return (Just Cmm, maybe_loc, output_fn)
 640
 641 runPhase Cmm basename suff input_fn get_output_fn maybe_loc
 642   = do
 643         dyn_flags <- getDynFlags
 644         hsc_lang <- hscMaybeAdjustLang (hscLang dyn_flags)
 645         next_phase <- hscNextPhase hsc_lang
 646         output_fn <- get_output_fn next_phase maybe_loc
 647
 648         let dyn_flags' = dyn_flags { hscLang = hsc_lang,
 649                                      hscOutName = output_fn,
 650                                      hscStubCOutName = basename ++ "_stub.c",
 651                                      hscStubHOutName = basename ++ "_stub.h",
 652                                      extCoreName = basename ++ ".hcr" }
 653
 654         ok <- hscCmmFile dyn_flags' input_fn
 655
 656         when (not ok) $ throwDyn (PhaseFailed "cmm" (ExitFailure 1))
 657
 658         return (Just next_phase, maybe_loc, output_fn)
 659
 660 -----------------------------------------------------------------------------
 661 -- Cc phase
 662
 663 -- we don't support preprocessing .c files (with -E) now.  Doing so introduces
 664 -- way too many hacks, and I can't say I've ever used it anyway.
 665
 666 runPhase cc_phase basename suff input_fn get_output_fn maybe_loc
 667    | cc_phase == Cc || cc_phase == HCc
 668    = do cc_opts <- getOpts opt_c
 669         cmdline_include_paths <- readIORef v_Include_paths
 670
 671         split  <- readIORef v_Split_object_files
 672         mangle <- readIORef v_Do_asm_mangling
 673
 674         let hcc = cc_phase == HCc
 675
 676             next_phase
 677                 | hcc && mangle     = Mangle
 678                 | otherwise         = As
 679
 680         output_fn <- get_output_fn next_phase maybe_loc
 681
 682         -- HC files have the dependent packages stamped into them
 683         pkgs <- if hcc then getHCFilePackages input_fn else return []
 684
 685         -- add package include paths even if we're just compiling .c
 686         -- files; this is the Value Add(TM) that using ghc instead of
 687         -- gcc gives you :)
 688         pkg_include_dirs <- getPackageIncludePath pkgs
 689         let include_paths = foldr (\ x xs -> "-I" : x : xs) []
 690                               (cmdline_include_paths ++ pkg_include_dirs)
 691
 692         mangle <- readIORef v_Do_asm_mangling
 693         (md_c_flags, md_regd_c_flags) <- machdepCCOpts
 694
 695         verb <- getVerbFlag
 696
 697         pkg_extra_cc_opts <- getPackageExtraCcOpts pkgs
 698
 699         split_objs <- readIORef v_Split_object_files
 700         let split_opt | hcc && split_objs = [ "-DUSE_SPLIT_MARKERS" ]
 701                       | otherwise         = [ ]
 702
 703         excessPrecision <- readIORef v_Excess_precision
 704
 705         -- force the C compiler to interpret this file as C when
 706         -- compiling .hc files, by adding the -x c option.
 707         let langopt
 708                 | cc_phase == HCc = [ SysTools.Option "-x", SysTools.Option "c"]
 709                 | otherwise       = [ ]
 710
 711         SysTools.runCc (langopt ++
 712                         [ SysTools.FileOption "" input_fn
 713                         , SysTools.Option "-o"
 714                         , SysTools.FileOption "" output_fn
 715                         ]
 716                        ++ map SysTools.Option (
 717                           md_c_flags
 718                        ++ (if cc_phase == HCc && mangle
 719                              then md_regd_c_flags
 720                              else [])
 721                        ++ [ verb, "-S", "-Wimplicit", "-O" ]
 722                        ++ [ "-D__GLASGOW_HASKELL__="++cProjectVersionInt ]
 723                        ++ cc_opts
 724                        ++ split_opt
 725                        ++ (if excessPrecision then [] else [ "-ffloat-store" ])
 726                        ++ include_paths
 727                        ++ pkg_extra_cc_opts
 728                        ))
 729
 730         return (Just next_phase, maybe_loc, output_fn)
 731
 732         -- ToDo: postprocess the output from gcc
 733
 734 -----------------------------------------------------------------------------
 735 -- Mangle phase
 736
 737 runPhase Mangle _basename _suff input_fn get_output_fn maybe_loc
 738    = do mangler_opts <- getOpts opt_m
 739         machdep_opts <- if (prefixMatch "i386" cTARGETPLATFORM)
 740                           then do n_regs <- dynFlag stolen_x86_regs
 741                                   return [ show n_regs ]
 742                           else return []
 743
 744         split <- readIORef v_Split_object_files
 745         let next_phase
 746                 | split = SplitMangle
 747                 | otherwise = As
 748         output_fn <- get_output_fn next_phase maybe_loc
 749
 750         SysTools.runMangle (map SysTools.Option mangler_opts
 751                           ++ [ SysTools.FileOption "" input_fn
 752                              , SysTools.FileOption "" output_fn
 753                              ]
 754                           ++ map SysTools.Option machdep_opts)
 755
 756         return (Just next_phase, maybe_loc, output_fn)
 757
 758 -----------------------------------------------------------------------------
 759 -- Splitting phase
 760
 761 runPhase SplitMangle _basename _suff input_fn get_output_fn maybe_loc
 762   = do  -- tmp_pfx is the prefix used for the split .s files
 763         -- We also use it as the file to contain the no. of split .s files (sigh)
 764         split_s_prefix <- SysTools.newTempName "split"
 765         let n_files_fn = split_s_prefix
 766
 767         SysTools.runSplit [ SysTools.FileOption "" input_fn
 768                           , SysTools.FileOption "" split_s_prefix
 769                           , SysTools.FileOption "" n_files_fn
 770                           ]
 771
 772         -- Save the number of split files for future references
 773         s <- readFile n_files_fn
 774         let n_files = read s :: Int
 775         writeIORef v_Split_info (split_s_prefix, n_files)
 776
 777         -- Remember to delete all these files
 778         addFilesToClean [ split_s_prefix ++ "__" ++ show n ++ ".s"
 779                         | n <- [1..n_files]]
 780
 781         return (Just SplitAs, maybe_loc, "**splitmangle**")
 782           -- we don't use the filename
 783
 784 -----------------------------------------------------------------------------
 785 -- As phase
 786
 787 runPhase As _basename _suff input_fn get_output_fn maybe_loc
 788   = do  as_opts               <- getOpts opt_a
 789         cmdline_include_paths <- readIORef v_Include_paths
 790
 791         output_fn <- get_output_fn Ln maybe_loc
 792
 793         -- we create directories for the object file, because it
 794         -- might be a hierarchical module.
 795         createDirectoryHierarchy (directoryOf output_fn)
 796
 797         SysTools.runAs (map SysTools.Option as_opts
 798                        ++ [ SysTools.Option ("-I" ++ p) | p <- cmdline_include_paths ]
 799                        ++ [ SysTools.Option "-c"
 800                           , SysTools.FileOption "" input_fn
 801                           , SysTools.Option "-o"
 802                           , SysTools.FileOption "" output_fn
 803                           ])
 804
 805         return (Just Ln, maybe_loc, output_fn)
 806
 807
 808 runPhase SplitAs basename _suff _input_fn get_output_fn maybe_loc
 809   = do  as_opts <- getOpts opt_a
 810
 811         (split_s_prefix, n) <- readIORef v_Split_info
 812
 813         odir <- readIORef v_Output_dir
 814         let real_odir = case odir of
 815                                 Nothing -> basename ++ "_split"
 816                                 Just d  -> d
 817
 818         let assemble_file n
 819               = do  let input_s  = split_s_prefix ++ "__" ++ show n ++ ".s"
 820                     let output_o = replaceFilenameDirectory
 821                                         (basename ++ "__" ++ show n ++ ".o")
 822                                          real_odir
 823                     real_o <- osuf_ify output_o
 824                     SysTools.runAs (map SysTools.Option as_opts ++
 825                                     [ SysTools.Option "-c"
 826                                     , SysTools.Option "-o"
 827                                     , SysTools.FileOption "" real_o
 828                                     , SysTools.FileOption "" input_s
 829                                     ])
 830
 831         mapM_ assemble_file [1..n]
 832
 833         output_fn <- get_output_fn Ln maybe_loc
 834         return (Just Ln, maybe_loc, output_fn)
 835
 836 #ifdef ILX
 837 -----------------------------------------------------------------------------
 838 -- Ilx2Il phase
 839 -- Run ilx2il over the ILX output, getting an IL file
 840
 841 runPhase Ilx2Il _basename _suff input_fn get_output_fn maybe_loc
 842   = do  ilx2il_opts <- getOpts opt_I
 843         SysTools.runIlx2il (map SysTools.Option ilx2il_opts
 844                            ++ [ SysTools.Option "--no-add-suffix-to-assembly",
 845                                 SysTools.Option "mscorlib",
 846                                 SysTools.Option "-o",
 847                                 SysTools.FileOption "" output_fn,
 848                                 SysTools.FileOption "" input_fn ])
 849         return True
 850
 851 -----------------------------------------------------------------------------
 852 -- Ilasm phase
 853 -- Run ilasm over the IL, getting a DLL
 854
 855 runPhase Ilasm _basename _suff input_fn get_output_fn maybe_loc
 856   = do  ilasm_opts <- getOpts opt_i
 857         SysTools.runIlasm (map SysTools.Option ilasm_opts
 858                            ++ [ SysTools.Option "/QUIET",
 859                                 SysTools.Option "/DLL",
 860                                 SysTools.FileOption "/OUT=" output_fn,
 861                                 SysTools.FileOption "" input_fn ])
 862         return True
 863
 864 #endif /* ILX */
 865
 866 -----------------------------------------------------------------------------
 867 -- MoveBinary sort-of-phase
 868 -- After having produced a binary, move it somewhere else and generate a
 869 -- wrapper script calling the binary. Currently, we need this only in
 870 -- a parallel way (i.e. in GUM), because PVM expects the binary in a
 871 -- central directory.
 872 -- This is called from staticLink below, after linking. I haven't made it
 873 -- a separate phase to minimise interfering with other modules, and
 874 -- we don't need the generality of a phase (MoveBinary is always
 875 -- done after linking and makes only sense in a parallel setup)   -- HWL
 876
 877 runPhase_MoveBinary input_fn
 878   = do
 879         sysMan   <- getSysMan
 880         pvm_root <- getEnv "PVM_ROOT"
 881         pvm_arch <- getEnv "PVM_ARCH"
 882         let
 883            pvm_executable_base = "=" ++ input_fn
 884            pvm_executable = pvm_root ++ "/bin/" ++ pvm_arch ++ "/" ++ pvm_executable_base
 885         -- nuke old binary; maybe use configur'ed names for cp and rm?
 886         system ("rm -f " ++ pvm_executable)
 887         -- move the newly created binary into PVM land
 888         system ("cp -p " ++ input_fn ++ " " ++ pvm_executable)
 889         -- generate a wrapper script for running a parallel prg under PVM
 890         writeFile input_fn (mk_pvm_wrapper_script pvm_executable pvm_executable_base sysMan)
 891         return True
 892
 893 -- generates a Perl skript starting a parallel prg under PVM
 894 mk_pvm_wrapper_script :: String -> String -> String -> String
 895 mk_pvm_wrapper_script pvm_executable pvm_executable_base sysMan = unlines $
 896  [
 897   "eval 'exec perl -S $0 ${1+\"$@\"}'",
 898   "  if $running_under_some_shell;",
 899   "# =!=!=!=!=!=!=!=!=!=!=!",
 900   "# This script is automatically generated: DO NOT EDIT!!!",
 901   "# Generated by Glasgow Haskell Compiler",
 902   "# ngoqvam choHbogh vaj' vIHoHnISbej !!!!",
 903   "#",
 904   "$pvm_executable      = '" ++ pvm_executable ++ "';",
 905   "$pvm_executable_base = '" ++ pvm_executable_base ++ "';",
 906   "$SysMan = '" ++ sysMan ++ "';",
 907   "",
 908   {- ToDo: add the magical shortcuts again iff we actually use them -- HWL
 909   "# first, some magical shortcuts to run "commands" on the binary",
 910   "# (which is hidden)",
 911   "if ($#ARGV == 1 && $ARGV[0] eq '+RTS' && $ARGV[1] =~ /^--((size|file|strip|rm|nm).*)/ ) {",
 912   "    local($cmd) = $1;",
 913   "    system("$cmd $pvm_executable");",
 914   "    exit(0); # all done",
 915   "}", -}
 916   "",
 917   "# Now, run the real binary; process the args first",
 918   "$ENV{'PE'} = $pvm_executable_base;", --  ++ pvm_executable_base,
 919   "$debug = '';",
 920   "$nprocessors = 0; # the default: as many PEs as machines in PVM config",
 921   "@nonPVM_args = ();",
 922   "$in_RTS_args = 0;",
 923   "",
 924   "args: while ($a = shift(@ARGV)) {",
 925   "    if ( $a eq '+RTS' ) {",
 926   "     $in_RTS_args = 1;",
 927   "    } elsif ( $a eq '-RTS' ) {",
 928   "     $in_RTS_args = 0;",
 929   "    }",
 930   "    if ( $a eq '-d' && $in_RTS_args ) {",
 931   "     $debug = '-';",
 932   "    } elsif ( $a =~ /^-qN(\\d+)/ && $in_RTS_args ) {",
 933   "     $nprocessors = $1;",
 934   "    } elsif ( $a =~ /^-qp(\\d+)/ && $in_RTS_args ) {",
 935   "     $nprocessors = $1;",
 936   "    } else {",
 937   "     push(@nonPVM_args, $a);",
 938   "    }",
 939   "}",
 940   "",
 941   "local($return_val) = 0;",
 942   "# Start the parallel execution by calling SysMan",
 943   "system(\"$SysMan $debug $pvm_executable $nprocessors @nonPVM_args\");",
 944   "$return_val = $?;",
 945   "# ToDo: fix race condition moving files and flushing them!!",
 946   "system(\"cp $ENV{'HOME'}/$pvm_executable_base.???.gr .\") if -f \"$ENV{'HOME'}/$pvm_executable_base.002.gr\";",
 947   "exit($return_val);"
 948  ]
 949
 950 -----------------------------------------------------------------------------
 951 -- Complain about non-dynamic flags in OPTIONS pragmas
 952
 953 checkProcessArgsResult flags basename suff
 954   = do when (notNull flags) (throwDyn (ProgramError (
 955           showSDoc (hang (text basename <> text ('.':suff) <> char ':')
 956                       4 (text "unknown flags in  {-# OPTIONS #-} pragma:" <+>
 957                           hsep (map text flags)))
 958         )))
 959
 960 -----------------------------------------------------------------------------
 961 -- Look for the /* GHC_PACKAGES ... */ comment at the top of a .hc file
 962
 963 getHCFilePackages :: FilePath -> IO [PackageName]
 964 getHCFilePackages filename =
 965   EXCEPTION.bracket (openFile filename ReadMode) hClose $ \h -> do
 966     l <- hGetLine h
 967     case l of
 968       '/':'*':' ':'G':'H':'C':'_':'P':'A':'C':'K':'A':'G':'E':'S':rest ->
 969           return (map mkPackageName (words rest))
 970       _other ->
 971           return []
 972
 973 -----------------------------------------------------------------------------
 974 -- Static linking, of .o files
 975
 976 -- The list of packages passed to link is the list of packages on
 977 -- which this program depends, as discovered by the compilation
 978 -- manager.  It is combined with the list of packages that the user
 979 -- specifies on the command line with -package flags.
 980 --
 981 -- In one-shot linking mode, we can't discover the package
 982 -- dependencies (because we haven't actually done any compilation or
 983 -- read any interface files), so the user must explicitly specify all
 984 -- the packages.
 985
 986 staticLink :: [FilePath] -> [PackageName] -> IO ()
 987 staticLink o_files dep_packages = do
 988     verb       <- getVerbFlag
 989     static     <- readIORef v_Static
 990     no_hs_main <- readIORef v_NoHsMain
 991
 992     -- get the full list of packages to link with, by combining the
 993     -- explicit packages with the auto packages and all of their
 994     -- dependencies, and eliminating duplicates.
 995
 996     o_file <- readIORef v_Output_file
 997     let output_fn = case o_file of { Just s -> s; Nothing -> "a.out"; }
 998
 999     pkg_lib_paths <- getPackageLibraryPath dep_packages
1000     let pkg_lib_path_opts = map ("-L"++) pkg_lib_paths
1001
1002     lib_paths <- readIORef v_Library_paths
1003     let lib_path_opts = map ("-L"++) lib_paths
1004
1005     pkg_link_opts <- getPackageLinkOpts dep_packages
1006
1007 #ifdef darwin_TARGET_OS
1008     pkg_framework_paths <- getPackageFrameworkPath dep_packages
1009     let pkg_framework_path_opts = map ("-F"++) pkg_framework_paths
1010
1011     framework_paths <- readIORef v_Framework_paths
1012     let framework_path_opts = map ("-F"++) framework_paths
1013
1014     pkg_frameworks <- getPackageFrameworks dep_packages
1015     let pkg_framework_opts = concat [ ["-framework", fw] | fw <- pkg_frameworks ]
1016
1017     frameworks <- readIORef v_Cmdline_frameworks
1018     let framework_opts = concat [ ["-framework", fw] | fw <- reverse frameworks ]
1019          -- reverse because they're added in reverse order from the cmd line
1020 #endif
1021
1022         -- probably _stub.o files
1023     extra_ld_inputs <- readIORef v_Ld_inputs
1024
1025         -- opts from -optl-<blah> (including -l<blah> options)
1026     extra_ld_opts <- getStaticOpts v_Opt_l
1027
1028     [rts_pkg, std_pkg] <- getPackageDetails [rtsPackage, basePackage]
1029
1030     ways <- readIORef v_Ways
1031
1032     -- Here are some libs that need to be linked at the *end* of
1033     -- the command line, because they contain symbols that are referred to
1034     -- by the RTS.  We can't therefore use the ordinary way opts for these.
1035     let
1036         debug_opts | WayDebug `elem` ways = [
1037 #if defined(HAVE_LIBBFD)
1038                         "-lbfd", "-liberty"
1039 #endif
1040                          ]
1041                    | otherwise            = []
1042
1043     let
1044         thread_opts | WayThreaded `elem` ways = [
1045 #if !defined(mingw32_TARGET_OS) && !defined(freebsd_TARGET_OS)
1046                         "-lpthread"
1047 #endif
1048 #if defined(osf3_TARGET_OS)
1049                         , "-lexc"
1050 #endif
1051                         ]
1052                     | otherwise               = []
1053
1054     let extra_os = if static || no_hs_main
1055                    then []
1056                    else [ head (library_dirs rts_pkg) ++ "/Main.dll_o",
1057                           head (library_dirs std_pkg) ++ "/PrelMain.dll_o" ]
1058
1059     (md_c_flags, _) <- machdepCCOpts
1060     SysTools.runLink ( [ SysTools.Option verb
1061                        , SysTools.Option "-o"
1062                        , SysTools.FileOption "" output_fn
1063                        ]
1064                       ++ map SysTools.Option (
1065                          md_c_flags
1066                       ++ o_files
1067                       ++ extra_os
1068                       ++ extra_ld_inputs
1069                       ++ lib_path_opts
1070                       ++ extra_ld_opts
1071 #ifdef darwin_TARGET_OS
1072                       ++ framework_path_opts
1073                       ++ framework_opts
1074 #endif
1075                       ++ pkg_lib_path_opts
1076                       ++ pkg_link_opts
1077 #ifdef darwin_TARGET_OS
1078                       ++ pkg_framework_path_opts
1079                       ++ pkg_framework_opts
1080 #endif
1081                       ++ debug_opts
1082                       ++ thread_opts
1083                     ))
1084
1085     -- parallel only: move binary to another dir -- HWL
1086     ways_ <- readIORef v_Ways
1087     when (WayPar `elem` ways_)
1088          (do success <- runPhase_MoveBinary output_fn
1089              if success then return ()
1090                         else throwDyn (InstallationError ("cannot move binary to PVM dir")))
1091
1092 -----------------------------------------------------------------------------
1093 -- Making a DLL (only for Win32)
1094
1095 doMkDLL :: [String] -> [PackageName] -> IO ()
1096 doMkDLL o_files dep_packages = do
1097     verb       <- getVerbFlag
1098     static     <- readIORef v_Static
1099     no_hs_main <- readIORef v_NoHsMain
1100
1101     o_file <- readIORef v_Output_file
1102     let output_fn = case o_file of { Just s -> s; Nothing -> "HSdll.dll"; }
1103
1104     pkg_lib_paths <- getPackageLibraryPath dep_packages
1105     let pkg_lib_path_opts = map ("-L"++) pkg_lib_paths
1106
1107     lib_paths <- readIORef v_Library_paths
1108     let lib_path_opts = map ("-L"++) lib_paths
1109
1110     pkg_link_opts <- getPackageLinkOpts dep_packages
1111
1112         -- probably _stub.o files
1113     extra_ld_inputs <- readIORef v_Ld_inputs
1114
1115         -- opts from -optdll-<blah>
1116     extra_ld_opts <- getStaticOpts v_Opt_dll
1117
1118     [rts_pkg, std_pkg] <- getPackageDetails [rtsPackage, basePackage]
1119
1120     let extra_os = if static || no_hs_main
1121                    then []
1122                    else [ head (library_dirs rts_pkg) ++ "/Main.dll_o",
1123                           head (library_dirs std_pkg) ++ "/PrelMain.dll_o" ]
1124
1125     (md_c_flags, _) <- machdepCCOpts
1126     SysTools.runMkDLL
1127          ([ SysTools.Option verb
1128           , SysTools.Option "-o"
1129           , SysTools.FileOption "" output_fn
1130           ]
1131          ++ map SysTools.Option (
1132             md_c_flags
1133          ++ o_files
1134          ++ extra_os
1135          ++ [ "--target=i386-mingw32" ]
1136          ++ extra_ld_inputs
1137          ++ lib_path_opts
1138          ++ extra_ld_opts
1139          ++ pkg_lib_path_opts
1140          ++ pkg_link_opts
1141          ++ (if "--def" `elem` (concatMap words extra_ld_opts)
1142                then [ "" ]
1143                else [ "--export-all" ])
1144         ))
1145
1146 -- -----------------------------------------------------------------------------
1147 -- Misc.
1148
1149 doCpp :: Bool -> Bool -> FilePath -> FilePath -> IO ()
1150 doCpp raw include_cc_opts input_fn output_fn = do
1151     hscpp_opts      <- getOpts opt_P
1152
1153     cmdline_include_paths <- readIORef v_Include_paths
1154
1155     pkg_include_dirs <- getPackageIncludePath []
1156     let include_paths = foldr (\ x xs -> "-I" : x : xs) []
1157                           (cmdline_include_paths ++ pkg_include_dirs)
1158
1159     verb <- getVerbFlag
1160
1161     cc_opts <- if not include_cc_opts
1162                   then return []
1163                   else do optc <- getOpts opt_c
1164                           (md_c_flags, _) <- machdepCCOpts
1165                           return (optc ++ md_c_flags)
1166
1167     let cpp_prog args | raw       = SysTools.runCpp args
1168                       | otherwise = SysTools.runCc (SysTools.Option "-E" : args)
1169
1170     let target_defs =
1171           [ "-D" ++ cTARGETOS   ++ "_TARGET_OS=1",
1172             "-D" ++ cTARGETARCH ++ "_TARGET_ARCH=1" ]
1173
1174     cpp_prog       ([SysTools.Option verb]
1175                     ++ map SysTools.Option include_paths
1176                     ++ map SysTools.Option hsSourceCppOpts
1177                     ++ map SysTools.Option hscpp_opts
1178                     ++ map SysTools.Option cc_opts
1179                     ++ map SysTools.Option target_defs
1180                     ++ [ SysTools.Option     "-x"
1181                        , SysTools.Option     "c"
1182                        , SysTools.Option     input_fn
1183         -- We hackily use Option instead of FileOption here, so that the file
1184         -- name is not back-slashed on Windows.  cpp is capable of
1185         -- dealing with / in filenames, so it works fine.  Furthermore
1186         -- if we put in backslashes, cpp outputs #line directives
1187         -- with *double* backslashes.   And that in turn means that
1188         -- our error messages get double backslashes in them.
1189         -- In due course we should arrange that the lexer deals
1190         -- with these \\ escapes properly.
1191                        , SysTools.Option     "-o"
1192                        , SysTools.FileOption "" output_fn
1193                        ])
1194
1195 -- -----------------------------------------------------------------------------
1196 -- Misc.
1197
1198 hscNextPhase :: HscLang -> IO Phase
1199 hscNextPhase hsc_lang = do
1200   split <- readIORef v_Split_object_files
1201   return (case hsc_lang of
1202                 HscC -> HCc
1203                 HscAsm | split -> SplitMangle
1204                        | otherwise -> As
1205                 HscNothing     -> HCc  -- dummy (no output will be generated)
1206                 HscInterpreted -> HCc  -- "" ""
1207                 _other         -> HCc  -- "" ""
1208         )
1209
1210 hscMaybeAdjustLang :: HscLang -> IO HscLang
1211 hscMaybeAdjustLang current_hsc_lang = do
1212   todo    <- readIORef v_GhcMode
1213   keep_hc <- readIORef v_Keep_hc_files
1214   let hsc_lang
1215         -- don't change the lang if we're interpreting
1216          | current_hsc_lang == HscInterpreted = current_hsc_lang
1217         -- force -fvia-C if we are being asked for a .hc file
1218          | todo == StopBefore HCc  || keep_hc = HscC
1219         -- otherwise, stick to the plan
1220          | otherwise = current_hsc_lang
1221   return hsc_lang