Skip to content

ChocolateCharlie/lib_rt

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

56 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

lib_rt

A small C library with usual functions, freely inspired by The Open Group Base Specifications Issue 7, 2018 edition.

/!\ Warning : some parts of the documentation may temporary not be up to date, sorry :'(

How can I use it ?

If you want to use the full library, including all modules can be done typing a single line :

#include "lib_rt/lib_rt.h"

However, this will not include the testing module. See the lib_rtest documentation for this module.

If you want to use only a few modules, it is possible to do more specific includes. You may refer to the corresponding documentation, or have a look at the list of the available modules in the next section.

/!\ Warning : though parts of <stdio.h> are re-implemented, this library relies on it, and may rely in the future on other libraries.

This library also relies on <stdlib.h> for the lrt_assert module.

What are the modules currently available ?

lrt_assert

A free implementation of <assert.h>.

To include this header, use :

#include "lib_rt/lrt_assert/lrt_assert.h"

This module relies on :

  • <stdlib.h>
  • <stdio.h>

lrt_ctype (documentation may not be up to date)

A free implementation of <ctype.h>.

To include this module, use :

#include "lib_rt/lrt_ctype/lrt_ctype.h"

Tests are available separately in the lrtest_ctype repository (see lib_rtest).

lrt_limits.h (partially implemented)

A free implementation of <limits.h>.

To include this header, use :

#include "lib_rt/lrt_limits/lrt_limits.h"

lrt_stdbool.h - tested and documented

A free implementation of <stdbool.h>.

To include this header, use :

#include "lib_rt/lrt_stdbool/lrt_stdbool.h"

lrt_stdio.h (work in progress)

A free and partial implementation of <stdio.h>.

To include this header, use :

#include "lib_rt/lrt_stdio/lrt_stdio.h"

This module relies on :

  • <stdio.h>

lib_rtest (documentation may not be up to date)

Testing module of lib_rt.

To include all headers and sub-modules of this module, use :

#include "lib_rt/lib_rtest/lib_rtest.h"

lrtest_assert (work in progress)

Testing functions for lrt_assert.

To include this sub-module, use :

 #include "lib_rt/lib_rtest/lrt_assert/lrt_assert.h"

This module relies on :

  • <stdio.h>
  • lrt_assert.h
  • lrt_stdbool.h

lrtest_ctype (documentation may not be up to date)

Testing functions for lrt_ctype.

To include this sub-module, use :

#include "lib_rt/lib_rtest/lrt_ctype/lrt_ctype.h"

lrtest_stdbool - available

Testing functions for lrt_stdbool.

To include this sub-module, use :

#include "lib_rt/lib_rtest/lrt_stdbool/lrt_stdbool.h"

This module relies on :

  • lrt_assert.h
  • lrt_stdbool.h