ScriptModule Class Reference

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

#include <script.h>

Inheritance diagram for ScriptModule:

List of all members.

Protected Member Functions
virtual void	moduleAttach (ScriptInterp *interp)
	Method to call for handling script attach events.
virtual void	moduleDetach (ScriptInterp *interp)
	Method to call for handling script detach events.
virtual char *	getSession (ScriptInterp *interp, Line *line, Session **session)
	Check for script handler.
virtual char *	checkScript (Line *line, ScriptImage *img)
	Validate script command for parser.
	ScriptModule (const char *name)
	Construct and link-in a command handler.
Static Protected Member Functions
static ScriptModule *	find (const char *name)
	Find a given module.
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	(	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, protected]

Find a given module.

Returns:

module found.

Parameters:

module

name.

virtual char* ScriptModule::getSession	(	ScriptInterp *	interp,
		Line *	line,
		Session **	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:

• script.h

---