/* This file is part of the Spring engine (GPL v2 or later), see LICENSE.html */

#ifndef AI_INTERFACE_LIBRARY_INFO_H
#define AI_INTERFACE_LIBRARY_INFO_H

#include <vector>
#include <map>
#include <string>

class AIInterfaceKey;

class CAIInterfaceLibraryInfo {
public:
	CAIInterfaceLibraryInfo(const CAIInterfaceLibraryInfo& interfaceInfo);
	CAIInterfaceLibraryInfo(const std::string& interfaceInfoFile);
	virtual ~CAIInterfaceLibraryInfo();

	//virtual LevelOfSupport GetLevelOfSupportForCurrentEngine() const;

	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 AIInterfaceKey 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 IsLookupSupported() 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 bool SetInfo(const std::string& key, const std::string& value,
			const std::string& description = "");

private:
	// for having a well defined order
	std::vector<std::string> keys;
	std::map<std::string, std::string> keyLower_key;
	std::map<std::string, std::string> key_value;
	std::map<std::string, std::string> key_description;
};

#endif // AI_INTERFACE_LIBRARY_INFO_H
