faux/faux/list/list.c

/** @file list.c
 * @brief Implementation of a bidirectional list.
 *
 * Bidirectional List stores special structures (nodes) as its elements.
 * Nodes are linked to each other. Node stores abstract user data (i.e. void *).
 *
 * List can be sorted or unsorted. To sort list user provides special callback
 * function to compare two nodes. The list will be sorted
 * due to this function return value that indicates "less than",
 * "equal", "greater than". Additionally user may provide another callback
 * function to free user defined data on list freeing.
 */

#include <stdlib.h>
#include <assert.h>
#include <string.h>

#include "private.h"
#include "faux/list.h"


/** @brief Allocates and initializes new list node instance.
 *
 * @param [in] data User defined data to store within node.
 * @return Newly created list node instance or NULL on error.
 */
static faux_list_node_t *faux_list_new_node(void *data)
{
	faux_list_node_t *node = NULL;

	node = faux_zmalloc(sizeof(*node));
	assert(node);
	if (!node)
		return NULL;

	// Initialize
	node->prev = NULL;
	node->next = NULL;
	node->data = data;

	return node;
}


/** @brief Free list node instance.
 *
 * @param [in] node List node instance.
 */
static void faux_list_free_node(faux_list_node_t *node)
{
	faux_free(node);
}


/** @brief Gets previous list node.
 *
 * @param [in] this List node instance.
 * @return List node previous in list.
 */
faux_list_node_t *faux_list_prev_node(const faux_list_node_t *node)
{
	assert(node);
	if (!node)
		return NULL;

	return node->prev;
}


/** @brief Gets next list node.
 *
 * @param [in] this List node instance.
 * @return List node next in list.
 */
faux_list_node_t *faux_list_next_node(const faux_list_node_t *node)
{
	assert(node);
	if (!node)
		return NULL;

	return node->next;
}


/** @brief Gets user data from list node.
 *
 * @param [in] this List node instance.
 * @return User data stored within specified list node.
 */
void *faux_list_data(const faux_list_node_t *node)
{
	if (!node)
		return NULL;

	return node->data;
}


/** @brief Iterate through each list node.
 *
 * On each call to this function the iterator will change its value.
 * Before function using the iterator must be initialised by list head node.
 *
 * @param [in,out] iter List node ptr used as an iterator.
 * @return List node or NULL if list elements are over.
 */
faux_list_node_t *faux_list_each_node(faux_list_node_t **iter)
{
	faux_list_node_t *current_node = *iter;

	// No assert() on current_node. NULL iterator is normal
	if (!current_node)
		return NULL;
	*iter = faux_list_next_node(current_node);

	return current_node;
}


/** @brief Iterate through each list node. Reverse order.
 *
 * On each call to this function the iterator will change its value.
 * Before function using the iterator must be initialised by list tail node.
 *
 * @param [in,out] iter List node ptr used as an iterator.
 * @return List node or NULL if list elements are over.
 */
faux_list_node_t *faux_list_eachr_node(faux_list_node_t **iter)
{
	faux_list_node_t *current_node = *iter;

	// No assert() on current_node. NULL iterator is normal
	if (!current_node)
		return NULL;
	*iter = faux_list_prev_node(current_node);

	return current_node;
}


/** @brief Iterate through each list node and returns user data.
 *
 * On each call to this function the iterator will change its value.
 * Before function using the iterator must be initialised by list head node.
 *
 * @param [in,out] iter List node ptr used as an iterator.
 * @return User data or NULL if list elements are over.
 */
void *faux_list_each(faux_list_node_t **iter)
{
	faux_list_node_t *current_node = NULL;

	// No assert() on current_node. NULL iterator is normal
	if (!*iter)
		return NULL;
	current_node = faux_list_each_node(iter);

	return faux_list_data(current_node);
}


/** @brief Iterate (reverse order) through each list node and returns user data.
 *
 * On each call to this function the iterator will change its value.
 * Before function using the iterator must be initialised by list head node.
 *
 * @param [in,out] iter List node ptr used as an iterator.
 * @return User data or NULL if list elements are over.
 */
void *faux_list_eachr(faux_list_node_t **iter)
{
	faux_list_node_t *current_node = NULL;

	// No assert() on current_node. NULL iterator is normal
	if (!*iter)
		return NULL;
	current_node = faux_list_eachr_node(iter);

	return faux_list_data(current_node);
}


/** @brief Allocate and initialize bidirectional list.
 *
 * Prototypes for callback functions:
 * @code
 * int (*faux_list_cmp_fn)(const void *new_item, const void *list_item);
 * void faux_list_free_fn(void *data);
 * @endcode
 *
 * @param [in] sorted If list is sorted - FAUX_LIST_SORTED, unsorted - FAUX_LIST_UNSORTED.
 * @param [in] unique If list entry is unique - FAUX_LIST_UNIQUE, else - FAUX_LIST_NONUNIQUE.
 * @param [in] compareFn Callback function to compare two user data instances
 * to sort list.
 * @param [in] freeFn Callback function to free user data.
 * @return Newly created bidirectional list or NULL on error.
 */
faux_list_t *faux_list_new(faux_list_sorted_e sorted, faux_list_unique_e unique,
	faux_list_cmp_fn cmpFn, faux_list_kcmp_fn kcmpFn,
	faux_list_free_fn freeFn)
{
	faux_list_t *list = NULL;

	// Sorted list must have cmpFn
	if (sorted && !cmpFn)
		return NULL;

	// Unique list must have cmpFn
	if (unique && !cmpFn)
		return NULL;

	list = faux_zmalloc(sizeof(*list));
	assert(list);
	if (!list)
		return NULL;

	// Initialize
	list->head = NULL;
	list->tail = NULL;
	list->sorted = sorted;
	list->unique = unique;
	list->cmpFn = cmpFn;
	list->kcmpFn = kcmpFn;
	list->freeFn = freeFn;
	list->len = 0;

	return list;
}


/** @brief Delete all entries from list
 *
 * Removes and frees all list entries.
 *
 * @param [in] list List to empty.
 * @return Number of deleted entries or < 0 on error.
 */
ssize_t faux_list_del_all(faux_list_t *list)
{
	faux_list_node_t *iter = NULL;
	ssize_t num = 0;

	if (!list)
		return -1;

	while ((iter = faux_list_head(list))) {
		faux_list_del(list, iter);
		num++;
	}

	return num;
}


/** @brief Free bidirectional list
 *
 * Free all nodes and user data from list and finally
 * free the list itself. It uses special callback
 * function specified by user (while faux_list_new()) to free the abstract
 * user data.
 *
 * @param [in] list List to free.
 */
void faux_list_free(faux_list_t *list)
{
	faux_list_del_all(list);
	faux_free(list);
}


/** @brief Gets head of list.
 *
 * @param [in] list List.
 * @return List node first in list.
 */
faux_list_node_t *faux_list_head(const faux_list_t *list)
{
	assert(list);
	if (!list)
		return NULL;

	return list->head;
}


/** @brief Gets tail of list.
 *
 * @param [in] list List.
 * @return List node last in list.
 */
faux_list_node_t *faux_list_tail(const faux_list_t *list)
{
	assert(list);
	if (!list)
		return NULL;

	return list->tail;
}


/** @brief Gets current length of list.
 *
 * @param [in] list List.
 * @return Current length of list.
 */
size_t faux_list_len(const faux_list_t *list)
{
	assert(list);
	if (!list)
		return 0;

	return list->len;
}


/** @brief Checks is list empty.
 *
 * @param [in] list Allocated list.
 * @return BOOL_TRUE - empty, BOOL_FALSE - not empty.
 */
bool_t faux_list_is_empty(const faux_list_t *list)
{
	assert(list);
	if (!list)
		return BOOL_TRUE;

	if (faux_list_len(list) == 0)
		return BOOL_TRUE;

	return BOOL_FALSE;
}


/** @brief Generic static function for adding new list nodes.
 *
 * @param [in] list List to add node to.
 * @param [in] data User data for new list node.
 * key (when the cmpFn() returns 0)
 * @param [in] find - true/false Function returns list node if there is
 * identical entry. Or NULL if find is false.
 * @return Newly added list node.
 */
static faux_list_node_t *faux_list_add_generic(
	faux_list_t *list, void *data, bool_t find)
{
	faux_list_node_t *node = NULL;
	faux_list_node_t *iter = NULL;

	assert(list);
	assert(data);
	if (!list || !data)
		return NULL;

	node = faux_list_new_node(data);
	if (!node)
		return NULL;

	// Empty list
	if (!list->head) {
		list->head = node;
		list->tail = node;
		list->len++;
		return node;
	}

	// Non-sorted: Insert to tail
	if (!list->sorted) {
		// Unique: Search through whole list
		if (list->unique) {
			iter = list->tail;
			while (iter) {
				int res = list->cmpFn(node->data, iter->data);
				if (0 == res) { // Already in list
					faux_list_free_node(node);
					return (find ? iter : NULL);
				}
				iter = iter->prev;
			}
		}
		// Add entry to the tail
		node->prev = list->tail;
		node->next = NULL;
		if (list->tail)
			list->tail->next = node;
		list->tail = node;
		list->len++;
		return node;
	}

	// Sorted: Insert from tail
	iter = list->tail;
	while (iter) {
		int res = list->cmpFn(node->data, iter->data);
		// Unique: Already exists
		if (list->unique && (0 == res)) {
			faux_list_free_node(node);
			return (find ? iter : NULL);
		}
		// Non-unique: Entry will be inserted after existent one
		if (res >= 0) {
			node->next = iter->next;
			node->prev = iter;
			iter->next = node;
			if (node->next)
				node->next->prev = node;
			break;
		}
		iter = iter->prev;
	}
	// Insert node into the list head
	if (!iter) {
		node->next = list->head;
		node->prev = NULL;
		list->head->prev = node;
		list->head = node;
	}
	if (!node->next)
		list->tail = node;
	list->len++;

	return node;
}


/** @brief Adds user data to the list.
 *
 * The user data is not unique. It means that two equal user data instances
 * can be added to the list.
 *
 * @param [in] list List to add entry to.
 * @param [in] data User data.
 * @return Newly created list node or NULL on error.
 */
faux_list_node_t *faux_list_add(faux_list_t *list, void *data)
{
	return faux_list_add_generic(list, data, BOOL_FALSE);
}


/** @brief Adds user data (unique) to the list or return equal existent node.
 *
 * The user data must be unique in this case. Function compares list nodes
 * with the new one. If equal node is already in the list then function
 * returns this node. Else new unique node will be added to the list.
 *
 * @param [in] list List to add entry to.
 * @param [in] data User data.
 * @return Newly created list node, existent equal node or NULL on error.
 */
faux_list_node_t *faux_list_add_find(faux_list_t *list, void *data)
{
	assert(list);
	if (!list)
		return NULL;

	// Function add_find has no meaning for non-unique list. What is the
	// function behaviour? It found entry. Must it return existent entry or
	// add new non-unique entry?
	if (!list->unique)
		return NULL;

	return faux_list_add_generic(list, data, BOOL_TRUE);
}


/** Takes away list node from the list.
 *
 * Function removes list node from the list and returns user data
 * stored in this node.
 *
 * @param [in] list List to take away node from.
 * @param [in] node List node to take away.
 * @return User data from removed node or NULL on error.
 */
void *faux_list_takeaway(faux_list_t *list, faux_list_node_t *node)
{
	void *data = NULL;

	assert(list);
	assert(node);
	if (!list || !node)
		return NULL;

	if (node->prev)
		node->prev->next = node->next;
	else
		list->head = node->next;
	if (node->next)
		node->next->prev = node->prev;
	else
		list->tail = node->prev;
	list->len--;

	data = faux_list_data(node);
	faux_list_free_node(node);

	return data;
}


/** @brief Deletes list node from the list.
 *
 * Functions removes node from the list and free user data memory if
 * freeFn callback was defined while list creation. If freeFn callback
 * is not defined then function is the same as faux_list_takeaway().
 *
 * @param [in] list List to delete node from.
 * @param [in] node List node to delete.
 * @return BOOL_TRUE - success, BOOL_FALSE on error.
 */
bool_t faux_list_del(faux_list_t *list, faux_list_node_t *node)
{
	void *data = NULL;

	assert(list);
	assert(node);
	if (!list || !node)
		return BOOL_FALSE;

	data = faux_list_takeaway(list, node);
	assert(data);
	if (!data) // Illegal case
		return BOOL_FALSE;
	if (list->freeFn)
		list->freeFn(data);

	return BOOL_TRUE;
}


/** @brief Deletes list node from the list by user key.
 *
 * @sa faux_list_del()
 * @param [in] list List to delete node from.
 * @param [in] node User key to find node to delete.
 * @return BOOL_TRUE - success, BOOL_FALSE on error.
 */
bool_t faux_list_kdel(faux_list_t *list, const void *userkey)
{
	faux_list_node_t *node = NULL;

	assert(list);
	assert(userkey);
	if (!list || !userkey)
		return BOOL_FALSE;

	node = faux_list_kfind_node(list, userkey);
	if (!node)
		return BOOL_FALSE; // Not found

	return faux_list_del(list, node);
}


/** @brief Search list for matching (match function).
 *
 * Function iterates through the list and executes special matching user defined
 * callback function matchFn for every list node. User can provide "userkey" -
 * the data that matchFn can use how it wants. The matchFn is mandatory
 * argument. The userkey argument can be NULL. The function will immediately
 * return matched list node. To continue searching the iter argument contains
 * current iterator. So user can call to faux_list_match_node() for several
 * times and gets all matched nodes from list.
 * Before function using the iterator must be initialised by list head node.
 *
 * Prototype for matchFn callback function:
 * @code
 * int (*faux_list_kcmp_fn)(const void *key, const void *list_item);
 * @endcode
 *
 * @param [in] list List.
 * @param [in] matchFn User defined matching callback function.
 * @param [in] userkey User defined data to use in matchFn function.
 * @param [in,out] iter List node ptr used as an iterator.
 * @return Matched list node.
 */
faux_list_node_t *faux_list_match_node(const faux_list_t *list,
	faux_list_kcmp_fn matchFn, const void *userkey, faux_list_node_t **iter)
{
	faux_list_node_t *node = NULL;

	assert(list);
	assert(iter);
	assert(matchFn);
	if (!iter || !matchFn || !list)
		return NULL;

	while ((node = faux_list_each_node(iter))) {
		int res = matchFn(userkey, faux_list_data(node));
		if (0 == res)
			return node; // Match
		if (list->sorted && (res < 0)) // No chances to find match
			return NULL;
	}

	return NULL;
}


/** @brief Search list for matching (key cmp function).
 *
 * Same as faux_list_match_node() but uses userkey compare function defined
 * while faux_list_new() function call.
 *
 * @sa faux_list_match_node()
 */
faux_list_node_t *faux_list_kmatch_node(const faux_list_t *list,
	const void *userkey, faux_list_node_t **iter)
{
	assert(list);
	if (!list)
		return NULL;

	return faux_list_match_node(list, list->kcmpFn, userkey, iter);
}


/** @brief Search list for matching (match function) and returns user data.
 *
 * Same as faux_list_match_node() but returns user data structure.
 *
 * @sa faux_list_match_node()
 */
void *faux_list_match(const faux_list_t *list,
	faux_list_kcmp_fn matchFn, const void *userkey, faux_list_node_t **iter)
{
	faux_list_node_t *res =
		faux_list_match_node(list, matchFn, userkey, iter);
	if (!res)
		return NULL;

	return faux_list_data(res);
}


/** @brief Search list for matching (key cmp function) and returns user data.
 *
 * Same as faux_list_match() but uses userkey compare function defined
 * while faux_list_new() function call.
 *
 * @sa faux_list_match_node()
 */
void *faux_list_kmatch(const faux_list_t *list,
	const void *userkey, faux_list_node_t **iter)
{
	assert(list);
	if (!list)
		return NULL;

	return faux_list_match(list, list->kcmpFn, userkey, iter);
}


/** @brief Search list for first matching (match function).
 *
 * Same as faux_list_match_node() but search for the first matching.
 * Doesn't use saveptr iterator.
 *
 * @sa faux_list_match_node()
 */
faux_list_node_t *faux_list_find_node(const faux_list_t *list,
	faux_list_kcmp_fn matchFn, const void *userkey)
{
	faux_list_node_t *iter = NULL;

	assert(list);
	if (!list)
		return NULL;

	iter = faux_list_head(list);

	return faux_list_match_node(list, matchFn, userkey, &iter);
}


/** @brief Search list for first matching (key cmp function).
 *
 * Same as faux_list_find_node() but uses userkey compare function defined
 * while faux_list_new() function call.
 *
 * @sa faux_list_match_node()
 */
faux_list_node_t *faux_list_kfind_node(const faux_list_t *list,
	const void *userkey)
{
	assert(list);
	if (!list)
		return NULL;

	return faux_list_find_node(list, list->kcmpFn, userkey);
}


/** @brief Search list for first matching (match function) and returns user data.
 *
 * Same as faux_list_match_node() but returns user data structure and search
 * only for the first matching. Doesn't use saveptr iterator.
 *
 * @sa faux_list_match_node()
 */
void *faux_list_find(const faux_list_t *list, faux_list_kcmp_fn matchFn,
	const void *userkey)
{
	faux_list_node_t *iter = NULL;

	assert(list);
	if (!list)
		return NULL;

	iter = faux_list_head(list);

	return faux_list_match(list, matchFn, userkey, &iter);
}


/** @brief Search list for first matching (key cmp function). Returns user data.
 *
 * Same as faux_list_find() but uses userkey compare function defined
 * while faux_list_new() function call.
 *
 * @sa faux_list_match_node()
 */
void *faux_list_kfind(const faux_list_t *list,
	const void *userkey)
{
	assert(list);
	if (!list)
		return NULL;

	return faux_list_find(list, list->kcmpFn, userkey);
}


/** @brief Gets list node by index.
 *
 * Note getting item by index is not effective operation for list.
 *
 * @param [in] list List.
 * @param [in] index Item's index.
 * @return List node by index or NULL on error.
 */
faux_list_node_t *faux_list_index_node(const faux_list_t *list, size_t index)
{
	faux_list_node_t *iter = NULL;
	size_t i = 0;

	assert(list);
	if (!list)
		return NULL;
	if (index >= list->len)
		return NULL;

	iter = list->head;
	for (i = 0; i < index; i++)
		iter = faux_list_next_node(iter);

	return iter;
}


/** @brief Gets list item by index.
 *
 * Note getting item by index is not effective operation for list.
 *
 * @param [in] list List.
 * @param [in] index Item's index.
 * @return List node's data by index or NULL on error.
 */
void *faux_list_index(const faux_list_t *list, size_t index)
{
	faux_list_node_t *res =
		faux_list_index_node(list, index);
	if (!res)
		return NULL;

	return faux_list_data(res);
}