coding.h 22.3 KB
Newer Older
Karl Heuer's avatar
Karl Heuer committed
1
/* Header for coding system handler.
2
   Copyright (C) 1995, 1997 Electrotechnical Laboratory, JAPAN.
Kenichi Handa's avatar
Kenichi Handa committed
3 4
     Licensed to the Free Software Foundation.
   Copyright (C) 2003
Kenichi Handa's avatar
Kenichi Handa committed
5 6
     National Institute of Advanced Industrial Science and Technology (AIST)
     Registration Number H13PRO009
Karl Heuer's avatar
Karl Heuer committed
7

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

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

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

Karl Heuer's avatar
Karl Heuer committed
20 21 22 23
You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Karl Heuer's avatar
Karl Heuer committed
24

25 26
#ifndef EMACS_CODING_H
#define EMACS_CODING_H
Karl Heuer's avatar
Karl Heuer committed
27

Kenichi Handa's avatar
Kenichi Handa committed
28
/* Index to arguments of Fdefine_coding_system_internal.  */
Karl Heuer's avatar
Karl Heuer committed
29

Kenichi Handa's avatar
Kenichi Handa committed
30 31 32 33 34 35 36 37 38 39 40 41
enum define_coding_system_arg_index
  {
    coding_arg_name,
    coding_arg_mnemonic,
    coding_arg_coding_type,
    coding_arg_charset_list,
    coding_arg_ascii_compatible_p,
    coding_arg_decode_translation_table,
    coding_arg_encode_translation_table,
    coding_arg_post_read_conversion,
    coding_arg_pre_write_conversion,
    coding_arg_default_char,
Kenichi Handa's avatar
Kenichi Handa committed
42
    coding_arg_for_unibyte,
Kenichi Handa's avatar
Kenichi Handa committed
43 44 45 46
    coding_arg_plist,
    coding_arg_eol_type,
    coding_arg_max
  };
Karl Heuer's avatar
Karl Heuer committed
47

Kenichi Handa's avatar
Kenichi Handa committed
48
enum define_coding_iso2022_arg_index
Karl Heuer's avatar
Karl Heuer committed
49
  {
Kenichi Handa's avatar
Kenichi Handa committed
50 51 52 53 54
    coding_arg_iso2022_initial = coding_arg_max,
    coding_arg_iso2022_reg_usage,
    coding_arg_iso2022_request,
    coding_arg_iso2022_flags,
    coding_arg_iso2022_max
Karl Heuer's avatar
Karl Heuer committed
55 56
  };

Kenichi Handa's avatar
Kenichi Handa committed
57
enum define_coding_utf16_arg_index
Karl Heuer's avatar
Karl Heuer committed
58
  {
Kenichi Handa's avatar
Kenichi Handa committed
59 60 61
    coding_arg_utf16_bom = coding_arg_max,
    coding_arg_utf16_endian,
    coding_arg_utf16_max
Karl Heuer's avatar
Karl Heuer committed
62 63
  };

Kenichi Handa's avatar
Kenichi Handa committed
64 65
enum define_coding_ccl_arg_index
  {
66
    coding_arg_ccl_decoder = coding_arg_max,
Kenichi Handa's avatar
Kenichi Handa committed
67 68 69 70
    coding_arg_ccl_encoder,
    coding_arg_ccl_valids,
    coding_arg_ccl_max
  };
Karl Heuer's avatar
Karl Heuer committed
71

Kenichi Handa's avatar
Kenichi Handa committed
72
extern Lisp_Object Vcoding_system_hash_table;
Karl Heuer's avatar
Karl Heuer committed
73

Kenichi Handa's avatar
Kenichi Handa committed
74
/* Enumeration of coding system type.  */
Karl Heuer's avatar
Karl Heuer committed
75

Kenichi Handa's avatar
Kenichi Handa committed
76 77 78 79 80 81 82 83 84 85 86 87 88
enum coding_system_type
  {
    coding_type_charset,
    coding_type_utf_8,
    coding_type_utf_16,
    coding_type_iso_2022,
    coding_type_emacs_mule,
    coding_type_sjis,
    coding_type_ccl,
    coding_type_raw_text,
    coding_type_undecided,
    coding_type_max
  };
Karl Heuer's avatar
Karl Heuer committed
89 90


Kenichi Handa's avatar
Kenichi Handa committed
91
/* Enumeration of end-of-line format type.  */
Karl Heuer's avatar
Karl Heuer committed
92

Kenichi Handa's avatar
Kenichi Handa committed
93 94 95 96 97 98 99 100 101 102 103 104 105
enum end_of_line_type
  {
    eol_lf,		/* Line-feed only, same as Emacs' internal
			   format.  */
    eol_crlf,		/* Sequence of carriage-return and
			   line-feed.  */
    eol_cr,		/* Carriage-return only.  */
    eol_any,		/* Accept any of above.  Produce line-feed
			   only.  */
    eol_undecided,	/* This value is used to denote that the
			   eol-type is not yet undecided.  */
    eol_type_max
  };
Karl Heuer's avatar
Karl Heuer committed
106

Kenichi Handa's avatar
Kenichi Handa committed
107
/* Enumeration of index to an attribute vector of a coding system.  */
Karl Heuer's avatar
Karl Heuer committed
108

Kenichi Handa's avatar
Kenichi Handa committed
109 110 111 112 113 114 115 116 117 118 119 120 121
enum coding_attr_index
  {
    coding_attr_base_name,
    coding_attr_docstring,
    coding_attr_mnemonic,
    coding_attr_type,
    coding_attr_charset_list,
    coding_attr_ascii_compat,
    coding_attr_decode_tbl,
    coding_attr_encode_tbl,
    coding_attr_post_read,
    coding_attr_pre_write,
    coding_attr_default_char,
Kenichi Handa's avatar
Kenichi Handa committed
122
    coding_attr_for_unibyte,
Kenichi Handa's avatar
Kenichi Handa committed
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
    coding_attr_plist,

    coding_attr_category,
    coding_attr_safe_charsets,

    /* The followings are extra attributes for each type.  */
    coding_attr_charset_valids,

    coding_attr_ccl_decoder,
    coding_attr_ccl_encoder,
    coding_attr_ccl_valids,

    coding_attr_iso_initial,
    coding_attr_iso_usage,
    coding_attr_iso_request,
    coding_attr_iso_flags,

    coding_attr_utf_16_bom,
    coding_attr_utf_16_endian,

    coding_attr_emacs_mule_full,

    coding_attr_last_index
  };
Karl Heuer's avatar
Karl Heuer committed
147 148


Kenichi Handa's avatar
Kenichi Handa committed
149 150 151 152 153 154 155 156 157 158 159
#define CODING_ATTR_BASE_NAME(attrs)	AREF (attrs, coding_attr_base_name)
#define CODING_ATTR_TYPE(attrs)		AREF (attrs, coding_attr_type)
#define CODING_ATTR_CHARSET_LIST(attrs)	AREF (attrs, coding_attr_charset_list)
#define CODING_ATTR_MNEMONIC(attrs)	AREF (attrs, coding_attr_mnemonic)
#define CODING_ATTR_DOCSTRING(attrs)	AREF (attrs, coding_attr_docstring)
#define CODING_ATTR_ASCII_COMPAT(attrs)	AREF (attrs, coding_attr_ascii_compat)
#define CODING_ATTR_DECODE_TBL(attrs)	AREF (attrs, coding_attr_decode_tbl)
#define CODING_ATTR_ENCODE_TBL(attrs)	AREF (attrs, coding_attr_encode_tbl)
#define CODING_ATTR_POST_READ(attrs)	AREF (attrs, coding_attr_post_read)
#define CODING_ATTR_PRE_WRITE(attrs)	AREF (attrs, coding_attr_pre_write)
#define CODING_ATTR_DEFAULT_CHAR(attrs)	AREF (attrs, coding_attr_default_char)
Kenichi Handa's avatar
Kenichi Handa committed
160
#define CODING_ATTR_FOR_UNIBYTE(attrs)	AREF (attrs, coding_attr_for_unibyte)
Kenichi Handa's avatar
Kenichi Handa committed
161 162 163 164
#define CODING_ATTR_FLUSHING(attrs)	AREF (attrs, coding_attr_flushing)
#define CODING_ATTR_PLIST(attrs)	AREF (attrs, coding_attr_plist)
#define CODING_ATTR_CATEGORY(attrs)	AREF (attrs, coding_attr_category)
#define CODING_ATTR_SAFE_CHARSETS(attrs)AREF (attrs, coding_attr_safe_charsets)
165 166


Kenichi Handa's avatar
Kenichi Handa committed
167 168
#define CODING_ID_ATTRS(id)	\
  (AREF (HASH_VALUE (XHASH_TABLE (Vcoding_system_hash_table), id), 0))
169

Kenichi Handa's avatar
Kenichi Handa committed
170 171
#define CODING_ID_ALIASES(id)	\
  (AREF (HASH_VALUE (XHASH_TABLE (Vcoding_system_hash_table), id), 1))
172

Kenichi Handa's avatar
Kenichi Handa committed
173 174
#define CODING_ID_EOL_TYPE(id)	\
  (AREF (HASH_VALUE (XHASH_TABLE (Vcoding_system_hash_table), id), 2))
175

Kenichi Handa's avatar
Kenichi Handa committed
176 177
#define CODING_ID_NAME(id) \
  (HASH_KEY (XHASH_TABLE (Vcoding_system_hash_table), id))
178

Kenichi Handa's avatar
Kenichi Handa committed
179 180
#define CODING_SYSTEM_SPEC(coding_system_symbol)	\
  (Fgethash (coding_system_symbol, Vcoding_system_hash_table, Qnil))
Karl Heuer's avatar
Karl Heuer committed
181

Kenichi Handa's avatar
Kenichi Handa committed
182 183 184
#define CODING_SYSTEM_ID(coding_system_symbol)			\
  hash_lookup (XHASH_TABLE (Vcoding_system_hash_table),		\
	       coding_system_symbol, NULL)
Karl Heuer's avatar
Karl Heuer committed
185

Kenichi Handa's avatar
Kenichi Handa committed
186 187
#define CODING_SYSTEM_P(coding_system_symbol)	\
  (! NILP (CODING_SYSTEM_SPEC (coding_system_symbol)))
Karl Heuer's avatar
Karl Heuer committed
188

Kenichi Handa's avatar
Kenichi Handa committed
189
#define CHECK_CODING_SYSTEM(x)				\
Kenichi Handa's avatar
Kenichi Handa committed
190 191
  do {							\
    if (!CODING_SYSTEM_P (x))				\
Kenichi Handa's avatar
Kenichi Handa committed
192
      wrong_type_argument (Qcoding_system_p, (x));	\
Kenichi Handa's avatar
Kenichi Handa committed
193
  } while (0)
194

Karl Heuer's avatar
Karl Heuer committed
195

Kenichi Handa's avatar
Kenichi Handa committed
196 197 198 199 200 201
#define CHECK_CODING_SYSTEM_GET_SPEC(x, spec)		\
  do {							\
    spec = CODING_SYSTEM_SPEC (x);			\
    if (NILP (spec))					\
      x = wrong_type_argument (Qcoding_system_p, (x));	\
  } while (0)
202

203

Kenichi Handa's avatar
Kenichi Handa committed
204 205 206 207 208 209 210
#define CHECK_CODING_SYSTEM_GET_ID(x, id)			\
  do								\
    {								\
      id = CODING_SYSTEM_ID (x);				\
      if (id < 0)						\
	x = wrong_type_argument (Qcoding_system_p, (x));	\
    } while (0)
Karl Heuer's avatar
Karl Heuer committed
211 212 213 214


/*** GENERAL section ***/

Kenichi Handa's avatar
Kenichi Handa committed
215 216
/* Enumeration of result code of code conversion.  */
enum coding_result_code
Karl Heuer's avatar
Karl Heuer committed
217
  {
Kenichi Handa's avatar
Kenichi Handa committed
218 219 220 221
    CODING_RESULT_SUCCESS,
    CODING_RESULT_INSUFFICIENT_SRC,
    CODING_RESULT_INSUFFICIENT_DST,
    CODING_RESULT_INCONSISTENT_EOL,
222
    CODING_RESULT_INVALID_SRC,
Kenichi Handa's avatar
Kenichi Handa committed
223 224
    CODING_RESULT_INTERRUPT,
    CODING_RESULT_INSUFFICIENT_MEM
Karl Heuer's avatar
Karl Heuer committed
225 226
  };

227

Kenichi Handa's avatar
Kenichi Handa committed
228
/* Macros used for the member `mode' of the struct coding_system.  */
229 230 231 232 233 234

/* If set, recover the original CR or LF of the already decoded text
   when the decoding routine encounters an inconsistent eol format.  */
#define CODING_MODE_INHIBIT_INCONSISTENT_EOL	0x01

/* If set, the decoding/encoding routines treat the current data as
Dave Love's avatar
Dave Love committed
235
   the last block of the whole text to be converted, and do the
Dave Love's avatar
Dave Love committed
236
   appropriate finishing job.  */
237 238 239 240 241 242 243 244 245 246
#define CODING_MODE_LAST_BLOCK			0x02

/* If set, it means that the current source text is in a buffer which
   enables selective display.  */
#define CODING_MODE_SELECTIVE_DISPLAY		0x04

/* This flag is used by the decoding/encoding routines on the fly.  If
   set, it means that right-to-left text is being processed.  */
#define CODING_MODE_DIRECTION			0x08

Kenichi Handa's avatar
Kenichi Handa committed
247 248 249 250 251 252 253
#define CODING_MODE_FIXED_DESTINATION		0x10

#define CODING_MODE_SAFE_ENCODING		0x20

/* Structure of the field `spec.iso_2022' in the structure
   `coding_system'.  */
struct iso_2022_spec
Karl Heuer's avatar
Karl Heuer committed
254
{
Kenichi Handa's avatar
Kenichi Handa committed
255
  /* Bit-wise-or of CODING_ISO_FLAG_XXX.  */
Kenichi Handa's avatar
Kenichi Handa committed
256
  unsigned flags;
Karl Heuer's avatar
Karl Heuer committed
257

Kenichi Handa's avatar
Kenichi Handa committed
258 259
  /* The current graphic register invoked to each graphic plane.  */
  int current_invocation[2];
260

Kenichi Handa's avatar
Kenichi Handa committed
261 262 263 264
  /* The current charset designated to each graphic register.  The
     value -1 means that not charset is designated, -2 means that
     there was an invalid designation previously.  */
  int current_designation[4];
Karl Heuer's avatar
Karl Heuer committed
265

Kenichi Handa's avatar
Kenichi Handa committed
266 267 268
  /* Set to 1 temporarily only when graphic register 2 or 3 is invoked
     by single-shift while encoding.  */
  int single_shifting;
Karl Heuer's avatar
Karl Heuer committed
269

Kenichi Handa's avatar
Kenichi Handa committed
270 271 272
  /* Set to 1 temporarily only when processing at beginning of line.  */
  int bol;
};
Karl Heuer's avatar
Karl Heuer committed
273

Kenichi Handa's avatar
Kenichi Handa committed
274
struct ccl_spec;
Karl Heuer's avatar
Karl Heuer committed
275

Kenichi Handa's avatar
Kenichi Handa committed
276 277 278 279 280 281
enum utf_16_bom_type
  {
    utf_16_detect_bom,
    utf_16_without_bom,
    utf_16_with_bom
  };
282

Kenichi Handa's avatar
Kenichi Handa committed
283 284 285 286 287
enum utf_16_endian_type
  {
    utf_16_big_endian,
    utf_16_little_endian
  };
288

Kenichi Handa's avatar
Kenichi Handa committed
289 290 291 292 293 294
struct utf_16_spec
{
  enum utf_16_bom_type bom;
  enum utf_16_endian_type endian;
  int surrogate;
};
295

296 297 298 299 300 301 302 303 304 305
struct coding_detection_info
{
  /* Values of these members are bitwise-OR of CATEGORY_MASK_XXXs.  */
  /* Which categories are already checked.  */
  int checked;
  /* Which categories are strongly found.  */
  int found;
  /* Which categories are rejected.  */
  int rejected;
};
306 307


Kenichi Handa's avatar
Kenichi Handa committed
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
struct coding_system
{
  /* ID number of the coding system.  This is an index to
     Vcoding_system_hash_table.  This value is set by
     setup_coding_system.  At the early stage of building time, this
     value is -1 in the array coding_categories to indicate that no
     coding-system of that category is yet defined.  */
  int id;

  /* Flag bits of the coding system.  The meaning of each bit is common
     to all types of coding systems.  */
  int common_flags;

  /* Mode bits of the coding system.  See the comments of the macros
     CODING_MODE_XXX.  */
  unsigned int mode;
324

Karl Heuer's avatar
Karl Heuer committed
325
  /* Detailed information specific to each type of coding system.  */
Kenichi Handa's avatar
Kenichi Handa committed
326
  union
Karl Heuer's avatar
Karl Heuer committed
327
    {
Kenichi Handa's avatar
Kenichi Handa committed
328 329 330 331
      struct iso_2022_spec iso_2022;
      struct ccl_spec *ccl;	/* Defined in ccl.h.  */
      struct utf_16_spec utf_16;
      int emacs_mule_full_support;
Karl Heuer's avatar
Karl Heuer committed
332 333
    } spec;

Kenichi Handa's avatar
Kenichi Handa committed
334 335
  int max_charset_id;
  char *safe_charsets;
336

Kenichi Handa's avatar
Kenichi Handa committed
337 338 339 340
  /* The following two members specify how binary 8-bit code 128..255
     are represented in source and destination text respectively.  1
     means they are represented by 2-byte sequence, 0 means they are
     represented by 1-byte as is (see the comment in character.h).  */
341 342 343
  unsigned src_multibyte : 1;
  unsigned dst_multibyte : 1;

344 345 346 347
  /* How may heading bytes we can skip for decoding.  This is set to
     -1 in setup_coding_system, and updated by detect_coding.  So,
     when this is equal to the byte length of the text being
     converted, we can skip the actual conversion process.  */
Kenichi Handa's avatar
Kenichi Handa committed
348
  int head_ascii;
349 350

  /* The following members are set by encoding/decoding routine.  */
Kenichi Handa's avatar
Kenichi Handa committed
351
  EMACS_INT produced, produced_char, consumed, consumed_char;
352

353 354 355
  /* Number of error source data found in a decoding routine.  */
  int errors;

Kenichi Handa's avatar
Kenichi Handa committed
356 357
  /* Store the positions of error source data. */
  EMACS_INT *error_positions;
358

Kenichi Handa's avatar
Kenichi Handa committed
359 360
  /* Finish status of code conversion.  */
  enum coding_result_code result;
361

362 363 364 365 366
  /* The following members are all Lisp symbols.  We don't have to
     protect them from GC because the current garbage collection
     doesn't relocate Lisp symbols.  But, when it is changed, we must
     find a way to protect them.  */

Kenichi Handa's avatar
Kenichi Handa committed
367 368
  EMACS_INT src_pos, src_pos_byte, src_chars, src_bytes;
  Lisp_Object src_object;
Kenichi Handa's avatar
Kenichi Handa committed
369
  const unsigned char *source;
Karl Heuer's avatar
Karl Heuer committed
370

Kenichi Handa's avatar
Kenichi Handa committed
371 372 373
  EMACS_INT dst_pos, dst_pos_byte, dst_bytes;
  Lisp_Object dst_object;
  unsigned char *destination;
Karl Heuer's avatar
Karl Heuer committed
374

Kenichi Handa's avatar
Kenichi Handa committed
375
  int chars_at_source;
Karl Heuer's avatar
Karl Heuer committed
376

Kenichi Handa's avatar
Kenichi Handa committed
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
  /* If an element is non-negative, it is a character code.

     If it is in the range -128..-1, it is a 8-bit character code
     minus 256.

     If it is less than -128, it specifies the start of an annotation
     chunk.  The length of the chunk is -128 minus the value of the
     element.  The following elements are OFFSET, ANNOTATION-TYPE, and
     a sequence of actual data for the annotation.  OFFSET is a
     character position offset from dst_pos or src_pos,
     ANNOTATION-TYPE specfies the meaning of the annotation and how to
     handle the following data..  */
  int *charbuf;
  int charbuf_size, charbuf_used;

  /* Set to 1 if charbuf contains an annotation.  */
  int annotated;
Karl Heuer's avatar
Karl Heuer committed
394

Kenichi Handa's avatar
Kenichi Handa committed
395 396
  unsigned char carryover[64];
  int carryover_bytes;
397

Kenichi Handa's avatar
Kenichi Handa committed
398 399
  int default_char;

400 401
  int (*detector) P_ ((struct coding_system *,
		       struct coding_detection_info *));
Kenichi Handa's avatar
Kenichi Handa committed
402 403 404 405 406 407 408 409 410 411
  void (*decoder) P_ ((struct coding_system *));
  int (*encoder) P_ ((struct coding_system *));
};

/* Meanings of bits in the member `common_flags' of the structure
   coding_system.  The lowest 8 bits are reserved for various kind of
   annotations (currently two of them are used).  */
#define CODING_ANNOTATION_MASK			0x00FF
#define CODING_ANNOTATE_COMPOSITION_MASK	0x0001
#define CODING_ANNOTATE_DIRECTION_MASK		0x0002
412
#define CODING_ANNOTATE_CHARSET_MASK		0x0003
Kenichi Handa's avatar
Kenichi Handa committed
413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
#define CODING_FOR_UNIBYTE_MASK			0x0100
#define CODING_REQUIRE_FLUSHING_MASK		0x0200
#define CODING_REQUIRE_DECODING_MASK		0x0400
#define CODING_REQUIRE_ENCODING_MASK		0x0800
#define CODING_REQUIRE_DETECTION_MASK		0x1000
#define CODING_RESET_AT_BOL_MASK		0x2000

/* Return 1 if the coding context CODING requires annotaion
   handling.  */
#define CODING_REQUIRE_ANNOTATION(coding) \
  ((coding)->common_flags & CODING_ANNOTATION_MASK)

/* Return 1 if the coding context CODING prefers decoding into unibyte.  */
#define CODING_FOR_UNIBYTE(coding) \
  ((coding)->common_flags & CODING_FOR_UNIBYTE_MASK)

/* Return 1 if the coding context CODING requires specific code to be
430 431 432 433
   attached at the tail of converted text.  */
#define CODING_REQUIRE_FLUSHING(coding) \
  ((coding)->common_flags & CODING_REQUIRE_FLUSHING_MASK)

Kenichi Handa's avatar
Kenichi Handa committed
434
/* Return 1 if the coding context CODING requires code conversion on
435 436
   decoding.  */
#define CODING_REQUIRE_DECODING(coding)	\
437 438
  ((coding)->dst_multibyte		\
   || (coding)->common_flags & CODING_REQUIRE_DECODING_MASK)
439

Kenichi Handa's avatar
Kenichi Handa committed
440 441

/* Return 1 if the coding context CODING requires code conversion on
442
   encoding.  */
Kenichi Handa's avatar
Kenichi Handa committed
443 444 445 446 447
#define CODING_REQUIRE_ENCODING(coding)				\
  ((coding)->src_multibyte					\
   || (coding)->common_flags & CODING_REQUIRE_ENCODING_MASK	\
   || (coding)->mode & CODING_MODE_SELECTIVE_DISPLAY)

448

Kenichi Handa's avatar
Kenichi Handa committed
449
/* Return 1 if the coding context CODING requires some kind of code
450 451 452 453
   detection.  */
#define CODING_REQUIRE_DETECTION(coding) \
  ((coding)->common_flags & CODING_REQUIRE_DETECTION_MASK)

Kenichi Handa's avatar
Kenichi Handa committed
454
/* Return 1 if the coding context CODING requires code conversion on
455
   decoding or some kind of code detection.  */
456
#define CODING_MAY_REQUIRE_DECODING(coding)	\
457 458
  (CODING_REQUIRE_DECODING (coding)		\
   || CODING_REQUIRE_DETECTION (coding))
Karl Heuer's avatar
Karl Heuer committed
459 460 461 462 463 464

/* Macros to decode or encode a character of JISX0208 in SJIS.  S1 and
   S2 are the 1st and 2nd position-codes of JISX0208 in SJIS coding
   system.  C1 and C2 are the 1st and 2nd position codes of Emacs'
   internal format.  */

Kenichi Handa's avatar
Kenichi Handa committed
465 466 467 468 469 470 471 472 473 474 475 476 477
#define SJIS_TO_JIS(code)				\
  do {							\
    int s1, s2, j1, j2;					\
							\
    s1 = (code) >> 8, s2 = (code) & 0xFF;		\
							\
    if (s2 >= 0x9F)					\
      (j1 = s1 * 2 - (s1 >= 0xE0 ? 0x160 : 0xE0),	\
       j2 = s2 - 0x7E);					\
    else						\
      (j1 = s1 * 2 - ((s1 >= 0xE0) ? 0x161 : 0xE1),	\
       j2 = s2 - ((s2 >= 0x7F) ? 0x20 : 0x1F));		\
    (code) = (j1 << 8) | j2;				\
Karl Heuer's avatar
Karl Heuer committed
478 479
  } while (0)

Kenichi Handa's avatar
Kenichi Handa committed
480 481

#define JIS_TO_SJIS(code)				\
Karl Heuer's avatar
Karl Heuer committed
482
  do {							\
Kenichi Handa's avatar
Kenichi Handa committed
483 484 485 486 487 488
    int s1, s2, j1, j2;					\
							\
    j1 = (code) >> 8, j2 = (code) & 0xFF;		\
    if (j1 & 1)						\
      (s1 = j1 / 2 + ((j1 < 0x5F) ? 0x71 : 0xB1),	\
       s2 = j2 + ((j2 >= 0x60) ? 0x20 : 0x1F));		\
Karl Heuer's avatar
Karl Heuer committed
489
    else						\
Kenichi Handa's avatar
Kenichi Handa committed
490 491
      (s1 = j1 / 2 + ((j1 < 0x5F) ? 0x70 : 0xB0),	\
       s2 = j2 + 0x7E);					\
492
    (code) = (s1 << 8) | s2;				\
Karl Heuer's avatar
Karl Heuer committed
493 494
  } while (0)

Kenichi Handa's avatar
Kenichi Handa committed
495

496 497 498 499 500
/* Encode the file name NAME using the specified coding system
   for file names, if any.  */
#define ENCODE_FILE(name)						   \
  (! NILP (Vfile_name_coding_system)					   \
   && XFASTINT (Vfile_name_coding_system) != 0				   \
Karl Heuer's avatar
Karl Heuer committed
501
   ? code_convert_string_norecord (name, Vfile_name_coding_system, 1)	   \
502
   : (! NILP (Vdefault_file_name_coding_system)				   \
Karl Heuer's avatar
Karl Heuer committed
503 504
      && XFASTINT (Vdefault_file_name_coding_system) != 0		   \
      ? code_convert_string_norecord (name, Vdefault_file_name_coding_system, 1) \
505 506
      : name))

Kenichi Handa's avatar
Kenichi Handa committed
507

508 509 510 511 512
/* Decode the file name NAME using the specified coding system
   for file names, if any.  */
#define DECODE_FILE(name)						   \
  (! NILP (Vfile_name_coding_system)					   \
   && XFASTINT (Vfile_name_coding_system) != 0				   \
Karl Heuer's avatar
Karl Heuer committed
513
   ? code_convert_string_norecord (name, Vfile_name_coding_system, 0)	   \
514
   : (! NILP (Vdefault_file_name_coding_system)				   \
Karl Heuer's avatar
Karl Heuer committed
515 516
      && XFASTINT (Vdefault_file_name_coding_system) != 0		   \
      ? code_convert_string_norecord (name, Vdefault_file_name_coding_system, 0) \
517 518
      : name))

Kenichi Handa's avatar
Kenichi Handa committed
519

520 521 522
#ifdef WINDOWSNT
/* Encode the string STR using the specified coding system
   for w32 system functions, if any.  */
Kenichi Handa's avatar
Kenichi Handa committed
523 524 525 526
#define ENCODE_SYSTEM(str)						\
  (! NILP (Vlocale_coding_system)					\
   && XFASTINT (Vlocale_coding_system) != 0				\
   ? code_convert_string_norecord (str, Vlocale_coding_system, 1)	\
527 528 529 530
   : str)

/* Decode the string STR using the specified coding system
   for w32 system functions, if any.  */
Kenichi Handa's avatar
Kenichi Handa committed
531 532 533 534
#define DECODE_SYSTEM(name)						\
  (! NILP (Vlocale_coding_system)					\
   && XFASTINT (Vlocale_coding_system) != 0				\
   ? code_convert_string_norecord (str, Vlocale_coding_system, 0)	\
535
   : str)
536 537 538 539 540 541 542

#else /* WINDOWSNT */

#define ENCODE_SYSTEM(str) string_make_unibyte(str)
#define DECODE_SYSTEM(name) name

#endif /* !WINDOWSNT */
543

Dave Love's avatar
Dave Love committed
544 545 546 547
/* Used by the gtk menu code.  Note that this encodes utf-8, not
   utf-8-emacs, so it's not a no-op.  */
#define ENCODE_UTF_8(str) code_convert_string_norecord (str, Qutf_8, 1)

Karl Heuer's avatar
Karl Heuer committed
548
/* Extern declarations.  */
549
extern Lisp_Object code_conversion_save P_ ((int, int));
550 551
extern int decoding_buffer_size P_ ((struct coding_system *, int));
extern int encoding_buffer_size P_ ((struct coding_system *, int));
Kenichi Handa's avatar
Kenichi Handa committed
552 553
extern void setup_coding_system P_ ((Lisp_Object, struct coding_system *));
extern void detect_coding P_ ((struct coding_system *));
554
extern Lisp_Object code_convert_region P_ ((Lisp_Object, Lisp_Object,
Kenichi Handa's avatar
Kenichi Handa committed
555 556 557 558
					    Lisp_Object, Lisp_Object,
					    int, int));
extern Lisp_Object code_convert_string P_ ((Lisp_Object, Lisp_Object,
					    Lisp_Object, int, int, int));
559 560
extern Lisp_Object code_convert_string_norecord P_ ((Lisp_Object, Lisp_Object,
						     int));
Kenichi Handa's avatar
Kenichi Handa committed
561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608
extern Lisp_Object raw_text_coding_system P_ ((Lisp_Object));
extern Lisp_Object coding_inherit_eol_type P_ ((Lisp_Object, Lisp_Object));

extern int decode_coding_gap P_ ((struct coding_system *,
				  EMACS_INT, EMACS_INT));
extern int encode_coding_gap P_ ((struct coding_system *,
				  EMACS_INT, EMACS_INT));
extern void decode_coding_object P_ ((struct coding_system *,
				      Lisp_Object, EMACS_INT, EMACS_INT,
				      EMACS_INT, EMACS_INT, Lisp_Object));
extern void encode_coding_object P_ ((struct coding_system *,
				      Lisp_Object, EMACS_INT, EMACS_INT,
				      EMACS_INT, EMACS_INT, Lisp_Object));

#define decode_coding_region(coding, from, to)		\
  decode_coding_object (coding, Fcurrent_buffer (),	\
			from, CHAR_TO_BYTE (from),	\
			to, CHAR_TO_BYTE (to), Fcurrent_buffer ())


#define encode_coding_region(coding, from, to)		\
  encode_coding_object (coding, Fcurrent_buffer (),	\
			from, CHAR_TO_BYTE (from),	\
			to, CHAR_TO_BYTE (to), Fcurrent_buffer ())


#define decode_coding_string(coding, string, nocopy)			\
  decode_coding_object (coding, string, 0, 0, XSTRING (string)->size,	\
			STRING_BYTES (XSTRING (string)), Qt)

#define encode_coding_string(coding, string, nocopy)			\
  (encode_coding_object (coding, string, 0, 0, XSTRING (string)->size,	\
			 STRING_BYTES (XSTRING (string)), Qt),		\
   (coding)->dst_object)


#define decode_coding_c_string(coding, src, bytes, dst_object)		\
  do {									\
    (coding)->source = (src);						\
    (coding)->src_chars = (coding)->src_bytes = (bytes);		\
    decode_coding_object ((coding), Qnil, 0, 0, (bytes), (bytes),	\
			  (dst_object));				\
  } while (0)


extern Lisp_Object preferred_coding_system P_ (());


Kenichi Handa's avatar
Kenichi Handa committed
609 610
extern Lisp_Object Qutf_8, Qutf_8_emacs;

Karl Heuer's avatar
Karl Heuer committed
611
extern Lisp_Object Qcoding_system, Qeol_type, Qcoding_category_index;
Kenichi Handa's avatar
Kenichi Handa committed
612 613 614
extern Lisp_Object Qcoding_system_p;
extern Lisp_Object Qraw_text, Qemacs_mule, Qno_conversion, Qundecided;
extern Lisp_Object Qiso_2022;
Karl Heuer's avatar
Karl Heuer committed
615
extern Lisp_Object Qbuffer_file_coding_system;
Kenichi Handa's avatar
Kenichi Handa committed
616 617

extern Lisp_Object Qunix, Qdos, Qmac;
Karl Heuer's avatar
Karl Heuer committed
618

619 620
extern Lisp_Object Qtranslation_table;
extern Lisp_Object Qtranslation_table_id;
621

622 623 624 625
/* Mnemonic strings to indicate each type of end-of-line.  */
extern Lisp_Object eol_mnemonic_unix, eol_mnemonic_dos, eol_mnemonic_mac;
/* Mnemonic string to indicate type of end-of-line is not yet decided.  */
extern Lisp_Object eol_mnemonic_undecided;
Karl Heuer's avatar
Karl Heuer committed
626 627 628 629 630

#ifdef emacs
extern Lisp_Object Qfile_coding_system;
extern Lisp_Object Qcall_process, Qcall_process_region, Qprocess_argument;
extern Lisp_Object Qstart_process, Qopen_network_stream;
631
extern Lisp_Object Qwrite_region;
Karl Heuer's avatar
Karl Heuer committed
632

633 634
extern char *emacs_strerror P_ ((int));

Karl Heuer's avatar
Karl Heuer committed
635 636 637 638 639 640
/* Coding-system for reading files and receiving data from process.  */
extern Lisp_Object Vcoding_system_for_read;
/* Coding-system for writing files and sending data to process.  */
extern Lisp_Object Vcoding_system_for_write;
/* Coding-system actually used in the latest I/O.  */
extern Lisp_Object Vlast_coding_system_used;
641 642
/* Coding-system to use with system messages (e.g. strerror).  */
extern Lisp_Object Vlocale_coding_system;
Karl Heuer's avatar
Karl Heuer committed
643

644 645 646 647
/* If non-zero, process buffer inherits the coding system used to decode
   the subprocess output.  */
extern int inherit_process_coding_system;

Karl Heuer's avatar
Karl Heuer committed
648 649 650 651 652
/* Coding-system to be used for encoding terminal output.  This
   structure contains information of a coding-system specified by the
   function `set-terminal-coding-system'.  */
extern struct coding_system terminal_coding;

653 654 655 656
/* Coding system to be used to encode text for terminal display when
   terminal coding system is nil.  */
extern struct coding_system safe_terminal_coding;

Karl Heuer's avatar
Karl Heuer committed
657 658 659 660 661
/* Coding-system of what is sent from terminal keyboard.  This
   structure contains information of a coding-system specified by the
   function `set-keyboard-coding-system'.  */
extern struct coding_system keyboard_coding;

662 663
/* Default coding systems used for process I/O.  */
extern Lisp_Object Vdefault_process_coding_system;
Karl Heuer's avatar
Karl Heuer committed
664

Kenichi Handa's avatar
Kenichi Handa committed
665
/* Function to call to force a user to force select a propert coding
666 667 668
   system.  */
extern Lisp_Object Vselect_safe_coding_system_function;

669 670 671 672
/* If nonzero, on writing a file, Vselect_safe_coding_system_function
   is called even if Vcoding_system_for_write is non-nil.  */
extern int coding_system_require_warning;

673 674 675 676 677 678
/* Coding system for file names, or nil if none.  */
extern Lisp_Object Vfile_name_coding_system;

/* Coding system for file names used only when
   Vfile_name_coding_system is nil.  */
extern Lisp_Object Vdefault_file_name_coding_system;
679

Karl Heuer's avatar
Karl Heuer committed
680 681
#endif

682 683 684
/* Error signaled when there's a problem with detecting coding system */
extern Lisp_Object Qcoding_system_error;

Kenichi Handa's avatar
Kenichi Handa committed
685 686 687
extern char emacs_mule_bytes[256];
extern int emacs_mule_string_char P_ ((unsigned char *));

688
#endif /* EMACS_CODING_H */