class runtime

Static class containing functions that provide information about the JewelScript runtime.

Global Functions

string compilerVersion ()Returns the version number of the compiler.
int debugBuild ()Returns true if this is a debug build of the runtime.
int generateBindings (const string)Generates native binding code at the specified path.
int generateDocs (const string, const string)Generates HTML documentation at the specified path.
int getBaseType (int)Returns the base class type ID for the specified type ID.
int getNumTypes ()Returns the total number of types known to the runtime.
string getTypeAuthor (int)Returns the author string of the specified native type.
string getTypeDescription (int)Returns the description string of the specified native type.
int getTypeFamily (int)Returns the type family ID for the specified type ID.
int getTypeID (const string)Returns the type ID for the specified type name.
string getTypeName (int)Returns the type name for the specified type identifier number.
string getTypeTimeStamp (int)Returns the build time stamp of the specified native type.
string getTypeVersion (int)Returns the version string of the specified native type.
int instructionCounter ()Returns the current value of the instruction counter.
int isTypeNative (int)Returns true if the specified type is a native class.
string libraryVersion ()Returns the version number of the JewelScript library.
int releaseBuild ()Return true if this is a release build of the runtime.
int runtimeChecks ()Returns true if the virtual machine performs extended runtime checks.
string runtimeVersion ()Returns the version number of the runtime.
int stackSize ()Returns the stack size specified when initializing this runtime.
int traceException ()Returns true if the virtual machine supports the trace exception.
string typeInterfaceVersion ()Returns the version number of the native type interface.

Reference

function string compilerVersion ()

Returns the version number of the compiler.


function int debugBuild ()

Returns true if this is a debug build of the runtime.


function int generateBindings (const string path)

Generates native binding code at the specified path.

To save memory, the application can free the compiler before executing the script, in which case this function will do nothing.


function int generateDocs (const string path, const string args)

Generates HTML documentation at the specified path.

To save memory, the application can free the compiler before executing the script, in which case this function will do nothing.


function int getBaseType (int type)

Returns the base class type ID for the specified type ID.


function int getNumTypes ()

Returns the total number of types known to the runtime.


function string getTypeAuthor (int type)

Returns the author string of the specified native type.


function string getTypeDescription (int type)

Returns the description string of the specified native type.


function int getTypeFamily (int type)

Returns the type family ID for the specified type ID.


function int getTypeID (const string name)

Returns the type ID for the specified type name.

If the name is not a type name, returns 0.


function string getTypeName (int type)

Returns the type name for the specified type identifier number.


function string getTypeTimeStamp (int type)

Returns the build time stamp of the specified native type.


function string getTypeVersion (int type)

Returns the version string of the specified native type.


function int instructionCounter ()

Returns the current value of the instruction counter.

The instruction counter is a signed 32-bit integer that is increased for each executed VM instruction. If this feature has been disabled, the result is always 0.


function int isTypeNative (int type)

Returns true if the specified type is a native class.


function string libraryVersion ()

Returns the version number of the JewelScript library.


function int releaseBuild ()

Return true if this is a release build of the runtime.


function int runtimeChecks ()

Returns true if the virtual machine performs extended runtime checks.


function string runtimeVersion ()

Returns the version number of the runtime.


function int stackSize ()

Returns the stack size specified when initializing this runtime.


function int traceException ()

Returns true if the virtual machine supports the trace exception.


function string typeInterfaceVersion ()

Returns the version number of the native type interface.