campaign_selection.hpp

Go to the documentation of this file.

/*
    Copyright (C) 2009 - 2024
    by Mark de Wever <koraq@xs4all.nl>
    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 "gui/dialogs/modal_dialog.hpp"
 
#include "game_initialization/create_engine.hpp"
 
#include <boost/dynamic_bitset.hpp>
 
namespace gui2::dialogs
{
 
class campaign_selection : public modal_dialog
{
    enum CAMPAIGN_ORDER {RANK, DATE, NAME};
public:
    /**
     * RNG mode selection values.
     *
     * @note The contents of this enum must match the order of the options
     *       defined in the WML for the "rng_menu" widget of this dialog.
     */
    enum RNG_MODE
    {
        RNG_DEFAULT,
        RNG_SAVE_SEED,
        RNG_BIASED,
    };
 
    //return value for opening addon manager
    const static int OPEN_ADDON_MANAGER = 3;
 
    explicit campaign_selection(ng::create_engine& eng)
        : modal_dialog(window_id())
        , engine_(eng)
        , choice_(-1)
        , rng_mode_(RNG_DEFAULT)
        , mod_states_()
        , page_ids_()
        , difficulties_()
        , current_difficulty_()
        , current_sorting_(RANK)
        , currently_sorted_asc_(true)
        , mod_ids_()
    {
    }
 
    /***** ***** ***** setters / getters for members ***** ****** *****/
 
    int get_choice() const
    {
        return choice_;
    }
 
    RNG_MODE get_rng_mode() const
    {
        return rng_mode_;
    }
 
    const std::string& get_difficulty() const
    {
        return current_difficulty_;
    }
 
private:
    /** Called when another campaign is selected. */
    void campaign_selected();
 
    /** Called when the difficulty selection changes. */
    void difficulty_selected();
 
    virtual const std::string& window_id() const override;
 
    virtual void pre_show() override;
 
    void proceed();
 
    void sort_campaigns(CAMPAIGN_ORDER order, bool ascending);
 
    void add_campaign_to_tree(const config& campaign);
 
    void toggle_sorting_selection(CAMPAIGN_ORDER order);
 
    void mod_toggled();
 
    void filter_text_changed(const std::string& text);
 
    ng::create_engine& engine_;
 
    /** The chosen campaign. */
    int choice_;
 
    /** whether the player checked the "Deterministic" checkbox. */
    RNG_MODE rng_mode_;
 
    boost::dynamic_bitset<> mod_states_;
 
    std::vector<std::string> page_ids_;
 
    std::vector<std::string> difficulties_;
 
    std::string current_difficulty_;
 
    CAMPAIGN_ORDER current_sorting_;
 
    bool currently_sorted_asc_;
 
    std::vector<std::string> last_search_words_;
 
    inline const static std::string missing_campaign_ = "////missing-campaign////";
    inline const static std::string addons_ = "////addons////";
 
    std::vector<std::string> mod_ids_;
};
 
} // namespace dialogs