tiger_lib/ck3/data/
doctrines.rs

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
use std::path::PathBuf;

use crate::block::Block;
use crate::ck3::validate::validate_traits;
use crate::context::ScopeContext;
use crate::desc::validate_desc;
use crate::everything::Everything;
use crate::fileset::{FileEntry, FileHandler};
use crate::helpers::{dup_error, TigerHashMap, TigerHashSet};
use crate::item::Item;
use crate::modif::{validate_modifs, ModifKinds};
use crate::parse::ParserMemory;
use crate::pdxfile::PdxFile;
use crate::scopes::Scopes;
use crate::token::Token;
use crate::tooltipped::Tooltipped;
use crate::trigger::validate_trigger;
use crate::validator::Validator;

#[derive(Clone, Debug, Default)]
#[allow(clippy::struct_field_names)]
pub struct Doctrines {
    categories: TigerHashMap<&'static str, DoctrineCategory>,
    doctrines: TigerHashMap<&'static str, Doctrine>,
    parameters: TigerHashSet<Token>, // only the boolean parameters
}

impl Doctrines {
    fn load_item(&mut self, key: Token, block: Block) {
        if let Some(other) = self.categories.get(key.as_str()) {
            if other.key.loc.kind >= key.loc.kind {
                dup_error(&key, &other.key, "doctrine category");
            }
        }
        self.categories.insert(key.as_str(), DoctrineCategory::new(key, block));
    }

    pub fn validate(&self, data: &Everything) {
        for category in self.categories.values() {
            category.validate(data);
        }
        for doctrine in self.doctrines.values() {
            doctrine.validate(data);
        }
    }

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

    pub fn iter_keys(&self) -> impl Iterator<Item = &Token> {
        self.doctrines.values().map(|item| &item.key)
    }

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

    pub fn category(&self, key: &str) -> Option<&Token> {
        self.doctrines.get(key).map(|d| &d.category)
    }

    pub fn number_of_picks(&self, category: &str) -> Option<&Token> {
        self.categories.get(category).and_then(|c| c.picks.as_ref())
    }

    pub fn iter_category_keys(&self) -> impl Iterator<Item = &Token> {
        self.categories.values().map(|item| &item.key)
    }

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

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

    pub fn unreformed(&self, key: &str) -> bool {
        self.doctrines.get(key).is_some_and(Doctrine::unreformed)
    }
}

impl FileHandler<Block> for Doctrines {
    fn subpath(&self) -> PathBuf {
        PathBuf::from("common/religion/doctrines")
    }

    fn load_file(&self, entry: &FileEntry, parser: &ParserMemory) -> Option<Block> {
        if !entry.filename().to_string_lossy().ends_with(".txt") {
            return None;
        }

        PdxFile::read(entry, parser)
    }

    fn handle_file(&mut self, _entry: &FileEntry, mut block: Block) {
        for (key, block) in block.drain_definitions_warn() {
            self.load_item(key, block);
        }
    }

    fn finalize(&mut self) {
        for category in self.categories.values() {
            for (doctrine, block) in category.block.iter_definitions() {
                // skip definitions that are not doctrines
                if doctrine.is("is_available_on_create") || doctrine.is("name") {
                    continue;
                }

                if let Some(other) = self.doctrines.get(doctrine.as_str()) {
                    if other.key.loc.kind >= doctrine.loc.kind {
                        dup_error(doctrine, &other.key, "doctrine");
                    }
                }

                if let Some(b) = block.get_field_block("parameters") {
                    for (k, v) in b.iter_assignments() {
                        if v.is("yes") || v.is("no") {
                            self.parameters.insert(k.clone());
                        }
                    }
                }
                self.doctrines.insert(
                    doctrine.as_str(),
                    Doctrine::new(doctrine.clone(), block.clone(), category.key.clone()),
                );
            }
        }
    }
}

#[derive(Clone, Debug)]
pub struct DoctrineCategory {
    key: Token,
    block: Block,
    picks: Option<Token>,
}

impl DoctrineCategory {
    pub fn new(key: Token, block: Block) -> Self {
        let picks = block.get_field_value("number_of_picks").cloned();
        Self { key, block, picks }
    }

    pub fn needs_icon(&self, data: &Everything) -> bool {
        if let Some(group) = self.block.get_field_value("group") {
            if group.is("special") || group.is("not_creatable") {
                return false;
            }
        }

        if let Some(icon_path) =
            data.get_defined_string_warn(&self.key, "NGameIcons|FAITH_DOCTRINE_GROUP_ICON_PATH")
        {
            let path = format!("{icon_path}/{}.dds", &self.key);
            data.mark_used(Item::File, &path);
            return !data.fileset.exists(&path);
        }
        true
    }

    pub fn validate(&self, data: &Everything) {
        let mut vd = Validator::new(&self.block, data);
        let mut sc = ScopeContext::new(Scopes::Faith, &self.key);

        if !vd.field_validated_sc("name", &mut sc, validate_desc) {
            let loca = format!("{}_name", self.key);
            data.verify_exists_implied(Item::Localization, &loca, &self.key);
        }

        // doc says "grouping" but that's wrong
        vd.field_value("group");

        vd.field_integer("number_of_picks");

        vd.field_validated_block("is_available_on_create", |b, data| {
            validate_trigger(b, data, &mut sc, Tooltipped::No);
        });

        // Any remaining definitions are doctrines, so accept them all.
        // They are validated separately.
        vd.unknown_block_fields(|_, _| ());
    }
}

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

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

    pub fn validate(&self, data: &Everything) {
        let mut vd = Validator::new(&self.block, data);
        let mut sc = ScopeContext::new(Scopes::Faith, &self.key);
        sc.define_list("selected_doctrines", Scopes::Doctrine, &self.key);

        if let Some(icon) = vd.field_value("icon") {
            data.verify_icon("NGameIcons|FAITH_DOCTRINE_ICON_PATH", icon, ".dds");
        } else if data.doctrines.categories[self.category.as_str()].needs_icon(data) {
            data.verify_icon("NGameIcons|FAITH_DOCTRINE_ICON_PATH", &self.key, ".dds");
        }

        if !vd.field_validated_sc("name", &mut sc, validate_desc) {
            let loca = format!("{}_name", self.key);
            data.verify_exists_implied(Item::Localization, &loca, &self.key);
        }

        if !vd.field_validated_sc("desc", &mut sc, validate_desc) {
            let loca = format!("{}_desc", self.key);
            data.verify_exists_implied(Item::Localization, &loca, &self.key);
        }

        vd.field_bool("visible");
        vd.field_validated_block("parameters", validate_parameters);
        vd.field_script_value("piety_cost", &mut sc);
        vd.field_validated_block("is_shown", |b, data| {
            validate_trigger(b, data, &mut sc, Tooltipped::No);
        });
        vd.field_validated_block("can_pick", |b, data| {
            validate_trigger(b, data, &mut sc, Tooltipped::Yes);
        });

        vd.field_validated_block("character_modifier", |block, data| {
            let mut vd = Validator::new(block, data);
            vd.field_item("name", Item::Localization);
            validate_modifs(block, data, ModifKinds::Character, vd);
        });

        // Not documented, but used in vanilla
        vd.field_validated_block("clergy_modifier", |block, data| {
            let vd = Validator::new(block, data);
            validate_modifs(block, data, ModifKinds::Character, vd);
        });

        // In the docs but not used in vanilla
        vd.field_validated_block("doctrine_character_modifier", |block, data| {
            let mut vd = Validator::new(block, data);
            vd.field_item("doctrine", Item::Doctrine);
            validate_modifs(block, data, ModifKinds::Character, vd);
        });

        vd.field_validated_block("traits", validate_traits);
    }

    fn unreformed(&self) -> bool {
        if let Some(block) = self.block.get_field_block("parameters") {
            return block.field_value_is("unreformed", "yes");
        }
        false
    }
}

fn validate_parameters(block: &Block, data: &Everything) {
    let mut vd = Validator::new(block, data);

    vd.unknown_value_fields(|_, value| {
        if value.is("yes") || value.is("no") {
            return;
        }
        value.expect_number();
    });
}