tiger-lib 1.18.0

Library used by the tools ck3-tiger, vic3-tiger, and imperator-tiger. This library holds the bulk of the code for them. It can be built either for ck3-tiger with the feature ck3, or for vic3-tiger with the feature vic3, or for imperator-tiger with the feature imperator, but not both at the same time.
Documentation
use crate::block::{BV, Block};
use crate::db::{Db, DbKind};
use crate::everything::Everything;
use crate::game::GameFlags;
use crate::item::{Item, ItemLoader};
use crate::report::{ErrorKey, err};
use crate::token::Token;
use crate::validator::Validator;

#[derive(Clone, Debug)]
pub struct SubUnit {}
#[derive(Clone, Debug)]
pub struct SubUnitCategory {}

inventory::submit! {
    ItemLoader::Normal(GameFlags::Hoi4, Item::SubUnit, SubUnit::add)
}
inventory::submit! {
    ItemLoader::Normal(GameFlags::Hoi4, Item::SubUnitCategory, SubUnitCategory::add)
}

impl SubUnit {
    pub fn add(db: &mut Db, key: Token, mut block: Block) {
        if key.is("sub_units") {
            for (key, block) in block.drain_definitions_warn() {
                db.add(Item::SubUnit, key, block, Box::new(Self {}));
            }
        } else {
            let msg = "unexpected key";
            let info = "only `sub_units` is expected here";
            err(ErrorKey::UnknownField).msg(msg).info(info).loc(key).push();
        }
    }
}

impl SubUnitCategory {
    #[allow(clippy::needless_pass_by_value)]
    pub fn add(db: &mut Db, key: Token, block: Block) {
        if key.is("sub_unit_categories") {
            for value in block.iter_values_warn() {
                db.add_flag(Item::SubUnitCategory, value.clone());
            }
        } else {
            let msg = "unexpected key";
            let info = "only `sub_units_categories` is expected here";
            err(ErrorKey::UnknownField).msg(msg).info(info).loc(key).push();
        }
        db.set_flag_validator(Item::SubUnitCategory, |flag, data| {
            data.verify_exists(Item::Localization, flag);
        });
    }
}

impl DbKind for SubUnit {
    fn validate(&self, key: &Token, block: &Block, data: &Everything) {
        let mut vd = Validator::new(block, data);

        data.verify_exists(Item::Localization, key);

        vd.field_value("abbreviation");
        // TODO: figure out what values this can take. It is not a Sprite name.
        vd.field_value("sprite");
        vd.field_integer("priority");
        vd.field_integer("ai_priority");
        vd.field_bool("active");
        vd.field_bool("special_forces");
        vd.field_bool("marines");
        vd.field_bool("can_be_parachuted");
        vd.field_bool("is_artillery_brigade");
        vd.field_bool("cavalry");
        vd.field_bool("affects_speed");
        vd.field_bool("can_exfiltrate_from_coast");
        vd.field_bool("mountaineers");
        vd.field_choice(
            "map_icon_category",
            &["infantry", "armored", "other", "ship", "transport", "uboat"],
        );
        vd.field_item("type", Item::EquipmentCategory);
        vd.field_validated_block("need", |block, data| {
            let mut vd = Validator::new(block, data);
            vd.validate_item_key_values(Item::EquipmentBonusType, |_, mut vd| {
                vd.integer();
            });
        });
        vd.field_choice(
            "group",
            &[
                "armor",
                "mobile",
                "support",
                "combat_support",
                "mobile_combat_support",
                "armor_combat_support",
            ],
        );
        vd.field_list_items("categories", Item::SubUnitCategory);
        vd.field_validated_block("battalion_mult", |block, data| {
            let mut vd = Validator::new(block, data);
            vd.field_item("category", Item::SubUnitCategory);
            vd.field_bool("add");
            vd.advice_field("max_organization", "it's max_organisation with an s");
            vd.unknown_value_fields(|key, value| {
                validate_equipment_stat(key, value, data);
            });
        });

        vd.field_list_items("essential", Item::EquipmentBonusType);
        vd.field_item("transport", Item::EquipmentBonusType);

        vd.field_item("same_support_type", Item::SubUnit);

        vd.field_integer("land_air_wing_size");
        vd.field_integer("carrier_air_wing_size");
        vd.field_integer("mega_carrier_air_wing_size");
        vd.field_integer("combat_width");
        vd.field_integer("manpower");
        vd.field_integer("training_time");
        vd.field_numeric("critical_part_damage_chance_mult");
        vd.field_numeric("hit_profile_mult");

        vd.field_list_items("critical_parts", Item::Localization);

        vd.field_validated_block("need_equipment", |block, data| {
            let mut vd = Validator::new(block, data);
            vd.validate_item_key_values(Item::Equipment, |_, mut vvd| {
                vvd.integer();
            });
        });
        vd.field_validated_block("need_equipment_modules", |block, data| {
            let mut vd = Validator::new(block, data);
            // TODO: figure out what the key is here.
            vd.unknown_block_fields(|_, block| {
                let mut vd = Validator::new(block, data);
                vd.validate_item_key_values(Item::EquipmentModule, |_, mut vvd| {
                    vvd.integer();
                });
            });
        });

        vd.field_validated_block("fort", validate_terrain_values);
        vd.field_validated_block("river", validate_terrain_values);
        vd.field_validated_block("amphibious", validate_terrain_values);
        vd.advice_field("max_organization", "it's max_organisation with an s");
        vd.unknown_fields(|key, bv| match bv {
            BV::Value(value) => {
                validate_equipment_stat(key, value, data);
            }
            BV::Block(block) => {
                if !key.is("snow") {
                    data.verify_exists(Item::Terrain, key);
                }
                validate_terrain_values(block, data);
            }
        });
    }
}

fn validate_terrain_values(block: &Block, data: &Everything) {
    let mut vd = Validator::new(block, data);
    vd.field_numeric("attack");
    vd.field_numeric("movement");
    vd.field_numeric("defence");
}

pub fn validate_equipment_stat(key: &Token, value: &Token, data: &Everything) {
    data.verify_exists(Item::EquipmentStat, key);
    // TODO: distinguish between integer and numeric fields
    value.expect_number();
}