core

Core of the HUD-Engine

Stars
0

Table of contents

  1. Status
  2. Description

Status

Windows build and test msvc_2022_x86-64 clang-cl_2022_x86-64
Ubuntu build and test clang_14_x86-64 gcc_12_x86-64
Sanitizer MSVC GCC Clang
Coverage codecov
Quality codeql codacy

Description

Core is the heart of the HUD engine for HUD-Software.

It provides low-level C++ features that are close to the C++ STL implementation:

  • Containers: array (std::vector), pair, tuple, optional, shared_pointer, unique_pointer, etc.
  • Debugging features: conditional break, debugger attached checker, call stacks, etc.
  • Memory: dynamic allocations, slicing, constexpr allocations/constructions/destructions, etc.
  • Strings: UTF-8 strings, ANSI strings, platform-specific strings, etc.

Core follows the STL interface but permits making changes and additions to the STL specification to improve productivity, limit bugs, and enhance performance. It focuses on code quality, robustness, and performance.

Core follows the HUD-Software project organization:

  • The src directory contains the source and interface of the Core.

    • The src/core directory contains the interface of the Core library. This is the directory that will be included in C++ user code to use the library.
  • The test directory contains the source of all tests of the Core in src. Code coverage checks ensure that test covers all src code.