[bpt/emacs.git] / src / coding.h

/* Header for coding system handler.
   Ver.1.0
   Copyright (C) 1995 Free Software Foundation, Inc.
   Copyright (C) 1995 Electrotechnical Laboratory, JAPAN.

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.

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.

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

#ifndef _CODING_H
#define _CODING_H

#ifndef _CCL_H
#include "../src/ccl.h"
#endif

/*** EMACS' INTERNAL FORMAT section ***/

/* 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_composition, /* Leading code of a composite
				       character.  */
    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
  {
    ISO_control_code,		/* Control codes in the range
				   0x00..0x1F, 0x7F, and 0x80..0x9F,
				   except for the following seven
				   codes.  */
    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) */
    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

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

  /* A graphic register to which each charset should be designated.  */
  int requested_designation[MAX_CHARSET];

  /* Set to 1 temporarily only when graphic register 2 or 3 is invoked
     by single-shift while encoding.  */
  int single_shifting;
};

/* Macros to access each field in the structure `spec.iso2022'.  */
#define CODING_SPEC_ISO_INVOCATION(coding, plane) \
  coding->spec.iso2022.current_invocation[plane]
#define CODING_SPEC_ISO_DESIGNATION(coding, reg) \
  coding->spec.iso2022.current_designation[reg]
#define CODING_SPEC_ISO_INITIAL_DESIGNATION(coding, reg) \
  coding->spec.iso2022.initial_designation[reg]
#define CODING_SPEC_ISO_REQUESTED_DESIGNATION(coding, charset) \
  coding->spec.iso2022.requested_designation[charset]

/* Set to 1 temporarily only when encoding a character with
   single-shift function.  */
#define CODING_SPEC_ISO_SINGLE_SHIFTING(coding) \
  coding->spec.iso2022.single_shifting

/* Return a charset which is currently designated to the graphic plane
   PLANE in the coding-system CODING.  */
#define CODING_SPEC_ISO_PLANE_CHARSET(coding, plane) \
  CODING_SPEC_ISO_DESIGNATION		 \
  (coding, CODING_SPEC_ISO_INVOCATION (coding, plane))

/*** 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.  */
    coding_type_internal,	/* A coding system used in Emacs'
				   buffer and string.  Requires no
				   conversion for reading and writing
				   except for end-of-line format.  */
    coding_type_automatic,	/* A coding system which requires
				   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.  */
    coding_type_ccl		/* The coding system of which decoder
				   and encoder are written in CCL.  */
  };

/* 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.  */
#define CODING_EOL_AUTOMATIC 3	/* This value is used to denote the
				   eol-type is not yet decided.  */

/* Character composition status while encoding/decoding.  */
#define COMPOSING_NO		 0 /* not composing */
#define COMPOSING_WITH_RULE_HEAD 1 /* 1st char of with-rule composing follow */
#define COMPOSING_NO_RULE_HEAD	 2 /* 1st char of no-rule composing follow */
#define COMPOSING_WITH_RULE_TAIL 3 /* Nth char of with-rule composing follow */
#define COMPOSING_NO_RULE_TAIL	 4 /* Nth char of no-rule composing follow */
#define COMPOSING_WITH_RULE_RULE 5 /* composition rule follow */

/* 1 iff composing.  */
#define COMPOSING_P(composing) (composing)
/* 1 iff 1st char of composing element follows.  */
#define COMPOSING_HEAD_P(composing) \
  ((composing) && (composing) <= COMPOSING_NO_RULE_HEAD)
/* 1 iff composing with embeded composition rule.  */
#define COMPOSING_WITH_RULE_P(composing) ((composing) & 1)

struct coding_system
{
  /* Type of the coding system.  */
  enum coding_type type;

  /* If the coding system requires specific code to be attached at the
     tail of converted text, this value should be set to `1'.  */
  int require_flushing;

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

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

  /* Non-zero means that the current source text is the last block of the
     whole text to be converted.  */
  int last_block;

  /* Non-zero means that characters are being composed currently while
     decoding or encoding.  See macros COMPOSING_XXXX above for the
     meaing of each non-zero value.  */
  int composing;

  /* 0 (left-to-right) or 1 (right-to-left): the direction of the text
     being processed currently.  */
  int direction;

  /* Non-zero means that the current source text is in a buffer which
     enables selective display.  */
  int selective;

  /* Detailed information specific to each type of coding system.  */
  union spec
    {
      struct iso2022_spec iso2022;
      struct ccl_spec ccl;	/* Defined in ccl.h.  */
    } spec;

  /* Backward pointer to the Lisp symbol of the coding system.  */
  Lisp_Object symbol;

  /* Lisp function (symbol) to be called after decoding to do
     additional conversion. */
  Lisp_Object post_read_conversion;

  /* Lisp function (symbol) to be called before encoding to do
     additional conversion. */
  Lisp_Object pre_write_conversion;

  /* Carryover yielded by decoding/encoding incomplete source.  No
     coding-system yields more than 7-byte of carryover.  This does
     not include a text which is not processed because of short of
     output buffer.  */
  char carryover[8];

  /* Actual data length in the above array.  */
  int carryover_size;
};

/* Return 1 if the coding-system CODING requires conversion of
   representation of a visible character (text).  */
#define CODING_REQUIRE_TEXT_CONVERSION(coding)	\
  ((coding)->type != coding_type_no_conversion  	\
   && (coding)->type != coding_type_internal)

/* Return 1 if the coding-system CODING requires conversion of the
   format of end-of-line.  */
#define CODING_REQUIRE_EOL_CONVERSION(coding)	\
  ((coding)->eol_type != CODING_EOL_AUTOMATIC  	\
   && (coding)->eol_type != CODING_EOL_LF)

/* Return 1 if the coding-system CODING requires some conversion.  */
#define CODING_REQUIRE_CONVERSION(coding)  	\
  (CODING_REQUIRE_TEXT_CONVERSION (coding) 	\
   || CODING_REQUIRE_EOL_CONVERSION (coding))

/* Index for each coding category in `coding_category_table' */
#define CODING_CATEGORY_IDX_INTERNAL	0
#define CODING_CATEGORY_IDX_SJIS	1
#define CODING_CATEGORY_IDX_ISO_7	2
#define CODING_CATEGORY_IDX_ISO_8_1	3
#define CODING_CATEGORY_IDX_ISO_8_2	4
#define CODING_CATEGORY_IDX_ISO_ELSE	5
#define CODING_CATEGORY_IDX_BIG5	6
#define CODING_CATEGORY_IDX_BINARY	7
#define CODING_CATEGORY_IDX_MAX		8

/* Definitions of flag bits returned by the function
   detect_coding_mask ().  */
#define CODING_CATEGORY_MASK_INTERNAL	(1 << CODING_CATEGORY_IDX_INTERNAL)
#define CODING_CATEGORY_MASK_SJIS	(1 << CODING_CATEGORY_IDX_SJIS)
#define CODING_CATEGORY_MASK_ISO_7	(1 << CODING_CATEGORY_IDX_ISO_7)
#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)
#define CODING_CATEGORY_MASK_ISO_ELSE	(1 << CODING_CATEGORY_IDX_ISO_ELSE)
#define CODING_CATEGORY_MASK_BIG5	(1 << CODING_CATEGORY_IDX_BIG5)

/* This value is returned if detect_coding_mask () find nothing other
   than ASCII characters.  */
#define CODING_CATEGORY_MASK_ANY  	\
  (  CODING_CATEGORY_MASK_INTERNAL	\
   | CODING_CATEGORY_MASK_SJIS	  	\
   | CODING_CATEGORY_MASK_ISO_7	  	\
   | CODING_CATEGORY_MASK_ISO_8_1 	\
   | CODING_CATEGORY_MASK_ISO_8_2 	\
   | CODING_CATEGORY_MASK_ISO_ELSE	\
   | CODING_CATEGORY_MASK_BIG5)

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

/* Extern declarations.  */
extern int decode_coding (), encode_coding ();
extern int decoding_buffer_size (), encoding_buffer_size ();
extern int conversion_buffer_size;
extern char *conversion_buffer, *get_conversion_buffer ();
extern Lisp_Object Fcheck_coding_system ();
extern Lisp_Object Qcoding_system, Qeol_type, Qcoding_category_index;
extern Lisp_Object Qbuffer_file_coding_system;
extern Lisp_Object Vcoding_category_list;

/* Mnemonic character to indicate each type of end-of-line.  */
extern int eol_mnemonic_unix, eol_mnemonic_dos, eol_mnemonic_mac;
/* Mnemonic character to indicate type of end-of-line is not yet decided.  */
extern int eol_mnemonic_undecided;

/* Table of coding-systems currently assigned to each coding-category.  */
extern Lisp_Object coding_category_table[CODING_CATEGORY_IDX_MAX];
/* Table of names of symbol for each coding-category.  */
extern char *coding_category_name[CODING_CATEGORY_IDX_MAX];

#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;

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

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

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

extern Lisp_Object Vcoding_system_alist;

#endif

#endif /* _CODING_H */
Commit	Line	Data
4ed46869 KH	1	/* Header for coding system handler.
4ed46869 KH	2	Ver.1.0
4ed46869 KH	3	Copyright (C) 1995 Free Software Foundation, Inc.
	4	Copyright (C) 1995 Electrotechnical Laboratory, JAPAN.
	5
369314dc KH	6	This file is part of GNU Emacs.
	7
	8	GNU Emacs is free software; you can redistribute it and/or modify
	9	it under the terms of the GNU General Public License as published by
	10	the Free Software Foundation; either version 2, or (at your option)
	11	any later version.
4ed46869	12
369314dc KH	13	GNU Emacs is distributed in the hope that it will be useful,
	14	but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	GNU General Public License for more details.
4ed46869	17
369314dc KH	18	You should have received a copy of the GNU General Public License
	19	along with GNU Emacs; see the file COPYING. If not, write to
	20	the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
	21	Boston, MA 02111-1307, USA. */
4ed46869 KH	22
	23	#ifndef _CODING_H
	24	#define _CODING_H
	25
	26	#ifndef _CCL_H
	27	#include "../src/ccl.h"
	28	#endif
	29
	30	/* EMACS' INTERNAL FORMAT section */
	31
	32	/* All code (1-byte) of Emacs' internal format is classified into one
	33	of the followings. See also `charset.h'. */
	34	enum emacs_code_class_type
	35	{
	36	EMACS_control_code, /* Control codes in the range
	37	0x00..0x1F and 0x7F except for the
	38	following two codes. */
	39	EMACS_linefeed_code, /* 0x0A (linefeed) to denote
	40	end-of-line. */
	41	EMACS_carriage_return_code, /* 0x0D (carriage-return) to be used
	42	in selective display mode. */
	43	EMACS_ascii_code, /* ASCII characters. */
	44	EMACS_leading_code_composition, /* Leading code of a composite
	45	character. */
	46	EMACS_leading_code_2, /* Base leading code of official
	47	TYPE9N character. */
	48	EMACS_leading_code_3, /* Base leading code of private TYPE9N
	49	or official TYPE9Nx9N character. */
	50	EMACS_leading_code_4, /* Base leading code of private
	51	TYPE9Nx9N character. */
	52	EMACS_invalid_code /* Invalid code, i.e. a base leading
	53	code not yet assigned to any
	54	charset, or a code of the range
	55	0xA0..0xFF. */
	56	};
	57
	58	extern enum emacs_code_class_type emacs_code_class[256];
	59
	60	/* ISO2022 section */
	61
	62	/* Macros to define code of control characters for ISO2022's functions. */
	63	/* code / / function */
	64	#define ISO_CODE_LF 0x0A /* line-feed */
	65	#define ISO_CODE_CR 0x0D /* carriage-return */
	66	#define ISO_CODE_SO 0x0E /* shift-out */
	67	#define ISO_CODE_SI 0x0F /* shift-in */
	68	#define ISO_CODE_SS2_7 0x19 /* single-shift-2 for 7-bit code */
	69	#define ISO_CODE_ESC 0x1B /* escape */
	70	#define ISO_CODE_SS2 0x8E /* single-shift-2 */
	71	#define ISO_CODE_SS3 0x8F /* single-shift-3 */
	72	#define ISO_CODE_CSI 0x9B /* control-sequence-introduce */
	73
	74	/* All code (1-byte) of ISO2022 is classified into one of the
	75	followings. */
	76	enum iso_code_class_type
	77	{
	78	ISO_control_code, /* Control codes in the range
	79	0x00..0x1F, 0x7F, and 0x80..0x9F,
	80	except for the following seven
	81	codes. */
	82	ISO_carriage_return, /* ISO_CODE_CR (0x0D) */
	83	ISO_shift_out, /* ISO_CODE_SO (0x0E) */
	84	ISO_shift_in, /* ISO_CODE_SI (0x0F) */
	85	ISO_single_shift_2_7, /* ISO_CODE_SS2_7 (0x19) */
86	ISO_escape, /* ISO_CODE_SO (0x1B) */
87	ISO_single_shift_2, /* ISO_CODE_SS2 (0x8E) */
88	ISO_single_shift_3, /* ISO_CODE_SS3 (0x8F) */
89	ISO_control_sequence_introducer, /* ISO_CODE_CSI (0x9B) */
90	ISO_0x20_or_0x7F, /* Codes of the values 0x20 or 0x7F. */
91	ISO_graphic_plane_0, /* Graphic codes in the range 0x21..0x7E. */
92	ISO_0xA0_or_0xFF, /* Codes of the values 0xA0 or 0xFF. */
93	ISO_graphic_plane_1 /* Graphic codes in the range 0xA1..0xFE. */
94	};
95
96	/** The macros CODING_FLAG_ISO_XXX defines a flag bit of the `flags'
97	element in the structure `coding_system'. This information is used
98	while encoding a text to ISO2022. **/
99
100	/* If set, produce short-form designation sequence (e.g. ESC $ A)
101	instead of long-form sequence (e.g. ESC $ ( A). */
102	#define CODING_FLAG_ISO_SHORT_FORM 0x0001
103
104	/* If set, reset graphic planes and registers at end-of-line to the
105	initial state. */
106	#define CODING_FLAG_ISO_RESET_AT_EOL 0x0002
107
108	/* If set, reset graphic planes and registers before any control
109	characters to the initial state. */
110	#define CODING_FLAG_ISO_RESET_AT_CNTL 0x0004
111
112	/* If set, encode by 7-bit environment. */
113	#define CODING_FLAG_ISO_SEVEN_BITS 0x0008
114
115	/* If set, use locking-shift function. */
116	#define CODING_FLAG_ISO_LOCKING_SHIFT 0x0010
117
118	/* If set, use single-shift function. Overwrite
119	CODING_FLAG_ISO_LOCKING_SHIFT. */
120	#define CODING_FLAG_ISO_SINGLE_SHIFT 0x0020
121
122	/* If set, designate JISX0201-Roman instead of ASCII. */
123	#define CODING_FLAG_ISO_USE_ROMAN 0x0040
124
125	/* If set, designate JISX0208-1978 instead of JISX0208-1983. */
126	#define CODING_FLAG_ISO_USE_OLDJIS 0x0080
127
128	/* If set, do not produce ISO6429's direction specifying sequence. */
129	#define CODING_FLAG_ISO_NO_DIRECTION 0x0100
130
131	/* Structure of the field `spec.iso2022' in the structure `coding_system'. */
132	struct iso2022_spec
133	{
134	/* The current graphic register invoked to each graphic plane. */
135	int current_invocation[2];
136
137	/* The current charset designated to each graphic register. */
138	int current_designation[4];
139
140	/* A charset initially designated to each graphic register. */
141	int initial_designation[4];
142
143	/* A graphic register to which each charset should be designated. */
144	int requested_designation[MAX_CHARSET];
145
146	/* Set to 1 temporarily only when graphic register 2 or 3 is invoked
147	by single-shift while encoding. */
148	int single_shifting;
149	};
150
151	/* Macros to access each field in the structure `spec.iso2022'. */
152	#define CODING_SPEC_ISO_INVOCATION(coding, plane) \
153	coding->spec.iso2022.current_invocation[plane]
154	#define CODING_SPEC_ISO_DESIGNATION(coding, reg) \
155	coding->spec.iso2022.current_designation[reg]
156	#define CODING_SPEC_ISO_INITIAL_DESIGNATION(coding, reg) \
157	coding->spec.iso2022.initial_designation[reg]
158	#define CODING_SPEC_ISO_REQUESTED_DESIGNATION(coding, charset) \
159	coding->spec.iso2022.requested_designation[charset]
160
161	/* Set to 1 temporarily only when encoding a character with
162	single-shift function. */
163	#define CODING_SPEC_ISO_SINGLE_SHIFTING(coding) \
164	coding->spec.iso2022.single_shifting
165
166	/* Return a charset which is currently designated to the graphic plane
167	PLANE in the coding-system CODING. */
168	#define CODING_SPEC_ISO_PLANE_CHARSET(coding, plane) \
169	CODING_SPEC_ISO_DESIGNATION \
170	(coding, CODING_SPEC_ISO_INVOCATION (coding, plane))
171
172	/* BIG5 section */
173
174	/* Macros to denote each type of BIG5 coding system. */
175	#define CODING_FLAG_BIG5_HKU 0x00 /* BIG5-HKU is one of variants of
176	BIG5 developed by Hong Kong
177	University. */
178	#define CODING_FLAG_BIG5_ETEN 0x01 /* BIG5_ETen is one of variants
179	of BIG5 developed by the
180	company ETen in Taiwan. */
181
182	/* GENERAL section */
183
184	/* Types of coding system. */
185	enum coding_type
186	{
187	coding_type_no_conversion, /* A coding system which requires no
188	conversion for reading and writing
189	including end-of-line format. */
190	coding_type_internal, /* A coding system used in Emacs'
191	buffer and string. Requires no
192	conversion for reading and writing
193	except for end-of-line format. */
194	coding_type_automatic, /* A coding system which requires
195	automatic detection of a real
196	coding system. */
197	coding_type_sjis, /* SJIS coding system for Japanese. */
198	coding_type_iso2022, /* Any coding system of ISO2022
199	variants. */
200	coding_type_big5, /* BIG5 coding system for Chinese. */
201	coding_type_ccl /* The coding system of which decoder
202	and encoder are written in CCL. */
203	};
204
205	/* Formats of end-of-line. */
206	#define CODING_EOL_LF 0 /* Line-feed only, same as Emacs'
207	internal format. */
208	#define CODING_EOL_CRLF 1 /* Sequence of carriage-return and
209	line-feed. */
210	#define CODING_EOL_CR 2 /* Carriage-return only. */
211	#define CODING_EOL_AUTOMATIC 3 /* This value is used to denote the
212	eol-type is not yet decided. */
213
214	/* Character composition status while encoding/decoding. */
215	#define COMPOSING_NO 0 /* not composing */
216	#define COMPOSING_WITH_RULE_HEAD 1 /* 1st char of with-rule composing follow */
217	#define COMPOSING_NO_RULE_HEAD 2 /* 1st char of no-rule composing follow */
218	#define COMPOSING_WITH_RULE_TAIL 3 /* Nth char of with-rule composing follow */
219	#define COMPOSING_NO_RULE_TAIL 4 /* Nth char of no-rule composing follow */
220	#define COMPOSING_WITH_RULE_RULE 5 /* composition rule follow */
221
222	/* 1 iff composing. */
223	#define COMPOSING_P(composing) (composing)
224	/* 1 iff 1st char of composing element follows. */
225	#define COMPOSING_HEAD_P(composing) \
226	((composing) && (composing) <= COMPOSING_NO_RULE_HEAD)
227	/* 1 iff composing with embeded composition rule. */
228	#define COMPOSING_WITH_RULE_P(composing) ((composing) & 1)
229
230	struct coding_system
231	{
232	/* Type of the coding system. */
233	enum coding_type type;
234
235	/* If the coding system requires specific code to be attached at the
236	tail of converted text, this value should be set to `1'. */
237	int require_flushing;
238
239	/* Flag bits of the coding system. The meaning of each bit depends
240	on the type of the coding system. */
241	unsigned int flags;
242
243	/* Type of end-of-line format (LF, CRLF, or CR) of the coding system. */
244	int eol_type;
245
246	/* Non-zero means that the current source text is the last block of the
247	whole text to be converted. */
248	int last_block;
249
250	/* Non-zero means that characters are being composed currently while
251	decoding or encoding. See macros COMPOSING_XXXX above for the
252	meaing of each non-zero value. */
253	int composing;
254
255	/* 0 (left-to-right) or 1 (right-to-left): the direction of the text
256	being processed currently. */
257	int direction;
258
259	/* Non-zero means that the current source text is in a buffer which
260	enables selective display. */
261	int selective;
262
263	/* Detailed information specific to each type of coding system. */
264	union spec
265	{
266	struct iso2022_spec iso2022;
267	struct ccl_spec ccl; /* Defined in ccl.h. */
268	} spec;
269
270	/* Backward pointer to the Lisp symbol of the coding system. */
271	Lisp_Object symbol;
272
273	/* Lisp function (symbol) to be called after decoding to do
274	additional conversion. */
275	Lisp_Object post_read_conversion;
276
277	/* Lisp function (symbol) to be called before encoding to do
278	additional conversion. */
279	Lisp_Object pre_write_conversion;
280
281	/* Carryover yielded by decoding/encoding incomplete source. No
282	coding-system yields more than 7-byte of carryover. This does
283	not include a text which is not processed because of short of
284	output buffer. */
285	char carryover[8];
286
287	/* Actual data length in the above array. */
288	int carryover_size;
289	};
290
291	/* Return 1 if the coding-system CODING requires conversion of
292	representation of a visible character (text). */
293	#define CODING_REQUIRE_TEXT_CONVERSION(coding) \
294	((coding)->type != coding_type_no_conversion \
295	&& (coding)->type != coding_type_internal)
296
297	/* Return 1 if the coding-system CODING requires conversion of the
298	format of end-of-line. */
299	#define CODING_REQUIRE_EOL_CONVERSION(coding) \
300	((coding)->eol_type != CODING_EOL_AUTOMATIC \
301	&& (coding)->eol_type != CODING_EOL_LF)
302
303	/* Return 1 if the coding-system CODING requires some conversion. */
304	#define CODING_REQUIRE_CONVERSION(coding) \
305	(CODING_REQUIRE_TEXT_CONVERSION (coding) \
306	\|\| CODING_REQUIRE_EOL_CONVERSION (coding))
307
308	/* Index for each coding category in `coding_category_table' */
309	#define CODING_CATEGORY_IDX_INTERNAL 0
310	#define CODING_CATEGORY_IDX_SJIS 1
311	#define CODING_CATEGORY_IDX_ISO_7 2
312	#define CODING_CATEGORY_IDX_ISO_8_1 3
313	#define CODING_CATEGORY_IDX_ISO_8_2 4
314	#define CODING_CATEGORY_IDX_ISO_ELSE 5
315	#define CODING_CATEGORY_IDX_BIG5 6
316	#define CODING_CATEGORY_IDX_BINARY 7
317	#define CODING_CATEGORY_IDX_MAX 8
318
319	/* Definitions of flag bits returned by the function
320	detect_coding_mask (). */
321	#define CODING_CATEGORY_MASK_INTERNAL (1 << CODING_CATEGORY_IDX_INTERNAL)
322	#define CODING_CATEGORY_MASK_SJIS (1 << CODING_CATEGORY_IDX_SJIS)
323	#define CODING_CATEGORY_MASK_ISO_7 (1 << CODING_CATEGORY_IDX_ISO_7)
324	#define CODING_CATEGORY_MASK_ISO_8_1 (1 << CODING_CATEGORY_IDX_ISO_8_1)
325	#define CODING_CATEGORY_MASK_ISO_8_2 (1 << CODING_CATEGORY_IDX_ISO_8_2)
326	#define CODING_CATEGORY_MASK_ISO_ELSE (1 << CODING_CATEGORY_IDX_ISO_ELSE)
327	#define CODING_CATEGORY_MASK_BIG5 (1 << CODING_CATEGORY_IDX_BIG5)
328
329	/* This value is returned if detect_coding_mask () find nothing other
330	than ASCII characters. */
331	#define CODING_CATEGORY_MASK_ANY \
332	( CODING_CATEGORY_MASK_INTERNAL \
333	\| CODING_CATEGORY_MASK_SJIS \
334	\| CODING_CATEGORY_MASK_ISO_7 \
335	\| CODING_CATEGORY_MASK_ISO_8_1 \
336	\| CODING_CATEGORY_MASK_ISO_8_2 \
337	\| CODING_CATEGORY_MASK_ISO_ELSE \
338	\| CODING_CATEGORY_MASK_BIG5)
339
340	/* Macros to decode or encode a character of JISX0208 in SJIS. S1 and
341	S2 are the 1st and 2nd position-codes of JISX0208 in SJIS coding
342	system. C1 and C2 are the 1st and 2nd position codes of Emacs'
343	internal format. */
344
345	#define DECODE_SJIS(s1, s2, c1, c2) \
346	do { \
347	if (s2 >= 0x9F) \
348	c1 = s1 * 2 - (s1 >= 0xE0 ? 0x160 : 0xE0), \
349	c2 = s2 - 0x7E; \
350	else \
351	c1 = s1 * 2 - ((s1 >= 0xE0) ? 0x161 : 0xE1), \
352	c2 = s2 - ((s2 >= 0x7F) ? 0x20 : 0x1F); \
353	} while (0)
354
355	#define ENCODE_SJIS(c1, c2, s1, s2) \
356	do { \
357	if (c1 & 1) \
358	s1 = c1 / 2 + ((c1 < 0x5F) ? 0x71 : 0xB1), \
359	s2 = c2 + ((c2 >= 0x60) ? 0x20 : 0x1F); \
360	else \
361	s1 = c1 / 2 + ((c1 < 0x5F) ? 0x70 : 0xB0), \
362	s2 = c2 + 0x7E; \
363	} while (0)
364
365	/* Extern declarations. */
366	extern int decode_coding (), encode_coding ();
367	extern int decoding_buffer_size (), encoding_buffer_size ();
368	extern int conversion_buffer_size;
369	extern char conversion_buffer, get_conversion_buffer ();
370	extern Lisp_Object Fcheck_coding_system ();
371	extern Lisp_Object Qcoding_system, Qeol_type, Qcoding_category_index;
372	extern Lisp_Object Qbuffer_file_coding_system;
373	extern Lisp_Object Vcoding_category_list;
374
375	/* Mnemonic character to indicate each type of end-of-line. */
376	extern int eol_mnemonic_unix, eol_mnemonic_dos, eol_mnemonic_mac;
377	/* Mnemonic character to indicate type of end-of-line is not yet decided. */
378	extern int eol_mnemonic_undecided;
379
380	/* Table of coding-systems currently assigned to each coding-category. */
381	extern Lisp_Object coding_category_table[CODING_CATEGORY_IDX_MAX];
382	/* Table of names of symbol for each coding-category. */
383	extern char *coding_category_name[CODING_CATEGORY_IDX_MAX];
384
385	#ifdef emacs
386	extern Lisp_Object Qfile_coding_system;
387	extern Lisp_Object Qcall_process, Qcall_process_region, Qprocess_argument;
388	extern Lisp_Object Qstart_process, Qopen_network_stream;
389
390	/* Coding-system for reading files and receiving data from process. */
391	extern Lisp_Object Vcoding_system_for_read;
392	/* Coding-system for writing files and sending data to process. */
393	extern Lisp_Object Vcoding_system_for_write;
394	/* Coding-system actually used in the latest I/O. */
395	extern Lisp_Object Vlast_coding_system_used;
396
397	/* Coding-system to be used for encoding terminal output. This
398	structure contains information of a coding-system specified by the
399	function `set-terminal-coding-system'. */
400	extern struct coding_system terminal_coding;
401
402	/* Coding-system of what is sent from terminal keyboard. This
403	structure contains information of a coding-system specified by the
404	function `set-keyboard-coding-system'. */
405	extern struct coding_system keyboard_coding;
406
407	extern Lisp_Object Vcoding_system_alist;
408
409	#endif
410
411	#endif /* _CODING_H */