utf8lib.h

   1 /*
   2  * UTF-8 utility functions for DarkPlaces
   3  */
   4 #ifndef UTF8LIB_H__
   5 #define UTF8LIB_H__
   6
   7 #include "qtypes.h"
   8
   9 // types for unicode strings
  10 // let them be 32 bit for now
  11 // normally, whcar_t is 16 or 32 bit, 16 on linux I think, 32 on haiku and maybe windows
  12
  13 // Uchar, a wide character
  14 typedef int32_t Uchar;
  15
  16 // Initialize UTF8, this registers cvars which allows for UTF8 to be disabled
  17 // completely.
  18 // When UTF8 is disabled, every u8_ function will work exactly as you'd expect
  19 // a non-utf8 version to work: u8_strlen() will wrap to strlen()
  20 // u8_byteofs() and u8_charidx() will simply return whatever is passed as index parameter
  21 // u8_getchar() will will just return the next byte, u8_fromchar will write one byte, ...
  22 extern cvar_t    utf8_enable;
  23 void   u8_Init(void);
  24
  25 size_t u8_strlen(const char*);
  26 size_t u8_strnlen(const char*, size_t);
  27 int    u8_byteofs(const char*, size_t, size_t*);
  28 int    u8_charidx(const char*, size_t, size_t*);
  29 size_t u8_bytelen(const char*, size_t);
  30 size_t u8_prevbyte(const char*, size_t);
  31 Uchar  u8_getchar_utf8_enabled(const char*, const char**);
  32 Uchar  u8_getnchar_utf8_enabled(const char*, const char**, size_t);
  33 int    u8_fromchar(Uchar, char*, size_t);
  34 size_t u8_mbstowcs(Uchar *, const char *, size_t);
  35 size_t u8_wcstombs(char*, const Uchar*, size_t);
  36 size_t u8_COM_StringLengthNoColors(const char *s, size_t size_s, qbool *valid);
  37
  38 // returns a static buffer, use this for inlining
  39 char  *u8_encodech(Uchar ch, size_t*, char*buf16);
  40
  41 size_t u8_strpad(char *out, size_t outsize, const char *in, qbool leftalign, size_t minwidth, size_t maxwidth);
  42 size_t u8_strpad_colorcodes(char *out, size_t outsize, const char *in, qbool leftalign, size_t minwidth, size_t maxwidth);
  43
  44 /* Careful: if we disable utf8 but not freetype, we wish to see freetype chars
  45  * for normal letters. So use E000+x for special chars, but leave the freetype stuff for the
  46  * rest:
  47  */
  48 extern Uchar u8_quake2utf8map[256];
  49 // these defines get a bit tricky, as c and e may be aliased to the same variable
  50 #define u8_getchar(c,e) (utf8_enable.integer ? u8_getchar_utf8_enabled(c,e) : (u8_quake2utf8map[(unsigned char)(*(e) = (c) + 1)[-1]]))
  51 #define u8_getchar_noendptr(c) (utf8_enable.integer ? u8_getchar_utf8_enabled(c,NULL) : (u8_quake2utf8map[(unsigned char)*(c)]))
  52 #define u8_getchar_check(c,e) ((e) ? u8_getchar((c),(e)) : u8_getchar_noendptr((c)))
  53 #define u8_getnchar(c,e,n) (utf8_enable.integer ? u8_getnchar_utf8_enabled(c,e,n) : ((n) <= 0 ? ((*(e) = c), 0) : (u8_quake2utf8map[(unsigned char)(*(e) = (c) + 1)[-1]])))
  54 #define u8_getnchar_noendptr(c,n) (utf8_enable.integer ? u8_getnchar_utf8_enabled(c,NULL,n) : ((n) <= 0 ? 0  : (u8_quake2utf8map[(unsigned char)*(c)])))
  55 #define u8_getnchar_check(c,e,n) ((e) ? u8_getchar((c),(e),(n)) : u8_getchar_noendptr((c),(n)))
  56
  57 Uchar u8_toupper(Uchar ch);
  58 Uchar u8_tolower(Uchar ch);
  59
  60 #endif // UTF8LIB_H__