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
|
/* This file is part of the Spring engine (GPL v2 or later), see LICENSE.html */
#ifndef SKIRMISH_AI_LIBRARY_INFO_H
#define SKIRMISH_AI_LIBRARY_INFO_H
#include <vector>
#include <map>
#include <string>
class SkirmishAIKey;
struct Option;
class CSkirmishAILibraryInfo {
public:
CSkirmishAILibraryInfo(const CSkirmishAILibraryInfo& aiInfo);
/**
* This is used when initializing from purely Lua files
* (AIInfo.lua & AIOptions.lua).
*/
CSkirmishAILibraryInfo(const std::string& aiInfoFile,
const std::string& aiOptionFile = "");
/**
* This is used when initializing from data fetched through the AI Interface
* library plugin, through C functions.
*/
CSkirmishAILibraryInfo(const std::map<std::string, std::string>& aiInfo,
const std::string& aiOptionLua = "");
virtual ~CSkirmishAILibraryInfo();
virtual size_t size() const;
virtual const std::string& GetKeyAt(size_t index) const;
virtual const std::string& GetValueAt(size_t index) const;
virtual const std::string& GetDescriptionAt(size_t index) const;
virtual SkirmishAIKey GetKey() const;
virtual const std::string& GetDataDir() const;
virtual const std::string& GetDataDirCommon() const;
/** Restrictions: none of the following: spaces, '_', '#' */
virtual const std::string& GetShortName() const;
/** Restrictions: none of the following: spaces, '_', '#' */
virtual const std::string& GetVersion() const;
virtual const std::string& GetName() const;
virtual const std::string& GetDescription() const;
virtual const std::string& GetURL() const;
virtual bool IsLuaAI() const;
virtual const std::string& GetInterfaceShortName() const;
virtual const std::string& GetInterfaceVersion() const;
virtual const std::string& GetInfo(const std::string& key) const;
virtual void SetDataDir(const std::string& dataDir);
virtual void SetDataDirCommon(const std::string& dataDirCommon);
/** Restrictions: none of the following: spaces, '_', '#' */
virtual void SetShortName(const std::string& shortName);
/** Restrictions: none of the following: spaces, '_', '#' */
virtual void SetVersion(const std::string& version);
virtual void SetName(const std::string& name);
virtual void SetDescription(const std::string& description);
virtual void SetURL(const std::string& url);
virtual void SetLuaAI(const std::string& isLua);
virtual void SetLuaAI(const bool isLua);
virtual void SetInterfaceShortName(const std::string& interfaceShortName);
virtual void SetInterfaceVersion(const std::string& interfaceVersion);
virtual bool SetInfo(const std::string& key, const std::string& value,
const std::string& description = "");
virtual const std::vector<Option>& GetOptions() const;
private:
// for having a well defined order
std::vector<std::string> info_keys;
std::map<std::string, std::string> info_keyLower_key;
std::map<std::string, std::string> info_key_value;
std::map<std::string, std::string> info_key_description;
std::vector<Option> options;
};
#endif // SKIRMISH_AI_LIBRARY_INFO_H
|