sources/liblfds/liblfds.h

Go to the documentation of this file.

#ifndef __LIBLFDS_H
# define __LIBLFDS_H /* Helixis patch :) */

#include "hlx/core.h"
#include "helixis_internal.h"

#if defined(HLX_BUILD_WITH_PARALLEL_THREADING)

/***** library header *****/
#define LIBLFDS_RELEASE_NUMBER 6

/***** enums *****/
enum data_structure_validity
{
        VALIDITY_VALID,
        VALIDITY_INVALID_LOOP,
        VALIDITY_INVALID_MISSING_ELEMENTS,
        VALIDITY_INVALID_ADDITIONAL_ELEMENTS,
        VALIDITY_INVALID_TEST_DATA
};

/***** structs *****/
struct validation_info
{
        atom_t
                min_elements,
                max_elements;
};

/***** freelist *****/

/***** enums *****/
enum freelist_query_type
{
        FREELIST_QUERY_ELEMENT_COUNT,
        FREELIST_QUERY_VALIDATE
};

/***** incomplete types *****/
struct freelist_state;
struct freelist_element;

/***** public prototypes *****/
int freelist_new( struct freelist_state **fs, atom_t number_elements, int (*user_data_init_function)(void **user_data, void *user_state), void *user_state );
void freelist_delete( struct freelist_state *fs, void (*user_data_delete_function)(void *user_data, void *user_state), void *user_state );

atom_t freelist_new_elements( struct freelist_state *fs, atom_t number_elements );

struct freelist_element *freelist_pop( struct freelist_state *fs, struct freelist_element **fe );
struct freelist_element *freelist_guaranteed_pop( struct freelist_state *fs, struct freelist_element **fe );
void freelist_push( struct freelist_state *fs, struct freelist_element *fe );

void *freelist_get_user_data_from_element( struct freelist_element *fe, void **user_data );
void freelist_set_user_data_in_element( struct freelist_element *fe, void *user_data );

void freelist_query( struct freelist_state *fs, enum freelist_query_type query_type, void *query_input, void *query_output );




/***** queue *****/

/***** enums *****/
enum queue_query_type
{
        QUEUE_QUERY_ELEMENT_COUNT,
        QUEUE_QUERY_VALIDATE
};

/***** incomplete types *****/
struct queue_state;

/***** public prototypes *****/
int queue_new( struct queue_state **sq, atom_t number_elements );
void queue_delete( struct queue_state *qs, void (*user_data_delete_function)(void *user_data, void *user_state), void *user_state );

int queue_enqueue( struct queue_state *qs, void *user_data );
int queue_guaranteed_enqueue( struct queue_state *qs, void *user_data );
int queue_dequeue( struct queue_state *qs, void **user_data );

void queue_query( struct queue_state *qs, enum queue_query_type query_type, void *query_input, void *query_output );




/***** slist *****/

/***** incomplete types *****/
struct slist_state;
struct slist_element;

/***** public prototypes *****/
int slist_new( struct slist_state **ss, void (*user_data_delete_function)(void *user_data, void *user_state), void *user_state );
void slist_delete( struct slist_state *ss );

struct slist_element *slist_new_head( struct slist_state *ss, void *user_data );
struct slist_element *slist_new_next( struct slist_element *se, void *user_data );

void slist_delete_element( struct slist_state *ss, struct slist_element *se );
void slist_delete_all_elements( struct slist_state *ss );

int slist_get_user_data_from_element( struct slist_element *se, void **user_data );
int slist_set_user_data_in_element( struct slist_element *se, void *user_data );

struct slist_element *slist_get_head( struct slist_state *ss, struct slist_element **se );
struct slist_element *slist_get_next( struct slist_element *se, struct slist_element **next_se );
struct slist_element *slist_get_head_and_then_next( struct slist_state *ss, struct slist_element **se );

#endif /* !HLX_BUILD_WITH_KERNEL_THREAD */

#define __LIBLFDS_H

#endif