aspect_attacks.cpp

Go to the documentation of this file.

/*
    Copyright (C) 2009 - 2022
    by Yurii Chernyi <terraninfo@terraninfo.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.
*/

/**
 * Stage: fallback to other AI
 * @file
 */

#include "ai/default/aspect_attacks.hpp"

#include "actions/attack.hpp"
#include "ai/manager.hpp"
#include "game_board.hpp"
#include "log.hpp"
#include "lua/lauxlib.h"
#include "map/map.hpp"
#include "pathfind/pathfind.hpp"
#include "resources.hpp"
#include "scripting/lua_unit.hpp"
#include "team.hpp"
#include "tod_manager.hpp"
#include "units/filter.hpp"
#include "units/unit.hpp"

namespace ai
{
namespace ai_default_rca
{
static lg::log_domain log_ai_testing_aspect_attacks("ai/aspect/attacks");
#define DBG_AI LOG_STREAM(debug, log_ai_testing_aspect_attacks)
#define LOG_AI LOG_STREAM(info, log_ai_testing_aspect_attacks)
#define ERR_AI LOG_STREAM(err, log_ai_testing_aspect_attacks)

aspect_attacks_base::aspect_attacks_base(readonly_context& context, const config& cfg, const std::string& id)
    : typesafe_aspect<attacks_vector>(context, cfg, id)
{
}

aspect_attacks::aspect_attacks(readonly_context& context, const config& cfg, const std::string& id)
    : aspect_attacks_base(context, cfg, id)
    , filter_own_()
    , filter_enemy_()
{
    if(const config& filter_own = cfg.child("filter_own")) {
        vconfig vcfg(filter_own);
        vcfg.make_safe();
        filter_own_.reset(new unit_filter(vcfg));
    }

    if(const config& filter_enemy = cfg.child("filter_enemy")) {
        vconfig vcfg(filter_enemy);
        vcfg.make_safe();
        filter_enemy_.reset(new unit_filter(vcfg));
    }
}

void aspect_attacks_base::recalculate() const
{
    this->value_ = analyze_targets();
    this->valid_ = true;
}

std::shared_ptr<attacks_vector> aspect_attacks_base::analyze_targets() const
{
    const move_map& srcdst = get_srcdst();
    const move_map& dstsrc = get_dstsrc();
    const move_map& enemy_srcdst = get_enemy_srcdst();
    const move_map& enemy_dstsrc = get_enemy_dstsrc();

    auto res = std::make_shared<attacks_vector>();
    const unit_map& units_ = resources::gameboard->units();

    std::vector<map_location> unit_locs;
    for(const unit& u : units_) {
        if(u.side() == get_side() && u.attacks_left() && !(u.can_recruit() && is_passive_leader(u.id()))) {
            if(!is_allowed_attacker(u)) {
                continue;
            }

            unit_locs.push_back(u.get_location());
        }
    }

    std::array<bool, 6> used_locations;
    used_locations.fill(false);

    moves_map dummy_moves;
    move_map fullmove_srcdst, fullmove_dstsrc;
    calculate_possible_moves(dummy_moves, fullmove_srcdst, fullmove_dstsrc, false, true);

    unit_stats_cache().clear();

    for(const unit& u : units_) {
        // Attack anyone who is on the enemy side,
        // and who is not invisible or petrified.
        if(current_team().is_enemy(u.side()) && !u.incapacitated() && !u.invisible(u.get_location())) {
            if(!is_allowed_enemy(u)) {
                continue;
            }

            const auto adjacent = get_adjacent_tiles(u.get_location());
            attack_analysis analysis;
            analysis.target = u.get_location();
            analysis.vulnerability = 0.0;
            analysis.support = 0.0;

            do_attack_analysis(u.get_location(), srcdst, dstsrc, fullmove_srcdst, fullmove_dstsrc, enemy_srcdst,
                enemy_dstsrc, adjacent, used_locations, unit_locs, *res, analysis, current_team());
        }
    }
    return res;
}

void aspect_attacks_base::do_attack_analysis(const map_location& loc,
    const move_map& srcdst,
    const move_map& dstsrc,
    const move_map& fullmove_srcdst,
    const move_map& fullmove_dstsrc,
    const move_map& enemy_srcdst,
    const move_map& enemy_dstsrc,
    const std::array<map_location, 6>& tiles,
    std::array<bool, 6>& used_locations,
    std::vector<map_location>& units,
    std::vector<attack_analysis>& result,
    attack_analysis& cur_analysis,
    const team& current_team) const
{
    // This function is called fairly frequently, so interact with the user here.

    ai::manager::get_singleton().raise_user_interact();
    const int max_attack_depth = 5;
    if(cur_analysis.movements.size() >= std::size_t(max_attack_depth)) {
        return;
    }

    const gamemap& map_ = resources::gameboard->map();
    unit_map& units_ = resources::gameboard->units();
    const std::vector<team>& teams_ = resources::gameboard->teams();

    const std::size_t max_positions = 1000;
    if(result.size() > max_positions && !cur_analysis.movements.empty()) {
        LOG_AI << "cut analysis short with number of positions";
        return;
    }

    for(std::size_t i = 0; i != units.size(); ++i) {
        const map_location current_unit = units[i];

        unit_map::iterator unit_itor = units_.find(current_unit);
        assert(unit_itor != units_.end());

        // See if the unit has the backstab ability.
        // Units with backstab will want to try to have a
        // friendly unit opposite the position they move to.
        //
        // See if the unit has the slow ability -- units with slow only attack first.
        bool backstab = false, slow = false;
        for(const attack_type& a : unit_itor->attacks()) {
            // For speed, just assume these specials will be active if they are present.
            if(a.has_special("backstab", true)) {
                backstab = true;
            }

            if(a.has_special("slow", true)) {
                slow = true;
            }
        }

        if(slow && cur_analysis.movements.empty() == false) {
            continue;
        }

        // Check if the friendly unit is surrounded,
        // A unit is surrounded if it is flanked by enemy units
        // and at least one other enemy unit is nearby
        // or if the unit is totally surrounded by enemies
        // with max. one tile to escape.
        bool is_surrounded = false;
        bool is_flanked = false;
        int enemy_units_around = 0;
        int accessible_tiles = 0;
        const auto adj = get_adjacent_tiles(current_unit);

        for(std::size_t tile = 0; tile != 3; ++tile) {
            const unit_map::const_iterator tmp_unit = units_.find(adj[tile]);
            bool possible_flanked = false;

            if(map_.on_board(adj[tile])) {
                ++accessible_tiles;
                if(tmp_unit != units_.end() && current_team.is_enemy(tmp_unit->side())) {
                    ++enemy_units_around;
                    possible_flanked = true;
                }
            }

            const unit_map::const_iterator tmp_opposite_unit = units_.find(adj[tile + 3]);
            if(map_.on_board(adj[tile + 3])) {
                ++accessible_tiles;
                if(tmp_opposite_unit != units_.end() && current_team.is_enemy(tmp_opposite_unit->side())) {
                    ++enemy_units_around;
                    if(possible_flanked) {
                        is_flanked = true;
                    }
                }
            }
        }

        if((is_flanked && enemy_units_around > 2) || enemy_units_around >= accessible_tiles - 1) {
            is_surrounded = true;
        }

        double best_vulnerability = 0.0, best_support = 0.0;
        int best_rating = 0;
        int cur_position = -1;

        // Iterate over positions adjacent to the unit, finding the best rated one.
        for(unsigned j = 0; j < tiles.size(); ++j) {
            // If in this planned attack, a unit is already in this location.
            if(used_locations[j]) {
                continue;
            }

            // See if the current unit can reach that position.
            if(tiles[j] != current_unit) {
                auto its = dstsrc.equal_range(tiles[j]);
                while(its.first != its.second) {
                    if(its.first->second == current_unit) {
                        break;
                    }

                    ++its.first;
                }

                // If the unit can't move to this location.
                if(its.first == its.second || units_.find(tiles[j]) != units_.end()) {
                    continue;
                }
            }

            int best_leadership_bonus = under_leadership(*unit_itor, tiles[j]);
            double leadership_bonus = static_cast<double>(best_leadership_bonus + 100) / 100.0;
            if(leadership_bonus > 1.1) {
                LOG_AI << unit_itor->name() << " is getting leadership " << leadership_bonus;
            }

            // Check to see whether this move would be a backstab.
            int backstab_bonus = 1;
            double surround_bonus = 1.0;

            if(tiles[(j + 3) % 6] != current_unit) {
                const unit_map::const_iterator itor = units_.find(tiles[(j + 3) % 6]);

                // Note that we *could* also check if a unit plans to move there
                // before we're at this stage, but we don't because, since the
                // attack calculations don't actually take backstab into account (too complicated),
                // this could actually make our analysis look *worse* instead of better.
                // So we only check for 'concrete' backstab opportunities.
                // That would also break backstab_check, since it assumes
                // the defender is in place.
                if(itor != units_.end() && backstab_check(tiles[j], loc, units_, teams_)) {
                    if(backstab) {
                        backstab_bonus = 2;
                    }

                    // No surround bonus if target is skirmisher
                    if(!itor->get_ability_bool("skirmisher")) {
                        surround_bonus = 1.2;
                    }
                }
            }

            // See if this position is the best rated we've seen so far.
            int rating = static_cast<int>(rate_terrain(*unit_itor, tiles[j]) * backstab_bonus * leadership_bonus);
            if(cur_position >= 0 && rating < best_rating) {
                continue;
            }

            // Find out how vulnerable we are to attack from enemy units in this hex.
            // FIXME: suokko's r29531 multiplied this by a constant 1.5. ?
            const double vulnerability = power_projection(tiles[j], enemy_dstsrc); //?

            // Calculate how much support we have on this hex from allies.
            const double support = power_projection(tiles[j], fullmove_dstsrc); //?

            // If this is a position with equal defense to another position,
            // but more vulnerability then we don't want to use it.
            if(cur_position >= 0 && rating == best_rating
                && vulnerability / surround_bonus - support * surround_bonus >= best_vulnerability - best_support) {
                continue;
            }

            cur_position = j;
            best_rating = rating;
            best_vulnerability = vulnerability / surround_bonus;
            best_support = support * surround_bonus;
        }

        if(cur_position != -1) {
            units.erase(units.begin() + i);

            cur_analysis.movements.emplace_back(current_unit, tiles[cur_position]);
            cur_analysis.vulnerability += best_vulnerability;
            cur_analysis.support += best_support;
            cur_analysis.is_surrounded = is_surrounded;
            cur_analysis.analyze(map_, units_, *this, dstsrc, srcdst, enemy_dstsrc, get_aggression());
            result.push_back(cur_analysis);

            used_locations[cur_position] = true;

            do_attack_analysis(loc, srcdst, dstsrc, fullmove_srcdst, fullmove_dstsrc, enemy_srcdst, enemy_dstsrc, tiles,
                used_locations, units, result, cur_analysis, current_team);

            used_locations[cur_position] = false;

            cur_analysis.vulnerability -= best_vulnerability;
            cur_analysis.support -= best_support;
            cur_analysis.movements.pop_back();

            units.insert(units.begin() + i, current_unit);
        }
    }
}

int aspect_attacks_base::rate_terrain(const unit& u, const map_location& loc)
{
    const gamemap& map_ = resources::gameboard->map();
    const t_translation::terrain_code terrain = map_.get_terrain(loc);
    const int defense = u.defense_modifier(terrain);
    int rating = 100 - defense;

    const int healing_value = 10;
    const int friendly_village_value = 5;
    const int neutral_village_value = 10;
    const int enemy_village_value = 15;

    if(map_.gives_healing(terrain) && u.get_ability_bool("regenerate", loc) == false) {
        rating += healing_value;
    }

    if(map_.is_village(terrain)) {
        int owner = resources::gameboard->village_owner(loc);

        if(owner == u.side()) {
            rating += friendly_village_value;
        } else if(owner == 0) {
            rating += neutral_village_value;
        } else {
            rating += enemy_village_value;
        }
    }

    return rating;
}

config aspect_attacks::to_config() const
{
    config cfg = typesafe_aspect<attacks_vector>::to_config();
    if(filter_own_ && !filter_own_->empty()) {
        cfg.add_child("filter_own", filter_own_->to_config());
    }

    if(filter_enemy_ && !filter_enemy_->empty()) {
        cfg.add_child("filter_enemy", filter_enemy_->to_config());
    }

    return cfg;
}

bool aspect_attacks::is_allowed_attacker(const unit& u) const
{
    if(u.side() != get_side()) {
        return false;
    }

    if(filter_own_) {
        return (*filter_own_)(u);
    }

    return true;
}

bool aspect_attacks::is_allowed_enemy(const unit& u) const
{
    const team& my_team = resources::gameboard->get_team(get_side());
    if(!my_team.is_enemy(u.side())) {
        return false;
    }

    if(filter_enemy_) {
        return (*filter_enemy_)(u);
    }

    return true;
}

} // namespace ai_default_rca

aspect_attacks_lua::aspect_attacks_lua(
    readonly_context& context, const config& cfg, const std::string& id, std::shared_ptr<lua_ai_context>& l_ctx)
    : aspect_attacks_base(context, cfg, id)
    , handler_()
    , code_()
    , params_(cfg.child_or_empty("args"))
{
    this->name_ = "lua_aspect";
    if(cfg.has_attribute("code")) {
        code_ = cfg["code"].str();
    } else if(cfg.has_attribute("value")) {
        code_ = "return " + cfg["value"].apply_visitor(lua_aspect_visitor());
    } else {
        // error
        return;
    }

    handler_.reset(resources::lua_kernel->create_lua_ai_action_handler(code_.c_str(), *l_ctx));
}

void aspect_attacks_lua::recalculate() const
{
    obj_.reset(new lua_object<aspect_attacks_lua_filter>);
    const config empty_cfg;
    handler_->handle(params_, empty_cfg, true, obj_);

    aspect_attacks_lua_filter filt = *obj_->get();
    aspect_attacks_base::recalculate();

    if(filt.lua) {
        if(filt.ref_own_ != -1) {
            luaL_unref(filt.lua, LUA_REGISTRYINDEX, filt.ref_own_);
        }
        if(filt.ref_enemy_ != -1) {
            luaL_unref(filt.lua, LUA_REGISTRYINDEX, filt.ref_enemy_);
        }
    }

    obj_.reset();
}

config aspect_attacks_lua::to_config() const
{
    config cfg = aspect::to_config();
    cfg["code"] = code_;
    if(!params_.empty()) {
        cfg.add_child("args", params_);
    }

    return cfg;
}

static bool call_lua_filter_fcn(lua_State* L, const unit& u, int idx)
{
    lua_rawgeti(L, LUA_REGISTRYINDEX, idx);
    luaW_pushunit(L, u.underlying_id());
    luaW_pcall(L, 1, 1);
    bool result = luaW_toboolean(L, -1);
    lua_pop(L, 1);
    return result;
}

bool aspect_attacks_lua::is_allowed_attacker(const unit& u) const
{
    const aspect_attacks_lua_filter& filt = *obj_->get();
    if(filt.lua && filt.ref_own_ != -1) {
        return call_lua_filter_fcn(filt.lua, u, filt.ref_own_);
    } else if(filt.filter_own_) {
        return (*filt.filter_own_)(u);
    } else {
        return true;
    }
}

bool aspect_attacks_lua::is_allowed_enemy(const unit& u) const
{
    const aspect_attacks_lua_filter& filt = *obj_->get();
    if(filt.lua && filt.ref_enemy_ != -1) {
        return call_lua_filter_fcn(filt.lua, u, filt.ref_enemy_);
    } else if(filt.filter_enemy_) {
        return (*filt.filter_enemy_)(u);
    } else {
        return true;
    }
}

} // end of namespace ai