sourcemm/util.h
author Scott Ehlert <ds@alliedmods.net>
Fri Aug 10 23:43:16 2007 +0000 (2007-08-10)
changeset 346 d0868271663a
parent 320 c955cb69efe3
permissions -rw-r--r--
Reformatted output of meta list command
dvander@7
     1
/* ======== SourceMM ========
dvander@282
     2
 * Copyright (C) 2004-2007 Metamod:Source Development Team
dvander@282
     3
 * No warranties of any kind
dvander@282
     4
 *
dvander@282
     5
 * License: zlib/libpng
dvander@282
     6
 *
dvander@282
     7
 * Author(s): David "BAILOPAN" Anderson
dvander@282
     8
 * ============================
dvander@282
     9
 */
dvander@7
    10
dvander@7
    11
#ifndef _INCLUDE_UTIL_H
dvander@7
    12
#define _INCLUDE_UTIL_H
dvander@7
    13
ds@296
    14
#include <stdarg.h>
ds@296
    15
dvander@7
    16
/**
ds@296
    17
 * @brief Utility functions
dvander@7
    18
 * @file util.h
dvander@7
    19
 */
dvander@7
    20
ds@296
    21
/**
ds@346
    22
 * @brief Returns true is string is not blank, false otherwise.
ds@346
    23
 */
ds@346
    24
#define IS_STR_FILLED(var) (var != NULL && var[0] != '\0')
ds@346
    25
ds@346
    26
/**
ds@296
    27
 * @brief Returns a pointer to the extension in a file name.
ds@296
    28
 */
dvander@7
    29
const char *UTIL_GetExtension(const char *file);
ds@296
    30
ds@296
    31
/**
ds@296
    32
 * @brief Removes C-style comments from string.
ds@296
    33
 */
dvander@122
    34
void UTIL_TrimComments(char *buffer);
ds@296
    35
ds@296
    36
/**
ds@296
    37
 * @brief Removes whitespace characters from left side of string.
ds@296
    38
 */
ds@84
    39
void UTIL_TrimLeft(char *buffer);
ds@296
    40
ds@296
    41
/**
ds@296
    42
 * @brief Removes whitespace characters from right side of string.
ds@296
    43
 */
ds@84
    44
void UTIL_TrimRight(char *buffer);
ds@296
    45
ds@296
    46
/**
ds@296
    47
 * @brief Breaks a string at the first space until it reaches a non-space.
ds@296
    48
 */
dvander@122
    49
void UTIL_KeySplit(const char *str, char *buf1, size_t len1, char *buf2, size_t len2);
ds@296
    50
ds@296
    51
/**
ds@296
    52
 * @brief Compares two file paths.
ds@296
    53
 */
dvander@122
    54
bool UTIL_PathCmp(const char *path1, const char *path2);
dvander@7
    55
ds@296
    56
/**
ds@296
    57
 * @brief Same as snprintf except that it ensures the string buffer is null terminated.
ds@296
    58
 */
ds@296
    59
size_t UTIL_Format(char *buffer, size_t maxlength, const char *fmt, ...);
ds@296
    60
ds@296
    61
/**
ds@296
    62
 * @brief Same as vsnprintf except that it ensures the string buffer is null terminated.
ds@296
    63
 */
dvander@320
    64
size_t UTIL_FormatArgs(char *buffer, size_t maxlength, const char *fmt, va_list params);
ds@296
    65
dvander@320
    66
/**
dvander@320
    67
 * @brief Forms a relative path given two absolute paths.
dvander@320
    68
 *
dvander@320
    69
 * @param buffer		Buffer to store relative path in.
dvander@320
    70
 * @param maxlength		Maximum length of the output buffer.
dvander@320
    71
 * @param relTo			Destination folder to use as a working directory.
dvander@320
    72
 *						Final folder name should not be pathchar-terminated.
dvander@320
    73
 * @param relFrom		Source file or folder to use as a target.
dvander@320
    74
 * @return				True on success, false on failure.
dvander@320
    75
 */
dvander@320
    76
bool UTIL_Relatize(char buffer[],
dvander@320
    77
				   size_t maxlength,
dvander@320
    78
				   const char *relTo,
dvander@320
    79
				   const char *relFrom);
ds@296
    80
dvander@7
    81
#endif //_INCLUDE_UTIL_H