Protobuf generator and bindings for Qt framework

Alexey Edelev a9de300f03 Change the installation directory of QML plugins 2 weeks ago
.ci bcfb457794 Fix build configurations 2 weeks ago
.github dead934e37 Add a release workflow for Windows 2 weeks ago
3rdparty 3d6b2acaa5 Update build procedure 1 month ago
cmake dead934e37 Add a release workflow for Windows 2 weeks ago
doxygen 61e19c2c56 Add client tutorial sample 10 months ago
examples 3d6b2acaa5 Update build procedure 1 month ago
src a9de300f03 Change the installation directory of QML plugins 2 weeks ago
tests bcfb457794 Fix build configurations 2 weeks ago
.gitignore 7495ae7751 Initial version of generator 2 years ago
.gitmodules ade25f9064 Split generator and QtProtobuf library 6 months ago
.travis.yml 1ceacf28b0 Force usage of internal targets for in-tree build 4 months ago
CHANGES.txt 4f63b15340 Version 0.5.0 7 months ago
CMakeLists.txt 6d5b1c4a11 Fix installation rules 3 weeks ago
LICENSE 3beab4ea24 Implement move semantic for generated classes, update copyrights. 2 years ago
ProjectConfig.cmake.in 3d6b2acaa5 Update build procedure 1 month ago
README.md 432a65de00 Remove deprecated travis badges 1 month ago
conanfile.py 4f63b15340 Version 0.5.0 7 months ago

README.md

QtProtobuf

gRPC and Protobuf generator and bindings for Qt framework

see Protobuf and gRPC for more information

QtProtobuf provides Qt-native support of Google protocol buffers. Generated code doesn't depend on any framework except Qt framework. QtProtobuf uses existing Qt meta-object information to access object fields and supports most of features of original C++ protocol buffers. It's not just a wrapper arround protocol buffers, but pure Qt generator with own serializers. Our target to provide deep Qt, protocol buffers and gRPC intergration.

Test results

Branch Results Support
master :heavy_check_mark:
0.5 :heavy_check_mark:
0.4 :heavy_check_mark:
0.3 :heavy_check_mark:
0.2
0.1.0

Table of contents

API Reference

Linux Build

Windows Build

Usage

Integration with CMake project

Integration with qmake project

Generated and QtProtobuf types registation

Code exceptions

QtProtobuf development

Tutorials

QtProtobuf Client Tutorial

Build

Build options

QT_PROTOBUF_MAKE_COVERAGE - if TRUE/ON, enables gcov intergration, to collect code coverage reports(usefull for developers). FALSE by default.

QT_PROTOBUF_MAKE_TESTS - if TRUE/ON, enables tests for QtProtobuf. TRUE by default.

QT_PROTOBUF_MAKE_EXAMPLES - if TRUE/ON, enables built-in examples. TRUE by default.

QT_PROTOBUF_NATIVE_GRPC_CHANNEL - if TRUE/ON, enables build of an additional channel wrapping native gGRPC C++ library (Note: grpc++ library is required).

BUILD_SHARED_LIBS - if TRUE/ON, enables shared libraries build, FALSE by default, static libraries build is performed.

Note: In case if you use static QtProtobuf in your non-cmake/-qmake build system, you additionaly need manually add QT_PROTOBUF_STATIC compiler definition.

QT_PROTOBUF_FIELD_ENUM - if TRUE/ON, adds enumeration with message fields for generated messages in QtProtobufTypes and QtProtobufWellKnownTypes libraries. FALSE by default.

Linux Build

Prerequesties

Check installation of following packages in your system:

  • cmake 3.6 or higher
  • Qt 5.12.4 or higher
  • protobuf 3.6.0 or higher (might be used from submodule)
  • golang 1.10 or higher

Optional:

  • grpc 1.15.0 or higher (might be used from submodule)

Note: Older versions could be supported as well but not tested.

Option 1: Use system libraries

For Ubuntu 19.10 or higher

Install dependencies:

sudo apt-get
    build-essential \
    cmake \
    golang \
    wget \
    libdbus-1-3 \
    libfreetype6 libfontconfig libx11-6 \
    libgl1-mesa-dev \
    libsm6 \
    libice6 \
    libxext6 \
    libxrender1 \
    doxygen \
    qt5-default \
    qtdeclarative5-private-dev \
    qtbase5-private-dev \
    protobuf-compiler \
    libprotoc-dev \
    protobuf-compiler-grpc \
    libgrpc++-dev \
    libgrpc-dev \
    libgtest-dev
For OpenSUSE 15.2 or higher

Install dependencies:

sudo zypper in go \
    wget \
    cmake \
    libXrender1 \
    libXext6 \
    libSM6 \
    Mesa-libGL1 \
    libfreetype6 \
    libX11-6 \
    libdbus-1-3 \
    fontconfig \
    libICE6 \
    gcc-c++ \
    Mesa-devel \
    libgthread-2_0-0 \
    libqt5-qttools \
    protobuf-devel \
    grpc-devel \
    libqt5-qtdeclarative-devel \
    libqt5-qtbase-devel \
    libqt5-qtdeclarative-private-headers-devel \
    libqt5-qtbase-private-headers-devel \
    rpm-build
sudo zypper --non-interactive in --type pattern devel_C_C++

Option 2: All-in-one build

If required versions of libraries are not found in your system, you may use all-in-one build procedure for prerequesties.

Manually install Qt version you need [](https://www.qt.io/download).

Update submodules to fetch 3rdparty dependencies:

git submodule update --init --recursive

Note: All installation rules are disabled for all-in-one build.

Option 3: Use as sub-module

QtProtobuf build procedure is designed to use QtProtobuf as sub-project.

Note: This option only supported by projects that use CMake as build tool.

Add QtProtobuf as git submodule in your Project folder:

git submodule add https://github.com/semlanik/qtprotobuf.git qtprotobuf
git submodule init qtprotobuf
git submodule update qtprotobuf

#(Optional) You also may initialize all internal QtProtobuf sub-modules for all-in-one build using steps bellow:
cd qtprotobuf
git submodule update --init --recursive

Next add QtProtobuf subproject to your CMake tree, edit CMakeLists.txt:

...
add_subdirectory("qtprotobuf")
...

QtProtobuf and dependencies from source tree will be built within your Project.

Note: All installation rules of QtProtobuf project are disabled for sub-project build.

Build

git submodule init src/protobuf/3rdparty/microjson #microjson is part of build and installation tree. Made this to simplify dependency management, but you always may use system microjson if installed.
git submodule update src/protobuf/3rdparty/microjson
mkdir build
cd build
cmake .. [-DCMAKE_PREFIX_PATH="<path/to/qt/installation>/Qt<qt_version>/<qt_version>/gcc_64/lib/cmake"]
cmake --build . [--config <RELEASE|DEBUG>] -- -j<N>

Packaging

QtProtobuf has packaging support based on CPack.

.deb

You can create .deb package for debian-like operating systems, using commands below:

mkdir build
cd build
cmake .. -DQT_PROTOBUF_MAKE_TESTS=FALSE -DQT_PROTOBUF_MAKE_EXAMPLES=FALSE
cpack -G DEB ..

Note: Only tested on Ubuntu 19.10

.rpm

You can create .rpm package for rpm-based operating systems, using commands below:

mkdir build
cd build
cmake .. -DQT_PROTOBUF_MAKE_TESTS=FALSE -DQT_PROTOBUF_MAKE_EXAMPLES=FALSE
cpack -G RPM ..

Note: Only tested on OpenSUSE 15.2

Windows Build

Prerequesties

Download and install:

  • Qt 5.12.3 or higher 1
  • cmake-3.6 or higher 2
  • Strawberry perl 5.28 3
  • GoLang 1.10 or higher 4
  • Yasm 1.3 or higher 5
  • Actual Visual Studio Compiler with cmake support that required by Qt 6

Note: All applications should be in PATH

Update submodules to fetch 3rdparty dependencies:

git submodule update --init --recursive

Build

Open Qt MSVC command line and follow steps:

"C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\VC\Auxiliary\Build\vcvarsall.bat" <x86|x64>
cd <directory with qtprotobuf project>
mkdir build
cd build
cmake ..
cmake --build . [--config <RELEASE|DEBUG>] -- /m:<N>

Conan build

QtProtobuf supports conan builds since version 0.4.0.

Build QtProtobuf

Before build make sure that all sub-modules are deinitilized:

git submodule deinit -f --all

Build QtProtobuf:

mkdir -p build_conan
cd build_conan
conan source ..
conan install .. --build=microjson
conan build ..

Conan project integration

QtProtobuf conan source packages are hosted on JFrog Bintray. Add remote to conan:

conan remote add semlanik https://api.bintray.com/conan/semlanik/libs

To intergrate QtProtobuf add it as a dependency to your conanfile.py:

    ...
    requires = [
        ...
        "qtprotobuf/0.5.0@semlanik/stable",
        ...
    ]
    ...

Note: You also may use QtProtobuf package is built localy or from other remote source. Look in conan documentation for details.

Usage

Direct usage of generator

[QT_PROTOBUF_OPTIONS="[SINGLE|MULTI]:QML:COMMENTS:FOLDER:FIELDENUM"] protoc --plugin=protoc-gen-qtprotobuf=<path/to/bin/>qtprotobufgen --qtprotobuf_out=<output_dir> [-I/extra/proto/include/path] <protofile>.proto

QT_PROTOBUF_OPTIONS

For protoc command you also may specify extra options using QT_PROTOBUF_OPTIONS environment variable and colon-separated format:

[QT_PROTOBUF_OPTIONS="[SINGLE|MULTI]:QML:COMMENTS:FOLDER:FIELDENUM"] protoc --plugin=protoc-gen-qtprotobuf=<path/to/bin/>qtprotobufgen --qtprotobuf_out=<output_dir> [-I/extra/proto/include/path] <protofile>.proto

Following options are supported:

SINGLE - enables single-file generation when for each .proto file single pair of .h .cpp files is generated

Note: Enabled by default. Excluded by SINGLE

MULTI - enables multi-file generation when for each message separate pair of .h .cpp

Note: Has higher priority than SINGLE

QML - enables QML code generation in protobuf classes. If is set QML-related code for lists and QML registration to be generated.

COMMENTS - enables comments copying from .proto files

FOLDER - enables folder-based generation

FIELDENUM - adds enumeration with message fields for generated messages.

Integration with CMake project

You can integrate QtProtobuf as submodule in your project or as installed in system package. Add following line in your project CMakeLists.txt:

...
find_package(QtProtobuf CONFIG REQUIRED COMPONENTS Protobuf Grpc)
file(GLOB PROTO_FILES ABSOLUTE ${CMAKE_CURRENT_SOURCE_DIR}/path/to/protofile1.proto
 ${CMAKE_CURRENT_SOURCE_DIR}/path/to/protofile2.proto
 ...
 ${CMAKE_CURRENT_SOURCE_DIR}/path/to/protofileN.proto)
# Function below generates source files for specified PROTO_FILES,
# and link them to the MyTarget as static library
add_executable(MyTarget main.cpp) # Add your target here
qtprotobuf_generate(TARGET MyTarget
OUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/generated
PROTO_FILES ${PROTO_FILES})

Another option is to pre-specify expected generated headers to prevent dummy-parser mistakes

...
set(GENERATED_HEADERS
# List of artifacts expected after qtprotobufgen job done.
# Usually it's full list of messages in all packages with .h header suffix
...
)
...
qtprotobuf_generate(TARGET MyTarget
OUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/generated
PROTO_FILES ${PROTO_FILES}
GENERATED_HEADERS ${GENERATED_HEADERS})
...

In case if you somehow avoided qtprotobuf_generate usage, you need manualy link QtProtobuf libraries used by project, e.g.:

...
target_link_libraries(${TARGET} QtProtobuf::Protobuf QtProtobuf::Grpc QtProtobuf::ProtobufWellKnownTypes)
...

CMake functions reference

qtprotobuf_generate

qtprotobuf_generate is cmake helper function that automatically generates STATIC library target from your .proto files

Parameters:

TARGET - name of you target that generated code archive will be linked to

GENERATED_TARGET - name that will be used for generated archive library target. It's usefull when you supposed to have multiple generated targets to be linked to single one.

OUT_DIR - output directory that will contain generated artifacts. Usually subfolder in build directory should be used

GENERATED_HEADERS - List of header files expected after generator job finished

EXCLUDE_HEADERS - List of header files to be excluded from pre-parsed list of expected header files (e.g. nested messages that are not supported by QtProtobuf generator)

PROTO_FILES - List of .proto files that will be used in generation procedure

Options:

MULTI - Enables multi-files generation mode. If provided in parameter list generator will create pair of header/source files for each message.

Note: multi-files generation mode is defined as deprecated by QtProtobuf team, and might have poor support in future

QML - Enables QML code generation in protobuf classes. If provided in parameter list QML related code for lists and QML registration to be generated.

COMMENTS - Enables comments copying from .proto files. If provided in parameter list message and field related comments will be copied to generated header files.

FOLDER - Enables folder based generation. If provided in parameter list generator will place generated artifacts to folder structure according to package of corresponding .proto file.

Note: enabled by default if MULTI option provided

FIELDENUM - Adds enumeration with message fields for generated messages.

qtprotobuf_link_target

qtprotobuf_link_target is cmake helper function that links generated protobuf target to your binary. It's useful when you try to link generated target to shared library or/and to executable that doesn't utilize all protobuf generated classes directly from C++ code, but requires them from QML.

Parameters:

TARGET - name of target to link to

GENERATED_TARGET - protobuf generated target name

Useful definitions

QT_PROTOBUF_EXECUTABLE - contains full path to QtProtobuf generator

Integration with qmake project

Note: Available in QtProtobuf version >=0.2.0

QtProtobuf has limited qmake build procedures support. It's only available and tested on linux platforms. To use it in your qmake project, first you need build and install QtProtobuf as standalone project in your system paths:

mkdir build
cd build
cmake .. [-DCMAKE_PREFIX_PATH="<path/to/qt/installation>/Qt<qt_version>/<qt_version>/gcc_64/lib/cmake"] -DCMAKE_INSTALL_PREFIX=/usr -DQT_PROTOBUF_MAKE_TESTS=OFF -DQT_PROTOBUF_MAKE_EXAMPLES=OFF
cmake --build . [--config <RELEASE|DEBUG>] -- -j<N>
sudo cmake --build . [--config <RELEASE|DEBUG>] --target install

Commands above will install qt protobuf into you system paths prefixed with /usr folder.

Once build and installation is finished, you may use QtProtobuf and QtGrpc in qmake project by adding following lines in .pro file:

QT += protobuf #for protobuf libraries support
QT += grpc #for grpc libraries support

To generate source code and link it to you project use predefined qtprotobuf_generate function

qmake functions reference

qtprotobuf_generate([generate_qml=false])

qtprotobuf_generate is qmake helper test function that generates QtProtobuf source code based on files provided by PROTO_FILES global context variable

Parameters:

generate_qml - Enables/disables QML code generation in protobuf classes. If set to true QML-related code for lists and QML registration to be generated.

Note: see examples/qmakeexample for details

Generated and QtProtobuf types registation

To enable QtProtobuf project you need to register protobuf types. It's good practice to make it in 'main' function.

...
#include <QtProtobufTypes>
...
int main(int argc, char *argv[])
{
QtProtobuf::qRegisterProtobufTypes();
... //Qt application initialization and run
}

Code exceptions

If any prohibited Qt/QML keyword is used as field name, generator appends '_proto' suffix to generated filed name. It's required to omit overloading for example QML reserved names like 'id' or 'objectName'.

E.g. for message:

message MessageReserved {
    sint32 import = 1;
    sint32 property = 2;
    sint32 id = 3;
}

Following properties will be generated:

...
    Q_PROPERTY(QtProtobuf::sint32 import_proto READ import_proto WRITE setImport_proto NOTIFY import_protoChanged SCRIPTABLE true)
    Q_PROPERTY(QtProtobuf::sint32 property_proto READ property_proto WRITE setProperty_proto NOTIFY property_protoChanged SCRIPTABLE true)
    Q_PROPERTY(QtProtobuf::sint32 id_proto READ id_proto WRITE setId_proto NOTIFY id_protoChanged SCRIPTABLE true)
...

Note: List of exceptions might be extended in future releases.

QtProtobuf development

Running tests

cd <build directory>
ctest

Documentation generation

Project uses doxygen for documentation generation.

Ubuntu

Install doxygen and graphviz packages:

sudo apt-get install -y doxygen graphviz

Windows

Install doxygen and graphviz packages:

Generation

You can generate documentation for actual version using following commands:

mkdir build
cd build
cmake ..
cmake --build . --target doc