|
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 |
#ifndef _INCLUDE_UTIL_H |
|
dvander@347
|
12 |
#define _INCLUDE_UTIL_H |
|
dvander@347
|
13 |
|
|
dvander@347
|
14 |
#include <stdarg.h> |
|
dvander@347
|
15 |
|
|
dvander@347
|
16 |
/** |
|
dvander@347
|
17 |
* @brief Utility functions |
|
dvander@347
|
18 |
* @file util.h |
|
dvander@347
|
19 |
*/ |
|
dvander@347
|
20 |
|
|
dvander@347
|
21 |
/** |
|
dvander@348
|
22 |
* @brief Returns true is string is not blank, false otherwise. |
|
dvander@348
|
23 |
*/ |
|
dvander@348
|
24 |
#define IS_STR_FILLED(var) (var != NULL && var[0] != '\0') |
|
dvander@348
|
25 |
|
|
dvander@348
|
26 |
/** |
|
dvander@347
|
27 |
* @brief Returns a pointer to the extension in a file name. |
|
dvander@347
|
28 |
*/ |
|
dvander@347
|
29 |
const char *UTIL_GetExtension(const char *file); |
|
dvander@347
|
30 |
|
|
dvander@347
|
31 |
/** |
|
dvander@347
|
32 |
* @brief Removes C-style comments from string. |
|
dvander@347
|
33 |
*/ |
|
dvander@347
|
34 |
void UTIL_TrimComments(char *buffer); |
|
dvander@347
|
35 |
|
|
dvander@347
|
36 |
/** |
|
dvander@347
|
37 |
* @brief Removes whitespace characters from left side of string. |
|
dvander@347
|
38 |
*/ |
|
dvander@347
|
39 |
void UTIL_TrimLeft(char *buffer); |
|
dvander@347
|
40 |
|
|
dvander@347
|
41 |
/** |
|
dvander@347
|
42 |
* @brief Removes whitespace characters from right side of string. |
|
dvander@347
|
43 |
*/ |
|
dvander@347
|
44 |
void UTIL_TrimRight(char *buffer); |
|
dvander@347
|
45 |
|
|
dvander@347
|
46 |
/** |
|
dvander@347
|
47 |
* @brief Breaks a string at the first space until it reaches a non-space. |
|
dvander@347
|
48 |
*/ |
|
dvander@347
|
49 |
void UTIL_KeySplit(const char *str, char *buf1, size_t len1, char *buf2, size_t len2); |
|
dvander@347
|
50 |
|
|
dvander@347
|
51 |
/** |
|
dvander@347
|
52 |
* @brief Compares two file paths. |
|
dvander@347
|
53 |
*/ |
|
dvander@347
|
54 |
bool UTIL_PathCmp(const char *path1, const char *path2); |
|
dvander@347
|
55 |
|
|
dvander@347
|
56 |
/** |
|
dvander@347
|
57 |
* @brief Same as snprintf except that it ensures the string buffer is null terminated. |
|
dvander@347
|
58 |
*/ |
|
dvander@347
|
59 |
size_t UTIL_Format(char *buffer, size_t maxlength, const char *fmt, ...); |
|
dvander@347
|
60 |
|
|
dvander@347
|
61 |
/** |
|
dvander@347
|
62 |
* @brief Same as vsnprintf except that it ensures the string buffer is null terminated. |
|
dvander@347
|
63 |
*/ |
|
dvander@347
|
64 |
size_t UTIL_FormatArgs(char *buffer, size_t maxlength, const char *fmt, va_list params); |
|
dvander@347
|
65 |
|
|
dvander@347
|
66 |
/** |
|
dvander@347
|
67 |
* @brief Forms a relative path given two absolute paths. |
|
dvander@347
|
68 |
* |
|
dvander@347
|
69 |
* @param buffer Buffer to store relative path in. |
|
dvander@347
|
70 |
* @param maxlength Maximum length of the output buffer. |
|
dvander@347
|
71 |
* @param relTo Destination folder to use as a working directory. |
|
dvander@347
|
72 |
* Final folder name should not be pathchar-terminated. |
|
dvander@347
|
73 |
* @param relFrom Source file or folder to use as a target. |
|
dvander@347
|
74 |
* @return True on success, false on failure. |
|
dvander@347
|
75 |
*/ |
|
dvander@347
|
76 |
bool UTIL_Relatize(char buffer[], |
|
dvander@347
|
77 |
size_t maxlength, |
|
dvander@347
|
78 |
const char *relTo, |
|
dvander@347
|
79 |
const char *relFrom); |
|
dvander@347
|
80 |
|
|
dvander@347
|
81 |
#endif //_INCLUDE_UTIL_H |