git.chise.org Git - chise/xemacs-chise.git.1/blob - src/mule-charset.c

   1 /* Functions to handle multilingual characters.
   2    Copyright (C) 1992, 1995 Free Software Foundation, Inc.
   3    Copyright (C) 1995 Sun Microsystems, Inc.
   4
   5 This file is part of XEmacs.
   6
   7 XEmacs is free software; you can redistribute it and/or modify it
   8 under the terms of the GNU General Public License as published by the
   9 Free Software Foundation; either version 2, or (at your option) any
  10 later version.
  11
  12 XEmacs is distributed in the hope that it will be useful, but WITHOUT
  13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with XEmacs; see the file COPYING.  If not, write to
  19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20 Boston, MA 02111-1307, USA.  */
  21
  22 /* Synched up with: FSF 20.3.  Not in FSF. */
  23
  24 /* Rewritten by Ben Wing <ben@xemacs.org>. */
  25
  26 #include <config.h>
  27 #include "lisp.h"
  28
  29 #include "buffer.h"
  30 #include "chartab.h"
  31 #include "elhash.h"
  32 #include "lstream.h"
  33 #include "device.h"
  34 #include "faces.h"
  35 #include "mule-ccl.h"
  36
  37 /* The various pre-defined charsets. */
  38
  39 Lisp_Object Vcharset_ascii;
  40 Lisp_Object Vcharset_control_1;
  41 Lisp_Object Vcharset_latin_iso8859_1;
  42 Lisp_Object Vcharset_latin_iso8859_2;
  43 Lisp_Object Vcharset_latin_iso8859_3;
  44 Lisp_Object Vcharset_latin_iso8859_4;
  45 Lisp_Object Vcharset_thai_tis620;
  46 Lisp_Object Vcharset_greek_iso8859_7;
  47 Lisp_Object Vcharset_arabic_iso8859_6;
  48 Lisp_Object Vcharset_hebrew_iso8859_8;
  49 Lisp_Object Vcharset_katakana_jisx0201;
  50 Lisp_Object Vcharset_latin_jisx0201;
  51 Lisp_Object Vcharset_cyrillic_iso8859_5;
  52 Lisp_Object Vcharset_latin_iso8859_9;
  53 Lisp_Object Vcharset_japanese_jisx0208_1978;
  54 Lisp_Object Vcharset_chinese_gb2312;
  55 Lisp_Object Vcharset_japanese_jisx0208;
  56 Lisp_Object Vcharset_korean_ksc5601;
  57 Lisp_Object Vcharset_japanese_jisx0212;
  58 Lisp_Object Vcharset_chinese_cns11643_1;
  59 Lisp_Object Vcharset_chinese_cns11643_2;
  60 Lisp_Object Vcharset_chinese_big5_1;
  61 Lisp_Object Vcharset_chinese_big5_2;
  62
  63 #ifdef ENABLE_COMPOSITE_CHARS
  64 Lisp_Object Vcharset_composite;
  65
  66 /* Hash tables for composite chars.  One maps string representing
  67    composed chars to their equivalent chars; one goes the
  68    other way. */
  69 Lisp_Object Vcomposite_char_char2string_hash_table;
  70 Lisp_Object Vcomposite_char_string2char_hash_table;
  71
  72 static int composite_char_row_next;
  73 static int composite_char_col_next;
  74
  75 #endif /* ENABLE_COMPOSITE_CHARS */
  76
  77 struct charset_lookup *chlook;
  78
  79 static const struct lrecord_description charset_lookup_description_1[] = {
  80   { XD_LISP_OBJECT_ARRAY, offsetof (struct charset_lookup, charset_by_leading_byte), 128+4*128*2 },
  81   { XD_END }
  82 };
  83
  84 static const struct struct_description charset_lookup_description = {
  85   sizeof (struct charset_lookup),
  86   charset_lookup_description_1
  87 };
  88
  89 /* Table of number of bytes in the string representation of a character
  90    indexed by the first byte of that representation.
  91
  92    rep_bytes_by_first_byte(c) is more efficient than the equivalent
  93    canonical computation:
  94
  95    XCHARSET_REP_BYTES (CHARSET_BY_LEADING_BYTE (c)) */
  96
  97 const Bytecount rep_bytes_by_first_byte[0xA0] =
  98 { /* 0x00 - 0x7f are for straight ASCII */
  99   1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 100   1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 101   1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 102   1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 103   1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 104   1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 105   1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 106   1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1,
 107   /* 0x80 - 0x8f are for Dimension-1 official charsets */
 108   2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2,
 109   /* 0x90 - 0x9d are for Dimension-2 official charsets */
 110   /* 0x9e is for Dimension-1 private charsets */
 111   /* 0x9f is for Dimension-2 private charsets */
 112   3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 3, 4
 113 };
 114
 115 Lisp_Object Qcharsetp;
 116
 117 /* Qdoc_string, Qdimension, Qchars defined in general.c */
 118 Lisp_Object Qregistry, Qfinal, Qgraphic;
 119 Lisp_Object Qdirection;
 120 Lisp_Object Qreverse_direction_charset;
 121 Lisp_Object Qleading_byte;
 122 Lisp_Object Qshort_name, Qlong_name;
 123
 124 Lisp_Object Qascii,
 125   Qcontrol_1,
 126   Qlatin_iso8859_1,
 127   Qlatin_iso8859_2,
 128   Qlatin_iso8859_3,
 129   Qlatin_iso8859_4,
 130   Qthai_tis620,
 131   Qgreek_iso8859_7,
 132   Qarabic_iso8859_6,
 133   Qhebrew_iso8859_8,
 134   Qkatakana_jisx0201,
 135   Qlatin_jisx0201,
 136   Qcyrillic_iso8859_5,
 137   Qlatin_iso8859_9,
 138   Qjapanese_jisx0208_1978,
 139   Qchinese_gb2312,
 140   Qjapanese_jisx0208,
 141   Qkorean_ksc5601,
 142   Qjapanese_jisx0212,
 143   Qchinese_cns11643_1,
 144   Qchinese_cns11643_2,
 145   Qchinese_big5_1,
 146   Qchinese_big5_2,
 147   Qcomposite;
 148
 149 Lisp_Object Ql2r, Qr2l;
 150
 151 Lisp_Object Vcharset_hash_table;
 152
 153 /* Composite characters are characters constructed by overstriking two
 154    or more regular characters.
 155
 156    1) The old Mule implementation involves storing composite characters
 157       in a buffer as a tag followed by all of the actual characters
 158       used to make up the composite character.  I think this is a bad
 159       idea; it greatly complicates code that wants to handle strings
 160       one character at a time because it has to deal with the possibility
 161       of great big ungainly characters.  It's much more reasonable to
 162       simply store an index into a table of composite characters.
 163
 164    2) The current implementation only allows for 16,384 separate
 165       composite characters over the lifetime of the XEmacs process.
 166       This could become a potential problem if the user
 167       edited lots of different files that use composite characters.
 168       Due to FSF bogosity, increasing the number of allowable
 169       composite characters under Mule would decrease the number
 170       of possible faces that can exist.  Mule already has shrunk
 171       this to 2048, and further shrinkage would become uncomfortable.
 172       No such problems exist in XEmacs.
 173
 174       Composite characters could be represented as 0x80 C1 C2 C3,
 175       where each C[1-3] is in the range 0xA0 - 0xFF.  This allows
 176       for slightly under 2^20 (one million) composite characters
 177       over the XEmacs process lifetime, and you only need to
 178       increase the size of a Mule character from 19 to 21 bits.
 179       Or you could use 0x80 C1 C2 C3 C4, allowing for about
 180       85 million (slightly over 2^26) composite characters. */
 181
 182 \f
 183 /************************************************************************/
 184 /*                       Basic Emchar functions                         */
 185 /************************************************************************/
 186
 187 /* Convert a non-ASCII Mule character C into a one-character Mule-encoded
 188    string in STR.  Returns the number of bytes stored.
 189    Do not call this directly.  Use the macro set_charptr_emchar() instead.
 190  */
 191
 192 Bytecount
 193 non_ascii_set_charptr_emchar (Bufbyte *str, Emchar c)
 194 {
 195   Bufbyte *p;
 196   Bufbyte lb;
 197   int c1, c2;
 198   Lisp_Object charset;
 199
 200   p = str;
 201   BREAKUP_CHAR (c, charset, c1, c2);
 202   lb = CHAR_LEADING_BYTE (c);
 203   if (LEADING_BYTE_PRIVATE_P (lb))
 204     *p++ = PRIVATE_LEADING_BYTE_PREFIX (lb);
 205   *p++ = lb;
 206   if (EQ (charset, Vcharset_control_1))
 207     c1 += 0x20;
 208   *p++ = c1 | 0x80;
 209   if (c2)
 210     *p++ = c2 | 0x80;
 211
 212   return (p - str);
 213 }
 214
 215 /* Return the first character from a Mule-encoded string in STR,
 216    assuming it's non-ASCII.  Do not call this directly.
 217    Use the macro charptr_emchar() instead. */
 218
 219 Emchar
 220 non_ascii_charptr_emchar (const Bufbyte *str)
 221 {
 222   Bufbyte i0 = *str, i1, i2 = 0;
 223   Lisp_Object charset;
 224
 225   if (i0 == LEADING_BYTE_CONTROL_1)
 226     return (Emchar) (*++str - 0x20);
 227
 228   if (LEADING_BYTE_PREFIX_P (i0))
 229     i0 = *++str;
 230
 231   i1 = *++str & 0x7F;
 232
 233   charset = CHARSET_BY_LEADING_BYTE (i0);
 234   if (XCHARSET_DIMENSION (charset) == 2)
 235     i2 = *++str & 0x7F;
 236
 237   return MAKE_CHAR (charset, i1, i2);
 238 }
 239
 240 /* Return whether CH is a valid Emchar, assuming it's non-ASCII.
 241    Do not call this directly.  Use the macro valid_char_p() instead. */
 242
 243 int
 244 non_ascii_valid_char_p (Emchar ch)
 245 {
 246   int f1, f2, f3;
 247
 248   /* Must have only lowest 19 bits set */
 249   if (ch & ~0x7FFFF)
 250     return 0;
 251
 252   f1 = CHAR_FIELD1 (ch);
 253   f2 = CHAR_FIELD2 (ch);
 254   f3 = CHAR_FIELD3 (ch);
 255
 256   if (f1 == 0)
 257     {
 258       Lisp_Object charset;
 259
 260       if (f2 < MIN_CHAR_FIELD2_OFFICIAL ||
 261           (f2 > MAX_CHAR_FIELD2_OFFICIAL && f2 < MIN_CHAR_FIELD2_PRIVATE) ||
 262            f2 > MAX_CHAR_FIELD2_PRIVATE)
 263         return 0;
 264       if (f3 < 0x20)
 265         return 0;
 266
 267       if (f3 != 0x20 && f3 != 0x7F && !(f2 >= MIN_CHAR_FIELD2_PRIVATE &&
 268                                         f2 <= MAX_CHAR_FIELD2_PRIVATE))
 269         return 1;
 270
 271       /*
 272          NOTE: This takes advantage of the fact that
 273          FIELD2_TO_OFFICIAL_LEADING_BYTE and
 274          FIELD2_TO_PRIVATE_LEADING_BYTE are the same.
 275          */
 276       charset = CHARSET_BY_LEADING_BYTE (f2 + FIELD2_TO_OFFICIAL_LEADING_BYTE);
 277       if (EQ (charset, Qnil))
 278         return 0;
 279       return (XCHARSET_CHARS (charset) == 96);
 280     }
 281   else
 282     {
 283       Lisp_Object charset;
 284
 285       if (f1 < MIN_CHAR_FIELD1_OFFICIAL ||
 286           (f1 > MAX_CHAR_FIELD1_OFFICIAL && f1 < MIN_CHAR_FIELD1_PRIVATE) ||
 287           f1 > MAX_CHAR_FIELD1_PRIVATE)
 288         return 0;
 289       if (f2 < 0x20 || f3 < 0x20)
 290         return 0;
 291
 292 #ifdef ENABLE_COMPOSITE_CHARS
 293       if (f1 + FIELD1_TO_OFFICIAL_LEADING_BYTE == LEADING_BYTE_COMPOSITE)
 294         {
 295           if (UNBOUNDP (Fgethash (make_int (ch),
 296                                   Vcomposite_char_char2string_hash_table,
 297                                   Qunbound)))
 298             return 0;
 299           return 1;
 300         }
 301 #endif /* ENABLE_COMPOSITE_CHARS */
 302
 303       if (f2 != 0x20 && f2 != 0x7F && f3 != 0x20 && f3 != 0x7F
 304           && !(f1 >= MIN_CHAR_FIELD1_PRIVATE && f1 <= MAX_CHAR_FIELD1_PRIVATE))
 305         return 1;
 306
 307       if (f1 <= MAX_CHAR_FIELD1_OFFICIAL)
 308         charset =
 309           CHARSET_BY_LEADING_BYTE (f1 + FIELD1_TO_OFFICIAL_LEADING_BYTE);
 310       else
 311         charset =
 312           CHARSET_BY_LEADING_BYTE (f1 + FIELD1_TO_PRIVATE_LEADING_BYTE);
 313
 314       if (EQ (charset, Qnil))
 315         return 0;
 316       return (XCHARSET_CHARS (charset) == 96);
 317     }
 318 }
 319
 320 \f
 321 /************************************************************************/
 322 /*                       Basic string functions                         */
 323 /************************************************************************/
 324
 325 /* Copy the character pointed to by PTR into STR, assuming it's
 326    non-ASCII.  Do not call this directly.  Use the macro
 327    charptr_copy_char() instead. */
 328
 329 Bytecount
 330 non_ascii_charptr_copy_char (const Bufbyte *ptr, Bufbyte *str)
 331 {
 332   Bufbyte *strptr = str;
 333   *strptr = *ptr++;
 334   switch (REP_BYTES_BY_FIRST_BYTE (*strptr))
 335     {
 336       /* Notice fallthrough. */
 337     case 4: *++strptr = *ptr++;
 338     case 3: *++strptr = *ptr++;
 339     case 2: *++strptr = *ptr;
 340       break;
 341     default:
 342       abort ();
 343     }
 344   return strptr + 1 - str;
 345 }
 346
 347 \f
 348 /************************************************************************/
 349 /*                        streams of Emchars                            */
 350 /************************************************************************/
 351
 352 /* Treat a stream as a stream of Emchar's rather than a stream of bytes.
 353    The functions below are not meant to be called directly; use
 354    the macros in insdel.h. */
 355
 356 Emchar
 357 Lstream_get_emchar_1 (Lstream *stream, int ch)
 358 {
 359   Bufbyte str[MAX_EMCHAR_LEN];
 360   Bufbyte *strptr = str;
 361
 362   str[0] = (Bufbyte) ch;
 363   switch (REP_BYTES_BY_FIRST_BYTE (ch))
 364     {
 365       /* Notice fallthrough. */
 366     case 4:
 367       ch = Lstream_getc (stream);
 368       assert (ch >= 0);
 369       *++strptr = (Bufbyte) ch;
 370     case 3:
 371       ch = Lstream_getc (stream);
 372       assert (ch >= 0);
 373       *++strptr = (Bufbyte) ch;
 374     case 2:
 375       ch = Lstream_getc (stream);
 376       assert (ch >= 0);
 377       *++strptr = (Bufbyte) ch;
 378       break;
 379     default:
 380       abort ();
 381     }
 382   return charptr_emchar (str);
 383 }
 384
 385 int
 386 Lstream_fput_emchar (Lstream *stream, Emchar ch)
 387 {
 388   Bufbyte str[MAX_EMCHAR_LEN];
 389   Bytecount len = set_charptr_emchar (str, ch);
 390   return Lstream_write (stream, str, len);
 391 }
 392
 393 void
 394 Lstream_funget_emchar (Lstream *stream, Emchar ch)
 395 {
 396   Bufbyte str[MAX_EMCHAR_LEN];
 397   Bytecount len = set_charptr_emchar (str, ch);
 398   Lstream_unread (stream, str, len);
 399 }
 400
 401 \f
 402 /************************************************************************/
 403 /*                            charset object                            */
 404 /************************************************************************/
 405
 406 static Lisp_Object
 407 mark_charset (Lisp_Object obj)
 408 {
 409   Lisp_Charset *cs = XCHARSET (obj);
 410
 411   mark_object (cs->short_name);
 412   mark_object (cs->long_name);
 413   mark_object (cs->doc_string);
 414   mark_object (cs->registry);
 415   mark_object (cs->ccl_program);
 416   return cs->name;
 417 }
 418
 419 static void
 420 print_charset (Lisp_Object obj, Lisp_Object printcharfun, int escapeflag)
 421 {
 422   Lisp_Charset *cs = XCHARSET (obj);
 423   char buf[200];
 424
 425   if (print_readably)
 426     error ("printing unreadable object #<charset %s 0x%x>",
 427            string_data (XSYMBOL (CHARSET_NAME (cs))->name),
 428            cs->header.uid);
 429
 430   write_c_string ("#<charset ", printcharfun);
 431   print_internal (CHARSET_NAME (cs), printcharfun, 0);
 432   write_c_string (" ", printcharfun);
 433   print_internal (CHARSET_SHORT_NAME (cs), printcharfun, 1);
 434   write_c_string (" ", printcharfun);
 435   print_internal (CHARSET_LONG_NAME (cs), printcharfun, 1);
 436   write_c_string (" ", printcharfun);
 437   print_internal (CHARSET_DOC_STRING (cs), printcharfun, 1);
 438   sprintf (buf, " %s %s cols=%d g%d final='%c' reg=",
 439            CHARSET_TYPE (cs) == CHARSET_TYPE_94    ? "94" :
 440            CHARSET_TYPE (cs) == CHARSET_TYPE_96    ? "96" :
 441            CHARSET_TYPE (cs) == CHARSET_TYPE_94X94 ? "94x94" :
 442            "96x96",
 443            CHARSET_DIRECTION (cs) == CHARSET_LEFT_TO_RIGHT ? "l2r" : "r2l",
 444            CHARSET_COLUMNS (cs),
 445            CHARSET_GRAPHIC (cs),
 446            CHARSET_FINAL (cs));
 447   write_c_string (buf, printcharfun);
 448   print_internal (CHARSET_REGISTRY (cs), printcharfun, 0);
 449   sprintf (buf, " 0x%x>", cs->header.uid);
 450   write_c_string (buf, printcharfun);
 451 }
 452
 453 static const struct lrecord_description charset_description[] = {
 454   { XD_LISP_OBJECT, offsetof (Lisp_Charset, name) },
 455   { XD_LISP_OBJECT, offsetof (Lisp_Charset, doc_string) },
 456   { XD_LISP_OBJECT, offsetof (Lisp_Charset, registry) },
 457   { XD_LISP_OBJECT, offsetof (Lisp_Charset, short_name) },
 458   { XD_LISP_OBJECT, offsetof (Lisp_Charset, long_name) },
 459   { XD_LISP_OBJECT, offsetof (Lisp_Charset, reverse_direction_charset) },
 460   { XD_LISP_OBJECT, offsetof (Lisp_Charset, ccl_program) },
 461   { XD_END }
 462 };
 463
 464 DEFINE_LRECORD_IMPLEMENTATION ("charset", charset,
 465                                mark_charset, print_charset, 0, 0, 0, charset_description,
 466                                Lisp_Charset);
 467 /* Make a new charset. */
 468
 469 static Lisp_Object
 470 make_charset (int id, Lisp_Object name, unsigned char rep_bytes,
 471               unsigned char type, unsigned char columns, unsigned char graphic,
 472               Bufbyte final, unsigned char direction,  Lisp_Object short_name,
 473               Lisp_Object long_name, Lisp_Object doc,
 474               Lisp_Object reg)
 475 {
 476   Lisp_Object obj;
 477   Lisp_Charset *cs = alloc_lcrecord_type (Lisp_Charset, &lrecord_charset);
 478
 479   zero_lcrecord (cs);
 480
 481   XSETCHARSET (obj, cs);
 482
 483   CHARSET_ID            (cs) = id;
 484   CHARSET_NAME          (cs) = name;
 485   CHARSET_SHORT_NAME    (cs) = short_name;
 486   CHARSET_LONG_NAME     (cs) = long_name;
 487   CHARSET_REP_BYTES     (cs) = rep_bytes;
 488   CHARSET_DIRECTION     (cs) = direction;
 489   CHARSET_TYPE          (cs) = type;
 490   CHARSET_COLUMNS       (cs) = columns;
 491   CHARSET_GRAPHIC       (cs) = graphic;
 492   CHARSET_FINAL         (cs) = final;
 493   CHARSET_DOC_STRING    (cs) = doc;
 494   CHARSET_REGISTRY      (cs) = reg;
 495   CHARSET_CCL_PROGRAM   (cs) = Qnil;
 496   CHARSET_REVERSE_DIRECTION_CHARSET (cs) = Qnil;
 497
 498   CHARSET_DIMENSION     (cs) = (CHARSET_TYPE (cs) == CHARSET_TYPE_94 ||
 499                                 CHARSET_TYPE (cs) == CHARSET_TYPE_96) ? 1 : 2;
 500   CHARSET_CHARS         (cs) = (CHARSET_TYPE (cs) == CHARSET_TYPE_94 ||
 501                                 CHARSET_TYPE (cs) == CHARSET_TYPE_94X94) ? 94 : 96;
 502
 503   if (final)
 504     {
 505       /* some charsets do not have final characters.  This includes
 506          ASCII, Control-1, Composite, and the two faux private
 507          charsets. */
 508       assert (NILP (chlook->charset_by_attributes[type][final][direction]));
 509       chlook->charset_by_attributes[type][final][direction] = obj;
 510     }
 511
 512   assert (NILP (chlook->charset_by_leading_byte[id - 128]));
 513   chlook->charset_by_leading_byte[id - 128] = obj;
 514
 515   /* Some charsets are "faux" and don't have names or really exist at
 516      all except in the leading-byte table. */
 517   if (!NILP (name))
 518     Fputhash (name, obj, Vcharset_hash_table);
 519   return obj;
 520 }
 521
 522 static int
 523 get_unallocated_leading_byte (int dimension)
 524 {
 525   int lb;
 526
 527   if (dimension == 1)
 528     {
 529       if (chlook->next_allocated_1_byte_leading_byte > MAX_LEADING_BYTE_PRIVATE_1)
 530         lb = 0;
 531       else
 532         lb = chlook->next_allocated_1_byte_leading_byte++;
 533     }
 534   else
 535     {
 536       if (chlook->next_allocated_2_byte_leading_byte > MAX_LEADING_BYTE_PRIVATE_2)
 537         lb = 0;
 538       else
 539         lb = chlook->next_allocated_2_byte_leading_byte++;
 540     }
 541
 542   if (!lb)
 543     signal_simple_error
 544       ("No more character sets free for this dimension",
 545        make_int (dimension));
 546
 547   return lb;
 548 }
 549
 550 \f
 551 /************************************************************************/
 552 /*                      Basic charset Lisp functions                    */
 553 /************************************************************************/
 554
 555 DEFUN ("charsetp", Fcharsetp, 1, 1, 0, /*
 556 Return non-nil if OBJECT is a charset.
 557 */
 558        (object))
 559 {
 560   return CHARSETP (object) ? Qt : Qnil;
 561 }
 562
 563 DEFUN ("find-charset", Ffind_charset, 1, 1, 0, /*
 564 Retrieve the charset of the given name.
 565 If CHARSET-OR-NAME is a charset object, it is simply returned.
 566 Otherwise, CHARSET-OR-NAME should be a symbol.  If there is no such charset,
 567 nil is returned.  Otherwise the associated charset object is returned.
 568 */
 569        (charset_or_name))
 570 {
 571   if (CHARSETP (charset_or_name))
 572     return charset_or_name;
 573
 574   CHECK_SYMBOL (charset_or_name);
 575   return Fgethash (charset_or_name, Vcharset_hash_table, Qnil);
 576 }
 577
 578 DEFUN ("get-charset", Fget_charset, 1, 1, 0, /*
 579 Retrieve the charset of the given name.
 580 Same as `find-charset' except an error is signalled if there is no such
 581 charset instead of returning nil.
 582 */
 583        (name))
 584 {
 585   Lisp_Object charset = Ffind_charset (name);
 586
 587   if (NILP (charset))
 588     signal_simple_error ("No such charset", name);
 589   return charset;
 590 }
 591
 592 /* We store the charsets in hash tables with the names as the key and the
 593    actual charset object as the value.  Occasionally we need to use them
 594    in a list format.  These routines provide us with that. */
 595 struct charset_list_closure
 596 {
 597   Lisp_Object *charset_list;
 598 };
 599
 600 static int
 601 add_charset_to_list_mapper (Lisp_Object key, Lisp_Object value,
 602                             void *charset_list_closure)
 603 {
 604   /* This function can GC */
 605   struct charset_list_closure *chcl =
 606     (struct charset_list_closure*) charset_list_closure;
 607   Lisp_Object *charset_list = chcl->charset_list;
 608
 609   *charset_list = Fcons (XCHARSET_NAME (value), *charset_list);
 610   return 0;
 611 }
 612
 613 DEFUN ("charset-list", Fcharset_list, 0, 0, 0, /*
 614 Return a list of the names of all defined charsets.
 615 */
 616        ())
 617 {
 618   Lisp_Object charset_list = Qnil;
 619   struct gcpro gcpro1;
 620   struct charset_list_closure charset_list_closure;
 621
 622   GCPRO1 (charset_list);
 623   charset_list_closure.charset_list = &charset_list;
 624   elisp_maphash (add_charset_to_list_mapper, Vcharset_hash_table,
 625                  &charset_list_closure);
 626   UNGCPRO;
 627
 628   return charset_list;
 629 }
 630
 631 DEFUN ("charset-name", Fcharset_name, 1, 1, 0, /*
 632 Return the name of the given charset.
 633 */
 634        (charset))
 635 {
 636   return XCHARSET_NAME (Fget_charset (charset));
 637 }
 638
 639 DEFUN ("make-charset", Fmake_charset, 3, 3, 0, /*
 640 Define a new character set.
 641 This function is for use with Mule support.
 642 NAME is a symbol, the name by which the character set is normally referred.
 643 DOC-STRING is a string describing the character set.
 644 PROPS is a property list, describing the specific nature of the
 645 character set.  Recognized properties are:
 646
 647 'short-name     Short version of the charset name (ex: Latin-1)
 648 'long-name      Long version of the charset name (ex: ISO8859-1 (Latin-1))
 649 'registry       A regular expression matching the font registry field for
 650                 this character set.
 651 'dimension      Number of octets used to index a character in this charset.
 652                 Either 1 or 2.  Defaults to 1.
 653 'columns        Number of columns used to display a character in this charset.
 654                 Only used in TTY mode. (Under X, the actual width of a
 655                 character can be derived from the font used to display the
 656                 characters.) If unspecified, defaults to the dimension
 657                 (this is almost always the correct value).
 658 'chars          Number of characters in each dimension (94 or 96).
 659                 Defaults to 94.  Note that if the dimension is 2, the
 660                 character set thus described is 94x94 or 96x96.
 661 'final          Final byte of ISO 2022 escape sequence.  Must be
 662                 supplied.  Each combination of (DIMENSION, CHARS) defines a
 663                 separate namespace for final bytes.  Note that ISO
 664                 2022 restricts the final byte to the range
 665                 0x30 - 0x7E if dimension == 1, and 0x30 - 0x5F if
 666                 dimension == 2.  Note also that final bytes in the range
 667                 0x30 - 0x3F are reserved for user-defined (not official)
 668                 character sets.
 669 'graphic        0 (use left half of font on output) or 1 (use right half
 670                 of font on output).  Defaults to 0.  For example, for
 671                 a font whose registry is ISO8859-1, the left half
 672                 (octets 0x20 - 0x7F) is the `ascii' character set, while
 673                 the right half (octets 0xA0 - 0xFF) is the `latin-1'
 674                 character set.  With 'graphic set to 0, the octets
 675                 will have their high bit cleared; with it set to 1,
 676                 the octets will have their high bit set.
 677 'direction      'l2r (left-to-right) or 'r2l (right-to-left).
 678                 Defaults to 'l2r.
 679 'ccl-program    A compiled CCL program used to convert a character in
 680                 this charset into an index into the font.  This is in
 681                 addition to the 'graphic property.  The CCL program
 682                 is passed the octets of the character, with the high
 683                 bit cleared and set depending upon whether the value
 684                 of the 'graphic property is 0 or 1.
 685 */
 686        (name, doc_string, props))
 687 {
 688   int id, dimension = 1, chars = 94, graphic = 0, final = 0, columns = -1;
 689   int direction = CHARSET_LEFT_TO_RIGHT;
 690   int type;
 691   Lisp_Object registry = Qnil;
 692   Lisp_Object charset;
 693   Lisp_Object ccl_program = Qnil;
 694   Lisp_Object short_name = Qnil, long_name = Qnil;
 695
 696   CHECK_SYMBOL (name);
 697   if (!NILP (doc_string))
 698     CHECK_STRING (doc_string);
 699
 700   charset = Ffind_charset (name);
 701   if (!NILP (charset))
 702     signal_simple_error ("Cannot redefine existing charset", name);
 703
 704   {
 705     EXTERNAL_PROPERTY_LIST_LOOP_3 (keyword, value, props)
 706       {
 707         if (EQ (keyword, Qshort_name))
 708           {
 709             CHECK_STRING (value);
 710             short_name = value;
 711           }
 712
 713         if (EQ (keyword, Qlong_name))
 714           {
 715             CHECK_STRING (value);
 716             long_name = value;
 717           }
 718
 719         else if (EQ (keyword, Qdimension))
 720           {
 721             CHECK_INT (value);
 722             dimension = XINT (value);
 723             if (dimension < 1 || dimension > 2)
 724               signal_simple_error ("Invalid value for 'dimension", value);
 725           }
 726
 727         else if (EQ (keyword, Qchars))
 728           {
 729             CHECK_INT (value);
 730             chars = XINT (value);
 731             if (chars != 94 && chars != 96)
 732               signal_simple_error ("Invalid value for 'chars", value);
 733           }
 734
 735         else if (EQ (keyword, Qcolumns))
 736           {
 737             CHECK_INT (value);
 738             columns = XINT (value);
 739             if (columns != 1 && columns != 2)
 740               signal_simple_error ("Invalid value for 'columns", value);
 741           }
 742
 743         else if (EQ (keyword, Qgraphic))
 744           {
 745             CHECK_INT (value);
 746             graphic = XINT (value);
 747             if (graphic < 0 || graphic > 1)
 748               signal_simple_error ("Invalid value for 'graphic", value);
 749           }
 750
 751         else if (EQ (keyword, Qregistry))
 752           {
 753             CHECK_STRING (value);
 754             registry = value;
 755           }
 756
 757         else if (EQ (keyword, Qdirection))
 758           {
 759             if (EQ (value, Ql2r))
 760               direction = CHARSET_LEFT_TO_RIGHT;
 761             else if (EQ (value, Qr2l))
 762               direction = CHARSET_RIGHT_TO_LEFT;
 763             else
 764               signal_simple_error ("Invalid value for 'direction", value);
 765           }
 766
 767         else if (EQ (keyword, Qfinal))
 768           {
 769             CHECK_CHAR_COERCE_INT (value);
 770             final = XCHAR (value);
 771             if (final < '0' || final > '~')
 772               signal_simple_error ("Invalid value for 'final", value);
 773           }
 774
 775         else if (EQ (keyword, Qccl_program))
 776           {
 777             CHECK_VECTOR (value);
 778             ccl_program = value;
 779           }
 780
 781         else
 782           signal_simple_error ("Unrecognized property", keyword);
 783       }
 784   }
 785
 786   if (!final)
 787     error ("'final must be specified");
 788   if (dimension == 2 && final > 0x5F)
 789     signal_simple_error
 790       ("Final must be in the range 0x30 - 0x5F for dimension == 2",
 791        make_char (final));
 792
 793   if (dimension == 1)
 794     type = (chars == 94) ? CHARSET_TYPE_94    : CHARSET_TYPE_96;
 795   else
 796     type = (chars == 94) ? CHARSET_TYPE_94X94 : CHARSET_TYPE_96X96;
 797
 798   if (!NILP (CHARSET_BY_ATTRIBUTES (type, final, CHARSET_LEFT_TO_RIGHT)) ||
 799       !NILP (CHARSET_BY_ATTRIBUTES (type, final, CHARSET_RIGHT_TO_LEFT)))
 800     error
 801       ("Character set already defined for this DIMENSION/CHARS/FINAL combo");
 802
 803   id = get_unallocated_leading_byte (dimension);
 804
 805   if (NILP (doc_string))
 806     doc_string = build_string ("");
 807
 808   if (NILP (registry))
 809     registry = build_string ("");
 810
 811   if (NILP (short_name))
 812     XSETSTRING (short_name, XSYMBOL (name)->name);
 813
 814   if (NILP (long_name))
 815     long_name = doc_string;
 816
 817   if (columns == -1)
 818     columns = dimension;
 819   charset = make_charset (id, name, dimension + 2, type, columns, graphic,
 820                           final, direction, short_name, long_name, doc_string, registry);
 821   if (!NILP (ccl_program))
 822     XCHARSET_CCL_PROGRAM (charset) = ccl_program;
 823   return charset;
 824 }
 825
 826 DEFUN ("make-reverse-direction-charset", Fmake_reverse_direction_charset,
 827        2, 2, 0, /*
 828 Make a charset equivalent to CHARSET but which goes in the opposite direction.
 829 NEW-NAME is the name of the new charset.  Return the new charset.
 830 */
 831        (charset, new_name))
 832 {
 833   Lisp_Object new_charset = Qnil;
 834   int id, dimension, columns, graphic, final;
 835   int direction, type;
 836   Lisp_Object registry, doc_string, short_name, long_name;
 837   Lisp_Charset *cs;
 838
 839   charset = Fget_charset (charset);
 840   if (!NILP (XCHARSET_REVERSE_DIRECTION_CHARSET (charset)))
 841     signal_simple_error ("Charset already has reverse-direction charset",
 842                          charset);
 843
 844   CHECK_SYMBOL (new_name);
 845   if (!NILP (Ffind_charset (new_name)))
 846     signal_simple_error ("Cannot redefine existing charset", new_name);
 847
 848   cs = XCHARSET (charset);
 849
 850   type      = CHARSET_TYPE      (cs);
 851   columns   = CHARSET_COLUMNS   (cs);
 852   dimension = CHARSET_DIMENSION (cs);
 853   id = get_unallocated_leading_byte (dimension);
 854
 855   graphic = CHARSET_GRAPHIC (cs);
 856   final = CHARSET_FINAL (cs);
 857   direction = CHARSET_RIGHT_TO_LEFT;
 858   if (CHARSET_DIRECTION (cs) == CHARSET_RIGHT_TO_LEFT)
 859     direction = CHARSET_LEFT_TO_RIGHT;
 860   doc_string = CHARSET_DOC_STRING (cs);
 861   short_name = CHARSET_SHORT_NAME (cs);
 862   long_name = CHARSET_LONG_NAME (cs);
 863   registry = CHARSET_REGISTRY (cs);
 864
 865   new_charset = make_charset (id, new_name, dimension + 2, type, columns,
 866                               graphic, final, direction, short_name, long_name,
 867                               doc_string, registry);
 868
 869   CHARSET_REVERSE_DIRECTION_CHARSET (cs) = new_charset;
 870   XCHARSET_REVERSE_DIRECTION_CHARSET (new_charset) = charset;
 871
 872   return new_charset;
 873 }
 874
 875 /* #### Reverse direction charsets not yet implemented.  */
 876 #if 0
 877 DEFUN ("charset-reverse-direction-charset", Fcharset_reverse_direction_charset,
 878        1, 1, 0, /*
 879 Return the reverse-direction charset parallel to CHARSET, if any.
 880 This is the charset with the same properties (in particular, the same
 881 dimension, number of characters per dimension, and final byte) as
 882 CHARSET but whose characters are displayed in the opposite direction.
 883 */
 884        (charset))
 885 {
 886   charset = Fget_charset (charset);
 887   return XCHARSET_REVERSE_DIRECTION_CHARSET (charset);
 888 }
 889 #endif
 890
 891 DEFUN ("charset-from-attributes", Fcharset_from_attributes, 3, 4, 0, /*
 892 Return a charset with the given DIMENSION, CHARS, FINAL, and DIRECTION.
 893 If DIRECTION is omitted, both directions will be checked (left-to-right
 894 will be returned if character sets exist for both directions).
 895 */
 896        (dimension, chars, final, direction))
 897 {
 898   int dm, ch, fi, di = -1;
 899   int type;
 900   Lisp_Object obj = Qnil;
 901
 902   CHECK_INT (dimension);
 903   dm = XINT (dimension);
 904   if (dm < 1 || dm > 2)
 905     signal_simple_error ("Invalid value for DIMENSION", dimension);
 906
 907   CHECK_INT (chars);
 908   ch = XINT (chars);
 909   if (ch != 94 && ch != 96)
 910     signal_simple_error ("Invalid value for CHARS", chars);
 911
 912   CHECK_CHAR_COERCE_INT (final);
 913   fi = XCHAR (final);
 914   if (fi < '0' || fi > '~')
 915     signal_simple_error ("Invalid value for FINAL", final);
 916
 917   if (EQ (direction, Ql2r))
 918     di = CHARSET_LEFT_TO_RIGHT;
 919   else if (EQ (direction, Qr2l))
 920     di = CHARSET_RIGHT_TO_LEFT;
 921   else if (!NILP (direction))
 922     signal_simple_error ("Invalid value for DIRECTION", direction);
 923
 924   if (dm == 2 && fi > 0x5F)
 925     signal_simple_error
 926       ("Final must be in the range 0x30 - 0x5F for dimension == 2", final);
 927
 928   if (dm == 1)
 929     type = (ch == 94) ? CHARSET_TYPE_94    : CHARSET_TYPE_96;
 930   else
 931     type = (ch == 94) ? CHARSET_TYPE_94X94 : CHARSET_TYPE_96X96;
 932
 933   if (di == -1)
 934     {
 935       obj = CHARSET_BY_ATTRIBUTES (type, fi, CHARSET_LEFT_TO_RIGHT);
 936       if (NILP (obj))
 937         obj = CHARSET_BY_ATTRIBUTES (type, fi, CHARSET_RIGHT_TO_LEFT);
 938     }
 939   else
 940     obj = CHARSET_BY_ATTRIBUTES (type, fi, di);
 941
 942   if (CHARSETP (obj))
 943     return XCHARSET_NAME (obj);
 944   return obj;
 945 }
 946
 947 DEFUN ("charset-short-name", Fcharset_short_name, 1, 1, 0, /*
 948 Return short name of CHARSET.
 949 */
 950        (charset))
 951 {
 952   return XCHARSET_SHORT_NAME (Fget_charset (charset));
 953 }
 954
 955 DEFUN ("charset-long-name", Fcharset_long_name, 1, 1, 0, /*
 956 Return long name of CHARSET.
 957 */
 958        (charset))
 959 {
 960   return XCHARSET_LONG_NAME (Fget_charset (charset));
 961 }
 962
 963 DEFUN ("charset-description", Fcharset_description, 1, 1, 0, /*
 964 Return description of CHARSET.
 965 */
 966        (charset))
 967 {
 968   return XCHARSET_DOC_STRING (Fget_charset (charset));
 969 }
 970
 971 DEFUN ("charset-dimension", Fcharset_dimension, 1, 1, 0, /*
 972 Return dimension of CHARSET.
 973 */
 974        (charset))
 975 {
 976   return make_int (XCHARSET_DIMENSION (Fget_charset (charset)));
 977 }
 978
 979 DEFUN ("charset-property", Fcharset_property, 2, 2, 0, /*
 980 Return property PROP of CHARSET.
 981 Recognized properties are those listed in `make-charset', as well as
 982 'name and 'doc-string.
 983 */
 984        (charset, prop))
 985 {
 986   Lisp_Charset *cs;
 987
 988   charset = Fget_charset (charset);
 989   cs = XCHARSET (charset);
 990
 991   CHECK_SYMBOL (prop);
 992   if (EQ (prop, Qname))        return CHARSET_NAME (cs);
 993   if (EQ (prop, Qshort_name))  return CHARSET_SHORT_NAME (cs);
 994   if (EQ (prop, Qlong_name))   return CHARSET_LONG_NAME (cs);
 995   if (EQ (prop, Qdoc_string))  return CHARSET_DOC_STRING (cs);
 996   if (EQ (prop, Qdimension))   return make_int (CHARSET_DIMENSION (cs));
 997   if (EQ (prop, Qcolumns))     return make_int (CHARSET_COLUMNS (cs));
 998   if (EQ (prop, Qgraphic))     return make_int (CHARSET_GRAPHIC (cs));
 999   if (EQ (prop, Qfinal))       return make_char (CHARSET_FINAL (cs));
1000   if (EQ (prop, Qchars))       return make_int (CHARSET_CHARS (cs));
1001   if (EQ (prop, Qregistry))    return CHARSET_REGISTRY (cs);
1002   if (EQ (prop, Qccl_program)) return CHARSET_CCL_PROGRAM (cs);
1003   if (EQ (prop, Qdirection))
1004     return CHARSET_DIRECTION (cs) == CHARSET_LEFT_TO_RIGHT ? Ql2r : Qr2l;
1005   if (EQ (prop, Qreverse_direction_charset))
1006     {
1007       Lisp_Object obj = CHARSET_REVERSE_DIRECTION_CHARSET (cs);
1008       if (NILP (obj))
1009         return Qnil;
1010       else
1011         return XCHARSET_NAME (obj);
1012     }
1013   signal_simple_error ("Unrecognized charset property name", prop);
1014   return Qnil; /* not reached */
1015 }
1016
1017 DEFUN ("charset-id", Fcharset_id, 1, 1, 0, /*
1018 Return charset identification number of CHARSET.
1019 */
1020         (charset))
1021 {
1022   return make_int(XCHARSET_LEADING_BYTE (Fget_charset (charset)));
1023 }
1024
1025 /* #### We need to figure out which properties we really want to
1026    allow to be set. */
1027
1028 DEFUN ("set-charset-ccl-program", Fset_charset_ccl_program, 2, 2, 0, /*
1029 Set the 'ccl-program property of CHARSET to CCL-PROGRAM.
1030 */
1031        (charset, ccl_program))
1032 {
1033   charset = Fget_charset (charset);
1034   CHECK_VECTOR (ccl_program);
1035   XCHARSET_CCL_PROGRAM (charset) = ccl_program;
1036   return Qnil;
1037 }
1038
1039 static void
1040 invalidate_charset_font_caches (Lisp_Object charset)
1041 {
1042   /* Invalidate font cache entries for charset on all devices. */
1043   Lisp_Object devcons, concons, hash_table;
1044   DEVICE_LOOP_NO_BREAK (devcons, concons)
1045     {
1046       struct device *d = XDEVICE (XCAR (devcons));
1047       hash_table = Fgethash (charset, d->charset_font_cache, Qunbound);
1048       if (!UNBOUNDP (hash_table))
1049         Fclrhash (hash_table);
1050     }
1051 }
1052
1053 /* Japanese folks may want to (set-charset-registry 'ascii "jisx0201") */
1054 DEFUN ("set-charset-registry", Fset_charset_registry, 2, 2, 0, /*
1055 Set the 'registry property of CHARSET to REGISTRY.
1056 */
1057        (charset, registry))
1058 {
1059   charset = Fget_charset (charset);
1060   CHECK_STRING (registry);
1061   XCHARSET_REGISTRY (charset) = registry;
1062   invalidate_charset_font_caches (charset);
1063   face_property_was_changed (Vdefault_face, Qfont, Qglobal);
1064   return Qnil;
1065 }
1066
1067 \f
1068 /************************************************************************/
1069 /*              Lisp primitives for working with characters             */
1070 /************************************************************************/
1071
1072 DEFUN ("make-char", Fmake_char, 2, 3, 0, /*
1073 Make a character from CHARSET and octets ARG1 and ARG2.
1074 ARG2 is required only for characters from two-dimensional charsets.
1075 For example, (make-char 'latin-iso8859-2 185) will return the Latin 2
1076 character s with caron.
1077 */
1078        (charset, arg1, arg2))
1079 {
1080   Lisp_Charset *cs;
1081   int a1, a2;
1082   int lowlim, highlim;
1083
1084   charset = Fget_charset (charset);
1085   cs = XCHARSET (charset);
1086
1087   if      (EQ (charset, Vcharset_ascii))     lowlim =  0, highlim = 127;
1088   else if (EQ (charset, Vcharset_control_1)) lowlim =  0, highlim =  31;
1089   else if (CHARSET_CHARS (cs) == 94)         lowlim = 33, highlim = 126;
1090   else  /* CHARSET_CHARS (cs) == 96) */      lowlim = 32, highlim = 127;
1091
1092   CHECK_INT (arg1);
1093   /* It is useful (and safe, according to Olivier Galibert) to strip
1094      the 8th bit off ARG1 and ARG2 because it allows programmers to
1095      write (make-char 'latin-iso8859-2 CODE) where code is the actual
1096      Latin 2 code of the character.  */
1097   a1 = XINT (arg1) & 0x7f;
1098   if (a1 < lowlim || a1 > highlim)
1099     args_out_of_range_3 (arg1, make_int (lowlim), make_int (highlim));
1100
1101   if (CHARSET_DIMENSION (cs) == 1)
1102     {
1103       if (!NILP (arg2))
1104         signal_simple_error
1105           ("Charset is of dimension one; second octet must be nil", arg2);
1106       return make_char (MAKE_CHAR (charset, a1, 0));
1107     }
1108
1109   CHECK_INT (arg2);
1110   a2 = XINT (arg2) & 0x7f;
1111   if (a2 < lowlim || a2 > highlim)
1112     args_out_of_range_3 (arg2, make_int (lowlim), make_int (highlim));
1113
1114   return make_char (MAKE_CHAR (charset, a1, a2));
1115 }
1116
1117 DEFUN ("char-charset", Fchar_charset, 1, 1, 0, /*
1118 Return the character set of char CH.
1119 */
1120        (ch))
1121 {
1122   CHECK_CHAR_COERCE_INT (ch);
1123
1124   return XCHARSET_NAME (CHARSET_BY_LEADING_BYTE
1125                         (CHAR_LEADING_BYTE (XCHAR (ch))));
1126 }
1127
1128 DEFUN ("char-octet", Fchar_octet, 1, 2, 0, /*
1129 Return the octet numbered N (should be 0 or 1) of char CH.
1130 N defaults to 0 if omitted.
1131 */
1132        (ch, n))
1133 {
1134   Lisp_Object charset;
1135   int octet0, octet1;
1136
1137   CHECK_CHAR_COERCE_INT (ch);
1138
1139   BREAKUP_CHAR (XCHAR (ch), charset, octet0, octet1);
1140
1141   if (NILP (n) || EQ (n, Qzero))
1142     return make_int (octet0);
1143   else if (EQ (n, make_int (1)))
1144     return make_int (octet1);
1145   else
1146     signal_simple_error ("Octet number must be 0 or 1", n);
1147 }
1148
1149 DEFUN ("split-char", Fsplit_char, 1, 1, 0, /*
1150 Return list of charset and one or two position-codes of CHAR.
1151 */
1152        (character))
1153 {
1154   /* This function can GC */
1155   struct gcpro gcpro1, gcpro2;
1156   Lisp_Object charset = Qnil;
1157   Lisp_Object rc = Qnil;
1158   int c1, c2;
1159
1160   GCPRO2 (charset, rc);
1161   CHECK_CHAR_COERCE_INT (character);
1162
1163   BREAKUP_CHAR (XCHAR (character), charset, c1, c2);
1164
1165   if (XCHARSET_DIMENSION (Fget_charset (charset)) == 2)
1166     {
1167       rc = list3 (XCHARSET_NAME (charset), make_int (c1), make_int (c2));
1168     }
1169   else
1170     {
1171       rc = list2 (XCHARSET_NAME (charset), make_int (c1));
1172     }
1173   UNGCPRO;
1174
1175   return rc;
1176 }
1177
1178 \f
1179 #ifdef ENABLE_COMPOSITE_CHARS
1180 /************************************************************************/
1181 /*                     composite character functions                    */
1182 /************************************************************************/
1183
1184 Emchar
1185 lookup_composite_char (Bufbyte *str, int len)
1186 {
1187   Lisp_Object lispstr = make_string (str, len);
1188   Lisp_Object ch = Fgethash (lispstr,
1189                              Vcomposite_char_string2char_hash_table,
1190                              Qunbound);
1191   Emchar emch;
1192
1193   if (UNBOUNDP (ch))
1194     {
1195       if (composite_char_row_next >= 128)
1196         signal_simple_error ("No more composite chars available", lispstr);
1197       emch = MAKE_CHAR (Vcharset_composite, composite_char_row_next,
1198                         composite_char_col_next);
1199       Fputhash (make_char (emch), lispstr,
1200                 Vcomposite_char_char2string_hash_table);
1201       Fputhash (lispstr, make_char (emch),
1202                 Vcomposite_char_string2char_hash_table);
1203       composite_char_col_next++;
1204       if (composite_char_col_next >= 128)
1205         {
1206           composite_char_col_next = 32;
1207           composite_char_row_next++;
1208         }
1209     }
1210   else
1211     emch = XCHAR (ch);
1212   return emch;
1213 }
1214
1215 Lisp_Object
1216 composite_char_string (Emchar ch)
1217 {
1218   Lisp_Object str = Fgethash (make_char (ch),
1219                               Vcomposite_char_char2string_hash_table,
1220                               Qunbound);
1221   assert (!UNBOUNDP (str));
1222   return str;
1223 }
1224
1225 xxDEFUN ("make-composite-char", Fmake_composite_char, 1, 1, 0, /*
1226 Convert a string into a single composite character.
1227 The character is the result of overstriking all the characters in
1228 the string.
1229 */
1230        (string))
1231 {
1232   CHECK_STRING (string);
1233   return make_char (lookup_composite_char (XSTRING_DATA (string),
1234                                            XSTRING_LENGTH (string)));
1235 }
1236
1237 xxDEFUN ("composite-char-string", Fcomposite_char_string, 1, 1, 0, /*
1238 Return a string of the characters comprising a composite character.
1239 */
1240        (ch))
1241 {
1242   Emchar emch;
1243
1244   CHECK_CHAR (ch);
1245   emch = XCHAR (ch);
1246   if (CHAR_LEADING_BYTE (emch) != LEADING_BYTE_COMPOSITE)
1247     signal_simple_error ("Must be composite char", ch);
1248   return composite_char_string (emch);
1249 }
1250 #endif /* ENABLE_COMPOSITE_CHARS */
1251
1252 \f
1253 /************************************************************************/
1254 /*                            initialization                            */
1255 /************************************************************************/
1256
1257 void
1258 syms_of_mule_charset (void)
1259 {
1260   INIT_LRECORD_IMPLEMENTATION (charset);
1261
1262   DEFSUBR (Fcharsetp);
1263   DEFSUBR (Ffind_charset);
1264   DEFSUBR (Fget_charset);
1265   DEFSUBR (Fcharset_list);
1266   DEFSUBR (Fcharset_name);
1267   DEFSUBR (Fmake_charset);
1268   DEFSUBR (Fmake_reverse_direction_charset);
1269   /*  DEFSUBR (Freverse_direction_charset); */
1270   DEFSUBR (Fcharset_from_attributes);
1271   DEFSUBR (Fcharset_short_name);
1272   DEFSUBR (Fcharset_long_name);
1273   DEFSUBR (Fcharset_description);
1274   DEFSUBR (Fcharset_dimension);
1275   DEFSUBR (Fcharset_property);
1276   DEFSUBR (Fcharset_id);
1277   DEFSUBR (Fset_charset_ccl_program);
1278   DEFSUBR (Fset_charset_registry);
1279
1280   DEFSUBR (Fmake_char);
1281   DEFSUBR (Fchar_charset);
1282   DEFSUBR (Fchar_octet);
1283   DEFSUBR (Fsplit_char);
1284
1285 #ifdef ENABLE_COMPOSITE_CHARS
1286   DEFSUBR (Fmake_composite_char);
1287   DEFSUBR (Fcomposite_char_string);
1288 #endif
1289
1290   defsymbol (&Qcharsetp, "charsetp");
1291   defsymbol (&Qregistry, "registry");
1292   defsymbol (&Qfinal, "final");
1293   defsymbol (&Qgraphic, "graphic");
1294   defsymbol (&Qdirection, "direction");
1295   defsymbol (&Qreverse_direction_charset, "reverse-direction-charset");
1296   defsymbol (&Qshort_name, "short-name");
1297   defsymbol (&Qlong_name, "long-name");
1298
1299   defsymbol (&Ql2r, "l2r");
1300   defsymbol (&Qr2l, "r2l");
1301
1302   /* Charsets, compatible with FSF 20.3
1303      Naming convention is Script-Charset[-Edition] */
1304   defsymbol (&Qascii,                   "ascii");
1305   defsymbol (&Qcontrol_1,               "control-1");
1306   defsymbol (&Qlatin_iso8859_1,         "latin-iso8859-1");
1307   defsymbol (&Qlatin_iso8859_2,         "latin-iso8859-2");
1308   defsymbol (&Qlatin_iso8859_3,         "latin-iso8859-3");
1309   defsymbol (&Qlatin_iso8859_4,         "latin-iso8859-4");
1310   defsymbol (&Qthai_tis620,             "thai-tis620");
1311   defsymbol (&Qgreek_iso8859_7,         "greek-iso8859-7");
1312   defsymbol (&Qarabic_iso8859_6,        "arabic-iso8859-6");
1313   defsymbol (&Qhebrew_iso8859_8,        "hebrew-iso8859-8");
1314   defsymbol (&Qkatakana_jisx0201,       "katakana-jisx0201");
1315   defsymbol (&Qlatin_jisx0201,          "latin-jisx0201");
1316   defsymbol (&Qcyrillic_iso8859_5,      "cyrillic-iso8859-5");
1317   defsymbol (&Qlatin_iso8859_9,         "latin-iso8859-9");
1318   defsymbol (&Qjapanese_jisx0208_1978,  "japanese-jisx0208-1978");
1319   defsymbol (&Qchinese_gb2312,          "chinese-gb2312");
1320   defsymbol (&Qjapanese_jisx0208,       "japanese-jisx0208");
1321   defsymbol (&Qkorean_ksc5601,          "korean-ksc5601");
1322   defsymbol (&Qjapanese_jisx0212,       "japanese-jisx0212");
1323   defsymbol (&Qchinese_cns11643_1,      "chinese-cns11643-1");
1324   defsymbol (&Qchinese_cns11643_2,      "chinese-cns11643-2");
1325   defsymbol (&Qchinese_big5_1,          "chinese-big5-1");
1326   defsymbol (&Qchinese_big5_2,          "chinese-big5-2");
1327
1328   defsymbol (&Qcomposite,               "composite");
1329 }
1330
1331 void
1332 vars_of_mule_charset (void)
1333 {
1334   int i, j, k;
1335
1336   chlook = xnew (struct charset_lookup);
1337   dumpstruct (&chlook, &charset_lookup_description);
1338
1339   /* Table of charsets indexed by leading byte. */
1340   for (i = 0; i < countof (chlook->charset_by_leading_byte); i++)
1341     chlook->charset_by_leading_byte[i] = Qnil;
1342
1343   /* Table of charsets indexed by type/final-byte/direction. */
1344   for (i = 0; i < countof (chlook->charset_by_attributes); i++)
1345     for (j = 0; j < countof (chlook->charset_by_attributes[0]); j++)
1346       for (k = 0; k < countof (chlook->charset_by_attributes[0][0]); k++)
1347         chlook->charset_by_attributes[i][j][k] = Qnil;
1348
1349   chlook->next_allocated_1_byte_leading_byte = MIN_LEADING_BYTE_PRIVATE_1;
1350   chlook->next_allocated_2_byte_leading_byte = MIN_LEADING_BYTE_PRIVATE_2;
1351 }
1352
1353 void
1354 complex_vars_of_mule_charset (void)
1355 {
1356   staticpro (&Vcharset_hash_table);
1357   Vcharset_hash_table =
1358     make_lisp_hash_table (50, HASH_TABLE_NON_WEAK, HASH_TABLE_EQ);
1359
1360   /* Predefined character sets.  We store them into variables for
1361      ease of access. */
1362
1363   staticpro (&Vcharset_ascii);
1364   Vcharset_ascii =
1365     make_charset (LEADING_BYTE_ASCII, Qascii, 1,
1366                   CHARSET_TYPE_94, 1, 0, 'B',
1367                   CHARSET_LEFT_TO_RIGHT,
1368                   build_string ("ASCII"),
1369                   build_string ("ASCII)"),
1370                   build_string ("ASCII (ISO646 IRV)"),
1371                   build_string ("\\(iso8859-[0-9]*\\|-ascii\\)"));
1372   staticpro (&Vcharset_control_1);
1373   Vcharset_control_1 =
1374     make_charset (LEADING_BYTE_CONTROL_1, Qcontrol_1, 2,
1375                   CHARSET_TYPE_94, 1, 1, 0,
1376                   CHARSET_LEFT_TO_RIGHT,
1377                   build_string ("C1"),
1378                   build_string ("Control characters"),
1379                   build_string ("Control characters 128-191"),
1380                   build_string (""));
1381   staticpro (&Vcharset_latin_iso8859_1);
1382   Vcharset_latin_iso8859_1 =
1383     make_charset (LEADING_BYTE_LATIN_ISO8859_1, Qlatin_iso8859_1, 2,
1384                   CHARSET_TYPE_96, 1, 1, 'A',
1385                   CHARSET_LEFT_TO_RIGHT,
1386                   build_string ("Latin-1"),
1387                   build_string ("ISO8859-1 (Latin-1)"),
1388                   build_string ("ISO8859-1 (Latin-1)"),
1389                   build_string ("iso8859-1"));
1390   staticpro (&Vcharset_latin_iso8859_2);
1391   Vcharset_latin_iso8859_2 =
1392     make_charset (LEADING_BYTE_LATIN_ISO8859_2, Qlatin_iso8859_2, 2,
1393                   CHARSET_TYPE_96, 1, 1, 'B',
1394                   CHARSET_LEFT_TO_RIGHT,
1395                   build_string ("Latin-2"),
1396                   build_string ("ISO8859-2 (Latin-2)"),
1397                   build_string ("ISO8859-2 (Latin-2)"),
1398                   build_string ("iso8859-2"));
1399   staticpro (&Vcharset_latin_iso8859_3);
1400   Vcharset_latin_iso8859_3 =
1401     make_charset (LEADING_BYTE_LATIN_ISO8859_3, Qlatin_iso8859_3, 2,
1402                   CHARSET_TYPE_96, 1, 1, 'C',
1403                   CHARSET_LEFT_TO_RIGHT,
1404                   build_string ("Latin-3"),
1405                   build_string ("ISO8859-3 (Latin-3)"),
1406                   build_string ("ISO8859-3 (Latin-3)"),
1407                   build_string ("iso8859-3"));
1408   staticpro (&Vcharset_latin_iso8859_4);
1409   Vcharset_latin_iso8859_4 =
1410     make_charset (LEADING_BYTE_LATIN_ISO8859_4, Qlatin_iso8859_4, 2,
1411                   CHARSET_TYPE_96, 1, 1, 'D',
1412                   CHARSET_LEFT_TO_RIGHT,
1413                   build_string ("Latin-4"),
1414                   build_string ("ISO8859-4 (Latin-4)"),
1415                   build_string ("ISO8859-4 (Latin-4)"),
1416                   build_string ("iso8859-4"));
1417   staticpro (&Vcharset_thai_tis620);
1418   Vcharset_thai_tis620 =
1419     make_charset (LEADING_BYTE_THAI_TIS620, Qthai_tis620, 2,
1420                   CHARSET_TYPE_96, 1, 1, 'T',
1421                   CHARSET_LEFT_TO_RIGHT,
1422                   build_string ("TIS620"),
1423                   build_string ("TIS620 (Thai)"),
1424                   build_string ("TIS620.2529 (Thai)"),
1425                   build_string ("tis620"));
1426   staticpro (&Vcharset_greek_iso8859_7);
1427   Vcharset_greek_iso8859_7 =
1428     make_charset (LEADING_BYTE_GREEK_ISO8859_7, Qgreek_iso8859_7, 2,
1429                   CHARSET_TYPE_96, 1, 1, 'F',
1430                   CHARSET_LEFT_TO_RIGHT,
1431                   build_string ("ISO8859-7"),
1432                   build_string ("ISO8859-7 (Greek)"),
1433                   build_string ("ISO8859-7 (Greek)"),
1434                   build_string ("iso8859-7"));
1435   staticpro (&Vcharset_arabic_iso8859_6);
1436   Vcharset_arabic_iso8859_6 =
1437     make_charset (LEADING_BYTE_ARABIC_ISO8859_6, Qarabic_iso8859_6, 2,
1438                   CHARSET_TYPE_96, 1, 1, 'G',
1439                   CHARSET_RIGHT_TO_LEFT,
1440                   build_string ("ISO8859-6"),
1441                   build_string ("ISO8859-6 (Arabic)"),
1442                   build_string ("ISO8859-6 (Arabic)"),
1443                   build_string ("iso8859-6"));
1444   staticpro (&Vcharset_hebrew_iso8859_8);
1445   Vcharset_hebrew_iso8859_8 =
1446     make_charset (LEADING_BYTE_HEBREW_ISO8859_8, Qhebrew_iso8859_8, 2,
1447                   CHARSET_TYPE_96, 1, 1, 'H',
1448                   CHARSET_RIGHT_TO_LEFT,
1449                   build_string ("ISO8859-8"),
1450                   build_string ("ISO8859-8 (Hebrew)"),
1451                   build_string ("ISO8859-8 (Hebrew)"),
1452                   build_string ("iso8859-8"));
1453   staticpro (&Vcharset_katakana_jisx0201);
1454   Vcharset_katakana_jisx0201 =
1455     make_charset (LEADING_BYTE_KATAKANA_JISX0201, Qkatakana_jisx0201, 2,
1456                   CHARSET_TYPE_94, 1, 1, 'I',
1457                   CHARSET_LEFT_TO_RIGHT,
1458                   build_string ("JISX0201 Kana"),
1459                   build_string ("JISX0201.1976 (Japanese Kana)"),
1460                   build_string ("JISX0201.1976 Japanese Kana"),
1461                   build_string ("jisx0201.1976"));
1462   staticpro (&Vcharset_latin_jisx0201);
1463   Vcharset_latin_jisx0201 =
1464     make_charset (LEADING_BYTE_LATIN_JISX0201, Qlatin_jisx0201, 2,
1465                   CHARSET_TYPE_94, 1, 0, 'J',
1466                   CHARSET_LEFT_TO_RIGHT,
1467                   build_string ("JISX0201 Roman"),
1468                   build_string ("JISX0201.1976 (Japanese Roman)"),
1469                   build_string ("JISX0201.1976 Japanese Roman"),
1470                   build_string ("jisx0201.1976"));
1471   staticpro (&Vcharset_cyrillic_iso8859_5);
1472   Vcharset_cyrillic_iso8859_5 =
1473     make_charset (LEADING_BYTE_CYRILLIC_ISO8859_5, Qcyrillic_iso8859_5, 2,
1474                   CHARSET_TYPE_96, 1, 1, 'L',
1475                   CHARSET_LEFT_TO_RIGHT,
1476                   build_string ("ISO8859-5"),
1477                   build_string ("ISO8859-5 (Cyrillic)"),
1478                   build_string ("ISO8859-5 (Cyrillic)"),
1479                   build_string ("iso8859-5"));
1480   staticpro (&Vcharset_latin_iso8859_9);
1481   Vcharset_latin_iso8859_9 =
1482     make_charset (LEADING_BYTE_LATIN_ISO8859_9, Qlatin_iso8859_9, 2,
1483                   CHARSET_TYPE_96, 1, 1, 'M',
1484                   CHARSET_LEFT_TO_RIGHT,
1485                   build_string ("Latin-5"),
1486                   build_string ("ISO8859-9 (Latin-5)"),
1487                   build_string ("ISO8859-9 (Latin-5)"),
1488                   build_string ("iso8859-9"));
1489   staticpro (&Vcharset_japanese_jisx0208_1978);
1490   Vcharset_japanese_jisx0208_1978 =
1491     make_charset (LEADING_BYTE_JAPANESE_JISX0208_1978, Qjapanese_jisx0208_1978, 3,
1492                   CHARSET_TYPE_94X94, 2, 0, '@',
1493                   CHARSET_LEFT_TO_RIGHT,
1494                   build_string ("JISX0208.1978"),
1495                   build_string ("JISX0208.1978 (Japanese)"),
1496                   build_string
1497                   ("JISX0208.1978 Japanese Kanji (so called \"old JIS\")"),
1498                   build_string ("\\(jisx0208\\|jisc6226\\)\\.1978"));
1499   staticpro (&Vcharset_chinese_gb2312);
1500   Vcharset_chinese_gb2312 =
1501     make_charset (LEADING_BYTE_CHINESE_GB2312, Qchinese_gb2312, 3,
1502                   CHARSET_TYPE_94X94, 2, 0, 'A',
1503                   CHARSET_LEFT_TO_RIGHT,
1504                   build_string ("GB2312"),
1505                   build_string ("GB2312)"),
1506                   build_string ("GB2312 Chinese simplified"),
1507                   build_string ("gb2312"));
1508   staticpro (&Vcharset_japanese_jisx0208);
1509   Vcharset_japanese_jisx0208 =
1510     make_charset (LEADING_BYTE_JAPANESE_JISX0208, Qjapanese_jisx0208, 3,
1511                   CHARSET_TYPE_94X94, 2, 0, 'B',
1512                   CHARSET_LEFT_TO_RIGHT,
1513                   build_string ("JISX0208"),
1514                   build_string ("JISX0208.1983/1990 (Japanese)"),
1515                   build_string ("JISX0208.1983/1990 Japanese Kanji"),
1516                   build_string ("jisx0208.19\\(83\\|90\\)"));
1517   staticpro (&Vcharset_korean_ksc5601);
1518   Vcharset_korean_ksc5601 =
1519     make_charset (LEADING_BYTE_KOREAN_KSC5601, Qkorean_ksc5601, 3,
1520                   CHARSET_TYPE_94X94, 2, 0, 'C',
1521                   CHARSET_LEFT_TO_RIGHT,
1522                   build_string ("KSC5601"),
1523                   build_string ("KSC5601 (Korean"),
1524                   build_string ("KSC5601 Korean Hangul and Hanja"),
1525                   build_string ("ksc5601"));
1526   staticpro (&Vcharset_japanese_jisx0212);
1527   Vcharset_japanese_jisx0212 =
1528     make_charset (LEADING_BYTE_JAPANESE_JISX0212, Qjapanese_jisx0212, 3,
1529                   CHARSET_TYPE_94X94, 2, 0, 'D',
1530                   CHARSET_LEFT_TO_RIGHT,
1531                   build_string ("JISX0212"),
1532                   build_string ("JISX0212 (Japanese)"),
1533                   build_string ("JISX0212 Japanese Supplement"),
1534                   build_string ("jisx0212"));
1535
1536 #define CHINESE_CNS_PLANE_RE(n) "cns11643[.-]\\(.*[.-]\\)?" n "$"
1537   staticpro (&Vcharset_chinese_cns11643_1);
1538   Vcharset_chinese_cns11643_1 =
1539     make_charset (LEADING_BYTE_CHINESE_CNS11643_1, Qchinese_cns11643_1, 3,
1540                   CHARSET_TYPE_94X94, 2, 0, 'G',
1541                   CHARSET_LEFT_TO_RIGHT,
1542                   build_string ("CNS11643-1"),
1543                   build_string ("CNS11643-1 (Chinese traditional)"),
1544                   build_string
1545                   ("CNS 11643 Plane 1 Chinese traditional"),
1546                   build_string (CHINESE_CNS_PLANE_RE("1")));
1547   staticpro (&Vcharset_chinese_cns11643_2);
1548   Vcharset_chinese_cns11643_2 =
1549     make_charset (LEADING_BYTE_CHINESE_CNS11643_2, Qchinese_cns11643_2, 3,
1550                   CHARSET_TYPE_94X94, 2, 0, 'H',
1551                   CHARSET_LEFT_TO_RIGHT,
1552                   build_string ("CNS11643-2"),
1553                   build_string ("CNS11643-2 (Chinese traditional)"),
1554                   build_string
1555                   ("CNS 11643 Plane 2 Chinese traditional"),
1556                   build_string (CHINESE_CNS_PLANE_RE("2")));
1557   staticpro (&Vcharset_chinese_big5_1);
1558   Vcharset_chinese_big5_1 =
1559     make_charset (LEADING_BYTE_CHINESE_BIG5_1, Qchinese_big5_1, 3,
1560                   CHARSET_TYPE_94X94, 2, 0, '0',
1561                   CHARSET_LEFT_TO_RIGHT,
1562                   build_string ("Big5"),
1563                   build_string ("Big5 (Level-1)"),
1564                   build_string
1565                   ("Big5 Level-1 Chinese traditional"),
1566                   build_string ("big5"));
1567   staticpro (&Vcharset_chinese_big5_2);
1568   Vcharset_chinese_big5_2 =
1569     make_charset (LEADING_BYTE_CHINESE_BIG5_2, Qchinese_big5_2, 3,
1570                   CHARSET_TYPE_94X94, 2, 0, '1',
1571                   CHARSET_LEFT_TO_RIGHT,
1572                   build_string ("Big5"),
1573                   build_string ("Big5 (Level-2)"),
1574                   build_string
1575                   ("Big5 Level-2 Chinese traditional"),
1576                   build_string ("big5"));
1577
1578
1579 #ifdef ENABLE_COMPOSITE_CHARS
1580   /* #### For simplicity, we put composite chars into a 96x96 charset.
1581      This is going to lead to problems because you can run out of
1582      room, esp. as we don't yet recycle numbers. */
1583   staticpro (&Vcharset_composite);
1584   Vcharset_composite =
1585     make_charset (LEADING_BYTE_COMPOSITE, Qcomposite, 3,
1586                   CHARSET_TYPE_96X96, 2, 0, 0,
1587                   CHARSET_LEFT_TO_RIGHT,
1588                   build_string ("Composite"),
1589                   build_string ("Composite characters"),
1590                   build_string ("Composite characters"),
1591                   build_string (""));
1592
1593   /* #### not dumped properly */
1594   composite_char_row_next = 32;
1595   composite_char_col_next = 32;
1596
1597   Vcomposite_char_string2char_hash_table =
1598     make_lisp_hash_table (500, HASH_TABLE_NON_WEAK, HASH_TABLE_EQUAL);
1599   Vcomposite_char_char2string_hash_table =
1600     make_lisp_hash_table (500, HASH_TABLE_NON_WEAK, HASH_TABLE_EQ);
1601   staticpro (&Vcomposite_char_string2char_hash_table);
1602   staticpro (&Vcomposite_char_char2string_hash_table);
1603 #endif /* ENABLE_COMPOSITE_CHARS */
1604
1605 }