SpringUnitSyncLib Class Reference

Primitive class handeling the unitsync library. More...

#include <springunitsynclib.h>

Public Member Functions

 SpringUnitSyncLib ()
 Constructor.
 ~SpringUnitSyncLib ()
 Destructor, unloads unitsync if loaded.
void Load (const wxString &path, const wxString &ForceConfigFilePath)
 Loads the unitsync library from path.
void Unload ()
 Unload the unitsync library.
bool IsLoaded () const
 Returns true if the library is loaded.
void AssertUnitsyncOk () const
 Gets last error from unitsync library.
wxArrayString GetUnitsyncErrors () const
 Get list of errors from unitsync library in an array.
bool VersionSupports (SpringUnitSync::GameFeature feature) const
int GetModIndex (const wxString &name)
wxString GetSpringVersion ()
std::map< wxString, wxString > GetSpringVersionList (const std::map< wxString, wxString > &usync_paths)
 Loads unitsync from any number of paths in succession, queries the Spring versions supported by these unitsyncs, and returns those.
wxString GetSpringDataDir ()
int GetSpringDataDirCount ()
wxString GetSpringDataDirByIndex (const int index)
wxString GetConfigFilePath ()
int GetMapCount ()
wxString GetMapChecksum (int index)
wxString GetMapName (int index)
int GetMapArchiveCount (int index)
wxString GetMapArchiveName (int arnr)
wxArrayString GetMapDeps (int index)
MapInfo GetMapInfoEx (int index, int version)
 Get information about a map.
wxImage GetMinimap (const wxString &mapFileName)
 Get minimap.
wxImage GetMetalmap (const wxString &mapFileName)
 Get metalmap.
wxImage GetHeightmap (const wxString &mapFileName)
 Get heightmap.
wxString GetPrimaryModChecksum (int index)
int GetPrimaryModIndex (const wxString &modName)
wxString GetPrimaryModName (int index)
int GetPrimaryModCount ()
wxString GetPrimaryModArchive (int index)
wxString GetPrimaryModShortName (int index)
wxString GetPrimaryModVersion (int index)
wxString GetPrimaryModMutator (int index)
wxString GetPrimaryModGame (int index)
wxString GetPrimaryModShortGame (int index)
wxString GetPrimaryModDescription (int index)
int GetPrimaryModArchiveCount (int index)
wxString GetPrimaryModArchiveList (int arnr)
wxString GetPrimaryModChecksumFromName (const wxString &name)
wxArrayString GetModDeps (int index)
wxArrayString GetSides (const wxString &modName)
void AddAllArchives (const wxString &root)
 Add all achives.
void SetCurrentMod (const wxString &modname)
void UnSetCurrentMod ()
wxString GetFullUnitName (int index)
wxString GetUnitName (int index)
int GetUnitCount ()
int ProcessUnitsNoChecksum ()
wxArrayString FindFilesVFS (const wxString &name)
 Search for a file pattern.
int OpenFileVFS (const wxString &name)
int FileSizeVFS (int handle)
int ReadFileVFS (int handle, void *buffer, int bufferLength)
void CloseFileVFS (int handle)
int GetLuaAICount (const wxString &modname)
wxString GetLuaAIName (int aiIndex)
wxString GetLuaAIDesc (int aiIndex)
unsigned int GetValidMapCount (const wxString &modname)
wxString GetValidMapName (unsigned int MapIndex)
int GetMapOptionCount (const wxString &name)
int GetCustomOptionCount (const wxString &modname, const wxString &filename)
int GetModOptionCount (const wxString &name)
int GetAIOptionCount (const wxString &modname, int index)
wxString GetOptionKey (int optIndex)
wxString GetOptionName (int optIndex)
wxString GetOptionDesc (int optIndex)
wxString GetOptionSection (int optIndex)
wxString GetOptionStyle (int optIndex)
int GetOptionType (int optIndex)
int GetOptionBoolDef (int optIndex)
float GetOptionNumberDef (int optIndex)
float GetOptionNumberMin (int optIndex)
float GetOptionNumberMax (int optIndex)
float GetOptionNumberStep (int optIndex)
wxString GetOptionStringDef (int optIndex)
int GetOptionStringMaxLen (int optIndex)
int GetOptionListCount (int optIndex)
wxString GetOptionListDef (int optIndex)
wxString GetOptionListItemKey (int optIndex, int itemIndex)
wxString GetOptionListItemName (int optIndex, int itemIndex)
wxString GetOptionListItemDesc (int optIndex, int itemIndex)
int OpenArchive (const wxString &name)
void CloseArchive (int archive)
int FindFilesArchive (int archive, int cur, wxString &nameBuf)
int OpenArchiveFile (int archive, const wxString &name)
int ReadArchiveFile (int archive, int handle, void *buffer, int numBytes)
void CloseArchiveFile (int archive, int handle)
int SizeArchiveFile (int archive, int handle)
wxString GetArchivePath (const wxString &name)
int GetSpringConfigInt (const wxString &key, int defValue)
wxString GetSpringConfigString (const wxString &key, const wxString &defValue)
float GetSpringConfigFloat (const wxString &key, const float defValue)
void SetSpringConfigString (const wxString &key, const wxString &value)
void SetSpringConfigInt (const wxString &key, int value)
void SetSpringConfigFloat (const wxString &key, const float value)
int GetSkirmishAICount (const wxString &modname)
 AI info.
wxArrayString GetAIInfo (int index)
 Get next search result.
wxString GetArchiveChecksum (const wxString &VFSPath)
void CloseParser ()
 lua parser
bool OpenParserFile (const wxString &filename, const wxString &filemodes, const wxString &accessModes)
bool OpenParserSource (const wxString &source, const wxString &accessModes)
bool ParserExecute ()
wxString ParserErrorLog ()
void ParserAddTable (int key, bool override)
void ParserAddTable (const wxString &key, bool override)
void ParserEndTable ()
void ParserAddTableValue (int key, int val)
void ParserAddTableValue (const wxString &key, int val)
void ParserAddTableValue (int key, bool val)
void ParserAddTableValue (const wxString &key, bool val)
void ParserAddTableValue (int key, const wxString &val)
void ParserAddTableValue (const wxString &key, const wxString &val)
void ParserAddTableValue (int key, float val)
void ParserAddTableValue (const wxString &key, float val)
bool ParserGetRootTable ()
bool ParserGetRootTableExpression (const wxString &exp)
bool ParserGetSubTableInt (int key)
bool ParserGetSubTableString (const wxString &key)
bool ParserGetSubTableInt (const wxString &exp)
void ParserPopTable ()
bool ParserKeyExists (int key)
bool ParserKeyExists (const wxString &key)
int ParserGetKeyType (int key)
int ParserGetKeyType (const wxString &key)
int ParserGetIntKeyListCount ()
int ParserGetIntKeyListEntry (int index)
int ParserGetStringKeyListCount ()
int ParserGetStringKeyListEntry (int index)
int GetKeyValue (int key, int defval)
bool GetKeyValue (int key, bool defval)
wxString GetKeyValue (int key, const wxString &defval)
float GetKeyValue (int key, float defval)
int GetKeyValue (const wxString &key, int defval)
bool GetKeyValue (const wxString &key, bool defval)
wxString GetKeyValue (const wxString &key, const wxString &defval)
float GetKeyValue (const wxString &key, float defval)

Protected Member Functions

 SpringUnitSyncLib (const SpringUnitSyncLib &)
void _Load (const wxString &path)
 Loads the unitsync library from path.
void _Init ()
 Initializes unitsync.
void _RemoveAllArchives ()
 Calls RemoveAllArchives if available, _Init() otherwise.
void _Unload ()
 Internal Unload() function.
bool _IsLoaded () const
 Returns true if the library is loaded.
void _ConvertSpringMapInfo (const SpringMapInfo &in, MapInfo &out)
void _SetCurrentMod (const wxString &modname)

Protected Attributes

bool m_loaded
 Keeps track if unitsync is loaded or not.
wxDynamicLibrary * m_libhandle
 Handle to the unitsync library.
wxCriticalSection m_lock
 Critical section controlling access to unitsync functions.
wxString m_path
 Path to unitsync.
wxString m_current_mod
 the current loaded mod.
InitPtr m_init
UnInitPtr m_uninit
GetNextErrorPtr m_get_next_error
GetWritableDataDirectoryPtr m_get_writeable_data_dir
GetDataDirectoryPtr m_get_data_dir_by_index
GetDataDirectoryCountPtr m_get_data_dir_count
GetMapCountPtr m_get_map_count
GetMapChecksumPtr m_get_map_checksum
GetMapNamePtr m_get_map_name
GetMapDescriptionPtr m_get_map_description
GetMapAuthorPtr m_get_map_author
GetMapWidthPtr m_get_map_width
GetMapHeightPtr m_get_map_height
GetMapTidalStrengthPtr m_get_map_tidalStrength
GetMapWindMinPtr m_get_map_windMin
GetMapWindMaxPtr m_get_map_windMax
GetMapGravityPtr m_get_map_gravity
GetMapResourceCountPtr m_get_map_resource_count
GetMapResourceNamePtr m_get_map_resource_name
GetMapResourceMaxPtr m_get_map_resource_max
GetMapResourceExtractorRadiusPtr m_get_map_resource_extractorRadius
GetMapPosCountPtr m_get_map_pos_count
GetMapPosXPtr m_get_map_pos_x
GetMapPosZPtr m_get_map_pos_z
GetMapInfoExPtr m_get_map_info_ex
GetMinimapPtr m_get_minimap
GetInfoMapSizePtr m_get_infomap_size
GetInfoMapPtr m_get_infomap
GetPrimaryModChecksumPtr m_get_mod_checksum
GetPrimaryModIndexPtr m_get_mod_index
GetPrimaryModNamePtr m_get_mod_name
GetPrimaryModCountPtr m_get_mod_count
GetPrimaryModArchivePtr m_get_mod_archive
GetSideCountPtr m_get_side_count
GetSideNamePtr m_get_side_name
AddAllArchivesPtr m_add_all_archives
RemoveAllArchivesPtr m_remove_all_archives
GetUnitCountPtr m_get_unit_count
GetUnitNamePtr m_get_unit_name
GetFullUnitNamePtr m_get_unit_full_name
ProcessUnitsNoChecksumPtr m_proc_units_nocheck
InitFindVFSPtr m_init_find_vfs
FindFilesVFSPtr m_find_files_vfs
OpenFileVFSPtr m_open_file_vfs
FileSizeVFSPtr m_file_size_vfs
ReadFileVFSPtr m_read_file_vfs
CloseFileVFSPtr m_close_file_vfs
GetSpringVersionPtr m_get_spring_version
ProcessUnitsPtr m_process_units
AddArchivePtr m_add_archive
GetArchiveChecksumPtr m_get_archive_checksum
GetArchivePathPtr m_get_archive_path
GetMapArchiveCountPtr m_get_map_archive_count
GetMapArchiveNamePtr m_get_map_archive_name
GetMapChecksumFromNamePtr m_get_map_checksum_from_name
GetPrimaryModShortNamePtr m_get_primary_mod_short_name
GetPrimaryModVersionPtr m_get_primary_mod_version
GetPrimaryModMutatorPtr m_get_primary_mod_mutator
GetPrimaryModGamePtr m_get_primary_mod_game
GetPrimaryModShortGamePtr m_get_primary_mod_short_game
GetPrimaryModDescriptionPtr m_get_primary_mod_description
GetPrimaryModArchivePtr m_get_primary_mod_archive
GetPrimaryModArchiveCountPtr m_get_primary_mod_archive_count
GetPrimaryModArchiveListPtr m_get_primary_mod_archive_list
GetPrimaryModChecksumFromNamePtr m_get_primary_mod_checksum_from_name
GetModValidMapCountPtr m_get_mod_valid_map_count
GetModValidMapPtr m_get_valid_map
GetLuaAICountPtr m_get_luaai_count
GetLuaAINamePtr m_get_luaai_name
GetLuaAIDescPtr m_get_luaai_desc
GetMapOptionCountPtr m_get_map_option_count
GetCustomOptionCountPtr m_get_custom_option_count
GetModOptionCountPtr m_get_mod_option_count
GetSkirmishAIOptionCountPtr m_get_skirmish_ai_option_count
GetOptionKeyPtr m_get_option_key
GetOptionNamePtr m_get_option_name
GetOptionDescPtr m_get_option_desc
GetOptionTypePtr m_get_option_type
GetOptionSectionPtr m_get_option_section
GetOptionStylePtr m_get_option_style
GetOptionBoolDefPtr m_get_option_bool_def
GetOptionNumberDefPtr m_get_option_number_def
GetOptionNumberMinPtr m_get_option_number_min
GetOptionNumberMaxPtr m_get_option_number_max
GetOptionNumberStepPtr m_get_option_number_step
GetOptionStringDefPtr m_get_option_string_def
GetOptionStringMaxLenPtr m_get_option_string_max_len
GetOptionListCountPtr m_get_option_list_count
GetOptionListDefPtr m_get_option_list_def
GetOptionListItemKeyPtr m_get_option_list_item_key
GetOptionListItemNamePtr m_get_option_list_item_name
GetOptionListItemDescPtr m_get_option_list_item_desc
OpenArchivePtr m_open_archive
CloseArchivePtr m_close_archive
FindFilesArchivePtr m_find_Files_archive
OpenArchiveFilePtr m_open_archive_file
ReadArchiveFilePtr m_read_archive_file
CloseArchiveFilePtr m_close_archive_file
SizeArchiveFilePtr m_size_archive_file
SetSpringConfigFilePtr m_set_spring_config_file_path
GetSpringConfigFilePtr m_get_spring_config_file_path
SetSpringConfigFloatPtr m_set_spring_config_float
GetSpringConfigFloatPtr m_get_spring_config_float
GetSpringConfigIntPtr m_get_spring_config_int
GetSpringConfigStringPtr m_get_spring_config_string
SetSpringConfigStringPtr m_set_spring_config_string
SetSpringConfigIntPtr m_set_spring_config_int
GetSkirmishAICountPtr m_get_skirmish_ai_count
GetSkirmishAIInfoCountPtr m_get_skirmish_ai_info_count
GetInfoKeyPtr m_get_skirmish_ai_info_key
GetInfoValuePtr m_get_skirmish_ai_info_value
GetInfoDescriptionPtr m_get_skirmish_ai_info_description
lpClosePtr m_parser_close
lpOpenFilePtr m_parser_open_file
lpOpenSourcePtr m_parser_open_source
lpExecutePtr m_parser_execute
lpErrorLogPtr m_parser_error_log
lpAddTableIntPtr m_parser_add_table_int
lpAddTableStrPtr m_parser_add_table_string
lpEndTablePtr m_parser_end_table
lpAddIntKeyIntValPtr m_parser_add_int_key_int_value
lpAddStrKeyIntValPtr m_parser_add_string_key_int_value
lpAddIntKeyBoolValPtr m_parser_add_int_key_bool_value
lpAddStrKeyBoolValPtr m_parser_add_string_key_bool_value
lpAddIntKeyFloatValPtr m_parser_add_int_key_float_value
lpAddStrKeyFloatValPtr m_parser_add_string_key_float_value
lpAddIntKeyStrValPtr m_parser_add_int_key_string_value
lpAddStrKeyStrValPtr m_parser_add_string_key_string_value
lpRootTablePtr m_parser_root_table
lpRootTableExprPtr m_parser_root_table_expression
lpSubTableIntPtr m_parser_sub_table_int
lpSubTableStrPtr m_parser_sub_table_string
lpSubTableExprPtr m_parser_sub_table_expression
lpPopTablePtr m_parser_pop_table
lpGetKeyExistsIntPtr m_parser_key_int_exists
lpGetKeyExistsStrPtr m_parser_key_string_exists
lpGetIntKeyTypePtr m_parser_int_key_get_type
lpGetStrKeyTypePtr m_parser_string_key_get_type
lpGetIntKeyListCountPtr m_parser_int_key_get_list_count
lpGetIntKeyListEntryPtr m_parser_int_key_get_list_entry
lpGetStrKeyListCountPtr m_parser_string_key_get_list_count
lpGetStrKeyListEntryPtr m_parser_string_key_get_list_entry
lpGetIntKeyIntValPtr m_parser_int_key_get_int_value
lpGetStrKeyIntValPtr m_parser_string_key_get_int_value
lpGetIntKeyBoolValPtr m_parser_int_key_get_bool_value
lpGetStrKeyBoolValPtr m_parser_string_key_get_bool_value
lpGetIntKeyFloatValPtr m_parser_int_key_get_float_value
lpGetStrKeyFloatValPtr m_parser_string_key_get_float_value
lpGetIntKeyStrValPtr m_parser_int_key_get_string_value
lpGetStrKeyStrValPtr m_parser_string_key_get_string_value

Detailed Description

Primitive class handeling the unitsync library.

This class is - in a limited way - thread safe but may block execution in case two threads use it at the same time. The thread safety ensures there can never be multiple threads executing unitsync functions at the same time. However, many unitsync functions use (hidden) global state, so often there is a need for running multiple unitsync methods while holding a single lock continuously.

Definition at line 242 of file springunitsynclib.h.

Constructor & Destructor Documentation

SpringUnitSyncLib::SpringUnitSyncLib (  ) 

Constructor.

Definition at line 26 of file springunitsynclib.cpp.

SpringUnitSyncLib::~SpringUnitSyncLib (  ) 

Destructor, unloads unitsync if loaded.

Definition at line 36 of file springunitsynclib.cpp.

SpringUnitSyncLib::SpringUnitSyncLib ( const SpringUnitSyncLib &   )  [protected]

Member Function Documentation

void SpringUnitSyncLib::_ConvertSpringMapInfo ( const SpringMapInfo &  in,
MapInfo &  out 
) [protected]

Definition at line 473 of file springunitsynclib.cpp.

void SpringUnitSyncLib::_Init (  )  [protected]

Initializes unitsync.

Definition at line 353 of file springunitsynclib.cpp.

bool SpringUnitSyncLib::_IsLoaded (  )  const [protected]

Returns true if the library is loaded.

Internal.

Definition at line 421 of file springunitsynclib.cpp.

void SpringUnitSyncLib::_Load ( const wxString &  path  )  [protected]

Loads the unitsync library from path.

Note:
this function is not threadsafe if called from code not locked.
See also:
Load()

Definition at line 101 of file springunitsynclib.cpp.

void SpringUnitSyncLib::_RemoveAllArchives (  )  [protected]

Calls RemoveAllArchives if available, _Init() otherwise.

Definition at line 376 of file springunitsynclib.cpp.

void SpringUnitSyncLib::_SetCurrentMod ( const wxString &  modname  )  [protected]

Definition at line 500 of file springunitsynclib.cpp.

void SpringUnitSyncLib::_Unload (  )  [protected]

Internal Unload() function.

Note:
this function is not threadsafe if called from code not locked.
See also:
Unload()

Definition at line 394 of file springunitsynclib.cpp.

void SpringUnitSyncLib::AddAllArchives ( const wxString &  root  ) 

Add all achives.

Note:
Not sure what this does, but adding the mod archive path to this when setting new mod seems to work :)

Definition at line 988 of file springunitsynclib.cpp.

void SpringUnitSyncLib::AssertUnitsyncOk (  )  const

Gets last error from unitsync library.

Note:
throws unitsync_assert in case of error
this method should only be used after using directly an unitsync call to catch it's errors

Definition at line 427 of file springunitsynclib.cpp.

void SpringUnitSyncLib::CloseArchive ( int  archive  ) 

Definition at line 1311 of file springunitsynclib.cpp.

void SpringUnitSyncLib::CloseArchiveFile ( int  archive,
int  handle 
)

Definition at line 1349 of file springunitsynclib.cpp.

void SpringUnitSyncLib::CloseFileVFS ( int  handle  ) 

Definition at line 1072 of file springunitsynclib.cpp.

void SpringUnitSyncLib::CloseParser (  ) 

lua parser

Definition at line 1459 of file springunitsynclib.cpp.

int SpringUnitSyncLib::FileSizeVFS ( int  handle  ) 

Definition at line 1056 of file springunitsynclib.cpp.

int SpringUnitSyncLib::FindFilesArchive ( int  archive,
int  cur,
wxString &  nameBuf 
)

Definition at line 1319 of file springunitsynclib.cpp.

wxArrayString SpringUnitSyncLib::FindFilesVFS ( const wxString &  name  ) 

Search for a file pattern.

Parameters:
the search patterns
Returns:
wxarraystring of results

Definition at line 1028 of file springunitsynclib.cpp.

wxArrayString SpringUnitSyncLib::GetAIInfo ( int  index  ) 

Get next search result.

Parameters:
the AI index within range of GetSkirmishAIInfoCount
Returns:
an array made of blocks with this layout { key, value, description }

Definition at line 1430 of file springunitsynclib.cpp.

int SpringUnitSyncLib::GetAIOptionCount ( const wxString &  modname,
int  index 
)

Definition at line 1149 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetArchiveChecksum ( const wxString &  VFSPath  ) 

Definition at line 1451 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetArchivePath ( const wxString &  name  ) 

Definition at line 1365 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetConfigFilePath (  ) 

Definition at line 603 of file springunitsynclib.cpp.

int SpringUnitSyncLib::GetCustomOptionCount ( const wxString &  modname,
const wxString &  filename 
)

Definition at line 1129 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetFullUnitName ( int  index  ) 

Definition at line 996 of file springunitsynclib.cpp.

wxImage SpringUnitSyncLib::GetHeightmap ( const wxString &  mapFileName  ) 

Get heightmap.

Note:
Throws assert_exception if unsuccesful.

Definition at line 782 of file springunitsynclib.cpp.

float SpringUnitSyncLib::GetKeyValue ( const wxString &  key,
float  defval 
)

Definition at line 1725 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetKeyValue ( const wxString &  key,
const wxString &  defval 
)

Definition at line 1718 of file springunitsynclib.cpp.

bool SpringUnitSyncLib::GetKeyValue ( const wxString &  key,
bool  defval 
)

Definition at line 1711 of file springunitsynclib.cpp.

int SpringUnitSyncLib::GetKeyValue ( const wxString &  key,
int  defval 
)

Definition at line 1704 of file springunitsynclib.cpp.

float SpringUnitSyncLib::GetKeyValue ( int  key,
float  defval 
)

Definition at line 1697 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetKeyValue ( int  key,
const wxString &  defval 
)

Definition at line 1690 of file springunitsynclib.cpp.

bool SpringUnitSyncLib::GetKeyValue ( int  key,
bool  defval 
)

Definition at line 1683 of file springunitsynclib.cpp.

int SpringUnitSyncLib::GetKeyValue ( int  key,
int  defval 
)

Definition at line 1676 of file springunitsynclib.cpp.

int SpringUnitSyncLib::GetLuaAICount ( const wxString &  modname  ) 

Definition at line 1080 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetLuaAIDesc ( int  aiIndex  ) 

Definition at line 1097 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetLuaAIName ( int  aiIndex  ) 

Definition at line 1089 of file springunitsynclib.cpp.

int SpringUnitSyncLib::GetMapArchiveCount ( int  index  ) 

Definition at line 635 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetMapArchiveName ( int  arnr  ) 

Definition at line 643 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetMapChecksum ( int  index  ) 

Definition at line 619 of file springunitsynclib.cpp.

int SpringUnitSyncLib::GetMapCount (  ) 

Definition at line 611 of file springunitsynclib.cpp.

wxArrayString SpringUnitSyncLib::GetMapDeps ( int  index  ) 

Definition at line 651 of file springunitsynclib.cpp.

MapInfo SpringUnitSyncLib::GetMapInfoEx ( int  index,
int  version 
)

Get information about a map.

Parameters:
version will get author if >=1.
Note:
Throws assert_exception if unsuccessful.

Definition at line 663 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetMapName ( int  index  ) 

Definition at line 627 of file springunitsynclib.cpp.

int SpringUnitSyncLib::GetMapOptionCount ( const wxString &  name  ) 

Definition at line 1121 of file springunitsynclib.cpp.

wxImage SpringUnitSyncLib::GetMetalmap ( const wxString &  mapFileName  ) 

Get metalmap.

Note:
Throws assert_exception if unsuccessful.

Definition at line 753 of file springunitsynclib.cpp.

wxImage SpringUnitSyncLib::GetMinimap ( const wxString &  mapFileName  ) 

Get minimap.

Note:
Throws assert_exception if unsuccessful.

Definition at line 725 of file springunitsynclib.cpp.

wxArrayString SpringUnitSyncLib::GetModDeps ( int  index  ) 

Definition at line 963 of file springunitsynclib.cpp.

int SpringUnitSyncLib::GetModIndex ( const wxString &  name  ) 

Definition at line 520 of file springunitsynclib.cpp.

int SpringUnitSyncLib::GetModOptionCount ( const wxString &  name  ) 

Definition at line 1139 of file springunitsynclib.cpp.

int SpringUnitSyncLib::GetOptionBoolDef ( int  optIndex  ) 

Definition at line 1207 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetOptionDesc ( int  optIndex  ) 

Definition at line 1177 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetOptionKey ( int  optIndex  ) 

Definition at line 1161 of file springunitsynclib.cpp.

int SpringUnitSyncLib::GetOptionListCount ( int  optIndex  ) 

Definition at line 1263 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetOptionListDef ( int  optIndex  ) 

Definition at line 1271 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetOptionListItemDesc ( int  optIndex,
int  itemIndex 
)

Definition at line 1295 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetOptionListItemKey ( int  optIndex,
int  itemIndex 
)

Definition at line 1279 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetOptionListItemName ( int  optIndex,
int  itemIndex 
)

Definition at line 1287 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetOptionName ( int  optIndex  ) 

Definition at line 1169 of file springunitsynclib.cpp.

float SpringUnitSyncLib::GetOptionNumberDef ( int  optIndex  ) 

Definition at line 1215 of file springunitsynclib.cpp.

float SpringUnitSyncLib::GetOptionNumberMax ( int  optIndex  ) 

Definition at line 1231 of file springunitsynclib.cpp.

float SpringUnitSyncLib::GetOptionNumberMin ( int  optIndex  ) 

Definition at line 1223 of file springunitsynclib.cpp.

float SpringUnitSyncLib::GetOptionNumberStep ( int  optIndex  ) 

Definition at line 1239 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetOptionSection ( int  optIndex  ) 

Definition at line 1184 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetOptionStringDef ( int  optIndex  ) 

Definition at line 1247 of file springunitsynclib.cpp.

int SpringUnitSyncLib::GetOptionStringMaxLen ( int  optIndex  ) 

Definition at line 1255 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetOptionStyle ( int  optIndex  ) 

Definition at line 1191 of file springunitsynclib.cpp.

int SpringUnitSyncLib::GetOptionType ( int  optIndex  ) 

Definition at line 1199 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetPrimaryModArchive ( int  index  ) 

Definition at line 880 of file springunitsynclib.cpp.

int SpringUnitSyncLib::GetPrimaryModArchiveCount ( int  index  ) 

Definition at line 939 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetPrimaryModArchiveList ( int  arnr  ) 

Definition at line 947 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetPrimaryModChecksum ( int  index  ) 

Definition at line 848 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetPrimaryModChecksumFromName ( const wxString &  name  ) 

Definition at line 955 of file springunitsynclib.cpp.

int SpringUnitSyncLib::GetPrimaryModCount (  ) 

Definition at line 872 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetPrimaryModDescription ( int  index  ) 

Definition at line 931 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetPrimaryModGame ( int  index  ) 

Definition at line 915 of file springunitsynclib.cpp.

int SpringUnitSyncLib::GetPrimaryModIndex ( const wxString &  modName  ) 

Definition at line 856 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetPrimaryModMutator ( int  index  ) 

Definition at line 907 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetPrimaryModName ( int  index  ) 

Definition at line 864 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetPrimaryModShortGame ( int  index  ) 

Definition at line 923 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetPrimaryModShortName ( int  index  ) 

Definition at line 891 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetPrimaryModVersion ( int  index  ) 

Definition at line 899 of file springunitsynclib.cpp.

wxArrayString SpringUnitSyncLib::GetSides ( const wxString &  modName  ) 

Definition at line 975 of file springunitsynclib.cpp.

int SpringUnitSyncLib::GetSkirmishAICount ( const wxString &  modname  ) 

AI info.

Definition at line 1421 of file springunitsynclib.cpp.

float SpringUnitSyncLib::GetSpringConfigFloat ( const wxString &  key,
const float  defValue 
)

Definition at line 1389 of file springunitsynclib.cpp.

int SpringUnitSyncLib::GetSpringConfigInt ( const wxString &  key,
int  defValue 
)

Definition at line 1373 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetSpringConfigString ( const wxString &  key,
const wxString &  defValue 
)

Definition at line 1381 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetSpringDataDir (  ) 

Definition at line 582 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetSpringDataDirByIndex ( const int  index  ) 

Definition at line 596 of file springunitsynclib.cpp.

int SpringUnitSyncLib::GetSpringDataDirCount (  ) 

Definition at line 589 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetSpringVersion (  ) 

Definition at line 575 of file springunitsynclib.cpp.

std::map< wxString, wxString > SpringUnitSyncLib::GetSpringVersionList ( const std::map< wxString, wxString > &  usync_paths  ) 

Loads unitsync from any number of paths in succession, queries the Spring versions supported by these unitsyncs, and returns those.

This is done by a single function because this "transaction" needs to hold the unitsync lock the entire time.

Definition at line 526 of file springunitsynclib.cpp.

int SpringUnitSyncLib::GetUnitCount (  ) 

Definition at line 1012 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetUnitName ( int  index  ) 

Definition at line 1004 of file springunitsynclib.cpp.

wxArrayString SpringUnitSyncLib::GetUnitsyncErrors (  )  const

Get list of errors from unitsync library in an array.

Definition at line 435 of file springunitsynclib.cpp.

unsigned int SpringUnitSyncLib::GetValidMapCount ( const wxString &  modname  ) 

Definition at line 1104 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::GetValidMapName ( unsigned int  MapIndex  ) 

Definition at line 1113 of file springunitsynclib.cpp.

bool SpringUnitSyncLib::IsLoaded (  )  const

Returns true if the library is loaded.

Definition at line 415 of file springunitsynclib.cpp.

void SpringUnitSyncLib::Load ( const wxString &  path,
const wxString &  ForceConfigFilePath 
)

Loads the unitsync library from path.

Parameters:
path path to the unitsync lib.
ForceConfigFilePath if set forces unitsync to use pointed config file, if empty leaves to spring's default
See also:
Unload().
Note:
Throws runtime_error if load failed.

Definition at line 50 of file springunitsynclib.cpp.

int SpringUnitSyncLib::OpenArchive ( const wxString &  name  ) 

Definition at line 1303 of file springunitsynclib.cpp.

int SpringUnitSyncLib::OpenArchiveFile ( int  archive,
const wxString &  name 
)

Definition at line 1333 of file springunitsynclib.cpp.

int SpringUnitSyncLib::OpenFileVFS ( const wxString &  name  ) 

Definition at line 1048 of file springunitsynclib.cpp.

bool SpringUnitSyncLib::OpenParserFile ( const wxString &  filename,
const wxString &  filemodes,
const wxString &  accessModes 
)

Definition at line 1467 of file springunitsynclib.cpp.

bool SpringUnitSyncLib::OpenParserSource ( const wxString &  source,
const wxString &  accessModes 
)

Definition at line 1474 of file springunitsynclib.cpp.

void SpringUnitSyncLib::ParserAddTable ( const wxString &  key,
bool  override 
)

Definition at line 1503 of file springunitsynclib.cpp.

void SpringUnitSyncLib::ParserAddTable ( int  key,
bool  override 
)

Definition at line 1496 of file springunitsynclib.cpp.

void SpringUnitSyncLib::ParserAddTableValue ( const wxString &  key,
float  val 
)

Definition at line 1566 of file springunitsynclib.cpp.

void SpringUnitSyncLib::ParserAddTableValue ( int  key,
float  val 
)

Definition at line 1559 of file springunitsynclib.cpp.

void SpringUnitSyncLib::ParserAddTableValue ( const wxString &  key,
const wxString &  val 
)

Definition at line 1552 of file springunitsynclib.cpp.

void SpringUnitSyncLib::ParserAddTableValue ( int  key,
const wxString &  val 
)

Definition at line 1545 of file springunitsynclib.cpp.

void SpringUnitSyncLib::ParserAddTableValue ( const wxString &  key,
bool  val 
)

Definition at line 1538 of file springunitsynclib.cpp.

void SpringUnitSyncLib::ParserAddTableValue ( int  key,
bool  val 
)

Definition at line 1531 of file springunitsynclib.cpp.

void SpringUnitSyncLib::ParserAddTableValue ( const wxString &  key,
int  val 
)

Definition at line 1524 of file springunitsynclib.cpp.

void SpringUnitSyncLib::ParserAddTableValue ( int  key,
int  val 
)

Definition at line 1517 of file springunitsynclib.cpp.

void SpringUnitSyncLib::ParserEndTable (  ) 

Definition at line 1510 of file springunitsynclib.cpp.

wxString SpringUnitSyncLib::ParserErrorLog (  ) 

Definition at line 1488 of file springunitsynclib.cpp.

bool SpringUnitSyncLib::ParserExecute (  ) 

Definition at line 1481 of file springunitsynclib.cpp.

int SpringUnitSyncLib::ParserGetIntKeyListCount (  ) 

Definition at line 1647 of file springunitsynclib.cpp.

int SpringUnitSyncLib::ParserGetIntKeyListEntry ( int  index  ) 

Definition at line 1654 of file springunitsynclib.cpp.

int SpringUnitSyncLib::ParserGetKeyType ( const wxString &  key  ) 

Definition at line 1639 of file springunitsynclib.cpp.

int SpringUnitSyncLib::ParserGetKeyType ( int  key  ) 

Definition at line 1632 of file springunitsynclib.cpp.

bool SpringUnitSyncLib::ParserGetRootTable (  ) 

Definition at line 1574 of file springunitsynclib.cpp.

bool SpringUnitSyncLib::ParserGetRootTableExpression ( const wxString &  exp  ) 

Definition at line 1581 of file springunitsynclib.cpp.

int SpringUnitSyncLib::ParserGetStringKeyListCount (  ) 

Definition at line 1661 of file springunitsynclib.cpp.

int SpringUnitSyncLib::ParserGetStringKeyListEntry ( int  index  ) 

Definition at line 1668 of file springunitsynclib.cpp.

bool SpringUnitSyncLib::ParserGetSubTableInt ( const wxString &  exp  ) 

Definition at line 1602 of file springunitsynclib.cpp.

bool SpringUnitSyncLib::ParserGetSubTableInt ( int  key  ) 

Definition at line 1588 of file springunitsynclib.cpp.

bool SpringUnitSyncLib::ParserGetSubTableString ( const wxString &  key  ) 

Definition at line 1595 of file springunitsynclib.cpp.

bool SpringUnitSyncLib::ParserKeyExists ( const wxString &  key  ) 

Definition at line 1624 of file springunitsynclib.cpp.

bool SpringUnitSyncLib::ParserKeyExists ( int  key  ) 

Definition at line 1617 of file springunitsynclib.cpp.

void SpringUnitSyncLib::ParserPopTable (  ) 

Definition at line 1609 of file springunitsynclib.cpp.

int SpringUnitSyncLib::ProcessUnitsNoChecksum (  ) 

Definition at line 1020 of file springunitsynclib.cpp.

int SpringUnitSyncLib::ReadArchiveFile ( int  archive,
int  handle,
void *  buffer,
int  numBytes 
)

Definition at line 1341 of file springunitsynclib.cpp.

int SpringUnitSyncLib::ReadFileVFS ( int  handle,
void *  buffer,
int  bufferLength 
)

Definition at line 1064 of file springunitsynclib.cpp.

void SpringUnitSyncLib::SetCurrentMod ( const wxString &  modname  ) 

Definition at line 491 of file springunitsynclib.cpp.

void SpringUnitSyncLib::SetSpringConfigFloat ( const wxString &  key,
const float  value 
)

Definition at line 1413 of file springunitsynclib.cpp.

void SpringUnitSyncLib::SetSpringConfigInt ( const wxString &  key,
int  value 
)

Definition at line 1405 of file springunitsynclib.cpp.

void SpringUnitSyncLib::SetSpringConfigString ( const wxString &  key,
const wxString &  value 
)

Definition at line 1397 of file springunitsynclib.cpp.

int SpringUnitSyncLib::SizeArchiveFile ( int  archive,
int  handle 
)

Definition at line 1357 of file springunitsynclib.cpp.

void SpringUnitSyncLib::Unload (  ) 

Unload the unitsync library.

Does nothing if not loaded.

See also:
Load().

Definition at line 385 of file springunitsynclib.cpp.

void SpringUnitSyncLib::UnSetCurrentMod (  ) 

Definition at line 512 of file springunitsynclib.cpp.

bool SpringUnitSyncLib::VersionSupports ( SpringUnitSync::GameFeature  feature  )  const

Definition at line 459 of file springunitsynclib.cpp.

Field Documentation

wxString SpringUnitSyncLib::m_current_mod [protected]

the current loaded mod.

Definition at line 505 of file springunitsynclib.h.

wxDynamicLibrary* SpringUnitSyncLib::m_libhandle [protected]

Handle to the unitsync library.

Definition at line 496 of file springunitsynclib.h.

bool SpringUnitSyncLib::m_loaded [protected]

Keeps track if unitsync is loaded or not.

Definition at line 493 of file springunitsynclib.h.

wxCriticalSection SpringUnitSyncLib::m_lock [mutable, protected]

Critical section controlling access to unitsync functions.

Definition at line 499 of file springunitsynclib.h.

wxString SpringUnitSyncLib::m_path [protected]

Path to unitsync.

Definition at line 502 of file springunitsynclib.h.

The documentation for this class was generated from the following files:
Generated on Thu Dec 29 00:11:49 2011 for SpringLobby by doxygen 1.6.3