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

/**

    33

 * Valid filter types for IsValidAsciiChar.

    34

 */

    35

typedef enum CharSetFilter {

    36

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

    37

	CS_NUMERAL,           //! Only numeric ones

    38

	CS_ALPHA,             //! Only alphabetic values

    39

} CharSetFilter;

    40

    41

/**

    42

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

    43

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

    44

 * @param key character to be checked

    45

 * @param afilter the filter to use

    46

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

    47

 */

    48

bool IsValidAsciiChar(byte key, CharSetFilter afilter);

    49

    50

/** Convert the given string to lowercase */

    51

void strtolower(char *str);

    52

    53

#endif /* STRING_H */