unit_recruit.cpp

Go to the documentation of this file.

/*
    Copyright (C) 2016 - 2024
    Part of the Battle for Wesnoth Project https://www.wesnoth.org/
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY.
 
    See the COPYING file for more details.
*/
 
#define GETTEXT_DOMAIN "wesnoth-lib"
 
#include "serialization/markup.hpp"
#include "gui/dialogs/unit_recruit.hpp"
#include "gui/widgets/button.hpp"
#include "gui/widgets/image.hpp"
#include "gui/widgets/listbox.hpp"
#include "gui/widgets/unit_preview_pane.hpp"
#include "gui/widgets/text_box.hpp"
#include "gui/widgets/window.hpp"
#include "gettext.hpp"
#include "help/help.hpp"
#include "team.hpp"
#include "units/types.hpp"
#include "utils/ci_searcher.hpp"
 
#include <functional>
 
namespace gui2::dialogs
{
 
REGISTER_DIALOG(unit_recruit)
 
unit_recruit::unit_recruit(std::map<const unit_type*, t_string>& recruit_map, team& team)
    : modal_dialog(window_id())
    , recruit_list_()
    , recruit_map_(recruit_map)
    , team_(team)
    , selected_index_(0)
{
    for(const auto& pair : recruit_map) {
        recruit_list_.push_back(pair.first);
    }
    // Ensure the recruit list is sorted by name
    std::sort(recruit_list_.begin(), recruit_list_.end(), [](const unit_type* t1, const unit_type* t2) {
        return t1->type_name().str() < t2->type_name().str();
    });
 
}
 
static const color_t inactive_row_color(0x96, 0x96, 0x96);
 
static inline std::string gray_if_unrecruitable(const std::string& text, const bool is_recruitable)
{
    return is_recruitable ? text : markup::span_color(inactive_row_color, text);
}
 
// Compare unit_create::filter_text_change
void unit_recruit::filter_text_changed(const std::string& text)
{
    find_widget<listbox>("recruit_list")
        .filter_rows_by([this, match = translation::make_ci_matcher(text)](std::size_t row) {
            const unit_type* type = recruit_list_[row];
            if(!type) return true;
 
            const auto default_gender = !type->genders().empty() ? type->genders().front() : unit_race::MALE;
            const auto race = type->race();
 
            // List of possible match criteria for this unit type.
            // Empty values will never match.
            return match(
                (game_config::debug ? type->id() : ""),
                type->type_name(),
                std::to_string(type->level()),
                unit_type::alignment_description(type->alignment(), default_gender),
                (race ? race->name(default_gender) : ""),
                (race ? race->plural_name() : "")
            );
        });
}
 
void unit_recruit::pre_show()
{
    text_box* filter = find_widget<text_box>("filter_box", false, true);
    filter->on_modified([this](const auto& box) { filter_text_changed(box.text()); });
 
    listbox& list = find_widget<listbox>("recruit_list");
 
    connect_signal_notify_modified(list, std::bind(&unit_recruit::list_item_clicked, this));
 
    keyboard_capture(filter);
    add_to_keyboard_chain(&list);
 
    connect_signal_mouse_left_click(
        find_widget<button>("show_help"),
        std::bind(&unit_recruit::show_help, this));
 
    for(const auto& recruit : recruit_list_)
    {
        const t_string& error = recruit_map_[recruit];
        widget_data row_data;
        widget_item column;
 
        std::string image_string = recruit->image() + "~RC(" + recruit->flag_rgb() + ">"
            + team_.color() + ")";
 
        const bool is_recruitable = error.empty();
 
        const std::string cost_string = std::to_string(recruit->cost());
 
        column["use_markup"] = "true";
        if(!error.empty()) {
            // Just set the tooltip on every single element in this row.
            column["tooltip"] = error;
        }
 
        column["label"] = image_string + (is_recruitable ? "" : "~GS()");
        row_data.emplace("unit_image", column);
 
        column["label"] = gray_if_unrecruitable(recruit->type_name(), is_recruitable);
        row_data.emplace("unit_type", column);
 
        column["label"] = gray_if_unrecruitable(cost_string, is_recruitable);
        row_data.emplace("unit_cost", column);
 
        grid& grid = list.add_row(row_data);
        if(!is_recruitable) {
            image *gold_icon = dynamic_cast<image*>(grid.find("gold_icon", false));
            assert(gold_icon);
            gold_icon->set_image(gold_icon->get_image() + "~GS()");
        }
    }
 
    list_item_clicked();
}
 
void unit_recruit::list_item_clicked()
{
    const int selected_row
        = find_widget<listbox>("recruit_list").get_selected_row();
 
    if(selected_row == -1) {
        return;
    }
 
    find_widget<unit_preview_pane>("recruit_details")
        .set_display_data(*recruit_list_[selected_row]);
}
 
void unit_recruit::show_help()
{
    help::show_help("recruit_and_recall");
}
 
void unit_recruit::post_show()
{
    if(get_retval() == retval::OK) {
        selected_index_ = find_widget<listbox>("recruit_list")
            .get_selected_row();
    }
}
 
} // namespace dialogs