wow_dbc 0.3.0

Library for parsing World of Warcraft DBC files for 1.12, 2.4.3 and 3.3.5.
Documentation
use crate::{
    DbcTable, ExtendedLocalizedString, Indexable,
};
use crate::header::{
    DbcHeader, HEADER_SIZE, parse_header,
};
use std::io::Write;

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct BattlemasterList {
    pub rows: Vec<BattlemasterListRow>,
}

impl DbcTable for BattlemasterList {
    type Row = BattlemasterListRow;

    const FILENAME: &'static str = "BattlemasterList.dbc";

    fn rows(&self) -> &[Self::Row] { &self.rows }
    fn rows_mut(&mut self) -> &mut [Self::Row] { &mut self.rows }

    fn read(b: &mut impl std::io::Read) -> Result<Self, crate::DbcError> {
        let mut header = [0_u8; HEADER_SIZE];
        b.read_exact(&mut header)?;
        let header = parse_header(&header)?;

        if header.record_size != 132 {
            return Err(crate::DbcError::InvalidHeader(
                crate::InvalidHeaderError::RecordSize {
                    expected: 132,
                    actual: header.record_size,
                },
            ));
        }

        if header.field_count != 33 {
            return Err(crate::DbcError::InvalidHeader(
                crate::InvalidHeaderError::FieldCount {
                    expected: 33,
                    actual: header.field_count,
                },
            ));
        }

        let mut r = vec![0_u8; (header.record_count * header.record_size) as usize];
        b.read_exact(&mut r)?;
        let mut string_block = vec![0_u8; header.string_block_size as usize];
        b.read_exact(&mut string_block)?;

        let mut rows = Vec::with_capacity(header.record_count as usize);

        for mut chunk in r.chunks(header.record_size as usize) {
            let chunk = &mut chunk;

            // id: primary_key (BattlemasterList) int32
            let id = BattlemasterListKey::new(crate::util::read_i32_le(chunk)?);

            // map_id: int32[8]
            let map_id = crate::util::read_array_i32::<8>(chunk)?;

            // instance_type: int32
            let instance_type = crate::util::read_i32_le(chunk)?;

            // min_level: int32
            let min_level = crate::util::read_i32_le(chunk)?;

            // max_level: int32
            let max_level = crate::util::read_i32_le(chunk)?;

            // field_2_0_0_5610_005: int32
            let field_2_0_0_5610_005 = crate::util::read_i32_le(chunk)?;

            // field_2_0_0_5610_006: int32
            let field_2_0_0_5610_006 = crate::util::read_i32_le(chunk)?;

            // groups_allowed: int32
            let groups_allowed = crate::util::read_i32_le(chunk)?;

            // name_lang: string_ref_loc (Extended)
            let name_lang = crate::util::read_extended_localized_string(chunk, &string_block)?;

            // field_2_4_0_8089_009: int32
            let field_2_4_0_8089_009 = crate::util::read_i32_le(chunk)?;


            rows.push(BattlemasterListRow {
                id,
                map_id,
                instance_type,
                min_level,
                max_level,
                field_2_0_0_5610_005,
                field_2_0_0_5610_006,
                groups_allowed,
                name_lang,
                field_2_4_0_8089_009,
            });
        }

        Ok(BattlemasterList { rows, })
    }

    fn write(&self, b: &mut impl Write) -> Result<(), std::io::Error> {
        let header = DbcHeader {
            record_count: self.rows.len() as u32,
            field_count: 33,
            record_size: 132,
            string_block_size: self.string_block_size(),
        };

        b.write_all(&header.write_header())?;

        let mut string_index = 1;
        for row in &self.rows {
            // id: primary_key (BattlemasterList) int32
            b.write_all(&row.id.id.to_le_bytes())?;

            // map_id: int32[8]
            for i in row.map_id {
                b.write_all(&i.to_le_bytes())?;
            }


            // instance_type: int32
            b.write_all(&row.instance_type.to_le_bytes())?;

            // min_level: int32
            b.write_all(&row.min_level.to_le_bytes())?;

            // max_level: int32
            b.write_all(&row.max_level.to_le_bytes())?;

            // field_2_0_0_5610_005: int32
            b.write_all(&row.field_2_0_0_5610_005.to_le_bytes())?;

            // field_2_0_0_5610_006: int32
            b.write_all(&row.field_2_0_0_5610_006.to_le_bytes())?;

            // groups_allowed: int32
            b.write_all(&row.groups_allowed.to_le_bytes())?;

            // name_lang: string_ref_loc (Extended)
            b.write_all(&row.name_lang.string_indices_as_array(&mut string_index))?;

            // field_2_4_0_8089_009: int32
            b.write_all(&row.field_2_4_0_8089_009.to_le_bytes())?;

        }

        self.write_string_block(b)?;

        Ok(())
    }

}

impl Indexable for BattlemasterList {
    type PrimaryKey = BattlemasterListKey;
    fn get(&self, key: impl TryInto<Self::PrimaryKey>) -> Option<&Self::Row> {
        let key = key.try_into().ok()?;
        self.rows.iter().find(|a| a.id.id == key.id)
    }

    fn get_mut(&mut self, key: impl TryInto<Self::PrimaryKey>) -> Option<&mut Self::Row> {
        let key = key.try_into().ok()?;
        self.rows.iter_mut().find(|a| a.id.id == key.id)
    }
}

impl BattlemasterList {
    fn write_string_block(&self, b: &mut impl Write) -> Result<(), std::io::Error> {
        b.write_all(&[0])?;

        for row in &self.rows {
            row.name_lang.string_block_as_array(b)?;
        }

        Ok(())
    }

    fn string_block_size(&self) -> u32 {
        let mut sum = 1;
        for row in &self.rows {
            sum += row.name_lang.string_block_size();
        }

        sum as u32
    }

}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Ord, PartialOrd, Hash, Default)]
pub struct BattlemasterListKey {
    pub id: i32
}

impl BattlemasterListKey {
    pub const fn new(id: i32) -> Self {
        Self { id }
    }

}

impl From<u8> for BattlemasterListKey {
    fn from(v: u8) -> Self {
        Self::new(v.into())
    }
}

impl From<u16> for BattlemasterListKey {
    fn from(v: u16) -> Self {
        Self::new(v.into())
    }
}

impl From<i8> for BattlemasterListKey {
    fn from(v: i8) -> Self {
        Self::new(v.into())
    }
}

impl From<i16> for BattlemasterListKey {
    fn from(v: i16) -> Self {
        Self::new(v.into())
    }
}

impl From<i32> for BattlemasterListKey {
    fn from(v: i32) -> Self {
        Self::new(v)
    }
}

impl TryFrom<u32> for BattlemasterListKey {
    type Error = u32;
    fn try_from(v: u32) -> Result<Self, Self::Error> {
        Ok(TryInto::<i32>::try_into(v).ok().ok_or(v)?.into())
    }
}

impl TryFrom<usize> for BattlemasterListKey {
    type Error = usize;
    fn try_from(v: usize) -> Result<Self, Self::Error> {
        Ok(TryInto::<i32>::try_into(v).ok().ok_or(v)?.into())
    }
}

impl TryFrom<u64> for BattlemasterListKey {
    type Error = u64;
    fn try_from(v: u64) -> Result<Self, Self::Error> {
        Ok(TryInto::<i32>::try_into(v).ok().ok_or(v)?.into())
    }
}

impl TryFrom<i64> for BattlemasterListKey {
    type Error = i64;
    fn try_from(v: i64) -> Result<Self, Self::Error> {
        Ok(TryInto::<i32>::try_into(v).ok().ok_or(v)?.into())
    }
}

impl TryFrom<isize> for BattlemasterListKey {
    type Error = isize;
    fn try_from(v: isize) -> Result<Self, Self::Error> {
        Ok(TryInto::<i32>::try_into(v).ok().ok_or(v)?.into())
    }
}

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct BattlemasterListRow {
    pub id: BattlemasterListKey,
    pub map_id: [i32; 8],
    pub instance_type: i32,
    pub min_level: i32,
    pub max_level: i32,
    pub field_2_0_0_5610_005: i32,
    pub field_2_0_0_5610_006: i32,
    pub groups_allowed: i32,
    pub name_lang: ExtendedLocalizedString,
    pub field_2_4_0_8089_009: i32,
}