M*LIB: Generic type-safe Container Library for C language

Overview

M*LIB (M star lib) is a C library enabling to use generic and type safe container in pure C language, aka handling generic containers. The objects within the containers can still have proper constructor, destructor (and other methods): this is handled by the library. This makes it possible to construct fully recursive objects (container-of[...]-container-of-type-T), without erasing type information (typically using void pointers or resorting to C macro to access the container).

This is an equivalent of the C++ Standard Library but for standard ISO C99 / C11. There is not a strict mapping as both the STL and M*LIB have their exclusive containers: See here for details.

M*LIB is portable to any systems that support ISO C99. Some optional features need at least ISO C11.

M*LIB is only composed of a set of headers. There is no C file: you just have to put the header in the search path of your compiler, and it will work. There is no dependency (except some other headers of M*LIB and the LIBC).

One of M*LIB's design key is to ensure safety. This is done by multiple means:

in debug mode, defensive programming is extensively used: the contracts of the function are checked, ensuring that the data are not corrupted. For example, Buffer overflow are checked in this mode through bound checking or the intrinsic properties of a Red-Black tree (for example) are verified.
as few cast as possible are used within the library (as cast are the evil of safety). Still the library can be used with the greatest level of warnings by a C compiler without any aliasing warning.
the genericity is not done directly by macro, but indirectly by making them define inline functions with the proper prototypes: this enables the user calls to have proper warning checks.

Other key designs are:

do not rewrite the C library and just wrap around it (for example don't rewrite sort but stable sort),
do not make users pay the cost of what they don't need.

Due to the weak nature of the C language for pointers, type safe means that at least a warning is generated by the compiler in case of wrong type passed as container arguments to the functions.

M*LIB is still be quite-efficient: even if the implementation may not always be state of the art, there is no overhead in using this library rather than using direct C low-level access: the compiler is able to fully optimize the library calls since all the functions are declared as inline. In fact, M*LIB is one of the fastest generic C library you can find.

M*LIB uses internally the 'malloc', 'realloc' and 'free' functions to handle the memory pool. This behavior can be overridden at different level. M*LIB default policy is to abort the program if there is a memory error. However, this behavior can also be customized globally.

M*LIB may use a lot of assertions in its implementation to ensure safety: it is highly recommended to properly define NDEBUG for released programs.

M*LIB is distributed under BSD-2 simplified license.

It is strongly advised not to read the source to know how to use the library but rather read the examples or the tests.

In this documentation, 'shall' will be used to indicate a user constraint that is mandatory to follow under penalty of undefined behavior. 'should' will be used to indicate a recommendation to the user. All pointers expect non-null argument except if indicated.

Components

The available containers that doesn't require the user structure to be modified are:

m-array.h: header for creating array of generic type and of variable size,
m-list.h: header for creating singly-linked list of generic type,
m-deque.h: header for creating double-ended queue of generic type and of variable size,
m-dict.h: header for creating generic dictionary or set of generic type (and of variable kind),
m-rbtree.h: header for creating binary sorted tree of generic type,
m-bptree.h: header for creating B+TREE of generic type,
m-tuple.h: header for creating arbitrary tuple of generic type,
m-variant.h: header for creating arbitrary variant of generic type,
m-prioqueue.h: header for creating priority queue of generic type and of variable size,

The available containers of M*LIB for thread synchronization are:

m-buffer.h: header for creating fixed-size queue (or stack) of generic type (multiple producer / multiple consumer),
m-snapshot: header for creating 'snapshot' buffer for sharing synchronously big data (thread safe).
m-shared.h: header for creating shared pointer of generic type.
m-concurrent.h: header for transforming a container into a concurrent container.
[m-c-mempool.h]: WIP header for creating fast concurrent memory allocation.

The following containers are intrusive (You need to modify your structure to add fields needed by the container):

m-i-list.h: header for creating doubly-linked intrusive list of generic type,
m-i-shared.h: header for creating intrusive shared pointer of generic type (Thread Safe),

Other headers offering other functionality are:

m-string.h: header for creating dynamic variable-length string,
m-bitset.h: header for creating bit set (or "packed array of bool"),
m-algo.h: header for providing various generic algorithms to the previous containers.
m-funcobj.h: header for creating function object (used by algorithm generation).
m-mempool.h: header for creating specialized & fast memory allocator.
m-worker.h: header for providing an easy pool of workers on separated threads to handle work orders, used for parallelism tasks.
m-serial-json.h: header for importing / exporting the containers in JSON format.
m-serial-bin.h: header for importing / exporting the containers in an adhoc fast binary format.
[m-genint.h]: internal header for generating unique integers in a concurrent context.
m-core.h: header for meta-programming with the C preprocessor (used by all other headers).

Finally headers for compatibility with non C11 compilers:

m-atomic.h: header for ensuring compatibility between C's stdatomic.h and C++'s atomic header. Provide also an implementation over mutex if none is available.
m-mutex.h: header for providing a very thin layer across multiple implementation of mutex/threads (C11/PTHREAD/WIN32).

Each containers define their iterators.

All containers try to expose the same interface: if the method name is the same, then it does the same thing and is used in the same way. In some rare case, the method has to be adapted to the container.

Each header can be used separately from others: dependency between headers have been kept to the minimum.

Build & Installation

M*LIB is only composed of a set of headers, as such there is no build for the library. The library doesn't depend on any other library than the LIBC.

To run the test suite, run:

   make check

To generate the documentation, run:

   make doc

To install the headers, run:

   make install PREFIX=/my/directory/where/to/install

Other targets exist. Mainly for development purpose.

How to use

To use these data structures, you include the desired header, instantiate the definition of the structure and its associated methods by using a macro _DEF for the needed type. Then you use the defined functions. Let's see a first simple example that creates a list of unsigned int:

#include <stdio.h>
#include "m-list.h"

LIST_DEF(list_uint, unsigned int)      /* Define struct list_uint_t and its methods */

int main(void) {
   list_uint_t list ;             /* list_uint_t has been define above */
   list_uint_init(list);          /* All type needs to be initialized */
   list_uint_push_back(list, 42); /* Push 42 in the list */
   list_uint_push_back(list, 17); /* Push 17 in the list */
   list_uint_it_t it;             /* Define an iterator to scan each one */
   for(list_uint_it(it, list)     /* Start iterator on first element */
       ; !list_uint_end_p(it)     /* Until the end is not reached */
       ; list_uint_next(it)) {    /* Set the iterator to the next element*/
          printf("%d\n",          /* Get a reference to the underlying */
            *list_uint_cref(it)); /* data and print it */
   }
   list_uint_clear(list);         /* Clear all the list */
}

[ Do not forget to add -std=c99 (or c11) to your compile command to request a C99 compatible build ]

This looks like a typical C program except the line with 'LIST_DEF' that doesn't have any semi-colon at the end. And in fact, except this line, everything is typical C program and even macro free! The only macro is in fact LIST_DEF: this macro expands to the good type for the list of the defined type and to all the necessary functions needed to handle such type. It is heavily context dependent and can generate different code depending on it. You can use it as many times as needed to defined as many lists as you want. The first argument of the macro is the name to use, e.g. the prefix that is added to all generated functions and types. The second argument of the macro is the type to embed within the container. It can be any C type. The third argument of the macro is optional and is the oplist to use. See below for more information.

You could replace LIST_DEF by ARRAY_DEF to change the kind of container (an array instead of a linked list) without changing the code below: the generated interface of a list or of an array is very similar. Yet the performance remains the same as hand-written code for both the list variant and the array variant.

This is equivalent to this C++ program using the STL:

#include <iostream>
#include <list>

typedef std::list<unsigned int> list_uint_t;
typedef std::list<unsigned int>::iterator list_uint_it_t;

int main(void) {
   list_uint_t list ;             /* list_uint_t has been define above */
   list.push_back(42);            /* Push 42 in the list */
   list.push_back(17);            /* Push 17 in the list */
   for(list_uint_it_t it = list.begin()  /* Iterator is first element*/
       ; it != list.end()         /* Until the end is not reached */
       ; ++it) {                  /* Set the iterator to the next element*/
       std::cout << *it << '\n';  /* Print the underlying data */
   }
}

As you can see, this is rather equivalent with the following remarks:

M*LIB requires an explicit definition of the instance of the list,
M*LIB code is more verbose in the method name,
M*LIB needs explicit construction and destruction (as plain old C requests),
M*LIB doesn't return a value to the underlying data but a pointer to this value:
- this was done for performance (it avoids copying all the data within the stack)
- and for generality reasons (some structure may not allow copying data).

Note: list_uint_t is internally defined as an array of structure of size 1. This has the following advantages:

you effectively reserve the data whenever you declare a variable,
you pass automatically the variable per reference for function calls,
you can not copy the variable by an affectation (you have to use the API instead).

You can also condense the M*LIB code by using the M_EACH & M_LET macros if you are not afraid of using syntactic macros:

#include <stdio.h>
#include "m-list.h"

LIST_DEF(list_uint, unsigned int)   /* Define struct list_uint_t and its methods */

int main(void) {
   M_LET(list, LIST_OPLIST(uint)) { /* Define & init list as list_uint_t */
     list_uint_push_back(list, 42); /* Push 42 in the list */
     list_uint_push_back(list, 17); /* Push 17 in the list */
     for M_EACH(item, list, LIST_OPLIST(uint)) {
       printf("%d\n", *item);       /* Print the item */
     }
   }                                /* Clear of list will be done now */
}

Here is another example with a complete type (with proper initialization & clear function) by using the GMP library:

#include <stdio.h>
#include <gmp.h>
#include "m-array.h"

ARRAY_DEF(array_mpz, mpz_t, (INIT(mpz_init), INIT_SET(mpz_init_set), SET(mpz_set), CLEAR(mpz_clear)) )

int main(void) {
   array_mpz_t array ;             /* array_mpz_t has been define above */
   array_mpz_init(array);          /* All type needs to be initialized */
   mpz_t z;                        /* Define a mpz_t type */
   mpz_init(z);                    /* Initialize the z variable */
   mpz_set_ui (z, 42);
   array_mpz_push_back(array, z);  /* Push 42 in the array */
   mpz_set_ui (z, 17);
   array_mpz_push_back(array, z); /* Push 17 in the array */
   array_it_mpz_t it;              /* Define an iterator to scan each one */
   for(array_mpz_it(it, array)     /* Start iterator on first element */
       ; !array_mpz_end_p(it)      /* Until the end is not reached */
       ; array_mpz_next(it)) {     /* Set the iterator to the next element*/
          gmp_printf("%Zd\n",      /* Get a reference to the underlying */
            *array_mpz_cref(it));  /* data and print it */
   }
   mpz_clear(z);                   /* Clear the z variable */
   array_mpz_clear(array);         /* Clear all the array */
}

As the mpz_t type needs proper initialization, copy and destroy functions we need to tell to the container how to handle such a type. This is done by giving it the oplist associated to the type. An oplist is an associative array where the operators are associated to methods. In the example, we tell to the container to use the mpz_init function for the INIT operator of the type, the mpz_clear function for the CLEAR operator of the type, the mpz_set function for the SET operator of the type, the mpz_init_set function for the INIT_SET operator of the type. See oplist chapter for more information.

We can also write the same example shorter:

#include <stdio.h>
#include <gmp.h>
#include "m-array.h"

// Register the oplist of a mpz_t. It is a classic oplist.
#define M_OPL_mpz_t() M_CLASSIC_OPLIST(mpz)
// Define an instance of an array of mpz_t (both type and function)
ARRAY_DEF(array_mpz, mpz_t)
// Register the oplist of the created instance of array of mpz_t
#define M_OPL_array_mpz_t() ARRAY_OPLIST(array_mpz, M_OPL_mpz_t())

int main(void) {
  // Let's define 'array' as an 'array_mpz_t' & initialize it.
  M_LET(array, array_mpz_t)
    // Let's define 'z1' and 'z2' to be 'mpz_t' & initialize it
    M_LET (z1, z2, mpz_t) {
     mpz_set_ui (z1, 42);
     array_mpz_push_back(array, z1);  /* Push 42 in the array */
     mpz_set_ui (z2, 17);
     array_mpz_push_back(array, z2); /* Push 17 in the array */
     // Let's iterate over all items of the container
     for M_EACH(item, array, array_mpz_t) {
          gmp_printf("%Zd\n", *item);
     }
  } // All variables are cleared with the proper method beyond this point.
  return 0;
}

Or even shorter when you're comfortable enough with the library:

    #include <stdio.h>
    #include <gmp.h>
    #include "m-array.h"
    
    // Register the oplist of a mpz_t. It is a classic oplist.
    #define M_OPL_mpz_t() M_OPEXTEND(M_CLASSIC_OPLIST(mpz), INIT_WITH(mpz_init_set_ui) )
    // Define an instance of an array of mpz_t (both type and function)
    ARRAY_DEF(array_mpz, mpz_t)
    // Register the oplist of the created instance of array of mpz_t
    #define M_OPL_array_mpz_t() ARRAY_OPLIST(array_mpz, M_OPL_mpz_t())
    
    int main(void) {
      // Let's define & init 'z1=42' and 'z2=17' to be 'mpz_t'
      M_LET ((z1,42), (z2,17), mpz_t)
        // Let's define 'array' as an 'array_mpz_t' with 'z1' and 'z2'
        M_LET((array,z1,z2), array_mpz_t) {
         // Let's iterate over all items of the container
         for M_EACH(item, array, array_mpz_t) {
              gmp_printf("%Zd\n", *item);
         }
      } // All variables are cleared with the proper method beyond this point.
      return 0;
    }

There are two ways a container can known what is the oplist of a type:

either the oplist is passed explicitly for each definition of container and for the LET & EACH macros,
or the oplist is registered globally by defining a new macro starting with the prefix M_OPL_ and finishing with the name of type (don't forget the parenthesis). The macros performing the definition of container and the LET & EACH will test if such macro is defined. If it is defined, it will be used. Otherwise default methods are used.

Here we can see that we register the mpz_t type into the container with the minimum information of its interface needed.

We can also see in this example so the container ARRAY provides also a macro to define the oplist of the array itself. This is true for all containers and this enables to define proper recursive container like in this example which reads from a text file a definition of sections:

    #include <stdio.h>
    #include "m-array.h"
    #include "m-tuple.h"
    #include "m-dict.h"
    #include "m-string.h"
    
    TUPLE_DEF2(symbol, (offset, long), (value, long))
    #define M_OPL_symbol_t() TUPLE_OPLIST(symbol, M_DEFAULT_OPLIST, M_DEFAULT_OPLIST)
    
    ARRAY_DEF(array_symbol, symbol_t)
    #define M_OPL_array_symbol_t() ARRAY_OPLIST(array_symbol, M_OPL_symbol_t())
    
    DICT_DEF2(sections, string_t, array_symbol_t)
    #define M_OPL_sections_t() DICT_OPLIST(sections, STRING_OPLIST, M_OPL_array_symbol_t())
    
    int main(int argc, const char *argv[])
    {
      if (argc < 2) abort();
      FILE *f = fopen(argv[1], "rt");
      if (!f) abort();
      M_LET(sc, sections_t) {
        sections_in_str(sc, f);
        array_symbol_t *a = sections_get(sc, STRING_CTE(".text"));
        if (a == NULL) {
          printf("There is no .text section.");
        } else {
          printf("Section .text is :");
          array_symbol_out_str(stdout, *a);
          printf("\n");
        }
      }
      return 0;
    }

This example reads the data from a file and outputs the .text section if it finds it on the terminal.

Other examples are available in the example folder.

Internal fields of the structure are subject to change even for small revision of the library.

The final goal of the library is to be able to write code like this in pure C while keeping type safety and compile time name resolution:

    let(list, list_uint_t) {
      push(list, 42);
      push(list, 17);
      for each (item, list) {
        print(item, "\n");
      }
    }

OPLIST

An OPLIST is a fundamental notion of M*LIB that hasn't be used in any other library. In order to know how to operate on a type, M*LIB needs additional information as the compiler doesn't know how to handle properly any type (contrary to C++). This is done by giving an operator list (or oplist in short) to any macro that needs to handle the type. As such, an oplist as only meaning within a macro expansion. Fundamentally, this is the exposed interface of a type with documented operators using an associative array implemented with the only C preprocessor where the operators are the predefined keys and the methods are the values.

An oplist is an associative array of operator over methods in the following format:

(OPERATOR1(method1), OPERATOR2(method2), ...)

The function 'method1' is used to handle 'OPERATOR1'. The function 'method2' is used to handle 'OPERATOR2'. etc. The order of the operator in this list is the priority order: in case the same operator appear multiple times in the list, the first one is the priority.

The method of an operator in an oplist is a preprocessor expression that shall not contain a comma.

It is used to perform the association between the operation on a type and the function that performs this operation. Without an oplist, M*LIB has no way to known how to deal with your type and will deal with it like a classic C type.

When you define an instance of a new container, you give the type oplist you want to use as the base of the container. This type oplist performs the association between the operators and the methods for the type. In function of the available interface of the oplist, the container definition macro function generates the interface of the container. You can then use this interface directly. You can also use the oplist of the container to chain this new interface with another container, creating container-of-container.

A function name can be followed by the token M_IPTR in the oplist (for example: (INIT(init_func M_IPTR)) ) to specify that the function accept as its first argument a pointer to the type rather than the type itself (aka the prototype is init_func(type *) instead of init_func(type)). If you use the '[1]' trick (see below), you won't need this. See also the API_* transformation call below for further transformation means of the calls.

An oplist has no real form from a C language point of view. It is just an abstraction that disappears after the macro expansion step of the preprocessing.

For each object / container, an oplist is needed. The following operators are usually expected for an object:

INIT(obj): initialize the object 'obj' into a valid state (constructor).
INIT_SET(obj, org): initialize the object 'obj' into the same state as the object 'org' (constructor).
SET(obj, org): set the initialized object 'obj' into the same state as the initialized object org (operator).
CLEAR(obj): destroy the initialized object 'obj', releasing any attached memory (destructor). This method shall never fail.

INIT, INIT_SET & SET methods shall only fail due to memory errors.

Not all operators are needed within an oplist to handle a container. If some operator is missing, the associated default operator of the function is used. To use C integer or float types, the default constructors are perfectly fine: you may use M_DEFAULT_OPLIST to define the operator list of such types or you can just omit it.

NOTE: An iterator doesn't have a constructor nor destructor methods. It should not allocate any memory. A reference to an object through an iterator is only valid until another reference is taken from the same container (potentially through another iterator), the iterator is moved. If the container is modified, all iterators of this container become invalid and shall not be used anymore except if the modifying operator provided itself an updated iterator. Some containers may lessen these constraints.

Which OPLIST to use?

My type is:

a C Boolean: M_BOOL_OPLIST (M_DEFAULT_OPLIST also works partially),
a C integer or a C float: M_DEFAULT_OPLIST (it can also be omitted),
a C enumerate: M_ENUM_OPLIST,
a pointer to something (the contained do nothing on the pointed object): M_PTR_OPLIST,
a plain structure that can be init/copy/compare with memset/memcpy/memcmp: M_POD_OPLIST,
a plain structure that is passed by reference using [1] and can be init,copy,compare with memset,memcpy,memcmp: M_A1_OPLIST,
a type that offers name_init, name_init_set, name_set, name_clear methods: M_CLASSIC_OPLIST,
a const string (const char *) that is neither freed nor moved: M_CSTR_OPLIST,
a M*LIB string_t: STRING_OPLIST,
a M*LIB container: the OPLIST of the used container,
other things: you need to provide a custom OPLIST to your type.

Note: The precise exported methods of the Oplist depend of the version of the C language used. Typically, in C11 mode, the M_DEFAULT_OPLIST exports all needed methods to handle generic input/output of int/floats (using _Generic) whereas it is not possible in C99 mode.

This explains why JSON import/export is only available in C11 mode (See below chapter).

Memory Allocation

Memory Allocation functions can be globally set by overriding the following macros before using the definition _DEF macros:

M_MEMORY_ALLOC (type): return a pointer to a new object of type 'type'.
M_MEMORY_DEL (ptr): free the single object pointed by 'ptr'.
M_MEMORY_REALLOC (type, ptr, number): return a pointer to an array of 'number' objects of type 'type', reusing the old array pointed by 'ptr'. 'ptr' can be NULL, in that case the array will be created.
M_MEMORY_FREE (ptr): free the array of objects pointed by 'ptr'.

ALLOC & DEL operators are supposed to allocate fixed size single element object (no array). Theses objects are not expected to grow. REALLOC & FREE operators deal with allocated memory for growing objects. Do not mix pointers between both: a pointer allocated by ALLOC (resp. REALLOC) is supposed to be only freed by DEL (resp. FREE). There are separated 'free' operators to enable specialization in the allocator (a good allocator can take this hint into account).

M_MEMORY_ALLOC and M_MEMORY_REALLOC are supposed to return NULL in case of memory allocation failure. The defaults are 'malloc', 'free', 'realloc' and 'free'.

You can also override the methods NEW, DEL, REALLOC & DEL in the oplist given to a container so that only the container will use these memory allocation functions.

Out-of-memory error

When a memory exhaustion is reached, the global macro "M_MEMORY_FULL" is called and the function returns immediately after. The object remains in a valid (if previously valid) and unchanged state in this case.

By default, the macro prints an error message and aborts the program: handling non-trivial memory errors can be hard, testing them is even harder but still mandatory to avoid security holes. So the default behavior is rather conservative.

Indeed, a good design should handle a process entire failure (using for examples multiple processes for doing the job) so that even if a process stops, it should be recovered. See here for more information about why abandonment is good software practice.

It can however be overloaded to handle other policy for error handling like:

throwing an error (in that case, the user is responsible to free memory of the allocated objects - destructor can still be called),
set a global error and handle it when the function returns,
other policy.

This function takes the size in bytes of the memory that has been tried to be allocated.

If needed, this macro shall be defined prior to instantiate the structure.

NOTE: Throwing an error is not fully supported yet. Some help from the library is needed to avoid losing memory. See issue #15.

ERRORS & COMPILERS

M*LIB implements internally some controls to reduce the list of errors/warnings generated by a compiler when it detects some violation in the use of oplist by use of static assertion. It can also transform some type warnings into proper errors. In C99 mode, it will produce illegal code with the name of the error as attribute. In C11 mode, it will use static assert and produce a detailed error message.

The list of errors it can generate:

M_LIB_NOT_AN_OPLIST: something has been given (directly or indirectly) and it doesn't reduce as a proper oplist. You need to give an oplist for this definition.
M_LIB_ERROR(ARGUMENT_OF_*_OPLIST_IS_NOT_AN_OPLIST, name, oplist): sub error of the previous error one, identifying the root cause. The error is in the oplist construction of the given macro. You need to give an oplist for this oplist construction.
M_LIB_MISSING_METHOD: a required operator doesn't define any method in the given oplist. You need to complete the oplist with the missing method.
M_LIB_TYPE_MISTMACH: the given oplist and the type do not match each other. You need to give the right oplist for this type.
M_LIB_NOT_A_DEFAULT_TYPE: The oplist M_DEFAULT_OPLIST (directly or indirectly) has been used with the given type, but the given type is not a default type. You need to give the right oplist for this type.

You should focus mainly on the first reported error/warning even if the link between what the compiler report and what the error is is not immediate. The error is always in one of the oplist definition.

Examples of typical errors:

lack of inclusion of an header,
overriding locally operator names by macros (like NEW, DEL, INIT, OPLIST, ...),
lack of ( ) or double level of ( ) around the oplist,
an unknown variable (example using DEFAULT_OPLIST instead of M_DEFAULT_OPLIST or M_STRING_OPLIST instead of STRING_OPLIST),
the name given to the oplist is not the same as the one used to define the methods,
use of a type instead of an oplist in the OPLIST definition,
a missing sub oplist in the OPLIST definition.

A good way to avoid theses errors is to register the oplist globally as soon as you define the container.

In case of difficulties, debugging can be done by generating the preprocessed file (by usually calling the compiler with the '-E' option instead of '-c') and check what's wrong in the preprocessed file:

      cc -std=c99 -E test-file.c > test-file.i
      perl -pi -e 's/;/;\n/g' test-file.i
      cc -std=c99 -c -Wall test-file.i

If there is a warning reported by the compiler in the generated code, then there is definitely an error you should fix (except if it reports shadowed variables), in particular cast evolving pointers.

Benchmarks

All bench codes are available in the bench directory. The results are available in a separate page.

External Reference

Many other implementation of generic container libraries in C exist. For example:

Each can be classified into one of the following concept:

Each object is handled through a pointer to void (with potential registered callbacks to handle the contained objects for the specialized methods). From a user point of view, this makes the code harder to use (as you don't have any help from the compiler) and type unsafe with a lot of cast (so no formal proof of the code is possible). This also generally generate slower code (even if using link time optimization, this penalty can be reduced). Properly used, it can yet be the most space efficient for the code, but can consume a lot more for the data due to the obligation of using pointers. This is however the easiest to design & code.
Macros are used to access structures in a generic way (using known fields of a structure - typically size, number, etc.). From a user point of view, this can create subtitle bug in the use of the library (as everything is done through macro expansion in the user defined code) or hard to understand warnings. This can generates fully efficient code. From a library developer point of view, this can be quite limiting in what you can offer.
A known structure is put in an intrusive way in the type of all the objects you wan to handle. From a user point of view, he needs to modify its structure and has to perform all the allocation & deallocation code itself (which is good or bad depending on the context). This can generate efficient code (both in speed and size). From a library developer point of view, this is easy to design & code. You need internally a cast to go from a pointer to the known structure to the pointed object (a reverse of offsetof) that is generally type unsafe (except if mixed with the macro generating concept). This is quite limitation in what you can do: you can't move your objects so any container that has to move some objects is out-of-question (which means that you cannot use the most efficient container).
Header files are included multiple times with different contexts (some different values given to defined macros) in order to generate different code for each type. From a user point of view, this creates a new step before using the container: an instantiating stage that has to be done once per type and per compilation unit (The user is responsible to create only one instance of the container, which can be troublesome if the library doesn't handle proper prefix for its naming convention). The debug of the library is generally easy and can generate fully specialized & efficient code. Incorrectly used, this can generate a lot of code bloat. Properly used, this can even create smaller code than the void pointer variant. The interface used to configure the library can be quite tiresome in case of a lot of specialized methods to configure: it doesn't enable to chain the configuration from a container to another one easily. It also cannot have heavy customization of the code.
Macros are used to generate context-dependent C code enabling to generate code for different type. This is pretty much like the headers solution but with added flexibility. From a user point of view, this creates a new step before using the container: an instantiating stage that has to be done once per type and per compilation unit (The user is responsible to create only one instance of the container, which can be troublesome if the library doesn't handle proper prefix for its naming convention). This can generate fully specialized & efficient code. Incorrectly used, this can generate a lot of code bloat. Properly used, this can even create smaller code than the void pointer variant. From a library developer point of view, the library is harder to design and to debug: everything being expanded in one line, you can't step in the library (there is however a solution to overcome this limitation by adding another stage to the compilation process). You can however see the generated code by looking at the preprocessed file. You can perform heavy context-dependent customization of the code (transforming the macro preprocessing step into its own language). Properly done, you can also chain the methods from a container to another one easily, enabling expansion of the library. Errors within the macro expansion are generally hard to decipher, but errors in code using containers are easy to read and natural.

M*LIB's category is mainly the last one. Some macros are also defined to access structure in a generic way, but they are optional. There are also intrusive containers.

M*LIB main added value compared to other libraries is its oplist feature enabling it to chain the containers and/or use complex types in containers: list of array of dictionary of C++ objects are perfectly supported by M*LIB.

For the macro-preprocessing part, other libraries also exist. For example:

For the string library, there is for example:

The Better String Library with a page that lists a lot of other string libraries.
VSTR with a page that lists a lot of other string libraries.
SDS
STC - C99 Standard Container library

API Documentation

The M*LIB reference card is available here.

M-LIST

This header is for creating singly linked list.

A linked list is a linear collection of elements, in which each element points to the next, all representing a sequence.

LIST_DEF(name, type, [, oplist])

Define the singly linked list named 'name##_t' that contains objects of type 'type' and the associated methods as "static inline" functions. 'name' shall be a C identifier that will be used to identify the list. It will be used to create all the types and functions to handle the container. This definition shall be done once per name and per compilation unit. It also define the iterator name##_it_t and its associated methods as "static inline" functions.

A fundamental property of a list is that the objects created within the list will remain at their initialized address, and won't moved due to operations done on the list (except if it is removed).

The type oplist is expected to have at least the following operators (INIT_SET, SET and CLEAR). If there is no given oplist, the default oplist for standard C type is used or a globally registered oplist is used if there is one available. The created methods use the operators to init, set and clear the contained object.

For this structure, the back is always the first element, and the front is the last element: the list grows from the back.

Example:

    LIST_DEF(list_uint, unsigned int)

    list_uint_t list_of_integer;

    void fi(unsigned int z) {
            list_uint_push_back (list_of_integer, z);
    }
    
    LIST_DEF(list_mpz, mpz_t,                                               \
            (INIT(mpz_init), INIT_SET(mpz_init_set), SET(mpz_set), CLEAR(mpz_clear)))

    list_mpz_t my_list;

    void fz(mpz_t z) {
            list_mpz_push_back (my_list, z);
    }

If the given oplist contain the method MEMPOOL, then LIST_DEF macro will create a dedicated mempool that is named with the given value of the method MEMPOOL. This mempool (see mempool chapter) is optimized for this kind of list:

it creates a mempool named by the concatenation of "name" and "_mempool",
it creates a variable named by the value of the method MEMPOOL with the linkage defined by the value of the method MEMPOOL_LINKAGE (can be extern, static or none). This variable is shared by all lists of the same type.
it links the memory allocation of the list to use this mempool with this variable.

mempool create heavily efficient list. However it is only worth the effort in some heavy performance context. The created mempool has to be explicitly initialized before using any methods of the created list by calling mempool_list_name_init(variable) and cleared by calling mempool_list_name_clear(variable).

Example:

    LIST_DEF(list_uint, unsigned int, (MEMPOOL(list_mpool), MEMPOOL_LINKAGE(static)))

    static void test_list (size_t n)
    {
      list_uint_mempool_init(list_mpool);
      M_LET(a1, LIST_OPLIST(uint)) {
          for(size_t i = 0; i < n; i++)
              list_uint_push_back(a1, rand_get() );
      }
      list_uint_mempool_clear(list_mpool);
    }

LIST_DEF_AS(name, name_t, name_it_t, type, [, oplist])

Same as LIST_DEF except the name of the types name_t, name_it_t are provided.

LIST_OPLIST(name [, oplist])

Return the oplist of the list defined by calling LIST_DEF & LIST_DUAL_PUSH_DEF with name & oplist. If there is no given oplist, the default oplist for standard C type is used.

Created methods

In the following methods, name stands for the name given to the macro that is used to identify the type. The following types are automatically defined by the previous definition macro:

name_t

Type of the list of 'type'.

name_it_t

Type of an iterator over this list.

The following methods are automatically created by the previous definition macro:

void name_init(name_t list)

Initialize the list 'list' (aka constructor) to an empty list.

void name_init_set(name_t list, const name_t ref)

Initialize the list 'list' (aka constructor) and set it to a copy of 'ref'.

void name_set(name_t list, const name_t ref)

Set the list 'list' to the a copy of 'ref'.

void name_init_move(name_t list, name_t ref)

Initialize the list 'list' (aka constructor) by stealing as many resources from 'ref' as possible. After-wise 'ref' is cleared and can no longer be used.

void name_move(name_t list, name_t ref)

Set the list 'list' (aka constructor) by stealing as many resources from 'ref' as possible. After-wise 'ref' is cleared and can no longer be used.

void name_clear(name_t list)

Clear the list 'list (aka destructor), calling the CLEAR method of all the objects of the list and freeing memory. The list can't be used anymore, except with a constructor.

void name_clean(name_t list)

Clean the list (the list becomes empty). It is like CLEAR but the list remains initialized and empty.

const type *name_back(const name_t list)

Return a constant pointer to the data stored in the back of the list.

void name_push_back(name_t list, const type value)

Push a new element within the list 'list' with the value 'value' contained within.

type *name_push_raw(name_t list)

Push a new element within the list 'list' without initializing it and returns a pointer to the non-initialized data. The first thing to do after calling this function is to initialize the data using the proper constructor. This enables using more specialized constructor than the generic one. Return a pointer to the non-initialized data.

type *name_push_new(name_t list)

Push a new element within the list 'list' and initialize it with the default constructor of the type. Return a pointer to the initialized object. This method is only defined if the type of the element defines an INIT method.

void name_push_move(name_t list, type *value)

Push a new element within the list 'list' with the value '*value' contained within by stealing as much resources from '*value' than possible. Afterward '*value' is cleared and cannot longer be used.

void name_pop_back(type *data, name_t list)

Pop a element from the list 'list', and set *data to this value if data is not the NULL pointer (otherwise only pop the data).

void name_pop_move(type *data, name_t list)

Pop a element from the list 'list', and initialize and set *data to this value by stealing as much resources from the list as possible. data cannot be a NULL pointer.

bool name_empty_p(const name_t list)

Return true if the list is empty, false otherwise.

void name_swap(name_t list1, name_t list2)

Swap the list 'list1' and 'list2'.

void name_it(name_it_t it, const name_t list)

Set the iterator 'it' to the back(=first) element of 'list'. There is no destructor associated to this initialization.

void name_it_set(name_it_t it, const name_it_t ref)

Set the iterator 'it' to the iterator 'ref'. There is no destructor associated to this initialization.

void name_it_end(name_it_t it, const name_t list)

Set the iterator 'it' to a non valid element of the list. There is no destructor associated to this initialization.

bool name_end_p(const name_it_t it)

Return true if the iterator doesn't reference a valid element anymore.

bool name_last_p(const name_it_t it)

Return true if the iterator references the top(=last) element or if the iterator doesn't reference a valid element anymore.

bool name_it_equal_p(const name_it_t it1, const name_it_t it2)

Return true if the iterator it1 references the same element than it2.

void name_next(name_it_t it)

Move the iterator 'it' to the next element of the list, i.e. from the back (=first) element to the front (=last) element.

type *name_ref(name_it_t it)

Return a pointer to the element pointed by the iterator. This pointer remains valid until the element is destroyed in the list.

const type *name_cref(const name_it_t it)

Return a constant pointer to the element pointed by the iterator. This pointer remains valid until the element is destroyed in the list.

type *name_get(const name_t list, size_t i)

Return a pointer to the element i-th of the list (from 0). It is assumed than i is within the size of the list. This function is slow and iterates linearly over the element of the elements until it reaches the desired element.

const type *name_cget(const name_t list, size_t i)

Return a constant pointer to the element i-th of the list (from 0). It is assumed than i is within the size of the list. This function is slow and iterates linearly over the element of the elements until it reaches the desired element.

size_t name_size(const name_t list)

Return the number elements of the list (aka size). Return 0 if there no element. This function is slow and iterates linearly over all the element to compute the size.

void name_insert(name_t list, const name_it_t it, const type x)

Insert 'x' after the position pointed by 'it' (which is an iterator of the list 'list') or if 'it' doesn't point anymore to a valid element of the list, it is added as the back (=first) element of the 'list'

void name_remove(name_t list, name_it_t it)

Remove the element 'it' from the list 'list'. After wise, 'it' points to the next element of the list.

void name_splice_back(name_t list1, name_t list2, name_it_t it)

Move the element pointed by 'it' (which is an iterator of 'list2') from the list 'list2' to the back position of 'list1'. After wise, 'it' points to the next element of 'list2'.

void name_splice_at(name_t list1, name_it_t it1, name_t list2, name_it_t it2)

Move the element pointed by 'it2' (which is an iterator of 'list2') from the list 'list2' to the position just after 'it1' in the list 'list1'. After wise, 'it2' points to the next element of 'list2' and 'it1' points to the inserted element in 'list1'. If 'it1' is the end position, it inserts it at the back (just like _insert_at).

void name_splice(name_t list1, name_t list2)

Move all the element of 'list2' into 'list1", moving the last element of 'list2' after the first element of 'list1'. After-wise, 'list2' remains initialized but is emptied.

void name_reverse(name_t list)

Reverse the order of the list.

void name_get_str(string_t str, const name_t list, bool append)

Set 'str' to the formatted string representation of the list 'list' (if 'append' is false) or append 'str' with this representation (if 'append' is true). This method is only defined if the type of the element defines a GET_STR method itself.

bool name_parse_str(name_t list, const char str[], const char **endp)

Parse the formatted string 'str', that is assumed to be a string representation of a list and set 'list' to this representation. This method is only defined if the type of the element defines a PARSE_STR & INIT methods itself. It returns true if success, false otherwise. If endp is not NULL, it sets '*endp' to the pointer of the first character not decoded by the function.

void name_out_str(FILE *file, const name_t list)

Generate a formatted string representation of the list 'list' and outputs it into the FILE 'file'. This method is only defined if the type of the element defines a OUT_STR method itself.

void name_in_str(name_t list, FILE *file)

Read from the file 'file' a formatted string representation of a list and set 'list' to this representation. This method is only defined if the type of the element defines a IN_STR & INIT method itself.

bool name_equal_p(const name_t list1, const name_t list2)

Return true if both lists 'list1' and 'list2' are equal. This method is only defined if the type of the element defines a EQUAL method itself.

size_t name_hash(const name_t list)

Return a hash value of 'list'. This method is only defined if the type of the element defines a HASH method itself.

LIST_DUAL_PUSH_DEF(name, type[, oplist])

Define the singly linked list named 'name##_t' that contains the objects of type 'type' and the associated methods as "static inline" functions. 'name' shall be a C identifier that will be used to identify the list. It will be used to create all the types and functions to handle the container. It shall be done once per type and per compilation unit. It also define the iterator name##_it_t and its associated methods as "static inline" functions too.

The only difference with the list defined by LIST_DEF is the support of the method PUSH_FRONT in addition to PUSH_BACK (therefore the DUAL PUSH name). There is still only POP method (POP_BACK). The head of the list is a bit bigger to be able to handle such methods to work. This enables this list to be able to represent both stack (PUSH_BACK + POP_BACK) and queue (PUSH_FRONT + POP_BACK).

A fundamental property of a list is that the objects created within the list will remain at their initialized address, and won't moved due to operations on the list.

The object oplist is expected to have at least the following operators (INIT_SET, SET and CLEAR). If there is no given oplist, the default oplist for standard C type is used or a globally registered oplist is used. The created methods will use the operators to init, set and clear the contained object.

For this structure, the back is always the first element, and the front is the last element.

Example:

    LIST_DUAL\_PUSH\_DEF(list_mpz, mpz_t,                                   \
            (INIT(mpz_init), INIT_SET(mpz_init_set), SET(mpz_set), CLEAR(mpz_clear)))

    list_mpz_t my_list;

    void f(mpz_t z) {
            list_mpz_push_front (my_list, z);
            list_mpz_pop_back (z, my_list);
    }

If the given oplist contain the method MEMPOOL, then macro will create a dedicated mempool that is named with the given value of the method MEMPOOL, optimized for this kind of list:

it creates a mempool named by the concatenation of "name" and "_mempool",
it creates a variable named by the value of the method MEMPOOL with linkage defined by the value of the method MEMPOOL_LINKAGE (can be extern, static or none), this variable will be shared by all lists of the same type.
it overwrites memory allocation of the created list to use this mempool with this variable.

mempool creates heavily efficient list but it will be only worth the effort in some heavy performance context. The created mempool has to be initialized before using any methods of the created list by calling mempool_list_name_init(variable) and cleared by calling mempool_list_name_clear(variable).

The methods follow closely the methods defined by LIST_DEF.

LIST_DUAL_PUSH_DEF_AS(name, name_t, name_it_t, type, [, oplist])

Same as LIST_DUAL_PUSH_DEF except the name of the types name_t, name_it_t are provided.

Created methods

In the following methods, name stands for the name given to the macro that is used to identify the type. The following types are automatically defined by the previous macro:

name_t

Type of the list of 'type'.

name_it_t

Type of an iterator over this list.

The following methods are automatically and properly created by the previous macro.

void name_init(name_t list)

Initialize the list 'list' (aka constructor) to an empty list.

void name_init_set(name_t list, const name_t ref)

Initialize the list 'list' (aka constructor) and set it to the value of 'ref'.

void name_set(name_t list, const name_t ref)

Set the list 'list' to the value of 'ref'.

void name_init_move(name_t list, name_t ref)

Initialize the list 'list' (aka constructor) by stealing as many resources from 'ref' as possible. After-wise 'ref' is cleared and can no longer be used.

void name_move(name_t list, name_t ref)

Set the list 'list' (aka constructor) by stealing as many resources from 'ref' as possible. After-wise 'ref' is cleared and can no longer be used.

void name_clear(name_t list)

Clear the list 'list (aka destructor). The list can't be used anymore, except with a constructor.

void name_clean(name_t list)

Clean the list (the list becomes empty). The list remains initialized but is empty.

const type *name_back(const name_t list)

Return a constant pointer to the data stored in the back of the list.

void name_push_back(name_t list, type value)

Push a new element within the list 'list' with the value 'value' into the back of the list.

type *name_push_back_raw(name_t list)

Push a new element within the list 'list' without initializing it into the back of the list and returns a pointer to the non-initialized data. The first thing to do after calling this function is to initialize the data using the proper constructor. This enables to use a more specialized constructor than the generic one. Return a pointer to the non-initialized data.

type *name_push_back_new(name_t list)

Push a new element within the list 'list' into the back of the list and initialize it with the default constructor of the type. Return a pointer to the initialized object. This method is only defined if the type of the element defines an INIT method.

void name_push_back_move(name_t list, type *value)

Push a new element within the list 'list' with the value '*value' ,by stealing as much resources from '*value' as possible, into the back of the list. Afterwards, *value is cleared and cannot be used anymore. value cannot be NULL.

const type *name_front(const name_t list)

Return a constant pointer to the data stored in the front of the list.

void name_push_front(name_t list, type value)

Push a new element within the list 'list' with the value 'value' contained within into the front of the list.

type *name_push_front_raw(name_t list)

Push a new element within the list 'list' without initializing it into the front of the list and returns a pointer to the non-initialized data. The first thing to do after calling this function is to initialize the data using the proper constructor. This enables to use a more specialized constructor than the generic one. Return a pointer to the non-initialized data.

type *name_push_front_new(name_t list)

Push a new element within the list 'list' into the front of the list and initialize it with the default constructor of the type. Return a pointer to the initialized object. This method is only defined if the type of the element defines an INIT method.

void name_push_front_move(name_t list, type *value)

Push a new element within the list 'list' with the value '*value' ,by stealing as much resources from '*value' as possible, into the front of the list. Afterwards, *value is cleared and cannot be used anymore. value cannot be NULL.

void name_pop_back(type *data, name_t list)

Pop a element from the list 'list' and set *data to this value if data is not NULL.

void name_pop_move(type *data, name_t list)

Pop a element from the list 'list' and initialize and set *data to this value, stealing as much resources from the list as possible.

bool name_empty_p(const name_t list)

Return true if the list is empty, false otherwise.

void name_swap(name_t list1, name_t list2)

Swap the list 'list1' and 'list2'.

void name_it(name_it_t it, name_t list)

Set the iterator 'it' to the back(=first) element of 'list'. There is no destructor associated to this initialization.

void name_it_set(name_it_t it, const name_it_t ref)

Set the iterator 'it' to the iterator 'ref'. There is no destructor associated to this initialization.

void name_it_end(name_it_t it, const name_t list)

Set the iterator 'it' to an invalid reference of 'list'. There is no destructor associated to this initialization.

bool name_end_p(const name_it_t it)

Return true if the iterator doesn't reference a valid element anymore.

bool name_last_p(const name_it_t it)

Return true if the iterator references the top(=last) element or if the iterator doesn't reference a valid element anymore.

bool name_it_equal_p(const name_it_t it1, const name_it_t it2)

Return true if the iterator it1 references the same element than it2.

void name_next(name_it_t it)

Move the iterator 'it' to the next element of the list, ie. from the back (=first) element to the front(=last) element.

type *name_ref(name_it_t it)

Return a pointer to the element pointed by the iterator. This pointer remains valid until the object is destroyed.

const type *name_cref(const name_it_t it)

Return a constant pointer to the element pointed by the iterator. This pointer remains valid until the object is destroyed.

size_t name_size(const name_t list)

Compute and return the number elements of the list (aka size). Return 0 if there no element.

void name_insert(name_t list, const name_it_t it, const type x)

void name_remove(name_t list, name_it_t it)

Remove the element 'it' from the list 'list'. After wise, 'it' points to the next element of the list.

void name_splice_back(name_t list1, name_t list2, name_it_t it)

Move the element pointed by 'it' (which is an iterator of 'list2') from the list 'list2' to the back position of 'list1'. After wise, 'it' points to the next element of 'list2'.

void name_splice(name_t list1, name_t list2)

Move all the element of 'list2' into 'list1", moving the last element of 'list2' after the first element of 'list1'. After-wise, 'list2' is emptied.

void name_reverse(name_t list)

Reverse the order of the list.

void name_get_str(string_t str, const name_t list, bool append)

Generate a formatted string representation of the list 'list' and set 'str' to this representation (if 'append' is false) or append 'str' with this representation (if 'append' is true). This method is only defined if the type of the element defines a GET_STR method itself.

bool name_parse_str(name_t list, const char str[], const char **endp)

Parse the formatted string 'str' that is assumed to be a string representation of a list and set 'list' to this representation. This method is only defined if the type of the element defines PARSE_STR & INIT methods itself. It returns true if success, false otherwise. If endp is not NULL, it sets '*endp' to the pointer of the first character not decoded by the function.

void name_out_str(FILE *file, const name_t list)

Generate a formatted string representation of the list 'list' and outputs it into the FILE 'file'. This method is only defined if the type of the element defines a OUT_STR method itself.

void name_in_str(name_t list, FILE *file)

bool name_equal_p(const name_t list1, const name_t list2)

Return true if both lists 'list1' and 'list2' are equal. This method is only defined if the type of the element defines a EQUAL method itself.

size_t name_hash(const name_t list)

Return a hash value of 'list'. This method is only defined if the type of the element defines a HASH method itself.

M-ARRAY

An array is a growable collection of element that are individually indexable.

ARRAY_DEF(name, type [, oplist])

Define the array 'name##_t' that contains the objects of type 'type' and its associated methods as "static inline" functions. Compared to C arrays, the created methods handle automatically the size (aka growable array). 'name' shall be a C identifier that will be used to identify the container.

It also define the iterator name##_it_t and its associated methods as "static inline" functions.

The object oplist is expected to have at least the following operators (CLEAR), and usually (INIT, INIT_SET, SET and CLEAR) otherwise default operators are used. If there is no given oplist, the default oplist for standard C type is used or a globally registered oplist is used. The created methods will use the operators to init-and-set, set and clear the contained object.

Example:

    ARRAY_DEF(array_mpfr_t, mpfr,                                                                  \
       (INIT(mpfr_init), INIT_SET(mpfr_init_set), SET(mpfr_set), CLEAR(mpfr_clear)))

    array_mpfr_t my_array;

    void f(mpfr_t z) {
            array_mpfr_push_back (my_array, z);
    }

ARRAY_DEF_AS(name, name_t, name_it_t, type, [, oplist])

Same as ARRAY_DEF except the name of the types name_t, name_it_t are provided.

ARRAY_OPLIST(name [, oplist])

Return the oplist of the array defined by calling ARRAY_DEF with name & oplist. If there is no given oplist, the default oplist for standard C type is used.

Created methods

In the following methods, name stands for the name given to the macro. This is used to identify the type. The following types are automatically defined by the previous macro:

name_t

Type of the array of 'type'.

name_it_t

Type of an iterator over this array.

The following methods are automatically and properly created by the previous macros:

void name_init(name_t array)

Initialize the array 'array' (aka constructor) to an empty array.

void name_init_set(name_t array, const name_t ref)

Initialize the array 'array' (aka constructor) and set it to the value of 'ref'. This method is created if the INIT_SET & SET operators are provided.

void name_set(name_t array, const name_t ref)

Set the array 'array' to the value of 'ref'. This method is created if the INIT_SET & SET operators are provided.

void name_init_move(name_t array, name_t ref)

Initialize the array 'array' (aka constructor) by stealing as many resources from 'ref' as possible. After-wise 'ref' is cleared.

void name_move(name_t array, name_t ref)

Set the array 'array' by stealing as many resources from 'ref' as possible. After-wise 'ref' is cleared.

void name_clear(name_t array)

Clear the array 'array (aka destructor).

void name_clean(name_t array)

Clean the array (the array becomes empty but remains initialized).

type *name_push_raw(name_t array)

Push the needed storage of a new element into the back of the array 'array' without initializing it and return a pointer to the non-initialized data. The first thing to do after calling this function is to initialize the data using the proper constructor. This enables to use a more specialized constructor than the generic one. It is recommended to use other _push function if possible rather than this one as it is low level and error prone.

void name_push_back(name_t array, const type value)

Push a new element into the back of the array 'array' with the value 'value' contained within. This method is created if the INIT_SET operator is provided.

type *name_push_new(name_t array)

Push a new element into the back of the array 'array' and initialize it with the default constructor. Return a pointer to this created element. This method is only defined if the type of the element defines an INIT method.

void name_push_move(name_t array, type *val)

Push '*val' a new element into the back of the array 'array' by stealing as much resources as possible from '*val'. After-wise '*x' is cleared. This method is created if the INIT_SET or INIT_MOVE operator is provided.

void name_push_at(name_t array, size_t key, const type x)

Push a new element into the position 'key' of the array 'array' with the value 'value' contained within. 'key' shall be a valid position of the array: from 0 to the size of array (included). This method is created if the INIT_SET operator is provided.

void name_pop_back(type *data, name_t array)

Pop a element from the back of the array 'array' and set *data to this value if data is not NULL (if data is NULL, the popped data is cleared). This method is created if the SET or INIT_MOVE operator is provided.

void name_pop_move(type *data, name_t array)

Pop a element from the back of the array 'array' and initialize *data with this value by stealing as much from the array as possible. This method is created if the INIT_SET or INIT_MOVE operator is provided.

void name_pop_until(name_t array, array_it_t position)

Pop all elements of the array 'array' from 'position' to the back of the array, clearing them. This method is only defined if the type of the element defines an INIT method.

void name_pop_at(type *dest, name_t array, size_t key)

Set *dest to the value the element 'key' if dest is not NULL, then remove the element 'key' from the array. 'key' shall be within the size of the array. This method is created if the SET or INIT_MOVE operator is provided.

const type *name_front(const name_t array)

Return a constant pointer to the first element of the array.

const type *name_back(const name_t array)

Return a constant pointer to the last element of the array.

void name_set_at(name_t array, size_t i, type value)

Set the element 'i' of array 'array' to 'value'. 'i' shall be within 0 to the size of the array (excluded). This method is created if the INIT_SET operator is provided.

type *name_get(name_t array, size_t i)

Return a pointer to the element 'i' of the array. 'i' shall be within 0 to the size of the array (excluded). The returned pointer cannot be NULL. This pointer remains valid until the array is modified by another method.

const type *name_cget(const name_t it, size_t i)

Return a constant pointer to the element 'i' of the array. 'i' shall be within 0 to the size of the array (excluded). The returned pointer cannot be NULL. This pointer remains valid until the array is modified by another method.

type *name_get_at(name_t array, size_t i)

Return a pointer to the element 'i' of array 'array', by increasing the size of the array if needed (creating new elements with INIT). The returned pointer cannot be NULL. This method is only defined if the type of the element defines an INIT method. This pointer remains valid until the array is modified by another method.

bool name_empty_p(const name_t array)

Return true if the array is empty, false otherwise.

size_t name_size(const name_t array)

Return the size of the array.

size_t name_capacity(const name_t array)

Return the capacity of the array.

void name_resize(name_t array, size_t size)

Resize the array 'array' to the size 'size' (initializing or clearing elements). This method is only defined if the type of the element defines an INIT method.

void name_reserve(name_t array, size_t capacity)

Extend or reduce the capacity of the 'array' to a rounded value based on 'capacity'. If the given capacity is below the current size of the array, the capacity is set to the size of the array.

void name_remove(name_t array, name_it_t it)

Remove the element pointed by the iterator 'it' from the array 'array'. 'it' shall be a valid iterator. Afterward 'it' points to the next element, or points to the end. This method is created if the SET or INIT_MOVE operator is provided.

void name_remove_v(name_t array, size_t i, size_t j)

Remove the element 'i' (included) to the element 'j' (excluded) from the array. 'i' and 'j' shall be within the size of the array, and i < j.

void name_insert(name_t array, name_it_t it, const type x)

Insert the object 'x' at the position 'it' of the array. 'it' shall be a valid iterator of the array. This method is created if the INIT_SET operator is provided.

void name_insert_v(name_t array, size_t i, size_t j)

Insert from the element 'i' (included) to the element 'j' (excluded) new empty elements to the array. 'i' and 'j' shall be within the size of the array, and i < j. This method is only defined if the type of the element defines an INIT method.

void name_swap(name_t array1, name_t array2)

Swap the array 'array1' and 'array2'.

void name_swap_at(name_t array, size_t i, size_t j)

Swap the elements 'i' and 'j' of the array 'array'. 'i' and 'j' shall reference valid elements of the array. This method is created if the INIT_SET or INIT_MOVE operator is provided.

void name_it(name_it_t it, name_t array)

Set the iterator 'it' to the first element of 'array'.

void name_it_last(name_it_t it, name_t array)

Set the iterator 'it' to the last element of 'array'.

void name_it_end(name_it_t it, name_t array)

Set the iterator 'it' to the end of 'array'.

void name_it_set(name_it_t it1, name_it_t it2)

Set the iterator 'it1' to 'it2'.

bool name_end_p(name_it_t it)

Return true if the iterator doesn't reference a valid element anymore.

bool name_last_p(name_it_t it)

Return true if the iterator references the last element of the array, or doesn't reference a valid element.

bool name_it_equal_p(const name_it_t it1, const name_it_t it2)

Return true if both iterators reference the same element.

void name_next(name_it_t it)

Move the iterator 'it' to the next element of the array.

void name_previous(name_it_t it)

Move the iterator 'it' to the previous element of the array.

type *name_ref(name_it_t it)

Return a pointer to the element pointed by the iterator. This pointer remains valid until the array is modified by another method.

const type *name_cref(const name_it_t it)

Return a constant pointer to the element pointed by the iterator. This pointer remains valid until the array is modified by another method.

void name_special_sort(name_t array)

Sort the array 'array'. This method is defined if the type of the element defines CMP method. This method uses the qsort function of the C library.

void name_special_stable_sort(name_t array)

Sort the array 'array' using a stable sort. This method is defined if the type of the element defines CMP and SWAP and SET methods. This method provides an ad-hoc implementation of the stable sort. In practice, it is faster than the _sort method for small types and fast comparisons.

void name_get_str(string_t str, const name_t array, bool append)

Generate a formatted string representation of the array 'array' and set 'str' to this representation (if 'append' is false) or append 'str' with this representation (if 'append' is true). This method is only defined if the type of the element defines a GET_STR method itself.

bool name_parse_str(name_t array, const char str[], const char **endp)

Parse the formatted string 'str' that is assumed to be a string representation of an array and set 'array' to this representation. This method is only defined if the type of the element defines both PARSE_STR & INIT methods itself. It returns true if success, false otherwise. If endp is not NULL, it sets '*endp' to the pointer of the first character not decoded by the function.

void name_out_str(FILE *file, const name_t array)

Generate a formatted string representation of the array 'array' and outputs it into the FILE 'file'. This method is only defined if the type of the element defines a OUT_STR method itself.

void name_in_str(name_t array, FILE *file)

Read from the file 'file' a formatted string representation of an array and set 'array' to this representation. This method is only defined if the type of the element defines both IN_STR & INIT methods itself.

bool name_equal_p(const name_t array1, const name_t array2)

Return true if both arrays 'array1' and 'array2' are equal. This method is only defined if the type of the element defines a EQUAL method itself.

size_t name_hash(const name_t array)

Return an hash value of 'array'. This method is only defined if the type of the element defines a HASH method itself.

void name_splice(name_t array1, name_t array2)

Merge the elements of 'array2' in 'array1' at its end. Afterwards, 'array2' is empty.

M-DEQUE

This header is for creating double-ended queue (or deque). A deque is an abstract data type that generalizes a queue, for that elements can be added to or removed from either the front (head) or back (tail)

DEQUE_DEF(name, type, [, oplist])

Define the deque 'name##_t' that contains the objects of type 'type' and its associated methods as "static inline" functions. 'name' shall be a C identifier that will be used to identify the deque. It will be used to create all the types and functions to handle the container. It shall be done once per type and per compilation unit. It also define the iterator name##_it_t and its associated methods as "static inline" functions.

The object oplist is expected to have at least the following operators (INIT, INIT_SET, SET and CLEAR), otherwise default operators are used. If there is no given oplist, the default oplist for standard C type is used or a globally registered oplist is used. The created methods will use the operators to init, set and clear the contained object.

Example:

    DEQUE_DEF(deque_mpz, mpz_t,                                               \
            (INIT(mpz_init), INIT_SET(mpz_init_set), SET(mpz_set), CLEAR(mpz_clear)))

    deque_mpz_t my_deque;

    void f(mpz_t z) {
            deque_mpz_push_back (my_deque, z);
    }

DEQUE_DEF_AS(name, name_t, name_it_t, type, [, oplist])

Same as DEQUE_DEF except the name of the types name_t, name_it_t are provided.

DEQUE_OPLIST(name [, oplist])

Return the oplist of the deque defined by calling DEQUE_DEF with name & oplist.

Created methods

In the following methods, name stands for the name given to the macro that is used to identify the type. The following types are automatically defined by the previous macro:

name_t

Type of the deque of 'type'.

name_it_t

Type of an iterator over this deque.

The following methods are automatically and properly created by the previous macro.

void name_init(name_t deque)

Initialize the deque 'deque' (aka constructor) to an empty deque.

void name_init_set(name_t deque, const name_t ref)

Initialize the deque 'deque' (aka constructor) and set it to the value of 'ref'.

void name_set(name_t deque, const name_t ref)

Set the deque 'deque' to the value of 'ref'.

void name_init_move(name_t deque, name_t ref)

Initialize the deque 'deque' (aka constructor) by stealing as many resources from 'ref' as possible. After-wise 'ref' is cleared and can no longer be used.

void name_move(name_t deque, name_t ref)

Set the deque 'deque' (aka constructor) by stealing as many resources from 'ref' as possible. After-wise 'ref' is cleared and can no longer be used.

void name_clear(name_t deque)

Clear the deque 'deque (aka destructor). The deque can't be used anymore, except with a constructor.

void name_clean(name_t deque)

Clean the deque (the deque becomes empty). The deque remains initialized but is empty.

const type *name_back(const name_t deque)

Return a constant pointer to the data stored in the back of the deque.

void name_push_back(name_t deque, type value)

Push a new element within the deque 'deque' with the value 'value' at the back of the deque.

type *name_push_back÷_raw(name_t deque)

Push at the back a new element within the deque 'deque' without initializing it and returns a pointer to the non-initialized data. The first thing to do after calling this function is to initialize the data using the proper constructor. This enables to use a more specialized constructor than the generic one. Return a pointer to the non-initialized data.

type *name_push_back_new(name_t deque)

Push at the back a new element within the deque 'deque' and initialize it with the default constructor of the type. Return a pointer to the initialized object.

void name_pop_back(type *data, name_t deque)

Pop a element from the deque 'deque' and set *data to this value. If data pointer is NULL, then the popped value is discarded.

const type *name_front(const name_t deque)

Return a constant pointer to the data stored in the front of the deque.

void name_push_front(name_t deque, type value)

Push at the front a new element within the deque 'deque' with the value 'value'.

type *name_push_front_raw(name_t deque)

Push at the front a new element within the deque 'deque' without initializing it and returns a pointer to the non-initialized data. The first thing to do after calling this function is to initialize the data using the proper constructor. This enables to use a more specialized constructor than the generic one. Return a pointer to the non-initialized data.

type *name_push_front_new(name_t deque)

Push at the front a new element within the deque 'deque' and initialize it with the default constructor of the type. Return a pointer to the initialized object.

void name_pop_front(type *data, name_t deque)

Pop a element from the deque 'deque' and set *data to this value. If data pointer is NULL, then the pop-ed value is discarded.

bool name_empty_p(const name_t deque)

Return true if the deque is empty, false otherwise.

void name_swap(name_t deque1, name_t deque2)

Swap the deque 'deque1' and 'deque2'.

void name_it(name_it_t it, name_t deque)

Set the iterator 'it' to the first element of 'deque' (aka the front). There is no destructor associated to this initialization.

void name_it_set(name_it_t it, const name_it_t ref)

Set the iterator 'it' to the iterator 'ref'. There is no destructor associated to this initialization.

bool name_end_p(const name_it_t it)

Return true if the iterator doesn't reference a valid element anymore.

bool name_last_p(const name_it_t it)

Return true if the iterator references the last element or if the iterator doesn't reference a valid element anymore.

bool name_it_equal_p(const name_it_t it1, const name_it_t it2)

Return true if the iterator it1 references the same element than it2.

void name_next(name_it_t it)

Move the iterator 'it' to the next element of the deque, ie. from the front element to the back element.

void name_previous(name_it_t it)

Move the iterator 'it' to the previous element of the deque, ie. from the back element to the front element.

type *name_ref(name_it_t it)

Return a pointer to the element pointed by the iterator. This pointer remains valid until the deque is modified by another method.

const type *name_cref(const name_it_t it)

Return a constant pointer to the element pointed by the iterator. This pointer remains valid until the deque is modified by another method.

type *name_get(const name_t deque, size_t i)

Return a pointer to the element i-th of the deque (from 0). It is assumed than i is within the size of the deque. The algorithm complexity is in O(ln(n))

const type *name_cget(const name_t deque, size_t i)

Return a constant pointer to the element i-th of the deque (from 0). It is assumed than i is within the size of the deque. The algorithm complexity is in O(ln(n))

size_t name_size(const name_t deque)

Return the number elements of the deque (aka size). Return 0 if there no element.

void name_get_str(string_t str, const name_t deque, bool append)

Generate a formatted string representation of the deque 'deque' and set 'str' to this representation (if 'append' is false) or append 'str' with this representation (if 'append' is true). This method is only defined if the type of the element defines a GET_STR method itself.

bool name_parse_str(name_t deque, const char str[], const char **endp)

Parse the formatted string 'str' that is assumed to be a string representation of a deque and set 'deque' to this representation. This method is only defined if the type of the element defines PARSE_STR & INIT methods itself. It returns true if success, false otherwise. If endp is not NULL, it sets '*endp' to the pointer of the first character not decoded by the function.

void name_out_str(FILE *file, const name_t deque)

Generate a formatted string representation of the deque 'deque' and outputs it into the FILE 'file'. This method is only defined if the type of the element defines a OUT_STR method itself.

void name_in_str(name_t deque, FILE *file)

Read from the file 'file' a formatted string representation of a deque and set 'deque' to this representation. This method is only defined if the type of the element defines a IN_STR method itself.

bool name_equal_p(const name_t deque1, const name_t deque2)

Return true if both deque 'deque1' and 'deque2' are equal. This method is only defined if the type of the element defines a EQUAL method itself.

size_t name_hash(const name_t deque)

Return a hash value of 'deque'. This method is only defined if the type of the element defines a HASH method itself.

void name_swap_at(name_t deque, size_t i, size_t j)

Swap the values within the deque pointed by 'i' and by 'j'. 'i' & 'j' shall be valid index within the deque. This method is only defined if the type of the element defines a SWAP method itself.

M-DICT

A dictionary (or associative array, map, symbol table) is an abstract data type composed of a collection of (key, value) pairs, such that each possible key appears at most once in the collection.

Several dictionaries are proposed. The "best" to use depends on the data type and in particular:

the size of the data,
the inner cost of copying the object,
the inner cost of computing the hash of the object,
the inner cost of comparing the objects,
the load factor.

For small, fast types (integer, or floats, or pair of such types), DICT_OA_DEF2 may be the best to use. For medium type, DICT_DEF2 with mempool activated may be better. For even larger object, DICT_STOREHASH_DEF2 may be better.

DICT_DEF2(name, key_type[, key_oplist], value_type[, value_oplist])

Define the dictionary 'name##_t' and its associated methods as "static inline" functions. 'name' shall be a C identifier that will be used to identify the container. Current implementation uses chained Hash-Table and as such, elements in the dictionary are unordered.

It shall be done once per type and per compilation unit. It also define the iterator name##_it_t and its associated methods as "static inline" functions.

The key_oplist shall also define the additional operators (HASH and EQUAL).

Example:

    DICT_DEF2(dict_str, string_t, STRING_OPLIST, string_t, STRING_OPLIST)
    dict_str_t my_dict;
    void f(string_t key, string_t value) {
            dict_str_set_at (my_dict, key, value);
    }

DICT_STOREHASH_DEF2(name, key_type[, key_oplist], value_type[, value_oplist])

Define the dictionary 'name##_t' and its associated methods as "static inline" functions just like DICT_DEF2.

The only difference is that it stores the hash of each key alongside the key in the dictionary. This enable the container to avoid recomputing it in some occasions resulting in faster dictionary if the hash is costly to compute, or slower otherwise.

DICT_OA_DEF2(name, key_type[, key_oplist], value_type[, value_oplist])

Define the dictionary 'name##_t' and its associated methods as "static inline" functions much like DICT_DEF2. The difference is that it uses an Open Addressing Hash-Table as container.

It shall be done once per type and per compilation unit. It also define the iterator name##_it_t and its associated methods as "static inline" functions.

The key_oplist shall also define the additional operators : HASH and EQUAL and OOR_EQUAL and OOR_SET

This implementation is in general faster for small types of keys (like integer) but slower for larger types.

Example:

    static inline bool oor_equal_p(int k, unsigned char n) {
      return k == (int)-n-1;
    }
    static inline void oor_set(int *k, unsigned char n) {
      *k = (int)-n-1;
    }

    DICT_OA_DEF2(dict_int, int, M_OPEXTEND(M_DEFAULT_OPLIST, OOR_EQUAL(oor_equal_p), OOR_SET(oor_set M_IPTR)), int64_t, M_DEFAULT_OPLIST)

    dict_int_t my_dict;
    void f(int key, int64_t value) {
            dict_int_set_at (my_dict, key, value);
    }

DICT_DEF2_AS(name, name_t, name_it_t, name_itref_t, key_type[, key_oplist], value_type[, value_oplist])

Same as DICT_DEF2 except the name of the types name_t, name_it_t, name_itref_t, are provided.

DICT_STOREHASH_DEF2_AS(name, name_t, name_it_t, name_itref_t, key_type[, key_oplist], value_type[, value_oplist])

Same as DICT_STOREHASH_DEF2 except the name of the types name_t, name_it_t, name_itref_t, are provided.

DICT_OA_DEF2_AS(name, name_t, name_it_t, name_itref_t, key_type[, key_oplist], value_type[, value_oplist])

Same as DICT_OA_DEF2 except the name of the types name_t, name_it_t, name_itref_t, are provided.

DICT_OPLIST(name[, key_oplist, value_oplist])

Return the oplist of the dictionary defined by calling DICT_DEF2 with name & key_oplist & value_oplist.

DICT_SET_DEF(name, key_type[, key_oplist])

Define the set 'name##_t' and its associated methods as "static inline" functions. A set is a specialized version of a dictionary with no value.

It shall be done once per type and per compilation unit. It also define the iterator name##_it_t and its associated methods as "static inline" functions.

The object oplist is expected to have at least the following operators (INIT, INIT_SET, SET, CLEAR, HASH and EQUAL), otherwise default operators are used. If there is no given oplist, the default oplist for standard C type is used or a globally registered oplist is used. The created methods will use the operators to init, set and clear the contained object.

Example:

    DICT_SET_DEF(dict_strSet, string_t)
    dict_strSet_t set;
    void f(string_t key) {
            dict_strSet_set_at (set, key);
    }

DICT_OASET_DEF(name, key_type[, key_oplist])

Define the set 'name##_t' and its associated methods as "static inline" functions. A set is a specialized version of a dictionary with no value. The difference is that it uses an Open Addressing Hash-Table as container.

It shall be done once per type and per compilation unit. It also define the iterator name##_it_t and its associated methods as "static inline" functions.

The key_oplist shall therefore define the additional operators : HASH and EQUAL and OOR_EQUAL and OOR_SET

This implementation is in general faster for small types of keys (like integer) but slower for larger types.

DICT_SET_DEF_AS(name, name_t, name_it_t, key_type[, key_oplist])

Same as DICT_SET_DEF except the name of the types name_t, name_it_t, are provided.

DICT_OASET_DEF_AS(name, name_t, name_it_t, key_type[, key_oplist])

Same as DICT_OASET_DEF except the name of the types name_t, name_it_t, are provided.

DICT_SET_OPLIST(name[, key_oplist])

Return the oplist of the set defined by calling DICT_SET_DEF (or DICT_OASET_DEF) with name & key_oplist.

Created methods

In the following methods, name stands for the name given to the macro that is used to identify the type. The following types/methods are automatically defined by the previous macro:

name_t

Type of the dictionary which either associate 'key_type' to 'value_type', or store element 'key_type'.

name_it_t

Type of an iterator over this dictionary.

name_itref_t

Type of one item referenced in the dictionary for associative array. It is a structure composed of the key (field 'key') and the value (field 'value').

This type is created only for associative arrays (_DEF2 suffix).

void name_init(name_t dict)

Initialize the dictionary 'dict' to be empty.

void name_clear(name_t dict)

Clear the dictionary 'dict'.

void name_init_set(name_t dict, const name_t ref)

Initialize the dictionary 'dict' to be the same as 'ref'.

void name_set(name_t dict, const name_t ref)

Set the dictionary 'dict' to be the same as 'ref'.

void name_init_move(name_t dict, name_t ref)

Initialize the dictionary 'dict' by stealing as resource as possible from 'ref' and clear 'ref'.

void name_move(name_t dict, name_t ref)

Set the dictionary 'dict' by stealing as resource as possible from 'ref' and clear 'ref'.

void name_clean(name_t dict)

Clean the dictionary 'dict'. 'dict' remains initialized.

size_t name_size(const name_t dict)

Return the number of elements of the dictionary.

value_type *name_get(const name_t dict, const key_type key)

Return a pointer to the value associated to the key 'key' in dictionary 'dict' or NULL if the key is not found.

void name_set_at(name_t dict, const key_type key, const value_type value)

Set the value referenced by key 'key' in the dictionary 'dict' to 'value'. This method is only defined for associative containers (no SET).

void name_push(name_t dict, const key_type key)

Push the value referenced by key 'key' into the dictionary 'dict'. This method is only defined for SET.

void name_erase(name_t dict, const key_type key)

Remove the element referenced by key 'key' in the dictionary 'dict'. Do nothing if 'key' is no present in the dictionary.

void name_it(name_it_t it, name_t dict)

Set the iterator 'it' to the first element of 'dict'.

void name_it_set(name_it_t it, const name_it_t ref)

Set the iterator 'it' to the same element than 'ref'.

bool name_end_p(const name_it_t it)

Return true if 'it' references no longer a valid element.

bool name_last_p(const name_it_t it)

Return true if 'it' references the last element or is no longer valid.

void name_next(name_it_t it)

Update the iterator 'it' to the next element.

name_itref_t *name_ref(name_it_t it) [for associative array]

key_type *name_ref(name_it_t it) [for set]

Return a pointer to the pair composed by the key ('key' field) and its value ('value' field) if it is not a set, to the key type if it is a set. 'key' element shall not be modified. This pointer remains valid until the dictionary is modified by another method.

const name_itref_t *name_ref(name_it_t it) [for associative array]

const key_type *name_ref(name_it_t it) [for set]

Return a constant pointer to the pair composed by the key ('key' field) and its value ('value' field) if it is not a set, to the key type if it is a set. This pointer remains valid until the dictionary is modified by another method.

void name_get_str(string_t str, const name_t dict, bool append)

Generate a formatted string representation of the dict 'dict' and set 'str' to this representation (if 'append' is false) or append 'str' with this representation (if 'append' is true). This method is only defined if the type of the element defines a GET_STR method itself.

bool name_parse_str(name_t dict, const char str[], const char **endp)

Parse the formatted string 'str' that is assumed to be a string representation of a dict and set 'dict' to this representation. This method is only defined if all types of the element defines PARSE_STR methods itself. It returns true if success, false otherwise. If endp is not NULL, it sets '*endp' to the pointer of the first character not decoded by the function.

void name_out_str(FILE *file, const name_t dict)

Generate a formatted string representation of the dict 'dict' and outputs it into the FILE 'file'. This method is only defined if the type of the element defines a OUT_STR method itself.

void name_in_str(name_t dict, FILE *file)

Read from the file 'file' a formatted string representation of a dict and set 'dict' to this representation. This method is only defined if the type of the element defines a IN_STR method itself.

bool name_equal_p(const name_t dict1, const name_t dict2)

Return true if both dict 'dict1' and 'dict2' are equal. This method is only defined if the type of the element defines a EQUAL method itself.

M-TUPLE

A tuple is a finite ordered list of elements of different types.

TUPLE_DEF2(name, (element1, type1[, oplist1]) [, ...])

Define the tuple 'name##_t' and its associated methods as "static inline" functions. Each parameter of the macro is expected to be an element of the tuple. Each element is defined by three parameters within parenthesis: the element name, the element type and the element oplist. 'name' and 'element' shall be a C identifier that will be used to identify the container.

This is more or less like a C structure. The main added value compared to using a struct is that it generates also all the basic methods to handle it. In fact, it generates a C struct with the given type and element.

It shall be done once per type and per compilation unit.

The object oplist is expected to have at least the following operators (INIT_SET, SET and CLEAR), otherwise default operators are used. If there is no given oplist, the default oplist for standard C type is used or a globally registered oplist is used. The created methods will use the operators to init, set and clear the contained object.

Example:

    TUPLE_DEF2(pair, (key, string_t, STRING_OPLIST),
                     (value, mpz_t, (INIT(mpz_init), INIT_SET(mpz_init_set), SET(mpz_set), CLEAR(mpz_clear) )))
    void f(void) {
            pair_t p1;
            pair_init (p1);
            string_set_str(p1->key, "HELLO");
            mpz_set_str(p1->value, "1742", 10);
            pair_clear(p1);
    }

TUPLE_DEF2_AS(name, name_t, (element1, type1[, oplist1]) [, ...])

Same as TUPLE_DEF2 except the name of the type name_t is provided.

TUPLE_OPLIST(name, oplist1[, ...] )

Return the oplist of the tuple defined by calling TUPLE_DEF2 with the given name & the Oplist.

Created methods

In the following methods, name stands for the name given to the macro that is used to identify the type. The following types are automatically defined by the previous macro:

name_t

Type of the defined tuple.

The following methods are automatically and properly created by the previous macros:

void name_init(name_t tuple)

Initialize the tuple 'tuple' (aka constructor) to an empty tuple. This method is defined if all methods define an INIT method.

void name_init_set(name_t tuple, const name_t ref)

Initialize the tuple 'tuple' (aka constructor) and set it to the value of 'ref'.

void name_init_emplace(name_t tuple, const type1 element1[, ...])

Initialize the tuple 'tuple' (aka constructor) and set it to the value of the constructed tuple ('element1'[, ...]).

void name_set(name_t tuple, const name_t ref)

Set the tuple 'tuple' to the value of 'ref'.

void name_emplace(name_t tuple, const type1 element1[, ...])

Set the tuple 'tuple' to the value of the tuple constructed with ('element1'[,...]).

void name_init_move(name_t tuple, name_t ref)

Initialize the tuple 'tuple' (aka constructor) by stealing as many resources from 'ref' as possible. After-wise 'ref' is cleared. This method is created only if all Oplist of the tuple define INIT_MOVE method.

void name_move(name_t tuple, name_t ref)

Set the tuple 'tuple' by stealing as many resources from 'ref' as possible. After-wise 'ref' is cleared. This method is created only if all Oplist of the tuple define MOVE method.

void name_clear(name_t tuple)

Clear the tuple 'tuple (aka destructor).

const type1 *name_cget_at_element1(const name_t tuple)

Return a constant pointer to the element 'element1' of the tuple. There is as many methods as there are elements.

type1 *name_get_at_element1(const name_t tuple)

Return a pointer to the element 'element1' of the tuple. There is as many methods as there are elements.

void name_set_element1(name_t tuple, type1 element1)

Set the element of the tuple to 'element1' There is as many methods as there are elements.

int name_cmp(const name_t tuple1, const name_t tuple2)

Compare 'tuple1' to 'tuple2' using lexicographic order. This method is created only if all Oplist of the tuple define CMP method.

int name_cmp_order(const name_t tuple1, const name_t tuple2, const int order[])

Compare 'tuple1' to 'tuple2' using the given order. 'order' is a null terminated array of int that defines the order of comparison: an order of {1,4,2,0} indicates to compare first the first field, if it is equal, to compare the fourth and so on. The third field is not compared. A negative value indicates to revert the comparison. This method is created only if all Oplist of the tuple define CMP method.

int name_cmp_element1(const name_t tuple1, const name_t tuple2)

Compare 'tuple1' to 'tuple2' using only the element element1 as reference. This method is created only if the oplist of element1 defines the CMP method.

int name_equal_p(const name_t tuple1, const name_t tuple2)

Return true if 'tuple1' and 'tuple2' are identical. This method is created only if all Oplist of the tuple define EQUAL method.

void name_get_str(string_t str, const name_t tuple, bool append)

Generate a formatted string representation of the tuple 'tuple' and set 'str' to this representation (if 'append' is false) or append 'str' with this representation (if 'append' is true). This method is only defined if all Oplist define a GET_STR method.

bool name_parse_str(name_t tuple, const char str[], const char **endp)

Parse the formatted string 'str' that is assumed to be a string representation of a tuple and set 'tuple' to this representation. This method is only defined if all types of the element defines PARSE_STR & INIT methods itself. It returns true if success, false otherwise. If endp is not NULL, it sets '*endp' to the pointer of the first character not decoded by the function.

void name_out_str(FILE *file, const name_t tuple)

Generate a formatted string representation of the tuple 'tuple' and outputs it into the FILE 'file'. This method is only defined if all Oplist define a OUT_STR method.

void name_in_str(name_t tuple, FILE *file)

Read from the file 'file' a formatted string representation of a tuple and set 'tuple' to this representation. This method is only defined if all Oplist define a IN_STR method.

M-VARIANT

A variant is a finite exclusive list of elements of different types : the variant can be only equal to one element at a time.

VARIANT_DEF2(name, (element1, type1[, oplist1]) [, ...])

Define the variant 'name##_t' and its associated methods as "static inline" functions. Each parameter of the macro is expected to be an element of the variant. Each element is defined by three parameters within parenthesis: the element name, the element type and the element oplist. 'name' and 'element' shall be a C identifier that will be used to identify the container.

This is like a C union. The main added value compared to using a union is that it generates all the basic methods to handle it and it dynamically identifies which element is stored within.

It shall be done once per type and per compilation unit.

Example:

    VARIANT_DEF2(either, (key, string_t, STRING_OPLIST),
                     (value, mpz_t, (INIT(mpz_init), INIT_SET(mpz_init_set), SET(mpz_set), CLEAR(mpz_clear) )))
    void f(sting_t s) {
            either_t p1;
            either_init (p1);
            either_set_key(p1, s);
            either_clear(p1);
    }

VARIANT_DEF2_AS(name, name_t, (element1, type1[, oplist1]) [, ...])

Same as VARIANT_DEF2 except the name of the type name_t is provided.

VARIANT_OPLIST(name, oplist1[, ...] )

Return the oplist of the variant defined by calling VARIANT_DEF2 with the given name & the Oplist.

Created methods

In the following methods, name stands for the name given to the macro that is used to identify the type. The following types / methods are automatically defined by the previous macro:

name_t

Type of the defined variant.

void name_init(name_t variant)

Initialize the variant 'variant' (aka constructor) to be empty.

void name_init_set(name_t variant, const name_t ref)

Initialize the variant 'variant' (aka constructor) and set it to the value of 'ref'.

void name_set(name_t variant, const name_t ref)

Set the variant 'variant' to the value of 'ref'.

void name_init_move(name_t variant, name_t ref)

Initialize the variant 'variant' (aka constructor) by stealing as many resources from 'ref' as possible. After-wise 'ref' is cleared. This method is created only if all Oplist of the variant define INIT_MOVE method.

void name_move(name_t variant, name_t ref)

void name_move_elementN(name_t variant, typeN ref)

Set the variant 'variant' by stealing as many resources from 'ref' as possible. After-wise 'ref' is cleared. This method is created only if all Oplist of the variant define MOVE method.

void name_clear(name_t variant)

Clear the variant 'variant (aka destructor).

void name_clean(name_t variant)

Clean the variant 'variant and make it empty.

void name_init_elementN(name_t variant)

Initialize the variant 'variant' to the type of 'element1' This method is defined if all methods define an INIT method.

void name_init_set_elementN(name_t variant, const typeN elementN)

Initialize and set the variant 'variant' to the type and value of 'elementN'.

void name_set_elementN(name_t variant, const typeN elementN)

Set the variant 'variant' to the type and value of 'elementN'.

const typeN * name_cget_at_elementN(name_t variant)

Return a pointer to the 'variant' viewed as of type 'typeN'. If the variant isn't an object of such type, it returns NULL.

typeN * name_get_at_elementN(name_t variant)

Return a pointer to the 'variant' viewed as of type 'typeN'. If the variant isn't an object of such type, it returns NULL.

bool name_empty_p(const name_t variant)

Return true if the variant is empty, false otherwise.

bool name_elementN_p(const name_t variant)

Return true if the variant is of the type of 'elementN'.

size_t name_hash(const name_t variant)

Return a hash associated to the variant. All types associated to the variant shall have a hash function for this function to be defined.

bool name_equal_p(const name_t variant1, const name_t variant2)

Return true if both objects are equal, false otherwise. All types associated to the variant shall have a equal_p function for this function to be defined.

void name_swap(name_t variant1, name_t variant2)

Swap both objects.

void name_get_str(string_t str, name_t variant, bool append)

Convert the variant into a formatted string, appending it into 'str' or not. All types associated to the variant shall have a GET_STR method for this function to be defined.

bool name_parse_str(name_t variant, const char str[], const char **endp)

Parse the formatted string 'str' that is assumed to be a string representation of a variant and set 'variant' to this representation. This method is only defined if all types of the element defines PARSE_STR & INIT methods itself. It returns true if success, false otherwise. If endp is not NULL, it sets '*endp' to the pointer of the first character not decoded by the function.

void name_out_str(FILE *file, name_t variant)

Convert the variant into a formatted string and send it to the stream 'file'. All types associated to the variant shall have a out_str function for this function to be defined.

void name_in_str(name_t variant, FILE *file)

Read a formatted string representation of the variant from the stream 'file' and update the object variant with it. All types associated to the variant shall have a in_str function for this function to be defined. This method is defined if all methods define an INIT method.

M-RBTREE

A binary tree is a tree data structure in which each node has at most two children, which are referred to as the left child and the right child. In this kind of tree, all elements of the tree are totally ordered. The current implementation is RED-BLACK TREE. It has not to be confused with a B-TREE.

RBTREE_DEF(name, type[, oplist])

Define the binary ordered tree 'name##_t' and its associated methods as "static inline" functions. 'name' shall be a C identifier that will be used to identify the container.

The CMP operator is used to perform the total ordering of the elements.

The UPDATE operator is used to update an element if the pushed item already exist in the container. The default behavior will overwrite the recorded value with the new one.

It shall be done once per type and per compilation unit. It also define the iterator name##_it_t and its associated methods as "static inline" functions.

The object oplist is expected to have at least the following operators (INIT, INIT_SET, SET, CLEAR and CMP), otherwise default operators are used. If there is no given oplist, the default oplist for standard C type is used or a globally registered oplist is used. The created methods will use the operators to init, set and clear the contained object.

Some methods may return a modifiable pointer to the found element (for example, _get). In this case, the user shall not modify the key ordre of the element, as there is no reordering of the tree in this case.

Example:

    RBTREE_DEF(rbtree_uint, unsigned int)
    void f(unsigned int num) {
            rbtree_uint_t tree;
            rbtree_uint_init(tree);
            for(unsigned int i = 0; i < num; i++)
                    rbtree_uint_push(tree, i);
            rbtree_uint_clear(tree);                              
    }

RBTREE_DEF_AS(name, name_t, name_it_t, type[, oplist])

Same as RBTREE_DEF2 except the name of the types name_t, name_it_t are provided.

RBTREE_OPLIST(name [, oplist])

Return the oplist of the Red-Black defined by calling RBTREE_DEF with name & oplist. If there is no given oplist, the default oplist for standard C type is used.

Created methods

The following methods are automatically and properly created by the previous macros. In the following methods, name stands for the name given to the macro that is used to identify the type.

name_t

Type of the Red Black Tree of 'type'.

name_it_t

Type of an iterator over this Red Black Tree.

void name_init(name_t rbtree)

Initialize the Red Black Tree 'rbtree' to be empty.

void name_clear(name_t rbtree)

Clear the Red Black Tree 'rbtree'.

void name_init_set(name_t rbtree, const name_t ref)

Initialize the Red Black Tree 'rbtree' to be the same as 'ref'.

void name_set(name_t rbtree, const name_t ref)

Set the Red Black Tree 'rbtree' to be the same as 'ref'.

void name_init_move(name_t rbtree, name_t ref)

Initialize the Red Black Tree 'rbtree' by stealing as resource as possible from 'ref' and clear 'ref'.

void name_move(name_t rbtree, name_t ref)

Set the Red Black Tree 'rbtree' by stealing as resource as possible from 'ref' and clear 'ref'.

void name_clean(name_t rbtree)

Clean the Red Black Tree 'rbtree'. 'rbtree' remains initialized but empty.

size_t name_size(const name_t rbtree)

Return the number of elements of the Red Black Tree.

void name_push(name_t rbtree, const type data)

Push 'data' into the Red Black Tree 'rbtree' at its ordered place while keeping the tree balanced. If the UPDATE operator is defined and there exists a node that equals (CMP) 'data' it will be used to update the data of the node on push (It can be used to increment value). Otherwise the value is overwritten.

void name_pop(type *dest, name_t rbtree, const type data)

Pop 'data' from the Red Black Tree 'rbtree' and save the popped value into 'dest' if the pointer is not null while keeping the tree balanced. Do nothing if 'data' is no present in the Red Black Tree.

type * name_min(const name_t rbtree)

const type * name_cmin(const name_t rbtree)

Return a pointer to the minimum element of the tree or NULL if there is no element.

type * name_max(const name_t rbtree)

const type * name_cmax(const name_t rbtree)

Return a pointer to the maximum element of the tree or NULL if there is no element.

type * name_get(const name_t rbtree, const type *data)

const type * name_cget(const name_t rbtree, const type *data)

Return a pointer to the element of the tree 'rbtree' that is equal to 'data', or NULL if there is no match.

void name_swap(name_t rbtree1, name_t rbtree2)

Swap both trees.

bool name_empty_p(const name_t rbtree)

Return true if the tree is empty, false otherwise.

void name_it(name_it_t it, name_t rbtree)

Set the iterator 'it' to the first element of 'rbtree'.

void name_it_set(name_it_t it, const name_it_t ref)

Set the iterator 'it' to the same element than 'ref'.

void name_it_last(name_it_t it, name_t rbtree)

Set the iterator 'it' to the last element of 'rbtree'.

void name_it_end(name_it_t it, name_t rbtree)

Set the iterator 'it' to no element of 'rbtree'.

void name_it_from(name_it_t it, const name_t rbtree, const type data)

Set the iterator 'it' to the greatest element of 'rbtree' lower of equal than 'data' or the first element is there is none.

bool name_end_p(const name_it_t it)

Return true if 'it' references no longer a valid element.

bool name_last_p(const name_it_t it)

Return true if 'it' references the last element or is no longer valid.

bool name_it_until_p(const name_it_t it, const type data)

Return true if 'it' references an element that is greater or equal than 'data'.

bool name_it_while_p(const name_it_t it, const type data)

Return true if 'it' references an element that is lower or equal than 'data'.

void name_next(name_it_t it)

Update the iterator 'it' to the next element.

void name_previous(name_it_t it)

Update the iterator 'it' to the previous element.

type *name_ref(name_it_t it)

const type *name_ref(name_it_t it)

Return a pointer to the element pointer by the iterator 'it'. This pointer remains valid until the Red Black Tree is modified by another method.

void name_get_str(string_t str, const name_t rbtree, bool append)

Generate a formatted string representation of the rbtree 'rbtree' and set 'str' to this representation (if 'append' is false) or append 'str' with this representation (if 'append' is true). This method is only defined if the type of the element defines a GET_STR method itself.

bool name_parse_str(name_t tree, const char str[], const char **endp)

Parse the formatted string 'str' that is assumed to be a string representation of a RBTREE and set 'tree' to this representation. This method is only defined if all types of the element defines PARSE_STR & INIT methods itself. It returns true if success, false otherwise. If endp is not NULL, it sets '*endp' to the pointer of the first character not decoded by the function.

void name_out_str(FILE *file, const name_t rbtree)

Generate a formatted string representation of the rbtree 'rbtree' and outputs it into the FILE 'file'. This method is only defined if the type of the element defines a OUT_STR method itself.

void name_in_str(name_t rbtree, FILE *file)

Read from the file 'file' a formatted string representation of a rbtree and set 'rbtree' to this representation. This method is only defined if the type of the element defines a IN_STR method itself.

bool name_equal_p(const name_t rbtree1, const name_t rbtree2)

Return true if both rbtree 'rbtree1' and 'rbtree2' are equal. This method is only defined if the type of the element defines a EQUAL method itself.

size_t name_hash_p(const name_t rbtree)

Return the hash of the tree. This method is only defined if the type of the element defines a HASH method itself.

M-BPTREE

A B+TREE is a variant of BTREE that itself is a generalization of Binary Tree.

A B+TREE is an N-ary tree with a variable but often large number of children per node. It is mostly used for handling slow media by file system and database.

It provides a fully sorted container enabling fast access to individual item or range of items, and as such is concurrent to Red-Black Tree. On modern architecture, a B+TREE is typically faster than a red-black tree due to being more cache friendly (The RAM itself can be considered as a slow media nowadays!)

When defining a B+TREE it is necessary to give the type of the item within, but also the maximum number of child per node (N). The best maximum number of child per node depends on the type itself (its size, its compare cost) and the cache of the processor.

BPTREE_DEF2(name, N, key_type, key_oplist, value_type, value_oplist)

Define the B+TREE tree of rank N 'name##_t' and its associated methods as "static inline" functions. This B+TREE will be created as an associative array of the key_type to the value_type.

The CMP operator is used to perform the total ordering of the key elements.

N is the number of items per node and shall be greater or equal than 2.

It shall be done once per type and per compilation unit. It also define the iterator name##_it_t and its associated methods as "static inline" functions.

Example:

    BPTREE_DEF2(tree_uint, 4, unsigned int, (), float, ())
    void f(unsigned int num) {
            tree_uint_t tree;
            tree_uint_init(tree);
            for(unsigned int i = 0; i < num; i++)
                    tree_uint_set_at(tree, i, (float) i);
            tree_uint_clear(tree);
    }

BPTREE_DEF2_AS(name, name_t, name_it_t, name_itref_t, N, key_type, key_oplist, value_type, value_oplist)

Same as BPTREE_DEF2 except the name of the types name_t, name_it_t, name_itref_t are provided.

BPTREE_OPLIST2(name, key_oplist, value_oplist)

Return the oplist of the BPTREE defined by calling BPTREE_DEF2 with name, key_oplist and value_oplist.

BPTREE_DEF(name, N, key_type[, key_oplist])

Define the B+TREE tree of rank N 'name##_t' and its associated methods as "static inline" functions. This B+TREE will be created as an ordered set of key_type.

The CMP operator is used to perform the total ordering of the key elements.

N is the number of items per node and shall be greater or equal than 2.

It shall be done once per type and per compilation unit. It also define the iterator name##_it_t and its associated methods as "static inline" functions.

In the following specification, in this case, value_type will be defined as the same as key_type.

Example:

    BPTREE_DEF(tree_uint, unsigned int)
    void f(unsigned int num) {
            tree_uint_t tree;
            tree_uint_init(tree);
            for(unsigned int i = 0; i < num; i++)
                    tree_uint_push(tree, i);
            tree_uint_clear(tree);
    }

BPTREE_DEF_AS(name, name_t, name_it_t, name_itref_t, N, key_type, key_oplist)

Same as BPTREE_DEF except the name of the types name_t, name_it_t, name_itref_t are provided.

BPTREE_OPLIST(name[, key_oplist])

Return the oplist of the BPTREE defined by calling BPTREE_DEF with name, key_oplist. If there is no given oplist, the default oplist for standard C type is used.

BPTREE_MULTI_DEF2(name, N, key_type, key_oplist, value_type, value_oplist)

Define the B+TREE tree of rank N 'name##_t' and its associated methods as "static inline" functions. This B+TREE will be created as an associative array of the 'key_type' to the 'value_type' and allows multiple instance of the same key in the tree (aka it is a multimap: re-adding the same key in the tree will add a new instance of the key in the tree rather than update the value associated to the key).

See BPTREE_DEF2 for additional details and example.

BPTREE_MULTI_DEF2_AS(name, name_t, name_it_t, name_itref_t, N, key_type, key_oplist, value_type, value_oplist)

Same as BPTREE_MULTI_DEF2 except the name of the types name_t, name_it_t, name_itref_t are provided.

BPTREE_MULTI_DEF(name, N, key_type[, key_oplist])

Define the B+TREE tree of rank N 'name##_t' and its associated methods as "static inline" functions. This B+TREE will be created as an ordered set of key_type and allows multiple instance of the same key in the tree (aka it is a multiset: re-adding the same key in the tree will add a new instance of the key in the tree rather than update the key value).

See BPTREE_DEF for additional details and example.

BPTREE_MULTI_DEF_AS(name, name_t, name_it_t, name_itref_t, N, key_type, key_oplist)

Same as BPTREE_MULTI_DEF except the name of the types name_t, name_it_t, name_itref_t are provided.

Created methods

The following methods are automatically and properly created by the previous macros. In the following methods, name stands for the name given to the macro that is used to identify the type.

name_t

Type of the B+Tree of 'type'.

name_it_t

Type of an iterator over this B+Tree.

name_itref_t

Type of one item referenced in the B+Tree. It is either:

a structure composed of a pointer to the key (field key_ptr) and a pointer to the value (field value_ptr) if the B+Tree is a map
or the basic type of the container if the B+Tree is a set.

void name_init(name_t tree)

Initialize the B+Tree 'tree' and set it to empty.

void name_clear(name_t tree)

Clear the B+Tree 'tree'.

void name_init_set(name_t tree, const name_t ref)

Initialize the B+Tree 'tree' to be the same as 'ref'.

void name_set(name_t tree, const name_t ref)

Set the B+Tree 'tree' to be the same as 'ref'.

void name_init_move(name_t tree, name_t ref)

Initialize the B+Tree 'tree' by stealing as resource as possible from 'ref' and clear 'ref'.

void name_move(name_t tree, name_t ref)

Set the B+Tree 'tree' by stealing as resource as possible from 'ref' and clear 'ref'.

void name_clean(name_t tree)

Clean the B+Tree 'tree'. 'tree' remains initialized but empty.

size_t name_size(const name_t tree)

Return the number of elements of the B+Tree.

void name_push(name_t tree, const key_type data)

Push 'data' into the B+Tree 'tree' at the right order while keeping the tree balanced. This function is defined only if the tree is not defined as an associative array.

void name_set_at(name_t tree, const key_type data, const value_type val)

Associate the value 'val' to the key 'data' in the B+Tree 'tree' while keeping the tree balanced. This function is defined only if the tree is defined as an associative array.

void name_pop(value_type *dest, name_t tree, const key_type data)

Pop 'data' from the B+Tree 'tree' and save the popped value into 'dest' if the pointer is not null while keeping the tree balanced. Do nothing if 'data' is no present in the B+Tree.

bool name_erase(name_t tree, const key_type data)

Remove 'data' from the B+Tree 'tree' while keeping the tree balanced. Return true if the data is removed, false if nothing is done (data is not present).

value_type * name_min(const name_t tree)

const value_type * name_cmin(const name_t tree)

Return a pointer to the minimum element of the tree or NULL if there is no element in the B+Tree.

value_type * name_max(const name_t tree)

const value_type * name_cmax(const name_t tree)

Return a pointer to the maximum element of the tree or NULL if there is no element in the B+Tree.

value_type * name_get(const name_t tree, const key_type data)

const value_type * name_cget(const name_t tree, const key_type data)

Return a pointer to the value of the tree 'tree' that is associated to 'data', or NULL if there is no match.

value_type * name_get_at(name_t tree, const key_type data)

Return a pointer to the value of the tree 'tree' that is associated to 'data'. If the key doesn't exist yet in the tree, a new entry is created with 'key' and a value initialized with its INIT operator, then a pointer to the newly created entry is returned.

void name_swap(name_t tree1, name_t tree2)

Swap both trees.

bool name_empty_p(const name_t tree)

Return true if the tree is empty, false otherwise.

void name_it(name_it_t it, name_t tree)

Set the iterator 'it' to the first element of 'tree'.

void name_it_set(name_it_t it, const name_it_t ref)

Set the iterator 'it' to the same element than 'ref'.

void name_it_end(name_it_t it, name_t tree)

Set the iterator 'it' to no element of 'tree'.

void name_it_from(name_it_t it, const name_t tree, const type data)

Set the iterator 'it' to the greatest element of 'tree' lower of equal than 'data' or the first element is there is none.

bool name_end_p(const name_it_t it)

Return true if 'it' references no longer a valid element.

bool name_it_until_p(const name_it_t it, const type data)

Return true if 'it' references an element that is greater or equal than 'data'.

bool name_it_while_p(const name_it_t it, const type data)

Return true if 'it' references an element that is lower or equal than 'data'.

bool name_it_equal_p(const name_it_t it1, const name_it_t it1)

Return true if both iterators reference the same object.

void name_next(name_it_t it)

Update the iterator 'it' to the next element.

name_itref_t *name_ref(name_it_t it)

const name_itref_t *name_ref(name_it_t it)

Return a pointer to the element pointer by the iterator 'it'. This pointer remains valid until the B+Tree is modified by another method.

void name_get_str(string_t str, const name_t tree, bool append)

Generate a formatted string representation of the tree 'tree' and set 'str' to this representation (if 'append' is false) or append 'str' with this representation (if 'append' is true). This method is only defined if the type of the element defines a GET_STR method itself.

bool name_parse_str(name_t tree, const char str[], const char **endp)

Parse the formatted string 'str' that is assumed to be a string representation of a tree and set 'tree' to this representation. This method is only defined if the type of the element defines a PARSE_STR method itself. It returns true if success, false otherwise. If endp is not NULL, it sets '*endp' to the pointer of the first character not decoded by the function.

void name_out_str(FILE *file, const name_t tree)

Generate a formatted string representation of the tree 'tree' and outputs it into the FILE 'file'. This method is only defined if the type of the element defines a OUT_STR method itself.

void name_in_str(name_t tree, FILE *file)

Read from the file 'file' a formatted string representation of a tree and set 'tree' to this representation. This method is only defined if the type of the element defines a IN_STR method itself.

bool name_equal_p(const name_t tree1, const name_t tree2)

Return true if both trees 'tree1' and 'tree2' are equal. This method is only defined if the type of the element defines a EQUAL method itself.

size_t name_hash_p(const name_t tree)

Return the hash of the tree. This method is only defined if the type of the element defines a HASH method itself.

M-PRIOQUEUE

A priority queue is a queue where each element has a "priority" associated with it: an element with high priority is served before an element with low priority. It is currently implemented as a heap.

PRIOQUEUE_DEF(name, type [, oplist])

Define the priority queue 'name##_t' and its associated methods as "static inline" functions. The queue will be composed of object of type 'type'.

'name' shall be a C identifier that will be used to identify the container.

The CMP operator is used to sort the queue so that it always returns the minimum of the queue. The EQUAL operator is used to identify an item on UPDATE or REMOVE operations. It is uncorrelated with the CMP operator from the point of view of this operator. (i.e. EQUAL() == TRUE is not equivalent to CMP() == 0 for this container)

The object oplist is expected to have at least the following operators (INIT, INIT_SET, SET, CLEAR, CMP and EQUAL), otherwise default operators are used. If there is no given oplist, the default oplist for standard C type is used or a globally registered oplist is used. The created methods will use the operators to init, set and clear the contained object.

PRIOQUEUE_DEF_AS(name, name_t, name_it_t, type [, oplist])

Same as PRIOQUEUE_DEF except the name of the types name_t, name_it_t are provided.

PRIOQUEUE_OPLIST(name, [, oplist])

Define the oplist of the prioqueue defined with 'name' and potentially 'oplist'. If there is no given oplist, the default oplist for standard C type is used.

Created methods

The following methods are automatically and properly created by the previous macros. In the following methods, name stands for the name given to the macro that is used to identify the type.

name_t

Type of the priority queue of 'type'.

name_it_t

Type of an iterator over this priority queue.

void name_init(name_t queue)

Initialize the priority queue 'queue' and set it to empty.

void name_clear(name_t queue)

Clear the priority queue 'tree'.

void name_init_set(name_t queue, const name_t ref)

Initialize the Priority Queue 'queue' to be the same as 'ref'.

void name_set(name_t queue, const name_t ref)

Set the Priority Queue 'queue' to be the same as 'ref'.

void name_init_move(name_t queue, name_t ref)

Initialize the Priority Queue 'queue' by stealing as resource as possible from 'ref' and clear 'ref'.

void name_move(name_t queue, name_t ref)

Set the Priority Queue 'queue' by stealing as resource as possible from 'ref' and clear 'ref'.

void name_clean(name_t queue)

Clean the Priority Queue 'queue'. 'queue' remains initialized but empty.

size_t name_size(const name_t queue)

Return the number of elements of the Priority Queue.

bool name_empty_p(const name_t queue)

Return true if the queue is empty, false otherwise.

void name_swap(name_t queue1, name_t queue2)

Swap both queues.

void name_push(name_t queue, const type x)

Push 'x' into the Priority Queue 'queue' (somewhere in the queue).

const type *name_front(name_t queue)

Return a constant pointer to the item having the minimum value of all elements in the queue 'queue'.

void name_pop(type *dest, name_t queue)

Pop the minimum value from the priority Queue 'queue' and save the popped value into 'dest' if the pointer is not null.

bool name_equal_p(const name_t queue1, const name_t queue2)

Return true if both queues are equal, false otherwise.

void name_update(name_t queue, const type_t old_val, const type_t new_val)

Change the priority of the data of the priority equals to 'old_val' (in EQUAL sense) to 'new_val' (increase or decrease priority). This method has a complexity of O(n) (due to to linear search of the data). This method is defined only if the EQUAL method is defined.

void name_erase(name_t queue, const type_t val)

Remove the data of the priority equals to 'val' (in EQUAL sense). This method has a complexity of O(n) (due to to linear search of the data). This method is defined only if the EQUAL method is defined.

void name_it(name_it_t it, name_t queue)

Set the iterator 'it' to the first element of 'queue'. It won't iterate from minimum to maximum but in an implementation define way that ensures that all items are accessed.

void name_it_last(name_it_t it, name_t queue)

Set the iterator 'it' to the last element of 'queue'.

void name_it_set(name_it_t it, const name_it_t ref)

Set the iterator 'it' to the same element than 'ref'.

void name_it_end(name_it_t it, name_t queue)

Set the iterator 'it' to no element of 'queue'.

bool name_end_p(const name_it_t it)

Return true if 'it' references no longer a valid element.

bool name_last_p(const name_it_t it)

Return true if 'it' references the last element, or there is no longer any valid element.

bool name_it_equal_p(const name_it_t it1, const name_it_t it2)

Return true if both iterators reference the same entries.

void name_next(name_it_t it)

Update the iterator 'it' to the next element.

void name_previous(name_it_t it)

Update the iterator 'it' to the previous element.

const type *name_cref(name_it_t it)

Return a constant pointer to the referenced item.

M-BUFFER

This header implements different kind of fixed circular buffer.

A circular buffer (or ring buffer) is a data structure using a single, bounded buffer as if its head was connected to its tail.

BUFFER_DEF(name, type, size, policy[, oplist])

Define the buffer 'name##_t' and its associated methods as "static inline" functions. A buffer is a fixed circular queue implementing a queue (or stack) interface. It can be used to transfer message from multiple producer threads to multiple consumer threads. This is done internally using a mutex and conditional waits (if it is built with the BUFFER_THREAD_SAFE option -- default)

'name' shall be a C identifier that will be used to identify the container.

The size parameter defined the fixed size of the queue. It can be 0. In this case, the fixed size is defined at initialization time only and the needed objects to handle the buffer are allocated at initialization time too. Otherwise the needed objects are embedded within the structure, preventing any other allocations.

The size of the buffer shall be lower or equal than the maximum of the type 'int'.

Multiple additional policy can be applied to the buffer by performing a logical or of the following properties:

BUFFER_QUEUE : define a FIFO queue (default),
BUFFER_STACK : define a stack (exclusive with BUFFER_QUEUE),
BUFFER_THREAD_SAFE : define thread safe functions (default),
BUFFER_THREAD_UNSAFE : define thread unsafe functions (exclusive with BUFFER_THREAD_SAFE),
BUFFER_PUSH_INIT_POP_MOVE : change the behavior of PUSH to push a new initialized object, and POP as moving this new object into the new emplacement (this is mostly used for performance reasons or to handle properly a shared_ptr semantic). In practice, it works as if POP performs the initialization of the object.
BUFFER_PUSH_OVERWRITE : PUSH overwrites the last entry if the queue is full instead of blocking,
BUFFER_DEFERRED_POP : do not consider the object to be fully popped from the buffer by calling the pop method until the call to pop_deferred ; this enables to handle object that are in-progress of being consumed by the thread.

This container is designed to be used for easy synchronization inter-threads (and the variable should be a global shared one).

It shall be done once per type and per compilation unit.

Example:

    BUFFER_DEF(buffer_uint, unsigned int, 10, BUFFER_QUEUE|BUFFER_BLOCKING)

    buffer_uint_t g_buff;

    void f(unsigned int i) {
            buffer_uint_init(g_buff, 10);
            buffer_uint_push(g_buff, i);
            buffer_uint_pop(&i, g_buff);
            buffer_uint_clear(g_buff);
    }

BUFFER_DEF_AS(name, name_t, type, size, policy[, oplist])

Same as BUFFER_DEF except the name of the type name_t is provided.

Created methods

The following methods are automatically and properly created by the previous macros. In the following methods, name stands for the name given to the macro that is used to identify the type.

void name_init(buffer_t buffer, size_t size)

Initialize the buffer 'buffer' for 'size' elements. The 'size' argument shall be the same as the one used to create the buffer or the one used to create the buffer was '0'. The size of the buffer shall be lower or equal than UINT_MAX. This function is not thread safe.

void name_clear(buffer_t buffer)

Clear the buffer and destroy all its allocation. This function is not thread safe and doesn't perform any synchronization: all threads shall have stopped using the buffer.

void name_clean(buffer_t buffer)

Clean the buffer making it empty but remain initialized. This function is thread safe if the buffer was built thread safe.

bool name_empty_p(const buffer_t buffer)

Return true if the buffer is empty, false otherwise. This function is thread safe if the buffer was built thread safe.

bool name_full_p(const buffer_t buffer)

Return true if the buffer is full, false otherwise. This function is thread safe if the buffer was built thread safe.

size_t name_size(const buffer_t buffer)

Return the number of elements in the buffer that can be en-queued. This function is thread safe if the buffer was built thread safe.

size_t name_capacity(const buffer_t buffer)

Return the capacity of the buffer.

size_t name_overwrite(const buffer_t buffer)

If the buffer is built with the BUFFER_PUSH_OVERWRITE option, this function returns the number of elements that have been overwritten and thus discarded. If the buffer was not built with the BUFFER_PUSH_OVERWRITE option, it returns 0.

bool name_push_blocking(buffer_t buffer, const type data, bool blocking)

Push the object 'data' in the buffer 'buffer', waiting for an empty room if 'blocking' is true. Returns true if the data was pushed, false otherwise. Always return true if the buffer is blocking. This function is thread safe if the buffer was built thread safe.

bool name_pop_blocking(type *data, buffer_t buffer, bool blocking)

Pop from the buffer 'buffer' into the object '*data', waiting for a data if 'blocking' is true.

If the buffer is built with the BUFFER_PUSH_INIT_POP_MOVE option, the object pointed by 'data' shall be uninitialized as the pop function will perform a quick initialization of the object (using an INIT_MOVE operator) , otherwise it shall be an initialized object (the pop function will perform a SET operator).

If the buffer is built with the BUFFER_DEFERRED_POP option, the object is still considered being present in the queue until a call to name_pop_release.

Returns true if a data was popped, false otherwise. Always return true if the buffer is blocking. This function is thread safe if the buffer was built thread safe.

bool name_push(buffer_t buffer, const type data)

Same as name_push_blocking with blocking equals to true.

bool name_pop(type *data, buffer_t buffer)

Same as name_pop_blocking with blocking equals to true.

bool name_pop_release(buffer_t buffer)

If the buffer is built with the BUFFER_DEFERRED_POP option, the object being popped is considered fully release (freeing a space in the queue). Otherwise it does nothing.

QUEUE_MPMC_DEF(name, type, policy[, oplist])

Define the MPMC queue 'name##_t' and its associated methods as "static inline" functions. A MPMC queue is a fixed circular queue implementing a queue (or stack) interface. It can be used to transfer message from Multiple Producer threads to Multiple Consumer threads. This queue is not strictly lock free but has a lot of the properties of such algorithms.

The size is specified only at run-time and shall be a power of 2.

'name' shall be a C identifier that will be used to identify the container.

An additional policy can be applied to the buffer by performing a logical or of the following properties:

BUFFER_QUEUE : define a FIFO queue (default),
BUFFER_PUSH_INIT_POP_MOVE : change the behavior of PUSH to push a new initialized object, and POP as moving this new object into the new emplacement (this is mostly used for performance reasons or to handle properly a shared_ptr semantic). In practice, it works as if POP performs the initialization of the object.

This container is designed to be used for easy synchronization inter-threads in a context of very fast communication (the variable should be a global shared one). There should not have more threads using this queue than they are available hardware cores due to the only partial protection on Context-switch Immunity of this structure (This can happen only if you abuse massively the number of threads vs the number of cores).

It shall be done once per type and per compilation unit.

QUEUE_MPMC_DEF_AS(name, name_t, type, policy[, oplist])

Same as QUEUE_MPMC_DEF except the name of the type name_t is provided.

Created methods

The following methods are automatically and properly created by the previous macros. In the following methods, name stands for the name given to the macro that is used to identify the type (prefix).

void name_init(buffer_t buffer, size_t size)

Initialize the buffer 'buffer' with 'size' elements. The 'size' argument shall be a power of two greater than 0, and less than UINT_MAX. This function is not thread safe.

void name_clear(buffer_t buffer)

Clear the buffer and destroy all its allocation. This function is not thread safe and doesn't perform any synchronization: all threads shall have stopped using the buffer.

bool name_empty_p(const buffer_t buffer)

Return true if the buffer is empty, false otherwise. This function is thread safe.

bool name_full_p(const buffer_t buffer)

Return true if the buffer is full, false otherwise. This function is thread safe.

size_t name_size(const buffer_t buffer)

Return the number of elements in the buffer that can be en-queued. This function is thread safe but may return a size greater than the size of the queue in some race condition.

size_t name_capacity(const buffer_t buffer)

Return the capacity of the buffer.

bool name_push(buffer_t buffer, const type data)

Push the object 'data' in the buffer 'buffer' if possible. Returns true if the data was pushed, false otherwise (buffer full or unlikely data race). This function is thread safe.

bool name_pop(type *data, buffer_t buffer)

Pop from the buffer 'buffer' into the object '*data' if possible.

Returns true if a data was popped, false otherwise (buffer empty or unlikely data race). This function is thread safe.

QUEUE_SPSC_DEF(name, type, policy[, oplist])

Define the SPSC queue 'name##_t' and its associated methods as "static inline" functions. A SPSC queue is a fixed circular queue implementing a queue (or stack) interface. It can be used to transfer message from a Single Producer thread to a Single Consumer thread. This is done internally using lock-free objects. It is more specialized than QUEUE_MPMC_DEF and as such, is faster.

The size is specified only at run-time and shall be a power of 2.

'name' shall be a C identifier that will be used to identify the container.

An additional policy can be applied to the buffer by performing a logical or of the following properties:

BUFFER_QUEUE : define a FIFO queue (default),
BUFFER_PUSH_INIT_POP_MOVE : change the behavior of PUSH to push a new initialized object, and POP as moving this new object into the new emplacement (this is mostly used for performance reasons or to handle properly a shared_ptr semantic). In practice, it works as if POP performs the initialization of the object.

This container is designed to be used for easy synchronization inter-threads in a context of very fast communication (the variable should be a global shared one).

It shall be done once per type and per compilation unit.

QUEUE_SPSC_DEF_AS(name, name_t, type, policy[, oplist])

Same as QUEUE_MPMC_DEF except the name of the type name_t is provided.

Created methods

The following methods are automatically and properly created by the previous macros. In the following methods, name stands for the name given to the macro that is used to identify the type (prefix).

void name_init(buffer_t buffer, size_t size)

Initialize the buffer 'buffer' with 'size' elements. The 'size' argument shall be a power of two greater than 0, and less than UINT_MAX. This function is not thread safe.

void name_clear(buffer_t buffer)

Clear the buffer and destroy all its allocation. This function is not thread safe and doesn't perform any synchronization: all threads shall have stopped using the buffer.

bool name_empty_p(const buffer_t buffer)

Return true if the buffer is empty, false otherwise. This function is thread safe.

bool name_full_p(const buffer_t buffer)

Return true if the buffer is full, false otherwise. This function is thread safe.

size_t name_size(const buffer_t buffer)

Return the number of elements in the buffer that can be en-queued. This function is thread safe but may return a size greater than the size of the queue in some race condition.

size_t name_capacity(const buffer_t buffer)

Return the capacity of the buffer.

bool name_push(buffer_t buffer, const type data)

Push the object 'data' in the buffer 'buffer' if possible. Returns true if the data was pushed, false otherwise (buffer full). This function is thread safe.

bool name_push_move(buffer_t buffer, type *data)

Push & move the object '*data' in the buffer 'buffer' if possible. Returns true if the data was pushed, false otherwise (buffer full). Afterwards '*data' is cleared (destructor) if true is returned. This function is thread safe.

bool name_push_force(buffer_t buffer, const type data)

Push the object 'data' in the buffer 'buffer' discarding the oldest data if needed. This function is thread safe.

bool name_push_bulk(buffer_t buffer, unsigned n, const type data[])

Push as much objects from the array 'data' in the buffer 'buffer' as possible, starting from the object at index 0 to the object at index 'n-1'. Returns the number of objects pushed. This function is thread safe.

bool name_pop(type *data, buffer_t buffer)

Pop from the buffer 'buffer' into the object '*data' if possible.

Returns true if a data was popped, false otherwise (buffer empty or unlikely data race). This function is thread safe.

unsigned name_pop_bulk(unsigned n, type tab[n], buffer_t buffer)

Pop from the buffer 'buffer' as many objects as possible to fill in 'tab' and at most 'n'.

It returns the number of objects popped. This function is thread safe.

M-SNAPSHOT

This header is for created snapshots.

A snapshot is a mechanism enabling a reader thread and a writer thread, working at different speeds, to exchange messages in a fast, reliable and thread safe way (the message is always passed automatically from a thread point of view) without waiting for synchronization. The consumer thread has only access to the latest published data of the producer thread. This is implemented in a fast way as the writer directly writes the message in the buffer that will be passed to the reader (avoiding copy of the buffer) and a simple exchange of index is sufficient to handle the switch.

This container is designed to be used for easy synchronization inter-threads (and the variable should be a global shared one).

This is linked to shared atomic register in the literature and snapshot names vector of such registers where each element of the vector can be updated separately. They can be classified according to the number of producers/consumers: SPSC (Single Producer, Single Consumer), MPSC (Multiple Producer, Single Consumer), SPMC (Single Producer, Multiple Consumer), MPMC (Multiple Producer, Multiple Consumer),

The provided containers by the library are designed to handle huge structure efficiently and as such deal with the memory reclamation needed to handle them. If the data you are sharing are supported by the atomic header (like bool or integer), using atomic_load and atomic_store is a much more efficient and simple way to do even in the case of MPMC.

SNAPSHOT_SPSC_DEF(name, type[, oplist])

Define the snapshot 'name##_t' and its associated methods as "static inline" functions. Only a single reader thread and a single writer thread are supported. It is a SPSC atomic shared register. In practice, it is implemented using a triple buffer (lock-free).

It shall be done once per type and per compilation unit. Not all functions are thread safe.

Example:

    SNAPSHOT_DEF(snapshot_uint, unsigned int)
    snapshot_uint_t message;
    void f(unsigned int i) {
            unsigned *p = snapshot_uint_get_write_buffer(message);
            *p = i;
            snapshot_uint_write(message);
    }
    unsigned int g(void) {
            unsigned *p = snapshot_uint_read(message);
            return *p;
    }

SNAPSHOT_SPSC_DEF_AS(name, name_t, type[, oplist])

Same as SNAPSHOT_SPSC_DEF except the name of the type name_t is provided.

Created methods

The following methods are automatically and properly created by the previous macros. In the following methods, name stands for the name given to the macro that is used to identify the type.

void name_init(snapshot_t snapshot)

Initialize the snapshot 'snapshot'. This function is not thread safe.

void name_clear(snapshot_t snapshot)

Clear the snapshot and destroy all its allocations. This function is not thread safe.

void name_init_set(snapshot_t snapshot, const snapshot_t org)

Initialize the snapshot 'snapshot' from the state of 'org'. This function is not thread safe.

void name_set(snapshot_t snapshot, const snapshot_t org)

Set the snapshot 'snapshot' from the state of 'org'. This function is not thread safe.

void name_init_move(snapshot_t snapshot, snapshot_t org)

Move the contain of the snapshot 'org' to the uninitialized 'snapshot', clearing 'org' in the process. This function is not thread safe. This function is defined only if the underlying type has defined the INIT_MOVE operator.

void name_move(snapshot_t snapshot, snapshot_t org)

Move the contain of the snapshot 'org' to the initialized 'snapshot', clearing 'org' in the process. This function is not thread safe. This function is defined only if the underlying type has defined the MOVE operator.

type *name_write(snapshot_t snap)

Publish the 'in-progress' data of the snapshot 'snap so that the read thread can have access to the data. It returns the pointer to the new 'in-progress' data buffer of the snapshot (which is not yet published but will be published for the next call of name_write). This function is thread-safe and performs atomic operation on the snapshot.

type *name_read(snapshot_t snap)

Get access to the last published data of the snapshot 'snap'. It returns the pointer to the data. If a publication has been performed since the last call to name_read a new pointer to the data is returned. Otherwise the previous pointer is returned. This function is thread-safe and performs atomic operation on the snapshot.

bool name_updated_p(snapshot_t snap)

Return true if the buffer has updated data compared to the last time it was read. This function is thread-safe and performs atomic operation on the snapshot.

type *name_get_write_buffer(snapshot_t snap)

Return a pointer to the active 'in-progress' data of the snapshot 'snap'. It is the same as the last return from name_write. This function is thread-safe and performs atomic operation on the snapshot.

type *name_get_read_buffer(snapshot_t snap)

Return a pointer to the active published data of the snapshot 'snap'. It is the same as the last return from name_read. It doesn't perform any switch of the data that has to be read. This function is thread-safe and performs atomic operation on the snapshot.

TODO: Document SPMC & MPMC snapshots

M-SHARED

This header is for creating shared pointer. A shared pointer is a smart pointer that retains shared ownership of an object. Several shared pointers may own the same object, sharing ownership of an object.

SHARED_PTR_DEF(name, type[, oplist])

Define the shared pointer 'name##_t' and its associated methods as "static inline" functions. A shared pointer is a mechanism to keep tracks of all users of an object and performs an automatic destruction of the object whenever all users release their need on this object.

The tracking of ownership is atomic and the destruction of the object is thread safe.

The object oplist is expected to have at least the following operators (CLEAR to clear the object and DEL to free the allocated memory), otherwise default operators are used. If there is no given oplist, the default oplist for standard C type is used or a globally registered oplist is used. The created methods will use the operators to initialize, set and clear the contained object. It supports also the INIT_MOVE operator of the object if available.

There are designed to work with buffers with policy BUFFER_PUSH_INIT_POP_MOVE to send a shared pointer across multiple threads.

Example:

    SHARED_PTR_DEF(shared_mpz, mpz_t, (CLEAR(mpz_clear)))
    void f(void) {
            shared_mpz_t p;
            mpz_t z;
            mpz_init(z);
            shared_mpz_init2 (p, z);
            buffer_uint_push(g_buff1, p);
            buffer_uint_push(g_buff2, p);
            shared_mpz_clear(p);
    }

SHARED_PTR_DEF_AS(name, name_t, type[, oplist])

Same as SHARED_PTR_DEF except the name of the type name_t is provided.

Created methods

The following methods are automatically and properly created by the previous macros. In the following methods, name stands for the name given to the macro that is used to identify the type.

void name_init(shared_t shared)

Initialize the shared pointer 'shared' to represent NULL (no object is therefore referenced).

void name_init2(shared_t shared, type *data)

Initialize the shared pointer 'shared' to reference '*data'. User code shall not use '*data' (or any pointer to it) anymore as the shared pointer gets the exclusive ownership of the object.

void name_init_new(shared_t shared)

Initialize the shared pointer 'shared' to a new object of type 'type'. The default constructor of type is used to initialize the object.

void name_init_set(shared_t shared, const shared_t src)

Initialize the shared pointer 'shared' to the same object than the one pointed by 'src' (sharing ownership). This function is thread safe from 'src' point of view.

bool name_NULL_p(const shared_t shared)

Return true if shared doesn't reference any object.

void name_clear(shared_t shared)

Clear the shared pointer: the shared pointer loses its ownership of the object and it destroys it if no longer any other shared pointers own the object. This function is thread safe.

void name_clean(shared_t shared)

'shared' loses ownership of its object and destroy it if no longer any other shared pointers own it. Then it makes the shared pointer 'shared' references NULL (it doesn't reference its object any-longer and loses its ownership of it). This function is thread safe.

void name_set(shared_t shared, const shared_t src)

'shared' loses ownership of its object and destroy it if no longer any other shared pointers own it. Then it sets the shared pointer 'shared' to the same object than the one pointed by 'src' (sharing ownership). This function is thread safe.

void name_init_move(shared_t shared, shared_t src)

Move the shared pointer from the initialized 'src' to 'shared'.

void name_move(shared_t shared, shared_t src)

'shared' loses ownership of its object and destroy it if no longer any other shared pointers own it. Then it moves the shared pointer from the initialized 'src' to 'shared'.

void name_swap(shared_t shared1, shared_t shared2)

Swap the references of the objects owned by the shared pointers 'shared1' and 'shared2'.

bool name_equal_p(const shared_t shared1, const shared_t shared2)

Return true if both shared pointers own the same object.

const type *name_cref(const shared_t shared)

Return a constant pointer to the shared object owned by the shared pointer. The pointer shall be kept only until another use of shared pointer method. Keeping the pointer otherwise is undefined behavior.

type *name_ref(const shared_t shared)

Return a pointer to the shared object pointed by the shared pointer. The pointer shall be kept only until another use of shared pointer method. Keeping the pointer otherwise is undefined behavior.

TODO: Document shared resource

M-I-SHARED

This header is for creating intrusive shared pointer.

ISHARED_PTR_INTERFACE(name, type)

Extend the definition of the structure of an object of type 'type' by adding the necessary interface to handle it as a shared pointer named 'name'. It shall be put within the structure definition of the object (See example).

ISHARED_PTR_STATIC_INIT(name, type)

Provide the static initialization value of an object defined with a ISHARED_PTR_INTERFACE extra fields. It shall be used only for global variables with the _init_once function.

Usage (provided that the interface is used as the first element of the structure):

    struct mystruct variable = { ISHARED_PTR_STATIC_INIT(ishared_double, struct mystruct) };

ISHARED_PTR_STATIC_DESIGNATED_INIT(name, type)

Provide the static initialization value of an object defined with a ISHARED_PTR_INTERFACE extra fields. It shall be used only for global variables with the _init_once function.

It uses designated initializers to set the right fields.

Usage:

    struct mystruct variable = { ISHARED_PTR_STATIC_DESIGNATED_INIT(ishared_double, struct mystruct) };

ISHARED_PTR_DEF(name, type[, oplist])

Define the associated methods to handle the shared pointer named 'name' as "static inline" functions. A shared pointer is a mechanism to keep tracks of all 'users' of an object and performs an automatic destruction of the object whenever all users release their need on this object.

The destruction of the object is thread safe and occurs when the last user of the object releases it. The destruction of the object implies:

calling the CLEAR operator to clear the object,
calling the DEL operator to release the memory used by the object (if the method has not been disabled).

The object oplist is expected to have the following operators (CLEAR and DEL), otherwise default operators are used. If there is no given oplist, the default operators are also used. The created methods will use the operators to init, set and clear the contained object.

There are designed to work with buffers with policy BUFFER_PUSH_INIT_POP_MOVE to send a shared pointer across multiple threads.

It is recommended to use the intrusive shared pointer over the standard one if possible (They are faster & cleaner).

The default is to use heap allocated entities, which are allocated by NEW & freed by DEL.

It can be used for statically allocated entities. However, in this case, you shall disable the operator NEW & DEL when expanding the oplist so that the CLEAR method doesn't try to free the objects like this:

(NEW(0), DEL(0))

NEW & DEL operators shall be either both defined, or both disabled.

Example (dynamic):

    typedef struct mystruct_s {
            ISHARED_PTR_INTERFACE(ishared_mystruct, struct mystruct_s);
            char *message;
    } mystruct_t;

    static inline void mystruct_init(mystruct_t *p) { p->message = NULL; }
    static inline void mystruct_clear(mystruct_t *p) { free(p->message); }

    ISHARED_PTR_DEF(ishared_mystruct, mystruct_t, (INIT(mystruct_init), CLEAR(mystruct_clear M_IPTR)))

    void f(void) {
            mystruct_t *p = ishared_mystruct_init_new();
            p->message = strdup ("Hello");
            buffer_mystruct_push(g_buff1, p);
            buffer_mystruct_push(g_buff2, p);
            ishared_mystruct_clear(p);
    }

ISHARED_PTR_DEF_AS(name, name_t, type[, oplist])

Same as ISHARED_PTR_DEF except the name of the type name_t is provided.

Created methods

The following methods are automatically and properly created by the previous macros. In the following methods, name stands for the name given to the macro that is used to identify the type.

typedef type *name_t

It will define name_t as a pointer to shared counted object. This is a synonymous to a pointer to the object.

name_t name_init(type *object)

Return a shared pointer to 'object' which owns 'object'. It initializes the private fields of 'object' handling the shared pointer, returning a pointer to the object (but initialized).

As a consequence, the shared pointer part of 'object' shall not have been initialized yet. The other part of 'object' may or may not be initialized before calling this method.

name_t name_init_set(name_t shared)

Return a new shared pointer to the same object than the one pointed by 'shared', incrementing the ownership of the object. This function is thread safe.

name_t name_init_new(void)

Allocate a new object, initialize it and return an initialized shared pointer to it.

The used allocation function is the NEW operator.

This function is created only if the INIT method is defined in the oplist and if the NEW method has not been disabled in the oplist.

name_t name_init_once(type *object)

Initialize the new object 'object' and return an initialized shared pointer to it. The INIT operator of 'object' is ensured to be called only once, even if multiple threads try to initialize it at the same time. Once the object is fully cleared, the initialization function may occur once again.

object shall be a global variable initialized with the ISHARED_PTR_STATIC_INIT macro.

This function is created only if the INIT method is defined in the oplist and if the NEW method has been disabled in the oplist.

void name_clear(name_t shared)

Clear the shared pointer, releasing ownership of the object and destroying the shared object if no longer any other shared pointers own it. This function is thread safe.

void name_clear_ptr(name_t *shared)

Clear the shared pointer '*shared', releasing ownership of the object and destroying the shared object if no longer any other shared pointers own it. This function is thread safe. Afterwards, '*shared' is set to NULL.

void name_set(name_t *shared1, name_t shared2)

Update the shared pointer '*shared1' to point to the same object than the shared pointer 'shared2'. Destroy the shared object pointed by '*shared1' if no longer any other shared pointers own it, set the shared pointer 'shared' to the same object than the one pointed by 'src'. This function is thread safe.

M-I-LIST

This header is for creating intrusive doubly-linked list.

ILIST_INTERFACE(name, type)

Extend an object by adding the necessary interface to handle it within an intrusive doubly-linked list. This is the intrusive part. It shall be put within the structure of the object to link, at the top level of the structure. See example of ILIST_DEF.

ILIST_DEF(name, type[, oplist])

Define the intrusive doubly-linked list and define the associated methods to handle it as "static inline" functions. 'name' shall be a C identifier that will be used to identify the list. It will be used to create all the types and functions to handle the container. It shall be done once per type and per compilation unit.

An object is expected to be part of only one list of a kind in the entire program at a time. An intrusive list enables to move from an object to the next object without needing to go through the entire list, or to remove an object from a list in O(1). It may, or may not, be better than standard list. It depends on the context.

The object oplist is expected to have the default operators. If there is no given oplist, the methods for a standard C type are used, or if there is a global defined oplist, it is used. The created methods will use the operators to init, set and clear the contained object.

The given interface won't allocate anything to handle the objects as all allocations and initialization are let to the user.

However the objects within the list can be automatically be cleared (by calling the CLEAR method to destruct the object) on list destruction. The memory allocation, performed by the called, can also be reclaimed by defining a DEL operator to free the used memory in the object oplist. If there is no DEL operator, it is up to the user to free the used memory.

Example:

    typedef struct test_s {
      int n;
      ILIST_INTERFACE (ilist_tname, struct test_s);
    } test_t;

    ILIST_DEF(ilist_tname, test_t)

    void f(void) {
            test_t x1, x2, x3;
            ilist_tname_t list;

            x1.n = 1;
            x2.n = 2;
            x3.n = 3;

            ilist_tname_init(list);
            ilist_tname_push_back (list, &x3);
            ilist_tname_push_front (list, &x1);
            ilist_tname_push_after (&x1, &x2);

            int n = 1;
            for M_EACH(item, list, ILIST_OPLIST(ilist_tname)) {
                    assert (n == item->n);
                    n++;
            }
            ilist_tname_clear(list);
    }

ILIST_DEF_AS(name, name_t, name_it_t, type[, oplist])

Same as SNAPSHOT_SPSC_DEF except the name of the types name_t, name_it_t are provided.

Created methods

The following methods are automatically and properly created by the previous macros. In the following methods, name stands for the name given to the macro that is used to identify the type.

name_t

Type of the list of 'type'.

name_it_t

Type of an iterator over this list.

The following methods are automatically and properly created by the previous macro.

void name_init(name_t list)

Initialize the list 'list' (aka constructor) to an empty list.

void name_init_field(type *obj)

Initialize the additional fields of the object '*obj'.

void name_clear(name_t list)

Clear the list 'list (aka destructor). The list can't be used anymore, except with a constructor. If the DEL operator is available in the oplist of the type, the cleared object will also be deleted.

void name_clean(name_t list)

Clean the list (the list becomes empty). The list remains initialized but is empty. If the DEL operator is available in the oplist of the type, the cleared object will also be deleted.

type *name_back(const name_t list)

Return a constant pointer to the data stored in the back of the list.

type *name_front(const name_t list)

Return a constant pointer to the data stored in the front of the list.

void name_push_back(name_t list, type *obj)

Push the object '*obj' itself at the back of the list 'list'.

void name_push_front(name_t list, type *obj)

Push the object '*obj' itself at the front of the list 'list'.

void name_push_after(type position, type obj)

Push the object '*obj' after the object '*position'.

type *name_pop_back(name_t list)

Pop the object from the back of the list 'list' and return a pointer to the popped object.

type *name_pop_front(name_t list)

Pop the object from the front of the list 'list' and return a pointer to the popped object.

bool name_empty_p(const name_t list)

Return true if the list is empty, false otherwise.

void name_swap(name_t list1, name_t list2)

Swap the list 'list1' and 'list2'.

void name_unlink(type *obj)

Remove the object '*obj' from the list.

type name_next_obj(const name_t list, const type obj)

Return the object that is after the object '*obj' in the list or NULL if there is no more object.

type name_previous_obj(const name_t list, const type obj)

Return the object that is before the object '*obj' in the list or NULL if there is no more object.

void name_it(name_it_t it, name_t list)

Set the iterator 'it' to the back(=first) element of 'list'. There is no destructor associated to this initialization.

void name_it_set(name_it_t it, const name_it_t ref)

Set the iterator 'it' to the iterator 'ref'. There is no destructor associated to this initialization.

void name_it_last(name_it_t it, name_t list)

Set the iterator 'it' to the last element of the list. There is no destructor associated to this initialization.

void name_it_end(name_it_t it, name_t list)

Set the iterator 'it' to the end of the list (i.e. not a valid element). There is no destructor associated to this initialization.

bool name_end_p(const name_it_t it)

Return true if the iterator doesn't reference a valid element anymore.

bool name_last_p(const name_it_t it)

Return true if the iterator references the last element or if the iterator doesn't reference a valid element anymore.

bool name_it_equal_p(const name_it_t it1, const name_it_t it2)

Return true if the iterator it1 references the same element than it2.

void name_next(name_it_t it)

Move the iterator 'it' to the next element of the list.

void name_previous(name_it_t it)

Move the iterator 'it' to the previous element of the list.

type *name_ref(name_it_t it)

Return a pointer to the element pointed by the iterator. This pointer remains valid until the list is modified by another method.

const type *name_cref(const name_it_t it)

Return a constant pointer to the element pointed by the iterator. This pointer remains valid until the list is modified by another method.

size_t name_size(const name_t list)

Return the number elements of the list (aka size). Return 0 if there no element.

void name_insert(name_t list, name_it_t it, type x)

Insert a copy of 'x' after the position pointed by 'it' (which is an iterator of the list 'list') or if 'it' doesn't point anymore to a valid element of the list, it is added as the back (=first) element of the 'list' This service is available only if a NEW operator is available for the type.

void name_remove(name_t list, name_it_t it)

Remove the element 'it' from the list 'list'. After wise, 'it' points to the next element of the list.

void name_splice_back(name_t list1, name_t list2, name_it_t it)

Move the element pointed by 'it' (which is an iterator of 'list2') from the list 'list2' to the back position of 'list1'. After wise, 'it' points to the next element of 'list2'.

void name_splice(name_t list1, name_t list2)

Move all the element of 'list2' into 'list1", moving the last element of 'list2' after the first element of 'list1'. After-wise, 'list2' is emptied.

M-CONCURRENT

This header is for transforming a standard container (LIST, ARRAY, DICT, DEQUE, ...) into an equivalent container but compatible with concurrent access by different threads. In practice, it puts a lock to access the container.

As such it is quite generic. However it is less efficient than containers specially tuned for multiple threads. There is also no iterators.

methods

CONCURRENT_DEF(name, type[, oplist])

Define the concurrent container 'name' based on container 'type' of oplist 'oplist', and define the associated methods to handle it as "static inline" functions. 'name' shall be a C identifier that will be used to identify the list. It will be used to create all the types and functions to handle the container. It shall be done once per type and per compilation unit.

It scans the 'oplist' of the type to create equivalent function, so it needs it (either explicitly or implicitly).

Example:

    /* Define a stack container (STACK)*/
    ARRAY_DEF(array1, int)
    CONCURRENT_DEF(parray1, array1_t, ARRAY_OPLIST(array1))

    /* Define a queue container (FIFO) */
    DEQUE_DEF(deque_uint, unsigned int)
    CONCURRENT_DEF(cdeque_uint, deque_uint_t, M_OPEXTEND(DEQUE_OPLIST(deque_uint, M_DEFAULT_OPLIST), PUSH(deque_uint_push_front)))

    extern parray1_t x1;
    extern cdeque_uint_t x2;

    void f(void) {
         parray1_push (x1, 17);
         cdeque_uint_push (x2, 17);
    }

CONCURRENT_DEF_AS(name, name_t, type[, oplist])

Same as CONCURRENT_DEF except the name of the type name_t is provided.

Created methods

The following methods are automatically and properly created by the previous macros. In the following methods, name stands for the name given to the macro that is used to identify the type.

name_t

Type of the concurrent container of 'type'.

void name_init(name_t concurrent)

Initialize the concurrent container. This method is only defined if the base container exports the INIT operator.

void name_init_set(name_t concurrent, const name_t src)

Initialize the concurrent container and set it with a copy of 'src'. This method is only defined if the base container exports the INIT_SET operator.

void name_init_move(name_t concurrent, name_t src)

Initialize the concurrent container by stealing as much resources from 'src' as possible. Afterwards 'src' is cleared. This method is only defined if the base container exports the INIT_MOVE operator.

void name_set(name_t concurrent, const name_t src)

Set the container with a copy of 'src'. This method is only defined if the base container exports the SET operator.

void name_move(name_t concurrent, name_t src)

Set the container with the value of 'src' by stealing as much resources from 'src' as possible. Afterwards 'src' is cleared. This method is only defined if the base container exports the MOVE operator.

void name_clean(name_t concurrent)

Clean the concurrent container. Afterwards the container is empty, but remains initialized. This method is only defined if the base container exports the CLEAN operator.

void name_clear(name_t concurrent)

Clear the concurrent container and destroy any resource. This method shall only be called in context when no other threads can use the resource. This method is only defined if the base container exports the CLEAR operator.

void name_swap(name_t concurrent1, name_t concurrent2)

Swap both containers. This method is only defined if the base container exports the SWAP operator.

bool name_empty_p(const name_t concurrent)

Return true if the container is empty, false otherwise. This method is only defined if the base container exports the EMPTY_P operator.

void name_set_at(name_t concurrent, key_t key, value_t value)

Associate to the key 'key' the value 'value' in the container. This method is only defined if the base container exports the SET_KEY operator.

bool name_get_copy(value_t *value, name_t concurrent, key_t key)

Read the value associated to the key 'key'. If it exists, it sets '*value' to it and returns true. Otherwise it returns false. This method is only defined if the base container exports the GET_KEY operator.

void name_get_at_copy(value_t *value, name_t concurrent, key_t key)

Read the value associated to the key 'key'. If it exists, it sets '*value' to it. Otherwise it creates a new value and sets '*value' to it. This method is only defined if the base container exports the GET_SET_KEY operator.

bool name_erase(name_t concurrent, const key_t key)

Erase the association for the key 'key'. Returns true in case of success, false otherwise. This method is only defined if the base container exports the ERASE_KEY operator.

void name_push(name_t concurrent, const subtype_t data)

Push data in the container. This method is only defined if the base container exports the PUSH operator.

void name_pop(subtype_t *data, name_t concurrent)

Pop data from the container and set it in '*data'. There shall be at least one data to pop. Testing with the operator EMPTY_P before calling this function is not enough as there can be some concurrent scenario where another thread pop the last value. name_pop_blocking should be used instead. This method is only defined if the base container exports the POP operator.

void name_push_move(name_t concurrent, subtype_t *data)

Push data in the container by stealing as much resources from data as possible. Afterwards, data is cleared. This method is only defined if the base container exports the PUSH_MOVE operator.

void name_pop_move(subtype_t *data, name_t concurrent)

Pop data from the container and initialize '*data' with it. name_pop_move_blocking should be used instead (See name_pop for details). This method is only defined if the base container exports the POP_MOVE operator.

void name_get_str(string_t str, name_t concurrent, bool append)

Convert the formatted container into a string representation of it and put it in 'str' This method is only defined if the base container exports the GET_STR operator.

void name_out_str(FILE *file, name_t concurrent)

Convert the formatted container into a string and put it in 'file'. This method is only defined if the base container exports the OUT_STR operator.

bool name_parse_str(name_t concurrent, const char str[], const char **end)

Convert the formatted string representing the container and set it 'concurrent' to it. Return true in case of success, false otherwise. This method is only defined if the base container exports the PARSE_STR operator.

bool name_in_str(name_t concurrent, FILE *file)

Read the file and convert the formatted string representing the container and set it 'concurrent' to it. Return true in case of success, false otherwise. This method is only defined if the base container exports the IN_STR operator.

bool name_equal_p(name_t concurrent1, name_t concurrent2)

Return true if both containers are equal, false otherwise. This method is only defined if the base container exports the EQUAL operator.

bool name_get_blocking(value_t *value, name_t concurrent, key_t key, bool blocking)

Read the value associated to the key 'key'. If it exists, it sets '*value' to it and returns true. Otherwise if blocking is true, it waits for the data to be filled. After the wait, it sets '*value' to it and returns true. Otherwise if blocking is false, it returns false. This method is only defined if the base container exports the GET_KEY operator.

bool name_pop_blocking(type_t *data, name_t concurrent, bool blocking)

Pop a value from the container and set '*data' with it. If the container is not empty, it sets '*data' and return true. Otherwise if blocking is true, it waits for the data to be pushed. After the wait, it sets '*data' to it and returns true. Otherwise if blocking is false, it returns false. This method is only defined if the base container exports the POP and EMPTY_P operators.

bool name_pop_move_blocking(type_t *data, name_t concurrent, bool blocking)

Pop a value from the container and initialize & set '*data' with it. If the container is not empty, it initializes & sets '*data' and return true. Otherwise if blocking is true, it waits for the data to be pushed. After the wait, it initializes & sets '*data' to it and returns true. Otherwise if blocking is false, it returns false (*data remains uninitialized!). This method is only defined if the base container exports the POP_MOVE and EMPTY_P operators.

size_t name_hash(name_t concurrent)

Return a value suitable for being a hash of the container. This method is only defined if the base container exports the HASH operator.

M-BITSET

This header is for using bitset.

A bitset can be seen as a specialized version of an array of bool, where each item takes only 1 bit. It enables for compact representation of such array.

Example:

    void f(void) {
            bitset_t set;
            bitset_init(set);
            for(int i = 0; i < 100; i ++)
                    bitset_push_back(set, i%2);
            bitset_clear(set);
    }

methods

The methods are mostly the same than for an array. The following methods are available:

bitset_t

This type defines a dynamic array of bit and is the primary type of the module.

bitset_it_t

This type defines an iterator over the bitset.

void bitset_init(bitset_t array)

Initialize the bitset 'array' (aka constructor) to an empty array.

void bitset_init_set(bitset_t array, const bitset_t ref)

Initialize the bitset 'array' (aka constructor) and set it to the value of 'ref'.

void bitset_set(bitset_t array, const bitset_t ref)

Set the bitset 'array' to the value of 'ref'.

void bitset_init_move(bitset_t array, bitset_t ref)

Initialize the bitset 'array' (aka constructor) by stealing as many resources from 'ref' as possible. Afterwards 'ref' is cleared.

void bitset_move(bitset_t array, bitset_t ref)

Set the bitset 'array' by stealing as many resources from 'ref' as possible. Afterwards 'ref' is cleared.

void bitset_clear(bitset_t array)

Clear the bitset 'array (aka destructor).

void bitset_clean(bitset_t array)

Clean the bitset (the bitset becomes empty but remains initialized).

void bitset_push_back(bitset_t array, const bool value)

Push a new element into the back of the bitset 'array' with the value 'value'.

void bitset_push_at(bitset_t array, size_t key, const bool x)

Push a new element into the position 'key' of the bitset 'array' with the value 'value' contained within. 'key' shall be a valid position of the array: from 0 to the size of array (included).

void bitset_pop_back(bool *data, bitset_t array)

Pop a element from the back of the bitset 'array' and set *data to this value if data is not NULL (if data is NULL, the popped data is cleared).

void bitset_pop_at(bool *dest, bitset_t array, size_t key)

Set *dest to the value the element 'key' if dest is not NULL, then remove the element 'key' from the bitset. 'key' shall be within the size of the bitset.

bool bitset_front(const bitset_t array)

Return the first element of the bitset. The bitset shall have at least one element.

bool bitset_back(const bitset_t array)

Return the last element of the bitset. The bitset shall have at least one element.

void bitset_set_at(bitset_t array, size_t i, bool value)

Set the element 'i' of bitset 'array' to 'value'. 'i' shall be within 0 to the size of the array (excluded).

void bitset_flip_at(bitset_t array, size_t i)

Flip the element 'i' of bitset 'array''. 'i' shall be within 0 to the size of the array (excluded).

bool bitset_get(bitset_t array, size_t i)

Return the element 'i' of the bitset. 'i' shall be within 0 to the size of the array (excluded).

bool bitset_empty_p(const bitset_t array)

Return true if the bitset is empty, false otherwise.

size_t bitset_size(const bitset_t array)

Return the size of the bitset.

size_t bitset_capacity(const bitset_t array)

Return the capacity of the bitset.

void bitset_resize(bitset_t array, size_t size)

Resize the bitset 'array' to the size 'size' (initializing or clearing elements).

void bitset_reserve(bitset_t array, size_t capacity)

Extend or reduce the capacity of the 'array' to a rounded value based on 'capacity'. If the given capacity is below the current size of the bitset, the capacity is set to the size of the bitset.

void bitset_swap(bitset_t array1, bitset_t array2)

Swap the bitsets 'array1' and 'array2'.

void bitset_swap_at(bitset_t array, size_t i, size_t j)

Swap the elements 'i' and 'j' of the bitset 'array'. 'i' and 'j' shall reference valid elements of the array.

void bitset_it(bitset_it_t it, bitset_t array)

Set the iterator 'it' to the first element of 'array'.

void bitset_it_last(bitset_it_t it, bitset_t array)

Set the iterator 'it' to the last element of 'array'.

void bitset_it_end(bitset_it_t it, bitset_t array)

Set the iterator 'it' to the end of 'array'.

void bitset_it_set(bitset_it_t it1, bitset_it_t it2)

Set the iterator 'it1' to 'it2'.

bool bitset_end_p(bitset_it_t it)

Return true if the iterator doesn't reference a valid element anymore.

bool bitset_last_p(bitset_it_t it)

Return true if the iterator references the last element of the array, or doesn't reference a valid element.

bool bitset_it_equal_p(const bitset_it_t it1, const bitset_it_t it2)

Return true if both iterators reference the same element.

void bitset_next(bitset_it_t it)

Move the iterator 'it' to the next element of the array.

void bitset_previous(bitset_it_t it)

Move the iterator 'it' to the previous element of the array.

const bool *bitset_cref(const bitset_it_t it)

Return a constant pointer to the element pointed by the iterator. This pointer remains valid until the array or the iterator is modified by another method.

void bitset_get_str(string_t str, const bitset_t array, bool append)

Generate a formatted string representation of the bitset 'array' and set 'str' to this representation (if 'append' is false) or append 'str' with this representation (if 'append' is true). This method is only defined if the header 'm-string.h' was included before including 'm-bitset.h'

bool bitset_parse_str(bitset_t array, const char str[], const char **endp)

Parse the formatted string 'str' that is assumed to be a string representation of a bitset and set 'array' to this representation. It returns true if success, false otherwise. If endp is not NULL, it sets '*endp' to the pointer of the first character not decoded by the function.

void bitset_out_str(FILE *file, const bitset_t array)

Generate a formatted string representation of the bitset 'array' and outputs it into the FILE 'file'.

void bitset_in_str(bitset_t array, FILE *file)

Read from the file 'file' a formatted string representation of a bitset and set 'array' to this representation.

bool bitset_equal_p(const bitset_t array1, const bitset_t array2)

Return true if both bitsets 'array1' and 'array2' are equal.

size_t bitset_hash(const bitset_t array)

Return a hash value of 'array'.

void bitset_and(bitset_t dst, const bitset_t src)

Perform a bitwise AND operation in 'dst' between 'dst' and 'src' (effectively performing an intersection of the sets).

void bitset_or(bitset_t dst, const bitset_t src)

Perform a bitwise OR operation in 'dst' between 'dst' and 'src' (effectively performing an union of the sets).

void bitset_xor(bitset_t dst, const bitset_t src)

Perform a bitwise XOR operation in 'dst' between dst and src.

void bitset_not(bitset_t dst)

Perform a bitwise NOT operation for dst.

size_t bitset_clz(const bitset_t src)

Return the leading zero position in 'src' (Count Leading Zero).

size_t bitset_popcount(const bitset_t src)

Count the number of '1' in 'src'.

M-STRING

This header is for using dynamic string. The size of the string is automatically updated in function of the needs.

Example:

    void f(void) {
            string_t s1;
            string_init (s1);
            string_set_str (s1, "Hello, world!");
            string_clear(s1);
    }

methods

The following methods are available:

string_t

This type defines a dynamic string and is the primary type of the module. The provided methods are just handy wrappers to the C library, providing few algorithms on its own.

STRING_FAILURE

Constant Macro defined as the index value returned in case of error. (equal as -1U).

string_fgets_t

This type defines the different enumerate value for the string_fgets function:

STRING_READ_LINE: read a full line until the EOL character (included),
STRING_READ_PURE_LINE: read a full line until the EOL character (excluded),
STRING_READ_FILE: read the full file.

void string_init(string_t str)

Init the string 'str' to an empty string.

void string_clear(string_t str)

Clear the string 'str' and frees any allocated memory.

char *string_clear_get_str(string_t v)

Clear the string 'str' and returns the allocated array of char, representing a C string, giving back ownership of this array to the caller. This array will have to be freed. It can return NULL if no array was allocated by the string.

void string_clean(string_t str)

Set the string 'str' to an empty string.

size_t string_size(const string_t str)

Return the size in bytes of the string. It can be also the number of characters of the string if the encoding type is one character per byte. If the characters are encoded as UTF8, the function string_length_u is preferred.

size_t string_capacity(const string_t str)

Return the capacity in bytes of the string. The capacity is the number of bytes the string accept before a reallocation of the underlying array of char has to be performed.

char string_get_char(const string_t v, size_t index)

Return the byte 'index' of the string 'v'. 'index' shall be within the allowed range of bytes of the string.

bool string_empty_p(const string_t v)

Return true if the string is empty, false otherwise.

void string_reserve(string_t v, size_t alloc)

Update the capacity of the string to be able to receive at least 'alloc' bytes. Calling with 'alloc' lower or equal than the size of the string enables the function to perform a shrink of the string to its exact needs. If the string is empty, it will free the memory.

void string_set_str(string_t v, const char str[])

Set the string to the array of char 'str'. 'str' is supposed to be 0 terminated as any C string.

void string_set_strn(string_t v, const char str[], size_t n)

Set the string to the array of char 'str' by copying at most 'n' char from the array. 'str' is supposed to be 0 terminated as any C string.

const char* string_get_cstr(const string_t v)

Return a constant pointer to the underlying array of char of the string. This array of char is terminated by 0, enabling the pointer to be passed to standard C function. The pointer remains valid until the string itself remains valid and the next call to a function that updates the string.

void string_set (string_t v1, const string_t v2)

Set the string 'v1' to the value of the string 'v2'.

void string_set_n(string_t v, const string_t ref, size_t offset, size_t length)

Set the string to the value of the string 'ref' by skipping the first 'offset' char of the array of char of 'ref' and copying at most 'length' char in the remaining array of characters of 'ref'. 'offset' shall be within the range of index of the string 'ref'. 'ref' and 'v' cannot be the same string.

void string_init_set(string_t v1, const string_t v2)

Initialize 'v1' to the value of the string 'v2'.

void string_init_set_str(string_t v1, const char str[])

Initialize 'v1' to the value of the array of char 'str'. The array of char shall be terminated with 0.

void string_init_move(string_t v1, string_t v2)

Initialize 'v1' by stealing as most resource from 'v2' as possible and clear 'v2' afterward.

void string_move(string_t v1, string_t v2)

Set 'v1' by stealing as most resource from 'v2' as possible and clear 'v2' afterward.

void string_swap(string_t v1, string_t v2)

Swap the content of both strings.

void string_push_back (string_t v, char c)

Append the character 'c' to the string 'v'

void string_cat_str(string_t v, const char str[])

Append the array of char 'str' to the string 'v'. The array of char shall be terminated with 0.

void string_cat(string_t v, const string_t v2)

Append the string 'v2' to the string 'v'. NOTE: v2 can also be a 'const char *' in C11.

void string_cats(string_t v, const string_t v2[, ...] )

Append all the strings 'v2' ... to the string 'v'. NOTE: v2 can also be a 'const char *' in C11.

void string_sets(string_t v, const string_t v2[, ...] )

Set the string 'v' to the concatenation of all the strings 'v2' NOTE: v2 can also be a 'const char *' in C11.

int string_cmp_str(const string_t v1, const char str[])

int string_cmp(const string_t v1, const string_t str)

Perform a byte comparison of both string by using the strcmp function and return the result of this comparison.

bool string_equal_str_p(const string_t v1, const char str[])

Return true if the string is equal to the array of char, false otherwise.

bool string_equal_p(const string_t v1, const string_t v2)

Return true if both strings are equal, false otherwise.

int string_cmpi_str(const string_t v, const char str[])

int string_cmpi(const string_t v, const string_t str)

This function compares both strings by ignoring the difference due to the case. This function doesn't work with UTF-8 strings. It returns a negative integer if the string is before the array, 0 if there are equal, a positive integer if the string is after the array.

size_t string_search_char (const string_t v, char c [, size_t start])

Search for the character 'c' in the string from the offset 'start'. 'start' shall be within the valid ranges of offset of the string. 'start' is an optional argument. If it is not present, the default value 0 is used instead. This doesn't work if the function is used as function pointer. Return the offset of the string where the character is first found, or STRING_FAILURE otherwise.

size_t string_search_rchar (const string_t v, char c [, size_t start])

Search backwards for the character 'c' in the string from the offset 'start'. 'start' shall be within the valid ranges of offset of the string. 'start' is an optional argument. If it is not present, the default value 0 is used instead. This doesn't work if the function is used as function pointer. Return the offset of the string where the character is last found, or STRING_FAILURE otherwise.

size_t string_search_str (const string_t v, char str[] [, size_t start])

size_t string_search (const string_t v, string_t str [, size_t start])

Search for the string 'str' in the string from the offset 'start'. 'start' shall be within the valid ranges of offset of the string. 'start' is an optional argument. If it is not present, the default value 0 is used instead. This doesn't work if the function is used as function pointer. Return the offset of the string where 'str' is first found, or STRING_FAILURE otherwise.

size_t string_pbrk(const string_t v, const char first_of[] [, size_t start])

Search for the first occurrence in the string 'v' from the offset 'start' of any of the bytes in the string 'first_of'. 'start' shall be within the valid ranges of offset of the string. 'start' is an optional argument. If it is not present, the default value 0 is used instead. This doesn't work if the function is used as function pointer. Return the offset of the string where 'str' is first found, or STRING_FAILURE otherwise.

int string_strcoll_str(const string_t str1, const char str2[])

int string_strcoll(const string_t str1, const string_t str2[])

Compare the two strings str1 and str2. It returns an integer less than, equal to, or greater than zero if 's1' is found, respectively, to be less than, to match, or be greater than s2. The comparison is based on strings interpreted as appropriate for the program's current locale.

size_t string_spn(const string_t v1, const char accept[])

Calculate the length (in bytes) of the initial segment of the string that consists entirely of bytes in accept.

size_t string_cspn(const string_t v1, const char reject[])

Calculate the length (in bytes) of the initial segment of the string that consists entirely of bytes not in reject.

void string_left(string_t v, size_t index)

Keep at most the 'index' left bytes of the string, terminating the string at the given index. index can be out of range.

void string_right(string_t v, size_t index)

Keep the right part of the string, after the index 'index'.

void string_mid (string_t v, size_t index, size_t size)

Extract the medium string from offset 'index' and up to 'size' bytes.

size_t string_replace_str (string_t v, const char str1[], const char str2[] [, size_t start])

size_t string_replace (string_t v, const string_t str1, const string_t str2 [ , size_t start])

Replace in the string 'v' from the offset 'start' the string 'str1' by the string 'str2' once. Returns the offset of the replacement or STRING_FAILURE if no replacement was performed. str1 shall be a non empty string.

size_t string_replace_all_str (string_t v, const char str1[], const char str2[])

size_t string_replace_all (string_t v, const string_t str1, const string_t str2)

Replace in the string 'v' all the occurrences of the string 'str1' by the string 'str2'. str1 shall be a non empty string.

void string_replace_at (string_t v, size_t pos, size_t len, const char str2[])

Replace in the string 'v' the sub-string defined as starting from 'pos' and of size 'len' by the string str2. It assumes that pos+len is before the end of the string of 'v'.

void string_init_printf(string_t v, const char format[], ...)

Initialize 'v' to the formatted string 'format' with the given variable argument lists. 'format' is like the printf function family.

void string_init_vprintf(string_t v, const char format[], va_list args)

Initialize 'v' to the formatted string 'format' with the given variable argument lists 'args'. 'format' is like the printf function family.

int string_printf (string_t v, const char format[], ...)

Set the string 'v' to the formatted string 'format'. 'format' is like the printf function family with the given variable argument list. Return the number of characters printed (excluding the final null char), or a negative value in case of error.

int string_vprintf (string_t v, const char format[], va_list args)

Set the string 'v' to the formatted string 'format'. 'format' is like the vprintf function family with the variable argument list 'args'. Return the number of characters printed (excluding the final null char), or a negative value in case of error.

int string_cat_printf (string_t v, const char format[], ...)

Appends to the string 'v' the formatted string 'format'. 'format' is like the printf function family.

bool string_fgets(string_t v, FILE *f, string_fgets_t arg)

Read from the opened file 'f' a stream of characters and set 'v' with this stream. It stops after the character end of line if arg is STRING_READ_PURE_LINE or STRING_READ_LINE, and until the end of the file if arg is STRING_READ_FILE. If arg is STRING_READ_PURE_LINE, the character end of line is removed from the string. Return true if something has been read, false otherwise.

bool string_fget_word (string_t v, const char separator[], FILE *f)

Read a word from the file 'f' and set 'v' with this word. A word is separated from another by the list of characters in the array 'separator'. (Example: "^ \t.\n"). It is highly recommended for separator to be a constant string. 'separator' shall be at most composed of 100 characters (as bytes).

void string_fputs(FILE *f, const string_t v)

Put the string in the file.

bool string_start_with_str_p(const string_t v, const char str[])

bool string_start_with_string_p(const string_t v, const string_t str)

Return true if the string starts with the same characters than 'str', false otherwise.

bool string_end_with_str_p(const string_t v, const char str[])

bool string_end_with_string_p(const string_t v, const string_t str)

Return true if the string ends with the same characters than 'str', false otherwise.

size_t string_hash(const string_t v)

Return a hash of the string.

void string_strim(string_t v [, const char charTab[]])

Remove from the string any leading or trailing space-like characters (space or tabulation or end of line). If 'charTab' is given, it get the list of characters to remove from this argument.

bool string_oor_equal_p(const string_t v, unsigned char n)

Provide the OOR_EQUAL_P method of a string.

void string_oor_set(string_t v, unsigned char n)

Provide the OOR_SET method of a string.

void string_get_str(string_t v, const string_t v2, bool append)

Convert a string into a formatted string usable for I/O: Outputs the input string with quote around, replacing any " by \" within the string into the output string.

bool string_parse_str(string_t v, const char str[], const char **endp)

Parse the formatted string 'str' that is assumed to be a string representation of a string and set 'v' to this representation. This method is only defined if the type of the element defines a PARSE_STR method itself. It returns true if success, false otherwise. If endp is not NULL, it sets '*endp' to the pointer of the first character not decoded by the function.

void string_out_str(FILE *f, const string_t v)

Write a string into a FILE as a formatted string: Outputs the input string while quoting around, replacing any " by \" within the string, and quote special characters.

bool string_in_str(string_t v, FILE *f)

Read a formatted string from a FILE. The string shall follow the formatting rules of string_out_str. It returns true if it has successfully parsed the string, false otherwise. In this case, the position within the FILE is undefined.

string_unicode_t

Define a type suitable to store a unicode character.

string_it_t

Define an iterator over the string, enabling to iterate the string over UTF8 encoded character.

void string_it(string_it_t it, const string_t str)

Initialize the iterator 'it' to iterate over the string 'str' over UTF8 encoded character.

bool string_end_p (string_it_t it)

Return true if the iterator has reached the end of the string, false otherwise.

void string_next (string_it_t it)

Move the iterator to the next UTF8 encoded character. string_end_p shall have been called at least once per UTF8 character before.

string_unicode_t string_get_cref (const string_it_t it)

Return the unicode character associated to the UTF8 encoded character pointer by the iterator. string_end_p shall have been called at least once per UTF8 character before. It returns -1 in case of error in decoding the UTF8 string.

void string_push_u (string_t str, string_unicode_t u)

Push the unicode character 'u' into the string 'str' encoding it as a UTF8 encoded characters.

size_t string_length_u(string_t str)

Return the number of UTF8 encoded characters in the string.

bool string_utf8_p(string_t str)

Return true if the string is a valid UTF8, false otherwise. It doesn't check for unique canonical form for UTF8 string, so it may report 'true' whereas the string is not strictly conforming.

STRING_CTE(string)

Macro to convert a constant array string into a temporary string_t variable suitable only for being called within a function.

STRING_OPLIST

The oplist of a string_t

BOUNDED_STRING_DEF(name, size)

aka char[N+1] TODO: Document the API.

M-CORE

This header is the internal core of M*LIB, providing a lot of functionality by extending a lot the preprocessing capability. Working with these macros is not easy and the developer needs to know how the macro preprocessing works. It also adds the needed macro for handling the oplist. As a consequence, it is needed by all other header files.

Some macros are using recursion to work. This is not an easy feat to do as it needs some tricks to work (see reference). This still work well with only one major limitation: it can not be chained. For example, if MACRO is a macro implementing recursion, then MACRO(MACRO()) won't work.

Example:

    M_MAP(f, 1, 2, 3, 4)
    M_REDUCE(f, g, 1, 2, 3, 4)
    M_SEQ(1, 20, f)

Compiler Macros

The following compiler macros are available:

M_ASSUME(cond)

M_ASSUME is equivalent to assert, but gives hints to compiler about how to optimize the code if NDEBUG is defined.

M_LIKELY(cond) / M_UNLIKELY(cond)

M_LIKELY / M_UNLIKELY gives hints on the compiler of the likelihood of the given condition.

Preprocessing macro extension

M_MAX_NB_ARGUMENT

Maximum default number of argument that can be handled by this header. It is currently 52 (even if some local macros may have increased this limit).

M_C(a,b)

M_C3(a,b,c)

M_C4(a,b,c,d)

Return a symbol corresponding to the concatenation of the input arguments.

M_INC(number)

Increment the number given as argument and return a pre-processing token corresponding to this value (meaning it is evaluated at macro processing stage, not at compiler stage). The number shall be within the range [0..M_MAX_NB_ARGUMENT-1].

M_DEC(number)

Decrement the number given as argument and return a pre-processing token corresponding to this value (meaning it is evaluated at macro processing stage, not at compiler stage). The number shall be within the range [1..M_MAX_NB_ARGUMENT].

M_ADD(x, y)

Return x+y (resolution is performed at preprocessing time). x, y shall be within [0..M_MAX_NB_ARGUMENT]. If the result is not in [0..M_MAX_NB_ARGUMENT+1], it returns M_OVERFLOW.

M_SUB(x, y)

Return x-y (resolution is performed at preprocessing time). x, y shall be within [0..M_MAX_NB_ARGUMENT]. If the result is not in [0..M_MAX_NB_ARGUMENT], it returns M_UNDERFLOW.

M_BOOL(cond)

Convert an integer or a symbol into 0 (if 0) or 1 (if not 0 or symbol unknown). Return a pre-processing token corresponding to this value (meaning it is evaluated at macro processing stage, not at compiler stage).

M_INV(cond)

Inverse 0 into 1 and 1 into 0. It is undefined if cond is not 0 or 1 (use M_BOOL to convert). Return a pre-processing token corresponding to this value (meaning it is evaluated at macro processing stage, not at compiler stage).

M_AND(cond1, cond2)

Perform a logical 'and' between cond1 and cond2. cond1 and cond2 shall be 0 or 1. (You should use M_bool to convert this parameter otherwise). Return a pre-processing token corresponding to this value (meaning it is evaluated at macro processing stage, not at compiler stage).

M_OR(cond1, cond2)

Perform a logical 'or' between cond1 and cond2. cond1 and cond2 shall be 0 or 1. (You should use M_bool to convert this parameter otherwise). Return a pre-processing token corresponding to this value (meaning it is evaluated at macro processing stage, not at compiler stage).

M_NOTEQUAL(x, y)

Return 1 if x != y, 0 otherwise (resolution is performed at preprocessing time). x and y shall be within [0..M_MAX_NB_ARGUMENT].

M_EQUAL(x, y)

Return 1 if x == y, 0 otherwise (resolution is performed at preprocessing time). x and y shall be within [0..M_MAX_NB_ARGUMENT].

M_LESS_THAN_P(x, y)

Return 1 if x < y, 0 otherwise (resolution is performed at preprocessing time). x and y shall be within [0..M_MAX_NB_ARGUMENT].x

M_LESS_OR_EQUAL_P(x, y)

Return 1 if x <= y, 0 otherwise (resolution is performed at preprocessing time). x and y shall be within [0..M_MAX_NB_ARGUMENT].x

M_GREATER_OR_EQUAL_P(x, y)

Return 1 if x >= y, 0 otherwise (resolution is performed at preprocessing time). x and y shall be within [0..M_MAX_NB_ARGUMENT].x

M_GREATER_THAN_P(x, y)

Return 1 if x > y, 0 otherwise (resolution is performed at preprocessing time). x and y shall be within [0..M_MAX_NB_ARGUMENT].x

M_COMMA_P(arglist)

Return 1 if there is a comma inside the argument list, 0 otherwise. Return a pre-processing token corresponding to this value (meaning it is evaluated at macro processing stage, not at compiler stage).

M_EMPTY_P(expression)

Return 1 if the argument 'expression' is 'empty', 0 otherwise. Return a pre-processing token corresponding to this value (meaning it is evaluated at macro processing stage, not at compiler stage).

NOTE: It should work for a wide range of inputs except when it is called with a macro function that takes more than one argument and without its arguments (in which case it generates a compiler error).

M_PARENTHESIS_P(expression)

Return 1 if the argument 'expression' starts a parenthesis and ends it (like '(...)'), 0 otherwise. Return a pre-processing token corresponding to this value (meaning it is evaluated at macro processing stage, not at compiler stage).

M_KEYWORD_P(reference_keyword, get_keyword)

Return 1 if the argument 'get_keyword' is equal to 'reference_keyword', 0 otherwise. reference_keyword shall be a keyword in the following list:

and
or
add (or sum, they are considered equivalent)
mul (or product, they are considered equivalent)
void
bool
char
short
int
long
float
double
TYPE
SUBTYPE
IT_TYPE
M_OVERFLOW
M_UNDERFLOW

M_IF(cond)(action_if_true, action_if_false)

Return the pre-processing token 'action_if_true' if 'cond' is true, action_if_false otherwise (meaning it is evaluated at macro processing stage, not at compiler stage).

cond shall be a 0 or 1 as a preprocessing constant. (You should use M_bool to convert this parameter otherwise).

M_IF_EMPTY(cond)(action_if_true, action_if_false)

Return the pre-processing token 'action_if_true' if 'cond' is empty, action_if_false otherwise (meaning it is evaluated at macro processing stage, not at compiler stage).

cond shall be a preprocessing constant equal to 0 or 1. (You should use M_bool to convert this parameter otherwise).

M_DELAY1(expr)

M_DELAY2(expr)

M_DELAY3(expr)

M_DELAY4(expr)

M_ID

Delay the evaluation by 1, 2, 3 or 4 steps. This is necessary to write macros that are recursive. The argument is a macro-function that has to be deferred. M_ID is an equivalent of M_DELAY1.

M_EVAL(expr)

Perform a complete stage evaluation of the given expression, removing recursive expression within it. Only ONE M_EVAL expression is expected in the evaluation chain. Can not be chained.

M_APPLY(func, args...)

Apply 'func' to '(args...) ensuring that a() isn't evaluated until all 'args' have been also evaluated. It is used to delay evaluation.

M_EAT(...)

Clobber the input, whatever it is.

M_RET_ARG'N'(arglist...)

Return the argument 'N' of the given arglist. N shall be within [1..76]. The argument shall exist in the arglist. The arglist shall have at least one more argument that 'N'.

M_GET_AT(list, index)

Return the index 'index' of the list 'list', which is a list of arguments encapsulated with parenthesis, (it is not a true C array). Return the pre-processing token corresponding to this value (meaning it is evaluated at macro processing stage, not at compiler stage).

    M_GET_AT((f_0,f_1,f_2),1)
    ==>
    f_1

M_SKIP_ARGS(N,...)

Skip the Nth first arguments of the argument list. N shall be within [0..M_MAX_NB_ARGUMENT].

    M_SKIP_ARGS(2, a, b, c, d)
    ==>
    c, d

M_KEEP_ARGS(N,...)

Keep the Nth first arguments of the argument list. N shall be within [0..M_MAX_NB_ARGUMENT].

    M_KEEP_ARGS(2, a, b, c, d)
    ==>
    a, b

M_MID_ARGS(first, len,...)

Keep the medium arguments of the argument list, starting from the 'first'-th one (zero based) and up to 'len' arguments. first and len shall be within [0..M_MAX_NB_ARGUMENT]. first+len shall be within the argument of the argument list.

    M_MID_ARGS(2, 1, a, b, c, d)
    ==>
    c

M_REVERSE(args...)

Reverse the argument list.

    M_REVERSE(a, b, c, d)
    ==>
    d, c, b, a

M_MAP(func, args...)

Apply 'func' to each argument of the 'args...' list of argument.

  M_MAP(f, 1, 2, 3)
  ==>
  f(1) f(2) f(3)

M_MAP_C(func, args...)

Apply 'func' to each argument of the 'args...' list of argument, putting a comma between each expanded 'func(argc)'

  M_MAP_C(f, 1, 2, 3)
  ==>
  f(1) , f(2) , f(3)

M_MAP2(func, data, args...)

Apply 'func' to each couple '(data, argument)' with argument an element of the 'args...' list.

  M_MAP2(f, d, 1, 2, 3)
  ==>
  f(d, 1) f(d, 2) f(d, 3)

M_MAP2_C(func, data, args...)

Apply 'func' to each couple '(data, argument)' with argument an element of the 'args...' list, putting a comma between each expanded 'func(argc)'

  M_MAP2_C(f, d, 1, 2, 3)
  ==>
  f(d, 1) , f(d, 2) , f(d, 3)

M_MAP3(func, data, args...)

Apply 'func' to each tuple '(data, number, argument)' with argument an element of the 'args...' list and number from 1 to N (the index of the list).

  M_MAP3(f, d, a, b, c)
  ==>
  f(d, 1, a) f(d, 2, b) f(d, 3, c)

M_MAP3_C(func, data, args...)

Apply 'func' to each tuple '(data, number, argument)' with argument an element of the 'args...' list, and number from 1 to N (the index of the list) putting a comma between each expanded 'func(argc)'

  M_MAP3_C(f, d, a, b, c)
  ==>
  f(d, 1, a) , f(d, 2, b) , f(d, 3, c)

M_MAP_PAIR(func, args...)

Map a macro to all given pair of arguments (Using recursion). Can not be chained.

  M_MAP_PAIR(f, a, b, c, d)
  ==>
  f(a, b) f(c, d)

M_REDUCE(funcMap, funcReduce, args...)

Map the macro funcMap to all given arguments 'args' and reduce all theses computation with the macro 'funcReduce'.

    M_REDUCE(f, g, a, b, c)
    ==>
    g( f(a) , g( f(b) , f(c) ) )

M_REDUCE2(funcMap, funcReduce, data, args...)

Map the macro funcMap to all pair (data, arg) of the given argument list 'args' and reduce all theses computation with the macro 'funcReduce'.

    M_REDUCE2(f, g, d, a, b, c)
    ==>
    g( f(d, a) , g( f(d, b) , f(d, c) ) )

M_REDUCE3(funcMap, funcReduce, data, args...)

Map the macro funcMap to all tuple (data, number arg) of the given argument list 'args' with number from 1 to N( the size of args) and reduce all theses computation with the macro 'funcReduce'.

    M_REDUCE3(f, g, d, a, b, c)
    ==>
    g( f(d, 1, a) , g( f(d, 2, b) , f(d, 3, c) ) )

M_SEQ(init, end)

Generate a sequence of number from 'init' to 'end'

    M_SEQ(1, 6)
    ==>
    1,2,3,4,5,6

M_REPLICATE(N, value)

Replicate the value 'value' N times.

    M_REPLICATE(5, D)
    ==>
    D D D D D

M_REPLICATE_C(N, value)

Replicate the value 'value' N times, separating then by commas.

    M_REPLICATE_C(5, D)
    ==>
    D , D , D , D , D

M_FILTER(func, data, ...)

Filter the arglists by keeping only the element that match the function 'func(data, element)'

   M_FILTER(M_NOTEQUAL, 8, 1, 3, 4, 8, 9, 8, 10)
   ==>
   1 3 4 9 10

M_FILTER_C(func, data, ...)

Filter the arglists by keeping only the element that match the function 'func(data, element)' separated by commas.

   M_FILTER(M_NOTEQUAL, 8, 1, 3, 4, 8, 9, 8, 10)
   ==>
   1 , 3 , 4 , 9 , 10

M_NARGS(args...)

Return the number of argument of the given list. args shall not be an empty argument.

M_IF_NARGS_EQ1(argslist)(action_if_one_arg, action_otherwise)

Return the pre-processing token 'action_if_one_arg' if 'argslist' has only one argument, action_otherwise otherwise (meaning it is evaluated at macro processing stage, not at compiler stage).

M_IF_NARGS_EQ2(argslist)(action_if_two_arg, action_otherwise)

Return the pre-processing token 'action_if_two_arg' if 'argslist' has two arguments, action_otherwise otherwise (meaning it is evaluated at macro processing stage, not at compiler stage).

M_IF_DEBUG(action)

Return the pre-processing token 'action' if the build is compiled in debug mode (i.e. NDEBUG is undefined).

M_IF_DEFAULT1(default_value, argumentlist)

Helper macro to redefine a function with a default value. If there is only one variable as the argument list, print the variable of the argument list then ', value', instead only print the argument list (and so two arguments).

   int f(int a, int b);
   #define f(...) M_APPLY(f, M_IF_DEFAULT1(0, __VA_ARGS__))

This need to be called within a M_APPLY macro.

Experimental macro. It may dissapear or change in a broken way.

M_DEFAULT_ARGS(nbExpectedArg, (defaultArgumentlist), argumentList )

Helper macro to redefine a function with one or more default values. defaultArgumentlist is a list of the default value to complete the list argumentList to reach the number nbExpectedArg arguments. Example: int f(int a, int b, long p, void *q); #define f(...) f(M_DEFAULT_ARGS(4, (0, 1, NULL), VA_ARGS)) The last 3 arguments have their default value as 0 (for b), 1 (for p) and NULL (for q).

Experimental macro. It may dissapear or change in a broken way.

M_DEFERRED_COMMA

Return a comma ',' at a later phase of the macro processing steps (delay evaluation).

M_AS_STR(expression)

Return the string representation of the evaluated expression.

C11 Macro

Theses macros are only valid if the program is built in C11 mode:

M_PRINTF_FORMAT(x)

Return the printf format associated to the type of 'x'. 'x' shall be a basic C variable, printable with printf.

M_PRINT_ARG(x)

Print using printf the variable 'x'. The format of 'x' is deduced provided that it is a standard numerical C type.

M_FPRINT_ARG(file, x)

Print into a file 'file' using fprintf the variable 'x'. The format of 'x' is deduced provided that it is a standard numerical C type.

M_GET_STRING_ARG(string,x,append)

Print into the string_t 'string' the variable 'x'. The format of 'x' is deduced provided that it is a standard numerical C type. It needs the header 'm-string.h' for working (this macro is only a wrapper around it).

M_PRINT(args...)

Print using printf all the variable in 'args'. The format of the arguments are deduced provided that it is a standard numerical C type.

M_FPRINT(file, args...)

Print into a file 'file' using fprintf all the variables in 'args'. The format of the arguments are deduced provided that it is a standard numerical C type.

M_AS_TYPE(type, x)

Within a C11 _Generic statement, all expressions must be valid C expression even if the case if always false, and is not executed. This can seriously limit the _Generic statement. This macro overcomes this limitation by returning :

either the input 'x' if it is of type 'type',
or the value 0 view as a type 'type'.

So the returned value is always of type 'type' and is safe in a _Generic statement.

C Macro

Theses macros expand their code at compilation level:

M_MIN(x, y)

Return the minimum of 'x' and 'y'. x and y shall not have any side effect.

M_MAX(x, y)

Return the maximum of 'x' and 'y'. x and y shall not have any side effect.

M_POWEROF2_P(n)

Return true if 'n' is a power of 2. n shall not have any side effect.

M_SWAP(type, a, b)

Swap the values of 'a' and 'b'. 'a' and 'b' are of type 'type'. a and b shall not have any side effect.

M_ASSIGN_CAST(type, a)

Check if 'a' can be assigned to a temporary of type 'type' and returns this temporary. If it cannot, the compilation failed.

M_CONST_CAST(type, a)

Check if 'a' can be properly casted to (const type *) and returns this casted pointer if possible. If it cannot, the compilation failed.

M_TYPE_FROM_FIELD(type, ptr, fieldType, field)

Assuming 'ptr' is a pointer to a fieldType object that is stored within a structure of type 'type' at the position 'field', it returns a pointer to the structure. NOTE: It is equivalent to the container_of macro of the Linux kernel.

M_CSTR(format, ...)

Return a constant string constructed based on the printf-liked formated string and its arguments.

The string is constructed at run time and uses a temporary space on the stack. If the constructed string is longer than M_USE_CSTR_ALLOC-1, the string is truncated. Example:

    strcmp( M_CSTR("Len=%d", 17) , "Len=17" ) == 0

HASH Functions

M_USE_HASH_SEED

A User modifiable macro defining the initial random seed (of type size_t). It shall be define before including any header of M*LIB, so that hash functions use this variable as their initial seed for their hash computation of an object. It can be used to generate less predictable hash values at runtime, which may protect against DOS dictionary attacks. It shall be unique for a running instance of M*LIB. Note that using a random seed is not enough to protect efficienly againt such attacks. A cryptographic secure hash may be also needed. If it is not defined, the default is to use the value 0, making all hash computations predictable.

M_HASH_DECL(hash)

Declare and initialize a new hash computation, named 'hash' that is an integer.

M_HASH_UP(hash, value)

Update the 'hash' variable with the given 'value' by incorporating the 'value' within the 'hash'. 'value' can be up to a 'size_t' variable.

uint32_t m_core_rotl32a (uint32_t x, uint32_t n)

uint64_t m_core_rotl64a (uint64_t x, uint32_t n)

Perform a rotation of 'n' bits of the input 'x'. n shall be within 1 and the number of bits of the type minus 1.

uint64_t m_core_roundpow2(uint64_t v)

Round to the next highest power of 2.

unsigned int m_core_clz32(uint32_t limb)

unsigned int m_core_clz64(uint64_t limb)

Count the number of leading zero and return it. limb can be 0.

size_t m_core_hash (const void *str, size_t length)

Compute the hash of the binary representation of the data pointer by 'str' of length 'length'. 'str' shall have the same alignment restriction than a 'size_t'.

OPERATORS Functions

M_GET_INIT oplist

M_GET_INIT_SET oplist

M_GET_INIT_MOVE oplist

M_GET_SET oplist

M_GET_MOVE oplist

M_GET_SWAP oplist

M_GET_CLEAR oplist

M_GET_NEW oplist

M_GET_DEL oplist

M_GET_REALLOC oplist

M_GET_FREE oplist

M_GET_MEMPOOL oplist

M_GET_MEMPOOL_LINKAGE oplist

M_GET_HASH oplist

M_GET_EQUAL oplist

M_GET_CMP oplist

M_GET_UPDATE oplist

M_GET_TYPE oplist

M_GET_SUBTYPE oplist

M_GET_OPLIST oplist

M_GET_SORT oplist

M_GET_IT_TYPE oplist

M_GET_IT_FIRST oplist

M_GET_IT_LAST oplist

M_GET_IT_END oplist

M_GET_IT_SET oplist

M_GET_IT_END_P oplist

M_GET_IT_LAST_P oplist

M_GET_IT_EQUAL_P oplist

M_GET_IT_NEXT oplist

M_GET_IT_PREVIOUS oplist

M_GET_IT_REF oplist

M_GET_IT_CREF oplist

M_GET_IT_REMOVE oplist

M_GET_IT_INSERT oplist

M_GET_ADD oplist

M_GET_SUB oplist

M_GET_MUL oplist

M_GET_DIV oplist

M_GET_CLEAN oplist

M_GET_PUSH oplist

M_GET_POP oplist

M_GET_REVERSE oplist

M_GET_GET_STR oplist

M_GET_OUT_STR oplist

M_GET_IN_STR oplist

M_GET_SEPARATOR oplist

M_GET_EXT_ALGO oplist

M_GET_INC_ALLOC oplist

M_GET_OOR_SET oplist

M_GET_OOR_EQUAL oplist

Return the associated method to the given operator within the given oplist.

M_BOOL_OPLIST

Default oplist for C standard Boolean.

M_DEFAULT_OPLIST

Default oplist for C standard types (int & float)

M_ENUM_OPLIST(type, init_value)

Default oplist for a C standard enumerate of type 'type', and of initial value 'init_value'

M_CSTR_OPLIST

Default oplist for the C type const char *, seen as a constant string.

M_POD_OPLIST

Default oplist for a structure C type without any init & clear prerequisites (plain old data).

M_A1_OPLIST

Default oplist for an array of size 1 of a structure C type without any init & clear prerequisites.

M_EMPTY_OPLIST

Default oplist for a type that shall not be instantiated. Each method does nothing.

M_CLASSIC_OPLIST(name)

Create the oplist with the operators using the pattern 'name', i.e. name##_init, name##_init_set, name##_set, name##_clear, name##_t

M_OPFLAT oplist

Remove the parenthesis around an oplist.

M_OPCAT(oplist1,oplist2)

Concat two oplists in one. 'oplist1''s operators will have higher priority to 'oplist2'

M_OPEXTEND(oplist, ...)

Extend an oplist with the given list of operators. Theses new operators will have higher priority than the ones in the given oplist.

M_TEST_METHOD_P(method, oplist)

Test if a method is present in an oplist. Return 0 or 1.

M_IF_METHOD(method, oplist)

Perform a preprocessing M_IF, if the method is present in the oplist. Example: M_IF_METHOD(HASH, oplist)(define function that uses HASH method, )

M_IF_METHOD_BOTH(method, oplist1, oplist2)

Perform a preprocessing M_IF if the method exists in both oplist. Example: M_IF_METHOD_BOTH(HASH, oplist1, oplist2) (define function , )

M_IF_METHOD_ALL(method, ...)

Perform a preprocessing M_IF if the method exists for all oplist. Example: M_IF_METHOD_ALL(HASH, oplist1, oplist2, oplist3) (define function, )

M_IPTR

By putting this after a method for an operator in the oplist, it specifies that the first argument of the method shall be a pointer to the destination type, rather than the type. See M_API_2 for an equivalent implementation.

M_DO_INIT_MOVE(oplist, dest, src)

M_DO_MOVE(oplist, dest, src)

Perform an INIT_MOVE/MOVE if present, or emulate it otherwise. Note: default methods for INIT_MOVE/MOVE are not robust enough yet.

M_GLOBAL_OPLIST(a)

Check if a is an oplist, and return 'a' or if a global oplist is registered for 'a' view as a typ, (by testing if a symbol composed of M_OPL_##a() is defined) and returns it, otherwise return 'a'.

In short, if a global oplist is defined for the argument, it returns it otherwise it returns the argument. Global oplist is limited to typedef types.

M_GLOBAL_OPLIST_OR_DEF(a)

Check if a a symbol composed of M_OPL_##a() is defined as an oplist, and returns its name otherwise return a name that will expand to M_DEFAULT_OPLIST. The return value shall be evaluated once again to get the oplist (this is needed due to technical reasons) like this:

   M_GLOBAL_OPLIST_OR_DEF(mpz_t)()

In short, if a global oplist is defined for the argument, it returns it otherwise it returns the default oplist. Global oplist is limited to typedef types.

Syntax enhancing

These macros are quite useful to lighten the C style and make full use of the library.

M_EACH(item, container, oplist|type)

This macro iterates over the given 'container' of oplist 'oplist' (or of type 'type' with a globally registered oplist) and sets 'item' to reference one different element of the container for each iteration of the loop.

'item' is a created pointer variable to the contained type of the container, only available within the 'for' loop. There can only have one M_EACH per line. It shall be used after the 'for' C keyword to perform a loop over the container. The order of the iteration depends on the given container.

Example: for M_EACH(item, list, LIST_OPLIST) { action; }

M_LET(var1[,var2[,...]], oplist|type)

This macro defines the variable 'var1'(resp. var2, ...) of oplist 'oplist' (or of type 'type' with a globally registered oplist). It initializes 'var1' (resp. var2, ...) by calling the initialization method, and clears 'var1' (resp. var2, ...) by calling the clear method when the bracket associated to the M_LET go out of scope.

If 'var1' (resp. var2, ...) has the form (v1, arguments...), then the variable 'v1' will be initialized with the contains of 'arguments...' given to the specialized initializer operator INIT_WITH (and not the empty initializer INIT operator).

There shall be at most one M_LET macro per line of source code.

Example:

 M_LET(a, STRING_OPLIST) { do something with a }  or
 M_LET(a, b, c, string_t) { do something with a, b & c }

NOTE: The user code shall not perform a return or a goto (or longjmp) outside the {} or a call to an exit function otherwise the clear code of the object won't be called . However, you can use the break instruction to quit the block (the clear function will be executed), and you can chain the M_LET macro to create several different variables.

M_LET_IF(init_code, test_code, clear_code [, else_code] )

This macro defines the variable(s) in 'init_code', executes the next block of instructions where the variable(s) is(are) used if the initialization succeeds by testing 'test_code', then it executes the 'clear_code'.

'test_code' shall return a boolean indicating if the initialization succeeds (true) or not. If the initialization fails, it won't call the 'clear_code', but the 'else_code' if it is present.

The syntax of 'init_code' is the same as a one of a for loop.

There shall be at most one M_LET_IF macro per line of source code.

Example:

M_LET_IF(int *p = malloc(100), p!=0, free(p)) {
  M_LET_IF( /* nothing */ , mtx_lock(&mut)!=thrd_error, mtx_unlock(&mut)) {
    printf ("OK! Let's use p in a mutex section\n");
  }
}

NOTE: The user code shall not perform a return or a goto (or longjmp) outside the {} or a call to an exit function otherwise the clear_code won't be called . However, you can use the break instruction to quit properly the block (the clear_code will be executed). You can chain the M_LET_IF macro to create several different variables.

M_DEFER(clear_code)

This macro registers the execution of 'clear_code' when reaching the further closing brace of the next block of instruction.

There shall be at most one M_DEFER macro per line of source code.

Example:

    m_mutex_lock(mut);
    M_DEFER(m_mutex_unlock(mut)) {
        // Use of the critical section.
    } // Now m_mutex_unlock is called

NOTE: The user code shall not perform a return or a goto (or longjmp) outside the {} or a call to an exit function otherwise the clear_code won't be called. You can use the break instruction to quit the block (the clear_code will be executed).

Memory / Error macros

All these macro can be overridden before including the header m-core.h so that they can be adapted to a particular memory pool.

type *M_MEMORY_ALLOC (type)

Return a pointer to a new allocated non-initialized object of type 'type'. In case of allocation error, it returns NULL. The default used function is the 'malloc' function of the LIBC.

The user may defined its own implementation of the macro before including any M*LIB header.

void M_MEMORY_DEL (type *ptr)

Delete the cleared object pointed by the pointer 'ptr' that was previously allocated by the macro M_MEMORY_ALLOC. 'ptr' can not be NULL. The default used function is the 'free' function of the LIBC.

The user may defined its own implementation of the macro before including any M*LIB header.

type *M_MEMORY_REALLOC (type, ptr, number)

Return a pointer to an array of 'number' objects of type 'type' 'ptr' is either NULL (in which the array is allocated), or a pointer returned from a previous call of M_MEMORY_REALLOC (in which case the array is reallocated). The objects are not initialized, nor the state of previous objects changed (in case of reallocation). The address of the previous objects may have moved and the MOVE operator is not used in this case. In case of allocation error, it returns NULL. The default used function is the 'realloc' function of the LIBC.

The user may defined its own implementation of the macro before including any M*LIB header.

void M_MEMORY_FREE (type *ptr)

Delete the cleared object pointed by the pointer 'ptr'. The pointer was previously allocated by the macro M_MEMORY_REALLOC. 'ptr' can not be NULL. The default used function is the 'free' function of the LIBC.

The user may defined its own implementation of the macro before including any M*LIB header.

void M_MEMORY_FULL (size_t size)

This macro is called by M*LIB when a memory error has been detected. The parameter 'size' is what was tried to be allocated (as a hint). The default is to abort the execution. The macro can :

abort the execution,
throw an exception (In this case, the state of the object is unchanged),
set a global error variable and return.

NOTE: The last two cases are not properly fully supported yet. Throwing an exception is not fully supported yet (Needs M*LIB support to clear the skipped objects).

The user may defined its own implementation of the macro before including any M*LIB header.

void M_ASSERT_INIT_FAILURE(expression, object_name)

This macro is called when an assertion used in an initialization context is called to check the good creation of an object (like a thread, a mutex) that string name is 'object_name'.

If the given 'expression' is false, the execution shall be aborted. The assertion is kept in programs built in release mode. The default is to abort the execution.

The user may defined its own implementation of the macro before including any M*LIB header.

Generic Serialization objects

A serialization is the process of translating data structures into a format that can be stored or transmitted. When the resulting format is reread and translated, it creates a semantically identical clone of the original object.

A generic serialization object is an object that takes a C object (Boolean, integer, float, structure, union, pointer, array, list, hash-map, ...) and outputs it into a serialization way through the following defined interface that defined the format of the serialization and where it is physically output.

The M*LIB containers define the methods _out_serial and _in_serial if the underlying types define theses methods over the operators OUT_SERIAL and IN_SERIAL. The methods for the basic C types (int, float, ...) are also defined (but only in C11 due to technical limitation).

The methods _out_serial and _in_serial will request the generic serialization object to serialize their current object:

calling the interface of the generic serialization object if needed,
performing recursive call to serialize the contained-objects.

The final output of this serialization can be a FILE or a string. Two kinds of serialization objects exist: one for input and one for output. The serialization is fully recursive and can be seen as a collection of token. The only constraint is that what is output by the output serialization object shall be able to be parsed by the input serialization object.

The serialization input object is named as m_serial_read_t, defined in m-core.h as a structure (of array of size 1) with the following fields:

m_interface: a pointer to the constant m_serial_read_interface_s structure that defines all methods that operate on this object to parse it. The instance has to be customized for the needs of the wanted serialization.
data: a table of M_SERIAL_MAX_DATA_SIZE of C types (Boolean, integer, size or pointer). This data is used to store the needed data for the methods.

This is pretty much like a pure virtual interface object in C++. The interface has to defines the following fields with the following definition:

read_boolean: Read from the stream 'serial' a boolean. Set '*b' with the boolean value if it succeeds. Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise
read_integer: Read from the stream 'serial' an integer that can be represented with 'size_of_type' bytes. Set '*i' with the integer value if it succeeds. Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise.
read_float: Read from the stream 'serial' a float that can be represented with 'size_of_type' bytes. Set '*r' with the float value if it succeeds. Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise.
read_string: Read from the stream 'serial' a string. Set 's' with the string if it succeeds. Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise
read_array_start: Start reading from the stream 'serial' an array (which is defined as a sequential collection of object). Set '*num' with the number of elements, or 0 if it is not known. Initialize the object 'local' so that it can be used by the serialization object to serialize the array. ('local' is an unique local serialization object of the array). Return M_SERIAL_OK_CONTINUE if it succeeds and the parsing of the array can continue (the array is not empty), M_SERIAL_OK_DONE if it succeeds and the array ends (the array is empty), M_SERIAL_FAIL otherwise.
read_array_next: Continue reading from the stream 'serial' an array using 'local' to load / save data if needed. Return M_SERIAL_OK_CONTINUE if it succeeds and the array can continue (the array end is still not reached), M_SERIAL_OK_DONE if it succeeds and the array ends, M_SERIAL_FAIL otherwise.
read_map_start: Start reading from the stream 'serial' a map (an associative array). Set '*num' with the number of elements, or 0 if it is not known. Initialize 'local' so that it can be used to serialize the map. ('local' is an unique serialization object of the map). Return M_SERIAL_OK_CONTINUE if it succeeds and the map continue, M_SERIAL_OK_DONE if it succeeds and the map ends (the map is empty), M_SERIAL_FAIL otherwise
read_map_value: Continue reading from the stream 'serial' the value separator token (if needed) using 'local' to load / save data if needed. Return M_SERIAL_OK_CONTINUE if it succeeds and the map continue, M_SERIAL_FAIL otherwise
read_map_next: Continue reading from the stream 'serial' a map. using 'local' to load / save data if needed. Return M_SERIAL_OK_CONTINUE if it succeeds and the map continue, M_SERIAL_OK_DONE if it succeeds and the map ends, M_SERIAL_FAIL otherwise
read_tuple_start: Start reading a tuple from the stream 'serial'. Return M_SERIAL_OK_CONTINUE if it succeeds and the tuple continues, M_SERIAL_FAIL otherwise
read_tuple_id: Continue reading a tuple (a structure) from the stream 'serial'. using 'local' to load / save data if needed. Set '*id' with the corresponding index of the table 'field_name[max]' associated to the parsed field in the stream. Return M_SERIAL_OK_CONTINUE if it succeeds and the tuple continues, Return M_SERIAL_OK_DONE if it succeeds and the tuple ends, M_SERIAL_FAIL otherwise
read_variant_start: Start reading a variant (an union) from the stream 'serial'. Set '*id' with the corresponding index of the table 'field_name[max]' associated to the parsed field in the stream. Return M_SERIAL_OK_CONTINUE if it succeeds and the variant continues, Return M_SERIAL_OK_DONE if it succeeds and the variant ends(variant is empty), M_SERIAL_FAIL otherwise
read_variant_end: End reading a variant from the stream 'serial'. Return M_SERIAL_OK_DONE if it succeeds and the variant ends, M_SERIAL_FAIL otherwise

The serialization output object is named as m_serial_write_t, defined in m-core.h as a structure (of array of size 1) with the following fields:

m_interface: a pointer to the constant m_serial_write_interface_s structure that defines all methods that operate on this object to output it. The instance has to be customized for the needs of the wanted serialization.
data: a table of M_SERIAL_MAX_DATA_SIZE of C types (boolean, integer, size or pointer). This data is used to store the needed data for the methods.

This is pretty much like a pure virtual interface object in C++. The interface has to defines the following fields with the following definition:

write_boolean: Write the boolean 'b' into the serial stream 'serial'. Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise */
write_integer: Write the integer 'data' of 'size_of_type' bytes into the serial stream 'serial'. Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise */
write_float: Write the float 'data' of 'size_of_type' bytes into the serial stream 'serial'. Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise */
write_string: Write the null-terminated string 'data' of 'length' characters into the serial stream 'serial'. Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise */
write_array_start: Start writing an array of 'number_of_elements' objects into the serial stream 'serial'. If 'number_of_elements' is 0, then either the array has no data, or the number\ of\ elements of the array is unknown. Initialize 'local' so that it can be used to serialize the array (local is an unique serialization object of the array). Return M_SERIAL_OK_CONTINUE if it succeeds, M_SERIAL_FAIL otherwise */
write_array_next: Write an array separator between elements of an array into the serial stream 'serial' if needed. Return M_SERIAL_OK_CONTINUE if it succeeds, M_SERIAL_FAIL otherwise */
write_array_end: End the writing of an array into the serial stream 'serial'. Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise */
write_map_start: Start writing a map of 'number_of_elements' pairs of objects into the serial stream 'serial'. If 'number_of_elements' is 0, then either the map has no data, or the number of elements is unknown. Initialize 'local' so that it can be used to serialize the map (local is an unique serialization object of the map). Return M_SERIAL_OK_CONTINUE if it succeeds, M_SERIAL_FAIL otherwise */
write_map_value: Write a value separator between element of the same pair of a map into the serial stream 'serial' if needed. Return M_SERIAL_OK_CONTINUE if it succeeds, M_SERIAL_FAIL otherwise */
write_map_next: Write a map separator between elements of a map into the serial stream 'serial' if needed. Return M_SERIAL_OK_CONTINUE if it succeeds, M_SERIAL_FAIL otherwise */
write_map_end: End the writing of a map into the serial stream 'serial'. Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise */
write_tuple_start: Start writing a tuple into the serial stream 'serial'. Initialize 'local' so that it can serial the tuple (local is an unique serialization object of the tuple). Return M_SERIAL_OK_CONTINUE if it succeeds, M_SERIAL_FAIL otherwise */
write_tuple_id: Start writing the field named field_name[index] of a tuple into the serial stream 'serial'. Return M_SERIAL_OK_CONTINUE if it succeeds, M_SERIAL_FAIL otherwise */
write_tuple_end: End the write of a tuple into the serial stream 'serial'. Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise */
write_variant_start: Start writing a variant into the serial stream 'serial'. If index <= 0, the variant is empty. Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise Otherwise, the field 'field_name[index]' will be filled. Return M_SERIAL_OK_CONTINUE if it succeeds, M_SERIAL_FAIL otherwise */
write_variant_end: End Writing a variant into the serial stream 'serial'. Return M_SERIAL_OK_DONE if it succeeds, M_SERIAL_FAIL otherwise */

M_SERIAL_MAX_DATA_SIZE can be overloaded before including any M*LIB header to increase the size of the generic object. The maximum default size is 4 fields.

The full C definition are:

    // Serial return code
    typedef enum m_serial_return_code_e {
     M_SERIAL_OK_DONE = 0, M_SERIAL_OK_CONTINUE = 1, M_SERIAL_FAIL = 2
    } m_serial_return_code_t;
    
    // Different types of types that can be stored in a serial object to represent it.
    typedef union m_serial_ll_u {
      bool   b;
      int    i;
      size_t s;
      void  *p;
    } m_serial_ll_t;
    
    /* Object to handle the construction of a serial write/read of an object
       that needs multiple calls (array, map, ...)
       It is common to all calls to the same object */
    typedef struct m_serial_local_s {
     m_serial_ll_t data[M_USE_SERIAL_MAX_DATA_SIZE];
    } m_serial_local_t[1];
    
    // Object to handle the generic serial read of an object.
    typedef struct m_serial_read_s {
     const struct m_serial_read_interface_s *m_interface;
     m_serial_ll_t data[M_USE_SERIAL_MAX_DATA_SIZE];
    } m_serial_read_t[1];
    
    // Interface exported by the serial read object.
    typedef struct m_serial_read_interface_s {
      m_serial_return_code_t (*read_boolean)(m_serial_read_t serial,bool *b);
      m_serial_return_code_t (*read_integer)(m_serial_read_t serial, long long *i, const size_t size_of_type);
      m_serial_return_code_t (*read_float)(m_serial_read_t serial, long double *f, const size_t size_of_type);
      m_serial_return_code_t (*read_string)(m_serial_read_t serial, struct string_s *s); 
      m_serial_return_code_t (*read_array_start)(m_serial_local_t local, m_serial_read_t serial, size_t *s);
      m_serial_return_code_t (*read_array_next)(m_serial_local_t local, m_serial_read_t serial);
      m_serial_return_code_t (*read_map_start)(m_serial_local_t local, m_serial_read_t serial, size_t *);
      m_serial_return_code_t (*read_map_value)(m_serial_local_t local, m_serial_read_t serial);
      m_serial_return_code_t (*read_map_next)(m_serial_local_t local, m_serial_read_t serial);
      m_serial_return_code_t (*read_tuple_start)(m_serial_local_t local, m_serial_read_t serial);
      m_serial_return_code_t (*read_tuple_id)(m_serial_local_t local, m_serial_read_t serial, const char *const field_name [], const int max, int *id);
      m_serial_return_code_t (*read_variant_start)(m_serial_local_t local, m_serial_read_t serial, const char *const field_name[], const int max, int*id);
      m_serial_return_code_t (*read_variant_end)(m_serial_local_t local, m_serial_read_t serial);
    } m_serial_read_interface_t;
    
    
    // Object to handle the generic serial write of an object.
    typedef struct m_serial_write_s {
     const struct m_serial_write_interface_s *m_interface;
     m_serial_ll_t data[M_USE_SERIAL_MAX_DATA_SIZE];
    } m_serial_write_t[1];
    
    // Interface exported by the serial write object.
    typedef struct m_serial_write_interface_s {
      m_serial_return_code_t (*write_boolean)(m_serial_write_t serial, const bool b);
      m_serial_return_code_t (*write_integer)(m_serial_write_t serial, const long long i, const size_t size_of_type);
      m_serial_return_code_t (*write_float)(m_serial_write_t serial,  const long double f, const size_t size_of_type);
      m_serial_return_code_t (*write_string)(m_serial_write_t serial, const char s[], size_t length); 
      m_serial_return_code_t (*write_array_start)(m_serial_local_t local, m_serial_write_t serial, const size_t number_of_elements);
      m_serial_return_code_t (*write_array_next)(m_serial_local_t local, m_serial_write_t serial);
      m_serial_return_code_t (*write_array_end)(m_serial_local_t local, m_serial_write_t serial);
      m_serial_return_code_t (*write_map_start)(m_serial_local_t local, m_serial_write_t serial,  const size_t number_of_elements);
      m_serial_return_code_t (*write_map_value)(m_serial_local_t local, m_serial_write_t serial);
      m_serial_return_code_t (*write_map_next)(m_serial_local_t local, m_serial_write_t serial);
      m_serial_return_code_t (*write_map_end)(m_serial_local_t local, m_serial_write_t serial);
      m_serial_return_code_t (*write_tuple_start)(m_serial_local_t local, m_serial_write_t serial);
      m_serial_return_code_t (*write_tuple_id)(m_serial_local_t local, m_serial_write_t serial, const char * const field_name[], const int max, const int index);
      m_serial_return_code_t (*write_tuple_end)(m_serial_local_t local, m_serial_write_t serial);
      m_serial_return_code_t (*write_variant_start)(m_serial_local_t local, m_serial_write_t serial,  const char * const field_name[], const int max, const int index);
      m_serial_return_code_t (*write_variant_end)(m_serial_local_t local, m_serial_write_t serial);
    } m_serial_write_interface_t;

See m-serial-json.h for example of use.

M-MUTEX

This header is for providing very thin layer around OS implementation of threads, conditional variables and mutex. It has back-ends for WIN32, POSIX thread or C11 thread.

It was needed due to the low adoption rate of the C11 equivalent layer.

It uses the C11 threads.h if possible. If the C11 implementation does not respect the C standard (i.e. the compiler targets C11 mode, the __STDC_NO_THREADS__ macro is not defined but the header threads.h is not available or not working), then the user shall define manually the M_USE_THREAD_BACKEND macro to select the back end to use:

1: for C11
2: for WINDOWS
3: for PTHREAD

Example:

    m_thread_t idx_p;
    m_thread_t idx_c;

    m_thread_create (idx_p, conso_function, NULL);
    m_thread_create (idx_c, prod_function, NULL);
    m_thread_join (idx_p;
    m_thread_join (idx_c);

Attributes

The following attributes are available:

M_THREAD_ATTR

An attribute used for qualifying a variable to be thread specific. It is an alias for __thread, _Thread_local or __declspec( thread ) depending on the used backend.

methods

The following methods are available:

m_mutex_t

A type representing a mutex.

void m_mutex_init(mutex)

Initialize the variable mutex of type m_mutex_t. If the initialization fails, the program aborts.

void m_mutex_clear(mutex)

Clear the variable mutex of type m_mutex_t. If the variable is not initialized, the behavior is undefined.

void m_mutex_lock(mutex)

Lock the variable mutex of type m_mutex_t for exclusive use. If the variable is not free, it will wait indefinitely until it is. If the variable is not initialized, the behavior is undefined.

void m_mutex_unlock(mutex)

Unlock the variable mutex of type m_mutex_t for exclusive use. If the variable is not locked, the behavior is undefined. If the variable is not initialized, the behavior is undefined.

m_cond_t

A type representing a conditional variable, used within a mutex section.

void m_cond_init(m_cond_t cond)

Initialize the conditional variable cond of type m_cond_t. If the initialization failed, the program aborts.

void m_cond_clear(m_cond_t cond)

Clear the variable cond of type m_cond_t. If the variable is not initialized, the behavior is undefined.

void m_cond_signal(m_cond_t cond)

Within a mutex exclusive section, signal that the event associated to the variable cond of type m_cond_t has occurred to at least a single thread. If the variable is not initialized, the behavior is undefined.

void m_cond_broadcast(m_cond_t cond)

Within a mutex exclusive section, signal that the event associated to the variable cond of type m_cond_t has occurred to all waiting threads. If the variable is not initialized, the behavior is undefined.

void m_cond_wait(m_cond_t cond, m_mutex_t mutex)

Within a mutex exclusive section defined by mutex, wait indefinitely for the event associated to the variable cond of type m_cond_t to occur. IF multiple threads wait for the same event, which thread to awoken is not specified. If any variable is not initialized, the behavior is undefined.

m_thread_t

A type representing an id of a thread.

void m_thread_create(m_thread_t thread, void (function)(void), void *argument)

Create a new thread and set the it of the thread to 'thread'. The new thread run the code function(argument) with argument a 'void *' and function taking a 'void *' and returning nothing. If the initialization fails, the program aborts.

void m_thread_join(m_thread_t thread)

Wait indefinitely for the thread 'thread' to exit.

M-WORKER

This header is for providing a pool of workers. Each worker run in a separate thread and can handle work orders sent by the main threads. A work order is a computation task. Work orders are organized around synchronization points. Workers can be disabled globally to ease debugging.

This implements parallelism just like OpenMP or CILK++.

Example:

    worker_t worker;
    worker_init(worker, 0, 0, NULL);
    worker_sync_t sync;
    worker_start(sync, worker);
    void *data = ...;
    worker_spawn (sync, taskFunc, data);
    taskFunc(otherData);
    worker_sync(sync);

Currently, there is no support for:

throw exceptions by the worker tasks,
unbalanced design: the worker tasks shall not lock a mutex without closing it (same for other synchronization structures).

Thread Local Storage variables have to be reinitialized properly with the reset function. This may result in subtle difference between the serial code and the parallel code.

methods

The following methods are available:

worker_t

A pool of worker.

worker_sync_t

A synchronization point between workers.

void worker_init(worker_t worker[, unsigned int numWorker, unsigned int extraQueue, void (resetFunc)(void), void (clearFunc)(void) ])

Initialize the pool of workers 'worker' with 'numWorker' workers. if 'numWorker' is 0, then it will detect how many core is available on the system and creates as much workers as there are cores.

Before starting any work, the function 'resetFunc' is called by the worker to reset its state (or call nothing if the function pointer is NULL).

'extraQueue' is the number of tasks that can be accepted by the work order queue in case if there is no worker available.

Before terminating, each worker will call 'clearFunc' if the function is not NULL.

Default values are respectively 0, 0, NULL and NULL.

void worker_clear(worker_t worker)

Request termination to the pool of workers, and wait for them to terminate. It is undefined if there is any work order in progress.

void worker_start(worker_block_t syncBlock, worker_t worker)

Start a new synchronization block for a pool of work orders linked to the pool of worker 'worker'.

void worker_spawn(worker_block_t syncBlock, void (func)(void data), void *data)

Register the work order 'func(data)' to the the synchronization point 'syncBlock'. If no worker is available (and no extraQueue), the work order 'func(data)' will be handled by the caller. Otherwise the work order 'func(data)' will be handled by an asynchronous worker and the function immediately returns.

bool worker_sync_p(worker_block_t syncBlock)

Test if all work orders registered to this synchronization point are terminated (true) or not (false).

void worker_sync(worker_block_t syncBlock)

Wait for all work orders registered to this synchronization point 'syncBlock' to be terminated.

size_t worker_count(worker_t worker)

Return the number of workers of the pool.

WORKER_SPAWN(syncBlock, input, core, output)

Request the work order 'core' to the synchronization point syncBlock. If no worker is available (and no extra queue), the work order 'core' will be handled by the caller. Otherwise the work order 'core' will be handled by an asynchronous worker.

'core' is any C code that doesn't break the control flow (you cannot use return / goto / break to go outside the flow). 'input' is the list of local input variables of the 'core' block within "( )". 'output' is the list of local output variables of the 'core' block within "( )". These lists shall be exhaustive to capture all needed variables.

This macro needs either GCC (for nested function) or CLANG (for blocks) or a C++11 compiler (for lambda and functional) to work.

NOTE1: Even if nested functions are used for GCC, it doesn't generate a trampoline and the stack doesn't need to be executable as all variables are captured by the library.

NOTE2: For CLANG, you need to add -fblocks to CFLAGS and -lBlocksRuntime to LIB (See CLANG manual).

NOTE3: It will generate warnings about shadowed variables. There is no way to avoid this.

NOTE4: arrays and not trivially movable object are not supported as input / output variables due to current technical limitations.

M-ATOMIC

This header goal is to provide the C header 'stdatomic.h' to any C compiler (C11 or C99 compliant) or C++ compiler. If available, it uses the C11 header stdatomic.h, otherwise if the compiler is a C++ compiler, it uses the header 'atomic' and imports all definition into the global name space (this is needed because the C++ standard doesn't support officially the stdatomic header, resulting in broken compilation when building C code with a C++ compiler).

Otherwise it provides a non-thin emulation of atomic using mutex. This emulation has a known theoretical limitation: the mutex are never cleared. There is nothing to do to fix this. In practice, it is not a problem.

M-ALGO

This header is for generating generic algorithm to containers.

ALGO_DEF(name, container_oplist)

Define the available algorithms for the container which oplist is container_oplist. The defined algorithms depend on the availability of the methods of the containers (For example, if there no CMP operator, there is no MIN method defined).

Example:

    ARRAY_DEF(array_int, int)
    ALGO_DEF(array_int, ARRAY_OPLIST(array_int))
    void f(void) {
            array_int_t l;
            array_int_init(l);
            for(int i = 0; i < 100; i++)
                    array_int_push_back (l, i);
            array_int_push_back (l, 17);
            assert( array_int_contains(l, 62) == true);
            assert( array_int_contains(l, -1) == false);
            assert( array_int_count(l, 17) == 2);
            array_int_clear(l);
    }

Created methods

The following methods are automatically and properly created by the previous macros. In the following methods, name stands for the name given to the macro that is used to identify the type.

In the following descriptions, it_t is an iterator of the container container_t is the type of the container and type_t is the type of object contained in the container.

void name_find(it_t it, const container_t c, const type_t data)

Search for the first occurrence of 'data' within the container. Update the iterator with the found position or return the end iterator. The search is linear.

void name_find_again(it_t it, const type_t data)

Search from the position 'it' for the next occurrence of 'data' within the container. Update the iterator with the found position or return end iterator. The search is linear.

void name_find_if(it_t it, const container_t c, bool (*pred)(type_t const))

Search for the first occurrence within the container than matches the predicate 'pred' Update the iterator with the found position or return end iterator. The search is linear.

void name_find_again_if(it_t it, bool (*pred)(type_t const))

Search from the position 'it' for the next occurrence matching the predicate 'pred' within the container. Update the iterator with the found position or return end iterator. The search is linear.

void name_find_last(it_t it, const container_t c, const type_t data)

Search for the last occurrence of 'data' within the container. Update the iterator with the found position or return end iterator. The search is linear and can be backward or forwards depending on the possibility of the container.

bool name_contains(const container_t c, const type_t data)

Return true if 'data' is within the container, false otherwise. The search is linear.

size_t name_count(const container_t c, const type_t data)

Return the number of occurrence of 'data' within the container. The search is linear.

size_t name_count_if(const container_t c, bool (*pred)(type_t const data))

Return the number of occurrence matching the predicate 'pred' within the container. The search is linear.

void name_mismatch(it_t it1, it_t it2, const container_t c1, const container_t c2)

Returns the first mismatching pair of elements of the two containers 'c1' and 'c2'.

void name_mismatch_again(it_t it1, it_t it2)

Returns the next mismatching pair of elements of the two containers from the position 'it1' of container 'c1' and from the position 'it2' of container 'c2'.

void name_mismatch_if(it_t it1, it_t it2, const container_t c1, const container_t c2, bool (*cmp)(type_t const, type_t const))

Returns the first mismatching pair of elements of the two containers using the provided comparison 'cmp'.

void name_mismatch_again_if(it_t it1, it_t it2, bool (*cmp)(type_t const, type_t const))

Returns the next mismatching pair of elements of the two containers using the provided comparison 'cmp' from the position 'it1' and from the position 'it2'.

void name_fill(container_t c, type_t value)

Set all elements of the container 'c' to 'value'.

void name_fill_n(container_t c, size_t n, type_t value)

Set the container to 'n' elements equal to 'value'. This method is defined only if the container exports a PUSH method.

void name_fill_a(container_t c, type_t value, type_t inc)

Set all elements of the container 'c' to 'value + i * inc' with i = 0.. size(c) This method is defined only if the base type exports an ADD method. This method is defined only if the container exports a PUSH method.

void name_fill_an(container_t c, size_t n, type_t value)

Set the container to 'n' elements to 'value + i * inc' with i = 0..n This method is defined only if the base type exports an ADD method. This method is defined only if the container exports a PUSH method.

void name_for_each(container_t c, void (*func)(type_t))

Apply the function 'func' to each element of the container 'c'. The function may transform the element provided it doesn't reallocate the object and if the container supports iterating over modifiable elements.

void name_transform(container_t d, container_t c, void (func)(type_t out, const type_t in))

Apply the function 'func' to each element of the container 'c' and push the result into the container 'd' so that 'd = func(c)'

'func' shall output in the initialized object 'out' the transformed value of the constant object 'in'. Afterwards 'out' is pushed moved into 'd'.

This method is defined only if the base type exports an INIT method. This method is defined only if the container exports a PUSH_MOVE method. 'c' and 'd' cannot be the same containers.

void name_reduce(type_t dest, const container_t c, void (func)(type_t *, type_t const))

Perform a reduction using the function 'func' to the elements of the container 'c'. The final result is stored in '*dest'. If there is no element, '*dest' is let unmodified.

void name_map_reduce(type_t dest, const container_t c, void (redFunc)(type_t , type_t const), void (mapFunc)(type_t *, type_t const))

Perform a reduction using the function 'redFunc' to the transformed elements of the container 'c' using 'mapFunc'. The final result is stored in '*dest'. If there is no element, '*dest' is let unmodified.

bool name_any_of_p(const container_t c, void *(func)(const type_t))

Test if any element of the container 'c' matches the predicate 'func'.

bool name_all_of_p(const container_t c, void *(func)(const type_t))

Test if all elements of the container 'c' match the predicate 'func'.

bool name_none_of_p(const container_t c, void *(func)(const type_t))

Test if no element of the container 'c' match the predicate 'func'.

type_t *name_min(const container_t c)

Return a reference to the minimum element of the container 'c'. Return NULL if there is no element. This method is available if the CMP operator has been defined.

type_t *name_max(const container_t c)

Return a reference to the maximum element of the container 'c'. Return NULL if there is no element. This method is available if the CMP operator has been defined.

void name_minmax(type_t min, type_t max, const container_t c)

Stores in '*min' a reference to the minimum element of the container 'c'. Stores in '*max' a reference to the minimum element of the container 'c'. Stores NULL if there is no element. This method is available if the CMP operator has been defined.

void name_uniq(container_t c)

Assuming the container 'c' has been sorted, remove any duplicate elements of the container. This method is available if the CMP and IT_REMOVE operators have been defined.

void name_remove_val(container_t c, type_t val)

Remove all elements equal to 'val' of the container. This method is available if the CMP and IT_REMOVE operators have been defined.

void name_remove_if(container_t c, bool (*func)(type_t) )

Remove all elements matching the given condition (function func() returns true) of the container. This method is available if the CMP and IT_REMOVE operators have been defined.

void name_add(container_t dest, const container_t value)

For each element of the container 'dest', add the corresponding element of the container 'dest' up to the minimum size of the containers. This method is available if the ADD operator has been defined.

void name_sub(container_t dest, const container_t value)

For each element of the container 'dest', sub the corresponding element of the container 'dest' up to the minimum size of the containers. This method is available if the SUB operator has been defined.

void name_mul(container_t dest, const container_t value)

For each element of the container 'dest', mul the corresponding element of the container 'dest' up to the minimum size of the containers. This method is available if the MUL operator has been defined.

void name_div(container_t dest, const container_t value)

For each element of the container 'dest', div the corresponding element of the container 'dest' up to the minimum size of the containers. This method is available if the DIV operator has been defined.

bool void name_sort_p(const container_t c)

Test if the container 'c' is sorted (=true) or not (=false). This method is available if the CMP operator has been defined.

bool name_sort_dsc_p(const container_t c)

Test if the container 'c' is reverse sorted (=true) or not (=false) This method is available if the CMP operator has been defined.

void void name_sort(container_t c)

Sort the container 'c'. This method is available if the CMP operator has been defined. The used algorithm depends on the available operators: if a specialized SORT operator is defined for the container, it is used. if SPLICE_BACK and SPLICE_AT operates are defined, a merge sort is defined, if IT_PREVIOUS is defined, an insertion sort is used, otherwise a selection sort is used.

bool name_sort_dsc(const container_t c)

Reverse sort the container 'c'. This method is available if the CMP operator has been defined. The used algorithm depends on the available operators: if a specialized SORT operator is defined, it is used. if SPLICE_BACK and SPLICE_AT operates are defined, a merge sort is defined, if IT_PREVIOUS is defined, an insertion sort is used, otherwise a selection sort is used.

void name_sort_union(container_t c1, const container_t c2)

Assuming both containers 'c1' and 'c2' are sorted, perform an union of the containers in 'c1'. This method is available if the IT_INSERT operator is defined.

void name_sort_dsc_union(container_t c1, const container_t c2)

Assuming both containers 'c1' and 'c2' are reverse sorted, perform an union of the containers in 'c2'. This method is available if the IT_INSERT operator is defined.

void name_sort_intersect(container_t c1, const container_t c2)

Assuming both containers 'c1' and 'c2' are sorted, perform an intersection of the containers in 'c1'. This method is available if the IT_REMOVE operator is defined.

void name_sort_dsc_intersect(container_t c, const container_t c)

Assuming both containers 'c1' and 'c2' are reverse sorted, perform an intersection of the containers in 'c1'. This method is available if the IT_REMOVE operator is defined.

void name_split(container_t c, const string_t str, const char sp)

Split the string 'str' around the character separator 'sp' into a set of string in the container 'c'. This method is defined if the base type of the container is a string_t type,

void name_join(string_t dst, container_t c, const string_t str)

Join the string 'str' and all the strings of the container 'c' into 'dst'. This method is defined if the base type of the container is a string_t type,

ALGO_FOR_EACH(container, oplist, func[, arguments..])

Apply the function 'func' to each element of the container 'container' of oplist 'oplist' :

 for each item in container do
          func([arguments,] item)

The function 'func' is a method that takes as argument an object of the container and returns nothing. It may update the object provided it doesn't reallocate it.

ALGO_TRANSFORM(contDst, contDstOplist, contSrc, contSrcOplist, func[, arguments..])

Apply the function 'func' to each element of the container 'contSrc' of oplist 'contSrcOplist' and store its outptut in the container 'contDst' of oplist 'contDstOplist' so that 'contDst = func(contSrc)'. Exact algorithm is:

 clean(contDst)
 for each item in  do
     init(tmp)
          func(tmp, item, [, arguments])
     push_move(contDst, tmp)

The function 'func' is a method that takes as first argument the object to put in the new container, and as second argument the object in the source container.

ALGO_EXTRACT(containerDest, oplistDest, containerSrc, oplistSrc[, func[, arguments..]])

Extract the items of the container 'containerSrc' of oplist 'oplistSrc' into the 'containerDest' of oplist 'oplistDest':

 CLEAN (containerDest)
 for each item in containerSrc do
          [ if func([arguments,] item) ] 
                   Push item in containerDest

The optional function 'func' is a predicate that takes as argument an object of the container and returns a boolean that is true if the object has to be added to the other container.

Both containers shall either provide PUSH method, or SET_KEY method.

ALGO_REDUCE(dest, container, oplist, reduceFunc[, mapFunc[, arguments..])

Reduce the items of the container 'container' of oplist 'oplist' into a single element by applying the reduce function:

 dest = reduceFunc(mapFunc(item[0]), reduceFunc(..., reduceFunc(mapFunc(item[N-2]), mapFunc(item[N-1]))))

'mapFunc' is a method which prototype is:

void mapFunc(dest, item)

with both 'dest' & 'item' that are of the same type than the one of the container. It transforms the 'item' into another form that is suitable for the 'reduceFunc'. If 'mapFunc' is not specified, identity will be used instead.

'reduceFunc' is a method which prototype is:

 void reduceFunc(dest, item)

It integrates the new 'item' into the partial 'sum' 'dest.

The reduce function can be the special keywords 'add', 'sum', 'and', 'or' 'product', 'mul' in which case the special function performing a sum/sum/and/or/mul/mul operation will be used.

'dest' can be either the variable (in which case 'dest' is assumed to be of type equivalent to the elements of the container) or a tuple ('var', 'oplist') with 'var' being the variable name and 'oplist' its oplist (with TYPE, INIT, SET methods). The tuple may be needed if the map function transform a type into another.

ALGO_INSERT_AT(containerDst, containerDstOPLIST, position, containerSrc, containerSrcOPLIST)

Insert into the container 'contDst' at position 'position' all the values of container 'contSrc'.

M-FUNCOBJ

This header is for generating Function Object. A function object is a construct an object to be invoked or called as if it were an ordinary function, usually with the same syntax (a function parameter that can also be a function) but with additional "within" parameters.

Example:

    // Define generic interface of a function int --> int
    FUNC_OBJ_ITF_DEF(interface, int, int)

    // Define one instance of such interface
    FUNC_OBJ_INS_DEF(sumint, interface, x, {
            return self->sum + x;
    }, (sum, int)   )

    int f(interface_t i)
    {
            return interface_call(i, 4);
    }
    int h(void)
    {
            sumint_t s;
            sumint_init_with(s, 16);
            int n = f(sumint_as_interface(s));
            printf("sum=%d\n", n);
            sumint_clear(s);
    }

FUNC_OBJ_ITF_DEF(name, retcode_type[, type_of_param1, type_of_param 2, ...])

FUNC_OBJ_ITF_DEF_AS(name, name_t, retcode_type[, type_of_param1, type_of_param 2, ...])

Define a function object interface of name 'name' emulating a function pointer returning retcode_type (which can be void), and with as inputs the list of types of paramN, thus generating a function prototype like this:

    retcode_type function(type_of_param1, type_of_param 2, ...)

An interface cannot be used without an instance (see below) that implements this interface. In particular, there is no init nor clear function for an interface (only an instance provides such initialization).

FUNC_OBJ_ITF_DEF_AS is the same as FUNC_OBJ_ITF_DEF except the name of the type name_t is provided.

It will define the following type and functions:

name_t

Type representing an interface to such function object. There is only one method for such type (see below).

retcode_type name_call(name_t interface, type_of_param1, type_of_param 2, ...)

The call function of the interface object. It will call the particular implemented callback of the instance of this interface. It shall only be used by an inteface object derived from an instance.

FUNC_OBJ_INS_DEF(name, interface_name, (param_name_1, ...), { callback_core }, (self_member1, self_type1[, self_oplist1]), ...)

FUNC_OBJ_INS_DEF_AS(name, name_t, interface_name, (param_name_1, ...), { callback_core }, (self_member1, self_type1[, self_oplist1]), ...)

Define a function object instance of name 'name' implementing the interface 'interface_name' (it is the same as used as name in FUNC_OBJ_ITF_DEF).

The function instance is defined as per :

the function prototype of the inherited interface,
the parameters of the function are named as per the list param_name_list,
the core of the function shall be defined in the brackets within the callback_core. The members of the function object can be accessed through the pointer named 'self' to access the member attributes of the object (without any cast), and the parameter names of the function shall be accessed as per their names in the param_name_list.
optional member attributes of the function object can be defined after the core (just like for tuple & variant): Each parameter is defined as a triplet: (name, type [, oplist])

It generates a function that looks like:

    interface_name_retcode_type function(interface_name_t *self, interface_name_type_of_param1 param_name_1, interface_name_type_of_param 2 param_name_2, ...) {
           callback_core
    }

FUNC_OBJ_INS_DEF_AS is the same as FUNC_OBJ_INS_DEF except the name of the type name_t is provided.

name_t

Name of a particular instance to the interface of the Function Object interface_name.

void name_init(name_t self)

Initialize the instance of the function with default value. This method is defined only if all member attributes export an INIT method. If there is no member, the method is defined.

void name_init_with(name_t self, self_type1 a1, self_type2 a2, ...)

Initialize the instance of the function with the given values of the member attributes.

void name_clear(name_t self)

Clear the instance of the function.

interface_name_t name_as_interface(name_t self)

Return the interface object derived from this instance. This object can then be transmitted to any function that accept the generic interface (mainly _call).

M-MEMPOOL

This header is for generating specialized and optimized memory pools: it will generate specialized functions to allocate and free only one kind of an object. The mempool functions are not specially thread safe for a given mempool, but the mempool variable can have the attribute M_THREAD_ATTR so that each thread has its own instance of the mempool.

The memory pool has to be initialized and cleared like any other variable. Clearing the memory pool will free all the memory that has been allocated within this memory pool.

MEMPOOL_DEF(name, type)

Generate specialized functions & types prefixed by 'name' to alloc & free an object of type 'type'.

Example:

    MEMPOOL_DEF(mempool_uint, unsigned int)

    mempool_uint_t m;

    void f(void) {
      mempool_uint_init(m);
      unsigned int *p = mempool_uint_alloc(m);
      *p = 17;
      mempool_uint_free(m, p);
      mempool_uint_clear(m);
    }

Created methods

The following methods are automatically and properly created by the previous macros. In the following methods, name stands for the name given to the macro that is used to identify the type.

name_t

The type of a mempool.

void name_init(name_t m)

Initialize the mempool 'm'.

void name_clear(name_t m)

Clear the mempool 'm'. All allocated objects associated to the this mempool that weren't explicitly freed will be deleted too (without calling their clear method).

type *name_alloc(name_t m)

Create a new object of type 'type' and return a new pointer to the uninitialized object.

void name_free(name_t m, type *p)

Free the object 'p' created by the call to name_alloc. The clear method of the type is not called.

M-SERIAL-JSON

This header is for defining an instance of the serial interface supporting import (and export) of a container from (to) to a file in JSON format. It uses the generic serialization ability of M*LIB for this purpose, providing a specialization of the serialization for JSON over FILE*.

Another way of seeing it is that you define your data structure using M*LIB containers (building it using basic types, strings, tuples, variants, array, dictionaries, ...) and then you can import / export your data structure for free in JSON format.

If the JSON file cannot be translated into the data structure, a failure error is reported (M_SERIAL_FAIL). For example, if some new fields are present in the JSON file but not in the data structure. On contrary, if some fields are missing (or in a different order) in the JSON file, the parsing will still succeed (object fields are unmodified except for new sub-objects, for which default value are used).

It is fully working with C11 compilers only.

C functions on FILE

m_serial_json_write_t

A synonym of m_serial_write_t with a global oplist registered for use with JSON over FILE*.

void m_serial_json_write_init(m_serial_write_t serial, FILE *f)

Initialize the 'serial' object to be able to output in JSON format to the file 'f'. The file 'f' shall remain open in 'wt' mode while the 'serial' is not cleared.

void m_serial_json_write_clear(m_serial_write_t serial)

Clear the serialization object 'serial'.

m_serial_json_read_t

A synonym of m_serial_read_t with a global oplist registered for use with JSON over FILE *.

void m_serial_json_read_init(m_serial_read_t serial, FILE *f)

Initialize the 'serial' object to be able to parse in JSON format from the file 'f'. The file 'f' shall remain open in 'rt' mode while the 'serial' is not cleared.

void m_serial_json_read_clear(m_serial_read_t serial)

Clear the serialization object 'serial'.

C functions on string

m_serial_str_json_write_t

A synonym of m_serial_write_t with a global oplist registered for use with JSON over string_t.

void m_serial_str_json_write_init(m_serial_write_t serial, string_t str)

Initialize the 'serial' object to be able to output in JSON format to the string_t 'str'. The string 'str' shall remain initialized while the 'serial' object is not cleared.

void m_serial_str_json_write_clear(m_serial_write_t serial)

Clear the serialization object 'serial'.

m_serial_str_json_read_t

A synonym of m_serial_read_t with a global oplist registered for use with JSON over const string (const char*).

void m_serial_str_json_read_init(m_serial_read_t serial, const char str[])

Initialize the 'serial' object to be able to parse in JSON format from the const string 'str'. The const string 'str' shall remain initialized while the 'serial' object is not cleared.

const char * m_serial_str_json_read_clear(m_serial_read_t serial)

Clear the serialization object 'serial' and return a pointer to the first unparsed character in the const string.

Example:

    // Define a structure of two fields.
    TUPLE_DEF2(my,
               (value, int),
               (name, string_t)
               )
    #define M_OPL_my_t() TUPLE_OPLIST(my, M_DEFAULT_OPLIST, STRING_OPLIST )
    
    // Output in JSON file the structure my_t
    void output(my_t el1)
    {
      m_serial_write_t out;
      m_serial_return_code_t ret;
    
      FILE *f = fopen ("data.json", "wt");
      if (!f) abort();
      m_serial_json_write_init(out, f);
      ret = my2_out_serial(out, el1);
      assert (ret == M_SERIAL_OK_DONE);
      m_serial_json_write_clear(out);
      fclose(f);
    }
    
    // Get from JSON file the structure my_t
    void input(my_t el1)
    {
      m_serial_read_t  in;
      m_serial_return_code_t ret;
    
      f = fopen ("data.json", "rt");
      if (!f) abort();
      m_serial_json_read_init(in, f);
      ret = my2_in_serial(el2, in);
      assert (ret == M_SERIAL_OK_DONE);
      m_serial_json_read_clear(in);
      fclose(f);
    }

M-SERIAL-BIN

This header is for defining an instance of the serial interface supporting import (and export) of a container from (to) to a file in an ad-hoc binary format. This format only supports the current system and cannot be used to communicate across multiple systems (endianess, size of types are typically not abstracted by this format).

It uses the generic serialization ability of M*LIB for this purpose, providing a specialization of the serialization for JSON over FILE*.

It is fully working with C11 compilers only.

C functions

void m_serial_bin_write_init(m_serial_write_t serial, FILE *f)

Initialize the 'serial' object to be able to output in BIN format to the file 'f'. The file 'f' has to remained open in 'wb' mode while the 'serial' is not cleared otherwise the behavior of the object is undefined.

void m_serial_bin_write_clear(m_serial_write_t serial)

Clear the serialization object 'serial'.

void m_serial_bin_read_init(m_serial_read_t serial, FILE *f)

Initialize the 'serial' object to be able to parse in BIN format from the file 'f'. The file 'f' has to remained open in 'rb' mode while the 'serial' is not cleared otherwise the behavior of the object is undefined.

void m_serial_bin_read_clear(m_serial_read_t serial)

Clear the serialization object 'serial'.

Global User Customization

The behavior of M*LIB can be customized globally by defining the following macros before including any headers of M*LIB. If a macro is not defined before including any M*LIB header, the default value will be used.

Theses macros shall not be defined after including any M*LIB header.

M_USE_UNDEF_ATOMIC

Undefine the macro _Atomic in m-atomic.h if stdatomic.h is included. It is needed on MSYS2 due to a bug in their headers which is not fixed yet.

Default value: 1 (undef) on MSYS2, 0 otherwise.

M_USE_STDIO

This macro indicates if the system header stdio.h shall be included and the FILE functions be defined (=1) or not (=0).

Default value: 1

M_USE_STDARG

This macro indicates if the system header stdarg.h shall be included and the va_args functions be defined (=1) or not (=0).

Default value: 1 (true)

M_USE_CSTR_ALLOC

Define the allocation size of the temporary strings created by M_CSTR (including the final nul char).

Default value: 256.

M_USE_IDENTIFIER_ALLOC

Define the allocation size of a C identifier in the source code (excluding the final nul char). It is used to represent a C identifier by a C string.

Default value: 128

M_USE_THREAD_BACKEND

Define the thread backend to use by m-mutex.h:

1: for C11 header threads.h
2: for WINDOWS header windows.h
3: for POSIX THREAD header pthread.h

Default value: autodetect in function of the running system.

M_USE_WORKER

This macro indicates if the multi-thread code of m-worker.h shall be used (=1) or not (=0)

In this case, a single-thread code is used -.

Default value: 1

M_USE_WORKER_CLANG_BLOCK

This macro indicates if the workers shall use the CLANG block extension (=1) or not (=0).

Default value: 1 (on clang), 0 (otherwise)

M_USE_WORKER_CPP_FUNCTION

This macro indicates if the workers shall use the C++ lambda function (=1) or not (=0).

Default value: 1 (compiled in C++), 0 (otherwise)

M_USE_BACKOFF_MAX_COUNT

Define the maximum iteration of the backoff exponential scheme for the synchronization waiting loop of multithreading code.

Default value: 6

M_USE_SERIAL_MAX_DATA_SIZE

Define the size of the private data (reserved to the serial implementation) in a serial object (as a number of pointers or equivalent objects).

Default value: 4

M_USE_MEMPOOL_MAX_PER_SEGMENT(type)

Define the number of elements to allocate in a segment per object of type 'type'.

Default value: number of elements that fits in a 16KB page.

M_USE_DEQUE_DEFAULT_SIZE

Define the default size of a segment for a deque structure.

Default value: 8 elements.

M_USE_HASH_SEED

Define the seed to inject to the hash computation of an object.

Default value: 0 (predictable hash)

License

All files of M*LIB are distributed under the following license.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.