doxygen: add newline after \file
[blender.git] / source / blender / blenlib / BLI_utildefines_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
17 #ifndef __BLI_UTILDEFINES_STACK_H__
18 #define __BLI_UTILDEFINES_STACK_H__
19
20 /** \file
21  * \ingroup bli
22  *
23  * Macro's for a simple array based stack
24  * \note Caller handles alloc & free.
25  */
26
27 /* only validate array-bounds in debug mode */
28 #ifdef DEBUG
29 #  define STACK_DECLARE(stack)   unsigned int _##stack##_index, _##stack##_totalloc
30 #  define STACK_INIT(stack, tot) ((void)stack, (void)((_##stack##_index) = 0), (void)((_##stack##_totalloc) = (tot)))
31 #  define _STACK_SIZETEST(stack, off) (BLI_assert((_##stack##_index) + (off) <= _##stack##_totalloc))
32 #  define _STACK_SWAP_TOTALLOC(stack_a, stack_b) SWAP(unsigned int, _##stack_a##_totalloc, _##stack_b##_totalloc)
33 #else
34 #  define STACK_DECLARE(stack)   unsigned int _##stack##_index
35 #  define STACK_INIT(stack, tot) ((void)stack, (void)((_##stack##_index) = 0), (void)(0 ? (tot) : 0))
36 #  define _STACK_SIZETEST(stack, off) (void)(stack), (void)(off)
37 #  define _STACK_SWAP_TOTALLOC(stack_a, stack_b) (void)(stack_a), (void)(stack_b)
38 #endif
39 #define _STACK_BOUNDSTEST(stack, index) ((void)stack, BLI_assert((unsigned int)(index) < _##stack##_index))
40
41
42 #define STACK_SIZE(stack)           ((void)stack, (_##stack##_index))
43 #define STACK_CLEAR(stack)          {(void)stack;  _##stack##_index = 0; } ((void)0)
44 /** add item to stack */
45 #define STACK_PUSH(stack, val)      ((void)stack, _STACK_SIZETEST(stack, 1),  ((stack)[(_##stack##_index)++] = (val)))
46 #define STACK_PUSH_RET(stack)       ((void)stack, _STACK_SIZETEST(stack, 1),  ((stack)[(_##stack##_index)++]))
47 #define STACK_PUSH_RET_PTR(stack)   ((void)stack, _STACK_SIZETEST(stack, 1), &((stack)[(_##stack##_index)++]))
48 /** take last item from stack */
49 #define STACK_POP(stack)            ((_##stack##_index) ?  ((stack)[--(_##stack##_index)]) : NULL)
50 #define STACK_POP_PTR(stack)        ((_##stack##_index) ? &((stack)[--(_##stack##_index)]) : NULL)
51 #define STACK_POP_DEFAULT(stack, r) ((_##stack##_index) ?  ((stack)[--(_##stack##_index)]) : (r))
52 /** look at last item (assumes non-empty stack) */
53 #define STACK_PEEK(stack)           (BLI_assert(_##stack##_index),  ((stack)[_##stack##_index - 1]))
54 #define STACK_PEEK_PTR(stack)       (BLI_assert(_##stack##_index), &((stack)[_##stack##_index - 1]))
55 /** remove any item from the stack, take care, re-orders */
56 #define STACK_REMOVE(stack, i) \
57         { \
58                 const unsigned int _i = i; \
59                 _STACK_BOUNDSTEST(stack, _i); \
60                 if (--_##stack##_index != _i) { \
61                         stack[_i] = stack[_##stack##_index]; \
62                 } \
63         } ((void)0)
64 #define STACK_DISCARD(stack, n) \
65         { \
66                 const unsigned int _n = n; \
67                 BLI_assert(_##stack##_index >= _n); \
68                 (void)stack; \
69                 _##stack##_index -= _n; \
70         } ((void)0)
71 #ifdef __GNUC__
72 #define STACK_SWAP(stack_a, stack_b) { \
73         SWAP(typeof(stack_a), stack_a, stack_b); \
74         SWAP(unsigned int, _##stack_a##_index, _##stack_b##_index); \
75         _STACK_SWAP_TOTALLOC(stack_a, stack_b); \
76 } ((void)0)
77 #else
78 #define STACK_SWAP(stack_a, stack_b) { \
79         SWAP(void *, stack_a, stack_b); \
80         SWAP(unsigned int, _##stack_a##_index, _##stack_b##_index); \
81         _STACK_SWAP_TOTALLOC(stack_a, stack_b); \
82 } ((void)0)
83 #endif
84
85 #endif  /* __BLI_UTILDEFINES_STACK_H__ */