QScriptContextInfo Class | Qt Script

Qt 5.9 | Qt Script | C++ Classes | QScriptContextInfo

Qt 5.9.2 Reference Documentation

# QScriptContextInfo Class

The QScriptContextInfo class provides additional information about a QScriptContext. More...

Header: | #include <QScriptContextInfo>
qmake: | QT += script
Since: | Qt 4.4

- List of all members, including inherited members
- Obsolete members

## Public Types

enum | FunctionType { ScriptFunction, QtFunction, QtPropertyFunction, NativeFunction }

## Public Functions

| QScriptContextInfo(const QScriptContext *context)
| QScriptContextInfo(const QScriptContextInfo &other)
| QScriptContextInfo()
| ~QScriptContextInfo()
QString | fileName() const
int | functionEndLineNumber() const
int | functionMetaIndex() const
QString | functionName() const
QStringList | functionParameterNames() const
int | functionStartLineNumber() const
FunctionType | functionType() const
bool | isNull() const
int | lineNumber() const
qint64 | scriptId() const
bool | operator!=(const QScriptContextInfo &other) const
QScriptContextInfo & | operator=(const QScriptContextInfo &other)
bool | operator==(const QScriptContextInfo &other) const

## Related Non-Members

QDataStream & | operator<<(QDataStream &stream, const QScriptContextInfo &info)
QDataStream & | operator>>(QDataStream &stream, QScriptContextInfo &info)

## Detailed Description

The QScriptContextInfo class provides additional information about a QScriptContext.

QScriptContextInfo is typically used for debugging purposes. It can provide information about the code being executed, such as the type of the called function, and the original source code location of the current statement.

If the called function is executing Qt Script code, you can obtain the script location with the functions fileName() and lineNumber().

You can obtain the starting line number and ending line number of a Qt Script function definition with functionStartLineNumber() and functionEndLineNumber(), respectively.

For Qt Script functions and Qt methods (e.g. slots), you can call functionParameterNames() to get the names of the formal parameters of the function.

For Qt methods and Qt property accessors, you can obtain the index of the underlying QMetaMethod or QMetaProperty by calling functionMetaIndex().

See also QScriptContext and QScriptEngineAgent.

## Member Type Documentation

### enum QScriptContextInfo::FunctionType

This enum specifies the type of function being called.

Constant | Value | Description
--- | --- | ---
`QScriptContextInfo::ScriptFunction` | `0` | The function is a Qt Script function, i.e. it was defined through a call to QScriptEngine::evaluate().
`QScriptContextInfo::QtFunction` | `1` | The function is a Qt function (a signal, slot or method).
`QScriptContextInfo::QtPropertyFunction` | `2` | The function is a Qt property getter or setter.
`QScriptContextInfo::NativeFunction` | `3` | The function is a built-in Qt Script function, or it was defined through a call to QScriptEngine::newFunction().

## Member Function Documentation

### QScriptContextInfo::QScriptContextInfo(const QScriptContext *context)

Constructs a new QScriptContextInfo from the given context.

The relevant information is extracted from the context at construction time; i.e. if you continue script execution in the context, the new state of the context will not be reflected in a previously created QScriptContextInfo.

### QScriptContextInfo::QScriptContextInfo(const QScriptContextInfo &other)

Constructs a new QScriptContextInfo from the other info.

### QScriptContextInfo::QScriptContextInfo()

Constructs a null QScriptContextInfo.

See also isNull().

### QScriptContextInfo::~QScriptContextInfo()

Destroys the QScriptContextInfo.

### QString QScriptContextInfo::fileName() const

Returns the name of the file where the code being executed was defined, if available; otherwise returns an empty string.

For Qt Script code, this function returns the fileName argument that was passed to QScriptEngine::evaluate().

See also lineNumber() and functionName().

### int QScriptContextInfo::functionEndLineNumber() const

Returns the line number where the definition of the called function ends, or -1 if the line number is not available.

The ending line number is only available if the functionType() is ScriptFunction.

See also functionStartLineNumber().

### int QScriptContextInfo::functionMetaIndex() const

Returns the meta index of the called function, or -1 if the meta index is not available.

The meta index is only available if the functionType() is QtFunction or QtPropertyFunction. For QtFunction, the meta index can be passed to QMetaObject::method() to obtain the corresponding method definition; for QtPropertyFunction, the meta index can be passed to QMetaObject::property() to obtain the corresponding property definition.

See also QScriptContext::thisObject().

### QString QScriptContextInfo::functionName() const

Returns the name of the called function, or an empty string if the name is not available.

For script functions of type QtPropertyFunction, this function always returns the name of the property; you can use QScriptContext::argumentCount() to differentiate between reads and writes.

See also fileName() and functionType().

### QStringList QScriptContextInfo::functionParameterNames() const

Returns the names of the formal parameters of the called function, or an empty QStringList if the parameter names are not available.

See also QScriptContext::argument().

### int QScriptContextInfo::functionStartLineNumber() const

Returns the line number where the definition of the called function starts, or -1 if the line number is not available.

The starting line number is only available if the functionType() is ScriptFunction.

See also functionEndLineNumber() and fileName().

### FunctionType QScriptContextInfo::functionType() const

Returns the type of the called function.

See also functionName() and QScriptContext::callee().

### bool QScriptContextInfo::isNull() const

Returns true if this QScriptContextInfo is null, i.e. does not contain any information.

### int QScriptContextInfo::lineNumber() const

Returns the line number corresponding to the statement being executed, or -1 if the line number is not available.

The line number is only available if Qt Script code is being executed.

See also columnNumber() and fileName().

### qint64 QScriptContextInfo::scriptId() const

Returns the ID of the script where the code being executed was defined, or -1 if the ID is not available (i.e. a native function is being executed).

See also QScriptEngineAgent::scriptLoad().

### bool QScriptContextInfo::operator!=(const QScriptContextInfo &other) const

Returns true if this QScriptContextInfo is not equal to the other info, otherwise returns false.

### QScriptContextInfo &QScriptContextInfo::operator=(const QScriptContextInfo &other)

Assigns the other info to this QScriptContextInfo, and returns a reference to this QScriptContextInfo.

### bool QScriptContextInfo::operator==(const QScriptContextInfo &other) const

Returns true if this QScriptContextInfo is equal to the other info, otherwise returns false.

## Related Non-Members

### QDataStream &operator<<(QDataStream &stream, const QScriptContextInfo &info)

Writes the given info to the specified stream.

This function was introduced in Qt 4.4.

### QDataStream &operator>>(QDataStream &stream, QScriptContextInfo &info)

Reads a QScriptContextInfo from the specified stream into the given info.

This function was introduced in Qt 4.4.