knight/shared/KeCommon.h
author David Anderson <dvander@alliedmods.net>
Sun Aug 11 11:30:27 2013 -0700 (2013-08-11)
changeset 3984 d94a0d3bc008
parent 2226 d10b38524be3
permissions -rw-r--r--
Clean up INFO register structure (bug 5844 part 1, r=ds).
dvander@2226
     1
#ifndef _INCLUDE_KNIGHT_KE_COMMON_UTILS_H_
dvander@2226
     2
#define _INCLUDE_KNIGHT_KE_COMMON_UTILS_H_
dvander@2226
     3
dvander@2226
     4
#include <stddef.h>
dvander@2226
     5
#include <stdarg.h>
dvander@2226
     6
dvander@2226
     7
namespace Knight
dvander@2226
     8
{
dvander@2226
     9
	/**
dvander@2226
    10
	 * @brief Formats a buffer with C platform rules.
dvander@2226
    11
	 *
dvander@2226
    12
	 * Unlink platform snprintf, this will never return nonsense values like -1.
dvander@2226
    13
	 *
dvander@2226
    14
	 * @param buffer			Buffer to store to.
dvander@2226
    15
	 * @param maxlength			Maximum length of buffer (including null terminator).
dvander@2226
    16
	 * @param fmt				printf() format string.
dvander@2226
    17
	 * @param ...				Formatting arguments.
dvander@2226
    18
	 * @return					Number of characters written.
dvander@2226
    19
	 */
dvander@2226
    20
	extern size_t KE_PFormat(char *buffer, size_t maxlength, const char *fmt, ...);
dvander@2226
    21
dvander@2226
    22
	/**
dvander@2226
    23
	 * @brief Formats a buffer with C platform rules.
dvander@2226
    24
	 *
dvander@2226
    25
	 * Unlink platform snprintf, this will never return nonsense values like -1.
dvander@2226
    26
	 *
dvander@2226
    27
	 * @param buffer			Buffer to store to.
dvander@2226
    28
	 * @param maxlength			Maximum length of buffer (including null terminator).
dvander@2226
    29
	 * @param fmt				printf() format string.
dvander@2226
    30
	 * @param args				Formatting arguments.
dvander@2226
    31
	 * @return					Number of characters written.
dvander@2226
    32
	 */
dvander@2226
    33
	extern size_t KE_PFormatArgs(char *buffer, size_t maxlength, const char *fmt, va_list args);
dvander@2226
    34
}
dvander@2226
    35
dvander@2226
    36
#endif //_INCLUDE_KNIGHT_KE_COMMON_UTILS_H_