Fully support array parameters

Source/UnrealEnginePython/Private/PythonFunction.cpp

@@ -9,7 +9,6 @@ void UPythonFunction::SetPyCallable(PyObject *callable)
  Py_INCREF(py_callable);
 }
 
-
 #if ENGINE_MINOR_VERSION > 18
 void UPythonFunction::CallPythonCallable(UObject *Context, FFrame& Stack, RESULT_DECL)
 #else
@@ -27,12 +26,14 @@ void UPythonFunction::CallPythonCallable(FFrame& Stack, RESULT_DECL)
 
  bool on_error = false;
  bool is_static = function->HasAnyFunctionFlags(FUNC_Static);
+ FOutParmRec *OutParms = nullptr;
 
  // count the number of arguments
  Py_ssize_t argn = (Context && !is_static) ? 1 : 0;
- TFieldIterator<UProperty> IArgs(function);
- for (; IArgs && ((IArgs->PropertyFlags & (CPF_Parm | CPF_ReturnParm)) == CPF_Parm); ++IArgs) {
- argn++;
+ for (TFieldIterator<UProperty> IArgs(function); IArgs; ++IArgs)
+ {
+ if (!PROP_IS_OUT_PARAM(*IArgs))
+ argn++;
  }
 #if defined(UEPY_MEMORY_DEBUG)
  UE_LOG(LogPython, Warning, TEXT("Initializing %d parameters"), argn);
@@ -54,11 +55,11 @@ void UPythonFunction::CallPythonCallable(FFrame& Stack, RESULT_DECL)
 
  uint8 *frame = Stack.Locals;
 
- // is it a blueprint call ?
- if (*Stack.Code == EX_EndFunctionParms) {
+ if (*Stack.Code == EX_EndFunctionParms)
+ { // native call
  for (UProperty *prop = (UProperty *)function->Children; prop; prop = (UProperty *)prop->Next) {
- if (prop->PropertyFlags & CPF_ReturnParm)
- continue;
+ if (PROP_IS_OUT_PARAM(prop))
+ continue;
  if (!on_error) {
  PyObject *arg = ue_py_convert_property(prop, (uint8 *)Stack.Locals, 0);
  if (!arg) {
@@ -71,14 +72,23 @@ void UPythonFunction::CallPythonCallable(FFrame& Stack, RESULT_DECL)
  }
  }
  }
- else {
- //UE_LOG(LogPython, Warning, TEXT("BLUEPRINT CALL"));
+ else
+ { // blueprint call
+ // largely copied from ScriptCore.cpp::CallFunction - for BP calls, we need to set up some of the FOutParmRec stuff ourselves
  frame = (uint8 *)FMemory_Alloca(function->PropertiesSize);
  FMemory::Memzero(frame, function->PropertiesSize);
- for (UProperty *prop = (UProperty *)function->Children; *Stack.Code != EX_EndFunctionParms; prop = (UProperty *)prop->Next) {
+ for (UProperty *prop = (UProperty *)function->Children; *Stack.Code != EX_EndFunctionParms; prop = (UProperty *)prop->Next) 
+ {
  Stack.Step(Stack.Object, prop->ContainerPtrToValuePtr<uint8>(frame));
- if (prop->PropertyFlags & CPF_ReturnParm)
+ if (PROP_IS_OUT_PARAM(prop))
+ {
+ FOutParmRec *rec = (FOutParmRec*)FMemory_Alloca(sizeof(FOutParmRec));
+ rec->Property = prop;
+ rec->PropAddr = Stack.MostRecentPropertyAddress;
+ rec->NextOutParm = OutParms;
+ OutParms = rec;
  continue;
+ }
  if (!on_error) {
  PyObject *arg = ue_py_convert_property(prop, frame, 0);
  if (!arg) {
@@ -106,20 +116,72 @@ void UPythonFunction::CallPythonCallable(FFrame& Stack, RESULT_DECL)
  return;
  }
 
- // get return value (if required)
- UProperty *return_property = function->GetReturnProperty();
- if (return_property && function->ReturnValueOffset != MAX_uint16) {
-#if defined(UEPY_MEMORY_DEBUG)
- UE_LOG(LogPython, Warning, TEXT("FOUND RETURN VALUE"));
-#endif
- if (ue_py_convert_pyobject(ret, return_property, frame, 0)) {
- // copy value to stack result value
- FMemory::Memcpy(RESULT_PARAM, frame + function->ReturnValueOffset, return_property->ArrayDim * return_property->ElementSize);
- }
- else {
- UE_LOG(LogPython, Error, TEXT("Invalid return value type for function %s"), *function->GetFName().ToString());
- }
- }
+ // get return value and/or any out params - for convenience, if a single item is returned, wrap it in a tuple so that we can process
+ // multi-out params and single out params with one block of code
+ bool wrapped_ret = false;
+ if (!PyTuple_Check(ret))
+ {
+ PyObject *wrapped = PyTuple_New(1);
+ PyTuple_SetItem(wrapped, 0, ret);
+ ret = wrapped;
+ }
+
+ int nret = PyTuple_Size(ret);
+ int tuple_index = 0;
+ for (TFieldIterator<UProperty> It(function); It && (It->PropertyFlags & CPF_Parm); ++It)
+ {
+ if (!PROP_IS_OUT_PARAM(*It))
+ continue;
+ if (tuple_index >= nret)
+ {
+ UE_LOG(LogPython, Error, TEXT("Python function %s didn't return enough values"), *function->GetFName().ToString());
+ break;
+ }
+
+ UProperty *prop = *It;
+ PyObject *py_obj = PyTuple_GetItem(ret, tuple_index);
+ if (prop->PropertyFlags & CPF_ReturnParm)
+ { // handle the return value specially by having it write directly to the stack
+ if (!ue_py_convert_pyobject(py_obj, prop, (uint8*)RESULT_PARAM - prop->GetOffset_ForUFunction(), 0))
+ {
+ UE_LOG(LogPython, Error, TEXT("Invalid return value type for function %s"), *function->GetFName().ToString());
+ }
+ }
+ else
+ { // Find the given FOutParmRec for this property - look in the stack first
+ uint8 *out_frame = nullptr;
+ for (FOutParmRec *rec = Stack.OutParms; rec != nullptr; rec = rec->NextOutParm)
+ {
+ if (rec->Property == prop)
+ {
+ out_frame = rec->PropAddr - prop->GetOffset_ForUFunction();
+ break;
+ }
+ }
+ if (!out_frame)
+ { // look in our local out parms next
+ for (FOutParmRec *rec = OutParms; rec != nullptr; rec = rec->NextOutParm)
+ {
+ if (rec->Property == prop)
+ {
+ out_frame = rec->PropAddr - prop->GetOffset_ForUFunction();
+ break;
+ }
+ }
+ }
+ if (!out_frame)
+ { // default to our current frame
+ out_frame = frame;
+
+ }
+
+ if (!ue_py_convert_pyobject(py_obj, prop, out_frame, 0))
+ {
+ UE_LOG(LogPython, Error, TEXT("Failed to convert output property for function %s"), *function->GetFName().ToString());
+ }
+ }
+ tuple_index++;
+ }
  Py_DECREF(ret);
 }