Commit | Line | Data |
---|---|---|
4ed46869 | 1 | /* Header for CCL (Code Conversion Language) interpreter. |
7976eda0 | 2 | Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, |
5df4f04c | 3 | 2005, 2006, 2007, 2008, 2009, 2010, 2011 |
ce03bf76 KH |
4 | National Institute of Advanced Industrial Science and Technology (AIST) |
5 | Registration Number H14PRO021 | |
8f924df7 | 6 | Copyright (C) 2003 |
d2bc5a70 KH |
7 | National Institute of Advanced Industrial Science and Technology (AIST) |
8 | Registration Number H13PRO009 | |
4ed46869 | 9 | |
369314dc KH |
10 | This file is part of GNU Emacs. |
11 | ||
b9b1cc14 | 12 | GNU Emacs is free software: you can redistribute it and/or modify |
369314dc | 13 | it under the terms of the GNU General Public License as published by |
b9b1cc14 GM |
14 | the Free Software Foundation, either version 3 of the License, or |
15 | (at your option) any later version. | |
4ed46869 | 16 | |
369314dc KH |
17 | GNU Emacs is distributed in the hope that it will be useful, |
18 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
20 | GNU General Public License for more details. | |
4ed46869 | 21 | |
369314dc | 22 | You should have received a copy of the GNU General Public License |
b9b1cc14 GM |
23 | along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */ |
24 | ||
4ed46869 | 25 | |
265702b7 KH |
26 | #ifndef EMACS_CCL_H |
27 | #define EMACS_CCL_H | |
4ed46869 | 28 | |
eacba247 KH |
29 | /* Macros for exit status of CCL program. */ |
30 | #define CCL_STAT_SUCCESS 0 /* Terminated successfully. */ | |
31 | #define CCL_STAT_SUSPEND_BY_SRC 1 /* Terminated by empty input. */ | |
32 | #define CCL_STAT_SUSPEND_BY_DST 2 /* Terminated by output buffer full. */ | |
33 | #define CCL_STAT_INVALID_CMD 3 /* Terminated because of invalid | |
34 | command. */ | |
35 | #define CCL_STAT_QUIT 4 /* Terminated because of quit. */ | |
36 | ||
4ed46869 KH |
37 | /* Structure to hold information about running CCL code. Read |
38 | comments in the file ccl.c for the detail of each field. */ | |
39 | struct ccl_program { | |
7cf49add KH |
40 | int idx; /* Index number of the CCL program. |
41 | -1 means that the program was given | |
42 | by a vector, not by a program | |
43 | name. */ | |
4ed46869 KH |
44 | int size; /* Size of the compiled code. */ |
45 | Lisp_Object *prog; /* Pointer into the compiled code. */ | |
46 | int ic; /* Instruction Counter (index for PROG). */ | |
47 | int eof_ic; /* Instruction Counter for end-of-file | |
48 | processing code. */ | |
49 | int reg[8]; /* CCL registers, reg[7] is used for | |
50 | condition flag of relational | |
51 | operations. */ | |
eacba247 | 52 | int private_state; /* CCL instruction may use this |
975ddbf5 KH |
53 | for private use, mainly for saving |
54 | internal states on suspending. | |
177c0ea7 | 55 | This variable is set to 0 when ccl is |
eacba247 | 56 | set up. */ |
4ed46869 KH |
57 | int last_block; /* Set to 1 while processing the last |
58 | block. */ | |
59 | int status; /* Exit status of the CCL program. */ | |
60 | int buf_magnification; /* Output buffer magnification. How | |
61 | many times bigger the output buffer | |
62 | should be than the input buffer. */ | |
e05645ee | 63 | int stack_idx; /* How deep the call of CCL_Call is nested. */ |
d2bc5a70 KH |
64 | int src_multibyte; /* 1 if the input buffer is multibyte. */ |
65 | int dst_multibyte; /* 1 if the output buffer is multibyte. */ | |
f455f068 KH |
66 | int cr_consumed; /* Flag for encoding DOS-like EOL |
67 | format when the CCL program is used | |
68 | for encoding by a coding | |
69 | system. */ | |
d2bc5a70 KH |
70 | int consumed; |
71 | int produced; | |
64068fbf KH |
72 | int suppress_error; /* If nonzero, don't insert error |
73 | message in the output. */ | |
034060e4 KH |
74 | int eight_bit_control; /* If nonzero, ccl_driver counts all |
75 | eight-bit-control bytes written by | |
76 | CCL_WRITE_CHAR. After execution, | |
77 | if no such byte is written, set | |
78 | this value to zero. */ | |
7a1dd8de KH |
79 | int quit_silently; /* If nonzero, don't append "CCL: |
80 | Quitted" to the generated text when | |
81 | CCL program is quitted. */ | |
4ed46869 KH |
82 | }; |
83 | ||
84 | /* This data type is used for the spec field of the structure | |
85 | coding_system. */ | |
86 | ||
87 | struct ccl_spec { | |
d2bc5a70 | 88 | struct ccl_program ccl; |
8538ed9a | 89 | int cr_carryover; /* CR carryover flag. */ |
898f3312 | 90 | unsigned char eight_bit_carryover[MAX_MULTIBYTE_LENGTH]; |
4ed46869 KH |
91 | }; |
92 | ||
d2bc5a70 KH |
93 | #define CODING_SPEC_CCL_PROGRAM(coding) ((coding)->spec.ccl.ccl) |
94 | ||
58068210 | 95 | /* Setup fields of the structure pointed by CCL appropriately for the |
e5e6d6fb | 96 | execution of ccl program CCL_PROG (symbol or vector). */ |
383e0970 | 97 | extern int setup_ccl_program (struct ccl_program *, Lisp_Object); |
58068210 | 98 | |
7cf49add | 99 | /* Check if CCL is updated or not. If not, re-setup members of CCL. */ |
383e0970 | 100 | extern int check_ccl_update (struct ccl_program *); |
7cf49add | 101 | |
383e0970 J |
102 | extern void ccl_driver (struct ccl_program *, int *, int *, int, int, |
103 | Lisp_Object); | |
58068210 | 104 | |
1cfae2bf KH |
105 | /* Vector of CCL program names vs corresponding program data. */ |
106 | extern Lisp_Object Vccl_program_table; | |
107 | ||
108 | /* Symbols of ccl program have this property, a value of the property | |
109 | is an index for Vccl_protram_table. */ | |
110 | extern Lisp_Object Qccl_program_idx; | |
111 | ||
d2bc5a70 KH |
112 | extern Lisp_Object Qccl, Qcclp; |
113 | ||
114 | EXFUN (Fccl_program_p, 1); | |
115 | ||
116 | #define CHECK_CCL_PROGRAM(x) \ | |
117 | do { \ | |
118 | if (NILP (Fccl_program_p (x))) \ | |
02dfeba8 | 119 | wrong_type_argument (Qcclp, (x)); \ |
d2bc5a70 KH |
120 | } while (0); |
121 | ||
265702b7 | 122 | #endif /* EMACS_CCL_H */ |
6b61353c | 123 |