wiki.burkey.co

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== stack ======

LIFO (last in first out) stack structure

===== Structs =====

''%%Stack%%'' is a linked list with stack-based operations available

<code c>
#define Stack List
</code>

===== Functions =====

==== stack_init ====

Intializes the stack. The user is responsible for creating the initial ''%%Stack%%'' structure and freeing memory with ''%%stack_destroy()%%''. ''%%destroy%%'' is a deallocation function for the members of ''%%Stack%%'', pass ''%%NULL%%'' if the memory is stack-allocated

<code c>
void stack_init(Stack *stack, void (*destroy)(void *data));

/* Usage */
Stack *stack = malloc(sizeof(Stack));

// Pass NULL for stack-allocated memory
stack_init(stack, NULL);

// Pass free or a custom freeing function for heap allocated memory
stack_init(stack, free);
</code>

==== stack_destroy ====

Destroys the nodes inside a ''%%Stack%%'' and calls the deallocation funciton on the data if one was provided. Does not destroy the list itself, that is left up to the user.

<code c>
void stack_destroy(Stack *stack);
</code>

==== stack_push ====

Push a new element onto the top of the stack

<code c>
int stack_push(Stack *stack, void *data);
</code>

==== stack_peek ====

Returns a ''%%void *%%'' to the top element of the stack. Does not remove the element

<code c>
void *stack_peek(Stack *stack);

/* Usage */
// stack: 1 2 3
int *t = (int*)stack_peek(stack);
assert(*t == 3);
// stack: 1 2 3
</code>

==== stack_pop ====

Returns a ''%%void *%%'' to the top element of the stack and removes the element

<code c>
int stack_pop(Stack *stack, void **data);

/* Usage */
// stack: 1 2 3
int *t = (int*)stack_peek(stack);
assert(*t == 3);
// stack: 1 2
</code>
wiki.burkey.co

User Tools

Site Tools

Page Tools
