ScriptModule Class Reference

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

#include <bayonnescript.h>

Inheritance diagram for ScriptModule:

List of all members.

Public Member Functions
virtual char *	parseScript (ScriptInterp *interp, Line *line)
	parse a script in a module, and return optional error.
Static Public Member Functions
static ScriptModule *	find (const char *name)
	Find a given module.
static void	addPreparse (const char *id, Parse p)
	Add a compile time command parser.
static void	addInit (Init p)
	Add script system initialization handler.
static void	init (void)
	Call script system initialization handlers.
Protected Member Functions
virtual void	moduleAttach (ScriptInterp *interp)
	Method to call for handling script attach events.
virtual void	moduleDetach (ScriptInterp *interp, const char *id)
	Method to call for handling script detach events.
virtual char *	checkScript (Line *line, ScriptImage *img)
	Validate script command for parser.
	ScriptModule (const char *name, Script::Method method=NULL)
	Construct and link-in a command handler.
Friends
class __EXPORT	ScriptInterp
class __EXPORT	ScriptCommand
class __EXPORT	ScriptImage

---

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, Script::Method  method = NULL )  [protected]

Construct and link-in a command handler. Parameters: name  of command being created.

---

Member Function Documentation

static void ScriptModule::addInit (  Init  p  )  [static]

Add script system initialization handler. Parameters: handler  to add.

static void ScriptModule::addPreparse (  const char *  id, Parse  p )  [static]

Add a compile time command parser. Parameters: command  name of compile time operation. handler  that is called.

virtual char* ScriptModule::checkScript (  Line *  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.

static ScriptModule* ScriptModule::find (  const char *  name  )  [static]

Find a given module. Returns: module found. Parameters: module  name.

static void ScriptModule::init (  void   )  [static]

Call script system initialization handlers.

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

Method to call for handling script attach events. Parameters: interpreter  being attached. Reimplemented in Trunk::Database.

virtual void ScriptModule::moduleDetach (  ScriptInterp *  interp, const char *  id )  [inline, protected, virtual]

Method to call for handling script detach events. Parameters: interpreter  being detached.

virtual char* ScriptModule::parseScript (  ScriptInterp *  interp, Line *  line )  [inline, virtual]

parse a script in a module, and return optional error. Returns: error string. Parameters: interpreter  image. Reimplemented in Trunk::Database.

---

Friends And Related Function Documentation

friend class __EXPORT ScriptCommand [friend]

friend class __EXPORT ScriptImage [friend]

friend class __EXPORT ScriptInterp [friend]

---

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

• bayonnescript.h

---