pump.hpp

Go to the documentation of this file.

/*
    Copyright (C) 2003 - 2025
    by David White <dave@whitevine.net>
    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.
*/
 
/**
 * @file
 * Define the game's event mechanism.
 *
 * Events might be units moving or fighting, or when victory or defeat occurs.
 * A scenario's configuration file will define actions to take when certain events occur.
 * This module is responsible for the processing of events.
 *
 * Note that game events have nothing to do with SDL events,
 * like mouse movement, keyboard events, etc.
 * See events.hpp for how they are handled.
 */
 
#pragma once
 
#include "game_events/fwd.hpp"
#include "game_events/entity_location.hpp"
#include "game_events/manager.hpp"
 
#include "config.hpp"
 
#include <sstream>
#include <string>
 
namespace lg
{
class logger;
}
 
namespace game_events
{
struct queued_event
{
    queued_event(const std::string& name,
            const std::string& id,
            const entity_location& loc1,
            const entity_location& loc2,
            const config& data)
        : name(name)
        , id(id)
        , loc1(loc1)
        , loc2(loc2)
        , data(data)
    {
        std::replace(this->name.begin(), this->name.end(), ' ', '_');
    }
 
    std::string name;
    std::string id;
    entity_location loc1;
    entity_location loc2;
    config data;
};
 
struct pump_impl;
class manager;
 
class wml_event_pump
{
    const std::unique_ptr<pump_impl> impl_;
 
public:
    wml_event_pump(manager&);
    ~wml_event_pump();
 
    /**
     * Context: The general environment within which events are processed.
     * Returns whether or not audoing is impossible due to wml.
     */
    bool undo_disabled();
 
    /** [allow_undo] implementation */
    void set_undo_disabled(bool mutated);
 
    /**
     * Returns whether or not wml wants to abort the currently executed user action.
     */
    bool action_canceled();
 
    /** Sets whether or not wml wants to abort the currently executed user action. */
    void set_action_canceled();
 
    /** Returns whether or not we are skipping messages. */
    bool context_skip_messages();
 
    /** Sets whether or not we are skipping messages. */
    void context_skip_messages(bool skip);
 
    /*
     * Helper function which determines whether a wml_message text can
     * really be pushed into the wml_messages_stream, and does it.
     */
    void put_wml_message(const std::string& logger, const std::string& message, bool in_chat);
 
    /**
     * Function to fire an event.
     *
     * Events may have up to two arguments, both of which must be locations.
     */
    pump_result_t fire(const std::string& event,
            const entity_location& loc1 = entity_location::null_entity,
            const entity_location& loc2 = entity_location::null_entity,
            const config& data = config());
 
    pump_result_t fire(const std::string& event,
            const std::string& id,
            const entity_location& loc1 = entity_location::null_entity,
            const entity_location& loc2 = entity_location::null_entity,
            const config& data = config());
 
    void raise(const std::string& event,
            const std::string& id,
            const entity_location& loc1 = entity_location::null_entity,
            const entity_location& loc2 = entity_location::null_entity,
            const config& data = config());
 
    inline void raise(const std::string& event,
            const entity_location& loc1 = entity_location::null_entity,
            const entity_location& loc2 = entity_location::null_entity,
            const config& data = config())
    {
        raise(event, "", loc1, loc2, data);
    }
 
    pump_result_t operator()();
 
    /** Flushes WML messages and errors. */
    void flush_messages();
 
private:
    void process_event(handler_ptr& handler_p, const queued_event& ev);
 
    void fill_wml_messages_map(std::map<std::string, int>& msg_map, std::stringstream& source);
 
    void show_wml_messages(std::stringstream& source, const std::string& caption);
 
    void show_wml_errors();
 
    void show_wml_messages();
 
    void put_wml_message(lg::logger& logger, const std::string& prefix, const std::string& message, bool in_chat);
};
}