BLI_stack.h File Reference

#include "BLI_compiler_attrs.h"

Go to the source code of this file.

Typedefs
typedef struct BLI_Stack	BLI_Stack

Functions
BLI_Stack *	BLI_stack_new_ex (size_t elem_size, const char *description, size_t chunk_size) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
BLI_Stack *	BLI_stack_new (size_t elem_size, const char *description) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
void	BLI_stack_free (BLI_Stack *stack) ATTR_NONNULL()
void *	BLI_stack_push_r (BLI_Stack *stack) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
void	BLI_stack_push (BLI_Stack *stack, const void *src) ATTR_NONNULL()
void	BLI_stack_pop_n (BLI_Stack *stack, void *dst, unsigned int n) ATTR_NONNULL()
void	BLI_stack_pop_n_reverse (BLI_Stack *stack, void *dst, unsigned int n) ATTR_NONNULL()
void	BLI_stack_pop (BLI_Stack *stack, void *dst) ATTR_NONNULL()
void *	BLI_stack_peek (BLI_Stack *stack) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
void	BLI_stack_discard (BLI_Stack *stack) ATTR_NONNULL()
void	BLI_stack_clear (BLI_Stack *stack) ATTR_NONNULL()
size_t	BLI_stack_count (const BLI_Stack *stack) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()
bool	BLI_stack_is_empty (const BLI_Stack *stack) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL()

Typedef Documentation

BLI_Stack

typedef struct BLI_Stack BLI_Stack

Definition at line 17 of file BLI_stack.h.

Function Documentation

BLI_stack_clear()

void BLI_stack_clear

(

BLI_Stack *

stack

)

Discards all elements without freeing.

Definition at line 195 of file stack.c.

References BLI_Stack::chunk_curr, BLI_Stack::chunk_elem_max, BLI_Stack::chunk_free, BLI_Stack::chunk_index, BLI_Stack::elem_num, StackChunk::next, NULL, and UNLIKELY.

Referenced by TEST().

BLI_stack_count()

size_t BLI_stack_count

(

const BLI_Stack *

stack

)

Definition at line 227 of file stack.c.

References BLI_Stack::chunk_curr, BLI_Stack::chunk_elem_max, BLI_Stack::chunk_index, data, and BLI_Stack::elem_num.

Referenced by BLI_bvhtree_intersect_plane(), BLI_bvhtree_overlap_ex(), BLI_stack_pop_n(), BLI_stack_pop_n_reverse(), BM_mesh_edgeloops_find(), BM_mesh_edgeloops_find_path(), BM_mesh_intersect_edges(), TEST(), TEST(), TEST(), and view3d_preselect_mesh_edgering_update_edges_from_edge().

BLI_stack_discard()

void BLI_stack_discard

(

BLI_Stack *

stack

)

Removes the top element from the stack.

Definition at line 175 of file stack.c.

References BLI_assert, BLI_stack_is_empty(), BLI_Stack::chunk_curr, BLI_Stack::chunk_elem_max, CHUNK_EMPTY, BLI_Stack::chunk_free, BLI_Stack::chunk_index, BLI_Stack::elem_num, StackChunk::next, and UNLIKELY.

Referenced by BLI_stack_pop(), bmo_subdivide_edges_exec(), filelist_readjob_recursive_dir_add_items(), knifetool_undo(), and TEST().

BLI_stack_free()

void BLI_stack_free

(

BLI_Stack *

stack

)

Free the stack's data and the stack itself

Definition at line 96 of file stack.c.

References BLI_Stack::chunk_curr, BLI_Stack::chunk_free, MEM_freeN(), and stack_free_chunks().

Referenced by BLI_bvhtree_intersect_plane(), BLI_bvhtree_overlap_ex(), bm_face_split(), BM_mesh_edgeloops_find(), BM_mesh_edgeloops_find_path(), BM_mesh_intersect_edges(), bmo_collapse_exec(), bmo_collapsecon_do_layer(), bmo_subdivide_edges_exec(), build_edge_mats(), blender::deg::deg_graph_flush_visibility_flags(), edbm_face_split_by_edges_exec(), filelist_readjob_recursive_dir_add_items(), knifetool_exit_ex(), paint_2d_bucket_fill(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), and view3d_preselect_mesh_edgering_update_edges_from_edge().

BLI_stack_is_empty()

bool BLI_stack_is_empty

(

const BLI_Stack *

stack

)

Returns true if the stack is empty, false otherwise

Definition at line 249 of file stack.c.

References BLI_assert, BLI_Stack::chunk_curr, BLI_Stack::elem_num, and NULL.

Referenced by BLI_stack_discard(), BLI_stack_peek(), BLI_stack_pop(), bm_face_split(), bmo_collapse_exec(), bmo_collapsecon_do_layer(), bmo_subdivide_edges_exec(), build_edge_mats(), blender::deg::deg_graph_flush_visibility_flags(), edbm_face_split_by_edges_exec(), filelist_readjob_recursive_dir_add_items(), knifetool_modal(), paint_2d_bucket_fill(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), and view3d_preselect_mesh_edgering_update_edges_from_edge().

BLI_stack_new()

BLI_Stack * BLI_stack_new	(	size_t	elem_size,
		const char *	description )

Create a new homogeneous stack with elements of 'elem_size' bytes.

Definition at line 82 of file stack.c.

References BLI_stack_new_ex(), and CHUNK_SIZE_DEFAULT.

BLI_stack_new_ex()

BLI_Stack * BLI_stack_new_ex	(	size_t	elem_size,
		const char *	description,
		size_t	chunk_size )

Definition at line 68 of file stack.c.

References BLI_Stack::chunk_elem_max, BLI_Stack::chunk_index, BLI_Stack::elem_size, MEM_callocN, and stack_chunk_elem_max_calc().

Referenced by BLI_stack_new().

BLI_stack_peek()

void * BLI_stack_peek

(

BLI_Stack *

stack

)

Definition at line 168 of file stack.c.

References BLI_assert, BLI_stack_is_empty(), and stack_get_last_elem().

Referenced by bmo_collapse_exec(), bmo_subdivide_edges_exec(), filelist_readjob_recursive_dir_add_items(), knifetool_undo(), TEST(), and view3d_preselect_mesh_edgering_update_edges_from_edge().

BLI_stack_pop()

void BLI_stack_pop	(	BLI_Stack *	stack,
		void *	dst )

Retrieves and removes the top element from the stack. The value is copies to dst, which must be at least elem_size bytes.

Does not reduce amount of allocated memory.

Definition at line 137 of file stack.c.

References BLI_assert, BLI_stack_discard(), BLI_stack_is_empty(), BLI_Stack::elem_size, and stack_get_last_elem().

Referenced by BLI_stack_pop_n(), BLI_stack_pop_n_reverse(), bm_face_split(), bmo_collapse_exec(), bmo_collapsecon_do_layer(), build_emats_stack(), blender::deg::deg_graph_flush_visibility_flags(), edbm_face_split_by_edges_exec(), knifetool_undo(), paint_2d_bucket_fill(), TEST(), TEST(), TEST(), TEST(), TEST(), and view3d_preselect_mesh_edgering_update_edges_from_edge().

BLI_stack_pop_n()

void BLI_stack_pop_n	(	BLI_Stack *	stack,
		void *	dst,
		unsigned int	n )

A version of BLI_stack_pop which fills in an array.

Parameters

dst	The destination array, must be at least (BLI_Stack.elem_size * n) bytes long.
n	The number of items to pop.

Note

The first item in the array will be last item added to the stack.

Definition at line 146 of file stack.c.

References BLI_assert, BLI_stack_count(), BLI_stack_pop(), and BLI_Stack::elem_size.

Referenced by BLI_bvhtree_intersect_plane(), BLI_bvhtree_overlap_ex(), and TEST().

BLI_stack_pop_n_reverse()

void BLI_stack_pop_n_reverse	(	BLI_Stack *	stack,
		void *	dst,
		unsigned int	n )

A version of BLI_stack_pop_n which fills in an array (in the reverse order).

Note

The first item in the array will be first item added to the stack.

Definition at line 156 of file stack.c.

References BLI_assert, BLI_stack_count(), BLI_stack_pop(), and BLI_Stack::elem_size.

Referenced by BM_mesh_edgeloops_find(), BM_mesh_edgeloops_find_path(), and BM_mesh_intersect_edges().

BLI_stack_push()

void BLI_stack_push	(	BLI_Stack *	stack,
		const void *	src )

Copies the source value onto the stack

Note

This copies BLI_Stack.elem_size bytes from src, (the pointer itself is not stored).

Parameters

src	source data to be copied to the stack.

Definition at line 131 of file stack.c.

References BLI_stack_push_r(), and BLI_Stack::elem_size.

Referenced by bm_face_split(), BM_mesh_edgeloops_find(), BM_mesh_edgeloops_find_path(), bmo_collapse_exec(), bmo_collapsecon_do_layer(), build_edge_mats(), build_emats_stack(), blender::deg::deg_graph_flush_visibility_flags(), edbm_face_split_by_edges_exec(), knife_split_edge(), paint_2d_bucket_fill(), paint_2d_fill_add_pixel_byte(), paint_2d_fill_add_pixel_float(), TEST(), TEST(), TEST(), TEST(), TEST(), TEST(), and view3d_preselect_mesh_edgering_update_edges_from_edge().

BLI_stack_push_r()

void * BLI_stack_push_r

(

BLI_Stack *

stack

)

Push a new item onto the stack.

Returns

a pointer BLI_Stack.elem_size bytes of uninitialized memory (caller must fill in).

Definition at line 103 of file stack.c.

References BLI_assert, BLI_Stack::chunk_curr, BLI_Stack::chunk_elem_max, BLI_Stack::chunk_free, BLI_Stack::chunk_index, BLI_Stack::elem_num, BLI_Stack::elem_size, MEM_mallocN, StackChunk::next, stack_get_last_elem(), and UNLIKELY.

Referenced by BLI_stack_push(), bm_edgexedge_isect_cb(), bm_edgexvert_isect_cb(), bm_vertxvert_isect_cb(), bmo_subdivide_edges_exec(), bvhtree_intersect_plane_dfs_recursive(), filelist_readjob_recursive_dir_add_items(), knife_add_cut(), tree_overlap_traverse(), tree_overlap_traverse_cb(), and tree_overlap_traverse_num().