campaign_selection.cpp

Go to the documentation of this file.

/*
   Copyright (C) 2009 - 2018 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.
*/

#define GETTEXT_DOMAIN "wesnoth-lib"

#include "gui/dialogs/campaign_selection.hpp"

#include "gui/auxiliary/find_widget.hpp"
#include "gui/widgets/button.hpp"
#include "gui/widgets/image.hpp"
#include "gui/widgets/listbox.hpp"
#include "gui/widgets/multi_page.hpp"
#include "gui/widgets/multimenu_button.hpp"
#include "gui/widgets/scroll_label.hpp"
#include "gui/widgets/settings.hpp"
#include "gui/widgets/text_box.hpp"
#include "gui/widgets/toggle_button.hpp"
#include "gui/widgets/tree_view.hpp"
#include "gui/widgets/tree_view_node.hpp"
#include "gui/widgets/window.hpp"
#include "lexical_cast.hpp"
#include "preferences/game.hpp"

#include "utils/functional.hpp"
#include "utils/irdya_datetime.hpp"

namespace gui2
{
namespace dialogs
{
/*WIKI
 * @page = GUIWindowDefinitionWML
 * @order = 2_campaign_selection
 *
 * == Campaign selection ==
 *
 * This shows the dialog which allows the user to choose which campaign to
 * play.
 *
 * @begin{table}{dialog_widgets}
 *
 * campaign_tree & & tree_view & m &
 *         A tree_view that contains all available campaigns. $
 *
 * -icon & & image & o &
 *         The icon for the campaign. $
 *
 * -name & & styled_widget & o &
 *         The name of the campaign. $
 *
 * -victory & & image & o &
 *         The icon to show when the user finished the campaign. The engine
 *         determines whether or not the user has finished the campaign and
 *         sets the visible flag for the widget accordingly. $
 *
 * campaign_details & & multi_page & m &
 *         A multi page widget that shows more details for the selected
 *         campaign. $
 *
 * -image & & image & o &
 *         The image for the campaign. $
 *
 * -description & & styled_widget & o &
 *         The description of the campaign. $
 *
 * @end{table}
 */

REGISTER_DIALOG(campaign_selection)

void campaign_selection::campaign_selected() const
{
    tree_view& tree = find_widget<tree_view>(get_window(), "campaign_tree", false);
    if(tree.empty()) {
        return;
    }

    assert(tree.selected_item());

    if(!tree.selected_item()->id().empty()) {
        auto iter = std::find(page_ids_.begin(), page_ids_.end(), tree.selected_item()->id());

        const int choice = std::distance(page_ids_.begin(), iter);
        if(iter == page_ids_.end()) {
            return;
        }

        multi_page& pages = find_widget<multi_page>(get_window(), "campaign_details", false);
        pages.select_page(choice);

        engine_.set_current_level(choice);
    }
}

void campaign_selection::sort_campaigns(campaign_selection::CAMPAIGN_ORDER order, bool ascending) const
{
    using level_ptr = ng::create_engine::level_ptr;

    auto levels = engine_.get_levels_by_type_unfiltered(ng::level::TYPE::SP_CAMPAIGN);

    switch(order) {
    case RANK: // Already sorted by rank
        // This'll actually never happen, but who knows if that'll ever change...
        if(!ascending) {
            std::reverse(levels.begin(), levels.end());
        }

        break;

    case DATE:
        std::sort(levels.begin(), levels.end(), [ascending](const level_ptr& a, const level_ptr& b) {
            auto cpn_a = std::dynamic_pointer_cast<ng::campaign>(a);
            auto cpn_b = std::dynamic_pointer_cast<ng::campaign>(b);

            if(cpn_b == nullptr) {
                return cpn_a != nullptr;
            }

            if(cpn_a == nullptr) {
                return false;
            }

            return ascending
                ? cpn_a->dates().first < cpn_b->dates().first
                : cpn_a->dates().first > cpn_b->dates().first;
        });

        break;

    case NAME:
        std::sort(levels.begin(), levels.end(), [ascending](const level_ptr& a, const level_ptr& b) {
            const int cmp = translation::icompare(a->name(), b->name());
            return ascending ? cmp < 0 : cmp > 0;
        });

        break;
    }

    tree_view& tree = find_widget<tree_view>(get_window(), "campaign_tree", false);

    // Remember which campaign was selected...
    std::string was_selected;
    if(!tree.empty()) {
        was_selected = tree.selected_item()->id();
        tree.clear();
    }

    boost::dynamic_bitset<> show_items;
    show_items.resize(levels.size(), true);

    if(!last_search_words_.empty()) {
        for(unsigned i = 0; i < levels.size(); ++i) {
            bool found = false;
            for(const auto& word : last_search_words_) {
                found = translation::ci_search(levels[i]->name(), word) ||
                        translation::ci_search(levels[i]->data()["name"].t_str().base_str(), word) ||
                        translation::ci_search(levels[i]->description(), word) ||
                        translation::ci_search(levels[i]->data()["description"].t_str().base_str(), word) ||
                        translation::ci_search(levels[i]->data()["abbrev"], word) ||
                        translation::ci_search(levels[i]->data()["abbrev"].t_str().base_str(), word);

                if(!found) {
                    break;
                }
            }

            show_items[i] = found;
        }
    }

    bool exists_in_filtered_result = false;
    for(unsigned i = 0; i < levels.size(); ++i) {
        if(show_items[i]) {
            add_campaign_to_tree(levels[i]->data());

            if (!exists_in_filtered_result) {
                exists_in_filtered_result = levels[i]->id() == was_selected;
            }
        }
    }

    if(!was_selected.empty() && exists_in_filtered_result) {
        find_widget<tree_view_node>(get_window(), was_selected, false).select_node();
    } else {
        campaign_selected();
    }
}

void campaign_selection::toggle_sorting_selection(CAMPAIGN_ORDER order)
{
    static bool force = false;
    if(force) {
        return;
    }

    if(current_sorting_ == order) {
        if(currently_sorted_asc_) {
            currently_sorted_asc_ = false;
        } else {
            currently_sorted_asc_ = true;
            current_sorting_ = RANK;
        }
    } else if(current_sorting_ == RANK) {
        currently_sorted_asc_ = true;
        current_sorting_ = order;
    } else {
        currently_sorted_asc_ = true;
        current_sorting_ = order;

        force = true;

        if(order == NAME) {
            find_widget<toggle_button>(get_window(), "sort_time", false).set_value(0);
        } else if(order == DATE) {
            find_widget<toggle_button>(get_window(), "sort_name", false).set_value(0);
        }

        force = false;
    }

    sort_campaigns(current_sorting_, currently_sorted_asc_);
}

void campaign_selection::filter_text_changed(const std::string& text)
{
    const std::vector<std::string> words = utils::split(text, ' ');

    if(words == last_search_words_) {
        return;
    }

    last_search_words_ = words;
    sort_campaigns(current_sorting_, currently_sorted_asc_);
}

void campaign_selection::pre_show(window& window)
{
    text_box* filter = find_widget<text_box>(&window, "filter_box", false, true);
    filter->set_text_changed_callback(
            std::bind(&campaign_selection::filter_text_changed, this, _2));

    /***** Setup campaign tree. *****/
    tree_view& tree = find_widget<tree_view>(&window, "campaign_tree", false);

    connect_signal_notify_modified(tree,
        std::bind(&campaign_selection::campaign_selected, this));

    toggle_button& sort_name = find_widget<toggle_button>(&window, "sort_name", false);
    toggle_button& sort_time = find_widget<toggle_button>(&window, "sort_time", false);

    connect_signal_notify_modified(sort_name,
        std::bind(&campaign_selection::toggle_sorting_selection, this, NAME));

    connect_signal_notify_modified(sort_time,
        std::bind(&campaign_selection::toggle_sorting_selection, this, DATE));

    window.keyboard_capture(filter);
    window.add_to_keyboard_chain(&tree);

    /***** Setup campaign details. *****/
    multi_page& pages = find_widget<multi_page>(&window, "campaign_details", false);

    for(const auto& level : engine_.get_levels_by_type_unfiltered(ng::level::TYPE::SP_CAMPAIGN)) {
        const config& campaign = level->data();

        /*** Add tree item ***/
        add_campaign_to_tree(campaign);

        /*** Add detail item ***/
        std::map<std::string, string_map> data;
        string_map item;

        item["label"] = campaign["description"];
        item["use_markup"] = "true";

        if(!campaign["description_alignment"].empty()) {
            item["text_alignment"] = campaign["description_alignment"];
        }

        data.emplace("description", item);

        item["label"] = campaign["image"];
        data.emplace("image", item);

        pages.add_page(data);
        page_ids_.push_back(campaign["id"]);
    }

    //
    // Set up Mods selection dropdown
    //
    multimenu_button& mods_menu = find_widget<multimenu_button>(&window, "mods_menu", false);

    if(!engine_.get_const_extras_by_type(ng::create_engine::MOD).empty()) {
        std::vector<config> mod_menu_values;
        std::vector<std::string> enabled = engine_.active_mods();

        for(const auto& mod : engine_.get_const_extras_by_type(ng::create_engine::MOD)) {
            const bool active = std::find(enabled.begin(), enabled.end(), mod->id) != enabled.end();

            mod_menu_values.emplace_back("label", mod->name, "checkbox", active);

            mod_states_.push_back(active);
        }

        mods_menu.set_values(mod_menu_values);
        mods_menu.select_options(mod_states_);

        connect_signal_notify_modified(mods_menu, std::bind(&campaign_selection::mod_toggled, this));
    } else {
        mods_menu.set_active(false);
        mods_menu.set_label(_("active_modifications^None"));
    }

    campaign_selected();
}

void campaign_selection::add_campaign_to_tree(const config& campaign) const
{
    tree_view& tree = find_widget<tree_view>(get_window(), "campaign_tree", false);
    std::map<std::string, string_map> data;
    string_map item;

    item["label"] = campaign["icon"];
    data.emplace("icon", item);

    item["label"] = campaign["name"];
    data.emplace("name", item);

    // We completed the campaign! Calculate the appropriate victory laurel.
    if(campaign["completed"].to_bool()) {
        config::const_child_itors difficulties = campaign.child_range("difficulty");

        auto did_complete_at = [](const config& c) { return c["completed_at"].to_bool(); };

        // Check for non-completion on every difficulty save the first.
        const bool only_first_completed = difficulties.size() > 1 &&
            std::none_of(difficulties.begin() + 1, difficulties.end(), did_complete_at);

        /*
         * Criteria:
         *
         * - Use the gold laurel (hardest) for campaigns with only one difficulty OR
         *   if out of two or more difficulties, the last one has been completed.
         *
         * - Use the bronze laurel (easiest) only if the first difficulty out of two
         *   or more has been completed.
         *
         * - Use the silver laurel otherwise.
         */
        if(!difficulties.empty() && did_complete_at(difficulties.back())) {
            item["label"] = game_config::images::victory_laurel_hardest;
        } else if(only_first_completed && did_complete_at(difficulties.front())) {
            item["label"] = game_config::images::victory_laurel_easy;
        } else {
            item["label"] = game_config::images::victory_laurel;
        }

        data.emplace("victory", item);
    }

    tree.add_node("campaign", data).set_id(campaign["id"]);
}

void campaign_selection::post_show(window& window)
{
    tree_view& tree = find_widget<tree_view>(&window, "campaign_tree", false);

    if(tree.empty()) {
        return;
    }

    assert(tree.selected_item());
    if(!tree.selected_item()->id().empty()) {
        auto iter = std::find(page_ids_.begin(), page_ids_.end(), tree.selected_item()->id());
        if(iter != page_ids_.end()) {
            choice_ = std::distance(page_ids_.begin(), iter);
        }
    }

    deterministic_ = find_widget<toggle_button>(&window, "checkbox_deterministic", false).get_value_bool();

    preferences::set_modifications(engine_.active_mods(), false);
}

void campaign_selection::mod_toggled()
{
    boost::dynamic_bitset<> new_mod_states =
        find_widget<multimenu_button>(get_window(), "mods_menu", false).get_toggle_states();

    // Get a mask of any mods that were toggled, regardless of new state
    mod_states_ = mod_states_ ^ new_mod_states;

    for(unsigned i = 0; i < mod_states_.size(); i++) {
        if(mod_states_[i]) {
            engine_.toggle_mod(i);
        }
    }

    // Save the full toggle states for next time
    mod_states_ = new_mod_states;
}

} // namespace dialogs
} // namespace gui2