tiger-lib 1.17.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
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
use std::path::PathBuf;

use crate::block::{BV, Block};
use crate::everything::Everything;
use crate::fileset::{FileEntry, FileHandler};
use crate::game::Game;
use crate::helpers::{TigerHashMap, TigerHashSet, dup_error};
use crate::item::Item;
use crate::parse::ParserMemory;
use crate::pdxfile::PdxFile;
#[cfg(feature = "jomini")]
use crate::report::{Confidence, Severity};
use crate::report::{ErrorKey, warn};
use crate::token::Token;
use crate::util::SmartJoin;
#[cfg(feature = "jomini")]
use crate::validate::validate_numeric_range;
use crate::validator::Validator;

#[derive(Clone, Debug, Default)]
#[allow(clippy::struct_field_names)]
pub struct Assets {
    assets: TigerHashMap<&'static str, Asset>,
    attributes: TigerHashSet<Token>,
    blend_shapes: TigerHashSet<Token>,
    musics: TigerHashSet<Token>,
    textures: TigerHashMap<String, (FileEntry, Token)>,
}

impl Assets {
    pub fn load_item(&mut self, key: &Token, block: &Block) {
        if let Some(name) = block.get_field_value("name") {
            if let Some(other) = self.assets.get(name.as_str()) {
                if other.key.loc.kind >= name.loc.kind {
                    dup_error(name, &other.key, "asset");
                }
            }
            self.assets.insert(name.as_str(), Asset::new(key.clone(), name.clone(), block.clone()));
        }
    }

    pub fn asset_exists(&self, key: &str) -> bool {
        self.assets.contains_key(key)
    }

    pub fn iter_asset_keys(&self) -> impl Iterator<Item = &Token> {
        self.assets.values().map(|item| &item.name)
    }

    #[cfg(feature = "jomini")]
    pub fn mesh_exists(&self, key: &str) -> bool {
        if let Some(asset) = self.assets.get(key) { asset.key.is("pdxmesh") } else { false }
    }

    #[cfg(feature = "jomini")]
    pub fn iter_mesh_keys(&self) -> impl Iterator<Item = &Token> {
        self.assets.values().filter(|item| item.key.is("pdxmesh")).map(|item| &item.name)
    }

    pub fn entity_exists(&self, key: &str) -> bool {
        if let Some(asset) = self.assets.get(key) { asset.key.is("entity") } else { false }
    }

    pub fn iter_entity_keys(&self) -> impl Iterator<Item = &Token> {
        self.assets.values().filter(|item| item.key.is("entity")).map(|item| &item.name)
    }

    pub fn blend_shape_exists(&self, key: &str) -> bool {
        self.blend_shapes.contains(key)
    }

    pub fn iter_blend_shape_keys(&self) -> impl Iterator<Item = &Token> {
        self.blend_shapes.iter()
    }

    #[cfg(feature = "jomini")]
    pub fn attribute_exists(&self, key: &str) -> bool {
        self.attributes.contains(key)
    }

    #[cfg(feature = "jomini")]
    pub fn iter_attribute_keys(&self) -> impl Iterator<Item = &Token> {
        self.attributes.iter()
    }

    #[cfg(feature = "hoi4")]
    pub fn music_exists(&self, key: &str) -> bool {
        self.musics.contains(key)
    }

    #[cfg(feature = "hoi4")]
    pub fn iter_music_keys(&self) -> impl Iterator<Item = &Token> {
        self.musics.iter()
    }

    pub fn texture_exists(&self, key: &str) -> bool {
        self.textures.contains_key(key)
    }

    pub fn iter_texture_keys(&self) -> impl Iterator<Item = &Token> {
        self.textures.values().map(|(_, token)| token)
    }

    pub fn get_texture(&self, key: &str) -> Option<&FileEntry> {
        self.textures.get(key).map(|(entry, _)| entry)
    }

    pub fn validate(&self, data: &Everything) {
        for item in self.assets.values() {
            item.validate(data);
        }
    }
}

impl FileHandler<Option<Block>> for Assets {
    fn subpath(&self) -> PathBuf {
        PathBuf::from("gfx/models")
    }

    /// TODO: should probably simplify this `FileHandler` by keeping the textures in a separate `FileHandler`.
    fn load_file(&self, entry: &FileEntry, parser: &ParserMemory) -> Option<Option<Block>> {
        let name = entry.filename().to_string_lossy();

        if name.ends_with(".dds") {
            Some(None)
        } else if name.ends_with(".asset") {
            PdxFile::read_optional_bom(entry, parser).map(Some)
        } else {
            None
        }
    }

    fn handle_file(&mut self, entry: &FileEntry, loaded: Option<Block>) {
        let name = entry.filename().to_string_lossy();
        if name.ends_with(".dds") {
            if let Some((other, _)) = self.textures.get(&*name) {
                if other.kind() >= entry.kind() {
                    warn(ErrorKey::DuplicateItem)
                        .msg("texture file is redefined by another file")
                        .loc(other)
                        .loc_msg(entry, "the other file is here")
                        .push();
                }
            }
            let entry_token = Token::new(&entry.filename().to_string_lossy(), entry.into());
            self.textures.insert(name.to_string(), (entry.clone(), entry_token));
            return;
        }

        let block = loaded.expect("internal error");
        for (key, block) in block.iter_definitions_warn() {
            self.load_item(key, block);
        }
    }

    fn finalize(&mut self) {
        for asset in self.assets.values() {
            if asset.key.is("pdxmesh") {
                for (key, block) in asset.block.iter_definitions() {
                    if key.is("blend_shape") {
                        if let Some(id) = block.get_field_value("id") {
                            self.blend_shapes.insert(id.clone());
                        }
                    }
                }
            } else if asset.key.is("entity") {
                for (key, block) in asset.block.iter_definitions() {
                    if key.is("attribute") {
                        if let Some(name) = block.get_field_value("name") {
                            self.attributes.insert(name.clone());
                        }
                    }
                }
            } else if asset.key.is("music") {
                self.musics.insert(asset.name.clone());
            }
        }
    }
}

#[derive(Clone, Debug)]
pub struct Asset {
    key: Token,
    name: Token,
    block: Block,
}

impl Asset {
    pub fn new(key: Token, name: Token, block: Block) -> Self {
        Self { key, name, block }
    }

    pub fn validate_mesh(&self, data: &Everything) {
        let mut vd = Validator::new(&self.block, data);
        vd.field_value("name");
        vd.req_field("file");
        if let Some(token) = vd.field_value("file") {
            let path = self.key.loc.pathname().smart_join_parent(token.as_str());
            data.verify_exists_implied(Item::File, &path.to_string_lossy(), token);
        }
        vd.field_numeric("scale");
        vd.field_numeric("cull_distance");

        vd.multi_field_validated_block("lod_percentages", |block, data| {
            let mut vd = Validator::new(block, data);
            vd.multi_field_validated_block("lod", |block, data| {
                let mut vd = Validator::new(block, data);
                vd.req_field("index");
                vd.req_field("percent");
                vd.field_integer("index");
                vd.field_precise_numeric("percent");
            });
        });

        vd.multi_field_validated_block("meshsettings", validate_meshsettings);
        vd.multi_field_validated_block("blend_shape", |block, data| {
            let mut vd = Validator::new(block, data);
            vd.req_field("id");
            vd.req_field("type");
            vd.field_value("id");
            if let Some(token) = vd.field_value("type") {
                let path = self.key.loc.pathname().smart_join_parent(token.as_str());
                data.verify_exists_implied(Item::File, &path.to_string_lossy(), token);
            }
            vd.field_value("data"); // TODO
        });

        vd.multi_field_validated_block("animation", |block, data| {
            let mut vd = Validator::new(block, data);
            vd.req_field("id");
            vd.req_field("type");
            vd.field_value("id");
            if let Some(token) = vd.field_value("type") {
                let path = self.key.loc.pathname().smart_join_parent(token.as_str());
                data.fileset.verify_exists_implied_crashes(&path.to_string_lossy(), token);
            }
        });
        vd.multi_field_validated_block("additive_animation", |block, data| {
            let mut vd = Validator::new(block, data);
            vd.req_field("id");
            vd.req_field("type");
            vd.field_value("id");
            if let Some(token) = vd.field_value("type") {
                let path = self.key.loc.pathname().smart_join_parent(token.as_str());
                data.verify_exists_implied(Item::File, &path.to_string_lossy(), token);
            }
        });

        vd.multi_field_validated_block("import", |block, data| {
            let mut vd = Validator::new(block, data);
            vd.field_value("type"); // TODO
            vd.field_item("name", Item::Asset);
        });
    }

    pub fn validate_entity(&self, data: &Everything) {
        let mut vd = Validator::new(&self.block, data);
        vd.set_case_sensitive(false);

        vd.field_value("name");
        vd.field_item("pdxmesh", Item::Pdxmesh);
        vd.field_item("clone", Item::Entity);
        vd.field_bool("get_state_from_parent");
        vd.field_numeric("scale");
        vd.field_numeric("cull_radius");
        #[cfg(feature = "jomini")]
        if Game::is_jomini() {
            vd.multi_field_validated_block("attribute", |block, data| {
                let mut vd = Validator::new(block, data);
                vd.req_field("name");
                vd.req_field_one_of(&["blend_shape", "additive_animation"]);
                vd.field_item("name", Item::GeneAttribute);
                if Game::is_eu5() {
                    vd.field("additive_animation"); // TODO: eu5 link to defined "additive_animation"
                } else {
                    vd.field_item("additive_animation", Item::GeneAttribute);
                }
                vd.field_item("blend_shape", Item::BlendShape);
                vd.field_numeric("default");
            });
        }
        vd.multi_field_validated_block("meshsettings", validate_meshsettings);
        #[cfg(feature = "jomini")]
        vd.multi_field_validated_block("game_data", |block, data| {
            let mut vd = Validator::new(block, data);
            vd.multi_field_validated_block("portrait_entity_user_data", |block, data| {
                let mut vd = Validator::new(block, data);
                vd.multi_field_validated_block("portrait_accessory", |block, data| {
                    let mut vd = Validator::new(block, data);
                    vd.field_item("pattern_mask", Item::File);
                    vd.field_item("variation", Item::AccessoryVariation);
                });
                vd.multi_field_validated_block("color_mask_remap_interval", |block, data| {
                    let mut vd = Validator::new(block, data);
                    vd.multi_field_validated_block("interval", |block, data| {
                        validate_numeric_range(
                            block,
                            data,
                            0.0,
                            1.0,
                            Severity::Warning,
                            Confidence::Weak,
                        );
                    });
                });
                vd.multi_field_validated_block("portrait_decal", |block, data| {
                    let mut vd = Validator::new(block, data);
                    vd.field_value("body_part"); // TODO
                });
                vd.field_item("coa_mask", Item::File);
            });
            vd.multi_field_validated_block("throne_entity_user_data", |block, data| {
                let mut vd = Validator::new(block, data);
                vd.field_item("animation", Item::PortraitAnimation);
                vd.field_bool("use_throne_transform");
            });
            vd.multi_field_validated_block("court_entity_user_data", |block, data| {
                let mut vd = Validator::new(block, data);
                vd.field_bool("coat_of_arms");
            });
        });
        vd.multi_field_validated_block("state", |block, data| {
            let mut vd = Validator::new(block, data);
            vd.req_field("name");
            vd.field_value("name");
            vd.field_numeric("state_time");
            vd.field_bool("looping");
            vd.field_numeric("animation_speed");
            vd.field_value("next_state"); // TODO
            vd.field("chance"); // TODO: can be integer or block
            vd.field_value("animation"); // TODO
            vd.field_numeric("animation_blend_time");
            vd.field_validated("time_offset", validate_time_offset);
            vd.multi_field_validated_block("start_event", validate_event);
            vd.multi_field_validated_block("event", validate_event);
            vd.multi_field_validated("propagate_state", |bv, data| {
                match bv {
                    BV::Value(_token) => (), // TODO
                    BV::Block(block) => {
                        let mut vd = Validator::new(block, data);
                        // TODO
                        vd.unknown_value_fields(|_, _| ());
                    }
                }
            });
        });
        vd.field_value("default_state"); // TODO: must be a state name
        vd.multi_field_validated_block("locator", |block, data| {
            let mut vd = Validator::new(block, data);
            vd.req_field("name");
            vd.field_value("name");
            vd.multi_field_validated_block("position", |block, data| {
                let mut vd = Validator::new(block, data);
                vd.req_tokens_numbers_exactly(3);
            });
            vd.multi_field_validated_block("rotation", |block, data| {
                let mut vd = Validator::new(block, data);
                vd.req_tokens_numbers_exactly(3);
            });
            if Game::is_vic3() || Game::is_eu5() {
                vd.field("parent_joint"); // TODO: eu5 & vic3
            }
            vd.field_numeric("scale");
        });
        vd.multi_field_validated_block("attach", |block, data| {
            let mut vd = Validator::new(block, data);
            vd.unknown_value_fields(|_, token| {
                // TODO: what are the keys here?
                data.verify_exists(Item::Asset, token);
            });
        });
    }

    pub fn validate_animation(&self, data: &Everything) {
        let mut vd = Validator::new(&self.block, data);
        vd.field_value("name");
        if let Some(token) = vd.field_value("file") {
            let path = self.key.loc.pathname().smart_join_parent(token.as_str());
            data.verify_exists_implied(Item::File, &path.to_string_lossy(), token);
        }
    }

    pub fn validate_animation_set(&self, data: &Everything) {
        let mut vd = Validator::new(&self.block, data);
        vd.field_value("name");
        vd.req_field("reference_skeleton");
        vd.multi_field_item("reference_skeleton", Item::Pdxmesh);
        vd.multi_field_validated_block("animation", |block, data| {
            let mut vd = Validator::new(block, data);
            vd.req_field("id");
            vd.req_field("type");
            vd.field_value("id");
            if let Some(token) = vd.field_value("type") {
                let path = self.key.loc.pathname().smart_join_parent(token.as_str());
                data.verify_exists_implied(Item::File, &path.to_string_lossy(), token);
            }
        });
    }

    pub fn validate_music(&self, data: &Everything) {
        if !Game::is_hoi4() {
            let msg = "`music` assets are only used in Hoi4";
            warn(ErrorKey::WrongGame).msg(msg).loc(&self.key).push();
        }
        let mut vd = Validator::new(&self.block, data);
        vd.field_item("name", Item::Localization);
        if let Some(token) = vd.field_value("file") {
            let path = self.key.loc.pathname().smart_join_parent(token.as_str());
            data.verify_exists_implied(Item::File, &path.to_string_lossy(), token);
        }
        vd.field_numeric("volume");
    }

    pub fn validate(&self, data: &Everything) {
        if self.key.is("pdxmesh") {
            self.validate_mesh(data);
        } else if self.key.is("entity") {
            self.validate_entity(data);
        } else if Game::is_hoi4() && self.key.is("animation") {
            self.validate_animation(data);
        } else if self.key.is("skeletal_animation_set") {
            self.validate_animation_set(data);
        } else if self.key.is("arrowType") {
            // TODO: arrowType
        } else if self.key.is("music") {
            self.validate_music(data);
        } else {
            warn(ErrorKey::UnknownField).msg("unknown asset type").loc(&self.key).push();
        }
    }
}

fn validate_event(block: &Block, data: &Everything) {
    let mut vd = Validator::new(block, data);
    vd.field_numeric("time");
    vd.field_numeric("life");
    vd.field_numeric("entity_fade_speed");
    if Game::is_eu5() {
        vd.field_numeric("entity_editor_id");
    }
    vd.field_value("state"); // TODO
    vd.field_value("node"); // TODO
    vd.field_value("particle"); // TODO
    vd.field_bool("keep_particle");
    vd.field_bool("keep_sound");
    vd.field_bool("keep_entity");
    vd.field_bool("trigger_once");
    vd.field_bool("use_parent_nodes");
    vd.field_integer("skip_forward");
    vd.field_value("attachment_id"); // TODO
    vd.field_value("remove_attachment"); // TODO
    vd.field_item("entity", Item::Entity);
    vd.multi_field_validated_block("soundparameter", |block, data| {
        let mut vd = Validator::new(block, data);
        vd.unknown_value_fields(|_, token| {
            // TODO: what are the keys here?
            token.expect_number();
        });
    });
    vd.multi_field_validated_block("sound", |block, data| {
        let mut vd = Validator::new(block, data);
        if let Some(token) = vd.field_value("soundeffect") {
            if !token.is("") {
                if Game::is_hoi4() {
                    #[cfg(feature = "hoi4")]
                    data.verify_exists(Item::SoundEffect, token);
                } else if Game::is_eu5() {
                    // TODO: EU5 sound system is wwise and not documented
                } else {
                    data.verify_exists(Item::Sound, token);
                }
            }
        }
        vd.field_bool("stop_on_state_change");
    });
    vd.field_value("light"); // TODO
}

fn validate_meshsettings(block: &Block, data: &Everything) {
    let mut vd = Validator::new(block, data);
    vd.field_value("name");
    vd.field_integer("index"); // TODO: do these need to be consecutive?
    vd.field_bool("shadow_only");
    vd.field_item_or_empty("texture_diffuse", Item::TextureFile);
    vd.field_item_or_empty("texture_normal", Item::TextureFile);
    vd.field_item_or_empty("texture_specular", Item::TextureFile);
    // TODO: verify if indexes have to be unique
    vd.multi_field_validated_block("texture", |block, data| {
        let mut vd = Validator::new(block, data);
        vd.req_field("file");
        vd.req_field("index");
        vd.field_item("file", Item::TextureFile);
        vd.field_integer("index");
        vd.field_bool("srgb");
    });
    vd.field_value("shader"); // TODO
    vd.field_item("shader_file", Item::File);
    vd.field_value("subpass");
    vd.field_value("shadow_shader");
    vd.field_value("rasterizerstate"); // TODO, choices?
    if Game::is_vic3() || Game::is_ck3() || Game::is_eu5() {
        vd.field_list("additional_shader_defines");
    }
}

fn validate_time_offset(bv: &BV, data: &Everything) {
    match bv {
        BV::Value(token) => {
            _ = token.expect_number();
        }
        BV::Block(block) => {
            let mut vd = Validator::new(block, data);
            vd.req_tokens_numbers_exactly(2);
        }
    }
}