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