coding.c 172 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 216 217 218 219 220
     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.  */

#define DECODE_CHARACTER_ASCII(c)				\
  do {								\
    if (COMPOSING_P (coding->composing))			\
      *dst++ = 0xA0, *dst++ = (c) | 0x80;			\
    else							\
221 222 223 224
      {								\
	*dst++ = (c);						\
	coding->produced_char++;				\
      }								\
Karl Heuer's avatar
Karl Heuer committed
225 226
  } while (0)

Richard M. Stallman's avatar
Richard M. Stallman committed
227
/* Decode one DIMENSION1 character whose charset is CHARSET and whose
Karl Heuer's avatar
Karl Heuer committed
228 229 230 231 232 233 234 235
   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))				\
      *dst++ = leading_code + 0x20;					\
    else								\
236 237 238 239
      {									\
	*dst++ = leading_code;						\
	coding->produced_char++;					\
      }									\
Karl Heuer's avatar
Karl Heuer committed
240 241 242 243 244
    if (leading_code = CHARSET_LEADING_CODE_EXT (charset))		\
      *dst++ = leading_code;						\
    *dst++ = (c) | 0x80;						\
  } while (0)

Richard M. Stallman's avatar
Richard M. Stallman committed
245
/* Decode one DIMENSION2 character whose charset is CHARSET and whose
Karl Heuer's avatar
Karl Heuer committed
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277
   position-codes are C1 and C2.  */

#define DECODE_CHARACTER_DIMENSION2(charset, c1, c2)	\
  do {							\
    DECODE_CHARACTER_DIMENSION1 (charset, c1);		\
    *dst++ = (c2) | 0x80;				\
  } 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;
278
Lisp_Object Qno_conversion, Qundecided;
279
Lisp_Object Qcoding_system_history;
280
Lisp_Object Qsafe_charsets;
Kenichi Handa's avatar
Kenichi Handa committed
281
Lisp_Object Qvalid_codes;
Karl Heuer's avatar
Karl Heuer committed
282 283 284 285 286 287

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;

288 289
Lisp_Object Vselect_safe_coding_system_function;

Karl Heuer's avatar
Karl Heuer committed
290 291 292 293 294 295
/* Mnemonic character of each format of end-of-line.  */
int eol_mnemonic_unix, eol_mnemonic_dos, eol_mnemonic_mac;
/* Mnemonic character to indicate format of end-of-line is not yet
   decided.  */
int eol_mnemonic_undecided;

296 297 298 299
/* 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
300 301
#ifdef emacs

302 303 304
Lisp_Object Vcoding_system_list, Vcoding_system_alist;

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

306 307 308
/* Coding system emacs-mule and raw-text are for converting only
   end-of-line format.  */
Lisp_Object Qemacs_mule, Qraw_text;
309

Karl Heuer's avatar
Karl Heuer committed
310 311 312 313 314 315 316 317 318
/* 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;

319
/* A vector of length 256 which contains information about special
Karl Heuer's avatar
Karl Heuer committed
320
   Latin codes (especially for dealing with Microsoft codes).  */
321
Lisp_Object Vlatin_extra_code_table;
322

323 324 325
/* Flag to inhibit code conversion of end-of-line format.  */
int inhibit_eol_conversion;

326 327 328
/* Flag to make buffer-file-coding-system inherit from process-coding.  */
int inherit_process_coding_system;

329
/* Coding system to be used to encode text for terminal display.  */
Karl Heuer's avatar
Karl Heuer committed
330 331
struct coding_system terminal_coding;

332 333 334 335 336
/* 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
337 338
struct coding_system keyboard_coding;

339 340 341
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
342 343 344

#endif /* emacs */

345
Lisp_Object Qcoding_category, Qcoding_category_index;
Karl Heuer's avatar
Karl Heuer committed
346 347 348 349

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

350 351
/* Table of coding categories (Lisp symbols).  */
Lisp_Object Vcoding_category_table;
Karl Heuer's avatar
Karl Heuer committed
352 353 354

/* Table of names of symbol for each coding-category.  */
char *coding_category_name[CODING_CATEGORY_IDX_MAX] = {
Kenichi Handa's avatar
Kenichi Handa committed
355
  "coding-category-emacs-mule",
Karl Heuer's avatar
Karl Heuer committed
356 357
  "coding-category-sjis",
  "coding-category-iso-7",
358
  "coding-category-iso-7-tight",
Karl Heuer's avatar
Karl Heuer committed
359 360
  "coding-category-iso-8-1",
  "coding-category-iso-8-2",
361 362
  "coding-category-iso-7-else",
  "coding-category-iso-8-else",
Karl Heuer's avatar
Karl Heuer committed
363
  "coding-category-big5",
364
  "coding-category-raw-text",
Kenichi Handa's avatar
Kenichi Handa committed
365 366
  "coding-category-binary",
  "coding-category-ccl"
Karl Heuer's avatar
Karl Heuer committed
367 368
};

369
/* Table of pointers to coding systems corresponding to each coding
370 371 372
   categories.  */
struct coding_system *coding_system_table[CODING_CATEGORY_IDX_MAX];

373 374 375 376 377
/* 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];

378 379
/* Flag to tell if we look up translation table on character code
   conversion.  */
380
Lisp_Object Venable_character_translation;
381 382 383 384
/* 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;
385

386 387 388 389
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
390 391 392 393

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

394 395 396
/* Default coding systems used for process I/O.  */
Lisp_Object Vdefault_process_coding_system;

Karl Heuer's avatar
Karl Heuer committed
397

Kenichi Handa's avatar
Kenichi Handa committed
398
/*** 2. Emacs internal format (emacs-mule) handlers ***/
Karl Heuer's avatar
Karl Heuer committed
399 400

/* Emacs' internal format for encoding multiple character sets is a
Richard M. Stallman's avatar
Richard M. Stallman committed
401 402 403 404 405 406 407 408 409 410 411 412 413
   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
414 415 416 417
   `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
418 419
   `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
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
   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,
445
   return CODING_CATEGORY_MASK_EMACS_MULE, else return 0.  */
Karl Heuer's avatar
Karl Heuer committed
446 447

int
Kenichi Handa's avatar
Kenichi Handa committed
448
detect_coding_emacs_mule (src, src_end)
Karl Heuer's avatar
Karl Heuer committed
449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 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
     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
504
  return CODING_CATEGORY_MASK_EMACS_MULE;
Karl Heuer's avatar
Karl Heuer committed
505 506 507 508 509 510
}

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

/* The following note describes the coding system ISO2022 briefly.
Richard M. Stallman's avatar
Richard M. Stallman committed
511 512
   Since the intention of this note is to help in understanding of
   the programs in this file, some parts are NOT ACCURATE or OVERLY
Karl Heuer's avatar
Karl Heuer committed
513 514 515 516
   SIMPLIFIED.  For the thorough understanding, please refer to the
   original document of ISO2022.

   ISO2022 provides many mechanisms to encode several character sets
Richard M. Stallman's avatar
Richard M. Stallman committed
517
   in 7-bit and 8-bit environment.  If one chooses 7-bite environment,
Karl Heuer's avatar
Karl Heuer committed
518
   all text is encoded by codes of less than 128.  This may make the
Richard M. Stallman's avatar
Richard M. Stallman committed
519 520
   encoded text a little bit longer, but the text gets more stability
   to pass through several gateways (some of them strip off the MSB).
Karl Heuer's avatar
Karl Heuer committed
521

Richard M. Stallman's avatar
Richard M. Stallman committed
522
   There are two kinds of character set: control character set and
Karl Heuer's avatar
Karl Heuer committed
523 524
   graphic character set.  The former contains control characters such
   as `newline' and `escape' to provide control functions (control
Richard M. Stallman's avatar
Richard M. Stallman committed
525
   functions are provided also by escape sequences).  The latter
Karl Heuer's avatar
Karl Heuer committed
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585
   contains graphic characters such as ' A' and '-'.  Emacs recognizes
   two control character sets and many graphic character sets.

   Graphic character sets are classified into one of the following
   four classes, DIMENSION1_CHARS94, DIMENSION1_CHARS96,
   DIMENSION2_CHARS94, DIMENSION2_CHARS96 according to the number of
   bytes (DIMENSION) and the number of characters in one dimension
   (CHARS) of the set.  In addition, each character set is assigned an
   identification tag (called "final character" and denoted as <F>
   here after) which is unique in each class.  <F> of each character
   set is decided by ECMA(*) when it is registered in ISO.  Code range
   of <F> is 0x30..0x7F (0x30..0x3F are for private use only).

   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

   A code area (1byte=8bits) is divided into 4 areas, C0, GL, C1, and GR.
	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
   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 a coded text.  With
   7-bit environment, only C0 can be used, and a control character for
   C1 is encoded by an appropriate escape sequence to fit in the
   environment.  All control characters for C1 are defined the
   corresponding escape sequences.

   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
   GL, G1 is invoked to GR, and ASCII is designated to G0, and usually
   these invocations and designations are omitted in a coded text.
   With 7-bit environment, only GL can be used.

   When a graphic character set of CHARS94 is invoked to GL, code 0x20
   and 0x7F of GL area work as control characters SPACE and DEL
   respectively, and code 0xA0 and 0xFF of GR area should not be used.

   There are two ways of invocation: locking-shift and single-shift.
   With locking-shift, the invocation lasts until the next different
   invocation, whereas with single-shift, the invocation works only
   for the following character and doesn't affect locking-shift.
   Invocations are done by the following control characters or escape
   sequences.

   ----------------------------------------------------------------------
   function		control char	escape sequence	description
   ----------------------------------------------------------------------
   SI  (shift-in)		0x0F	none		invoke G0 to GL
586
   SO  (shift-out)		0x0E	none		invoke G1 to GL
Karl Heuer's avatar
Karl Heuer committed
587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
   LS2 (locking-shift-2)	none	ESC 'n'		invoke G2 into GL
   LS3 (locking-shift-3)	none	ESC 'o'		invoke G3 into GL
   SS2 (single-shift-2)		0x8E	ESC 'N'		invoke G2 into GL
   SS3 (single-shift-3)		0x8F	ESC 'O'		invoke G3 into GL
   ----------------------------------------------------------------------
   The first four are for locking-shift.  Control characters for these
   functions are defined by macros ISO_CODE_XXX in `coding.h'.

   Designations are done by the following escape sequences.
   ----------------------------------------------------------------------
   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
   of dimension 1, chars 94, and final character <F>, and etc.

   Note (*): Although these designations are not allowed in ISO2022,
   Emacs accepts them on decoding, and produces them on encoding
   CHARS96 character set in a coding system which is characterized as
   7-bit environment, non-locking-shift, and non-single-shift.

   Note (**): If <F> is '@', 'A', or 'B', the intermediate character
   '(' can be omitted.  We call this as "short-form" here after.

   Now you may notice that there are a lot of ways for encoding the
Richard M. Stallman's avatar
Richard M. Stallman committed
629
   same multilingual text in ISO2022.  Actually, there exists many
Karl Heuer's avatar
Karl Heuer committed
630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654
   coding systems such as Compound Text (used in X'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
   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.

   ISO6429's direction specification takes the following format:
	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
   abbreviated to the escape sequence ESC '[' in 7-bit environment.
   
   Character composition specification takes the following format:
	o ESC '0' -- start character composition
	o ESC '1' -- end character composition
   Since these are not standard escape sequences of any ISO, the use
   of them for these meaning is restricted to Emacs only.  */

enum iso_code_class_type iso_code_class[256];

655 656 657 658 659 660
#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)))
661 662 663 664

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

Karl Heuer's avatar
Karl Heuer committed
665 666 667 668
/* 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
669
	CODING_CATEGORY_MASK_ISO_7_TIGHT
Karl Heuer's avatar
Karl Heuer committed
670 671
	CODING_CATEGORY_MASK_ISO_8_1
	CODING_CATEGORY_MASK_ISO_8_2
672 673
	CODING_CATEGORY_MASK_ISO_7_ELSE
	CODING_CATEGORY_MASK_ISO_8_ELSE
Karl Heuer's avatar
Karl Heuer committed
674 675 676 677 678 679 680
   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;
{
681 682 683 684
  int mask = CODING_CATEGORY_MASK_ISO;
  int mask_found = 0;
  int reg[4], shift_out = 0;
  int c, c1, i, charset;
685

686
  reg[0] = CHARSET_ASCII, reg[1] = reg[2] = reg[3] = -1;
687
  while (mask && src < src_end)
Karl Heuer's avatar
Karl Heuer committed
688 689 690 691 692
    {
      c = *src++;
      switch (c)
	{
	case ISO_CODE_ESC:
693
	  if (src >= src_end)
Karl Heuer's avatar
Karl Heuer committed
694 695
	    break;
	  c = *src++;
696
	  if (c >= '(' && c <= '/')
Karl Heuer's avatar
Karl Heuer committed
697
	    {
698 699 700
	      /* Designation sequence for a charset of dimension 1.  */
	      if (src >= src_end)
		break;
701 702 703 704 705 706
	      c1 = *src++;
	      if (c1 < ' ' || c1 >= 0x80
		  || (charset = iso_charset_table[0][c >= ','][c1]) < 0)
		/* Invalid designation sequence.  Just ignore.  */
		break;
	      reg[(c - '(') % 4] = charset;
707 708 709 710 711 712 713 714 715
	    }
	  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.  */
716
		reg[0] = charset = iso_charset_table[1][0][c];
717
	      else if (c >= '(' && c <= '/')
718
		{
719 720
		  if (src >= src_end)
		    break;
721 722 723 724 725 726
		  c1 = *src++;
		  if (c1 < ' ' || c1 >= 0x80
		      || (charset = iso_charset_table[1][c >= ','][c1]) < 0)
		    /* Invalid designation sequence.  Just ignore.  */
		    break;
		  reg[(c - '(') % 4] = charset;
727
		}
728
	      else
729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755
		/* Invalid designation sequence.  Just ignore.  */
		break;
	    }
	  else if (c == 'N' || c == 'n')
	    {
	      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;
		  shift_out = 1;
		}
	      break;
	    }
	  else if (c == 'O' || c == 'o')
	    {
	      if (shift_out == 1)
		{
		  /* Locking shift in.  */
		  mask &= ~CODING_CATEGORY_MASK_ISO_7BIT;
		  mask_found |= CODING_CATEGORY_MASK_ISO_SHIFT;
		  shift_out = 0;
		}
	      break;
Karl Heuer's avatar
Karl Heuer committed
756
	    }
757
	  else if (c == '0' || c == '1' || c == '2')
758 759
	    /* Start/end composition.  Just ignore.  */
	    break;
760
	  else
761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777
	    /* 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;
	  if (! CHARSET_OK (CODING_CATEGORY_IDX_ISO_7_ELSE, charset))
	    mask &= ~CODING_CATEGORY_MASK_ISO_7_ELSE;
	  if (! CHARSET_OK (CODING_CATEGORY_IDX_ISO_8_ELSE, charset))
	    mask &= ~CODING_CATEGORY_MASK_ISO_8_ELSE;
Karl Heuer's avatar
Karl Heuer committed
778 779 780
	  break;

	case ISO_CODE_SO:
781 782 783 784 785 786 787 788 789
	  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;
	    }
790 791
	  break;
	  
792 793 794 795 796 797 798 799 800
	case ISO_CODE_SI:
	  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
801 802 803
	case ISO_CODE_CSI:
	case ISO_CODE_SS2:
	case ISO_CODE_SS3:
804 805 806
	  {
	    int newmask = CODING_CATEGORY_MASK_ISO_8_ELSE;

807 808
	    if (c != ISO_CODE_CSI)
	      {
809 810
		if (coding_system_table[CODING_CATEGORY_IDX_ISO_8_1]->flags
		    & CODING_FLAG_ISO_SINGLE_SHIFT)
811
		  newmask |= CODING_CATEGORY_MASK_ISO_8_1;
812 813
		if (coding_system_table[CODING_CATEGORY_IDX_ISO_8_2]->flags
		    & CODING_FLAG_ISO_SINGLE_SHIFT)
814 815
		  newmask |= CODING_CATEGORY_MASK_ISO_8_2;
	      }
816 817 818
	    if (VECTORP (Vlatin_extra_code_table)
		&& !NILP (XVECTOR (Vlatin_extra_code_table)->contents[c]))
	      {
819 820
		if (coding_system_table[CODING_CATEGORY_IDX_ISO_8_1]->flags
		    & CODING_FLAG_ISO_LATIN_EXTRA)
821
		  newmask |= CODING_CATEGORY_MASK_ISO_8_1;
822 823
		if (coding_system_table[CODING_CATEGORY_IDX_ISO_8_2]->flags
		    & CODING_FLAG_ISO_LATIN_EXTRA)
824 825 826
		  newmask |= CODING_CATEGORY_MASK_ISO_8_2;
	      }
	    mask &= newmask;
827
	    mask_found |= newmask;
828 829
	  }
	  break;
Karl Heuer's avatar
Karl Heuer committed
830 831 832 833 834

	default:
	  if (c < 0x80)
	    break;
	  else if (c < 0xA0)
835
	    {
836 837
	      if (VECTORP (Vlatin_extra_code_table)
		  && !NILP (XVECTOR (Vlatin_extra_code_table)->contents[c]))
838
		{
839 840
		  int newmask = 0;

841 842
		  if (coding_system_table[CODING_CATEGORY_IDX_ISO_8_1]->flags
		      & CODING_FLAG_ISO_LATIN_EXTRA)
843
		    newmask |= CODING_CATEGORY_MASK_ISO_8_1;
844 845
		  if (coding_system_table[CODING_CATEGORY_IDX_ISO_8_2]->flags
		      & CODING_FLAG_ISO_LATIN_EXTRA)
846 847
		    newmask |= CODING_CATEGORY_MASK_ISO_8_2;
		  mask &= newmask;
848
		  mask_found |= newmask;
849
		}
850 851
	      else
		return 0;
852
	    }
Karl Heuer's avatar
Karl Heuer committed
853 854
	  else
	    {
855
	      unsigned char *src_begin = src;
Karl Heuer's avatar
Karl Heuer committed
856

857
	      mask &= ~(CODING_CATEGORY_MASK_ISO_7BIT
858
			| CODING_CATEGORY_MASK_ISO_7_ELSE);
859
	      mask_found |= CODING_CATEGORY_MASK_ISO_8_1;
860
	      while (src < src_end && *src >= 0xA0)
861 862
		src++;
	      if ((src - src_begin - 1) & 1 && src < src_end)
Karl Heuer's avatar
Karl Heuer committed
863
		mask &= ~CODING_CATEGORY_MASK_ISO_8_2;
864 865
	      else
		mask_found |= CODING_CATEGORY_MASK_ISO_8_2;
Karl Heuer's avatar
Karl Heuer committed
866 867 868 869 870
	    }
	  break;
	}
    }

871
  return (mask & mask_found);
Karl Heuer's avatar
Karl Heuer committed
872 873 874
}

/* Decode a character of which charset is CHARSET and the 1st position
875
   code is C1.  If dimension of CHARSET is 2, the 2nd position code is
Karl Heuer's avatar
Karl Heuer committed
876 877 878 879
   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.  */

880 881 882 883 884 885 886 887 888 889 890
#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;						\
      }									\
891
    if (charset_alt >= 0)						\
892
      {									\
893
	if (CHARSET_DIMENSION (charset_alt) == 2)			\
894 895 896 897 898 899
	  {								\
	    ONE_MORE_BYTE (c2);						\
	    if (iso_code_class[(c2) & 0x7F] != ISO_0x20_or_0x7F		\
		&& iso_code_class[(c2) & 0x7F] != ISO_graphic_plane_0)	\
	      {								\
		src--;							\
900
		charset_alt = CHARSET_ASCII;				\
901 902
	      }								\
	  }								\
903 904
	if (!NILP (translation_table)					\
	    && ((c_alt = translate_char (translation_table,		\
905
					 -1, charset_alt, c1, c2)) >= 0)) \
906 907 908 909 910 911 912 913 914 915 916
	  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
917 918 919
  } while (0)

/* Set designation state into CODING.  */
920 921 922 923 924 925
#define DECODE_DESIGNATION(reg, dimension, chars, final_char)		   \
  do {									   \
    int charset = ISO_CHARSET_TABLE (make_number (dimension),		   \
				     make_number (chars),		   \
				     make_number (final_char));		   \
    if (charset >= 0							   \
926 927
	&& (CODING_SPEC_ISO_REQUESTED_DESIGNATION (coding, charset) == reg \
	    || coding->safe_charsets[charset]))				   \
928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948
      {									   \
	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
949 950
  } while (0)

951 952 953 954 955
/* Check if the current composing sequence contains only valid codes.
   If the composing sequence doesn't end before SRC_END, return -1.
   Else, if it contains only valid codes, return 0.
   Else return the length of the composing sequence.  */

956 957
int
check_composing_code (coding, src, src_end)
958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986
     struct coding_system *coding;
     unsigned char *src, *src_end;
{
  unsigned char *src_start = src;
  int invalid_code_found = 0;
  int charset, c, c1, dim;

  while (src < src_end)
    {
      if (*src++ != ISO_CODE_ESC) continue;
      if (src >= src_end) break;
      if ((c = *src++) == '1') /* end of compsition */
	return (invalid_code_found ? src - src_start : 0);
      if (src + 2 >= src_end) break;
      if (!coding->flags & CODING_FLAG_ISO_DESIGNATION)
	invalid_code_found = 1;
      else
	{
	  dim = 0;
	  if (c == '$')
	    {
	      dim = 1;
	      c = (*src >= '@' && *src <= 'B') ? '(' : *src++;
	    }
	  if (c >= '(' && c <= '/')
	    {
	      c1 = *src++;
	      if ((c1 < ' ' || c1 >= 0x80)
		  || (charset = iso_charset_table[dim][c >= ','][c1]) < 0
987
		  || ! coding->safe_charsets[charset]
988 989 990 991 992 993 994 995
		  || (CODING_SPEC_ISO_REQUESTED_DESIGNATION (coding, charset)
		      == CODING_SPEC_ISO_NO_REQUESTED_DESIGNATION))
		invalid_code_found = 1;
	    }
	  else
	    invalid_code_found = 1;
	}
    }
996 997 998
  return (invalid_code_found
	  ? src - src_start
	  : (coding->mode & CODING_MODE_LAST_BLOCK ? 0 : -1));
999 1000
}

Karl Heuer's avatar
Karl Heuer committed
1001 1002 1003
/* See the above "GENERAL NOTES on `decode_coding_XXX ()' functions".  */

int
1004
decode_coding_iso2022 (coding, source, destination, src_bytes, dst_bytes)
Karl Heuer's avatar
Karl Heuer committed
1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
     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);
1021
  Lisp_Object translation_table
1022
    = coding->translation_table_for_decode;
1023
  int result = CODING_FINISH_NORMAL;
1024

1025
  if (!NILP (Venable_character_translation) && NILP (translation_table))
1026
    translation_table = Vstandard_translation_table_for_decode;
Karl Heuer's avatar
Karl Heuer committed
1027

1028
  coding->produced_char = 0;
1029
  coding->fake_multibyte = 0;
1030 1031 1032
  while (src < src_end && (dst_bytes
			   ? (dst < adjusted_dst_end)
			   : (dst < src - 6)))
Karl Heuer's avatar
Karl Heuer committed
1033 1034 1035 1036 1037 1038 1039
    {
      /* 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;
1040
      int c1 = *src++, c2;
Karl Heuer's avatar
Karl Heuer committed
1041 1042 1043 1044 1045 1046 1047 1048 1049

      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;
1050
	      coding->produced_char++;
Karl Heuer's avatar
Karl Heuer committed
1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066
	      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:
1067 1068
	  if (charset1 < 0 || CHARSET_CHARS (charset1) == 94
	      || coding->flags & CODING_FLAG_ISO_SEVEN_BITS)
1069
	    goto label_invalid_code;
Karl Heuer's avatar
Karl Heuer committed
1070 1071 1072
	  /* This is a graphic character, we fall down ... */

	case ISO_graphic_plane_1:
1073
	  if (coding->flags & CODING_FLAG_ISO_SEVEN_BITS)
1074
	    goto label_invalid_code;
1075 1076
	  else
	    DECODE_ISO_CHARACTER (charset1, c1);
Karl Heuer's avatar
Karl Heuer committed
1077 1078 1079 1080 1081
	  break;

	case ISO_control_code:
	  /* All ISO2022 control characters in this class have the
             same representation in Emacs internal format.  */
1082 1083 1084 1085 1086 1087 1088 1089
	  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
1090
	  *dst++ = c1;
1091
	  coding->produced_char++;
Karl Heuer's avatar
Karl Heuer committed
1092 1093 1094 1095
	  break;

	case ISO_carriage_return:
	  if (coding->eol_type == CODING_EOL_CR)
1096
	    *dst++ = '\n';
Karl Heuer's avatar
Karl Heuer committed
1097 1098 1099 1100 1101 1102 1103
	  else if (coding->eol_type == CODING_EOL_CRLF)
	    {
	      ONE_MORE_BYTE (c1);
	      if (c1 == ISO_CODE_LF)
		*dst++ = '\n';
	      else
		{
1104 1105 1106 1107 1108
		  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
1109
		  src--;
1110
		  *dst++ = '\r';
Karl Heuer's avatar
Karl Heuer committed
1111 1112 1113
		}
	    }
	  else
1114 1115
	    *dst++ = c1;
	  coding->produced_char++;
Karl Heuer's avatar
Karl Heuer committed
1116 1117 1118
	  break;

	case ISO_shift_out:
1119 1120 1121
	  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
1122 1123 1124 1125 1126
	  CODING_SPEC_ISO_INVOCATION (coding, 0) = 1;
	  charset0 = CODING_SPEC_ISO_PLANE_CHARSET (coding, 0);
	  break;

	case ISO_shift_in:
1127 1128
	  if (! (coding->flags & CODING_FLAG_ISO_LOCKING_SHIFT))
	    goto label_invalid_code;
Karl Heuer's avatar
Karl Heuer committed
1129 1130 1131 1132 1133 1134
	  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:
1135 1136
	  if (! (coding->flags & CODING_FLAG_ISO_SINGLE_SHIFT))
	    goto label_invalid_code;
Karl Heuer's avatar
Karl Heuer committed
1137 1138 1139 1140 1141
	  /* SS2 is handled as an escape sequence of ESC 'N' */
	  c1 = 'N';
	  goto label_escape_sequence;

	case ISO_single_shift_3:
1142 1143
	  if (! (coding->flags & CODING_FLAG_ISO_SINGLE_SHIFT))
	    goto label_invalid_code;
Karl Heuer's avatar
Karl Heuer committed
1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163
	  /* 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 <= '~'))
1164
		goto label_invalid_code;
Karl Heuer's avatar
Karl Heuer committed
1165 1166
	      ONE_MORE_BYTE (c1);
	      if (c1 != ISO_CODE_ESC)
1167
		goto label_invalid_code;
Karl Heuer's avatar
Karl Heuer committed
1168 1169 1170 1171
	      ONE_MORE_BYTE (c1);
	      goto label_escape_sequence;

	    case '$':		/* designation of 2-byte character set */
1172 1173
	      if (! (coding->flags & CODING_FLAG_ISO_DESIGNATION))
		goto label_invalid_code;
Karl Heuer's avatar
Karl Heuer committed
1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190
	      ONE_MORE_BYTE (c1);
	      if (c1 >= '@' && c1 <= 'B')
		{	/* designation of JISX0208.1978, GB2312.1980,
				   or JISX0208.1980 */
		  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
1191
		goto label_invalid_code;
Karl Heuer's avatar
Karl Heuer committed
1192 1193 1194
	      break;

	    case 'n':		/* invocation of locking-shift-2 */
1195 1196 1197
	      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
1198
	      CODING_SPEC_ISO_INVOCATION (coding, 0) = 2;
1199
	      charset0 = CODING_SPEC_ISO_PLANE_CHARSET (coding, 0);
Karl Heuer's avatar
Karl Heuer committed
1200 1201 1202
	      break;

	    case 'o':		/* invocation of locking-shift-3 */
1203 1204 1205
	      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
1206
	      CODING_SPEC_ISO_INVOCATION (coding, 0) = 3;
1207
	      charset0 = CODING_SPEC_ISO_PLANE_CHARSET (coding, 0);
Karl Heuer's avatar
Karl Heuer committed
1208 1209 1210
	      break;

	    case 'N':		/* invocation of single-shift-2 */
1211 1212 1213
	      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
1214 1215 1216 1217 1218 1219
	      ONE_MORE_BYTE (c1);
	      charset = CODING_SPEC_ISO_DESIGNATION (coding, 2);
	      DECODE_ISO_CHARACTER (charset, c1);
	      break;

	    case 'O':		/* invocation of single-shift-3 */
1220 1221 1222
	      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
1223 1224 1225 1226 1227
	      ONE_MORE_BYTE (c1);
	      charset = CODING_SPEC_ISO_DESIGNATION (coding, 3);
	      DECODE_ISO_CHARACTER (charset, c1);
	      break;

1228 1229 1230 1231 1232 1233 1234 1235 1236 1237
	    case '0': case '2':	/* start composing */
	      /* Before processing composing, we must be sure that all
		 characters being composed are supported by CODING.
		 If not, we must give up composing and insert the
		 bunch of codes for composing as is without decoding.  */
	      {
		int result1;

		result1 = check_composing_code (coding, src, src_end);
		if (result1 == 0)
1238 1239 1240 1241 1242 1243
		  {
		    coding->composing = (c1 == '0'
					 ? COMPOSING_NO_RULE_HEAD
					 : COMPOSING_WITH_RULE_HEAD);
		    coding->produced_char++;
		  }
1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261
		else if (result1 > 0)
		  {
		    if (result1 + 2 < (dst_bytes ? dst_end : src_base) - dst)
		      {
			bcopy (src_base, dst, result1 + 2);
			src += result1;
			dst += result1 + 2;
			coding->produced_char += result1 + 2;
		      }
		    else
		      {
			result = CODING_FINISH_INSUFFICIENT_DST;
			goto label_end_of_loop_2;
		      }
		  }
		else
		  goto label_end_of_loop;
	      }
Karl Heuer's avatar
Karl Heuer committed
1262 1263 1264 1265 1266 1267 1268
	      break;

	    case '1':		/* end composing */
	      coding->composing = COMPOSING_NO;
	      break;

	    case '[':		/* specification of direction */
1269 1270
	      if (coding->flags & CODING_FLAG_ISO_NO_DIRECTION)
		goto label_invalid_code;
Karl Heuer's avatar
Karl Heuer committed
1271
	      /* For the moment, nested direction is not supported.
1272 1273
		 So, `coding->mode & CODING_MODE_DIRECTION' zero means
		 left-to-right, and nozero means right-to-left.  */
Karl Heuer's avatar
Karl Heuer committed
1274 1275 1276 1277
	      ONE_MORE_BYTE (c1);
	      switch (c1)
		{
		case ']':	/* end of the current direction */
1278
		  coding->mode &= ~CODING_MODE_DIRECTION;
Karl Heuer's avatar
Karl Heuer committed
1279 1280 1281 1282 1283

		case '0':	/* end of the current direction */
		case '1':	/* start of left-to-right direction */
		  ONE_MORE_BYTE (c1);
		  if (c1 == ']')
1284
		    coding->mode &= ~CODING_MODE_DIRECTION;
Karl Heuer's avatar
Karl Heuer committed
1285
		  else
1286
		    goto label_invalid_code;
Karl Heuer's avatar
Karl Heuer committed
1287 1288 1289 1290 1291
		  break;

		case '2':	/* start of right-to-left direction */
		  ONE_MORE_BYTE (c1);
		  if (c1 == ']')
1292
		    coding->mode |= CODING_MODE_DIRECTION;
Karl Heuer's avatar
Karl Heuer committed
1293
		  else
1294
		    goto label_invalid_code;
Karl Heuer's avatar
Karl Heuer committed
1295 1296 1297
		  break;

		default:
1298
		  goto label_invalid_code;
Karl Heuer's avatar
Karl Heuer committed
1299 1300 1301 1302
		}
	      break;

	    default:
1303 1304
	      if (! (coding->flags & CODING_FLAG_ISO_DESIGNATION))
		goto label_invalid_code;
Karl Heuer's avatar
Karl Heuer committed
1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316
	      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
		{
1317
		  goto label_invalid_code;
Karl Heuer's avatar
Karl Heuer committed
1318 1319 1320 1321 1322 1323 1324
		}
	    }
	  /* We must update these variables now.  */
	  charset0 = CODING_SPEC_ISO_PLANE_CHARSET (coding, 0);
	  charset1 = CODING_SPEC_ISO_PLANE_CHARSET (coding, 1);
	  break;

1325 1326 1327
	label_invalid_code:
	  while (src_base < src)
	    *dst++ = *src_base++;
1328
	  coding->fake_multibyte = 1;
Karl Heuer's avatar
Karl Heuer committed
1329 1330 1331 1332
	}
      continue;

    label_end_of_loop:
1333 1334
      result = CODING_FINISH_INSUFFICIENT_SRC;
    label_end_of_loop_2:
Karl Heuer's avatar
Karl Heuer committed
1335 1336 1337 1338
      src = src_base;
      break;
    }

1339
  if (src < src_end)
Karl Heuer's avatar
Karl Heuer committed
1340
    {
1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356
      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
1357
    }
1358

1359 1360 1361
  coding->consumed = coding->consumed_char = src - source;
  coding->produced = dst - destination;
  return result;
Karl Heuer's avatar
Karl Heuer committed
1362 1363
}

Richard M. Stallman's avatar
Richard M. Stallman committed
1364
/* ISO2022 encoding stuff.  */