XCLE_Mod_parse

XCLE: eXtensible Concatenative Language Engine
Copyright (C) 2000-2006 Yann LANDRIN-SCHWEITZER a.k.a. Varkhan

This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as published
by the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.

This library is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with this library; if not, write to the Free Software Foundation,
Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Author: Yann LANDRIN-SCHWEITZER
Contact: varkhan@varkhan.net
Homepage: http://www.varkhan.net/

Parsing context definition

Function XCLE_ParseCtxAlloc

XCLE_ParseCtx XCLE_ParseCtxAlloc(void) ;
Creates a new parsing context.

Returns:
	_ NULL	: if memory allocation could not be performed
	else a new XCLE_ParseCtx object.

Function XCLE_ParseCtx_DescByName

const char * XCLE_ParseCtx_DescByName(XCLE_ParseCtx contx, char * str) ;
Finds a description for a Code name, looking for a definition in registered tables.

Args:
	_ contx	: parsing context
	_ str	: string to look up in the tables

Returns:
	_ NULL	: if the string or parsing context were NULL, or the string was not found in the tables
	else a Code of name 'str', built from the related definition.

	NOTE:
		Use XCLE_CodeRegister to register instructions before calling XCLE_CodeByName.

Function XCLE_ParseCtx_CodeByName

XCLE_Code XCLE_ParseCtx_CodeByName(XCLE_ParseCtx contx, char * str) ;
Creates a Code object by its name, looking for a definition in registered tables.

Args:
	_ contx	: parsing context
	_ str	: string to look up in the tables

Returns:
	_ NULL	: if the string or parsing context were NULL, or the string was not found in the tables
	else a Code of name 'str', built from the related definition.

	NOTE:
		Use XCLE_CodeRegister to register instructions before calling XCLE_CodeByName.

Registry and Dynamic Loading

Function XCLE_CodeRegister

unsigned long XCLE_CodeRegister(XCLE_ParseCtx contx, char * name, XCLE_CodeDef * table, unsigned long tablesize) ;
Registers a primitives module.

Args:
	_ contx	: parsing context
	_ name	: module name
	_ table	: table of primitives definitions
	_ tablesize	: size of the definitions table

Returns:
	_ -1	: if the parsing context, the module name or the table were NULL
	_ 0	: if the table was empty
	else the number of modules registered.

Errors:
	_ ENOMEM	: if a reallocation failed
	_ EINVAL	: if the context was not properly defined, or the module name was NULL
	_ EINVAL	: if the table was NULL or empty

Function XCLE_CodeUnregister

unsigned long XCLE_CodeUnegister(XCLE_ParseCtx contx, char * name) ;
Unregisters a primitives module.

Args:
	_ contx	: parsing context
	_ name	: module name

Returns:
	_ -1	: if the parsing context or the module name were NULL
	else the number of modules registered.

Errors:
	_ ENOMEM	: if a reallocation failed
	_ EINVAL	: if the context was not properly defined
	_ EINVAL	: if the module name was NULL or could not be found

Function XCLE_CodeLoad

unsigned long XCLE_CodeLoad(XCLE_ParseCtx contx, char * module) ;
Registers instruction definitions from a module file.

Args:
	_ contx	: parsing context
	_ module	: file name of the module

Returns:
	_ -1	: if the parsing context was NULL, or the module was invalid
	else the size of the table.

Errors:
	_ ENOMEM	: if a reallocation failed
	_ ENOENT	: if the module was not found
	_ EINVAL	: if the context was not properly defined or the module structure invalid

NOTE:
	This loading interface asks for two symbol names to be defined in modules (shared
	objects, or dynamically loaded libraries):
	_ unsigned long XCL_Registry_Vers	: a version identifier produced by XCLE_MAKEVERSIONID
	_ unsigned long XCL_Registry_Size	: the number of CodeDef objects defined by the module
	_ XCLE_CodeDef XCL_Registry_Table	: a table of CodeDef objects defining the module contents
	To prevent loading of modules compiled with incompatibles versions of XCLE, the module is
	loaded only if XCL_Registry_Vers matches XCLE_versionid() in their first two bytes.
	Module developers should use the macro XCLE_MAKEVERSIONID with the major, minor and
	release version number of the XCLE library they use to produce XCL_Registry_Vers.

Parsing

Function XCLE_ObjectParse

XCLE_Object XCLE_ObjectParse(XCLE_ParseCtx contx, char * str, unsigned long * off) ;
Creates an object, from a character string object representation.

Args:
	_ contx	: parsing context
	_ str	: string to parse
	_ off	: offset pointer in the string indicating where to begin (or NULL)

Returns:
	_ NULL	: if a syntax error occurred or the end of the string was reached
	else the next parsed XCLE_Object.

Errors:
	_ EINVAL	: if a syntax error occurred
	_ ENOMEM	: if no memory was available

Function XCLE_ListParse

XCLE_List XCLE_ListParse(XCLE_ParseCtx contx, char * str, unsigned long * off) ;
Parses a string into a list of objects.

Args:
	_ contx	: parsing context
	_ str	: string to parse
	_ off	: offset pointer in the string indicating where to begin (or NULL)

Returns:
	_ NULL	: if a syntax error occurred, or no object was found
	else an XCLE_List of all recognised XCLE_Objects.

Errors:
	_ EINVAL	: if a syntax error occurred
	_ ENOMEM	: if no memory was available

Generated by textdoc2html - 2006-02-22