coding.c 183 KB
Newer Older
Karl Heuer's avatar
Karl Heuer committed
1
/* Coding system handler (conversion, detection, and etc).
Richard M. Stallman's avatar
Richard M. Stallman committed
2
   Copyright (C) 1995, 1997, 1998 Electrotechnical Laboratory, JAPAN.
3
   Licensed to the Free Software Foundation.
Karl Heuer's avatar
Karl Heuer committed
4

Karl Heuer's avatar
Karl Heuer committed
5 6 7 8 9 10
This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
Karl Heuer's avatar
Karl Heuer committed
11

Karl Heuer's avatar
Karl Heuer committed
12 13 14 15
GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
Karl Heuer's avatar
Karl Heuer committed
16

Karl Heuer's avatar
Karl Heuer committed
17 18 19 20
You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Karl Heuer's avatar
Karl Heuer committed
21 22 23 24

/*** TABLE OF CONTENTS ***

  1. Preamble
Kenichi Handa's avatar
Kenichi Handa committed
25
  2. Emacs' internal format (emacs-mule) handlers
Karl Heuer's avatar
Karl Heuer committed
26 27
  3. ISO2022 handlers
  4. Shift-JIS and BIG5 handlers
Kenichi Handa's avatar
Kenichi Handa committed
28 29 30 31 32
  5. CCL handlers
  6. End-of-line handlers
  7. C library functions
  8. Emacs Lisp library functions
  9. Post-amble
Karl Heuer's avatar
Karl Heuer committed
33 34 35 36 37 38 39 40

*/

/*** GENERAL NOTE on CODING SYSTEM ***

  Coding system is an encoding mechanism of one or more character
  sets.  Here's a list of coding systems which Emacs can handle.  When
  we say "decode", it means converting some other coding system to
Kenichi Handa's avatar
Kenichi Handa committed
41 42 43
  Emacs' internal format (emacs-internal), and when we say "encode",
  it means converting the coding system emacs-mule to some other
  coding system.
Karl Heuer's avatar
Karl Heuer committed
44

Kenichi Handa's avatar
Kenichi Handa committed
45
  0. Emacs' internal format (emacs-mule)
Karl Heuer's avatar
Karl Heuer committed
46 47

  Emacs itself holds a multi-lingual character in a buffer and a string
Richard M. Stallman's avatar
Richard M. Stallman committed
48
  in a special format.  Details are described in section 2.
Karl Heuer's avatar
Karl Heuer committed
49 50 51 52

  1. ISO2022

  The most famous coding system for multiple character sets.  X's
Richard M. Stallman's avatar
Richard M. Stallman committed
53 54 55
  Compound Text, various EUCs (Extended Unix Code), and coding
  systems used in Internet communication such as ISO-2022-JP are
  all variants of ISO2022.  Details are described in section 3.
Karl Heuer's avatar
Karl Heuer committed
56 57 58 59 60

  2. SJIS (or Shift-JIS or MS-Kanji-Code)
   
  A coding system to encode character sets: ASCII, JISX0201, and
  JISX0208.  Widely used for PC's in Japan.  Details are described in
Richard M. Stallman's avatar
Richard M. Stallman committed
61
  section 4.
Karl Heuer's avatar
Karl Heuer committed
62 63 64 65 66

  3. BIG5

  A coding system to encode character sets: ASCII and Big5.  Widely
  used by Chinese (mainly in Taiwan and Hong Kong).  Details are
Richard M. Stallman's avatar
Richard M. Stallman committed
67 68 69
  described in section 4.  In this file, when we write "BIG5"
  (all uppercase), we mean the coding system, and when we write
  "Big5" (capitalized), we mean the character set.
Karl Heuer's avatar
Karl Heuer committed
70

71 72
  4. Raw text

73 74
  A coding system for a text containing random 8-bit code.  Emacs does
  no code conversion on such a text except for end-of-line format.
75 76

  5. Other
Karl Heuer's avatar
Karl Heuer committed
77

Richard M. Stallman's avatar
Richard M. Stallman committed
78
  If a user wants to read/write a text encoded in a coding system not
Karl Heuer's avatar
Karl Heuer committed
79 80 81 82
  listed above, he can supply a decoder and an encoder for it in CCL
  (Code Conversion Language) programs.  Emacs executes the CCL program
  while reading/writing.

83 84
  Emacs represents a coding system by a Lisp symbol that has a property
  `coding-system'.  But, before actually using the coding system, the
Karl Heuer's avatar
Karl Heuer committed
85
  information about it is set in a structure of type `struct
Richard M. Stallman's avatar
Richard M. Stallman committed
86
  coding_system' for rapid processing.  See section 6 for more details.
Karl Heuer's avatar
Karl Heuer committed
87 88 89 90 91 92 93

*/

/*** GENERAL NOTES on END-OF-LINE FORMAT ***

  How end-of-line of a text is encoded depends on a system.  For
  instance, Unix's format is just one byte of `line-feed' code,
Richard M. Stallman's avatar
Richard M. Stallman committed
94
  whereas DOS's format is two-byte sequence of `carriage-return' and
95 96
  `line-feed' codes.  MacOS's format is usually one byte of
  `carriage-return'.
Karl Heuer's avatar
Karl Heuer committed
97

Richard M. Stallman's avatar
Richard M. Stallman committed
98 99
  Since text characters encoding and end-of-line encoding are
  independent, any coding system described above can take
Karl Heuer's avatar
Karl Heuer committed
100
  any format of end-of-line.  So, Emacs has information of format of
Richard M. Stallman's avatar
Richard M. Stallman committed
101
  end-of-line in each coding-system.  See section 6 for more details.
Karl Heuer's avatar
Karl Heuer committed
102 103 104 105 106 107 108 109 110 111 112 113

*/

/*** GENERAL NOTES on `detect_coding_XXX ()' functions ***

  These functions check if a text between SRC and SRC_END is encoded
  in the coding system category XXX.  Each returns an integer value in
  which appropriate flag bits for the category XXX is set.  The flag
  bits are defined in macros CODING_CATEGORY_MASK_XXX.  Below is the
  template of these functions.  */
#if 0
int
Kenichi Handa's avatar
Kenichi Handa committed
114
detect_coding_emacs_mule (src, src_end)
Karl Heuer's avatar
Karl Heuer committed
115 116 117 118 119 120 121 122 123
     unsigned char *src, *src_end;
{
  ...
}
#endif

/*** GENERAL NOTES on `decode_coding_XXX ()' functions ***

  These functions decode SRC_BYTES length text at SOURCE encoded in
Kenichi Handa's avatar
Kenichi Handa committed
124
  CODING to Emacs' internal format (emacs-mule).  The resulting text
125 126 127 128 129 130 131 132 133 134 135 136 137
  goes to a place pointed to by DESTINATION, the length of which
  should not exceed DST_BYTES.  These functions set the information of
  original and decoded texts in the members produced, produced_char,
  consumed, and consumed_char of the structure *CODING.

  The return value is an integer (CODING_FINISH_XXX) indicating how
  the decoding finished.

  DST_BYTES zero means that source area and destination area are
  overlapped, which means that we can produce a decoded text until it
  reaches at the head of not-yet-decoded source text.

  Below is a template of these functions.  */
Karl Heuer's avatar
Karl Heuer committed
138
#if 0
139
decode_coding_XXX (coding, source, destination, src_bytes, dst_bytes)
Karl Heuer's avatar
Karl Heuer committed
140 141 142 143 144 145 146 147 148 149
     struct coding_system *coding;
     unsigned char *source, *destination;
     int src_bytes, dst_bytes;
{
  ...
}
#endif

/*** GENERAL NOTES on `encode_coding_XXX ()' functions ***

Kenichi Handa's avatar
Kenichi Handa committed
150 151
  These functions encode SRC_BYTES length text at SOURCE of Emacs'
  internal format (emacs-mule) to CODING.  The resulting text goes to
Richard M. Stallman's avatar
Richard M. Stallman committed
152
  a place pointed to by DESTINATION, the length of which should not
153 154 155 156 157 158 159 160 161 162 163 164
  exceed DST_BYTES.  These functions set the information of
  original and encoded texts in the members produced, produced_char,
  consumed, and consumed_char of the structure *CODING.

  The return value is an integer (CODING_FINISH_XXX) indicating how
  the encoding finished.

  DST_BYTES zero means that source area and destination area are
  overlapped, which means that we can produce a decoded text until it
  reaches at the head of not-yet-decoded source text.

  Below is a template of these functions.  */
Karl Heuer's avatar
Karl Heuer committed
165
#if 0
166
encode_coding_XXX (coding, source, destination, src_bytes, dst_bytes)
Karl Heuer's avatar
Karl Heuer committed
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
     struct coding_system *coding;
     unsigned char *source, *destination;
     int src_bytes, dst_bytes;
{
  ...
}
#endif

/*** COMMONLY USED MACROS ***/

/* The following three macros ONE_MORE_BYTE, TWO_MORE_BYTES, and
   THREE_MORE_BYTES safely get one, two, and three bytes from the
   source text respectively.  If there are not enough bytes in the
   source, they jump to `label_end_of_loop'.  The caller should set
   variables `src' and `src_end' to appropriate areas in advance.  */

#define ONE_MORE_BYTE(c1)   	\
  do {			     	\
    if (src < src_end)	     	\
      c1 = *src++;	     	\
    else		     	\
      goto label_end_of_loop;	\
  } while (0)

#define TWO_MORE_BYTES(c1, c2) 	\
  do {			       	\
    if (src + 1 < src_end)     	\
      c1 = *src++, c2 = *src++;	\
    else		       	\
      goto label_end_of_loop;  	\
  } while (0)

#define THREE_MORE_BYTES(c1, c2, c3)	    	\
  do {					    	\
    if (src + 2 < src_end)		    	\
      c1 = *src++, c2 = *src++, c3 = *src++;	\
    else				    	\
      goto label_end_of_loop;		    	\
  } while (0)

/* The following three macros DECODE_CHARACTER_ASCII,
   DECODE_CHARACTER_DIMENSION1, and DECODE_CHARACTER_DIMENSION2 put
   the multi-byte form of a character of each class at the place
   pointed by `dst'.  The caller should set the variable `dst' to
   point to an appropriate area and the variable `coding' to point to
   the coding-system of the currently decoding text in advance.  */

/* Decode one ASCII character C.  */

216 217 218 219 220 221
#define DECODE_CHARACTER_ASCII(c)		\
  do {						\
    if (COMPOSING_P (coding->composing))	\
      {						\
	*dst++ = 0xA0, *dst++ = (c) | 0x80;	\
	coding->composed_chars++;		\
222 223
	if (((c) | 0x80) < 0xA0)		\
	  coding->fake_multibyte = 1;		\
224 225 226
      }						\
    else					\
      {						\
227 228 229
	/* If ASCII charset is invoked to GR,	\
	   we must reset MSB now.  */		\
	*dst++ = (c) & 0x7F;			\
230 231
	coding->produced_char++;		\
      }						\
Karl Heuer's avatar
Karl Heuer committed
232 233
  } while (0)

Richard M. Stallman's avatar
Richard M. Stallman committed
234
/* Decode one DIMENSION1 character whose charset is CHARSET and whose
Karl Heuer's avatar
Karl Heuer committed
235 236 237 238 239 240
   position-code is C.  */

#define DECODE_CHARACTER_DIMENSION1(charset, c)				\
  do {									\
    unsigned char leading_code = CHARSET_LEADING_CODE_BASE (charset);	\
    if (COMPOSING_P (coding->composing))				\
241 242 243 244
      {									\
	*dst++ = leading_code + 0x20;					\
	coding->composed_chars++;					\
      }									\
Karl Heuer's avatar
Karl Heuer committed
245
    else								\
246 247 248 249
      {									\
	*dst++ = leading_code;						\
	coding->produced_char++;					\
      }									\
Karl Heuer's avatar
Karl Heuer committed
250 251 252
    if (leading_code = CHARSET_LEADING_CODE_EXT (charset))		\
      *dst++ = leading_code;						\
    *dst++ = (c) | 0x80;						\
253 254
    if (((c) | 0x80)  < 0xA0)						\
      coding->fake_multibyte = 1; 					\
Karl Heuer's avatar
Karl Heuer committed
255 256
  } while (0)

Richard M. Stallman's avatar
Richard M. Stallman committed
257
/* Decode one DIMENSION2 character whose charset is CHARSET and whose
Karl Heuer's avatar
Karl Heuer committed
258 259 260 261 262 263
   position-codes are C1 and C2.  */

#define DECODE_CHARACTER_DIMENSION2(charset, c1, c2)	\
  do {							\
    DECODE_CHARACTER_DIMENSION1 (charset, c1);		\
    *dst++ = (c2) | 0x80;				\
264 265
    if (((c2) | 0x80) < 0xA0)				\
      coding->fake_multibyte = 1;			\
Karl Heuer's avatar
Karl Heuer committed
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
  } while (0)


/*** 1. Preamble ***/

#include <stdio.h>

#ifdef emacs

#include <config.h>
#include "lisp.h"
#include "buffer.h"
#include "charset.h"
#include "ccl.h"
#include "coding.h"
#include "window.h"

#else  /* not emacs */

#include "mulelib.h"

#endif /* not emacs */

Lisp_Object Qcoding_system, Qeol_type;
Lisp_Object Qbuffer_file_coding_system;
Lisp_Object Qpost_read_conversion, Qpre_write_conversion;
292
Lisp_Object Qno_conversion, Qundecided;
293
Lisp_Object Qcoding_system_history;
294
Lisp_Object Qsafe_charsets;
Kenichi Handa's avatar
Kenichi Handa committed
295
Lisp_Object Qvalid_codes;
Karl Heuer's avatar
Karl Heuer committed
296 297 298 299 300 301

extern Lisp_Object Qinsert_file_contents, Qwrite_region;
Lisp_Object Qcall_process, Qcall_process_region, Qprocess_argument;
Lisp_Object Qstart_process, Qopen_network_stream;
Lisp_Object Qtarget_idx;

302 303
Lisp_Object Vselect_safe_coding_system_function;

304 305 306
/* Mnemonic string for each format of end-of-line.  */
Lisp_Object eol_mnemonic_unix, eol_mnemonic_dos, eol_mnemonic_mac;
/* Mnemonic string to indicate format of end-of-line is not yet
Karl Heuer's avatar
Karl Heuer committed
307
   decided.  */
308
Lisp_Object eol_mnemonic_undecided;
Karl Heuer's avatar
Karl Heuer committed
309

310 311 312 313
/* Format of end-of-line decided by system.  This is CODING_EOL_LF on
   Unix, CODING_EOL_CRLF on DOS/Windows, and CODING_EOL_CR on Mac.  */
int system_eol_type;

Karl Heuer's avatar
Karl Heuer committed
314 315
#ifdef emacs

316 317 318
Lisp_Object Vcoding_system_list, Vcoding_system_alist;

Lisp_Object Qcoding_system_p, Qcoding_system_error;
Karl Heuer's avatar
Karl Heuer committed
319

320 321 322
/* Coding system emacs-mule and raw-text are for converting only
   end-of-line format.  */
Lisp_Object Qemacs_mule, Qraw_text;
323

Karl Heuer's avatar
Karl Heuer committed
324 325 326 327 328 329 330 331 332
/* Coding-systems are handed between Emacs Lisp programs and C internal
   routines by the following three variables.  */
/* Coding-system for reading files and receiving data from process.  */
Lisp_Object Vcoding_system_for_read;
/* Coding-system for writing files and sending data to process.  */
Lisp_Object Vcoding_system_for_write;
/* Coding-system actually used in the latest I/O.  */
Lisp_Object Vlast_coding_system_used;

333
/* A vector of length 256 which contains information about special
Karl Heuer's avatar
Karl Heuer committed
334
   Latin codes (especially for dealing with Microsoft codes).  */
335
Lisp_Object Vlatin_extra_code_table;
336

337 338 339
/* Flag to inhibit code conversion of end-of-line format.  */
int inhibit_eol_conversion;

340 341 342
/* Flag to make buffer-file-coding-system inherit from process-coding.  */
int inherit_process_coding_system;

343
/* Coding system to be used to encode text for terminal display.  */
Karl Heuer's avatar
Karl Heuer committed
344 345
struct coding_system terminal_coding;

346 347 348 349 350
/* Coding system to be used to encode text for terminal display when
   terminal coding system is nil.  */
struct coding_system safe_terminal_coding;

/* Coding system of what is sent from terminal keyboard.  */
Karl Heuer's avatar
Karl Heuer committed
351 352
struct coding_system keyboard_coding;

353 354 355
/* Default coding system to be used to write a file.  */
struct coding_system default_buffer_file_coding;

356 357 358
Lisp_Object Vfile_coding_system_alist;
Lisp_Object Vprocess_coding_system_alist;
Lisp_Object Vnetwork_coding_system_alist;
Karl Heuer's avatar
Karl Heuer committed
359 360 361

#endif /* emacs */

362
Lisp_Object Qcoding_category, Qcoding_category_index;
Karl Heuer's avatar
Karl Heuer committed
363 364 365 366

/* List of symbols `coding-category-xxx' ordered by priority.  */
Lisp_Object Vcoding_category_list;

367 368
/* Table of coding categories (Lisp symbols).  */
Lisp_Object Vcoding_category_table;
Karl Heuer's avatar
Karl Heuer committed
369 370 371

/* Table of names of symbol for each coding-category.  */
char *coding_category_name[CODING_CATEGORY_IDX_MAX] = {
Kenichi Handa's avatar
Kenichi Handa committed
372
  "coding-category-emacs-mule",
Karl Heuer's avatar
Karl Heuer committed
373 374
  "coding-category-sjis",
  "coding-category-iso-7",
375
  "coding-category-iso-7-tight",
Karl Heuer's avatar
Karl Heuer committed
376 377
  "coding-category-iso-8-1",
  "coding-category-iso-8-2",
378 379
  "coding-category-iso-7-else",
  "coding-category-iso-8-else",
380
  "coding-category-ccl",
Karl Heuer's avatar
Karl Heuer committed
381
  "coding-category-big5",
382
  "coding-category-raw-text",
383
  "coding-category-binary"
Karl Heuer's avatar
Karl Heuer committed
384 385
};

386
/* Table of pointers to coding systems corresponding to each coding
387 388 389
   categories.  */
struct coding_system *coding_system_table[CODING_CATEGORY_IDX_MAX];

390 391 392 393 394
/* Table of coding category masks.  Nth element is a mask for a coding
   cateogry of which priority is Nth.  */
static
int coding_priorities[CODING_CATEGORY_IDX_MAX];

395 396
/* Flag to tell if we look up translation table on character code
   conversion.  */
397
Lisp_Object Venable_character_translation;
398 399 400 401
/* Standard translation table to look up on decoding (reading).  */
Lisp_Object Vstandard_translation_table_for_decode;
/* Standard translation table to look up on encoding (writing).  */
Lisp_Object Vstandard_translation_table_for_encode;
402

403 404 405 406
Lisp_Object Qtranslation_table;
Lisp_Object Qtranslation_table_id;
Lisp_Object Qtranslation_table_for_decode;
Lisp_Object Qtranslation_table_for_encode;
Karl Heuer's avatar
Karl Heuer committed
407 408 409 410

/* Alist of charsets vs revision number.  */
Lisp_Object Vcharset_revision_alist;

411 412 413
/* Default coding systems used for process I/O.  */
Lisp_Object Vdefault_process_coding_system;

414 415 416 417 418 419
/* Global flag to tell that we can't call post-read-conversion and
   pre-write-conversion functions.  Usually the value is zero, but it
   is set to 1 temporarily while such functions are running.  This is
   to avoid infinite recursive call.  */
static int inhibit_pre_post_conversion;

Karl Heuer's avatar
Karl Heuer committed
420

Kenichi Handa's avatar
Kenichi Handa committed
421
/*** 2. Emacs internal format (emacs-mule) handlers ***/
Karl Heuer's avatar
Karl Heuer committed
422 423

/* Emacs' internal format for encoding multiple character sets is a
Richard M. Stallman's avatar
Richard M. Stallman committed
424 425 426 427 428 429 430 431 432 433 434 435 436
   kind of multi-byte encoding, i.e. characters are encoded by
   variable-length sequences of one-byte codes.  ASCII characters
   and control characters (e.g. `tab', `newline') are represented by
   one-byte sequences which are their ASCII codes, in the range 0x00
   through 0x7F.  The other characters are represented by a sequence
   of `base leading-code', optional `extended leading-code', and one
   or two `position-code's.  The length of the sequence is determined
   by the base leading-code.  Leading-code takes the range 0x80
   through 0x9F, whereas extended leading-code and position-code take
   the range 0xA0 through 0xFF.  See `charset.h' for more details
   about leading-code and position-code.

   There's one exception to this rule.  Special leading-code
Karl Heuer's avatar
Karl Heuer committed
437 438 439 440
   `leading-code-composition' denotes that the following several
   characters should be composed into one character.  Leading-codes of
   components (except for ASCII) are added 0x20.  An ASCII character
   component is represented by a 2-byte sequence of `0xA0' and
Richard M. Stallman's avatar
Richard M. Stallman committed
441 442
   `ASCII-code + 0x80'.  See also the comments in `charset.h' for the
   details of composite character.  Hence, we can summarize the code
Karl Heuer's avatar
Karl Heuer committed
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
   range as follows:

   --- CODE RANGE of Emacs' internal format ---
   (character set)	(range)
   ASCII		0x00 .. 0x7F
   ELSE (1st byte)	0x80 .. 0x9F
	(rest bytes)	0xA0 .. 0xFF
   ---------------------------------------------

  */

enum emacs_code_class_type emacs_code_class[256];

/* Go to the next statement only if *SRC is accessible and the code is
   greater than 0xA0.  */
#define CHECK_CODE_RANGE_A0_FF 	\
  do {			       	\
    if (src >= src_end)	       	\
      goto label_end_of_switch;	\
    else if (*src++ < 0xA0)    	\
      return 0;		       	\
  } while (0)

/* See the above "GENERAL NOTES on `detect_coding_XXX ()' functions".
   Check if a text is encoded in Emacs' internal format.  If it is,
468
   return CODING_CATEGORY_MASK_EMACS_MULE, else return 0.  */
Karl Heuer's avatar
Karl Heuer committed
469 470

int
Kenichi Handa's avatar
Kenichi Handa committed
471
detect_coding_emacs_mule (src, src_end)
Karl Heuer's avatar
Karl Heuer committed
472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526
     unsigned char *src, *src_end;
{
  unsigned char c;
  int composing = 0;

  while (src < src_end)
    {
      c = *src++;

      if (composing)
	{
	  if (c < 0xA0)
	    composing = 0;
	  else
	    c -= 0x20;
	}

      switch (emacs_code_class[c])
	{
	case EMACS_ascii_code:
	case EMACS_linefeed_code:
	  break;

	case EMACS_control_code:
	  if (c == ISO_CODE_ESC || c == ISO_CODE_SI || c == ISO_CODE_SO)
	    return 0;
	  break;

	case EMACS_invalid_code:
	  return 0;

	case EMACS_leading_code_composition: /* c == 0x80 */
	  if (composing)
	    CHECK_CODE_RANGE_A0_FF;
	  else
	    composing = 1;
	  break;

	case EMACS_leading_code_4:
	  CHECK_CODE_RANGE_A0_FF;
	  /* fall down to check it two more times ...  */

	case EMACS_leading_code_3:
	  CHECK_CODE_RANGE_A0_FF;
	  /* fall down to check it one more time ...  */

	case EMACS_leading_code_2:
	  CHECK_CODE_RANGE_A0_FF;
	  break;

	default:
	label_end_of_switch:
	  break;
	}
    }
Kenichi Handa's avatar
Kenichi Handa committed
527
  return CODING_CATEGORY_MASK_EMACS_MULE;
Karl Heuer's avatar
Karl Heuer committed
528 529 530 531 532 533
}


/*** 3. ISO2022 handlers ***/

/* The following note describes the coding system ISO2022 briefly.
534 535 536
   Since the intention of this note is to help understand the
   functions in this file, some parts are NOT ACCURATE or OVERLY
   SIMPLIFIED.  For thorough understanding, please refer to the
Karl Heuer's avatar
Karl Heuer committed
537 538 539
   original document of ISO2022.

   ISO2022 provides many mechanisms to encode several character sets
540 541 542 543 544 545
   in 7-bit and 8-bit environments.  For 7-bite environments, all text
   is encoded using bytes less than 128.  This may make the encoded
   text a little bit longer, but the text passes more easily through
   several gateways, some of which strip off MSB (Most Signigant Bit).
 
   There are two kinds of character sets: control character set and
Karl Heuer's avatar
Karl Heuer committed
546 547
   graphic character set.  The former contains control characters such
   as `newline' and `escape' to provide control functions (control
548 549
   functions are also provided by escape sequences).  The latter
   contains graphic characters such as 'A' and '-'.  Emacs recognizes
Karl Heuer's avatar
Karl Heuer committed
550 551 552
   two control character sets and many graphic character sets.

   Graphic character sets are classified into one of the following
553 554 555 556 557 558 559 560 561 562 563 564
   four classes, according to the number of bytes (DIMENSION) and
   number of characters in one dimension (CHARS) of the set:
   - DIMENSION1_CHARS94
   - DIMENSION1_CHARS96
   - DIMENSION2_CHARS94
   - DIMENSION2_CHARS96

   In addition, each character set is assigned an identification tag,
   unique for each set, called "final character" (denoted as <F>
   hereafter).  The <F> of each character set is decided by ECMA(*)
   when it is registered in ISO.  The code range of <F> is 0x30..0x7F
   (0x30..0x3F are for private use only).
Karl Heuer's avatar
Karl Heuer committed
565 566 567 568 569 570 571 572 573

   Note (*): ECMA = European Computer Manufacturers Association

   Here are examples of graphic character set [NAME(<F>)]:
	o DIMENSION1_CHARS94 -- ASCII('B'), right-half-of-JISX0201('I'), ...
	o DIMENSION1_CHARS96 -- right-half-of-ISO8859-1('A'), ...
	o DIMENSION2_CHARS94 -- GB2312('A'), JISX0208('B'), ...
	o DIMENSION2_CHARS96 -- none for the moment

574
   A code area (1 byte=8 bits) is divided into 4 areas, C0, GL, C1, and GR.
Karl Heuer's avatar
Karl Heuer committed
575 576 577 578 579 580
	C0 [0x00..0x1F] -- control character plane 0
	GL [0x20..0x7F] -- graphic character plane 0
	C1 [0x80..0x9F] -- control character plane 1
	GR [0xA0..0xFF] -- graphic character plane 1

   A control character set is directly designated and invoked to C0 or
581 582 583 584 585 586 587 588
   C1 by an escape sequence.  The most common case is that:
   - ISO646's  control character set is designated/invoked to C0, and
   - ISO6429's control character set is designated/invoked to C1,
   and usually these designations/invocations are omitted in encoded
   text.  In a 7-bit environment, only C0 can be used, and a control
   character for C1 is encoded by an appropriate escape sequence to
   fit into the environment.  All control characters for C1 are
   defined to have corresponding escape sequences.
Karl Heuer's avatar
Karl Heuer committed
589 590 591 592 593

   A graphic character set is at first designated to one of four
   graphic registers (G0 through G3), then these graphic registers are
   invoked to GL or GR.  These designations and invocations can be
   done independently.  The most common case is that G0 is invoked to
594 595 596
   GL, G1 is invoked to GR, and ASCII is designated to G0.  Usually
   these invocations and designations are omitted in encoded text.
   In a 7-bit environment, only GL can be used.
Karl Heuer's avatar
Karl Heuer committed
597

598 599 600 601
   When a graphic character set of CHARS94 is invoked to GL, codes
   0x20 and 0x7F of the GL area work as control characters SPACE and
   DEL respectively, and codes 0xA0 and 0xFF of the GR area should not
   be used.
Karl Heuer's avatar
Karl Heuer committed
602 603 604

   There are two ways of invocation: locking-shift and single-shift.
   With locking-shift, the invocation lasts until the next different
605 606 607 608
   invocation, whereas with single-shift, the invocation affects the
   following character only and doesn't affect the locking-shift
   state.  Invocations are done by the following control characters or
   escape sequences:
Karl Heuer's avatar
Karl Heuer committed
609 610

   ----------------------------------------------------------------------
611
   abbrev  function	             cntrl escape seq	description
Karl Heuer's avatar
Karl Heuer committed
612
   ----------------------------------------------------------------------
613 614 615 616 617 618 619 620 621
   SI/LS0  (shift-in)		     0x0F  none		invoke G0 into GL
   SO/LS1  (shift-out)		     0x0E  none		invoke G1 into GL
   LS2     (locking-shift-2)	     none  ESC 'n'	invoke G2 into GL
   LS3     (locking-shift-3)	     none  ESC 'o'	invoke G3 into GL
   LS1R    (locking-shift-1 right)   none  ESC '~'      invoke G1 into GR (*)
   LS2R    (locking-shift-2 right)   none  ESC '}'      invoke G2 into GR (*)
   LS3R    (locking-shift 3 right)   none  ESC '|'      invoke G3 into GR (*)
   SS2     (single-shift-2)	     0x8E  ESC 'N'	invoke G2 for one char
   SS3     (single-shift-3)	     0x8F  ESC 'O'	invoke G3 for one char
Karl Heuer's avatar
Karl Heuer committed
622
   ----------------------------------------------------------------------
623 624 625 626
   (*) These are not used by any known coding system.

   Control characters for these functions are defined by macros
   ISO_CODE_XXX in `coding.h'.
Karl Heuer's avatar
Karl Heuer committed
627

628
   Designations are done by the following escape sequences:
Karl Heuer's avatar
Karl Heuer committed
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650
   ----------------------------------------------------------------------
   escape sequence	description
   ----------------------------------------------------------------------
   ESC '(' <F>		designate DIMENSION1_CHARS94<F> to G0
   ESC ')' <F>		designate DIMENSION1_CHARS94<F> to G1
   ESC '*' <F>		designate DIMENSION1_CHARS94<F> to G2
   ESC '+' <F>		designate DIMENSION1_CHARS94<F> to G3
   ESC ',' <F>		designate DIMENSION1_CHARS96<F> to G0 (*)
   ESC '-' <F>		designate DIMENSION1_CHARS96<F> to G1
   ESC '.' <F>		designate DIMENSION1_CHARS96<F> to G2
   ESC '/' <F>		designate DIMENSION1_CHARS96<F> to G3
   ESC '$' '(' <F>	designate DIMENSION2_CHARS94<F> to G0 (**)
   ESC '$' ')' <F>	designate DIMENSION2_CHARS94<F> to G1
   ESC '$' '*' <F>	designate DIMENSION2_CHARS94<F> to G2
   ESC '$' '+' <F>	designate DIMENSION2_CHARS94<F> to G3
   ESC '$' ',' <F>	designate DIMENSION2_CHARS96<F> to G0 (*)
   ESC '$' '-' <F>	designate DIMENSION2_CHARS96<F> to G1
   ESC '$' '.' <F>	designate DIMENSION2_CHARS96<F> to G2
   ESC '$' '/' <F>	designate DIMENSION2_CHARS96<F> to G3
   ----------------------------------------------------------------------

   In this list, "DIMENSION1_CHARS94<F>" means a graphic character set
651
   of dimension 1, chars 94, and final character <F>, etc...
Karl Heuer's avatar
Karl Heuer committed
652 653 654

   Note (*): Although these designations are not allowed in ISO2022,
   Emacs accepts them on decoding, and produces them on encoding
655
   CHARS96 character sets in a coding system which is characterized as
Karl Heuer's avatar
Karl Heuer committed
656 657 658
   7-bit environment, non-locking-shift, and non-single-shift.

   Note (**): If <F> is '@', 'A', or 'B', the intermediate character
659
   '(' can be omitted.  We refer to this as "short-form" hereafter.
Karl Heuer's avatar
Karl Heuer committed
660 661

   Now you may notice that there are a lot of ways for encoding the
662 663 664 665
   same multilingual text in ISO2022.  Actually, there exist many
   coding systems such as Compound Text (used in X11's inter client
   communication, ISO-2022-JP (used in Japanese internet), ISO-2022-KR
   (used in Korean internet), EUC (Extended UNIX Code, used in Asian
Karl Heuer's avatar
Karl Heuer committed
666 667 668 669 670 671
   localized platforms), and all of these are variants of ISO2022.

   In addition to the above, Emacs handles two more kinds of escape
   sequences: ISO6429's direction specification and Emacs' private
   sequence for specifying character composition.

672
   ISO6429's direction specification takes the following form:
Karl Heuer's avatar
Karl Heuer committed
673 674 675 676 677
	o CSI ']'      -- end of the current direction
	o CSI '0' ']'  -- end of the current direction
	o CSI '1' ']'  -- start of left-to-right text
	o CSI '2' ']'  -- start of right-to-left text
   The control character CSI (0x9B: control sequence introducer) is
678 679 680
   abbreviated to the escape sequence ESC '[' in a 7-bit environment.

   Character composition specification takes the following form:
Karl Heuer's avatar
Karl Heuer committed
681 682
	o ESC '0' -- start character composition
	o ESC '1' -- end character composition
683 684
   Since these are not standard escape sequences of any ISO standard,
   the use of them for these meaning is restricted to Emacs only.  */
Karl Heuer's avatar
Karl Heuer committed
685 686 687

enum iso_code_class_type iso_code_class[256];

688 689 690 691 692 693
#define CHARSET_OK(idx, charset)				\
  (coding_system_table[idx]					\
   && (coding_system_table[idx]->safe_charsets[charset]		\
       || (CODING_SPEC_ISO_REQUESTED_DESIGNATION		\
            (coding_system_table[idx], charset)			\
           != CODING_SPEC_ISO_NO_REQUESTED_DESIGNATION)))
694 695 696 697

#define SHIFT_OUT_OK(idx) \
  (CODING_SPEC_ISO_INITIAL_DESIGNATION (coding_system_table[idx], 1) >= 0)

Karl Heuer's avatar
Karl Heuer committed
698 699 700 701
/* See the above "GENERAL NOTES on `detect_coding_XXX ()' functions".
   Check if a text is encoded in ISO2022.  If it is, returns an
   integer in which appropriate flag bits any of:
	CODING_CATEGORY_MASK_ISO_7
702
	CODING_CATEGORY_MASK_ISO_7_TIGHT
Karl Heuer's avatar
Karl Heuer committed
703 704
	CODING_CATEGORY_MASK_ISO_8_1
	CODING_CATEGORY_MASK_ISO_8_2
705 706
	CODING_CATEGORY_MASK_ISO_7_ELSE
	CODING_CATEGORY_MASK_ISO_8_ELSE
Karl Heuer's avatar
Karl Heuer committed
707 708 709 710 711 712 713
   are set.  If a code which should never appear in ISO2022 is found,
   returns 0.  */

int
detect_coding_iso2022 (src, src_end)
     unsigned char *src, *src_end;
{
714 715
  int mask = CODING_CATEGORY_MASK_ISO;
  int mask_found = 0;
716
  int reg[4], shift_out = 0, single_shifting = 0;
717
  int c, c1, i, charset;
718

719
  reg[0] = CHARSET_ASCII, reg[1] = reg[2] = reg[3] = -1;
720
  while (mask && src < src_end)
Karl Heuer's avatar
Karl Heuer committed
721 722 723 724 725
    {
      c = *src++;
      switch (c)
	{
	case ISO_CODE_ESC:
726
	  single_shifting = 0;
727
	  if (src >= src_end)
Karl Heuer's avatar
Karl Heuer committed
728 729
	    break;
	  c = *src++;
730
	  if (c >= '(' && c <= '/')
Karl Heuer's avatar
Karl Heuer committed
731
	    {
732 733 734
	      /* Designation sequence for a charset of dimension 1.  */
	      if (src >= src_end)
		break;
735 736 737 738 739 740
	      c1 = *src++;
	      if (c1 < ' ' || c1 >= 0x80
		  || (charset = iso_charset_table[0][c >= ','][c1]) < 0)
		/* Invalid designation sequence.  Just ignore.  */
		break;
	      reg[(c - '(') % 4] = charset;
741 742 743 744 745 746 747 748 749
	    }
	  else if (c == '$')
	    {
	      /* Designation sequence for a charset of dimension 2.  */
	      if (src >= src_end)
		break;
	      c = *src++;
	      if (c >= '@' && c <= 'B')
		/* Designation for JISX0208.1978, GB2312, or JISX0208.  */
750
		reg[0] = charset = iso_charset_table[1][0][c];
751
	      else if (c >= '(' && c <= '/')
752
		{
753 754
		  if (src >= src_end)
		    break;
755 756 757 758 759 760
		  c1 = *src++;
		  if (c1 < ' ' || c1 >= 0x80
		      || (charset = iso_charset_table[1][c >= ','][c1]) < 0)
		    /* Invalid designation sequence.  Just ignore.  */
		    break;
		  reg[(c - '(') % 4] = charset;
761
		}
762
	      else
763 764 765
		/* Invalid designation sequence.  Just ignore.  */
		break;
	    }
766
	  else if (c == 'N' || c == 'O')
767
	    {
768 769
	      /* ESC <Fe> for SS2 or SS3.  */
	      mask &= CODING_CATEGORY_MASK_ISO_7_ELSE;
770
	      break;
Karl Heuer's avatar
Karl Heuer committed
771
	    }
772
	  else if (c == '0' || c == '1' || c == '2')
773
	    /* ESC <Fp> for start/end composition.  Just ignore.  */
774
	    break;
775
	  else
776 777 778 779 780 781 782 783 784 785 786 787 788
	    /* Invalid escape sequence.  Just ignore.  */
	    break;

	  /* We found a valid designation sequence for CHARSET.  */
	  mask &= ~CODING_CATEGORY_MASK_ISO_8BIT;
	  if (CHARSET_OK (CODING_CATEGORY_IDX_ISO_7, charset))
	    mask_found |= CODING_CATEGORY_MASK_ISO_7;
	  else
	    mask &= ~CODING_CATEGORY_MASK_ISO_7;
	  if (CHARSET_OK (CODING_CATEGORY_IDX_ISO_7_TIGHT, charset))
	    mask_found |= CODING_CATEGORY_MASK_ISO_7_TIGHT;
	  else
	    mask &= ~CODING_CATEGORY_MASK_ISO_7_TIGHT;
789 790 791
	  if (CHARSET_OK (CODING_CATEGORY_IDX_ISO_7_ELSE, charset))
	    mask_found |= CODING_CATEGORY_MASK_ISO_7_ELSE;
	  else
792
	    mask &= ~CODING_CATEGORY_MASK_ISO_7_ELSE;
793 794 795
	  if (CHARSET_OK (CODING_CATEGORY_IDX_ISO_8_ELSE, charset))
	    mask_found |= CODING_CATEGORY_MASK_ISO_8_ELSE;
	  else
796
	    mask &= ~CODING_CATEGORY_MASK_ISO_8_ELSE;
Karl Heuer's avatar
Karl Heuer committed
797 798 799
	  break;

	case ISO_CODE_SO:
800
	  single_shifting = 0;
801 802 803 804 805 806 807 808 809
	  if (shift_out == 0
	      && (reg[1] >= 0
		  || SHIFT_OUT_OK (CODING_CATEGORY_IDX_ISO_7_ELSE)
		  || SHIFT_OUT_OK (CODING_CATEGORY_IDX_ISO_8_ELSE)))
	    {
	      /* Locking shift out.  */
	      mask &= ~CODING_CATEGORY_MASK_ISO_7BIT;
	      mask_found |= CODING_CATEGORY_MASK_ISO_SHIFT;
	    }
810 811
	  break;
	  
812
	case ISO_CODE_SI:
813
	  single_shifting = 0;
814 815 816 817 818 819 820 821
	  if (shift_out == 1)
	    {
	      /* Locking shift in.  */
	      mask &= ~CODING_CATEGORY_MASK_ISO_7BIT;
	      mask_found |= CODING_CATEGORY_MASK_ISO_SHIFT;
	    }
	  break;

Karl Heuer's avatar
Karl Heuer committed
822
	case ISO_CODE_CSI:
823
	  single_shifting = 0;
Karl Heuer's avatar
Karl Heuer committed
824 825
	case ISO_CODE_SS2:
	case ISO_CODE_SS3:
826 827 828
	  {
	    int newmask = CODING_CATEGORY_MASK_ISO_8_ELSE;

829 830
	    if (c != ISO_CODE_CSI)
	      {
831 832
		if (coding_system_table[CODING_CATEGORY_IDX_ISO_8_1]->flags
		    & CODING_FLAG_ISO_SINGLE_SHIFT)
833
		  newmask |= CODING_CATEGORY_MASK_ISO_8_1;
834 835
		if (coding_system_table[CODING_CATEGORY_IDX_ISO_8_2]->flags
		    & CODING_FLAG_ISO_SINGLE_SHIFT)
836
		  newmask |= CODING_CATEGORY_MASK_ISO_8_2;
837
		single_shifting = 1;
838
	      }
839 840 841
	    if (VECTORP (Vlatin_extra_code_table)
		&& !NILP (XVECTOR (Vlatin_extra_code_table)->contents[c]))
	      {
842 843
		if (coding_system_table[CODING_CATEGORY_IDX_ISO_8_1]->flags
		    & CODING_FLAG_ISO_LATIN_EXTRA)
844
		  newmask |= CODING_CATEGORY_MASK_ISO_8_1;
845 846
		if (coding_system_table[CODING_CATEGORY_IDX_ISO_8_2]->flags
		    & CODING_FLAG_ISO_LATIN_EXTRA)
847 848 849
		  newmask |= CODING_CATEGORY_MASK_ISO_8_2;
	      }
	    mask &= newmask;
850
	    mask_found |= newmask;
851 852
	  }
	  break;
Karl Heuer's avatar
Karl Heuer committed
853 854 855

	default:
	  if (c < 0x80)
856 857 858 859
	    {
	      single_shifting = 0;
	      break;
	    }
Karl Heuer's avatar
Karl Heuer committed
860
	  else if (c < 0xA0)
861
	    {
862
	      single_shifting = 0;
863 864
	      if (VECTORP (Vlatin_extra_code_table)
		  && !NILP (XVECTOR (Vlatin_extra_code_table)->contents[c]))
865
		{
866 867
		  int newmask = 0;

868 869
		  if (coding_system_table[CODING_CATEGORY_IDX_ISO_8_1]->flags
		      & CODING_FLAG_ISO_LATIN_EXTRA)
870
		    newmask |= CODING_CATEGORY_MASK_ISO_8_1;
871 872
		  if (coding_system_table[CODING_CATEGORY_IDX_ISO_8_2]->flags
		      & CODING_FLAG_ISO_LATIN_EXTRA)
873 874
		    newmask |= CODING_CATEGORY_MASK_ISO_8_2;
		  mask &= newmask;
875
		  mask_found |= newmask;
876
		}
877 878
	      else
		return 0;
879
	    }
Karl Heuer's avatar
Karl Heuer committed
880 881
	  else
	    {
882
	      unsigned char *src_begin = src;
Karl Heuer's avatar
Karl Heuer committed
883

884
	      mask &= ~(CODING_CATEGORY_MASK_ISO_7BIT
885
			| CODING_CATEGORY_MASK_ISO_7_ELSE);
886
	      mask_found |= CODING_CATEGORY_MASK_ISO_8_1;
887 888 889 890 891 892 893 894 895 896 897 898 899
	      /* Check the length of succeeding codes of the range
                 0xA0..0FF.  If the byte length is odd, we exclude
                 CODING_CATEGORY_MASK_ISO_8_2.  We can check this only
                 when we are not single shifting.  */
	      if (!single_shifting)
		{
		  while (src < src_end && *src >= 0xA0)
		    src++;
		  if ((src - src_begin - 1) & 1 && src < src_end)
		    mask &= ~CODING_CATEGORY_MASK_ISO_8_2;
		  else
		    mask_found |= CODING_CATEGORY_MASK_ISO_8_2;
		}
Karl Heuer's avatar
Karl Heuer committed
900 901 902 903 904
	    }
	  break;
	}
    }

905
  return (mask & mask_found);
Karl Heuer's avatar
Karl Heuer committed
906 907 908
}

/* Decode a character of which charset is CHARSET and the 1st position
909
   code is C1.  If dimension of CHARSET is 2, the 2nd position code is
Karl Heuer's avatar
Karl Heuer committed
910 911 912 913
   fetched from SRC and set to C2.  If CHARSET is negative, it means
   that we are decoding ill formed text, and what we can do is just to
   read C1 as is.  */

914 915 916 917 918 919 920 921 922 923 924
#define DECODE_ISO_CHARACTER(charset, c1)				\
  do {									\
    int c_alt, charset_alt = (charset);					\
    if (COMPOSING_HEAD_P (coding->composing))				\
      {									\
	*dst++ = LEADING_CODE_COMPOSITION;				\
	if (COMPOSING_WITH_RULE_P (coding->composing))			\
	  /* To tell composition rules are embeded.  */			\
	  *dst++ = 0xFF;						\
	coding->composing += 2;						\
      }									\
925
    if (charset_alt >= 0)						\
926
      {									\
927
	if (CHARSET_DIMENSION (charset_alt) == 2)			\
928 929 930 931 932 933
	  {								\
	    ONE_MORE_BYTE (c2);						\
	    if (iso_code_class[(c2) & 0x7F] != ISO_0x20_or_0x7F		\
		&& iso_code_class[(c2) & 0x7F] != ISO_graphic_plane_0)	\
	      {								\
		src--;							\
934
		charset_alt = CHARSET_ASCII;				\
935 936
	      }								\
	  }								\
937 938
	if (!NILP (translation_table)					\
	    && ((c_alt = translate_char (translation_table,		\
939
					 -1, charset_alt, c1, c2)) >= 0)) \
940 941 942 943 944 945 946 947 948 949 950
	  SPLIT_CHAR (c_alt, charset_alt, c1, c2);			\
      }									\
    if (charset_alt == CHARSET_ASCII || charset_alt < 0)		\
      DECODE_CHARACTER_ASCII (c1);					\
    else if (CHARSET_DIMENSION (charset_alt) == 1)			\
      DECODE_CHARACTER_DIMENSION1 (charset_alt, c1);			\
    else								\
      DECODE_CHARACTER_DIMENSION2 (charset_alt, c1, c2);		\
    if (COMPOSING_WITH_RULE_P (coding->composing))			\
      /* To tell a composition rule follows.  */			\
      coding->composing = COMPOSING_WITH_RULE_RULE;			\
Karl Heuer's avatar
Karl Heuer committed
951 952 953
  } while (0)

/* Set designation state into CODING.  */
954 955
#define DECODE_DESIGNATION(reg, dimension, chars, final_char)		   \
  do {									   \
956 957 958 959 960 961 962
    int charset;							   \
    									   \
    if (final_char < '0' || final_char >= 128)				   \
      goto label_invalid_code;						   \
    charset = ISO_CHARSET_TABLE (make_number (dimension),		   \
				 make_number (chars),			   \
				 make_number (final_char));		   \
963
    if (charset >= 0							   \
964 965
	&& (CODING_SPEC_ISO_REQUESTED_DESIGNATION (coding, charset) == reg \
	    || coding->safe_charsets[charset]))				   \
966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986
      {									   \
	if (coding->spec.iso2022.last_invalid_designation_register == 0	   \
	    && reg == 0							   \
	    && charset == CHARSET_ASCII)				   \
	  {								   \
	    /* We should insert this designation sequence as is so	   \
               that it is surely written back to a file.  */		   \
	    coding->spec.iso2022.last_invalid_designation_register = -1;   \
	    goto label_invalid_code;					   \
	  }								   \
	coding->spec.iso2022.last_invalid_designation_register = -1;	   \
        if ((coding->mode & CODING_MODE_DIRECTION)			   \
	    && CHARSET_REVERSE_CHARSET (charset) >= 0)			   \
          charset = CHARSET_REVERSE_CHARSET (charset);			   \
        CODING_SPEC_ISO_DESIGNATION (coding, reg) = charset;		   \
      }									   \
    else								   \
      {									   \
	coding->spec.iso2022.last_invalid_designation_register = reg;	   \
	goto label_invalid_code;					   \
      }									   \
Karl Heuer's avatar
Karl Heuer committed
987 988
  } while (0)

989 990
/* Return 0 if there's a valid composing sequence starting at SRC and
   ending before SRC_END, else return -1.  */
991

992 993
int
check_composing_code (coding, src, src_end)
994 995 996 997 998 999 1000
     struct coding_system *coding;
     unsigned char *src, *src_end;
{
  int charset, c, c1, dim;

  while (src < src_end)
    {
1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016
      c = *src++;
      if (c >= 0x20)
	continue;
      if (c != ISO_CODE_ESC || src >= src_end)
	return -1;
      c = *src++;
      if (c == '1') /* end of compsition */
	return 0;
      if (src + 2 >= src_end
	  || !coding->flags & CODING_FLAG_ISO_DESIGNATION)
	return -1;

      dim = (c == '$');
      if (dim == 1)
	c = (*src >= '@' && *src <= 'B') ? '(' : *src++;
      if (c >= '(' && c <= '/')
1017
	{
1018 1019 1020 1021 1022 1023 1024
	  c1 = *src++;
	  if ((c1 < ' ' || c1 >= 0x80)
	      || (charset = iso_charset_table[dim][c >= ','][c1]) < 0
	      || ! coding->safe_charsets[charset]
	      || (CODING_SPEC_ISO_REQUESTED_DESIGNATION (coding, charset)
		  == CODING_SPEC_ISO_NO_REQUESTED_DESIGNATION))
	    return -1;
1025
	}
1026 1027
      else
	return -1;
1028
    }
1029 1030 1031

  /* We have not found the sequence "ESC 1".  */
  return -1;
1032 1033
}

Karl Heuer's avatar
Karl Heuer committed
1034 1035 1036
/* See the above "GENERAL NOTES on `decode_coding_XXX ()' functions".  */

int
1037
decode_coding_iso2022 (coding, source, destination, src_bytes, dst_bytes)
Karl Heuer's avatar
Karl Heuer committed
1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
     struct coding_system *coding;
     unsigned char *source, *destination;
     int src_bytes, dst_bytes;
{
  unsigned char *src = source;
  unsigned char *src_end = source + src_bytes;
  unsigned char *dst = destination;
  unsigned char *dst_end = destination + dst_bytes;
  /* Since the maximum bytes produced by each loop is 7, we subtract 6
     from DST_END to assure that overflow checking is necessary only
     at the head of loop.  */
  unsigned char *adjusted_dst_end = dst_end - 6;
  int charset;
  /* Charsets invoked to graphic plane 0 and 1 respectively.  */
  int charset0 = CODING_SPEC_ISO_PLANE_CHARSET (coding, 0);
  int charset1 = CODING_SPEC_ISO_PLANE_CHARSET (coding, 1);
1054
  Lisp_Object translation_table
1055
    = coding->translation_table_for_decode;
1056
  int result = CODING_FINISH_NORMAL;
1057

1058
  if (!NILP (Venable_character_translation) && NILP (translation_table))
1059
    translation_table = Vstandard_translation_table_for_decode;
Karl Heuer's avatar
Karl Heuer committed
1060

1061
  coding->produced_char = 0;
1062
  coding->fake_multibyte = 0;
1063 1064 1065
  while (src < src_end && (dst_bytes
			   ? (dst < adjusted_dst_end)
			   : (dst < src - 6)))
Karl Heuer's avatar
Karl Heuer committed
1066 1067 1068 1069 1070 1071 1072
    {
      /* SRC_BASE remembers the start position in source in each loop.
	 The loop will be exited when there's not enough source text
	 to analyze long escape sequence or 2-byte code (within macros
	 ONE_MORE_BYTE or TWO_MORE_BYTES).  In that case, SRC is reset
	 to SRC_BASE before exiting.  */
      unsigned char *src_base = src;
1073
      int c1 = *src++, c2;
Karl Heuer's avatar
Karl Heuer committed
1074 1075 1076 1077 1078 1079 1080 1081 1082

      switch (iso_code_class [c1])
	{
	case ISO_0x20_or_0x7F:
	  if (!coding->composing
	      && (charset0 < 0 || CHARSET_CHARS (charset0) == 94))
	    {
	      /* This is SPACE or DEL.  */
	      *dst++ = c1;
1083
	      coding->produced_char++;
Karl Heuer's avatar
Karl Heuer committed
1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099
	      break;
	    }
	  /* This is a graphic character, we fall down ...  */

	case ISO_graphic_plane_0:
	  if (coding->composing == COMPOSING_WITH_RULE_RULE)
	    {
	      /* This is a composition rule.  */
	      *dst++ = c1 | 0x80;
	      coding->composing = COMPOSING_WITH_RULE_TAIL;
	    }
	  else
	    DECODE_ISO_CHARACTER (charset0, c1);
	  break;

	case ISO_0xA0_or_0xFF:
1100 1101
	  if (charset1 < 0 || CHARSET_CHARS (charset1) == 94
	      || coding->flags & CODING_FLAG_ISO_SEVEN_BITS)
1102
	    goto label_invalid_code;
Karl Heuer's avatar
Karl Heuer committed
1103 1104 1105
	  /* This is a graphic character, we fall down ... */

	case ISO_graphic_plane_1:
1106
	  if (coding->flags & CODING_FLAG_ISO_SEVEN_BITS)
1107
	    goto label_invalid_code;
1108 1109
	  else
	    DECODE_ISO_CHARACTER (charset1, c1);
Karl Heuer's avatar
Karl Heuer committed
1110 1111 1112 1113 1114
	  break;

	case ISO_control_code:
	  /* All ISO2022 control characters in this class have the
             same representation in Emacs internal format.  */
1115 1116 1117 1118 1119 1120 1121 1122
	  if (c1 == '\n'
	      && (coding->mode & CODING_MODE_INHIBIT_INCONSISTENT_EOL)
	      && (coding->eol_type == CODING_EOL_CR
		  || coding->eol_type == CODING_EOL_CRLF))
	    {
	      result = CODING_FINISH_INCONSISTENT_EOL;
	      goto label_end_of_loop_2;
	    }
Karl Heuer's avatar
Karl Heuer committed
1123
	  *dst++ = c1;
1124
	  coding->produced_char++;
1125 1126
	  if (c1 >= 0x80)
	    coding->fake_multibyte = 1;
Karl Heuer's avatar
Karl Heuer committed
1127 1128 1129 1130
	  break;

	case ISO_carriage_return:
	  if (coding->eol_type == CODING_EOL_CR)
1131
	    *dst++ = '\n';
Karl Heuer's avatar
Karl Heuer committed
1132 1133 1134 1135 1136 1137 1138
	  else if (coding->eol_type == CODING_EOL_CRLF)
	    {
	      ONE_MORE_BYTE (c1);
	      if (c1 == ISO_CODE_LF)
		*dst++ = '\n';
	      else
		{
1139 1140 1141 1142 1143
		  if (coding->mode & CODING_MODE_INHIBIT_INCONSISTENT_EOL)
		    {
		      result = CODING_FINISH_INCONSISTENT_EOL;
		      goto label_end_of_loop_2;
		    }
Karl Heuer's avatar
Karl Heuer committed
1144
		  src--;
1145
		  *dst++ = '\r';
Karl Heuer's avatar
Karl Heuer committed
1146 1147 1148
		}
	    }
	  else
1149 1150
	    *dst++ = c1;
	  coding->produced_char++;
Karl Heuer's avatar
Karl Heuer committed
1151 1152 1153
	  break;

	case ISO_shift_out:
1154 1155 1156
	  if (! (coding->flags & CODING_FLAG_ISO_LOCKING_SHIFT)
	      || CODING_SPEC_ISO_DESIGNATION (coding, 1) < 0)
	    goto label_invalid_code;
Karl Heuer's avatar
Karl Heuer committed
1157 1158 1159 1160 1161
	  CODING_SPEC_ISO_INVOCATION (coding, 0) = 1;
	  charset0 = CODING_SPEC_ISO_PLANE_CHARSET (coding, 0);
	  break;

	case ISO_shift_in:
1162 1163
	  if (! (coding->flags & CODING_FLAG_ISO_LOCKING_SHIFT))
	    goto label_invalid_code;
Karl Heuer's avatar
Karl Heuer committed
1164 1165 1166 1167 1168 1169
	  CODING_SPEC_ISO_INVOCATION (coding, 0) = 0;
	  charset0 = CODING_SPEC_ISO_PLANE_CHARSET (coding, 0);
	  break;

	case ISO_single_shift_2_7:
	case ISO_single_shift_2:
1170 1171
	  if (! (coding->flags & CODING_FLAG_ISO_SINGLE_SHIFT))
	    goto label_invalid_code;
Karl Heuer's avatar
Karl Heuer committed
1172 1173 1174 1175 1176
	  /* SS2 is handled as an escape sequence of ESC 'N' */
	  c1 = 'N';
	  goto label_escape_sequence;

	case ISO_single_shift_3:
1177 1178
	  if (! (coding->flags & CODING_FLAG_ISO_SINGLE_SHIFT))
	    goto label_invalid_code;
Karl Heuer's avatar
Karl Heuer committed
1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198
	  /* SS2 is handled as an escape sequence of ESC 'O' */
	  c1 = 'O';
	  goto label_escape_sequence;

	case ISO_control_sequence_introducer:
	  /* CSI is handled as an escape sequence of ESC '[' ...  */
	  c1 = '[';
	  goto label_escape_sequence;

	case ISO_escape:
	  ONE_MORE_BYTE (c1);
	label_escape_sequence:
	  /* Escape sequences handled by Emacs are invocation,
	     designation, direction specification, and character
	     composition specification.  */
	  switch (c1)
	    {
	    case '&':		/* revision of following character set */
	      ONE_MORE_BYTE (c1);
	      if (!(c1 >= '@' && c1 <= '~'))
1199
		goto label_invalid_code;
Karl Heuer's avatar
Karl Heuer committed
1200 1201
	      ONE_MORE_BYTE (c1);
	      if (c1 != ISO_CODE_ESC)
1202
		goto label_invalid_code;
Karl Heuer's avatar
Karl Heuer committed
1203 1204 1205 1206
	      ONE_MORE_BYTE (c1);
	      goto label_escape_sequence;

	    case '$':		/* designation of 2-byte character set */
1207 1208
	      if (! (coding->flags & CODING_FLAG_ISO_DESIGNATION))
		goto label_invalid_code;
Karl Heuer's avatar
Karl Heuer committed
1209 1210 1211
	      ONE_MORE_BYTE (c1);
	      if (c1 >= '@' && c1 <= 'B')
		{	/* designation of JISX0208.1978, GB2312.1980,
1212
			   or JISX0208.1980 */
Karl Heuer's avatar
Karl Heuer committed
1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225
		  DECODE_DESIGNATION (0, 2, 94, c1);
		}
	      else if (c1 >= 0x28 && c1 <= 0x2B)
		{	/* designation of DIMENSION2_CHARS94 character set */
		  ONE_MORE_BYTE (c2);
		  DECODE_DESIGNATION (c1 - 0x28, 2, 94, c2);
		}
	      else if (c1 >= 0x2C && c1 <= 0x2F)
		{	/* designation of DIMENSION2_CHARS96 character set */
		  ONE_MORE_BYTE (c2);
		  DECODE_DESIGNATION (c1 - 0x2C, 2, 96, c2);
		}
	      else
1226
		goto label_invalid_code;
Karl Heuer's avatar
Karl Heuer committed
1227 1228 1229
	      break;

	    case 'n':		/* invocation of locking-shift-2 */
1230 1231 1232
	      if (! (coding->flags & CODING_FLAG_ISO_LOCKING_SHIFT)
		  || CODING_SPEC_ISO_DESIGNATION (coding, 2) < 0)
		goto label_invalid_code;
Karl Heuer's avatar
Karl Heuer committed
1233
	      CODING_SPEC_ISO_INVOCATION (coding, 0) = 2;
1234
	      charset0 = CODING_SPEC_ISO_PLANE_CHARSET (coding, 0);
Karl Heuer's avatar
Karl Heuer committed
1235 1236 1237
	      break;

	    case 'o':		/* invocation of locking-shift-3 */
1238 1239 1240
	      if (! (coding->flags & CODING_FLAG_ISO_LOCKING_SHIFT)
		  || CODING_SPEC_ISO_DESIGNATION (coding, 3) < 0)
		goto label_invalid_code;
Karl Heuer's avatar
Karl Heuer committed
1241
	      CODING_SPEC_ISO_INVOCATION (coding, 0) = 3;
1242
	      charset0 = CODING_SPEC_ISO_PLANE_CHARSET (coding, 0);
Karl Heuer's avatar
Karl Heuer committed
1243 1244 1245
	      break;

	    case 'N':		/* invocation of single-shift-2 */
1246 1247 1248
	      if (! (coding->flags & CODING_FLAG_ISO_SINGLE_SHIFT)
		  || CODING_SPEC_ISO_DESIGNATION (coding, 2) < 0)
		goto label_invalid_code;
Karl Heuer's avatar
Karl Heuer committed
1249 1250 1251 1252 1253 1254
	      ONE_MORE_BYTE (c1);
	      charset = CODING_SPEC_ISO_DESIGNATION (coding, 2);
	      DECODE_ISO_CHARACTER (charset, c1);
	      break;

	    case 'O':		/* invocation of single-shift-3 */
1255 1256 1257
	      if (! (coding->flags & CODING_FLAG_ISO_SINGLE_SHIFT)
		  || CODING_SPEC_ISO_DESIGNATION (coding, 3) < 0)
		goto label_invalid_code;
Karl Heuer's avatar
Karl Heuer committed
1258 1259 1260 1261 1262
	      ONE_MORE_BYTE (c1);
	      charset = CODING_SPEC_ISO_DESIGNATION (coding, 3);
	      DECODE_ISO_CHARACTER (charset, c1);
	      break;

1263 1264 1265
	    case '0': case '2':	/* start composing */
	      /* Before processing composing, we must be sure that all
		 characters being composed are supported by CODING.
1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280
		 If not, we must give up composing.  */
	      if (check_composing_code (coding, src, src_end) == 0)
		{
		  /* We are looking at a valid composition sequence.  */
		  coding->composing = (c1 == '0'
				       ? COMPOSING_NO_RULE_HEAD
				       : COMPOSING_WITH_RULE_HEAD);
		  coding->composed_chars = 0;
		}
	      else
		{
		  *dst++ = ISO_CODE_ESC;
		  *dst++ = c1;
		  coding->produced_char += 2;
		}
Karl Heuer's avatar
Karl Heuer committed
1281 1282 1283
	      break;

	    case '1':		/* end composing */
1284 1285 1286 1287 1288 1289 1290 1291
	      if (!coding->composing)
		{
		  *dst++ = ISO_CODE_ESC;
		  *dst++ = c1;
		  coding->produced_char += 2;
		  break;
		}

1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313
	      if (coding->composed_chars > 0)
		{
		  if (coding->composed_chars == 1)
		    {
		      unsigned char *this_char_start = dst;
		      int this_bytes;

		      /* Only one character is in the composing
			 sequence.  Make it a normal character.  */
		      while (*--this_char_start != LEADING_CODE_COMPOSITION);
		      dst = (this_char_start
			     + (coding->composing == COMPOSING_NO_RULE_TAIL
				? 1 : 2));
		      *dst -= 0x20;
		      if (*dst == 0x80)
			*++dst &= 0x7F;
		      this_bytes = BYTES_BY_CHAR_HEAD (*dst);
		      while (this_bytes--) *this_char_start++ = *dst++;
		      dst = this_char_start;
		    }
		  coding->produced_char++;
		}
Karl Heuer's avatar
Karl Heuer committed
1314 1315 1316 1317
	      coding->composing = COMPOSING_NO;
	      break;

	    case '[':		/* specification of direction */
1318 1319
	      if (coding->flags & CODING_FLAG_ISO_NO_DIRECTION)
		goto label_invalid_code;
Karl Heuer's avatar
Karl Heuer committed
1320
	      /* For the moment, nested direction is not supported.
1321 1322
		 So, `coding->mode & CODING_MODE_DIRECTION' zero means
		 left-to-right, and nozero means right-to-left.  */
Karl Heuer's avatar
Karl Heuer committed
1323 1324 1325 1326
	      ONE_MORE_BYTE (c1);
	      switch (c1)
		{
		case ']':	/* end of the current direction */
1327
		  coding->mode &= ~CODING_MODE_DIRECTION;
Karl Heuer's avatar
Karl Heuer committed
1328 1329 1330 1331 1332

		case '0':	/* end of the current direction */
		case '1':	/* start of left-to-right direction */
		  ONE_MORE_BYTE (c1);
		  if (c1 == ']')
1333
		    coding->mode &= ~CODING_MODE_DIRECTION;
Karl Heuer's avatar
Karl Heuer committed
1334
		  else
1335
		    goto label_invalid_code;
Karl Heuer's avatar
Karl Heuer committed
1336 1337 1338 1339 1340
		  break;

		case '2':	/* start of right-to-left direction */
		  ONE_MORE_BYTE (c1);
		  if (c1 == ']')
1341
		    coding->mode |= CODING_MODE_DIRECTION;
Karl Heuer's avatar
Karl Heuer committed
1342
		  else
1343
		    goto label_invalid_code;
Karl Heuer's avatar
Karl Heuer committed
1344 1345 1346
		  break;

		default:
1347
		  goto label_invalid_code;
Karl Heuer's avatar
Karl Heuer committed
1348 1349 1350 1351
		}
	      break;

	    default:
1352 1353
	      if (! (coding->flags & CODING_FLAG_ISO_DESIGNATION))
		goto label_invalid_code;
Karl Heuer's avatar
Karl Heuer committed
1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365
	      if (c1 >= 0x28 && c1 <= 0x2B)
		{	/* designation of DIMENSION1_CHARS94 character set */
		  ONE_MORE_BYTE (c2);
		  DECODE_DESIGNATION (c1 - 0x28, 1, 94, c2);
		}
	      else if (c1 >= 0x2C && c1 <= 0x2F)
		{	/* designation of DIMENSION1_CHARS96 character set */
		  ONE_MORE_BYTE (c2);
		  DECODE_DESIGNATION (c1 - 0x2C, 1, 96, c2);
		}
	      else
		{
1366
		  goto label_invalid_code;
Karl Heuer's avatar
Karl Heuer committed
1367 1368 1369 1370 1371 1372 1373
		}
	    }
	  /* We must update these variables now.  */
	  charset0 = CODING_SPEC_ISO_PLANE_CHARSET (coding, 0);
	  charset1 = CODING_SPEC_ISO_PLANE_CHARSET (coding, 1);
	  break;

1374 1375 1376
	label_invalid_code:
	  while (src_base < src)
	    *dst++ = *src_base++;
1377
	  coding->fake_multibyte = 1;
Karl Heuer's avatar
Karl Heuer committed
1378 1379 1380 1381
	}
      continue;

    label_end_of_loop:
1382 1383
      result = CODING_FINISH_INSUFFICIENT_SRC;
    label_end_of_loop_2:
Karl Heuer's avatar
Karl Heuer committed
1384 1385 1386 1387
      src = src_base;
      break;
    }

1388
  if (src < src_end)
Karl Heuer's avatar
Karl Heuer committed
1389
    {
1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405
      if (result == CODING_FINISH_NORMAL)
	result = CODING_FINISH_INSUFFICIENT_DST;
      else if (result != CODING_FINISH_INCONSISTENT_EOL
	       && coding->mode & CODING_MODE_LAST_BLOCK)
	{
	  /* This is the last block of the text to be decoded.  We had
	     better just flush out all remaining codes in the text
	     although they are not valid characters.  */
	  src_bytes = src_end - src;
	  if (dst_bytes && (dst_end - dst < src_bytes))
	    src_bytes = dst_end - dst;
	  bcopy (src, dst, src_bytes);
	  dst += src_bytes;
	  src += src_bytes;
	  coding->fake_multibyte = 1;
	}
Karl Heuer's avatar
Karl Heuer committed
1406
    }
1407

1408 1409 1410
  coding->consumed = coding->consumed_char = src - source;
  coding->produced = dst - destination;
  return result;
Karl Heuer's avatar
Karl Heuer committed
1411 1412
}

Richard M. Stallman's avatar
Richard M. Stallman committed
1413
/* ISO2022 encoding stuff.  */
Karl Heuer's avatar
Karl Heuer committed
1414 1415

/*
Richard M. Stallman's avatar
Richard M. Stallman committed
1416
   It is not enough to say just "ISO2022" on encoding, we have to
1417
   specify more details.  In Emacs, each coding system of ISO2022
Karl Heuer's avatar
Karl Heuer committed
1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430
   variant has the following specifications:
	1. Initial designation to G0 thru G3.
	2. Allows short-form designation?
	3. ASCII should be designated to G0 before control characters?
	4. ASCII should be designated to G0 at end of line?
	5. 7-bit environment or 8-bit environment?
	6. Use locking-shift?
	7. Use Single-shift?
   And the following two are only for Japanese:
	8. Use ASCII in place of JIS0201-1976-Roman?
	9. Use JISX0208-1983 in place of JISX0208-1978?
   These specifications are encoded in `coding->flags' as flag bits
   defined by macros CODING_FLAG_ISO_XXX.  See `coding.h' for more
Richard M. Stallman's avatar
Richard M. Stallman committed
1431
   details.
Karl Heuer's avatar
Karl Heuer committed
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443
*/

/* Produce codes (escape sequence) for designating CHARSET to graphic
   register REG.  If <final-char> of CHARSET is '@', 'A', or 'B' and
   the coding system CODING allows, produce designation sequence of
   short-form.  */

#define ENCODE_DESIGNATION(charset, reg, coding)			\
  do {									\
    unsigned char final_char = CHARSET_ISO_FINAL_CHAR (charset);	\
    char *intermediate_char_94 = "()*+";				\
    char *intermediate_char_96 = ",-./";				\
1444 1445 1446
    int revision = CODING_SPEC_ISO_REVISION_NUMBER(coding, charset);	\
    if (revision < 255)							\
      {									\
Karl Heuer's avatar
Karl Heuer committed
1447 1448
	*dst++ = ISO_CODE_ESC;						\
	*dst++ = '&';							\
1449
	*dst++ = '@' + revision;					\
Karl Heuer's avatar
Karl Heuer committed
1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479