axl.cm

A multiplatform C++ library for common and basic system functionalities.

Platforms

• Linux
• Windows

C++ standard

• minimum: C++98
• target: C++11
• maximum: *

Features

• thread
  • Thread
  • Mutex
  • Semaphore
• time
  • Time - for keeping track of elapsed time. i.e. delta time since last setting.
  • Timer - count down timer for keeping track of elapsed, excess and remaining time.

Getting Started

Clone Repository

• git clone https://github.com/defalt8/axl.cm.git
• cd axl.cm

Build Library And Tests

Using The Build Scripts

• ./build

• ./build [target]

• ./build <library-type> <build-type> [target] ...cmake args

  • target: axl.cm | install | clean | ...
  • library-type: static | shared
  • config: Debug | Release | MinSizeRel | RelWithDebInfo
  • you can set this variables in the shell. They will be used in the build script when you run it
    • CMAKE_GENERATOR, CMAKE_BUILD_DIR, CMAKE_INSTALL_DIR, CMAKE_SOURCE_DIR

• build

  • ./build or
  • ./build axl.cm or
  • ./build static release or
  • ./build SHARED Release or
  • ./build Static debug axl.cm ...

• install

  • ./build install
  • ./build static release install ...

Manually

• configure cmake

  • cmake -B out/build or
  • cmake -B out/build -DAXLCM_BUILD_TESTS=OFF or
  • cmake -B out/build -DAXLCM_BUILD_TESTS=OFF -DBUILD_SHARED_LIBS=ON or
  • cmake -B out/build -DCMAKE_INSTALL_PREFIX=out/install or
  • cmake -B out/build -DCMAKE_INSTALL_PREFIX=out/install -DAXLCM_BUILD_TESTS=OFF or
  • cmake -B out/build -DCMAKE_INSTALL_PREFIX=out/install -DAXLCM_BUILD_TESTS=OFF -DBUILD_SHARED_LIBS=ON

• build

  • cmake --build out/build --config Release

• install

  • cmake --build out/build --config Release --target install

Testing

• Make sure that the tests are built.
• ./build test or ./build RUN_TESTS for MSCV
• ctest -C Release --test-dir out/build

Output

Generated library output files will be located under out/build/bin and out/build/lib

• The output names are:
  • Shared Release: axl.cm
  • Shared Debug: axl.cmd
  • Static Release: axl.cms
  • Static Debug: axl.cmsd

Header Files

• axl.cm
  • lib.hpp
  • everything.hpp
  • time/Time.hpp
  • time/Timer.hpp
  • thread/Thread.hpp
  • thread/Mutex.hpp
  • thread/Semaphore.hpp