X-Git-Url: http://git.megacz.com/?p=ghc-hetmet.git;a=blobdiff_plain;f=compiler%2Fmain%2FErrUtils.lhs;h=66ade906fb0c4398a9c9a0f685c772b3280d6d5b;hp=42cb31474d24fe5462ea499f9d0a81f93ff65773;hb=f96194794bf099020706c3816d1a5678b40addbb;hpb=b1ab4b8a607addc4d097588db5761313c996a41f diff --git a/compiler/main/ErrUtils.lhs b/compiler/main/ErrUtils.lhs index 42cb314..66ade90 100644 --- a/compiler/main/ErrUtils.lhs +++ b/compiler/main/ErrUtils.lhs @@ -9,14 +9,16 @@ module ErrUtils ( Severity(..), ErrMsg, WarnMsg, - errMsgSpans, errMsgContext, errMsgShortDoc, errMsgExtraInfo, + ErrorMessages, WarningMessages, Messages, errorsFound, emptyMessages, - mkErrMsg, mkWarnMsg, mkPlainErrMsg, mkLongErrMsg, + mkErrMsg, mkPlainErrMsg, mkLongErrMsg, mkWarnMsg, mkPlainWarnMsg, printErrorsAndWarnings, printBagOfErrors, printBagOfWarnings, + warnIsErrorMsg, mkLongWarnMsg, ghcExit, doIfSet, doIfSet_dyn, - dumpIfSet, dumpIfSet_core, dumpIfSet_dyn, dumpIfSet_dyn_or, mkDumpDoc, + dumpIfSet, dumpIf_core, dumpIfSet_core, dumpIfSet_dyn, dumpIfSet_dyn_or, + mkDumpDoc, dumpSDoc, -- * Messages during compilation putMsg, @@ -30,16 +32,16 @@ module ErrUtils ( #include "HsVersions.h" import Bag ( Bag, bagToList, isEmptyBag, emptyBag ) -import SrcLoc ( SrcSpan ) import Util ( sortLe ) import Outputable -import SrcLoc ( srcSpanStart, noSrcSpan ) +import SrcLoc import DynFlags ( DynFlags(..), DynFlag(..), dopt ) import StaticFlags ( opt_ErrorSpans ) +import Control.Monad 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. @@ -74,19 +76,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 @@ -94,40 +86,59 @@ 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.\n") + errorsFound :: DynFlags -> Messages -> Bool -- The dyn-flags are used to see if the user has specified --- -Werorr, which says that warnings should be fatal +-- -Werror, 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 + | no_errs && no_warns = return () + | no_errs = do printBagOfWarnings dflags warns + when (dopt Opt_WarnIsError dflags) $ + errorMsg dflags $ + text "\nFailing due to -Werror.\n" + -- Don't print any warnings if there are errors + | otherwise = printBagOfErrors dflags errs where no_warns = isEmptyBag warns no_errs = isEmptyBag errs @@ -136,7 +147,7 @@ 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, + | ErrMsg { errMsgSpans = s:_, errMsgShortDoc = d, errMsgExtraInfo = e, errMsgContext = unqual } <- sorted_errs ] @@ -154,7 +165,7 @@ 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, + | ErrMsg { errMsgSpans = s:_, errMsgShortDoc = d, errMsgExtraInfo = e, errMsgContext = unqual } <- sorted_errs ] @@ -167,17 +178,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 () @@ -185,25 +192,32 @@ 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) +dumpIf_core :: Bool -> DynFlags -> DynFlag -> String -> SDoc -> IO () +dumpIf_core cond dflags dflag hdr doc + | cond + || verbosity dflags >= 4 + || dopt Opt_D_verbose_core2core dflags + = dumpSDoc dflags dflag hdr doc + + | otherwise = return () + 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 () + = dumpIf_core (dopt flag dflags) dflags flag hdr doc 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 () @@ -214,14 +228,73 @@ dumpIfSet_dyn_or dflags flags hdr doc = printDump (mkDumpDoc hdr doc) | otherwise = return () +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 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 +328,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}