Kelsidavis-WoWee/tools/editor/cli_hearth_binds_catalog.cpp
Kelsi 2d99f82531 feat(editor): add WHRT JSON round-trip (--export/--import-whrt-json)
Dual encoding for both bindKind (int 0..5 OR
"inn"/"capital"/"quest"/"guild"/"specialport"/"faction")
and factionMask (int 1..3 OR "alliance"/"horde"/"both")
on import. Export emits both int and *Name string fields
for round-trip safety and human readability — the int
form is authoritative; the *Name string can be read for
edits but is ignored if the int form is also present.

All 3 presets (starter-cities/capitals/inns) byte-
identical roundtrip OK. Token-form import smoke-tested
with mixed faction+kind tokens. CLI flag count 1102 ->
1104.
2026-05-10 00:27:05 -07:00

463 lines
16 KiB
C++

#include "cli_hearth_binds_catalog.hpp"
#include "cli_arg_parse.hpp"
#include "cli_box_emitter.hpp"
#include "pipeline/wowee_hearth_binds.hpp"
#include <nlohmann/json.hpp>
#include <cstdint>
#include <cstdio>
#include <cstring>
#include <fstream>
#include <string>
#include <vector>
namespace wowee {
namespace editor {
namespace cli {
namespace {
std::string stripWhrtExt(std::string base) {
stripExt(base, ".whrt");
return base;
}
const char* bindKindName(uint8_t k) {
using H = wowee::pipeline::WoweeHearthBinds;
switch (k) {
case H::Inn: return "inn";
case H::Capital: return "capital";
case H::Quest: return "quest";
case H::Guild: return "guild";
case H::SpecialPort: return "specialport";
case H::Faction: return "faction";
default: return "unknown";
}
}
const char* factionMaskName(uint8_t f) {
using H = wowee::pipeline::WoweeHearthBinds;
switch (f) {
case H::AllianceOnly: return "alliance";
case H::HordeOnly: return "horde";
case H::Both: return "both";
default: return "unknown";
}
}
bool saveOrError(const wowee::pipeline::WoweeHearthBinds& c,
const std::string& base, const char* cmd) {
if (!wowee::pipeline::WoweeHearthBindsLoader::save(c, base)) {
std::fprintf(stderr, "%s: failed to save %s.whrt\n",
cmd, base.c_str());
return false;
}
return true;
}
void printGenSummary(const wowee::pipeline::WoweeHearthBinds& c,
const std::string& base) {
std::printf("Wrote %s.whrt\n", base.c_str());
std::printf(" catalog : %s\n", c.name.c_str());
std::printf(" binds : %zu\n", c.entries.size());
}
int handleGenStarterCities(int& i, int argc, char** argv) {
std::string base = argv[++i];
std::string name = "StarterCityBinds";
if (parseOptArg(i, argc, argv)) name = argv[++i];
base = stripWhrtExt(base);
auto c = wowee::pipeline::WoweeHearthBindsLoader::makeStarterCities(name);
if (!saveOrError(c, base, "gen-hrt")) return 1;
printGenSummary(c, base);
return 0;
}
int handleGenCapitals(int& i, int argc, char** argv) {
std::string base = argv[++i];
std::string name = "CapitalBinds";
if (parseOptArg(i, argc, argv)) name = argv[++i];
base = stripWhrtExt(base);
auto c = wowee::pipeline::WoweeHearthBindsLoader::makeCapitals(name);
if (!saveOrError(c, base, "gen-hrt-capitals")) return 1;
printGenSummary(c, base);
return 0;
}
int handleGenStarterInns(int& i, int argc, char** argv) {
std::string base = argv[++i];
std::string name = "StarterInns";
if (parseOptArg(i, argc, argv)) name = argv[++i];
base = stripWhrtExt(base);
auto c = wowee::pipeline::WoweeHearthBindsLoader::makeStarterInns(name);
if (!saveOrError(c, base, "gen-hrt-inns")) return 1;
printGenSummary(c, base);
return 0;
}
int handleInfo(int& i, int argc, char** argv) {
std::string base = argv[++i];
bool jsonOut = consumeJsonFlag(i, argc, argv);
base = stripWhrtExt(base);
if (!wowee::pipeline::WoweeHearthBindsLoader::exists(base)) {
std::fprintf(stderr, "WHRT not found: %s.whrt\n", base.c_str());
return 1;
}
auto c = wowee::pipeline::WoweeHearthBindsLoader::load(base);
if (jsonOut) {
nlohmann::json j;
j["whrt"] = base + ".whrt";
j["name"] = c.name;
j["count"] = c.entries.size();
nlohmann::json arr = nlohmann::json::array();
for (const auto& e : c.entries) {
arr.push_back({
{"bindId", e.bindId},
{"name", e.name},
{"description", e.description},
{"mapId", e.mapId},
{"areaId", e.areaId},
{"x", e.x}, {"y", e.y}, {"z", e.z},
{"facing", e.facing},
{"npcId", e.npcId},
{"factionMask", e.factionMask},
{"factionMaskName", factionMaskName(e.factionMask)},
{"bindKind", e.bindKind},
{"bindKindName", bindKindName(e.bindKind)},
{"levelMin", e.levelMin},
{"iconColorRGBA", e.iconColorRGBA},
});
}
j["entries"] = arr;
std::printf("%s\n", j.dump(2).c_str());
return 0;
}
std::printf("WHRT: %s.whrt\n", base.c_str());
std::printf(" catalog : %s\n", c.name.c_str());
std::printf(" binds : %zu\n", c.entries.size());
if (c.entries.empty()) return 0;
std::printf(" id map area faction kind npc lvl name\n");
for (const auto& e : c.entries) {
std::printf(" %4u %4u %4u %-9s %-12s %5u %3u %s\n",
e.bindId, e.mapId, e.areaId,
factionMaskName(e.factionMask),
bindKindName(e.bindKind),
e.npcId, e.levelMin, e.name.c_str());
}
return 0;
}
// Token parser for bindKind. Returns -1 if the token
// doesn't match any known kind, else the enum value.
int parseBindKindToken(const std::string& s) {
using H = wowee::pipeline::WoweeHearthBinds;
if (s == "inn") return H::Inn;
if (s == "capital") return H::Capital;
if (s == "quest") return H::Quest;
if (s == "guild") return H::Guild;
if (s == "specialport") return H::SpecialPort;
if (s == "faction") return H::Faction;
return -1;
}
// Token parser for factionMask. Returns -1 if unknown.
int parseFactionMaskToken(const std::string& s) {
using H = wowee::pipeline::WoweeHearthBinds;
if (s == "alliance") return H::AllianceOnly;
if (s == "horde") return H::HordeOnly;
if (s == "both") return H::Both;
return -1;
}
int handleExportJson(int& i, int argc, char** argv) {
std::string base = argv[++i];
std::string out;
if (parseOptArg(i, argc, argv)) out = argv[++i];
base = stripWhrtExt(base);
if (out.empty()) out = base + ".whrt.json";
if (!wowee::pipeline::WoweeHearthBindsLoader::exists(base)) {
std::fprintf(stderr,
"export-whrt-json: WHRT not found: %s.whrt\n",
base.c_str());
return 1;
}
auto c = wowee::pipeline::WoweeHearthBindsLoader::load(base);
nlohmann::json j;
j["magic"] = "WHRT";
j["version"] = 1;
j["name"] = c.name;
nlohmann::json arr = nlohmann::json::array();
for (const auto& e : c.entries) {
arr.push_back({
{"bindId", e.bindId},
{"name", e.name},
{"description", e.description},
{"mapId", e.mapId},
{"areaId", e.areaId},
{"x", e.x}, {"y", e.y}, {"z", e.z},
{"facing", e.facing},
{"npcId", e.npcId},
{"factionMask", e.factionMask},
{"factionMaskName", factionMaskName(e.factionMask)},
{"bindKind", e.bindKind},
{"bindKindName", bindKindName(e.bindKind)},
{"levelMin", e.levelMin},
{"iconColorRGBA", e.iconColorRGBA},
});
}
j["entries"] = arr;
std::ofstream os(out);
if (!os) {
std::fprintf(stderr,
"export-whrt-json: failed to open %s for write\n",
out.c_str());
return 1;
}
os << j.dump(2) << "\n";
std::printf("Wrote %s (%zu binds)\n",
out.c_str(), c.entries.size());
return 0;
}
int handleImportJson(int& i, int argc, char** argv) {
std::string in = argv[++i];
std::string outBase;
if (parseOptArg(i, argc, argv)) outBase = argv[++i];
if (outBase.empty()) {
outBase = in;
if (outBase.size() >= 10 &&
outBase.substr(outBase.size() - 10) == ".whrt.json") {
outBase.resize(outBase.size() - 10);
} else {
stripExt(outBase, ".json");
stripExt(outBase, ".whrt");
}
}
std::ifstream is(in);
if (!is) {
std::fprintf(stderr,
"import-whrt-json: cannot open %s\n", in.c_str());
return 1;
}
nlohmann::json j;
try {
is >> j;
} catch (const std::exception& ex) {
std::fprintf(stderr,
"import-whrt-json: JSON parse error: %s\n", ex.what());
return 1;
}
wowee::pipeline::WoweeHearthBinds c;
c.name = j.value("name", std::string{});
if (!j.contains("entries") || !j["entries"].is_array()) {
std::fprintf(stderr,
"import-whrt-json: missing or non-array 'entries'\n");
return 1;
}
for (const auto& je : j["entries"]) {
wowee::pipeline::WoweeHearthBinds::Entry e;
e.bindId = je.value("bindId", 0u);
e.name = je.value("name", std::string{});
e.description = je.value("description", std::string{});
e.mapId = je.value("mapId", 0u);
e.areaId = je.value("areaId", 0u);
e.x = je.value("x", 0.0f);
e.y = je.value("y", 0.0f);
e.z = je.value("z", 0.0f);
e.facing = je.value("facing", 0.0f);
e.npcId = je.value("npcId", 0u);
// bindKind: int OR token string.
if (je.contains("bindKind")) {
const auto& bk = je["bindKind"];
if (bk.is_string()) {
int parsed = parseBindKindToken(bk.get<std::string>());
if (parsed < 0) {
std::fprintf(stderr,
"import-whrt-json: unknown bindKind "
"token '%s' on entry id=%u\n",
bk.get<std::string>().c_str(), e.bindId);
return 1;
}
e.bindKind = static_cast<uint8_t>(parsed);
} else if (bk.is_number_integer()) {
e.bindKind = static_cast<uint8_t>(bk.get<int>());
}
} else if (je.contains("bindKindName") &&
je["bindKindName"].is_string()) {
int parsed = parseBindKindToken(
je["bindKindName"].get<std::string>());
if (parsed >= 0)
e.bindKind = static_cast<uint8_t>(parsed);
}
// factionMask: int OR token string.
if (je.contains("factionMask")) {
const auto& fm = je["factionMask"];
if (fm.is_string()) {
int parsed = parseFactionMaskToken(
fm.get<std::string>());
if (parsed < 0) {
std::fprintf(stderr,
"import-whrt-json: unknown factionMask "
"token '%s' on entry id=%u\n",
fm.get<std::string>().c_str(), e.bindId);
return 1;
}
e.factionMask = static_cast<uint8_t>(parsed);
} else if (fm.is_number_integer()) {
e.factionMask = static_cast<uint8_t>(fm.get<int>());
}
} else if (je.contains("factionMaskName") &&
je["factionMaskName"].is_string()) {
int parsed = parseFactionMaskToken(
je["factionMaskName"].get<std::string>());
if (parsed >= 0)
e.factionMask = static_cast<uint8_t>(parsed);
}
e.levelMin = static_cast<uint8_t>(je.value("levelMin", 0u));
e.iconColorRGBA = je.value("iconColorRGBA", 0xFFFFFFFFu);
c.entries.push_back(e);
}
if (!wowee::pipeline::WoweeHearthBindsLoader::save(c, outBase)) {
std::fprintf(stderr,
"import-whrt-json: failed to save %s.whrt\n",
outBase.c_str());
return 1;
}
std::printf("Wrote %s.whrt (%zu binds)\n",
outBase.c_str(), c.entries.size());
return 0;
}
int handleValidate(int& i, int argc, char** argv) {
std::string base = argv[++i];
bool jsonOut = consumeJsonFlag(i, argc, argv);
base = stripWhrtExt(base);
if (!wowee::pipeline::WoweeHearthBindsLoader::exists(base)) {
std::fprintf(stderr,
"validate-whrt: WHRT not found: %s.whrt\n", base.c_str());
return 1;
}
auto c = wowee::pipeline::WoweeHearthBindsLoader::load(base);
std::vector<std::string> errors;
std::vector<std::string> warnings;
if (c.entries.empty()) {
warnings.push_back("catalog has zero entries");
}
std::vector<uint32_t> idsSeen;
for (size_t k = 0; k < c.entries.size(); ++k) {
const auto& e = c.entries[k];
std::string ctx = "entry " + std::to_string(k) +
" (id=" + std::to_string(e.bindId);
if (!e.name.empty()) ctx += " " + e.name;
ctx += ")";
if (e.bindId == 0)
errors.push_back(ctx + ": bindId is 0");
if (e.name.empty())
errors.push_back(ctx + ": name is empty");
if (e.factionMask == 0 || e.factionMask > 3) {
errors.push_back(ctx + ": factionMask " +
std::to_string(e.factionMask) +
" out of range (must be 1=A / 2=H / 3=Both)");
}
if (e.bindKind > 5) {
errors.push_back(ctx + ": bindKind " +
std::to_string(e.bindKind) +
" out of range (must be 0..5)");
}
// Bind position must not be at origin (probably
// unset). Origin coords often indicate a forgotten
// SetPosition call in a content authoring tool.
if (e.x == 0.0f && e.y == 0.0f && e.z == 0.0f) {
warnings.push_back(ctx +
": position is (0,0,0) — likely forgotten "
"SetPosition; bind would teleport player to "
"world origin");
}
// Inn-kind bindings should have an NPC bind clerk
// (the innkeeper). SpecialPort bindings often
// don't. Warn if Inn and npcId=0.
using H = wowee::pipeline::WoweeHearthBinds;
if (e.bindKind == H::Inn && e.npcId == 0) {
warnings.push_back(ctx +
": Inn bind has no NPC innkeeper (npcId=0). "
"Inn bindings should reference the WCRT "
"innkeeper entry.");
}
// Quest-given bindings without level gate are
// suspicious — quest binds usually require level
// (Theramore at 30+, Wyrmrest at 70+).
if (e.bindKind == H::Quest && e.levelMin == 0) {
warnings.push_back(ctx +
": Quest bind has levelMin=0 — quest "
"bindings usually have a minimum level "
"gate; verify if intentional");
}
for (uint32_t prev : idsSeen) {
if (prev == e.bindId) {
errors.push_back(ctx + ": duplicate bindId");
break;
}
}
idsSeen.push_back(e.bindId);
}
bool ok = errors.empty();
if (jsonOut) {
nlohmann::json j;
j["whrt"] = base + ".whrt";
j["ok"] = ok;
j["errors"] = errors;
j["warnings"] = warnings;
std::printf("%s\n", j.dump(2).c_str());
return ok ? 0 : 1;
}
std::printf("validate-whrt: %s.whrt\n", base.c_str());
if (ok && warnings.empty()) {
std::printf(" OK — %zu binds, all bindIds unique\n",
c.entries.size());
return 0;
}
if (!warnings.empty()) {
std::printf(" warnings (%zu):\n", warnings.size());
for (const auto& w : warnings)
std::printf(" - %s\n", w.c_str());
}
if (!errors.empty()) {
std::printf(" ERRORS (%zu):\n", errors.size());
for (const auto& e : errors)
std::printf(" - %s\n", e.c_str());
}
return ok ? 0 : 1;
}
} // namespace
bool handleHearthBindsCatalog(int& i, int argc, char** argv,
int& outRc) {
if (std::strcmp(argv[i], "--gen-hrt") == 0 && i + 1 < argc) {
outRc = handleGenStarterCities(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--gen-hrt-capitals") == 0 && i + 1 < argc) {
outRc = handleGenCapitals(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--gen-hrt-inns") == 0 && i + 1 < argc) {
outRc = handleGenStarterInns(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--info-whrt") == 0 && i + 1 < argc) {
outRc = handleInfo(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--validate-whrt") == 0 && i + 1 < argc) {
outRc = handleValidate(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--export-whrt-json") == 0 && i + 1 < argc) {
outRc = handleExportJson(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--import-whrt-json") == 0 && i + 1 < argc) {
outRc = handleImportJson(i, argc, argv); return true;
}
return false;
}
} // namespace cli
} // namespace editor
} // namespace wowee