ccl.h 3.3 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,
3
     2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012
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
This file is part of GNU Emacs.

12
GNU Emacs is free software: you can redistribute it and/or modify
Karl Heuer's avatar
Karl Heuer committed
13
it under the terms of the GNU General Public License as published by
14 15
the Free Software Foundation, either version 3 of the License, or
(at your option) 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
You should have received a copy of the GNU General Public License
23 24
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */

Karl Heuer's avatar
Karl Heuer committed
25

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

29 30 31 32 33 34 35 36
/* 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
37 38 39
/* Structure to hold information about running CCL code.  Read
   comments in the file ccl.c for the detail of each field.  */
struct ccl_program {
40
  ptrdiff_t idx;		/* Index number of the CCL program.
Kenichi Handa's avatar
Kenichi Handa committed
41 42 43
				   -1 means that the program was given
				   by a vector, not by a program
				   name.  */
Karl Heuer's avatar
Karl Heuer committed
44 45 46 47 48 49 50 51 52 53 54 55
  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.  */
  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.  */
56
  int stack_idx;		/* How deep the call of CCL_Call is nested.  */
57 58
  int consumed;
  int produced;
59 60 61
  bool_bf last_block : 1;	/* Set to true while processing the last
				   block. */
  bool_bf quit_silently : 1;	/* If true, don't append "CCL:
62 63
				   Quitted" to the generated text when
				   CCL program is quitted. */
Karl Heuer's avatar
Karl Heuer committed
64 65 66 67 68 69
};

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

struct ccl_spec {
70
  struct ccl_program ccl;
Karl Heuer's avatar
Karl Heuer committed
71 72
};

73 74
#define CODING_SPEC_CCL_PROGRAM(coding) ((coding)->spec.ccl.ccl)

75
/* Setup fields of the structure pointed by CCL appropriately for the
76
   execution of ccl program CCL_PROG (symbol or vector).  */
77
extern bool setup_ccl_program (struct ccl_program *, Lisp_Object);
78

Jan D's avatar
Jan D committed
79 80
extern void ccl_driver (struct ccl_program *, int *, int *, int, int,
                        Lisp_Object);
81

82 83 84
#define CHECK_CCL_PROGRAM(x)			\
  do {						\
    if (NILP (Fccl_program_p (x)))		\
85
      wrong_type_argument (Qcclp, (x));	\
86
  } while (false);
87

88
#endif /* EMACS_CCL_H */