Skip to content

function.h#

Func object interface.

Authors#

TheSilvered

Functions#

Nst_func_new_c#

Synopsis:

Nst_ObjRef *Nst_func_new_c(usize arg_num, Nst_NestCallable cbody)

Description:

Create a new function object with a C function body.

Parameters:

  • arg_num: the maximum number of arguments the function accepts
  • cbody: the body of the function

Returns:

The new function object or NULL on failure. The error is set.

Nst_func_arg_num#

Synopsis:

usize Nst_func_arg_num(Nst_Obj *func)

Returns:

The maximum number of arguments a function accepts.

Nst_func_args#

Synopsis:

Nst_Obj **Nst_func_args(Nst_Obj *func)

Returns:

The argument names as a list of objects. If the function has a C body the return value is NULL.

Nst_func_c_body#

Synopsis:

Nst_NestCallable Nst_func_c_body(Nst_Obj *func)

Returns:

The body of a C function wrapper.

Nst_func_nest_body#

Synopsis:

Nst_Bytecode *Nst_func_nest_body(Nst_Obj *func)

Returns:

The body of a Nest function.

Nst_func_mod_globals#

Synopsis:

Nst_Obj *Nst_func_mod_globals(Nst_Obj *func)

Returns:

The _globals_ variable map of a function. No reference is added. It may be NULL.

Nst_func_outer_vars#

Synopsis:

Nst_Obj *Nst_func_outer_vars(Nst_Obj *func)

Returns:

The outer variables that the function can access when defined.

_Nst_func_traverse#

Synopsis:

void _Nst_func_traverse(Nst_Obj *func)

Description:

Nst_ObjTrav function for Func objects.

Enums#

Nst_FuncFlags#

Synopsis:

typedef enum _Nst_FuncFlags {
    Nst_FLAG_FUNC_IS_C = Nst_FLAG(1)
} Nst_FuncFlags

Description:

Flags for Func objects.