libamxc  1.10.3
C Generic Data Containers
amxc_astack.h File Reference

Ambiorix array stack API header file. More...

#include <amxc/amxc_common.h>
#include <amxc/amxc_array.h>

Go to the source code of this file.

Typedefs

typedef amxc_array_t amxc_astack_t
 The array stack structure. More...
 
typedef amxc_array_it_t amxc_astack_it_t
 The array stack iterator structure. More...
 
typedef amxc_array_it_delete_t amxc_astack_it_delete_t
 Definition of the item delete function. More...
 

Functions

AMXC_INLINE int amxc_astack_new (amxc_astack_t **astack)
 Allocates an array stack. More...
 
AMXC_INLINE void amxc_astack_delete (amxc_astack_t **astack, amxc_astack_it_delete_t func)
 Frees the previously allocated array stack. More...
 
AMXC_INLINE int amxc_astack_init (amxc_astack_t *const astack)
 Initializes an array stack. More...
 
AMXC_INLINE void amxc_astack_clean (amxc_astack_t *const astack, amxc_astack_it_delete_t func)
 Removes all items from the array stack. More...
 
AMXC_INLINE amxc_astack_it_tamxc_astack_push (amxc_astack_t *const astack, void *data)
 Adds an item to the array stack. More...
 
AMXC_INLINE void * amxc_astack_pop (amxc_astack_t *const astack)
 Removes the last added data from the stack. More...
 
AMXC_INLINE void * amxc_astack_peek (amxc_astack_t *const astack)
 Peek the top of the stack, without removing. More...
 
AMXC_INLINE size_t amxc_astack_size (const amxc_astack_t *const astack)
 Calculate the number of items on the stack, expressed in number of items. More...
 
AMXC_INLINE bool amxc_astack_is_empty (const amxc_astack_t *const astack)
 Checks that the array stack is empty. More...
 

Detailed Description

Ambiorix array stack API header file.

Definition in file amxc_astack.h.