GblClosure Struct Reference

#include <gimbal_closure.h>

Inheritance diagram for GblClosure:

Data Fields
union {
GblClosureClass *   pClass
GblBox   base
};
struct {
GblMarshalFn   pFnMarshal
}	private_
Data Fields inherited from GblBox
union {
GblBoxClass *   pClass
GblInstance   base
};
struct {
GblArrayMap *   pFields
volatile uint16_t   refCounter
uint16_t   contextType: 1
uint16_t   constructedInPlace: 1
uint16_t   derivedFlags: 14
}	private_
Data Fields inherited from GblInstance
GblClass *	pClass

Related Symbols
#define	GblClosure_create(...)
Accessor Methods
Methods for reading/writing GblClosure fields
void	GblClosure_setMarshal (GblClosure *pSelf, GblMarshalFn pFnMarshal)
GBL_RESULT	GblClosure_setMetaMarshal (GblClosure *pSelf, GblMarshalFn pFnMeta)
GblBool	GblClosure_hasMarshal (const GblClosure *pSelf)
GblBool	GblClosure_hasMetaMarshal (const GblClosure *pSelf)
Invocation Method(s)
Methods used to invoke the closure
GBL_RESULT	GblClosure_invoke (GblClosure *pSelf, GblVariant *pRetValue, size_t argCount, GblVariant *pArgValues)
Related Symbols inherited from GblBox
GblBox *	GblBox_ref (GblBox *pSelf)
GblRefCount	GblBox_unref (GblBox *pSelf)
GblRefCount	GblBox_refCount (const GblBox *pSelf)
void *	GblBox_userdata (const GblBox *pSelf)
GBL_RESULT	GblBox_setUserdata (GblBox *pSelf, void *pUserdata)
GBL_RESULT	GblBox_setUserDestructor (GblBox *pSelf, GblArrayMapDtorFn pFnUdDtor)
uintptr_t	GblBox_field (const GblBox *pSelf, GblQuark key)
uintptr_t	GblBox_takeField (GblBox *pSelf, GblQuark key)
GblBool	GblBox_clearField (GblBox *pSelf, GblQuark key)
GblBool	GblBox_hasField (const GblBox *pSelf, GblQuark key)
GBL_RESULT	GblBox_setField (GblBox *pSelf, GblQuark key, uintptr_t ud, GblArrayMapDtorFn pFnDtor)
Related Symbols inherited from GblInstance
GblRefCount	GblInstance_destroy (GblInstance *pSelf)
#define	GBL_TYPEOF(self)
#define	GBL_PRIVATE(cType, self)
#define	GBL_PUBLIC(cType, selfPriv)
#define	GBL_TYPECHECK(cType, self)
#define	GBL_CAST(cType, self)
#define	GBL_AS(cType, self)
#define	GBL_CLASSOF(cType, self)
#define	GBL_CLASSOF_AS(cType, self)
#define	GBL_VCALL(cType, method, ...)
#define	GBL_VCALL_DEFAULT(cType, method, ...)
GblBool	GblInstance_check (const GblInstance *pSelf, GblType toType)
GblInstance *	GblInstance_cast (GblInstance *pSelf, GblType toType)
GblInstance *	GblInstance_as (GblInstance *pSelf, GblType toType)
void *	GblInstance_private (const GblInstance *pSelf, GblType base)
GblInstance *	GblInstance_public (const void *pPriv, GblType base)
GblType	GblInstance_typeOf (const GblInstance *pSelf)
size_t	GblInstance_size (const GblInstance *pSelf)
size_t	GblInstance_privateSize (const GblInstance *pSelf)
size_t	GblInstance_totalSize (const GblInstance *pSelf)
GblClass *	GblInstance_class (const GblInstance *pSelf)
GBL_RESULT	GblInstance_swizzleClass (GblInstance *pSelf, GblClass *pClass)
GBL_RESULT	GblInstance_sinkClass (GblInstance *pSelf)
GBL_RESULT	GblInstance_floatClass (GblInstance *pSelf)

Detailed Description

Base instance for all closure types.

A GblClosure represents an abstract generic callback object. It is analogous to a stateful C++ function object, or functor, in that it can contain both a callback method as well as stateful data to operate upon.

All closures have a single entry-point for having their callback logic called, which is GblClosure_invoke(). This calls the closure's "marshal" function, which is responsible for

• validating arguments and return type
• converting arguments into expected format for callback
• calling actual callback or logic
• converting return value back into a GblVariant

As the abstract base closure, there is no underlying language-specific callback state within this class. For calling back into C function pointers, see GblCClosure.

Note

As GblClosure inherits GblBox, it can contain arbitrary language-specific or binding-specific userdata and has reference count semantics.

See also

GblCClosure, GblMarshalFn, gimbal_signal.h

Definition at line 88 of file gimbal_closure.h.

Friends And Related Symbol Documentation

GblClosure_setMarshal()

void GblClosure_setMarshal ( GblClosure *  pSelf, GblMarshalFn  pFnMarshal  )

related

Sets the closure's marshal to the function pointed to by pFnMarshal.

GblClosure_setMetaMarshal()

GBL_RESULT GblClosure_setMetaMarshal ( GblClosure *  pSelf, GblMarshalFn  pFnMeta  )

related

Sets the closure's class's meta marshal to the function pointed to by pFnMeta, swizzling its class.

GblClosure_hasMarshal()

GblBool GblClosure_hasMarshal ( const GblClosure *  pSelf )

related

Returns whether the GblClosure has an instance marshal or not.

GblClosure_hasMetaMarshal()

GblBool GblClosure_hasMetaMarshal ( const GblClosure *  pSelf )

related

Returns whether the GblClosure's class has a meta marshal or not.

GblClosure_invoke()

GBL_RESULT GblClosure_invoke ( GblClosure *  pSelf, GblVariant *  pRetValue, size_t  argCount, GblVariant *  pArgValues  )

related

Invokes the given GblClosure, marshalling args in and a value out as variants.

GblClosure_create

#define GblClosure_create (   ... )

related

Definition at line 147 of file gimbal_closure.h.

Field Documentation

pClass

GblClosureClass* GblClosure::pClass

Pointer to class/vtable structure.

Definition at line 88 of file gimbal_closure.h.

base

GblBox GblClosure::base

Inherited base instance structure.

Definition at line 88 of file gimbal_closure.h.

pFnMarshal

GblMarshalFn GblClosure::pFnMarshal

Per-instance marshal function, private.

Definition at line 90 of file gimbal_closure.h.

---

The documentation for this struct was generated from the following file:

• gimbal_closure.h