path: root/source/blender/blenlib/intern/BLI_linklist.c

/*
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 *
 * The Original Code is: all of this file.
 *
 * Contributor(s): none yet.
 *
 * ***** END GPL LICENSE BLOCK *****
 * Support for linked lists.
 */

/** \file blender/blenlib/intern/BLI_linklist.c
 *  \ingroup bli
 */


#include "MEM_guardedalloc.h"

#include "BLI_utildefines.h"
#include "BLI_linklist.h"
#include "BLI_memarena.h"
#include "BLI_mempool.h"

int BLI_linklist_length(LinkNode *list)
{
	int len;

	for (len = 0; list; list = list->next)
		len++;

	return len;
}

int BLI_linklist_index(LinkNode *list, void *ptr)
{
	int index;
	
	for (index = 0; list; list = list->next, index++)
		if (list->link == ptr)
			return index;
	
	return -1;
}

LinkNode *BLI_linklist_find(LinkNode *list, int index)
{
	int i;
	
	for (i = 0; list; list = list->next, i++)
		if (i == index)
			return list;

	return NULL;
}

void BLI_linklist_reverse(LinkNode **listp)
{
	LinkNode *rhead = NULL, *cur = *listp;
	
	while (cur) {
		LinkNode *next = cur->next;
		
		cur->next = rhead;
		rhead = cur;
		
		cur = next;
	}
	
	*listp = rhead;
}

/**
 * Move an item from its current position to a new one inside a single-linked list.
 * Note *listp may be modified.
 */
void BLI_linklist_move_item(LinkNode **listp, int curr_index, int new_index)
{
	LinkNode *lnk, *lnk_psrc = NULL, *lnk_pdst = NULL;
	int i;

	if (new_index == curr_index) {
		return;
	}

	if (new_index < curr_index) {
		for (lnk = *listp, i = 0; lnk; lnk = lnk->next, i++) {
			if (i == new_index - 1) {
				lnk_pdst = lnk;
			}
			else if (i == curr_index - 1) {
				lnk_psrc = lnk;
				break;
			}
		}

		if (!(lnk_psrc && lnk_psrc->next && (!lnk_pdst || lnk_pdst->next))) {
			/* Invalid indices, abort. */
			return;
		}

		lnk = lnk_psrc->next;
		lnk_psrc->next = lnk->next;
		if (lnk_pdst) {
			lnk->next = lnk_pdst->next;
			lnk_pdst->next = lnk;
		}
		else {
			/* destination is first element of the list... */
			lnk->next = *listp;
			*listp = lnk;
		}
	}
	else {
		for (lnk = *listp, i = 0; lnk; lnk = lnk->next, i++) {
			if (i == new_index) {
				lnk_pdst = lnk;
				break;
			}
			else if (i == curr_index - 1) {
				lnk_psrc = lnk;
			}
		}

		if (!(lnk_pdst && (!lnk_psrc || lnk_psrc->next))) {
			/* Invalid indices, abort. */
			return;
		}

		if (lnk_psrc) {
			lnk = lnk_psrc->next;
			lnk_psrc->next = lnk->next;
		}
		else {
			/* source is first element of the list... */
			lnk = *listp;
			*listp = lnk->next;
		}
		lnk->next = lnk_pdst->next;
		lnk_pdst->next = lnk;
	}
}

/**
 * A version of prepend that takes the allocated link.
 */
void BLI_linklist_prepend_nlink(LinkNode **listp, void *ptr, LinkNode *nlink)
{
	nlink->link = ptr;
	nlink->next = *listp;
	*listp = nlink;
}

void BLI_linklist_prepend(LinkNode **listp, void *ptr)
{
	LinkNode *nlink = MEM_mallocN(sizeof(*nlink), __func__);
	BLI_linklist_prepend_nlink(listp, ptr, nlink);
}

void BLI_linklist_prepend_arena(LinkNode **listp, void *ptr, MemArena *ma)
{
	LinkNode *nlink = BLI_memarena_alloc(ma, sizeof(*nlink));
	BLI_linklist_prepend_nlink(listp, ptr, nlink);
}

void BLI_linklist_prepend_pool(LinkNode **listp, void *ptr, BLI_mempool *mempool)
{
	LinkNode *nlink = BLI_mempool_alloc(mempool);
	BLI_linklist_prepend_nlink(listp, ptr, nlink);
}

/**
 * A version of append that takes the allocated link.
 */
void BLI_linklist_append_nlink(LinkNode **listp, void *ptr, LinkNode *nlink)
{
	LinkNode *node = *listp;
	
	nlink->link = ptr;
	nlink->next = NULL;
	
	if (node == NULL) {
		*listp = nlink;
	}
	else {
		while (node->next != NULL) {
			node = node->next;   
		}
		node->next = nlink;
	}
}

void BLI_linklist_append(LinkNode **listp, void *ptr)
{
	LinkNode *nlink = MEM_mallocN(sizeof(*nlink), __func__);
	BLI_linklist_append_nlink(listp, ptr, nlink);
}

void BLI_linklist_append_arena(LinkNode **listp, void *ptr, MemArena *ma)
{
	LinkNode *nlink = BLI_memarena_alloc(ma, sizeof(*nlink));
	BLI_linklist_append_nlink(listp, ptr, nlink);
}

void BLI_linklist_append_pool(LinkNode **listp, void *ptr, BLI_mempool *mempool)
{
	LinkNode *nlink = BLI_mempool_alloc(mempool);
	BLI_linklist_append_nlink(listp, ptr, nlink);
}

void *BLI_linklist_pop(struct LinkNode **listp)
{
	/* intentionally no NULL check */
	void *link = (*listp)->link;
	void *next = (*listp)->next;

	MEM_freeN((*listp));

	*listp = next;
	return link;
}

void *BLI_linklist_pop_pool(struct LinkNode **listp, struct BLI_mempool *mempool)
{
	/* intentionally no NULL check */
	void *link = (*listp)->link;
	void *next = (*listp)->next;

	BLI_mempool_free(mempool, (*listp));

	*listp = next;
	return link;
}

void BLI_linklist_insert_after(LinkNode **listp, void *ptr)
{
	LinkNode *nlink = MEM_mallocN(sizeof(*nlink), __func__);
	LinkNode *node = *listp;

	nlink->link = ptr;

	if (node) {
		nlink->next = node->next;
		node->next = nlink;
	}
	else {
		nlink->next = NULL;
		*listp = nlink;
	}
}

void BLI_linklist_free(LinkNode *list, LinkNodeFreeFP freefunc)
{
	while (list) {
		LinkNode *next = list->next;
		
		if (freefunc)
			freefunc(list->link);
		MEM_freeN(list);
		
		list = next;
	}
}

void BLI_linklist_free_pool(LinkNode *list, LinkNodeFreeFP freefunc, struct BLI_mempool *mempool)
{
	while (list) {
		LinkNode *next = list->next;

		if (freefunc)
			freefunc(list->link);
		BLI_mempool_free(mempool, list);

		list = next;
	}
}

void BLI_linklist_freeN(LinkNode *list)
{
	while (list) {
		LinkNode *next = list->next;

		MEM_freeN(list->link);
		MEM_freeN(list);

		list = next;
	}
}

void BLI_linklist_apply(LinkNode *list, LinkNodeApplyFP applyfunc, void *userdata)
{
	for (; list; list = list->next)
		applyfunc(list->link, userdata);
}