[Synfig Studio] exception-guard now lists SynfigApp exception too (sy…

…nfig#2028)

(cherry picked from commit 06d71c5)

synfig-studio/src/gui/exception_guard.h

@@ -3,15 +3,39 @@
 
 #include <ETL/stringf>
 #include <synfig/general.h> // for synfig::error()
-#include <synfig/exception.h>
+#include <synfig/exception.h> // for synfig::Exception
+#include <synfigapp/action.h> // for synfigapp::Action::Error
 
-#ifdef _WIN32
+#ifdef _MSC_VER
 # ifndef __PRETTY_FUNCTION__
 #  define SYNFIG_DEFINED_PRETTY_FUNCTION_
 #  define __PRETTY_FUNCTION__ __FUNCSIG__
 #endif
 #endif
 
+/// These macros are supposed to be used in pair, and avoid any exception thrown to be propagated and terminate synfig.
+/// This is specially important for Gtk user event callback methods, like Gtk::Widget::on_event(), Gtk::Widget::on_key_press_event(),
+/// Gtk::Widget::on_draw() implementations. However, it may be used in any case.
+///
+/// Example code:
+///
+/// void my_method_that_could_not_throw() // maybe append noexcept keyword too
+/// {
+///     SYNFIG_EXCEPTION_GUARD_BEGIN()
+///     ... code
+///     ... code
+///     SYNFIG_EXCEPTION_GUARD_END()
+/// }
+///
+/// bool my_other_method_that_could_not_throw() // maybe append noexcept keyword too
+/// {
+///     SYNFIG_EXCEPTION_GUARD_BEGIN()
+///     ... code
+///     ... code
+///     SYNFIG_EXCEPTION_GUARD_END_BOOL(true) // return true if successfull, false if it caught any exception
+/// }
+///
+
 #define SYNFIG_EXCEPTION_GUARD_BEGIN() \
 	{ \
 		int _exception_guard_error_code = 0; \
@@ -20,34 +44,25 @@
 
 /// Normally, you shouldn't use this macro directly
 #define SYNFIG_EXCEPTION_GUARD_END_COMMON \
-		} \
-		catch(int ret) \
-		{ \
+		} catch(int ret) { \
 			_exception_guard_error_str = etl::strprintf("%s Uncaught Exception:int: %i", __PRETTY_FUNCTION__, ret); \
 			_exception_guard_error_code = ret; \
-		} \
-		catch(std::string& str) \
-		{ \
+		} catch(std::string& str) { \
 			_exception_guard_error_str = etl::strprintf("%s Uncaught Exception:string: %s", __PRETTY_FUNCTION__, str.c_str()); \
 			_exception_guard_error_code = 1001; \
-		} \
-		catch(synfig::Exception::Exception& x) \
-		{ \
+		} catch(synfig::Exception::Exception& x) { \
 			_exception_guard_error_str = etl::strprintf("%s Synfig Exception: %s", __PRETTY_FUNCTION__, x.what()); \
 			_exception_guard_error_code = 1002; \
-		} \
-		catch(std::exception& x) \
-		{ \
+		} catch(std::exception& x) { \
 			_exception_guard_error_str = etl::strprintf("%s Standard Exception: %s", __PRETTY_FUNCTION__, x.what()); \
-			_exception_guard_error_code = 1002; \
-		} \
-		catch(Glib::Exception& x) \
-		{ \
+			_exception_guard_error_code = 1004; \
+		} catch(Glib::Exception& x) { \
 			_exception_guard_error_str = etl::strprintf("%s GLib Exception: %s", __PRETTY_FUNCTION__, x.what().c_str()); \
 			_exception_guard_error_code = 1003; \
-		} \
-		catch(...) \
-		{ \
+		} catch(synfigapp::Action::Error& x) { \
+			_exception_guard_error_str = etl::strprintf("%s SynfigApp Exception: $i - %s", __PRETTY_FUNCTION__, x.get_type(), x.get_desc().c_str()); \
+			_exception_guard_error_code = 1005; \
+		} catch(...) { \
 			_exception_guard_error_str = etl::strprintf("%s Uncaught Exception:unknown type", __PRETTY_FUNCTION__); \
 			_exception_guard_error_code = 1100; \
 		}
@@ -56,18 +71,27 @@
 #define SYNFIG_EXCEPTION_GUARD_END() \
 	SYNFIG_EXCEPTION_GUARD_END_COMMON \
 		if (!_exception_guard_error_str.empty()) { \
-			synfig::error("%s", _exception_guard_error_str.c_str()); \
+			synfig::error("%s (%d)", _exception_guard_error_str.c_str(), _exception_guard_error_code); \
 			return; \
 		} else { \
 			return; \
 		} \
 	}
 
+/// It just finishes the exception guard, don't do any return
+#define SYNFIG_EXCEPTION_GUARD_END_NO_RETURN() \
+	SYNFIG_EXCEPTION_GUARD_END_COMMON \
+		if (!_exception_guard_error_str.empty()) { \
+			synfig::error("%s (%d)", _exception_guard_error_str.c_str(), _exception_guard_error_code); \
+		} \
+	}
+
+
 /// It should return a boolean. On success, return success_value; inverse value otherwise
 #define SYNFIG_EXCEPTION_GUARD_END_BOOL(success_value) \
 	SYNFIG_EXCEPTION_GUARD_END_COMMON \
 		if (!_exception_guard_error_str.empty()) { \
-			synfig::error("%s", _exception_guard_error_str.c_str()); \
+			synfig::error("%s (%d)", _exception_guard_error_str.c_str(), _exception_guard_error_code); \
 			return !success_value; \
 		} else { \
 			return success_value; \
@@ -78,7 +102,7 @@
 #define SYNFIG_EXCEPTION_GUARD_END_INT(success_value) \
 	SYNFIG_EXCEPTION_GUARD_END_COMMON \
 		if (!_exception_guard_error_str.empty()) { \
-			synfig::error("%s", _exception_guard_error_str.c_str()); \
+			synfig::error("%s (%d)", _exception_guard_error_str.c_str(), _exception_guard_error_code); \
 			return _exception_guard_error_code; \
 		} else { \
 			return success_value; \
@@ -89,7 +113,7 @@
 #define SYNFIG_EXCEPTION_GUARD_END_NULL(success_value) \
 	SYNFIG_EXCEPTION_GUARD_END_COMMON \
 		if (!_exception_guard_error_str.empty()) { \
-			synfig::error("%s", _exception_guard_error_str.c_str()); \
+			synfig::error("%s (%d)", _exception_guard_error_str.c_str(), _exception_guard_error_code); \
 			return nullptr; \
 		} else { \
 			return success_value; \