add linklist stack macros, use where over allocating an array was previously done.
[blender-staging.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 #define BLI_LINKSTACK_DECLARE(var, type) \
44         LinkNode *var; \
45         BLI_mempool *_##var##_pool; \
46         type _##var##_type
47
48 #define BLI_LINKSTACK_INIT(var)  { \
49         var = NULL; \
50         _##var##_pool = BLI_mempool_create(sizeof(LinkNode), 1, 64, 0); \
51 } (void)0
52
53 #define BLI_LINKSTACK_SIZE(var) \
54         BLI_mempool_count(_##var##_pool)
55
56 /* check for typeof() */
57 #ifdef __GNUC__
58 #define BLI_LINKSTACK_PUSH(var, ptr)  ( \
59         CHECK_TYPE_INLINE(ptr, typeof(_##var##_type)), \
60         BLI_linklist_prepend_pool(&(var), ptr, _##var##_pool))
61 #define BLI_LINKSTACK_POP(var) \
62         (var ? (typeof(_##var##_type))BLI_linklist_pop_pool(&(var), _##var##_pool) : NULL)
63 #define BLI_LINKSTACK_POP_ELSE(var, r) \
64         (var ? (typeof(_##var##_type))BLI_linklist_pop_pool(&(var), _##var##_pool) : r)
65 #else  /* non gcc */
66 #define BLI_LINKSTACK_PUSH(var, ptr)  ( \
67         BLI_linklist_prepend_pool(&(var), ptr, _##var##_pool))
68 #define BLI_LINKSTACK_POP(var) \
69         (var ? BLI_linklist_pop_pool(&(var), _##var##_pool) : NULL)
70 #define BLI_LINKSTACK_POP_ELSE(var, r) \
71         (var ? BLI_linklist_pop_pool(&(var), _##var##_pool) : r)
72 #endif  /* gcc check */
73
74 #define BLI_LINKSTACK_SWAP(var_a, var_b)  { \
75         CHECK_TYPE_PAIR(_##var_a##_type, _##var_b##_type); \
76         SWAP(LinkNode *, var_a, var_b); \
77         SWAP(BLI_mempool *, _##var_a##_pool, _##var_b##_pool); \
78 } (void)0
79
80 #define BLI_LINKSTACK_FREE(var)  { \
81         BLI_mempool_destroy(_##var##_pool); \
82         _##var##_pool = NULL; (void)_##var##_pool; \
83         var = NULL; (void)var; \
84         (void)_##var##_type; \
85 } (void)0
86
87 #include "BLI_linklist.h"
88 #include "BLI_mempool.h"
89
90 #endif  /* __BLI_LINKLIST_STACK_H__ */