1 /* Code conversion functions.
2 Copyright (C) 1991, 1995 Free Software Foundation, Inc.
3 Copyright (C) 1995 Sun Microsystems, Inc.
5 This file is part of XEmacs.
7 XEmacs is free software; you can redistribute it and/or modify it
8 under the terms of the GNU General Public License as published by the
9 Free Software Foundation; either version 2, or (at your option) any
12 XEmacs is distributed in the hope that it will be useful, but WITHOUT
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
17 You should have received a copy of the GNU General Public License
18 along with XEmacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 /* Synched up with: Mule 2.3. Not in FSF. */
24 /* Rewritten by Ben Wing <ben@xemacs.org>. */
38 #include "file-coding.h"
40 Lisp_Object Qcoding_system_error;
42 Lisp_Object Vkeyboard_coding_system;
43 Lisp_Object Vterminal_coding_system;
44 Lisp_Object Vcoding_system_for_read;
45 Lisp_Object Vcoding_system_for_write;
46 Lisp_Object Vfile_name_coding_system;
48 /* Table of symbols identifying each coding category. */
49 Lisp_Object coding_category_symbol[CODING_CATEGORY_LAST];
53 struct file_coding_dump {
54 /* Coding system currently associated with each coding category. */
55 Lisp_Object coding_category_system[CODING_CATEGORY_LAST];
57 /* Table of all coding categories in decreasing order of priority.
58 This describes a permutation of the possible coding categories. */
59 int coding_category_by_priority[CODING_CATEGORY_LAST];
62 Lisp_Object ucs_to_mule_table[65536];
66 static const struct lrecord_description fcd_description_1[] = {
67 { XD_LISP_OBJECT_ARRAY, offsetof (struct file_coding_dump, coding_category_system), CODING_CATEGORY_LAST },
69 { XD_LISP_OBJECT_ARRAY, offsetof (struct file_coding_dump, ucs_to_mule_table), countof (fcd->ucs_to_mule_table) },
74 static const struct struct_description fcd_description = {
75 sizeof (struct file_coding_dump),
79 Lisp_Object mule_to_ucs_table;
81 Lisp_Object Qcoding_systemp;
83 Lisp_Object Qraw_text, Qno_conversion, Qccl, Qiso2022;
84 /* Qinternal in general.c */
86 Lisp_Object Qmnemonic, Qeol_type;
87 Lisp_Object Qcr, Qcrlf, Qlf;
88 Lisp_Object Qeol_cr, Qeol_crlf, Qeol_lf;
89 Lisp_Object Qpost_read_conversion;
90 Lisp_Object Qpre_write_conversion;
93 Lisp_Object Qucs4, Qutf8;
94 Lisp_Object Qbig5, Qshift_jis;
95 Lisp_Object Qcharset_g0, Qcharset_g1, Qcharset_g2, Qcharset_g3;
96 Lisp_Object Qforce_g0_on_output, Qforce_g1_on_output;
97 Lisp_Object Qforce_g2_on_output, Qforce_g3_on_output;
98 Lisp_Object Qno_iso6429;
99 Lisp_Object Qinput_charset_conversion, Qoutput_charset_conversion;
100 Lisp_Object Qescape_quoted;
101 Lisp_Object Qshort, Qno_ascii_eol, Qno_ascii_cntl, Qseven, Qlock_shift;
103 Lisp_Object Qencode, Qdecode;
105 Lisp_Object Vcoding_system_hash_table;
107 int enable_multibyte_characters;
110 /* Additional information used by the ISO2022 decoder and detector. */
111 struct iso2022_decoder
113 /* CHARSET holds the character sets currently assigned to the G0
114 through G3 variables. It is initialized from the array
115 INITIAL_CHARSET in CODESYS. */
116 Lisp_Object charset[4];
118 /* Which registers are currently invoked into the left (GL) and
119 right (GR) halves of the 8-bit encoding space? */
120 int register_left, register_right;
122 /* ISO_ESC holds a value indicating part of an escape sequence
123 that has already been seen. */
124 enum iso_esc_flag esc;
126 /* This records the bytes we've seen so far in an escape sequence,
127 in case the sequence is invalid (we spit out the bytes unchanged). */
128 unsigned char esc_bytes[8];
130 /* Index for next byte to store in ISO escape sequence. */
133 #ifdef ENABLE_COMPOSITE_CHARS
134 /* Stuff seen so far when composing a string. */
135 unsigned_char_dynarr *composite_chars;
138 /* If we saw an invalid designation sequence for a particular
139 register, we flag it here and switch to ASCII. The next time we
140 see a valid designation for this register, we turn off the flag
141 and do the designation normally, but pretend the sequence was
142 invalid. The effect of all this is that (most of the time) the
143 escape sequences for both the switch to the unknown charset, and
144 the switch back to the known charset, get inserted literally into
145 the buffer and saved out as such. The hope is that we can
146 preserve the escape sequences so that the resulting written out
147 file makes sense. If we don't do any of this, the designation
148 to the invalid charset will be preserved but that switch back
149 to the known charset will probably get eaten because it was
150 the same charset that was already present in the register. */
151 unsigned char invalid_designated[4];
153 /* We try to do similar things as above for direction-switching
154 sequences. If we encountered a direction switch while an
155 invalid designation was present, or an invalid designation
156 just after a direction switch (i.e. no valid designation
157 encountered yet), we insert the direction-switch escape
158 sequence literally into the output stream, and later on
159 insert the corresponding direction-restoring escape sequence
161 unsigned int switched_dir_and_no_valid_charset_yet :1;
162 unsigned int invalid_switch_dir :1;
164 /* Tells the decoder to output the escape sequence literally
165 even though it was valid. Used in the games we play to
166 avoid lossage when we encounter invalid designations. */
167 unsigned int output_literally :1;
168 /* We encountered a direction switch followed by an invalid
169 designation. We didn't output the direction switch
170 literally because we didn't know about the invalid designation;
171 but we have to do so now. */
172 unsigned int output_direction_sequence :1;
175 EXFUN (Fcopy_coding_system, 2);
177 struct detection_state;
178 static int detect_coding_sjis (struct detection_state *st,
179 const Extbyte *src, size_t n);
180 static void decode_coding_sjis (Lstream *decoding, const Extbyte *src,
181 unsigned_char_dynarr *dst, size_t n);
182 static void encode_coding_sjis (Lstream *encoding, const Bufbyte *src,
183 unsigned_char_dynarr *dst, size_t n);
184 static int detect_coding_big5 (struct detection_state *st,
185 const Extbyte *src, size_t n);
186 static void decode_coding_big5 (Lstream *decoding, const Extbyte *src,
187 unsigned_char_dynarr *dst, size_t n);
188 static void encode_coding_big5 (Lstream *encoding, const Bufbyte *src,
189 unsigned_char_dynarr *dst, size_t n);
190 static int detect_coding_ucs4 (struct detection_state *st,
191 const Extbyte *src, size_t n);
192 static void decode_coding_ucs4 (Lstream *decoding, const Extbyte *src,
193 unsigned_char_dynarr *dst, size_t n);
194 static void encode_coding_ucs4 (Lstream *encoding, const Bufbyte *src,
195 unsigned_char_dynarr *dst, size_t n);
196 static int detect_coding_utf8 (struct detection_state *st,
197 const Extbyte *src, size_t n);
198 static void decode_coding_utf8 (Lstream *decoding, const Extbyte *src,
199 unsigned_char_dynarr *dst, size_t n);
200 static void encode_coding_utf8 (Lstream *encoding, const Bufbyte *src,
201 unsigned_char_dynarr *dst, size_t n);
202 static int postprocess_iso2022_mask (int mask);
203 static void reset_iso2022 (Lisp_Object coding_system,
204 struct iso2022_decoder *iso);
205 static int detect_coding_iso2022 (struct detection_state *st,
206 const Extbyte *src, size_t n);
207 static void decode_coding_iso2022 (Lstream *decoding, const Extbyte *src,
208 unsigned_char_dynarr *dst, size_t n);
209 static void encode_coding_iso2022 (Lstream *encoding, const Bufbyte *src,
210 unsigned_char_dynarr *dst, size_t n);
212 static void decode_coding_no_conversion (Lstream *decoding, const Extbyte *src,
213 unsigned_char_dynarr *dst, size_t n);
214 static void encode_coding_no_conversion (Lstream *encoding, const Bufbyte *src,
215 unsigned_char_dynarr *dst, size_t n);
216 static void mule_decode (Lstream *decoding, const Extbyte *src,
217 unsigned_char_dynarr *dst, size_t n);
218 static void mule_encode (Lstream *encoding, const Bufbyte *src,
219 unsigned_char_dynarr *dst, size_t n);
221 typedef struct codesys_prop codesys_prop;
230 Dynarr_declare (codesys_prop);
231 } codesys_prop_dynarr;
233 static const struct lrecord_description codesys_prop_description_1[] = {
234 { XD_LISP_OBJECT, offsetof (codesys_prop, sym) },
238 static const struct struct_description codesys_prop_description = {
239 sizeof (codesys_prop),
240 codesys_prop_description_1
243 static const struct lrecord_description codesys_prop_dynarr_description_1[] = {
244 XD_DYNARR_DESC (codesys_prop_dynarr, &codesys_prop_description),
248 static const struct struct_description codesys_prop_dynarr_description = {
249 sizeof (codesys_prop_dynarr),
250 codesys_prop_dynarr_description_1
253 codesys_prop_dynarr *the_codesys_prop_dynarr;
255 enum codesys_prop_enum
258 CODESYS_PROP_ISO2022,
263 /************************************************************************/
264 /* Coding system functions */
265 /************************************************************************/
267 static Lisp_Object mark_coding_system (Lisp_Object);
268 static void print_coding_system (Lisp_Object, Lisp_Object, int);
269 static void finalize_coding_system (void *header, int for_disksave);
272 static const struct lrecord_description ccs_description_1[] = {
273 { XD_LISP_OBJECT, offsetof (charset_conversion_spec, from_charset) },
274 { XD_LISP_OBJECT, offsetof (charset_conversion_spec, to_charset) },
278 static const struct struct_description ccs_description = {
279 sizeof (charset_conversion_spec),
283 static const struct lrecord_description ccsd_description_1[] = {
284 XD_DYNARR_DESC (charset_conversion_spec_dynarr, &ccs_description),
288 static const struct struct_description ccsd_description = {
289 sizeof (charset_conversion_spec_dynarr),
294 static const struct lrecord_description coding_system_description[] = {
295 { XD_LISP_OBJECT, offsetof (Lisp_Coding_System, name) },
296 { XD_LISP_OBJECT, offsetof (Lisp_Coding_System, doc_string) },
297 { XD_LISP_OBJECT, offsetof (Lisp_Coding_System, mnemonic) },
298 { XD_LISP_OBJECT, offsetof (Lisp_Coding_System, post_read_conversion) },
299 { XD_LISP_OBJECT, offsetof (Lisp_Coding_System, pre_write_conversion) },
300 { XD_LISP_OBJECT, offsetof (Lisp_Coding_System, eol_lf) },
301 { XD_LISP_OBJECT, offsetof (Lisp_Coding_System, eol_crlf) },
302 { XD_LISP_OBJECT, offsetof (Lisp_Coding_System, eol_cr) },
304 { XD_LISP_OBJECT_ARRAY, offsetof (Lisp_Coding_System, iso2022.initial_charset), 4 },
305 { XD_STRUCT_PTR, offsetof (Lisp_Coding_System, iso2022.input_conv), 1, &ccsd_description },
306 { XD_STRUCT_PTR, offsetof (Lisp_Coding_System, iso2022.output_conv), 1, &ccsd_description },
307 { XD_LISP_OBJECT, offsetof (Lisp_Coding_System, ccl.decode) },
308 { XD_LISP_OBJECT, offsetof (Lisp_Coding_System, ccl.encode) },
313 DEFINE_LRECORD_IMPLEMENTATION ("coding-system", coding_system,
314 mark_coding_system, print_coding_system,
315 finalize_coding_system,
316 0, 0, coding_system_description,
320 mark_coding_system (Lisp_Object obj)
322 Lisp_Coding_System *codesys = XCODING_SYSTEM (obj);
324 mark_object (CODING_SYSTEM_NAME (codesys));
325 mark_object (CODING_SYSTEM_DOC_STRING (codesys));
326 mark_object (CODING_SYSTEM_MNEMONIC (codesys));
327 mark_object (CODING_SYSTEM_EOL_LF (codesys));
328 mark_object (CODING_SYSTEM_EOL_CRLF (codesys));
329 mark_object (CODING_SYSTEM_EOL_CR (codesys));
331 switch (CODING_SYSTEM_TYPE (codesys))
335 case CODESYS_ISO2022:
336 for (i = 0; i < 4; i++)
337 mark_object (CODING_SYSTEM_ISO2022_INITIAL_CHARSET (codesys, i));
338 if (codesys->iso2022.input_conv)
340 for (i = 0; i < Dynarr_length (codesys->iso2022.input_conv); i++)
342 struct charset_conversion_spec *ccs =
343 Dynarr_atp (codesys->iso2022.input_conv, i);
344 mark_object (ccs->from_charset);
345 mark_object (ccs->to_charset);
348 if (codesys->iso2022.output_conv)
350 for (i = 0; i < Dynarr_length (codesys->iso2022.output_conv); i++)
352 struct charset_conversion_spec *ccs =
353 Dynarr_atp (codesys->iso2022.output_conv, i);
354 mark_object (ccs->from_charset);
355 mark_object (ccs->to_charset);
361 mark_object (CODING_SYSTEM_CCL_DECODE (codesys));
362 mark_object (CODING_SYSTEM_CCL_ENCODE (codesys));
369 mark_object (CODING_SYSTEM_PRE_WRITE_CONVERSION (codesys));
370 return CODING_SYSTEM_POST_READ_CONVERSION (codesys);
374 print_coding_system (Lisp_Object obj, Lisp_Object printcharfun,
377 Lisp_Coding_System *c = XCODING_SYSTEM (obj);
379 error ("printing unreadable object #<coding_system 0x%x>",
382 write_c_string ("#<coding_system ", printcharfun);
383 print_internal (c->name, printcharfun, 1);
384 write_c_string (">", printcharfun);
388 finalize_coding_system (void *header, int for_disksave)
390 Lisp_Coding_System *c = (Lisp_Coding_System *) header;
391 /* Since coding systems never go away, this function is not
392 necessary. But it would be necessary if we changed things
393 so that coding systems could go away. */
394 if (!for_disksave) /* see comment in lstream.c */
396 switch (CODING_SYSTEM_TYPE (c))
399 case CODESYS_ISO2022:
400 if (c->iso2022.input_conv)
402 Dynarr_free (c->iso2022.input_conv);
403 c->iso2022.input_conv = 0;
405 if (c->iso2022.output_conv)
407 Dynarr_free (c->iso2022.output_conv);
408 c->iso2022.output_conv = 0;
419 symbol_to_eol_type (Lisp_Object symbol)
421 CHECK_SYMBOL (symbol);
422 if (NILP (symbol)) return EOL_AUTODETECT;
423 if (EQ (symbol, Qlf)) return EOL_LF;
424 if (EQ (symbol, Qcrlf)) return EOL_CRLF;
425 if (EQ (symbol, Qcr)) return EOL_CR;
427 signal_simple_error ("Unrecognized eol type", symbol);
428 return EOL_AUTODETECT; /* not reached */
432 eol_type_to_symbol (eol_type_t type)
437 case EOL_LF: return Qlf;
438 case EOL_CRLF: return Qcrlf;
439 case EOL_CR: return Qcr;
440 case EOL_AUTODETECT: return Qnil;
445 setup_eol_coding_systems (Lisp_Coding_System *codesys)
447 Lisp_Object codesys_obj;
448 int len = string_length (XSYMBOL (CODING_SYSTEM_NAME (codesys))->name);
449 char *codesys_name = (char *) alloca (len + 7);
451 char *codesys_mnemonic=0;
453 Lisp_Object codesys_name_sym, sub_codesys_obj;
457 XSETCODING_SYSTEM (codesys_obj, codesys);
459 memcpy (codesys_name,
460 string_data (XSYMBOL (CODING_SYSTEM_NAME (codesys))->name), len);
462 if (STRINGP (CODING_SYSTEM_MNEMONIC (codesys)))
464 mlen = XSTRING_LENGTH (CODING_SYSTEM_MNEMONIC (codesys));
465 codesys_mnemonic = (char *) alloca (mlen + 7);
466 memcpy (codesys_mnemonic,
467 XSTRING_DATA (CODING_SYSTEM_MNEMONIC (codesys)), mlen);
470 #define DEFINE_SUB_CODESYS(op_sys, op_sys_abbr, Type) do { \
471 strcpy (codesys_name + len, "-" op_sys); \
473 strcpy (codesys_mnemonic + mlen, op_sys_abbr); \
474 codesys_name_sym = intern (codesys_name); \
475 sub_codesys_obj = Fcopy_coding_system (codesys_obj, codesys_name_sym); \
476 XCODING_SYSTEM_EOL_TYPE (sub_codesys_obj) = Type; \
478 XCODING_SYSTEM_MNEMONIC(sub_codesys_obj) = \
479 build_string (codesys_mnemonic); \
480 CODING_SYSTEM_##Type (codesys) = sub_codesys_obj; \
483 DEFINE_SUB_CODESYS("unix", "", EOL_LF);
484 DEFINE_SUB_CODESYS("dos", ":T", EOL_CRLF);
485 DEFINE_SUB_CODESYS("mac", ":t", EOL_CR);
488 DEFUN ("coding-system-p", Fcoding_system_p, 1, 1, 0, /*
489 Return t if OBJECT is a coding system.
490 A coding system is an object that defines how text containing multiple
491 character sets is encoded into a stream of (typically 8-bit) bytes.
492 The coding system is used to decode the stream into a series of
493 characters (which may be from multiple charsets) when the text is read
494 from a file or process, and is used to encode the text back into the
495 same format when it is written out to a file or process.
497 For example, many ISO2022-compliant coding systems (such as Compound
498 Text, which is used for inter-client data under the X Window System)
499 use escape sequences to switch between different charsets -- Japanese
500 Kanji, for example, is invoked with "ESC $ ( B"; ASCII is invoked
501 with "ESC ( B"; and Cyrillic is invoked with "ESC - L". See
502 `make-coding-system' for more information.
504 Coding systems are normally identified using a symbol, and the
505 symbol is accepted in place of the actual coding system object whenever
506 a coding system is called for. (This is similar to how faces work.)
510 return CODING_SYSTEMP (object) ? Qt : Qnil;
513 DEFUN ("find-coding-system", Ffind_coding_system, 1, 1, 0, /*
514 Retrieve the coding system of the given name.
516 If CODING-SYSTEM-OR-NAME is a coding-system object, it is simply
517 returned. Otherwise, CODING-SYSTEM-OR-NAME should be a symbol.
518 If there is no such coding system, nil is returned. Otherwise the
519 associated coding system object is returned.
521 (coding_system_or_name))
523 if (NILP (coding_system_or_name))
524 coding_system_or_name = Qbinary;
525 else if (CODING_SYSTEMP (coding_system_or_name))
526 return coding_system_or_name;
528 CHECK_SYMBOL (coding_system_or_name);
532 coding_system_or_name =
533 Fgethash (coding_system_or_name, Vcoding_system_hash_table, Qnil);
535 if (CODING_SYSTEMP (coding_system_or_name) || NILP (coding_system_or_name))
536 return coding_system_or_name;
540 DEFUN ("get-coding-system", Fget_coding_system, 1, 1, 0, /*
541 Retrieve the coding system of the given name.
542 Same as `find-coding-system' except that if there is no such
543 coding system, an error is signaled instead of returning nil.
547 Lisp_Object coding_system = Ffind_coding_system (name);
549 if (NILP (coding_system))
550 signal_simple_error ("No such coding system", name);
551 return coding_system;
554 /* We store the coding systems in hash tables with the names as the key and the
555 actual coding system object as the value. Occasionally we need to use them
556 in a list format. These routines provide us with that. */
557 struct coding_system_list_closure
559 Lisp_Object *coding_system_list;
563 add_coding_system_to_list_mapper (Lisp_Object key, Lisp_Object value,
564 void *coding_system_list_closure)
566 /* This function can GC */
567 struct coding_system_list_closure *cscl =
568 (struct coding_system_list_closure *) coding_system_list_closure;
569 Lisp_Object *coding_system_list = cscl->coding_system_list;
571 *coding_system_list = Fcons (key, *coding_system_list);
575 DEFUN ("coding-system-list", Fcoding_system_list, 0, 0, 0, /*
576 Return a list of the names of all defined coding systems.
580 Lisp_Object coding_system_list = Qnil;
582 struct coding_system_list_closure coding_system_list_closure;
584 GCPRO1 (coding_system_list);
585 coding_system_list_closure.coding_system_list = &coding_system_list;
586 elisp_maphash (add_coding_system_to_list_mapper, Vcoding_system_hash_table,
587 &coding_system_list_closure);
590 return coding_system_list;
593 DEFUN ("coding-system-name", Fcoding_system_name, 1, 1, 0, /*
594 Return the name of the given coding system.
598 coding_system = Fget_coding_system (coding_system);
599 return XCODING_SYSTEM_NAME (coding_system);
602 static Lisp_Coding_System *
603 allocate_coding_system (enum coding_system_type type, Lisp_Object name)
605 Lisp_Coding_System *codesys =
606 alloc_lcrecord_type (Lisp_Coding_System, &lrecord_coding_system);
608 zero_lcrecord (codesys);
609 CODING_SYSTEM_PRE_WRITE_CONVERSION (codesys) = Qnil;
610 CODING_SYSTEM_POST_READ_CONVERSION (codesys) = Qnil;
611 CODING_SYSTEM_EOL_TYPE (codesys) = EOL_AUTODETECT;
612 CODING_SYSTEM_EOL_CRLF (codesys) = Qnil;
613 CODING_SYSTEM_EOL_CR (codesys) = Qnil;
614 CODING_SYSTEM_EOL_LF (codesys) = Qnil;
615 CODING_SYSTEM_TYPE (codesys) = type;
616 CODING_SYSTEM_MNEMONIC (codesys) = Qnil;
618 if (type == CODESYS_ISO2022)
621 for (i = 0; i < 4; i++)
622 CODING_SYSTEM_ISO2022_INITIAL_CHARSET (codesys, i) = Qnil;
624 else if (type == CODESYS_CCL)
626 CODING_SYSTEM_CCL_DECODE (codesys) = Qnil;
627 CODING_SYSTEM_CCL_ENCODE (codesys) = Qnil;
630 CODING_SYSTEM_NAME (codesys) = name;
636 /* Given a list of charset conversion specs as specified in a Lisp
637 program, parse it into STORE_HERE. */
640 parse_charset_conversion_specs (charset_conversion_spec_dynarr *store_here,
641 Lisp_Object spec_list)
645 EXTERNAL_LIST_LOOP (rest, spec_list)
647 Lisp_Object car = XCAR (rest);
648 Lisp_Object from, to;
649 struct charset_conversion_spec spec;
651 if (!CONSP (car) || !CONSP (XCDR (car)) || !NILP (XCDR (XCDR (car))))
652 signal_simple_error ("Invalid charset conversion spec", car);
653 from = Fget_charset (XCAR (car));
654 to = Fget_charset (XCAR (XCDR (car)));
655 if (XCHARSET_TYPE (from) != XCHARSET_TYPE (to))
656 signal_simple_error_2
657 ("Attempted conversion between different charset types",
659 spec.from_charset = from;
660 spec.to_charset = to;
662 Dynarr_add (store_here, spec);
666 /* Given a dynarr LOAD_HERE of internally-stored charset conversion
667 specs, return the equivalent as the Lisp programmer would see it.
669 If LOAD_HERE is 0, return Qnil. */
672 unparse_charset_conversion_specs (charset_conversion_spec_dynarr *load_here)
679 for (i = 0, result = Qnil; i < Dynarr_length (load_here); i++)
681 struct charset_conversion_spec *ccs = Dynarr_atp (load_here, i);
682 result = Fcons (list2 (ccs->from_charset, ccs->to_charset), result);
685 return Fnreverse (result);
690 DEFUN ("make-coding-system", Fmake_coding_system, 2, 4, 0, /*
691 Register symbol NAME as a coding system.
693 TYPE describes the conversion method used and should be one of
696 Automatic conversion. XEmacs attempts to detect the coding system
699 No conversion. Use this for binary files and such. On output,
700 graphic characters that are not in ASCII or Latin-1 will be
701 replaced by a ?. (For a no-conversion-encoded buffer, these
702 characters will only be present if you explicitly insert them.)
704 Shift-JIS (a Japanese encoding commonly used in PC operating systems).
706 ISO 10646 UCS-4 encoding.
708 ISO 10646 UTF-8 encoding.
710 Any ISO2022-compliant encoding. Among other things, this includes
711 JIS (the Japanese encoding commonly used for e-mail), EUC (the
712 standard Unix encoding for Japanese and other languages), and
713 Compound Text (the encoding used in X11). You can specify more
714 specific information about the conversion with the PROPS argument.
716 Big5 (the encoding commonly used for Taiwanese).
718 The conversion is performed using a user-written pseudo-code
719 program. CCL (Code Conversion Language) is the name of this
722 Write out or read in the raw contents of the memory representing
723 the buffer's text. This is primarily useful for debugging
724 purposes, and is only enabled when XEmacs has been compiled with
725 DEBUG_XEMACS defined (via the --debug configure option).
726 WARNING: Reading in a file using 'internal conversion can result
727 in an internal inconsistency in the memory representing a
728 buffer's text, which will produce unpredictable results and may
729 cause XEmacs to crash. Under normal circumstances you should
730 never use 'internal conversion.
732 DOC-STRING is a string describing the coding system.
734 PROPS is a property list, describing the specific nature of the
735 character set. Recognized properties are:
738 String to be displayed in the modeline when this coding system is
742 End-of-line conversion to be used. It should be one of
745 Automatically detect the end-of-line type (LF, CRLF,
746 or CR). Also generate subsidiary coding systems named
747 `NAME-unix', `NAME-dos', and `NAME-mac', that are
748 identical to this coding system but have an EOL-TYPE
749 value of 'lf, 'crlf, and 'cr, respectively.
751 The end of a line is marked externally using ASCII LF.
752 Since this is also the way that XEmacs represents an
753 end-of-line internally, specifying this option results
754 in no end-of-line conversion. This is the standard
755 format for Unix text files.
757 The end of a line is marked externally using ASCII
758 CRLF. This is the standard format for MS-DOS text
761 The end of a line is marked externally using ASCII CR.
762 This is the standard format for Macintosh text files.
764 Automatically detect the end-of-line type but do not
765 generate subsidiary coding systems. (This value is
766 converted to nil when stored internally, and
767 `coding-system-property' will return nil.)
769 'post-read-conversion
770 Function called after a file has been read in, to perform the
771 decoding. Called with two arguments, START and END, denoting
772 a region of the current buffer to be decoded.
774 'pre-write-conversion
775 Function called before a file is written out, to perform the
776 encoding. Called with two arguments, START and END, denoting
777 a region of the current buffer to be encoded.
780 The following additional properties are recognized if TYPE is 'iso2022:
786 The character set initially designated to the G0 - G3 registers.
787 The value should be one of
789 -- A charset object (designate that character set)
790 -- nil (do not ever use this register)
791 -- t (no character set is initially designated to
792 the register, but may be later on; this automatically
793 sets the corresponding `force-g*-on-output' property)
799 If non-nil, send an explicit designation sequence on output before
800 using the specified register.
803 If non-nil, use the short forms "ESC $ @", "ESC $ A", and
804 "ESC $ B" on output in place of the full designation sequences
805 "ESC $ ( @", "ESC $ ( A", and "ESC $ ( B".
808 If non-nil, don't designate ASCII to G0 at each end of line on output.
809 Setting this to non-nil also suppresses other state-resetting that
810 normally happens at the end of a line.
813 If non-nil, don't designate ASCII to G0 before control chars on output.
816 If non-nil, use 7-bit environment on output. Otherwise, use 8-bit
820 If non-nil, use locking-shift (SO/SI) instead of single-shift
821 or designation by escape sequence.
824 If non-nil, don't use ISO6429's direction specification.
827 If non-nil, literal control characters that are the same as
828 the beginning of a recognized ISO2022 or ISO6429 escape sequence
829 (in particular, ESC (0x1B), SO (0x0E), SI (0x0F), SS2 (0x8E),
830 SS3 (0x8F), and CSI (0x9B)) are "quoted" with an escape character
831 so that they can be properly distinguished from an escape sequence.
832 (Note that doing this results in a non-portable encoding.) This
833 encoding flag is used for byte-compiled files. Note that ESC
834 is a good choice for a quoting character because there are no
835 escape sequences whose second byte is a character from the Control-0
836 or Control-1 character sets; this is explicitly disallowed by the
839 'input-charset-conversion
840 A list of conversion specifications, specifying conversion of
841 characters in one charset to another when decoding is performed.
842 Each specification is a list of two elements: the source charset,
843 and the destination charset.
845 'output-charset-conversion
846 A list of conversion specifications, specifying conversion of
847 characters in one charset to another when encoding is performed.
848 The form of each specification is the same as for
849 'input-charset-conversion.
852 The following additional properties are recognized (and required)
856 CCL program used for decoding (converting to internal format).
859 CCL program used for encoding (converting to external format).
861 (name, type, doc_string, props))
863 Lisp_Coding_System *codesys;
864 enum coding_system_type ty;
865 int need_to_setup_eol_systems = 1;
867 /* Convert type to constant */
868 if (NILP (type) || EQ (type, Qundecided))
869 { ty = CODESYS_AUTODETECT; }
871 else if (EQ (type, Qshift_jis)) { ty = CODESYS_SHIFT_JIS; }
872 else if (EQ (type, Qiso2022)) { ty = CODESYS_ISO2022; }
873 else if (EQ (type, Qbig5)) { ty = CODESYS_BIG5; }
874 else if (EQ (type, Qucs4)) { ty = CODESYS_UCS4; }
875 else if (EQ (type, Qutf8)) { ty = CODESYS_UTF8; }
876 else if (EQ (type, Qccl)) { ty = CODESYS_CCL; }
878 else if (EQ (type, Qno_conversion)) { ty = CODESYS_NO_CONVERSION; }
880 else if (EQ (type, Qinternal)) { ty = CODESYS_INTERNAL; }
883 signal_simple_error ("Invalid coding system type", type);
887 codesys = allocate_coding_system (ty, name);
889 if (NILP (doc_string))
890 doc_string = build_string ("");
892 CHECK_STRING (doc_string);
893 CODING_SYSTEM_DOC_STRING (codesys) = doc_string;
896 EXTERNAL_PROPERTY_LIST_LOOP_3 (key, value, props)
898 if (EQ (key, Qmnemonic))
901 CHECK_STRING (value);
902 CODING_SYSTEM_MNEMONIC (codesys) = value;
905 else if (EQ (key, Qeol_type))
907 need_to_setup_eol_systems = NILP (value);
910 CODING_SYSTEM_EOL_TYPE (codesys) = symbol_to_eol_type (value);
913 else if (EQ (key, Qpost_read_conversion)) CODING_SYSTEM_POST_READ_CONVERSION (codesys) = value;
914 else if (EQ (key, Qpre_write_conversion)) CODING_SYSTEM_PRE_WRITE_CONVERSION (codesys) = value;
916 else if (ty == CODESYS_ISO2022)
918 #define FROB_INITIAL_CHARSET(charset_num) \
919 CODING_SYSTEM_ISO2022_INITIAL_CHARSET (codesys, charset_num) = \
920 ((EQ (value, Qt) || EQ (value, Qnil)) ? value : Fget_charset (value))
922 if (EQ (key, Qcharset_g0)) FROB_INITIAL_CHARSET (0);
923 else if (EQ (key, Qcharset_g1)) FROB_INITIAL_CHARSET (1);
924 else if (EQ (key, Qcharset_g2)) FROB_INITIAL_CHARSET (2);
925 else if (EQ (key, Qcharset_g3)) FROB_INITIAL_CHARSET (3);
927 #define FROB_FORCE_CHARSET(charset_num) \
928 CODING_SYSTEM_ISO2022_FORCE_CHARSET_ON_OUTPUT (codesys, charset_num) = !NILP (value)
930 else if (EQ (key, Qforce_g0_on_output)) FROB_FORCE_CHARSET (0);
931 else if (EQ (key, Qforce_g1_on_output)) FROB_FORCE_CHARSET (1);
932 else if (EQ (key, Qforce_g2_on_output)) FROB_FORCE_CHARSET (2);
933 else if (EQ (key, Qforce_g3_on_output)) FROB_FORCE_CHARSET (3);
935 #define FROB_BOOLEAN_PROPERTY(prop) \
936 CODING_SYSTEM_ISO2022_##prop (codesys) = !NILP (value)
938 else if (EQ (key, Qshort)) FROB_BOOLEAN_PROPERTY (SHORT);
939 else if (EQ (key, Qno_ascii_eol)) FROB_BOOLEAN_PROPERTY (NO_ASCII_EOL);
940 else if (EQ (key, Qno_ascii_cntl)) FROB_BOOLEAN_PROPERTY (NO_ASCII_CNTL);
941 else if (EQ (key, Qseven)) FROB_BOOLEAN_PROPERTY (SEVEN);
942 else if (EQ (key, Qlock_shift)) FROB_BOOLEAN_PROPERTY (LOCK_SHIFT);
943 else if (EQ (key, Qno_iso6429)) FROB_BOOLEAN_PROPERTY (NO_ISO6429);
944 else if (EQ (key, Qescape_quoted)) FROB_BOOLEAN_PROPERTY (ESCAPE_QUOTED);
946 else if (EQ (key, Qinput_charset_conversion))
948 codesys->iso2022.input_conv =
949 Dynarr_new (charset_conversion_spec);
950 parse_charset_conversion_specs (codesys->iso2022.input_conv,
953 else if (EQ (key, Qoutput_charset_conversion))
955 codesys->iso2022.output_conv =
956 Dynarr_new (charset_conversion_spec);
957 parse_charset_conversion_specs (codesys->iso2022.output_conv,
961 signal_simple_error ("Unrecognized property", key);
963 else if (EQ (type, Qccl))
966 struct ccl_program test_ccl;
969 /* Check key first. */
970 if (EQ (key, Qdecode))
971 suffix = "-ccl-decode";
972 else if (EQ (key, Qencode))
973 suffix = "-ccl-encode";
975 signal_simple_error ("Unrecognized property", key);
977 /* If value is vector, register it as a ccl program
978 associated with an newly created symbol for
979 backward compatibility. */
982 sym = Fintern (concat2 (Fsymbol_name (name),
983 build_string (suffix)),
985 Fregister_ccl_program (sym, value);
989 CHECK_SYMBOL (value);
992 /* check if the given ccl programs are valid. */
993 if (setup_ccl_program (&test_ccl, sym) < 0)
994 signal_simple_error ("Invalid CCL program", value);
996 if (EQ (key, Qdecode))
997 CODING_SYSTEM_CCL_DECODE (codesys) = sym;
998 else if (EQ (key, Qencode))
999 CODING_SYSTEM_CCL_ENCODE (codesys) = sym;
1004 signal_simple_error ("Unrecognized property", key);
1008 if (need_to_setup_eol_systems)
1009 setup_eol_coding_systems (codesys);
1012 Lisp_Object codesys_obj;
1013 XSETCODING_SYSTEM (codesys_obj, codesys);
1014 Fputhash (name, codesys_obj, Vcoding_system_hash_table);
1019 DEFUN ("copy-coding-system", Fcopy_coding_system, 2, 2, 0, /*
1020 Copy OLD-CODING-SYSTEM to NEW-NAME.
1021 If NEW-NAME does not name an existing coding system, a new one will
1024 (old_coding_system, new_name))
1026 Lisp_Object new_coding_system;
1027 old_coding_system = Fget_coding_system (old_coding_system);
1028 new_coding_system = Ffind_coding_system (new_name);
1029 if (NILP (new_coding_system))
1031 XSETCODING_SYSTEM (new_coding_system,
1032 allocate_coding_system
1033 (XCODING_SYSTEM_TYPE (old_coding_system),
1035 Fputhash (new_name, new_coding_system, Vcoding_system_hash_table);
1039 Lisp_Coding_System *to = XCODING_SYSTEM (new_coding_system);
1040 Lisp_Coding_System *from = XCODING_SYSTEM (old_coding_system);
1041 memcpy (((char *) to ) + sizeof (to->header),
1042 ((char *) from) + sizeof (from->header),
1043 sizeof (*from) - sizeof (from->header));
1044 to->name = new_name;
1046 return new_coding_system;
1049 DEFUN ("coding-system-canonical-name-p", Fcoding_system_canonical_name_p, 1, 1, 0, /*
1050 Return t if OBJECT names a coding system, and is not a coding system alias.
1054 return CODING_SYSTEMP (Fgethash (object, Vcoding_system_hash_table, Qnil))
1058 DEFUN ("coding-system-alias-p", Fcoding_system_alias_p, 1, 1, 0, /*
1059 Return t if OBJECT is a coding system alias.
1060 All coding system aliases are created by `define-coding-system-alias'.
1064 return SYMBOLP (Fgethash (object, Vcoding_system_hash_table, Qzero))
1068 DEFUN ("coding-system-aliasee", Fcoding_system_aliasee, 1, 1, 0, /*
1069 Return the coding-system symbol for which symbol ALIAS is an alias.
1073 Lisp_Object aliasee = Fgethash (alias, Vcoding_system_hash_table, Qnil);
1074 if (SYMBOLP (aliasee))
1077 signal_simple_error ("Symbol is not a coding system alias", alias);
1078 return Qnil; /* To keep the compiler happy */
1082 append_suffix_to_symbol (Lisp_Object symbol, const char *ascii_string)
1084 return Fintern (concat2 (Fsymbol_name (symbol), build_string (ascii_string)),
1088 /* A maphash function, for removing dangling coding system aliases. */
1090 dangling_coding_system_alias_p (Lisp_Object alias,
1091 Lisp_Object aliasee,
1092 void *dangling_aliases)
1094 if (SYMBOLP (aliasee)
1095 && NILP (Fgethash (aliasee, Vcoding_system_hash_table, Qnil)))
1097 (*(int *) dangling_aliases)++;
1104 DEFUN ("define-coding-system-alias", Fdefine_coding_system_alias, 2, 2, 0, /*
1105 Define symbol ALIAS as an alias for coding system ALIASEE.
1107 You can use this function to redefine an alias that has already been defined,
1108 but you cannot redefine a name which is the canonical name for a coding system.
1109 \(a canonical name of a coding system is what is returned when you call
1110 `coding-system-name' on a coding system).
1112 ALIASEE itself can be an alias, which allows you to define nested aliases.
1114 You are forbidden, however, from creating alias loops or `dangling' aliases.
1115 These will be detected, and an error will be signaled if you attempt to do so.
1117 If ALIASEE is nil, then ALIAS will simply be undefined.
1119 See also `coding-system-alias-p', `coding-system-aliasee',
1120 and `coding-system-canonical-name-p'.
1124 Lisp_Object real_coding_system, probe;
1126 CHECK_SYMBOL (alias);
1128 if (!NILP (Fcoding_system_canonical_name_p (alias)))
1130 ("Symbol is the canonical name of a coding system and cannot be redefined",
1135 Lisp_Object subsidiary_unix = append_suffix_to_symbol (alias, "-unix");
1136 Lisp_Object subsidiary_dos = append_suffix_to_symbol (alias, "-dos");
1137 Lisp_Object subsidiary_mac = append_suffix_to_symbol (alias, "-mac");
1139 Fremhash (alias, Vcoding_system_hash_table);
1141 /* Undefine subsidiary aliases,
1142 presumably created by a previous call to this function */
1143 if (! NILP (Fcoding_system_alias_p (subsidiary_unix)) &&
1144 ! NILP (Fcoding_system_alias_p (subsidiary_dos)) &&
1145 ! NILP (Fcoding_system_alias_p (subsidiary_mac)))
1147 Fdefine_coding_system_alias (subsidiary_unix, Qnil);
1148 Fdefine_coding_system_alias (subsidiary_dos, Qnil);
1149 Fdefine_coding_system_alias (subsidiary_mac, Qnil);
1152 /* Undefine dangling coding system aliases. */
1154 int dangling_aliases;
1157 dangling_aliases = 0;
1158 elisp_map_remhash (dangling_coding_system_alias_p,
1159 Vcoding_system_hash_table,
1161 } while (dangling_aliases > 0);
1167 if (CODING_SYSTEMP (aliasee))
1168 aliasee = XCODING_SYSTEM_NAME (aliasee);
1170 /* Checks that aliasee names a coding-system */
1171 real_coding_system = Fget_coding_system (aliasee);
1173 /* Check for coding system alias loops */
1174 if (EQ (alias, aliasee))
1175 alias_loop: signal_simple_error_2
1176 ("Attempt to create a coding system alias loop", alias, aliasee);
1178 for (probe = aliasee;
1180 probe = Fgethash (probe, Vcoding_system_hash_table, Qzero))
1182 if (EQ (probe, alias))
1186 Fputhash (alias, aliasee, Vcoding_system_hash_table);
1188 /* Set up aliases for subsidiaries.
1189 #### There must be a better way to handle subsidiary coding systems. */
1191 static const char *suffixes[] = { "-unix", "-dos", "-mac" };
1193 for (i = 0; i < countof (suffixes); i++)
1195 Lisp_Object alias_subsidiary =
1196 append_suffix_to_symbol (alias, suffixes[i]);
1197 Lisp_Object aliasee_subsidiary =
1198 append_suffix_to_symbol (aliasee, suffixes[i]);
1200 if (! NILP (Ffind_coding_system (aliasee_subsidiary)))
1201 Fdefine_coding_system_alias (alias_subsidiary, aliasee_subsidiary);
1204 /* FSF return value is a vector of [ALIAS-unix ALIAS-dos ALIAS-mac],
1205 but it doesn't look intentional, so I'd rather return something
1206 meaningful or nothing at all. */
1211 subsidiary_coding_system (Lisp_Object coding_system, eol_type_t type)
1213 Lisp_Coding_System *cs = XCODING_SYSTEM (coding_system);
1214 Lisp_Object new_coding_system;
1216 if (CODING_SYSTEM_EOL_TYPE (cs) != EOL_AUTODETECT)
1217 return coding_system;
1221 case EOL_AUTODETECT: return coding_system;
1222 case EOL_LF: new_coding_system = CODING_SYSTEM_EOL_LF (cs); break;
1223 case EOL_CR: new_coding_system = CODING_SYSTEM_EOL_CR (cs); break;
1224 case EOL_CRLF: new_coding_system = CODING_SYSTEM_EOL_CRLF (cs); break;
1225 default: abort (); return Qnil;
1228 return NILP (new_coding_system) ? coding_system : new_coding_system;
1231 DEFUN ("subsidiary-coding-system", Fsubsidiary_coding_system, 2, 2, 0, /*
1232 Return the subsidiary coding system of CODING-SYSTEM with eol type EOL-TYPE.
1234 (coding_system, eol_type))
1236 coding_system = Fget_coding_system (coding_system);
1238 return subsidiary_coding_system (coding_system,
1239 symbol_to_eol_type (eol_type));
1243 /************************************************************************/
1244 /* Coding system accessors */
1245 /************************************************************************/
1247 DEFUN ("coding-system-doc-string", Fcoding_system_doc_string, 1, 1, 0, /*
1248 Return the doc string for CODING-SYSTEM.
1252 coding_system = Fget_coding_system (coding_system);
1253 return XCODING_SYSTEM_DOC_STRING (coding_system);
1256 DEFUN ("coding-system-type", Fcoding_system_type, 1, 1, 0, /*
1257 Return the type of CODING-SYSTEM.
1261 switch (XCODING_SYSTEM_TYPE (Fget_coding_system (coding_system)))
1264 case CODESYS_AUTODETECT: return Qundecided;
1266 case CODESYS_SHIFT_JIS: return Qshift_jis;
1267 case CODESYS_ISO2022: return Qiso2022;
1268 case CODESYS_BIG5: return Qbig5;
1269 case CODESYS_UCS4: return Qucs4;
1270 case CODESYS_UTF8: return Qutf8;
1271 case CODESYS_CCL: return Qccl;
1273 case CODESYS_NO_CONVERSION: return Qno_conversion;
1275 case CODESYS_INTERNAL: return Qinternal;
1282 Lisp_Object coding_system_charset (Lisp_Object coding_system, int gnum)
1285 = XCODING_SYSTEM_ISO2022_INITIAL_CHARSET (coding_system, gnum);
1287 return CHARSETP (cs) ? XCHARSET_NAME (cs) : Qnil;
1290 DEFUN ("coding-system-charset", Fcoding_system_charset, 2, 2, 0, /*
1291 Return initial charset of CODING-SYSTEM designated to GNUM.
1294 (coding_system, gnum))
1296 coding_system = Fget_coding_system (coding_system);
1299 return coding_system_charset (coding_system, XINT (gnum));
1303 DEFUN ("coding-system-property", Fcoding_system_property, 2, 2, 0, /*
1304 Return the PROP property of CODING-SYSTEM.
1306 (coding_system, prop))
1309 enum coding_system_type type;
1311 coding_system = Fget_coding_system (coding_system);
1312 CHECK_SYMBOL (prop);
1313 type = XCODING_SYSTEM_TYPE (coding_system);
1315 for (i = 0; !ok && i < Dynarr_length (the_codesys_prop_dynarr); i++)
1316 if (EQ (Dynarr_at (the_codesys_prop_dynarr, i).sym, prop))
1319 switch (Dynarr_at (the_codesys_prop_dynarr, i).prop_type)
1321 case CODESYS_PROP_ALL_OK:
1324 case CODESYS_PROP_ISO2022:
1325 if (type != CODESYS_ISO2022)
1327 ("Property only valid in ISO2022 coding systems",
1331 case CODESYS_PROP_CCL:
1332 if (type != CODESYS_CCL)
1334 ("Property only valid in CCL coding systems",
1344 signal_simple_error ("Unrecognized property", prop);
1346 if (EQ (prop, Qname))
1347 return XCODING_SYSTEM_NAME (coding_system);
1348 else if (EQ (prop, Qtype))
1349 return Fcoding_system_type (coding_system);
1350 else if (EQ (prop, Qdoc_string))
1351 return XCODING_SYSTEM_DOC_STRING (coding_system);
1352 else if (EQ (prop, Qmnemonic))
1353 return XCODING_SYSTEM_MNEMONIC (coding_system);
1354 else if (EQ (prop, Qeol_type))
1355 return eol_type_to_symbol (XCODING_SYSTEM_EOL_TYPE (coding_system));
1356 else if (EQ (prop, Qeol_lf))
1357 return XCODING_SYSTEM_EOL_LF (coding_system);
1358 else if (EQ (prop, Qeol_crlf))
1359 return XCODING_SYSTEM_EOL_CRLF (coding_system);
1360 else if (EQ (prop, Qeol_cr))
1361 return XCODING_SYSTEM_EOL_CR (coding_system);
1362 else if (EQ (prop, Qpost_read_conversion))
1363 return XCODING_SYSTEM_POST_READ_CONVERSION (coding_system);
1364 else if (EQ (prop, Qpre_write_conversion))
1365 return XCODING_SYSTEM_PRE_WRITE_CONVERSION (coding_system);
1367 else if (type == CODESYS_ISO2022)
1369 if (EQ (prop, Qcharset_g0))
1370 return coding_system_charset (coding_system, 0);
1371 else if (EQ (prop, Qcharset_g1))
1372 return coding_system_charset (coding_system, 1);
1373 else if (EQ (prop, Qcharset_g2))
1374 return coding_system_charset (coding_system, 2);
1375 else if (EQ (prop, Qcharset_g3))
1376 return coding_system_charset (coding_system, 3);
1378 #define FORCE_CHARSET(charset_num) \
1379 (XCODING_SYSTEM_ISO2022_FORCE_CHARSET_ON_OUTPUT \
1380 (coding_system, charset_num) ? Qt : Qnil)
1382 else if (EQ (prop, Qforce_g0_on_output)) return FORCE_CHARSET (0);
1383 else if (EQ (prop, Qforce_g1_on_output)) return FORCE_CHARSET (1);
1384 else if (EQ (prop, Qforce_g2_on_output)) return FORCE_CHARSET (2);
1385 else if (EQ (prop, Qforce_g3_on_output)) return FORCE_CHARSET (3);
1387 #define LISP_BOOLEAN(prop) \
1388 (XCODING_SYSTEM_ISO2022_##prop (coding_system) ? Qt : Qnil)
1390 else if (EQ (prop, Qshort)) return LISP_BOOLEAN (SHORT);
1391 else if (EQ (prop, Qno_ascii_eol)) return LISP_BOOLEAN (NO_ASCII_EOL);
1392 else if (EQ (prop, Qno_ascii_cntl)) return LISP_BOOLEAN (NO_ASCII_CNTL);
1393 else if (EQ (prop, Qseven)) return LISP_BOOLEAN (SEVEN);
1394 else if (EQ (prop, Qlock_shift)) return LISP_BOOLEAN (LOCK_SHIFT);
1395 else if (EQ (prop, Qno_iso6429)) return LISP_BOOLEAN (NO_ISO6429);
1396 else if (EQ (prop, Qescape_quoted)) return LISP_BOOLEAN (ESCAPE_QUOTED);
1398 else if (EQ (prop, Qinput_charset_conversion))
1400 unparse_charset_conversion_specs
1401 (XCODING_SYSTEM (coding_system)->iso2022.input_conv);
1402 else if (EQ (prop, Qoutput_charset_conversion))
1404 unparse_charset_conversion_specs
1405 (XCODING_SYSTEM (coding_system)->iso2022.output_conv);
1409 else if (type == CODESYS_CCL)
1411 if (EQ (prop, Qdecode))
1412 return XCODING_SYSTEM_CCL_DECODE (coding_system);
1413 else if (EQ (prop, Qencode))
1414 return XCODING_SYSTEM_CCL_ENCODE (coding_system);
1422 return Qnil; /* not reached */
1426 /************************************************************************/
1427 /* Coding category functions */
1428 /************************************************************************/
1431 decode_coding_category (Lisp_Object symbol)
1435 CHECK_SYMBOL (symbol);
1436 for (i = 0; i < CODING_CATEGORY_LAST; i++)
1437 if (EQ (coding_category_symbol[i], symbol))
1440 signal_simple_error ("Unrecognized coding category", symbol);
1441 return 0; /* not reached */
1444 DEFUN ("coding-category-list", Fcoding_category_list, 0, 0, 0, /*
1445 Return a list of all recognized coding categories.
1450 Lisp_Object list = Qnil;
1452 for (i = CODING_CATEGORY_LAST - 1; i >= 0; i--)
1453 list = Fcons (coding_category_symbol[i], list);
1457 DEFUN ("set-coding-priority-list", Fset_coding_priority_list, 1, 1, 0, /*
1458 Change the priority order of the coding categories.
1459 LIST should be list of coding categories, in descending order of
1460 priority. Unspecified coding categories will be lower in priority
1461 than all specified ones, in the same relative order they were in
1466 int category_to_priority[CODING_CATEGORY_LAST];
1470 /* First generate a list that maps coding categories to priorities. */
1472 for (i = 0; i < CODING_CATEGORY_LAST; i++)
1473 category_to_priority[i] = -1;
1475 /* Highest priority comes from the specified list. */
1477 EXTERNAL_LIST_LOOP (rest, list)
1479 int cat = decode_coding_category (XCAR (rest));
1481 if (category_to_priority[cat] >= 0)
1482 signal_simple_error ("Duplicate coding category in list", XCAR (rest));
1483 category_to_priority[cat] = i++;
1486 /* Now go through the existing categories by priority to retrieve
1487 the categories not yet specified and preserve their priority
1489 for (j = 0; j < CODING_CATEGORY_LAST; j++)
1491 int cat = fcd->coding_category_by_priority[j];
1492 if (category_to_priority[cat] < 0)
1493 category_to_priority[cat] = i++;
1496 /* Now we need to construct the inverse of the mapping we just
1499 for (i = 0; i < CODING_CATEGORY_LAST; i++)
1500 fcd->coding_category_by_priority[category_to_priority[i]] = i;
1502 /* Phew! That was confusing. */
1506 DEFUN ("coding-priority-list", Fcoding_priority_list, 0, 0, 0, /*
1507 Return a list of coding categories in descending order of priority.
1512 Lisp_Object list = Qnil;
1514 for (i = CODING_CATEGORY_LAST - 1; i >= 0; i--)
1515 list = Fcons (coding_category_symbol[fcd->coding_category_by_priority[i]],
1520 DEFUN ("set-coding-category-system", Fset_coding_category_system, 2, 2, 0, /*
1521 Change the coding system associated with a coding category.
1523 (coding_category, coding_system))
1525 int cat = decode_coding_category (coding_category);
1527 coding_system = Fget_coding_system (coding_system);
1528 fcd->coding_category_system[cat] = coding_system;
1532 DEFUN ("coding-category-system", Fcoding_category_system, 1, 1, 0, /*
1533 Return the coding system associated with a coding category.
1537 int cat = decode_coding_category (coding_category);
1538 Lisp_Object sys = fcd->coding_category_system[cat];
1541 return XCODING_SYSTEM_NAME (sys);
1546 /************************************************************************/
1547 /* Detecting the encoding of data */
1548 /************************************************************************/
1550 struct detection_state
1552 eol_type_t eol_type;
1588 struct iso2022_decoder iso;
1590 int high_byte_count;
1591 unsigned int saw_single_shift:1;
1604 acceptable_control_char_p (int c)
1608 /* Allow and ignore control characters that you might
1609 reasonably see in a text file */
1614 case 8: /* backspace */
1615 case 11: /* vertical tab */
1616 case 12: /* form feed */
1617 case 26: /* MS-DOS C-z junk */
1618 case 31: /* '^_' -- for info */
1626 mask_has_at_most_one_bit_p (int mask)
1628 /* Perhaps the only thing useful you learn from intensive Microsoft
1629 technical interviews */
1630 return (mask & (mask - 1)) == 0;
1634 detect_eol_type (struct detection_state *st, const Extbyte *src,
1639 unsigned char c = *(unsigned char *)src++;
1642 if (st->eol.just_saw_cr)
1644 else if (st->eol.seen_anything)
1647 else if (st->eol.just_saw_cr)
1650 st->eol.just_saw_cr = 1;
1652 st->eol.just_saw_cr = 0;
1653 st->eol.seen_anything = 1;
1656 return EOL_AUTODETECT;
1659 /* Attempt to determine the encoding and EOL type of the given text.
1660 Before calling this function for the first type, you must initialize
1661 st->eol_type as appropriate and initialize st->mask to ~0.
1663 st->eol_type holds the determined EOL type, or EOL_AUTODETECT if
1666 st->mask holds the determined coding category mask, or ~0 if only
1667 ASCII has been seen so far.
1671 0 == st->eol_type is EOL_AUTODETECT and/or more than coding category
1672 is present in st->mask
1673 1 == definitive answers are here for both st->eol_type and st->mask
1677 detect_coding_type (struct detection_state *st, const Extbyte *src,
1678 size_t n, int just_do_eol)
1680 if (st->eol_type == EOL_AUTODETECT)
1681 st->eol_type = detect_eol_type (st, src, n);
1684 return st->eol_type != EOL_AUTODETECT;
1686 if (!st->seen_non_ascii)
1688 for (; n; n--, src++)
1690 unsigned char c = *(unsigned char *) src;
1691 if ((c < 0x20 && !acceptable_control_char_p (c)) || c >= 0x80)
1693 st->seen_non_ascii = 1;
1695 st->shift_jis.mask = ~0;
1699 st->iso2022.mask = ~0;
1709 if (!mask_has_at_most_one_bit_p (st->iso2022.mask))
1710 st->iso2022.mask = detect_coding_iso2022 (st, src, n);
1711 if (!mask_has_at_most_one_bit_p (st->shift_jis.mask))
1712 st->shift_jis.mask = detect_coding_sjis (st, src, n);
1713 if (!mask_has_at_most_one_bit_p (st->big5.mask))
1714 st->big5.mask = detect_coding_big5 (st, src, n);
1715 if (!mask_has_at_most_one_bit_p (st->utf8.mask))
1716 st->utf8.mask = detect_coding_utf8 (st, src, n);
1717 if (!mask_has_at_most_one_bit_p (st->ucs4.mask))
1718 st->ucs4.mask = detect_coding_ucs4 (st, src, n);
1721 = st->iso2022.mask | st->shift_jis.mask | st->big5.mask
1722 | st->utf8.mask | st->ucs4.mask;
1725 int retval = mask_has_at_most_one_bit_p (st->mask);
1726 st->mask |= CODING_CATEGORY_NO_CONVERSION_MASK;
1727 return retval && st->eol_type != EOL_AUTODETECT;
1732 coding_system_from_mask (int mask)
1736 /* If the file was entirely or basically ASCII, use the
1737 default value of `buffer-file-coding-system'. */
1738 Lisp_Object retval =
1739 XBUFFER (Vbuffer_defaults)->buffer_file_coding_system;
1742 retval = Ffind_coding_system (retval);
1746 (Qbad_variable, Qwarning,
1747 "Invalid `default-buffer-file-coding-system', set to nil");
1748 XBUFFER (Vbuffer_defaults)->buffer_file_coding_system = Qnil;
1752 retval = Fget_coding_system (Qraw_text);
1760 mask = postprocess_iso2022_mask (mask);
1762 /* Look through the coding categories by priority and find
1763 the first one that is allowed. */
1764 for (i = 0; i < CODING_CATEGORY_LAST; i++)
1766 cat = fcd->coding_category_by_priority[i];
1767 if ((mask & (1 << cat)) &&
1768 !NILP (fcd->coding_category_system[cat]))
1772 return fcd->coding_category_system[cat];
1774 return Fget_coding_system (Qraw_text);
1778 /* Given a seekable read stream and potential coding system and EOL type
1779 as specified, do any autodetection that is called for. If the
1780 coding system and/or EOL type are not `autodetect', they will be left
1781 alone; but this function will never return an autodetect coding system
1784 This function does not automatically fetch subsidiary coding systems;
1785 that should be unnecessary with the explicit eol-type argument. */
1787 #define LENGTH(string_constant) (sizeof (string_constant) - 1)
1790 determine_real_coding_system (Lstream *stream, Lisp_Object *codesys_in_out,
1791 eol_type_t *eol_type_in_out)
1793 struct detection_state decst;
1795 if (*eol_type_in_out == EOL_AUTODETECT)
1796 *eol_type_in_out = XCODING_SYSTEM_EOL_TYPE (*codesys_in_out);
1799 decst.eol_type = *eol_type_in_out;
1802 /* If autodetection is called for, do it now. */
1803 if (XCODING_SYSTEM_TYPE (*codesys_in_out) == CODESYS_AUTODETECT
1804 || *eol_type_in_out == EOL_AUTODETECT)
1807 Lisp_Object coding_system = Qnil;
1809 ssize_t nread = Lstream_read (stream, buf, sizeof (buf));
1812 /* Look for initial "-*-"; mode line prefix */
1814 scan_end = buf + nread - LENGTH ("-*-coding:?-*-");
1819 if (*p == '-' && *(p+1) == '*' && *(p+2) == '-')
1821 Extbyte *local_vars_beg = p + 3;
1822 /* Look for final "-*-"; mode line suffix */
1823 for (p = local_vars_beg,
1824 scan_end = buf + nread - LENGTH ("-*-");
1829 if (*p == '-' && *(p+1) == '*' && *(p+2) == '-')
1831 Extbyte *suffix = p;
1832 /* Look for "coding:" */
1833 for (p = local_vars_beg,
1834 scan_end = suffix - LENGTH ("coding:?");
1837 if (memcmp ("coding:", p, LENGTH ("coding:")) == 0
1838 && (p == local_vars_beg
1839 || (*(p-1) == ' ' ||
1845 p += LENGTH ("coding:");
1846 while (*p == ' ' || *p == '\t') p++;
1848 /* Get coding system name */
1849 save = *suffix; *suffix = '\0';
1850 /* Characters valid in a MIME charset name (rfc 1521),
1851 and in a Lisp symbol name. */
1852 n = strspn ( (char *) p,
1853 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
1854 "abcdefghijklmnopqrstuvwxyz"
1860 save = p[n]; p[n] = '\0';
1862 Ffind_coding_system (intern ((char *) p));
1872 if (NILP (coding_system))
1875 if (detect_coding_type (&decst, buf, nread,
1876 XCODING_SYSTEM_TYPE (*codesys_in_out)
1877 != CODESYS_AUTODETECT))
1879 nread = Lstream_read (stream, buf, sizeof (buf));
1885 else if (XCODING_SYSTEM_TYPE (*codesys_in_out) == CODESYS_AUTODETECT
1886 && XCODING_SYSTEM_EOL_TYPE (coding_system) == EOL_AUTODETECT)
1889 if (detect_coding_type (&decst, buf, nread, 1))
1891 nread = Lstream_read (stream, buf, sizeof (buf));
1897 *eol_type_in_out = decst.eol_type;
1898 if (XCODING_SYSTEM_TYPE (*codesys_in_out) == CODESYS_AUTODETECT)
1900 if (NILP (coding_system))
1901 *codesys_in_out = coding_system_from_mask (decst.mask);
1903 *codesys_in_out = coding_system;
1907 /* If we absolutely can't determine the EOL type, just assume LF. */
1908 if (*eol_type_in_out == EOL_AUTODETECT)
1909 *eol_type_in_out = EOL_LF;
1911 Lstream_rewind (stream);
1914 DEFUN ("detect-coding-region", Fdetect_coding_region, 2, 3, 0, /*
1915 Detect coding system of the text in the region between START and END.
1916 Return a list of possible coding systems ordered by priority.
1917 If only ASCII characters are found, return 'undecided or one of
1918 its subsidiary coding systems according to a detected end-of-line
1919 type. Optional arg BUFFER defaults to the current buffer.
1921 (start, end, buffer))
1923 Lisp_Object val = Qnil;
1924 struct buffer *buf = decode_buffer (buffer, 0);
1926 Lisp_Object instream, lb_instream;
1927 Lstream *istr, *lb_istr;
1928 struct detection_state decst;
1929 struct gcpro gcpro1, gcpro2;
1931 get_buffer_range_char (buf, start, end, &b, &e, 0);
1932 lb_instream = make_lisp_buffer_input_stream (buf, b, e, 0);
1933 lb_istr = XLSTREAM (lb_instream);
1934 instream = make_encoding_input_stream (lb_istr, Fget_coding_system (Qbinary));
1935 istr = XLSTREAM (instream);
1936 GCPRO2 (instream, lb_instream);
1938 decst.eol_type = EOL_AUTODETECT;
1942 Extbyte random_buffer[4096];
1943 ssize_t nread = Lstream_read (istr, random_buffer, sizeof (random_buffer));
1947 if (detect_coding_type (&decst, random_buffer, nread, 0))
1951 if (decst.mask == ~0)
1952 val = subsidiary_coding_system (Fget_coding_system (Qundecided),
1960 decst.mask = postprocess_iso2022_mask (decst.mask);
1962 for (i = CODING_CATEGORY_LAST - 1; i >= 0; i--)
1964 int sys = fcd->coding_category_by_priority[i];
1965 if (decst.mask & (1 << sys))
1967 Lisp_Object codesys = fcd->coding_category_system[sys];
1968 if (!NILP (codesys))
1969 codesys = subsidiary_coding_system (codesys, decst.eol_type);
1970 val = Fcons (codesys, val);
1974 Lstream_close (istr);
1976 Lstream_delete (istr);
1977 Lstream_delete (lb_istr);
1982 /************************************************************************/
1983 /* Converting to internal Mule format ("decoding") */
1984 /************************************************************************/
1986 /* A decoding stream is a stream used for decoding text (i.e.
1987 converting from some external format to internal format).
1988 The decoding-stream object keeps track of the actual coding
1989 stream, the stream that is at the other end, and data that
1990 needs to be persistent across the lifetime of the stream. */
1992 /* Handle the EOL stuff related to just-read-in character C.
1993 EOL_TYPE is the EOL type of the coding stream.
1994 FLAGS is the current value of FLAGS in the coding stream, and may
1995 be modified by this macro. (The macro only looks at the
1996 CODING_STATE_CR flag.) DST is the Dynarr to which the decoded
1997 bytes are to be written. You need to also define a local goto
1998 label "label_continue_loop" that is at the end of the main
1999 character-reading loop.
2001 If C is a CR character, then this macro handles it entirely and
2002 jumps to label_continue_loop. Otherwise, this macro does not add
2003 anything to DST, and continues normally. You should continue
2004 processing C normally after this macro. */
2006 #define DECODE_HANDLE_EOL_TYPE(eol_type, c, flags, dst) \
2010 if (eol_type == EOL_CR) \
2011 Dynarr_add (dst, '\n'); \
2012 else if (eol_type != EOL_CRLF || flags & CODING_STATE_CR) \
2013 Dynarr_add (dst, c); \
2015 flags |= CODING_STATE_CR; \
2016 goto label_continue_loop; \
2018 else if (flags & CODING_STATE_CR) \
2019 { /* eol_type == CODING_SYSTEM_EOL_CRLF */ \
2021 Dynarr_add (dst, '\r'); \
2022 flags &= ~CODING_STATE_CR; \
2026 /* C should be a binary character in the range 0 - 255; convert
2027 to internal format and add to Dynarr DST. */
2029 #define DECODE_ADD_BINARY_CHAR(c, dst) \
2031 if (BYTE_ASCII_P (c)) \
2032 Dynarr_add (dst, c); \
2033 else if (BYTE_C1_P (c)) \
2035 Dynarr_add (dst, LEADING_BYTE_CONTROL_1); \
2036 Dynarr_add (dst, c + 0x20); \
2040 Dynarr_add (dst, LEADING_BYTE_LATIN_ISO8859_1); \
2041 Dynarr_add (dst, c); \
2045 #define DECODE_OUTPUT_PARTIAL_CHAR(ch) \
2049 DECODE_ADD_BINARY_CHAR (ch, dst); \
2054 #define DECODE_HANDLE_END_OF_CONVERSION(flags, ch, dst) \
2056 if (flags & CODING_STATE_END) \
2058 DECODE_OUTPUT_PARTIAL_CHAR (ch); \
2059 if (flags & CODING_STATE_CR) \
2060 Dynarr_add (dst, '\r'); \
2064 #define DECODING_STREAM_DATA(stream) LSTREAM_TYPE_DATA (stream, decoding)
2066 struct decoding_stream
2068 /* Coding system that governs the conversion. */
2069 Lisp_Coding_System *codesys;
2071 /* Stream that we read the encoded data from or
2072 write the decoded data to. */
2075 /* If we are reading, then we can return only a fixed amount of
2076 data, so if the conversion resulted in too much data, we store it
2077 here for retrieval the next time around. */
2078 unsigned_char_dynarr *runoff;
2080 /* FLAGS holds flags indicating the current state of the decoding.
2081 Some of these flags are dependent on the coding system. */
2084 /* CH holds a partially built-up character. Since we only deal
2085 with one- and two-byte characters at the moment, we only use
2086 this to store the first byte of a two-byte character. */
2089 /* EOL_TYPE specifies the type of end-of-line conversion that
2090 currently applies. We need to keep this separate from the
2091 EOL type stored in CODESYS because the latter might indicate
2092 automatic EOL-type detection while the former will always
2093 indicate a particular EOL type. */
2094 eol_type_t eol_type;
2096 /* Additional ISO2022 information. We define the structure above
2097 because it's also needed by the detection routines. */
2098 struct iso2022_decoder iso2022;
2100 /* Additional information (the state of the running CCL program)
2101 used by the CCL decoder. */
2102 struct ccl_program ccl;
2104 /* counter for UTF-8 or UCS-4 */
2105 unsigned char counter;
2107 struct detection_state decst;
2110 static ssize_t decoding_reader (Lstream *stream,
2111 unsigned char *data, size_t size);
2112 static ssize_t decoding_writer (Lstream *stream,
2113 const unsigned char *data, size_t size);
2114 static int decoding_rewinder (Lstream *stream);
2115 static int decoding_seekable_p (Lstream *stream);
2116 static int decoding_flusher (Lstream *stream);
2117 static int decoding_closer (Lstream *stream);
2119 static Lisp_Object decoding_marker (Lisp_Object stream);
2121 DEFINE_LSTREAM_IMPLEMENTATION ("decoding", lstream_decoding,
2122 sizeof (struct decoding_stream));
2125 decoding_marker (Lisp_Object stream)
2127 Lstream *str = DECODING_STREAM_DATA (XLSTREAM (stream))->other_end;
2128 Lisp_Object str_obj;
2130 /* We do not need to mark the coding systems or charsets stored
2131 within the stream because they are stored in a global list
2132 and automatically marked. */
2134 XSETLSTREAM (str_obj, str);
2135 mark_object (str_obj);
2136 if (str->imp->marker)
2137 return (str->imp->marker) (str_obj);
2142 /* Read SIZE bytes of data and store it into DATA. We are a decoding stream
2143 so we read data from the other end, decode it, and store it into DATA. */
2146 decoding_reader (Lstream *stream, unsigned char *data, size_t size)
2148 struct decoding_stream *str = DECODING_STREAM_DATA (stream);
2149 unsigned char *orig_data = data;
2151 int error_occurred = 0;
2153 /* We need to interface to mule_decode(), which expects to take some
2154 amount of data and store the result into a Dynarr. We have
2155 mule_decode() store into str->runoff, and take data from there
2158 /* We loop until we have enough data, reading chunks from the other
2159 end and decoding it. */
2162 /* Take data from the runoff if we can. Make sure to take at
2163 most SIZE bytes, and delete the data from the runoff. */
2164 if (Dynarr_length (str->runoff) > 0)
2166 size_t chunk = min (size, (size_t) Dynarr_length (str->runoff));
2167 memcpy (data, Dynarr_atp (str->runoff, 0), chunk);
2168 Dynarr_delete_many (str->runoff, 0, chunk);
2174 break; /* No more room for data */
2176 if (str->flags & CODING_STATE_END)
2177 /* This means that on the previous iteration, we hit the EOF on
2178 the other end. We loop once more so that mule_decode() can
2179 output any final stuff it may be holding, or any "go back
2180 to a sane state" escape sequences. (This latter makes sense
2181 during encoding.) */
2184 /* Exhausted the runoff, so get some more. DATA has at least
2185 SIZE bytes left of storage in it, so it's OK to read directly
2186 into it. (We'll be overwriting above, after we've decoded it
2187 into the runoff.) */
2188 read_size = Lstream_read (str->other_end, data, size);
2195 /* There might be some more end data produced in the translation.
2196 See the comment above. */
2197 str->flags |= CODING_STATE_END;
2198 mule_decode (stream, (Extbyte *) data, str->runoff, read_size);
2201 if (data - orig_data == 0)
2202 return error_occurred ? -1 : 0;
2204 return data - orig_data;
2208 decoding_writer (Lstream *stream, const unsigned char *data, size_t size)
2210 struct decoding_stream *str = DECODING_STREAM_DATA (stream);
2213 /* Decode all our data into the runoff, and then attempt to write
2214 it all out to the other end. Remove whatever chunk we succeeded
2216 mule_decode (stream, (Extbyte *) data, str->runoff, size);
2217 retval = Lstream_write (str->other_end, Dynarr_atp (str->runoff, 0),
2218 Dynarr_length (str->runoff));
2220 Dynarr_delete_many (str->runoff, 0, retval);
2221 /* Do NOT return retval. The return value indicates how much
2222 of the incoming data was written, not how many bytes were
2228 reset_decoding_stream (struct decoding_stream *str)
2231 if (CODING_SYSTEM_TYPE (str->codesys) == CODESYS_ISO2022)
2233 Lisp_Object coding_system;
2234 XSETCODING_SYSTEM (coding_system, str->codesys);
2235 reset_iso2022 (coding_system, &str->iso2022);
2237 else if (CODING_SYSTEM_TYPE (str->codesys) == CODESYS_CCL)
2239 setup_ccl_program (&str->ccl, CODING_SYSTEM_CCL_DECODE (str->codesys));
2243 if (CODING_SYSTEM_TYPE (str->codesys) == CODESYS_AUTODETECT
2244 || CODING_SYSTEM_EOL_TYPE (str->codesys) == EOL_AUTODETECT)
2247 str->decst.eol_type = EOL_AUTODETECT;
2248 str->decst.mask = ~0;
2250 str->flags = str->ch = 0;
2254 decoding_rewinder (Lstream *stream)
2256 struct decoding_stream *str = DECODING_STREAM_DATA (stream);
2257 reset_decoding_stream (str);
2258 Dynarr_reset (str->runoff);
2259 return Lstream_rewind (str->other_end);
2263 decoding_seekable_p (Lstream *stream)
2265 struct decoding_stream *str = DECODING_STREAM_DATA (stream);
2266 return Lstream_seekable_p (str->other_end);
2270 decoding_flusher (Lstream *stream)
2272 struct decoding_stream *str = DECODING_STREAM_DATA (stream);
2273 return Lstream_flush (str->other_end);
2277 decoding_closer (Lstream *stream)
2279 struct decoding_stream *str = DECODING_STREAM_DATA (stream);
2280 if (stream->flags & LSTREAM_FL_WRITE)
2282 str->flags |= CODING_STATE_END;
2283 decoding_writer (stream, 0, 0);
2285 Dynarr_free (str->runoff);
2287 #ifdef ENABLE_COMPOSITE_CHARS
2288 if (str->iso2022.composite_chars)
2289 Dynarr_free (str->iso2022.composite_chars);
2292 return Lstream_close (str->other_end);
2296 decoding_stream_coding_system (Lstream *stream)
2298 Lisp_Object coding_system;
2299 struct decoding_stream *str = DECODING_STREAM_DATA (stream);
2301 XSETCODING_SYSTEM (coding_system, str->codesys);
2302 return subsidiary_coding_system (coding_system, str->eol_type);
2306 set_decoding_stream_coding_system (Lstream *lstr, Lisp_Object codesys)
2308 Lisp_Coding_System *cs = XCODING_SYSTEM (codesys);
2309 struct decoding_stream *str = DECODING_STREAM_DATA (lstr);
2311 if (CODING_SYSTEM_EOL_TYPE (cs) != EOL_AUTODETECT)
2312 str->eol_type = CODING_SYSTEM_EOL_TYPE (cs);
2313 reset_decoding_stream (str);
2316 /* WARNING WARNING WARNING WARNING!!!!! If you open up a decoding
2317 stream for writing, no automatic code detection will be performed.
2318 The reason for this is that automatic code detection requires a
2319 seekable input. Things will also fail if you open a decoding
2320 stream for reading using a non-fully-specified coding system and
2321 a non-seekable input stream. */
2324 make_decoding_stream_1 (Lstream *stream, Lisp_Object codesys,
2327 Lstream *lstr = Lstream_new (lstream_decoding, mode);
2328 struct decoding_stream *str = DECODING_STREAM_DATA (lstr);
2332 str->other_end = stream;
2333 str->runoff = (unsigned_char_dynarr *) Dynarr_new (unsigned_char);
2334 str->eol_type = EOL_AUTODETECT;
2335 if (!strcmp (mode, "r")
2336 && Lstream_seekable_p (stream))
2337 /* We can determine the coding system now. */
2338 determine_real_coding_system (stream, &codesys, &str->eol_type);
2339 set_decoding_stream_coding_system (lstr, codesys);
2340 str->decst.eol_type = str->eol_type;
2341 str->decst.mask = ~0;
2342 XSETLSTREAM (obj, lstr);
2347 make_decoding_input_stream (Lstream *stream, Lisp_Object codesys)
2349 return make_decoding_stream_1 (stream, codesys, "r");
2353 make_decoding_output_stream (Lstream *stream, Lisp_Object codesys)
2355 return make_decoding_stream_1 (stream, codesys, "w");
2358 /* Note: the decode_coding_* functions all take the same
2359 arguments as mule_decode(), which is to say some SRC data of
2360 size N, which is to be stored into dynamic array DST.
2361 DECODING is the stream within which the decoding is
2362 taking place, but no data is actually read from or
2363 written to that stream; that is handled in decoding_reader()
2364 or decoding_writer(). This allows the same functions to
2365 be used for both reading and writing. */
2368 mule_decode (Lstream *decoding, const Extbyte *src,
2369 unsigned_char_dynarr *dst, size_t n)
2371 struct decoding_stream *str = DECODING_STREAM_DATA (decoding);
2373 /* If necessary, do encoding-detection now. We do this when
2374 we're a writing stream or a non-seekable reading stream,
2375 meaning that we can't just process the whole input,
2376 rewind, and start over. */
2378 if (CODING_SYSTEM_TYPE (str->codesys) == CODESYS_AUTODETECT ||
2379 str->eol_type == EOL_AUTODETECT)
2381 Lisp_Object codesys;
2383 XSETCODING_SYSTEM (codesys, str->codesys);
2384 detect_coding_type (&str->decst, src, n,
2385 CODING_SYSTEM_TYPE (str->codesys) !=
2386 CODESYS_AUTODETECT);
2387 if (CODING_SYSTEM_TYPE (str->codesys) == CODESYS_AUTODETECT &&
2388 str->decst.mask != ~0)
2389 /* #### This is cheesy. What we really ought to do is
2390 buffer up a certain amount of data so as to get a
2391 less random result. */
2392 codesys = coding_system_from_mask (str->decst.mask);
2393 str->eol_type = str->decst.eol_type;
2394 if (XCODING_SYSTEM (codesys) != str->codesys)
2396 /* Preserve the CODING_STATE_END flag in case it was set.
2397 If we erase it, bad things might happen. */
2398 int was_end = str->flags & CODING_STATE_END;
2399 set_decoding_stream_coding_system (decoding, codesys);
2401 str->flags |= CODING_STATE_END;
2405 switch (CODING_SYSTEM_TYPE (str->codesys))
2408 case CODESYS_INTERNAL:
2409 Dynarr_add_many (dst, src, n);
2412 case CODESYS_AUTODETECT:
2413 /* If we got this far and still haven't decided on the coding
2414 system, then do no conversion. */
2415 case CODESYS_NO_CONVERSION:
2416 decode_coding_no_conversion (decoding, src, dst, n);
2419 case CODESYS_SHIFT_JIS:
2420 decode_coding_sjis (decoding, src, dst, n);
2423 decode_coding_big5 (decoding, src, dst, n);
2426 decode_coding_ucs4 (decoding, src, dst, n);
2429 decode_coding_utf8 (decoding, src, dst, n);
2432 str->ccl.last_block = str->flags & CODING_STATE_END;
2433 /* When applying ccl program to stream, MUST NOT set NULL
2435 ccl_driver (&str->ccl, (src ? (unsigned char *)src : (unsigned char*)""),
2436 dst, n, 0, CCL_MODE_DECODING);
2438 case CODESYS_ISO2022:
2439 decode_coding_iso2022 (decoding, src, dst, n);
2447 DEFUN ("decode-coding-region", Fdecode_coding_region, 3, 4, 0, /*
2448 Decode the text between START and END which is encoded in CODING-SYSTEM.
2449 This is useful if you've read in encoded text from a file without decoding
2450 it (e.g. you read in a JIS-formatted file but used the `binary' or
2451 `no-conversion' coding system, so that it shows up as "^[$B!<!+^[(B").
2452 Return length of decoded text.
2453 BUFFER defaults to the current buffer if unspecified.
2455 (start, end, coding_system, buffer))
2458 struct buffer *buf = decode_buffer (buffer, 0);
2459 Lisp_Object instream, lb_outstream, de_outstream, outstream;
2460 Lstream *istr, *ostr;
2461 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2463 get_buffer_range_char (buf, start, end, &b, &e, 0);
2465 barf_if_buffer_read_only (buf, b, e);
2467 coding_system = Fget_coding_system (coding_system);
2468 instream = make_lisp_buffer_input_stream (buf, b, e, 0);
2469 lb_outstream = make_lisp_buffer_output_stream (buf, b, 0);
2470 de_outstream = make_decoding_output_stream (XLSTREAM (lb_outstream),
2472 outstream = make_encoding_output_stream (XLSTREAM (de_outstream),
2473 Fget_coding_system (Qbinary));
2474 istr = XLSTREAM (instream);
2475 ostr = XLSTREAM (outstream);
2476 GCPRO4 (instream, lb_outstream, de_outstream, outstream);
2478 /* The chain of streams looks like this:
2480 [BUFFER] <----- send through
2481 ------> [ENCODE AS BINARY]
2482 ------> [DECODE AS SPECIFIED]
2488 char tempbuf[1024]; /* some random amount */
2489 Bufpos newpos, even_newer_pos;
2490 Bufpos oldpos = lisp_buffer_stream_startpos (istr);
2491 ssize_t size_in_bytes = Lstream_read (istr, tempbuf, sizeof (tempbuf));
2495 newpos = lisp_buffer_stream_startpos (istr);
2496 Lstream_write (ostr, tempbuf, size_in_bytes);
2497 even_newer_pos = lisp_buffer_stream_startpos (istr);
2498 buffer_delete_range (buf, even_newer_pos - (newpos - oldpos),
2501 Lstream_close (istr);
2502 Lstream_close (ostr);
2504 Lstream_delete (istr);
2505 Lstream_delete (ostr);
2506 Lstream_delete (XLSTREAM (de_outstream));
2507 Lstream_delete (XLSTREAM (lb_outstream));
2512 /************************************************************************/
2513 /* Converting to an external encoding ("encoding") */
2514 /************************************************************************/
2516 /* An encoding stream is an output stream. When you create the
2517 stream, you specify the coding system that governs the encoding
2518 and another stream that the resulting encoded data is to be
2519 sent to, and then start sending data to it. */
2521 #define ENCODING_STREAM_DATA(stream) LSTREAM_TYPE_DATA (stream, encoding)
2523 struct encoding_stream
2525 /* Coding system that governs the conversion. */
2526 Lisp_Coding_System *codesys;
2528 /* Stream that we read the encoded data from or
2529 write the decoded data to. */
2532 /* If we are reading, then we can return only a fixed amount of
2533 data, so if the conversion resulted in too much data, we store it
2534 here for retrieval the next time around. */
2535 unsigned_char_dynarr *runoff;
2537 /* FLAGS holds flags indicating the current state of the encoding.
2538 Some of these flags are dependent on the coding system. */
2541 /* CH holds a partially built-up character. Since we only deal
2542 with one- and two-byte characters at the moment, we only use
2543 this to store the first byte of a two-byte character. */
2546 /* Additional information used by the ISO2022 encoder. */
2549 /* CHARSET holds the character sets currently assigned to the G0
2550 through G3 registers. It is initialized from the array
2551 INITIAL_CHARSET in CODESYS. */
2552 Lisp_Object charset[4];
2554 /* Which registers are currently invoked into the left (GL) and
2555 right (GR) halves of the 8-bit encoding space? */
2556 int register_left, register_right;
2558 /* Whether we need to explicitly designate the charset in the
2559 G? register before using it. It is initialized from the
2560 array FORCE_CHARSET_ON_OUTPUT in CODESYS. */
2561 unsigned char force_charset_on_output[4];
2563 /* Other state variables that need to be preserved across
2565 Lisp_Object current_charset;
2567 int current_char_boundary;
2570 /* Additional information (the state of the running CCL program)
2571 used by the CCL encoder. */
2572 struct ccl_program ccl;
2576 static ssize_t encoding_reader (Lstream *stream, unsigned char *data, size_t size);
2577 static ssize_t encoding_writer (Lstream *stream, const unsigned char *data,
2579 static int encoding_rewinder (Lstream *stream);
2580 static int encoding_seekable_p (Lstream *stream);
2581 static int encoding_flusher (Lstream *stream);
2582 static int encoding_closer (Lstream *stream);
2584 static Lisp_Object encoding_marker (Lisp_Object stream);
2586 DEFINE_LSTREAM_IMPLEMENTATION ("encoding", lstream_encoding,
2587 sizeof (struct encoding_stream));
2590 encoding_marker (Lisp_Object stream)
2592 Lstream *str = ENCODING_STREAM_DATA (XLSTREAM (stream))->other_end;
2593 Lisp_Object str_obj;
2595 /* We do not need to mark the coding systems or charsets stored
2596 within the stream because they are stored in a global list
2597 and automatically marked. */
2599 XSETLSTREAM (str_obj, str);
2600 mark_object (str_obj);
2601 if (str->imp->marker)
2602 return (str->imp->marker) (str_obj);
2607 /* Read SIZE bytes of data and store it into DATA. We are a encoding stream
2608 so we read data from the other end, encode it, and store it into DATA. */
2611 encoding_reader (Lstream *stream, unsigned char *data, size_t size)
2613 struct encoding_stream *str = ENCODING_STREAM_DATA (stream);
2614 unsigned char *orig_data = data;
2616 int error_occurred = 0;
2618 /* We need to interface to mule_encode(), which expects to take some
2619 amount of data and store the result into a Dynarr. We have
2620 mule_encode() store into str->runoff, and take data from there
2623 /* We loop until we have enough data, reading chunks from the other
2624 end and encoding it. */
2627 /* Take data from the runoff if we can. Make sure to take at
2628 most SIZE bytes, and delete the data from the runoff. */
2629 if (Dynarr_length (str->runoff) > 0)
2631 int chunk = min ((int) size, Dynarr_length (str->runoff));
2632 memcpy (data, Dynarr_atp (str->runoff, 0), chunk);
2633 Dynarr_delete_many (str->runoff, 0, chunk);
2639 break; /* No more room for data */
2641 if (str->flags & CODING_STATE_END)
2642 /* This means that on the previous iteration, we hit the EOF on
2643 the other end. We loop once more so that mule_encode() can
2644 output any final stuff it may be holding, or any "go back
2645 to a sane state" escape sequences. (This latter makes sense
2646 during encoding.) */
2649 /* Exhausted the runoff, so get some more. DATA at least SIZE bytes
2650 left of storage in it, so it's OK to read directly into it.
2651 (We'll be overwriting above, after we've encoded it into the
2653 read_size = Lstream_read (str->other_end, data, size);
2660 /* There might be some more end data produced in the translation.
2661 See the comment above. */
2662 str->flags |= CODING_STATE_END;
2663 mule_encode (stream, data, str->runoff, read_size);
2666 if (data == orig_data)
2667 return error_occurred ? -1 : 0;
2669 return data - orig_data;
2673 encoding_writer (Lstream *stream, const unsigned char *data, size_t size)
2675 struct encoding_stream *str = ENCODING_STREAM_DATA (stream);
2678 /* Encode all our data into the runoff, and then attempt to write
2679 it all out to the other end. Remove whatever chunk we succeeded
2681 mule_encode (stream, data, str->runoff, size);
2682 retval = Lstream_write (str->other_end, Dynarr_atp (str->runoff, 0),
2683 Dynarr_length (str->runoff));
2685 Dynarr_delete_many (str->runoff, 0, retval);
2686 /* Do NOT return retval. The return value indicates how much
2687 of the incoming data was written, not how many bytes were
2693 reset_encoding_stream (struct encoding_stream *str)
2696 switch (CODING_SYSTEM_TYPE (str->codesys))
2698 case CODESYS_ISO2022:
2702 for (i = 0; i < 4; i++)
2704 str->iso2022.charset[i] =
2705 CODING_SYSTEM_ISO2022_INITIAL_CHARSET (str->codesys, i);
2706 str->iso2022.force_charset_on_output[i] =
2707 CODING_SYSTEM_ISO2022_FORCE_CHARSET_ON_OUTPUT (str->codesys, i);
2709 str->iso2022.register_left = 0;
2710 str->iso2022.register_right = 1;
2711 str->iso2022.current_charset = Qnil;
2712 str->iso2022.current_half = 0;
2713 str->iso2022.current_char_boundary = 1;
2717 setup_ccl_program (&str->ccl, CODING_SYSTEM_CCL_ENCODE (str->codesys));
2724 str->flags = str->ch = 0;
2728 encoding_rewinder (Lstream *stream)
2730 struct encoding_stream *str = ENCODING_STREAM_DATA (stream);
2731 reset_encoding_stream (str);
2732 Dynarr_reset (str->runoff);
2733 return Lstream_rewind (str->other_end);
2737 encoding_seekable_p (Lstream *stream)
2739 struct encoding_stream *str = ENCODING_STREAM_DATA (stream);
2740 return Lstream_seekable_p (str->other_end);
2744 encoding_flusher (Lstream *stream)
2746 struct encoding_stream *str = ENCODING_STREAM_DATA (stream);
2747 return Lstream_flush (str->other_end);
2751 encoding_closer (Lstream *stream)
2753 struct encoding_stream *str = ENCODING_STREAM_DATA (stream);
2754 if (stream->flags & LSTREAM_FL_WRITE)
2756 str->flags |= CODING_STATE_END;
2757 encoding_writer (stream, 0, 0);
2759 Dynarr_free (str->runoff);
2760 return Lstream_close (str->other_end);
2764 encoding_stream_coding_system (Lstream *stream)
2766 Lisp_Object coding_system;
2767 struct encoding_stream *str = ENCODING_STREAM_DATA (stream);
2769 XSETCODING_SYSTEM (coding_system, str->codesys);
2770 return coding_system;
2774 set_encoding_stream_coding_system (Lstream *lstr, Lisp_Object codesys)
2776 Lisp_Coding_System *cs = XCODING_SYSTEM (codesys);
2777 struct encoding_stream *str = ENCODING_STREAM_DATA (lstr);
2779 reset_encoding_stream (str);
2783 make_encoding_stream_1 (Lstream *stream, Lisp_Object codesys,
2786 Lstream *lstr = Lstream_new (lstream_encoding, mode);
2787 struct encoding_stream *str = ENCODING_STREAM_DATA (lstr);
2791 str->runoff = Dynarr_new (unsigned_char);
2792 str->other_end = stream;
2793 set_encoding_stream_coding_system (lstr, codesys);
2794 XSETLSTREAM (obj, lstr);
2799 make_encoding_input_stream (Lstream *stream, Lisp_Object codesys)
2801 return make_encoding_stream_1 (stream, codesys, "r");
2805 make_encoding_output_stream (Lstream *stream, Lisp_Object codesys)
2807 return make_encoding_stream_1 (stream, codesys, "w");
2810 /* Convert N bytes of internally-formatted data stored in SRC to an
2811 external format, according to the encoding stream ENCODING.
2812 Store the encoded data into DST. */
2815 mule_encode (Lstream *encoding, const Bufbyte *src,
2816 unsigned_char_dynarr *dst, size_t n)
2818 struct encoding_stream *str = ENCODING_STREAM_DATA (encoding);
2820 switch (CODING_SYSTEM_TYPE (str->codesys))
2823 case CODESYS_INTERNAL:
2824 Dynarr_add_many (dst, src, n);
2827 case CODESYS_AUTODETECT:
2828 /* If we got this far and still haven't decided on the coding
2829 system, then do no conversion. */
2830 case CODESYS_NO_CONVERSION:
2831 encode_coding_no_conversion (encoding, src, dst, n);
2834 case CODESYS_SHIFT_JIS:
2835 encode_coding_sjis (encoding, src, dst, n);
2838 encode_coding_big5 (encoding, src, dst, n);
2841 encode_coding_ucs4 (encoding, src, dst, n);
2844 encode_coding_utf8 (encoding, src, dst, n);
2847 str->ccl.last_block = str->flags & CODING_STATE_END;
2848 /* When applying ccl program to stream, MUST NOT set NULL
2850 ccl_driver (&str->ccl, ((src) ? src : (unsigned char*)""),
2851 dst, n, 0, CCL_MODE_ENCODING);
2853 case CODESYS_ISO2022:
2854 encode_coding_iso2022 (encoding, src, dst, n);
2862 DEFUN ("encode-coding-region", Fencode_coding_region, 3, 4, 0, /*
2863 Encode the text between START and END using CODING-SYSTEM.
2864 This will, for example, convert Japanese characters into stuff such as
2865 "^[$B!<!+^[(B" if you use the JIS encoding. Return length of encoded
2866 text. BUFFER defaults to the current buffer if unspecified.
2868 (start, end, coding_system, buffer))
2871 struct buffer *buf = decode_buffer (buffer, 0);
2872 Lisp_Object instream, lb_outstream, de_outstream, outstream;
2873 Lstream *istr, *ostr;
2874 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
2876 get_buffer_range_char (buf, start, end, &b, &e, 0);
2878 barf_if_buffer_read_only (buf, b, e);
2880 coding_system = Fget_coding_system (coding_system);
2881 instream = make_lisp_buffer_input_stream (buf, b, e, 0);
2882 lb_outstream = make_lisp_buffer_output_stream (buf, b, 0);
2883 de_outstream = make_decoding_output_stream (XLSTREAM (lb_outstream),
2884 Fget_coding_system (Qbinary));
2885 outstream = make_encoding_output_stream (XLSTREAM (de_outstream),
2887 istr = XLSTREAM (instream);
2888 ostr = XLSTREAM (outstream);
2889 GCPRO4 (instream, outstream, de_outstream, lb_outstream);
2890 /* The chain of streams looks like this:
2892 [BUFFER] <----- send through
2893 ------> [ENCODE AS SPECIFIED]
2894 ------> [DECODE AS BINARY]
2899 char tempbuf[1024]; /* some random amount */
2900 Bufpos newpos, even_newer_pos;
2901 Bufpos oldpos = lisp_buffer_stream_startpos (istr);
2902 ssize_t size_in_bytes = Lstream_read (istr, tempbuf, sizeof (tempbuf));
2906 newpos = lisp_buffer_stream_startpos (istr);
2907 Lstream_write (ostr, tempbuf, size_in_bytes);
2908 even_newer_pos = lisp_buffer_stream_startpos (istr);
2909 buffer_delete_range (buf, even_newer_pos - (newpos - oldpos),
2915 lisp_buffer_stream_startpos (XLSTREAM (instream)) - b;
2916 Lstream_close (istr);
2917 Lstream_close (ostr);
2919 Lstream_delete (istr);
2920 Lstream_delete (ostr);
2921 Lstream_delete (XLSTREAM (de_outstream));
2922 Lstream_delete (XLSTREAM (lb_outstream));
2923 return make_int (retlen);
2929 /************************************************************************/
2930 /* Shift-JIS methods */
2931 /************************************************************************/
2933 /* Shift-JIS is a coding system encoding three character sets: ASCII, right
2934 half of JISX0201-Kana, and JISX0208. An ASCII character is encoded
2935 as is. A character of JISX0201-Kana (DIMENSION1_CHARS94 character set) is
2936 encoded by "position-code + 0x80". A character of JISX0208
2937 (DIMENSION2_CHARS94 character set) is encoded in 2-byte but two
2938 position-codes are divided and shifted so that it fit in the range
2941 --- CODE RANGE of Shift-JIS ---
2942 (character set) (range)
2944 JISX0201-Kana 0xA0 .. 0xDF
2945 JISX0208 (1st byte) 0x80 .. 0x9F and 0xE0 .. 0xEF
2946 (2nd byte) 0x40 .. 0x7E and 0x80 .. 0xFC
2947 -------------------------------
2951 /* Is this the first byte of a Shift-JIS two-byte char? */
2953 #define BYTE_SJIS_TWO_BYTE_1_P(c) \
2954 (((c) >= 0x81 && (c) <= 0x9F) || ((c) >= 0xE0 && (c) <= 0xEF))
2956 /* Is this the second byte of a Shift-JIS two-byte char? */
2958 #define BYTE_SJIS_TWO_BYTE_2_P(c) \
2959 (((c) >= 0x40 && (c) <= 0x7E) || ((c) >= 0x80 && (c) <= 0xFC))
2961 #define BYTE_SJIS_KATAKANA_P(c) \
2962 ((c) >= 0xA1 && (c) <= 0xDF)
2965 detect_coding_sjis (struct detection_state *st, const Extbyte *src, size_t n)
2969 unsigned char c = *(unsigned char *)src++;
2970 if (c == ISO_CODE_ESC || c == ISO_CODE_SI || c == ISO_CODE_SO)
2972 if (st->shift_jis.in_second_byte)
2974 st->shift_jis.in_second_byte = 0;
2978 else if ((c >= 0x80 && c < 0xA0) || c >= 0xE0)
2979 st->shift_jis.in_second_byte = 1;
2981 return CODING_CATEGORY_SHIFT_JIS_MASK;
2984 /* Convert Shift-JIS data to internal format. */
2987 decode_coding_sjis (Lstream *decoding, const Extbyte *src,
2988 unsigned_char_dynarr *dst, size_t n)
2990 struct decoding_stream *str = DECODING_STREAM_DATA (decoding);
2991 unsigned int flags = str->flags;
2992 unsigned int ch = str->ch;
2993 eol_type_t eol_type = str->eol_type;
2997 unsigned char c = *(unsigned char *)src++;
3001 /* Previous character was first byte of Shift-JIS Kanji char. */
3002 if (BYTE_SJIS_TWO_BYTE_2_P (c))
3004 unsigned char e1, e2;
3006 Dynarr_add (dst, LEADING_BYTE_JAPANESE_JISX0208);
3007 DECODE_SJIS (ch, c, e1, e2);
3008 Dynarr_add (dst, e1);
3009 Dynarr_add (dst, e2);
3013 DECODE_ADD_BINARY_CHAR (ch, dst);
3014 DECODE_ADD_BINARY_CHAR (c, dst);
3020 DECODE_HANDLE_EOL_TYPE (eol_type, c, flags, dst);
3021 if (BYTE_SJIS_TWO_BYTE_1_P (c))
3023 else if (BYTE_SJIS_KATAKANA_P (c))
3025 Dynarr_add (dst, LEADING_BYTE_KATAKANA_JISX0201);
3026 Dynarr_add (dst, c);
3029 DECODE_ADD_BINARY_CHAR (c, dst);
3031 label_continue_loop:;
3034 DECODE_HANDLE_END_OF_CONVERSION (flags, ch, dst);
3040 /* Convert internally-formatted data to Shift-JIS. */
3043 encode_coding_sjis (Lstream *encoding, const Bufbyte *src,
3044 unsigned_char_dynarr *dst, size_t n)
3046 struct encoding_stream *str = ENCODING_STREAM_DATA (encoding);
3047 unsigned int flags = str->flags;
3048 unsigned int ch = str->ch;
3049 eol_type_t eol_type = CODING_SYSTEM_EOL_TYPE (str->codesys);
3056 if (eol_type != EOL_LF && eol_type != EOL_AUTODETECT)
3057 Dynarr_add (dst, '\r');
3058 if (eol_type != EOL_CR)
3059 Dynarr_add (dst, '\n');
3062 else if (BYTE_ASCII_P (c))
3064 Dynarr_add (dst, c);
3067 else if (BUFBYTE_LEADING_BYTE_P (c))
3068 ch = (c == LEADING_BYTE_KATAKANA_JISX0201 ||
3069 c == LEADING_BYTE_JAPANESE_JISX0208_1978 ||
3070 c == LEADING_BYTE_JAPANESE_JISX0208) ? c : 0;
3073 if (ch == LEADING_BYTE_KATAKANA_JISX0201)
3075 Dynarr_add (dst, c);
3078 else if (ch == LEADING_BYTE_JAPANESE_JISX0208_1978 ||
3079 ch == LEADING_BYTE_JAPANESE_JISX0208)
3083 unsigned char j1, j2;
3084 ENCODE_SJIS (ch, c, j1, j2);
3085 Dynarr_add (dst, j1);
3086 Dynarr_add (dst, j2);
3096 DEFUN ("decode-shift-jis-char", Fdecode_shift_jis_char, 1, 1, 0, /*
3097 Decode a JISX0208 character of Shift-JIS coding-system.
3098 CODE is the character code in Shift-JIS as a cons of type bytes.
3099 Return the corresponding character.
3103 unsigned char c1, c2, s1, s2;
3106 CHECK_INT (XCAR (code));
3107 CHECK_INT (XCDR (code));
3108 s1 = XINT (XCAR (code));
3109 s2 = XINT (XCDR (code));
3110 if (BYTE_SJIS_TWO_BYTE_1_P (s1) &&
3111 BYTE_SJIS_TWO_BYTE_2_P (s2))
3113 DECODE_SJIS (s1, s2, c1, c2);
3114 return make_char (MAKE_CHAR (Vcharset_japanese_jisx0208,
3115 c1 & 0x7F, c2 & 0x7F));
3121 DEFUN ("encode-shift-jis-char", Fencode_shift_jis_char, 1, 1, 0, /*
3122 Encode a JISX0208 character CHARACTER to SHIFT-JIS coding-system.
3123 Return the corresponding character code in SHIFT-JIS as a cons of two bytes.
3127 Lisp_Object charset;
3130 CHECK_CHAR_COERCE_INT (character);
3131 BREAKUP_CHAR (XCHAR (character), charset, c1, c2);
3132 if (EQ (charset, Vcharset_japanese_jisx0208))
3134 ENCODE_SJIS (c1 | 0x80, c2 | 0x80, s1, s2);
3135 return Fcons (make_int (s1), make_int (s2));
3142 /************************************************************************/
3144 /************************************************************************/
3146 /* BIG5 is a coding system encoding two character sets: ASCII and
3147 Big5. An ASCII character is encoded as is. Big5 is a two-byte
3148 character set and is encoded in two-byte.
3150 --- CODE RANGE of BIG5 ---
3151 (character set) (range)
3153 Big5 (1st byte) 0xA1 .. 0xFE
3154 (2nd byte) 0x40 .. 0x7E and 0xA1 .. 0xFE
3155 --------------------------
3157 Since the number of characters in Big5 is larger than maximum
3158 characters in Emacs' charset (96x96), it can't be handled as one
3159 charset. So, in Emacs, Big5 is divided into two: `charset-big5-1'
3160 and `charset-big5-2'. Both <type>s are DIMENSION2_CHARS94. The former
3161 contains frequently used characters and the latter contains less
3162 frequently used characters. */
3164 #define BYTE_BIG5_TWO_BYTE_1_P(c) \
3165 ((c) >= 0xA1 && (c) <= 0xFE)
3167 /* Is this the second byte of a Shift-JIS two-byte char? */
3169 #define BYTE_BIG5_TWO_BYTE_2_P(c) \
3170 (((c) >= 0x40 && (c) <= 0x7E) || ((c) >= 0xA1 && (c) <= 0xFE))
3172 /* Number of Big5 characters which have the same code in 1st byte. */
3174 #define BIG5_SAME_ROW (0xFF - 0xA1 + 0x7F - 0x40)
3176 /* Code conversion macros. These are macros because they are used in
3177 inner loops during code conversion.
3179 Note that temporary variables in macros introduce the classic
3180 dynamic-scoping problems with variable names. We use capital-
3181 lettered variables in the assumption that XEmacs does not use
3182 capital letters in variables except in a very formalized way
3185 /* Convert Big5 code (b1, b2) into its internal string representation
3188 /* There is a much simpler way to split the Big5 charset into two.
3189 For the moment I'm going to leave the algorithm as-is because it
3190 claims to separate out the most-used characters into a single
3191 charset, which perhaps will lead to optimizations in various
3194 The way the algorithm works is something like this:
3196 Big5 can be viewed as a 94x157 charset, where the row is
3197 encoded into the bytes 0xA1 .. 0xFE and the column is encoded
3198 into the bytes 0x40 .. 0x7E and 0xA1 .. 0xFE. As for frequency,
3199 the split between low and high column numbers is apparently
3200 meaningless; ascending rows produce less and less frequent chars.
3201 Therefore, we assign the lower half of rows (0xA1 .. 0xC8) to
3202 the first charset, and the upper half (0xC9 .. 0xFE) to the
3203 second. To do the conversion, we convert the character into
3204 a single number where 0 .. 156 is the first row, 157 .. 313
3205 is the second, etc. That way, the characters are ordered by
3206 decreasing frequency. Then we just chop the space in two
3207 and coerce the result into a 94x94 space.
3210 #define DECODE_BIG5(b1, b2, lb, c1, c2) do \
3212 int B1 = b1, B2 = b2; \
3214 = (B1 - 0xA1) * BIG5_SAME_ROW + B2 - (B2 < 0x7F ? 0x40 : 0x62); \
3218 lb = LEADING_BYTE_CHINESE_BIG5_1; \
3222 lb = LEADING_BYTE_CHINESE_BIG5_2; \
3223 I -= (BIG5_SAME_ROW) * (0xC9 - 0xA1); \
3225 c1 = I / (0xFF - 0xA1) + 0xA1; \
3226 c2 = I % (0xFF - 0xA1) + 0xA1; \
3229 /* Convert the internal string representation of a Big5 character
3230 (lb, c1, c2) into Big5 code (b1, b2). */
3232 #define ENCODE_BIG5(lb, c1, c2, b1, b2) do \
3234 unsigned int I = ((c1) - 0xA1) * (0xFF - 0xA1) + ((c2) - 0xA1); \
3236 if (lb == LEADING_BYTE_CHINESE_BIG5_2) \
3238 I += BIG5_SAME_ROW * (0xC9 - 0xA1); \
3240 b1 = I / BIG5_SAME_ROW + 0xA1; \
3241 b2 = I % BIG5_SAME_ROW; \
3242 b2 += b2 < 0x3F ? 0x40 : 0x62; \
3246 detect_coding_big5 (struct detection_state *st, const Extbyte *src, size_t n)
3250 unsigned char c = *(unsigned char *)src++;
3251 if (c == ISO_CODE_ESC || c == ISO_CODE_SI || c == ISO_CODE_SO ||
3252 (c >= 0x80 && c <= 0xA0))
3254 if (st->big5.in_second_byte)
3256 st->big5.in_second_byte = 0;
3257 if (c < 0x40 || (c >= 0x80 && c <= 0xA0))
3261 st->big5.in_second_byte = 1;
3263 return CODING_CATEGORY_BIG5_MASK;
3266 /* Convert Big5 data to internal format. */
3269 decode_coding_big5 (Lstream *decoding, const Extbyte *src,
3270 unsigned_char_dynarr *dst, size_t n)
3272 struct decoding_stream *str = DECODING_STREAM_DATA (decoding);
3273 unsigned int flags = str->flags;
3274 unsigned int ch = str->ch;
3275 eol_type_t eol_type = str->eol_type;
3279 unsigned char c = *(unsigned char *)src++;
3282 /* Previous character was first byte of Big5 char. */
3283 if (BYTE_BIG5_TWO_BYTE_2_P (c))
3285 unsigned char b1, b2, b3;
3286 DECODE_BIG5 (ch, c, b1, b2, b3);
3287 Dynarr_add (dst, b1);
3288 Dynarr_add (dst, b2);
3289 Dynarr_add (dst, b3);
3293 DECODE_ADD_BINARY_CHAR (ch, dst);
3294 DECODE_ADD_BINARY_CHAR (c, dst);
3300 DECODE_HANDLE_EOL_TYPE (eol_type, c, flags, dst);
3301 if (BYTE_BIG5_TWO_BYTE_1_P (c))
3304 DECODE_ADD_BINARY_CHAR (c, dst);
3306 label_continue_loop:;
3309 DECODE_HANDLE_END_OF_CONVERSION (flags, ch, dst);
3315 /* Convert internally-formatted data to Big5. */
3318 encode_coding_big5 (Lstream *encoding, const Bufbyte *src,
3319 unsigned_char_dynarr *dst, size_t n)
3322 struct encoding_stream *str = ENCODING_STREAM_DATA (encoding);
3323 unsigned int flags = str->flags;
3324 unsigned int ch = str->ch;
3325 eol_type_t eol_type = CODING_SYSTEM_EOL_TYPE (str->codesys);
3332 if (eol_type != EOL_LF && eol_type != EOL_AUTODETECT)
3333 Dynarr_add (dst, '\r');
3334 if (eol_type != EOL_CR)
3335 Dynarr_add (dst, '\n');
3337 else if (BYTE_ASCII_P (c))
3340 Dynarr_add (dst, c);
3342 else if (BUFBYTE_LEADING_BYTE_P (c))
3344 if (c == LEADING_BYTE_CHINESE_BIG5_1 ||
3345 c == LEADING_BYTE_CHINESE_BIG5_2)
3347 /* A recognized leading byte. */
3349 continue; /* not done with this character. */
3351 /* otherwise just ignore this character. */
3353 else if (ch == LEADING_BYTE_CHINESE_BIG5_1 ||
3354 ch == LEADING_BYTE_CHINESE_BIG5_2)
3356 /* Previous char was a recognized leading byte. */
3358 continue; /* not done with this character. */
3362 /* Encountering second byte of a Big5 character. */
3363 unsigned char b1, b2;
3365 ENCODE_BIG5 (ch >> 8, ch & 0xFF, c, b1, b2);
3366 Dynarr_add (dst, b1);
3367 Dynarr_add (dst, b2);
3378 DEFUN ("decode-big5-char", Fdecode_big5_char, 1, 1, 0, /*
3379 Decode a Big5 character CODE of BIG5 coding-system.
3380 CODE is the character code in BIG5, a cons of two integers.
3381 Return the corresponding character.
3385 unsigned char c1, c2, b1, b2;
3388 CHECK_INT (XCAR (code));
3389 CHECK_INT (XCDR (code));
3390 b1 = XINT (XCAR (code));
3391 b2 = XINT (XCDR (code));
3392 if (BYTE_BIG5_TWO_BYTE_1_P (b1) &&
3393 BYTE_BIG5_TWO_BYTE_2_P (b2))
3396 Lisp_Object charset;
3397 DECODE_BIG5 (b1, b2, leading_byte, c1, c2);
3398 charset = CHARSET_BY_LEADING_BYTE (leading_byte);
3399 return make_char (MAKE_CHAR (charset, c1 & 0x7F, c2 & 0x7F));
3405 DEFUN ("encode-big5-char", Fencode_big5_char, 1, 1, 0, /*
3406 Encode the Big5 character CHARACTER in the BIG5 coding-system.
3407 Return the corresponding character code in Big5.
3411 Lisp_Object charset;
3414 CHECK_CHAR_COERCE_INT (character);
3415 BREAKUP_CHAR (XCHAR (character), charset, c1, c2);
3416 if (EQ (charset, Vcharset_chinese_big5_1) ||
3417 EQ (charset, Vcharset_chinese_big5_2))
3419 ENCODE_BIG5 (XCHARSET_LEADING_BYTE (charset), c1 | 0x80, c2 | 0x80,
3421 return Fcons (make_int (b1), make_int (b2));
3428 /************************************************************************/
3431 /* UCS-4 character codes are implemented as nonnegative integers. */
3433 /************************************************************************/
3436 DEFUN ("set-ucs-char", Fset_ucs_char, 2, 2, 0, /*
3437 Map UCS-4 code CODE to Mule character CHARACTER.
3439 Return T on success, NIL on failure.
3445 CHECK_CHAR (character);
3446 CHECK_NATNUM (code);
3449 if (c < countof (fcd->ucs_to_mule_table))
3451 fcd->ucs_to_mule_table[c] = character;
3459 ucs_to_char (unsigned long code)
3461 if (code < countof (fcd->ucs_to_mule_table))
3463 return fcd->ucs_to_mule_table[code];
3465 else if ((0xe00000 <= code) && (code <= 0xe00000 + 94 * 94 * 14))
3470 c = code % (94 * 94);
3472 (MAKE_CHAR (CHARSET_BY_ATTRIBUTES
3473 (CHARSET_TYPE_94X94, code / (94 * 94) + '@',
3474 CHARSET_LEFT_TO_RIGHT),
3475 c / 94 + 33, c % 94 + 33));
3481 DEFUN ("ucs-char", Fucs_char, 1, 1, 0, /*
3482 Return Mule character corresponding to UCS code CODE (a positive integer).
3486 CHECK_NATNUM (code);
3487 return ucs_to_char (XINT (code));
3490 DEFUN ("set-char-ucs", Fset_char_ucs, 2, 2, 0, /*
3491 Map Mule character CHARACTER to UCS code CODE (a positive integer).
3495 /* #### Isn't this gilding the lily? Fput_char_table checks its args.
3496 Fset_char_ucs is more restrictive on index arg, but should
3497 check code arg in a char_table method. */
3498 CHECK_CHAR (character);
3499 CHECK_NATNUM (code);
3500 return Fput_char_table (character, code, mule_to_ucs_table);
3503 DEFUN ("char-ucs", Fchar_ucs, 1, 1, 0, /*
3504 Return the UCS code (a positive integer) corresponding to CHARACTER.
3508 return Fget_char_table (character, mule_to_ucs_table);
3511 /* Decode a UCS-4 character into a buffer. If the lookup fails, use
3512 <GETA MARK> (U+3013) of JIS X 0208, which means correct character
3513 is not found, instead.
3514 #### do something more appropriate (use blob?)
3515 Danger, Will Robinson! Data loss. Should we signal user? */
3517 decode_ucs4 (unsigned long ch, unsigned_char_dynarr *dst)
3519 Lisp_Object chr = ucs_to_char (ch);
3523 Bufbyte work[MAX_EMCHAR_LEN];
3528 simple_set_charptr_emchar (work, ch) :
3529 non_ascii_set_charptr_emchar (work, ch);
3530 Dynarr_add_many (dst, work, len);
3534 Dynarr_add (dst, LEADING_BYTE_JAPANESE_JISX0208);
3535 Dynarr_add (dst, 34 + 128);
3536 Dynarr_add (dst, 46 + 128);
3540 static unsigned long
3541 mule_char_to_ucs4 (Lisp_Object charset,
3542 unsigned char h, unsigned char l)
3545 = Fget_char_table (make_char (MAKE_CHAR (charset, h & 127, l & 127)),
3552 else if ( (XCHARSET_DIMENSION (charset) == 2) &&
3553 (XCHARSET_CHARS (charset) == 94) )
3555 unsigned char final = XCHARSET_FINAL (charset);
3557 if ( ('@' <= final) && (final < 0x7f) )
3559 return 0xe00000 + (final - '@') * 94 * 94
3560 + ((h & 127) - 33) * 94 + (l & 127) - 33;
3574 encode_ucs4 (Lisp_Object charset,
3575 unsigned char h, unsigned char l, unsigned_char_dynarr *dst)
3577 unsigned long code = mule_char_to_ucs4 (charset, h, l);
3578 Dynarr_add (dst, code >> 24);
3579 Dynarr_add (dst, (code >> 16) & 255);
3580 Dynarr_add (dst, (code >> 8) & 255);
3581 Dynarr_add (dst, code & 255);
3585 detect_coding_ucs4 (struct detection_state *st, const Extbyte *src, size_t n)
3589 unsigned char c = *(unsigned char *)src++;
3590 switch (st->ucs4.in_byte)
3599 st->ucs4.in_byte = 0;
3605 return CODING_CATEGORY_UCS4_MASK;
3609 decode_coding_ucs4 (Lstream *decoding, const Extbyte *src,
3610 unsigned_char_dynarr *dst, size_t n)
3612 struct decoding_stream *str = DECODING_STREAM_DATA (decoding);
3613 unsigned int flags = str->flags;
3614 unsigned int ch = str->ch;
3615 unsigned char counter = str->counter;
3619 unsigned char c = *(unsigned char *)src++;
3627 decode_ucs4 ( ( ch << 8 ) | c, dst);
3632 ch = ( ch << 8 ) | c;
3636 if (counter & CODING_STATE_END)
3637 DECODE_OUTPUT_PARTIAL_CHAR (ch);
3641 str->counter = counter;
3645 encode_coding_ucs4 (Lstream *encoding, const Bufbyte *src,
3646 unsigned_char_dynarr *dst, size_t n)
3648 struct encoding_stream *str = ENCODING_STREAM_DATA (encoding);
3649 unsigned int flags = str->flags;
3650 unsigned int ch = str->ch;
3651 unsigned char char_boundary = str->iso2022.current_char_boundary;
3652 Lisp_Object charset = str->iso2022.current_charset;
3654 #ifdef ENABLE_COMPOSITE_CHARS
3655 /* flags for handling composite chars. We do a little switcharoo
3656 on the source while we're outputting the composite char. */
3657 unsigned int saved_n = 0;
3658 const unsigned char *saved_src = NULL;
3659 int in_composite = 0;
3666 unsigned char c = *src++;
3668 if (BYTE_ASCII_P (c))
3669 { /* Processing ASCII character */
3671 encode_ucs4 (Vcharset_ascii, c, 0, dst);
3674 else if (BUFBYTE_LEADING_BYTE_P (c) || BUFBYTE_LEADING_BYTE_P (ch))
3675 { /* Processing Leading Byte */
3677 charset = CHARSET_BY_LEADING_BYTE (c);
3678 if (LEADING_BYTE_PREFIX_P(c))
3683 { /* Processing Non-ASCII character */
3685 if (EQ (charset, Vcharset_control_1))
3687 encode_ucs4 (Vcharset_control_1, c, 0, dst);
3691 switch (XCHARSET_REP_BYTES (charset))
3694 encode_ucs4 (charset, c, 0, dst);
3697 if (XCHARSET_PRIVATE_P (charset))
3699 encode_ucs4 (charset, c, 0, dst);
3704 #ifdef ENABLE_COMPOSITE_CHARS
3705 if (EQ (charset, Vcharset_composite))
3709 /* #### Bother! We don't know how to
3711 Dynarr_add (dst, '\0');
3712 Dynarr_add (dst, '\0');
3713 Dynarr_add (dst, '\0');
3714 Dynarr_add (dst, '~');
3718 Emchar emch = MAKE_CHAR (Vcharset_composite,
3719 ch & 0x7F, c & 0x7F);
3720 Lisp_Object lstr = composite_char_string (emch);
3724 src = XSTRING_DATA (lstr);
3725 n = XSTRING_LENGTH (lstr);
3729 #endif /* ENABLE_COMPOSITE_CHARS */
3731 encode_ucs4(charset, ch, c, dst);
3744 encode_ucs4 (charset, ch, c, dst);
3760 #ifdef ENABLE_COMPOSITE_CHARS
3766 goto back_to_square_n; /* Wheeeeeeeee ..... */
3768 #endif /* ENABLE_COMPOSITE_CHARS */
3772 str->iso2022.current_char_boundary = char_boundary;
3773 str->iso2022.current_charset = charset;
3775 /* Verbum caro factum est! */
3779 /************************************************************************/
3781 /************************************************************************/
3784 detect_coding_utf8 (struct detection_state *st, const Extbyte *src, size_t n)
3788 unsigned char c = *(unsigned char *)src++;
3789 switch (st->utf8.in_byte)
3792 if (c == ISO_CODE_ESC || c == ISO_CODE_SI || c == ISO_CODE_SO)
3795 st->utf8.in_byte = 5;
3797 st->utf8.in_byte = 4;
3799 st->utf8.in_byte = 3;
3801 st->utf8.in_byte = 2;
3803 st->utf8.in_byte = 1;
3808 if ((c & 0xc0) != 0x80)
3814 return CODING_CATEGORY_UTF8_MASK;
3818 decode_coding_utf8 (Lstream *decoding, const Extbyte *src,
3819 unsigned_char_dynarr *dst, size_t n)
3821 struct decoding_stream *str = DECODING_STREAM_DATA (decoding);
3822 unsigned int flags = str->flags;
3823 unsigned int ch = str->ch;
3824 eol_type_t eol_type = str->eol_type;
3825 unsigned char counter = str->counter;
3829 unsigned char c = *(unsigned char *)src++;
3838 else if ( c >= 0xf8 )
3843 else if ( c >= 0xf0 )
3848 else if ( c >= 0xe0 )
3853 else if ( c >= 0xc0 )
3860 DECODE_HANDLE_EOL_TYPE (eol_type, c, flags, dst);
3861 decode_ucs4 (c, dst);
3865 ch = ( ch << 6 ) | ( c & 0x3f );
3866 decode_ucs4 (ch, dst);
3871 ch = ( ch << 6 ) | ( c & 0x3f );
3874 label_continue_loop:;
3877 if (flags & CODING_STATE_END)
3878 DECODE_OUTPUT_PARTIAL_CHAR (ch);
3882 str->counter = counter;
3886 encode_utf8 (Lisp_Object charset,
3887 unsigned char h, unsigned char l, unsigned_char_dynarr *dst)
3889 unsigned long code = mule_char_to_ucs4 (charset, h, l);
3892 Dynarr_add (dst, code);
3894 else if ( code <= 0x7ff )
3896 Dynarr_add (dst, (code >> 6) | 0xc0);
3897 Dynarr_add (dst, (code & 0x3f) | 0x80);
3899 else if ( code <= 0xffff )
3901 Dynarr_add (dst, (code >> 12) | 0xe0);
3902 Dynarr_add (dst, ((code >> 6) & 0x3f) | 0x80);
3903 Dynarr_add (dst, (code & 0x3f) | 0x80);
3905 else if ( code <= 0x1fffff )
3907 Dynarr_add (dst, (code >> 18) | 0xf0);
3908 Dynarr_add (dst, ((code >> 12) & 0x3f) | 0x80);
3909 Dynarr_add (dst, ((code >> 6) & 0x3f) | 0x80);
3910 Dynarr_add (dst, (code & 0x3f) | 0x80);
3912 else if ( code <= 0x3ffffff )
3914 Dynarr_add (dst, (code >> 24) | 0xf8);
3915 Dynarr_add (dst, ((code >> 18) & 0x3f) | 0x80);
3916 Dynarr_add (dst, ((code >> 12) & 0x3f) | 0x80);
3917 Dynarr_add (dst, ((code >> 6) & 0x3f) | 0x80);
3918 Dynarr_add (dst, (code & 0x3f) | 0x80);
3922 Dynarr_add (dst, (code >> 30) | 0xfc);
3923 Dynarr_add (dst, ((code >> 24) & 0x3f) | 0x80);
3924 Dynarr_add (dst, ((code >> 18) & 0x3f) | 0x80);
3925 Dynarr_add (dst, ((code >> 12) & 0x3f) | 0x80);
3926 Dynarr_add (dst, ((code >> 6) & 0x3f) | 0x80);
3927 Dynarr_add (dst, (code & 0x3f) | 0x80);
3932 encode_coding_utf8 (Lstream *encoding, const Bufbyte *src,
3933 unsigned_char_dynarr *dst, size_t n)
3935 struct encoding_stream *str = ENCODING_STREAM_DATA (encoding);
3936 unsigned int flags = str->flags;
3937 unsigned int ch = str->ch;
3938 eol_type_t eol_type = CODING_SYSTEM_EOL_TYPE (str->codesys);
3939 unsigned char char_boundary = str->iso2022.current_char_boundary;
3940 Lisp_Object charset = str->iso2022.current_charset;
3942 #ifdef ENABLE_COMPOSITE_CHARS
3943 /* flags for handling composite chars. We do a little switcharoo
3944 on the source while we're outputting the composite char. */
3945 unsigned int saved_n = 0;
3946 const unsigned char *saved_src = NULL;
3947 int in_composite = 0;
3950 #endif /* ENABLE_COMPOSITE_CHARS */
3954 unsigned char c = *src++;
3956 if (BYTE_ASCII_P (c))
3957 { /* Processing ASCII character */
3961 if (eol_type != EOL_LF && eol_type != EOL_AUTODETECT)
3962 Dynarr_add (dst, '\r');
3963 if (eol_type != EOL_CR)
3964 Dynarr_add (dst, c);
3967 encode_utf8 (Vcharset_ascii, c, 0, dst);
3970 else if (BUFBYTE_LEADING_BYTE_P (c) || BUFBYTE_LEADING_BYTE_P (ch))
3971 { /* Processing Leading Byte */
3973 charset = CHARSET_BY_LEADING_BYTE (c);
3974 if (LEADING_BYTE_PREFIX_P(c))
3979 { /* Processing Non-ASCII character */
3981 if (EQ (charset, Vcharset_control_1))
3983 encode_utf8 (Vcharset_control_1, c, 0, dst);
3987 switch (XCHARSET_REP_BYTES (charset))
3990 encode_utf8 (charset, c, 0, dst);
3993 if (XCHARSET_PRIVATE_P (charset))
3995 encode_utf8 (charset, c, 0, dst);
4000 #ifdef ENABLE_COMPOSITE_CHARS
4001 if (EQ (charset, Vcharset_composite))
4005 /* #### Bother! We don't know how to
4007 encode_utf8 (Vcharset_ascii, '~', 0, dst);
4011 Emchar emch = MAKE_CHAR (Vcharset_composite,
4012 ch & 0x7F, c & 0x7F);
4013 Lisp_Object lstr = composite_char_string (emch);
4017 src = XSTRING_DATA (lstr);
4018 n = XSTRING_LENGTH (lstr);
4022 #endif /* ENABLE_COMPOSITE_CHARS */
4024 encode_utf8 (charset, ch, c, dst);
4037 encode_utf8 (charset, ch, c, dst);
4053 #ifdef ENABLE_COMPOSITE_CHARS
4059 goto back_to_square_n; /* Wheeeeeeeee ..... */
4065 str->iso2022.current_char_boundary = char_boundary;
4066 str->iso2022.current_charset = charset;
4068 /* Verbum caro factum est! */
4072 /************************************************************************/
4073 /* ISO2022 methods */
4074 /************************************************************************/
4076 /* The following note describes the coding system ISO2022 briefly.
4077 Since the intention of this note is to help understand the
4078 functions in this file, some parts are NOT ACCURATE or OVERLY
4079 SIMPLIFIED. For thorough understanding, please refer to the
4080 original document of ISO2022.
4082 ISO2022 provides many mechanisms to encode several character sets
4083 in 7-bit and 8-bit environments. For 7-bit environments, all text
4084 is encoded using bytes less than 128. This may make the encoded
4085 text a little bit longer, but the text passes more easily through
4086 several gateways, some of which strip off MSB (Most Signigant Bit).
4088 There are two kinds of character sets: control character set and
4089 graphic character set. The former contains control characters such
4090 as `newline' and `escape' to provide control functions (control
4091 functions are also provided by escape sequences). The latter
4092 contains graphic characters such as 'A' and '-'. Emacs recognizes
4093 two control character sets and many graphic character sets.
4095 Graphic character sets are classified into one of the following
4096 four classes, according to the number of bytes (DIMENSION) and
4097 number of characters in one dimension (CHARS) of the set:
4098 - DIMENSION1_CHARS94
4099 - DIMENSION1_CHARS96
4100 - DIMENSION2_CHARS94
4101 - DIMENSION2_CHARS96
4103 In addition, each character set is assigned an identification tag,
4104 unique for each set, called "final character" (denoted as <F>
4105 hereafter). The <F> of each character set is decided by ECMA(*)
4106 when it is registered in ISO. The code range of <F> is 0x30..0x7F
4107 (0x30..0x3F are for private use only).
4109 Note (*): ECMA = European Computer Manufacturers Association
4111 Here are examples of graphic character set [NAME(<F>)]:
4112 o DIMENSION1_CHARS94 -- ASCII('B'), right-half-of-JISX0201('I'), ...
4113 o DIMENSION1_CHARS96 -- right-half-of-ISO8859-1('A'), ...
4114 o DIMENSION2_CHARS94 -- GB2312('A'), JISX0208('B'), ...
4115 o DIMENSION2_CHARS96 -- none for the moment
4117 A code area (1 byte = 8 bits) is divided into 4 areas, C0, GL, C1, and GR.
4118 C0 [0x00..0x1F] -- control character plane 0
4119 GL [0x20..0x7F] -- graphic character plane 0
4120 C1 [0x80..0x9F] -- control character plane 1
4121 GR [0xA0..0xFF] -- graphic character plane 1
4123 A control character set is directly designated and invoked to C0 or
4124 C1 by an escape sequence. The most common case is that:
4125 - ISO646's control character set is designated/invoked to C0, and
4126 - ISO6429's control character set is designated/invoked to C1,
4127 and usually these designations/invocations are omitted in encoded
4128 text. In a 7-bit environment, only C0 can be used, and a control
4129 character for C1 is encoded by an appropriate escape sequence to
4130 fit into the environment. All control characters for C1 are
4131 defined to have corresponding escape sequences.
4133 A graphic character set is at first designated to one of four
4134 graphic registers (G0 through G3), then these graphic registers are
4135 invoked to GL or GR. These designations and invocations can be
4136 done independently. The most common case is that G0 is invoked to
4137 GL, G1 is invoked to GR, and ASCII is designated to G0. Usually
4138 these invocations and designations are omitted in encoded text.
4139 In a 7-bit environment, only GL can be used.
4141 When a graphic character set of CHARS94 is invoked to GL, codes
4142 0x20 and 0x7F of the GL area work as control characters SPACE and
4143 DEL respectively, and codes 0xA0 and 0xFF of the GR area should not
4146 There are two ways of invocation: locking-shift and single-shift.
4147 With locking-shift, the invocation lasts until the next different
4148 invocation, whereas with single-shift, the invocation affects the
4149 following character only and doesn't affect the locking-shift
4150 state. Invocations are done by the following control characters or
4153 ----------------------------------------------------------------------
4154 abbrev function cntrl escape seq description
4155 ----------------------------------------------------------------------
4156 SI/LS0 (shift-in) 0x0F none invoke G0 into GL
4157 SO/LS1 (shift-out) 0x0E none invoke G1 into GL
4158 LS2 (locking-shift-2) none ESC 'n' invoke G2 into GL
4159 LS3 (locking-shift-3) none ESC 'o' invoke G3 into GL
4160 LS1R (locking-shift-1 right) none ESC '~' invoke G1 into GR (*)
4161 LS2R (locking-shift-2 right) none ESC '}' invoke G2 into GR (*)
4162 LS3R (locking-shift 3 right) none ESC '|' invoke G3 into GR (*)
4163 SS2 (single-shift-2) 0x8E ESC 'N' invoke G2 for one char
4164 SS3 (single-shift-3) 0x8F ESC 'O' invoke G3 for one char
4165 ----------------------------------------------------------------------
4166 (*) These are not used by any known coding system.
4168 Control characters for these functions are defined by macros
4169 ISO_CODE_XXX in `coding.h'.
4171 Designations are done by the following escape sequences:
4172 ----------------------------------------------------------------------
4173 escape sequence description
4174 ----------------------------------------------------------------------
4175 ESC '(' <F> designate DIMENSION1_CHARS94<F> to G0
4176 ESC ')' <F> designate DIMENSION1_CHARS94<F> to G1
4177 ESC '*' <F> designate DIMENSION1_CHARS94<F> to G2
4178 ESC '+' <F> designate DIMENSION1_CHARS94<F> to G3
4179 ESC ',' <F> designate DIMENSION1_CHARS96<F> to G0 (*)
4180 ESC '-' <F> designate DIMENSION1_CHARS96<F> to G1
4181 ESC '.' <F> designate DIMENSION1_CHARS96<F> to G2
4182 ESC '/' <F> designate DIMENSION1_CHARS96<F> to G3
4183 ESC '$' '(' <F> designate DIMENSION2_CHARS94<F> to G0 (**)
4184 ESC '$' ')' <F> designate DIMENSION2_CHARS94<F> to G1
4185 ESC '$' '*' <F> designate DIMENSION2_CHARS94<F> to G2
4186 ESC '$' '+' <F> designate DIMENSION2_CHARS94<F> to G3
4187 ESC '$' ',' <F> designate DIMENSION2_CHARS96<F> to G0 (*)
4188 ESC '$' '-' <F> designate DIMENSION2_CHARS96<F> to G1
4189 ESC '$' '.' <F> designate DIMENSION2_CHARS96<F> to G2
4190 ESC '$' '/' <F> designate DIMENSION2_CHARS96<F> to G3
4191 ----------------------------------------------------------------------
4193 In this list, "DIMENSION1_CHARS94<F>" means a graphic character set
4194 of dimension 1, chars 94, and final character <F>, etc...
4196 Note (*): Although these designations are not allowed in ISO2022,
4197 Emacs accepts them on decoding, and produces them on encoding
4198 CHARS96 character sets in a coding system which is characterized as
4199 7-bit environment, non-locking-shift, and non-single-shift.
4201 Note (**): If <F> is '@', 'A', or 'B', the intermediate character
4202 '(' can be omitted. We refer to this as "short-form" hereafter.
4204 Now you may notice that there are a lot of ways for encoding the
4205 same multilingual text in ISO2022. Actually, there exist many
4206 coding systems such as Compound Text (used in X11's inter client
4207 communication, ISO-2022-JP (used in Japanese internet), ISO-2022-KR
4208 (used in Korean internet), EUC (Extended UNIX Code, used in Asian
4209 localized platforms), and all of these are variants of ISO2022.
4211 In addition to the above, Emacs handles two more kinds of escape
4212 sequences: ISO6429's direction specification and Emacs' private
4213 sequence for specifying character composition.
4215 ISO6429's direction specification takes the following form:
4216 o CSI ']' -- end of the current direction
4217 o CSI '0' ']' -- end of the current direction
4218 o CSI '1' ']' -- start of left-to-right text
4219 o CSI '2' ']' -- start of right-to-left text
4220 The control character CSI (0x9B: control sequence introducer) is
4221 abbreviated to the escape sequence ESC '[' in a 7-bit environment.
4223 Character composition specification takes the following form:
4224 o ESC '0' -- start character composition
4225 o ESC '1' -- end character composition
4226 Since these are not standard escape sequences of any ISO standard,
4227 their use with these meanings is restricted to Emacs only. */
4230 reset_iso2022 (Lisp_Object coding_system, struct iso2022_decoder *iso)
4234 for (i = 0; i < 4; i++)
4236 if (!NILP (coding_system))
4238 XCODING_SYSTEM_ISO2022_INITIAL_CHARSET (coding_system, i);
4240 iso->charset[i] = Qt;
4241 iso->invalid_designated[i] = 0;
4243 iso->esc = ISO_ESC_NOTHING;
4244 iso->esc_bytes_index = 0;
4245 iso->register_left = 0;
4246 iso->register_right = 1;
4247 iso->switched_dir_and_no_valid_charset_yet = 0;
4248 iso->invalid_switch_dir = 0;
4249 iso->output_direction_sequence = 0;
4250 iso->output_literally = 0;
4251 #ifdef ENABLE_COMPOSITE_CHARS
4252 if (iso->composite_chars)
4253 Dynarr_reset (iso->composite_chars);
4258 fit_to_be_escape_quoted (unsigned char c)
4275 /* Parse one byte of an ISO2022 escape sequence.
4276 If the result is an invalid escape sequence, return 0 and
4277 do not change anything in STR. Otherwise, if the result is
4278 an incomplete escape sequence, update ISO2022.ESC and
4279 ISO2022.ESC_BYTES and return -1. Otherwise, update
4280 all the state variables (but not ISO2022.ESC_BYTES) and
4283 If CHECK_INVALID_CHARSETS is non-zero, check for designation
4284 or invocation of an invalid character set and treat that as
4285 an unrecognized escape sequence.
4287 ********************************************************************
4289 #### Strategies for error annotation and coding orthogonalization
4291 We really want to separate out a number of things. Conceptually,
4292 there is a nested syntax.
4294 At the top level is the ISO 2022 extension syntax, including charset
4295 designation and invocation, and certain auxiliary controls such as the
4296 ISO 6429 direction specification. These are octet-oriented, with the
4297 single exception (AFAIK) of the "exit Unicode" sequence which uses the
4298 UTF's natural width (1 byte for UTF-7 and UTF-8, 2 bytes for UCS-2 and
4299 UTF-16, and 4 bytes for UCS-4 and UTF-32). This will be treated as a
4300 (deprecated) special case in Unicode processing.
4302 The middle layer is ISO 2022 character interpretation. This will depend
4303 on the current state of the ISO 2022 registers, and assembles octets
4304 into the character's internal representation.
4306 The lowest level is translating system control conventions. At present
4307 this is restricted to newline translation, but one could imagine doing
4308 tab conversion or line wrapping here. "Escape from Unicode" processing
4309 would be done at this level.
4311 At each level the parser will verify the syntax. In the case of a
4312 syntax error or warning (such as a redundant escape sequence that affects
4313 no characters), the parser will take some action, typically inserting the
4314 erroneous octets directly into the output and creating an annotation
4315 which can be used by higher level I/O to mark the affected region.
4317 This should make it possible to do something sensible about separating
4318 newline convention processing from character construction, and about
4319 preventing ISO 2022 escape sequences from being recognized
4322 The basic strategy will be to have octet classification tables, and
4323 switch processing according to the table entry.
4325 It's possible that, by doing the processing with tables of functions or
4326 the like, the parser can be used for both detection and translation. */
4329 parse_iso2022_esc (Lisp_Object codesys, struct iso2022_decoder *iso,
4330 unsigned char c, unsigned int *flags,
4331 int check_invalid_charsets)
4333 /* (1) If we're at the end of a designation sequence, CS is the
4334 charset being designated and REG is the register to designate
4337 (2) If we're at the end of a locking-shift sequence, REG is
4338 the register to invoke and HALF (0 == left, 1 == right) is
4339 the half to invoke it into.
4341 (3) If we're at the end of a single-shift sequence, REG is
4342 the register to invoke. */
4343 Lisp_Object cs = Qnil;
4346 /* NOTE: This code does goto's all over the fucking place.
4347 The reason for this is that we're basically implementing
4348 a state machine here, and hierarchical languages like C
4349 don't really provide a clean way of doing this. */
4351 if (! (*flags & CODING_STATE_ESCAPE))
4352 /* At beginning of escape sequence; we need to reset our
4353 escape-state variables. */
4354 iso->esc = ISO_ESC_NOTHING;
4356 iso->output_literally = 0;
4357 iso->output_direction_sequence = 0;
4361 case ISO_ESC_NOTHING:
4362 iso->esc_bytes_index = 0;
4365 case ISO_CODE_ESC: /* Start escape sequence */
4366 *flags |= CODING_STATE_ESCAPE;
4370 case ISO_CODE_CSI: /* ISO6429 (specifying directionality) */
4371 *flags |= CODING_STATE_ESCAPE;
4372 iso->esc = ISO_ESC_5_11;
4375 case ISO_CODE_SO: /* locking shift 1 */
4378 case ISO_CODE_SI: /* locking shift 0 */
4382 case ISO_CODE_SS2: /* single shift */
4385 case ISO_CODE_SS3: /* single shift */
4389 default: /* Other control characters */
4396 /**** single shift ****/
4398 case 'N': /* single shift 2 */
4401 case 'O': /* single shift 3 */
4405 /**** locking shift ****/
4407 case '~': /* locking shift 1 right */
4410 case 'n': /* locking shift 2 */
4413 case '}': /* locking shift 2 right */
4416 case 'o': /* locking shift 3 */
4419 case '|': /* locking shift 3 right */
4423 #ifdef ENABLE_COMPOSITE_CHARS
4424 /**** composite ****/
4427 iso->esc = ISO_ESC_START_COMPOSITE;
4428 *flags = (*flags & CODING_STATE_ISO2022_LOCK) |
4429 CODING_STATE_COMPOSITE;
4433 iso->esc = ISO_ESC_END_COMPOSITE;
4434 *flags = (*flags & CODING_STATE_ISO2022_LOCK) &
4435 ~CODING_STATE_COMPOSITE;
4437 #endif /* ENABLE_COMPOSITE_CHARS */
4439 /**** directionality ****/
4442 iso->esc = ISO_ESC_5_11;
4445 /**** designation ****/
4447 case '$': /* multibyte charset prefix */
4448 iso->esc = ISO_ESC_2_4;
4452 if (0x28 <= c && c <= 0x2F)
4454 iso->esc = (enum iso_esc_flag) (c - 0x28 + ISO_ESC_2_8);
4458 /* This function is called with CODESYS equal to nil when
4459 doing coding-system detection. */
4461 && XCODING_SYSTEM_ISO2022_ESCAPE_QUOTED (codesys)
4462 && fit_to_be_escape_quoted (c))
4464 iso->esc = ISO_ESC_LITERAL;
4465 *flags &= CODING_STATE_ISO2022_LOCK;
4475 /**** directionality ****/
4477 case ISO_ESC_5_11: /* ISO6429 direction control */
4480 *flags &= (CODING_STATE_ISO2022_LOCK & ~CODING_STATE_R2L);
4481 goto directionality;
4483 if (c == '0') iso->esc = ISO_ESC_5_11_0;
4484 else if (c == '1') iso->esc = ISO_ESC_5_11_1;
4485 else if (c == '2') iso->esc = ISO_ESC_5_11_2;
4489 case ISO_ESC_5_11_0:
4492 *flags &= (CODING_STATE_ISO2022_LOCK & ~CODING_STATE_R2L);
4493 goto directionality;
4497 case ISO_ESC_5_11_1:
4500 *flags = (CODING_STATE_ISO2022_LOCK & ~CODING_STATE_R2L);
4501 goto directionality;
4505 case ISO_ESC_5_11_2:
4508 *flags = (*flags & CODING_STATE_ISO2022_LOCK) | CODING_STATE_R2L;
4509 goto directionality;
4514 iso->esc = ISO_ESC_DIRECTIONALITY;
4515 /* Various junk here to attempt to preserve the direction sequences
4516 literally in the text if they would otherwise be swallowed due
4517 to invalid designations that don't show up as actual charset
4518 changes in the text. */
4519 if (iso->invalid_switch_dir)
4521 /* We already inserted a direction switch literally into the
4522 text. We assume (#### this may not be right) that the
4523 next direction switch is the one going the other way,
4524 and we need to output that literally as well. */
4525 iso->output_literally = 1;
4526 iso->invalid_switch_dir = 0;
4532 /* If we are in the thrall of an invalid designation,
4533 then stick the directionality sequence literally into the
4534 output stream so it ends up in the original text again. */
4535 for (jj = 0; jj < 4; jj++)
4536 if (iso->invalid_designated[jj])
4540 iso->output_literally = 1;
4541 iso->invalid_switch_dir = 1;
4544 /* Indicate that we haven't yet seen a valid designation,
4545 so that if a switch-dir is directly followed by an
4546 invalid designation, both get inserted literally. */
4547 iso->switched_dir_and_no_valid_charset_yet = 1;
4552 /**** designation ****/
4555 if (0x28 <= c && c <= 0x2F)
4557 iso->esc = (enum iso_esc_flag) (c - 0x28 + ISO_ESC_2_4_8);
4560 if (0x40 <= c && c <= 0x42)
4562 cs = CHARSET_BY_ATTRIBUTES (CHARSET_TYPE_94X94, c,
4563 *flags & CODING_STATE_R2L ?
4564 CHARSET_RIGHT_TO_LEFT :
4565 CHARSET_LEFT_TO_RIGHT);
4575 if (c < '0' || c > '~')
4576 return 0; /* bad final byte */
4578 if (iso->esc >= ISO_ESC_2_8 &&
4579 iso->esc <= ISO_ESC_2_15)
4581 type = ((iso->esc >= ISO_ESC_2_12) ?
4582 CHARSET_TYPE_96 : CHARSET_TYPE_94);
4583 reg = (iso->esc - ISO_ESC_2_8) & 3;
4585 else if (iso->esc >= ISO_ESC_2_4_8 &&
4586 iso->esc <= ISO_ESC_2_4_15)
4588 type = ((iso->esc >= ISO_ESC_2_4_12) ?
4589 CHARSET_TYPE_96X96 : CHARSET_TYPE_94X94);
4590 reg = (iso->esc - ISO_ESC_2_4_8) & 3;
4594 /* Can this ever be reached? -slb */
4599 cs = CHARSET_BY_ATTRIBUTES (type, c,
4600 *flags & CODING_STATE_R2L ?
4601 CHARSET_RIGHT_TO_LEFT :
4602 CHARSET_LEFT_TO_RIGHT);
4608 iso->esc_bytes[iso->esc_bytes_index++] = (unsigned char) c;
4612 if (check_invalid_charsets && !CHARSETP (iso->charset[reg]))
4613 /* can't invoke something that ain't there. */
4615 iso->esc = ISO_ESC_SINGLE_SHIFT;
4616 *flags &= CODING_STATE_ISO2022_LOCK;
4618 *flags |= CODING_STATE_SS2;
4620 *flags |= CODING_STATE_SS3;
4624 if (check_invalid_charsets &&
4625 !CHARSETP (iso->charset[reg]))
4626 /* can't invoke something that ain't there. */
4629 iso->register_right = reg;
4631 iso->register_left = reg;
4632 *flags &= CODING_STATE_ISO2022_LOCK;
4633 iso->esc = ISO_ESC_LOCKING_SHIFT;
4637 if (NILP (cs) && check_invalid_charsets)
4639 iso->invalid_designated[reg] = 1;
4640 iso->charset[reg] = Vcharset_ascii;
4641 iso->esc = ISO_ESC_DESIGNATE;
4642 *flags &= CODING_STATE_ISO2022_LOCK;
4643 iso->output_literally = 1;
4644 if (iso->switched_dir_and_no_valid_charset_yet)
4646 /* We encountered a switch-direction followed by an
4647 invalid designation. Ensure that the switch-direction
4648 gets outputted; otherwise it will probably get eaten
4649 when the text is written out again. */
4650 iso->switched_dir_and_no_valid_charset_yet = 0;
4651 iso->output_direction_sequence = 1;
4652 /* And make sure that the switch-dir going the other
4653 way gets outputted, as well. */
4654 iso->invalid_switch_dir = 1;
4658 /* This function is called with CODESYS equal to nil when
4659 doing coding-system detection. */
4660 if (!NILP (codesys))
4662 charset_conversion_spec_dynarr *dyn =
4663 XCODING_SYSTEM (codesys)->iso2022.input_conv;
4669 for (i = 0; i < Dynarr_length (dyn); i++)
4671 struct charset_conversion_spec *spec = Dynarr_atp (dyn, i);
4672 if (EQ (cs, spec->from_charset))
4673 cs = spec->to_charset;
4678 iso->charset[reg] = cs;
4679 iso->esc = ISO_ESC_DESIGNATE;
4680 *flags &= CODING_STATE_ISO2022_LOCK;
4681 if (iso->invalid_designated[reg])
4683 iso->invalid_designated[reg] = 0;
4684 iso->output_literally = 1;
4686 if (iso->switched_dir_and_no_valid_charset_yet)
4687 iso->switched_dir_and_no_valid_charset_yet = 0;
4692 detect_coding_iso2022 (struct detection_state *st, const Extbyte *src, size_t n)
4696 /* #### There are serious deficiencies in the recognition mechanism
4697 here. This needs to be much smarter if it's going to cut it.
4698 The sequence "\xff\x0f" is currently detected as LOCK_SHIFT while
4699 it should be detected as Latin-1.
4700 All the ISO2022 stuff in this file should be synced up with the
4701 code from FSF Emacs-20.4, in which Mule should be more or less stable.
4702 Perhaps we should wait till R2L works in FSF Emacs? */
4704 if (!st->iso2022.initted)
4706 reset_iso2022 (Qnil, &st->iso2022.iso);
4707 st->iso2022.mask = (CODING_CATEGORY_ISO_7_MASK |
4708 CODING_CATEGORY_ISO_8_DESIGNATE_MASK |
4709 CODING_CATEGORY_ISO_8_1_MASK |
4710 CODING_CATEGORY_ISO_8_2_MASK |
4711 CODING_CATEGORY_ISO_LOCK_SHIFT_MASK);
4712 st->iso2022.flags = 0;
4713 st->iso2022.high_byte_count = 0;
4714 st->iso2022.saw_single_shift = 0;
4715 st->iso2022.initted = 1;
4718 mask = st->iso2022.mask;
4722 unsigned char c = *(unsigned char *)src++;
4725 mask &= ~CODING_CATEGORY_ISO_7_MASK;
4726 st->iso2022.high_byte_count++;
4730 if (st->iso2022.high_byte_count && !st->iso2022.saw_single_shift)
4732 if (st->iso2022.high_byte_count & 1)
4733 /* odd number of high bytes; assume not iso-8-2 */
4734 mask &= ~CODING_CATEGORY_ISO_8_2_MASK;
4736 st->iso2022.high_byte_count = 0;
4737 st->iso2022.saw_single_shift = 0;
4739 mask &= ~CODING_CATEGORY_ISO_7_MASK;
4741 if (!(st->iso2022.flags & CODING_STATE_ESCAPE)
4742 && (BYTE_C0_P (c) || BYTE_C1_P (c)))
4743 { /* control chars */
4746 /* Allow and ignore control characters that you might
4747 reasonably see in a text file */
4752 case 8: /* backspace */
4753 case 11: /* vertical tab */
4754 case 12: /* form feed */
4755 case 26: /* MS-DOS C-z junk */
4756 case 31: /* '^_' -- for info */
4757 goto label_continue_loop;
4764 if ((st->iso2022.flags & CODING_STATE_ESCAPE) || BYTE_C0_P (c)
4767 if (parse_iso2022_esc (Qnil, &st->iso2022.iso, c,
4768 &st->iso2022.flags, 0))
4770 switch (st->iso2022.iso.esc)
4772 case ISO_ESC_DESIGNATE:
4773 mask &= ~CODING_CATEGORY_ISO_8_1_MASK;
4774 mask &= ~CODING_CATEGORY_ISO_8_2_MASK;
4776 case ISO_ESC_LOCKING_SHIFT:
4777 mask = CODING_CATEGORY_ISO_LOCK_SHIFT_MASK;
4778 goto ran_out_of_chars;
4779 case ISO_ESC_SINGLE_SHIFT:
4780 mask &= ~CODING_CATEGORY_ISO_8_DESIGNATE_MASK;
4781 st->iso2022.saw_single_shift = 1;
4790 goto ran_out_of_chars;
4793 label_continue_loop:;
4802 postprocess_iso2022_mask (int mask)
4804 /* #### kind of cheesy */
4805 /* If seven-bit ISO is allowed, then assume that the encoding is
4806 entirely seven-bit and turn off the eight-bit ones. */
4807 if (mask & CODING_CATEGORY_ISO_7_MASK)
4808 mask &= ~ (CODING_CATEGORY_ISO_8_DESIGNATE_MASK |
4809 CODING_CATEGORY_ISO_8_1_MASK |
4810 CODING_CATEGORY_ISO_8_2_MASK);
4814 /* If FLAGS is a null pointer or specifies right-to-left motion,
4815 output a switch-dir-to-left-to-right sequence to DST.
4816 Also update FLAGS if it is not a null pointer.
4817 If INTERNAL_P is set, we are outputting in internal format and
4818 need to handle the CSI differently. */
4821 restore_left_to_right_direction (Lisp_Coding_System *codesys,
4822 unsigned_char_dynarr *dst,
4823 unsigned int *flags,
4826 if (!flags || (*flags & CODING_STATE_R2L))
4828 if (CODING_SYSTEM_ISO2022_SEVEN (codesys))
4830 Dynarr_add (dst, ISO_CODE_ESC);
4831 Dynarr_add (dst, '[');
4833 else if (internal_p)
4834 DECODE_ADD_BINARY_CHAR (ISO_CODE_CSI, dst);
4836 Dynarr_add (dst, ISO_CODE_CSI);
4837 Dynarr_add (dst, '0');
4838 Dynarr_add (dst, ']');
4840 *flags &= ~CODING_STATE_R2L;
4844 /* If FLAGS is a null pointer or specifies a direction different from
4845 DIRECTION (which should be either CHARSET_RIGHT_TO_LEFT or
4846 CHARSET_LEFT_TO_RIGHT), output the appropriate switch-dir escape
4847 sequence to DST. Also update FLAGS if it is not a null pointer.
4848 If INTERNAL_P is set, we are outputting in internal format and
4849 need to handle the CSI differently. */
4852 ensure_correct_direction (int direction, Lisp_Coding_System *codesys,
4853 unsigned_char_dynarr *dst, unsigned int *flags,
4856 if ((!flags || (*flags & CODING_STATE_R2L)) &&
4857 direction == CHARSET_LEFT_TO_RIGHT)
4858 restore_left_to_right_direction (codesys, dst, flags, internal_p);
4859 else if (!CODING_SYSTEM_ISO2022_NO_ISO6429 (codesys)
4860 && (!flags || !(*flags & CODING_STATE_R2L)) &&
4861 direction == CHARSET_RIGHT_TO_LEFT)
4863 if (CODING_SYSTEM_ISO2022_SEVEN (codesys))
4865 Dynarr_add (dst, ISO_CODE_ESC);
4866 Dynarr_add (dst, '[');
4868 else if (internal_p)
4869 DECODE_ADD_BINARY_CHAR (ISO_CODE_CSI, dst);
4871 Dynarr_add (dst, ISO_CODE_CSI);
4872 Dynarr_add (dst, '2');
4873 Dynarr_add (dst, ']');
4875 *flags |= CODING_STATE_R2L;
4879 /* Convert ISO2022-format data to internal format. */
4882 decode_coding_iso2022 (Lstream *decoding, const Extbyte *src,
4883 unsigned_char_dynarr *dst, size_t n)
4885 struct decoding_stream *str = DECODING_STREAM_DATA (decoding);
4886 unsigned int flags = str->flags;
4887 unsigned int ch = str->ch;
4888 eol_type_t eol_type = str->eol_type;
4889 #ifdef ENABLE_COMPOSITE_CHARS
4890 unsigned_char_dynarr *real_dst = dst;
4892 Lisp_Object coding_system;
4894 XSETCODING_SYSTEM (coding_system, str->codesys);
4896 #ifdef ENABLE_COMPOSITE_CHARS
4897 if (flags & CODING_STATE_COMPOSITE)
4898 dst = str->iso2022.composite_chars;
4899 #endif /* ENABLE_COMPOSITE_CHARS */
4903 unsigned char c = *(unsigned char *)src++;
4904 if (flags & CODING_STATE_ESCAPE)
4905 { /* Within ESC sequence */
4906 int retval = parse_iso2022_esc (coding_system, &str->iso2022,
4911 switch (str->iso2022.esc)
4913 #ifdef ENABLE_COMPOSITE_CHARS
4914 case ISO_ESC_START_COMPOSITE:
4915 if (str->iso2022.composite_chars)
4916 Dynarr_reset (str->iso2022.composite_chars);
4918 str->iso2022.composite_chars = Dynarr_new (unsigned_char);
4919 dst = str->iso2022.composite_chars;
4921 case ISO_ESC_END_COMPOSITE:
4923 Bufbyte comstr[MAX_EMCHAR_LEN];
4925 Emchar emch = lookup_composite_char (Dynarr_atp (dst, 0),
4926 Dynarr_length (dst));
4928 len = set_charptr_emchar (comstr, emch);
4929 Dynarr_add_many (dst, comstr, len);
4932 #endif /* ENABLE_COMPOSITE_CHARS */
4934 case ISO_ESC_LITERAL:
4935 DECODE_ADD_BINARY_CHAR (c, dst);
4939 /* Everything else handled already */
4944 /* Attempted error recovery. */
4945 if (str->iso2022.output_direction_sequence)
4946 ensure_correct_direction (flags & CODING_STATE_R2L ?
4947 CHARSET_RIGHT_TO_LEFT :
4948 CHARSET_LEFT_TO_RIGHT,
4949 str->codesys, dst, 0, 1);
4950 /* More error recovery. */
4951 if (!retval || str->iso2022.output_literally)
4953 /* Output the (possibly invalid) sequence */
4955 for (i = 0; i < str->iso2022.esc_bytes_index; i++)
4956 DECODE_ADD_BINARY_CHAR (str->iso2022.esc_bytes[i], dst);
4957 flags &= CODING_STATE_ISO2022_LOCK;
4959 n++, src--;/* Repeat the loop with the same character. */
4962 /* No sense in reprocessing the final byte of the
4963 escape sequence; it could mess things up anyway.
4965 DECODE_ADD_BINARY_CHAR (c, dst);
4970 else if (BYTE_C0_P (c) || BYTE_C1_P (c))
4971 { /* Control characters */
4973 /***** Error-handling *****/
4975 /* If we were in the middle of a character, dump out the
4976 partial character. */
4977 DECODE_OUTPUT_PARTIAL_CHAR (ch);
4979 /* If we just saw a single-shift character, dump it out.
4980 This may dump out the wrong sort of single-shift character,
4981 but least it will give an indication that something went
4983 if (flags & CODING_STATE_SS2)
4985 DECODE_ADD_BINARY_CHAR (ISO_CODE_SS2, dst);
4986 flags &= ~CODING_STATE_SS2;
4988 if (flags & CODING_STATE_SS3)
4990 DECODE_ADD_BINARY_CHAR (ISO_CODE_SS3, dst);
4991 flags &= ~CODING_STATE_SS3;
4994 /***** Now handle the control characters. *****/
4997 DECODE_HANDLE_EOL_TYPE (eol_type, c, flags, dst);
4999 flags &= CODING_STATE_ISO2022_LOCK;
5001 if (!parse_iso2022_esc (coding_system, &str->iso2022, c, &flags, 1))
5002 DECODE_ADD_BINARY_CHAR (c, dst);
5005 { /* Graphic characters */
5006 Lisp_Object charset;
5010 DECODE_HANDLE_EOL_TYPE (eol_type, c, flags, dst);
5012 /* Now determine the charset. */
5013 reg = ((flags & CODING_STATE_SS2) ? 2
5014 : (flags & CODING_STATE_SS3) ? 3
5015 : !BYTE_ASCII_P (c) ? str->iso2022.register_right
5016 : str->iso2022.register_left);
5017 charset = str->iso2022.charset[reg];
5019 /* Error checking: */
5020 if (! CHARSETP (charset)
5021 || str->iso2022.invalid_designated[reg]
5022 || (((c & 0x7F) == ' ' || (c & 0x7F) == ISO_CODE_DEL)
5023 && XCHARSET_CHARS (charset) == 94))
5024 /* Mrmph. We are trying to invoke a register that has no
5025 or an invalid charset in it, or trying to add a character
5026 outside the range of the charset. Insert that char literally
5027 to preserve it for the output. */
5029 DECODE_OUTPUT_PARTIAL_CHAR (ch);
5030 DECODE_ADD_BINARY_CHAR (c, dst);
5035 /* Things are probably hunky-dorey. */
5037 /* Fetch reverse charset, maybe. */
5038 if (((flags & CODING_STATE_R2L) &&
5039 XCHARSET_DIRECTION (charset) == CHARSET_LEFT_TO_RIGHT)
5041 (!(flags & CODING_STATE_R2L) &&
5042 XCHARSET_DIRECTION (charset) == CHARSET_RIGHT_TO_LEFT))
5044 Lisp_Object new_charset =
5045 XCHARSET_REVERSE_DIRECTION_CHARSET (charset);
5046 if (!NILP (new_charset))
5047 charset = new_charset;
5050 lb = XCHARSET_LEADING_BYTE (charset);
5051 switch (XCHARSET_REP_BYTES (charset))
5054 DECODE_OUTPUT_PARTIAL_CHAR (ch);
5055 Dynarr_add (dst, c & 0x7F);
5058 case 2: /* one-byte official */
5059 DECODE_OUTPUT_PARTIAL_CHAR (ch);
5060 Dynarr_add (dst, lb);
5061 Dynarr_add (dst, c | 0x80);
5064 case 3: /* one-byte private or two-byte official */
5065 if (XCHARSET_PRIVATE_P (charset))
5067 DECODE_OUTPUT_PARTIAL_CHAR (ch);
5068 Dynarr_add (dst, PRE_LEADING_BYTE_PRIVATE_1);
5069 Dynarr_add (dst, lb);
5070 Dynarr_add (dst, c | 0x80);
5076 Dynarr_add (dst, lb);
5077 Dynarr_add (dst, ch | 0x80);
5078 Dynarr_add (dst, c | 0x80);
5086 default: /* two-byte private */
5089 Dynarr_add (dst, PRE_LEADING_BYTE_PRIVATE_2);
5090 Dynarr_add (dst, lb);
5091 Dynarr_add (dst, ch | 0x80);
5092 Dynarr_add (dst, c | 0x80);
5101 flags &= CODING_STATE_ISO2022_LOCK;
5104 label_continue_loop:;
5107 if (flags & CODING_STATE_END)
5108 DECODE_OUTPUT_PARTIAL_CHAR (ch);
5115 /***** ISO2022 encoder *****/
5117 /* Designate CHARSET into register REG. */
5120 iso2022_designate (Lisp_Object charset, unsigned char reg,
5121 struct encoding_stream *str, unsigned_char_dynarr *dst)
5123 static const char inter94[] = "()*+";
5124 static const char inter96[] = ",-./";
5126 unsigned char final;
5127 Lisp_Object old_charset = str->iso2022.charset[reg];
5129 str->iso2022.charset[reg] = charset;
5130 if (!CHARSETP (charset))
5131 /* charset might be an initial nil or t. */
5133 type = XCHARSET_TYPE (charset);
5134 final = XCHARSET_FINAL (charset);
5135 if (!str->iso2022.force_charset_on_output[reg] &&
5136 CHARSETP (old_charset) &&
5137 XCHARSET_TYPE (old_charset) == type &&
5138 XCHARSET_FINAL (old_charset) == final)
5141 str->iso2022.force_charset_on_output[reg] = 0;
5144 charset_conversion_spec_dynarr *dyn =
5145 str->codesys->iso2022.output_conv;
5151 for (i = 0; i < Dynarr_length (dyn); i++)
5153 struct charset_conversion_spec *spec = Dynarr_atp (dyn, i);
5154 if (EQ (charset, spec->from_charset))
5155 charset = spec->to_charset;
5160 Dynarr_add (dst, ISO_CODE_ESC);
5163 case CHARSET_TYPE_94:
5164 Dynarr_add (dst, inter94[reg]);
5166 case CHARSET_TYPE_96:
5167 Dynarr_add (dst, inter96[reg]);
5169 case CHARSET_TYPE_94X94:
5170 Dynarr_add (dst, '$');
5172 || !(CODING_SYSTEM_ISO2022_SHORT (str->codesys))
5175 Dynarr_add (dst, inter94[reg]);
5177 case CHARSET_TYPE_96X96:
5178 Dynarr_add (dst, '$');
5179 Dynarr_add (dst, inter96[reg]);
5182 Dynarr_add (dst, final);
5186 ensure_normal_shift (struct encoding_stream *str, unsigned_char_dynarr *dst)
5188 if (str->iso2022.register_left != 0)
5190 Dynarr_add (dst, ISO_CODE_SI);
5191 str->iso2022.register_left = 0;
5196 ensure_shift_out (struct encoding_stream *str, unsigned_char_dynarr *dst)
5198 if (str->iso2022.register_left != 1)
5200 Dynarr_add (dst, ISO_CODE_SO);
5201 str->iso2022.register_left = 1;
5205 /* Convert internally-formatted data to ISO2022 format. */
5208 encode_coding_iso2022 (Lstream *encoding, const Bufbyte *src,
5209 unsigned_char_dynarr *dst, size_t n)
5211 unsigned char charmask, c;
5212 unsigned char char_boundary;
5213 struct encoding_stream *str = ENCODING_STREAM_DATA (encoding);
5214 unsigned int flags = str->flags;
5215 unsigned int ch = str->ch;
5216 Lisp_Coding_System *codesys = str->codesys;
5217 eol_type_t eol_type = CODING_SYSTEM_EOL_TYPE (str->codesys);
5219 Lisp_Object charset;
5222 #ifdef ENABLE_COMPOSITE_CHARS
5223 /* flags for handling composite chars. We do a little switcharoo
5224 on the source while we're outputting the composite char. */
5225 unsigned int saved_n = 0;
5226 const unsigned char *saved_src = NULL;
5227 int in_composite = 0;
5228 #endif /* ENABLE_COMPOSITE_CHARS */
5230 char_boundary = str->iso2022.current_char_boundary;
5231 charset = str->iso2022.current_charset;
5232 half = str->iso2022.current_half;
5234 #ifdef ENABLE_COMPOSITE_CHARS
5241 if (BYTE_ASCII_P (c))
5242 { /* Processing ASCII character */
5245 restore_left_to_right_direction (codesys, dst, &flags, 0);
5247 /* Make sure G0 contains ASCII */
5248 if ((c > ' ' && c < ISO_CODE_DEL) ||
5249 !CODING_SYSTEM_ISO2022_NO_ASCII_CNTL (codesys))
5251 ensure_normal_shift (str, dst);
5252 iso2022_designate (Vcharset_ascii, 0, str, dst);
5255 /* If necessary, restore everything to the default state
5258 !(CODING_SYSTEM_ISO2022_NO_ASCII_EOL (codesys)))
5260 restore_left_to_right_direction (codesys, dst, &flags, 0);
5262 ensure_normal_shift (str, dst);
5264 for (i = 0; i < 4; i++)
5266 Lisp_Object initial_charset =
5267 CODING_SYSTEM_ISO2022_INITIAL_CHARSET (codesys, i);
5268 iso2022_designate (initial_charset, i, str, dst);
5273 if (eol_type != EOL_LF && eol_type != EOL_AUTODETECT)
5274 Dynarr_add (dst, '\r');
5275 if (eol_type != EOL_CR)
5276 Dynarr_add (dst, c);
5280 if (CODING_SYSTEM_ISO2022_ESCAPE_QUOTED (codesys)
5281 && fit_to_be_escape_quoted (c))
5282 Dynarr_add (dst, ISO_CODE_ESC);
5283 Dynarr_add (dst, c);
5288 else if (BUFBYTE_LEADING_BYTE_P (c) || BUFBYTE_LEADING_BYTE_P (ch))
5289 { /* Processing Leading Byte */
5291 charset = CHARSET_BY_LEADING_BYTE (c);
5292 if (LEADING_BYTE_PREFIX_P(c))
5294 else if (!EQ (charset, Vcharset_control_1)
5295 #ifdef ENABLE_COMPOSITE_CHARS
5296 && !EQ (charset, Vcharset_composite)
5302 ensure_correct_direction (XCHARSET_DIRECTION (charset),
5303 codesys, dst, &flags, 0);
5305 /* Now determine which register to use. */
5307 for (i = 0; i < 4; i++)
5309 if (EQ (charset, str->iso2022.charset[i]) ||
5311 CODING_SYSTEM_ISO2022_INITIAL_CHARSET (codesys, i)))
5320 if (XCHARSET_GRAPHIC (charset) != 0)
5322 if (!NILP (str->iso2022.charset[1]) &&
5323 (!CODING_SYSTEM_ISO2022_SEVEN (codesys) ||
5324 CODING_SYSTEM_ISO2022_LOCK_SHIFT (codesys)))
5326 else if (!NILP (str->iso2022.charset[2]))
5328 else if (!NILP (str->iso2022.charset[3]))
5337 iso2022_designate (charset, reg, str, dst);
5339 /* Now invoke that register. */
5343 ensure_normal_shift (str, dst);
5348 if (CODING_SYSTEM_ISO2022_SEVEN (codesys))
5350 ensure_shift_out (str, dst);
5358 if (CODING_SYSTEM_ISO2022_SEVEN (str->codesys))
5360 Dynarr_add (dst, ISO_CODE_ESC);
5361 Dynarr_add (dst, 'N');
5366 Dynarr_add (dst, ISO_CODE_SS2);
5372 if (CODING_SYSTEM_ISO2022_SEVEN (str->codesys))
5374 Dynarr_add (dst, ISO_CODE_ESC);
5375 Dynarr_add (dst, 'O');
5380 Dynarr_add (dst, ISO_CODE_SS3);
5392 { /* Processing Non-ASCII character */
5393 charmask = (half == 0 ? 0x7F : 0xFF);
5395 if (EQ (charset, Vcharset_control_1))
5397 if (CODING_SYSTEM_ISO2022_ESCAPE_QUOTED (codesys)
5398 && fit_to_be_escape_quoted (c))
5399 Dynarr_add (dst, ISO_CODE_ESC);
5400 /* you asked for it ... */
5401 Dynarr_add (dst, c - 0x20);
5405 switch (XCHARSET_REP_BYTES (charset))
5408 Dynarr_add (dst, c & charmask);
5411 if (XCHARSET_PRIVATE_P (charset))
5413 Dynarr_add (dst, c & charmask);
5418 #ifdef ENABLE_COMPOSITE_CHARS
5419 if (EQ (charset, Vcharset_composite))
5423 /* #### Bother! We don't know how to
5425 Dynarr_add (dst, '~');
5429 Emchar emch = MAKE_CHAR (Vcharset_composite,
5430 ch & 0x7F, c & 0x7F);
5431 Lisp_Object lstr = composite_char_string (emch);
5435 src = XSTRING_DATA (lstr);
5436 n = XSTRING_LENGTH (lstr);
5437 Dynarr_add (dst, ISO_CODE_ESC);
5438 Dynarr_add (dst, '0'); /* start composing */
5442 #endif /* ENABLE_COMPOSITE_CHARS */
5444 Dynarr_add (dst, ch & charmask);
5445 Dynarr_add (dst, c & charmask);
5458 Dynarr_add (dst, ch & charmask);
5459 Dynarr_add (dst, c & charmask);
5475 #ifdef ENABLE_COMPOSITE_CHARS
5481 Dynarr_add (dst, ISO_CODE_ESC);
5482 Dynarr_add (dst, '1'); /* end composing */
5483 goto back_to_square_n; /* Wheeeeeeeee ..... */
5485 #endif /* ENABLE_COMPOSITE_CHARS */
5487 if (char_boundary && flags & CODING_STATE_END)
5489 restore_left_to_right_direction (codesys, dst, &flags, 0);
5490 ensure_normal_shift (str, dst);
5491 for (i = 0; i < 4; i++)
5493 Lisp_Object initial_charset =
5494 CODING_SYSTEM_ISO2022_INITIAL_CHARSET (codesys, i);
5495 iso2022_designate (initial_charset, i, str, dst);
5501 str->iso2022.current_char_boundary = char_boundary;
5502 str->iso2022.current_charset = charset;
5503 str->iso2022.current_half = half;
5505 /* Verbum caro factum est! */
5509 /************************************************************************/
5510 /* No-conversion methods */
5511 /************************************************************************/
5513 /* This is used when reading in "binary" files -- i.e. files that may
5514 contain all 256 possible byte values and that are not to be
5515 interpreted as being in any particular decoding. */
5517 decode_coding_no_conversion (Lstream *decoding, const Extbyte *src,
5518 unsigned_char_dynarr *dst, size_t n)
5520 struct decoding_stream *str = DECODING_STREAM_DATA (decoding);
5521 unsigned int flags = str->flags;
5522 unsigned int ch = str->ch;
5523 eol_type_t eol_type = str->eol_type;
5527 unsigned char c = *(unsigned char *)src++;
5529 DECODE_HANDLE_EOL_TYPE (eol_type, c, flags, dst);
5530 DECODE_ADD_BINARY_CHAR (c, dst);
5531 label_continue_loop:;
5534 DECODE_HANDLE_END_OF_CONVERSION (flags, ch, dst);
5541 encode_coding_no_conversion (Lstream *encoding, const Bufbyte *src,
5542 unsigned_char_dynarr *dst, size_t n)
5545 struct encoding_stream *str = ENCODING_STREAM_DATA (encoding);
5546 unsigned int flags = str->flags;
5547 unsigned int ch = str->ch;
5548 eol_type_t eol_type = CODING_SYSTEM_EOL_TYPE (str->codesys);
5555 if (eol_type != EOL_LF && eol_type != EOL_AUTODETECT)
5556 Dynarr_add (dst, '\r');
5557 if (eol_type != EOL_CR)
5558 Dynarr_add (dst, '\n');
5561 else if (BYTE_ASCII_P (c))
5564 Dynarr_add (dst, c);
5566 else if (BUFBYTE_LEADING_BYTE_P (c))
5569 if (c == LEADING_BYTE_LATIN_ISO8859_1 ||
5570 c == LEADING_BYTE_CONTROL_1)
5573 Dynarr_add (dst, '~'); /* untranslatable character */
5577 if (ch == LEADING_BYTE_LATIN_ISO8859_1)
5578 Dynarr_add (dst, c);
5579 else if (ch == LEADING_BYTE_CONTROL_1)
5582 Dynarr_add (dst, c - 0x20);
5584 /* else it should be the second or third byte of an
5585 untranslatable character, so ignore it */
5596 /************************************************************************/
5597 /* Initialization */
5598 /************************************************************************/
5601 syms_of_file_coding (void)
5603 INIT_LRECORD_IMPLEMENTATION (coding_system);
5605 DEFERROR_STANDARD (Qcoding_system_error, Qio_error);
5607 DEFSUBR (Fcoding_system_p);
5608 DEFSUBR (Ffind_coding_system);
5609 DEFSUBR (Fget_coding_system);
5610 DEFSUBR (Fcoding_system_list);
5611 DEFSUBR (Fcoding_system_name);
5612 DEFSUBR (Fmake_coding_system);
5613 DEFSUBR (Fcopy_coding_system);
5614 DEFSUBR (Fcoding_system_canonical_name_p);
5615 DEFSUBR (Fcoding_system_alias_p);
5616 DEFSUBR (Fcoding_system_aliasee);
5617 DEFSUBR (Fdefine_coding_system_alias);
5618 DEFSUBR (Fsubsidiary_coding_system);
5620 DEFSUBR (Fcoding_system_type);
5621 DEFSUBR (Fcoding_system_doc_string);
5623 DEFSUBR (Fcoding_system_charset);
5625 DEFSUBR (Fcoding_system_property);
5627 DEFSUBR (Fcoding_category_list);
5628 DEFSUBR (Fset_coding_priority_list);
5629 DEFSUBR (Fcoding_priority_list);
5630 DEFSUBR (Fset_coding_category_system);
5631 DEFSUBR (Fcoding_category_system);
5633 DEFSUBR (Fdetect_coding_region);
5634 DEFSUBR (Fdecode_coding_region);
5635 DEFSUBR (Fencode_coding_region);
5637 DEFSUBR (Fdecode_shift_jis_char);
5638 DEFSUBR (Fencode_shift_jis_char);
5639 DEFSUBR (Fdecode_big5_char);
5640 DEFSUBR (Fencode_big5_char);
5641 DEFSUBR (Fset_ucs_char);
5642 DEFSUBR (Fucs_char);
5643 DEFSUBR (Fset_char_ucs);
5644 DEFSUBR (Fchar_ucs);
5646 defsymbol (&Qcoding_systemp, "coding-system-p");
5647 defsymbol (&Qno_conversion, "no-conversion");
5648 defsymbol (&Qraw_text, "raw-text");
5650 defsymbol (&Qbig5, "big5");
5651 defsymbol (&Qshift_jis, "shift-jis");
5652 defsymbol (&Qucs4, "ucs-4");
5653 defsymbol (&Qutf8, "utf-8");
5654 defsymbol (&Qccl, "ccl");
5655 defsymbol (&Qiso2022, "iso2022");
5657 defsymbol (&Qmnemonic, "mnemonic");
5658 defsymbol (&Qeol_type, "eol-type");
5659 defsymbol (&Qpost_read_conversion, "post-read-conversion");
5660 defsymbol (&Qpre_write_conversion, "pre-write-conversion");
5662 defsymbol (&Qcr, "cr");
5663 defsymbol (&Qlf, "lf");
5664 defsymbol (&Qcrlf, "crlf");
5665 defsymbol (&Qeol_cr, "eol-cr");
5666 defsymbol (&Qeol_lf, "eol-lf");
5667 defsymbol (&Qeol_crlf, "eol-crlf");
5669 defsymbol (&Qcharset_g0, "charset-g0");
5670 defsymbol (&Qcharset_g1, "charset-g1");
5671 defsymbol (&Qcharset_g2, "charset-g2");
5672 defsymbol (&Qcharset_g3, "charset-g3");
5673 defsymbol (&Qforce_g0_on_output, "force-g0-on-output");
5674 defsymbol (&Qforce_g1_on_output, "force-g1-on-output");
5675 defsymbol (&Qforce_g2_on_output, "force-g2-on-output");
5676 defsymbol (&Qforce_g3_on_output, "force-g3-on-output");
5677 defsymbol (&Qno_iso6429, "no-iso6429");
5678 defsymbol (&Qinput_charset_conversion, "input-charset-conversion");
5679 defsymbol (&Qoutput_charset_conversion, "output-charset-conversion");
5681 defsymbol (&Qshort, "short");
5682 defsymbol (&Qno_ascii_eol, "no-ascii-eol");
5683 defsymbol (&Qno_ascii_cntl, "no-ascii-cntl");
5684 defsymbol (&Qseven, "seven");
5685 defsymbol (&Qlock_shift, "lock-shift");
5686 defsymbol (&Qescape_quoted, "escape-quoted");
5688 defsymbol (&Qencode, "encode");
5689 defsymbol (&Qdecode, "decode");
5692 defsymbol (&coding_category_symbol[CODING_CATEGORY_SHIFT_JIS],
5694 defsymbol (&coding_category_symbol[CODING_CATEGORY_BIG5],
5696 defsymbol (&coding_category_symbol[CODING_CATEGORY_UCS4],
5698 defsymbol (&coding_category_symbol[CODING_CATEGORY_UTF8],
5700 defsymbol (&coding_category_symbol[CODING_CATEGORY_ISO_7],
5702 defsymbol (&coding_category_symbol[CODING_CATEGORY_ISO_8_DESIGNATE],
5704 defsymbol (&coding_category_symbol[CODING_CATEGORY_ISO_8_1],
5706 defsymbol (&coding_category_symbol[CODING_CATEGORY_ISO_8_2],
5708 defsymbol (&coding_category_symbol[CODING_CATEGORY_ISO_LOCK_SHIFT],
5711 defsymbol (&coding_category_symbol[CODING_CATEGORY_NO_CONVERSION],
5716 lstream_type_create_file_coding (void)
5718 LSTREAM_HAS_METHOD (decoding, reader);
5719 LSTREAM_HAS_METHOD (decoding, writer);
5720 LSTREAM_HAS_METHOD (decoding, rewinder);
5721 LSTREAM_HAS_METHOD (decoding, seekable_p);
5722 LSTREAM_HAS_METHOD (decoding, flusher);
5723 LSTREAM_HAS_METHOD (decoding, closer);
5724 LSTREAM_HAS_METHOD (decoding, marker);
5726 LSTREAM_HAS_METHOD (encoding, reader);
5727 LSTREAM_HAS_METHOD (encoding, writer);
5728 LSTREAM_HAS_METHOD (encoding, rewinder);
5729 LSTREAM_HAS_METHOD (encoding, seekable_p);
5730 LSTREAM_HAS_METHOD (encoding, flusher);
5731 LSTREAM_HAS_METHOD (encoding, closer);
5732 LSTREAM_HAS_METHOD (encoding, marker);
5736 vars_of_file_coding (void)
5740 fcd = xnew (struct file_coding_dump);
5741 dump_add_root_struct_ptr (&fcd, &fcd_description);
5743 /* Initialize to something reasonable ... */
5744 for (i = 0; i < CODING_CATEGORY_LAST; i++)
5746 fcd->coding_category_system[i] = Qnil;
5747 fcd->coding_category_by_priority[i] = i;
5750 Fprovide (intern ("file-coding"));
5752 DEFVAR_LISP ("keyboard-coding-system", &Vkeyboard_coding_system /*
5753 Coding system used for TTY keyboard input.
5754 Not used under a windowing system.
5756 Vkeyboard_coding_system = Qnil;
5758 DEFVAR_LISP ("terminal-coding-system", &Vterminal_coding_system /*
5759 Coding system used for TTY display output.
5760 Not used under a windowing system.
5762 Vterminal_coding_system = Qnil;
5764 DEFVAR_LISP ("coding-system-for-read", &Vcoding_system_for_read /*
5765 Overriding coding system used when reading from a file or process.
5766 You should bind this variable with `let', but do not set it globally.
5767 If this is non-nil, it specifies the coding system that will be used
5768 to decode input on read operations, such as from a file or process.
5769 It overrides `buffer-file-coding-system-for-read',
5770 `insert-file-contents-pre-hook', etc. Use those variables instead of
5771 this one for permanent changes to the environment. */ );
5772 Vcoding_system_for_read = Qnil;
5774 DEFVAR_LISP ("coding-system-for-write",
5775 &Vcoding_system_for_write /*
5776 Overriding coding system used when writing to a file or process.
5777 You should bind this variable with `let', but do not set it globally.
5778 If this is non-nil, it specifies the coding system that will be used
5779 to encode output for write operations, such as to a file or process.
5780 It overrides `buffer-file-coding-system', `write-region-pre-hook', etc.
5781 Use those variables instead of this one for permanent changes to the
5783 Vcoding_system_for_write = Qnil;
5785 DEFVAR_LISP ("file-name-coding-system", &Vfile_name_coding_system /*
5786 Coding system used to convert pathnames when accessing files.
5788 Vfile_name_coding_system = Qnil;
5790 DEFVAR_BOOL ("enable-multibyte-characters", &enable_multibyte_characters /*
5791 Non-nil means the buffer contents are regarded as multi-byte form
5792 of characters, not a binary code. This affects the display, file I/O,
5793 and behaviors of various editing commands.
5795 Setting this to nil does not do anything.
5797 enable_multibyte_characters = 1;
5801 complex_vars_of_file_coding (void)
5803 staticpro (&Vcoding_system_hash_table);
5804 Vcoding_system_hash_table =
5805 make_lisp_hash_table (50, HASH_TABLE_NON_WEAK, HASH_TABLE_EQ);
5807 the_codesys_prop_dynarr = Dynarr_new (codesys_prop);
5808 dump_add_root_struct_ptr (&the_codesys_prop_dynarr, &codesys_prop_dynarr_description);
5810 #define DEFINE_CODESYS_PROP(Prop_Type, Sym) do \
5812 struct codesys_prop csp; \
5814 csp.prop_type = (Prop_Type); \
5815 Dynarr_add (the_codesys_prop_dynarr, csp); \
5818 DEFINE_CODESYS_PROP (CODESYS_PROP_ALL_OK, Qmnemonic);
5819 DEFINE_CODESYS_PROP (CODESYS_PROP_ALL_OK, Qeol_type);
5820 DEFINE_CODESYS_PROP (CODESYS_PROP_ALL_OK, Qeol_cr);
5821 DEFINE_CODESYS_PROP (CODESYS_PROP_ALL_OK, Qeol_crlf);
5822 DEFINE_CODESYS_PROP (CODESYS_PROP_ALL_OK, Qeol_lf);
5823 DEFINE_CODESYS_PROP (CODESYS_PROP_ALL_OK, Qpost_read_conversion);
5824 DEFINE_CODESYS_PROP (CODESYS_PROP_ALL_OK, Qpre_write_conversion);
5826 DEFINE_CODESYS_PROP (CODESYS_PROP_ISO2022, Qcharset_g0);
5827 DEFINE_CODESYS_PROP (CODESYS_PROP_ISO2022, Qcharset_g1);
5828 DEFINE_CODESYS_PROP (CODESYS_PROP_ISO2022, Qcharset_g2);
5829 DEFINE_CODESYS_PROP (CODESYS_PROP_ISO2022, Qcharset_g3);
5830 DEFINE_CODESYS_PROP (CODESYS_PROP_ISO2022, Qforce_g0_on_output);
5831 DEFINE_CODESYS_PROP (CODESYS_PROP_ISO2022, Qforce_g1_on_output);
5832 DEFINE_CODESYS_PROP (CODESYS_PROP_ISO2022, Qforce_g2_on_output);
5833 DEFINE_CODESYS_PROP (CODESYS_PROP_ISO2022, Qforce_g3_on_output);
5834 DEFINE_CODESYS_PROP (CODESYS_PROP_ISO2022, Qshort);
5835 DEFINE_CODESYS_PROP (CODESYS_PROP_ISO2022, Qno_ascii_eol);
5836 DEFINE_CODESYS_PROP (CODESYS_PROP_ISO2022, Qno_ascii_cntl);
5837 DEFINE_CODESYS_PROP (CODESYS_PROP_ISO2022, Qseven);
5838 DEFINE_CODESYS_PROP (CODESYS_PROP_ISO2022, Qlock_shift);
5839 DEFINE_CODESYS_PROP (CODESYS_PROP_ISO2022, Qno_iso6429);
5840 DEFINE_CODESYS_PROP (CODESYS_PROP_ISO2022, Qescape_quoted);
5841 DEFINE_CODESYS_PROP (CODESYS_PROP_ISO2022, Qinput_charset_conversion);
5842 DEFINE_CODESYS_PROP (CODESYS_PROP_ISO2022, Qoutput_charset_conversion);
5844 DEFINE_CODESYS_PROP (CODESYS_PROP_CCL, Qencode);
5845 DEFINE_CODESYS_PROP (CODESYS_PROP_CCL, Qdecode);
5847 /* Need to create this here or we're really screwed. */
5849 (Qraw_text, Qno_conversion,
5850 build_string ("Raw text, which means it converts only line-break-codes."),
5851 list2 (Qmnemonic, build_string ("Raw")));
5854 (Qbinary, Qno_conversion,
5855 build_string ("Binary, which means it does not convert anything."),
5856 list4 (Qeol_type, Qlf,
5857 Qmnemonic, build_string ("Binary")));
5859 Fdefine_coding_system_alias (Qno_conversion, Qraw_text);
5861 Fdefine_coding_system_alias (Qfile_name, Qbinary);
5863 Fdefine_coding_system_alias (Qterminal, Qbinary);
5864 Fdefine_coding_system_alias (Qkeyboard, Qbinary);
5866 /* Need this for bootstrapping */
5867 fcd->coding_category_system[CODING_CATEGORY_NO_CONVERSION] =
5868 Fget_coding_system (Qraw_text);
5874 for (i = 0; i < countof (fcd->ucs_to_mule_table); i++)
5875 fcd->ucs_to_mule_table[i] = Qnil;
5877 staticpro (&mule_to_ucs_table);
5878 mule_to_ucs_table = Fmake_char_table(Qgeneric);