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

Karl Heuer's avatar
Karl Heuer committed
11 12
This file is part of GNU Emacs.

13
GNU Emacs is free software: you can redistribute it and/or modify
Karl Heuer's avatar
Karl Heuer committed
14
it under the terms of the GNU General Public License as published by
15 16
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Karl Heuer's avatar
Karl Heuer committed
17

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

Karl Heuer's avatar
Karl Heuer committed
23
You should have received a copy of the GNU General Public License
24
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
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.  On
  the 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 true if the byte sequence conforms to XXX.
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
155
static bool
156 157
detect_coding_XXX (struct coding_system *coding,
		   struct coding_detection_info *detect_info)
Karl Heuer's avatar
Karl Heuer committed
158
{
159 160
  const unsigned char *src = coding->source;
  const unsigned char *src_end = coding->source + coding->src_bytes;
161
  bool multibytep = coding->src_multibyte;
162
  ptrdiff_t consumed_chars = 0;
Kenichi Handa's avatar
Kenichi Handa committed
163 164 165 166 167
  int found = 0;
  ...;

  while (1)
    {
Kenichi Handa's avatar
Kenichi Handa committed
168
      /* Get one byte from the source.  If the source is exhausted, jump
Kenichi Handa's avatar
Kenichi Handa committed
169 170
	 to no_more_source:.  */
      ONE_MORE_BYTE (c);
171 172 173 174 175

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

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

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

Kenichi Handa's avatar
Kenichi Handa committed
190 191 192 193
  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;
194

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

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

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

  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
239 240 241 242 243
}
#endif

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

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

Kenichi Handa's avatar
Kenichi Handa committed
249 250 251 252
  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.
253

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

Kenichi Handa's avatar
Kenichi Handa committed
258
  Below is a template of these functions.  */
Karl Heuer's avatar
Karl Heuer committed
259
#if 0
260
static void
261
encode_coding_XXX (struct coding_system *coding)
Karl Heuer's avatar
Karl Heuer committed
262
{
263
  bool multibytep = coding->dst_multibyte;
Kenichi Handa's avatar
Kenichi Handa committed
264 265 266 267 268
  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_;
269
  ptrdiff_t produced_chars = 0;
Kenichi Handa's avatar
Kenichi Handa committed
270 271 272 273 274 275 276 277 278 279

  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
280 281 282 283 284 285
}
#endif


/*** 1. Preamble ***/

286
#include <config.h>
Karl Heuer's avatar
Karl Heuer committed
287 288 289
#include <stdio.h>

#include "lisp.h"
Kenichi Handa's avatar
Kenichi Handa committed
290
#include "character.h"
291
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
292 293
#include "charset.h"
#include "ccl.h"
Kenichi Handa's avatar
Kenichi Handa committed
294
#include "composite.h"
Karl Heuer's avatar
Karl Heuer committed
295 296
#include "coding.h"
#include "window.h"
297 298
#include "frame.h"
#include "termhooks.h"
Karl Heuer's avatar
Karl Heuer committed
299

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

302 303
static Lisp_Object Qcoding_system, Qeol_type;
static Lisp_Object Qcoding_aliases;
304
Lisp_Object Qunix, Qdos;
Karl Heuer's avatar
Karl Heuer committed
305
Lisp_Object Qbuffer_file_coding_system;
306 307
static Lisp_Object Qpost_read_conversion, Qpre_write_conversion;
static Lisp_Object Qdefault_char;
308
Lisp_Object Qno_conversion, Qundecided;
309 310 311 312 313 314 315 316 317 318
Lisp_Object Qcharset, Qutf_8;
static Lisp_Object Qiso_2022;
static Lisp_Object Qutf_16, Qshift_jis, Qbig5;
static Lisp_Object Qbig, Qlittle;
static Lisp_Object Qcoding_system_history;
static Lisp_Object Qvalid_codes;
static Lisp_Object QCcategory, QCmnemonic, QCdefault_char;
static Lisp_Object QCdecode_translation_table, QCencode_translation_table;
static Lisp_Object QCpost_read_conversion, QCpre_write_conversion;
static Lisp_Object QCascii_compatible_p;
Karl Heuer's avatar
Karl Heuer committed
319

Kim F. Storm's avatar
Kim F. Storm committed
320
Lisp_Object Qcall_process, Qcall_process_region;
Karl Heuer's avatar
Karl Heuer committed
321
Lisp_Object Qstart_process, Qopen_network_stream;
322
static Lisp_Object Qtarget_idx;
Karl Heuer's avatar
Karl Heuer committed
323

324 325
static Lisp_Object Qinsufficient_source, Qinconsistent_eol, Qinvalid_source;
static Lisp_Object Qinterrupted, Qinsufficient_memory;
326

327 328 329 330
/* If a symbol has this property, evaluate the value to define the
   symbol as a coding system.  */
static Lisp_Object Qcoding_system_define_form;

331 332 333 334 335 336
/* 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
337 338
#ifdef emacs

339
Lisp_Object Qcoding_system_p, Qcoding_system_error;
Karl Heuer's avatar
Karl Heuer committed
340

341 342 343
/* 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
344
Lisp_Object Qutf_8_emacs;
Dave Love's avatar
Dave Love committed
345

346
#if defined (WINDOWSNT) || defined (CYGWIN)
347 348 349
static Lisp_Object Qutf_16le;
#endif

Karl Heuer's avatar
Karl Heuer committed
350 351
/* Coding-systems are handed between Emacs Lisp programs and C internal
   routines by the following three variables.  */
352 353 354 355
/* Coding system to be used to encode text for terminal display when
   terminal coding system is nil.  */
struct coding_system safe_terminal_coding;

Karl Heuer's avatar
Karl Heuer committed
356 357
#endif /* emacs */

358 359
Lisp_Object Qtranslation_table;
Lisp_Object Qtranslation_table_id;
360 361
static Lisp_Object Qtranslation_table_for_decode;
static Lisp_Object Qtranslation_table_for_encode;
Karl Heuer's avatar
Karl Heuer committed
362

Kenichi Handa's avatar
Kenichi Handa committed
363
/* Two special coding systems.  */
364 365
static Lisp_Object Vsjis_coding_system;
static Lisp_Object Vbig5_coding_system;
Kenichi Handa's avatar
Kenichi Handa committed
366 367 368 369 370 371 372 373 374

/* ISO2022 section */

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


375 376 377 378 379
#define CODING_ISO_REQUEST(coding, charset_id)		\
  (((charset_id) <= (coding)->max_charset_id		\
    ? ((coding)->safe_charsets[charset_id] != 255	\
       ? (coding)->safe_charsets[charset_id]		\
       : -1)						\
Kenichi Handa's avatar
Kenichi Handa committed
380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
    : -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)))
395 396 397 398 399 400
#define CODING_ISO_CMP_STATUS(coding)	\
  (&(coding)->spec.iso_2022.cmp_status)
#define CODING_ISO_EXTSEGMENT_LEN(coding)	\
  ((coding)->spec.iso_2022.ctext_extended_segment_len)
#define CODING_ISO_EMBEDDED_UTF_8(coding)	\
  ((coding)->spec.iso_2022.embedded_utf_8)
Kenichi Handa's avatar
Kenichi Handa committed
401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421

/* Control characters of ISO2022.  */
			/* code */	/* function */
#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) */
422
    ISO_escape,			/* ISO_CODE_ESC (0x1B) */
Kenichi Handa's avatar
Kenichi Handa committed
423 424 425 426 427 428 429 430 431 432 433
    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.  */
  };
434

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

Kenichi Handa's avatar
Kenichi Handa committed
438 439 440
/* 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
441

Kenichi Handa's avatar
Kenichi Handa committed
442 443 444
/* If set, reset graphic planes and registers at end-of-line to the
   initial state.  */
#define CODING_ISO_FLAG_RESET_AT_EOL	0x0002
445

Kenichi Handa's avatar
Kenichi Handa committed
446 447 448
/* If set, reset graphic planes and registers before any control
   characters to the initial state.  */
#define CODING_ISO_FLAG_RESET_AT_CNTL	0x0004
449

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

Kenichi Handa's avatar
Kenichi Handa committed
453 454
/* If set, use locking-shift function.  */
#define CODING_ISO_FLAG_LOCKING_SHIFT	0x0010
455

Kenichi Handa's avatar
Kenichi Handa committed
456 457 458
/* If set, use single-shift function.  Overwrite
   CODING_ISO_FLAG_LOCKING_SHIFT.  */
#define CODING_ISO_FLAG_SINGLE_SHIFT	0x0020
459

Kenichi Handa's avatar
Kenichi Handa committed
460 461
/* If set, use designation escape sequence.  */
#define CODING_ISO_FLAG_DESIGNATION	0x0040
462

Kenichi Handa's avatar
Kenichi Handa committed
463 464
/* If set, produce revision number sequence.  */
#define CODING_ISO_FLAG_REVISION	0x0080
465

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

Kenichi Handa's avatar
Kenichi Handa committed
469 470 471
/* 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
472

Kenichi Handa's avatar
Kenichi Handa committed
473 474 475
/* If set, designation sequence should be placed at beginning of line
   on output.  */
#define CODING_ISO_FLAG_DESIGNATE_AT_BOL 0x0400
476

Kenichi Handa's avatar
Kenichi Handa committed
477
/* If set, do not encode unsafe characters on output.  */
Kenichi Handa's avatar
Kenichi Handa committed
478
#define CODING_ISO_FLAG_SAFE		0x0800
479

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

Kenichi Handa's avatar
Kenichi Handa committed
484
#define CODING_ISO_FLAG_COMPOSITION	0x2000
485

486
/* #define CODING_ISO_FLAG_EUC_TW_SHIFT	0x4000 */
487

488
#define CODING_ISO_FLAG_USE_ROMAN	0x8000
489

490
#define CODING_ISO_FLAG_USE_OLDJIS	0x10000
491

492
#define CODING_ISO_FLAG_FULL_SUPPORT	0x100000
493

Kenichi Handa's avatar
Kenichi Handa committed
494 495 496
/* 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  '?'
497

Kenichi Handa's avatar
Kenichi Handa committed
498 499 500
/* UTF-8 section */
#define CODING_UTF_8_BOM(coding)	\
  ((coding)->spec.utf_8_bom)
Karl Heuer's avatar
Karl Heuer committed
501

Kenichi Handa's avatar
Kenichi Handa committed
502 503 504
/* UTF-16 section */
#define CODING_UTF_16_BOM(coding)	\
  ((coding)->spec.utf_16.bom)
Karl Heuer's avatar
Karl Heuer committed
505

Kenichi Handa's avatar
Kenichi Handa committed
506 507
#define CODING_UTF_16_ENDIAN(coding)	\
  ((coding)->spec.utf_16.endian)
Karl Heuer's avatar
Karl Heuer committed
508

Kenichi Handa's avatar
Kenichi Handa committed
509 510
#define CODING_UTF_16_SURROGATE(coding)	\
  ((coding)->spec.utf_16.surrogate)
Karl Heuer's avatar
Karl Heuer committed
511 512


Kenichi Handa's avatar
Kenichi Handa committed
513 514 515 516 517 518
/* 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
519
  (SDATA (AREF (CODING_ID_ATTRS ((coding)->id), coding_attr_ccl_valids)))
Karl Heuer's avatar
Karl Heuer committed
520

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

Kenichi Handa's avatar
Kenichi Handa committed
523 524 525 526 527 528 529 530
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,
Kenichi Handa's avatar
Kenichi Handa committed
531 532 533
    coding_category_utf_8_auto,
    coding_category_utf_8_nosig,
    coding_category_utf_8_sig,
Kenichi Handa's avatar
Kenichi Handa committed
534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556
    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)
Kenichi Handa's avatar
Kenichi Handa committed
557 558 559
#define CATEGORY_MASK_UTF_8_AUTO	(1 << coding_category_utf_8_auto)
#define CATEGORY_MASK_UTF_8_NOSIG	(1 << coding_category_utf_8_nosig)
#define CATEGORY_MASK_UTF_8_SIG		(1 << coding_category_utf_8_sig)
560
#define CATEGORY_MASK_UTF_16_AUTO	(1 << coding_category_utf_16_auto)
Kenichi Handa's avatar
Kenichi Handa committed
561 562 563 564 565 566 567 568 569
#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)
570
#define CATEGORY_MASK_RAW_TEXT		(1 << coding_category_raw_text)
Kenichi Handa's avatar
Kenichi Handa committed
571 572 573 574 575 576 577 578 579 580

/* 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		\
Kenichi Handa's avatar
Kenichi Handa committed
581 582 583
   | CATEGORY_MASK_UTF_8_AUTO		\
   | CATEGORY_MASK_UTF_8_NOSIG		\
   | CATEGORY_MASK_UTF_8_SIG		\
584
   | CATEGORY_MASK_UTF_16_AUTO		\
Kenichi Handa's avatar
Kenichi Handa committed
585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616
   | 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		\
617 618
  (CATEGORY_MASK_UTF_16_AUTO		\
   | CATEGORY_MASK_UTF_16_BE		\
Kenichi Handa's avatar
Kenichi Handa committed
619 620 621 622
   | CATEGORY_MASK_UTF_16_LE		\
   | CATEGORY_MASK_UTF_16_BE_NOSIG	\
   | CATEGORY_MASK_UTF_16_LE_NOSIG)

Kenichi Handa's avatar
Kenichi Handa committed
623 624 625 626
#define CATEGORY_MASK_UTF_8	\
  (CATEGORY_MASK_UTF_8_AUTO	\
   | CATEGORY_MASK_UTF_8_NOSIG	\
   | CATEGORY_MASK_UTF_8_SIG)
Kenichi Handa's avatar
Kenichi Handa committed
627 628

/* Table of coding categories (Lisp symbols).  This variable is for
Kenichi Handa's avatar
Kenichi Handa committed
629
   internal use only.  */
Kenichi Handa's avatar
Kenichi Handa committed
630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646
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
647

648 649 650 651
#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
652
  } while (0)
Karl Heuer's avatar
Karl Heuer committed
653 654


Kenichi Handa's avatar
Kenichi Handa committed
655 656
/* 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
657 658
   in the source, it jumps to 'no_more_source'.  If MULTIBYTEP,
   and a multibyte character is found at SRC, set C to the
659 660 661
   negative value of the character code.  The caller should declare
   and set these variables appropriately in advance:
	src, src_end, multibytep */
662

663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678
#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						\
	  {						\
679 680
	    src--;					\
	    c = - string_char (src, &src, NULL);	\
681 682 683 684 685
	    record_conversion_result			\
	      (coding, CODING_RESULT_INVALID_SRC);	\
	  }						\
      }							\
    consumed_chars++;					\
686 687
  } while (0)

Kenichi Handa's avatar
Kenichi Handa committed
688
/* Safely get two bytes from the source text pointed by SRC which ends
Kenichi Handa's avatar
Kenichi Handa committed
689 690
   at SRC_END, and set C1 and C2 to those bytes while skipping the
   heading multibyte characters.  If there are not enough bytes in the
691
   source, it jumps to 'no_more_source'.  If MULTIBYTEP and
Kenichi Handa's avatar
Kenichi Handa committed
692 693 694
   a multibyte character is found for C2, set C2 to the negative value
   of the character code.  The caller should declare and set these
   variables appropriately in advance:
Kenichi Handa's avatar
Kenichi Handa committed
695 696 697
	src, src_end, multibytep
   It is intended that this macro is used in detect_coding_utf_16.  */

Kenichi Handa's avatar
Kenichi Handa committed
698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724
#define TWO_MORE_BYTES(c1, c2)				\
  do {							\
    do {						\
      if (src == src_end)				\
	goto no_more_source;				\
      c1 = *src++;					\
      if (multibytep && (c1 & 0x80))			\
	{						\
	  if ((c1 & 0xFE) == 0xC0)			\
	    c1 = ((c1 & 1) << 6) | *src++;		\
	  else						\
	    {						\
	      src += BYTES_BY_CHAR_HEAD (c1) - 1;	\
	      c1 = -1;					\
	    }						\
	}						\
    } while (c1 < 0);					\
    if (src == src_end)					\
      goto no_more_source;				\
    c2 = *src++;					\
    if (multibytep && (c2 & 0x80))			\
      {							\
	if ((c2 & 0xFE) == 0xC0)			\
	  c2 = ((c2 & 1) << 6) | *src++;		\
	else						\
	  c2 = -1;					\
      }							\
Kenichi Handa's avatar
Kenichi Handa committed
725 726
  } while (0)

727

Kenichi Handa's avatar
Kenichi Handa committed
728 729 730 731 732
/* 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.
*/
733 734


Kenichi Handa's avatar
Kenichi Handa committed
735 736 737 738
#define EMIT_ONE_ASCII_BYTE(c)	\
  do {				\
    produced_chars++;		\
    *dst++ = (c);		\
739
  } while (0)
740 741


Kenichi Handa's avatar
Kenichi Handa committed
742
/* Like EMIT_ONE_ASCII_BYTE but store two bytes; C1 and C2.  */
743

Kenichi Handa's avatar
Kenichi Handa committed
744 745 746 747 748
#define EMIT_TWO_ASCII_BYTES(c1, c2)	\
  do {					\
    produced_chars += 2;		\
    *dst++ = (c1), *dst++ = (c2);	\
  } while (0)
749 750


Kenichi Handa's avatar
Kenichi Handa committed
751
/* Store a byte C in the place pointed by DST and increment DST to the
752 753
   next free point, and increment PRODUCED_CHARS.  If MULTIBYTEP,
   store in an appropriate multibyte form.  The caller should
Kenichi Handa's avatar
Kenichi Handa committed
754 755 756 757 758 759 760 761
   declare and set the variables `dst' and `multibytep' appropriately
   in advance.  */

#define EMIT_ONE_BYTE(c)		\
  do {					\
    produced_chars++;			\
    if (multibytep)			\
      {					\
762
	unsigned ch = (c);		\
Kenichi Handa's avatar
Kenichi Handa committed
763 764 765 766 767 768
	if (ch >= 0x80)			\
	  ch = BYTE8_TO_CHAR (ch);	\
	CHAR_STRING_ADVANCE (ch, dst);	\
      }					\
    else				\
      *dst++ = (c);			\
769 770 771
  } while (0)


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

774 775 776 777 778
#define EMIT_TWO_BYTES(c1, c2)		\
  do {					\
    produced_chars += 2;		\
    if (multibytep)			\
      {					\
779
	unsigned ch;			\
780 781 782 783 784 785 786 787 788 789 790 791 792 793 794
					\
	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);			\
      }					\
795 796 797
  } while (0)


Kenichi Handa's avatar
Kenichi Handa committed
798 799 800 801 802
#define EMIT_THREE_BYTES(c1, c2, c3)	\
  do {					\
    EMIT_ONE_BYTE (c1);			\
    EMIT_TWO_BYTES (c2, c3);		\
  } while (0)
803 804


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


812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833
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;
834 835 836 837 838
    case CODING_RESULT_INSUFFICIENT_DST:
      /* Don't record this error in Vlast_code_conversion_error
	 because it happens just temporarily and is resolved when the
	 whole conversion is finished.  */
      break;
839 840
    case CODING_RESULT_SUCCESS:
      break;
841 842
    default:
      Vlast_code_conversion_error = intern ("Unknown error");
843 844 845
    }
}

846 847 848 849 850
/* These wrapper macros are used to preserve validity of pointers into
   buffer text across calls to decode_char, encode_char, etc, which
   could cause relocation of buffers if it loads a charset map,
   because loading a charset map allocates large structures.  */

Kenichi Handa's avatar
Kenichi Handa committed
851 852
#define CODING_DECODE_CHAR(coding, src, src_base, src_end, charset, code, c) \
  do {									     \
Paul Eggert's avatar
Paul Eggert committed
853
    ptrdiff_t offset;							     \
854
									     \
Kenichi Handa's avatar
Kenichi Handa committed
855 856
    charset_map_loaded = 0;						     \
    c = DECODE_CHAR (charset, code);					     \
857
    if (charset_map_loaded						     \
858
	&& (offset = coding_change_source (coding)))			     \
Kenichi Handa's avatar
Kenichi Handa committed
859 860 861 862 863
      {									     \
	src += offset;							     \
	src_base += offset;						     \
	src_end += offset;						     \
      }									     \
864 865
  } while (0)

866 867
#define CODING_ENCODE_CHAR(coding, dst, dst_end, charset, c, code)	\
  do {									\
Paul Eggert's avatar
Paul Eggert committed
868
    ptrdiff_t offset;							\
869 870 871 872
									\
    charset_map_loaded = 0;						\
    code = ENCODE_CHAR (charset, c);					\
    if (charset_map_loaded						\
873
	&& (offset = coding_change_destination (coding)))		\
874 875 876 877 878 879 880 881
      {									\
	dst += offset;							\
	dst_end += offset;						\
      }									\
  } while (0)

#define CODING_CHAR_CHARSET(coding, dst, dst_end, c, charset_list, code_return, charset) \
  do {									\
Paul Eggert's avatar
Paul Eggert committed
882
    ptrdiff_t offset;							\
883 884 885 886
									\
    charset_map_loaded = 0;						\
    charset = char_charset (c, charset_list, code_return);		\
    if (charset_map_loaded						\
887
	&& (offset = coding_change_destination (coding)))		\
888 889 890 891 892 893 894 895
      {									\
	dst += offset;							\
	dst_end += offset;						\
      }									\
  } while (0)

#define CODING_CHAR_CHARSET_P(coding, dst, dst_end, c, charset, result)	\
  do {									\
Paul Eggert's avatar
Paul Eggert committed
896
    ptrdiff_t offset;							\
897 898 899 900
									\
    charset_map_loaded = 0;						\
    result = CHAR_CHARSET_P (c, charset);				\
    if (charset_map_loaded						\
901
	&& (offset = coding_change_destination (coding)))		\
902 903 904 905 906 907
      {									\
	dst += offset;							\
	dst_end += offset;						\
      }									\
  } while (0)

908

909 910 911 912 913
/* If there are at least BYTES length of room at dst, allocate memory
   for coding->destination and update dst and dst_end.  We don't have
   to take care of coding->source which will be relocated.  It is
   handled by calling coding_set_source in encode_coding.  */

Kenichi Handa's avatar
Kenichi Handa committed
914 915 916 917
#define ASSURE_DESTINATION(bytes)				\
  do {								\
    if (dst + (bytes) >= dst_end)				\
      {								\
918
	ptrdiff_t more_bytes = charbuf_end - charbuf + (bytes);	\
Kenichi Handa's avatar
Kenichi Handa committed
919 920 921 922 923
								\
	dst = alloc_destination (coding, more_bytes, dst);	\
	dst_end = coding->destination + coding->dst_bytes;	\
      }								\
  } while (0)
924 925


Kenichi Handa's avatar
Kenichi Handa committed
926
/* Store multibyte form of the character C in P, and advance P to the
927 928 929
   end of the multibyte form.  This used to be like CHAR_STRING_ADVANCE
   without ever calling MAYBE_UNIFY_CHAR, but nowadays we don't call
   MAYBE_UNIFY_CHAR in CHAR_STRING_ADVANCE.  */
Kenichi Handa's avatar
Kenichi Handa committed
930

931
#define CHAR_STRING_ADVANCE_NO_UNIFY(c, p)  CHAR_STRING_ADVANCE(c, p)
Kenichi Handa's avatar
Kenichi Handa committed
932 933

/* Return the character code of character whose multibyte form is at
934 935 936
   P, and advance P to the end of the multibyte form.  This used to be
   like STRING_CHAR_ADVANCE without ever calling MAYBE_UNIFY_CHAR, but
   nowadays STRING_CHAR_ADVANCE doesn't call MAYBE_UNIFY_CHAR.  */
Kenichi Handa's avatar
Kenichi Handa committed
937

938
#define STRING_CHAR_ADVANCE_NO_UNIFY(p) STRING_CHAR_ADVANCE(p)
939

940
/* Set coding->source from coding->src_object.  */
941

942
static void
943
coding_set_source (struct coding_system *coding)
944
{
Kenichi Handa's avatar
Kenichi Handa committed
945 946
  if (BUFFERP (coding->src_object))
    {
947
      struct buffer *buf = XBUFFER (coding->src_object);
948

Kenichi Handa's avatar
Kenichi Handa committed
949
      if (coding->src_pos < 0)
950
	coding->source = BUF_GAP_END_ADDR (buf) + coding->src_pos_byte;
Kenichi Handa's avatar
Kenichi Handa committed
951
      else
952
	coding->source = BUF_BYTE_ADDRESS (buf, coding->src_pos_byte);
953
    }
Kenichi Handa's avatar
Kenichi Handa committed
954
  else if (STRINGP (coding->src_object))
955
    {
Kenichi Handa's avatar
Kenichi Handa committed
956
      coding->source = SDATA (coding->src_object) + coding->src_pos_byte;
957
    }
Kenichi Handa's avatar
Kenichi Handa committed
958
  else
959 960 961 962
    {
      /* Otherwise, the source is C string and is never relocated
	 automatically.  Thus we don't have to update anything.  */
    }
Kenichi Handa's avatar
Kenichi Handa committed
963
}
964

965

966 967
/* Set coding->source from coding->src_object, and return how many
   bytes coding->source was changed.  */
968

Paul Eggert's avatar
Paul Eggert committed
969
static ptrdiff_t
970
coding_change_source (struct coding_system *coding)
Kenichi Handa's avatar
Kenichi Handa committed
971
{
972 973 974 975 976
  const unsigned char *orig = coding->source;
  coding_set_source (coding);
  return coding->source - orig;
}

977

978 979 980 981 982
/* Set coding->destination from coding->dst_object.  */

static void
coding_set_destination (struct coding_system *coding)
{
Kenichi Handa's avatar
Kenichi Handa committed
983
  if (BUFFERP (coding->dst_object))
984
    {
985
      if (BUFFERP (coding->src_object) && coding->src_pos < 0)
986
	{
987
	  coding->destination = BEG_ADDR + coding->dst_pos_byte - BEG_BYTE;
988 989 990
	  coding->dst_bytes = (GAP_END_ADDR
			       - (coding->src_bytes - coding->consumed)
			       - coding->destination);
991
	}
Kenichi Handa's avatar
Kenichi Handa committed
992
      else
993 994 995 996
	{
	  /* We are sure that coding->dst_pos_byte is before the gap
	     of the buffer. */
	  coding->destination = (BUF_BEG_ADDR (XBUFFER (coding->dst_object))
997
				 + coding->dst_pos_byte - BEG_BYTE);
998 999 1000
	  coding->dst_bytes = (BUF_GAP_END_ADDR (XBUFFER (coding->dst_object))
			       - coding->destination);
	}
Kenichi Handa's avatar
Kenichi Handa committed
1001 1002
    }
  else
1003 1004 1005 1006
    {
      /* Otherwise, the destination is C string and is never relocated
	 automatically.  Thus we don't have to update anything.  */
    }
1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
}


/* Set coding->destination from coding->dst_object, and return how
   many bytes coding->destination was changed.  */

static ptrdiff_t
coding_change_destination (struct coding_system *coding)
{
  const unsigned char *orig = coding->destination;
  coding_set_destination (coding);
1018
  return coding->destination - orig;
Kenichi Handa's avatar
Kenichi Handa committed
1019 1020 1021 1022
}


static void
1023
coding_alloc_by_realloc (struct coding_system *coding, ptrdiff_t bytes)
Kenichi Handa's avatar
Kenichi Handa committed
1024
{
1025
  if (STRING_BYTES_BOUND - coding->dst_bytes < bytes)
1026
    string_overflow ();
1027 1028
  coding->destination = xrealloc (coding->destination,
				  coding->dst_bytes + bytes);
Kenichi Handa's avatar
Kenichi Handa committed
1029 1030 1031 1032
  coding->dst_bytes += bytes;
}

static void
1033
coding_alloc_by_making_gap (struct coding_system *coding,
1034
			    ptrdiff_t gap_head_used, ptrdiff_t bytes)
Kenichi Handa's avatar
Kenichi Handa committed
1035
{
Kenichi Handa's avatar
Kenichi Handa committed
1036
  if (EQ (coding->src_object, coding->dst_object))
Kenichi Handa's avatar
Kenichi Handa committed
1037
    {
Kenichi Handa's avatar
Kenichi Handa committed
1038 1039 1040 1041
      /* The gap may contain the produced data at the head and not-yet
	 consumed data at the tail.  To preserve those data, we at
	 first make the gap size to zero, then increase the gap
	 size.  */
1042
      ptrdiff_t add = GAP_SIZE;
Kenichi Handa's avatar
Kenichi Handa committed
1043 1044 1045

      GPT += gap_head_used, GPT_BYTE += gap_head_used;
      GAP_SIZE = 0; ZV += add; Z += add; ZV_BYTE += add; Z_BYTE += add;
Kenichi Handa's avatar
Kenichi Handa committed
1046 1047
      make_gap (bytes);
      GAP_SIZE += add; ZV -= add; Z -= add; ZV_BYTE -= add; Z_BYTE -= add;
Kenichi Handa's avatar
Kenichi Handa committed