pass all structs by ref

Author: Roberto De Ioris

Source/UnrealEnginePython/Private/Slate/UEPyIStructureDetailsView.cpp

@@ -52,7 +52,7 @@ static PyObject *py_ue_istructure_details_view_set_structure_data(ue_PyIStructur
 	Py_XDECREF(self->ue_py_struct);
 	self->ue_py_struct = ue_py_struct;
 	Py_INCREF(self->ue_py_struct);
-	TSharedPtr<FStructOnScope> struct_scope = MakeShared<FStructOnScope>(ue_py_struct->u_struct, ue_py_struct->data);
+	TSharedPtr<FStructOnScope> struct_scope = MakeShared<FStructOnScope>(ue_py_struct->u_struct, ue_py_struct->u_struct_ptr);
 	FPropertyEditorModule& PropertyEditorModule = FModuleManager::GetModuleChecked<FPropertyEditorModule>("PropertyEditor");
 	self->istructure_details_view->SetStructureData(struct_scope);
 
@@ -188,7 +188,7 @@ static int ue_py_istructure_details_view_init(ue_PyIStructureDetailsView *self,
 
 	self->ue_py_struct = ue_py_struct;
 	Py_INCREF(self->ue_py_struct);
-	TSharedPtr<FStructOnScope> struct_scope = MakeShared<FStructOnScope>(ue_py_struct->u_struct, ue_py_struct->data);
+	TSharedPtr<FStructOnScope> struct_scope = MakeShared<FStructOnScope>(ue_py_struct->u_struct, ue_py_struct->u_struct_ptr);
 	FPropertyEditorModule& PropertyEditorModule = FModuleManager::GetModuleChecked<FPropertyEditorModule>("PropertyEditor");
 	new(&self->istructure_details_view) TSharedRef<IStructureDetailsView>(PropertyEditorModule.CreateStructureDetailView(view_args, struct_view_args, struct_scope));
 

Source/UnrealEnginePython/Private/Slate/UEPySlate.cpp

@@ -1190,7 +1190,7 @@ PyObject *py_unreal_engine_create_structure_detail_view(PyObject *self, PyObject
 	{
 		Py_INCREF(ue_py_struct);
 		ret->ue_py_struct = ue_py_struct;
-		struct_scope = MakeShared<FStructOnScope>(ue_py_struct->u_struct, ue_py_struct->data);
+		struct_scope = MakeShared<FStructOnScope>(ue_py_struct->u_struct, ue_py_struct->u_struct_ptr);
 	}
 
 	FPropertyEditorModule& PropertyEditorModule = FModuleManager::GetModuleChecked<FPropertyEditorModule>("PropertyEditor");

Source/UnrealEnginePython/Private/UEPyModule.cpp

@@ -1368,7 +1368,7 @@ static PyObject *ue_PyUObject_call(ue_PyUObject *self, PyObject *args, PyObject
 				}
 			}
 		}
-		return py_ue_wrap_uscriptstruct(u_script_struct, data);
+		return py_ue_new_uscriptstruct(u_script_struct, data);
 	}
 	return PyErr_Format(PyExc_Exception, "the specified uobject has no __call__ support");
 }
@@ -2472,7 +2472,7 @@ bool ue_py_convert_pyobject(PyObject *py_obj, UProperty *prop, uint8 *buffer, in
 			if (casted_prop->Struct == py_u_struct->u_struct)
 			{
 				uint8 *dest = casted_prop->ContainerPtrToValuePtr<uint8>(buffer, index);
-				FMemory::Memcpy(dest, py_u_struct->data, py_u_struct->u_struct->GetStructureSize());
+				FMemory::Memcpy(dest, py_u_struct->u_struct_ptr, py_u_struct->u_struct->GetStructureSize());
 				return true;
 			}
 		}
@@ -3288,7 +3288,7 @@ FGuid *ue_py_check_fguid(PyObject *py_obj)
 
 	if (ue_py_struct->u_struct == FindObject<UScriptStruct>(ANY_PACKAGE, UTF8_TO_TCHAR((char *)"Guid")))
 	{
-		return (FGuid*)ue_py_struct->data;
+		return (FGuid*)ue_py_struct->u_struct_ptr;
 	}
 
 	return nullptr;
@@ -3303,7 +3303,7 @@ uint8 * do_ue_py_check_struct(PyObject *py_obj, UScriptStruct* chk_u_struct)
 
 	if (ue_py_struct->u_struct == chk_u_struct)
 	{
-		return ue_py_struct->data;
+		return ue_py_struct->u_struct_ptr;
 	}
 
 	return nullptr;

Source/UnrealEnginePython/Private/UEPyUScriptStruct.cpp

@@ -78,10 +78,7 @@ static PyObject *py_ue_uscriptstruct_get_struct(ue_PyUScriptStruct *self, PyObje
 	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->u_struct_ptr);
-}
+static PyObject *py_ue_uscriptstruct_clone(ue_PyUScriptStruct *, PyObject *);
 
 PyObject *py_ue_uscriptstruct_as_dict(ue_PyUScriptStruct * self, PyObject * args)
 {
@@ -98,7 +95,7 @@ PyObject *py_ue_uscriptstruct_as_dict(ue_PyUScriptStruct * self, PyObject * args
 	TFieldIterator<UProperty> SArgs(self->u_struct);
 	for (; SArgs; ++SArgs)
 	{
-		PyObject *struct_value = ue_py_convert_property(*SArgs, self->data, 0);
+		PyObject *struct_value = ue_py_convert_property(*SArgs, self->u_struct_ptr, 0);
 		if (!struct_value)
 		{
 			Py_DECREF(py_struct_dict);
@@ -143,7 +140,7 @@ static PyMethodDef ue_PyUScriptStruct_methods[] = {
 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);
+		TCHAR_TO_UTF8(*self->u_struct->GetName()), self->u_struct->GetStructureSize(), self->u_struct_ptr);
 }
 
 static UProperty *get_field_from_name(UScriptStruct *u_struct, char *name)
@@ -193,7 +190,7 @@ static PyObject *ue_PyUScriptStruct_getattro(ue_PyUScriptStruct *self, PyObject
 			{
 				// swallow previous exception
 				PyErr_Clear();
-				return ue_py_convert_property(u_property, self->data, 0);
+				return ue_py_convert_property(u_property, self->u_struct_ptr, 0);
 			}
 		}
 	}
@@ -210,7 +207,7 @@ static int ue_PyUScriptStruct_setattro(ue_PyUScriptStruct *self, PyObject *attr_
 		UProperty *u_property = get_field_from_name(self->u_struct, (char *)attr);
 		if (u_property)
 		{
-			if (ue_py_convert_pyobject(value, u_property, self->data, 0))
+			if (ue_py_convert_pyobject(value, u_property, self->u_struct_ptr, 0))
 			{
 				return 0;
 			}
@@ -229,9 +226,9 @@ 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)
+	if (self->u_struct_owned)
 	{
-		FMemory::Free(self->data);
+		FMemory::Free(self->u_struct_ptr);
 	}
 	Py_TYPE(self)->tp_free((PyObject *)self);
 }
@@ -289,25 +286,20 @@ static int ue_py_uscriptstruct_init(ue_PyUScriptStruct *self, PyObject *args, Py
 	}
 
 	self->u_struct = (UScriptStruct *)py_u_obj->ue_object;
-	self->data = (uint8*)FMemory::Malloc(self->u_struct->GetStructureSize());
-	self->u_struct->InitializeStruct(self->data);
+	self->u_struct_ptr = (uint8*)FMemory::Malloc(self->u_struct->GetStructureSize());
+	self->u_struct->InitializeStruct(self->u_struct_ptr);
 #if WITH_EDITOR
-	self->u_struct->InitializeDefaultValue(self->data);
+	self->u_struct->InitializeDefaultValue(self->u_struct_ptr);
 #endif
-	self->original_data = self->data;
-	self->is_ptr = 0;
+	self->u_struct_owned = 1;
 	return 0;
 }
 
-// get the original pointer of a struct
+// get the original pointer of a struct (dumb function for backward compatibility with older scripts from
+// a dark age where strctures were passed by value)
 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;
+	return (PyObject *)self;
 }
 
 static PyObject *ue_py_uscriptstruct_richcompare(ue_PyUScriptStruct *u_struct1, PyObject *py_obj, int op)
@@ -318,7 +310,7 @@ static PyObject *ue_py_uscriptstruct_richcompare(ue_PyUScriptStruct *u_struct1,
 		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()));
+	bool equals = (u_struct1->u_struct == u_struct2->u_struct && !memcmp(u_struct1->u_struct_ptr, u_struct2->u_struct_ptr, u_struct1->u_struct->GetStructureSize()));
 
 	if (op == Py_EQ)
 	{
@@ -358,23 +350,20 @@ 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;
+	ret->u_struct_ptr = data;
+	ret->u_struct_owned = 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)
+static PyObject *py_ue_uscriptstruct_clone(ue_PyUScriptStruct *self, PyObject * args)
 {
 	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;
+	ret->u_struct = self->u_struct;
+	uint8 *struct_data = (uint8*)FMemory::Malloc(self->u_struct->GetStructureSize());
+	ret->u_struct->InitializeStruct(struct_data);
+	ret->u_struct->CopyScriptStruct(struct_data, self->u_struct_ptr);
+	ret->u_struct_ptr = struct_data;
+	ret->u_struct_owned = 1;
 	return (PyObject *)ret;
 }
 

Source/UnrealEnginePython/Private/UEPyUScriptStruct.h

@@ -8,14 +8,11 @@ typedef struct
 	/* Type-specific fields go here. */
 	UScriptStruct *u_struct;
 	uint8 *u_struct_ptr;
-	// points to the original struct memory (do not try this at home !)
-	uint8 *original_ptr;
 	// if set, the struct is responsible for freeing memory
 	int u_struct_owned;
 } ue_PyUScriptStruct;
 
 PyObject *py_ue_new_uscriptstruct(UScriptStruct *, uint8 *);
-PyObject *py_ue_wrap_uscriptstruct(UScriptStruct *, uint8 *);
 ue_PyUScriptStruct *py_ue_is_uscriptstruct(PyObject *);
 
 UProperty *ue_struct_get_field_from_name(UScriptStruct *, char *);