syncspirit/docs/building.md

building

requirements

• C++ 20 compatible compiler (tested with gcc-10 and clang-17)

• boost (at least v1.84.0)

• openssl

• protobuf, (at least v3.0)

• zlib

• rotor, (at least v0.32)

• lz4

• libmbdx, (at least v0.13.3)

• spdlog

• json

• pugixml

• tomlplusplus

• c-ares

• fltk (for fltk-ui)

The conan package manager (v2.0+) is used with cmake build system.

syncspririt can be build with conan or just with bare cmake build system. conan is responsible for installing and building dependencies, with bare cmake it should be done manually (e.g. use system-provided libraries).

Please note, that fltk library should be build as shared library; otherwise applications will not work correctly.

generic build

Make sure that the default conan profile has proper options:

cat ~/.conan2/profiles/default 
[settings]
arch=x86_64
build_type=Release
compiler=gcc
compiler.cppstd=20
compiler.libcxx=libstdc++11
compiler.version=11
os=Linux

[options]
*/*:shared=True
fltk/*:with_xft=True
fltk/*:with_gl=False
boost/*:magic_autolink=False
boost/*:visibility=hidden
boost/*:header_only=False
boost/*:without_serialization=True
boost/*:without_graph=True
boost/*:without_fiber=True
boost/*:without_log=True
boost/*:without_math=True
boost/*:without_process=True
boost/*:without_stacktrace=True
boost/*:without_test=True
boost/*:without_wave=True
pugixml/*:no_exceptions=True
rotor/*:enable_asio=True
rotor/*:enable_thread=True
rotor/*:enable_fltk=True

If static build is planned, than */*:shared=True should be False.

If the defult conan profile is missing, than create it via:

conan profile detect

and modify accordingly.

mkdir build.release && cd build.release
conan install --build=missing --output-folder . -o '&:shared=True' -s build_type=Release ..
cmake .. -G "Unix Makefiles" \
  -DCMAKE_TOOLCHAIN_FILE=$PWD/conan_toolchain.cmake \
  -DCMAKE_BUILD_TYPE=Release
make -j`nproc`

(for shared build it should contain '&:shared=True' here too)

To have locally installed binaries with all dependencies cmake command should be:

cmake .. -G "Unix Makefiles" \
  -DCMAKE_TOOLCHAIN_FILE=$PWD/conan_toolchain.cmake \
  -DCMAKE_POLICY_DEFAULT_CMP0091=NEW \
  -DCMAKE_BUILD_TYPE=Release

make -j`nproc`

For win32 to gater dlls it should be

make -j`nproc` deploy_deps

cross building on linux for windows

Generally it the process is the same as above, with the addition, that cross-compiler should be installed and conan profiles should be activated

mingw

Install mingw on linux (something like cross-x86_64-w64-mingw32)

Make a conan profile for mingw:

cat ~/.conan2/profiles/mingw
[settings]
os=Windows
arch=x86_64
compiler=gcc
build_type=Release
compiler.cppstd=gnu17
compiler.libcxx=libstdc++11
compiler.version=12
[buildenv]
CC=x86_64-w64-mingw32-gcc
CXX=x86_64-w64-mingw32-g++
LD=ix86_64-w64-mingw32-ld
RC=x86_64-w64-mingw32-windres

[options]
*/*:shared=False
fltk/*:with_xft=True
fltk/*:with_gl=False
boost/*:magic_autolink=False
boost/*:visibility=hidden
boost/*:header_only=False
boost/*:without_serialization=True
boost/*:without_graph=True
boost/*:without_fiber=True
boost/*:without_log=True
boost/*:without_math=True
boost/*:without_process=True
boost/*:without_stacktrace=True
boost/*:without_test=True
boost/*:without_wave=True
pugixml/*:no_exceptions=True
rotor/*:enable_asio=True
rotor/*:enable_thread=True
rotor/*:enable_fltk=True

Then make a build

mkdir build.release && cd build.release
conan install --build=missing --output-folder . -s build_type=Release \
    --profile:build=default --profile:host=mingw -o '&:shared=False'  ..
source ./conanbuild.sh
cmake .. -G "Unix Makefiles" -DCMAKE_TOOLCHAIN_FILE=$PWD/conan_toolchain.cmake \
   -DCMAKE_BUILD_TYPE=Release
make -j`nproc`

mxe

Download mxe; make sure all requirements are met.

Your settings.mk should contain something like:

MXE_TARGETS := x86_64-w64-mingw32.shared

Validate, that everything is OK via typing in mxe dir something like

make zip

Add $mxe_dir/uer/bin to your PATH, and make sure something like that works:

export PATH=`pwd`/usr/bin:$PATH
x86_64-w64-mingw32.shared-g++ --version
x86_64-w64-mingw32.shared-g++ (GCC) 11.2.0

Make a conan profile for mingw:

cat ~/.conan2/profiles/mxe
[settings]
os=Windows
arch=x86_64
compiler=gcc
build_type=Release
compiler.cppstd=gnu17
compiler.libcxx=libstdc++11
compiler.version=11
[buildenv]
CC=x86_64-w64-mingw32.shared-gcc
CXX=x86_64-w64-mingw32.shared-g++
LD=x86_64-w64-mingw32.shared-ld
RC=x86_64-w64-mingw32.shared-windres

[options]
shared=False
*/*:shared=True
fltk/*:with_xft=True
fltk/*:with_gl=False
boost/*:magic_autolink=False
boost/*:visibility=hidden
boost/*:header_only=False
boost/*:without_serialization=True
boost/*:without_graph=True
boost/*:without_fiber=True
boost/*:without_log=True
boost/*:without_math=True
boost/*:without_process=True
boost/*:without_stacktrace=True
boost/*:without_test=True
boost/*:without_wave=True
protobuf/*:with_zlib=False
pugixml/*:no_exceptions=True
rotor/*:enable_asio=True
rotor/*:enable_thread=True
rotor/*:enable_fltk=True

Go to syncspirit dir and then make a build

cd syncspirit
mkdir build.release && cd build.release
conan install --build=missing --output-folder . -s build_type=Release \
    --profile:build=default --profile:host=mxe -o '&:shared=False' ..
source ./conanbuild.sh
cmake .. -G "Unix Makefiles" -DCMAKE_TOOLCHAIN_FILE=$PWD/conan_toolchain.cmake \
  -DCMAKE_BUILD_TYPE=Release
make -j`nproc`

mxe & windows xp

Download mxe; make sure all requirements are met.

Your settings.mk should contain something like:

MXE_TARGETS := i686-w64-mingw32.shared
MXE_PLUGIN_DIRS=plugins/windows-xp

Validate, that everything is OK via typing in mxe dir something like

make zip

Copy the resulting zip.exe to windows xp host and launch, i.e. make sure everything is ok with the toolchain.

Add $mxe_dir/uer/bin to your PATH, and make sure something like that works:

export PATH=`pwd`/usr/bin:$PATH
i686-w64-mingw32.shared-g++ --version
i686-w64-mingw32.shared-g++ (GCC) 11.2.0

Make a conan profile for mingw:

cat ~/.conan2/profiles/xp
[settings]
os=Windows
arch=x86
compiler=gcc
build_type=Release
compiler.cppstd=gnu17
compiler.libcxx=libstdc++11
compiler.version=12
[buildenv]
CC=i686-w64-mingw32.shared-gcc
CXX=i686-w64-mingw32.shared-g++
LD=i686-w64-mingw32.shared-ld
RC=i686-w64-mingw32.shared-windres

[options]
*/*:shared=False
fltk/*:with_xft=True
fltk/*:with_gl=False
boost/*:magic_autolink=False
boost/*:visibility=hidden
boost/*:header_only=False
boost/*:without_serialization=True
boost/*:without_graph=True
boost/*:without_fiber=True
boost/*:without_log=True
boost/*:without_math=True
boost/*:without_process=True
boost/*:without_stacktrace=True
boost/*:without_test=True
boost/*:without_wave=True
protobuf/*:with_zlib=False
pugixml/*:no_exceptions=True
rotor/*:enable_asio=True
rotor/*:enable_thread=True
rotor/*:enable_fltk=True

[conf]
tools.build:cflags=["-D_WIN32_WINNT=0x0501"]
tools.build:cxxflags=["-D_WIN32_WINNT=0x0501", "-DBOOST_ASIO_ENABLE_CANCELIO=1"]

The supped libmbdx should be patched for windows xp support:

cd syncspirit/lib/mbdx
 patch -p1 < ../mdbx-xp-patch.diff

Go to syncspirit dir and then make a build

cd syncspirit
mkdir build.release && cd build.release
conan install --build=missing --output-folder . -s build_type=Release \
    --profile:build=default --profile:host=xp -o '&:shared=False' .. ..
source ./conanbuild.sh
cmake .. -G "Unix Makefiles" -DCMAKE_TOOLCHAIN_FILE=$PWD/conan_toolchain.cmake \
  -DCMAKE_BUILD_TYPE=Release \
  -DCMAKE_CXX_FLAGS="-DBOOST_ASIO_ENABLE_CANCELIO=1"
make -j`nproc` deploy_deps

making appImage (ubuntu 20.04 etc.)

debootstrap --arch amd64 focal  ubuntu-root http://archive.ubuntu.com/ubuntu/

mount --bind /proc ubuntu-root/proc/
mount --rbind /dev ubuntu-root/dev/
chroot ubuntu-root


apt update
apt-get install -y software-properties-common
add-apt-repository universe -y
add-apt-repository ppa:ubuntu-toolchain-r/ppa -y
apt update
apt install -y g++-9 gcc-9

apt install -y g++-10 gcc-10
apt-get install -y wget libxft-dev build-essential python3-pip make cmake git fuse libfuse2 libx11-dev libx11-xcb-dev libfontenc-dev libice-dev libsm-dev libxau-dev libxaw7-dev libxcomposite-dev libxcursor-dev libxdamage-dev libxfixes-dev libxi-dev libxinerama-dev libxkbfile-dev libxmuu-dev libxrandr-dev libxrender-dev libxres-dev libxss-dev libxtst-dev libxv-dev libxxf86vm-dev libxcb-glx0-dev libxcb-render0-dev libxcb-render-util0-dev libxcb-xkb-dev libxcb-icccm4-dev libxcb-image0-dev libxcb-keysyms1-dev libxcb-randr0-dev libxcb-shape0-dev libxcb-sync-dev libxcb-xfixes0-dev libxcb-xinerama0-dev libxcb-dri3-dev uuid-dev libxcb-cursor-dev libxcb-dri2-0-dev libxcb-dri3-dev libxcb-present-dev libxcb-composite0-dev libxcb-ewmh-dev libxcb-res0-dev libxcb-util0-dev libxcb-util-dev libglu1-mesa-dev pkgconf

adduser --quiet --disabled-password c

su c
export PATH=$HOME/.local/bin:$PATH
pip3 install --user conan
conan profile detect

cat << EOF > $HOME/.conan2/profiles/default
[settings]
arch=x86_64
build_type=Release
os=Linux
compiler=gcc
compiler.cppstd=gnu17
compiler.libcxx=libstdc++11
compiler.version=10
os=Linux
[buildenv]
CC=gcc-10
CXX=g++-10

[options]
shared=True
*/*:shared=True
fltk/*:with_xft=True
fltk/*:with_gl=False
boost/*:magic_autolink=False
boost/*:visibility=hidden
boost/*:header_only=False
boost/*:without_serialization=True
boost/*:without_graph=True
boost/*:without_fiber=True
boost/*:without_log=True
boost/*:without_math=True
boost/*:without_process=True
boost/*:without_stacktrace=True
boost/*:without_test=True
boost/*:without_wave=True
protobuf/*:with_zlib=False
pugixml/*:no_exceptions=True
rotor/*:enable_asio=True
rotor/*:enable_thread=True
rotor/*:enable_fltk=True
EOF

git clone https://notabug.org/basiliscos/syncspirit.git
cd syncspirit
git checkout v0.4.0-dev
git submodule update --init
mkdir build.chroot
cd build.chroot
conan install --build=missing --output-folder . -s build_type=Release  -o '&:shared=True' ..
source ./conanbuild.sh
cmake .. -G "Unix Makefiles" -DCMAKE_TOOLCHAIN_FILE=conan_toolchain.cmake  -DCMAKE_POLICY_DEFAULT_CMP0091=NEW -DCMAKE_BUILD_TYPE=Release
make -j`nproc`
make deploy_syncspirit-fltk

Development build

conan install --build=missing --output-folder . -s build_type=Debug

-o '&:shared=True' ..

cmake .. -G "Unix Makefiles" -DCMAKE_TOOLCHAIN_FILE=conan_toolchain.cmake

-DCMAKE_BUILD_TYPE=Debug -DSYNCSPIRIT_BUILD_TESTS=on \
-DCMAKE_CXX_FLAGS="-fuse-ld=mold"