Zserio Compiler Build Instructions

This section describes zserio build instructions for developers. If you are users, it should be normally enough just to download the latest build of the zserio compiler and runtime libraries from Zserio Releases.

Zserio Projects

Before we start to describe build instructions for zserio compiler, it’s good to known which independent projects can be found in zserio repository.

Zserio consists of the following independent projects:

• Zserio core - This Java project contains pure zserio compiler which parses zserio language. It doesn’t contain any generators.

• C++ extension - This Java project contains C++ generator.

• C++ runtime library - This C++ project contains runtime library for C++ extension which must be linked to generated C++ sources.

• Java extension - This Java project contains Java generator.

• Java runtime library - This Java project contains runtime library for Java extension which must be used together with generated Java sources.

• Python extension - This Java project contains Python generator.

• Python runtime library - This Python project contains runtime library for Python extension which must be used together with generated Python sources.

• XML extension - This Java project contains XML generator.

• Doc extension - This Java project contains HTML generator.

• Ant task - This Java project contains Ant task zserio for zserio compiler.

• Zserio bundle - This Java project creates one standalone jar with Zserio core and all available extensions together with their dependent jars.

Prerequisites

Before you start building, make sure you have the following components installed:

• JAVA JDK
• Ant
• CMake
• Doxygen
• Python

Building by Bash Script

The easiest way how to build zserio compiler is by using prepared Bash script build.sh located in project’s folder scripts.

This script builds Zserio projects and installs them in folder distr (located in project’s root by default).

Usage

The script build.sh has the following usage:

build.sh [-h,--help] package...

The argument package can be the arbitrary combination of the following packages:

Package	Description
ant_task	Zserio Ant task.
core	Zserio Core.
cpp	Zserio C++ extension.
cpp_rt-linux32	Zserio C++ extension runtime library for native linux32 (gcc).
cpp_rt-linux64	Zserio C++ extension runtime library for native linux64 (gcc).
cpp_rt-windows64-mingw	Zserio C++ extension runtime library for windows64 target (MinGW64).
cpp_rt-windows64-msvc	Zserio C++ extension runtime library for windows64 target (MSVC).
java	Zserio Java extension.
java_rt	Zserio Java extension runtime library.
python	Zserio Python extension.
python_rt	Zserio Python extension runtime library.
xml	Zserio XML extension.
doc	Zserio Documentation extension.
zserio	Zserio bundle (Zserio Core packed together with all already built extensions).
all-linux32	All available packages for linux32.
all-linux64	All available packages for linux64.
all-windows64-mingw	All available packages for windows64 (MinGW).
all-windows64-msvc	All available packages for windows64 (MSVC).

Examples

The following command creates Zserio bundle jar with Java extension together with Java runtime library jar in distr directory:

./build.sh core java java_rt zserio

The following command creates Zserio bundle jar with C++ extension together with C++ runtime library for linux64 platform in distr directory:

./build.sh core cpp cpp_rt-linux64 zserio

The following command creates Zserio bundle jar with Python extension together with Python runtime library in distr directory:

./build.sh core python python_rt zserio

The following command creates Zserio bundle jar with all available extensions together with all runtime libraries for linux64 platform in distr directory:

./build.sh all-linux64

Building by Hand

If you don’t like Bash script, you can build Zserio by hand.

Java projects use Ant and can be built by the command:

ant install

There is one exception for Zserio bundle jar which is built by the command:

ant zserio_bundle.install

C++ projects use CMake and can be build by commands:

mkdir build
cd build
cmake ..
cmake --build .

Please don’t forget about dependencies. Zserio core must be build before all extensions and Zserio bundle must be built as the last one.

Examples

The following command creates Zserio bundle jar with Java extension together with Java runtime library jar in distr directory:

ant install
ant -f compiler/extensions/java install
ant -f compiler/extensions/java/runtime install
ant zserio_bundle.install