File: stack.h

package info (click to toggle)
scummvm-tools 2.9.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 6,940 kB
  • sloc: cpp: 76,819; python: 6,550; sh: 4,661; perl: 1,530; ansic: 646; makefile: 360
file content (101 lines) | stat: -rw-r--r-- 2,587 bytes parent folder | download | duplicates (2)
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
/* 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