%
-% (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, emptyMessages,
+
addShortErrLocLine, addShortWarnLocLine,
- dontAddErrLoc,
- pprBagOfErrors,
- ghcExit
+ addErrLocHdrLine, addWarnLocHdrLine, dontAddErrLoc,
+
+ printErrorsAndWarnings, pprBagOfErrors, pprBagOfWarnings,
+
+ printError,
+ ghcExit,
+ doIfSet, doIfSet_dyn,
+ dumpIfSet, dumpIfSet_core, dumpIfSet_dyn, dumpIfSet_dyn_or, mkDumpDoc,
+ showPass
) where
-IMP_Ubiq(){-uitous-}
+#include "HsVersions.h"
-import Bag ( bagToList )
-import PprStyle ( PprStyle(..) )
-import Pretty
-import SrcLoc ( mkUnknownSrcLoc, SrcLoc{-instance-} )
+import Bag ( Bag, bagToList, isEmptyBag, emptyBag )
+import SrcLoc ( SrcLoc, noSrcLoc, isGoodSrcLoc )
+import Util ( sortLt )
+import Outputable
+import qualified Pretty
+import CmdLineOpts ( DynFlags(..), DynFlag(..), dopt )
+
+import List ( replicate )
+import System ( ExitCode(..), exitWith )
+import IO ( hPutStr, hPutStrLn, stderr, stdout )
\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, Pretty.Doc)
+ -- The SrcLoc is used for sorting errors into line-number order
+ -- NB Pretty.Doc not SDoc: we deal with the printing style (in ptic
+ -- whether to qualify an External Name) at the error occurrence
+
+type ErrMsg = MsgWithLoc
+type WarnMsg = MsgWithLoc
+type Message = SDoc
+
+addShortErrLocLine :: SrcLoc -> PrintUnqualified -> Message -> ErrMsg
+addShortWarnLocLine :: SrcLoc -> PrintUnqualified -> Message -> WarnMsg
+ -- Used heavily by renamer/typechecker
+ -- Be refined about qualification, return an ErrMsg
+
+addErrLocHdrLine :: SrcLoc -> Message -> Message -> Message
+addWarnLocHdrLine :: SrcLoc -> Message -> Message -> Message
+ -- Used by Lint and other system stuff
+ -- Always print qualified, return a Message
+
+addShortErrLocLine locn print_unqual msg
+ = (locn, doc (mkErrStyle print_unqual))
+ where
+ doc = mkErrDoc locn msg
+
+addShortWarnLocLine locn print_unqual msg
+ = (locn, doc (mkErrStyle print_unqual))
+ where
+ doc = mkWarnDoc locn msg
+
+addErrLocHdrLine locn hdr msg
+ = mkErrDoc locn (hdr $$ msg)
+
+addWarnLocHdrLine locn hdr msg
+ = mkWarnDoc locn (hdr $$ msg)
+
+dontAddErrLoc :: Message -> ErrMsg
+dontAddErrLoc msg = (noSrcLoc, msg defaultErrStyle)
+
+mkErrDoc locn msg
+ | isGoodSrcLoc locn = hang (ppr locn <> colon) 4 msg
+ | otherwise = msg
+
+mkWarnDoc locn msg
+ | isGoodSrcLoc locn = hang (ppr locn <> colon) 4 warn_msg
+ | otherwise = warn_msg
+ where
+ warn_msg = ptext SLIT("Warning:") <+> msg
\end{code}
\begin{code}
-ghcExit :: Int -> IO ()
+printError :: String -> IO ()
+printError str = hPutStrLn stderr str
+\end{code}
+
+\begin{code}
+type Messages = (Bag WarnMsg, Bag ErrMsg)
+
+emptyMessages :: Messages
+emptyMessages = (emptyBag, emptyBag)
+errorsFound :: DynFlags -> Messages -> Bool
+-- The dyn-flags are used to see if the user has specified
+-- -Werorr, which says that warnings should be fatal
+errorsFound dflags (warns, errs)
+ | dopt Opt_WarnIsError dflags = not (isEmptyBag errs) || not (isEmptyBag warns)
+ | otherwise = not (isEmptyBag errs)
+
+printErrorsAndWarnings :: Messages -> IO ()
+ -- Don't print any warnings if there are errors
+printErrorsAndWarnings (warns, errs)
+ | no_errs && no_warns = return ()
+ | no_errs = printErrs (pprBagOfWarnings warns)
+ | otherwise = printErrs (pprBagOfErrors errs)
+ where
+ no_warns = isEmptyBag warns
+ no_errs = isEmptyBag errs
+
+pprBagOfErrors :: Bag ErrMsg -> Pretty.Doc
+pprBagOfErrors bag_of_errors
+ = Pretty.vcat [Pretty.text "" Pretty.$$ 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 -> Pretty.Doc
+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
+ | verbosity dflags >= 2 = hPutStr stderr ("*** "++what++":\n")
+ | otherwise = return ()
+
+dumpIfSet :: Bool -> String -> SDoc -> IO ()
+dumpIfSet flag hdr doc
+ | not flag = return ()
+ | otherwise = printDump (mkDumpDoc hdr doc)
+
+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)
+ | otherwise = return ()
+
+dumpIfSet_dyn :: DynFlags -> DynFlag -> String -> SDoc -> IO ()
+dumpIfSet_dyn dflags flag hdr doc
+ | dopt flag dflags || verbosity dflags >= 4
+ = if flag `elem` [Opt_D_dump_stix, Opt_D_dump_asm]
+ then printForC stdout (mkDumpDoc hdr doc)
+ else printDump (mkDumpDoc hdr doc)
+ | otherwise
+ = return ()
+
+dumpIfSet_dyn_or :: DynFlags -> [DynFlag] -> String -> SDoc -> IO ()
+dumpIfSet_dyn_or dflags flags hdr doc
+ | or [dopt flag dflags | flag <- flags]
+ || verbosity dflags >= 4
+ = printDump (mkDumpDoc hdr doc)
+ | otherwise = return ()
+
+mkDumpDoc hdr doc
+ = vcat [text "",
+ line <+> text hdr <+> line,
+ doc,
+ text ""]
+ where
+ line = text (replicate 20 '=')
\end{code}