Sync with r21-4-9-utf-2000-0_19-jc3lisp.
[chise/xemacs-chise.git] / src / char-ucs.h
1 /* Header for UCS-4 character representation.
2    Copyright (C) 1999,2000,2001,2002 MORIOKA Tomohiko
3
4 This file is part of XEmacs.
5
6 XEmacs is free software; you can redistribute it and/or modify it
7 under the terms of the GNU General Public License as published by the
8 Free Software Foundation; either version 2, or (at your option) any
9 later version.
10
11 XEmacs is distributed in the hope that it will be useful, but WITHOUT
12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with XEmacs; see the file COPYING.  If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA.  */
20
21 #ifndef INCLUDED_char_ucs_h_
22 #define INCLUDED_char_ucs_h_
23
24 #include "chartab.h"
25 #include "elhash.h"
26
27 extern Lisp_Object Vchar_attribute_hash_table;
28
29 #define valid_char_p(ch) 1
30
31 #define CHAR_ASCII_P(ch) ((ch) <= 0x7F)
32
33 \f
34 /************************************************************************/
35 /*                            Exported functions                        */
36 /************************************************************************/
37
38 extern Lisp_Object Vcharset_ucs;
39 extern Lisp_Object Vcharset_latin_jisx0201;
40 extern Lisp_Object Vcharset_chinese_big5;
41 extern Lisp_Object Vcharset_chinese_big5_1;
42 extern Lisp_Object Vcharset_chinese_big5_2;
43 extern Lisp_Object Vcharset_japanese_jisx0208;
44 extern Lisp_Object Vcharset_japanese_jisx0208_1990;
45 extern Lisp_Object Vcharset_japanese_jisx0212;
46
47 EXFUN (Fget_charset, 1);
48
49 extern Lisp_Object Qucs;
50
51 Lisp_Object put_char_ccs_code_point (Lisp_Object character,
52                                      Lisp_Object ccs, Lisp_Object value);
53 Lisp_Object remove_char_ccs (Lisp_Object character, Lisp_Object ccs);
54
55 \f
56 /************************************************************************/
57 /*                    Definition of leading bytes                       */
58 /************************************************************************/
59
60 typedef short Charset_ID;
61
62 #define MIN_LEADING_BYTE                -0x200
63
64 /* ISO/IEC 10646 */
65 #define LEADING_BYTE_UCS                (MIN_LEADING_BYTE + 1)
66
67 /* represent normal 80-9F */
68 #define LEADING_BYTE_CONTROL_1          (MIN_LEADING_BYTE + 2)
69
70 /* ISO/IEC 10646 BMP */
71 #define LEADING_BYTE_UCS_BMP            (MIN_LEADING_BYTE + 3)
72
73 /* ISO/IEC 10646 SMP */
74 #define LEADING_BYTE_UCS_SMP            (MIN_LEADING_BYTE + 4)
75
76 /* ISO/IEC 10646 SIP */
77 #define LEADING_BYTE_UCS_SIP            (MIN_LEADING_BYTE + 5)
78
79 /* ISO/IEC 10646 for GB */
80 #define LEADING_BYTE_UCS_GB             (MIN_LEADING_BYTE + 6)
81
82 /* ISO/IEC 10646 for CNS */
83 #define LEADING_BYTE_UCS_CNS            (MIN_LEADING_BYTE + 7)
84
85 /* ISO/IEC 10646 for JIS */
86 #define LEADING_BYTE_UCS_JIS            (MIN_LEADING_BYTE + 8)
87
88 /* ISO/IEC 10646 for KS */
89 #define LEADING_BYTE_UCS_KS             (MIN_LEADING_BYTE + 9)
90
91 /* ISO/IEC 10646 for Big5 */
92 #define LEADING_BYTE_UCS_BIG5           (MIN_LEADING_BYTE + 10)
93
94 /* Japanese JIS X0208 Common    2/4 2/{(8),9,10,11} 4/2 (B) */
95 #define LEADING_BYTE_JIS_X0208          (MIN_LEADING_BYTE + 11)
96
97 /* Japanese JIS X0208-1990      2/4 2/{(8),9,10,11} 4/2 (B) */
98 #define LEADING_BYTE_JAPANESE_JISX0208_1990 (MIN_LEADING_BYTE + 12)
99
100 /* Chinese GB 12345-1990 */
101 #define LEADING_BYTE_CHINESE_GB12345    (MIN_LEADING_BYTE + 13)
102
103 #define LEADING_BYTE_CHINESE_BIG5       (MIN_LEADING_BYTE + 20)
104
105 /* Big5 Level 1                 2/4 2/{(8),9,10,11} 4/0 '0' */
106 #define LEADING_BYTE_CHINESE_BIG5_1     (MIN_LEADING_BYTE + 21)
107
108 /* Big5 Level 2                 2/4 2/{(8),9,10,11} 4/0 '1' */
109 #define LEADING_BYTE_CHINESE_BIG5_2     (MIN_LEADING_BYTE + 22)
110
111 /* VISCII 1.1 */
112 #define LEADING_BYTE_LATIN_VISCII       (MIN_LEADING_BYTE + 24)
113
114 /* MULE VISCII-LOWER                    (CHARSET_ID_OFFSET_96 + '1') */
115 #define LEADING_BYTE_LATIN_VISCII_LOWER (MIN_LEADING_BYTE + 25)
116
117 /* MULE VISCII-UPPER                    (CHARSET_ID_OFFSET_96 + '2') */
118 #define LEADING_BYTE_LATIN_VISCII_UPPER (MIN_LEADING_BYTE + 26)
119
120 #define LEADING_BYTE_ETHIOPIC_UCS       (MIN_LEADING_BYTE + 27)
121
122 #define LEADING_BYTE_DAIKANWA_0         (MIN_LEADING_BYTE + 28)
123 #define LEADING_BYTE_DAIKANWA_1         (MIN_LEADING_BYTE + 29)
124 #define LEADING_BYTE_DAIKANWA_2         (MIN_LEADING_BYTE + 30)
125 #define LEADING_BYTE_DAIKANWA_3         (MIN_LEADING_BYTE + 31)
126
127 #define LEADING_BYTE_GT                 (MIN_LEADING_BYTE + 40)
128 #define LEADING_BYTE_GT_PJ_1            (MIN_LEADING_BYTE + 41)
129 #define LEADING_BYTE_GT_PJ_2            (MIN_LEADING_BYTE + 42)
130 #define LEADING_BYTE_GT_PJ_3            (MIN_LEADING_BYTE + 43)
131 #define LEADING_BYTE_GT_PJ_4            (MIN_LEADING_BYTE + 44)
132 #define LEADING_BYTE_GT_PJ_5            (MIN_LEADING_BYTE + 45)
133 #define LEADING_BYTE_GT_PJ_6            (MIN_LEADING_BYTE + 46)
134 #define LEADING_BYTE_GT_PJ_7            (MIN_LEADING_BYTE + 47)
135 #define LEADING_BYTE_GT_PJ_8            (MIN_LEADING_BYTE + 48)
136 #define LEADING_BYTE_GT_PJ_9            (MIN_LEADING_BYTE + 49)
137 #define LEADING_BYTE_GT_PJ_10           (MIN_LEADING_BYTE + 50)
138 #define LEADING_BYTE_GT_PJ_11           (MIN_LEADING_BYTE + 51)
139
140 #define LEADING_BYTE_CBETA              (MIN_LEADING_BYTE + 83)
141 /* #define LEADING_BYTE_CHINESE_BIG5_CDP        (MIN_LEADING_BYTE + 84) */
142 #define LEADING_BYTE_HANZIKU_1          (MIN_LEADING_BYTE + 85)
143 #define LEADING_BYTE_HANZIKU_2          (MIN_LEADING_BYTE + 86)
144 #define LEADING_BYTE_HANZIKU_3          (MIN_LEADING_BYTE + 87)
145 #define LEADING_BYTE_HANZIKU_4          (MIN_LEADING_BYTE + 88)
146 #define LEADING_BYTE_HANZIKU_5          (MIN_LEADING_BYTE + 89)
147 #define LEADING_BYTE_HANZIKU_6          (MIN_LEADING_BYTE + 90)
148 #define LEADING_BYTE_HANZIKU_7          (MIN_LEADING_BYTE + 91)
149 #define LEADING_BYTE_HANZIKU_8          (MIN_LEADING_BYTE + 92)
150 #define LEADING_BYTE_HANZIKU_9          (MIN_LEADING_BYTE + 93)
151 #define LEADING_BYTE_HANZIKU_10         (MIN_LEADING_BYTE + 94)
152 #define LEADING_BYTE_HANZIKU_11         (MIN_LEADING_BYTE + 95)
153 #define LEADING_BYTE_HANZIKU_12         (MIN_LEADING_BYTE + 96)
154
155 #define MIN_LEADING_BYTE_PRIVATE        (MIN_LEADING_BYTE + 97)
156 #define MAX_LEADING_BYTE_PRIVATE        -1
157
158
159 /* ISO 646 IRV */
160 #define LEADING_BYTE_ASCII                6 /* (CHARSET_ID_OFFSET_94 + 'B') */
161
162 /* Right half of JIS X0201-1976 */
163 #define LEADING_BYTE_KATAKANA_JISX0201   13 /* (CHARSET_ID_OFFSET_94 + 'I') */
164
165 /* Left  half of JIS X0201-1976 */
166 #define LEADING_BYTE_LATIN_JISX0201      14 /* (CHARSET_ID_OFFSET_94 + 'J') */
167
168
169 /* #define CHARSET_ID_OFFSET_96         (CHARSET_ID_OFFSET_94 + 80) */
170
171 /* Right half of ISO 8859-1 */
172 #define LEADING_BYTE_LATIN_ISO8859_1    100 /* (CHARSET_ID_OFFSET_96 + 'A') */
173
174 /* Right half of ISO 8859-2 */
175 #define LEADING_BYTE_LATIN_ISO8859_2    101 /* (CHARSET_ID_OFFSET_96 + 'B') */
176
177 /* Right half of ISO 8859-3 */
178 #define LEADING_BYTE_LATIN_ISO8859_3    109 /* (CHARSET_ID_OFFSET_96 + 'C') */
179
180 /* Right half of ISO 8859-4 */
181 #define LEADING_BYTE_LATIN_ISO8859_4    110 /* (CHARSET_ID_OFFSET_96 + 'D') */
182
183 /* Right half of ISO 8859-7 */
184 #define LEADING_BYTE_GREEK_ISO8859_7    126 /* (CHARSET_ID_OFFSET_96 + 'F') */
185
186 /* Right half of ISO 8859-6 */
187 #define LEADING_BYTE_ARABIC_ISO8859_6   127 /* (CHARSET_ID_OFFSET_96 + 'G') */
188
189 /* Right half of ISO 8859-8 */
190 #define LEADING_BYTE_HEBREW_ISO8859_8   138 /* (CHARSET_ID_OFFSET_96 + 'H') */
191
192 /* Right half of ISO 8859-5 */
193 #define LEADING_BYTE_CYRILLIC_ISO8859_5 144 /* (CHARSET_ID_OFFSET_96 + 'L') */
194
195 /* Right half of ISO 8859-9 */
196 #define LEADING_BYTE_LATIN_ISO8859_9    148 /* (CHARSET_ID_OFFSET_96 + 'M') */
197
198 /* TIS620-2533 */
199 #define LEADING_BYTE_THAI_TIS620        166 /* (CHARSET_ID_OFFSET_96 + 'T') */
200
201 /* Right-hand Part of the VSCII-2 (TCVN 5712:1983) */
202 #define LEADING_BYTE_LATIN_TCVN5712     180 /* F = 5/10 0x5A `Z' */
203
204
205 /* #define CHARSET_ID_OFFSET_94x94              (CHARSET_ID_OFFSET_96 + 80) */
206
207 /* #define MIN_LEADING_BYTE_PRIVATE_2   ('0' + CHARSET_ID_OFFSET_94x94) */
208 /* #define MAX_LEADING_BYTE_PRIVATE_2   ('?' + CHARSET_ID_OFFSET_94x94) */
209
210 /* Japanese JIS X0208-1978      2/4 2/{(8),9,10,11} 4/0 (@) */
211 #define LEADING_BYTE_JAPANESE_JISX0208_1978      42
212
213 /* Chinese Hanzi GB2312-1980    2/4 2/{(8),9,10,11} 4/1 (A) */
214 #define LEADING_BYTE_CHINESE_GB2312              58
215
216 /* Japanese JIS X0208-1983      2/4 2/{(8),9,10,11} 4/2 (B) */
217 #define LEADING_BYTE_JAPANESE_JISX0208           87
218
219 /* Hangul KS C5601-1987         2/4 2/{8,9,10,11} 4/3 (C) */
220 #define LEADING_BYTE_KOREAN_KSC5601             149
221
222 /* Japanese JIS X0212-1990      2/4 2/{8,9,10,11} 4/4 (D) */
223 #define LEADING_BYTE_JAPANESE_JISX0212          159
224
225 /* CCITT Extended GB            2/4 2/{8,9,10,11} 4/5 (E) */
226 #define LEADING_BYTE_CHINESE_CCITT_GB           165
227
228 /* Chinese CNS11643 Set 1       2/4 2/{8,9,10,11} 4/7 (G) */
229 #define LEADING_BYTE_CHINESE_CNS11643_1         171
230
231 /* Chinese CNS11643 Set 2       2/4 2/{8,9,10,11} 4/8 (H) */
232 #define LEADING_BYTE_CHINESE_CNS11643_2         172
233
234 /* Chinese CNS11643 Set 3       2/4 2/{8,9,10,11} 4/9 (I) */
235 #define LEADING_BYTE_CHINESE_CNS11643_3         183
236
237 /* Chinese CNS11643 Set 4       2/4 2/{8,9,10,11} 4/10 (J) */
238 #define LEADING_BYTE_CHINESE_CNS11643_4         184
239
240 /* Chinese CNS11643 Set 5       2/4 2/{8,9,10,11} 4/11 (K) */
241 #define LEADING_BYTE_CHINESE_CNS11643_5         185
242
243 /* Chinese CNS11643 Set 6       2/4 2/{8,9,10,11} 4/12 (L) */
244 #define LEADING_BYTE_CHINESE_CNS11643_6         186
245
246 /* Chinese CNS11643 Set 7       2/4 2/{8,9,10,11} 4/13 (M) */
247 #define LEADING_BYTE_CHINESE_CNS11643_7         187
248
249 /* DPRK Hangul KPS 9566-1997    2/4 2/{8,9,10,11} 4/14 (N) */
250 #define LEADING_BYTE_KOREAN_KPS9566             202
251
252
253 #define NUM_LEADING_BYTES       (80 * 3 - MIN_LEADING_BYTE)
254
255 \f
256 /************************************************************************/
257 /*            Information about a particular character set              */
258 /************************************************************************/
259
260 struct Lisp_Charset
261 {
262   struct lcrecord_header header;
263
264   int id;
265   Lisp_Object name;
266   Lisp_Object doc_string;
267   Lisp_Object registry;
268   Lisp_Object short_name;
269   Lisp_Object long_name;
270
271   Lisp_Object reverse_direction_charset;
272
273   Lisp_Object ccl_program;
274
275   /* Final byte of this character set in ISO2022 designating escape sequence */
276   Bufbyte final;
277
278   /* Number of columns a character in this charset takes up, on TTY
279      devices.  Not used for X devices. */
280   unsigned int columns;
281
282   /* Direction of this character set */
283   unsigned int direction;
284
285   /* Number of bytes used in encoding of this character set (1 .. 4) */
286   unsigned short dimension;
287
288   /* Number of chars in each dimension (94, 96, 128, 256) */
289   unsigned short chars;
290
291   /* Which half of font to be used to display this character set */
292   unsigned int graphic;
293
294   /* Code-point->character mapping table */
295   Lisp_Object decoding_table;
296
297   /* Base CCS */
298   Lisp_Object mother;
299
300   /* Range of character code */
301   int min_code, max_code;
302
303   /* Offset for external code */
304   int code_offset;
305
306   /* Type of conversion from mother CCS */
307   unsigned char conversion;
308
309   /* Offset for each byte */
310   int byte_offset;
311 };
312 typedef struct Lisp_Charset Lisp_Charset;
313
314 DECLARE_LRECORD (charset, Lisp_Charset);
315 #define XCHARSET(x) XRECORD (x, charset, Lisp_Charset)
316 #define XSETCHARSET(x, p) XSETRECORD (x, p, charset)
317 #define CHARSETP(x) RECORDP (x, charset)
318 #define GC_CHARSETP(x) GC_RECORDP (x, charset)
319 #define CHECK_CHARSET(x) CHECK_RECORD (x, charset)
320 #define CONCHECK_CHARSET(x) CONCHECK_RECORD (x, charset)
321
322 #define CHARSET_LEFT_TO_RIGHT   0
323 #define CHARSET_RIGHT_TO_LEFT   1
324
325 /* Leading byte and id have been regrouped. -- OG */
326 #define CHARSET_ID(cs)           ((cs)->id)
327 #define CHARSET_LEADING_BYTE(cs) (CHARSET_ID(cs))
328 #define CHARSET_NAME(cs)         ((cs)->name)
329 #define CHARSET_SHORT_NAME(cs)   ((cs)->short_name)
330 #define CHARSET_LONG_NAME(cs)    ((cs)->long_name)
331 #define CHARSET_COLUMNS(cs)      ((cs)->columns)
332 #define CHARSET_GRAPHIC(cs)      ((cs)->graphic)
333 #define CHARSET_DIRECTION(cs)    ((cs)->direction)
334 #define CHARSET_FINAL(cs)        ((cs)->final)
335 #define CHARSET_DOC_STRING(cs)   ((cs)->doc_string)
336 #define CHARSET_REGISTRY(cs)     ((cs)->registry)
337 #define CHARSET_CCL_PROGRAM(cs)  ((cs)->ccl_program)
338 #define CHARSET_DIMENSION(cs)    ((cs)->dimension)
339 #define CHARSET_CHARS(cs)        ((cs)->chars)
340 #define CHARSET_REVERSE_DIRECTION_CHARSET(cs) ((cs)->reverse_direction_charset)
341 #define CHARSET_DECODING_TABLE(cs) ((cs)->decoding_table)
342 #define CHARSET_MIN_CODE(cs)     ((cs)->min_code)
343 #define CHARSET_MAX_CODE(cs)     ((cs)->max_code)
344 #define CHARSET_CODE_OFFSET(cs)  ((cs)->code_offset)
345 #define CHARSET_BYTE_OFFSET(cs)  ((cs)->byte_offset)
346 #define CHARSET_MOTHER(cs)       ((cs)->mother)
347 #define CHARSET_CONVERSION(cs)   ((cs)->conversion)
348
349 INLINE_HEADER int CHARSET_BYTE_SIZE (Lisp_Charset* cs);
350 INLINE_HEADER int
351 CHARSET_BYTE_SIZE (Lisp_Charset* cs)
352 {
353   /* ad-hoc method for `ascii' */
354   if ((CHARSET_CHARS (cs) == 94) &&
355       (CHARSET_BYTE_OFFSET (cs) != 33))
356     return 128 - CHARSET_BYTE_OFFSET (cs);
357   else
358     return CHARSET_CHARS (cs);
359 }
360
361 INLINE_HEADER Lisp_Object CHARSET_ENCODING_TABLE (Lisp_Charset* cs);
362 INLINE_HEADER Lisp_Object
363 CHARSET_ENCODING_TABLE (Lisp_Charset* cs)
364 {
365   return Fgethash (CHARSET_NAME(cs),
366                    Vchar_attribute_hash_table,
367                    Qnil);
368 }
369
370 #define CONVERSION_IDENTICAL    0
371 #define CONVERSION_94           1
372 #define CONVERSION_96           2
373 #define CONVERSION_94x60        3
374 #define CONVERSION_94x94        4
375 #define CONVERSION_96x96        5
376 #define CONVERSION_94x94x60     6
377 #define CONVERSION_94x94x94     7
378 #define CONVERSION_96x96x96     8
379 #define CONVERSION_94x94x94x60  9
380 #define CONVERSION_94x94x94x94  10
381 #define CONVERSION_96x96x96x96  11
382
383 #define XCHARSET_ID(cs)           CHARSET_ID           (XCHARSET (cs))
384 #define XCHARSET_NAME(cs)         CHARSET_NAME         (XCHARSET (cs))
385 #define XCHARSET_SHORT_NAME(cs)   CHARSET_SHORT_NAME   (XCHARSET (cs))
386 #define XCHARSET_LONG_NAME(cs)    CHARSET_LONG_NAME    (XCHARSET (cs))
387 #define XCHARSET_GRAPHIC(cs)      CHARSET_GRAPHIC      (XCHARSET (cs))
388 #define XCHARSET_DIRECTION(cs)    CHARSET_DIRECTION    (XCHARSET (cs))
389 #define XCHARSET_FINAL(cs)        CHARSET_FINAL        (XCHARSET (cs))
390 #define XCHARSET_DOC_STRING(cs)   CHARSET_DOC_STRING   (XCHARSET (cs))
391 #define XCHARSET_REGISTRY(cs)     CHARSET_REGISTRY     (XCHARSET (cs))
392 #define XCHARSET_LEADING_BYTE(cs) CHARSET_LEADING_BYTE (XCHARSET (cs))
393 #define XCHARSET_CCL_PROGRAM(cs)  CHARSET_CCL_PROGRAM  (XCHARSET (cs))
394 #define XCHARSET_DIMENSION(cs)    CHARSET_DIMENSION    (XCHARSET (cs))
395 #define XCHARSET_CHARS(cs)        CHARSET_CHARS        (XCHARSET (cs))
396 #define XCHARSET_BYTE_SIZE(cs)    CHARSET_BYTE_SIZE    (XCHARSET (cs))
397 #define XCHARSET_REVERSE_DIRECTION_CHARSET(cs) \
398   CHARSET_REVERSE_DIRECTION_CHARSET (XCHARSET (cs))
399 #define XCHARSET_DECODING_TABLE(cs) CHARSET_DECODING_TABLE(XCHARSET(cs))
400 #define XCHARSET_ENCODING_TABLE(cs) CHARSET_ENCODING_TABLE(XCHARSET(cs))
401 #define XCHARSET_MIN_CODE(cs)     CHARSET_MIN_CODE(XCHARSET(cs))
402 #define XCHARSET_MAX_CODE(cs)     CHARSET_MAX_CODE(XCHARSET(cs))
403 #define XCHARSET_CODE_OFFSET(cs)  CHARSET_CODE_OFFSET(XCHARSET(cs))
404 #define XCHARSET_BYTE_OFFSET(cs)  CHARSET_BYTE_OFFSET(XCHARSET(cs))
405 #define XCHARSET_MOTHER(cs)       CHARSET_MOTHER(XCHARSET(cs))
406 #define XCHARSET_CONVERSION(cs)   CHARSET_CONVERSION(XCHARSET(cs))
407
408 struct charset_lookup {
409   /* Table of charsets indexed by (leading byte - 128). */
410   Lisp_Object charset_by_leading_byte[NUM_LEADING_BYTES];
411   
412   /* Table of charsets indexed by type/final-byte/direction. */
413   Lisp_Object charset_by_attributes[4][128];
414
415   Charset_ID next_allocated_leading_byte;
416 };
417
418 extern struct charset_lookup *chlook;
419
420 #ifdef ERROR_CHECK_TYPECHECK
421 /* int not Bufbyte even though that is the actual type of a leading byte.
422    This way, out-ot-range values will get caught rather than automatically
423    truncated. */
424 INLINE_HEADER Lisp_Object CHARSET_BY_LEADING_BYTE (Charset_ID lb);
425 INLINE_HEADER Lisp_Object
426 CHARSET_BY_LEADING_BYTE (Charset_ID lb)
427 {
428   assert (lb >= MIN_LEADING_BYTE &&
429           lb < (MIN_LEADING_BYTE + NUM_LEADING_BYTES));
430   return chlook->charset_by_leading_byte[lb - MIN_LEADING_BYTE];
431 }
432
433 #else
434
435 #define CHARSET_BY_LEADING_BYTE(lb) \
436   (chlook->charset_by_leading_byte[(lb) - MIN_LEADING_BYTE])
437
438 #endif
439
440 INLINE_HEADER Lisp_Object
441 CHARSET_BY_ATTRIBUTES (int chars, int dimension, int final, int dir);
442 INLINE_HEADER Lisp_Object
443 CHARSET_BY_ATTRIBUTES (int chars, int dimension, int final, int dir)
444 {
445   int type;
446
447   if (chars == 94)
448     type = 0;
449   else if (chars == 96)
450     type = 1;
451   else
452     return Qnil;
453   type += dimension == 1 ? 0 : 2;
454   return chlook->charset_by_attributes[type][final];
455 }
456
457 \f
458 /************************************************************************/
459 /*                        Dealing with characters                       */
460 /************************************************************************/
461
462 #define MAX_CHAR_BASIC_LATIN    0x007F
463
464 /*
465 #define MIN_CHAR_HEBREW         0x0590
466 #define MAX_CHAR_HEBREW         0x05EF
467 */
468
469 #define MIN_CHAR_THAI           0x0E00
470 #define MAX_CHAR_THAI           0x0E5F
471
472 /*
473 #define MIN_CHAR_HIRAGANA       0x3041
474 #define MAX_CHAR_HIRAGANA       0x3093
475
476 #define MIN_CHAR_KATAKANA       0x30A1
477 #define MAX_CHAR_KATAKANA       0x30F6
478 */
479
480 #define MIN_CHAR_HALFWIDTH_KATAKANA     0xFF61
481 #define MAX_CHAR_HALFWIDTH_KATAKANA     0xFF9F
482
483 #define MAX_CHAR_BMP            0x00FFFF
484
485 #define MIN_CHAR_SMP            0x010000
486 #define MAX_CHAR_SMP            0x01FFFF
487
488 #define MIN_CHAR_SIP            0x020000
489 #define MAX_CHAR_SIP            0x02FFFF
490
491 #define MIN_CHAR_DAIKANWA       0x00E00000
492 #define MAX_CHAR_DAIKANWA       (MIN_CHAR_DAIKANWA + 50100) /* 0xE0FFFF */
493 #define MIN_CHAR_CBETA          0x00E20000
494 #define MAX_CHAR_CBETA          0x00E2FFFF
495 /*
496 #define MIN_CHAR_CHINA3_JEF     0x00E80000
497 #define MAX_CHAR_CHINA3_JEF     0x00E8FFFF
498 */
499
500 #define MIN_CHAR_94             0x00E90940
501 #define MAX_CHAR_94             (MIN_CHAR_94 + 94 * 80 - 1)
502 #define MIN_CHAR_96             (MIN_CHAR_94 + 94 * 80)
503 #define MAX_CHAR_96             (MIN_CHAR_96 + 96 * 80 - 1)
504
505 #define MIN_CHAR_94x94          0xE9F6C0
506 #define MIN_CHAR_JIS_X0208_1990 (MIN_CHAR_94x94 + 94 * 94 * 79)
507 #define MAX_CHAR_94x94          (MIN_CHAR_94x94 + 94 * 94 * 80 - 1)
508 #define MAX_CHAR_JIS_X0208_1990 MAX_CHAR_94x94
509 #define MIN_CHAR_96x96          0xF4C000
510 #define MAX_CHAR_96x96          (MIN_CHAR_96x96 + 96 * 96 * 80 - 1)
511
512 #define MIN_CHAR_GT             0x61000000
513 #define MAX_CHAR_GT             (MIN_CHAR_GT + 66773)
514 #define MIN_CHAR_BIG5_CDP       0x62000000
515 #define MAX_CHAR_BIG5_CDP       0x6200FFFF
516 #define MIN_CHAR_HANZIKU_1      (0x62000000 + 65536 * 1)
517 #define MAX_CHAR_HANZIKU_1      (0x62000000 + 65536 * 1 + 65535)
518 #define MIN_CHAR_HANZIKU_2      (0x62000000 + 65536 * 2)
519 #define MAX_CHAR_HANZIKU_2      (0x62000000 + 65536 * 2 + 65535)
520 #define MIN_CHAR_HANZIKU_3      (0x62000000 + 65536 * 3)
521 #define MAX_CHAR_HANZIKU_3      (0x62000000 + 65536 * 3 + 65535)
522 #define MIN_CHAR_HANZIKU_4      (0x62000000 + 65536 * 4)
523 #define MAX_CHAR_HANZIKU_4      (0x62000000 + 65536 * 4 + 65535)
524 #define MIN_CHAR_HANZIKU_5      (0x62000000 + 65536 * 5)
525 #define MAX_CHAR_HANZIKU_5      (0x62000000 + 65536 * 5 + 65535)
526 #define MIN_CHAR_HANZIKU_6      (0x62000000 + 65536 * 6)
527 #define MAX_CHAR_HANZIKU_6      (0x62000000 + 65536 * 6 + 65535)
528 #define MIN_CHAR_HANZIKU_7      (0x62000000 + 65536 * 7)
529 #define MAX_CHAR_HANZIKU_7      (0x62000000 + 65536 * 7 + 65535)
530 #define MIN_CHAR_HANZIKU_8      (0x62000000 + 65536 * 8)
531 #define MAX_CHAR_HANZIKU_8      (0x62000000 + 65536 * 8 + 65535)
532 #define MIN_CHAR_HANZIKU_9      (0x62000000 + 65536 * 9)
533 #define MAX_CHAR_HANZIKU_9      (0x62000000 + 65536 * 9 + 65535)
534 #define MIN_CHAR_HANZIKU_10     (0x62000000 + 65536 * 10)
535 #define MAX_CHAR_HANZIKU_10     (0x62000000 + 65536 * 10 + 65535)
536 #define MIN_CHAR_HANZIKU_11     (0x62000000 + 65536 * 11)
537 #define MAX_CHAR_HANZIKU_11     (0x62000000 + 65536 * 11 + 65535)
538 #define MIN_CHAR_HANZIKU_12     (0x62000000 + 65536 * 12)
539 #define MAX_CHAR_HANZIKU_12     (0x62000000 + 65536 * 12 + 65535)
540
541 Emchar decode_builtin_char (Lisp_Object charset, int code_point);
542
543 INLINE_HEADER Lisp_Object
544 get_ccs_octet_table (Lisp_Object table, Lisp_Object ccs, int code);
545 INLINE_HEADER Lisp_Object
546 get_ccs_octet_table (Lisp_Object table, Lisp_Object ccs, int code)
547 {
548   int byte_offset = XCHARSET_BYTE_OFFSET (ccs);
549
550   if (VECTORP (table))
551     {
552       int idx = code - byte_offset;
553
554       if (idx < XVECTOR_LENGTH(table))
555         return XVECTOR_DATA(table)[idx];
556       else
557         return Qunbound;
558     }
559   else
560     return table;
561 }
562
563 INLINE_HEADER Lisp_Object
564 put_ccs_octet_table (Lisp_Object table, Lisp_Object ccs, int code,
565                      Lisp_Object value);
566 INLINE_HEADER Lisp_Object
567 put_ccs_octet_table (Lisp_Object table, Lisp_Object ccs, int code,
568                      Lisp_Object value)
569 {
570   int byte_offset = XCHARSET_BYTE_OFFSET (ccs);
571   int ccs_len = XCHARSET_BYTE_SIZE (ccs);
572
573   if (VECTORP (table))
574     {
575       XVECTOR_DATA(table)[code - byte_offset] = value;
576       return table;
577     }
578   else if (EQ (table, value))
579     return table;
580   else
581     {
582       table = make_vector (ccs_len, table);
583       XVECTOR_DATA(table)[code - byte_offset] = value;
584       return table;
585     }
586 }
587
588 INLINE_HEADER void
589 decoding_table_put_char (Lisp_Object ccs,
590                          int code_point, Lisp_Object character);
591 INLINE_HEADER void
592 decoding_table_put_char (Lisp_Object ccs,
593                          int code_point, Lisp_Object character)
594 {
595   Lisp_Object table1 = XCHARSET_DECODING_TABLE (ccs);
596   int dim = XCHARSET_DIMENSION (ccs);
597
598   if (dim == 1)
599     XCHARSET_DECODING_TABLE (ccs)
600       = put_ccs_octet_table (table1, ccs, code_point, character);
601   else if (dim == 2)
602     {
603       Lisp_Object table2
604         = get_ccs_octet_table (table1, ccs, (unsigned char)(code_point >> 8));
605
606       table2 = put_ccs_octet_table (table2, ccs,
607                                     (unsigned char)code_point, character);
608       XCHARSET_DECODING_TABLE (ccs)
609         = put_ccs_octet_table (table1, ccs,
610                                (unsigned char)(code_point >> 8), table2);
611     }
612   else if (dim == 3)
613     {
614       Lisp_Object table2
615         = get_ccs_octet_table (table1, ccs, (unsigned char)(code_point >> 16));
616       Lisp_Object table3
617         = get_ccs_octet_table (table2, ccs, (unsigned char)(code_point >>  8));
618
619       table3 = put_ccs_octet_table (table3, ccs,
620                                     (unsigned char)code_point, character);
621       table2 = put_ccs_octet_table (table2, ccs,
622                                     (unsigned char)(code_point >> 8), table3);
623       XCHARSET_DECODING_TABLE (ccs)
624         = put_ccs_octet_table (table1, ccs,
625                                (unsigned char)(code_point >> 16), table2);
626     }
627   else /* if (dim == 4) */
628     {
629       Lisp_Object table2
630         = get_ccs_octet_table (table1, ccs, (unsigned char)(code_point >> 24));
631       Lisp_Object table3
632         = get_ccs_octet_table (table2, ccs, (unsigned char)(code_point >> 16));
633       Lisp_Object table4
634         = get_ccs_octet_table (table3, ccs, (unsigned char)(code_point >>  8));
635
636       table4 = put_ccs_octet_table (table4, ccs,
637                                     (unsigned char)code_point, character);
638       table3 = put_ccs_octet_table (table3, ccs,
639                                     (unsigned char)(code_point >>  8), table4);
640       table2 = put_ccs_octet_table (table2, ccs,
641                                     (unsigned char)(code_point >> 16), table3);
642       XCHARSET_DECODING_TABLE (ccs)
643         = put_ccs_octet_table (table1, ccs,
644                                (unsigned char)(code_point >> 24), table2);
645     }
646 }
647
648 INLINE_HEADER void
649 decoding_table_remove_char (Lisp_Object ccs, int code_point);
650 INLINE_HEADER void
651 decoding_table_remove_char (Lisp_Object ccs, int code_point)
652 {
653   decoding_table_put_char (ccs, code_point, Qunbound);
654 }
655
656 Emchar decode_defined_char (Lisp_Object charset, int code_point);
657
658 INLINE_HEADER Emchar DECODE_CHAR (Lisp_Object charset, int code_point);
659 INLINE_HEADER Emchar
660 DECODE_CHAR (Lisp_Object charset, int code_point)
661 {
662   Emchar char_id = decode_defined_char (charset, code_point);
663
664   if (char_id >= 0)
665     return char_id;
666   else if (XCHARSET_DIMENSION (charset) == 1)
667     return decode_builtin_char (charset, code_point);
668   else if (EQ (charset, Vcharset_chinese_big5_1))
669     {
670       unsigned int I
671         = ((code_point >> 8) - 33) * (0xFF - 0xA1)
672         + ((code_point & 0xFF) - 33);
673       unsigned char b1 = I / (0xFF - 0xA1 + 0x7F - 0x40) + 0xA1;
674       unsigned char b2 = I % (0xFF - 0xA1 + 0x7F - 0x40);
675
676       b2 += b2 < 0x3F ? 0x40 : 0x62;
677       return DECODE_CHAR (Vcharset_chinese_big5, (b1 << 8) | b2);
678     }
679   else if (EQ (charset, Vcharset_chinese_big5_2))
680     {
681       unsigned int I
682         = ((code_point >> 8) - 33) * (0xFF - 0xA1)
683         + ((code_point & 0xFF) - 33);
684       unsigned char b1, b2;
685
686       I += (0xFF - 0xA1 + 0x7F - 0x40) * (0xC9 - 0xA1);
687       b1 = I / (0xFF - 0xA1 + 0x7F - 0x40) + 0xA1;
688       b2 = I % (0xFF - 0xA1 + 0x7F - 0x40);
689       b2 += b2 < 0x3F ? 0x40 : 0x62;
690       return DECODE_CHAR (Vcharset_chinese_big5, (b1 << 8) | b2);
691     }
692   return decode_builtin_char (charset, code_point);
693 }
694
695 /* Return a character whose charset is CHARSET and position-codes
696    are C1 and C2.  TYPE9N character ignores C2. */
697
698 INLINE_HEADER Emchar MAKE_CHAR (Lisp_Object charset, int c1, int c2);
699 INLINE_HEADER Emchar
700 MAKE_CHAR (Lisp_Object charset, int c1, int c2)
701 {
702   if (XCHARSET_DIMENSION (charset) == 1)
703     return DECODE_CHAR (charset, c1);
704   else
705     return DECODE_CHAR (charset, (c1 << 8) | c2);
706 }
707
708 extern Lisp_Object Vcharacter_attribute_table;
709
710 int encode_builtin_char_1 (Emchar c, Lisp_Object* charset);
711 int charset_code_point (Lisp_Object charset, Emchar ch, int defined_only);
712 int range_charset_code_point (Lisp_Object charset, Emchar ch);
713
714 extern Lisp_Object Vdefault_coded_charset_priority_list;
715 EXFUN (Ffind_charset, 1);
716
717 INLINE_HEADER int encode_char_1 (Emchar ch, Lisp_Object* charset);
718 INLINE_HEADER int
719 encode_char_1 (Emchar ch, Lisp_Object* charset)
720 {
721   Lisp_Object charsets = Vdefault_coded_charset_priority_list;
722
723   while (!NILP (charsets))
724     {
725       *charset = Ffind_charset (Fcar (charsets));
726       if (!NILP (*charset))
727         {
728           int code_point = charset_code_point (*charset, ch, 0);
729
730           if (code_point >= 0)
731             return code_point;
732         }
733       charsets = Fcdr (charsets);             
734     }
735   
736   /* otherwise --- maybe for bootstrap */
737   return encode_builtin_char_1 (ch, charset);
738 }
739
740 #define ENCODE_CHAR(ch, charset)        encode_char_1 (ch, &(charset))
741
742 INLINE_HEADER void
743 breakup_char_1 (Emchar c, Lisp_Object *charset, int *c1, int *c2);
744 INLINE_HEADER void
745 breakup_char_1 (Emchar c, Lisp_Object *charset, int *c1, int *c2)
746 {
747   int code_point = encode_char_1 (c, charset);
748
749   if (code_point >= 0)
750     {
751       int dim = XCHARSET_DIMENSION (*charset);
752
753        if (dim == 1)
754          {
755            *c1 = code_point;
756            *c2 = 0;
757          }
758        else /* if (dim == 2) */
759          {
760            *c1 = code_point >> 8;
761            *c2 = code_point & 255;
762          }
763     }
764   else{
765     *c1 = *c2 = 0;
766   }
767 }
768
769 #define BREAKUP_CHAR(ch, charset, b1, b2) \
770   breakup_char_1 (ch, &(charset), &(b1), &(b2))
771
772 INLINE_HEADER Lisp_Object CHAR_CHARSET (Emchar ch);
773 INLINE_HEADER Lisp_Object
774 CHAR_CHARSET (Emchar ch)
775 {
776   Lisp_Object charset;
777  
778   ENCODE_CHAR (ch, charset);
779   return charset;
780 }
781
782 #define CHAR_CHARSET_ID(c)  (XCHARSET_ID(CHAR_CHARSET(c)))
783 #define CHAR_COLUMNS(c)     (CHARSET_COLUMNS(XCHARSET(CHAR_CHARSET(c))))
784
785
786 typedef struct Charc
787 {
788   Lisp_Object charset;
789   int code_point;
790 } Charc;
791
792 INLINE_HEADER Charc CHAR_TO_CHARC (Emchar ch);
793 INLINE_HEADER Charc
794 CHAR_TO_CHARC (Emchar ch)
795 {
796   Charc cc;
797
798   cc.code_point = encode_char_1 (ch, &cc.charset);
799   return cc;
800 }
801
802 #endif /* INCLUDED_char_ucs_h_ */