Mercurial > hg > xemacs-beta
annotate src/mule-ccl.h @ 5159:cb303ff63e76
merge
| author | Ben Wing <ben@xemacs.org> |
|---|---|
| date | Fri, 19 Mar 2010 17:02:11 -0500 |
| parents | 0c54de4c4b9d |
| children | 308d34e9f07d |
| rev | line source |
|---|---|
| 428 | 1 /* Header for CCL (Code Conversion Language) interpreter. |
| 444 | 2 Copyright (C) 1995 Electrotechnical Laboratory, JAPAN. |
| 428 | 3 Licensed to the Free Software Foundation. |
| 4 | |
| 5 This file is part of XEmacs. | |
| 6 | |
| 613 | 7 XEmacs is free software; you can redistribute it and/or modify |
| 428 | 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 | |
| 613 | 12 XEmacs is distributed in the hope that it will be useful, |
| 428 | 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 | |
| 613 | 18 along with XEmacs; see the file COPYING. If not, write to |
| 428 | 19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330, |
| 20 Boston, MA 02111-1307, USA. */ | |
| 21 | |
| 440 | 22 #ifndef INCLUDED_mule_ccl_h_ |
| 23 #define INCLUDED_mule_ccl_h_ | |
| 428 | 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 | |
| 444 | 45 for private use, mainly for saving |
| 46 internal states on suspending. | |
| 428 | 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. */ | |
| 444 | 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 | |
| 59 system. */ | |
| 60 int multibyte; /* 1 if the source text is multibyte. */ | |
| 428 | 61 }; |
| 62 | |
| 63 #define CCL_MODE_ENCODING 0 | |
| 64 #define CCL_MODE_DECODING 1 | |
| 65 | |
| 444 | 66 #define CCL_CODING_EOL_LF 0 /* Line-feed only, same as Emacs' |
| 67 internal format. */ | |
| 68 #define CCL_CODING_EOL_CRLF 1 /* Sequence of carriage-return and | |
| 69 line-feed. */ | |
| 70 #define CCL_CODING_EOL_CR 2 /* Carriage-return only. */ | |
| 428 | 71 |
|
4745
0c54de4c4b9d
Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents:
613
diff
changeset
|
72 /* If OBJECT is symbol designating a registered CCL program, return it. |
|
0c54de4c4b9d
Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents:
613
diff
changeset
|
73 Else if OBJECT is a vector CCL program with no unresolved symbols, return |
|
0c54de4c4b9d
Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents:
613
diff
changeset
|
74 it. |
|
0c54de4c4b9d
Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents:
613
diff
changeset
|
75 Else, if OBJECT is a vector CCL program with unresolved symbols, return a |
|
0c54de4c4b9d
Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents:
613
diff
changeset
|
76 newly-created vector reflecting the CCL program with all symbols |
|
0c54de4c4b9d
Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents:
613
diff
changeset
|
77 resolved, if that is currently possible in this XEmacs. |
| 444 | 78 |
|
4745
0c54de4c4b9d
Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents:
613
diff
changeset
|
79 Otherwise, signal `invalid-argument'. */ |
|
0c54de4c4b9d
Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents:
613
diff
changeset
|
80 extern Lisp_Object get_ccl_program (Lisp_Object object); |
|
0c54de4c4b9d
Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents:
613
diff
changeset
|
81 |
|
0c54de4c4b9d
Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents:
613
diff
changeset
|
82 /* Set up fields of the structure pointed by CCL appropriately for the |
|
0c54de4c4b9d
Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents:
613
diff
changeset
|
83 execution of ccl program CCL_PROG (a symbol or a vector). |
|
0c54de4c4b9d
Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents:
613
diff
changeset
|
84 |
|
0c54de4c4b9d
Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents:
613
diff
changeset
|
85 If CCL_PROG is a vector and contains unresolved symbols, this function |
|
0c54de4c4b9d
Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents:
613
diff
changeset
|
86 will throw an assertion failure. To avoid this, call get_ccl_program at |
|
0c54de4c4b9d
Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents:
613
diff
changeset
|
87 the point that you receive the CCL program from Lisp, and use and store |
|
0c54de4c4b9d
Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents:
613
diff
changeset
|
88 its (resolved) result instead. */ |
|
0c54de4c4b9d
Resolve the unregistered-CCL-programs-get-garbage-collected problem correctly
Aidan Kehoe <kehoea@parhasard.net>
parents:
613
diff
changeset
|
89 extern int setup_ccl_program (struct ccl_program *, Lisp_Object ccl_prog); |
| 444 | 90 |
| 91 extern int ccl_driver (struct ccl_program *, const unsigned char *, | |
| 92 unsigned_char_dynarr *, int, int *, int); | |
| 93 | |
| 94 EXFUN (Fregister_ccl_program, 2); | |
| 95 | |
| 428 | 96 extern Lisp_Object Qccl_program; |
| 97 | |
| 444 | 98 /* Vector of CCL program names vs corresponding program data. */ |
| 99 extern Lisp_Object Vccl_program_table; | |
| 100 | |
| 101 /* Symbols of ccl program have this property, a value of the property | |
| 102 is an index for Vccl_program_table. */ | |
| 103 extern Lisp_Object Qccl_program_idx; | |
| 104 | |
| 440 | 105 #endif /* INCLUDED_mule_ccl_h_ */ |