Skip to content

A C++ 17/20 general purpose class library. 15 different modules cover areas from strings and formatting, over debug logging to expression-parser and file scanner.

License

Notifications You must be signed in to change notification settings

AlexWorx/ALib-Class-Library

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ALib Homepage

Please find all about the ALib For C++, including

  • Programmer's Manuals
  • Reference Documentation
  • Tutorials
  • Project setup guide
  • Version History / Change log

at the ALib Homepage.

Abstract

ALib is a general purpose, use-case agnostic, platform independent, low-level C++ class library.

Its mission is to provide foundational concepts, types and idioms relevant to any C++ project. As of today, ALib consists of 15 modules, each addressing different topics. A subset of the available modules can be selectively included in a custom library build. This means, you just get what you choose from the menu.

Some highlights of the functionality:

  • ALib Strings: String types with interfaces similar to Java/C#, compatible with anything that "smells" like a string (due to some template meta programming magic).
  • ALibBoxing: Consider this "std::any on steroids".
  • ALib Enums: Finally, we get what we expected from C++ enums.
  • ALib Monomem: Monotonic allocation with recycling. Why use the oh-so-slow heap?
  • ALib ALox: Logging for adults.
  • ALib Bitbuffer: Write bit-streams instead of human readable text.
  • ALib CLI: Command line parser with support of environment variables and configuration files.
  • ALib Expressions: Type-safe run-time expression compiler. Easily extensible to support your custom expression functions. 130+ (optional) predefined functions (math, string compare, date/time, etc.)
  • ALib Files: A directory and file scanner (with run-time expression support)
  • And last but not least: Many more tools like managing bootstrapping of C++ software, externalized resources, resources, configuration data, singletons with Windows DLLs, ...

Main Characteristics And Design Goals

  • ALib is free software.
  • Compiles and tested with C++ 17 and 20.
  • Modularization: Possible selective use of only parts of the library.
  • Extensive documentation.
  • Least intrusive: Designed to keep user code as independent from ALib types and idioms as possible.
  • Ease of use by design. When things become complex, features are hidden behind default behaviour and are only available to users who read the detail chapters of the various Programmer's Manuals.
  • Developed and steadily tested under GNU/Linux, Windows OS, Mac OS, and Raspberry. For details in respect to the current release, see section below.

Documentation

The following documentation is provided. The following documentation is provided.

  1. A \ref alib_manual General Library Manual is available describing the library structure, its setup and compilation, bootstrapping, etc.

  2. Fifteen separated Programmer's Manuals are published with the ALib Homepage! (One for each ALib Module).

    The manuals are well structured, provide step by step source-code tutorials and sometimes go into in-depth discussion in respect to design decisions and overall rationals behind important features of the ALib Modules.

  3. Reference Documentation which is covering100% of the provided types, members, functions, namespaces, macros, etc. In short, each and every C++ entity is documented.

  4. A detailed version history, documenting every interface change is found in the Changelog.

  5. All documentation provided leverages the full power of Doxygen (the industry standard).

    Therefore, changes in the library's interfaces are always detected and corrected. The many code samples are implemented as unit tests and thus are "live"-integrated to the documentation, often together with the output text snippets of the recent unit test run. (See an example here).

Summary: ALib comes with a complete book of documentation, which has more than 1000 pages if printed. Its all explained, for beginners and experts!

IDE / Build System Setup

The current Version got tested on the following platform combinations:

  • GNU/Linux Arch 6.7.6, GNU C++ 13.2.1 / Clang++ 16.0.6, C++ 17/20, 32-Bit / 64-Bit (This is the main development platform.)
  • Windows 10/11, MSC 17.8.3 (Visual Studio 2022), C++ 17/20, 32-Bit / 64-Bit
  • Windows 10/11, MinGW, C++ 17/20, 64-Bit
  • MacOS Sonoma 14.3.1, Apple M2 / ARM64, Apple Clang Version 15.0.0, C++ 17/20, 64-Bit
  • Raspberry 3, ARM, 64-bit OS, GCC 10.2.1, C++ 17/20, 64-Bit
  • Raspberry 4, ARM, 64-bit OS, GNU C++ 12.2.0, C++ 17/20

The Programmer's Manual contains an extensive chapter about how to compile and use ALib in your C++ environment.

C# and Java Versions Of ALib

Parts of ALib have sibling incarnations in programming languages C# and JAVA. Historically, ALib aimed to be a cross platform/cross language library. This goal was (mostly) dropped in favour to be able to independently develop ALib for C++.

ALib for C# and ALib for Java are included in and distributed with the cross platform ALox Logging Library.

License

ALib is free software, can be downloaded at Github and sources are published under Boost Software License

Library Dependencies

ALib compiles as is, hence it is not dependent on any 3rd-party library. Optional dependencies exist. For example if boost is available, ALib Strings are using its regex search. In contrast, ALib provides optional compatibility headers for 3rd-party libraries (e.g. QT Class Library), which for example provide adoptions of ALib type-traits for QT-types.

Contributions

We would be happy, if the community started to support this library and are willing to receive contributions and, if accepted, to update the code accordingly.

Note that for legal reasons, we hereby explicitly refuse and reject code (or ideas for code) that are not explicitly provided under the Boost Software License. Please do not even contact us with your ideas/code in that case.

Thanks

Our thanks go to all supporters that did and do help realizing this project. Furthermore to just all of these millions of supporters of free software, including:

Special thanks also to C. Darwin, who created life on earth hundreds of millions of years ago, until he - when things became too crazy - disappeared in 1882.

More Information...

Please visit the ALib Homepage!