Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

ScriptModule Class Reference

This class is used for generic ccScript DSO plugins. ccScript loadable module. More...

#include <script.h>

List of all members.

Protected Methods

virtual void moduleAttach (ScriptInterp *interp)
 Method to call for handling script attach events. More...

virtual void moduleDetach (ScriptInterp *interp)
 Method to call for handling script detach events. More...

virtual char * getSession (ScriptInterp *interp, scriptline_t *line, ScriptSession **session)
 Check for script handler. More...

virtual char * checkScript (scriptline_t *line, ScriptImage *img)
 Validate script command for parser. More...

 ScriptModule (const char *name)
 Construct and link-in a command handler. More...


Static Protected Methods

ScriptModule * find (const char *name)
 Find a given module. More...


Friends

class ScriptInterp
class ScriptCommand


Detailed Description

This class is used for generic ccScript DSO plugins. ccScript loadable module.

This allows plugins to become part of the base ccScript engine.

Author:
David Sugar <dyfet@ostel.com>


Constructor & Destructor Documentation

ScriptModule::ScriptModule const char *   name [protected]
 

Construct and link-in a command handler.

Parameters:
name   of command being created.


Member Function Documentation

virtual char* ScriptModule::checkScript scriptline_t *   line,
ScriptImage *   img
[inline, protected, virtual]
 

Validate script command for parser.

Returns:
error string or NULL if ok.
Parameters:
script   line evaluated.
image   set analyzed.

ScriptModule* ScriptModule::find const char *   name [static, protected]
 

Find a given module.

Returns:
module found.
Parameters:
module   name.

virtual char* ScriptModule::getSession ScriptInterp *   interp,
scriptline_t *   line,
ScriptSession **   session
[inline, protected, virtual]
 

Check for script handler.

Returns:
error string.
Parameters:
interpreter   image.
line   object parsed.
pointer   to session handler.

virtual void ScriptModule::moduleAttach ScriptInterp *   interp [inline, protected, virtual]
 

Method to call for handling script attach events.

Parameters:
interpreter   being attached.

virtual void ScriptModule::moduleDetach ScriptInterp *   interp [inline, protected, virtual]
 

Method to call for handling script detach events.

Parameters:
interpreter   being detached.


Friends And Related Function Documentation

friend class ScriptCommand [friend]
 

friend class ScriptInterp [friend]
 


The documentation for this class was generated from the following file:
Generated at Fri Dec 28 09:29:24 2001 for ccScript by doxygen1.2.10 written by Dimitri van Heesch, © 1997-2001