[HAVE_TERMCAP_H]: Include <termcap.h>.
[emacs.git] / src / coding.c
blob462f88b23cce413a593f3cbaec593fd862144e10
1 /* Coding system handler (conversion, detection, and etc).
2 Copyright (C) 1995, 1997, 1998 Electrotechnical Laboratory, JAPAN.
3 Licensed to the Free Software Foundation.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; 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. */
22 /*** TABLE OF CONTENTS ***
24 0. General comments
25 1. Preamble
26 2. Emacs' internal format (emacs-mule) handlers
27 3. ISO2022 handlers
28 4. Shift-JIS and BIG5 handlers
29 5. CCL handlers
30 6. End-of-line handlers
31 7. C library functions
32 8. Emacs Lisp library functions
33 9. Post-amble
37 /*** 0. General comments ***/
40 /*** GENERAL NOTE on CODING SYSTEM ***
42 Coding system is an encoding mechanism of one or more character
43 sets. Here's a list of coding systems which Emacs can handle. When
44 we say "decode", it means converting some other coding system to
45 Emacs' internal format (emacs-internal), and when we say "encode",
46 it means converting the coding system emacs-mule to some other
47 coding system.
49 0. Emacs' internal format (emacs-mule)
51 Emacs itself holds a multi-lingual character in a buffer and a string
52 in a special format. Details are described in section 2.
54 1. ISO2022
56 The most famous coding system for multiple character sets. X's
57 Compound Text, various EUCs (Extended Unix Code), and coding
58 systems used in Internet communication such as ISO-2022-JP are
59 all variants of ISO2022. Details are described in section 3.
61 2. SJIS (or Shift-JIS or MS-Kanji-Code)
63 A coding system to encode character sets: ASCII, JISX0201, and
64 JISX0208. Widely used for PC's in Japan. Details are described in
65 section 4.
67 3. BIG5
69 A coding system to encode character sets: ASCII and Big5. Widely
70 used by Chinese (mainly in Taiwan and Hong Kong). Details are
71 described in section 4. In this file, when we write "BIG5"
72 (all uppercase), we mean the coding system, and when we write
73 "Big5" (capitalized), we mean the character set.
75 4. Raw text
77 A coding system for a text containing random 8-bit code. Emacs does
78 no code conversion on such a text except for end-of-line format.
80 5. Other
82 If a user wants to read/write a text encoded in a coding system not
83 listed above, he can supply a decoder and an encoder for it in CCL
84 (Code Conversion Language) programs. Emacs executes the CCL program
85 while reading/writing.
87 Emacs represents a coding system by a Lisp symbol that has a property
88 `coding-system'. But, before actually using the coding system, the
89 information about it is set in a structure of type `struct
90 coding_system' for rapid processing. See section 6 for more details.
94 /*** GENERAL NOTES on END-OF-LINE FORMAT ***
96 How end-of-line of a text is encoded depends on a system. For
97 instance, Unix's format is just one byte of `line-feed' code,
98 whereas DOS's format is two-byte sequence of `carriage-return' and
99 `line-feed' codes. MacOS's format is usually one byte of
100 `carriage-return'.
102 Since text characters encoding and end-of-line encoding are
103 independent, any coding system described above can take
104 any format of end-of-line. So, Emacs has information of format of
105 end-of-line in each coding-system. See section 6 for more details.
109 /*** GENERAL NOTES on `detect_coding_XXX ()' functions ***
111 These functions check if a text between SRC and SRC_END is encoded
112 in the coding system category XXX. Each returns an integer value in
113 which appropriate flag bits for the category XXX is set. The flag
114 bits are defined in macros CODING_CATEGORY_MASK_XXX. Below is the
115 template of these functions. */
116 #if 0
118 detect_coding_emacs_mule (src, src_end)
119 unsigned char *src, *src_end;
123 #endif
125 /*** GENERAL NOTES on `decode_coding_XXX ()' functions ***
127 These functions decode SRC_BYTES length of unibyte text at SOURCE
128 encoded in CODING to Emacs' internal format. The resulting
129 multibyte text goes to a place pointed to by DESTINATION, the length
130 of which should not exceed DST_BYTES.
132 These functions set the information of original and decoded texts in
133 the members produced, produced_char, consumed, and consumed_char of
134 the structure *CODING. They also set the member result to one of
135 CODING_FINISH_XXX indicating how the decoding finished.
137 DST_BYTES zero means that source area and destination area are
138 overlapped, which means that we can produce a decoded text until it
139 reaches at the head of not-yet-decoded source text.
141 Below is a template of these functions. */
142 #if 0
143 static void
144 decode_coding_XXX (coding, source, destination, src_bytes, dst_bytes)
145 struct coding_system *coding;
146 unsigned char *source, *destination;
147 int src_bytes, dst_bytes;
151 #endif
153 /*** GENERAL NOTES on `encode_coding_XXX ()' functions ***
155 These functions encode SRC_BYTES length text at SOURCE of Emacs'
156 internal multibyte format to CODING. The resulting unibyte text
157 goes to a place pointed to by DESTINATION, the length of which
158 should not exceed DST_BYTES.
160 These functions set the information of original and encoded texts in
161 the members produced, produced_char, consumed, and consumed_char of
162 the structure *CODING. They also set the member result to one of
163 CODING_FINISH_XXX indicating how the encoding finished.
165 DST_BYTES zero means that source area and destination area are
166 overlapped, which means that we can produce a encoded text until it
167 reaches at the head of not-yet-encoded source text.
169 Below is a template of these functions. */
170 #if 0
171 static void
172 encode_coding_XXX (coding, source, destination, src_bytes, dst_bytes)
173 struct coding_system *coding;
174 unsigned char *source, *destination;
175 int src_bytes, dst_bytes;
179 #endif
181 /*** COMMONLY USED MACROS ***/
183 /* The following two macros ONE_MORE_BYTE and TWO_MORE_BYTES safely
184 get one, two, and three bytes from the source text respectively.
185 If there are not enough bytes in the source, they jump to
186 `label_end_of_loop'. The caller should set variables `coding',
187 `src' and `src_end' to appropriate pointer in advance. These
188 macros are called from decoding routines `decode_coding_XXX', thus
189 it is assumed that the source text is unibyte. */
191 #define ONE_MORE_BYTE(c1) \
192 do { \
193 if (src >= src_end) \
195 coding->result = CODING_FINISH_INSUFFICIENT_SRC; \
196 goto label_end_of_loop; \
198 c1 = *src++; \
199 } while (0)
201 #define TWO_MORE_BYTES(c1, c2) \
202 do { \
203 if (src + 1 >= src_end) \
205 coding->result = CODING_FINISH_INSUFFICIENT_SRC; \
206 goto label_end_of_loop; \
208 c1 = *src++; \
209 c2 = *src++; \
210 } while (0)
213 /* Set C to the next character at the source text pointed by `src'.
214 If there are not enough characters in the source, jump to
215 `label_end_of_loop'. The caller should set variables `coding'
216 `src', `src_end', and `translation_table' to appropriate pointers
217 in advance. This macro is used in encoding routines
218 `encode_coding_XXX', thus it assumes that the source text is in
219 multibyte form except for 8-bit characters. 8-bit characters are
220 in multibyte form if coding->src_multibyte is nonzero, else they
221 are represented by a single byte. */
223 #define ONE_MORE_CHAR(c) \
224 do { \
225 int len = src_end - src; \
226 int bytes; \
227 if (len <= 0) \
229 coding->result = CODING_FINISH_INSUFFICIENT_SRC; \
230 goto label_end_of_loop; \
232 if (coding->src_multibyte \
233 || UNIBYTE_STR_AS_MULTIBYTE_P (src, len, bytes)) \
234 c = STRING_CHAR_AND_LENGTH (src, len, bytes); \
235 else \
236 c = *src, bytes = 1; \
237 if (!NILP (translation_table)) \
238 c = translate_char (translation_table, c, 0, 0, 0); \
239 src += bytes; \
240 } while (0)
243 /* Produce a multibyte form of characater C to `dst'. Jump to
244 `label_end_of_loop' if there's not enough space at `dst'.
246 If we are now in the middle of composition sequence, the decoded
247 character may be ALTCHAR (for the current composition). In that
248 case, the character goes to coding->cmp_data->data instead of
249 `dst'.
251 This macro is used in decoding routines. */
253 #define EMIT_CHAR(c) \
254 do { \
255 if (! COMPOSING_P (coding) \
256 || coding->composing == COMPOSITION_RELATIVE \
257 || coding->composing == COMPOSITION_WITH_RULE) \
259 int bytes = CHAR_BYTES (c); \
260 if ((dst + bytes) > (dst_bytes ? dst_end : src)) \
262 coding->result = CODING_FINISH_INSUFFICIENT_DST; \
263 goto label_end_of_loop; \
265 dst += CHAR_STRING (c, dst); \
266 coding->produced_char++; \
269 if (COMPOSING_P (coding) \
270 && coding->composing != COMPOSITION_RELATIVE) \
272 CODING_ADD_COMPOSITION_COMPONENT (coding, c); \
273 coding->composition_rule_follows \
274 = coding->composing != COMPOSITION_WITH_ALTCHARS; \
276 } while (0)
279 #define EMIT_ONE_BYTE(c) \
280 do { \
281 if (dst >= (dst_bytes ? dst_end : src)) \
283 coding->result = CODING_FINISH_INSUFFICIENT_DST; \
284 goto label_end_of_loop; \
286 *dst++ = c; \
287 } while (0)
289 #define EMIT_TWO_BYTES(c1, c2) \
290 do { \
291 if (dst + 2 > (dst_bytes ? dst_end : src)) \
293 coding->result = CODING_FINISH_INSUFFICIENT_DST; \
294 goto label_end_of_loop; \
296 *dst++ = c1, *dst++ = c2; \
297 } while (0)
299 #define EMIT_BYTES(from, to) \
300 do { \
301 if (dst + (to - from) > (dst_bytes ? dst_end : src)) \
303 coding->result = CODING_FINISH_INSUFFICIENT_DST; \
304 goto label_end_of_loop; \
306 while (from < to) \
307 *dst++ = *from++; \
308 } while (0)
311 /*** 1. Preamble ***/
313 #ifdef emacs
314 #include <config.h>
315 #endif
317 #include <stdio.h>
319 #ifdef emacs
321 #include "lisp.h"
322 #include "buffer.h"
323 #include "charset.h"
324 #include "composite.h"
325 #include "ccl.h"
326 #include "coding.h"
327 #include "window.h"
329 #else /* not emacs */
331 #include "mulelib.h"
333 #endif /* not emacs */
335 Lisp_Object Qcoding_system, Qeol_type;
336 Lisp_Object Qbuffer_file_coding_system;
337 Lisp_Object Qpost_read_conversion, Qpre_write_conversion;
338 Lisp_Object Qno_conversion, Qundecided;
339 Lisp_Object Qcoding_system_history;
340 Lisp_Object Qsafe_chars;
341 Lisp_Object Qvalid_codes;
343 extern Lisp_Object Qinsert_file_contents, Qwrite_region;
344 Lisp_Object Qcall_process, Qcall_process_region, Qprocess_argument;
345 Lisp_Object Qstart_process, Qopen_network_stream;
346 Lisp_Object Qtarget_idx;
348 Lisp_Object Vselect_safe_coding_system_function;
350 /* Mnemonic string for each format of end-of-line. */
351 Lisp_Object eol_mnemonic_unix, eol_mnemonic_dos, eol_mnemonic_mac;
352 /* Mnemonic string to indicate format of end-of-line is not yet
353 decided. */
354 Lisp_Object eol_mnemonic_undecided;
356 /* Format of end-of-line decided by system. This is CODING_EOL_LF on
357 Unix, CODING_EOL_CRLF on DOS/Windows, and CODING_EOL_CR on Mac. */
358 int system_eol_type;
360 #ifdef emacs
362 Lisp_Object Vcoding_system_list, Vcoding_system_alist;
364 Lisp_Object Qcoding_system_p, Qcoding_system_error;
366 /* Coding system emacs-mule and raw-text are for converting only
367 end-of-line format. */
368 Lisp_Object Qemacs_mule, Qraw_text;
370 /* Coding-systems are handed between Emacs Lisp programs and C internal
371 routines by the following three variables. */
372 /* Coding-system for reading files and receiving data from process. */
373 Lisp_Object Vcoding_system_for_read;
374 /* Coding-system for writing files and sending data to process. */
375 Lisp_Object Vcoding_system_for_write;
376 /* Coding-system actually used in the latest I/O. */
377 Lisp_Object Vlast_coding_system_used;
379 /* A vector of length 256 which contains information about special
380 Latin codes (especially for dealing with Microsoft codes). */
381 Lisp_Object Vlatin_extra_code_table;
383 /* Flag to inhibit code conversion of end-of-line format. */
384 int inhibit_eol_conversion;
386 /* Flag to inhibit ISO2022 escape sequence detection. */
387 int inhibit_iso_escape_detection;
389 /* Flag to make buffer-file-coding-system inherit from process-coding. */
390 int inherit_process_coding_system;
392 /* Coding system to be used to encode text for terminal display. */
393 struct coding_system terminal_coding;
395 /* Coding system to be used to encode text for terminal display when
396 terminal coding system is nil. */
397 struct coding_system safe_terminal_coding;
399 /* Coding system of what is sent from terminal keyboard. */
400 struct coding_system keyboard_coding;
402 /* Default coding system to be used to write a file. */
403 struct coding_system default_buffer_file_coding;
405 Lisp_Object Vfile_coding_system_alist;
406 Lisp_Object Vprocess_coding_system_alist;
407 Lisp_Object Vnetwork_coding_system_alist;
409 Lisp_Object Vlocale_coding_system;
411 #endif /* emacs */
413 Lisp_Object Qcoding_category, Qcoding_category_index;
415 /* List of symbols `coding-category-xxx' ordered by priority. */
416 Lisp_Object Vcoding_category_list;
418 /* Table of coding categories (Lisp symbols). */
419 Lisp_Object Vcoding_category_table;
421 /* Table of names of symbol for each coding-category. */
422 char *coding_category_name[CODING_CATEGORY_IDX_MAX] = {
423 "coding-category-emacs-mule",
424 "coding-category-sjis",
425 "coding-category-iso-7",
426 "coding-category-iso-7-tight",
427 "coding-category-iso-8-1",
428 "coding-category-iso-8-2",
429 "coding-category-iso-7-else",
430 "coding-category-iso-8-else",
431 "coding-category-ccl",
432 "coding-category-big5",
433 "coding-category-utf-8",
434 "coding-category-utf-16-be",
435 "coding-category-utf-16-le",
436 "coding-category-raw-text",
437 "coding-category-binary"
440 /* Table of pointers to coding systems corresponding to each coding
441 categories. */
442 struct coding_system *coding_system_table[CODING_CATEGORY_IDX_MAX];
444 /* Table of coding category masks. Nth element is a mask for a coding
445 cateogry of which priority is Nth. */
446 static
447 int coding_priorities[CODING_CATEGORY_IDX_MAX];
449 /* Flag to tell if we look up translation table on character code
450 conversion. */
451 Lisp_Object Venable_character_translation;
452 /* Standard translation table to look up on decoding (reading). */
453 Lisp_Object Vstandard_translation_table_for_decode;
454 /* Standard translation table to look up on encoding (writing). */
455 Lisp_Object Vstandard_translation_table_for_encode;
457 Lisp_Object Qtranslation_table;
458 Lisp_Object Qtranslation_table_id;
459 Lisp_Object Qtranslation_table_for_decode;
460 Lisp_Object Qtranslation_table_for_encode;
462 /* Alist of charsets vs revision number. */
463 Lisp_Object Vcharset_revision_alist;
465 /* Default coding systems used for process I/O. */
466 Lisp_Object Vdefault_process_coding_system;
468 /* Global flag to tell that we can't call post-read-conversion and
469 pre-write-conversion functions. Usually the value is zero, but it
470 is set to 1 temporarily while such functions are running. This is
471 to avoid infinite recursive call. */
472 static int inhibit_pre_post_conversion;
474 /* Char-table containing safe coding systems of each character. */
475 Lisp_Object Vchar_coding_system_table;
476 Lisp_Object Qchar_coding_system;
478 /* Return `safe-chars' property of coding system CODING. Don't check
479 validity of CODING. */
481 Lisp_Object
482 coding_safe_chars (coding)
483 struct coding_system *coding;
485 Lisp_Object coding_spec, plist, safe_chars;
487 coding_spec = Fget (coding->symbol, Qcoding_system);
488 plist = XVECTOR (coding_spec)->contents[3];
489 safe_chars = Fplist_get (XVECTOR (coding_spec)->contents[3], Qsafe_chars);
490 return (CHAR_TABLE_P (safe_chars) ? safe_chars : Qt);
493 #define CODING_SAFE_CHAR_P(safe_chars, c) \
494 (EQ (safe_chars, Qt) || !NILP (CHAR_TABLE_REF (safe_chars, c)))
497 /*** 2. Emacs internal format (emacs-mule) handlers ***/
499 /* Emacs' internal format for encoding multiple character sets is a
500 kind of multi-byte encoding, i.e. characters are encoded by
501 variable-length sequences of one-byte codes.
503 ASCII characters and control characters (e.g. `tab', `newline') are
504 represented by one-byte sequences which are their ASCII codes, in
505 the range 0x00 through 0x7F.
507 8-bit characters of the range 0x80..0x9F are represented by
508 two-byte sequences of LEADING_CODE_8_BIT_CONTROL and (their 8-bit
509 code + 0x20).
511 8-bit characters of the range 0xA0..0xFF are represented by
512 one-byte sequences which are their 8-bit code.
514 The other characters are represented by a sequence of `base
515 leading-code', optional `extended leading-code', and one or two
516 `position-code's. The length of the sequence is determined by the
517 base leading-code. Leading-code takes the range 0x80 through 0x9F,
518 whereas extended leading-code and position-code take the range 0xA0
519 through 0xFF. See `charset.h' for more details about leading-code
520 and position-code.
522 --- CODE RANGE of Emacs' internal format ---
523 character set range
524 ------------- -----
525 ascii 0x00..0x7F
526 eight-bit-control LEADING_CODE_8_BIT_CONTROL + 0xA0..0xBF
527 eight-bit-graphic 0xA0..0xBF
528 ELSE 0x81..0x9F + [0xA0..0xFF]+
529 ---------------------------------------------
533 enum emacs_code_class_type emacs_code_class[256];
535 /* See the above "GENERAL NOTES on `detect_coding_XXX ()' functions".
536 Check if a text is encoded in Emacs' internal format. If it is,
537 return CODING_CATEGORY_MASK_EMACS_MULE, else return 0. */
540 detect_coding_emacs_mule (src, src_end)
541 unsigned char *src, *src_end;
543 unsigned char c;
544 int composing = 0;
545 /* Dummy for ONE_MORE_BYTE. */
546 struct coding_system dummy_coding;
547 struct coding_system *coding = &dummy_coding;
549 while (1)
551 ONE_MORE_BYTE (c);
553 if (composing)
555 if (c < 0xA0)
556 composing = 0;
557 else if (c == 0xA0)
559 ONE_MORE_BYTE (c);
560 c &= 0x7F;
562 else
563 c -= 0x20;
566 if (c < 0x20)
568 if (c == ISO_CODE_ESC || c == ISO_CODE_SI || c == ISO_CODE_SO)
569 return 0;
571 else if (c >= 0x80 && c < 0xA0)
573 if (c == 0x80)
574 /* Old leading code for a composite character. */
575 composing = 1;
576 else
578 unsigned char *src_base = src - 1;
579 int bytes;
581 if (!UNIBYTE_STR_AS_MULTIBYTE_P (src_base, src_end - src_base,
582 bytes))
583 return 0;
584 src = src_base + bytes;
588 label_end_of_loop:
589 return CODING_CATEGORY_MASK_EMACS_MULE;
593 /* See the above "GENERAL NOTES on `decode_coding_XXX ()' functions". */
595 static void
596 decode_coding_emacs_mule (coding, source, destination, src_bytes, dst_bytes)
597 struct coding_system *coding;
598 unsigned char *source, *destination;
599 int src_bytes, dst_bytes;
601 unsigned char *src = source;
602 unsigned char *src_end = source + src_bytes;
603 unsigned char *dst = destination;
604 unsigned char *dst_end = destination + dst_bytes;
605 /* SRC_BASE remembers the start position in source in each loop.
606 The loop will be exited when there's not enough source code, or
607 when there's not enough destination area to produce a
608 character. */
609 unsigned char *src_base;
611 coding->produced_char = 0;
612 while ((src_base = src) < src_end)
614 unsigned char tmp[MAX_MULTIBYTE_LENGTH], *p;
615 int bytes;
617 if (UNIBYTE_STR_AS_MULTIBYTE_P (src, src_end - src, bytes))
619 p = src;
620 src += bytes;
622 else
624 bytes = CHAR_STRING (*src, tmp);
625 p = tmp;
626 src++;
628 if (dst + bytes >= (dst_bytes ? dst_end : src))
630 coding->result = CODING_FINISH_INSUFFICIENT_DST;
631 break;
633 while (bytes--) *dst++ = *p++;
634 coding->produced_char++;
636 coding->consumed = coding->consumed_char = src_base - source;
637 coding->produced = dst - destination;
640 #define encode_coding_emacs_mule(coding, source, destination, src_bytes, dst_bytes) \
641 encode_eol (coding, source, destination, src_bytes, dst_bytes)
645 /*** 3. ISO2022 handlers ***/
647 /* The following note describes the coding system ISO2022 briefly.
648 Since the intention of this note is to help understand the
649 functions in this file, some parts are NOT ACCURATE or OVERLY
650 SIMPLIFIED. For thorough understanding, please refer to the
651 original document of ISO2022.
653 ISO2022 provides many mechanisms to encode several character sets
654 in 7-bit and 8-bit environments. For 7-bite environments, all text
655 is encoded using bytes less than 128. This may make the encoded
656 text a little bit longer, but the text passes more easily through
657 several gateways, some of which strip off MSB (Most Signigant Bit).
659 There are two kinds of character sets: control character set and
660 graphic character set. The former contains control characters such
661 as `newline' and `escape' to provide control functions (control
662 functions are also provided by escape sequences). The latter
663 contains graphic characters such as 'A' and '-'. Emacs recognizes
664 two control character sets and many graphic character sets.
666 Graphic character sets are classified into one of the following
667 four classes, according to the number of bytes (DIMENSION) and
668 number of characters in one dimension (CHARS) of the set:
669 - DIMENSION1_CHARS94
670 - DIMENSION1_CHARS96
671 - DIMENSION2_CHARS94
672 - DIMENSION2_CHARS96
674 In addition, each character set is assigned an identification tag,
675 unique for each set, called "final character" (denoted as <F>
676 hereafter). The <F> of each character set is decided by ECMA(*)
677 when it is registered in ISO. The code range of <F> is 0x30..0x7F
678 (0x30..0x3F are for private use only).
680 Note (*): ECMA = European Computer Manufacturers Association
682 Here are examples of graphic character set [NAME(<F>)]:
683 o DIMENSION1_CHARS94 -- ASCII('B'), right-half-of-JISX0201('I'), ...
684 o DIMENSION1_CHARS96 -- right-half-of-ISO8859-1('A'), ...
685 o DIMENSION2_CHARS94 -- GB2312('A'), JISX0208('B'), ...
686 o DIMENSION2_CHARS96 -- none for the moment
688 A code area (1 byte=8 bits) is divided into 4 areas, C0, GL, C1, and GR.
689 C0 [0x00..0x1F] -- control character plane 0
690 GL [0x20..0x7F] -- graphic character plane 0
691 C1 [0x80..0x9F] -- control character plane 1
692 GR [0xA0..0xFF] -- graphic character plane 1
694 A control character set is directly designated and invoked to C0 or
695 C1 by an escape sequence. The most common case is that:
696 - ISO646's control character set is designated/invoked to C0, and
697 - ISO6429's control character set is designated/invoked to C1,
698 and usually these designations/invocations are omitted in encoded
699 text. In a 7-bit environment, only C0 can be used, and a control
700 character for C1 is encoded by an appropriate escape sequence to
701 fit into the environment. All control characters for C1 are
702 defined to have corresponding escape sequences.
704 A graphic character set is at first designated to one of four
705 graphic registers (G0 through G3), then these graphic registers are
706 invoked to GL or GR. These designations and invocations can be
707 done independently. The most common case is that G0 is invoked to
708 GL, G1 is invoked to GR, and ASCII is designated to G0. Usually
709 these invocations and designations are omitted in encoded text.
710 In a 7-bit environment, only GL can be used.
712 When a graphic character set of CHARS94 is invoked to GL, codes
713 0x20 and 0x7F of the GL area work as control characters SPACE and
714 DEL respectively, and codes 0xA0 and 0xFF of the GR area should not
715 be used.
717 There are two ways of invocation: locking-shift and single-shift.
718 With locking-shift, the invocation lasts until the next different
719 invocation, whereas with single-shift, the invocation affects the
720 following character only and doesn't affect the locking-shift
721 state. Invocations are done by the following control characters or
722 escape sequences:
724 ----------------------------------------------------------------------
725 abbrev function cntrl escape seq description
726 ----------------------------------------------------------------------
727 SI/LS0 (shift-in) 0x0F none invoke G0 into GL
728 SO/LS1 (shift-out) 0x0E none invoke G1 into GL
729 LS2 (locking-shift-2) none ESC 'n' invoke G2 into GL
730 LS3 (locking-shift-3) none ESC 'o' invoke G3 into GL
731 LS1R (locking-shift-1 right) none ESC '~' invoke G1 into GR (*)
732 LS2R (locking-shift-2 right) none ESC '}' invoke G2 into GR (*)
733 LS3R (locking-shift 3 right) none ESC '|' invoke G3 into GR (*)
734 SS2 (single-shift-2) 0x8E ESC 'N' invoke G2 for one char
735 SS3 (single-shift-3) 0x8F ESC 'O' invoke G3 for one char
736 ----------------------------------------------------------------------
737 (*) These are not used by any known coding system.
739 Control characters for these functions are defined by macros
740 ISO_CODE_XXX in `coding.h'.
742 Designations are done by the following escape sequences:
743 ----------------------------------------------------------------------
744 escape sequence description
745 ----------------------------------------------------------------------
746 ESC '(' <F> designate DIMENSION1_CHARS94<F> to G0
747 ESC ')' <F> designate DIMENSION1_CHARS94<F> to G1
748 ESC '*' <F> designate DIMENSION1_CHARS94<F> to G2
749 ESC '+' <F> designate DIMENSION1_CHARS94<F> to G3
750 ESC ',' <F> designate DIMENSION1_CHARS96<F> to G0 (*)
751 ESC '-' <F> designate DIMENSION1_CHARS96<F> to G1
752 ESC '.' <F> designate DIMENSION1_CHARS96<F> to G2
753 ESC '/' <F> designate DIMENSION1_CHARS96<F> to G3
754 ESC '$' '(' <F> designate DIMENSION2_CHARS94<F> to G0 (**)
755 ESC '$' ')' <F> designate DIMENSION2_CHARS94<F> to G1
756 ESC '$' '*' <F> designate DIMENSION2_CHARS94<F> to G2
757 ESC '$' '+' <F> designate DIMENSION2_CHARS94<F> to G3
758 ESC '$' ',' <F> designate DIMENSION2_CHARS96<F> to G0 (*)
759 ESC '$' '-' <F> designate DIMENSION2_CHARS96<F> to G1
760 ESC '$' '.' <F> designate DIMENSION2_CHARS96<F> to G2
761 ESC '$' '/' <F> designate DIMENSION2_CHARS96<F> to G3
762 ----------------------------------------------------------------------
764 In this list, "DIMENSION1_CHARS94<F>" means a graphic character set
765 of dimension 1, chars 94, and final character <F>, etc...
767 Note (*): Although these designations are not allowed in ISO2022,
768 Emacs accepts them on decoding, and produces them on encoding
769 CHARS96 character sets in a coding system which is characterized as
770 7-bit environment, non-locking-shift, and non-single-shift.
772 Note (**): If <F> is '@', 'A', or 'B', the intermediate character
773 '(' can be omitted. We refer to this as "short-form" hereafter.
775 Now you may notice that there are a lot of ways for encoding the
776 same multilingual text in ISO2022. Actually, there exist many
777 coding systems such as Compound Text (used in X11's inter client
778 communication, ISO-2022-JP (used in Japanese internet), ISO-2022-KR
779 (used in Korean internet), EUC (Extended UNIX Code, used in Asian
780 localized platforms), and all of these are variants of ISO2022.
782 In addition to the above, Emacs handles two more kinds of escape
783 sequences: ISO6429's direction specification and Emacs' private
784 sequence for specifying character composition.
786 ISO6429's direction specification takes the following form:
787 o CSI ']' -- end of the current direction
788 o CSI '0' ']' -- end of the current direction
789 o CSI '1' ']' -- start of left-to-right text
790 o CSI '2' ']' -- start of right-to-left text
791 The control character CSI (0x9B: control sequence introducer) is
792 abbreviated to the escape sequence ESC '[' in a 7-bit environment.
794 Character composition specification takes the following form:
795 o ESC '0' -- start relative composition
796 o ESC '1' -- end composition
797 o ESC '2' -- start rule-base composition (*)
798 o ESC '3' -- start relative composition with alternate chars (**)
799 o ESC '4' -- start rule-base composition with alternate chars (**)
800 Since these are not standard escape sequences of any ISO standard,
801 the use of them for these meaning is restricted to Emacs only.
803 (*) This form is used only in Emacs 20.5 and the older versions,
804 but the newer versions can safely decode it.
805 (**) This form is used only in Emacs 21.1 and the newer versions,
806 and the older versions can't decode it.
808 Here's a list of examples usages of these composition escape
809 sequences (categorized by `enum composition_method').
811 COMPOSITION_RELATIVE:
812 ESC 0 CHAR [ CHAR ] ESC 1
813 COMPOSITOIN_WITH_RULE:
814 ESC 2 CHAR [ RULE CHAR ] ESC 1
815 COMPOSITION_WITH_ALTCHARS:
816 ESC 3 ALTCHAR [ ALTCHAR ] ESC 0 CHAR [ CHAR ] ESC 1
817 COMPOSITION_WITH_RULE_ALTCHARS:
818 ESC 4 ALTCHAR [ RULE ALTCHAR ] ESC 0 CHAR [ CHAR ] ESC 1 */
820 enum iso_code_class_type iso_code_class[256];
822 #define CHARSET_OK(idx, charset, c) \
823 (coding_system_table[idx] \
824 && (charset == CHARSET_ASCII \
825 || (safe_chars = coding_safe_chars (coding_system_table[idx]), \
826 CODING_SAFE_CHAR_P (safe_chars, c))) \
827 && (CODING_SPEC_ISO_REQUESTED_DESIGNATION (coding_system_table[idx], \
828 charset) \
829 != CODING_SPEC_ISO_NO_REQUESTED_DESIGNATION))
831 #define SHIFT_OUT_OK(idx) \
832 (CODING_SPEC_ISO_INITIAL_DESIGNATION (coding_system_table[idx], 1) >= 0)
834 /* See the above "GENERAL NOTES on `detect_coding_XXX ()' functions".
835 Check if a text is encoded in ISO2022. If it is, returns an
836 integer in which appropriate flag bits any of:
837 CODING_CATEGORY_MASK_ISO_7
838 CODING_CATEGORY_MASK_ISO_7_TIGHT
839 CODING_CATEGORY_MASK_ISO_8_1
840 CODING_CATEGORY_MASK_ISO_8_2
841 CODING_CATEGORY_MASK_ISO_7_ELSE
842 CODING_CATEGORY_MASK_ISO_8_ELSE
843 are set. If a code which should never appear in ISO2022 is found,
844 returns 0. */
847 detect_coding_iso2022 (src, src_end)
848 unsigned char *src, *src_end;
850 int mask = CODING_CATEGORY_MASK_ISO;
851 int mask_found = 0;
852 int reg[4], shift_out = 0, single_shifting = 0;
853 int c, c1, i, charset;
854 /* Dummy for ONE_MORE_BYTE. */
855 struct coding_system dummy_coding;
856 struct coding_system *coding = &dummy_coding;
857 Lisp_Object safe_chars;
859 reg[0] = CHARSET_ASCII, reg[1] = reg[2] = reg[3] = -1;
860 while (mask && src < src_end)
862 ONE_MORE_BYTE (c);
863 switch (c)
865 case ISO_CODE_ESC:
866 if (inhibit_iso_escape_detection)
867 break;
868 single_shifting = 0;
869 ONE_MORE_BYTE (c);
870 if (c >= '(' && c <= '/')
872 /* Designation sequence for a charset of dimension 1. */
873 ONE_MORE_BYTE (c1);
874 if (c1 < ' ' || c1 >= 0x80
875 || (charset = iso_charset_table[0][c >= ','][c1]) < 0)
876 /* Invalid designation sequence. Just ignore. */
877 break;
878 reg[(c - '(') % 4] = charset;
880 else if (c == '$')
882 /* Designation sequence for a charset of dimension 2. */
883 ONE_MORE_BYTE (c);
884 if (c >= '@' && c <= 'B')
885 /* Designation for JISX0208.1978, GB2312, or JISX0208. */
886 reg[0] = charset = iso_charset_table[1][0][c];
887 else if (c >= '(' && c <= '/')
889 ONE_MORE_BYTE (c1);
890 if (c1 < ' ' || c1 >= 0x80
891 || (charset = iso_charset_table[1][c >= ','][c1]) < 0)
892 /* Invalid designation sequence. Just ignore. */
893 break;
894 reg[(c - '(') % 4] = charset;
896 else
897 /* Invalid designation sequence. Just ignore. */
898 break;
900 else if (c == 'N' || c == 'O')
902 /* ESC <Fe> for SS2 or SS3. */
903 mask &= CODING_CATEGORY_MASK_ISO_7_ELSE;
904 break;
906 else if (c >= '0' && c <= '4')
908 /* ESC <Fp> for start/end composition. */
909 mask_found |= CODING_CATEGORY_MASK_ISO;
910 break;
912 else
913 /* Invalid escape sequence. Just ignore. */
914 break;
916 /* We found a valid designation sequence for CHARSET. */
917 mask &= ~CODING_CATEGORY_MASK_ISO_8BIT;
918 c = MAKE_CHAR (charset, 0, 0);
919 if (CHARSET_OK (CODING_CATEGORY_IDX_ISO_7, charset, c))
920 mask_found |= CODING_CATEGORY_MASK_ISO_7;
921 else
922 mask &= ~CODING_CATEGORY_MASK_ISO_7;
923 if (CHARSET_OK (CODING_CATEGORY_IDX_ISO_7_TIGHT, charset, c))
924 mask_found |= CODING_CATEGORY_MASK_ISO_7_TIGHT;
925 else
926 mask &= ~CODING_CATEGORY_MASK_ISO_7_TIGHT;
927 if (CHARSET_OK (CODING_CATEGORY_IDX_ISO_7_ELSE, charset, c))
928 mask_found |= CODING_CATEGORY_MASK_ISO_7_ELSE;
929 else
930 mask &= ~CODING_CATEGORY_MASK_ISO_7_ELSE;
931 if (CHARSET_OK (CODING_CATEGORY_IDX_ISO_8_ELSE, charset, c))
932 mask_found |= CODING_CATEGORY_MASK_ISO_8_ELSE;
933 else
934 mask &= ~CODING_CATEGORY_MASK_ISO_8_ELSE;
935 break;
937 case ISO_CODE_SO:
938 if (inhibit_iso_escape_detection)
939 break;
940 single_shifting = 0;
941 if (shift_out == 0
942 && (reg[1] >= 0
943 || SHIFT_OUT_OK (CODING_CATEGORY_IDX_ISO_7_ELSE)
944 || SHIFT_OUT_OK (CODING_CATEGORY_IDX_ISO_8_ELSE)))
946 /* Locking shift out. */
947 mask &= ~CODING_CATEGORY_MASK_ISO_7BIT;
948 mask_found |= CODING_CATEGORY_MASK_ISO_SHIFT;
950 break;
952 case ISO_CODE_SI:
953 if (inhibit_iso_escape_detection)
954 break;
955 single_shifting = 0;
956 if (shift_out == 1)
958 /* Locking shift in. */
959 mask &= ~CODING_CATEGORY_MASK_ISO_7BIT;
960 mask_found |= CODING_CATEGORY_MASK_ISO_SHIFT;
962 break;
964 case ISO_CODE_CSI:
965 single_shifting = 0;
966 case ISO_CODE_SS2:
967 case ISO_CODE_SS3:
969 int newmask = CODING_CATEGORY_MASK_ISO_8_ELSE;
971 if (inhibit_iso_escape_detection)
972 break;
973 if (c != ISO_CODE_CSI)
975 if (coding_system_table[CODING_CATEGORY_IDX_ISO_8_1]->flags
976 & CODING_FLAG_ISO_SINGLE_SHIFT)
977 newmask |= CODING_CATEGORY_MASK_ISO_8_1;
978 if (coding_system_table[CODING_CATEGORY_IDX_ISO_8_2]->flags
979 & CODING_FLAG_ISO_SINGLE_SHIFT)
980 newmask |= CODING_CATEGORY_MASK_ISO_8_2;
981 single_shifting = 1;
983 if (VECTORP (Vlatin_extra_code_table)
984 && !NILP (XVECTOR (Vlatin_extra_code_table)->contents[c]))
986 if (coding_system_table[CODING_CATEGORY_IDX_ISO_8_1]->flags
987 & CODING_FLAG_ISO_LATIN_EXTRA)
988 newmask |= CODING_CATEGORY_MASK_ISO_8_1;
989 if (coding_system_table[CODING_CATEGORY_IDX_ISO_8_2]->flags
990 & CODING_FLAG_ISO_LATIN_EXTRA)
991 newmask |= CODING_CATEGORY_MASK_ISO_8_2;
993 mask &= newmask;
994 mask_found |= newmask;
996 break;
998 default:
999 if (c < 0x80)
1001 single_shifting = 0;
1002 break;
1004 else if (c < 0xA0)
1006 single_shifting = 0;
1007 if (VECTORP (Vlatin_extra_code_table)
1008 && !NILP (XVECTOR (Vlatin_extra_code_table)->contents[c]))
1010 int newmask = 0;
1012 if (coding_system_table[CODING_CATEGORY_IDX_ISO_8_1]->flags
1013 & CODING_FLAG_ISO_LATIN_EXTRA)
1014 newmask |= CODING_CATEGORY_MASK_ISO_8_1;
1015 if (coding_system_table[CODING_CATEGORY_IDX_ISO_8_2]->flags
1016 & CODING_FLAG_ISO_LATIN_EXTRA)
1017 newmask |= CODING_CATEGORY_MASK_ISO_8_2;
1018 mask &= newmask;
1019 mask_found |= newmask;
1021 else
1022 return 0;
1024 else
1026 mask &= ~(CODING_CATEGORY_MASK_ISO_7BIT
1027 | CODING_CATEGORY_MASK_ISO_7_ELSE);
1028 mask_found |= CODING_CATEGORY_MASK_ISO_8_1;
1029 /* Check the length of succeeding codes of the range
1030 0xA0..0FF. If the byte length is odd, we exclude
1031 CODING_CATEGORY_MASK_ISO_8_2. We can check this only
1032 when we are not single shifting. */
1033 if (!single_shifting
1034 && mask & CODING_CATEGORY_MASK_ISO_8_2)
1036 int i = 1;
1037 while (src < src_end)
1039 ONE_MORE_BYTE (c);
1040 if (c < 0xA0)
1041 break;
1042 i++;
1045 if (i & 1 && src < src_end)
1046 mask &= ~CODING_CATEGORY_MASK_ISO_8_2;
1047 else
1048 mask_found |= CODING_CATEGORY_MASK_ISO_8_2;
1051 break;
1054 label_end_of_loop:
1055 return (mask & mask_found);
1058 /* Decode a character of which charset is CHARSET, the 1st position
1059 code is C1, the 2nd position code is C2, and return the decoded
1060 character code. If the variable `translation_table' is non-nil,
1061 returned the translated code. */
1063 #define DECODE_ISO_CHARACTER(charset, c1, c2) \
1064 (NILP (translation_table) \
1065 ? MAKE_CHAR (charset, c1, c2) \
1066 : translate_char (translation_table, -1, charset, c1, c2))
1068 /* Set designation state into CODING. */
1069 #define DECODE_DESIGNATION(reg, dimension, chars, final_char) \
1070 do { \
1071 int charset, c; \
1073 if (final_char < '0' || final_char >= 128) \
1074 goto label_invalid_code; \
1075 charset = ISO_CHARSET_TABLE (make_number (dimension), \
1076 make_number (chars), \
1077 make_number (final_char)); \
1078 c = MAKE_CHAR (charset, 0, 0); \
1079 if (charset >= 0 \
1080 && (CODING_SPEC_ISO_REQUESTED_DESIGNATION (coding, charset) == reg \
1081 || CODING_SAFE_CHAR_P (safe_chars, c))) \
1083 if (coding->spec.iso2022.last_invalid_designation_register == 0 \
1084 && reg == 0 \
1085 && charset == CHARSET_ASCII) \
1087 /* We should insert this designation sequence as is so \
1088 that it is surely written back to a file. */ \
1089 coding->spec.iso2022.last_invalid_designation_register = -1; \
1090 goto label_invalid_code; \
1092 coding->spec.iso2022.last_invalid_designation_register = -1; \
1093 if ((coding->mode & CODING_MODE_DIRECTION) \
1094 && CHARSET_REVERSE_CHARSET (charset) >= 0) \
1095 charset = CHARSET_REVERSE_CHARSET (charset); \
1096 CODING_SPEC_ISO_DESIGNATION (coding, reg) = charset; \
1098 else \
1100 coding->spec.iso2022.last_invalid_designation_register = reg; \
1101 goto label_invalid_code; \
1103 } while (0)
1105 /* Allocate a memory block for storing information about compositions.
1106 The block is chained to the already allocated blocks. */
1108 void
1109 coding_allocate_composition_data (coding, char_offset)
1110 struct coding_system *coding;
1111 int char_offset;
1113 struct composition_data *cmp_data
1114 = (struct composition_data *) xmalloc (sizeof *cmp_data);
1116 cmp_data->char_offset = char_offset;
1117 cmp_data->used = 0;
1118 cmp_data->prev = coding->cmp_data;
1119 cmp_data->next = NULL;
1120 if (coding->cmp_data)
1121 coding->cmp_data->next = cmp_data;
1122 coding->cmp_data = cmp_data;
1123 coding->cmp_data_start = 0;
1126 /* Record the starting position START and METHOD of one composition. */
1128 #define CODING_ADD_COMPOSITION_START(coding, start, method) \
1129 do { \
1130 struct composition_data *cmp_data = coding->cmp_data; \
1131 int *data = cmp_data->data + cmp_data->used; \
1132 coding->cmp_data_start = cmp_data->used; \
1133 data[0] = -1; \
1134 data[1] = cmp_data->char_offset + start; \
1135 data[3] = (int) method; \
1136 cmp_data->used += 4; \
1137 } while (0)
1139 /* Record the ending position END of the current composition. */
1141 #define CODING_ADD_COMPOSITION_END(coding, end) \
1142 do { \
1143 struct composition_data *cmp_data = coding->cmp_data; \
1144 int *data = cmp_data->data + coding->cmp_data_start; \
1145 data[0] = cmp_data->used - coding->cmp_data_start; \
1146 data[2] = cmp_data->char_offset + end; \
1147 } while (0)
1149 /* Record one COMPONENT (alternate character or composition rule). */
1151 #define CODING_ADD_COMPOSITION_COMPONENT(coding, component) \
1152 (coding->cmp_data->data[coding->cmp_data->used++] = component)
1154 /* Handle compositoin start sequence ESC 0, ESC 2, ESC 3, or ESC 4. */
1156 #define DECODE_COMPOSITION_START(c1) \
1157 do { \
1158 if (coding->composing == COMPOSITION_DISABLED) \
1160 *dst++ = ISO_CODE_ESC; \
1161 *dst++ = c1 & 0x7f; \
1162 coding->produced_char += 2; \
1164 else if (!COMPOSING_P (coding)) \
1166 /* This is surely the start of a composition. We must be sure \
1167 that coding->cmp_data has enough space to store the \
1168 information about the composition. If not, terminate the \
1169 current decoding loop, allocate one more memory block for \
1170 coding->cmp_data in the calller, then start the decoding \
1171 loop again. We can't allocate memory here directly because \
1172 it may cause buffer/string relocation. */ \
1173 if (!coding->cmp_data \
1174 || (coding->cmp_data->used + COMPOSITION_DATA_MAX_BUNCH_LENGTH \
1175 >= COMPOSITION_DATA_SIZE)) \
1177 coding->result = CODING_FINISH_INSUFFICIENT_CMP; \
1178 goto label_end_of_loop; \
1180 coding->composing = (c1 == '0' ? COMPOSITION_RELATIVE \
1181 : c1 == '2' ? COMPOSITION_WITH_RULE \
1182 : c1 == '3' ? COMPOSITION_WITH_ALTCHARS \
1183 : COMPOSITION_WITH_RULE_ALTCHARS); \
1184 CODING_ADD_COMPOSITION_START (coding, coding->produced_char, \
1185 coding->composing); \
1186 coding->composition_rule_follows = 0; \
1188 else \
1190 /* We are already handling a composition. If the method is \
1191 the following two, the codes following the current escape \
1192 sequence are actual characters stored in a buffer. */ \
1193 if (coding->composing == COMPOSITION_WITH_ALTCHARS \
1194 || coding->composing == COMPOSITION_WITH_RULE_ALTCHARS) \
1196 coding->composing = COMPOSITION_RELATIVE; \
1197 coding->composition_rule_follows = 0; \
1200 } while (0)
1202 /* Handle compositoin end sequence ESC 1. */
1204 #define DECODE_COMPOSITION_END(c1) \
1205 do { \
1206 if (coding->composing == COMPOSITION_DISABLED) \
1208 *dst++ = ISO_CODE_ESC; \
1209 *dst++ = c1; \
1210 coding->produced_char += 2; \
1212 else \
1214 CODING_ADD_COMPOSITION_END (coding, coding->produced_char); \
1215 coding->composing = COMPOSITION_NO; \
1217 } while (0)
1219 /* Decode a composition rule from the byte C1 (and maybe one more byte
1220 from SRC) and store one encoded composition rule in
1221 coding->cmp_data. */
1223 #define DECODE_COMPOSITION_RULE(c1) \
1224 do { \
1225 int rule = 0; \
1226 (c1) -= 32; \
1227 if (c1 < 81) /* old format (before ver.21) */ \
1229 int gref = (c1) / 9; \
1230 int nref = (c1) % 9; \
1231 if (gref == 4) gref = 10; \
1232 if (nref == 4) nref = 10; \
1233 rule = COMPOSITION_ENCODE_RULE (gref, nref); \
1235 else if (c1 < 93) /* new format (after ver.21) */ \
1237 ONE_MORE_BYTE (c2); \
1238 rule = COMPOSITION_ENCODE_RULE (c1 - 81, c2 - 32); \
1240 CODING_ADD_COMPOSITION_COMPONENT (coding, rule); \
1241 coding->composition_rule_follows = 0; \
1242 } while (0)
1245 /* See the above "GENERAL NOTES on `decode_coding_XXX ()' functions". */
1247 static void
1248 decode_coding_iso2022 (coding, source, destination, src_bytes, dst_bytes)
1249 struct coding_system *coding;
1250 unsigned char *source, *destination;
1251 int src_bytes, dst_bytes;
1253 unsigned char *src = source;
1254 unsigned char *src_end = source + src_bytes;
1255 unsigned char *dst = destination;
1256 unsigned char *dst_end = destination + dst_bytes;
1257 /* Charsets invoked to graphic plane 0 and 1 respectively. */
1258 int charset0 = CODING_SPEC_ISO_PLANE_CHARSET (coding, 0);
1259 int charset1 = CODING_SPEC_ISO_PLANE_CHARSET (coding, 1);
1260 /* SRC_BASE remembers the start position in source in each loop.
1261 The loop will be exited when there's not enough source code
1262 (within macro ONE_MORE_BYTE), or when there's not enough
1263 destination area to produce a character (within macro
1264 EMIT_CHAR). */
1265 unsigned char *src_base;
1266 int c, charset;
1267 Lisp_Object translation_table;
1268 Lisp_Object safe_chars;
1270 safe_chars = coding_safe_chars (coding);
1272 if (NILP (Venable_character_translation))
1273 translation_table = Qnil;
1274 else
1276 translation_table = coding->translation_table_for_decode;
1277 if (NILP (translation_table))
1278 translation_table = Vstandard_translation_table_for_decode;
1281 coding->result = CODING_FINISH_NORMAL;
1283 while (1)
1285 int c1, c2;
1287 src_base = src;
1288 ONE_MORE_BYTE (c1);
1290 /* We produce no character or one character. */
1291 switch (iso_code_class [c1])
1293 case ISO_0x20_or_0x7F:
1294 if (COMPOSING_P (coding) && coding->composition_rule_follows)
1296 DECODE_COMPOSITION_RULE (c1);
1297 continue;
1299 if (charset0 < 0 || CHARSET_CHARS (charset0) == 94)
1301 /* This is SPACE or DEL. */
1302 charset = CHARSET_ASCII;
1303 break;
1305 /* This is a graphic character, we fall down ... */
1307 case ISO_graphic_plane_0:
1308 if (COMPOSING_P (coding) && coding->composition_rule_follows)
1310 DECODE_COMPOSITION_RULE (c1);
1311 continue;
1313 charset = charset0;
1314 break;
1316 case ISO_0xA0_or_0xFF:
1317 if (charset1 < 0 || CHARSET_CHARS (charset1) == 94
1318 || coding->flags & CODING_FLAG_ISO_SEVEN_BITS)
1319 goto label_invalid_code;
1320 /* This is a graphic character, we fall down ... */
1322 case ISO_graphic_plane_1:
1323 if (charset1 < 0)
1324 goto label_invalid_code;
1325 charset = charset1;
1326 break;
1328 case ISO_control_0:
1329 if (COMPOSING_P (coding))
1330 DECODE_COMPOSITION_END ('1');
1332 /* All ISO2022 control characters in this class have the
1333 same representation in Emacs internal format. */
1334 if (c1 == '\n'
1335 && (coding->mode & CODING_MODE_INHIBIT_INCONSISTENT_EOL)
1336 && (coding->eol_type == CODING_EOL_CR
1337 || coding->eol_type == CODING_EOL_CRLF))
1339 coding->result = CODING_FINISH_INCONSISTENT_EOL;
1340 goto label_end_of_loop;
1342 charset = CHARSET_ASCII;
1343 break;
1345 case ISO_control_1:
1346 if (COMPOSING_P (coding))
1347 DECODE_COMPOSITION_END ('1');
1348 goto label_invalid_code;
1350 case ISO_carriage_return:
1351 if (COMPOSING_P (coding))
1352 DECODE_COMPOSITION_END ('1');
1354 if (coding->eol_type == CODING_EOL_CR)
1355 c1 = '\n';
1356 else if (coding->eol_type == CODING_EOL_CRLF)
1358 ONE_MORE_BYTE (c1);
1359 if (c1 != ISO_CODE_LF)
1361 if (coding->mode & CODING_MODE_INHIBIT_INCONSISTENT_EOL)
1363 coding->result = CODING_FINISH_INCONSISTENT_EOL;
1364 goto label_end_of_loop;
1366 src--;
1367 c1 = '\r';
1370 charset = CHARSET_ASCII;
1371 break;
1373 case ISO_shift_out:
1374 if (! (coding->flags & CODING_FLAG_ISO_LOCKING_SHIFT)
1375 || CODING_SPEC_ISO_DESIGNATION (coding, 1) < 0)
1376 goto label_invalid_code;
1377 CODING_SPEC_ISO_INVOCATION (coding, 0) = 1;
1378 charset0 = CODING_SPEC_ISO_PLANE_CHARSET (coding, 0);
1379 continue;
1381 case ISO_shift_in:
1382 if (! (coding->flags & CODING_FLAG_ISO_LOCKING_SHIFT))
1383 goto label_invalid_code;
1384 CODING_SPEC_ISO_INVOCATION (coding, 0) = 0;
1385 charset0 = CODING_SPEC_ISO_PLANE_CHARSET (coding, 0);
1386 continue;
1388 case ISO_single_shift_2_7:
1389 case ISO_single_shift_2:
1390 if (! (coding->flags & CODING_FLAG_ISO_SINGLE_SHIFT))
1391 goto label_invalid_code;
1392 /* SS2 is handled as an escape sequence of ESC 'N' */
1393 c1 = 'N';
1394 goto label_escape_sequence;
1396 case ISO_single_shift_3:
1397 if (! (coding->flags & CODING_FLAG_ISO_SINGLE_SHIFT))
1398 goto label_invalid_code;
1399 /* SS2 is handled as an escape sequence of ESC 'O' */
1400 c1 = 'O';
1401 goto label_escape_sequence;
1403 case ISO_control_sequence_introducer:
1404 /* CSI is handled as an escape sequence of ESC '[' ... */
1405 c1 = '[';
1406 goto label_escape_sequence;
1408 case ISO_escape:
1409 ONE_MORE_BYTE (c1);
1410 label_escape_sequence:
1411 /* Escape sequences handled by Emacs are invocation,
1412 designation, direction specification, and character
1413 composition specification. */
1414 switch (c1)
1416 case '&': /* revision of following character set */
1417 ONE_MORE_BYTE (c1);
1418 if (!(c1 >= '@' && c1 <= '~'))
1419 goto label_invalid_code;
1420 ONE_MORE_BYTE (c1);
1421 if (c1 != ISO_CODE_ESC)
1422 goto label_invalid_code;
1423 ONE_MORE_BYTE (c1);
1424 goto label_escape_sequence;
1426 case '$': /* designation of 2-byte character set */
1427 if (! (coding->flags & CODING_FLAG_ISO_DESIGNATION))
1428 goto label_invalid_code;
1429 ONE_MORE_BYTE (c1);
1430 if (c1 >= '@' && c1 <= 'B')
1431 { /* designation of JISX0208.1978, GB2312.1980,
1432 or JISX0208.1980 */
1433 DECODE_DESIGNATION (0, 2, 94, c1);
1435 else if (c1 >= 0x28 && c1 <= 0x2B)
1436 { /* designation of DIMENSION2_CHARS94 character set */
1437 ONE_MORE_BYTE (c2);
1438 DECODE_DESIGNATION (c1 - 0x28, 2, 94, c2);
1440 else if (c1 >= 0x2C && c1 <= 0x2F)
1441 { /* designation of DIMENSION2_CHARS96 character set */
1442 ONE_MORE_BYTE (c2);
1443 DECODE_DESIGNATION (c1 - 0x2C, 2, 96, c2);
1445 else
1446 goto label_invalid_code;
1447 /* We must update these variables now. */
1448 charset0 = CODING_SPEC_ISO_PLANE_CHARSET (coding, 0);
1449 charset1 = CODING_SPEC_ISO_PLANE_CHARSET (coding, 1);
1450 continue;
1452 case 'n': /* invocation of locking-shift-2 */
1453 if (! (coding->flags & CODING_FLAG_ISO_LOCKING_SHIFT)
1454 || CODING_SPEC_ISO_DESIGNATION (coding, 2) < 0)
1455 goto label_invalid_code;
1456 CODING_SPEC_ISO_INVOCATION (coding, 0) = 2;
1457 charset0 = CODING_SPEC_ISO_PLANE_CHARSET (coding, 0);
1458 continue;
1460 case 'o': /* invocation of locking-shift-3 */
1461 if (! (coding->flags & CODING_FLAG_ISO_LOCKING_SHIFT)
1462 || CODING_SPEC_ISO_DESIGNATION (coding, 3) < 0)
1463 goto label_invalid_code;
1464 CODING_SPEC_ISO_INVOCATION (coding, 0) = 3;
1465 charset0 = CODING_SPEC_ISO_PLANE_CHARSET (coding, 0);
1466 continue;
1468 case 'N': /* invocation of single-shift-2 */
1469 if (! (coding->flags & CODING_FLAG_ISO_SINGLE_SHIFT)
1470 || CODING_SPEC_ISO_DESIGNATION (coding, 2) < 0)
1471 goto label_invalid_code;
1472 charset = CODING_SPEC_ISO_DESIGNATION (coding, 2);
1473 ONE_MORE_BYTE (c1);
1474 if (c1 < 0x20 || (c1 >= 0x80 && c1 < 0xA0))
1475 goto label_invalid_code;
1476 break;
1478 case 'O': /* invocation of single-shift-3 */
1479 if (! (coding->flags & CODING_FLAG_ISO_SINGLE_SHIFT)
1480 || CODING_SPEC_ISO_DESIGNATION (coding, 3) < 0)
1481 goto label_invalid_code;
1482 charset = CODING_SPEC_ISO_DESIGNATION (coding, 3);
1483 ONE_MORE_BYTE (c1);
1484 if (c1 < 0x20 || (c1 >= 0x80 && c1 < 0xA0))
1485 goto label_invalid_code;
1486 break;
1488 case '0': case '2': case '3': case '4': /* start composition */
1489 DECODE_COMPOSITION_START (c1);
1490 continue;
1492 case '1': /* end composition */
1493 DECODE_COMPOSITION_END (c1);
1494 continue;
1496 case '[': /* specification of direction */
1497 if (coding->flags & CODING_FLAG_ISO_NO_DIRECTION)
1498 goto label_invalid_code;
1499 /* For the moment, nested direction is not supported.
1500 So, `coding->mode & CODING_MODE_DIRECTION' zero means
1501 left-to-right, and nozero means right-to-left. */
1502 ONE_MORE_BYTE (c1);
1503 switch (c1)
1505 case ']': /* end of the current direction */
1506 coding->mode &= ~CODING_MODE_DIRECTION;
1508 case '0': /* end of the current direction */
1509 case '1': /* start of left-to-right direction */
1510 ONE_MORE_BYTE (c1);
1511 if (c1 == ']')
1512 coding->mode &= ~CODING_MODE_DIRECTION;
1513 else
1514 goto label_invalid_code;
1515 break;
1517 case '2': /* start of right-to-left direction */
1518 ONE_MORE_BYTE (c1);
1519 if (c1 == ']')
1520 coding->mode |= CODING_MODE_DIRECTION;
1521 else
1522 goto label_invalid_code;
1523 break;
1525 default:
1526 goto label_invalid_code;
1528 continue;
1530 default:
1531 if (! (coding->flags & CODING_FLAG_ISO_DESIGNATION))
1532 goto label_invalid_code;
1533 if (c1 >= 0x28 && c1 <= 0x2B)
1534 { /* designation of DIMENSION1_CHARS94 character set */
1535 ONE_MORE_BYTE (c2);
1536 DECODE_DESIGNATION (c1 - 0x28, 1, 94, c2);
1538 else if (c1 >= 0x2C && c1 <= 0x2F)
1539 { /* designation of DIMENSION1_CHARS96 character set */
1540 ONE_MORE_BYTE (c2);
1541 DECODE_DESIGNATION (c1 - 0x2C, 1, 96, c2);
1543 else
1544 goto label_invalid_code;
1545 /* We must update these variables now. */
1546 charset0 = CODING_SPEC_ISO_PLANE_CHARSET (coding, 0);
1547 charset1 = CODING_SPEC_ISO_PLANE_CHARSET (coding, 1);
1548 continue;
1552 /* Now we know CHARSET and 1st position code C1 of a character.
1553 Produce a multibyte sequence for that character while getting
1554 2nd position code C2 if necessary. */
1555 if (CHARSET_DIMENSION (charset) == 2)
1557 ONE_MORE_BYTE (c2);
1558 if (c1 < 0x80 ? c2 < 0x20 || c2 >= 0x80 : c2 < 0xA0)
1559 /* C2 is not in a valid range. */
1560 goto label_invalid_code;
1562 c = DECODE_ISO_CHARACTER (charset, c1, c2);
1563 EMIT_CHAR (c);
1564 continue;
1566 label_invalid_code:
1567 coding->errors++;
1568 if (COMPOSING_P (coding))
1569 DECODE_COMPOSITION_END ('1');
1570 src = src_base;
1571 c = *src++;
1572 EMIT_CHAR (c);
1575 label_end_of_loop:
1576 coding->consumed = coding->consumed_char = src_base - source;
1577 coding->produced = dst - destination;
1578 return;
1582 /* ISO2022 encoding stuff. */
1585 It is not enough to say just "ISO2022" on encoding, we have to
1586 specify more details. In Emacs, each coding system of ISO2022
1587 variant has the following specifications:
1588 1. Initial designation to G0 thru G3.
1589 2. Allows short-form designation?
1590 3. ASCII should be designated to G0 before control characters?
1591 4. ASCII should be designated to G0 at end of line?
1592 5. 7-bit environment or 8-bit environment?
1593 6. Use locking-shift?
1594 7. Use Single-shift?
1595 And the following two are only for Japanese:
1596 8. Use ASCII in place of JIS0201-1976-Roman?
1597 9. Use JISX0208-1983 in place of JISX0208-1978?
1598 These specifications are encoded in `coding->flags' as flag bits
1599 defined by macros CODING_FLAG_ISO_XXX. See `coding.h' for more
1600 details.
1603 /* Produce codes (escape sequence) for designating CHARSET to graphic
1604 register REG at DST, and increment DST. If <final-char> of CHARSET is
1605 '@', 'A', or 'B' and the coding system CODING allows, produce
1606 designation sequence of short-form. */
1608 #define ENCODE_DESIGNATION(charset, reg, coding) \
1609 do { \
1610 unsigned char final_char = CHARSET_ISO_FINAL_CHAR (charset); \
1611 char *intermediate_char_94 = "()*+"; \
1612 char *intermediate_char_96 = ",-./"; \
1613 int revision = CODING_SPEC_ISO_REVISION_NUMBER(coding, charset); \
1615 if (revision < 255) \
1617 *dst++ = ISO_CODE_ESC; \
1618 *dst++ = '&'; \
1619 *dst++ = '@' + revision; \
1621 *dst++ = ISO_CODE_ESC; \
1622 if (CHARSET_DIMENSION (charset) == 1) \
1624 if (CHARSET_CHARS (charset) == 94) \
1625 *dst++ = (unsigned char) (intermediate_char_94[reg]); \
1626 else \
1627 *dst++ = (unsigned char) (intermediate_char_96[reg]); \
1629 else \
1631 *dst++ = '$'; \
1632 if (CHARSET_CHARS (charset) == 94) \
1634 if (! (coding->flags & CODING_FLAG_ISO_SHORT_FORM) \
1635 || reg != 0 \
1636 || final_char < '@' || final_char > 'B') \
1637 *dst++ = (unsigned char) (intermediate_char_94[reg]); \
1639 else \
1640 *dst++ = (unsigned char) (intermediate_char_96[reg]); \
1642 *dst++ = final_char; \
1643 CODING_SPEC_ISO_DESIGNATION (coding, reg) = charset; \
1644 } while (0)
1646 /* The following two macros produce codes (control character or escape
1647 sequence) for ISO2022 single-shift functions (single-shift-2 and
1648 single-shift-3). */
1650 #define ENCODE_SINGLE_SHIFT_2 \
1651 do { \
1652 if (coding->flags & CODING_FLAG_ISO_SEVEN_BITS) \
1653 *dst++ = ISO_CODE_ESC, *dst++ = 'N'; \
1654 else \
1655 *dst++ = ISO_CODE_SS2; \
1656 CODING_SPEC_ISO_SINGLE_SHIFTING (coding) = 1; \
1657 } while (0)
1659 #define ENCODE_SINGLE_SHIFT_3 \
1660 do { \
1661 if (coding->flags & CODING_FLAG_ISO_SEVEN_BITS) \
1662 *dst++ = ISO_CODE_ESC, *dst++ = 'O'; \
1663 else \
1664 *dst++ = ISO_CODE_SS3; \
1665 CODING_SPEC_ISO_SINGLE_SHIFTING (coding) = 1; \
1666 } while (0)
1668 /* The following four macros produce codes (control character or
1669 escape sequence) for ISO2022 locking-shift functions (shift-in,
1670 shift-out, locking-shift-2, and locking-shift-3). */
1672 #define ENCODE_SHIFT_IN \
1673 do { \
1674 *dst++ = ISO_CODE_SI; \
1675 CODING_SPEC_ISO_INVOCATION (coding, 0) = 0; \
1676 } while (0)
1678 #define ENCODE_SHIFT_OUT \
1679 do { \
1680 *dst++ = ISO_CODE_SO; \
1681 CODING_SPEC_ISO_INVOCATION (coding, 0) = 1; \
1682 } while (0)
1684 #define ENCODE_LOCKING_SHIFT_2 \
1685 do { \
1686 *dst++ = ISO_CODE_ESC, *dst++ = 'n'; \
1687 CODING_SPEC_ISO_INVOCATION (coding, 0) = 2; \
1688 } while (0)
1690 #define ENCODE_LOCKING_SHIFT_3 \
1691 do { \
1692 *dst++ = ISO_CODE_ESC, *dst++ = 'o'; \
1693 CODING_SPEC_ISO_INVOCATION (coding, 0) = 3; \
1694 } while (0)
1696 /* Produce codes for a DIMENSION1 character whose character set is
1697 CHARSET and whose position-code is C1. Designation and invocation
1698 sequences are also produced in advance if necessary. */
1700 #define ENCODE_ISO_CHARACTER_DIMENSION1(charset, c1) \
1701 do { \
1702 if (CODING_SPEC_ISO_SINGLE_SHIFTING (coding)) \
1704 if (coding->flags & CODING_FLAG_ISO_SEVEN_BITS) \
1705 *dst++ = c1 & 0x7F; \
1706 else \
1707 *dst++ = c1 | 0x80; \
1708 CODING_SPEC_ISO_SINGLE_SHIFTING (coding) = 0; \
1709 break; \
1711 else if (charset == CODING_SPEC_ISO_PLANE_CHARSET (coding, 0)) \
1713 *dst++ = c1 & 0x7F; \
1714 break; \
1716 else if (charset == CODING_SPEC_ISO_PLANE_CHARSET (coding, 1)) \
1718 *dst++ = c1 | 0x80; \
1719 break; \
1721 else \
1722 /* Since CHARSET is not yet invoked to any graphic planes, we \
1723 must invoke it, or, at first, designate it to some graphic \
1724 register. Then repeat the loop to actually produce the \
1725 character. */ \
1726 dst = encode_invocation_designation (charset, coding, dst); \
1727 } while (1)
1729 /* Produce codes for a DIMENSION2 character whose character set is
1730 CHARSET and whose position-codes are C1 and C2. Designation and
1731 invocation codes are also produced in advance if necessary. */
1733 #define ENCODE_ISO_CHARACTER_DIMENSION2(charset, c1, c2) \
1734 do { \
1735 if (CODING_SPEC_ISO_SINGLE_SHIFTING (coding)) \
1737 if (coding->flags & CODING_FLAG_ISO_SEVEN_BITS) \
1738 *dst++ = c1 & 0x7F, *dst++ = c2 & 0x7F; \
1739 else \
1740 *dst++ = c1 | 0x80, *dst++ = c2 | 0x80; \
1741 CODING_SPEC_ISO_SINGLE_SHIFTING (coding) = 0; \
1742 break; \
1744 else if (charset == CODING_SPEC_ISO_PLANE_CHARSET (coding, 0)) \
1746 *dst++ = c1 & 0x7F, *dst++= c2 & 0x7F; \
1747 break; \
1749 else if (charset == CODING_SPEC_ISO_PLANE_CHARSET (coding, 1)) \
1751 *dst++ = c1 | 0x80, *dst++= c2 | 0x80; \
1752 break; \
1754 else \
1755 /* Since CHARSET is not yet invoked to any graphic planes, we \
1756 must invoke it, or, at first, designate it to some graphic \
1757 register. Then repeat the loop to actually produce the \
1758 character. */ \
1759 dst = encode_invocation_designation (charset, coding, dst); \
1760 } while (1)
1762 #define ENCODE_ISO_CHARACTER(c) \
1763 do { \
1764 int charset, c1, c2; \
1766 SPLIT_CHAR (c, charset, c1, c2); \
1767 if (CHARSET_DEFINED_P (charset)) \
1769 if (CHARSET_DIMENSION (charset) == 1) \
1771 if (charset == CHARSET_ASCII \
1772 && coding->flags & CODING_FLAG_ISO_USE_ROMAN) \
1773 charset = charset_latin_jisx0201; \
1774 ENCODE_ISO_CHARACTER_DIMENSION1 (charset, c1); \
1776 else \
1778 if (charset == charset_jisx0208 \
1779 && coding->flags & CODING_FLAG_ISO_USE_OLDJIS) \
1780 charset = charset_jisx0208_1978; \
1781 ENCODE_ISO_CHARACTER_DIMENSION2 (charset, c1, c2); \
1784 else \
1786 *dst++ = c1; \
1787 if (c2 >= 0) \
1788 *dst++ = c2; \
1790 } while (0)
1793 /* Instead of encoding character C, produce one or two `?'s. */
1795 #define ENCODE_UNSAFE_CHARACTER(c) \
1796 do { \
1797 ENCODE_ISO_CHARACTER (CODING_INHIBIT_CHARACTER_SUBSTITUTION); \
1798 if (CHARSET_WIDTH (CHAR_CHARSET (c)) > 1) \
1799 ENCODE_ISO_CHARACTER (CODING_INHIBIT_CHARACTER_SUBSTITUTION); \
1800 } while (0)
1803 /* Produce designation and invocation codes at a place pointed by DST
1804 to use CHARSET. The element `spec.iso2022' of *CODING is updated.
1805 Return new DST. */
1807 unsigned char *
1808 encode_invocation_designation (charset, coding, dst)
1809 int charset;
1810 struct coding_system *coding;
1811 unsigned char *dst;
1813 int reg; /* graphic register number */
1815 /* At first, check designations. */
1816 for (reg = 0; reg < 4; reg++)
1817 if (charset == CODING_SPEC_ISO_DESIGNATION (coding, reg))
1818 break;
1820 if (reg >= 4)
1822 /* CHARSET is not yet designated to any graphic registers. */
1823 /* At first check the requested designation. */
1824 reg = CODING_SPEC_ISO_REQUESTED_DESIGNATION (coding, charset);
1825 if (reg == CODING_SPEC_ISO_NO_REQUESTED_DESIGNATION)
1826 /* Since CHARSET requests no special designation, designate it
1827 to graphic register 0. */
1828 reg = 0;
1830 ENCODE_DESIGNATION (charset, reg, coding);
1833 if (CODING_SPEC_ISO_INVOCATION (coding, 0) != reg
1834 && CODING_SPEC_ISO_INVOCATION (coding, 1) != reg)
1836 /* Since the graphic register REG is not invoked to any graphic
1837 planes, invoke it to graphic plane 0. */
1838 switch (reg)
1840 case 0: /* graphic register 0 */
1841 ENCODE_SHIFT_IN;
1842 break;
1844 case 1: /* graphic register 1 */
1845 ENCODE_SHIFT_OUT;
1846 break;
1848 case 2: /* graphic register 2 */
1849 if (coding->flags & CODING_FLAG_ISO_SINGLE_SHIFT)
1850 ENCODE_SINGLE_SHIFT_2;
1851 else
1852 ENCODE_LOCKING_SHIFT_2;
1853 break;
1855 case 3: /* graphic register 3 */
1856 if (coding->flags & CODING_FLAG_ISO_SINGLE_SHIFT)
1857 ENCODE_SINGLE_SHIFT_3;
1858 else
1859 ENCODE_LOCKING_SHIFT_3;
1860 break;
1864 return dst;
1867 /* Produce 2-byte codes for encoded composition rule RULE. */
1869 #define ENCODE_COMPOSITION_RULE(rule) \
1870 do { \
1871 int gref, nref; \
1872 COMPOSITION_DECODE_RULE (rule, gref, nref); \
1873 *dst++ = 32 + 81 + gref; \
1874 *dst++ = 32 + nref; \
1875 } while (0)
1877 /* Produce codes for indicating the start of a composition sequence
1878 (ESC 0, ESC 3, or ESC 4). DATA points to an array of integers
1879 which specify information about the composition. See the comment
1880 in coding.h for the format of DATA. */
1882 #define ENCODE_COMPOSITION_START(coding, data) \
1883 do { \
1884 coding->composing = data[3]; \
1885 *dst++ = ISO_CODE_ESC; \
1886 if (coding->composing == COMPOSITION_RELATIVE) \
1887 *dst++ = '0'; \
1888 else \
1890 *dst++ = (coding->composing == COMPOSITION_WITH_ALTCHARS \
1891 ? '3' : '4'); \
1892 coding->cmp_data_index = coding->cmp_data_start + 4; \
1893 coding->composition_rule_follows = 0; \
1895 } while (0)
1897 /* Produce codes for indicating the end of the current composition. */
1899 #define ENCODE_COMPOSITION_END(coding, data) \
1900 do { \
1901 *dst++ = ISO_CODE_ESC; \
1902 *dst++ = '1'; \
1903 coding->cmp_data_start += data[0]; \
1904 coding->composing = COMPOSITION_NO; \
1905 if (coding->cmp_data_start == coding->cmp_data->used \
1906 && coding->cmp_data->next) \
1908 coding->cmp_data = coding->cmp_data->next; \
1909 coding->cmp_data_start = 0; \
1911 } while (0)
1913 /* Produce composition start sequence ESC 0. Here, this sequence
1914 doesn't mean the start of a new composition but means that we have
1915 just produced components (alternate chars and composition rules) of
1916 the composition and the actual text follows in SRC. */
1918 #define ENCODE_COMPOSITION_FAKE_START(coding) \
1919 do { \
1920 *dst++ = ISO_CODE_ESC; \
1921 *dst++ = '0'; \
1922 coding->composing = COMPOSITION_RELATIVE; \
1923 } while (0)
1925 /* The following three macros produce codes for indicating direction
1926 of text. */
1927 #define ENCODE_CONTROL_SEQUENCE_INTRODUCER \
1928 do { \
1929 if (coding->flags == CODING_FLAG_ISO_SEVEN_BITS) \
1930 *dst++ = ISO_CODE_ESC, *dst++ = '['; \
1931 else \
1932 *dst++ = ISO_CODE_CSI; \
1933 } while (0)
1935 #define ENCODE_DIRECTION_R2L \
1936 ENCODE_CONTROL_SEQUENCE_INTRODUCER (dst), *dst++ = '2', *dst++ = ']'
1938 #define ENCODE_DIRECTION_L2R \
1939 ENCODE_CONTROL_SEQUENCE_INTRODUCER (dst), *dst++ = '0', *dst++ = ']'
1941 /* Produce codes for designation and invocation to reset the graphic
1942 planes and registers to initial state. */
1943 #define ENCODE_RESET_PLANE_AND_REGISTER \
1944 do { \
1945 int reg; \
1946 if (CODING_SPEC_ISO_INVOCATION (coding, 0) != 0) \
1947 ENCODE_SHIFT_IN; \
1948 for (reg = 0; reg < 4; reg++) \
1949 if (CODING_SPEC_ISO_INITIAL_DESIGNATION (coding, reg) >= 0 \
1950 && (CODING_SPEC_ISO_DESIGNATION (coding, reg) \
1951 != CODING_SPEC_ISO_INITIAL_DESIGNATION (coding, reg))) \
1952 ENCODE_DESIGNATION \
1953 (CODING_SPEC_ISO_INITIAL_DESIGNATION (coding, reg), reg, coding); \
1954 } while (0)
1956 /* Produce designation sequences of charsets in the line started from
1957 SRC to a place pointed by DST, and return updated DST.
1959 If the current block ends before any end-of-line, we may fail to
1960 find all the necessary designations. */
1962 static unsigned char *
1963 encode_designation_at_bol (coding, translation_table, src, src_end, dst)
1964 struct coding_system *coding;
1965 Lisp_Object translation_table;
1966 unsigned char *src, *src_end, *dst;
1968 int charset, c, found = 0, reg;
1969 /* Table of charsets to be designated to each graphic register. */
1970 int r[4];
1972 for (reg = 0; reg < 4; reg++)
1973 r[reg] = -1;
1975 while (found < 4)
1977 ONE_MORE_CHAR (c);
1978 if (c == '\n')
1979 break;
1981 charset = CHAR_CHARSET (c);
1982 reg = CODING_SPEC_ISO_REQUESTED_DESIGNATION (coding, charset);
1983 if (reg != CODING_SPEC_ISO_NO_REQUESTED_DESIGNATION && r[reg] < 0)
1985 found++;
1986 r[reg] = charset;
1990 label_end_of_loop:
1991 if (found)
1993 for (reg = 0; reg < 4; reg++)
1994 if (r[reg] >= 0
1995 && CODING_SPEC_ISO_DESIGNATION (coding, reg) != r[reg])
1996 ENCODE_DESIGNATION (r[reg], reg, coding);
1999 return dst;
2002 /* See the above "GENERAL NOTES on `encode_coding_XXX ()' functions". */
2004 static void
2005 encode_coding_iso2022 (coding, source, destination, src_bytes, dst_bytes)
2006 struct coding_system *coding;
2007 unsigned char *source, *destination;
2008 int src_bytes, dst_bytes;
2010 unsigned char *src = source;
2011 unsigned char *src_end = source + src_bytes;
2012 unsigned char *dst = destination;
2013 unsigned char *dst_end = destination + dst_bytes;
2014 /* Since the maximum bytes produced by each loop is 20, we subtract 19
2015 from DST_END to assure overflow checking is necessary only at the
2016 head of loop. */
2017 unsigned char *adjusted_dst_end = dst_end - 19;
2018 /* SRC_BASE remembers the start position in source in each loop.
2019 The loop will be exited when there's not enough source text to
2020 analyze multi-byte codes (within macro ONE_MORE_CHAR), or when
2021 there's not enough destination area to produce encoded codes
2022 (within macro EMIT_BYTES). */
2023 unsigned char *src_base;
2024 int c;
2025 Lisp_Object translation_table;
2026 Lisp_Object safe_chars;
2028 safe_chars = coding_safe_chars (coding);
2030 if (NILP (Venable_character_translation))
2031 translation_table = Qnil;
2032 else
2034 translation_table = coding->translation_table_for_encode;
2035 if (NILP (translation_table))
2036 translation_table = Vstandard_translation_table_for_encode;
2039 coding->consumed_char = 0;
2040 coding->errors = 0;
2041 while (1)
2043 src_base = src;
2045 if (dst >= (dst_bytes ? adjusted_dst_end : (src - 19)))
2047 coding->result = CODING_FINISH_INSUFFICIENT_DST;
2048 break;
2051 if (coding->flags & CODING_FLAG_ISO_DESIGNATE_AT_BOL
2052 && CODING_SPEC_ISO_BOL (coding))
2054 /* We have to produce designation sequences if any now. */
2055 dst = encode_designation_at_bol (coding, translation_table,
2056 src, src_end, dst);
2057 CODING_SPEC_ISO_BOL (coding) = 0;
2060 /* Check composition start and end. */
2061 if (coding->composing != COMPOSITION_DISABLED
2062 && coding->cmp_data_start < coding->cmp_data->used)
2064 struct composition_data *cmp_data = coding->cmp_data;
2065 int *data = cmp_data->data + coding->cmp_data_start;
2066 int this_pos = cmp_data->char_offset + coding->consumed_char;
2068 if (coding->composing == COMPOSITION_RELATIVE)
2070 if (this_pos == data[2])
2072 ENCODE_COMPOSITION_END (coding, data);
2073 cmp_data = coding->cmp_data;
2074 data = cmp_data->data + coding->cmp_data_start;
2077 else if (COMPOSING_P (coding))
2079 /* COMPOSITION_WITH_ALTCHARS or COMPOSITION_WITH_RULE_ALTCHAR */
2080 if (coding->cmp_data_index == coding->cmp_data_start + data[0])
2081 /* We have consumed components of the composition.
2082 What follows in SRC is the compositions's base
2083 text. */
2084 ENCODE_COMPOSITION_FAKE_START (coding);
2085 else
2087 int c = cmp_data->data[coding->cmp_data_index++];
2088 if (coding->composition_rule_follows)
2090 ENCODE_COMPOSITION_RULE (c);
2091 coding->composition_rule_follows = 0;
2093 else
2095 if (coding->flags & CODING_FLAG_ISO_SAFE
2096 && ! CODING_SAFE_CHAR_P (safe_chars, c))
2097 ENCODE_UNSAFE_CHARACTER (c);
2098 else
2099 ENCODE_ISO_CHARACTER (c);
2100 if (coding->composing == COMPOSITION_WITH_RULE_ALTCHARS)
2101 coding->composition_rule_follows = 1;
2103 continue;
2106 if (!COMPOSING_P (coding))
2108 if (this_pos == data[1])
2110 ENCODE_COMPOSITION_START (coding, data);
2111 continue;
2116 ONE_MORE_CHAR (c);
2118 /* Now encode the character C. */
2119 if (c < 0x20 || c == 0x7F)
2121 if (c == '\r')
2123 if (! (coding->mode & CODING_MODE_SELECTIVE_DISPLAY))
2125 if (coding->flags & CODING_FLAG_ISO_RESET_AT_CNTL)
2126 ENCODE_RESET_PLANE_AND_REGISTER;
2127 *dst++ = c;
2128 continue;
2130 /* fall down to treat '\r' as '\n' ... */
2131 c = '\n';
2133 if (c == '\n')
2135 if (coding->flags & CODING_FLAG_ISO_RESET_AT_EOL)
2136 ENCODE_RESET_PLANE_AND_REGISTER;
2137 if (coding->flags & CODING_FLAG_ISO_INIT_AT_BOL)
2138 bcopy (coding->spec.iso2022.initial_designation,
2139 coding->spec.iso2022.current_designation,
2140 sizeof coding->spec.iso2022.initial_designation);
2141 if (coding->eol_type == CODING_EOL_LF
2142 || coding->eol_type == CODING_EOL_UNDECIDED)
2143 *dst++ = ISO_CODE_LF;
2144 else if (coding->eol_type == CODING_EOL_CRLF)
2145 *dst++ = ISO_CODE_CR, *dst++ = ISO_CODE_LF;
2146 else
2147 *dst++ = ISO_CODE_CR;
2148 CODING_SPEC_ISO_BOL (coding) = 1;
2150 else
2152 if (coding->flags & CODING_FLAG_ISO_RESET_AT_CNTL)
2153 ENCODE_RESET_PLANE_AND_REGISTER;
2154 *dst++ = c;
2157 else if (ASCII_BYTE_P (c))
2158 ENCODE_ISO_CHARACTER (c);
2159 else if (SINGLE_BYTE_CHAR_P (c))
2161 *dst++ = c;
2162 coding->errors++;
2164 else if (coding->flags & CODING_FLAG_ISO_SAFE
2165 && ! CODING_SAFE_CHAR_P (safe_chars, c))
2166 ENCODE_UNSAFE_CHARACTER (c);
2167 else
2168 ENCODE_ISO_CHARACTER (c);
2170 coding->consumed_char++;
2173 label_end_of_loop:
2174 coding->consumed = src_base - source;
2175 coding->produced = coding->produced_char = dst - destination;
2179 /*** 4. SJIS and BIG5 handlers ***/
2181 /* Although SJIS and BIG5 are not ISO's coding system, they are used
2182 quite widely. So, for the moment, Emacs supports them in the bare
2183 C code. But, in the future, they may be supported only by CCL. */
2185 /* SJIS is a coding system encoding three character sets: ASCII, right
2186 half of JISX0201-Kana, and JISX0208. An ASCII character is encoded
2187 as is. A character of charset katakana-jisx0201 is encoded by
2188 "position-code + 0x80". A character of charset japanese-jisx0208
2189 is encoded in 2-byte but two position-codes are divided and shifted
2190 so that it fit in the range below.
2192 --- CODE RANGE of SJIS ---
2193 (character set) (range)
2194 ASCII 0x00 .. 0x7F
2195 KATAKANA-JISX0201 0xA0 .. 0xDF
2196 JISX0208 (1st byte) 0x81 .. 0x9F and 0xE0 .. 0xEF
2197 (2nd byte) 0x40 .. 0x7E and 0x80 .. 0xFC
2198 -------------------------------
2202 /* BIG5 is a coding system encoding two character sets: ASCII and
2203 Big5. An ASCII character is encoded as is. Big5 is a two-byte
2204 character set and is encoded in two-byte.
2206 --- CODE RANGE of BIG5 ---
2207 (character set) (range)
2208 ASCII 0x00 .. 0x7F
2209 Big5 (1st byte) 0xA1 .. 0xFE
2210 (2nd byte) 0x40 .. 0x7E and 0xA1 .. 0xFE
2211 --------------------------
2213 Since the number of characters in Big5 is larger than maximum
2214 characters in Emacs' charset (96x96), it can't be handled as one
2215 charset. So, in Emacs, Big5 is divided into two: `charset-big5-1'
2216 and `charset-big5-2'. Both are DIMENSION2 and CHARS94. The former
2217 contains frequently used characters and the latter contains less
2218 frequently used characters. */
2220 /* Macros to decode or encode a character of Big5 in BIG5. B1 and B2
2221 are the 1st and 2nd position-codes of Big5 in BIG5 coding system.
2222 C1 and C2 are the 1st and 2nd position-codes of of Emacs' internal
2223 format. CHARSET is `charset_big5_1' or `charset_big5_2'. */
2225 /* Number of Big5 characters which have the same code in 1st byte. */
2226 #define BIG5_SAME_ROW (0xFF - 0xA1 + 0x7F - 0x40)
2228 #define DECODE_BIG5(b1, b2, charset, c1, c2) \
2229 do { \
2230 unsigned int temp \
2231 = (b1 - 0xA1) * BIG5_SAME_ROW + b2 - (b2 < 0x7F ? 0x40 : 0x62); \
2232 if (b1 < 0xC9) \
2233 charset = charset_big5_1; \
2234 else \
2236 charset = charset_big5_2; \
2237 temp -= (0xC9 - 0xA1) * BIG5_SAME_ROW; \
2239 c1 = temp / (0xFF - 0xA1) + 0x21; \
2240 c2 = temp % (0xFF - 0xA1) + 0x21; \
2241 } while (0)
2243 #define ENCODE_BIG5(charset, c1, c2, b1, b2) \
2244 do { \
2245 unsigned int temp = (c1 - 0x21) * (0xFF - 0xA1) + (c2 - 0x21); \
2246 if (charset == charset_big5_2) \
2247 temp += BIG5_SAME_ROW * (0xC9 - 0xA1); \
2248 b1 = temp / BIG5_SAME_ROW + 0xA1; \
2249 b2 = temp % BIG5_SAME_ROW; \
2250 b2 += b2 < 0x3F ? 0x40 : 0x62; \
2251 } while (0)
2253 /* See the above "GENERAL NOTES on `detect_coding_XXX ()' functions".
2254 Check if a text is encoded in SJIS. If it is, return
2255 CODING_CATEGORY_MASK_SJIS, else return 0. */
2258 detect_coding_sjis (src, src_end)
2259 unsigned char *src, *src_end;
2261 int c;
2262 /* Dummy for ONE_MORE_BYTE. */
2263 struct coding_system dummy_coding;
2264 struct coding_system *coding = &dummy_coding;
2266 while (1)
2268 ONE_MORE_BYTE (c);
2269 if ((c >= 0x80 && c < 0xA0) || c >= 0xE0)
2271 ONE_MORE_BYTE (c);
2272 if (c < 0x40)
2273 return 0;
2276 label_end_of_loop:
2277 return CODING_CATEGORY_MASK_SJIS;
2280 /* See the above "GENERAL NOTES on `detect_coding_XXX ()' functions".
2281 Check if a text is encoded in BIG5. If it is, return
2282 CODING_CATEGORY_MASK_BIG5, else return 0. */
2285 detect_coding_big5 (src, src_end)
2286 unsigned char *src, *src_end;
2288 int c;
2289 /* Dummy for ONE_MORE_BYTE. */
2290 struct coding_system dummy_coding;
2291 struct coding_system *coding = &dummy_coding;
2293 while (1)
2295 ONE_MORE_BYTE (c);
2296 if (c >= 0xA1)
2298 ONE_MORE_BYTE (c);
2299 if (c < 0x40 || (c >= 0x7F && c <= 0xA0))
2300 return 0;
2303 label_end_of_loop:
2304 return CODING_CATEGORY_MASK_BIG5;
2307 /* See the above "GENERAL NOTES on `detect_coding_XXX ()' functions".
2308 Check if a text is encoded in UTF-8. If it is, return
2309 CODING_CATEGORY_MASK_UTF_8, else return 0. */
2311 #define UTF_8_1_OCTET_P(c) ((c) < 0x80)
2312 #define UTF_8_EXTRA_OCTET_P(c) (((c) & 0xC0) == 0x80)
2313 #define UTF_8_2_OCTET_LEADING_P(c) (((c) & 0xE0) == 0xC0)
2314 #define UTF_8_3_OCTET_LEADING_P(c) (((c) & 0xF0) == 0xE0)
2315 #define UTF_8_4_OCTET_LEADING_P(c) (((c) & 0xF8) == 0xF0)
2316 #define UTF_8_5_OCTET_LEADING_P(c) (((c) & 0xFC) == 0xF8)
2317 #define UTF_8_6_OCTET_LEADING_P(c) (((c) & 0xFE) == 0xFC)
2320 detect_coding_utf_8 (src, src_end)
2321 unsigned char *src, *src_end;
2323 unsigned char c;
2324 int seq_maybe_bytes;
2325 /* Dummy for ONE_MORE_BYTE. */
2326 struct coding_system dummy_coding;
2327 struct coding_system *coding = &dummy_coding;
2329 while (1)
2331 ONE_MORE_BYTE (c);
2332 if (UTF_8_1_OCTET_P (c))
2333 continue;
2334 else if (UTF_8_2_OCTET_LEADING_P (c))
2335 seq_maybe_bytes = 1;
2336 else if (UTF_8_3_OCTET_LEADING_P (c))
2337 seq_maybe_bytes = 2;
2338 else if (UTF_8_4_OCTET_LEADING_P (c))
2339 seq_maybe_bytes = 3;
2340 else if (UTF_8_5_OCTET_LEADING_P (c))
2341 seq_maybe_bytes = 4;
2342 else if (UTF_8_6_OCTET_LEADING_P (c))
2343 seq_maybe_bytes = 5;
2344 else
2345 return 0;
2349 ONE_MORE_BYTE (c);
2350 if (!UTF_8_EXTRA_OCTET_P (c))
2351 return 0;
2352 seq_maybe_bytes--;
2354 while (seq_maybe_bytes > 0);
2357 label_end_of_loop:
2358 return CODING_CATEGORY_MASK_UTF_8;
2361 /* See the above "GENERAL NOTES on `detect_coding_XXX ()' functions".
2362 Check if a text is encoded in UTF-16 Big Endian (endian == 1) or
2363 Little Endian (otherwise). If it is, return
2364 CODING_CATEGORY_MASK_UTF_16_BE or CODING_CATEGORY_MASK_UTF_16_LE,
2365 else return 0. */
2367 #define UTF_16_INVALID_P(val) \
2368 (((val) == 0xFFFE) \
2369 || ((val) == 0xFFFF))
2371 #define UTF_16_HIGH_SURROGATE_P(val) \
2372 (((val) & 0xD800) == 0xD800)
2374 #define UTF_16_LOW_SURROGATE_P(val) \
2375 (((val) & 0xDC00) == 0xDC00)
2378 detect_coding_utf_16 (src, src_end)
2379 unsigned char *src, *src_end;
2381 unsigned char c1, c2;
2382 /* Dummy for TWO_MORE_BYTES. */
2383 struct coding_system dummy_coding;
2384 struct coding_system *coding = &dummy_coding;
2386 TWO_MORE_BYTES (c1, c2);
2388 if ((c1 == 0xFF) && (c2 == 0xFE))
2389 return CODING_CATEGORY_MASK_UTF_16_LE;
2390 else if ((c1 == 0xFE) && (c2 == 0xFF))
2391 return CODING_CATEGORY_MASK_UTF_16_BE;
2393 label_end_of_loop:
2394 return 0;
2397 /* See the above "GENERAL NOTES on `decode_coding_XXX ()' functions".
2398 If SJIS_P is 1, decode SJIS text, else decode BIG5 test. */
2400 static void
2401 decode_coding_sjis_big5 (coding, source, destination,
2402 src_bytes, dst_bytes, sjis_p)
2403 struct coding_system *coding;
2404 unsigned char *source, *destination;
2405 int src_bytes, dst_bytes;
2406 int sjis_p;
2408 unsigned char *src = source;
2409 unsigned char *src_end = source + src_bytes;
2410 unsigned char *dst = destination;
2411 unsigned char *dst_end = destination + dst_bytes;
2412 /* SRC_BASE remembers the start position in source in each loop.
2413 The loop will be exited when there's not enough source code
2414 (within macro ONE_MORE_BYTE), or when there's not enough
2415 destination area to produce a character (within macro
2416 EMIT_CHAR). */
2417 unsigned char *src_base;
2418 Lisp_Object translation_table;
2420 if (NILP (Venable_character_translation))
2421 translation_table = Qnil;
2422 else
2424 translation_table = coding->translation_table_for_decode;
2425 if (NILP (translation_table))
2426 translation_table = Vstandard_translation_table_for_decode;
2429 coding->produced_char = 0;
2430 while (1)
2432 int c, charset, c1, c2;
2434 src_base = src;
2435 ONE_MORE_BYTE (c1);
2437 if (c1 < 0x80)
2439 charset = CHARSET_ASCII;
2440 if (c1 < 0x20)
2442 if (c1 == '\r')
2444 if (coding->eol_type == CODING_EOL_CRLF)
2446 ONE_MORE_BYTE (c2);
2447 if (c2 == '\n')
2448 c1 = c2;
2449 else if (coding->mode
2450 & CODING_MODE_INHIBIT_INCONSISTENT_EOL)
2452 coding->result = CODING_FINISH_INCONSISTENT_EOL;
2453 goto label_end_of_loop;
2455 else
2456 /* To process C2 again, SRC is subtracted by 1. */
2457 src--;
2459 else if (coding->eol_type == CODING_EOL_CR)
2460 c1 = '\n';
2462 else if (c1 == '\n'
2463 && (coding->mode & CODING_MODE_INHIBIT_INCONSISTENT_EOL)
2464 && (coding->eol_type == CODING_EOL_CR
2465 || coding->eol_type == CODING_EOL_CRLF))
2467 coding->result = CODING_FINISH_INCONSISTENT_EOL;
2468 goto label_end_of_loop;
2472 else
2474 if (sjis_p)
2476 if (c1 >= 0xF0)
2477 goto label_invalid_code;
2478 if (c1 < 0xA0 || c1 >= 0xE0)
2480 /* SJIS -> JISX0208 */
2481 ONE_MORE_BYTE (c2);
2482 if (c2 < 0x40 || c2 == 0x7F || c2 > 0xFC)
2483 goto label_invalid_code;
2484 DECODE_SJIS (c1, c2, c1, c2);
2485 charset = charset_jisx0208;
2487 else
2488 /* SJIS -> JISX0201-Kana */
2489 charset = charset_katakana_jisx0201;
2491 else
2493 /* BIG5 -> Big5 */
2494 if (c1 < 0xA1 || c1 > 0xFE)
2495 goto label_invalid_code;
2496 ONE_MORE_BYTE (c2);
2497 if (c2 < 0x40 || (c2 > 0x7E && c2 < 0xA1) || c2 > 0xFE)
2498 goto label_invalid_code;
2499 DECODE_BIG5 (c1, c2, charset, c1, c2);
2503 c = DECODE_ISO_CHARACTER (charset, c1, c2);
2504 EMIT_CHAR (c);
2505 continue;
2507 label_invalid_code:
2508 coding->errors++;
2509 src = src_base;
2510 c = *src++;
2511 EMIT_CHAR (c);
2514 label_end_of_loop:
2515 coding->consumed = coding->consumed_char = src_base - source;
2516 coding->produced = dst - destination;
2517 return;
2520 /* See the above "GENERAL NOTES on `encode_coding_XXX ()' functions".
2521 This function can encode charsets `ascii', `katakana-jisx0201',
2522 `japanese-jisx0208', `chinese-big5-1', and `chinese-big5-2'. We
2523 are sure that all these charsets are registered as official charset
2524 (i.e. do not have extended leading-codes). Characters of other
2525 charsets are produced without any encoding. If SJIS_P is 1, encode
2526 SJIS text, else encode BIG5 text. */
2528 static void
2529 encode_coding_sjis_big5 (coding, source, destination,
2530 src_bytes, dst_bytes, sjis_p)
2531 struct coding_system *coding;
2532 unsigned char *source, *destination;
2533 int src_bytes, dst_bytes;
2534 int sjis_p;
2536 unsigned char *src = source;
2537 unsigned char *src_end = source + src_bytes;
2538 unsigned char *dst = destination;
2539 unsigned char *dst_end = destination + dst_bytes;
2540 /* SRC_BASE remembers the start position in source in each loop.
2541 The loop will be exited when there's not enough source text to
2542 analyze multi-byte codes (within macro ONE_MORE_CHAR), or when
2543 there's not enough destination area to produce encoded codes
2544 (within macro EMIT_BYTES). */
2545 unsigned char *src_base;
2546 Lisp_Object translation_table;
2548 if (NILP (Venable_character_translation))
2549 translation_table = Qnil;
2550 else
2552 translation_table = coding->translation_table_for_decode;
2553 if (NILP (translation_table))
2554 translation_table = Vstandard_translation_table_for_decode;
2557 while (1)
2559 int c, charset, c1, c2;
2561 src_base = src;
2562 ONE_MORE_CHAR (c);
2564 /* Now encode the character C. */
2565 if (SINGLE_BYTE_CHAR_P (c))
2567 switch (c)
2569 case '\r':
2570 if (!coding->mode & CODING_MODE_SELECTIVE_DISPLAY)
2572 EMIT_ONE_BYTE (c);
2573 break;
2575 c = '\n';
2576 case '\n':
2577 if (coding->eol_type == CODING_EOL_CRLF)
2579 EMIT_TWO_BYTES ('\r', c);
2580 break;
2582 else if (coding->eol_type == CODING_EOL_CR)
2583 c = '\r';
2584 default:
2585 EMIT_ONE_BYTE (c);
2588 else
2590 SPLIT_CHAR (c, charset, c1, c2);
2591 if (sjis_p)
2593 if (charset == charset_jisx0208
2594 || charset == charset_jisx0208_1978)
2596 ENCODE_SJIS (c1, c2, c1, c2);
2597 EMIT_TWO_BYTES (c1, c2);
2599 else if (charset == charset_latin_jisx0201)
2600 EMIT_ONE_BYTE (c1);
2601 else
2602 /* There's no way other than producing the internal
2603 codes as is. */
2604 EMIT_BYTES (src_base, src);
2606 else
2608 if (charset == charset_big5_1 || charset == charset_big5_2)
2610 ENCODE_BIG5 (charset, c1, c2, c1, c2);
2611 EMIT_TWO_BYTES (c1, c2);
2613 else
2614 /* There's no way other than producing the internal
2615 codes as is. */
2616 EMIT_BYTES (src_base, src);
2619 coding->consumed_char++;
2622 label_end_of_loop:
2623 coding->consumed = src_base - source;
2624 coding->produced = coding->produced_char = dst - destination;
2628 /*** 5. CCL handlers ***/
2630 /* See the above "GENERAL NOTES on `detect_coding_XXX ()' functions".
2631 Check if a text is encoded in a coding system of which
2632 encoder/decoder are written in CCL program. If it is, return
2633 CODING_CATEGORY_MASK_CCL, else return 0. */
2636 detect_coding_ccl (src, src_end)
2637 unsigned char *src, *src_end;
2639 unsigned char *valid;
2640 int c;
2641 /* Dummy for ONE_MORE_BYTE. */
2642 struct coding_system dummy_coding;
2643 struct coding_system *coding = &dummy_coding;
2645 /* No coding system is assigned to coding-category-ccl. */
2646 if (!coding_system_table[CODING_CATEGORY_IDX_CCL])
2647 return 0;
2649 valid = coding_system_table[CODING_CATEGORY_IDX_CCL]->spec.ccl.valid_codes;
2650 while (1)
2652 ONE_MORE_BYTE (c);
2653 if (! valid[c])
2654 return 0;
2656 label_end_of_loop:
2657 return CODING_CATEGORY_MASK_CCL;
2661 /*** 6. End-of-line handlers ***/
2663 /* See the above "GENERAL NOTES on `decode_coding_XXX ()' functions". */
2665 static void
2666 decode_eol (coding, source, destination, src_bytes, dst_bytes)
2667 struct coding_system *coding;
2668 unsigned char *source, *destination;
2669 int src_bytes, dst_bytes;
2671 unsigned char *src = source;
2672 unsigned char *dst = destination;
2673 unsigned char *src_end = src + src_bytes;
2674 unsigned char *dst_end = dst + dst_bytes;
2675 Lisp_Object translation_table;
2676 /* SRC_BASE remembers the start position in source in each loop.
2677 The loop will be exited when there's not enough source code
2678 (within macro ONE_MORE_BYTE), or when there's not enough
2679 destination area to produce a character (within macro
2680 EMIT_CHAR). */
2681 unsigned char *src_base;
2682 int c;
2684 translation_table = Qnil;
2685 switch (coding->eol_type)
2687 case CODING_EOL_CRLF:
2688 while (1)
2690 src_base = src;
2691 ONE_MORE_BYTE (c);
2692 if (c == '\r')
2694 ONE_MORE_BYTE (c);
2695 if (c != '\n')
2697 if (coding->mode & CODING_MODE_INHIBIT_INCONSISTENT_EOL)
2699 coding->result = CODING_FINISH_INCONSISTENT_EOL;
2700 goto label_end_of_loop;
2702 src--;
2703 c = '\r';
2706 else if (c == '\n'
2707 && (coding->mode & CODING_MODE_INHIBIT_INCONSISTENT_EOL))
2709 coding->result = CODING_FINISH_INCONSISTENT_EOL;
2710 goto label_end_of_loop;
2712 EMIT_CHAR (c);
2714 break;
2716 case CODING_EOL_CR:
2717 while (1)
2719 src_base = src;
2720 ONE_MORE_BYTE (c);
2721 if (c == '\n')
2723 if (coding->mode & CODING_MODE_INHIBIT_INCONSISTENT_EOL)
2725 coding->result = CODING_FINISH_INCONSISTENT_EOL;
2726 goto label_end_of_loop;
2729 else if (c == '\r')
2730 c = '\n';
2731 EMIT_CHAR (c);
2733 break;
2735 default: /* no need for EOL handling */
2736 while (1)
2738 src_base = src;
2739 ONE_MORE_BYTE (c);
2740 EMIT_CHAR (c);
2744 label_end_of_loop:
2745 coding->consumed = coding->consumed_char = src_base - source;
2746 coding->produced = dst - destination;
2747 return;
2750 /* See "GENERAL NOTES about `encode_coding_XXX ()' functions". Encode
2751 format of end-of-line according to `coding->eol_type'. It also
2752 convert multibyte form 8-bit characers to unibyte if
2753 CODING->src_multibyte is nonzero. If `coding->mode &
2754 CODING_MODE_SELECTIVE_DISPLAY' is nonzero, code '\r' in source text
2755 also means end-of-line. */
2757 static void
2758 encode_eol (coding, source, destination, src_bytes, dst_bytes)
2759 struct coding_system *coding;
2760 unsigned char *source, *destination;
2761 int src_bytes, dst_bytes;
2763 unsigned char *src = source;
2764 unsigned char *dst = destination;
2765 unsigned char *src_end = src + src_bytes;
2766 unsigned char *dst_end = dst + dst_bytes;
2767 Lisp_Object translation_table;
2768 /* SRC_BASE remembers the start position in source in each loop.
2769 The loop will be exited when there's not enough source text to
2770 analyze multi-byte codes (within macro ONE_MORE_CHAR), or when
2771 there's not enough destination area to produce encoded codes
2772 (within macro EMIT_BYTES). */
2773 unsigned char *src_base;
2774 int c;
2775 int selective_display = coding->mode & CODING_MODE_SELECTIVE_DISPLAY;
2777 translation_table = Qnil;
2778 if (coding->src_multibyte
2779 && *(src_end - 1) == LEADING_CODE_8_BIT_CONTROL)
2781 src_end--;
2782 src_bytes--;
2783 coding->result = CODING_FINISH_INSUFFICIENT_SRC;
2786 if (coding->eol_type == CODING_EOL_CRLF)
2788 while (src < src_end)
2790 src_base = src;
2791 c = *src++;
2792 if (c >= 0x20)
2793 EMIT_ONE_BYTE (c);
2794 else if (c == '\n' || (c == '\r' && selective_display))
2795 EMIT_TWO_BYTES ('\r', '\n');
2796 else
2797 EMIT_ONE_BYTE (c);
2799 src_base = src;
2800 label_end_of_loop:
2803 else
2805 if (src_bytes <= dst_bytes)
2807 safe_bcopy (src, dst, src_bytes);
2808 src_base = src_end;
2809 dst += src_bytes;
2811 else
2813 if (coding->src_multibyte
2814 && *(src + dst_bytes - 1) == LEADING_CODE_8_BIT_CONTROL)
2815 dst_bytes--;
2816 safe_bcopy (src, dst, dst_bytes);
2817 src_base = src + dst_bytes;
2818 dst = destination + dst_bytes;
2819 coding->result = CODING_FINISH_INSUFFICIENT_DST;
2821 if (coding->eol_type == CODING_EOL_CR)
2823 for (src = destination; src < dst; src++)
2824 if (*src == '\n') *src = '\r';
2826 else if (selective_display)
2828 for (src = destination; src < dst; src++)
2829 if (*src == '\r') *src = '\n';
2832 if (coding->src_multibyte)
2833 dst = destination + str_as_unibyte (destination, dst - destination);
2835 coding->consumed = src_base - source;
2836 coding->produced = dst - destination;
2840 /*** 7. C library functions ***/
2842 /* In Emacs Lisp, coding system is represented by a Lisp symbol which
2843 has a property `coding-system'. The value of this property is a
2844 vector of length 5 (called as coding-vector). Among elements of
2845 this vector, the first (element[0]) and the fifth (element[4])
2846 carry important information for decoding/encoding. Before
2847 decoding/encoding, this information should be set in fields of a
2848 structure of type `coding_system'.
2850 A value of property `coding-system' can be a symbol of another
2851 subsidiary coding-system. In that case, Emacs gets coding-vector
2852 from that symbol.
2854 `element[0]' contains information to be set in `coding->type'. The
2855 value and its meaning is as follows:
2857 0 -- coding_type_emacs_mule
2858 1 -- coding_type_sjis
2859 2 -- coding_type_iso2022
2860 3 -- coding_type_big5
2861 4 -- coding_type_ccl encoder/decoder written in CCL
2862 nil -- coding_type_no_conversion
2863 t -- coding_type_undecided (automatic conversion on decoding,
2864 no-conversion on encoding)
2866 `element[4]' contains information to be set in `coding->flags' and
2867 `coding->spec'. The meaning varies by `coding->type'.
2869 If `coding->type' is `coding_type_iso2022', element[4] is a vector
2870 of length 32 (of which the first 13 sub-elements are used now).
2871 Meanings of these sub-elements are:
2873 sub-element[N] where N is 0 through 3: to be set in `coding->spec.iso2022'
2874 If the value is an integer of valid charset, the charset is
2875 assumed to be designated to graphic register N initially.
2877 If the value is minus, it is a minus value of charset which
2878 reserves graphic register N, which means that the charset is
2879 not designated initially but should be designated to graphic
2880 register N just before encoding a character in that charset.
2882 If the value is nil, graphic register N is never used on
2883 encoding.
2885 sub-element[N] where N is 4 through 11: to be set in `coding->flags'
2886 Each value takes t or nil. See the section ISO2022 of
2887 `coding.h' for more information.
2889 If `coding->type' is `coding_type_big5', element[4] is t to denote
2890 BIG5-ETen or nil to denote BIG5-HKU.
2892 If `coding->type' takes the other value, element[4] is ignored.
2894 Emacs Lisp's coding system also carries information about format of
2895 end-of-line in a value of property `eol-type'. If the value is
2896 integer, 0 means CODING_EOL_LF, 1 means CODING_EOL_CRLF, and 2
2897 means CODING_EOL_CR. If it is not integer, it should be a vector
2898 of subsidiary coding systems of which property `eol-type' has one
2899 of above values.
2903 /* Extract information for decoding/encoding from CODING_SYSTEM_SYMBOL
2904 and set it in CODING. If CODING_SYSTEM_SYMBOL is invalid, CODING
2905 is setup so that no conversion is necessary and return -1, else
2906 return 0. */
2909 setup_coding_system (coding_system, coding)
2910 Lisp_Object coding_system;
2911 struct coding_system *coding;
2913 Lisp_Object coding_spec, coding_type, eol_type, plist;
2914 Lisp_Object val;
2915 int i;
2917 /* Initialize some fields required for all kinds of coding systems. */
2918 coding->symbol = coding_system;
2919 coding->common_flags = 0;
2920 coding->mode = 0;
2921 coding->heading_ascii = -1;
2922 coding->post_read_conversion = coding->pre_write_conversion = Qnil;
2923 coding->composing = COMPOSITION_DISABLED;
2924 coding->cmp_data = NULL;
2926 if (NILP (coding_system))
2927 goto label_invalid_coding_system;
2929 coding_spec = Fget (coding_system, Qcoding_system);
2931 if (!VECTORP (coding_spec)
2932 || XVECTOR (coding_spec)->size != 5
2933 || !CONSP (XVECTOR (coding_spec)->contents[3]))
2934 goto label_invalid_coding_system;
2936 eol_type = inhibit_eol_conversion ? Qnil : Fget (coding_system, Qeol_type);
2937 if (VECTORP (eol_type))
2939 coding->eol_type = CODING_EOL_UNDECIDED;
2940 coding->common_flags = CODING_REQUIRE_DETECTION_MASK;
2942 else if (XFASTINT (eol_type) == 1)
2944 coding->eol_type = CODING_EOL_CRLF;
2945 coding->common_flags
2946 = CODING_REQUIRE_DECODING_MASK | CODING_REQUIRE_ENCODING_MASK;
2948 else if (XFASTINT (eol_type) == 2)
2950 coding->eol_type = CODING_EOL_CR;
2951 coding->common_flags
2952 = CODING_REQUIRE_DECODING_MASK | CODING_REQUIRE_ENCODING_MASK;
2954 else
2955 coding->eol_type = CODING_EOL_LF;
2957 coding_type = XVECTOR (coding_spec)->contents[0];
2958 /* Try short cut. */
2959 if (SYMBOLP (coding_type))
2961 if (EQ (coding_type, Qt))
2963 coding->type = coding_type_undecided;
2964 coding->common_flags |= CODING_REQUIRE_DETECTION_MASK;
2966 else
2967 coding->type = coding_type_no_conversion;
2968 return 0;
2971 /* Get values of coding system properties:
2972 `post-read-conversion', `pre-write-conversion',
2973 `translation-table-for-decode', `translation-table-for-encode'. */
2974 plist = XVECTOR (coding_spec)->contents[3];
2975 /* Pre & post conversion functions should be disabled if
2976 inhibit_eol_conversion is nozero. This is the case that a code
2977 conversion function is called while those functions are running. */
2978 if (! inhibit_pre_post_conversion)
2980 coding->post_read_conversion = Fplist_get (plist, Qpost_read_conversion);
2981 coding->pre_write_conversion = Fplist_get (plist, Qpre_write_conversion);
2983 val = Fplist_get (plist, Qtranslation_table_for_decode);
2984 if (SYMBOLP (val))
2985 val = Fget (val, Qtranslation_table_for_decode);
2986 coding->translation_table_for_decode = CHAR_TABLE_P (val) ? val : Qnil;
2987 val = Fplist_get (plist, Qtranslation_table_for_encode);
2988 if (SYMBOLP (val))
2989 val = Fget (val, Qtranslation_table_for_encode);
2990 coding->translation_table_for_encode = CHAR_TABLE_P (val) ? val : Qnil;
2991 val = Fplist_get (plist, Qcoding_category);
2992 if (!NILP (val))
2994 val = Fget (val, Qcoding_category_index);
2995 if (INTEGERP (val))
2996 coding->category_idx = XINT (val);
2997 else
2998 goto label_invalid_coding_system;
3000 else
3001 goto label_invalid_coding_system;
3003 /* If the coding system has non-nil `composition' property, enable
3004 composition handling. */
3005 val = Fplist_get (plist, Qcomposition);
3006 if (!NILP (val))
3007 coding->composing = COMPOSITION_NO;
3009 switch (XFASTINT (coding_type))
3011 case 0:
3012 coding->type = coding_type_emacs_mule;
3013 if (!NILP (coding->post_read_conversion))
3014 coding->common_flags |= CODING_REQUIRE_DECODING_MASK;
3015 if (!NILP (coding->pre_write_conversion))
3016 coding->common_flags |= CODING_REQUIRE_ENCODING_MASK;
3017 break;
3019 case 1:
3020 coding->type = coding_type_sjis;
3021 coding->common_flags
3022 |= CODING_REQUIRE_DECODING_MASK | CODING_REQUIRE_ENCODING_MASK;
3023 break;
3025 case 2:
3026 coding->type = coding_type_iso2022;
3027 coding->common_flags
3028 |= CODING_REQUIRE_DECODING_MASK | CODING_REQUIRE_ENCODING_MASK;
3030 Lisp_Object val, temp;
3031 Lisp_Object *flags;
3032 int i, charset, reg_bits = 0;
3034 val = XVECTOR (coding_spec)->contents[4];
3036 if (!VECTORP (val) || XVECTOR (val)->size != 32)
3037 goto label_invalid_coding_system;
3039 flags = XVECTOR (val)->contents;
3040 coding->flags
3041 = ((NILP (flags[4]) ? 0 : CODING_FLAG_ISO_SHORT_FORM)
3042 | (NILP (flags[5]) ? 0 : CODING_FLAG_ISO_RESET_AT_EOL)
3043 | (NILP (flags[6]) ? 0 : CODING_FLAG_ISO_RESET_AT_CNTL)
3044 | (NILP (flags[7]) ? 0 : CODING_FLAG_ISO_SEVEN_BITS)
3045 | (NILP (flags[8]) ? 0 : CODING_FLAG_ISO_LOCKING_SHIFT)
3046 | (NILP (flags[9]) ? 0 : CODING_FLAG_ISO_SINGLE_SHIFT)
3047 | (NILP (flags[10]) ? 0 : CODING_FLAG_ISO_USE_ROMAN)
3048 | (NILP (flags[11]) ? 0 : CODING_FLAG_ISO_USE_OLDJIS)
3049 | (NILP (flags[12]) ? 0 : CODING_FLAG_ISO_NO_DIRECTION)
3050 | (NILP (flags[13]) ? 0 : CODING_FLAG_ISO_INIT_AT_BOL)
3051 | (NILP (flags[14]) ? 0 : CODING_FLAG_ISO_DESIGNATE_AT_BOL)
3052 | (NILP (flags[15]) ? 0 : CODING_FLAG_ISO_SAFE)
3053 | (NILP (flags[16]) ? 0 : CODING_FLAG_ISO_LATIN_EXTRA)
3056 /* Invoke graphic register 0 to plane 0. */
3057 CODING_SPEC_ISO_INVOCATION (coding, 0) = 0;
3058 /* Invoke graphic register 1 to plane 1 if we can use full 8-bit. */
3059 CODING_SPEC_ISO_INVOCATION (coding, 1)
3060 = (coding->flags & CODING_FLAG_ISO_SEVEN_BITS ? -1 : 1);
3061 /* Not single shifting at first. */
3062 CODING_SPEC_ISO_SINGLE_SHIFTING (coding) = 0;
3063 /* Beginning of buffer should also be regarded as bol. */
3064 CODING_SPEC_ISO_BOL (coding) = 1;
3066 for (charset = 0; charset <= MAX_CHARSET; charset++)
3067 CODING_SPEC_ISO_REVISION_NUMBER (coding, charset) = 255;
3068 val = Vcharset_revision_alist;
3069 while (CONSP (val))
3071 charset = get_charset_id (Fcar_safe (XCAR (val)));
3072 if (charset >= 0
3073 && (temp = Fcdr_safe (XCAR (val)), INTEGERP (temp))
3074 && (i = XINT (temp), (i >= 0 && (i + '@') < 128)))
3075 CODING_SPEC_ISO_REVISION_NUMBER (coding, charset) = i;
3076 val = XCDR (val);
3079 /* Checks FLAGS[REG] (REG = 0, 1, 2 3) and decide designations.
3080 FLAGS[REG] can be one of below:
3081 integer CHARSET: CHARSET occupies register I,
3082 t: designate nothing to REG initially, but can be used
3083 by any charsets,
3084 list of integer, nil, or t: designate the first
3085 element (if integer) to REG initially, the remaining
3086 elements (if integer) is designated to REG on request,
3087 if an element is t, REG can be used by any charsets,
3088 nil: REG is never used. */
3089 for (charset = 0; charset <= MAX_CHARSET; charset++)
3090 CODING_SPEC_ISO_REQUESTED_DESIGNATION (coding, charset)
3091 = CODING_SPEC_ISO_NO_REQUESTED_DESIGNATION;
3092 for (i = 0; i < 4; i++)
3094 if (INTEGERP (flags[i])
3095 && (charset = XINT (flags[i]), CHARSET_VALID_P (charset))
3096 || (charset = get_charset_id (flags[i])) >= 0)
3098 CODING_SPEC_ISO_INITIAL_DESIGNATION (coding, i) = charset;
3099 CODING_SPEC_ISO_REQUESTED_DESIGNATION (coding, charset) = i;
3101 else if (EQ (flags[i], Qt))
3103 CODING_SPEC_ISO_INITIAL_DESIGNATION (coding, i) = -1;
3104 reg_bits |= 1 << i;
3105 coding->flags |= CODING_FLAG_ISO_DESIGNATION;
3107 else if (CONSP (flags[i]))
3109 Lisp_Object tail;
3110 tail = flags[i];
3112 coding->flags |= CODING_FLAG_ISO_DESIGNATION;
3113 if (INTEGERP (XCAR (tail))
3114 && (charset = XINT (XCAR (tail)),
3115 CHARSET_VALID_P (charset))
3116 || (charset = get_charset_id (XCAR (tail))) >= 0)
3118 CODING_SPEC_ISO_INITIAL_DESIGNATION (coding, i) = charset;
3119 CODING_SPEC_ISO_REQUESTED_DESIGNATION (coding, charset) =i;
3121 else
3122 CODING_SPEC_ISO_INITIAL_DESIGNATION (coding, i) = -1;
3123 tail = XCDR (tail);
3124 while (CONSP (tail))
3126 if (INTEGERP (XCAR (tail))
3127 && (charset = XINT (XCAR (tail)),
3128 CHARSET_VALID_P (charset))
3129 || (charset = get_charset_id (XCAR (tail))) >= 0)
3130 CODING_SPEC_ISO_REQUESTED_DESIGNATION (coding, charset)
3131 = i;
3132 else if (EQ (XCAR (tail), Qt))
3133 reg_bits |= 1 << i;
3134 tail = XCDR (tail);
3137 else
3138 CODING_SPEC_ISO_INITIAL_DESIGNATION (coding, i) = -1;
3140 CODING_SPEC_ISO_DESIGNATION (coding, i)
3141 = CODING_SPEC_ISO_INITIAL_DESIGNATION (coding, i);
3144 if (reg_bits && ! (coding->flags & CODING_FLAG_ISO_LOCKING_SHIFT))
3146 /* REG 1 can be used only by locking shift in 7-bit env. */
3147 if (coding->flags & CODING_FLAG_ISO_SEVEN_BITS)
3148 reg_bits &= ~2;
3149 if (! (coding->flags & CODING_FLAG_ISO_SINGLE_SHIFT))
3150 /* Without any shifting, only REG 0 and 1 can be used. */
3151 reg_bits &= 3;
3154 if (reg_bits)
3155 for (charset = 0; charset <= MAX_CHARSET; charset++)
3157 if (CHARSET_VALID_P (charset)
3158 && (CODING_SPEC_ISO_REQUESTED_DESIGNATION (coding, charset)
3159 == CODING_SPEC_ISO_NO_REQUESTED_DESIGNATION))
3161 /* There exist some default graphic registers to be
3162 used by CHARSET. */
3164 /* We had better avoid designating a charset of
3165 CHARS96 to REG 0 as far as possible. */
3166 if (CHARSET_CHARS (charset) == 96)
3167 CODING_SPEC_ISO_REQUESTED_DESIGNATION (coding, charset)
3168 = (reg_bits & 2
3169 ? 1 : (reg_bits & 4 ? 2 : (reg_bits & 8 ? 3 : 0)));
3170 else
3171 CODING_SPEC_ISO_REQUESTED_DESIGNATION (coding, charset)
3172 = (reg_bits & 1
3173 ? 0 : (reg_bits & 2 ? 1 : (reg_bits & 4 ? 2 : 3)));
3177 coding->common_flags |= CODING_REQUIRE_FLUSHING_MASK;
3178 coding->spec.iso2022.last_invalid_designation_register = -1;
3179 break;
3181 case 3:
3182 coding->type = coding_type_big5;
3183 coding->common_flags
3184 |= CODING_REQUIRE_DECODING_MASK | CODING_REQUIRE_ENCODING_MASK;
3185 coding->flags
3186 = (NILP (XVECTOR (coding_spec)->contents[4])
3187 ? CODING_FLAG_BIG5_HKU
3188 : CODING_FLAG_BIG5_ETEN);
3189 break;
3191 case 4:
3192 coding->type = coding_type_ccl;
3193 coding->common_flags
3194 |= CODING_REQUIRE_DECODING_MASK | CODING_REQUIRE_ENCODING_MASK;
3196 val = XVECTOR (coding_spec)->contents[4];
3197 if (! CONSP (val)
3198 || setup_ccl_program (&(coding->spec.ccl.decoder),
3199 XCAR (val)) < 0
3200 || setup_ccl_program (&(coding->spec.ccl.encoder),
3201 XCDR (val)) < 0)
3202 goto label_invalid_coding_system;
3204 bzero (coding->spec.ccl.valid_codes, 256);
3205 val = Fplist_get (plist, Qvalid_codes);
3206 if (CONSP (val))
3208 Lisp_Object this;
3210 for (; CONSP (val); val = XCDR (val))
3212 this = XCAR (val);
3213 if (INTEGERP (this)
3214 && XINT (this) >= 0 && XINT (this) < 256)
3215 coding->spec.ccl.valid_codes[XINT (this)] = 1;
3216 else if (CONSP (this)
3217 && INTEGERP (XCAR (this))
3218 && INTEGERP (XCDR (this)))
3220 int start = XINT (XCAR (this));
3221 int end = XINT (XCDR (this));
3223 if (start >= 0 && start <= end && end < 256)
3224 while (start <= end)
3225 coding->spec.ccl.valid_codes[start++] = 1;
3230 coding->common_flags |= CODING_REQUIRE_FLUSHING_MASK;
3231 coding->spec.ccl.cr_carryover = 0;
3232 break;
3234 case 5:
3235 coding->type = coding_type_raw_text;
3236 break;
3238 default:
3239 goto label_invalid_coding_system;
3241 return 0;
3243 label_invalid_coding_system:
3244 coding->type = coding_type_no_conversion;
3245 coding->category_idx = CODING_CATEGORY_IDX_BINARY;
3246 coding->common_flags = 0;
3247 coding->eol_type = CODING_EOL_LF;
3248 coding->pre_write_conversion = coding->post_read_conversion = Qnil;
3249 return -1;
3252 /* Free memory blocks allocated for storing composition information. */
3254 void
3255 coding_free_composition_data (coding)
3256 struct coding_system *coding;
3258 struct composition_data *cmp_data = coding->cmp_data, *next;
3260 if (!cmp_data)
3261 return;
3262 /* Memory blocks are chained. At first, rewind to the first, then,
3263 free blocks one by one. */
3264 while (cmp_data->prev)
3265 cmp_data = cmp_data->prev;
3266 while (cmp_data)
3268 next = cmp_data->next;
3269 xfree (cmp_data);
3270 cmp_data = next;
3272 coding->cmp_data = NULL;
3275 /* Set `char_offset' member of all memory blocks pointed by
3276 coding->cmp_data to POS. */
3278 void
3279 coding_adjust_composition_offset (coding, pos)
3280 struct coding_system *coding;
3281 int pos;
3283 struct composition_data *cmp_data;
3285 for (cmp_data = coding->cmp_data; cmp_data; cmp_data = cmp_data->next)
3286 cmp_data->char_offset = pos;
3289 /* Setup raw-text or one of its subsidiaries in the structure
3290 coding_system CODING according to the already setup value eol_type
3291 in CODING. CODING should be setup for some coding system in
3292 advance. */
3294 void
3295 setup_raw_text_coding_system (coding)
3296 struct coding_system *coding;
3298 if (coding->type != coding_type_raw_text)
3300 coding->symbol = Qraw_text;
3301 coding->type = coding_type_raw_text;
3302 if (coding->eol_type != CODING_EOL_UNDECIDED)
3304 Lisp_Object subsidiaries;
3305 subsidiaries = Fget (Qraw_text, Qeol_type);
3307 if (VECTORP (subsidiaries)
3308 && XVECTOR (subsidiaries)->size == 3)
3309 coding->symbol
3310 = XVECTOR (subsidiaries)->contents[coding->eol_type];
3312 setup_coding_system (coding->symbol, coding);
3314 return;
3317 /* Emacs has a mechanism to automatically detect a coding system if it
3318 is one of Emacs' internal format, ISO2022, SJIS, and BIG5. But,
3319 it's impossible to distinguish some coding systems accurately
3320 because they use the same range of codes. So, at first, coding
3321 systems are categorized into 7, those are:
3323 o coding-category-emacs-mule
3325 The category for a coding system which has the same code range
3326 as Emacs' internal format. Assigned the coding-system (Lisp
3327 symbol) `emacs-mule' by default.
3329 o coding-category-sjis
3331 The category for a coding system which has the same code range
3332 as SJIS. Assigned the coding-system (Lisp
3333 symbol) `japanese-shift-jis' by default.
3335 o coding-category-iso-7
3337 The category for a coding system which has the same code range
3338 as ISO2022 of 7-bit environment. This doesn't use any locking
3339 shift and single shift functions. This can encode/decode all
3340 charsets. Assigned the coding-system (Lisp symbol)
3341 `iso-2022-7bit' by default.
3343 o coding-category-iso-7-tight
3345 Same as coding-category-iso-7 except that this can
3346 encode/decode only the specified charsets.
3348 o coding-category-iso-8-1
3350 The category for a coding system which has the same code range
3351 as ISO2022 of 8-bit environment and graphic plane 1 used only
3352 for DIMENSION1 charset. This doesn't use any locking shift
3353 and single shift functions. Assigned the coding-system (Lisp
3354 symbol) `iso-latin-1' by default.
3356 o coding-category-iso-8-2
3358 The category for a coding system which has the same code range
3359 as ISO2022 of 8-bit environment and graphic plane 1 used only
3360 for DIMENSION2 charset. This doesn't use any locking shift
3361 and single shift functions. Assigned the coding-system (Lisp
3362 symbol) `japanese-iso-8bit' by default.
3364 o coding-category-iso-7-else
3366 The category for a coding system which has the same code range
3367 as ISO2022 of 7-bit environemnt but uses locking shift or
3368 single shift functions. Assigned the coding-system (Lisp
3369 symbol) `iso-2022-7bit-lock' by default.
3371 o coding-category-iso-8-else
3373 The category for a coding system which has the same code range
3374 as ISO2022 of 8-bit environemnt but uses locking shift or
3375 single shift functions. Assigned the coding-system (Lisp
3376 symbol) `iso-2022-8bit-ss2' by default.
3378 o coding-category-big5
3380 The category for a coding system which has the same code range
3381 as BIG5. Assigned the coding-system (Lisp symbol)
3382 `cn-big5' by default.
3384 o coding-category-utf-8
3386 The category for a coding system which has the same code range
3387 as UTF-8 (cf. RFC2279). Assigned the coding-system (Lisp
3388 symbol) `utf-8' by default.
3390 o coding-category-utf-16-be
3392 The category for a coding system in which a text has an
3393 Unicode signature (cf. Unicode Standard) in the order of BIG
3394 endian at the head. Assigned the coding-system (Lisp symbol)
3395 `utf-16-be' by default.
3397 o coding-category-utf-16-le
3399 The category for a coding system in which a text has an
3400 Unicode signature (cf. Unicode Standard) in the order of
3401 LITTLE endian at the head. Assigned the coding-system (Lisp
3402 symbol) `utf-16-le' by default.
3404 o coding-category-ccl
3406 The category for a coding system of which encoder/decoder is
3407 written in CCL programs. The default value is nil, i.e., no
3408 coding system is assigned.
3410 o coding-category-binary
3412 The category for a coding system not categorized in any of the
3413 above. Assigned the coding-system (Lisp symbol)
3414 `no-conversion' by default.
3416 Each of them is a Lisp symbol and the value is an actual
3417 `coding-system's (this is also a Lisp symbol) assigned by a user.
3418 What Emacs does actually is to detect a category of coding system.
3419 Then, it uses a `coding-system' assigned to it. If Emacs can't
3420 decide only one possible category, it selects a category of the
3421 highest priority. Priorities of categories are also specified by a
3422 user in a Lisp variable `coding-category-list'.
3426 static
3427 int ascii_skip_code[256];
3429 /* Detect how a text of length SRC_BYTES pointed by SOURCE is encoded.
3430 If it detects possible coding systems, return an integer in which
3431 appropriate flag bits are set. Flag bits are defined by macros
3432 CODING_CATEGORY_MASK_XXX in `coding.h'. If PRIORITIES is non-NULL,
3433 it should point the table `coding_priorities'. In that case, only
3434 the flag bit for a coding system of the highest priority is set in
3435 the returned value.
3437 How many ASCII characters are at the head is returned as *SKIP. */
3439 static int
3440 detect_coding_mask (source, src_bytes, priorities, skip)
3441 unsigned char *source;
3442 int src_bytes, *priorities, *skip;
3444 register unsigned char c;
3445 unsigned char *src = source, *src_end = source + src_bytes;
3446 unsigned int mask, utf16_examined_p, iso2022_examined_p;
3447 int i, idx;
3449 /* At first, skip all ASCII characters and control characters except
3450 for three ISO2022 specific control characters. */
3451 ascii_skip_code[ISO_CODE_SO] = 0;
3452 ascii_skip_code[ISO_CODE_SI] = 0;
3453 ascii_skip_code[ISO_CODE_ESC] = 0;
3455 label_loop_detect_coding:
3456 while (src < src_end && ascii_skip_code[*src]) src++;
3457 *skip = src - source;
3459 if (src >= src_end)
3460 /* We found nothing other than ASCII. There's nothing to do. */
3461 return 0;
3463 c = *src;
3464 /* The text seems to be encoded in some multilingual coding system.
3465 Now, try to find in which coding system the text is encoded. */
3466 if (c < 0x80)
3468 /* i.e. (c == ISO_CODE_ESC || c == ISO_CODE_SI || c == ISO_CODE_SO) */
3469 /* C is an ISO2022 specific control code of C0. */
3470 mask = detect_coding_iso2022 (src, src_end);
3471 if (mask == 0)
3473 /* No valid ISO2022 code follows C. Try again. */
3474 src++;
3475 if (c == ISO_CODE_ESC)
3476 ascii_skip_code[ISO_CODE_ESC] = 1;
3477 else
3478 ascii_skip_code[ISO_CODE_SO] = ascii_skip_code[ISO_CODE_SI] = 1;
3479 goto label_loop_detect_coding;
3481 if (priorities)
3483 for (i = 0; i < CODING_CATEGORY_IDX_MAX; i++)
3485 if (mask & priorities[i])
3486 return priorities[i];
3488 return CODING_CATEGORY_MASK_RAW_TEXT;
3491 else
3493 int try;
3495 if (c < 0xA0)
3497 /* C is the first byte of SJIS character code,
3498 or a leading-code of Emacs' internal format (emacs-mule),
3499 or the first byte of UTF-16. */
3500 try = (CODING_CATEGORY_MASK_SJIS
3501 | CODING_CATEGORY_MASK_EMACS_MULE
3502 | CODING_CATEGORY_MASK_UTF_16_BE
3503 | CODING_CATEGORY_MASK_UTF_16_LE);
3505 /* Or, if C is a special latin extra code,
3506 or is an ISO2022 specific control code of C1 (SS2 or SS3),
3507 or is an ISO2022 control-sequence-introducer (CSI),
3508 we should also consider the possibility of ISO2022 codings. */
3509 if ((VECTORP (Vlatin_extra_code_table)
3510 && !NILP (XVECTOR (Vlatin_extra_code_table)->contents[c]))
3511 || (c == ISO_CODE_SS2 || c == ISO_CODE_SS3)
3512 || (c == ISO_CODE_CSI
3513 && (src < src_end
3514 && (*src == ']'
3515 || ((*src == '0' || *src == '1' || *src == '2')
3516 && src + 1 < src_end
3517 && src[1] == ']')))))
3518 try |= (CODING_CATEGORY_MASK_ISO_8_ELSE
3519 | CODING_CATEGORY_MASK_ISO_8BIT);
3521 else
3522 /* C is a character of ISO2022 in graphic plane right,
3523 or a SJIS's 1-byte character code (i.e. JISX0201),
3524 or the first byte of BIG5's 2-byte code,
3525 or the first byte of UTF-8/16. */
3526 try = (CODING_CATEGORY_MASK_ISO_8_ELSE
3527 | CODING_CATEGORY_MASK_ISO_8BIT
3528 | CODING_CATEGORY_MASK_SJIS
3529 | CODING_CATEGORY_MASK_BIG5
3530 | CODING_CATEGORY_MASK_UTF_8
3531 | CODING_CATEGORY_MASK_UTF_16_BE
3532 | CODING_CATEGORY_MASK_UTF_16_LE);
3534 /* Or, we may have to consider the possibility of CCL. */
3535 if (coding_system_table[CODING_CATEGORY_IDX_CCL]
3536 && (coding_system_table[CODING_CATEGORY_IDX_CCL]
3537 ->spec.ccl.valid_codes)[c])
3538 try |= CODING_CATEGORY_MASK_CCL;
3540 mask = 0;
3541 utf16_examined_p = iso2022_examined_p = 0;
3542 if (priorities)
3544 for (i = 0; i < CODING_CATEGORY_IDX_MAX; i++)
3546 if (!iso2022_examined_p
3547 && (priorities[i] & try & CODING_CATEGORY_MASK_ISO))
3549 mask |= detect_coding_iso2022 (src, src_end);
3550 iso2022_examined_p = 1;
3552 else if (priorities[i] & try & CODING_CATEGORY_MASK_SJIS)
3553 mask |= detect_coding_sjis (src, src_end);
3554 else if (priorities[i] & try & CODING_CATEGORY_MASK_UTF_8)
3555 mask |= detect_coding_utf_8 (src, src_end);
3556 else if (!utf16_examined_p
3557 && (priorities[i] & try &
3558 CODING_CATEGORY_MASK_UTF_16_BE_LE))
3560 mask |= detect_coding_utf_16 (src, src_end);
3561 utf16_examined_p = 1;
3563 else if (priorities[i] & try & CODING_CATEGORY_MASK_BIG5)
3564 mask |= detect_coding_big5 (src, src_end);
3565 else if (priorities[i] & try & CODING_CATEGORY_MASK_EMACS_MULE)
3566 mask |= detect_coding_emacs_mule (src, src_end);
3567 else if (priorities[i] & try & CODING_CATEGORY_MASK_CCL)
3568 mask |= detect_coding_ccl (src, src_end);
3569 else if (priorities[i] & CODING_CATEGORY_MASK_RAW_TEXT)
3570 mask |= CODING_CATEGORY_MASK_RAW_TEXT;
3571 else if (priorities[i] & CODING_CATEGORY_MASK_BINARY)
3572 mask |= CODING_CATEGORY_MASK_BINARY;
3573 if (mask & priorities[i])
3574 return priorities[i];
3576 return CODING_CATEGORY_MASK_RAW_TEXT;
3578 if (try & CODING_CATEGORY_MASK_ISO)
3579 mask |= detect_coding_iso2022 (src, src_end);
3580 if (try & CODING_CATEGORY_MASK_SJIS)
3581 mask |= detect_coding_sjis (src, src_end);
3582 if (try & CODING_CATEGORY_MASK_BIG5)
3583 mask |= detect_coding_big5 (src, src_end);
3584 if (try & CODING_CATEGORY_MASK_UTF_8)
3585 mask |= detect_coding_utf_8 (src, src_end);
3586 if (try & CODING_CATEGORY_MASK_UTF_16_BE_LE)
3587 mask |= detect_coding_utf_16 (src, src_end);
3588 if (try & CODING_CATEGORY_MASK_EMACS_MULE)
3589 mask |= detect_coding_emacs_mule (src, src_end);
3590 if (try & CODING_CATEGORY_MASK_CCL)
3591 mask |= detect_coding_ccl (src, src_end);
3593 return (mask | CODING_CATEGORY_MASK_RAW_TEXT | CODING_CATEGORY_MASK_BINARY);
3596 /* Detect how a text of length SRC_BYTES pointed by SRC is encoded.
3597 The information of the detected coding system is set in CODING. */
3599 void
3600 detect_coding (coding, src, src_bytes)
3601 struct coding_system *coding;
3602 unsigned char *src;
3603 int src_bytes;
3605 unsigned int idx;
3606 int skip, mask, i;
3607 Lisp_Object val;
3609 val = Vcoding_category_list;
3610 mask = detect_coding_mask (src, src_bytes, coding_priorities, &skip);
3611 coding->heading_ascii = skip;
3613 if (!mask) return;
3615 /* We found a single coding system of the highest priority in MASK. */
3616 idx = 0;
3617 while (mask && ! (mask & 1)) mask >>= 1, idx++;
3618 if (! mask)
3619 idx = CODING_CATEGORY_IDX_RAW_TEXT;
3621 val = XSYMBOL (XVECTOR (Vcoding_category_table)->contents[idx])->value;
3623 if (coding->eol_type != CODING_EOL_UNDECIDED)
3625 Lisp_Object tmp;
3627 tmp = Fget (val, Qeol_type);
3628 if (VECTORP (tmp))
3629 val = XVECTOR (tmp)->contents[coding->eol_type];
3632 /* Setup this new coding system while preserving some slots. */
3634 int src_multibyte = coding->src_multibyte;
3635 int dst_multibyte = coding->dst_multibyte;
3637 setup_coding_system (val, coding);
3638 coding->src_multibyte = src_multibyte;
3639 coding->dst_multibyte = dst_multibyte;
3640 coding->heading_ascii = skip;
3644 /* Detect how end-of-line of a text of length SRC_BYTES pointed by
3645 SOURCE is encoded. Return one of CODING_EOL_LF, CODING_EOL_CRLF,
3646 CODING_EOL_CR, and CODING_EOL_UNDECIDED.
3648 How many non-eol characters are at the head is returned as *SKIP. */
3650 #define MAX_EOL_CHECK_COUNT 3
3652 static int
3653 detect_eol_type (source, src_bytes, skip)
3654 unsigned char *source;
3655 int src_bytes, *skip;
3657 unsigned char *src = source, *src_end = src + src_bytes;
3658 unsigned char c;
3659 int total = 0; /* How many end-of-lines are found so far. */
3660 int eol_type = CODING_EOL_UNDECIDED;
3661 int this_eol_type;
3663 *skip = 0;
3665 while (src < src_end && total < MAX_EOL_CHECK_COUNT)
3667 c = *src++;
3668 if (c == '\n' || c == '\r')
3670 if (*skip == 0)
3671 *skip = src - 1 - source;
3672 total++;
3673 if (c == '\n')
3674 this_eol_type = CODING_EOL_LF;
3675 else if (src >= src_end || *src != '\n')
3676 this_eol_type = CODING_EOL_CR;
3677 else
3678 this_eol_type = CODING_EOL_CRLF, src++;
3680 if (eol_type == CODING_EOL_UNDECIDED)
3681 /* This is the first end-of-line. */
3682 eol_type = this_eol_type;
3683 else if (eol_type != this_eol_type)
3685 /* The found type is different from what found before. */
3686 eol_type = CODING_EOL_INCONSISTENT;
3687 break;
3692 if (*skip == 0)
3693 *skip = src_end - source;
3694 return eol_type;
3697 /* Like detect_eol_type, but detect EOL type in 2-octet
3698 big-endian/little-endian format for coding systems utf-16-be and
3699 utf-16-le. */
3701 static int
3702 detect_eol_type_in_2_octet_form (source, src_bytes, skip, big_endian_p)
3703 unsigned char *source;
3704 int src_bytes, *skip;
3706 unsigned char *src = source, *src_end = src + src_bytes;
3707 unsigned int c1, c2;
3708 int total = 0; /* How many end-of-lines are found so far. */
3709 int eol_type = CODING_EOL_UNDECIDED;
3710 int this_eol_type;
3711 int msb, lsb;
3713 if (big_endian_p)
3714 msb = 0, lsb = 1;
3715 else
3716 msb = 1, lsb = 0;
3718 *skip = 0;
3720 while ((src + 1) < src_end && total < MAX_EOL_CHECK_COUNT)
3722 c1 = (src[msb] << 8) | (src[lsb]);
3723 src += 2;
3725 if (c1 == '\n' || c1 == '\r')
3727 if (*skip == 0)
3728 *skip = src - 2 - source;
3729 total++;
3730 if (c1 == '\n')
3732 this_eol_type = CODING_EOL_LF;
3734 else
3736 if ((src + 1) >= src_end)
3738 this_eol_type = CODING_EOL_CR;
3740 else
3742 c2 = (src[msb] << 8) | (src[lsb]);
3743 if (c2 == '\n')
3744 this_eol_type = CODING_EOL_CRLF, src += 2;
3745 else
3746 this_eol_type = CODING_EOL_CR;
3750 if (eol_type == CODING_EOL_UNDECIDED)
3751 /* This is the first end-of-line. */
3752 eol_type = this_eol_type;
3753 else if (eol_type != this_eol_type)
3755 /* The found type is different from what found before. */
3756 eol_type = CODING_EOL_INCONSISTENT;
3757 break;
3762 if (*skip == 0)
3763 *skip = src_end - source;
3764 return eol_type;
3767 /* Detect how end-of-line of a text of length SRC_BYTES pointed by SRC
3768 is encoded. If it detects an appropriate format of end-of-line, it
3769 sets the information in *CODING. */
3771 void
3772 detect_eol (coding, src, src_bytes)
3773 struct coding_system *coding;
3774 unsigned char *src;
3775 int src_bytes;
3777 Lisp_Object val;
3778 int skip;
3779 int eol_type;
3781 switch (coding->category_idx)
3783 case CODING_CATEGORY_IDX_UTF_16_BE:
3784 eol_type = detect_eol_type_in_2_octet_form (src, src_bytes, &skip, 1);
3785 break;
3786 case CODING_CATEGORY_IDX_UTF_16_LE:
3787 eol_type = detect_eol_type_in_2_octet_form (src, src_bytes, &skip, 0);
3788 break;
3789 default:
3790 eol_type = detect_eol_type (src, src_bytes, &skip);
3791 break;
3794 if (coding->heading_ascii > skip)
3795 coding->heading_ascii = skip;
3796 else
3797 skip = coding->heading_ascii;
3799 if (eol_type == CODING_EOL_UNDECIDED)
3800 return;
3801 if (eol_type == CODING_EOL_INCONSISTENT)
3803 #if 0
3804 /* This code is suppressed until we find a better way to
3805 distinguish raw text file and binary file. */
3807 /* If we have already detected that the coding is raw-text, the
3808 coding should actually be no-conversion. */
3809 if (coding->type == coding_type_raw_text)
3811 setup_coding_system (Qno_conversion, coding);
3812 return;
3814 /* Else, let's decode only text code anyway. */
3815 #endif /* 0 */
3816 eol_type = CODING_EOL_LF;
3819 val = Fget (coding->symbol, Qeol_type);
3820 if (VECTORP (val) && XVECTOR (val)->size == 3)
3822 int src_multibyte = coding->src_multibyte;
3823 int dst_multibyte = coding->dst_multibyte;
3825 setup_coding_system (XVECTOR (val)->contents[eol_type], coding);
3826 coding->src_multibyte = src_multibyte;
3827 coding->dst_multibyte = dst_multibyte;
3828 coding->heading_ascii = skip;
3832 #define CONVERSION_BUFFER_EXTRA_ROOM 256
3834 #define DECODING_BUFFER_MAG(coding) \
3835 (coding->type == coding_type_iso2022 \
3836 ? 3 \
3837 : (coding->type == coding_type_ccl \
3838 ? coding->spec.ccl.decoder.buf_magnification \
3839 : 2))
3841 /* Return maximum size (bytes) of a buffer enough for decoding
3842 SRC_BYTES of text encoded in CODING. */
3845 decoding_buffer_size (coding, src_bytes)
3846 struct coding_system *coding;
3847 int src_bytes;
3849 return (src_bytes * DECODING_BUFFER_MAG (coding)
3850 + CONVERSION_BUFFER_EXTRA_ROOM);
3853 /* Return maximum size (bytes) of a buffer enough for encoding
3854 SRC_BYTES of text to CODING. */
3857 encoding_buffer_size (coding, src_bytes)
3858 struct coding_system *coding;
3859 int src_bytes;
3861 int magnification;
3863 if (coding->type == coding_type_ccl)
3864 magnification = coding->spec.ccl.encoder.buf_magnification;
3865 else if (CODING_REQUIRE_ENCODING (coding))
3866 magnification = 3;
3867 else
3868 magnification = 1;
3870 return (src_bytes * magnification + CONVERSION_BUFFER_EXTRA_ROOM);
3873 /* Working buffer for code conversion. */
3874 struct conversion_buffer
3876 int size; /* size of data. */
3877 int on_stack; /* 1 if allocated by alloca. */
3878 unsigned char *data;
3881 /* Don't use alloca for allocating memory space larger than this, lest
3882 we overflow their stack. */
3883 #define MAX_ALLOCA 16*1024
3885 /* Allocate LEN bytes of memory for BUF (struct conversion_buffer). */
3886 #define allocate_conversion_buffer(buf, len) \
3887 do { \
3888 if (len < MAX_ALLOCA) \
3890 buf.data = (unsigned char *) alloca (len); \
3891 buf.on_stack = 1; \
3893 else \
3895 buf.data = (unsigned char *) xmalloc (len); \
3896 buf.on_stack = 0; \
3898 buf.size = len; \
3899 } while (0)
3901 /* Double the allocated memory for *BUF. */
3902 static void
3903 extend_conversion_buffer (buf)
3904 struct conversion_buffer *buf;
3906 if (buf->on_stack)
3908 unsigned char *save = buf->data;
3909 buf->data = (unsigned char *) xmalloc (buf->size * 2);
3910 bcopy (save, buf->data, buf->size);
3911 buf->on_stack = 0;
3913 else
3915 buf->data = (unsigned char *) xrealloc (buf->data, buf->size * 2);
3917 buf->size *= 2;
3920 /* Free the allocated memory for BUF if it is not on stack. */
3921 static void
3922 free_conversion_buffer (buf)
3923 struct conversion_buffer *buf;
3925 if (!buf->on_stack)
3926 xfree (buf->data);
3930 ccl_coding_driver (coding, source, destination, src_bytes, dst_bytes, encodep)
3931 struct coding_system *coding;
3932 unsigned char *source, *destination;
3933 int src_bytes, dst_bytes, encodep;
3935 struct ccl_program *ccl
3936 = encodep ? &coding->spec.ccl.encoder : &coding->spec.ccl.decoder;
3937 int result;
3939 ccl->last_block = coding->mode & CODING_MODE_LAST_BLOCK;
3940 if (encodep)
3941 ccl->eol_type = coding->eol_type;
3942 ccl->multibyte = coding->src_multibyte;
3943 coding->produced = ccl_driver (ccl, source, destination,
3944 src_bytes, dst_bytes, &(coding->consumed));
3945 if (encodep)
3946 coding->produced_char = coding->produced;
3947 else
3949 int bytes
3950 = dst_bytes ? dst_bytes : source + coding->consumed - destination;
3951 coding->produced = str_as_multibyte (destination, bytes,
3952 coding->produced,
3953 &(coding->produced_char));
3956 switch (ccl->status)
3958 case CCL_STAT_SUSPEND_BY_SRC:
3959 coding->result = CODING_FINISH_INSUFFICIENT_SRC;
3960 break;
3961 case CCL_STAT_SUSPEND_BY_DST:
3962 coding->result = CODING_FINISH_INSUFFICIENT_DST;
3963 break;
3964 case CCL_STAT_QUIT:
3965 case CCL_STAT_INVALID_CMD:
3966 coding->result = CODING_FINISH_INTERRUPT;
3967 break;
3968 default:
3969 coding->result = CODING_FINISH_NORMAL;
3970 break;
3972 return coding->result;
3975 /* Decode EOL format of the text at PTR of BYTES length destructively
3976 according to CODING->eol_type. This is called after the CCL
3977 program produced a decoded text at PTR. If we do CRLF->LF
3978 conversion, update CODING->produced and CODING->produced_char. */
3980 static void
3981 decode_eol_post_ccl (coding, ptr, bytes)
3982 struct coding_system *coding;
3983 unsigned char *ptr;
3984 int bytes;
3986 Lisp_Object val, saved_coding_symbol;
3987 unsigned char *pend = ptr + bytes;
3988 int dummy;
3990 /* Remember the current coding system symbol. We set it back when
3991 an inconsistent EOL is found so that `last-coding-system-used' is
3992 set to the coding system that doesn't specify EOL conversion. */
3993 saved_coding_symbol = coding->symbol;
3995 coding->spec.ccl.cr_carryover = 0;
3996 if (coding->eol_type == CODING_EOL_UNDECIDED)
3998 /* Here, to avoid the call of setup_coding_system, we directly
3999 call detect_eol_type. */
4000 coding->eol_type = detect_eol_type (ptr, bytes, &dummy);
4001 if (coding->eol_type == CODING_EOL_INCONSISTENT)
4002 coding->eol_type = CODING_EOL_LF;
4003 if (coding->eol_type != CODING_EOL_UNDECIDED)
4005 val = Fget (coding->symbol, Qeol_type);
4006 if (VECTORP (val) && XVECTOR (val)->size == 3)
4007 coding->symbol = XVECTOR (val)->contents[coding->eol_type];
4009 coding->mode |= CODING_MODE_INHIBIT_INCONSISTENT_EOL;
4012 if (coding->eol_type == CODING_EOL_LF
4013 || coding->eol_type == CODING_EOL_UNDECIDED)
4015 /* We have nothing to do. */
4016 ptr = pend;
4018 else if (coding->eol_type == CODING_EOL_CRLF)
4020 unsigned char *pstart = ptr, *p = ptr;
4022 if (! (coding->mode & CODING_MODE_LAST_BLOCK)
4023 && *(pend - 1) == '\r')
4025 /* If the last character is CR, we can't handle it here
4026 because LF will be in the not-yet-decoded source text.
4027 Recorded that the CR is not yet processed. */
4028 coding->spec.ccl.cr_carryover = 1;
4029 coding->produced--;
4030 coding->produced_char--;
4031 pend--;
4033 while (ptr < pend)
4035 if (*ptr == '\r')
4037 if (ptr + 1 < pend && *(ptr + 1) == '\n')
4039 *p++ = '\n';
4040 ptr += 2;
4042 else
4044 if (coding->mode & CODING_MODE_INHIBIT_INCONSISTENT_EOL)
4045 goto undo_eol_conversion;
4046 *p++ = *ptr++;
4049 else if (*ptr == '\n'
4050 && coding->mode & CODING_MODE_INHIBIT_INCONSISTENT_EOL)
4051 goto undo_eol_conversion;
4052 else
4053 *p++ = *ptr++;
4054 continue;
4056 undo_eol_conversion:
4057 /* We have faced with inconsistent EOL format at PTR.
4058 Convert all LFs before PTR back to CRLFs. */
4059 for (p--, ptr--; p >= pstart; p--)
4061 if (*p == '\n')
4062 *ptr-- = '\n', *ptr-- = '\r';
4063 else
4064 *ptr-- = *p;
4066 /* If carryover is recorded, cancel it because we don't
4067 convert CRLF anymore. */
4068 if (coding->spec.ccl.cr_carryover)
4070 coding->spec.ccl.cr_carryover = 0;
4071 coding->produced++;
4072 coding->produced_char++;
4073 pend++;
4075 p = ptr = pend;
4076 coding->eol_type = CODING_EOL_LF;
4077 coding->symbol = saved_coding_symbol;
4079 if (p < pend)
4081 /* As each two-byte sequence CRLF was converted to LF, (PEND
4082 - P) is the number of deleted characters. */
4083 coding->produced -= pend - p;
4084 coding->produced_char -= pend - p;
4087 else /* i.e. coding->eol_type == CODING_EOL_CR */
4089 unsigned char *p = ptr;
4091 for (; ptr < pend; ptr++)
4093 if (*ptr == '\r')
4094 *ptr = '\n';
4095 else if (*ptr == '\n'
4096 && coding->mode & CODING_MODE_INHIBIT_INCONSISTENT_EOL)
4098 for (; p < ptr; p++)
4100 if (*p == '\n')
4101 *p = '\r';
4103 ptr = pend;
4104 coding->eol_type = CODING_EOL_LF;
4105 coding->symbol = saved_coding_symbol;
4111 /* See "GENERAL NOTES about `decode_coding_XXX ()' functions". Before
4112 decoding, it may detect coding system and format of end-of-line if
4113 those are not yet decided. The source should be unibyte, the
4114 result is multibyte if CODING->dst_multibyte is nonzero, else
4115 unibyte. */
4118 decode_coding (coding, source, destination, src_bytes, dst_bytes)
4119 struct coding_system *coding;
4120 unsigned char *source, *destination;
4121 int src_bytes, dst_bytes;
4123 if (coding->type == coding_type_undecided)
4124 detect_coding (coding, source, src_bytes);
4126 if (coding->eol_type == CODING_EOL_UNDECIDED
4127 && coding->type != coding_type_ccl)
4128 detect_eol (coding, source, src_bytes);
4130 coding->produced = coding->produced_char = 0;
4131 coding->consumed = coding->consumed_char = 0;
4132 coding->errors = 0;
4133 coding->result = CODING_FINISH_NORMAL;
4135 switch (coding->type)
4137 case coding_type_sjis:
4138 decode_coding_sjis_big5 (coding, source, destination,
4139 src_bytes, dst_bytes, 1);
4140 break;
4142 case coding_type_iso2022:
4143 decode_coding_iso2022 (coding, source, destination,
4144 src_bytes, dst_bytes);
4145 break;
4147 case coding_type_big5:
4148 decode_coding_sjis_big5 (coding, source, destination,
4149 src_bytes, dst_bytes, 0);
4150 break;
4152 case coding_type_emacs_mule:
4153 decode_coding_emacs_mule (coding, source, destination,
4154 src_bytes, dst_bytes);
4155 break;
4157 case coding_type_ccl:
4158 if (coding->spec.ccl.cr_carryover)
4160 /* Set the CR which is not processed by the previous call of
4161 decode_eol_post_ccl in DESTINATION. */
4162 *destination = '\r';
4163 coding->produced++;
4164 coding->produced_char++;
4165 dst_bytes--;
4167 ccl_coding_driver (coding, source,
4168 destination + coding->spec.ccl.cr_carryover,
4169 src_bytes, dst_bytes, 0);
4170 if (coding->eol_type != CODING_EOL_LF)
4171 decode_eol_post_ccl (coding, destination, coding->produced);
4172 break;
4174 default:
4175 decode_eol (coding, source, destination, src_bytes, dst_bytes);
4178 if (coding->result == CODING_FINISH_INSUFFICIENT_SRC
4179 && coding->consumed == src_bytes)
4180 coding->result = CODING_FINISH_NORMAL;
4182 if (coding->mode & CODING_MODE_LAST_BLOCK
4183 && coding->result == CODING_FINISH_INSUFFICIENT_SRC)
4185 unsigned char *src = source + coding->consumed;
4186 unsigned char *dst = destination + coding->produced;
4188 src_bytes -= coding->consumed;
4189 coding->errors++;
4190 if (COMPOSING_P (coding))
4191 DECODE_COMPOSITION_END ('1');
4192 while (src_bytes--)
4194 int c = *src++;
4195 dst += CHAR_STRING (c, dst);
4196 coding->produced_char++;
4198 coding->consumed = coding->consumed_char = src - source;
4199 coding->produced = dst - destination;
4200 coding->result = CODING_FINISH_NORMAL;
4203 if (!coding->dst_multibyte)
4205 coding->produced = str_as_unibyte (destination, coding->produced);
4206 coding->produced_char = coding->produced;
4209 return coding->result;
4212 /* See "GENERAL NOTES about `encode_coding_XXX ()' functions". The
4213 multibyteness of the source is CODING->src_multibyte, the
4214 multibyteness of the result is always unibyte. */
4217 encode_coding (coding, source, destination, src_bytes, dst_bytes)
4218 struct coding_system *coding;
4219 unsigned char *source, *destination;
4220 int src_bytes, dst_bytes;
4222 coding->produced = coding->produced_char = 0;
4223 coding->consumed = coding->consumed_char = 0;
4224 coding->errors = 0;
4225 coding->result = CODING_FINISH_NORMAL;
4227 switch (coding->type)
4229 case coding_type_sjis:
4230 encode_coding_sjis_big5 (coding, source, destination,
4231 src_bytes, dst_bytes, 1);
4232 break;
4234 case coding_type_iso2022:
4235 encode_coding_iso2022 (coding, source, destination,
4236 src_bytes, dst_bytes);
4237 break;
4239 case coding_type_big5:
4240 encode_coding_sjis_big5 (coding, source, destination,
4241 src_bytes, dst_bytes, 0);
4242 break;
4244 case coding_type_emacs_mule:
4245 encode_coding_emacs_mule (coding, source, destination,
4246 src_bytes, dst_bytes);
4247 break;
4249 case coding_type_ccl:
4250 ccl_coding_driver (coding, source, destination,
4251 src_bytes, dst_bytes, 1);
4252 break;
4254 default:
4255 encode_eol (coding, source, destination, src_bytes, dst_bytes);
4258 if (coding->mode & CODING_MODE_LAST_BLOCK
4259 && coding->result == CODING_FINISH_INSUFFICIENT_SRC)
4261 unsigned char *src = source + coding->consumed;
4262 unsigned char *src_end = src + src_bytes;
4263 unsigned char *dst = destination + coding->produced;
4265 if (coding->type == coding_type_iso2022)
4266 ENCODE_RESET_PLANE_AND_REGISTER;
4267 if (COMPOSING_P (coding))
4268 *dst++ = ISO_CODE_ESC, *dst++ = '1';
4269 if (coding->consumed < src_bytes)
4271 int len = src_bytes - coding->consumed;
4273 BCOPY_SHORT (source + coding->consumed, dst, len);
4274 if (coding->src_multibyte)
4275 len = str_as_unibyte (dst, len);
4276 dst += len;
4277 coding->consumed = src_bytes;
4279 coding->produced = coding->produced_char = dst - destination;
4280 coding->result = CODING_FINISH_NORMAL;
4283 if (coding->result == CODING_FINISH_INSUFFICIENT_SRC
4284 && coding->consumed == src_bytes)
4285 coding->result = CODING_FINISH_NORMAL;
4287 return coding->result;
4290 /* Scan text in the region between *BEG and *END (byte positions),
4291 skip characters which we don't have to decode by coding system
4292 CODING at the head and tail, then set *BEG and *END to the region
4293 of the text we actually have to convert. The caller should move
4294 the gap out of the region in advance if the region is from a
4295 buffer.
4297 If STR is not NULL, *BEG and *END are indices into STR. */
4299 static void
4300 shrink_decoding_region (beg, end, coding, str)
4301 int *beg, *end;
4302 struct coding_system *coding;
4303 unsigned char *str;
4305 unsigned char *begp_orig, *begp, *endp_orig, *endp, c;
4306 int eol_conversion;
4307 Lisp_Object translation_table;
4309 if (coding->type == coding_type_ccl
4310 || coding->type == coding_type_undecided
4311 || coding->eol_type != CODING_EOL_LF
4312 || !NILP (coding->post_read_conversion)
4313 || coding->composing != COMPOSITION_DISABLED)
4315 /* We can't skip any data. */
4316 return;
4318 if (coding->type == coding_type_no_conversion
4319 || coding->type == coding_type_raw_text
4320 || coding->type == coding_type_emacs_mule)
4322 /* We need no conversion, but don't have to skip any data here.
4323 Decoding routine handles them effectively anyway. */
4324 return;
4327 translation_table = coding->translation_table_for_decode;
4328 if (NILP (translation_table) && !NILP (Venable_character_translation))
4329 translation_table = Vstandard_translation_table_for_decode;
4330 if (CHAR_TABLE_P (translation_table))
4332 int i;
4333 for (i = 0; i < 128; i++)
4334 if (!NILP (CHAR_TABLE_REF (translation_table, i)))
4335 break;
4336 if (i < 128)
4337 /* Some ASCII character should be translated. We give up
4338 shrinking. */
4339 return;
4342 if (coding->heading_ascii >= 0)
4343 /* Detection routine has already found how much we can skip at the
4344 head. */
4345 *beg += coding->heading_ascii;
4347 if (str)
4349 begp_orig = begp = str + *beg;
4350 endp_orig = endp = str + *end;
4352 else
4354 begp_orig = begp = BYTE_POS_ADDR (*beg);
4355 endp_orig = endp = begp + *end - *beg;
4358 eol_conversion = (coding->eol_type == CODING_EOL_CR
4359 || coding->eol_type == CODING_EOL_CRLF);
4361 switch (coding->type)
4363 case coding_type_sjis:
4364 case coding_type_big5:
4365 /* We can skip all ASCII characters at the head. */
4366 if (coding->heading_ascii < 0)
4368 if (eol_conversion)
4369 while (begp < endp && *begp < 0x80 && *begp != '\r') begp++;
4370 else
4371 while (begp < endp && *begp < 0x80) begp++;
4373 /* We can skip all ASCII characters at the tail except for the
4374 second byte of SJIS or BIG5 code. */
4375 if (eol_conversion)
4376 while (begp < endp && endp[-1] < 0x80 && endp[-1] != '\r') endp--;
4377 else
4378 while (begp < endp && endp[-1] < 0x80) endp--;
4379 /* Do not consider LF as ascii if preceded by CR, since that
4380 confuses eol decoding. */
4381 if (begp < endp && endp < endp_orig && endp[-1] == '\r' && endp[0] == '\n')
4382 endp++;
4383 if (begp < endp && endp < endp_orig && endp[-1] >= 0x80)
4384 endp++;
4385 break;
4387 case coding_type_iso2022:
4388 if (CODING_SPEC_ISO_INITIAL_DESIGNATION (coding, 0) != CHARSET_ASCII)
4389 /* We can't skip any data. */
4390 break;
4391 if (coding->heading_ascii < 0)
4393 /* We can skip all ASCII characters at the head except for a
4394 few control codes. */
4395 while (begp < endp && (c = *begp) < 0x80
4396 && c != ISO_CODE_CR && c != ISO_CODE_SO
4397 && c != ISO_CODE_SI && c != ISO_CODE_ESC
4398 && (!eol_conversion || c != ISO_CODE_LF))
4399 begp++;
4401 switch (coding->category_idx)
4403 case CODING_CATEGORY_IDX_ISO_8_1:
4404 case CODING_CATEGORY_IDX_ISO_8_2:
4405 /* We can skip all ASCII characters at the tail. */
4406 if (eol_conversion)
4407 while (begp < endp && (c = endp[-1]) < 0x80 && c != '\r') endp--;
4408 else
4409 while (begp < endp && endp[-1] < 0x80) endp--;
4410 /* Do not consider LF as ascii if preceded by CR, since that
4411 confuses eol decoding. */
4412 if (begp < endp && endp < endp_orig && endp[-1] == '\r' && endp[0] == '\n')
4413 endp++;
4414 break;
4416 case CODING_CATEGORY_IDX_ISO_7:
4417 case CODING_CATEGORY_IDX_ISO_7_TIGHT:
4419 /* We can skip all charactes at the tail except for 8-bit
4420 codes and ESC and the following 2-byte at the tail. */
4421 unsigned char *eight_bit = NULL;
4423 if (eol_conversion)
4424 while (begp < endp
4425 && (c = endp[-1]) != ISO_CODE_ESC && c != '\r')
4427 if (!eight_bit && c & 0x80) eight_bit = endp;
4428 endp--;
4430 else
4431 while (begp < endp
4432 && (c = endp[-1]) != ISO_CODE_ESC)
4434 if (!eight_bit && c & 0x80) eight_bit = endp;
4435 endp--;
4437 /* Do not consider LF as ascii if preceded by CR, since that
4438 confuses eol decoding. */
4439 if (begp < endp && endp < endp_orig
4440 && endp[-1] == '\r' && endp[0] == '\n')
4441 endp++;
4442 if (begp < endp && endp[-1] == ISO_CODE_ESC)
4444 if (endp + 1 < endp_orig && end[0] == '(' && end[1] == 'B')
4445 /* This is an ASCII designation sequence. We can
4446 surely skip the tail. But, if we have
4447 encountered an 8-bit code, skip only the codes
4448 after that. */
4449 endp = eight_bit ? eight_bit : endp + 2;
4450 else
4451 /* Hmmm, we can't skip the tail. */
4452 endp = endp_orig;
4454 else if (eight_bit)
4455 endp = eight_bit;
4458 break;
4460 default:
4461 abort ();
4463 *beg += begp - begp_orig;
4464 *end += endp - endp_orig;
4465 return;
4468 /* Like shrink_decoding_region but for encoding. */
4470 static void
4471 shrink_encoding_region (beg, end, coding, str)
4472 int *beg, *end;
4473 struct coding_system *coding;
4474 unsigned char *str;
4476 unsigned char *begp_orig, *begp, *endp_orig, *endp;
4477 int eol_conversion;
4478 Lisp_Object translation_table;
4480 if (coding->type == coding_type_ccl
4481 || coding->eol_type == CODING_EOL_CRLF
4482 || coding->eol_type == CODING_EOL_CR
4483 || coding->cmp_data && coding->cmp_data->used > 0)
4485 /* We can't skip any data. */
4486 return;
4488 if (coding->type == coding_type_no_conversion
4489 || coding->type == coding_type_raw_text
4490 || coding->type == coding_type_emacs_mule
4491 || coding->type == coding_type_undecided)
4493 /* We need no conversion, but don't have to skip any data here.
4494 Encoding routine handles them effectively anyway. */
4495 return;
4498 translation_table = coding->translation_table_for_encode;
4499 if (NILP (translation_table) && !NILP (Venable_character_translation))
4500 translation_table = Vstandard_translation_table_for_encode;
4501 if (CHAR_TABLE_P (translation_table))
4503 int i;
4504 for (i = 0; i < 128; i++)
4505 if (!NILP (CHAR_TABLE_REF (translation_table, i)))
4506 break;
4507 if (i < 128)
4508 /* Some ASCII character should be tranlsated. We give up
4509 shrinking. */
4510 return;
4513 if (str)
4515 begp_orig = begp = str + *beg;
4516 endp_orig = endp = str + *end;
4518 else
4520 begp_orig = begp = BYTE_POS_ADDR (*beg);
4521 endp_orig = endp = begp + *end - *beg;
4524 eol_conversion = (coding->eol_type == CODING_EOL_CR
4525 || coding->eol_type == CODING_EOL_CRLF);
4527 /* Here, we don't have to check coding->pre_write_conversion because
4528 the caller is expected to have handled it already. */
4529 switch (coding->type)
4531 case coding_type_iso2022:
4532 if (CODING_SPEC_ISO_INITIAL_DESIGNATION (coding, 0) != CHARSET_ASCII)
4533 /* We can't skip any data. */
4534 break;
4535 if (coding->flags & CODING_FLAG_ISO_DESIGNATE_AT_BOL)
4537 unsigned char *bol = begp;
4538 while (begp < endp && *begp < 0x80)
4540 begp++;
4541 if (begp[-1] == '\n')
4542 bol = begp;
4544 begp = bol;
4545 goto label_skip_tail;
4547 /* fall down ... */
4549 case coding_type_sjis:
4550 case coding_type_big5:
4551 /* We can skip all ASCII characters at the head and tail. */
4552 if (eol_conversion)
4553 while (begp < endp && *begp < 0x80 && *begp != '\n') begp++;
4554 else
4555 while (begp < endp && *begp < 0x80) begp++;
4556 label_skip_tail:
4557 if (eol_conversion)
4558 while (begp < endp && endp[-1] < 0x80 && endp[-1] != '\n') endp--;
4559 else
4560 while (begp < endp && *(endp - 1) < 0x80) endp--;
4561 break;
4563 default:
4564 abort ();
4567 *beg += begp - begp_orig;
4568 *end += endp - endp_orig;
4569 return;
4572 /* As shrinking conversion region requires some overhead, we don't try
4573 shrinking if the length of conversion region is less than this
4574 value. */
4575 static int shrink_conversion_region_threshhold = 1024;
4577 #define SHRINK_CONVERSION_REGION(beg, end, coding, str, encodep) \
4578 do { \
4579 if (*(end) - *(beg) > shrink_conversion_region_threshhold) \
4581 if (encodep) shrink_encoding_region (beg, end, coding, str); \
4582 else shrink_decoding_region (beg, end, coding, str); \
4584 } while (0)
4586 static Lisp_Object
4587 code_convert_region_unwind (dummy)
4588 Lisp_Object dummy;
4590 inhibit_pre_post_conversion = 0;
4591 return Qnil;
4594 /* Store information about all compositions in the range FROM and TO
4595 of OBJ in memory blocks pointed by CODING->cmp_data. OBJ is a
4596 buffer or a string, defaults to the current buffer. */
4598 void
4599 coding_save_composition (coding, from, to, obj)
4600 struct coding_system *coding;
4601 int from, to;
4602 Lisp_Object obj;
4604 Lisp_Object prop;
4605 int start, end;
4607 if (coding->composing == COMPOSITION_DISABLED)
4608 return;
4609 if (!coding->cmp_data)
4610 coding_allocate_composition_data (coding, from);
4611 if (!find_composition (from, to, &start, &end, &prop, obj)
4612 || end > to)
4613 return;
4614 if (start < from
4615 && (!find_composition (end, to, &start, &end, &prop, obj)
4616 || end > to))
4617 return;
4618 coding->composing = COMPOSITION_NO;
4621 if (COMPOSITION_VALID_P (start, end, prop))
4623 enum composition_method method = COMPOSITION_METHOD (prop);
4624 if (coding->cmp_data->used + COMPOSITION_DATA_MAX_BUNCH_LENGTH
4625 >= COMPOSITION_DATA_SIZE)
4626 coding_allocate_composition_data (coding, from);
4627 /* For relative composition, we remember start and end
4628 positions, for the other compositions, we also remember
4629 components. */
4630 CODING_ADD_COMPOSITION_START (coding, start - from, method);
4631 if (method != COMPOSITION_RELATIVE)
4633 /* We must store a*/
4634 Lisp_Object val, ch;
4636 val = COMPOSITION_COMPONENTS (prop);
4637 if (CONSP (val))
4638 while (CONSP (val))
4640 ch = XCAR (val), val = XCDR (val);
4641 CODING_ADD_COMPOSITION_COMPONENT (coding, XINT (ch));
4643 else if (VECTORP (val) || STRINGP (val))
4645 int len = (VECTORP (val)
4646 ? XVECTOR (val)->size : XSTRING (val)->size);
4647 int i;
4648 for (i = 0; i < len; i++)
4650 ch = (STRINGP (val)
4651 ? Faref (val, make_number (i))
4652 : XVECTOR (val)->contents[i]);
4653 CODING_ADD_COMPOSITION_COMPONENT (coding, XINT (ch));
4656 else /* INTEGERP (val) */
4657 CODING_ADD_COMPOSITION_COMPONENT (coding, XINT (val));
4659 CODING_ADD_COMPOSITION_END (coding, end - from);
4661 start = end;
4663 while (start < to
4664 && find_composition (start, to, &start, &end, &prop, obj)
4665 && end <= to);
4667 /* Make coding->cmp_data point to the first memory block. */
4668 while (coding->cmp_data->prev)
4669 coding->cmp_data = coding->cmp_data->prev;
4670 coding->cmp_data_start = 0;
4673 /* Reflect the saved information about compositions to OBJ.
4674 CODING->cmp_data points to a memory block for the informaiton. OBJ
4675 is a buffer or a string, defaults to the current buffer. */
4677 void
4678 coding_restore_composition (coding, obj)
4679 struct coding_system *coding;
4680 Lisp_Object obj;
4682 struct composition_data *cmp_data = coding->cmp_data;
4684 if (!cmp_data)
4685 return;
4687 while (cmp_data->prev)
4688 cmp_data = cmp_data->prev;
4690 while (cmp_data)
4692 int i;
4694 for (i = 0; i < cmp_data->used && cmp_data->data[i] > 0;
4695 i += cmp_data->data[i])
4697 int *data = cmp_data->data + i;
4698 enum composition_method method = (enum composition_method) data[3];
4699 Lisp_Object components;
4701 if (method == COMPOSITION_RELATIVE)
4702 components = Qnil;
4703 else
4705 int len = data[0] - 4, j;
4706 Lisp_Object args[MAX_COMPOSITION_COMPONENTS * 2 - 1];
4708 for (j = 0; j < len; j++)
4709 args[j] = make_number (data[4 + j]);
4710 components = (method == COMPOSITION_WITH_ALTCHARS
4711 ? Fstring (len, args) : Fvector (len, args));
4713 compose_text (data[1], data[2], components, Qnil, obj);
4715 cmp_data = cmp_data->next;
4719 /* Decode (if ENCODEP is zero) or encode (if ENCODEP is nonzero) the
4720 text from FROM to TO (byte positions are FROM_BYTE and TO_BYTE) by
4721 coding system CODING, and return the status code of code conversion
4722 (currently, this value has no meaning).
4724 How many characters (and bytes) are converted to how many
4725 characters (and bytes) are recorded in members of the structure
4726 CODING.
4728 If REPLACE is nonzero, we do various things as if the original text
4729 is deleted and a new text is inserted. See the comments in
4730 replace_range (insdel.c) to know what we are doing.
4732 If REPLACE is zero, it is assumed that the source text is unibyte.
4733 Otherwize, it is assumed that the source text is multibyte. */
4736 code_convert_region (from, from_byte, to, to_byte, coding, encodep, replace)
4737 int from, from_byte, to, to_byte, encodep, replace;
4738 struct coding_system *coding;
4740 int len = to - from, len_byte = to_byte - from_byte;
4741 int require, inserted, inserted_byte;
4742 int head_skip, tail_skip, total_skip = 0;
4743 Lisp_Object saved_coding_symbol;
4744 int first = 1;
4745 unsigned char *src, *dst;
4746 Lisp_Object deletion;
4747 int orig_point = PT, orig_len = len;
4748 int prev_Z;
4749 int multibyte_p = !NILP (current_buffer->enable_multibyte_characters);
4751 coding->src_multibyte = replace && multibyte_p;
4752 coding->dst_multibyte = multibyte_p;
4754 deletion = Qnil;
4755 saved_coding_symbol = Qnil;
4757 if (from < PT && PT < to)
4759 TEMP_SET_PT_BOTH (from, from_byte);
4760 orig_point = from;
4763 if (replace)
4765 int saved_from = from;
4766 int saved_inhibit_modification_hooks;
4768 prepare_to_modify_buffer (from, to, &from);
4769 if (saved_from != from)
4771 to = from + len;
4772 from_byte = CHAR_TO_BYTE (from), to_byte = CHAR_TO_BYTE (to);
4773 len_byte = to_byte - from_byte;
4776 /* The code conversion routine can not preserve text properties
4777 for now. So, we must remove all text properties in the
4778 region. Here, we must suppress all modification hooks. */
4779 saved_inhibit_modification_hooks = inhibit_modification_hooks;
4780 inhibit_modification_hooks = 1;
4781 Fset_text_properties (make_number (from), make_number (to), Qnil, Qnil);
4782 inhibit_modification_hooks = saved_inhibit_modification_hooks;
4785 if (! encodep && CODING_REQUIRE_DETECTION (coding))
4787 /* We must detect encoding of text and eol format. */
4789 if (from < GPT && to > GPT)
4790 move_gap_both (from, from_byte);
4791 if (coding->type == coding_type_undecided)
4793 detect_coding (coding, BYTE_POS_ADDR (from_byte), len_byte);
4794 if (coding->type == coding_type_undecided)
4795 /* It seems that the text contains only ASCII, but we
4796 should not left it undecided because the deeper
4797 decoding routine (decode_coding) tries to detect the
4798 encodings again in vain. */
4799 coding->type = coding_type_emacs_mule;
4801 if (coding->eol_type == CODING_EOL_UNDECIDED
4802 && coding->type != coding_type_ccl)
4804 saved_coding_symbol = coding->symbol;
4805 detect_eol (coding, BYTE_POS_ADDR (from_byte), len_byte);
4806 if (coding->eol_type == CODING_EOL_UNDECIDED)
4807 coding->eol_type = CODING_EOL_LF;
4808 /* We had better recover the original eol format if we
4809 encounter an inconsitent eol format while decoding. */
4810 coding->mode |= CODING_MODE_INHIBIT_INCONSISTENT_EOL;
4814 /* Now we convert the text. */
4816 /* For encoding, we must process pre-write-conversion in advance. */
4817 if (! inhibit_pre_post_conversion
4818 && encodep
4819 && SYMBOLP (coding->pre_write_conversion)
4820 && ! NILP (Ffboundp (coding->pre_write_conversion)))
4822 /* The function in pre-write-conversion may put a new text in a
4823 new buffer. */
4824 struct buffer *prev = current_buffer;
4825 Lisp_Object new;
4826 int count = specpdl_ptr - specpdl;
4828 record_unwind_protect (code_convert_region_unwind, Qnil);
4829 /* We should not call any more pre-write/post-read-conversion
4830 functions while this pre-write-conversion is running. */
4831 inhibit_pre_post_conversion = 1;
4832 call2 (coding->pre_write_conversion,
4833 make_number (from), make_number (to));
4834 inhibit_pre_post_conversion = 0;
4835 /* Discard the unwind protect. */
4836 specpdl_ptr--;
4838 if (current_buffer != prev)
4840 len = ZV - BEGV;
4841 new = Fcurrent_buffer ();
4842 set_buffer_internal_1 (prev);
4843 del_range_2 (from, from_byte, to, to_byte, 0);
4844 TEMP_SET_PT_BOTH (from, from_byte);
4845 insert_from_buffer (XBUFFER (new), 1, len, 0);
4846 Fkill_buffer (new);
4847 if (orig_point >= to)
4848 orig_point += len - orig_len;
4849 else if (orig_point > from)
4850 orig_point = from;
4851 orig_len = len;
4852 to = from + len;
4853 from_byte = CHAR_TO_BYTE (from);
4854 to_byte = CHAR_TO_BYTE (to);
4855 len_byte = to_byte - from_byte;
4856 TEMP_SET_PT_BOTH (from, from_byte);
4860 if (replace)
4861 deletion = make_buffer_string_both (from, from_byte, to, to_byte, 1);
4863 if (coding->composing != COMPOSITION_DISABLED)
4865 if (encodep)
4866 coding_save_composition (coding, from, to, Fcurrent_buffer ());
4867 else
4868 coding_allocate_composition_data (coding, from);
4871 /* Try to skip the heading and tailing ASCIIs. */
4872 if (coding->type != coding_type_ccl)
4874 int from_byte_orig = from_byte, to_byte_orig = to_byte;
4876 if (from < GPT && GPT < to)
4877 move_gap_both (from, from_byte);
4878 SHRINK_CONVERSION_REGION (&from_byte, &to_byte, coding, NULL, encodep);
4879 if (from_byte == to_byte
4880 && (encodep || NILP (coding->post_read_conversion))
4881 && ! CODING_REQUIRE_FLUSHING (coding))
4883 coding->produced = len_byte;
4884 coding->produced_char = len;
4885 if (!replace)
4886 /* We must record and adjust for this new text now. */
4887 adjust_after_insert (from, from_byte_orig, to, to_byte_orig, len);
4888 return 0;
4891 head_skip = from_byte - from_byte_orig;
4892 tail_skip = to_byte_orig - to_byte;
4893 total_skip = head_skip + tail_skip;
4894 from += head_skip;
4895 to -= tail_skip;
4896 len -= total_skip; len_byte -= total_skip;
4899 /* For converion, we must put the gap before the text in addition to
4900 making the gap larger for efficient decoding. The required gap
4901 size starts from 2000 which is the magic number used in make_gap.
4902 But, after one batch of conversion, it will be incremented if we
4903 find that it is not enough . */
4904 require = 2000;
4906 if (GAP_SIZE < require)
4907 make_gap (require - GAP_SIZE);
4908 move_gap_both (from, from_byte);
4910 inserted = inserted_byte = 0;
4912 GAP_SIZE += len_byte;
4913 ZV -= len;
4914 Z -= len;
4915 ZV_BYTE -= len_byte;
4916 Z_BYTE -= len_byte;
4918 if (GPT - BEG < BEG_UNCHANGED)
4919 BEG_UNCHANGED = GPT - BEG;
4920 if (Z - GPT < END_UNCHANGED)
4921 END_UNCHANGED = Z - GPT;
4923 if (!encodep && coding->src_multibyte)
4925 /* Decoding routines expects that the source text is unibyte.
4926 We must convert 8-bit characters of multibyte form to
4927 unibyte. */
4928 int len_byte_orig = len_byte;
4929 len_byte = str_as_unibyte (GAP_END_ADDR - len_byte, len_byte);
4930 if (len_byte < len_byte_orig)
4931 safe_bcopy (GAP_END_ADDR - len_byte_orig, GAP_END_ADDR - len_byte,
4932 len_byte);
4933 coding->src_multibyte = 0;
4936 for (;;)
4938 int result;
4940 /* The buffer memory is now:
4941 +--------+converted-text+---------+-------original-text-------+---+
4942 |<-from->|<--inserted-->|---------|<--------len_byte--------->|---|
4943 |<---------------------- GAP ----------------------->| */
4944 src = GAP_END_ADDR - len_byte;
4945 dst = GPT_ADDR + inserted_byte;
4947 if (encodep)
4948 result = encode_coding (coding, src, dst, len_byte, 0);
4949 else
4950 result = decode_coding (coding, src, dst, len_byte, 0);
4952 /* The buffer memory is now:
4953 +--------+-------converted-text----+--+------original-text----+---+
4954 |<-from->|<-inserted->|<-produced->|--|<-(len_byte-consumed)->|---|
4955 |<---------------------- GAP ----------------------->| */
4957 inserted += coding->produced_char;
4958 inserted_byte += coding->produced;
4959 len_byte -= coding->consumed;
4961 if (result == CODING_FINISH_INSUFFICIENT_CMP)
4963 coding_allocate_composition_data (coding, from + inserted);
4964 continue;
4967 src += coding->consumed;
4968 dst += coding->produced;
4970 if (result == CODING_FINISH_NORMAL)
4972 src += len_byte;
4973 break;
4975 if (! encodep && result == CODING_FINISH_INCONSISTENT_EOL)
4977 unsigned char *pend = dst, *p = pend - inserted_byte;
4978 Lisp_Object eol_type;
4980 /* Encode LFs back to the original eol format (CR or CRLF). */
4981 if (coding->eol_type == CODING_EOL_CR)
4983 while (p < pend) if (*p++ == '\n') p[-1] = '\r';
4985 else
4987 int count = 0;
4989 while (p < pend) if (*p++ == '\n') count++;
4990 if (src - dst < count)
4992 /* We don't have sufficient room for encoding LFs
4993 back to CRLF. We must record converted and
4994 not-yet-converted text back to the buffer
4995 content, enlarge the gap, then record them out of
4996 the buffer contents again. */
4997 int add = len_byte + inserted_byte;
4999 GAP_SIZE -= add;
5000 ZV += add; Z += add; ZV_BYTE += add; Z_BYTE += add;
5001 GPT += inserted_byte; GPT_BYTE += inserted_byte;
5002 make_gap (count - GAP_SIZE);
5003 GAP_SIZE += add;
5004 ZV -= add; Z -= add; ZV_BYTE -= add; Z_BYTE -= add;
5005 GPT -= inserted_byte; GPT_BYTE -= inserted_byte;
5006 /* Don't forget to update SRC, DST, and PEND. */
5007 src = GAP_END_ADDR - len_byte;
5008 dst = GPT_ADDR + inserted_byte;
5009 pend = dst;
5011 inserted += count;
5012 inserted_byte += count;
5013 coding->produced += count;
5014 p = dst = pend + count;
5015 while (count)
5017 *--p = *--pend;
5018 if (*p == '\n') count--, *--p = '\r';
5022 /* Suppress eol-format conversion in the further conversion. */
5023 coding->eol_type = CODING_EOL_LF;
5025 /* Set the coding system symbol to that for Unix-like EOL. */
5026 eol_type = Fget (saved_coding_symbol, Qeol_type);
5027 if (VECTORP (eol_type)
5028 && XVECTOR (eol_type)->size == 3
5029 && SYMBOLP (XVECTOR (eol_type)->contents[CODING_EOL_LF]))
5030 coding->symbol = XVECTOR (eol_type)->contents[CODING_EOL_LF];
5031 else
5032 coding->symbol = saved_coding_symbol;
5034 continue;
5036 if (len_byte <= 0)
5038 if (coding->type != coding_type_ccl
5039 || coding->mode & CODING_MODE_LAST_BLOCK)
5040 break;
5041 coding->mode |= CODING_MODE_LAST_BLOCK;
5042 continue;
5044 if (result == CODING_FINISH_INSUFFICIENT_SRC)
5046 /* The source text ends in invalid codes. Let's just
5047 make them valid buffer contents, and finish conversion. */
5048 inserted += len_byte;
5049 inserted_byte += len_byte;
5050 while (len_byte--)
5051 *dst++ = *src++;
5052 break;
5054 if (result == CODING_FINISH_INTERRUPT)
5056 /* The conversion procedure was interrupted by a user. */
5057 break;
5059 /* Now RESULT == CODING_FINISH_INSUFFICIENT_DST */
5060 if (coding->consumed < 1)
5062 /* It's quite strange to require more memory without
5063 consuming any bytes. Perhaps CCL program bug. */
5064 break;
5066 if (first)
5068 /* We have just done the first batch of conversion which was
5069 stoped because of insufficient gap. Let's reconsider the
5070 required gap size (i.e. SRT - DST) now.
5072 We have converted ORIG bytes (== coding->consumed) into
5073 NEW bytes (coding->produced). To convert the remaining
5074 LEN bytes, we may need REQUIRE bytes of gap, where:
5075 REQUIRE + LEN_BYTE = LEN_BYTE * (NEW / ORIG)
5076 REQUIRE = LEN_BYTE * (NEW - ORIG) / ORIG
5077 Here, we are sure that NEW >= ORIG. */
5078 float ratio = coding->produced - coding->consumed;
5079 ratio /= coding->consumed;
5080 require = len_byte * ratio;
5081 first = 0;
5083 if ((src - dst) < (require + 2000))
5085 /* See the comment above the previous call of make_gap. */
5086 int add = len_byte + inserted_byte;
5088 GAP_SIZE -= add;
5089 ZV += add; Z += add; ZV_BYTE += add; Z_BYTE += add;
5090 GPT += inserted_byte; GPT_BYTE += inserted_byte;
5091 make_gap (require + 2000);
5092 GAP_SIZE += add;
5093 ZV -= add; Z -= add; ZV_BYTE -= add; Z_BYTE -= add;
5094 GPT -= inserted_byte; GPT_BYTE -= inserted_byte;
5097 if (src - dst > 0) *dst = 0; /* Put an anchor. */
5099 if (encodep && coding->dst_multibyte)
5101 /* The output is unibyte. We must convert 8-bit characters to
5102 multibyte form. */
5103 if (inserted_byte * 2 > GAP_SIZE)
5105 GAP_SIZE -= inserted_byte;
5106 ZV += inserted_byte; Z += inserted_byte;
5107 ZV_BYTE += inserted_byte; Z_BYTE += inserted_byte;
5108 GPT += inserted_byte; GPT_BYTE += inserted_byte;
5109 make_gap (inserted_byte - GAP_SIZE);
5110 GAP_SIZE += inserted_byte;
5111 ZV -= inserted_byte; Z -= inserted_byte;
5112 ZV_BYTE -= inserted_byte; Z_BYTE -= inserted_byte;
5113 GPT -= inserted_byte; GPT_BYTE -= inserted_byte;
5115 inserted_byte = str_to_multibyte (GPT_ADDR, GAP_SIZE, inserted_byte);
5118 /* If we have shrinked the conversion area, adjust it now. */
5119 if (total_skip > 0)
5121 if (tail_skip > 0)
5122 safe_bcopy (GAP_END_ADDR, GPT_ADDR + inserted_byte, tail_skip);
5123 inserted += total_skip; inserted_byte += total_skip;
5124 GAP_SIZE += total_skip;
5125 GPT -= head_skip; GPT_BYTE -= head_skip;
5126 ZV -= total_skip; ZV_BYTE -= total_skip;
5127 Z -= total_skip; Z_BYTE -= total_skip;
5128 from -= head_skip; from_byte -= head_skip;
5129 to += tail_skip; to_byte += tail_skip;
5132 prev_Z = Z;
5133 adjust_after_replace (from, from_byte, deletion, inserted, inserted_byte);
5134 inserted = Z - prev_Z;
5136 if (!encodep && coding->cmp_data && coding->cmp_data->used)
5137 coding_restore_composition (coding, Fcurrent_buffer ());
5138 coding_free_composition_data (coding);
5140 if (! inhibit_pre_post_conversion
5141 && ! encodep && ! NILP (coding->post_read_conversion))
5143 Lisp_Object val;
5144 int count = specpdl_ptr - specpdl;
5146 if (from != PT)
5147 TEMP_SET_PT_BOTH (from, from_byte);
5148 prev_Z = Z;
5149 record_unwind_protect (code_convert_region_unwind, Qnil);
5150 /* We should not call any more pre-write/post-read-conversion
5151 functions while this post-read-conversion is running. */
5152 inhibit_pre_post_conversion = 1;
5153 val = call1 (coding->post_read_conversion, make_number (inserted));
5154 inhibit_pre_post_conversion = 0;
5155 /* Discard the unwind protect. */
5156 specpdl_ptr--;
5157 CHECK_NUMBER (val, 0);
5158 inserted += Z - prev_Z;
5161 if (orig_point >= from)
5163 if (orig_point >= from + orig_len)
5164 orig_point += inserted - orig_len;
5165 else
5166 orig_point = from;
5167 TEMP_SET_PT (orig_point);
5170 if (replace)
5172 signal_after_change (from, to - from, inserted);
5173 update_compositions (from, from + inserted, CHECK_BORDER);
5177 coding->consumed = to_byte - from_byte;
5178 coding->consumed_char = to - from;
5179 coding->produced = inserted_byte;
5180 coding->produced_char = inserted;
5183 return 0;
5186 Lisp_Object
5187 run_pre_post_conversion_on_str (str, coding, encodep)
5188 Lisp_Object str;
5189 struct coding_system *coding;
5190 int encodep;
5192 int count = specpdl_ptr - specpdl;
5193 struct gcpro gcpro1;
5194 struct buffer *prev = current_buffer;
5195 int multibyte = STRING_MULTIBYTE (str);
5197 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
5198 record_unwind_protect (code_convert_region_unwind, Qnil);
5199 GCPRO1 (str);
5200 temp_output_buffer_setup (" *code-converting-work*");
5201 set_buffer_internal (XBUFFER (Vstandard_output));
5202 /* We must insert the contents of STR as is without
5203 unibyte<->multibyte conversion. For that, we adjust the
5204 multibyteness of the working buffer to that of STR. */
5205 Ferase_buffer ();
5206 current_buffer->enable_multibyte_characters = multibyte ? Qt : Qnil;
5207 insert_from_string (str, 0, 0,
5208 XSTRING (str)->size, STRING_BYTES (XSTRING (str)), 0);
5209 UNGCPRO;
5210 inhibit_pre_post_conversion = 1;
5211 if (encodep)
5212 call2 (coding->pre_write_conversion, make_number (BEG), make_number (Z));
5213 else
5215 TEMP_SET_PT_BOTH (BEG, BEG_BYTE);
5216 call1 (coding->post_read_conversion, make_number (Z - BEG));
5218 inhibit_pre_post_conversion = 0;
5219 str = make_buffer_string (BEG, Z, 1);
5220 return unbind_to (count, str);
5223 Lisp_Object
5224 decode_coding_string (str, coding, nocopy)
5225 Lisp_Object str;
5226 struct coding_system *coding;
5227 int nocopy;
5229 int len;
5230 struct conversion_buffer buf;
5231 int from, to, to_byte;
5232 struct gcpro gcpro1;
5233 Lisp_Object saved_coding_symbol;
5234 int result;
5235 int require_decoding;
5236 int shrinked_bytes = 0;
5237 Lisp_Object newstr;
5238 int consumed, produced, produced_char;
5240 from = 0;
5241 to = XSTRING (str)->size;
5242 to_byte = STRING_BYTES (XSTRING (str));
5244 saved_coding_symbol = Qnil;
5245 if (CODING_REQUIRE_DETECTION (coding))
5247 /* See the comments in code_convert_region. */
5248 if (coding->type == coding_type_undecided)
5250 detect_coding (coding, XSTRING (str)->data, to_byte);
5251 if (coding->type == coding_type_undecided)
5252 coding->type = coding_type_emacs_mule;
5254 if (coding->eol_type == CODING_EOL_UNDECIDED
5255 && coding->type != coding_type_ccl)
5257 saved_coding_symbol = coding->symbol;
5258 detect_eol (coding, XSTRING (str)->data, to_byte);
5259 if (coding->eol_type == CODING_EOL_UNDECIDED)
5260 coding->eol_type = CODING_EOL_LF;
5261 /* We had better recover the original eol format if we
5262 encounter an inconsitent eol format while decoding. */
5263 coding->mode |= CODING_MODE_INHIBIT_INCONSISTENT_EOL;
5267 require_decoding = CODING_REQUIRE_DECODING (coding);
5269 if (STRING_MULTIBYTE (str))
5271 /* Decoding routines expect the source text to be unibyte. */
5272 str = Fstring_as_unibyte (str);
5273 to_byte = STRING_BYTES (XSTRING (str));
5274 nocopy = 1;
5276 coding->src_multibyte = 0;
5277 coding->dst_multibyte = (coding->type != coding_type_no_conversion
5278 && coding->type != coding_type_raw_text);
5280 /* Try to skip the heading and tailing ASCIIs. */
5281 if (require_decoding && coding->type != coding_type_ccl)
5283 SHRINK_CONVERSION_REGION (&from, &to_byte, coding, XSTRING (str)->data,
5285 if (from == to_byte)
5286 require_decoding = 0;
5287 shrinked_bytes = from + (STRING_BYTES (XSTRING (str)) - to_byte);
5290 if (!require_decoding)
5292 coding->consumed = STRING_BYTES (XSTRING (str));
5293 coding->consumed_char = XSTRING (str)->size;
5294 if (coding->dst_multibyte)
5296 str = Fstring_as_multibyte (str);
5297 nocopy = 1;
5299 coding->produced = STRING_BYTES (XSTRING (str));
5300 coding->produced_char = XSTRING (str)->size;
5301 return (nocopy ? str : Fcopy_sequence (str));
5304 if (coding->composing != COMPOSITION_DISABLED)
5305 coding_allocate_composition_data (coding, from);
5306 len = decoding_buffer_size (coding, to_byte - from);
5307 allocate_conversion_buffer (buf, len);
5309 consumed = produced = produced_char = 0;
5310 while (1)
5312 result = decode_coding (coding, XSTRING (str)->data + from + consumed,
5313 buf.data + produced, to_byte - from - consumed,
5314 buf.size - produced);
5315 consumed += coding->consumed;
5316 produced += coding->produced;
5317 produced_char += coding->produced_char;
5318 if (result == CODING_FINISH_NORMAL)
5319 break;
5320 if (result == CODING_FINISH_INSUFFICIENT_CMP)
5321 coding_allocate_composition_data (coding, from + produced_char);
5322 else if (result == CODING_FINISH_INSUFFICIENT_DST)
5323 extend_conversion_buffer (&buf);
5324 else if (result == CODING_FINISH_INCONSISTENT_EOL)
5326 /* Recover the original EOL format. */
5327 if (coding->eol_type == CODING_EOL_CR)
5329 unsigned char *p;
5330 for (p = buf.data; p < buf.data + produced; p++)
5331 if (*p == '\n') *p = '\r';
5333 else if (coding->eol_type == CODING_EOL_CRLF)
5335 int num_eol = 0;
5336 unsigned char *p0, *p1;
5337 for (p0 = buf.data, p1 = p0 + produced; p0 < p1; p0++)
5338 if (*p0 == '\n') num_eol++;
5339 if (produced + num_eol >= buf.size)
5340 extend_conversion_buffer (&buf);
5341 for (p0 = buf.data + produced, p1 = p0 + num_eol; p0 > buf.data;)
5343 *--p1 = *--p0;
5344 if (*p0 == '\n') *--p1 = '\r';
5346 produced += num_eol;
5347 produced_char += num_eol;
5349 coding->eol_type = CODING_EOL_LF;
5350 coding->symbol = saved_coding_symbol;
5354 if (coding->dst_multibyte)
5355 newstr = make_uninit_multibyte_string (produced_char + shrinked_bytes,
5356 produced + shrinked_bytes);
5357 else
5358 newstr = make_uninit_string (produced + shrinked_bytes);
5359 if (from > 0)
5360 bcopy (XSTRING (str)->data, XSTRING (newstr)->data, from);
5361 bcopy (buf.data, XSTRING (newstr)->data + from, produced);
5362 if (shrinked_bytes > from)
5363 bcopy (XSTRING (str)->data + to_byte,
5364 XSTRING (newstr)->data + from + produced,
5365 shrinked_bytes - from);
5366 free_conversion_buffer (&buf);
5368 if (coding->cmp_data && coding->cmp_data->used)
5369 coding_restore_composition (coding, newstr);
5370 coding_free_composition_data (coding);
5372 if (SYMBOLP (coding->post_read_conversion)
5373 && !NILP (Ffboundp (coding->post_read_conversion)))
5374 newstr = run_pre_post_conversion_on_str (newstr, coding, 0);
5376 return newstr;
5379 Lisp_Object
5380 encode_coding_string (str, coding, nocopy)
5381 Lisp_Object str;
5382 struct coding_system *coding;
5383 int nocopy;
5385 int len;
5386 struct conversion_buffer buf;
5387 int from, to, to_byte;
5388 struct gcpro gcpro1;
5389 Lisp_Object saved_coding_symbol;
5390 int result;
5391 int shrinked_bytes = 0;
5392 Lisp_Object newstr;
5393 int consumed, consumed_char, produced;
5395 if (SYMBOLP (coding->pre_write_conversion)
5396 && !NILP (Ffboundp (coding->pre_write_conversion)))
5397 str = run_pre_post_conversion_on_str (str, coding, 1);
5399 from = 0;
5400 to = XSTRING (str)->size;
5401 to_byte = STRING_BYTES (XSTRING (str));
5403 saved_coding_symbol = Qnil;
5404 if (! CODING_REQUIRE_ENCODING (coding))
5406 if (STRING_MULTIBYTE (str))
5408 str = Fstring_as_unibyte (str);
5409 nocopy = 1;
5411 return (nocopy ? str : Fcopy_sequence (str));
5414 /* Encoding routines determine the multibyteness of the source text
5415 by coding->src_multibyte. */
5416 coding->src_multibyte = STRING_MULTIBYTE (str);
5417 coding->dst_multibyte = 0;
5419 if (coding->composing != COMPOSITION_DISABLED)
5420 coding_save_composition (coding, from, to, str);
5422 /* Try to skip the heading and tailing ASCIIs. */
5423 if (coding->type != coding_type_ccl)
5425 SHRINK_CONVERSION_REGION (&from, &to_byte, coding, XSTRING (str)->data,
5427 if (from == to_byte)
5428 return (nocopy ? str : Fcopy_sequence (str));
5429 shrinked_bytes = from + (STRING_BYTES (XSTRING (str)) - to_byte);
5432 len = encoding_buffer_size (coding, to_byte - from);
5433 allocate_conversion_buffer (buf, len);
5435 consumed = consumed_char = produced = 0;
5437 while (1)
5439 result = encode_coding (coding, XSTRING (str)->data + from + consumed,
5440 buf.data + produced, to_byte - from - consumed,
5441 buf.size - produced);
5442 consumed += coding->consumed;
5443 produced += coding->produced;
5444 if (result == CODING_FINISH_NORMAL)
5445 break;
5446 /* Now result should be CODING_FINISH_INSUFFICIENT_DST. */
5447 extend_conversion_buffer (&buf);
5450 newstr = make_uninit_string (produced + shrinked_bytes);
5451 if (from > 0)
5452 bcopy (XSTRING (str)->data, XSTRING (newstr)->data, from);
5453 bcopy (buf.data, XSTRING (newstr)->data + from, produced);
5454 if (shrinked_bytes > from)
5455 bcopy (XSTRING (str)->data + to_byte,
5456 XSTRING (newstr)->data + from + produced,
5457 shrinked_bytes - from);
5459 free_conversion_buffer (&buf);
5460 coding_free_composition_data (coding);
5462 return newstr;
5466 #ifdef emacs
5467 /*** 8. Emacs Lisp library functions ***/
5469 DEFUN ("coding-system-p", Fcoding_system_p, Scoding_system_p, 1, 1, 0,
5470 "Return t if OBJECT is nil or a coding-system.\n\
5471 See the documentation of `make-coding-system' for information\n\
5472 about coding-system objects.")
5473 (obj)
5474 Lisp_Object obj;
5476 if (NILP (obj))
5477 return Qt;
5478 if (!SYMBOLP (obj))
5479 return Qnil;
5480 /* Get coding-spec vector for OBJ. */
5481 obj = Fget (obj, Qcoding_system);
5482 return ((VECTORP (obj) && XVECTOR (obj)->size == 5)
5483 ? Qt : Qnil);
5486 DEFUN ("read-non-nil-coding-system", Fread_non_nil_coding_system,
5487 Sread_non_nil_coding_system, 1, 1, 0,
5488 "Read a coding system from the minibuffer, prompting with string PROMPT.")
5489 (prompt)
5490 Lisp_Object prompt;
5492 Lisp_Object val;
5495 val = Fcompleting_read (prompt, Vcoding_system_alist, Qnil,
5496 Qt, Qnil, Qcoding_system_history, Qnil, Qnil);
5498 while (XSTRING (val)->size == 0);
5499 return (Fintern (val, Qnil));
5502 DEFUN ("read-coding-system", Fread_coding_system, Sread_coding_system, 1, 2, 0,
5503 "Read a coding system from the minibuffer, prompting with string PROMPT.\n\
5504 If the user enters null input, return second argument DEFAULT-CODING-SYSTEM.")
5505 (prompt, default_coding_system)
5506 Lisp_Object prompt, default_coding_system;
5508 Lisp_Object val;
5509 if (SYMBOLP (default_coding_system))
5510 XSETSTRING (default_coding_system, XSYMBOL (default_coding_system)->name);
5511 val = Fcompleting_read (prompt, Vcoding_system_alist, Qnil,
5512 Qt, Qnil, Qcoding_system_history,
5513 default_coding_system, Qnil);
5514 return (XSTRING (val)->size == 0 ? Qnil : Fintern (val, Qnil));
5517 DEFUN ("check-coding-system", Fcheck_coding_system, Scheck_coding_system,
5518 1, 1, 0,
5519 "Check validity of CODING-SYSTEM.\n\
5520 If valid, return CODING-SYSTEM, else signal a `coding-system-error' error.\n\
5521 It is valid if it is a symbol with a non-nil `coding-system' property.\n\
5522 The value of property should be a vector of length 5.")
5523 (coding_system)
5524 Lisp_Object coding_system;
5526 CHECK_SYMBOL (coding_system, 0);
5527 if (!NILP (Fcoding_system_p (coding_system)))
5528 return coding_system;
5529 while (1)
5530 Fsignal (Qcoding_system_error, Fcons (coding_system, Qnil));
5533 Lisp_Object
5534 detect_coding_system (src, src_bytes, highest)
5535 unsigned char *src;
5536 int src_bytes, highest;
5538 int coding_mask, eol_type;
5539 Lisp_Object val, tmp;
5540 int dummy;
5542 coding_mask = detect_coding_mask (src, src_bytes, NULL, &dummy);
5543 eol_type = detect_eol_type (src, src_bytes, &dummy);
5544 if (eol_type == CODING_EOL_INCONSISTENT)
5545 eol_type = CODING_EOL_UNDECIDED;
5547 if (!coding_mask)
5549 val = Qundecided;
5550 if (eol_type != CODING_EOL_UNDECIDED)
5552 Lisp_Object val2;
5553 val2 = Fget (Qundecided, Qeol_type);
5554 if (VECTORP (val2))
5555 val = XVECTOR (val2)->contents[eol_type];
5557 return (highest ? val : Fcons (val, Qnil));
5560 /* At first, gather possible coding systems in VAL. */
5561 val = Qnil;
5562 for (tmp = Vcoding_category_list; CONSP (tmp); tmp = XCDR (tmp))
5564 Lisp_Object category_val, category_index;
5566 category_index = Fget (XCAR (tmp), Qcoding_category_index);
5567 category_val = Fsymbol_value (XCAR (tmp));
5568 if (!NILP (category_val)
5569 && NATNUMP (category_index)
5570 && (coding_mask & (1 << XFASTINT (category_index))))
5572 val = Fcons (category_val, val);
5573 if (highest)
5574 break;
5577 if (!highest)
5578 val = Fnreverse (val);
5580 /* Then, replace the elements with subsidiary coding systems. */
5581 for (tmp = val; CONSP (tmp); tmp = XCDR (tmp))
5583 if (eol_type != CODING_EOL_UNDECIDED
5584 && eol_type != CODING_EOL_INCONSISTENT)
5586 Lisp_Object eol;
5587 eol = Fget (XCAR (tmp), Qeol_type);
5588 if (VECTORP (eol))
5589 XCAR (tmp) = XVECTOR (eol)->contents[eol_type];
5592 return (highest ? XCAR (val) : val);
5595 DEFUN ("detect-coding-region", Fdetect_coding_region, Sdetect_coding_region,
5596 2, 3, 0,
5597 "Detect coding system of the text in the region between START and END.\n\
5598 Return a list of possible coding systems ordered by priority.\n\
5600 If only ASCII characters are found, it returns a list of single element\n\
5601 `undecided' or its subsidiary coding system according to a detected\n\
5602 end-of-line format.\n\
5604 If optional argument HIGHEST is non-nil, return the coding system of\n\
5605 highest priority.")
5606 (start, end, highest)
5607 Lisp_Object start, end, highest;
5609 int from, to;
5610 int from_byte, to_byte;
5612 CHECK_NUMBER_COERCE_MARKER (start, 0);
5613 CHECK_NUMBER_COERCE_MARKER (end, 1);
5615 validate_region (&start, &end);
5616 from = XINT (start), to = XINT (end);
5617 from_byte = CHAR_TO_BYTE (from);
5618 to_byte = CHAR_TO_BYTE (to);
5620 if (from < GPT && to >= GPT)
5621 move_gap_both (to, to_byte);
5623 return detect_coding_system (BYTE_POS_ADDR (from_byte),
5624 to_byte - from_byte,
5625 !NILP (highest));
5628 DEFUN ("detect-coding-string", Fdetect_coding_string, Sdetect_coding_string,
5629 1, 2, 0,
5630 "Detect coding system of the text in STRING.\n\
5631 Return a list of possible coding systems ordered by priority.\n\
5633 If only ASCII characters are found, it returns a list of single element\n\
5634 `undecided' or its subsidiary coding system according to a detected\n\
5635 end-of-line format.\n\
5637 If optional argument HIGHEST is non-nil, return the coding system of\n\
5638 highest priority.")
5639 (string, highest)
5640 Lisp_Object string, highest;
5642 CHECK_STRING (string, 0);
5644 return detect_coding_system (XSTRING (string)->data,
5645 STRING_BYTES (XSTRING (string)),
5646 !NILP (highest));
5649 /* Return an intersection of lists L1 and L2. */
5651 static Lisp_Object
5652 intersection (l1, l2)
5653 Lisp_Object l1, l2;
5655 Lisp_Object val;
5657 for (val = Qnil; CONSP (l1); l1 = XCDR (l1))
5659 if (!NILP (Fmemq (XCAR (l1), l2)))
5660 val = Fcons (XCAR (l1), val);
5662 return val;
5666 /* Subroutine for Fsafe_coding_systems_region_internal.
5668 Return a list of coding systems that safely encode the multibyte
5669 text between P and PEND. SAFE_CODINGS, if non-nil, is a list of
5670 possible coding systems. If it is nil, it means that we have not
5671 yet found any coding systems.
5673 WORK_TABLE is a copy of the char-table Vchar_coding_system_table. An
5674 element of WORK_TABLE is set to t once the element is looked up.
5676 If a non-ASCII single byte char is found, set
5677 *single_byte_char_found to 1. */
5679 static Lisp_Object
5680 find_safe_codings (p, pend, safe_codings, work_table, single_byte_char_found)
5681 unsigned char *p, *pend;
5682 Lisp_Object safe_codings, work_table;
5683 int *single_byte_char_found;
5685 int c, len, idx;
5686 Lisp_Object val;
5688 while (p < pend)
5690 c = STRING_CHAR_AND_LENGTH (p, pend - p, len);
5691 p += len;
5692 if (ASCII_BYTE_P (c))
5693 /* We can ignore ASCII characters here. */
5694 continue;
5695 if (SINGLE_BYTE_CHAR_P (c))
5696 *single_byte_char_found = 1;
5697 if (NILP (safe_codings))
5698 continue;
5699 /* Check the safe coding systems for C. */
5700 val = char_table_ref_and_index (work_table, c, &idx);
5701 if (EQ (val, Qt))
5702 /* This element was already checked. Ignore it. */
5703 continue;
5704 /* Remember that we checked this element. */
5705 CHAR_TABLE_SET (work_table, make_number (idx), Qt);
5707 /* If there are some safe coding systems for C and we have
5708 already found the other set of coding systems for the
5709 different characters, get the intersection of them. */
5710 if (!EQ (safe_codings, Qt) && !NILP (val))
5711 val = intersection (safe_codings, val);
5712 safe_codings = val;
5714 return safe_codings;
5718 /* Return a list of coding systems that safely encode the text between
5719 START and END. If the text contains only ASCII or is unibyte,
5720 return t. */
5722 DEFUN ("find-coding-systems-region-internal",
5723 Ffind_coding_systems_region_internal,
5724 Sfind_coding_systems_region_internal, 2, 2, 0,
5725 "Internal use only.")
5726 (start, end)
5727 Lisp_Object start, end;
5729 Lisp_Object work_table, safe_codings;
5730 int non_ascii_p = 0;
5731 int single_byte_char_found = 0;
5732 unsigned char *p1, *p1end, *p2, *p2end, *p;
5733 Lisp_Object args[2];
5735 if (STRINGP (start))
5737 if (!STRING_MULTIBYTE (start))
5738 return Qt;
5739 p1 = XSTRING (start)->data, p1end = p1 + STRING_BYTES (XSTRING (start));
5740 p2 = p2end = p1end;
5741 if (XSTRING (start)->size != STRING_BYTES (XSTRING (start)))
5742 non_ascii_p = 1;
5744 else
5746 int from, to, stop;
5748 CHECK_NUMBER_COERCE_MARKER (start, 0);
5749 CHECK_NUMBER_COERCE_MARKER (end, 1);
5750 if (XINT (start) < BEG || XINT (end) > Z || XINT (start) > XINT (end))
5751 args_out_of_range (start, end);
5752 if (NILP (current_buffer->enable_multibyte_characters))
5753 return Qt;
5754 from = CHAR_TO_BYTE (XINT (start));
5755 to = CHAR_TO_BYTE (XINT (end));
5756 stop = from < GPT_BYTE && GPT_BYTE < to ? GPT_BYTE : to;
5757 p1 = BYTE_POS_ADDR (from), p1end = p1 + (stop - from);
5758 if (stop == to)
5759 p2 = p2end = p1end;
5760 else
5761 p2 = BYTE_POS_ADDR (stop), p2end = p2 + (to - stop);
5762 if (XINT (end) - XINT (start) != to - from)
5763 non_ascii_p = 1;
5766 if (!non_ascii_p)
5768 /* We are sure that the text contains no multibyte character.
5769 Check if it contains eight-bit-graphic. */
5770 p = p1;
5771 for (p = p1; p < p1end && ASCII_BYTE_P (*p); p++);
5772 if (p == p1end)
5774 for (p = p2; p < p2end && ASCII_BYTE_P (*p); p++);
5775 if (p == p2end)
5776 return Qt;
5780 /* The text contains non-ASCII characters. */
5781 work_table = Fcopy_sequence (Vchar_coding_system_table);
5782 safe_codings = find_safe_codings (p1, p1end, Qt, work_table,
5783 &single_byte_char_found);
5784 if (p2 < p2end)
5785 safe_codings = find_safe_codings (p2, p2end, safe_codings, work_table,
5786 &single_byte_char_found);
5788 if (!single_byte_char_found)
5790 /* Append generic coding systems. */
5791 Lisp_Object args[2];
5792 args[0] = safe_codings;
5793 args[1] = Fchar_table_extra_slot (Vchar_coding_system_table,
5794 make_number (0));
5795 safe_codings = Fappend (2, args);
5797 else
5798 safe_codings = Fcons (Qraw_text, Fcons (Qemacs_mule, safe_codings));
5799 return safe_codings;
5803 Lisp_Object
5804 code_convert_region1 (start, end, coding_system, encodep)
5805 Lisp_Object start, end, coding_system;
5806 int encodep;
5808 struct coding_system coding;
5809 int from, to, len;
5811 CHECK_NUMBER_COERCE_MARKER (start, 0);
5812 CHECK_NUMBER_COERCE_MARKER (end, 1);
5813 CHECK_SYMBOL (coding_system, 2);
5815 validate_region (&start, &end);
5816 from = XFASTINT (start);
5817 to = XFASTINT (end);
5819 if (NILP (coding_system))
5820 return make_number (to - from);
5822 if (setup_coding_system (Fcheck_coding_system (coding_system), &coding) < 0)
5823 error ("Invalid coding system: %s", XSYMBOL (coding_system)->name->data);
5825 coding.mode |= CODING_MODE_LAST_BLOCK;
5826 coding.src_multibyte = coding.dst_multibyte
5827 = !NILP (current_buffer->enable_multibyte_characters);
5828 code_convert_region (from, CHAR_TO_BYTE (from), to, CHAR_TO_BYTE (to),
5829 &coding, encodep, 1);
5830 Vlast_coding_system_used = coding.symbol;
5831 return make_number (coding.produced_char);
5834 DEFUN ("decode-coding-region", Fdecode_coding_region, Sdecode_coding_region,
5835 3, 3, "r\nzCoding system: ",
5836 "Decode the current region by specified coding system.\n\
5837 When called from a program, takes three arguments:\n\
5838 START, END, and CODING-SYSTEM. START and END are buffer positions.\n\
5839 This function sets `last-coding-system-used' to the precise coding system\n\
5840 used (which may be different from CODING-SYSTEM if CODING-SYSTEM is\n\
5841 not fully specified.)\n\
5842 It returns the length of the decoded text.")
5843 (start, end, coding_system)
5844 Lisp_Object start, end, coding_system;
5846 return code_convert_region1 (start, end, coding_system, 0);
5849 DEFUN ("encode-coding-region", Fencode_coding_region, Sencode_coding_region,
5850 3, 3, "r\nzCoding system: ",
5851 "Encode the current region by specified coding system.\n\
5852 When called from a program, takes three arguments:\n\
5853 START, END, and CODING-SYSTEM. START and END are buffer positions.\n\
5854 This function sets `last-coding-system-used' to the precise coding system\n\
5855 used (which may be different from CODING-SYSTEM if CODING-SYSTEM is\n\
5856 not fully specified.)\n\
5857 It returns the length of the encoded text.")
5858 (start, end, coding_system)
5859 Lisp_Object start, end, coding_system;
5861 return code_convert_region1 (start, end, coding_system, 1);
5864 Lisp_Object
5865 code_convert_string1 (string, coding_system, nocopy, encodep)
5866 Lisp_Object string, coding_system, nocopy;
5867 int encodep;
5869 struct coding_system coding;
5871 CHECK_STRING (string, 0);
5872 CHECK_SYMBOL (coding_system, 1);
5874 if (NILP (coding_system))
5875 return (NILP (nocopy) ? Fcopy_sequence (string) : string);
5877 if (setup_coding_system (Fcheck_coding_system (coding_system), &coding) < 0)
5878 error ("Invalid coding system: %s", XSYMBOL (coding_system)->name->data);
5880 coding.mode |= CODING_MODE_LAST_BLOCK;
5881 string = (encodep
5882 ? encode_coding_string (string, &coding, !NILP (nocopy))
5883 : decode_coding_string (string, &coding, !NILP (nocopy)));
5884 Vlast_coding_system_used = coding.symbol;
5886 return string;
5889 DEFUN ("decode-coding-string", Fdecode_coding_string, Sdecode_coding_string,
5890 2, 3, 0,
5891 "Decode STRING which is encoded in CODING-SYSTEM, and return the result.\n\
5892 Optional arg NOCOPY non-nil means it is ok to return STRING itself\n\
5893 if the decoding operation is trivial.\n\
5894 This function sets `last-coding-system-used' to the precise coding system\n\
5895 used (which may be different from CODING-SYSTEM if CODING-SYSTEM is\n\
5896 not fully specified.)")
5897 (string, coding_system, nocopy)
5898 Lisp_Object string, coding_system, nocopy;
5900 return code_convert_string1 (string, coding_system, nocopy, 0);
5903 DEFUN ("encode-coding-string", Fencode_coding_string, Sencode_coding_string,
5904 2, 3, 0,
5905 "Encode STRING to CODING-SYSTEM, and return the result.\n\
5906 Optional arg NOCOPY non-nil means it is ok to return STRING itself\n\
5907 if the encoding operation is trivial.\n\
5908 This function sets `last-coding-system-used' to the precise coding system\n\
5909 used (which may be different from CODING-SYSTEM if CODING-SYSTEM is\n\
5910 not fully specified.)")
5911 (string, coding_system, nocopy)
5912 Lisp_Object string, coding_system, nocopy;
5914 return code_convert_string1 (string, coding_system, nocopy, 1);
5917 /* Encode or decode STRING according to CODING_SYSTEM.
5918 Do not set Vlast_coding_system_used.
5920 This function is called only from macros DECODE_FILE and
5921 ENCODE_FILE, thus we ignore character composition. */
5923 Lisp_Object
5924 code_convert_string_norecord (string, coding_system, encodep)
5925 Lisp_Object string, coding_system;
5926 int encodep;
5928 struct coding_system coding;
5930 CHECK_STRING (string, 0);
5931 CHECK_SYMBOL (coding_system, 1);
5933 if (NILP (coding_system))
5934 return string;
5936 if (setup_coding_system (Fcheck_coding_system (coding_system), &coding) < 0)
5937 error ("Invalid coding system: %s", XSYMBOL (coding_system)->name->data);
5939 coding.composing = COMPOSITION_DISABLED;
5940 coding.mode |= CODING_MODE_LAST_BLOCK;
5941 return (encodep
5942 ? encode_coding_string (string, &coding, 1)
5943 : decode_coding_string (string, &coding, 1));
5946 DEFUN ("decode-sjis-char", Fdecode_sjis_char, Sdecode_sjis_char, 1, 1, 0,
5947 "Decode a Japanese character which has CODE in shift_jis encoding.\n\
5948 Return the corresponding character.")
5949 (code)
5950 Lisp_Object code;
5952 unsigned char c1, c2, s1, s2;
5953 Lisp_Object val;
5955 CHECK_NUMBER (code, 0);
5956 s1 = (XFASTINT (code)) >> 8, s2 = (XFASTINT (code)) & 0xFF;
5957 if (s1 == 0)
5959 if (s2 < 0x80)
5960 XSETFASTINT (val, s2);
5961 else if (s2 >= 0xA0 || s2 <= 0xDF)
5962 XSETFASTINT (val, MAKE_CHAR (charset_katakana_jisx0201, s2, 0));
5963 else
5964 error ("Invalid Shift JIS code: %x", XFASTINT (code));
5966 else
5968 if ((s1 < 0x80 || s1 > 0x9F && s1 < 0xE0 || s1 > 0xEF)
5969 || (s2 < 0x40 || s2 == 0x7F || s2 > 0xFC))
5970 error ("Invalid Shift JIS code: %x", XFASTINT (code));
5971 DECODE_SJIS (s1, s2, c1, c2);
5972 XSETFASTINT (val, MAKE_CHAR (charset_jisx0208, c1, c2));
5974 return val;
5977 DEFUN ("encode-sjis-char", Fencode_sjis_char, Sencode_sjis_char, 1, 1, 0,
5978 "Encode a Japanese character CHAR to shift_jis encoding.\n\
5979 Return the corresponding code in SJIS.")
5980 (ch)
5981 Lisp_Object ch;
5983 int charset, c1, c2, s1, s2;
5984 Lisp_Object val;
5986 CHECK_NUMBER (ch, 0);
5987 SPLIT_CHAR (XFASTINT (ch), charset, c1, c2);
5988 if (charset == CHARSET_ASCII)
5990 val = ch;
5992 else if (charset == charset_jisx0208
5993 && c1 > 0x20 && c1 < 0x7F && c2 > 0x20 && c2 < 0x7F)
5995 ENCODE_SJIS (c1, c2, s1, s2);
5996 XSETFASTINT (val, (s1 << 8) | s2);
5998 else if (charset == charset_katakana_jisx0201
5999 && c1 > 0x20 && c2 < 0xE0)
6001 XSETFASTINT (val, c1 | 0x80);
6003 else
6004 error ("Can't encode to shift_jis: %d", XFASTINT (ch));
6005 return val;
6008 DEFUN ("decode-big5-char", Fdecode_big5_char, Sdecode_big5_char, 1, 1, 0,
6009 "Decode a Big5 character which has CODE in BIG5 coding system.\n\
6010 Return the corresponding character.")
6011 (code)
6012 Lisp_Object code;
6014 int charset;
6015 unsigned char b1, b2, c1, c2;
6016 Lisp_Object val;
6018 CHECK_NUMBER (code, 0);
6019 b1 = (XFASTINT (code)) >> 8, b2 = (XFASTINT (code)) & 0xFF;
6020 if (b1 == 0)
6022 if (b2 >= 0x80)
6023 error ("Invalid BIG5 code: %x", XFASTINT (code));
6024 val = code;
6026 else
6028 if ((b1 < 0xA1 || b1 > 0xFE)
6029 || (b2 < 0x40 || (b2 > 0x7E && b2 < 0xA1) || b2 > 0xFE))
6030 error ("Invalid BIG5 code: %x", XFASTINT (code));
6031 DECODE_BIG5 (b1, b2, charset, c1, c2);
6032 XSETFASTINT (val, MAKE_CHAR (charset, c1, c2));
6034 return val;
6037 DEFUN ("encode-big5-char", Fencode_big5_char, Sencode_big5_char, 1, 1, 0,
6038 "Encode the Big5 character CHAR to BIG5 coding system.\n\
6039 Return the corresponding character code in Big5.")
6040 (ch)
6041 Lisp_Object ch;
6043 int charset, c1, c2, b1, b2;
6044 Lisp_Object val;
6046 CHECK_NUMBER (ch, 0);
6047 SPLIT_CHAR (XFASTINT (ch), charset, c1, c2);
6048 if (charset == CHARSET_ASCII)
6050 val = ch;
6052 else if ((charset == charset_big5_1
6053 && (XFASTINT (ch) >= 0x250a1 && XFASTINT (ch) <= 0x271ec))
6054 || (charset == charset_big5_2
6055 && XFASTINT (ch) >= 0x290a1 && XFASTINT (ch) <= 0x2bdb2))
6057 ENCODE_BIG5 (charset, c1, c2, b1, b2);
6058 XSETFASTINT (val, (b1 << 8) | b2);
6060 else
6061 error ("Can't encode to Big5: %d", XFASTINT (ch));
6062 return val;
6065 DEFUN ("set-terminal-coding-system-internal",
6066 Fset_terminal_coding_system_internal,
6067 Sset_terminal_coding_system_internal, 1, 1, 0, "")
6068 (coding_system)
6069 Lisp_Object coding_system;
6071 CHECK_SYMBOL (coding_system, 0);
6072 setup_coding_system (Fcheck_coding_system (coding_system), &terminal_coding);
6073 /* We had better not send unsafe characters to terminal. */
6074 terminal_coding.flags |= CODING_FLAG_ISO_SAFE;
6075 /* Characer composition should be disabled. */
6076 terminal_coding.composing = COMPOSITION_DISABLED;
6077 terminal_coding.src_multibyte = 1;
6078 terminal_coding.dst_multibyte = 0;
6079 return Qnil;
6082 DEFUN ("set-safe-terminal-coding-system-internal",
6083 Fset_safe_terminal_coding_system_internal,
6084 Sset_safe_terminal_coding_system_internal, 1, 1, 0, "")
6085 (coding_system)
6086 Lisp_Object coding_system;
6088 CHECK_SYMBOL (coding_system, 0);
6089 setup_coding_system (Fcheck_coding_system (coding_system),
6090 &safe_terminal_coding);
6091 /* Characer composition should be disabled. */
6092 safe_terminal_coding.composing = COMPOSITION_DISABLED;
6093 safe_terminal_coding.src_multibyte = 1;
6094 safe_terminal_coding.dst_multibyte = 0;
6095 return Qnil;
6098 DEFUN ("terminal-coding-system",
6099 Fterminal_coding_system, Sterminal_coding_system, 0, 0, 0,
6100 "Return coding system specified for terminal output.")
6103 return terminal_coding.symbol;
6106 DEFUN ("set-keyboard-coding-system-internal",
6107 Fset_keyboard_coding_system_internal,
6108 Sset_keyboard_coding_system_internal, 1, 1, 0, "")
6109 (coding_system)
6110 Lisp_Object coding_system;
6112 CHECK_SYMBOL (coding_system, 0);
6113 setup_coding_system (Fcheck_coding_system (coding_system), &keyboard_coding);
6114 /* Characer composition should be disabled. */
6115 keyboard_coding.composing = COMPOSITION_DISABLED;
6116 return Qnil;
6119 DEFUN ("keyboard-coding-system",
6120 Fkeyboard_coding_system, Skeyboard_coding_system, 0, 0, 0,
6121 "Return coding system specified for decoding keyboard input.")
6124 return keyboard_coding.symbol;
6128 DEFUN ("find-operation-coding-system", Ffind_operation_coding_system,
6129 Sfind_operation_coding_system, 1, MANY, 0,
6130 "Choose a coding system for an operation based on the target name.\n\
6131 The value names a pair of coding systems: (DECODING-SYSTEM . ENCODING-SYSTEM).\n\
6132 DECODING-SYSTEM is the coding system to use for decoding\n\
6133 \(in case OPERATION does decoding), and ENCODING-SYSTEM is the coding system\n\
6134 for encoding (in case OPERATION does encoding).\n\
6136 The first argument OPERATION specifies an I/O primitive:\n\
6137 For file I/O, `insert-file-contents' or `write-region'.\n\
6138 For process I/O, `call-process', `call-process-region', or `start-process'.\n\
6139 For network I/O, `open-network-stream'.\n\
6141 The remaining arguments should be the same arguments that were passed\n\
6142 to the primitive. Depending on which primitive, one of those arguments\n\
6143 is selected as the TARGET. For example, if OPERATION does file I/O,\n\
6144 whichever argument specifies the file name is TARGET.\n\
6146 TARGET has a meaning which depends on OPERATION:\n\
6147 For file I/O, TARGET is a file name.\n\
6148 For process I/O, TARGET is a process name.\n\
6149 For network I/O, TARGET is a service name or a port number\n\
6151 This function looks up what specified for TARGET in,\n\
6152 `file-coding-system-alist', `process-coding-system-alist',\n\
6153 or `network-coding-system-alist' depending on OPERATION.\n\
6154 They may specify a coding system, a cons of coding systems,\n\
6155 or a function symbol to call.\n\
6156 In the last case, we call the function with one argument,\n\
6157 which is a list of all the arguments given to this function.")
6158 (nargs, args)
6159 int nargs;
6160 Lisp_Object *args;
6162 Lisp_Object operation, target_idx, target, val;
6163 register Lisp_Object chain;
6165 if (nargs < 2)
6166 error ("Too few arguments");
6167 operation = args[0];
6168 if (!SYMBOLP (operation)
6169 || !INTEGERP (target_idx = Fget (operation, Qtarget_idx)))
6170 error ("Invalid first arguement");
6171 if (nargs < 1 + XINT (target_idx))
6172 error ("Too few arguments for operation: %s",
6173 XSYMBOL (operation)->name->data);
6174 target = args[XINT (target_idx) + 1];
6175 if (!(STRINGP (target)
6176 || (EQ (operation, Qopen_network_stream) && INTEGERP (target))))
6177 error ("Invalid %dth argument", XINT (target_idx) + 1);
6179 chain = ((EQ (operation, Qinsert_file_contents)
6180 || EQ (operation, Qwrite_region))
6181 ? Vfile_coding_system_alist
6182 : (EQ (operation, Qopen_network_stream)
6183 ? Vnetwork_coding_system_alist
6184 : Vprocess_coding_system_alist));
6185 if (NILP (chain))
6186 return Qnil;
6188 for (; CONSP (chain); chain = XCDR (chain))
6190 Lisp_Object elt;
6191 elt = XCAR (chain);
6193 if (CONSP (elt)
6194 && ((STRINGP (target)
6195 && STRINGP (XCAR (elt))
6196 && fast_string_match (XCAR (elt), target) >= 0)
6197 || (INTEGERP (target) && EQ (target, XCAR (elt)))))
6199 val = XCDR (elt);
6200 /* Here, if VAL is both a valid coding system and a valid
6201 function symbol, we return VAL as a coding system. */
6202 if (CONSP (val))
6203 return val;
6204 if (! SYMBOLP (val))
6205 return Qnil;
6206 if (! NILP (Fcoding_system_p (val)))
6207 return Fcons (val, val);
6208 if (! NILP (Ffboundp (val)))
6210 val = call1 (val, Flist (nargs, args));
6211 if (CONSP (val))
6212 return val;
6213 if (SYMBOLP (val) && ! NILP (Fcoding_system_p (val)))
6214 return Fcons (val, val);
6216 return Qnil;
6219 return Qnil;
6222 DEFUN ("update-coding-systems-internal", Fupdate_coding_systems_internal,
6223 Supdate_coding_systems_internal, 0, 0, 0,
6224 "Update internal database for ISO2022 and CCL based coding systems.\n\
6225 When values of any coding categories are changed, you must\n\
6226 call this function")
6229 int i;
6231 for (i = CODING_CATEGORY_IDX_EMACS_MULE; i < CODING_CATEGORY_IDX_MAX; i++)
6233 Lisp_Object val;
6235 val = XSYMBOL (XVECTOR (Vcoding_category_table)->contents[i])->value;
6236 if (!NILP (val))
6238 if (! coding_system_table[i])
6239 coding_system_table[i] = ((struct coding_system *)
6240 xmalloc (sizeof (struct coding_system)));
6241 setup_coding_system (val, coding_system_table[i]);
6243 else if (coding_system_table[i])
6245 xfree (coding_system_table[i]);
6246 coding_system_table[i] = NULL;
6250 return Qnil;
6253 DEFUN ("set-coding-priority-internal", Fset_coding_priority_internal,
6254 Sset_coding_priority_internal, 0, 0, 0,
6255 "Update internal database for the current value of `coding-category-list'.\n\
6256 This function is internal use only.")
6259 int i = 0, idx;
6260 Lisp_Object val;
6262 val = Vcoding_category_list;
6264 while (CONSP (val) && i < CODING_CATEGORY_IDX_MAX)
6266 if (! SYMBOLP (XCAR (val)))
6267 break;
6268 idx = XFASTINT (Fget (XCAR (val), Qcoding_category_index));
6269 if (idx >= CODING_CATEGORY_IDX_MAX)
6270 break;
6271 coding_priorities[i++] = (1 << idx);
6272 val = XCDR (val);
6274 /* If coding-category-list is valid and contains all coding
6275 categories, `i' should be CODING_CATEGORY_IDX_MAX now. If not,
6276 the following code saves Emacs from crashing. */
6277 while (i < CODING_CATEGORY_IDX_MAX)
6278 coding_priorities[i++] = CODING_CATEGORY_MASK_RAW_TEXT;
6280 return Qnil;
6283 #endif /* emacs */
6286 /*** 9. Post-amble ***/
6288 void
6289 init_coding_once ()
6291 int i;
6293 /* Emacs' internal format specific initialize routine. */
6294 for (i = 0; i <= 0x20; i++)
6295 emacs_code_class[i] = EMACS_control_code;
6296 emacs_code_class[0x0A] = EMACS_linefeed_code;
6297 emacs_code_class[0x0D] = EMACS_carriage_return_code;
6298 for (i = 0x21 ; i < 0x7F; i++)
6299 emacs_code_class[i] = EMACS_ascii_code;
6300 emacs_code_class[0x7F] = EMACS_control_code;
6301 for (i = 0x80; i < 0xFF; i++)
6302 emacs_code_class[i] = EMACS_invalid_code;
6303 emacs_code_class[LEADING_CODE_PRIVATE_11] = EMACS_leading_code_3;
6304 emacs_code_class[LEADING_CODE_PRIVATE_12] = EMACS_leading_code_3;
6305 emacs_code_class[LEADING_CODE_PRIVATE_21] = EMACS_leading_code_4;
6306 emacs_code_class[LEADING_CODE_PRIVATE_22] = EMACS_leading_code_4;
6308 /* ISO2022 specific initialize routine. */
6309 for (i = 0; i < 0x20; i++)
6310 iso_code_class[i] = ISO_control_0;
6311 for (i = 0x21; i < 0x7F; i++)
6312 iso_code_class[i] = ISO_graphic_plane_0;
6313 for (i = 0x80; i < 0xA0; i++)
6314 iso_code_class[i] = ISO_control_1;
6315 for (i = 0xA1; i < 0xFF; i++)
6316 iso_code_class[i] = ISO_graphic_plane_1;
6317 iso_code_class[0x20] = iso_code_class[0x7F] = ISO_0x20_or_0x7F;
6318 iso_code_class[0xA0] = iso_code_class[0xFF] = ISO_0xA0_or_0xFF;
6319 iso_code_class[ISO_CODE_CR] = ISO_carriage_return;
6320 iso_code_class[ISO_CODE_SO] = ISO_shift_out;
6321 iso_code_class[ISO_CODE_SI] = ISO_shift_in;
6322 iso_code_class[ISO_CODE_SS2_7] = ISO_single_shift_2_7;
6323 iso_code_class[ISO_CODE_ESC] = ISO_escape;
6324 iso_code_class[ISO_CODE_SS2] = ISO_single_shift_2;
6325 iso_code_class[ISO_CODE_SS3] = ISO_single_shift_3;
6326 iso_code_class[ISO_CODE_CSI] = ISO_control_sequence_introducer;
6328 setup_coding_system (Qnil, &keyboard_coding);
6329 setup_coding_system (Qnil, &terminal_coding);
6330 setup_coding_system (Qnil, &safe_terminal_coding);
6331 setup_coding_system (Qnil, &default_buffer_file_coding);
6333 bzero (coding_system_table, sizeof coding_system_table);
6335 bzero (ascii_skip_code, sizeof ascii_skip_code);
6336 for (i = 0; i < 128; i++)
6337 ascii_skip_code[i] = 1;
6339 #if defined (MSDOS) || defined (WINDOWSNT)
6340 system_eol_type = CODING_EOL_CRLF;
6341 #else
6342 system_eol_type = CODING_EOL_LF;
6343 #endif
6345 inhibit_pre_post_conversion = 0;
6348 #ifdef emacs
6350 void
6351 syms_of_coding ()
6353 Qtarget_idx = intern ("target-idx");
6354 staticpro (&Qtarget_idx);
6356 Qcoding_system_history = intern ("coding-system-history");
6357 staticpro (&Qcoding_system_history);
6358 Fset (Qcoding_system_history, Qnil);
6360 /* Target FILENAME is the first argument. */
6361 Fput (Qinsert_file_contents, Qtarget_idx, make_number (0));
6362 /* Target FILENAME is the third argument. */
6363 Fput (Qwrite_region, Qtarget_idx, make_number (2));
6365 Qcall_process = intern ("call-process");
6366 staticpro (&Qcall_process);
6367 /* Target PROGRAM is the first argument. */
6368 Fput (Qcall_process, Qtarget_idx, make_number (0));
6370 Qcall_process_region = intern ("call-process-region");
6371 staticpro (&Qcall_process_region);
6372 /* Target PROGRAM is the third argument. */
6373 Fput (Qcall_process_region, Qtarget_idx, make_number (2));
6375 Qstart_process = intern ("start-process");
6376 staticpro (&Qstart_process);
6377 /* Target PROGRAM is the third argument. */
6378 Fput (Qstart_process, Qtarget_idx, make_number (2));
6380 Qopen_network_stream = intern ("open-network-stream");
6381 staticpro (&Qopen_network_stream);
6382 /* Target SERVICE is the fourth argument. */
6383 Fput (Qopen_network_stream, Qtarget_idx, make_number (3));
6385 Qcoding_system = intern ("coding-system");
6386 staticpro (&Qcoding_system);
6388 Qeol_type = intern ("eol-type");
6389 staticpro (&Qeol_type);
6391 Qbuffer_file_coding_system = intern ("buffer-file-coding-system");
6392 staticpro (&Qbuffer_file_coding_system);
6394 Qpost_read_conversion = intern ("post-read-conversion");
6395 staticpro (&Qpost_read_conversion);
6397 Qpre_write_conversion = intern ("pre-write-conversion");
6398 staticpro (&Qpre_write_conversion);
6400 Qno_conversion = intern ("no-conversion");
6401 staticpro (&Qno_conversion);
6403 Qundecided = intern ("undecided");
6404 staticpro (&Qundecided);
6406 Qcoding_system_p = intern ("coding-system-p");
6407 staticpro (&Qcoding_system_p);
6409 Qcoding_system_error = intern ("coding-system-error");
6410 staticpro (&Qcoding_system_error);
6412 Fput (Qcoding_system_error, Qerror_conditions,
6413 Fcons (Qcoding_system_error, Fcons (Qerror, Qnil)));
6414 Fput (Qcoding_system_error, Qerror_message,
6415 build_string ("Invalid coding system"));
6417 Qcoding_category = intern ("coding-category");
6418 staticpro (&Qcoding_category);
6419 Qcoding_category_index = intern ("coding-category-index");
6420 staticpro (&Qcoding_category_index);
6422 Vcoding_category_table
6423 = Fmake_vector (make_number (CODING_CATEGORY_IDX_MAX), Qnil);
6424 staticpro (&Vcoding_category_table);
6426 int i;
6427 for (i = 0; i < CODING_CATEGORY_IDX_MAX; i++)
6429 XVECTOR (Vcoding_category_table)->contents[i]
6430 = intern (coding_category_name[i]);
6431 Fput (XVECTOR (Vcoding_category_table)->contents[i],
6432 Qcoding_category_index, make_number (i));
6436 Qtranslation_table = intern ("translation-table");
6437 staticpro (&Qtranslation_table);
6438 Fput (Qtranslation_table, Qchar_table_extra_slots, make_number (1));
6440 Qtranslation_table_id = intern ("translation-table-id");
6441 staticpro (&Qtranslation_table_id);
6443 Qtranslation_table_for_decode = intern ("translation-table-for-decode");
6444 staticpro (&Qtranslation_table_for_decode);
6446 Qtranslation_table_for_encode = intern ("translation-table-for-encode");
6447 staticpro (&Qtranslation_table_for_encode);
6449 Qsafe_chars = intern ("safe-chars");
6450 staticpro (&Qsafe_chars);
6452 Qchar_coding_system = intern ("char-coding-system");
6453 staticpro (&Qchar_coding_system);
6455 /* Intern this now in case it isn't already done.
6456 Setting this variable twice is harmless.
6457 But don't staticpro it here--that is done in alloc.c. */
6458 Qchar_table_extra_slots = intern ("char-table-extra-slots");
6459 Fput (Qsafe_chars, Qchar_table_extra_slots, make_number (0));
6460 Fput (Qchar_coding_system, Qchar_table_extra_slots, make_number (1));
6462 Qvalid_codes = intern ("valid-codes");
6463 staticpro (&Qvalid_codes);
6465 Qemacs_mule = intern ("emacs-mule");
6466 staticpro (&Qemacs_mule);
6468 Qraw_text = intern ("raw-text");
6469 staticpro (&Qraw_text);
6471 defsubr (&Scoding_system_p);
6472 defsubr (&Sread_coding_system);
6473 defsubr (&Sread_non_nil_coding_system);
6474 defsubr (&Scheck_coding_system);
6475 defsubr (&Sdetect_coding_region);
6476 defsubr (&Sdetect_coding_string);
6477 defsubr (&Sfind_coding_systems_region_internal);
6478 defsubr (&Sdecode_coding_region);
6479 defsubr (&Sencode_coding_region);
6480 defsubr (&Sdecode_coding_string);
6481 defsubr (&Sencode_coding_string);
6482 defsubr (&Sdecode_sjis_char);
6483 defsubr (&Sencode_sjis_char);
6484 defsubr (&Sdecode_big5_char);
6485 defsubr (&Sencode_big5_char);
6486 defsubr (&Sset_terminal_coding_system_internal);
6487 defsubr (&Sset_safe_terminal_coding_system_internal);
6488 defsubr (&Sterminal_coding_system);
6489 defsubr (&Sset_keyboard_coding_system_internal);
6490 defsubr (&Skeyboard_coding_system);
6491 defsubr (&Sfind_operation_coding_system);
6492 defsubr (&Supdate_coding_systems_internal);
6493 defsubr (&Sset_coding_priority_internal);
6495 DEFVAR_LISP ("coding-system-list", &Vcoding_system_list,
6496 "List of coding systems.\n\
6498 Do not alter the value of this variable manually. This variable should be\n\
6499 updated by the functions `make-coding-system' and\n\
6500 `define-coding-system-alias'.");
6501 Vcoding_system_list = Qnil;
6503 DEFVAR_LISP ("coding-system-alist", &Vcoding_system_alist,
6504 "Alist of coding system names.\n\
6505 Each element is one element list of coding system name.\n\
6506 This variable is given to `completing-read' as TABLE argument.\n\
6508 Do not alter the value of this variable manually. This variable should be\n\
6509 updated by the functions `make-coding-system' and\n\
6510 `define-coding-system-alias'.");
6511 Vcoding_system_alist = Qnil;
6513 DEFVAR_LISP ("coding-category-list", &Vcoding_category_list,
6514 "List of coding-categories (symbols) ordered by priority.");
6516 int i;
6518 Vcoding_category_list = Qnil;
6519 for (i = CODING_CATEGORY_IDX_MAX - 1; i >= 0; i--)
6520 Vcoding_category_list
6521 = Fcons (XVECTOR (Vcoding_category_table)->contents[i],
6522 Vcoding_category_list);
6525 DEFVAR_LISP ("coding-system-for-read", &Vcoding_system_for_read,
6526 "Specify the coding system for read operations.\n\
6527 It is useful to bind this variable with `let', but do not set it globally.\n\
6528 If the value is a coding system, it is used for decoding on read operation.\n\
6529 If not, an appropriate element is used from one of the coding system alists:\n\
6530 There are three such tables, `file-coding-system-alist',\n\
6531 `process-coding-system-alist', and `network-coding-system-alist'.");
6532 Vcoding_system_for_read = Qnil;
6534 DEFVAR_LISP ("coding-system-for-write", &Vcoding_system_for_write,
6535 "Specify the coding system for write operations.\n\
6536 Programs bind this variable with `let', but you should not set it globally.\n\
6537 If the value is a coding system, it is used for encoding of output,\n\
6538 when writing it to a file and when sending it to a file or subprocess.\n\
6540 If this does not specify a coding system, an appropriate element\n\
6541 is used from one of the coding system alists:\n\
6542 There are three such tables, `file-coding-system-alist',\n\
6543 `process-coding-system-alist', and `network-coding-system-alist'.\n\
6544 For output to files, if the above procedure does not specify a coding system,\n\
6545 the value of `buffer-file-coding-system' is used.");
6546 Vcoding_system_for_write = Qnil;
6548 DEFVAR_LISP ("last-coding-system-used", &Vlast_coding_system_used,
6549 "Coding system used in the latest file or process I/O.");
6550 Vlast_coding_system_used = Qnil;
6552 DEFVAR_BOOL ("inhibit-eol-conversion", &inhibit_eol_conversion,
6553 "*Non-nil means always inhibit code conversion of end-of-line format.\n\
6554 See info node `Coding Systems' and info node `Text and Binary' concerning\n\
6555 such conversion.");
6556 inhibit_eol_conversion = 0;
6558 DEFVAR_BOOL ("inherit-process-coding-system", &inherit_process_coding_system,
6559 "Non-nil means process buffer inherits coding system of process output.\n\
6560 Bind it to t if the process output is to be treated as if it were a file\n\
6561 read from some filesystem.");
6562 inherit_process_coding_system = 0;
6564 DEFVAR_LISP ("file-coding-system-alist", &Vfile_coding_system_alist,
6565 "Alist to decide a coding system to use for a file I/O operation.\n\
6566 The format is ((PATTERN . VAL) ...),\n\
6567 where PATTERN is a regular expression matching a file name,\n\
6568 VAL is a coding system, a cons of coding systems, or a function symbol.\n\
6569 If VAL is a coding system, it is used for both decoding and encoding\n\
6570 the file contents.\n\
6571 If VAL is a cons of coding systems, the car part is used for decoding,\n\
6572 and the cdr part is used for encoding.\n\
6573 If VAL is a function symbol, the function must return a coding system\n\
6574 or a cons of coding systems which are used as above.\n\
6576 See also the function `find-operation-coding-system'\n\
6577 and the variable `auto-coding-alist'.");
6578 Vfile_coding_system_alist = Qnil;
6580 DEFVAR_LISP ("process-coding-system-alist", &Vprocess_coding_system_alist,
6581 "Alist to decide a coding system to use for a process I/O operation.\n\
6582 The format is ((PATTERN . VAL) ...),\n\
6583 where PATTERN is a regular expression matching a program name,\n\
6584 VAL is a coding system, a cons of coding systems, or a function symbol.\n\
6585 If VAL is a coding system, it is used for both decoding what received\n\
6586 from the program and encoding what sent to the program.\n\
6587 If VAL is a cons of coding systems, the car part is used for decoding,\n\
6588 and the cdr part is used for encoding.\n\
6589 If VAL is a function symbol, the function must return a coding system\n\
6590 or a cons of coding systems which are used as above.\n\
6592 See also the function `find-operation-coding-system'.");
6593 Vprocess_coding_system_alist = Qnil;
6595 DEFVAR_LISP ("network-coding-system-alist", &Vnetwork_coding_system_alist,
6596 "Alist to decide a coding system to use for a network I/O operation.\n\
6597 The format is ((PATTERN . VAL) ...),\n\
6598 where PATTERN is a regular expression matching a network service name\n\
6599 or is a port number to connect to,\n\
6600 VAL is a coding system, a cons of coding systems, or a function symbol.\n\
6601 If VAL is a coding system, it is used for both decoding what received\n\
6602 from the network stream and encoding what sent to the network stream.\n\
6603 If VAL is a cons of coding systems, the car part is used for decoding,\n\
6604 and the cdr part is used for encoding.\n\
6605 If VAL is a function symbol, the function must return a coding system\n\
6606 or a cons of coding systems which are used as above.\n\
6608 See also the function `find-operation-coding-system'.");
6609 Vnetwork_coding_system_alist = Qnil;
6611 DEFVAR_LISP ("locale-coding-system", &Vlocale_coding_system,
6612 "Coding system to use with system messages.");
6613 Vlocale_coding_system = Qnil;
6615 /* The eol mnemonics are reset in startup.el system-dependently. */
6616 DEFVAR_LISP ("eol-mnemonic-unix", &eol_mnemonic_unix,
6617 "*String displayed in mode line for UNIX-like (LF) end-of-line format.");
6618 eol_mnemonic_unix = build_string (":");
6620 DEFVAR_LISP ("eol-mnemonic-dos", &eol_mnemonic_dos,
6621 "*String displayed in mode line for DOS-like (CRLF) end-of-line format.");
6622 eol_mnemonic_dos = build_string ("\\");
6624 DEFVAR_LISP ("eol-mnemonic-mac", &eol_mnemonic_mac,
6625 "*String displayed in mode line for MAC-like (CR) end-of-line format.");
6626 eol_mnemonic_mac = build_string ("/");
6628 DEFVAR_LISP ("eol-mnemonic-undecided", &eol_mnemonic_undecided,
6629 "*String displayed in mode line when end-of-line format is not yet determined.");
6630 eol_mnemonic_undecided = build_string (":");
6632 DEFVAR_LISP ("enable-character-translation", &Venable_character_translation,
6633 "*Non-nil enables character translation while encoding and decoding.");
6634 Venable_character_translation = Qt;
6636 DEFVAR_LISP ("standard-translation-table-for-decode",
6637 &Vstandard_translation_table_for_decode,
6638 "Table for translating characters while decoding.");
6639 Vstandard_translation_table_for_decode = Qnil;
6641 DEFVAR_LISP ("standard-translation-table-for-encode",
6642 &Vstandard_translation_table_for_encode,
6643 "Table for translationg characters while encoding.");
6644 Vstandard_translation_table_for_encode = Qnil;
6646 DEFVAR_LISP ("charset-revision-table", &Vcharset_revision_alist,
6647 "Alist of charsets vs revision numbers.\n\
6648 While encoding, if a charset (car part of an element) is found,\n\
6649 designate it with the escape sequence identifing revision (cdr part of the element).");
6650 Vcharset_revision_alist = Qnil;
6652 DEFVAR_LISP ("default-process-coding-system",
6653 &Vdefault_process_coding_system,
6654 "Cons of coding systems used for process I/O by default.\n\
6655 The car part is used for decoding a process output,\n\
6656 the cdr part is used for encoding a text to be sent to a process.");
6657 Vdefault_process_coding_system = Qnil;
6659 DEFVAR_LISP ("latin-extra-code-table", &Vlatin_extra_code_table,
6660 "Table of extra Latin codes in the range 128..159 (inclusive).\n\
6661 This is a vector of length 256.\n\
6662 If Nth element is non-nil, the existence of code N in a file\n\
6663 \(or output of subprocess) doesn't prevent it to be detected as\n\
6664 a coding system of ISO 2022 variant which has a flag\n\
6665 `accept-latin-extra-code' t (e.g. iso-latin-1) on reading a file\n\
6666 or reading output of a subprocess.\n\
6667 Only 128th through 159th elements has a meaning.");
6668 Vlatin_extra_code_table = Fmake_vector (make_number (256), Qnil);
6670 DEFVAR_LISP ("select-safe-coding-system-function",
6671 &Vselect_safe_coding_system_function,
6672 "Function to call to select safe coding system for encoding a text.\n\
6674 If set, this function is called to force a user to select a proper\n\
6675 coding system which can encode the text in the case that a default\n\
6676 coding system used in each operation can't encode the text.\n\
6678 The default value is `select-safe-coding-system' (which see).");
6679 Vselect_safe_coding_system_function = Qnil;
6681 DEFVAR_LISP ("char-coding-system-table", &Vchar_coding_system_table,
6682 "Char-table containing safe coding systems of each characters.\n\
6683 Each element doesn't include such generic coding systems that can\n\
6684 encode any characters. They are in the first extra slot.");
6685 Vchar_coding_system_table = Fmake_char_table (Qchar_coding_system, Qnil);
6687 DEFVAR_BOOL ("inhibit-iso-escape-detection",
6688 &inhibit_iso_escape_detection,
6689 "If non-nil, Emacs ignores ISO2022's escape sequence on code detection.\n\
6691 By default, on reading a file, Emacs tries to detect how the text is\n\
6692 encoded. This code detection is sensitive to escape sequences. If\n\
6693 the sequence is valid as ISO2022, the code is determined as one of\n\
6694 the ISO2022 encodings, and the file is decoded by the corresponding\n\
6695 coding system (e.g. `iso-2022-7bit').\n\
6697 However, there may be a case that you want to read escape sequences in\n\
6698 a file as is. In such a case, you can set this variable to non-nil.\n\
6699 Then, as the code detection ignores any escape sequences, no file is\n\
6700 detected as encoded in some ISO2022 encoding. The result is that all\n\
6701 escape sequences become visible in a buffer.\n\
6703 The default value is nil, and it is strongly recommended not to change\n\
6704 it. That is because many Emacs Lisp source files that contain\n\
6705 non-ASCII characters are encoded by the coding system `iso-2022-7bit'\n\
6706 in Emacs's distribution, and they won't be decoded correctly on\n\
6707 reading if you suppress escape sequence detection.\n\
6709 The other way to read escape sequences in a file without decoding is\n\
6710 to explicitly specify some coding system that doesn't use ISO2022's\n\
6711 escape sequence (e.g `latin-1') on reading by \\[universal-coding-system-argument].");
6712 inhibit_iso_escape_detection = 0;
6715 char *
6716 emacs_strerror (error_number)
6717 int error_number;
6719 char *str;
6721 synchronize_system_messages_locale ();
6722 str = strerror (error_number);
6724 if (! NILP (Vlocale_coding_system))
6726 Lisp_Object dec = code_convert_string_norecord (build_string (str),
6727 Vlocale_coding_system,
6729 str = (char *) XSTRING (dec)->data;
6732 return str;
6735 #endif /* emacs */