lib/unicode.h

   1 /*
   2  *      UCW Library -- Unicode Characters
   3  *
   4  *      (c) 1997--2004 Martin Mares <mj@ucw.cz>
   5  *      (c) 2004 Robert Spalek <robert@ucw.cz>
   6  *      (c) 2007 Pavel Charvat <pchar@ucw.cz>
   7  *
   8  *      This software may be freely distributed and used according to the terms
   9  *      of the GNU Lesser General Public License.
  10  */
  11
  12 #ifndef _UCW_UNICODE_H
  13 #define _UCW_UNICODE_H
  14
  15 #include "lib/unaligned.h"
  16
  17 /* Macros for handling UTF-8 */
  18
  19 #define UNI_REPLACEMENT 0xfffc
  20
  21 /* Encode a character from the basic multilingual plane [0, 0xFFFF]
  22  * (subset of Unicode 4.0); up to 3 bytes needed (RFC2279) */
  23 static inline byte *
  24 utf8_put(byte *p, uns u)
  25 {
  26   if (u < 0x80)
  27     *p++ = u;
  28   else if (u < 0x800)
  29     {
  30       *p++ = 0xc0 | (u >> 6);
  31       *p++ = 0x80 | (u & 0x3f);
  32     }
  33   else
  34     {
  35       ASSERT(u < 0x10000);
  36       *p++ = 0xe0 | (u >> 12);
  37       *p++ = 0x80 | ((u >> 6) & 0x3f);
  38       *p++ = 0x80 | (u & 0x3f);
  39     }
  40   return p;
  41 }
  42
  43 /* Encode a value from the range [0, 0x7FFFFFFF];
  44  * (superset of Unicode 4.0) up to 6 bytes needed (RFC2279) */
  45 static inline byte *
  46 utf8_32_put(byte *p, uns u)
  47 {
  48   if (u < 0x80)
  49     *p++ = u;
  50   else if (u < 0x800)
  51     {
  52       *p++ = 0xc0 | (u >> 6);
  53       goto put1;
  54     }
  55   else if (u < (1<<16))
  56     {
  57       *p++ = 0xe0 | (u >> 12);
  58       goto put2;
  59     }
  60   else if (u < (1<<21))
  61     {
  62       *p++ = 0xf0 | (u >> 18);
  63       goto put3;
  64     }
  65   else if (u < (1<<26))
  66     {
  67       *p++ = 0xf8 | (u >> 24);
  68       goto put4;
  69     }
  70   else if (u < (1U<<31))
  71     {
  72       *p++ = 0xfc | (u >> 30);
  73       *p++ = 0x80 | ((u >> 24) & 0x3f);
  74 put4: *p++ = 0x80 | ((u >> 18) & 0x3f);
  75 put3: *p++ = 0x80 | ((u >> 12) & 0x3f);
  76 put2: *p++ = 0x80 | ((u >> 6) & 0x3f);
  77 put1: *p++ = 0x80 | (u & 0x3f);
  78     }
  79   else
  80     ASSERT(0);
  81   return p;
  82 }
  83
  84 #define UTF8_GET_NEXT if (unlikely((*p & 0xc0) != 0x80)) goto bad; u = (u << 6) | (*p++ & 0x3f)
  85
  86 /* Decode a character from the basic multilingual plane [0, 0xFFFF]
  87  * or return UNI_REPLACEMENT if the encoding has been corrupted */
  88 static inline byte *
  89 utf8_get(const byte *p, uns *uu)
  90 {
  91   uns u = *p++;
  92   if (u < 0x80)
  93     ;
  94   else if (unlikely(u < 0xc0))
  95     {
  96       /* Incorrect byte sequence */
  97     bad:
  98       u = UNI_REPLACEMENT;
  99     }
 100   else if (u < 0xe0)
 101     {
 102       u &= 0x1f;
 103       UTF8_GET_NEXT;
 104     }
 105   else if (likely(u < 0xf0))
 106     {
 107       u &= 0x0f;
 108       UTF8_GET_NEXT;
 109       UTF8_GET_NEXT;
 110     }
 111   else
 112     goto bad;
 113   *uu = u;
 114   return (byte *)p;
 115 }
 116
 117 /* Decode a value from the range [0, 0x7FFFFFFF]
 118  * or return UNI_REPLACEMENT if the encoding has been corrupted */
 119 static inline byte *
 120 utf8_32_get(const byte *p, uns *uu)
 121 {
 122   uns u = *p++;
 123   if (u < 0x80)
 124     ;
 125   else if (unlikely(u < 0xc0))
 126     {
 127       /* Incorrect byte sequence */
 128     bad:
 129       u = UNI_REPLACEMENT;
 130     }
 131   else if (u < 0xe0)
 132     {
 133       u &= 0x1f;
 134       goto get1;
 135     }
 136   else if (u < 0xf0)
 137     {
 138       u &= 0x0f;
 139       goto get2;
 140     }
 141   else if (u < 0xf8)
 142     {
 143       u &= 0x07;
 144       goto get3;
 145     }
 146   else if (u < 0xfc)
 147     {
 148       u &= 0x03;
 149       goto get4;
 150     }
 151   else if (u < 0xfe)
 152     {
 153       u &= 0x01;
 154       UTF8_GET_NEXT;
 155 get4: UTF8_GET_NEXT;
 156 get3: UTF8_GET_NEXT;
 157 get2: UTF8_GET_NEXT;
 158 get1: UTF8_GET_NEXT;
 159     }
 160   else
 161     goto bad;
 162   *uu = u;
 163   return (byte *)p;
 164 }
 165
 166 #define PUT_UTF8(p,u) p = utf8_put(p, u)
 167 #define GET_UTF8(p,u) p = (byte*)utf8_get(p, &(u))
 168
 169 #define PUT_UTF8_32(p,u) p = utf8_32_put(p, u)
 170 #define GET_UTF8_32(p,u) p = (byte*)utf8_32_get(p, &(u))
 171
 172 #define UTF8_SKIP(p) do {                               \
 173     uns c = *p++;                                       \
 174     if (c >= 0xc0)                                      \
 175       while (c & 0x40 && *p >= 0x80 && *p < 0xc0)       \
 176         p++, c <<= 1;                                   \
 177   } while (0)
 178
 179 #define UTF8_SKIP_BWD(p) while ((*--(p) & 0xc0) == 0x80)
 180
 181 static inline uns
 182 utf8_space(uns u)
 183 {
 184   if (u < 0x80)
 185     return 1;
 186   if (u < 0x800)
 187     return 2;
 188   if (u < (1<<16))
 189     return 3;
 190   if (u < (1<<21))
 191     return 4;
 192   if (u < (1<<26))
 193     return 5;
 194   return 6;
 195 }
 196
 197 static inline uns
 198 utf8_encoding_len(uns c)
 199 {
 200   if (c < 0x80)
 201     return 1;
 202   ASSERT(c >= 0xc0 && c < 0xfe);
 203   if (c < 0xe0)
 204     return 2;
 205   if (c < 0xf0)
 206     return 3;
 207   if (c < 0xf8)
 208     return 4;
 209   if (c < 0xfc)
 210     return 5;
 211   return 6;
 212 }
 213
 214 /* Encode a character from the range [0, 0xD7FF] or [0xE000,0x11FFFF];
 215  * up to 4 bytes needed */
 216 static inline void *
 217 utf16_le_put(void *p, uns u)
 218 {
 219   if (u < 0xd800 || (u < 0x10000 && u >= 0xe000))
 220     {
 221       put_u16_le(p, u);
 222       return p + 2;
 223     }
 224   else if ((u -= 0x10000) < 0x100000)
 225     {
 226       put_u16_le(p, u >> 10);
 227       put_u16_le(p + 2, u & 0x7ff);
 228       return p + 4;
 229     }
 230   else
 231     ASSERT(0);
 232 }
 233
 234 static inline void *
 235 utf16_be_put(void *p, uns u)
 236 {
 237   if (u < 0xd800 || (u < 0x10000 && u >= 0xe000))
 238     {
 239       put_u16_be(p, u);
 240       return p + 2;
 241     }
 242   else if ((u -= 0x10000) < 0x100000)
 243     {
 244       put_u16_be(p, u >> 10);
 245       put_u16_be(p + 2, u & 0x7ff);
 246       return p + 4;
 247     }
 248   else
 249     ASSERT(0);
 250 }
 251
 252 /* Decode a character from the range [0, 0xD7FF] or [0xE000,11FFFF]
 253  * or return `repl' if the encoding has been corrupted */
 254 static inline void *
 255 utf16_le_get_repl(const void *p, uns *uu, uns repl)
 256 {
 257   uns u = get_u16_le(p), x, y;
 258   x = u - 0xd800;
 259   if (x < 0x800)
 260     if (x < 0x400 && (y = get_u16_le(p + 2) - 0xdc00) < 0x400)
 261       {
 262         u = 0x10000 + (x << 10) + y;
 263         p += 2;
 264       }
 265     else
 266       u = repl;
 267   *uu = u;
 268   return (void *)(p + 2);
 269 }
 270
 271 static inline void *
 272 utf16_be_get_repl(const void *p, uns *uu, uns repl)
 273 {
 274   uns u = get_u16_be(p), x, y;
 275   x = u - 0xd800;
 276   if (x < 0x800)
 277     if (x < 0x400 && (y = get_u16_be(p + 2) - 0xdc00) < 0x400)
 278       {
 279         u = 0x10000 + (x << 10) + y;
 280         p += 2;
 281       }
 282     else
 283       u = repl;
 284   *uu = u;
 285   return (void *)(p + 2);
 286 }
 287
 288 /* Decode a character from the range [0, 0xD7FF] or [0xE000,11FFFF]
 289  * or return UNI_REPLACEMENT if the encoding has been corrupted */
 290 static inline void *
 291 utf16_le_get(const void *p, uns *uu)
 292 {
 293   return utf16_le_get_repl(p, uu, UNI_REPLACEMENT);
 294 }
 295
 296 static inline void *
 297 utf16_be_get(const void *p, uns *uu)
 298 {
 299   return utf16_be_get_repl(p, uu, UNI_REPLACEMENT);
 300 }
 301
 302 static inline uns
 303 unicode_sanitize_char(uns u)
 304 {
 305   if (u >= 0x10000 ||                   // We don't accept anything outside the basic plane
 306       u >= 0xd800 && u < 0xf900 ||      // neither we do surrogates
 307       u >= 0x80 && u < 0xa0 ||          // nor latin-1 control chars
 308       u < 0x20 && u != '\t')
 309     return UNI_REPLACEMENT;
 310   return u;
 311 }
 312
 313 /* unicode-utf8.c */
 314
 315 uns utf8_strlen(const byte *str);
 316 uns utf8_strnlen(const byte *str, uns n);
 317
 318 #endif