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
|
/*
* 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_PARAMS_HH__
#define __FN_MULTI_FUNCTION_PARAMS_HH__
/** \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 "FN_generic_vector_array.hh"
#include "FN_multi_function_signature.hh"
namespace blender::fn {
class MFParamsBuilder {
private:
const MFSignature *signature_;
uint min_array_size_;
Vector<GVSpan> virtual_spans_;
Vector<GMutableSpan> mutable_spans_;
Vector<GVArraySpan> virtual_array_spans_;
Vector<GVectorArray *> vector_arrays_;
friend class MFParams;
public:
MFParamsBuilder(const MFSignature &signature, uint min_array_size)
: signature_(&signature), min_array_size_(min_array_size)
{
}
MFParamsBuilder(const class MultiFunction &fn, uint min_array_size);
template<typename T> void add_readonly_single_input(const T *value)
{
this->add_readonly_single_input(GVSpan::FromSingle(CPPType::get<T>(), value, min_array_size_));
}
void add_readonly_single_input(GVSpan ref)
{
this->assert_current_param_type(MFParamType::ForSingleInput(ref.type()));
BLI_assert(ref.size() >= min_array_size_);
virtual_spans_.append(ref);
}
void add_readonly_vector_input(GVArraySpan ref)
{
this->assert_current_param_type(MFParamType::ForVectorInput(ref.type()));
BLI_assert(ref.size() >= min_array_size_);
virtual_array_spans_.append(ref);
}
void add_uninitialized_single_output(GMutableSpan ref)
{
this->assert_current_param_type(MFParamType::ForSingleOutput(ref.type()));
BLI_assert(ref.size() >= min_array_size_);
mutable_spans_.append(ref);
}
void add_vector_output(GVectorArray &vector_array)
{
this->assert_current_param_type(MFParamType::ForVectorOutput(vector_array.type()));
BLI_assert(vector_array.size() >= min_array_size_);
vector_arrays_.append(&vector_array);
}
void add_single_mutable(GMutableSpan ref)
{
this->assert_current_param_type(MFParamType::ForMutableSingle(ref.type()));
BLI_assert(ref.size() >= min_array_size_);
mutable_spans_.append(ref);
}
void add_vector_mutable(GVectorArray &vector_array)
{
this->assert_current_param_type(MFParamType::ForMutableVector(vector_array.type()));
BLI_assert(vector_array.size() >= min_array_size_);
vector_arrays_.append(&vector_array);
}
GMutableSpan computed_array(uint param_index)
{
BLI_assert(ELEM(signature_->param_types[param_index].category(),
MFParamType::SingleOutput,
MFParamType::SingleMutable));
uint data_index = signature_->data_index(param_index);
return mutable_spans_[data_index];
}
GVectorArray &computed_vector_array(uint param_index)
{
BLI_assert(ELEM(signature_->param_types[param_index].category(),
MFParamType::VectorOutput,
MFParamType::VectorMutable));
uint data_index = signature_->data_index(param_index);
return *vector_arrays_[data_index];
}
private:
void assert_current_param_type(MFParamType param_type)
{
UNUSED_VARS_NDEBUG(param_type);
#ifdef DEBUG
uint param_index = this->current_param_index();
MFParamType expected_type = signature_->param_types[param_index];
BLI_assert(expected_type == param_type);
#endif
}
uint current_param_index() const
{
return virtual_spans_.size() + mutable_spans_.size() + virtual_array_spans_.size() +
vector_arrays_.size();
}
};
class MFParams {
private:
MFParamsBuilder *builder_;
public:
MFParams(MFParamsBuilder &builder) : builder_(&builder)
{
}
template<typename T> VSpan<T> readonly_single_input(uint param_index, StringRef name = "")
{
return this->readonly_single_input(param_index, name).typed<T>();
}
GVSpan readonly_single_input(uint param_index, StringRef name = "")
{
this->assert_correct_param(param_index, name, MFParamType::SingleInput);
uint data_index = builder_->signature_->data_index(param_index);
return builder_->virtual_spans_[data_index];
}
template<typename T>
MutableSpan<T> uninitialized_single_output(uint param_index, StringRef name = "")
{
return this->uninitialized_single_output(param_index, name).typed<T>();
}
GMutableSpan uninitialized_single_output(uint param_index, StringRef name = "")
{
this->assert_correct_param(param_index, name, MFParamType::SingleOutput);
uint data_index = builder_->signature_->data_index(param_index);
return builder_->mutable_spans_[data_index];
}
template<typename T> VArraySpan<T> readonly_vector_input(uint param_index, StringRef name = "")
{
return this->readonly_vector_input(param_index, name).typed<T>();
}
GVArraySpan readonly_vector_input(uint param_index, StringRef name = "")
{
this->assert_correct_param(param_index, name, MFParamType::VectorInput);
uint data_index = builder_->signature_->data_index(param_index);
return builder_->virtual_array_spans_[data_index];
}
template<typename T> GVectorArrayRef<T> vector_output(uint param_index, StringRef name = "")
{
return this->vector_output(param_index, name).typed<T>();
}
GVectorArray &vector_output(uint param_index, StringRef name = "")
{
this->assert_correct_param(param_index, name, MFParamType::VectorOutput);
uint data_index = builder_->signature_->data_index(param_index);
return *builder_->vector_arrays_[data_index];
}
template<typename T> MutableSpan<T> single_mutable(uint param_index, StringRef name = "")
{
return this->single_mutable(param_index, name).typed<T>();
}
GMutableSpan single_mutable(uint param_index, StringRef name = "")
{
this->assert_correct_param(param_index, name, MFParamType::SingleMutable);
uint data_index = builder_->signature_->data_index(param_index);
return builder_->mutable_spans_[data_index];
}
template<typename T> GVectorArrayRef<T> vector_mutable(uint param_index, StringRef name = "")
{
return this->vector_mutable(param_index, name).typed<T>();
}
GVectorArray &vector_mutable(uint param_index, StringRef name = "")
{
this->assert_correct_param(param_index, name, MFParamType::VectorMutable);
uint data_index = builder_->signature_->data_index(param_index);
return *builder_->vector_arrays_[data_index];
}
private:
void assert_correct_param(uint 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(uint param_index, StringRef name, MFParamType::Category 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
}
};
} // namespace blender::fn
#endif /* __FN_MULTI_FUNCTION_PARAMS_HH__ */
|
