%
-% (c) The AQUA Project, Glasgow University, 1994-1995
+% (c) The AQUA Project, Glasgow University, 1994-1998
%
\section[ErrsUtils]{Utilities for error reporting}
\begin{code}
-#include "HsVersions.h"
-
module ErrUtils (
- Error(..), Warning(..), Message(..),
- addErrLoc,
+ ErrMsg, WarnMsg, Message, Messages, errorsFound, warningsFound,
+
addShortErrLocLine, addShortWarnLocLine,
- dontAddErrLoc,
- pprBagOfErrors,
- ghcExit
+ addErrLocHdrLine, dontAddErrLoc,
+
+ printErrorsAndWarnings, pprBagOfErrors, pprBagOfWarnings,
+
+ ghcExit,
+ doIfSet, doIfSet_dyn, dumpIfSet, dumpIfSet_dyn, showPass
) where
-IMP_Ubiq(){-uitous-}
+#include "HsVersions.h"
+
+import Bag ( Bag, bagToList, isEmptyBag )
+import SrcLoc ( SrcLoc, noSrcLoc, isGoodSrcLoc )
+import Util ( sortLt )
+import Outputable
+import CmdLineOpts ( DynFlags, DynFlag(..), dopt )
-import Bag ( bagToList )
-import PprStyle ( PprStyle(..) )
-import Pretty
-import SrcLoc ( mkUnknownSrcLoc, SrcLoc{-instance-} )
+import System ( ExitCode(..), exitWith )
+import IO ( hPutStr, stderr )
\end{code}
\begin{code}
-type Error = PprStyle -> Pretty
-type Warning = PprStyle -> Pretty
-type Message = PprStyle -> Pretty
-
-addErrLoc :: SrcLoc -> String -> Error -> Error
-addErrLoc locn title rest_of_err_msg sty
- = ppHang (ppBesides [ppr PprForUser locn,
- if null title then ppNil else ppStr (": " ++ title),
- ppChar ':'])
- 4 (rest_of_err_msg sty)
-
-addShortErrLocLine, addShortWarnLocLine :: SrcLoc -> Error -> Error
-
-addShortErrLocLine locn rest_of_err_msg sty
- = ppHang (ppBeside (ppr PprForUser locn) (ppChar ':'))
- 4 (rest_of_err_msg sty)
-
-addShortWarnLocLine locn rest_of_err_msg sty
- = ppHang (ppBeside (ppr PprForUser locn) (ppPStr SLIT(":warning:")))
- 4 (rest_of_err_msg sty)
-
-dontAddErrLoc :: String -> Error -> Error
-dontAddErrLoc title rest_of_err_msg sty
- = ppHang (ppBesides [ppStr title, ppChar ':'])
- 4 (rest_of_err_msg sty)
-
-pprBagOfErrors :: PprStyle -> Bag Error -> Pretty
-pprBagOfErrors sty bag_of_errors
- = let pretties = map ( \ e -> e sty ) (bagToList bag_of_errors) in
- ppAboves (map (\ p -> ppAbove ppSP p) pretties)
+type MsgWithLoc = (SrcLoc, SDoc)
+
+type ErrMsg = MsgWithLoc
+type WarnMsg = MsgWithLoc
+type Message = SDoc
+
+addShortErrLocLine :: SrcLoc -> Message -> ErrMsg
+addErrLocHdrLine :: SrcLoc -> Message -> Message -> ErrMsg
+addShortWarnLocLine :: SrcLoc -> Message -> WarnMsg
+
+addShortErrLocLine locn rest_of_err_msg
+ | isGoodSrcLoc locn = (locn, hang (ppr locn <> colon) 4
+ rest_of_err_msg)
+ | otherwise = (locn, rest_of_err_msg)
+
+addErrLocHdrLine locn hdr rest_of_err_msg
+ = ( locn
+ , hang (ppr locn <> colon<+> hdr)
+ 4 rest_of_err_msg
+ )
+
+addShortWarnLocLine locn rest_of_err_msg
+ | isGoodSrcLoc locn = (locn, hang (ppr locn <> colon) 4
+ (ptext SLIT("Warning:") <+> rest_of_err_msg))
+ | otherwise = (locn, rest_of_err_msg)
+
+dontAddErrLoc :: Message -> ErrMsg
+dontAddErrLoc msg = (noSrcLoc, msg)
+
\end{code}
+
\begin{code}
-ghcExit :: Int -> IO ()
+type Messages = (Bag WarnMsg, Bag ErrMsg)
+
+errorsFound :: Messages -> Bool
+errorsFound (warns, errs) = not (isEmptyBag errs)
+
+warningsFound :: Messages -> Bool
+warningsFound (warns, errs) = not (isEmptyBag warns)
+printErrorsAndWarnings :: PrintUnqualified -> Messages -> IO ()
+ -- Don't print any warnings if there are errors
+printErrorsAndWarnings unqual (warns, errs)
+ | no_errs && no_warns = return ()
+ | no_errs = printErrs unqual (pprBagOfWarnings warns)
+ | otherwise = printErrs unqual (pprBagOfErrors errs)
+ where
+ no_warns = isEmptyBag warns
+ no_errs = isEmptyBag errs
+
+pprBagOfErrors :: Bag ErrMsg -> SDoc
+pprBagOfErrors bag_of_errors
+ = vcat [text "" $$ p | (_,p) <- sorted_errs ]
+ where
+ bag_ls = bagToList bag_of_errors
+ sorted_errs = sortLt occ'ed_before bag_ls
+
+ occ'ed_before (a,_) (b,_) = LT == compare a b
+
+pprBagOfWarnings :: Bag WarnMsg -> SDoc
+pprBagOfWarnings bag_of_warns = pprBagOfErrors bag_of_warns
+\end{code}
+
+\begin{code}
+ghcExit :: Int -> IO ()
ghcExit val
- = if val /= 0
- then error "Compilation had errors\n"
- else return ()
+ | val == 0 = exitWith ExitSuccess
+ | otherwise = do hPutStr stderr "\nCompilation had errors\n\n"
+ exitWith (ExitFailure val)
+\end{code}
+
+\begin{code}
+doIfSet :: Bool -> IO () -> IO ()
+doIfSet flag action | flag = action
+ | otherwise = return ()
+
+doIfSet_dyn :: DynFlags -> DynFlag -> IO () -> IO()
+doIfSet_dyn dflags flag action | dopt flag dflags = action
+ | otherwise = return ()
+\end{code}
+
+\begin{code}
+showPass :: DynFlags -> String -> IO ()
+showPass dflags what
+ | dopt Opt_D_show_passes dflags = hPutStr stderr ("*** "++what++":\n")
+ | otherwise = return ()
+
+dumpIfSet :: Bool -> String -> SDoc -> IO ()
+dumpIfSet flag hdr doc
+ | not flag = return ()
+ | otherwise = printDump (dump hdr doc)
+
+dumpIfSet_dyn :: DynFlags -> DynFlag -> String -> SDoc -> IO ()
+dumpIfSet_dyn dflags flag hdr doc
+ | not (dopt flag dflags) = return ()
+ | otherwise = printDump (dump hdr doc)
+
+dump hdr doc
+ = vcat [text "",
+ line <+> text hdr <+> line,
+ doc,
+ text ""]
+ where
+ line = text (take 20 (repeat '='))
\end{code}