about summary refs log tree commit diff stats
path: root/tools/validator
diff options
context:
space:
mode:
Diffstat (limited to 'tools/validator')
-rw-r--r--tools/validator/CMakeLists.txt13
-rw-r--r--tools/validator/godot_processor.cpp72
-rw-r--r--tools/validator/godot_processor.h14
-rw-r--r--tools/validator/human_processor.cpp660
-rw-r--r--tools/validator/human_processor.h14
-rw-r--r--tools/validator/main.cpp34
-rw-r--r--tools/validator/structs.h149
-rw-r--r--tools/validator/validator.cpp587
-rw-r--r--tools/validator/validator.h12
9 files changed, 1555 insertions, 0 deletions
diff --git a/tools/validator/CMakeLists.txt b/tools/validator/CMakeLists.txt new file mode 100644 index 0000000..1a8fd9c --- /dev/null +++ b/tools/validator/CMakeLists.txt
@@ -0,0 +1,13 @@
1find_package(fmt REQUIRED)
2find_package(Protobuf REQUIRED)
3
4add_executable(validator
5 godot_processor.cpp
6 human_processor.cpp
7 main.cpp
8 validator.cpp
9)
10set_property(TARGET validator PROPERTY CXX_STANDARD 20)
11set_property(TARGET validator PROPERTY CXX_STANDARD_REQUIRED ON)
12target_include_directories(validator PUBLIC ${CMAKE_BINARY_DIR} ${CMAKE_SOURCE_DIR}/tools)
13target_link_libraries(validator PUBLIC protos util fmt::fmt protobuf::libprotobuf)
diff --git a/tools/validator/godot_processor.cpp b/tools/validator/godot_processor.cpp new file mode 100644 index 0000000..ad2be78 --- /dev/null +++ b/tools/validator/godot_processor.cpp
@@ -0,0 +1,72 @@
1#include "godot_processor.h"
2
3#include <filesystem>
4#include <iostream>
5#include <memory>
6#include <set>
7
8#include "structs.h"
9#include "util/godot_scene.h"
10
11namespace com::fourisland::lingo2_archipelago {
12
13namespace {
14
15static const std::set<std::string> kImportantNodeTypes = {
16 "res://objects/nodes/panel.tscn", "res://objects/nodes/worldport.tscn",
17 "res://objects/nodes/keyHolder.tscn",
18 "res://objects/nodes/collectable.tscn"};
19
20class GodotProcessor {
21 public:
22 GodotProcessor(const std::string& repodir, CollectedInfo& info)
23 : repodir_(repodir), info_(info) {}
24
25 void Run() {
26 for (auto& [map_name, map_info] : info_.maps) {
27 ProcessMap(map_name, map_info);
28 }
29 }
30
31 void ProcessMap(const std::string& map_name, MapInfo& map_info) {
32 std::filesystem::path scene_path = std::filesystem::path(repodir_) /
33 "objects" / "scenes" /
34 (map_name + ".tscn");
35 std::string scene_path_str = scene_path.string();
36 std::cout << "Processing " << scene_path_str << std::endl;
37
38 GodotScene scene = ReadGodotSceneFromFile(scene_path_str);
39 for (const GodotNode& node : scene.GetNodes()) {
40 ProcessMapNode(scene, node, map_info);
41 }
42 }
43
44 void ProcessMapNode(const GodotScene& scene, const GodotNode& node,
45 MapInfo& map_info) {
46 if (std::holds_alternative<GodotExtResourceRef>(node.instance_type)) {
47 const GodotExtResourceRef& ext_resource_ref =
48 std::get<GodotExtResourceRef>(node.instance_type);
49 const GodotExtResource* ext_resource =
50 scene.GetExtResource(ext_resource_ref.id);
51
52 if (ext_resource != nullptr &&
53 (kImportantNodeTypes.count(ext_resource->path) ||
54 ext_resource->path.starts_with("res://objects/meshes/paintings/"))) {
55 map_info.game_nodes[node.GetPath()].defined = true;
56 }
57 }
58 }
59
60 private:
61 std::string repodir_;
62 CollectedInfo& info_;
63};
64
65} // namespace
66
67void ProcessGodotData(const std::string& repodir, CollectedInfo& info) {
68 GodotProcessor godot_processor(repodir, info);
69 godot_processor.Run();
70}
71
72} // namespace com::fourisland::lingo2_archipelago
diff --git a/tools/validator/godot_processor.h b/tools/validator/godot_processor.h new file mode 100644 index 0000000..97bcea6 --- /dev/null +++ b/tools/validator/godot_processor.h
@@ -0,0 +1,14 @@
1#ifndef TOOLS_VALIDATOR_GODOT_PROCESSOR_H_
2#define TOOLS_VALIDATOR_GODOT_PROCESSOR_H_
3
4#include <string>
5
6namespace com::fourisland::lingo2_archipelago {
7
8struct CollectedInfo;
9
10void ProcessGodotData(const std::string& repodir, CollectedInfo& info);
11
12} // namespace com::fourisland::lingo2_archipelago
13
14#endif /* TOOLS_VALIDATOR_GODOT_PROCESSOR_H_ */
diff --git a/tools/validator/human_processor.cpp b/tools/validator/human_processor.cpp new file mode 100644 index 0000000..ffa9765 --- /dev/null +++ b/tools/validator/human_processor.cpp
@@ -0,0 +1,660 @@
1#include "human_processor.h"
2
3#include <fmt/core.h>
4#include <google/protobuf/message.h>
5#include <google/protobuf/text_format.h>
6
7#include <filesystem>
8#include <fstream>
9#include <iostream>
10#include <map>
11#include <optional>
12#include <sstream>
13#include <string>
14
15#include "structs.h"
16#include "util/ids_yaml_format.h"
17
18namespace com::fourisland::lingo2_archipelago {
19namespace {
20
21template <typename T>
22T ReadMessageFromFile(const std::string& path) {
23 std::cout << "Processing " << path << std::endl;
24
25 std::ifstream file(path);
26 std::stringstream buffer;
27 buffer << file.rdbuf();
28
29 T message;
30 google::protobuf::TextFormat::ParseFromString(buffer.str(), &message);
31
32 return message;
33}
34
35class HumanProcessor {
36 public:
37 HumanProcessor(const std::string& mapdir, CollectedInfo& info)
38 : mapdir_(mapdir), info_(info) {}
39
40 void Run() {
41 std::filesystem::path datadir_path = mapdir_;
42
43 ProcessConnectionsFile(datadir_path / "connections.txtpb", std::nullopt);
44 ProcessMaps(datadir_path);
45 ProcessProgressivesFile(datadir_path / "progressives.txtpb");
46 ProcessDoorGroupsFile(datadir_path / "door_groups.txtpb");
47 ProcessIdsFile(datadir_path / "ids.yaml");
48 }
49
50 private:
51 void ProcessMaps(std::filesystem::path path) {
52 std::filesystem::path maps_dir = path / "maps";
53 for (auto const& dir_entry :
54 std::filesystem::directory_iterator(maps_dir)) {
55 ProcessMap(dir_entry.path());
56 }
57 }
58
59 void ProcessMap(std::filesystem::path path) {
60 std::string map_name = path.filename().string();
61
62 ProcessMetadataFile(path / "metadata.txtpb", map_name);
63 ProcessConnectionsFile(path / "connections.txtpb", map_name);
64 ProcessDoorsFile(path / "doors.txtpb", map_name);
65 ProcessRooms(path / "rooms", map_name);
66 }
67
68 void ProcessMetadataFile(std::filesystem::path path,
69 const std::string& current_map_name) {
70 if (!std::filesystem::exists(path)) {
71 return;
72 }
73
74 MapInfo& map_info = info_.maps[current_map_name];
75
76 auto metadata = ReadMessageFromFile<HumanMap>(path.string());
77 for (const std::string& path : metadata.excluded_nodes()) {
78 map_info.game_nodes[path].uses++;
79 }
80
81 for (const std::string& path : metadata.custom_nodes()) {
82 map_info.game_nodes[path].defined = true;
83 }
84
85 if (metadata.has_worldport_entrance()) {
86 auto port_identifier = GetCompletePortIdentifier(
87 metadata.worldport_entrance(), current_map_name, std::nullopt);
88 if (port_identifier) {
89 PortInfo& port_info = info_.ports[*port_identifier];
90 port_info.map_worldport_entrances.push_back(current_map_name);
91 } else {
92 map_info.malformed_worldport_entrance = metadata.worldport_entrance();
93 }
94 }
95 }
96
97 void ProcessRooms(std::filesystem::path path,
98 const std::string& current_map_name) {
99 for (auto const& dir_entry : std::filesystem::directory_iterator(path)) {
100 auto room = ReadMessageFromFile<HumanRoom>(dir_entry.path().string());
101 ProcessRoom(room, current_map_name);
102 }
103 }
104
105 void ProcessRoom(const HumanRoom& h_room,
106 const std::string& current_map_name) {
107 RoomIdentifier room_identifier;
108 room_identifier.set_map(current_map_name);
109 room_identifier.set_name(h_room.name());
110
111 RoomInfo& room_info = info_.rooms[room_identifier];
112 room_info.definitions.push_back(h_room);
113
114 for (const HumanPanel& h_panel : h_room.panels()) {
115 ProcessPanel(h_panel, current_map_name, h_room);
116 }
117
118 for (const HumanPainting& h_painting : h_room.paintings()) {
119 ProcessPainting(h_painting, current_map_name, h_room.name());
120 }
121
122 for (const HumanPort& h_port : h_room.ports()) {
123 ProcessPort(h_port, current_map_name, h_room.name());
124 }
125
126 for (const HumanLetter& h_letter : h_room.letters()) {
127 ProcessLetter(h_letter, current_map_name, h_room.name());
128 }
129
130 for (const HumanMastery& h_mastery : h_room.masteries()) {
131 ProcessMastery(h_mastery, current_map_name, h_room.name());
132 }
133
134 for (const HumanKeyholder& h_keyholder : h_room.keyholders()) {
135 ProcessKeyholder(h_keyholder, current_map_name, h_room.name());
136 }
137
138 for (const HumanEnding& h_ending : h_room.endings()) {
139 ProcessEnding(h_ending, current_map_name, h_room.name());
140 }
141 }
142
143 void ProcessPanel(const HumanPanel& h_panel,
144 const std::string& current_map_name,
145 const HumanRoom& h_room) {
146 PanelIdentifier panel_identifier;
147 panel_identifier.set_map(current_map_name);
148 panel_identifier.set_room(h_room.name());
149 panel_identifier.set_name(h_panel.name());
150
151 PanelInfo& panel_info = info_.panels[panel_identifier];
152 panel_info.definitions.push_back(h_panel);
153
154 MapInfo& map_info = info_.maps[current_map_name];
155 map_info.game_nodes[h_panel.path()].uses++;
156
157 for (const Proxy& h_proxy : h_panel.proxies()) {
158 ProxyInfo& proxy_info = panel_info.proxies[h_proxy.answer()];
159 proxy_info.definitions.push_back(h_proxy);
160
161 map_info.game_nodes[h_proxy.path()].uses++;
162 }
163
164 if (h_panel.has_required_door()) {
165 DoorIdentifier required_door_identifier =
166 *GetCompleteDoorIdentifier(h_panel.required_door(), current_map_name);
167 DoorInfo& required_door_info = info_.doors[required_door_identifier];
168 required_door_info.panels_referenced_by.push_back(panel_identifier);
169 }
170
171 if (h_panel.has_required_room()) {
172 RoomIdentifier required_room_identifier =
173 *GetCompleteRoomIdentifier(h_panel.required_room(), current_map_name);
174 RoomInfo& required_room_info = info_.rooms[required_room_identifier];
175 required_room_info.panels_referenced_by.push_back(panel_identifier);
176 }
177
178 std::string map_area_name = current_map_name;
179 if (h_room.has_panel_display_name()) {
180 map_area_name =
181 fmt::format("{} ({})", current_map_name, h_room.panel_display_name());
182 }
183
184 panel_info.map_area_name = map_area_name;
185
186 std::string panelsanity_name;
187 if (h_panel.has_display_name()) {
188 panelsanity_name =
189 fmt::format("{} - {}", map_area_name, h_panel.display_name());
190 } else {
191 panelsanity_name = fmt::format("{} - {}", map_area_name, h_panel.name());
192 }
193 info_.panel_names[panelsanity_name].panels_used_by.push_back(
194 panel_identifier);
195 }
196
197 void ProcessPainting(const HumanPainting& h_painting,
198 const std::string& current_map_name,
199 const std::string& current_room_name) {
200 PaintingIdentifier painting_identifier;
201 painting_identifier.set_map(current_map_name);
202 painting_identifier.set_room(current_room_name);
203 painting_identifier.set_name(h_painting.name());
204
205 PaintingInfo& painting_info = info_.paintings[painting_identifier];
206 painting_info.definitions.push_back(h_painting);
207
208 MapInfo& map_info = info_.maps[current_map_name];
209 map_info.game_nodes[h_painting.path()].uses++;
210
211 if (h_painting.has_required_door()) {
212 DoorIdentifier required_door_identifier = *GetCompleteDoorIdentifier(
213 h_painting.required_door(), current_map_name);
214 DoorInfo& required_door_info = info_.doors[required_door_identifier];
215 required_door_info.paintings_referenced_by.push_back(painting_identifier);
216 }
217 }
218
219 void ProcessPort(const HumanPort& h_port, const std::string& current_map_name,
220 const std::string& current_room_name) {
221 PortIdentifier port_identifier;
222 port_identifier.set_map(current_map_name);
223 port_identifier.set_room(current_room_name);
224 port_identifier.set_name(h_port.name());
225
226 PortInfo& port_info = info_.ports[port_identifier];
227 port_info.definitions.push_back(h_port);
228
229 MapInfo& map_info = info_.maps[current_map_name];
230 map_info.game_nodes[h_port.path()].uses++;
231
232 if (h_port.has_required_door()) {
233 DoorIdentifier required_door_identifier =
234 *GetCompleteDoorIdentifier(h_port.required_door(), current_map_name);
235 DoorInfo& required_door_info = info_.doors[required_door_identifier];
236 required_door_info.ports_referenced_by.push_back(port_identifier);
237 }
238 }
239
240 void ProcessLetter(const HumanLetter& h_letter,
241 const std::string& current_map_name,
242 const std::string& current_room_name) {
243 LetterIdentifier letter_identifier =
244 std::make_tuple(h_letter.key()[0], h_letter.level2());
245 LetterInfo& letter_info = info_.letters[letter_identifier];
246
247 RoomIdentifier room_identifier;
248 room_identifier.set_map(current_map_name);
249 room_identifier.set_name(current_room_name);
250 letter_info.defined_in.push_back(room_identifier);
251
252 MapInfo& map_info = info_.maps[current_map_name];
253 map_info.game_nodes[h_letter.path()].uses++;
254 }
255
256 void ProcessMastery(const HumanMastery& h_mastery,
257 const std::string& current_map_name,
258 const std::string& current_room_name) {
259 MapInfo& map_info = info_.maps[current_map_name];
260 map_info.game_nodes[h_mastery.path()].uses++;
261 }
262
263 void ProcessKeyholder(const HumanKeyholder& h_keyholder,
264 const std::string& current_map_name,
265 const std::string& current_room_name) {
266 KeyholderIdentifier keyholder_identifier;
267 keyholder_identifier.set_map(current_map_name);
268 keyholder_identifier.set_room(current_room_name);
269 keyholder_identifier.set_name(h_keyholder.name());
270
271 KeyholderInfo& keyholder_info = info_.keyholders[keyholder_identifier];
272 keyholder_info.definitions.push_back(h_keyholder);
273
274 MapInfo& map_info = info_.maps[current_map_name];
275 map_info.game_nodes[h_keyholder.path()].uses++;
276 }
277
278 void ProcessEnding(const HumanEnding& h_ending,
279 const std::string& current_map_name,
280 const std::string& current_room_name) {
281 EndingInfo& ending_info = info_.endings[h_ending.name()];
282
283 RoomIdentifier room_identifier;
284 room_identifier.set_map(current_map_name);
285 room_identifier.set_name(current_room_name);
286 ending_info.defined_in.push_back(room_identifier);
287
288 MapInfo& map_info = info_.maps[current_map_name];
289 map_info.game_nodes[h_ending.path()].uses++;
290 }
291
292 void ProcessDoorsFile(std::filesystem::path path,
293 const std::string& current_map_name) {
294 if (!std::filesystem::exists(path)) {
295 return;
296 }
297
298 auto doors = ReadMessageFromFile<HumanDoors>(path.string());
299
300 for (const HumanDoor& door : doors.doors()) {
301 ProcessDoor(door, current_map_name);
302 }
303 }
304
305 void ProcessDoor(const HumanDoor& h_door,
306 const std::string& current_map_name) {
307 DoorIdentifier door_identifier;
308 door_identifier.set_map(current_map_name);
309 door_identifier.set_name(h_door.name());
310
311 DoorInfo& door_info = info_.doors[door_identifier];
312 door_info.definitions.push_back(h_door);
313
314 if (h_door.has_location_room()) {
315 RoomIdentifier location_room_identifier;
316 location_room_identifier.set_map(current_map_name);
317 location_room_identifier.set_name(h_door.location_room());
318 info_.rooms[location_room_identifier].doors_referenced_by.push_back(
319 door_identifier);
320 }
321
322 for (const PaintingIdentifier& pi : h_door.move_paintings()) {
323 auto complete_painting_identifier =
324 GetCompletePaintingIdentifier(pi, current_map_name, std::nullopt);
325 if (complete_painting_identifier) {
326 PaintingInfo& move_painting_info =
327 info_.paintings[*complete_painting_identifier];
328 move_painting_info.doors_referenced_by.push_back(door_identifier);
329 } else {
330 door_info.malformed_identifiers.paintings.push_back(pi);
331 }
332 }
333
334 for (const PanelIdentifier& pi : h_door.panels()) {
335 auto complete_panel_identifier = GetCompletePanelIdentifierWithoutAnswer(
336 pi, current_map_name, std::nullopt);
337 if (complete_panel_identifier) {
338 PanelInfo& panel_info = info_.panels[*complete_panel_identifier];
339 panel_info.doors_referenced_by.push_back(door_identifier);
340
341 if (pi.has_answer()) {
342 panel_info.proxies[pi.answer()].doors_referenced_by.push_back(
343 door_identifier);
344 }
345 } else {
346 door_info.malformed_identifiers.panels.push_back(pi);
347 }
348 }
349
350 for (const KeyholderIdentifier& ki : h_door.keyholders()) {
351 auto complete_keyholder_identifier =
352 GetCompleteKeyholderIdentifierWithoutKey(ki, current_map_name,
353 std::nullopt);
354 if (complete_keyholder_identifier) {
355 KeyholderInfo& keyholder_info =
356 info_.keyholders[*complete_keyholder_identifier];
357 keyholder_info.doors_referenced_by.push_back(door_identifier);
358 } else {
359 door_info.malformed_identifiers.keyholders.push_back(ki);
360 }
361 }
362
363 for (const RoomIdentifier& ri : h_door.rooms()) {
364 RoomIdentifier complete_room_identifier =
365 *GetCompleteRoomIdentifier(ri, current_map_name);
366 RoomInfo& room_info = info_.rooms[complete_room_identifier];
367 room_info.doors_referenced_by.push_back(door_identifier);
368 }
369
370 for (const DoorIdentifier& di : h_door.doors()) {
371 DoorIdentifier complete_door_identifier =
372 *GetCompleteDoorIdentifier(di, current_map_name);
373 DoorInfo& other_door_info = info_.doors[complete_door_identifier];
374 other_door_info.doors_referenced_by.push_back(door_identifier);
375 }
376 }
377
378 void ProcessConnectionsFile(std::filesystem::path path,
379 std::optional<std::string> current_map_name) {
380 if (!std::filesystem::exists(path)) {
381 return;
382 }
383
384 auto connections = ReadMessageFromFile<HumanConnections>(path.string());
385
386 for (const HumanConnection& connection : connections.connections()) {
387 ProcessConnection(connection, current_map_name);
388 }
389 }
390
391 void ProcessConnection(const HumanConnection& human_connection,
392 const std::optional<std::string>& current_map_name) {
393 if (human_connection.has_from_room()) {
394 if (current_map_name) {
395 RoomIdentifier room_identifier;
396 room_identifier.set_map(*current_map_name);
397 room_identifier.set_name(human_connection.from_room());
398
399 RoomInfo& room_info = info_.rooms[room_identifier];
400 room_info.connections_referenced_by.push_back(human_connection);
401 } else {
402 // Not sure where else to store this right now.
403 std::cout << "A global connection used from_room." << std::endl;
404 }
405 } else if (human_connection.has_from()) {
406 ProcessSingleConnection(human_connection, human_connection.from(),
407 current_map_name,
408 /*is_target=*/!human_connection.oneway() &&
409 !human_connection.bypass_target_door());
410 }
411
412 if (human_connection.has_to_room()) {
413 if (current_map_name) {
414 RoomIdentifier room_identifier;
415 room_identifier.set_map(*current_map_name);
416 room_identifier.set_name(human_connection.to_room());
417
418 RoomInfo& room_info = info_.rooms[room_identifier];
419 room_info.connections_referenced_by.push_back(human_connection);
420 } else {
421 // Not sure where else to store this right now.
422 std::cout << "A global connection used to_room." << std::endl;
423 }
424 } else if (human_connection.has_to()) {
425 ProcessSingleConnection(
426 human_connection, human_connection.to(), current_map_name,
427 /*is_target=*/!human_connection.bypass_target_door());
428 }
429
430 if (human_connection.has_door()) {
431 auto door_identifier =
432 GetCompleteDoorIdentifier(human_connection.door(), current_map_name);
433 if (door_identifier) {
434 DoorInfo& door_info = info_.doors[*door_identifier];
435 door_info.connections_referenced_by.push_back(human_connection);
436 } else {
437 // Not sure where else to store this right now.
438 std::cout
439 << "A connection used the following malformed door identifier: "
440 << human_connection.door().ShortDebugString() << std::endl;
441 }
442 }
443 }
444
445 void ProcessSingleConnection(
446 const HumanConnection& human_connection,
447 const HumanConnection::Endpoint& endpoint,
448 const std::optional<std::string>& current_map_name, bool is_target) {
449 if (endpoint.has_room()) {
450 auto room_identifier =
451 GetCompleteRoomIdentifier(endpoint.room(), current_map_name);
452 if (room_identifier) {
453 RoomInfo& room_info = info_.rooms[*room_identifier];
454 room_info.connections_referenced_by.push_back(human_connection);
455 } else {
456 // Not sure where else to store this right now.
457 std::cout
458 << "A connection used the following malformed room identifier: "
459 << endpoint.room().ShortDebugString() << std::endl;
460 }
461 } else if (endpoint.has_painting()) {
462 auto painting_identifier = GetCompletePaintingIdentifier(
463 endpoint.painting(), current_map_name, std::nullopt);
464 if (painting_identifier) {
465 PaintingInfo& painting_info = info_.paintings[*painting_identifier];
466 painting_info.connections_referenced_by.push_back(human_connection);
467
468 if (is_target) {
469 painting_info.target_connections_referenced_by.push_back(
470 human_connection);
471 }
472 } else {
473 // Not sure where else to store this right now.
474 std::cout
475 << "A connection used the following malformed painting identifier: "
476 << endpoint.painting().ShortDebugString() << std::endl;
477 }
478 } else if (endpoint.has_port()) {
479 auto port_identifier = GetCompletePortIdentifier(
480 endpoint.port(), current_map_name, std::nullopt);
481 if (port_identifier) {
482 PortInfo& port_info = info_.ports[*port_identifier];
483 port_info.connections_referenced_by.push_back(human_connection);
484
485 if (is_target) {
486 port_info.target_connections_referenced_by.push_back(
487 human_connection);
488 }
489 } else {
490 // Not sure where else to store this right now.
491 std::cout
492 << "A connection used the following malformed port identifier: "
493 << endpoint.port().ShortDebugString() << std::endl;
494 }
495 } else if (endpoint.has_panel()) {
496 auto panel_identifier = GetCompletePanelIdentifierWithoutAnswer(
497 endpoint.panel(), current_map_name, std::nullopt);
498 if (panel_identifier) {
499 PanelInfo& panel_info = info_.panels[*panel_identifier];
500 panel_info.connections_referenced_by.push_back(human_connection);
501
502 if (endpoint.panel().has_answer()) {
503 panel_info.proxies[endpoint.panel().answer()]
504 .connections_referenced_by.push_back(human_connection);
505 }
506
507 if (is_target) {
508 panel_info.target_connections_referenced_by.push_back(
509 human_connection);
510 }
511 }
512 }
513 }
514
515 void ProcessProgressivesFile(std::filesystem::path path) {
516 if (!std::filesystem::exists(path)) {
517 return;
518 }
519
520 auto h_progs = ReadMessageFromFile<HumanProgressives>(path.string());
521
522 for (const HumanProgressive& h_prog : h_progs.progressives()) {
523 ProcessProgressive(h_prog);
524 }
525 }
526
527 void ProcessProgressive(const HumanProgressive& h_prog) {
528 ProgressiveInfo& prog_info = info_.progressives[h_prog.name()];
529 prog_info.definitions.push_back(h_prog);
530
531 for (const DoorIdentifier& di : h_prog.doors()) {
532 if (!di.has_map()) {
533 prog_info.malformed_doors.push_back(di);
534 continue;
535 }
536
537 DoorInfo& door_info = info_.doors[di];
538 door_info.progressives_referenced_by.push_back(h_prog.name());
539 }
540 }
541
542 void ProcessDoorGroupsFile(std::filesystem::path path) {
543 if (!std::filesystem::exists(path)) {
544 return;
545 }
546
547 auto h_groups = ReadMessageFromFile<HumanDoorGroups>(path.string());
548
549 for (const HumanDoorGroup& h_group : h_groups.door_groups()) {
550 ProcessDoorGroup(h_group);
551 }
552 }
553
554 void ProcessDoorGroup(const HumanDoorGroup& h_group) {
555 DoorGroupInfo& group_info = info_.door_groups[h_group.name()];
556 group_info.definitions.push_back(h_group);
557
558 for (const DoorIdentifier& di : h_group.doors()) {
559 if (!di.has_map()) {
560 group_info.malformed_doors.push_back(di);
561 continue;
562 }
563
564 DoorInfo& door_info = info_.doors[di];
565 door_info.door_groups_referenced_by.push_back(h_group.name());
566 }
567 }
568
569 void ProcessIdsFile(std::filesystem::path path) {
570 auto ids = ReadIdsFromYaml(path.string());
571
572 DoorIdentifier di;
573 PanelIdentifier pai;
574 PortIdentifier poi;
575 KeyholderIdentifier ki;
576
577 for (const auto& [map_name, map] : ids.maps()) {
578 di.set_map(map_name);
579 pai.set_map(map_name);
580 poi.set_map(map_name);
581 ki.set_map(map_name);
582
583 for (const auto& [door_name, ap_id] : map.doors()) {
584 di.set_name(door_name);
585
586 DoorInfo& door_info = info_.doors[di];
587 door_info.has_id = true;
588 }
589
590 for (const auto& [room_name, room] : map.rooms()) {
591 pai.set_room(room_name);
592 poi.set_room(room_name);
593 ki.set_room(room_name);
594
595 for (const auto& [panel_name, ap_id] : room.panels()) {
596 pai.set_name(panel_name);
597
598 PanelInfo& panel_info = info_.panels[pai];
599 panel_info.has_id = true;
600 }
601
602 for (const auto& [mastery_name, ap_id] : room.masteries()) {
603 // TODO: Mastery
604 }
605
606 for (const auto& [keyholder_name, ap_id] : room.keyholders()) {
607 ki.set_name(keyholder_name);
608
609 KeyholderInfo& keyholder_info = info_.keyholders[ki];
610 keyholder_info.has_id = true;
611 }
612
613 for (const auto& [port_name, ap_id] : room.ports()) {
614 poi.set_name(port_name);
615
616 PortInfo& port_info = info_.ports[poi];
617 port_info.has_id = true;
618 }
619 }
620 }
621
622 for (const auto& [tag, id] : ids.special()) {
623 // TODO: Specials
624 }
625
626 for (const auto& [letter_name, ap_id] : ids.letters()) {
627 LetterIdentifier li =
628 std::make_tuple(letter_name[0], letter_name[1] == '2');
629 LetterInfo& letter_info = info_.letters[li];
630 letter_info.has_id = true;
631 }
632
633 for (const auto& [ending_name, ap_id] : ids.endings()) {
634 EndingInfo& ending_info = info_.endings[ending_name];
635 ending_info.has_id = true;
636 }
637
638 for (const auto& [prog_name, ap_id] : ids.progressives()) {
639 ProgressiveInfo& prog_info = info_.progressives[prog_name];
640 prog_info.has_id = true;
641 }
642
643 for (const auto& [group_name, ap_id] : ids.door_groups()) {
644 DoorGroupInfo& group_info = info_.door_groups[group_name];
645 group_info.has_id = true;
646 }
647 }
648
649 std::string mapdir_;
650 CollectedInfo& info_;
651};
652
653} // namespace
654
655void ProcessHumanData(const std::string& mapdir, CollectedInfo& info) {
656 HumanProcessor human_processor(mapdir, info);
657 human_processor.Run();
658}
659
660} // namespace com::fourisland::lingo2_archipelago
diff --git a/tools/validator/human_processor.h b/tools/validator/human_processor.h new file mode 100644 index 0000000..52f174f --- /dev/null +++ b/tools/validator/human_processor.h
@@ -0,0 +1,14 @@
1#ifndef TOOLS_VALIDATOR_HUMAN_PROCESSOR_H_
2#define TOOLS_VALIDATOR_HUMAN_PROCESSOR_H_
3
4#include <string>
5
6namespace com::fourisland::lingo2_archipelago {
7
8struct CollectedInfo;
9
10void ProcessHumanData(const std::string& mapdir, CollectedInfo& info);
11
12} // namespace com::fourisland::lingo2_archipelago
13
14#endif /* TOOLS_VALIDATOR_HUMAN_PROCESSOR_H_ */
diff --git a/tools/validator/main.cpp b/tools/validator/main.cpp new file mode 100644 index 0000000..1a72e9a --- /dev/null +++ b/tools/validator/main.cpp
@@ -0,0 +1,34 @@
1#include "godot_processor.h"
2#include "human_processor.h"
3#include "structs.h"
4#include "validator.h"
5
6namespace com::fourisland::lingo2_archipelago {
7namespace {
8
9void Run(const std::string& mapdir, const std::string& repodir) {
10 CollectedInfo info;
11
12 ProcessHumanData(mapdir, info);
13 ProcessGodotData(repodir, info);
14
15 ValidateCollectedInfo(info);
16}
17
18} // namespace
19} // namespace com::fourisland::lingo2_archipelago
20
21int main(int argc, char** argv) {
22 if (argc != 3) {
23 std::cout << "Incorrect argument count." << std::endl;
24 std::cout << "Usage: validator [path to map directory] [path to Lingo 2 repository]" << std::endl;
25 return 1;
26 }
27
28 std::string mapdir = argv[1];
29 std::string repodir = argv[2];
30
31 com::fourisland::lingo2_archipelago::Run(mapdir, repodir);
32
33 return 0;
34}
diff --git a/tools/validator/structs.h b/tools/validator/structs.h new file mode 100644 index 0000000..62974a8 --- /dev/null +++ b/tools/validator/structs.h
@@ -0,0 +1,149 @@
1#ifndef TOOLS_VALIDATOR_STRUCTS_H_
2#define TOOLS_VALIDATOR_STRUCTS_H_
3
4#include <map>
5#include <string>
6#include <vector>
7
8#include "proto/human.pb.h"
9#include "util/identifiers.h"
10
11namespace com::fourisland::lingo2_archipelago {
12
13struct MalformedIdentifiers {
14 std::vector<PaintingIdentifier> paintings;
15 std::vector<PanelIdentifier> panels;
16 std::vector<KeyholderIdentifier> keyholders;
17
18 bool HasAny() const {
19 return !paintings.empty() || !panels.empty() || !keyholders.empty();
20 }
21};
22
23struct GameNodeInfo {
24 bool defined = false;
25 int uses = 0;
26};
27
28struct MapInfo {
29 std::map<std::string, GameNodeInfo> game_nodes;
30
31 std::optional<PortIdentifier> malformed_worldport_entrance;
32};
33
34struct RoomInfo {
35 std::vector<HumanRoom> definitions;
36
37 std::vector<DoorIdentifier> doors_referenced_by;
38 std::vector<PanelIdentifier> panels_referenced_by;
39 std::vector<HumanConnection> connections_referenced_by;
40};
41
42struct DoorInfo {
43 std::vector<HumanDoor> definitions;
44 bool has_id = false;
45
46 std::vector<HumanConnection> connections_referenced_by;
47 std::vector<DoorIdentifier> doors_referenced_by;
48 std::vector<PanelIdentifier> panels_referenced_by;
49 std::vector<PaintingIdentifier> paintings_referenced_by;
50 std::vector<PortIdentifier> ports_referenced_by;
51 std::vector<std::string> progressives_referenced_by;
52 std::vector<std::string> door_groups_referenced_by;
53
54 MalformedIdentifiers malformed_identifiers;
55};
56
57struct PortInfo {
58 std::vector<HumanPort> definitions;
59 bool has_id = false;
60
61 std::vector<HumanConnection> connections_referenced_by;
62 std::vector<HumanConnection> target_connections_referenced_by;
63 std::vector<std::string> map_worldport_entrances;
64};
65
66struct PaintingInfo {
67 std::vector<HumanPainting> definitions;
68
69 std::vector<HumanConnection> connections_referenced_by;
70 std::vector<HumanConnection> target_connections_referenced_by;
71 std::vector<DoorIdentifier> doors_referenced_by;
72};
73
74struct ProxyInfo {
75 std::vector<Proxy> definitions;
76
77 std::vector<HumanConnection> connections_referenced_by;
78 std::vector<DoorIdentifier> doors_referenced_by;
79};
80
81struct PanelInfo {
82 std::vector<HumanPanel> definitions;
83 bool has_id = false;
84
85 std::string map_area_name;
86
87 std::vector<HumanConnection> connections_referenced_by;
88 std::vector<HumanConnection> target_connections_referenced_by;
89 std::vector<DoorIdentifier> doors_referenced_by;
90
91 std::map<std::string, ProxyInfo> proxies;
92};
93
94struct KeyholderInfo {
95 std::vector<HumanKeyholder> definitions;
96 bool has_id = false;
97
98 std::vector<DoorIdentifier> doors_referenced_by;
99};
100
101using LetterIdentifier = std::tuple<char, bool>;
102
103struct LetterInfo {
104 std::vector<RoomIdentifier> defined_in;
105 bool has_id = false;
106};
107
108struct EndingInfo {
109 std::vector<RoomIdentifier> defined_in;
110 bool has_id = false;
111};
112
113struct PanelNameInfo {
114 std::vector<PanelIdentifier> panels_used_by;
115};
116
117struct ProgressiveInfo {
118 std::vector<HumanProgressive> definitions;
119 bool has_id = false;
120
121 std::vector<DoorIdentifier> malformed_doors;
122};
123
124struct DoorGroupInfo {
125 std::vector<HumanDoorGroup> definitions;
126 bool has_id = false;
127
128 std::vector<DoorIdentifier> malformed_doors;
129};
130
131struct CollectedInfo {
132 std::map<std::string, MapInfo> maps;
133 std::map<RoomIdentifier, RoomInfo, RoomIdentifierLess> rooms;
134 std::map<DoorIdentifier, DoorInfo, DoorIdentifierLess> doors;
135 std::map<PortIdentifier, PortInfo, PortIdentifierLess> ports;
136 std::map<PaintingIdentifier, PaintingInfo, PaintingIdentifierLess> paintings;
137 std::map<PanelIdentifier, PanelInfo, PanelIdentifierLess> panels;
138 std::map<KeyholderIdentifier, KeyholderInfo, KeyholderIdentifierLess>
139 keyholders;
140 std::map<LetterIdentifier, LetterInfo> letters;
141 std::map<std::string, EndingInfo> endings;
142 std::map<std::string, PanelNameInfo> panel_names;
143 std::map<std::string, ProgressiveInfo> progressives;
144 std::map<std::string, DoorGroupInfo> door_groups;
145};
146
147} // namespace com::fourisland::lingo2_archipelago
148
149#endif /* TOOLS_VALIDATOR_STRUCTS_H_ */
diff --git a/tools/validator/validator.cpp b/tools/validator/validator.cpp new file mode 100644 index 0000000..fe36be7 --- /dev/null +++ b/tools/validator/validator.cpp
@@ -0,0 +1,587 @@
1#include "validator.h"
2
3#include <iostream>
4
5#include "proto/human.pb.h"
6#include "structs.h"
7#include "util/identifiers.h"
8
9namespace com::fourisland::lingo2_archipelago {
10namespace {
11
12class Validator {
13 public:
14 explicit Validator(const CollectedInfo& info) : info_(info) {}
15
16 void Validate() const {
17 for (const auto& [map_name, map_info] : info_.maps) {
18 ValidateMap(map_name, map_info);
19 }
20 for (const auto& [room_identifier, room_info] : info_.rooms) {
21 ValidateRoom(room_identifier, room_info);
22 }
23 for (const auto& [door_identifier, door_info] : info_.doors) {
24 ValidateDoor(door_identifier, door_info);
25 }
26 for (const auto& [port_identifier, port_info] : info_.ports) {
27 ValidatePort(port_identifier, port_info);
28 }
29 for (const auto& [painting_identifier, painting_info] : info_.paintings) {
30 ValidatePainting(painting_identifier, painting_info);
31 }
32 for (const auto& [panel_identifier, panel_info] : info_.panels) {
33 ValidatePanel(panel_identifier, panel_info);
34 }
35 for (const auto& [keyholder_identifier, keyholder_info] :
36 info_.keyholders) {
37 ValidateKeyholder(keyholder_identifier, keyholder_info);
38 }
39 for (const auto& [letter_identifier, letter_info] : info_.letters) {
40 ValidateLetter(letter_identifier, letter_info);
41 }
42 for (const auto& [ending_name, ending_info] : info_.endings) {
43 ValidateEnding(ending_name, ending_info);
44 }
45 for (const auto& [panel_name, panel_info] : info_.panel_names) {
46 ValidatePanelName(panel_name, panel_info);
47 }
48 for (const auto& [prog_name, prog_info] : info_.progressives) {
49 ValidateProgressive(prog_name, prog_info);
50 }
51 for (const auto& [group_name, group_info] : info_.door_groups) {
52 ValidateDoorGroup(group_name, group_info);
53 }
54 }
55
56 private:
57 void ValidateMap(const std::string& map_name, const MapInfo& map_info) const {
58 for (const auto& [node_path, node_info] : map_info.game_nodes) {
59 if (node_info.uses > 1) {
60 std::cout << "Map " << map_name << " node " << node_path
61 << " is used in multiple places." << std::endl;
62 } else if (node_info.uses == 0) {
63 std::cout << "Map " << map_name << " node " << node_path
64 << " is not used." << std::endl;
65 }
66
67 if (!node_info.defined) {
68 std::cout << "Map " << map_name << " node " << node_path
69 << " is not defined in the game file." << std::endl;
70 }
71 }
72
73 if (map_info.malformed_worldport_entrance) {
74 std::cout << "The worldport entrance for map " << map_name
75 << " is malformed." << std::endl;
76 }
77 }
78
79 void ValidateRoom(const RoomIdentifier& room_identifier,
80 const RoomInfo& room_info) const {
81 if (room_info.definitions.empty()) {
82 std::cout << "Room " << room_identifier.ShortDebugString()
83 << " has no definition, but was referenced:" << std::endl;
84
85 for (const DoorIdentifier& door_identifier :
86 room_info.doors_referenced_by) {
87 std::cout << " DOOR " << door_identifier.ShortDebugString()
88 << std::endl;
89 }
90
91 for (const PanelIdentifier& panel_identifier :
92 room_info.panels_referenced_by) {
93 std::cout << " PANEL " << panel_identifier.ShortDebugString()
94 << std::endl;
95 }
96
97 for (const HumanConnection& connection :
98 room_info.connections_referenced_by) {
99 std::cout << " CONNECTION " << connection.ShortDebugString()
100 << std::endl;
101 }
102 } else if (room_info.definitions.size() > 1) {
103 std::cout << "Room " << room_identifier.ShortDebugString()
104 << " was defined multiple times." << std::endl;
105 }
106 }
107
108 bool DoesDoorNeedLocationName(const HumanDoor& h_door,
109 const std::string& map_name) const {
110 if (h_door.type() != DoorType::STANDARD) {
111 return false;
112 }
113
114 if (h_door.keyholders_size() > 0 || h_door.white_ending() ||
115 h_door.complete_at() > 0) {
116 return true;
117 }
118
119 if (h_door.panels_size() > 4) {
120 return true;
121 }
122
123 std::set<std::string> map_areas;
124 for (const PanelIdentifier& pi : h_door.panels()) {
125 auto full_pi =
126 GetCompletePanelIdentifierWithoutAnswer(pi, map_name, std::nullopt);
127 if (full_pi) {
128 auto panel_info_it = info_.panels.find(*full_pi);
129 if (panel_info_it != info_.panels.end()) {
130 const PanelInfo& panel_info = panel_info_it->second;
131
132 map_areas.insert(panel_info.map_area_name);
133 }
134 }
135 }
136
137 if (map_areas.size() > 1) {
138 return true;
139 }
140
141 return false;
142 }
143
144 void ValidateDoor(const DoorIdentifier& door_identifier,
145 const DoorInfo& door_info) const {
146 if (door_info.definitions.empty()) {
147 std::cout << "Door " << door_identifier.ShortDebugString()
148 << " has no definition, but was referenced:" << std::endl;
149
150 for (const DoorIdentifier& other_door_identifier :
151 door_info.doors_referenced_by) {
152 std::cout << " DOOR " << other_door_identifier.ShortDebugString()
153 << std::endl;
154 }
155
156 for (const PanelIdentifier& panel_identifier :
157 door_info.panels_referenced_by) {
158 std::cout << " PANEL " << panel_identifier.ShortDebugString()
159 << std::endl;
160 }
161
162 for (const PaintingIdentifier& painting_identifier :
163 door_info.paintings_referenced_by) {
164 std::cout << " PAINTING " << painting_identifier.ShortDebugString()
165 << std::endl;
166 }
167
168 for (const PortIdentifier& port_identifier :
169 door_info.ports_referenced_by) {
170 std::cout << " PORT " << port_identifier.ShortDebugString()
171 << std::endl;
172 }
173
174 for (const HumanConnection& connection :
175 door_info.connections_referenced_by) {
176 std::cout << " CONNECTION " << connection.ShortDebugString()
177 << std::endl;
178 }
179
180 for (const std::string& prog_name :
181 door_info.progressives_referenced_by) {
182 std::cout << " PROGRESSIVE " << prog_name << std::endl;
183 }
184
185 for (const std::string& group_name :
186 door_info.door_groups_referenced_by) {
187 std::cout << " DOOR GROUP " << group_name << std::endl;
188 }
189
190 if (door_info.has_id) {
191 std::cout << " An AP ID is present." << std::endl;
192 }
193 } else if (door_info.definitions.size() > 1) {
194 std::cout << "Door " << door_identifier.ShortDebugString()
195 << " was defined multiple times." << std::endl;
196 }
197
198 if (door_info.malformed_identifiers.HasAny()) {
199 std::cout << "Door " << door_identifier.ShortDebugString()
200 << " has malformed identifiers:" << std::endl;
201
202 for (const PaintingIdentifier& painting_identifier :
203 door_info.malformed_identifiers.paintings) {
204 std::cout << " PAINTING " << painting_identifier.ShortDebugString()
205 << std::endl;
206 }
207
208 for (const PanelIdentifier& panel_identifier :
209 door_info.malformed_identifiers.panels) {
210 std::cout << " PANEL " << panel_identifier.ShortDebugString()
211 << std::endl;
212 }
213
214 for (const KeyholderIdentifier& keyholder_identifier :
215 door_info.malformed_identifiers.keyholders) {
216 std::cout << " KEYHOLDER " << keyholder_identifier.ShortDebugString()
217 << std::endl;
218 }
219 }
220
221 for (const HumanDoor& h_door : door_info.definitions) {
222 if (DoesDoorNeedLocationName(h_door, door_identifier.map()) &&
223 !h_door.has_location_name()) {
224 std::cout << "Door " << door_identifier.ShortDebugString()
225 << " needs an explicit location name." << std::endl;
226 }
227
228 if (h_door.type() == DoorType::STANDARD ||
229 h_door.type() == DoorType::LOCATION_ONLY ||
230 h_door.type() == DoorType::GRAVESTONE || h_door.legacy_location()) {
231 if (h_door.double_letters()) {
232 std::cout << "Door " << door_identifier.ShortDebugString()
233 << " is a location that depends on double_letters."
234 << std::endl;
235 }
236
237 if (!h_door.has_location_room()) {
238 std::cout << "Door " << door_identifier.ShortDebugString()
239 << " is missing a location_room." << std::endl;
240 }
241 }
242
243 bool needs_id = (h_door.type() != DoorType::EVENT || h_door.latch() ||
244 h_door.legacy_location());
245 if (door_info.has_id != needs_id) {
246 if (needs_id) {
247 std::cout << "Door " << door_identifier.ShortDebugString()
248 << " is missing an AP ID." << std::endl;
249 } else {
250 std::cout << "Door " << door_identifier.ShortDebugString()
251 << " should not have an AP ID." << std::endl;
252 }
253 }
254 }
255 }
256
257 void ValidatePort(const PortIdentifier& port_identifier,
258 const PortInfo& port_info) const {
259 if (port_info.definitions.empty()) {
260 std::cout << "Port " << port_identifier.ShortDebugString()
261 << " has no definition, but was referenced:" << std::endl;
262
263 for (const HumanConnection& connection :
264 port_info.connections_referenced_by) {
265 std::cout << " CONNECTION " << connection.ShortDebugString()
266 << std::endl;
267 }
268
269 for (const std::string& map_name : port_info.map_worldport_entrances) {
270 std::cout << " MAP (worldport_entrance) " << map_name << std::endl;
271 }
272
273 if (port_info.has_id) {
274 std::cout << " An AP ID is present." << std::endl;
275 }
276 } else if (port_info.definitions.size() > 1) {
277 std::cout << "Port " << port_identifier.ShortDebugString()
278 << " was defined multiple times." << std::endl;
279 }
280
281 if (!port_info.target_connections_referenced_by.empty()) {
282 for (const HumanPort& port : port_info.definitions) {
283 if (port.has_required_door()) {
284 std::cout << "Port " << port_identifier.ShortDebugString()
285 << " has a required door but is the target of a connection:"
286 << std::endl;
287
288 for (const HumanConnection& connection :
289 port_info.target_connections_referenced_by) {
290 std::cout << " CONNECTION " << connection.ShortDebugString()
291 << std::endl;
292 }
293 }
294 }
295 }
296
297 for (const HumanPort& port : port_info.definitions) {
298 if (!port.no_shuffle()) {
299 if (!port.has_destination()) {
300 std::cout << "Port " << port_identifier.ShortDebugString()
301 << " is shuffleable and missing a destination."
302 << std::endl;
303 }
304 if (!port.has_rotation()) {
305 std::cout << "Port " << port_identifier.ShortDebugString()
306 << " is shuffleable and missing a rotation." << std::endl;
307 }
308 if (!port_info.has_id) {
309 std::cout << "Port " << port_identifier.ShortDebugString()
310 << " is missing an AP ID." << std::endl;
311 }
312 } else {
313 if (port_info.has_id) {
314 std::cout << "Port " << port_identifier.ShortDebugString()
315 << " should not have an AP ID." << std::endl;
316 }
317 }
318 }
319 }
320
321 void ValidatePainting(const PaintingIdentifier& painting_identifier,
322 const PaintingInfo& painting_info) const {
323 if (painting_info.definitions.empty()) {
324 std::cout << "Painting " << painting_identifier.ShortDebugString()
325 << " has no definition, but was referenced:" << std::endl;
326
327 for (const DoorIdentifier& door_identifier :
328 painting_info.doors_referenced_by) {
329 std::cout << " DOOR " << door_identifier.ShortDebugString()
330 << std::endl;
331 }
332
333 for (const HumanConnection& connection :
334 painting_info.connections_referenced_by) {
335 std::cout << " CONNECTION " << connection.ShortDebugString()
336 << std::endl;
337 }
338 } else if (painting_info.definitions.size() > 1) {
339 std::cout << "Painting " << painting_identifier.ShortDebugString()
340 << " was defined multiple times." << std::endl;
341 }
342
343 if (!painting_info.target_connections_referenced_by.empty()) {
344 for (const HumanPainting& painting : painting_info.definitions) {
345 if (painting.has_required_door()) {
346 std::cout << "Painting " << painting_identifier.ShortDebugString()
347 << " has a required door but is the target of a connection:"
348 << std::endl;
349
350 for (const HumanConnection& connection :
351 painting_info.target_connections_referenced_by) {
352 std::cout << " CONNECTION " << connection.ShortDebugString()
353 << std::endl;
354 }
355 }
356 }
357 }
358 }
359
360 void ValidatePanel(const PanelIdentifier& panel_identifier,
361 const PanelInfo& panel_info) const {
362 if (panel_identifier.name().empty()) {
363 std::cout << "Panel " << panel_identifier.ShortDebugString()
364 << " has no name." << std::endl;
365 }
366
367 if (panel_info.definitions.empty()) {
368 std::cout << "Panel " << panel_identifier.ShortDebugString()
369 << " has no definition, but was referenced:" << std::endl;
370
371 for (const DoorIdentifier& door_identifier :
372 panel_info.doors_referenced_by) {
373 std::cout << " DOOR " << door_identifier.ShortDebugString()
374 << std::endl;
375 }
376
377 for (const HumanConnection& connection :
378 panel_info.connections_referenced_by) {
379 std::cout << " CONNECTION " << connection.ShortDebugString()
380 << std::endl;
381 }
382
383 if (panel_info.has_id) {
384 std::cout << " An AP ID is present." << std::endl;
385 }
386 } else if (panel_info.definitions.size() > 1) {
387 std::cout << "Panel " << panel_identifier.ShortDebugString()
388 << " was defined multiple times." << std::endl;
389 }
390
391 for (const auto& [answer, proxy_info] : panel_info.proxies) {
392 if (proxy_info.definitions.empty()) {
393 std::cout << "Panel " << panel_identifier.ShortDebugString()
394 << " with answer \"" << answer
395 << "\" has no definition, but was referenced:" << std::endl;
396
397 for (const DoorIdentifier& door_identifier :
398 proxy_info.doors_referenced_by) {
399 std::cout << " DOOR " << door_identifier.ShortDebugString()
400 << std::endl;
401 }
402
403 for (const HumanConnection& connection :
404 proxy_info.connections_referenced_by) {
405 std::cout << " CONNECTION " << connection.ShortDebugString()
406 << std::endl;
407 }
408 } else if (proxy_info.definitions.size() > 1) {
409 std::cout << "Panel " << panel_identifier.ShortDebugString()
410 << " with answer \"" << answer
411 << "\" was defined multiple times." << std::endl;
412 }
413 }
414
415 if (!panel_info.has_id) {
416 std::cout << "Panel " << panel_identifier.ShortDebugString()
417 << " is missing an AP ID." << std::endl;
418 }
419
420 if (!panel_info.target_connections_referenced_by.empty()) {
421 for (const HumanPanel& panel : panel_info.definitions) {
422 if (panel.has_required_door()) {
423 std::cout << "Panel " << panel_identifier.ShortDebugString()
424 << " has a required door but is the target of a connection:"
425 << std::endl;
426
427 for (const HumanConnection& connection :
428 panel_info.target_connections_referenced_by) {
429 std::cout << " CONNECTION " << connection.ShortDebugString()
430 << std::endl;
431 }
432 }
433 }
434 }
435 }
436
437 void ValidateKeyholder(const KeyholderIdentifier& keyholder_identifier,
438 const KeyholderInfo& keyholder_info) const {
439 if (keyholder_info.definitions.empty()) {
440 std::cout << "Keyholder " << keyholder_identifier.ShortDebugString()
441 << " has no definition, but was referenced:" << std::endl;
442
443 for (const DoorIdentifier& door_identifier :
444 keyholder_info.doors_referenced_by) {
445 std::cout << " DOOR " << door_identifier.ShortDebugString()
446 << std::endl;
447 }
448
449 if (keyholder_info.has_id) {
450 std::cout << " An AP ID is present." << std::endl;
451 }
452 } else if (keyholder_info.definitions.size() > 1) {
453 std::cout << "Keyholder " << keyholder_identifier.ShortDebugString()
454 << " was defined multiple times." << std::endl;
455 }
456
457 for (const HumanKeyholder& h_keyholder : keyholder_info.definitions) {
458 bool needs_id = (h_keyholder.has_key());
459
460 if (needs_id != keyholder_info.has_id) {
461 if (needs_id) {
462 std::cout << "Keyholder " << keyholder_identifier.ShortDebugString()
463 << " is missing an AP ID." << std::endl;
464 } else {
465 std::cout << "Keyholder " << keyholder_identifier.ShortDebugString()
466 << " should not have an AP ID." << std::endl;
467 }
468 }
469 }
470 }
471
472 void ValidateLetter(const LetterIdentifier& letter_identifier,
473 const LetterInfo& letter_info) const {
474 std::string letter_name = std::string(1, std::get<0>(letter_identifier)) +
475 (std::get<1>(letter_identifier) ? "2" : "1");
476
477 if (letter_info.defined_in.empty()) {
478 std::cout << "Letter " << letter_name
479 << " has no definition, but was referenced:" << std::endl;
480
481 if (letter_info.has_id) {
482 std::cout << " An AP ID is present." << std::endl;
483 }
484 } else if (letter_info.defined_in.size() > 1) {
485 std::cout << "Letter " << letter_name
486 << " was defined in multiple places:" << std::endl;
487
488 for (const RoomIdentifier& room_identifier : letter_info.defined_in) {
489 std::cout << " " << room_identifier.ShortDebugString() << std::endl;
490 }
491 }
492
493 if (!letter_info.has_id) {
494 std::cout << "Letter " << letter_name << " is missing an AP ID."
495 << std::endl;
496 }
497 }
498
499 void ValidateEnding(const std::string& ending_name,
500 const EndingInfo& ending_info) const {
501 if (ending_info.defined_in.empty()) {
502 std::cout << "Ending " << ending_name
503 << " has no definition, but was referenced:" << std::endl;
504
505 if (ending_info.has_id) {
506 std::cout << " An AP ID is present." << std::endl;
507 }
508 } else if (ending_info.defined_in.size() > 1) {
509 std::cout << "Ending " << ending_name
510 << " was defined in multiple places:" << std::endl;
511
512 for (const RoomIdentifier& room_identifier : ending_info.defined_in) {
513 std::cout << " " << room_identifier.ShortDebugString() << std::endl;
514 }
515 }
516
517 if (!ending_info.has_id) {
518 std::cout << "Ending " << ending_name << " is missing an AP ID."
519 << std::endl;
520 }
521 }
522
523 void ValidatePanelName(const std::string& panel_name,
524 const PanelNameInfo& panel_info) const {
525 if (panel_info.panels_used_by.size() > 1) {
526 std::cout << "The location name \"" << panel_name
527 << "\" is used by multiple panels:" << std::endl;
528
529 for (const PanelIdentifier& panel_identifier :
530 panel_info.panels_used_by) {
531 std::cout << " PANEL " << panel_identifier.ShortDebugString()
532 << std::endl;
533 }
534 }
535 }
536
537 void ValidateProgressive(const std::string& prog_name,
538 const ProgressiveInfo& prog_info) const {
539 if (prog_info.definitions.empty()) {
540 std::cout << "Progressive \"" << prog_name
541 << "\" has no definition, but was referenced:" << std::endl;
542
543 if (prog_info.has_id) {
544 std::cout << " An AP ID is present." << std::endl;
545 }
546 } else if (prog_info.definitions.size() > 1) {
547 std::cout << "Progressive \"" << prog_name
548 << "\" has multiple definitions." << std::endl;
549 }
550
551 if (!prog_info.has_id) {
552 std::cout << "Progressive \"" << prog_name << "\" is missing an AP ID."
553 << std::endl;
554 }
555 }
556
557 void ValidateDoorGroup(const std::string& group_name,
558 const DoorGroupInfo& group_info) const {
559 if (group_info.definitions.empty()) {
560 std::cout << "Door group \"" << group_name
561 << "\" has no definition, but was referenced:" << std::endl;
562
563 if (group_info.has_id) {
564 std::cout << " An AP ID is present." << std::endl;
565 }
566 } else if (group_info.definitions.size() > 1) {
567 std::cout << "Door group \"" << group_name
568 << "\" has multiple definitions." << std::endl;
569 }
570
571 if (!group_info.has_id) {
572 std::cout << "Door group \"" << group_name << "\" is missing an AP ID."
573 << std::endl;
574 }
575 }
576
577 const CollectedInfo& info_;
578};
579
580} // namespace
581
582void ValidateCollectedInfo(const CollectedInfo& info) {
583 Validator validator(info);
584 validator.Validate();
585}
586
587} // namespace com::fourisland::lingo2_archipelago
diff --git a/tools/validator/validator.h b/tools/validator/validator.h new file mode 100644 index 0000000..33bc7c9 --- /dev/null +++ b/tools/validator/validator.h
@@ -0,0 +1,12 @@
1#ifndef TOOLS_VALIDATOR_VALIDATOR_H
2#define TOOLS_VALIDATOR_VALIDATOR_H
3
4namespace com::fourisland::lingo2_archipelago {
5
6struct CollectedInfo;
7
8void ValidateCollectedInfo(const CollectedInfo& info);
9
10} // namespace com::fourisland::lingo2_archipelago
11
12#endif /* TOOLS_VALIDATOR_VALIDATOR_H */