Common C++ classes and routines used by my applications such as argument parser, IO and conversion utilities
Go to file
Martchus 2dc5219adf Log bash-completion args 2017-07-28 19:35:49 +02:00
application Log bash-completion args 2017-07-28 19:35:49 +02:00
chrono Fix handling negative time spans 2017-06-25 16:00:11 +02:00
cmake Prevent error in coverage target when building only static libs 2017-07-28 17:34:28 +02:00
conversion Write digitToChar() in a more compact way 2017-06-29 18:24:11 +02:00
doc Improve documentation of build-variables 2017-07-20 02:30:00 +02:00
io catchiofailure: defined _GLIBCXX_USE_CXX11_ABI first to cover GCC 5 2017-06-25 12:29:32 -05:00
math Apply clang-format 2017-05-01 03:13:11 +02:00
misc Add trait to test for strings 2017-05-10 23:31:28 +02:00
scripts Call wine actually 2016-10-29 00:21:42 +02:00
testfiles Fix bash completion when dir/file contains single quote 2016-10-22 20:52:08 +02:00
tests Improve argument parser tests 2017-07-28 19:33:55 +02:00
.gitignore Fix INI test 2017-06-09 12:15:24 +02:00
CMakeLists.txt bash completion: Show values for implicit args 2017-07-28 17:32:16 +02:00
LICENSE Create LICENSE 2015-04-22 19:01:00 +02:00
README.md Improve README section for RPM packages 2017-07-22 15:32:06 +02:00
coding-style.clang-format Set clang-format standard to Cpp11 2017-05-04 22:43:20 +02:00
global.h Adapt global.h.in to new coding style 2017-05-01 02:57:58 +02:00

README.md

C++ utilities

Common C++ classes and routines used by my applications such as argument parser, IO and conversion utilities.

Features

The library utilizes:

  • parsing command-line arguments and providing Bash completion
  • dealing with dates and times
  • conversion of primitive data types to byte-buffers and vice versa (litte-endian and big-endian)
  • common string conversions/operations, eg.
    • character set conversion via iconv
    • split, join, find and replace
    • conversion from number to string and vice verca
    • encoding/decoding base-64
    • building string without multiple heap allocations (string builder)
  • IO
    • reading/writing primitive data types of various sizes (little-endian and big-endian)
    • reading/writing terminated strings and size-prefixed strings
    • reading/writing INI files
    • reading bitwise
  • building with CMake by providing some modules and templates

Build instructions

Requirements

Build-only dependencies

  • C++ compiler supporting C++14, tested with
    • Clang
    • regular GNU g++
    • mingw-w64 g++
    • Cygwin g++
  • CMake (at least 3.3.0)
  • cppunit for unit tests (optional)
  • Doxygen for API documentation (optional)
  • Graphviz for diagrams in the API documentation (optional)
  • clang-format for tidying (optional)
  • llvm-profdata, llvm-cov and cppunit for source-based code coverage analysis (optional)

Runtime dependencies

  • The c++utilities library itself only needs
  • C/C++ standard library supporting C++14
  • libiconv (might be part of glibc or provided as extra library)
  • For dependencies of my other projects check the README.md of these projects.

How to build

Just run:

cd "path/to/build/directory"
cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX="/final/install/location" "path/to/projectdirectory"
make tidy # format source files (optional)
make
make check # build and run unit tests (optional)
make apidoc # build API documentation (optional)
make DESTDIR="/temporary/install/location" install

General notes

  • Building with qmake is not supported anymore.
  • The make option -j can be used for concurrent compilation.
  • LIB_SUFFIX, LIB_SUFFIX_32 and LIB_SUFFIX_64 can be set to specify a suffix for the library directory, eg. lib64 or lib32. The 32/64 variants are only used when building for 32/64-bit architecture.
  • By default the build system will build shared libs. To build also static libraries, set ENABLE_STATIC_LIBS=ON. To disable building shared libs set DISABLE_SHARED_LIBS=ON.
  • By default the build system will prefer linking against shared libraries. To force linking against static libraries set STATIC_LINKAGE=ON. However, this will only affect applications. To force linking statically when building shared libraries set STATIC_LIBRARY_LINKAGE=ON.

Building for Windows

Building for Windows with Mingw-w64 cross compiler can be utilized using a small cmake wrapper from Fedora:

${_arch}-cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX="/final/install/location" "path/to/source/directory"
make DESTDIR="/temporary/install/location" install-mingw-w64-strip
  • To create the *.ico file for the application icon ffmpeg/avconv is required.
  • The target install-mingw-w64-strip in the example will only install files suitable for creating a cross-compiler package and additionally strip the binaries.

Development builds

During development I find it useful to build all required projects (for instace c++utilities, qtutilities, tagparser and tageditor) as one big project.

This can be easily achieved by using CMake's add_subdirectory() function. For project files see the repository subdirs. For an example, see build instructions for Syncthing Tray.

For a debug build, just use -DCMAKE_BUILD_TYPE=Debug.

Arch Linux package

The repository PKGBUILDs contains files for building Arch Linux packages.

PKGBUILD files to build for Windows using the Mingw-w64 compiler are also included.

RPM packages

RPM *.spec files can be found at openSUSE Build Servide. Packages are available for x86_64, aarch64 and armv7l. Since GCC provided by Leap is too old, only Tumbleweed packages are up-to-date.

Gentoo

Packages are provided by perfect7gentleman; checkout his repository.

Cygwin

Scripts to build with Cygwin are provided by svnpenn. Checkout his repository.

General notes

  • There is a workaround for GCC Bug 66145 provided in io/catchiofailure.h.

TODO

  • remove unused features