coding.h 28 KB
Newer Older
Karl Heuer's avatar
Karl Heuer committed
1
/* Header for coding system handler.
2
   Copyright (C) 2004  Free Software Foundation, Inc.
3 4
   Copyright (C) 1995, 1997 Electrotechnical Laboratory, JAPAN.
   Licensed to the Free Software Foundation.
Karl Heuer's avatar
Karl Heuer committed
5

Karl Heuer's avatar
Karl Heuer committed
6 7 8 9 10 11
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
12

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

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

23 24
#ifndef EMACS_CODING_H
#define EMACS_CODING_H
Karl Heuer's avatar
Karl Heuer committed
25

26
#include "ccl.h"
Karl Heuer's avatar
Karl Heuer committed
27

Kenichi Handa's avatar
Kenichi Handa committed
28
/*** EMACS' INTERNAL FORMAT (emacs-mule) section ***/
Karl Heuer's avatar
Karl Heuer committed
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73

/* All code (1-byte) of Emacs' internal format is classified into one
   of the followings.  See also `charset.h'.  */
enum emacs_code_class_type
  {
    EMACS_control_code,		/* Control codes in the range
				   0x00..0x1F and 0x7F except for the
				   following two codes.  */
    EMACS_linefeed_code,	/* 0x0A (linefeed) to denote
				   end-of-line.  */
    EMACS_carriage_return_code,	/* 0x0D (carriage-return) to be used
				   in selective display mode.  */
    EMACS_ascii_code,		/* ASCII characters.  */
    EMACS_leading_code_2,	/* Base leading code of official
				   TYPE9N character.  */
    EMACS_leading_code_3,	/* Base leading code of private TYPE9N
				   or official TYPE9Nx9N character.  */
    EMACS_leading_code_4,	/* Base leading code of private
				   TYPE9Nx9N character.  */
    EMACS_invalid_code		/* Invalid code, i.e. a base leading
				   code not yet assigned to any
				   charset, or a code of the range
				   0xA0..0xFF.  */
  };

extern enum emacs_code_class_type emacs_code_class[256];

/*** ISO2022 section ***/

/* Macros to define code of control characters for ISO2022's functions.  */
			/* 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-introduce */

/* All code (1-byte) of ISO2022 is classified into one of the
   followings.  */
enum iso_code_class_type
  {
74 75 76
    ISO_control_0,		/* Control codes in the range
				   0x00..0x1F and 0x7F, except for the
				   following 5 codes.  */
Karl Heuer's avatar
Karl Heuer committed
77 78 79 80 81
    ISO_carriage_return,	/* ISO_CODE_CR (0x0D) */
    ISO_shift_out,		/* ISO_CODE_SO (0x0E) */
    ISO_shift_in,		/* ISO_CODE_SI (0x0F) */
    ISO_single_shift_2_7,	/* ISO_CODE_SS2_7 (0x19) */
    ISO_escape,			/* ISO_CODE_SO (0x1B) */
82 83 84
    ISO_control_1,		/* Control codes in the range
				   0x80..0x9F, except for the
				   following 3 codes.  */
Karl Heuer's avatar
Karl Heuer committed
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
    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.  */
  };

/** The macros CODING_FLAG_ISO_XXX defines a flag bit of the `flags'
  element in the structure `coding_system'.  This information is used
  while encoding a text to ISO2022.  **/

/* If set, produce short-form designation sequence (e.g. ESC $ A)
   instead of long-form sequence (e.g. ESC $ ( A).  */
#define CODING_FLAG_ISO_SHORT_FORM	0x0001

/* If set, reset graphic planes and registers at end-of-line to the
   initial state.  */
#define CODING_FLAG_ISO_RESET_AT_EOL	0x0002

/* If set, reset graphic planes and registers before any control
   characters to the initial state.  */
#define CODING_FLAG_ISO_RESET_AT_CNTL	0x0004

/* If set, encode by 7-bit environment.  */
#define CODING_FLAG_ISO_SEVEN_BITS	0x0008

/* If set, use locking-shift function.  */
#define CODING_FLAG_ISO_LOCKING_SHIFT	0x0010

/* If set, use single-shift function.  Overwrite
   CODING_FLAG_ISO_LOCKING_SHIFT.  */
#define CODING_FLAG_ISO_SINGLE_SHIFT	0x0020

/* If set, designate JISX0201-Roman instead of ASCII.  */
#define CODING_FLAG_ISO_USE_ROMAN	0x0040

/* If set, designate JISX0208-1978 instead of JISX0208-1983.  */
#define CODING_FLAG_ISO_USE_OLDJIS	0x0080

/* If set, do not produce ISO6429's direction specifying sequence.  */
#define CODING_FLAG_ISO_NO_DIRECTION	0x0100

129 130 131 132 133 134 135 136
/* If set, assume designation states are reset at beginning of line on
   output.  */
#define CODING_FLAG_ISO_INIT_AT_BOL	0x0200

/* If set, designation sequence should be placed at beginning of line
   on output.  */
#define CODING_FLAG_ISO_DESIGNATE_AT_BOL 0x0400

Dave Love's avatar
Dave Love committed
137
/* If set, do not encode unsafe characters on output.  */
138 139
#define CODING_FLAG_ISO_SAFE		0x0800

140 141 142 143
/* If set, extra latin codes (128..159) are accepted as a valid code
   on input.  */
#define CODING_FLAG_ISO_LATIN_EXTRA	0x1000

144 145 146
/* If set, use designation escape sequence.  */
#define CODING_FLAG_ISO_DESIGNATION	0x10000

147
/* A character to be produced on output if encoding of the original
148 149 150
   character is inhibitted by CODING_MODE_INHIBIT_UNENCODABLE_CHAR.
   It must be an ASCII character.  */
#define CODING_REPLACEMENT_CHARACTER '?'
151

Karl Heuer's avatar
Karl Heuer committed
152 153 154 155 156 157 158 159 160 161 162 163
/* Structure of the field `spec.iso2022' in the structure `coding_system'.  */
struct iso2022_spec
{
  /* The current graphic register invoked to each graphic plane.  */
  int current_invocation[2];

  /* The current charset designated to each graphic register.  */
  int current_designation[4];

  /* A charset initially designated to each graphic register.  */
  int initial_designation[4];

164 165 166 167
  /* If not -1, it is a graphic register specified in an invalid
     designation sequence.  */
  int last_invalid_designation_register;

Karl Heuer's avatar
Karl Heuer committed
168
  /* A graphic register to which each charset should be designated.  */
169
  unsigned char requested_designation[MAX_CHARSET + 1];
Karl Heuer's avatar
Karl Heuer committed
170

171 172 173 174
  /* A revision number to be specified for each charset on encoding.
     The value 255 means no revision number for the corresponding
     charset.  */
  unsigned char charset_revision_number[MAX_CHARSET + 1];
175

Karl Heuer's avatar
Karl Heuer committed
176 177 178
  /* Set to 1 temporarily only when graphic register 2 or 3 is invoked
     by single-shift while encoding.  */
  int single_shifting;
179 180 181

  /* Set to 1 temporarily only when processing at beginning of line.  */
  int bol;
Karl Heuer's avatar
Karl Heuer committed
182 183 184 185
};

/* Macros to access each field in the structure `spec.iso2022'.  */
#define CODING_SPEC_ISO_INVOCATION(coding, plane) \
186
  (coding)->spec.iso2022.current_invocation[plane]
Karl Heuer's avatar
Karl Heuer committed
187
#define CODING_SPEC_ISO_DESIGNATION(coding, reg) \
188
  (coding)->spec.iso2022.current_designation[reg]
Karl Heuer's avatar
Karl Heuer committed
189
#define CODING_SPEC_ISO_INITIAL_DESIGNATION(coding, reg) \
190
  (coding)->spec.iso2022.initial_designation[reg]
Karl Heuer's avatar
Karl Heuer committed
191
#define CODING_SPEC_ISO_REQUESTED_DESIGNATION(coding, charset) \
192
  (coding)->spec.iso2022.requested_designation[charset]
193
#define CODING_SPEC_ISO_REVISION_NUMBER(coding, charset) \
194
  (coding)->spec.iso2022.charset_revision_number[charset]
Karl Heuer's avatar
Karl Heuer committed
195
#define CODING_SPEC_ISO_SINGLE_SHIFTING(coding) \
196
  (coding)->spec.iso2022.single_shifting
197
#define CODING_SPEC_ISO_BOL(coding) \
198
  (coding)->spec.iso2022.bol
Karl Heuer's avatar
Karl Heuer committed
199

200 201 202 203 204 205
/* A value which may appear in
   coding->spec.iso2022.requested_designation indicating that the
   corresponding charset does not request any graphic register to be
   designated.  */
#define CODING_SPEC_ISO_NO_REQUESTED_DESIGNATION 4

Karl Heuer's avatar
Karl Heuer committed
206 207
/* Return a charset which is currently designated to the graphic plane
   PLANE in the coding-system CODING.  */
208 209 210 211 212
#define CODING_SPEC_ISO_PLANE_CHARSET(coding, plane)	\
  ((CODING_SPEC_ISO_INVOCATION (coding, plane) < 0)	\
   ? -1							\
   : CODING_SPEC_ISO_DESIGNATION (coding,		\
				  CODING_SPEC_ISO_INVOCATION (coding, plane)))
Karl Heuer's avatar
Karl Heuer committed
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231

/*** BIG5 section ***/

/* Macros to denote each type of BIG5 coding system.  */
#define CODING_FLAG_BIG5_HKU	0x00 /* BIG5-HKU is one of variants of
					BIG5 developed by Hong Kong
					University.  */
#define CODING_FLAG_BIG5_ETEN	0x01 /* BIG5_ETen is one of variants
					of BIG5 developed by the
					company ETen in Taiwan.  */

/*** GENERAL section ***/

/* Types of coding system.  */
enum coding_type
  {
    coding_type_no_conversion,	/* A coding system which requires no
				   conversion for reading and writing
				   including end-of-line format.  */
Kenichi Handa's avatar
Kenichi Handa committed
232
    coding_type_emacs_mule,	/* A coding system used in Emacs'
Karl Heuer's avatar
Karl Heuer committed
233 234 235
				   buffer and string.  Requires no
				   conversion for reading and writing
				   except for end-of-line format.  */
Kenichi Handa's avatar
Kenichi Handa committed
236
    coding_type_undecided,	/* A coding system which requires
Karl Heuer's avatar
Karl Heuer committed
237 238 239 240 241 242
				   automatic detection of a real
				   coding system.  */
    coding_type_sjis,		/* SJIS coding system for Japanese.  */
    coding_type_iso2022,	/* Any coding system of ISO2022
				   variants.  */
    coding_type_big5,		/* BIG5 coding system for Chinese.  */
243
    coding_type_ccl,		/* The coding system of which decoder
Karl Heuer's avatar
Karl Heuer committed
244
				   and encoder are written in CCL.  */
245
    coding_type_raw_text	/* A coding system for a text
Dave Love's avatar
Dave Love committed
246
				   containing random 8-bit code which
247 248
				   does not require code conversion
				   except for end-of-line format. */
Karl Heuer's avatar
Karl Heuer committed
249 250 251 252 253 254 255 256
  };

/* Formats of end-of-line.  */
#define CODING_EOL_LF	0	/* Line-feed only, same as Emacs'
				   internal format.  */
#define CODING_EOL_CRLF	1	/* Sequence of carriage-return and
				   line-feed.  */
#define CODING_EOL_CR	2	/* Carriage-return only.  */
Kenichi Handa's avatar
Kenichi Handa committed
257
#define CODING_EOL_UNDECIDED 3	/* This value is used to denote the
Karl Heuer's avatar
Karl Heuer committed
258
				   eol-type is not yet decided.  */
259 260 261
#define CODING_EOL_INCONSISTENT 4 /* This value is used to denote the
				     eol-type is not consistent
				     through the file.  */
Karl Heuer's avatar
Karl Heuer committed
262 263

/* 1 iff composing.  */
264 265 266 267 268 269 270 271 272 273 274 275 276 277 278
#define COMPOSING_P(coding) ((int) coding->composing > (int) COMPOSITION_NO)

#define COMPOSITION_DATA_SIZE 4080
#define COMPOSITION_DATA_MAX_BUNCH_LENGTH (4 + MAX_COMPOSITION_COMPONENTS*2)

/* Data structure to hold information about compositions of text that
   is being decoded or encode.  ISO 2022 base code conversion routines
   handle special ESC sequences for composition specification.  But,
   they can't get/put such information directly from/to a buffer in
   the deepest place.  So, they store or retrieve the information
   through this structure.

   The encoder stores the information in this structure when it meets
   ESC sequences for composition while encoding codes, then, after all
   text codes are encoded, puts `composition' properties on the text
Dave Love's avatar
Dave Love committed
279
   by referring to the structure.
280 281 282

   The decoder at first stores the information of a text to be
   decoded, then, while decoding codes, generates ESC sequences for
Dave Love's avatar
Dave Love committed
283
   composition at proper places by referring to the structure.  */
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300

struct composition_data
{
  /* The character position of the first character to be encoded or
     decoded.  START and END (see below) are relative to this
     position.  */
  int char_offset;

  /* The composition data.  These elements are repeated for each
     composition:
	LENGTH START END METHOD [ COMPONENT ... ]
     where,
        LENGTH is the number of elements for this composition.

	START and END are starting and ending character positions of
	the composition relative to `char_offset'.

Dave Love's avatar
Dave Love committed
301
	METHOD is one of `enum composing_status' specifying the way of
302 303 304 305 306 307 308 309 310 311
	composition.

	COMPONENT is a character or an encoded composition rule.  */
  int data[COMPOSITION_DATA_SIZE];

  /* The number of elements in `data' currently used.  */
  int used;

  /* Pointers to the previous and next structures.  When `data' is
     filled up, another structure is allocated and linked in `next'.
Dave Love's avatar
Dave Love committed
312 313
     The new structure has backward link to this structure in `prev'.
     The number of chained structures depends on how many compositions
314 315 316
     the text being encoded or decoded contains.  */
  struct composition_data *prev, *next;
};
Karl Heuer's avatar
Karl Heuer committed
317

318
/* Macros used for the member `result' of the struct
319 320 321 322 323
   coding_system.  */
#define CODING_FINISH_NORMAL		0
#define CODING_FINISH_INSUFFICIENT_SRC	1
#define CODING_FINISH_INSUFFICIENT_DST	2
#define CODING_FINISH_INCONSISTENT_EOL	3
324 325
#define CODING_FINISH_INSUFFICIENT_CMP	4
#define CODING_FINISH_INTERRUPT		5
326

Kenichi Handa's avatar
Kenichi Handa committed
327
/* Macros used for the member `mode' of the struct coding_system.  */
328 329 330 331 332 333 334

/* 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
   the last block of the whole text to be converted, and do
Dave Love's avatar
Dave Love committed
335
   appropriate finishing job.  */
336 337 338 339 340 341
#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

342 343 344
/* If set, replace unencodabae characters by `?' on encoding.  */
#define CODING_MODE_INHIBIT_UNENCODABLE_CHAR	0x08

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

Karl Heuer's avatar
Karl Heuer committed
349 350 351 352 353
struct coding_system
{
  /* Type of the coding system.  */
  enum coding_type type;

354 355 356
  /* Type of end-of-line format (LF, CRLF, or CR) of the coding system.  */
  int eol_type;

357
  /* Flag bits of the coding system.  The meaning of each bit is common
358
     to all types of coding systems.  */
359
  unsigned int common_flags;
Karl Heuer's avatar
Karl Heuer committed
360 361 362 363 364

  /* Flag bits of the coding system.  The meaning of each bit depends
     on the type of the coding system.  */
  unsigned int flags;

365 366 367
  /* Mode bits of the coding system.  See the comments of the macros
     CODING_MODE_XXX.  */
  unsigned int mode;
Karl Heuer's avatar
Karl Heuer committed
368

369
  /* The current status of composition handling.  */
Karl Heuer's avatar
Karl Heuer committed
370 371
  int composing;

372 373 374 375 376 377 378 379 380 381 382 383 384 385
  /* 1 iff the next character is a composition rule.  */
  int composition_rule_follows;

  /* Information of compositions are stored here on decoding and set
     in advance on encoding.  */
  struct composition_data *cmp_data;

  /* Index to cmp_data->data for the first element for the current
     composition.  */
  int cmp_data_start;

  /* Index to cmp_data->data for the current element for the current
     composition.  */
  int cmp_data_index;
386

Karl Heuer's avatar
Karl Heuer committed
387 388 389 390 391 392 393
  /* Detailed information specific to each type of coding system.  */
  union spec
    {
      struct iso2022_spec iso2022;
      struct ccl_spec ccl;	/* Defined in ccl.h.  */
    } spec;

394 395 396
  /* Index number of coding category of the coding system.  */
  int category_idx;

397 398 399 400
  /* The following two members specify how characters 128..159 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 charset.h).  */
401 402 403
  unsigned src_multibyte : 1;
  unsigned dst_multibyte : 1;

404 405 406 407
  /* 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.  */
408 409 410 411 412
  int heading_ascii;

  /* The following members are set by encoding/decoding routine.  */
  int produced, produced_char, consumed, consumed_char;

413 414 415 416 417 418
  /* Number of error source data found in a decoding routine.  */
  int errors;

  /* Finish status of code conversion.  It should be one of macros
     CODING_FINISH_XXXX.  */
  int result;
419

420 421 422
  /* If nonzero, suppress error notification.  */
  int suppress_error;

423 424 425 426 427
  /* 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.  */

Karl Heuer's avatar
Karl Heuer committed
428 429 430 431
  /* Backward pointer to the Lisp symbol of the coding system.  */
  Lisp_Object symbol;

  /* Lisp function (symbol) to be called after decoding to do
432
     additional conversion, or nil.  */
Karl Heuer's avatar
Karl Heuer committed
433 434 435
  Lisp_Object post_read_conversion;

  /* Lisp function (symbol) to be called before encoding to do
436
     additional conversion, or nil.  */
Karl Heuer's avatar
Karl Heuer committed
437 438
  Lisp_Object pre_write_conversion;

439
  /* Character translation tables to look up, or nil.  */
440 441
  Lisp_Object translation_table_for_decode;
  Lisp_Object translation_table_for_encode;
Karl Heuer's avatar
Karl Heuer committed
442 443
};

444 445 446 447 448 449 450 451 452 453 454 455 456
#define CODING_REQUIRE_FLUSHING_MASK	1
#define CODING_REQUIRE_DECODING_MASK	2
#define CODING_REQUIRE_ENCODING_MASK	4
#define CODING_REQUIRE_DETECTION_MASK	8

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

/* Return 1 if the coding system CODING requires code conversion on
   decoding.  */
#define CODING_REQUIRE_DECODING(coding)	\
457 458
  ((coding)->dst_multibyte		\
   || (coding)->common_flags & CODING_REQUIRE_DECODING_MASK)
459 460 461 462

/* Return 1 if the coding system CODING requires code conversion on
   encoding.  */
#define CODING_REQUIRE_ENCODING(coding)	\
463 464
  ((coding)->src_multibyte		\
   || (coding)->common_flags & CODING_REQUIRE_ENCODING_MASK)
465 466 467 468 469 470

/* Return 1 if the coding system CODING requires some kind of code
   detection.  */
#define CODING_REQUIRE_DETECTION(coding) \
  ((coding)->common_flags & CODING_REQUIRE_DETECTION_MASK)

471 472
/* Return 1 if the coding system CODING requires code conversion on
   decoding or some kind of code detection.  */
473
#define CODING_MAY_REQUIRE_DECODING(coding)	\
474 475
  (CODING_REQUIRE_DECODING (coding)		\
   || CODING_REQUIRE_DETECTION (coding))
Karl Heuer's avatar
Karl Heuer committed
476 477

/* Index for each coding category in `coding_category_table' */
Kenichi Handa's avatar
Kenichi Handa committed
478
#define CODING_CATEGORY_IDX_EMACS_MULE	0
Karl Heuer's avatar
Karl Heuer committed
479 480
#define CODING_CATEGORY_IDX_SJIS	1
#define CODING_CATEGORY_IDX_ISO_7	2
481 482 483 484 485
#define CODING_CATEGORY_IDX_ISO_7_TIGHT	3
#define CODING_CATEGORY_IDX_ISO_8_1	4
#define CODING_CATEGORY_IDX_ISO_8_2	5
#define CODING_CATEGORY_IDX_ISO_7_ELSE	6
#define CODING_CATEGORY_IDX_ISO_8_ELSE	7
486 487
#define CODING_CATEGORY_IDX_CCL		8
#define CODING_CATEGORY_IDX_BIG5	9
Kenichi Handa's avatar
Kenichi Handa committed
488 489 490 491 492 493
#define CODING_CATEGORY_IDX_UTF_8       10
#define CODING_CATEGORY_IDX_UTF_16_BE   11
#define CODING_CATEGORY_IDX_UTF_16_LE   12
#define CODING_CATEGORY_IDX_RAW_TEXT	13
#define CODING_CATEGORY_IDX_BINARY	14
#define CODING_CATEGORY_IDX_MAX		15
Karl Heuer's avatar
Karl Heuer committed
494 495 496

/* Definitions of flag bits returned by the function
   detect_coding_mask ().  */
Kenichi Handa's avatar
Kenichi Handa committed
497
#define CODING_CATEGORY_MASK_EMACS_MULE	(1 << CODING_CATEGORY_IDX_EMACS_MULE)
Karl Heuer's avatar
Karl Heuer committed
498 499
#define CODING_CATEGORY_MASK_SJIS	(1 << CODING_CATEGORY_IDX_SJIS)
#define CODING_CATEGORY_MASK_ISO_7	(1 << CODING_CATEGORY_IDX_ISO_7)
500
#define CODING_CATEGORY_MASK_ISO_7_TIGHT (1 << CODING_CATEGORY_IDX_ISO_7_TIGHT)
Karl Heuer's avatar
Karl Heuer committed
501 502
#define CODING_CATEGORY_MASK_ISO_8_1	(1 << CODING_CATEGORY_IDX_ISO_8_1)
#define CODING_CATEGORY_MASK_ISO_8_2	(1 << CODING_CATEGORY_IDX_ISO_8_2)
503 504
#define CODING_CATEGORY_MASK_ISO_7_ELSE	(1 << CODING_CATEGORY_IDX_ISO_7_ELSE)
#define CODING_CATEGORY_MASK_ISO_8_ELSE	(1 << CODING_CATEGORY_IDX_ISO_8_ELSE)
505
#define CODING_CATEGORY_MASK_CCL	(1 << CODING_CATEGORY_IDX_CCL)
Karl Heuer's avatar
Karl Heuer committed
506
#define CODING_CATEGORY_MASK_BIG5	(1 << CODING_CATEGORY_IDX_BIG5)
Kenichi Handa's avatar
Kenichi Handa committed
507 508 509
#define CODING_CATEGORY_MASK_UTF_8      (1 << CODING_CATEGORY_IDX_UTF_8)
#define CODING_CATEGORY_MASK_UTF_16_BE  (1 << CODING_CATEGORY_IDX_UTF_16_BE)
#define CODING_CATEGORY_MASK_UTF_16_LE  (1 << CODING_CATEGORY_IDX_UTF_16_LE)
510
#define CODING_CATEGORY_MASK_RAW_TEXT	(1 << CODING_CATEGORY_IDX_RAW_TEXT)
511
#define CODING_CATEGORY_MASK_BINARY	(1 << CODING_CATEGORY_IDX_BINARY)
Karl Heuer's avatar
Karl Heuer committed
512 513 514 515

/* This value is returned if detect_coding_mask () find nothing other
   than ASCII characters.  */
#define CODING_CATEGORY_MASK_ANY  	\
Kenichi Handa's avatar
Kenichi Handa committed
516
  (  CODING_CATEGORY_MASK_EMACS_MULE	\
Karl Heuer's avatar
Karl Heuer committed
517 518
   | CODING_CATEGORY_MASK_SJIS	  	\
   | CODING_CATEGORY_MASK_ISO_7	  	\
519
   | CODING_CATEGORY_MASK_ISO_7_TIGHT  	\
Karl Heuer's avatar
Karl Heuer committed
520 521
   | CODING_CATEGORY_MASK_ISO_8_1 	\
   | CODING_CATEGORY_MASK_ISO_8_2 	\
522 523
   | CODING_CATEGORY_MASK_ISO_7_ELSE	\
   | CODING_CATEGORY_MASK_ISO_8_ELSE	\
524
   | CODING_CATEGORY_MASK_CCL		\
Kenichi Handa's avatar
Kenichi Handa committed
525 526 527 528
   | CODING_CATEGORY_MASK_BIG5		\
   | CODING_CATEGORY_MASK_UTF_8		\
   | CODING_CATEGORY_MASK_UTF_16_BE	\
   | CODING_CATEGORY_MASK_UTF_16_LE)
Karl Heuer's avatar
Karl Heuer committed
529

530 531 532 533 534 535 536 537 538 539 540 541 542 543
#define CODING_CATEGORY_MASK_ISO_7BIT \
  (CODING_CATEGORY_MASK_ISO_7 | CODING_CATEGORY_MASK_ISO_7_TIGHT)

#define CODING_CATEGORY_MASK_ISO_8BIT \
  (CODING_CATEGORY_MASK_ISO_8_1 | CODING_CATEGORY_MASK_ISO_8_2)

#define CODING_CATEGORY_MASK_ISO_SHIFT \
  (CODING_CATEGORY_MASK_ISO_7_ELSE | CODING_CATEGORY_MASK_ISO_8_ELSE)

#define CODING_CATEGORY_MASK_ISO	\
  (  CODING_CATEGORY_MASK_ISO_7BIT	\
   | CODING_CATEGORY_MASK_ISO_SHIFT	\
   | CODING_CATEGORY_MASK_ISO_8BIT)

Kenichi Handa's avatar
Kenichi Handa committed
544 545 546
#define CODING_CATEGORY_MASK_UTF_16_BE_LE \
   (CODING_CATEGORY_MASK_UTF_16_BE | CODING_CATEGORY_MASK_UTF_16_LE)

Karl Heuer's avatar
Karl Heuer committed
547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571
/* 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.  */

#define DECODE_SJIS(s1, s2, c1, c2)		  	\
  do {						  	\
    if (s2 >= 0x9F)				  	\
      c1 = s1 * 2 - (s1 >= 0xE0 ? 0x160 : 0xE0),  	\
      c2 = s2 - 0x7E;				  	\
    else					  	\
      c1 = s1 * 2 - ((s1 >= 0xE0) ? 0x161 : 0xE1),	\
      c2 = s2 - ((s2 >= 0x7F) ? 0x20 : 0x1F);	  	\
  } while (0)

#define ENCODE_SJIS(c1, c2, s1, s2)			\
  do {							\
    if (c1 & 1)						\
      s1 = c1 / 2 + ((c1 < 0x5F) ? 0x71 : 0xB1),	\
      s2 = c2 + ((c2 >= 0x60) ? 0x20 : 0x1F);		\
    else						\
      s1 = c1 / 2 + ((c1 < 0x5F) ? 0x70 : 0xB0),	\
      s2 = c2 + 0x7E;					\
  } while (0)

572 573 574 575
/* Encode the file name NAME using the specified coding system
   for file names, if any.  */
#define ENCODE_FILE(name)						   \
  (! NILP (Vfile_name_coding_system)					   \
576
   && !EQ (Vfile_name_coding_system, make_number (0))			   \
Karl Heuer's avatar
Karl Heuer committed
577
   ? code_convert_string_norecord (name, Vfile_name_coding_system, 1)	   \
578
   : (! NILP (Vdefault_file_name_coding_system)				   \
579
      && !EQ (Vdefault_file_name_coding_system, make_number (0))	   \
Karl Heuer's avatar
Karl Heuer committed
580
      ? code_convert_string_norecord (name, Vdefault_file_name_coding_system, 1) \
581 582 583 584 585 586
      : name))

/* Decode the file name NAME using the specified coding system
   for file names, if any.  */
#define DECODE_FILE(name)						   \
  (! NILP (Vfile_name_coding_system)					   \
587
   && !EQ (Vfile_name_coding_system, make_number (0))			   \
Karl Heuer's avatar
Karl Heuer committed
588
   ? code_convert_string_norecord (name, Vfile_name_coding_system, 0)	   \
589
   : (! NILP (Vdefault_file_name_coding_system)				   \
590
      && !EQ (Vdefault_file_name_coding_system, make_number (0))	   \
Karl Heuer's avatar
Karl Heuer committed
591
      ? code_convert_string_norecord (name, Vdefault_file_name_coding_system, 0) \
592 593
      : name))

594 595 596 597
#ifdef WINDOWSNT
/* Encode the string STR using the specified coding system
   for w32 system functions, if any.  */
#define ENCODE_SYSTEM(str)						   \
598
  (! NILP (Vlocale_coding_system)					   \
599
   && !EQ (Vlocale_coding_system, make_number (0))			   \
600
   ? code_convert_string_norecord (str, Vlocale_coding_system, 1)	   \
601 602 603 604 605
   : str)

/* Decode the string STR using the specified coding system
   for w32 system functions, if any.  */
#define DECODE_SYSTEM(name)						   \
606
  (! NILP (Vlocale_coding_system)					   \
607
   && !EQ (Vlocale_coding_system, make_number (0))			   \
608
   ? code_convert_string_norecord (str, Vlocale_coding_system, 0)	   \
609
   : str)
610 611 612 613 614 615 616

#else /* WINDOWSNT */

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

#endif /* !WINDOWSNT */
617

Dave Love's avatar
Dave Love committed
618 619
#define ENCODE_UTF_8(str) code_convert_string_norecord (str, Qutf_8, 1)

Karl Heuer's avatar
Karl Heuer committed
620
/* Extern declarations.  */
621
extern int decode_coding P_ ((struct coding_system *, const unsigned char *,
622
			      unsigned char *, int, int));
623
extern int encode_coding P_ ((struct coding_system *, const unsigned char *,
624
			      unsigned char *, int, int));
625 626 627 628 629
extern void coding_save_composition P_ ((struct coding_system *, int, int,
					 Lisp_Object));
extern void coding_free_composition_data P_ ((struct coding_system *));
extern void coding_adjust_composition_offset P_ ((struct coding_system *,
						  int));
630 631 632 633
extern void coding_allocate_composition_data P_ ((struct coding_system *,
						  int));
extern void coding_restore_composition P_ ((struct coding_system *,
					    Lisp_Object));
Andreas Schwab's avatar
Andreas Schwab committed
634 635
extern int code_convert_region P_ ((int, int, int, int, struct coding_system *,
				    int, int));
636 637 638
extern Lisp_Object run_pre_post_conversion_on_str P_ ((Lisp_Object,
						       struct coding_system *,
						       int));
639 640 641 642
extern void run_pre_write_conversin_on_c_str P_ ((unsigned char **, int *, 
						  int, int,
						  struct coding_system *));

643 644
extern int decoding_buffer_size P_ ((struct coding_system *, int));
extern int encoding_buffer_size P_ ((struct coding_system *, int));
645 646 647 648
extern void detect_coding P_ ((struct coding_system *, const unsigned char *,
			       int));
extern void detect_eol P_ ((struct coding_system *, const unsigned char *,
			    int));
649
extern int setup_coding_system P_ ((Lisp_Object, struct coding_system *));
650 651
extern Lisp_Object code_convert_string P_ ((Lisp_Object,
					    struct coding_system *, int, int));
Ken Raeburn's avatar
Ken Raeburn committed
652 653
extern Lisp_Object code_convert_string1 P_ ((Lisp_Object, Lisp_Object,
					     Lisp_Object, int));
654 655
extern Lisp_Object code_convert_string_norecord P_ ((Lisp_Object, Lisp_Object,
						     int));
656
extern void setup_raw_text_coding_system P_ ((struct coding_system *));
657 658
extern Lisp_Object encode_coding_string P_ ((Lisp_Object,
					     struct coding_system *, int));
Ken Raeburn's avatar
Ken Raeburn committed
659 660
extern Lisp_Object decode_coding_string P_ ((Lisp_Object,
					     struct coding_system *, int));
Karl Heuer's avatar
Karl Heuer committed
661
extern Lisp_Object Qcoding_system, Qeol_type, Qcoding_category_index;
Kenichi Handa's avatar
Kenichi Handa committed
662
extern Lisp_Object Qraw_text, Qemacs_mule;
Karl Heuer's avatar
Karl Heuer committed
663 664
extern Lisp_Object Qbuffer_file_coding_system;
extern Lisp_Object Vcoding_category_list;
Dave Love's avatar
Dave Love committed
665
extern Lisp_Object Qutf_8;
Karl Heuer's avatar
Karl Heuer committed
666

667 668
extern Lisp_Object Qtranslation_table;
extern Lisp_Object Qtranslation_table_id;
669

670 671 672 673
/* 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
674 675 676 677 678

#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;
679
extern Lisp_Object Qwrite_region;
Karl Heuer's avatar
Karl Heuer committed
680

681 682
extern char *emacs_strerror P_ ((int));

Karl Heuer's avatar
Karl Heuer committed
683 684 685 686 687 688
/* 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;
689 690
/* Coding-system to use with system messages (e.g. strerror).  */
extern Lisp_Object Vlocale_coding_system;
Karl Heuer's avatar
Karl Heuer committed
691

692 693 694 695
/* 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
696 697 698 699 700
/* 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;

701 702 703 704
/* 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
705 706 707 708 709
/* 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;

710 711 712
/* Default coding system to be used to write a file.  */
extern struct coding_system default_buffer_file_coding;

713 714
/* Default coding systems used for process I/O.  */
extern Lisp_Object Vdefault_process_coding_system;
Karl Heuer's avatar
Karl Heuer committed
715

Dave Love's avatar
Dave Love committed
716
/* Function to call to force a user to force select a proper coding
717 718 719
   system.  */
extern Lisp_Object Vselect_safe_coding_system_function;

720 721 722 723
/* 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;

724 725 726 727 728 729
/* 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;
730

Karl Heuer's avatar
Karl Heuer committed
731 732
#endif

733 734 735
/* Error signaled when there's a problem with detecting coding system */
extern Lisp_Object Qcoding_system_error;

736
#endif /* EMACS_CODING_H */
Miles Bader's avatar
Miles Bader committed
737 738 739

/* arch-tag: 2bc3b4fa-6870-4f64-8135-b962b2d290e4
   (do not change this comment) */