1

/* $Id$ */

     2

     3

#ifndef STRING_H

     4

#define STRING_H

     5

     6

#include "macros.h"

     7

     8

/*

     9

 * dst: destination buffer

    10

 * src: string to copy/concatenate

    11

 * size: size of the destination buffer

    12

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

    13

 */

    14

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

    15

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

    16

    17

/*

    18

 * dst: destination buffer

    19

 * src: string to copy

    20

 * last: pointer to the last element in the dst array

    21

 *       if NULL no boundary check is performed

    22

 * returns a pointer to the terminating \0 in the destination buffer

    23

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

    24

 */

    25

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

    26

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

    27

    28

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

    29

    30

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

    31

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

    32

void str_validate(char *str);

    33

    34

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

    35

void str_strip_colours(char *str);

    36

    37

/**

    38

 * Valid filter types for IsValidChar.

    39

 */

    40

typedef enum CharSetFilter {

    41

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

    42

	CS_NUMERAL,           //! Only numeric ones

    43

	CS_ALPHA,             //! Only alphabetic values

    44

} CharSetFilter;

    45

    46

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

    47

void strtolower(char *str);

    48

    49

    50

static inline bool StrEmpty(const char* s) { return s[0] == '\0'; }

    51

    52

    53

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

    54

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

    55

{

    56

	const char *t;

    57

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

    58

	return t - str;

    59

}

    60

    61

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

    62

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

    63

    64

typedef uint32 WChar;

    65

    66

/**

    67

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

    68

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

    69

 * @param key character to be checked

    70

 * @param afilter the filter to use

    71

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

    72

 */

    73

bool IsValidChar(WChar key, CharSetFilter afilter);

    74

    75

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

    76

size_t Utf8Encode(char *buf, WChar c);

    77

    78

    79

static inline WChar Utf8Consume(const char **s)

    80

{

    81

	WChar c;

    82

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

    83

	return c;

    84

}

    85

    86

    87

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

    88

 * @param c Unicode character.

    89

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

    90

 */

    91

static inline size_t Utf8CharLen(WChar c)

    92

{

    93

	if (c < 0x80)       return 1;

    94

	if (c < 0x800)      return 2;

    95

	if (c < 0x10000)    return 3;

    96

	if (c < 0x110000)   return 4;

    97

    98

	/* Invalid valid, we encode as a '?' */

    99

	return 1;

   100

}

   101

   102

   103

/* Check if the given character is part of a UTF8 sequence */

   104

static inline bool IsUtf8Part(char c)

   105

{

   106

	return GB(c, 6, 2) == 2;

   107

}

   108

   109

   110

static inline bool IsPrintable(WChar c)

   111

{

   112

	if (c < 0x20)   return false;

   113

	if (c < 0xE000) return true;

   114

	if (c < 0xE200) return false;

   115

	return true;

   116

}

   117

   118

   119

#endif /* STRING_H */