(x_set_alpha): Set alpha to -1 if nil given.
[bpt/emacs.git] / src / charset.h
1 /* Header for charset handler.
2 Copyright (C) 2001, 2002, 2003, 2004, 2005,
3 2006, 2007, 2008 Free Software Foundation, Inc.
4 Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
5 2005, 2006, 2007, 2008
6 National Institute of Advanced Industrial Science and Technology (AIST)
7 Registration Number H14PRO021
8
9 Copyright (C) 2003
10 National Institute of Advanced Industrial Science and Technology (AIST)
11 Registration Number H13PRO009
12
13 This file is part of GNU Emacs.
14
15 GNU Emacs is free software: you can redistribute it and/or modify
16 it under the terms of the GNU General Public License as published by
17 the Free Software Foundation, either version 3 of the License, or
18 (at your option) any later version.
19
20 GNU Emacs is distributed in the hope that it will be useful,
21 but WITHOUT ANY WARRANTY; without even the implied warranty of
22 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 GNU General Public License for more details.
24
25 You should have received a copy of the GNU General Public License
26 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
27
28 #ifndef EMACS_CHARSET_H
29 #define EMACS_CHARSET_H
30
31 /* Index to arguments of Fdefine_charset_internal. */
32
33 enum define_charset_arg_index
34 {
35 charset_arg_name,
36 charset_arg_dimension,
37 charset_arg_code_space,
38 charset_arg_min_code,
39 charset_arg_max_code,
40 charset_arg_iso_final,
41 charset_arg_iso_revision,
42 charset_arg_emacs_mule_id,
43 charset_arg_ascii_compatible_p,
44 charset_arg_supplementary_p,
45 charset_arg_invalid_code,
46 charset_arg_code_offset,
47 charset_arg_map,
48 charset_arg_subset,
49 charset_arg_superset,
50 charset_arg_unify_map,
51 charset_arg_plist,
52 charset_arg_max
53 };
54
55
56 /* Indices to charset attributes vector. */
57
58 enum charset_attr_index
59 {
60 /* ID number of the charset. */
61 charset_id,
62
63 /* Name of the charset (symbol). */
64 charset_name,
65
66 /* Property list of the charset. */
67 charset_plist,
68
69 /* If the method of the charset is `MAP_DEFERRED', the value is a
70 mapping vector or a file name that contains mapping vector.
71 Otherwise, nil. */
72 charset_map,
73
74 /* If the method of the charset is `MAP', the value is a vector
75 that maps code points of the charset to characters. The vector
76 is indexed by a character index. A character index is
77 calculated from a code point and the code-space table of the
78 charset. */
79 charset_decoder,
80
81 /* If the method of the charset is `MAP', the value is a
82 char-table that maps characters of the charset to code
83 points. */
84 charset_encoder,
85
86 /* If the method of the charset is `SUBSET', the value is a vector
87 that has this form:
88
89 [ CHARSET-ID MIN-CODE MAX-CODE OFFSET ]
90
91 CHARSET-ID is an ID number of a parent charset. MIN-CODE and
92 MAX-CODE specify the range of characters inherited from the
93 parent. OFFSET is an integer value to add to a code point of
94 the parent charset to get the corresponding code point of this
95 charset. */
96 charset_subset,
97
98 /* If the method of the charset is `SUPERSET', the value is a list
99 whose elements have this form:
100
101 (CHARSET-ID . OFFSET)
102
103 CHARSET-IDs are ID numbers of parent charsets. OFFSET is an
104 integer value to add to a code point of the parent charset to
105 get the corresponding code point of this charset. */
106 charset_superset,
107
108 /* The value is a mapping vector or a file name that contains the
109 mapping. This defines how characters in the charset should be
110 unified with Unicode. The value of the member
111 `charset_deunifier' is created from this information. */
112 charset_unify_map,
113
114 /* If characters in the charset must be unified Unicode, the value
115 is a char table that maps a unified Unicode character code to
116 the non-unified character code in the charset. */
117 charset_deunifier,
118
119 /* The length of the charset attribute vector. */
120 charset_attr_max
121 };
122
123 /* Methods for converting code points and characters of charsets. */
124
125 enum charset_method
126 {
127 /* For a charset of this method, a character code is calculated
128 from a character index (which is calculated from a code point)
129 simply by adding an offset value. */
130 CHARSET_METHOD_OFFSET,
131
132 /* For a charset of this method, a decoder vector and an encoder
133 char-table is used for code point <-> character code
134 conversion. */
135 CHARSET_METHOD_MAP,
136
137 /* Same as above but decoder and encoder are loaded from a file on
138 demand. Once loaded, the method is changed to
139 CHARSET_METHOD_MAP. */
140 CHARSET_METHOD_MAP_DEFERRED,
141
142 /* A charset of this method is a subset of another charset. */
143 CHARSET_METHOD_SUBSET,
144
145 /* A charset of this method is a superset of other charsets. */
146 CHARSET_METHOD_SUPERSET
147 };
148
149 struct charset
150 {
151 /* Index to charset_table. */
152 int id;
153
154 /* Index to Vcharset_hash_table. */
155 int hash_index;
156
157 /* Dimension of the charset: 1, 2, 3, or 4. */
158 int dimension;
159
160 /* Byte code range of each dimension. <code_space>[4N] is a mininum
161 byte code of the (N+1)th dimension, <code_space>[4N+1] is a
162 maximum byte code of the (N+1)th dimension, <code_space>[4N+2] is
163 (<code_space>[4N+1] - <code_space>[4N] + 1), <code_space>[4N+3]
164 is a number of characters containd in the first to (N+1)th
165 dismesions. We get `char-index' of a `code-point' from this
166 information. */
167 int code_space[16];
168
169 /* If B is a byte of Nth dimension of a code-point, the (N-1)th bit
170 of code_space_mask[B] is set. This array is used to quickly
171 check if a code-point is in a valid range. */
172 unsigned char *code_space_mask;
173
174 /* 1 if there's no gap in code-points. */
175 int code_linear_p;
176
177 /* If the charset is treated as 94-chars in ISO-2022, the value is 0.
178 If the charset is treated as 96-chars in ISO-2022, the value is 1. */
179 int iso_chars_96;
180
181 /* ISO final byte of the charset: 48..127. It may be -1 if the
182 charset doesn't conform to ISO-2022. */
183 int iso_final;
184
185 /* ISO revision number of the charset. */
186 int iso_revision;
187
188 /* If the charset is identical to what supported by Emacs 21 and the
189 priors, the identification number of the charset used in those
190 version. Otherwise, -1. */
191 int emacs_mule_id;
192
193 /* Nonzero if the charset is compatible with ASCII. */
194 int ascii_compatible_p;
195
196 /* Nonzero if the charset is supplementary. */
197 int supplementary_p;
198
199 /* Nonzero if all the code points are representable by Lisp_Int. */
200 int compact_codes_p;
201
202 /* The method for encoding/decoding characters of the charset. */
203 enum charset_method method;
204
205 /* Mininum and Maximum code points of the charset. */
206 unsigned min_code, max_code;
207
208 /* Offset value used by macros CODE_POINT_TO_INDEX and
209 INDEX_TO_CODE_POINT. . */
210 unsigned char_index_offset;
211
212 /* Mininum and Maximum character codes of the charset. If the
213 charset is compatible with ASCII, min_char is a minimum non-ASCII
214 character of the charset. If the method of charset is
215 CHARSET_METHOD_OFFSET, even if the charset is unified, min_char
216 and max_char doesn't change. */
217 int min_char, max_char;
218
219 /* The code returned by ENCODE_CHAR if a character is not encodable
220 by the charset. */
221 unsigned invalid_code;
222
223 /* If the method of the charset is CHARSET_METHOD_MAP, this is a
224 table of bits used to quickly and roughly guess if a character
225 belongs to the charset.
226
227 The first 64 elements are 512 bits for characters less than
228 0x10000. Each bit corresponds to 128-character block. The last
229 126 elements are 1008 bits for the greater characters
230 (0x10000..0x3FFFFF). Each bit corresponds to 4096-character
231 block.
232
233 If a bit is 1, at least one character in the corresponding block is
234 in this charset. */
235 unsigned char fast_map[190];
236
237 /* Offset value to calculate a character code from code-point, and
238 visa versa. */
239 int code_offset;
240
241 int unified_p;
242 };
243
244 /* Hash table of charset symbols vs. the correponding attribute
245 vectors. */
246 extern Lisp_Object Vcharset_hash_table;
247
248 /* Table of struct charset. */
249 extern struct charset *charset_table;
250
251 #define CHARSET_FROM_ID(id) (charset_table + (id))
252
253 extern Lisp_Object Vcharset_ordered_list;
254 extern Lisp_Object Vcharset_non_preferred_head;
255
256 /* Incremented everytime we change the priority of charsets. */
257 extern unsigned short charset_ordered_list_tick;
258
259 extern Lisp_Object Vcharset_list;
260 extern Lisp_Object Viso_2022_charset_list;
261 extern Lisp_Object Vemacs_mule_charset_list;
262
263 extern struct charset *emacs_mule_charset[256];
264
265 extern Lisp_Object Vcurrent_iso639_language;
266
267 /* Macros to access information about charset. */
268
269 /* Return the attribute vector of charset whose symbol is SYMBOL. */
270 #define CHARSET_SYMBOL_ATTRIBUTES(symbol) \
271 Fgethash ((symbol), Vcharset_hash_table, Qnil)
272
273 #define CHARSET_ATTR_ID(attrs) AREF ((attrs), charset_id)
274 #define CHARSET_ATTR_NAME(attrs) AREF ((attrs), charset_name)
275 #define CHARSET_ATTR_PLIST(attrs) AREF ((attrs), charset_plist)
276 #define CHARSET_ATTR_MAP(attrs) AREF ((attrs), charset_map)
277 #define CHARSET_ATTR_DECODER(attrs) AREF ((attrs), charset_decoder)
278 #define CHARSET_ATTR_ENCODER(attrs) AREF ((attrs), charset_encoder)
279 #define CHARSET_ATTR_SUBSET(attrs) AREF ((attrs), charset_subset)
280 #define CHARSET_ATTR_SUPERSET(attrs) AREF ((attrs), charset_superset)
281 #define CHARSET_ATTR_UNIFY_MAP(attrs) AREF ((attrs), charset_unify_map)
282 #define CHARSET_ATTR_DEUNIFIER(attrs) AREF ((attrs), charset_deunifier)
283
284 #define CHARSET_SYMBOL_ID(symbol) \
285 CHARSET_ATTR_ID (CHARSET_SYMBOL_ATTRIBUTES (symbol))
286
287 /* Return an index to Vcharset_hash_table of the charset whose symbol
288 is SYMBOL. */
289 #define CHARSET_SYMBOL_HASH_INDEX(symbol) \
290 hash_lookup (XHASH_TABLE (Vcharset_hash_table), symbol, NULL)
291
292 /* Return the attribute vector of CHARSET. */
293 #define CHARSET_ATTRIBUTES(charset) \
294 (HASH_VALUE (XHASH_TABLE (Vcharset_hash_table), (charset)->hash_index))
295
296 #define CHARSET_ID(charset) ((charset)->id)
297 #define CHARSET_HASH_INDEX(charset) ((charset)->hash_index)
298 #define CHARSET_DIMENSION(charset) ((charset)->dimension)
299 #define CHARSET_CODE_SPACE(charset) ((charset)->code_space)
300 #define CHARSET_CODE_LINEAR_P(charset) ((charset)->code_linear_p)
301 #define CHARSET_ISO_CHARS_96(charset) ((charset)->iso_chars_96)
302 #define CHARSET_ISO_FINAL(charset) ((charset)->iso_final)
303 #define CHARSET_ISO_PLANE(charset) ((charset)->iso_plane)
304 #define CHARSET_ISO_REVISION(charset) ((charset)->iso_revision)
305 #define CHARSET_EMACS_MULE_ID(charset) ((charset)->emacs_mule_id)
306 #define CHARSET_ASCII_COMPATIBLE_P(charset) ((charset)->ascii_compatible_p)
307 #define CHARSET_COMPACT_CODES_P(charset) ((charset)->compact_codes_p)
308 #define CHARSET_METHOD(charset) ((charset)->method)
309 #define CHARSET_MIN_CODE(charset) ((charset)->min_code)
310 #define CHARSET_MAX_CODE(charset) ((charset)->max_code)
311 #define CHARSET_INVALID_CODE(charset) ((charset)->invalid_code)
312 #define CHARSET_MIN_CHAR(charset) ((charset)->min_char)
313 #define CHARSET_MAX_CHAR(charset) ((charset)->max_char)
314 #define CHARSET_CODE_OFFSET(charset) ((charset)->code_offset)
315 #define CHARSET_UNIFIED_P(charset) ((charset)->unified_p)
316
317 #define CHARSET_NAME(charset) \
318 (CHARSET_ATTR_NAME (CHARSET_ATTRIBUTES (charset)))
319 #define CHARSET_MAP(charset) \
320 (CHARSET_ATTR_MAP (CHARSET_ATTRIBUTES (charset)))
321 #define CHARSET_DECODER(charset) \
322 (CHARSET_ATTR_DECODER (CHARSET_ATTRIBUTES (charset)))
323 #define CHARSET_ENCODER(charset) \
324 (CHARSET_ATTR_ENCODER (CHARSET_ATTRIBUTES (charset)))
325 #define CHARSET_SUBSET(charset) \
326 (CHARSET_ATTR_SUBSET (CHARSET_ATTRIBUTES (charset)))
327 #define CHARSET_SUPERSET(charset) \
328 (CHARSET_ATTR_SUPERSET (CHARSET_ATTRIBUTES (charset)))
329 #define CHARSET_UNIFY_MAP(charset) \
330 (CHARSET_ATTR_UNIFY_MAP (CHARSET_ATTRIBUTES (charset)))
331 #define CHARSET_DEUNIFIER(charset) \
332 (CHARSET_ATTR_DEUNIFIER (CHARSET_ATTRIBUTES (charset)))
333
334
335 /* Nonzero if OBJ is a valid charset symbol. */
336 #define CHARSETP(obj) (CHARSET_SYMBOL_HASH_INDEX (obj) >= 0)
337
338 /* Check if X is a valid charset symbol. If not, signal an error. */
339 #define CHECK_CHARSET(x) \
340 do { \
341 if (! SYMBOLP (x) || CHARSET_SYMBOL_HASH_INDEX (x) < 0) \
342 wrong_type_argument (Qcharsetp, (x)); \
343 } while (0)
344
345
346 /* Check if X is a valid charset symbol. If valid, set ID to the id
347 number of the charset. Otherwise, signal an error. */
348 #define CHECK_CHARSET_GET_ID(x, id) \
349 do { \
350 int idx; \
351 \
352 if (! SYMBOLP (x) || (idx = CHARSET_SYMBOL_HASH_INDEX (x)) < 0) \
353 wrong_type_argument (Qcharsetp, (x)); \
354 id = XINT (AREF (HASH_VALUE (XHASH_TABLE (Vcharset_hash_table), idx), \
355 charset_id)); \
356 } while (0)
357
358
359 /* Check if X is a valid charset symbol. If valid, set ATTR to the
360 attr vector of the charset. Otherwise, signal an error. */
361 #define CHECK_CHARSET_GET_ATTR(x, attr) \
362 do { \
363 if (!SYMBOLP (x) || NILP (attr = CHARSET_SYMBOL_ATTRIBUTES (x))) \
364 wrong_type_argument (Qcharsetp, (x)); \
365 } while (0)
366
367
368 #define CHECK_CHARSET_GET_CHARSET(x, charset) \
369 do { \
370 int id; \
371 CHECK_CHARSET_GET_ID (x, id); \
372 charset = CHARSET_FROM_ID (id); \
373 } while (0)
374
375
376 /* Lookup Vcharset_ordered_list and return the first charset that
377 contains the character C. */
378 #define CHAR_CHARSET(c) \
379 ((c) < 0x80 ? CHARSET_FROM_ID (charset_ascii) \
380 : char_charset ((c), Qnil, NULL))
381
382 #if 0
383 /* Char-table of charset-sets. Each element is a bool vector indexed
384 by a charset ID. */
385 extern Lisp_Object Vchar_charset_set;
386
387 /* Charset-bag of character C. */
388 #define CHAR_CHARSET_SET(c) \
389 CHAR_TABLE_REF (Vchar_charset_set, c)
390
391 /* Check if two characters C1 and C2 belong to the same charset. */
392 #define SAME_CHARSET_P(c1, c2) \
393 intersection_p (CHAR_CHARSET_SET (c1), CHAR_CHARSET_SET (c2))
394
395 #endif
396
397
398 /* Return a character correponding to the code-point CODE of CHARSET.
399 Try some optimization before calling decode_char. */
400
401 #define DECODE_CHAR(charset, code) \
402 ((ASCII_BYTE_P (code) && (charset)->ascii_compatible_p) \
403 ? (code) \
404 : ((code) < (charset)->min_code || (code) > (charset)->max_code) \
405 ? -1 \
406 : (charset)->unified_p \
407 ? decode_char ((charset), (code)) \
408 : (charset)->method == CHARSET_METHOD_OFFSET \
409 ? ((charset)->code_linear_p \
410 ? (code) - (charset)->min_code + (charset)->code_offset \
411 : decode_char ((charset), (code))) \
412 : (charset)->method == CHARSET_METHOD_MAP \
413 ? ((charset)->code_linear_p \
414 ? XINT (AREF (CHARSET_DECODER (charset), \
415 (code) - (charset)->min_code)) \
416 : decode_char ((charset), (code))) \
417 : decode_char ((charset), (code)))
418
419
420 /* If CHARSET is a simple offset base charset, return it's offset,
421 otherwise return -1. */
422 #define CHARSET_OFFSET(charset) \
423 (((charset)->method == CHARSET_METHOD_OFFSET \
424 && (charset)->code_linear_p \
425 && ! (charset)->unified_p) \
426 ? (charset)->code_offset - (charset)->min_code \
427 : -1)
428
429 extern Lisp_Object charset_work;
430
431 /* Return a code point of CHAR in CHARSET.
432 Try some optimization before calling encode_char. */
433
434 #define ENCODE_CHAR(charset, c) \
435 ((ASCII_CHAR_P (c) && (charset)->ascii_compatible_p) \
436 ? (c) \
437 : ((charset)->unified_p \
438 || (charset)->method == CHARSET_METHOD_SUBSET \
439 || (charset)->method == CHARSET_METHOD_SUPERSET) \
440 ? encode_char ((charset), (c)) \
441 : ((c) < (charset)->min_char || (c) > (charset)->max_char) \
442 ? (charset)->invalid_code \
443 : (charset)->method == CHARSET_METHOD_OFFSET \
444 ? ((charset)->code_linear_p \
445 ? (c) - (charset)->code_offset + (charset)->min_code \
446 : encode_char ((charset), (c))) \
447 : (charset)->method == CHARSET_METHOD_MAP \
448 ? ((charset)->compact_codes_p \
449 ? (charset_work = CHAR_TABLE_REF (CHARSET_ENCODER (charset), (c)), \
450 (NILP (charset_work) \
451 ? (charset)->invalid_code \
452 : XFASTINT (charset_work))) \
453 : encode_char ((charset), (c))) \
454 : encode_char ((charset), (c)))
455
456
457 /* Set to 1 when a charset map is loaded to warn that a buffer text
458 and a string data may be relocated. */
459 extern int charset_map_loaded;
460
461
462 /* Set CHARSET to the charset highest priority of C, CODE to the
463 code-point of C in CHARSET. */
464 #define SPLIT_CHAR(c, charset, code) \
465 ((charset) = char_charset ((c), Qnil, &(code)))
466
467
468 #define ISO_MAX_DIMENSION 3
469 #define ISO_MAX_CHARS 2
470 #define ISO_MAX_FINAL 0x80 /* only 0x30..0xFF are used */
471
472 /* Mapping table from ISO2022's charset (specified by DIMENSION,
473 CHARS, and FINAL_CHAR) to Emacs' charset ID. Should be accessed by
474 macro ISO_CHARSET_TABLE (DIMENSION, CHARS, FINAL_CHAR). */
475 extern int iso_charset_table[ISO_MAX_DIMENSION][ISO_MAX_CHARS][ISO_MAX_FINAL];
476
477 /* A charset of type iso2022 who has DIMENSION, CHARS, and FINAL
478 (final character). */
479 #define ISO_CHARSET_TABLE(dimension, chars_96, final) \
480 iso_charset_table[(dimension) - 1][(chars_96)][(final)]
481
482 /* Nonzero if the charset who has FAST_MAP may contain C. */
483 #define CHARSET_FAST_MAP_REF(c, fast_map) \
484 ((c) < 0x10000 \
485 ? fast_map[(c) >> 10] & (1 << (((c) >> 7) & 7)) \
486 : fast_map[((c) >> 15) + 62] & (1 << (((c) >> 12) & 7)))
487
488 #define CHARSET_FAST_MAP_SET(c, fast_map) \
489 do { \
490 if ((c) < 0x10000) \
491 (fast_map)[(c) >> 10] |= 1 << (((c) >> 7) & 7); \
492 else \
493 (fast_map)[((c) >> 15) + 62] |= 1 << (((c) >> 12) & 7); \
494 } while (0)
495
496
497
498 /* 1 if CHARSET may contain the character C. */
499 #define CHAR_CHARSET_P(c, charset) \
500 ((ASCII_CHAR_P (c) && (charset)->ascii_compatible_p) \
501 || ((CHARSET_UNIFIED_P (charset) \
502 || (charset)->method == CHARSET_METHOD_SUBSET \
503 || (charset)->method == CHARSET_METHOD_SUPERSET) \
504 ? encode_char ((charset), (c)) != (charset)->invalid_code \
505 : (CHARSET_FAST_MAP_REF ((c), (charset)->fast_map) \
506 && ((charset)->method == CHARSET_METHOD_OFFSET \
507 ? (c) >= (charset)->min_char && (c) <= (charset)->max_char \
508 : ((charset)->method == CHARSET_METHOD_MAP \
509 && (charset)->compact_codes_p) \
510 ? ! NILP (CHAR_TABLE_REF (CHARSET_ENCODER (charset), (c))) \
511 : encode_char ((charset), (c)) != (charset)->invalid_code))))
512
513 \f
514 /* Special macros for emacs-mule encoding. */
515
516 /* Leading-code followed by extended leading-code. DIMENSION/COLUMN */
517 #define EMACS_MULE_LEADING_CODE_PRIVATE_11 0x9A /* 1/1 */
518 #define EMACS_MULE_LEADING_CODE_PRIVATE_12 0x9B /* 1/2 */
519 #define EMACS_MULE_LEADING_CODE_PRIVATE_21 0x9C /* 2/2 */
520 #define EMACS_MULE_LEADING_CODE_PRIVATE_22 0x9D /* 2/2 */
521
522 extern struct charset *emacs_mule_charset[256];
523
524 \f
525
526 extern Lisp_Object Qcharsetp;
527
528 extern Lisp_Object Qascii, Qunicode;
529 extern int charset_ascii, charset_eight_bit;
530 extern int charset_iso_8859_1;
531 extern int charset_unicode;
532 extern int charset_jisx0201_roman;
533 extern int charset_jisx0208_1978;
534 extern int charset_jisx0208;
535
536 extern int charset_unibyte;
537
538 extern struct charset *char_charset P_ ((int, Lisp_Object, unsigned *));
539 extern Lisp_Object charset_attributes P_ ((int));
540
541 extern int decode_char P_ ((struct charset *, unsigned));
542 extern unsigned encode_char P_ ((struct charset *, int));
543 extern int string_xstring_p P_ ((Lisp_Object));
544
545 extern void map_charset_chars P_ ((void (*) (Lisp_Object, Lisp_Object),
546 Lisp_Object, Lisp_Object,
547 struct charset *, unsigned, unsigned));
548
549 EXFUN (Funify_charset, 3);
550
551 #endif /* EMACS_CHARSET_H */
552
553 /* arch-tag: 3b96db55-4961-481d-ac3e-219f46a2b3aa
554 (do not change this comment) */