Ivory.Language.Pointer

Generic pointer

Documentation

data Constancy

Constructors

Const

data may not be modified

Mutable

data may be modified

class KnownConstancy c

Minimal complete definition

demoteConstancy

Instances

KnownConstancy Const

Methods

demoteConstancy :: Proxy Constancy Const -> Constancy

KnownConstancy Mutable

Methods

demoteConstancy :: Proxy Constancy Mutable -> Constancy

data Nullability

Constructors

Nullable

may be NULL

Valid

may not be NULL

data Pointer n c s a

Constructors

Pointer

Fields

• getPointer :: Expr

Instances

IvoryAddrOf ConstMemArea ConstRef

Methods

addrOf :: IvoryArea area => ConstMemArea area -> ConstRef Global area

IvoryAddrOf MemArea Ref

Methods

addrOf :: IvoryArea area => MemArea area -> Ref Global area

IvoryRef (Pointer Valid c)

Methods

unwrapRef :: IvoryVar a => Pointer Valid c s (Stored * a) -> Expr

IvoryArea area => IvoryZeroVal (Ptr Global area)

Methods

izeroval :: Init (Stored * (Ptr Global area))

IvoryArea area => IvoryInit (Ptr Global area)

Methods

ival :: Ptr Global area -> Init (Stored * (Ptr Global area))

(KnownNullability n, KnownConstancy c, IvoryArea a) => IvoryExpr (Pointer n c s a)

Methods

wrapExpr :: Expr -> Pointer n c s a

(KnownNullability n, KnownConstancy c, IvoryArea a) => IvoryVar (Pointer n c s a)

Methods

wrapVar :: Var -> Pointer n c s a

unwrapExpr :: Pointer n c s a -> Expr

(KnownNullability n, KnownConstancy c, IvoryArea a) => IvoryType (Pointer n c s a)

Methods

ivoryType :: Proxy * (Pointer n c s a) -> Type

(KnownNullability n, KnownConstancy c, IvoryArea a) => IvoryEq (Pointer n c s a)

Methods

(==?) :: Pointer n c s a -> Pointer n c s a -> IBool

(/=?) :: Pointer n c s a -> Pointer n c s a -> IBool

(KnownConstancy c, IvoryArea a) => IvoryStore (Pointer Nullable c Global a)

nullPtr :: IvoryArea a => Pointer Nullable c s a

pointerCast :: forall s a. (PointerCast n1 c1 n2 c2, IvoryArea a) => Pointer n1 c1 s a -> Pointer n2 c2 s a

pointerCastToConst :: (KnownNullability n, IvoryArea a) => Pointer n Mutable s a -> Pointer n Const s a

pointerCastToNullable :: (KnownConstancy c, IvoryArea a) => Pointer Valid c s a -> Pointer Nullable c s a

unsafePointerCast :: (KnownNullability n1, KnownNullability n2, KnownConstancy c1, KnownConstancy c2, IvoryArea a) => Pointer n1 c1 s a -> Pointer n2 c2 s a

withRef :: (KnownConstancy c, IvoryArea a) => Pointer Nullable c s a -> (Pointer Valid c s a -> Ivory eff t) -> Ivory eff f -> Ivory eff ()

Unwrap a pointer, and use it as a reference.