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::Block;
use crate::ck3::modif::ModifKinds;
use crate::ck3::validate::validate_cost;
use crate::context::ScopeContext;
use crate::db::{Db, DbKind};
use crate::everything::Everything;
use crate::game::GameFlags;
use crate::item::{Item, ItemLoader};
use crate::modif::validate_modifs;
use crate::report::Severity;
use crate::scopes::Scopes;
use crate::token::Token;
use crate::tooltipped::Tooltipped;
use crate::validator::{Validator, ValueValidator};

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

inventory::submit! {
    ItemLoader::Normal(GameFlags::Ck3, Item::House, House::add)
}

impl House {
    pub fn add(db: &mut Db, key: Token, block: Block) {
        db.add(Item::House, key, block, Box::new(Self {}));
    }

    pub fn get_dynasty<'a>(key: &str, data: &'a Everything) -> Option<&'a Token> {
        data.database
            .get_key_block(Item::House, key)
            .and_then(|(_, block)| block.get_field_value("dynasty"))
    }
}

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

        vd.req_field("name");
        vd.req_field("dynasty");

        vd.field_item("name", Item::Localization);
        vd.field_item("prefix", Item::Localization);
        vd.field_item("motto", Item::Localization);
        vd.field_item("dynasty", Item::Dynasty);
        vd.field_value("forced_coa_religiongroup"); // TODO
    }
}

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

inventory::submit! {
    ItemLoader::Normal(GameFlags::Ck3, Item::HouseAspiration, HouseAspiration::add)
}

impl HouseAspiration {
    pub fn add(db: &mut Db, key: Token, block: Block) {
        db.add(Item::HouseAspiration, key, block, Box::new(Self {}));
    }
}

impl DbKind for HouseAspiration {
    fn add_subitems(&self, _key: &Token, block: &Block, db: &mut Db) {
        for block in block.get_field_blocks("level") {
            if let Some(block) = block.get_field_block("parameters") {
                for (key, value) in block.iter_assignments() {
                    if value.lowercase_is("yes") || value.lowercase_is("no") {
                        db.add_flag(Item::BooleanHouseAspirationParameter, key.clone());
                    }
                }
            }
            if let Some(block) = block.get_field_block("house_head_parameters") {
                for (key, value) in block.iter_assignments() {
                    if value.lowercase_is("yes") || value.lowercase_is("no") {
                        db.add_flag(Item::BooleanHouseHeadParameter, key.clone());
                    }
                }
            }
        }
    }

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

        let loca = format!("{key}_house_power");
        data.verify_exists_implied(Item::Localization, &loca, key);

        data.verify_icon("NGameIcons|HOUSE_POWER_BONUS_ICON_PATH", key, ".dds");

        vd.field_bool("show_in_main_hud");
        vd.field_trigger_rooted("is_shown", Tooltipped::No, Scopes::DynastyHouse);

        vd.field_bool("is_default");

        vd.req_field("level");
        vd.multi_field_validated_block("level", |block, data| {
            let mut vd = Validator::new(block, data);
            vd.field_validated_key_block("cost", |key, block, data| {
                let mut sc = ScopeContext::new(Scopes::Character, key);
                validate_cost(block, data, &mut sc);
            });
            for field in &[
                "powerful_family_top_liege_modifier",
                "powerful_family_member_modifier",
                "any_house_member_modifier",
                "house_head_modifier",
            ] {
                vd.field_validated_block(field, |block, data| {
                    let vd = Validator::new(block, data);
                    validate_modifs(block, data, ModifKinds::Character, vd);
                });
            }

            vd.field_script_value_no_breakdown_rooted("ai_score", Scopes::Character);
            for field in &["parameters", "house_head_parameters"] {
                vd.field_validated_block(field, |block, data| {
                    let mut vd = Validator::new(block, data);
                    vd.unknown_value_fields(|key, value| {
                        let loca = format!("house_power_parameter_{key}");
                        data.verify_exists_implied(Item::Localization, &loca, key);

                        let mut vvd = ValueValidator::new(value, data);
                        vvd.bool();
                    });
                });
            }

            vd.field_bool("can_request_great_project_contributions_from_allies");
            vd.field_trigger_rooted("can_upgrade", Tooltipped::Yes, Scopes::Character);
        });

        vd.field_item("illustration", Item::File);

        // TODO: figure out if this takes script values, and if so, what's the scope context.
        vd.field_validated_block("cooldown", |block, data| {
            let mut vd = Validator::new(block, data);
            vd.field_integer("days");
            vd.field_integer("weeks");
            vd.field_integer("months");
            vd.field_integer("years");
        });

        for field in &["on_changed", "on_upgraded"] {
            vd.field_effect_builder(field, Tooltipped::Yes, |key| {
                let mut sc = ScopeContext::new(Scopes::Character, key);
                sc.define_name("house", Scopes::DynastyHouse, key);
                sc
            });
        }

        // undocumented

        vd.field_item("confederation_type", Item::ConfederationType);
    }
}

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

inventory::submit! {
    ItemLoader::Normal(GameFlags::Ck3, Item::HouseRelationType, HouseRelationType::add)
}

impl HouseRelationType {
    pub fn add(db: &mut Db, key: Token, block: Block) {
        db.add(Item::HouseRelationType, key, block, Box::new(Self {}));
    }
}

impl DbKind for HouseRelationType {
    fn add_subitems(&self, _key: &Token, block: &Block, db: &mut Db) {
        if let Some(block) = block.get_field_block("levels") {
            for (key, block) in block.iter_definitions() {
                db.add_flag(Item::HouseRelationLevel, key.clone());
                if let Some(block) = block.get_field_block("parameters") {
                    for value in block.iter_values() {
                        db.add_flag(Item::BooleanHouseRelationParameter, value.clone());
                    }
                }
            }
        }
    }

    fn validate(&self, key: &Token, block: &Block, data: &Everything) {
        data.verify_exists(Item::Localization, key);

        let mut vd = Validator::new(block, data);
        // TODO: check that the level is part of this relation type
        vd.field_item("neutral_level", Item::HouseRelationLevel);

        vd.field_trigger_builder("is_valid_to_start", Tooltipped::No, |key| {
            let mut sc = ScopeContext::new(Scopes::None, key);
            sc.define_name("house_1", Scopes::DynastyHouse, key);
            sc.define_name("house_2", Scopes::DynastyHouse, key);
            sc
        });

        vd.field_trigger_builder("is_valid_to_keep", Tooltipped::No, |key| {
            let mut sc = ScopeContext::new(Scopes::HouseRelation, key);
            sc.define_name("house_1", Scopes::DynastyHouse, key);
            sc.define_name("house_2", Scopes::DynastyHouse, key);
            sc
        });

        vd.req_field("levels");
        vd.field_validated_block("levels", |block, data| {
            let mut vd = Validator::new(block, data);
            vd.unknown_block_fields(|k, block| {
                let loca = format!("{key}_level_{k}");
                data.verify_exists_implied(Item::Localization, &loca, key);
                let loca = format!("{key}_level_{k}_desc");
                data.verify_exists_implied(Item::Localization, &loca, key);
                if let Some(icon_path) = data.get_defined_string_warn(
                    k,
                    "NGameIcons|HOUSE_RELATION_LEVEL_RENDERED_ICON_PATH",
                ) {
                    let pathname = format!("{icon_path}/{key}_level_{k}_rendered_icon.dds");
                    data.verify_exists_implied_max_sev(Item::File, &pathname, k, Severity::Warning);
                }
                if let Some(icon_path) = data
                    .get_defined_string_warn(k, "NGameIcons|HOUSE_RELATION_LEVEL_FLAT_ICON_PATH")
                {
                    let pathname = format!("{icon_path}/{key}_level_{k}_flat_icon.dds");
                    data.verify_exists_implied_max_sev(Item::File, &pathname, k, Severity::Warning);
                }

                let mut vd = Validator::new(block, data);
                vd.field_integer("opinion");
                vd.field_integer("cohesion_contribution");
                vd.field_validated_list("parameters", |value, data| {
                    let loca = format!("house_relation_parameter_{value}");
                    data.verify_exists_implied(Item::Localization, &loca, value);
                });
            });
        });
    }
}