/* 
 * The MIT License
 *
 * Copyright 2020 The OpenNARS authors.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#ifndef STACK_H
#define STACK_H

/////////////
//  Stack  //
/////////////
//The stack for use by the hashtable

//References//
//-----------//
#include <stdlib.h>
#include <stdbool.h>
#include "Concept.h"

//Data structure//
//--------------//
typedef struct
{
    void** items;
    int stackpointer;
    int maxElements;
} Stack;

//Methods//
//-------//
void Stack_INIT(Stack *stack, void **items, int maxElements);
//Add a VMItem on the top of the stack
void Stack_Push(Stack *stack, void *item);
//Remove a VMItem from the top of the stack
void* Stack_Pop(Stack *stack);
//Check if there aren't VMItems left on the stack
bool Stack_IsEmpty(Stack *stack);

#endif