ccl.h 4.47 KB
Newer Older
Karl Heuer's avatar
Karl Heuer committed
1
/* Header for CCL (Code Conversion Language) interpreter.
Kenichi Handa's avatar
Kenichi Handa committed
2
   Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
Glenn Morris's avatar
Glenn Morris committed
3
     2005, 2006, 2007, 2008
Kenichi Handa's avatar
Kenichi Handa committed
4 5
     National Institute of Advanced Industrial Science and Technology (AIST)
     Registration Number H14PRO021
Karl Heuer's avatar
Karl Heuer committed
6

Karl Heuer's avatar
Karl Heuer committed
7 8 9 10
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
11
the Free Software Foundation; either version 3, or (at your option)
Karl Heuer's avatar
Karl Heuer committed
12
any later version.
Karl Heuer's avatar
Karl Heuer committed
13

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

Karl Heuer's avatar
Karl Heuer committed
19 20
You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
Lute Kamstra's avatar
Lute Kamstra committed
21 22
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Karl Heuer's avatar
Karl Heuer committed
23

24 25
#ifndef EMACS_CCL_H
#define EMACS_CCL_H
Karl Heuer's avatar
Karl Heuer committed
26

27 28 29 30 31 32 33 34
/* Macros for exit status of CCL program.  */
#define CCL_STAT_SUCCESS	0 /* Terminated successfully.  */
#define CCL_STAT_SUSPEND_BY_SRC	1 /* Terminated by empty input.  */
#define CCL_STAT_SUSPEND_BY_DST	2 /* Terminated by output buffer full.  */
#define CCL_STAT_INVALID_CMD	3 /* Terminated because of invalid
				     command.  */
#define CCL_STAT_QUIT		4 /* Terminated because of quit.  */

Karl Heuer's avatar
Karl Heuer committed
35 36 37
/* Structure to hold information about running CCL code.  Read
   comments in the file ccl.c for the detail of each field.  */
struct ccl_program {
Kenichi Handa's avatar
Kenichi Handa committed
38 39 40 41
  int idx;			/* Index number of the CCL program.
				   -1 means that the program was given
				   by a vector, not by a program
				   name.  */
Karl Heuer's avatar
Karl Heuer committed
42 43 44 45 46 47 48 49
  int size;			/* Size of the compiled code.  */
  Lisp_Object *prog;		/* Pointer into the compiled code.  */
  int ic;			/* Instruction Counter (index for PROG).  */
  int eof_ic;			/* Instruction Counter for end-of-file
				   processing code.  */
  int reg[8];			/* CCL registers, reg[7] is used for
				   condition flag of relational
				   operations.  */
50
  int private_state;            /* CCL instruction may use this
51 52
				   for private use, mainly for saving
				   internal states on suspending.
53
				   This variable is set to 0 when ccl is
54
				   set up.  */
Karl Heuer's avatar
Karl Heuer committed
55 56 57 58 59 60
  int last_block;		/* Set to 1 while processing the last
				   block. */
  int status;			/* Exit status of the CCL program.  */
  int buf_magnification;	/* Output buffer magnification.  How
				   many times bigger the output buffer
				   should be than the input buffer.  */
61
  int stack_idx;		/* How deep the call of CCL_Call is nested.  */
62 63
  int eol_type;			/* When the CCL program is used for
				   encoding by a coding system, set to
64 65 66
				   the eol_type of the coding system.
				   In other cases, always
				   CODING_EOL_LF.  */
67
  int multibyte;		/* 1 if the source text is multibyte.  */
68 69 70 71
  int cr_consumed;		/* Flag for encoding DOS-like EOL
				   format when the CCL program is used
				   for encoding by a coding
				   system.  */
72 73
  int suppress_error;		/* If nonzero, don't insert error
				   message in the output.  */
74 75 76 77 78
  int eight_bit_control;	/* If nonzero, ccl_driver counts all
				   eight-bit-control bytes written by
				   CCL_WRITE_CHAR.  After execution,
				   if no such byte is written, set
				   this value to zero.  */
Karl Heuer's avatar
Karl Heuer committed
79 80 81 82 83 84 85 86
};

/* This data type is used for the spec field of the structure
   coding_system.  */

struct ccl_spec {
  struct ccl_program decoder;
  struct ccl_program encoder;
87
  unsigned char valid_codes[256];
88
  int cr_carryover;		/* CR carryover flag.  */
89
  unsigned char eight_bit_carryover[MAX_MULTIBYTE_LENGTH];
Karl Heuer's avatar
Karl Heuer committed
90 91 92 93 94
};

/* Alist of fontname patterns vs corresponding CCL program.  */
extern Lisp_Object Vfont_ccl_encoder_alist;

95
/* Setup fields of the structure pointed by CCL appropriately for the
96 97
   execution of ccl program CCL_PROG (symbol or vector).  */
extern int setup_ccl_program P_ ((struct ccl_program *, Lisp_Object));
98

Kenichi Handa's avatar
Kenichi Handa committed
99 100 101
/* Check if CCL is updated or not.  If not, re-setup members of CCL.  */
extern int check_ccl_update P_ ((struct ccl_program *));

102 103 104
extern int ccl_driver P_ ((struct ccl_program *, unsigned char *,
			   unsigned char *, int, int, int *));

105 106 107 108 109 110 111
/* Vector of CCL program names vs corresponding program data.  */
extern Lisp_Object Vccl_program_table;

/* Symbols of ccl program have this property, a value of the property
   is an index for Vccl_protram_table. */
extern Lisp_Object Qccl_program_idx;

112
#endif /* EMACS_CCL_H */
Miles Bader's avatar
Miles Bader committed
113 114 115

/* arch-tag: 14681df7-876d-43de-bc71-6b78e23a4e3c
   (do not change this comment) */