ExpExtender Class Reference

ExpEvaluator extending interface. More...

#include <yatescript.h>

Inheritance diagram for ExpExtender:

List of all members.

Public Member Functions
virtual	~ExpExtender ()
virtual RefObject *	refObj ()
virtual bool	hasField (ObjList &stack, const String &name, GenObject *context) const
virtual NamedString *	getField (ObjList &stack, const String &name, GenObject *context) const
virtual bool	runFunction (ObjList &stack, const ExpOperation &oper, GenObject *context)
virtual bool	runField (ObjList &stack, const ExpOperation &oper, GenObject *context)
virtual bool	runAssign (ObjList &stack, const ExpOperation &oper, GenObject *context)

---

Detailed Description

ExpEvaluator extending interface.

This class allows extending ExpEvaluator to implement custom fields and functions

---

Constructor & Destructor Documentation

virtual ~ExpExtender

(

)

[inline, virtual]

Destructor

---

Member Function Documentation

virtual NamedString* getField	(	ObjList &	stack,
		const String &	name,
		GenObject *	context
	)		const [virtual]

Get a pointer to a field in extender

Parameters:

stack	Evaluation stack in use
name	Name of the field to retrieve
context	Pointer to arbitrary object passed from evaluation methods

Returns:

Pointer to field, NULL if not present

Reimplemented in ScriptContext.

virtual bool hasField	(	ObjList &	stack,
		const String &	name,
		GenObject *	context
	)		const [virtual]

Check if a certain field is assigned in extender

Parameters:

stack	Evaluation stack in use
name	Name of the field to test
context	Pointer to arbitrary object passed from evaluation methods

Returns:

True if the field is present

Reimplemented in ScriptContext.

virtual RefObject* refObj

(

)

[virtual]

Retrieve the reference counted object owning this interface

Returns:

Pointer to object owning the extender, NULL if no ownership

Reimplemented in ScriptContext.

virtual bool runAssign	(	ObjList &	stack,
		const ExpOperation &	oper,
		GenObject *	context
	)		[virtual]

Try to assign a value to a single field

Parameters:

stack	Evaluation stack in use
oper	Field to assign to, contains the field name and new value
context	Pointer to arbitrary object passed from evaluation methods

Returns:

True if assignment succeeded

Reimplemented in JsObject, and ScriptContext.

virtual bool runField	(	ObjList &	stack,
		const ExpOperation &	oper,
		GenObject *	context
	)		[virtual]

Try to evaluate a single field

Parameters:

stack	Evaluation stack in use, field value must be pushed on it
oper	Field to evaluate
context	Pointer to arbitrary object passed from evaluation methods

Returns:

True if evaluation succeeded

Reimplemented in JsObject, and ScriptContext.

virtual bool runFunction	(	ObjList &	stack,
		const ExpOperation &	oper,
		GenObject *	context
	)		[virtual]

Try to evaluate a single function

Parameters:

stack	Evaluation stack in use, parameters are popped off this stack and results are pushed back on stack
oper	Function to evaluate
context	Pointer to arbitrary object passed from evaluation methods

Returns:

True if evaluation succeeded

Reimplemented in JsObject, and ScriptContext.

---

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

• yatescript.h