ErrUtils

ghc-7.10.3: The GHC API

Safe Haskell | None
Language | Haskell2010

ErrUtils

Synopsis

- type MsgDoc = SDoc
- data Validity
  - = IsValid
  - | NotValid MsgDoc
- andValid :: Validity -> Validity -> Validity
- allValid :: [Validity] -> Validity
- isValid :: Validity -> Bool
- getInvalids :: [Validity] -> [MsgDoc]
- data ErrMsg
- type WarnMsg = ErrMsg
- data Severity
  - = SevOutput
  - | SevDump
  - | SevInteractive
  - | SevInfo
  - | SevWarning
  - | SevError
  - | SevFatal
- type Messages = (WarningMessages, ErrorMessages)
- type ErrorMessages = Bag ErrMsg
- type WarningMessages = Bag WarnMsg
- errMsgSpan :: ErrMsg -> SrcSpan
- errMsgContext :: ErrMsg -> PrintUnqualified
- errMsgShortDoc :: ErrMsg -> MsgDoc
- errMsgExtraInfo :: ErrMsg -> MsgDoc
- mkLocMessage :: Severity -> SrcSpan -> MsgDoc -> MsgDoc
- pprMessageBag :: Bag MsgDoc -> SDoc
- pprErrMsgBag :: Bag ErrMsg -> [SDoc]
- pprErrMsgBagWithLoc :: Bag ErrMsg -> [SDoc]
- pprLocErrMsg :: ErrMsg -> SDoc
- makeIntoWarning :: ErrMsg -> ErrMsg
- isWarning :: ErrMsg -> Bool
- errorsFound :: DynFlags -> Messages -> Bool
- emptyMessages :: Messages
- isEmptyMessages :: Messages -> Bool
- mkErrMsg :: DynFlags -> SrcSpan -> PrintUnqualified -> MsgDoc -> ErrMsg
- mkPlainErrMsg :: DynFlags -> SrcSpan -> MsgDoc -> ErrMsg
- mkLongErrMsg :: DynFlags -> SrcSpan -> PrintUnqualified -> MsgDoc -> MsgDoc -> ErrMsg
- mkWarnMsg :: DynFlags -> SrcSpan -> PrintUnqualified -> MsgDoc -> ErrMsg
- mkPlainWarnMsg :: DynFlags -> SrcSpan -> MsgDoc -> ErrMsg
- printBagOfErrors :: DynFlags -> Bag ErrMsg -> IO ()
- warnIsErrorMsg :: DynFlags -> ErrMsg
- mkLongWarnMsg :: DynFlags -> SrcSpan -> PrintUnqualified -> MsgDoc -> MsgDoc -> ErrMsg
- ghcExit :: DynFlags -> Int -> IO ()
- doIfSet :: Bool -> IO () -> IO ()
- doIfSet_dyn :: DynFlags -> GeneralFlag -> IO () -> IO ()
- dumpIfSet :: DynFlags -> Bool -> String -> SDoc -> IO ()
- dumpIfSet_dyn :: DynFlags -> DumpFlag -> String -> SDoc -> IO ()
- dumpIfSet_dyn_printer :: PrintUnqualified -> DynFlags -> DumpFlag -> SDoc -> IO ()
- mkDumpDoc :: String -> SDoc -> SDoc
- dumpSDoc :: DynFlags -> PrintUnqualified -> DumpFlag -> String -> SDoc -> IO ()
- putMsg :: DynFlags -> MsgDoc -> IO ()
- printInfoForUser :: DynFlags -> PrintUnqualified -> MsgDoc -> IO ()
- printOutputForUser :: DynFlags -> PrintUnqualified -> MsgDoc -> IO ()
- logInfo :: DynFlags -> PprStyle -> MsgDoc -> IO ()
- logOutput :: DynFlags -> PprStyle -> MsgDoc -> IO ()
- errorMsg :: DynFlags -> MsgDoc -> IO ()
- warningMsg :: DynFlags -> MsgDoc -> IO ()
- fatalErrorMsg :: DynFlags -> MsgDoc -> IO ()
- fatalErrorMsg' :: LogAction -> DynFlags -> MsgDoc -> IO ()
- fatalErrorMsg'' :: FatalMessager -> String -> IO ()
- compilationProgressMsg :: DynFlags -> String -> IO ()
- showPass :: DynFlags -> String -> IO ()
- debugTraceMsg :: DynFlags -> Int -> MsgDoc -> IO ()
- prettyPrintGhcErrors :: ExceptionMonad m => DynFlags -> m a -> m a

# Documentation

type MsgDoc = SDoc

data Validity

Constructors

IsValid |
NotValid MsgDoc |

andValid :: Validity -> Validity -> Validity

allValid :: [Validity] -> Validity

isValid :: Validity -> Bool

getInvalids :: [Validity] -> [MsgDoc]

data ErrMsg

Instances

Show ErrMsg |

type WarnMsg = ErrMsg

data Severity

Constructors

SevOutput |
SevDump |
SevInteractive |
SevInfo |
SevWarning |
SevError |
SevFatal |

type Messages = (WarningMessages, ErrorMessages)

type ErrorMessages = Bag ErrMsg

type WarningMessages = Bag WarnMsg

errMsgSpan :: ErrMsg -> SrcSpan

errMsgContext :: ErrMsg -> PrintUnqualified

errMsgShortDoc :: ErrMsg -> MsgDoc

errMsgExtraInfo :: ErrMsg -> MsgDoc

mkLocMessage :: Severity -> SrcSpan -> MsgDoc -> MsgDoc

pprMessageBag :: Bag MsgDoc -> SDoc

pprErrMsgBag :: Bag ErrMsg -> [SDoc]

pprErrMsgBagWithLoc :: Bag ErrMsg -> [SDoc]

pprLocErrMsg :: ErrMsg -> SDoc

makeIntoWarning :: ErrMsg -> ErrMsg

isWarning :: ErrMsg -> Bool

errorsFound :: DynFlags -> Messages -> Bool

emptyMessages :: Messages

isEmptyMessages :: Messages -> Bool

mkErrMsg :: DynFlags -> SrcSpan -> PrintUnqualified -> MsgDoc -> ErrMsg

mkPlainErrMsg :: DynFlags -> SrcSpan -> MsgDoc -> ErrMsg

mkLongErrMsg :: DynFlags -> SrcSpan -> PrintUnqualified -> MsgDoc -> MsgDoc -> ErrMsg

mkWarnMsg :: DynFlags -> SrcSpan -> PrintUnqualified -> MsgDoc -> ErrMsg

mkPlainWarnMsg :: DynFlags -> SrcSpan -> MsgDoc -> ErrMsg

printBagOfErrors :: DynFlags -> Bag ErrMsg -> IO ()

warnIsErrorMsg :: DynFlags -> ErrMsg

mkLongWarnMsg :: DynFlags -> SrcSpan -> PrintUnqualified -> MsgDoc -> MsgDoc -> ErrMsg

ghcExit :: DynFlags -> Int -> IO ()

doIfSet :: Bool -> IO () -> IO ()

doIfSet_dyn :: DynFlags -> GeneralFlag -> IO () -> IO ()

dumpIfSet :: DynFlags -> Bool -> String -> SDoc -> IO ()

dumpIfSet_dyn :: DynFlags -> DumpFlag -> String -> SDoc -> IO ()

a wrapper around `dumpSDoc`. First check whether the dump flag is set Do nothing if it is unset

dumpIfSet_dyn_printer :: PrintUnqualified -> DynFlags -> DumpFlag -> SDoc -> IO ()

a wrapper around `dumpSDoc`. First check whether the dump flag is set Do nothing if it is unset

Unlike `dumpIfSet_dyn`, has a printer argument but no header argument

mkDumpDoc :: String -> SDoc -> SDoc

dumpSDoc :: DynFlags -> PrintUnqualified -> DumpFlag -> String -> SDoc -> IO ()

Write out a dump. If --dump-to-file is set then this goes to a file. otherwise emit to stdout.

When hdr is empty, we print in a more compact format (no separators and blank lines)

The DumpFlag is used only to choose the filename to use if --dump-to-file is used; it is not used to decide whether to dump the output

putMsg :: DynFlags -> MsgDoc -> IO ()

printInfoForUser :: DynFlags -> PrintUnqualified -> MsgDoc -> IO ()

printOutputForUser :: DynFlags -> PrintUnqualified -> MsgDoc -> IO ()

logInfo :: DynFlags -> PprStyle -> MsgDoc -> IO ()

logOutput :: DynFlags -> PprStyle -> MsgDoc -> IO ()

errorMsg :: DynFlags -> MsgDoc -> IO ()

warningMsg :: DynFlags -> MsgDoc -> IO ()

fatalErrorMsg :: DynFlags -> MsgDoc -> IO ()

fatalErrorMsg' :: LogAction -> DynFlags -> MsgDoc -> IO ()

fatalErrorMsg'' :: FatalMessager -> String -> IO ()

compilationProgressMsg :: DynFlags -> String -> IO ()

showPass :: DynFlags -> String -> IO ()

debugTraceMsg :: DynFlags -> Int -> MsgDoc -> IO ()

prettyPrintGhcErrors :: ExceptionMonad m => DynFlags -> m a -> m a