coding.c 282 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.
Kenichi Handa's avatar
Kenichi Handa committed
3
     Licensed to the Free Software Foundation.
4
   Copyright (C) 2001, 2002 Free Software Foundation, Inc.
Kenichi Handa's avatar
Kenichi Handa committed
5
   Copyright (C) 2003
Kenichi Handa's avatar
Kenichi Handa committed
6 7
     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
You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
Lute Kamstra's avatar
Lute Kamstra committed
23 24
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, 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
  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
Kenichi Handa's avatar
Kenichi Handa committed
56
  coding system.
Karl Heuer's avatar
Karl Heuer committed
57

58 59
  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
  coding system symbol to attributes vector is done by looking up
  Vcharset_hash_table by the symbol.
Karl Heuer's avatar
Karl Heuer committed
63

64
  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.
Karl Heuer's avatar
Karl Heuer committed
66

Kenichi Handa's avatar
Kenichi Handa committed
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
Karl Heuer's avatar
Karl Heuer committed
82 83

  The most famous coding system for multiple character sets.  X's
Kenichi Handa's avatar
Kenichi Handa committed
84 85 86
  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.
Karl Heuer's avatar
Karl Heuer committed
87

Kenichi Handa's avatar
Kenichi Handa committed
88
  o SJIS (or Shift-JIS or MS-Kanji-Code)
89

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).
Karl Heuer's avatar
Karl Heuer committed
138 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
{
160 161
  const unsigned char *src = coding->source;
  const unsigned char *src_end = coding->source + coding->src_bytes;
Kenichi Handa's avatar
Kenichi Handa committed
162
  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;
{
208 209
  const unsigned char *src = coding->source + coding->consumed;
  const unsigned char *src_end = coding->source + coding->src_bytes;
Kenichi Handa's avatar
Kenichi Handa committed
210 211 212
  /* 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.  */
213
  const unsigned char *src_base;
Kenichi Handa's avatar
Kenichi Handa committed
214
  /* A buffer to produce decoded characters.  */
215 216
  int *charbuf = coding->charbuf + coding->charbuf_used;
  int *charbuf_end = coding->charbuf + coding->charbuf_size;
Kenichi Handa's avatar
Kenichi Handa committed
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
  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
Lisp_Object Qcharset, Qiso_2022, Qutf_8, Qutf_16, Qshift_jis, Qbig5;
311
Lisp_Object Qbig, Qlittle;
312
Lisp_Object Qcoding_system_history;
Kenichi Handa's avatar
Kenichi Handa committed
313
Lisp_Object Qvalid_codes;
Kenichi Handa's avatar
Kenichi Handa committed
314 315 316
Lisp_Object QCcategory, QCmnemonic, QCdefalut_char;
Lisp_Object QCdecode_translation_table, QCencode_translation_table;
Lisp_Object QCpost_read_conversion, QCpre_write_conversion;
Karl Heuer's avatar
Karl Heuer committed
317 318

extern Lisp_Object Qinsert_file_contents, Qwrite_region;
Kim F. Storm's avatar
Kim F. Storm committed
319
Lisp_Object Qcall_process, Qcall_process_region;
Karl Heuer's avatar
Karl Heuer committed
320 321 322
Lisp_Object Qstart_process, Qopen_network_stream;
Lisp_Object Qtarget_idx;

323 324 325
Lisp_Object Qinsufficient_source, Qinconsistent_eol, Qinvalid_source;
Lisp_Object Qinterrupted, Qinsufficient_memory;

326 327
int coding_system_require_warning;

328 329
Lisp_Object Vselect_safe_coding_system_function;

330 331 332
/* 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
333
   decided.  */
334
Lisp_Object eol_mnemonic_undecided;
Karl Heuer's avatar
Karl Heuer committed
335 336 337

#ifdef emacs

338 339 340
Lisp_Object Vcoding_system_list, Vcoding_system_alist;

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

342 343 344
/* Coding system emacs-mule and raw-text are for converting only
   end-of-line format.  */
Lisp_Object Qemacs_mule, Qraw_text;
Kenichi Handa's avatar
Kenichi Handa committed
345
Lisp_Object Qutf_8_emacs;
Dave Love's avatar
Dave Love committed
346

Karl Heuer's avatar
Karl Heuer committed
347 348 349 350 351 352 353 354
/* 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;
355 356
/* Set to non-nil when an error is detected while code conversion.  */
Lisp_Object Vlast_code_conversion_error;
357
/* A vector of length 256 which contains information about special
Karl Heuer's avatar
Karl Heuer committed
358
   Latin codes (especially for dealing with Microsoft codes).  */
359
Lisp_Object Vlatin_extra_code_table;
360

361 362 363
/* Flag to inhibit code conversion of end-of-line format.  */
int inhibit_eol_conversion;

364 365 366
/* Flag to inhibit ISO2022 escape sequence detection.  */
int inhibit_iso_escape_detection;

367 368 369
/* Flag to make buffer-file-coding-system inherit from process-coding.  */
int inherit_process_coding_system;

370
/* Coding system to be used to encode text for terminal display.  */
Karl Heuer's avatar
Karl Heuer committed
371 372
struct coding_system terminal_coding;

373 374 375 376 377
/* 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
378 379
struct coding_system keyboard_coding;

380 381 382
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
383

384 385
Lisp_Object Vlocale_coding_system;

Karl Heuer's avatar
Karl Heuer committed
386 387
#endif /* emacs */

388 389
/* Flag to tell if we look up translation table on character code
   conversion.  */
390
Lisp_Object Venable_character_translation;
391 392 393 394
/* 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;
395

396 397 398 399
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
400 401

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

404 405 406
/* Default coding systems used for process I/O.  */
Lisp_Object Vdefault_process_coding_system;

407 408 409
/* Char table for translating Quail and self-inserting input.  */
Lisp_Object Vtranslation_table_for_input;

Kenichi Handa's avatar
Kenichi Handa committed
410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 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
/* Two special coding systems.  */
Lisp_Object Vsjis_coding_system;
Lisp_Object Vbig5_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_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.  */
  };
475

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

Kenichi Handa's avatar
Kenichi Handa committed
479 480 481
/* 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
482

Kenichi Handa's avatar
Kenichi Handa committed
483 484 485
/* If set, reset graphic planes and registers at end-of-line to the
   initial state.  */
#define CODING_ISO_FLAG_RESET_AT_EOL	0x0002
486

Kenichi Handa's avatar
Kenichi Handa committed
487 488 489
/* If set, reset graphic planes and registers before any control
   characters to the initial state.  */
#define CODING_ISO_FLAG_RESET_AT_CNTL	0x0004
490

Kenichi Handa's avatar
Kenichi Handa committed
491 492
/* If set, encode by 7-bit environment.  */
#define CODING_ISO_FLAG_SEVEN_BITS	0x0008
Karl Heuer's avatar
Karl Heuer committed
493

Kenichi Handa's avatar
Kenichi Handa committed
494 495
/* If set, use locking-shift function.  */
#define CODING_ISO_FLAG_LOCKING_SHIFT	0x0010
496

Kenichi Handa's avatar
Kenichi Handa committed
497 498 499
/* If set, use single-shift function.  Overwrite
   CODING_ISO_FLAG_LOCKING_SHIFT.  */
#define CODING_ISO_FLAG_SINGLE_SHIFT	0x0020
500

Kenichi Handa's avatar
Kenichi Handa committed
501 502
/* If set, use designation escape sequence.  */
#define CODING_ISO_FLAG_DESIGNATION	0x0040
503

Kenichi Handa's avatar
Kenichi Handa committed
504 505
/* If set, produce revision number sequence.  */
#define CODING_ISO_FLAG_REVISION	0x0080
506

Kenichi Handa's avatar
Kenichi Handa committed
507 508
/* If set, produce ISO6429's direction specifying sequence.  */
#define CODING_ISO_FLAG_DIRECTION	0x0100
Richard M. Stallman's avatar
Richard M. Stallman committed
509

Kenichi Handa's avatar
Kenichi Handa committed
510 511 512
/* If set, assume designation states are reset at beginning of line on
   output.  */
#define CODING_ISO_FLAG_INIT_AT_BOL	0x0200
Karl Heuer's avatar
Karl Heuer committed
513

Kenichi Handa's avatar
Kenichi Handa committed
514 515 516
/* If set, designation sequence should be placed at beginning of line
   on output.  */
#define CODING_ISO_FLAG_DESIGNATE_AT_BOL 0x0400
517

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

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

Kenichi Handa's avatar
Kenichi Handa committed
525
#define CODING_ISO_FLAG_COMPOSITION	0x2000
526

Kenichi Handa's avatar
Kenichi Handa committed
527
#define CODING_ISO_FLAG_EUC_TW_SHIFT	0x4000
528

529
#define CODING_ISO_FLAG_USE_ROMAN	0x8000
530

531
#define CODING_ISO_FLAG_USE_OLDJIS	0x10000
532

533
#define CODING_ISO_FLAG_FULL_SUPPORT	0x100000
534

Kenichi Handa's avatar
Kenichi Handa committed
535 536 537
/* 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  '?'
538

Karl Heuer's avatar
Karl Heuer committed
539

Kenichi Handa's avatar
Kenichi Handa committed
540 541 542
/* UTF-16 section */
#define CODING_UTF_16_BOM(coding)	\
  ((coding)->spec.utf_16.bom)
Karl Heuer's avatar
Karl Heuer committed
543

Kenichi Handa's avatar
Kenichi Handa committed
544 545
#define CODING_UTF_16_ENDIAN(coding)	\
  ((coding)->spec.utf_16.endian)
Karl Heuer's avatar
Karl Heuer committed
546

Kenichi Handa's avatar
Kenichi Handa committed
547 548
#define CODING_UTF_16_SURROGATE(coding)	\
  ((coding)->spec.utf_16.surrogate)
Karl Heuer's avatar
Karl Heuer committed
549 550


Kenichi Handa's avatar
Kenichi Handa committed
551 552 553 554 555 556
/* 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)					   \
Kenichi Handa's avatar
Kenichi Handa committed
557
  (SDATA (AREF (CODING_ID_ATTRS ((coding)->id), coding_attr_ccl_valids)))
Karl Heuer's avatar
Karl Heuer committed
558

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

Kenichi Handa's avatar
Kenichi Handa committed
561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593
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)
594
#define CATEGORY_MASK_UTF_16_AUTO	(1 << coding_category_utf_16_auto)
Kenichi Handa's avatar
Kenichi Handa committed
595 596 597 598 599 600 601 602 603
#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)
604
#define CATEGORY_MASK_RAW_TEXT		(1 << coding_category_raw_text)
Kenichi Handa's avatar
Kenichi Handa committed
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 638 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

/* 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];

/*** 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
677

678 679 680 681
#define CODING_GET_INFO(coding, attrs, charset_list)	\
  do {							\
    (attrs) = CODING_ID_ATTRS ((coding)->id);		\
    (charset_list) = CODING_ATTR_CHARSET_LIST (attrs);	\
Kenichi Handa's avatar
Kenichi Handa committed
682
  } while (0)
Karl Heuer's avatar
Karl Heuer committed
683 684


Kenichi Handa's avatar
Kenichi Handa committed
685 686
/* 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
687 688 689 690 691
   in the source, it jumps to `no_more_source'.  If multibytep is
   nonzero, and a multibyte character is found at SRC, set C to the
   negative value of the character code.  The caller should declare
   and set these variables appropriately in advance:
	src, src_end, multibytep */
692

693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714
#define ONE_MORE_BYTE(c)				\
  do {							\
    if (src == src_end)					\
      {							\
	if (src_base < src)				\
	  record_conversion_result			\
	    (coding, CODING_RESULT_INSUFFICIENT_SRC);	\
	goto no_more_source;				\
      }							\
    c = *src++;						\
    if (multibytep && (c & 0x80))			\
      {							\
	if ((c & 0xFE) == 0xC0)				\
	  c = ((c & 1) << 6) | *src++;			\
	else						\
	  {						\
	    c = - string_char (--src, &src, NULL);	\
	    record_conversion_result			\
	      (coding, CODING_RESULT_INVALID_SRC);	\
	  }						\
      }							\
    consumed_chars++;					\
715 716 717
  } while (0)


718 719 720 721 722 723 724 725 726 727 728 729 730 731 732
#define ONE_MORE_BYTE_NO_CHECK(c)			\
  do {							\
    c = *src++;						\
    if (multibytep && (c & 0x80))			\
      {							\
	if ((c & 0xFE) == 0xC0)				\
	  c = ((c & 1) << 6) | *src++;			\
	else						\
	  {						\
	    c = - string_char (--src, &src, NULL);	\
	    record_conversion_result			\
	      (coding, CODING_RESULT_INVALID_SRC);	\
	  }						\
      }							\
    consumed_chars++;					\
733 734 735
  } while (0)


Kenichi Handa's avatar
Kenichi Handa committed
736 737 738 739 740
/* 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.
*/
741 742


Kenichi Handa's avatar
Kenichi Handa committed
743 744 745 746
#define EMIT_ONE_ASCII_BYTE(c)	\
  do {				\
    produced_chars++;		\
    *dst++ = (c);		\
747
  } while (0)
748 749


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

Kenichi Handa's avatar
Kenichi Handa committed
752 753 754 755 756
#define EMIT_TWO_ASCII_BYTES(c1, c2)	\
  do {					\
    produced_chars += 2;		\
    *dst++ = (c1), *dst++ = (c2);	\
  } while (0)
757 758


Kenichi Handa's avatar
Kenichi Handa committed
759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776
/* 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);			\
777 778 779
  } while (0)


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

782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802
#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);			\
      }					\
803 804 805
  } while (0)


Kenichi Handa's avatar
Kenichi Handa committed
806 807 808 809 810
#define EMIT_THREE_BYTES(c1, c2, c3)	\
  do {					\
    EMIT_ONE_BYTE (c1);			\
    EMIT_TWO_BYTES (c2, c3);		\
  } while (0)
811 812


Kenichi Handa's avatar
Kenichi Handa committed
813 814 815 816 817
#define EMIT_FOUR_BYTES(c1, c2, c3, c4)		\
  do {						\
    EMIT_TWO_BYTES (c1, c2);			\
    EMIT_TWO_BYTES (c3, c4);			\
  } while (0)
818 819


820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898
/* Prototypes for static functions.  */
static void record_conversion_result P_ ((struct coding_system *coding,
					  enum coding_result_code result));
static int detect_coding_utf_8 P_ ((struct coding_system *,
				    struct coding_detection_info *info));
static void decode_coding_utf_8 P_ ((struct coding_system *));
static int encode_coding_utf_8 P_ ((struct coding_system *));

static int detect_coding_utf_16 P_ ((struct coding_system *,
				     struct coding_detection_info *info));
static void decode_coding_utf_16 P_ ((struct coding_system *));
static int encode_coding_utf_16 P_ ((struct coding_system *));

static int detect_coding_iso_2022 P_ ((struct coding_system *,
				       struct coding_detection_info *info));
static void decode_coding_iso_2022 P_ ((struct coding_system *));
static int encode_coding_iso_2022 P_ ((struct coding_system *));

static int detect_coding_emacs_mule P_ ((struct coding_system *,
					 struct coding_detection_info *info));
static void decode_coding_emacs_mule P_ ((struct coding_system *));
static int encode_coding_emacs_mule P_ ((struct coding_system *));

static int detect_coding_sjis P_ ((struct coding_system *,
				   struct coding_detection_info *info));
static void decode_coding_sjis P_ ((struct coding_system *));
static int encode_coding_sjis P_ ((struct coding_system *));

static int detect_coding_big5 P_ ((struct coding_system *,
				   struct coding_detection_info *info));
static void decode_coding_big5 P_ ((struct coding_system *));
static int encode_coding_big5 P_ ((struct coding_system *));

static int detect_coding_ccl P_ ((struct coding_system *,
				  struct coding_detection_info *info));
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 *));

static void coding_set_source P_ ((struct coding_system *));
static void coding_set_destination P_ ((struct coding_system *));
static void coding_alloc_by_realloc P_ ((struct coding_system *, EMACS_INT));
static void coding_alloc_by_making_gap P_ ((struct coding_system *,
					    EMACS_INT));
static unsigned char *alloc_destination P_ ((struct coding_system *,
					     EMACS_INT, unsigned char *));
static void setup_iso_safe_charsets P_ ((Lisp_Object));
static unsigned char *encode_designation_at_bol P_ ((struct coding_system *,
						     int *, int *,
						     unsigned char *));
static int detect_eol P_ ((const unsigned char *,
			   EMACS_INT, enum coding_category));
static Lisp_Object adjust_coding_eol_type P_ ((struct coding_system *, int));
static void decode_eol P_ ((struct coding_system *));
static Lisp_Object get_translation_table P_ ((Lisp_Object, int, int *));
static Lisp_Object get_translation P_ ((Lisp_Object, int *, int *,
					int, int *, int *));
static int produce_chars P_ ((struct coding_system *, Lisp_Object, int));
static INLINE void produce_composition P_ ((struct coding_system *, int *,
					    EMACS_INT));
static INLINE void produce_charset P_ ((struct coding_system *, int *,
					EMACS_INT));
static void produce_annotation P_ ((struct coding_system *, EMACS_INT));
static int decode_coding P_ ((struct coding_system *));
static INLINE int *handle_composition_annotation P_ ((EMACS_INT, EMACS_INT,
						      struct coding_system *, 
						      int *, EMACS_INT *));
static INLINE int *handle_charset_annotation P_ ((EMACS_INT, EMACS_INT,
						  struct coding_system *,
						  int *, EMACS_INT *));
static void consume_chars P_ ((struct coding_system *, Lisp_Object, int));
static int encode_coding P_ ((struct coding_system *));
static Lisp_Object make_conversion_work_buffer P_ ((int));
static Lisp_Object code_conversion_restore P_ ((Lisp_Object));
static INLINE int char_encodable_p P_ ((int, Lisp_Object));
static Lisp_Object make_subsidiaries P_ ((Lisp_Object));

899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923
static void
record_conversion_result (struct coding_system *coding,
			  enum coding_result_code result)
{
  coding->result = result;
  switch (result)
    {
    case CODING_RESULT_INSUFFICIENT_SRC:
      Vlast_code_conversion_error = Qinsufficient_source;
      break;
    case CODING_RESULT_INCONSISTENT_EOL:
      Vlast_code_conversion_error = Qinconsistent_eol;
      break;
    case CODING_RESULT_INVALID_SRC:
      Vlast_code_conversion_error = Qinvalid_source;
      break;
    case CODING_RESULT_INTERRUPT:
      Vlast_code_conversion_error = Qinterrupted;
      break;
    case CODING_RESULT_INSUFFICIENT_MEM:
      Vlast_code_conversion_error = Qinsufficient_memory;
      break;
    }
}

Kenichi Handa's avatar
Kenichi Handa committed
924 925 926 927 928 929
#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)						     \
      {									     \
Kenichi Handa's avatar
Kenichi Handa committed
930
	const unsigned char *orig = coding->source;			     \
Kenichi Handa's avatar
Kenichi Handa committed
931 932 933 934 935 936 937 938
	EMACS_INT offset;						     \
									     \
	coding_set_source (coding);					     \
	offset = coding->source - orig;					     \
	src += offset;							     \
	src_base += offset;						     \
	src_end += offset;						     \
      }									     \
939 940 941
  } while (0)


Kenichi Handa's avatar
Kenichi Handa committed
942 943 944 945 946 947 948 949 950 951
#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)
952 953 954



Kenichi Handa's avatar
Kenichi Handa committed
955 956
static void
coding_set_source (coding)
957 958
     struct coding_system *coding;
{
Kenichi Handa's avatar
Kenichi Handa committed
959 960
  if (BUFFERP (coding->src_object))
    {
961
      struct buffer *buf = XBUFFER (coding->src_object);
962

Kenichi Handa's avatar
Kenichi Handa committed
963
      if (coding->src_pos < 0)
964
	coding->source = BUF_GAP_END_ADDR (buf) + coding->src_pos_byte;
Kenichi Handa's avatar
Kenichi Handa committed
965
      else
966
	coding->source = BUF_BYTE_ADDRESS (buf, coding->src_pos_byte);
967
    }
Kenichi Handa's avatar
Kenichi Handa committed
968
  else if (STRINGP (coding->src_object))
969
    {
Kenichi Handa's avatar
Kenichi Handa committed
970
      coding->source = SDATA (coding->src_object) + coding->src_pos_byte;
971
    }
Kenichi Handa's avatar
Kenichi Handa committed
972 973 974 975 976
  else
    /* Otherwise, the source is C string and is never relocated
       automatically.  Thus we don't have to update anything.  */
    ;
}
977

Kenichi Handa's avatar
Kenichi Handa committed
978 979 980 981 982
static void
coding_set_destination (coding)
     struct coding_system *coding;
{
  if (BUFFERP (coding->dst_object))
983
    {
Kenichi Handa's avatar
Kenichi Handa committed
984
      if (coding->src_pos < 0)
985
	{
986 987 988 989
	  coding->destination = BEG_ADDR + coding->dst_pos_byte - 1;
	  coding->dst_bytes = (GAP_END_ADDR
			       - (coding->src_bytes - coding->consumed)
			       - coding->destination);
990
	}
Kenichi Handa's avatar
Kenichi Handa committed
991
      else
992 993 994 995 996 997 998 999
	{
	  /* 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
1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022
    }
  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;
{
1023 1024
  if (BUFFERP (coding->dst_object)
      && EQ (coding->src_object, coding->dst_object))
Kenichi Handa's avatar
Kenichi Handa committed
1025 1026 1027 1028 1029 1030 1031 1032 1033
    {
      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
    {
1034 1035 1036
      Lisp_Object this_buffer;

      this_buffer = Fcurrent_buffer ();
Kenichi Handa's avatar
Kenichi Handa committed
1037 1038 1039
      set_buffer_internal (XBUFFER (coding->dst_object));
      make_gap (bytes);
      set_buffer_internal (XBUFFER (this_buffer));
1040
    }
Kenichi Handa's avatar
Kenichi Handa committed
1041
}
Kenichi Handa's avatar
Kenichi Handa committed
1042

Kenichi Handa's avatar
Kenichi Handa committed
1043 1044 1045 1046

static unsigned char *
alloc_destination (coding, nbytes, dst)
     struct coding_system *coding;
1047
     EMACS_INT nbytes;
Kenichi Handa's avatar
Kenichi Handa committed
1048 1049 1050 1051 1052 1053
     unsigned char *dst;
{
  EMACS_INT offset = dst - coding->destination;

  if (BUFFERP (coding->dst_object))
    coding_alloc_by_making_gap (coding, nbytes);
1054
  else
Kenichi Handa's avatar
Kenichi Handa committed
1055
    coding_alloc_by_realloc (coding, nbytes);
1056
  record_conversion_result (coding, CODING_RESULT_SUCCESS);
Kenichi Handa's avatar
Kenichi Handa committed
1057 1058 1059 1060
  coding_set_destination (coding);
  dst = coding->destination + offset;
  return dst;
}
1061

1062 1063 1064 1065
/** Macros for annotations.  */

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

/* An annotation data is stored in the array coding->charbuf in this
   format:
1070
     [ -LENGTH ANNOTATION_MASK NCHARS ... ]
1071 1072
   LENGTH is the number of elements in the annotation.
   ANNOTATION_MASK is one of CODING_ANNOTATE_XXX_MASK.
1073
   NCHARS is the number of characters in the text annotated.
1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086

   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.  */

1087
#define ADD_ANNOTATION_DATA(buf, len, mask, nchars)	\
1088 1089 1090
  do {							\
    *(buf)++ = -(len);					\
    *(buf)++ = (mask);					\
1091
    *(buf)++ = (nchars);				\
1092 1093 1094
    coding->annotated = 1;				\
  } while (0);

1095 1096 1097 1098
#define ADD_COMPOSITION_DATA(buf, nchars, method)			    \
  do {									    \
    ADD_ANNOTATION_DATA (buf, 4, CODING_ANNOTATE_COMPOSITION_MASK, nchars); \
    *buf++ = method;							    \
1099 1100 1101
  } while (0)


1102 1103 1104 1105
#define ADD_CHARSET_DATA(buf, nchars, id)				\
  do {									\
    ADD_ANNOTATION_DATA (buf, 4, CODING_ANNOTATE_CHARSET_MASK, nchars);	\
    *buf++ = id;							\
1106 1107
  } while (0)

Kenichi Handa's avatar
Kenichi Handa committed
1108 1109 1110 1111 1112 1113 1114 1115 1116

/*** 2. Emacs' internal format (emacs-utf-8) ***/



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

/* See the above "GENERAL NOTES on `detect_coding_XXX ()' functions".
1117 1118
   Check if a text is encoded in UTF-8.  If it is, return 1, else
   return 0.  */
Kenichi Handa's avatar
Kenichi Handa committed
1119 1120 1121 1122 1123 1124 1125 1126 1127

#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
1128
detect_coding_utf_8 (coding, detect_info)
Kenichi Handa's avatar
Kenichi Handa committed
1129
     struct coding_system *coding;
1130
     struct coding_detection_info *detect_info;
Kenichi Handa's avatar
Kenichi Handa committed
1131
{
1132
  const unsigned char *src = coding->source, *src_base;
Kenichi Handa's avatar
Kenichi Handa committed
1133
  const unsigned char *src_end = coding->source + coding->src_bytes;
Kenichi Handa's avatar
Kenichi Handa committed
1134 1135 1136 1137
  int multibytep = coding->src_multibyte;
  int consumed_chars = 0;
  int found = 0;

1138
  detect_info->checked |= CATEGORY_MASK_UTF_8;
Kenichi Handa's avatar
Kenichi Handa committed
1139 1140 1141 1142
  /* A coding system of this category is always ASCII compatible.  */
  src += coding->head_ascii;

  while (1)
1143
    {
Kenichi Handa's avatar
Kenichi Handa committed
1144
      int c, c1, c2, c3, c4;
1145

1146
      src_base = src;
Kenichi Handa's avatar
Kenichi Handa committed
1147
      ONE_MORE_BYTE (c);
1148
      if (c < 0 || UTF_8_1_OCTET_P (c))
Kenichi Handa's avatar
Kenichi Handa committed
1149 1150
	continue;
      ONE_MORE_BYTE (c1);
1151
      if (c1 < 0 || ! UTF_8_EXTRA_OCTET_P (c1))
Kenichi Handa's avatar
Kenichi Handa committed
1152 1153
	break;
      if (UTF_8_2_OCTET_LEADING_P (c))
1154
	{
1155
	  found = CATEGORY_MASK_UTF_8;
Kenichi Handa's avatar
Kenichi Handa committed
1156
	  continue;
1157
	}
Kenichi Handa's avatar
Kenichi Handa committed
1158
      ONE_MORE_BYTE (c2);
1159
      if (c2 < 0 || ! UTF_8_EXTRA_OCTET_P (c2))
Kenichi Handa's avatar
Kenichi Handa committed
1160 1161
	break;
      if (UTF_8_3_OCTET_LEADING_P (c))
1162
	{
1163
	  found = CATEGORY_MASK_UTF_8;
Kenichi Handa's avatar
Kenichi Handa committed
1164
	  continue;
1165
	}
Kenichi Handa's avatar
Kenichi Handa committed
1166
      ONE_MORE_BYTE (c3);
1167
      if (c3 < 0 || ! UTF_8_EXTRA_OCTET_P (c3))
Kenichi Handa's avatar
Kenichi Handa committed
1168 1169
	break;
      if (UTF_8_4_OCTET_LEADING_P (c))
1170
	{
1171
	  found = CATEGORY_MASK_UTF_8;
Kenichi Handa's avatar
Kenichi Handa committed
1172 1173 1174
	  continue;
	}
      ONE_MORE_BYTE (c4);
1175
      if (c4 < 0 || ! UTF_8_EXTRA_OCTET_P (c4))
Kenichi Handa's avatar
Kenichi Handa committed
1176 1177 1178
	break;
      if (UTF_8_5_OCTET_LEADING_P (c))
	{
1179
	  found = CATEGORY_MASK_UTF_8;
Kenichi Handa's avatar
Kenichi Handa committed
1180 1181 1182
	  continue;
	}
      break;
1183
    }
1184
  detect_info->rejected |= CATEGORY_MASK_UTF_8;
Kenichi Handa's avatar
Kenichi Handa committed
1185
  return 0;
1186

Kenichi Handa's avatar
Kenichi Handa committed
1187
 no_more_source:
1188
  if (src_base < src && coding->mode & CODING_MODE_LAST_BLOCK)
1189
    {
1190
      detect_info->rejected |= CATEGORY_MASK_UTF_8;
1191
      return 0;
1192
    }
1193 1194
  detect_info->found |= found;
  return 1;
1195 1196
}

Karl Heuer's avatar
Karl Heuer committed
1197

1198
static void
Kenichi Handa's avatar
Kenichi Handa committed
1199
decode_coding_utf_8 (coding)
1200 1201
     struct coding_system *coding;
{
Kenichi Handa's avatar
Kenichi Handa committed
1202 1203 1204
  const unsigned char *src = coding->source + coding->consumed;
  const unsigned char *src_end = coding->source + coding->src_bytes;
  const unsigned char *src_base;
1205 1206
  int *charbuf = coding->charbuf + coding->charbuf_used;
  int *charbuf_end = coding->charbuf + coding->charbuf_size;
Kenichi Handa's avatar
Kenichi Handa committed
1207 1208
  int consumed_chars = 0, consumed_chars_base;
  int multibytep = coding->src_multibyte;
1209
  Lisp_Object attr, charset_list;
Karl Heuer's avatar
Karl Heuer committed
1210

1211
  CODING_GET_INFO (coding, attr, charset_list);
Kenichi Handa's avatar
Kenichi Handa committed
1212 1213

  while (1)
1214
    {
Kenichi Handa's avatar
Kenichi Handa committed
1215
      int c, c1, c2, c3, c4, c5;
Kenichi Handa's avatar
Kenichi Handa committed
1216

Kenichi Handa's avatar
Kenichi Handa committed
1217 1218
      src_base = src;
      consumed_chars_base = consumed_chars;
1219

Kenichi Handa's avatar
Kenichi Handa committed
1220 1221 1222 1223
      if (charbuf >= charbuf_end)
	break;

      ONE_MORE_BYTE (c1);
1224 1225 1226 1227 1228
      if (c1 < 0)
	{
	  c = - c1;
	}
      else if (UTF_8_1_OCTET_P(c1))
Kenichi Handa's avatar
Kenichi Handa committed
1229 1230
	{
	  c = c1;
1231
	}
Kenichi Handa's avatar
Kenichi Handa committed
1232
      else
1233
	{
Kenichi Handa's avatar
Kenichi Handa committed
1234
	  ONE_MORE_BYTE (c2);
1235
	  if (c2 < 0 || ! UTF_8_EXTRA_OCTET_P (c2))
Kenichi Handa's avatar
Kenichi Handa committed
1236 1237
	    goto invalid_code;
	  if (UTF_8_2_OCTET_LEADING_P (c1))
1238
	    {
1239 1240 1241 1242 1243 1244
	      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;
1245
	    }
Kenichi Handa's avatar
Kenichi Handa committed
1246
	  else
1247
	    {
Kenichi Handa's avatar
Kenichi Handa committed
1248
	      ONE_MORE_BYTE (c3);
1249
	      if (c3 < 0 || ! UTF_8_EXTRA_OCTET_P (c3))
Kenichi Handa's avatar
Kenichi Handa committed
1250 1251
		goto invalid_code;
	      if (UTF_8_3_OCTET_LEADING_P (c1))
1252 1253 1254
		{
		  c = (((c1 & 0xF) << 12)
		       | ((c2 & 0x3F) << 6) | (c3 & 0x3F));
1255 1256
		  if (c < 0x800
		      || (c >= 0xd800 && c < 0xe000)) /* surrogates (invalid) */
1257 1258
		    goto invalid_code;
		}
Kenichi Handa's avatar
Kenichi Handa committed
1259 1260 1261
	      else
		{
		  ONE_MORE_BYTE (c4);
1262
		  if (c4 < 0 || ! UTF_8_EXTRA_OCTET_P (c4))
Kenichi Handa's avatar
Kenichi Handa committed
1263 1264
		    goto invalid_code;
		  if (UTF_8_4_OCTET_LEADING_P (c1))
1265
		    {
Kenichi Handa's avatar
Kenichi Handa committed
1266 1267
		    c = (((c1 & 0x7) << 18) | ((c2 & 0x3F) << 12)
			 | ((c3 & 0x3F) << 6) | (c4 & 0x3F));
1268 1269 1270
		    if (c < 0x10000)
		      goto invalid_code;
		    }
Kenichi Handa's avatar
Kenichi Handa committed
1271 1272 1273
		  else
		    {
		      ONE_MORE_BYTE (c5);
1274
		      if (c5 < 0 || ! UTF_8_EXTRA_OCTET_P (c5))
Kenichi Handa's avatar
Kenichi Handa committed
1275 1276 1277 1278 1279 1280
			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));
1281
			  if ((c > MAX_CHAR) || (c < 0x200000))
Kenichi Handa's avatar
Kenichi Handa committed
1282 1283 1284 1285 1286 1287
			    goto invalid_code;
			}
		      else
			goto invalid_code;
		    }
		}
1288
	    }
1289
	}
Kenichi Handa's avatar
Kenichi Handa committed
1290 1291 1292 1293 1294 1295 1296 1297 1298 1299

      *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++;
1300 1301
    }

Kenichi Handa's avatar
Kenichi Handa committed
1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317
 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;
1318
  int produced_chars = 0;
Kenichi Handa's avatar
Kenichi Handa committed
1319 1320 1321
  int c;

  if (multibytep)
1322
    {
Kenichi Handa's avatar
Kenichi Handa committed
1323 1324 1325
      int safe_room = MAX_MULTIBYTE_LENGTH * 2;

      while (charbuf < charbuf_end)
1326
	{
Kenichi Handa's avatar
Kenichi Handa committed
1327
	  unsigned char str[MAX_MULTIBYTE_LENGTH], *p, *pend = str;