coding.c 211 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

/*** TABLE OF CONTENTS ***

24
  0. General comments
Karl Heuer's avatar
Karl Heuer committed
25
  1. Preamble
Kenichi Handa's avatar
Kenichi Handa committed
26
  2. Emacs' internal format (emacs-mule) handlers
Karl Heuer's avatar
Karl Heuer committed
27 28
  3. ISO2022 handlers
  4. Shift-JIS and BIG5 handlers
Kenichi Handa's avatar
Kenichi Handa committed
29 30 31 32 33
  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
34 35 36

*/

37 38 39
/*** 0. General comments ***/


Karl Heuer's avatar
Karl Heuer committed
40 41 42 43 44
/*** 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
45 46 47
  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
48

Kenichi Handa's avatar
Kenichi Handa committed
49
  0. Emacs' internal format (emacs-mule)
Karl Heuer's avatar
Karl Heuer committed
50 51

  Emacs itself holds a multi-lingual character in a buffer and a string
Richard M. Stallman's avatar
Richard M. Stallman committed
52
  in a special format.  Details are described in section 2.
Karl Heuer's avatar
Karl Heuer committed
53 54 55 56

  1. ISO2022

  The most famous coding system for multiple character sets.  X's
Richard M. Stallman's avatar
Richard M. Stallman committed
57 58 59
  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
60 61 62 63 64

  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
65
  section 4.
Karl Heuer's avatar
Karl Heuer committed
66 67 68 69 70

  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
71 72 73
  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
74

75 76
  4. Raw text

77 78
  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.
79 80

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

Richard M. Stallman's avatar
Richard M. Stallman committed
82
  If a user wants to read/write a text encoded in a coding system not
Karl Heuer's avatar
Karl Heuer committed
83 84 85 86
  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.

87 88
  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
89
  information about it is set in a structure of type `struct
Richard M. Stallman's avatar
Richard M. Stallman committed
90
  coding_system' for rapid processing.  See section 6 for more details.
Karl Heuer's avatar
Karl Heuer committed
91 92 93 94 95 96 97

*/

/*** 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
98
  whereas DOS's format is two-byte sequence of `carriage-return' and
99 100
  `line-feed' codes.  MacOS's format is usually one byte of
  `carriage-return'.
Karl Heuer's avatar
Karl Heuer committed
101

Richard M. Stallman's avatar
Richard M. Stallman committed
102 103
  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
104
  any format of end-of-line.  So, Emacs has information of format of
Richard M. Stallman's avatar
Richard M. Stallman committed
105
  end-of-line in each coding-system.  See section 6 for more details.
Karl Heuer's avatar
Karl Heuer committed
106 107 108 109 110 111 112 113 114 115 116 117

*/

/*** 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
118
detect_coding_emacs_mule (src, src_end)
Karl Heuer's avatar
Karl Heuer committed
119 120 121 122 123 124 125 126
     unsigned char *src, *src_end;
{
  ...
}
#endif

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

127 128 129 130
  These functions decode SRC_BYTES length of unibyte text at SOURCE
  encoded in CODING to Emacs' internal format.  The resulting
  multibyte text goes to a place pointed to by DESTINATION, the length
  of which should not exceed DST_BYTES.
131

132 133 134 135
  These functions set the information of original and decoded texts in
  the members produced, produced_char, consumed, and consumed_char of
  the structure *CODING.  They also set the member result to one of
  CODING_FINISH_XXX indicating how the decoding finished.
136 137 138 139 140 141

  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
142
#if 0
143
static void
144
decode_coding_XXX (coding, source, destination, src_bytes, dst_bytes)
Karl Heuer's avatar
Karl Heuer committed
145 146 147 148 149 150 151 152 153 154
     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
155
  These functions encode SRC_BYTES length text at SOURCE of Emacs'
156 157 158
  internal multibyte format to CODING.  The resulting unibyte text
  goes to a place pointed to by DESTINATION, the length of which
  should not exceed DST_BYTES.
159

160 161 162 163
  These functions set the information of original and encoded texts in
  the members produced, produced_char, consumed, and consumed_char of
  the structure *CODING.  They also set the member result to one of
  CODING_FINISH_XXX indicating how the encoding finished.
164 165

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

  Below is a template of these functions.  */
Karl Heuer's avatar
Karl Heuer committed
170
#if 0
171
static void
172
encode_coding_XXX (coding, source, destination, src_bytes, dst_bytes)
Karl Heuer's avatar
Karl Heuer committed
173 174 175 176 177 178 179 180 181 182
     struct coding_system *coding;
     unsigned char *source, *destination;
     int src_bytes, dst_bytes;
{
  ...
}
#endif

/*** COMMONLY USED MACROS ***/

183 184 185 186 187 188 189
/* The following two macros ONE_MORE_BYTE and TWO_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 `coding',
   `src' and `src_end' to appropriate pointer in advance.  These
   macros are called from decoding routines `decode_coding_XXX', thus
   it is assumed that the source text is unibyte.  */
Karl Heuer's avatar
Karl Heuer committed
190

191 192 193 194 195 196 197 198
#define ONE_MORE_BYTE(c1)					\
  do {								\
    if (src >= src_end)						\
      {								\
	coding->result = CODING_FINISH_INSUFFICIENT_SRC;	\
	goto label_end_of_loop;					\
      }								\
    c1 = *src++;						\
Karl Heuer's avatar
Karl Heuer committed
199 200
  } while (0)

201 202 203 204 205 206 207 208 209
#define TWO_MORE_BYTES(c1, c2)					\
  do {								\
    if (src + 1 >= src_end)					\
      {								\
	coding->result = CODING_FINISH_INSUFFICIENT_SRC;	\
	goto label_end_of_loop;					\
      }								\
    c1 = *src++;						\
    c2 = *src++;						\
Karl Heuer's avatar
Karl Heuer committed
210 211 212
  } while (0)


213 214 215 216 217 218 219 220 221
/* Set C to the next character at the source text pointed by `src'.
   If there are not enough characters in the source, jump to
   `label_end_of_loop'.  The caller should set variables `coding'
   `src', `src_end', and `translation_table' to appropriate pointers
   in advance.  This macro is used in encoding routines
   `encode_coding_XXX', thus it assumes that the source text is in
   multibyte form except for 8-bit characters.  8-bit characters are
   in multibyte form if coding->src_multibyte is nonzero, else they
   are represented by a single byte.  */
Karl Heuer's avatar
Karl Heuer committed
222

223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
#define ONE_MORE_CHAR(c)					\
  do {								\
    int len = src_end - src;					\
    int bytes;							\
    if (len <= 0)						\
      {								\
	coding->result = CODING_FINISH_INSUFFICIENT_SRC;	\
	goto label_end_of_loop;					\
      }								\
    if (coding->src_multibyte					\
	|| UNIBYTE_STR_AS_MULTIBYTE_P (src, len, bytes))	\
      c = STRING_CHAR_AND_LENGTH (src, len, bytes);		\
    else							\
      c = *src, bytes = 1;					\
    if (!NILP (translation_table))				\
238
      c = translate_char (translation_table, c, -1, 0, 0);	\
239
    src += bytes;						\
Karl Heuer's avatar
Karl Heuer committed
240 241 242
  } while (0)


243 244 245 246 247 248 249 250 251 252 253
/* Produce a multibyte form of characater C to `dst'.  Jump to
   `label_end_of_loop' if there's not enough space at `dst'.

   If we are now in the middle of composition sequence, the decoded
   character may be ALTCHAR (for the current composition).  In that
   case, the character goes to coding->cmp_data->data instead of
   `dst'.

   This macro is used in decoding routines.  */

#define EMIT_CHAR(c)							\
Karl Heuer's avatar
Karl Heuer committed
254
  do {									\
255 256 257 258 259 260 261 262 263 264 265 266 267
    if (! COMPOSING_P (coding)						\
	|| coding->composing == COMPOSITION_RELATIVE			\
	|| coding->composing == COMPOSITION_WITH_RULE)			\
      {									\
	int bytes = CHAR_BYTES (c);					\
	if ((dst + bytes) > (dst_bytes ? dst_end : src))		\
	  {								\
	    coding->result = CODING_FINISH_INSUFFICIENT_DST;		\
	    goto label_end_of_loop;					\
	  }								\
	dst += CHAR_STRING (c, dst);					\
	coding->produced_char++;					\
      }									\
Kenichi Handa's avatar
Kenichi Handa committed
268
    									\
269 270 271 272 273 274 275
    if (COMPOSING_P (coding)						\
	&& coding->composing != COMPOSITION_RELATIVE)			\
      {									\
	CODING_ADD_COMPOSITION_COMPONENT (coding, c);			\
	coding->composition_rule_follows				\
	  = coding->composing != COMPOSITION_WITH_ALTCHARS;		\
      }									\
Karl Heuer's avatar
Karl Heuer committed
276 277 278
  } while (0)


279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
#define EMIT_ONE_BYTE(c)					\
  do {								\
    if (dst >= (dst_bytes ? dst_end : src))			\
      {								\
	coding->result = CODING_FINISH_INSUFFICIENT_DST;	\
	goto label_end_of_loop;					\
      }								\
    *dst++ = c;							\
  } while (0)

#define EMIT_TWO_BYTES(c1, c2)					\
  do {								\
    if (dst + 2 > (dst_bytes ? dst_end : src))			\
      {								\
	coding->result = CODING_FINISH_INSUFFICIENT_DST;	\
	goto label_end_of_loop;					\
      }								\
    *dst++ = c1, *dst++ = c2;					\
  } while (0)

#define EMIT_BYTES(from, to)					\
  do {								\
    if (dst + (to - from) > (dst_bytes ? dst_end : src))	\
      {								\
	coding->result = CODING_FINISH_INSUFFICIENT_DST;	\
	goto label_end_of_loop;					\
      }								\
    while (from < to)						\
      *dst++ = *from++;						\
Karl Heuer's avatar
Karl Heuer committed
308 309 310 311 312
  } while (0)


/*** 1. Preamble ***/

313 314 315 316
#ifdef emacs
#include <config.h>
#endif

Karl Heuer's avatar
Karl Heuer committed
317 318 319 320 321 322 323
#include <stdio.h>

#ifdef emacs

#include "lisp.h"
#include "buffer.h"
#include "charset.h"
Kenichi Handa's avatar
Kenichi Handa committed
324
#include "composite.h"
Karl Heuer's avatar
Karl Heuer committed
325 326 327 328 329 330 331 332 333 334 335 336 337
#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;
338
Lisp_Object Qno_conversion, Qundecided;
339
Lisp_Object Qcoding_system_history;
340
Lisp_Object Qsafe_chars;
Kenichi Handa's avatar
Kenichi Handa committed
341
Lisp_Object Qvalid_codes;
Karl Heuer's avatar
Karl Heuer committed
342 343 344 345 346 347

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;

348 349
Lisp_Object Vselect_safe_coding_system_function;

350 351 352
/* 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
353
   decided.  */
354
Lisp_Object eol_mnemonic_undecided;
Karl Heuer's avatar
Karl Heuer committed
355

356 357 358 359
/* 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
360 361
#ifdef emacs

362 363 364
Lisp_Object Vcoding_system_list, Vcoding_system_alist;

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

366 367 368
/* Coding system emacs-mule and raw-text are for converting only
   end-of-line format.  */
Lisp_Object Qemacs_mule, Qraw_text;
369

Karl Heuer's avatar
Karl Heuer committed
370 371 372 373 374 375 376 377 378
/* 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;

379
/* A vector of length 256 which contains information about special
Karl Heuer's avatar
Karl Heuer committed
380
   Latin codes (especially for dealing with Microsoft codes).  */
381
Lisp_Object Vlatin_extra_code_table;
382

383 384 385
/* Flag to inhibit code conversion of end-of-line format.  */
int inhibit_eol_conversion;

386 387 388
/* Flag to inhibit ISO2022 escape sequence detection.  */
int inhibit_iso_escape_detection;

389 390 391
/* Flag to make buffer-file-coding-system inherit from process-coding.  */
int inherit_process_coding_system;

392
/* Coding system to be used to encode text for terminal display.  */
Karl Heuer's avatar
Karl Heuer committed
393 394
struct coding_system terminal_coding;

395 396 397 398 399
/* 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
400 401
struct coding_system keyboard_coding;

402 403 404
/* Default coding system to be used to write a file.  */
struct coding_system default_buffer_file_coding;

405 406 407
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
408

409 410
Lisp_Object Vlocale_coding_system;

Karl Heuer's avatar
Karl Heuer committed
411 412
#endif /* emacs */

413
Lisp_Object Qcoding_category, Qcoding_category_index;
Karl Heuer's avatar
Karl Heuer committed
414 415 416 417

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

418 419
/* Table of coding categories (Lisp symbols).  */
Lisp_Object Vcoding_category_table;
Karl Heuer's avatar
Karl Heuer committed
420 421 422

/* Table of names of symbol for each coding-category.  */
char *coding_category_name[CODING_CATEGORY_IDX_MAX] = {
Kenichi Handa's avatar
Kenichi Handa committed
423
  "coding-category-emacs-mule",
Karl Heuer's avatar
Karl Heuer committed
424 425
  "coding-category-sjis",
  "coding-category-iso-7",
426
  "coding-category-iso-7-tight",
Karl Heuer's avatar
Karl Heuer committed
427 428
  "coding-category-iso-8-1",
  "coding-category-iso-8-2",
429 430
  "coding-category-iso-7-else",
  "coding-category-iso-8-else",
431
  "coding-category-ccl",
Karl Heuer's avatar
Karl Heuer committed
432
  "coding-category-big5",
433 434 435
  "coding-category-utf-8",
  "coding-category-utf-16-be",
  "coding-category-utf-16-le",
436
  "coding-category-raw-text",
437
  "coding-category-binary"
Karl Heuer's avatar
Karl Heuer committed
438 439
};

440
/* Table of pointers to coding systems corresponding to each coding
441 442 443
   categories.  */
struct coding_system *coding_system_table[CODING_CATEGORY_IDX_MAX];

444 445 446 447 448
/* 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];

449 450
/* Flag to tell if we look up translation table on character code
   conversion.  */
451
Lisp_Object Venable_character_translation;
452 453 454 455
/* 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;
456

457 458 459 460
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
461 462 463 464

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

465 466 467
/* Default coding systems used for process I/O.  */
Lisp_Object Vdefault_process_coding_system;

468 469 470 471 472 473
/* 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;

474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
/* Char-table containing safe coding systems of each character.  */
Lisp_Object Vchar_coding_system_table;
Lisp_Object Qchar_coding_system;

/* Return `safe-chars' property of coding system CODING.  Don't check
   validity of CODING.  */

Lisp_Object
coding_safe_chars (coding)
     struct coding_system *coding;
{
  Lisp_Object coding_spec, plist, safe_chars;
  
  coding_spec = Fget (coding->symbol, Qcoding_system);
  plist = XVECTOR (coding_spec)->contents[3];
  safe_chars = Fplist_get (XVECTOR (coding_spec)->contents[3], Qsafe_chars);
  return (CHAR_TABLE_P (safe_chars) ? safe_chars : Qt);
}

#define CODING_SAFE_CHAR_P(safe_chars, c) \
  (EQ (safe_chars, Qt) || !NILP (CHAR_TABLE_REF (safe_chars, c)))

Karl Heuer's avatar
Karl Heuer committed
496

Kenichi Handa's avatar
Kenichi Handa committed
497
/*** 2. Emacs internal format (emacs-mule) handlers ***/
Karl Heuer's avatar
Karl Heuer committed
498 499

/* Emacs' internal format for encoding multiple character sets is a
Richard M. Stallman's avatar
Richard M. Stallman committed
500
   kind of multi-byte encoding, i.e. characters are encoded by
501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
   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.

   8-bit characters of the range 0x80..0x9F are represented by
   two-byte sequences of LEADING_CODE_8_BIT_CONTROL and (their 8-bit
   code + 0x20).

   8-bit characters of the range 0xA0..0xFF are represented by
   one-byte sequences which are their 8-bit code.

   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.
Richard M. Stallman's avatar
Richard M. Stallman committed
521

Karl Heuer's avatar
Karl Heuer committed
522
   --- CODE RANGE of Emacs' internal format ---
523 524 525 526 527 528
   character set	range
   -------------	-----
   ascii		0x00..0x7F
   eight-bit-control	LEADING_CODE_8_BIT_CONTROL + 0xA0..0xBF
   eight-bit-graphic	0xA0..0xBF
   ELSE			0x81..0x9F + [0xA0..0xFF]+
Karl Heuer's avatar
Karl Heuer committed
529 530 531 532 533 534 535 536
   ---------------------------------------------

  */

enum emacs_code_class_type emacs_code_class[256];

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

int
Kenichi Handa's avatar
Kenichi Handa committed
540
detect_coding_emacs_mule (src, src_end)
541
      unsigned char *src, *src_end;
Karl Heuer's avatar
Karl Heuer committed
542 543 544
{
  unsigned char c;
  int composing = 0;
545 546 547
  /* Dummy for ONE_MORE_BYTE.  */
  struct coding_system dummy_coding;
  struct coding_system *coding = &dummy_coding;
Karl Heuer's avatar
Karl Heuer committed
548

549
  while (1)
Karl Heuer's avatar
Karl Heuer committed
550
    {
551
      ONE_MORE_BYTE (c);
Karl Heuer's avatar
Karl Heuer committed
552 553 554 555 556

      if (composing)
	{
	  if (c < 0xA0)
	    composing = 0;
557 558 559 560 561
	  else if (c == 0xA0)
	    {
	      ONE_MORE_BYTE (c);
	      c &= 0x7F;
	    }
Karl Heuer's avatar
Karl Heuer committed
562 563 564 565
	  else
	    c -= 0x20;
	}

566
      if (c < 0x20)
Karl Heuer's avatar
Karl Heuer committed
567 568 569
	{
	  if (c == ISO_CODE_ESC || c == ISO_CODE_SI || c == ISO_CODE_SO)
	    return 0;
570 571 572 573 574 575 576 577 578 579
	}
      else if (c >= 0x80 && c < 0xA0)
	{
	  if (c == 0x80)
	    /* Old leading code for a composite character.  */
	    composing = 1;
	  else
	    {
	      unsigned char *src_base = src - 1;
	      int bytes;
Karl Heuer's avatar
Karl Heuer committed
580

581 582 583 584 585 586 587 588 589 590
	      if (!UNIBYTE_STR_AS_MULTIBYTE_P (src_base, src_end - src_base,
					       bytes))
		return 0;
	      src = src_base + bytes;
	    }
	}
    }
 label_end_of_loop:
  return CODING_CATEGORY_MASK_EMACS_MULE;
}
Karl Heuer's avatar
Karl Heuer committed
591 592


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

595 596 597 598 599 600 601 602 603 604 605 606 607 608 609
static void
decode_coding_emacs_mule (coding, source, destination, src_bytes, dst_bytes)
     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;
  /* SRC_BASE remembers the start position in source in each loop.
     The loop will be exited when there's not enough source code, or
     when there's not enough destination area to produce a
     character.  */
  unsigned char *src_base;
Karl Heuer's avatar
Karl Heuer committed
610

611
  coding->produced_char = 0;
612
  while ((src_base = src) < src_end)
613 614 615
    {
      unsigned char tmp[MAX_MULTIBYTE_LENGTH], *p;
      int bytes;
Kenichi Handa's avatar
Kenichi Handa committed
616

617 618
      if (*src == '\r')
	{
619
	  int c = *src++;
620 621 622 623 624 625 626 627 628 629 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

	  if (coding->eol_type == CODING_EOL_CR)
	    c = '\n';
	  else if (coding->eol_type == CODING_EOL_CRLF)
	    {
	      ONE_MORE_BYTE (c);
	      if (c != '\n')
		{
		  if (coding->mode & CODING_MODE_INHIBIT_INCONSISTENT_EOL)
		    {
		      coding->result = CODING_FINISH_INCONSISTENT_EOL;
		      goto label_end_of_loop;
		    }
		  src--;
		  c = '\r';
		}
	    }
	  *dst++ = c;
	  coding->produced_char++;
	  continue;
	}
      else if (*src == '\n')
	{
	  if ((coding->eol_type == CODING_EOL_CR
	       || coding->eol_type == CODING_EOL_CRLF)
	      && coding->mode & CODING_MODE_INHIBIT_INCONSISTENT_EOL)
	    {
	      coding->result = CODING_FINISH_INCONSISTENT_EOL;
	      goto label_end_of_loop;
	    }
	  *dst++ = *src++;
	  coding->produced_char++;
	  continue;
	}
      else if (UNIBYTE_STR_AS_MULTIBYTE_P (src, src_end - src, bytes))
655 656 657 658 659 660 661 662 663 664 665 666 667
	{
	  p = src;
	  src += bytes;
	}
      else
	{
	  bytes = CHAR_STRING (*src, tmp);
	  p = tmp;
	  src++;
	}
      if (dst + bytes >= (dst_bytes ? dst_end : src))
	{
	  coding->result = CODING_FINISH_INSUFFICIENT_DST;
Karl Heuer's avatar
Karl Heuer committed
668 669
	  break;
	}
670 671
      while (bytes--) *dst++ = *p++;
      coding->produced_char++;
Karl Heuer's avatar
Karl Heuer committed
672
    }
673
 label_end_of_loop:
674 675
  coding->consumed = coding->consumed_char = src_base - source;
  coding->produced = dst - destination;
Karl Heuer's avatar
Karl Heuer committed
676 677
}

678 679 680 681
#define encode_coding_emacs_mule(coding, source, destination, src_bytes, dst_bytes) \
  encode_eol (coding, source, destination, src_bytes, dst_bytes)


Karl Heuer's avatar
Karl Heuer committed
682 683 684 685

/*** 3. ISO2022 handlers ***/

/* The following note describes the coding system ISO2022 briefly.
686 687 688
   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
689 690 691
   original document of ISO2022.

   ISO2022 provides many mechanisms to encode several character sets
692 693 694 695
   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).
696

697
   There are two kinds of character sets: control character set and
Karl Heuer's avatar
Karl Heuer committed
698 699
   graphic character set.  The former contains control characters such
   as `newline' and `escape' to provide control functions (control
700 701
   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
702 703 704
   two control character sets and many graphic character sets.

   Graphic character sets are classified into one of the following
705 706 707 708 709 710 711 712 713 714 715 716
   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
717 718 719 720 721 722 723 724 725

   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

726
   A code area (1 byte=8 bits) is divided into 4 areas, C0, GL, C1, and GR.
Karl Heuer's avatar
Karl Heuer committed
727 728 729 730 731 732
	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
733 734 735 736 737 738 739 740
   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
741 742 743 744 745

   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
746 747 748
   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
749

750 751 752 753
   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
754 755 756

   There are two ways of invocation: locking-shift and single-shift.
   With locking-shift, the invocation lasts until the next different
757 758 759 760
   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
761 762

   ----------------------------------------------------------------------
763
   abbrev  function	             cntrl escape seq	description
Karl Heuer's avatar
Karl Heuer committed
764
   ----------------------------------------------------------------------
765 766 767 768 769 770 771 772 773
   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
774
   ----------------------------------------------------------------------
775 776 777 778
   (*) 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
779

780
   Designations are done by the following escape sequences:
Karl Heuer's avatar
Karl Heuer committed
781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802
   ----------------------------------------------------------------------
   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
803
   of dimension 1, chars 94, and final character <F>, etc...
Karl Heuer's avatar
Karl Heuer committed
804 805 806

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

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

   Now you may notice that there are a lot of ways for encoding the
814 815 816 817
   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
818 819 820 821 822 823
   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.

824
   ISO6429's direction specification takes the following form:
Karl Heuer's avatar
Karl Heuer committed
825 826 827 828 829
	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
830 831 832
   abbreviated to the escape sequence ESC '[' in a 7-bit environment.

   Character composition specification takes the following form:
Kenichi Handa's avatar
Kenichi Handa committed
833 834 835 836 837
	o ESC '0' -- start relative composition
	o ESC '1' -- end composition
	o ESC '2' -- start rule-base composition (*)
	o ESC '3' -- start relative composition with alternate chars  (**)
	o ESC '4' -- start rule-base composition with alternate chars  (**)
838 839
  Since these are not standard escape sequences of any ISO standard,
  the use of them for these meaning is restricted to Emacs only.
Kenichi Handa's avatar
Kenichi Handa committed
840

841 842 843 844
  (*) This form is used only in Emacs 20.5 and the older versions,
  but the newer versions can safely decode it.
  (**) This form is used only in Emacs 21.1 and the newer versions,
  and the older versions can't decode it.
Kenichi Handa's avatar
Kenichi Handa committed
845

846 847
  Here's a list of examples usages of these composition escape
  sequences (categorized by `enum composition_method').
Kenichi Handa's avatar
Kenichi Handa committed
848

849
  COMPOSITION_RELATIVE:
Kenichi Handa's avatar
Kenichi Handa committed
850
	ESC 0 CHAR [ CHAR ] ESC 1
851
  COMPOSITOIN_WITH_RULE:
Kenichi Handa's avatar
Kenichi Handa committed
852
	ESC 2 CHAR [ RULE CHAR ] ESC 1
853
  COMPOSITION_WITH_ALTCHARS:
Kenichi Handa's avatar
Kenichi Handa committed
854
	ESC 3 ALTCHAR [ ALTCHAR ] ESC 0 CHAR [ CHAR ] ESC 1
855
  COMPOSITION_WITH_RULE_ALTCHARS:
Kenichi Handa's avatar
Kenichi Handa committed
856
	ESC 4 ALTCHAR [ RULE ALTCHAR ] ESC 0 CHAR [ CHAR ] ESC 1 */
Karl Heuer's avatar
Karl Heuer committed
857 858 859

enum iso_code_class_type iso_code_class[256];

860 861 862 863 864 865 866 867
#define CHARSET_OK(idx, charset, c)					\
  (coding_system_table[idx]						\
   && (charset == CHARSET_ASCII						\
       || (safe_chars = coding_safe_chars (coding_system_table[idx]),	\
	   CODING_SAFE_CHAR_P (safe_chars, c)))				\
   && (CODING_SPEC_ISO_REQUESTED_DESIGNATION (coding_system_table[idx],	\
					      charset)			\
       != CODING_SPEC_ISO_NO_REQUESTED_DESIGNATION))
868 869 870 871

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

Karl Heuer's avatar
Karl Heuer committed
872 873 874 875
/* 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
876
	CODING_CATEGORY_MASK_ISO_7_TIGHT
Karl Heuer's avatar
Karl Heuer committed
877 878
	CODING_CATEGORY_MASK_ISO_8_1
	CODING_CATEGORY_MASK_ISO_8_2
879 880
	CODING_CATEGORY_MASK_ISO_7_ELSE
	CODING_CATEGORY_MASK_ISO_8_ELSE
Karl Heuer's avatar
Karl Heuer committed
881 882 883 884 885 886 887
   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;
{
888 889
  int mask = CODING_CATEGORY_MASK_ISO;
  int mask_found = 0;
890
  int reg[4], shift_out = 0, single_shifting = 0;
891
  int c, c1, i, charset;
892 893 894
  /* Dummy for ONE_MORE_BYTE.  */
  struct coding_system dummy_coding;
  struct coding_system *coding = &dummy_coding;
895
  Lisp_Object safe_chars;
896

897
  reg[0] = CHARSET_ASCII, reg[1] = reg[2] = reg[3] = -1;
898
  while (mask && src < src_end)
Karl Heuer's avatar
Karl Heuer committed
899
    {
900
      ONE_MORE_BYTE (c);
Karl Heuer's avatar
Karl Heuer committed
901 902 903
      switch (c)
	{
	case ISO_CODE_ESC:
904 905
	  if (inhibit_iso_escape_detection)
	    break;
906
	  single_shifting = 0;
907
	  ONE_MORE_BYTE (c);
908
	  if (c >= '(' && c <= '/')
Karl Heuer's avatar
Karl Heuer committed
909
	    {
910
	      /* Designation sequence for a charset of dimension 1.  */
911
	      ONE_MORE_BYTE (c1);
912 913 914 915 916
	      if (c1 < ' ' || c1 >= 0x80
		  || (charset = iso_charset_table[0][c >= ','][c1]) < 0)
		/* Invalid designation sequence.  Just ignore.  */
		break;
	      reg[(c - '(') % 4] = charset;
917 918 919 920
	    }
	  else if (c == '$')
	    {
	      /* Designation sequence for a charset of dimension 2.  */
921
	      ONE_MORE_BYTE (c);
922 923
	      if (c >= '@' && c <= 'B')
		/* Designation for JISX0208.1978, GB2312, or JISX0208.  */
924
		reg[0] = charset = iso_charset_table[1][0][c];
925
	      else if (c >= '(' && c <= '/')
926
		{
927
		  ONE_MORE_BYTE (c1);
928 929 930 931 932
		  if (c1 < ' ' || c1 >= 0x80
		      || (charset = iso_charset_table[1][c >= ','][c1]) < 0)
		    /* Invalid designation sequence.  Just ignore.  */
		    break;
		  reg[(c - '(') % 4] = charset;
933
		}
934
	      else
935 936 937
		/* Invalid designation sequence.  Just ignore.  */
		break;
	    }
938
	  else if (c == 'N' || c == 'O')
939
	    {
940 941
	      /* ESC <Fe> for SS2 or SS3.  */
	      mask &= CODING_CATEGORY_MASK_ISO_7_ELSE;
942
	      break;
Karl Heuer's avatar
Karl Heuer committed
943
	    }
Kenichi Handa's avatar
Kenichi Handa committed
944 945 946 947 948 949
	  else if (c >= '0' && c <= '4')
	    {
	      /* ESC <Fp> for start/end composition.  */
	      mask_found |= CODING_CATEGORY_MASK_ISO;
	      break;
	    }
950
	  else
951 952 953 954 955
	    /* Invalid escape sequence.  Just ignore.  */
	    break;

	  /* We found a valid designation sequence for CHARSET.  */
	  mask &= ~CODING_CATEGORY_MASK_ISO_8BIT;
956 957
	  c = MAKE_CHAR (charset, 0, 0);
	  if (CHARSET_OK (CODING_CATEGORY_IDX_ISO_7, charset, c))
958 959 960
	    mask_found |= CODING_CATEGORY_MASK_ISO_7;
	  else
	    mask &= ~CODING_CATEGORY_MASK_ISO_7;
961
	  if (CHARSET_OK (CODING_CATEGORY_IDX_ISO_7_TIGHT, charset, c))
962 963 964
	    mask_found |= CODING_CATEGORY_MASK_ISO_7_TIGHT;
	  else
	    mask &= ~CODING_CATEGORY_MASK_ISO_7_TIGHT;
965
	  if (CHARSET_OK (CODING_CATEGORY_IDX_ISO_7_ELSE, charset, c))
966 967
	    mask_found |= CODING_CATEGORY_MASK_ISO_7_ELSE;
	  else
968
	    mask &= ~CODING_CATEGORY_MASK_ISO_7_ELSE;
969
	  if (CHARSET_OK (CODING_CATEGORY_IDX_ISO_8_ELSE, charset, c))
970 971
	    mask_found |= CODING_CATEGORY_MASK_ISO_8_ELSE;
	  else
972
	    mask &= ~CODING_CATEGORY_MASK_ISO_8_ELSE;
Karl Heuer's avatar
Karl Heuer committed
973 974 975
	  break;

	case ISO_CODE_SO:
976 977
	  if (inhibit_iso_escape_detection)
	    break;
978
	  single_shifting = 0;
979 980 981 982 983 984 985 986 987
	  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;
	    }
988 989
	  break;
	  
990
	case ISO_CODE_SI:
991 992
	  if (inhibit_iso_escape_detection)
	    break;
993
	  single_shifting = 0;
994 995 996 997 998 999 1000 1001
	  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
1002
	case ISO_CODE_CSI:
1003
	  single_shifting = 0;
Karl Heuer's avatar
Karl Heuer committed
1004 1005
	case ISO_CODE_SS2:
	case ISO_CODE_SS3:
1006 1007 1008
	  {
	    int newmask = CODING_CATEGORY_MASK_ISO_8_ELSE;

1009 1010
	    if (inhibit_iso_escape_detection)
	      break;
1011 1012
	    if (c != ISO_CODE_CSI)
	      {
1013 1014
		if (coding_system_table[CODING_CATEGORY_IDX_ISO_8_1]->flags
		    & CODING_FLAG_ISO_SINGLE_SHIFT)
1015
		  newmask |= CODING_CATEGORY_MASK_ISO_8_1;
1016 1017
		if (coding_system_table[CODING_CATEGORY_IDX_ISO_8_2]->flags
		    & CODING_FLAG_ISO_SINGLE_SHIFT)
1018
		  newmask |= CODING_CATEGORY_MASK_ISO_8_2;
1019
		single_shifting = 1;
1020
	      }
1021 1022 1023
	    if (VECTORP (Vlatin_extra_code_table)
		&& !NILP (XVECTOR (Vlatin_extra_code_table)->contents[c]))
	      {
1024 1025
		if (coding_system_table[CODING_CATEGORY_IDX_ISO_8_1]->flags
		    & CODING_FLAG_ISO_LATIN_EXTRA)
1026
		  newmask |= CODING_CATEGORY_MASK_ISO_8_1;
1027 1028
		if (coding_system_table[CODING_CATEGORY_IDX_ISO_8_2]->flags
		    & CODING_FLAG_ISO_LATIN_EXTRA)
1029 1030 1031
		  newmask |= CODING_CATEGORY_MASK_ISO_8_2;
	      }
	    mask &= newmask;
1032
	    mask_found |= newmask;
1033 1034
	  }
	  break;
Karl Heuer's avatar
Karl Heuer committed
1035 1036 1037

	default:
	  if (c < 0x80)
1038 1039 1040 1041
	    {
	      single_shifting = 0;
	      break;
	    }
Karl Heuer's avatar
Karl Heuer committed
1042
	  else if (c < 0xA0)
1043
	    {
1044
	      single_shifting = 0;
1045 1046
	      if (VECTORP (Vlatin_extra_code_table)
		  && !NILP (XVECTOR (Vlatin_extra_code_table)->contents[c]))
1047
		{
1048 1049
		  int newmask = 0;

1050 1051
		  if (coding_system_table[CODING_CATEGORY_IDX_ISO_8_1]->flags
		      & CODING_FLAG_ISO_LATIN_EXTRA)
1052
		    newmask |= CODING_CATEGORY_MASK_ISO_8_1;
1053 1054
		  if (coding_system_table[CODING_CATEGORY_IDX_ISO_8_2]->flags
		      & CODING_FLAG_ISO_LATIN_EXTRA)
1055 1056
		    newmask |= CODING_CATEGORY_MASK_ISO_8_2;
		  mask &= newmask;
1057
		  mask_found |= newmask;
1058
		}
1059 1060
	      else
		return 0;
1061
	    }
Karl Heuer's avatar
Karl Heuer committed
1062 1063
	  else
	    {
1064
	      mask &= ~(CODING_CATEGORY_MASK_ISO_7BIT
1065
			| CODING_CATEGORY_MASK_ISO_7_ELSE);
1066
	      mask_found |= CODING_CATEGORY_MASK_ISO_8_1;
1067 1068 1069 1070
	      /* 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.  */
1071 1072
	      if (!single_shifting
		  && mask & CODING_CATEGORY_MASK_ISO_8_2)
1073
		{
1074
		  int i = 1;
1075 1076 1077 1078 1079 1080 1081 1082 1083
		  while (src < src_end)
		    {
		      ONE_MORE_BYTE (c);
		      if (c < 0xA0)
			break;
		      i++;
		    }

		  if (i & 1 && src < src_end)
1084 1085 1086 1087
		    mask &= ~CODING_CATEGORY_MASK_ISO_8_2;
		  else
		    mask_found |= CODING_CATEGORY_MASK_ISO_8_2;
		}
Karl Heuer's avatar
Karl Heuer committed
1088 1089 1090 1091
	    }
	  break;
	}
    }
1092
 label_end_of_loop:
1093
  return (mask & mask_found);
Karl Heuer's avatar
Karl Heuer committed
1094 1095
}

1096 1097 1098 1099
/* Decode a character of which charset is CHARSET, the 1st position
   code is C1, the 2nd position code is C2, and return the decoded
   character code.  If the variable `translation_table' is non-nil,
   returned the translated code.  */
Kenichi Handa's avatar
Kenichi Handa committed
1100

1101 1102 1103 1104
#define DECODE_ISO_CHARACTER(charset, c1, c2)	\
  (NILP (translation_table)			\
   ? MAKE_CHAR (charset, c1, c2)		\
   : translate_char (translation_table, -1, charset, c1, c2))
Karl Heuer's avatar
Karl Heuer committed
1105 1106

/* Set designation state into CODING.  */
1107 1108
#define DECODE_DESIGNATION(reg, dimension, chars, final_char)		   \
  do {									   \
1109
    int charset, c;							   \
1110 1111 1112 1113 1114 1115
    									   \
    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));		   \
1116
    c = MAKE_CHAR (charset, 0, 0);					   \
1117
    if (charset >= 0							   \
1118
	&& (CODING_SPEC_ISO_REQUESTED_DESIGNATION (coding, charset) == reg \
1119
	    || CODING_SAFE_CHAR_P (safe_chars, c)))			   \
1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140
      {									   \
	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
1141 1142
  } while (0)

Kenichi Handa's avatar
Kenichi Handa committed
1143 1144
/* Allocate a memory block for storing information about compositions.
   The block is chained to the already allocated blocks.  */
1145

1146
void
Kenichi Handa's avatar
Kenichi Handa committed
1147
coding_allocate_composition_data (coding, char_offset)
1148
     struct coding_system *coding;
Kenichi Handa's avatar
Kenichi Handa committed
1149
     int char_offset;
1150
{
Kenichi Handa's avatar
Kenichi Handa committed
1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162
  struct composition_data *cmp_data
    = (struct composition_data *) xmalloc (sizeof *cmp_data);

  cmp_data->char_offset = char_offset;
  cmp_data->used = 0;
  cmp_data->prev = coding->cmp_data;
  cmp_data->next = NULL;
  if (coding->cmp_data)
    coding->cmp_data->next = cmp_data;
  coding->cmp_data = cmp_data;
  coding->cmp_data_start = 0;
}
1163

Kenichi Handa's avatar
Kenichi Handa committed
1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193
/* Record the starting position START and METHOD of one composition.  */

#define CODING_ADD_COMPOSITION_START(coding, start, method)	\
  do {								\
    struct composition_data *cmp_data = coding->cmp_data;	\
    int *data = cmp_data->data + cmp_data->used;		\
    coding->cmp_data_start = cmp_data->used;			\
    data[0] = -1;						\
    data[1] = cmp_data->char_offset + start;			\
    data[3] = (int) method;					\
    cmp_data->used += 4;					\
  } while (0)

/* Record the ending position END of the current composition.  */

#define CODING_ADD_COMPOSITION_END(coding, end)			\
  do {								\
    struct composition_data *cmp_data = coding->cmp_data;	\
    int *data = cmp_data->data + coding->cmp_data_start;	\
    data[0] = cmp_data->used - coding->cmp_data_start;		\
    data[2] = cmp_data->char_offset + end;			\
  } while (0)

/* Record one COMPONENT (alternate character or composition rule).  */

#define CODING_ADD_COMPOSITION_COMPONENT(coding, component)	\
  (coding->cmp_data->data[coding->cmp_data->used++] = component)

/* Handle compositoin start sequence ESC 0, ESC 2, ESC 3, or ESC 4.  */

1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237
#define DECODE_COMPOSITION_START(c1)					   \
  do {									   \
    if (coding->composing == COMPOSITION_DISABLED)			   \
      {									   \
      	*dst++ = ISO_CODE_ESC;						   \
	*dst++ = c1 & 0x7f;						   \
	coding->produced_char += 2;					   \
      }									   \
    else if (!COMPOSING_P (coding))					   \
      {									   \
	/* This is surely the start of a composition.  We must be sure	   \
           that coding->cmp_data has enough space to store the		   \
           information about the composition.  If not, terminate the	   \
           current decoding loop, allocate one more memory block for	   \
           coding->cmp_data in the calller, then start the decoding	   \
           loop again.  We can't allocate memory here directly because	   \
           it may cause buffer/string relocation.  */			   \
	if (!coding->cmp_data						   \
	    || (coding->cmp_data->used + COMPOSITION_DATA_MAX_BUNCH_LENGTH \
		>= COMPOSITION_DATA_SIZE))				   \
	  {								   \
	    coding->result = CODING_FINISH_INSUFFICIENT_CMP;		   \
	    goto label_end_of_loop;					   \
	  }								   \
	coding->composing = (c1 == '0' ? COMPOSITION_RELATIVE		   \
			     : c1 == '2' ? COMPOSITION_WITH_RULE	   \
			     : c1 == '3' ? COMPOSITION_WITH_ALTCHARS	   \
			     : COMPOSITION_WITH_RULE_ALTCHARS);		   \
	CODING_ADD_COMPOSITION_START (coding, coding->produced_char,	   \
				      coding->composing);		   \
	coding->composition_rule_follows = 0;				   \
      }									   \
    else								   \
      {									   \
	/* We are already handling a composition.  If the method is	   \
           the following two, the codes following the current escape	   \
           sequence are actual characters stored in a buffer.  */	   \
	if (coding->composing == COMPOSITION_WITH_ALTCHARS		   \
	    || coding->composing == COMPOSITION_WITH_RULE_ALTCHARS)	   \
	  {								   \
	    coding->composing = COMPOSITION_RELATIVE;			   \
	    coding->composition_rule_follows = 0;			   \
	  }								   \
      }									   \
Kenichi Handa's avatar
Kenichi Handa committed
1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272
  } while (0)

/* Handle compositoin end sequence ESC 1.  */

#define DECODE_COMPOSITION_END(c1)					\
  do {									\
    if (coding->composing == COMPOSITION_DISABLED)			\
      {									\
	*dst++ = ISO_CODE_ESC;						\
	*dst++ = c1;							\
	coding->produced_char += 2;					\
      }									\
    else								\
      {									\
	CODING_ADD_COMPOSITION_END (coding, coding->produced_char);	\
	coding->composing = COMPOSITION_NO;				\
      }									\
  } while (0)

/* Decode a composition rule from the byte C1 (and maybe one more byte
   from SRC) and store one encoded composition rule in
   coding->cmp_data.  */

#define DECODE_COMPOSITION_RULE(c1)					\
  do {									\
    int rule = 0;							\
    (c1) -= 32;								\
    if (c1 < 81)		/* old format (before ver.21) */	\
      {									\
	int gref = (c1) / 9;						\
	int nref = (c1) % 9;						\
	if (gref == 4) gref = 10;					\
	if (nref == 4) nref = 10;					\
	rule = COMPOSITION_ENCODE_RULE (gref, nref);			\
      }									\
1273
    else if (c1 < 93)		/* new format (after ver.21) */		\
Kenichi Handa's avatar
Kenichi Handa committed
1274 1275 1276 1277 1278 1279 1280
      {									\
	ONE_MORE_BYTE (c2);						\
	rule = COMPOSITION_ENCODE_RULE (c1 - 81, c2 - 32);		\
      }									\
    CODING_ADD_COMPOSITION_COMPONENT (coding, rule);			\
    coding->composition_rule_follows = 0;				\
  } while (0)
1281

1282

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

1285
static void
1286
decode_coding_iso2022 (coding, source, destination, src_bytes, dst_bytes)
Karl Heuer's avatar
Karl Heuer committed
1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297
     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;
  /* 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);
1298 1299 1300 1301 1302 1303 1304 1305
  /* SRC_BASE remembers the start position in source in each loop.
     The loop will be exited when there's not enough source code
     (within macro ONE_MORE_BYTE), or when there's not enough
     destination area to produce a character (within macro
     EMIT_CHAR).  */
  unsigned char *src_base;
  int c, charset;
  Lisp_Object translation_table;
1306 1307 1308
  Lisp_Object safe_chars;

  safe_chars = coding_safe_chars (coding);
1309

1310 1311 1312 1313 1314 1315 1316 1317
  if (NILP (Venable_character_translation))
    translation_table = Qnil;
  else
    {
      translation_table = coding->translation_table_for_decode;
      if (NILP (translation_table))
	translation_table = Vstandard_translation_table_for_decode;
    }