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

use crate::block::{BV, Block, Comparator, Eq::*};
use crate::report::{ErrorKey, err};
use crate::token::Token;

#[derive(Debug, Clone)]
pub struct Field(pub Token, pub Comparator, pub BV);

impl Field {
    pub fn into_key(self) -> Token {
        self.0
    }

    pub fn key(&self) -> &Token {
        &self.0
    }

    pub fn cmp(&self) -> Comparator {
        self.1
    }

    #[allow(dead_code)] // It's here for symmetry
    pub fn into_bv(self) -> BV {
        self.2
    }

    pub fn bv(&self) -> &BV {
        &self.2
    }

    pub fn is_eq(&self) -> bool {
        matches!(self.1, Comparator::Equals(Single))
    }

    pub fn is_eq_qeq(&self) -> bool {
        matches!(self.1, Comparator::Equals(Single | Question))
    }

    pub fn expect_eq(&self) -> bool {
        let Self(key, cmp, _) = self;
        if matches!(cmp, Comparator::Equals(Single)) {
            true
        } else {
            let msg = &format!("expected `{key} =`, found `{cmp}`");
            err(ErrorKey::Validation).msg(msg).loc(self).push();
            false
        }
    }

    pub fn describe(&self) -> &'static str {
        if self.is_eq_qeq() {
            match self.2 {
                BV::Value(_) => "assignment",
                BV::Block(_) => "definition",
            }
        } else {
            "comparison"
        }
    }

    pub fn equivalent(&self, other: &Self) -> bool {
        self.0 == other.0 && self.1 == other.1 && self.2.equivalent(&other.2)
    }

    pub fn expect_definition(&self) -> Option<(&Token, &Block)> {
        #[allow(clippy::single_match_else)] // too complicated for a `let`
        match self {
            Field(key, Comparator::Equals(Single | Question), BV::Block(block)) => {
                return Some((key, block));
            }
            _ => {
                let msg = format!("expected definition, found {}", self.describe());
                err(ErrorKey::Structure).msg(msg).loc(self).push();
            }
        }
        None
    }

    pub fn expect_into_definition(self) -> Option<(Token, Block)> {
        #[allow(clippy::single_match_else)] // too complicated for a `let`
        match self {
            Field(key, Comparator::Equals(Single | Question), BV::Block(block)) => {
                return Some((key, block));
            }
            _ => {
                let msg = format!("expected definition, found {}", self.describe());
                err(ErrorKey::Structure).msg(msg).loc(self).push();
            }
        }
        None
    }

    pub fn get_definition(&self) -> Option<(&Token, &Block)> {
        #[allow(clippy::single_match_else)] // too complicated for a `let`
        match self {
            Field(key, Comparator::Equals(Single | Question), BV::Block(block)) => {
                Some((key, block))
            }
            _ => None,
        }
    }

    #[allow(dead_code)]
    pub fn into_definition(self) -> Option<(Token, Block)> {
        #[allow(clippy::single_match_else)] // too complicated for a `let`
        match self {
            Field(key, Comparator::Equals(Single | Question), BV::Block(block)) => {
                Some((key, block))
            }
            _ => None,
        }
    }

    pub fn get_assignment(&self) -> Option<(&Token, &Token)> {
        #[allow(clippy::single_match_else)] // too complicated for a `let`
        match self {
            Field(key, Comparator::Equals(Single | Question), BV::Value(token)) => {
                Some((key, token))
            }
            _ => None,
        }
    }

    pub fn expect_into_assignment(self) -> Option<(Token, Token)> {
        #[allow(clippy::single_match_else)] // too complicated for a `let`
        match self {
            Field(key, Comparator::Equals(Single | Question), BV::Value(token)) => {
                return Some((key, token));
            }
            _ => {
                let msg = format!("expected assignment, found {}", self.describe());
                err(ErrorKey::Structure).msg(msg).loc(self).push();
            }
        }
        None
    }

    #[allow(dead_code)] // It's here for symmetry
    pub fn expect_assignment(&self) -> Option<(&Token, &Token)> {
        #[allow(clippy::single_match_else)] // too complicated for a `let`
        match self {
            Field(key, Comparator::Equals(Single | Question), BV::Value(token)) => {
                return Some((key, token));
            }
            _ => {
                let msg = format!("expected assignment, found {}", self.describe());
                err(ErrorKey::Structure).msg(msg).loc(self).push();
            }
        }
        None
    }

    #[allow(dead_code)]
    pub fn into_assignment(self) -> Option<(Token, Token)> {
        #[allow(clippy::single_match_else)] // too complicated for a `let`
        match self {
            Field(key, Comparator::Equals(Single | Question), BV::Value(value)) => {
                Some((key, value))
            }
            _ => None,
        }
    }
}