Repository navigation
Expand file tree
/
Copy pathUEPyUScriptStruct.cpp
More file actions
386 lines (324 loc) · 11 KB
/
Copy pathUEPyUScriptStruct.cpp
File metadata and controls
386 lines (324 loc) · 11 KB
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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
// Copyright 20Tab S.r.l.
#include "UEPyUScriptStruct.h"
static PyObject *py_ue_uscriptstruct_get_field(ue_PyUScriptStruct *self, PyObject * args)
{
char *name;
int index = 0;
if (!PyArg_ParseTuple(args, "s|i:get_field", &name, &index))
{
return nullptr;
}
UProperty *u_property = self->u_struct->FindPropertyByName(FName(UTF8_TO_TCHAR(name)));
if (!u_property)
return PyErr_Format(PyExc_Exception, "unable to find property %s", name);
return ue_py_convert_property(u_property, self->data, index);
}
static PyObject *py_ue_uscriptstruct_get_field_array_dim(ue_PyUScriptStruct *self, PyObject * args)
{
char *name;
if (!PyArg_ParseTuple(args, "s:get_field_array_dim", &name))
{
return nullptr;
}
UProperty *u_property = self->u_struct->FindPropertyByName(FName(UTF8_TO_TCHAR(name)));
if (!u_property)
return PyErr_Format(PyExc_Exception, "unable to find property %s", name);
return PyLong_FromLongLong(u_property->ArrayDim);
}
static PyObject *py_ue_uscriptstruct_set_field(ue_PyUScriptStruct *self, PyObject * args)
{
char *name;
PyObject *value;
int index = 0;
if (!PyArg_ParseTuple(args, "sO|i:set_field", &name, &value, &index))
{
return nullptr;
}
UProperty *u_property = self->u_struct->FindPropertyByName(FName(UTF8_TO_TCHAR(name)));
if (!u_property)
return PyErr_Format(PyExc_Exception, "unable to find property %s", name);
if (!ue_py_convert_pyobject(value, u_property, self->data, index))
{
return PyErr_Format(PyExc_Exception, "unable to set property %s", name);
}
Py_RETURN_NONE;
}
static PyObject *py_ue_uscriptstruct_fields(ue_PyUScriptStruct *self, PyObject * args)
{
PyObject *ret = PyList_New(0);
for (TFieldIterator<UProperty> PropIt(self->u_struct); PropIt; ++PropIt)
{
UProperty* property = *PropIt;
PyObject *property_name = PyUnicode_FromString(TCHAR_TO_UTF8(*property->GetName()));
PyList_Append(ret, property_name);
Py_DECREF(property_name);
}
return ret;
}
static PyObject *py_ue_uscriptstruct_get_struct(ue_PyUScriptStruct *self, PyObject * args)
{
Py_RETURN_UOBJECT(self->u_struct);
}
static PyObject *py_ue_uscriptstruct_clone(ue_PyUScriptStruct *self, PyObject * args)
{
return py_ue_new_uscriptstruct(self->u_struct, self->data);
}
PyObject *py_ue_uscriptstruct_as_dict(ue_PyUScriptStruct * self, PyObject * args)
{
PyObject *py_bool = nullptr;
if (!PyArg_ParseTuple(args, "|O:as_dict", &py_bool))
{
return nullptr;
}
static const FName DisplayNameKey(TEXT("DisplayName"));
PyObject *py_struct_dict = PyDict_New();
TFieldIterator<UProperty> SArgs(self->u_struct);
for (; SArgs; ++SArgs)
{
PyObject *struct_value = ue_py_convert_property(*SArgs, self->data, 0);
if (!struct_value)
{
Py_DECREF(py_struct_dict);
return NULL;
}
FString prop_name = SArgs->GetName();
#if WITH_EDITOR
if (py_bool && PyObject_IsTrue(py_bool))
{
if (SArgs->HasMetaData(DisplayNameKey))
{
FString display_name = SArgs->GetMetaData(DisplayNameKey);
if (display_name.Len() > 0)
prop_name = display_name;
}
}
#endif
PyDict_SetItemString(py_struct_dict, TCHAR_TO_UTF8(*prop_name), struct_value);
}
return py_struct_dict;
}
static PyObject *py_ue_uscriptstruct_ref(ue_PyUScriptStruct *, PyObject *);
static PyMethodDef ue_PyUScriptStruct_methods[] = {
{ "get_field", (PyCFunction)py_ue_uscriptstruct_get_field, METH_VARARGS, "" },
{ "set_field", (PyCFunction)py_ue_uscriptstruct_set_field, METH_VARARGS, "" },
{ "get_field_array_dim", (PyCFunction)py_ue_uscriptstruct_get_field_array_dim, METH_VARARGS, "" },
{ "fields", (PyCFunction)py_ue_uscriptstruct_fields, METH_VARARGS, "" },
{ "get_struct", (PyCFunction)py_ue_uscriptstruct_get_struct, METH_VARARGS, "" },
{ "clone", (PyCFunction)py_ue_uscriptstruct_clone, METH_VARARGS, "" },
{ "as_dict", (PyCFunction)py_ue_uscriptstruct_as_dict, METH_VARARGS, "" },
{ "ref", (PyCFunction)py_ue_uscriptstruct_ref, METH_VARARGS, "" },
{ NULL } /* Sentinel */
};
static PyObject *ue_PyUScriptStruct_str(ue_PyUScriptStruct *self)
{
return PyUnicode_FromFormat("<unreal_engine.UScriptStruct {'struct': '%s', 'size': %d, 'ptr': %p}>",
TCHAR_TO_UTF8(*self->u_struct->GetName()), self->u_struct->GetStructureSize(), self->data);
}
static UProperty *get_field_from_name(UScriptStruct *u_struct, char *name)
{
FString attr = UTF8_TO_TCHAR(name);
UProperty *u_property = u_struct->FindPropertyByName(FName(*attr));
if (u_property)
return u_property;
#if WITH_EDITOR
static const FName DisplayNameKey(TEXT("DisplayName"));
// if the property is not found, attempt to search for DisplayName
for (TFieldIterator<UProperty> prop(u_struct); prop; ++prop)
{
UProperty *property = *prop;
if (property->HasMetaData(DisplayNameKey))
{
FString display_name = property->GetMetaData(DisplayNameKey);
if (display_name.Len() > 0 && attr.Equals(display_name))
{
return property;
}
}
}
#endif
return nullptr;
}
UProperty *ue_struct_get_field_from_name(UScriptStruct *u_struct, char *name)
{
return get_field_from_name(u_struct, name);
}
static PyObject *ue_PyUScriptStruct_getattro(ue_PyUScriptStruct *self, PyObject *attr_name)
{
PyObject *ret = PyObject_GenericGetAttr((PyObject *)self, attr_name);
if (!ret)
{
if (PyUnicodeOrString_Check(attr_name))
{
char *attr = PyUnicode_AsUTF8(attr_name);
// first check for property
UProperty *u_property = get_field_from_name(self->u_struct, attr);
if (u_property)
{
// swallow previous exception
PyErr_Clear();
return ue_py_convert_property(u_property, self->data, 0);
}
}
}
return ret;
}
static int ue_PyUScriptStruct_setattro(ue_PyUScriptStruct *self, PyObject *attr_name, PyObject *value)
{
// first of all check for UProperty
if (PyUnicodeOrString_Check(attr_name))
{
char *attr = PyUnicode_AsUTF8(attr_name);
// first check for property
UProperty *u_property = get_field_from_name(self->u_struct, attr);
if (u_property)
{
if (ue_py_convert_pyobject(value, u_property, self->data, 0))
{
return 0;
}
PyErr_SetString(PyExc_ValueError, "invalid value for UProperty");
return -1;
}
}
return PyObject_GenericSetAttr((PyObject *)self, attr_name, value);
}
// destructor
static void ue_PyUScriptStruct_dealloc(ue_PyUScriptStruct *self)
{
#if defined(UEPY_MEMORY_DEBUG)
UE_LOG(LogPython, Warning, TEXT("Destroying ue_PyUScriptStruct %p with size %d"), self, self->u_struct->GetStructureSize());
#endif
if (!self->is_ptr)
{
FMemory::Free(self->data);
}
Py_TYPE(self)->tp_free((PyObject *)self);
}
static PyTypeObject ue_PyUScriptStructType = {
PyVarObject_HEAD_INIT(NULL, 0)
"unreal_engine.UScriptStruct", /* tp_name */
sizeof(ue_PyUScriptStruct), /* tp_basicsize */
0, /* tp_itemsize */
(destructor)ue_PyUScriptStruct_dealloc, /* tp_dealloc */
0, /* tp_print */
0, /* tp_getattr */
0, /* tp_setattr */
0, /* tp_reserved */
0, /* tp_repr */
0, /* tp_as_number */
0, /* tp_as_sequence */
0, /* tp_as_mapping */
0, /* tp_hash */
0, /* tp_call */
(reprfunc)ue_PyUScriptStruct_str, /* tp_str */
(getattrofunc)ue_PyUScriptStruct_getattro, /* tp_getattro */
(setattrofunc)ue_PyUScriptStruct_setattro, /* tp_setattro */
0, /* tp_as_buffer */
Py_TPFLAGS_DEFAULT, /* tp_flags */
"Unreal Engine Editor UScriptStruct", /* tp_doc */
0, /* tp_traverse */
0, /* tp_clear */
0, /* tp_richcompare */
0, /* tp_weaklistoffset */
0, /* tp_iter */
0, /* tp_iternext */
ue_PyUScriptStruct_methods, /* tp_methods */
0,
0,
};
static int ue_py_uscriptstruct_init(ue_PyUScriptStruct *self, PyObject *args, PyObject *kwargs)
{
PyObject *py_struct;
if (!PyArg_ParseTuple(args, "O", &py_struct))
return -1;
if (!ue_is_pyuobject(py_struct))
{
PyErr_SetString(PyExc_Exception, "argument is not a UScriptStruct");
return -1;
}
ue_PyUObject *py_u_obj = (ue_PyUObject *)py_struct;
if (!py_u_obj->ue_object->IsA<UScriptStruct>())
{
PyErr_SetString(PyExc_Exception, "argument is not a UScriptStruct");
return -1;
}
self->u_struct = (UScriptStruct *)py_u_obj->ue_object;
self->data = (uint8*)FMemory::Malloc(self->u_struct->GetStructureSize());
self->u_struct->InitializeStruct(self->data);
#if WITH_EDITOR
self->u_struct->InitializeDefaultValue(self->data);
#endif
self->original_data = self->data;
self->is_ptr = 0;
return 0;
}
// get the original pointer of a struct
static PyObject *py_ue_uscriptstruct_ref(ue_PyUScriptStruct *self, PyObject * args)
{
ue_PyUScriptStruct *ret = (ue_PyUScriptStruct *)PyObject_New(ue_PyUScriptStruct, &ue_PyUScriptStructType);
ret->u_struct = self->u_struct;
ret->data = self->original_data;
ret->original_data = ret->data;
ret->is_ptr = 1;
return (PyObject *)ret;
}
static PyObject *ue_py_uscriptstruct_richcompare(ue_PyUScriptStruct *u_struct1, PyObject *py_obj, int op)
{
ue_PyUScriptStruct *u_struct2 = py_ue_is_uscriptstruct(py_obj);
if (!u_struct2 || (op != Py_EQ && op != Py_NE))
{
return PyErr_Format(PyExc_NotImplementedError, "can only compare with another UScriptStruct");
}
bool equals = (u_struct1->u_struct == u_struct2->u_struct && !memcmp(u_struct1->data, u_struct2->data, u_struct1->u_struct->GetStructureSize()));
if (op == Py_EQ)
{
if (equals)
{
Py_RETURN_TRUE;
}
Py_RETURN_FALSE;
}
if (equals)
{
Py_RETURN_FALSE;
}
Py_RETURN_TRUE;
}
void ue_python_init_uscriptstruct(PyObject *ue_module)
{
ue_PyUScriptStructType.tp_new = PyType_GenericNew;
ue_PyUScriptStructType.tp_richcompare = (richcmpfunc)ue_py_uscriptstruct_richcompare;
ue_PyUScriptStructType.tp_init = (initproc)ue_py_uscriptstruct_init;
if (PyType_Ready(&ue_PyUScriptStructType) < 0)
return;
Py_INCREF(&ue_PyUScriptStructType);
PyModule_AddObject(ue_module, "UScriptStruct", (PyObject *)&ue_PyUScriptStructType);
}
PyObject *py_ue_new_uscriptstruct(UScriptStruct *u_struct, uint8 *data)
{
ue_PyUScriptStruct *ret = (ue_PyUScriptStruct *)PyObject_New(ue_PyUScriptStruct, &ue_PyUScriptStructType);
ret->u_struct = u_struct;
uint8 *struct_data = (uint8*)FMemory::Malloc(u_struct->GetStructureSize());
ret->u_struct->InitializeStruct(struct_data);
ret->u_struct->CopyScriptStruct(struct_data, data);
ret->data = struct_data;
ret->original_data = data;
ret->is_ptr = 0;
return (PyObject *)ret;
}
// generate a new python UScriptStruct from an already allocated data block
PyObject *py_ue_wrap_uscriptstruct(UScriptStruct *u_struct, uint8 *data)
{
ue_PyUScriptStruct *ret = (ue_PyUScriptStruct *)PyObject_New(ue_PyUScriptStruct, &ue_PyUScriptStructType);
ret->u_struct = u_struct;
ret->data = data;
ret->original_data = data;
ret->is_ptr = 0;
return (PyObject *)ret;
}
ue_PyUScriptStruct *py_ue_is_uscriptstruct(PyObject *obj)
{
if (!PyObject_IsInstance(obj, (PyObject *)&ue_PyUScriptStructType))
return nullptr;
return (ue_PyUScriptStruct *)obj;
}