closure.h

Go to the documentation of this file.

#ifndef REDUCT_CLOSURE_H
#define REDUCT_CLOSURE_H 1
 
struct reduct_item;
 
#include <reduct/defs.h>
#include <reduct/function.h>
 
/**
 * @file closure.h
 * @brief Closure management.
 * @defgroup closure Closure
 *
 * A closure is a function instance that has captured variables from its enclosing scope.
 *
 * @{
 */
 
#define REDUCT_CLOSURE_SMALL_MAX 4 ///< The maximum number of small constants.
 
/**
 * @brief Closure structure.
 * @struct reduct_closure_t
 */
typedef struct reduct_closure
{
    reduct_function_t* function; ///< Pointer to the prototype function item.
    size_t constantCount; ///< The number of constants in the constant pool (equal to the number of captured and static
                          ///< constants in the function).
    reduct_handle_t* constants; ///< The array of constants forming the constant pool.
    reduct_handle_t smallConstants[REDUCT_CLOSURE_SMALL_MAX];
} reduct_closure_t;
 
/**
 * @brief Allocate a new closure.
 *
 * @param reduct Pointer to the Reduct structure.
 * @param function The prototype function item.
 * @return A pointer to the newly allocated closure.
 */
REDUCT_API reduct_closure_t* reduct_closure_new(struct reduct* reduct, reduct_function_t* function);
 
/**
 * @brief Retain a closure, preventing it from being collected by the garbage collector.
 *
 * @param reduct Pointer to the Reduct structure.
 * @param closure Pointer to the closure, can be `NULL`.
 */
REDUCT_API void reduct_closure_retain(struct reduct* reduct, reduct_closure_t* closure);
 
/**
 * @brief Release a closure, potentially allowing the garbage collector to collect it.
 *
 * @param reduct Pointer to the Reduct structure.
 * @param closure Pointer to the closure, can be `NULL`.
 */
REDUCT_API void reduct_closure_release(struct reduct* reduct, reduct_closure_t* closure);
 
/** @} */
 
#endif