Skip to content

obj.h#

Nest Object interface.

Authors#

TheSilvered

Macros#

_Nst_P_LEN_MAX#

Description:

Maximum size for an object pool.

NstOBJ#

Synopsis:

#define NstOBJ(obj)

Description:

Cast obj to Nst_Obj *.

Nst_obj_alloc#

Synopsis:

#define Nst_obj_alloc(type, type_obj)

Description:

Wrapper for _Nst_obj_alloc. type is used to get the size of the object to allocate and to cast the result into the correct pointer type.

Nst_SET_FLAG#

Synopsis:

#define Nst_SET_FLAG(obj, flag)

Description:

Sets flag of obj to true.

Nst_DEL_FLAG#

Synopsis:

#define Nst_DEL_FLAG(obj, flag)

Description:

Sets flag of obj to false.

Nst_HAS_FLAG#

Synopsis:

#define Nst_HAS_FLAG(obj, flag)

Description:

Check if flag is set.

Nst_FLAG#

Synopsis:

#define Nst_FLAG(n)

Description:

Create a flag from an id. n can be between 1 and 28 included.

Nst_CLEAR_FLAGS#

Synopsis:

#define Nst_CLEAR_FLAGS(obj)

Description:

Clear all flags from an object, except for the reserved ones.

Nst_OBJ_HEAD#

Description:

The macro used to make a struct an object.

It must be placed before any other arguments in the struct. Custom flags cannot occupy the four most significant bits of the flags field because they are reserved for the garbage collector.

Type aliases#

Nst_ObjDstr#

Synopsis:

typedef void (*Nst_ObjDstr)(Nst_Obj *)

Description:

The type of an object destructor.

This function, in an object's type, is called when the object is deleted and should free any memory associated with it apart from the object's own memory, which is handled by Nest. This function should also remove any references that the object being deleted has with other objects.

Nst_ObjTrav#

Synopsis:

typedef void (*Nst_ObjTrav)(Nst_Obj *)

Description:

The type of an object traverse function for the garbage collector.

This function is called during a garbage collection and should call the function Nst_ggc_obj_reachable with any object that it directly references. Any indirect references, such as objects within objects, should be left untouched.

Functions#

_Nst_obj_alloc#

Synopsis:

Nst_ObjRef *_Nst_obj_alloc(usize size, Nst_Obj *type)

Description:

Allocates an object on the heap and initializes the fields in Nst_OBJ_HEAD.

Parameters:

  • size: the size in bytes of the memory to allocate
  • type: the type of the object, if it is NULL, the object itself is used as the type

Returns:

The newly allocate object or NULL on failure. The error is set.

Nst_obj_traverse#

Synopsis:

void Nst_obj_traverse(Nst_Obj *obj)

Description:

Traverse an object for the GGC. If the object's type does not have a traverse function, this function does nothing.

Nst_inc_ref#

Synopsis:

Nst_ObjRef *Nst_inc_ref(Nst_Obj *obj)

Description:

Increase the reference count of an object. Returns obj.

Nst_ninc_ref#

Synopsis:

Nst_ObjRef *Nst_ninc_ref(Nst_Obj *obj)

Description:

Call Nst_inc_ref if obj is not a NULL pointer. Returns obj.

Nst_dec_ref#

Synopsis:

void Nst_dec_ref(Nst_ObjRef *obj)

Description:

Decrease the reference count of an object.

Nst_ndec_ref#

Synopsis:

void Nst_ndec_ref(Nst_ObjRef *obj)

Description:

Call Nst_dec_ref if obj is not a NULL pointer.

Enums#

Nst_ObjFlags#

Synopsis:

typedef enum _Nst_ObjFlags {
    Nst_FLAG_OBJ_DESTROYED = Nst_FLAG(29)
} Nst_ObjFlags

Description:

Flags of a Nest object.