*** empty log message ***
[emacs.git] / src / ccl.h
blobcda611007f872095e4bed45c7610cde2e1b8d5f4
1 /* Header for CCL (Code Conversion Language) interpreter.
2 Copyright (C) 1995 Electrotechnical Laboratory, JAPAN.
3 Licensed to the Free Software Foundation.
5 This file is part of GNU Emacs.
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.
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.
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. */
22 #ifndef EMACS_CCL_H
23 #define EMACS_CCL_H
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. */
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 saving
46 internal states on 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 int eol_type; /* When the CCL program is used for
57 encoding by a coding system, set to
58 the eol_type of the coding system.
59 In other cases, always
60 CODING_EOL_LF. */
61 int multibyte; /* 1 if the source text is multibyte. */
62 int cr_consumed; /* Flag for encoding DOS-like EOL
63 format when the CCL program is used
64 for encoding by a coding
65 system. */
66 int suppress_error; /* If nonzero, don't insert error
67 message in the output. */
68 int eight_bit_control; /* If nonzero, ccl_driver counts all
69 eight-bit-control bytes written by
70 CCL_WRITE_CHAR. After execution,
71 if no such byte is written, set
72 this value to zero. */
75 /* This data type is used for the spec field of the structure
76 coding_system. */
78 struct ccl_spec {
79 struct ccl_program decoder;
80 struct ccl_program encoder;
81 unsigned char valid_codes[256];
82 int cr_carryover; /* CR carryover flag. */
83 unsigned char eight_bit_carryover[MAX_MULTIBYTE_LENGTH];
86 /* Alist of fontname patterns vs corresponding CCL program. */
87 extern Lisp_Object Vfont_ccl_encoder_alist;
89 /* Setup fields of the structure pointed by CCL appropriately for the
90 execution of ccl program CCL_PROG (symbol or vector). */
91 extern int setup_ccl_program P_ ((struct ccl_program *, Lisp_Object));
93 extern int ccl_driver P_ ((struct ccl_program *, unsigned char *,
94 unsigned char *, int, int, int *));
96 /* Vector of CCL program names vs corresponding program data. */
97 extern Lisp_Object Vccl_program_table;
99 /* Symbols of ccl program have this property, a value of the property
100 is an index for Vccl_protram_table. */
101 extern Lisp_Object Qccl_program_idx;
103 #endif /* EMACS_CCL_H */
105 /* arch-tag: 14681df7-876d-43de-bc71-6b78e23a4e3c
106 (do not change this comment) */