Emacs.Module.Errors

This module defines various kinds of exception that this library

Documentation

data EmacsThrow

A Haskell exception used to signal a throw exit performed by an Emacs function.

Unlikely to be needed when developing Emacs extensions.

Constructors

EmacsThrow

Fields

• emacsThrowTag :: !RawValue
• emacsThrowValue :: !RawValue

Instances

Show EmacsThrow

Defined in Emacs.Module.Errors

Methods

showsPrec :: Int -> EmacsThrow -> ShowS

show :: EmacsThrow -> String

showList :: [EmacsThrow] -> ShowS

Exception EmacsThrow

Defined in Emacs.Module.Errors

Methods

toException :: EmacsThrow -> SomeException

fromException :: SomeException -> Maybe EmacsThrow

displayException :: EmacsThrow -> String

reportEmacsThrowToEmacs :: Env -> EmacsThrow -> IO RawValue

data UserError

Error thrown to emacs by Haskell functions when anything goes awry.

Constructors

UserError

Fields

• userErrFunctionName :: Doc Void
• userErrMsg :: Doc Void
• userErrStack :: CallStack

Instances

Show UserError

Defined in Emacs.Module.Errors

Methods

showsPrec :: Int -> UserError -> ShowS

show :: UserError -> String

showList :: [UserError] -> ShowS

Exception UserError

Defined in Emacs.Module.Errors

Methods

toException :: UserError -> SomeException

fromException :: SomeException -> Maybe UserError

displayException :: UserError -> String

Pretty UserError

Defined in Emacs.Module.Errors

Methods

pretty :: UserError -> Doc ann

prettyList :: [UserError] -> Doc ann

mkUserError

Arguments

:: WithCallStack

=> Doc Void

Function name

-> Doc Void

Message body

-> UserError

data EmacsError

A high-level error thrown when an Emacs function fails.

Constructors

EmacsError

Fields

• emacsErrMsg :: Doc Void
• emacsErrData :: Doc Void
• emacsErrStack :: CallStack

Instances

Show EmacsError

Defined in Emacs.Module.Errors

Methods

showsPrec :: Int -> EmacsError -> ShowS

show :: EmacsError -> String

showList :: [EmacsError] -> ShowS

Exception EmacsError

Defined in Emacs.Module.Errors

Methods

toException :: EmacsError -> SomeException

fromException :: SomeException -> Maybe EmacsError

displayException :: EmacsError -> String

Pretty EmacsError

Defined in Emacs.Module.Errors

Methods

pretty :: EmacsError -> Doc ann

prettyList :: [EmacsError] -> Doc ann

mkEmacsError

Arguments

:: WithCallStack

=> Doc Void

Message

-> Doc Void

Error data from Emacs

-> EmacsError

reportErrorToEmacs :: Env -> EmacsError -> IO RawValue

data EmacsInternalError

A low-level error thrown when assumptions of this package are violated and it's not safe to proceed further.

Constructors

EmacsInternalError

Fields

• emacsInternalErrMsg :: Doc Void
• emacsInternalErrStack :: CallStack

Instances

Show EmacsInternalError

Defined in Emacs.Module.Errors

Methods

showsPrec :: Int -> EmacsInternalError -> ShowS

show :: EmacsInternalError -> String

showList :: [EmacsInternalError] -> ShowS

Exception EmacsInternalError

Defined in Emacs.Module.Errors

Methods

toException :: EmacsInternalError -> SomeException

fromException :: SomeException -> Maybe EmacsInternalError

displayException :: EmacsInternalError -> String

Pretty EmacsInternalError

Defined in Emacs.Module.Errors

Methods

pretty :: EmacsInternalError -> Doc ann

prettyList :: [EmacsInternalError] -> Doc ann

mkEmacsInternalError

Arguments

:: WithCallStack

=> Doc Void

Error message

-> EmacsInternalError

reportInternalErrorToEmacs :: Env -> EmacsInternalError -> IO RawValue

formatSomeException :: SomeException -> Text

reportAnyErrorToEmacs :: Env -> SomeException -> IO RawValue

reportAllErrorsToEmacs

Arguments

:: Env

-> IO a

Result to return on error.

-> ((Throws EmacsInternalError, Throws EmacsError, Throws UserError, Throws EmacsThrow) => IO a)

-> IO a

Catch all errors this package might throw in an IO action and make Emacs aware of them.

This is a convenience function intended to be used around exported initialise entry point into an Emacs module.