X-Git-Url: http://git.megacz.com/?a=blobdiff_plain;f=ghc%2Fcompiler%2Fmain%2FErrUtils.lhs;h=90e5dc87b6a204cdf98fc6d0f42e377df1527cc9;hb=78b72ed1e0ffab668e0d4bb31657942970515e4f;hp=9a04b72583cbf0f1dc3f041c2f5c05eab097e6ab;hpb=9af77fa423926fbda946b31e174173d0ec5ebac8;p=ghc-hetmet.git

diff --git a/ghc/compiler/main/ErrUtils.lhs b/ghc/compiler/main/ErrUtils.lhs
index 9a04b72..90e5dc8 100644
--- a/ghc/compiler/main/ErrUtils.lhs
+++ b/ghc/compiler/main/ErrUtils.lhs
@@ -5,130 +5,177 @@
 
 \begin{code}
 module ErrUtils (
-	ErrMsg, WarnMsg, Message, 
-	Messages, errorsFound, warningsFound, emptyMessages,
+	Message, mkLocMessage, printError,
+	Severity(..),
 
-	addShortErrLocLine, addShortWarnLocLine,
-	addErrLocHdrLine, addWarnLocHdrLine, dontAddErrLoc,
+	ErrMsg, WarnMsg,
+	errMsgSpans, errMsgContext, errMsgShortDoc, errMsgExtraInfo,
+	Messages, errorsFound, emptyMessages,
+	mkErrMsg, mkWarnMsg, mkPlainErrMsg, mkLongErrMsg,
+	printErrorsAndWarnings, printBagOfErrors, printBagOfWarnings,
 
-	printErrorsAndWarnings, pprBagOfErrors, pprBagOfWarnings,
-
-	printError,
 	ghcExit,
 	doIfSet, doIfSet_dyn, 
-	dumpIfSet, dumpIfSet_core, dumpIfSet_dyn, dumpIfSet_dyn_or, mkDumpDoc,
-	showPass
+	dumpIfSet, dumpIfSet_core, dumpIfSet_dyn, dumpIfSet_dyn_or, mkDumpDoc,	
+
+	--  * Messages during compilation
+	putMsg,
+	errorMsg,
+	fatalErrorMsg,
+	compilationProgressMsg,
+	showPass,
+	debugTraceMsg,	
     ) where
 
 #include "HsVersions.h"
 
 import Bag		( Bag, bagToList, isEmptyBag, emptyBag )
-import SrcLoc		( SrcLoc, noSrcLoc, isGoodSrcLoc )
-import Util		( sortLt )
+import SrcLoc		( SrcSpan )
+import Util		( sortLe, global )
 import Outputable
 import qualified Pretty
-import CmdLineOpts	( DynFlags(..), DynFlag(..), dopt )
-
-import List             ( replicate )
+import SrcLoc		( srcSpanStart, noSrcSpan )
+import DynFlags		( DynFlags(..), DynFlag(..), dopt )
+import StaticFlags	( opt_ErrorSpans )
 import System		( ExitCode(..), exitWith )
-import IO		( hPutStr, hPutStrLn, stderr, stdout )
-\end{code}
-
-\begin{code}
-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
+import DATA_IOREF
+import IO		( hPutStrLn, stderr )
+import DYNAMIC
 
-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)
+-- -----------------------------------------------------------------------------
+-- Basic error messages: just render a message with a source location.
 
-dontAddErrLoc :: Message -> ErrMsg
-dontAddErrLoc msg = (noSrcLoc, msg defaultErrStyle)
+type Message = SDoc
 
-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}
+data Severity
+  = SevInfo
+  | SevWarning
+  | SevError
+  | SevFatal
+
+mkLocMessage :: SrcSpan -> Message -> Message
+mkLocMessage locn msg
+  | opt_ErrorSpans = hang (ppr locn <> colon) 4 msg
+  | otherwise      = hang (ppr (srcSpanStart locn) <> colon) 4 msg
+  -- always print the location, even if it is unhelpful.  Error messages
+  -- are supposed to be in a standard format, and one without a location
+  -- would look strange.  Better to say explicitly "<no location info>".
+
+printError :: SrcSpan -> Message -> IO ()
+printError span msg = printErrs (mkLocMessage span msg $ defaultErrStyle)
+
+
+-- -----------------------------------------------------------------------------
+-- Collecting up messages for later ordering and printing.
+
+data ErrMsg = ErrMsg { 
+	errMsgSpans     :: [SrcSpan],
+	errMsgContext   :: PrintUnqualified,
+	errMsgShortDoc  :: Message,
+	errMsgExtraInfo :: Message
+	}
+	-- The SrcSpan 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
 
-\begin{code}
-printError :: String -> IO ()
-printError str = hPutStrLn stderr str
-\end{code}
+-- So we can throw these things as exceptions
+errMsgTc :: TyCon
+errMsgTc = mkTyCon "ErrMsg"
+{-# NOINLINE errMsgTc #-}
+instance Typeable ErrMsg where
+#if __GLASGOW_HASKELL__ < 603
+  typeOf _ = mkAppTy errMsgTc []
+#else
+  typeOf _ = mkTyConApp errMsgTc []
+#endif
+
+type WarnMsg = ErrMsg
+
+-- A short (one-line) error message, with context to tell us whether
+-- to qualify names in the message or not.
+mkErrMsg :: SrcSpan -> PrintUnqualified -> Message -> ErrMsg
+mkErrMsg locn print_unqual msg
+  = ErrMsg [locn] print_unqual msg empty
+
+-- Variant that doesn't care about qualified/unqualified names
+mkPlainErrMsg :: SrcSpan -> Message -> ErrMsg
+mkPlainErrMsg locn msg
+  = ErrMsg [locn] alwaysQualify msg empty
+
+-- A long (multi-line) error message, with context to tell us whether
+-- to qualify names in the message or not.
+mkLongErrMsg :: SrcSpan -> PrintUnqualified -> Message -> Message -> ErrMsg
+mkLongErrMsg locn print_unqual msg extra 
+ = ErrMsg [locn] print_unqual msg extra
+
+mkWarnMsg :: SrcSpan -> PrintUnqualified -> Message -> WarnMsg
+mkWarnMsg = mkErrMsg
 
-\begin{code}
 type Messages = (Bag WarnMsg, Bag ErrMsg)
 
 emptyMessages :: Messages
 emptyMessages = (emptyBag, emptyBag)
 
-errorsFound :: Messages -> Bool
-errorsFound (warns, errs) = not (isEmptyBag errs)
+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)
 
-warningsFound :: Messages -> Bool
-warningsFound (warns, errs) = not (isEmptyBag warns)
-
-printErrorsAndWarnings :: Messages -> IO ()
-	-- Don't print any warnings if there are errors
-printErrorsAndWarnings (warns, errs)
+printErrorsAndWarnings :: DynFlags -> Messages -> IO ()
+printErrorsAndWarnings dflags (warns, errs)
   | no_errs && no_warns  = return ()
-  | no_errs		 = printErrs (pprBagOfWarnings warns)
-  | otherwise		 = printErrs (pprBagOfErrors   errs)
+  | no_errs		 = printBagOfWarnings dflags warns
+			    -- Don't print any warnings if there are errors
+  | otherwise		 = printBagOfErrors   dflags 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 ]
+printBagOfErrors :: DynFlags -> Bag ErrMsg -> IO ()
+printBagOfErrors dflags bag_of_errors
+  = sequence_   [ let style = mkErrStyle unqual
+		  in log_action dflags SevError s style (d $$ e)
+		| ErrMsg { errMsgSpans = s:ss,
+			   errMsgShortDoc = d,
+			   errMsgExtraInfo = e,
+			   errMsgContext = unqual } <- 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
+      sorted_errs = sortLe occ'ed_before bag_ls
+
+      occ'ed_before err1 err2 = 
+         case compare (head (errMsgSpans err1)) (head (errMsgSpans err2)) of
+		LT -> True
+		EQ -> True
+		GT -> False
+
+printBagOfWarnings :: DynFlags -> Bag ErrMsg -> IO ()
+printBagOfWarnings dflags bag_of_warns
+  = sequence_   [ let style = mkErrStyle unqual
+		  in log_action dflags SevWarning s style (d $$ e)
+		| ErrMsg { errMsgSpans = s:ss,
+			   errMsgShortDoc = d,
+			   errMsgExtraInfo = e,
+			   errMsgContext = unqual } <- sorted_errs ]
+    where
+      bag_ls	  = bagToList bag_of_warns
+      sorted_errs = sortLe occ'ed_before bag_ls
+
+      occ'ed_before err1 err2 = 
+         case compare (head (errMsgSpans err1)) (head (errMsgSpans err2)) of
+		LT -> True
+		EQ -> True
+		GT -> False
 \end{code}
 
 \begin{code}
-ghcExit :: Int -> IO ()
-ghcExit val
+ghcExit :: DynFlags -> Int -> IO ()
+ghcExit dflags val
   | val == 0  = exitWith ExitSuccess
-  | otherwise = do hPutStr stderr "\nCompilation had errors\n\n"
+  | otherwise = do errorMsg dflags (text "\nCompilation had errors\n\n")
 	           exitWith (ExitFailure val)
 \end{code}
 
@@ -143,11 +190,6 @@ doIfSet_dyn dflags flag action | dopt flag dflags = action
 \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 ()
@@ -163,9 +205,7 @@ dumpIfSet_core dflags flag hdr doc
 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)
+  = printDump (mkDumpDoc hdr doc)
   | otherwise
   = return ()
 
@@ -183,4 +223,38 @@ mkDumpDoc hdr doc
 	   text ""]
      where 
         line = text (replicate 20 '=')
+
+-- -----------------------------------------------------------------------------
+-- Outputting messages from the compiler
+
+-- We want all messages to go through one place, so that we can
+-- redirect them if necessary.  For example, when GHC is used as a
+-- library we might want to catch all messages that GHC tries to
+-- output and do something else with them.
+
+ifVerbose :: DynFlags -> Int -> IO () -> IO ()
+ifVerbose dflags val act
+  | verbosity dflags >= val = act
+  | otherwise               = return ()
+
+putMsg :: DynFlags -> Message -> IO ()
+putMsg dflags msg = log_action dflags SevInfo noSrcSpan defaultUserStyle msg
+
+errorMsg :: DynFlags -> Message -> IO ()
+errorMsg dflags msg = log_action dflags SevError noSrcSpan defaultErrStyle msg
+
+fatalErrorMsg :: DynFlags -> Message -> IO ()
+fatalErrorMsg dflags msg = log_action dflags SevFatal noSrcSpan defaultErrStyle msg
+
+compilationProgressMsg :: DynFlags -> String -> IO ()
+compilationProgressMsg dflags msg
+  = ifVerbose dflags 1 (log_action dflags SevInfo noSrcSpan defaultUserStyle (text msg))
+
+showPass :: DynFlags -> String -> IO ()
+showPass dflags what 
+  = ifVerbose dflags 2 (log_action dflags SevInfo noSrcSpan defaultUserStyle (text "***" <+> text what <> colon))
+
+debugTraceMsg :: DynFlags -> Int -> Message -> IO ()
+debugTraceMsg dflags val msg
+  = ifVerbose dflags val (log_action dflags SevInfo noSrcSpan defaultDumpStyle msg)
 \end{code}