A bunch more work on replacing every potential panic with results
continuous-integration/drone/push Build is passing Details

This commit is contained in:
Deukhoofd 2023-04-16 19:57:21 +02:00
parent 1b8403ecda
commit 00d596d656
Signed by: Deukhoofd
GPG Key ID: F63E044490819F6F
37 changed files with 526 additions and 300 deletions

View File

@ -1,7 +1,7 @@
use crate::dynamic_data::choices::TurnChoice; use crate::dynamic_data::choices::TurnChoice;
use crate::dynamic_data::script_handling::ScriptSource; use crate::dynamic_data::script_handling::ScriptSource;
use crate::dynamic_data::Pokemon; use crate::dynamic_data::Pokemon;
use crate::{script_hook, PkmnError, ValueIdentifiable, ValueIdentifier}; use crate::{script_hook, PkmnError, ValueIdentifiable, ValueIdentifier, VecExt};
use anyhow::Result; use anyhow::Result;
use anyhow_ext::anyhow; use anyhow_ext::anyhow;
use parking_lot::lock_api::MappedRwLockReadGuard; use parking_lot::lock_api::MappedRwLockReadGuard;
@ -81,9 +81,7 @@ impl ChoiceQueue {
let len = self.queue.read().len(); let len = self.queue.read().len();
let mut write_lock = self.queue.write(); let mut write_lock = self.queue.write();
for index in self.current..len { for index in self.current..len {
let choice = &mut write_lock let choice = &mut write_lock.get_mut_res(index)?;
.get_mut(index)
.ok_or(PkmnError::IndexOutOfBounds { index, len })?;
if let Some(choice) = choice { if let Some(choice) = choice {
let mut speed = choice.user().boosted_stats().speed(); let mut speed = choice.user().boosted_stats().speed();
script_hook!(change_speed, (*choice), choice, &mut speed); script_hook!(change_speed, (*choice), choice, &mut speed);
@ -121,14 +119,9 @@ impl ChoiceQueue {
return Ok(true); return Ok(true);
} }
let len = queue_lock.len();
// Take the choice we want to move forward out of it's place. // Take the choice we want to move forward out of it's place.
let choice = queue_lock let choice = queue_lock
.get_mut(desired_index) .get_mut_res(desired_index)?
.ok_or(PkmnError::IndexOutOfBounds {
index: self.current,
len,
})?
.take() .take()
.ok_or(anyhow!("Choice was already taken"))?; .ok_or(anyhow!("Choice was already taken"))?;
// Iterate backwards from the spot before the choice we want to move up, push them all back // Iterate backwards from the spot before the choice we want to move up, push them all back
@ -136,15 +129,8 @@ impl ChoiceQueue {
for index in (self.current..desired_index).rev() { for index in (self.current..desired_index).rev() {
queue_lock.swap(index, index + 1); queue_lock.swap(index, index + 1);
} }
let len = queue_lock.len();
// Place the choice that needs to be next in the next to be executed position. // Place the choice that needs to be next in the next to be executed position.
let _ = queue_lock let _ = queue_lock.get_mut_res(self.current)?.insert(choice);
.get_mut(self.current)
.ok_or(PkmnError::IndexOutOfBounds {
index: self.current,
len,
})?
.insert(choice);
true true
} }
None => false, None => false,
@ -173,13 +159,13 @@ impl ValueIdentifiable for ChoiceQueue {
} }
#[cfg(test)] #[cfg(test)]
#[allow(clippy::unwrap_used)]
mod tests { mod tests {
use super::*; use super::*;
use crate::defines::LevelInt; use crate::defines::LevelInt;
use crate::dynamic_data::{DynamicLibrary, PassChoice}; use crate::dynamic_data::{DynamicLibrary, PassChoice};
use crate::static_data::{AbilityIndex, Gender}; use crate::static_data::{AbilityIndex, Gender};
use std::sync::Arc; use std::sync::Arc;
#[test] #[test]
fn create_empty_queue() { fn create_empty_queue() {
let queue = ChoiceQueue::new(Vec::new()); let queue = ChoiceQueue::new(Vec::new());

View File

@ -7,9 +7,9 @@ use num_traits::abs;
use crate::dynamic_data::Battle; use crate::dynamic_data::Battle;
use crate::dynamic_data::Pokemon; use crate::dynamic_data::Pokemon;
use crate::static_data::MoveTarget; use crate::static_data::MoveTarget;
use crate::PkmnError; use crate::VecExt;
/// Helper type for the vector of targets we will return. /// Helper type for the vector of targ ets we will return.
pub type TargetList = Vec<Option<Arc<Pokemon>>>; pub type TargetList = Vec<Option<Arc<Pokemon>>>;
/// This returns all Pokemon in the battle. /// This returns all Pokemon in the battle.
@ -127,16 +127,7 @@ pub fn resolve_targets(side: u8, index: u8, target: MoveTarget, battle: &Battle)
// the client deal with what side is passed. // the client deal with what side is passed.
MoveTarget::AllAlly | MoveTarget::AllOpponent => { MoveTarget::AllAlly | MoveTarget::AllOpponent => {
let mut v = Vec::new(); let mut v = Vec::new();
for pokemon in battle for pokemon in battle.sides().get_res(side as usize)?.pokemon().deref() {
.sides()
.get(side as usize)
.ok_or(PkmnError::IndexOutOfBounds {
index: side as usize,
len: battle.sides().len(),
})?
.pokemon()
.deref()
{
v.push(pokemon.as_ref().cloned()); v.push(pokemon.as_ref().cloned());
} }
v v

View File

@ -20,7 +20,7 @@ use crate::dynamic_data::VolatileScriptsOwner;
use crate::dynamic_data::{is_valid_target, ScriptWrapper}; use crate::dynamic_data::{is_valid_target, ScriptWrapper};
use crate::dynamic_data::{ChoiceQueue, ScriptContainer}; use crate::dynamic_data::{ChoiceQueue, ScriptContainer};
use crate::dynamic_data::{ScriptCategory, ScriptSource, ScriptSourceData}; use crate::dynamic_data::{ScriptCategory, ScriptSource, ScriptSourceData};
use crate::{script_hook, PkmnError, StringKey, ValueIdentifiable, ValueIdentifier}; use crate::{script_hook, PkmnError, StringKey, ValueIdentifiable, ValueIdentifier, VecExt};
/// A pokemon battle, with any amount of sides and pokemon per side. /// A pokemon battle, with any amount of sides and pokemon per side.
#[derive(Debug)] #[derive(Debug)]
@ -271,13 +271,7 @@ impl Battle {
let side = choice.user().get_battle_side_index(); let side = choice.user().get_battle_side_index();
match side { match side {
Some(side) => { Some(side) => {
self.sides self.sides.get_res(side as usize)?.set_choice(choice)?;
.get(side as usize)
.ok_or(PkmnError::IndexOutOfBounds {
index: side as usize,
len: self.sides.len(),
})?
.set_choice(choice)?;
self.check_choices_set_and_run()?; self.check_choices_set_and_run()?;
Ok(true) Ok(true)
} }

View File

@ -1,3 +1,4 @@
use anyhow::Result;
use std::sync::Arc; use std::sync::Arc;
use crate::dynamic_data::models::pokemon::Pokemon; use crate::dynamic_data::models::pokemon::Pokemon;
@ -19,12 +20,12 @@ pub struct BattleParty {
impl BattleParty { impl BattleParty {
/// Initializes a battle party with the underlying party, and the indices the party is responsible /// Initializes a battle party with the underlying party, and the indices the party is responsible
/// for. /// for.
pub fn new(party: Arc<PokemonParty>, responsible_indices: Vec<(u8, u8)>) -> Self { pub fn new(party: Arc<PokemonParty>, responsible_indices: Vec<(u8, u8)>) -> Result<Self> {
Self { Ok(Self {
identifier: Default::default(), identifier: Default::default(),
party, party,
responsible_indices, responsible_indices,
} })
} }
/// Checks whether the party is responsible for the given index. /// Checks whether the party is responsible for the given index.

View File

@ -14,7 +14,7 @@ use crate::dynamic_data::script_handling::{ScriptSource, ScriptSourceData, Scrip
use crate::dynamic_data::Script; use crate::dynamic_data::Script;
use crate::dynamic_data::ScriptSet; use crate::dynamic_data::ScriptSet;
use crate::dynamic_data::VolatileScriptsOwner; use crate::dynamic_data::VolatileScriptsOwner;
use crate::{script_hook, PkmnError, StringKey, ValueIdentifiable, ValueIdentifier}; use crate::{script_hook, StringKey, ValueIdentifiable, ValueIdentifier, VecExt};
/// A side on a battle. /// A side on a battle.
#[derive(Debug)] #[derive(Debug)]
@ -149,12 +149,7 @@ impl BattleSide {
for (index, pokemon_slot) in self.pokemon.read().iter().enumerate() { for (index, pokemon_slot) in self.pokemon.read().iter().enumerate() {
if let Some(pokemon) = pokemon_slot { if let Some(pokemon) = pokemon_slot {
if std::ptr::eq(pokemon.deref(), choice.user().deref()) { if std::ptr::eq(pokemon.deref(), choice.user().deref()) {
let len = self.choices.read().len(); self.choices.write().get_mut_res(index)?.replace(choice);
self.choices
.write()
.get_mut(index)
.ok_or(PkmnError::IndexOutOfBounds { index, len })?
.replace(choice);
self.choices_set.fetch_add(1, Ordering::SeqCst); self.choices_set.fetch_add(1, Ordering::SeqCst);
return Ok(()); return Ok(());
} }
@ -180,10 +175,7 @@ impl BattleSide {
pub fn set_pokemon(&self, index: u8, pokemon: Option<Arc<Pokemon>>) -> Result<()> { pub fn set_pokemon(&self, index: u8, pokemon: Option<Arc<Pokemon>>) -> Result<()> {
{ {
let mut write_lock = self.pokemon.write(); let mut write_lock = self.pokemon.write();
let old = write_lock.get_mut(index as usize).ok_or(PkmnError::IndexOutOfBounds { let old = write_lock.get_mut_res(index as usize)?;
index: index as usize,
len: self.pokemon_per_side as usize,
})?;
let old = match pokemon { let old = match pokemon {
Some(pokemon) => old.replace(pokemon), Some(pokemon) => old.replace(pokemon),
None => old.take(), None => old.take(),
@ -193,23 +185,17 @@ impl BattleSide {
// side again. // side again.
drop(write_lock); drop(write_lock);
script_hook!(on_remove, old_pokemon,); script_hook!(on_remove, old_pokemon,);
old_pokemon.set_on_battlefield(false); old_pokemon.set_on_battlefield(false)?;
} }
} }
let pokemon = { let pokemon = {
let read_lock = self.pokemon.read(); let read_lock = self.pokemon.read();
&read_lock &read_lock.get_res(index as usize)?.clone()
.get(index as usize)
.ok_or(PkmnError::IndexOutOfBounds {
index: index as usize,
len: read_lock.len(),
})?
.clone()
}; };
if let Some(pokemon) = pokemon { if let Some(pokemon) = pokemon {
pokemon.set_battle_data(self.battle, self.index); pokemon.set_battle_data(self.battle, self.index);
pokemon.set_on_battlefield(true); pokemon.set_on_battlefield(true)?;
pokemon.set_battle_index(index); pokemon.set_battle_index(index);
let battle = self.battle()?; let battle = self.battle()?;
@ -252,11 +238,7 @@ impl BattleSide {
/// If this happens, the slot can not be used again. /// If this happens, the slot can not be used again.
pub(crate) fn mark_slot_as_unfillable(&self, index: u8) -> Result<()> { pub(crate) fn mark_slot_as_unfillable(&self, index: u8) -> Result<()> {
self.fillable_slots self.fillable_slots
.get(index as usize) .get_res(index as usize)?
.ok_or(PkmnError::IndexOutOfBounds {
index: index as usize,
len: self.fillable_slots.len(),
})?
.store(false, Ordering::SeqCst); .store(false, Ordering::SeqCst);
Ok(()) Ok(())
} }
@ -266,14 +248,7 @@ impl BattleSide {
for (i, slot) in self.pokemon.read().iter().enumerate() { for (i, slot) in self.pokemon.read().iter().enumerate() {
if let Some(p) = slot { if let Some(p) = slot {
if std::ptr::eq(p.deref().deref(), pokemon.deref()) { if std::ptr::eq(p.deref().deref(), pokemon.deref()) {
return Ok(self return Ok(self.fillable_slots.get_res(i)?.load(Ordering::Relaxed));
.fillable_slots
.get(i)
.ok_or(PkmnError::IndexOutOfBounds {
index: i,
len: self.fillable_slots.len(),
})?
.load(Ordering::Relaxed));
} }
} }
} }

View File

@ -22,7 +22,7 @@ use crate::static_data::TypeIdentifier;
use crate::static_data::{Ability, Statistic}; use crate::static_data::{Ability, Statistic};
use crate::static_data::{ClampedStatisticSet, StatisticSet}; use crate::static_data::{ClampedStatisticSet, StatisticSet};
use crate::utils::Random; use crate::utils::Random;
use crate::{script_hook, PkmnError, StringKey, ValueIdentifiable, ValueIdentifier}; use crate::{script_hook, PkmnError, StringKey, ValueIdentifiable, ValueIdentifier, VecExt};
use anyhow::{anyhow, bail, Result}; use anyhow::{anyhow, bail, Result};
/// An individual Pokemon as we know and love them. /// An individual Pokemon as we know and love them.
@ -595,16 +595,17 @@ impl Pokemon {
} }
/// Sets whether or not the Pokemon is on the battlefield. /// Sets whether or not the Pokemon is on the battlefield.
pub fn set_on_battlefield(&self, value: bool) { pub fn set_on_battlefield(&self, value: bool) -> Result<()> {
let r = self.battle_data.read(); let r = self.battle_data.read();
if let Some(data) = &mut r.deref() { if let Some(data) = &mut r.deref() {
data.on_battle_field.store(value, Ordering::SeqCst); data.on_battle_field.store(value, Ordering::SeqCst);
if !value { if !value {
self.volatile.clear(); self.volatile.clear()?;
self.weight.store(self.form().weight(), Ordering::SeqCst); self.weight.store(self.form().weight(), Ordering::SeqCst);
self.height.store(self.form().height(), Ordering::SeqCst); self.height.store(self.form().height(), Ordering::SeqCst);
} }
} }
Ok(())
} }
/// Sets the index of the slot of the side the Pokemon is on. /// Sets the index of the slot of the side the Pokemon is on.
@ -676,11 +677,7 @@ impl Pokemon {
if !battle.can_slot_be_filled(battle_data.battle_side_index(), battle_data.index()) { if !battle.can_slot_be_filled(battle_data.battle_side_index(), battle_data.index()) {
battle battle
.sides() .sides()
.get(battle_data.battle_side_index() as usize) .get_res(battle_data.battle_side_index() as usize)?
.ok_or(PkmnError::IndexOutOfBounds {
index: battle_data.battle_side_index() as usize,
len: battle.sides().len(),
})?
.mark_slot_as_unfillable(battle_data.index())?; .mark_slot_as_unfillable(battle_data.index())?;
} }
@ -721,9 +718,12 @@ impl Pokemon {
pub fn learn_move(&self, move_name: &StringKey, learn_method: MoveLearnMethod) -> Result<()> { pub fn learn_move(&self, move_name: &StringKey, learn_method: MoveLearnMethod) -> Result<()> {
let mut learned_moves = self.learned_moves().write(); let mut learned_moves = self.learned_moves().write();
let move_pos = learned_moves.iter().position(|a| a.is_none()); let move_pos = learned_moves.iter().position(|a| a.is_none());
if move_pos.is_none() { let move_pos = match move_pos {
bail!("No more moves with an empty space found."); Some(a) => a,
} None => {
bail!("No more moves with an empty space found.");
}
};
let move_data = self let move_data = self
.library .library
.static_data() .static_data()
@ -732,7 +732,9 @@ impl Pokemon {
.ok_or(PkmnError::InvalidMoveName { .ok_or(PkmnError::InvalidMoveName {
move_name: move_name.clone(), move_name: move_name.clone(),
})?; })?;
learned_moves[move_pos.unwrap()] = Some(Arc::new(LearnedMove::new(move_data, learn_method))); learned_moves
.get_mut_res(move_pos)?
.replace(Arc::new(LearnedMove::new(move_data, learn_method)));
Ok(()) Ok(())
} }
@ -805,7 +807,10 @@ impl ScriptSource for Pokemon {
let mut c = 3; let mut c = 3;
if let Some(battle_data) = &self.battle_data.read().deref() { if let Some(battle_data) = &self.battle_data.read().deref() {
if let Some(battle) = battle_data.battle() { if let Some(battle) = battle_data.battle() {
c += battle.sides()[battle_data.battle_side_index() as usize].get_script_count()?; c += battle
.sides()
.get_res(battle_data.battle_side_index() as usize)?
.get_script_count()?;
} }
} }
Ok(c) Ok(c)
@ -826,7 +831,10 @@ impl ScriptSource for Pokemon {
self.get_own_scripts(scripts); self.get_own_scripts(scripts);
if let Some(battle_data) = &self.battle_data.read().deref() { if let Some(battle_data) = &self.battle_data.read().deref() {
if let Some(battle) = battle_data.battle() { if let Some(battle) = battle_data.battle() {
battle.sides()[battle_data.battle_side_index() as usize].collect_scripts(scripts)?; battle
.sides()
.get_res(battle_data.battle_side_index() as usize)?
.collect_scripts(scripts)?;
} }
} }
Ok(()) Ok(())
@ -862,6 +870,7 @@ pub enum DamageSource {
} }
#[cfg(test)] #[cfg(test)]
#[allow(clippy::unwrap_used)]
pub mod test { pub mod test {
use crate::dynamic_data::libraries::test::MockDynamicLibrary; use crate::dynamic_data::libraries::test::MockDynamicLibrary;
use crate::dynamic_data::models::pokemon::Pokemon; use crate::dynamic_data::models::pokemon::Pokemon;

View File

@ -5,7 +5,7 @@ use crate::dynamic_data::models::learned_move::MoveLearnMethod;
use crate::dynamic_data::models::pokemon::Pokemon; use crate::dynamic_data::models::pokemon::Pokemon;
use crate::dynamic_data::DynamicLibrary; use crate::dynamic_data::DynamicLibrary;
use crate::static_data::{AbilityIndex, Gender}; use crate::static_data::{AbilityIndex, Gender};
use crate::{Random, StringKey}; use crate::{PkmnError, Random, StringKey};
use anyhow::Result; use anyhow::Result;
/// This allows for the easy chain building of a Pokemon. /// This allows for the easy chain building of a Pokemon.
@ -47,7 +47,12 @@ impl PokemonBuilder {
Random::default() Random::default()
}; };
let species = self.library.static_data().species().get(&self.species).unwrap(); let species = self
.library
.static_data()
.species()
.get(&self.species)
.ok_or(PkmnError::InvalidSpeciesName { species: self.species })?;
let form = species.get_default_form(); let form = species.get_default_form();
let p = Pokemon::new( let p = Pokemon::new(
self.library, self.library,

View File

@ -1,9 +1,10 @@
use anyhow::Result;
use parking_lot::lock_api::RwLockReadGuard; use parking_lot::lock_api::RwLockReadGuard;
use parking_lot::{RawRwLock, RwLock}; use parking_lot::{RawRwLock, RwLock};
use std::sync::Arc; use std::sync::Arc;
use crate::dynamic_data::models::pokemon::Pokemon; use crate::dynamic_data::models::pokemon::Pokemon;
use crate::{ValueIdentifiable, ValueIdentifier}; use crate::{ValueIdentifiable, ValueIdentifier, VecExt};
/// A list of Pokemon belonging to a trainer. /// A list of Pokemon belonging to a trainer.
#[derive(Debug)] #[derive(Debug)]
@ -52,14 +53,17 @@ impl PokemonParty {
} }
/// Sets the Pokemon at an index to a Pokemon, returning the old Pokemon. /// Sets the Pokemon at an index to a Pokemon, returning the old Pokemon.
pub fn swap_into(&self, index: usize, pokemon: Option<Arc<Pokemon>>) -> Option<Arc<Pokemon>> { pub fn swap_into(&self, index: usize, pokemon: Option<Arc<Pokemon>>) -> Result<Option<Arc<Pokemon>>> {
let mut party = self.pokemon.write(); let mut party = self.pokemon.write();
if index >= party.len() { if index >= party.len() {
return pokemon; return Ok(pokemon);
} }
let old = party[index].as_ref().cloned(); let value = party.get_mut_res(index)?;
party[index] = pokemon; let old = match pokemon {
old Some(p) => value.replace(p),
None => value.take(),
};
Ok(old)
} }
/// Whether or not the party still has Pokemon that can be used in battle. /// Whether or not the party still has Pokemon that can be used in battle.
@ -83,18 +87,18 @@ impl PokemonParty {
} }
/// Makes sure there are no empty spots in the party anymore, leaving the length the same. /// Makes sure there are no empty spots in the party anymore, leaving the length the same.
pub fn pack_party(&self) { pub fn pack_party(&self) -> Result<()> {
let mut first_empty = None; let mut first_empty = None;
let mut i = 0; let mut i = 0;
let mut party = self.pokemon.write(); let mut party = self.pokemon.write();
loop { loop {
if party[i].is_none() { if party.get_res(i)?.is_none() {
if first_empty.is_none() { if first_empty.is_none() {
first_empty = Some(i) first_empty = Some(i)
} }
} else if first_empty.is_some() { } else if let Some(f) = first_empty {
party.swap(first_empty.unwrap(), i); party.swap(f, i);
i = first_empty.unwrap(); i = f;
first_empty = None; first_empty = None;
} }
i += 1; i += 1;
@ -102,6 +106,7 @@ impl PokemonParty {
break; break;
} }
} }
Ok(())
} }
/// Checks if the party contains a given pokemon. /// Checks if the party contains a given pokemon.

View File

@ -1,8 +1,9 @@
use anyhow::Result; use anyhow::{anyhow, Result};
use std::sync::{Arc, Weak}; use std::sync::{Arc, Weak};
use parking_lot::RwLock; use parking_lot::RwLock;
use crate::VecExt;
#[doc(inline)] #[doc(inline)]
pub use item_script::*; pub use item_script::*;
#[doc(inline)] #[doc(inline)]
@ -27,7 +28,7 @@ mod volatile_scripts_owner;
macro_rules! script_hook { macro_rules! script_hook {
($hook_name: ident, $source: expr, $($parameters: expr),*) => { ($hook_name: ident, $source: expr, $($parameters: expr),*) => {
let mut aggregator = $source.get_script_iterator()?; let mut aggregator = $source.get_script_iterator()?;
while let Some(script_container) = aggregator.get_next() { while let Some(script_container) = aggregator.get_next()? {
let script = script_container.get(); let script = script_container.get();
if let Some(script) = script { if let Some(script) = script {
if let Some(script) = script.read().as_deref() { if let Some(script) = script.read().as_deref() {
@ -157,16 +158,16 @@ impl ScriptIterator {
} }
/// Move to the next valid value in the scripts. /// Move to the next valid value in the scripts.
fn increment_to_next_value(&mut self) -> bool { fn increment_to_next_value(&mut self) -> Result<bool> {
if self.index != -1 { if self.index != -1 {
let wrapper = unsafe { &(*self.scripts)[self.index as usize] }; let wrapper = unsafe { &(*self.scripts).get_res(self.index as usize)? };
if let ScriptWrapper::Set(set) = wrapper { if let ScriptWrapper::Set(set) = wrapper {
if let Some(set) = set.upgrade() { if let Some(set) = set.upgrade() {
self.set_index += 1; self.set_index += 1;
if self.set_index as usize >= set.count() { if self.set_index as usize >= set.count() {
self.set_index = -1; self.set_index = -1;
} else { } else {
return true; return Ok(true);
} }
} }
} }
@ -175,41 +176,61 @@ impl ScriptIterator {
let len = (unsafe { &*self.scripts }).len() as i32; let len = (unsafe { &*self.scripts }).len() as i32;
for index in self.index..len { for index in self.index..len {
self.index = index; self.index = index;
let wrapper = unsafe { &self.scripts.as_ref().unwrap()[self.index as usize] }; let wrapper = unsafe {
&self
.scripts
.as_ref()
.ok_or(anyhow!("ScriptIterator scripts pointer is null"))?
.get_res(self.index as usize)?
};
if let ScriptWrapper::Set(s) = wrapper { if let ScriptWrapper::Set(s) = wrapper {
if let Some(set) = s.upgrade() { if let Some(set) = s.upgrade() {
if set.count() > 0 { if set.count() > 0 {
self.set_index = 0; self.set_index = 0;
return true; return Ok(true);
} }
} }
} else if let ScriptWrapper::Script(script) = wrapper { } else if let ScriptWrapper::Script(script) = wrapper {
if let Some(v) = script.upgrade() { if let Some(v) = script.upgrade() {
if let Some(..) = v.read().as_ref() { if let Some(..) = v.read().as_ref() {
return true; return Ok(true);
} }
} }
} }
} }
false Ok(false)
} }
/// Gets the next valid script. If none is found, returns None. /// Gets the next valid script. If none is found, returns None.
pub fn get_next(&mut self) -> Option<ScriptContainer> { pub fn get_next(&mut self) -> Result<Option<ScriptContainer>> {
if !self.increment_to_next_value() { if !self.increment_to_next_value()? {
return None; return Ok(None);
} }
unsafe { unsafe {
return match &self.scripts.as_ref().unwrap()[self.index as usize] { Ok(
// increment_to_next_value match &self
ScriptWrapper::Script(script) => Some(script.upgrade().unwrap().into()), .scripts
ScriptWrapper::Set(set) => { .as_ref()
let set = set.upgrade().unwrap(); .ok_or(anyhow!("ScriptIterator scripts pointer is null"))?
let sc = set.at(self.set_index as usize); .get_res(self.index as usize)?
return Some(sc); {
} // increment_to_next_value
}; ScriptWrapper::Script(script) => Some(
script
.upgrade()
.ok_or(anyhow!("Couldn't get a strong reference to a script"))?
.into(),
),
ScriptWrapper::Set(set) => {
let set = set
.upgrade()
.ok_or(anyhow!("Couldn't get a strong reference to a set"))?;
let sc = set.at(self.set_index as usize)?;
return Ok(Some(sc));
}
},
)
} }
} }
@ -221,6 +242,7 @@ impl ScriptIterator {
} }
#[cfg(test)] #[cfg(test)]
#[allow(clippy::unwrap_used)]
mod tests { mod tests {
use std::any::Any; use std::any::Any;
use std::sync::atomic::{AtomicBool, AtomicUsize, Ordering}; use std::sync::atomic::{AtomicBool, AtomicUsize, Ordering};
@ -291,10 +313,10 @@ mod tests {
let script = ScriptContainer::new(Arc::new(TestScript::new())); let script = ScriptContainer::new(Arc::new(TestScript::new()));
let scripts = vec![ScriptWrapper::from(&script)]; let scripts = vec![ScriptWrapper::from(&script)];
let mut aggregator = ScriptIterator::new(&scripts as *const Vec<ScriptWrapper>); let mut aggregator = ScriptIterator::new(&scripts as *const Vec<ScriptWrapper>);
while let Some(v) = aggregator.get_next() { while let Some(v) = aggregator.get_next().unwrap() {
v.get().unwrap().read().as_ref().unwrap().stack(); v.get().unwrap().read().as_ref().unwrap().stack();
} }
let a = script.get_as::<TestScript>(); let a = script.get_as::<TestScript>().unwrap();
assert_eq!(a.test_count.load(Ordering::Relaxed), 1); assert_eq!(a.test_count.load(Ordering::Relaxed), 1);
} }
@ -305,10 +327,10 @@ mod tests {
let mut aggregator = ScriptIterator::new(&scripts as *const Vec<ScriptWrapper>); let mut aggregator = ScriptIterator::new(&scripts as *const Vec<ScriptWrapper>);
for i in 1..11 { for i in 1..11 {
aggregator.reset(); aggregator.reset();
while let Some(v) = aggregator.get_next() { while let Some(v) = aggregator.get_next().unwrap() {
v.get().unwrap().read().as_ref().unwrap().stack(); v.get().unwrap().read().as_ref().unwrap().stack();
} }
let a = script.get_as::<TestScript>(); let a = script.get_as::<TestScript>().unwrap();
assert_eq!(a.test_count.load(Ordering::Relaxed), i); assert_eq!(a.test_count.load(Ordering::Relaxed), i);
} }
} }
@ -324,14 +346,14 @@ mod tests {
ScriptWrapper::from(&script3), ScriptWrapper::from(&script3),
]; ];
let mut aggregator = ScriptIterator::new(&scripts as *const Vec<ScriptWrapper>); let mut aggregator = ScriptIterator::new(&scripts as *const Vec<ScriptWrapper>);
while let Some(v) = aggregator.get_next() { while let Some(v) = aggregator.get_next().unwrap() {
v.get().unwrap().read().as_ref().unwrap().stack(); v.get().unwrap().read().as_ref().unwrap().stack();
} }
let a = script1.get_as::<TestScript>(); let a = script1.get_as::<TestScript>().unwrap();
assert_eq!(a.test_count.load(Ordering::Relaxed), 1); assert_eq!(a.test_count.load(Ordering::Relaxed), 1);
let a = script2.get_as::<TestScript>(); let a = script2.get_as::<TestScript>().unwrap();
assert_eq!(a.test_count.load(Ordering::Relaxed), 1); assert_eq!(a.test_count.load(Ordering::Relaxed), 1);
let a = script3.get_as::<TestScript>(); let a = script3.get_as::<TestScript>().unwrap();
assert_eq!(a.test_count.load(Ordering::Relaxed), 1); assert_eq!(a.test_count.load(Ordering::Relaxed), 1);
} }
@ -348,14 +370,14 @@ mod tests {
let mut aggregator = ScriptIterator::new(&scripts as *const Vec<ScriptWrapper>); let mut aggregator = ScriptIterator::new(&scripts as *const Vec<ScriptWrapper>);
for i in 1..11 { for i in 1..11 {
aggregator.reset(); aggregator.reset();
while let Some(v) = aggregator.get_next() { while let Some(v) = aggregator.get_next().unwrap() {
v.get().unwrap().read().as_ref().unwrap().stack(); v.get().unwrap().read().as_ref().unwrap().stack();
} }
let a = script1.get_as::<TestScript>(); let a = script1.get_as::<TestScript>().unwrap();
assert_eq!(a.test_count.load(Ordering::Relaxed), i); assert_eq!(a.test_count.load(Ordering::Relaxed), i);
let a = script2.get_as::<TestScript>(); let a = script2.get_as::<TestScript>().unwrap();
assert_eq!(a.test_count.load(Ordering::Relaxed), i); assert_eq!(a.test_count.load(Ordering::Relaxed), i);
let a = script3.get_as::<TestScript>(); let a = script3.get_as::<TestScript>().unwrap();
assert_eq!(a.test_count.load(Ordering::Relaxed), i); assert_eq!(a.test_count.load(Ordering::Relaxed), i);
} }
} }
@ -371,19 +393,19 @@ mod tests {
let mut aggregator = ScriptIterator::new(&scripts as *const Vec<ScriptWrapper>); let mut aggregator = ScriptIterator::new(&scripts as *const Vec<ScriptWrapper>);
for i in 1..11 { for i in 1..11 {
aggregator.reset(); aggregator.reset();
while let Some(v) = aggregator.get_next() { while let Some(v) = aggregator.get_next().unwrap() {
v.get().unwrap().read().as_ref().unwrap().stack(); v.get().unwrap().read().as_ref().unwrap().stack();
} }
let s = set.at(0); let s = set.at(0).unwrap();
let s = s.get_as::<TestScript>(); let s = s.get_as::<TestScript>().unwrap();
assert_eq!(s.test_count.load(Ordering::Relaxed), i); assert_eq!(s.test_count.load(Ordering::Relaxed), i);
assert_eq!(s.name().str(), "test_a"); assert_eq!(s.name().str(), "test_a");
let s = set.at(1); let s = set.at(1).unwrap();
let s = s.get_as::<TestScript>(); let s = s.get_as::<TestScript>().unwrap();
assert_eq!(s.test_count.load(Ordering::Relaxed), i); assert_eq!(s.test_count.load(Ordering::Relaxed), i);
assert_eq!(s.name().str(), "test_b"); assert_eq!(s.name().str(), "test_b");
let s = set.at(2); let s = set.at(2).unwrap();
let s = s.get_as::<TestScript>(); let s = s.get_as::<TestScript>().unwrap();
assert_eq!(s.test_count.load(Ordering::Relaxed), i); assert_eq!(s.test_count.load(Ordering::Relaxed), i);
assert_eq!(s.name().str(), "test_c"); assert_eq!(s.name().str(), "test_c");
} }
@ -402,6 +424,7 @@ mod tests {
aggregator aggregator
.get_next() .get_next()
.unwrap() .unwrap()
.unwrap()
.get() .get()
.unwrap() .unwrap()
.read() .read()
@ -415,6 +438,7 @@ mod tests {
aggregator aggregator
.get_next() .get_next()
.unwrap() .unwrap()
.unwrap()
.get() .get()
.unwrap() .unwrap()
.read() .read()
@ -425,8 +449,8 @@ mod tests {
"test_b" "test_b"
); );
set.remove(&"test_c".into()); set.remove(&"test_c".into()).unwrap();
assert!(aggregator.get_next().is_none()); assert!(aggregator.get_next().unwrap().is_none());
} }
#[test] #[test]
@ -442,6 +466,7 @@ mod tests {
aggregator aggregator
.get_next() .get_next()
.unwrap() .unwrap()
.unwrap()
.get() .get()
.unwrap() .unwrap()
.read() .read()
@ -452,12 +477,13 @@ mod tests {
"test_a" "test_a"
); );
set.remove(&"test_b".into()); set.remove(&"test_b".into()).unwrap();
assert_eq!( assert_eq!(
aggregator aggregator
.get_next() .get_next()
.unwrap() .unwrap()
.unwrap()
.get() .get()
.unwrap() .unwrap()
.read() .read()
@ -467,7 +493,7 @@ mod tests {
.str(), .str(),
"test_c" "test_c"
); );
assert!(aggregator.get_next().is_none()); assert!(aggregator.get_next().unwrap().is_none());
} }
pub struct TestScriptSource { pub struct TestScriptSource {
@ -503,10 +529,10 @@ mod tests {
let mut aggregator = source.get_script_iterator().unwrap(); let mut aggregator = source.get_script_iterator().unwrap();
aggregator.reset(); aggregator.reset();
assert!(aggregator.get_next().is_none()); assert!(aggregator.get_next().unwrap().is_none());
aggregator.reset(); aggregator.reset();
source.script.set(Arc::new(TestScript::new())); source.script.set(Arc::new(TestScript::new()));
assert!(aggregator.get_next().is_some()); assert!(aggregator.get_next().unwrap().is_some());
} }
#[test] #[test]
@ -518,9 +544,9 @@ mod tests {
let mut aggregator = source.get_script_iterator().unwrap(); let mut aggregator = source.get_script_iterator().unwrap();
source.script.set(Arc::new(TestScript::new())); source.script.set(Arc::new(TestScript::new()));
assert!(aggregator.get_next().is_some()); assert!(aggregator.get_next().unwrap().is_some());
aggregator.reset(); aggregator.reset();
source.script.clear(); source.script.clear();
assert!(aggregator.get_next().is_none()); assert!(aggregator.get_next().unwrap().is_none());
} }
} }

View File

@ -1,3 +1,4 @@
use anyhow::{anyhow, Result};
use std::any::Any; use std::any::Any;
use std::fmt::{Debug, Formatter}; use std::fmt::{Debug, Formatter};
use std::ops::Deref; use std::ops::Deref;
@ -355,12 +356,16 @@ impl ScriptContainer {
} }
/// Get the underlying script as the downcasted value. /// Get the underlying script as the downcasted value.
pub fn get_as<T: 'static>(&self) -> MappedRwLockReadGuard<T> { pub fn get_as<T: 'static>(&self) -> Result<MappedRwLockReadGuard<T>> {
RwLockReadGuard::map(self.script.read(), |a| unsafe { let r = RwLockReadGuard::try_map(self.script.read(), |a| unsafe {
let ptr = a.as_ref().as_ref().unwrap().as_ref() as *const dyn Script; let ptr = a.as_ref().as_ref()?.as_ref() as *const dyn Script;
let any = ptr.as_ref().unwrap().as_any(); let any = ptr.as_ref()?.as_any();
any.downcast_ref::<T>().unwrap() any.downcast_ref::<T>()
}) });
match r {
Ok(a) => Ok(a),
Err(_) => Err(anyhow!("Could not downcast script to requested type")),
}
} }
} }

View File

@ -6,7 +6,7 @@ use indexmap::IndexMap;
use parking_lot::RwLock; use parking_lot::RwLock;
use crate::dynamic_data::script_handling::script::{Script, ScriptContainer}; use crate::dynamic_data::script_handling::script::{Script, ScriptContainer};
use crate::StringKey; use crate::{PkmnError, StringKey};
/// A collection of unique scripts. /// A collection of unique scripts.
#[derive(Debug, Default)] #[derive(Debug, Default)]
@ -29,10 +29,12 @@ impl ScriptSet {
} }
} }
} }
self.scripts
.write() // If the existing script does not exist, or is not a script, we can just add the new one.
.insert(script.name().clone(), ScriptContainer::new(script)); let name = script.name().clone();
self.scripts.read().last().unwrap().1.clone() let container = ScriptContainer::new(script);
self.scripts.write().insert(name, container.clone());
container
} }
/// Adds a script with a name to the set. If the script with that name already exists in this /// Adds a script with a name to the set. If the script with that name already exists in this
@ -54,8 +56,8 @@ impl ScriptSet {
if let Some(script) = script { if let Some(script) = script {
let name = script.name().clone(); let name = script.name().clone();
let arc = ScriptContainer::new(script); let arc = ScriptContainer::new(script);
self.scripts.write().insert(name, arc); self.scripts.write().insert(name, arc.clone());
Ok(Some(self.scripts.read().last().unwrap().1.clone())) Ok(Some(arc))
} else { } else {
Ok(None) Ok(None)
} }
@ -67,27 +69,34 @@ impl ScriptSet {
} }
/// Removes a script from the set using its unique name. /// Removes a script from the set using its unique name.
pub fn remove(&self, key: &StringKey) { pub fn remove(&self, key: &StringKey) -> Result<()> {
let value = self.scripts.write().shift_remove(key); let value = self.scripts.write().shift_remove(key);
if let Some(script) = value { if let Some(script) = value {
if let Some(script) = script.get() { if let Some(script) = script.get() {
let script = script.read(); let script = script.read();
script.as_ref().unwrap().on_remove(); script.as_ref().ok_or(PkmnError::UnableToAcquireLock)?.on_remove();
script.as_ref().unwrap().mark_for_deletion(); script
.as_ref()
.ok_or(PkmnError::UnableToAcquireLock)?
.mark_for_deletion();
} }
} }
Ok(())
} }
/// Clears all scripts from the set. /// Clears all scripts from the set.
pub fn clear(&self) { pub fn clear(&self) -> Result<()> {
for script in self.scripts.read().deref() { for script in self.scripts.read().deref() {
if let Some(script) = script.1.get() { if let Some(script) = script.1.get() {
let script = script.read(); let script = script.read();
script.as_ref().unwrap().on_remove(); if let Some(script) = &*script {
script.as_ref().unwrap().mark_for_deletion(); script.on_remove();
script.mark_for_deletion();
}
} }
} }
self.scripts.write().clear(); self.scripts.write().clear();
Ok(())
} }
/// Checks if the set has a script with the given name. /// Checks if the set has a script with the given name.
@ -96,8 +105,17 @@ impl ScriptSet {
} }
/// Gets a script from the set at a specific index. /// Gets a script from the set at a specific index.
pub fn at(&self, index: usize) -> ScriptContainer { pub fn at(&self, index: usize) -> Result<ScriptContainer> {
self.scripts.read()[index].clone() Ok(self
.scripts
.read()
.get_index(index)
.ok_or(PkmnError::IndexOutOfBounds {
index,
len: self.scripts.read().len(),
})?
.1
.clone())
} }
/// Gets the number of scripts in the set. /// Gets the number of scripts in the set.

View File

@ -35,7 +35,7 @@ pub trait VolatileScriptsOwner {
} }
/// Removes a volatile script by name. /// Removes a volatile script by name.
fn remove_volatile_script(&self, key: &StringKey) { fn remove_volatile_script(&self, key: &StringKey) -> Result<()> {
self.volatile_scripts().remove(key) self.volatile_scripts().remove(key)
} }
} }

View File

@ -1,5 +1,6 @@
use crate::dynamic_data::{FleeChoice, LearnedMove, MoveChoice, PassChoice, Pokemon, TurnChoice}; use crate::dynamic_data::{FleeChoice, LearnedMove, MoveChoice, PassChoice, Pokemon, TurnChoice};
use crate::ffi::{ExternPointer, IdentifiablePointer, OwnedPtr}; use crate::ffi::{ExternPointer, IdentifiablePointer, NativeResult, OwnedPtr};
use anyhow::anyhow;
use std::ptr::drop_in_place; use std::ptr::drop_in_place;
use std::sync::Arc; use std::sync::Arc;
@ -57,38 +58,38 @@ extern "C" fn turn_choice_move_new(
#[no_mangle] #[no_mangle]
extern "C" fn turn_choice_move_learned_move( extern "C" fn turn_choice_move_learned_move(
choice: ExternPointer<TurnChoice>, choice: ExternPointer<TurnChoice>,
) -> IdentifiablePointer<Arc<LearnedMove>> { ) -> NativeResult<IdentifiablePointer<Arc<LearnedMove>>> {
if let TurnChoice::Move(c) = choice.as_ref() { if let TurnChoice::Move(c) = choice.as_ref() {
return c.used_move().clone().into(); return NativeResult::ok(c.used_move().clone().into());
} }
panic!("Turn choice was not a learned move"); NativeResult::err(anyhow!("Turn choice was not a learned move"))
} }
/// The target side the move is aimed at. /// The target side the move is aimed at.
#[no_mangle] #[no_mangle]
extern "C" fn turn_choice_move_target_side(choice: ExternPointer<TurnChoice>) -> u8 { extern "C" fn turn_choice_move_target_side(choice: ExternPointer<TurnChoice>) -> NativeResult<u8> {
if let TurnChoice::Move(c) = choice.as_ref() { if let TurnChoice::Move(c) = choice.as_ref() {
return c.target_side(); return NativeResult::ok(c.target_side());
} }
panic!("Turn choice was not a learned move"); NativeResult::err(anyhow!("Turn choice was not a learned move"))
} }
/// The Pokemon index on the side we're aiming at. /// The Pokemon index on the side we're aiming at.
#[no_mangle] #[no_mangle]
extern "C" fn turn_choice_move_target_index(choice: ExternPointer<TurnChoice>) -> u8 { extern "C" fn turn_choice_move_target_index(choice: ExternPointer<TurnChoice>) -> NativeResult<u8> {
if let TurnChoice::Move(c) = choice.as_ref() { if let TurnChoice::Move(c) = choice.as_ref() {
return c.target_index(); return NativeResult::ok(c.target_index());
} }
panic!("Turn choice was not a learned move"); NativeResult::err(anyhow!("Turn choice was not a learned move"))
} }
/// The priority of the move choice at the beginning of the turn. /// The priority of the move choice at the beginning of the turn.
#[no_mangle] #[no_mangle]
extern "C" fn turn_choice_move_priority(choice: ExternPointer<TurnChoice>) -> i8 { extern "C" fn turn_choice_move_priority(choice: ExternPointer<TurnChoice>) -> NativeResult<i8> {
if let TurnChoice::Move(c) = choice.as_ref() { if let TurnChoice::Move(c) = choice.as_ref() {
return c.priority(); return NativeResult::ok(c.priority());
} }
panic!("Turn choice was not a learned move"); NativeResult::err(anyhow!("Turn choice was not a learned move"))
} }
/// Creates a new Turn Choice for the user to flee. /// Creates a new Turn Choice for the user to flee.

View File

@ -3,6 +3,7 @@ use crate::dynamic_data::{
}; };
use crate::ffi::dynamic_data::models::native_event_hook::NativeEventHook; use crate::ffi::dynamic_data::models::native_event_hook::NativeEventHook;
use crate::ffi::{ExternPointer, IdentifiablePointer, NativeResult, OwnedPtr}; use crate::ffi::{ExternPointer, IdentifiablePointer, NativeResult, OwnedPtr};
use anyhow::anyhow;
use std::ffi::{c_char, CStr, CString}; use std::ffi::{c_char, CStr, CString};
use std::sync::Arc; use std::sync::Arc;
@ -178,14 +179,12 @@ extern "C" fn battle_can_use(ptr: ExternPointer<Arc<Battle>>, choice: ExternPoin
/// Checks to see whether all Pokemon on the field have set their choices. If so, we then run /// Checks to see whether all Pokemon on the field have set their choices. If so, we then run
/// the turn. /// the turn.
#[no_mangle] #[no_mangle]
extern "C" fn battle_try_set_choice(ptr: ExternPointer<Arc<Battle>>, choice: OwnedPtr<TurnChoice>) -> u8 { extern "C" fn battle_try_set_choice(ptr: ExternPointer<Arc<Battle>>, choice: OwnedPtr<TurnChoice>) -> NativeResult<u8> {
let choice = unsafe { choice.read() }; let choice = unsafe { choice.read() };
let result = ptr.as_ref().try_set_choice(choice); let result = ptr.as_ref().try_set_choice(choice);
match result { match result {
Ok(b) => u8::from(b), Ok(b) => NativeResult::ok(u8::from(b)),
Err(e) => { Err(e) => NativeResult::err(e),
panic!("Encountered error: {}", e)
}
} }
} }
@ -203,7 +202,10 @@ extern "C" fn battle_set_weather(ptr: ExternPointer<Arc<Battle>>, weather: *cons
#[no_mangle] #[no_mangle]
extern "C" fn battle_weather_name(ptr: ExternPointer<Arc<Battle>>) -> NativeResult<*mut c_char> { extern "C" fn battle_weather_name(ptr: ExternPointer<Arc<Battle>>) -> NativeResult<*mut c_char> {
match ptr.as_ref().weather_name() { match ptr.as_ref().weather_name() {
Ok(Some(w)) => CString::new(w.str()).unwrap().into_raw().into(), Ok(Some(w)) => match CString::new(w.str()) {
Ok(s) => s.into_raw().into(),
Err(e) => NativeResult::err(anyhow!("Failed to convert weather name to CString: {}", e)),
},
Ok(None) => std::ptr::null_mut::<c_char>().into(), Ok(None) => std::ptr::null_mut::<c_char>().into(),
Err(e) => NativeResult::err(e), Err(e) => NativeResult::err(e),
} }

View File

@ -1,5 +1,7 @@
use crate::dynamic_data::{BattleParty, Pokemon, PokemonParty}; use crate::dynamic_data::{BattleParty, Pokemon, PokemonParty};
use crate::ffi::{ExternPointer, IdentifiablePointer}; use crate::ffi::{ExternPointer, IdentifiablePointer, NativeResult};
use crate::VecExt;
use anyhow::{anyhow, Result};
use std::sync::Arc; use std::sync::Arc;
/// A battle party is a wrapper around a party, with the indices for which the party is responsible /// A battle party is a wrapper around a party, with the indices for which the party is responsible
@ -9,18 +11,34 @@ extern "C" fn battle_party_new(
party: ExternPointer<Arc<PokemonParty>>, party: ExternPointer<Arc<PokemonParty>>,
responsible_indices_ptr: *const u8, responsible_indices_ptr: *const u8,
responsible_indices_length: usize, responsible_indices_length: usize,
) -> IdentifiablePointer<Arc<BattleParty>> { ) -> NativeResult<IdentifiablePointer<Arc<BattleParty>>> {
if responsible_indices_length % 2 == 1 { if responsible_indices_length % 2 != 0 {
panic!("The length of responsible indices should be dividable by two"); return NativeResult::err(anyhow!("The length of responsible indices should be dividable by two"));
} }
let responsible_indices_slice = let responsible_indices_slice =
unsafe { std::slice::from_raw_parts(responsible_indices_ptr, responsible_indices_length) }; unsafe { std::slice::from_raw_parts(responsible_indices_ptr, responsible_indices_length) };
let mut responsible_indices: Vec<(u8, u8)> = Vec::with_capacity(responsible_indices_length / 2); let mut responsible_indices: Vec<(u8, u8)> = Vec::with_capacity(responsible_indices_length / 2);
let mut split = |i| -> Result<()> {
*responsible_indices.get_mut_res(i)? = (
*responsible_indices_slice.get_res(i * 2)?,
*responsible_indices_slice.get_res(i * 2 + 1)?,
);
Ok(())
};
for i in 0..responsible_indices_length / 2 { for i in 0..responsible_indices_length / 2 {
responsible_indices[i] = (responsible_indices_slice[i * 2], responsible_indices_slice[i * 2 + 1]) match split(i) {
Ok(_) => (),
Err(e) => return NativeResult::err(e),
}
} }
Arc::new(BattleParty::new(party.as_ref().clone(), responsible_indices)).into() match BattleParty::new(party.as_ref().clone(), responsible_indices) {
Ok(v) => NativeResult::ok(Arc::new(v).into()),
Err(e) => NativeResult::err(e),
}
} }
/// Checks whether the party is responsible for the given index. /// Checks whether the party is responsible for the given index.

View File

@ -4,6 +4,7 @@ use crate::ffi::{ffi_arc_getter, ffi_vec_value_getters, ExternPointer, Identifia
use crate::static_data::{ use crate::static_data::{
Ability, AbilityIndex, Form, Gender, Item, Nature, Species, Statistic, StatisticSet, TypeIdentifier, Ability, AbilityIndex, Form, Gender, Item, Nature, Species, Statistic, StatisticSet, TypeIdentifier,
}; };
use anyhow::anyhow;
use std::ffi::{c_char, CStr, CString}; use std::ffi::{c_char, CStr, CString};
use std::ptr::drop_in_place; use std::ptr::drop_in_place;
use std::sync::Arc; use std::sync::Arc;
@ -141,12 +142,15 @@ ffi_arc_getter!(Pokemon, height, f32);
/// An optional nickname of the Pokemon. /// An optional nickname of the Pokemon.
#[no_mangle] #[no_mangle]
extern "C" fn pokemon_nickname(ptr: ExternPointer<Arc<Pokemon>>) -> *mut c_char { extern "C" fn pokemon_nickname(ptr: ExternPointer<Arc<Pokemon>>) -> NativeResult<*mut c_char> {
let name = ptr.as_ref().nickname(); let name = ptr.as_ref().nickname();
if let Some(v) = name { if let Some(v) = name {
CString::new(v.as_str()).unwrap().into_raw() match CString::new(v.as_str()) {
Ok(v) => NativeResult::ok(v.into_raw()),
Err(err) => NativeResult::err(anyhow!("Could not convert nickname to CString: {}", err)),
}
} else { } else {
std::ptr::null_mut() NativeResult::ok(std::ptr::null_mut())
} }
} }

View File

@ -1,5 +1,5 @@
use crate::dynamic_data::{Pokemon, PokemonParty}; use crate::dynamic_data::{Pokemon, PokemonParty};
use crate::ffi::{ExternPointer, IdentifiablePointer}; use crate::ffi::{ExternPointer, IdentifiablePointer, NativeResult};
use std::sync::Arc; use std::sync::Arc;
/// Instantiates a party with a set size. /// Instantiates a party with a set size.
@ -33,16 +33,16 @@ extern "C" fn pokemon_party_swap_into(
ptr: ExternPointer<Arc<PokemonParty>>, ptr: ExternPointer<Arc<PokemonParty>>,
index: usize, index: usize,
pokemon: ExternPointer<Arc<Pokemon>>, pokemon: ExternPointer<Arc<Pokemon>>,
) -> IdentifiablePointer<Arc<Pokemon>> { ) -> NativeResult<IdentifiablePointer<Arc<Pokemon>>> {
let pokemon = if pokemon.ptr.is_null() { let pokemon = if pokemon.ptr.is_null() {
None None
} else { } else {
Some(pokemon.as_ref().clone()) Some(pokemon.as_ref().clone())
}; };
if let Some(v) = ptr.as_ref().swap_into(index, pokemon) { match ptr.as_ref().swap_into(index, pokemon) {
v.into() Ok(Some(v)) => NativeResult::ok(v.into()),
} else { Ok(None) => NativeResult::ok(IdentifiablePointer::none()),
IdentifiablePointer::none() Err(e) => NativeResult::err(e),
} }
} }
@ -60,8 +60,8 @@ extern "C" fn pokemon_party_length(ptr: ExternPointer<Arc<PokemonParty>>) -> usi
/// Makes sure there are no empty spots in the party anymore, leaving the length the same. /// Makes sure there are no empty spots in the party anymore, leaving the length the same.
#[no_mangle] #[no_mangle]
extern "C" fn pokemon_party_pack_party(ptr: ExternPointer<Arc<PokemonParty>>) { extern "C" fn pokemon_party_pack_party(ptr: ExternPointer<Arc<PokemonParty>>) -> NativeResult<()> {
ptr.as_ref().pack_party() ptr.as_ref().pack_party().into()
} }
/// Checks if the party contains a given pokemon. /// Checks if the party contains a given pokemon.

View File

@ -106,6 +106,7 @@ pub(self) struct ExternPointer<T: ?Sized> {
impl<T: ?Sized> ExternPointer<T> { impl<T: ?Sized> ExternPointer<T> {
/// Get the internal pointer as reference. /// Get the internal pointer as reference.
#[allow(clippy::panic)] // We currently allow this as these should never be null, but we might want to change this in the future.
pub(self) fn as_ref(&self) -> &T { pub(self) fn as_ref(&self) -> &T {
unsafe { unsafe {
self.ptr self.ptr
@ -114,6 +115,7 @@ impl<T: ?Sized> ExternPointer<T> {
} }
} }
/// Get the internal pointer as mutable reference. /// Get the internal pointer as mutable reference.
#[allow(clippy::panic)] // We currently allow this as these should never be null, but we might want to change this in the future.
pub(self) fn as_mut(&mut self) -> &mut T { pub(self) fn as_mut(&mut self) -> &mut T {
unsafe { unsafe {
self.ptr self.ptr
@ -241,6 +243,7 @@ impl<T: ValueIdentifiable> From<Box<T>> for IdentifiablePointer<T> {
} }
impl<T: ValueIdentifiable> From<*const T> for IdentifiablePointer<T> { impl<T: ValueIdentifiable> From<*const T> for IdentifiablePointer<T> {
#[allow(clippy::unwrap_used)] // We currently allow this as these should never be null, but we might want to change this in the future.
fn from(v: *const T) -> Self { fn from(v: *const T) -> Self {
let id = unsafe { transmute(v.as_ref().unwrap().value_identifier()) }; let id = unsafe { transmute(v.as_ref().unwrap().value_identifier()) };
Self { ptr: v, id } Self { ptr: v, id }
@ -284,7 +287,8 @@ impl<T: Copy> NativeResult<T> {
} }
} }
/// Creates a new NativeResult with the given error. /// Creates a new NativeResult with the given error.
pub fn err(err: anyhow::Error) -> Self { #[allow(clippy::unwrap_used)] // We know for certain this is not empty.
pub fn err(err: anyhow_ext::Error) -> Self {
Self { Self {
ok: 0, ok: 0,
value: ResultUnion { value: ResultUnion {
@ -292,6 +296,17 @@ impl<T: Copy> NativeResult<T> {
}, },
} }
} }
/// Creates a new NativeResult with the given error string.
#[allow(clippy::unwrap_used)] // We know for certain this is not empty.
pub fn err_from_str(err: &str) -> Self {
Self {
ok: 0,
value: ResultUnion {
err: CString::new(err).unwrap().into_raw(),
},
}
}
} }
impl<T: Copy> From<anyhow::Result<T>> for NativeResult<T> { impl<T: Copy> From<anyhow::Result<T>> for NativeResult<T> {

View File

@ -1,6 +1,7 @@
use crate::ffi::{ExternPointer, IdentifiablePointer, OwnedPtr}; use crate::ffi::{ExternPointer, IdentifiablePointer, NativeResult, OwnedPtr};
use crate::static_data::{Ability, AbilityImpl, EffectParameter}; use crate::static_data::{Ability, AbilityImpl, EffectParameter};
use crate::StringKey; use crate::StringKey;
use anyhow::anyhow;
use std::ffi::{c_char, CStr, CString}; use std::ffi::{c_char, CStr, CString};
use std::ptr::drop_in_place; use std::ptr::drop_in_place;
use std::sync::Arc; use std::sync::Arc;
@ -12,18 +13,24 @@ unsafe extern "C" fn ability_new(
effect: *const c_char, effect: *const c_char,
parameters: *const OwnedPtr<EffectParameter>, parameters: *const OwnedPtr<EffectParameter>,
parameters_length: usize, parameters_length: usize,
) -> IdentifiablePointer<Arc<dyn Ability>> { ) -> NativeResult<IdentifiablePointer<Arc<dyn Ability>>> {
let parameters = std::slice::from_raw_parts(parameters, parameters_length); let parameters = std::slice::from_raw_parts(parameters, parameters_length);
let mut parameters_vec: Vec<EffectParameter> = Vec::with_capacity(parameters_length); let mut parameters_vec: Vec<EffectParameter> = Vec::with_capacity(parameters_length);
for parameter in parameters { for parameter in parameters {
parameters_vec.push(*Box::from_raw(*parameter)); parameters_vec.push(*Box::from_raw(*parameter));
} }
let name: StringKey = CStr::from_ptr(name).to_str().unwrap().into(); let name: StringKey = match CStr::from_ptr(name).to_str() {
let effect: StringKey = CStr::from_ptr(effect).to_str().unwrap().into(); Ok(s) => s.into(),
Err(_) => return NativeResult::err(anyhow!("Failed to convert name to CStr")),
};
let effect: StringKey = match CStr::from_ptr(effect).to_str() {
Ok(s) => s.into(),
Err(_) => return NativeResult::err(anyhow!("Failed to convert effect to CStr")),
};
let arc: Arc<dyn Ability> = Arc::new(AbilityImpl::new(&name, &effect, parameters_vec)); let arc: Arc<dyn Ability> = Arc::new(AbilityImpl::new(&name, &effect, parameters_vec));
arc.into() NativeResult::ok(arc.into())
} }
/// Drops a reference counted ability. /// Drops a reference counted ability.
@ -34,14 +41,20 @@ unsafe extern "C" fn ability_drop(ptr: OwnedPtr<Arc<dyn Ability>>) {
/// The name of the ability. /// The name of the ability.
#[no_mangle] #[no_mangle]
unsafe extern "C" fn ability_name(ptr: ExternPointer<Arc<dyn Ability>>) -> OwnedPtr<c_char> { unsafe extern "C" fn ability_name(ptr: ExternPointer<Arc<dyn Ability>>) -> NativeResult<OwnedPtr<c_char>> {
CString::new(ptr.as_ref().name().str()).unwrap().into_raw() match CString::new(ptr.as_ref().name().str()) {
Ok(s) => NativeResult::ok(s.into_raw()),
Err(_) => NativeResult::err(anyhow!("Failed to convert name to CString")),
}
} }
/// The name of the script effect of the ability. /// The name of the script effect of the ability.
#[no_mangle] #[no_mangle]
unsafe extern "C" fn ability_effect(ptr: ExternPointer<Arc<dyn Ability>>) -> OwnedPtr<c_char> { unsafe extern "C" fn ability_effect(ptr: ExternPointer<Arc<dyn Ability>>) -> NativeResult<OwnedPtr<c_char>> {
CString::new(ptr.as_ref().effect().str()).unwrap().into_raw() match CString::new(ptr.as_ref().effect().str()) {
Ok(s) => NativeResult::ok(s.into_raw()),
Err(_) => NativeResult::err(anyhow!("Failed to convert effect to CString")),
}
} }
/// The length of the parameters for the script effect of the ability. /// The length of the parameters for the script effect of the ability.

View File

@ -1,9 +1,10 @@
use crate::ffi::{ use crate::ffi::{
ffi_arc_dyn_getter, ffi_vec_stringkey_getters, ffi_vec_value_getters, BorrowedPtr, ExternPointer, ffi_arc_dyn_getter, ffi_vec_stringkey_getters, ffi_vec_value_getters, BorrowedPtr, ExternPointer,
IdentifiablePointer, OwnedPtr, IdentifiablePointer, NativeResult, OwnedPtr,
}; };
use crate::static_data::{Form, FormImpl, LearnableMoves, StaticStatisticSet, TypeIdentifier}; use crate::static_data::{Form, FormImpl, LearnableMoves, StaticStatisticSet, TypeIdentifier};
use crate::StringKey; use crate::StringKey;
use anyhow::anyhow;
use hashbrown::HashSet; use hashbrown::HashSet;
use std::ffi::{c_char, CStr, CString}; use std::ffi::{c_char, CStr, CString};
use std::ptr::drop_in_place; use std::ptr::drop_in_place;
@ -26,8 +27,11 @@ unsafe extern "C" fn form_new(
moves: OwnedPtr<Box<dyn LearnableMoves>>, moves: OwnedPtr<Box<dyn LearnableMoves>>,
flags: *const *const c_char, flags: *const *const c_char,
flags_length: usize, flags_length: usize,
) -> IdentifiablePointer<Arc<dyn Form>> { ) -> NativeResult<IdentifiablePointer<Arc<dyn Form>>> {
let name: StringKey = CStr::from_ptr(name).to_str().unwrap().into(); let name: StringKey = match CStr::from_ptr(name).to_str() {
Ok(name) => name.into(),
Err(_) => return NativeResult::err(anyhow!("Unable to convert name to string")),
};
let abilities = std::slice::from_raw_parts(abilities, abilities_length); let abilities = std::slice::from_raw_parts(abilities, abilities_length);
let mut abilities_vec = Vec::with_capacity(abilities_length); let mut abilities_vec = Vec::with_capacity(abilities_length);
@ -43,7 +47,11 @@ unsafe extern "C" fn form_new(
let flags = std::slice::from_raw_parts(flags, flags_length); let flags = std::slice::from_raw_parts(flags, flags_length);
let mut flags_set: HashSet<StringKey> = HashSet::with_capacity(flags_length); let mut flags_set: HashSet<StringKey> = HashSet::with_capacity(flags_length);
for flag in flags { for flag in flags {
flags_set.insert(CStr::from_ptr(*flag).to_str().unwrap().into()); let flag = match CStr::from_ptr(*flag).to_str() {
Ok(flag) => flag,
Err(_) => return NativeResult::err(anyhow!("Unable to convert flag to string")),
};
flags_set.insert(flag.into());
} }
let a: Arc<dyn Form> = Arc::new(FormImpl::new( let a: Arc<dyn Form> = Arc::new(FormImpl::new(
@ -58,7 +66,7 @@ unsafe extern "C" fn form_new(
*Box::from_raw(moves), *Box::from_raw(moves),
flags_set, flags_set,
)); ));
a.into() NativeResult::ok(a.into())
} }
/// Drops a reference count for a form. /// Drops a reference count for a form.
@ -69,9 +77,12 @@ unsafe extern "C" fn form_drop(ptr: OwnedPtr<Arc<dyn Form>>) {
/// The name of the form. /// The name of the form.
#[no_mangle] #[no_mangle]
unsafe extern "C" fn form_name(ptr: ExternPointer<Arc<dyn Form>>) -> OwnedPtr<c_char> { unsafe extern "C" fn form_name(ptr: ExternPointer<Arc<dyn Form>>) -> NativeResult<OwnedPtr<c_char>> {
let name = ptr.as_ref().name(); let name = ptr.as_ref().name();
CString::new(name.str()).unwrap().into_raw() match CString::new(name.str()) {
Ok(name) => NativeResult::ok(name.into_raw()),
Err(_) => NativeResult::err(anyhow!("Unable to convert name `{}` to CString", name.str())),
}
} }
ffi_arc_dyn_getter!(Form, height, f32); ffi_arc_dyn_getter!(Form, height, f32);

View File

@ -1,6 +1,7 @@
use crate::ffi::{ffi_arc_dyn_getter, ExternPointer, IdentifiablePointer, OwnedPtr}; use crate::ffi::{ffi_arc_dyn_getter, ExternPointer, IdentifiablePointer, NativeResult, OwnedPtr};
use crate::static_data::{BattleItemCategory, Item, ItemCategory, ItemImpl}; use crate::static_data::{BattleItemCategory, Item, ItemCategory, ItemImpl};
use crate::StringKey; use crate::StringKey;
use anyhow::anyhow;
use hashbrown::HashSet; use hashbrown::HashSet;
use std::ffi::{c_char, CStr, CString}; use std::ffi::{c_char, CStr, CString};
use std::ptr::drop_in_place; use std::ptr::drop_in_place;
@ -15,16 +16,23 @@ unsafe extern "C" fn item_new(
price: i32, price: i32,
flags: *const *const c_char, flags: *const *const c_char,
flags_length: usize, flags_length: usize,
) -> IdentifiablePointer<Arc<dyn Item>> { ) -> NativeResult<IdentifiablePointer<Arc<dyn Item>>> {
let flags = std::slice::from_raw_parts(flags, flags_length); let flags = std::slice::from_raw_parts(flags, flags_length);
let name: StringKey = CStr::from_ptr(name).to_str().unwrap().into(); let name: StringKey = match CStr::from_ptr(name).to_str() {
Ok(name) => name.into(),
Err(_) => return NativeResult::err(anyhow!("Unable to convert name to string")),
};
let mut flags_set: HashSet<StringKey> = HashSet::with_capacity(flags_length); let mut flags_set: HashSet<StringKey> = HashSet::with_capacity(flags_length);
for flag in flags { for flag in flags {
flags_set.insert(CStr::from_ptr(*flag).to_str().unwrap().into()); let flag = match CStr::from_ptr(*flag).to_str() {
Ok(flag) => flag,
Err(_) => return NativeResult::err(anyhow!("Unable to convert flag to string")),
};
flags_set.insert(flag.into());
} }
let item: Arc<dyn Item> = Arc::new(ItemImpl::new(&name, category, battle_category, price, flags_set)); let item: Arc<dyn Item> = Arc::new(ItemImpl::new(&name, category, battle_category, price, flags_set));
item.into() NativeResult::ok(item.into())
} }
/// Drops a reference counted item. /// Drops a reference counted item.
@ -35,9 +43,12 @@ unsafe extern "C" fn item_drop(ptr: OwnedPtr<Arc<dyn Item>>) {
/// The name of the item. /// The name of the item.
#[no_mangle] #[no_mangle]
unsafe extern "C" fn item_name(ptr: ExternPointer<Arc<dyn Item>>) -> OwnedPtr<c_char> { unsafe extern "C" fn item_name(ptr: ExternPointer<Arc<dyn Item>>) -> NativeResult<OwnedPtr<c_char>> {
let name = ptr.as_ref().name(); let name = ptr.as_ref().name();
CString::new(name.str()).unwrap().into_raw() match CString::new(name.str()) {
Ok(name) => NativeResult::ok(name.into_raw()),
Err(_) => NativeResult::err(anyhow!("Unable to convert name `{}` to CString", name.str())),
}
} }
ffi_arc_dyn_getter!(Item, category, ItemCategory); ffi_arc_dyn_getter!(Item, category, ItemCategory);

View File

@ -1,6 +1,7 @@
use crate::ffi::{BorrowedPtr, ExternPointer, IdentifiablePointer, OwnedPtr}; use crate::ffi::{BorrowedPtr, ExternPointer, IdentifiablePointer, NativeResult, OwnedPtr};
use crate::static_data::{Nature, NatureLibrary, NatureLibraryImpl}; use crate::static_data::{Nature, NatureLibrary, NatureLibraryImpl};
use crate::Random; use crate::{PkmnError, Random};
use anyhow::anyhow;
use std::ffi::{c_char, CStr, CString}; use std::ffi::{c_char, CStr, CString};
use std::ptr::drop_in_place; use std::ptr::drop_in_place;
use std::sync::Arc; use std::sync::Arc;
@ -24,9 +25,15 @@ unsafe extern "C" fn nature_library_load_nature(
mut ptr: ExternPointer<Box<dyn NatureLibrary>>, mut ptr: ExternPointer<Box<dyn NatureLibrary>>,
name: BorrowedPtr<c_char>, name: BorrowedPtr<c_char>,
nature: OwnedPtr<Arc<dyn Nature>>, nature: OwnedPtr<Arc<dyn Nature>>,
) { ) -> NativeResult<()> {
ptr.as_mut() let nature = nature.as_ref().ok_or(PkmnError::NullReference);
.load_nature(CStr::from_ptr(name).into(), nature.as_ref().unwrap().clone()) match nature {
Ok(nature) => {
ptr.as_mut().load_nature(CStr::from_ptr(name).into(), nature.clone());
NativeResult::ok(())
}
Err(e) => NativeResult::err(e.into()),
}
} }
/// Gets a nature by name. /// Gets a nature by name.
@ -57,8 +64,15 @@ unsafe extern "C" fn nature_library_get_random_nature(
unsafe extern "C" fn nature_library_get_nature_name( unsafe extern "C" fn nature_library_get_nature_name(
ptr: ExternPointer<Box<dyn NatureLibrary>>, ptr: ExternPointer<Box<dyn NatureLibrary>>,
nature: BorrowedPtr<Arc<dyn Nature>>, nature: BorrowedPtr<Arc<dyn Nature>>,
) -> OwnedPtr<c_char> { ) -> NativeResult<OwnedPtr<c_char>> {
CString::new(ptr.as_ref().get_nature_name(nature.as_ref().unwrap()).str()) match nature.as_ref() {
.unwrap() Some(nature) => {
.into_raw() let name = ptr.as_ref().get_nature_name(nature);
match CString::new(name.str()) {
Ok(cstr) => NativeResult::ok(cstr.into_raw()),
Err(_) => NativeResult::err(anyhow!("Failed to convert nature name to C string")),
}
}
None => NativeResult::err(PkmnError::NullReference.into()),
}
} }

View File

@ -1,4 +1,4 @@
use crate::ffi::{BorrowedPtr, ExternPointer, IdentifiablePointer, OwnedPtr}; use crate::ffi::{BorrowedPtr, ExternPointer, IdentifiablePointer, NativeResult, OwnedPtr};
use crate::static_data::{TypeIdentifier, TypeLibrary, TypeLibraryImpl}; use crate::static_data::{TypeIdentifier, TypeLibrary, TypeLibraryImpl};
use std::ffi::{c_char, CStr, CString}; use std::ffi::{c_char, CStr, CString};
use std::ptr::drop_in_place; use std::ptr::drop_in_place;
@ -38,13 +38,17 @@ unsafe extern "C" fn type_library_get_type_name(
ptr: ExternPointer<Box<dyn TypeLibrary>>, ptr: ExternPointer<Box<dyn TypeLibrary>>,
type_id: TypeIdentifier, type_id: TypeIdentifier,
found: *mut bool, found: *mut bool,
) -> *mut c_char { ) -> NativeResult<*mut c_char> {
if let Some(v) = ptr.as_ref().get_type_name(type_id) { if let Some(v) = ptr.as_ref().get_type_name(type_id) {
*found = true; *found = true;
CString::new(v.str()).unwrap().into_raw()
match CString::new(v.str()) {
Ok(v) => NativeResult::ok(v.into_raw()),
Err(e) => NativeResult::err(e.into()),
}
} else { } else {
*found = false; *found = false;
std::ptr::null_mut() NativeResult::ok(std::ptr::null_mut())
} }
} }

View File

@ -1,6 +1,7 @@
use crate::ffi::{ExternPointer, IdentifiablePointer, OwnedPtr}; use crate::ffi::{ExternPointer, IdentifiablePointer, NativeResult, OwnedPtr};
use crate::static_data::EffectParameter; use crate::static_data::EffectParameter;
use crate::StringKey; use crate::{PkmnError, StringKey};
use anyhow::anyhow;
use std::ffi::{c_char, CStr, CString}; use std::ffi::{c_char, CStr, CString};
use std::ptr::drop_in_place; use std::ptr::drop_in_place;
@ -45,9 +46,14 @@ extern "C" fn effect_parameter_new_float(value: f32) -> IdentifiablePointer<Effe
/// Instantiates an effect parameter with a string. /// Instantiates an effect parameter with a string.
#[no_mangle] #[no_mangle]
unsafe extern "C" fn effect_parameter_new_string(value: *const c_char) -> IdentifiablePointer<EffectParameter> { unsafe extern "C" fn effect_parameter_new_string(
let sk: StringKey = CStr::from_ptr(value).to_str().unwrap().into(); value: *const c_char,
Box::<EffectParameter>::new(sk.into()).into() ) -> NativeResult<IdentifiablePointer<EffectParameter>> {
let sk: StringKey = match CStr::from_ptr(value).to_str() {
Ok(sk) => sk.into(),
Err(_) => return NativeResult::err(PkmnError::InvalidCString.into()),
};
NativeResult::ok(Box::<EffectParameter>::new(sk.into()).into())
} }
/// Drop an effect parameter. /// Drop an effect parameter.
@ -69,40 +75,47 @@ extern "C" fn effect_parameter_get_type(ptr: ExternPointer<EffectParameter>) ->
/// Get the boolean contained in the effect parameter, panics if the effect parameter is not a bool. /// Get the boolean contained in the effect parameter, panics if the effect parameter is not a bool.
#[no_mangle] #[no_mangle]
extern "C" fn effect_parameter_get_as_bool(ptr: ExternPointer<EffectParameter>) -> u8 { extern "C" fn effect_parameter_get_as_bool(ptr: ExternPointer<EffectParameter>) -> NativeResult<u8> {
let p = ptr.as_ref(); let p = ptr.as_ref();
if let EffectParameter::Bool(_, b) = p { if let EffectParameter::Bool(_, b) = p {
return u8::from(*b); NativeResult::ok(u8::from(*b))
} else {
NativeResult::err(anyhow!("Unexpected effect parameter. Expected bool, was: {}", p))
} }
panic!("Unexpected effect parameter. Expected bool, was: {}", p);
} }
/// Get the int contained in the effect parameter, panics if the effect parameter is not a int. /// Get the int contained in the effect parameter, panics if the effect parameter is not a int.
#[no_mangle] #[no_mangle]
extern "C" fn effect_parameter_get_as_int(ptr: ExternPointer<EffectParameter>) -> i64 { extern "C" fn effect_parameter_get_as_int(ptr: ExternPointer<EffectParameter>) -> NativeResult<i64> {
let p = ptr.as_ref(); let p = ptr.as_ref();
if let EffectParameter::Int(_, b) = p { if let EffectParameter::Int(_, b) = p {
return *b; NativeResult::ok(*b)
} else {
NativeResult::err(anyhow!("Unexpected effect parameter. Expected int, was: {}", p))
} }
panic!("Unexpected effect parameter. Expected int, was: {}", p);
} }
/// Get the float contained in the effect parameter, panics if the effect parameter is not a float. /// Get the float contained in the effect parameter, panics if the effect parameter is not a float.
#[no_mangle] #[no_mangle]
extern "C" fn effect_parameter_get_as_float(ptr: ExternPointer<EffectParameter>) -> f32 { extern "C" fn effect_parameter_get_as_float(ptr: ExternPointer<EffectParameter>) -> NativeResult<f32> {
let p = ptr.as_ref(); let p = ptr.as_ref();
if let EffectParameter::Float(_, b) = p { if let EffectParameter::Float(_, b) = p {
return *b; NativeResult::ok(*b)
} else {
NativeResult::err(anyhow!("Unexpected effect parameter. Expected float, was: {}", p))
} }
panic!("Unexpected effect parameter. Expected float, was: {}", p);
} }
/// Get the string contained in the effect parameter, panics if the effect parameter is not a string. /// Get the string contained in the effect parameter, panics if the effect parameter is not a string.
#[no_mangle] #[no_mangle]
extern "C" fn effect_parameter_get_as_string(ptr: ExternPointer<EffectParameter>) -> OwnedPtr<c_char> { extern "C" fn effect_parameter_get_as_string(ptr: ExternPointer<EffectParameter>) -> NativeResult<OwnedPtr<c_char>> {
let p = ptr.as_ref(); let p = ptr.as_ref();
if let EffectParameter::String(_, b) = p { if let EffectParameter::String(_, b) = p {
return CString::new(b.str().to_string()).unwrap().into_raw(); match CString::new(b.str().to_string()) {
Ok(cstr) => NativeResult::ok(cstr.into_raw()),
Err(_) => NativeResult::err(PkmnError::InvalidCString.into()),
}
} else {
NativeResult::err(anyhow!("Unexpected effect parameter. Expected string, was: {}", p))
} }
panic!("Unexpected effect parameter. Expected string, was: {}", p);
} }

View File

@ -1,9 +1,10 @@
use crate::ffi::{ffi_arc_dyn_getter, BorrowedPtr, ExternPointer, IdentifiablePointer, OwnedPtr}; use crate::ffi::{ffi_arc_dyn_getter, BorrowedPtr, ExternPointer, IdentifiablePointer, NativeResult, OwnedPtr};
use crate::static_data::{ use crate::static_data::{
EffectParameter, MoveCategory, MoveData, MoveDataImpl, MoveTarget, SecondaryEffect, SecondaryEffectImpl, EffectParameter, MoveCategory, MoveData, MoveDataImpl, MoveTarget, SecondaryEffect, SecondaryEffectImpl,
TypeIdentifier, TypeIdentifier,
}; };
use crate::StringKey; use crate::StringKey;
use anyhow::anyhow;
use hashbrown::HashSet; use hashbrown::HashSet;
use std::ffi::{c_char, CStr, CString}; use std::ffi::{c_char, CStr, CString};
use std::ptr::drop_in_place; use std::ptr::drop_in_place;
@ -23,12 +24,19 @@ unsafe extern "C" fn move_data_new(
secondary_effect: *mut Box<dyn SecondaryEffect>, secondary_effect: *mut Box<dyn SecondaryEffect>,
flags: *const *const c_char, flags: *const *const c_char,
flags_length: usize, flags_length: usize,
) -> IdentifiablePointer<Arc<dyn MoveData>> { ) -> NativeResult<IdentifiablePointer<Arc<dyn MoveData>>> {
let flags = std::slice::from_raw_parts(flags, flags_length); let flags = std::slice::from_raw_parts(flags, flags_length);
let name: StringKey = CStr::from_ptr(name).to_str().unwrap().into(); let name: StringKey = match CStr::from_ptr(name).to_str() {
Ok(name) => name.into(),
Err(_) => return NativeResult::err_from_str("Unable to convert name to string"),
};
let mut flags_set: HashSet<StringKey> = HashSet::with_capacity(flags_length); let mut flags_set: HashSet<StringKey> = HashSet::with_capacity(flags_length);
for flag in flags { for flag in flags {
flags_set.insert(CStr::from_ptr(*flag).to_str().unwrap().into()); let flag = match CStr::from_ptr(*flag).to_str() {
Ok(flag) => flag,
Err(_) => return NativeResult::err_from_str("Unable to convert flag to string"),
};
flags_set.insert(flag.into());
} }
let secondary_effect = if secondary_effect.is_null() { let secondary_effect = if secondary_effect.is_null() {
None None
@ -47,7 +55,7 @@ unsafe extern "C" fn move_data_new(
secondary_effect, secondary_effect,
flags_set, flags_set,
)); ));
a.into() NativeResult::ok(a.into())
} }
/// Drops a reference counted move. /// Drops a reference counted move.
@ -58,9 +66,12 @@ unsafe extern "C" fn move_data_drop(ptr: OwnedPtr<Arc<dyn MoveData>>) {
/// The name of the move. /// The name of the move.
#[no_mangle] #[no_mangle]
unsafe extern "C" fn move_data_name(ptr: ExternPointer<Arc<dyn MoveData>>) -> OwnedPtr<c_char> { unsafe extern "C" fn move_data_name(ptr: ExternPointer<Arc<dyn MoveData>>) -> NativeResult<OwnedPtr<c_char>> {
let name = ptr.as_ref().name(); let name = ptr.as_ref().name();
CString::new(name.str()).unwrap().into_raw() match CString::new(name.str()) {
Ok(name) => NativeResult::ok(name.into_raw()),
Err(_) => NativeResult::err_from_str("Unable to convert name to string"),
}
} }
ffi_arc_dyn_getter!(MoveData, move_type, TypeIdentifier); ffi_arc_dyn_getter!(MoveData, move_type, TypeIdentifier);
@ -122,8 +133,16 @@ unsafe extern "C" fn secondary_effect_chance(ptr: ExternPointer<Box<dyn Secondar
/// The name of the effect. /// The name of the effect.
#[no_mangle] #[no_mangle]
unsafe extern "C" fn secondary_effect_effect_name(ptr: ExternPointer<Box<dyn SecondaryEffect>>) -> OwnedPtr<c_char> { unsafe extern "C" fn secondary_effect_effect_name(
CString::new(ptr.as_ref().effect_name().str()).unwrap().into_raw() ptr: ExternPointer<Box<dyn SecondaryEffect>>,
) -> NativeResult<OwnedPtr<c_char>> {
match CString::new(ptr.as_ref().effect_name().str()) {
Ok(name) => NativeResult::ok(name.into_raw()),
Err(_) => NativeResult::err(anyhow!(
"Unable to convert effect name '{}' to CString",
ptr.as_ref().effect_name()
)),
}
} }
/// The length of parameters of the effect. /// The length of parameters of the effect.

View File

@ -1,8 +1,9 @@
use crate::ffi::{ use crate::ffi::{
ffi_arc_dyn_getter, ffi_arc_stringkey_getter, BorrowedPtr, ExternPointer, IdentifiablePointer, OwnedPtr, ffi_arc_dyn_getter, ffi_arc_stringkey_getter, BorrowedPtr, ExternPointer, IdentifiablePointer, NativeResult,
OwnedPtr,
}; };
use crate::static_data::{Form, Gender, Species, SpeciesImpl}; use crate::static_data::{Form, Gender, Species, SpeciesImpl};
use crate::{Random, StringKey}; use crate::{PkmnError, Random, StringKey};
use hashbrown::HashSet; use hashbrown::HashSet;
use std::ffi::{c_char, CStr}; use std::ffi::{c_char, CStr};
use std::ptr::drop_in_place; use std::ptr::drop_in_place;
@ -19,25 +20,40 @@ unsafe extern "C" fn species_new(
default_form: OwnedPtr<Arc<dyn Form>>, default_form: OwnedPtr<Arc<dyn Form>>,
flags: *const *const c_char, flags: *const *const c_char,
flags_length: usize, flags_length: usize,
) -> IdentifiablePointer<Arc<dyn Species>> { ) -> NativeResult<IdentifiablePointer<Arc<dyn Species>>> {
let name: StringKey = CStr::from_ptr(name).to_str().unwrap().into(); let name: StringKey = match CStr::from_ptr(name).to_str() {
let growth_rate: StringKey = CStr::from_ptr(growth_rate).to_str().unwrap().into(); Ok(name) => name.into(),
Err(_) => return NativeResult::err(PkmnError::InvalidCString.into()),
};
let growth_rate: StringKey = match CStr::from_ptr(growth_rate).to_str() {
Ok(growth_rate) => growth_rate.into(),
Err(_) => return NativeResult::err(PkmnError::InvalidCString.into()),
};
let flags = std::slice::from_raw_parts(flags, flags_length); let flags = std::slice::from_raw_parts(flags, flags_length);
let mut flags_set: HashSet<StringKey> = HashSet::with_capacity(flags_length); let mut flags_set: HashSet<StringKey> = HashSet::with_capacity(flags_length);
for flag in flags { for flag in flags {
flags_set.insert(CStr::from_ptr(*flag).to_str().unwrap().into()); let flag = match CStr::from_ptr(*flag).to_str() {
Ok(flag) => flag,
Err(_) => return NativeResult::err(PkmnError::InvalidCString.into()),
};
flags_set.insert(flag.into());
} }
let default_form = match default_form.as_ref() {
Some(default_form) => default_form,
None => return NativeResult::err(PkmnError::NullReference.into()),
};
let a: Arc<dyn Species> = Arc::new(SpeciesImpl::new( let a: Arc<dyn Species> = Arc::new(SpeciesImpl::new(
id, id,
&name, &name,
gender_rate, gender_rate,
&growth_rate, &growth_rate,
capture_rate, capture_rate,
default_form.as_ref().unwrap().clone(), default_form.clone(),
flags_set, flags_set,
)); ));
a.into() NativeResult::ok(a.into())
} }
/// Drop a reference to the species. /// Drop a reference to the species.
@ -58,9 +74,13 @@ unsafe extern "C" fn species_add_form(
mut species: ExternPointer<Arc<dyn Species>>, mut species: ExternPointer<Arc<dyn Species>>,
name: BorrowedPtr<c_char>, name: BorrowedPtr<c_char>,
form: OwnedPtr<Arc<dyn Form>>, form: OwnedPtr<Arc<dyn Form>>,
) { ) -> NativeResult<()> {
let form = form.as_ref().unwrap().clone(); let form = match form.as_ref() {
species.as_mut().add_form(CStr::from_ptr(name).into(), form) Some(form) => form.clone(),
None => return NativeResult::err(PkmnError::NullReference.into()),
};
species.as_mut().add_form(CStr::from_ptr(name).into(), form);
NativeResult::ok(())
} }
/// Gets a form by name. /// Gets a form by name.

View File

@ -64,6 +64,9 @@ use thiserror::Error;
/// that can fail. For uncommon errors, anyhow is used. /// that can fail. For uncommon errors, anyhow is used.
#[derive(Error, Debug)] #[derive(Error, Debug)]
pub enum PkmnError { pub enum PkmnError {
/// The given value was null
#[error("The given value was null")]
NullReference,
/// The given index is out of bounds for the given length of the array. /// The given index is out of bounds for the given length of the array.
#[error("The given index {index} is out of bounds for the given len {len}")] #[error("The given index {index} is out of bounds for the given len {len}")]
IndexOutOfBounds { IndexOutOfBounds {
@ -94,4 +97,13 @@ pub enum PkmnError {
/// The nature that was requested /// The nature that was requested
nature: StringKey, nature: StringKey,
}, },
/// Unable to get species
#[error("Unable to get species {species}")]
InvalidSpeciesName {
/// The species that was requested
species: StringKey,
},
/// The given pointer is not a valid CString
#[error("The given pointer is not a valid CString")]
InvalidCString,
} }

View File

@ -1,3 +1,10 @@
/// The WASM module handles loading dynamic scripts through WebAssembly. /// The WASM module handles loading dynamic scripts through WebAssembly.
#[cfg(feature = "wasm")] #[cfg(feature = "wasm")]
// FIXME: allow these for now until we have a good result interface defined.
#[allow(clippy::unwrap_used)]
#[allow(clippy::expect_used)]
#[allow(clippy::indexing_slicing)]
#[allow(clippy::string_slice)]
#[allow(clippy::exit)]
#[allow(clippy::panic)]
pub mod wasm; pub mod wasm;

View File

@ -78,7 +78,7 @@ register! {
let c_name = CStr::from_ptr(env.data().data().get_raw_pointer(name_ptr)); let c_name = CStr::from_ptr(env.data().data().get_raw_pointer(name_ptr));
let script = side.value_func(&env).unwrap().add_volatile_script(&c_name.as_ref().into()).unwrap(); let script = side.value_func(&env).unwrap().add_volatile_script(&c_name.as_ref().into()).unwrap();
if let Some(script) = script { if let Some(script) = script {
let script = script.get_as::<WebAssemblyScript>(); let script = script.get_as::<WebAssemblyScript>().unwrap();
script.get_wasm_pointer() script.get_wasm_pointer()
} else { } else {
0 0
@ -101,7 +101,7 @@ register! {
if let Some(script) = script { if let Some(script) = script {
let script = side.add_volatile_script_with_script(script); let script = side.add_volatile_script_with_script(script);
let s = script.as_ref().unwrap().as_ref().unwrap().get_as::<WebAssemblyScript>(); let s = script.as_ref().unwrap().as_ref().unwrap().get_as::<WebAssemblyScript>().unwrap();
s.get_wasm_pointer() s.get_wasm_pointer()
} else { } else {
0 0
@ -129,7 +129,7 @@ register! {
let c_name = CStr::from_ptr(env.data().data().get_raw_pointer(name_ptr)); let c_name = CStr::from_ptr(env.data().data().get_raw_pointer(name_ptr));
let script = side.value_func(&env).unwrap().get_volatile_script(&c_name.as_ref().into()); let script = side.value_func(&env).unwrap().get_volatile_script(&c_name.as_ref().into());
if let Some(script) = script { if let Some(script) = script {
let script = script.get_as::<WebAssemblyScript>(); let script = script.get_as::<WebAssemblyScript>().unwrap();
script.get_wasm_pointer() script.get_wasm_pointer()
} else { } else {
0 0
@ -144,7 +144,7 @@ register! {
) { ) {
unsafe { unsafe {
let c_name = CStr::from_ptr(env.data().data().get_raw_pointer(name_ptr)); let c_name = CStr::from_ptr(env.data().data().get_raw_pointer(name_ptr));
side.value_func(&env).unwrap().remove_volatile_script(&c_name.as_ref().into()); side.value_func(&env).unwrap().remove_volatile_script(&c_name.as_ref().into()).unwrap();
} }
} }

View File

@ -413,7 +413,7 @@ register! {
let c_name = CStr::from_ptr(env.data().data().get_raw_pointer(name_ptr)); let c_name = CStr::from_ptr(env.data().data().get_raw_pointer(name_ptr));
let script = pokemon.value_func(&env).unwrap().add_volatile_script(&c_name.as_ref().into()).unwrap(); let script = pokemon.value_func(&env).unwrap().add_volatile_script(&c_name.as_ref().into()).unwrap();
if let Some(script) = script { if let Some(script) = script {
let script = script.get_as::<WebAssemblyScript>(); let script = script.get_as::<WebAssemblyScript>().unwrap();
script.get_wasm_pointer() script.get_wasm_pointer()
} else { } else {
0 0
@ -436,7 +436,7 @@ register! {
if let Some(script) = script { if let Some(script) = script {
let script = pokemon.add_volatile_script_with_script(script); let script = pokemon.add_volatile_script_with_script(script);
let s = script.as_ref().unwrap().as_ref().unwrap().get_as::<WebAssemblyScript>(); let s = script.as_ref().unwrap().as_ref().unwrap().get_as::<WebAssemblyScript>().unwrap();
s.get_wasm_pointer() s.get_wasm_pointer()
} else { } else {
0 0
@ -464,7 +464,7 @@ register! {
let c_name = CStr::from_ptr(env.data().data().get_raw_pointer(name_ptr)); let c_name = CStr::from_ptr(env.data().data().get_raw_pointer(name_ptr));
let script = pokemon.value_func(&env).unwrap().get_volatile_script(&c_name.as_ref().into()); let script = pokemon.value_func(&env).unwrap().get_volatile_script(&c_name.as_ref().into());
if let Some(script) = script { if let Some(script) = script {
let script = script.get_as::<WebAssemblyScript>(); let script = script.get_as::<WebAssemblyScript>().unwrap();
script.get_wasm_pointer() script.get_wasm_pointer()
} else { } else {
0 0
@ -479,7 +479,7 @@ register! {
) { ) {
unsafe { unsafe {
let c_name = CStr::from_ptr(env.data().data().get_raw_pointer(name_ptr)); let c_name = CStr::from_ptr(env.data().data().get_raw_pointer(name_ptr));
pokemon.value_func(&env).unwrap().remove_volatile_script(&c_name.as_ref().into()); pokemon.value_func(&env).unwrap().remove_volatile_script(&c_name.as_ref().into()).unwrap();
} }
} }

View File

@ -1,6 +1,3 @@
// allow these for now until we have a good result interface defined.
#[allow(clippy::unwrap_used)]
#[allow(clippy::expect_used)]
/// The export registry module deals with registering all functions we require in WebAssembly. /// The export registry module deals with registering all functions we require in WebAssembly.
mod export_registry; mod export_registry;
/// A hacky extern ref implementation to ensure the client does not do things it is not allowed to do. /// A hacky extern ref implementation to ensure the client does not do things it is not allowed to do.

View File

@ -1,4 +1,5 @@
use crate::defines::LevelInt; use crate::defines::LevelInt;
use crate::VecExt;
use anyhow::Result; use anyhow::Result;
use anyhow_ext::ensure; use anyhow_ext::ensure;
@ -37,9 +38,12 @@ impl GrowthRate for LookupGrowthRate {
fn calculate_experience(&self, level: LevelInt) -> Result<u32> { fn calculate_experience(&self, level: LevelInt) -> Result<u32> {
ensure!(level > 0, "Level must be greater than 0, but was {}", level); ensure!(level > 0, "Level must be greater than 0, but was {}", level);
if level >= self.experience.len() as LevelInt { if level >= self.experience.len() as LevelInt {
Ok(*self.experience.last().unwrap()) match self.experience.last() {
Some(v) => Ok(*v),
None => anyhow::bail!("No experience values found"),
}
} else { } else {
Ok(self.experience[(level - 1) as usize]) Ok(*self.experience.get_res((level - 1) as usize)?)
} }
} }
} }

View File

@ -1,3 +1,4 @@
use anyhow_ext::Result;
use std::sync::Arc; use std::sync::Arc;
use indexmap::IndexMap; use indexmap::IndexMap;
@ -48,8 +49,11 @@ pub trait DataLibrary<T: ?Sized> {
} }
/// Gets a random value from the library. /// Gets a random value from the library.
fn random_value(&self, rand: &mut Random) -> &Arc<T> { fn random_value(&self, rand: &mut Random) -> Result<&Arc<T>> {
let i = rand.get_between(0, self.len() as i32); let i = rand.get_between(0, self.len() as i32);
return self.map().get_index(i as usize).unwrap().1; match self.map().get_index(i as usize) {
Some(v) => Ok(v.1),
None => anyhow::bail!("No value found for index {}", i),
}
} }
} }

View File

@ -4,6 +4,8 @@ pub use random::Random;
pub use string_key::StringKey; pub use string_key::StringKey;
#[doc(inline)] #[doc(inline)]
pub use value_identifier::*; pub use value_identifier::*;
#[doc(inline)]
pub use vec_ext::*;
/// The random module defines a RNG implementation used in pkmn_lib /// The random module defines a RNG implementation used in pkmn_lib
mod random; mod random;
@ -12,3 +14,5 @@ mod random;
mod string_key; mod string_key;
/// Helper tool to keep track of moving memory for FFI. /// Helper tool to keep track of moving memory for FFI.
mod value_identifier; mod value_identifier;
/// Helper functions for vecs
mod vec_ext;

36
src/utils/vec_ext.rs Normal file
View File

@ -0,0 +1,36 @@
use crate::PkmnError;
use anyhow::Result;
/// Extension trait for `Vec` and `[T]` to provide common helper methods.
pub trait VecExt<T> {
/// Get a mutable reference to an element in the vector, or return an error if the index is out of bounds.
fn get_mut_res(&mut self, index: usize) -> Result<&mut T>;
/// Get a reference to an element in the vector, or return an error if the index is out of bounds.
fn get_res(&self, index: usize) -> Result<&T>;
}
impl<T> VecExt<T> for [T] {
fn get_mut_res(&mut self, index: usize) -> Result<&mut T> {
let len = self.len();
self.get_mut(index)
.ok_or(PkmnError::IndexOutOfBounds { index, len }.into())
}
fn get_res(&self, index: usize) -> Result<&T> {
self.get(index)
.ok_or(PkmnError::IndexOutOfBounds { index, len: self.len() }.into())
}
}
impl<T> VecExt<T> for Vec<T> {
fn get_mut_res(&mut self, index: usize) -> Result<&mut T> {
let len = self.len();
self.get_mut(index)
.ok_or(PkmnError::IndexOutOfBounds { index, len }.into())
}
fn get_res(&self, index: usize) -> Result<&T> {
self.get(index)
.ok_or(PkmnError::IndexOutOfBounds { index, len: self.len() }.into())
}
}

View File

@ -56,7 +56,7 @@ impl TestCase {
} }
let mut battle_parties = Vec::new(); let mut battle_parties = Vec::new();
for party in parties { for party in parties {
battle_parties.push(BattleParty::new(party.0.clone(), party.1)); battle_parties.push(BattleParty::new(party.0.clone(), party.1).unwrap());
} }
let mut battle = Battle::new( let mut battle = Battle::new(
library, library,

View File

@ -99,11 +99,13 @@ fn validate_assurance() {
let party1 = BattleParty::new( let party1 = BattleParty::new(
Arc::new(PokemonParty::new_from_vec(vec![Some(p1.clone())])), Arc::new(PokemonParty::new_from_vec(vec![Some(p1.clone())])),
vec![(0, 0)], vec![(0, 0)],
); )
.unwrap();
let party2 = BattleParty::new( let party2 = BattleParty::new(
Arc::new(PokemonParty::new_from_vec(vec![Some(p2.clone())])), Arc::new(PokemonParty::new_from_vec(vec![Some(p2.clone())])),
vec![(1, 0)], vec![(1, 0)],
); )
.unwrap();
let battle = Battle::new(lib.clone(), vec![party1, party2], false, 2, 1, None); let battle = Battle::new(lib.clone(), vec![party1, party2], false, 2, 1, None);