Moduleghc-10.0.0.20260917GHC2024

GHC.Utils.Panic.Plain

Defines a simple exception type and utilities to throw it. The PlainGhcException type is a subset of the GhcException type. It omits the exception constructors that involve pretty-printing via SDoc.

The reason for this is to avoid import cycles / use of boot files. GHC.Utils.Outputable has many transitive dependencies. To throw exceptions from these modules, the functions here can be used without introducing import cycles.

1 type
10 values

Packageghc-10.0.0.20260917
Exports11
LanguageGHC2024
LicenceBSD-3-Clause
SourcePlain.hs

datadata PlainGhcException

This type is very similar to GhcException, but it omits the constructors that involve pretty-printing via SDoc. Due to the implementation of fromException for GhcException, this type can be caught as a GhcException.

Note that this should only be used for throwing exceptions, not for catching, as GhcException will not be converted to this type when catching.

Constructors

PlainSignal Int
Some other fatal signal (SIGHUP,SIGTERM)
PlainUsageError String
Prints the short usage msg after the error
PlainCmdLineError String
A problem with the command line arguments, but don't print usage.
PlainPanic String
The impossible happened.
PlainSorry String
The user tickled something that's known not to work yet, but we're not counting it as a bug.
PlainInstallationError String
An installation problem.
PlainProgramError String
An error in the user's code, probably.

Instances2Show, Exception

Show PlainGhcExceptionDefined in ghc-10.0.0.20260917 · GHC.Utils.Panic.Plain
Exception PlainGhcExceptionDefined in ghc-10.0.0.20260917 · GHC.Utils.Panic.Plain

valueshowPlainGhcException :: PlainGhcException -> ShowS

Append a description of the given exception to this string.

valuepanic :: HasCallStack => String -> a

Panics and asserts.

valuesorry :: HasCallStack => String -> a

Panics and asserts.

valuepgmError :: HasCallStack => String -> a

Panics and asserts.

valuecmdLineError :: String -> a

valuecmdLineErrorIO :: String -> IO a

valueassertPanic :: String -> Int -> a

Throw a failed assertion exception for a given filename and line number.

valueassert :: HasCallStack => Bool -> a -> a

valueassertM :: (HasCallStack, Monad m) => m Bool -> m ()

valuemassert :: (HasCallStack, Applicative m) => Bool -> m ()