include/gammu-unicode.h

   1 /**
   2  * \file gammu-unicode.h
   3  * \author Michal Čihař
   4  *
   5  * Unicode manipulation functions.
   6  */
   7 #ifndef __gammu_unicode_h
   8 #define __gammu_unicode_h
   9
  10 /**
  11  * \defgroup Unicode Unicode
  12  * Unicode manipulation functions. Please note that most of functions
  13  * here rely on initialised libc char conversions, what is usually done
  14  * by locales initialisation. Recommended way for doing this is calling
  15  * \ref GSM_InitLocales.
  16  */
  17
  18 #include <wchar.h>
  19
  20 #include <gammu-types.h>
  21 #include <gammu-config.h>
  22
  23 /**
  24  * Returns length of unicode string.
  25  *
  26  * \ingroup Unicode
  27  */
  28 size_t UnicodeLength(const unsigned char *str);
  29
  30 /**
  31  * Converts string to locale charset.
  32  *
  33  * \return Pointer to static string.
  34  *
  35  * \ingroup Unicode
  36  */
  37 char *DecodeUnicodeString(const unsigned char *src);
  38
  39 /**
  40  * Converts string to console charset.
  41  *
  42  * \return Pointer to static string.
  43  *
  44  * \ingroup Unicode
  45  */
  46 char *DecodeUnicodeConsole(const unsigned char *src);
  47
  48 /**
  49  * Converts string from unicode to local charset.
  50  *
  51  * \ingroup Unicode
  52  */
  53 void DecodeUnicode(const unsigned char *src, char *dest);
  54
  55 /**
  56  * Encodes string from local charset to unicode.
  57  *
  58  * \ingroup Unicode
  59  */
  60 void EncodeUnicode(unsigned char *dest, const char *src, int len);
  61
  62 /**
  63  * Decodes unicode file data with byte order mark (BOM).
  64  *
  65  * \ingroup Unicode
  66  */
  67 void ReadUnicodeFile(unsigned char *Dest, const unsigned char *Source);
  68
  69 /**
  70  * Copies unicode string.
  71  *
  72  * \ingroup Unicode
  73  */
  74 void CopyUnicodeString(unsigned char *Dest, const unsigned char *Source);
  75
  76 /**
  77  * Encodes string to UTF-8 quoted printable.
  78  *
  79  * \ingroup Unicode
  80  */
  81 gboolean EncodeUTF8QuotedPrintable(char *dest, const unsigned char *src);
  82
  83 /**
  84  * Decodes UTF-8 quoted printable string.
  85  *
  86  * \ingroup Unicode
  87  */
  88 void DecodeUTF8QuotedPrintable(unsigned char *dest, const char *src,
  89                                int len);
  90 /**
  91  * Encodes string to UTF-8.
  92  *
  93  * \ingroup Unicode
  94  */
  95 int EncodeWithUTF8Alphabet(unsigned char mychar1, unsigned char mychar2,
  96                            char *ret);
  97 /**
  98  * Decodes string from UTF-8.
  99  *
 100  * \ingroup Unicode
 101  */
 102 int DecodeWithUTF8Alphabet(const unsigned char *src, wchar_t * dest, int len);
 103
 104 /**
 105  * Decodes string from hex quoted unicode.
 106  *
 107  * \ingroup Unicode
 108  */
 109 void DecodeHexUnicode(unsigned char *dest, const char *src, size_t len);
 110
 111 /**
 112  * Encodes string to hex quoted unicode.
 113  *
 114  * \ingroup Unicode
 115  */
 116 void EncodeHexUnicode(char *dest, const unsigned char *src, size_t len);
 117
 118 /**
 119  * Compares two unicode strings.
 120  *
 121  * \ingroup Unicode
 122  */
 123 gboolean mywstrncmp(unsigned const char *a, unsigned const char *b, int num);
 124
 125 /**
 126  * Locates unicode substring.
 127  *
 128  * \ingroup Unicode
 129  */
 130 unsigned char *mywstrstr(unsigned const char *haystack,
 131                          unsigned const char *needle);
 132
 133 /**
 134  * Compares two unicode strings case insensitive.
 135  *
 136  * \ingroup Unicode
 137  */
 138 gboolean mywstrncasecmp(unsigned const char *a, unsigned const char *b, int num);
 139
 140 /**
 141  * Encode text to UTF-8.
 142  *
 143  * \ingroup Unicode
 144  */
 145 gboolean EncodeUTF8(char *dest, const unsigned char *src);
 146
 147 /**
 148  * Decode text from UTF-8.
 149  *
 150  * \ingroup Unicode
 151  */
 152 void DecodeUTF8(unsigned char *dest, const char *src, int len);
 153
 154 /**
 155  * Decode hex encoded binary text.
 156  *
 157  * \ingroup Unicode
 158  */
 159 gboolean DecodeHexBin(unsigned char *dest, const unsigned char *src, int len);
 160
 161 /**
 162  * Converts single character from unicode to wchar_t.
 163  */
 164 int EncodeWithUnicodeAlphabet(const unsigned char *value, wchar_t *dest);
 165
 166 /**
 167  * Converts single character from wchar_t to unicode.
 168  */
 169 int DecodeWithUnicodeAlphabet(wchar_t value, unsigned char *dest);
 170 #endif
 171
 172 /* Editor configuration
 173  * vim: noexpandtab sw=8 ts=8 sts=8 tw=72:
 174  */