Blender V5.3
FN_multi_function_signature.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
5#pragma once
6
13
15
16#include "BLI_enum_flags.hh"
17#include "BLI_vector.hh"
18
20
21enum class ParamFlag {
22 None = 0,
29};
31
49
51 private:
52 Signature &signature_;
53
54 public:
55 SignatureBuilder(const char *function_name, Signature &signature_to_build);
56
57 /* Input Parameter Types */
58
59 template<typename T> void single_input(const char *name);
60 void single_input(const char *name, const CPPType &type);
61 template<typename T> void vector_input(const char *name);
62 void vector_input(const char *name, const CPPType &base_type);
63 void input(const char *name, DataType data_type);
64
65 /* Output Parameter Types */
66
67 template<typename T>
68 void single_output(const char *name, const ParamFlag flag = ParamFlag::None);
69 void single_output(const char *name,
70 const CPPType &type,
71 const ParamFlag flag = ParamFlag::None);
72 template<typename T>
73 void vector_output(const char *name, const ParamFlag flag = ParamFlag::None);
74 void vector_output(const char *name,
75 const CPPType &base_type,
76 const ParamFlag flag = ParamFlag::None);
77 void output(const char *name, DataType data_type, const ParamFlag flag = ParamFlag::None);
78
79 /* Mutable Parameter Types */
80
81 template<typename T> void single_mutable(const char *name);
82 void single_mutable(const char *name, const CPPType &type);
83 template<typename T> void vector_mutable(const char *name);
84 void vector_mutable(const char *name, const CPPType &base_type);
85 void mutable_(const char *name, DataType data_type);
86
87 template<ParamCategory Category, typename T>
88 void add(ParamTag<Category, T> /*tag*/, const char *name);
89 void add(const char *name, const ParamType &param_type);
90};
91
92/* -------------------------------------------------------------------- */
95
96inline SignatureBuilder::SignatureBuilder(const char *function_name, Signature &signature_to_build)
97 : signature_(signature_to_build)
98{
99 signature_.function_name = function_name;
100}
101
102template<typename T> inline void SignatureBuilder::single_input(const char *name)
103{
104 this->single_input(name, CPPType::get<T>());
105}
106
107inline void SignatureBuilder::single_input(const char *name, const CPPType &type)
108{
109 this->input(name, DataType::ForSingle(type));
110}
111
112template<typename T> inline void SignatureBuilder::vector_input(const char *name)
113{
114 this->vector_input(name, CPPType::get<T>());
115}
116
117inline void SignatureBuilder::vector_input(const char *name, const CPPType &base_type)
118{
119 this->input(name, DataType::ForVector(base_type));
120}
121
122inline void SignatureBuilder::input(const char *name, DataType data_type)
123{
124 signature_.params.append({ParamType(ParamType::Input, data_type), name});
125}
126
127template<typename T>
128inline void SignatureBuilder::single_output(const char *name, const ParamFlag flag)
129{
130 this->single_output(name, CPPType::get<T>(), flag);
131}
132
133inline void SignatureBuilder::single_output(const char *name,
134 const CPPType &type,
135 const ParamFlag flag)
136{
137 this->output(name, DataType::ForSingle(type), flag);
138}
139
140template<typename T>
141inline void SignatureBuilder::vector_output(const char *name, const ParamFlag flag)
142{
143 this->vector_output(name, CPPType::get<T>(), flag);
144}
145
146inline void SignatureBuilder::vector_output(const char *name,
147 const CPPType &base_type,
148 const ParamFlag flag)
149{
150 this->output(name, DataType::ForVector(base_type), flag);
151}
152
153inline void SignatureBuilder::output(const char *name, DataType data_type, const ParamFlag flag)
154{
155 signature_.params.append({ParamType(ParamType::Output, data_type), name, flag});
156}
157
158template<typename T> inline void SignatureBuilder::single_mutable(const char *name)
159{
160 this->single_mutable(name, CPPType::get<T>());
161}
162
163inline void SignatureBuilder::single_mutable(const char *name, const CPPType &type)
164{
165 this->mutable_(name, DataType::ForSingle(type));
166}
167
168template<typename T> inline void SignatureBuilder::vector_mutable(const char *name)
169{
170 this->vector_mutable(name, CPPType::get<T>());
171}
172
173inline void SignatureBuilder::vector_mutable(const char *name, const CPPType &base_type)
174{
175 this->mutable_(name, DataType::ForVector(base_type));
176}
177
178inline void SignatureBuilder::mutable_(const char *name, DataType data_type)
179{
180 signature_.params.append({ParamType(ParamType::Mutable, data_type), name});
181}
182
183inline void SignatureBuilder::add(const char *name, const ParamType &param_type)
184{
185 switch (param_type.interface_type()) {
186 case ParamType::Input:
187 this->input(name, param_type.data_type());
188 break;
190 this->mutable_(name, param_type.data_type());
191 break;
193 this->output(name, param_type.data_type());
194 break;
195 }
196}
197
198template<ParamCategory Category, typename T>
199inline void SignatureBuilder::add(ParamTag<Category, T> /*tag*/, const char *name)
200{
201 switch (Category) {
203 this->single_input<T>(name);
204 return;
206 this->vector_input<T>(name);
207 return;
209 this->single_output<T>(name);
210 return;
212 this->vector_output<T>(name);
213 return;
215 this->single_mutable<T>(name);
216 return;
218 this->vector_mutable<T>(name);
219 return;
220 }
222}
223
225
226} // namespace blender::fn::multi_function
#define BLI_assert_unreachable()
static const CPPType & get()
static DataType ForVector(const CPPType &type)
static DataType ForSingle(const CPPType &type)
ParamType(InterfaceType interface_type, DataType data_type)
void input(const char *name, DataType data_type)
void add(ParamTag< Category, T >, const char *name)
SignatureBuilder(const char *function_name, Signature &signature_to_build)
void vector_output(const char *name, const ParamFlag flag=ParamFlag::None)
void mutable_(const char *name, DataType data_type)
void output(const char *name, DataType data_type, const ParamFlag flag=ParamFlag::None)
void single_output(const char *name, const ParamFlag flag=ParamFlag::None)