Throw exceptions for Resets and Exits instead of directly raising.

While this does close small memory leaks, this is mostly for threading reasons. We're not supposed to call rb_raise with the gvl released, and calling rb_raise prevents GFX_UNLOCK from being called, which would cause problems for any games that want to call graphical operations in multiple threads should the user reset.

We're also now calling Graphics.__reset__ and Audio.__reset__ via eval instead of directly calling the functions, in case a game wants to hook them.

Author: WaywardHeart

binding/binding-mri.cpp

@@ -315,21 +315,29 @@ static void printP(int argc, VALUE *argv, const char *convMethod,
 }
 
 
-RB_METHOD(mriPrint) {
+RB_METHOD_GUARD(mriPrint) {
     RB_UNUSED_PARAM;
 
     printP(argc, argv, "to_s", "");
 
+    shState->checkShutdown();
+    shState->checkReset();
+    
     return Qnil;
 }
+RB_METHOD_GUARD_END
 
-RB_METHOD(mriP) {
+RB_METHOD_GUARD(mriP) {
     RB_UNUSED_PARAM;
 
     printP(argc, argv, "inspect", "\n");
 
+    shState->checkShutdown();
+    shState->checkReset();
+    
     return Qnil;
 }
+RB_METHOD_GUARD_END
 
 RB_METHOD(mkxpDelta) {
     RB_UNUSED_PARAM;
@@ -757,15 +765,21 @@ static VALUE rgssMainRescue(VALUE arg, VALUE exc) {
     return Qnil;
 }
 
-static void processReset() {
-    shState->graphics().reset();
-    shState->audio().reset();
-    
-    shState->rtData().rqReset.clear();
-    shState->graphics().repaintWait(shState->rtData().rqResetFinish, false);
+static bool processReset(bool rubyExc) {
+	const char *str = "Audio.__reset__; Graphics.__reset__;";
+	
+	if (rubyExc) {
+		rb_eval_string(str);
+	} else {
+		int state;
+		rb_eval_string_protect(str, &state);
+		return state;
+	}
+	
+	return 0;
 }
 
-RB_METHOD(mriRgssMain) {
+RB_METHOD_GUARD(mriRgssMain) {
     RB_UNUSED_PARAM;
 
     while (true) {
@@ -783,22 +797,24 @@ RB_METHOD(mriRgssMain) {
             break;
 
         if (rb_obj_class(exc) == getRbData()->exc[Reset])
-            processReset();
+            processReset(true);
         else
             rb_exc_raise(exc);
     }
 
     return Qnil;
 }
+RB_METHOD_GUARD_END
 
-RB_METHOD(mriRgssStop) {
+RB_METHOD_GUARD(mriRgssStop) {
     RB_UNUSED_PARAM;
 
     while (true)
         shState->graphics().update();
 
     return Qnil;
 }
+RB_METHOD_GUARD_END
 
 RB_METHOD(_kernelCaller) {
     RB_UNUSED_PARAM;
@@ -1038,7 +1054,8 @@ static void runRMXPScripts(BacktraceData &btData) {
         if (rb_obj_class(exc) != getRbData()->exc[Reset])
             break;
 
-        processReset();
+        if (processReset(false))
+            break;
     }
 }
 
@@ -1247,6 +1264,6 @@ static void mriBindingExecute() {
     shState->rtData().rqTermAck.set();
 }
 
-static void mriBindingTerminate() { rb_raise(rb_eSystemExit, " "); }
+static void mriBindingTerminate() { throw Exception(Exception::SystemExit, " "); }
 
-static void mriBindingReset() { rb_raise(getRbData()->exc[Reset], " "); }
+static void mriBindingReset() { throw Exception(Exception::Reset, " "); }

binding/binding-util.cpp

@@ -58,8 +58,9 @@ RbData::~RbData() {}
 
 /* Indexed with Exception::Type */
 const RbException excToRbExc[] = {
-    RGSS,        /* RGSSError   */
-    ErrnoENOENT, /* NoFileError */
+    RGSS,        /* RGSSError          */
+    Reset,       /* Reset/RGSSReset */
+    ErrnoENOENT, /* NoFileError        */
     IOError,
 
     TypeError,   ArgumentError, SystemExit, RuntimeError,
@@ -317,3 +318,39 @@ int rb_get_args(int argc, VALUE *argv, const char *format, ...) {
 
   return 0;
 }
+
+#if RAPI_MAJOR >= 2
+#include <ruby/thread.h>
+
+typedef struct gvl_guard_args {
+	Exception *exc;
+	void *(*func)(void *);
+	void *args;
+} gvl_guard_args;
+
+static void *gvl_guard(void *args) {
+	gvl_guard_args *gvl_args = (gvl_guard_args*)args;
+	try{
+		return gvl_args->func(gvl_args->args);
+	} catch (const Exception &e) {
+		gvl_args->exc = new Exception(e.type, e.msg);
+	}
+	return 0;
+}
+
+void *drop_gvl_guard(void *(*func)(void *), void *args,
+                            rb_unblock_function_t *ubf, void *data2) {
+	gvl_guard_args gvl_args = {0, func, args};
+	
+	void *ret = rb_thread_call_without_gvl(&gvl_guard, &gvl_args, ubf, data2);
+	
+	Exception *&exc = gvl_args.exc;
+	if (exc){
+		Exception e(exc->type, exc->msg);
+		delete exc;
+		throw e;
+	}
+	return ret;
+}
+
+#endif

binding/binding-util.h

@@ -78,6 +78,11 @@ struct Exception;
 VALUE excToRbClass(const Exception &exc);
 void raiseRbExc(Exception exc);
 
+#if RAPI_MAJOR >= 2
+void *drop_gvl_guard(void *(*func)(void *), void *args,
+                            rb_unblock_function_t *ubf, void *data2);
+#endif
+
 #if RAPI_FULL > 187
 #define DECL_TYPE(Klass) extern rb_data_type_t Klass##Type
 
@@ -309,15 +314,6 @@ static inline void _rb_define_module_function(VALUE module, const char *name,
     rb_define_module_function(module, name, RUBY_METHOD_FUNC(func), -1);
 }
 
-#define GUARD_EXC(exp)                                                         \
-{                                                                            \
-try {                                                                      \
-exp                                                                      \
-} catch (const Exception &exc) {                                           \
-raiseRbExc(exc);                                                         \
-}                                                                          \
-}
-
 #define GFX_GUARD_EXC(exp)                                               \
 {                                                                        \
 GFX_LOCK;                                                                \