src/lib/doslib/ext/vorbtool/charset.c

   1 /*
   2  * Copyright (C) 2001 Edmund Grimley Evans <edmundo@rano.org>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  17  */
  18
  19 /*
  20  * See the corresponding header file for a description of the functions
  21  * that this file provides.
  22  *
  23  * This was first written for Ogg Vorbis but could be of general use.
  24  *
  25  * The only deliberate assumption about data sizes is that a short has
  26  * at least 16 bits, but this code has only been tested on systems with
  27  * 8-bit char, 16-bit short and 32-bit int.
  28  */
  29
  30 #ifdef HAVE_CONFIG_H
  31 # include <config.h>
  32 #endif
  33
  34 #ifndef HAVE_ICONV /* should be ifdef USE_CHARSET_CONVERT */
  35
  36 #include <stdlib.h>
  37
  38 #include "charset.h"
  39
  40 #include "charmaps.h"
  41
  42 /*
  43  * This is like the standard strcasecmp, but it does not depend
  44  * on the locale. Locale-dependent functions can be dangerous:
  45  * we once had a bug involving strcasecmp("iso", "ISO") in a
  46  * Turkish locale!
  47  *
  48  * (I'm not really sure what the official standard says
  49  * about the sign of strcasecmp("Z", "["), but usually
  50  * we're only interested in whether it's zero.)
  51  */
  52
  53 static int ascii_strcasecmp(const char *s1, const char *s2)
  54 {
  55   char c1, c2;
  56
  57   for (;; s1++, s2++) {
  58     if (!*s1 || !*s1)
  59       break;
  60     if (*s1 == *s2)
  61       continue;
  62     c1 = *s1;
  63     if ('a' <= c1 && c1 <= 'z')
  64       c1 += 'A' - 'a';
  65     c2 = *s2;
  66     if ('a' <= c2 && c2 <= 'z')
  67       c2 += 'A' - 'a';
  68     if (c1 != c2)
  69       break;
  70   }
  71   return (unsigned char)*s1 - (unsigned char)*s2;
  72 }
  73
  74 /*
  75  * UTF-8 equivalents of the C library's wctomb() and mbtowc().
  76  */
  77
  78 int utf8_mbtowc(int *pwc, const char *s, size_t n)
  79 {
  80   unsigned char c;
  81   int wc, i, k;
  82
  83   if (!n || !s)
  84     return 0;
  85
  86   c = *s;
  87   if (c < 0x80) {
  88     if (pwc)
  89       *pwc = c;
  90     return c ? 1 : 0;
  91   }
  92   else if (c < 0xc2)
  93     return -1;
  94   else if (c < 0xe0) {
  95     if (n >= 2 && (s[1] & 0xc0) == 0x80) {
  96       if (pwc)
  97         *pwc = ((c & 0x1f) << 6) | (s[1] & 0x3f);
  98       return 2;
  99     }
 100     else
 101       return -1;
 102   }
 103   else if (c < 0xf0)
 104     k = 3;
 105   else if (c < 0xf8)
 106     k = 4;
 107   else if (c < 0xfc)
 108     k = 5;
 109   else if (c < 0xfe)
 110     k = 6;
 111   else
 112     return -1;
 113
 114   if (n < k)
 115     return -1;
 116   wc = *s++ & ((1 << (7 - k)) - 1);
 117   for (i = 1; i < k; i++) {
 118     if ((*s & 0xc0) != 0x80)
 119       return -1;
 120     wc = (wc << 6) | (*s++ & 0x3f);
 121   }
 122   if (wc < (1 << (5 * k - 4)))
 123     return -1;
 124   if (pwc)
 125     *pwc = wc;
 126   return k;
 127 }
 128
 129 int utf8_wctomb(char *s, int wc1)
 130 {
 131   unsigned int wc = wc1;
 132
 133   if (!s)
 134     return 0;
 135   if (wc < (1 << 7)) {
 136     *s++ = wc;
 137     return 1;
 138   }
 139   else if (wc < (1 << 11)) {
 140     *s++ = 0xc0 | (wc >> 6);
 141     *s++ = 0x80 | (wc & 0x3f);
 142     return 2;
 143   }
 144   else if (wc < (1 << 16)) {
 145     *s++ = 0xe0 | (wc >> 12);
 146     *s++ = 0x80 | ((wc >> 6) & 0x3f);
 147     *s++ = 0x80 | (wc & 0x3f);
 148     return 3;
 149   }
 150   else if (wc < (1 << 21)) {
 151     *s++ = 0xf0 | (wc >> 18);
 152     *s++ = 0x80 | ((wc >> 12) & 0x3f);
 153     *s++ = 0x80 | ((wc >> 6) & 0x3f);
 154     *s++ = 0x80 | (wc & 0x3f);
 155     return 4;
 156   }
 157   else if (wc < (1 << 26)) {
 158     *s++ = 0xf8 | (wc >> 24);
 159     *s++ = 0x80 | ((wc >> 18) & 0x3f);
 160     *s++ = 0x80 | ((wc >> 12) & 0x3f);
 161     *s++ = 0x80 | ((wc >> 6) & 0x3f);
 162     *s++ = 0x80 | (wc & 0x3f);
 163     return 5;
 164   }
 165   else if (wc < (1 << 31)) {
 166     *s++ = 0xfc | (wc >> 30);
 167     *s++ = 0x80 | ((wc >> 24) & 0x3f);
 168     *s++ = 0x80 | ((wc >> 18) & 0x3f);
 169     *s++ = 0x80 | ((wc >> 12) & 0x3f);
 170     *s++ = 0x80 | ((wc >> 6) & 0x3f);
 171     *s++ = 0x80 | (wc & 0x3f);
 172     return 6;
 173   }
 174   else
 175     return -1;
 176 }
 177
 178 /*
 179  * The charset "object" and methods.
 180  */
 181
 182 struct charset {
 183   int max;
 184   int (*mbtowc)(void *table, int *pwc, const char *s, size_t n);
 185   int (*wctomb)(void *table, char *s, int wc);
 186   void *map;
 187 };
 188
 189 int charset_mbtowc(struct charset *charset, int *pwc, const char *s, size_t n)
 190 {
 191   return (*charset->mbtowc)(charset->map, pwc, s, n);
 192 }
 193
 194 int charset_wctomb(struct charset *charset, char *s, int wc)
 195 {
 196   return (*charset->wctomb)(charset->map, s, wc);
 197 }
 198
 199 int charset_max(struct charset *charset)
 200 {
 201   return charset->max;
 202 }
 203
 204 /*
 205  * Implementation of UTF-8.
 206  */
 207
 208 static int mbtowc_utf8(void *map, int *pwc, const char *s, size_t n)
 209 {
 210   return utf8_mbtowc(pwc, s, n);
 211 }
 212
 213 static int wctomb_utf8(void *map, char *s, int wc)
 214 {
 215   return utf8_wctomb(s, wc);
 216 }
 217
 218 /*
 219  * Implementation of US-ASCII.
 220  * Probably on most architectures this compiles to less than 256 bytes
 221  * of code, so we can save space by not having a table for this one.
 222  */
 223
 224 static int mbtowc_ascii(void *map, int *pwc, const char *s, size_t n)
 225 {
 226   int wc;
 227
 228   if (!n || !s)
 229     return 0;
 230   wc = (unsigned char)*s;
 231   if (wc & ~0x7f)
 232     return -1;
 233   if (pwc)
 234     *pwc = wc;
 235   return wc ? 1 : 0;
 236 }
 237
 238 static int wctomb_ascii(void *map, char *s, int wc)
 239 {
 240   if (!s)
 241     return 0;
 242   if (wc & ~0x7f)
 243     return -1;
 244   *s = wc;
 245   return 1;
 246 }
 247
 248 /*
 249  * Implementation of ISO-8859-1.
 250  * Probably on most architectures this compiles to less than 256 bytes
 251  * of code, so we can save space by not having a table for this one.
 252  */
 253
 254 static int mbtowc_iso1(void *map, int *pwc, const char *s, size_t n)
 255 {
 256   int wc;
 257
 258   if (!n || !s)
 259     return 0;
 260   wc = (unsigned char)*s;
 261   if (wc & ~0xff)
 262     return -1;
 263   if (pwc)
 264     *pwc = wc;
 265   return wc ? 1 : 0;
 266 }
 267
 268 static int wctomb_iso1(void *map, char *s, int wc)
 269 {
 270   if (!s)
 271     return 0;
 272   if (wc & ~0xff)
 273     return -1;
 274   *s = wc;
 275   return 1;
 276 }
 277
 278 /*
 279  * Implementation of any 8-bit charset.
 280  */
 281
 282 struct map {
 283   const unsigned short *from;
 284   struct inverse_map *to;
 285 };
 286
 287 static int mbtowc_8bit(void *map1, int *pwc, const char *s, size_t n)
 288 {
 289   struct map *map = map1;
 290   unsigned short wc;
 291
 292   if (!n || !s)
 293     return 0;
 294   wc = map->from[(unsigned char)*s];
 295   if (wc == 0xffff)
 296     return -1;
 297   if (pwc)
 298     *pwc = (int)wc;
 299   return wc ? 1 : 0;
 300 }
 301
 302 /*
 303  * For the inverse map we use a hash table, which has the advantages
 304  * of small constant memory requirement and simple memory allocation,
 305  * but the disadvantage of slow conversion in the worst case.
 306  * If you need real-time performance while letting a potentially
 307  * malicious user define their own map, then the method used in
 308  * linux/drivers/char/consolemap.c would be more appropriate.
 309  */
 310
 311 struct inverse_map {
 312   unsigned char first[256];
 313   unsigned char next[256];
 314 };
 315
 316 /*
 317  * The simple hash is good enough for this application.
 318  * Use the alternative trivial hashes for testing.
 319  */
 320 #define HASH(i) ((i) & 0xff)
 321 /* #define HASH(i) 0 */
 322 /* #define HASH(i) 99 */
 323
 324 static struct inverse_map *make_inverse_map(const unsigned short *from)
 325 {
 326   struct inverse_map *to;
 327   char used[256];
 328   int i, j, k;
 329
 330   to = (struct inverse_map *)malloc(sizeof(struct inverse_map));
 331   if (!to)
 332     return 0;
 333   for (i = 0; i < 256; i++)
 334     to->first[i] = to->next[i] = used[i] = 0;
 335   for (i = 255; i >= 0; i--)
 336     if (from[i] != 0xffff) {
 337       k = HASH(from[i]);
 338       to->next[i] = to->first[k];
 339       to->first[k] = i;
 340       used[k] = 1;
 341     }
 342
 343   /* Point the empty buckets at an empty list. */
 344   for (i = 0; i < 256; i++)
 345     if (!to->next[i])
 346       break;
 347   if (i < 256)
 348     for (j = 0; j < 256; j++)
 349       if (!used[j])
 350         to->first[j] = i;
 351
 352   return to;
 353 }
 354
 355 int wctomb_8bit(void *map1, char *s, int wc1)
 356 {
 357   struct map *map = map1;
 358   unsigned short wc = wc1;
 359   int i;
 360
 361   if (!s)
 362     return 0;
 363
 364   if (wc1 & ~0xffff)
 365     return -1;
 366
 367   if (1) /* Change 1 to 0 to test the case where malloc fails. */
 368     if (!map->to)
 369       map->to = make_inverse_map(map->from);
 370
 371   if (map->to) {
 372     /* Use the inverse map. */
 373     i = map->to->first[HASH(wc)];
 374     for (;;) {
 375       if (map->from[i] == wc) {
 376         *s = i;
 377         return 1;
 378       }
 379       if (!(i = map->to->next[i]))
 380         break;
 381     }
 382   }
 383   else {
 384     /* We don't have an inverse map, so do a linear search. */
 385     for (i = 0; i < 256; i++)
 386       if (map->from[i] == wc) {
 387         *s = i;
 388         return 1;
 389       }
 390   }
 391
 392   return -1;
 393 }
 394
 395 /*
 396  * The "constructor" charset_find().
 397  */
 398
 399 struct charset charset_utf8 = {
 400   6,
 401   &mbtowc_utf8,
 402   &wctomb_utf8,
 403   0
 404 };
 405
 406 struct charset charset_iso1 = {
 407   1,
 408   &mbtowc_iso1,
 409   &wctomb_iso1,
 410   0
 411 };
 412
 413 struct charset charset_ascii = {
 414   1,
 415   &mbtowc_ascii,
 416   &wctomb_ascii,
 417   0
 418 };
 419
 420 struct charset *charset_find(const char *code)
 421 {
 422   int i;
 423
 424   /* Find good (MIME) name. */
 425   for (i = 0; names[i].bad; i++)
 426     if (!ascii_strcasecmp(code, names[i].bad)) {
 427       code = names[i].good;
 428       break;
 429     }
 430
 431   /* Recognise some charsets for which we avoid using a table. */
 432   if (!ascii_strcasecmp(code, "UTF-8"))
 433     return &charset_utf8;
 434   if (!ascii_strcasecmp(code, "US-ASCII"))
 435     return &charset_ascii;
 436   if (!ascii_strcasecmp(code, "ISO-8859-1"))
 437     return &charset_iso1;
 438
 439   /* Look for a mapping for a simple 8-bit encoding. */
 440   for (i = 0; maps[i].name; i++)
 441     if (!ascii_strcasecmp(code, maps[i].name)) {
 442       if (!maps[i].charset) {
 443         maps[i].charset = (struct charset *)malloc(sizeof(struct charset));
 444         if (maps[i].charset) {
 445           struct map *map = (struct map *)malloc(sizeof(struct map));
 446           if (!map) {
 447             free(maps[i].charset);
 448             maps[i].charset = 0;
 449           }
 450           else {
 451             maps[i].charset->max = 1;
 452             maps[i].charset->mbtowc = &mbtowc_8bit;
 453             maps[i].charset->wctomb = &wctomb_8bit;
 454             maps[i].charset->map = map;
 455             map->from = maps[i].map;
 456             map->to = 0; /* inverse mapping is created when required */
 457           }
 458         }
 459       }
 460       return maps[i].charset;
 461     }
 462
 463   return 0;
 464 }
 465
 466 /*
 467  * Function to convert a buffer from one encoding to another.
 468  * Invalid bytes are replaced by '#', and characters that are
 469  * not available in the target encoding are replaced by '?'.
 470  * Each of TO and TOLEN may be zero, if the result is not needed.
 471  * The output buffer is null-terminated, so it is all right to
 472  * use charset_convert(fromcode, tocode, s, strlen(s), &t, 0).
 473  */
 474
 475 int charset_convert(const char *fromcode, const char *tocode,
 476                     const char *from, size_t fromlen,
 477                     char **to, size_t *tolen)
 478 {
 479   int ret = 0;
 480   struct charset *charset1, *charset2;
 481   char *tobuf, *p, *newbuf;
 482   int i, j, wc;
 483
 484   charset1 = charset_find(fromcode);
 485   charset2 = charset_find(tocode);
 486   if (!charset1 || !charset2 )
 487     return -1;
 488
 489   tobuf = (char *)malloc(fromlen * charset2->max + 1);
 490   if (!tobuf)
 491     return -2;
 492
 493   for (p = tobuf; fromlen; from += i, fromlen -= i, p += j) {
 494     i = charset_mbtowc(charset1, &wc, from, fromlen);
 495     if (!i)
 496       i = 1;
 497     else if (i == -1) {
 498       i  = 1;
 499       wc = '#';
 500       ret = 2;
 501     }
 502     j = charset_wctomb(charset2, p, wc);
 503     if (j == -1) {
 504       if (!ret)
 505         ret = 1;
 506       j = charset_wctomb(charset2, p, '?');
 507       if (j == -1)
 508         j = 0;
 509     }
 510   }
 511
 512   if (tolen)
 513     *tolen = p - tobuf;
 514   *p++ = '\0';
 515   if (to) {
 516     newbuf = realloc(tobuf, p - tobuf);
 517     *to = newbuf ? newbuf : tobuf;
 518   }
 519   else
 520     free(tobuf);
 521
 522   return ret;
 523 }
 524
 525 #endif /* USE_CHARSET_ICONV */