group Compiler

Provided By: ferite_compile.c

Description

Not all the compiler functions are documented, this is because they are internal and dont concern anyone but the compiler hackers. If you are a compiler hacker you should not need function descriptions :)

group contents Functions ferite_compile_string(char) - Compile a string with the default search paths ferite_compile_string_with_path(char,char) - Compile a str with the default search paths aswell as an extra set ferite_compile_string_with_script_and_path(FeriteScript,char,char) - Compile a string into a given script object. This allows you to preload the script with data ferite_compiler_keep_native_code() - Tell ferite to keep the native code that is found within the compiled scripts ferite_script_compile(char) - Compile a script with the default search paths ferite_script_compile_with_path(char,char) - Compile a script with the default search paths aswell as an extra set ferite_script_compile_with_script_and_path(FeriteScript,char,char) - Compile a script on disk into a given script object. This allows you to preload the script with data. ferite_script_eval(FeriteScript,char) - This is used to evalutate a string as a script at runtime ferite_script_include(FeriteScript,char) - This is used to include another script at runtime

Functions

function ferite_compile_string Compile a string with the default search paths Declaration:     FeriteScript *ferite_compile_string( char *str ) Parameters:     Parameter #1: char *str - The string to compile Returns:     A script which can either be executed or contains error information

function ferite_compile_string_with_path Compile a str with the default search paths aswell as an extra set Declaration:     FeriteScript *ferite_compile_string_with_path( char *str, char **paths ) Parameters:     Parameter #1: char *str - The script to compile     Parameter #2: char **paths - A NULL terminated array of paths to add during compilation Returns:     A script which can either be executed or contains error information

function ferite_compile_string_with_script_and_path Compile a string into a given script object. This allows you to preload the script with data Declaration:     FeriteScript *ferite_compile_string_with_script_and_path( FeriteScript *script, char *str, char **paths ) Parameters:     Parameter #1: FeriteScript *script - The script to use     Parameter #2: char *str - The script string to compile     Parameter #3: char **paths - A NULL terminated array of paths to add during compliation Returns:     The same script that was passed into the function

function ferite_compiler_keep_native_code Tell ferite to keep the native code that is found within the compiled scripts Declaration:     void ferite_compiler_keep_native_code()

function ferite_script_compile Compile a script with the default search paths Declaration:     FeriteScript *ferite_script_compile( char *filename ) Parameters:     Parameter #1: char *filename - The name of the script to compile Returns:     A script which can either be executed or contains error information

function ferite_script_compile_with_path Compile a script with the default search paths aswell as an extra set Declaration:     FeriteScript *ferite_script_compile_with_path( char *filename, char **paths ) Parameters:     Parameter #1: char *filename - The name of the script to compile     Parameter #2: char **paths - A NULL terminated array of paths to add during compilation Returns:     A script which can either be executed or contains error information

function ferite_script_compile_with_script_and_path Compile a script on disk into a given script object. This allows you to preload the script with data. Declaration:     FeriteScript *ferite_script_compile_with_script_and_path( FeriteScript *script, char *str, char **paths ) Parameters:     Parameter #1: FeriteScript *script - The script to use     Parameter #2: char *filename - The script filename to compile     Parameter #3: char **paths - A NULL terminated array of paths to add during compliation Returns:     The same script that was passed into the function

function ferite_script_eval This is used to evalutate a string as a script at runtime Declaration:     FeriteVariable *ferite_script_eval( FeriteScript *script, char *str ) Parameters:     Parameter #1: FeriteScript *script - The script to include into     Parameter #2: char *str - The string to evaulate Returns:     The value that is returned after executing the 'main' body of the evaluated script

function ferite_script_include This is used to include another script at runtime Declaration:     FeriteVariable *ferite_script_include( FeriteScript *script, char *filename ) Description: This is a runtime equivelent to: uses "foo"; Parameters:     Parameter #1: FeriteScript *script - The script to include into     Parameter #2: char *filename - The name of the script to include Returns:     The value that is returned after executing the 'main' body of the included script

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