| 1 | /* Header for CCL (Code Conversion Language) interpreter. |
| 2 | Copyright (C) 1995 Electrotechnical Laboratory, JAPAN. |
| 3 | Licensed to the Free Software Foundation. |
| 4 | |
| 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. |
| 11 | |
| 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. |
| 16 | |
| 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. */ |
| 21 | |
| 22 | #ifndef _CCL_H |
| 23 | #define _CCL_H |
| 24 | |
| 25 | /* Macros for exit status of CCL program. */ |
| 26 | #define CCL_STAT_SUCCESS 0 /* Terminated successfully. */ |
| 27 | #define CCL_STAT_SUSPEND_BY_SRC 1 /* Terminated by empty input. */ |
| 28 | #define CCL_STAT_SUSPEND_BY_DST 2 /* Terminated by output buffer full. */ |
| 29 | #define CCL_STAT_INVALID_CMD 3 /* Terminated because of invalid |
| 30 | command. */ |
| 31 | #define CCL_STAT_QUIT 4 /* Terminated because of quit. */ |
| 32 | |
| 33 | /* Structure to hold information about running CCL code. Read |
| 34 | comments in the file ccl.c for the detail of each field. */ |
| 35 | struct ccl_program { |
| 36 | int size; /* Size of the compiled code. */ |
| 37 | Lisp_Object *prog; /* Pointer into the compiled code. */ |
| 38 | int ic; /* Instruction Counter (index for PROG). */ |
| 39 | int eof_ic; /* Instruction Counter for end-of-file |
| 40 | processing code. */ |
| 41 | int reg[8]; /* CCL registers, reg[7] is used for |
| 42 | condition flag of relational |
| 43 | operations. */ |
| 44 | int private_state; /* CCL instruction may use this |
| 45 | for private use, mainly for preservation |
| 46 | internal states for suspending. |
| 47 | This variable is set to 0 when ccl is |
| 48 | set up. */ |
| 49 | int last_block; /* Set to 1 while processing the last |
| 50 | block. */ |
| 51 | int status; /* Exit status of the CCL program. */ |
| 52 | int buf_magnification; /* Output buffer magnification. How |
| 53 | many times bigger the output buffer |
| 54 | should be than the input buffer. */ |
| 55 | int stack_idx; /* How deep the call of CCL_Call is nested. */ |
| 56 | }; |
| 57 | |
| 58 | /* This data type is used for the spec field of the structure |
| 59 | coding_system. */ |
| 60 | |
| 61 | struct ccl_spec { |
| 62 | struct ccl_program decoder; |
| 63 | struct ccl_program encoder; |
| 64 | unsigned char valid_codes[256]; |
| 65 | }; |
| 66 | |
| 67 | /* Alist of fontname patterns vs corresponding CCL program. */ |
| 68 | extern Lisp_Object Vfont_ccl_encoder_alist; |
| 69 | |
| 70 | /* Setup fields of the structure pointed by CCL appropriately for the |
| 71 | execution of ccl program CCL_PROG (symbol or vector). */ |
| 72 | extern int setup_ccl_program P_ ((struct ccl_program *, Lisp_Object)); |
| 73 | |
| 74 | extern int ccl_driver P_ ((struct ccl_program *, unsigned char *, |
| 75 | unsigned char *, int, int, int *)); |
| 76 | |
| 77 | /* Vector of CCL program names vs corresponding program data. */ |
| 78 | extern Lisp_Object Vccl_program_table; |
| 79 | |
| 80 | /* Symbols of ccl program have this property, a value of the property |
| 81 | is an index for Vccl_protram_table. */ |
| 82 | extern Lisp_Object Qccl_program_idx; |
| 83 | |
| 84 | #endif /* _CCL_H */ |