feat: add panic handling

Author: YaoerWu

src/lib.rs

@@ -10,6 +10,30 @@ use image::BGRImage;
 use interface::{Interface, RecognizeEnemyInput, WrappedPixels};
 
 use std::ffi::{c_char, c_int, c_void};
+use std::panic;
+
+/// Helper function to catch panics and log stack trace
+fn catch_panic<F, R>(f: F) -> Result<R, ()>
+where
+    F: FnOnce() -> R + panic::UnwindSafe,
+{
+    panic::catch_unwind(f).map_err(|panic_info| {
+        eprintln!("Panic occurred in image-autowsgrs library:");
+
+        // Print panic message
+        if let Some(s) = panic_info.downcast_ref::<&str>() {
+            eprintln!("Panic message: {s}");
+        } else if let Some(s) = panic_info.downcast_ref::<String>() {
+            eprintln!("Panic message: {s}");
+        } else {
+            eprintln!("Panic message: <unknown>");
+        }
+
+        // Print backtrace if available
+        eprintln!("Stack backtrace:");
+        eprintln!("{}", std::backtrace::Backtrace::capture());
+    })
+}
 
 /// # Safety
 /// The input pointer must be freed by caller
@@ -23,14 +47,17 @@ use std::ffi::{c_char, c_int, c_void};
 /// e.g. [[0, 1], [2, 3], [4, 5]]
 #[no_mangle]
 pub unsafe extern "C" fn locate(input: *const c_void, output: *mut c_int) -> c_int {
-    let image = BGRImage::from_wrapped_pixels(WrappedPixels::from_raw(input));
-    let result = locator::locate(&image);
-    if result.is_empty() || result.len() >= 32 {
-        return -1;
-    }
-    let len = result.len();
-    output.copy_from_nonoverlapping(result.as_ptr() as *const c_int, len);
-    len as c_int
+    catch_panic(|| {
+        let image = BGRImage::from_wrapped_pixels(WrappedPixels::from_raw(input));
+        let result = locator::locate(&image);
+        if result.is_empty() || result.len() >= 32 {
+            return -1;
+        }
+        let len = result.len();
+        output.copy_from_nonoverlapping(result.as_ptr() as *const c_int, len);
+        len as c_int
+    })
+    .unwrap_or(-1)
 }
 
 /// # Safety
@@ -45,20 +72,23 @@ pub unsafe extern "C" fn locate(input: *const c_void, output: *mut c_int) -> c_i
 /// e.g. "DD SS NO NO NO NO"
 #[no_mangle]
 pub unsafe extern "C" fn recognize_enemy(input: *const c_void, output: *mut c_char) -> c_int {
-    let input = RecognizeEnemyInput::from_raw(input);
-    let result = recognize_enemy::recognize_enemy(
-        &input.images,
-        &recognize_enemy::templates::Template::init_templates(),
-    );
+    catch_panic(|| {
+        let input = RecognizeEnemyInput::from_raw(input);
+        let result = recognize_enemy::recognize_enemy(
+            &input.images,
+            &recognize_enemy::templates::Template::init_templates(),
+        );
 
-    output.copy_from(result.as_ptr() as *const c_char, result.len());
-    0
+        output.copy_from(result.as_ptr() as *const c_char, result.len());
+        0
+    })
+    .unwrap_or(-1)
 }
 
 /// # Safety
 /// The input pointer must be freed by caller
 ///
-/// cant be failed, always return a character
+/// return '\0' if failed (panic occurred), otherwise return the recognized character
 ///
 /// # Usage
 ///
@@ -67,7 +97,10 @@ pub unsafe extern "C" fn recognize_enemy(input: *const c_void, output: *mut c_ch
 /// e.g. 'J'
 #[no_mangle]
 pub unsafe extern "C" fn recognize_map(input: *const c_void) -> c_char {
-    let image = BGRImage::from_wrapped_pixels(WrappedPixels::from_raw(input));
-    let result = recognize_map::recognize_map(&image);
-    result as c_char
+    catch_panic(|| {
+        let image = BGRImage::from_wrapped_pixels(WrappedPixels::from_raw(input));
+        let result = recognize_map::recognize_map(&image);
+        result as c_char
+    })
+    .unwrap_or_default()
 }

src/recognize_map.rs

@@ -172,7 +172,7 @@ pub fn recognize_map(image: &BGRImage) -> char {
                     }
                 }
                 6 | 7 => 'G',
-                _ => '0',
+                _ => '\0',
             }
         } else {
             'H'