a9c943bef9
This PR implements range iterators in the base containers (Vector, Map, List, Pair Set).
Given several of these data structures will be replaced by more efficient versions, having a common iterator API will make this simpler.
Iterating can be done as follows (examples):
```C++
//Vector<String>
for(const String& I: vector) {
}
//List<String>
for(const String& I: list) {
}
//Map<String,int>
for(const KeyValue<String,int>&I : map) {
print_line("key: "+I.key+" value: "+itos(I.value));
}
//if intending to write the elements, reference can be used
//Map<String,int>
for(KeyValue<String,int>& I: map) {
I.value = 25;
//this will fail because key is always const
//I.key = "hello"
}
```
The containers are (for now) not STL compatible, since this would mean changing how they work internally (STL uses a special head/tail allocation for end(), while Godot Map/Set/List do not).
The idea is to change the Godot versions to be more compatible with STL, but this will happen after conversion to new iterators have taken place.
103 lines
3.7 KiB
C++
103 lines
3.7 KiB
C++
/*************************************************************************/
|
|
/* pair.h */
|
|
/*************************************************************************/
|
|
/* This file is part of: */
|
|
/* GODOT ENGINE */
|
|
/* https://godotengine.org */
|
|
/*************************************************************************/
|
|
/* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
|
|
/* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
|
|
/* */
|
|
/* 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 PAIR_H
|
|
#define PAIR_H
|
|
|
|
#include "core/typedefs.h"
|
|
|
|
template <class F, class S>
|
|
struct Pair {
|
|
F first;
|
|
S second;
|
|
|
|
Pair() :
|
|
first(),
|
|
second() {
|
|
}
|
|
|
|
Pair(F p_first, const S &p_second) :
|
|
first(p_first),
|
|
second(p_second) {
|
|
}
|
|
};
|
|
|
|
template <class F, class S>
|
|
bool operator==(const Pair<F, S> &pair, const Pair<F, S> &other) {
|
|
return (pair.first == other.first) && (pair.second == other.second);
|
|
}
|
|
|
|
template <class F, class S>
|
|
bool operator!=(const Pair<F, S> &pair, const Pair<F, S> &other) {
|
|
return (pair.first != other.first) || (pair.second != other.second);
|
|
}
|
|
|
|
template <class F, class S>
|
|
struct PairSort {
|
|
bool operator()(const Pair<F, S> &A, const Pair<F, S> &B) const {
|
|
return A.first < B.first;
|
|
}
|
|
};
|
|
|
|
template <class K, class V>
|
|
struct KeyValue {
|
|
const K key;
|
|
V value;
|
|
|
|
void operator=(const KeyValue &p_kv) = delete;
|
|
_FORCE_INLINE_ KeyValue(const KeyValue &p_kv) :
|
|
key(p_kv.key),
|
|
value(p_kv.value) {
|
|
}
|
|
_FORCE_INLINE_ KeyValue(const K &p_key, const V &p_value) :
|
|
key(p_key),
|
|
value(p_value) {
|
|
}
|
|
};
|
|
|
|
template <class K, class V>
|
|
bool operator==(const KeyValue<K, V> &pair, const KeyValue<K, V> &other) {
|
|
return (pair.key == other.key) && (pair.value == other.value);
|
|
}
|
|
|
|
template <class K, class V>
|
|
bool operator!=(const KeyValue<K, V> &pair, const KeyValue<K, V> &other) {
|
|
return (pair.key != other.key) || (pair.value != other.value);
|
|
}
|
|
|
|
template <class K, class V>
|
|
struct KeyValueSort {
|
|
bool operator()(const KeyValue<K, V> &A, const KeyValue<K, V> &B) const {
|
|
return A.key < B.key;
|
|
}
|
|
};
|
|
|
|
#endif // PAIR_H
|