0ct0pu5/wesnoth
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

AI/Configuration: formatting cleanup

Browse source
This commit is contained in:
Charles Dang 2018-05-01 12:40:23 +11:00
parent 1c744875d3
commit cc1b4825d9
2 changed files with 151 additions and 116 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

231
src/ai/configuration.cpp
View file

@ -12,7 +12,6 @@
See the COPYING file for more details.
*/
/**
* Managing the AI configuration
* @file
@ -25,81 +24,91 @@
#include "serialization/parser.hpp"
#include "serialization/preprocessor.hpp"
#include <vector>
#include <deque>
#include <set>
#include <vector>
namespace ai {
namespace ai
{
static lg::log_domain log_ai_configuration("ai/config");
#define DBG_AI_CONFIGURATION LOG_STREAM(debug, log_ai_configuration)
#define LOG_AI_CONFIGURATION LOG_STREAM(info, log_ai_configuration)
#define WRN_AI_CONFIGURATION LOG_STREAM(warn, log_ai_configuration)
#define ERR_AI_CONFIGURATION LOG_STREAM(err, log_ai_configuration)
void configuration::init(const config &game_config)
void configuration::init(const config& game_config)
{
ai_configurations_.clear();
era_ai_configurations_.clear();
mod_ai_configurations_.clear();
const config &ais = game_config.child("ais");
const config& ais = game_config.child("ais");
default_config_ = ais.child("default_config");
if (!default_config_) {
if(!default_config_) {
ERR_AI_CONFIGURATION << "Missing AI [default_config]. Therefore, default_config_ set to empty." << std::endl;
default_config_.clear();
}
for (const config &ai_configuration : ais.child_range("ai")) {
const std::string &id = ai_configuration["id"];
if (id.empty()){
ERR_AI_CONFIGURATION << "skipped AI config due to missing id" << ". Config contains:"<< std::endl << ai_configuration << std::endl;
for(const config& ai_configuration : ais.child_range("ai")) {
const std::string& id = ai_configuration["id"];
if(id.empty()) {
ERR_AI_CONFIGURATION
<< "skipped AI config due to missing id. Config contains:" << std::endl
<< ai_configuration << std::endl;
continue;
}
if (ai_configurations_.count(id)>0){
ERR_AI_CONFIGURATION << "skipped AI config due to duplicate id [" << id << "]. Config contains:"<< std::endl << ai_configuration << std::endl;
if(ai_configurations_.count(id) > 0) {
ERR_AI_CONFIGURATION
<< "skipped AI config due to duplicate id [" << id << "]. Config contains:" << std::endl
<< ai_configuration << std::endl;
continue;
}
description desc;
desc.id=id;
desc.id = id;
desc.text = ai_configuration["description"].t_str();
desc.cfg=ai_configuration;
desc.cfg = ai_configuration;
ai_configurations_.emplace(id, desc);
LOG_AI_CONFIGURATION << "loaded AI config: " << ai_configuration["description"] << std::endl;
}
}
namespace {
void extract_ai_configurations(std::map<std::string, description> &storage, const config &input)
namespace
{
for (const config &ai_configuration : input.child_range("ai")) {
const std::string &id = ai_configuration["id"];
if (id.empty()){
void extract_ai_configurations(std::map<std::string, description>& storage, const config& input)
{
for(const config& ai_configuration : input.child_range("ai")) {
const std::string& id = ai_configuration["id"];
ERR_AI_CONFIGURATION << "skipped AI config due to missing id" << ". Config contains:"<< std::endl << ai_configuration << std::endl;
if(id.empty()) {
ERR_AI_CONFIGURATION
<< "skipped AI config due to missing id. Config contains:" << std::endl
<< ai_configuration << std::endl;
continue;
}
if (storage.count(id)>0){
ERR_AI_CONFIGURATION << "skipped AI config due to duplicate id [" << id << "]. Config contains:"<< std::endl << ai_configuration << std::endl;
if(storage.count(id) > 0) {
ERR_AI_CONFIGURATION
<< "skipped AI config due to duplicate id [" << id << "]. Config contains:" << std::endl
<< ai_configuration << std::endl;
continue;
}
description desc;
desc.id=id;
desc.id = id;
desc.text = ai_configuration["description"].t_str();
desc.cfg=ai_configuration;
desc.cfg = ai_configuration;
storage.emplace(id, desc);
LOG_AI_CONFIGURATION << "loaded AI config: " << ai_configuration["description"] << std::endl;
}
}
}
} // end anon namespace
void configuration::add_era_ai_from_config(const config &era)
void configuration::add_era_ai_from_config(const config& era)
{
era_ai_configurations_.clear();
extract_ai_configurations(era_ai_configurations_, era);
@ -108,7 +117,7 @@ void configuration::add_era_ai_from_config(const config &era)
void configuration::add_mod_ai_from_config(config::const_child_itors mods)
{
mod_ai_configurations_.clear();
for (const config &mod : mods) {
for(const config& mod : mods) {
extract_ai_configurations(mod_ai_configurations_, mod);
}
}
@ -142,14 +151,16 @@ std::vector<description*> configuration::get_available_ais()
return ais_list;
}
const config& configuration::get_ai_config_for(const std::string &id)
const config& configuration::get_ai_config_for(const std::string& id)
{
description_map::iterator cfg_it = ai_configurations_.find(id);
if (cfg_it==ai_configurations_.end()){
if(cfg_it == ai_configurations_.end()) {
description_map::iterator era_cfg_it = era_ai_configurations_.find(id);
if (era_cfg_it==era_ai_configurations_.end()){
if(era_cfg_it == era_ai_configurations_.end()) {
description_map::iterator mod_cfg_it = mod_ai_configurations_.find(id);
if (mod_cfg_it==mod_ai_configurations_.end()) {
if(mod_cfg_it == mod_ai_configurations_.end()) {
return default_config_;
} else {
return mod_cfg_it->second.cfg;
@ -158,25 +169,27 @@ const config& configuration::get_ai_config_for(const std::string &id)
return era_cfg_it->second.cfg;
}
}
return cfg_it->second.cfg;
}
configuration::description_map configuration::ai_configurations_ = configuration::description_map();
configuration::description_map configuration::era_ai_configurations_ = configuration::description_map();
configuration::description_map configuration::mod_ai_configurations_ = configuration::description_map();
config configuration::default_config_ = config();
bool configuration::get_side_config_from_file(const std::string& file, config& cfg ){
bool configuration::get_side_config_from_file(const std::string& file, config& cfg)
{
try {
filesystem::scoped_istream stream = preprocess_file(filesystem::get_wml_location(file));
read(cfg, *stream);
LOG_AI_CONFIGURATION << "Reading AI configuration from file '" << file << "'" << std::endl;
} catch(config::error &) {
ERR_AI_CONFIGURATION << "Error while reading AI configuration from file '" << file << "'" << std::endl;
LOG_AI_CONFIGURATION << "Reading AI configuration from file '" << file << "'" << std::endl;
} catch(config::error&) {
ERR_AI_CONFIGURATION << "Error while reading AI configuration from file '" << file << "'" << std::endl;
return false;
}
LOG_AI_CONFIGURATION << "Successfully read AI configuration from file '" << file << "'" << std::endl;
LOG_AI_CONFIGURATION << "Successfully read AI configuration from file '" << file << "'" << std::endl;
return true;
}
@ -185,107 +198,121 @@ const config& configuration::get_default_ai_parameters()
return default_config_;
}
bool configuration::parse_side_config(side_number side, const config& original_cfg, config &cfg )
bool configuration::parse_side_config(side_number side, const config& original_cfg, config& cfg)
{
LOG_AI_CONFIGURATION << "side "<< side <<": parsing AI configuration from config" << std::endl;
LOG_AI_CONFIGURATION << "side " << side << ": parsing AI configuration from config" << std::endl;
//leave only the [ai] children
// leave only the [ai] children
cfg.clear();
for (const config &aiparam : original_cfg.child_range("ai")) {
cfg.add_child("ai",aiparam);
for(const config& aiparam : original_cfg.child_range("ai")) {
cfg.add_child("ai", aiparam);
}
//backward-compatibility hack: put ai_algorithm if it is present
if (const config::attribute_value *v = original_cfg.get("ai_algorithm")) {
// backward-compatibility hack: put ai_algorithm if it is present
if(const config::attribute_value* v = original_cfg.get("ai_algorithm")) {
config ai_a;
ai_a["ai_algorithm"] = *v;
cfg.add_child("ai",ai_a);
cfg.add_child("ai", ai_a);
}
DBG_AI_CONFIGURATION << "side " << side << ": config contains:"<< std::endl << cfg << std::endl;
//insert default config at the beginning
if (default_config_) {
DBG_AI_CONFIGURATION << "side "<< side <<": applying default configuration" << std::endl;
cfg.add_child_at("ai",default_config_,0);
DBG_AI_CONFIGURATION << "side " << side << ": config contains:" << std::endl << cfg << std::endl;
// insert default config at the beginning
if(default_config_) {
DBG_AI_CONFIGURATION << "side " << side << ": applying default configuration" << std::endl;
cfg.add_child_at("ai", default_config_, 0);
} else {
ERR_AI_CONFIGURATION << "side "<< side <<": default configuration is not available, not applying it" << std::endl;
ERR_AI_CONFIGURATION << "side " << side << ": default configuration is not available, not applying it" << std::endl;
}
LOG_AI_CONFIGURATION << "side "<< side << ": expanding simplified aspects into full facets"<< std::endl;
LOG_AI_CONFIGURATION << "side " << side << ": expanding simplified aspects into full facets" << std::endl;
expand_simplified_aspects(side, cfg);
//construct new-style integrated config
LOG_AI_CONFIGURATION << "side "<< side << ": doing final operations on AI config"<< std::endl;
// construct new-style integrated config
LOG_AI_CONFIGURATION << "side " << side << ": doing final operations on AI config" << std::endl;
config parsed_cfg = config();
LOG_AI_CONFIGURATION << "side "<< side <<": merging AI configurations"<< std::endl;
for (const config &aiparam : cfg.child_range("ai")) {
LOG_AI_CONFIGURATION << "side " << side << ": merging AI configurations" << std::endl;
for(const config& aiparam : cfg.child_range("ai")) {
parsed_cfg.append(aiparam);
}
LOG_AI_CONFIGURATION << "side " << side << ": merging AI aspect with the same id" << std::endl;
parsed_cfg.merge_children_by_attribute("aspect", "id");
LOG_AI_CONFIGURATION << "side "<< side <<": merging AI aspect with the same id"<< std::endl;
parsed_cfg.merge_children_by_attribute("aspect","id");
LOG_AI_CONFIGURATION << "side "<< side <<": removing duplicate [default] tags from aspects"<< std::endl;
for (config &aspect_cfg : parsed_cfg.child_range("aspect")) {
if (aspect_cfg["name"] != "composite_aspect") {
LOG_AI_CONFIGURATION << "side " << side << ": removing duplicate [default] tags from aspects" << std::endl;
for(config& aspect_cfg : parsed_cfg.child_range("aspect")) {
if(aspect_cfg["name"] != "composite_aspect") {
// No point in warning about Lua or standard aspects lacking [default]
continue;
}
if (!aspect_cfg.child("default")) {
WRN_AI_CONFIGURATION << "side "<< side <<": aspect with id=["<<aspect_cfg["id"]<<"] lacks default config facet!" <<std::endl;
if(!aspect_cfg.child("default")) {
WRN_AI_CONFIGURATION
<< "side " << side << ": aspect with id=[" << aspect_cfg["id"]
<< "] lacks default config facet!" << std::endl;
continue;
}
aspect_cfg.merge_children("default");
config& dflt = aspect_cfg.child("default");
if (dflt.has_child("value")) {
while (dflt.child_count("value") > 1) {
if(dflt.has_child("value")) {
while(dflt.child_count("value") > 1) {
dflt.remove_child("value", 0);
}
}
}
DBG_AI_CONFIGURATION << "side "<< side <<": done parsing side config, it contains:"<< std::endl << parsed_cfg << std::endl;
LOG_AI_CONFIGURATION << "side "<< side <<": done parsing side config"<< std::endl;
DBG_AI_CONFIGURATION << "side " << side << ": done parsing side config, it contains:" << std::endl << parsed_cfg << std::endl;
LOG_AI_CONFIGURATION << "side " << side << ": done parsing side config" << std::endl;
cfg = parsed_cfg;
return true;
}
static const std::set<std::string> non_aspect_attributes {"turns", "time_of_day", "engine", "ai_algorithm", "id", "description", "hidden"};
static const std::set<std::string> just_copy_tags {"engine", "stage", "aspect", "goal", "modify_ai"};
static const std::set<std::string> old_goal_tags {"target", "target_location", "protect_unit", "protect_location"};
void configuration::expand_simplified_aspects(side_number side, config &cfg) {
void configuration::expand_simplified_aspects(side_number side, config& cfg)
{
std::string algorithm;
config base_config, parsed_config;
for (const config &aiparam : cfg.child_range("ai")) {
for(const config& aiparam : cfg.child_range("ai")) {
std::string turns, time_of_day, engine = "cpp";
if (aiparam.has_attribute("turns")) {
if(aiparam.has_attribute("turns")) {
turns = aiparam["turns"].str();
}
if (aiparam.has_attribute("time_of_day")) {
if(aiparam.has_attribute("time_of_day")) {
time_of_day = aiparam["time_of_day"].str();
}
if (aiparam.has_attribute("engine")) {
if(aiparam.has_attribute("engine")) {
engine = aiparam["engine"].str();
}
if (aiparam.has_attribute("ai_algorithm")) {
if (algorithm.empty()) {
if(aiparam.has_attribute("ai_algorithm")) {
if(algorithm.empty()) {
algorithm = aiparam["ai_algorithm"].str();
base_config = get_ai_config_for(algorithm);
} else if(algorithm != aiparam["ai_algorithm"]) {
lg::wml_error() << "side " << side << " has two [ai] tags with contradictory ai_algorithm - the first one will take precedence.\n";
lg::wml_error()
<< "side " << side
<< " has two [ai] tags with contradictory ai_algorithm - the first one will take precedence.\n";
}
}
std::deque<std::pair<std::string, config>> facet_configs;
for (const config::attribute &attr : aiparam.attribute_range()) {
if (non_aspect_attributes.count(attr.first)) {
for(const config::attribute& attr : aiparam.attribute_range()) {
if(non_aspect_attributes.count(attr.first)) {
continue;
}
config facet_config;
facet_config["engine"] = engine;
facet_config["name"] = "standard_aspect";
@ -294,8 +321,9 @@ void configuration::expand_simplified_aspects(side_number side, config &cfg) {
facet_config["value"] = attr.second;
facet_configs.emplace_back(attr.first, facet_config);
}
for (const config::any_child &child : aiparam.all_children_range()) {
if (just_copy_tags.count(child.key)) {
for(const config::any_child& child : aiparam.all_children_range()) {
if(just_copy_tags.count(child.key)) {
// These aren't simplified, so just copy over unchanged.
parsed_config.add_child(child.key, child.cfg);
continue;
@ -305,21 +333,25 @@ void configuration::expand_simplified_aspects(side_number side, config &cfg) {
goal_config["name"] = child.key;
goal_config["turns"] = turns;
goal_config["time_of_day"] = time_of_day;
if(child.key.substr(0,7) == "protect" && criteria_config.has_attribute("protect_radius")) {
if(child.key.substr(0, 7) == "protect" && criteria_config.has_attribute("protect_radius")) {
goal_config["protect_radius"] = criteria_config["protect_radius"];
criteria_config.remove_attribute("protect_radius");
}
if(criteria_config.has_attribute("value")) {
goal_config["value"] = criteria_config["value"];
criteria_config.remove_attribute("value");
}
parsed_config.add_child("goal", std::move(goal_config));
continue;
}
// Now there's two possibilities. If the tag is [attacks] or contains either value= or [value],
// then it can be copied verbatim as a [facet] tag.
// Otherwise, it needs to be placed as a [value] within a [facet] tag.
if (child.key == "attacks" || child.cfg.has_attribute("value") || child.cfg.has_child("value")) {
if(child.key == "attacks" || child.cfg.has_attribute("value") || child.cfg.has_child("value")) {
facet_configs.emplace_back(child.key, child.cfg);
} else {
config facet_config;
@ -328,44 +360,53 @@ void configuration::expand_simplified_aspects(side_number side, config &cfg) {
facet_config["turns"] = turns;
facet_config["time_of_day"] = time_of_day;
facet_config.add_child("value", child.cfg);
if (child.key == "leader_goal" && !child.cfg["id"].empty()) {
if(child.key == "leader_goal" && !child.cfg["id"].empty()) {
// Use id= attribute (if present) as the facet ID
const std::string& id = child.cfg["id"];
if(id != "*" && id.find_first_not_of("0123456789") != std::string::npos) {
facet_config["id"] = child.cfg["id"];
}
}
facet_configs.emplace_back(child.key, facet_config);
}
}
std::map<std::string, config> aspect_configs;
while (!facet_configs.empty()) {
const std::string &aspect = facet_configs.front().first;
const config &facet_config = facet_configs.front().second;
while(!facet_configs.empty()) {
const std::string& aspect = facet_configs.front().first;
const config& facet_config = facet_configs.front().second;
aspect_configs[aspect]["id"] = aspect; // Will sometimes be redundant assignment
aspect_configs[aspect]["name"] = "composite_aspect";
aspect_configs[aspect].add_child("facet", facet_config);
facet_configs.pop_front();
}
typedef std::map<std::string, config>::value_type aspect_pair;
for (const aspect_pair& p : aspect_configs) {
for(const aspect_pair& p : aspect_configs) {
parsed_config.add_child("aspect", p.second);
}
}
// Support old recruitment aspect syntax
for(auto& child : parsed_config.child_range("aspect")) {
if(child["id"] == "recruitment") {
child["id"] = "recruitment_instructions";
}
}
if (algorithm.empty() && !parsed_config.has_child("stage")) {
if(algorithm.empty() && !parsed_config.has_child("stage")) {
base_config = get_ai_config_for("ai_default_rca");
}
for (const config::any_child &child : parsed_config.all_children_range()) {
for(const config::any_child& child : parsed_config.all_children_range()) {
base_config.add_child(child.key, child.cfg);
}
cfg.clear_children("ai");
cfg.add_child("ai", std::move(base_config));
}
} //end of namespace ai
} // end of namespace ai

36
src/ai/configuration.hpp
View file

@ -19,11 +19,11 @@
#pragma once
#include "config.hpp"
#include "ai/game_info.hpp"
#include "config.hpp"
namespace ai {
namespace ai
{
/**
* AI parameters. class to deal with AI parameters. It is an implementation detail.
* We need implementation which will allow easy access to all the parameters
@ -41,7 +41,8 @@ namespace ai {
* use any and loudly complain.
*/
struct description {
struct description
{
public:
description()
: text()
@ -55,30 +56,27 @@ public:
config cfg;
};
class configuration {
class configuration
{
public:
/**
* Init the parameters of ai configuration parser
* @param game_config game config
*/
static void init(const config &game_config);
static void add_era_ai_from_config(const config &game_config);
static void init(const config& game_config);
static void add_era_ai_from_config(const config& game_config);
static void add_mod_ai_from_config(config::const_child_itors configs);
/**
* get default AI parameters
* @return default AI parameters
*/
static const config& get_default_ai_parameters();
/**
* Return the config for a specified ai
*/
static const config& get_ai_config_for(const std::string &id);
static const config& get_ai_config_for(const std::string& id);
/**
* Returns a list of available AIs.
@ -86,7 +84,6 @@ public:
*/
static std::vector<description*> get_available_ais();
/**
* get side config from file
* @param file the file name to open. follows usual WML convention.
@ -95,8 +92,7 @@ public:
* @retval true success
* @retval false failure
*/
static bool get_side_config_from_file( const std::string& file, config& cfg );
static bool get_side_config_from_file(const std::string& file, config& cfg);
/**
* @param[in] original_cfg the config to be read
@ -105,22 +101,20 @@ public:
* @retval true success
* @retval false failure
*/
static bool parse_side_config(side_number side, const config& original_cfg, config &cfg);
static bool parse_side_config(side_number side, const config& original_cfg, config& cfg);
/**
* Expand simplified aspects, similar to the change from 1.7.2 to 1.7.3
* but with some additional syntax options.
*/
static void expand_simplified_aspects(side_number side, config &cfg);
private:
static void expand_simplified_aspects(side_number side, config& cfg);
private:
typedef std::map<std::string, description> description_map;
static description_map ai_configurations_;
static description_map era_ai_configurations_;
static description_map mod_ai_configurations_;
static config default_config_;
};
} //end of namespace ai
} // end of namespace ai