terrain.cpp

Go to the documentation of this file.

/*
    Copyright (C) 2003 - 2022
    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.
*/

#include "deprecation.hpp"
#include "game_version.hpp"
#include "gettext.hpp"
#include "log.hpp"
#include "serialization/string_utils.hpp"
#include "terrain/terrain.hpp"

#include <set>

static lg::log_domain log_config("config");
#define ERR_G LOG_STREAM(err, lg::general())
#define WRN_G LOG_STREAM(warn, lg::general())
#define LOG_G LOG_STREAM(info, lg::general())
#define DBG_G LOG_STREAM(debug, lg::general())

/**
 * Insert second vector into first when the terrain _ref^base is encountered
 */
void merge_alias_lists(t_translation::ter_list& first, const t_translation::ter_list& second);

terrain_type::terrain_type() :
        minimap_image_(),
        minimap_image_overlay_(),
        editor_image_(),
        id_(),
        name_(),
        editor_name_(),
        description_(),
        help_topic_text_(),
        number_(t_translation::VOID_TERRAIN),
        mvt_type_(1, t_translation::VOID_TERRAIN),
        vision_type_(1, t_translation::VOID_TERRAIN),
        def_type_(1, t_translation::VOID_TERRAIN),
        union_type_(1, t_translation::VOID_TERRAIN),
        height_adjust_(0),
        height_adjust_set_(false),
        submerge_(0.0),
        submerge_set_(false),
        light_modification_(0),
        max_light_(0),
        min_light_(0),
        heals_(0),
        income_description_(),
        income_description_ally_(),
        income_description_enemy_(),
        income_description_own_(),
        editor_group_(),
        village_(false),
        castle_(false),
        keep_(false),
        overlay_(false),
        combined_(false),
        editor_default_base_(t_translation::VOID_TERRAIN),
        hide_help_(false),
        hide_in_editor_(false),
        hide_if_impassable_(false)
{}

terrain_type::terrain_type(const config& cfg) :
        icon_image_(cfg["icon_image"]),
        minimap_image_(cfg["symbol_image"]),
        minimap_image_overlay_(),
        editor_image_(cfg["editor_image"].empty() ? "terrain/" + minimap_image_ + ".png" : "terrain/" + cfg["editor_image"].str() + ".png"),
        id_(cfg["id"]),
        name_(cfg["name"].t_str()),
        editor_name_(cfg["editor_name"].t_str()),
        description_(cfg["description"].t_str()),
        help_topic_text_(cfg["help_topic_text"].t_str()),
        number_(t_translation::read_terrain_code(cfg["string"].str())),
        mvt_type_(),
        vision_type_(),
        def_type_(),
        union_type_(),
        height_adjust_(cfg["unit_height_adjust"]),
        height_adjust_set_(!cfg["unit_height_adjust"].empty()),
        submerge_(cfg["submerge"].to_double()),
        submerge_set_(!cfg["submerge"].empty()),
        light_modification_(cfg["light"]),
        max_light_(cfg["max_light"].to_int(light_modification_)),
        min_light_(cfg["min_light"].to_int(light_modification_)),
        heals_(cfg["heals"]),
        income_description_(),
        income_description_ally_(),
        income_description_enemy_(),
        income_description_own_(),
        editor_group_(cfg["editor_group"]),
        village_(cfg["gives_income"].to_bool()),
        castle_(cfg["recruit_onto"].to_bool()),
        keep_(cfg["recruit_from"].to_bool()),
        overlay_(number_.base == t_translation::NO_LAYER),
        combined_(false),
        editor_default_base_(t_translation::read_terrain_code(cfg["default_base"].str())),
        hide_help_(cfg["hide_help"].to_bool(false)),
        hide_in_editor_(cfg["hidden"].to_bool(false)),
        hide_if_impassable_(cfg["hide_if_impassable"].to_bool(false))
{
/**
 *  @todo reenable these validations. The problem is that all MP
 *  scenarios/campaigns share the same namespace and one rogue scenario
 *  can avoid the player to create a MP game. So every scenario/campaign
 *  should get its own namespace to be safe.
 */
#if 0
    VALIDATE(number_ != t_translation::NONE_TERRAIN,
        missing_mandatory_wml_key("terrain_type", "string"));
    VALIDATE(!minimap_image_.empty(),
        missing_mandatory_wml_key("terrain_type", "symbol_image", "string",
        t_translation::write_terrain_code(number_)));
    VALIDATE(!name_.empty(),
        missing_mandatory_wml_key("terrain_type", "name", "string",
        t_translation::write_terrain_code(number_)));
#endif

    if(editor_image_.empty()) {
        editor_image_ = "terrain/" + minimap_image_ + ".png";
    }

    if(hide_in_editor_) {
        editor_image_ = "";
    }

    mvt_type_.push_back(number_);
    def_type_.push_back(number_);
    vision_type_.push_back(number_);

    const t_translation::ter_list& alias = t_translation::read_list(cfg["aliasof"].str());
    if(!alias.empty()) {
        mvt_type_ = alias;
        vision_type_ = alias;
        def_type_ = alias;
    }

    const t_translation::ter_list& mvt_alias = t_translation::read_list(cfg["mvt_alias"].str());
    if(!mvt_alias.empty()) {
        mvt_type_ = mvt_alias;
    }

    const t_translation::ter_list& def_alias = t_translation::read_list(cfg["def_alias"].str());
    if(!def_alias.empty()) {
        def_type_ = def_alias;
    }

    const t_translation::ter_list& vision_alias = t_translation::read_list(cfg["vision_alias"].str());
    if(!vision_alias.empty()) {
        // Vision costs are calculated in movetype.cpp, but they're calculated based on gamemap::underlying_mvt_terrain().
        // Having vision costs that are different to movement costs is still supported, but having separate aliases seems
        // an edge case that shouldn't be introduced until we're ready to test it.
        deprecated_message("vision_alias", DEP_LEVEL::REMOVED, {1, 15, 2}, "vision_alias was never completely implemented, vision is calculated using mvt_alias instead");
        vision_type_ = vision_alias;
    }

    union_type_ = mvt_type_;
    union_type_.insert( union_type_.end(), def_type_.begin(), def_type_.end() );
    union_type_.insert( union_type_.end(), vision_type_.begin(), vision_type_.end() );

    // remove + and -
    union_type_.erase(std::remove(union_type_.begin(), union_type_.end(),
                t_translation::MINUS), union_type_.end());

    union_type_.erase(std::remove(union_type_.begin(), union_type_.end(),
                t_translation::PLUS), union_type_.end());

    // remove doubles
    std::sort(union_type_.begin(),union_type_.end());
    union_type_.erase(std::unique(union_type_.begin(), union_type_.end()), union_type_.end());



    //mouse over message are only shown on villages
    if(village_) {
        income_description_ = cfg["income_description"];
        if(income_description_.empty()) {
            income_description_ = _("Village");
        }

        income_description_ally_ = cfg["income_description_ally"];
        if(income_description_ally_.empty()) {
            income_description_ally_ = _("Allied village");
        }

        income_description_enemy_ = cfg["income_description_enemy"];
        if(income_description_enemy_.empty()) {
            income_description_enemy_ = _("Enemy village");
        }

        income_description_own_ = cfg["income_description_own"];
        if(income_description_own_.empty()) {
            income_description_own_ = _("Owned village");
        }
    }
}

terrain_type::terrain_type(const terrain_type& base, const terrain_type& overlay) :
    icon_image_(),
    minimap_image_(base.minimap_image_),
    minimap_image_overlay_(overlay.minimap_image_),
    editor_image_(base.editor_image_ + "~BLIT(" + overlay.editor_image_ +")"),
    id_(base.id_+"^"+overlay.id_),
    name_(overlay.name_),
    editor_name_((base.editor_name_.empty() ? base.name_ : base.editor_name_) + " / " + (overlay.editor_name_.empty() ? overlay.name_ : overlay.editor_name_)),
    description_(overlay.description()),
    help_topic_text_(),
    number_(t_translation::terrain_code(base.number_.base, overlay.number_.overlay)),
    mvt_type_(overlay.mvt_type_),
    vision_type_(overlay.vision_type_),
    def_type_(overlay.def_type_),
    union_type_(),
    height_adjust_(base.height_adjust_),
    height_adjust_set_(base.height_adjust_set_),
    submerge_(base.submerge_),
    submerge_set_(base.submerge_set_),
    light_modification_(base.light_modification_ + overlay.light_modification_),
    max_light_(std::max(base.max_light_, overlay.max_light_)),
    min_light_(std::min(base.min_light_, overlay.min_light_)),
    heals_(std::max<int>(base.heals_, overlay.heals_)),
    income_description_(),
    income_description_ally_(),
    income_description_enemy_(),
    income_description_own_(),
    editor_group_(),
    village_(base.village_ || overlay.village_),
    castle_(base.castle_ || overlay.castle_),
    keep_(base.keep_ || overlay.keep_),
    overlay_(false),
    combined_(true),
    editor_default_base_(),
    hide_help_(true),
    hide_in_editor_(base.hide_in_editor_ || overlay.hide_in_editor_),
    hide_if_impassable_(base.hide_if_impassable_ || overlay.hide_if_impassable_)
{
    if(description_.empty()) {
        description_ = base.description();
    }

    if(overlay.height_adjust_set_) {
        height_adjust_set_ = true;
        height_adjust_ = overlay.height_adjust_;
    }

    if(overlay.submerge_set_) {
        submerge_set_ = true;
        submerge_ = overlay.submerge_;
    }

    merge_alias_lists(mvt_type_, base.mvt_type_);
    merge_alias_lists(def_type_, base.def_type_);
    merge_alias_lists(vision_type_, base.vision_type_);

    union_type_ = mvt_type_;
    union_type_.insert( union_type_.end(), def_type_.begin(), def_type_.end() );
    union_type_.insert( union_type_.end(), vision_type_.begin(), vision_type_.end() );

    // remove + and -
    union_type_.erase(std::remove(union_type_.begin(), union_type_.end(),
                t_translation::MINUS), union_type_.end());

    union_type_.erase(std::remove(union_type_.begin(), union_type_.end(),
                t_translation::PLUS), union_type_.end());

    // remove doubles
    std::sort(union_type_.begin(),union_type_.end());
    union_type_.erase(std::unique(union_type_.begin(), union_type_.end()), union_type_.end());



    //mouse over message are only shown on villages
    if(base.village_) {
        income_description_ = base.income_description_;
        income_description_ally_ = base.income_description_ally_;
        income_description_enemy_ = base.income_description_enemy_;
        income_description_own_ = base.income_description_own_;
    }
    else if (overlay.village_) {
        income_description_ = overlay.income_description_;
        income_description_ally_ = overlay.income_description_ally_;
        income_description_enemy_ = overlay.income_description_enemy_;
        income_description_own_ = overlay.income_description_own_;
    }

}

t_translation::terrain_code terrain_type::terrain_with_default_base() const {
    if(overlay_ && editor_default_base_ != t_translation::NONE_TERRAIN) {
        return t_translation::terrain_code(editor_default_base_.base, number_.overlay);
    }
    return number_;
}

bool terrain_type::operator==(const terrain_type& other) const {
    return minimap_image_         == other.minimap_image_
        && minimap_image_overlay_ == other.minimap_image_overlay_
        && editor_image_          == other.editor_image_
        && id_                    == other.id_
        && name_.base_str()       == other.name_.base_str()
        && editor_name_.base_str() == other.editor_name_.base_str()
        && number_                == other.number_
        && mvt_type_              == other.mvt_type_
        && vision_type_           == other.vision_type_
        && def_type_              == other.def_type_
        && union_type_            == other.union_type_
        && height_adjust_         == other.height_adjust_
        && height_adjust_set_     == other.height_adjust_set_
        && submerge_              == other.submerge_
        && submerge_set_          == other.submerge_set_
        && light_modification_    == other.light_modification_
        && max_light_             == other.max_light_
        && min_light_             == other.min_light_
        && heals_                 == other.heals_
        && village_               == other.village_
        && castle_                == other.castle_
        && keep_                  == other.keep_
        && combined_              == other.combined_
        && overlay_               == other.overlay_
        && editor_default_base_   == other.editor_default_base_
        && hide_in_editor_        == other.hide_in_editor_
        && hide_help_             == other.hide_help_;
}

void merge_alias_lists(t_translation::ter_list& first, const t_translation::ter_list& second)
{
    // Insert second vector into first when the terrain _ref^base is encountered

    bool revert = (first.front() == t_translation::MINUS ? true : false);
    t_translation::ter_list::iterator i;

    for(i = first.begin(); i != first.end(); ++i) {
        if(*i == t_translation::PLUS) {
            revert = false;
            continue;
        } else if(*i == t_translation::MINUS) {
            revert = true;
            continue;
        }

        // This only works for a subset of the possible cases, and doesn't work for
        // worst(best(a,b),c,d) terrain. Part of the reason that it doesn't work is that
        // movetype.cpp starts with a default value of either UNREACHABLE or zero, which
        // when inverted would drown out the values in best(a,b). Another part of the reason
        // is that the insertion of a plus or minus before the base terrain is commented out
        // in this function.

        if(*i == t_translation::BASE) {
            t_translation::ter_list::iterator insert_it = first.erase(i);
            //if we are in reverse mode, insert PLUS before and MINUS after the base list
            //so calculation of base aliases will work normal
            if(revert) {
//              insert_it = first.insert(insert_it, t_translation::PLUS);
//              insert_it++;
                insert_it = first.insert(insert_it, t_translation::MINUS);
            }
            else {
                //else insert PLUS after the base aliases to restore previous "reverse state"
                insert_it =  first.insert(insert_it, t_translation::PLUS);
            }

            first.insert(insert_it, second.begin(), second.end());

            break;
        }
    }

}