coding.c 290 KB
Newer Older
Dave Love's avatar
Dave Love committed
1
/* Coding system handler (conversion, detection, etc).
2
   Copyright (C) 2001, 2002, 2003, 2004, 2005,
Glenn Morris's avatar
Glenn Morris committed
3
                 2006, 2007, 2008 Free Software Foundation, Inc.
Kenichi Handa's avatar
Kenichi Handa committed
4
   Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
Glenn Morris's avatar
Glenn Morris committed
5
     2005, 2006, 2007, 2008
Kenichi Handa's avatar
Kenichi Handa committed
6 7
     National Institute of Advanced Industrial Science and Technology (AIST)
     Registration Number H14PRO021
Kenichi Handa's avatar
Kenichi Handa committed
8
   Copyright (C) 2003
Kenichi Handa's avatar
Kenichi Handa committed
9 10
     National Institute of Advanced Industrial Science and Technology (AIST)
     Registration Number H13PRO009
Karl Heuer's avatar
Karl Heuer committed
11

Karl Heuer's avatar
Karl Heuer committed
12 13 14 15
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
16
the Free Software Foundation; either version 3, or (at your option)
Karl Heuer's avatar
Karl Heuer committed
17
any later version.
Karl Heuer's avatar
Karl Heuer committed
18

Karl Heuer's avatar
Karl Heuer committed
19 20 21 22
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
23

Karl Heuer's avatar
Karl Heuer committed
24 25
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
26 27
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Karl Heuer's avatar
Karl Heuer committed
28 29 30

/*** TABLE OF CONTENTS ***

31
  0. General comments
Karl Heuer's avatar
Karl Heuer committed
32
  1. Preamble
Kenichi Handa's avatar
Kenichi Handa committed
33 34 35 36 37 38 39 40 41 42 43
  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
44 45 46

*/

Kenichi Handa's avatar
Kenichi Handa committed
47
/*** 0. General comments ***
48 49


Kenichi Handa's avatar
Kenichi Handa committed
50
CODING SYSTEM
Karl Heuer's avatar
Karl Heuer committed
51

Dave Love's avatar
Dave Love committed
52 53
  A coding system is an object for an encoding mechanism that contains
  information about how to convert byte sequences to character
54 55 56 57 58
  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
59
  coding system.
Karl Heuer's avatar
Karl Heuer committed
60

61 62
  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
63
  stored in the hash table Vcharset_hash_table.  The conversion from
64 65
  coding system symbol to attributes vector is done by looking up
  Vcharset_hash_table by the symbol.
Karl Heuer's avatar
Karl Heuer committed
66

67
  Coding systems are classified into the following types depending on
Dave Love's avatar
Dave Love committed
68
  the encoding mechanism.  Here's a brief description of the types.
Karl Heuer's avatar
Karl Heuer committed
69

Kenichi Handa's avatar
Kenichi Handa committed
70 71 72 73 74 75 76
  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
77
  Decoding and encoding are done by a code converter defined for each
Kenichi Handa's avatar
Kenichi Handa committed
78 79
  character set.

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

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

Kenichi Handa's avatar
Kenichi Handa committed
84
  o ISO2022-base coding system
Karl Heuer's avatar
Karl Heuer committed
85 86

  The most famous coding system for multiple character sets.  X's
Kenichi Handa's avatar
Kenichi Handa committed
87 88 89
  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
90

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

Karl Heuer's avatar
Karl Heuer committed
93 94
  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
95
  section 8.
Karl Heuer's avatar
Karl Heuer committed
96

Kenichi Handa's avatar
Kenichi Handa committed
97
  o BIG5
Karl Heuer's avatar
Karl Heuer committed
98

Kenichi Handa's avatar
Kenichi Handa committed
99
  A coding system to encode character sets: ASCII and Big5.  Widely
Dave Love's avatar
Dave Love committed
100
  used for Chinese (mainly in Taiwan and Hong Kong).  Details are
Kenichi Handa's avatar
Kenichi Handa committed
101 102 103
  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
104

Kenichi Handa's avatar
Kenichi Handa committed
105
  o CCL
106

Dave Love's avatar
Dave Love committed
107
  If a user wants to decode/encode text encoded in a coding system
Kenichi Handa's avatar
Kenichi Handa committed
108 109 110
  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.
111

Kenichi Handa's avatar
Kenichi Handa committed
112
  o Raw-text
Karl Heuer's avatar
Karl Heuer committed
113

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

Kenichi Handa's avatar
Kenichi Handa committed
118 119 120
  o No-conversion

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


Kenichi Handa's avatar
Kenichi Handa committed
123
END-OF-LINE FORMAT
Karl Heuer's avatar
Karl Heuer committed
124

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

Dave Love's avatar
Dave Love committed
131
  Since text character encoding and end-of-line encoding are
Kenichi Handa's avatar
Kenichi Handa committed
132 133
  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
134

135 136 137 138 139
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
140
  conversion (e.g. the location of source and destination data).
Karl Heuer's avatar
Karl Heuer committed
141 142 143

*/

Kenichi Handa's avatar
Kenichi Handa committed
144 145 146
/* COMMON MACROS */


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

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

153
  Return 1 if the byte sequence conforms to XXX, otherwise return 0.
Kenichi Handa's avatar
Kenichi Handa committed
154 155 156

  Below is the template of these functions.  */

Karl Heuer's avatar
Karl Heuer committed
157
#if 0
Kenichi Handa's avatar
Kenichi Handa committed
158
static int
159
detect_coding_XXX (coding, detect_info)
Kenichi Handa's avatar
Kenichi Handa committed
160
     struct coding_system *coding;
161
     struct coding_detection_info *detect_info;
Karl Heuer's avatar
Karl Heuer committed
162
{
163 164
  const unsigned char *src = coding->source;
  const unsigned char *src_end = coding->source + coding->src_bytes;
Kenichi Handa's avatar
Kenichi Handa committed
165
  int multibytep = coding->src_multibyte;
166
  int consumed_chars = 0;
Kenichi Handa's avatar
Kenichi Handa committed
167 168 169 170 171 172 173 174
  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);
175 176 177 178 179

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

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

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

Kenichi Handa's avatar
Kenichi Handa committed
194 195 196 197
  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;
198

Kenichi Handa's avatar
Kenichi Handa committed
199 200 201 202
  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.
203

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

Karl Heuer's avatar
Karl Heuer committed
206
#if 0
207
static void
Kenichi Handa's avatar
Kenichi Handa committed
208
decode_coding_XXXX (coding)
Karl Heuer's avatar
Karl Heuer committed
209 210
     struct coding_system *coding;
{
211 212
  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
213 214 215
  /* 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.  */
216
  const unsigned char *src_base;
Kenichi Handa's avatar
Kenichi Handa committed
217
  /* A buffer to produce decoded characters.  */
218 219
  int *charbuf = coding->charbuf + coding->charbuf_used;
  int *charbuf_end = coding->charbuf + coding->charbuf_size;
Kenichi Handa's avatar
Kenichi Handa committed
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
  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
244 245 246 247 248
}
#endif

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

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

Kenichi Handa's avatar
Kenichi Handa committed
254 255 256 257
  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.
258

Kenichi Handa's avatar
Kenichi Handa committed
259 260 261
  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.
262

Kenichi Handa's avatar
Kenichi Handa committed
263
  Below is a template of these functions.  */
Karl Heuer's avatar
Karl Heuer committed
264
#if 0
265
static void
Kenichi Handa's avatar
Kenichi Handa committed
266
encode_coding_XXX (coding)
Karl Heuer's avatar
Karl Heuer committed
267 268
     struct coding_system *coding;
{
Kenichi Handa's avatar
Kenichi Handa committed
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
  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
286 287 288 289 290 291
}
#endif


/*** 1. Preamble ***/

292
#include <config.h>
Karl Heuer's avatar
Karl Heuer committed
293 294 295 296
#include <stdio.h>

#include "lisp.h"
#include "buffer.h"
Kenichi Handa's avatar
Kenichi Handa committed
297
#include "character.h"
Karl Heuer's avatar
Karl Heuer committed
298 299
#include "charset.h"
#include "ccl.h"
Kenichi Handa's avatar
Kenichi Handa committed
300
#include "composite.h"
Karl Heuer's avatar
Karl Heuer committed
301 302
#include "coding.h"
#include "window.h"
303 304
#include "frame.h"
#include "termhooks.h"
Karl Heuer's avatar
Karl Heuer committed
305

Kenichi Handa's avatar
Kenichi Handa committed
306
Lisp_Object Vcoding_system_hash_table;
Karl Heuer's avatar
Karl Heuer committed
307

Kenichi Handa's avatar
Kenichi Handa committed
308
Lisp_Object Qcoding_system, Qcoding_aliases, Qeol_type;
309 310
Lisp_Object Qunix, Qdos;
extern Lisp_Object Qmac;	/* frame.c */
Karl Heuer's avatar
Karl Heuer committed
311 312
Lisp_Object Qbuffer_file_coding_system;
Lisp_Object Qpost_read_conversion, Qpre_write_conversion;
Kenichi Handa's avatar
Kenichi Handa committed
313
Lisp_Object Qdefault_char;
314
Lisp_Object Qno_conversion, Qundecided;
Kenichi Handa's avatar
Kenichi Handa committed
315
Lisp_Object Qcharset, Qiso_2022, Qutf_8, Qutf_16, Qshift_jis, Qbig5;
316
Lisp_Object Qbig, Qlittle;
317
Lisp_Object Qcoding_system_history;
Kenichi Handa's avatar
Kenichi Handa committed
318
Lisp_Object Qvalid_codes;
Kenichi Handa's avatar
Kenichi Handa committed
319 320 321
Lisp_Object QCcategory, QCmnemonic, QCdefalut_char;
Lisp_Object QCdecode_translation_table, QCencode_translation_table;
Lisp_Object QCpost_read_conversion, QCpre_write_conversion;
322
Lisp_Object QCascii_compatible_p;
Karl Heuer's avatar
Karl Heuer committed
323 324

extern Lisp_Object Qinsert_file_contents, Qwrite_region;
Kim F. Storm's avatar
Kim F. Storm committed
325
Lisp_Object Qcall_process, Qcall_process_region;
Karl Heuer's avatar
Karl Heuer committed
326 327 328
Lisp_Object Qstart_process, Qopen_network_stream;
Lisp_Object Qtarget_idx;

329 330 331
Lisp_Object Qinsufficient_source, Qinconsistent_eol, Qinvalid_source;
Lisp_Object Qinterrupted, Qinsufficient_memory;

332 333
extern Lisp_Object Qcompletion_ignore_case;

334 335 336 337
/* If a symbol has this property, evaluate the value to define the
   symbol as a coding system.  */
static Lisp_Object Qcoding_system_define_form;

338 339
int coding_system_require_warning;

340 341
Lisp_Object Vselect_safe_coding_system_function;

342 343 344
/* 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
345
   decided.  */
346
Lisp_Object eol_mnemonic_undecided;
Karl Heuer's avatar
Karl Heuer committed
347

348 349 350 351 352 353
/* Format of end-of-line decided by system.  This is Qunix on
   Unix and Mac, Qdos on DOS/Windows.
   This has an effect only for external encoding (i.e. for output to
   file and process), not for in-buffer or Lisp string encoding.  */
static Lisp_Object system_eol_type;

Karl Heuer's avatar
Karl Heuer committed
354 355
#ifdef emacs

356 357 358
Lisp_Object Vcoding_system_list, Vcoding_system_alist;

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

360 361 362
/* 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
363
Lisp_Object Qutf_8_emacs;
Dave Love's avatar
Dave Love committed
364

Karl Heuer's avatar
Karl Heuer committed
365 366 367 368 369 370 371 372
/* 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;
373 374
/* Set to non-nil when an error is detected while code conversion.  */
Lisp_Object Vlast_code_conversion_error;
375
/* A vector of length 256 which contains information about special
Karl Heuer's avatar
Karl Heuer committed
376
   Latin codes (especially for dealing with Microsoft codes).  */
377
Lisp_Object Vlatin_extra_code_table;
378

379 380 381
/* Flag to inhibit code conversion of end-of-line format.  */
int inhibit_eol_conversion;

382 383 384
/* Flag to inhibit ISO2022 escape sequence detection.  */
int inhibit_iso_escape_detection;

385 386 387
/* Flag to make buffer-file-coding-system inherit from process-coding.  */
int inherit_process_coding_system;

388 389 390 391
/* Coding system to be used to encode text for terminal display when
   terminal coding system is nil.  */
struct coding_system safe_terminal_coding;

392 393 394
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
395

396 397
Lisp_Object Vlocale_coding_system;

Karl Heuer's avatar
Karl Heuer committed
398 399
#endif /* emacs */

400 401
/* Flag to tell if we look up translation table on character code
   conversion.  */
402
Lisp_Object Venable_character_translation;
403 404 405 406
/* 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;
407

408 409 410 411
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
412 413

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

416 417 418
/* Default coding systems used for process I/O.  */
Lisp_Object Vdefault_process_coding_system;

419 420 421
/* Char table for translating Quail and self-inserting input.  */
Lisp_Object Vtranslation_table_for_input;

Kenichi Handa's avatar
Kenichi Handa committed
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 475 476 477 478 479 480 481 482 483 484 485 486
/* 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.  */
  };
487

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

Kenichi Handa's avatar
Kenichi Handa committed
491 492 493
/* 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
494

Kenichi Handa's avatar
Kenichi Handa committed
495 496 497
/* If set, reset graphic planes and registers at end-of-line to the
   initial state.  */
#define CODING_ISO_FLAG_RESET_AT_EOL	0x0002
498

Kenichi Handa's avatar
Kenichi Handa committed
499 500 501
/* If set, reset graphic planes and registers before any control
   characters to the initial state.  */
#define CODING_ISO_FLAG_RESET_AT_CNTL	0x0004
502

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

Kenichi Handa's avatar
Kenichi Handa committed
506 507
/* If set, use locking-shift function.  */
#define CODING_ISO_FLAG_LOCKING_SHIFT	0x0010
508

Kenichi Handa's avatar
Kenichi Handa committed
509 510 511
/* If set, use single-shift function.  Overwrite
   CODING_ISO_FLAG_LOCKING_SHIFT.  */
#define CODING_ISO_FLAG_SINGLE_SHIFT	0x0020
512

Kenichi Handa's avatar
Kenichi Handa committed
513 514
/* If set, use designation escape sequence.  */
#define CODING_ISO_FLAG_DESIGNATION	0x0040
515

Kenichi Handa's avatar
Kenichi Handa committed
516 517
/* If set, produce revision number sequence.  */
#define CODING_ISO_FLAG_REVISION	0x0080
518

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

Kenichi Handa's avatar
Kenichi Handa committed
522 523 524
/* 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
525

Kenichi Handa's avatar
Kenichi Handa committed
526 527 528
/* If set, designation sequence should be placed at beginning of line
   on output.  */
#define CODING_ISO_FLAG_DESIGNATE_AT_BOL 0x0400
529

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

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

Kenichi Handa's avatar
Kenichi Handa committed
537
#define CODING_ISO_FLAG_COMPOSITION	0x2000
538

Kenichi Handa's avatar
Kenichi Handa committed
539
#define CODING_ISO_FLAG_EUC_TW_SHIFT	0x4000
540

541
#define CODING_ISO_FLAG_USE_ROMAN	0x8000
542

543
#define CODING_ISO_FLAG_USE_OLDJIS	0x10000
544

545
#define CODING_ISO_FLAG_FULL_SUPPORT	0x100000
546

Kenichi Handa's avatar
Kenichi Handa committed
547 548 549
/* 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  '?'
550

Karl Heuer's avatar
Karl Heuer committed
551

Kenichi Handa's avatar
Kenichi Handa committed
552 553 554
/* UTF-16 section */
#define CODING_UTF_16_BOM(coding)	\
  ((coding)->spec.utf_16.bom)
Karl Heuer's avatar
Karl Heuer committed
555

Kenichi Handa's avatar
Kenichi Handa committed
556 557
#define CODING_UTF_16_ENDIAN(coding)	\
  ((coding)->spec.utf_16.endian)
Karl Heuer's avatar
Karl Heuer committed
558

Kenichi Handa's avatar
Kenichi Handa committed
559 560
#define CODING_UTF_16_SURROGATE(coding)	\
  ((coding)->spec.utf_16.surrogate)
Karl Heuer's avatar
Karl Heuer committed
561 562


Kenichi Handa's avatar
Kenichi Handa committed
563 564 565 566 567 568
/* 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
569
  (SDATA (AREF (CODING_ID_ATTRS ((coding)->id), coding_attr_ccl_valids)))
Karl Heuer's avatar
Karl Heuer committed
570

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

Kenichi Handa's avatar
Kenichi Handa committed
573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605
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)
606
#define CATEGORY_MASK_UTF_16_AUTO	(1 << coding_category_utf_16_auto)
Kenichi Handa's avatar
Kenichi Handa committed
607 608 609 610 611 612 613 614 615
#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)
616
#define CATEGORY_MASK_RAW_TEXT		(1 << coding_category_raw_text)
Kenichi Handa's avatar
Kenichi Handa committed
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 677 678 679 680 681 682 683 684 685 686 687 688

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

690 691 692 693
#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
694
  } while (0)
Karl Heuer's avatar
Karl Heuer committed
695 696


Kenichi Handa's avatar
Kenichi Handa committed
697 698
/* 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
699 700 701 702 703
   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 */
704

705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720
#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						\
	  {						\
721 722
	    src--;					\
	    c = - string_char (src, &src, NULL);	\
723 724 725 726 727
	    record_conversion_result			\
	      (coding, CODING_RESULT_INVALID_SRC);	\
	  }						\
      }							\
    consumed_chars++;					\
728 729 730
  } while (0)


731 732 733 734 735 736 737 738 739
#define ONE_MORE_BYTE_NO_CHECK(c)			\
  do {							\
    c = *src++;						\
    if (multibytep && (c & 0x80))			\
      {							\
	if ((c & 0xFE) == 0xC0)				\
	  c = ((c & 1) << 6) | *src++;			\
	else						\
	  {						\
740 741
	    src--;					\
	    c = - string_char (src, &src, NULL);	\
742 743 744 745 746
	    record_conversion_result			\
	      (coding, CODING_RESULT_INVALID_SRC);	\
	  }						\
      }							\
    consumed_chars++;					\
747 748 749
  } while (0)


Kenichi Handa's avatar
Kenichi Handa committed
750 751 752 753 754
/* 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.
*/
755 756


Kenichi Handa's avatar
Kenichi Handa committed
757 758 759 760
#define EMIT_ONE_ASCII_BYTE(c)	\
  do {				\
    produced_chars++;		\
    *dst++ = (c);		\
761
  } while (0)
762 763


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

Kenichi Handa's avatar
Kenichi Handa committed
766 767 768 769 770
#define EMIT_TWO_ASCII_BYTES(c1, c2)	\
  do {					\
    produced_chars += 2;		\
    *dst++ = (c1), *dst++ = (c2);	\
  } while (0)
771 772


Kenichi Handa's avatar
Kenichi Handa committed
773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790
/* 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);			\
791 792 793
  } while (0)


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

796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816
#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);			\
      }					\
817 818 819
  } while (0)


Kenichi Handa's avatar
Kenichi Handa committed
820 821 822 823 824
#define EMIT_THREE_BYTES(c1, c2, c3)	\
  do {					\
    EMIT_ONE_BYTE (c1);			\
    EMIT_TWO_BYTES (c2, c3);		\
  } while (0)
825 826


Kenichi Handa's avatar
Kenichi Handa committed
827 828 829 830 831
#define EMIT_FOUR_BYTES(c1, c2, c3, c4)		\
  do {						\
    EMIT_TWO_BYTES (c1, c2);			\
    EMIT_TWO_BYTES (c3, c4);			\
  } while (0)
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
/* 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 *,
879
					    EMACS_INT, EMACS_INT));
880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912
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));

913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934
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;
935 936
    default:
      Vlast_code_conversion_error = intern ("Unknown error");
937 938 939
    }
}

Kenichi Handa's avatar
Kenichi Handa committed
940 941 942 943 944 945
#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
946
	const unsigned char *orig = coding->source;			     \
Kenichi Handa's avatar
Kenichi Handa committed
947 948 949 950 951 952 953 954
	EMACS_INT offset;						     \
									     \
	coding_set_source (coding);					     \
	offset = coding->source - orig;					     \
	src += offset;							     \
	src_base += offset;						     \
	src_end += offset;						     \
      }									     \
955 956 957
  } while (0)


Kenichi Handa's avatar
Kenichi Handa committed
958 959 960 961 962 963 964 965 966 967
#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)
968 969 970



Kenichi Handa's avatar
Kenichi Handa committed
971 972
static void
coding_set_source (coding)
973 974
     struct coding_system *coding;
{
Kenichi Handa's avatar
Kenichi Handa committed
975 976
  if (BUFFERP (coding->src_object))
    {
977
      struct buffer *buf = XBUFFER (coding->src_object);
978

Kenichi Handa's avatar
Kenichi Handa committed
979
      if (coding->src_pos < 0)
980
	coding->source = BUF_GAP_END_ADDR (buf) + coding->src_pos_byte;
Kenichi Handa's avatar
Kenichi Handa committed
981
      else
982
	coding->source = BUF_BYTE_ADDRESS (buf, coding->src_pos_byte);
983
    }
Kenichi Handa's avatar
Kenichi Handa committed
984
  else if (STRINGP (coding->src_object))
985
    {
Kenichi Handa's avatar
Kenichi Handa committed
986
      coding->source = SDATA (coding->src_object) + coding->src_pos_byte;
987
    }
Kenichi Handa's avatar
Kenichi Handa committed
988 989 990 991 992
  else
    /* Otherwise, the source is C string and is never relocated
       automatically.  Thus we don't have to update anything.  */
    ;
}
993

Kenichi Handa's avatar
Kenichi Handa committed
994 995 996 997 998
static void
coding_set_destination (coding)
     struct coding_system *coding;
{
  if (BUFFERP (coding->dst_object))
999
    {
Kenichi Handa's avatar
Kenichi Handa committed
1000
      if (coding->src_pos < 0)
1001
	{
1002 1003 1004 1005
	  coding->destination = BEG_ADDR + coding->dst_pos_byte - 1;
	  coding->dst_bytes = (GAP_END_ADDR
			       - (coding->src_bytes - coding->consumed)
			       - coding->destination);
1006
	}
Kenichi Handa's avatar
Kenichi Handa committed
1007
      else
1008 1009 1010 1011 1012 1013 1014 1015
	{
	  /* 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
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034
    }
  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
1035
coding_alloc_by_making_gap (coding, offset, bytes)
Kenichi Handa's avatar
Kenichi Handa committed
1036
     struct coding_system *coding;
1037
     EMACS_INT offset, bytes;
Kenichi Handa's avatar
Kenichi Handa committed
1038
{
1039 1040
  if (BUFFERP (coding->dst_object)
      && EQ (coding->src_object, coding->dst_object))
Kenichi Handa's avatar
Kenichi Handa committed
1041
    {
1042
      EMACS_INT add = offset + (coding->src_bytes - coding->consumed);
Kenichi Handa's avatar
Kenichi Handa committed
1043

1044
      GPT += offset, GPT_BYTE += offset;
Kenichi Handa's avatar
Kenichi Handa committed
1045 1046 1047
      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;
1048
      GPT -= offset, GPT_BYTE -= offset;
Kenichi Handa's avatar
Kenichi Handa committed
1049
    }
1050
  else
Kenichi Handa's avatar
Kenichi Handa committed
1051
    {
1052 1053 1054
      Lisp_Object this_buffer;

      this_buffer = Fcurrent_buffer ();
Kenichi Handa's avatar
Kenichi Handa committed
1055 1056 1057
      set_buffer_internal (XBUFFER (coding->dst_object));
      make_gap (bytes);
      set_buffer_internal (XBUFFER (this_buffer));
1058
    }
Kenichi Handa's avatar
Kenichi Handa committed
1059
}
Kenichi Handa's avatar
Kenichi Handa committed
1060

Kenichi Handa's avatar
Kenichi Handa committed
1061 1062 1063 1064

static unsigned char *
alloc_destination (coding, nbytes, dst)
     struct coding_system *coding;
1065
     EMACS_INT nbytes;
Kenichi Handa's avatar
Kenichi Handa committed
1066 1067 1068 1069 1070
     unsigned char *dst;
{
  EMACS_INT offset = dst - coding->destination;

  if (BUFFERP (coding->dst_object))
1071
    coding_alloc_by_making_gap (coding, offset, nbytes);
1072
  else
Kenichi Handa's avatar
Kenichi Handa committed
1073
    coding_alloc_by_realloc (coding, nbytes);
1074
  record_conversion_result (coding, CODING_RESULT_SUCCESS);
Kenichi Handa's avatar
Kenichi Handa committed
1075 1076 1077 1078
  coding_set_destination (coding);
  dst = coding->destination + offset;
  return dst;
}
1079

1080 1081 1082 1083
/** Macros for annotations.  */

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

/* An annotation data is stored in the array coding->charbuf in this
   format:
1088
     [ -LENGTH ANNOTATION_MASK NCHARS ... ]
1089 1090
   LENGTH is the number of elements in the annotation.
   ANNOTATION_MASK is one of CODING_ANNOTATE_XXX_MASK.
1091
   NCHARS is the number of characters in the text annotated.
1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104

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

1105
#define ADD_ANNOTATION_DATA(buf, len, mask, nchars)	\
1106 1107 1108
  do {							\
    *(buf)++ = -(len);					\
    *(buf)++ = (mask);					\
1109
    *(buf)++ = (nchars);				\
1110 1111 1112
    coding->annotated = 1;				\
  } while (0);

1113 1114 1115 1116
#define ADD_COMPOSITION_DATA(buf, nchars, method)			    \
  do {									    \
    ADD_ANNOTATION_DATA (buf, 4, CODING_ANNOTATE_COMPOSITION_MASK, nchars); \
    *buf++ = method;							    \
1117 1118 1119
  } while (0)


1120 1121 1122 1123
#define ADD_CHARSET_DATA(buf, nchars, id)				\
  do {									\
    ADD_ANNOTATION_DATA (buf, 4, CODING_ANNOTATE_CHARSET_MASK, nchars);	\
    *buf++ = id;							\
1124 1125
  } while (0)

Kenichi Handa's avatar
Kenichi Handa committed
1126 1127 1128 1129 1130 1131 1132 1133 1134

/*** 2. Emacs' internal format (emacs-utf-8) ***/



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

/* See the above "GENERAL NOTES on `detect_coding_XXX ()' functions".
1135 1136
   Check if a text is encoded in UTF-8.  If it is, return 1, else
   return 0.  */
Kenichi Handa's avatar
Kenichi Handa committed
1137 1138 1139 1140 1141 1142 1143 1144 1145

#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
1146
detect_coding_utf_8 (coding, detect_info)
Kenichi Handa's avatar
Kenichi Handa committed
1147
     struct coding_system *coding;
1148
     struct coding_detection_info *detect_info;
Kenichi Handa's avatar
Kenichi Handa committed
1149
{
1150
  const unsigned char *src = coding->source, *src_base;
Kenichi Handa's avatar
Kenichi Handa committed
1151
  const unsigned char *src_end = coding->source + coding->src_bytes;
Kenichi Handa's avatar
Kenichi Handa committed
1152 1153 1154 1155
  int multibytep = coding->src_multibyte;
  int consumed_chars = 0;
  int found = 0;

1156
  detect_info->checked |= CATEGORY_MASK_UTF_8;
Kenichi Handa's avatar
Kenichi Handa committed
1157 1158 1159 1160
  /* A coding system of this category is always ASCII compatible.  */
  src += coding->head_ascii;

  while (1)
1161
    {
Kenichi Handa's avatar
Kenichi Handa committed
1162
      int c, c1, c2, c3, c4;
1163

1164
      src_base = src;
Kenichi Handa's avatar
Kenichi Handa committed
1165
      ONE_MORE_BYTE (c);
1166
      if (c < 0 || UTF_8_1_OCTET_P (c))
Kenichi Handa's avatar
Kenichi Handa committed
1167 1168
	continue;
      ONE_MORE_BYTE (c1);
1169
      if (c1 < 0 || ! UTF_8_EXTRA_OCTET_P (c1))
Kenichi Handa's avatar
Kenichi Handa committed
1170 1171
	break;
      if (UTF_8_2_OCTET_LEADING_P (c))
1172
	{
1173
	  found = CATEGORY_MASK_UTF_8;
Kenichi Handa's avatar
Kenichi Handa committed
1174
	  continue;
1175
	}
Kenichi Handa's avatar
Kenichi Handa committed
1176
      ONE_MORE_BYTE (c2);
1177
      if (c2 < 0 || ! UTF_8_EXTRA_OCTET_P (c2))
Kenichi Handa's avatar
Kenichi Handa committed
1178 1179
	break;
      if (UTF_8_3_OCTET_LEADING_P (c))
1180
	{
1181
	  found = CATEGORY_MASK_UTF_8;
Kenichi Handa's avatar
Kenichi Handa committed
1182
	  continue;
1183
	}
Kenichi Handa's avatar
Kenichi Handa committed
1184
      ONE_MORE_BYTE (c3);
1185
      if (c3 < 0 || ! UTF_8_EXTRA_OCTET_P (c3))
Kenichi Handa's avatar
Kenichi Handa committed
1186 1187
	break;
      if (UTF_8_4_OCTET_LEADING_P (c))
1188
	{
1189
	  found = CATEGORY_MASK_UTF_8;
Kenichi Handa's avatar
Kenichi Handa committed
1190 1191 1192
	  continue;
	}
      ONE_MORE_BYTE (c4);
1193
      if (c4 < 0 || ! UTF_8_EXTRA_OCTET_P (c4))
Kenichi Handa's avatar
Kenichi Handa committed
1194 1195 1196
	break;
      if (UTF_8_5_OCTET_LEADING_P (c))
	{
1197
	  found = CATEGORY_MASK_UTF_8;
Kenichi Handa's avatar
Kenichi Handa committed
1198 1199 1200
	  continue;
	}
      break;
1201
    }
1202
  detect_info->rejected |= CATEGORY_MASK_UTF_8;
Kenichi Handa's avatar
Kenichi Handa committed
1203
  return 0;
1204

Kenichi Handa's avatar
Kenichi Handa committed
1205
 no_more_source:
1206
  if (src_base < src && coding->mode & CODING_MODE_LAST_BLOCK)
1207
    {
1208
      detect_info->rejected |= CATEGORY_MASK_UTF_8;
1209
      return 0;
1210
    }
1211 1212
  detect_info->found |= found;
  return 1;
1213 1214
}

Karl Heuer's avatar
Karl Heuer committed
1215

1216
static void