contexts.hpp

Go to the documentation of this file.

/*
    Copyright (C) 2009 - 2021
    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.
*/

/**
 * @file
 * Default AI contexts
 */

#pragma once

#include "ai/contexts.hpp"
#include "formula/callable.hpp"
#include "utils/make_enum.hpp"

//============================================================================
namespace ai {

struct target {
    MAKE_ENUM(TYPE,
        (VILLAGE, "village")
        (LEADER, "leader")
        (EXPLICIT, "explicit")
        (THREAT, "threat")
        (BATTLE_AID, "battle aid")
        (MASS, "mass")
        (SUPPORT, "support")
    )

    target(const map_location& pos, double val, TYPE target_type=TYPE::VILLAGE) : loc(pos), value(val), type(target_type)
    {}
    map_location loc;
    double value;

    TYPE type;
};

class attack_analysis : public wfl::action_callable
{
public:
    attack_analysis() :
        wfl::action_callable(),
        target(),
        movements(),
        target_value(0.0),
        avg_losses(0.0),
        chance_to_kill(0.0),
        avg_damage_inflicted(0.0),
        target_starting_damage(0),
        avg_damage_taken(0.0),
        resources_used(0.0),
        terrain_quality(0.0),
        alternative_terrain_quality(0.0),
        vulnerability(0.0),
        support(0.0),
        leader_threat(false),
        uses_leader(false),
        is_surrounded(false)
    {
    }

    void analyze(const gamemap& map, unit_map& units,
                 const readonly_context& ai_obj,
                 const move_map& dstsrc, const move_map& srcdst,
                 const move_map& enemy_dstsrc, double aggression);

    double rating(double aggression, const readonly_context& ai_obj) const;
    wfl::variant get_value(const std::string& key) const override;
    void get_inputs(wfl::formula_input_vector& inputs) const override;

    bool attack_close(const map_location& loc) const;

    map_location target;
    std::vector<std::pair<map_location,map_location>> movements;

    /** The value of the unit being targeted. */
    double target_value;

    /** The value on average, of units lost in the combat. */
    double avg_losses;

    /** Estimated % chance to kill the unit. */
    double chance_to_kill;

    /** The average hitpoints damage inflicted. */
    double avg_damage_inflicted;

    int target_starting_damage;

    /** The average hitpoints damage taken. */
    double avg_damage_taken;

    /** The sum of the values of units used in the attack. */
    double resources_used;

    /** The weighted average of the % chance to hit each attacking unit. */
    double terrain_quality;

    /**
     * The weighted average of the % defense of the best possible terrain
     * that the attacking units could reach this turn, without attacking
     * (good for comparison to see just how good/bad 'terrain_quality' is).
     */
    double alternative_terrain_quality;

    /**
     * The vulnerability is the power projection of enemy units onto the hex
     * we're standing on. support is the power projection of friendly units.
     */
    double vulnerability, support;

    /** Is true if the unit is a threat to our leader. */
    bool leader_threat;

    /** Is true if this attack sequence makes use of the leader. */
    bool uses_leader;

    /** Is true if the units involved in this attack sequence are surrounded. */
    bool is_surrounded;

    wfl::variant execute_self(wfl::variant ctxt) override;
};

class default_ai_context;
class default_ai_context : public virtual readwrite_context{
public:

    virtual int count_free_hexes_in_castle(const map_location& loc, std::set<map_location> &checked_hexes) = 0;

    /** Constructor */
    default_ai_context();

    /** Destructor */
    virtual ~default_ai_context();

    virtual const std::vector<target>& additional_targets() const = 0;

    virtual void add_target(const target& t) const = 0;

    virtual void clear_additional_targets() const = 0;

    virtual default_ai_context& get_default_ai_context() = 0;

    virtual std::vector<target> find_targets(const move_map& enemy_dstsrc) = 0;

    virtual int rate_terrain(const unit& u, const map_location& loc) const = 0;

    virtual config to_default_ai_context_config() const = 0;
};

// proxies
class default_ai_context_proxy : public virtual default_ai_context, public virtual readwrite_context_proxy {
public:

    int count_free_hexes_in_castle(const map_location& loc, std::set<map_location> &checked_hexes)
    {
        return target_->count_free_hexes_in_castle(loc, checked_hexes);
    }

    default_ai_context_proxy()
        : target_(nullptr)
    {
    }

    virtual ~default_ai_context_proxy();

    virtual const std::vector<target>& additional_targets() const
    {
        return target_->additional_targets();
    }

    virtual void add_target(const target& t) const
    {
        target_->add_target(t);
    }

    virtual void clear_additional_targets() const
    {
        target_->clear_additional_targets();
    }

    virtual default_ai_context& get_default_ai_context()
    {
        return target_->get_default_ai_context();
    }

    virtual std::vector<target> find_targets(const move_map& enemy_dstsrc)
    {
        return target_->find_targets(enemy_dstsrc);
    }

    void init_default_ai_context_proxy(default_ai_context &target);

    virtual int rate_terrain(const unit& u, const map_location& loc) const
    {
        return target_->rate_terrain(u,loc);
    }

    virtual config to_default_ai_context_config() const
    {
        return target_->to_default_ai_context_config();
    }

private:
    default_ai_context *target_;
};

class default_ai_context_impl : public virtual readwrite_context_proxy, public default_ai_context {
public:

    int count_free_hexes_in_castle(const map_location& loc, std::set<map_location> &checked_hexes);

    default_ai_context_impl(readwrite_context &context, const config &/*cfg*/)
        : recursion_counter_(context.get_recursion_count()),additional_targets_()
    {
        init_readwrite_context_proxy(context);
    }

    virtual ~default_ai_context_impl();

    virtual default_ai_context& get_default_ai_context();

    virtual const std::vector<target>& additional_targets() const;

    virtual void add_target(const target& t) const;

    virtual void clear_additional_targets() const;

    int get_recursion_count() const
    {
        return recursion_counter_.get_count();
    }

    virtual std::vector<target> find_targets(const move_map& enemy_dstsrc);

    virtual int rate_terrain(const unit& u, const map_location& loc) const;

    virtual config to_default_ai_context_config() const;

private:
    recursion_counter recursion_counter_;
    mutable std::vector<target> additional_targets_;// TODO: refactor this (remove mutable)

};

} //end of namespace ai