The function signature QScriptValue f(QScriptContext *, QScriptEngine *). A function with such a signature can be passed to QScriptEngine::newFunction() to wrap the function.

The function signature QScriptValue f(QScriptContext *, QScriptEngine *, void *).

A function with such a signature can be passed to QScriptEngine::newFunction() to wrap the function.

This enum specifies the ownership when wrapping a C++ value, e.g. by using newQObject().

Constructs a QScriptEngine object. The globalObject() is initialized to have properties as described in ECMA-262, Section 15.1.

Constructs a QScriptEngine object with the given parent. The globalObject() is initialized to have properties as described in ECMA-262, Section 15.1.

Destroys this QScriptEngine.

Aborts any script evaluation currently taking place in this engine. The given result is passed back as the result of the evaluation (i.e. it is returned from the call to evaluate() being aborted). If the engine is not evaluating a script (i.e. isEvaluating() returns false), this function does nothing.

Call this function if you need to abort a running script for some reason, e.g. when you have detected that the script has been running for several seconds without completing.

See also

evaluate(), isEvaluating(), setProcessEventsInterval()

Returns the agent currently installed on this engine or a nullptr if no agent is installed.

See also

setAgent()

Returns a list naming the available extensions that can be imported using the importExtension() function. This list includes extensions that have been imported.

See also

importExtension(), importedExtensions()

Deprecated:

Returns true if program can be evaluated; i.e. the code is sufficient to determine whether it appears to be a syntactically correct program, or contains a syntax error.

This function returns false if program is incomplete; i.e. the input is syntactically correct up to the point where the input is terminated.

Note that this function only does a static check of program; e.g. it does not check whether references to variables are valid, and so on.

A typical usage of canEvaluate() is to implement an interactive interpreter for CsScript. The user is repeatedly queried for individual lines of code; the lines are concatenated internally, and only when canEvaluate() returns true for the resulting program is it passed to evaluate().

The following are some examples to illustrate the behavior of canEvaluate(). (Note that all example inputs are assumed to have an explicit newline as their last character, since otherwise the CsScript parser would automatically insert a semi-colon character at the end of the input, and this could cause canEvaluate() to produce different results.)

Given the input

canEvaluate() will return true, since the program appears to be complete.

Given the input

canEvaluate() will return false, since the if-statement is not complete, but is syntactically correct so far.

Given the input

canEvaluate() will return true, but evaluate() will throw a SyntaxError given the same input.

Given the input

canEvaluate() will return true, even though the code is clearly not syntactically valid CsScript code. evaluate() will throw a SyntaxError when this code is evaluated.

Given the input

canEvaluate() will return true, but evaluate() will throw a ReferenceError if foo is not defined in the script environment.

See also

evaluate(), checkSyntax()

Checks the syntax of the given program. Returns a QScriptSyntaxCheckResult object that contains the result of the check.

Clears any uncaught exceptions in this engine.

See also

hasUncaughtException()

Runs the garbage collector which will attempt to reclaim memory by locating and disposing of objects that are no longer reachable in the script environment.

Normally you do not need to call this function. The garbage collector will automatically be invoked when the QScriptEngine decides that it's wise to do so (i.e. when a certain number of new objects have been created). However, you can call this function to explicitly request that garbage collection should be performed as soon as possible.

See also

reportAdditionalMemoryCost()

Returns the current context which is typically accessed to retrieve the arguments and "this" object in native functions. It is available as the first argument in QScriptEngine::FunctionSignature.

Returns the default prototype associated with the given metaTypeId or an invalid QScriptValue if no default prototype has been set.

See also

setDefaultPrototype()

Evaluates the given program and returns the result of the evaluation.

Evaluates program, using lineNumber as the base line number, and returns the result of the evaluation. The script code will be evaluated in the current context.

The evaluation of program can cause an exception in the engine; in this case the return value will be the exception that was thrown (typically an Error object). You can call hasUncaughtException() to determine if an exception occurred in the last call to evaluate().

The lineNumber is used to specify a starting line number for program. The line number information reported by the engine that pertain to this evaluation (e.g. uncaughtExceptionLineNumber()) will be based on this argument. For example, if program consists of two lines of code, and the statement on the second line causes a script exception, uncaughtExceptionLineNumber() would return the given lineNumber plus one. When no starting line number is specified, line numbers will be 1-based.

The fileName is used for error reporting. For example in error objects the file name is accessible through the "fileName" property if it's provided with this function.

See also

canEvaluate(), hasUncaughtException(), isEvaluating(), abortEvaluation()

Returns the given value converted to the template type T which must be registered with QVariant.

Refer to Conversion from %CsScript to C++ for a description of the built-in type conversion provided by CsScript.

See also

toScriptValue(), qScriptRegisterMetaType()

Returns this engine's Global Object.

By default, the Global Object contains the built-in objects that are part of ECMA-262, such as Math, Date and String. Additionally, you can set properties of the Global Object to make your own extensions available to all script code. Non-local variables in script code will be created as properties of the Global Object, as well as local variables in global code.

See also

setGlobalObject()

Returns true if the last script evaluation resulted in an uncaught exception, otherwise returns false. The exception state is cleared when evaluate() is called.

See also

uncaughtException(), uncaughtExceptionLineNumber()

Returns a list naming the extensions that have been imported using the importExtension() function.

See also

availableExtensions()

Imports the given extension into this QScriptEngine. Returns undefinedValue() if the extension was successfully imported. You can call hasUncaughtException() to check if an error occurred; in that case, the return value is the value that was thrown by the exception (usually an Error object).

QScriptEngine ensures that a particular extension is only imported once; subsequent calls to importExtension() with the same extension name will do nothing and return undefinedValue().

See also

availableExtensions(), QScriptExtensionPlugin, Creating CsScript Extensions

Installs translator functions on the given object, or on the Global Object if no object is specified. The relation between CsScript translator functions and C++ translator functions is described in the following table.

See also

Internationalization

Returns true if this engine is currently evaluating a script, otherwise returns false.

See also

evaluate(), abortEvaluation()

Creates a CsScript object of class Array with the given length.

See also

newObject()

Creates a CsScript object of class Date from the given value.

See also

QScriptValue::toDateTime()

Creates a CsScript object of class Date with the given value (the number of milliseconds since 01 January 1970, UTC).

Creates a constructor function from signature with the given length. The protype property of the resulting function is set to the given prototype. The constructor property of prototype is set to the resulting function.

When a function is called as a constructor, the "this" object associated with the function call is the new object the function is expected to initialize. The prototype of this default constructed object will be the function's public prototype property. If you always want the function to behave as a constructor or if you need to create your own object rather than using the default "this" object, you should make sure the prototype of your object is set correctly. Either set it manually or wrap a custom type by registering the defaultPrototype() of that type.

The following is sample code to wrap a custom type and provide a constructor for it.

Creates a QScriptValue that wraps a native C++ function specified by the given signature. The signature must be a C++ free function with signature matching QScriptEngine::FunctionSignature.

The length is the number of arguments signature expects and this becomes the length property of the created QScriptValue. The length only gives an indication of the number of arguments the function expects. An actual invocation of a function can include any number of arguments. This can be checked by calling argumentCount() on the QScriptContext passed to your function.

A prototype property is automatically created for the resulting function object to provide for the possibility that the function will be used as a constructor.

By combining newFunction() and the property flags QScriptValue::PropertyGetter and QScriptValue::PropertySetter, you can create script object properties which behaves like normal properties in script code, but are in fact accessed through functions. This is analogous to how properties work in Property System.

When the property somePropertyName of the script object is subsequently accessed in script code, getOrSetMyProperty() will be invoked to handle the access. In this particular case we are storing the "real" value of somePropertyName as a property of the accessor function itself.

In the example shown above a single native function was used to handle both reads and writes to the property. The argument count is used to determine if we are handling a read or write.

Alternatively, you can also use two separate free functions and specify the QScriptValue::PropertyGetter or QScriptValue::PropertySetter.

See also

QScriptValue::call()

Creates a CsScript object of class Object. The prototype of the created object will be the Object prototype object.

See also

newArray(), QScriptValue::setProperty()

Creates a CsScript Object of the given class, scriptClass. The prototype of the created object will be the Object prototype object. The value for data is set as the internal data of the new object (using QScriptValue::setData()).

See also

QScriptValue::scriptClass(), reportAdditionalMemoryCost()

Creates a CsScript object that represents a QObject class, using the given metaObject and constructor ctor.

Enums of metaObject (declared with CS_ENUM) are available as properties of the created QScriptValue. When the class is called as a function, ctor will be called to create a new instance of the class.

See also

newQObject(), scriptValueFromQMetaObject()

Initializes the given scriptObject to hold the given qtObject, and returns the scriptObject.

This function enables you to "promote" a plain CsScript object (created by the newObject() function) to a QObject proxy, or to replace the QObject contained inside an object previously created by the newQObject() function.

The prototype() of the scriptObject will remain unchanged.

If scriptObject is not an object, this function behaves like the normal newQObject(), i.e. it creates a new script object and returns it.

This method is useful when you want to provide a script constructor for a QObject based class. If your constructor is invoked in a new expression (QScriptContext::isCalledAsConstructor() returns true), you can pass QScriptContext::thisObject() (the default constructed script object) to this function to initialize the new object.

See also

reportAdditionalMemoryCost()

Creates a CsScript object that wraps the given QObject object, using the given ownership. The given options control various aspects of the interaction with the resulting script object. Signals and slots, properties and children of object are available as properties of the created QScriptValue. For more information, see the CsScript documentation.

If object is a null pointer this method returns nullValue(). If a default prototype has been registered for the object class or a parent class, the prototype of the new script object will be set to be that default prototype.

If the given object is deleted outside of the CsScript control, any attempt to access the deleted QObject's members through the CsScript wrapper object (either by script code or C++) will result in a script exception.

See also

QScriptValue::toQObject(), reportAdditionalMemoryCost()

Creates a CsScript object of class QRegularExpression with the given regexp.

See also

QScriptValue::toRegExp()

Creates a CsScript object of class QRegularExpressionwith the given pattern and flags.

The legal flags are 'g' (global), 'i' (ignore case), and 'm' (multiline).

Initializes the given CsScript object to hold the given variant value, and returns the object.

This function enables you to "promote" a plain CsScript object (created by the newObject() function) to a variant, or to replace the variant contained inside an object previously created by the newVariant() function.

The prototype() of the object will remain unchanged.

If object is not an object, this function behaves like the normal newVariant(), i.e. it creates a new script object and returns it.

This function is useful when you want to provide a script constructor for a C++ type. If your constructor is invoked in a new expression (QScriptContext::isCalledAsConstructor() returns true), you can pass QScriptContext::thisObject() (the default constructed script object) to this function to initialize the new object.

See also

reportAdditionalMemoryCost()

Creates a CsScript object holding the given variant value.

If a default prototype has been registered with the meta type id of value, then the prototype of the created object will be that prototype, otherwise the prototype will be the Object prototype object.

See also

setDefaultPrototype(), QScriptValue::toVariant(), reportAdditionalMemoryCost()

Returns a QScriptValue of the primitive type Null.

See also

undefinedValue()

Pops the current execution context and restores the previous one. This function must be used in conjunction with pushContext().

See also

pushContext()

Returns the interval in milliseconds between calls to QCoreApplication::processEvents() while the interpreter is running.

See also

setProcessEventsInterval()

Enters a new execution context and returns the associated QScriptContext object. Once you are done with the context, you should call popContext() to restore the old context. By default, the "this" object of the new context is the Global Object. The context's callee() will be invalid.

This function is useful when you want to evaluate script code as if it were the body of a function. You can use the context's activationObject() to initialize local variables that will be available to scripts.

In the above example, the new variable "tmp" defined in the script will be local to the context; in other words, the script does not have any effect on the global environment.

Returns a nullptr in case of astack overflow.

See also

popContext()

Reports an additional memory cost of the given size, measured in bytes, to the garbage collector.

This function can be called to indicate that a CsScript object has memory associated with it that is not managed by CsScript itself. Reporting the additional cost makes it more likely that the garbage collector will be triggered.

Note that if the additional memory is shared with objects outside the scripting environment, the cost should not be reported, since collecting the CsScript object would not cause the memory to be freed anyway.

Negative size values are ignored, i.e. this function can not be used to report that the additional memory has been deallocated.

See also

collectGarbage()

Creates a QScriptValue that represents the CopperSpice class T.

This function is used in combination with one of the Q_SCRIPT_DECLARE_QMETAOBJECT() macro.

See also

QScriptEngine::newQMetaObject()

Installs the given agent on this engine. The agent will be notified of various events pertaining to script execution. This is useful when you want to find out exactly what the engine is doing, e.g. when evaluate() is called. The agent interface is the basis of tools like debuggers and profilers.

The engine maintains ownership of the agent.

Calling this function will replace the existing agent, if any.

See also

agent()

Sets the default prototype of the C++ type identified by the given metaTypeId to prototype.

The default prototype provides a script interface for values of type metaTypeId when a value of that type is accessed from script code. Whenever the script engine (implicitly or explicitly) creates a QScriptValue from a value of type metaTypeId, the default prototype will be set as the QScriptValue's prototype.

The prototype object itself may be constructed using one of two principal techniques; the simplest is to subclass QScriptable, which enables you to define the scripting API of the type through QObject properties and slots. Another possibility is to create a script object by calling newObject(), and populate the object with the desired properties (e.g. native functions wrapped with newFunction()).

See also

defaultPrototype(), qScriptRegisterMetaType(), QScriptable

Sets this engine's Global Object to be the given object. If object is not a valid script object, this function does nothing.

When setting a custom global object, you may want to use QScriptValueIterator to copy the properties of the standard Global Object; alternatively, you can set the internal prototype of your custom object to be the original Global Object.

See also

globalObject()

Sets the interval between calls to QCoreApplication::processEvents to interval milliseconds.

While the interpreter is running, all event processing is by default blocked. This means for instance that the gui will not be updated and timers will not be fired. To allow event processing during interpreter execution one can specify the processing interval to be a positive value, indicating the number of milliseconds between each time QCoreApplication::processEvents() is called.

The default value is -1, which disables event processing during interpreter execution.

You can use QCoreApplication::postEvent() to post an event that performs custom processing at the next interval. For example, you could keep track of the total running time of the script and call abortEvaluation() when you detect that the script has been running for a long time without completing.

See also

processEventsInterval()

This signal is emitted when a script function connected to a signal causes an exception.

See also

qScriptConnect()

Converts the given value to an object, if such a conversion is possible, otherwise returns an invalid QScriptValue. The conversion is performed according to the following table.

See also

newObject()

Creates a QScriptValue with the given value. The T must be registered with QVariant.

Refer to Conversion from %CsScript to C++ for a description of the built-in type conversion provided by CsScript. By default, the types that are not specially handled by CsScript are represented as QVariants. You can change this behavior by installing your own type conversion functions with qScriptRegisterMetaType().

See also

fromScriptValue(), qScriptRegisterMetaType()

Returns a handle that represents the given string, str. QScriptString can be used to quickly look up properties, and compare property names, of script objects.

See also

QScriptValue::property()

Returns the current uncaught exception, or an invalid QScriptValue if there is no uncaught exception. The exception value is typically an Error object; in that case, you can call toString() on the return value to obtain an error message.

See also

hasUncaughtException(), uncaughtExceptionLineNumber()

Returns a human-readable backtrace of the last uncaught exception.

It is in the form <function-name>()&lt;file-name>:<line-number>.

See also

uncaughtException()

Returns the line number where the last uncaught exception occurred. Line numbers are 1-based, unless a different base was specified as the second argument to evaluate().

See also

hasUncaughtException()

Returns a QScriptValue of the primitive type Undefined.

See also

nullValue()

Creates a connection from the signal in the sender to the given function. If receiver is an object it will act as the "this" object when the signal function is invoked. Returns true if the connection succeeds, otherwise returns false.

Registers the type T in the given engine. The value for toScriptValue must be a function which will convert from a value of type T to a QScriptValue. The value for fromScriptValue is a function that does the opposite. The the prototype is valid it is set on QScriptValues returned by toScriptValue.

Returns the internal ID used by QMetaType.