LibLapin

The AStack module provides a stack container which is fully built on the program stack.

By being fully on the program stack -which means malloc is never called- an AStack instance is automatically destroyed when you leave the function in which it was built.

This container must be used with care:

Create it in the function you want it to be destroyed
Add nodes inside the stack only from the function where it was created
You can insert elements allocated with:
- bunny_alloca
- alloca
- By being a non static local variable
- Eventually, by being a global variable or a static variable
Never insert elements created by:
- malloc, calloc, realloc
- b‌u‌n‌n‌y‌_‌m‌a‌l‌l‌o‌c, b‌u‌n‌n‌y‌_‌c‌a‌l‌l‌o‌c, b‌u‌n‌n‌y‌_‌r‌e‌a‌l‌l‌o‌c
The general rule being: do not insert elements that need to be freed.

The Astack module is only available on systems that provide an alloca function.

The astack module header is lapin/container/astack.h.

typedef struct s_bunny_astack
{
const size_t length;
const void * const * const top;

} t‌_‌b‌u‌n‌n‌y‌_‌a‌s‌t‌a‌c‌k;

Description

This structure is the main data of the AStack container.

This type cannot be declared on stack. It must be created by a call to b‌u‌n‌n‌y‌_‌n‌e‌w‌_‌a‌s‌t‌a‌c‌k.

Attributes

const size_t length:
The amount of elements in the AStack container.
const void * const * const * top:
A pointer to a node containing the first element of the AStack container, and the address of its following element if there is one. This attribute is NULL if there is no element inside the AStack.

INDEX

typedef struct s_bunny_astack_node
{
void *data;
struct s_bunny_astack_node *next;

} t‌_‌b‌u‌n‌n‌y‌_‌a‌s‌t‌a‌c‌k‌_‌n‌o‌d‌e;

Description

This structure is the node in which every single data is referenced inside the stack.
This type is an inside type of the Astack module and should not be created by you.

Attributes

void *data:
A pointer to a stored data.
struct s_bunny_astack_node *next:
The node following the current one or NULL if there is none.

INDEX

Macro t‌_‌b‌u‌n‌n‌y‌_‌a‌s‌t‌a‌c‌k *b‌u‌n‌n‌y‌_‌n‌e‌w‌_‌a‌s‌t‌a‌c‌k(void);

Description

Create an Astack.

Return value

The function returns the address of the created Astack.
This function cannot fail without crashing your program by stack overflow.

INDEX

k

Macro size_t b‌u‌n‌n‌y‌_‌a‌s‌t‌a‌c‌k‌_‌s‌i‌z‌e(const t‌_‌b‌u‌n‌n‌y‌_‌a‌s‌t‌a‌c‌k *astack);

Description

Return the amount of elements inside the Astack container.

Parameters

const t‌_‌b‌u‌n‌n‌y‌_‌a‌s‌t‌a‌c‌k *astack:
The astack to extract the length from.

Return value

This function returns the amount of elements inside the Astack container.

INDEX

Macro bool b‌u‌n‌n‌y‌_‌a‌s‌t‌a‌c‌k‌_‌e‌m‌p‌t‌y(const t‌_‌b‌u‌n‌n‌y‌_‌a‌s‌t‌a‌c‌k *astack);

Description

Return if the sent Astack container is empty.

Parameters

const t‌_‌b‌u‌n‌n‌y‌_‌a‌s‌t‌a‌c‌k *astack:
The astack to extract the information about emptyness from.

Return value

This function returns true if the sent Astack is empty.

INDEX

Macro type b‌u‌n‌n‌y‌_‌a‌s‌t‌a‌c‌k‌_‌t‌o‌p(t‌_‌b‌u‌n‌n‌y‌_‌a‌s‌t‌a‌c‌k *astack, type);

Description

Return the element that is on top of the sent Astack.

Parameters

t‌_‌b‌u‌n‌n‌y‌_‌a‌s‌t‌a‌c‌k *astack:
The astack to extract the top element from.
type:
     The type of the element you want to extract. For example:

          int *ptr;

          ptr = b‌u‌n‌n‌y‌_‌a‌s‌t‌a‌c‌k‌_‌t‌o‌p(astack, int*);

Return value

This function returns the top element of the sent Astack or NULL if there is none.

INDEX

Macro void b‌u‌n‌n‌y‌_‌a‌s‌t‌a‌c‌k‌_‌p‌u‌s‌h(t‌_‌b‌u‌n‌n‌y‌_‌a‌s‌t‌a‌c‌k *astack, data);

Description

Push at the top of the Astack the sent data.

Parameters

t‌_‌b‌u‌n‌n‌y‌_‌a‌s‌t‌a‌c‌k *astack:
The Astack in which the data will be pushed.
data:
A data of any type that will be pushed at the top of the Astack.

INDEX

Macro void b‌u‌n‌n‌y‌_‌a‌s‌t‌a‌c‌k‌_‌p‌o‌p(t‌_‌b‌u‌n‌n‌y‌_‌a‌s‌t‌a‌c‌k *astack);

Description

Remove the top element from the sent Astack.
Do not attempt to pop an empty stack!

Parameters

t‌_‌b‌u‌n‌n‌y‌_‌a‌s‌t‌a‌c‌k *astack:
The Astack in which the data will be pushed.

INDEX