virtual Symbol * getEntry (const char *symbol, int size=0)

Fetch a symbol entry. void setExclusive (bool enable)

Can be used to tie together an exclusive function... virtual void commit (Symbol *sym)

A virtual method used when 'committing' symbol changes. Symbol * getTrigger (void)

Fetch a pending trigger value and clear it. int getSymbolSize (void)

Fetch default symbol size. ScriptSymbol (int size, int pgsize=1024)

~ScriptSymbol ()

void * getPointer (const char *symbol)

Fetch an embedded pointer held in a symbol identifier. bool setPointer (const char *symbol, void *data)

Set an embedded pointer object as a symbol. char * getSymbol (const char *symbol)

Fetch the address of the value of a given symbol identifier. char * setSymbol (const char *symbol, const char *value='')

Set a given symbol to a new value. char * setConst (const char *symbol, const char *value='')

Set a constant value. bool makeSequence (const char *id, unsigned char count, unsigned char recsize)

Create a sequence object (looping fifo). bool makeCache (const char *id, unsigned char count, unsigned char recsize)

bool makeStack (const char *id, unsigned char count, unsigned char recsize)

Create a stack object. bool makeFifo (const char *id, unsigned char count, unsigned char recsize)

Create a fifo object. bool makeCounter (const char *id)

Create an automatic counter object. bool postSymbol (Symbol *sym, const char *value)

Post data into a fifo. bool removeSymbol (Symbol *sym, const char *value)

Remove entry from a queue. char * readSymbol (Symbol *sym)

Read symbol handles special symbol types. bool setAlias (const char *symbol, const char *source)

Set an alias. bool swapSymbol (const char *oldname, const char *newname)

Swap an existing symbol, relinks table sets. Symbol * getAlias (const char *symbol)

Get an alias. char * setSymbol (const char *symbol, int size=0)

Create a new symbol entry of a specified size. void clrSymbol (const char *id)

Clear a symbol definition. void purge (void)

Purge user defined symbols and memory space. unsigned gather (Symbol **index, unsigned max, const char *prefrix, const char *suffix='')

Gather a listing of common script symbols.

bool setArray (const char *sym, const char *source)

class ScriptInterp

Clear a symbol definition.

This does not remove the entry if it already exists. It mearly clears the initial flag so it still can appear undefined.

Parameters:

symbol

name to clear.

A virtual method used when 'committing' symbol changes.

Normally this is a non-operation, but when system specific dialects are created, special symbols that must be converted from strings into other kinds of internal data types, or that might perform operations can be represented with the commit.

Parameters:

symbol

to commit.

Get an alias.

Parameters:

symbol

name to find.

Returns: script symbol object or NULL.

Fetch a symbol entry.

Normally this is presumed to be from the native symbol table. However, the use of a virtual allows one to derive special 'system' symbols as needed for Bayonne dialects, as well as specify special attributes and properties for system symbols. For example, in the Bayonne IVR, symbols might be used to retrieve the current DTMF digit buffer and count, but these are stored as and manipulated in a channel structure rather than in 'symbol space'.

Returns: symbol entry or NULL if not found.

Parameters:

symbol

name to find or create.

size

of symbol space to create if not found.

Fetch an embedded pointer held in a symbol identifier.

Parameters:

symbol

name.

Returns: pointer held in symbol or NULL.

Fetch the address of the value of a given symbol identifier.

Parameters:

symbol

name.

Returns: symbol buffer address, or NULL if not found.

Fetch default symbol size.

Returns: default symbol size.

Fetch a pending trigger value and clear it.

Returns: symbol trigger that is active.

Create an automatic counter object.

Returns: false if fail.

Parameters:

name

of counter.

Create a fifo object.

Returns: false if fail.

Parameters:

name

of fifo.

number

of records.

size

of record.

Create a sequence object (looping fifo).

Returns: false if fail.

Parameters:

name

of sequence.

max.

number of sequences.

size

of sequence data record.

Create a stack object.

Returns: false if fail.

Parameters:

name

of stack.

number

of entries.

size

of record.

Post data into a fifo.

Returns: false if full.

Parameters:

symbol

object to post.

data

value to post.

Read symbol handles special symbol types.

Returns: data of symbol.

Parameters:

symbol.

Remove entry from a queue.

Returns: false if invalid.

Parameters:

symbol

object to remove from.

data

value to find and remove.

Set an alias.

Parameters:

symbol

name to alias.

value

of alias to set.

Returns: bool if not set, else value.

Set a constant value.

Parameters:

symbol

name to find.

value

string to set.

Returns: NULL if not found, else value.

Set an embedded pointer object as a symbol.

Parameters:

symbol

name.

data

pointer to save.

Returns: true if successful.

Create a new symbol entry of a specified size.

Parameters:

symbol

name to create.

size

of symbol, otherwise default size used.

buffer

or NULL if exists.

Set a given symbol to a new value.

Parameters:

symbol

name to find.

value

string to set.

Returns: NULL if not found, else value.

Swap an existing symbol, relinks table sets.

Parameters:

symbol

name to find.

symbol

name to swap with.

Returns: bool true if successful.