aboutsummaryrefslogtreecommitdiff
path: root/include/SafeVector.hpp
blob: 63125ad211c2b7cb708c9027b728c4e5bc2eeb11 (plain)
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
#pragma once

#include <vector>
#include <functional>
#include <assert.h>
#include "gui/Widget.hpp"

template <typename T>
struct SafeVectorItem {
    T item;
    bool alive = false;
};

// A vector that can be modified while iterating
template <typename T>
class SafeVector {
public:
    using PointerType = typename std::pointer_traits<T>::element_type*;

    SafeVector() = default;
    SafeVector(const SafeVector&) = delete;
    SafeVector& operator=(const SafeVector&) = delete;
    ~SafeVector() {
        clear();
    }

    void push_back(T item) {
        data.push_back({std::move(item), true});
        ++num_items_alive;
    }

    // Safe to call when vector is empty
    // TODO: Make this iterator safe
    void pop_back() {
        if(!data.empty()) {
            gsr::add_widget_to_remove(std::move(data.back().item));
            data.pop_back();
            --num_items_alive;
        }
    }

    // Might not remove the data immediately if inside for_each loop.
    // In that case the item is removed at the end of the loop.
    void remove(PointerType item_to_remove) {
        if(for_each_depth == 0) {
            remove_item(item_to_remove);
            return;
        }

        SafeVectorItem<T> *item = get_item(item_to_remove);
        if(item && item->alive) {
            item->alive = false;
            --num_items_alive;
            has_items_to_remove = true;
        }
    }

    // Safe to call when vector is empty, in which case it returns nullptr
    T* back() {
        for(auto it = data.rbegin(), end = data.rend(); it != end; ++it) {
            if(it->alive)
                return &it->item;
        }
        return nullptr;
    }

    // TODO: Make this iterator safe
    void clear() {
        for(auto &item : data) {
            gsr::add_widget_to_remove(std::move(item.item));
        }
        data.clear();
        num_items_alive = 0;
    }

    // Return true from |callback| to continue. This function returns false if |callback| returned false
    bool for_each(std::function<bool(T &t)> callback, bool include_dead = false) {
        bool result = true;
        ++for_each_depth;

        for(size_t i = 0; i < data.size(); ++i) {
            if(data[i].alive || include_dead) {
                result = callback(data[i].item);
                if(!result)
                    break;
            }
        }

        --for_each_depth;
        if(for_each_depth == 0)
            remove_dead_items();

        return result;
    }

    // Return true from |callback| to continue. This function returns false if |callback| returned false
    bool for_each_reverse(std::function<bool(T &t)> callback, bool include_dead = false) {
        bool result = true;
        ++for_each_depth;

        int i = (int)data.size() - 1;
        while(true) {
            // pop_back can be called while iterating so handle that case
            if(i >= (int)data.size())
                i = (int)data.size() - 1;

            if(i < 0)
                break;

            if(data[i].alive || include_dead) {
                result = callback(data[i].item);
                if(!result)
                    break;
            }

            --i;
        }

        --for_each_depth;
        if(for_each_depth == 0)
            remove_dead_items();

        return result;
    }

    T& operator[](size_t index) {
        assert(index < data.size());
        return data[index].item;
    }

    const T& operator[](size_t index) const {
        assert(index < data.size());
        return data[index].item;
    }

    size_t size() const {
        return (size_t)num_items_alive;
    }

    bool empty() const {
        return num_items_alive == 0;
    }

    void replace_item(PointerType item_to_replace, T new_item) {
        SafeVectorItem<T> *item = get_item(item_to_replace);
        if(item->alive) {
            gsr::add_widget_to_remove(std::move(item->item));
            item->item = std::move(new_item);
        }
    }
private:
    void remove_item(PointerType item_to_remove) {
        for(auto it = data.begin(), end = data.end(); it != end; ++it) {
            if(&*(it->item) == item_to_remove) {
                gsr::add_widget_to_remove(std::move(it->item));
                data.erase(it);
                --num_items_alive;
                return;
            }
        }
    }

    SafeVectorItem<T>* get_item(PointerType item_to_remove) {
        for(auto &item : data) {
            if(&*(item.item) == item_to_remove)
                return &item;
        }
        return nullptr;
    }

    void remove_dead_items() {
        if(!has_items_to_remove)
            return;

        for(auto it = data.begin(); it != data.end();) {
            if(it->alive) {
                ++it;
            } else {
                gsr::add_widget_to_remove(std::move(it->item));
                it = data.erase(it);
            }
        }
        has_items_to_remove = false;
    }
private:
    std::vector<SafeVectorItem<T>> data;
    int for_each_depth = 0;
    int num_items_alive = 0;
    bool has_items_to_remove = false;
};