mp_options_helper.cpp

Go to the documentation of this file.

/*
    Copyright (C) 2008 - 2025
    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 "gui/dialogs/multiplayer/mp_options_helper.hpp"
 
#include "preferences/preferences.hpp"
#include "gui/widgets/button.hpp"
#include "gui/widgets/menu_button.hpp"
#include "gui/widgets/slider.hpp"
#include "gui/widgets/toggle_button.hpp"
#include "gui/widgets/text_box.hpp"
#include "gui/widgets/tree_view.hpp"
#include "gui/widgets/tree_view_node.hpp"
#include "gui/widgets/window.hpp"
#include "wml_exception.hpp"
 
 
namespace gui2::dialogs
{
 
mp_options_helper::mp_options_helper(window& window, ng::create_engine& create_engine)
    : create_engine_(create_engine)
    , options_tree_(window.find_widget<tree_view>("custom_options"))
    , no_options_notice_(window.find_widget<styled_widget>("no_options_notice"))
    , node_data_map_()
    , visible_options_()
    , options_data_()
{
    for(const auto [_, cfg] : prefs::get().options().all_children_view()) {
        for(const auto& saved_option : cfg.child_range("option")) {
            options_data_[cfg["id"]][saved_option["id"].str()] = saved_option["value"];
        }
    }
 
    update_all_options();
}
 
void mp_options_helper::set_options(const config& new_options)
{
    visible_options_.clear();
    node_data_map_.clear();
    options_tree_.clear();
 
    for(const auto [_, cfg] : new_options.all_children_view()) {
        for(const auto& saved_option : cfg.child_range("option")) {
            options_data_[cfg["id"]][saved_option["id"].str()] = saved_option["value"];
        }
    }
 
    update_all_options();
}
 
void mp_options_helper::update_all_options()
{
    visible_options_.clear();
    node_data_map_.clear();
    options_tree_.clear();
 
    update_game_options();
    update_era_options();
    update_mod_options();
}
 
void mp_options_helper::update_game_options()
{
    std::string type;
 
    if(create_engine_.is_campaign()) {
        type = "campaign";
    } else {
        type = "multiplayer";
    }
 
    // For game options, we check for both types and remove them. This is to prevent options from a game
    // of one type remaining visible when selecting a game of another type.
              remove_nodes_for_type("campaign");
    int pos = remove_nodes_for_type("multiplayer");
 
    display_custom_options(type, pos, create_engine_.current_level().data());
 
    update_status_label();
}
 
void mp_options_helper::update_era_options()
{
    static const std::string type = "era";
 
    int pos = remove_nodes_for_type(type);
 
    display_custom_options(type, pos, create_engine_.curent_era_cfg());
 
    update_status_label();
}
 
void mp_options_helper::update_mod_options()
{
    static const std::string type = "modification";
 
    int pos = remove_nodes_for_type(type);
 
    for(const auto& mod : create_engine_.active_mods_data()) {
        display_custom_options(type, pos, *mod->cfg);
    }
 
    update_status_label();
}
 
int mp_options_helper::remove_nodes_for_type(const std::string& type)
{
    // Remove all visible options of the specified source type
    utils::erase_if(visible_options_, [&type](const option_source& source) {
        return source.level_type == type;
    });
 
    // Get the node data for this specific source type
    type_node_data* data;
 
    auto node_data_map_iter = node_data_map_.end();
    std::tie(node_data_map_iter, std::ignore) = node_data_map_.emplace(type, type_node_data());
 
    data = &node_data_map_iter->second;
 
    node_vector& type_node_vector = data->nodes;
 
    // The position to insert a new node of this type. If no nodes exist yet, the default value (-1) is
    // accepted by tree_view_node as meaning at-end.
    int& position = data->position;
 
    // Remove each node in reverse, so that in the end we have the position of the first node removed
    for(auto i = type_node_vector.rbegin(); i != type_node_vector.rend(); i++) {
        position = options_tree_.remove_node(*i).second;
    }
 
    type_node_vector.clear();
 
    return position;
}
 
void mp_options_helper::update_status_label()
{
    // No custom options, display a message
    no_options_notice_.set_visible(options_tree_.empty());
}
 
template<typename T>
void mp_options_helper::update_options_data_map(T* widget, const option_source& source)
{
    options_data_[source.id][widget->id()] = widget->get_value();
}
 
template<>
void mp_options_helper::update_options_data_map(toggle_button* widget, const option_source& source)
{
    options_data_[source.id][widget->id()] = widget->get_value_bool();
}
 
void mp_options_helper::update_options_data_map_menu_button(menu_button* widget, const option_source& source, const config& cfg)
{
    options_data_[source.id][widget->id()] = cfg.child_range("item")[widget->get_value()]["value"].str();
}
 
void mp_options_helper::reset_options_data(const option_source& source, bool& handled, bool& halt)
{
    options_data_[source.id].clear();
 
    if(source.level_type == "campaign" || source.level_type == "multiplayer") {
        update_game_options();
    } else if(source.level_type == "era") {
        update_era_options();
    } else if(source.level_type == "modification") {
        update_mod_options();
    }
 
    handled = true;
    halt = true;
}
 
template<typename T>
std::pair<T*, config::attribute_value> mp_options_helper::add_node_and_get_widget(
        tree_view_node& option_node, const std::string& id, data_map& data, const config& cfg)
{
    tree_view_node& node = option_node.add_child(id + "_node", data);
 
    T* widget = dynamic_cast<T*>(node.find(id, true));
    VALIDATE(widget, missing_widget(id));
 
    const std::string widget_id = cfg["id"];
 
    auto& option_config = options_data_[visible_options_.back().id];
    if(!option_config.has_attribute(widget_id) || option_config[widget_id].empty()) {
        option_config[widget_id] = cfg["default"];
    }
 
    widget->set_id(widget_id);
    widget->set_tooltip(cfg["description"]);
 
    return {widget, option_config[widget_id]};
}
 
void mp_options_helper::display_custom_options(const std::string& type, int node_position, const config& cfg)
{
    // Needed since some compilers don't like passing just {}
    static const widget_data empty_map;
 
    // This ensures that any game, era, or mod with no options doesn't get an entry in the visible_options_
    // vector and prevents invalid options from different games, era, or mods being created when the options
    // config is created.
    if(!cfg.has_child("options")) {
        return;
    }
 
    visible_options_.push_back({type, cfg["id"]});
 
    // Get the node vector for this specific source type
    node_vector& type_node_vector = node_data_map_[type].nodes;
 
    for(const auto& options : cfg.child_range("options")) {
        widget_data data;
        widget_item item;
 
        item["label"] = cfg["name"];
        data.emplace("tree_view_node_label", item);
 
        tree_view_node& option_node = options_tree_.add_node("option_node", data, node_position);
        type_node_vector.push_back(&option_node);
 
        for(const auto [option_key, option_cfg] : options.all_children_view()) {
            data.clear();
            item.clear();
 
            config::attribute_value val;
 
            if(option_key == "checkbox") {
                item["label"] = option_cfg["name"];
                data.emplace("option_checkbox", item);
 
                toggle_button* checkbox;
                std::tie(checkbox, val) = add_node_and_get_widget<toggle_button>(option_node, "option_checkbox", data, option_cfg);
 
                checkbox->set_value(val.to_bool());
 
                connect_signal_notify_modified(*checkbox,
                    std::bind(&mp_options_helper::update_options_data_map<toggle_button>, this, checkbox, visible_options_.back()));
 
            } else if(option_key == "spacer") {
                option_node.add_child("options_spacer_node", empty_map);
 
            } else if(option_key == "choice") {
                if(!option_cfg.has_child("item")) {
                    continue;
                }
 
                item["label"] = option_cfg["name"];
                data.emplace("menu_button_label", item);
 
                std::vector<config> combo_items;
                std::vector<std::string> combo_values;
 
                for(auto i : option_cfg.child_range("item")) {
                    // Comboboxes expect this key to be 'label' not 'name'
                    i["label"] = i["name"];
 
                    combo_items.push_back(i);
                    combo_values.push_back(i["value"]);
                }
 
                menu_button* menu;
                std::tie(menu, val) = add_node_and_get_widget<menu_button>(option_node, "option_menu_button", data, option_cfg);
 
                // Needs to be called before set_selected
                menu->set_values(combo_items);
 
                auto iter = std::find(combo_values.begin(), combo_values.end(), val.str());
 
                if(iter != combo_values.end()) {
                    menu->set_selected(std::distance(combo_values.begin(), iter));
                }
 
                connect_signal_notify_modified(*menu,
                    std::bind(&mp_options_helper::update_options_data_map_menu_button, this, menu, visible_options_.back(), option_cfg));
 
            } else if(option_key == "slider") {
                item["label"] = option_cfg["name"];
                data.emplace("slider_label", item);
 
                slider* slide;
                std::tie(slide, val) = add_node_and_get_widget<slider>(option_node, "option_slider", data, option_cfg);
 
                slide->set_value_range(option_cfg["min"].to_int(), option_cfg["max"].to_int());
                slide->set_step_size(option_cfg["step"].to_int(1));
                slide->set_value(val.to_int());
 
                connect_signal_notify_modified(*slide,
                    std::bind(&mp_options_helper::update_options_data_map<slider>, this, slide, visible_options_.back()));
 
            } else if(option_key == "entry") {
                item["label"] = option_cfg["name"];
                data.emplace("text_entry_label", item);
 
                text_box* textbox;
                std::tie(textbox, val) = add_node_and_get_widget<text_box>(option_node, "option_text_entry", data, option_cfg);
 
                textbox->set_value(val.str());
                textbox->on_modified([this](const auto& box) { update_options_data_map(&box, visible_options_.back()); });
            }
        }
 
        // Add the Defaults button at the end
        tree_view_node& node = option_node.add_child("options_default_button", empty_map);
 
        connect_signal_mouse_left_click(node.find_widget<button>("reset_option_values"),
            std::bind(&mp_options_helper::reset_options_data, this, visible_options_.back(),
                std::placeholders::_3, std::placeholders::_4));
    }
}
 
config mp_options_helper::get_options_config()
{
    config options;
    for(const auto& source : visible_options_) {
        config& mod = options.add_child(source.level_type);
        mod["id"] = source.id;
#if 0
        // TODO: enable this as soon as we drop the old mp configure screen.
        mod.add_child("options", options_data_[source.id]);
#else
        for(const auto& [key, value] : options_data_[source.id].attribute_range()) {
            mod.add_child("option", config {"id", key, "value", value});
        }
#endif
    }
 
    return options;
}
 
} // namespace dialogs