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