goal.hpp

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.
*/

/**
 * @file
 */

#pragma once

#include "ai/composite/component.hpp"

#include "ai/default/contexts.hpp"
#include "ai/game_info.hpp"
#include "config.hpp"

#include <iterator>
#include <map>
#include <set>
#include <string>
#include <utility>
#include <vector>

class terrain_filter;
namespace ai { class lua_ai_action_handler; }
namespace ai { class lua_ai_context; }
namespace ai { struct target; }

namespace ai {

class goal : public readonly_context_proxy, public component {
public:
    goal(readonly_context &context, const config &cfg);

    virtual ~goal();

    virtual void add_targets(std::back_insert_iterator< std::vector< target >> target_list);

    virtual config to_config() const;

    virtual void on_create();
    virtual void on_create(std::shared_ptr<ai::lua_ai_context>);

    bool active() const;
    bool ok() const;

    virtual std::string get_id() const;
    virtual std::string get_name() const;
    virtual std::string get_engine() const;

    bool redeploy(const config &cfg);

protected:
    void unrecognized();
    config cfg_;
    bool ok_;

};

class target_unit_goal : public goal {
public:
    target_unit_goal(readonly_context &context, const config &cfg);

    virtual void add_targets(std::back_insert_iterator< std::vector< target >> target_list);

    virtual void on_create();

private:
    double value() const
    {
        return value_;
    }
    double value_;
};

class target_location_goal : public goal {
public:
    target_location_goal(readonly_context &context, const config &cfg);

    virtual void add_targets(std::back_insert_iterator< std::vector< target >> target_list);

    virtual void on_create();

private:
    double value() const
    {
        return value_;
    }
    std::shared_ptr<terrain_filter> filter_ptr_;
    double value_;
};

class protect_goal : public goal {
public:
    protect_goal(readonly_context &context, const config &cfg, bool protect_unit);

    virtual void add_targets(std::back_insert_iterator< std::vector< target >> target_list);

    virtual void on_create();

private:

    double value()
    {
        return value_;
    }

    std::shared_ptr<terrain_filter> filter_ptr_;
    bool protect_unit_;
    int radius_;
    double value_;
};

class protect_location_goal : public protect_goal {
public:
    protect_location_goal(readonly_context &context, const config &cfg)
    : protect_goal(context,cfg,false)
    {
    }
};

class protect_unit_goal : public protect_goal {
public:
    protect_unit_goal(readonly_context &context, const config &cfg)
    : protect_goal(context,cfg,true)
    {
    }
};

class lua_goal : public goal {
public:
    lua_goal(readonly_context& context, const config& cfg);
    virtual void add_targets(std::back_insert_iterator< std::vector< target >> target_list);
    void on_create(std::shared_ptr<ai::lua_ai_context>);

private:
    std::string code_;
    std::shared_ptr<lua_ai_action_handler> handler_;
};

class goal_factory{
    bool is_duplicate(const std::string &name);
public:
    typedef std::shared_ptr< goal_factory > factory_ptr;
    typedef std::map<std::string, factory_ptr> factory_map;
    typedef std::pair<const std::string, factory_ptr> factory_map_pair;

    static factory_map& get_list() {
        static factory_map *goal_factories;
        if (goal_factories==nullptr) {
            goal_factories = new factory_map;
        }
        return *goal_factories;
    }

    virtual goal_ptr get_new_instance( readonly_context &context, const config &cfg ) = 0;

    goal_factory( const std::string &name )
    {
        if (is_duplicate(name)) {
            return;
        }
        factory_ptr ptr_to_this(this);
        get_list().emplace(name,ptr_to_this);
    }

    virtual ~goal_factory() {}
};

template<class GOAL>
class register_goal_factory : public goal_factory {
public:
    register_goal_factory( const std::string &name )
        : goal_factory( name )
    {
    }

    virtual goal_ptr get_new_instance( readonly_context &context, const config &cfg ){
        goal_ptr a = std::make_shared<GOAL>(context, cfg);
        a->on_create();
        return a;
    }
};

} //end of namespace ai