Prevent overflows using saturating types for several script functions

gen_7_scripts/src/common_usings.rs

@@ -4,6 +4,7 @@ pub use alloc::rc::Rc;
 pub use alloc::vec::Vec;
 pub use atomic_float::AtomicF32;
 pub use core::any::Any;
+pub use core::num::Saturating;
 pub use core::sync::atomic::{AtomicBool, AtomicI8, AtomicU32, Ordering};
 pub use pkmn_lib_interface::app_interface::{
     get_volatile_as, BattleSide, DamageSource, DynamicLibrary, EffectParameter, ExecutingMove,

gen_7_scripts/src/moves/acrobatics.rs

@@ -21,15 +21,11 @@ impl Script for Acrobatics {
         mv: ExecutingMove,
         _target: Pokemon,
         _hit: u8,
-        base_power: &mut u8,
+        base_power: &mut Saturating<u8>,
     ) -> PkmnResult<()> {
         if mv.user().held_item()?.is_none() {
-            if *base_power >= 128_u8 {
-                *base_power = 255
-            } else {
             *base_power *= 2;
         }
-        }
         Ok(())
     }
 
@@ -65,11 +61,11 @@ mod tests {
         let mv = mock_executing_move(false);
 
         let script = Acrobatics::new();
-        let mut base_power = 50u8;
+        let mut base_power = Saturating(50u8);
         script
             .change_base_power(mv, Rc::new(MockPokemon::new()), 0, &mut base_power)
             .unwrap();
-        assert_eq!(100, base_power);
+        assert_eq!(100, base_power.0);
     }
 
     #[test]
@@ -77,11 +73,11 @@ mod tests {
         let mv = mock_executing_move(false);
 
         let script = Acrobatics::new();
-        let mut base_power = 200u8;
+        let mut base_power = Saturating(200u8);
         script
             .change_base_power(mv, Rc::new(MockPokemon::new()), 0, &mut base_power)
             .unwrap();
-        assert_eq!(255, base_power);
+        assert_eq!(255, base_power.0);
     }
 
     #[test]
@@ -89,10 +85,10 @@ mod tests {
         let mv = mock_executing_move(true);
 
         let script = Acrobatics::new();
-        let mut base_power = 50u8;
+        let mut base_power = Saturating(50u8);
         script
             .change_base_power(mv, Rc::new(MockPokemon::new()), 0, &mut base_power)
             .unwrap();
-        assert_eq!(50, base_power);
+        assert_eq!(50, base_power.0);
     }
 }

gen_7_scripts/src/moves/assurance.rs

@@ -40,7 +40,7 @@ impl Script for Assurance {
         _move: ExecutingMove,
         target: Pokemon,
         _hit: u8,
-        base_power: &mut u8,
+        base_power: &mut Saturating<u8>,
     ) -> PkmnResult<()> {
         if let Some(s) = get_volatile_as::<AssuranceData>(
             target.battle_side()?.as_ref(),

gen_7_scripts/src/moves/increased_critical_stage.rs

@@ -21,7 +21,7 @@ impl Script for IncreasedCriticalStage {
         _move: ExecutingMove,
         _target: Pokemon,
         _hit: u8,
-        stage: &mut u8,
+        stage: &mut Saturating<u8>,
     ) -> PkmnResult<()> {
         *stage += 1;
         Ok(())

gen_7_scripts/src/moves/multi_hit_move.rs

@@ -21,7 +21,11 @@ impl Script for MultiHitMove {
         &[ScriptCapabilities::ChangeNumberOfHits]
     }
 
-    fn change_number_of_hits(&self, choice: TurnChoice, number_of_hits: &mut u8) -> PkmnResult<()> {
+    fn change_number_of_hits(
+        &self,
+        choice: TurnChoice,
+        number_of_hits: &mut Saturating<u8>,
+    ) -> PkmnResult<()> {
         // 35% chance that it will hit 2 times, a 35% chance it will hit 3 times, a 15% chance it
         // will hit 4 times, and a 15% chance it will hit 5 times.
         let rand_value = choice
@@ -30,12 +34,12 @@ impl Script for MultiHitMove {
             .unwrap()
             .random()
             .get_between(0, 100)?;
-        *number_of_hits = match rand_value {
+        number_of_hits.0 = match rand_value {
             0..=34 => 2,
             35..=69 => 3,
             70..=84 => 4,
             85..=100 => 5,
-            _ => *number_of_hits,
+            _ => number_of_hits.0,
         };
         Ok(())
     }

gen_7_scripts/src/moves/struggle.rs

@@ -23,9 +23,9 @@ impl Script for Struggle {
     fn change_number_of_hits(
         &self,
         _choice: TurnChoice,
-        number_of_hits: &mut u8,
+        number_of_hits: &mut Saturating<u8>,
     ) -> PkmnResult<()> {
-        *number_of_hits = 1;
+        number_of_hits.0 = 1;
         Ok(())
     }
 

gen_7_scripts/src/side/aurora_veil_effect.rs

@@ -28,7 +28,7 @@ impl Script for AuroraVeilEffect {
         mv: ExecutingMove,
         target: Pokemon,
         hit: u8,
-        damage: &mut u32,
+        damage: &mut Saturating<u32>,
     ) -> PkmnResult<()> {
         if mv.get_hit_data(&target, hit)?.is_critical()? {
             return Ok(());
@@ -48,7 +48,7 @@ impl Script for AuroraVeilEffect {
         if target.battle()?.unwrap().pokemon_per_side()? > 1 {
             modifier = 1.5
         }
-        *damage = (*damage as f32 / modifier) as u32;
+        damage.0 = (damage.0 as f32 / modifier) as u32;
         Ok(())
     }
 

pkmn_lib_interface/src/handling/script.rs

@@ -8,6 +8,8 @@ use alloc::rc::Rc;
 use alloc::vec::Vec;
 use core::any::Any;
 use core::fmt::{Debug, Display, Formatter};
+use core::num::Saturating;
+
 type Result<T> = crate::result::PkmnResult<T>;
 
 pub trait Script {
@@ -45,7 +47,7 @@ pub trait Script {
 
     /// This function allows you to modify the effective speed of the Pokemon. This is ran before
     /// turn ordering, so overriding here will allow you to put certain Pokemon before others.
-    fn change_speed(&self, _choice: TurnChoice, _speed: &mut u32) -> Result<()> {
+    fn change_speed(&self, _choice: TurnChoice, _speed: &mut Saturating<u32>) -> Result<()> {
         Ok(())
     }
     /// This function allows you to modify the effective priority of the Pokemon. This is ran before
@@ -63,7 +65,11 @@ pub trait Script {
     /// This function allows you to change a move into a multi-hit move. The number of hits set here
     /// gets used as the number of hits. If set to 0, this will behave as if the move missed on its
     /// first hit.
-    fn change_number_of_hits(&self, _choice: TurnChoice, _number_of_hits: &mut u8) -> Result<()> {
+    fn change_number_of_hits(
+        &self,
+        _choice: TurnChoice,
+        _number_of_hits: &mut Saturating<u8>,
+    ) -> Result<()> {
         Ok(())
     }
 
@@ -157,7 +163,7 @@ pub trait Script {
         _move: ExecutingMove,
         _target: Pokemon,
         _hit: u8,
-        _accuracy: &mut u8,
+        _accuracy: &mut Saturating<u8>,
     ) -> Result<()> {
         Ok(())
     }
@@ -168,7 +174,7 @@ pub trait Script {
         _move: ExecutingMove,
         _target: Pokemon,
         _hit: u8,
-        _stage: &mut u8,
+        _stage: &mut Saturating<u8>,
     ) -> Result<()> {
         Ok(())
     }
@@ -201,7 +207,7 @@ pub trait Script {
         _move: ExecutingMove,
         _target: Pokemon,
         _hit: u8,
-        _base_power: &mut u8,
+        _base_power: &mut Saturating<u8>,
     ) -> Result<()> {
         Ok(())
     }
@@ -231,7 +237,7 @@ pub trait Script {
         _move: ExecutingMove,
         _target: Pokemon,
         _hit: u8,
-        _amount: &mut u32,
+        _amount: &mut Saturating<u32>,
     ) -> Result<()> {
         Ok(())
     }
@@ -241,7 +247,7 @@ pub trait Script {
         _move: ExecutingMove,
         _target: Pokemon,
         _hit: u8,
-        _amount: &mut u32,
+        _amount: &mut Saturating<u32>,
     ) -> Result<()> {
         Ok(())
     }
@@ -273,7 +279,7 @@ pub trait Script {
         _move: ExecutingMove,
         _target: Pokemon,
         _hit: u8,
-        _damage: &mut u32,
+        _damage: &mut Saturating<u32>,
     ) -> Result<()> {
         Ok(())
     }
@@ -283,7 +289,7 @@ pub trait Script {
         _move: ExecutingMove,
         _target: Pokemon,
         _hit: u8,
-        _damage: &mut u32,
+        _damage: &mut Saturating<u32>,
     ) -> Result<()> {
         Ok(())
     }
@@ -428,7 +434,7 @@ pub trait Script {
         &self,
         _fainted_mon: Pokemon,
         _winning_mon: Pokemon,
-        _amount: &mut u32,
+        _amount: &mut Saturating<u32>,
     ) -> Result<()> {
         Ok(())
     }
@@ -454,7 +460,7 @@ pub trait Script {
         &self,
         _target: Pokemon,
         _pokeball: Item,
-        _modifier: &mut u8,
+        _modifier: &mut Saturating<u8>,
     ) -> Result<()> {
         Ok(())
     }

pkmn_lib_interface/src/lib.rs

@@ -13,6 +13,7 @@
 #![feature(build_hasher_simple_hash_one)]
 #![feature(adt_const_params)]
 #![feature(try_trait_v2)]
+#![feature(saturating_int_impl)]
 #![cfg_attr(not(feature = "mock_data"), no_std)]
 #![allow(incomplete_features)]
 // These give false positives too often
@@ -86,8 +87,8 @@ mod implementation {
     };
 }
 
-    static mut SCRIPT_PTR_CACHE: Option<hashbrown::HashMap<*const dyn Script, u32>> = None;
+    static mut SCRIPT_PTR_CACHE: Option<HashMap<*const dyn Script, u32>> = None;
-    static mut SCRIPT_PTR_REVERSE_CACHE: Option<hashbrown::HashMap<u32, Box<dyn Script>>> = None;
+    static mut SCRIPT_PTR_REVERSE_CACHE: Option<HashMap<u32, Box<dyn Script>>> = None;
     static mut SCRIPT_INDEX_COUNTER: AtomicU32 = AtomicU32::new(1);
 
     #[repr(C)]
@@ -100,7 +101,7 @@ mod implementation {
         fn get_cache<'a>() -> &'a mut HashMap<*const dyn Script, u32> {
             unsafe {
                 if let None = SCRIPT_PTR_CACHE {
-                    SCRIPT_PTR_CACHE = Some(hashbrown::HashMap::new());
+                    SCRIPT_PTR_CACHE = Some(HashMap::new());
                 }
                 let cache = SCRIPT_PTR_CACHE.as_mut().unwrap();
                 cache
@@ -110,7 +111,7 @@ mod implementation {
         fn get_reverse_cache<'a>() -> &'a mut HashMap<u32, Box<dyn Script>> {
             unsafe {
                 if let None = SCRIPT_PTR_REVERSE_CACHE {
-                    SCRIPT_PTR_REVERSE_CACHE = Some(hashbrown::HashMap::new());
+                    SCRIPT_PTR_REVERSE_CACHE = Some(HashMap::new());
                 }
                 let cache = SCRIPT_PTR_REVERSE_CACHE.as_mut().unwrap();
                 cache
@@ -219,7 +220,11 @@ mod implementation {
             choice: ExternRef<TurnChoice>,
             speed: *mut u32,
         ) -> WasmVoidResult {
-        WasmVoidResult::from_res(script.val().unwrap().change_speed(choice.not_null(), speed.as_mut().unwrap()))
+            let out = speed.as_mut().unwrap();
+            let mut out_saturating = core::num::Saturating(*speed);
+            let res = WasmVoidResult::from_res(script.val().unwrap().change_speed(choice.not_null(), &mut out_saturating));
+            *out = out_saturating.0;
+            return res;
         }
 
         fn script_change_priority(
@@ -254,7 +259,11 @@ mod implementation {
             choice: ExternRef<TurnChoice>,
             out: *mut u8,
         ) -> WasmVoidResult {
-        WasmVoidResult::from_res(script.val().unwrap().change_number_of_hits(choice.not_null(), out.as_mut().unwrap()))
+            let out = out.as_mut().unwrap();
+            let mut out_saturating = core::num::Saturating(*out);
+            let res = WasmVoidResult::from_res(script.val().unwrap().change_number_of_hits(choice.not_null(), &mut out_saturating));
+            *out = out_saturating.0;
+            return res;
         }
 
         fn script_prevent_move(
@@ -361,7 +370,11 @@ mod implementation {
             hit: u8,
             out: *mut u8,
         ) -> WasmVoidResult {
-        WasmVoidResult::from_res(script.val().unwrap().change_accuracy(mv.not_null_rc(), target.not_null_rc(), hit, out.as_mut().unwrap()))
+            let out = out.as_mut().unwrap();
+            let mut out_saturating = core::num::Saturating(*out);
+            let res = WasmVoidResult::from_res(script.val().unwrap().change_accuracy(mv.not_null_rc(), target.not_null_rc(), hit, &mut out_saturating));
+            *out = out_saturating.0;
+            return res;
         }
 
         fn script_change_critical_stage(
@@ -371,7 +384,11 @@ mod implementation {
             hit: u8,
             out: *mut u8,
         ) -> WasmVoidResult {
-        WasmVoidResult::from_res(script.val().unwrap().change_critical_stage(mv.not_null_rc(), target.not_null_rc(), hit, out.as_mut().unwrap()))
+            let out = out.as_mut().unwrap();
+            let mut out_saturating = core::num::Saturating(*out);
+            let res = WasmVoidResult::from_res(script.val().unwrap().change_critical_stage(mv.not_null_rc(), target.not_null_rc(), hit, &mut out_saturating));
+            *out = out_saturating.0;
+            return res;
         }
 
         fn script_change_critical_modifier(
@@ -401,7 +418,12 @@ mod implementation {
             hit: u8,
             out: *mut u8,
         ) -> WasmVoidResult {
-        WasmVoidResult::from_res(script.val().unwrap().change_base_power(mv.not_null_rc(), target.not_null_rc(), hit, out.as_mut().unwrap()))
+            let out = out.as_mut().unwrap();
+            let mut out_saturating = core::num::Saturating(*out);
+            let res = WasmVoidResult::from_res(script.val().unwrap().change_base_power(mv.not_null_rc(), target.not_null_rc(), hit,
+                    &mut out_saturating));
+            *out = out_saturating.0;
+            res
         }
 
         fn script_bypass_defensive_stat_boost(
@@ -431,7 +453,11 @@ mod implementation {
             hit: u8,
             out: *mut u32,
         ) -> WasmVoidResult {
-        WasmVoidResult::from_res(script.val().unwrap().change_defensive_stat_value(mv.not_null_rc(), target.not_null_rc(), hit, out.as_mut().unwrap()))
+            let out = out.as_mut().unwrap();
+            let mut out_saturating = core::num::Saturating(*out);
+            let res = WasmVoidResult::from_res(script.val().unwrap().change_defensive_stat_value(mv.not_null_rc(), target.not_null_rc(), hit, &mut out_saturating));
+            *out = out_saturating.0;
+            return res;
         }
 
         fn script_change_offensive_stat_value(
@@ -441,7 +467,11 @@ mod implementation {
             hit: u8,
             out: *mut u32,
         ) -> WasmVoidResult {
-        WasmVoidResult::from_res(script.val().unwrap().change_offensive_stat_value(mv.not_null_rc(), target.not_null_rc(), hit, out.as_mut().unwrap()))
+            let out = out.as_mut().unwrap();
+            let mut out_saturating = core::num::Saturating(*out);
+            let res = WasmVoidResult::from_res(script.val().unwrap().change_offensive_stat_value(mv.not_null_rc(), target.not_null_rc(), hit, &mut out_saturating));
+            *out = out_saturating.0;
+            return res;
         }
 
         fn script_change_damage_stat_modifier(
@@ -471,7 +501,11 @@ mod implementation {
             hit: u8,
             out: *mut u32,
         ) -> WasmVoidResult {
-        WasmVoidResult::from_res(script.val().unwrap().change_damage(mv.not_null_rc(), target.not_null_rc(), hit, out.as_mut().unwrap()))
+            let out = out.as_mut().unwrap();
+            let mut out_saturating = core::num::Saturating(*out);
+            let res = WasmVoidResult::from_res(script.val().unwrap().change_damage(mv.not_null_rc(), target.not_null_rc(), hit, &mut out_saturating));
+            *out = out_saturating.0;
+            return res;
         }
 
         fn script_change_incoming_damage(
@@ -481,7 +515,11 @@ mod implementation {
             hit: u8,
             out: *mut u32,
         ) -> WasmVoidResult {
-        WasmVoidResult::from_res(script.val().unwrap().change_incoming_damage(mv.not_null_rc(), target.not_null_rc(), hit, out.as_mut().unwrap()))
+            let out = out.as_mut().unwrap();
+            let mut out_saturating = core::num::Saturating(*out);
+            let res = WasmVoidResult::from_res(script.val().unwrap().change_incoming_damage(mv.not_null_rc(), target.not_null_rc(), hit, &mut out_saturating));
+            *out = out_saturating.0;
+            return res;
         }
 
         fn script_on_incoming_hit(
@@ -651,11 +689,15 @@ mod implementation {
             winning_pokemon: ExternRef<PokemonImpl>,
             out: *mut u32
         ) -> WasmVoidResult {
-        WasmVoidResult::from_res(script.val().unwrap().change_experience_gained(
+            let out = out.as_mut().unwrap();
+            let mut out_saturating = core::num::Saturating(*out);
+            let res = WasmVoidResult::from_res(script.val().unwrap().change_experience_gained(
                     fainted_pokemon.not_null_rc(),
                     winning_pokemon.not_null_rc(),
-                out.as_mut().unwrap()
+                    &mut out_saturating
-        ))
+            ));
+            *out = out_saturating.0;
+            return res;
         }
 
         fn script_share_experience(
@@ -685,11 +727,15 @@ mod implementation {
             pokeball: ExternRef<ItemImpl>,
             out: *mut u8,
         ) -> WasmVoidResult {
-        WasmVoidResult::from_res(script.val().unwrap().change_capture_rate_bonus(
+            let out = out.as_mut().unwrap();
+            let mut out_saturating = core::num::Saturating(*out);
+            let res = WasmVoidResult::from_res(script.val().unwrap().change_capture_rate_bonus(
                     target.not_null_rc(),
                     pokeball.not_null_rc(),
-                out.as_mut().unwrap()
+                    &mut out_saturating
-        ))
+            ));
+            *out = out_saturating.0;
+            return res;
         }
     }
 }