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