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

/* Header for coding system handler.
   Copyright (C) 1995, 1997 Electrotechnical Laboratory, JAPAN.
   Licensed to the Free Software Foundation.

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 (emacs-mule) 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

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

/* 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.  */
  unsigned char requested_designation[MAX_CHARSET + 1];

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

  /* Set to 1 temporarily only when processing at beginning of line.  */
  int bol;
};

/* 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]
#define CODING_SPEC_ISO_SINGLE_SHIFTING(coding) \
  coding->spec.iso2022.single_shifting
#define CODING_SPEC_ISO_BOL(coding) \
  coding->spec.iso2022.bol

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

/* 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_INVOCATION (coding, plane) < 0)	\
   ? -1							\
   : 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_emacs_mule,	/* A coding system used in Emacs'
				   buffer and string.  Requires no
				   conversion for reading and writing
				   except for end-of-line format.  */
    coding_type_undecided,	/* 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_UNDECIDED 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;

  /* Character unification table to look up, or nil.  */
  Lisp_Object character_unification_table;

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

/* 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_UNDECIDED  	\
   && (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_EMACS_MULE	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_EMACS_MULE	(1 << CODING_CATEGORY_IDX_EMACS_MULE)
#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_EMACS_MULE	\
   | 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;

/* Default coding systems used for process I/O.  */
extern Lisp_Object Vdefault_process_coding_system;

#endif

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