Add {-# OPTIONS_GHC -w #-} and some blurb to all compiler modules

[ghc-hetmet.git] / compiler / main / ErrUtils.lhs

diff --git a/compiler/main/ErrUtils.lhs b/compiler/main/ErrUtils.lhs
index 42cb314..f89954d 100644 (file)
--- a/compiler/main/ErrUtils.lhs
+++ b/compiler/main/ErrUtils.lhs
@@ -4,6 +4,13 @@
 \section[ErrsUtils]{Utilities for error reporting}
 
 \begin{code}
+{-# OPTIONS_GHC -w #-}
+-- The above warning supression flag is a temporary kludge.
+-- While working on this module you are encouraged to remove it and fix
+-- any warnings in the module. See
+--     http://hackage.haskell.org/trac/ghc/wiki/WorkingConventions#Warnings
+-- for details
+
 module ErrUtils (
        Message, mkLocMessage, printError,
        Severity(..),
@@ -16,7 +23,7 @@ module ErrUtils (
 
        ghcExit,
        doIfSet, doIfSet_dyn, 
-       dumpIfSet, dumpIfSet_core, dumpIfSet_dyn, dumpIfSet_dyn_or, mkDumpDoc,  
+       dumpIfSet, dumpIfSet_core, dumpIfSet_dyn, dumpIfSet_dyn_or, mkDumpDoc, dumpSDoc,
 
        --  * Messages during compilation
        putMsg,
@@ -29,6 +36,7 @@ module ErrUtils (
 
 #include "HsVersions.h"
 
+import Module          ( ModLocation(..))
 import Bag             ( Bag, bagToList, isEmptyBag, emptyBag )
 import SrcLoc          ( SrcSpan )
 import Util            ( sortLe )
@@ -39,7 +47,8 @@ import StaticFlags    ( opt_ErrorSpans )
 
 import System.Exit     ( ExitCode(..), exitWith )
 import Data.Dynamic
-
+import Data.List
+import System.IO
 
 -- -----------------------------------------------------------------------------
 -- Basic error messages: just render a message with a source location.
@@ -167,17 +176,15 @@ printBagOfWarnings dflags bag_of_warns
                LT -> True
                EQ -> True
                GT -> False
-\end{code}
 
-\begin{code}
+
+
 ghcExit :: DynFlags -> Int -> IO ()
 ghcExit dflags val
   | val == 0  = exitWith ExitSuccess
   | otherwise = do errorMsg dflags (text "\nCompilation had errors\n\n")
                   exitWith (ExitFailure val)
-\end{code}
 
-\begin{code}
 doIfSet :: Bool -> IO () -> IO ()
 doIfSet flag action | flag      = action
                    | otherwise = return ()
@@ -185,9 +192,10 @@ doIfSet flag action | flag      = action
 doIfSet_dyn :: DynFlags -> DynFlag -> IO () -> IO()
 doIfSet_dyn dflags flag action | dopt flag dflags = action
                               | otherwise        = return ()
-\end{code}
 
-\begin{code}
+-- -----------------------------------------------------------------------------
+-- Dumping
+
 dumpIfSet :: Bool -> String -> SDoc -> IO ()
 dumpIfSet flag hdr doc
   | not flag   = return ()
@@ -197,13 +205,14 @@ dumpIfSet_core :: DynFlags -> DynFlag -> String -> SDoc -> IO ()
 dumpIfSet_core dflags flag hdr doc
   | dopt flag dflags
        || verbosity dflags >= 4
-       || dopt Opt_D_verbose_core2core dflags  = printDump (mkDumpDoc hdr doc)
+       || dopt Opt_D_verbose_core2core dflags
+  = dumpSDoc dflags flag hdr doc
   | otherwise                                   = return ()
 
 dumpIfSet_dyn :: DynFlags -> DynFlag -> String -> SDoc -> IO ()
 dumpIfSet_dyn dflags flag hdr doc
   | dopt flag dflags || verbosity dflags >= 4 
-  = printDump (mkDumpDoc hdr doc)
+  = dumpSDoc dflags flag hdr doc
   | otherwise
   = return ()
 
@@ -222,6 +231,64 @@ mkDumpDoc hdr doc
      where 
         line = text (replicate 20 '=')
 
+
+-- | Write out a dump.
+--     If --dump-to-file is set then this goes to a file.
+--     otherwise emit to stdout.
+dumpSDoc :: DynFlags -> DynFlag -> String -> SDoc -> IO ()
+dumpSDoc dflags dflag hdr doc
+ = do  let mFile       = chooseDumpFile dflags dflag
+       case mFile of
+               -- write the dump to a file
+               --      don't add the header in this case, we can see what kind
+               --      of dump it is from the filename.
+               Just fileName
+                -> do  handle  <- openFile fileName AppendMode
+                       hPrintDump handle doc
+                       hClose handle
+
+               -- write the dump to stdout
+               Nothing
+                -> do  printDump (mkDumpDoc hdr doc)
+
+
+-- | Choose where to put a dump file based on DynFlags
+--
+chooseDumpFile :: DynFlags -> DynFlag -> Maybe String
+chooseDumpFile dflags dflag
+
+       -- dump file location is being forced
+       --      by the --ddump-file-prefix flag.
+       | dumpToFile
+       , Just prefix   <- dumpPrefixForce dflags
+       = Just $ prefix ++ (beautifyDumpName dflag)
+
+       -- dump file location chosen by DriverPipeline.runPipeline
+       | dumpToFile
+       , Just prefix   <- dumpPrefix dflags
+       = Just $ prefix ++ (beautifyDumpName dflag)
+
+       -- we haven't got a place to put a dump file.
+       | otherwise
+       = Nothing
+
+       where   dumpToFile = dopt Opt_DumpToFile dflags
+
+
+-- | Build a nice file name from name of a DynFlag constructor
+beautifyDumpName :: DynFlag -> String
+beautifyDumpName dflag
+ = let str     = show dflag
+       cut     = if isPrefixOf "Opt_D_" str
+                        then drop 6 str
+                        else str
+       dash    = map   (\c -> case c of
+                               '_'     -> '-'
+                               _       -> c)
+                       cut
+   in  dash
+
+
 -- -----------------------------------------------------------------------------
 -- Outputting messages from the compiler
 
@@ -255,4 +322,5 @@ showPass dflags what
 debugTraceMsg :: DynFlags -> Int -> Message -> IO ()
 debugTraceMsg dflags val msg
   = ifVerbose dflags val (log_action dflags SevInfo noSrcSpan defaultDumpStyle msg)
+
 \end{code}