annotate src/ccl.h @ 89300:6a0cc62928b5

(lao-post-read-conversion): Delete this function. (lao-composition-function): Change arguments to conform to composition-function-table.
author Kenichi Handa <handa@m17n.org>
date Thu, 07 Nov 2002 06:31:37 +0000
parents 8ced48c5d267
children 0c4fd9081174
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
17052
d0d7b244b1d0 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
1 /* Header for CCL (Code Conversion Language) interpreter.
d0d7b244b1d0 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
2 Copyright (C) 1995 Electrotechnical Laboratory, JAPAN.
18341
33e78cc7f058 Change copyright notices.
Richard M. Stallman <rms@gnu.org>
parents: 17071
diff changeset
3 Licensed to the Free Software Foundation.
88362
8ced48c5d267 (struct ccl_program): Members eol_type and multibyte
Kenichi Handa <handa@m17n.org>
parents: 36412
diff changeset
4 Copyright (C) 2001, 2002
8ced48c5d267 (struct ccl_program): Members eol_type and multibyte
Kenichi Handa <handa@m17n.org>
parents: 36412
diff changeset
5 National Institute of Advanced Industrial Science and Technology (AIST)
8ced48c5d267 (struct ccl_program): Members eol_type and multibyte
Kenichi Handa <handa@m17n.org>
parents: 36412
diff changeset
6 Registration Number H13PRO009
17052
d0d7b244b1d0 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
7
17071
70194012fb3a Fix FSF address in comment.
Karl Heuer <kwzh@gnu.org>
parents: 17052
diff changeset
8 This file is part of GNU Emacs.
70194012fb3a Fix FSF address in comment.
Karl Heuer <kwzh@gnu.org>
parents: 17052
diff changeset
9
70194012fb3a Fix FSF address in comment.
Karl Heuer <kwzh@gnu.org>
parents: 17052
diff changeset
10 GNU Emacs is free software; you can redistribute it and/or modify
70194012fb3a Fix FSF address in comment.
Karl Heuer <kwzh@gnu.org>
parents: 17052
diff changeset
11 it under the terms of the GNU General Public License as published by
70194012fb3a Fix FSF address in comment.
Karl Heuer <kwzh@gnu.org>
parents: 17052
diff changeset
12 the Free Software Foundation; either version 2, or (at your option)
70194012fb3a Fix FSF address in comment.
Karl Heuer <kwzh@gnu.org>
parents: 17052
diff changeset
13 any later version.
17052
d0d7b244b1d0 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
14
17071
70194012fb3a Fix FSF address in comment.
Karl Heuer <kwzh@gnu.org>
parents: 17052
diff changeset
15 GNU Emacs is distributed in the hope that it will be useful,
70194012fb3a Fix FSF address in comment.
Karl Heuer <kwzh@gnu.org>
parents: 17052
diff changeset
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
70194012fb3a Fix FSF address in comment.
Karl Heuer <kwzh@gnu.org>
parents: 17052
diff changeset
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
70194012fb3a Fix FSF address in comment.
Karl Heuer <kwzh@gnu.org>
parents: 17052
diff changeset
18 GNU General Public License for more details.
17052
d0d7b244b1d0 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
19
17071
70194012fb3a Fix FSF address in comment.
Karl Heuer <kwzh@gnu.org>
parents: 17052
diff changeset
20 You should have received a copy of the GNU General Public License
70194012fb3a Fix FSF address in comment.
Karl Heuer <kwzh@gnu.org>
parents: 17052
diff changeset
21 along with GNU Emacs; see the file COPYING. If not, write to
70194012fb3a Fix FSF address in comment.
Karl Heuer <kwzh@gnu.org>
parents: 17052
diff changeset
22 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
70194012fb3a Fix FSF address in comment.
Karl Heuer <kwzh@gnu.org>
parents: 17052
diff changeset
23 Boston, MA 02111-1307, USA. */
17052
d0d7b244b1d0 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
24
29569
2d148b8db59b (EMACS_CCL_H): Renamed from _CCL_H.
Kenichi Handa <handa@m17n.org>
parents: 25065
diff changeset
25 #ifndef EMACS_CCL_H
2d148b8db59b (EMACS_CCL_H): Renamed from _CCL_H.
Kenichi Handa <handa@m17n.org>
parents: 25065
diff changeset
26 #define EMACS_CCL_H
17052
d0d7b244b1d0 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
27
20721
b5b97880b7d0 Definition of macros CCL_STAT_XXX are moved from ccl.c to here.
Kenichi Handa <handa@m17n.org>
parents: 20306
diff changeset
28 /* Macros for exit status of CCL program. */
b5b97880b7d0 Definition of macros CCL_STAT_XXX are moved from ccl.c to here.
Kenichi Handa <handa@m17n.org>
parents: 20306
diff changeset
29 #define CCL_STAT_SUCCESS 0 /* Terminated successfully. */
b5b97880b7d0 Definition of macros CCL_STAT_XXX are moved from ccl.c to here.
Kenichi Handa <handa@m17n.org>
parents: 20306
diff changeset
30 #define CCL_STAT_SUSPEND_BY_SRC 1 /* Terminated by empty input. */
b5b97880b7d0 Definition of macros CCL_STAT_XXX are moved from ccl.c to here.
Kenichi Handa <handa@m17n.org>
parents: 20306
diff changeset
31 #define CCL_STAT_SUSPEND_BY_DST 2 /* Terminated by output buffer full. */
b5b97880b7d0 Definition of macros CCL_STAT_XXX are moved from ccl.c to here.
Kenichi Handa <handa@m17n.org>
parents: 20306
diff changeset
32 #define CCL_STAT_INVALID_CMD 3 /* Terminated because of invalid
b5b97880b7d0 Definition of macros CCL_STAT_XXX are moved from ccl.c to here.
Kenichi Handa <handa@m17n.org>
parents: 20306
diff changeset
33 command. */
b5b97880b7d0 Definition of macros CCL_STAT_XXX are moved from ccl.c to here.
Kenichi Handa <handa@m17n.org>
parents: 20306
diff changeset
34 #define CCL_STAT_QUIT 4 /* Terminated because of quit. */
b5b97880b7d0 Definition of macros CCL_STAT_XXX are moved from ccl.c to here.
Kenichi Handa <handa@m17n.org>
parents: 20306
diff changeset
35
17052
d0d7b244b1d0 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
36 /* Structure to hold information about running CCL code. Read
d0d7b244b1d0 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
37 comments in the file ccl.c for the detail of each field. */
d0d7b244b1d0 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
38 struct ccl_program {
d0d7b244b1d0 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
39 int size; /* Size of the compiled code. */
d0d7b244b1d0 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
40 Lisp_Object *prog; /* Pointer into the compiled code. */
d0d7b244b1d0 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
41 int ic; /* Instruction Counter (index for PROG). */
d0d7b244b1d0 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
42 int eof_ic; /* Instruction Counter for end-of-file
d0d7b244b1d0 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
43 processing code. */
d0d7b244b1d0 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
44 int reg[8]; /* CCL registers, reg[7] is used for
d0d7b244b1d0 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
45 condition flag of relational
d0d7b244b1d0 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
46 operations. */
20721
b5b97880b7d0 Definition of macros CCL_STAT_XXX are moved from ccl.c to here.
Kenichi Handa <handa@m17n.org>
parents: 20306
diff changeset
47 int private_state; /* CCL instruction may use this
30755
c9a72e24976c (struct ccl_program): New member multibyte.
Kenichi Handa <handa@m17n.org>
parents: 29723
diff changeset
48 for private use, mainly for saving
c9a72e24976c (struct ccl_program): New member multibyte.
Kenichi Handa <handa@m17n.org>
parents: 29723
diff changeset
49 internal states on suspending.
20721
b5b97880b7d0 Definition of macros CCL_STAT_XXX are moved from ccl.c to here.
Kenichi Handa <handa@m17n.org>
parents: 20306
diff changeset
50 This variable is set to 0 when ccl is
b5b97880b7d0 Definition of macros CCL_STAT_XXX are moved from ccl.c to here.
Kenichi Handa <handa@m17n.org>
parents: 20306
diff changeset
51 set up. */
17052
d0d7b244b1d0 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
52 int last_block; /* Set to 1 while processing the last
d0d7b244b1d0 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
53 block. */
d0d7b244b1d0 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
54 int status; /* Exit status of the CCL program. */
d0d7b244b1d0 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
55 int buf_magnification; /* Output buffer magnification. How
d0d7b244b1d0 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
56 many times bigger the output buffer
d0d7b244b1d0 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
57 should be than the input buffer. */
24689
46d2dc61ec31 (struct ccl_program): New member stack_idx.
Kenichi Handa <handa@m17n.org>
parents: 22875
diff changeset
58 int stack_idx; /* How deep the call of CCL_Call is nested. */
88362
8ced48c5d267 (struct ccl_program): Members eol_type and multibyte
Kenichi Handa <handa@m17n.org>
parents: 36412
diff changeset
59 int src_multibyte; /* 1 if the input buffer is multibyte. */
8ced48c5d267 (struct ccl_program): Members eol_type and multibyte
Kenichi Handa <handa@m17n.org>
parents: 36412
diff changeset
60 int dst_multibyte; /* 1 if the output buffer is multibyte. */
34817
41f50ad22d7a (struct ccl_program): New member cr_consumed.
Kenichi Handa <handa@m17n.org>
parents: 30755
diff changeset
61 int cr_consumed; /* Flag for encoding DOS-like EOL
41f50ad22d7a (struct ccl_program): New member cr_consumed.
Kenichi Handa <handa@m17n.org>
parents: 30755
diff changeset
62 format when the CCL program is used
41f50ad22d7a (struct ccl_program): New member cr_consumed.
Kenichi Handa <handa@m17n.org>
parents: 30755
diff changeset
63 for encoding by a coding
29723
9d85d8264c59 (struct ccl_program): New member eol_type.
Kenichi Handa <handa@m17n.org>
parents: 29569
diff changeset
64 system. */
88362
8ced48c5d267 (struct ccl_program): Members eol_type and multibyte
Kenichi Handa <handa@m17n.org>
parents: 36412
diff changeset
65 int consumed;
8ced48c5d267 (struct ccl_program): Members eol_type and multibyte
Kenichi Handa <handa@m17n.org>
parents: 36412
diff changeset
66 int produced;
35528
4ca44cbfa530 (sturct ccl_program): New member suppress_error.
Kenichi Handa <handa@m17n.org>
parents: 34891
diff changeset
67 int suppress_error; /* If nonzero, don't insert error
4ca44cbfa530 (sturct ccl_program): New member suppress_error.
Kenichi Handa <handa@m17n.org>
parents: 34891
diff changeset
68 message in the output. */
36412
4fbcbbb88ef0 (struct ccl_program): New member eight_bit_control.
Kenichi Handa <handa@m17n.org>
parents: 35528
diff changeset
69 int eight_bit_control; /* Set to nonzero if CCL_WRITE_CHAR
4fbcbbb88ef0 (struct ccl_program): New member eight_bit_control.
Kenichi Handa <handa@m17n.org>
parents: 35528
diff changeset
70 writes eight-bit-control char. */
17052
d0d7b244b1d0 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
71 };
d0d7b244b1d0 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
72
d0d7b244b1d0 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
73 /* This data type is used for the spec field of the structure
d0d7b244b1d0 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
74 coding_system. */
d0d7b244b1d0 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
75
d0d7b244b1d0 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
76 struct ccl_spec {
88362
8ced48c5d267 (struct ccl_program): Members eol_type and multibyte
Kenichi Handa <handa@m17n.org>
parents: 36412
diff changeset
77 struct ccl_program ccl;
29723
9d85d8264c59 (struct ccl_program): New member eol_type.
Kenichi Handa <handa@m17n.org>
parents: 29569
diff changeset
78 int cr_carryover; /* CR carryover flag. */
34891
b9b14e62fe38 (struct ccl_spec): New member eight_bit_carryover.
Kenichi Handa <handa@m17n.org>
parents: 34817
diff changeset
79 unsigned char eight_bit_carryover[MAX_MULTIBYTE_LENGTH];
17052
d0d7b244b1d0 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
80 };
d0d7b244b1d0 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
81
88362
8ced48c5d267 (struct ccl_program): Members eol_type and multibyte
Kenichi Handa <handa@m17n.org>
parents: 36412
diff changeset
82 #define CODING_SPEC_CCL_PROGRAM(coding) ((coding)->spec.ccl.ccl)
8ced48c5d267 (struct ccl_program): Members eol_type and multibyte
Kenichi Handa <handa@m17n.org>
parents: 36412
diff changeset
83
17052
d0d7b244b1d0 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
84 /* Alist of fontname patterns vs corresponding CCL program. */
d0d7b244b1d0 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
85 extern Lisp_Object Vfont_ccl_encoder_alist;
d0d7b244b1d0 Initial revision
Karl Heuer <kwzh@gnu.org>
parents:
diff changeset
86
20306
275d6855275a Add declaration of setup_ccl_program and ccl_driver.
Andreas Schwab <schwab@suse.de>
parents: 18341
diff changeset
87 /* Setup fields of the structure pointed by CCL appropriately for the
25065
6f92f7a071c9 (setup_ccl_program): The type is changed to `int'.
Kenichi Handa <handa@m17n.org>
parents: 24689
diff changeset
88 execution of ccl program CCL_PROG (symbol or vector). */
6f92f7a071c9 (setup_ccl_program): The type is changed to `int'.
Kenichi Handa <handa@m17n.org>
parents: 24689
diff changeset
89 extern int setup_ccl_program P_ ((struct ccl_program *, Lisp_Object));
20306
275d6855275a Add declaration of setup_ccl_program and ccl_driver.
Andreas Schwab <schwab@suse.de>
parents: 18341
diff changeset
90
88362
8ced48c5d267 (struct ccl_program): Members eol_type and multibyte
Kenichi Handa <handa@m17n.org>
parents: 36412
diff changeset
91 extern void ccl_driver P_ ((struct ccl_program *, int *, int *, int, int));
20306
275d6855275a Add declaration of setup_ccl_program and ccl_driver.
Andreas Schwab <schwab@suse.de>
parents: 18341
diff changeset
92
21550
dddb0d1318aa (Vccl_program_table, Qccl_program_idx): Extern them.
Kenichi Handa <handa@m17n.org>
parents: 20721
diff changeset
93 /* Vector of CCL program names vs corresponding program data. */
dddb0d1318aa (Vccl_program_table, Qccl_program_idx): Extern them.
Kenichi Handa <handa@m17n.org>
parents: 20721
diff changeset
94 extern Lisp_Object Vccl_program_table;
dddb0d1318aa (Vccl_program_table, Qccl_program_idx): Extern them.
Kenichi Handa <handa@m17n.org>
parents: 20721
diff changeset
95
dddb0d1318aa (Vccl_program_table, Qccl_program_idx): Extern them.
Kenichi Handa <handa@m17n.org>
parents: 20721
diff changeset
96 /* Symbols of ccl program have this property, a value of the property
dddb0d1318aa (Vccl_program_table, Qccl_program_idx): Extern them.
Kenichi Handa <handa@m17n.org>
parents: 20721
diff changeset
97 is an index for Vccl_protram_table. */
dddb0d1318aa (Vccl_program_table, Qccl_program_idx): Extern them.
Kenichi Handa <handa@m17n.org>
parents: 20721
diff changeset
98 extern Lisp_Object Qccl_program_idx;
dddb0d1318aa (Vccl_program_table, Qccl_program_idx): Extern them.
Kenichi Handa <handa@m17n.org>
parents: 20721
diff changeset
99
88362
8ced48c5d267 (struct ccl_program): Members eol_type and multibyte
Kenichi Handa <handa@m17n.org>
parents: 36412
diff changeset
100 extern Lisp_Object Qccl, Qcclp;
8ced48c5d267 (struct ccl_program): Members eol_type and multibyte
Kenichi Handa <handa@m17n.org>
parents: 36412
diff changeset
101
8ced48c5d267 (struct ccl_program): Members eol_type and multibyte
Kenichi Handa <handa@m17n.org>
parents: 36412
diff changeset
102 EXFUN (Fccl_program_p, 1);
8ced48c5d267 (struct ccl_program): Members eol_type and multibyte
Kenichi Handa <handa@m17n.org>
parents: 36412
diff changeset
103
8ced48c5d267 (struct ccl_program): Members eol_type and multibyte
Kenichi Handa <handa@m17n.org>
parents: 36412
diff changeset
104 #define CHECK_CCL_PROGRAM(x) \
8ced48c5d267 (struct ccl_program): Members eol_type and multibyte
Kenichi Handa <handa@m17n.org>
parents: 36412
diff changeset
105 do { \
8ced48c5d267 (struct ccl_program): Members eol_type and multibyte
Kenichi Handa <handa@m17n.org>
parents: 36412
diff changeset
106 if (NILP (Fccl_program_p (x))) \
8ced48c5d267 (struct ccl_program): Members eol_type and multibyte
Kenichi Handa <handa@m17n.org>
parents: 36412
diff changeset
107 x = wrong_type_argument (Qcclp, (x)); \
8ced48c5d267 (struct ccl_program): Members eol_type and multibyte
Kenichi Handa <handa@m17n.org>
parents: 36412
diff changeset
108 } while (0);
8ced48c5d267 (struct ccl_program): Members eol_type and multibyte
Kenichi Handa <handa@m17n.org>
parents: 36412
diff changeset
109
29569
2d148b8db59b (EMACS_CCL_H): Renamed from _CCL_H.
Kenichi Handa <handa@m17n.org>
parents: 25065
diff changeset
110 #endif /* EMACS_CCL_H */