coding.c 256 KB
Newer Older
Dave Love's avatar
Dave Love committed
1
/* Coding system handler (conversion, detection, 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.
4
   Copyright (C) 2001, 2002 Free Software Foundation, Inc.
Kenichi Handa's avatar
Kenichi Handa committed
5 6 7
   Copyright (C) 2001, 2002
     National Institute of Advanced Industrial Science and Technology (AIST)
     Registration Number H13PRO009
Karl Heuer's avatar
Karl Heuer committed
8

Karl Heuer's avatar
Karl Heuer committed
9 10 11 12 13 14
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
15

Karl Heuer's avatar
Karl Heuer committed
16 17 18 19
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
20

Karl Heuer's avatar
Karl Heuer committed
21 22 23 24
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
25 26 27

/*** TABLE OF CONTENTS ***

28
  0. General comments
Karl Heuer's avatar
Karl Heuer committed
29
  1. Preamble
Kenichi Handa's avatar
Kenichi Handa committed
30 31 32 33 34 35 36 37 38 39 40
  2. Emacs' internal format (emacs-utf-8) handlers
  3. UTF-8 handlers
  4. UTF-16 handlers
  5. Charset-base coding systems handlers
  6. emacs-mule (old Emacs' internal format) handlers
  7. ISO2022 handlers
  8. Shift-JIS and BIG5 handlers
  9. CCL handlers
  10. C library functions
  11. Emacs Lisp library functions
  12. Postamble
Karl Heuer's avatar
Karl Heuer committed
41 42 43

*/

Kenichi Handa's avatar
Kenichi Handa committed
44
/*** 0. General comments ***
45 46


Kenichi Handa's avatar
Kenichi Handa committed
47
CODING SYSTEM
Karl Heuer's avatar
Karl Heuer committed
48

Dave Love's avatar
Dave Love committed
49 50
  A coding system is an object for an encoding mechanism that contains
  information about how to convert byte sequences to character
51 52 53 54 55 56 57 58 59
  sequences and vice versa.  When we say "decode", it means converting
  a byte sequence of a specific coding system into a character
  sequence that is represented by Emacs' internal coding system
  `emacs-utf-8', and when we say "encode", it means converting a
  character sequence of emacs-utf-8 to a byte sequence of a specific
  coding system.

  In Emacs Lisp, a coding system is represented by a Lisp symbol.  In
  C level, a coding system is represented by a vector of attributes
Dave Love's avatar
Dave Love committed
60
  stored in the hash table Vcharset_hash_table.  The conversion from
61 62 63 64
  coding system symbol to attributes vector is done by looking up
  Vcharset_hash_table by the symbol.

  Coding systems are classified into the following types depending on
Dave Love's avatar
Dave Love committed
65
  the encoding mechanism.  Here's a brief description of the types.
Kenichi Handa's avatar
Kenichi Handa committed
66 67 68 69 70 71 72 73

  o UTF-8

  o UTF-16

  o Charset-base coding system

  A coding system defined by one or more (coded) character sets.
Dave Love's avatar
Dave Love committed
74
  Decoding and encoding are done by a code converter defined for each
Kenichi Handa's avatar
Kenichi Handa committed
75 76
  character set.

Dave Love's avatar
Dave Love committed
77
  o Old Emacs internal format (emacs-mule)
Kenichi Handa's avatar
Kenichi Handa committed
78

Dave Love's avatar
Dave Love committed
79
  The coding system adopted by old versions of Emacs (20 and 21).
Karl Heuer's avatar
Karl Heuer committed
80

Kenichi Handa's avatar
Kenichi Handa committed
81
  o ISO2022-base coding system
82

Kenichi Handa's avatar
Kenichi Handa committed
83 84 85 86 87 88 89
  The most famous coding system for multiple character sets.  X's
  Compound Text, various EUCs (Extended Unix Code), and coding systems
  used in the Internet communication such as ISO-2022-JP are all
  variants of ISO2022.

  o SJIS (or Shift-JIS or MS-Kanji-Code)
   
Karl Heuer's avatar
Karl Heuer committed
90 91
  A coding system to encode character sets: ASCII, JISX0201, and
  JISX0208.  Widely used for PC's in Japan.  Details are described in
Kenichi Handa's avatar
Kenichi Handa committed
92
  section 8.
Karl Heuer's avatar
Karl Heuer committed
93

Kenichi Handa's avatar
Kenichi Handa committed
94
  o BIG5
Karl Heuer's avatar
Karl Heuer committed
95

Kenichi Handa's avatar
Kenichi Handa committed
96
  A coding system to encode character sets: ASCII and Big5.  Widely
Dave Love's avatar
Dave Love committed
97
  used for Chinese (mainly in Taiwan and Hong Kong).  Details are
Kenichi Handa's avatar
Kenichi Handa committed
98 99 100
  described in section 8.  In this file, when we write "big5" (all
  lowercase), we mean the coding system, and when we write "Big5"
  (capitalized), we mean the character set.
Karl Heuer's avatar
Karl Heuer committed
101

Kenichi Handa's avatar
Kenichi Handa committed
102
  o CCL
103

Dave Love's avatar
Dave Love committed
104
  If a user wants to decode/encode text encoded in a coding system
Kenichi Handa's avatar
Kenichi Handa committed
105 106 107
  not listed above, he can supply a decoder and an encoder for it in
  CCL (Code Conversion Language) programs.  Emacs executes the CCL
  program while decoding/encoding.
108

Kenichi Handa's avatar
Kenichi Handa committed
109
  o Raw-text
Karl Heuer's avatar
Karl Heuer committed
110

Dave Love's avatar
Dave Love committed
111
  A coding system for text containing raw eight-bit data.  Emacs
Dave Love's avatar
Dave Love committed
112
  treats each byte of source text as a character (except for
Kenichi Handa's avatar
Kenichi Handa committed
113
  end-of-line conversion).
Karl Heuer's avatar
Karl Heuer committed
114

Kenichi Handa's avatar
Kenichi Handa committed
115 116 117
  o No-conversion

  Like raw text, but don't do end-of-line conversion.
Karl Heuer's avatar
Karl Heuer committed
118 119


Kenichi Handa's avatar
Kenichi Handa committed
120
END-OF-LINE FORMAT
Karl Heuer's avatar
Karl Heuer committed
121

Dave Love's avatar
Dave Love committed
122
  How text end-of-line is encoded depends on operating system.  For
Kenichi Handa's avatar
Kenichi Handa committed
123
  instance, Unix's format is just one byte of LF (line-feed) code,
Richard M. Stallman's avatar
Richard M. Stallman committed
124
  whereas DOS's format is two-byte sequence of `carriage-return' and
125 126
  `line-feed' codes.  MacOS's format is usually one byte of
  `carriage-return'.
Karl Heuer's avatar
Karl Heuer committed
127

Dave Love's avatar
Dave Love committed
128
  Since text character encoding and end-of-line encoding are
Kenichi Handa's avatar
Kenichi Handa committed
129 130
  independent, any coding system described above can take any format
  of end-of-line (except for no-conversion).
Karl Heuer's avatar
Karl Heuer committed
131

132 133 134 135 136
STRUCT CODING_SYSTEM

  Before using a coding system for code conversion (i.e. decoding and
  encoding), we setup a structure of type `struct coding_system'.
  This structure keeps various information about a specific code
Dave Love's avatar
Dave Love committed
137
  conversion (e.g. the location of source and destination data).
138

Karl Heuer's avatar
Karl Heuer committed
139 140
*/

Kenichi Handa's avatar
Kenichi Handa committed
141 142 143
/* COMMON MACROS */


Karl Heuer's avatar
Karl Heuer committed
144 145
/*** GENERAL NOTES on `detect_coding_XXX ()' functions ***

Kenichi Handa's avatar
Kenichi Handa committed
146
  These functions check if a byte sequence specified as a source in
147 148
  CODING conforms to the format of XXX, and update the members of
  DETECT_INFO.
Kenichi Handa's avatar
Kenichi Handa committed
149

150
  Return 1 if the byte sequence conforms to XXX, otherwise return 0.
Kenichi Handa's avatar
Kenichi Handa committed
151 152 153

  Below is the template of these functions.  */

Karl Heuer's avatar
Karl Heuer committed
154
#if 0
Kenichi Handa's avatar
Kenichi Handa committed
155
static int
156
detect_coding_XXX (coding, detect_info)
Kenichi Handa's avatar
Kenichi Handa committed
157
     struct coding_system *coding;
158
     struct coding_detection_info *detect_info;
Karl Heuer's avatar
Karl Heuer committed
159
{
Kenichi Handa's avatar
Kenichi Handa committed
160 161 162
  unsigned char *src = coding->source;
  unsigned char *src_end = coding->source + coding->src_bytes;
  int multibytep = coding->src_multibyte;
163
  int consumed_chars = 0;
Kenichi Handa's avatar
Kenichi Handa committed
164 165 166 167 168 169 170 171
  int found = 0;
  ...;

  while (1)
    {
      /* Get one byte from the source.  If the souce is exausted, jump
	 to no_more_source:.  */
      ONE_MORE_BYTE (c);
172 173 174 175 176

      if (! __C_conforms_to_XXX___ (c))
	break;
      if (! __C_strongly_suggests_XXX__ (c))
	found = CATEGORY_MASK_XXX;
Kenichi Handa's avatar
Kenichi Handa committed
177
    }
178 179
  /* The byte sequence is invalid for XXX.  */
  detect_info->rejected |= CATEGORY_MASK_XXX;
Kenichi Handa's avatar
Kenichi Handa committed
180
  return 0;
181

Kenichi Handa's avatar
Kenichi Handa committed
182
 no_more_source:
183 184
  /* The source exausted successfully.  */
  detect_info->found |= found;
Kenichi Handa's avatar
Kenichi Handa committed
185
  return 1;
Karl Heuer's avatar
Karl Heuer committed
186 187 188 189 190
}
#endif

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

Kenichi Handa's avatar
Kenichi Handa committed
191 192 193 194
  These functions decode a byte sequence specified as a source by
  CODING.  The resulting multibyte text goes to a place pointed to by
  CODING->charbuf, the length of which should not exceed
  CODING->charbuf_size;
195

Kenichi Handa's avatar
Kenichi Handa committed
196 197 198 199
  These functions set the information of original and decoded texts in
  CODING->consumed, CODING->consumed_char, and CODING->charbuf_used.
  They also set CODING->result to one of CODING_RESULT_XXX indicating
  how the decoding is finished.
200

Kenichi Handa's avatar
Kenichi Handa committed
201
  Below is the template of these functions.  */
202

Karl Heuer's avatar
Karl Heuer committed
203
#if 0
204
static void
Kenichi Handa's avatar
Kenichi Handa committed
205
decode_coding_XXXX (coding)
Karl Heuer's avatar
Karl Heuer committed
206 207
     struct coding_system *coding;
{
Kenichi Handa's avatar
Kenichi Handa committed
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
  unsigned char *src = coding->source + coding->consumed;
  unsigned char *src_end = coding->source + coding->src_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 no room in CHARBUF for a decoded character.  */
  unsigned char *src_base;
  /* A buffer to produce decoded characters.  */
  int *charbuf = coding->charbuf;
  int *charbuf_end = charbuf + coding->charbuf_size;
  int multibytep = coding->src_multibyte;

  while (1)
    {
      src_base = src;
      if (charbuf < charbuf_end)
	/* No more room to produce a decoded character.  */
	break;
      ONE_MORE_BYTE (c);
      /* Decode it. */
    }

 no_more_source:
  if (src_base < src_end
      && coding->mode & CODING_MODE_LAST_BLOCK)
    /* If the source ends by partial bytes to construct a character,
       treat them as eight-bit raw data.  */
    while (src_base < src_end && charbuf < charbuf_end)
      *charbuf++ = *src_base++;
  /* Remember how many bytes and characters we consumed.  If the
     source is multibyte, the bytes and chars are not identical.  */
  coding->consumed = coding->consumed_char = src_base - coding->source;
  /* Remember how many characters we produced.  */
  coding->charbuf_used = charbuf - coding->charbuf;
Karl Heuer's avatar
Karl Heuer committed
241 242 243 244 245
}
#endif

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

Kenichi Handa's avatar
Kenichi Handa committed
246 247
  These functions encode SRC_BYTES length text at SOURCE of Emacs'
  internal multibyte format by CODING.  The resulting byte sequence
248 249
  goes to a place pointed to by DESTINATION, the length of which
  should not exceed DST_BYTES.
250

Kenichi Handa's avatar
Kenichi Handa committed
251 252 253 254
  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_RESULT_XXX indicating how the encoding finished.
255

Kenichi Handa's avatar
Kenichi Handa committed
256 257 258
  DST_BYTES zero means that source area and destination area are
  overlapped, which means that we can produce a encoded text until it
  reaches at the head of not-yet-encoded source text.
259

Kenichi Handa's avatar
Kenichi Handa committed
260
  Below is a template of these functions.  */
Karl Heuer's avatar
Karl Heuer committed
261
#if 0
262
static void
Kenichi Handa's avatar
Kenichi Handa committed
263
encode_coding_XXX (coding)
Karl Heuer's avatar
Karl Heuer committed
264 265
     struct coding_system *coding;
{
Kenichi Handa's avatar
Kenichi Handa committed
266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
  int multibytep = coding->dst_multibyte;
  int *charbuf = coding->charbuf;
  int *charbuf_end = charbuf->charbuf + coding->charbuf_used;
  unsigned char *dst = coding->destination + coding->produced;
  unsigned char *dst_end = coding->destination + coding->dst_bytes;
  unsigned char *adjusted_dst_end = dst_end - _MAX_BYTES_PRODUCED_IN_LOOP_;
  int produced_chars = 0;

  for (; charbuf < charbuf_end && dst < adjusted_dst_end; charbuf++)
    {
      int c = *charbuf;
      /* Encode C into DST, and increment DST.  */
    }
 label_no_more_destination:
  /* How many chars and bytes we produced.  */
  coding->produced_char += produced_chars;
  coding->produced = dst - coding->destination;
Karl Heuer's avatar
Karl Heuer committed
283 284 285 286 287 288
}
#endif


/*** 1. Preamble ***/

289
#include <config.h>
Karl Heuer's avatar
Karl Heuer committed
290 291 292 293
#include <stdio.h>

#include "lisp.h"
#include "buffer.h"
Kenichi Handa's avatar
Kenichi Handa committed
294
#include "character.h"
Karl Heuer's avatar
Karl Heuer committed
295 296
#include "charset.h"
#include "ccl.h"
Kenichi Handa's avatar
Kenichi Handa committed
297
#include "composite.h"
Karl Heuer's avatar
Karl Heuer committed
298 299 300
#include "coding.h"
#include "window.h"

Kenichi Handa's avatar
Kenichi Handa committed
301
Lisp_Object Vcoding_system_hash_table;
Karl Heuer's avatar
Karl Heuer committed
302

Kenichi Handa's avatar
Kenichi Handa committed
303
Lisp_Object Qcoding_system, Qcoding_aliases, Qeol_type;
304 305
Lisp_Object Qunix, Qdos;
extern Lisp_Object Qmac;	/* frame.c */
Karl Heuer's avatar
Karl Heuer committed
306 307
Lisp_Object Qbuffer_file_coding_system;
Lisp_Object Qpost_read_conversion, Qpre_write_conversion;
Kenichi Handa's avatar
Kenichi Handa committed
308
Lisp_Object Qdefault_char;
309
Lisp_Object Qno_conversion, Qundecided;
Kenichi Handa's avatar
Kenichi Handa committed
310 311
Lisp_Object Qcharset, Qiso_2022, Qutf_8, Qutf_16, Qshift_jis, Qbig5;
Lisp_Object Qsignature, Qendian, Qbig, Qlittle;
312
Lisp_Object Qcoding_system_history;
Kenichi Handa's avatar
Kenichi Handa committed
313
Lisp_Object Qvalid_codes;
Karl Heuer's avatar
Karl Heuer committed
314 315 316 317 318 319

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;

320 321
Lisp_Object Vselect_safe_coding_system_function;

322 323 324
/* 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
325
   decided.  */
326
Lisp_Object eol_mnemonic_undecided;
Karl Heuer's avatar
Karl Heuer committed
327 328 329

#ifdef emacs

330 331 332
Lisp_Object Vcoding_system_list, Vcoding_system_alist;

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

334 335 336
/* Coding system emacs-mule and raw-text are for converting only
   end-of-line format.  */
Lisp_Object Qemacs_mule, Qraw_text;
337

Karl Heuer's avatar
Karl Heuer committed
338 339 340 341 342 343 344 345 346
/* 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;

347
/* A vector of length 256 which contains information about special
Karl Heuer's avatar
Karl Heuer committed
348
   Latin codes (especially for dealing with Microsoft codes).  */
349
Lisp_Object Vlatin_extra_code_table;
350

351 352 353
/* Flag to inhibit code conversion of end-of-line format.  */
int inhibit_eol_conversion;

354 355 356
/* Flag to inhibit ISO2022 escape sequence detection.  */
int inhibit_iso_escape_detection;

357 358 359
/* Flag to make buffer-file-coding-system inherit from process-coding.  */
int inherit_process_coding_system;

360
/* Coding system to be used to encode text for terminal display.  */
Karl Heuer's avatar
Karl Heuer committed
361 362
struct coding_system terminal_coding;

363 364 365 366 367
/* 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
368 369
struct coding_system keyboard_coding;

370 371 372
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
373

374 375
Lisp_Object Vlocale_coding_system;

Karl Heuer's avatar
Karl Heuer committed
376 377
#endif /* emacs */

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

/* Alist of charsets vs revision number.  */
Kenichi Handa's avatar
Kenichi Handa committed
392
static Lisp_Object Vcharset_revision_table;
Karl Heuer's avatar
Karl Heuer committed
393

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

397 398 399 400 401 402
/* 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;

Kenichi Handa's avatar
Kenichi Handa committed
403 404 405 406 407
/* Two special coding systems.  */
Lisp_Object Vsjis_coding_system;
Lisp_Object Vbig5_coding_system;


408 409
static int detect_coding_utf_8 P_ ((struct coding_system *,
				    struct coding_detection_info *info));
Kenichi Handa's avatar
Kenichi Handa committed
410 411 412
static void decode_coding_utf_8 P_ ((struct coding_system *));
static int encode_coding_utf_8 P_ ((struct coding_system *));

413 414
static int detect_coding_utf_16 P_ ((struct coding_system *,
				     struct coding_detection_info *info));
Kenichi Handa's avatar
Kenichi Handa committed
415 416 417
static void decode_coding_utf_16 P_ ((struct coding_system *));
static int encode_coding_utf_16 P_ ((struct coding_system *));

418 419
static int detect_coding_iso_2022 P_ ((struct coding_system *,
				       struct coding_detection_info *info));
Kenichi Handa's avatar
Kenichi Handa committed
420 421 422
static void decode_coding_iso_2022 P_ ((struct coding_system *));
static int encode_coding_iso_2022 P_ ((struct coding_system *));

423 424
static int detect_coding_emacs_mule P_ ((struct coding_system *,
					 struct coding_detection_info *info));
Kenichi Handa's avatar
Kenichi Handa committed
425 426 427
static void decode_coding_emacs_mule P_ ((struct coding_system *));
static int encode_coding_emacs_mule P_ ((struct coding_system *));

428 429
static int detect_coding_sjis P_ ((struct coding_system *,
				   struct coding_detection_info *info));
Kenichi Handa's avatar
Kenichi Handa committed
430 431 432
static void decode_coding_sjis P_ ((struct coding_system *));
static int encode_coding_sjis P_ ((struct coding_system *));

433 434
static int detect_coding_big5 P_ ((struct coding_system *,
				   struct coding_detection_info *info));
Kenichi Handa's avatar
Kenichi Handa committed
435 436 437
static void decode_coding_big5 P_ ((struct coding_system *));
static int encode_coding_big5 P_ ((struct coding_system *));

438 439
static int detect_coding_ccl P_ ((struct coding_system *,
				  struct coding_detection_info *info));
Kenichi Handa's avatar
Kenichi Handa committed
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 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 504 505 506 507 508
static void decode_coding_ccl P_ ((struct coding_system *));
static int encode_coding_ccl P_ ((struct coding_system *));

static void decode_coding_raw_text P_ ((struct coding_system *));
static int encode_coding_raw_text P_ ((struct coding_system *));


/* ISO2022 section */

#define CODING_ISO_INITIAL(coding, reg)			\
  (XINT (AREF (AREF (CODING_ID_ATTRS ((coding)->id),	\
		     coding_attr_iso_initial),		\
	       reg)))


#define CODING_ISO_REQUEST(coding, charset_id)	\
  ((charset_id <= (coding)->max_charset_id	\
    ? (coding)->safe_charsets[charset_id]	\
    : -1))


#define CODING_ISO_FLAGS(coding)	\
  ((coding)->spec.iso_2022.flags)
#define CODING_ISO_DESIGNATION(coding, reg)	\
  ((coding)->spec.iso_2022.current_designation[reg])
#define CODING_ISO_INVOCATION(coding, plane)	\
  ((coding)->spec.iso_2022.current_invocation[plane])
#define CODING_ISO_SINGLE_SHIFTING(coding)	\
  ((coding)->spec.iso_2022.single_shifting)
#define CODING_ISO_BOL(coding)	\
  ((coding)->spec.iso_2022.bol)
#define CODING_ISO_INVOKED_CHARSET(coding, plane)	\
  CODING_ISO_DESIGNATION ((coding), CODING_ISO_INVOCATION ((coding), (plane)))

/* Control characters of ISO2022.  */
			/* code */	/* function */
#define ISO_CODE_LF	0x0A		/* line-feed */
#define ISO_CODE_CR	0x0D		/* carriage-return */
#define ISO_CODE_SO	0x0E		/* shift-out */
#define ISO_CODE_SI	0x0F		/* shift-in */
#define ISO_CODE_SS2_7	0x19		/* single-shift-2 for 7-bit code */
#define ISO_CODE_ESC	0x1B		/* escape */
#define ISO_CODE_SS2	0x8E		/* single-shift-2 */
#define ISO_CODE_SS3	0x8F		/* single-shift-3 */
#define ISO_CODE_CSI	0x9B		/* control-sequence-introducer */

/* All code (1-byte) of ISO2022 is classified into one of the
   followings.  */
enum iso_code_class_type
  {
    ISO_control_0,		/* Control codes in the range
				   0x00..0x1F and 0x7F, except for the
				   following 5 codes.  */
    ISO_carriage_return,	/* ISO_CODE_CR (0x0D) */
    ISO_shift_out,		/* ISO_CODE_SO (0x0E) */
    ISO_shift_in,		/* ISO_CODE_SI (0x0F) */
    ISO_single_shift_2_7,	/* ISO_CODE_SS2_7 (0x19) */
    ISO_escape,			/* ISO_CODE_SO (0x1B) */
    ISO_control_1,		/* Control codes in the range
				   0x80..0x9F, except for the
				   following 3 codes.  */
    ISO_single_shift_2,		/* ISO_CODE_SS2 (0x8E) */
    ISO_single_shift_3,		/* ISO_CODE_SS3 (0x8F) */
    ISO_control_sequence_introducer, /* ISO_CODE_CSI (0x9B) */
    ISO_0x20_or_0x7F,		/* Codes of the values 0x20 or 0x7F.  */
    ISO_graphic_plane_0,	/* Graphic codes in the range 0x21..0x7E.  */
    ISO_0xA0_or_0xFF,		/* Codes of the values 0xA0 or 0xFF.  */
    ISO_graphic_plane_1		/* Graphic codes in the range 0xA1..0xFE.  */
  };
509

Kenichi Handa's avatar
Kenichi Handa committed
510 511
/** The macros CODING_ISO_FLAG_XXX defines a flag bit of the
    `iso-flags' attribute of an iso2022 coding system.  */
512

Kenichi Handa's avatar
Kenichi Handa committed
513 514 515
/* If set, produce long-form designation sequence (e.g. ESC $ ( A)
   instead of the correct short-form sequence (e.g. ESC $ A).  */
#define CODING_ISO_FLAG_LONG_FORM	0x0001
516

Kenichi Handa's avatar
Kenichi Handa committed
517 518 519
/* If set, reset graphic planes and registers at end-of-line to the
   initial state.  */
#define CODING_ISO_FLAG_RESET_AT_EOL	0x0002
520

Kenichi Handa's avatar
Kenichi Handa committed
521 522 523
/* If set, reset graphic planes and registers before any control
   characters to the initial state.  */
#define CODING_ISO_FLAG_RESET_AT_CNTL	0x0004
Karl Heuer's avatar
Karl Heuer committed
524

Kenichi Handa's avatar
Kenichi Handa committed
525 526
/* If set, encode by 7-bit environment.  */
#define CODING_ISO_FLAG_SEVEN_BITS	0x0008
527

Kenichi Handa's avatar
Kenichi Handa committed
528 529
/* If set, use locking-shift function.  */
#define CODING_ISO_FLAG_LOCKING_SHIFT	0x0010
530

Kenichi Handa's avatar
Kenichi Handa committed
531 532 533
/* If set, use single-shift function.  Overwrite
   CODING_ISO_FLAG_LOCKING_SHIFT.  */
#define CODING_ISO_FLAG_SINGLE_SHIFT	0x0020
534

Kenichi Handa's avatar
Kenichi Handa committed
535 536
/* If set, use designation escape sequence.  */
#define CODING_ISO_FLAG_DESIGNATION	0x0040
537

Kenichi Handa's avatar
Kenichi Handa committed
538 539
/* If set, produce revision number sequence.  */
#define CODING_ISO_FLAG_REVISION	0x0080
Richard M. Stallman's avatar
Richard M. Stallman committed
540

Kenichi Handa's avatar
Kenichi Handa committed
541 542
/* If set, produce ISO6429's direction specifying sequence.  */
#define CODING_ISO_FLAG_DIRECTION	0x0100
Karl Heuer's avatar
Karl Heuer committed
543

Kenichi Handa's avatar
Kenichi Handa committed
544 545 546
/* If set, assume designation states are reset at beginning of line on
   output.  */
#define CODING_ISO_FLAG_INIT_AT_BOL	0x0200
547

Kenichi Handa's avatar
Kenichi Handa committed
548 549 550
/* If set, designation sequence should be placed at beginning of line
   on output.  */
#define CODING_ISO_FLAG_DESIGNATE_AT_BOL 0x0400
551

Kenichi Handa's avatar
Kenichi Handa committed
552 553
/* If set, do not encode unsafe charactes on output.  */
#define CODING_ISO_FLAG_SAFE		0x0800
554

Kenichi Handa's avatar
Kenichi Handa committed
555 556 557
/* If set, extra latin codes (128..159) are accepted as a valid code
   on input.  */
#define CODING_ISO_FLAG_LATIN_EXTRA	0x1000
558

Kenichi Handa's avatar
Kenichi Handa committed
559
#define CODING_ISO_FLAG_COMPOSITION	0x2000
560

Kenichi Handa's avatar
Kenichi Handa committed
561
#define CODING_ISO_FLAG_EUC_TW_SHIFT	0x4000
562

563 564 565 566 567
#define CODING_ISO_FLAG_USE_ROMAN	0x8000

#define CODING_ISO_FLAG_USE_OLDJIS	0x10000

#define CODING_ISO_FLAG_FULL_SUPPORT	0x100000
568

Kenichi Handa's avatar
Kenichi Handa committed
569 570 571
/* A character to be produced on output if encoding of the original
   character is prohibited by CODING_ISO_FLAG_SAFE.  */
#define CODING_INHIBIT_CHARACTER_SUBSTITUTION  '?'
572 573


Kenichi Handa's avatar
Kenichi Handa committed
574 575 576
/* UTF-16 section */
#define CODING_UTF_16_BOM(coding)	\
  ((coding)->spec.utf_16.bom)
Karl Heuer's avatar
Karl Heuer committed
577

Kenichi Handa's avatar
Kenichi Handa committed
578 579
#define CODING_UTF_16_ENDIAN(coding)	\
  ((coding)->spec.utf_16.endian)
Karl Heuer's avatar
Karl Heuer committed
580

Kenichi Handa's avatar
Kenichi Handa committed
581 582
#define CODING_UTF_16_SURROGATE(coding)	\
  ((coding)->spec.utf_16.surrogate)
Karl Heuer's avatar
Karl Heuer committed
583 584


Kenichi Handa's avatar
Kenichi Handa committed
585 586 587 588 589 590 591 592
/* CCL section */
#define CODING_CCL_DECODER(coding)	\
  AREF (CODING_ID_ATTRS ((coding)->id), coding_attr_ccl_decoder)
#define CODING_CCL_ENCODER(coding)	\
  AREF (CODING_ID_ATTRS ((coding)->id), coding_attr_ccl_encoder)
#define CODING_CCL_VALIDS(coding)					   \
  (XSTRING (AREF (CODING_ID_ATTRS ((coding)->id), coding_attr_ccl_valids)) \
   ->data)
Karl Heuer's avatar
Karl Heuer committed
593

Dave Love's avatar
Dave Love committed
594
/* Index for each coding category in `coding_categories' */
Karl Heuer's avatar
Karl Heuer committed
595

Kenichi Handa's avatar
Kenichi Handa committed
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 629 630 631 632 633 634 635 636 637
enum coding_category
  {
    coding_category_iso_7,
    coding_category_iso_7_tight,
    coding_category_iso_8_1,
    coding_category_iso_8_2,
    coding_category_iso_7_else,
    coding_category_iso_8_else,
    coding_category_utf_8,
    coding_category_utf_16_auto,
    coding_category_utf_16_be,
    coding_category_utf_16_le,
    coding_category_utf_16_be_nosig,
    coding_category_utf_16_le_nosig,
    coding_category_charset,
    coding_category_sjis,
    coding_category_big5,
    coding_category_ccl,
    coding_category_emacs_mule,
    /* All above are targets of code detection.  */
    coding_category_raw_text,
    coding_category_undecided,
    coding_category_max
  };

/* Definitions of flag bits used in detect_coding_XXXX.  */
#define CATEGORY_MASK_ISO_7		(1 << coding_category_iso_7)
#define CATEGORY_MASK_ISO_7_TIGHT	(1 << coding_category_iso_7_tight)
#define CATEGORY_MASK_ISO_8_1		(1 << coding_category_iso_8_1)
#define CATEGORY_MASK_ISO_8_2		(1 << coding_category_iso_8_2)
#define CATEGORY_MASK_ISO_7_ELSE	(1 << coding_category_iso_7_else)
#define CATEGORY_MASK_ISO_8_ELSE	(1 << coding_category_iso_8_else)
#define CATEGORY_MASK_UTF_8		(1 << coding_category_utf_8)
#define CATEGORY_MASK_UTF_16_BE		(1 << coding_category_utf_16_be)
#define CATEGORY_MASK_UTF_16_LE		(1 << coding_category_utf_16_le)
#define CATEGORY_MASK_UTF_16_BE_NOSIG	(1 << coding_category_utf_16_be_nosig)
#define CATEGORY_MASK_UTF_16_LE_NOSIG	(1 << coding_category_utf_16_le_nosig)
#define CATEGORY_MASK_CHARSET		(1 << coding_category_charset)
#define CATEGORY_MASK_SJIS		(1 << coding_category_sjis)
#define CATEGORY_MASK_BIG5		(1 << coding_category_big5)
#define CATEGORY_MASK_CCL		(1 << coding_category_ccl)
#define CATEGORY_MASK_EMACS_MULE	(1 << coding_category_emacs_mule)
638
#define CATEGORY_MASK_RAW_TEXT		(1 << coding_category_raw_text)
Kenichi Handa's avatar
Kenichi Handa committed
639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730

/* This value is returned if detect_coding_mask () find nothing other
   than ASCII characters.  */
#define CATEGORY_MASK_ANY		\
  (CATEGORY_MASK_ISO_7			\
   | CATEGORY_MASK_ISO_7_TIGHT		\
   | CATEGORY_MASK_ISO_8_1		\
   | CATEGORY_MASK_ISO_8_2		\
   | CATEGORY_MASK_ISO_7_ELSE		\
   | CATEGORY_MASK_ISO_8_ELSE		\
   | CATEGORY_MASK_UTF_8		\
   | CATEGORY_MASK_UTF_16_BE		\
   | CATEGORY_MASK_UTF_16_LE		\
   | CATEGORY_MASK_UTF_16_BE_NOSIG	\
   | CATEGORY_MASK_UTF_16_LE_NOSIG	\
   | CATEGORY_MASK_CHARSET		\
   | CATEGORY_MASK_SJIS			\
   | CATEGORY_MASK_BIG5			\
   | CATEGORY_MASK_CCL			\
   | CATEGORY_MASK_EMACS_MULE)


#define CATEGORY_MASK_ISO_7BIT \
  (CATEGORY_MASK_ISO_7 | CATEGORY_MASK_ISO_7_TIGHT)

#define CATEGORY_MASK_ISO_8BIT \
  (CATEGORY_MASK_ISO_8_1 | CATEGORY_MASK_ISO_8_2)

#define CATEGORY_MASK_ISO_ELSE \
  (CATEGORY_MASK_ISO_7_ELSE | CATEGORY_MASK_ISO_8_ELSE)

#define CATEGORY_MASK_ISO_ESCAPE	\
  (CATEGORY_MASK_ISO_7			\
   | CATEGORY_MASK_ISO_7_TIGHT		\
   | CATEGORY_MASK_ISO_7_ELSE		\
   | CATEGORY_MASK_ISO_8_ELSE)

#define CATEGORY_MASK_ISO	\
  (  CATEGORY_MASK_ISO_7BIT	\
     | CATEGORY_MASK_ISO_8BIT	\
     | CATEGORY_MASK_ISO_ELSE)

#define CATEGORY_MASK_UTF_16		\
  (CATEGORY_MASK_UTF_16_BE		\
   | CATEGORY_MASK_UTF_16_LE		\
   | CATEGORY_MASK_UTF_16_BE_NOSIG	\
   | CATEGORY_MASK_UTF_16_LE_NOSIG)


/* List of symbols `coding-category-xxx' ordered by priority.  This
   variable is exposed to Emacs Lisp.  */
static Lisp_Object Vcoding_category_list;

/* Table of coding categories (Lisp symbols).  This variable is for
   internal use oly.  */
static Lisp_Object Vcoding_category_table;

/* Table of coding-categories ordered by priority.  */
static enum coding_category coding_priorities[coding_category_max];

/* Nth element is a coding context for the coding system bound to the
   Nth coding category.  */
static struct coding_system coding_categories[coding_category_max];

static int detected_mask[coding_category_raw_text] =
  { CATEGORY_MASK_ISO,
    CATEGORY_MASK_ISO,
    CATEGORY_MASK_ISO,
    CATEGORY_MASK_ISO,
    CATEGORY_MASK_ISO,
    CATEGORY_MASK_ISO,
    CATEGORY_MASK_UTF_8,
    CATEGORY_MASK_UTF_16,
    CATEGORY_MASK_UTF_16,
    CATEGORY_MASK_UTF_16,
    CATEGORY_MASK_UTF_16,
    CATEGORY_MASK_UTF_16,
    CATEGORY_MASK_CHARSET,
    CATEGORY_MASK_SJIS,
    CATEGORY_MASK_BIG5,
    CATEGORY_MASK_CCL,
    CATEGORY_MASK_EMACS_MULE
  };

/*** Commonly used macros and functions ***/

#ifndef min
#define min(a, b) ((a) < (b) ? (a) : (b))
#endif
#ifndef max
#define max(a, b) ((a) > (b) ? (a) : (b))
#endif
Karl Heuer's avatar
Karl Heuer committed
731

Kenichi Handa's avatar
Kenichi Handa committed
732 733 734 735 736 737 738 739
#define CODING_GET_INFO(coding, attrs, eol_type, charset_list)	\
  do {								\
    attrs = CODING_ID_ATTRS (coding->id);			\
    eol_type = CODING_ID_EOL_TYPE (coding->id);			\
    if (VECTORP (eol_type))					\
      eol_type = Qunix;						\
    charset_list = CODING_ATTR_CHARSET_LIST (attrs);		\
  } while (0)
Karl Heuer's avatar
Karl Heuer committed
740 741


Kenichi Handa's avatar
Kenichi Handa committed
742 743 744 745 746 747
/* Safely get one byte from the source text pointed by SRC which ends
   at SRC_END, and set C to that byte.  If there are not enough bytes
   in the source, it jumps to `no_more_source'.  The caller
   should declare and set these variables appropriately in advance:
	src, src_end, multibytep
*/
748

Kenichi Handa's avatar
Kenichi Handa committed
749
#define ONE_MORE_BYTE(c)					\
750
  do {								\
Kenichi Handa's avatar
Kenichi Handa committed
751 752 753 754 755 756 757 758 759 760 761 762 763 764
    if (src == src_end)						\
      {								\
	if (src_base < src)					\
	  coding->result = CODING_RESULT_INSUFFICIENT_SRC;	\
	goto no_more_source;					\
      }								\
    c = *src++;							\
    if (multibytep && (c & 0x80))				\
      {								\
	if ((c & 0xFE) != 0xC0)					\
	  error ("Undecodable char found");			\
	c = ((c & 1) << 6) | *src++;				\
      }								\
    consumed_chars++;						\
765 766 767
  } while (0)


Kenichi Handa's avatar
Kenichi Handa committed
768 769 770 771 772 773 774 775 776
#define ONE_MORE_BYTE_NO_CHECK(c)		\
  do {						\
    c = *src++;					\
    if (multibytep && (c & 0x80))		\
      {						\
	if ((c & 0xFE) != 0xC0)			\
	  error ("Undecodable char found");	\
	c = ((c & 1) << 6) | *src++;		\
      }						\
777
    consumed_chars++;				\
778 779 780
  } while (0)


Kenichi Handa's avatar
Kenichi Handa committed
781 782 783 784 785
/* Store a byte C in the place pointed by DST and increment DST to the
   next free point, and increment PRODUCED_CHARS.  The caller should
   assure that C is 0..127, and declare and set the variable `dst'
   appropriately in advance.
*/
786 787


Kenichi Handa's avatar
Kenichi Handa committed
788 789 790 791 792
#define EMIT_ONE_ASCII_BYTE(c)	\
  do {				\
    produced_chars++;		\
    *dst++ = (c);		\
  } while (0)
793 794


Kenichi Handa's avatar
Kenichi Handa committed
795
/* Like EMIT_ONE_ASCII_BYTE byt store two bytes; C1 and C2.  */
796

Kenichi Handa's avatar
Kenichi Handa committed
797 798 799 800 801
#define EMIT_TWO_ASCII_BYTES(c1, c2)	\
  do {					\
    produced_chars += 2;		\
    *dst++ = (c1), *dst++ = (c2);	\
  } while (0)
802

Kenichi Handa's avatar
Kenichi Handa committed
803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821

/* Store a byte C in the place pointed by DST and increment DST to the
   next free point, and increment PRODUCED_CHARS.  If MULTIBYTEP is
   nonzero, store in an appropriate multibyte from.  The caller should
   declare and set the variables `dst' and `multibytep' appropriately
   in advance.  */

#define EMIT_ONE_BYTE(c)		\
  do {					\
    produced_chars++;			\
    if (multibytep)			\
      {					\
	int ch = (c);			\
	if (ch >= 0x80)			\
	  ch = BYTE8_TO_CHAR (ch);	\
	CHAR_STRING_ADVANCE (ch, dst);	\
      }					\
    else				\
      *dst++ = (c);			\
822 823 824
  } while (0)


Kenichi Handa's avatar
Kenichi Handa committed
825
/* Like EMIT_ONE_BYTE, but emit two bytes; C1 and C2.  */
826

827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847
#define EMIT_TWO_BYTES(c1, c2)		\
  do {					\
    produced_chars += 2;		\
    if (multibytep)			\
      {					\
	int ch;				\
					\
	ch = (c1);			\
	if (ch >= 0x80)			\
	  ch = BYTE8_TO_CHAR (ch);	\
	CHAR_STRING_ADVANCE (ch, dst);	\
	ch = (c2);			\
	if (ch >= 0x80)			\
	  ch = BYTE8_TO_CHAR (ch);	\
	CHAR_STRING_ADVANCE (ch, dst);	\
      }					\
    else				\
      {					\
	*dst++ = (c1);			\
	*dst++ = (c2);			\
      }					\
848 849 850
  } while (0)


Kenichi Handa's avatar
Kenichi Handa committed
851 852 853 854 855
#define EMIT_THREE_BYTES(c1, c2, c3)	\
  do {					\
    EMIT_ONE_BYTE (c1);			\
    EMIT_TWO_BYTES (c2, c3);		\
  } while (0)
856 857


Kenichi Handa's avatar
Kenichi Handa committed
858 859 860 861 862
#define EMIT_FOUR_BYTES(c1, c2, c3, c4)		\
  do {						\
    EMIT_TWO_BYTES (c1, c2);			\
    EMIT_TWO_BYTES (c3, c4);			\
  } while (0)
863 864


Kenichi Handa's avatar
Kenichi Handa committed
865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880
#define CODING_DECODE_CHAR(coding, src, src_base, src_end, charset, code, c) \
  do {									     \
    charset_map_loaded = 0;						     \
    c = DECODE_CHAR (charset, code);					     \
    if (charset_map_loaded)						     \
      {									     \
	unsigned char *orig = coding->source;				     \
	EMACS_INT offset;						     \
									     \
	coding_set_source (coding);					     \
	offset = coding->source - orig;					     \
	src += offset;							     \
	src_base += offset;						     \
	src_end += offset;						     \
      }									     \
  } while (0)
881 882


Kenichi Handa's avatar
Kenichi Handa committed
883 884 885 886 887 888 889 890 891 892
#define ASSURE_DESTINATION(bytes)				\
  do {								\
    if (dst + (bytes) >= dst_end)				\
      {								\
	int more_bytes = charbuf_end - charbuf + (bytes);	\
								\
	dst = alloc_destination (coding, more_bytes, dst);	\
	dst_end = coding->destination + coding->dst_bytes;	\
      }								\
  } while (0)
893

Kenichi Handa's avatar
Kenichi Handa committed
894 895 896 897 898 899 900 901


static void
coding_set_source (coding)
     struct coding_system *coding;
{
  if (BUFFERP (coding->src_object))
    {
902 903
      struct buffer *buf = XBUFFER (coding->src_object);

Kenichi Handa's avatar
Kenichi Handa committed
904
      if (coding->src_pos < 0)
905
	coding->source = BUF_GAP_END_ADDR (buf) + coding->src_pos_byte;
Kenichi Handa's avatar
Kenichi Handa committed
906
      else
907
	coding->source = BUF_BYTE_ADDRESS (buf, coding->src_pos_byte);
908
    }
Kenichi Handa's avatar
Kenichi Handa committed
909
  else if (STRINGP (coding->src_object))
910
    {
Kenichi Handa's avatar
Kenichi Handa committed
911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926
      coding->source = (XSTRING (coding->src_object)->data
			+ coding->src_pos_byte);
    }
  else
    /* Otherwise, the source is C string and is never relocated
       automatically.  Thus we don't have to update anything.  */
    ;
}

static void
coding_set_destination (coding)
     struct coding_system *coding;
{
  if (BUFFERP (coding->dst_object))
    {
      if (coding->src_pos < 0)
927 928 929 930 931 932
	{
	  coding->destination = BEG_ADDR + coding->dst_pos_byte - 1;
	  coding->dst_bytes = (GAP_END_ADDR
			       - (coding->src_bytes - coding->consumed)
			       - coding->destination);
	}
Kenichi Handa's avatar
Kenichi Handa committed
933
      else
934 935 936 937 938 939 940 941
	{
	  /* We are sure that coding->dst_pos_byte is before the gap
	     of the buffer. */
	  coding->destination = (BUF_BEG_ADDR (XBUFFER (coding->dst_object))
				 + coding->dst_pos_byte - 1);
	  coding->dst_bytes = (BUF_GAP_END_ADDR (XBUFFER (coding->dst_object))
			       - coding->destination);
	}
Kenichi Handa's avatar
Kenichi Handa committed
942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964
    }
  else
    /* Otherwise, the destination is C string and is never relocated
       automatically.  Thus we don't have to update anything.  */
    ;
}


static void
coding_alloc_by_realloc (coding, bytes)
     struct coding_system *coding;
     EMACS_INT bytes;
{
  coding->destination = (unsigned char *) xrealloc (coding->destination,
						    coding->dst_bytes + bytes);
  coding->dst_bytes += bytes;
}

static void
coding_alloc_by_making_gap (coding, bytes)
     struct coding_system *coding;
     EMACS_INT bytes;
{
965 966
  if (BUFFERP (coding->dst_object)
      && EQ (coding->src_object, coding->dst_object))
Kenichi Handa's avatar
Kenichi Handa committed
967 968 969 970 971 972 973 974 975
    {
      EMACS_INT add = coding->src_bytes - coding->consumed;

      GAP_SIZE -= add; ZV += add; Z += add; ZV_BYTE += add; Z_BYTE += add;
      make_gap (bytes);
      GAP_SIZE += add; ZV -= add; Z -= add; ZV_BYTE -= add; Z_BYTE -= add;
    }
  else
    {
976 977 978
      Lisp_Object this_buffer;

      this_buffer = Fcurrent_buffer ();
Kenichi Handa's avatar
Kenichi Handa committed
979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002
      set_buffer_internal (XBUFFER (coding->dst_object));
      make_gap (bytes);
      set_buffer_internal (XBUFFER (this_buffer));
    }
}
     

static unsigned char *
alloc_destination (coding, nbytes, dst)
     struct coding_system *coding;
     int nbytes;
     unsigned char *dst;
{
  EMACS_INT offset = dst - coding->destination;

  if (BUFFERP (coding->dst_object))
    coding_alloc_by_making_gap (coding, nbytes);
  else
    coding_alloc_by_realloc (coding, nbytes);
  coding->result = CODING_RESULT_SUCCESS;
  coding_set_destination (coding);
  dst = coding->destination + offset;
  return dst;
}
1003

1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051
/** Macros for annotations.  */

/* Maximum length of annotation data (sum of annotations for
   composition and charset).  */
#define MAX_ANNOTATION_LENGTH (5 + (MAX_COMPOSITION_COMPONENTS * 2) - 1 + 5)

/* An annotation data is stored in the array coding->charbuf in this
   format:
     [ -LENGTH ANNOTATION_MASK FROM TO ... ]
   LENGTH is the number of elements in the annotation.
   ANNOTATION_MASK is one of CODING_ANNOTATE_XXX_MASK.
   FROM and TO specify the range of text annotated.  They are relative
   to coding->src_pos (on encoding) or coding->dst_pos (on decoding).

   The format of the following elements depend on ANNOTATION_MASK.

   In the case of CODING_ANNOTATE_COMPOSITION_MASK, these elements
   follows:
     ... METHOD [ COMPOSITION-COMPONENTS ... ]
   METHOD is one of enum composition_method.
   Optionnal COMPOSITION-COMPONENTS are characters and composition
   rules.

   In the case of CODING_ANNOTATE_CHARSET_MASK, one element CHARSET-ID
   follows.  */

#define ADD_ANNOTATION_DATA(buf, len, mask, from, to)	\
  do {							\
    *(buf)++ = -(len);					\
    *(buf)++ = (mask);					\
    *(buf)++ = (from);					\
    *(buf)++ = (to);					\
    coding->annotated = 1;				\
  } while (0);

#define ADD_COMPOSITION_DATA(buf, from, to, method)			      \
  do {									      \
    ADD_ANNOTATION_DATA (buf, 5, CODING_ANNOTATE_COMPOSITION_MASK, from, to); \
    *buf++ = method;							      \
  } while (0)


#define ADD_CHARSET_DATA(buf, from, to, id)				  \
  do {									  \
    ADD_ANNOTATION_DATA (buf, 5, CODING_ANNOTATE_CHARSET_MASK, from, to); \
    *buf++ = id;							  \
  } while (0)

Kenichi Handa's avatar
Kenichi Handa committed
1052 1053 1054 1055 1056 1057 1058 1059 1060

/*** 2. Emacs' internal format (emacs-utf-8) ***/




/*** 3. UTF-8 ***/

/* See the above "GENERAL NOTES on `detect_coding_XXX ()' functions".
1061 1062
   Check if a text is encoded in UTF-8.  If it is, return 1, else
   return 0.  */
Kenichi Handa's avatar
Kenichi Handa committed
1063 1064 1065 1066 1067 1068 1069 1070 1071

#define UTF_8_1_OCTET_P(c)         ((c) < 0x80)
#define UTF_8_EXTRA_OCTET_P(c)     (((c) & 0xC0) == 0x80)
#define UTF_8_2_OCTET_LEADING_P(c) (((c) & 0xE0) == 0xC0)
#define UTF_8_3_OCTET_LEADING_P(c) (((c) & 0xF0) == 0xE0)
#define UTF_8_4_OCTET_LEADING_P(c) (((c) & 0xF8) == 0xF0)
#define UTF_8_5_OCTET_LEADING_P(c) (((c) & 0xFC) == 0xF8)

static int
1072
detect_coding_utf_8 (coding, detect_info)
Kenichi Handa's avatar
Kenichi Handa committed
1073
     struct coding_system *coding;
1074
     struct coding_detection_info *detect_info;
Kenichi Handa's avatar
Kenichi Handa committed
1075 1076 1077 1078 1079 1080
{
  unsigned char *src = coding->source, *src_base = src;
  unsigned char *src_end = coding->source + coding->src_bytes;
  int multibytep = coding->src_multibyte;
  int consumed_chars = 0;
  int found = 0;
1081
  int incomplete;
Kenichi Handa's avatar
Kenichi Handa committed
1082

1083
  detect_info->checked |= CATEGORY_MASK_UTF_8;
Kenichi Handa's avatar
Kenichi Handa committed
1084 1085 1086 1087 1088 1089 1090
  /* A coding system of this category is always ASCII compatible.  */
  src += coding->head_ascii;

  while (1)
    {
      int c, c1, c2, c3, c4;

1091
      incomplete = 0;
Kenichi Handa's avatar
Kenichi Handa committed
1092 1093 1094
      ONE_MORE_BYTE (c);
      if (UTF_8_1_OCTET_P (c))
	continue;
1095
      incomplete = 1;
Kenichi Handa's avatar
Kenichi Handa committed
1096 1097 1098 1099 1100
      ONE_MORE_BYTE (c1);
      if (! UTF_8_EXTRA_OCTET_P (c1))
	break;
      if (UTF_8_2_OCTET_LEADING_P (c))
	{
1101
	  found = CATEGORY_MASK_UTF_8;
Kenichi Handa's avatar
Kenichi Handa committed
1102 1103 1104 1105 1106 1107 1108
	  continue;
	}
      ONE_MORE_BYTE (c2);
      if (! UTF_8_EXTRA_OCTET_P (c2))
	break;
      if (UTF_8_3_OCTET_LEADING_P (c))
	{
1109
	  found = CATEGORY_MASK_UTF_8;
Kenichi Handa's avatar
Kenichi Handa committed
1110 1111 1112 1113 1114 1115
	  continue;
	}
      ONE_MORE_BYTE (c3);
      if (! UTF_8_EXTRA_OCTET_P (c3))
	break;
      if (UTF_8_4_OCTET_LEADING_P (c))
1116
	{
1117
	  found = CATEGORY_MASK_UTF_8;
Kenichi Handa's avatar
Kenichi Handa committed
1118 1119 1120 1121 1122 1123 1124
	  continue;
	}
      ONE_MORE_BYTE (c4);
      if (! UTF_8_EXTRA_OCTET_P (c4))
	break;
      if (UTF_8_5_OCTET_LEADING_P (c))
	{
1125
	  found = CATEGORY_MASK_UTF_8;
Kenichi Handa's avatar
Kenichi Handa committed
1126 1127 1128 1129
	  continue;
	}
      break;
    }
1130
  detect_info->rejected |= CATEGORY_MASK_UTF_8;
Kenichi Handa's avatar
Kenichi Handa committed
1131 1132 1133
  return 0;

 no_more_source:
1134 1135
  if (incomplete && coding->mode & CODING_MODE_LAST_BLOCK)
    {
1136
      detect_info->rejected |= CATEGORY_MASK_UTF_8;
1137 1138
      return 0;
    }
1139 1140
  detect_info->found |= found;
  return 1;
Kenichi Handa's avatar
Kenichi Handa committed
1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173
}


static void
decode_coding_utf_8 (coding)
     struct coding_system *coding;
{
  unsigned char *src = coding->source + coding->consumed;
  unsigned char *src_end = coding->source + coding->src_bytes;
  unsigned char *src_base;
  int *charbuf = coding->charbuf;
  int *charbuf_end = charbuf + coding->charbuf_size;
  int consumed_chars = 0, consumed_chars_base;
  int multibytep = coding->src_multibyte;
  Lisp_Object attr, eol_type, charset_list;

  CODING_GET_INFO (coding, attr, eol_type, charset_list);

  while (1)
    {
      int c, c1, c2, c3, c4, c5;

      src_base = src;
      consumed_chars_base = consumed_chars;

      if (charbuf >= charbuf_end)
	break;

      ONE_MORE_BYTE (c1);
      if (UTF_8_1_OCTET_P(c1))
	{
	  c = c1;
	  if (c == '\r')
1174
	    {
Kenichi Handa's avatar
Kenichi Handa committed
1175 1176 1177
	      if (EQ (eol_type, Qdos))
		{
		  if (src == src_end)
1178 1179 1180 1181
		    {
		      coding->result = CODING_RESULT_INSUFFICIENT_SRC;
		      goto no_more_source;
		    }
Kenichi Handa's avatar
Kenichi Handa committed
1182 1183 1184 1185 1186
		  if (*src == '\n')
		    ONE_MORE_BYTE (c);
		}
	      else if (EQ (eol_type, Qmac))
		c = '\n';
1187 1188
	    }
	}
Kenichi Handa's avatar
Kenichi Handa committed
1189
      else
1190
	{
Kenichi Handa's avatar
Kenichi Handa committed
1191 1192 1193 1194
	  ONE_MORE_BYTE (c2);
	  if (! UTF_8_EXTRA_OCTET_P (c2))
	    goto invalid_code;
	  if (UTF_8_2_OCTET_LEADING_P (c1))
1195 1196 1197 1198 1199 1200 1201 1202
	    {
	      c = ((c1 & 0x1F) << 6) | (c2 & 0x3F);
	      /* Reject overlong sequences here and below.  Encoders
		 producing them are incorrect, they can be misleading,
		 and they mess up read/write invariance.  */
	      if (c < 128)
		goto invalid_code;
	    }
Kenichi Handa's avatar
Kenichi Handa committed
1203
	  else
1204
	    {
Kenichi Handa's avatar
Kenichi Handa committed
1205 1206 1207 1208
	      ONE_MORE_BYTE (c3);
	      if (! UTF_8_EXTRA_OCTET_P (c3))
		goto invalid_code;
	      if (UTF_8_3_OCTET_LEADING_P (c1))
1209 1210 1211
		{
		  c = (((c1 & 0xF) << 12)
		       | ((c2 & 0x3F) << 6) | (c3 & 0x3F));
1212 1213
		  if (c < 0x800
		      || (c >= 0xd800 && c < 0xe000)) /* surrogates (invalid) */
1214 1215
		    goto invalid_code;
		}
Kenichi Handa's avatar
Kenichi Handa committed
1216 1217 1218 1219 1220 1221
	      else
		{
		  ONE_MORE_BYTE (c4);
		  if (! UTF_8_EXTRA_OCTET_P (c4))
		    goto invalid_code;
		  if (UTF_8_4_OCTET_LEADING_P (c1))
1222
		    {
Kenichi Handa's avatar
Kenichi Handa committed
1223 1224
		    c = (((c1 & 0x7) << 18) | ((c2 & 0x3F) << 12)
			 | ((c3 & 0x3F) << 6) | (c4 & 0x3F));
1225 1226 1227
		    if (c < 0x10000)
		      goto invalid_code;
		    }
Kenichi Handa's avatar
Kenichi Handa committed
1228 1229 1230 1231 1232 1233 1234 1235 1236 1237
		  else
		    {
		      ONE_MORE_BYTE (c5);
		      if (! UTF_8_EXTRA_OCTET_P (c5))
			goto invalid_code;
		      if (UTF_8_5_OCTET_LEADING_P (c1))
			{
			  c = (((c1 & 0x3) << 24) | ((c2 & 0x3F) << 18)
			       | ((c3 & 0x3F) << 12) | ((c4 & 0x3F) << 6)
			       | (c5 & 0x3F));
1238
			  if ((c > MAX_CHAR) || (c < 0x200000))
Kenichi Handa's avatar
Kenichi Handa committed
1239 1240 1241 1242 1243 1244
			    goto invalid_code;
			}
		      else
			goto invalid_code;
		    }
		}
1245 1246
	    }
	}
Kenichi Handa's avatar
Kenichi Handa committed
1247 1248 1249 1250 1251 1252 1253 1254 1255 1256

      *charbuf++ = c;
      continue;

    invalid_code:
      src = src_base;
      consumed_chars = consumed_chars_base;
      ONE_MORE_BYTE (c);
      *charbuf++ = ASCII_BYTE_P (c) ? c : BYTE8_TO_CHAR (c);
      coding->errors++;
1257 1258
    }

Kenichi Handa's avatar
Kenichi Handa committed
1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274
 no_more_source:
  coding->consumed_char += consumed_chars_base;
  coding->consumed = src_base - coding->source;
  coding->charbuf_used = charbuf - coding->charbuf;
}


static int
encode_coding_utf_8 (coding)
     struct coding_system *coding;
{
  int multibytep = coding->dst_multibyte;
  int *charbuf = coding->charbuf;
  int *charbuf_end = charbuf + coding->charbuf_used;
  unsigned char *dst = coding->destination + coding->produced;
  unsigned char *dst_end = coding->destination + coding->dst_bytes;
1275
  int produced_chars = 0;
Kenichi Handa's avatar
Kenichi Handa committed
1276 1277 1278
  int c;

  if (multibytep)
1279
    {
Kenichi Handa's avatar
Kenichi Handa committed
1280 1281 1282
      int safe_room = MAX_MULTIBYTE_LENGTH * 2;

      while (charbuf < charbuf_end)
1283
	{
Kenichi Handa's avatar
Kenichi Handa committed
1284 1285 1286 1287
	  unsigned char str[MAX_MULTIBYTE_LENGTH], *p, *pend = str;
	  
	  ASSURE_DESTINATION (safe_room);
	  c = *charbuf++;
1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298
	  if (CHAR_BYTE8_P (c))
	    {
	      c = CHAR_TO_BYTE8 (c);
	      EMIT_ONE_BYTE (c);
	    }
	  else
	    {
	      CHAR_STRING_ADVANCE (c, pend);
	      for (p = str; p < pend; p++)
		EMIT_ONE_BYTE (*p);
	    }
1299 1300
	}
    }
Kenichi Handa's avatar
Kenichi Handa committed
1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316
  else
    {
      int safe_room = MAX_MULTIBYTE_LENGTH;

      while (charbuf < charbuf_end)
	{
	  ASSURE_DESTINATION (safe_room);
	  c = *charbuf++;
	  dst += CHAR_STRING (c, dst);
	  produced_chars++;
	}
    }
  coding->result = CODING_RESULT_SUCCESS;
  coding->produced_char += produced_chars;
  coding->produced = dst - coding->destination;
  return 0;
1317 1318
}

Karl Heuer's avatar
Karl Heuer committed
1319

Kenichi Handa's avatar
Kenichi Handa committed
1320
/* See the above "GENERAL NOTES on `detect_coding_XXX ()' functions".
1321 1322
   Check if a text is encoded in one of UTF-16 based coding systems.
   If it is, return 1, else return 0.  */
Kenichi Handa's avatar
Kenichi Handa committed
1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336

#define UTF_16_HIGH_SURROGATE_P(val) \
  (((val) & 0xFC00) == 0xD800)

#define UTF_16_LOW_SURROGATE_P(val) \
  (((val) & 0xFC00) == 0xDC00)

#define UTF_16_INVALID_P(val)	\
  (((val) == 0xFFFE)		\
   || ((val) == 0xFFFF)		\
   || UTF_16_LOW_SURROGATE_P (val))


static int
1337
detect_coding_utf_16 (coding, detect_info)
1338
     struct coding_system *coding;
1339
     struct coding_detection_info *detect_info;
1340
{
Kenichi Handa's avatar
Kenichi Handa committed
1341 1342 1343 1344 1345 1346
  unsigned char *src = coding->source, *src_base = src;
  unsigned char *src_end = coding->source + coding->src_bytes;
  int multibytep = coding->src_multibyte;
  int consumed_chars = 0;
  int c1, c2;

1347
  detect_info->checked |= CATEGORY_MASK_UTF_16;
1348

1349 1350 1351 1352 1353 1354
  if (coding->mode & CODING_MODE_LAST_BLOCK
      && (coding->src_bytes & 1))
    {
      detect_info->rejected |= CATEGORY_MASK_UTF_16;
      return 0;
    }
Kenichi Handa's avatar
Kenichi Handa committed
1355 1356
  ONE_MORE_BYTE (c1);
  ONE_MORE_BYTE (c2);
Karl Heuer's avatar
Karl Heuer committed
1357

Kenichi Handa's avatar
Kenichi Handa committed
1358
  if ((c1 == 0xFF) && (c2 == 0xFE))
1359 1360 1361 1362
    {
      detect_info->found |= CATEGORY_MASK_UTF_16_LE;
      detect_info->rejected |= CATEGORY_MASK_UTF_16_BE;
    }
Kenichi Handa's avatar
Kenichi Handa committed
1363
  else if ((c1 == 0xFE) && (c2 == 0xFF))
1364 1365 1366 1367
    {
      detect_info->found |= CATEGORY_MASK_UTF_16_BE;
      detect_info->rejected |= CATEGORY_MASK_UTF_16_LE;
    }
Kenichi Handa's avatar
Kenichi Handa committed
1368
 no_more_source:
1369
  return 1;
Kenichi Handa's avatar
Kenichi Handa committed
1370
}
Kenichi Handa's avatar
Kenichi Handa committed
1371

Kenichi Handa's avatar
Kenichi Handa committed
1372 1373 1374 1375 1376 1377
static void
decode_coding_utf_16 (coding)
     struct coding_system *coding;
{
  unsigned char *src = coding->source + coding->consumed;
  unsigned char *src_end = coding->source + coding->src_bytes;
1378
  unsigned char *src_base;
Kenichi Handa's avatar
Kenichi Handa committed
1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392
  int *charbuf = coding->charbuf;
  int *charbuf_end = charbuf + coding->charbuf_size;
  int consumed_chars = 0, consumed_chars_base;
  int multibytep = coding->src_multibyte;
  enum utf_16_bom_type bom = CODING_UTF_16_BOM (coding);
  enum utf_16_endian_type endian = CODING_UTF_16_ENDIAN (coding);
  int surrogate = CODING_UTF_16_SURROGATE (coding);
  Lisp_Object attr, eol_type, charset_list;

  CODING_GET_INFO (coding, attr, eol_type, charset_list);

  if (bom != utf_16_without_bom)
    {
      int c, c1, c2;
1393

Kenichi Handa's avatar
Kenichi Handa committed
1394 1395 1396
      src_base = src;
      ONE_MORE_BYTE (c1);
      ONE_MORE_BYTE (c2);
1397
      c = (c1 << 8) | c2;
Kenichi Handa's avatar
Kenichi Handa committed
1398 1399 1400
      if (bom == utf_16_with_bom)
	{
	  if (endian == utf_16_big_endian
1401
	      ? c != 0xFEFF : c != 0xFFFE)
1402
	    {
Kenichi Handa's avatar
Kenichi Handa committed
1403 1404 1405 1406
	      /* We are sure that there's enouph room at CHARBUF.  */
	      *charbuf++ = c1;
	      *charbuf++ = c2;
	      coding->errors++;
1407 1408
	    }
	}
Kenichi Handa's avatar
Kenichi Handa committed
1409
      else