end_credits.cpp

Go to the documentation of this file.

/*
    Copyright (C) 2016 - 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/end_credits.hpp"
 
#include "about.hpp"
#include "game_config.hpp"
#include "gui/widgets/grid.hpp"
#include "gui/widgets/scrollbar.hpp"
#include "gui/widgets/scroll_label.hpp"
#include "gui/widgets/window.hpp"
#include "gettext.hpp"
#include "serialization/markup.hpp"
 
#include <SDL2/SDL_timer.h>
 
#include <functional>
#include <sstream>
 
namespace gui2::dialogs
{
 
REGISTER_DIALOG(end_credits)
 
end_credits::end_credits(const std::string& campaign)
    : modal_dialog(window_id())
    , focus_on_(campaign)
    , backgrounds_()
    , text_widget_(nullptr)
    , scroll_speed_(100)
    , last_scroll_(std::numeric_limits<uint32_t>::max())
    , first_idx_(0)
    , last_idx_(first_idx_ + sliding_size_)
{
}
 
void end_credits::pre_show()
{
    last_scroll_ = SDL_GetTicks();
 
    connect_signal_pre_key_press(*this, std::bind(&end_credits::key_press_callback, this, std::placeholders::_5));
 
    std::stringstream ss;
    std::stringstream focus_ss;
 
    for(const about::credits_group& group : about::get_credits_data()) {
        std::stringstream& group_stream = (group.id == focus_on_) ? focus_ss : ss;
        group_stream << "\n";
 
        if(!group.header.empty()) {
            group_stream << markup::span_size("xx-large", group.header) << "\n";
        }
 
        for(const about::credits_group::about_group& about : group.sections) {
            group_stream << "\n" << markup::span_size("x-large", about.title) << "\n";
 
            for(const auto& entry : about.names) {
                group_stream << entry.first << "\n";
            }
        }
    }
 
    // If a section is focused, move it to the top
    if(!focus_ss.str().empty()) {
        focus_ss << ss.rdbuf();
    }
 
    // Get the appropriate background images
    backgrounds_ = about::get_background_images(focus_on_);
 
    if(backgrounds_.empty()) {
        backgrounds_.push_back(game_config::images::game_title_background);
    }
 
    // TODO: implement showing all available images as the credits scroll
    get_canvas(0).set_variable("background_image", wfl::variant(backgrounds_[0]));
 
    text_widget_ = find_widget<scroll_label>("text", false, true);
 
    text_widget_->set_use_markup(true);
    text_widget_->set_link_aware(false);
 
    content_ = focus_ss.str().empty() ? ss.str() : focus_ss.str();
 
    // splits the content text by newline, leaving blanks
    // also truncates the length of the line to 200 characters
    // 200 characters is completely arbitrary, just prevent the possibility of ridiculously wide lines
    // NOTE: this depends on the assumption that the <span>s added above only ever wrap a single line
    std::vector<std::string> lines = utils::split(content_, '\n', 0);
    int i = 0;
    for(const std::string& line : lines) {
        if(i % lines_per_chunk_ == 0) {
            chunks_.emplace_back();
        }
        std::vector<std::string>& last_chunk = chunks_[chunks_.size()-1];
        last_chunk.emplace_back(line.size() < 200 ? line : line.substr(0, 200));
        i++;
    }
 
    sliding_content_.clear();
    for(std::size_t i = 0; i <= sliding_size_; i++){
        sliding_content_ += utils::join(chunks_.at(i), "\n") + "\n";
    }
 
    //concat substring strings
    text_widget_->set_label(sliding_content_);
    // HACK: always hide the scrollbar, even if it's needed.
    // This should probably be implemented as a scrollbar mode.
    // Also, for some reason hiding the whole grid doesn't work, and the elements need to be hidden manually
    if(grid* v_grid = dynamic_cast<grid*>(text_widget_->find("_vertical_scrollbar_grid", false))) {
        v_grid->find_widget<scrollbar_base>("_vertical_scrollbar").set_visible(widget::visibility::hidden);
 
        // TODO: enable again if e24336afeb7 is reverted.
        //v_grid.find_widget<repeating_button>("_half_page_up").set_visible(widget::visibility::hidden);
        //v_grid.find_widget<repeating_button>("_half_page_down").set_visible(widget::visibility::hidden);
    }
}
 
void end_credits::update()
{
    uint32_t now = SDL_GetTicks();
    if(last_scroll_ > now) {
        return;
    }
 
    uint32_t missed_time = now - last_scroll_;
 
    unsigned int cur_pos = text_widget_->get_vertical_scrollbar_item_position();
 
    // Calculate how far the text should have scrolled by now
    // The division by 1000 is to convert milliseconds to seconds.
    unsigned int needed_dist = missed_time * scroll_speed_ / 1000;
 
    // TODO: this doesn't allow for scrolling up again after been scrolled down
    // only the content in the current sliding window can be scrolled up
    if(cur_pos <= text_widget_->get_height()){
        text_widget_->set_vertical_scrollbar_item_position(cur_pos + needed_dist);
    } else {
        if(first_idx_ < chunks_.size() - sliding_size_ - 1){
            first_idx_++;
            last_idx_ = first_idx_ + sliding_size_;
            sliding_content_.clear();
 
            if(last_idx_ <= chunks_.size()){
                for(std::size_t i = first_idx_; i <= last_idx_; i++) {
                    sliding_content_ += utils::join(chunks_[i], "\n") + "\n";
                }
            }
 
            // updates the sliding window
            text_widget_->set_label(sliding_content_);
            cur_pos = 0;
        }
    }
 
    last_scroll_ = now;
}
 
void end_credits::key_press_callback(const SDL_Keycode key)
{
    if(key == SDLK_UP && scroll_speed_ < 400) {
        scroll_speed_ <<= 1;
    }
 
    if(key == SDLK_DOWN && scroll_speed_ > 50) {
        scroll_speed_ >>= 1;
    }
}
 
} // namespace dialogs