Debug: Change sprite group indentation handling

This commit is contained in:
Jonathan G Rennison
2022-08-09 21:53:43 +01:00
parent 41f2e92f5c
commit 9ed5b6e65c
5 changed files with 66 additions and 50 deletions

View File

@@ -569,7 +569,7 @@ struct NewGRFInspectWindow : Window {
collapse_lines = 0; collapse_lines = 0;
} }
if (operation == DSGPO_END && collapsed && collapse_group == group) { if (operation == DSGPO_END && collapsed && collapse_group == group) {
seprintf(tmp_buf, lastof(tmp_buf), "%*sCOLLAPSED: %u lines omitted", highlight_tag + 2, "", collapse_lines); seprintf(tmp_buf, lastof(tmp_buf), "%sCOLLAPSED: %u lines omitted", buf, collapse_lines);
buf = tmp_buf; buf = tmp_buf;
collapsed = false; collapsed = false;
highlight_tag = 0; highlight_tag = 0;

View File

@@ -1682,7 +1682,7 @@ void DumpVehicleSpriteGroup(const Vehicle *v, DumpSpriteGroupPrinter print)
} }
SpriteGroupDumper dumper(print); SpriteGroupDumper dumper(print);
dumper.DumpSpriteGroup(root_spritegroup, 0, 0); dumper.DumpSpriteGroup(root_spritegroup, 0);
for (uint i = 0; i < NUM_CARGO + 2; i++) { for (uint i = 0; i < NUM_CARGO + 2; i++) {
if (e->grf_prop.spritegroup[i] != root_spritegroup && e->grf_prop.spritegroup[i] != nullptr) { if (e->grf_prop.spritegroup[i] != root_spritegroup && e->grf_prop.spritegroup[i] != nullptr) {
@@ -1699,14 +1699,14 @@ void DumpVehicleSpriteGroup(const Vehicle *v, DumpSpriteGroupPrinter print)
break; break;
} }
print(nullptr, DSGPO_PRINT, 0, buffer); print(nullptr, DSGPO_PRINT, 0, buffer);
dumper.DumpSpriteGroup(e->grf_prop.spritegroup[i], 0, 0); dumper.DumpSpriteGroup(e->grf_prop.spritegroup[i], 0);
} }
} }
for (const WagonOverride &wo : e->overrides) { for (const WagonOverride &wo : e->overrides) {
if (wo.group != root_spritegroup && wo.group != nullptr) { if (wo.group != root_spritegroup && wo.group != nullptr) {
print(nullptr, DSGPO_PRINT, 0, ""); print(nullptr, DSGPO_PRINT, 0, "");
print(nullptr, DSGPO_PRINT, 0, "OTHER SPRITE GROUP: Wagon override"); print(nullptr, DSGPO_PRINT, 0, "OTHER SPRITE GROUP: Wagon override");
dumper.DumpSpriteGroup(wo.group, 0, 0); dumper.DumpSpriteGroup(wo.group, 0);
} }
} }
} }

View File

@@ -110,6 +110,6 @@ void DumpNewSignalsSpriteGroups(DumpSpriteGroupPrinter print)
seprintf(buffer, lastof(buffer), "GRF: %08X", BSWAP32(grf->grfid)); seprintf(buffer, lastof(buffer), "GRF: %08X", BSWAP32(grf->grfid));
print(nullptr, DSGPO_PRINT, 0, buffer); print(nullptr, DSGPO_PRINT, 0, buffer);
first = false; first = false;
dumper.DumpSpriteGroup(grf->new_signals_group, 0, 0); dumper.DumpSpriteGroup(grf->new_signals_group, 0);
} }
} }

View File

@@ -733,14 +733,14 @@ static char *GetAdjustOperationName(char *str, const char *last, DeterministicSp
return str + seprintf(str, last, "\?\?\?(0x%X)", operation); return str + seprintf(str, last, "\?\?\?(0x%X)", operation);
} }
static char *DumpSpriteGroupAdjust(char *p, const char *last, const DeterministicSpriteGroupAdjust &adjust, int padding, uint32 &highlight_tag, uint &conditional_indent) static char *DumpSpriteGroupAdjust(char *p, const char *last, const DeterministicSpriteGroupAdjust &adjust, const char *padding, uint32 &highlight_tag, uint &conditional_indent)
{ {
if (adjust.variable == 0x7D) { if (adjust.variable == 0x7D) {
/* Temp storage load */ /* Temp storage load */
highlight_tag = (1 << 16) | (adjust.parameter & 0xFFFF); highlight_tag = (1 << 16) | (adjust.parameter & 0xFFFF);
} }
p += seprintf(p, last, "%*s", padding, ""); p += seprintf(p, last, "%s", padding);
for (uint i = 0; i < conditional_indent; i++) { for (uint i = 0; i < conditional_indent; i++) {
p += seprintf(p, last, "> "); p += seprintf(p, last, "> ");
} }
@@ -831,7 +831,7 @@ static char *DumpSpriteGroupAdjust(char *p, const char *last, const Deterministi
bool SpriteGroupDumper::use_shadows = false; bool SpriteGroupDumper::use_shadows = false;
void SpriteGroupDumper::DumpSpriteGroup(const SpriteGroup *sg, int padding, uint flags) void SpriteGroupDumper::DumpSpriteGroup(const SpriteGroup *sg, const char *padding, uint flags)
{ {
uint32 highlight_tag = 0; uint32 highlight_tag = 0;
auto print = [&]() { auto print = [&]() {
@@ -840,7 +840,7 @@ void SpriteGroupDumper::DumpSpriteGroup(const SpriteGroup *sg, int padding, uint
}; };
if (sg == nullptr) { if (sg == nullptr) {
seprintf(this->buffer, lastof(this->buffer), "%*sNULL GROUP", padding, ""); seprintf(this->buffer, lastof(this->buffer), "%sNULL GROUP", padding);
print(); print();
return; return;
} }
@@ -854,7 +854,7 @@ void SpriteGroupDumper::DumpSpriteGroup(const SpriteGroup *sg, int padding, uint
}; };
auto guard = scope_guard([&]() { auto guard = scope_guard([&]() {
if (start_emitted) { if (start_emitted) {
this->print_fn(sg, DSGPO_END, padding, nullptr); this->print_fn(sg, DSGPO_END, 0, padding);
} }
}); });
@@ -864,19 +864,21 @@ void SpriteGroupDumper::DumpSpriteGroup(const SpriteGroup *sg, int padding, uint
switch (sg->type) { switch (sg->type) {
case SGT_REAL: { case SGT_REAL: {
const RealSpriteGroup *rsg = (const RealSpriteGroup*)sg; const RealSpriteGroup *rsg = (const RealSpriteGroup*)sg;
seprintf(this->buffer, lastof(this->buffer), "%*sReal (loaded: %u, loading: %u)%s [%u]", seprintf(this->buffer, lastof(this->buffer), "%sReal (loaded: %u, loading: %u)%s [%u]",
padding, "", (uint)rsg->loaded.size(), (uint)rsg->loading.size(), extra_info, sg->nfo_line); padding, (uint)rsg->loaded.size(), (uint)rsg->loading.size(), extra_info, sg->nfo_line);
print(); print();
emit_start(); emit_start();
std::string sub_padding(padding);
sub_padding += " ";
for (size_t i = 0; i < rsg->loaded.size(); i++) { for (size_t i = 0; i < rsg->loaded.size(); i++) {
seprintf(this->buffer, lastof(this->buffer), "%*sLoaded %u", padding + 2, "", (uint)i); seprintf(this->buffer, lastof(this->buffer), "%s Loaded %u", padding, (uint)i);
print(); print();
this->DumpSpriteGroup(rsg->loaded[i], padding + 4, 0); this->DumpSpriteGroup(rsg->loaded[i], sub_padding.c_str(), 0);
} }
for (size_t i = 0; i < rsg->loading.size(); i++) { for (size_t i = 0; i < rsg->loading.size(); i++) {
seprintf(this->buffer, lastof(this->buffer), "%*sLoading %u", padding + 2, "", (uint)i); seprintf(this->buffer, lastof(this->buffer), "%s Loading %u", padding, (uint)i);
print(); print();
this->DumpSpriteGroup(rsg->loading[i], padding + 4, 0); this->DumpSpriteGroup(rsg->loading[i], sub_padding.c_str(), 0);
} }
break; break;
} }
@@ -905,25 +907,25 @@ void SpriteGroupDumper::DumpSpriteGroup(const SpriteGroup *sg, int padding, uint
} }
} }
if (padding == 0 && !dsg->calculated_result && default_group != nullptr) { if (*padding == 0 && !dsg->calculated_result && default_group != nullptr) {
this->top_default_group = default_group; this->top_default_group = default_group;
} }
if (dsg == this->top_default_group && !(padding == 4 && (flags & SGDF_DEFAULT))) { if (dsg == this->top_default_group && !((flags & SGDF_DEFAULT)) && strlen(padding) == 4) {
seprintf(this->buffer, lastof(this->buffer), "%*sTOP LEVEL DEFAULT GROUP: Deterministic (%s, %s), [%u]", seprintf(this->buffer, lastof(this->buffer), "%sTOP LEVEL DEFAULT GROUP: Deterministic (%s, %s), [%u]",
padding, "", _sg_scope_names[dsg->var_scope], _sg_size_names[dsg->size], dsg->nfo_line); padding, _sg_scope_names[dsg->var_scope], _sg_size_names[dsg->size], dsg->nfo_line);
print(); print();
return; return;
} }
auto res = this->seen_dsgs.insert(dsg); auto res = this->seen_dsgs.insert(dsg);
if (!res.second) { if (!res.second) {
seprintf(this->buffer, lastof(this->buffer), "%*sGROUP SEEN ABOVE: Deterministic (%s, %s), [%u]", seprintf(this->buffer, lastof(this->buffer), "%sGROUP SEEN ABOVE: Deterministic (%s, %s), [%u]",
padding, "", _sg_scope_names[dsg->var_scope], _sg_size_names[dsg->size], dsg->nfo_line); padding, _sg_scope_names[dsg->var_scope], _sg_size_names[dsg->size], dsg->nfo_line);
print(); print();
return; return;
} }
char *p = this->buffer; char *p = this->buffer;
p += seprintf(p, lastof(this->buffer), "%*sDeterministic (%s, %s)%s [%u]", p += seprintf(p, lastof(this->buffer), "%sDeterministic (%s, %s)%s [%u]",
padding, "", _sg_scope_names[dsg->var_scope], _sg_size_names[dsg->size], extra_info, dsg->nfo_line); padding, _sg_scope_names[dsg->var_scope], _sg_size_names[dsg->size], extra_info, dsg->nfo_line);
if (HasBit(_misc_debug_flags, MDF_NEWGRF_SG_DUMP_MORE_DETAIL)) { if (HasBit(_misc_debug_flags, MDF_NEWGRF_SG_DUMP_MORE_DETAIL)) {
if (dsg->dsg_flags & DSGF_NO_DSE) p += seprintf(p, lastof(this->buffer), ", NO_DSE"); if (dsg->dsg_flags & DSGF_NO_DSE) p += seprintf(p, lastof(this->buffer), ", NO_DSE");
if (dsg->dsg_flags & DSGF_DSE_RECURSIVE_DISABLE) p += seprintf(p, lastof(this->buffer), ", DSE_RD"); if (dsg->dsg_flags & DSGF_DSE_RECURSIVE_DISABLE) p += seprintf(p, lastof(this->buffer), ", DSE_RD");
@@ -934,22 +936,30 @@ void SpriteGroupDumper::DumpSpriteGroup(const SpriteGroup *sg, int padding, uint
} }
print(); print();
emit_start(); emit_start();
padding += 2; std::string sub_padding(padding);
sub_padding += " ";
uint conditional_indent = 0; uint conditional_indent = 0;
for (const auto &adjust : (*adjusts)) { for (const auto &adjust : (*adjusts)) {
DumpSpriteGroupAdjust(this->buffer, lastof(this->buffer), adjust, padding, highlight_tag, conditional_indent); DumpSpriteGroupAdjust(this->buffer, lastof(this->buffer), adjust, sub_padding.c_str(), highlight_tag, conditional_indent);
print(); print();
if (adjust.variable == 0x7E && adjust.subroutine != nullptr) { if (adjust.variable == 0x7E && adjust.subroutine != nullptr) {
this->DumpSpriteGroup(adjust.subroutine, padding + 5, 0); std::string subroutine_padding(sub_padding);
for (uint i = 0; i < conditional_indent; i++) {
subroutine_padding += "> ";
}
subroutine_padding += " ";
this->DumpSpriteGroup(adjust.subroutine, subroutine_padding.c_str(), 0);
} }
} }
if (dsg->calculated_result) { if (dsg->calculated_result) {
seprintf(this->buffer, lastof(this->buffer), "%*scalculated_result", padding, ""); seprintf(this->buffer, lastof(this->buffer), "%scalculated_result", padding);
print(); print();
} else { } else {
std::string subgroup_padding(padding);
subgroup_padding += " ";
for (const auto &range : (*ranges)) { for (const auto &range : (*ranges)) {
char *p = this->buffer; char *p = this->buffer;
p += seprintf(p, lastof(this->buffer), "%*srange: %X -> %X", padding, "", range.low, range.high); p += seprintf(p, lastof(this->buffer), "%srange: %X -> %X", padding, range.low, range.high);
if (range.low == range.high && is_callback_group) { if (range.low == range.high && is_callback_group) {
const char *cb_name = GetNewGRFCallbackName((CallbackID)range.low); const char *cb_name = GetNewGRFCallbackName((CallbackID)range.low);
if (cb_name != nullptr) { if (cb_name != nullptr) {
@@ -957,12 +967,12 @@ void SpriteGroupDumper::DumpSpriteGroup(const SpriteGroup *sg, int padding, uint
} }
} }
print(); print();
this->DumpSpriteGroup(range.group, padding + 2, 0); this->DumpSpriteGroup(range.group, subgroup_padding.c_str(), 0);
} }
if (default_group != nullptr) { if (default_group != nullptr) {
seprintf(this->buffer, lastof(this->buffer), "%*sdefault", padding, ""); seprintf(this->buffer, lastof(this->buffer), "%sdefault", padding);
print(); print();
this->DumpSpriteGroup(default_group, padding + 2, SGDF_DEFAULT); this->DumpSpriteGroup(default_group, subgroup_padding.c_str(), SGDF_DEFAULT);
} }
} }
break; break;
@@ -979,31 +989,32 @@ void SpriteGroupDumper::DumpSpriteGroup(const SpriteGroup *sg, int padding, uint
} }
} }
seprintf(this->buffer, lastof(this->buffer), "%*sRandom (%s, %s, triggers: %X, count: %X, lowest_randbit: %X, groups: %u)%s [%u]", seprintf(this->buffer, lastof(this->buffer), "%sRandom (%s, %s, triggers: %X, count: %X, lowest_randbit: %X, groups: %u)%s [%u]",
padding, "", _sg_scope_names[rsg->var_scope], rsg->cmp_mode == RSG_CMP_ANY ? "ANY" : "ALL", padding, _sg_scope_names[rsg->var_scope], rsg->cmp_mode == RSG_CMP_ANY ? "ANY" : "ALL",
rsg->triggers, rsg->count, rsg->lowest_randbit, (uint)rsg->groups.size(), extra_info, rsg->nfo_line); rsg->triggers, rsg->count, rsg->lowest_randbit, (uint)rsg->groups.size(), extra_info, rsg->nfo_line);
print(); print();
emit_start(); emit_start();
std::string sub_padding(padding);
sub_padding += " ";
for (const auto &group : (*groups)) { for (const auto &group : (*groups)) {
this->DumpSpriteGroup(group, padding + 2, 0); this->DumpSpriteGroup(group, sub_padding.c_str(), 0);
} }
break; break;
} }
case SGT_CALLBACK: case SGT_CALLBACK:
seprintf(this->buffer, lastof(this->buffer), "%*sCallback Result: %X", padding, "", ((const CallbackResultSpriteGroup *) sg)->result); seprintf(this->buffer, lastof(this->buffer), "%sCallback Result: %X", padding, ((const CallbackResultSpriteGroup *) sg)->result);
print(); print();
break; break;
case SGT_RESULT: case SGT_RESULT:
seprintf(this->buffer, lastof(this->buffer), "%*sSprite Result: SpriteID: %u, num: %u", seprintf(this->buffer, lastof(this->buffer), "%sSprite Result: SpriteID: %u, num: %u",
padding, "", ((const ResultSpriteGroup *) sg)->sprite, ((const ResultSpriteGroup *) sg)->num_sprites); padding, ((const ResultSpriteGroup *) sg)->sprite, ((const ResultSpriteGroup *) sg)->num_sprites);
print(); print();
break; break;
case SGT_TILELAYOUT: { case SGT_TILELAYOUT: {
const TileLayoutSpriteGroup *tlsg = (const TileLayoutSpriteGroup*)sg; const TileLayoutSpriteGroup *tlsg = (const TileLayoutSpriteGroup*)sg;
seprintf(this->buffer, lastof(this->buffer), "%*sTile Layout%s [%u]", padding, "", extra_info, sg->nfo_line); seprintf(this->buffer, lastof(this->buffer), "%sTile Layout%s [%u]", padding, extra_info, sg->nfo_line);
print(); print();
emit_start(); emit_start();
padding += 2;
if (tlsg->dts.registers != nullptr) { if (tlsg->dts.registers != nullptr) {
const TileLayoutRegisters *registers = tlsg->dts.registers; const TileLayoutRegisters *registers = tlsg->dts.registers;
size_t count = 1; // 1 for the ground sprite size_t count = 1; // 1 for the ground sprite
@@ -1011,12 +1022,12 @@ void SpriteGroupDumper::DumpSpriteGroup(const SpriteGroup *sg, int padding, uint
foreach_draw_tile_seq(element, tlsg->dts.seq) count++; foreach_draw_tile_seq(element, tlsg->dts.seq) count++;
for (size_t i = 0; i < count; i ++) { for (size_t i = 0; i < count; i ++) {
const TileLayoutRegisters *reg = registers + i; const TileLayoutRegisters *reg = registers + i;
seprintf(this->buffer, lastof(this->buffer), "%*ssection: %X, register flags: %X", padding, "", (uint)i, reg->flags); seprintf(this->buffer, lastof(this->buffer), "%s section: %X, register flags: %X", padding, (uint)i, reg->flags);
print(); print();
auto log_reg = [&](TileLayoutFlags flag, const char *name, uint8 flag_reg) { auto log_reg = [&](TileLayoutFlags flag, const char *name, uint8 flag_reg) {
if (reg->flags & flag) { if (reg->flags & flag) {
highlight_tag = (1 << 16) | flag_reg; highlight_tag = (1 << 16) | flag_reg;
seprintf(this->buffer, lastof(this->buffer), "%*s%s reg: %X", padding + 2, "", name, flag_reg); seprintf(this->buffer, lastof(this->buffer), "%s %s reg: %X", padding, name, flag_reg);
print(); print();
} }
}; };
@@ -1029,11 +1040,11 @@ void SpriteGroupDumper::DumpSpriteGroup(const SpriteGroup *sg, int padding, uint
log_reg(TLF_CHILD_X_OFFSET, "TLF_CHILD_X_OFFSET", reg->delta.child[0]); log_reg(TLF_CHILD_X_OFFSET, "TLF_CHILD_X_OFFSET", reg->delta.child[0]);
log_reg(TLF_CHILD_Y_OFFSET, "TLF_CHILD_Y_OFFSET", reg->delta.child[1]); log_reg(TLF_CHILD_Y_OFFSET, "TLF_CHILD_Y_OFFSET", reg->delta.child[1]);
if (reg->flags & TLF_SPRITE_VAR10) { if (reg->flags & TLF_SPRITE_VAR10) {
seprintf(this->buffer, lastof(this->buffer), "%*sTLF_SPRITE_VAR10 value: %X", padding + 2, "", reg->sprite_var10); seprintf(this->buffer, lastof(this->buffer), "%s TLF_SPRITE_VAR10 value: %X", padding, reg->sprite_var10);
print(); print();
} }
if (reg->flags & TLF_PALETTE_VAR10) { if (reg->flags & TLF_PALETTE_VAR10) {
seprintf(this->buffer, lastof(this->buffer), "%*sTLF_PALETTE_VAR10 value: %X", padding + 2, "", reg->palette_var10); seprintf(this->buffer, lastof(this->buffer), "%s TLF_PALETTE_VAR10 value: %X", padding, reg->palette_var10);
print(); print();
} }
} }
@@ -1042,17 +1053,17 @@ void SpriteGroupDumper::DumpSpriteGroup(const SpriteGroup *sg, int padding, uint
} }
case SGT_INDUSTRY_PRODUCTION: { case SGT_INDUSTRY_PRODUCTION: {
const IndustryProductionSpriteGroup *ipsg = (const IndustryProductionSpriteGroup*)sg; const IndustryProductionSpriteGroup *ipsg = (const IndustryProductionSpriteGroup*)sg;
seprintf(this->buffer, lastof(this->buffer), "%*sIndustry Production (version %X) [%u]", padding, "", ipsg->version, ipsg->nfo_line); seprintf(this->buffer, lastof(this->buffer), "%sIndustry Production (version %X) [%u]", padding, ipsg->version, ipsg->nfo_line);
print(); print();
emit_start(); emit_start();
auto log_io = [&](const char *prefix, int i, int quantity, CargoID cargo) { auto log_io = [&](const char *prefix, int i, int quantity, CargoID cargo) {
if (ipsg->version >= 1) highlight_tag = (1 << 16) | quantity; if (ipsg->version >= 1) highlight_tag = (1 << 16) | quantity;
if (ipsg->version >= 2) { if (ipsg->version >= 2) {
seprintf(this->buffer, lastof(this->buffer), "%*s%s %X: reg %X, cargo ID: %X", padding + 2, "", prefix, i, quantity, cargo); seprintf(this->buffer, lastof(this->buffer), "%s %s %X: reg %X, cargo ID: %X", padding, prefix, i, quantity, cargo);
print(); print();
} else { } else {
const char *type = (ipsg->version >= 1) ? "reg" : "value"; const char *type = (ipsg->version >= 1) ? "reg" : "value";
seprintf(this->buffer, lastof(this->buffer), "%*s%s %X: %s %X", padding + 2, "", prefix, i, type, quantity); seprintf(this->buffer, lastof(this->buffer), "%s %s %X: %s %X", padding, prefix, i, type, quantity);
print(); print();
} }
}; };
@@ -1063,7 +1074,7 @@ void SpriteGroupDumper::DumpSpriteGroup(const SpriteGroup *sg, int padding, uint
log_io("Add input", i, ipsg->add_output[i], ipsg->cargo_output[i]); log_io("Add input", i, ipsg->add_output[i], ipsg->cargo_output[i]);
} }
if (ipsg->version >= 1) highlight_tag = (1 << 16) | ipsg->again; if (ipsg->version >= 1) highlight_tag = (1 << 16) | ipsg->again;
seprintf(this->buffer, lastof(this->buffer), "%*sAgain: %s %X", padding + 2, "", (ipsg->version >= 1) ? "reg" : "value", ipsg->again); seprintf(this->buffer, lastof(this->buffer), "%s Again: %s %X", padding, (ipsg->version >= 1) ? "reg" : "value", ipsg->again);
print(); print();
break; break;
} }
@@ -1073,5 +1084,5 @@ void SpriteGroupDumper::DumpSpriteGroup(const SpriteGroup *sg, int padding, uint
void DumpSpriteGroup(const SpriteGroup *sg, DumpSpriteGroupPrinter print) void DumpSpriteGroup(const SpriteGroup *sg, DumpSpriteGroupPrinter print)
{ {
SpriteGroupDumper dumper(std::move(print)); SpriteGroupDumper dumper(std::move(print));
dumper.DumpSpriteGroup(sg, 0, 0); dumper.DumpSpriteGroup(sg, 0);
} }

View File

@@ -769,10 +769,15 @@ private:
SGDF_DEFAULT = 1 << 0, SGDF_DEFAULT = 1 << 0,
}; };
void DumpSpriteGroup(const SpriteGroup *sg, const char *prefix, uint flags);
public: public:
SpriteGroupDumper(DumpSpriteGroupPrinter print) : print_fn(print) {} SpriteGroupDumper(DumpSpriteGroupPrinter print) : print_fn(print) {}
void DumpSpriteGroup(const SpriteGroup *sg, int padding, uint flags); void DumpSpriteGroup(const SpriteGroup *sg, uint flags)
{
this->DumpSpriteGroup(sg, "", flags);
}
}; };
void DumpSpriteGroup(const SpriteGroup *sg, DumpSpriteGroupPrinter print); void DumpSpriteGroup(const SpriteGroup *sg, DumpSpriteGroupPrinter print);