foch 0.0.2

EU4 mod analysis and merge toolkit
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

//! Engine host windows documented by EU4's `common/custom_gui/example.txt`.

/// What `ROOT` is inside a documented host. `FROM` is always the clicking
/// country, so `Actor` means `ROOT = FROM`.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Hash)]
pub enum HostRoot {
	Actor,
	ClickedProvince,
	SelectedCountry,
	TradeNodeCapital,
}

/// Scripted GUI objects run only under a descendant of one of these windows.
/// The table copies the installed game's documentation, including its
/// `countrydiplimacyview` spelling. "All faction windows" are omitted because
/// the documentation does not name them.
const DOCUMENTED_HOSTS: &[(&str, &str, HostRoot)] = &[
	(
		"interface/provinceview.gui",
		"province_window",
		HostRoot::ClickedProvince,
	),
	(
		"interface/provinceview.gui",
		"buildings_window",
		HostRoot::ClickedProvince,
	),
	(
		"interface/provinceview.gui",
		"state_window",
		HostRoot::ClickedProvince,
	),
	(
		"interface/countrycourtview.gui",
		"countrycourtview",
		HostRoot::Actor,
	),
	(
		"interface/countrygovernmentview.gui",
		"countrygovernmentview",
		HostRoot::Actor,
	),
	(
		"interface/countrydiplomacyview.gui",
		"countrydiplimacyview",
		HostRoot::SelectedCountry,
	),
	(
		"interface/countryeconomyview.gui",
		"countryeconomyview",
		HostRoot::Actor,
	),
	(
		"interface/countrytradeview.gui",
		"countrytradeview",
		HostRoot::Actor,
	),
	(
		"interface/countrytechnologyview.gui",
		"countrytechnologyview",
		HostRoot::Actor,
	),
	(
		"interface/countryideasview.gui",
		"countryideasview",
		HostRoot::Actor,
	),
	(
		"interface/countrymissionsview.gui",
		"countrymissionsview",
		HostRoot::SelectedCountry,
	),
	(
		"interface/countrydecisionview.gui",
		"countrydecisionsview",
		HostRoot::Actor,
	),
	(
		"interface/countrystabilityview.gui",
		"countrystabilityview",
		HostRoot::Actor,
	),
	(
		"interface/countryreligionview.gui",
		"countryreligionview",
		HostRoot::Actor,
	),
	(
		"interface/countrymilitaryview.gui",
		"countrymilitaryview",
		HostRoot::Actor,
	),
	(
		"interface/countrysubjectsview.gui",
		"countrysubjectview",
		HostRoot::Actor,
	),
	(
		"interface/countryestatesview.gui",
		"countryestatesview",
		HostRoot::Actor,
	),
	("interface/ages_view.gui", "ages_view", HostRoot::Actor),
	(
		"interface/tradeinterface.gui",
		"TradeNodeInterface",
		HostRoot::TradeNodeCapital,
	),
	("interface/hre.gui", "hre_window", HostRoot::Actor),
	("interface/papacy.gui", "papacy_window", HostRoot::Actor),
	(
		"interface/celestialempireview.gui",
		"celestial_window",
		HostRoot::Actor,
	),
	(
		"interface/countrynativesview.gui",
		"natives_window",
		HostRoot::Actor,
	),
	(
		"interface/religiousreforms.gui",
		"reforms_window",
		HostRoot::Actor,
	),
	(
		"interface/parliament.gui",
		"parliament_window",
		HostRoot::Actor,
	),
];

/// The documented `ROOT` of `window` when it is defined in `gui_file`.
pub fn documented_host(gui_file: &str, window: &str) -> Option<HostRoot> {
	let gui_file = gui_file.replace('\\', "/");
	DOCUMENTED_HOSTS
		.iter()
		.find(|(file, name, _)| file.eq_ignore_ascii_case(&gui_file) && *name == window)
		.map(|(_, _, root)| *root)
}