An instance of the runtime interpreter. More...

#include <ccscript.h>

Inheritance diagram for ucommon::Script::interp:

Collaboration diagram for ucommon::Script::interp:

Public Types
typedef char	num_t [16]

Public Member Functions
	interp ()

virtual	~interp ()

bool	step (void)
	Step through an instance of the interpreter. More...

bool	attach (Script image, const char entry=NULL)
	Attach a compiled image to the interpreter and start. More...

void	detach (void)
	Cleanup after interpreter run. More...

void	initialize (void)
	Used to initialize and purge the interpreter between runs. More...

bool	error (const char *text)
	Invoke runtime interpreter error handling. More...

unsigned	getResource (void)
	Get current dsp resource mask. More...

const char *	getFilename (void)
	Get effective filename of base. More...

Protected Member Functions
symbol *	find (const char *id)

void	skip (void)

void	push (void)

bool	trylabel (const char *id)

bool	tryexit (void)

void	pullScope (void)

void	pullBase (void)

void	pullLoop (void)

bool	pop (void)

void	setStack (header scr, event ev=NULL)

bool	scriptEvent (const char *name)
	Try to branch to a named event handler. More...

event *	scriptMethod (const char *name)
	Search for an event object in the method table. More...

char *	getTemp (void)

bool	setConst (const char id, const char value)

symbol *	createSymbol (const char *id)

symbol *	getVar (const char id, const char value=NULL)

const char *	getValue (void)

const char *	getContent (void)

const char *	getContent (const char *text)

const char *	getKeyword (const char *id)

method_t	getLooping (void)

bool	isConditional (unsigned index)

void	setRef (header scope, const char id, char *data, unsigned size)

void	getParams (header scope, line_t line)

void	startScript (header *scr)

virtual unsigned	getTypesize (const char *type_id)

virtual const char *	getTypeinit (const char *type_id)

virtual const char *	getFormat (symbol sym, const char id, char *temp)

virtual bool	getCondition (const char test, const char value)

const char *	getIndex (void)

Protected Attributes
stack_t *	stack

object_pointer< Script >	image

LinkedObject **	syms

unsigned	frame

Detailed Description

An instance of the runtime interpreter.

Some application servers, like GNU Bayonne, may create an interpreter instance for each telephone call session. All runtime execution happens through the interpreter class, which executes compiled script images. This is commonly used as a base class for runtime methods and application specific interpreters. All interpreter instance data and symbols are allocated off the interpreter instance private heap.

Author: David Sugar dyfet.nosp@m.@gnu.nosp@m.telep.nosp@m.hony.nosp@m..org

Definition at line 253 of file ccscript.h.

Member Typedef Documentation

typedef char ucommon::Script::interp::num_t[16]

Definition at line 256 of file ccscript.h.

Constructor & Destructor Documentation

interp::interp ( )

Definition at line 35 of file interp.cpp.

interp::~interp ( )

virtual

Definition at line 40 of file interp.cpp.

Member Function Documentation

bool interp::attach	(	Script *	image,
		const char *	entry = `NULL`
	)

Attach a compiled image to the interpreter and start.

Even when different entry points are called, the initialization block is always called.

Parameters

image	to attach (ref count).
entry	point, NULL for "@main"

Returns: true ifi successful, false if failed to find entry.

Definition at line 771 of file interp.cpp.

Script::symbol * interp::createSymbol ( const char * id )

protected

Definition at line 494 of file interp.cpp.

void interp::detach ( void )

Cleanup after interpreter run.

Releases reference to image.

Definition at line 746 of file interp.cpp.

bool interp::error ( const char * text )

Invoke runtime interpreter error handling.

Parameters

text	to post into error symbol.

Definition at line 68 of file interp.cpp.

Script::symbol * interp::find ( const char * id )

protected

Definition at line 724 of file interp.cpp.

bool interp::getCondition	(	const char *	test,
		const char *	value
	)

protectedvirtual

Definition at line 1026 of file interp.cpp.

const char * interp::getContent ( void )

protected

Definition at line 429 of file interp.cpp.

const char * interp::getContent ( const char * text )

protected

Definition at line 351 of file interp.cpp.

const char * interp::getFilename ( void )

Get effective filename of base.

Returns: filename.

Definition at line 751 of file interp.cpp.

const char * interp::getFormat	(	Script::symbol *	sym,
		const char *	id,
		char *	temp
	)

protectedvirtual

Definition at line 97 of file interp.cpp.

const char * interp::getIndex ( void )

protected

Definition at line 405 of file interp.cpp.

const char * interp::getKeyword ( const char * id )

protected

Definition at line 388 of file interp.cpp.

Script::method_t interp::getLooping ( void )

protected

Definition at line 421 of file interp.cpp.

void interp::getParams	(	Script::header *	scope,
		Script::line_t *	line
	)

protected

Definition at line 582 of file interp.cpp.

unsigned interp::getResource ( void )

Get current dsp resource mask.

Returns: resource mask.

Definition at line 935 of file interp.cpp.

char * interp::getTemp ( void )

protected

Definition at line 87 of file interp.cpp.

const char * interp::getTypeinit ( const char * type_id )

protectedvirtual

Definition at line 568 of file interp.cpp.

unsigned interp::getTypesize ( const char * type_id )

protectedvirtual

Definition at line 551 of file interp.cpp.

const char * interp::getValue ( void )

protected

Definition at line 446 of file interp.cpp.

Script::symbol * interp::getVar	(	const char *	id,
		const char *	value = `NULL`
	)

protected

Definition at line 656 of file interp.cpp.

void interp::initialize ( void )

Used to initialize and purge the interpreter between runs.

This is used especially if the same interpreter object is kept in memory and directly re-used for multiple executions.

Definition at line 45 of file interp.cpp.

bool interp::isConditional ( unsigned index )

protected

Definition at line 1138 of file interp.cpp.

bool interp::pop ( void )

protected

Definition at line 946 of file interp.cpp.

void interp::pullBase ( void )

protected

Definition at line 913 of file interp.cpp.

void interp::pullLoop ( void )

protected

Definition at line 925 of file interp.cpp.

void interp::pullScope ( void )

protected

Definition at line 919 of file interp.cpp.

void interp::push ( void )

protected

Definition at line 957 of file interp.cpp.

bool interp::scriptEvent ( const char * name )

protected

Try to branch to a named event handler.

If successful, the interpreter transfers control to the start of the handler for the next step.

Parameters

name	of event to request.

Returns: true if found.

Definition at line 825 of file interp.cpp.

Script::event * interp::scriptMethod ( const char * name )

protected

Search for an event object in the method table.

Parameters

name	to search for.

Returns: method if found.

Definition at line 813 of file interp.cpp.

bool interp::setConst	(	const char *	id,
		const char *	value
	)

protected

Definition at line 463 of file interp.cpp.

void interp::setRef	(	Script::header *	scope,
		const char *	id,
		char *	data,
		unsigned	size
	)

protected

Definition at line 620 of file interp.cpp.

void interp::setStack	(	Script::header *	scr,
		Script::event *	ev = `NULL`
	)

protected

Definition at line 899 of file interp.cpp.

void interp::skip ( void )

protected

Definition at line 808 of file interp.cpp.

void interp::startScript ( Script::header * scr )

protected

Definition at line 756 of file interp.cpp.

bool interp::step ( void )

Step through an instance of the interpreter.

This can step through multiple lines at once, depending on Script::stepping.

Returns: true if still running, false if exited.

Definition at line 1003 of file interp.cpp.

bool interp::tryexit ( void )

protected

Definition at line 985 of file interp.cpp.

bool interp::trylabel ( const char * id )

protected

Definition at line 971 of file interp.cpp.

Member Data Documentation

unsigned ucommon::Script::interp::frame

protected

Definition at line 339 of file ccscript.h.

object_pointer<Script> ucommon::Script::interp::image

protected

Definition at line 337 of file ccscript.h.

stack_t* ucommon::Script::interp::stack

protected

Definition at line 336 of file ccscript.h.

LinkedObject** ucommon::Script::interp::syms

protected

Definition at line 338 of file ccscript.h.

The documentation for this class was generated from the following files:

inc/ccscript.h
src/interp.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation