action.cpp

Go to the documentation of this file.

/*
    Copyright (C) 2008 - 2025
    by Tomasz Sniatowski <kailoran@gmail.com>
    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
 * Editor action classes
 */
#define GETTEXT_DOMAIN "wesnoth-editor"
 
#include "editor/action/action.hpp"
 
#include "editor/map/map_context.hpp"
#include "gettext.hpp"
#include "random.hpp"
 
#include <memory>
 
namespace editor
{
int editor_action::next_id_ = 1;
int editor_action::instance_count_ = 0;
 
editor_action::editor_action()
    : id_(next_id_++)
{
    ++instance_count_;
 
#ifdef EDITOR_DEBUG_ACTION_LIFETIME
    LOG_ED << "Action " << std::setw(2) << id_ << " ctor " << this << " (count is " << instance_count;
#endif
}
 
editor_action::~editor_action()
{
    instance_count_--;
 
#ifdef EDITOR_DEBUG_ACTION_LIFETIME
    LOG_ED << "Action " << std::setw(2) << id_ << " dtor " << this << " (count is " << instance_count;
#endif
}
 
int editor_action::action_count() const
{
    return 1;
}
 
std::string editor_action::get_description() const
{
    return "Unknown action";
}
 
std::unique_ptr<editor_action> editor_action::perform(map_context& mc) const
{
    auto undo = std::make_unique<editor_action_whole_map>(mc.map());
    perform_without_undo(mc);
    return undo;
}
 
IMPLEMENT_ACTION(whole_map)
 
void editor_action_whole_map::perform_without_undo(map_context& mc) const
{
    mc.set_map(m_);
}
 
editor_action_chain::editor_action_chain(const editor::editor_action_chain& other)
    : editor_action()
    , actions_()
{
    for(const auto& a : other.actions_) {
        actions_.push_back(a->clone());
    }
}
 
editor_action_chain& editor_action_chain::operator=(const editor_action_chain& other)
{
    if(this == &other) {
        return *this;
    }
 
    actions_.clear();
 
    for(const auto& a : other.actions_) {
        actions_.push_back(a->clone());
    }
 
    return *this;
}
 
IMPLEMENT_ACTION(chain)
 
int editor_action_chain::action_count() const
{
    int count = 0;
    for(const auto& a : actions_) {
        if(a) {
            count += a->action_count();
        }
    }
 
    return count;
}
 
void editor_action_chain::append_action(std::unique_ptr<editor_action> a)
{
    actions_.push_back(std::move(a));
}
 
void editor_action_chain::prepend_action(std::unique_ptr<editor_action> a)
{
    actions_.push_front(std::move(a));
}
 
bool editor_action_chain::empty() const
{
    return actions_.empty();
}
 
std::unique_ptr<editor_action> editor_action_chain::pop_last_action()
{
    if(empty()) {
        throw editor_action_exception("pop_last_action requested on an empty action_chain");
    }
 
    auto last = std::move(actions_.back());
    actions_.pop_back();
    return last;
}
 
std::unique_ptr<editor_action> editor_action_chain::pop_first_action()
{
    if(empty()) {
        throw editor_action_exception("pop_first_action requested on an empty action_chain");
    }
 
    auto first = std::move(actions_.front());
    actions_.pop_front();
    return first;
}
 
std::unique_ptr<editor_action> editor_action_chain::perform(map_context& mc) const
{
    auto undo = std::make_unique<editor_action_chain>();
    for(auto& a : actions_) {
        if(a != nullptr) {
            undo->append_action(a->perform(mc));
        }
    }
 
    std::reverse(undo->actions_.begin(), undo->actions_.end());
    return undo;
}
void editor_action_chain::perform_without_undo(map_context& mc) const
{
    for(const auto& a : actions_) {
        if(a != nullptr) {
            a->perform_without_undo(mc);
        }
    }
}
 
void editor_action_area::extend(const editor_map& /*map*/, const std::set<map_location>& locs)
{
    area_.insert(locs.begin(), locs.end());
}
 
IMPLEMENT_ACTION(paste)
 
void editor_action_paste::extend(const editor_map& map, const std::set<map_location>& locs)
{
    paste_.add_tiles(map, locs);
}
 
std::unique_ptr<editor_action> editor_action_paste::perform(map_context& mc) const
{
    map_fragment mf(mc.map(), paste_.get_offset_area(offset_));
    auto undo = std::make_unique<editor_action_paste>(mf);
 
    perform_without_undo(mc);
    return undo;
}
 
void editor_action_paste::perform_without_undo(map_context& mc) const
{
    paste_.paste_into(mc.map(), offset_);
    mc.add_changed_location(paste_.get_offset_area(offset_));
    mc.set_needs_terrain_rebuild();
}
 
IMPLEMENT_ACTION(paint_area)
 
std::unique_ptr<editor_action> editor_action_paint_area::perform(map_context& mc) const
{
    map_fragment mf(mc.map(), area_);
    auto undo = std::make_unique<editor_action_paste>(mf);
 
    perform_without_undo(mc);
    return undo;
}
 
void editor_action_paint_area::perform_without_undo(map_context& mc) const
{
    mc.draw_terrain(t_, area_, one_layer_);
    mc.set_needs_terrain_rebuild();
}
 
IMPLEMENT_ACTION(fill)
 
std::unique_ptr<editor_action> editor_action_fill::perform(map_context& mc) const
{
    std::set<map_location> to_fill = mc.map().get_contiguous_terrain_tiles(loc_);
    auto undo = std::make_unique<editor_action_paint_area>(to_fill, mc.map().get_terrain(loc_));
 
    mc.draw_terrain(t_, to_fill, one_layer_);
    mc.set_needs_terrain_rebuild();
 
    return undo;
}
 
void editor_action_fill::perform_without_undo(map_context& mc) const
{
    std::set<map_location> to_fill = mc.map().get_contiguous_terrain_tiles(loc_);
    mc.draw_terrain(t_, to_fill, one_layer_);
    mc.set_needs_terrain_rebuild();
}
 
IMPLEMENT_ACTION(starting_position)
 
std::unique_ptr<editor_action> editor_action_starting_position::perform(map_context& mc) const
{
    std::unique_ptr<editor_action> undo;
 
    const std::string* old_loc_id = mc.map().is_special_location(loc_);
    map_location old_loc = mc.map().special_location(loc_id_);
 
    if(old_loc_id != nullptr) {
        // If another player was starting at the location, we actually perform two actions, so the undo is an
        // action_chain.
        auto undo_chain = std::make_unique<editor_action_chain>();
 
        undo_chain->append_action(std::make_unique<editor_action_starting_position>(loc_, *old_loc_id));
        undo_chain->append_action(std::make_unique<editor_action_starting_position>(old_loc, loc_id_));
 
        undo = std::move(undo_chain);
 
        LOG_ED << "ssp actual: " << *old_loc_id << " to " << map_location();
 
        mc.map().set_special_location(*old_loc_id, map_location());
    } else {
        undo = std::make_unique<editor_action_starting_position>(old_loc, loc_id_);
    }
 
    LOG_ED << "ssp actual: " << loc_id_ << " to " << loc_;
 
    mc.map().set_special_location(loc_id_, loc_);
    mc.set_needs_labels_reset();
 
    return undo;
}
 
void editor_action_starting_position::perform_without_undo(map_context& mc) const
{
    const std::string* old_id = mc.map().is_special_location(loc_);
    if(old_id != nullptr) {
        mc.map().set_special_location(*old_id, map_location());
    }
 
    mc.map().set_special_location(loc_id_, loc_);
    mc.set_needs_labels_reset();
}
 
IMPLEMENT_ACTION(resize_map)
 
void editor_action_resize_map::perform_without_undo(map_context& mc) const
{
    mc.map().resize(x_size_, y_size_, x_offset_, y_offset_, fill_);
    mc.set_needs_reload();
}
 
IMPLEMENT_ACTION(apply_mask)
 
void editor_action_apply_mask::perform_without_undo(map_context& mc) const
{
    mc.map().overlay(mask_, {0, 0, wml_loc()});
    mc.set_needs_terrain_rebuild();
}
 
IMPLEMENT_ACTION(create_mask)
 
void editor_action_create_mask::perform_without_undo(map_context& mc) const
{
    mc.set_map(editor_map(mc.map().mask_to(target_)));
    mc.set_needs_terrain_rebuild();
}
 
IMPLEMENT_ACTION(shuffle_area)
 
std::unique_ptr<editor_action> editor_action_shuffle_area::perform(map_context& mc) const
{
    map_fragment mf(mc.map(), area_);
    auto undo = std::make_unique<editor_action_paste>(mf);
    perform_without_undo(mc);
    return undo;
}
 
void editor_action_shuffle_area::perform_without_undo(map_context& mc) const
{
    std::vector<map_location> shuffle;
 
    std::copy(area_.begin(), area_.end(), std::inserter(shuffle, shuffle.begin()));
    std::shuffle(shuffle.begin(), shuffle.end(), randomness::rng::default_instance());
 
    std::vector<map_location>::const_iterator shuffle_it = shuffle.begin();
    std::set<map_location>::const_iterator orig_it = area_.begin();
 
    while(orig_it != area_.end()) {
        t_translation::terrain_code tmp = mc.map().get_terrain(*orig_it);
 
        mc.draw_terrain(mc.map().get_terrain(*shuffle_it), *orig_it);
        mc.draw_terrain(tmp, *shuffle_it);
 
        ++orig_it;
        ++shuffle_it;
    }
 
    mc.set_needs_terrain_rebuild();
}
 
IMPLEMENT_ACTION(time_area_move_all)
 
std::unique_ptr<editor_action> editor_action_time_area_move_all::perform(map_context& mc) const
{
    auto undo = std::make_unique<editor_action_time_area_move_all>(-x_offset_, -y_offset_);
    perform_without_undo(mc);
    return undo;
}
 
void editor_action_time_area_move_all::perform_without_undo(map_context& mc) const
{
    mc.get_time_manager()->move_all_areas(x_offset_, y_offset_);
}
 
} // end namespace editor