Emacs.Module.Monad.Class

Documentation

type EmacsFunction req opt rest (s :: k) (m :: k -> Type -> Type) = (Throws EmacsThrow, Throws EmacsError, Throws EmacsInternalError, Throws UserError) => EmacsArgs req opt rest (EmacsRef m s) -> m s (EmacsReturn m s)

Basic Haskell function that can be called by Emacs.

type EmacsFunctionExtra req opt rest extra (s :: k) (m :: k -> Type -> Type) = (Throws EmacsThrow, Throws EmacsError, Throws EmacsInternalError, Throws UserError) => EmacsArgs req opt rest (EmacsRef m s) -> Ptr extra -> m s (EmacsReturn m s)

A Haskell functions that is callable by Emacs.

This type differs from EmacsFunction in that it has an extra parameter which will result in an additional pointer being passed to this function when it's called by Emacs. Contents of the pointer is specified when function is exported to Emacs.

class MonadEmacs (m :: k -> Type -> Type) where

A mtl-style typeclass for interacting with Emacs. Typeclass functions are mostly direct translations of emacs interface provided by 'emacs-module.h'.

For more functions please refer to Emacs.Module.Functions module.

Associated Types

type EmacsRef m :: k -> Type

Emacs value that is managed by the m monad. Will be cleaned up after m finishes its execution.

type EmacsReturn m :: k -> Type

Type of values that Haskell functions may returns to Emacs.

Methods

produceRef :: EmacsRef m s -> m s (EmacsReturn m s)

Return an EmacsRef back to Emacs.

nonLocalExitCheck :: WithCallStack => m s (FuncallExit ())

Check whether a non-local exit is pending.

nonLocalExitGet :: WithCallStack => m s (FuncallExit (EmacsRef m s, EmacsRef m s))

Check whether a non-local exit is pending and get detailed data in case it is.

nonLocalExitSignal

Arguments

:: WithCallStack

=> EmacsRef m s

Error symbol

-> [EmacsRef m s]

Error data, will be converted to a list as Emacs API expects.

-> m s ()

Equivalent to Emacs's signal function.

NB if a non-local exit is alredy pending, this function will not overwrite it. In order to do that, use nonLocalExitClear.

nonLocalExitThrow

Arguments

:: WithCallStack

=> EmacsRef m s

Tag

-> EmacsRef m s

Data

-> m s ()

Equivalent to Emacs's throw function.

NB if a non-local exit is alredy pending, this function will not overwrite it. In order to do that, use nonLocalExitClear.

nonLocalExitClear :: WithCallStack => m s ()

Clean any pending local exits.

freeValue :: WithCallStack => EmacsRef m s -> m s ()

Make value eligible for collection during next GC within Emacs.

makeFunctionExtra

Arguments

:: (WithCallStack, EmacsInvocation req opt rest, GetArities req opt rest)

=> (forall s'. EmacsFunctionExtra req opt rest extra s' m)

Haskell function to export

-> ByteString

Documentation

-> Ptr extra

Extra data to be passed to the Haskell function

-> m s (EmacsRef m s)

Make Haskell function available as an anonymoucs Emacs function. In order to be able to use it later from Emacs it should be fed into bindFunction.

NB Each call to this function produces a small memory leak that will not be freed up. Hence, try not to create unbounded number of functions. This happens because GHC has to generate some wrapping code to convert between ccall and Haskell calling convention each time a function is exported. It is possible to free this code after function will not be used, but it's currently not supported.

funcall

Arguments

:: WithCallStack

=> SymbolName

Function name

-> [EmacsRef m s]

Arguments

-> m s (EmacsRef m s)

Invoke an Emacs function that may call back into Haskell.

funcallPrimitive

Arguments

:: WithCallStack

=> SymbolName

Function name

-> [EmacsRef m s]

Arguments

-> m s (EmacsRef m s)

Invoke an Emacs function. The function should be simple and must not call back into Haskell.

funcallPrimitive_

Arguments

:: WithCallStack

=> SymbolName

Function name

-> [EmacsRef m s]

Arguments

-> m s ()

Invoke an Emacs function and ignore its result. The function should be simple and must not call back into Haskell.

intern :: WithCallStack => SymbolName -> m s (EmacsRef m s)

Convert a string to an Emacs symbol.

typeOf :: WithCallStack => EmacsRef m s -> m s (EmacsRef m s)

Get type of an Emacs value as an Emacs symbol.

isNotNil :: WithCallStack => EmacsRef m s -> m s Bool

Check whether Emacs value is not nil.

eq :: WithCallStack => EmacsRef m s -> EmacsRef m s -> m s Bool

Primitive equality. Tests whether two symbols, integers or characters are the equal, but not much more. For more complete equality comparison do

funcallPrimitive [esym|equal|] [x, y]

extractWideInteger :: WithCallStack => EmacsRef m s -> m s Int64

Try to unpack a wide integer from a value.

makeWideInteger :: WithCallStack => Int64 -> m s (EmacsRef m s)

Pack a wide integer for Emacs.

extractDouble :: WithCallStack => EmacsRef m s -> m s Double

Try to unpack a floating-point number from a value.

makeDouble :: WithCallStack => Double -> m s (EmacsRef m s)

Convert a floating-point number into Emacs value.

extractString :: WithCallStack => EmacsRef m s -> m s ByteString

Extract string contents from an Emacs value.

makeString :: WithCallStack => ByteString -> m s (EmacsRef m s)

Convert a utf8-encoded ByteString into an Emacs value.

extractUserPtr :: WithCallStack => EmacsRef m s -> m s (Ptr a)

Extract a user pointer from an Emacs value.

makeUserPtr

Arguments

:: WithCallStack

=> UserPtrFinaliser a

Finalisation action that will be executed when user pointer gets garbage-collected by Emacs.

-> Ptr a

-> m s (EmacsRef m s)

Pack a user pointer into an Emacs value.

assignUserPtr :: WithCallStack => EmacsRef m s -> Ptr a -> m s ()

Set user pointer to a new value

extractUserPtrFinaliser :: WithCallStack => EmacsRef m s -> m s (UserPtrFinaliser a)

Extract a finaliser from an user_ptr.

assignUserPtrFinaliser :: WithCallStack => EmacsRef m s -> UserPtrFinaliser a -> m s ()

Assign new finaliser into an user_ptr.

vecGet :: WithCallStack => EmacsRef m s -> Int -> m s (EmacsRef m s)

Extract an element from an Emacs vector.

vecSet

Arguments

:: WithCallStack

=> EmacsRef m s

Vector

-> Int

Index

-> EmacsRef m s

New value

-> m s ()

Assign an element into an Emacs vector.

vecSize :: WithCallStack => EmacsRef m s -> m s Int

Get size of an Emacs vector.

Instances

(Throws EmacsThrow, Throws EmacsError, Throws EmacsInternalError) => MonadEmacs EmacsM

Defined in Emacs.Module.Monad

Associated Types

type EmacsRef EmacsM :: k -> Type

type EmacsReturn EmacsM :: k -> Type

Methods

produceRef :: forall (s :: k). EmacsRef EmacsM s -> EmacsM s (EmacsReturn EmacsM s)

nonLocalExitCheck :: forall (s :: k). WithCallStack => EmacsM s (FuncallExit ())

nonLocalExitGet :: forall (s :: k). WithCallStack => EmacsM s (FuncallExit (EmacsRef EmacsM s, EmacsRef EmacsM s))

nonLocalExitSignal :: forall (s :: k). WithCallStack => EmacsRef EmacsM s -> [EmacsRef EmacsM s] -> EmacsM s ()

nonLocalExitThrow :: forall (s :: k). WithCallStack => EmacsRef EmacsM s -> EmacsRef EmacsM s -> EmacsM s ()

nonLocalExitClear :: forall (s :: k). WithCallStack => EmacsM s ()

freeValue :: forall (s :: k). WithCallStack => EmacsRef EmacsM s -> EmacsM s ()

makeFunctionExtra :: forall (req :: Nat) (opt :: Nat) (rest :: Bool) extra (s :: k). (WithCallStack, EmacsInvocation req opt rest, GetArities req opt rest) => (forall (s' :: k). EmacsFunctionExtra req opt rest extra s' EmacsM) -> ByteString -> Ptr extra -> EmacsM s (EmacsRef EmacsM s)

funcall :: forall (s :: k). WithCallStack => SymbolName -> [EmacsRef EmacsM s] -> EmacsM s (EmacsRef EmacsM s)

funcallPrimitive :: forall (s :: k). WithCallStack => SymbolName -> [EmacsRef EmacsM s] -> EmacsM s (EmacsRef EmacsM s)

funcallPrimitive_ :: forall (s :: k). WithCallStack => SymbolName -> [EmacsRef EmacsM s] -> EmacsM s ()

intern :: forall (s :: k). WithCallStack => SymbolName -> EmacsM s (EmacsRef EmacsM s)

typeOf :: forall (s :: k). WithCallStack => EmacsRef EmacsM s -> EmacsM s (EmacsRef EmacsM s)

isNotNil :: forall (s :: k). WithCallStack => EmacsRef EmacsM s -> EmacsM s Bool

eq :: forall (s :: k). WithCallStack => EmacsRef EmacsM s -> EmacsRef EmacsM s -> EmacsM s Bool

extractWideInteger :: forall (s :: k). WithCallStack => EmacsRef EmacsM s -> EmacsM s Int64

makeWideInteger :: forall (s :: k). WithCallStack => Int64 -> EmacsM s (EmacsRef EmacsM s)

extractDouble :: forall (s :: k). WithCallStack => EmacsRef EmacsM s -> EmacsM s Double

makeDouble :: forall (s :: k). WithCallStack => Double -> EmacsM s (EmacsRef EmacsM s)

extractString :: forall (s :: k). WithCallStack => EmacsRef EmacsM s -> EmacsM s ByteString

makeString :: forall (s :: k). WithCallStack => ByteString -> EmacsM s (EmacsRef EmacsM s)

extractUserPtr :: forall (s :: k) a. WithCallStack => EmacsRef EmacsM s -> EmacsM s (Ptr a)

makeUserPtr :: forall a (s :: k). WithCallStack => UserPtrFinaliser a -> Ptr a -> EmacsM s (EmacsRef EmacsM s)

assignUserPtr :: forall (s :: k) a. WithCallStack => EmacsRef EmacsM s -> Ptr a -> EmacsM s ()

extractUserPtrFinaliser :: forall (s :: k) a. WithCallStack => EmacsRef EmacsM s -> EmacsM s (UserPtrFinaliser a)

assignUserPtrFinaliser :: forall (s :: k) a. WithCallStack => EmacsRef EmacsM s -> UserPtrFinaliser a -> EmacsM s ()

vecGet :: forall (s :: k). WithCallStack => EmacsRef EmacsM s -> Int -> EmacsM s (EmacsRef EmacsM s)

vecSet :: forall (s :: k). WithCallStack => EmacsRef EmacsM s -> Int -> EmacsRef EmacsM s -> EmacsM s ()

vecSize :: forall (s :: k). WithCallStack => EmacsRef EmacsM s -> EmacsM s Int