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