from .generated import data_pb2 as data_pb2 from .items import SYMBOL_ITEMS import pkgutil class Lingo2StaticLogic: item_id_to_name: dict[int, str] location_id_to_name: dict[int, str] item_name_to_id: dict[str, int] location_name_to_id: dict[str, int] item_name_groups: dict[str, list[str]] location_name_groups: dict[str, list[str]] def __init__(self): self.item_id_to_name = {} self.location_id_to_name = {} self.item_name_groups = {} self.location_name_groups = {} file = pkgutil.get_data(__name__, "generated/data.binpb") self.objects = data_pb2.AllObjects() self.objects.ParseFromString(bytearray(file)) for door in self.objects.doors: if door.type in [data_pb2.DoorType.STANDARD, data_pb2.DoorType.LOCATION_ONLY, data_pb2.DoorType.GRAVESTONE]: location_name = self.get_door_location_name(door) self.location_id_to_name[door.ap_id] = location_name if door.type not in [data_pb2.DoorType.EVENT, data_pb2.DoorType.LOCATION_ONLY, data_pb2.DoorType.GRAVESTONE]: item_name = self.get_door_item_name(door) self.item_id_to_name[door.ap_id] = item_name for letter in self.objects.letters: letter_name = f"{letter.key.upper()}{'2' if letter.level2 else '1'}" location_name = f"{self.get_room_object_map_name(letter)} - {letter_name}" self.location_id_to_name[letter.ap_id] = location_name self.location_name_groups.setdefault("Letters", []).append(location_name) if not letter.level2: self.item_id_to_name[letter.ap_id] = letter.key.upper() self.item_name_groups.setdefault("Letters", []).append(letter.key.upper()) for mastery in self.objects.masteries: location_name = f"{self.get_room_object_map_name(mastery)} - Mastery" self.location_id_to_name[mastery.ap_id] = location_name self.location_name_groups.setdefault("Masteries", []).append(location_name) for ending in self.objects.endings: location_name = f"{self.get_room_object_map_name(ending)} - {ending.name.title()} Ending" self.location_id_to_name[ending.ap_id] = location_name self.location_name_groups.setdefault("Endings", []).append(location_name) for progressive in self.objects.progressives: self.item_id_to_name[progressive.ap_id] = progressive.name for door_group in self.objects.door_groups: self.item_id_to_name[door_group.ap_id] = door_group.name for keyholder in self.objects.keyholders: if keyholder.HasField("key"): location_name = f"{self.get_room_object_location_prefix(keyholder)} - {keyholder.key.upper()} Keyholder" self.location_id_to_name[keyholder.ap_id] = location_name self.location_name_groups.setdefault("Keyholders", []).append(location_name) self.item_id_to_name[self.objects.special_ids["A Job Well Done"]] = "A Job Well Done" for symbol_name in SYMBOL_ITEMS.values(): self.item_id_to_name[self.objects.special_ids[symbol_name]] = symbol_name self.item_name_to_id = {name: ap_id for ap_id, name in self.item_id_to_name.items()} self.location_name_to_id = {name: ap_id for ap_id, name in self.location_id_to_name.items()} def get_door_item_name(self, door: data_pb2.Door) -> str: return f"{self.get_map_object_map_name(door)} - {door.name}" def get_door_item_name_by_id(self, door_id: int) -> str: door = self.objects.doors[door_id] return self.get_door_item_name(door_id) def get_door_location_name(self, door: data_pb2.Door) -> str: map_part = self.get_room_object_location_prefix(door) if door.HasField("location_name"): return f"{map_part} - {door.location_name}" generated_location_name = self.get_generated_door_location_name(door) if generated_location_name is not None: return generated_location_name return f"{map_part} - {door.name}" def get_generated_door_location_name(self, door: data_pb2.Door) -> str | None: if door.type != data_pb2.DoorType.STANDARD: return None if len(door.keyholders) > 0 or len(door.endings) > 0 or not door.HasField("complete_at"): return None if len(door.panels) > 4: return None map_areas = set() for panel_id in door.panels: panel = self.objects.panels[panel_id.panel] panel_room = self.objects.rooms[panel.room_id] # It's okay if panel_display_name is not present because then it's coalesced with other unnamed areas. map_areas.add(panel_room.panel_display_name) if len(map_areas) > 1: return None game_map = self.objects.maps[door.map_id] map_area = map_areas.pop() if map_area == "": map_part = game_map.display_name else: map_part = f"{game_map.display_name} ({map_area})" def get_panel_display_name(panel: data_pb2.ProxyIdentifier) -> str: panel_data = self.objects.panels[panel.panel] panel_name = panel_data.display_name if panel_data.HasField("display_name") else panel_data.name if panel.HasField("answer"): return f"{panel_name}/{panel.answer.upper()}" else: return panel_name panel_names = [get_panel_display_name(panel_id) for panel_id in door.panels] panel_names.sort() return map_part + " - " + ", ".join(panel_names) def get_door_location_name_by_id(self, door_id: int) -> str: door = self.objects.doors[door_id] return self.get_door_location_name(door) def get_room_region_name(self, room_id: int) -> str: room = self.objects.rooms[room_id] return f"{self.get_map_object_map_name(room)} - {room.name}" def get_map_object_map_name(self, obj) -> str: return self.objects.maps[obj.map_id].display_name def get_room_object_map_name(self, obj) -> str: return self.get_map_object_map_name(self.objects.rooms[obj.room_id]) def get_room_object_location_prefix(self, obj) -> str: room = self.objects.rooms[obj.room_id] game_map = self.objects.maps[room.map_id] if room.HasField("panel_display_name"): return f"{game_map.display_name} ({room.panel_display_name})" else: return game_map.display_name def get_data_version(self) -> int: return self.objects.version 'n104' href='#n104'>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 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
#include "validator.h"
#include <iostream>
#include "proto/human.pb.h"
#include "structs.h"
#include "util/identifiers.h"
namespace com::fourisland::lingo2_archipelago {
namespace {
class Validator {
public:
explicit Validator(const CollectedInfo& info) : info_(info) {}
void Validate() const {
for (const auto& [map_name, map_info] : info_.maps) {
ValidateMap(map_name, map_info);
}
for (const auto& [room_identifier, room_info] : info_.rooms) {
ValidateRoom(room_identifier, room_info);
}
for (const auto& [door_identifier, door_info] : info_.doors) {
ValidateDoor(door_identifier, door_info);
}
for (const auto& [port_identifier, port_info] : info_.ports) {
ValidatePort(port_identifier, port_info);
}
for (const auto& [painting_identifier, painting_info] : info_.paintings) {
ValidatePainting(painting_identifier, painting_info);
}
for (const auto& [panel_identifier, panel_info] : info_.panels) {
ValidatePanel(panel_identifier, panel_info);
}
for (const auto& [keyholder_identifier, keyholder_info] :
info_.keyholders) {
ValidateKeyholder(keyholder_identifier, keyholder_info);
}
for (const auto& [letter_identifier, letter_info] : info_.letters) {
ValidateLetter(letter_identifier, letter_info);
}
for (const auto& [ending_name, ending_info] : info_.endings) {
ValidateEnding(ending_name, ending_info);
}
for (const auto& [panel_name, panel_info] : info_.panel_names) {
ValidatePanelName(panel_name, panel_info);
}
}
private:
void ValidateMap(const std::string& map_name, const MapInfo& map_info) const {
for (const auto& [node_path, node_info] : map_info.game_nodes) {
if (node_info.uses > 1) {
std::cout << "Map " << map_name << " node " << node_path
<< " is used in multiple places." << std::endl;
} else if (node_info.uses == 0) {
std::cout << "Map " << map_name << " node " << node_path
<< " is not used." << std::endl;
}
if (!node_info.defined) {
std::cout << "Map " << map_name << " node " << node_path
<< " is not defined in the game file." << std::endl;
}
}
}
void ValidateRoom(const RoomIdentifier& room_identifier,
const RoomInfo& room_info) const {
if (room_info.definitions.empty()) {
std::cout << "Room " << room_identifier.ShortDebugString()
<< " has no definition, but was referenced:" << std::endl;
for (const DoorIdentifier& door_identifier :
room_info.doors_referenced_by) {
std::cout << " DOOR " << door_identifier.ShortDebugString()
<< std::endl;
}
for (const PanelIdentifier& panel_identifier :
room_info.panels_referenced_by) {
std::cout << " PANEL " << panel_identifier.ShortDebugString()
<< std::endl;
}
for (const HumanConnection& connection :
room_info.connections_referenced_by) {
std::cout << " CONNECTION " << connection.ShortDebugString()
<< std::endl;
}
} else if (room_info.definitions.size() > 1) {
std::cout << "Room " << room_identifier.ShortDebugString()
<< " was defined multiple times." << std::endl;
}
}
bool DoesDoorNeedLocationName(const HumanDoor& h_door,
const std::string& map_name) const {
if (h_door.type() != DoorType::STANDARD) {
return false;
}
if (h_door.keyholders_size() > 0 || h_door.endings_size() > 0) {
return true;
}
if (h_door.panels_size() > 4) {
return true;
}
std::set<std::string> map_areas;
for (const PanelIdentifier& pi : h_door.panels()) {
auto full_pi =
GetCompletePanelIdentifierWithoutAnswer(pi, map_name, std::nullopt);
if (full_pi) {
auto panel_info_it = info_.panels.find(*full_pi);
if (panel_info_it != info_.panels.end()) {
const PanelInfo& panel_info = panel_info_it->second;
map_areas.insert(panel_info.map_area_name);
}
}
}
if (map_areas.size() > 1) {
return true;
}
return false;
}
void ValidateDoor(const DoorIdentifier& door_identifier,
const DoorInfo& door_info) const {
if (door_info.definitions.empty()) {
std::cout << "Door " << door_identifier.ShortDebugString()
<< " has no definition, but was referenced:" << std::endl;
for (const DoorIdentifier& other_door_identifier :
door_info.doors_referenced_by) {
std::cout << " DOOR " << other_door_identifier.ShortDebugString()
<< std::endl;
}
for (const PanelIdentifier& panel_identifier :
door_info.panels_referenced_by) {
std::cout << " PANEL " << panel_identifier.ShortDebugString()
<< std::endl;
}
for (const PaintingIdentifier& painting_identifier :
door_info.paintings_referenced_by) {
std::cout << " PAINTING " << painting_identifier.ShortDebugString()
<< std::endl;
}
for (const PortIdentifier& port_identifier :
door_info.ports_referenced_by) {
std::cout << " PORT " << port_identifier.ShortDebugString()
<< std::endl;
}
for (const HumanConnection& connection :
door_info.connections_referenced_by) {
std::cout << " CONNECTION " << connection.ShortDebugString()
<< std::endl;
}
} else if (door_info.definitions.size() > 1) {
std::cout << "Door " << door_identifier.ShortDebugString()
<< " was defined multiple times." << std::endl;
}
if (door_info.malformed_identifiers.HasAny()) {
std::cout << "Door " << door_identifier.ShortDebugString()
<< " has malformed identifiers:" << std::endl;
for (const PaintingIdentifier& painting_identifier :
door_info.malformed_identifiers.paintings) {
std::cout << " PAINTING " << painting_identifier.ShortDebugString()
<< std::endl;
}
for (const PanelIdentifier& panel_identifier :
door_info.malformed_identifiers.panels) {
std::cout << " PANEL " << panel_identifier.ShortDebugString()
<< std::endl;
}
for (const KeyholderIdentifier& keyholder_identifier :
door_info.malformed_identifiers.keyholders) {
std::cout << " KEYHOLDER " << keyholder_identifier.ShortDebugString()
<< std::endl;
}
}
for (const HumanDoor& h_door : door_info.definitions) {
if (DoesDoorNeedLocationName(h_door, door_identifier.map()) &&
!h_door.has_location_name()) {
std::cout << "Door " << door_identifier.ShortDebugString()
<< " needs an explicit location name." << std::endl;
}
if (h_door.double_letters() &&
(h_door.type() == DoorType::STANDARD ||
h_door.type() == DoorType::LOCATION_ONLY ||
h_door.type() == DoorType::GRAVESTONE)) {
std::cout << "Door " << door_identifier.ShortDebugString()
<< " is a location that depends on double_letters."
<< std::endl;
}
}
}
void ValidatePort(const PortIdentifier& port_identifier,
const PortInfo& port_info) const {
if (port_info.definitions.empty()) {
std::cout << "Port " << port_identifier.ShortDebugString()
<< " has no definition, but was referenced:" << std::endl;
for (const HumanConnection& connection :
port_info.connections_referenced_by) {
std::cout << " CONNECTION " << connection.ShortDebugString()
<< std::endl;
}
} else if (port_info.definitions.size() > 1) {
std::cout << "Port " << port_identifier.ShortDebugString()
<< " was defined multiple times." << std::endl;
}
}
void ValidatePainting(const PaintingIdentifier& painting_identifier,
const PaintingInfo& painting_info) const {
if (painting_info.definitions.empty()) {
std::cout << "Painting " << painting_identifier.ShortDebugString()
<< " has no definition, but was referenced:" << std::endl;
for (const DoorIdentifier& door_identifier :
painting_info.doors_referenced_by) {
std::cout << " DOOR " << door_identifier.ShortDebugString()
<< std::endl;
}
for (const HumanConnection& connection :
painting_info.connections_referenced_by) {
std::cout << " CONNECTION " << connection.ShortDebugString()
<< std::endl;
}
} else if (painting_info.definitions.size() > 1) {
std::cout << "Painting " << painting_identifier.ShortDebugString()
<< " was defined multiple times." << std::endl;
}
}
void ValidatePanel(const PanelIdentifier& panel_identifier,
const PanelInfo& panel_info) const {
if (panel_identifier.name().empty()) {
std::cout << "Panel " << panel_identifier.ShortDebugString()
<< " has no name." << std::endl;
}
if (panel_info.definitions.empty()) {
std::cout << "Panel " << panel_identifier.ShortDebugString()
<< " has no definition, but was referenced:" << std::endl;
for (const DoorIdentifier& door_identifier :
panel_info.doors_referenced_by) {
std::cout << " DOOR " << door_identifier.ShortDebugString()
<< std::endl;
}
for (const HumanConnection& connection :
panel_info.connections_referenced_by) {
std::cout << " CONNECTION " << connection.ShortDebugString()
<< std::endl;
}
} else if (panel_info.definitions.size() > 1) {
std::cout << "Panel " << panel_identifier.ShortDebugString()
<< " was defined multiple times." << std::endl;
}
for (const auto& [answer, proxy_info] : panel_info.proxies) {
if (proxy_info.definitions.empty()) {
std::cout << "Panel " << panel_identifier.ShortDebugString()
<< " with answer \"" << answer
<< "\" has no definition, but was referenced:" << std::endl;
for (const DoorIdentifier& door_identifier :
proxy_info.doors_referenced_by) {
std::cout << " DOOR " << door_identifier.ShortDebugString()
<< std::endl;
}
for (const HumanConnection& connection :
proxy_info.connections_referenced_by) {
std::cout << " CONNECTION " << connection.ShortDebugString()
<< std::endl;
}
} else if (proxy_info.definitions.size() > 1) {
std::cout << "Panel " << panel_identifier.ShortDebugString()
<< " with answer \"" << answer
<< "\" was defined multiple times." << std::endl;
}
}
}
void ValidateKeyholder(const KeyholderIdentifier& keyholder_identifier,
const KeyholderInfo& keyholder_info) const {
if (keyholder_info.definitions.empty()) {
std::cout << "Keyholder " << keyholder_identifier.ShortDebugString()
<< " has no definition, but was referenced:" << std::endl;
for (const DoorIdentifier& door_identifier :
keyholder_info.doors_referenced_by) {
std::cout << " DOOR " << door_identifier.ShortDebugString()
<< std::endl;
}
} else if (keyholder_info.definitions.size() > 1) {
std::cout << "Keyholder " << keyholder_identifier.ShortDebugString()
<< " was defined multiple times." << std::endl;
}
}
void ValidateLetter(const LetterIdentifier& letter_identifier,
const LetterInfo& letter_info) const {
std::string letter_name = std::string(1, std::get<0>(letter_identifier)) +
(std::get<1>(letter_identifier) ? "2" : "1");
if (letter_info.defined_in.size() > 1) {
std::cout << "Letter " << letter_name
<< " was defined in multiple places:" << std::endl;
for (const RoomIdentifier& room_identifier : letter_info.defined_in) {
std::cout << " " << room_identifier.ShortDebugString() << std::endl;
}
}
}
void ValidateEnding(const std::string& ending_name,
const EndingInfo& ending_info) const {
if (ending_info.defined_in.empty()) {
std::cout << "Ending " << ending_name
<< " has no definition, but was referenced:" << std::endl;
for (const DoorIdentifier& door_identifier :
ending_info.doors_referenced_by) {
std::cout << " DOOR " << door_identifier.ShortDebugString()
<< std::endl;
}
} else if (ending_info.defined_in.size() > 1) {
std::cout << "Ending " << ending_name
<< " was defined in multiple places:" << std::endl;
for (const RoomIdentifier& room_identifier : ending_info.defined_in) {
std::cout << " " << room_identifier.ShortDebugString() << std::endl;
}
}
}
void ValidatePanelName(const std::string& panel_name,
const PanelNameInfo& panel_info) const {
if (panel_info.panels_used_by.size() > 1) {
std::cout << "The location name \"" << panel_name
<< "\" is used by multiple panels:" << std::endl;
for (const PanelIdentifier& panel_identifier :
panel_info.panels_used_by) {
std::cout << " PANEL " << panel_identifier.ShortDebugString()
<< std::endl;
}
}
}
const CollectedInfo& info_;
};
} // namespace
void ValidateCollectedInfo(const CollectedInfo& info) {
Validator validator(info);
validator.Validate();
}
} // namespace com::fourisland::lingo2_archipelago