more solid threading support

Author: Roberto De Ioris

Source/UnrealEnginePython/Private/ConsoleManager/UEPyIConsoleManager.cpp

@@ -434,6 +434,10 @@ static PyObject *py_ue_iconsole_manager_unregister_object(PyObject *cls, PyObjec
 		return PyErr_Format(PyExc_Exception, "unable to find console object \"%s\"", key);
 	}
 
+
+	FPythonSmartConsoleDelegate::UnregisterPyDelegate(c_object);
+
+
 	IConsoleManager::Get().UnregisterConsoleObject(c_object, false);
 
 	Py_RETURN_NONE;
@@ -539,6 +543,9 @@ void FPythonSmartConsoleDelegate::OnConsoleCommand(const TArray < FString > & In
 	Py_DECREF(ret);
 }
 
+// static TArray declaration
+TArray<FPythonSmartConsoleDelegatePair> FPythonSmartConsoleDelegate::PyDelegatesMapping;
+
 static PyObject *py_ue_iconsole_manager_register_command(PyObject *cls, PyObject * args)
 {
 	char *key;
@@ -565,10 +572,14 @@ static PyObject *py_ue_iconsole_manager_register_command(PyObject *cls, PyObject
 	FConsoleCommandWithArgsDelegate console_delegate;
 	console_delegate.BindSP(py_delegate, &FPythonSmartConsoleDelegate::OnConsoleCommand);
 
-	if (!IConsoleManager::Get().RegisterConsoleCommand(UTF8_TO_TCHAR(key), help ? UTF8_TO_TCHAR(help) : UTF8_TO_TCHAR(key), console_delegate, 0))
-	{
+
+
+	c_object = IConsoleManager::Get().RegisterConsoleCommand(UTF8_TO_TCHAR(key), help ? UTF8_TO_TCHAR(help) : UTF8_TO_TCHAR(key), console_delegate, 0);
+	if (!c_object)
 		return PyErr_Format(PyExc_Exception, "unable to register console command \"%s\"", key);
-	}
+
+	// this allows the delegates to not be destroyed
+	FPythonSmartConsoleDelegate::RegisterPyDelegate(c_object, py_delegate);
 
 	Py_RETURN_NONE;
 }

Source/UnrealEnginePython/Private/ConsoleManager/UEPyIConsoleManager.h

@@ -10,11 +10,50 @@ typedef struct
 		/* Type-specific fields go here. */
 } ue_PyIConsoleManager;
 
+class FPythonSmartConsoleDelegate;
+struct FPythonSmartConsoleDelegatePair
+{
+	IConsoleObject *Key;
+	TSharedRef<FPythonSmartConsoleDelegate> Value;
+
+	FPythonSmartConsoleDelegatePair(IConsoleObject *InKey, TSharedRef<FPythonSmartConsoleDelegate> InValue) : Key(InKey), Value(InValue)
+	{
+
+	}
+};
+
 class FPythonSmartConsoleDelegate : public FPythonSmartDelegate
 {
 
 public:
 	void OnConsoleCommand(const TArray < FString > &InArgs);
+
+	static void RegisterPyDelegate(IConsoleObject *InKey, TSharedRef<FPythonSmartConsoleDelegate> InValue)
+	{
+		FPythonSmartConsoleDelegatePair Pair(InKey, InValue);
+		PyDelegatesMapping.Add(Pair);
+	}
+
+	static void UnregisterPyDelegate(IConsoleObject *Key)
+	{
+		int32 Index = -1;
+		for (int32 i = 0; i < PyDelegatesMapping.Num(); i++)
+		{
+			if (PyDelegatesMapping[i].Key == Key)
+			{
+				Index = i;
+				break;
+			}
+		}
+
+		if (Index >= 0)
+		{
+			PyDelegatesMapping.RemoveAt(Index);
+		}
+	}
+
+private:
+	static TArray<FPythonSmartConsoleDelegatePair> PyDelegatesMapping;
 };
 
 void ue_python_init_iconsole_manager(PyObject *);

Source/UnrealEnginePython/Private/UEPyModule.cpp

@@ -157,9 +157,9 @@ static PyObject *py_unreal_engine_exec(PyObject * self, PyObject * args)
 		return NULL;
 	}
 	FUnrealEnginePythonModule &PythonModule = FModuleManager::GetModuleChecked<FUnrealEnginePythonModule>("UnrealEnginePython");
-	UEPyGlobalState = PyEval_SaveThread();
+	Py_BEGIN_ALLOW_THREADS;
 	PythonModule.RunFile(filename);
-	PyEval_RestoreThread(UEPyGlobalState);
+	Py_END_ALLOW_THREADS;
 	Py_RETURN_NONE;
 }
 

Source/UnrealEnginePython/Private/UObject/UEPyTransform.cpp

@@ -236,9 +236,7 @@ PyObject *py_ue_set_actor_location(ue_PyUObject *self, PyObject * args)
 	FHitResult hit;
 	bool success = false;
 
-	Py_BEGIN_ALLOW_THREADS;
 	success = actor->SetActorLocation(vec, sweep, &hit, teleport_physics ? ETeleportType::TeleportPhysics : ETeleportType::None);
-	Py_END_ALLOW_THREADS;
 
 	if (!sweep)
 	{
@@ -268,9 +266,8 @@ PyObject *py_ue_add_actor_world_offset(ue_PyUObject *self, PyObject * args)
 		PyErr_Format(PyExc_Exception, "uobject is not an actor or a component");
 
 	FHitResult hit;
-	Py_BEGIN_ALLOW_THREADS;
+
 	actor->AddActorWorldOffset(vec, sweep, &hit, teleport_physics ? ETeleportType::TeleportPhysics : ETeleportType::None);
-	Py_END_ALLOW_THREADS;
 
 	if (!sweep)
 	{
@@ -296,9 +293,7 @@ PyObject *py_ue_add_actor_local_offset(ue_PyUObject *self, PyObject * args)
 		PyErr_Format(PyExc_Exception, "uobject is not an actor or a component");
 
 	FHitResult hit;
-	Py_BEGIN_ALLOW_THREADS;
 	actor->AddActorLocalOffset(vec, sweep, &hit, teleport_physics ? ETeleportType::TeleportPhysics : ETeleportType::None);
-	Py_END_ALLOW_THREADS;
 
 	if (!sweep)
 	{
@@ -324,9 +319,9 @@ PyObject *py_ue_add_actor_world_rotation(ue_PyUObject *self, PyObject * args)
 	if (!actor)
 		return PyErr_Format(PyExc_Exception, "uobject is not an actor or a component");
 	FHitResult hit;
-	Py_BEGIN_ALLOW_THREADS;
+
 	actor->AddActorWorldRotation(quat, sweep, &hit, teleport_physics ? ETeleportType::TeleportPhysics : ETeleportType::None);
-	Py_END_ALLOW_THREADS;
+
 	if (!sweep)
 	{
 		Py_RETURN_NONE;
@@ -351,9 +346,9 @@ PyObject *py_ue_add_actor_local_rotation(ue_PyUObject *self, PyObject * args)
 		return PyErr_Format(PyExc_Exception, "uobject is not an actor or a component");
 	FHitResult hit;
 
-	Py_BEGIN_ALLOW_THREADS;
+
 	actor->AddActorLocalRotation(quat, sweep, &hit, teleport_physics ? ETeleportType::TeleportPhysics : ETeleportType::None);
-	Py_END_ALLOW_THREADS;
+
 	if (!sweep)
 	{
 		Py_RETURN_NONE;
@@ -376,9 +371,9 @@ PyObject *py_ue_set_actor_scale(ue_PyUObject *self, PyObject * args)
 	if (!actor)
 		PyErr_Format(PyExc_Exception, "uobject is not an actor or a component");
 
-	Py_BEGIN_ALLOW_THREADS;
+
 	actor->SetActorScale3D(vec);
-	Py_END_ALLOW_THREADS;
+
 
 	Py_RETURN_NONE;
 
@@ -400,9 +395,9 @@ PyObject *py_ue_set_actor_rotation(ue_PyUObject *self, PyObject * args)
 
 	bool success = false;
 
-	Py_BEGIN_ALLOW_THREADS;
+
 	success = actor->SetActorRotation(quat, teleport_physics ? ETeleportType::TeleportPhysics : ETeleportType::None);
-	Py_END_ALLOW_THREADS;
+
 
 	if (success)
 	{
@@ -425,9 +420,9 @@ PyObject *py_ue_set_actor_transform(ue_PyUObject *self, PyObject * args)
 	if (!actor)
 		PyErr_Format(PyExc_Exception, "uobject is not an actor or a component");
 
-	Py_BEGIN_ALLOW_THREADS;
+
 	actor->SetActorTransform(t);
-	Py_END_ALLOW_THREADS;
+
 
 	Py_RETURN_NONE;
 }
@@ -567,9 +562,9 @@ PyObject *py_ue_set_world_location(ue_PyUObject *self, PyObject * args)
 
 	if (self->ue_object->IsA<USceneComponent>())
 	{
-		Py_BEGIN_ALLOW_THREADS;
+
 		((USceneComponent *)self->ue_object)->SetWorldLocation(vec, sweep, &hit, teleport_physics ? ETeleportType::TeleportPhysics : ETeleportType::None);
-		Py_END_ALLOW_THREADS;
+
 		if (!sweep)
 		{
 			Py_RETURN_NONE;
@@ -587,11 +582,10 @@ PyObject *py_ue_set_world_rotation(ue_PyUObject *self, PyObject * args)
 		return NULL;
 	if (self->ue_object->IsA<USceneComponent>())
 	{
-		Py_BEGIN_ALLOW_THREADS;
+	
 		((USceneComponent *)self->ue_object)->SetWorldRotation(rot);
-		Py_END_ALLOW_THREADS;
-		Py_INCREF(Py_None);
-		return Py_None;
+	
+		Py_RETURN_NONE;
 	}
 	return PyErr_Format(PyExc_Exception, "uobject is not a USceneComponent");
 }
@@ -605,10 +599,9 @@ PyObject *py_ue_set_world_scale(ue_PyUObject *self, PyObject * args)
 
 	if (self->ue_object->IsA<USceneComponent>())
 	{
-		Py_BEGIN_ALLOW_THREADS;
+	
 		((USceneComponent *)self->ue_object)->SetWorldScale3D(vec);
-		Py_RETURN_NONE;
-		Py_END_ALLOW_THREADS;
+	
 	}
 	return PyErr_Format(PyExc_Exception, "uobject is not a USceneComponent");
 }
@@ -626,9 +619,9 @@ PyObject *py_ue_set_world_transform(ue_PyUObject *self, PyObject * args)
 	if (!component)
 		return PyErr_Format(PyExc_Exception, "uobject is not a USceneComponent");
 
-	Py_BEGIN_ALLOW_THREADS;
+	
 	component->SetWorldTransform(t);
-	Py_END_ALLOW_THREADS;
+	
 
 	Py_RETURN_NONE;
 }
@@ -646,9 +639,9 @@ PyObject *py_ue_set_relative_transform(ue_PyUObject *self, PyObject * args)
 	if (!component)
 		return PyErr_Format(PyExc_Exception, "uobject is not a USceneComponent");
 
-	Py_BEGIN_ALLOW_THREADS;
+	
 	component->SetRelativeTransform(t);
-	Py_END_ALLOW_THREADS;
+
 	Py_RETURN_NONE;
 }
 
@@ -661,9 +654,9 @@ PyObject *py_ue_set_relative_location(ue_PyUObject *self, PyObject * args)
 
 	if (self->ue_object->IsA<USceneComponent>())
 	{
-		Py_BEGIN_ALLOW_THREADS;
+	
 		((USceneComponent *)self->ue_object)->SetRelativeLocation(vec);
-		Py_END_ALLOW_THREADS;
+		
 		Py_RETURN_NONE;
 	}
 	return PyErr_Format(PyExc_Exception, "uobject is not a USceneComponent");
@@ -677,9 +670,9 @@ PyObject *py_ue_set_relative_rotation(ue_PyUObject *self, PyObject * args)
 		return NULL;
 	if (self->ue_object->IsA<USceneComponent>())
 	{
-		Py_BEGIN_ALLOW_THREADS;
+	
 		((USceneComponent *)self->ue_object)->SetRelativeRotation(rot);
-		Py_END_ALLOW_THREADS;
+		
 		Py_RETURN_NONE;
 	}
 	return PyErr_Format(PyExc_Exception, "uobject is not a USceneComponent");
@@ -694,9 +687,9 @@ PyObject *py_ue_set_relative_scale(ue_PyUObject *self, PyObject * args)
 
 	if (self->ue_object->IsA<USceneComponent>())
 	{
-		Py_BEGIN_ALLOW_THREADS;
+		
 		((USceneComponent *)self->ue_object)->SetRelativeScale3D(vec);
-		Py_END_ALLOW_THREADS;
+		
 		Py_RETURN_NONE;
 	}
 	return PyErr_Format(PyExc_Exception, "uobject is not a USceneComponent");

Source/UnrealEnginePython/Private/UnrealEnginePython.cpp

@@ -372,7 +372,7 @@ void FUnrealEnginePythonModule::StartupModule()
 	}
 
 	// release the GIL
-	UEPyGlobalState = PyEval_SaveThread();
+	PyThreadState *UEPyGlobalState = PyEval_SaveThread();
 }
 
 void FUnrealEnginePythonModule::ShutdownModule()

Source/UnrealEnginePython/Public/PythonHouseKeeper.h

@@ -71,9 +71,8 @@ class FUnrealEnginePythonHouseKeeper
 
 	void RunGCDelegate()
 	{
-		PyGILState_STATE state = PyGILState_Ensure();
+		FScopePythonGIL gil;
 		RunGC();
-		PyGILState_Release(state);
 	}
 
 	int32 RunGC()

Source/UnrealEnginePython/Public/UnrealEnginePython.h

@@ -122,19 +122,19 @@ class UNREALENGINEPYTHON_API FUnrealEnginePythonModule : public IModuleInterface
 	TSharedPtr<FSlateStyleSet> StyleSet;
 };
 
-UNREALENGINEPYTHON_API extern PyThreadState* UEPyGlobalState;
-
 struct FScopePythonGIL
 {
 
+	PyGILState_STATE state;
+
 	FScopePythonGIL()
 	{
-		PyEval_RestoreThread(UEPyGlobalState);
+		state = PyGILState_Ensure();
 	}
 
 	~FScopePythonGIL()
 	{
-		UEPyGlobalState = PyEval_SaveThread();
+		PyGILState_Release(state);
 	}
 };