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