Martchus
/
cpp-utilities
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Common C++ classes and routines used by my applications such as argument parser, IO and conversion utilities
137 Commits 18 Branches 79 Tags 2.3 MiB
C++ 79.9%
CMake 18.6%
C 1.4%
Awk 0.1%
Go to file
Martchus 3ead704f1d Improve DECLARE_ENUM macro 
- DECLARE_ENUM now declares a regular enum.
- DECLARE_ENUM_CLASS declares an enum class.
- Macros don't include a trailing ';' so they
  can also be used when defining an enum.
 		2016-07-11 21:32:20 +02:00
application Improve DECLARE_ENUM macro 2016-07-11 21:32:20 +02:00
chrono Make header guards more unique and consistent 2016-06-11 19:09:14 +02:00
cmake Use option for CMake options 2016-07-10 00:16:43 +02:00
conversion Rewrite argument parsing 2016-06-13 00:00:36 +02:00
io Add methods to get dir path and entries 2016-07-02 02:01:26 +02:00
math added functions for modulo calculations 2016-01-27 00:15:01 +01:00
misc Complete generation of API doc 2016-06-10 22:59:22 +02:00
testfiles added more tests, fixed some bugs 2016-01-27 02:25:28 +01:00
tests Provide complete occurance info (callbacks) 2016-07-04 23:18:49 +02:00
.gitignore added more tests, fixed some bugs 2016-01-27 02:25:28 +01:00
CMakeLists.txt Add support for bash completion 2016-07-04 02:46:54 +02:00
LICENSE Create LICENSE 2015-04-22 19:01:00 +02:00
README.md Update README.md 2016-07-04 23:53:56 +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.
  • 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 (I've tested GNU g++, Clang and mingw-w64 yet.)
  • CMake (I've only tested 3.5.1 so far.)
  • 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.
  • 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