[project @ 2001-12-05 00:08:26 by sof]
[ghc-hetmet.git] / ghc / compiler / main / DriverPipeline.hs
index 2142f91..c43381c 100644 (file)
@@ -33,7 +33,7 @@ import DriverUtil
 import DriverMkDepend
 import DriverPhases
 import DriverFlags
-import SysTools                ( newTempName, addFilesToClean, getSysMan, unDosifyPath )
+import SysTools                ( newTempName, addFilesToClean, getSysMan, copy )
 import qualified SysTools      
 import HscMain
 import Finder
@@ -84,7 +84,7 @@ getGhcMode flags
        ([(flag,one)], rest) -> return (rest, one, flag)
        (_    , _   ) -> 
          throwDyn (UsageError 
-               "only one of the flags -M, -E, -C, -S, -c, --make, --interactive, -mk-dll is allowed")
+               "only one of the flags -M, -E, -C, -S, -c, --make, --interactive, --mk-dll is allowed")
 
 -----------------------------------------------------------------------------
 -- genPipeline
@@ -135,6 +135,10 @@ genPipeline todo stop_flag persistent_output lang (filename,suffix)
    split      <- readIORef v_Split_object_files
    mangle     <- readIORef v_Do_asm_mangling
    keep_hc    <- readIORef v_Keep_hc_files
+#ifdef ILX
+   keep_il    <- readIORef v_Keep_il_files
+   keep_ilx   <- readIORef v_Keep_ilx_files
+#endif
    keep_raw_s <- readIORef v_Keep_raw_s_files
    keep_s     <- readIORef v_Keep_s_files
    osuf       <- readIORef v_Object_suf
@@ -158,26 +162,26 @@ genPipeline todo stop_flag persistent_output lang (filename,suffix)
    let
    ----------- -----  ----   ---   --   --  -  -  -
     pipeline
-      | todo == DoMkDependHS = [ Unlit, Cpp, MkDependHS ]
+      | todo == DoMkDependHS = [ Unlit, Cpp, HsPp, MkDependHS ]
 
       | haskellish = 
        case real_lang of
-       HscC    | split && mangle -> [ Unlit, Cpp, Hsc, HCc, Mangle, 
+       HscC    | split && mangle -> [ Unlit, Cpp, HsPp, Hsc, HCc, Mangle, 
                                        SplitMangle, SplitAs ]
-               | mangle          -> [ Unlit, Cpp, Hsc, HCc, Mangle, As ]
+               | mangle          -> [ Unlit, Cpp, HsPp, Hsc, HCc, Mangle, As ]
                | split           -> not_valid
-               | otherwise       -> [ Unlit, Cpp, Hsc, HCc, As ]
+               | otherwise       -> [ Unlit, Cpp, HsPp, Hsc, HCc, As ]
 
-       HscAsm  | split           -> [ Unlit, Cpp, Hsc, SplitMangle, SplitAs ]
-               | otherwise       -> [ Unlit, Cpp, Hsc, As ]
+       HscAsm  | split           -> [ Unlit, Cpp, HsPp, Hsc, SplitMangle, SplitAs ]
+               | otherwise       -> [ Unlit, Cpp, HsPp, Hsc, As ]
 
        HscJava | split           -> not_valid
                | otherwise       -> error "not implemented: compiling via Java"
 #ifdef ILX
        HscILX  | split           -> not_valid
-               | otherwise       -> [ Unlit, Cpp, Hsc, Ilx2Il, Ilasm ]
+               | otherwise       -> [ Unlit, Cpp, HsPp, Hsc, Ilx2Il, Ilasm ]
 #endif
-       HscNothing                -> [ Unlit, Cpp, Hsc ]
+       HscNothing                -> [ Unlit, Cpp, HsPp, Hsc ]
 
       | cish      = [ Cc, As ]
 
@@ -188,28 +192,28 @@ genPipeline todo stop_flag persistent_output lang (filename,suffix)
 
     stop_phase = case todo of 
                        StopBefore As | split -> SplitAs
+#ifdef ILX
+                                      | real_lang == HscILX -> Ilasm
+#endif
                        StopBefore phase      -> phase
                        DoMkDependHS          -> Ln
                        DoLink                -> Ln
+                       DoMkDLL               -> Ln
    ----------- -----  ----   ---   --   --  -  -  -
 
        -- this shouldn't happen.
-   if start_phase /= Ln && start_phase `notElem` pipeline
-       then throwDyn (CmdLineError ("can't find starting phase for "
-                                    ++ filename))
-       else do
-
+   when (start_phase /= Ln && start_phase `notElem` pipeline)
+       (throwDyn (CmdLineError ("can't find starting phase for "
+                                ++ filename)))
        -- if we can't find the phase we're supposed to stop before,
        -- something has gone wrong.  This test carefully avoids the
        -- case where we aren't supposed to do any compilation, because the file
        -- is already in linkable form (for example).
-   if start_phase `elem` pipeline && 
-       (stop_phase /= Ln && stop_phase `notElem` pipeline)
-      then throwDyn (UsageError 
-               ("flag " ++ stop_flag
-                ++ " is incompatible with source file `" ++ filename ++ "'"))
-      else do
-
+   when (start_phase `elem` pipeline && 
+        (stop_phase /= Ln && stop_phase `notElem` pipeline))
+        (throwDyn (UsageError 
+                   ("flag " ++ stop_flag
+                    ++ " is incompatible with source file `" ++ filename ++ "'")))
    let
        -- .o and .hc suffixes can be overriden by command-line options:
       myPhaseInputExt Ln  | Just s <- osuf  = s
@@ -235,6 +239,10 @@ genPipeline todo stop_flag persistent_output lang (filename,suffix)
                             Mangle | keep_raw_s -> Persistent
                             As     | keep_s     -> Persistent
                             HCc    | keep_hc    -> Persistent
+#ifdef ILX
+                            Ilx2Il | keep_ilx   -> Persistent
+                            Ilasm  | keep_il    -> Persistent
+#endif
                             _other              -> Temporary
 
        -- add information about output files to the pipeline
@@ -266,22 +274,37 @@ runPipeline pipeline (input_fn,suffix) do_linking use_ofile
   where (basename, _) = splitFilename input_fn
 
 pipeLoop [] input_fn _ _ _ _ = return input_fn
-pipeLoop ((phase, keep, o_suffix):phases) 
+pipeLoop (all_phases@((phase, keep, o_suffix):phases))
        (input_fn,real_suff) do_linking use_ofile orig_basename orig_suffix
   = do
 
      output_fn <- outputFileName (null phases) keep o_suffix
 
-     mbCarryOn <- run_phase phase orig_basename orig_suffix input_fn output_fn 
+     mbCarryOn <- run_phase phase orig_basename orig_suffix
+                           input_fn output_fn 
        -- sometimes we bail out early, eg. when the compiler's recompilation
        -- checker has determined that recompilation isn't necessary.
      case mbCarryOn of
        Nothing -> do
-             let (_,keep,final_suffix) = last phases
+             let (_,keep,final_suffix) = last all_phases
              ofile <- outputFileName True keep final_suffix
              return (ofile, final_suffix)
           -- carry on ...
-       Just fn -> 
+       Just fn -> do
+               {-
+                 Check to see whether we've reached the end of the
+                 pipeline, but did so with an ineffective last stage.
+                 (i.e., it returned the input_fn as the output filename).
+                 
+                 If we did and the output is persistent, copy the contents
+                 of input_fn into the file where the pipeline's output is
+                 expected to end up.
+               -}
+             atEnd <- finalStage (null phases)
+             when (atEnd && fn == input_fn)
+                  (copy "Saving away compilation pipeline's output"
+                        input_fn
+                        output_fn)
               {-
               Notice that in order to keep the invariant that we can
               determine a compilation pipeline's 'start phase' just
@@ -302,9 +325,14 @@ pipeLoop ((phase, keep, o_suffix):phases)
               pipeLoop phases (fn, o_suffix) do_linking use_ofile
                                orig_basename orig_suffix
   where
+     finalStage lastPhase = do
+       o_file <- readIORef v_Output_file
+       return (lastPhase && not do_linking && use_ofile && isJust o_file)
+
      outputFileName last_phase keep suffix
        = do o_file <- readIORef v_Output_file
-            if last_phase && not do_linking && use_ofile && isJust o_file
+            atEnd  <- finalStage last_phase
+            if atEnd
               then case o_file of 
                       Just s  -> return s
                       Nothing -> error "outputFileName"
@@ -326,9 +354,7 @@ run_phase :: Phase
 
 run_phase Unlit _basename _suff input_fn output_fn
   = do unlit_flags <- getOpts opt_L
-       -- The -h option passes the file name for unlit to put in a #line directive;
-       -- we undosify it so that it doesn't contain backslashes in Windows, which
-       -- would disappear in error messages
+       -- The -h option passes the file name for unlit to put in a #line directive
        SysTools.runUnlit (map SysTools.Option unlit_flags ++
                                  [ SysTools.Option     "-h"
                          , SysTools.Option     input_fn
@@ -369,54 +395,85 @@ run_phase Cpp basename suff input_fn output_fn
                            ++ map SysTools.Option md_c_flags
                            ++ [ SysTools.Option     "-x"
                               , SysTools.Option     "c"
-                              , SysTools.FileOption "" input_fn
+                              , SysTools.Option     input_fn
+       -- We hackily use Option instead of FileOption here, so that the file
+       -- name is not back-slashed on Windows.  cpp is capable of
+       -- dealing with / in filenames, so it works fine.  Furthermore
+       -- if we put in backslashes, cpp outputs #line directives
+       -- with *double* backslashes.   And that in turn means that
+       -- our error messages get double backslashes in them.
+       -- In due course we should arrange that the lexer deals
+       -- with these \\ escapes properly.
                               , SysTools.Option     "-o"
                               , SysTools.FileOption "" output_fn
                               ])
            return (Just output_fn)
 
+-------------------------------------------------------------------------------
+-- HsPp phase 
+run_phase HsPp basename suff input_fn output_fn
+  = do src_opts <- getOptionsFromSource input_fn
+       unhandled_flags <- processArgs dynamic_flags src_opts []
+       checkProcessArgsResult unhandled_flags basename suff
+
+       let orig_fn = basename ++ '.':suff
+       do_pp   <- dynFlag ppFlag
+       if not do_pp then
+           -- no need to preprocess, just pass input file along
+          -- to the next phase of the pipeline.
+          return (Just input_fn)
+       else do
+           hspp_opts      <- getOpts opt_F
+                   hs_src_pp_opts <- readIORef v_Hs_source_pp_opts
+           SysTools.runPp ( [ SysTools.Option     orig_fn
+                            , SysTools.Option     input_fn
+                            , SysTools.FileOption "" output_fn
+                            ] ++
+                            map SysTools.Option hs_src_pp_opts ++
+                            map SysTools.Option hspp_opts
+                          )
+           return (Just output_fn)
+
 -----------------------------------------------------------------------------
 -- MkDependHS phase
 
-run_phase MkDependHS basename suff input_fn output_fn = do 
-   src <- readFile input_fn
-   let (import_sources, import_normals, _) = getImports src
-
-   let orig_fn = basename ++ '.':suff
-   deps_sources <- mapM (findDependency True  orig_fn) import_sources
-   deps_normals <- mapM (findDependency False orig_fn) import_normals
-   let deps = deps_sources ++ deps_normals
-
-   osuf_opt <- readIORef v_Object_suf
-   let osuf = case osuf_opt of
-                       Nothing -> phaseInputExt Ln
-                       Just s  -> s
-
-   extra_suffixes <- readIORef v_Dep_suffixes
-   let suffixes = osuf : map (++ ('_':osuf)) extra_suffixes
-       ofiles = map (\suf -> basename ++ '.':suf) suffixes
-          
-   objs <- mapM odir_ify ofiles
-   
+run_phase MkDependHS basename suff input_fn output_fn 
+ = do src <- readFile input_fn
+      let (import_sources, import_normals, _) = getImports src
+      let orig_fn = basename ++ '.':suff
+      deps_sources <- mapM (findDependency True  orig_fn) import_sources
+      deps_normals <- mapM (findDependency False orig_fn) import_normals
+      let deps = deps_sources ++ deps_normals
+
+      osuf_opt <- readIORef v_Object_suf
+      let osuf = case osuf_opt of
+                  Nothing -> phaseInputExt Ln
+                  Just s  -> s
+
+      extra_suffixes <- readIORef v_Dep_suffixes
+      let suffixes = osuf : map (++ ('_':osuf)) extra_suffixes
+          ofiles = map (\suf -> basename ++ '.':suf) suffixes
+
+      objs <- mapM odir_ify ofiles
+
        -- Handle for file that accumulates dependencies 
-   hdl <- readIORef v_Dep_tmp_hdl
+      hdl <- readIORef v_Dep_tmp_hdl
 
        -- std dependency of the object(s) on the source file
-   hPutStrLn hdl (unwords objs ++ " : " ++ basename ++ '.':suff)
-
-   let genDep (dep, False {- not an hi file -}) = 
-         hPutStrLn hdl (unwords objs ++ " : " ++ dep)
-       genDep (dep, True  {- is an hi file -}) = do
-         hisuf <- readIORef v_Hi_suf
-         let dep_base = remove_suffix '.' dep
-             deps = (dep_base ++ hisuf)
-                    : map (\suf -> dep_base ++ suf ++ '_':hisuf) extra_suffixes
+      hPutStrLn hdl (unwords objs ++ " : " ++ basename ++ '.':suff)
+
+      let genDep (dep, False {- not an hi file -}) = 
+            hPutStrLn hdl (unwords objs ++ " : " ++ dep)
+          genDep (dep, True  {- is an hi file -}) = do
+            hisuf <- readIORef v_Hi_suf
+            let dep_base = remove_suffix '.' dep
+                deps = (dep_base ++ hisuf)
+                       : map (\suf -> dep_base ++ suf ++ '_':hisuf) extra_suffixes
                  -- length objs should be == length deps
-         sequence_ (zipWith (\o d -> hPutStrLn hdl (o ++ " : " ++ d)) objs deps)
+            sequence_ (zipWith (\o d -> hPutStrLn hdl (o ++ " : " ++ d)) objs deps)
 
-   mapM genDep [ d | Just d <- deps ]
-
-   return (Just output_fn)
+      sequence_ (map genDep [ d | Just d <- deps ])
+      return (Just output_fn)
 
 -- add the lines to dep_makefile:
           -- always:
@@ -512,7 +569,7 @@ run_phase Hsc basename suff input_fn output_fn
         let dyn_flags' = dyn_flags { hscOutName = output_fn,
                                     hscStubCOutName = basename ++ "_stub.c",
                                     hscStubHOutName = basename ++ "_stub.h",
-                                    extCoreName = basename ++ ".core" }
+                                    extCoreName = basename ++ ".hcr" }
 
   -- run the compiler!
         pcs <- initPersistentCompilerState
@@ -868,13 +925,8 @@ doLink o_files = do
                      ++ pkg_extra_ld_opts
                      ++ extra_ld_opts
                      ++ if static && not no_hs_main then
-#ifdef LEADING_UNDERSCORE
-                           [ "-u", "_PrelMain_mainIO_closure" ,
-                             "-u", "___init_PrelMain"] 
-#else
-                           [ "-u", prefixUnderscore "PrelMain_mainIO_closure" ,
-                             "-u", prefixUnderscore "__init_PrelMain"] 
-#endif
+                           [ "-u", prefixUnderscore "PrelMain_mainIO_closure",
+                             "-u", prefixUnderscore "__stginit_PrelMain"] 
                         else []))
 
     -- parallel only: move binary to another dir -- HWL
@@ -957,9 +1009,10 @@ preprocess :: FilePath -> IO FilePath
 preprocess filename =
   ASSERT(haskellish_src_file filename) 
   do restoreDynFlags   -- Restore to state of last save
+     let fInfo = (filename, getFileSuffix filename)
      pipeline <- genPipeline (StopBefore Hsc) ("preprocess") False 
-                            defaultHscLang (filename, getFileSuffix filename)
-     (fn,_)   <- runPipeline pipeline (filename,getFileSuffix filename)
+                            defaultHscLang fInfo
+     (fn,_)   <- runPipeline pipeline fInfo
                             False{-no linking-} False{-no -o flag-}
      return fn
 
@@ -1023,6 +1076,9 @@ compile ghci_mode summary source_unchanged have_object
        (basename, _) = splitFilename input_fn
        
    keep_hc <- readIORef v_Keep_hc_files
+#ifdef ILX
+   keep_il <- readIORef v_Keep_il_files
+#endif
    keep_s  <- readIORef v_Keep_s_files
 
    output_fn <- 
@@ -1033,7 +1089,8 @@ compile ghci_mode summary source_unchanged have_object
                   | otherwise -> newTempName (phaseInputExt HCc)
            HscJava             -> newTempName "java" -- ToDo
 #ifdef ILX
-          HscILX              -> return (phaseInputExt Ilx2Il)         
+          HscILX  | keep_il   -> return (basename ++ '.':phaseInputExt Ilasm)
+                   | otherwise -> newTempName (phaseInputExt Ilx2Il)   
 #endif
           HscInterpreted      -> return (error "no output file")
            HscNothing         -> return (error "no output file")
@@ -1041,7 +1098,7 @@ compile ghci_mode summary source_unchanged have_object
    let dyn_flags' = dyn_flags { hscOutName = output_fn,
                                hscStubCOutName = basename ++ "_stub.c",
                                hscStubHOutName = basename ++ "_stub.h",
-                               extCoreName = basename ++ ".core" }
+                               extCoreName = basename ++ ".hcr" }
 
    -- figure out which header files to #include in a generated .hc file
    c_includes <- getPackageCIncludes
@@ -1057,10 +1114,14 @@ compile ghci_mode summary source_unchanged have_object
 
    writeIORef v_HCHeader cc_injects
 
+   -- -no-recomp should also work with --make
+   do_recomp <- readIORef v_Recomp
+   let source_unchanged' = source_unchanged && do_recomp
+
    -- run the compiler
    hsc_result <- hscMain ghci_mode dyn_flags'
                         (ms_mod summary) location
-                        source_unchanged have_object old_iface hst hit pcs
+                        source_unchanged' have_object old_iface hst hit pcs
 
    case hsc_result of
       HscFail pcs -> return (CompErrs pcs)