Script execution context. More...

#include <yatescript.h>

Inheritance diagram for ScriptContext:

Public Member Functions
	ScriptContext (const char *name=0)

NamedList &	params ()

const NamedList &	params () const

virtual NamedList *	nativeParams () const

virtual const String &	toString () const

virtual void *	getObject (const String &name) const

virtual RefObject *	refObj ()

virtual ScriptMutex *	mutex ()=0

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

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

virtual void	fillFieldNames (ObjList &names)

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)

virtual bool	copyFields (ObjList &stack, const ScriptContext &original, GenObject *context)

virtual void	addFields (const NamedList &list, const char *skipPrefix="__")

bool	runMatchingField (ObjList &stack, const ExpOperation &oper, GenObject *context)

virtual void	createdObj (GenObject *obj)

virtual void	deletedObj (GenObject *obj)

virtual void	trackObjs (unsigned int track=0)

virtual ObjList *	countAllocations ()

Public Member Functions inherited from RefObject
	RefObject ()

virtual	~RefObject ()

virtual void *	getObject (const String &name) const

virtual bool	alive () const

bool	ref ()

bool	deref ()

int	refcount () const

virtual void	destruct ()

Public Member Functions inherited from GenObject
	GenObject ()

virtual	~GenObject ()

virtual bool	alive () const

virtual void	destruct ()

virtual const String &	toString () const

virtual const String &	traceId () const

virtual void *	getObject (const String &name) const

NamedCounter *	getObjCounter () const

NamedCounter *	setObjCounter (NamedCounter *counter)

Public Member Functions inherited from ExpExtender
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)

Static Public Member Functions
static void	fillFieldNames (ObjList &names, const NamedList &list, bool checkDupl=true, const char *skip=0)

static void	fillFieldNames (ObjList &names, const HashList &list)

Static Public Member Functions inherited from RefObject
static bool	alive (const RefObject *obj)

static bool	efficientIncDec ()

Static Public Member Functions inherited from GenObject
static void *	getObject (const String &name, const GenObject *obj)

static bool	getObjCounting ()

static void	setObjCounting (bool enable)

static NamedCounter *	getObjCounter (const String &name, bool create=true)

static ObjList &	getObjCounters ()

Additional Inherited Members
Protected Member Functions inherited from RefObject
virtual void	zeroRefs ()

bool	resurrect ()

virtual void	destroyed ()

Detailed Description

Script execution context.

A script execution context, holds global variables and objects

Constructor & Destructor Documentation

◆ ScriptContext()

ScriptContext ( const char * name = 0 )

inlineexplicit

Constructor

Parameters

name	Name of the context

Member Function Documentation

◆ addFields()

virtual void addFields	(	const NamedList &	list,
		const char *	skipPrefix = `"__"`
	)

virtual

Add string parameters from list

Parameters

list	Parameters list
skipPrefix	Skip parameters whose name start with specified prefix

◆ copyFields()

virtual bool copyFields	(	ObjList &	stack,
		const ScriptContext &	original,
		GenObject *	context
	)

virtual

Copy all fields from another context

Parameters

stack	Evaluation stack in use
original	Script context to copy from
context	Pointer to context data passed from evaluation methods

Returns: True if all fields were copied

◆ countAllocations()

virtual ObjList * countAllocations ( )

inlinevirtual

Retrieve a list of how many objects were allocated at each line

Returns: The list of counters for allocations, 0 if tracking is not active

◆ createdObj()

virtual void createdObj ( GenObject * obj )

inlinevirtual

Notification that an object was created in this context Used for object tracking purposes

Parameters

obj	The created object

◆ deletedObj()

virtual void deletedObj ( GenObject * obj )

inlinevirtual

Notification that an object was destroyed in this context Used for object tracking purposes

Parameters

obj	The destroyed object

◆ fillFieldNames() [1/3]

virtual void fillFieldNames ( ObjList & names )

virtual

Fill a list with the unique names of all fields

Parameters

names List to which key names must be added

Reimplemented in JsObject.

◆ fillFieldNames() [2/3]

static void fillFieldNames	(	ObjList &	names,
		const HashList &	list
	)

static

Fill a list with the unique names from a Hash list

Parameters

names	List to which key names must be added
list	Hash list whose names are to be added

◆ fillFieldNames() [3/3]

static void fillFieldNames	(	ObjList &	names,
		const NamedList &	list,
		bool	checkDupl = `true`,
		const char *	skip = `0`
	)

static

Fill a list with the unique names of all fields

Parameters

names	List to which key names must be added
list	List of parameters whose names to be added
checkDupl	True to ignore duplicates from the given list
skip	Parameters starting with this prefix will not be added

◆ getField()

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

virtual

Get a pointer to a field in the context

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 from ExpExtender.

Reimplemented in JsObject.

◆ getObject()

virtual void * getObject ( const String & name ) const

virtual

Get a pointer to a derived class given that class name

Parameters

name	Name of the class we are asking for

Returns: Pointer to the requested class or NULL if this object doesn't implement it

Reimplemented from RefObject.

◆ hasField()

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

virtual

Check if a certain field is assigned in context

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 from ExpExtender.

Reimplemented in JsObject.

◆ mutex()

virtual ScriptMutex * mutex ( )

pure virtual

Retrieve the Mutex object used to serialize object access, if any

Returns: Pointer to the mutex or NULL if none applies

Implemented in JsObject.

◆ nativeParams()

virtual NamedList * nativeParams ( ) const

inlinevirtual

Access any native NamedList hold by the context

Returns: Pointer to a native named list

◆ params() [1/2]

NamedList & params ( )

inline

Access to the NamedList operator

Returns: Reference to the internal named list

Referenced by JsObject::clearField(), JsObject::setBoolField(), JsObject::setIntField(), JsObject::setObjField(), and JsObject::setStringField().

◆ params() [2/2]

const NamedList & params ( ) const

inline

Const access to the NamedList operator

Returns: Reference to the internal named list

◆ refObj()

virtual RefObject * refObj ( )

inlinevirtual

Retrieve the reference counted object owning this interface

Returns: Pointer to this script context

Reimplemented from ExpExtender.

◆ runAssign()

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 context data passed from evaluation methods

Returns: True if assignment succeeded

Reimplemented from ExpExtender.

Reimplemented in JsObject, JsArray, and JsRegExp.

◆ runField()

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

virtual

Try to evaluate a single field in the context

Parameters

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

Returns: True if evaluation succeeded

Reimplemented from ExpExtender.

Reimplemented in JsObject, and JsArray.

◆ runFunction()

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

virtual

Try to evaluate a single function in the context

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 context data passed from evaluation methods

Returns: True if evaluation succeeded

Reimplemented from ExpExtender.

Reimplemented in JsObject.

◆ runMatchingField()

bool runMatchingField	(	ObjList &	stack,
		const ExpOperation &	oper,
		GenObject *	context
	)

Try to evaluate a single field searching for a matching context

Parameters

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

Returns: True if evaluation succeeded

◆ toString()

virtual const String & toString ( ) const

inlinevirtual

Override GenObject's method to return the internal name of the named list

Returns: A reference to the context name

Reimplemented from GenObject.

Referenced by JsObject::clone().

◆ trackObjs()

virtual void trackObjs ( unsigned int track = 0 )

inlinevirtual

Activate object tracking

Parameters

track O for not enabled, non-zero for enabling it

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

yatescript.h

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ScriptContext()

Member Function Documentation

◆ addFields()

◆ copyFields()

◆ countAllocations()

◆ createdObj()

◆ deletedObj()

◆ fillFieldNames() [1/3]

◆ fillFieldNames() [2/3]

◆ fillFieldNames() [3/3]

◆ getField()

◆ getObject()

◆ hasField()

◆ mutex()

◆ nativeParams()

◆ params() [1/2]

◆ params() [2/2]

◆ refObj()

◆ runAssign()

◆ runField()

◆ runFunction()

◆ runMatchingField()

◆ toString()

◆ trackObjs()