Fix T60285: allow negative offsets in shrinkwrap (worked in 2.79).
[blender.git] / source / blender / blenlib / BLI_linklist_stack.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_STACK_H__
29 #define __BLI_LINKLIST_STACK_H__
30
31 /** \file BLI_linklist_stack.h
32  * \ingroup bli
33  * \brief BLI_LINKSTACK_*** wrapper macros for using a \a LinkNode
34  *        to store a stack of pointers, using a single linked list
35  *        allocated from a mempool.
36  *
37  * \note These macros follow STACK_* macros defined in 'BLI_utildefines.h'
38  *       and should be kept (mostly) interchangeable.
39  *
40  * \note ``_##var##_type`` is a dummy variable only used for typechecks.
41  */
42
43 /* -------------------------------------------------------------------- */
44 /* Linked Stack using BLI_mempool
45  *
46  * Uses mempool for storage.
47  */
48
49 /** \name Linked Stack (mempool)
50  * \{ */
51
52 #define BLI_LINKSTACK_DECLARE(var, type) \
53         LinkNode *var; \
54         BLI_mempool *var##_pool_; \
55         type var##_type_
56
57 #define BLI_LINKSTACK_INIT(var)  { \
58         var = NULL; \
59         var##_pool_ = BLI_mempool_create(sizeof(LinkNode), 0, 64, BLI_MEMPOOL_NOP); \
60 } (void)0
61
62 #define BLI_LINKSTACK_SIZE(var) \
63         BLI_mempool_len(var##_pool_)
64
65 /* check for typeof() */
66 #ifdef __GNUC__
67 #define BLI_LINKSTACK_PUSH(var, ptr)  ( \
68         CHECK_TYPE_INLINE(ptr, typeof(var##_type_)), \
69         BLI_linklist_prepend_pool(&(var), ptr, var##_pool_))
70 #define BLI_LINKSTACK_POP(var) \
71         (var ? (typeof(var##_type_))BLI_linklist_pop_pool(&(var), var##_pool_) : NULL)
72 #define BLI_LINKSTACK_POP_DEFAULT(var, r) \
73         (var ? (typeof(var##_type_))BLI_linklist_pop_pool(&(var), var##_pool_) : r)
74 #else  /* non gcc */
75 #define BLI_LINKSTACK_PUSH(var, ptr)  ( \
76         BLI_linklist_prepend_pool(&(var), ptr, var##_pool_))
77 #define BLI_LINKSTACK_POP(var) \
78         (var ? BLI_linklist_pop_pool(&(var), var##_pool_) : NULL)
79 #define BLI_LINKSTACK_POP_DEFAULT(var, r) \
80         (var ? BLI_linklist_pop_pool(&(var), var##_pool_) : r)
81 #endif  /* gcc check */
82
83 #define BLI_LINKSTACK_SWAP(var_a, var_b)  { \
84         CHECK_TYPE_PAIR(var_a##_type_, var_b##_type_); \
85         SWAP(LinkNode *, var_a, var_b); \
86         SWAP(BLI_mempool *, var_a##_pool_, var_b##_pool_); \
87 } (void)0
88
89 #define BLI_LINKSTACK_FREE(var)  { \
90         BLI_mempool_destroy(var##_pool_); \
91         var##_pool_ = NULL; (void)var##_pool_; \
92         var = NULL; (void)var; \
93         (void)&(var##_type_); \
94 } (void)0
95
96 #include "BLI_linklist.h"
97 #include "BLI_mempool.h"
98
99 /** \} */
100
101
102 /* -------------------------------------------------------------------- */
103 /* Linked Stack, using stack memory (alloca)
104  *
105  * alloca never frees, pop'd items are stored in a free-list for reuse.
106  * only use for lists small enough to fit on the stack.
107  */
108
109
110 /** \name Linked Stack (alloca)
111  * \{ */
112
113 #ifdef __GNUC__
114 #  define _BLI_SMALLSTACK_CAST(var) (typeof(_##var##_type))
115 #else
116 #  define _BLI_SMALLSTACK_CAST(var)
117 #endif
118
119 #define _BLI_SMALLSTACK_FAKEUSER(var) \
120         (void)(&(_##var##_type))
121
122 #define BLI_SMALLSTACK_DECLARE(var, type) \
123         LinkNode *_##var##_stack = NULL, *_##var##_free = NULL, *_##var##_temp = NULL; \
124         type _##var##_type
125
126 #define BLI_SMALLSTACK_PUSH(var, data) \
127 { \
128         CHECK_TYPE_PAIR(data, _##var##_type); \
129         if (_##var##_free) { \
130                 _##var##_temp = _##var##_free; \
131                 _##var##_free = _##var##_free->next; \
132         } \
133         else { \
134                 _##var##_temp = alloca(sizeof(LinkNode)); \
135         } \
136         _##var##_temp->next = _##var##_stack; \
137         _##var##_temp->link = data; \
138         _##var##_stack = _##var##_temp; \
139         _BLI_SMALLSTACK_FAKEUSER(var); \
140 } (void)0
141
142 /* internal use, no null check */
143 #define _BLI_SMALLSTACK_DEL_EX(var_src, var_dst) \
144         (void)(_BLI_SMALLSTACK_FAKEUSER(var_src), \
145                _BLI_SMALLSTACK_FAKEUSER(var_dst), \
146                (_##var_src##_temp = _##var_src##_stack->next), \
147                (_##var_src##_stack->next = _##var_dst##_free), \
148                (_##var_dst##_free = _##var_src##_stack), \
149                (_##var_src##_stack = _##var_src##_temp)) \
150
151 #define _BLI_SMALLSTACK_DEL(var) \
152         _BLI_SMALLSTACK_DEL_EX(var, var) \
153
154 /* check for typeof() */
155 #define BLI_SMALLSTACK_POP(var) \
156         (_BLI_SMALLSTACK_CAST(var) ((_##var##_stack) ? \
157         (_BLI_SMALLSTACK_DEL(var), (_##var##_free->link)) : NULL))
158
159 /* support to put the free-node into another stack */
160 #define BLI_SMALLSTACK_POP_EX(var_src, var_dst) \
161         (_BLI_SMALLSTACK_CAST(var_src) ((_##var_src##_stack) ? \
162         (_BLI_SMALLSTACK_DEL_EX(var_src, var_dst), (_##var_dst##_free->link)) : NULL))
163
164 #define BLI_SMALLSTACK_PEEK(var) \
165         (_BLI_SMALLSTACK_CAST(var) ((_##var##_stack) ? \
166                                      _##var##_stack->link : NULL))
167
168 #define BLI_SMALLSTACK_IS_EMPTY(var) \
169         ((_BLI_SMALLSTACK_CAST(var) _##var##_stack) == NULL)
170
171 /* fill in a lookup table */
172 #define BLI_SMALLSTACK_AS_TABLE(var, data) \
173 { \
174         LinkNode *_##var##_iter; \
175         unsigned int i; \
176         for (_##var##_iter = _##var##_stack, i = 0; _##var##_iter; _##var##_iter = _##var##_iter->next, i++) { \
177                 (data)[i] = _BLI_SMALLSTACK_CAST(var) (_##var##_iter->link); \
178         } \
179 } ((void)0)
180
181 /* loop over stack members last-added-first */
182 #define BLI_SMALLSTACK_ITER_BEGIN(var, item) \
183         { \
184                 LinkNode *_##var##_iter; \
185                 for (_##var##_iter = _##var##_stack; _##var##_iter; _##var##_iter = _##var##_iter->next) { \
186                         item = _BLI_SMALLSTACK_CAST(var) (_##var##_iter->link); \
187
188 #define BLI_SMALLSTACK_ITER_END \
189                 } \
190         } (void)0
191
192 #define BLI_SMALLSTACK_SWAP(var_a, var_b) \
193 { \
194         CHECK_TYPE_PAIR(_##var_a##_type, _##var_b##_type); \
195         SWAP(LinkNode *, _##var_a##_stack, _##var_b##_stack); \
196         SWAP(LinkNode *, _##var_a##_free, _##var_b##_free); \
197 } (void)0
198
199 /** \} */
200
201 #endif  /* __BLI_LINKLIST_STACK_H__ */