Welcome to c_libs Library

The c_libs library contains a large assortment of typed and type-generic functionas and macros for various data structures and utilities such as file readers and the PRINT statement. This library was written for the express reason of providing a more modern object oriented interface to the C language. The user of this library can interface with its functionality through a type generic interface driven by the _Generic operator, or they can interface with the equivalent type specific functions. This libraries relies upon the use of the _Generic operator to enable Macros such that the Macros do not consume extra memory.

NOTE: This library is under maintenance. Please check the documentation for each section to ensure it is still in working order.

Contents:

Indices and tables

Installation

This library can be installed from GitHub. in the following manner

  1. Ensure that you have clang or gcc installed. This library was tested on gcc 12.2.1 and clang 14.0.0

  2. Ensure that you have git installed on your local machine

  3. Clone the c_libs repository with the command

    • git clone https://github.com/Jon-Webb-79/c_libs.git

If you wish to contribute to the development of this library you will need to install the Python virtual environments that are needed to support the Sphinx documentation tool.

  1. Ensure a valid Python distribution is installed on your computer with version 3.8 or greater.

  2. In the uppermost c_libs directory install a viertual environment

    • python -m venv .venv

  3. Activate the virtual environment with the following command;

Activation Commands for Virtual Environments

Platform

Shell

Command to activate virtual environment

POSIX

bash/zsh

$ source <venv>/bin/activate

fish

$ source <venv>/bin/activate.fish

csh/tcsh

$ source <venv>/bin/activate.csh

Powershell

$ <venv>/bin/Activate.ps1

Windows

cmd.exe

C:\> <venv>\\Scripts\\activate.bat

PowerShell

PS C:\\> <venv>\\Scripts\\Activate.ps1

  1. Install packages to virtual environments from requirements.txt file

    • pip install -r requirements.txt

  2. Ensure that cmocka is installed locally to suuport unit testing.

  3. Build the code. NOTE: The current build platforms are Linux and Mac OS. Presently scripts have not been written to run this on Windows.

    • If you are using bash, chante to teh following directory within the project c_libs/c_livs/script/bash

      • build the code with the following command bash build.sh

      • compile the test code with the following command bash compile.sh

      • Navigate to the following directory c_libs/c_libs/build/test

      • Verify the code runs correctly with the following command ./unit_tests

    • If you are using zsh change to teh following directory within the project c_libs/c_libs/scripts/zsh

      • build the code with the following command zsh build.zsh

      • compile the test code with the following command zsh compile.zsh

      • Navigate to the following directory c_libs/c_libs/build/test

      • Verify the code runs correctly with the following command ./unit_tests

  4. Install the library as a static library via xxx

  5. Install the library as a dynamically linked library via xxx