This is a very simple implementation of a stack which stores chunks of memory of any type. More...

Include dependency graph for void_stack.h:

Data Structures
struct	void_stack
	XXX: document this. More...
struct	void_stack_iterator
	XXX: document this. More...
Functions
void_stack *	void_stack_new (unsigned short max_size)
	Allocates a new void_stack.
void_stack *	void_stack_copy (const void_stack *v)
	Makes a shallow copy of void_stack.
void_stack *	void_stack_copy_reverse (const void_stack *v)
	Makes a shallow copy of void_stack in reverse order.
void	void_stack_free (void_stack *stack)
	Frees the memory associated with a void_stack, but not the elements held on the stack.
void	void_stack_free_deep (void_stack *stack)
	Frees the memory associated with a void_stack and the elements referenced by the stack.
unsigned short	void_stack_size (const void_stack *stack)
	Query the current number of elements on a void_stack()
void *	void_stack_pop (void_stack *stack)
	Removes the top element on a void_stack and returns a reference to it.
bool	void_stack_push (void_stack stack, void e)
	Puts a new element on the top of a void_stack.
const void *	void_stack_cur (const void_stack *stack)
	Returns a pointer to the current element on the top of the stack.
void_stack_iterator *	void_stack_iterator_new (const void_stack *stack)
	Creates a new iterator for the specified void_stack.
void	void_stack_iterator_free (void_stack_iterator *iter)
	Frees a void_stack_iterator.
const void *	void_stack_iterator_next (void_stack_iterator *iter)
	Returns a pointer to the the next element in the stack.

Detailed Description

This is a very simple implementation of a stack which stores chunks of memory of any type.

Function Documentation

void_stack* void_stack_new ( unsigned short max_size )

Allocates a new void_stack.

Parameters:

max_size the maxiumum number of elements which may be pushed onto the stack.

Returns:: a pointer to the newly allocated void_stack, or NULL if an error occurred.

Referenced by regfi_iterator_new(), void_stack_copy(), and void_stack_copy_reverse().

void_stack* void_stack_copy ( const void_stack * v )

Makes a shallow copy of void_stack.

Parameters:

v	the stack to make a copy of.

Returns:: a pointer to the duplicate void_stack, or NULL if an error occurred.

References void_stack_new().

void_stack* void_stack_copy_reverse ( const void_stack * v )

Makes a shallow copy of void_stack in reverse order.

Parameters:

v	the stack to make a copy of.

Returns:: a pointer to the duplicate void_stack (which will be in reverse order), or NULL if an error occurred.

References void_stack_new().

void void_stack_free ( void_stack * stack )

Frees the memory associated with a void_stack, but not the elements held on the stack.

Parameters:

stack the stack to be free()d.

void void_stack_free_deep ( void_stack * stack )

Frees the memory associated with a void_stack and the elements referenced by the stack.

Do not use this function if the elements of the stack are also free()d elsewhere, or contain pointers to other memory which cannot be otherwise free()d.

Parameters:

stack the stack to be free()d.

unsigned short void_stack_size ( const void_stack * stack )

Query the current number of elements on a void_stack()

Parameters:

stack the void_stack to query