File: stablemap.h

package info (click to toggle)
scummvm 2.9.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 450,580 kB
  • sloc: cpp: 4,299,825; asm: 28,322; python: 12,901; sh: 11,302; java: 9,289; xml: 7,895; perl: 2,639; ansic: 2,465; yacc: 1,670; javascript: 1,020; makefile: 933; lex: 578; awk: 275; objc: 82; sed: 11; php: 1
file content (214 lines) | stat: -rw-r--r-- 5,650 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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM 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 COMMON_STABLEMAP_H
#define COMMON_STABLEMAP_H

#include "common/rb_tree.h"

namespace Common {

/**
 * @defgroup common_stablemap stable map
 * @ingroup common
 *
 * @brief API for operating on a key value map
 *
 * @{
 */

/**
 * Ordered associative container meant as a drop-in replacement
 * for the C++ standard library's std::map.
 */
template<class Key, class Val, class CompFunc = Common::Less<Key> >
class StableMap {
	using TreeT = RBTree<Pair<Key, Val>, Key, PairFirst<Key, Val>, CompFunc>;

public:
	using value_type = Pair<Key, Val>;                    /*!< Type of the value obtained by dereferencing a StableMap iterator. */
	using iterator = typename TreeT::BasicIterator;       /*!< StableMap iterator. */
	using const_iterator = typename TreeT::ConstIterator; /*!< Const-qualified StableMap iterator. */

	/** Clears the contents of the map */
	void clear() {
		_items.clear();
	}

	/** Return an iterator pointing to the first element in the map. */
	iterator begin() {
		return _items.begin();
	}

	/** Return an iterator pointing to the last element in the map. */
	iterator end() {
		return _items.end();
	}

	/** Return a const iterator pointing to the first element in the map. */
	const_iterator begin() const {
		return _items.begin();
	}

	/** Return a const iterator pointing to the last element in the map. */
	const_iterator end() const {
		return _items.end();
	}

	/**
	 * Returns an iterator to the first item thas is not less than @p key
	 * in the map (or end() if this cannot be found).
	 */
	const_iterator lower_bound(const Key &key) const {
		return _items.lowerBound(key);
	}

	/**
	 * Returns a const iterator to the first item thas is not less than @p key
	 * in the map (or end() if this cannot be found).
	 */
	iterator lower_bound(const Key &key) {
		return _items.lowerBound(key);
	}

	/**
	 * Returns an iterator to the first item bigger than @p key
	 * in the map (or end() if this cannot be found).
	 */
	iterator upper_bound(const Key &key) {
		return _items.upperBound(key);
	}

	/**
	 * Returns an iterator to the item with the given key,
	 * or end() if the item was not found.
	 */
	iterator find(const Key &theKey) {
		iterator it = _items.lowerBound(theKey);
		if (it != this->end() && compareEqual(it->first, theKey))
			return it;
		return this->end();
	}

	/**
	 * Returns a const iterator to the item with the given key,
	 * or end() if the item was not found.
	 */
	const_iterator find(const Key &theKey) const {
		const_iterator it = _items.lowerBound(theKey);
		if (it != this->end() && compareEqual(it->first, theKey))
			return it;
		return this->end();
	}

	/**
	 * Square brackets operator accesses items by key, creating if necessary
	 */
	Val &operator[](const Key &theKey) {
		iterator it = _items.lowerBound(theKey);
		if (it == this->end() || !compareEqual(it->first, theKey)) {
			iterator i = _items.insert(value_type(theKey, Val()));
			return i->second;
		}
		return it->second;
	}

	/** Erases the item in the map pointed by @p it .*/
	iterator erase(iterator it) {
		return _items.erase(it);
	}

	/**
	 * Erase the elements from @p first to @p last and return an iterator pointing to the next element in the map.
	 * @note
	 * If [first, last) is not a valid range for the map, the behaviour is undefined.
	 */
	iterator erase(iterator first, iterator last) {
		return _items.erase(first, last);
	}

	/**
	 * Erases the item with the given key.
	 * Returns the number of elements removed (0 or 1)
	 */
	size_t erase(const Key &theKey) {
		iterator it = find(theKey);
		if (it != this->end()) {
			erase(it);
			return 1;
		}
		return 0;
	}

	/**
	 * Tries to insert the value @p val in the map. If the value is inserted,
	 * the pair (it, true), where it is the iterator to the inserted value,
	 * is returned, otherwise (lower_bound(val), false) is returned
	 */
	Pair<iterator, bool> insert(const value_type &val) {
		iterator it = _items.lowerBound(val.first);
		if (it == this->end() || !compareEqual(it->first, val.first))
			return {_items.insert(val), true};
		return {it, false};
	}

	/** Returns the size of the map. */
	size_t size() const {
		return _items.size();
	}

	/**
	 * Returns true if the map is empty.
	 * Shorthand for:
	 * @code
	 * map.size() == 0
	 * @endcode
	 */
	bool empty() const {
		return _items.isEmpty();
	}

	/**
	 * Returns the number of elements with a matching key
	 */
	size_t count(const Key &key) {
		int count_ = 0;
		for (iterator it = this->begin(); it != this->end(); ++it) {
			if (compareEqual(it->first, key))
				++count_;
		}
		return count_;
	}

private:
	bool compareEqual(const Key &a, const Key &b) const {
		return !_comp(a, b) && !_comp(b, a);
	}

	TreeT _items;
	CompFunc _comp;
};

/** @} */

} // End of namespace Common

#endif