engine.cpp

Go to the documentation of this file.

/*
    Copyright (C) 2009 - 2025
    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.
*/
 
/**
 * AI Support engine - creating specific ai components from config
 * @file
 */
 
#include "ai/composite/engine.hpp"
#include "ai/composite/contexts.hpp"
 
#include "log.hpp"
 
namespace ai {
 
static lg::log_domain log_ai_engine("ai/engine");
#define DBG_AI_ENGINE LOG_STREAM(debug, log_ai_engine)
#define LOG_AI_ENGINE LOG_STREAM(info, log_ai_engine)
#define ERR_AI_ENGINE LOG_STREAM(err, log_ai_engine)
 
engine::engine( readonly_context &context, const config &cfg )
    : ai_(context)
    , ai_context_(nullptr)
    , engine_(cfg["engine"])
    , id_(cfg["id"])
    , name_(cfg["name"])
{
    LOG_AI_ENGINE << "side "<< ai_.get_side() << " : "<<" created engine with name=["<<name_<<"]";
}
 
engine::~engine()
{
}
 
bool engine::is_ok() const
{
    return true;
}
 
void engine::parse_aspect_from_config( readonly_context &context, const config &cfg, const std::string &id, std::back_insert_iterator< std::vector< aspect_ptr >> b )
{
    engine_ptr eng = context.get_engine_by_cfg(cfg);
    if (eng){
        //do not override that method in subclasses which cannot create aspects
        eng->do_parse_aspect_from_config(cfg, id, b);
    }
}
 
void engine::parse_candidate_action_from_config( rca_context &context, const config &cfg, std::back_insert_iterator<std::vector< candidate_action_ptr >> b )
{
    engine_ptr eng = context.get_engine_by_cfg(cfg);
    if (eng){
        //do not override that method in subclasses which cannot create candidate actions
        eng->do_parse_candidate_action_from_config(context, cfg, b);
    }
}
 
void engine::parse_engine_from_config( readonly_context &context, const config &cfg, std::back_insert_iterator<std::vector< engine_ptr >> b )
{
    engine_ptr eng = context.get_engine_by_cfg(cfg);
    if (eng){
        //do not override that method in subclasses which cannot create engines
        eng->do_parse_engine_from_config(cfg, b);
    }
}
 
void engine::parse_goal_from_config( readonly_context &context, const config &cfg, std::back_insert_iterator<std::vector< goal_ptr >> b )
{
    engine_ptr eng = context.get_engine_by_cfg(cfg);
    if (eng){
        //do not override that method in subclasses which cannot create goals
        eng->do_parse_goal_from_config(cfg, b);
    }
}
 
void engine::parse_stage_from_config( ai_context &context, const config &cfg, std::back_insert_iterator<std::vector< stage_ptr >> b )
{
    engine_ptr eng = context.get_engine_by_cfg(cfg);
    if (eng){
        //do not override that method in subclasses which cannot create stages
        eng->do_parse_stage_from_config(context, cfg, b);
    }
}
 
void engine::do_parse_aspect_from_config( const config &/*cfg*/, const std::string &/*id*/, std::back_insert_iterator< std::vector<aspect_ptr>> /*b*/ )
{
 
}
 
void engine::do_parse_candidate_action_from_config( rca_context &/*context*/, const config &/*cfg*/, std::back_insert_iterator<std::vector< candidate_action_ptr >> /*b*/ ){
 
}
 
void engine::do_parse_engine_from_config( const config &/*cfg*/, std::back_insert_iterator<std::vector< engine_ptr >> /*b*/ ){
 
}
 
void engine::do_parse_goal_from_config( const config &/*cfg*/, std::back_insert_iterator<std::vector< goal_ptr >> /*b*/ ){
 
}
 
void engine::do_parse_stage_from_config( ai_context &/*context*/, const config &/*cfg*/, std::back_insert_iterator<std::vector< stage_ptr >> /*b*/ )
{
 
}
 
void engine::set_ai_context(ai_context_ptr ai_context)
{
    ai_context_ = ai_context;
}
 
ai_context_ptr engine::get_ai_context()
{
    return ai_context_;
}
 
config engine::to_config() const
{
    config cfg;
    cfg["engine"] = engine_;
    cfg["name"] = get_name();
    return cfg;
}
 
readonly_context& engine::get_readonly_context()
{
    return ai_;
}
 
// This is defined in the source file so that it can easily access the logger
bool engine_factory::is_duplicate(const std::string& name)
{
    if (get_list().find(name) != get_list().end()) {
        ERR_AI_ENGINE << "Error: Attempt to double-register engine " << name;
        return true;
    }
    return false;
}
 
} //end of namespace ai