Javascript Object. More...

#include <yatescript.h>

Inheritance diagram for JsObject:

Public Types
enum	DumpFlags { DumpFunc = 0x01 , DumpProp = 0x02 , DumpRecursive = 0x10 , DumpType = 0x20 , DumpProto = 0x40 , DumpPropObjType = 0x80 , DumpFuncOnly = DumpRecursive \| DumpProto \| DumpFunc , DumpPropOnly = DumpRecursive \| DumpPropObjType \| DumpProp }

Public Member Functions
	JsObject (const char name="Object", ScriptMutex mtx=0, bool frozen=false)

	JsObject (ScriptMutex mtx, const char name, unsigned int line, bool frozen=0)

	JsObject (GenObject context, unsigned int line, ScriptMutex mtx=0, bool frozen=false)

virtual	~JsObject ()

virtual ScriptMutex *	mutex ()

virtual JsObject *	clone (const char *name, const ExpOperation &oper) const

JsObject *	clone (const ExpOperation &oper) const

void	setPrototype (GenObject *context, const String &objName)

virtual JsObject *	copy (ScriptMutex *mtx, const ExpOperation &oper) const

virtual void	fillFieldNames (ObjList &names)

virtual const HashList *	getHashListParams () const

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

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

virtual void	initConstructor (JsFunction *construct)

virtual JsObject *	runConstructor (ObjList &stack, const ExpOperation &oper, GenObject *context)

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 ExpOperation *	popValue (ObjList &stack, GenObject *context=0)

virtual void	clearField (const String &name)

bool	setIntField (const char *name, int64_t val)

bool	setBoolField (const char *name, bool val)

bool	setStringField (const char name, const char val)

bool	setObjField (const char name, JsObject obj)

bool	getIntField (const String &name, int64_t &val)

bool	getBoolField (const String &name, bool &val)

bool	getStringField (const String &name, String &val)

bool	getObjField (const String &name, JsObject *&obj)

bool	frozen () const

void	freeze ()

void	lineNo (unsigned int line)

unsigned int	lineNo () const

int	extractArgs (ObjList &stack, const ExpOperation &oper, GenObject *context, ObjList &arguments)

Public Member Functions inherited from ScriptContext
	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 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 bool	alive () const

bool	ref ()

bool	deref ()

int	refcount () const

virtual void	destruct ()

Public Member Functions inherited from GenObject
	GenObject ()

virtual	~GenObject ()

virtual const String &	traceId () const

NamedCounter *	getObjCounter () const

NamedCounter *	setObjCounter (NamedCounter *counter)

Public Member Functions inherited from ExpExtender
virtual	~ExpExtender ()

Static Public Member Functions
static void	addObject (NamedList &params, const char name, JsObject obj)

static void	addConstructor (NamedList &params, const char name, JsObject obj)

static int	extractArgs (JsObject obj, ObjList &stack, const ExpOperation &oper, GenObject context, ObjList &arguments)

static JsObject *	buildCallContext (ScriptMutex mtx, JsObject thisObj=0)

static void	initialize (ScriptContext *context)

static void	setLineForObj (JsObject *obj, unsigned int lineNo, bool recursive)

static const String &	protoName ()

static void	deepCopyParams (NamedList &dst, const NamedList &src, ScriptMutex *mtx)

static void	dumpRecursive (const GenObject *obj, String &buf, unsigned int flags=0xffffffff)

static void	printRecursive (const GenObject *obj, unsigned int flags=0xffffffff)

static ExpOperation *	toJSON (const ExpOperation *oper, int spaces)

Static Public Member Functions inherited from ScriptContext
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 ()

Protected Member Functions
virtual bool	runNative (ObjList &stack, const ExpOperation &oper, GenObject *context)

ScriptMutex *	mutex () const

void	setMutex (ScriptMutex *mtx)

Protected Member Functions inherited from RefObject
virtual void	zeroRefs ()

bool	resurrect ()

virtual void	destroyed ()

Static Protected Member Functions
static void	toJSON (const NamedString *ns, String &buf, int spaces, int indent=0)

static String	strEscape (const char *str)

Friends
class	JsFunction

Detailed Description

Javascript Object.

Javascript Object class, base for all JS objects

Member Enumeration Documentation

◆ DumpFlags

enum DumpFlags

Dump object flags

Constructor & Destructor Documentation

◆ JsObject() [1/3]

JsObject	(	const char *	name = "Object",
		ScriptMutex *	mtx = 0,
		bool	frozen = false )

Constructor

Parameters

name	Name of the object
mtx	Pointer to the mutex that serializes this object
frozen	True if the object is to be frozen from creation

References frozen().

Referenced by addConstructor(), addObject(), buildCallContext(), clone(), clone(), JsRegExp::clone(), JsFunction::copy(), JsFunction::copy(), copy(), JsRegExp::copy(), extractArgs(), getObjField(), runConstructor(), JsRegExp::runConstructor(), JsFunction::runDefined(), setLineForObj(), and setObjField().

◆ JsObject() [2/3]

JsObject	(	ScriptMutex *	mtx,
		const char *	name,
		unsigned int	line,
		bool	frozen = 0 )

Constructor for an empty object

Parameters

mtx	Pointer to the mutex that serializes this object
name	Full name of the object
line	Code line where this object was created
frozen	True if the object is to be frozen from creation

References frozen().

◆ JsObject() [3/3]

JsObject	(	GenObject *	context,
		unsigned int	line,
		ScriptMutex *	mtx = 0,
		bool	frozen = false )

Constructor for an empty object with prototype

Parameters

context	Script context from which Object prototype is obtained
line	Code line where this object was created
mtx	Pointer to the mutex that serializes this object
frozen	True if the object is to be frozen from creation

References frozen(), and GenObject::GenObject().

◆ ~JsObject()

virtual ~JsObject ( )

virtual

Destructor

Member Function Documentation

◆ addConstructor()

static void addConstructor	(	NamedList &	params,
		const char *	name,
		JsObject *	obj )

static

Helper static method that adds a constructor to a parent

Parameters

params	List of parameters where to add the constructor
name	Name of the new parameter
obj	Pointer to the prototype object to add

References JsObject(), and ScriptContext::params().

◆ addObject()

static void addObject	(	NamedList &	params,
		const char *	name,
		JsObject *	obj )

static

Helper static method that adds an object to a parent

Parameters

params	List of parameters where to add the object
name	Name of the new parameter
obj	Pointer to the object to add

References JsObject(), and ScriptContext::params().

◆ buildCallContext()

static JsObject * buildCallContext	(	ScriptMutex *	mtx,
		JsObject *	thisObj = 0 )

static

Create an empty function call context

Parameters

mtx	Pointer to the mutex that serializes this object
thisObj	Optional object that will be set as "this"

Returns: New empty object usable as call context

References JsObject().

◆ clearField()

virtual void clearField ( const String & name )

inlinevirtual

Delete a field of the object

Parameters

name	Name of field to remove

References ScriptContext::params().

◆ clone() [1/2]

virtual JsObject * clone	(	const char *	name,
		const ExpOperation &	oper ) const

inlinevirtual

Clone and rename method

Parameters

name	Name of the cloned object
oper	ExpOperation that required the clone

Returns: New object instance

Reimplemented in JsArray, and JsRegExp.

References JsObject(), and ExpOperation::lineNumber().

Referenced by clone().

◆ clone() [2/2]

JsObject * clone ( const ExpOperation & oper ) const

inline

Clone method

Parameters

oper	ExpOperation that required the clone

Returns: New object instance

References clone(), JsObject(), and ScriptContext::toString().

◆ copy()

virtual JsObject * copy	(	ScriptMutex *	mtx,
		const ExpOperation &	oper ) const

virtual

Deep copy method

Parameters

mtx	Pointer to the mutex that serializes the copied object
oper	Caller of copying operation

Returns: New object instance, does not keep references to old object

Reimplemented in JsArray, JsFunction, and JsRegExp.

References JsObject().

◆ deepCopyParams()

static void deepCopyParams	(	NamedList &	dst,
		const NamedList &	src,
		ScriptMutex *	mtx )

static

Static helper method that deep copies all parameters

Parameters

dst	Destination parameters
src	Source parameters
mtx	Mutex to be used to synchronize all new objects

◆ dumpRecursive()

static void dumpRecursive	(	const GenObject *	obj,
		String &	buf,
		unsigned int	flags = 0xffffffff )

static

Helper method to return the hierarchical structure of an object

Parameters

obj	Object to dump structure
buf	String to which the structure is added
flags	Flags indicating what to dump

References GenObject::GenObject().

◆ extractArgs() [1/2]

static int extractArgs	(	JsObject *	obj,
		ObjList &	stack,
		const ExpOperation &	oper,
		GenObject *	context,
		ObjList &	arguments )

static

Helper static method that pops arguments off a stack to a list in proper order

Parameters

obj	Pointer to the object to use when popping each argument
stack	Evaluation stack in use, parameters are popped off this stack
oper	Function that is being evaluated
context	Pointer to arbitrary object passed from evaluation methods
arguments	List where the arguments are added in proper order

Returns: Number of arguments popped off stack

References GenObject::GenObject(), and JsObject().

Referenced by extractArgs().

◆ extractArgs() [2/2]

int extractArgs	(	ObjList &	stack,
		const ExpOperation &	oper,
		GenObject *	context,
		ObjList &	arguments )

inline

Helper method that pops arguments off a stack to a list in proper order

Parameters

stack	Evaluation stack in use, parameters are popped off this stack
oper	Function that is being evaluated
context	Pointer to arbitrary object passed from evaluation methods
arguments	List where the arguments are added in proper order

Returns: Number of arguments popped off stack

References extractArgs(), and GenObject::GenObject().

◆ fillFieldNames()

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

◆ freeze()

void freeze ( )

inline

Freeze the Javascript object preventing external changes to it

◆ frozen()

bool frozen ( ) const

inline

Retrieve the object frozen status (cannot modify attributes or methods)

Returns: True if the object is frozen

Referenced by JsArray::JsArray(), JsObject(), JsObject(), JsObject(), JsRegExp::JsRegExp(), and JsRegExp::JsRegExp().

◆ getBoolField()

bool getBoolField	(	const String &	name,
		bool &	val )

Get the boolean value of the field with the given name

Parameters

name	Name of field to retrieve
val	Field where to put the retrieved value

Returns: True if field was retrieved, false if not found or not the right type

◆ getField()

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

virtual

Get a pointer to a field in the object or its prototype

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 ScriptContext.

References GenObject::GenObject().

◆ getHashListParams()

virtual const HashList * getHashListParams ( ) const

virtual

Retrieve enclosed hashed list paramsters

Returns: HashList pointer, NULL if this object don't hold one

◆ getIntField()

bool getIntField	(	const String &	name,
		int64_t &	val )

Get the integer value of the field with the given name

Parameters

name	Name of field to retrieve
val	Field where to put the retrieved value

Returns: True if field was retrieved, false if not found or not the right type

◆ getObjField()

bool getObjField	(	const String &	name,
		JsObject *&	obj )

Get the object associated with the field with the given name

Parameters

name	Name of field to retrieve
obj	Field where to put the retrieved value

Returns: True if field was retrieved, false if not found or not the right type

References JsObject().

◆ getStringField()

bool getStringField	(	const String &	name,
		String &	val )

Get the string value of the field with the given name

Parameters

name	Name of field to retrieve
val	Field where to put the retrieved value

Returns: True if field was retrieved, false if not found or not the right type

◆ hasField()

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

virtual

Check if a certain field is assigned in the object or its prototype

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 ScriptContext.

References GenObject::GenObject().

◆ initConstructor()

virtual void initConstructor ( JsFunction * construct )

inlinevirtual

Native constructor initialization, called by addConstructor on the prototype

Parameters

construct Function that has this object as prototype

Reimplemented in JsArray, and JsFunction.

◆ initialize()

static void initialize ( ScriptContext * context )

static

Initialize the standard global objects in a context

Parameters

context Script context to initialize

References ScriptContext::ScriptContext().

◆ lineNo() [1/2]

unsigned int lineNo ( ) const

inline

Get the script line number at which this object was created;

Returns: The line number from the script where this object was created.

◆ lineNo() [2/2]

void lineNo ( unsigned int line )

inline

Set the script line number at which this object was created

Parameters

line	Line number

Referenced by setLineForObj().

◆ mutex() [1/2]

virtual ScriptMutex * mutex ( )

inlinevirtual

Retrieve the Mutex object used to serialize object access

Returns: Pointer to the mutex of the context this object belongs to

Implements ScriptContext.

Referenced by JsArray::clone(), and JsRegExp::clone().

◆ mutex() [2/2]

ScriptMutex * mutex ( ) const

inlineprotected

Retrieve the Mutex object used to serialize object access

Returns: Pointer to the mutex of the context this object belongs to

◆ popValue()

virtual ExpOperation * popValue	(	ObjList &	stack,
		GenObject *	context = 0 )

virtual

Pops and evaluate the value of an operand off an evaluation stack, does not pop a barrier

Parameters

stack	Evaluation stack to remove the operand from
context	Pointer to arbitrary object to be passed to called methods

Returns: Value removed from stack, NULL if stack underflow or field not evaluable

References GenObject::GenObject().

◆ printRecursive()

static void printRecursive	(	const GenObject *	obj,
		unsigned int	flags = 0xffffffff )

static

Helper method to display the hierarchical structure of an object

Parameters

obj	Object to display
flags	Flags indicating what to dump (display)

References GenObject::GenObject().

◆ protoName()

static const String & protoName ( )

inlinestatic

Get the name of the internal property used to track prototypes

Returns: The "__proto__" constant string

◆ runAssign()

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

virtual

Try to assign a value to a single field if object is not frozen

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

Reimplemented in JsArray, and JsRegExp.

References GenObject::GenObject().

◆ runConstructor()

virtual JsObject * runConstructor	(	ObjList &	stack,
		const ExpOperation &	oper,
		GenObject *	context )

virtual

Native object constructor, it's run on the prototype

Parameters

stack	Evaluation stack in use
oper	Constructor function to evaluate
context	Pointer to arbitrary object passed from evaluation methods

Returns: New created and populated Javascript object

Reimplemented in JsArray, and JsRegExp.

References GenObject::GenObject(), and JsObject().

◆ runField()

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

Reimplemented in JsArray.

References GenObject::GenObject().

◆ runFunction()

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

virtual

Try to evaluate a single method

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

References GenObject::GenObject().

◆ runNative()

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

protectedvirtual

Try to evaluate a single native method

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 JsArray, JsFunction, and JsRegExp.

References GenObject::GenObject().

◆ setBoolField()

bool setBoolField	(	const char *	name,
		bool	val )

inline

Set a boolean field in this object

Parameters

name	Name of field to set
val	Boolean value to set

Returns: True if set was successful

References ScriptContext::params().

◆ setIntField()

bool setIntField	(	const char *	name,
		int64_t	val )

inline

Set a integer field in this object

Parameters

name	Name of field to set
val	Integer value to set

Returns: True if set was successful

References ScriptContext::params().

◆ setLineForObj()

static void setLineForObj	(	JsObject *	obj,
		unsigned int	lineNo,
		bool	recursive )

static

Set the creation line for this object and its properties

Parameters

obj	Object t set the line for
lineNo	The line number to set
recursive	True to set it to its sub-objects, false otherwise

References JsObject(), and lineNo().

◆ setMutex()

void setMutex ( ScriptMutex * mtx )

inlineprotected

Set the Mutex used to serialize this object, set to 0 to reset it

Parameters

mtx	Mutex to set

◆ setObjField()

bool setObjField	(	const char *	name,
		JsObject *	obj )

inline

Set a object field in this object

Parameters

name	Name of field to set
obj	Object value to set

Returns: True if set was successful

References JsObject(), and ScriptContext::params().

◆ setPrototype()

void setPrototype	(	GenObject *	context,
		const String &	objName )

Set the object prototype

Parameters

context	Pointer to arbitrary object passed from evaluation methods
objName	Name of the object prototype to set the this object

References GenObject::GenObject().

◆ setStringField()

bool setStringField	(	const char *	name,
		const char *	val )

inline

Set a string field in this object

Parameters

name	Name of field to set
val	String value to set

Returns: True if set was successful

References ScriptContext::params().

◆ strEscape()

static String strEscape ( const char * str )

staticprotected

Static helper method for escaping special characters when JSON stringifying

Parameters

str	String to escape

Returns: Escaped string

References GenObject::GenObject().

◆ toJSON() [1/2]

static ExpOperation * toJSON	(	const ExpOperation *	oper,
		int	spaces )

static

Static method to obtain a JSON representation of the given object

Parameters

oper	Object to represent in JSON format
spaces	Number of spaces used for one indentation level

Returns: String represention of the object

◆ toJSON() [2/2]

static void toJSON	(	const NamedString *	ns,
		String &	buf,
		int	spaces,
		int	indent = 0 )

inlinestaticprotected

Static method to obtain a JSON representation of the given object

Parameters

ns	Object to represent in JSON format
buf	String used as output for the JSON represantion
spaces	Number of spaces used for one indentation level
indent	Current number of spaces used for indentation

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

yatescript.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Friends

Detailed Description

Member Enumeration Documentation

◆ DumpFlags

Constructor & Destructor Documentation

◆ JsObject() [1/3]

◆ JsObject() [2/3]

◆ JsObject() [3/3]

◆ ~JsObject()

Member Function Documentation

◆ addConstructor()

◆ addObject()

◆ buildCallContext()

◆ clearField()

◆ clone() [1/2]

◆ clone() [2/2]

◆ copy()

◆ deepCopyParams()

◆ dumpRecursive()

◆ extractArgs() [1/2]

◆ extractArgs() [2/2]

◆ fillFieldNames()

◆ freeze()

◆ frozen()

◆ getBoolField()

◆ getField()

◆ getHashListParams()

◆ getIntField()

◆ getObjField()

◆ getStringField()

◆ hasField()

◆ initConstructor()

◆ initialize()

◆ lineNo() [1/2]

◆ lineNo() [2/2]

◆ mutex() [1/2]

◆ mutex() [2/2]

◆ popValue()

◆ printRecursive()

◆ protoName()

◆ runAssign()

◆ runConstructor()

◆ runField()

◆ runFunction()

◆ runNative()

◆ setBoolField()

◆ setIntField()

◆ setLineForObj()

◆ setMutex()

◆ setObjField()

◆ setPrototype()

◆ setStringField()

◆ strEscape()

◆ toJSON() [1/2]

◆ toJSON() [2/2]