Common C++ classes and routines used by my applications such as argument parser, IO and conversion utilities
Go to file
Martchus bbb884da30 Don't imply args which can't be combined
Leads to more useful error messages if an unknown
argument has been specified.
2016-11-15 21:44:23 +01:00
application Don't imply args which can't be combined 2016-11-15 21:44:23 +01:00
chrono Add DateTime::fromIsoString{Gmt,Local} 2016-09-01 15:42:25 +02:00
cmake Improve install-mingw-w64-strip target 2016-11-12 02:06:52 +01:00
conversion Make numberToString/stringToNumber work with u16string 2016-11-13 23:06:03 +01:00
io Make 'DirectoryEntryType &operator|=' not constexpr 2016-10-29 00:24:18 +02:00
math Fix decoration for static builds 2016-08-29 15:35:48 +02:00
misc Add traits for exploiting SFINAE 2016-11-13 22:51:09 +01: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 Fix minor mistake in argument parser 2016-11-14 22:38:21 +01:00
.gitignore added more tests, fixed some bugs 2016-01-27 02:25:28 +01:00
CMakeLists.txt Add traits for exploiting SFINAE 2016-11-13 22:51:09 +01:00
LICENSE Create LICENSE 2015-04-22 19:01:00 +02:00
README.md Add functions for character set conversions 2016-07-27 18:24:37 +02:00
global.h Improve doc 2016-10-30 00:30:54 +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
  • 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++11, tested with
  • GNU g++
  • mingw-w64
  • Clang
  • CMake, tested 3.5.1 and 3.6.0
  • cppunit for unit tests (optional)
  • Doxygen for API documentation (optional)
  • Graphviz for diagrams in the API documentation (optional)

Runtime dependencies

  • The c++utilities library itself only needs
  • the C/C++ standard library
  • 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
make check # build and run unit tests (optional)
make c++utilities_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.

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 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 package

A *.spec files can be found at openSUSE Build Servide.

General notes

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

TODO

  • remove unused features