no_os_list.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef _NO_OS_LIST_H_
#define _NO_OS_LIST_H_
 
/******************************************************************************/
/***************************** Include Files **********************************/
/******************************************************************************/
 
#include <stdint.h>
#include <stdbool.h>
 
/******************************************************************************/
/*************************** Types Declarations *******************************/
/******************************************************************************/
 
struct no_os_list_desc;
 
struct no_os_iterator;
 
typedef int32_t (*f_cmp)(void *data1, void *data2);
 
typedef int32_t (*f_add)(struct no_os_list_desc *list_desc, void *data);
 
typedef int32_t (*f_edit)(struct no_os_list_desc *list_desc, void *new_data);
 
typedef int32_t (*f_read)(struct no_os_list_desc *list_desc, void **data);
 
typedef int32_t (*f_get)(struct no_os_list_desc *list_desc, void **data);
 
enum no_os_adapter_type {
    NO_OS_LIST_DEFAULT,
    NO_OS_LIST_QUEUE,
    NO_OS_LIST_STACK,
    NO_OS_LIST_PRIORITY_LIST
};
 
struct no_os_list_desc {
    f_add   push;
    f_get   pop;
    f_read  top_next;
    f_read  back;
    f_edit  swap;
    void    *priv_desc;
};
 
/******************************************************************************/
/************************ Functions Declarations ******************************/
/******************************************************************************/
 
int32_t no_os_list_init(struct no_os_list_desc **list_desc,
            enum no_os_adapter_type type,
            f_cmp comparator);
int32_t no_os_list_remove(struct no_os_list_desc *list_desc);
int32_t no_os_list_get_size(struct no_os_list_desc *list_desc,
                uint32_t *out_size);
 
int32_t no_os_iterator_init(struct no_os_iterator **iter,
                struct no_os_list_desc *list_desc,
                bool start);
int32_t no_os_iterator_remove(struct no_os_iterator *iter);
int32_t no_os_iterator_move(struct no_os_iterator *iter, int32_t steps);
int32_t no_os_iterator_move_to_idx(struct no_os_iterator *iter, int32_t idx);
int32_t no_os_iterator_find(struct no_os_iterator *iter, void *cmp_data);
int32_t no_os_iterator_insert(struct no_os_iterator *iter, void *data,
                  bool after);
int32_t no_os_iterator_edit(struct no_os_iterator *iter, void *new_data);
int32_t no_os_iterator_read(struct no_os_iterator *iter, void **data);
int32_t no_os_iterator_get(struct no_os_iterator *iter, void **data);
int32_t no_os_list_add_first(struct no_os_list_desc *list_desc, void *data);
int32_t no_os_list_edit_first(struct no_os_list_desc *list_desc,
                  void *new_data);
int32_t no_os_list_read_first(struct no_os_list_desc *list_desc, void **data);
int32_t no_os_list_get_first(struct no_os_list_desc *list_desc, void **data);
 
int32_t no_os_list_add_last(struct no_os_list_desc *list_desc, void *data);
int32_t no_os_list_edit_last(struct no_os_list_desc *list_desc, void *new_data);
int32_t no_os_list_read_last(struct no_os_list_desc *list_desc, void **data);
int32_t no_os_list_get_last(struct no_os_list_desc *list_desc, void **data);
int32_t no_os_list_add_idx(struct no_os_list_desc *list_desc, void *data,
               uint32_t idx);
int32_t no_os_list_edit_idx(struct no_os_list_desc *list_desc, void *new_data,
                uint32_t idx);
int32_t no_os_list_read_idx(struct no_os_list_desc *list_desc, void **data,
                uint32_t idx);
int32_t no_os_list_get_idx(struct no_os_list_desc *list_desc, void **data,
               uint32_t idx);
int32_t no_os_list_add_find(struct no_os_list_desc *list_desc, void *data);
int32_t no_os_list_edit_find(struct no_os_list_desc *list_desc, void *new_data,
                 void *cmp_data);
int32_t no_os_list_read_find(struct no_os_list_desc *list_desc, void **data,
                 void *cmp_data);
int32_t no_os_list_get_find(struct no_os_list_desc *list_desc, void **data,
                void *cmp_data);
#endif // _NO_OS_LIST_H_