group Engine Globals

Provided By: ferite_globals.c

Description

This is where the main globals are held. These are used all over the ferite engine and provide useful no-area specific functions.

group contents Functions fcalloc(size_t,size_t) - Allocate a block of memory and have it zero'd to blk_size blocks ferite_add_to_gc(FeriteScript,FeriteObject) - Add an object to the garbage collector ferite_check_gc(FeriteScript) - Cause a check of the garbage collector ffree(void) - Free a block of memory fmalloc(size_t) - Allocate a block of memory frealloc(void,size_t) - Reallocate a block of memory to be smaller or bigger Variables ferite_ARGV - This is the arguments that can be passed to a script ferite_show_debug - A flag to say whether or not we should show debug output

Functions

function fcalloc Allocate a block of memory and have it zero'd to blk_size blocks Declaration:     fcalloc( size_t size, size_t blk_size ) Parameters:     Parameter #1: size_t size - The size of memory to allocate     Parameter #2: size_t blk_size - Size of blocks Returns:     A pointer to the allocated memory

function ferite_add_to_gc Add an object to the garbage collector Declaration:     void ferite_add_to_gc( FeriteScript *script, FeriteObject *obj ) Parameters:     Parameter #1: FeriteScript *script - The script     Parameter #2: FeriteObject *obj - The object to add

function ferite_check_gc Cause a check of the garbage collector Declaration:     void ferite_check_gc( FeriteScript *script ) Parameters:     Parameter #1: FeriteScript *script - The script

function ffree Free a block of memory Declaration:     void ffree( void *ptr ); Parameters:     Parameter #1: void *ptr - The memory to free up

function fmalloc Allocate a block of memory Declaration:     void *fmalloc( size_t size ) Parameters:     Parameter #1: size_t size - The size of the memory required Returns:     A pointer to the allocated memory

function frealloc Reallocate a block of memory to be smaller or bigger Declaration:     void *frealloc( void *ptr, size_t size ) Parameters:     Parameter #1: void *ptr - The memory to resize     Parameter #2: size_t size - The new size of the memory block Returns:     The pointer to the block of memory

Variables

FeriteVariable ferite_ARGV This is the arguments that can be passed to a script

int ferite_show_debug A flag to say whether or not we should show debug output

Automatically generated at 10:58AM, Saturday 14 August 2010 by feritedoc.