QML script compiler | Qt Qml | Qt 6.11.2
Description: A tool to compile functions and expressions in QML.

- Qt 6.11
- Qt Qml
- Qt Qml Tooling
- Qt Quick Compiler
- QML script compiler
- Qt 6.11.2 Reference Documentation

Qt Quick Compiler ◦ QML type compiler

# QML script compiler

The QML script compiler compiles functions and expressions in QML and JavaScript files to a byte code that can be interpreted or Just-in-time compiled by the QML engine.

In addition, it compiles some functions and expressions in QML files into C++ code, within limitations set by the nature of JavaScript. It generates C++ code for functions that can be exhaustively analyzed. The following flow chart explains the compilation workflow.

QML script compiler is available in two versions. One is qmlcachegen, which is a part of the Qt Quick Compiler. Another one is qmlsc, which is a part of the commercial-only add-on Qt Quick Compiler Extensions.

## qmlcachegen

qmlcachegen uses the meta-object system and generates lookups and stores them in a central place, a compilation unit. The compilation unit contains a representation of document structure, compact byte code representation for each function and expression, and native code for functions and bindings that compiler fully understands. The byte code in a compilation unit can be used by the QML engine to avoid re-compilation and to speed up execution.

## qmlsc

qmlsc, on the flip side, extends the base functionality of qmlcachegen by providing two extra modes.

- static mode
- direct mode

### static mode

In static mode, qmlsc assumes that no properties of any types exposed to C++ can be shadowed by derived types. It eliminates the shadow checking mechanism and allows more JavaScript code to be compiled to C++ and eventually generates faster code.

To enable static mode in qmlsc, you should pass `--static` via `QT_QMLCACHEGEN_ARGUMENTS` to qt_add_qml_module.

     qt_add_qml_module(someTarget
     ...
     )

     set_target_properties(someTarget PROPERTIES
         QT_QMLCACHEGEN_ARGUMENTS "--static"
     )

Warning: qmlsc static-mode generates invalid code if any properties are shadowed in the QML document.

### direct mode

In direct mode, qmlsc assumes that all C++ types used in your QML code are available and can be included as C++ headers to the generated code. Then the generated code accesses or modifies properties by directly calling getters, setters and invokable functions in those headers which makes the execution even faster. This means you have to link to private Qt APIs in CMake.

Warning: Private Qt APIs change often. You will need to recompile Qt for each new version.

Warning: If a type is only defined in a plugin or has no header, you can’t use it in direct mode.

To enable direct mode, you should consider the followings:

- you should pass `--direct-calls` via `QT_QMLCACHEGEN_ARGUMENTS` to qt_add_qml_module.

       qt_add_qml_module(someTarget
       ...
       )

       set_target_properties(someTarget PROPERTIES
           QT_QMLCACHEGEN_ARGUMENTS "--direct-calls"
       )

- Link all the relevant private Qt modules instead of their public counterparts.

       find_package(Qt6 COMPONENTS QmlPrivate QuickPrivate)

       qt_add_qml_module(someTarget
       ...
       )

       target_link_libraries(someTarget PRIVATE
           Qt::QmlPrivate
           Qt::QuickPrivate
           ...
       )

- Do not set the `PLUGIN_TARGET` to be the same as the backing library target.

       # direct mode will not function in this setup.
       qt_add_qml_module(someTarget
       PLUGIN_TARGET someTarget
       ...
       )

## Limitations when compiling JavaScript to C++

Many JavaScript constructs cannot be efficiently represented in C++. The QML script compiler skips the C++ code generation for functions that contain such constructs and only generates byte code to be interpreted or run through the Just-in-time compiler. Most common QML expressions are rather simple: value lookups on QObjects, arithmetics, simple if/else or loop constructs. Those can easily be expressed in C++, and doing so makes your application run faster.

## Obtaining statistics about the compilation of functions and bindings

The QML Script Compiler records statistics when compiling QML to C++. These can give insight into the compilation of functions and bindings and whether it was successful or which error has caused it to fail. In addition to showing these results per binding or function, the statistics are also summarized per file, per module, and at the project level. This can give a quick overview of how well a project is being compiled.

To show statistics, invoke the all_aotstats CMake target.

The collection of compilation statistics is enabled by default. In order to disable it, set the QT_QML_GENERATE_AOTSTATS CMake variable to OFF before the first call to qt_add_qml_module.

Note: These statistics are only available for modules registered through the qt_add_qml_module CMake API

Qt Quick Compiler ◦ QML type compiler