File: container.hxx

package info (click to toggle)
sight 25.2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 42,180 kB
  • sloc: cpp: 289,476; xml: 17,257; ansic: 9,878; python: 1,379; sh: 144; makefile: 33
file content (387 lines) | stat: -rw-r--r-- 11,419 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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
/************************************************************************
 *
 * Copyright (C) 2022-2024 IRCAD France
 *
 * This file is part of Sight.
 *
 * Sight is free software: you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Sight 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with Sight. If not, see <https://www.gnu.org/licenses/>.
 *
 ***********************************************************************/

#pragma once

#include "data/exception.hpp"

#include <core/com/signal.hpp>
#include <core/com/signal.hxx>

namespace sight::data
{

/// Special templated wrapper to std::inserter, std::back_inserter, iterator that can be used in std::copy()
template<class C>
constexpr static auto inserter(C& _container)
{
    if constexpr(core::is_container_associative<C>::value)
    {
        return std::inserter(_container, _container.begin());
    }
    else if constexpr(core::is_container_back_inserter<C>::value)
    {
        return std::back_inserter(_container);
    }
    else if constexpr(core::is_container<C>::value)
    {
        // std::array case
        return _container.begin();
    }
    else
    {
        static_assert(
            core::is_container<C>::value,
            "sight::data::inserter(): Unsupported container type"
        );

        return _container;
    }
}

template<class C>
constexpr container<C>::container() :
    object(),
    container_wrapper<C>()
{
    new_signal<added_signal_t>(ADDED_OBJECTS_SIG);
    new_signal<changed_signal_t>(CHANGED_OBJECTS_SIG);
    new_signal<removed_signal_t>(REMOVED_OBJECTS_SIG);
}

template<class C>
inline container<C>::container(const C& _container) :
    container<C>::container()
{
    this->container_wrapper<C>::operator=(_container);
}

template<class C>
inline container<C>::container(C&& _container) :
    container<C>::container()
{
    this->container_wrapper<C>::operator=(_container);
}

//------------------------------------------------------------------------------

template<class C>
constexpr bool container<C>::operator==(const container& _other) const noexcept
{
    if(!core::is_equal(*this, _other))
    {
        return false;
    }

    // Super class last
    return base_class_t::operator==(_other);
}

//------------------------------------------------------------------------------

template<class C>
constexpr bool container<C>::operator!=(const container& _other) const noexcept
{
    return !(*this == _other);
}

//------------------------------------------------------------------------------

template<class C>
inline void container<C>::shallow_copy(const object::csptr& _source)
{
    const auto& other = std::dynamic_pointer_cast<const container<C> >(_source);

    SIGHT_THROW_EXCEPTION_IF(
        exception(
            "Unable to copy " + (_source ? _source->get_classname() : std::string("<NULL>")) + " to " + get_classname()
        ),
        !other
    );

    if constexpr(core::is_container_dynamic<C>::value)
    {
        this->container<C>::clear();

        if constexpr(core::is_vector<C>::value || core::is_container_unordered_associative<C>::value)
        {
            this->container<C>::reserve(other->size());
        }
    }

    if constexpr(core::is_container<C>::value)
    {
        std::copy(other->cbegin(), other->cend(), inserter(*this));
    }

    base_class_t::shallow_copy(other);
}

//------------------------------------------------------------------------------

template<class C>
constexpr bool is_data_object_fn()
{
    if constexpr(core::is_map_like<C>::value)
    {
        if constexpr(core::is_shared_ptr<typename C::mapped_type>::value)
        {
            // "using" is required for MSVC
            using shared_ptr_type = typename C::mapped_type;
            return std::is_base_of<object, typename shared_ptr_type::element_type>::value;
        }
    }
    else
    {
        if constexpr(core::is_shared_ptr<typename C::value_type>::value)
        {
            // "using" is required for MSVC
            using shared_ptr_type = typename C::value_type;
            return std::is_base_of<object, typename shared_ptr_type::element_type>::value;
        }
    }

    return false;
}

//------------------------------------------------------------------------------

template<class C>
inline void container<C>::deep_copy(const object::csptr& _source, const std::unique_ptr<deep_copy_cache_t>& _cache)
{
    const auto& other = std::dynamic_pointer_cast<const container<C> >(_source);

    SIGHT_THROW_EXCEPTION_IF(
        exception(
            "Unable to copy " + (_source ? _source->get_classname() : std::string("<NULL>")) + " to " + get_classname()
        ),
        !other
    );

    // If the container is dynamic, we need to clear it before copying
    if constexpr(core::is_container_dynamic<C>::value)
    {
        // Clear the container
        this->container<C>::clear();

        // Reserve room in the container, if reserve() is available
        if constexpr(core::is_vector<C>::value || core::is_container_unordered_associative<C>::value)
        {
            this->container<C>::reserve(other->size());
        }
    }

    // True if the container contains shared_ptr<object>
    constexpr bool is_data_object = is_data_object_fn<C>();

    // Special case for map
    if constexpr(core::is_map_like<C>::value)
    {
        // Need to be done this way, because std::pair<key, value>::operator= is deleted..
        for(const auto& [key, value] : *other)
        {
            if constexpr(is_data_object)
            {
                this->container<C>::insert({key, object::copy(value, _cache)});
            }
            else
            {
                this->container<C>::insert({key, value});
            }
        }
    }
    else if constexpr(core::is_container<C>::value)
    {
        if constexpr(is_data_object)
        {
            std::transform(
                other->cbegin(),
                other->cend(),
                inserter(*this),
                [&](const auto& _value)
                {
                    return object::copy(_value, _cache);
                });
        }
        else
        {
            std::copy(other->cbegin(), other->cend(), inserter(*this));
        }
    }

    base_class_t::deep_copy(other, _cache);
}

//------------------------------------------------------------------------------

template<class C>
constexpr C container<C>::get_content() const noexcept
{
    C c;
    std::copy(this->container<C>::cbegin(), this->container<C>::cend(), inserter(c));
    return c;
}

//------------------------------------------------------------------------------

template<class C>
[[nodiscard]] constexpr auto container<C>::scoped_emit() const noexcept
{
    return std::make_unique<container<C>::scoped_emitter>(*this);
}

//------------------------------------------------------------------------------

template<class C>
constexpr container<C>::scoped_emitter::scoped_emitter(const container<C>& _container) noexcept :
    m_container(_container),
    m_backup(_container.get_content())
{
}

//------------------------------------------------------------------------------

template<class C>
inline container<C>::scoped_emitter::~scoped_emitter() noexcept
{
    emit();
}

//------------------------------------------------------------------------------

template<class C>
constexpr void container<C>::scoped_emitter::block(const core::com::slot_base::sptr& _slot) noexcept
{
    m_blocked_slots.push_back(_slot);
}

//------------------------------------------------------------------------------

template<class C>
void container<C>::scoped_emitter::emit() noexcept
{
    container<C>::container_t added;
    container<C>::container_t before;
    container<C>::container_t after;

    // Build the added and the changed lists
    for(const auto& element : m_container)
    {
        if constexpr(core::is_map_like<C>::value)
        {
            // If we cannot find the key in the backup, it means it was added
            if(const auto& it = m_backup.find(element.first); it == m_backup.cend())
            {
                added.insert(element);
            }
            // If we can find the key, but the element is not the same, it means it was changed
            else if(element.second != it->second)
            {
                before.insert(*it);
                after.insert(element);
            }
        }
        else
        {
            // If we cannot find the element in the backup, it means it was added
            if(std::find(m_backup.cbegin(), m_backup.cend(), element) == m_backup.cend())
            {
                added.insert(added.cend(), element);
            }
        }
    }

    container<C>::container_t removed;

    // Build the removed lists
    for(const auto& element : m_backup)
    {
        if constexpr(core::is_map_like<C>::value)
        {
            // If we cannot find the key in the container, it means it was removed
            if(m_container.find(element.first) == m_container.cend())
            {
                removed.insert(element);
            }
        }
        else
        {
            // If we cannot find the element in the container, it means it was removed
            if(std::find(m_container.cbegin(), m_container.cend(), element) == m_container.cend())
            {
                removed.insert(removed.cend(), element);
            }
        }
    }

    // Send the notifications
    if(!added.empty())
    {
        auto signal = m_container.template signal<container<C>::added_signal_t>(container<C>::ADDED_OBJECTS_SIG);
        std::vector<core::com::connection::blocker> blockers;
        for(auto& slot : m_blocked_slots)
        {
            blockers.emplace_back(core::com::connection::blocker(signal->get_connection(slot)));
        }

        signal->async_emit(added);
    }

    if(!before.empty() || !after.empty())
    {
        auto signal =
            m_container.template signal<container<C>::changed_signal_t>(container<C>::CHANGED_OBJECTS_SIG);

        std::vector<core::com::connection::blocker> blockers;
        for(auto& slot : m_blocked_slots)
        {
            blockers.emplace_back(core::com::connection::blocker(signal->get_connection(slot)));
        }

        signal->async_emit(before, after);
    }

    if(!removed.empty())
    {
        auto signal =
            m_container.template signal<container<C>::removed_signal_t>(container<C>::REMOVED_OBJECTS_SIG);

        std::vector<core::com::connection::blocker> blockers;
        for(auto& slot : m_blocked_slots)
        {
            blockers.emplace_back(core::com::connection::blocker(signal->get_connection(slot)));
        }

        signal->async_emit(removed);
    }

    reset();
}

//------------------------------------------------------------------------------

template<class C>
constexpr void container<C>::scoped_emitter::reset() noexcept
{
    m_backup = m_container.get_content();
}

} // namespace sight::data