OrcaSlicer/src/slic3r/GUI/IMEXModesCtrl.cpp

#include "slic3r/GUI/IMEXModesCtrl.hpp"

#include <wx/anybutton.h>
#include <libslic3r/IMEXHelpers.hpp>
#include <cstddef>
#include <vector>
#include <tuple>
#include <libslic3r/Config.hpp>
#include <map>
#include <string>
#include <optional>
#include <functional>
#include <wx/app.h>
#include <wx/event.h>
#include <wx/colour.h>
#include <wx/font.h>
#include <wx/panel.h>
#include <wx/sizer.h>
#include <wx/gdicmn.h>
#include <wx/stattext.h>

#include <algorithm>
#include <boost/algorithm/string/predicate.hpp>
#include <utility>
#include <wx/string.h>

#include "slic3r/GUI/EditGCodeDialog.hpp"
#include "slic3r/GUI/GUI.hpp"
#include "slic3r/GUI/GUI_App.hpp"
#include "slic3r/GUI/I18N.hpp"
#include "slic3r/GUI/Widgets/Button.hpp"
#include "slic3r/GUI/Widgets/ComboBox.hpp"
#include "slic3r/GUI/Widgets/StateColor.hpp"
#include "slic3r/GUI/wxExtensions.hpp"

namespace Slic3r {
namespace GUI {

// Icon size for every button in this control -- the help button beside the legend and the
// edit / remove buttons on each row. One constant so the three cannot drift apart.
static constexpr int kImexIconPx = 20;

// Mode column width. The name field carries a drop-down arrow, which eats interior space, so
// this is wider than a bare text field needed. The header spacer below derives from it.
static constexpr int kNameColPx = 176;

IMEXModesCtrl::IMEXModesCtrl(wxWindow* parent, int n_cols, int n_rows, int layout)
    : wxPanel(parent, wxID_ANY), m_n_cols(std::max(1, n_cols)), m_n_rows(std::max(1, n_rows)), m_layout(layout)
{
    // Set explicitly: GTK otherwise gives child wxPanels a slightly lighter "widget bg",
    // which shows as a light box around the chromeless ScalableButtons. The page's own
    // color, as OG_CustomCtrl takes it, because the dark-mode walk only remaps palette
    // colors: the app's window default is not one, so it never matched the page and
    // froze in whichever theme the editor was last built in. Sub-panels inherit this color.
    SetBackgroundColour(parent->GetBackgroundColour());

    m_outer = new wxBoxSizer(wxVERTICAL);
    m_rows_sizer = new wxBoxSizer(wxVERTICAL);

    // Info panel (instructions + legend) and the column-header row. Both depend on the grid
    // shape, so their CONTENTS are (re)built by rebuild_info_and_header(), which set_grid_size()
    // calls again whenever the grid changes. The panels themselves are stable so m_outer's
    // ordering never has to be rearranged.
    m_info_panel = new wxPanel(this, wxID_ANY);
    m_info_panel->SetBackgroundColour(GetBackgroundColour());
    m_hdr_panel = new wxPanel(this, wxID_ANY);
    m_hdr_panel->SetBackgroundColour(GetBackgroundColour());
    rebuild_info_and_header();

    // Add Mode is built by rebuild_info_and_header() into the info panel, above the rows:
    // at the bottom it moved down the page every time a mode was added, so its position
    // depended on how many modes you already had.
    m_outer->Add(m_info_panel, 0, wxEXPAND | wxBOTTOM, FromDIP(4));
    m_outer->Add(m_hdr_panel,  0, wxEXPAND | wxBOTTOM, FromDIP(2));
    m_outer->Add(m_rows_sizer, 0, wxEXPAND);
    m_outer->AddSpacer(FromDIP(4));
    // SetSizer(), not SetSizerAndFit(): no row exists yet, so there is nothing to fit to --
    // rows arrive from add_row() / load_from_config() / set_grid_size(). Deliberately NOT
    // followed by m_outer->SetSizeHints(this) once they do: this panel owns a sizer, so
    // wxWindow::GetBestSize() bypasses the best-size cache and re-runs m_outer->CalcMin()
    // on every parent layout, and that is what the enclosing sizer already reserves space
    // for via GetEffectiveMinSize(). An explicitly set min size takes PRIORITY over the best
    // size in that call, so a size hint would pin the reserved height to the row count that
    // happened to be on screen when it ran -- adding a mode after that would clip the bottom
    // row, which is the very failure the hint is meant to avoid.
    SetSizer(m_outer);
}

// A wxTextCtrl cannot paint its own border on GTK -- Orca sidesteps that in ::TextInput by
// drawing one on a StaticBox, but that has no multiline form and nothing in the tree uses it
// that way. A one-pixel panel behind the control gives the same visible edge for both the
// single-line name and the multiline G-code box, in the color the settings fields above use:
// the inputs here were landing on GTK's near-black default, invisible against the panel.
static wxPanel* framed_input(wxWindow* parent)
{
    wxColour clr(0xDB, 0xDB, 0xDB);
    if (wxGetApp().dark_mode())
        clr = StateColor::darkModeColorFor(clr);
    auto* frame = new wxPanel(parent, wxID_ANY);
    frame->SetBackgroundColour(clr);
    frame->SetSizer(new wxBoxSizer(wxVERTICAL));
    return frame;
}

// The settings page's label color, set before the walk as Tab's labels are, so the theme
// remaps it with the page. Left on the system text color, a label follows the OS theme on MSW
// rather than Orca's, and on GTK a dark walk pins a color the light map cannot undo.
static wxStaticText* page_label(wxStaticText* lbl)
{
    lbl->SetForegroundColour(wxColour("#363636"));
    wxGetApp().UpdateDarkUI(lbl);
    return lbl;
}

void IMEXModesCtrl::rebuild_info_and_header() {
    // --- Info panel: help button + color legend ---
    m_info_panel->DestroyChildren();
    auto* info_sizer = new wxBoxSizer(wxVERTICAL);

    // The overview rides on the "?" button at the head of the legend rather than sitting in
    // the panel as body text: it is read once and then only gets in the way, while the legend
    // beside it is the part worth keeping on screen. Per-role detail is on the swatches.
    const wxString instructions =
        _L("Each mode names the tool heads that take part and the role each one plays. "
           "Click a tool button to cycle its role — hover a color below for what each role does.");

    // Color legend — swatches sized to the body text height so they read as
    // matched pairs with their labels regardless of system DPI / font scale,
    // matching the on-hover ghost tooltip swatch's visual weight.
    // One entry per role this printer offers, in kImexRoleTable order — the same order the
    // tiles cycle in. A role added to that table appears here with no edit of its own.
    auto* leg_sizer = new wxBoxSizer(wxHORIZONTAL);
    const int swatch_side = m_info_panel->GetCharHeight();

    // Action row: Add Mode, then the "?" carrying the overview. Width-matched to the mode
    // column so the button sits over the field it creates.
    auto* act_sizer = new wxBoxSizer(wxHORIZONTAL);
    auto* add_btn = new Button(m_info_panel, _L("Add Mode"));
    add_btn->SetStyle(ButtonStyle::Confirm, ButtonType::Window);
    // Width-matched to the mode column. The height has to be a real number: Button takes its
    // min size literally, so a -1 there collapses it to a sliver rather than meaning "auto".
    add_btn->SetMinSize(wxSize(FromDIP(130), add_btn->GetBestSize().GetHeight()));
    add_btn->Bind(wxEVT_BUTTON, [this](wxCommandEvent&) { add_row(); notify(); });
    act_sizer->Add(add_btn, 0, wxALIGN_CENTER_VERTICAL | wxRIGHT, FromDIP(6));

    auto* help_btn = new ScalableButton(m_info_panel, wxID_ANY, "icon_qusetion", wxEmptyString,
                                        wxDefaultSize, wxDefaultPosition,
                                        wxBU_EXACTFIT | wxNO_BORDER, /*use_default_disabled_bitmap=*/true, kImexIconPx);
    help_btn->SetToolTip(instructions);
    act_sizer->Add(help_btn, 0, wxALIGN_CENTER_VERTICAL);
    info_sizer->Add(act_sizer, 0, wxBOTTOM, FromDIP(6));
    for (const ImexRoleDesc& d : kImexRoleTable) {
        if (!role_offered(d.role)) continue;
        const RoleStyle style = role_style(d.role);
        auto* swatch = new wxPanel(m_info_panel, wxID_ANY, wxDefaultPosition, wxSize(swatch_side, swatch_side));
        swatch->SetBackgroundColour(style.bg);
        auto* leg_label = page_label(new wxStaticText(m_info_panel, wxID_ANY, style.label));
        const wxString hint = role_hint(d.role);
        swatch->SetToolTip(hint);
        leg_label->SetToolTip(hint);
        leg_sizer->Add(swatch, 0, wxALIGN_CENTER_VERTICAL | wxRIGHT, FromDIP(4));
        leg_sizer->Add(leg_label, 0, wxALIGN_CENTER_VERTICAL | wxRIGHT, FromDIP(16));
    }
    info_sizer->Add(leg_sizer, 0, wxBOTTOM, FromDIP(6));
    m_info_panel->SetSizerAndFit(info_sizer);

    // --- Column header row ---
    // Spacers sized to align with the mode-row fields below. Name field: FromDIP(130) + FromDIP(6)
    // gap; tool grid: n_cols*(FromDIP(24)+FromDIP(2))-FromDIP(2) + FromDIP(6) gap. grid_px tracks
    // the live column count, so the G-code header stays aligned after a grid change.
    m_hdr_panel->DestroyChildren();
    auto* hdr_sizer = new wxBoxSizer(wxHORIZONTAL);
    auto* hdr_name  = page_label(new wxStaticText(m_hdr_panel, wxID_ANY, _L("Mode")));
    auto* hdr_tools = page_label(new wxStaticText(m_hdr_panel, wxID_ANY, _L("Tools")));
    auto* hdr_gcode = page_label(new wxStaticText(m_hdr_panel, wxID_ANY, _L("G-code")));
    hdr_name->SetToolTip(_L("How the mode is labeled in the plate's IDEX/IQEX mode selector. "
                            "Required — a mode with no name cannot be selected."));
    hdr_tools->SetToolTip(_L("Which tool heads take part in the mode and what role each one plays. "
                             "Click a tile to cycle its role."));
    hdr_gcode->SetToolTip(_L("G-code run at print start to put the printer into this mode "
                             "(for example a Klipper SET_PRINT_MODE call). The slicer only emits "
                             "the Primary tool's paths; the firmware drives the others."));
    const int grid_px = m_n_cols * FromDIP(26) - FromDIP(2);  // tile 24 + 2px gap, less the trailing gap
    const int name_col_px = FromDIP(kNameColPx + 6);
    hdr_sizer->Add(hdr_name,  0, wxALIGN_CENTER_VERTICAL);
    hdr_sizer->AddSpacer(std::max(0, name_col_px - hdr_name->GetBestSize().x));
    hdr_sizer->Add(hdr_tools, 0, wxALIGN_CENTER_VERTICAL);
    hdr_sizer->AddSpacer(std::max(0, grid_px + FromDIP(6) - hdr_tools->GetBestSize().x));
    hdr_sizer->Add(hdr_gcode, 1, wxALIGN_CENTER_VERTICAL);
    m_hdr_panel->SetSizerAndFit(hdr_sizer);
}

void IMEXModesCtrl::set_grid_size(int n_cols, int n_rows, int layout) {
    n_cols = std::max(1, n_cols);
    n_rows = std::max(1, n_rows);
    if (layout < 0) layout = m_layout;
    if (n_cols == m_n_cols && n_rows == m_n_rows && layout == m_layout) return;
    auto [names, tools, gcodes] = get_mode_data();
    clear_rows();
    m_n_cols = n_cols;
    m_n_rows = n_rows;
    m_layout = layout;
    // Span becomes available the moment a second gantry exists, and the header spacing tracks the
    // column count -- so the legend and headers are rebuilt here rather than only at construction.
    // Without this, adding a gantry gives the tiles a Span role the legend never explains until
    // the preset is saved and the page reopened.
    rebuild_info_and_header();
    for (size_t i = 0; i < names.size(); ++i)
        add_row(names[i], tools[i], gcodes[i], /*is_primary=*/(names[i] == kImexPrimaryMode));
    Layout();
}

void IMEXModesCtrl::load_from_config(const DynamicPrintConfig& cfg) {
    clear_rows();
    // One ImexMode per row of imex_mode_names, with any sibling array too short for a row
    // padded to an empty string -- exactly what the three per-index bounds checks this
    // replaced were doing, now in one place shared with every other IMEX consumer.
    const std::vector<ImexMode> table = imex_mode_table(cfg);

    // Primary row is always first and non-deletable.  Look for an existing
    // "primary" entry in the config (present in configs saved after #8 was
    // implemented); fall back to empty tool/gcode for older configs.
    const ImexMode primary = find_imex_mode(cfg, kImexPrimaryMode);
    add_row(kImexPrimaryMode, primary.active_tools, primary.gcode, /*is_primary=*/true);

    for (const ImexMode& m : table) {
        if (m.index == primary.index) continue; // already added above
        add_row(m.name, m.active_tools, m.gcode);
    }
    refresh_reset_buttons();
    Layout();
}

std::tuple<std::vector<std::string>, std::vector<std::string>, std::vector<std::string>>
IMEXModesCtrl::get_mode_data() const {
    std::vector<std::string> names, tools, gcodes;
    for (auto& r : m_rows) {
        // into_u8(), not ToStdString(): everything downstream of here -- the preset, the 3MF
        // metadata, the plate's stored mode name -- is UTF-8, while ToStdString() encodes
        // through wxConvLibc, which on Windows is the ANSI codepage. The two agree only on a
        // UTF-8 locale, so mixing them turns a non-ASCII mode name into mojibake (or an empty
        // field, once from_u8() rejects it) on the round trip through the preset.
        std::string nm = r.is_primary ? std::string(kImexPrimaryMode) : into_u8(r.name->GetTextCtrl()->GetValue());
        if (nm.empty()) nm = unique_mode_name(names);
        names.push_back(nm);
        tools.push_back(active_tools_string(r));
        gcodes.push_back(into_u8(r.gcode->GetValue()));
    }
    return {names, tools, gcodes};
}

bool IMEXModesCtrl::matches_config(const DynamicPrintConfig& cfg) const {
    auto [names, tools, gcodes] = get_mode_data();
    auto cfg_strings = [&cfg](const char* key) {
        std::vector<std::string> v;
        if (auto* o = cfg.option<ConfigOptionStrings>(key)) v = o->values;
        return v;
    };
    return names  == cfg_strings("imex_mode_names")
        && tools  == cfg_strings("imex_mode_active_tools")
        && gcodes == cfg_strings("imex_mode_gcodes");
}

std::map<int, ImexRole> IMEXModesCtrl::roles_for_mode(const std::string& active_tools) {
    std::map<int, ImexRole> roles;
    for (const auto& [phys, role] : parse_imex_active_tools(active_tools))
        roles[phys] = role;
    // Promote the mode's primary, but never invent a tool that isn't in the
    // slicer's own active-tool list: parse_imex_active_tools() drops negative and
    // out-of-range indices, imex_primary_tool_for_mode() does not range-check the
    // upper bound, and a junk index round-tripped back out on save would be a
    // token the slicer ignores.
    const int primary = imex_primary_tool_for_mode(active_tools);
    if (primary >= 0) {
        auto it = roles.find(primary);
        if (it != roles.end())
            it->second = ImexRole::Primary;
    }
    return roles;
}

std::string IMEXModesCtrl::unique_mode_name(const std::vector<std::string>& also_taken, const std::string& base) const {
    auto is_taken = [&](const std::string& cand) {
        if (std::find(also_taken.begin(), also_taken.end(), cand) != also_taken.end())
            return true;
        for (const auto& r : m_rows)
            if (!r.is_primary && r.name && into_u8(r.name->GetTextCtrl()->GetValue()) == cand)
                return true;
        return false;
    };
    for (int n = 2; ; ++n) {
        std::string cand = base + " " + std::to_string(n);
        if (!is_taken(cand))
            return cand;
    }
}

bool IMEXModesCtrl::fix_row_name(Row& r) {
    if (r.is_primary || !r.name)
        return false;
    const std::string name = into_u8(r.name->GetTextCtrl()->GetValue());
    // Case-insensitive: a row named "Primary" works, but its menu entry reads the same as the
    // built-in Primary's.
    const bool reserved = boost::iequals(name, kImexPrimaryMode);
    bool taken = false;
    for (const Row& other : m_rows)
        if (&other != &r && !other.is_primary && other.name && into_u8(other.name->GetTextCtrl()->GetValue()) == name)
            taken = true;
    if (!name.empty() && !reserved && !taken)
        return false;
    std::string base = name;
    // "copy 2" taken becomes "copy 3", not "copy 2 2".
    if (const size_t sp = base.find_last_of(' '); sp != std::string::npos && sp > 0 && sp + 1 < base.size() &&
        base.find_first_not_of("0123456789", sp + 1) == std::string::npos)
        base.erase(sp);
    // ChangeValue(), not SetValue(): no nested wxEVT_TEXT.
    r.name->GetTextCtrl()->ChangeValue(from_u8(name.empty() || reserved ? unique_mode_name({}) : unique_mode_name({}, base)));
    return true;
}

IMEXModesCtrl::RoleStyle IMEXModesCtrl::role_style(std::optional<ImexRole> role) {
    // Gray / "Inactive" is the no-role answer; every role gets an explicit case so a new
    // one is a compile-time -Wswitch prompt rather than a tile that silently renders gray.
    // TRN IDEX/IQEX role of a tool head that takes no part in the mode.
    const wxString inactive = _L_CONTEXT("Inactive", "IDEX/IQEX role");
    if (!role)
        return { wxColour(90, 90, 90), *wxWHITE, inactive };
    switch (*role) {
    // TRN IDEX/IQEX role: the tool head the slicer generates paths for.
    case ImexRole::Primary: return { wxColour(50,  160, 50),  *wxWHITE, _L_CONTEXT("Primary", "IDEX/IQEX role") };  // green
    // TRN IDEX/IQEX role: the tool head prints a copy of the Primary's paths.
    case ImexRole::Copy:    return { wxColour(60,  120, 210), *wxWHITE, _L_CONTEXT("Copy", "IDEX/IQEX role")    };  // blue
    // TRN IDEX/IQEX role: the tool head prints a mirror image of the Primary's paths.
    case ImexRole::Mirror:  return { wxColour(210, 130, 20),  *wxWHITE, _L_CONTEXT("Mirror", "IDEX/IQEX role")  };  // amber
    // TRN IDEX/IQEX role: multicolor partner of the Primary on the same gantry.
    case ImexRole::Span:    return { wxColour(180, 180, 40),  *wxWHITE, _L_CONTEXT("Span", "IDEX/IQEX role")    };  // yellow
    }
    return { wxColour(90, 90, 90), *wxWHITE, inactive };  // keeps every compiler quiet
}

wxString IMEXModesCtrl::role_hint(ImexRole role) {
    switch (role) {
    case ImexRole::Primary:
        return _L("Drives every sliced path. Always tool 0 — use Tool 0 Position above to choose "
                  "which corner of the bed it occupies. It cannot be moved from the grid.");
    case ImexRole::Copy:
        return _L("Follows the Primary at the firmware level, printing the same paths offset into "
                  "its own zone.");
    case ImexRole::Mirror:
        return _L("Follows the Primary at the firmware level, printing the same paths reflected "
                  "across the boundary between the two zones.");
    case ImexRole::Span:
        return _L("Marks a tool on the Primary's gantry as its multicolor partner. Required to "
                  "allow multi-color printing in paired-gantry modes.");
    }
    return wxEmptyString;
}

bool IMEXModesCtrl::role_offered(ImexRole role) const {
    // Span declares a within-gantry multicolor partner of the Primary, which only means
    // something when there is a second gantry running in parallel with it.
    if (role == ImexRole::Span)
        return m_n_rows >= 2;
    return true;
}

bool IMEXModesCtrl::role_allowed_on_tile(ImexRole role, int tool_idx,
                                         bool other_primary, int primary_gantry) const {
    if (!role_offered(role))
        return false;
    // Exactly one tile drives the sliced paths.
    if (role == ImexRole::Primary)
        return !other_primary;
    // Span only on a tile sharing the Primary's gantry — that is what the marker declares.
    if (role == ImexRole::Span)
        return primary_gantry >= 0 && (tool_idx / m_n_cols) == primary_gantry;
    return true;
}

std::optional<ImexRole> IMEXModesCtrl::next_tile_role(std::optional<ImexRole> current,
                                                      const std::function<bool(ImexRole)>& allowed) {
    const int n = (int)(sizeof(kImexRoleTable) / sizeof(kImexRoleTable[0]));
    int start = 0;  // no current role (Inactive) → start at the first role
    if (current) {
        for (int i = 0; i < n; ++i)
            if (kImexRoleTable[i].role == *current) { start = i + 1; break; }
    }
    for (int i = start; i < n; ++i)
        if (allowed(kImexRoleTable[i].role))
            return kImexRoleTable[i].role;
    return std::nullopt;  // walked off the end → back to Inactive
}

// The tool grid says which topologies this printer can express, so a two-tool machine is not
// offered the four-carriage modes. Names a row already uses are dropped, leaving only what is
// still free. These are conventions, not keywords -- nothing in the slicer reads a mode's name
// except as the key a plate stores -- so the field stays typeable and this is only a shortcut.
std::vector<wxString> IMEXModesCtrl::suggested_mode_names(const ::ComboBox* skip) const {
    std::vector<std::string> pool = { "copy", "mirror" };
    // Four carriages to drive, however they are arranged.
    if (m_n_cols * m_n_rows >= 4)
        for (const char* n : { "iq-copy", "iq-mirror" })
            pool.emplace_back(n);
    // Multicolor needs a Span partner beside the primary, so two tools on a gantry, and a
    // second gantry to copy the pair onto. imex_resolve_routing() refuses a multicolor mode
    // with no Span on the primary's gantry, so offering one here that it would reject is
    // worse than not offering it at all.
    if (m_n_cols >= 2 && m_n_rows >= 2)
        for (const char* n : { "mc-copy", "mc-mirror" })
            pool.emplace_back(n);

    std::vector<wxString> out;
    for (const std::string& cand : pool) {
        bool taken = false;
        for (const Row& r : m_rows)
            if (!r.is_primary && r.name && r.name != skip &&
                into_u8(r.name->GetTextCtrl()->GetValue()) == cand) {
                taken = true;
                break;
            }
        if (!taken)
            out.push_back(from_u8(cand));
    }
    return out;
}

void IMEXModesCtrl::apply_btn(wxButton* btn, int tool_idx, std::optional<ImexRole> role) {
    // Always label as T{n} — the button color already encodes the role.
    const RoleStyle style = role_style(role);
    btn->SetLabel(wxString::Format("T%d", tool_idx));
    btn->SetBackgroundColour(style.bg);
    btn->SetForegroundColour(style.fg);
    btn->Refresh();
}

IMEXModesCtrl::RowSnapshot IMEXModesCtrl::snapshot_row(const Row& r) const {
    RowSnapshot s;
    // UTF-8 throughout -- this snapshot is compared against the preset's own values.
    s.name  = r.is_primary ? std::string(kImexPrimaryMode) : into_u8(r.name->GetTextCtrl()->GetValue());
    s.tools = active_tools_string(r);
    s.gcode = into_u8(r.gcode->GetValue());
    return s;
}

bool IMEXModesCtrl::row_differs_from_parent(int row_idx) const {
    if (!m_parent_lookup) return false;
    const DynamicPrintConfig* parent = m_parent_lookup();
    if (!parent) return false;
    auto* p_names  = parent->option<ConfigOptionStrings>("imex_mode_names");
    auto* p_tools  = parent->option<ConfigOptionStrings>("imex_mode_active_tools");
    auto* p_gcodes = parent->option<ConfigOptionStrings>("imex_mode_gcodes");
    if (!p_names || row_idx < 0 || row_idx >= (int)p_names->values.size()) return false;
    const Row& r = m_rows[row_idx];
    const RowSnapshot s = snapshot_row(r);
    if (!r.is_primary && s.name != p_names->values[row_idx]) return true;
    if (p_tools  && row_idx < (int)p_tools->values.size()  && s.tools  != p_tools->values[row_idx])  return true;
    if (p_gcodes && row_idx < (int)p_gcodes->values.size() && s.gcode != p_gcodes->values[row_idx]) return true;
    return false;
}

bool IMEXModesCtrl::row_has_parent_counterpart(int row_idx) const {
    if (!m_parent_lookup) return false;
    const DynamicPrintConfig* parent = m_parent_lookup();
    if (!parent) return false;
    auto* p_names = parent->option<ConfigOptionStrings>("imex_mode_names");
    return p_names && row_idx >= 0 && row_idx < (int)p_names->values.size();
}

void IMEXModesCtrl::add_row(const std::string& name,
                            const std::string& active_tools,
                            const std::string& gcode,
                            bool is_primary)
{
    Row r;
    r.is_primary = is_primary;
    r.panel = new wxPanel(this, wxID_ANY);
    r.panel->SetBackgroundColour(GetBackgroundColour());
    auto* sizer = new wxBoxSizer(wxHORIZONTAL);
    // The mode column is vertical: name on top, and for a deletable row the remove button
    // beneath it. Remove used to sit next to Edit in the right-hand column, one icon apart
    // from a button people press often -- a destructive action does not belong there.
    auto* name_col = new wxBoxSizer(wxVERTICAL);

    if (is_primary) {
        r.orig_name = kImexPrimaryMode;
        r.name = nullptr;
        auto* lbl = page_label(new wxStaticText(r.panel, wxID_ANY, _L("Primary"),
                                                wxDefaultPosition, FromDIP(wxSize(kNameColPx, -1))));
        wxFont f = lbl->GetFont();
        f.SetWeight(wxFONTWEIGHT_BOLD);
        lbl->SetFont(f);
        name_col->Add(lbl, 0);   // the combo below carries no frame, so no inset to match
    } else {
        // A nameless mode cannot be selected on a plate and used to be dropped on
        // save together with its tool roles and G-code, so a name is pre-filled
        // here and restored below if the field is left empty. That keeps the
        // "Add Mode → assign tools → never typed a name" path from losing work
        // without ever showing an error.
        const std::string nm = name.empty() ? unique_mode_name({}) : name;
        // The name as first shown, i.e. the one the plate's mode selector offered while this
        // row looked like this. remove_row() reports it alongside the current name, because
        // renaming is not routed through on_mode_removed and the two then diverge.
        r.orig_name = nm;
        // Editable: no wxCB_READONLY, so the inner text control stays live and any name can
        // still be typed, which the mode table needs -- it is authored for whatever hardware
        // the user has. ComboBox derives from TextInput and paints the same border the settings
        // fields do, so it needs no frame panel of its own.
        r.name = new ::ComboBox(r.panel, wxID_ANY, wxEmptyString, wxDefaultPosition,
                                FromDIP(wxSize(kNameColPx, -1)), 0, nullptr, 0);
        for (const wxString& sug : suggested_mode_names())
            r.name->Append(sug);
        // Rebuilt on every click that could open the list: add_row() runs before this row joins
        // m_rows and before the rows below it exist, so a list built once there filters against
        // only part of the table and offers names that are already taken. By then every row is
        // present -- and this row's own name is excluded from "taken" so it stays offered. It
        // has to be BEFORE ComboBox opens it, not in wxEVT_COMBOBOX_DROPDOWN, which ComboBox
        // sends after sizing and showing the popup from the old items: with every name taken
        // that showed an empty popup. Bound handlers run ahead of ComboBox's own event-table
        // entries, so this rebuilds first and, with nothing to offer, keeps it shut. Only clicks
        // can open it: focus lives in the inner text control, so keys never reach the combo.
        const auto on_open_click = [this, cb = r.name](wxMouseEvent& e) {
            if (!cb->is_drop_down()) {
                cb->Clear();
                for (const wxString& sug : suggested_mode_names(cb))
                    cb->Append(sug);
                if (cb->GetCount() == 0) {
                    cb->SetFocus(); // what ComboBox's own click would have done, short of the list
                    return;
                }
            }
            e.Skip();
        };
        r.name->Bind(wxEVT_LEFT_DOWN, on_open_click);
        r.name->Bind(wxEVT_LEFT_DCLICK, on_open_click);
        // Constructed empty on purpose: ComboBox hands its value to TextInput as the LABEL --
        // the small right-aligned slot a unit like "mm" lives in -- because a read-only combo
        // hides the text control and shows that label instead. This one is editable, so the
        // value belongs in the text control; left in the label it renders as a second, greyed
        // copy of the name beside the hint.
        r.name->GetTextCtrl()->ChangeValue(from_u8(nm));
        r.name->GetTextCtrl()->SetHint(_L("Mode name (required)"));
        r.name->SetToolTip(_L("Name of this parallel mode, as it appears in the plate's IDEX/IQEX mode "
                              "selector. Stored in the project by name, so renaming a mode that "
                              "plates already use makes them fall back to Primary. Cannot be empty "
                              "— a blank name is replaced with a generated one."));
        r.name->GetTextCtrl()->Bind(wxEVT_TEXT, [this](wxCommandEvent&) { notify(); });
        // Picking a suggestion writes it into the text control, so everything downstream keeps
        // reading one place for the name.
        r.name->Bind(wxEVT_COMBOBOX, [this, cb = r.name](wxCommandEvent& e) {
            // Do NOT call SetLabel() here. It is overridden, and on an editable combo it
            // writes the TEXT CONTROL rather than the label (ComboBox.cpp, the IsShown()
            // branch) -- clearing it would erase the name that was just picked. The label
            // stays empty for this control's whole life anyway: it is constructed empty and
            // every write routes through the same override.
            // ChangeValue is still needed: SetSelection() early-returns when the index is
            // unchanged, so re-picking the current item would otherwise leave typed-over text.
            cb->GetTextCtrl()->ChangeValue(cb->GetDropDown().GetValue());
            notify();
        });
        // Restore a name rather than let the row reach get_mode_data() unnamed.
        // Row is located by panel pointer (stable across add/remove) so a
        // kill-focus delivered while the rows are being torn down is a no-op.
        r.name->GetTextCtrl()->Bind(wxEVT_SET_FOCUS, [this, panel = r.panel](wxFocusEvent& e) {
            e.Skip();
            for (auto& row_ref : m_rows)
                if (row_ref.panel == panel && row_ref.name)
                    row_ref.focus_name = into_u8(row_ref.name->GetTextCtrl()->GetValue());
        });
        r.name->GetTextCtrl()->Bind(wxEVT_KILL_FOCUS, [this, panel = r.panel](wxFocusEvent& e) {
            e.Skip();
            if (m_clearing_rows) return; // focus-out emitted while the rows are being deleted
            for (auto& row_ref : m_rows) {
                if (row_ref.panel != panel) continue;
                // Only an edit is checked. Tabbing through a hand-edited profile's duplicate
                // leaves it alone rather than renaming the row plates resolve to.
                const wxString value = row_ref.name ? row_ref.name->GetTextCtrl()->GetValue() : wxString();
                if (!value.empty() && into_u8(value) == row_ref.focus_name)
                    return;
                if (fix_row_name(row_ref))
                    notify();
                return;
            }
        });
    }

    auto* grid_panel = new wxPanel(r.panel, wxID_ANY);
    grid_panel->SetBackgroundColour(GetBackgroundColour());
    auto* grid_sizer = new wxGridSizer(m_n_rows, m_n_cols, FromDIP(2), FromDIP(2));

    auto tool_roles = roles_for_mode(active_tools);
    if (tool_roles.empty())
        tool_roles[0] = ImexRole::Primary; // default T0 → Primary when no assignment is stored
    r.all_tool_roles = tool_roles; // preserve all assignments, including off-screen tools
    wxPanel* this_panel = r.panel;

    // Buttons rendered top=rear (high Y), bottom=front (low Y).
    // Layout remapping: m_layout encodes which corner T0 is at physically.
    //   flip_x (layout 1,3): col 0 is on the right (max-X) instead of left
    //   flip_y (layout 2,3): row 0 is at the rear (max-Y) instead of front
    // Display iterates: row from n_rows-1 down to 0 (rear→front = top→bottom).
    // raw_row = flip_y ? (n_rows-1-row) : row
    // raw_col = flip_x ? (n_cols-1-col) : col
    //
    // Render the whole grid: m_n_rows is the gantry count, so the valid tool indices are
    // 0 .. m_n_rows*m_n_cols-1 and a window this tall only fits inside the grid at row 0.
    // A Primary outside the grid is a data problem the zone layout already reports by
    // producing no zones (compute_imex_zone_layout, IMEXZones.cpp).

    bool flip_x = (m_layout == 1 || m_layout == 3);
    bool flip_y = (m_layout == 2 || m_layout == 3);
    for (int row = m_n_rows - 1; row >= 0; --row) {
        for (int col = 0; col < m_n_cols; ++col) {
            int raw_row = flip_y ? (m_n_rows - 1 - row) : row;
            int raw_col = flip_x ? (m_n_cols - 1 - col) : col;
            int tool_idx = raw_row * m_n_cols + raw_col;
            std::optional<ImexRole> role;  // nullopt == Inactive
            auto it = tool_roles.find(tool_idx);
            if (it != tool_roles.end()) role = it->second;

            // wxBU_AUTODRAW, which wx ignores on a text button, is what GUI_App::UpdateDarkUI
            // skips: without it every theme change ran the role colors through the palette
            // map and left the labels gray. apply_btn() owns these colors in both themes.
            auto* btn = new wxButton(grid_panel, wxID_ANY, wxEmptyString,
                                     wxDefaultPosition, FromDIP(wxSize(24, 24)), wxBU_EXACTFIT | wxBU_AUTODRAW);
            apply_btn(btn, tool_idx, role);

            int btn_pos = (int)r.btns.size();
            r.btns.push_back(btn);
            r.btn_roles.push_back(role);
            r.btn_tool_idx.push_back(tool_idx);

            // Two tiles are read-only.
            //
            // The whole reserved `primary` row: it is the IMEX-off mode, so cycling roles there
            // would be a no-op and confusing.
            //
            // And, on any row, the tile that currently HOLDS Primary. Primary is tool 0 and moves
            // only via Tool 0 Position; letting a click demote it would leave the mode with no
            // Primary at all, which parses to -1 and degrades the plate to an ordinary single-tool
            // print with no zones — authored silently, in one click, with nothing in the editor
            // showing what is wrong. The other tiles already never OFFER Primary while one is held
            // (role_allowed_on_tile), so this closes the only remaining route to that state.
            // A mode that reaches us WITHOUT a Primary (hand-edited preset, foreign 3MF) still has
            // every tile live, so it can be repaired by promoting one.
            if (is_primary || role == ImexRole::Primary) {
                btn->Disable();
            } else {
                btn->Bind(wxEVT_BUTTON, [this, this_panel, btn_pos](wxCommandEvent&) {
                    // Find the row by panel pointer (stable across add/remove)
                    for (auto& row_ref : m_rows) {
                        if (row_ref.panel != this_panel) continue;
                        std::optional<ImexRole>& tile = row_ref.btn_roles[btn_pos];
                        const int tidx = row_ref.btn_tool_idx[btn_pos];

                        // Check if another button already holds the Primary role,
                        // and locate the primary's gantry row for Span eligibility.
                        bool other_primary = false;
                        int  primary_gantry = -1;
                        for (int j = 0; j < (int)row_ref.btn_roles.size(); ++j) {
                            if (row_ref.btn_roles[j] == ImexRole::Primary) {
                                if (j != btn_pos) other_primary = true;
                                primary_gantry = row_ref.btn_tool_idx[j] / m_n_cols;
                            }
                        }

                        // Cycle Inactive → Primary → Copy → Mirror → Span → Inactive,
                        // skipping whatever this tile may not take right now.
                        tile = next_tile_role(tile, [&](ImexRole cand) {
                            return role_allowed_on_tile(cand, tidx, other_primary, primary_gantry);
                        });

                        // Keep all_tool_roles in sync so off-screen tools are preserved
                        if (tile)
                            row_ref.all_tool_roles[tidx] = *tile;
                        else
                            row_ref.all_tool_roles.erase(tidx);

                        apply_btn(row_ref.btns[btn_pos], row_ref.btn_tool_idx[btn_pos], tile);
                        notify();
                        break;
                    }
                });
            }

            grid_sizer->Add(btn, 0);
        }
    }
    grid_panel->SetSizerAndFit(grid_sizer);

    // from_u8(): `gcode` arrives from the preset as UTF-8. Handing the raw std::string to
    // wxString would decode it through the current locale's encoding instead.
    auto* gcode_frame = framed_input(r.panel);
    // wxBORDER_NONE matters off GTK: a wxTextCtrl's default border resolves to a themed or
    // sunken edge on Windows and to NSBezelBorder on macOS, which would sit immediately inside
    // the frame below and read as two borders.
    r.gcode = new wxTextCtrl(gcode_frame, wxID_ANY, from_u8(gcode),
                             wxDefaultPosition, FromDIP(wxSize(220, 54)),
                             wxTE_MULTILINE | wxBORDER_NONE);
    gcode_frame->GetSizer()->Add(r.gcode, 1, wxEXPAND | wxALL, 1);
    // Same monospace face EditGCodeDialog gives its editor, so G-code reads the same
    // wherever it is edited; and the same explicit-light-then-UpdateDarkUI treatment as the
    // name field above, for the same reason.
    r.gcode->SetFont(wxGetApp().code_font());
    r.gcode->SetBackgroundColour(*wxWHITE);
    r.gcode->SetForegroundColour(wxColour("#262E30")); // the palette's input text color
    wxGetApp().UpdateDarkUI(r.gcode);
    // Tooltip only, no SetHint(): wxTextEntry has no native placeholder for a
    // multiline control, so wxWidgets emulates one by writing the hint into the
    // control as gray text — indistinguishable from real G-code in this box.
    r.gcode->SetToolTip(_L("G-code emitted once at the start of a print that uses this mode, before "
                           "the machine start G-code. This is where the printer is put into the "
                           "matching firmware mode — for example a Klipper SET_PRINT_MODE call or a "
                           "RepRapFirmware M567 — since the slicer only emits the Primary tool's "
                           "paths and the firmware drives the Copy / Mirror tools. Placeholders are "
                           "supported; use the edit button to browse them. Leave empty if the mode "
                           "needs no firmware setup."));
    r.gcode->Bind(wxEVT_TEXT, [this](wxCommandEvent&) { notify(); });

    if (!is_primary)
        name_col->Add(r.name, 0);
    sizer->Add(name_col, 0, wxALIGN_CENTER_VERTICAL | wxRIGHT, FromDIP(6));
    sizer->Add(grid_panel, 0, wxALIGN_CENTER_VERTICAL | wxRIGHT, FromDIP(6));
    sizer->Add(gcode_frame, 1, wxALIGN_CENTER_VERTICAL | wxRIGHT, FromDIP(4));

    // Edit on top, per-row reset under it, in one column top-aligned with the G-code box.
    // Remove is not here -- it sits under the name field, away from the button people press
    // most. The column is top- rather than centre-justified so the edit icon keeps the same
    // position whatever a row's height turns out to be.
    auto* btn_col = new wxBoxSizer(wxVERTICAL);
    wxTextCtrl* gcode_ctrl = r.gcode;
    auto* ph_btn = new ScalableButton(r.panel, wxID_ANY, "edit", wxEmptyString,
                                      wxDefaultSize, wxDefaultPosition,
                                      wxBU_EXACTFIT | wxNO_BORDER, /*use_default_disabled_bitmap=*/true, kImexIconPx);
    ph_btn->SetToolTip(_L("Edit G-code / browse placeholders"));
    ph_btn->Bind(wxEVT_BUTTON, [this, gcode_ctrl](wxCommandEvent&) {
        // EditGCodeDialog takes and returns UTF-8 (get_edited_gcode() is a ToUTF8()).
        EditGCodeDialog dlg(this, "imex_mode_gcode", into_u8(gcode_ctrl->GetValue()));
        if (dlg.ShowModal() == wxID_OK)
            gcode_ctrl->SetValue(from_u8(dlg.get_edited_gcode()));
    });
    btn_col->Add(ph_btn, 0, wxBOTTOM, FromDIP(2));

    if (!is_primary) {
        auto* rm = new ScalableButton(r.panel, wxID_ANY, "delete", wxEmptyString,
                                      wxDefaultSize, wxDefaultPosition,
                                      wxBU_EXACTFIT | wxNO_BORDER, /*use_default_disabled_bitmap=*/true, kImexIconPx);
        rm->SetToolTip(_L("Remove mode"));
        rm->Bind(wxEVT_BUTTON, [this, this_panel](wxCommandEvent&) {
            const std::vector<std::string> removed = remove_row(this_panel);
            // Copied before notify(): on_change ends in on_value_change, which can send
            // the tab through update() and hence load_from_config(), and that rebuilds
            // every row. Reading the member afterwards would be reading through a
            // handler whose owner has just been rebuilt underneath it.
            auto removed_cb = on_mode_removed;
            notify();
            if (removed_cb && !removed.empty())
                removed_cb(removed);
        });
        name_col->Add(rm, 0, wxALIGN_RIGHT | wxTOP, FromDIP(2));
    }
    // Reset only renders when this row has a counterpart in the saved preset (user-added rows
    // beyond the saved mode count get no reset — remove covers "drop the row I just added").
    wxPanel* this_panel_for_reset = r.panel;
    if (row_has_parent_counterpart(static_cast<int>(m_rows.size()))) {
        r.reset_btn = new ScalableButton(r.panel, wxID_ANY, "dot", wxEmptyString,
                                         wxDefaultSize, wxDefaultPosition,
                                         wxBU_EXACTFIT | wxNO_BORDER, /*use_default_disabled_bitmap=*/true, kImexIconPx);
        r.reset_btn->SetToolTip(_L("Discard in-session edits to this mode (snap back to saved value)"));
        r.reset_btn->Bind(wxEVT_BUTTON, [this, this_panel_for_reset](wxCommandEvent&) {
            reset_row_to_parent(this_panel_for_reset);
        });
        btn_col->Add(r.reset_btn, 0, wxTOP, FromDIP(2));
    }
    sizer->Add(btn_col, 0, wxALIGN_TOP | wxRIGHT, FromDIP(4));
    r.panel->SetSizerAndFit(sizer);

    m_rows_sizer->Add(r.panel, 0, wxEXPAND | wxBOTTOM, FromDIP(4));
    m_rows.push_back(std::move(r));
    Layout();
}

std::vector<std::string> IMEXModesCtrl::remove_row(wxPanel* panel) {
    for (size_t i = 0; i < m_rows.size(); ++i) {
        if (m_rows[i].panel != panel) continue;
        if (m_rows[i].is_primary) return {}; // primary row is non-deletable

        // Both names a plate can be holding for this row: the one the row was built with and
        // the one in the field now. They diverge as soon as the row is renamed, because a
        // rename does not rebuild the row and is deliberately not reported as a removal (the
        // name field notifies on every keystroke). Reporting only the current name is what
        // let "rename, then delete" leave the plate on a mode that no longer exists.
        std::vector<std::string> removed_names;
        const std::string current = m_rows[i].name ? into_u8(m_rows[i].name->GetTextCtrl()->GetValue())
                                                   : std::string();
        for (const std::string& n : {m_rows[i].orig_name, current})
            if (!n.empty() && std::find(removed_names.begin(), removed_names.end(), n) == removed_names.end())
                removed_names.push_back(n);

        m_rows_sizer->Detach(panel);
        m_rows.erase(m_rows.begin() + i);

        // A name a surviving row still carries is not stale: the user can rename row A to
        // row B's old name and then delete B. Plates holding it now resolve to A, so drop it
        // rather than reset them.
        auto still_in_use = [this](const std::string& n) {
            return std::any_of(m_rows.begin(), m_rows.end(), [&n](const Row& r) {
                return r.is_primary ? n == kImexPrimaryMode
                                    : r.name && into_u8(r.name->GetTextCtrl()->GetValue()) == n;
            });
        };
        removed_names.erase(std::remove_if(removed_names.begin(), removed_names.end(), still_in_use),
                            removed_names.end());

        Layout();
        // Defer widget destruction so any in-flight GTK events for
        // panel's children (including the remove button we're inside) finish
        // processing before the wxEvtHandlers are freed.
        wxTheApp->CallAfter([panel]() { panel->Destroy(); });
        return removed_names;
    }
    return {};
}

void IMEXModesCtrl::clear_rows() {
    // Destroying a focused wxTextCtrl emits wxEVT_KILL_FOCUS, and the Name field's
    // handler would then read m_rows while it is half-destroyed. Flag the teardown
    // so that handler stays out of the way.
    m_clearing_rows = true;
    for (auto& r : m_rows) { m_rows_sizer->Detach(r.panel); r.panel->Destroy(); }
    m_rows.clear();
    m_clearing_rows = false;
}

std::string IMEXModesCtrl::active_tools_string(const Row& r) const {
    // Serialize from all_tool_roles (not just visible buttons) so assignments
    // for off-screen tools are preserved across grid size changes. Inactive tools are
    // simply absent from the map, so there is nothing to filter out here.
    //
    // The letters come from imex_role_letter(), the same table parse_imex_active_tools()
    // reads back — this used to be a second, independent int → letter switch, which is
    // exactly where the editor and the slicer could come to disagree about a mode string.
    std::string s;
    for (const auto& [idx, role] : r.all_tool_roles) {
        if (!s.empty()) s += ',';
        s += std::to_string(idx) + ':' + imex_role_letter(role);
    }
    return s;
}

void IMEXModesCtrl::notify() {
    refresh_reset_buttons();
    if (on_change) on_change();
}

void IMEXModesCtrl::refresh_reset_buttons() {
    for (size_t i = 0; i < m_rows.size(); ++i) {
        Row& r = m_rows[i];
        if (!r.reset_btn || !r.reset_btn->IsEnabled()) continue;
        const bool dirty = row_differs_from_parent(static_cast<int>(i));
        if (dirty == r.reset_dirty_cached) continue;
        r.reset_dirty_cached = dirty;
        r.reset_btn->SetBitmap_(dirty ? "undo" : "dot");
    }
}

void IMEXModesCtrl::reset_row_to_parent(wxPanel* panel) {
    if (!m_parent_lookup) return;
    const DynamicPrintConfig* parent = m_parent_lookup();
    if (!parent) return;
    auto* p_names  = parent->option<ConfigOptionStrings>("imex_mode_names");
    auto* p_tools  = parent->option<ConfigOptionStrings>("imex_mode_active_tools");
    auto* p_gcodes = parent->option<ConfigOptionStrings>("imex_mode_gcodes");
    for (size_t i = 0; i < m_rows.size(); ++i) {
        Row& r = m_rows[i];
        if (r.panel != panel) continue;
        if (!p_names || i >= p_names->values.size()) return;
        if (!r.is_primary && r.name) {
            r.name->GetTextCtrl()->ChangeValue(from_u8(p_names->values[i]));
            // The saved name may since have been given to another row, which keeps it.
            fix_row_name(r);
        }
        if (p_gcodes && i < p_gcodes->values.size())
            r.gcode->ChangeValue(from_u8(p_gcodes->values[i]));
        if (p_tools && i < p_tools->values.size()) {
            // Reapply tool roles from the parent's serialized form. all_tool_roles
            // is the source of truth for round-tripping; rebuild it then re-paint
            // the visible buttons.
            r.all_tool_roles = roles_for_mode(p_tools->values[i]);
            for (size_t j = 0; j < r.btns.size(); ++j) {
                int tidx = r.btn_tool_idx[j];
                auto it = r.all_tool_roles.find(tidx);
                std::optional<ImexRole> role;
                if (it != r.all_tool_roles.end()) role = it->second;
                r.btn_roles[j] = role;
                apply_btn(r.btns[j], tidx, role);
            }
        }
        notify();
        return;
    }
}

}} // namespace Slic3r::GUI