replay_controller.hpp

Go to the documentation of this file.

/*
    Copyright (C) 2015 - 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.
*/
 
#pragma once
 
#include "play_controller.hpp"
#include "mouse_handler_base.hpp" //events::command_disabler
 
 
class replay_controller : public events::observer
{
public:
    class replay_stop_condition
    {
    public:
        virtual void move_done() {}
        virtual void new_side_turn(int , int ) {}
        virtual bool should_stop() { return true; }
        virtual ~replay_stop_condition(){}
    };
    static void nop() {}
    replay_controller(play_controller& controller, bool control_view, const std::shared_ptr<config>& reset_state, const std::function<void()>& on_end_replay = nop);
    ~replay_controller();
 
    // void reset_replay();
    void play_replay();
    void stop_replay();
    void replay_next_turn();
    void replay_next_side();
    void replay_next_move();
    void play_side_impl();
 
    bool recorder_at_end() const;
    bool should_stop() const { return stop_condition_->should_stop(); }
    bool can_execute_command(const hotkey::ui_command& cmd) const;
    bool is_controlling_view() const {
        return vision_.has_value();
    }
    bool allow_reset_replay() const { return reset_state_.get() != nullptr; }
    const std::shared_ptr<config>& get_reset_state() const { return reset_state_; }
    void return_to_play_side(bool r = true) { return_to_play_side_ = r; }
    void replay_show_everything();
    void replay_show_each();
    void replay_show_team1();
    void update_teams();
    void update_viewing_player();
    bool see_all();
private:
    void add_replay_theme();
    void init();
    void update_gui();
    void handle_generic_event(const std::string& name) override;
 
    /**
     * Refresh the states of the replay-control buttons, this will cause the
     * hotkey framework to query can_execute_command() for each button and then
     * set the enabled/disabled state based on that query.
     *
     * The ids for the associated buttons are: "button-playreplay",
     * "button-stopreplay", "button-resetreplay", "button-nextturn",
     * "button-nextside", and "button-nextmove".
     */
    void update_enabled_buttons();
 
    play_controller& controller_;
    std::unique_ptr<replay_stop_condition> stop_condition_;
    events::command_disabler disabler_;
 
    enum REPLAY_VISION
    {
        HUMAN_TEAM,
        CURRENT_TEAM,
        SHOW_ALL,
    };
    utils::optional<REPLAY_VISION> vision_;
    /// When the "Reset" button is pressed reset the gamestate to this
    /// serialized gamestaten, the initial gamestate.
    std::shared_ptr<config> reset_state_;
    /// Called when there are no more moves in the [replay] to process
    std::function<void()> on_end_replay_;
    /// Used by unit tests.
    bool return_to_play_side_;
};