2023-05-31 16:19:06 +02:00
|
|
|
/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
|
|
|
|
*
|
|
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
2018-06-17 16:32:54 +02:00
|
|
|
|
2013-08-17 07:33:55 +02:00
|
|
|
#pragma once
|
|
|
|
|
2019-02-17 22:08:12 +01:00
|
|
|
/** \file
|
|
|
|
* \ingroup bli
|
2013-08-17 07:33:55 +02:00
|
|
|
* \brief BLI_LINKSTACK_*** wrapper macros for using a \a LinkNode
|
|
|
|
* to store a stack of pointers, using a single linked list
|
|
|
|
* allocated from a mempool.
|
|
|
|
*
|
|
|
|
* \note These macros follow STACK_* macros defined in 'BLI_utildefines.h'
|
|
|
|
* and should be kept (mostly) interchangeable.
|
|
|
|
*
|
2021-07-20 14:52:31 +02:00
|
|
|
* \note `_##var##_type` is a dummy variable only used for type-checks.
|
2013-08-17 07:33:55 +02:00
|
|
|
*/
|
|
|
|
|
2013-09-10 13:04:20 +02:00
|
|
|
/* -------------------------------------------------------------------- */
|
|
|
|
/** \name Linked Stack (mempool)
|
2020-10-27 11:32:09 +01:00
|
|
|
*
|
2013-09-10 13:04:20 +02:00
|
|
|
* Uses #BLI_mempool for storage.
|
|
|
|
* \{ */
|
|
|
|
|
2013-08-17 07:33:55 +02:00
|
|
|
#define BLI_LINKSTACK_DECLARE(var, type) \
|
|
|
|
LinkNode *var; \
|
2015-01-12 14:37:59 +01:00
|
|
|
BLI_mempool *var##_pool_; \
|
|
|
|
type var##_type_
|
2013-08-17 07:33:55 +02:00
|
|
|
|
|
|
|
#define BLI_LINKSTACK_INIT(var) \
|
|
|
|
{ \
|
|
|
|
var = NULL; \
|
2015-01-12 14:37:59 +01:00
|
|
|
var##_pool_ = BLI_mempool_create(sizeof(LinkNode), 0, 64, BLI_MEMPOOL_NOP); \
|
2013-08-17 07:33:55 +02:00
|
|
|
} \
|
|
|
|
(void)0
|
|
|
|
|
|
|
|
#define BLI_LINKSTACK_SIZE(var) BLI_mempool_len(var##_pool_)
|
|
|
|
|
2023-07-18 06:55:33 +02:00
|
|
|
/* Check for `decltype()` or `typeof()` support. */
|
|
|
|
#if defined(__cplusplus)
|
|
|
|
# define BLI_LINKSTACK_PUSH(var, ptr) \
|
|
|
|
(CHECK_TYPE_INLINE_NONCONST(ptr, decltype(var##_type_)), \
|
|
|
|
BLI_linklist_prepend_pool(&(var), ptr, var##_pool_))
|
|
|
|
# define BLI_LINKSTACK_POP(var) \
|
|
|
|
(decltype(var##_type_))(var ? BLI_linklist_pop_pool(&(var), var##_pool_) : NULL)
|
|
|
|
# define BLI_LINKSTACK_POP_DEFAULT(var, r) \
|
|
|
|
(decltype(var##_type_))(var ? BLI_linklist_pop_pool(&(var), var##_pool_) : r)
|
|
|
|
#elif defined(__GNUC__)
|
2013-08-17 07:33:55 +02:00
|
|
|
# define BLI_LINKSTACK_PUSH(var, ptr) \
|
2023-03-28 03:14:12 +02:00
|
|
|
(CHECK_TYPE_INLINE_NONCONST(ptr, typeof(var##_type_)), \
|
2015-01-12 14:37:59 +01:00
|
|
|
BLI_linklist_prepend_pool(&(var), ptr, var##_pool_))
|
2023-07-18 06:55:33 +02:00
|
|
|
# define BLI_LINKSTACK_POP(var) \
|
|
|
|
(typeof(var##_type_))(var ? BLI_linklist_pop_pool(&(var), var##_pool_) : NULL)
|
|
|
|
# define BLI_LINKSTACK_POP_DEFAULT(var, r) \
|
|
|
|
(typeof(var##_type_))(var ? BLI_linklist_pop_pool(&(var), var##_pool_) : r)
|
|
|
|
#else /* Non GCC/C++. */
|
2015-01-12 14:37:59 +01:00
|
|
|
# define BLI_LINKSTACK_PUSH(var, ptr) (BLI_linklist_prepend_pool(&(var), ptr, var##_pool_))
|
|
|
|
# define BLI_LINKSTACK_POP(var) (var ? BLI_linklist_pop_pool(&(var), var##_pool_) : NULL)
|
|
|
|
# define BLI_LINKSTACK_POP_DEFAULT(var, r) (var ? BLI_linklist_pop_pool(&(var), var##_pool_) : r)
|
2023-07-18 06:55:33 +02:00
|
|
|
#endif
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2013-08-17 07:33:55 +02:00
|
|
|
#define BLI_LINKSTACK_SWAP(var_a, var_b) \
|
|
|
|
{ \
|
2015-01-12 14:37:59 +01:00
|
|
|
CHECK_TYPE_PAIR(var_a##_type_, var_b##_type_); \
|
2013-08-17 07:33:55 +02:00
|
|
|
SWAP(LinkNode *, var_a, var_b); \
|
2015-01-12 14:37:59 +01:00
|
|
|
SWAP(BLI_mempool *, var_a##_pool_, var_b##_pool_); \
|
2013-08-17 07:33:55 +02:00
|
|
|
} \
|
|
|
|
(void)0
|
2019-04-17 06:17:24 +02:00
|
|
|
|
2013-08-17 07:33:55 +02:00
|
|
|
#define BLI_LINKSTACK_FREE(var) \
|
|
|
|
{ \
|
2015-01-12 14:37:59 +01:00
|
|
|
BLI_mempool_destroy(var##_pool_); \
|
|
|
|
var##_pool_ = NULL; \
|
|
|
|
(void)var##_pool_; \
|
2013-08-17 07:33:55 +02:00
|
|
|
var = NULL; \
|
|
|
|
(void)var; \
|
2015-01-12 14:37:59 +01:00
|
|
|
(void)&(var##_type_); \
|
2013-08-17 07:33:55 +02:00
|
|
|
} \
|
|
|
|
(void)0
|
|
|
|
|
|
|
|
#include "BLI_linklist.h"
|
|
|
|
#include "BLI_mempool.h"
|
|
|
|
|
2013-09-10 13:04:20 +02:00
|
|
|
/** \} */
|
|
|
|
|
|
|
|
/* -------------------------------------------------------------------- */
|
|
|
|
/** \name Linked Stack (alloca)
|
2020-10-27 11:32:09 +01:00
|
|
|
*
|
2013-09-10 13:04:20 +02:00
|
|
|
* Linked Stack, using stack memory (alloca).
|
|
|
|
*
|
|
|
|
* alloca never frees, pop'd items are stored in a free-list for reuse.
|
|
|
|
* only use for lists small enough to fit on the stack.
|
|
|
|
* \{ */
|
|
|
|
|
|
|
|
#ifdef __GNUC__
|
2013-09-10 17:41:01 +02:00
|
|
|
# define _BLI_SMALLSTACK_CAST(var) (typeof(_##var##_type))
|
2013-09-10 13:04:20 +02:00
|
|
|
#else
|
|
|
|
# define _BLI_SMALLSTACK_CAST(var)
|
|
|
|
#endif
|
|
|
|
|
2014-07-12 08:48:52 +02:00
|
|
|
#define _BLI_SMALLSTACK_FAKEUSER(var) (void)(&(_##var##_type))
|
|
|
|
|
2013-09-10 13:04:20 +02:00
|
|
|
#define BLI_SMALLSTACK_DECLARE(var, type) \
|
|
|
|
LinkNode *_##var##_stack = NULL, *_##var##_free = NULL, *_##var##_temp = NULL; \
|
|
|
|
type _##var##_type
|
|
|
|
|
|
|
|
#define BLI_SMALLSTACK_PUSH(var, data) \
|
|
|
|
{ \
|
|
|
|
CHECK_TYPE_PAIR(data, _##var##_type); \
|
|
|
|
if (_##var##_free) { \
|
|
|
|
_##var##_temp = _##var##_free; \
|
|
|
|
_##var##_free = _##var##_free->next; \
|
|
|
|
} \
|
|
|
|
else { \
|
2021-07-01 03:24:25 +02:00
|
|
|
_##var##_temp = (LinkNode *)alloca(sizeof(LinkNode)); \
|
2013-09-10 13:04:20 +02:00
|
|
|
} \
|
|
|
|
_##var##_temp->next = _##var##_stack; \
|
|
|
|
_##var##_temp->link = data; \
|
|
|
|
_##var##_stack = _##var##_temp; \
|
2014-07-12 08:48:52 +02:00
|
|
|
_BLI_SMALLSTACK_FAKEUSER(var); \
|
2013-09-10 13:04:20 +02:00
|
|
|
} \
|
|
|
|
(void)0
|
|
|
|
|
|
|
|
/* internal use, no null check */
|
2014-04-13 12:12:07 +02:00
|
|
|
#define _BLI_SMALLSTACK_DEL_EX(var_src, var_dst) \
|
2014-07-12 08:48:52 +02:00
|
|
|
(void)(_BLI_SMALLSTACK_FAKEUSER(var_src), \
|
|
|
|
_BLI_SMALLSTACK_FAKEUSER(var_dst), \
|
|
|
|
(_##var_src##_temp = _##var_src##_stack->next), \
|
2014-04-13 12:12:07 +02:00
|
|
|
(_##var_src##_stack->next = _##var_dst##_free), \
|
|
|
|
(_##var_dst##_free = _##var_src##_stack), \
|
|
|
|
(_##var_src##_stack = _##var_src##_temp))
|
|
|
|
|
|
|
|
#define _BLI_SMALLSTACK_DEL(var) _BLI_SMALLSTACK_DEL_EX(var, var)
|
2013-09-10 13:04:20 +02:00
|
|
|
|
|
|
|
/* check for typeof() */
|
|
|
|
#define BLI_SMALLSTACK_POP(var) \
|
2013-09-10 17:41:01 +02:00
|
|
|
(_BLI_SMALLSTACK_CAST(var)( \
|
|
|
|
(_##var##_stack) ? (_BLI_SMALLSTACK_DEL(var), (_##var##_free->link)) : NULL))
|
2013-09-10 13:04:20 +02:00
|
|
|
|
2014-04-13 12:12:07 +02:00
|
|
|
/* support to put the free-node into another stack */
|
|
|
|
#define BLI_SMALLSTACK_POP_EX(var_src, var_dst) \
|
|
|
|
(_BLI_SMALLSTACK_CAST(var_src)( \
|
|
|
|
(_##var_src##_stack) ? \
|
|
|
|
(_BLI_SMALLSTACK_DEL_EX(var_src, var_dst), (_##var_dst##_free->link)) : \
|
|
|
|
NULL))
|
|
|
|
|
2015-12-10 11:08:10 +01:00
|
|
|
#define BLI_SMALLSTACK_PEEK(var) \
|
2014-05-10 00:46:35 +02:00
|
|
|
(_BLI_SMALLSTACK_CAST(var)((_##var##_stack) ? _##var##_stack->link : NULL))
|
|
|
|
|
2014-07-08 23:52:06 +02:00
|
|
|
#define BLI_SMALLSTACK_IS_EMPTY(var) ((_BLI_SMALLSTACK_CAST(var) _##var##_stack) == NULL)
|
2014-05-10 00:46:35 +02:00
|
|
|
|
2015-04-29 15:54:32 +02:00
|
|
|
/* fill in a lookup table */
|
|
|
|
#define BLI_SMALLSTACK_AS_TABLE(var, data) \
|
|
|
|
{ \
|
|
|
|
LinkNode *_##var##_iter; \
|
|
|
|
unsigned int i; \
|
|
|
|
for (_##var##_iter = _##var##_stack, i = 0; _##var##_iter; \
|
|
|
|
_##var##_iter = _##var##_iter->next, i++) \
|
|
|
|
{ \
|
2023-07-26 16:12:55 +02:00
|
|
|
*(void **)&(data)[i] = _##var##_iter->link; \
|
2015-04-29 15:54:32 +02:00
|
|
|
} \
|
|
|
|
} \
|
|
|
|
((void)0)
|
|
|
|
|
2013-12-04 01:54:56 +01:00
|
|
|
/* loop over stack members last-added-first */
|
|
|
|
#define BLI_SMALLSTACK_ITER_BEGIN(var, item) \
|
|
|
|
{ \
|
|
|
|
LinkNode *_##var##_iter; \
|
|
|
|
for (_##var##_iter = _##var##_stack; _##var##_iter; _##var##_iter = _##var##_iter->next) { \
|
|
|
|
item = _BLI_SMALLSTACK_CAST(var)(_##var##_iter->link);
|
|
|
|
|
|
|
|
#define BLI_SMALLSTACK_ITER_END \
|
|
|
|
} \
|
|
|
|
} \
|
|
|
|
(void)0
|
|
|
|
|
2014-04-13 12:12:07 +02:00
|
|
|
#define BLI_SMALLSTACK_SWAP(var_a, var_b) \
|
|
|
|
{ \
|
|
|
|
CHECK_TYPE_PAIR(_##var_a##_type, _##var_b##_type); \
|
|
|
|
SWAP(LinkNode *, _##var_a##_stack, _##var_b##_stack); \
|
|
|
|
SWAP(LinkNode *, _##var_a##_free, _##var_b##_free); \
|
|
|
|
} \
|
|
|
|
(void)0
|
|
|
|
|
2013-09-10 13:04:20 +02:00
|
|
|
/** \} */
|