(rep_bytes_by_first_byte): Modify for conventional MULE
[chise/xemacs-chise.git] / src / character.h
1 /* Header for UCS-4 character representation.
2    Copyright (C) 1999 Electrotechnical Laboratory, JAPAN.
3    Licensed to the Free Software Foundation.
4
5 This file is part of XEmacs.
6
7 XEmacs is free software; you can redistribute it and/or modify it
8 under the terms of the GNU General Public License as published by the
9 Free Software Foundation; either version 2, or (at your option) any
10 later version.
11
12 XEmacs is distributed in the hope that it will be useful, but WITHOUT
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
15 for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with XEmacs; see the file COPYING.  If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA.  */
21
22 /* Rewritten by MORIOKA Tomohiko <tomo@m17n.org>. */
23
24 #ifndef _XEMACS_CHARACTER_H
25 #define _XEMACS_CHARACTER_H
26
27 /************************************************************************/
28 /*                    Definition of leading bytes                       */
29 /************************************************************************/
30
31 #define MIN_LEADING_BYTE                0x80
32 /* These need special treatment in a string and/or character */
33 #define LEADING_BYTE_ASCII              0x8E /* Omitted in a buffer */
34 #ifdef ENABLE_COMPOSITE_CHARS
35 #endif
36 #define LEADING_BYTE_COMPOSITE          0x80 /* for a composite character */
37 #define LEADING_BYTE_CONTROL_1          0x8F /* represent normal 80-9F */
38
39 /** The following are for 1-byte characters in an official charset. **/
40
41 #define LEADING_BYTE_LATIN_ISO8859_1    0x81 /* Right half of ISO 8859-1 */
42 #define LEADING_BYTE_LATIN_ISO8859_2    0x82 /* Right half of ISO 8859-2 */
43 #define LEADING_BYTE_LATIN_ISO8859_3    0x83 /* Right half of ISO 8859-3 */
44 #define LEADING_BYTE_LATIN_ISO8859_4    0x84 /* Right half of ISO 8859-4 */
45 #define LEADING_BYTE_THAI_TIS620        0x85 /* TIS620-2533 */
46 #define LEADING_BYTE_GREEK_ISO8859_7    0x86 /* Right half of ISO 8859-7 */
47 #define LEADING_BYTE_ARABIC_ISO8859_6   0x87 /* Right half of ISO 8859-6 */
48 #define LEADING_BYTE_HEBREW_ISO8859_8   0x88 /* Right half of ISO 8859-8 */
49 #define LEADING_BYTE_KATAKANA_JISX0201  0x89 /* Right half of JIS X0201-1976 */
50 #define LEADING_BYTE_LATIN_JISX0201     0x8A /* Left  half of JIS X0201-1976 */
51 #define LEADING_BYTE_CYRILLIC_ISO8859_5 0x8C /* Right half of ISO 8859-5 */
52 #define LEADING_BYTE_LATIN_ISO8859_9    0x8D /* Right half of ISO 8859-9 */
53
54 #define MIN_LEADING_BYTE_OFFICIAL_1     LEADING_BYTE_LATIN_ISO8859_1
55 #define MAX_LEADING_BYTE_OFFICIAL_1     LEADING_BYTE_LATIN_ISO8859_9
56
57 /** The following are for 2-byte characters in an official charset. **/
58
59 #define LEADING_BYTE_JAPANESE_JISX0208_1978 0x90/* Japanese JIS X0208-1978 */
60 #define LEADING_BYTE_CHINESE_GB2312     0x91    /* Chinese Hanzi GB2312-1980 */
61 #define LEADING_BYTE_JAPANESE_JISX0208  0x92    /* Japanese JIS X0208-1983 */
62 #define LEADING_BYTE_KOREAN_KSC5601     0x93    /* Hangul KS C5601-1987 */
63 #define LEADING_BYTE_JAPANESE_JISX0212  0x94    /* Japanese JIS X0212-1990 */
64 #define LEADING_BYTE_CHINESE_CCITT_GB   0x95    /* CCITT Extended GB */
65 #define LEADING_BYTE_CHINESE_BIG5_1     0x96    /* Big5 Level 1 */
66 #define LEADING_BYTE_CHINESE_CNS11643_1 0x97    /* Chinese CNS11643 Set 1 */
67 #define LEADING_BYTE_CHINESE_CNS11643_2 0x98    /* Chinese CNS11643 Set 2 */
68 #define LEADING_BYTE_CHINESE_CNS11643_3 0x99    /* Chinese CNS11643 Set 3 */
69 #define LEADING_BYTE_CHINESE_CNS11643_4 0x9A    /* Chinese CNS11643 Set 4 */
70 #define LEADING_BYTE_CHINESE_CNS11643_5 0x9B    /* Chinese CNS11643 Set 5 */
71 #define LEADING_BYTE_CHINESE_CNS11643_6 0x9C    /* Chinese CNS11643 Set 6 */
72 #define LEADING_BYTE_CHINESE_CNS11643_7 0x9D    /* Chinese CNS11643 Set 7 */
73 #define LEADING_BYTE_CHINESE_BIG5_2     0x9D    /* Big5 Level 2 */
74 #define LEADING_BYTE_KOREAN_KPS9566     0x9E    /* DPRK Hangul KPS 9566-1997 */
75
76 #define MIN_LEADING_BYTE_OFFICIAL_2     LEADING_BYTE_JAPANESE_JISX0208_1978
77 #define MAX_LEADING_BYTE_OFFICIAL_2     LEADING_BYTE_CHINESE_BIG5_2
78
79 /** The following are for 1- and 2-byte characters in a private charset. **/
80
81 #define PRE_LEADING_BYTE_PRIVATE_1      0x9E    /* 1-byte char-set */
82 #define PRE_LEADING_BYTE_PRIVATE_2      0x9F    /* 2-byte char-set */
83
84 #define MIN_LEADING_BYTE_PRIVATE_1      0xA0
85 #define MAX_LEADING_BYTE_PRIVATE_1      0xEF
86 #define MIN_LEADING_BYTE_PRIVATE_2      0xF0
87 #define MAX_LEADING_BYTE_PRIVATE_2      0xFF
88
89 #define NUM_LEADING_BYTES 128
90
91 \f
92 /************************************************************************/
93 /*                    Operations on leading bytes                       */
94 /************************************************************************/
95
96 /* Is this leading byte for a private charset? */
97
98 #define LEADING_BYTE_PRIVATE_P(lb) ((lb) >= MIN_LEADING_BYTE_PRIVATE_1)
99
100 /* Is this a prefix for a private leading byte? */
101
102 INLINE int LEADING_BYTE_PREFIX_P (unsigned char lb);
103 INLINE int
104 LEADING_BYTE_PREFIX_P (unsigned char lb)
105 {
106   return (lb == PRE_LEADING_BYTE_PRIVATE_1 ||
107           lb == PRE_LEADING_BYTE_PRIVATE_2);
108 }
109
110 /* Given a private leading byte, return the leading byte prefix stored
111    in a string */
112
113 #define PRIVATE_LEADING_BYTE_PREFIX(lb) \
114   ((lb) < MIN_LEADING_BYTE_PRIVATE_2 ?  \
115    PRE_LEADING_BYTE_PRIVATE_1 :         \
116    PRE_LEADING_BYTE_PRIVATE_2)
117
118 \f
119 /************************************************************************/
120 /*                     Operations on individual bytes                   */
121 /*                             of any format                            */
122 /************************************************************************/
123
124 /* Argument `c' should be (unsigned int) or (unsigned char). */
125 /* Note that SP and DEL are not included. */
126
127 #define BYTE_ASCII_P(c) ((c) < 0x80)
128 #define BYTE_C0_P(c) ((c) < 0x20)
129 /* Do some forced casting just to make *sure* things are gotten right. */
130 #define BYTE_C1_P(c) ((unsigned int) ((unsigned int) (c) - 0x80) < 0x20)
131
132 \f
133 /************************************************************************/
134 /*                     Operations on individual bytes                   */
135 /*                       in a Mule-formatted string                     */
136 /************************************************************************/
137
138 /* Does this byte represent the first byte of a character? */
139
140 #ifdef UTF2000
141 INLINE int
142 BUFBYTE_FIRST_BYTE_P(Bufbyte c)
143 {
144   return (c <= 0x7f) || (0xc0 <= c);
145 }
146 #else
147 #define BUFBYTE_FIRST_BYTE_P(c) ((c) < 0xA0)
148 #endif
149
150 /* Does this byte represent the first byte of a multi-byte character? */
151
152 #define BUFBYTE_LEADING_BYTE_P(c) BYTE_C1_P (c)
153
154 \f
155 /************************************************************************/
156 /*            Information about a particular character set              */
157 /************************************************************************/
158
159 struct Lisp_Charset
160 {
161   struct lcrecord_header header;
162
163   int id;
164   Lisp_Object name;
165   Lisp_Object doc_string, registry, short_name, long_name;
166
167   Lisp_Object reverse_direction_charset;
168
169   Lisp_Object ccl_program;
170
171   /* Final byte of this character set in ISO2022 designating escape sequence */
172   Bufbyte final;
173
174   /* Number of bytes (1 - 4) required in the internal representation
175      for characters in this character set.  This is *not* the
176      same as the dimension of the character set). */
177   unsigned int rep_bytes;
178
179   /* Number of columns a character in this charset takes up, on TTY
180      devices.  Not used for X devices. */
181   unsigned int columns;
182
183   /* Direction of this character set */
184   unsigned int direction;
185
186   /* Type of this character set (94, 96, 94x94, 96x96) */
187   unsigned int type;
188
189   /* Number of bytes used in encoding of this character set (1 or 2) */
190   unsigned int dimension;
191
192   /* Number of chars in each dimension (usually 94 or 96) */
193   unsigned int chars;
194
195   /* Which half of font to be used to display this character set */
196   unsigned int graphic;
197 };
198
199 DECLARE_LRECORD (charset, struct Lisp_Charset);
200 #define XCHARSET(x) XRECORD (x, charset, struct Lisp_Charset)
201 #define XSETCHARSET(x, p) XSETRECORD (x, p, charset)
202 #define CHARSETP(x) RECORDP (x, charset)
203 #define GC_CHARSETP(x) GC_RECORDP (x, charset)
204 #define CHECK_CHARSET(x) CHECK_RECORD (x, charset)
205 #define CONCHECK_CHARSET(x) CONCHECK_RECORD (x, charset)
206
207 #define CHARSET_TYPE_94    0    /* This charset includes 94    characters. */
208 #define CHARSET_TYPE_96    1    /* This charset includes 96    characters. */
209 #define CHARSET_TYPE_94X94 2    /* This charset includes 94x94 characters. */
210 #define CHARSET_TYPE_96X96 3    /* This charset includes 96x96 characters. */
211
212 #define CHARSET_LEFT_TO_RIGHT   0
213 #define CHARSET_RIGHT_TO_LEFT   1
214
215 /* Leading byte and id have been regrouped. -- OG */
216 #define CHARSET_ID(cs)           ((cs)->id)
217 #define CHARSET_LEADING_BYTE(cs) ((Bufbyte)(CHARSET_ID(cs)))
218 #define CHARSET_NAME(cs)         ((cs)->name)
219 #define CHARSET_SHORT_NAME(cs)   ((cs)->short_name)
220 #define CHARSET_LONG_NAME(cs)    ((cs)->long_name)
221 #define CHARSET_REP_BYTES(cs)    ((cs)->rep_bytes)
222 #define CHARSET_COLUMNS(cs)      ((cs)->columns)
223 #define CHARSET_GRAPHIC(cs)      ((cs)->graphic)
224 #define CHARSET_TYPE(cs)         ((cs)->type)
225 #define CHARSET_DIRECTION(cs)    ((cs)->direction)
226 #define CHARSET_FINAL(cs)        ((cs)->final)
227 #define CHARSET_DOC_STRING(cs)   ((cs)->doc_string)
228 #define CHARSET_REGISTRY(cs)     ((cs)->registry)
229 #define CHARSET_CCL_PROGRAM(cs)  ((cs)->ccl_program)
230 #define CHARSET_DIMENSION(cs)    ((cs)->dimension)
231 #define CHARSET_CHARS(cs)        ((cs)->chars)
232 #define CHARSET_REVERSE_DIRECTION_CHARSET(cs) ((cs)->reverse_direction_charset)
233
234
235 #define CHARSET_PRIVATE_P(cs) LEADING_BYTE_PRIVATE_P (CHARSET_LEADING_BYTE (cs))
236
237 #define XCHARSET_ID(cs)           CHARSET_ID           (XCHARSET (cs))
238 #define XCHARSET_NAME(cs)         CHARSET_NAME         (XCHARSET (cs))
239 #define XCHARSET_SHORT_NAME(cs)   CHARSET_SHORT_NAME   (XCHARSET (cs))
240 #define XCHARSET_LONG_NAME(cs)    CHARSET_LONG_NAME    (XCHARSET (cs))
241 #define XCHARSET_REP_BYTES(cs)    CHARSET_REP_BYTES    (XCHARSET (cs))
242 #define XCHARSET_COLUMNS(cs)      CHARSET_COLUMNS      (XCHARSET (cs))
243 #define XCHARSET_GRAPHIC(cs)      CHARSET_GRAPHIC      (XCHARSET (cs))
244 #define XCHARSET_TYPE(cs)         CHARSET_TYPE         (XCHARSET (cs))
245 #define XCHARSET_DIRECTION(cs)    CHARSET_DIRECTION    (XCHARSET (cs))
246 #define XCHARSET_FINAL(cs)        CHARSET_FINAL        (XCHARSET (cs))
247 #define XCHARSET_DOC_STRING(cs)   CHARSET_DOC_STRING   (XCHARSET (cs))
248 #define XCHARSET_REGISTRY(cs)     CHARSET_REGISTRY     (XCHARSET (cs))
249 #define XCHARSET_LEADING_BYTE(cs) CHARSET_LEADING_BYTE (XCHARSET (cs))
250 #define XCHARSET_CCL_PROGRAM(cs)  CHARSET_CCL_PROGRAM  (XCHARSET (cs))
251 #define XCHARSET_DIMENSION(cs)    CHARSET_DIMENSION    (XCHARSET (cs))
252 #define XCHARSET_CHARS(cs)        CHARSET_CHARS        (XCHARSET (cs))
253 #define XCHARSET_PRIVATE_P(cs)    CHARSET_PRIVATE_P    (XCHARSET (cs))
254 #define XCHARSET_REVERSE_DIRECTION_CHARSET(cs) \
255   CHARSET_REVERSE_DIRECTION_CHARSET (XCHARSET (cs))
256
257 /* Table of charsets indexed by (leading byte - 128). */
258 extern Lisp_Object charset_by_leading_byte[128];
259
260 /* Table of charsets indexed by type/final-byte/direction. */
261 extern Lisp_Object charset_by_attributes[4][128][2];
262
263 /* Table of number of bytes in the string representation of a character
264    indexed by the first byte of that representation.
265
266    This value can be derived other ways -- e.g. something like
267
268    (BYTE_ASCII_P (first_byte) ? 1 :
269     XCHARSET_REP_BYTES (CHARSET_BY_LEADING_BYTE (first_byte)))
270
271    but it's faster this way. */
272 extern Bytecount rep_bytes_by_first_byte[0xA0];
273
274 #ifdef ERROR_CHECK_TYPECHECK
275 /* int not Bufbyte even though that is the actual type of a leading byte.
276    This way, out-ot-range values will get caught rather than automatically
277    truncated. */
278 INLINE Lisp_Object CHARSET_BY_LEADING_BYTE (int lb);
279 INLINE Lisp_Object
280 CHARSET_BY_LEADING_BYTE (int lb)
281 {
282   assert (lb >= 0x80 && lb <= 0xFF);
283   return charset_by_leading_byte[lb - 128];
284 }
285
286 #else
287
288 #define CHARSET_BY_LEADING_BYTE(lb) (charset_by_leading_byte[(lb) - 128])
289
290 #endif
291
292 #define CHARSET_BY_ATTRIBUTES(type, final, dir) \
293   (charset_by_attributes[type][final][dir])
294
295 #ifdef UTF2000
296 INLINE int REP_BYTES_BY_FIRST_BYTE (int fb);
297 INLINE int
298 REP_BYTES_BY_FIRST_BYTE (int fb)
299 {
300   if ( fb >= 0xfc )
301     return 6;
302   else if ( fb >= 0xf8 )
303     return 5;
304   else if ( fb >= 0xf0 )
305     return 4;
306   else if ( fb >= 0xe0 )
307     return 3;
308   else if ( fb >= 0xc0 )
309     return 2;
310   else
311     return 1;
312 }
313 #else /* MULE */
314 #ifdef ERROR_CHECK_TYPECHECK
315
316 /* Number of bytes in the string representation of a character */
317 INLINE int REP_BYTES_BY_FIRST_BYTE (int fb);
318 INLINE int
319 REP_BYTES_BY_FIRST_BYTE (int fb)
320 {
321   assert (fb >= 0 && fb < 0xA0);
322   return rep_bytes_by_first_byte[fb];
323 }
324
325 #else
326 #define REP_BYTES_BY_FIRST_BYTE(fb) (rep_bytes_by_first_byte[fb])
327 #endif
328 #endif /* end MULE */
329
330 \f
331 /************************************************************************/
332 /*                        Dealing with characters                       */
333 /************************************************************************/
334
335 /* Is this character represented by more than one byte in a string? */
336
337 #define CHAR_MULTIBYTE_P(c) ((c) >= 0x80)
338
339 #define CHAR_ASCII_P(c) (!CHAR_MULTIBYTE_P (c))
340
341 /* The bit fields of character are divided into 3 parts:
342    FIELD1(5bits):FIELD2(7bits):FIELD3(7bits) */
343
344 #define CHAR_FIELD1_MASK (0x7F << 14)
345 #define CHAR_FIELD2_MASK (0x7F << 7)
346 #define CHAR_FIELD3_MASK 0x7F
347
348 #define MIN_CHAR_GREEK          0x0370
349 #define MAX_CHAR_GREEK          0x03CF
350
351 #define MIN_CHAR_CYRILLIC       0x0400
352 #define MAX_CHAR_CYRILLIC       0x045F
353
354 #define MIN_CHAR_HEBREW         0x0590
355 #define MAX_CHAR_HEBREW         0x05EF
356
357 #define MIN_CHAR_THAI           0x0E00
358 #define MAX_CHAR_THAI           0x0E5F
359
360 #define MIN_CHAR_HALFWIDTH_KATAKANA     0xFF60
361 #define MAX_CHAR_HALFWIDTH_KATAKANA     0xFF9F
362
363 /* Macros to access each field of a character code of C.  */
364
365 #define CHAR_FIELD1(c) (((c) & CHAR_FIELD1_MASK) >> 14)
366 #define CHAR_FIELD2_INTERNAL(c) (((c) & CHAR_FIELD2_MASK) >> 7)
367 #define CHAR_FIELD3_INTERNAL(c)  ((c) & CHAR_FIELD3_MASK)
368
369 /* Field 1, if non-zero, usually holds a leading byte for a
370    dimension-2 charset.  Field 2, if non-zero, usually holds a leading
371    byte for a dimension-1 charset. */
372
373 /* Converting between field values and leading bytes.  */
374
375 #define FIELD2_TO_OFFICIAL_LEADING_BYTE 0x80
376 #define FIELD2_TO_PRIVATE_LEADING_BYTE  0x80
377
378 #define FIELD1_TO_PRIVATE_LEADING_BYTE  0xc0
379 #define FIELD1_TO_OFFICIAL_LEADING_BYTE 0x50
380
381 INLINE Emchar
382 CHAR_FIELD2 (Emchar c)
383 {
384   if( (MIN_CHAR_GREEK <= c) && (c <= MAX_CHAR_GREEK) )
385     return LEADING_BYTE_GREEK_ISO8859_7
386       - FIELD2_TO_OFFICIAL_LEADING_BYTE;
387   else if( (MIN_CHAR_CYRILLIC <= c) && (c <= MAX_CHAR_CYRILLIC) )
388     return LEADING_BYTE_CYRILLIC_ISO8859_5
389       - FIELD2_TO_OFFICIAL_LEADING_BYTE;
390   else if( (MIN_CHAR_HEBREW <= c) && (c <= MAX_CHAR_HEBREW) )
391     return LEADING_BYTE_HEBREW_ISO8859_8
392       - FIELD2_TO_OFFICIAL_LEADING_BYTE;
393   else if( (MIN_CHAR_THAI <= c) && (c <= MAX_CHAR_THAI) )
394     return LEADING_BYTE_THAI_TIS620
395       - FIELD2_TO_OFFICIAL_LEADING_BYTE;
396   else if( (MIN_CHAR_HALFWIDTH_KATAKANA <= c)
397            && (c <= MAX_CHAR_HALFWIDTH_KATAKANA) )
398     return LEADING_BYTE_KATAKANA_JISX0201
399       - FIELD2_TO_OFFICIAL_LEADING_BYTE;
400   else
401     return CHAR_FIELD2_INTERNAL(c);
402 }
403
404 INLINE Emchar
405 CHAR_FIELD3 (Emchar c)
406 {
407   if( (MIN_CHAR_GREEK <= c) && (c <= MAX_CHAR_GREEK) )
408     return c - MIN_CHAR_GREEK + 0x20;
409   else if( (MIN_CHAR_CYRILLIC <= c) && (c <= MAX_CHAR_CYRILLIC) )
410     return c - MIN_CHAR_CYRILLIC + 0x20;
411   else if( (MIN_CHAR_HEBREW <= c) && (c <= MAX_CHAR_HEBREW) )
412     return c - MIN_CHAR_HEBREW + 0x20;
413   else if( (MIN_CHAR_THAI <= c) && (c <= MAX_CHAR_THAI) )
414     return c - MIN_CHAR_THAI + 0x20;
415   else if( (MIN_CHAR_HALFWIDTH_KATAKANA <= c)
416            && (c <= MAX_CHAR_HALFWIDTH_KATAKANA) )
417     return c - MIN_CHAR_HALFWIDTH_KATAKANA + 0x20;
418   else
419     return CHAR_FIELD3_INTERNAL(c);
420 }
421
422 /* Minimum and maximum allowed values for the fields. */
423
424 #define MIN_CHAR_FIELD2_OFFICIAL \
425   (MIN_LEADING_BYTE_OFFICIAL_1 - FIELD2_TO_OFFICIAL_LEADING_BYTE)
426 #define MAX_CHAR_FIELD2_OFFICIAL \
427   (MAX_LEADING_BYTE_OFFICIAL_1 - FIELD2_TO_OFFICIAL_LEADING_BYTE)
428
429 #define MIN_CHAR_FIELD1_OFFICIAL \
430   (MIN_LEADING_BYTE_OFFICIAL_2 - FIELD1_TO_OFFICIAL_LEADING_BYTE)
431 #define MAX_CHAR_FIELD1_OFFICIAL \
432   (MAX_LEADING_BYTE_OFFICIAL_2 - FIELD1_TO_OFFICIAL_LEADING_BYTE)
433
434 #define MIN_CHAR_FIELD2_PRIVATE \
435   (MIN_LEADING_BYTE_PRIVATE_1 - FIELD2_TO_PRIVATE_LEADING_BYTE)
436 #define MAX_CHAR_FIELD2_PRIVATE \
437   (MAX_LEADING_BYTE_PRIVATE_1 - FIELD2_TO_PRIVATE_LEADING_BYTE)
438
439 #define MIN_CHAR_FIELD1_PRIVATE \
440   (MIN_LEADING_BYTE_PRIVATE_2 - FIELD1_TO_PRIVATE_LEADING_BYTE)
441 #define MAX_CHAR_FIELD1_PRIVATE \
442   (MAX_LEADING_BYTE_PRIVATE_2 - FIELD1_TO_PRIVATE_LEADING_BYTE)
443
444 /* Minimum character code of each <type> character.  */
445
446 #define MULE_CHAR_PRIVATE_OFFSET (0xe0 << 16)
447
448 #define MIN_CHAR_OFFICIAL_TYPE9N \
449   (MULE_CHAR_PRIVATE_OFFSET | (MIN_CHAR_FIELD2_OFFICIAL <<  7))
450 #define MIN_CHAR_PRIVATE_TYPE9N \
451   (MULE_CHAR_PRIVATE_OFFSET | (MIN_CHAR_FIELD2_PRIVATE  <<  7))
452 #define MIN_CHAR_PRIVATE_TYPE9NX9N \
453   (MULE_CHAR_PRIVATE_OFFSET | (MIN_CHAR_FIELD1_PRIVATE  << 14))
454 #define MIN_CHAR_OFFICIAL_TYPE9NX9N \
455   (MULE_CHAR_PRIVATE_OFFSET | (MIN_CHAR_FIELD1_OFFICIAL << 14))
456 #define MIN_CHAR_COMPOSITION \
457   (MULE_CHAR_PRIVATE_OFFSET | (0x7f << 14))
458
459 /* Leading byte of a character.
460
461    NOTE: This takes advantage of the fact that
462    FIELD2_TO_OFFICIAL_LEADING_BYTE and
463    FIELD2_TO_PRIVATE_LEADING_BYTE are the same.
464    */
465
466 INLINE Bufbyte CHAR_LEADING_BYTE (Emchar c);
467 INLINE Bufbyte
468 CHAR_LEADING_BYTE (Emchar c)
469 {
470   if (CHAR_ASCII_P (c))
471     return LEADING_BYTE_ASCII;
472   else if (c < 0xA0)
473     return LEADING_BYTE_CONTROL_1;
474   else if (c <= 0xff)
475     return LEADING_BYTE_LATIN_ISO8859_1;
476   else if (c <= MAX_CHAR_GREEK)
477     return LEADING_BYTE_GREEK_ISO8859_7;
478   else if (c <= MAX_CHAR_CYRILLIC)
479     return LEADING_BYTE_CYRILLIC_ISO8859_5;
480   else if (c <= MAX_CHAR_HEBREW)
481     return LEADING_BYTE_HEBREW_ISO8859_8;
482   else if (c <= MAX_CHAR_THAI)
483     return LEADING_BYTE_THAI_TIS620;
484   else if (c <= MAX_CHAR_HALFWIDTH_KATAKANA)
485     return LEADING_BYTE_KATAKANA_JISX0201;
486   else if (c < MIN_CHAR_PRIVATE_TYPE9NX9N)
487     return CHAR_FIELD2 (c) + FIELD2_TO_OFFICIAL_LEADING_BYTE;
488   else if (c < MIN_CHAR_OFFICIAL_TYPE9NX9N)
489     return CHAR_FIELD1 (c) + FIELD1_TO_PRIVATE_LEADING_BYTE;
490   else if (c < MIN_CHAR_COMPOSITION)
491     return CHAR_FIELD1 (c) + FIELD1_TO_OFFICIAL_LEADING_BYTE;
492   else
493     {
494 #ifdef ENABLE_COMPOSITE_CHARS
495       return LEADING_BYTE_COMPOSITE;
496 #else
497       abort();
498       return 0;
499 #endif /* ENABLE_COMPOSITE_CHARS */
500     }
501 }
502
503 #define CHAR_CHARSET(c) CHARSET_BY_LEADING_BYTE (CHAR_LEADING_BYTE (c))
504
505 /* Return a character whose charset is CHARSET and position-codes
506    are C1 and C2.  TYPE9N character ignores C2.
507
508    NOTE: This takes advantage of the fact that
509    FIELD2_TO_OFFICIAL_LEADING_BYTE and
510    FIELD2_TO_PRIVATE_LEADING_BYTE are the same.
511    */
512
513 INLINE Emchar MAKE_CHAR (Lisp_Object charset, int c1, int c2);
514 INLINE Emchar
515 MAKE_CHAR (Lisp_Object charset, int c1, int c2)
516 {
517   if (EQ (charset, Vcharset_ascii))
518     return c1;
519   else if (EQ (charset, Vcharset_control_1))
520     return c1 | 0x80;
521   else if (EQ (charset, Vcharset_latin_iso8859_1))
522     return c1 | 0x80;
523   else if (EQ (charset, Vcharset_greek_iso8859_7))
524     return c1 + MIN_CHAR_GREEK - 0x20;
525   else if (EQ (charset, Vcharset_cyrillic_iso8859_5))
526     return c1 + MIN_CHAR_CYRILLIC - 0x20;
527   else if (EQ (charset, Vcharset_hebrew_iso8859_8))
528     return c1 + MIN_CHAR_HEBREW - 0x20;
529   else if (EQ (charset, Vcharset_thai_tis620))
530     return c1 + MIN_CHAR_THAI - 0x20;
531   else if (EQ (charset, Vcharset_katakana_jisx0201))
532     if (c1 < 0x60)
533       return c1 + MIN_CHAR_HALFWIDTH_KATAKANA - 0x20;
534     else
535       return 32;
536 #ifdef ENABLE_COMPOSITE_CHARS
537   else if (EQ (charset, Vcharset_composite))
538     return (0x1F << 14) | ((c1) << 7) | (c2);
539 #endif
540   else if (XCHARSET_DIMENSION (charset) == 1)
541     return MULE_CHAR_PRIVATE_OFFSET
542       | ((XCHARSET_LEADING_BYTE (charset) -
543           FIELD2_TO_OFFICIAL_LEADING_BYTE) << 7) | (c1);
544   else if (!XCHARSET_PRIVATE_P (charset))
545     return MULE_CHAR_PRIVATE_OFFSET
546       | ((XCHARSET_LEADING_BYTE (charset) -
547           FIELD1_TO_OFFICIAL_LEADING_BYTE) << 14) | ((c1) << 7) | (c2);
548   else
549     return MULE_CHAR_PRIVATE_OFFSET
550       | ((XCHARSET_LEADING_BYTE (charset) -
551           FIELD1_TO_PRIVATE_LEADING_BYTE) << 14) | ((c1) << 7) | (c2);
552 }
553
554 /* The charset of character C is set to CHARSET, and the
555    position-codes of C are set to C1 and C2.  C2 of TYPE9N character
556    is 0.  */
557
558 /* BREAKUP_CHAR_1_UNSAFE assumes that the charset has already been
559    calculated, and just computes c1 and c2.
560
561    BREAKUP_CHAR also computes and stores the charset. */
562
563 #define BREAKUP_CHAR_1_UNSAFE(c, charset, c1, c2)       \
564   XCHARSET_DIMENSION (charset) == 1                     \
565   ? ((c1) = CHAR_FIELD3 (c), (c2) = 0)                  \
566   : ((c1) = CHAR_FIELD2 (c),                            \
567      (c2) = CHAR_FIELD3 (c))
568
569 INLINE void breakup_char_1 (Emchar c, Lisp_Object *charset, int *c1, int *c2);
570 INLINE void
571 breakup_char_1 (Emchar c, Lisp_Object *charset, int *c1, int *c2)
572 {
573   *charset = CHAR_CHARSET (c);
574   BREAKUP_CHAR_1_UNSAFE (c, *charset, *c1, *c2);
575 }
576
577 #define BREAKUP_CHAR(c, charset, c1, c2) \
578   breakup_char_1 (c, &(charset), &(c1), &(c2))
579
580
581 \f
582 #ifdef ENABLE_COMPOSITE_CHARS
583 /************************************************************************/
584 /*                           Composite characters                       */
585 /************************************************************************/
586
587 Emchar lookup_composite_char (Bufbyte *str, int len);
588 Lisp_Object composite_char_string (Emchar ch);
589 #endif /* ENABLE_COMPOSITE_CHARS */
590
591 \f
592 /************************************************************************/
593 /*                            Exported functions                        */
594 /************************************************************************/
595
596 EXFUN (Ffind_charset, 1);
597 EXFUN (Fget_charset, 1);
598
599 extern Lisp_Object Vcharset_chinese_big5_1;
600 extern Lisp_Object Vcharset_chinese_big5_2;
601 extern Lisp_Object Vcharset_japanese_jisx0208;
602
603 Emchar Lstream_get_emchar_1 (Lstream *stream, int first_char);
604 int Lstream_fput_emchar (Lstream *stream, Emchar ch);
605 void Lstream_funget_emchar (Lstream *stream, Emchar ch);
606
607 int copy_internal_to_external (CONST Bufbyte *internal, Bytecount len,
608                                unsigned char *external);
609 Bytecount copy_external_to_internal (CONST unsigned char *external,
610                                      int len, Bufbyte *internal);
611
612 #endif /* _XEMACS_CHARACTER_H */