foch 0.1.0

Paradox mod static analysis toolkit with CLI and EU4-focused language tooling
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

use serde::Deserialize;
use std::collections::HashSet;
use std::sync::OnceLock;

#[derive(Debug, Deserialize)]
struct BuiltinCatalog {
	reserved_keywords: Vec<String>,
	contextual_keywords: Vec<String>,
	alias_keywords: Vec<String>,
	builtin_triggers: Vec<BuiltinSymbol>,
	builtin_effects: Vec<BuiltinSymbol>,
}

#[derive(Debug, Deserialize)]
struct BuiltinSymbol {
	name: String,
}

#[derive(Debug)]
struct BuiltinLookup {
	reserved: HashSet<String>,
	contextual: HashSet<String>,
	aliases: HashSet<String>,
	triggers: HashSet<String>,
	effects: HashSet<String>,
	reserved_list: Vec<String>,
	contextual_list: Vec<String>,
	aliases_list: Vec<String>,
	triggers_list: Vec<String>,
	effects_list: Vec<String>,
}

static LOOKUP: OnceLock<BuiltinLookup> = OnceLock::new();

fn load_lookup() -> &'static BuiltinLookup {
	LOOKUP.get_or_init(|| {
		let raw = include_str!("data/eu4_builtin_catalog.json");
		let catalog: BuiltinCatalog = serde_json::from_str(raw)
			.expect("valid src/check/data/eu4_builtin_catalog.json catalog");

		let mut reserved_list = catalog.reserved_keywords;
		reserved_list.sort();
		reserved_list.dedup();

		let mut contextual_list = catalog.contextual_keywords;
		contextual_list.sort();
		contextual_list.dedup();

		let mut aliases_list = catalog.alias_keywords;
		aliases_list.sort();
		aliases_list.dedup();

		let mut triggers_list: Vec<String> = catalog
			.builtin_triggers
			.into_iter()
			.map(|item| item.name)
			.collect();
		triggers_list.sort();
		triggers_list.dedup();

		let mut effects_list: Vec<String> = catalog
			.builtin_effects
			.into_iter()
			.map(|item| item.name)
			.collect();
		effects_list.sort();
		effects_list.dedup();

		BuiltinLookup {
			reserved: reserved_list.iter().cloned().collect(),
			contextual: contextual_list.iter().cloned().collect(),
			aliases: aliases_list.iter().cloned().collect(),
			triggers: triggers_list.iter().cloned().collect(),
			effects: effects_list.iter().cloned().collect(),
			reserved_list,
			contextual_list,
			aliases_list,
			triggers_list,
			effects_list,
		}
	})
}

pub fn is_reserved_keyword(key: &str) -> bool {
	load_lookup().reserved.contains(key)
}

pub fn is_contextual_keyword(key: &str) -> bool {
	load_lookup().contextual.contains(key)
}

pub fn is_alias_keyword(key: &str) -> bool {
	load_lookup().aliases.contains(key)
}

pub fn is_builtin_trigger(key: &str) -> bool {
	load_lookup().triggers.contains(key)
}

pub fn is_builtin_effect(key: &str) -> bool {
	load_lookup().effects.contains(key)
}

pub fn reserved_keywords() -> &'static [String] {
	&load_lookup().reserved_list
}

pub fn contextual_keywords() -> &'static [String] {
	&load_lookup().contextual_list
}

pub fn alias_keywords() -> &'static [String] {
	&load_lookup().aliases_list
}

pub fn builtin_trigger_names() -> &'static [String] {
	&load_lookup().triggers_list
}

pub fn builtin_effect_names() -> &'static [String] {
	&load_lookup().effects_list
}

#[cfg(test)]
mod tests {
	use super::{
		is_alias_keyword, is_builtin_effect, is_builtin_trigger, is_contextual_keyword,
		is_reserved_keyword,
	};

	#[test]
	fn keyword_sets_are_loaded() {
		assert!(is_reserved_keyword("potential"));
		assert!(is_reserved_keyword("allow"));
		assert!(is_contextual_keyword("hidden_effect"));
		assert!(is_alias_keyword("ROOT"));
	}

	#[test]
	fn builtin_symbols_include_trigger_and_effect_examples() {
		assert!(is_builtin_trigger("num_of_cities"));
		assert!(is_builtin_trigger("has_country_flag"));
		assert!(is_builtin_effect("add_country_modifier"));
	}
}