|
dvander@371
|
1 |
/** |
|
dvander@371
|
2 |
* vim: set ts=4 : |
|
dvander@371
|
3 |
* ====================================================== |
|
dvander@371
|
4 |
* Metamod:Source |
|
dvander@371
|
5 |
* Copyright (C) 2004-2007 AlliedModders LLC and authors. |
|
dvander@371
|
6 |
* All rights reserved. |
|
dvander@371
|
7 |
* ====================================================== |
|
dvander@371
|
8 |
* |
|
dvander@371
|
9 |
* This software is provided 'as-is', without any express or implied warranty. |
|
dvander@371
|
10 |
* In no event will the authors be held liable for any damages arising from |
|
dvander@371
|
11 |
* the use of this software. |
|
dvander@371
|
12 |
* |
|
dvander@371
|
13 |
* Permission is granted to anyone to use this software for any purpose, |
|
dvander@371
|
14 |
* including commercial applications, and to alter it and redistribute it |
|
dvander@371
|
15 |
* freely, subject to the following restrictions: |
|
dvander@371
|
16 |
* |
|
dvander@371
|
17 |
* 1. The origin of this software must not be misrepresented; you must not |
|
dvander@371
|
18 |
* claim that you wrote the original software. If you use this software in a |
|
dvander@371
|
19 |
* product, an acknowledgment in the product documentation would be |
|
dvander@371
|
20 |
* appreciated but is not required. |
|
dvander@371
|
21 |
* 2. Altered source versions must be plainly marked as such, and must not be |
|
dvander@371
|
22 |
* misrepresented as being the original software. |
|
dvander@371
|
23 |
* 3. This notice may not be removed or altered from any source distribution. |
|
dvander@371
|
24 |
* |
|
dvander@371
|
25 |
* Version: $Id$ |
|
dvander@371
|
26 |
*/ |
|
dvander@371
|
27 |
|
|
dvander@371
|
28 |
#ifndef _INCLUDE_UTIL_H |
|
dvander@371
|
29 |
#define _INCLUDE_UTIL_H |
|
dvander@371
|
30 |
|
|
dvander@371
|
31 |
#include <stdarg.h> |
|
dvander@371
|
32 |
|
|
dvander@371
|
33 |
/** |
|
dvander@371
|
34 |
* @brief Utility functions |
|
dvander@371
|
35 |
* @file util.h |
|
dvander@371
|
36 |
*/ |
|
dvander@371
|
37 |
|
|
dvander@371
|
38 |
/** |
|
dvander@371
|
39 |
* @brief Returns true is string is not blank, false otherwise. |
|
dvander@371
|
40 |
*/ |
|
dvander@371
|
41 |
#define IS_STR_FILLED(var) (var != NULL && var[0] != '\0') |
|
dvander@371
|
42 |
|
|
dvander@371
|
43 |
/** |
|
dvander@371
|
44 |
* @brief Returns a pointer to the extension in a file name. |
|
dvander@371
|
45 |
*/ |
|
dvander@371
|
46 |
const char *UTIL_GetExtension(const char *file); |
|
dvander@371
|
47 |
|
|
dvander@371
|
48 |
/** |
|
dvander@371
|
49 |
* @brief Removes C-style comments from string. |
|
dvander@371
|
50 |
*/ |
|
dvander@371
|
51 |
void UTIL_TrimComments(char *buffer); |
|
dvander@371
|
52 |
|
|
dvander@371
|
53 |
/** |
|
dvander@371
|
54 |
* @brief Removes whitespace characters from left side of string. |
|
dvander@371
|
55 |
*/ |
|
dvander@371
|
56 |
void UTIL_TrimLeft(char *buffer); |
|
dvander@371
|
57 |
|
|
dvander@371
|
58 |
/** |
|
dvander@371
|
59 |
* @brief Removes whitespace characters from right side of string. |
|
dvander@371
|
60 |
*/ |
|
dvander@371
|
61 |
void UTIL_TrimRight(char *buffer); |
|
dvander@371
|
62 |
|
|
dvander@371
|
63 |
/** |
|
dvander@371
|
64 |
* @brief Breaks a string at the first space until it reaches a non-space. |
|
dvander@371
|
65 |
*/ |
|
dvander@371
|
66 |
void UTIL_KeySplit(const char *str, char *buf1, size_t len1, char *buf2, size_t len2); |
|
dvander@371
|
67 |
|
|
dvander@371
|
68 |
/** |
|
dvander@371
|
69 |
* @brief Compares two file paths. |
|
dvander@371
|
70 |
*/ |
|
dvander@371
|
71 |
bool UTIL_PathCmp(const char *path1, const char *path2); |
|
dvander@371
|
72 |
|
|
dvander@371
|
73 |
/** |
|
dvander@371
|
74 |
* @brief Same as snprintf except that it ensures the string buffer is null terminated. |
|
dvander@371
|
75 |
*/ |
|
dvander@371
|
76 |
size_t UTIL_Format(char *buffer, size_t maxlength, const char *fmt, ...); |
|
dvander@371
|
77 |
|
|
dvander@371
|
78 |
/** |
|
dvander@371
|
79 |
* @brief Same as vsnprintf except that it ensures the string buffer is null terminated. |
|
dvander@371
|
80 |
*/ |
|
dvander@371
|
81 |
size_t UTIL_FormatArgs(char *buffer, size_t maxlength, const char *fmt, va_list params); |
|
dvander@371
|
82 |
|
|
dvander@371
|
83 |
/** |
|
dvander@371
|
84 |
* @brief Forms a relative path given two absolute paths. |
|
dvander@371
|
85 |
* |
|
dvander@371
|
86 |
* @param buffer Buffer to store relative path in. |
|
dvander@371
|
87 |
* @param maxlength Maximum length of the output buffer. |
|
dvander@371
|
88 |
* @param relTo Destination folder to use as a working directory. |
|
dvander@371
|
89 |
* Final folder name should not be pathchar-terminated. |
|
dvander@371
|
90 |
* @param relFrom Source file or folder to use as a target. |
|
dvander@371
|
91 |
* @return True on success, false on failure. |
|
dvander@371
|
92 |
*/ |
|
dvander@371
|
93 |
bool UTIL_Relatize(char buffer[], |
|
dvander@371
|
94 |
size_t maxlength, |
|
dvander@371
|
95 |
const char *relTo, |
|
dvander@371
|
96 |
const char *relFrom); |
|
dvander@371
|
97 |
|
|
dvander@485
|
98 |
void LogMessage(const char *msg, ...); |
|
dvander@485
|
99 |
|
|
dvander@371
|
100 |
#endif //_INCLUDE_UTIL_H |