c2aefc3f283704a5de3de5290da9127a61706c85
[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 var 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), 1, 64, BLI_MEMPOOL_NOP); \
60 } (void)0
61
62 #define BLI_LINKSTACK_SIZE(var) \
63         BLI_mempool_count(_##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_ELSE(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_ELSE(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_DECLARE(var, type) \
120         LinkNode *_##var##_stack = NULL, *_##var##_free = NULL, *_##var##_temp = NULL; \
121         type _##var##_type
122
123 #define BLI_SMALLSTACK_PUSH(var, data) \
124 { \
125         CHECK_TYPE_PAIR(data, _##var##_type); \
126         if (_##var##_free) { \
127                 _##var##_temp = _##var##_free; \
128                 _##var##_free = _##var##_free->next; \
129         } \
130         else { \
131                 _##var##_temp = alloca(sizeof(LinkNode)); \
132         } \
133         _##var##_temp->next = _##var##_stack; \
134         _##var##_temp->link = data; \
135         _##var##_stack = _##var##_temp; \
136 } (void)0
137
138 /* internal use, no null check */
139 #define _BLI_SMALLSTACK_DEL(var) \
140         (void)((_##var##_temp = _##var##_stack->next), \
141                (_##var##_stack->next = _##var##_free), \
142                (_##var##_free = _##var##_stack), \
143                (_##var##_stack = _##var##_temp)) \
144
145 /* check for typeof() */
146 #define BLI_SMALLSTACK_POP(var) \
147         (_BLI_SMALLSTACK_CAST(var) ((_##var##_stack) ? \
148         (_BLI_SMALLSTACK_DEL(var), (_##var##_free->link)) : NULL))
149
150 /* loop over stack members last-added-first */
151 #define BLI_SMALLSTACK_ITER_BEGIN(var, item) \
152         { \
153                 LinkNode *_##var##_iter; \
154                 for (_##var##_iter = _##var##_stack; _##var##_iter; _##var##_iter = _##var##_iter->next) { \
155                         item = _BLI_SMALLSTACK_CAST(var) (_##var##_iter->link); \
156
157 #define BLI_SMALLSTACK_ITER_END \
158                 } \
159         } (void)0
160
161 #define BLI_SMALLSTACK_FREE(var)  { \
162         (void)&(_##var##_type); \
163 } (void)0
164
165 /** \} */
166
167 #endif  /* __BLI_LINKLIST_STACK_H__ */
168