sourcemm/metamod_util.cpp
author David Anderson <dvander@alliedmods.net>
Thu Oct 04 19:18:19 2007 +0000 (2007-10-04)
branchsourcemm-1.6.0
changeset 369 2b8c2ea08b6d
parent 367 fc76472b980f
permissions -rw-r--r--
fixed usermessages not printing
removed old ConMsg extraction code
dvander@367
     1
/**
dvander@367
     2
 * vim: set ts=4 :
dvander@367
     3
 * ======================================================
dvander@367
     4
 * Metamod:Source
dvander@367
     5
 * Copyright (C) 2004-2007 AlliedModders LLC and authors.
dvander@367
     6
 * All rights reserved.
dvander@367
     7
 * ======================================================
dvander@352
     8
 *
dvander@367
     9
 * This software is provided 'as-is', without any express or implied warranty.
dvander@367
    10
 * In no event will the authors be held liable for any damages arising from 
dvander@367
    11
 * the use of this software.
dvander@367
    12
 * 
dvander@367
    13
 * Permission is granted to anyone to use this software for any purpose, 
dvander@367
    14
 * including commercial applications, and to alter it and redistribute it 
dvander@367
    15
 * freely, subject to the following restrictions:
dvander@352
    16
 *
dvander@367
    17
 * 1. The origin of this software must not be misrepresented; you must not 
dvander@367
    18
 * claim that you wrote the original software. If you use this software in a 
dvander@367
    19
 * product, an acknowledgment in the product documentation would be 
dvander@367
    20
 * appreciated but is not required.
dvander@367
    21
 * 2. Altered source versions must be plainly marked as such, and must not be
dvander@367
    22
 * misrepresented as being the original software.
dvander@367
    23
 * 3. This notice may not be removed or altered from any source distribution.
dvander@367
    24
 *
dvander@367
    25
 * Version: $Id$
dvander@352
    26
 */
dvander@352
    27
dvander@352
    28
#include <ctype.h>
dvander@352
    29
#include <string.h>
dvander@352
    30
#include <stdio.h>
dvander@352
    31
#include "metamod_util.h"
dvander@359
    32
#include "metamod_oslink.h"
dvander@352
    33
dvander@352
    34
/**
dvander@352
    35
 * @brief Utility functions
dvander@352
    36
 * @file util.cpp
dvander@352
    37
 */
dvander@352
    38
dvander@352
    39
const char *UTIL_GetExtension(const char *file)
dvander@352
    40
{
dvander@352
    41
	int len = strlen(file);
dvander@352
    42
	int i = 0;
dvander@352
    43
dvander@352
    44
	for (i = len - 1; i >= 0; i--)
dvander@352
    45
	{
dvander@352
    46
		if (file[i] == '/' || file[i] == '\\')
dvander@352
    47
		{
dvander@352
    48
			return NULL;
dvander@352
    49
		}
dvander@352
    50
dvander@352
    51
		if ((file[i] == '.') && (i != len - 1))
dvander@352
    52
		{
dvander@352
    53
			return (const char *)&(file[i + 1]);
dvander@352
    54
		}
dvander@352
    55
	}
dvander@352
    56
dvander@352
    57
	return NULL;
dvander@352
    58
}
dvander@352
    59
dvander@352
    60
void UTIL_TrimLeft(char *buffer)
dvander@352
    61
{
dvander@352
    62
	/* Let's think of this as our iterator */
dvander@352
    63
	char *i = buffer;
dvander@352
    64
dvander@352
    65
	/* Make sure the buffer isn't null */
dvander@352
    66
	if (i && *i)
dvander@352
    67
	{
dvander@352
    68
		/* Add up number of whitespace characters */
dvander@352
    69
		while(isspace((unsigned char) *i))
dvander@352
    70
		{
dvander@352
    71
			i++;
dvander@352
    72
		}
dvander@352
    73
dvander@352
    74
		/* If whitespace chars in buffer then adjust string so first non-whitespace char is at start of buffer */
dvander@352
    75
		if (i != buffer)
dvander@352
    76
		{
dvander@352
    77
			memmove(buffer, i, (strlen(i) + 1) * sizeof(char));
dvander@352
    78
		}
dvander@352
    79
	}
dvander@352
    80
}
dvander@352
    81
dvander@352
    82
void UTIL_TrimRight(char *buffer)
dvander@352
    83
{
dvander@352
    84
	/* Make sure buffer isn't null */
dvander@352
    85
	if (buffer)
dvander@352
    86
	{
dvander@352
    87
		size_t len = strlen(buffer);
dvander@352
    88
dvander@352
    89
		/* Loop through buffer backwards while replacing whitespace chars with null chars */
dvander@352
    90
		for (size_t i = len - 1; i >= 0; i--)
dvander@352
    91
		{
dvander@352
    92
			if (isspace((unsigned char) buffer[i]))
dvander@352
    93
			{
dvander@352
    94
				buffer[i] = '\0';
dvander@352
    95
			} else {
dvander@352
    96
				break;
dvander@352
    97
			}
dvander@352
    98
		}
dvander@352
    99
	}
dvander@352
   100
}
dvander@352
   101
dvander@352
   102
/* :TODO: this should skip string literals */
dvander@352
   103
void UTIL_TrimComments(char *buffer)
dvander@352
   104
{
dvander@352
   105
	int num_sc = 0;
dvander@352
   106
	size_t len = strlen(buffer);
dvander@352
   107
	if (buffer)
dvander@352
   108
	{
dvander@352
   109
		for (int i = len - 1; i >= 0; i--)
dvander@352
   110
		{
dvander@352
   111
			if (buffer[i] == '/')
dvander@352
   112
			{
dvander@352
   113
				if (++num_sc >= 2 && i==0)
dvander@352
   114
				{
dvander@352
   115
					buffer[i] = '\0';
dvander@352
   116
					return;
dvander@352
   117
				}
dvander@352
   118
			} else {
dvander@352
   119
				if (num_sc >= 2)
dvander@352
   120
				{
dvander@352
   121
					buffer[i] = '\0';
dvander@352
   122
					return;
dvander@352
   123
				}
dvander@352
   124
				num_sc = 0;
dvander@352
   125
			}
dvander@352
   126
			/* size_t won't go below 0, manually break out */
dvander@352
   127
			if (i == 0)
dvander@352
   128
			{
dvander@352
   129
				break;
dvander@352
   130
			}
dvander@352
   131
		}
dvander@352
   132
	}
dvander@352
   133
}
dvander@352
   134
dvander@352
   135
void UTIL_KeySplit(const char *str, char *buf1, size_t len1, char *buf2, size_t len2)
dvander@352
   136
{
dvander@352
   137
	size_t start;
dvander@352
   138
	size_t len = strlen(str);
dvander@352
   139
dvander@352
   140
	for (start = 0; start < len; start++)
dvander@352
   141
	{
dvander@352
   142
		if (!isspace(str[start]))
dvander@352
   143
		{
dvander@352
   144
			break;
dvander@352
   145
		}
dvander@352
   146
	}
dvander@352
   147
dvander@352
   148
	size_t end;
dvander@352
   149
	for (end = start; end < len; end++)
dvander@352
   150
	{
dvander@352
   151
		if (isspace(str[end]))
dvander@352
   152
		{
dvander@352
   153
			break;
dvander@352
   154
		}
dvander@352
   155
	}
dvander@352
   156
	
dvander@352
   157
	size_t i, c = 0;
dvander@352
   158
	for (i = start; i < end; i++, c++)
dvander@352
   159
	{
dvander@352
   160
		if (c >= len1)
dvander@352
   161
		{
dvander@352
   162
			break;
dvander@352
   163
		}
dvander@352
   164
		buf1[c] = str[i];
dvander@352
   165
	}
dvander@352
   166
	buf1[c] = '\0';
dvander@352
   167
dvander@352
   168
	for (start = end; start < len; start++)
dvander@352
   169
	{
dvander@352
   170
		if (!isspace(str[start]))
dvander@352
   171
		{
dvander@352
   172
			break;
dvander@352
   173
		}
dvander@352
   174
	}
dvander@352
   175
dvander@352
   176
	for (c = 0; start < len; start++, c++)
dvander@352
   177
	{
dvander@352
   178
		if (c >= len2)
dvander@352
   179
		{
dvander@352
   180
			break;
dvander@352
   181
		}
dvander@352
   182
		buf2[c] = str[start];
dvander@352
   183
	}
dvander@352
   184
	buf2[c] = '\0';
dvander@352
   185
}
dvander@352
   186
dvander@352
   187
bool UTIL_PathCmp(const char *path1, const char *path2)
dvander@352
   188
{
dvander@352
   189
	size_t pos1 = 0, pos2 = 0;
dvander@352
   190
dvander@352
   191
	while (true)
dvander@352
   192
	{
dvander@352
   193
		if (path1[pos1] == '\0' || path2[pos2] == '\0')
dvander@352
   194
		{
dvander@352
   195
			return (path1[pos1] == path2[pos2]);
dvander@352
   196
		}
dvander@352
   197
dvander@352
   198
		if (path1[pos1] == PATH_SEP_CHAR)
dvander@352
   199
		{
dvander@352
   200
			if (path2[pos2] != PATH_SEP_CHAR)
dvander@352
   201
			{
dvander@352
   202
				return false;
dvander@352
   203
			}
dvander@352
   204
dvander@352
   205
			/* Look for extra path chars */
dvander@352
   206
			while (path1[++pos1])
dvander@352
   207
			{
dvander@352
   208
				if (path1[pos1] != PATH_SEP_CHAR)
dvander@352
   209
				{
dvander@352
   210
					break;
dvander@352
   211
				}
dvander@352
   212
			}
dvander@352
   213
			while (path2[++pos2])
dvander@352
   214
			{
dvander@352
   215
				if (path2[pos2] != PATH_SEP_CHAR)
dvander@352
   216
				{
dvander@352
   217
					break;
dvander@352
   218
				}
dvander@352
   219
			}
dvander@352
   220
			continue;
dvander@352
   221
		}
dvander@352
   222
dvander@352
   223
		/* If we're at a different non-alphanumeric, the next character MUST match */
dvander@352
   224
		if (!isalpha(path1[pos1]) && (path1[pos1] != path2[pos2]))
dvander@352
   225
		{
dvander@352
   226
			return false;
dvander@352
   227
		}
dvander@352
   228
dvander@352
   229
	#ifdef WIN32
dvander@352
   230
		if (toupper(path1[pos1]) != toupper(path2[pos2]))
dvander@352
   231
	#else
dvander@352
   232
		if (path1[pos1] != path2[pos2])
dvander@352
   233
	#endif
dvander@352
   234
		{
dvander@352
   235
			return false;
dvander@352
   236
		}
dvander@352
   237
dvander@352
   238
		pos1++;
dvander@352
   239
		pos2++;
dvander@352
   240
	}
dvander@352
   241
}
dvander@352
   242
dvander@352
   243
size_t UTIL_Format(char *buffer, size_t maxlength, const char *fmt, ...)
dvander@352
   244
{
dvander@352
   245
	va_list ap;
dvander@352
   246
dvander@352
   247
	va_start(ap, fmt);
dvander@352
   248
	size_t len = vsnprintf(buffer, maxlength, fmt, ap);
dvander@352
   249
	va_end(ap);
dvander@352
   250
dvander@352
   251
	if (len >= maxlength)
dvander@352
   252
	{
dvander@352
   253
		len = maxlength - 1;
dvander@352
   254
		buffer[len] = '\0';
dvander@352
   255
	}
dvander@352
   256
dvander@352
   257
	return len;
dvander@352
   258
}
dvander@352
   259
dvander@352
   260
size_t UTIL_FormatArgs(char *buffer, size_t maxlength, const char *fmt, va_list params)
dvander@352
   261
{
dvander@352
   262
	size_t len = vsnprintf(buffer, maxlength, fmt, params);
dvander@352
   263
dvander@352
   264
	if (len >= maxlength)
dvander@352
   265
	{
dvander@352
   266
		len = maxlength - 1;
dvander@352
   267
		buffer[len] = '\0';
dvander@352
   268
	}
dvander@352
   269
dvander@352
   270
	return len;
dvander@352
   271
}
dvander@352
   272
dvander@352
   273
inline bool pathchar_isalpha(char a)
dvander@352
   274
{
dvander@352
   275
	return (((a & 1<<7) == 0) && isalpha(a));
dvander@352
   276
}
dvander@352
   277
dvander@352
   278
inline bool pathchar_sep(char a)
dvander@352
   279
{
dvander@352
   280
#if defined WIN32
dvander@352
   281
	return (a == '/' || a == '\\');
dvander@352
   282
#elif defined __linux__
dvander@352
   283
	return (a == '/');
dvander@352
   284
#endif
dvander@352
   285
}
dvander@352
   286
dvander@352
   287
inline bool pathstr_isabsolute(const char *str)
dvander@352
   288
{
dvander@352
   289
#if defined WIN32
dvander@352
   290
	return (pathchar_isalpha(str[0]) 
dvander@352
   291
		&& str[1] == ':' 
dvander@352
   292
		&& pathchar_sep(str[2]));
dvander@352
   293
#elif defined __linux__
dvander@352
   294
	return (str[0] == '/');
dvander@352
   295
#endif
dvander@352
   296
}
dvander@352
   297
dvander@352
   298
inline bool pathchar_cmp(char a, char b)
dvander@352
   299
{
dvander@352
   300
#if defined WIN32
dvander@352
   301
	if (pathchar_isalpha(a) && pathchar_isalpha(b))
dvander@352
   302
	{
dvander@352
   303
		return (tolower(a) == tolower(b));
dvander@352
   304
	}
dvander@352
   305
	/* Either path separator is acceptable */
dvander@352
   306
	if (pathchar_sep(a))
dvander@352
   307
	{
dvander@352
   308
		return pathchar_sep(b);
dvander@352
   309
	}
dvander@352
   310
#endif
dvander@352
   311
	return (a == b);
dvander@352
   312
}
dvander@352
   313
dvander@352
   314
/**
dvander@352
   315
 * @brief Forms a relative path given two absolute paths.
dvander@352
   316
 *
dvander@352
   317
 * @param buffer		Buffer to store relative path in.
dvander@352
   318
 * @param maxlength		Maximum length of the output buffer.
dvander@352
   319
 * @param relTo			Destination folder to use as a working directory.
dvander@352
   320
 *						Final folder name should not be pathchar-terminated.
dvander@352
   321
 * @param relFrom		Source file or folder to use as a target.
dvander@352
   322
 * @return				True on success, false on failure.
dvander@352
   323
 */
dvander@352
   324
bool UTIL_Relatize(char buffer[],
dvander@352
   325
				   size_t maxlength,
dvander@352
   326
				   const char *relTo,
dvander@352
   327
				   const char *relFrom)
dvander@352
   328
{
dvander@352
   329
	/* We don't allow relative paths in here, force
dvander@352
   330
	 * the user to resolve these himself!
dvander@352
   331
	 */
dvander@352
   332
	if (!pathstr_isabsolute(relTo)
dvander@352
   333
		|| !pathstr_isabsolute(relFrom))
dvander@352
   334
	{
dvander@352
   335
		return false;
dvander@352
   336
	}
dvander@352
   337
dvander@352
   338
#if defined WIN32
dvander@352
   339
	/* Relative paths across drives are not possible */
dvander@352
   340
	if (!pathchar_cmp(relTo[0], relFrom[0]))
dvander@352
   341
	{
dvander@352
   342
		return false;
dvander@352
   343
	}
dvander@352
   344
	/* Get rid of the drive and semicolon part */
dvander@352
   345
	relTo = &relTo[2];
dvander@352
   346
	relFrom = &relFrom[2];
dvander@352
   347
#endif
dvander@352
   348
dvander@352
   349
	/* Eliminate the common root between the paths */
dvander@352
   350
	const char *rootTo = NULL;
dvander@352
   351
	const char *rootFrom = NULL;
dvander@352
   352
	while (*relTo != '\0' && *relFrom != '\0')
dvander@352
   353
	{
dvander@352
   354
		/* If we get to a new path sequence, start over */
dvander@352
   355
		if (pathchar_sep(*relTo)
dvander@352
   356
			&& pathchar_sep(*relFrom))
dvander@352
   357
		{
dvander@352
   358
			rootTo = relTo;
dvander@352
   359
			rootFrom = relFrom;
dvander@352
   360
		/* If the paths don't compare, stop looking for a common root */
dvander@352
   361
		} else if (!pathchar_cmp(*relTo, *relFrom)) {
dvander@352
   362
			break;
dvander@352
   363
		}
dvander@352
   364
		relTo++;
dvander@352
   365
		relFrom++;
dvander@352
   366
	}
dvander@352
   367
dvander@352
   368
	/* NULLs shouldn't happen! */
dvander@352
   369
	if (rootTo == NULL
dvander@352
   370
		|| rootFrom == NULL)
dvander@352
   371
	{
dvander@352
   372
		return false;
dvander@352
   373
	}
dvander@352
   374
dvander@352
   375
	size_t numLevels = 0;
dvander@352
   376
dvander@352
   377
	/* The root case is special! 
dvander@352
   378
	 * Don't count anything from it.
dvander@352
   379
	 */
dvander@352
   380
	if (*(rootTo + 1) != '\0')
dvander@352
   381
	{
dvander@352
   382
		/* Search for how many levels we need to go up.
dvander@352
   383
	 	 * Since the root pointer points to a '/', we increment
dvander@352
   384
		 * the initial pointer by one.
dvander@352
   385
		 */
dvander@352
   386
		while (*rootTo != '\0')
dvander@352
   387
		{
dvander@352
   388
			if (pathchar_sep(*rootTo))
dvander@352
   389
			{
dvander@352
   390
				/* Check for an improper trailing slash,
dvander@352
   391
				 * just to be nice even though the user 
dvander@352
   392
				 * should NOT have done this!
dvander@352
   393
				 */
dvander@352
   394
				if (*(rootTo + 1) == '\0')
dvander@352
   395
				{
dvander@352
   396
					break;
dvander@352
   397
				}
dvander@352
   398
				numLevels++;
dvander@352
   399
			}
dvander@352
   400
			rootTo++;
dvander@352
   401
		}
dvander@352
   402
	}
dvander@352
   403
dvander@352
   404
	/* Now build the new relative path. */
dvander@352
   405
	size_t len, total = 0;
dvander@352
   406
	while (numLevels--)
dvander@352
   407
	{
dvander@352
   408
		len = _snprintf(&buffer[total], maxlength - total, ".." PATH_SEP_STR);
dvander@352
   409
		if (len >= maxlength - total)
dvander@352
   410
		{
dvander@352
   411
			/* Not enough space in the buffer */
dvander@352
   412
			return false;
dvander@352
   413
		}
dvander@352
   414
		total += len;
dvander@352
   415
	}
dvander@352
   416
dvander@352
   417
	/* Add the absolute path. */
dvander@352
   418
	len = _snprintf(&buffer[total], maxlength - total, "%s", &rootFrom[1]);
dvander@352
   419
	if (len >= maxlength - total)
dvander@352
   420
	{
dvander@352
   421
		return false;
dvander@352
   422
	}
dvander@352
   423
dvander@352
   424
	return true;
dvander@352
   425
}