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