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 #ifdef _MSC_VER
  13 typedef __int32 U_int32;
  14 #else
  15 #include <stdint.h>
  16 #include <sys/types.h>
  17 typedef int32_t U_int32;
  18 #endif
  19
  20 // Uchar, a wide character
  21 typedef U_int32 Uchar;
  22
  23 // Initialize UTF8, this registers cvars which allows for UTF8 to be disabled
  24 // completely.
  25 // When UTF8 is disabled, every u8_ function will work exactly as you'd expect
  26 // a non-utf8 version to work: u8_strlen() will wrap to strlen()
  27 // u8_byteofs() and u8_charidx() will simply return whatever is passed as index parameter
  28 // u8_getchar() will will just return the next byte, u8_fromchar will write one byte, ...
  29 extern cvar_t    utf8_enable;
  30 void   u8_Init(void);
  31
  32 size_t u8_strlen(const char*);
  33 size_t u8_strnlen(const char*, size_t);
  34 int    u8_byteofs(const char*, size_t, size_t*);
  35 int    u8_charidx(const char*, size_t, size_t*);
  36 size_t u8_bytelen(const char*, size_t);
  37 size_t u8_prevbyte(const char*, size_t);
  38 Uchar  u8_getchar_utf8_enabled(const char*, const char**);
  39 Uchar  u8_getnchar_utf8_enabled(const char*, const char**, size_t);
  40 int    u8_fromchar(Uchar, char*, size_t);
  41 size_t u8_mbstowcs(Uchar *, const char *, size_t);
  42 size_t u8_wcstombs(char*, const Uchar*, size_t);
  43 size_t u8_COM_StringLengthNoColors(const char *s, size_t size_s, qboolean *valid);
  44
  45 // returns a static buffer, use this for inlining
  46 char  *u8_encodech(Uchar ch, size_t*, char*buf16);
  47
  48 size_t u8_strpad(char *out, size_t outsize, const char *in, qboolean leftalign, size_t minwidth, size_t maxwidth);
  49 size_t u8_strpad_colorcodes(char *out, size_t outsize, const char *in, qboolean leftalign, size_t minwidth, size_t maxwidth);
  50
  51 /* Careful: if we disable utf8 but not freetype, we wish to see freetype chars
  52  * for normal letters. So use E000+x for special chars, but leave the freetype stuff for the
  53  * rest:
  54  */
  55 extern Uchar u8_quake2utf8map[256];
  56 // these defines get a bit tricky, as c and e may be aliased to the same variable
  57 #define u8_getchar(c,e) (utf8_enable.integer ? u8_getchar_utf8_enabled(c,e) : (u8_quake2utf8map[(unsigned char)(*(e) = (c) + 1)[-1]]))
  58 #define u8_getchar_noendptr(c) (utf8_enable.integer ? u8_getchar_utf8_enabled(c,NULL) : (u8_quake2utf8map[(unsigned char)*(c)]))
  59 #define u8_getchar_check(c,e) ((e) ? u8_getchar((c),(e)) : u8_getchar_noendptr((c)))
  60 #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]])))
  61 #define u8_getnchar_noendptr(c,n) (utf8_enable.integer ? u8_getnchar_utf8_enabled(c,NULL,n) : ((n) <= 0 ? 0  : (u8_quake2utf8map[(unsigned char)*(c)])))
  62 #define u8_getnchar_check(c,e,n) ((e) ? u8_getchar((c),(e),(n)) : u8_getchar_noendptr((c),(n)))
  63
  64 Uchar u8_toupper(Uchar ch);
  65 Uchar u8_tolower(Uchar ch);
  66
  67 #endif // UTF8LIB_H__