sllist.c File Reference

Builds, traverses and releases a singly linked list. More...

#include <errno.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <libmgec/mge-errno.h>
#include <libmgec/sllist.h>

Include dependency graph for sllist.c:

Functions
static void	free_sll_node (struct sllistnode *currentnode)
struct sllistnode *	add_head_sll_node (struct sllistnode *head, const void *object, size_t objsize)
	Add a node to the start of the singly linked list.
struct sllistnode *	add_tail_sll_node (struct sllistnode *head, const void *object, size_t objsize)
	Add a node to the tail of the singly linked list.
void *	find_sll_node (struct sllistnode *head, const void *searchobj, int(*comp)(const void *, const void *))
	Find a node.
struct sllistnode *	free_sllist (struct sllistnode *head)
	Free the entire list.

Detailed Description

Builds, traverses and releases a singly linked list.

Build, manipulate and traverse functionality for singly linked lists.

Author

Copyright (C) 2016-2023, 2025 Mark Grant

Released under the GPLv3 only.
SPDX-License-Identifier: GPL-3.0-only

Version

v1.1.1 ==== 03/04/2025

Function Documentation

add_head_sll_node()

struct sllistnode * add_head_sll_node	(	struct sllistnode *	head,
		const void *	object,
		size_t	objsize
	)

Add a node to the start of the singly linked list.

On error mge_errno will be set.

Parameters

head	A pointer to the current root node or NULL if the list is not yet started.
object	The object to attach to the node.
objsize	The size of the attached object.

Returns

head, a pointer to the new root node or NULL on error

add_tail_sll_node()

struct sllistnode * add_tail_sll_node	(	struct sllistnode *	head,
		const void *	object,
		size_t	objsize
	)

Add a node to the tail of the singly linked list.

On error mge_errno will be set.

Parameters

head	A pointer to the root node or NULL if the list is not yet started.
object	The object to attach to the node.
objsize	The size of the attached object.

Returns

head, a pointer to the root node or NULL on error

find_sll_node()

void * find_sll_node	(	struct sllistnode *	head,
		const void *	searchobj,
		int(*)(const void *, const void *)	comp
	)

Find a node.

On error mge_errno will be set, otherwise it will be 0.

Parameters

head	A pointer to the current root node.
searchobj	The object to find. It does not need to be a fully populated object. It only needs enough inforamtion to support the comparison function, eg a key.
comp	A pointer to the comparison function to be used. This must have the same shape as strcmp.

Returns

A pointer to the object found, (the fully populated object), or NULL if not found or an error was encountered.

free_sll_node()

static void free_sll_node ( struct sllistnode *  currentnode )

static

free_sllist()

struct sllistnode * free_sllist

(

struct sllistnode *

head

)

Free the entire list.

Walks the list deleting nodes.

Parameters

head	The root node.

Returns

NULL