veloren/common/src/comp/inventory/mod.rs

pub mod item;
pub mod slot;

use crate::{assets, recipe::Recipe};
use item::{Item, ItemKind};
use serde::{Deserialize, Serialize};
use specs::{Component, FlaggedStorage, HashMapStorage};
use specs_idvs::IdvStorage;
use std::ops::Not;

// The limit on distance between the entity and a collectible (squared)
pub const MAX_PICKUP_RANGE_SQR: f32 = 64.0;

#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
pub struct Inventory {
    pub slots: Vec<Option<Item>>,
    pub amount: u32,
}

/// Errors which the methods on `Inventory` produce
#[derive(Debug)]
pub enum Error {
    /// The inventory is full and items could not be added. The extra items have
    /// been returned.
    Full(Vec<Item>),
}

#[allow(clippy::len_without_is_empty)] // TODO: Pending review in #587
impl Inventory {
    pub fn slots(&self) -> &[Option<Item>] { &self.slots }

    pub fn len(&self) -> usize { self.slots.len() }

    pub fn recount_items(&mut self) {
        self.amount = self.slots.iter().filter(|i| i.is_some()).count() as u32;
    }

    /// Adds a new item to the first fitting group of the inventory or starts a
    /// new group. Returns the item again if no space was found.
    pub fn push(&mut self, item: Item) -> Option<Item> {
        let item = match &item.kind {
            ItemKind::Tool(_) | ItemKind::Armor { .. } | ItemKind::Lantern(_) => {
                self.add_to_first_empty(item)
            },
            ItemKind::Utility {
                kind: item_kind,
                amount: new_amount,
            } => {
                for slot in &mut self.slots {
                    if slot
                        .as_ref()
                        .map(|s| s.name() == item.name())
                        .unwrap_or(false)
                        && slot
                            .as_ref()
                            .map(|s| s.description() == item.description())
                            .unwrap_or(false)
                    {
                        if let Some(Item {
                            kind: ItemKind::Utility { kind, amount },
                            ..
                        }) = slot
                        {
                            if *item_kind == *kind {
                                *amount += new_amount;
                                self.recount_items();
                                return None;
                            }
                        }
                    }
                }
                // It didn't work
                self.add_to_first_empty(item)
            },
            ItemKind::Consumable {
                kind: item_kind,
                amount: new_amount,
                ..
            } => {
                for slot in &mut self.slots {
                    if slot
                        .as_ref()
                        .map(|s| s.name() == item.name())
                        .unwrap_or(false)
                        && slot
                            .as_ref()
                            .map(|s| s.description() == item.description())
                            .unwrap_or(false)
                    {
                        if let Some(Item {
                            kind: ItemKind::Consumable { kind, amount, .. },
                            ..
                        }) = slot
                        {
                            if *item_kind == *kind {
                                *amount += new_amount;
                                self.recount_items();
                                return None;
                            }
                        }
                    }
                }
                // It didn't work
                self.add_to_first_empty(item)
            },
            ItemKind::Throwable {
                kind: item_kind,
                amount: new_amount,
                ..
            } => {
                for slot in &mut self.slots {
                    if slot
                        .as_ref()
                        .map(|s| s.name() == item.name())
                        .unwrap_or(false)
                        && slot
                            .as_ref()
                            .map(|s| s.description() == item.description())
                            .unwrap_or(false)
                    {
                        if let Some(Item {
                            kind: ItemKind::Throwable { kind, amount, .. },
                            ..
                        }) = slot
                        {
                            if *item_kind == *kind {
                                *amount += new_amount;
                                self.recount_items();
                                return None;
                            }
                        }
                    }
                }
                // It didn't work
                self.add_to_first_empty(item)
            },
            ItemKind::Ingredient {
                kind: item_kind,
                amount: new_amount,
            } => {
                for slot in &mut self.slots {
                    if slot
                        .as_ref()
                        .map(|s| s.name() == item.name())
                        .unwrap_or(false)
                        && slot
                            .as_ref()
                            .map(|s| s.description() == item.description())
                            .unwrap_or(false)
                    {
                        if let Some(Item {
                            kind: ItemKind::Ingredient { kind, amount },
                            ..
                        }) = slot
                        {
                            if *item_kind == *kind {
                                *amount += new_amount;
                                self.recount_items();
                                return None;
                            }
                        }
                    }
                }
                // It didn't work
                self.add_to_first_empty(item)
            },
        };
        self.recount_items();
        item
    }

    /// Adds a new item to the first empty slot of the inventory. Returns the
    /// item again if no free slot was found.
    fn add_to_first_empty(&mut self, item: Item) -> Option<Item> {
        let item = match self.slots.iter_mut().find(|slot| slot.is_none()) {
            Some(slot) => {
                *slot = Some(item);
                None
            },
            None => Some(item),
        };
        self.recount_items();
        item
    }

    /// Add a series of items to inventory, returning any which do not fit as an
    /// error.
    pub fn push_all<I: Iterator<Item = Item>>(&mut self, items: I) -> Result<(), Error> {
        // Vec doesn't allocate for zero elements so this should be cheap
        let mut leftovers = Vec::new();
        for item in items {
            if let Some(item) = self.push(item) {
                leftovers.push(item);
            }
        }
        self.recount_items();
        if !leftovers.is_empty() {
            Err(Error::Full(leftovers))
        } else {
            Ok(())
        }
    }

    /// Add a series of items to an inventory without giving duplicates.
    /// (n * m complexity)
    ///
    /// Error if inventory cannot contain the items (is full), returning the
    /// un-added items. This is a lazy inefficient implementation, as it
    /// iterates over the inventory more times than necessary (n^2) and with
    /// the proper structure wouldn't need to iterate at all, but because
    /// this should be fairly cold code, clarity has been favored over
    /// efficiency.
    pub fn push_all_unique<I: Iterator<Item = Item>>(&mut self, mut items: I) -> Result<(), Error> {
        let mut leftovers = Vec::new();
        for item in &mut items {
            if self.contains(&item).not() {
                self.push(item).map(|overflow| leftovers.push(overflow));
            } // else drop item if it was already in
        }
        if !leftovers.is_empty() {
            Err(Error::Full(leftovers))
        } else {
            Ok(())
        }
    }

    /// Replaces an item in a specific slot of the inventory. Returns the old
    /// item or the same item again if that slot was not found.
    pub fn insert(&mut self, cell: usize, item: Item) -> Result<Option<Item>, Item> {
        match self.slots.get_mut(cell) {
            Some(slot) => {
                let old = slot.take();
                *slot = Some(item);
                self.recount_items();
                Ok(old)
            },
            None => Err(item),
        }
    }

    /// Checks if inserting item exists in given cell. Inserts an item if it
    /// exists.
    pub fn insert_or_stack(&mut self, cell: usize, item: Item) -> Result<Option<Item>, Item> {
        match &item.kind {
            ItemKind::Tool(_) | ItemKind::Armor { .. } | ItemKind::Lantern(_) => {
                self.insert(cell, item)
            },
            ItemKind::Utility {
                amount: new_amount, ..
            } => match self.slots.get_mut(cell) {
                Some(Some(slot_item)) => {
                    if slot_item.name() == item.name()
                        && slot_item.description() == item.description()
                    {
                        if let Item {
                            kind: ItemKind::Utility { amount, .. },
                            ..
                        } = slot_item
                        {
                            *amount += *new_amount;
                            self.recount_items();
                            Ok(None)
                        } else {
                            let old_item = std::mem::replace(slot_item, item);
                            self.recount_items();
                            Ok(Some(old_item))
                        }
                    } else {
                        let old_item = std::mem::replace(slot_item, item);
                        self.recount_items();
                        Ok(Some(old_item))
                    }
                },
                Some(None) => self.insert(cell, item),
                None => Err(item),
            },
            ItemKind::Ingredient {
                amount: new_amount, ..
            } => match self.slots.get_mut(cell) {
                Some(Some(slot_item)) => {
                    if slot_item.name() == item.name()
                        && slot_item.description() == item.description()
                    {
                        if let Item {
                            kind: ItemKind::Ingredient { amount, .. },
                            ..
                        } = slot_item
                        {
                            *amount += *new_amount;
                            self.recount_items();
                            Ok(None)
                        } else {
                            let old_item = std::mem::replace(slot_item, item);
                            self.recount_items();
                            Ok(Some(old_item))
                        }
                    } else {
                        let old_item = std::mem::replace(slot_item, item);
                        self.recount_items();
                        Ok(Some(old_item))
                    }
                },
                Some(None) => self.insert(cell, item),
                None => Err(item),
            },
            ItemKind::Consumable {
                amount: new_amount, ..
            } => match self.slots.get_mut(cell) {
                Some(Some(slot_item)) => {
                    if slot_item.name() == item.name()
                        && slot_item.description() == item.description()
                    {
                        if let Item {
                            kind: ItemKind::Consumable { amount, .. },
                            ..
                        } = slot_item
                        {
                            *amount += *new_amount;
                            self.recount_items();
                            Ok(None)
                        } else {
                            let old_item = std::mem::replace(slot_item, item);
                            self.recount_items();
                            Ok(Some(old_item))
                        }
                    } else {
                        let old_item = std::mem::replace(slot_item, item);
                        self.recount_items();
                        Ok(Some(old_item))
                    }
                },
                Some(None) => self.insert(cell, item),
                None => Err(item),
            },
            ItemKind::Throwable {
                amount: new_amount, ..
            } => match self.slots.get_mut(cell) {
                Some(Some(slot_item)) => {
                    if slot_item.name() == item.name()
                        && slot_item.description() == item.description()
                    {
                        if let Item {
                            kind: ItemKind::Throwable { amount, .. },
                            ..
                        } = slot_item
                        {
                            *amount += *new_amount;
                            self.recount_items();
                            Ok(None)
                        } else {
                            let old_item = std::mem::replace(slot_item, item);
                            self.recount_items();
                            Ok(Some(old_item))
                        }
                    } else {
                        let old_item = std::mem::replace(slot_item, item);
                        self.recount_items();
                        Ok(Some(old_item))
                    }
                },
                Some(None) => self.insert(cell, item),
                None => Err(item),
            },
        }
    }

    pub fn is_full(&self) -> bool { self.slots.iter().all(|slot| slot.is_some()) }

    /// O(n) count the number of items in this inventory.
    pub fn count(&self) -> usize { self.slots.iter().filter_map(|slot| slot.as_ref()).count() }

    /// O(n) check if an item is in this inventory.
    pub fn contains(&self, item: &Item) -> bool {
        self.slots.iter().any(|slot| slot.as_ref() == Some(item))
    }

    /// Get content of a slot
    pub fn get(&self, cell: usize) -> Option<&Item> {
        self.slots.get(cell).and_then(Option::as_ref)
    }

    /// Swap the items inside of two slots
    pub fn swap_slots(&mut self, a: usize, b: usize) {
        if a.max(b) < self.slots.len() {
            self.slots.swap(a, b);
        }
    }

    /// Remove an item from the slot
    pub fn remove(&mut self, cell: usize) -> Option<Item> {
        let item = self.slots.get_mut(cell).and_then(|item| item.take());
        self.recount_items();
        item
    }

    /// Remove just one item from the slot
    pub fn take(&mut self, cell: usize) -> Option<Item> {
        if let Some(Some(item)) = self.slots.get_mut(cell) {
            let mut return_item = item.clone();
            match &mut item.kind {
                ItemKind::Tool(_) | ItemKind::Armor { .. } | ItemKind::Lantern(_) => {
                    self.remove(cell)
                },
                ItemKind::Utility { kind, amount } => {
                    if *amount <= 1 {
                        self.remove(cell)
                    } else {
                        *amount -= 1;
                        return_item.kind = ItemKind::Utility {
                            kind: *kind,
                            amount: 1,
                        };
                        self.recount_items();
                        Some(return_item)
                    }
                },
                ItemKind::Consumable {
                    kind,
                    amount,
                    effect,
                } => {
                    if *amount <= 1 {
                        self.remove(cell)
                    } else {
                        *amount -= 1;
                        return_item.kind = ItemKind::Consumable {
                            kind: kind.clone(),
                            effect: *effect,
                            amount: 1,
                        };
                        self.recount_items();
                        Some(return_item)
                    }
                },
                ItemKind::Throwable { kind, amount } => {
                    if *amount <= 1 {
                        self.remove(cell)
                    } else {
                        *amount -= 1;
                        return_item.kind = ItemKind::Throwable {
                            kind: *kind,
                            amount: 1,
                        };
                        self.recount_items();
                        Some(return_item)
                    }
                },
                ItemKind::Ingredient { kind, amount } => {
                    if *amount <= 1 {
                        self.remove(cell)
                    } else {
                        *amount -= 1;
                        return_item.kind = ItemKind::Ingredient {
                            kind: kind.clone(),
                            amount: 1,
                        };
                        self.recount_items();
                        Some(return_item)
                    }
                },
            }
        } else {
            None
        }
    }

    /// Determine how many of a particular item there is in the inventory.
    pub fn item_count(&self, item: &Item) -> usize {
        self.slots()
            .iter()
            .flatten()
            .filter(|it| it.superficially_eq(item))
            .map(|it| it.amount() as usize)
            .sum()
    }

    /// Determine whether the inventory contains the ingredients for a recipe.
    /// If it does, return a vector of numbers, where is number corresponds
    /// to an inventory slot, along with the number of items that need
    /// removing from it. It items are missing, return the missing items, and
    /// how many are missing.
    pub fn contains_ingredients<'a>(
        &self,
        recipe: &'a Recipe,
    ) -> Result<Vec<usize>, Vec<(&'a Item, usize)>> {
        let mut slot_claims = vec![0; self.slots.len()];
        let mut missing = Vec::new();

        for (input, mut needed) in recipe.inputs() {
            let mut contains_any = false;

            for (i, slot) in self.slots().iter().enumerate() {
                if let Some(item) = slot.as_ref().filter(|item| item.superficially_eq(input)) {
                    let can_claim = (item.amount() as usize - slot_claims[i]).min(needed);
                    slot_claims[i] += can_claim;
                    needed -= can_claim;
                    contains_any = true;
                }
            }

            if needed > 0 || !contains_any {
                missing.push((input, needed));
            }
        }

        if missing.len() == 0 {
            Ok(slot_claims)
        } else {
            Err(missing)
        }
    }
}

impl Default for Inventory {
    fn default() -> Inventory {
        let mut inventory = Inventory {
            slots: vec![None; 36],
            amount: 0,
        };
        inventory.push(assets::load_expect_cloned("common.items.food.cheese"));
        inventory.push(assets::load_expect_cloned("common.items.food.apple"));
        inventory
    }
}

impl Component for Inventory {
    type Storage = HashMapStorage<Self>;
}

#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
pub enum InventoryUpdateEvent {
    Init,
    Used,
    Consumed(String),
    Gave,
    Given,
    Swapped,
    Dropped,
    Collected(Item),
    CollectFailed,
    Possession,
    Debug,
    Craft,
}

impl Default for InventoryUpdateEvent {
    fn default() -> Self { Self::Init }
}

#[derive(Clone, Debug, Default, Serialize, Deserialize)]
pub struct InventoryUpdate {
    event: InventoryUpdateEvent,
}

impl InventoryUpdate {
    pub fn new(event: InventoryUpdateEvent) -> Self { Self { event } }

    pub fn event(&self) -> InventoryUpdateEvent { self.event.clone() }
}

impl Component for InventoryUpdate {
    type Storage = FlaggedStorage<Self, IdvStorage<Self>>;
}

#[cfg(test)] mod test;