Interpreter Class Reference

#include <interpreter.h>

Inheritance diagram for Interpreter:

Inheritance graph
[legend]
List of all members.

Public Member Functions

virtual void stop ()=0
virtual void * define (const char *var, const char *value)=0
virtual bool defined (const char *var)=0
virtual int toint (void *value)=0
virtual void * eval (const char *script)=0
virtual const char * tostring (void *value)=0
virtual void start ()=0
virtual double todouble (void *value)=0
virtual bool tobool (void *value)=0
virtual void upscope ()=0
virtual void downscope ()=0

Member Function Documentation

virtual void Interpreter::stop  )  [pure virtual]
 

Stop the intrepreter and do and necessary cleanup.

Implemented in NullInterpreter, and PerlScriptInterpreter.

virtual void* Interpreter::define const char *  var,
const char *  value
[pure virtual]
 

Define a variable with in the intrepreter.

Parameters:
var Variable name.
value Variable value.
Returns:
A void pointer to the value structure.

Implemented in NullInterpreter, and PerlScriptInterpreter.

virtual bool Interpreter::defined const char *  var  )  [pure virtual]
 

Check if a variable is defined in the intreperter with in the current context.

Parameters:
var The name of the variable.
Returns:
true if var is defined, false otherwise.

Implemented in NullInterpreter, and PerlScriptInterpreter.

virtual int Interpreter::toint void *  value  )  [pure virtual]
 

Convert a value to an integer.

Parameters:
value A pointer to the value to be converted.
Returns:
The integer result.

Implemented in NullInterpreter, and PerlScriptInterpreter.

virtual void* Interpreter::eval const char *  script  )  [pure virtual]
 

Evaluage a line of script.

Parameters:
script The script.
Returns:
A void pointer to the return value.

Implemented in NullInterpreter, and PerlScriptInterpreter.

virtual const char* Interpreter::tostring void *  value  )  [pure virtual]
 

Convert a value pointer to a string.

Parameters:
value The value pointer.
Returns:
The string value of the value.

Implemented in NullInterpreter, and PerlScriptInterpreter.

virtual void Interpreter::start  )  [pure virtual]
 

Start the intrepreter and do any necessary initialization.

Implemented in NullInterpreter, and PerlScriptInterpreter.

virtual double Interpreter::todouble void *  value  )  [pure virtual]
 

Convert a value pointer to a double.

Parameters:
value The value pointer.
Returns:
The value converted to a double.

Implemented in NullInterpreter, and PerlScriptInterpreter.

virtual bool Interpreter::tobool void *  value  )  [pure virtual]
 

Convert a value pointer to a bool.

Parameters:
value The value pointer.
Returns:
The boolean value

Implemented in NullInterpreter, and PerlScriptInterpreter.

virtual void Interpreter::upscope  )  [pure virtual]
 

Create a new scope level in the intrepreter. It is not exactly defined how this should effect scripting. This function is called each time a node or network is entered.

Implemented in NullInterpreter, and PerlScriptInterpreter.

virtual void Interpreter::downscope  )  [pure virtual]
 

Move down a scope level in the intrepreter. It is not exactly defined how this should effect scripting. This function is called each time a node or network is exited.

Implemented in NullInterpreter, and PerlScriptInterpreter.


The documentation for this class was generated from the following file:
Generated on Wed Apr 5 21:04:16 2006 for Sesame by  doxygen 1.4.6