og-openarena-gamecode/code/qcommon/q_shared.c

1251 lines
22 KiB
C

/*
===========================================================================
Copyright (C) 1999-2005 Id Software, Inc.
This file is part of Quake III Arena source code.
Quake III Arena source code 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.
Quake III Arena source code 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 Quake III Arena source code; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
===========================================================================
*/
//
// q_shared.c -- stateless support routines that are included in each code dll
#include "q_shared.h"
float Com_Clamp(float min, float max, float value) {
if (value < min) {
return min;
}
if (value > max) {
return max;
}
return value;
}
/*
============
COM_SkipPath
============
*/
char *COM_SkipPath(char *pathname) {
char *last;
last = pathname;
while (*pathname) {
if (*pathname == '/')
last = pathname + 1;
pathname++;
}
return last;
}
/*
============
COM_GetExtension
============
*/
const char *COM_GetExtension(const char *name) {
int length, i;
length = strlen(name) - 1;
i = length;
while (name[i] != '.') {
i--;
if (name[i] == '/' || i == 0)
return ""; // no extension
}
return &name[i + 1];
}
/*
============
COM_StripExtension
============
*/
void COM_StripExtension(const char *in, char *out, int destsize) {
int length;
Q_strncpyz(out, in, destsize);
length = strlen(out) - 1;
while (length > 0 && out[length] != '.') {
length--;
if (out[length] == '/')
return; // no extension
}
if (length)
out[length] = 0;
}
/*
==================
COM_DefaultExtension
==================
*/
void COM_DefaultExtension(char *path, int maxSize, const char *extension) {
char oldPath[MAX_QPATH];
char *src;
//
// if path doesn't have a .EXT, append extension
// (extension should include the .)
//
src = path + strlen(path) - 1;
while (*src != '/' && src != path) {
if (*src == '.') {
return; // it has an extension
}
src--;
}
Q_strncpyz(oldPath, path, sizeof ( oldPath));
Com_sprintf(path, maxSize, "%s%s", oldPath, extension);
}
/*
============================================================================
BYTE ORDER FUNCTIONS
============================================================================
*/
/*
// can't just use function pointers, or dll linkage can
// mess up when qcommon is included in multiple places
static short (*_BigShort) (short l);
static short (*_LittleShort) (short l);
static int (*_BigLong) (int l);
static int (*_LittleLong) (int l);
static qint64 (*_BigLong64) (qint64 l);
static qint64 (*_LittleLong64) (qint64 l);
static float (*_BigFloat) (const float *l);
static float (*_LittleFloat) (const float *l);
short BigShort(short l){return _BigShort(l);}
short LittleShort(short l) {return _LittleShort(l);}
int BigLong (int l) {return _BigLong(l);}
int LittleLong (int l) {return _LittleLong(l);}
qint64 BigLong64 (qint64 l) {return _BigLong64(l);}
qint64 LittleLong64 (qint64 l) {return _LittleLong64(l);}
float BigFloat (const float *l) {return _BigFloat(l);}
float LittleFloat (const float *l) {return _LittleFloat(l);}
*/
short ShortSwap(short l) {
byte b1, b2;
b1 = l & 255;
b2 = (l >> 8)&255;
return (b1 << 8) +b2;
}
short ShortNoSwap(short l) {
return l;
}
int LongSwap(int l) {
byte b1, b2, b3, b4;
b1 = l & 255;
b2 = (l >> 8)&255;
b3 = (l >> 16)&255;
b4 = (l >> 24)&255;
return ((int) b1 << 24) + ((int) b2 << 16) + ((int) b3 << 8) + b4;
}
int LongNoSwap(int l) {
return l;
}
qint64 Long64Swap(qint64 ll) {
qint64 result;
result.b0 = ll.b7;
result.b1 = ll.b6;
result.b2 = ll.b5;
result.b3 = ll.b4;
result.b4 = ll.b3;
result.b5 = ll.b2;
result.b6 = ll.b1;
result.b7 = ll.b0;
return result;
}
qint64 Long64NoSwap(qint64 ll) {
return ll;
}
typedef union {
float f;
unsigned int i;
} _FloatByteUnion;
float FloatSwap(const float *f) {
_FloatByteUnion out;
out.f = *f;
out.i = LongSwap(out.i);
return out.f;
}
float FloatNoSwap(const float *f) {
return *f;
}
/*
================
Swap_Init
================
*/
/*
void Swap_Init (void)
{
byte swaptest[2] = {1,0};
// set the byte swapping variables in a portable manner
if ( *(short *)swaptest == 1)
{
_BigShort = ShortSwap;
_LittleShort = ShortNoSwap;
_BigLong = LongSwap;
_LittleLong = LongNoSwap;
_BigLong64 = Long64Swap;
_LittleLong64 = Long64NoSwap;
_BigFloat = FloatSwap;
_LittleFloat = FloatNoSwap;
}
else
{
_BigShort = ShortNoSwap;
_LittleShort = ShortSwap;
_BigLong = LongNoSwap;
_LittleLong = LongSwap;
_BigLong64 = Long64NoSwap;
_LittleLong64 = Long64Swap;
_BigFloat = FloatNoSwap;
_LittleFloat = FloatSwap;
}
}
*/
/*
============================================================================
PARSING
============================================================================
*/
static char com_token[MAX_TOKEN_CHARS];
static char com_parsename[MAX_TOKEN_CHARS];
static int com_lines;
void COM_BeginParseSession(const char *name) {
com_lines = 0;
Com_sprintf(com_parsename, sizeof (com_parsename), "%s", name);
}
int COM_GetCurrentParseLine(void) {
return com_lines;
}
char *COM_Parse(char **data_p) {
return COM_ParseExt(data_p, qtrue);
}
void COM_ParseError(char *format, ...) {
va_list argptr;
static char string[4096];
va_start(argptr, format);
Q_vsnprintf(string, sizeof (string), format, argptr);
va_end(argptr);
Com_Printf("ERROR: %s, line %d: %s\n", com_parsename, com_lines, string);
}
void COM_ParseWarning(char *format, ...) {
va_list argptr;
static char string[4096];
va_start(argptr, format);
Q_vsnprintf(string, sizeof (string), format, argptr);
va_end(argptr);
Com_Printf("WARNING: %s, line %d: %s\n", com_parsename, com_lines, string);
}
/*
==============
COM_Parse
Parse a token out of a string
Will never return NULL, just empty strings
If "allowLineBreaks" is qtrue then an empty
string will be returned if the next token is
a newline.
==============
*/
static char *SkipWhitespace(char *data, qboolean *hasNewLines) {
int c;
while ((c = *data) <= ' ') {
if (!c) {
return NULL;
}
if (c == '\n') {
com_lines++;
*hasNewLines = qtrue;
}
data++;
}
return data;
}
int COM_Compress(char *data_p) {
char *in, *out;
int c;
qboolean newline = qfalse, whitespace = qfalse;
in = out = data_p;
if (in) {
while ((c = *in) != 0) {
// skip double slash comments
if (c == '/' && in[1] == '/') {
while (*in && *in != '\n') {
in++;
}
// skip /* */ comments
} else if (c == '/' && in[1] == '*') {
while (*in && (*in != '*' || in[1] != '/'))
in++;
if (*in)
in += 2;
// record when we hit a newline
} else if (c == '\n' || c == '\r') {
newline = qtrue;
in++;
// record when we hit whitespace
} else if (c == ' ' || c == '\t') {
whitespace = qtrue;
in++;
// an actual token
} else {
// if we have a pending newline, emit it (and it counts as whitespace)
if (newline) {
*out++ = '\n';
newline = qfalse;
whitespace = qfalse;
}
if (whitespace) {
*out++ = ' ';
whitespace = qfalse;
}
// copy quoted strings unmolested
if (c == '"') {
*out++ = c;
in++;
while (1) {
c = *in;
if (c && c != '"') {
*out++ = c;
in++;
} else {
break;
}
}
if (c == '"') {
*out++ = c;
in++;
}
} else {
*out = c;
out++;
in++;
}
}
}
*out = 0;
return out - data_p;
}
return 0;
}
char *COM_ParseExt(char **data_p, qboolean allowLineBreaks) {
int c = 0, len;
qboolean hasNewLines = qfalse;
char *data;
data = *data_p;
len = 0;
com_token[0] = 0;
// make sure incoming data is valid
if (!data) {
*data_p = NULL;
return com_token;
}
while (1) {
// skip whitespace
data = SkipWhitespace(data, &hasNewLines);
if (!data) {
*data_p = NULL;
return com_token;
}
if (hasNewLines && !allowLineBreaks) {
*data_p = data;
return com_token;
}
c = *data;
// skip double slash comments
if (c == '/' && data[1] == '/') {
data += 2;
while (*data && *data != '\n') {
data++;
}
} // skip /* */ comments
else if (c == '/' && data[1] == '*') {
data += 2;
while (*data && (*data != '*' || data[1] != '/')) {
data++;
}
if (*data) {
data += 2;
}
} else {
break;
}
}
// handle quoted strings
if (c == '\"') {
data++;
while (1) {
c = *data++;
if (c == '\"' || !c) {
com_token[len] = 0;
*data_p = (char *) data;
return com_token;
}
if (len < MAX_TOKEN_CHARS - 1) {
com_token[len] = c;
len++;
}
}
}
// parse a regular word
do {
if (len < MAX_TOKEN_CHARS - 1) {
com_token[len] = c;
len++;
}
data++;
c = *data;
if (c == '\n')
com_lines++;
} while (c > 32);
com_token[len] = 0;
*data_p = (char *) data;
return com_token;
}
#if 0
// no longer used
/*
===============
COM_ParseInfos
===============
*/
int COM_ParseInfos(char *buf, int max, char infos[][MAX_INFO_STRING]) {
char *token;
int count;
char key[MAX_TOKEN_CHARS];
count = 0;
while (1) {
token = COM_Parse(&buf);
if (!token[0]) {
break;
}
if (strcmp(token, "{")) {
Com_Printf("Missing { in info file\n");
break;
}
if (count == max) {
Com_Printf("Max infos exceeded\n");
break;
}
infos[count][0] = 0;
while (1) {
token = COM_ParseExt(&buf, qtrue);
if (!token[0]) {
Com_Printf("Unexpected end of info file\n");
break;
}
if (!strcmp(token, "}")) {
break;
}
Q_strncpyz(key, token, sizeof ( key));
token = COM_ParseExt(&buf, qfalse);
if (!token[0]) {
strcpy(token, "<NULL>");
}
Info_SetValueForKey(infos[count], key, token);
}
count++;
}
return count;
}
#endif
/*
==================
COM_MatchToken
==================
*/
void COM_MatchToken(char **buf_p, char *match) {
char *token;
token = COM_Parse(buf_p);
if (strcmp(token, match)) {
Com_Error(ERR_DROP, "MatchToken: %s != %s", token, match);
}
}
/*
=================
SkipBracedSection
The next token should be an open brace.
Skips until a matching close brace is found.
Internal brace depths are properly skipped.
=================
*/
void SkipBracedSection(char **program) {
char *token;
int depth;
depth = 0;
do {
token = COM_ParseExt(program, qtrue);
if (token[1] == 0) {
if (token[0] == '{') {
depth++;
} else if (token[0] == '}') {
depth--;
}
}
} while (depth && *program);
}
/*
=================
SkipRestOfLine
=================
*/
void SkipRestOfLine(char **data) {
char *p;
int c;
p = *data;
while ((c = *p++) != 0) {
if (c == '\n') {
com_lines++;
break;
}
}
*data = p;
}
void Parse1DMatrix(char **buf_p, int x, float *m) {
char *token;
int i;
COM_MatchToken(buf_p, "(");
for (i = 0; i < x; i++) {
token = COM_Parse(buf_p);
m[i] = atof(token);
}
COM_MatchToken(buf_p, ")");
}
void Parse2DMatrix(char **buf_p, int y, int x, float *m) {
int i;
COM_MatchToken(buf_p, "(");
for (i = 0; i < y; i++) {
Parse1DMatrix(buf_p, x, m + i * x);
}
COM_MatchToken(buf_p, ")");
}
void Parse3DMatrix(char **buf_p, int z, int y, int x, float *m) {
int i;
COM_MatchToken(buf_p, "(");
for (i = 0; i < z; i++) {
Parse2DMatrix(buf_p, y, x, m + i * x * y);
}
COM_MatchToken(buf_p, ")");
}
void Q_StrToLower(char *io_string) {
int i;
for (i = 0; i < strlen(io_string); i++) {
io_string[i] = tolower(io_string[i]);
}
}
/*
============================================================================
LIBRARY REPLACEMENT FUNCTIONS
============================================================================
*/
int Q_isprint(int c) {
if (c >= 0x20 && c <= 0x7E)
return ( 1);
return ( 0);
}
int Q_islower(int c) {
if (c >= 'a' && c <= 'z')
return ( 1);
return ( 0);
}
int Q_isupper(int c) {
if (c >= 'A' && c <= 'Z')
return ( 1);
return ( 0);
}
int Q_isalpha(int c) {
if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z'))
return ( 1);
return ( 0);
}
char* Q_strrchr(const char* string, int c) {
char cc = c;
char *s;
char *sp = (char *) 0;
s = (char*) string;
while (*s) {
if (*s == cc)
sp = s;
s++;
}
if (cc == 0)
sp = s;
return sp;
}
/*
Copied from code/game/bg_lib.c
It is here to avoid undifined behavior when source and destination overlap.
This is used quite a lot in the code.
*/
static char *qstrncpy(char *strDest, const char *strSource, size_t count) {
char *s;
s = strDest;
while (*strSource && count) {
*s++ = *strSource++;
count--;
}
while (count--) {
*s++ = 0;
}
return strDest;
}
/*
=============
Q_strncpyz
Safe strncpy that ensures a trailing zero
Does not result in undefiend behavior if source=destination
=============
*/
void Q_strncpyz(char *dest, const char *src, int destsize) {
if (!dest) {
Com_Error(ERR_FATAL, "Q_strncpyz: NULL dest");
}
if (!src) {
Com_Error(ERR_FATAL, "Q_strncpyz: NULL src");
}
if (destsize < 1) {
Com_Error(ERR_FATAL, "Q_strncpyz: destsize < 1");
}
if (dest != src) {
qstrncpy(dest, src, destsize - 1);
}
dest[destsize - 1] = 0;
}
int Q_stricmpn(const char *s1, const char *s2, int n) {
int c1, c2;
if (s1 == NULL) {
if (s2 == NULL)
return 0;
else
return -1;
} else if (s2 == NULL)
return 1;
do {
c1 = *s1++;
c2 = *s2++;
if (!n--) {
return 0; // strings are equal until end point
}
if (c1 != c2) {
if (c1 >= 'a' && c1 <= 'z') {
c1 -= ('a' - 'A');
}
if (c2 >= 'a' && c2 <= 'z') {
c2 -= ('a' - 'A');
}
if (c1 != c2) {
return c1 < c2 ? -1 : 1;
}
}
} while (c1);
return 0; // strings are equal
}
int Q_strncmp(const char *s1, const char *s2, int n) {
int c1, c2;
do {
c1 = *s1++;
c2 = *s2++;
if (!n--) {
return 0; // strings are equal until end point
}
if (c1 != c2) {
return c1 < c2 ? -1 : 1;
}
} while (c1);
return 0; // strings are equal
}
int Q_stricmp(const char *s1, const char *s2) {
return (s1 && s2) ? Q_stricmpn(s1, s2, 99999) : -1;
}
char *Q_strlwr(char *s1) {
char *s;
s = s1;
while (*s) {
*s = tolower(*s);
s++;
}
return s1;
}
char *Q_strupr(char *s1) {
char *s;
s = s1;
while (*s) {
*s = toupper(*s);
s++;
}
return s1;
}
// never goes past bounds or leaves without a terminating 0
void Q_strcat(char *dest, int size, const char *src) {
int l1;
l1 = strlen(dest);
if (l1 >= size) {
Com_Error(ERR_FATAL, "Q_strcat: already overflowed");
}
Q_strncpyz(dest + l1, src, size - l1);
}
/*
* Find the first occurrence of find in s.
*/
const char *Q_stristr(const char *s, const char *find) {
char c, sc;
size_t len;
if ((c = *find++) != 0) {
if (c >= 'a' && c <= 'z') {
c -= ('a' - 'A');
}
len = strlen(find);
do {
do {
if ((sc = *s++) == 0)
return NULL;
if (sc >= 'a' && sc <= 'z') {
sc -= ('a' - 'A');
}
} while (sc != c);
} while (!Q_strequaln(s, find, len));
s--;
}
return s;
}
int Q_PrintStrlen(const char *string) {
int len;
const char *p;
if (!string) {
return 0;
}
len = 0;
p = string;
while (*p) {
if (Q_IsColorString(p)) {
p += 2;
continue;
}
p++;
len++;
}
return len;
}
char *Q_CleanStr(char *string) {
char* d;
char* s;
int c;
qboolean hadColor = qfalse;
s = string;
d = string;
while ((c = *s) != 0) {
if (Q_IsColorString(s)) {
s++;
hadColor = qtrue;
} else if (c >= 0x20 && c <= 0x7E) {
*d++ = c;
}
s++;
}
*d = '\0';
if (hadColor)
return Q_CleanStr(string);
else
return string;
}
int Q_CountChar(const char *string, char tocount) {
int count;
for (count = 0; *string; string++) {
if (*string == tocount)
count++;
}
return count;
}
void QDECL Com_sprintf(char *dest, int size, const char *fmt, ...) {
int len;
va_list argptr;
char bigbuffer[32000]; // big, but small enough to fit in PPC stack
va_start(argptr, fmt);
len = Q_vsnprintf(bigbuffer, sizeof (bigbuffer), fmt, argptr);
va_end(argptr);
if (len >= sizeof ( bigbuffer)) {
Com_Error(ERR_FATAL, "Com_sprintf: overflowed bigbuffer");
}
if (len >= size) {
Com_Printf("Com_sprintf: overflow of %i in %i\n", len, size);
#ifdef _DEBUG
__asm
{
int 3;
}
#endif
}
Q_strncpyz(dest, bigbuffer, size);
}
/*
============
va
does a varargs printf into a temp buffer, so I don't need to have
varargs versions of all text functions.
============
*/
char * QDECL va(char *format, ...) {
va_list argptr;
static char string[2][32000]; // in case va is called by nested functions
static int index = 0;
char *buf;
buf = string[index & 1];
index++;
va_start(argptr, format);
Q_vsnprintf(buf, sizeof (*string), format, argptr);
va_end(argptr);
return buf;
}
/*
============
Com_TruncateLongString
Assumes buffer is atleast TRUNCATE_LENGTH big
============
*/
void Com_TruncateLongString(char *buffer, const char *s) {
int length = strlen(s);
if (length <= TRUNCATE_LENGTH) {
Q_strncpyz(buffer, s, TRUNCATE_LENGTH);
}
else {
Q_strncpyz(buffer, s, (TRUNCATE_LENGTH / 2) - 3);
Q_strcat(buffer, TRUNCATE_LENGTH, " ... ");
Q_strcat(buffer, TRUNCATE_LENGTH, s + length - (TRUNCATE_LENGTH / 2) + 3);
}
}
/*
=====================================================================
INFO STRINGS
=====================================================================
*/
/*
===============
Info_ValueForKey
Searches the string for the given
key and returns the associated value, or an empty string.
FIXME: overflow check?
===============
*/
char *Info_ValueForKey(const char *s, const char *key) {
char pkey[BIG_INFO_KEY];
static char value[2][BIG_INFO_VALUE]; // use two buffers so compares
// work without stomping on each other
static int valueindex = 0;
char *o;
if (!s || !key) {
return "";
}
if (strlen(s) >= BIG_INFO_STRING) {
Com_Error(ERR_DROP, "Info_ValueForKey: oversize infostring");
}
valueindex ^= 1;
if (*s == '\\')
s++;
while (1) {
o = pkey;
while (*s != '\\') {
if (!*s)
return "";
*o++ = *s++;
}
*o = 0;
s++;
o = value[valueindex];
while (*s != '\\' && *s) {
*o++ = *s++;
}
*o = 0;
if (Q_strequal(key, pkey))
return value[valueindex];
if (!*s)
break;
s++;
}
return "";
}
/*
===================
Info_NextPair
Used to itterate through all the key/value pairs in an info string
===================
*/
void Info_NextPair(const char **head, char *key, char *value) {
char *o;
const char *s;
s = *head;
if (*s == '\\') {
s++;
}
key[0] = 0;
value[0] = 0;
o = key;
while (*s != '\\') {
if (!*s) {
*o = 0;
*head = s;
return;
}
*o++ = *s++;
}
*o = 0;
s++;
o = value;
while (*s != '\\' && *s) {
*o++ = *s++;
}
*o = 0;
*head = s;
}
/*
===================
Info_RemoveKey
===================
*/
void Info_RemoveKey(char *s, const char *key) {
char *start;
char pkey[MAX_INFO_KEY];
char value[MAX_INFO_VALUE];
char *o;
if (strlen(s) >= MAX_INFO_STRING) {
Com_Error(ERR_DROP, "Info_RemoveKey: oversize infostring");
}
if (strchr(key, '\\')) {
return;
}
while (1) {
start = s;
if (*s == '\\')
s++;
o = pkey;
while (*s != '\\') {
if (!*s)
return;
*o++ = *s++;
}
*o = 0;
s++;
o = value;
while (*s != '\\' && *s) {
if (!*s)
return;
*o++ = *s++;
}
*o = 0;
if (!strcmp(key, pkey)) {
memmove(start, s, strlen(s) + 1); // remove this part
return;
}
if (!*s)
return;
}
}
/*
==================
Info_Validate
Some characters are illegal in info strings because they
can mess up the server's parsing
==================
*/
qboolean Info_Validate(const char *s) {
if (strchr(s, '\"')) {
return qfalse;
}
if (strchr(s, ';')) {
return qfalse;
}
return qtrue;
}
/*
==================
Info_SetValueForKey
Changes or adds a key/value pair
==================
*/
void Info_SetValueForKey(char *s, const char *key, const char *value) {
char newi[MAX_INFO_STRING];
const char* blacklist = "\\;\"";
if (strlen(s) >= MAX_INFO_STRING) {
Com_Error(ERR_DROP, "Info_SetValueForKey: oversize infostring");
}
for (; *blacklist; ++blacklist) {
if (strchr(key, *blacklist) || strchr(value, *blacklist)) {
Com_Printf(S_COLOR_YELLOW "Can't use keys or values with a '%c': %s = %s\n", *blacklist, key, value);
return;
}
}
Info_RemoveKey(s, key);
if (!value || !strlen(value))
return;
Com_sprintf(newi, sizeof (newi), "\\%s\\%s", key, value);
if (strlen(newi) + strlen(s) >= MAX_INFO_STRING) {
Com_Printf("Info string length exceeded\n");
return;
}
strcat(newi, s);
strcpy(s, newi);
}
//====================================================================
/*
==================
Com_CharIsOneOfCharset
==================
*/
static qboolean Com_CharIsOneOfCharset(char c, char *set) {
int i;
for (i = 0; i < strlen(set); i++) {
if (set[ i ] == c)
return qtrue;
}
return qfalse;
}
/*
==================
Com_SkipCharset
==================
*/
char *Com_SkipCharset(char *s, char *sep) {
char *p = s;
while (p) {
if (Com_CharIsOneOfCharset(*p, sep))
p++;
else
break;
}
return p;
}
/*
==================
Com_SkipTokens
==================
*/
char *Com_SkipTokens(char *s, int numTokens, char *sep) {
int sepCount = 0;
char *p = s;
while (sepCount < numTokens) {
if (Com_CharIsOneOfCharset(*p++, sep)) {
sepCount++;
while (Com_CharIsOneOfCharset(*p, sep))
p++;
} else if (*p == '\0')
break;
}
if (sepCount == numTokens)
return p;
else
return s;
}