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

typedef uint32 WChar;

    50

    51

/**

    52

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

    53

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

    54

 * @param key character to be checked

    55

 * @param afilter the filter to use

    56

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

    57

 */

    58

bool IsValidChar(WChar key, CharSetFilter afilter);

    59

    60

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

    61

size_t Utf8Encode(char *buf, WChar c);

    62

    63

    64

static inline WChar Utf8Consume(const char **s)

    65

{

    66

	WChar c;

    67

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

    68

	return c;

    69

}

    70

    71

    72

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

    73

 * @param c Unicode character.

    74

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

    75

 */

    76

static inline size_t Utf8CharLen(WChar c)

    77

{

    78

	if (c < 0x80)       return 1;

    79

	if (c < 0x800)      return 2;

    80

	if (c < 0x10000)    return 3;

    81

	if (c < 0x110000)   return 4;

    82

    83

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

    84

	return 1;

    85

}

    86

    87

    88

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

    89

static inline bool IsUtf8Part(char c)

    90

{

    91

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

    92

}

    93

    94

    95

static inline bool IsPrintable(WChar c)

    96

{

    97

	if (c < 0x20)   return false;

    98

	if (c < 0xE000) return true;

    99

	if (c < 0xE200) return false;

   100

	return true;

   101

}

   102

   103

   104

#endif /* STRING_H */