warzone2100/lib/framework/strres.h

79 lines
2.2 KiB
C

/*
This file is part of Warzone 2100.
Copyright (C) 1999-2004 Eidos Interactive
Copyright (C) 2005-2007 Warzone Resurrection Project
Warzone 2100 is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
Warzone 2100 is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with Warzone 2100; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
/*! \file strres.h
* * \brief String resource interface functions
*/
#ifndef _strres_h
#define _strres_h
/* A string block */
typedef struct _str_block
{
char **apStrings;
UDWORD idStart, idEnd;
#ifdef DEBUG
UDWORD *aUsage;
#endif
struct _str_block *psNext;
} STR_BLOCK;
/* An ID entry */
typedef struct _str_id
{
UDWORD id;
char *pIDStr;
} STR_ID;
/* A String Resource */
typedef struct _str_res
{
TREAP *psIDTreap; // The treap to store string identifiers
STR_BLOCK *psStrings; // The store for the strings themselves
UDWORD init,ext; // Sizes for the string blocks
UDWORD nextID; // The next free ID
} STR_RES;
/* Create a string resource object */
extern BOOL strresCreate(STR_RES **ppsRes, UDWORD init, UDWORD ext);
/* Release a string resource object */
extern void strresDestroy(STR_RES *psRes);
/* Return the ID number for an ID string */
extern BOOL strresGetIDNum(STR_RES *psRes, const char *pIDStr, UDWORD *pIDNum);
/* Return the stored ID string that matches the string passed in */
extern BOOL strresGetIDString(STR_RES *psRes, const char *pIDStr, char **ppStoredID);
/* Get the string from an ID number */
extern char *strresGetString(STR_RES *psRes, UDWORD id);
/* Load a string resource file */
extern BOOL strresLoad(STR_RES* psRes, const char* fileName);
/* Get the ID number for a string*/
extern UDWORD strresGetIDfromString(STR_RES *psRes, const char *pString);
#endif