1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
|
/* This file is part of the Spring engine (GPL v2 or later), see LICENSE.html */
#include "AILibraryManager.h"
#include "Interface/aidefines.h"
#include "Interface/SAIInterfaceLibrary.h"
#include "AIInterfaceLibraryInfo.h"
#include "AIInterfaceLibrary.h"
#include "SkirmishAILibraryInfo.h"
#include "SkirmishAIData.h"
#include "System/Util.h"
#include "System/Log/ILog.h"
#include "System/Platform/errorhandler.h"
#include "System/Platform/SharedLib.h"
#include "System/FileSystem/FileHandler.h"
#include "System/FileSystem/DataDirsAccess.h"
#include "System/FileSystem/FileQueryFlags.h"
#include "System/FileSystem/FileSystem.h"
#include "Sim/Misc/GlobalConstants.h"
#include "Sim/Misc/Team.h"
#include "Sim/Misc/TeamHandler.h"
#include <string>
#include <set>
#include <sstream>
#include <limits.h>
CAILibraryManager::CAILibraryManager() {
ClearAllInfos();
GatherInterfaceLibrariesInfos();
GatherSkirmishAIsLibrariesInfos();
}
void CAILibraryManager::GatherInterfaceLibrariesInfos() {
typedef std::vector<std::string> T_dirs;
// cause we use CFileHandler for searching files,
// we are automatically searching in all data-dirs
// Read from AI Interface info files
// we are looking for:
// {AI_INTERFACES_DATA_DIR}/{*}/{*}/InterfaceInfo.lua
T_dirs aiInterfaceDataDirs =
dataDirsAccess.FindDirsInDirectSubDirs(AI_INTERFACES_DATA_DIR);
typedef std::map<const AIInterfaceKey, std::set<std::string> > T_dupInt;
T_dupInt duplicateInterfaceInfoCheck;
for (T_dirs::iterator dir = aiInterfaceDataDirs.begin();
dir != aiInterfaceDataDirs.end(); ++dir) {
const std::string& possibleDataDir = *dir;
T_dirs infoFiles =
CFileHandler::FindFiles(possibleDataDir, "InterfaceInfo.lua");
if (!infoFiles.empty()) { // interface info is available
const std::string& infoFile = infoFiles.at(0);
// generate and store the interface info
CAIInterfaceLibraryInfo* interfaceInfo =
new CAIInterfaceLibraryInfo(infoFile);
interfaceInfo->SetDataDir(FileSystem::EnsureNoPathSepAtEnd(possibleDataDir));
interfaceInfo->SetDataDirCommon(
FileSystem::GetParent(possibleDataDir) + "common");
AIInterfaceKey interfaceKey = interfaceInfo->GetKey();
interfaceKeys.insert(interfaceKey);
if (interfaceInfos.find(interfaceKey) == interfaceInfos.end()) {
// no interface info with this key yet -> store it
interfaceInfos[interfaceKey] = interfaceInfo;
} else {
// duplicate interface info -> free
delete interfaceInfo;
interfaceInfo = NULL;
}
// for debug-info, in case one interface is specified multiple times
duplicateInterfaceInfoCheck[interfaceKey].insert(infoFile);
}
}
// filter out interfaces that are specified multiple times
for (T_dupInt::const_iterator info = duplicateInterfaceInfoCheck.begin();
info != duplicateInterfaceInfoCheck.end(); ++info) {
if (info->second.size() >= 2) {
duplicateInterfaceInfos[info->first] = info->second;
if (LOG_IS_ENABLED(L_ERROR)) {
LOG_L(L_ERROR, "Duplicate AI Interface Info found:");
LOG_L(L_ERROR, "\tfor interface: %s %s",
info->first.GetShortName().c_str(),
info->first.GetVersion().c_str());
LOG_L(L_ERROR, "\tin files:");
const std::string* lastDir = NULL;
std::set<std::string>::const_iterator dir;
for (dir = info->second.begin(); dir != info->second.end(); ++dir) {
LOG_L(L_ERROR, "\t%s", dir->c_str());
lastDir = &(*dir);
}
LOG_L(L_ERROR, "\tusing: %s", lastDir->c_str());
}
}
}
}
void CAILibraryManager::GatherSkirmishAIsLibrariesInfos() {
T_dupSkirm duplicateSkirmishAIInfoCheck;
GatherSkirmishAIsLibrariesInfosFromLuaFiles(duplicateSkirmishAIInfoCheck);
GatherSkirmishAIsLibrariesInfosFromInterfaceLibrary(duplicateSkirmishAIInfoCheck);
FilterDuplicateSkirmishAILibrariesInfos(duplicateSkirmishAIInfoCheck);
}
void CAILibraryManager::StoreSkirmishAILibraryInfos(T_dupSkirm duplicateSkirmishAIInfoCheck, CSkirmishAILibraryInfo* skirmishAIInfo, const std::string& sourceDesc) {
skirmishAIInfo->SetLuaAI(false);
SkirmishAIKey aiKey = skirmishAIInfo->GetKey();
AIInterfaceKey interfaceKey =
FindFittingInterfaceSpecifier(
skirmishAIInfo->GetInterfaceShortName(),
skirmishAIInfo->GetInterfaceVersion(),
interfaceKeys);
if (!interfaceKey.IsUnspecified()) {
SkirmishAIKey skirmishAIKey = SkirmishAIKey(aiKey, interfaceKey);
skirmishAIKeys.insert(skirmishAIKey);
if (skirmishAIInfos.find(skirmishAIKey) == skirmishAIInfos.end()) {
// no AI info with this key yet -> store it
skirmishAIInfos[skirmishAIKey] = skirmishAIInfo;
} else {
// duplicate AI info -> free
delete skirmishAIInfo;
skirmishAIInfo = NULL;
}
// for debug-info, in case one AI is specified multiple times
duplicateSkirmishAIInfoCheck[skirmishAIKey].insert(sourceDesc);
} else {
LOG_L(L_ERROR,
"Required AI Interface for Skirmish AI %s %s not found.",
skirmishAIInfo->GetShortName().c_str(),
skirmishAIInfo->GetVersion().c_str());
delete skirmishAIInfo;
skirmishAIInfo = NULL;
}
}
void CAILibraryManager::GatherSkirmishAIsLibrariesInfosFromLuaFiles(T_dupSkirm duplicateSkirmishAIInfoCheck) {
typedef std::vector<std::string> T_dirs;
// Read from Skirmish AI info and option files
// we are looking for:
// {SKIRMISH_AI_DATA_DIR}/{*}/{*}/AIInfo.lua
// {SKIRMISH_AI_DATA_DIR}/{*}/{*}/AIOptions.lua
T_dirs skirmishAIDataDirs = dataDirsAccess.FindDirsInDirectSubDirs(SKIRMISH_AI_DATA_DIR);
for (T_dirs::iterator dir = skirmishAIDataDirs.begin();
dir != skirmishAIDataDirs.end(); ++dir)
{
const std::string& possibleDataDir = *dir;
T_dirs infoFiles = CFileHandler::FindFiles(possibleDataDir,
"AIInfo.lua");
if (!infoFiles.empty()) { // skirmish AI info is available
const std::string& infoFile = infoFiles.at(0);
std::string optionFileName = "";
T_dirs optionFile = CFileHandler::FindFiles(possibleDataDir,
"AIOptions.lua");
if (!optionFile.empty()) {
optionFileName = optionFile.at(0);
}
// generate and store the ai info
CSkirmishAILibraryInfo* skirmishAIInfo =
new CSkirmishAILibraryInfo(infoFile, optionFileName);
skirmishAIInfo->SetDataDir(
FileSystem::EnsureNoPathSepAtEnd(possibleDataDir));
skirmishAIInfo->SetDataDirCommon(
FileSystem::GetParent(possibleDataDir) + "common");
StoreSkirmishAILibraryInfos(duplicateSkirmishAIInfoCheck, skirmishAIInfo, infoFile);
}
}
}
void CAILibraryManager::GatherSkirmishAIsLibrariesInfosFromInterfaceLibrary(T_dupSkirm duplicateSkirmishAIInfoCheck) {
const T_interfaceInfos& intInfs = GetInterfaceInfos();
T_interfaceInfos::const_iterator intInfIt;
for (intInfIt = intInfs.begin(); intInfIt != intInfs.end(); ++intInfIt) {
// only try to lookup Skirmish AI infos through the Interface library
// if it explicitly states support for this in InterfaceInfo.lua
if (intInfIt->second->IsLookupSupported()) {
const CAIInterfaceLibrary* intLib = FetchInterface(intInfIt->second->GetKey());
const int aiCount = intLib->GetSkirmishAICount();
for (int aii = 0; aii < aiCount; ++aii) {
const std::map<std::string, std::string> rawInfos = intLib->GetSkirmishAIInfos(aii);
const std::string rawLuaOptions = intLib->GetSkirmishAIOptions(aii);
// generate and store the ai info
CSkirmishAILibraryInfo* skirmishAIInfo =
new CSkirmishAILibraryInfo(rawInfos, rawLuaOptions);
// NOTE We do not set the data-dir(s) for interface looked-up
// AIs. This is the duty of the AI Interface plugin.
StoreSkirmishAILibraryInfos(duplicateSkirmishAIInfoCheck, skirmishAIInfo, intInfIt->first.ToString());
}
}
}
}
void CAILibraryManager::FilterDuplicateSkirmishAILibrariesInfos(T_dupSkirm duplicateSkirmishAIInfoCheck) {
// filter out skirmish AIs that are specified multiple times
for (T_dupSkirm::const_iterator info = duplicateSkirmishAIInfoCheck.begin();
info != duplicateSkirmishAIInfoCheck.end(); ++info) {
if (info->second.size() >= 2) {
duplicateSkirmishAIInfos[info->first] = info->second;
if (LOG_IS_ENABLED(L_WARNING)) {
LOG_L(L_WARNING, "Duplicate Skirmish AI Info found:");
LOG_L(L_WARNING, "\tfor Skirmish AI: %s %s", info->first.GetShortName().c_str(),
info->first.GetVersion().c_str());
LOG_L(L_WARNING, "\tin files:");
const std::string* lastDir = NULL;
std::set<std::string>::const_iterator dir;
for (dir = info->second.begin(); dir != info->second.end(); ++dir) {
LOG_L(L_WARNING, "\t%s", dir->c_str());
lastDir = &(*dir);
}
LOG_L(L_WARNING, "\tusing: %s", lastDir->c_str());
}
}
}
}
void CAILibraryManager::ClearAllInfos() {
IAILibraryManager::T_interfaceInfos::iterator iii;
for (iii = interfaceInfos.begin(); iii != interfaceInfos.end(); ++iii) {
delete iii->second;
iii->second = NULL;
}
interfaceInfos.clear();
IAILibraryManager::T_skirmishAIInfos::iterator sai;
for (sai = skirmishAIInfos.begin(); sai != skirmishAIInfos.end(); ++sai) {
delete sai->second;
sai->second = NULL;
}
skirmishAIInfos.clear();
interfaceKeys.clear();
skirmishAIKeys.clear();
duplicateInterfaceInfos.clear();
duplicateSkirmishAIInfos.clear();
}
CAILibraryManager::~CAILibraryManager() {
ReleaseEverything();
ClearAllInfos();
}
const IAILibraryManager::T_interfaceSpecs& CAILibraryManager::GetInterfaceKeys() const {
return interfaceKeys;
}
const IAILibraryManager::T_skirmishAIKeys& CAILibraryManager::GetSkirmishAIKeys() const {
return skirmishAIKeys;
}
const IAILibraryManager::T_interfaceInfos& CAILibraryManager::GetInterfaceInfos() const {
return interfaceInfos;
}
const IAILibraryManager::T_skirmishAIInfos& CAILibraryManager::GetSkirmishAIInfos() const {
return skirmishAIInfos;
}
const IAILibraryManager::T_dupInt& CAILibraryManager::GetDuplicateInterfaceInfos() const {
return duplicateInterfaceInfos;
}
const IAILibraryManager::T_dupSkirm& CAILibraryManager::GetDuplicateSkirmishAIInfos() const {
return duplicateSkirmishAIInfos;
}
std::vector<SkirmishAIKey> CAILibraryManager::FittingSkirmishAIKeys(
const SkirmishAIKey& skirmishAIKey) const {
std::vector<SkirmishAIKey> applyingKeys;
if (skirmishAIKey.IsUnspecified()) {
return applyingKeys;
}
bool checkVersion = false;
if (skirmishAIKey.GetVersion() != "") {
checkVersion = true;
}
std::set<SkirmishAIKey>::const_iterator sasi;
for (sasi = skirmishAIKeys.begin(); sasi != skirmishAIKeys.end(); ++sasi) {
// check if the ai name fits
if (skirmishAIKey.GetShortName() != sasi->GetShortName()) {
continue;
}
// check if the ai version fits (if one is specified)
if (checkVersion && skirmishAIKey.GetVersion() != sasi->GetVersion()) {
continue;
}
// if the programm raches here, we know that this key fits
applyingKeys.push_back(*sasi);
}
return applyingKeys;
}
const CSkirmishAILibrary* CAILibraryManager::FetchSkirmishAILibrary(const SkirmishAIKey& skirmishAIKey) {
const CSkirmishAILibrary* aiLib = NULL;
T_skirmishAIInfos::const_iterator aiInfo = skirmishAIInfos.find(skirmishAIKey);
if (aiInfo == skirmishAIInfos.end()) {
LOG_L(L_ERROR,
"Unknown skirmish AI specified: %s %s",
skirmishAIKey.GetShortName().c_str(),
skirmishAIKey.GetVersion().c_str()
);
} else {
CAIInterfaceLibrary* interfaceLib = FetchInterface(skirmishAIKey.GetInterface());
if ((interfaceLib != NULL) && interfaceLib->IsInitialized()) {
aiLib = interfaceLib->FetchSkirmishAILibrary(*(aiInfo->second));
}
}
return aiLib;
}
void CAILibraryManager::ReleaseSkirmishAILibrary(const SkirmishAIKey& skirmishAIKey) {
CAIInterfaceLibrary* interfaceLib = FetchInterface(skirmishAIKey.GetInterface());
if ((interfaceLib != NULL) && interfaceLib->IsInitialized()) {
interfaceLib->ReleaseSkirmishAILibrary(skirmishAIKey);
// only releases the library if its load count is 0
ReleaseInterface(skirmishAIKey.GetInterface());
} else {
// Not releasing, because the AI Interface is not initialized,
// and so neither was the AI.
}
}
void CAILibraryManager::ReleaseEverything() {
T_loadedInterfaces::const_iterator lil;
for (lil = loadedAIInterfaceLibraries.begin(); lil != loadedAIInterfaceLibraries.end(); ++lil) {
CAIInterfaceLibrary* interfaceLib = FetchInterface(lil->first);
if ((interfaceLib != NULL) && interfaceLib->IsInitialized()) {
interfaceLib->ReleaseAllSkirmishAILibraries();
// only releases the library if its load count is 0
ReleaseInterface(lil->first);
}
}
}
CAIInterfaceLibrary* CAILibraryManager::FetchInterface(const AIInterfaceKey& interfaceKey) {
CAIInterfaceLibrary* interfaceLib = NULL;
T_loadedInterfaces::const_iterator interfacePos = loadedAIInterfaceLibraries.find(interfaceKey);
if (interfacePos == loadedAIInterfaceLibraries.end()) { // interface not yet loaded
T_interfaceInfos::const_iterator interfaceInfo = interfaceInfos.find(interfaceKey);
if (interfaceInfo != interfaceInfos.end()) {
interfaceLib = new CAIInterfaceLibrary(*(interfaceInfo->second));
if (!interfaceLib->IsInitialized()) {
delete interfaceLib;
interfaceLib = NULL;
}
// storing this for later use, even if it is NULL (failed to init)
loadedAIInterfaceLibraries[interfaceKey] = interfaceLib;
} else {
// unavailable interface requested, returning NULL
}
} else {
interfaceLib = interfacePos->second;
}
return interfaceLib;
}
void CAILibraryManager::ReleaseInterface(const AIInterfaceKey& interfaceKey) {
T_loadedInterfaces::iterator interfacePos = loadedAIInterfaceLibraries.find(interfaceKey);
if (interfacePos != loadedAIInterfaceLibraries.end()) {
CAIInterfaceLibrary* interfaceLib = interfacePos->second;
if (interfaceLib->GetLoadCount() == 0) {
loadedAIInterfaceLibraries.erase(interfacePos);
delete interfaceLib;
interfaceLib = NULL;
}
}
}
AIInterfaceKey CAILibraryManager::FindFittingInterfaceSpecifier(
const std::string& shortName,
const std::string& minVersion,
const IAILibraryManager::T_interfaceSpecs& keys) {
std::set<AIInterfaceKey>::const_iterator key;
int minDiff = INT_MAX;
AIInterfaceKey fittingKey = AIInterfaceKey(); // unspecified key
for (key = keys.begin(); key != keys.end(); ++key) {
if (shortName == key->GetShortName()) {
int diff = IAILibraryManager::VersionCompare(key->GetVersion(), minVersion);
if (diff >= 0 && diff < minDiff) {
fittingKey = *key;
minDiff = diff;
}
}
}
return fittingKey;
}
|