→ home

→ index of namespace default

→ index of project core

→ index of module core

Class `core.TKS`

Synopsis: Static class that provides various TkScript related utility functions (e.g. reflection helpers).

Base classes:

core.Object

Methods:

classToHashTable(Object c, HashTable ht) : boolean - Write the members of the given meta class instance to the given hash table.
constantToString(int c, String prefix) : String - Try to map a constant integer value to a literal.
evalMethodByName(Object o, String name, Object arglist, Value returnValue) : boolean - Evaluate the given C++ or meta class method.
findClassesByPrefix(String nspaceName, prefix) : PointerArray - Find all script and/or C++ classes that match the given class name prefix.
findScriptClass(String nspaceName, className) : Class - Find the template object for the given script class.
forceUnlockNamedMutex(name ) - Unlock mutex. Should only be called in case something horribly wrent wrong (e.g. a thread holding the mutex has crashed)
getClassID(Object o) : int - Return the classID of the given C++ object.
getClassName(Object o) : String - Return the name of the given object
getDllPrefix() : String - Query prefix for native code DLLs / shared objects.
getDllSuffix() : String - Query suffix for native code DLLs / shared objects.
getHomeDir() : String - Query absolute pathname of user home directory.
getMethodArgumentNames(String namespaceName, scriptClassName, methodName) : StringArray - Query the parameter names of the given script class method.
getMethodNames(Object o) : StringArray - Query the method names of the given C++ or script class.
getNamespaceName(Object o) : String - Return the namespace name of the given object
getNumProperties(Object o) : int - Return the number of meta class members.
getPropertyAccessKeyByIndex(Object o, int index) : int - Query the access key for the nth member of a meta class object.
getPropertyAccessKeyByName(Object o, String name) : int - Query the access key for a member of a meta class object.
getPropertyByAccessKey(int ak) : var - Read meta class member.
getPropertyByName(String name) : var - Return meta class member value by name.
getPropertyClassName(Object o) : String - Return the name of a meta class object.
getPropertyNameByAccessKey(int ak) : String - Return meta class member name.
getTksApplicationPath() : String - Query absolute pathname of tks application directory.
getTksExeDir() : String - Query absolute pathname of tks executable.
getTksLibraryPath() : String - Query absolute pathname of tks library directory.
getTksModulePath() : String - Query absolute pathname of tks modules directory.
getTksPluginPath() : String - Query absolute pathname of tks plugins directory.
getVersion() : int - Return TkScript version identifier.
getVersionString() : String - Return TkScript version string.
hashTableToClass(HashTable ht, Object c) : boolean - Iterate hash table and copy the elements to members of "c".
is64Bit() : boolean - Query whether it's a 64bit runtime environment.
isBigEndian() - Check whether TKS is running on a big endian host.
lockNamedMutex(name ) - Lock mutex that was declared using the =mutexname= syntax.
newObjectArrayByName(String nspace, name) : Object - Resolve object name and create an empty array of equally typed objects.
newObjectByID(int classID) : Object - Return a new instance of the given C++ class.
newObjectByName(String nspace, name) : Object - Create a new instance of a script or C++ class.
reinstallDebugHandler() - Hack to re-install exception filter after a DLL has changed it.
scriptClassConstantToString(Value vo, Class clazz, String prefix) : String - Try to map a constant to script class constant name.
setFloatPropertyByName(Object o, String name, float f) - Set a float member of a meta class object.
setIntPropertyByName(Object o, String name, int i) - Set an integer member of a meta class object.
setObjectPropertyByName(Object o, String name, Object o) - Set an object member of a meta class object.
sleep(int milliSec) - Suspend the current thread for the given number of milli seconds.
stringToConstant(String name) : var - Try to map a named constant to its value.
unlockNamedMutex(name ) - Unlock mutex that was declared using the =mutexname= syntax.
yield() - Yield CPU time to the next thread.

Constants:

int SIGABRT -
int SIGFPE -
int SIGILL -
int SIGINT -
int SIGSEGV -
int SIGTERM -
int YAC_BIG_ENDIAN - Stream byteorder (MSB first)
int YAC_LITTLE_ENDIAN - Stream byteorder (LSB first)
int YAC_OP_ADD - Object.yacOperator() command id (add)
int YAC_OP_AND - Object.yacOperator() command id (bitwise and)
int YAC_OP_ASSIGN - Object.yacOperator() command id (assign)
int YAC_OP_BITNOT - Object.yacOperator() command id (bitwise not)
int YAC_OP_CEQ - Object.yacOperator() command id (compare equal)
int YAC_OP_CGE - Object.yacOperator() command id (compare greater equal)
int YAC_OP_CGT - Object.yacOperator() command id (compare greater than)
int YAC_OP_CLE - Object.yacOperator() command id (compare less equal)
int YAC_OP_CLT - Object.yacOperator() command id (compare less than)
int YAC_OP_CNE - Object.yacOperator() command id (compare not equal)
int YAC_OP_DIV - Object.yacOperator() command id (divide)
int YAC_OP_EOR - Object.yacOperator() command id (bitwise exclusive or)
int YAC_OP_INIT - Object.yacOperator() command id (init)
int YAC_OP_LAND - Object.yacOperator() command id (logical and)
int YAC_OP_LEOR - Object.yacOperator() command id (logical exclusive or)
int YAC_OP_LOR - Object.yacOperator() command id (logical or)
int YAC_OP_MOD - Object.yacOperator() command id (modulo)
int YAC_OP_MUL - Object.yacOperator() command id (multiply)
int YAC_OP_NEG - Object.yacOperator() command id (negate)
int YAC_OP_NOT - Object.yacOperator() command id (logical not)
int YAC_OP_OR - Object.yacOperator() command id (bitwise or)
int YAC_OP_SHL - Object.yacOperator() command id (shift left)
int YAC_OP_SHR - Object.yacOperator() command id (shift right)
int YAC_OP_SUB - Object.yacOperator() command id (subtract)
int YAC_TYPE_FLOAT -
int YAC_TYPE_INT -
int YAC_TYPE_OBJECT -
int YAC_TYPE_STRING -
int YAC_TYPE_VOID -

Method classToHashTable

Write the members of the given meta class instance to the given hash table.

Signature

classToHashTable	(	Object	c	,
		HashTable	ht
		)
	:	boolean

Arguments

Object	c	–	Meta class instance (script class)
HashTable	ht	–	Target hashtable

Returns

boolean

–

true if all object members have been written to the hashtable or false otherwise

→ top of page

Method constantToString

Try to map a constant integer value to a literal.

Signature

constantToString	(	int	c	,
		String	prefix
		)
	:	String

Arguments

int	c	–	Integer constant
String	prefix	–	Prefix of constant name

Returns

String

–

→ top of page

Method evalMethodByName

Evaluate the given C++ or meta class method.

Signature

evalMethodByName	(	Object	o	,
		String	name	,
		Object	arglist	,
		Value	returnValue
		)
	:	boolean

Arguments

Object	o	–	Object to operate on
String	name	–	Method name
Object	arglist	–	Argument list (array, list, ..)
Value	returnValue	–	Receives the method return value

Returns

boolean

–

true if the method has been called successfully, false otherwise

→ top of page

Method findClassesByPrefix

Find all script and/or C++ classes that match the given class name prefix.

Signature

findClassesByPrefix	(	String	nspaceName	,
		String	prefix
		)
	:	PointerArray

Arguments

String	nspaceName	–	"yac" to only search C++ classes, null to search all classes (script classes first), or namespace name to match.
String	prefix	–	null to match all class names, class name prefix otherwise.

Returns

PointerArray

–

PointerArray that holds template object references to all matching classes.

Description

If nspaceName is "yac", only C++ will be searched.
This method supports the => operator.

→ top of page

Method findScriptClass

Find the template object for the given script class.

Signature

findScriptClass	(	String	nspaceName	,
		String	className
		)
	:	Class

Arguments

String	nspaceName	–	Name of the namespace or NULL (default namespace)
String	className	–	Name of the script class

Returns

Class

–

template object for the given script class or null if the given name does not map to a script class.

→ top of page

Method forceUnlockNamedMutex

Unlock mutex. Should only be called in case something horribly wrent wrong (e.g. a thread holding the mutex has crashed)

Signature

forceUnlockNamedMutex

(

name

)

Arguments

name

–

Description

This method might be removed, pls don't call.

→ top of page

Method getClassID

Return the classID of the given C++ object.

Signature

getClassID	(	Object	o	)
	:	int

Arguments

Object

–

The object in question

Returns

int

–

C++ classID

→ top of page

Method getClassName

Return the name of the given object

Signature

getClassName	(	Object	o	)
	:	String

Arguments

Object

–

The object in question

Returns

String

–

new String instance holding the class name or null if "o" is not a valid object.

See also:

→ top of page

Method getDllPrefix

Query prefix for native code DLLs / shared objects.

Signature

getDllPrefix

(

)

String

Returns

String

–

"" on Windows, "lib" on Linux, MacOSX, ..

→ top of page

Method getDllSuffix

Query suffix for native code DLLs / shared objects.

Signature

getDllSuffix

(

)

String

Returns

String

–

".dll" on Windows, ".so" on Linux, MacOSX, ..

→ top of page

Method getHomeDir

Query absolute pathname of user home directory.

Signature

getHomeDir

(

)

String

Returns

String

–

Absolute pathname of user home directory

→ top of page

Method getMethodArgumentNames

Query the parameter names of the given script class method.

Signature

getMethodArgumentNames	(	String	namespaceName	,
		String	scriptClassName	,
		String	methodName
		)
	:	StringArray

Arguments

String	namespaceName	–	Name of the namespace, null to search default namespace
String	scriptClassName	–	Name of the script class
String	methodName	–	Method name

Returns

StringArray

–

new StringArray instance holding the method parameter names or null if the class or method was not found.

→ top of page

Method getMethodNames

Query the method names of the given C++ or script class.

Signature

getMethodNames	(	Object	o	)
	:	StringArray

Arguments

Object

–

C++ or script (meta) class instance

Returns

StringArray

–

new StringArray instance holding the method names for the given class or null if "o" is not a valid object.

→ top of page

Method getNamespaceName

Return the namespace name of the given object

Signature

getNamespaceName	(	Object	o	)
	:	String

Arguments

Object

–

The object in question

Returns

String

–

new String instance holding the namespace name or null if "o" is not a valid object.

See also:

getClassName()

→ top of page

Method getNumProperties

Return the number of meta class members.

Signature

getNumProperties	(	Object	o	)
	:	int

Arguments

Object

–

The object in question

Returns

int

–

Number of meta class members

See also:

Object.yacMetaClassMemberGetNum()

→ top of page

Method getPropertyAccessKeyByIndex

Query the access key for the nth member of a meta class object.

Signature

getPropertyAccessKeyByIndex	(	Object	o	,
		int	index
		)
	:	int

Arguments

Object	o	–	The object in question
int	index	–

Returns

int

–

Description

This is a tool method to handle meta class objects like e.g. script classes.

See also:

→ top of page

Method getPropertyAccessKeyByName

Query the access key for a member of a meta class object.

Signature

getPropertyAccessKeyByName	(	Object	o	,
		String	name
		)
	:	int

Arguments

Object	o	–	The object in question
String	name	–	Member name

Returns

int

–

Description

This is a tool method to handle meta class objects like e.g. script classes.

See also:

→ top of page

Method getPropertyByAccessKey

Read meta class member.

Signature

getPropertyByAccessKey	(	int	ak	)
	:	var

Arguments

int

–

Access key to the meta class member

Returns

var

–

Member value

See also:

Object.yacMetaClassMemberGet()

→ top of page

Method getPropertyByName

Return meta class member value by name.

Signature

getPropertyByName	(	String	name	)
	:	var

Arguments

String

name

–

Member name

Returns

var

–

Member value

See also:

→ top of page

Method getPropertyClassName

Return the name of a meta class object.

Signature

getPropertyClassName	(	Object	o	)
	:	String

Arguments

Object

–

The object in question

Returns

String

–

Meta class name

See also:

Object.yacMetaClassName()

→ top of page

Method getPropertyNameByAccessKey

Return meta class member name.

Signature

getPropertyNameByAccessKey	(	int	ak	)
	:	String

Arguments

int

–

Access key to the meta class member

Returns

String

–

Member name

See also:

Object.yacMetaClassMemberGet()

→ top of page

Method getTksApplicationPath

Query absolute pathname of tks application directory.

Signature

getTksApplicationPath

(

)

String

Returns

String

–

Absolute pathname of tks application directory

→ top of page

Method getTksExeDir

Query absolute pathname of tks executable.

Signature

getTksExeDir

(

)

String

Returns

String

–

Absolute pathname of tks executable

→ top of page

Method getTksLibraryPath

Query absolute pathname of tks library directory.

Signature

getTksLibraryPath

(

)

String

Returns

String

–

Absolute pathname of tks library directory

→ top of page

Method getTksModulePath

Query absolute pathname of tks modules directory.

Signature

getTksModulePath

(

)

String

Returns

String

–

Absolute pathname of tks modules directory

→ top of page

Method getTksPluginPath

Query absolute pathname of tks plugins directory.

Signature

getTksPluginPath

(

)

String

Returns

String

–

Absolute pathname of tks plugins directory

→ top of page

Method getVersion

Return TkScript version identifier.

Signature

getVersion

(

)

int

Returns

int

–

TkScript version 32bit integer value

Description

The format is 0xmmiirrpp, where mm=major version, ii=minor version major, rr=release number, pp=patch.

See also:

getVersionString()

→ top of page

Method getVersionString

Return TkScript version string.

Signature

getVersionString

(

)

String

Returns

String

–

Version string

Description

Each byte is converted to decimal, sub-version numbers are separated by the '.' char.

See also:

getVersion()

→ top of page

Method hashTableToClass

Iterate hash table and copy the elements to members of "c".

Signature

hashTableToClass	(	HashTable	ht	,
		Object	c
		)
	:	boolean

Arguments

HashTable	ht	–	Source hashtable
Object	c	–	Destination metaclass instance (scriptclass object)

Returns

boolean

–

true if all hash table entries were copied to the object or false, otherwise.

Description

All deletable objects will be unlinked from the hashtable.

→ top of page

Method is64Bit

Query whether it's a 64bit runtime environment.

Signature

is64Bit

(

)

boolean

Returns

boolean

–

True if it's 64bit, false if 32bit (less is not supported).

→ top of page

Method isBigEndian

Check whether TKS is running on a big endian host.

Signature

isBigEndian

(

)

→ top of page

Method lockNamedMutex

Lock mutex that was declared using the =mutexname= syntax.

Signature

lockNamedMutex

(

name

)

Arguments

name

–

→ top of page

Method newObjectArrayByName

Resolve object name and create an empty array of equally typed objects.

Signature

newObjectArrayByName	(	String	nspace	,
		String	name
		)
	:	Object

Arguments

String	nspace	–	Namespace name or null
String	name	–	Name of the element object class

Returns

Object

–

Array object

Description

If the object class has a special array object (see Object.yacArrayNew()), an instance of the given array object class will be returned. A generic ObjectArray will be created, otherwise.

See also:

Object.yacArrayNew()

→ top of page

Method newObjectByID

Return a new instance of the given C++ class.

Signature

newObjectByID	(	int	classID	)
	:	Object

Arguments

int

classID

–

Name-id of a C++ class

Returns

Object

–

C++ class instance

Description

This method has to be used with care since classIDs are not constants and may vary between different releases of TkScript. Plugin classes always have dynamic class IDs.

→ top of page

Method newObjectByName

Create a new instance of a script or C++ class.

Signature

newObjectByName	(	String	nspace	,
		String	name
		)
	:	Object

Arguments

String	nspace	–	Namespace name or null
String	name	–	Class name

Returns

Object – New object instance or null if the given name does not map to a script or C++ class.

→ top of page

Method reinstallDebugHandler

Hack to re-install exception filter after a DLL has changed it.

Signature

reinstallDebugHandler

(

)

→ top of page

Method scriptClassConstantToString

Try to map a constant to script class constant name.

Signature

scriptClassConstantToString	(	Value	vo	,
		Class	clazz	,
		String	prefix
		)
	:	String

Arguments

Value	vo	–	→ValueObject that the constants are compared with
Class	clazz	–	`Class` in which to search
String	prefix	–	Prefix of constant name

Returns

String

–

→ top of page

Method setFloatPropertyByName

Set a float member of a meta class object.

Signature

setFloatPropertyByName	(	Object	o	,
		String	name	,
		float	f
		)

Arguments

Object	o	–	The object in question
String	name	–	Name of the property to modify
float	f	–	New value for the float property

Description

This is a tool method to handle meta class objects like e.g. script classes.

See also:

→ top of page

Method setIntPropertyByName

Set an integer member of a meta class object.

Signature

setIntPropertyByName	(	Object	o	,
		String	name	,
		int	i
		)

Arguments

Object	o	–	The object in question
String	name	–	Name of the property to modify
int	i	–	New value for the integer property

Description

This is a tool method to handle meta class objects like e.g. script classes.

See also:

→ top of page

Method setObjectPropertyByName

Set an object member of a meta class object.

Signature

setObjectPropertyByName	(	Object	o	,
		String	name	,
		Object	o
		)

Arguments

Object	o	–	The object in question
String	name	–	Name of the property to modify
Object	o	–	The object in question

Description

This is a tool method to handle meta class objects like e.g. script classes.

See also:

→ top of page

Method sleep

Suspend the current thread for the given number of milli seconds.

Signature

sleep

(

int

milliSec

)

Arguments

int

milliSec

–

Number of milli seconds

→ top of page

Method stringToConstant

Try to map a named constant to its value.

Signature

stringToConstant	(	String	name	)
	:	var

Arguments

String

name

–

Name of the constant

Returns

var – Constant value or void if the given name does not map to any constant

→ top of page

Method unlockNamedMutex

Unlock mutex that was declared using the =mutexname= syntax.

Signature

unlockNamedMutex

(

name

)

Arguments

name

–

→ top of page

Method yield

Yield CPU time to the next thread.

Signature

yield

(

)

→ top of page

Constant `SIGABRT (int)`

Constant `SIGFPE (int)`

Constant `SIGILL (int)`

Constant `SIGINT (int)`

Constant `SIGSEGV (int)`

Constant `SIGTERM (int)`

Constant `YAC_BIG_ENDIAN (int)`
Stream byteorder (MSB first)

Constant `YAC_LITTLE_ENDIAN (int)`
Stream byteorder (LSB first)

Constant `YAC_OP_ADD (int)`
`Object.yacOperator()` command id (add)

Constant `YAC_OP_AND (int)`
`Object.yacOperator()` command id (bitwise and)

Constant `YAC_OP_ASSIGN (int)`
`Object.yacOperator()` command id (assign)

Constant `YAC_OP_BITNOT (int)`
`Object.yacOperator()` command id (bitwise not)

Constant `YAC_OP_CEQ (int)`
`Object.yacOperator()` command id (compare equal)

Constant `YAC_OP_CGE (int)`
`Object.yacOperator()` command id (compare greater equal)

Constant `YAC_OP_CGT (int)`
`Object.yacOperator()` command id (compare greater than)

Constant `YAC_OP_CLE (int)`
`Object.yacOperator()` command id (compare less equal)

Constant `YAC_OP_CLT (int)`
`Object.yacOperator()` command id (compare less than)

Constant `YAC_OP_CNE (int)`
`Object.yacOperator()` command id (compare not equal)

Constant `YAC_OP_DIV (int)`
`Object.yacOperator()` command id (divide)

Constant `YAC_OP_EOR (int)`
`Object.yacOperator()` command id (bitwise exclusive or)

Constant `YAC_OP_INIT (int)`
`Object.yacOperator()` command id (init)

Constant `YAC_OP_LAND (int)`
`Object.yacOperator()` command id (logical and)

Constant `YAC_OP_LEOR (int)`
`Object.yacOperator()` command id (logical exclusive or)

Constant `YAC_OP_LOR (int)`
`Object.yacOperator()` command id (logical or)

Constant `YAC_OP_MOD (int)`
`Object.yacOperator()` command id (modulo)

Constant `YAC_OP_MUL (int)`
`Object.yacOperator()` command id (multiply)

Constant `YAC_OP_NEG (int)`
`Object.yacOperator()` command id (negate)

Constant `YAC_OP_NOT (int)`
`Object.yacOperator()` command id (logical not)

Constant `YAC_OP_OR (int)`
`Object.yacOperator()` command id (bitwise or)

Constant `YAC_OP_SHL (int)`
`Object.yacOperator()` command id (shift left)

Constant `YAC_OP_SHR (int)`
`Object.yacOperator()` command id (shift right)

Constant `YAC_OP_SUB (int)`
`Object.yacOperator()` command id (subtract)

Constant `YAC_TYPE_FLOAT (int)`

Constant `YAC_TYPE_INT (int)`

Constant `YAC_TYPE_OBJECT (int)`

Constant `YAC_TYPE_STRING (int)`

Constant `YAC_TYPE_VOID (int)`

Project Modules:	`core`
Project Classes:	`Boolean` , `Buffer` , `Byte` , `Class` , `ClassArray` , `Condition` , `Configuration` , `Double` , `DummyStream` , `Envelope` , `Event` , `Exception` , `File` , `Float` , `FloatArray` , `FloatArray128` , `FloatArray16` , `FloatArray32` , `FloatArray64` , `FloatArray8` , `Function` , `HashTable` , `IntArray` , `IntArray128` , `IntArray16` , `IntArray32` , `IntArray64` , `IntArray8` , `Integer` , `List` , `ListNode` , `Long` , `Mailbox` , `Mutex` , `Object` , `ObjectArray` , `PakFile` , `PointerArray` , `Pool` , `Script` , `SharedBuffer` , `Short` , `Stack` , `StdErrStream` , `StdInStream` , `StdOutStream` , `Stream` , `String` , `String128` , `String16` , `String32` , `String64` , `String8` , `StringArray` , `StringIterator` , `Thread` , `Time` , `TKS` , `TreeNode` , `UnsignedByte` , `UnsignedInteger` , `UnsignedLong` , `UnsignedShort` , `Value` , `ValueArray` , `Variable`
Project Functions:	`ceil` , `exit` , `floor` , `GetCurrentThread` , `getenv` , `lcchar` , `mathAbsMaxf` , `mathAbsMinf` , `mathAbsMini` , `mathAbsMini` , `mathClampf` , `mathClampi` , `mathDistancePointPlane2d` , `mathLerpf` , `mathMaxf` , `mathMaxi` , `mathMinf` , `mathMini` , `mathPowerf` , `mathPoweri` , `mathSmoothStepf` , `mathWrapf` , `mathWrapi` , `milliSeconds` , `psystem` , `putenv` , `srand` , `system` , `ucchar`
All Namespaces:	`default` , `ui`
All Projects:	`core` , `debugtext` , `tkfreetype2` , `tkmath` , `tkmidi` , `tkopengl` , `tkportaudio` , `tksdl` , `tkui` , `tkunit`

auto-generated by "DOG", the TkScript document generator. Mon, 28/Dec/2015 13:15:54

Class core.TKS

Class `core.TKS`