cxx-qt is a library that automatically generates code to transfer data between Rust and C++ through common interfaces such as QObjects that can be exposed directly into QML. It relies on the cxx crate internally to achieve this and thus it is recommended that any interactions with Qt that are not covered by the built-in code generators should be done directly in C++ and connected to relevant Rust logic by writing additional cxx code. The cxx-qt build system is based on CMake, but is compatible with cxx on its own as well.
The examples folder contains an example application using the cxx-qt crate and will be used for development and testing
purposes. The cxx-qt folder contains the source for the actual crate which contains a proc-macro. The cxx-qt-gen folder
contains the source for a crate which extracts and generates C++ and Rust source code. The cxx-qt-build folder contains
the source for a crate which provides helper functions to be used in a build.rs file.
Initially the projects in the examples folder will also serve as a template for new projects should use cxx-qt. In future we might improve upon this with a custom CMake module for instance.
Ensure that you have the following installed
- C++ compiler
- clang-format
- CMake v3.16+
- Qt 5
- Rust
In a cxx-qt project, the build system is based on CMake, which uses Cargo under the hood. Therefore, unlike a typical Rust project, CMake must be used to build cxx-qt.
mkdir build/
cd build/
cmake ../
cmake --build . -j$(nproc)./build/examples/basic_cxx_qt_qml/example_basic_cxx_qt_qmlTesting assumes that cargo clippy and cargo fmt are available, you may need to install these with rustup component add clippy rustfmt.
It also assumes that you have reuse installed (eg via pip3 install reuse) and valgrind.
cd build/
ctest -j$(nproc)cxx-qt is Copyright (C) 2021, Klarälvdalens Datakonsult AB, and is available under the terms of the MIT or the Apache-2.0 licenses.
Contact KDAB at info@kdab.com to inquire about additional features or services related to this project.
cxx-qt includes these source files, also available under the terms of the MIT license:
- doctest.h - the lightest feature-rich C++ single-header testing framework for unit tests and TDD (C) 2016-2021 Viktor Kirilov vik.kirilov@gmail.com
cxx-qt is supported and maintained by Klarälvdalens Datakonsult AB (KDAB).
The KDAB Group is the global No.1 software consultancy for Qt, C++ and OpenGL applications across desktop, embedded and mobile platforms.
The KDAB Group provides consulting and mentoring for developing Qt applications from scratch and in porting from all popular and legacy frameworks to Qt. We continue to help develop parts of Qt and are one of the major contributors to the Qt Project. We can give advanced or standard trainings anywhere around the globe on Qt as well as C++, OpenGL, 3D and more.
Please visit https://www.kdab.com to meet the people who write code like this.