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