From c94a1f53499106c095156a23279e9b2083477eec Mon Sep 17 00:00:00 2001 From: Jacques Lucke Date: Mon, 22 Jun 2020 15:50:08 +0200 Subject: Functions: add utilities that allow creating some multi-functions with less typing --- source/blender/functions/CMakeLists.txt | 1 + .../blender/functions/FN_multi_function_builder.hh | 157 +++++++++++++++++++++ 2 files changed, 158 insertions(+) create mode 100644 source/blender/functions/FN_multi_function_builder.hh (limited to 'source/blender') diff --git a/source/blender/functions/CMakeLists.txt b/source/blender/functions/CMakeLists.txt index dce7eb71376..0a080246d84 100644 --- a/source/blender/functions/CMakeLists.txt +++ b/source/blender/functions/CMakeLists.txt @@ -33,6 +33,7 @@ set(SRC FN_cpp_type.hh FN_cpp_types.hh FN_multi_function.hh + FN_multi_function_builder.hh FN_multi_function_context.hh FN_multi_function_data_type.hh FN_multi_function_param_type.hh diff --git a/source/blender/functions/FN_multi_function_builder.hh b/source/blender/functions/FN_multi_function_builder.hh new file mode 100644 index 00000000000..08d4ec672cd --- /dev/null +++ b/source/blender/functions/FN_multi_function_builder.hh @@ -0,0 +1,157 @@ +/* + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. + * + * This program 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 General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + */ + +#ifndef __FN_MULTI_FUNCTION_BUILDER_HH__ +#define __FN_MULTI_FUNCTION_BUILDER_HH__ + +/** \file + * \ingroup fn + * + * This file contains several utilities to create multi-functions with less redundant code. + */ + +#include + +#include "FN_multi_function.hh" + +namespace blender { +namespace fn { + +/** + * Generates a multi-function with the following parameters: + * 1. single input (SI) of type In1 + * 2. single output (SO) of type Out1 + * + * This example creates a function that adds 10 to the incoming values: + * CustomFunction_SI_SO fn("add 10", [](int value) { return value + 10; }); + */ +template class CustomFunction_SI_SO : public MultiFunction { + private: + using FunctionT = std::function, MutableSpan)>; + FunctionT m_function; + + public: + CustomFunction_SI_SO(StringRef name, FunctionT function) : m_function(std::move(function)) + { + MFSignatureBuilder signature = this->get_builder(name); + signature.single_input("In1"); + signature.single_output("Out1"); + } + + template + CustomFunction_SI_SO(StringRef name, ElementFuncT element_fn) + : CustomFunction_SI_SO(name, CustomFunction_SI_SO::create_function(element_fn)) + { + } + + template static FunctionT create_function(ElementFuncT element_fn) + { + return [=](IndexMask mask, VSpan in1, MutableSpan out1) { + mask.foreach_index([&](uint i) { new ((void *)&out1[i]) Out1(element_fn(in1[i])); }); + }; + } + + void call(IndexMask mask, MFParams params, MFContext UNUSED(context)) const override + { + VSpan in1 = params.readonly_single_input(0); + MutableSpan out1 = params.uninitialized_single_output(1); + m_function(mask, in1, out1); + } +}; + +/** + * Generates a multi-function with the following parameters: + * 1. single input (SI) of type In1 + * 2. single input (SI) of type In2 + * 3. single output (SO) of type Out1 + */ +template +class CustomFunction_SI_SI_SO : public MultiFunction { + private: + using FunctionT = std::function, VSpan, MutableSpan)>; + FunctionT m_function; + + public: + CustomFunction_SI_SI_SO(StringRef name, FunctionT function) : m_function(std::move(function)) + { + MFSignatureBuilder signature = this->get_builder(name); + signature.single_input("In1"); + signature.single_input("In2"); + signature.single_output("Out1"); + } + + template + CustomFunction_SI_SI_SO(StringRef name, ElementFuncT element_fn) + : CustomFunction_SI_SI_SO(name, CustomFunction_SI_SI_SO::create_function(element_fn)) + { + } + + template static FunctionT create_function(ElementFuncT element_fn) + { + return [=](IndexMask mask, VSpan in1, VSpan in2, MutableSpan out1) { + mask.foreach_index([&](uint i) { new ((void *)&out1[i]) Out1(element_fn(in1[i], in2[i])); }); + }; + } + + void call(IndexMask mask, MFParams params, MFContext UNUSED(context)) const override + { + VSpan in1 = params.readonly_single_input(0); + VSpan in2 = params.readonly_single_input(1); + MutableSpan out1 = params.uninitialized_single_output(2); + m_function(mask, in1, in2, out1); + } +}; + +/** + * Generates a multi-function with the following parameters: + * 1. single mutable (SM) of type Mut1 + */ +template class CustomFunction_SM : public MultiFunction { + private: + using FunctionT = std::function)>; + FunctionT m_function; + + public: + CustomFunction_SM(StringRef name, FunctionT function) : m_function(std::move(function)) + { + MFSignatureBuilder signature = this->get_builder(name); + signature.single_mutable("Mut1"); + } + + template + CustomFunction_SM(StringRef name, ElementFuncT element_fn) + : CustomFunction_SM(name, CustomFunction_SM::create_function(element_fn)) + { + } + + template static FunctionT create_function(ElementFuncT element_fn) + { + return [=](IndexMask mask, MutableSpan mut1) { + mask.foreach_index([&](uint i) { element_fn(mut1[i]); }); + }; + } + + void call(IndexMask mask, MFParams params, MFContext UNUSED(context)) const override + { + MutableSpan mut1 = params.single_mutable(0); + m_function(mask, mut1); + } +}; + +} // namespace fn +} // namespace blender + +#endif /* __FN_MULTI_FUNCTION_BUILDER_HH__ */ -- cgit v1.2.3