PerlScriptInterpreter Class Reference

#include <perlscriptinterpreter.h>

Inheritance diagram for PerlScriptInterpreter:

Inheritance graph
[legend]
Collaboration diagram for PerlScriptInterpreter:

Collaboration graph
[legend]
List of all members.

Public Member Functions

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

Static Public Member Functions

static PerlScriptInterpretergetSingleton ()

Constructor & Destructor Documentation

PerlScriptInterpreter::PerlScriptInterpreter  ) 
 

Construct a PerlScriptInterpreter. Allocates a new embedded perl instance. WARNING: Will throw a BasicException if this constructor is call more than once.

PerlScriptInterpreter::~PerlScriptInterpreter  )  [virtual]
 

Destruct a PearlScriptInterpreter. Deallocates the embedded pearl instance.


Member Function Documentation

PerlScriptInterpreter * PerlScriptInterpreter::getSingleton  )  [static]
 

Get a singleton instance of the PerlScriptInterpreter. There must only be once instance of this class because embedded perl has problems with there being more than one. If an instance has not yet been constructed one will be created.

Returns:
A pointer to the single instance of this class.

void PerlScriptInterpreter::start  )  [virtual]
 

Start the perl intrepreter.

Implements Interpreter.

void PerlScriptInterpreter::stop  )  [virtual]
 

Stop the perl intrepreter.

Implements Interpreter.

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

Define a variable in the interpreter.

Parameters:
var The variable name.
value The variable value.
Returns:
A void pointer to the resulting value.

Implements Interpreter.

bool PerlScriptInterpreter::defined const char *  var  )  [virtual]
 

Check if a variable is defined in this interpreter.

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

Implements Interpreter.

void * PerlScriptInterpreter::eval const char *  script  )  [virtual]
 

Evaluage a string of perl script.

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

Implements Interpreter.

int PerlScriptInterpreter::toint void *  value  )  [virtual]
 

Convert a void pointer value to an integer.

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

Implements Interpreter.

const char * PerlScriptInterpreter::tostring void *  value  )  [virtual]
 

convert a void pointer value to a string.

Parameters:
value A pointer to the value.
Returns:
The string result.

Implements Interpreter.

double PerlScriptInterpreter::todouble void *  value  )  [virtual]
 

Convert a void pointer value to a double.

Parameters:
value A pointer to the value.
Returns:
The double result.

Implements Interpreter.

bool PerlScriptInterpreter::tobool void *  value  )  [virtual]
 

Convert a void pointer value to a bool.

Parameters:
value A pointer to the value.
Returns:
The bool result.

Implements Interpreter.

void PerlScriptInterpreter::upscope  )  [virtual]
 

Up the variable scope. This doesn't currently do anything useful in perl.

Implements Interpreter.

void PerlScriptInterpreter::downscope  )  [virtual]
 

Down the variable scope. This doesn't currently do anything useful in perl.

Implements Interpreter.


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