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