Jacques Lucke
42b88c0088
The use of `std::variant` allows combining the four vectors into one which more closely matches the intend and avoids a workaround used before. Note that this uses `std::get_if` instead of `std::get` because `std::get` is only available since macOS 10.14.
350 lines
13 KiB
C++
350 lines
13 KiB
C++
/* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
|
|
#pragma once
|
|
|
|
/** \file
|
|
* \ingroup fn
|
|
*
|
|
* This file provides an MFParams and MFParamsBuilder structure.
|
|
*
|
|
* `MFParamsBuilder` is used by a function caller to be prepare all parameters that are passed into
|
|
* the function. `MFParams` is then used inside the called function to access the parameters.
|
|
*/
|
|
|
|
#include <mutex>
|
|
#include <variant>
|
|
|
|
#include "BLI_generic_pointer.hh"
|
|
#include "BLI_generic_vector_array.hh"
|
|
#include "BLI_generic_virtual_vector_array.hh"
|
|
#include "BLI_resource_scope.hh"
|
|
|
|
#include "FN_multi_function_signature.hh"
|
|
|
|
namespace blender::fn {
|
|
|
|
class MFParamsBuilder {
|
|
private:
|
|
ResourceScope scope_;
|
|
const MFSignature *signature_;
|
|
IndexMask mask_;
|
|
int64_t min_array_size_;
|
|
Vector<std::variant<GVArray, GMutableSpan, const GVVectorArray *, GVectorArray *>>
|
|
actual_params_;
|
|
|
|
std::mutex mutex_;
|
|
Vector<std::pair<int, GMutableSpan>> dummy_output_spans_;
|
|
|
|
friend class MFParams;
|
|
|
|
MFParamsBuilder(const MFSignature &signature, const IndexMask mask)
|
|
: signature_(&signature), mask_(mask), min_array_size_(mask.min_array_size())
|
|
{
|
|
actual_params_.reserve(signature.param_types.size());
|
|
}
|
|
|
|
public:
|
|
MFParamsBuilder(const class MultiFunction &fn, int64_t size);
|
|
/**
|
|
* The indices referenced by the #mask has to live longer than the params builder. This is
|
|
* because the it might have to destruct elements for all masked indices in the end.
|
|
*/
|
|
MFParamsBuilder(const class MultiFunction &fn, const IndexMask *mask);
|
|
|
|
template<typename T> void add_readonly_single_input_value(T value, StringRef expected_name = "")
|
|
{
|
|
this->assert_current_param_type(MFParamType::ForSingleInput(CPPType::get<T>()), expected_name);
|
|
actual_params_.append_unchecked_as(std::in_place_type<GVArray>,
|
|
varray_tag::single{},
|
|
CPPType::get<T>(),
|
|
min_array_size_,
|
|
&value);
|
|
}
|
|
template<typename T> void add_readonly_single_input(const T *value, StringRef expected_name = "")
|
|
{
|
|
this->assert_current_param_type(MFParamType::ForSingleInput(CPPType::get<T>()), expected_name);
|
|
actual_params_.append_unchecked_as(std::in_place_type<GVArray>,
|
|
varray_tag::single_ref{},
|
|
CPPType::get<T>(),
|
|
min_array_size_,
|
|
value);
|
|
}
|
|
void add_readonly_single_input(const GSpan span, StringRef expected_name = "")
|
|
{
|
|
this->assert_current_param_type(MFParamType::ForSingleInput(span.type()), expected_name);
|
|
BLI_assert(span.size() >= min_array_size_);
|
|
actual_params_.append_unchecked_as(std::in_place_type<GVArray>, varray_tag::span{}, span);
|
|
}
|
|
void add_readonly_single_input(GPointer value, StringRef expected_name = "")
|
|
{
|
|
this->assert_current_param_type(MFParamType::ForSingleInput(*value.type()), expected_name);
|
|
actual_params_.append_unchecked_as(std::in_place_type<GVArray>,
|
|
varray_tag::single_ref{},
|
|
*value.type(),
|
|
min_array_size_,
|
|
value.get());
|
|
}
|
|
void add_readonly_single_input(GVArray varray, StringRef expected_name = "")
|
|
{
|
|
this->assert_current_param_type(MFParamType::ForSingleInput(varray.type()), expected_name);
|
|
BLI_assert(varray.size() >= min_array_size_);
|
|
actual_params_.append_unchecked_as(std::in_place_type<GVArray>, std::move(varray));
|
|
}
|
|
|
|
void add_readonly_vector_input(const GVectorArray &vector_array, StringRef expected_name = "")
|
|
{
|
|
this->add_readonly_vector_input(scope_.construct<GVVectorArray_For_GVectorArray>(vector_array),
|
|
expected_name);
|
|
}
|
|
void add_readonly_vector_input(const GSpan single_vector, StringRef expected_name = "")
|
|
{
|
|
this->add_readonly_vector_input(
|
|
scope_.construct<GVVectorArray_For_SingleGSpan>(single_vector, min_array_size_),
|
|
expected_name);
|
|
}
|
|
void add_readonly_vector_input(const GVVectorArray &ref, StringRef expected_name = "")
|
|
{
|
|
this->assert_current_param_type(MFParamType::ForVectorInput(ref.type()), expected_name);
|
|
BLI_assert(ref.size() >= min_array_size_);
|
|
actual_params_.append_unchecked_as(std::in_place_type<const GVVectorArray *>, &ref);
|
|
}
|
|
|
|
template<typename T> void add_uninitialized_single_output(T *value, StringRef expected_name = "")
|
|
{
|
|
this->add_uninitialized_single_output(GMutableSpan(CPPType::get<T>(), value, 1),
|
|
expected_name);
|
|
}
|
|
void add_uninitialized_single_output(GMutableSpan ref, StringRef expected_name = "")
|
|
{
|
|
this->assert_current_param_type(MFParamType::ForSingleOutput(ref.type()), expected_name);
|
|
BLI_assert(ref.size() >= min_array_size_);
|
|
actual_params_.append_unchecked_as(std::in_place_type<GMutableSpan>, ref);
|
|
}
|
|
void add_ignored_single_output(StringRef expected_name = "")
|
|
{
|
|
this->assert_current_param_name(expected_name);
|
|
const int param_index = this->current_param_index();
|
|
const MFParamType ¶m_type = signature_->param_types[param_index];
|
|
BLI_assert(param_type.category() == MFParamCategory::SingleOutput);
|
|
const CPPType &type = param_type.data_type().single_type();
|
|
/* An empty span indicates that this is ignored. */
|
|
const GMutableSpan dummy_span{type};
|
|
actual_params_.append_unchecked_as(std::in_place_type<GMutableSpan>, dummy_span);
|
|
}
|
|
|
|
void add_vector_output(GVectorArray &vector_array, StringRef expected_name = "")
|
|
{
|
|
this->assert_current_param_type(MFParamType::ForVectorOutput(vector_array.type()),
|
|
expected_name);
|
|
BLI_assert(vector_array.size() >= min_array_size_);
|
|
actual_params_.append_unchecked_as(std::in_place_type<GVectorArray *>, &vector_array);
|
|
}
|
|
|
|
void add_single_mutable(GMutableSpan ref, StringRef expected_name = "")
|
|
{
|
|
this->assert_current_param_type(MFParamType::ForMutableSingle(ref.type()), expected_name);
|
|
BLI_assert(ref.size() >= min_array_size_);
|
|
actual_params_.append_unchecked_as(std::in_place_type<GMutableSpan>, ref);
|
|
}
|
|
|
|
void add_vector_mutable(GVectorArray &vector_array, StringRef expected_name = "")
|
|
{
|
|
this->assert_current_param_type(MFParamType::ForMutableVector(vector_array.type()),
|
|
expected_name);
|
|
BLI_assert(vector_array.size() >= min_array_size_);
|
|
actual_params_.append_unchecked_as(std::in_place_type<GVectorArray *>, &vector_array);
|
|
}
|
|
|
|
GMutableSpan computed_array(int param_index)
|
|
{
|
|
BLI_assert(ELEM(signature_->param_types[param_index].category(),
|
|
MFParamCategory::SingleOutput,
|
|
MFParamCategory::SingleMutable));
|
|
return *std::get_if<GMutableSpan>(&actual_params_[param_index]);
|
|
}
|
|
|
|
GVectorArray &computed_vector_array(int param_index)
|
|
{
|
|
BLI_assert(ELEM(signature_->param_types[param_index].category(),
|
|
MFParamCategory::VectorOutput,
|
|
MFParamCategory::VectorMutable));
|
|
return **std::get_if<GVectorArray *>(&actual_params_[param_index]);
|
|
}
|
|
|
|
ResourceScope &resource_scope()
|
|
{
|
|
return scope_;
|
|
}
|
|
|
|
private:
|
|
void assert_current_param_type(MFParamType param_type, StringRef expected_name = "")
|
|
{
|
|
UNUSED_VARS_NDEBUG(param_type, expected_name);
|
|
#ifdef DEBUG
|
|
int param_index = this->current_param_index();
|
|
|
|
if (expected_name != "") {
|
|
StringRef actual_name = signature_->param_names[param_index];
|
|
BLI_assert(actual_name == expected_name);
|
|
}
|
|
|
|
MFParamType expected_type = signature_->param_types[param_index];
|
|
BLI_assert(expected_type == param_type);
|
|
#endif
|
|
}
|
|
|
|
void assert_current_param_name(StringRef expected_name)
|
|
{
|
|
UNUSED_VARS_NDEBUG(expected_name);
|
|
#ifdef DEBUG
|
|
if (expected_name.is_empty()) {
|
|
return;
|
|
}
|
|
const int param_index = this->current_param_index();
|
|
StringRef actual_name = signature_->param_names[param_index];
|
|
BLI_assert(actual_name == expected_name);
|
|
#endif
|
|
}
|
|
|
|
int current_param_index() const
|
|
{
|
|
return actual_params_.size();
|
|
}
|
|
};
|
|
|
|
class MFParams {
|
|
private:
|
|
MFParamsBuilder *builder_;
|
|
|
|
public:
|
|
MFParams(MFParamsBuilder &builder) : builder_(&builder)
|
|
{
|
|
}
|
|
|
|
template<typename T> VArray<T> readonly_single_input(int param_index, StringRef name = "")
|
|
{
|
|
const GVArray &varray = this->readonly_single_input(param_index, name);
|
|
return varray.typed<T>();
|
|
}
|
|
const GVArray &readonly_single_input(int param_index, StringRef name = "")
|
|
{
|
|
this->assert_correct_param(param_index, name, MFParamCategory::SingleInput);
|
|
return *std::get_if<GVArray>(&builder_->actual_params_[param_index]);
|
|
}
|
|
|
|
/**
|
|
* \return True when the caller provided a buffer for this output parameter. This allows the
|
|
* called multi-function to skip some computation. It is still valid to call
|
|
* #uninitialized_single_output when this returns false. In this case a new temporary buffer is
|
|
* allocated.
|
|
*/
|
|
bool single_output_is_required(int param_index, StringRef name = "")
|
|
{
|
|
this->assert_correct_param(param_index, name, MFParamCategory::SingleOutput);
|
|
return !std::get_if<GMutableSpan>(&builder_->actual_params_[param_index])->is_empty();
|
|
}
|
|
|
|
template<typename T>
|
|
MutableSpan<T> uninitialized_single_output(int param_index, StringRef name = "")
|
|
{
|
|
return this->uninitialized_single_output(param_index, name).typed<T>();
|
|
}
|
|
GMutableSpan uninitialized_single_output(int param_index, StringRef name = "")
|
|
{
|
|
this->assert_correct_param(param_index, name, MFParamCategory::SingleOutput);
|
|
GMutableSpan span = *std::get_if<GMutableSpan>(&builder_->actual_params_[param_index]);
|
|
if (!span.is_empty()) {
|
|
return span;
|
|
}
|
|
/* The output is ignored by the caller, but the multi-function does not handle this case. So
|
|
* create a temporary buffer that the multi-function can write to. */
|
|
return this->ensure_dummy_single_output(param_index);
|
|
}
|
|
|
|
/**
|
|
* Same as #uninitialized_single_output, but returns an empty span when the output is not
|
|
* required.
|
|
*/
|
|
template<typename T>
|
|
MutableSpan<T> uninitialized_single_output_if_required(int param_index, StringRef name = "")
|
|
{
|
|
return this->uninitialized_single_output_if_required(param_index, name).typed<T>();
|
|
}
|
|
GMutableSpan uninitialized_single_output_if_required(int param_index, StringRef name = "")
|
|
{
|
|
this->assert_correct_param(param_index, name, MFParamCategory::SingleOutput);
|
|
return *std::get_if<GMutableSpan>(&builder_->actual_params_[param_index]);
|
|
}
|
|
|
|
template<typename T>
|
|
const VVectorArray<T> &readonly_vector_input(int param_index, StringRef name = "")
|
|
{
|
|
const GVVectorArray &vector_array = this->readonly_vector_input(param_index, name);
|
|
return builder_->scope_.construct<VVectorArray_For_GVVectorArray<T>>(vector_array);
|
|
}
|
|
const GVVectorArray &readonly_vector_input(int param_index, StringRef name = "")
|
|
{
|
|
this->assert_correct_param(param_index, name, MFParamCategory::VectorInput);
|
|
return **std::get_if<const GVVectorArray *>(&builder_->actual_params_[param_index]);
|
|
}
|
|
|
|
template<typename T>
|
|
GVectorArray_TypedMutableRef<T> vector_output(int param_index, StringRef name = "")
|
|
{
|
|
return {this->vector_output(param_index, name)};
|
|
}
|
|
GVectorArray &vector_output(int param_index, StringRef name = "")
|
|
{
|
|
this->assert_correct_param(param_index, name, MFParamCategory::VectorOutput);
|
|
return **std::get_if<GVectorArray *>(&builder_->actual_params_[param_index]);
|
|
}
|
|
|
|
template<typename T> MutableSpan<T> single_mutable(int param_index, StringRef name = "")
|
|
{
|
|
return this->single_mutable(param_index, name).typed<T>();
|
|
}
|
|
GMutableSpan single_mutable(int param_index, StringRef name = "")
|
|
{
|
|
this->assert_correct_param(param_index, name, MFParamCategory::SingleMutable);
|
|
return *std::get_if<GMutableSpan>(&builder_->actual_params_[param_index]);
|
|
}
|
|
|
|
template<typename T>
|
|
GVectorArray_TypedMutableRef<T> vector_mutable(int param_index, StringRef name = "")
|
|
{
|
|
return {this->vector_mutable(param_index, name)};
|
|
}
|
|
GVectorArray &vector_mutable(int param_index, StringRef name = "")
|
|
{
|
|
this->assert_correct_param(param_index, name, MFParamCategory::VectorMutable);
|
|
return **std::get_if<GVectorArray *>(&builder_->actual_params_[param_index]);
|
|
}
|
|
|
|
private:
|
|
void assert_correct_param(int param_index, StringRef name, MFParamType param_type)
|
|
{
|
|
UNUSED_VARS_NDEBUG(param_index, name, param_type);
|
|
#ifdef DEBUG
|
|
BLI_assert(builder_->signature_->param_types[param_index] == param_type);
|
|
if (name.size() > 0) {
|
|
BLI_assert(builder_->signature_->param_names[param_index] == name);
|
|
}
|
|
#endif
|
|
}
|
|
|
|
void assert_correct_param(int param_index, StringRef name, MFParamCategory category)
|
|
{
|
|
UNUSED_VARS_NDEBUG(param_index, name, category);
|
|
#ifdef DEBUG
|
|
BLI_assert(builder_->signature_->param_types[param_index].category() == category);
|
|
if (name.size() > 0) {
|
|
BLI_assert(builder_->signature_->param_names[param_index] == name);
|
|
}
|
|
#endif
|
|
}
|
|
|
|
GMutableSpan ensure_dummy_single_output(int param_index);
|
|
};
|
|
|
|
} // namespace blender::fn
|