Data.Emacs.Module.Value

Documentation

data RawValue

Basic handle on an Emacs value. Can be GC'ed after any call into Emacs. To overcome that, use ValueGC.

Not a real pointer because emacs values are not really pointers. That is, they're completely opaque.

Instances

Storable RawValue

Defined in Data.Emacs.Module.Raw.Value

Methods

sizeOf :: RawValue -> Int

alignment :: RawValue -> Int

peekElemOff :: Ptr RawValue -> Int -> IO RawValue

pokeElemOff :: Ptr RawValue -> Int -> RawValue -> IO ()

peekByteOff :: Ptr b -> Int -> IO RawValue

pokeByteOff :: Ptr b -> Int -> RawValue -> IO ()

peek :: Ptr RawValue -> IO RawValue

poke :: Ptr RawValue -> RawValue -> IO ()

NFData RawValue

Defined in Data.Emacs.Module.Raw.Value

Methods

rnf :: RawValue -> ()

data Value s

Value that is independent of environment (Env) that produced it. Incidentally, this implies that it's "protected" against Emacs GC and thus will not unexpectedly go out of scope.

In order to prevent memory leaks, value is registered in the Emacs monad than produced it and will be freed when the monad finishes. To make the connection clear the value is tagged with parameter s, which serves the same purpose as tag of the ST monad. That is, it ensures that value cannot leave the scope of the monad that produced it.

Constructors

Value

Fields

• valuePayload :: !GlobalRef
• valueReleaseHandle :: !ReleaseKey

Instances

Generic (Value s)

Defined in Data.Emacs.Module.Value.Internal

Associated Types

type Rep (Value s) :: * -> *

Methods

from :: Value s -> Rep (Value s) x

to :: Rep (Value s) x -> Value s

NFData (Value s)

Defined in Data.Emacs.Module.Value.Internal

Methods

rnf :: Value s -> ()

type Rep (Value s)

Defined in Data.Emacs.Module.Value.Internal

type Rep (Value s)