1 /* Code conversion functions.
2 Copyright (C) 1991, 1995 Free Software Foundation, Inc.
3 Copyright (C) 1995 Sun Microsystems, Inc.
4 Copyright (C) 1999,2000,2001,2002,2003,2004 MORIOKA Tomohiko
6 This file is part of XEmacs.
8 XEmacs is free software; you can redistribute it and/or modify it
9 under the terms of the GNU General Public License as published by the
10 Free Software Foundation; either version 2, or (at your option) any
13 XEmacs is distributed in the hope that it will be useful, but WITHOUT
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 You should have received a copy of the GNU General Public License
19 along with XEmacs; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
23 /* Synched up with: Mule 2.3. Not in FSF. */
25 /* Rewritten by Ben Wing <ben@xemacs.org>. */
26 /* Rewritten by MORIOKA Tomohiko <tomo@m17n.org> for XEmacs CHISE. */
40 #include "file-coding.h"
42 Lisp_Object Qcoding_system_error;
44 Lisp_Object Vkeyboard_coding_system;
45 Lisp_Object Vterminal_coding_system;
46 Lisp_Object Vcoding_system_for_read;
47 Lisp_Object Vcoding_system_for_write;
48 Lisp_Object Vfile_name_coding_system;
50 Lisp_Object Vcoded_charset_entity_reference_alist;
52 /* Table of symbols identifying each coding category. */
53 Lisp_Object coding_category_symbol[CODING_CATEGORY_LAST];
57 struct file_coding_dump {
58 /* Coding system currently associated with each coding category. */
59 Lisp_Object coding_category_system[CODING_CATEGORY_LAST];
61 /* Table of all coding categories in decreasing order of priority.
62 This describes a permutation of the possible coding categories. */
63 int coding_category_by_priority[CODING_CATEGORY_LAST];
65 #if defined(MULE) && !defined(UTF2000)
66 Lisp_Object ucs_to_mule_table[65536];
70 static const struct lrecord_description fcd_description_1[] = {
71 { XD_LISP_OBJECT_ARRAY, offsetof (struct file_coding_dump, coding_category_system), CODING_CATEGORY_LAST },
72 #if defined(MULE) && !defined(UTF2000)
73 { XD_LISP_OBJECT_ARRAY, offsetof (struct file_coding_dump, ucs_to_mule_table), countof (fcd->ucs_to_mule_table) },
78 static const struct struct_description fcd_description = {
79 sizeof (struct file_coding_dump),
83 Lisp_Object mule_to_ucs_table;
85 Lisp_Object Qcoding_systemp;
87 Lisp_Object Qraw_text, Qno_conversion, Qccl, Qiso2022;
88 /* Qinternal in general.c */
90 Lisp_Object Qmnemonic, Qeol_type;
91 Lisp_Object Qcr, Qcrlf, Qlf;
92 Lisp_Object Qeol_cr, Qeol_crlf, Qeol_lf;
93 Lisp_Object Qpost_read_conversion;
94 Lisp_Object Qpre_write_conversion;
97 Lisp_Object Qucs4, Qutf16, Qutf8;
98 Lisp_Object Qbig5, Qshift_jis;
99 Lisp_Object Qcharset_g0, Qcharset_g1, Qcharset_g2, Qcharset_g3;
100 Lisp_Object Qforce_g0_on_output, Qforce_g1_on_output;
101 Lisp_Object Qforce_g2_on_output, Qforce_g3_on_output;
102 Lisp_Object Qno_iso6429;
103 Lisp_Object Qinput_charset_conversion, Qoutput_charset_conversion;
104 Lisp_Object Qescape_quoted;
105 Lisp_Object Qshort, Qno_ascii_eol, Qno_ascii_cntl, Qseven, Qlock_shift;
108 Lisp_Object Qutf_8_mcs;
109 Lisp_Object Qdisable_composition;
110 Lisp_Object Quse_entity_reference;
111 Lisp_Object Qd, Qx, QX;
113 Lisp_Object Qencode, Qdecode;
115 Lisp_Object Vcoding_system_hash_table;
117 int enable_multibyte_characters;
120 /* Additional information used by the ISO2022 decoder and detector. */
121 struct iso2022_decoder
123 /* CHARSET holds the character sets currently assigned to the G0
124 through G3 variables. It is initialized from the array
125 INITIAL_CHARSET in CODESYS. */
126 Lisp_Object charset[4];
128 /* Which registers are currently invoked into the left (GL) and
129 right (GR) halves of the 8-bit encoding space? */
130 int register_left, register_right;
132 /* ISO_ESC holds a value indicating part of an escape sequence
133 that has already been seen. */
134 enum iso_esc_flag esc;
136 /* This records the bytes we've seen so far in an escape sequence,
137 in case the sequence is invalid (we spit out the bytes unchanged). */
138 unsigned char esc_bytes[8];
140 /* Index for next byte to store in ISO escape sequence. */
143 #ifdef ENABLE_COMPOSITE_CHARS
144 /* Stuff seen so far when composing a string. */
145 unsigned_char_dynarr *composite_chars;
148 /* If we saw an invalid designation sequence for a particular
149 register, we flag it here and switch to ASCII. The next time we
150 see a valid designation for this register, we turn off the flag
151 and do the designation normally, but pretend the sequence was
152 invalid. The effect of all this is that (most of the time) the
153 escape sequences for both the switch to the unknown charset, and
154 the switch back to the known charset, get inserted literally into
155 the buffer and saved out as such. The hope is that we can
156 preserve the escape sequences so that the resulting written out
157 file makes sense. If we don't do any of this, the designation
158 to the invalid charset will be preserved but that switch back
159 to the known charset will probably get eaten because it was
160 the same charset that was already present in the register. */
161 unsigned char invalid_designated[4];
163 /* We try to do similar things as above for direction-switching
164 sequences. If we encountered a direction switch while an
165 invalid designation was present, or an invalid designation
166 just after a direction switch (i.e. no valid designation
167 encountered yet), we insert the direction-switch escape
168 sequence literally into the output stream, and later on
169 insert the corresponding direction-restoring escape sequence
171 unsigned int switched_dir_and_no_valid_charset_yet :1;
172 unsigned int invalid_switch_dir :1;
174 /* Tells the decoder to output the escape sequence literally
175 even though it was valid. Used in the games we play to
176 avoid lossage when we encounter invalid designations. */
177 unsigned int output_literally :1;
178 /* We encountered a direction switch followed by an invalid
179 designation. We didn't output the direction switch
180 literally because we didn't know about the invalid designation;
181 but we have to do so now. */
182 unsigned int output_direction_sequence :1;
185 EXFUN (Fcopy_coding_system, 2);
187 struct detection_state;
190 text_encode_generic (Lstream *encoding, const Bufbyte *src,
191 unsigned_char_dynarr *dst, Lstream_data_count n);
193 static int detect_coding_sjis (struct detection_state *st,
194 const Extbyte *src, Lstream_data_count n);
195 static void decode_coding_sjis (Lstream *decoding, const Extbyte *src,
196 unsigned_char_dynarr *dst, Lstream_data_count n);
197 void char_encode_shift_jis (struct encoding_stream *str, Emchar c,
198 unsigned_char_dynarr *dst, unsigned int *flags);
199 void char_finish_shift_jis (struct encoding_stream *str,
200 unsigned_char_dynarr *dst, unsigned int *flags);
202 static int detect_coding_big5 (struct detection_state *st,
203 const Extbyte *src, Lstream_data_count n);
204 static void decode_coding_big5 (Lstream *decoding, const Extbyte *src,
205 unsigned_char_dynarr *dst, Lstream_data_count n);
206 void char_encode_big5 (struct encoding_stream *str, Emchar c,
207 unsigned_char_dynarr *dst, unsigned int *flags);
208 void char_finish_big5 (struct encoding_stream *str,
209 unsigned_char_dynarr *dst, unsigned int *flags);
211 static int detect_coding_ucs4 (struct detection_state *st,
212 const Extbyte *src, Lstream_data_count n);
213 static void decode_coding_ucs4 (Lstream *decoding, const Extbyte *src,
214 unsigned_char_dynarr *dst, Lstream_data_count n);
215 void char_encode_ucs4 (struct encoding_stream *str, Emchar c,
216 unsigned_char_dynarr *dst, unsigned int *flags);
217 void char_finish_ucs4 (struct encoding_stream *str,
218 unsigned_char_dynarr *dst, unsigned int *flags);
220 static int detect_coding_utf16 (struct detection_state *st,
221 const Extbyte *src, Lstream_data_count n);
222 static void decode_coding_utf16 (Lstream *decoding, const Extbyte *src,
223 unsigned_char_dynarr *dst, Lstream_data_count n);
224 void char_encode_utf16 (struct encoding_stream *str, Emchar c,
225 unsigned_char_dynarr *dst, unsigned int *flags);
226 void char_finish_utf16 (struct encoding_stream *str,
227 unsigned_char_dynarr *dst, unsigned int *flags);
229 static int detect_coding_utf8 (struct detection_state *st,
230 const Extbyte *src, Lstream_data_count n);
231 static void decode_coding_utf8 (Lstream *decoding, const Extbyte *src,
232 unsigned_char_dynarr *dst, Lstream_data_count n);
233 void char_encode_utf8 (struct encoding_stream *str, Emchar c,
234 unsigned_char_dynarr *dst, unsigned int *flags);
235 void char_finish_utf8 (struct encoding_stream *str,
236 unsigned_char_dynarr *dst, unsigned int *flags);
238 static int postprocess_iso2022_mask (int mask);
239 static void reset_iso2022 (Lisp_Object coding_system,
240 struct iso2022_decoder *iso);
241 static int detect_coding_iso2022 (struct detection_state *st,
242 const Extbyte *src, Lstream_data_count n);
243 static void decode_coding_iso2022 (Lstream *decoding, const Extbyte *src,
244 unsigned_char_dynarr *dst, Lstream_data_count n);
245 void char_encode_iso2022 (struct encoding_stream *str, Emchar c,
246 unsigned_char_dynarr *dst, unsigned int *flags);
247 void char_finish_iso2022 (struct encoding_stream *str,
248 unsigned_char_dynarr *dst, unsigned int *flags);
250 static void decode_coding_no_conversion (Lstream *decoding, const Extbyte *src,
251 unsigned_char_dynarr *dst, Lstream_data_count n);
252 static void encode_coding_no_conversion (Lstream *encoding, const Bufbyte *src,
253 unsigned_char_dynarr *dst, Lstream_data_count n);
254 static void mule_decode (Lstream *decoding, const Extbyte *src,
255 unsigned_char_dynarr *dst, Lstream_data_count n);
256 static void mule_encode (Lstream *encoding, const Bufbyte *src,
257 unsigned_char_dynarr *dst, Lstream_data_count n);
259 typedef struct codesys_prop codesys_prop;
268 Dynarr_declare (codesys_prop);
269 } codesys_prop_dynarr;
271 static const struct lrecord_description codesys_prop_description_1[] = {
272 { XD_LISP_OBJECT, offsetof (codesys_prop, sym) },
276 static const struct struct_description codesys_prop_description = {
277 sizeof (codesys_prop),
278 codesys_prop_description_1
281 static const struct lrecord_description codesys_prop_dynarr_description_1[] = {
282 XD_DYNARR_DESC (codesys_prop_dynarr, &codesys_prop_description),
286 static const struct struct_description codesys_prop_dynarr_description = {
287 sizeof (codesys_prop_dynarr),
288 codesys_prop_dynarr_description_1
291 codesys_prop_dynarr *the_codesys_prop_dynarr;
293 enum codesys_prop_enum
296 CODESYS_PROP_ISO2022,
301 /************************************************************************/
302 /* Coding system functions */
303 /************************************************************************/
305 static Lisp_Object mark_coding_system (Lisp_Object);
306 static void print_coding_system (Lisp_Object, Lisp_Object, int);
307 static void finalize_coding_system (void *header, int for_disksave);
310 static const struct lrecord_description ccs_description_1[] = {
311 { XD_LISP_OBJECT, offsetof (charset_conversion_spec, from_charset) },
312 { XD_LISP_OBJECT, offsetof (charset_conversion_spec, to_charset) },
316 static const struct struct_description ccs_description = {
317 sizeof (charset_conversion_spec),
321 static const struct lrecord_description ccsd_description_1[] = {
322 XD_DYNARR_DESC (charset_conversion_spec_dynarr, &ccs_description),
326 static const struct struct_description ccsd_description = {
327 sizeof (charset_conversion_spec_dynarr),
332 static const struct lrecord_description coding_system_description[] = {
333 { XD_LISP_OBJECT, offsetof (Lisp_Coding_System, name) },
334 { XD_LISP_OBJECT, offsetof (Lisp_Coding_System, doc_string) },
335 { XD_LISP_OBJECT, offsetof (Lisp_Coding_System, mnemonic) },
336 { XD_LISP_OBJECT, offsetof (Lisp_Coding_System, post_read_conversion) },
337 { XD_LISP_OBJECT, offsetof (Lisp_Coding_System, pre_write_conversion) },
338 { XD_LISP_OBJECT, offsetof (Lisp_Coding_System, eol_lf) },
339 { XD_LISP_OBJECT, offsetof (Lisp_Coding_System, eol_crlf) },
340 { XD_LISP_OBJECT, offsetof (Lisp_Coding_System, eol_cr) },
342 { XD_LISP_OBJECT_ARRAY, offsetof (Lisp_Coding_System, iso2022.initial_charset), 4 },
343 { XD_STRUCT_PTR, offsetof (Lisp_Coding_System, iso2022.input_conv), 1, &ccsd_description },
344 { XD_STRUCT_PTR, offsetof (Lisp_Coding_System, iso2022.output_conv), 1, &ccsd_description },
345 { XD_LISP_OBJECT, offsetof (Lisp_Coding_System, ccl.decode) },
346 { XD_LISP_OBJECT, offsetof (Lisp_Coding_System, ccl.encode) },
348 { XD_LISP_OBJECT, offsetof (Lisp_Coding_System, ccs_priority_list) },
354 DEFINE_LRECORD_IMPLEMENTATION ("coding-system", coding_system,
355 mark_coding_system, print_coding_system,
356 finalize_coding_system,
357 0, 0, coding_system_description,
361 mark_coding_system (Lisp_Object obj)
363 Lisp_Coding_System *codesys = XCODING_SYSTEM (obj);
365 mark_object (CODING_SYSTEM_NAME (codesys));
366 mark_object (CODING_SYSTEM_DOC_STRING (codesys));
367 mark_object (CODING_SYSTEM_MNEMONIC (codesys));
368 mark_object (CODING_SYSTEM_EOL_LF (codesys));
369 mark_object (CODING_SYSTEM_EOL_CRLF (codesys));
370 mark_object (CODING_SYSTEM_EOL_CR (codesys));
372 switch (CODING_SYSTEM_TYPE (codesys))
376 case CODESYS_ISO2022:
377 for (i = 0; i < 4; i++)
378 mark_object (CODING_SYSTEM_ISO2022_INITIAL_CHARSET (codesys, i));
379 if (codesys->iso2022.input_conv)
381 for (i = 0; i < Dynarr_length (codesys->iso2022.input_conv); i++)
383 struct charset_conversion_spec *ccs =
384 Dynarr_atp (codesys->iso2022.input_conv, i);
385 mark_object (ccs->from_charset);
386 mark_object (ccs->to_charset);
389 if (codesys->iso2022.output_conv)
391 for (i = 0; i < Dynarr_length (codesys->iso2022.output_conv); i++)
393 struct charset_conversion_spec *ccs =
394 Dynarr_atp (codesys->iso2022.output_conv, i);
395 mark_object (ccs->from_charset);
396 mark_object (ccs->to_charset);
403 mark_object (CODING_SYSTEM_ISO2022_INITIAL_CHARSET (codesys, 0));
404 mark_object (CODING_SYSTEM_ISO2022_INITIAL_CHARSET (codesys, 1));
409 mark_object (CODING_SYSTEM_CCL_DECODE (codesys));
410 mark_object (CODING_SYSTEM_CCL_ENCODE (codesys));
417 mark_object (CODING_SYSTEM_PRE_WRITE_CONVERSION (codesys));
419 mark_object (CODING_SYSTEM_CCS_PRIORITY_LIST (codesys));
421 return CODING_SYSTEM_POST_READ_CONVERSION (codesys);
425 print_coding_system (Lisp_Object obj, Lisp_Object printcharfun,
428 Lisp_Coding_System *c = XCODING_SYSTEM (obj);
430 error ("printing unreadable object #<coding_system 0x%x>",
433 write_c_string ("#<coding_system ", printcharfun);
434 print_internal (c->name, printcharfun, 1);
435 write_c_string (">", printcharfun);
439 finalize_coding_system (void *header, int for_disksave)
441 Lisp_Coding_System *c = (Lisp_Coding_System *) header;
442 /* Since coding systems never go away, this function is not
443 necessary. But it would be necessary if we changed things
444 so that coding systems could go away. */
445 if (!for_disksave) /* see comment in lstream.c */
447 switch (CODING_SYSTEM_TYPE (c))
450 case CODESYS_ISO2022:
451 if (c->iso2022.input_conv)
453 Dynarr_free (c->iso2022.input_conv);
454 c->iso2022.input_conv = 0;
456 if (c->iso2022.output_conv)
458 Dynarr_free (c->iso2022.output_conv);
459 c->iso2022.output_conv = 0;
470 symbol_to_eol_type (Lisp_Object symbol)
472 CHECK_SYMBOL (symbol);
473 if (NILP (symbol)) return EOL_AUTODETECT;
474 if (EQ (symbol, Qlf)) return EOL_LF;
475 if (EQ (symbol, Qcrlf)) return EOL_CRLF;
476 if (EQ (symbol, Qcr)) return EOL_CR;
478 signal_simple_error ("Unrecognized eol type", symbol);
479 return EOL_AUTODETECT; /* not reached */
483 eol_type_to_symbol (eol_type_t type)
488 case EOL_LF: return Qlf;
489 case EOL_CRLF: return Qcrlf;
490 case EOL_CR: return Qcr;
491 case EOL_AUTODETECT: return Qnil;
496 setup_eol_coding_systems (Lisp_Coding_System *codesys)
498 Lisp_Object codesys_obj;
499 int len = string_length (XSYMBOL (CODING_SYSTEM_NAME (codesys))->name);
500 char *codesys_name = (char *) alloca (len + 7);
502 char *codesys_mnemonic=0;
504 Lisp_Object codesys_name_sym, sub_codesys_obj;
508 XSETCODING_SYSTEM (codesys_obj, codesys);
510 memcpy (codesys_name,
511 string_data (XSYMBOL (CODING_SYSTEM_NAME (codesys))->name), len);
513 if (STRINGP (CODING_SYSTEM_MNEMONIC (codesys)))
515 mlen = XSTRING_LENGTH (CODING_SYSTEM_MNEMONIC (codesys));
516 codesys_mnemonic = (char *) alloca (mlen + 7);
517 memcpy (codesys_mnemonic,
518 XSTRING_DATA (CODING_SYSTEM_MNEMONIC (codesys)), mlen);
521 #define DEFINE_SUB_CODESYS(op_sys, op_sys_abbr, Type) do { \
522 strcpy (codesys_name + len, "-" op_sys); \
524 strcpy (codesys_mnemonic + mlen, op_sys_abbr); \
525 codesys_name_sym = intern (codesys_name); \
526 sub_codesys_obj = Fcopy_coding_system (codesys_obj, codesys_name_sym); \
527 XCODING_SYSTEM_EOL_TYPE (sub_codesys_obj) = Type; \
529 XCODING_SYSTEM_MNEMONIC(sub_codesys_obj) = \
530 build_string (codesys_mnemonic); \
531 CODING_SYSTEM_##Type (codesys) = sub_codesys_obj; \
534 DEFINE_SUB_CODESYS("unix", "", EOL_LF);
535 DEFINE_SUB_CODESYS("dos", ":T", EOL_CRLF);
536 DEFINE_SUB_CODESYS("mac", ":t", EOL_CR);
539 DEFUN ("coding-system-p", Fcoding_system_p, 1, 1, 0, /*
540 Return t if OBJECT is a coding system.
541 A coding system is an object that defines how text containing multiple
542 character sets is encoded into a stream of (typically 8-bit) bytes.
543 The coding system is used to decode the stream into a series of
544 characters (which may be from multiple charsets) when the text is read
545 from a file or process, and is used to encode the text back into the
546 same format when it is written out to a file or process.
548 For example, many ISO2022-compliant coding systems (such as Compound
549 Text, which is used for inter-client data under the X Window System)
550 use escape sequences to switch between different charsets -- Japanese
551 Kanji, for example, is invoked with "ESC $ ( B"; ASCII is invoked
552 with "ESC ( B"; and Cyrillic is invoked with "ESC - L". See
553 `make-coding-system' for more information.
555 Coding systems are normally identified using a symbol, and the
556 symbol is accepted in place of the actual coding system object whenever
557 a coding system is called for. (This is similar to how faces work.)
561 return CODING_SYSTEMP (object) ? Qt : Qnil;
564 DEFUN ("find-coding-system", Ffind_coding_system, 1, 1, 0, /*
565 Retrieve the coding system of the given name.
567 If CODING-SYSTEM-OR-NAME is a coding-system object, it is simply
568 returned. Otherwise, CODING-SYSTEM-OR-NAME should be a symbol.
569 If there is no such coding system, nil is returned. Otherwise the
570 associated coding system object is returned.
572 (coding_system_or_name))
574 if (NILP (coding_system_or_name))
575 coding_system_or_name = Qbinary;
576 else if (CODING_SYSTEMP (coding_system_or_name))
577 return coding_system_or_name;
579 CHECK_SYMBOL (coding_system_or_name);
583 coding_system_or_name =
584 Fgethash (coding_system_or_name, Vcoding_system_hash_table, Qnil);
586 if (CODING_SYSTEMP (coding_system_or_name) || NILP (coding_system_or_name))
587 return coding_system_or_name;
591 DEFUN ("get-coding-system", Fget_coding_system, 1, 1, 0, /*
592 Retrieve the coding system of the given name.
593 Same as `find-coding-system' except that if there is no such
594 coding system, an error is signaled instead of returning nil.
598 Lisp_Object coding_system = Ffind_coding_system (name);
600 if (NILP (coding_system))
601 signal_simple_error ("No such coding system", name);
602 return coding_system;
605 /* We store the coding systems in hash tables with the names as the key and the
606 actual coding system object as the value. Occasionally we need to use them
607 in a list format. These routines provide us with that. */
608 struct coding_system_list_closure
610 Lisp_Object *coding_system_list;
614 add_coding_system_to_list_mapper (Lisp_Object key, Lisp_Object value,
615 void *coding_system_list_closure)
617 /* This function can GC */
618 struct coding_system_list_closure *cscl =
619 (struct coding_system_list_closure *) coding_system_list_closure;
620 Lisp_Object *coding_system_list = cscl->coding_system_list;
622 *coding_system_list = Fcons (key, *coding_system_list);
626 DEFUN ("coding-system-list", Fcoding_system_list, 0, 0, 0, /*
627 Return a list of the names of all defined coding systems.
631 Lisp_Object coding_system_list = Qnil;
633 struct coding_system_list_closure coding_system_list_closure;
635 GCPRO1 (coding_system_list);
636 coding_system_list_closure.coding_system_list = &coding_system_list;
637 elisp_maphash (add_coding_system_to_list_mapper, Vcoding_system_hash_table,
638 &coding_system_list_closure);
641 return coding_system_list;
644 DEFUN ("coding-system-name", Fcoding_system_name, 1, 1, 0, /*
645 Return the name of the given coding system.
649 coding_system = Fget_coding_system (coding_system);
650 return XCODING_SYSTEM_NAME (coding_system);
653 static Lisp_Coding_System *
654 allocate_coding_system (enum coding_system_type type, Lisp_Object name)
656 Lisp_Coding_System *codesys =
657 alloc_lcrecord_type (Lisp_Coding_System, &lrecord_coding_system);
659 zero_lcrecord (codesys);
660 CODING_SYSTEM_PRE_WRITE_CONVERSION (codesys) = Qnil;
661 CODING_SYSTEM_POST_READ_CONVERSION (codesys) = Qnil;
662 CODING_SYSTEM_EOL_TYPE (codesys) = EOL_AUTODETECT;
663 CODING_SYSTEM_EOL_CRLF (codesys) = Qnil;
664 CODING_SYSTEM_EOL_CR (codesys) = Qnil;
665 CODING_SYSTEM_EOL_LF (codesys) = Qnil;
666 CODING_SYSTEM_TYPE (codesys) = type;
667 CODING_SYSTEM_MNEMONIC (codesys) = Qnil;
670 CODING_SYSTEM_CCS_PRIORITY_LIST (codesys) = Qnil;
672 if (type == CODESYS_ISO2022)
675 for (i = 0; i < 4; i++)
676 CODING_SYSTEM_ISO2022_INITIAL_CHARSET (codesys, i) = Qnil;
679 if (type == CODESYS_UTF8)
681 CODING_SYSTEM_ISO2022_INITIAL_CHARSET (codesys, 0)
683 CODING_SYSTEM_ISO2022_INITIAL_CHARSET (codesys, 1)
685 CODING_SYSTEM_ISO2022_INITIAL_CHARSET (codesys, 2)
687 CODING_SYSTEM_ISO2022_INITIAL_CHARSET (codesys, 3)
690 else if (type == CODESYS_BIG5)
692 CODING_SYSTEM_ISO2022_INITIAL_CHARSET (codesys, 0)
694 CODING_SYSTEM_ISO2022_INITIAL_CHARSET (codesys, 1)
695 = Vcharset_chinese_big5;
696 CODING_SYSTEM_ISO2022_INITIAL_CHARSET (codesys, 2)
698 CODING_SYSTEM_ISO2022_INITIAL_CHARSET (codesys, 3)
702 else if (type == CODESYS_CCL)
704 CODING_SYSTEM_CCL_DECODE (codesys) = Qnil;
705 CODING_SYSTEM_CCL_ENCODE (codesys) = Qnil;
708 CODING_SYSTEM_NAME (codesys) = name;
714 /* Given a list of charset conversion specs as specified in a Lisp
715 program, parse it into STORE_HERE. */
718 parse_charset_conversion_specs (charset_conversion_spec_dynarr *store_here,
719 Lisp_Object spec_list)
723 EXTERNAL_LIST_LOOP (rest, spec_list)
725 Lisp_Object car = XCAR (rest);
726 Lisp_Object from, to;
727 struct charset_conversion_spec spec;
729 if (!CONSP (car) || !CONSP (XCDR (car)) || !NILP (XCDR (XCDR (car))))
730 signal_simple_error ("Invalid charset conversion spec", car);
731 from = Fget_charset (XCAR (car));
732 to = Fget_charset (XCAR (XCDR (car)));
733 if ( (XCHARSET_CHARS (from) != XCHARSET_CHARS (to)) ||
734 (XCHARSET_DIMENSION (from) != XCHARSET_DIMENSION (to)) )
735 signal_simple_error_2
736 ("Attempted conversion between different charset types",
738 spec.from_charset = from;
739 spec.to_charset = to;
741 Dynarr_add (store_here, spec);
745 /* Given a dynarr LOAD_HERE of internally-stored charset conversion
746 specs, return the equivalent as the Lisp programmer would see it.
748 If LOAD_HERE is 0, return Qnil. */
751 unparse_charset_conversion_specs (charset_conversion_spec_dynarr *load_here)
758 for (i = 0, result = Qnil; i < Dynarr_length (load_here); i++)
760 struct charset_conversion_spec *ccs = Dynarr_atp (load_here, i);
761 result = Fcons (list2 (ccs->from_charset, ccs->to_charset), result);
764 return Fnreverse (result);
769 DEFUN ("make-coding-system", Fmake_coding_system, 2, 4, 0, /*
770 Register symbol NAME as a coding system.
772 TYPE describes the conversion method used and should be one of
775 Automatic conversion. XEmacs attempts to detect the coding system
778 No conversion. Use this for binary files and such. On output,
779 graphic characters that are not in ASCII or Latin-1 will be
780 replaced by a ?. (For a no-conversion-encoded buffer, these
781 characters will only be present if you explicitly insert them.)
783 Shift-JIS (a Japanese encoding commonly used in PC operating systems).
785 ISO 10646 UCS-4 encoding.
787 ISO 10646 UTF-8 encoding.
789 Any ISO2022-compliant encoding. Among other things, this includes
790 JIS (the Japanese encoding commonly used for e-mail), EUC (the
791 standard Unix encoding for Japanese and other languages), and
792 Compound Text (the encoding used in X11). You can specify more
793 specific information about the conversion with the PROPS argument.
795 Big5 (the encoding commonly used for Taiwanese).
797 The conversion is performed using a user-written pseudo-code
798 program. CCL (Code Conversion Language) is the name of this
801 Write out or read in the raw contents of the memory representing
802 the buffer's text. This is primarily useful for debugging
803 purposes, and is only enabled when XEmacs has been compiled with
804 DEBUG_XEMACS defined (via the --debug configure option).
805 WARNING: Reading in a file using 'internal conversion can result
806 in an internal inconsistency in the memory representing a
807 buffer's text, which will produce unpredictable results and may
808 cause XEmacs to crash. Under normal circumstances you should
809 never use 'internal conversion.
811 DOC-STRING is a string describing the coding system.
813 PROPS is a property list, describing the specific nature of the
814 character set. Recognized properties are:
817 String to be displayed in the modeline when this coding system is
821 End-of-line conversion to be used. It should be one of
824 Automatically detect the end-of-line type (LF, CRLF,
825 or CR). Also generate subsidiary coding systems named
826 `NAME-unix', `NAME-dos', and `NAME-mac', that are
827 identical to this coding system but have an EOL-TYPE
828 value of 'lf, 'crlf, and 'cr, respectively.
830 The end of a line is marked externally using ASCII LF.
831 Since this is also the way that XEmacs represents an
832 end-of-line internally, specifying this option results
833 in no end-of-line conversion. This is the standard
834 format for Unix text files.
836 The end of a line is marked externally using ASCII
837 CRLF. This is the standard format for MS-DOS text
840 The end of a line is marked externally using ASCII CR.
841 This is the standard format for Macintosh text files.
843 Automatically detect the end-of-line type but do not
844 generate subsidiary coding systems. (This value is
845 converted to nil when stored internally, and
846 `coding-system-property' will return nil.)
849 If non-nil, composition/decomposition for combining characters
852 'use-entity-reference
853 If non-nil, SGML style entity-reference is used for non-system-characters.
855 'post-read-conversion
856 Function called after a file has been read in, to perform the
857 decoding. Called with two arguments, START and END, denoting
858 a region of the current buffer to be decoded.
860 'pre-write-conversion
861 Function called before a file is written out, to perform the
862 encoding. Called with two arguments, START and END, denoting
863 a region of the current buffer to be encoded.
866 The following additional properties are recognized if TYPE is 'iso2022:
872 The character set initially designated to the G0 - G3 registers.
873 The value should be one of
875 -- A charset object (designate that character set)
876 -- nil (do not ever use this register)
877 -- t (no character set is initially designated to
878 the register, but may be later on; this automatically
879 sets the corresponding `force-g*-on-output' property)
885 If non-nil, send an explicit designation sequence on output before
886 using the specified register.
889 If non-nil, use the short forms "ESC $ @", "ESC $ A", and
890 "ESC $ B" on output in place of the full designation sequences
891 "ESC $ ( @", "ESC $ ( A", and "ESC $ ( B".
894 If non-nil, don't designate ASCII to G0 at each end of line on output.
895 Setting this to non-nil also suppresses other state-resetting that
896 normally happens at the end of a line.
899 If non-nil, don't designate ASCII to G0 before control chars on output.
902 If non-nil, use 7-bit environment on output. Otherwise, use 8-bit
906 If non-nil, use locking-shift (SO/SI) instead of single-shift
907 or designation by escape sequence.
910 If non-nil, don't use ISO6429's direction specification.
913 If non-nil, literal control characters that are the same as
914 the beginning of a recognized ISO2022 or ISO6429 escape sequence
915 (in particular, ESC (0x1B), SO (0x0E), SI (0x0F), SS2 (0x8E),
916 SS3 (0x8F), and CSI (0x9B)) are "quoted" with an escape character
917 so that they can be properly distinguished from an escape sequence.
918 (Note that doing this results in a non-portable encoding.) This
919 encoding flag is used for byte-compiled files. Note that ESC
920 is a good choice for a quoting character because there are no
921 escape sequences whose second byte is a character from the Control-0
922 or Control-1 character sets; this is explicitly disallowed by the
925 'input-charset-conversion
926 A list of conversion specifications, specifying conversion of
927 characters in one charset to another when decoding is performed.
928 Each specification is a list of two elements: the source charset,
929 and the destination charset.
931 'output-charset-conversion
932 A list of conversion specifications, specifying conversion of
933 characters in one charset to another when encoding is performed.
934 The form of each specification is the same as for
935 'input-charset-conversion.
938 The following additional properties are recognized (and required)
942 CCL program used for decoding (converting to internal format).
945 CCL program used for encoding (converting to external format).
947 (name, type, doc_string, props))
949 Lisp_Coding_System *codesys;
950 enum coding_system_type ty;
951 int need_to_setup_eol_systems = 1;
953 /* Convert type to constant */
954 if (NILP (type) || EQ (type, Qundecided))
955 { ty = CODESYS_AUTODETECT; }
957 else if (EQ (type, Qshift_jis)) { ty = CODESYS_SHIFT_JIS; }
958 else if (EQ (type, Qiso2022)) { ty = CODESYS_ISO2022; }
959 else if (EQ (type, Qbig5)) { ty = CODESYS_BIG5; }
960 else if (EQ (type, Qucs4)) { ty = CODESYS_UCS4; }
961 else if (EQ (type, Qutf16)) { ty = CODESYS_UTF16; }
962 else if (EQ (type, Qutf8)) { ty = CODESYS_UTF8; }
963 else if (EQ (type, Qccl)) { ty = CODESYS_CCL; }
965 else if (EQ (type, Qno_conversion)) { ty = CODESYS_NO_CONVERSION; }
967 else if (EQ (type, Qinternal)) { ty = CODESYS_INTERNAL; }
970 signal_simple_error ("Invalid coding system type", type);
974 codesys = allocate_coding_system (ty, name);
976 if (NILP (doc_string))
977 doc_string = build_string ("");
979 CHECK_STRING (doc_string);
980 CODING_SYSTEM_DOC_STRING (codesys) = doc_string;
983 EXTERNAL_PROPERTY_LIST_LOOP_3 (key, value, props)
985 if (EQ (key, Qmnemonic))
988 CHECK_STRING (value);
989 CODING_SYSTEM_MNEMONIC (codesys) = value;
992 else if (EQ (key, Qeol_type))
994 need_to_setup_eol_systems = NILP (value);
997 CODING_SYSTEM_EOL_TYPE (codesys) = symbol_to_eol_type (value);
1000 else if (EQ (key, Qpost_read_conversion))
1001 CODING_SYSTEM_POST_READ_CONVERSION (codesys) = value;
1002 else if (EQ (key, Qpre_write_conversion))
1003 CODING_SYSTEM_PRE_WRITE_CONVERSION (codesys) = value;
1005 else if (EQ (key, Qdisable_composition))
1006 CODING_SYSTEM_DISABLE_COMPOSITION (codesys) = !NILP (value);
1007 else if (EQ (key, Quse_entity_reference))
1008 CODING_SYSTEM_USE_ENTITY_REFERENCE (codesys) = !NILP (value);
1011 else if (ty == CODESYS_ISO2022)
1013 #define FROB_INITIAL_CHARSET(charset_num) \
1014 CODING_SYSTEM_ISO2022_INITIAL_CHARSET (codesys, charset_num) = \
1015 ((EQ (value, Qt) || EQ (value, Qnil)) ? value : Fget_charset (value))
1017 if (EQ (key, Qcharset_g0)) FROB_INITIAL_CHARSET (0);
1018 else if (EQ (key, Qcharset_g1)) FROB_INITIAL_CHARSET (1);
1019 else if (EQ (key, Qcharset_g2)) FROB_INITIAL_CHARSET (2);
1020 else if (EQ (key, Qcharset_g3)) FROB_INITIAL_CHARSET (3);
1022 #define FROB_FORCE_CHARSET(charset_num) \
1023 CODING_SYSTEM_ISO2022_FORCE_CHARSET_ON_OUTPUT (codesys, charset_num) = !NILP (value)
1025 else if (EQ (key, Qforce_g0_on_output)) FROB_FORCE_CHARSET (0);
1026 else if (EQ (key, Qforce_g1_on_output)) FROB_FORCE_CHARSET (1);
1027 else if (EQ (key, Qforce_g2_on_output)) FROB_FORCE_CHARSET (2);
1028 else if (EQ (key, Qforce_g3_on_output)) FROB_FORCE_CHARSET (3);
1030 #define FROB_BOOLEAN_PROPERTY(prop) \
1031 CODING_SYSTEM_ISO2022_##prop (codesys) = !NILP (value)
1033 else if (EQ (key, Qshort)) FROB_BOOLEAN_PROPERTY (SHORT);
1034 else if (EQ (key, Qno_ascii_eol)) FROB_BOOLEAN_PROPERTY (NO_ASCII_EOL);
1035 else if (EQ (key, Qno_ascii_cntl)) FROB_BOOLEAN_PROPERTY (NO_ASCII_CNTL);
1036 else if (EQ (key, Qseven)) FROB_BOOLEAN_PROPERTY (SEVEN);
1037 else if (EQ (key, Qlock_shift)) FROB_BOOLEAN_PROPERTY (LOCK_SHIFT);
1038 else if (EQ (key, Qno_iso6429)) FROB_BOOLEAN_PROPERTY (NO_ISO6429);
1039 else if (EQ (key, Qescape_quoted)) FROB_BOOLEAN_PROPERTY (ESCAPE_QUOTED);
1041 else if (EQ (key, Qinput_charset_conversion))
1043 codesys->iso2022.input_conv =
1044 Dynarr_new (charset_conversion_spec);
1045 parse_charset_conversion_specs (codesys->iso2022.input_conv,
1048 else if (EQ (key, Qoutput_charset_conversion))
1050 codesys->iso2022.output_conv =
1051 Dynarr_new (charset_conversion_spec);
1052 parse_charset_conversion_specs (codesys->iso2022.output_conv,
1056 signal_simple_error ("Unrecognized property", key);
1059 else if (ty == CODESYS_UTF8)
1061 if (EQ (key, Qcharset_g0)) FROB_INITIAL_CHARSET (0);
1062 else if (EQ (key, Qcharset_g1))
1063 CODING_SYSTEM_ISO2022_INITIAL_CHARSET (codesys, 1) = value;
1064 else if (EQ (key, Qcharset_g2))
1065 CODING_SYSTEM_ISO2022_INITIAL_CHARSET (codesys, 2) = value;
1067 signal_simple_error ("Unrecognized property", key);
1069 else if (ty == CODESYS_BIG5)
1071 if (EQ (key, Qcharset_g0)) FROB_INITIAL_CHARSET (0);
1072 else if (EQ (key, Qcharset_g1)) FROB_INITIAL_CHARSET (1);
1074 signal_simple_error ("Unrecognized property", key);
1077 else if (EQ (type, Qccl))
1080 struct ccl_program test_ccl;
1083 /* Check key first. */
1084 if (EQ (key, Qdecode))
1085 suffix = "-ccl-decode";
1086 else if (EQ (key, Qencode))
1087 suffix = "-ccl-encode";
1089 signal_simple_error ("Unrecognized property", key);
1091 /* If value is vector, register it as a ccl program
1092 associated with an newly created symbol for
1093 backward compatibility. */
1094 if (VECTORP (value))
1096 sym = Fintern (concat2 (Fsymbol_name (name),
1097 build_string (suffix)),
1099 Fregister_ccl_program (sym, value);
1103 CHECK_SYMBOL (value);
1106 /* check if the given ccl programs are valid. */
1107 if (setup_ccl_program (&test_ccl, sym) < 0)
1108 signal_simple_error ("Invalid CCL program", value);
1110 if (EQ (key, Qdecode))
1111 CODING_SYSTEM_CCL_DECODE (codesys) = sym;
1112 else if (EQ (key, Qencode))
1113 CODING_SYSTEM_CCL_ENCODE (codesys) = sym;
1118 signal_simple_error ("Unrecognized property", key);
1122 if (need_to_setup_eol_systems)
1123 setup_eol_coding_systems (codesys);
1126 Lisp_Object codesys_obj;
1127 XSETCODING_SYSTEM (codesys_obj, codesys);
1128 Fputhash (name, codesys_obj, Vcoding_system_hash_table);
1133 DEFUN ("copy-coding-system", Fcopy_coding_system, 2, 2, 0, /*
1134 Copy OLD-CODING-SYSTEM to NEW-NAME.
1135 If NEW-NAME does not name an existing coding system, a new one will
1138 (old_coding_system, new_name))
1140 Lisp_Object new_coding_system;
1141 old_coding_system = Fget_coding_system (old_coding_system);
1142 new_coding_system = Ffind_coding_system (new_name);
1143 if (NILP (new_coding_system))
1145 XSETCODING_SYSTEM (new_coding_system,
1146 allocate_coding_system
1147 (XCODING_SYSTEM_TYPE (old_coding_system),
1149 Fputhash (new_name, new_coding_system, Vcoding_system_hash_table);
1153 Lisp_Coding_System *to = XCODING_SYSTEM (new_coding_system);
1154 Lisp_Coding_System *from = XCODING_SYSTEM (old_coding_system);
1155 memcpy (((char *) to ) + sizeof (to->header),
1156 ((char *) from) + sizeof (from->header),
1157 sizeof (*from) - sizeof (from->header));
1158 to->name = new_name;
1160 return new_coding_system;
1163 DEFUN ("coding-system-canonical-name-p", Fcoding_system_canonical_name_p, 1, 1, 0, /*
1164 Return t if OBJECT names a coding system, and is not a coding system alias.
1168 return CODING_SYSTEMP (Fgethash (object, Vcoding_system_hash_table, Qnil))
1172 DEFUN ("coding-system-alias-p", Fcoding_system_alias_p, 1, 1, 0, /*
1173 Return t if OBJECT is a coding system alias.
1174 All coding system aliases are created by `define-coding-system-alias'.
1178 return SYMBOLP (Fgethash (object, Vcoding_system_hash_table, Qzero))
1182 DEFUN ("coding-system-aliasee", Fcoding_system_aliasee, 1, 1, 0, /*
1183 Return the coding-system symbol for which symbol ALIAS is an alias.
1187 Lisp_Object aliasee = Fgethash (alias, Vcoding_system_hash_table, Qnil);
1188 if (SYMBOLP (aliasee))
1191 signal_simple_error ("Symbol is not a coding system alias", alias);
1192 return Qnil; /* To keep the compiler happy */
1196 append_suffix_to_symbol (Lisp_Object symbol, const char *ascii_string)
1198 return Fintern (concat2 (Fsymbol_name (symbol), build_string (ascii_string)),
1202 /* A maphash function, for removing dangling coding system aliases. */
1204 dangling_coding_system_alias_p (Lisp_Object alias,
1205 Lisp_Object aliasee,
1206 void *dangling_aliases)
1208 if (SYMBOLP (aliasee)
1209 && NILP (Fgethash (aliasee, Vcoding_system_hash_table, Qnil)))
1211 (*(int *) dangling_aliases)++;
1218 DEFUN ("define-coding-system-alias", Fdefine_coding_system_alias, 2, 2, 0, /*
1219 Define symbol ALIAS as an alias for coding system ALIASEE.
1221 You can use this function to redefine an alias that has already been defined,
1222 but you cannot redefine a name which is the canonical name for a coding system.
1223 \(a canonical name of a coding system is what is returned when you call
1224 `coding-system-name' on a coding system).
1226 ALIASEE itself can be an alias, which allows you to define nested aliases.
1228 You are forbidden, however, from creating alias loops or `dangling' aliases.
1229 These will be detected, and an error will be signaled if you attempt to do so.
1231 If ALIASEE is nil, then ALIAS will simply be undefined.
1233 See also `coding-system-alias-p', `coding-system-aliasee',
1234 and `coding-system-canonical-name-p'.
1238 Lisp_Object real_coding_system, probe;
1240 CHECK_SYMBOL (alias);
1242 if (!NILP (Fcoding_system_canonical_name_p (alias)))
1244 ("Symbol is the canonical name of a coding system and cannot be redefined",
1249 Lisp_Object subsidiary_unix = append_suffix_to_symbol (alias, "-unix");
1250 Lisp_Object subsidiary_dos = append_suffix_to_symbol (alias, "-dos");
1251 Lisp_Object subsidiary_mac = append_suffix_to_symbol (alias, "-mac");
1253 Fremhash (alias, Vcoding_system_hash_table);
1255 /* Undefine subsidiary aliases,
1256 presumably created by a previous call to this function */
1257 if (! NILP (Fcoding_system_alias_p (subsidiary_unix)) &&
1258 ! NILP (Fcoding_system_alias_p (subsidiary_dos)) &&
1259 ! NILP (Fcoding_system_alias_p (subsidiary_mac)))
1261 Fdefine_coding_system_alias (subsidiary_unix, Qnil);
1262 Fdefine_coding_system_alias (subsidiary_dos, Qnil);
1263 Fdefine_coding_system_alias (subsidiary_mac, Qnil);
1266 /* Undefine dangling coding system aliases. */
1268 int dangling_aliases;
1271 dangling_aliases = 0;
1272 elisp_map_remhash (dangling_coding_system_alias_p,
1273 Vcoding_system_hash_table,
1275 } while (dangling_aliases > 0);
1281 if (CODING_SYSTEMP (aliasee))
1282 aliasee = XCODING_SYSTEM_NAME (aliasee);
1284 /* Checks that aliasee names a coding-system */
1285 real_coding_system = Fget_coding_system (aliasee);
1287 /* Check for coding system alias loops */
1288 if (EQ (alias, aliasee))
1289 alias_loop: signal_simple_error_2
1290 ("Attempt to create a coding system alias loop", alias, aliasee);
1292 for (probe = aliasee;
1294 probe = Fgethash (probe, Vcoding_system_hash_table, Qzero))
1296 if (EQ (probe, alias))
1300 Fputhash (alias, aliasee, Vcoding_system_hash_table);
1302 /* Set up aliases for subsidiaries.
1303 #### There must be a better way to handle subsidiary coding systems. */
1305 static const char *suffixes[] = { "-unix", "-dos", "-mac" };
1307 for (i = 0; i < countof (suffixes); i++)
1309 Lisp_Object alias_subsidiary =
1310 append_suffix_to_symbol (alias, suffixes[i]);
1311 Lisp_Object aliasee_subsidiary =
1312 append_suffix_to_symbol (aliasee, suffixes[i]);
1314 if (! NILP (Ffind_coding_system (aliasee_subsidiary)))
1315 Fdefine_coding_system_alias (alias_subsidiary, aliasee_subsidiary);
1318 /* FSF return value is a vector of [ALIAS-unix ALIAS-dos ALIAS-mac],
1319 but it doesn't look intentional, so I'd rather return something
1320 meaningful or nothing at all. */
1325 subsidiary_coding_system (Lisp_Object coding_system, eol_type_t type)
1327 Lisp_Coding_System *cs = XCODING_SYSTEM (coding_system);
1328 Lisp_Object new_coding_system;
1330 if (CODING_SYSTEM_EOL_TYPE (cs) != EOL_AUTODETECT)
1331 return coding_system;
1335 case EOL_AUTODETECT: return coding_system;
1336 case EOL_LF: new_coding_system = CODING_SYSTEM_EOL_LF (cs); break;
1337 case EOL_CR: new_coding_system = CODING_SYSTEM_EOL_CR (cs); break;
1338 case EOL_CRLF: new_coding_system = CODING_SYSTEM_EOL_CRLF (cs); break;
1339 default: abort (); return Qnil;
1342 return NILP (new_coding_system) ? coding_system : new_coding_system;
1345 DEFUN ("subsidiary-coding-system", Fsubsidiary_coding_system, 2, 2, 0, /*
1346 Return the subsidiary coding system of CODING-SYSTEM with eol type EOL-TYPE.
1348 (coding_system, eol_type))
1350 coding_system = Fget_coding_system (coding_system);
1352 return subsidiary_coding_system (coding_system,
1353 symbol_to_eol_type (eol_type));
1357 /************************************************************************/
1358 /* Coding system accessors */
1359 /************************************************************************/
1361 DEFUN ("coding-system-doc-string", Fcoding_system_doc_string, 1, 1, 0, /*
1362 Return the doc string for CODING-SYSTEM.
1366 coding_system = Fget_coding_system (coding_system);
1367 return XCODING_SYSTEM_DOC_STRING (coding_system);
1370 DEFUN ("coding-system-type", Fcoding_system_type, 1, 1, 0, /*
1371 Return the type of CODING-SYSTEM.
1375 switch (XCODING_SYSTEM_TYPE (Fget_coding_system (coding_system)))
1378 case CODESYS_AUTODETECT: return Qundecided;
1380 case CODESYS_SHIFT_JIS: return Qshift_jis;
1381 case CODESYS_ISO2022: return Qiso2022;
1382 case CODESYS_BIG5: return Qbig5;
1383 case CODESYS_UCS4: return Qucs4;
1384 case CODESYS_UTF16: return Qutf16;
1385 case CODESYS_UTF8: return Qutf8;
1386 case CODESYS_CCL: return Qccl;
1388 case CODESYS_NO_CONVERSION: return Qno_conversion;
1390 case CODESYS_INTERNAL: return Qinternal;
1397 Lisp_Object coding_system_charset (Lisp_Object coding_system, int gnum)
1400 = XCODING_SYSTEM_ISO2022_INITIAL_CHARSET (coding_system, gnum);
1402 return CHARSETP (cs) ? XCHARSET_NAME (cs) : Qnil;
1405 DEFUN ("coding-system-charset", Fcoding_system_charset, 2, 2, 0, /*
1406 Return initial charset of CODING-SYSTEM designated to GNUM.
1409 (coding_system, gnum))
1411 coding_system = Fget_coding_system (coding_system);
1414 return coding_system_charset (coding_system, XINT (gnum));
1418 DEFUN ("coding-system-property", Fcoding_system_property, 2, 2, 0, /*
1419 Return the PROP property of CODING-SYSTEM.
1421 (coding_system, prop))
1424 enum coding_system_type type;
1426 coding_system = Fget_coding_system (coding_system);
1427 CHECK_SYMBOL (prop);
1428 type = XCODING_SYSTEM_TYPE (coding_system);
1430 for (i = 0; !ok && i < Dynarr_length (the_codesys_prop_dynarr); i++)
1431 if (EQ (Dynarr_at (the_codesys_prop_dynarr, i).sym, prop))
1434 switch (Dynarr_at (the_codesys_prop_dynarr, i).prop_type)
1436 case CODESYS_PROP_ALL_OK:
1439 case CODESYS_PROP_ISO2022:
1440 if (type != CODESYS_ISO2022)
1442 ("Property only valid in ISO2022 coding systems",
1446 case CODESYS_PROP_CCL:
1447 if (type != CODESYS_CCL)
1449 ("Property only valid in CCL coding systems",
1459 signal_simple_error ("Unrecognized property", prop);
1461 if (EQ (prop, Qname))
1462 return XCODING_SYSTEM_NAME (coding_system);
1463 else if (EQ (prop, Qtype))
1464 return Fcoding_system_type (coding_system);
1465 else if (EQ (prop, Qdoc_string))
1466 return XCODING_SYSTEM_DOC_STRING (coding_system);
1467 else if (EQ (prop, Qmnemonic))
1468 return XCODING_SYSTEM_MNEMONIC (coding_system);
1469 else if (EQ (prop, Qeol_type))
1470 return eol_type_to_symbol (XCODING_SYSTEM_EOL_TYPE (coding_system));
1471 else if (EQ (prop, Qeol_lf))
1472 return XCODING_SYSTEM_EOL_LF (coding_system);
1473 else if (EQ (prop, Qeol_crlf))
1474 return XCODING_SYSTEM_EOL_CRLF (coding_system);
1475 else if (EQ (prop, Qeol_cr))
1476 return XCODING_SYSTEM_EOL_CR (coding_system);
1477 else if (EQ (prop, Qpost_read_conversion))
1478 return XCODING_SYSTEM_POST_READ_CONVERSION (coding_system);
1479 else if (EQ (prop, Qpre_write_conversion))
1480 return XCODING_SYSTEM_PRE_WRITE_CONVERSION (coding_system);
1483 else if (EQ (prop, Qdisable_composition))
1484 return XCODING_SYSTEM_DISABLE_COMPOSITION (coding_system) ? Qt : Qnil;
1485 else if (EQ (prop, Quse_entity_reference))
1486 return XCODING_SYSTEM_USE_ENTITY_REFERENCE (coding_system) ? Qt : Qnil;
1488 else if (type == CODESYS_ISO2022)
1490 if (EQ (prop, Qcharset_g0))
1491 return coding_system_charset (coding_system, 0);
1492 else if (EQ (prop, Qcharset_g1))
1493 return coding_system_charset (coding_system, 1);
1494 else if (EQ (prop, Qcharset_g2))
1495 return coding_system_charset (coding_system, 2);
1496 else if (EQ (prop, Qcharset_g3))
1497 return coding_system_charset (coding_system, 3);
1499 #define FORCE_CHARSET(charset_num) \
1500 (XCODING_SYSTEM_ISO2022_FORCE_CHARSET_ON_OUTPUT \
1501 (coding_system, charset_num) ? Qt : Qnil)
1503 else if (EQ (prop, Qforce_g0_on_output)) return FORCE_CHARSET (0);
1504 else if (EQ (prop, Qforce_g1_on_output)) return FORCE_CHARSET (1);
1505 else if (EQ (prop, Qforce_g2_on_output)) return FORCE_CHARSET (2);
1506 else if (EQ (prop, Qforce_g3_on_output)) return FORCE_CHARSET (3);
1508 #define LISP_BOOLEAN(prop) \
1509 (XCODING_SYSTEM_ISO2022_##prop (coding_system) ? Qt : Qnil)
1511 else if (EQ (prop, Qshort)) return LISP_BOOLEAN (SHORT);
1512 else if (EQ (prop, Qno_ascii_eol)) return LISP_BOOLEAN (NO_ASCII_EOL);
1513 else if (EQ (prop, Qno_ascii_cntl)) return LISP_BOOLEAN (NO_ASCII_CNTL);
1514 else if (EQ (prop, Qseven)) return LISP_BOOLEAN (SEVEN);
1515 else if (EQ (prop, Qlock_shift)) return LISP_BOOLEAN (LOCK_SHIFT);
1516 else if (EQ (prop, Qno_iso6429)) return LISP_BOOLEAN (NO_ISO6429);
1517 else if (EQ (prop, Qescape_quoted)) return LISP_BOOLEAN (ESCAPE_QUOTED);
1519 else if (EQ (prop, Qinput_charset_conversion))
1521 unparse_charset_conversion_specs
1522 (XCODING_SYSTEM (coding_system)->iso2022.input_conv);
1523 else if (EQ (prop, Qoutput_charset_conversion))
1525 unparse_charset_conversion_specs
1526 (XCODING_SYSTEM (coding_system)->iso2022.output_conv);
1530 else if (type == CODESYS_CCL)
1532 if (EQ (prop, Qdecode))
1533 return XCODING_SYSTEM_CCL_DECODE (coding_system);
1534 else if (EQ (prop, Qencode))
1535 return XCODING_SYSTEM_CCL_ENCODE (coding_system);
1543 return Qnil; /* not reached */
1547 /************************************************************************/
1548 /* Coding category functions */
1549 /************************************************************************/
1552 decode_coding_category (Lisp_Object symbol)
1556 CHECK_SYMBOL (symbol);
1557 for (i = 0; i < CODING_CATEGORY_LAST; i++)
1558 if (EQ (coding_category_symbol[i], symbol))
1561 signal_simple_error ("Unrecognized coding category", symbol);
1562 return 0; /* not reached */
1565 DEFUN ("coding-category-list", Fcoding_category_list, 0, 0, 0, /*
1566 Return a list of all recognized coding categories.
1571 Lisp_Object list = Qnil;
1573 for (i = CODING_CATEGORY_LAST - 1; i >= 0; i--)
1574 list = Fcons (coding_category_symbol[i], list);
1578 DEFUN ("set-coding-priority-list", Fset_coding_priority_list, 1, 1, 0, /*
1579 Change the priority order of the coding categories.
1580 LIST should be list of coding categories, in descending order of
1581 priority. Unspecified coding categories will be lower in priority
1582 than all specified ones, in the same relative order they were in
1587 int category_to_priority[CODING_CATEGORY_LAST];
1591 /* First generate a list that maps coding categories to priorities. */
1593 for (i = 0; i < CODING_CATEGORY_LAST; i++)
1594 category_to_priority[i] = -1;
1596 /* Highest priority comes from the specified list. */
1598 EXTERNAL_LIST_LOOP (rest, list)
1600 int cat = decode_coding_category (XCAR (rest));
1602 if (category_to_priority[cat] >= 0)
1603 signal_simple_error ("Duplicate coding category in list", XCAR (rest));
1604 category_to_priority[cat] = i++;
1607 /* Now go through the existing categories by priority to retrieve
1608 the categories not yet specified and preserve their priority
1610 for (j = 0; j < CODING_CATEGORY_LAST; j++)
1612 int cat = fcd->coding_category_by_priority[j];
1613 if (category_to_priority[cat] < 0)
1614 category_to_priority[cat] = i++;
1617 /* Now we need to construct the inverse of the mapping we just
1620 for (i = 0; i < CODING_CATEGORY_LAST; i++)
1621 fcd->coding_category_by_priority[category_to_priority[i]] = i;
1623 /* Phew! That was confusing. */
1627 DEFUN ("coding-priority-list", Fcoding_priority_list, 0, 0, 0, /*
1628 Return a list of coding categories in descending order of priority.
1633 Lisp_Object list = Qnil;
1635 for (i = CODING_CATEGORY_LAST - 1; i >= 0; i--)
1636 list = Fcons (coding_category_symbol[fcd->coding_category_by_priority[i]],
1641 DEFUN ("set-coding-category-system", Fset_coding_category_system, 2, 2, 0, /*
1642 Change the coding system associated with a coding category.
1644 (coding_category, coding_system))
1646 int cat = decode_coding_category (coding_category);
1648 coding_system = Fget_coding_system (coding_system);
1649 fcd->coding_category_system[cat] = coding_system;
1653 DEFUN ("coding-category-system", Fcoding_category_system, 1, 1, 0, /*
1654 Return the coding system associated with a coding category.
1658 int cat = decode_coding_category (coding_category);
1659 Lisp_Object sys = fcd->coding_category_system[cat];
1662 return XCODING_SYSTEM_NAME (sys);
1667 /************************************************************************/
1668 /* Detecting the encoding of data */
1669 /************************************************************************/
1671 struct detection_state
1673 eol_type_t eol_type;
1716 struct iso2022_decoder iso;
1718 int high_byte_count;
1719 unsigned int saw_single_shift:1;
1732 acceptable_control_char_p (int c)
1736 /* Allow and ignore control characters that you might
1737 reasonably see in a text file */
1742 case 8: /* backspace */
1743 case 11: /* vertical tab */
1744 case 12: /* form feed */
1745 case 26: /* MS-DOS C-z junk */
1746 case 31: /* '^_' -- for info */
1754 mask_has_at_most_one_bit_p (int mask)
1756 /* Perhaps the only thing useful you learn from intensive Microsoft
1757 technical interviews */
1758 return (mask & (mask - 1)) == 0;
1762 detect_eol_type (struct detection_state *st, const Extbyte *src,
1763 Lstream_data_count n)
1767 unsigned char c = *(unsigned char *)src++;
1770 if (st->eol.just_saw_cr)
1772 else if (st->eol.seen_anything)
1775 else if (st->eol.just_saw_cr)
1778 st->eol.just_saw_cr = 1;
1780 st->eol.just_saw_cr = 0;
1781 st->eol.seen_anything = 1;
1784 return EOL_AUTODETECT;
1787 /* Attempt to determine the encoding and EOL type of the given text.
1788 Before calling this function for the first type, you must initialize
1789 st->eol_type as appropriate and initialize st->mask to ~0.
1791 st->eol_type holds the determined EOL type, or EOL_AUTODETECT if
1794 st->mask holds the determined coding category mask, or ~0 if only
1795 ASCII has been seen so far.
1799 0 == st->eol_type is EOL_AUTODETECT and/or more than coding category
1800 is present in st->mask
1801 1 == definitive answers are here for both st->eol_type and st->mask
1805 detect_coding_type (struct detection_state *st, const Extbyte *src,
1806 Lstream_data_count n, int just_do_eol)
1808 if (st->eol_type == EOL_AUTODETECT)
1809 st->eol_type = detect_eol_type (st, src, n);
1812 return st->eol_type != EOL_AUTODETECT;
1814 if (!st->seen_non_ascii)
1816 for (; n; n--, src++)
1818 unsigned char c = *(unsigned char *) src;
1819 if ((c < 0x20 && !acceptable_control_char_p (c)) || c >= 0x80)
1821 st->seen_non_ascii = 1;
1823 st->shift_jis.mask = ~0;
1826 st->utf16.mask = ~0;
1828 st->iso2022.mask = ~0;
1838 if (!mask_has_at_most_one_bit_p (st->iso2022.mask))
1839 st->iso2022.mask = detect_coding_iso2022 (st, src, n);
1840 if (!mask_has_at_most_one_bit_p (st->shift_jis.mask))
1841 st->shift_jis.mask = detect_coding_sjis (st, src, n);
1842 if (!mask_has_at_most_one_bit_p (st->big5.mask))
1843 st->big5.mask = detect_coding_big5 (st, src, n);
1844 if (!mask_has_at_most_one_bit_p (st->utf8.mask))
1845 st->utf8.mask = detect_coding_utf8 (st, src, n);
1846 if (!mask_has_at_most_one_bit_p (st->utf16.mask))
1847 st->utf16.mask = detect_coding_utf16 (st, src, n);
1848 if (!mask_has_at_most_one_bit_p (st->ucs4.mask))
1849 st->ucs4.mask = detect_coding_ucs4 (st, src, n);
1852 = st->iso2022.mask | st->shift_jis.mask | st->big5.mask
1853 | st->utf8.mask | st->ucs4.mask;
1856 int retval = mask_has_at_most_one_bit_p (st->mask);
1857 st->mask |= CODING_CATEGORY_NO_CONVERSION_MASK;
1858 return retval && st->eol_type != EOL_AUTODETECT;
1863 coding_system_from_mask (int mask)
1867 /* If the file was entirely or basically ASCII, use the
1868 default value of `buffer-file-coding-system'. */
1869 Lisp_Object retval =
1870 XBUFFER (Vbuffer_defaults)->buffer_file_coding_system;
1873 retval = Ffind_coding_system (retval);
1877 (Qbad_variable, Qwarning,
1878 "Invalid `default-buffer-file-coding-system', set to nil");
1879 XBUFFER (Vbuffer_defaults)->buffer_file_coding_system = Qnil;
1883 retval = Fget_coding_system (Qraw_text);
1891 mask = postprocess_iso2022_mask (mask);
1893 /* Look through the coding categories by priority and find
1894 the first one that is allowed. */
1895 for (i = 0; i < CODING_CATEGORY_LAST; i++)
1897 cat = fcd->coding_category_by_priority[i];
1898 if ((mask & (1 << cat)) &&
1899 !NILP (fcd->coding_category_system[cat]))
1903 return fcd->coding_category_system[cat];
1905 return Fget_coding_system (Qraw_text);
1909 /* Given a seekable read stream and potential coding system and EOL type
1910 as specified, do any autodetection that is called for. If the
1911 coding system and/or EOL type are not `autodetect', they will be left
1912 alone; but this function will never return an autodetect coding system
1915 This function does not automatically fetch subsidiary coding systems;
1916 that should be unnecessary with the explicit eol-type argument. */
1918 #define LENGTH(string_constant) (sizeof (string_constant) - 1)
1919 /* number of leading lines to check for a coding cookie */
1920 #define LINES_TO_CHECK 2
1923 determine_real_coding_system (Lstream *stream, Lisp_Object *codesys_in_out,
1924 eol_type_t *eol_type_in_out)
1926 struct detection_state decst;
1928 if (*eol_type_in_out == EOL_AUTODETECT)
1929 *eol_type_in_out = XCODING_SYSTEM_EOL_TYPE (*codesys_in_out);
1932 decst.eol_type = *eol_type_in_out;
1935 /* If autodetection is called for, do it now. */
1936 if (XCODING_SYSTEM_TYPE (*codesys_in_out) == CODESYS_AUTODETECT
1937 || *eol_type_in_out == EOL_AUTODETECT)
1940 Lisp_Object coding_system = Qnil;
1942 Lstream_data_count nread = Lstream_read (stream, buf, sizeof (buf));
1944 int lines_checked = 0;
1946 /* Look for initial "-*-"; mode line prefix */
1948 scan_end = buf + nread - LENGTH ("-*-coding:?-*-");
1950 && lines_checked < LINES_TO_CHECK;
1952 if (*p == '-' && *(p+1) == '*' && *(p+2) == '-')
1954 Extbyte *local_vars_beg = p + 3;
1955 /* Look for final "-*-"; mode line suffix */
1956 for (p = local_vars_beg,
1957 scan_end = buf + nread - LENGTH ("-*-");
1959 && lines_checked < LINES_TO_CHECK;
1961 if (*p == '-' && *(p+1) == '*' && *(p+2) == '-')
1963 Extbyte *suffix = p;
1964 /* Look for "coding:" */
1965 for (p = local_vars_beg,
1966 scan_end = suffix - LENGTH ("coding:?");
1969 if (memcmp ("coding:", p, LENGTH ("coding:")) == 0
1970 && (p == local_vars_beg
1971 || (*(p-1) == ' ' ||
1977 p += LENGTH ("coding:");
1978 while (*p == ' ' || *p == '\t') p++;
1980 /* Get coding system name */
1981 save = *suffix; *suffix = '\0';
1982 /* Characters valid in a MIME charset name (rfc 1521),
1983 and in a Lisp symbol name. */
1984 n = strspn ( (char *) p,
1985 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
1986 "abcdefghijklmnopqrstuvwxyz"
1992 save = p[n]; p[n] = '\0';
1994 Ffind_coding_system (intern ((char *) p));
2001 /* #### file must use standard EOLs or we miss 2d line */
2002 /* #### not to mention this is broken for UTF-16 DOS files */
2003 else if (*p == '\n' || *p == '\r')
2006 /* skip past multibyte (DOS) newline */
2007 if (*p == '\r' && *(p+1) == '\n') p++;
2011 /* #### file must use standard EOLs or we miss 2d line */
2012 /* #### not to mention this is broken for UTF-16 DOS files */
2013 else if (*p == '\n' || *p == '\r')
2016 /* skip past multibyte (DOS) newline */
2017 if (*p == '\r' && *(p+1) == '\n') p++;
2020 if (NILP (coding_system))
2023 if (detect_coding_type (&decst, buf, nread,
2024 XCODING_SYSTEM_TYPE (*codesys_in_out)
2025 != CODESYS_AUTODETECT))
2027 nread = Lstream_read (stream, buf, sizeof (buf));
2033 else if (XCODING_SYSTEM_TYPE (*codesys_in_out) == CODESYS_AUTODETECT
2034 && XCODING_SYSTEM_EOL_TYPE (coding_system) == EOL_AUTODETECT)
2037 if (detect_coding_type (&decst, buf, nread, 1))
2039 nread = Lstream_read (stream, buf, sizeof (buf));
2045 *eol_type_in_out = decst.eol_type;
2046 if (XCODING_SYSTEM_TYPE (*codesys_in_out) == CODESYS_AUTODETECT)
2048 if (NILP (coding_system))
2049 *codesys_in_out = coding_system_from_mask (decst.mask);
2051 *codesys_in_out = coding_system;
2055 /* If we absolutely can't determine the EOL type, just assume LF. */
2056 if (*eol_type_in_out == EOL_AUTODETECT)
2057 *eol_type_in_out = EOL_LF;
2059 Lstream_rewind (stream);
2062 DEFUN ("detect-coding-region", Fdetect_coding_region, 2, 3, 0, /*
2063 Detect coding system of the text in the region between START and END.
2064 Return a list of possible coding systems ordered by priority.
2065 If only ASCII characters are found, return 'undecided or one of
2066 its subsidiary coding systems according to a detected end-of-line
2067 type. Optional arg BUFFER defaults to the current buffer.
2069 (start, end, buffer))
2071 Lisp_Object val = Qnil;
2072 struct buffer *buf = decode_buffer (buffer, 0);
2074 Lisp_Object instream, lb_instream;
2075 Lstream *istr, *lb_istr;
2076 struct detection_state decst;
2077 struct gcpro gcpro1, gcpro2;
2079 get_buffer_range_char (buf, start, end, &b, &e, 0);
2080 lb_instream = make_lisp_buffer_input_stream (buf, b, e, 0);
2081 lb_istr = XLSTREAM (lb_instream);
2082 instream = make_encoding_input_stream (lb_istr, Fget_coding_system (Qbinary));
2083 istr = XLSTREAM (instream);
2084 GCPRO2 (instream, lb_instream);
2086 decst.eol_type = EOL_AUTODETECT;
2090 Extbyte random_buffer[4096];
2091 Lstream_data_count nread = Lstream_read (istr, random_buffer, sizeof (random_buffer));
2095 if (detect_coding_type (&decst, random_buffer, nread, 0))
2099 if (decst.mask == ~0)
2100 val = subsidiary_coding_system (Fget_coding_system (Qundecided),
2108 decst.mask = postprocess_iso2022_mask (decst.mask);
2110 for (i = CODING_CATEGORY_LAST - 1; i >= 0; i--)
2112 int sys = fcd->coding_category_by_priority[i];
2113 if (decst.mask & (1 << sys))
2115 Lisp_Object codesys = fcd->coding_category_system[sys];
2116 if (!NILP (codesys))
2117 codesys = subsidiary_coding_system (codesys, decst.eol_type);
2118 val = Fcons (codesys, val);
2122 Lstream_close (istr);
2124 Lstream_delete (istr);
2125 Lstream_delete (lb_istr);
2130 /************************************************************************/
2131 /* Converting to internal Mule format ("decoding") */
2132 /************************************************************************/
2134 /* A decoding stream is a stream used for decoding text (i.e.
2135 converting from some external format to internal format).
2136 The decoding-stream object keeps track of the actual coding
2137 stream, the stream that is at the other end, and data that
2138 needs to be persistent across the lifetime of the stream. */
2140 /* Handle the EOL stuff related to just-read-in character C.
2141 EOL_TYPE is the EOL type of the coding stream.
2142 FLAGS is the current value of FLAGS in the coding stream, and may
2143 be modified by this macro. (The macro only looks at the
2144 CODING_STATE_CR flag.) DST is the Dynarr to which the decoded
2145 bytes are to be written. You need to also define a local goto
2146 label "label_continue_loop" that is at the end of the main
2147 character-reading loop.
2149 If C is a CR character, then this macro handles it entirely and
2150 jumps to label_continue_loop. Otherwise, this macro does not add
2151 anything to DST, and continues normally. You should continue
2152 processing C normally after this macro. */
2154 #define DECODE_HANDLE_EOL_TYPE(eol_type, c, flags, dst) \
2158 if (eol_type == EOL_CR) \
2159 Dynarr_add (dst, '\n'); \
2160 else if (eol_type != EOL_CRLF || flags & CODING_STATE_CR) \
2161 Dynarr_add (dst, c); \
2163 flags |= CODING_STATE_CR; \
2164 goto label_continue_loop; \
2166 else if (flags & CODING_STATE_CR) \
2167 { /* eol_type == CODING_SYSTEM_EOL_CRLF */ \
2169 Dynarr_add (dst, '\r'); \
2170 flags &= ~CODING_STATE_CR; \
2174 /* C should be a binary character in the range 0 - 255; convert
2175 to internal format and add to Dynarr DST. */
2178 #define DECODE_ADD_BINARY_CHAR(c, dst) \
2180 if (BYTE_ASCII_P (c)) \
2181 Dynarr_add (dst, c); \
2184 Dynarr_add (dst, (c >> 6) | 0xc0); \
2185 Dynarr_add (dst, (c & 0x3f) | 0x80); \
2189 INLINE_HEADER void DECODE_ADD_UCS_CHAR(Emchar c, unsigned_char_dynarr* dst);
2191 DECODE_ADD_UCS_CHAR(Emchar c, unsigned_char_dynarr* dst)
2195 Dynarr_add (dst, c);
2197 else if ( c <= 0x7ff )
2199 Dynarr_add (dst, (c >> 6) | 0xc0);
2200 Dynarr_add (dst, (c & 0x3f) | 0x80);
2202 else if ( c <= 0xffff )
2204 Dynarr_add (dst, (c >> 12) | 0xe0);
2205 Dynarr_add (dst, ((c >> 6) & 0x3f) | 0x80);
2206 Dynarr_add (dst, (c & 0x3f) | 0x80);
2208 else if ( c <= 0x1fffff )
2210 Dynarr_add (dst, (c >> 18) | 0xf0);
2211 Dynarr_add (dst, ((c >> 12) & 0x3f) | 0x80);
2212 Dynarr_add (dst, ((c >> 6) & 0x3f) | 0x80);
2213 Dynarr_add (dst, (c & 0x3f) | 0x80);
2215 else if ( c <= 0x3ffffff )
2217 Dynarr_add (dst, (c >> 24) | 0xf8);
2218 Dynarr_add (dst, ((c >> 18) & 0x3f) | 0x80);
2219 Dynarr_add (dst, ((c >> 12) & 0x3f) | 0x80);
2220 Dynarr_add (dst, ((c >> 6) & 0x3f) | 0x80);
2221 Dynarr_add (dst, (c & 0x3f) | 0x80);
2225 Dynarr_add (dst, (c >> 30) | 0xfc);
2226 Dynarr_add (dst, ((c >> 24) & 0x3f) | 0x80);
2227 Dynarr_add (dst, ((c >> 18) & 0x3f) | 0x80);
2228 Dynarr_add (dst, ((c >> 12) & 0x3f) | 0x80);
2229 Dynarr_add (dst, ((c >> 6) & 0x3f) | 0x80);
2230 Dynarr_add (dst, (c & 0x3f) | 0x80);
2234 #define DECODE_ADD_BINARY_CHAR(c, dst) \
2236 if (BYTE_ASCII_P (c)) \
2237 Dynarr_add (dst, c); \
2238 else if (BYTE_C1_P (c)) \
2240 Dynarr_add (dst, LEADING_BYTE_CONTROL_1); \
2241 Dynarr_add (dst, c + 0x20); \
2245 Dynarr_add (dst, LEADING_BYTE_LATIN_ISO8859_1); \
2246 Dynarr_add (dst, c); \
2251 #define DECODE_OUTPUT_PARTIAL_CHAR(ch) \
2255 DECODE_ADD_BINARY_CHAR (ch, dst); \
2260 #define DECODE_HANDLE_END_OF_CONVERSION(flags, ch, dst) \
2262 if (flags & CODING_STATE_END) \
2264 DECODE_OUTPUT_PARTIAL_CHAR (ch); \
2265 if (flags & CODING_STATE_CR) \
2266 Dynarr_add (dst, '\r'); \
2270 #define DECODING_STREAM_DATA(stream) LSTREAM_TYPE_DATA (stream, decoding)
2272 struct decoding_stream
2274 /* Coding system that governs the conversion. */
2275 Lisp_Coding_System *codesys;
2277 /* Stream that we read the encoded data from or
2278 write the decoded data to. */
2281 /* If we are reading, then we can return only a fixed amount of
2282 data, so if the conversion resulted in too much data, we store it
2283 here for retrieval the next time around. */
2284 unsigned_char_dynarr *runoff;
2286 /* FLAGS holds flags indicating the current state of the decoding.
2287 Some of these flags are dependent on the coding system. */
2290 /* CPOS holds a partially built-up code-point of character. */
2293 /* EOL_TYPE specifies the type of end-of-line conversion that
2294 currently applies. We need to keep this separate from the
2295 EOL type stored in CODESYS because the latter might indicate
2296 automatic EOL-type detection while the former will always
2297 indicate a particular EOL type. */
2298 eol_type_t eol_type;
2300 /* Additional ISO2022 information. We define the structure above
2301 because it's also needed by the detection routines. */
2302 struct iso2022_decoder iso2022;
2304 /* Additional information (the state of the running CCL program)
2305 used by the CCL decoder. */
2306 struct ccl_program ccl;
2308 /* counter for UTF-8 or UCS-4 */
2309 unsigned char counter;
2312 unsigned char er_counter;
2313 unsigned char er_buf[16];
2315 unsigned combined_char_count;
2316 Emchar combined_chars[16];
2317 Lisp_Object combining_table;
2319 struct detection_state decst;
2322 static Lstream_data_count decoding_reader (Lstream *stream,
2323 unsigned char *data, Lstream_data_count size);
2324 static Lstream_data_count decoding_writer (Lstream *stream,
2325 const unsigned char *data, Lstream_data_count size);
2326 static int decoding_rewinder (Lstream *stream);
2327 static int decoding_seekable_p (Lstream *stream);
2328 static int decoding_flusher (Lstream *stream);
2329 static int decoding_closer (Lstream *stream);
2331 static Lisp_Object decoding_marker (Lisp_Object stream);
2333 DEFINE_LSTREAM_IMPLEMENTATION ("decoding", lstream_decoding,
2334 sizeof (struct decoding_stream));
2337 decoding_marker (Lisp_Object stream)
2339 Lstream *str = DECODING_STREAM_DATA (XLSTREAM (stream))->other_end;
2340 Lisp_Object str_obj;
2342 /* We do not need to mark the coding systems or charsets stored
2343 within the stream because they are stored in a global list
2344 and automatically marked. */
2346 XSETLSTREAM (str_obj, str);
2347 mark_object (str_obj);
2348 if (str->imp->marker)
2349 return (str->imp->marker) (str_obj);
2354 /* Read SIZE bytes of data and store it into DATA. We are a decoding stream
2355 so we read data from the other end, decode it, and store it into DATA. */
2357 static Lstream_data_count
2358 decoding_reader (Lstream *stream, unsigned char *data, Lstream_data_count size)
2360 struct decoding_stream *str = DECODING_STREAM_DATA (stream);
2361 unsigned char *orig_data = data;
2362 Lstream_data_count read_size;
2363 int error_occurred = 0;
2365 /* We need to interface to mule_decode(), which expects to take some
2366 amount of data and store the result into a Dynarr. We have
2367 mule_decode() store into str->runoff, and take data from there
2370 /* We loop until we have enough data, reading chunks from the other
2371 end and decoding it. */
2374 /* Take data from the runoff if we can. Make sure to take at
2375 most SIZE bytes, and delete the data from the runoff. */
2376 if (Dynarr_length (str->runoff) > 0)
2378 Lstream_data_count chunk = min (size, (Lstream_data_count) Dynarr_length (str->runoff));
2379 memcpy (data, Dynarr_atp (str->runoff, 0), chunk);
2380 Dynarr_delete_many (str->runoff, 0, chunk);
2386 break; /* No more room for data */
2388 if (str->flags & CODING_STATE_END)
2389 /* This means that on the previous iteration, we hit the EOF on
2390 the other end. We loop once more so that mule_decode() can
2391 output any final stuff it may be holding, or any "go back
2392 to a sane state" escape sequences. (This latter makes sense
2393 during encoding.) */
2396 /* Exhausted the runoff, so get some more. DATA has at least
2397 SIZE bytes left of storage in it, so it's OK to read directly
2398 into it. (We'll be overwriting above, after we've decoded it
2399 into the runoff.) */
2400 read_size = Lstream_read (str->other_end, data, size);
2407 /* There might be some more end data produced in the translation.
2408 See the comment above. */
2409 str->flags |= CODING_STATE_END;
2410 mule_decode (stream, (Extbyte *) data, str->runoff, read_size);
2413 if (data - orig_data == 0)
2414 return error_occurred ? -1 : 0;
2416 return data - orig_data;
2419 static Lstream_data_count
2420 decoding_writer (Lstream *stream, const unsigned char *data, Lstream_data_count size)
2422 struct decoding_stream *str = DECODING_STREAM_DATA (stream);
2423 Lstream_data_count retval;
2425 /* Decode all our data into the runoff, and then attempt to write
2426 it all out to the other end. Remove whatever chunk we succeeded
2428 mule_decode (stream, (Extbyte *) data, str->runoff, size);
2429 retval = Lstream_write (str->other_end, Dynarr_atp (str->runoff, 0),
2430 Dynarr_length (str->runoff));
2432 Dynarr_delete_many (str->runoff, 0, retval);
2433 /* Do NOT return retval. The return value indicates how much
2434 of the incoming data was written, not how many bytes were
2440 reset_decoding_stream (struct decoding_stream *str)
2443 if (CODING_SYSTEM_TYPE (str->codesys) == CODESYS_ISO2022)
2445 Lisp_Object coding_system;
2446 XSETCODING_SYSTEM (coding_system, str->codesys);
2447 reset_iso2022 (coding_system, &str->iso2022);
2449 else if (CODING_SYSTEM_TYPE (str->codesys) == CODESYS_CCL)
2451 setup_ccl_program (&str->ccl, CODING_SYSTEM_CCL_DECODE (str->codesys));
2456 str->er_counter = 0;
2457 str->combined_char_count = 0;
2458 str->combining_table = Qnil;
2460 if (CODING_SYSTEM_TYPE (str->codesys) == CODESYS_AUTODETECT
2461 || CODING_SYSTEM_EOL_TYPE (str->codesys) == EOL_AUTODETECT)
2464 str->decst.eol_type = EOL_AUTODETECT;
2465 str->decst.mask = ~0;
2467 str->flags = str->cpos = 0;
2471 decoding_rewinder (Lstream *stream)
2473 struct decoding_stream *str = DECODING_STREAM_DATA (stream);
2474 reset_decoding_stream (str);
2475 Dynarr_reset (str->runoff);
2476 return Lstream_rewind (str->other_end);
2480 decoding_seekable_p (Lstream *stream)
2482 struct decoding_stream *str = DECODING_STREAM_DATA (stream);
2483 return Lstream_seekable_p (str->other_end);
2487 decoding_flusher (Lstream *stream)
2489 struct decoding_stream *str = DECODING_STREAM_DATA (stream);
2490 return Lstream_flush (str->other_end);
2494 decoding_closer (Lstream *stream)
2496 struct decoding_stream *str = DECODING_STREAM_DATA (stream);
2497 if (stream->flags & LSTREAM_FL_WRITE)
2499 str->flags |= CODING_STATE_END;
2500 decoding_writer (stream, 0, 0);
2502 Dynarr_free (str->runoff);
2504 #ifdef ENABLE_COMPOSITE_CHARS
2505 if (str->iso2022.composite_chars)
2506 Dynarr_free (str->iso2022.composite_chars);
2509 return Lstream_close (str->other_end);
2513 decoding_stream_coding_system (Lstream *stream)
2515 Lisp_Object coding_system;
2516 struct decoding_stream *str = DECODING_STREAM_DATA (stream);
2518 XSETCODING_SYSTEM (coding_system, str->codesys);
2519 return subsidiary_coding_system (coding_system, str->eol_type);
2523 set_decoding_stream_coding_system (Lstream *lstr, Lisp_Object codesys)
2525 Lisp_Coding_System *cs = XCODING_SYSTEM (codesys);
2526 struct decoding_stream *str = DECODING_STREAM_DATA (lstr);
2528 if (CODING_SYSTEM_EOL_TYPE (cs) != EOL_AUTODETECT)
2529 str->eol_type = CODING_SYSTEM_EOL_TYPE (cs);
2530 reset_decoding_stream (str);
2533 /* WARNING WARNING WARNING WARNING!!!!! If you open up a decoding
2534 stream for writing, no automatic code detection will be performed.
2535 The reason for this is that automatic code detection requires a
2536 seekable input. Things will also fail if you open a decoding
2537 stream for reading using a non-fully-specified coding system and
2538 a non-seekable input stream. */
2541 make_decoding_stream_1 (Lstream *stream, Lisp_Object codesys,
2544 Lstream *lstr = Lstream_new (lstream_decoding, mode);
2545 struct decoding_stream *str = DECODING_STREAM_DATA (lstr);
2549 str->other_end = stream;
2550 str->runoff = (unsigned_char_dynarr *) Dynarr_new (unsigned_char);
2551 str->eol_type = EOL_AUTODETECT;
2552 if (!strcmp (mode, "r")
2553 && Lstream_seekable_p (stream))
2554 /* We can determine the coding system now. */
2555 determine_real_coding_system (stream, &codesys, &str->eol_type);
2556 set_decoding_stream_coding_system (lstr, codesys);
2557 str->decst.eol_type = str->eol_type;
2558 str->decst.mask = ~0;
2559 XSETLSTREAM (obj, lstr);
2564 make_decoding_input_stream (Lstream *stream, Lisp_Object codesys)
2566 return make_decoding_stream_1 (stream, codesys, "r");
2570 make_decoding_output_stream (Lstream *stream, Lisp_Object codesys)
2572 return make_decoding_stream_1 (stream, codesys, "w");
2575 /* Note: the decode_coding_* functions all take the same
2576 arguments as mule_decode(), which is to say some SRC data of
2577 size N, which is to be stored into dynamic array DST.
2578 DECODING is the stream within which the decoding is
2579 taking place, but no data is actually read from or
2580 written to that stream; that is handled in decoding_reader()
2581 or decoding_writer(). This allows the same functions to
2582 be used for both reading and writing. */
2585 mule_decode (Lstream *decoding, const Extbyte *src,
2586 unsigned_char_dynarr *dst, Lstream_data_count n)
2588 struct decoding_stream *str = DECODING_STREAM_DATA (decoding);
2590 /* If necessary, do encoding-detection now. We do this when
2591 we're a writing stream or a non-seekable reading stream,
2592 meaning that we can't just process the whole input,
2593 rewind, and start over. */
2595 if (CODING_SYSTEM_TYPE (str->codesys) == CODESYS_AUTODETECT ||
2596 str->eol_type == EOL_AUTODETECT)
2598 Lisp_Object codesys;
2600 XSETCODING_SYSTEM (codesys, str->codesys);
2601 detect_coding_type (&str->decst, src, n,
2602 CODING_SYSTEM_TYPE (str->codesys) !=
2603 CODESYS_AUTODETECT);
2604 if (CODING_SYSTEM_TYPE (str->codesys) == CODESYS_AUTODETECT &&
2605 str->decst.mask != ~0)
2606 /* #### This is cheesy. What we really ought to do is
2607 buffer up a certain amount of data so as to get a
2608 less random result. */
2609 codesys = coding_system_from_mask (str->decst.mask);
2610 str->eol_type = str->decst.eol_type;
2611 if (XCODING_SYSTEM (codesys) != str->codesys)
2613 /* Preserve the CODING_STATE_END flag in case it was set.
2614 If we erase it, bad things might happen. */
2615 int was_end = str->flags & CODING_STATE_END;
2616 set_decoding_stream_coding_system (decoding, codesys);
2618 str->flags |= CODING_STATE_END;
2622 switch (CODING_SYSTEM_TYPE (str->codesys))
2625 case CODESYS_INTERNAL:
2626 Dynarr_add_many (dst, src, n);
2629 case CODESYS_AUTODETECT:
2630 /* If we got this far and still haven't decided on the coding
2631 system, then do no conversion. */
2632 case CODESYS_NO_CONVERSION:
2633 decode_coding_no_conversion (decoding, src, dst, n);
2636 case CODESYS_SHIFT_JIS:
2637 decode_coding_sjis (decoding, src, dst, n);
2640 decode_coding_big5 (decoding, src, dst, n);
2643 decode_coding_ucs4 (decoding, src, dst, n);
2646 decode_coding_utf16 (decoding, src, dst, n);
2649 decode_coding_utf8 (decoding, src, dst, n);
2652 str->ccl.last_block = str->flags & CODING_STATE_END;
2653 /* When applying ccl program to stream, MUST NOT set NULL
2655 ccl_driver (&str->ccl, (src ? (unsigned char *)src : (unsigned char*)""),
2656 dst, n, 0, CCL_MODE_DECODING);
2658 case CODESYS_ISO2022:
2659 decode_coding_iso2022 (decoding, src, dst, n);
2667 DEFUN ("decode-coding-region", Fdecode_coding_region, 3, 4, 0, /*
2668 Decode the text between START and END which is encoded in CODING-SYSTEM.
2669 This is useful if you've read in encoded text from a file without decoding
2670 it (e.g. you read in a JIS-formatted file but used the `binary' or
2671 `no-conversion' coding system, so that it shows up as "^[$B!<!+^[(B").
2672 Return length of decoded text.
2673 BUFFER defaults to the current buffer if unspecified.
2675 (start, end, coding_system, buffer))
2678 struct buffer *buf = decode_buffer (buffer, 0);
2679 Lisp_Object instream, lb_outstream, de_outstream, outstream;
2680 Lstream *istr, *ostr;
2681 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2683 get_buffer_range_char (buf, start, end, &b, &e, 0);
2685 barf_if_buffer_read_only (buf, b, e);
2687 coding_system = Fget_coding_system (coding_system);
2688 instream = make_lisp_buffer_input_stream (buf, b, e, 0);
2689 lb_outstream = make_lisp_buffer_output_stream (buf, b, 0);
2690 de_outstream = make_decoding_output_stream (XLSTREAM (lb_outstream),
2692 outstream = make_encoding_output_stream (XLSTREAM (de_outstream),
2693 Fget_coding_system (Qbinary));
2694 istr = XLSTREAM (instream);
2695 ostr = XLSTREAM (outstream);
2696 GCPRO4 (instream, lb_outstream, de_outstream, outstream);
2698 /* The chain of streams looks like this:
2700 [BUFFER] <----- send through
2701 ------> [ENCODE AS BINARY]
2702 ------> [DECODE AS SPECIFIED]
2708 char tempbuf[1024]; /* some random amount */
2709 Bufpos newpos, even_newer_pos;
2710 Bufpos oldpos = lisp_buffer_stream_startpos (istr);
2711 Lstream_data_count size_in_bytes = Lstream_read (istr, tempbuf, sizeof (tempbuf));
2715 newpos = lisp_buffer_stream_startpos (istr);
2716 Lstream_write (ostr, tempbuf, size_in_bytes);
2717 even_newer_pos = lisp_buffer_stream_startpos (istr);
2718 buffer_delete_range (buf, even_newer_pos - (newpos - oldpos),
2721 Lstream_close (istr);
2722 Lstream_close (ostr);
2724 Lstream_delete (istr);
2725 Lstream_delete (ostr);
2726 Lstream_delete (XLSTREAM (de_outstream));
2727 Lstream_delete (XLSTREAM (lb_outstream));
2732 /************************************************************************/
2733 /* Converting to an external encoding ("encoding") */
2734 /************************************************************************/
2736 /* An encoding stream is an output stream. When you create the
2737 stream, you specify the coding system that governs the encoding
2738 and another stream that the resulting encoded data is to be
2739 sent to, and then start sending data to it. */
2741 #define ENCODING_STREAM_DATA(stream) LSTREAM_TYPE_DATA (stream, encoding)
2743 struct encoding_stream
2745 /* Coding system that governs the conversion. */
2746 Lisp_Coding_System *codesys;
2748 /* Stream that we read the encoded data from or
2749 write the decoded data to. */
2752 /* If we are reading, then we can return only a fixed amount of
2753 data, so if the conversion resulted in too much data, we store it
2754 here for retrieval the next time around. */
2755 unsigned_char_dynarr *runoff;
2757 /* FLAGS holds flags indicating the current state of the encoding.
2758 Some of these flags are dependent on the coding system. */
2761 /* CH holds a partially built-up character. Since we only deal
2762 with one- and two-byte characters at the moment, we only use
2763 this to store the first byte of a two-byte character. */
2766 /* Additional information used by the ISO2022 encoder. */
2769 /* CHARSET holds the character sets currently assigned to the G0
2770 through G3 registers. It is initialized from the array
2771 INITIAL_CHARSET in CODESYS. */
2772 Lisp_Object charset[4];
2774 /* Which registers are currently invoked into the left (GL) and
2775 right (GR) halves of the 8-bit encoding space? */
2776 int register_left, register_right;
2778 /* Whether we need to explicitly designate the charset in the
2779 G? register before using it. It is initialized from the
2780 array FORCE_CHARSET_ON_OUTPUT in CODESYS. */
2781 unsigned char force_charset_on_output[4];
2783 /* Other state variables that need to be preserved across
2785 Lisp_Object current_charset;
2787 int current_char_boundary;
2790 void (*encode_char) (struct encoding_stream *str, Emchar c,
2791 unsigned_char_dynarr *dst, unsigned int *flags);
2792 void (*finish) (struct encoding_stream *str,
2793 unsigned_char_dynarr *dst, unsigned int *flags);
2795 /* Additional information (the state of the running CCL program)
2796 used by the CCL encoder. */
2797 struct ccl_program ccl;
2801 static Lstream_data_count encoding_reader (Lstream *stream, unsigned char *data, Lstream_data_count size);
2802 static Lstream_data_count encoding_writer (Lstream *stream, const unsigned char *data,
2803 Lstream_data_count size);
2804 static int encoding_rewinder (Lstream *stream);
2805 static int encoding_seekable_p (Lstream *stream);
2806 static int encoding_flusher (Lstream *stream);
2807 static int encoding_closer (Lstream *stream);
2809 static Lisp_Object encoding_marker (Lisp_Object stream);
2811 DEFINE_LSTREAM_IMPLEMENTATION ("encoding", lstream_encoding,
2812 sizeof (struct encoding_stream));
2815 encoding_marker (Lisp_Object stream)
2817 Lstream *str = ENCODING_STREAM_DATA (XLSTREAM (stream))->other_end;
2818 Lisp_Object str_obj;
2820 /* We do not need to mark the coding systems or charsets stored
2821 within the stream because they are stored in a global list
2822 and automatically marked. */
2824 XSETLSTREAM (str_obj, str);
2825 mark_object (str_obj);
2826 if (str->imp->marker)
2827 return (str->imp->marker) (str_obj);
2832 /* Read SIZE bytes of data and store it into DATA. We are a encoding stream
2833 so we read data from the other end, encode it, and store it into DATA. */
2835 static Lstream_data_count
2836 encoding_reader (Lstream *stream, unsigned char *data, Lstream_data_count size)
2838 struct encoding_stream *str = ENCODING_STREAM_DATA (stream);
2839 unsigned char *orig_data = data;
2840 Lstream_data_count read_size;
2841 int error_occurred = 0;
2843 /* We need to interface to mule_encode(), which expects to take some
2844 amount of data and store the result into a Dynarr. We have
2845 mule_encode() store into str->runoff, and take data from there
2848 /* We loop until we have enough data, reading chunks from the other
2849 end and encoding it. */
2852 /* Take data from the runoff if we can. Make sure to take at
2853 most SIZE bytes, and delete the data from the runoff. */
2854 if (Dynarr_length (str->runoff) > 0)
2856 int chunk = min ((int) size, Dynarr_length (str->runoff));
2857 memcpy (data, Dynarr_atp (str->runoff, 0), chunk);
2858 Dynarr_delete_many (str->runoff, 0, chunk);
2864 break; /* No more room for data */
2866 if (str->flags & CODING_STATE_END)
2867 /* This means that on the previous iteration, we hit the EOF on
2868 the other end. We loop once more so that mule_encode() can
2869 output any final stuff it may be holding, or any "go back
2870 to a sane state" escape sequences. (This latter makes sense
2871 during encoding.) */
2874 /* Exhausted the runoff, so get some more. DATA at least SIZE bytes
2875 left of storage in it, so it's OK to read directly into it.
2876 (We'll be overwriting above, after we've encoded it into the
2878 read_size = Lstream_read (str->other_end, data, size);
2885 /* There might be some more end data produced in the translation.
2886 See the comment above. */
2887 str->flags |= CODING_STATE_END;
2888 mule_encode (stream, data, str->runoff, read_size);
2891 if (data == orig_data)
2892 return error_occurred ? -1 : 0;
2894 return data - orig_data;
2897 static Lstream_data_count
2898 encoding_writer (Lstream *stream, const unsigned char *data, Lstream_data_count size)
2900 struct encoding_stream *str = ENCODING_STREAM_DATA (stream);
2901 Lstream_data_count retval;
2903 /* Encode all our data into the runoff, and then attempt to write
2904 it all out to the other end. Remove whatever chunk we succeeded
2906 mule_encode (stream, data, str->runoff, size);
2907 retval = Lstream_write (str->other_end, Dynarr_atp (str->runoff, 0),
2908 Dynarr_length (str->runoff));
2910 Dynarr_delete_many (str->runoff, 0, retval);
2911 /* Do NOT return retval. The return value indicates how much
2912 of the incoming data was written, not how many bytes were
2918 reset_encoding_stream (struct encoding_stream *str)
2921 switch (CODING_SYSTEM_TYPE (str->codesys))
2923 case CODESYS_ISO2022:
2927 str->encode_char = &char_encode_iso2022;
2928 str->finish = &char_finish_iso2022;
2929 for (i = 0; i < 4; i++)
2931 str->iso2022.charset[i] =
2932 CODING_SYSTEM_ISO2022_INITIAL_CHARSET (str->codesys, i);
2933 str->iso2022.force_charset_on_output[i] =
2934 CODING_SYSTEM_ISO2022_FORCE_CHARSET_ON_OUTPUT (str->codesys, i);
2936 str->iso2022.register_left = 0;
2937 str->iso2022.register_right = 1;
2938 str->iso2022.current_charset = Qnil;
2939 str->iso2022.current_half = 0;
2943 setup_ccl_program (&str->ccl, CODING_SYSTEM_CCL_ENCODE (str->codesys));
2946 str->encode_char = &char_encode_utf8;
2947 str->finish = &char_finish_utf8;
2950 str->encode_char = &char_encode_utf16;
2951 str->finish = &char_finish_utf16;
2954 str->encode_char = &char_encode_ucs4;
2955 str->finish = &char_finish_ucs4;
2957 case CODESYS_SHIFT_JIS:
2958 str->encode_char = &char_encode_shift_jis;
2959 str->finish = &char_finish_shift_jis;
2962 str->encode_char = &char_encode_big5;
2963 str->finish = &char_finish_big5;
2969 str->iso2022.current_char_boundary = 0;
2970 str->flags = str->ch = 0;
2974 encoding_rewinder (Lstream *stream)
2976 struct encoding_stream *str = ENCODING_STREAM_DATA (stream);
2977 reset_encoding_stream (str);
2978 Dynarr_reset (str->runoff);
2979 return Lstream_rewind (str->other_end);
2983 encoding_seekable_p (Lstream *stream)
2985 struct encoding_stream *str = ENCODING_STREAM_DATA (stream);
2986 return Lstream_seekable_p (str->other_end);
2990 encoding_flusher (Lstream *stream)
2992 struct encoding_stream *str = ENCODING_STREAM_DATA (stream);
2993 return Lstream_flush (str->other_end);
2997 encoding_closer (Lstream *stream)
2999 struct encoding_stream *str = ENCODING_STREAM_DATA (stream);
3000 if (stream->flags & LSTREAM_FL_WRITE)
3002 str->flags |= CODING_STATE_END;
3003 encoding_writer (stream, 0, 0);
3005 Dynarr_free (str->runoff);
3006 return Lstream_close (str->other_end);
3010 encoding_stream_coding_system (Lstream *stream)
3012 Lisp_Object coding_system;
3013 struct encoding_stream *str = ENCODING_STREAM_DATA (stream);
3015 XSETCODING_SYSTEM (coding_system, str->codesys);
3016 return coding_system;
3020 set_encoding_stream_coding_system (Lstream *lstr, Lisp_Object codesys)
3022 Lisp_Coding_System *cs = XCODING_SYSTEM (codesys);
3023 struct encoding_stream *str = ENCODING_STREAM_DATA (lstr);
3025 reset_encoding_stream (str);
3029 make_encoding_stream_1 (Lstream *stream, Lisp_Object codesys,
3032 Lstream *lstr = Lstream_new (lstream_encoding, mode);
3033 struct encoding_stream *str = ENCODING_STREAM_DATA (lstr);
3037 str->runoff = Dynarr_new (unsigned_char);
3038 str->other_end = stream;
3039 set_encoding_stream_coding_system (lstr, codesys);
3040 XSETLSTREAM (obj, lstr);
3045 make_encoding_input_stream (Lstream *stream, Lisp_Object codesys)
3047 return make_encoding_stream_1 (stream, codesys, "r");
3051 make_encoding_output_stream (Lstream *stream, Lisp_Object codesys)
3053 return make_encoding_stream_1 (stream, codesys, "w");
3056 /* Convert N bytes of internally-formatted data stored in SRC to an
3057 external format, according to the encoding stream ENCODING.
3058 Store the encoded data into DST. */
3061 mule_encode (Lstream *encoding, const Bufbyte *src,
3062 unsigned_char_dynarr *dst, Lstream_data_count n)
3064 struct encoding_stream *str = ENCODING_STREAM_DATA (encoding);
3066 switch (CODING_SYSTEM_TYPE (str->codesys))
3069 case CODESYS_INTERNAL:
3070 Dynarr_add_many (dst, src, n);
3073 case CODESYS_AUTODETECT:
3074 /* If we got this far and still haven't decided on the coding
3075 system, then do no conversion. */
3076 case CODESYS_NO_CONVERSION:
3077 encode_coding_no_conversion (encoding, src, dst, n);
3081 str->ccl.last_block = str->flags & CODING_STATE_END;
3082 /* When applying ccl program to stream, MUST NOT set NULL
3084 ccl_driver (&str->ccl, ((src) ? src : (unsigned char*)""),
3085 dst, n, 0, CCL_MODE_ENCODING);
3089 text_encode_generic (encoding, src, dst, n);
3093 DEFUN ("encode-coding-region", Fencode_coding_region, 3, 4, 0, /*
3094 Encode the text between START and END using CODING-SYSTEM.
3095 This will, for example, convert Japanese characters into stuff such as
3096 "^[$B!<!+^[(B" if you use the JIS encoding. Return length of encoded
3097 text. BUFFER defaults to the current buffer if unspecified.
3099 (start, end, coding_system, buffer))
3102 struct buffer *buf = decode_buffer (buffer, 0);
3103 Lisp_Object instream, lb_outstream, de_outstream, outstream;
3104 Lstream *istr, *ostr;
3105 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
3107 get_buffer_range_char (buf, start, end, &b, &e, 0);
3109 barf_if_buffer_read_only (buf, b, e);
3111 coding_system = Fget_coding_system (coding_system);
3112 instream = make_lisp_buffer_input_stream (buf, b, e, 0);
3113 lb_outstream = make_lisp_buffer_output_stream (buf, b, 0);
3114 de_outstream = make_decoding_output_stream (XLSTREAM (lb_outstream),
3115 Fget_coding_system (Qbinary));
3116 outstream = make_encoding_output_stream (XLSTREAM (de_outstream),
3118 istr = XLSTREAM (instream);
3119 ostr = XLSTREAM (outstream);
3120 GCPRO4 (instream, outstream, de_outstream, lb_outstream);
3121 /* The chain of streams looks like this:
3123 [BUFFER] <----- send through
3124 ------> [ENCODE AS SPECIFIED]
3125 ------> [DECODE AS BINARY]
3130 char tempbuf[1024]; /* some random amount */
3131 Bufpos newpos, even_newer_pos;
3132 Bufpos oldpos = lisp_buffer_stream_startpos (istr);
3133 Lstream_data_count size_in_bytes = Lstream_read (istr, tempbuf, sizeof (tempbuf));
3137 newpos = lisp_buffer_stream_startpos (istr);
3138 Lstream_write (ostr, tempbuf, size_in_bytes);
3139 even_newer_pos = lisp_buffer_stream_startpos (istr);
3140 buffer_delete_range (buf, even_newer_pos - (newpos - oldpos),
3146 lisp_buffer_stream_startpos (XLSTREAM (instream)) - b;
3147 Lstream_close (istr);
3148 Lstream_close (ostr);
3150 Lstream_delete (istr);
3151 Lstream_delete (ostr);
3152 Lstream_delete (XLSTREAM (de_outstream));
3153 Lstream_delete (XLSTREAM (lb_outstream));
3154 return make_int (retlen);
3161 text_encode_generic (Lstream *encoding, const Bufbyte *src,
3162 unsigned_char_dynarr *dst, Lstream_data_count n)
3165 unsigned char char_boundary;
3166 struct encoding_stream *str = ENCODING_STREAM_DATA (encoding);
3167 unsigned int flags = str->flags;
3168 Emchar ch = str->ch;
3170 char_boundary = str->iso2022.current_char_boundary;
3176 if (char_boundary == 0)
3204 (*str->encode_char) (str, c, dst, &flags);
3206 else if (char_boundary == 1)
3208 (*str->encode_char) (str, (ch << 6) | (c & 0x3f), dst, &flags);
3214 ch = (ch << 6) | (c & 0x3f);
3219 if ((char_boundary == 0) && (flags & CODING_STATE_END))
3221 (*str->finish) (str, dst, &flags);
3226 str->iso2022.current_char_boundary = char_boundary;
3231 /************************************************************************/
3232 /* entity reference */
3233 /************************************************************************/
3236 decode_flush_er_chars (struct decoding_stream *str, unsigned_char_dynarr* dst);
3238 decode_flush_er_chars (struct decoding_stream *str, unsigned_char_dynarr* dst)
3240 if ( str->er_counter > 0)
3242 Dynarr_add_many (dst, str->er_buf, str->er_counter);
3243 str->er_counter = 0;
3247 void decode_add_er_char (struct decoding_stream *str, Emchar character,
3248 unsigned_char_dynarr* dst);
3250 decode_add_er_char (struct decoding_stream *str, Emchar c,
3251 unsigned_char_dynarr* dst)
3253 if (str->er_counter == 0)
3255 if (CODING_SYSTEM_USE_ENTITY_REFERENCE (str->codesys)
3258 str->er_buf[0] = '&';
3262 DECODE_ADD_UCS_CHAR (c, dst);
3266 Lisp_Object string = make_string (str->er_buf,
3268 Lisp_Object rest = Vcoded_charset_entity_reference_alist;
3273 Lisp_Object char_type;
3276 while (!NILP (rest))
3282 char_type = XCDR (ccs);
3287 if (NILP (ccs = Ffind_charset (ccs)))
3302 pat = concat3 (build_string ("^&"),
3303 pat, build_string ("\\([0-9]+\\)$"));
3306 else if (EQ (ret, Qx))
3308 pat = concat3 (build_string ("^&"),
3309 pat, build_string ("\\([0-9a-f]+\\)$"));
3312 else if (EQ (ret, QX))
3314 pat = concat3 (build_string ("^&"),
3315 pat, build_string ("\\([0-9A-F]+\\)$"));
3321 if (!NILP (Fstring_match (pat, string, Qnil, Qnil)))
3324 = XINT (Fstring_to_number
3325 (Fsubstring (string,
3326 Fmatch_beginning (make_int (1)),
3327 Fmatch_end (make_int (1))),
3331 ? DECODE_CHAR (ccs, code, 0)
3332 : decode_builtin_char (ccs, code);
3334 DECODE_ADD_UCS_CHAR (chr, dst);
3339 if (!NILP (Fstring_match (build_string ("^&MCS-\\([0-9A-F]+\\)$"),
3340 string, Qnil, Qnil)))
3343 = XUINT (Fstring_to_number
3344 (Fsubstring (string,
3345 Fmatch_beginning (make_int (1)),
3346 Fmatch_end (make_int (1))),
3349 DECODE_ADD_UCS_CHAR (code, dst);
3353 Dynarr_add_many (dst, str->er_buf, str->er_counter);
3354 Dynarr_add (dst, ';');
3357 str->er_counter = 0;
3359 else if ( (str->er_counter >= 16) || (c >= 0x7F) )
3361 Dynarr_add_many (dst, str->er_buf, str->er_counter);
3362 str->er_counter = 0;
3363 DECODE_ADD_UCS_CHAR (c, dst);
3366 str->er_buf[str->er_counter++] = c;
3369 void char_encode_as_entity_reference (Emchar ch, char* buf);
3371 char_encode_as_entity_reference (Emchar ch, char* buf)
3373 Lisp_Object rest = Vcoded_charset_entity_reference_alist;
3376 Lisp_Object char_type;
3377 int format_columns, idx;
3380 while (!NILP (rest))
3386 char_type = XCDR (ccs);
3391 if (!NILP (ccs = Ffind_charset (ccs)))
3393 int code_point = charset_code_point (ccs, ch, 0);
3395 if ( (code_point >= 0)
3396 && (NILP (char_type)
3397 || DECODE_CHAR (ccs, code_point, 0) != ch) )
3403 if (STRINGP (ret) && ((idx = XSTRING_LENGTH (ret)) <= 6))
3406 strncpy (&format[1], XSTRING_DATA (ret), idx);
3416 format[idx++] = '%';
3417 format_columns = XINT (ret);
3418 if ( (2 <= format_columns) && (format_columns <= 8) )
3420 format [idx++] = '0';
3421 format [idx++] = '0' + format_columns;
3428 format [idx++] = 'd';
3429 else if (EQ (ret, Qx))
3430 format [idx++] = 'x';
3431 else if (EQ (ret, QX))
3432 format [idx++] = 'X';
3435 format [idx++] = ';';
3438 sprintf (buf, format, code_point);
3444 sprintf (buf, "&MCS-%08X;", ch);
3448 /************************************************************************/
3449 /* character composition */
3450 /************************************************************************/
3451 extern Lisp_Object Qcomposition;
3454 COMPOSE_FLUSH_CHARS (struct decoding_stream *str, unsigned_char_dynarr* dst);
3456 COMPOSE_FLUSH_CHARS (struct decoding_stream *str, unsigned_char_dynarr* dst)
3460 for (i = 0; i < str->combined_char_count; i++)
3461 decode_add_er_char (str, str->combined_chars[i], dst);
3462 str->combined_char_count = 0;
3463 str->combining_table = Qnil;
3466 void COMPOSE_ADD_CHAR (struct decoding_stream *str, Emchar character,
3467 unsigned_char_dynarr* dst);
3469 COMPOSE_ADD_CHAR (struct decoding_stream *str,
3470 Emchar character, unsigned_char_dynarr* dst)
3472 if (CODING_SYSTEM_DISABLE_COMPOSITION (str->codesys))
3473 decode_add_er_char (str, character, dst);
3474 else if (!CONSP (str->combining_table))
3477 = Fchar_feature (make_char (character), Qcomposition, Qnil,
3481 decode_add_er_char (str, character, dst);
3484 str->combined_chars[0] = character;
3485 str->combined_char_count = 1;
3486 str->combining_table = ret;
3492 = Fcdr (Fassq (make_char (character), str->combining_table));
3496 Emchar char2 = XCHARVAL (ret);
3497 Lisp_Object ret2 = Fchar_feature (ret, Qcomposition, Qnil,
3502 decode_add_er_char (str, char2, dst);
3503 str->combined_char_count = 0;
3504 str->combining_table = Qnil;
3508 str->combined_chars[0] = char2;
3509 str->combined_char_count = 1;
3510 str->combining_table = ret2;
3515 ret = Fchar_feature (make_char (character), Qcomposition, Qnil,
3518 COMPOSE_FLUSH_CHARS (str, dst);
3520 decode_add_er_char (str, character, dst);
3523 str->combined_chars[0] = character;
3524 str->combined_char_count = 1;
3525 str->combining_table = ret;
3530 #else /* not UTF2000 */
3531 #define COMPOSE_FLUSH_CHARS(str, dst)
3532 #define COMPOSE_ADD_CHAR(str, ch, dst) DECODE_ADD_UCS_CHAR (ch, dst)
3533 #endif /* UTF2000 */
3536 /************************************************************************/
3537 /* Shift-JIS methods */
3538 /************************************************************************/
3540 /* Shift-JIS is a coding system encoding three character sets: ASCII, right
3541 half of JISX0201-Kana, and JISX0208. An ASCII character is encoded
3542 as is. A character of JISX0201-Kana (DIMENSION1_CHARS94 character set) is
3543 encoded by "position-code + 0x80". A character of JISX0208
3544 (DIMENSION2_CHARS94 character set) is encoded in 2-byte but two
3545 position-codes are divided and shifted so that it fit in the range
3548 --- CODE RANGE of Shift-JIS ---
3549 (character set) (range)
3551 JISX0201-Kana 0xA0 .. 0xDF
3552 JISX0208 (1st byte) 0x80 .. 0x9F and 0xE0 .. 0xEF
3553 (2nd byte) 0x40 .. 0x7E and 0x80 .. 0xFC
3554 -------------------------------
3558 /* Is this the first byte of a Shift-JIS two-byte char? */
3560 #define BYTE_SJIS_TWO_BYTE_1_P(c) \
3561 (((c) >= 0x81 && (c) <= 0x9F) || ((c) >= 0xE0 && (c) <= 0xEF))
3563 /* Is this the second byte of a Shift-JIS two-byte char? */
3565 #define BYTE_SJIS_TWO_BYTE_2_P(c) \
3566 (((c) >= 0x40 && (c) <= 0x7E) || ((c) >= 0x80 && (c) <= 0xFC))
3568 #define BYTE_SJIS_KATAKANA_P(c) \
3569 ((c) >= 0xA1 && (c) <= 0xDF)
3572 detect_coding_sjis (struct detection_state *st, const Extbyte *src, Lstream_data_count n)
3576 unsigned char c = *(unsigned char *)src++;
3577 if (c == ISO_CODE_ESC || c == ISO_CODE_SI || c == ISO_CODE_SO)
3579 if (st->shift_jis.in_second_byte)
3581 st->shift_jis.in_second_byte = 0;
3585 else if ((c >= 0x80 && c < 0xA0) || c >= 0xE0)
3586 st->shift_jis.in_second_byte = 1;
3588 return CODING_CATEGORY_SHIFT_JIS_MASK;
3591 /* Convert Shift-JIS data to internal format. */
3594 decode_coding_sjis (Lstream *decoding, const Extbyte *src,
3595 unsigned_char_dynarr *dst, Lstream_data_count n)
3597 struct decoding_stream *str = DECODING_STREAM_DATA (decoding);
3598 unsigned int flags = str->flags;
3599 unsigned int cpos = str->cpos;
3600 eol_type_t eol_type = str->eol_type;
3604 unsigned char c = *(unsigned char *)src++;
3608 /* Previous character was first byte of Shift-JIS Kanji char. */
3609 if (BYTE_SJIS_TWO_BYTE_2_P (c))
3611 unsigned char e1, e2;
3613 DECODE_SJIS (cpos, c, e1, e2);
3615 DECODE_ADD_UCS_CHAR(MAKE_CHAR(Vcharset_japanese_jisx0208,
3619 Dynarr_add (dst, LEADING_BYTE_JAPANESE_JISX0208);
3620 Dynarr_add (dst, e1);
3621 Dynarr_add (dst, e2);
3626 DECODE_ADD_BINARY_CHAR (cpos, dst);
3627 DECODE_ADD_BINARY_CHAR (c, dst);
3633 DECODE_HANDLE_EOL_TYPE (eol_type, c, flags, dst);
3634 if (BYTE_SJIS_TWO_BYTE_1_P (c))
3636 else if (BYTE_SJIS_KATAKANA_P (c))
3639 DECODE_ADD_UCS_CHAR(MAKE_CHAR(Vcharset_katakana_jisx0201,
3642 Dynarr_add (dst, LEADING_BYTE_KATAKANA_JISX0201);
3643 Dynarr_add (dst, c);
3648 DECODE_ADD_UCS_CHAR(MAKE_CHAR(Vcharset_latin_jisx0201,
3652 DECODE_ADD_BINARY_CHAR (c, dst);
3654 label_continue_loop:;
3657 DECODE_HANDLE_END_OF_CONVERSION (flags, cpos, dst);
3663 /* Convert internal character representation to Shift_JIS. */
3666 char_encode_shift_jis (struct encoding_stream *str, Emchar ch,
3667 unsigned_char_dynarr *dst, unsigned int *flags)
3669 eol_type_t eol_type = CODING_SYSTEM_EOL_TYPE (str->codesys);
3673 if (eol_type != EOL_LF && eol_type != EOL_AUTODETECT)
3674 Dynarr_add (dst, '\r');
3675 if (eol_type != EOL_CR)
3676 Dynarr_add (dst, ch);
3680 unsigned int s1, s2;
3682 int code_point = charset_code_point (Vcharset_latin_jisx0201, ch, 0);
3684 if (code_point >= 0)
3685 Dynarr_add (dst, code_point);
3686 else if ((code_point
3687 = charset_code_point (Vcharset_japanese_jisx0208_1990, ch, 0))
3690 ENCODE_SJIS ((code_point >> 8) | 0x80,
3691 (code_point & 0xFF) | 0x80, s1, s2);
3692 Dynarr_add (dst, s1);
3693 Dynarr_add (dst, s2);
3695 else if ((code_point
3696 = charset_code_point (Vcharset_katakana_jisx0201, ch, 0))
3698 Dynarr_add (dst, code_point | 0x80);
3699 else if ((code_point
3700 = charset_code_point (Vcharset_japanese_jisx0208, ch, 0))
3703 ENCODE_SJIS ((code_point >> 8) | 0x80,
3704 (code_point & 0xFF) | 0x80, s1, s2);
3705 Dynarr_add (dst, s1);
3706 Dynarr_add (dst, s2);
3708 else if ((code_point = charset_code_point (Vcharset_ascii, ch, 0))
3710 Dynarr_add (dst, code_point);
3712 Dynarr_add (dst, '?');
3714 Lisp_Object charset;
3715 unsigned int c1, c2;
3717 BREAKUP_CHAR (ch, charset, c1, c2);
3719 if (EQ(charset, Vcharset_katakana_jisx0201))
3721 Dynarr_add (dst, c1 | 0x80);
3725 Dynarr_add (dst, c1);
3727 else if (EQ(charset, Vcharset_japanese_jisx0208))
3729 ENCODE_SJIS (c1 | 0x80, c2 | 0x80, s1, s2);
3730 Dynarr_add (dst, s1);
3731 Dynarr_add (dst, s2);
3734 Dynarr_add (dst, '?');
3740 char_finish_shift_jis (struct encoding_stream *str, unsigned_char_dynarr *dst,
3741 unsigned int *flags)
3745 DEFUN ("decode-shift-jis-char", Fdecode_shift_jis_char, 1, 1, 0, /*
3746 Decode a JISX0208 character of Shift-JIS coding-system.
3747 CODE is the character code in Shift-JIS as a cons of type bytes.
3748 Return the corresponding character.
3752 unsigned char c1, c2, s1, s2;
3755 CHECK_INT (XCAR (code));
3756 CHECK_INT (XCDR (code));
3757 s1 = XINT (XCAR (code));
3758 s2 = XINT (XCDR (code));
3759 if (BYTE_SJIS_TWO_BYTE_1_P (s1) &&
3760 BYTE_SJIS_TWO_BYTE_2_P (s2))
3762 DECODE_SJIS (s1, s2, c1, c2);
3763 return make_char (MAKE_CHAR (Vcharset_japanese_jisx0208,
3764 c1 & 0x7F, c2 & 0x7F));
3770 DEFUN ("encode-shift-jis-char", Fencode_shift_jis_char, 1, 1, 0, /*
3771 Encode a JISX0208 character CHARACTER to SHIFT-JIS coding-system.
3772 Return the corresponding character code in SHIFT-JIS as a cons of two bytes.
3776 Lisp_Object charset;
3779 CHECK_CHAR_COERCE_INT (character);
3780 BREAKUP_CHAR (XCHAR (character), charset, c1, c2);
3781 if (EQ (charset, Vcharset_japanese_jisx0208))
3783 ENCODE_SJIS (c1 | 0x80, c2 | 0x80, s1, s2);
3784 return Fcons (make_int (s1), make_int (s2));
3791 /************************************************************************/
3793 /************************************************************************/
3795 /* BIG5 is a coding system encoding two character sets: ASCII and
3796 Big5. An ASCII character is encoded as is. Big5 is a two-byte
3797 character set and is encoded in two-byte.
3799 --- CODE RANGE of BIG5 ---
3800 (character set) (range)
3802 Big5 (1st byte) 0xA1 .. 0xFE
3803 (2nd byte) 0x40 .. 0x7E and 0xA1 .. 0xFE
3804 --------------------------
3806 Since the number of characters in Big5 is larger than maximum
3807 characters in Emacs' charset (96x96), it can't be handled as one
3808 charset. So, in Emacs, Big5 is divided into two: `charset-big5-1'
3809 and `charset-big5-2'. Both <type>s are DIMENSION2_CHARS94. The former
3810 contains frequently used characters and the latter contains less
3811 frequently used characters. */
3814 #define BYTE_BIG5_TWO_BYTE_1_P(c) \
3815 ((c) >= 0x81 && (c) <= 0xFE)
3817 #define BYTE_BIG5_TWO_BYTE_1_P(c) \
3818 ((c) >= 0xA1 && (c) <= 0xFE)
3821 /* Is this the second byte of a Shift-JIS two-byte char? */
3823 #define BYTE_BIG5_TWO_BYTE_2_P(c) \
3824 (((c) >= 0x40 && (c) <= 0x7E) || ((c) >= 0xA1 && (c) <= 0xFE))
3826 /* Number of Big5 characters which have the same code in 1st byte. */
3828 #define BIG5_SAME_ROW (0xFF - 0xA1 + 0x7F - 0x40)
3830 /* Code conversion macros. These are macros because they are used in
3831 inner loops during code conversion.
3833 Note that temporary variables in macros introduce the classic
3834 dynamic-scoping problems with variable names. We use capital-
3835 lettered variables in the assumption that XEmacs does not use
3836 capital letters in variables except in a very formalized way
3839 /* Convert Big5 code (b1, b2) into its internal string representation
3842 /* There is a much simpler way to split the Big5 charset into two.
3843 For the moment I'm going to leave the algorithm as-is because it
3844 claims to separate out the most-used characters into a single
3845 charset, which perhaps will lead to optimizations in various
3848 The way the algorithm works is something like this:
3850 Big5 can be viewed as a 94x157 charset, where the row is
3851 encoded into the bytes 0xA1 .. 0xFE and the column is encoded
3852 into the bytes 0x40 .. 0x7E and 0xA1 .. 0xFE. As for frequency,
3853 the split between low and high column numbers is apparently
3854 meaningless; ascending rows produce less and less frequent chars.
3855 Therefore, we assign the lower half of rows (0xA1 .. 0xC8) to
3856 the first charset, and the upper half (0xC9 .. 0xFE) to the
3857 second. To do the conversion, we convert the character into
3858 a single number where 0 .. 156 is the first row, 157 .. 313
3859 is the second, etc. That way, the characters are ordered by
3860 decreasing frequency. Then we just chop the space in two
3861 and coerce the result into a 94x94 space.
3864 #define DECODE_BIG5(b1, b2, lb, c1, c2) do \
3866 int B1 = b1, B2 = b2; \
3868 = (B1 - 0xA1) * BIG5_SAME_ROW + B2 - (B2 < 0x7F ? 0x40 : 0x62); \
3872 lb = LEADING_BYTE_CHINESE_BIG5_1; \
3876 lb = LEADING_BYTE_CHINESE_BIG5_2; \
3877 I -= (BIG5_SAME_ROW) * (0xC9 - 0xA1); \
3879 c1 = I / (0xFF - 0xA1) + 0xA1; \
3880 c2 = I % (0xFF - 0xA1) + 0xA1; \
3883 /* Convert the internal string representation of a Big5 character
3884 (lb, c1, c2) into Big5 code (b1, b2). */
3886 #define ENCODE_BIG5(lb, c1, c2, b1, b2) do \
3888 unsigned int I = ((c1) - 0xA1) * (0xFF - 0xA1) + ((c2) - 0xA1); \
3890 if (lb == LEADING_BYTE_CHINESE_BIG5_2) \
3892 I += BIG5_SAME_ROW * (0xC9 - 0xA1); \
3894 b1 = I / BIG5_SAME_ROW + 0xA1; \
3895 b2 = I % BIG5_SAME_ROW; \
3896 b2 += b2 < 0x3F ? 0x40 : 0x62; \
3900 detect_coding_big5 (struct detection_state *st, const Extbyte *src, Lstream_data_count n)
3904 unsigned char c = *(unsigned char *)src++;
3905 if (c == ISO_CODE_ESC || c == ISO_CODE_SI || c == ISO_CODE_SO
3907 || (c >= 0x80 && c <= 0xA0)
3911 if (st->big5.in_second_byte)
3913 st->big5.in_second_byte = 0;
3914 if (c < 0x40 || (c >= 0x80 && c <= 0xA0))
3924 st->big5.in_second_byte = 1;
3926 return CODING_CATEGORY_BIG5_MASK;
3929 /* Convert Big5 data to internal format. */
3932 decode_coding_big5 (Lstream *decoding, const Extbyte *src,
3933 unsigned_char_dynarr *dst, Lstream_data_count n)
3935 struct decoding_stream *str = DECODING_STREAM_DATA (decoding);
3936 unsigned int flags = str->flags;
3937 unsigned int cpos = str->cpos;
3938 eol_type_t eol_type = str->eol_type;
3941 = CODING_SYSTEM_ISO2022_INITIAL_CHARSET (DECODING_STREAM_DATA
3942 (decoding)->codesys, 1);
3947 unsigned char c = *(unsigned char *)src++;
3950 /* Previous character was first byte of Big5 char. */
3951 if (BYTE_BIG5_TWO_BYTE_2_P (c))
3954 int code_point = (cpos << 8) | c;
3955 Emchar char_id = decode_defined_char (ccs, code_point, 0);
3959 = DECODE_CHAR (Vcharset_chinese_big5, code_point, 0);
3960 DECODE_ADD_UCS_CHAR (char_id, dst);
3962 unsigned char b1, b2, b3;
3963 DECODE_BIG5 (cpos, c, b1, b2, b3);
3964 Dynarr_add (dst, b1);
3965 Dynarr_add (dst, b2);
3966 Dynarr_add (dst, b3);
3971 DECODE_ADD_BINARY_CHAR (cpos, dst);
3972 DECODE_ADD_BINARY_CHAR (c, dst);
3978 DECODE_HANDLE_EOL_TYPE (eol_type, c, flags, dst);
3979 if (BYTE_BIG5_TWO_BYTE_1_P (c))
3981 decode_flush_er_chars (str, dst);
3986 decode_flush_er_chars (str, dst);
3987 DECODE_HANDLE_EOL_TYPE (eol_type, c, flags, dst);
3988 DECODE_ADD_BINARY_CHAR (c, dst);
3992 /* DECODE_ADD_BINARY_CHAR (c, dst); */
3993 decode_add_er_char (str, c, dst);
3996 label_continue_loop:;
3999 /* DECODE_HANDLE_END_OF_CONVERSION (flags, cpos, dst); */
4000 if (flags & CODING_STATE_END)
4002 decode_flush_er_chars (str, dst);
4003 DECODE_OUTPUT_PARTIAL_CHAR (cpos);
4004 if (flags & CODING_STATE_CR)
4005 Dynarr_add (dst, '\r');
4012 /* Convert internally-formatted data to Big5. */
4015 char_encode_big5 (struct encoding_stream *str, Emchar ch,
4016 unsigned_char_dynarr *dst, unsigned int *flags)
4018 eol_type_t eol_type = CODING_SYSTEM_EOL_TYPE (str->codesys);
4022 if (eol_type != EOL_LF && eol_type != EOL_AUTODETECT)
4023 Dynarr_add (dst, '\r');
4024 if (eol_type != EOL_CR)
4025 Dynarr_add (dst, ch);
4032 = CODING_SYSTEM_ISO2022_INITIAL_CHARSET (str->codesys, 1);
4034 if ((code_point = charset_code_point (Vcharset_ascii, ch, 0)) >= 0)
4035 Dynarr_add (dst, code_point);
4036 else if ((code_point = charset_code_point (ccs, ch, 0)) >= 0)
4038 Dynarr_add (dst, code_point >> 8);
4039 Dynarr_add (dst, code_point & 0xFF);
4041 else if ((code_point
4042 = charset_code_point (Vcharset_chinese_big5, ch, 0)) >= 0)
4044 Dynarr_add (dst, code_point >> 8);
4045 Dynarr_add (dst, code_point & 0xFF);
4047 else if ((code_point
4048 = charset_code_point (Vcharset_chinese_big5_1, ch, 0)) >= 0)
4051 = ((code_point >> 8) - 33) * (0xFF - 0xA1)
4052 + ((code_point & 0xFF) - 33);
4053 unsigned char b1 = I / BIG5_SAME_ROW + 0xA1;
4054 unsigned char b2 = I % BIG5_SAME_ROW;
4056 b2 += b2 < 0x3F ? 0x40 : 0x62;
4057 Dynarr_add (dst, b1);
4058 Dynarr_add (dst, b2);
4060 else if ((code_point
4061 = charset_code_point (Vcharset_chinese_big5_2, ch, 0)) >= 0)
4064 = ((code_point >> 8) - 33) * (0xFF - 0xA1)
4065 + ((code_point & 0xFF) - 33);
4066 unsigned char b1, b2;
4068 I += BIG5_SAME_ROW * (0xC9 - 0xA1);
4069 b1 = I / BIG5_SAME_ROW + 0xA1;
4070 b2 = I % BIG5_SAME_ROW;
4071 b2 += b2 < 0x3F ? 0x40 : 0x62;
4072 Dynarr_add (dst, b1);
4073 Dynarr_add (dst, b2);
4075 else if (CODING_SYSTEM_USE_ENTITY_REFERENCE (str->codesys))
4079 char_encode_as_entity_reference (ch, buf);
4080 Dynarr_add_many (dst, buf, strlen (buf));
4083 Dynarr_add (dst, '?');
4090 char_finish_big5 (struct encoding_stream *str, unsigned_char_dynarr *dst,
4091 unsigned int *flags)
4096 DEFUN ("decode-big5-char", Fdecode_big5_char, 1, 1, 0, /*
4097 Decode a Big5 character CODE of BIG5 coding-system.
4098 CODE is the character code in BIG5, a cons of two integers.
4099 Return the corresponding character.
4103 unsigned char c1, c2, b1, b2;
4106 CHECK_INT (XCAR (code));
4107 CHECK_INT (XCDR (code));
4108 b1 = XINT (XCAR (code));
4109 b2 = XINT (XCDR (code));
4110 if (BYTE_BIG5_TWO_BYTE_1_P (b1) &&
4111 BYTE_BIG5_TWO_BYTE_2_P (b2))
4113 Charset_ID leading_byte;
4114 Lisp_Object charset;
4115 DECODE_BIG5 (b1, b2, leading_byte, c1, c2);
4116 charset = CHARSET_BY_LEADING_BYTE (leading_byte);
4117 return make_char (MAKE_CHAR (charset, c1 & 0x7F, c2 & 0x7F));
4123 DEFUN ("encode-big5-char", Fencode_big5_char, 1, 1, 0, /*
4124 Encode the Big5 character CHARACTER in the BIG5 coding-system.
4125 Return the corresponding character code in Big5.
4129 Lisp_Object charset;
4132 CHECK_CHAR_COERCE_INT (character);
4133 BREAKUP_CHAR (XCHAR (character), charset, c1, c2);
4134 if (EQ (charset, Vcharset_chinese_big5_1) ||
4135 EQ (charset, Vcharset_chinese_big5_2))
4137 ENCODE_BIG5 (XCHARSET_LEADING_BYTE (charset), c1 | 0x80, c2 | 0x80,
4139 return Fcons (make_int (b1), make_int (b2));
4146 /************************************************************************/
4148 /************************************************************************/
4151 detect_coding_ucs4 (struct detection_state *st, const Extbyte *src, Lstream_data_count n)
4155 unsigned char c = *(unsigned char *)src++;
4156 switch (st->ucs4.in_byte)
4165 st->ucs4.in_byte = 0;
4171 return CODING_CATEGORY_UCS4_MASK;
4175 decode_coding_ucs4 (Lstream *decoding, const Extbyte *src,
4176 unsigned_char_dynarr *dst, Lstream_data_count n)
4178 struct decoding_stream *str = DECODING_STREAM_DATA (decoding);
4179 unsigned int flags = str->flags;
4180 unsigned int cpos = str->cpos;
4181 unsigned char counter = str->counter;
4185 unsigned char c = *(unsigned char *)src++;
4193 DECODE_ADD_UCS_CHAR ((cpos << 8) | c, dst);
4198 cpos = ( cpos << 8 ) | c;
4202 if (counter & CODING_STATE_END)
4203 DECODE_OUTPUT_PARTIAL_CHAR (cpos);
4207 str->counter = counter;
4211 char_encode_ucs4 (struct encoding_stream *str, Emchar ch,
4212 unsigned_char_dynarr *dst, unsigned int *flags)
4214 Dynarr_add (dst, ch >> 24);
4215 Dynarr_add (dst, ch >> 16);
4216 Dynarr_add (dst, ch >> 8);
4217 Dynarr_add (dst, ch );
4221 char_finish_ucs4 (struct encoding_stream *str, unsigned_char_dynarr *dst,
4222 unsigned int *flags)
4227 /************************************************************************/
4228 /* UTF-16 methods */
4229 /************************************************************************/
4232 detect_coding_utf16 (struct detection_state *st, const Extbyte *src, Lstream_data_count n)
4234 return CODING_CATEGORY_UTF16_MASK;
4238 decode_coding_utf16 (Lstream *decoding, const Extbyte *src,
4239 unsigned_char_dynarr *dst, Lstream_data_count n)
4241 struct decoding_stream *str = DECODING_STREAM_DATA (decoding);
4242 unsigned int flags = str->flags;
4243 unsigned int cpos = str->cpos;
4244 unsigned char counter = str->counter & 3;
4245 unsigned char byte_order = str->counter >> 2;
4246 eol_type_t eol_type = str->eol_type;
4250 unsigned char c = *(unsigned char *)src++;
4256 else if (counter == 1)
4260 if (byte_order == 0)
4261 code = (c << 8) | cpos;
4263 code = (cpos << 8) | c;
4266 code = ((code & 0xFF) << 8) | (code >> 8);
4267 if ( byte_order == 0 )
4272 if ( (0xD800 <= code) && (code <= 0xDBFF) )
4283 DECODE_HANDLE_EOL_TYPE (eol_type, code, flags, dst);
4284 DECODE_ADD_UCS_CHAR (code, dst);
4288 else if (counter == 2)
4290 cpos = (cpos << 8) | c;
4298 ? (c << 8) | (cpos & 0xFF)
4299 : ((cpos & 0xFF) << 8) | c;
4301 DECODE_ADD_UCS_CHAR ((x - 0xD800) * 0x400 + (y - 0xDC00)
4306 label_continue_loop:;
4308 if (counter & CODING_STATE_END)
4309 DECODE_OUTPUT_PARTIAL_CHAR (cpos);
4313 str->counter = (byte_order << 2) | counter;
4317 char_encode_utf16 (struct encoding_stream *str, Emchar ch,
4318 unsigned_char_dynarr *dst, unsigned int *flags)
4322 Dynarr_add (dst, ch);
4323 Dynarr_add (dst, ch >> 8);
4327 int y = ((ch - 0x10000) / 0x400) + 0xD800;
4328 int z = ((ch - 0x10000) % 0x400) + 0xDC00;
4330 Dynarr_add (dst, y);
4331 Dynarr_add (dst, y >> 8);
4332 Dynarr_add (dst, z);
4333 Dynarr_add (dst, z >> 8);
4338 char_finish_utf16 (struct encoding_stream *str, unsigned_char_dynarr *dst,
4339 unsigned int *flags)
4344 /************************************************************************/
4346 /************************************************************************/
4349 detect_coding_utf8 (struct detection_state *st, const Extbyte *src, Lstream_data_count n)
4353 unsigned char c = *(unsigned char *)src++;
4354 switch (st->utf8.in_byte)
4357 if (c == ISO_CODE_ESC || c == ISO_CODE_SI || c == ISO_CODE_SO)
4360 st->utf8.in_byte = 5;
4362 st->utf8.in_byte = 4;
4364 st->utf8.in_byte = 3;
4366 st->utf8.in_byte = 2;
4368 st->utf8.in_byte = 1;
4373 if ((c & 0xc0) != 0x80)
4379 return CODING_CATEGORY_UTF8_MASK;
4383 decode_output_utf8_partial_char (unsigned char counter,
4385 unsigned_char_dynarr *dst)
4388 DECODE_ADD_BINARY_CHAR ( (cpos|0xFC), dst);
4389 else if (counter == 4)
4391 if (cpos < (1 << 6))
4392 DECODE_ADD_BINARY_CHAR ( (cpos|0xF8), dst);
4395 DECODE_ADD_BINARY_CHAR ( ((cpos >> 6)|0xFC), dst);
4396 DECODE_ADD_BINARY_CHAR ( ((cpos&0x3F)|0x80), dst);
4399 else if (counter == 3)
4401 if (cpos < (1 << 6))
4402 DECODE_ADD_BINARY_CHAR ( (cpos|0xF0), dst);
4403 else if (cpos < (1 << 12))
4405 DECODE_ADD_BINARY_CHAR ( ((cpos >> 6)|0xF8), dst);
4406 DECODE_ADD_BINARY_CHAR ( ((cpos&0x3F)|0x80), dst);
4410 DECODE_ADD_BINARY_CHAR ( ( (cpos >> 12)|0xFC), dst);
4411 DECODE_ADD_BINARY_CHAR ( (((cpos >> 6)&0x3F)|0x80), dst);
4412 DECODE_ADD_BINARY_CHAR ( ( (cpos &0x3F)|0x80), dst);
4415 else if (counter == 2)
4417 if (cpos < (1 << 6))
4418 DECODE_ADD_BINARY_CHAR ( (cpos|0xE0), dst);
4419 else if (cpos < (1 << 12))
4421 DECODE_ADD_BINARY_CHAR ( ((cpos >> 6)|0xF0), dst);
4422 DECODE_ADD_BINARY_CHAR ( ((cpos&0x3F)|0x80), dst);
4424 else if (cpos < (1 << 18))
4426 DECODE_ADD_BINARY_CHAR ( ( (cpos >> 12)|0xF8), dst);
4427 DECODE_ADD_BINARY_CHAR ( (((cpos >> 6)&0x3F)|0x80), dst);
4428 DECODE_ADD_BINARY_CHAR ( ( (cpos &0x3F)|0x80), dst);
4432 DECODE_ADD_BINARY_CHAR ( ( (cpos >> 18)|0xFC), dst);
4433 DECODE_ADD_BINARY_CHAR ( (((cpos >> 12)&0x3F)|0x80), dst);
4434 DECODE_ADD_BINARY_CHAR ( (((cpos >> 6)&0x3F)|0x80), dst);
4435 DECODE_ADD_BINARY_CHAR ( ( (cpos &0x3F)|0x80), dst);
4440 if (cpos < (1 << 6))
4441 DECODE_ADD_BINARY_CHAR ( (cpos|0xC0), dst);
4442 else if (cpos < (1 << 12))
4444 DECODE_ADD_BINARY_CHAR ( ((cpos >> 6)|0xE0), dst);
4445 DECODE_ADD_BINARY_CHAR ( ((cpos&0x3F)|0x80), dst);
4447 else if (cpos < (1 << 18))
4449 DECODE_ADD_BINARY_CHAR ( ( (cpos >> 12)|0xF0), dst);
4450 DECODE_ADD_BINARY_CHAR ( (((cpos >> 6)&0x3F)|0x80), dst);
4451 DECODE_ADD_BINARY_CHAR ( ( (cpos &0x3F)|0x80), dst);
4453 else if (cpos < (1 << 24))
4455 DECODE_ADD_BINARY_CHAR ( ( (cpos >> 18)|0xF8), dst);
4456 DECODE_ADD_BINARY_CHAR ( (((cpos >> 12)&0x3F)|0x80), dst);
4457 DECODE_ADD_BINARY_CHAR ( (((cpos >> 6)&0x3F)|0x80), dst);
4458 DECODE_ADD_BINARY_CHAR ( ( (cpos &0x3F)|0x80), dst);
4462 DECODE_ADD_BINARY_CHAR ( ( (cpos >> 24)|0xFC), dst);
4463 DECODE_ADD_BINARY_CHAR ( (((cpos >> 18)&0x3F)|0x80), dst);
4464 DECODE_ADD_BINARY_CHAR ( (((cpos >> 12)&0x3F)|0x80), dst);
4465 DECODE_ADD_BINARY_CHAR ( (((cpos >> 6)&0x3F)|0x80), dst);
4466 DECODE_ADD_BINARY_CHAR ( ( (cpos &0x3F)|0x80), dst);
4472 decode_coding_utf8 (Lstream *decoding, const Extbyte *src,
4473 unsigned_char_dynarr *dst, Lstream_data_count n)
4475 struct decoding_stream *str = DECODING_STREAM_DATA (decoding);
4476 unsigned int flags = str->flags;
4477 unsigned int cpos = str->cpos;
4478 eol_type_t eol_type = str->eol_type;
4479 unsigned char counter = str->counter;
4482 = CODING_SYSTEM_ISO2022_INITIAL_CHARSET (DECODING_STREAM_DATA
4483 (decoding)->codesys, 0);
4488 unsigned char c = *(unsigned char *)src++;
4493 COMPOSE_FLUSH_CHARS (str, dst);
4494 decode_flush_er_chars (str, dst);
4495 DECODE_HANDLE_EOL_TYPE (eol_type, c, flags, dst);
4496 DECODE_ADD_UCS_CHAR (c, dst);
4498 else if ( c < 0xC0 )
4499 /* decode_add_er_char (str, c, dst); */
4500 COMPOSE_ADD_CHAR (str, c, dst);
4503 /* decode_flush_er_chars (str, dst); */
4509 else if ( c < 0xF0 )
4514 else if ( c < 0xF8 )
4519 else if ( c < 0xFC )
4531 else if ( (c & 0xC0) == 0x80 )
4533 cpos = ( cpos << 6 ) | ( c & 0x3f );
4540 char_id = decode_defined_char (ccs, cpos, 0);
4547 COMPOSE_ADD_CHAR (str, char_id, dst);
4556 COMPOSE_FLUSH_CHARS (str, dst);
4557 decode_flush_er_chars (str, dst);
4558 decode_output_utf8_partial_char (counter, cpos, dst);
4559 DECODE_ADD_BINARY_CHAR (c, dst);
4563 label_continue_loop:;
4566 if (flags & CODING_STATE_END)
4568 COMPOSE_FLUSH_CHARS (str, dst);
4569 decode_flush_er_chars (str, dst);
4572 decode_output_utf8_partial_char (counter, cpos, dst);
4579 str->counter = counter;
4583 char_encode_utf8 (struct encoding_stream *str, Emchar ch,
4584 unsigned_char_dynarr *dst, unsigned int *flags)
4586 eol_type_t eol_type = CODING_SYSTEM_EOL_TYPE (str->codesys);
4590 if (eol_type != EOL_LF && eol_type != EOL_AUTODETECT)
4591 Dynarr_add (dst, '\r');
4592 if (eol_type != EOL_CR)
4593 Dynarr_add (dst, ch);
4595 else if (ch <= 0x7f)
4597 Dynarr_add (dst, ch);
4602 = CODING_SYSTEM_ISO2022_INITIAL_CHARSET (str->codesys, 0);
4603 int code_point = charset_code_point (ucs_ccs, ch, 0);
4605 if ( (code_point < 0) || (code_point > 0x10FFFF) )
4608 = CODING_SYSTEM_ISO2022_INITIAL_CHARSET (str->codesys, 1);
4612 && INTP (ret = Fchar_feature (make_char (ch),
4615 code_point = XINT (ret);
4616 else if ( !NILP (map =
4617 CODING_SYSTEM_ISO2022_INITIAL_CHARSET
4619 && INTP (ret = Fchar_feature (make_char (ch),
4622 code_point = XINT (ret);
4623 else if (CODING_SYSTEM_USE_ENTITY_REFERENCE (str->codesys))
4627 char_encode_as_entity_reference (ch, buf);
4628 Dynarr_add_many (dst, buf, strlen (buf));
4634 if (code_point <= 0x7ff)
4636 Dynarr_add (dst, (code_point >> 6) | 0xc0);
4637 Dynarr_add (dst, (code_point & 0x3f) | 0x80);
4639 else if (code_point <= 0xffff)
4641 Dynarr_add (dst, (code_point >> 12) | 0xe0);
4642 Dynarr_add (dst, ((code_point >> 6) & 0x3f) | 0x80);
4643 Dynarr_add (dst, (code_point & 0x3f) | 0x80);
4645 else if (code_point <= 0x1fffff)
4647 Dynarr_add (dst, (code_point >> 18) | 0xf0);
4648 Dynarr_add (dst, ((code_point >> 12) & 0x3f) | 0x80);
4649 Dynarr_add (dst, ((code_point >> 6) & 0x3f) | 0x80);
4650 Dynarr_add (dst, (code_point & 0x3f) | 0x80);
4652 else if (code_point <= 0x3ffffff)
4654 Dynarr_add (dst, (code_point >> 24) | 0xf8);
4655 Dynarr_add (dst, ((code_point >> 18) & 0x3f) | 0x80);
4656 Dynarr_add (dst, ((code_point >> 12) & 0x3f) | 0x80);
4657 Dynarr_add (dst, ((code_point >> 6) & 0x3f) | 0x80);
4658 Dynarr_add (dst, (code_point & 0x3f) | 0x80);
4662 Dynarr_add (dst, (code_point >> 30) | 0xfc);
4663 Dynarr_add (dst, ((code_point >> 24) & 0x3f) | 0x80);
4664 Dynarr_add (dst, ((code_point >> 18) & 0x3f) | 0x80);
4665 Dynarr_add (dst, ((code_point >> 12) & 0x3f) | 0x80);
4666 Dynarr_add (dst, ((code_point >> 6) & 0x3f) | 0x80);
4667 Dynarr_add (dst, (code_point & 0x3f) | 0x80);
4673 char_finish_utf8 (struct encoding_stream *str, unsigned_char_dynarr *dst,
4674 unsigned int *flags)
4679 /************************************************************************/
4680 /* ISO2022 methods */
4681 /************************************************************************/
4683 /* The following note describes the coding system ISO2022 briefly.
4684 Since the intention of this note is to help understand the
4685 functions in this file, some parts are NOT ACCURATE or OVERLY
4686 SIMPLIFIED. For thorough understanding, please refer to the
4687 original document of ISO2022.
4689 ISO2022 provides many mechanisms to encode several character sets
4690 in 7-bit and 8-bit environments. For 7-bit environments, all text
4691 is encoded using bytes less than 128. This may make the encoded
4692 text a little bit longer, but the text passes more easily through
4693 several gateways, some of which strip off MSB (Most Signigant Bit).
4695 There are two kinds of character sets: control character set and
4696 graphic character set. The former contains control characters such
4697 as `newline' and `escape' to provide control functions (control
4698 functions are also provided by escape sequences). The latter
4699 contains graphic characters such as 'A' and '-'. Emacs recognizes
4700 two control character sets and many graphic character sets.
4702 Graphic character sets are classified into one of the following
4703 four classes, according to the number of bytes (DIMENSION) and
4704 number of characters in one dimension (CHARS) of the set:
4705 - DIMENSION1_CHARS94
4706 - DIMENSION1_CHARS96
4707 - DIMENSION2_CHARS94
4708 - DIMENSION2_CHARS96
4710 In addition, each character set is assigned an identification tag,
4711 unique for each set, called "final character" (denoted as <F>
4712 hereafter). The <F> of each character set is decided by ECMA(*)
4713 when it is registered in ISO. The code range of <F> is 0x30..0x7F
4714 (0x30..0x3F are for private use only).
4716 Note (*): ECMA = European Computer Manufacturers Association
4718 Here are examples of graphic character set [NAME(<F>)]:
4719 o DIMENSION1_CHARS94 -- ASCII('B'), right-half-of-JISX0201('I'), ...
4720 o DIMENSION1_CHARS96 -- right-half-of-ISO8859-1('A'), ...
4721 o DIMENSION2_CHARS94 -- GB2312('A'), JISX0208('B'), ...
4722 o DIMENSION2_CHARS96 -- none for the moment
4724 A code area (1 byte = 8 bits) is divided into 4 areas, C0, GL, C1, and GR.
4725 C0 [0x00..0x1F] -- control character plane 0
4726 GL [0x20..0x7F] -- graphic character plane 0
4727 C1 [0x80..0x9F] -- control character plane 1
4728 GR [0xA0..0xFF] -- graphic character plane 1
4730 A control character set is directly designated and invoked to C0 or
4731 C1 by an escape sequence. The most common case is that:
4732 - ISO646's control character set is designated/invoked to C0, and
4733 - ISO6429's control character set is designated/invoked to C1,
4734 and usually these designations/invocations are omitted in encoded
4735 text. In a 7-bit environment, only C0 can be used, and a control
4736 character for C1 is encoded by an appropriate escape sequence to
4737 fit into the environment. All control characters for C1 are
4738 defined to have corresponding escape sequences.
4740 A graphic character set is at first designated to one of four
4741 graphic registers (G0 through G3), then these graphic registers are
4742 invoked to GL or GR. These designations and invocations can be
4743 done independently. The most common case is that G0 is invoked to
4744 GL, G1 is invoked to GR, and ASCII is designated to G0. Usually
4745 these invocations and designations are omitted in encoded text.
4746 In a 7-bit environment, only GL can be used.
4748 When a graphic character set of CHARS94 is invoked to GL, codes
4749 0x20 and 0x7F of the GL area work as control characters SPACE and
4750 DEL respectively, and codes 0xA0 and 0xFF of the GR area should not
4753 There are two ways of invocation: locking-shift and single-shift.
4754 With locking-shift, the invocation lasts until the next different
4755 invocation, whereas with single-shift, the invocation affects the
4756 following character only and doesn't affect the locking-shift
4757 state. Invocations are done by the following control characters or
4760 ----------------------------------------------------------------------
4761 abbrev function cntrl escape seq description
4762 ----------------------------------------------------------------------
4763 SI/LS0 (shift-in) 0x0F none invoke G0 into GL
4764 SO/LS1 (shift-out) 0x0E none invoke G1 into GL
4765 LS2 (locking-shift-2) none ESC 'n' invoke G2 into GL
4766 LS3 (locking-shift-3) none ESC 'o' invoke G3 into GL
4767 LS1R (locking-shift-1 right) none ESC '~' invoke G1 into GR (*)
4768 LS2R (locking-shift-2 right) none ESC '}' invoke G2 into GR (*)
4769 LS3R (locking-shift 3 right) none ESC '|' invoke G3 into GR (*)
4770 SS2 (single-shift-2) 0x8E ESC 'N' invoke G2 for one char
4771 SS3 (single-shift-3) 0x8F ESC 'O' invoke G3 for one char
4772 ----------------------------------------------------------------------
4773 (*) These are not used by any known coding system.
4775 Control characters for these functions are defined by macros
4776 ISO_CODE_XXX in `coding.h'.
4778 Designations are done by the following escape sequences:
4779 ----------------------------------------------------------------------
4780 escape sequence description
4781 ----------------------------------------------------------------------
4782 ESC '(' <F> designate DIMENSION1_CHARS94<F> to G0
4783 ESC ')' <F> designate DIMENSION1_CHARS94<F> to G1
4784 ESC '*' <F> designate DIMENSION1_CHARS94<F> to G2
4785 ESC '+' <F> designate DIMENSION1_CHARS94<F> to G3
4786 ESC ',' <F> designate DIMENSION1_CHARS96<F> to G0 (*)
4787 ESC '-' <F> designate DIMENSION1_CHARS96<F> to G1
4788 ESC '.' <F> designate DIMENSION1_CHARS96<F> to G2
4789 ESC '/' <F> designate DIMENSION1_CHARS96<F> to G3
4790 ESC '$' '(' <F> designate DIMENSION2_CHARS94<F> to G0 (**)
4791 ESC '$' ')' <F> designate DIMENSION2_CHARS94<F> to G1
4792 ESC '$' '*' <F> designate DIMENSION2_CHARS94<F> to G2
4793 ESC '$' '+' <F> designate DIMENSION2_CHARS94<F> to G3
4794 ESC '$' ',' <F> designate DIMENSION2_CHARS96<F> to G0 (*)
4795 ESC '$' '-' <F> designate DIMENSION2_CHARS96<F> to G1
4796 ESC '$' '.' <F> designate DIMENSION2_CHARS96<F> to G2
4797 ESC '$' '/' <F> designate DIMENSION2_CHARS96<F> to G3
4798 ----------------------------------------------------------------------
4800 In this list, "DIMENSION1_CHARS94<F>" means a graphic character set
4801 of dimension 1, chars 94, and final character <F>, etc...
4803 Note (*): Although these designations are not allowed in ISO2022,
4804 Emacs accepts them on decoding, and produces them on encoding
4805 CHARS96 character sets in a coding system which is characterized as
4806 7-bit environment, non-locking-shift, and non-single-shift.
4808 Note (**): If <F> is '@', 'A', or 'B', the intermediate character
4809 '(' can be omitted. We refer to this as "short-form" hereafter.
4811 Now you may notice that there are a lot of ways for encoding the
4812 same multilingual text in ISO2022. Actually, there exist many
4813 coding systems such as Compound Text (used in X11's inter client
4814 communication, ISO-2022-JP (used in Japanese internet), ISO-2022-KR
4815 (used in Korean internet), EUC (Extended UNIX Code, used in Asian
4816 localized platforms), and all of these are variants of ISO2022.
4818 In addition to the above, Emacs handles two more kinds of escape
4819 sequences: ISO6429's direction specification and Emacs' private
4820 sequence for specifying character composition.
4822 ISO6429's direction specification takes the following form:
4823 o CSI ']' -- end of the current direction
4824 o CSI '0' ']' -- end of the current direction
4825 o CSI '1' ']' -- start of left-to-right text
4826 o CSI '2' ']' -- start of right-to-left text
4827 The control character CSI (0x9B: control sequence introducer) is
4828 abbreviated to the escape sequence ESC '[' in a 7-bit environment.
4830 Character composition specification takes the following form:
4831 o ESC '0' -- start character composition
4832 o ESC '1' -- end character composition
4833 Since these are not standard escape sequences of any ISO standard,
4834 their use with these meanings is restricted to Emacs only. */
4837 reset_iso2022 (Lisp_Object coding_system, struct iso2022_decoder *iso)
4841 for (i = 0; i < 4; i++)
4843 if (!NILP (coding_system))
4845 XCODING_SYSTEM_ISO2022_INITIAL_CHARSET (coding_system, i);
4847 iso->charset[i] = Qt;
4848 iso->invalid_designated[i] = 0;
4850 iso->esc = ISO_ESC_NOTHING;
4851 iso->esc_bytes_index = 0;
4852 iso->register_left = 0;
4853 iso->register_right = 1;
4854 iso->switched_dir_and_no_valid_charset_yet = 0;
4855 iso->invalid_switch_dir = 0;
4856 iso->output_direction_sequence = 0;
4857 iso->output_literally = 0;
4858 #ifdef ENABLE_COMPOSITE_CHARS
4859 if (iso->composite_chars)
4860 Dynarr_reset (iso->composite_chars);
4865 fit_to_be_escape_quoted (unsigned char c)
4882 /* Parse one byte of an ISO2022 escape sequence.
4883 If the result is an invalid escape sequence, return 0 and
4884 do not change anything in STR. Otherwise, if the result is
4885 an incomplete escape sequence, update ISO2022.ESC and
4886 ISO2022.ESC_BYTES and return -1. Otherwise, update
4887 all the state variables (but not ISO2022.ESC_BYTES) and
4890 If CHECK_INVALID_CHARSETS is non-zero, check for designation
4891 or invocation of an invalid character set and treat that as
4892 an unrecognized escape sequence. */
4895 parse_iso2022_esc (Lisp_Object codesys, struct iso2022_decoder *iso,
4896 unsigned char c, unsigned int *flags,
4897 int check_invalid_charsets)
4899 /* (1) If we're at the end of a designation sequence, CS is the
4900 charset being designated and REG is the register to designate
4903 (2) If we're at the end of a locking-shift sequence, REG is
4904 the register to invoke and HALF (0 == left, 1 == right) is
4905 the half to invoke it into.
4907 (3) If we're at the end of a single-shift sequence, REG is
4908 the register to invoke. */
4909 Lisp_Object cs = Qnil;
4912 /* NOTE: This code does goto's all over the fucking place.
4913 The reason for this is that we're basically implementing
4914 a state machine here, and hierarchical languages like C
4915 don't really provide a clean way of doing this. */
4917 if (! (*flags & CODING_STATE_ESCAPE))
4918 /* At beginning of escape sequence; we need to reset our
4919 escape-state variables. */
4920 iso->esc = ISO_ESC_NOTHING;
4922 iso->output_literally = 0;
4923 iso->output_direction_sequence = 0;
4927 case ISO_ESC_NOTHING:
4928 iso->esc_bytes_index = 0;
4931 case ISO_CODE_ESC: /* Start escape sequence */
4932 *flags |= CODING_STATE_ESCAPE;
4936 case ISO_CODE_CSI: /* ISO6429 (specifying directionality) */
4937 *flags |= CODING_STATE_ESCAPE;
4938 iso->esc = ISO_ESC_5_11;
4941 case ISO_CODE_SO: /* locking shift 1 */
4944 case ISO_CODE_SI: /* locking shift 0 */
4948 case ISO_CODE_SS2: /* single shift */
4951 case ISO_CODE_SS3: /* single shift */
4955 default: /* Other control characters */
4962 /**** single shift ****/
4964 case 'N': /* single shift 2 */
4967 case 'O': /* single shift 3 */
4971 /**** locking shift ****/
4973 case '~': /* locking shift 1 right */
4976 case 'n': /* locking shift 2 */
4979 case '}': /* locking shift 2 right */
4982 case 'o': /* locking shift 3 */
4985 case '|': /* locking shift 3 right */
4989 #ifdef ENABLE_COMPOSITE_CHARS
4990 /**** composite ****/
4993 iso->esc = ISO_ESC_START_COMPOSITE;
4994 *flags = (*flags & CODING_STATE_ISO2022_LOCK) |
4995 CODING_STATE_COMPOSITE;
4999 iso->esc = ISO_ESC_END_COMPOSITE;
5000 *flags = (*flags & CODING_STATE_ISO2022_LOCK) &
5001 ~CODING_STATE_COMPOSITE;
5003 #endif /* ENABLE_COMPOSITE_CHARS */
5005 /**** directionality ****/
5008 iso->esc = ISO_ESC_5_11;
5011 /**** designation ****/
5013 case '$': /* multibyte charset prefix */
5014 iso->esc = ISO_ESC_2_4;
5018 if (0x28 <= c && c <= 0x2F)
5020 iso->esc = (enum iso_esc_flag) (c - 0x28 + ISO_ESC_2_8);
5024 /* This function is called with CODESYS equal to nil when
5025 doing coding-system detection. */
5027 && XCODING_SYSTEM_ISO2022_ESCAPE_QUOTED (codesys)
5028 && fit_to_be_escape_quoted (c))
5030 iso->esc = ISO_ESC_LITERAL;
5031 *flags &= CODING_STATE_ISO2022_LOCK;
5041 /**** directionality ****/
5043 case ISO_ESC_5_11: /* ISO6429 direction control */
5046 *flags &= (CODING_STATE_ISO2022_LOCK & ~CODING_STATE_R2L);
5047 goto directionality;
5049 if (c == '0') iso->esc = ISO_ESC_5_11_0;
5050 else if (c == '1') iso->esc = ISO_ESC_5_11_1;
5051 else if (c == '2') iso->esc = ISO_ESC_5_11_2;
5055 case ISO_ESC_5_11_0:
5058 *flags &= (CODING_STATE_ISO2022_LOCK & ~CODING_STATE_R2L);
5059 goto directionality;
5063 case ISO_ESC_5_11_1:
5066 *flags = (CODING_STATE_ISO2022_LOCK & ~CODING_STATE_R2L);
5067 goto directionality;
5071 case ISO_ESC_5_11_2:
5074 *flags = (*flags & CODING_STATE_ISO2022_LOCK) | CODING_STATE_R2L;
5075 goto directionality;
5080 iso->esc = ISO_ESC_DIRECTIONALITY;
5081 /* Various junk here to attempt to preserve the direction sequences
5082 literally in the text if they would otherwise be swallowed due
5083 to invalid designations that don't show up as actual charset
5084 changes in the text. */
5085 if (iso->invalid_switch_dir)
5087 /* We already inserted a direction switch literally into the
5088 text. We assume (#### this may not be right) that the
5089 next direction switch is the one going the other way,
5090 and we need to output that literally as well. */
5091 iso->output_literally = 1;
5092 iso->invalid_switch_dir = 0;
5098 /* If we are in the thrall of an invalid designation,
5099 then stick the directionality sequence literally into the
5100 output stream so it ends up in the original text again. */
5101 for (jj = 0; jj < 4; jj++)
5102 if (iso->invalid_designated[jj])
5106 iso->output_literally = 1;
5107 iso->invalid_switch_dir = 1;
5110 /* Indicate that we haven't yet seen a valid designation,
5111 so that if a switch-dir is directly followed by an
5112 invalid designation, both get inserted literally. */
5113 iso->switched_dir_and_no_valid_charset_yet = 1;
5118 /**** designation ****/
5121 if (0x28 <= c && c <= 0x2F)
5123 iso->esc = (enum iso_esc_flag) (c - 0x28 + ISO_ESC_2_4_8);
5126 if (0x40 <= c && c <= 0x42)
5129 cs = CHARSET_BY_ATTRIBUTES (94, -1, c,
5130 *flags & CODING_STATE_R2L ?
5131 CHARSET_RIGHT_TO_LEFT :
5132 CHARSET_LEFT_TO_RIGHT);
5143 if (c < '0' || c > '~')
5144 return 0; /* bad final byte */
5146 if (iso->esc >= ISO_ESC_2_8 &&
5147 iso->esc <= ISO_ESC_2_15)
5149 chars = (iso->esc >= ISO_ESC_2_12) ? 96 : 94;
5150 single = 1; /* single-byte */
5151 reg = (iso->esc - ISO_ESC_2_8) & 3;
5153 else if (iso->esc >= ISO_ESC_2_4_8 &&
5154 iso->esc <= ISO_ESC_2_4_15)
5156 chars = (iso->esc >= ISO_ESC_2_4_12) ? 96 : 94;
5157 single = -1; /* multi-byte */
5158 reg = (iso->esc - ISO_ESC_2_4_8) & 3;
5162 /* Can this ever be reached? -slb */
5166 cs = CHARSET_BY_ATTRIBUTES (chars, single, c,
5167 *flags & CODING_STATE_R2L ?
5168 CHARSET_RIGHT_TO_LEFT :
5169 CHARSET_LEFT_TO_RIGHT);
5175 iso->esc_bytes[iso->esc_bytes_index++] = (unsigned char) c;
5179 if (check_invalid_charsets && !CHARSETP (iso->charset[reg]))
5180 /* can't invoke something that ain't there. */
5182 iso->esc = ISO_ESC_SINGLE_SHIFT;
5183 *flags &= CODING_STATE_ISO2022_LOCK;
5185 *flags |= CODING_STATE_SS2;
5187 *flags |= CODING_STATE_SS3;
5191 if (check_invalid_charsets &&
5192 !CHARSETP (iso->charset[reg]))
5193 /* can't invoke something that ain't there. */
5196 iso->register_right = reg;
5198 iso->register_left = reg;
5199 *flags &= CODING_STATE_ISO2022_LOCK;
5200 iso->esc = ISO_ESC_LOCKING_SHIFT;
5204 if (NILP (cs) && check_invalid_charsets)
5206 iso->invalid_designated[reg] = 1;
5207 iso->charset[reg] = Vcharset_ascii;
5208 iso->esc = ISO_ESC_DESIGNATE;
5209 *flags &= CODING_STATE_ISO2022_LOCK;
5210 iso->output_literally = 1;
5211 if (iso->switched_dir_and_no_valid_charset_yet)
5213 /* We encountered a switch-direction followed by an
5214 invalid designation. Ensure that the switch-direction
5215 gets outputted; otherwise it will probably get eaten
5216 when the text is written out again. */
5217 iso->switched_dir_and_no_valid_charset_yet = 0;
5218 iso->output_direction_sequence = 1;
5219 /* And make sure that the switch-dir going the other
5220 way gets outputted, as well. */
5221 iso->invalid_switch_dir = 1;
5225 /* This function is called with CODESYS equal to nil when
5226 doing coding-system detection. */
5227 if (!NILP (codesys))
5229 charset_conversion_spec_dynarr *dyn =
5230 XCODING_SYSTEM (codesys)->iso2022.input_conv;
5236 for (i = 0; i < Dynarr_length (dyn); i++)
5238 struct charset_conversion_spec *spec = Dynarr_atp (dyn, i);
5239 if (EQ (cs, spec->from_charset))
5240 cs = spec->to_charset;
5245 iso->charset[reg] = cs;
5246 iso->esc = ISO_ESC_DESIGNATE;
5247 *flags &= CODING_STATE_ISO2022_LOCK;
5248 if (iso->invalid_designated[reg])
5250 iso->invalid_designated[reg] = 0;
5251 iso->output_literally = 1;
5253 if (iso->switched_dir_and_no_valid_charset_yet)
5254 iso->switched_dir_and_no_valid_charset_yet = 0;
5259 detect_coding_iso2022 (struct detection_state *st, const Extbyte *src, Lstream_data_count n)
5263 /* #### There are serious deficiencies in the recognition mechanism
5264 here. This needs to be much smarter if it's going to cut it.
5265 The sequence "\xff\x0f" is currently detected as LOCK_SHIFT while
5266 it should be detected as Latin-1.
5267 All the ISO2022 stuff in this file should be synced up with the
5268 code from FSF Emacs-20.4, in which Mule should be more or less stable.
5269 Perhaps we should wait till R2L works in FSF Emacs? */
5271 if (!st->iso2022.initted)
5273 reset_iso2022 (Qnil, &st->iso2022.iso);
5274 st->iso2022.mask = (CODING_CATEGORY_ISO_7_MASK |
5275 CODING_CATEGORY_ISO_8_DESIGNATE_MASK |
5276 CODING_CATEGORY_ISO_8_1_MASK |
5277 CODING_CATEGORY_ISO_8_2_MASK |
5278 CODING_CATEGORY_ISO_LOCK_SHIFT_MASK);
5279 st->iso2022.flags = 0;
5280 st->iso2022.high_byte_count = 0;
5281 st->iso2022.saw_single_shift = 0;
5282 st->iso2022.initted = 1;
5285 mask = st->iso2022.mask;
5289 unsigned char c = *(unsigned char *)src++;
5292 mask &= ~CODING_CATEGORY_ISO_7_MASK;
5293 st->iso2022.high_byte_count++;
5297 if (st->iso2022.high_byte_count && !st->iso2022.saw_single_shift)
5299 if (st->iso2022.high_byte_count & 1)
5300 /* odd number of high bytes; assume not iso-8-2 */
5301 mask &= ~CODING_CATEGORY_ISO_8_2_MASK;
5303 st->iso2022.high_byte_count = 0;
5304 st->iso2022.saw_single_shift = 0;
5306 mask &= ~CODING_CATEGORY_ISO_7_MASK;
5308 if (!(st->iso2022.flags & CODING_STATE_ESCAPE)
5309 && (BYTE_C0_P (c) || BYTE_C1_P (c)))
5310 { /* control chars */
5313 /* Allow and ignore control characters that you might
5314 reasonably see in a text file */
5319 case 8: /* backspace */
5320 case 11: /* vertical tab */
5321 case 12: /* form feed */
5322 case 26: /* MS-DOS C-z junk */
5323 case 31: /* '^_' -- for info */
5324 goto label_continue_loop;
5331 if ((st->iso2022.flags & CODING_STATE_ESCAPE) || BYTE_C0_P (c)
5334 if (parse_iso2022_esc (Qnil, &st->iso2022.iso, c,
5335 &st->iso2022.flags, 0))
5337 switch (st->iso2022.iso.esc)
5339 case ISO_ESC_DESIGNATE:
5340 mask &= ~CODING_CATEGORY_ISO_8_1_MASK;
5341 mask &= ~CODING_CATEGORY_ISO_8_2_MASK;
5343 case ISO_ESC_LOCKING_SHIFT:
5344 mask = CODING_CATEGORY_ISO_LOCK_SHIFT_MASK;
5345 goto ran_out_of_chars;
5346 case ISO_ESC_SINGLE_SHIFT:
5347 mask &= ~CODING_CATEGORY_ISO_8_DESIGNATE_MASK;
5348 st->iso2022.saw_single_shift = 1;
5357 goto ran_out_of_chars;
5360 label_continue_loop:;
5369 postprocess_iso2022_mask (int mask)
5371 /* #### kind of cheesy */
5372 /* If seven-bit ISO is allowed, then assume that the encoding is
5373 entirely seven-bit and turn off the eight-bit ones. */
5374 if (mask & CODING_CATEGORY_ISO_7_MASK)
5375 mask &= ~ (CODING_CATEGORY_ISO_8_DESIGNATE_MASK |
5376 CODING_CATEGORY_ISO_8_1_MASK |
5377 CODING_CATEGORY_ISO_8_2_MASK);
5381 /* If FLAGS is a null pointer or specifies right-to-left motion,
5382 output a switch-dir-to-left-to-right sequence to DST.
5383 Also update FLAGS if it is not a null pointer.
5384 If INTERNAL_P is set, we are outputting in internal format and
5385 need to handle the CSI differently. */
5388 restore_left_to_right_direction (Lisp_Coding_System *codesys,
5389 unsigned_char_dynarr *dst,
5390 unsigned int *flags,
5393 if (!flags || (*flags & CODING_STATE_R2L))
5395 if (CODING_SYSTEM_ISO2022_SEVEN (codesys))
5397 Dynarr_add (dst, ISO_CODE_ESC);
5398 Dynarr_add (dst, '[');
5400 else if (internal_p)
5401 DECODE_ADD_BINARY_CHAR (ISO_CODE_CSI, dst);
5403 Dynarr_add (dst, ISO_CODE_CSI);
5404 Dynarr_add (dst, '0');
5405 Dynarr_add (dst, ']');
5407 *flags &= ~CODING_STATE_R2L;
5411 /* If FLAGS is a null pointer or specifies a direction different from
5412 DIRECTION (which should be either CHARSET_RIGHT_TO_LEFT or
5413 CHARSET_LEFT_TO_RIGHT), output the appropriate switch-dir escape
5414 sequence to DST. Also update FLAGS if it is not a null pointer.
5415 If INTERNAL_P is set, we are outputting in internal format and
5416 need to handle the CSI differently. */
5419 ensure_correct_direction (int direction, Lisp_Coding_System *codesys,
5420 unsigned_char_dynarr *dst, unsigned int *flags,
5423 if ((!flags || (*flags & CODING_STATE_R2L)) &&
5424 direction == CHARSET_LEFT_TO_RIGHT)
5425 restore_left_to_right_direction (codesys, dst, flags, internal_p);
5426 else if (!CODING_SYSTEM_ISO2022_NO_ISO6429 (codesys)
5427 && (!flags || !(*flags & CODING_STATE_R2L)) &&
5428 direction == CHARSET_RIGHT_TO_LEFT)
5430 if (CODING_SYSTEM_ISO2022_SEVEN (codesys))
5432 Dynarr_add (dst, ISO_CODE_ESC);
5433 Dynarr_add (dst, '[');
5435 else if (internal_p)
5436 DECODE_ADD_BINARY_CHAR (ISO_CODE_CSI, dst);
5438 Dynarr_add (dst, ISO_CODE_CSI);
5439 Dynarr_add (dst, '2');
5440 Dynarr_add (dst, ']');
5442 *flags |= CODING_STATE_R2L;
5446 /* Convert ISO2022-format data to internal format. */
5449 decode_coding_iso2022 (Lstream *decoding, const Extbyte *src,
5450 unsigned_char_dynarr *dst, Lstream_data_count n)
5452 struct decoding_stream *str = DECODING_STREAM_DATA (decoding);
5453 unsigned int flags = str->flags;
5454 unsigned int cpos = str->cpos;
5455 unsigned char counter = str->counter;
5456 eol_type_t eol_type = str->eol_type;
5457 #ifdef ENABLE_COMPOSITE_CHARS
5458 unsigned_char_dynarr *real_dst = dst;
5460 Lisp_Object coding_system;
5462 XSETCODING_SYSTEM (coding_system, str->codesys);
5464 #ifdef ENABLE_COMPOSITE_CHARS
5465 if (flags & CODING_STATE_COMPOSITE)
5466 dst = str->iso2022.composite_chars;
5467 #endif /* ENABLE_COMPOSITE_CHARS */
5471 unsigned char c = *(unsigned char *)src++;
5472 if (flags & CODING_STATE_ESCAPE)
5473 { /* Within ESC sequence */
5474 int retval = parse_iso2022_esc (coding_system, &str->iso2022,
5479 switch (str->iso2022.esc)
5481 #ifdef ENABLE_COMPOSITE_CHARS
5482 case ISO_ESC_START_COMPOSITE:
5483 if (str->iso2022.composite_chars)
5484 Dynarr_reset (str->iso2022.composite_chars);
5486 str->iso2022.composite_chars = Dynarr_new (unsigned_char);
5487 dst = str->iso2022.composite_chars;
5489 case ISO_ESC_END_COMPOSITE:
5491 Bufbyte comstr[MAX_EMCHAR_LEN];
5493 Emchar emch = lookup_composite_char (Dynarr_atp (dst, 0),
5494 Dynarr_length (dst));
5496 len = set_charptr_emchar (comstr, emch);
5497 Dynarr_add_many (dst, comstr, len);
5500 #endif /* ENABLE_COMPOSITE_CHARS */
5502 case ISO_ESC_LITERAL:
5503 COMPOSE_FLUSH_CHARS (str, dst);
5504 decode_flush_er_chars (str, dst);
5505 DECODE_ADD_BINARY_CHAR (c, dst);
5509 /* Everything else handled already */
5514 /* Attempted error recovery. */
5515 if (str->iso2022.output_direction_sequence)
5516 ensure_correct_direction (flags & CODING_STATE_R2L ?
5517 CHARSET_RIGHT_TO_LEFT :
5518 CHARSET_LEFT_TO_RIGHT,
5519 str->codesys, dst, 0, 1);
5520 /* More error recovery. */
5521 if (!retval || str->iso2022.output_literally)
5523 /* Output the (possibly invalid) sequence */
5525 COMPOSE_FLUSH_CHARS (str, dst);
5526 decode_flush_er_chars (str, dst);
5527 for (i = 0; i < str->iso2022.esc_bytes_index; i++)
5528 DECODE_ADD_BINARY_CHAR (str->iso2022.esc_bytes[i], dst);
5529 flags &= CODING_STATE_ISO2022_LOCK;
5531 n++, src--;/* Repeat the loop with the same character. */
5534 /* No sense in reprocessing the final byte of the
5535 escape sequence; it could mess things up anyway.
5537 COMPOSE_FLUSH_CHARS (str, dst);
5538 decode_flush_er_chars (str, dst);
5539 DECODE_ADD_BINARY_CHAR (c, dst);
5545 else if (BYTE_C0_P (c) || BYTE_C1_P (c))
5546 { /* Control characters */
5548 /***** Error-handling *****/
5550 /* If we were in the middle of a character, dump out the
5551 partial character. */
5554 COMPOSE_FLUSH_CHARS (str, dst);
5555 decode_flush_er_chars (str, dst);
5559 DECODE_ADD_BINARY_CHAR
5560 ((unsigned char)(cpos >> (counter * 8)), dst);
5565 /* If we just saw a single-shift character, dump it out.
5566 This may dump out the wrong sort of single-shift character,
5567 but least it will give an indication that something went
5569 if (flags & CODING_STATE_SS2)
5571 COMPOSE_FLUSH_CHARS (str, dst);
5572 decode_flush_er_chars (str, dst);
5573 DECODE_ADD_BINARY_CHAR (ISO_CODE_SS2, dst);
5574 flags &= ~CODING_STATE_SS2;
5576 if (flags & CODING_STATE_SS3)
5578 COMPOSE_FLUSH_CHARS (str, dst);
5579 decode_flush_er_chars (str, dst);
5580 DECODE_ADD_BINARY_CHAR (ISO_CODE_SS3, dst);
5581 flags &= ~CODING_STATE_SS3;
5584 /***** Now handle the control characters. *****/
5590 COMPOSE_FLUSH_CHARS (str, dst);
5591 decode_flush_er_chars (str, dst);
5592 if (eol_type == EOL_CR)
5593 Dynarr_add (dst, '\n');
5594 else if (eol_type != EOL_CRLF || flags & CODING_STATE_CR)
5595 Dynarr_add (dst, c);
5597 flags |= CODING_STATE_CR;
5598 goto label_continue_loop;
5600 else if (flags & CODING_STATE_CR)
5601 { /* eol_type == CODING_SYSTEM_EOL_CRLF */
5603 Dynarr_add (dst, '\r');
5604 flags &= ~CODING_STATE_CR;
5607 DECODE_HANDLE_EOL_TYPE (eol_type, c, flags, dst);
5610 flags &= CODING_STATE_ISO2022_LOCK;
5612 if (!parse_iso2022_esc (coding_system, &str->iso2022, c, &flags, 1))
5614 COMPOSE_FLUSH_CHARS (str, dst);
5615 decode_flush_er_chars (str, dst);
5616 DECODE_ADD_BINARY_CHAR (c, dst);
5620 { /* Graphic characters */
5621 Lisp_Object charset;
5630 COMPOSE_FLUSH_CHARS (str, dst);
5631 decode_flush_er_chars (str, dst);
5632 if (eol_type == EOL_CR)
5633 Dynarr_add (dst, '\n');
5634 else if (eol_type != EOL_CRLF || flags & CODING_STATE_CR)
5635 Dynarr_add (dst, c);
5637 flags |= CODING_STATE_CR;
5638 goto label_continue_loop;
5640 else if (flags & CODING_STATE_CR)
5641 { /* eol_type == CODING_SYSTEM_EOL_CRLF */
5643 Dynarr_add (dst, '\r');
5644 flags &= ~CODING_STATE_CR;
5647 DECODE_HANDLE_EOL_TYPE (eol_type, c, flags, dst);
5650 /* Now determine the charset. */
5651 reg = ((flags & CODING_STATE_SS2) ? 2
5652 : (flags & CODING_STATE_SS3) ? 3
5653 : !BYTE_ASCII_P (c) ? str->iso2022.register_right
5654 : str->iso2022.register_left);
5655 charset = str->iso2022.charset[reg];
5657 /* Error checking: */
5658 if (! CHARSETP (charset)
5659 || str->iso2022.invalid_designated[reg]
5660 || (((c & 0x7F) == ' ' || (c & 0x7F) == ISO_CODE_DEL)
5661 && XCHARSET_CHARS (charset) == 94))
5662 /* Mrmph. We are trying to invoke a register that has no
5663 or an invalid charset in it, or trying to add a character
5664 outside the range of the charset. Insert that char literally
5665 to preserve it for the output. */
5667 COMPOSE_FLUSH_CHARS (str, dst);
5668 decode_flush_er_chars (str, dst);
5672 DECODE_ADD_BINARY_CHAR
5673 ((unsigned char)(cpos >> (counter * 8)), dst);
5676 DECODE_ADD_BINARY_CHAR (c, dst);
5681 /* Things are probably hunky-dorey. */
5683 /* Fetch reverse charset, maybe. */
5684 if (((flags & CODING_STATE_R2L) &&
5685 XCHARSET_DIRECTION (charset) == CHARSET_LEFT_TO_RIGHT)
5687 (!(flags & CODING_STATE_R2L) &&
5688 XCHARSET_DIRECTION (charset) == CHARSET_RIGHT_TO_LEFT))
5690 Lisp_Object new_charset =
5691 XCHARSET_REVERSE_DIRECTION_CHARSET (charset);
5692 if (!NILP (new_charset))
5693 charset = new_charset;
5698 if (XCHARSET_DIMENSION (charset) == counter)
5700 COMPOSE_ADD_CHAR (str,
5701 DECODE_CHAR (charset,
5702 ((cpos & 0x7F7F7F) << 8)
5709 cpos = (cpos << 8) | c;
5711 lb = XCHARSET_LEADING_BYTE (charset);
5712 switch (XCHARSET_REP_BYTES (charset))
5715 DECODE_OUTPUT_PARTIAL_CHAR (ch);
5716 Dynarr_add (dst, c & 0x7F);
5719 case 2: /* one-byte official */
5720 DECODE_OUTPUT_PARTIAL_CHAR (ch);
5721 Dynarr_add (dst, lb);
5722 Dynarr_add (dst, c | 0x80);
5725 case 3: /* one-byte private or two-byte official */
5726 if (XCHARSET_PRIVATE_P (charset))
5728 DECODE_OUTPUT_PARTIAL_CHAR (ch);
5729 Dynarr_add (dst, PRE_LEADING_BYTE_PRIVATE_1);
5730 Dynarr_add (dst, lb);
5731 Dynarr_add (dst, c | 0x80);
5737 Dynarr_add (dst, lb);
5738 Dynarr_add (dst, ch | 0x80);
5739 Dynarr_add (dst, c | 0x80);
5747 default: /* two-byte private */
5750 Dynarr_add (dst, PRE_LEADING_BYTE_PRIVATE_2);
5751 Dynarr_add (dst, lb);
5752 Dynarr_add (dst, ch | 0x80);
5753 Dynarr_add (dst, c | 0x80);
5763 flags &= CODING_STATE_ISO2022_LOCK;
5766 label_continue_loop:;
5769 if (flags & CODING_STATE_END)
5771 COMPOSE_FLUSH_CHARS (str, dst);
5772 decode_flush_er_chars (str, dst);
5773 DECODE_OUTPUT_PARTIAL_CHAR (cpos);
5777 str->counter = counter;
5781 /***** ISO2022 encoder *****/
5783 /* Designate CHARSET into register REG. */
5786 iso2022_designate (Lisp_Object charset, unsigned char reg,
5787 struct encoding_stream *str, unsigned_char_dynarr *dst)
5789 static const char inter94[] = "()*+";
5790 static const char inter96[] = ",-./";
5791 unsigned short chars;
5792 unsigned char dimension;
5793 unsigned char final;
5794 Lisp_Object old_charset = str->iso2022.charset[reg];
5796 str->iso2022.charset[reg] = charset;
5797 if (!CHARSETP (charset))
5798 /* charset might be an initial nil or t. */
5800 chars = XCHARSET_CHARS (charset);
5801 dimension = XCHARSET_DIMENSION (charset);
5802 final = XCHARSET_FINAL (charset);
5803 if (!str->iso2022.force_charset_on_output[reg] &&
5804 CHARSETP (old_charset) &&
5805 XCHARSET_CHARS (old_charset) == chars &&
5806 XCHARSET_DIMENSION (old_charset) == dimension &&
5807 XCHARSET_FINAL (old_charset) == final)
5810 str->iso2022.force_charset_on_output[reg] = 0;
5813 charset_conversion_spec_dynarr *dyn =
5814 str->codesys->iso2022.output_conv;
5820 for (i = 0; i < Dynarr_length (dyn); i++)
5822 struct charset_conversion_spec *spec = Dynarr_atp (dyn, i);
5823 if (EQ (charset, spec->from_charset))
5824 charset = spec->to_charset;
5829 Dynarr_add (dst, ISO_CODE_ESC);
5834 Dynarr_add (dst, inter94[reg]);
5837 Dynarr_add (dst, '$');
5839 || !(CODING_SYSTEM_ISO2022_SHORT (str->codesys))
5842 Dynarr_add (dst, inter94[reg]);
5847 Dynarr_add (dst, inter96[reg]);
5850 Dynarr_add (dst, '$');
5851 Dynarr_add (dst, inter96[reg]);
5855 Dynarr_add (dst, final);
5859 ensure_normal_shift (struct encoding_stream *str, unsigned_char_dynarr *dst)
5861 if (str->iso2022.register_left != 0)
5863 Dynarr_add (dst, ISO_CODE_SI);
5864 str->iso2022.register_left = 0;
5869 ensure_shift_out (struct encoding_stream *str, unsigned_char_dynarr *dst)
5871 if (str->iso2022.register_left != 1)
5873 Dynarr_add (dst, ISO_CODE_SO);
5874 str->iso2022.register_left = 1;
5879 char_encode_iso2022 (struct encoding_stream *str, Emchar ch,
5880 unsigned_char_dynarr *dst, unsigned int *flags)
5882 unsigned char charmask;
5883 Lisp_Coding_System* codesys = str->codesys;
5884 eol_type_t eol_type = CODING_SYSTEM_EOL_TYPE (str->codesys);
5886 Lisp_Object charset = str->iso2022.current_charset;
5887 int half = str->iso2022.current_half;
5888 int code_point = -1;
5892 restore_left_to_right_direction (codesys, dst, flags, 0);
5894 /* Make sure G0 contains ASCII */
5895 if ((ch > ' ' && ch < ISO_CODE_DEL)
5896 || !CODING_SYSTEM_ISO2022_NO_ASCII_CNTL (codesys))
5898 ensure_normal_shift (str, dst);
5899 iso2022_designate (Vcharset_ascii, 0, str, dst);
5902 /* If necessary, restore everything to the default state
5904 if (ch == '\n' && !(CODING_SYSTEM_ISO2022_NO_ASCII_EOL (codesys)))
5906 restore_left_to_right_direction (codesys, dst, flags, 0);
5908 ensure_normal_shift (str, dst);
5910 for (i = 0; i < 4; i++)
5912 Lisp_Object initial_charset =
5913 CODING_SYSTEM_ISO2022_INITIAL_CHARSET (codesys, i);
5914 iso2022_designate (initial_charset, i, str, dst);
5919 if (eol_type != EOL_LF && eol_type != EOL_AUTODETECT)
5920 Dynarr_add (dst, '\r');
5921 if (eol_type != EOL_CR)
5922 Dynarr_add (dst, ch);
5926 if (CODING_SYSTEM_ISO2022_ESCAPE_QUOTED (codesys)
5927 && fit_to_be_escape_quoted (ch))
5928 Dynarr_add (dst, ISO_CODE_ESC);
5929 Dynarr_add (dst, ch);
5932 else if ( (0x80 <= ch) && (ch <= 0x9f) )
5934 charmask = (half == 0 ? 0x00 : 0x80);
5936 if (CODING_SYSTEM_ISO2022_ESCAPE_QUOTED (codesys)
5937 && fit_to_be_escape_quoted (ch))
5938 Dynarr_add (dst, ISO_CODE_ESC);
5939 /* you asked for it ... */
5940 Dynarr_add (dst, ch);
5946 /* Now determine which register to use. */
5948 for (i = 0; i < 4; i++)
5950 if ((CHARSETP (charset = str->iso2022.charset[i])
5951 && ((code_point = charset_code_point (charset, ch, 0)) >= 0))
5955 = CODING_SYSTEM_ISO2022_INITIAL_CHARSET (codesys, i))
5956 && ((code_point = charset_code_point (charset, ch, 0)) >= 0)))
5964 Lisp_Object original_default_coded_charset_priority_list
5965 = Vdefault_coded_charset_priority_list;
5967 while (!EQ (Vdefault_coded_charset_priority_list, Qnil))
5969 code_point = ENCODE_CHAR (ch, charset);
5970 if (XCHARSET_FINAL (charset))
5972 Vdefault_coded_charset_priority_list
5973 = Fcdr (Fmemq (XCHARSET_NAME (charset),
5974 Vdefault_coded_charset_priority_list));
5976 code_point = ENCODE_CHAR (ch, charset);
5977 if (!XCHARSET_FINAL (charset))
5979 charset = Vcharset_ascii;
5983 Vdefault_coded_charset_priority_list
5984 = original_default_coded_charset_priority_list;
5986 ensure_correct_direction (XCHARSET_DIRECTION (charset),
5987 codesys, dst, flags, 0);
5991 if (XCHARSET_GRAPHIC (charset) != 0)
5993 if (!NILP (str->iso2022.charset[1]) &&
5994 (!CODING_SYSTEM_ISO2022_SEVEN (codesys)
5995 || CODING_SYSTEM_ISO2022_LOCK_SHIFT (codesys)))
5997 else if (!NILP (str->iso2022.charset[2]))
5999 else if (!NILP (str->iso2022.charset[3]))
6008 iso2022_designate (charset, reg, str, dst);
6010 /* Now invoke that register. */
6014 ensure_normal_shift (str, dst);
6018 if (CODING_SYSTEM_ISO2022_SEVEN (codesys))
6020 ensure_shift_out (str, dst);
6027 if (CODING_SYSTEM_ISO2022_SEVEN (str->codesys))
6029 Dynarr_add (dst, ISO_CODE_ESC);
6030 Dynarr_add (dst, 'N');
6035 Dynarr_add (dst, ISO_CODE_SS2);
6040 if (CODING_SYSTEM_ISO2022_SEVEN (str->codesys))
6042 Dynarr_add (dst, ISO_CODE_ESC);
6043 Dynarr_add (dst, 'O');
6048 Dynarr_add (dst, ISO_CODE_SS3);
6056 charmask = (half == 0 ? 0x00 : 0x80);
6058 switch (XCHARSET_DIMENSION (charset))
6061 Dynarr_add (dst, (code_point & 0xFF) | charmask);
6064 Dynarr_add (dst, ((code_point >> 8) & 0xFF) | charmask);
6065 Dynarr_add (dst, ( code_point & 0xFF) | charmask);
6068 Dynarr_add (dst, ((code_point >> 16) & 0xFF) | charmask);
6069 Dynarr_add (dst, ((code_point >> 8) & 0xFF) | charmask);
6070 Dynarr_add (dst, ( code_point & 0xFF) | charmask);
6073 Dynarr_add (dst, ((code_point >> 24) & 0xFF) | charmask);
6074 Dynarr_add (dst, ((code_point >> 16) & 0xFF) | charmask);
6075 Dynarr_add (dst, ((code_point >> 8) & 0xFF) | charmask);
6076 Dynarr_add (dst, ( code_point & 0xFF) | charmask);
6082 str->iso2022.current_charset = charset;
6083 str->iso2022.current_half = half;
6087 char_finish_iso2022 (struct encoding_stream *str, unsigned_char_dynarr *dst,
6088 unsigned int *flags)
6090 Lisp_Coding_System* codesys = str->codesys;
6093 restore_left_to_right_direction (codesys, dst, flags, 0);
6094 ensure_normal_shift (str, dst);
6095 for (i = 0; i < 4; i++)
6097 Lisp_Object initial_charset
6098 = CODING_SYSTEM_ISO2022_INITIAL_CHARSET (codesys, i);
6099 iso2022_designate (initial_charset, i, str, dst);
6104 /************************************************************************/
6105 /* No-conversion methods */
6106 /************************************************************************/
6108 /* This is used when reading in "binary" files -- i.e. files that may
6109 contain all 256 possible byte values and that are not to be
6110 interpreted as being in any particular decoding. */
6112 decode_coding_no_conversion (Lstream *decoding, const Extbyte *src,
6113 unsigned_char_dynarr *dst, Lstream_data_count n)
6115 struct decoding_stream *str = DECODING_STREAM_DATA (decoding);
6116 unsigned int flags = str->flags;
6117 unsigned int cpos = str->cpos;
6118 eol_type_t eol_type = str->eol_type;
6122 unsigned char c = *(unsigned char *)src++;
6124 DECODE_HANDLE_EOL_TYPE (eol_type, c, flags, dst);
6125 DECODE_ADD_BINARY_CHAR (c, dst);
6126 label_continue_loop:;
6129 DECODE_HANDLE_END_OF_CONVERSION (flags, cpos, dst);
6136 encode_coding_no_conversion (Lstream *encoding, const Bufbyte *src,
6137 unsigned_char_dynarr *dst, Lstream_data_count n)
6140 struct encoding_stream *str = ENCODING_STREAM_DATA (encoding);
6141 unsigned int flags = str->flags;
6142 unsigned int ch = str->ch;
6143 eol_type_t eol_type = CODING_SYSTEM_EOL_TYPE (str->codesys);
6145 unsigned char char_boundary = str->iso2022.current_char_boundary;
6152 if (char_boundary == 0)
6158 else if ( c >= 0xf8 )
6163 else if ( c >= 0xf0 )
6168 else if ( c >= 0xe0 )
6173 else if ( c >= 0xc0 )
6183 if (eol_type != EOL_LF && eol_type != EOL_AUTODETECT)
6184 Dynarr_add (dst, '\r');
6185 if (eol_type != EOL_CR)
6186 Dynarr_add (dst, c);
6189 Dynarr_add (dst, c);
6192 else if (char_boundary == 1)
6194 ch = ( ch << 6 ) | ( c & 0x3f );
6195 Dynarr_add (dst, ch & 0xff);
6200 ch = ( ch << 6 ) | ( c & 0x3f );
6203 #else /* not UTF2000 */
6206 if (eol_type != EOL_LF && eol_type != EOL_AUTODETECT)
6207 Dynarr_add (dst, '\r');
6208 if (eol_type != EOL_CR)
6209 Dynarr_add (dst, '\n');
6212 else if (BYTE_ASCII_P (c))
6215 Dynarr_add (dst, c);
6217 else if (BUFBYTE_LEADING_BYTE_P (c))
6220 if (c == LEADING_BYTE_LATIN_ISO8859_1 ||
6221 c == LEADING_BYTE_CONTROL_1)
6224 Dynarr_add (dst, '~'); /* untranslatable character */
6228 if (ch == LEADING_BYTE_LATIN_ISO8859_1)
6229 Dynarr_add (dst, c);
6230 else if (ch == LEADING_BYTE_CONTROL_1)
6233 Dynarr_add (dst, c - 0x20);
6235 /* else it should be the second or third byte of an
6236 untranslatable character, so ignore it */
6239 #endif /* not UTF2000 */
6245 str->iso2022.current_char_boundary = char_boundary;
6251 /************************************************************************/
6252 /* Initialization */
6253 /************************************************************************/
6256 syms_of_file_coding (void)
6258 INIT_LRECORD_IMPLEMENTATION (coding_system);
6260 DEFERROR_STANDARD (Qcoding_system_error, Qio_error);
6262 DEFSUBR (Fcoding_system_p);
6263 DEFSUBR (Ffind_coding_system);
6264 DEFSUBR (Fget_coding_system);
6265 DEFSUBR (Fcoding_system_list);
6266 DEFSUBR (Fcoding_system_name);
6267 DEFSUBR (Fmake_coding_system);
6268 DEFSUBR (Fcopy_coding_system);
6269 DEFSUBR (Fcoding_system_canonical_name_p);
6270 DEFSUBR (Fcoding_system_alias_p);
6271 DEFSUBR (Fcoding_system_aliasee);
6272 DEFSUBR (Fdefine_coding_system_alias);
6273 DEFSUBR (Fsubsidiary_coding_system);
6275 DEFSUBR (Fcoding_system_type);
6276 DEFSUBR (Fcoding_system_doc_string);
6278 DEFSUBR (Fcoding_system_charset);
6280 DEFSUBR (Fcoding_system_property);
6282 DEFSUBR (Fcoding_category_list);
6283 DEFSUBR (Fset_coding_priority_list);
6284 DEFSUBR (Fcoding_priority_list);
6285 DEFSUBR (Fset_coding_category_system);
6286 DEFSUBR (Fcoding_category_system);
6288 DEFSUBR (Fdetect_coding_region);
6289 DEFSUBR (Fdecode_coding_region);
6290 DEFSUBR (Fencode_coding_region);
6292 DEFSUBR (Fdecode_shift_jis_char);
6293 DEFSUBR (Fencode_shift_jis_char);
6294 DEFSUBR (Fdecode_big5_char);
6295 DEFSUBR (Fencode_big5_char);
6297 defsymbol (&Qcoding_systemp, "coding-system-p");
6298 defsymbol (&Qno_conversion, "no-conversion");
6299 defsymbol (&Qraw_text, "raw-text");
6301 defsymbol (&Qbig5, "big5");
6302 defsymbol (&Qshift_jis, "shift-jis");
6303 defsymbol (&Qucs4, "ucs-4");
6304 defsymbol (&Qutf8, "utf-8");
6305 defsymbol (&Qutf16, "utf-16");
6306 defsymbol (&Qccl, "ccl");
6307 defsymbol (&Qiso2022, "iso2022");
6309 defsymbol (&Qmnemonic, "mnemonic");
6310 defsymbol (&Qeol_type, "eol-type");
6311 defsymbol (&Qpost_read_conversion, "post-read-conversion");
6312 defsymbol (&Qpre_write_conversion, "pre-write-conversion");
6314 defsymbol (&Qcr, "cr");
6315 defsymbol (&Qlf, "lf");
6316 defsymbol (&Qcrlf, "crlf");
6317 defsymbol (&Qeol_cr, "eol-cr");
6318 defsymbol (&Qeol_lf, "eol-lf");
6319 defsymbol (&Qeol_crlf, "eol-crlf");
6321 defsymbol (&Qcharset_g0, "charset-g0");
6322 defsymbol (&Qcharset_g1, "charset-g1");
6323 defsymbol (&Qcharset_g2, "charset-g2");
6324 defsymbol (&Qcharset_g3, "charset-g3");
6325 defsymbol (&Qforce_g0_on_output, "force-g0-on-output");
6326 defsymbol (&Qforce_g1_on_output, "force-g1-on-output");
6327 defsymbol (&Qforce_g2_on_output, "force-g2-on-output");
6328 defsymbol (&Qforce_g3_on_output, "force-g3-on-output");
6329 defsymbol (&Qno_iso6429, "no-iso6429");
6330 defsymbol (&Qinput_charset_conversion, "input-charset-conversion");
6331 defsymbol (&Qoutput_charset_conversion, "output-charset-conversion");
6333 defsymbol (&Qshort, "short");
6334 defsymbol (&Qno_ascii_eol, "no-ascii-eol");
6335 defsymbol (&Qno_ascii_cntl, "no-ascii-cntl");
6336 defsymbol (&Qseven, "seven");
6337 defsymbol (&Qlock_shift, "lock-shift");
6338 defsymbol (&Qescape_quoted, "escape-quoted");
6341 defsymbol (&Qutf_8_mcs, "utf-8-mcs");
6342 defsymbol (&Qdisable_composition, "disable-composition");
6343 defsymbol (&Quse_entity_reference, "use-entity-reference");
6344 defsymbol (&Qd, "d");
6345 defsymbol (&Qx, "x");
6346 defsymbol (&QX, "X");
6348 defsymbol (&Qencode, "encode");
6349 defsymbol (&Qdecode, "decode");
6352 defsymbol (&coding_category_symbol[CODING_CATEGORY_SHIFT_JIS],
6354 defsymbol (&coding_category_symbol[CODING_CATEGORY_BIG5],
6356 defsymbol (&coding_category_symbol[CODING_CATEGORY_UCS4],
6358 defsymbol (&coding_category_symbol[CODING_CATEGORY_UTF16],
6360 defsymbol (&coding_category_symbol[CODING_CATEGORY_UTF8],
6362 defsymbol (&coding_category_symbol[CODING_CATEGORY_ISO_7],
6364 defsymbol (&coding_category_symbol[CODING_CATEGORY_ISO_8_DESIGNATE],
6366 defsymbol (&coding_category_symbol[CODING_CATEGORY_ISO_8_1],
6368 defsymbol (&coding_category_symbol[CODING_CATEGORY_ISO_8_2],
6370 defsymbol (&coding_category_symbol[CODING_CATEGORY_ISO_LOCK_SHIFT],
6373 defsymbol (&coding_category_symbol[CODING_CATEGORY_NO_CONVERSION],
6378 lstream_type_create_file_coding (void)
6380 LSTREAM_HAS_METHOD (decoding, reader);
6381 LSTREAM_HAS_METHOD (decoding, writer);
6382 LSTREAM_HAS_METHOD (decoding, rewinder);
6383 LSTREAM_HAS_METHOD (decoding, seekable_p);
6384 LSTREAM_HAS_METHOD (decoding, flusher);
6385 LSTREAM_HAS_METHOD (decoding, closer);
6386 LSTREAM_HAS_METHOD (decoding, marker);
6388 LSTREAM_HAS_METHOD (encoding, reader);
6389 LSTREAM_HAS_METHOD (encoding, writer);
6390 LSTREAM_HAS_METHOD (encoding, rewinder);
6391 LSTREAM_HAS_METHOD (encoding, seekable_p);
6392 LSTREAM_HAS_METHOD (encoding, flusher);
6393 LSTREAM_HAS_METHOD (encoding, closer);
6394 LSTREAM_HAS_METHOD (encoding, marker);
6398 vars_of_file_coding (void)
6402 fcd = xnew (struct file_coding_dump);
6403 dump_add_root_struct_ptr (&fcd, &fcd_description);
6405 /* Initialize to something reasonable ... */
6406 for (i = 0; i < CODING_CATEGORY_LAST; i++)
6408 fcd->coding_category_system[i] = Qnil;
6409 fcd->coding_category_by_priority[i] = i;
6412 Fprovide (intern ("file-coding"));
6414 DEFVAR_LISP ("keyboard-coding-system", &Vkeyboard_coding_system /*
6415 Coding system used for TTY keyboard input.
6416 Not used under a windowing system.
6418 Vkeyboard_coding_system = Qnil;
6420 DEFVAR_LISP ("terminal-coding-system", &Vterminal_coding_system /*
6421 Coding system used for TTY display output.
6422 Not used under a windowing system.
6424 Vterminal_coding_system = Qnil;
6426 DEFVAR_LISP ("coding-system-for-read", &Vcoding_system_for_read /*
6427 Overriding coding system used when reading from a file or process.
6428 You should bind this variable with `let', but do not set it globally.
6429 If this is non-nil, it specifies the coding system that will be used
6430 to decode input on read operations, such as from a file or process.
6431 It overrides `buffer-file-coding-system-for-read',
6432 `insert-file-contents-pre-hook', etc. Use those variables instead of
6433 this one for permanent changes to the environment. */ );
6434 Vcoding_system_for_read = Qnil;
6436 DEFVAR_LISP ("coding-system-for-write",
6437 &Vcoding_system_for_write /*
6438 Overriding coding system used when writing to a file or process.
6439 You should bind this variable with `let', but do not set it globally.
6440 If this is non-nil, it specifies the coding system that will be used
6441 to encode output for write operations, such as to a file or process.
6442 It overrides `buffer-file-coding-system', `write-region-pre-hook', etc.
6443 Use those variables instead of this one for permanent changes to the
6445 Vcoding_system_for_write = Qnil;
6447 DEFVAR_LISP ("file-name-coding-system", &Vfile_name_coding_system /*
6448 Coding system used to convert pathnames when accessing files.
6450 Vfile_name_coding_system = Qnil;
6452 DEFVAR_LISP ("coded-charset-entity-reference-alist",
6453 &Vcoded_charset_entity_reference_alist /*
6454 Alist of coded-charset vs corresponding entity-reference.
6455 Each element looks like (CCS PREFIX CODE-COLUMNS CODE-TYPE).
6456 CCS is coded-charset.
6457 CODE-COLUMNS is columns of code-point of entity-reference.
6458 CODE-TYPE is format type of code-point of entity-reference.
6459 `d' means decimal value and `x' means hexadecimal value.
6461 Vcoded_charset_entity_reference_alist = Qnil;
6463 DEFVAR_BOOL ("enable-multibyte-characters", &enable_multibyte_characters /*
6464 Non-nil means the buffer contents are regarded as multi-byte form
6465 of characters, not a binary code. This affects the display, file I/O,
6466 and behaviors of various editing commands.
6468 Setting this to nil does not do anything.
6470 enable_multibyte_characters = 1;
6474 complex_vars_of_file_coding (void)
6476 staticpro (&Vcoding_system_hash_table);
6477 Vcoding_system_hash_table =
6478 make_lisp_hash_table (50, HASH_TABLE_NON_WEAK, HASH_TABLE_EQ);
6480 the_codesys_prop_dynarr = Dynarr_new (codesys_prop);
6481 dump_add_root_struct_ptr (&the_codesys_prop_dynarr, &codesys_prop_dynarr_description);
6483 #define DEFINE_CODESYS_PROP(Prop_Type, Sym) do \
6485 struct codesys_prop csp; \
6487 csp.prop_type = (Prop_Type); \
6488 Dynarr_add (the_codesys_prop_dynarr, csp); \
6491 DEFINE_CODESYS_PROP (CODESYS_PROP_ALL_OK, Qmnemonic);
6492 DEFINE_CODESYS_PROP (CODESYS_PROP_ALL_OK, Qeol_type);
6493 DEFINE_CODESYS_PROP (CODESYS_PROP_ALL_OK, Qeol_cr);
6494 DEFINE_CODESYS_PROP (CODESYS_PROP_ALL_OK, Qeol_crlf);
6495 DEFINE_CODESYS_PROP (CODESYS_PROP_ALL_OK, Qeol_lf);
6496 DEFINE_CODESYS_PROP (CODESYS_PROP_ALL_OK, Qpost_read_conversion);
6497 DEFINE_CODESYS_PROP (CODESYS_PROP_ALL_OK, Qpre_write_conversion);
6499 DEFINE_CODESYS_PROP (CODESYS_PROP_ISO2022, Qcharset_g0);
6500 DEFINE_CODESYS_PROP (CODESYS_PROP_ISO2022, Qcharset_g1);
6501 DEFINE_CODESYS_PROP (CODESYS_PROP_ISO2022, Qcharset_g2);
6502 DEFINE_CODESYS_PROP (CODESYS_PROP_ISO2022, Qcharset_g3);
6503 DEFINE_CODESYS_PROP (CODESYS_PROP_ISO2022, Qforce_g0_on_output);
6504 DEFINE_CODESYS_PROP (CODESYS_PROP_ISO2022, Qforce_g1_on_output);
6505 DEFINE_CODESYS_PROP (CODESYS_PROP_ISO2022, Qforce_g2_on_output);
6506 DEFINE_CODESYS_PROP (CODESYS_PROP_ISO2022, Qforce_g3_on_output);
6507 DEFINE_CODESYS_PROP (CODESYS_PROP_ISO2022, Qshort);
6508 DEFINE_CODESYS_PROP (CODESYS_PROP_ISO2022, Qno_ascii_eol);
6509 DEFINE_CODESYS_PROP (CODESYS_PROP_ISO2022, Qno_ascii_cntl);
6510 DEFINE_CODESYS_PROP (CODESYS_PROP_ISO2022, Qseven);
6511 DEFINE_CODESYS_PROP (CODESYS_PROP_ISO2022, Qlock_shift);
6512 DEFINE_CODESYS_PROP (CODESYS_PROP_ISO2022, Qno_iso6429);
6513 DEFINE_CODESYS_PROP (CODESYS_PROP_ISO2022, Qescape_quoted);
6514 DEFINE_CODESYS_PROP (CODESYS_PROP_ISO2022, Qinput_charset_conversion);
6515 DEFINE_CODESYS_PROP (CODESYS_PROP_ISO2022, Qoutput_charset_conversion);
6517 DEFINE_CODESYS_PROP (CODESYS_PROP_CCL, Qencode);
6518 DEFINE_CODESYS_PROP (CODESYS_PROP_CCL, Qdecode);
6520 DEFINE_CODESYS_PROP (CODESYS_PROP_ALL_OK, Qdisable_composition);
6521 DEFINE_CODESYS_PROP (CODESYS_PROP_ALL_OK, Quse_entity_reference);
6524 /* Need to create this here or we're really screwed. */
6526 (Qraw_text, Qno_conversion,
6527 build_string ("Raw text, which means it converts only line-break-codes."),
6528 list2 (Qmnemonic, build_string ("Raw")));
6531 (Qbinary, Qno_conversion,
6532 build_string ("Binary, which means it does not convert anything."),
6533 list4 (Qeol_type, Qlf,
6534 Qmnemonic, build_string ("Binary")));
6540 ("Coding-system of UTF-8 with Multiple Coded-character-Sets extension."),
6541 list2 (Qmnemonic, build_string ("MTF8")));
6544 Fdefine_coding_system_alias (Qno_conversion, Qraw_text);
6546 Fdefine_coding_system_alias (Qfile_name, Qbinary);
6548 Fdefine_coding_system_alias (Qterminal, Qbinary);
6549 Fdefine_coding_system_alias (Qkeyboard, Qbinary);
6551 /* Need this for bootstrapping */
6552 fcd->coding_category_system[CODING_CATEGORY_NO_CONVERSION] =
6553 Fget_coding_system (Qraw_text);
6556 fcd->coding_category_system[CODING_CATEGORY_UTF8]
6557 = Fget_coding_system (Qutf_8_mcs);
6560 #if defined(MULE) && !defined(UTF2000)
6564 for (i = 0; i < countof (fcd->ucs_to_mule_table); i++)
6565 fcd->ucs_to_mule_table[i] = Qnil;
6567 staticpro (&mule_to_ucs_table);
6568 mule_to_ucs_table = Fmake_char_table(Qgeneric);
6569 #endif /* defined(MULE) && !defined(UTF2000) */