Data.Emacs.Module.Value

Documentation

data Value (s :: k)

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.

Instances

MonadEmacs (EmacsM :: k -> Type -> Type) (Value :: k -> Type)

Defined in Emacs.Module.Monad

Methods

makeGlobalRef :: forall (s :: k0). WithCallStack => Value s -> EmacsM s (RawValue 'Pinned)

freeGlobalRef :: forall (s :: k0). WithCallStack => RawValue 'Pinned -> EmacsM s ()

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

nonLocalExitGet :: forall (s :: k0). WithCallStack => EmacsM s (FuncallExit (Value s, Value s))

nonLocalExitSignal :: forall f (s :: k0). (WithCallStack, Foldable f) => Value s -> f (Value s) -> EmacsM s ()

nonLocalExitThrow :: forall (s :: k0). WithCallStack => Value s -> Value s -> EmacsM s ()

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

makeFunction :: forall (req :: Nat) (opt :: Nat) (rest :: Bool) (s :: k0). (WithCallStack, EmacsInvocation req opt rest, GetArities req opt rest) => (forall (s' :: k0). EmacsFunction req opt rest EmacsM Value s') -> Doc -> EmacsM s (Value s)

funcall :: forall f (s :: k0). (WithCallStack, Foldable f) => Value s -> f (Value s) -> EmacsM s (Value s)

funcallPrimitive :: forall f (s :: k0). (WithCallStack, Foldable f) => Value s -> f (Value s) -> EmacsM s (Value s)

funcallPrimitiveUnchecked :: forall f (s :: k0). (WithCallStack, Foldable f) => Value s -> f (Value s) -> EmacsM s (Value s)

intern :: forall (s :: k0). WithCallStack => SymbolName -> EmacsM s (Value s)

typeOf :: forall (s :: k0). WithCallStack => Value s -> EmacsM s (Value s)

isNotNil :: forall (s :: k0). WithCallStack => Value s -> EmacsM s Bool

eq :: forall (s :: k0). WithCallStack => Value s -> Value s -> EmacsM s Bool

extractWideInteger :: forall (s :: k0). WithCallStack => Value s -> EmacsM s Int64

makeWideInteger :: forall (s :: k0). WithCallStack => Int64 -> EmacsM s (Value s)

extractDouble :: forall (s :: k0). WithCallStack => Value s -> EmacsM s Double

makeDouble :: forall (s :: k0). WithCallStack => Double -> EmacsM s (Value s)

extractText :: forall (s :: k0). WithCallStack => Value s -> EmacsM s Text

extractShortByteString :: forall (s :: k0). WithCallStack => Value s -> EmacsM s ShortByteString

makeString :: forall (s :: k0). WithCallStack => ByteString -> EmacsM s (Value s)

makeBinaryString :: forall (s :: k0). WithCallStack => ByteString -> EmacsM s (Value s)

extractUserPtr :: forall (s :: k0) a. WithCallStack => Value s -> EmacsM s (Ptr a)

makeUserPtr :: forall a (s :: k0). WithCallStack => FinalizerPtr a -> Ptr a -> EmacsM s (Value s)

assignUserPtr :: forall (s :: k0) a. WithCallStack => Value s -> Ptr a -> EmacsM s ()

extractUserPtrFinaliser :: forall (s :: k0) a. WithCallStack => Value s -> EmacsM s (FinalizerPtr a)

assignUserPtrFinaliser :: forall (s :: k0) a. WithCallStack => Value s -> FinalizerPtr a -> EmacsM s ()

vecGet :: forall (s :: k0). WithCallStack => Value s -> Int -> EmacsM s (Value s)

unsafeVecGet :: forall (s :: k0). WithCallStack => Value s -> Int -> EmacsM s (Value s)

vecSet :: forall (s :: k0). WithCallStack => Value s -> Int -> Value s -> EmacsM s ()

vecSize :: forall (s :: k0). WithCallStack => Value s -> EmacsM s Int

processInput :: forall (s :: k0). WithCallStack => EmacsM s Result

Vector Vector (Value s')

Defined in Data.Emacs.Module.Value.Internal

Methods

basicUnsafeFreeze :: Mutable Vector s (Value s') -> ST s (Vector (Value s'))

basicUnsafeThaw :: Vector (Value s') -> ST s (Mutable Vector s (Value s'))

basicLength :: Vector (Value s') -> Int

basicUnsafeSlice :: Int -> Int -> Vector (Value s') -> Vector (Value s')

basicUnsafeIndexM :: Vector (Value s') -> Int -> Box (Value s')

basicUnsafeCopy :: Mutable Vector s (Value s') -> Vector (Value s') -> ST s ()

elemseq :: Vector (Value s') -> Value s' -> b -> b

MVector MVector (Value s')

Defined in Data.Emacs.Module.Value.Internal

Methods

basicLength :: MVector s (Value s') -> Int

basicUnsafeSlice :: Int -> Int -> MVector s (Value s') -> MVector s (Value s')

basicOverlaps :: MVector s (Value s') -> MVector s (Value s') -> Bool

basicUnsafeNew :: Int -> ST s (MVector s (Value s'))

basicInitialize :: MVector s (Value s') -> ST s ()

basicUnsafeReplicate :: Int -> Value s' -> ST s (MVector s (Value s'))

basicUnsafeRead :: MVector s (Value s') -> Int -> ST s (Value s')

basicUnsafeWrite :: MVector s (Value s') -> Int -> Value s' -> ST s ()

basicClear :: MVector s (Value s') -> ST s ()

basicSet :: MVector s (Value s') -> Value s' -> ST s ()

basicUnsafeCopy :: MVector s (Value s') -> MVector s (Value s') -> ST s ()

basicUnsafeMove :: MVector s (Value s') -> MVector s (Value s') -> ST s ()

basicUnsafeGrow :: MVector s (Value s') -> Int -> ST s (MVector s (Value s'))

Generic (Value s)

Defined in Data.Emacs.Module.Value.Internal

Associated Types

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

Methods

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

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

Show (Value s)

Defined in Data.Emacs.Module.Value.Internal

Methods

showsPrec :: Int -> Value s -> ShowS

show :: Value s -> String

showList :: [Value s] -> ShowS

NFData (Value s)

Defined in Data.Emacs.Module.Value.Internal

Methods

rnf :: Value s -> ()

GetRawValue (Value s)

Defined in Data.Emacs.Module.GetRawValue

Methods

getRawValue :: Value s -> RawValue 'Regular

Pretty (Value s)

Defined in Data.Emacs.Module.Value.Internal

Methods

pretty :: Value s -> Doc ann

prettyList :: [Value s] -> Doc ann

Prim (Value s)

Defined in Data.Emacs.Module.Value.Internal

Methods

sizeOfType# :: Proxy (Value s) -> Int#

sizeOf# :: Value s -> Int#

alignmentOfType# :: Proxy (Value s) -> Int#

alignment# :: Value s -> Int#

indexByteArray# :: ByteArray# -> Int# -> Value s

readByteArray# :: MutableByteArray# s0 -> Int# -> State# s0 -> (# State# s0, Value s #)

writeByteArray# :: MutableByteArray# s0 -> Int# -> Value s -> State# s0 -> State# s0

setByteArray# :: MutableByteArray# s0 -> Int# -> Int# -> Value s -> State# s0 -> State# s0

indexOffAddr# :: Addr# -> Int# -> Value s

readOffAddr# :: Addr# -> Int# -> State# s0 -> (# State# s0, Value s #)

writeOffAddr# :: Addr# -> Int# -> Value s -> State# s0 -> State# s0

setOffAddr# :: Addr# -> Int# -> Int# -> Value s -> State# s0 -> State# s0

Unbox (Value s')

Defined in Data.Emacs.Module.Value.Internal

newtype MVector s (Value s')

Defined in Data.Emacs.Module.Value.Internal

newtype MVector s (Value s') = MV_Value (MVector s (Value s'))

type Rep (Value s)

Defined in Data.Emacs.Module.Value.Internal

type Rep (Value s)

newtype Vector (Value s')

Defined in Data.Emacs.Module.Value.Internal

newtype Vector (Value s') = V_Value (Vector (Value s'))