#ifndef STRING_H

#define STRING_H

#include "macros.h"

/**

 * usage ttd_strlcpy(dst, src, lengthof(dst));

 * @param dst destination buffer

 * @param src string to copy/concatenate

 * @param size size of the destination buffer

 */

void ttd_strlcat(char *dst, const char *src, size_t size);

void ttd_strlcpy(char *dst, const char *src, size_t size);

/**

 * usage: strecpy(dst, src, lastof(dst));

 * @param dst destination buffer

 * @param src string to copy

 * @param last pointer to the last element in the dst array

 *             if NULL no boundary check is performed

 * @return a pointer to the terminating \0 in the destination buffer

 */

char *strecat(char *dst, const char *src, const char *last);

char *strecpy(char *dst, const char *src, const char *last);

char *CDECL str_fmt(const char *str, ...);

/** Scans the string for valid characters and if it finds invalid ones,

 * replaces them with a question mark '?' */

void str_validate(char *str);

/** Scans the string for colour codes and strips them */

void str_strip_colours(char *str);

/**

 * Valid filter types for IsValidChar.

 */

enum CharSetFilter {

	CS_ALPHANUMERAL,      ///< Both numeric and alphabetic and spaces and stuff

	CS_NUMERAL,           ///< Only numeric ones

	CS_ALPHA,             ///< Only alphabetic values

};

/** Convert the given string to lowercase, only works with ASCII! */

void strtolower(char *str);

/** Get the length of a string, within a limited buffer */

static inline int ttd_strnlen(const char *str, int maxlen)

{

	const char *t;

	for (t = str; *t != '\0' && t - str < maxlen; t++);

	return t - str;

}

/** Convert the md5sum number to a 'hexadecimal' string, return next pos in buffer */

char *md5sumToString(char *buf, const char *last, const uint8 md5sum[16]);

typedef uint32 WChar;

/**

 * Only allow certain keys. You can define the filter to be used. This makes

 *  sure no invalid keys can get into an editbox, like BELL.

 * @param key character to be checked

 * @param afilter the filter to use

 * @return true or false depending if the character is printable/valid or not

 */

bool IsValidChar(WChar key, CharSetFilter afilter);

size_t Utf8Decode(WChar *c, const char *s);

size_t Utf8Encode(char *buf, WChar c);

size_t Utf8TrimString(char *s, size_t maxlen);

static inline WChar Utf8Consume(const char **s)

{

	WChar c;

	*s += Utf8Decode(&c, *s);

	return c;

}

/** Return the length of a UTF-8 encoded character.

 * @param c Unicode character.

 * @return Length of UTF-8 encoding for character.

 */

static inline size_t Utf8CharLen(WChar c)

{

	if (c < 0x80)       return 1;

	if (c < 0x800)      return 2;

	if (c < 0x10000)    return 3;

	if (c < 0x110000)   return 4;