AAIConfig.h

// -------------------------------------------------------------------------
// AAI
//
// A skirmish AI for the Spring engine.
// Copyright Alexander Seizinger
//
// Released under GPL license: see LICENSE.html for more information.
// -------------------------------------------------------------------------

#ifndef AAI_CONFIG_H
#define AAI_CONFIG_H

#include "LegacyCpp/IAICallback.h"

#include <stdio.h>
#include <list>
#include <vector>

using std::string;
using std::list;
using std::vector;

class AAI;

/// Converts a string to one that can be used in a file name (eg. "Abc.123 $%^*" -> "Abc.123_____")
std::string MakeFileSystemCompatible(const std::string& str);

class AAIConfig
{
public:

	//! @brief Return the configuration
	static AAIConfig* GetConfig() { return m_config; }

	//! @brief Initializes one instance of the configuration (if not already done - might be called multiple times)
	static void Init();

	//! @brief Deletes the configuration (if initialized)
	static void Delete();

	//! @brief Load configuration for specific game/mod from config file
	bool LoadGameConfig(AAI* ai);

	//! @brief Load general AAI config
	bool LoadGeneralConfig(AAI* ai);

	// mod specific
	int MIN_ENERGY;  // min energy make value to be considered beeing a power plant
	int MAX_UNITS;
	int MAX_SCOUTS;
	int MAX_XROW;
	int MAX_YROW;
	int X_SPACE;
	int Y_SPACE;
	int MAX_GROUP_SIZE;
	int MAX_AIR_GROUP_SIZE;
	int MAX_SUBMARINE_GROUP_SIZE;
	int MAX_NAVAL_GROUP_SIZE;
	int MAX_ANTI_AIR_GROUP_SIZE;
	int MAX_ARTY_GROUP_SIZE;

	int MAX_BUILDERS_PER_TYPE;
	int MAX_FACTORIES_PER_TYPE;
	int MAX_BUILDQUE_SIZE;
	int MAX_NANO_TURRETS_PER_SECTOR;
	int MAX_ASSISTANTS;
	int MIN_ASSISTANCE_BUILDTIME;
	int MAX_BASE_SIZE;
	float SCOUT_SPEED;
	float GROUND_ARTY_RANGE;
	float SEA_ARTY_RANGE;
	float HOVER_ARTY_RANGE;
	float STATIONARY_ARTY_RANGE;
	float AIRCRAFT_RATIO;
	float HIGH_RANGE_UNITS_RATIO;
	float FAST_UNITS_RATIO;

	int   MIN_ENERGY_STORAGE;
	int   MIN_METAL_STORAGE;
	float MIN_METAL_MAKER_ENERGY;

	//! Maximum number of economic targets (extractors, metal makers, storages)
	int   MAX_ECONOMY_TARGETS;

	//! Maximum number of military targets (long range artillery, missile launchers)
	int   MAX_MILITARY_TARGETS;

	//! The number of different sides (side 0 = neutral will be added)
	int numberOfSides;

	//! The names of the different sides
	std::vector<std::string> sideNames;

	//! The start units (i.e. commanders) for the different sides
	std::list<int> m_startUnits;

	//! A list of units that shall be considered to be scouts
	std::list<int> m_scouts;

	//! A list of units that shall be considered to be transport units
	std::list<int> m_transporters;

	//! A list of units that shall be considered to be metal makers
	std::list<int> m_metalMakers;

	//! A list of units that shall be considered to be bombers 
	std::list<int> m_bombers;

	//! A list of units that shall be considered to be melee combat units 
	std::list<int> m_meleeUnits;

	//! A list of units that shall be ignored (i.e. not assigned to any category and thus not used)
	std::list<int> m_ignoredUnits;

	//float KBOT_MAX_SLOPE;
	//float VEHICLE_MAX_SLOPE;
	//float HOVER_MAX_SLOPE;
	float NON_AMPHIB_MAX_WATERDEPTH;
	float METAL_ENERGY_RATIO;
	int   MAX_DEFENCES;
	int   MAX_STAT_ARTY;
	int   MAX_AIR_BASE;
	int   MAX_STORAGE;
	int   MAX_MEX_DISTANCE;
	int   MAX_MEX_DEFENCE_DISTANCE;

	int   MIN_FACTORIES_FOR_DEFENCES;
	int   MIN_FACTORIES_FOR_STORAGE;
	float MIN_AIR_SUPPORT_EFFICIENCY;
	float MAX_COST_LIGHT_ASSAULT;
	float MAX_COST_MEDIUM_ASSAULT;
	float MAX_COST_HEAVY_ASSAULT;

	//! Used to determine minimum number of bombers send vs. a given target; i.e. minNumber = targetHealth  / HEALTH_PER_BOMBER
	float HEALTH_PER_BOMBER;

	// combat behaviour
	float MIN_FALLBACK_TURNRATE; // units with lower turnrate will not try to fall back

	// internal
	float CLIFF_SLOPE;  // cells with greater slope will be considered to be cliffs

	// game specific
	int   LEARN_RATE;

	/**
	 * open a file in springs data directory
	 * @param filename relative path of the file in the spring data dir
	 * @param mode mode file to open, see manpage of fopen
	 */
	std::string GetFileName(springLegacyAI::IAICallback* cb, const std::string& filename, const std::string& prefix = "", const std::string& suffix = "", bool write = false) const;
	std::string GetUniqueName(springLegacyAI::IAICallback* cb, bool game, bool gamehash, bool map, bool maphash) const;

private:
	AAIConfig();

	//! The configuration (shared by all AAI instances)
	static AAIConfig* m_config;

	//! Indicates whether the game configuration has been loaded
	bool m_gameConfigurationLoaded;

	//! Indicates whether the general configuration has been loaded
	bool m_generalConfigurationLoaded;

	//! @brief Returns the unit definition for the unit with the given name (nullptr if not found)
	const springLegacyAI::UnitDef* GetUnitDef(AAI* ai, const std::string& name);

	//! @brief Reads one integer from the given file
	int ReadNextInteger(AAI* ai, FILE* file);

	//! @brief Read one float from the given file
	float ReadNextFloat(AAI* ai, FILE* file);

	//! @brief Read string from the given file
	std::string ReadNextString(AAI* ai, FILE* file);

	float WATER_MAP_RATIO;
	float LAND_WATER_MAP_RATIO;

	int MIN_FACTORIES_FOR_RADAR_JAMMER;
	int MAX_METAL_MAKERS;
	int MAX_BUILDERS;
};

//! global variable used for conveniece to easily access config
extern AAIConfig *cfg;


#endif