mp_options_helper.hpp

Go to the documentation of this file.

/*
    Copyright (C) 2008 - 2022
    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.
*/

#pragma once

#include "game_initialization/create_engine.hpp"
#include "gui/widgets/generator.hpp"

class config;

namespace gui2
{

class styled_widget;
class menu_button;
class toggle_button;
class tree_view;
class tree_view_node;
class window;

namespace dialogs
{

class mp_options_helper
{
public:
    mp_options_helper(window& window, ng::create_engine& create_engine);

    void update_all_options();

    void update_game_options();
    void update_era_options();
    void update_mod_options();

    config get_options_config();

private:
    struct option_source
    {
        std::string level_type;
        std::string id;

        friend bool operator<(const option_source& a, const option_source& b)
        {
            return std::tie(a.level_type, a.id) < std::tie(b.level_type, b.id);
        }
    };

    int remove_nodes_for_type(const std::string& type);

    using data_map = widget_data;

    template <typename T>
    std::pair<T*, config::attribute_value> add_node_and_get_widget(
        tree_view_node& option_node, const std::string& id, data_map& data, const config& cfg);

    void display_custom_options(const std::string& type, int node_position, const config& data);

    template<typename T>
    void update_options_data_map(T* widget, const option_source& source);
    void update_options_data_map(toggle_button* widget, const option_source& source);

    // NOTE: this cannot be an overload of update_options_data_map since that's a templated function
    void update_options_data_map_menu_button(menu_button* widget, const option_source& source, const config& cfg);

    void reset_options_data(const option_source& source, bool& handled, bool& halt);

    void update_status_label();

    ng::create_engine& create_engine_;

    tree_view& options_tree_;
    styled_widget& no_options_notice_;

    using node_vector = std::vector<tree_view_node*>;

    struct type_node_data
    {
        type_node_data() : nodes(), position(-1) {}

        node_vector nodes;
        int position;

        bool operator<(const type_node_data& data) {
            return (*this).position < data.position;
        }
    };

    std::map<std::string, type_node_data> node_data_map_;

    std::vector<option_source> visible_options_;
    std::map<std::string, config> options_data_;
};

} // namespace dialogs
} // namespace gui2