1

/* $Id$ */

     2

     3

#ifndef STRING_H

     4

#define STRING_H

     5

     6

/*

     7

 * dst: destination buffer

     8

 * src: string to copy/concatenate

     9

 * size: size of the destination buffer

    10

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

    11

 */

    12

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

    13

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

    14

    15

/*

    16

 * dst: destination buffer

    17

 * src: string to copy

    18

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

    19

 *       if NULL no boundary check is performed

    20

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

    21

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

    22

 */

    23

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

    24

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

    25

    26

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

    27

    28

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

    29

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

    30

void str_validate(char *str);

    31

    32

/** Convert the given string to lowercase */

    33

void strtolower(char *str);

    34

    35

/** Only allow valid ascii-function codes. Filter special codes like BELL and

    36

 * so on [we need a special filter here later]

    37

 * @param key character to be checked

    38

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

    39

static inline bool IsValidAsciiChar(byte key)

    40

{

    41

	// XXX This filter stops certain crashes, but may be too restrictive.

    42

	return (key >= ' ' && key < 127) || (key >= 160 &&

    43

		key != 0xAA && key != 0xAC && key != 0xAD && key != 0xAF &&

    44

		key != 0xB5 && key != 0xB6 && key != 0xB7 && key != 0xB9);

    45

}

    46

    47

#endif /* STRING_H */