Files
2022-06-26 19:14:49 +02:00

102 lines
2.5 KiB
C++

/* ScummVM Tools
*
* ScummVM Tools is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
#ifndef DEC_STACK_H
#define DEC_STACK_H
#include <deque>
#include <iostream>
/**
* Stack class based on a deque.
*/
template<typename T>
class Stack {
private:
std::deque<T> _stack; ///< Container used for the stack.
public:
/**
* Returns whether or not the stack is empty.
*
* @return true if the stack is empty, false if it is not.
*/
bool empty() const { return _stack.empty(); }
/**
* Push an item onto the stack.
*
* @param item The item to push.
*/
void push(const T &item) { _stack.push_front(item); }
/**
* Pop an item from the stack and return it.
*
* @return The value popped from the stack.
*/
T pop() {
T retval = _stack.front();
_stack.pop_front();
return retval;
}
/**
* Return the topmost item on the stack without removing it.
*
* @return The topmost item on the stack.
*/
T &peek() { return _stack.front(); }
/**
* Return the topmost item on the stack without removing it.
*
* @return The topmost item on the stack.
*/
const T &peek() const { return _stack.front(); }
/**
* Return the item on the specificed stack position without removing it.
*
* @param pos The number of items to skip on the stack.
* @return The desired item from the stack.
*/
T &peekPos(size_t pos) {
if (pos >= _stack.size())
std::cerr << "WARNING: Looking outside stack\n";
return _stack.at(pos);
}
/**
* Return the item on the specificed stack position without removing it.
*
* @param pos The number of items to skip on the stack.
* @return The desired item from the stack.
*/
const T &peekPos(size_t pos) const {
if (pos >= _stack.size())
std::cerr << "WARNING: Looking outside stack\n";
return _stack.at(pos);
}
};
#endif