stack.h

/**
 * Implementace překladače imperativního jazyka IFJ22
 *
 * @file stack.h
 * @author Josef Kuchař (xkucha28@stud.fit.vutbr.cz)
 * @author Matej Sirovatka (xsirov00@stud.fit.vutbr.cz)
 * @author Tomáš Běhal (xbehal02@stud.fit.vutbr.cz)
 * @author Šimon Benčík (xbenci01@stud.fit.vutbr.cz)
 * @brief Declarations of helper functions for working with stack
 */

#ifndef __STACK_H__
#define __STACK_H__

#include "token_term.h"

typedef struct {
    token_term_t** tokens;
    int len;
    int size;
} stack_t;

/**
 * @brief Initialize new stack struct
 *
 * @return New stack_t
 */
stack_t stack_new();

/**
 * @brief Frees stack
 *
 * @param stack to be freed
 */
void stack_free(stack_t* stack);

/**
 * @brief Removes all elements from stack (does not free stack)
 *
 * @param stack Stack
 */
void stack_empty(stack_t* stack);

/**
 * @brief Pushes value on the stack
 *
 * @param stack to be pushed to, token to be pushed
 */
void stack_push(stack_t* stack, token_term_t* token);

/**
 * @brief Removes and returns the top of the stack
 *
 * @param stack to be popped from
 *
 * @return token_term_t from top of the stack
 */
token_term_t* stack_pop(stack_t* stack);

/**
 * @brief Returns top of the stack
 *
 * @param stack to be popped from
 *
 * @return token_term_t from top of the stack
 */
token_term_t* stack_top(stack_t* stack);

/**
 * @brief Pretty prints stack
 *
 * @param stack to be printed
 */
void stack_pprint(stack_t* stack);

/**
 * @brief Returns terminal closest to the top of the stack and removes it
 *
 * @param stack to be popped from
 *
 * @return token_term_t from top of the stack
 */
token_term_t* stack_pop_terminal(stack_t* stack);

/**
 * @brief Returns terminal closest to the top of the stack
 *
 * @param stack to be popped from
 *
 * @return token_term_t from top of the stack
 */
token_term_t* stack_top_terminal(stack_t* stack);

/**
 * @brief Pushes start_handle after the terminal closest to the top
 *
 * @param stack to be pushed to
 */
void stack_push_after_terminal(stack_t* stack);

/**
 * @brief Resizes stack to twice the size
 *
 * @param stack to be resized
 */
void resize_stack(stack_t* stack);
#endif  // __STACK_H__