Copyright	(c) Sergey Vinokurov 2018
License	Apache-2.0 (see LICENSE)
Maintainer	serg.foo@gmail.com
Safe Haskell	Safe-Inferred
Language	GHC2021

Emacs.Module.Errors

Description

This module defines various kinds of exception that this library

Synopsis

data EmacsThrow = EmacsThrow {
- emacsThrowTag :: !(RawValue 'Regular)
- emacsThrowValue :: !(RawValue 'Regular)
- emacsThrowOrigin :: CallStack
}
reportEmacsThrowToEmacs :: Env -> EmacsThrow -> IO (RawValue 'Unknown)
data EmacsSignal = EmacsSignal {
- emacsSignalSym :: !(RawValue 'Unknown)
- emacsSignalData :: !(RawValue 'Regular)
- emacsSignalInfo :: !Text
- emacsSignalOrigin :: CallStack
}
reportEmacsSignalToEmacs :: Env -> EmacsSignal -> IO (RawValue 'Unknown)
data EmacsError = EmacsError {
- emacsErrMsg :: Doc Void
- emacsErrData :: Doc Void
- emacsErrStack :: CallStack
}
mkEmacsError :: WithCallStack => Doc Void -> Doc Void -> EmacsError
reportErrorToEmacs :: Env -> EmacsError -> IO (RawValue 'Unknown)
data EmacsInternalError = EmacsInternalError {
- emacsInternalErrMsg :: Doc Void
- emacsInternalErrStack :: CallStack
}
mkEmacsInternalError :: WithCallStack => Doc Void -> EmacsInternalError
reportInternalErrorToEmacs :: Env -> EmacsInternalError -> IO (RawValue 'Unknown)
data UserError = UserError {
- userErrFunctionName :: Doc Void
- userErrMsg :: Doc Void
- userErrStack :: CallStack
}
mkUserError :: WithCallStack => Doc Void -> Doc Void -> UserError
formatSomeException :: SomeException -> Text
reportAnyErrorToEmacs :: Env -> SomeException -> IO (RawValue 'Unknown)
reportAllErrorsToEmacs :: Env -> IO a -> IO a -> IO a

Documentation

data EmacsThrow Source #

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 'Regular) emacsThrowValue :: !(RawValue 'Regular) emacsThrowOrigin :: CallStack

Instances

Instances details

Exception EmacsThrow Source #
Instance details Defined in Emacs.Module.Errors Methods toException :: EmacsThrow -> SomeException # fromException :: SomeException -> Maybe EmacsThrow # displayException :: EmacsThrow -> String #
Show EmacsThrow Source #
Instance details Defined in Emacs.Module.Errors Methods showsPrec :: Int -> EmacsThrow -> ShowS # show :: EmacsThrow -> String # showList :: [EmacsThrow] -> ShowS #

reportEmacsThrowToEmacs :: Env -> EmacsThrow -> IO (RawValue 'Unknown) Source #

data EmacsSignal Source #

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

Unlikely to be needed when developing Emacs extensions.

Constructors

EmacsSignal
Fields emacsSignalSym :: !(RawValue 'Unknown) emacsSignalData :: !(RawValue 'Regular) emacsSignalInfo :: !Text emacsSignalOrigin :: CallStack

Instances

Instances details

Exception EmacsSignal Source #
Instance details Defined in Emacs.Module.Errors Methods toException :: EmacsSignal -> SomeException # fromException :: SomeException -> Maybe EmacsSignal # displayException :: EmacsSignal -> String #
Show EmacsSignal Source #
Instance details Defined in Emacs.Module.Errors Methods showsPrec :: Int -> EmacsSignal -> ShowS # show :: EmacsSignal -> String # showList :: [EmacsSignal] -> ShowS #

reportEmacsSignalToEmacs :: Env -> EmacsSignal -> IO (RawValue 'Unknown) Source #

data EmacsError Source #

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

Constructors

EmacsError
Fields emacsErrMsg :: Doc Void emacsErrData :: Doc Void emacsErrStack :: CallStack

Instances

Instances details

Exception EmacsError Source #
Instance details Defined in Emacs.Module.Errors Methods toException :: EmacsError -> SomeException # fromException :: SomeException -> Maybe EmacsError # displayException :: EmacsError -> String #
Show EmacsError Source #
Instance details Defined in Emacs.Module.Errors Methods showsPrec :: Int -> EmacsError -> ShowS # show :: EmacsError -> String # showList :: [EmacsError] -> ShowS #
Pretty EmacsError Source #
Instance details Defined in Emacs.Module.Errors Methods pretty :: EmacsError -> Doc ann # prettyList :: [EmacsError] -> Doc ann #

mkEmacsError Source #

Arguments

:: WithCallStack
=> Doc Void	Message
-> Doc Void	Error data from Emacs
-> EmacsError

reportErrorToEmacs :: Env -> EmacsError -> IO (RawValue 'Unknown) Source #

data EmacsInternalError Source #

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

E.g. Emacs returned value not specified in a C enum - cannot really process it in a meaningful way.

Constructors

EmacsInternalError
Fields emacsInternalErrMsg :: Doc Void emacsInternalErrStack :: CallStack

Instances

Instances details

Exception EmacsInternalError Source #
Instance details Defined in Emacs.Module.Errors Methods toException :: EmacsInternalError -> SomeException # fromException :: SomeException -> Maybe EmacsInternalError # displayException :: EmacsInternalError -> String #
Show EmacsInternalError Source #
Instance details Defined in Emacs.Module.Errors Methods showsPrec :: Int -> EmacsInternalError -> ShowS # show :: EmacsInternalError -> String # showList :: [EmacsInternalError] -> ShowS #
Pretty EmacsInternalError Source #
Instance details Defined in Emacs.Module.Errors Methods pretty :: EmacsInternalError -> Doc ann # prettyList :: [EmacsInternalError] -> Doc ann #

mkEmacsInternalError Source #

Arguments

:: WithCallStack
=> Doc Void	Error message
-> EmacsInternalError

reportInternalErrorToEmacs :: Env -> EmacsInternalError -> IO (RawValue 'Unknown) Source #

data UserError Source #

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

Constructors

UserError
Fields userErrFunctionName :: Doc Void userErrMsg :: Doc Void userErrStack :: CallStack

Instances

Instances details

Exception UserError Source #
Instance details Defined in Emacs.Module.Errors Methods toException :: UserError -> SomeException # fromException :: SomeException -> Maybe UserError # displayException :: UserError -> String #
Show UserError Source #
Instance details Defined in Emacs.Module.Errors Methods showsPrec :: Int -> UserError -> ShowS # show :: UserError -> String # showList :: [UserError] -> ShowS #
Pretty UserError Source #
Instance details Defined in Emacs.Module.Errors Methods pretty :: UserError -> Doc ann # prettyList :: [UserError] -> Doc ann #

mkUserError Source #

Arguments

:: WithCallStack
=> Doc Void	Function name
-> Doc Void	Message body
-> UserError

formatSomeException :: SomeException -> Text Source #

reportAnyErrorToEmacs :: Env -> SomeException -> IO (RawValue 'Unknown) Source #

reportAllErrorsToEmacs Source #

Arguments

:: Env
-> IO a	Result to return on error.
-> 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.