dvander@347: /* ======== SourceMM ======== dvander@347: * Copyright (C) 2004-2007 Metamod:Source Development Team dvander@347: * No warranties of any kind dvander@347: * dvander@347: * License: zlib/libpng dvander@347: * dvander@347: * Author(s): David "BAILOPAN" Anderson dvander@347: * ============================ dvander@347: */ dvander@347: dvander@347: #ifndef _INCLUDE_UTIL_H dvander@347: #define _INCLUDE_UTIL_H dvander@347: dvander@347: #include dvander@347: dvander@347: /** dvander@347: * @brief Utility functions dvander@347: * @file util.h dvander@347: */ dvander@347: dvander@347: /** dvander@348: * @brief Returns true is string is not blank, false otherwise. dvander@348: */ dvander@348: #define IS_STR_FILLED(var) (var != NULL && var[0] != '\0') dvander@348: dvander@348: /** dvander@347: * @brief Returns a pointer to the extension in a file name. dvander@347: */ dvander@347: const char *UTIL_GetExtension(const char *file); dvander@347: dvander@347: /** dvander@347: * @brief Removes C-style comments from string. dvander@347: */ dvander@347: void UTIL_TrimComments(char *buffer); dvander@347: dvander@347: /** dvander@347: * @brief Removes whitespace characters from left side of string. dvander@347: */ dvander@347: void UTIL_TrimLeft(char *buffer); dvander@347: dvander@347: /** dvander@347: * @brief Removes whitespace characters from right side of string. dvander@347: */ dvander@347: void UTIL_TrimRight(char *buffer); dvander@347: dvander@347: /** dvander@347: * @brief Breaks a string at the first space until it reaches a non-space. dvander@347: */ dvander@347: void UTIL_KeySplit(const char *str, char *buf1, size_t len1, char *buf2, size_t len2); dvander@347: dvander@347: /** dvander@347: * @brief Compares two file paths. dvander@347: */ dvander@347: bool UTIL_PathCmp(const char *path1, const char *path2); dvander@347: dvander@347: /** dvander@347: * @brief Same as snprintf except that it ensures the string buffer is null terminated. dvander@347: */ dvander@347: size_t UTIL_Format(char *buffer, size_t maxlength, const char *fmt, ...); dvander@347: dvander@347: /** dvander@347: * @brief Same as vsnprintf except that it ensures the string buffer is null terminated. dvander@347: */ dvander@347: size_t UTIL_FormatArgs(char *buffer, size_t maxlength, const char *fmt, va_list params); dvander@347: dvander@347: /** dvander@347: * @brief Forms a relative path given two absolute paths. dvander@347: * dvander@347: * @param buffer Buffer to store relative path in. dvander@347: * @param maxlength Maximum length of the output buffer. dvander@347: * @param relTo Destination folder to use as a working directory. dvander@347: * Final folder name should not be pathchar-terminated. dvander@347: * @param relFrom Source file or folder to use as a target. dvander@347: * @return True on success, false on failure. dvander@347: */ dvander@347: bool UTIL_Relatize(char buffer[], dvander@347: size_t maxlength, dvander@347: const char *relTo, dvander@347: const char *relFrom); dvander@347: dvander@347: #endif //_INCLUDE_UTIL_H