Gameconfs now support descriptions to identify games with '!' at the beginning of the string
3 * ===============================================================
4 * SourceMod (C)2004-2007 AlliedModders LLC. All rights reserved.
5 * ===============================================================
7 * This file is not open source and may not be copied without explicit
8 * written permission of AlliedModders LLC. This file may not be redistributed
9 * in whole or significant part.
10 * For information, see LICENSE.txt or http://www.sourcemod.net/license.php
17 #include "GameConfigs.h"
18 #include "TextParsers.h"
19 #include "sm_stringutil.h"
20 #include "sourcemod.h"
21 #include "sourcemm_api.h"
22 #include "HalfLife2.h"
25 #include "MemoryUtils.h"
26 #include "LibrarySys.h"
27 #include "HandleSys.h"
29 #if defined PLATFORM_LINUX
33 GameConfigManager g_GameConfigs;
34 IGameConfig *g_pGameConf = NULL;
36 char g_GameDesc[256] = {'!', '\0'};
39 #define PSTATE_GAMES 1
40 #define PSTATE_GAMEDEFS 2
41 #define PSTATE_GAMEDEFS_OFFSETS 3
42 #define PSTATE_GAMEDEFS_OFFSETS_OFFSET 4
43 #define PSTATE_GAMEDEFS_KEYS 5
44 #define PSTATE_GAMEDEFS_SUPPORTED 6
45 #define PSTATE_GAMEDEFS_SIGNATURES 7
46 #define PSTATE_GAMEDEFS_SIGNATURES_SIG 8
48 #if defined PLATFORM_WINDOWS
49 #define PLATFORM_NAME "windows"
50 #elif defined PLATFORM_LINUX
51 #define PLATFORM_NAME "linux"
65 CGameConfig::CGameConfig(const char *file)
67 m_pFile = sm_strdup(file);
68 m_pOffsets = sm_trie_create();
69 m_pProps = sm_trie_create();
70 m_pKeys = sm_trie_create();
71 m_pSigs = sm_trie_create();
72 m_pStrings = new BaseStringTable(512);
76 CGameConfig::~CGameConfig()
78 sm_trie_destroy(m_pOffsets);
79 sm_trie_destroy(m_pProps);
80 sm_trie_destroy(m_pKeys);
81 sm_trie_destroy(m_pSigs);
86 SMCParseResult CGameConfig::ReadSMC_NewSection(const char *name, bool opt_quotes)
91 return SMCParse_Continue;
98 if (strcmp(name, "Games") == 0)
100 m_ParseState = PSTATE_GAMES;
108 if ((strcmp(name, "*") == 0)
109 || (strcmp(name, "#default") == 0)
110 || (strcasecmp(name, g_Game) == 0)
111 || (strcasecmp(name, g_GameDesc) == 0))
113 m_ParseState = PSTATE_GAMEDEFS;
114 strncopy(m_Game, name, sizeof(m_Game));
120 case PSTATE_GAMEDEFS:
122 if (strcmp(name, "Offsets") == 0)
124 m_ParseState = PSTATE_GAMEDEFS_OFFSETS;
126 else if (strcmp(name, "Keys") == 0)
128 m_ParseState = PSTATE_GAMEDEFS_KEYS;
130 else if ((strcmp(name, "#supported") == 0)
131 && (strcmp(m_Game, "#default") == 0))
133 m_ParseState = PSTATE_GAMEDEFS_SUPPORTED;
134 /* Ignore this section unless we get a game. */
135 bShouldBeReadingDefault = false;
137 else if (strcmp(name, "Signatures") == 0)
139 m_ParseState = PSTATE_GAMEDEFS_SIGNATURES;
147 case PSTATE_GAMEDEFS_OFFSETS:
151 strncopy(m_offset, name, sizeof(m_offset));
152 m_ParseState = PSTATE_GAMEDEFS_OFFSETS_OFFSET;
155 case PSTATE_GAMEDEFS_SIGNATURES:
157 strncopy(m_offset, name, sizeof(m_offset));
159 m_ParseState = PSTATE_GAMEDEFS_SIGNATURES_SIG;
162 /* No sub-sections allowed:
163 case PSTATE_GAMEDEFS_OFFSETS_OFFSET:
164 case PSTATE_GAMEDEFS_KEYS:
165 case PSTATE_GAMEDEFS_SUPPORTED:
166 case PSTATE_GAMEDEFS_SIGNATURES_SIG:
170 /* If we don't know what we got, start ignoring */
176 return SMCParse_Continue;
179 SMCParseResult CGameConfig::ReadSMC_KeyValue(const char *key, const char *value, bool key_quotes, bool value_quotes)
183 return SMCParse_Continue;
186 if (m_ParseState == PSTATE_GAMEDEFS_OFFSETS_OFFSET)
188 if (strcmp(key, "class") == 0)
190 strncopy(m_Class, value, sizeof(m_Class));
191 } else if (strcmp(key, "prop") == 0) {
192 strncopy(m_Prop, value, sizeof(m_Prop));
193 } else if (strcmp(key, PLATFORM_NAME) == 0) {
194 int val = atoi(value);
195 sm_trie_replace(m_pOffsets, m_offset, (void *)val);
197 } else if (m_ParseState == PSTATE_GAMEDEFS_KEYS) {
198 int id = m_pStrings->AddString(value);
199 sm_trie_replace(m_pKeys, key, (void *)id);
200 } else if (m_ParseState == PSTATE_GAMEDEFS_SUPPORTED) {
201 if (strcmp(key, "game") == 0
202 && (strcasecmp(value, g_Game) == 0 || strcasecmp(value, g_GameDesc) == 0))
204 bShouldBeReadingDefault = true;
206 } else if (m_ParseState == PSTATE_GAMEDEFS_SIGNATURES_SIG) {
207 if (strcmp(key, PLATFORM_NAME) == 0)
209 strncopy(s_TempSig.sig, value, sizeof(s_TempSig.sig));
210 } else if (strcmp(key, "library") == 0) {
211 strncopy(s_TempSig.library, value, sizeof(s_TempSig.library));
215 return SMCParse_Continue;
218 SMCParseResult CGameConfig::ReadSMC_LeavingSection()
223 return SMCParse_Continue;
226 switch (m_ParseState)
230 m_ParseState = PSTATE_NONE;
233 case PSTATE_GAMEDEFS:
235 m_ParseState = PSTATE_GAMES;
238 case PSTATE_GAMEDEFS_KEYS:
239 case PSTATE_GAMEDEFS_OFFSETS:
241 m_ParseState = PSTATE_GAMEDEFS;
244 case PSTATE_GAMEDEFS_OFFSETS_OFFSET:
246 /* Parse the offset... */
247 if (m_Class[0] != '\0'
248 && m_Prop[0] != '\0')
250 SendProp *pProp = g_HL2.FindInSendTable(m_Class, m_Prop);
253 int val = pProp->GetOffset();
254 sm_trie_replace(m_pOffsets, m_offset, (void *)val);
255 sm_trie_replace(m_pProps, m_offset, pProp);
257 /* Check if it's a non-default game and no offsets exist */
258 if (((strcmp(m_Game, "*") != 0) && strcmp(m_Game, "#default") != 0)
259 && (!sm_trie_retrieve(m_pOffsets, m_offset, NULL)))
261 g_Logger.LogError("[SM] Unable to find property %s.%s (file \"%s\") (mod \"%s\")",
269 m_ParseState = PSTATE_GAMEDEFS_OFFSETS;
272 case PSTATE_GAMEDEFS_SUPPORTED:
274 if (!bShouldBeReadingDefault)
276 /* If we shouldn't read the rest of this section, set the ignore level. */
278 m_ParseState = PSTATE_GAMES;
280 m_ParseState = PSTATE_GAMEDEFS;
284 case PSTATE_GAMEDEFS_SIGNATURES:
286 m_ParseState = PSTATE_GAMEDEFS;
289 case PSTATE_GAMEDEFS_SIGNATURES_SIG:
291 if (s_TempSig.library[0] == '\0')
294 strncopy(s_TempSig.library, "server", sizeof(s_TempSig.library));
296 void *addrInBase = NULL;
297 if (strcmp(s_TempSig.library, "server") == 0)
299 addrInBase = (void *)g_SMAPI->serverFactory(false);
300 } else if (strcmp(s_TempSig.library, "engine") == 0) {
301 addrInBase = (void *)g_SMAPI->engineFactory(false);
303 void *final_addr = NULL;
304 if (addrInBase == NULL)
306 g_Logger.LogError("[SM] Unrecognized library \"%s\" (gameconf \"%s\")",
310 #if defined PLATFORM_LINUX
311 if (s_TempSig.sig[0] == '@')
314 /* GNU only: returns 0 on error, inconsistent! >:[ */
315 if (dladdr(addrInBase, &info) != 0)
317 void *handle = dlopen(info.dli_fname, RTLD_NOW);
320 final_addr = dlsym(handle, &s_TempSig.sig[1]);
323 g_Logger.LogError("[SM] Unable to load library \"%s\" (gameconf \"%s\")",
328 g_Logger.LogError("[SM] Unable to find library \"%s\" in memory (gameconf \"%s\")",
338 /* First, preprocess the signature */
344 length = strlen(s_TempSig.sig);
346 for (size_t i=0; i<length; i++)
348 if (real_bytes >= sizeof(real_sig))
352 real_sig[real_bytes++] = s_TempSig.sig[i];
353 if (s_TempSig.sig[i] == '\\'
354 && s_TempSig.sig[i+1] == 'x')
360 /* Get the hex part */
363 s_byte[0] = s_TempSig.sig[i+2];
364 s_byte[1] = s_TempSig.sig[i+3];
366 /* Read it as an integer */
367 sscanf(s_byte, "%x", &r_byte);
369 real_sig[real_bytes-1] = r_byte;
377 final_addr = g_MemUtils.FindPattern(addrInBase, real_sig, real_bytes);
381 #if defined PLATFORM_LINUX
384 sm_trie_replace(m_pSigs, m_offset, final_addr);
385 m_ParseState = PSTATE_GAMEDEFS_SIGNATURES;
391 return SMCParse_Continue;
394 bool CGameConfig::Reparse(char *error, size_t maxlength)
398 char path[PLATFORM_MAX_PATH];
399 g_SourceMod.BuildPath(Path_SM, path, sizeof(path), "gamedata/%s.txt", m_pFile);
400 /* Backwards compatibility */
401 if (!g_LibSys.PathExists(path))
403 g_SourceMod.BuildPath(Path_SM, path, sizeof(path), "configs/gamedata/%s.txt", m_pFile);
406 /* Initialize parse states */
408 bShouldBeReadingDefault = true;
409 m_ParseState = PSTATE_NONE;
410 /* Reset cached data */
412 sm_trie_clear(m_pOffsets);
413 sm_trie_clear(m_pProps);
414 sm_trie_clear(m_pKeys);
416 if ((err=g_TextParser.ParseFile_SMC(path, this, NULL, NULL))
419 if (error && (err != SMCParse_Custom))
421 const char *str = g_TextParser.GetSMCErrorString(err);
422 snprintf(error, maxlength, "%s", str);
430 bool CGameConfig::GetOffset(const char *key, int *value)
434 if (!sm_trie_retrieve(m_pOffsets, key, &obj))
444 const char *CGameConfig::GetKeyValue(const char *key)
447 if (!sm_trie_retrieve(m_pKeys, key, &obj))
451 return m_pStrings->GetString((int)obj);
454 SendProp *CGameConfig::GetSendProp(const char *key)
458 if (!sm_trie_retrieve(m_pProps, key, (void **)&pProp))
466 bool CGameConfig::GetMemSig(const char *key, void **addr)
468 return sm_trie_retrieve(m_pSigs, key, addr);
471 void CGameConfig::IncRefCount()
476 unsigned int CGameConfig::DecRefCount()
482 GameConfigManager::GameConfigManager()
484 m_pLookup = sm_trie_create();
487 GameConfigManager::~GameConfigManager()
489 sm_trie_destroy(m_pLookup);
492 void GameConfigManager::OnSourceModStartup(bool late)
494 LoadGameConfigFile("core.games", &g_pGameConf, NULL, 0);
496 strncopy(g_Game, g_SourceMod.GetGameFolderName(), sizeof(g_Game));
497 strncopy(g_GameDesc + 1, SERVER_CALL(GetGameDescription)(), sizeof(g_GameDesc) - 1);
500 void GameConfigManager::OnSourceModAllInitialized()
502 /* NOW initialize the game file */
503 CGameConfig *pGameConf = (CGameConfig *)g_pGameConf;
506 if (!pGameConf->Reparse(error, sizeof(error)))
511 g_ShareSys.AddInterface(NULL, this);
514 void GameConfigManager::OnSourceModAllShutdown()
516 CloseGameConfigFile(g_pGameConf);
519 bool GameConfigManager::LoadGameConfigFile(const char *file, IGameConfig **_pConfig, char *error, size_t maxlength)
521 CGameConfig *pConfig;
523 if (sm_trie_retrieve(m_pLookup, file, (void **)&pConfig))
525 pConfig->IncRefCount();
530 pConfig = new CGameConfig(file);
532 /* :HACKHACK: Don't parse the main config file */
534 if (_pConfig != &g_pGameConf)
536 retval = pConfig->Reparse(error, maxlength);
539 m_cfgs.push_back(pConfig);
540 sm_trie_insert(m_pLookup, file, pConfig);
542 pConfig->IncRefCount();
549 void GameConfigManager::CloseGameConfigFile(IGameConfig *cfg)
551 CGameConfig *pConfig = (CGameConfig *)cfg;
553 if (pConfig->DecRefCount() == 0)
555 sm_trie_delete(m_pLookup, pConfig->m_pFile);
560 extern HandleType_t g_GameConfigsType;
562 IGameConfig *GameConfigManager::ReadHandle(Handle_t hndl, IdentityToken_t *ident, HandleError *err)
564 HandleSecurity sec(ident, g_pCoreIdent);
565 IGameConfig *conf = NULL;
566 HandleError _err = g_HandleSys.ReadHandle(hndl, g_GameConfigsType, &sec, (void **)&conf);