ccl.h 4.83 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
Kenichi Handa's avatar
Kenichi Handa committed
6
   Copyright (C) 2003
7 8
     National Institute of Advanced Industrial Science and Technology (AIST)
     Registration Number H13PRO009
Karl Heuer's avatar
Karl Heuer committed
9

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

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

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

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

27 28
#ifndef EMACS_CCL_H
#define EMACS_CCL_H
Karl Heuer's avatar
Karl Heuer committed
29

30 31 32 33 34 35 36 37
/* 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
38 39 40
/* 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
41 42 43 44
  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
45 46 47 48 49 50 51 52
  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.  */
53
  int private_state;            /* CCL instruction may use this
54 55
				   for private use, mainly for saving
				   internal states on suspending.
56
				   This variable is set to 0 when ccl is
57
				   set up.  */
Karl Heuer's avatar
Karl Heuer committed
58 59 60 61 62 63
  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.  */
64
  int stack_idx;		/* How deep the call of CCL_Call is nested.  */
65 66
  int src_multibyte;		/* 1 if the input buffer is multibyte.  */
  int dst_multibyte;		/* 1 if the output buffer is multibyte.  */
67 68 69 70
  int cr_consumed;		/* Flag for encoding DOS-like EOL
				   format when the CCL program is used
				   for encoding by a coding
				   system.  */
71 72
  int consumed;
  int produced;
73 74
  int suppress_error;		/* If nonzero, don't insert error
				   message in the output.  */
75 76 77 78 79
  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.  */
80 81 82
  int quit_silently;		/* If nonzero, don't append "CCL:
				   Quitted" to the generated text when
				   CCL program is quitted. */
Karl Heuer's avatar
Karl Heuer committed
83 84 85 86 87 88
};

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

struct ccl_spec {
89
  struct ccl_program ccl;
90
  int cr_carryover;		/* CR carryover flag.  */
91
  unsigned char eight_bit_carryover[MAX_MULTIBYTE_LENGTH];
Karl Heuer's avatar
Karl Heuer committed
92 93
};

94 95
#define CODING_SPEC_CCL_PROGRAM(coding) ((coding)->spec.ccl.ccl)

Karl Heuer's avatar
Karl Heuer committed
96 97 98
/* Alist of fontname patterns vs corresponding CCL program.  */
extern Lisp_Object Vfont_ccl_encoder_alist;

99
/* Setup fields of the structure pointed by CCL appropriately for the
100 101
   execution of ccl program CCL_PROG (symbol or vector).  */
extern int setup_ccl_program P_ ((struct ccl_program *, Lisp_Object));
102

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

106 107
extern void ccl_driver P_ ((struct ccl_program *, int *, int *, int, int,
			    Lisp_Object));
108

109 110 111 112 113 114 115
/* 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;

116 117 118 119 120 121 122
extern Lisp_Object Qccl, Qcclp;

EXFUN (Fccl_program_p, 1);

#define CHECK_CCL_PROGRAM(x)			\
  do {						\
    if (NILP (Fccl_program_p (x)))		\
123
      wrong_type_argument (Qcclp, (x));	\
124 125
  } while (0);

126
#endif /* EMACS_CCL_H */
Kenichi Handa's avatar
Kenichi Handa committed
127 128 129

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