jaulib v1.1.2-28-g30efb27-dirty
Jau Support Library (C++, Java, ..)
|
This project's canonical repositories is hosted on Gothel Software.
This project aims to provide general C++ and Java collections, algorithms and utilities - as well as basic concepts to support a Java JNI binding.
This project was extracted from Direct-BT to enable general use and enforce better encapsulation.
Build and clang-tidy clean on C++17 and C++20, passing all unit tests.
Up to date API documentation can be found:
See Direct-BT C++ API Doc.
Language requirements
See supported platforms for details.
It is advised to include this library into your main project, e.g. as a git-submodule.
Then add jaulib/include/ to your C++ include-path and also add the C++ source files under jaulib/src/ into your build recipe.
The produced Java libraries are fully functional.
This library's build recipe are functional though, but currently only intended to support unit testing and to produce a Doxygen API doc.
lint
validationvscodium
integrationInstalling build dependencies on FreeBSD >= 13:
Install optional Java dependencies:
For Java ensure /etc/fstab
includes:
jau::fs::mount_image()
and jau::fs::umount()
are currenly not fully implemented under FreeBSD
, hence testing using cmake option -DTEST_WITH_SUDO=ON
is disabled.
To use URL streaming functionality via the curl
library in jau_io_util.hpp
and jau/io_util.cpp
, the cmake option -DUSE_LIBCURL=ON
must be set.
This also requires installation of the following packets:
Note: mini-httpd
is being used for unit testing URL streaming only.
Installing build dependencies on Debian >= 11 and Ubuntu >= 20.04:
If using the optional clang toolchain, perhaps change the clang version-suffix of above clang install line to the appropriate version.
After complete clang installation, you might want to setup the latest version as your default. For Debian you can use this clang alternatives setup script.
Install optional Java dependencies:
To test jau::fs::mount_image()
and jau::fs::umount()
under Linux
with enabled cmake option -DTEST_WITH_SUDO=ON
,
the following build dependencies are added
To use URL streaming functionality via the curl
library in jau_io_util.hpp
and jau/io_util.cpp
, the cmake option -DUSE_LIBCURL=ON
must be set.
This also requires installation of the following packets:
Note: mini-httpd
is being used for unit testing URL streaming only.
For a generic build use:
The install target of the last command will create the include/ and lib/ directories with a copy of the headers and library objects respectively in your build location. Note that doing an out-of-source build may cause issues when rebuilding later on.
You may also invoke scripts/build.sh
, which resolves installed environment variables like JAVA_HOME
and JUNIT_CP
as well as building and distributing using os_arch
type folders.
scripts/setup-machine-arch.sh
.. generic setup for all scriptsscripts/build.sh
.. initial build incl. install and unit testingscripts/rebuild.sh
.. rebuildscripts/build-cross.sh
.. cross-buildscripts/rebuild-cross.sh
.. cross-buildscripts/test_java.sh
.. invoke a java unit testscripts/test_exe_template.sh
.. invoke the symlink'ed files to invoke native unit testsOur cmake configure has a number of options, cmake-gui or ccmake can show you all the options. The interesting ones are detailed below:
Changing install path from /usr/local to /usr
Building debug build:
Add unit tests to build (default: disabled)
Add unit tests requiring sudo
to build (default: disabled).
This option requires -DBUILD_TESTING=ON
to be effective.
Covered unit test requiring sudo
are currently
Linux
OSjau::fs::mount_image()
jau::fs::umount()
Using clang instead of gcc:
Building with clang and clang-tidy lint
validation
Disable stripping native lib even in non debug build:
Enable using libcurl
(default: disabled)
Enable using libunwind
(default: disabled)
Disable using C++ Runtime Type Information
(RTTI) (default: enabled)
Override default javac debug arguments source,lines
:
Building debug and instrumentation (sanitizer) build:
Cross-compiling on a different system:
To build Java bindings:
To build documentation run:
Also provided is a cross-build script using chroot into a target system using QEMU User space emulation and Linux kernel binfmt_misc to run on other architectures than the host.
See Build Procedure for general overview.
You may use our pi-gen branch to produce a Raspi-arm64, Raspi-armhf or PC-amd64 target image.
IDE integration configuration files are provided for
CMake Support
, install C/C++ CMake Build Support
with ID org.eclipse.cdt.cmake.feature.group
From the project root directory, prepare the Debug
folder using cmake
The existing project setup is just using external build
via make
.
You can import the project to your workspace via File . Import...
and Existing Projects into Workspace
menu item.
For Eclipse one might need to adjust some setting in the .project
and .cproject
(CDT) via Eclipse settings UI, but it should just work out of the box.
IDE integration configuration files are provided for
.settings/org.eclipse.jdt.core.prefs
describes the lint
behaviorFor VSCodium one might copy the example root-workspace file to the parent folder of this project (note the filename change) and adjust the path
to your filesystem.
Then you can open it via File . Open Workspace from File...
menu item.
clang-tidy
enabledclang-tidy
is too slow, just remove it from the settings file.clangd
will still contain a good portion of clang-tidy
checksSee Changes.