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