Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / blenlib / BLI_linklist.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 #ifndef __BLI_LINKLIST_H__
21 #define __BLI_LINKLIST_H__
22
23 /** \file \ingroup bli
24  */
25
26 #include "BLI_compiler_attrs.h"
27
28 struct BLI_mempool;
29 struct MemArena;
30
31 typedef void (*LinkNodeFreeFP)(void *link);
32 typedef void (*LinkNodeApplyFP)(void *link, void *userdata);
33
34 typedef struct LinkNode {
35         struct LinkNode *next;
36         void *link;
37 } LinkNode;
38
39 /**
40  * Use for append (single linked list, storing the last element).
41  *
42  * \note list manipulation functions don't operate on this struct.
43  * This is only to be used while appending.
44  */
45 typedef struct LinkNodePair {
46         LinkNode *list, *last_node;
47 } LinkNodePair;
48
49 int       BLI_linklist_count(const LinkNode *list) ATTR_WARN_UNUSED_RESULT;
50 int       BLI_linklist_index(const LinkNode *list, void *ptr)  ATTR_WARN_UNUSED_RESULT;
51
52 LinkNode *BLI_linklist_find(LinkNode *list, int index) ATTR_WARN_UNUSED_RESULT;
53
54 void      BLI_linklist_reverse(LinkNode **listp) ATTR_NONNULL(1);
55
56 void      BLI_linklist_move_item(LinkNode **listp, int curr_index, int new_index) ATTR_NONNULL(1);
57
58 void      BLI_linklist_prepend_nlink(LinkNode **listp, void *ptr, LinkNode *nlink) ATTR_NONNULL(1, 3);
59 void      BLI_linklist_prepend(LinkNode **listp, void *ptr) ATTR_NONNULL(1);
60 void      BLI_linklist_prepend_arena(LinkNode **listp, void *ptr, struct MemArena *ma) ATTR_NONNULL(1, 3);
61 void      BLI_linklist_prepend_pool(LinkNode **listp, void *ptr, struct BLI_mempool *mempool) ATTR_NONNULL(1, 3);
62
63 /* use LinkNodePair to avoid full search */
64 void      BLI_linklist_append_nlink(LinkNodePair *list_pair, void *ptr, LinkNode *nlink) ATTR_NONNULL(1, 3);
65 void      BLI_linklist_append(LinkNodePair *list_pair, void *ptr) ATTR_NONNULL(1);
66 void      BLI_linklist_append_arena(LinkNodePair *list_pair, void *ptr, struct MemArena *ma) ATTR_NONNULL(1, 3);
67 void      BLI_linklist_append_pool(LinkNodePair *list_pair, void *ptr, struct BLI_mempool *mempool) ATTR_NONNULL(1, 3);
68
69 void     *BLI_linklist_pop(LinkNode **listp) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
70 void     *BLI_linklist_pop_pool(LinkNode **listp, struct BLI_mempool *mempool) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1, 2);
71 void      BLI_linklist_insert_after(LinkNode **listp, void *ptr) ATTR_NONNULL(1);
72
73 void      BLI_linklist_free(LinkNode *list, LinkNodeFreeFP freefunc);
74 void      BLI_linklist_freeN(LinkNode *list);
75 void      BLI_linklist_free_pool(LinkNode *list, LinkNodeFreeFP freefunc, struct BLI_mempool *mempool);
76 void      BLI_linklist_apply(LinkNode *list, LinkNodeApplyFP applyfunc, void *userdata);
77 LinkNode *BLI_linklist_sort(LinkNode *list, int (*cmp)(const void *, const void *)) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(2);
78 LinkNode *BLI_linklist_sort_r(LinkNode *list, int (*cmp)(void *, const void *, const void *), void *thunk) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(2);
79
80 #define BLI_linklist_prepend_alloca(listp, ptr) \
81         BLI_linklist_prepend_nlink(listp, ptr, alloca(sizeof(LinkNode)))
82 #define BLI_linklist_append_alloca(list_pair, ptr) \
83         BLI_linklist_append_nlink(list_pair, ptr, alloca(sizeof(LinkNode)))
84
85 #endif  /* __BLI_LINKLIST_H__ */