2023-08-15 16:20:26 +02:00
|
|
|
/* SPDX-FileCopyrightText: 2023 Blender Authors
|
2023-05-31 16:19:06 +02:00
|
|
|
*
|
|
|
|
* SPDX-License-Identifier: GPL-2.0-or-later */
|
2020-12-02 13:25:25 +01:00
|
|
|
|
|
|
|
#pragma once
|
|
|
|
|
2022-03-19 08:26:29 +01:00
|
|
|
#include "BLI_generic_pointer.hh"
|
2020-12-02 13:25:25 +01:00
|
|
|
#include "BLI_linear_allocator.hh"
|
|
|
|
#include "BLI_map.hh"
|
|
|
|
|
2022-03-19 08:26:29 +01:00
|
|
|
namespace blender {
|
2020-12-02 13:25:25 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* This is a map that stores key-value-pairs. What makes it special is that the type of values does
|
|
|
|
* not have to be known at compile time. There just has to be a corresponding CPPType.
|
|
|
|
*/
|
|
|
|
template<typename Key> class GValueMap {
|
|
|
|
private:
|
|
|
|
/* Used to allocate values owned by this container. */
|
|
|
|
LinearAllocator<> &allocator_;
|
|
|
|
Map<Key, GMutablePointer> values_;
|
|
|
|
|
|
|
|
public:
|
2023-03-29 16:50:54 +02:00
|
|
|
GValueMap(LinearAllocator<> &allocator) : allocator_(allocator) {}
|
2020-12-02 13:25:25 +01:00
|
|
|
|
|
|
|
~GValueMap()
|
|
|
|
{
|
|
|
|
/* Destruct all values that are still in the map. */
|
|
|
|
for (GMutablePointer value : values_.values()) {
|
|
|
|
value.destruct();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Add a value to the container. The container becomes responsible for destructing the value that
|
|
|
|
* is passed in. The caller remains responsible for freeing the value after it has been
|
|
|
|
* destructed. */
|
|
|
|
template<typename ForwardKey> void add_new_direct(ForwardKey &&key, GMutablePointer value)
|
|
|
|
{
|
|
|
|
values_.add_new_as(std::forward<ForwardKey>(key), value);
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Add a value to the container that is move constructed from the given value. The caller remains
|
|
|
|
* responsible for destructing and freeing the given value. */
|
|
|
|
template<typename ForwardKey> void add_new_by_move(ForwardKey &&key, GMutablePointer value)
|
|
|
|
{
|
|
|
|
const CPPType &type = *value.type();
|
|
|
|
void *buffer = allocator_.allocate(type.size(), type.alignment());
|
2021-06-28 13:13:52 +02:00
|
|
|
type.move_construct(value.get(), buffer);
|
2020-12-02 13:25:25 +01:00
|
|
|
values_.add_new_as(std::forward<ForwardKey>(key), GMutablePointer{type, buffer});
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Add a value to the container that is copy constructed from the given value. The caller remains
|
|
|
|
* responsible for destructing and freeing the given value. */
|
2020-12-18 13:26:08 +01:00
|
|
|
template<typename ForwardKey> void add_new_by_copy(ForwardKey &&key, GPointer value)
|
2020-12-02 13:25:25 +01:00
|
|
|
{
|
|
|
|
const CPPType &type = *value.type();
|
|
|
|
void *buffer = allocator_.allocate(type.size(), type.alignment());
|
2021-06-28 13:13:52 +02:00
|
|
|
type.copy_construct(value.get(), buffer);
|
2020-12-02 13:25:25 +01:00
|
|
|
values_.add_new_as(std::forward<ForwardKey>(key), GMutablePointer{type, buffer});
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Add a value to the container. */
|
|
|
|
template<typename ForwardKey, typename T> void add_new(ForwardKey &&key, T &&value)
|
|
|
|
{
|
|
|
|
if constexpr (std::is_rvalue_reference_v<T>) {
|
|
|
|
this->add_new_by_move(std::forward<ForwardKey>(key), &value);
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
this->add_new_by_copy(std::forward<ForwardKey>(key), &value);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/* Remove the value for the given name from the container and remove it. The caller is
|
|
|
|
* responsible for freeing it. The lifetime of the referenced memory might be bound to lifetime
|
|
|
|
* of the container. */
|
|
|
|
template<typename ForwardKey> GMutablePointer extract(const ForwardKey &key)
|
|
|
|
{
|
|
|
|
return values_.pop_as(key);
|
|
|
|
}
|
|
|
|
|
2021-04-27 13:03:40 +02:00
|
|
|
template<typename ForwardKey> GPointer lookup(const ForwardKey &key) const
|
|
|
|
{
|
|
|
|
return values_.lookup_as(key);
|
|
|
|
}
|
|
|
|
|
2020-12-02 13:25:25 +01:00
|
|
|
/* Remove the value for the given name from the container and remove it. */
|
|
|
|
template<typename T, typename ForwardKey> T extract(const ForwardKey &key)
|
|
|
|
{
|
|
|
|
GMutablePointer value = values_.pop_as(key);
|
|
|
|
const CPPType &type = *value.type();
|
|
|
|
BLI_assert(type.is<T>());
|
|
|
|
T return_value;
|
2021-06-28 13:13:52 +02:00
|
|
|
type.relocate_assign(value.get(), &return_value);
|
2020-12-02 13:25:25 +01:00
|
|
|
return return_value;
|
|
|
|
}
|
|
|
|
|
2021-02-18 12:40:27 +01:00
|
|
|
template<typename T, typename ForwardKey> const T &lookup(const ForwardKey &key) const
|
2020-12-02 13:25:25 +01:00
|
|
|
{
|
|
|
|
GMutablePointer value = values_.lookup_as(key);
|
2021-02-18 12:40:27 +01:00
|
|
|
BLI_assert(value.is_type<T>());
|
|
|
|
BLI_assert(value.get() != nullptr);
|
|
|
|
return *(const T *)value.get();
|
2020-12-02 13:25:25 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
template<typename ForwardKey> bool contains(const ForwardKey &key) const
|
|
|
|
{
|
|
|
|
return values_.contains_as(key);
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
2022-03-19 08:26:29 +01:00
|
|
|
} // namespace blender
|