function_gamestate.cpp

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.
*/
 
#include "formula/function_gamestate.hpp"
#include "formula/callable_objects.hpp"
 
#include "actions/attack.hpp"
#include "filesystem.hpp"
#include "game_board.hpp"
#include "map/label.hpp"
#include "map/map.hpp"
#include "pathutils.hpp"
#include "play_controller.hpp"
#include "resources.hpp"
#include "tod_manager.hpp"
#include "units/types.hpp"
#include "units/unit.hpp"
 
#include "utils/optional_fwd.hpp"
#include <utility>
 
namespace wfl {
 
namespace gamestate {
 
namespace
{
/**
 * Extracts a terrain_code from the given variant.
 *
 * @param loc_var        Variant containing either terrain_callable or location_callable.
 *                       A plain terrain code string is also accepted.
 *
 * @returns              The given location's terrain_code for the given terrain, or nullopt
 *                       if an invalid variant was given.
 */
utils::optional<t_translation::terrain_code> as_terrain_code(const variant& loc_var)
{
    if(loc_var.is_string()) {
        return t_translation::read_terrain_code(loc_var.as_string());
    }
 
    else if(auto tc = callable_cast<terrain_callable*>(loc_var)) {
        return tc->get_terrain_type().number();
    }
 
    else if(auto loc = callable_cast<location_callable*>(loc_var)) {
        const gamemap& map = resources::gameboard->map();
        if(map.on_board(loc->loc())) {
            return map.get_terrain(loc->loc());
        }
    }
 
    return utils::nullopt;
}
 
/**
 * Gets arbitrary movement type info for a given terrain from either a unit or unit type.
 *
 * @param loc_var        Variant containing either terrain_callable or location_callable.
 *                       A plain terrain code string is also accepted.
 * @param unit_var       Variant containing either unit_callable or unit_type_callable.
 * @param getter         Functor of the signature `[](const terrain_code&, const auto&) -> variant`
 *                       If @a unit_var resolves to a unit_callable, the second argument will be a
 *                       const @ref unit reference. For unit_type_callable, the argument will be a
 *                       const @ref movetype reference for that unit type.
 */
template<typename F>
variant get_movement_property(const variant& loc_var, const variant& unit_var, const F& getter)
{
    const utils::optional terrain_code = as_terrain_code(loc_var);
    if(!terrain_code) {
        return variant();
    }
 
    if(auto u_call = callable_cast<unit_callable*>(unit_var)) {
        return std::invoke(getter, terrain_code.value(), u_call->get_unit());
    }
 
    if(auto u_type = callable_cast<unit_type_callable*>(unit_var)) {
        return std::invoke(getter, terrain_code.value(), u_type->get_unit_type().movement_type());
    }
 
    return variant();
}
 
} // namespace
 
DEFINE_WFL_FUNCTION(run_file, 1, 1)
{
    variant var = args()[0]->evaluate(variables, add_debug_info(fdb, 0, "run_file:file"));
 
    // NOTE: get_wml_location also filters file path to ensure it doesn't contain things like "../../top/secret"
    auto path = filesystem::get_wml_location(var.as_string());
    if(!path) {
        return variant();
    }
 
    std::string formula_string = filesystem::read_file(path.value());
    gamestate_function_symbol_table symbols;
 
    auto parsed_formula = formula::create_optional_formula(formula_string, &symbols);
    return formula::evaluate(parsed_formula, variables, add_debug_info(fdb, -1, "run_file:formula_from_file"));
}
 
DEFINE_WFL_FUNCTION(debug_label, 2, 2)
{
    variant var0 = args()[0]->evaluate(variables, fdb);
    variant var1 = args()[1]->evaluate(variables, fdb);
 
    if(game_config::debug) {
        const team& team = resources::controller->current_team();
        const map_location loc = callable_cast<location_callable&>(var0).loc();
        const std::string text = var1.is_string() ? var1.as_string() : var1.to_debug_string();
 
        display::get_singleton()->labels().set_label(
            loc, text, team.side(), team.team_name(), team::get_side_color(team.side()));
    }
 
    return variant(std::vector{var0, var1});
}
 
DEFINE_WFL_FUNCTION(adjacent_locs, 1, 1)
{
    const map_location loc = callable_cast<location_callable&>(args()[0]->evaluate(variables, add_debug_info(fdb, 0, "adjacent_locs:location"))).loc();
 
    std::vector<variant> v;
    for(const map_location& adj : get_adjacent_tiles(loc)) {
        if(resources::gameboard->map().on_board(adj)) {
            v.emplace_back(std::make_shared<location_callable>(adj));
        }
    }
 
    return variant(std::move(v));
}
 
DEFINE_WFL_FUNCTION(locations_in_radius, 2, 2)
{
    const map_location loc = callable_cast<location_callable&>(args()[0]->evaluate(variables, fdb)).loc();
 
    int range = args()[1]->evaluate(variables, fdb).as_int();
 
    if(range < 0) {
        return variant();
    }
 
    if(!range) {
        return make_callable<location_callable>(loc);
    }
 
    std::vector<map_location> res;
 
    get_tiles_in_radius(loc, range, res);
 
    std::vector<variant> v;
    v.reserve(res.size() + 1);
    v.emplace_back(std::make_shared<location_callable>(loc));
 
    for(std::size_t n = 0; n != res.size(); ++n) {
        if(resources::gameboard->map().on_board(res[n])) {
            v.emplace_back(std::make_shared<location_callable>(res[n]));
        }
    }
 
    return variant(std::move(v));
}
 
DEFINE_WFL_FUNCTION(get_unit_type, 1, 1)
{
    const std::string type = args()[0]->evaluate(variables, add_debug_info(fdb, 0, "get_unit_type:name")).as_string();
 
    const unit_type *ut = unit_types.find(type);
    if(ut) {
        return make_callable<unit_type_callable>(*ut);
    }
 
    return variant();
}
 
DEFINE_WFL_FUNCTION(unit_at, 1, 1)
{
    variant loc_var = args()[0]->evaluate(variables, add_debug_info(fdb, 0, "unit_at:location"));
    if(loc_var.is_null()) {
        return variant();
    }
    const auto& loc = callable_cast<location_callable&>(loc_var);
    const unit_map::const_iterator i = resources::gameboard->units().find(loc.loc());
    if(i != resources::gameboard->units().end()) {
        return make_callable<unit_callable>(*i);
    } else {
        return variant();
    }
}
 
DEFINE_WFL_FUNCTION(defense_on, 2, 2)
{
    variant u = args()[0]->evaluate(variables, add_debug_info(fdb, 0, "defense_on:unit"));
    variant loc_var = args()[1]->evaluate(variables, add_debug_info(fdb, 1, "defense_on:location"));
    if(u.is_null() || loc_var.is_null()) {
        return variant();
    }
 
    return get_movement_property(loc_var, u,
        [](const t_translation::terrain_code& terrain, const auto& datum) {
            return variant(100 - datum.defense_modifier(terrain));
        });
}
 
DEFINE_WFL_FUNCTION(chance_to_hit, 2, 2)
{
    variant u = args()[0]->evaluate(variables, add_debug_info(fdb, 0, "chance_to_hit:unit"));
    variant loc_var = args()[1]->evaluate(variables, add_debug_info(fdb, 1, "chance_to_hit:location"));
    if(u.is_null() || loc_var.is_null()) {
        return variant();
    }
 
    return get_movement_property(loc_var, u,
        [](const t_translation::terrain_code& terrain, const auto& datum) {
            return variant(datum.defense_modifier(terrain));
        });
}
 
DEFINE_WFL_FUNCTION(movement_cost, 2, 2)
{
    variant u = args()[0]->evaluate(variables, add_debug_info(fdb, 0, "movement_cost:unit"));
    variant loc_var = args()[1]->evaluate(variables, add_debug_info(fdb, 0, "movement_cost:location"));
    if(u.is_null() || loc_var.is_null()) {
        return variant();
    }
 
    return get_movement_property(loc_var, u,
        [](const t_translation::terrain_code& terrain, const auto& datum) {
            return variant(datum.movement_cost(terrain));
        });
}
 
DEFINE_WFL_FUNCTION(vision_cost, 2, 2)
{
    variant u = args()[0]->evaluate(variables, add_debug_info(fdb, 0, "vision_cost:unit"));
    variant loc_var = args()[1]->evaluate(variables, add_debug_info(fdb, 0, "vision_cost:location"));
    if(u.is_null() || loc_var.is_null()) {
        return variant();
    }
 
    return get_movement_property(loc_var, u,
        [](const t_translation::terrain_code& terrain, const auto& datum) {
            return variant(datum.vision_cost(terrain));
        });
}
 
DEFINE_WFL_FUNCTION(jamming_cost, 2, 2)
{
    variant u = args()[0]->evaluate(variables, add_debug_info(fdb, 0, "jamming_cost:unit"));
    variant loc_var = args()[1]->evaluate(variables, add_debug_info(fdb, 0, "jamming_cost:location"));
    if(u.is_null() || loc_var.is_null()) {
        return variant();
    }
 
    return get_movement_property(loc_var, u,
        [](const t_translation::terrain_code& terrain, const auto& datum) {
            return variant(datum.jamming_cost(terrain));
        });
}
 
DEFINE_WFL_FUNCTION(enemy_of, 2, 2)
{
    variant self_v = args()[0]->evaluate(variables, add_debug_info(fdb, 0, "enemy_of:self"));
    variant other_v = args()[1]->evaluate(variables, add_debug_info(fdb, 1, "enemy_of:other"));
    int self, other;
 
    if(auto uc = callable_cast<unit_callable*>(self_v)) {
        self = uc->get_value("side_number").as_int();
    } else if(auto tc = callable_cast<team_callable*>(self_v)) {
        self = tc->get_value("side_number").as_int();
    } else {
        self = self_v.as_int();
    }
 
    if(auto uc = callable_cast<unit_callable*>(other_v)) {
        other = uc->get_value("side_number").as_int();
    } else if(auto tc = callable_cast<team_callable*>(other_v)) {
        other = tc->get_value("side_number").as_int();
    } else {
        other = other_v.as_int();
    }
 
    int num_teams = resources::gameboard->teams().size();
    if(self < 1 || self > num_teams || other < 1 || other > num_teams) {
        return variant(0);
    }
    return variant(resources::gameboard->get_team(self).is_enemy(other) ? 1 : 0);
}
 
DEFINE_WFL_FUNCTION(resistance_on, 3, 4)
{
    variant u = args()[0]->evaluate(variables, add_debug_info(fdb, 0, "resistance_on:unit"));
    variant loc_var = args()[1]->evaluate(variables, add_debug_info(fdb, 1, "resistance_on:location"));
    if(u.is_null() || loc_var.is_null()) {
        return variant();
    }
    std::string type = args()[2]->evaluate(variables, add_debug_info(fdb, 2, "resistance_on:type")).as_string();
    bool attacker = args().size() > 3 ? args()[3]->evaluate(variables, add_debug_info(fdb, 3, "resistance_on:attacker")).as_bool() : false;
    const map_location& loc = callable_cast<location_callable&>(loc_var).loc();
 
    if(auto u_call = callable_cast<unit_callable*>(u)) {
        const unit& un = u_call->get_unit();
 
        return variant(100 - un.resistance_against(type, attacker, loc));
    }
 
    return variant();
}
 
DEFINE_WFL_FUNCTION(tod_bonus, 0, 2)
{
    map_location loc;
    int turn = resources::controller->turn();
    if(args().size() > 0) {
        variant loc_arg = args()[0]->evaluate(variables, add_debug_info(fdb, 0, "tod_bonus:loc"));
        if(auto p = callable_cast<location_callable*>(loc_arg)) {
            loc = p->loc();
        } else return variant();
 
        if(args().size() > 1) {
            variant turn_arg = args()[1]->evaluate(variables, add_debug_info(fdb, 0, "tod_bonus:turn"));
            if(turn_arg.is_int()) {
                turn = turn_arg.as_int();
            } else if(!turn_arg.is_null()) {
                return variant();
            }
        }
    }
    int bonus = resources::tod_manager->get_illuminated_time_of_day(resources::gameboard->units(), resources::gameboard->map(), loc, turn).lawful_bonus;
    return variant(bonus);
}
 
DEFINE_WFL_FUNCTION(base_tod_bonus, 0, 2)
{
    map_location loc;
    int turn = resources::controller->turn();
    if(args().size() > 0) {
        variant loc_arg = args()[0]->evaluate(variables, add_debug_info(fdb, 0, "tod_bonus:loc"));
        if(auto p = callable_cast<location_callable*>(loc_arg)) {
            loc = p->loc();
        } else return variant();
 
        if(args().size() > 1) {
            variant turn_arg = args()[1]->evaluate(variables, add_debug_info(fdb, 0, "tod_bonus:turn"));
            if(turn_arg.is_int()) {
                turn = turn_arg.as_int();
            } else if(!turn_arg.is_null()) {
                return variant();
            }
        }
    }
    int bonus = resources::tod_manager->get_time_of_day(loc, turn).lawful_bonus;
    return variant(bonus);
}
 
DEFINE_WFL_FUNCTION(unit_tod_modifier, 1, 2)
{
    const unit& unit = callable_cast<unit_callable&>(
        args()[0]->evaluate(variables, add_debug_info(fdb, 0, "unit_tod_modifier:unit"))).get_unit();
 
    const map_location loc = args().size() == 2
        ? callable_cast<location_callable&>(
            args()[1]->evaluate(variables, add_debug_info(fdb, 1, "unit_tod_modifier:location"))).loc()
        : unit.get_location();
 
    return variant(combat_modifier(
        resources::gameboard->units(), resources::gameboard->map(), loc, unit.alignment(), unit.is_fearless()));
}
 
DEFINE_WFL_FUNCTION(is_shrouded, 2, 2)
{
    variant var0 = args()[0]->evaluate(variables, fdb);
    variant var1 = args()[1]->evaluate(variables, fdb);
 
    try {
        const map_location loc = callable_cast<location_callable&>(var0).loc();
        return variant(resources::gameboard->get_team(var1.as_int()).shrouded(loc));
 
    } catch(const std::out_of_range&) {
        return variant();
    }
}
 
DEFINE_WFL_FUNCTION(is_fogged, 2, 2)
{
    variant var0 = args()[0]->evaluate(variables, fdb);
    variant var1 = args()[1]->evaluate(variables, fdb);
 
    try {
        const map_location loc = callable_cast<location_callable&>(var0).loc();
        return variant(resources::gameboard->get_team(var1.as_int()).fogged(loc));
 
    } catch(const std::out_of_range&) {
        return variant();
    }
}
 
} // namespace gamestate
 
gamestate_function_symbol_table::gamestate_function_symbol_table(const std::shared_ptr<function_symbol_table>& parent) : function_symbol_table(parent) {
    using namespace gamestate;
    function_symbol_table& functions_table = *this;
    DECLARE_WFL_FUNCTION(run_file);
    DECLARE_WFL_FUNCTION(debug_label);
    DECLARE_WFL_FUNCTION(get_unit_type);
    DECLARE_WFL_FUNCTION(unit_at);
    DECLARE_WFL_FUNCTION(resistance_on);
    DECLARE_WFL_FUNCTION(defense_on);
    DECLARE_WFL_FUNCTION(chance_to_hit);
    DECLARE_WFL_FUNCTION(movement_cost);
    DECLARE_WFL_FUNCTION(vision_cost);
    DECLARE_WFL_FUNCTION(jamming_cost);
    DECLARE_WFL_FUNCTION(adjacent_locs); // This is deliberately duplicated here; this form excludes off-map locations, while the core form does not
    DECLARE_WFL_FUNCTION(locations_in_radius);
    DECLARE_WFL_FUNCTION(enemy_of);
    DECLARE_WFL_FUNCTION(tod_bonus);
    DECLARE_WFL_FUNCTION(base_tod_bonus);
    DECLARE_WFL_FUNCTION(unit_tod_modifier);
    DECLARE_WFL_FUNCTION(is_shrouded);
    DECLARE_WFL_FUNCTION(is_fogged);
}
 
} // namespace wfl