X-Git-Url: http://git.megacz.com/?p=ghc-hetmet.git;a=blobdiff_plain;f=compiler%2Fmain%2FErrUtils.lhs;h=a0a9f0e3b39369000c92402de5aacec901ee3d5e;hp=90e5dc87b6a204cdf98fc6d0f42e377df1527cc9;hb=86add45dbfb6f962b65e371143dd467ae783f9e7;hpb=0065d5ab628975892cea1ec7303f968c3338cbe1 diff --git a/compiler/main/ErrUtils.lhs b/compiler/main/ErrUtils.lhs index 90e5dc8..a0a9f0e 100644 --- a/compiler/main/ErrUtils.lhs +++ b/compiler/main/ErrUtils.lhs @@ -5,21 +5,24 @@ \begin{code} module ErrUtils ( - Message, mkLocMessage, printError, + Message, mkLocMessage, printError, pprMessageBag, Severity(..), ErrMsg, WarnMsg, - errMsgSpans, errMsgContext, errMsgShortDoc, errMsgExtraInfo, + ErrorMessages, WarningMessages, + errMsgSpans, errMsgContext, errMsgShortDoc, errMsgExtraInfo, Messages, errorsFound, emptyMessages, - mkErrMsg, mkWarnMsg, mkPlainErrMsg, mkLongErrMsg, - printErrorsAndWarnings, printBagOfErrors, printBagOfWarnings, + mkErrMsg, mkPlainErrMsg, mkLongErrMsg, mkWarnMsg, mkPlainWarnMsg, + printBagOfErrors, printBagOfWarnings, + warnIsErrorMsg, mkLongWarnMsg, ghcExit, doIfSet, doIfSet_dyn, - dumpIfSet, dumpIfSet_core, dumpIfSet_dyn, dumpIfSet_dyn_or, mkDumpDoc, + dumpIfSet, dumpIfSet_dyn, dumpIfSet_dyn_or, + mkDumpDoc, dumpSDoc, -- * Messages during compilation - putMsg, + putMsg, putMsgWith, errorMsg, fatalErrorMsg, compilationProgressMsg, @@ -30,26 +33,30 @@ module ErrUtils ( #include "HsVersions.h" import Bag ( Bag, bagToList, isEmptyBag, emptyBag ) -import SrcLoc ( SrcSpan ) -import Util ( sortLe, global ) +import Util ( sortLe ) import Outputable -import qualified Pretty -import SrcLoc ( srcSpanStart, noSrcSpan ) +import SrcLoc import DynFlags ( DynFlags(..), DynFlag(..), dopt ) import StaticFlags ( opt_ErrorSpans ) -import System ( ExitCode(..), exitWith ) -import DATA_IOREF -import IO ( hPutStrLn, stderr ) -import DYNAMIC +import System.Exit ( ExitCode(..), exitWith ) +import Data.List +import qualified Data.Set as Set +import Data.IORef +import Control.Monad +import System.IO -- ----------------------------------------------------------------------------- -- Basic error messages: just render a message with a source location. type Message = SDoc +pprMessageBag :: Bag Message -> SDoc +pprMessageBag msgs = vcat (punctuate blankLine (bagToList msgs)) + data Severity - = SevInfo + = SevOutput + | SevInfo | SevWarning | SevError | SevFatal @@ -63,7 +70,8 @@ mkLocMessage locn msg -- would look strange. Better to say explicitly "". printError :: SrcSpan -> Message -> IO () -printError span msg = printErrs (mkLocMessage span msg $ defaultErrStyle) +printError span msg = + printErrs (mkLocMessage span msg) defaultErrStyle -- ----------------------------------------------------------------------------- @@ -76,19 +84,9 @@ data ErrMsg = ErrMsg { 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 - --- 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 + +instance Show ErrMsg where + show em = showSDoc (errMsgShortDoc em) type WarnMsg = ErrMsg @@ -96,72 +94,64 @@ type WarnMsg = ErrMsg -- to qualify names in the message or not. mkErrMsg :: SrcSpan -> PrintUnqualified -> Message -> ErrMsg mkErrMsg locn print_unqual msg - = ErrMsg [locn] print_unqual msg empty + = ErrMsg { errMsgSpans = [locn], errMsgContext = print_unqual + , errMsgShortDoc = msg, errMsgExtraInfo = empty } -- Variant that doesn't care about qualified/unqualified names mkPlainErrMsg :: SrcSpan -> Message -> ErrMsg mkPlainErrMsg locn msg - = ErrMsg [locn] alwaysQualify msg empty + = ErrMsg { errMsgSpans = [locn], errMsgContext = alwaysQualify + , errMsgShortDoc = msg, errMsgExtraInfo = 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 + = ErrMsg { errMsgSpans = [locn], errMsgContext = print_unqual + , errMsgShortDoc = msg, errMsgExtraInfo = extra } mkWarnMsg :: SrcSpan -> PrintUnqualified -> Message -> WarnMsg mkWarnMsg = mkErrMsg +mkLongWarnMsg :: SrcSpan -> PrintUnqualified -> Message -> Message -> ErrMsg +mkLongWarnMsg = mkLongErrMsg + +-- Variant that doesn't care about qualified/unqualified names +mkPlainWarnMsg :: SrcSpan -> Message -> ErrMsg +mkPlainWarnMsg locn msg = mkWarnMsg locn alwaysQualify msg + type Messages = (Bag WarnMsg, Bag ErrMsg) +type WarningMessages = Bag WarnMsg +type ErrorMessages = Bag ErrMsg + emptyMessages :: Messages emptyMessages = (emptyBag, emptyBag) +warnIsErrorMsg :: ErrMsg +warnIsErrorMsg = mkPlainErrMsg noSrcSpan (text "\nFailing due to -Werror.") + 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 :: DynFlags -> Messages -> IO () -printErrorsAndWarnings dflags (warns, errs) - | no_errs && no_warns = return () - | 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 +errorsFound _dflags (_warns, errs) = not (isEmptyBag 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 = sortLe occ'ed_before bag_ls +printBagOfErrors dflags bag_of_errors = + printMsgBag dflags bag_of_errors SevError - occ'ed_before err1 err2 = - case compare (head (errMsgSpans err1)) (head (errMsgSpans err2)) of - LT -> True - EQ -> True - GT -> False +printBagOfWarnings :: DynFlags -> Bag WarnMsg -> IO () +printBagOfWarnings dflags bag_of_warns = + printMsgBag dflags bag_of_warns SevWarning -printBagOfWarnings :: DynFlags -> Bag ErrMsg -> IO () -printBagOfWarnings dflags bag_of_warns +printMsgBag :: DynFlags -> Bag ErrMsg -> Severity -> IO () +printMsgBag dflags bag sev = sequence_ [ let style = mkErrStyle unqual - in log_action dflags SevWarning s style (d $$ e) - | ErrMsg { errMsgSpans = s:ss, + in log_action dflags sev s style (d $$ e) + | ErrMsg { errMsgSpans = s:_, errMsgShortDoc = d, errMsgExtraInfo = e, errMsgContext = unqual } <- sorted_errs ] where - bag_ls = bagToList bag_of_warns + bag_ls = bagToList bag sorted_errs = sortLe occ'ed_before bag_ls occ'ed_before err1 err2 = @@ -169,17 +159,13 @@ 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 () @@ -187,43 +173,103 @@ 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 () | 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 - = printDump (mkDumpDoc hdr doc) + = dumpSDoc dflags flag 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 () +dumpIfSet_dyn_or _ [] _ _ = return () +dumpIfSet_dyn_or dflags (flag : flags) hdr doc + = if dopt flag dflags || verbosity dflags >= 4 + then dumpSDoc dflags flag hdr doc + else dumpIfSet_dyn_or dflags flags hdr doc +mkDumpDoc :: String -> SDoc -> SDoc mkDumpDoc hdr doc - = vcat [text "", + = vcat [blankLine, line <+> text hdr <+> line, doc, - text ""] + blankLine] 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 + let gdref = generatedDumps dflags + gd <- readIORef gdref + let append = Set.member fileName gd + mode = if append then AppendMode else WriteMode + when (not append) $ + writeIORef gdref (Set.insert fileName gd) + handle <- openFile fileName mode + hPrintDump handle doc + hClose handle + + -- write the dump to stdout + Nothing + -> 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 @@ -240,6 +286,12 @@ ifVerbose dflags val act putMsg :: DynFlags -> Message -> IO () putMsg dflags msg = log_action dflags SevInfo noSrcSpan defaultUserStyle msg +putMsgWith :: DynFlags -> PrintUnqualified -> Message -> IO () +putMsgWith dflags print_unqual msg + = log_action dflags SevInfo noSrcSpan sty msg + where + sty = mkUserStyle print_unqual AllTheWay + errorMsg :: DynFlags -> Message -> IO () errorMsg dflags msg = log_action dflags SevError noSrcSpan defaultErrStyle msg @@ -248,7 +300,7 @@ fatalErrorMsg dflags msg = log_action dflags SevFatal noSrcSpan defaultErrStyle compilationProgressMsg :: DynFlags -> String -> IO () compilationProgressMsg dflags msg - = ifVerbose dflags 1 (log_action dflags SevInfo noSrcSpan defaultUserStyle (text msg)) + = ifVerbose dflags 1 (log_action dflags SevOutput noSrcSpan defaultUserStyle (text msg)) showPass :: DynFlags -> String -> IO () showPass dflags what @@ -257,4 +309,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}