Campbell Barton
4ab47a7670
For areas that require append, store the last node, Previous behavior would too easily hide poorly performing code. Also avoid (prepend, reverse) where possible.
96 lines
3.9 KiB
C++
96 lines
3.9 KiB
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 *****
|
|
*/
|
|
|
|
#ifndef __BLI_LINKLIST_H__
|
|
#define __BLI_LINKLIST_H__
|
|
|
|
/** \file BLI_linklist.h
|
|
* \ingroup bli
|
|
* \brief Routines for working with singly linked lists
|
|
* of 'links' - pointers to other data.
|
|
*
|
|
*/
|
|
|
|
#include "BLI_compiler_attrs.h"
|
|
|
|
struct MemArena;
|
|
struct BLI_mempool;
|
|
|
|
typedef void (*LinkNodeFreeFP)(void *link);
|
|
typedef void (*LinkNodeApplyFP)(void *link, void *userdata);
|
|
|
|
typedef struct LinkNode {
|
|
struct LinkNode *next;
|
|
void *link;
|
|
} LinkNode;
|
|
|
|
/**
|
|
* Use for append (single linked list, storing the last element).
|
|
*
|
|
* \note list manipulation functions don't operate on this struct.
|
|
* This is only to be used while appending.
|
|
*/
|
|
typedef struct LinkNodePair {
|
|
LinkNode *list, *last_node;
|
|
} LinkNodePair;
|
|
|
|
int BLI_linklist_count(LinkNode *list) ATTR_WARN_UNUSED_RESULT;
|
|
int BLI_linklist_index(LinkNode *list, void *ptr) ATTR_WARN_UNUSED_RESULT;
|
|
|
|
LinkNode *BLI_linklist_find(LinkNode *list, int index) ATTR_WARN_UNUSED_RESULT;
|
|
|
|
void BLI_linklist_reverse(LinkNode **listp) ATTR_NONNULL(1);
|
|
|
|
void BLI_linklist_move_item(LinkNode **listp, int curr_index, int new_index) ATTR_NONNULL(1);
|
|
|
|
void BLI_linklist_prepend_nlink(LinkNode **listp, void *ptr, LinkNode *nlink) ATTR_NONNULL(1, 3);
|
|
void BLI_linklist_prepend(LinkNode **listp, void *ptr) ATTR_NONNULL(1);
|
|
void BLI_linklist_prepend_arena(LinkNode **listp, void *ptr, struct MemArena *ma) ATTR_NONNULL(1, 3);
|
|
void BLI_linklist_prepend_pool(LinkNode **listp, void *ptr, struct BLI_mempool *mempool) ATTR_NONNULL(1, 3);
|
|
|
|
/* use LinkNodePair to avoid full search */
|
|
void BLI_linklist_append_nlink(LinkNodePair *list_pair, void *ptr, LinkNode *nlink) ATTR_NONNULL(1, 3);
|
|
void BLI_linklist_append(LinkNodePair *list_pair, void *ptr) ATTR_NONNULL(1);
|
|
void BLI_linklist_append_arena(LinkNodePair *list_pair, void *ptr, struct MemArena *ma) ATTR_NONNULL(1, 3);
|
|
void BLI_linklist_append_pool(LinkNodePair *list_pair, void *ptr, struct BLI_mempool *mempool) ATTR_NONNULL(1, 3);
|
|
|
|
void *BLI_linklist_pop(LinkNode **listp) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
|
|
void *BLI_linklist_pop_pool(LinkNode **listp, struct BLI_mempool *mempool) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1, 2);
|
|
void BLI_linklist_insert_after(LinkNode **listp, void *ptr) ATTR_NONNULL(1);
|
|
|
|
void BLI_linklist_free(LinkNode *list, LinkNodeFreeFP freefunc);
|
|
void BLI_linklist_freeN(LinkNode *list);
|
|
void BLI_linklist_free_pool(LinkNode *list, LinkNodeFreeFP freefunc, struct BLI_mempool *mempool);
|
|
void BLI_linklist_apply(LinkNode *list, LinkNodeApplyFP applyfunc, void *userdata);
|
|
LinkNode *BLI_linklist_sort(LinkNode *list, int (*cmp)(const void *, const void *)) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(2);
|
|
LinkNode *BLI_linklist_sort_r(LinkNode *list, int (*cmp)(void *, const void *, const void *), void *thunk) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(2);
|
|
|
|
#define BLI_linklist_prepend_alloca(listp, ptr) \
|
|
BLI_linklist_prepend_nlink(listp, ptr, alloca(sizeof(LinkNode)))
|
|
|
|
#endif /* __BLI_LINKLIST_H__ */
|