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