Blame shared/nm-glib-aux/nm-c-list.h

Packit Service b23acc
// SPDX-License-Identifier: LGPL-2.1+
Packit Service b23acc
/*
Packit Service b23acc
 * Copyright (C) 2014 Red Hat, Inc.
Packit Service b23acc
 */
Packit Service b23acc
Packit Service b23acc
#ifndef __NM_C_LIST_H__
Packit Service b23acc
#define __NM_C_LIST_H__
Packit Service b23acc
Packit Service b23acc
#include "c-list/src/c-list.h"
Packit Service b23acc
Packit Service b23acc
/*****************************************************************************/
Packit Service b23acc
Packit Service b23acc
#define nm_c_list_contains_entry(list, what, member) \
Packit Service b23acc
	({ \
Packit Service b23acc
		typeof (what) _what = (what); \
Packit Service b23acc
		\
Packit Service b23acc
		_what && c_list_contains (list, &_what->member); \
Packit Service b23acc
	})
Packit Service b23acc
Packit Service b23acc
/* iterate over the list backwards. */
Packit Service b23acc
#define nm_c_list_for_each_entry_prev(_iter, _list, _m) \
Packit Service b23acc
	for (_iter = c_list_entry ((_list)->prev, __typeof__ (*_iter), _m); \
Packit Service b23acc
	     &(_iter)->_m != (_list); \
Packit Service b23acc
	     _iter = c_list_entry ((_iter)->_m.prev, __typeof__ (*_iter), _m))
Packit Service b23acc
Packit Service b23acc
/*****************************************************************************/
Packit Service b23acc
Packit Service b23acc
typedef struct {
Packit Service b23acc
	CList lst;
Packit Service b23acc
	void *data;
Packit Service b23acc
} NMCListElem;
Packit Service b23acc
Packit Service b23acc
static inline NMCListElem *
Packit Service b23acc
nm_c_list_elem_new_stale (void *data)
Packit Service b23acc
{
Packit Service b23acc
	NMCListElem *elem;
Packit Service b23acc
Packit Service b23acc
	elem = g_slice_new (NMCListElem);
Packit Service b23acc
	elem->data = data;
Packit Service b23acc
	return elem;
Packit Service b23acc
}
Packit Service b23acc
Packit Service b23acc
static inline gboolean
Packit Service b23acc
nm_c_list_elem_free_full (NMCListElem *elem, GDestroyNotify free_fcn)
Packit Service b23acc
{
Packit Service b23acc
	if (!elem)
Packit Service b23acc
		return FALSE;
Packit Service b23acc
	c_list_unlink_stale (&elem->lst);
Packit Service b23acc
	if (free_fcn)
Packit Service b23acc
		free_fcn (elem->data);
Packit Service b23acc
	g_slice_free (NMCListElem, elem);
Packit Service b23acc
	return TRUE;
Packit Service b23acc
}
Packit Service b23acc
Packit Service b23acc
static inline gboolean
Packit Service b23acc
nm_c_list_elem_free (NMCListElem *elem)
Packit Service b23acc
{
Packit Service b23acc
	return nm_c_list_elem_free_full (elem, NULL);
Packit Service b23acc
}
Packit Service b23acc
Packit Service b23acc
static inline void *
Packit Service b23acc
nm_c_list_elem_free_steal (NMCListElem *elem)
Packit Service b23acc
{
Packit Service b23acc
	gpointer data;
Packit Service b23acc
Packit Service b23acc
	if (!elem)
Packit Service b23acc
		return NULL;
Packit Service b23acc
	data = elem->data;
Packit Service b23acc
	nm_c_list_elem_free_full (elem, NULL);
Packit Service b23acc
	return data;
Packit Service b23acc
}
Packit Service b23acc
Packit Service b23acc
static inline void
Packit Service b23acc
nm_c_list_elem_free_all (CList *head, GDestroyNotify free_fcn)
Packit Service b23acc
{
Packit Service b23acc
	NMCListElem *elem;
Packit Service b23acc
Packit Service b23acc
	while ((elem = c_list_first_entry (head, NMCListElem, lst)))
Packit Service b23acc
		nm_c_list_elem_free_full (elem, free_fcn);
Packit Service b23acc
}
Packit Service b23acc
Packit Service b23acc
#define nm_c_list_elem_find_first(head, arg, predicate) \
Packit Service b23acc
	({ \
Packit Service b23acc
		CList *const _head = (head); \
Packit Service b23acc
		NMCListElem *_result = NULL; \
Packit Service b23acc
		NMCListElem *_elem; \
Packit Service b23acc
		\
Packit Service b23acc
		c_list_for_each_entry (_elem, _head, lst) { \
Packit Service b23acc
			void *const arg = _elem->data; \
Packit Service b23acc
			\
Packit Service b23acc
			if (predicate) { \
Packit Service b23acc
				_result = _elem; \
Packit Service b23acc
				break; \
Packit Service b23acc
			} \
Packit Service b23acc
		} \
Packit Service b23acc
		_result; \
Packit Service b23acc
	})
Packit Service b23acc
Packit Service b23acc
/**
Packit Service b23acc
 * nm_c_list_elem_find_first_ptr:
Packit Service b23acc
 * @head: the @CList head of a list containing #NMCListElem elements.
Packit Service b23acc
 *   Note that the head is not itself part of the list.
Packit Service b23acc
 * @needle: the needle pointer.
Packit Service b23acc
 *
Packit Service b23acc
 * Iterates the list and returns the first #NMCListElem with the matching @needle,
Packit Service b23acc
 * using pointer equality.
Packit Service b23acc
 *
Packit Service b23acc
 * Returns: the found list element or %NULL if not found.
Packit Service b23acc
 */
Packit Service b23acc
static inline NMCListElem *
Packit Service b23acc
nm_c_list_elem_find_first_ptr (CList *head, gconstpointer needle)
Packit Service b23acc
{
Packit Service b23acc
	return nm_c_list_elem_find_first (head, x, x == needle);
Packit Service b23acc
}
Packit Service b23acc
Packit Service b23acc
/*****************************************************************************/
Packit Service b23acc
Packit Service b23acc
/**
Packit Service b23acc
 * nm_c_list_move_before:
Packit Service b23acc
 * @lst: the list element to which @elem will be prepended.
Packit Service b23acc
 * @elem: the list element to move.
Packit Service b23acc
 *
Packit Service b23acc
 * This unlinks @elem from the current list and linkes it before
Packit Service b23acc
 * @lst. This is like c_list_link_before(), except that @elem must
Packit Service b23acc
 * be initialized and linked. Note that @elem may be linked in @lst
Packit Service b23acc
 * or in another list. In both cases it gets moved.
Packit Service b23acc
 *
Packit Service b23acc
 * Returns: %TRUE if there were any changes. %FALSE if elem was already
Packit Service b23acc
 *   linked at the right place.
Packit Service b23acc
 */
Packit Service b23acc
static inline gboolean
Packit Service b23acc
nm_c_list_move_before (CList *lst, CList *elem)
Packit Service b23acc
{
Packit Service b23acc
	nm_assert (lst);
Packit Service b23acc
	nm_assert (elem);
Packit Service b23acc
Packit Service b23acc
	if (   lst != elem
Packit Service b23acc
	    && lst->prev != elem) {
Packit Service b23acc
		c_list_unlink_stale (elem);
Packit Service b23acc
		c_list_link_before (lst, elem);
Packit Service b23acc
		return TRUE;
Packit Service b23acc
	}
Packit Service b23acc
	return FALSE;
Packit Service b23acc
}
Packit Service b23acc
#define nm_c_list_move_tail(lst, elem) nm_c_list_move_before (lst, elem)
Packit Service b23acc
Packit Service b23acc
/**
Packit Service b23acc
 * nm_c_list_move_after:
Packit Service b23acc
 * @lst: the list element to which @elem will be prepended.
Packit Service b23acc
 * @elem: the list element to move.
Packit Service b23acc
 *
Packit Service b23acc
 * This unlinks @elem from the current list and linkes it after
Packit Service b23acc
 * @lst. This is like c_list_link_after(), except that @elem must
Packit Service b23acc
 * be initialized and linked. Note that @elem may be linked in @lst
Packit Service b23acc
 * or in another list. In both cases it gets moved.
Packit Service b23acc
 *
Packit Service b23acc
 * Returns: %TRUE if there were any changes. %FALSE if elem was already
Packit Service b23acc
 *   linked at the right place.
Packit Service b23acc
 */
Packit Service b23acc
static inline gboolean
Packit Service b23acc
nm_c_list_move_after (CList *lst, CList *elem)
Packit Service b23acc
{
Packit Service b23acc
	nm_assert (lst);
Packit Service b23acc
	nm_assert (elem);
Packit Service b23acc
Packit Service b23acc
	if (   lst != elem
Packit Service b23acc
	    && lst->next != elem) {
Packit Service b23acc
		c_list_unlink_stale (elem);
Packit Service b23acc
		c_list_link_after (lst, elem);
Packit Service b23acc
		return TRUE;
Packit Service b23acc
	}
Packit Service b23acc
	return FALSE;
Packit Service b23acc
}
Packit Service b23acc
#define nm_c_list_move_front(lst, elem) nm_c_list_move_after (lst, elem)
Packit Service b23acc
Packit Service b23acc
#define nm_c_list_free_all(lst, type, member, destroy_fcn) \
Packit Service b23acc
	G_STMT_START { \
Packit Service b23acc
		CList *const _lst = (lst); \
Packit Service b23acc
		type *_elem; \
Packit Service b23acc
		\
Packit Service b23acc
		while ((_elem = c_list_first_entry (_lst, type, member))) { \
Packit Service b23acc
			destroy_fcn (_elem); \
Packit Service b23acc
		} \
Packit Service b23acc
	} G_STMT_END
Packit Service b23acc
Packit Service b23acc
#endif /* __NM_C_LIST_H__ */