summaryrefslogtreecommitdiff
path: root/prism/util/pm_state_stack.h
blob: 1ce57a2209f0c26490153736d7710a2738eafeb4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
/**
 * @file pm_state_stack.h
 *
 * A stack of boolean values.
 */
#ifndef PRISM_STATE_STACK_H
#define PRISM_STATE_STACK_H

#include "prism/defines.h"

#include <stdbool.h>
#include <stdint.h>

/**
 * A struct that represents a stack of boolean values.
 */
typedef uint32_t pm_state_stack_t;

/**
 * Pushes a value onto the stack.
 *
 * @param stack The stack to push the value onto.
 * @param value The value to push onto the stack.
 */
void pm_state_stack_push(pm_state_stack_t *stack, bool value);

/**
 * Pops a value off the stack.
 *
 * @param stack The stack to pop the value off of.
 */
void pm_state_stack_pop(pm_state_stack_t *stack);

/**
 * Returns the value at the top of the stack.
 *
 * @param stack The stack to get the value from.
 * @return The value at the top of the stack.
 */
bool pm_state_stack_p(pm_state_stack_t *stack);

#endif