src/list.h

Go to the documentation of this file.

#ifdef __cplusplus
extern "C" {
#endif 

#ifndef CDSA_LIST_H
#define CDSA_LIST_H

#include <stdio.h>
#include <stdlib.h>
#include <stdbool.h>
#include <assert.h>

#include "cdsa_types.h"

/* 
 * TODO: I don't like that insert occurs AFTER the element and still
 * takes linear time (due to checking the element is a member of the
 * given list). Perhaps insertion should happen BEFORE a given element,
 * in which case the linear-time check at least performs some useful
 * work in finding the previous node of the given element. Or ...?
 */

typedef struct List List;
struct List;

typedef struct ListNode ListNode;
struct ListNode;

cdsa_status_t list_new(List **list, size_t size_elem, cdsa_destroy_func1_t destroy);

cdsa_status_t list_destroy(List **list);

cdsa_status_t list_is_empty(List *list, bool *is_empty);

cdsa_status_t list_size(List *list, size_t *size);

cdsa_status_t list_head(List *list, ListNode **head);

cdsa_status_t list_tail(List *list, ListNode **tail);

cdsa_status_t list_prepend(List *list, void *data, ListNode **new_node);

cdsa_status_t list_append(List *list, void *data, ListNode **new_node);

cdsa_status_t list_insert(List *list, ListNode *elem, void *data, ListNode **new_node);

cdsa_status_t list_remove(List *list, ListNode *elem);

cdsa_status_t list_search(List *list, void *data, ListNode **node);

cdsa_status_t listelem_data(ListNode *elem, void *ptr);

cdsa_status_t listelem_next(ListNode *elem, ListNode **next);

cdsa_status_t listelem_destroy(ListNode **elem);


#ifdef __cplusplus
}
#endif

#endif

---