group Engine Globals

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 attributes
variable ferite_show_debug - A flag to say whether or not we should show debug output
function fmalloc() - Allocate a block of memory
function fcalloc() - Allocate a block of memory and have it zero'd to blk_size blocks
function frealloc() - Reallocate a block of memory to be smaller or bigger
function ffree() - Free a block of memory
function ferite_add_to_gc() - Add an object to the garbage collector
function ferite_check_gc() - Cause a check of the garbage collector
variable ferite_ARGV - This is the arguments that can be passed to a script

Functions
function fmalloc Click to go up to the list
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 fcalloc Click to go up to the list
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 frealloc Click to go up to the list
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

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

function ferite_add_to_gc Click to go up to the list
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 Click to go up to the list
Cause a check of the garbage collector
Declaration:
    void ferite_check_gc( FeriteScript *script )
Parameters:
    Parameter #1: FeriteScript *script - The script

Variables
int ferite_show_debug Click to go up to the list
A flag to say whether or not we should show debug output

FeriteVariable ferite_ARGV Click to go up to the list
This is the arguments that can be passed to a script

Automatically generated at 8:45pm, Wednesday 08 January 2003 by feritedoc.