[project @ 2003-07-21 15:14:18 by ross]
[ghc-hetmet.git] / ghc / compiler / main / Main.hs
index 5cf7ddf..7da0074 100644 (file)
@@ -1,10 +1,11 @@
-{-# OPTIONS -fno-warn-incomplete-patterns #-}
+{-# OPTIONS -fno-warn-incomplete-patterns -optc-DNON_POSIX_SOURCE #-}
+
 -----------------------------------------------------------------------------
--- $Id: Main.hs,v 1.78 2001/06/29 15:30:49 simonmar Exp $
+-- $Id: Main.hs,v 1.131 2003/07/21 15:14:18 ross Exp $
 --
 -- GHC Driver program
 --
--- (c) Simon Marlow 2000
+-- (c) The University of Glasgow 2002
 --
 -----------------------------------------------------------------------------
 
@@ -17,74 +18,56 @@ module Main (main) where
 
 
 #ifdef GHCI
-import InteractiveUI(ghciWelcomeMsg, interactiveUI)
+import InteractiveUI( ghciWelcomeMsg, interactiveUI )
 #endif
 
 
-import Finder          ( initFinder )
-import CompManager     ( cmInit, cmLoadModule )
+import CompManager     ( cmInit, cmLoadModules, cmDepAnal )
 import HscTypes                ( GhciMode(..) )
 import Config          ( cBooterVersion, cGhcUnregisterised, cProjectVersion )
-import SysTools                ( packageConfigPath, initSysTools, cleanTempFiles )
-import Packages                ( showPackages, mungePackagePaths )
-import ParsePkgConf    ( loadPackageConfig )
-
-import DriverPipeline  ( GhcMode(..), doLink, doMkDLL, genPipeline,
-                         getGhcMode, pipeLoop, v_GhcMode
+import SysTools                ( getPackageConfigPath, initSysTools, cleanTempFiles,
+                         normalisePath )
+import Packages                ( showPackages, getPackageConfigMap, basePackage,
+                         haskell98Package
                        )
-import DriverState     ( buildCoreToDo, buildStgToDo, defaultHscLang,
-                         findBuildTag, getPackageInfo, unregFlags, 
-                         v_Cmdline_libraries, v_Keep_tmp_files, v_Ld_inputs,
+import DriverPipeline  ( staticLink, doMkDLL, runPipeline )
+import DriverState     ( buildCoreToDo, buildStgToDo,
+                         findBuildTag, 
+                         getPackageExtraGhcOpts, unregFlags, 
+                         v_GhcMode, v_GhcModeFlag, GhcMode(..),
+                         v_Keep_tmp_files, v_Ld_inputs, v_Ways, 
                          v_OptLevel, v_Output_file, v_Output_hi, 
-                         v_Package_details, v_Ways, getPackageExtraGhcOpts
+                         readPackageConf, verifyOutputFiles, v_NoLink,
+                         v_Build_tag
                        )
-import DriverFlags     ( dynFlag, buildStaticHscOpts, dynamic_flags,
-                         processArgs, static_flags)
+import DriverFlags     ( buildStaticHscOpts,
+                         dynamic_flags, processArgs, static_flags)
 
 import DriverMkDepend  ( beginMkDependHS, endMkDependHS )
-import DriverPhases    ( Phase(Hsc, HCc), haskellish_src_file, objish_file )
+import DriverPhases    ( isSourceFile )
 
-import DriverUtil      ( add, handle, handleDyn, later, splitFilename,
-                         unknownFlagErr )
-import CmdLineOpts     ( dynFlag, defaultDynFlags, restoreDynFlags,
-                         saveDynFlags, setDynFlags, 
+import DriverUtil      ( add, handle, handleDyn, later, unknownFlagsErr )
+import CmdLineOpts     ( dynFlag, restoreDynFlags,
+                         saveDynFlags, setDynFlags, getDynFlags, dynFlag,
                          DynFlags(..), HscLang(..), v_Static_hsc_opts
                        )
-
+import BasicTypes      ( failed )
 import Outputable
 import Util
-import Panic           ( GhcException(..), panic )
+import Panic           ( GhcException(..), panic, installSignalHandlers )
+
+import DATA_IOREF      ( readIORef, writeIORef )
+import EXCEPTION       ( throwDyn, Exception(..), 
+                         AsyncException(StackOverflow) )
 
 -- Standard Haskell libraries
 import IO
 import Directory       ( doesFileExist )
-import IOExts          ( readIORef, writeIORef )
-import Exception       ( throwDyn, Exception(..) )
 import System          ( getArgs, exitWith, ExitCode(..) )
 import Monad
 import List
 import Maybe
 
-#ifndef mingw32_TARGET_OS
-import Concurrent      ( myThreadId )
-#if __GLASGOW_HASKELL__ < 500
-import Exception        ( raiseInThread )
-#define throwTo  raiseInThread
-#else
-import Exception       ( throwTo )
-#endif
-
-import Posix           ( Handler(Catch), installHandler, sigINT, sigQUIT )
-import Dynamic         ( toDyn )
-#endif
-
-
------------------------------------------------------------------------------
--- Changes:
-
--- * -fglasgow-exts NO LONGER IMPLIES -package lang!!!  (-fglasgow-exts is a
---   dynamic flag whereas -package is a static flag.)
-
 -----------------------------------------------------------------------------
 -- ToDo:
 
@@ -103,7 +86,6 @@ import Dynamic               ( toDyn )
 
 -- No more "Enter your Haskell program, end with ^D (on a line of its own):"
 -- consistency checking removed (may do this properly later)
--- removed -noC
 -- no -Ofile
 
 -----------------------------------------------------------------------------
@@ -112,19 +94,25 @@ import Dynamic             ( toDyn )
 main =
   -- top-level exception handler: any unrecognised exception is a compiler bug.
   handle (\exception -> do
+          hFlush stdout
           case exception of
                -- an IO exception probably isn't our fault, so don't panic
-               IOException _ ->  hPutStr stderr (show exception)
-               _other        ->  hPutStr stderr (show (Panic (show exception)))
+               IOException _ ->  hPutStrLn stderr (show exception)
+               AsyncException StackOverflow ->
+                       hPutStrLn stderr "stack overflow: use +RTS -K<size> \ 
+                                        \to increase it"
+               _other ->  hPutStr stderr (show (Panic (show exception)))
           exitWith (ExitFailure 1)
          ) $ do
 
   -- all error messages are propagated as exceptions
-  handleDyn (\dyn -> case dyn of
-                         PhaseFailed _phase code -> exitWith code
-                         Interrupted -> exitWith (ExitFailure 1)
-                         _ -> do hPutStrLn stderr (show (dyn :: GhcException))
-                                 exitWith (ExitFailure 1)
+  handleDyn (\dyn -> do
+               hFlush stdout
+               case dyn of
+                    PhaseFailed _ code -> exitWith code
+                    Interrupted -> exitWith (ExitFailure 1)
+                    _ -> do hPutStrLn stderr (show (dyn :: GhcException))
+                            exitWith (ExitFailure 1)
            ) $ do
 
    -- make sure we clean up after ourselves
@@ -137,37 +125,19 @@ main =
        -- so there shouldn't be any difficulty if we receive further
        -- signals.
 
-       -- install signal handlers
-#ifndef mingw32_TARGET_OS
-   main_thread <- myThreadId
-   let sig_handler = Catch (throwTo main_thread 
-                               (DynException (toDyn Interrupted)))
-   installHandler sigQUIT sig_handler Nothing 
-   installHandler sigINT  sig_handler Nothing
-#endif
+   installSignalHandlers
 
    argv <- getArgs
    let (minusB_args, argv') = partition (prefixMatch "-B") argv
    top_dir <- initSysTools minusB_args
 
        -- Read the package configuration
-   conf_file        <- packageConfigPath
-   proto_pkg_details <- loadPackageConfig conf_file
-   let pkg_details    = mungePackagePaths top_dir proto_pkg_details
-   writeIORef v_Package_details pkg_details
+   conf_file <- getPackageConfigPath
+   readPackageConf conf_file
 
-       -- find the phase to stop after (i.e. -E, -C, -c, -S flags)
-   (flags2, mode, stop_flag) <- getGhcMode argv'
-   writeIORef v_GhcMode mode
-
-       -- Show the GHCi banner?
-#  ifdef GHCI
-   when (mode == DoInteractive) $
-      hPutStrLn stdout ghciWelcomeMsg
-#  endif
-
-       -- process all the other arguments, and get the source files
-   non_static <- processArgs static_flags flags2 []
+       -- Process all the other arguments, and get the source files
+   non_static <- processArgs static_flags argv' []
+   mode <- readIORef v_GhcMode
 
        -- -O and --interactive are not a good combination
        -- ditto with any kind of way selection
@@ -176,7 +146,7 @@ main =
       do putStr "warning: -O conflicts with --interactive; -O turned off.\n"
          writeIORef v_OptLevel 0
    orig_ways <- readIORef v_Ways
-   when (not (null orig_ways) && mode == DoInteractive) $
+   when (notNull orig_ways && mode == DoInteractive) $
       do throwDyn (UsageError 
                    "--interactive can't be used with -prof, -ticky, -unreg or -smp.")
 
@@ -190,7 +160,7 @@ main =
    extra_non_static <- processArgs static_flags 
                           (unreg_opts ++ way_opts ++ pkg_extra_opts) []
 
-       -- give the static flags to hsc
+       -- Give the static flags to hsc
    static_opts <- buildStaticHscOpts
    writeIORef v_Static_hsc_opts static_opts
 
@@ -203,135 +173,192 @@ main =
    -- set the "global" HscLang.  The HscLang can be further adjusted on a module
    -- by module basis, using only the -fvia-C and -fasm flags.  If the global
    -- HscLang is not HscC or HscAsm, -fvia-C and -fasm have no effect.
-   opt_level  <- readIORef v_OptLevel
-
-
+   dyn_flags <- getDynFlags
+   build_tag <- readIORef v_Build_tag
    let lang = case mode of 
-                StopBefore HCc -> HscC
                 DoInteractive  -> HscInterpreted
-                _other        | opt_level >= 1  -> HscC  -- -O implies -fvia-C 
-                              | otherwise       -> defaultHscLang
-
-   setDynFlags (defaultDynFlags{ coreToDo = core_todo,
-                                stgToDo  = stg_todo,
-                                hscLang  = lang,
-                                -- leave out hscOutName for now
-                                hscOutName = panic "Main.main:hscOutName not set",
-
-                                verbosity = case mode of
-                                               DoInteractive -> 1
-                                               DoMake        -> 1
-                                               _other        -> 0,
-                               })
-
-       -- the rest of the arguments are "dynamic"
-   srcs <- processArgs dynamic_flags (extra_non_static ++ non_static) []
+                _other | build_tag /= "" -> HscC
+                       | otherwise       -> hscLang dyn_flags
+               -- for ways other that the normal way, we must 
+               -- compile via C.
+
+   setDynFlags (dyn_flags{ coreToDo = core_todo,
+                          stgToDo  = stg_todo,
+                          hscLang  = lang,
+                          -- leave out hscOutName for now
+                          hscOutName = panic "Main.main:hscOutName not set",
+                          verbosity = 1
+                       })
+
+       -- The rest of the arguments are "dynamic"
+       -- Leftover ones are presumably files
+   fileish_args <- processArgs dynamic_flags (extra_non_static ++ non_static) []
 
        -- save the "initial DynFlags" away
    saveDynFlags
 
-       -- complain about any unknown flags
-   mapM unknownFlagErr [ f | f@('-':_) <- srcs ]
-
-       -- Display details of the configuration in verbose mode
-   verb <- dynFlag verbosity
-
-   when (verb >= 2) 
-       (do hPutStr stderr "Glasgow Haskell Compiler, Version "
-           hPutStr stderr cProjectVersion
-           hPutStr stderr ", for Haskell 98, compiled by GHC version "
-           hPutStrLn stderr cBooterVersion)
+   let
+    {-
+      We split out the object files (.o, .dll) and add them
+      to v_Ld_inputs for use by the linker.
+
+      The following things should be considered compilation manager inputs:
+
+       - haskell source files (strings ending in .hs, .lhs or other 
+         haskellish extension),
+
+       - module names (not forgetting hierarchical module names),
+
+       - and finally we consider everything not containing a '.' to be
+         a comp manager input, as shorthand for a .hs or .lhs filename.
+
+      Everything else is considered to be a linker object, and passed
+      straight through to the linker.
+    -}
+    looks_like_an_input m =  isSourceFile m 
+                         || looksLikeModuleName m
+                         || '.' `notElem` m
+
+     -- To simplify the handling of filepaths, we normalise all filepaths right 
+     -- away - e.g., for win32 platforms, backslashes are converted
+     -- into forward slashes.
+    normal_fileish_paths = map normalisePath fileish_args
+    (srcs, objs)         = partition looks_like_an_input normal_fileish_paths
+
+   mapM_ (add v_Ld_inputs) objs
+
+       ---------------- Display banners and configuration -----------
+   showBanners mode conf_file static_opts
+
+       ---------------- Final sanity checking -----------
+   checkOptions mode srcs objs
+
+    -- We always link in the base package in
+    -- one-shot linking.  Any other packages
+    -- required must be given using -package
+    -- options on the command-line.
+   let def_hs_pkgs = [basePackage, haskell98Package]
+
+       ---------------- Do the business -----------
+   case mode of
+       DoMake         -> doMake srcs
+                              
+       DoMkDependHS   -> do { beginMkDependHS ; 
+                              compileFiles mode srcs; 
+                              endMkDependHS }
+       StopBefore p   -> do { compileFiles mode srcs; return () }
+       DoMkDLL        -> do { o_files <- compileFiles mode srcs; 
+                              doMkDLL o_files def_hs_pkgs }
+       DoLink         -> do { o_files <- compileFiles mode srcs; 
+                              omit_linking <- readIORef v_NoLink;
+                              when (not omit_linking)
+                                   (staticLink o_files def_hs_pkgs) }
 
-   when (verb >= 2) 
-       (hPutStrLn stderr ("Using package config file: " ++ conf_file))
-
-   when (verb >= 3) 
-       (hPutStrLn stderr ("Hsc static flags: " ++ unwords static_opts))
-
-   showPackages pkg_details
+#ifndef GHCI
+       DoInteractive -> throwDyn (CmdLineError "not built for interactive use")
+#else
+       DoInteractive -> interactiveUI srcs
+#endif
 
-       -- initialise the finder
-   pkg_avails <- getPackageInfo
-   initFinder pkg_avails
+-- -----------------------------------------------------------------------------
+-- Option sanity checks
 
-       -- mkdependHS is special
-   when (mode == DoMkDependHS) beginMkDependHS
+checkOptions :: GhcMode -> [String] -> [String] -> IO ()
+     -- Final sanity checking before kicking off a compilation (pipeline).
+checkOptions mode srcs objs = do
+     -- Complain about any unknown flags
+   let unknown_opts = [ f | f@('-':_) <- srcs ]
+   when (notNull unknown_opts) (unknownFlagsErr unknown_opts)
 
-       -- -ohi sanity checking
-   ohi    <- readIORef v_Output_hi
+       -- -ohi sanity check
+   ohi <- readIORef v_Output_hi
    if (isJust ohi && 
-       (mode == DoMake || mode == DoInteractive || length srcs > 1))
+      (mode == DoMake || mode == DoInteractive || srcs `lengthExceeds` 1))
        then throwDyn (UsageError "-ohi can only be used when compiling a single source file")
        else do
 
-       -- make/interactive require invoking the compilation manager
-   if (mode == DoMake)        then beginMake srcs        else do
-   if (mode == DoInteractive) then beginInteractive srcs else do
-
        -- -o sanity checking
    o_file <- readIORef v_Output_file
-   if (length srcs > 1 && isJust o_file && mode /= DoLink && mode /= DoMkDLL)
+   if (srcs `lengthExceeds` 1 && isJust o_file && mode /= DoLink && mode /= DoMkDLL)
        then throwDyn (UsageError "can't apply -o to multiple source files")
        else do
 
-   if null srcs then throwDyn (UsageError "no input files") else do
+       -- Check that there are some input files (except in the interactive 
+       -- case)
+   if null srcs && null objs && mode /= DoInteractive
+       then throwDyn (UsageError "no input files")
+       else do
 
-   let compileFile src = do
-         restoreDynFlags
+     -- Verify that output files point somewhere sensible.
+   verifyOutputFiles
 
-         exists <- doesFileExist src
-          when (not exists) $ 
-               throwDyn (CmdLineError ("file `" ++ src ++ "' does not exist"))
 
-         -- We compile in two stages, because the file may have an
-         -- OPTIONS pragma that affects the compilation pipeline (eg. -fvia-C)
-         let (basename, suffix) = splitFilename src
+-- -----------------------------------------------------------------------------
+-- Compile files in one-shot mode.
 
-         -- just preprocess (Haskell source only)
-         pp <- if not (haskellish_src_file src) || mode == StopBefore Hsc
-                       then return src else do
-               phases <- genPipeline (StopBefore Hsc) stop_flag
-                           False{-not persistent-} defaultHscLang src
-               pipeLoop phases src False{-no linking-} False{-no -o flag-}
-                       basename suffix
+compileFiles :: GhcMode 
+            -> [String]        -- Source files
+            -> IO [String]     -- Object files
+compileFiles mode srcs = do
+   stop_flag <- readIORef v_GhcModeFlag
+   mapM (compileFile mode stop_flag) srcs
 
-         -- rest of compilation
-         hsc_lang <- dynFlag hscLang
-         phases <- genPipeline mode stop_flag True hsc_lang pp
-         r <- pipeLoop phases pp (mode==DoLink || mode==DoMkDLL) True{-use -o flag-}
-                       basename suffix
-         return r
 
-   o_files <- mapM compileFile srcs
+compileFile mode stop_flag src = do
+   restoreDynFlags
+   
+   exists <- doesFileExist src
+   when (not exists) $ 
+       throwDyn (CmdLineError ("file `" ++ src ++ "' does not exist"))
+   
+   o_file   <- readIORef v_Output_file
+       -- when linking, the -o argument refers to the linker's output. 
+       -- otherwise, we use it as the name for the pipeline's output.
+   let maybe_o_file
+         | mode==DoLink || mode==DoMkDLL  = Nothing
+         | otherwise                      = o_file
 
-   when (mode == DoMkDependHS) endMkDependHS
-   when (mode == DoLink) (doLink o_files)
-   when (mode == DoMkDLL) (doMkDLL o_files)
+   runPipeline mode stop_flag True maybe_o_file src Nothing{-no ModLocation-}
 
 
+-- ----------------------------------------------------------------------------
+-- Run --make mode
 
-beginMake :: [String] -> IO ()
-beginMake fileish_args
-  = do let (objs, mods) = partition objish_file fileish_args
-       mapM (add v_Ld_inputs) objs
+doMake :: [String] -> IO ()
+doMake []    = throwDyn (UsageError "no input files")
+doMake srcs  = do 
+    dflags <- getDynFlags 
+    state  <- cmInit Batch
+    graph  <- cmDepAnal state dflags srcs
+    (_, ok_flag, _) <- cmLoadModules state dflags graph
+    when (failed ok_flag) (exitWith (ExitFailure 1))
+    return ()
 
-       case mods of
-        []    -> throwDyn (UsageError "no input files")
-        mod   -> do state <- cmInit Batch
-                    cmLoadModule state mods
-                    return ()
+-- ---------------------------------------------------------------------------
+-- Various banners and verbosity output.
 
+showBanners :: GhcMode -> FilePath -> [String] -> IO ()
+showBanners mode conf_file static_opts = do
+   verb <- dynFlag verbosity
 
-beginInteractive :: [String] -> IO ()
-#ifndef GHCI
-beginInteractive = throwDyn (CmdLineError "not built for interactive use")
-#else
-beginInteractive fileish_args
-  = do minus_ls <- readIORef v_Cmdline_libraries
+       -- Show the GHCi banner
+#  ifdef GHCI
+   when (mode == DoInteractive && verb >= 1) $
+      hPutStrLn stdout ghciWelcomeMsg
+#  endif
+
+       -- Display details of the configuration in verbose mode
+   when (verb >= 2) 
+       (do hPutStr stderr "Glasgow Haskell Compiler, Version "
+           hPutStr stderr cProjectVersion
+           hPutStr stderr ", for Haskell 98, compiled by GHC version "
+           hPutStrLn stderr cBooterVersion)
 
-       let (objs, mods) = partition objish_file fileish_args
-          libs = map Left objs ++ map Right minus_ls
+   when (verb >= 2) 
+       (hPutStrLn stderr ("Using package config file: " ++ conf_file))
 
-       state <- cmInit Interactive
-       interactiveUI state mods libs
-#endif
+   pkg_details <- getPackageConfigMap
+   showPackages pkg_details
+
+   when (verb >= 3) 
+       (hPutStrLn stderr ("Hsc static flags: " ++ unwords static_opts))