1 /* CCL (Code Conversion Language) interpreter.
2 Copyright (C) 2001, 2002, 2003, 2004, 2005,
3 2006, 2007, 2008 Free Software Foundation, Inc.
4 Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
6 National Institute of Advanced Industrial Science and Technology (AIST)
7 Registration Number H14PRO021
9 National Institute of Advanced Industrial Science and Technology (AIST)
10 Registration Number H13PRO009
12 This file is part of GNU Emacs.
14 GNU Emacs is free software; you can redistribute it and/or modify
15 it under the terms of the GNU General Public License as published by
16 the Free Software Foundation; either version 3, or (at your option)
19 GNU Emacs is distributed in the hope that it will be useful,
20 but WITHOUT ANY WARRANTY; without even the implied warranty of
21 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 GNU General Public License for more details.
24 You should have received a copy of the GNU General Public License
25 along with GNU Emacs; see the file COPYING. If not, write to
26 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
27 Boston, MA 02110-1301, USA. */
34 #include "character.h"
39 Lisp_Object Qccl
, Qcclp
;
41 /* This contains all code conversion map available to CCL. */
42 Lisp_Object Vcode_conversion_map_vector
;
44 /* Alist of fontname patterns vs corresponding CCL program. */
45 Lisp_Object Vfont_ccl_encoder_alist
;
47 /* This symbol is a property which assocates with ccl program vector.
48 Ex: (get 'ccl-big5-encoder 'ccl-program) returns ccl program vector. */
49 Lisp_Object Qccl_program
;
51 /* These symbols are properties which associate with code conversion
52 map and their ID respectively. */
53 Lisp_Object Qcode_conversion_map
;
54 Lisp_Object Qcode_conversion_map_id
;
56 /* Symbols of ccl program have this property, a value of the property
57 is an index for Vccl_protram_table. */
58 Lisp_Object Qccl_program_idx
;
60 /* Table of registered CCL programs. Each element is a vector of
61 NAME, CCL_PROG, RESOLVEDP, and UPDATEDP, where NAME (symbol) is the
62 name of the program, CCL_PROG (vector) is the compiled code of the
63 program, RESOLVEDP (t or nil) is the flag to tell if symbols in
64 CCL_PROG is already resolved to index numbers or not, UPDATEDP (t
65 or nil) is the flat to tell if the CCL program is updated after it
67 Lisp_Object Vccl_program_table
;
69 /* Vector of registered hash tables for translation. */
70 Lisp_Object Vtranslation_hash_table_vector
;
72 /* Return a hash table of id number ID. */
73 #define GET_HASH_TABLE(id) \
74 (XHASH_TABLE (XCDR(XVECTOR(Vtranslation_hash_table_vector)->contents[(id)])))
76 extern int charset_unicode
;
78 /* CCL (Code Conversion Language) is a simple language which has
79 operations on one input buffer, one output buffer, and 7 registers.
80 The syntax of CCL is described in `ccl.el'. Emacs Lisp function
81 `ccl-compile' compiles a CCL program and produces a CCL code which
82 is a vector of integers. The structure of this vector is as
83 follows: The 1st element: buffer-magnification, a factor for the
84 size of output buffer compared with the size of input buffer. The
85 2nd element: address of CCL code to be executed when encountered
86 with end of input stream. The 3rd and the remaining elements: CCL
89 /* Header of CCL compiled code */
90 #define CCL_HEADER_BUF_MAG 0
91 #define CCL_HEADER_EOF 1
92 #define CCL_HEADER_MAIN 2
94 /* CCL code is a sequence of 28-bit non-negative integers (i.e. the
95 MSB is always 0), each contains CCL command and/or arguments in the
98 |----------------- integer (28-bit) ------------------|
99 |------- 17-bit ------|- 3-bit --|- 3-bit --|- 5-bit -|
100 |--constant argument--|-register-|-register-|-command-|
101 ccccccccccccccccc RRR rrr XXXXX
103 |------- relative address -------|-register-|-command-|
104 cccccccccccccccccccc rrr XXXXX
106 |------------- constant or other args ----------------|
107 cccccccccccccccccccccccccccc
109 where, `cc...c' is a non-negative integer indicating constant value
110 (the left most `c' is always 0) or an absolute jump address, `RRR'
111 and `rrr' are CCL register number, `XXXXX' is one of the following
116 Each comment fields shows one or more lines for command syntax and
117 the following lines for semantics of the command. In semantics, IC
118 stands for Instruction Counter. */
120 #define CCL_SetRegister 0x00 /* Set register a register value:
121 1:00000000000000000RRRrrrXXXXX
122 ------------------------------
126 #define CCL_SetShortConst 0x01 /* Set register a short constant value:
127 1:CCCCCCCCCCCCCCCCCCCCrrrXXXXX
128 ------------------------------
129 reg[rrr] = CCCCCCCCCCCCCCCCCCC;
132 #define CCL_SetConst 0x02 /* Set register a constant value:
133 1:00000000000000000000rrrXXXXX
135 ------------------------------
140 #define CCL_SetArray 0x03 /* Set register an element of array:
141 1:CCCCCCCCCCCCCCCCCRRRrrrXXXXX
145 ------------------------------
146 if (0 <= reg[RRR] < CC..C)
147 reg[rrr] = ELEMENT[reg[RRR]];
151 #define CCL_Jump 0x04 /* Jump:
152 1:A--D--D--R--E--S--S-000XXXXX
153 ------------------------------
157 /* Note: If CC..C is greater than 0, the second code is omitted. */
159 #define CCL_JumpCond 0x05 /* Jump conditional:
160 1:A--D--D--R--E--S--S-rrrXXXXX
161 ------------------------------
167 #define CCL_WriteRegisterJump 0x06 /* Write register and jump:
168 1:A--D--D--R--E--S--S-rrrXXXXX
169 ------------------------------
174 #define CCL_WriteRegisterReadJump 0x07 /* Write register, read, and jump:
175 1:A--D--D--R--E--S--S-rrrXXXXX
176 2:A--D--D--R--E--S--S-rrrYYYYY
177 -----------------------------
183 /* Note: If read is suspended, the resumed execution starts from the
184 second code (YYYYY == CCL_ReadJump). */
186 #define CCL_WriteConstJump 0x08 /* Write constant and jump:
187 1:A--D--D--R--E--S--S-000XXXXX
189 ------------------------------
194 #define CCL_WriteConstReadJump 0x09 /* Write constant, read, and jump:
195 1:A--D--D--R--E--S--S-rrrXXXXX
197 3:A--D--D--R--E--S--S-rrrYYYYY
198 -----------------------------
204 /* Note: If read is suspended, the resumed execution starts from the
205 second code (YYYYY == CCL_ReadJump). */
207 #define CCL_WriteStringJump 0x0A /* Write string and jump:
208 1:A--D--D--R--E--S--S-000XXXXX
210 3:000MSTRIN[0]STRIN[1]STRIN[2]
212 ------------------------------
214 write_multibyte_string (STRING, LENGTH);
216 write_string (STRING, LENGTH);
220 #define CCL_WriteArrayReadJump 0x0B /* Write an array element, read, and jump:
221 1:A--D--D--R--E--S--S-rrrXXXXX
226 N:A--D--D--R--E--S--S-rrrYYYYY
227 ------------------------------
228 if (0 <= reg[rrr] < LENGTH)
229 write (ELEMENT[reg[rrr]]);
230 IC += LENGTH + 2; (... pointing at N+1)
234 /* Note: If read is suspended, the resumed execution starts from the
235 Nth code (YYYYY == CCL_ReadJump). */
237 #define CCL_ReadJump 0x0C /* Read and jump:
238 1:A--D--D--R--E--S--S-rrrYYYYY
239 -----------------------------
244 #define CCL_Branch 0x0D /* Jump by branch table:
245 1:CCCCCCCCCCCCCCCCCCCCrrrXXXXX
246 2:A--D--D--R--E-S-S[0]000XXXXX
247 3:A--D--D--R--E-S-S[1]000XXXXX
249 ------------------------------
250 if (0 <= reg[rrr] < CC..C)
251 IC += ADDRESS[reg[rrr]];
253 IC += ADDRESS[CC..C];
256 #define CCL_ReadRegister 0x0E /* Read bytes into registers:
257 1:CCCCCCCCCCCCCCCCCCCCrrrXXXXX
258 2:CCCCCCCCCCCCCCCCCCCCrrrXXXXX
260 ------------------------------
265 #define CCL_WriteExprConst 0x0F /* write result of expression:
266 1:00000OPERATION000RRR000XXXXX
268 ------------------------------
269 write (reg[RRR] OPERATION CONSTANT);
273 /* Note: If the Nth read is suspended, the resumed execution starts
274 from the Nth code. */
276 #define CCL_ReadBranch 0x10 /* Read one byte into a register,
277 and jump by branch table:
278 1:CCCCCCCCCCCCCCCCCCCCrrrXXXXX
279 2:A--D--D--R--E-S-S[0]000XXXXX
280 3:A--D--D--R--E-S-S[1]000XXXXX
282 ------------------------------
284 if (0 <= reg[rrr] < CC..C)
285 IC += ADDRESS[reg[rrr]];
287 IC += ADDRESS[CC..C];
290 #define CCL_WriteRegister 0x11 /* Write registers:
291 1:CCCCCCCCCCCCCCCCCCCrrrXXXXX
292 2:CCCCCCCCCCCCCCCCCCCrrrXXXXX
294 ------------------------------
300 /* Note: If the Nth write is suspended, the resumed execution
301 starts from the Nth code. */
303 #define CCL_WriteExprRegister 0x12 /* Write result of expression
304 1:00000OPERATIONRrrRRR000XXXXX
305 ------------------------------
306 write (reg[RRR] OPERATION reg[Rrr]);
309 #define CCL_Call 0x13 /* Call the CCL program whose ID is
311 1:CCCCCCCCCCCCCCCCCCCCFFFXXXXX
312 [2:00000000cccccccccccccccccccc]
313 ------------------------------
321 #define CCL_WriteConstString 0x14 /* Write a constant or a string:
322 1:CCCCCCCCCCCCCCCCCCCCrrrXXXXX
323 [2:000MSTRIN[0]STRIN[1]STRIN[2]]
325 -----------------------------
330 write_multibyte_string (STRING, CC..C);
332 write_string (STRING, CC..C);
333 IC += (CC..C + 2) / 3;
336 #define CCL_WriteArray 0x15 /* Write an element of array:
337 1:CCCCCCCCCCCCCCCCCCCCrrrXXXXX
341 ------------------------------
342 if (0 <= reg[rrr] < CC..C)
343 write (ELEMENT[reg[rrr]]);
347 #define CCL_End 0x16 /* Terminate:
348 1:00000000000000000000000XXXXX
349 ------------------------------
353 /* The following two codes execute an assignment arithmetic/logical
354 operation. The form of the operation is like REG OP= OPERAND. */
356 #define CCL_ExprSelfConst 0x17 /* REG OP= constant:
357 1:00000OPERATION000000rrrXXXXX
359 ------------------------------
360 reg[rrr] OPERATION= CONSTANT;
363 #define CCL_ExprSelfReg 0x18 /* REG1 OP= REG2:
364 1:00000OPERATION000RRRrrrXXXXX
365 ------------------------------
366 reg[rrr] OPERATION= reg[RRR];
369 /* The following codes execute an arithmetic/logical operation. The
370 form of the operation is like REG_X = REG_Y OP OPERAND2. */
372 #define CCL_SetExprConst 0x19 /* REG_X = REG_Y OP constant:
373 1:00000OPERATION000RRRrrrXXXXX
375 ------------------------------
376 reg[rrr] = reg[RRR] OPERATION CONSTANT;
380 #define CCL_SetExprReg 0x1A /* REG1 = REG2 OP REG3:
381 1:00000OPERATIONRrrRRRrrrXXXXX
382 ------------------------------
383 reg[rrr] = reg[RRR] OPERATION reg[Rrr];
386 #define CCL_JumpCondExprConst 0x1B /* Jump conditional according to
387 an operation on constant:
388 1:A--D--D--R--E--S--S-rrrXXXXX
391 -----------------------------
392 reg[7] = reg[rrr] OPERATION CONSTANT;
399 #define CCL_JumpCondExprReg 0x1C /* Jump conditional according to
400 an operation on register:
401 1:A--D--D--R--E--S--S-rrrXXXXX
404 -----------------------------
405 reg[7] = reg[rrr] OPERATION reg[RRR];
412 #define CCL_ReadJumpCondExprConst 0x1D /* Read and jump conditional according
413 to an operation on constant:
414 1:A--D--D--R--E--S--S-rrrXXXXX
417 -----------------------------
419 reg[7] = reg[rrr] OPERATION CONSTANT;
426 #define CCL_ReadJumpCondExprReg 0x1E /* Read and jump conditional according
427 to an operation on register:
428 1:A--D--D--R--E--S--S-rrrXXXXX
431 -----------------------------
433 reg[7] = reg[rrr] OPERATION reg[RRR];
440 #define CCL_Extension 0x1F /* Extended CCL code
441 1:ExtendedCOMMNDRrrRRRrrrXXXXX
444 ------------------------------
445 extended_command (rrr,RRR,Rrr,ARGS)
449 Here after, Extended CCL Instructions.
450 Bit length of extended command is 14.
451 Therefore, the instruction code range is 0..16384(0x3fff).
454 /* Read a multibyte characeter.
455 A code point is stored into reg[rrr]. A charset ID is stored into
458 #define CCL_ReadMultibyteChar2 0x00 /* Read Multibyte Character
459 1:ExtendedCOMMNDRrrRRRrrrXXXXX */
461 /* Write a multibyte character.
462 Write a character whose code point is reg[rrr] and the charset ID
465 #define CCL_WriteMultibyteChar2 0x01 /* Write Multibyte Character
466 1:ExtendedCOMMNDRrrRRRrrrXXXXX */
468 /* Translate a character whose code point is reg[rrr] and the charset
469 ID is reg[RRR] by a translation table whose ID is reg[Rrr].
471 A translated character is set in reg[rrr] (code point) and reg[RRR]
474 #define CCL_TranslateCharacter 0x02 /* Translate a multibyte character
475 1:ExtendedCOMMNDRrrRRRrrrXXXXX */
477 /* Translate a character whose code point is reg[rrr] and the charset
478 ID is reg[RRR] by a translation table whose ID is ARGUMENT.
480 A translated character is set in reg[rrr] (code point) and reg[RRR]
483 #define CCL_TranslateCharacterConstTbl 0x03 /* Translate a multibyte character
484 1:ExtendedCOMMNDRrrRRRrrrXXXXX
485 2:ARGUMENT(Translation Table ID)
488 /* Iterate looking up MAPs for reg[rrr] starting from the Nth (N =
489 reg[RRR]) MAP until some value is found.
491 Each MAP is a Lisp vector whose element is number, nil, t, or
493 If the element is nil, ignore the map and proceed to the next map.
494 If the element is t or lambda, finish without changing reg[rrr].
495 If the element is a number, set reg[rrr] to the number and finish.
497 Detail of the map structure is descibed in the comment for
498 CCL_MapMultiple below. */
500 #define CCL_IterateMultipleMap 0x10 /* Iterate multiple maps
501 1:ExtendedCOMMNDXXXRRRrrrXXXXX
508 /* Map the code in reg[rrr] by MAPs starting from the Nth (N =
511 MAPs are supplied in the succeeding CCL codes as follows:
513 When CCL program gives this nested structure of map to this command:
516 (MAP-ID121 MAP-ID122 MAP-ID123)
519 (MAP-ID211 (MAP-ID2111) MAP-ID212)
521 the compiled CCL codes has this sequence:
522 CCL_MapMultiple (CCL code of this command)
523 16 (total number of MAPs and SEPARATORs)
541 A value of each SEPARATOR follows this rule:
542 MAP-SET := SEPARATOR [(MAP-ID | MAP-SET)]+
543 SEPARATOR := -(number of MAP-IDs and SEPARATORs in the MAP-SET)
545 (*)....Nest level of MAP-SET must not be over than MAX_MAP_SET_LEVEL.
547 When some map fails to map (i.e. it doesn't have a value for
548 reg[rrr]), the mapping is treated as identity.
550 The mapping is iterated for all maps in each map set (set of maps
551 separated by SEPARATOR) except in the case that lambda is
552 encountered. More precisely, the mapping proceeds as below:
554 At first, VAL0 is set to reg[rrr], and it is translated by the
555 first map to VAL1. Then, VAL1 is translated by the next map to
556 VAL2. This mapping is iterated until the last map is used. The
557 result of the mapping is the last value of VAL?. When the mapping
558 process reached to the end of the map set, it moves to the next
559 map set. If the next does not exit, the mapping process terminates,
560 and regard the last value as a result.
562 But, when VALm is mapped to VALn and VALn is not a number, the
563 mapping proceed as below:
565 If VALn is nil, the lastest map is ignored and the mapping of VALm
566 proceed to the next map.
568 In VALn is t, VALm is reverted to reg[rrr] and the mapping of VALm
569 proceed to the next map.
571 If VALn is lambda, move to the next map set like reaching to the
572 end of the current map set.
574 If VALn is a symbol, call the CCL program refered by it.
575 Then, use reg[rrr] as a mapped value except for -1, -2 and -3.
576 Such special values are regarded as nil, t, and lambda respectively.
578 Each map is a Lisp vector of the following format (a) or (b):
579 (a)......[STARTPOINT VAL1 VAL2 ...]
580 (b)......[t VAL STARTPOINT ENDPOINT],
582 STARTPOINT is an offset to be used for indexing a map,
583 ENDPOINT is a maximum index number of a map,
584 VAL and VALn is a number, nil, t, or lambda.
586 Valid index range of a map of type (a) is:
587 STARTPOINT <= index < STARTPOINT + map_size - 1
588 Valid index range of a map of type (b) is:
589 STARTPOINT <= index < ENDPOINT */
591 #define CCL_MapMultiple 0x11 /* Mapping by multiple code conversion maps
592 1:ExtendedCOMMNDXXXRRRrrrXXXXX
604 #define MAX_MAP_SET_LEVEL 30
612 static tr_stack mapping_stack
[MAX_MAP_SET_LEVEL
];
613 static tr_stack
*mapping_stack_pointer
;
615 /* If this variable is non-zero, it indicates the stack_idx
616 of immediately called by CCL_MapMultiple. */
617 static int stack_idx_of_map_multiple
;
619 #define PUSH_MAPPING_STACK(restlen, orig) \
622 mapping_stack_pointer->rest_length = (restlen); \
623 mapping_stack_pointer->orig_val = (orig); \
624 mapping_stack_pointer++; \
628 #define POP_MAPPING_STACK(restlen, orig) \
631 mapping_stack_pointer--; \
632 (restlen) = mapping_stack_pointer->rest_length; \
633 (orig) = mapping_stack_pointer->orig_val; \
637 #define CCL_CALL_FOR_MAP_INSTRUCTION(symbol, ret_ic) \
640 struct ccl_program called_ccl; \
641 if (stack_idx >= 256 \
642 || (setup_ccl_program (&called_ccl, (symbol)) != 0)) \
646 ccl_prog = ccl_prog_stack_struct[0].ccl_prog; \
647 ic = ccl_prog_stack_struct[0].ic; \
648 eof_ic = ccl_prog_stack_struct[0].eof_ic; \
652 ccl_prog_stack_struct[stack_idx].ccl_prog = ccl_prog; \
653 ccl_prog_stack_struct[stack_idx].ic = (ret_ic); \
654 ccl_prog_stack_struct[stack_idx].eof_ic = eof_ic; \
656 ccl_prog = called_ccl.prog; \
657 ic = CCL_HEADER_MAIN; \
658 eof_ic = XFASTINT (ccl_prog[CCL_HEADER_EOF]); \
663 #define CCL_MapSingle 0x12 /* Map by single code conversion map
664 1:ExtendedCOMMNDXXXRRRrrrXXXXX
666 ------------------------------
667 Map reg[rrr] by MAP-ID.
668 If some valid mapping is found,
669 set reg[rrr] to the result,
674 #define CCL_LookupIntConstTbl 0x13 /* Lookup multibyte character by
675 integer key. Afterwards R7 set
676 to 1 if lookup succeeded.
677 1:ExtendedCOMMNDRrrRRRXXXXXXXX
678 2:ARGUMENT(Hash table ID) */
680 #define CCL_LookupCharConstTbl 0x14 /* Lookup integer by multibyte
681 character key. Afterwards R7 set
682 to 1 if lookup succeeded.
683 1:ExtendedCOMMNDRrrRRRrrrXXXXX
684 2:ARGUMENT(Hash table ID) */
686 /* CCL arithmetic/logical operators. */
687 #define CCL_PLUS 0x00 /* X = Y + Z */
688 #define CCL_MINUS 0x01 /* X = Y - Z */
689 #define CCL_MUL 0x02 /* X = Y * Z */
690 #define CCL_DIV 0x03 /* X = Y / Z */
691 #define CCL_MOD 0x04 /* X = Y % Z */
692 #define CCL_AND 0x05 /* X = Y & Z */
693 #define CCL_OR 0x06 /* X = Y | Z */
694 #define CCL_XOR 0x07 /* X = Y ^ Z */
695 #define CCL_LSH 0x08 /* X = Y << Z */
696 #define CCL_RSH 0x09 /* X = Y >> Z */
697 #define CCL_LSH8 0x0A /* X = (Y << 8) | Z */
698 #define CCL_RSH8 0x0B /* X = Y >> 8, r[7] = Y & 0xFF */
699 #define CCL_DIVMOD 0x0C /* X = Y / Z, r[7] = Y % Z */
700 #define CCL_LS 0x10 /* X = (X < Y) */
701 #define CCL_GT 0x11 /* X = (X > Y) */
702 #define CCL_EQ 0x12 /* X = (X == Y) */
703 #define CCL_LE 0x13 /* X = (X <= Y) */
704 #define CCL_GE 0x14 /* X = (X >= Y) */
705 #define CCL_NE 0x15 /* X = (X != Y) */
707 #define CCL_DECODE_SJIS 0x16 /* X = HIGHER_BYTE (DE-SJIS (Y, Z))
708 r[7] = LOWER_BYTE (DE-SJIS (Y, Z)) */
709 #define CCL_ENCODE_SJIS 0x17 /* X = HIGHER_BYTE (SJIS (Y, Z))
710 r[7] = LOWER_BYTE (SJIS (Y, Z) */
712 /* Terminate CCL program successfully. */
713 #define CCL_SUCCESS \
716 ccl->status = CCL_STAT_SUCCESS; \
721 /* Suspend CCL program because of reading from empty input buffer or
722 writing to full output buffer. When this program is resumed, the
723 same I/O command is executed. */
724 #define CCL_SUSPEND(stat) \
728 ccl->status = stat; \
733 /* Terminate CCL program because of invalid command. Should not occur
734 in the normal case. */
737 #define CCL_INVALID_CMD \
740 ccl->status = CCL_STAT_INVALID_CMD; \
741 goto ccl_error_handler; \
747 #define CCL_INVALID_CMD \
750 ccl_debug_hook (this_ic); \
751 ccl->status = CCL_STAT_INVALID_CMD; \
752 goto ccl_error_handler; \
758 /* Encode one character CH to multibyte form and write to the current
759 output buffer. If CH is less than 256, CH is written as is. */
760 #define CCL_WRITE_CHAR(ch) \
764 else if (dst < dst_end) \
767 CCL_SUSPEND (CCL_STAT_SUSPEND_BY_DST); \
770 /* Write a string at ccl_prog[IC] of length LEN to the current output
772 #define CCL_WRITE_STRING(len) \
777 else if (dst + len <= dst_end) \
779 if (XFASTINT (ccl_prog[ic]) & 0x1000000) \
780 for (i = 0; i < len; i++) \
781 *dst++ = XFASTINT (ccl_prog[ic + i]) & 0xFFFFFF; \
783 for (i = 0; i < len; i++) \
784 *dst++ = ((XFASTINT (ccl_prog[ic + (i / 3)])) \
785 >> ((2 - (i % 3)) * 8)) & 0xFF; \
788 CCL_SUSPEND (CCL_STAT_SUSPEND_BY_DST); \
791 /* Read one byte from the current input buffer into Rth register. */
792 #define CCL_READ_CHAR(r) \
796 else if (src < src_end) \
798 else if (ccl->last_block) \
805 CCL_SUSPEND (CCL_STAT_SUSPEND_BY_SRC); \
808 /* Decode CODE by a charset whose id is ID. If ID is 0, return CODE
809 as is for backward compatibility. Assume that we can use the
810 variable `charset'. */
812 #define CCL_DECODE_CHAR(id, code) \
813 ((id) == 0 ? (code) \
814 : (charset = CHARSET_FROM_ID ((id)), DECODE_CHAR (charset, (code))))
816 /* Encode character C by some of charsets in CHARSET_LIST. Set ID to
817 the id of the used charset, ENCODED to the resulf of encoding.
818 Assume that we can use the variable `charset'. */
820 #define CCL_ENCODE_CHAR(c, charset_list, id, encoded) \
824 charset = char_charset ((c), (charset_list), &code); \
825 if (! charset && ! NILP (charset_list)) \
826 charset = char_charset ((c), Qnil, &code); \
829 (id) = CHARSET_ID (charset); \
834 /* Execute CCL code on characters at SOURCE (length SRC_SIZE). The
835 resulting text goes to a place pointed by DESTINATION, the length
836 of which should not exceed DST_SIZE. As a side effect, how many
837 characters are consumed and produced are recorded in CCL->consumed
838 and CCL->produced, and the contents of CCL registers are updated.
839 If SOURCE or DESTINATION is NULL, only operations on registers are
843 #define CCL_DEBUG_BACKTRACE_LEN 256
844 int ccl_backtrace_table
[CCL_DEBUG_BACKTRACE_LEN
];
845 int ccl_backtrace_idx
;
848 ccl_debug_hook (int ic
)
855 struct ccl_prog_stack
857 Lisp_Object
*ccl_prog
; /* Pointer to an array of CCL code. */
858 int ic
; /* Instruction Counter. */
859 int eof_ic
; /* Instruction Counter to jump on EOF. */
862 /* For the moment, we only support depth 256 of stack. */
863 static struct ccl_prog_stack ccl_prog_stack_struct
[256];
866 ccl_driver (ccl
, source
, destination
, src_size
, dst_size
, charset_list
)
867 struct ccl_program
*ccl
;
868 int *source
, *destination
;
869 int src_size
, dst_size
;
870 Lisp_Object charset_list
;
872 register int *reg
= ccl
->reg
;
873 register int ic
= ccl
->ic
;
874 register int code
= 0, field1
, field2
;
875 register Lisp_Object
*ccl_prog
= ccl
->prog
;
876 int *src
= source
, *src_end
= src
+ src_size
;
877 int *dst
= destination
, *dst_end
= dst
+ dst_size
;
880 int stack_idx
= ccl
->stack_idx
;
881 /* Instruction counter of the current CCL code. */
883 struct charset
*charset
;
884 int eof_ic
= ccl
->eof_ic
;
888 ic
= CCL_HEADER_MAIN
;
890 if (ccl
->buf_magnification
== 0) /* We can't read/produce any bytes. */
893 /* Set mapping stack pointer. */
894 mapping_stack_pointer
= mapping_stack
;
897 ccl_backtrace_idx
= 0;
904 ccl_backtrace_table
[ccl_backtrace_idx
++] = ic
;
905 if (ccl_backtrace_idx
>= CCL_DEBUG_BACKTRACE_LEN
)
906 ccl_backtrace_idx
= 0;
907 ccl_backtrace_table
[ccl_backtrace_idx
] = 0;
910 if (!NILP (Vquit_flag
) && NILP (Vinhibit_quit
))
912 /* We can't just signal Qquit, instead break the loop as if
913 the whole data is processed. Don't reset Vquit_flag, it
914 must be handled later at a safer place. */
916 src
= source
+ src_size
;
917 ccl
->status
= CCL_STAT_QUIT
;
922 code
= XINT (ccl_prog
[ic
]); ic
++;
924 field2
= (code
& 0xFF) >> 5;
927 #define RRR (field1 & 7)
928 #define Rrr ((field1 >> 3) & 7)
930 #define EXCMD (field1 >> 6)
934 case CCL_SetRegister
: /* 00000000000000000RRRrrrXXXXX */
938 case CCL_SetShortConst
: /* CCCCCCCCCCCCCCCCCCCCrrrXXXXX */
942 case CCL_SetConst
: /* 00000000000000000000rrrXXXXX */
943 reg
[rrr
] = XINT (ccl_prog
[ic
]);
947 case CCL_SetArray
: /* CCCCCCCCCCCCCCCCCCCCRRRrrrXXXXX */
950 if ((unsigned int) i
< j
)
951 reg
[rrr
] = XINT (ccl_prog
[ic
+ i
]);
955 case CCL_Jump
: /* A--D--D--R--E--S--S-000XXXXX */
959 case CCL_JumpCond
: /* A--D--D--R--E--S--S-rrrXXXXX */
964 case CCL_WriteRegisterJump
: /* A--D--D--R--E--S--S-rrrXXXXX */
970 case CCL_WriteRegisterReadJump
: /* A--D--D--R--E--S--S-rrrXXXXX */
974 CCL_READ_CHAR (reg
[rrr
]);
978 case CCL_WriteConstJump
: /* A--D--D--R--E--S--S-000XXXXX */
979 i
= XINT (ccl_prog
[ic
]);
984 case CCL_WriteConstReadJump
: /* A--D--D--R--E--S--S-rrrXXXXX */
985 i
= XINT (ccl_prog
[ic
]);
988 CCL_READ_CHAR (reg
[rrr
]);
992 case CCL_WriteStringJump
: /* A--D--D--R--E--S--S-000XXXXX */
993 j
= XINT (ccl_prog
[ic
]);
995 CCL_WRITE_STRING (j
);
999 case CCL_WriteArrayReadJump
: /* A--D--D--R--E--S--S-rrrXXXXX */
1001 j
= XINT (ccl_prog
[ic
]);
1002 if ((unsigned int) i
< j
)
1004 i
= XINT (ccl_prog
[ic
+ 1 + i
]);
1008 CCL_READ_CHAR (reg
[rrr
]);
1009 ic
+= ADDR
- (j
+ 2);
1012 case CCL_ReadJump
: /* A--D--D--R--E--S--S-rrrYYYYY */
1013 CCL_READ_CHAR (reg
[rrr
]);
1017 case CCL_ReadBranch
: /* CCCCCCCCCCCCCCCCCCCCrrrXXXXX */
1018 CCL_READ_CHAR (reg
[rrr
]);
1019 /* fall through ... */
1020 case CCL_Branch
: /* CCCCCCCCCCCCCCCCCCCCrrrXXXXX */
1021 if ((unsigned int) reg
[rrr
] < field1
)
1022 ic
+= XINT (ccl_prog
[ic
+ reg
[rrr
]]);
1024 ic
+= XINT (ccl_prog
[ic
+ field1
]);
1027 case CCL_ReadRegister
: /* CCCCCCCCCCCCCCCCCCCCrrXXXXX */
1030 CCL_READ_CHAR (reg
[rrr
]);
1032 code
= XINT (ccl_prog
[ic
]); ic
++;
1034 field2
= (code
& 0xFF) >> 5;
1038 case CCL_WriteExprConst
: /* 1:00000OPERATION000RRR000XXXXX */
1041 j
= XINT (ccl_prog
[ic
]);
1043 jump_address
= ic
+ 1;
1046 case CCL_WriteRegister
: /* CCCCCCCCCCCCCCCCCCCrrrXXXXX */
1052 code
= XINT (ccl_prog
[ic
]); ic
++;
1054 field2
= (code
& 0xFF) >> 5;
1058 case CCL_WriteExprRegister
: /* 1:00000OPERATIONRrrRRR000XXXXX */
1066 case CCL_Call
: /* 1:CCCCCCCCCCCCCCCCCCCCFFFXXXXX */
1071 /* If FFF is nonzero, the CCL program ID is in the
1075 prog_id
= XINT (ccl_prog
[ic
]);
1081 if (stack_idx
>= 256
1083 || prog_id
>= ASIZE (Vccl_program_table
)
1084 || (slot
= AREF (Vccl_program_table
, prog_id
), !VECTORP (slot
))
1085 || !VECTORP (AREF (slot
, 1)))
1089 ccl_prog
= ccl_prog_stack_struct
[0].ccl_prog
;
1090 ic
= ccl_prog_stack_struct
[0].ic
;
1091 eof_ic
= ccl_prog_stack_struct
[0].eof_ic
;
1096 ccl_prog_stack_struct
[stack_idx
].ccl_prog
= ccl_prog
;
1097 ccl_prog_stack_struct
[stack_idx
].ic
= ic
;
1098 ccl_prog_stack_struct
[stack_idx
].eof_ic
= eof_ic
;
1100 ccl_prog
= XVECTOR (AREF (slot
, 1))->contents
;
1101 ic
= CCL_HEADER_MAIN
;
1102 eof_ic
= XFASTINT (ccl_prog
[CCL_HEADER_EOF
]);
1106 case CCL_WriteConstString
: /* CCCCCCCCCCCCCCCCCCCCrrrXXXXX */
1108 CCL_WRITE_CHAR (field1
);
1111 CCL_WRITE_STRING (field1
);
1112 ic
+= (field1
+ 2) / 3;
1116 case CCL_WriteArray
: /* CCCCCCCCCCCCCCCCCCCCrrrXXXXX */
1118 if ((unsigned int) i
< field1
)
1120 j
= XINT (ccl_prog
[ic
+ i
]);
1126 case CCL_End
: /* 0000000000000000000000XXXXX */
1130 ccl_prog
= ccl_prog_stack_struct
[stack_idx
].ccl_prog
;
1131 ic
= ccl_prog_stack_struct
[stack_idx
].ic
;
1132 eof_ic
= ccl_prog_stack_struct
[stack_idx
].eof_ic
;
1139 /* ccl->ic should points to this command code again to
1140 suppress further processing. */
1144 case CCL_ExprSelfConst
: /* 00000OPERATION000000rrrXXXXX */
1145 i
= XINT (ccl_prog
[ic
]);
1150 case CCL_ExprSelfReg
: /* 00000OPERATION000RRRrrrXXXXX */
1157 case CCL_PLUS
: reg
[rrr
] += i
; break;
1158 case CCL_MINUS
: reg
[rrr
] -= i
; break;
1159 case CCL_MUL
: reg
[rrr
] *= i
; break;
1160 case CCL_DIV
: reg
[rrr
] /= i
; break;
1161 case CCL_MOD
: reg
[rrr
] %= i
; break;
1162 case CCL_AND
: reg
[rrr
] &= i
; break;
1163 case CCL_OR
: reg
[rrr
] |= i
; break;
1164 case CCL_XOR
: reg
[rrr
] ^= i
; break;
1165 case CCL_LSH
: reg
[rrr
] <<= i
; break;
1166 case CCL_RSH
: reg
[rrr
] >>= i
; break;
1167 case CCL_LSH8
: reg
[rrr
] <<= 8; reg
[rrr
] |= i
; break;
1168 case CCL_RSH8
: reg
[7] = reg
[rrr
] & 0xFF; reg
[rrr
] >>= 8; break;
1169 case CCL_DIVMOD
: reg
[7] = reg
[rrr
] % i
; reg
[rrr
] /= i
; break;
1170 case CCL_LS
: reg
[rrr
] = reg
[rrr
] < i
; break;
1171 case CCL_GT
: reg
[rrr
] = reg
[rrr
] > i
; break;
1172 case CCL_EQ
: reg
[rrr
] = reg
[rrr
] == i
; break;
1173 case CCL_LE
: reg
[rrr
] = reg
[rrr
] <= i
; break;
1174 case CCL_GE
: reg
[rrr
] = reg
[rrr
] >= i
; break;
1175 case CCL_NE
: reg
[rrr
] = reg
[rrr
] != i
; break;
1176 default: CCL_INVALID_CMD
;
1180 case CCL_SetExprConst
: /* 00000OPERATION000RRRrrrXXXXX */
1182 j
= XINT (ccl_prog
[ic
]);
1184 jump_address
= ++ic
;
1187 case CCL_SetExprReg
: /* 00000OPERATIONRrrRRRrrrXXXXX */
1194 case CCL_ReadJumpCondExprConst
: /* A--D--D--R--E--S--S-rrrXXXXX */
1195 CCL_READ_CHAR (reg
[rrr
]);
1196 case CCL_JumpCondExprConst
: /* A--D--D--R--E--S--S-rrrXXXXX */
1198 op
= XINT (ccl_prog
[ic
]);
1199 jump_address
= ic
++ + ADDR
;
1200 j
= XINT (ccl_prog
[ic
]);
1205 case CCL_ReadJumpCondExprReg
: /* A--D--D--R--E--S--S-rrrXXXXX */
1206 CCL_READ_CHAR (reg
[rrr
]);
1207 case CCL_JumpCondExprReg
:
1209 op
= XINT (ccl_prog
[ic
]);
1210 jump_address
= ic
++ + ADDR
;
1211 j
= reg
[XINT (ccl_prog
[ic
])];
1218 case CCL_PLUS
: reg
[rrr
] = i
+ j
; break;
1219 case CCL_MINUS
: reg
[rrr
] = i
- j
; break;
1220 case CCL_MUL
: reg
[rrr
] = i
* j
; break;
1221 case CCL_DIV
: reg
[rrr
] = i
/ j
; break;
1222 case CCL_MOD
: reg
[rrr
] = i
% j
; break;
1223 case CCL_AND
: reg
[rrr
] = i
& j
; break;
1224 case CCL_OR
: reg
[rrr
] = i
| j
; break;
1225 case CCL_XOR
: reg
[rrr
] = i
^ j
; break;
1226 case CCL_LSH
: reg
[rrr
] = i
<< j
; break;
1227 case CCL_RSH
: reg
[rrr
] = i
>> j
; break;
1228 case CCL_LSH8
: reg
[rrr
] = (i
<< 8) | j
; break;
1229 case CCL_RSH8
: reg
[rrr
] = i
>> 8; reg
[7] = i
& 0xFF; break;
1230 case CCL_DIVMOD
: reg
[rrr
] = i
/ j
; reg
[7] = i
% j
; break;
1231 case CCL_LS
: reg
[rrr
] = i
< j
; break;
1232 case CCL_GT
: reg
[rrr
] = i
> j
; break;
1233 case CCL_EQ
: reg
[rrr
] = i
== j
; break;
1234 case CCL_LE
: reg
[rrr
] = i
<= j
; break;
1235 case CCL_GE
: reg
[rrr
] = i
>= j
; break;
1236 case CCL_NE
: reg
[rrr
] = i
!= j
; break;
1237 case CCL_DECODE_SJIS
:
1245 case CCL_ENCODE_SJIS
:
1253 default: CCL_INVALID_CMD
;
1256 if (code
== CCL_WriteExprConst
|| code
== CCL_WriteExprRegister
)
1269 case CCL_ReadMultibyteChar2
:
1273 CCL_ENCODE_CHAR (i
, charset_list
, reg
[RRR
], reg
[rrr
]);
1276 case CCL_WriteMultibyteChar2
:
1279 i
= CCL_DECODE_CHAR (reg
[RRR
], reg
[rrr
]);
1283 case CCL_TranslateCharacter
:
1284 i
= CCL_DECODE_CHAR (reg
[RRR
], reg
[rrr
]);
1285 op
= translate_char (GET_TRANSLATION_TABLE (reg
[Rrr
]), i
);
1286 CCL_ENCODE_CHAR (op
, charset_list
, reg
[RRR
], reg
[rrr
]);
1289 case CCL_TranslateCharacterConstTbl
:
1290 op
= XINT (ccl_prog
[ic
]); /* table */
1292 i
= CCL_DECODE_CHAR (reg
[RRR
], reg
[rrr
]);
1293 op
= translate_char (GET_TRANSLATION_TABLE (op
), i
);
1294 CCL_ENCODE_CHAR (op
, charset_list
, reg
[RRR
], reg
[rrr
]);
1297 case CCL_LookupIntConstTbl
:
1298 op
= XINT (ccl_prog
[ic
]); /* table */
1301 struct Lisp_Hash_Table
*h
= GET_HASH_TABLE (op
);
1303 op
= hash_lookup (h
, make_number (reg
[RRR
]), NULL
);
1307 opl
= HASH_VALUE (h
, op
);
1308 if (! CHARACTERP (opl
))
1310 reg
[RRR
] = charset_unicode
;
1312 reg
[7] = 1; /* r7 true for success */
1319 case CCL_LookupCharConstTbl
:
1320 op
= XINT (ccl_prog
[ic
]); /* table */
1322 i
= CCL_DECODE_CHAR (reg
[RRR
], reg
[rrr
]);
1324 struct Lisp_Hash_Table
*h
= GET_HASH_TABLE (op
);
1326 op
= hash_lookup (h
, make_number (i
), NULL
);
1330 opl
= HASH_VALUE (h
, op
);
1331 if (!INTEGERP (opl
))
1333 reg
[RRR
] = XINT (opl
);
1334 reg
[7] = 1; /* r7 true for success */
1341 case CCL_IterateMultipleMap
:
1343 Lisp_Object map
, content
, attrib
, value
;
1344 int point
, size
, fin_ic
;
1346 j
= XINT (ccl_prog
[ic
++]); /* number of maps. */
1349 if ((j
> reg
[RRR
]) && (j
>= 0))
1364 size
= ASIZE (Vcode_conversion_map_vector
);
1365 point
= XINT (ccl_prog
[ic
++]);
1366 if (point
>= size
) continue;
1367 map
= AREF (Vcode_conversion_map_vector
, point
);
1369 /* Check map varidity. */
1370 if (!CONSP (map
)) continue;
1372 if (!VECTORP (map
)) continue;
1374 if (size
<= 1) continue;
1376 content
= AREF (map
, 0);
1379 [STARTPOINT VAL1 VAL2 ...] or
1380 [t ELELMENT STARTPOINT ENDPOINT] */
1381 if (NUMBERP (content
))
1383 point
= XUINT (content
);
1384 point
= op
- point
+ 1;
1385 if (!((point
>= 1) && (point
< size
))) continue;
1386 content
= AREF (map
, point
);
1388 else if (EQ (content
, Qt
))
1390 if (size
!= 4) continue;
1391 if ((op
>= XUINT (AREF (map
, 2)))
1392 && (op
< XUINT (AREF (map
, 3))))
1393 content
= AREF (map
, 1);
1402 else if (NUMBERP (content
))
1405 reg
[rrr
] = XINT(content
);
1408 else if (EQ (content
, Qt
) || EQ (content
, Qlambda
))
1413 else if (CONSP (content
))
1415 attrib
= XCAR (content
);
1416 value
= XCDR (content
);
1417 if (!NUMBERP (attrib
) || !NUMBERP (value
))
1420 reg
[rrr
] = XUINT (value
);
1423 else if (SYMBOLP (content
))
1424 CCL_CALL_FOR_MAP_INSTRUCTION (content
, fin_ic
);
1434 case CCL_MapMultiple
:
1436 Lisp_Object map
, content
, attrib
, value
;
1437 int point
, size
, map_vector_size
;
1438 int map_set_rest_length
, fin_ic
;
1439 int current_ic
= this_ic
;
1441 /* inhibit recursive call on MapMultiple. */
1442 if (stack_idx_of_map_multiple
> 0)
1444 if (stack_idx_of_map_multiple
<= stack_idx
)
1446 stack_idx_of_map_multiple
= 0;
1447 mapping_stack_pointer
= mapping_stack
;
1452 mapping_stack_pointer
= mapping_stack
;
1453 stack_idx_of_map_multiple
= 0;
1455 map_set_rest_length
=
1456 XINT (ccl_prog
[ic
++]); /* number of maps and separators. */
1457 fin_ic
= ic
+ map_set_rest_length
;
1460 if ((map_set_rest_length
> reg
[RRR
]) && (reg
[RRR
] >= 0))
1464 map_set_rest_length
-= i
;
1470 mapping_stack_pointer
= mapping_stack
;
1474 if (mapping_stack_pointer
<= (mapping_stack
+ 1))
1476 /* Set up initial state. */
1477 mapping_stack_pointer
= mapping_stack
;
1478 PUSH_MAPPING_STACK (0, op
);
1483 /* Recover after calling other ccl program. */
1486 POP_MAPPING_STACK (map_set_rest_length
, orig_op
);
1487 POP_MAPPING_STACK (map_set_rest_length
, reg
[rrr
]);
1491 /* Regard it as Qnil. */
1495 map_set_rest_length
--;
1498 /* Regard it as Qt. */
1502 map_set_rest_length
--;
1505 /* Regard it as Qlambda. */
1507 i
+= map_set_rest_length
;
1508 ic
+= map_set_rest_length
;
1509 map_set_rest_length
= 0;
1512 /* Regard it as normal mapping. */
1513 i
+= map_set_rest_length
;
1514 ic
+= map_set_rest_length
;
1515 POP_MAPPING_STACK (map_set_rest_length
, reg
[rrr
]);
1519 map_vector_size
= ASIZE (Vcode_conversion_map_vector
);
1522 for (;map_set_rest_length
> 0;i
++, ic
++, map_set_rest_length
--)
1524 point
= XINT(ccl_prog
[ic
]);
1527 /* +1 is for including separator. */
1529 if (mapping_stack_pointer
1530 >= &mapping_stack
[MAX_MAP_SET_LEVEL
])
1532 PUSH_MAPPING_STACK (map_set_rest_length
- point
,
1534 map_set_rest_length
= point
;
1539 if (point
>= map_vector_size
) continue;
1540 map
= AREF (Vcode_conversion_map_vector
, point
);
1542 /* Check map varidity. */
1543 if (!CONSP (map
)) continue;
1545 if (!VECTORP (map
)) continue;
1547 if (size
<= 1) continue;
1549 content
= AREF (map
, 0);
1552 [STARTPOINT VAL1 VAL2 ...] or
1553 [t ELEMENT STARTPOINT ENDPOINT] */
1554 if (NUMBERP (content
))
1556 point
= XUINT (content
);
1557 point
= op
- point
+ 1;
1558 if (!((point
>= 1) && (point
< size
))) continue;
1559 content
= AREF (map
, point
);
1561 else if (EQ (content
, Qt
))
1563 if (size
!= 4) continue;
1564 if ((op
>= XUINT (AREF (map
, 2))) &&
1565 (op
< XUINT (AREF (map
, 3))))
1566 content
= AREF (map
, 1);
1577 if (NUMBERP (content
))
1579 op
= XINT (content
);
1580 i
+= map_set_rest_length
- 1;
1581 ic
+= map_set_rest_length
- 1;
1582 POP_MAPPING_STACK (map_set_rest_length
, reg
[rrr
]);
1583 map_set_rest_length
++;
1585 else if (CONSP (content
))
1587 attrib
= XCAR (content
);
1588 value
= XCDR (content
);
1589 if (!NUMBERP (attrib
) || !NUMBERP (value
))
1592 i
+= map_set_rest_length
- 1;
1593 ic
+= map_set_rest_length
- 1;
1594 POP_MAPPING_STACK (map_set_rest_length
, reg
[rrr
]);
1595 map_set_rest_length
++;
1597 else if (EQ (content
, Qt
))
1601 else if (EQ (content
, Qlambda
))
1603 i
+= map_set_rest_length
;
1604 ic
+= map_set_rest_length
;
1607 else if (SYMBOLP (content
))
1609 if (mapping_stack_pointer
1610 >= &mapping_stack
[MAX_MAP_SET_LEVEL
])
1612 PUSH_MAPPING_STACK (map_set_rest_length
, reg
[rrr
]);
1613 PUSH_MAPPING_STACK (map_set_rest_length
, op
);
1614 stack_idx_of_map_multiple
= stack_idx
+ 1;
1615 CCL_CALL_FOR_MAP_INSTRUCTION (content
, current_ic
);
1620 if (mapping_stack_pointer
<= (mapping_stack
+ 1))
1622 POP_MAPPING_STACK (map_set_rest_length
, reg
[rrr
]);
1623 i
+= map_set_rest_length
;
1624 ic
+= map_set_rest_length
;
1625 POP_MAPPING_STACK (map_set_rest_length
, reg
[rrr
]);
1635 Lisp_Object map
, attrib
, value
, content
;
1637 j
= XINT (ccl_prog
[ic
++]); /* map_id */
1639 if (j
>= ASIZE (Vcode_conversion_map_vector
))
1644 map
= AREF (Vcode_conversion_map_vector
, j
);
1657 point
= XUINT (AREF (map
, 0));
1658 point
= op
- point
+ 1;
1661 (!((point
>= 1) && (point
< size
))))
1666 content
= AREF (map
, point
);
1669 else if (NUMBERP (content
))
1670 reg
[rrr
] = XINT (content
);
1671 else if (EQ (content
, Qt
));
1672 else if (CONSP (content
))
1674 attrib
= XCAR (content
);
1675 value
= XCDR (content
);
1676 if (!NUMBERP (attrib
) || !NUMBERP (value
))
1678 reg
[rrr
] = XUINT(value
);
1681 else if (SYMBOLP (content
))
1682 CCL_CALL_FOR_MAP_INSTRUCTION (content
, ic
);
1700 /* The suppress_error member is set when e.g. a CCL-based coding
1701 system is used for terminal output. */
1702 if (!ccl
->suppress_error
&& destination
)
1704 /* We can insert an error message only if DESTINATION is
1705 specified and we still have a room to store the message
1713 switch (ccl
->status
)
1715 case CCL_STAT_INVALID_CMD
:
1716 sprintf(msg
, "\nCCL: Invalid command %x (ccl_code = %x) at %d.",
1717 code
& 0x1F, code
, this_ic
);
1720 int i
= ccl_backtrace_idx
- 1;
1723 msglen
= strlen (msg
);
1724 if (dst
+ msglen
<= (dst_bytes
? dst_end
: src
))
1726 bcopy (msg
, dst
, msglen
);
1730 for (j
= 0; j
< CCL_DEBUG_BACKTRACE_LEN
; j
++, i
--)
1732 if (i
< 0) i
= CCL_DEBUG_BACKTRACE_LEN
- 1;
1733 if (ccl_backtrace_table
[i
] == 0)
1735 sprintf(msg
, " %d", ccl_backtrace_table
[i
]);
1736 msglen
= strlen (msg
);
1737 if (dst
+ msglen
> (dst_bytes
? dst_end
: src
))
1739 bcopy (msg
, dst
, msglen
);
1748 sprintf(msg
, "\nCCL: Quited.");
1752 sprintf(msg
, "\nCCL: Unknown error type (%d)", ccl
->status
);
1755 msglen
= strlen (msg
);
1756 if (dst
+ msglen
<= dst_end
)
1758 for (i
= 0; i
< msglen
; i
++)
1762 if (ccl
->status
== CCL_STAT_INVALID_CMD
)
1764 #if 0 /* If the remaining bytes contain 0x80..0x9F, copying them
1765 results in an invalid multibyte sequence. */
1767 /* Copy the remaining source data. */
1768 int i
= src_end
- src
;
1769 if (dst_bytes
&& (dst_end
- dst
) < i
)
1771 bcopy (src
, dst
, i
);
1775 /* Signal that we've consumed everything. */
1783 ccl
->stack_idx
= stack_idx
;
1784 ccl
->prog
= ccl_prog
;
1785 ccl
->consumed
= src
- source
;
1787 ccl
->produced
= dst
- destination
;
1792 /* Resolve symbols in the specified CCL code (Lisp vector). This
1793 function converts symbols of code conversion maps and character
1794 translation tables embeded in the CCL code into their ID numbers.
1796 The return value is a vector (CCL itself or a new vector in which
1797 all symbols are resolved), Qt if resolving of some symbol failed,
1798 or nil if CCL contains invalid data. */
1801 resolve_symbol_ccl_program (ccl
)
1804 int i
, veclen
, unresolved
= 0;
1805 Lisp_Object result
, contents
, val
;
1808 veclen
= ASIZE (result
);
1810 for (i
= 0; i
< veclen
; i
++)
1812 contents
= AREF (result
, i
);
1813 if (INTEGERP (contents
))
1815 else if (CONSP (contents
)
1816 && SYMBOLP (XCAR (contents
))
1817 && SYMBOLP (XCDR (contents
)))
1819 /* This is the new style for embedding symbols. The form is
1820 (SYMBOL . PROPERTY). (get SYMBOL PROPERTY) should give
1823 if (EQ (result
, ccl
))
1824 result
= Fcopy_sequence (ccl
);
1826 val
= Fget (XCAR (contents
), XCDR (contents
));
1828 AREF (result
, i
) = val
;
1833 else if (SYMBOLP (contents
))
1835 /* This is the old style for embedding symbols. This style
1836 may lead to a bug if, for instance, a translation table
1837 and a code conversion map have the same name. */
1838 if (EQ (result
, ccl
))
1839 result
= Fcopy_sequence (ccl
);
1841 val
= Fget (contents
, Qtranslation_table_id
);
1843 AREF (result
, i
) = val
;
1846 val
= Fget (contents
, Qcode_conversion_map_id
);
1848 AREF (result
, i
) = val
;
1851 val
= Fget (contents
, Qccl_program_idx
);
1853 AREF (result
, i
) = val
;
1863 return (unresolved
? Qt
: result
);
1866 /* Return the compiled code (vector) of CCL program CCL_PROG.
1867 CCL_PROG is a name (symbol) of the program or already compiled
1868 code. If necessary, resolve symbols in the compiled code to index
1869 numbers. If we failed to get the compiled code or to resolve
1870 symbols, return Qnil. */
1873 ccl_get_compiled_code (ccl_prog
, idx
)
1874 Lisp_Object ccl_prog
;
1877 Lisp_Object val
, slot
;
1879 if (VECTORP (ccl_prog
))
1881 val
= resolve_symbol_ccl_program (ccl_prog
);
1883 return (VECTORP (val
) ? val
: Qnil
);
1885 if (!SYMBOLP (ccl_prog
))
1888 val
= Fget (ccl_prog
, Qccl_program_idx
);
1890 || XINT (val
) >= ASIZE (Vccl_program_table
))
1892 slot
= AREF (Vccl_program_table
, XINT (val
));
1893 if (! VECTORP (slot
)
1894 || ASIZE (slot
) != 4
1895 || ! VECTORP (AREF (slot
, 1)))
1898 if (NILP (AREF (slot
, 2)))
1900 val
= resolve_symbol_ccl_program (AREF (slot
, 1));
1901 if (! VECTORP (val
))
1903 AREF (slot
, 1) = val
;
1904 AREF (slot
, 2) = Qt
;
1906 return AREF (slot
, 1);
1909 /* Setup fields of the structure pointed by CCL appropriately for the
1910 execution of CCL program CCL_PROG. CCL_PROG is the name (symbol)
1911 of the CCL program or the already compiled code (vector).
1912 Return 0 if we succeed this setup, else return -1.
1914 If CCL_PROG is nil, we just reset the structure pointed by CCL. */
1916 setup_ccl_program (ccl
, ccl_prog
)
1917 struct ccl_program
*ccl
;
1918 Lisp_Object ccl_prog
;
1922 if (! NILP (ccl_prog
))
1924 struct Lisp_Vector
*vp
;
1926 ccl_prog
= ccl_get_compiled_code (ccl_prog
, &ccl
->idx
);
1927 if (! VECTORP (ccl_prog
))
1929 vp
= XVECTOR (ccl_prog
);
1930 ccl
->size
= vp
->size
;
1931 ccl
->prog
= vp
->contents
;
1932 ccl
->eof_ic
= XINT (vp
->contents
[CCL_HEADER_EOF
]);
1933 ccl
->buf_magnification
= XINT (vp
->contents
[CCL_HEADER_BUF_MAG
]);
1938 slot
= AREF (Vccl_program_table
, ccl
->idx
);
1939 ASET (slot
, 3, Qnil
);
1942 ccl
->ic
= CCL_HEADER_MAIN
;
1943 for (i
= 0; i
< 8; i
++)
1945 ccl
->last_block
= 0;
1946 ccl
->private_state
= 0;
1949 ccl
->suppress_error
= 0;
1950 ccl
->eight_bit_control
= 0;
1955 /* Check if CCL is updated or not. If not, re-setup members of CCL. */
1958 check_ccl_update (ccl
)
1959 struct ccl_program
*ccl
;
1961 Lisp_Object slot
, ccl_prog
;
1965 slot
= AREF (Vccl_program_table
, ccl
->idx
);
1966 if (NILP (AREF (slot
, 3)))
1968 ccl_prog
= ccl_get_compiled_code (AREF (slot
, 0), &ccl
->idx
);
1969 if (! VECTORP (ccl_prog
))
1971 ccl
->size
= ASIZE (ccl_prog
);
1972 ccl
->prog
= XVECTOR (ccl_prog
)->contents
;
1973 ccl
->eof_ic
= XINT (AREF (ccl_prog
, CCL_HEADER_EOF
));
1974 ccl
->buf_magnification
= XINT (AREF (ccl_prog
, CCL_HEADER_BUF_MAG
));
1975 ASET (slot
, 3, Qnil
);
1980 DEFUN ("ccl-program-p", Fccl_program_p
, Sccl_program_p
, 1, 1, 0,
1981 doc
: /* Return t if OBJECT is a CCL program name or a compiled CCL program code.
1982 See the documentation of `define-ccl-program' for the detail of CCL program. */)
1988 if (VECTORP (object
))
1990 val
= resolve_symbol_ccl_program (object
);
1991 return (VECTORP (val
) ? Qt
: Qnil
);
1993 if (!SYMBOLP (object
))
1996 val
= Fget (object
, Qccl_program_idx
);
1997 return ((! NATNUMP (val
)
1998 || XINT (val
) >= ASIZE (Vccl_program_table
))
2002 DEFUN ("ccl-execute", Fccl_execute
, Sccl_execute
, 2, 2, 0,
2003 doc
: /* Execute CCL-PROGRAM with registers initialized by REGISTERS.
2005 CCL-PROGRAM is a CCL program name (symbol)
2006 or compiled code generated by `ccl-compile' (for backward compatibility.
2007 In the latter case, the execution overhead is bigger than in the former).
2008 No I/O commands should appear in CCL-PROGRAM.
2010 REGISTERS is a vector of [R0 R1 ... R7] where RN is an initial value
2011 for the Nth register.
2013 As side effect, each element of REGISTERS holds the value of
2014 the corresponding register after the execution.
2016 See the documentation of `define-ccl-program' for a definition of CCL
2019 Lisp_Object ccl_prog
, reg
;
2021 struct ccl_program ccl
;
2024 if (setup_ccl_program (&ccl
, ccl_prog
) < 0)
2025 error ("Invalid CCL program");
2028 if (ASIZE (reg
) != 8)
2029 error ("Length of vector REGISTERS is not 8");
2031 for (i
= 0; i
< 8; i
++)
2032 ccl
.reg
[i
] = (INTEGERP (AREF (reg
, i
))
2033 ? XINT (AREF (reg
, i
))
2036 ccl_driver (&ccl
, NULL
, NULL
, 0, 0, Qnil
);
2038 if (ccl
.status
!= CCL_STAT_SUCCESS
)
2039 error ("Error in CCL program at %dth code", ccl
.ic
);
2041 for (i
= 0; i
< 8; i
++)
2042 XSETINT (AREF (reg
, i
), ccl
.reg
[i
]);
2046 DEFUN ("ccl-execute-on-string", Fccl_execute_on_string
, Sccl_execute_on_string
,
2048 doc
: /* Execute CCL-PROGRAM with initial STATUS on STRING.
2050 CCL-PROGRAM is a symbol registered by `register-ccl-program',
2051 or a compiled code generated by `ccl-compile' (for backward compatibility,
2052 in this case, the execution is slower).
2054 Read buffer is set to STRING, and write buffer is allocated automatically.
2056 STATUS is a vector of [R0 R1 ... R7 IC], where
2057 R0..R7 are initial values of corresponding registers,
2058 IC is the instruction counter specifying from where to start the program.
2059 If R0..R7 are nil, they are initialized to 0.
2060 If IC is nil, it is initialized to head of the CCL program.
2062 If optional 4th arg CONTINUE is non-nil, keep IC on read operation
2063 when read buffer is exausted, else, IC is always set to the end of
2064 CCL-PROGRAM on exit.
2066 It returns the contents of write buffer as a string,
2067 and as side effect, STATUS is updated.
2068 If the optional 5th arg UNIBYTE-P is non-nil, the returned string
2069 is a unibyte string. By default it is a multibyte string.
2071 See the documentation of `define-ccl-program' for the detail of CCL program.
2072 usage: (ccl-execute-on-string CCL-PROGRAM STATUS STRING &optional CONTINUE UNIBYTE-P) */)
2073 (ccl_prog
, status
, str
, contin
, unibyte_p
)
2074 Lisp_Object ccl_prog
, status
, str
, contin
, unibyte_p
;
2077 struct ccl_program ccl
;
2080 unsigned char *outbuf
, *outp
;
2081 int str_chars
, str_bytes
;
2082 #define CCL_EXECUTE_BUF_SIZE 1024
2083 int source
[CCL_EXECUTE_BUF_SIZE
], destination
[CCL_EXECUTE_BUF_SIZE
];
2084 int consumed_chars
, consumed_bytes
, produced_chars
;
2086 if (setup_ccl_program (&ccl
, ccl_prog
) < 0)
2087 error ("Invalid CCL program");
2089 CHECK_VECTOR (status
);
2090 if (ASIZE (status
) != 9)
2091 error ("Length of vector STATUS is not 9");
2094 str_chars
= SCHARS (str
);
2095 str_bytes
= SBYTES (str
);
2097 for (i
= 0; i
< 8; i
++)
2099 if (NILP (AREF (status
, i
)))
2100 XSETINT (AREF (status
, i
), 0);
2101 if (INTEGERP (AREF (status
, i
)))
2102 ccl
.reg
[i
] = XINT (AREF (status
, i
));
2104 if (INTEGERP (AREF (status
, i
)))
2106 i
= XFASTINT (AREF (status
, 8));
2107 if (ccl
.ic
< i
&& i
< ccl
.size
)
2111 outbufsize
= (ccl
.buf_magnification
2112 ? str_bytes
* ccl
.buf_magnification
+ 256
2114 outp
= outbuf
= (unsigned char *) xmalloc (outbufsize
);
2116 consumed_chars
= consumed_bytes
= 0;
2120 const unsigned char *p
= SDATA (str
) + consumed_bytes
;
2121 const unsigned char *endp
= SDATA (str
) + str_bytes
;
2125 if (endp
- p
== str_chars
- consumed_chars
)
2126 while (i
< CCL_EXECUTE_BUF_SIZE
&& p
< endp
)
2129 while (i
< CCL_EXECUTE_BUF_SIZE
&& p
< endp
)
2130 source
[i
++] = STRING_CHAR_ADVANCE (p
);
2131 consumed_chars
+= i
;
2132 consumed_bytes
= p
- SDATA (str
);
2134 if (consumed_bytes
== str_bytes
)
2135 ccl
.last_block
= NILP (contin
);
2140 ccl_driver (&ccl
, src
, destination
, src_size
, CCL_EXECUTE_BUF_SIZE
,
2142 produced_chars
+= ccl
.produced
;
2143 if (NILP (unibyte_p
))
2145 if (outp
- outbuf
+ MAX_MULTIBYTE_LENGTH
* ccl
.produced
2148 int offset
= outp
- outbuf
;
2149 outbufsize
+= MAX_MULTIBYTE_LENGTH
* ccl
.produced
;
2150 outbuf
= (unsigned char *) xrealloc (outbuf
, outbufsize
);
2151 outp
= outbuf
+ offset
;
2153 for (i
= 0; i
< ccl
.produced
; i
++)
2154 CHAR_STRING_ADVANCE (destination
[i
], outp
);
2158 if (outp
- outbuf
+ ccl
.produced
> outbufsize
)
2160 int offset
= outp
- outbuf
;
2161 outbufsize
+= ccl
.produced
;
2162 outbuf
= (unsigned char *) xrealloc (outbuf
, outbufsize
);
2163 outp
= outbuf
+ offset
;
2165 for (i
= 0; i
< ccl
.produced
; i
++)
2166 *outp
++ = destination
[i
];
2168 src
+= ccl
.consumed
;
2169 src_size
-= ccl
.consumed
;
2170 if (ccl
.status
!= CCL_STAT_SUSPEND_BY_DST
)
2174 if (ccl
.status
!= CCL_STAT_SUSPEND_BY_SRC
2175 || str_chars
== consumed_chars
)
2179 if (ccl
.status
== CCL_STAT_INVALID_CMD
)
2180 error ("Error in CCL program at %dth code", ccl
.ic
);
2181 if (ccl
.status
== CCL_STAT_QUIT
)
2182 error ("CCL program interrupted at %dth code", ccl
.ic
);
2184 for (i
= 0; i
< 8; i
++)
2185 ASET (status
, i
, make_number (ccl
.reg
[i
]));
2186 ASET (status
, 8, make_number (ccl
.ic
));
2188 if (NILP (unibyte_p
))
2189 val
= make_multibyte_string ((char *) outbuf
, produced_chars
,
2192 val
= make_unibyte_string ((char *) outbuf
, produced_chars
);
2198 DEFUN ("register-ccl-program", Fregister_ccl_program
, Sregister_ccl_program
,
2200 doc
: /* Register CCL program CCL-PROG as NAME in `ccl-program-table'.
2201 CCL-PROG should be a compiled CCL program (vector), or nil.
2202 If it is nil, just reserve NAME as a CCL program name.
2203 Return index number of the registered CCL program. */)
2205 Lisp_Object name
, ccl_prog
;
2207 int len
= ASIZE (Vccl_program_table
);
2209 Lisp_Object resolved
;
2211 CHECK_SYMBOL (name
);
2213 if (!NILP (ccl_prog
))
2215 CHECK_VECTOR (ccl_prog
);
2216 resolved
= resolve_symbol_ccl_program (ccl_prog
);
2217 if (NILP (resolved
))
2218 error ("Error in CCL program");
2219 if (VECTORP (resolved
))
2221 ccl_prog
= resolved
;
2228 for (idx
= 0; idx
< len
; idx
++)
2232 slot
= AREF (Vccl_program_table
, idx
);
2233 if (!VECTORP (slot
))
2234 /* This is the first unsed slot. Register NAME here. */
2237 if (EQ (name
, AREF (slot
, 0)))
2239 /* Update this slot. */
2240 ASET (slot
, 1, ccl_prog
);
2241 ASET (slot
, 2, resolved
);
2243 return make_number (idx
);
2248 /* Extend the table. */
2249 Vccl_program_table
= larger_vector (Vccl_program_table
, len
* 2, Qnil
);
2254 elt
= Fmake_vector (make_number (4), Qnil
);
2255 ASET (elt
, 0, name
);
2256 ASET (elt
, 1, ccl_prog
);
2257 ASET (elt
, 2, resolved
);
2259 ASET (Vccl_program_table
, idx
, elt
);
2262 Fput (name
, Qccl_program_idx
, make_number (idx
));
2263 return make_number (idx
);
2266 /* Register code conversion map.
2267 A code conversion map consists of numbers, Qt, Qnil, and Qlambda.
2268 The first element is the start code point.
2269 The other elements are mapped numbers.
2270 Symbol t means to map to an original number before mapping.
2271 Symbol nil means that the corresponding element is empty.
2272 Symbol lambda means to terminate mapping here.
2275 DEFUN ("register-code-conversion-map", Fregister_code_conversion_map
,
2276 Sregister_code_conversion_map
,
2278 doc
: /* Register SYMBOL as code conversion map MAP.
2279 Return index number of the registered map. */)
2281 Lisp_Object symbol
, map
;
2283 int len
= ASIZE (Vcode_conversion_map_vector
);
2287 CHECK_SYMBOL (symbol
);
2290 for (i
= 0; i
< len
; i
++)
2292 Lisp_Object slot
= AREF (Vcode_conversion_map_vector
, i
);
2297 if (EQ (symbol
, XCAR (slot
)))
2299 index
= make_number (i
);
2300 XSETCDR (slot
, map
);
2301 Fput (symbol
, Qcode_conversion_map
, map
);
2302 Fput (symbol
, Qcode_conversion_map_id
, index
);
2308 Vcode_conversion_map_vector
= larger_vector (Vcode_conversion_map_vector
,
2311 index
= make_number (i
);
2312 Fput (symbol
, Qcode_conversion_map
, map
);
2313 Fput (symbol
, Qcode_conversion_map_id
, index
);
2314 AREF (Vcode_conversion_map_vector
, i
) = Fcons (symbol
, map
);
2322 staticpro (&Vccl_program_table
);
2323 Vccl_program_table
= Fmake_vector (make_number (32), Qnil
);
2325 Qccl
= intern ("ccl");
2328 Qcclp
= intern ("cclp");
2331 Qccl_program
= intern ("ccl-program");
2332 staticpro (&Qccl_program
);
2334 Qccl_program_idx
= intern ("ccl-program-idx");
2335 staticpro (&Qccl_program_idx
);
2337 Qcode_conversion_map
= intern ("code-conversion-map");
2338 staticpro (&Qcode_conversion_map
);
2340 Qcode_conversion_map_id
= intern ("code-conversion-map-id");
2341 staticpro (&Qcode_conversion_map_id
);
2343 DEFVAR_LISP ("code-conversion-map-vector", &Vcode_conversion_map_vector
,
2344 doc
: /* Vector of code conversion maps. */);
2345 Vcode_conversion_map_vector
= Fmake_vector (make_number (16), Qnil
);
2347 DEFVAR_LISP ("font-ccl-encoder-alist", &Vfont_ccl_encoder_alist
,
2348 doc
: /* Alist of fontname patterns vs corresponding CCL program.
2349 Each element looks like (REGEXP . CCL-CODE),
2350 where CCL-CODE is a compiled CCL program.
2351 When a font whose name matches REGEXP is used for displaying a character,
2352 CCL-CODE is executed to calculate the code point in the font
2353 from the charset number and position code(s) of the character which are set
2354 in CCL registers R0, R1, and R2 before the execution.
2355 The code point in the font is set in CCL registers R1 and R2
2356 when the execution terminated.
2357 If the font is single-byte font, the register R2 is not used. */);
2358 Vfont_ccl_encoder_alist
= Qnil
;
2360 DEFVAR_LISP ("translation-hash-table-vector", &Vtranslation_hash_table_vector
,
2361 doc
: /* Vector containing all translation hash tables ever defined.
2362 Comprises pairs (SYMBOL . TABLE) where SYMBOL and TABLE were set up by calls
2363 to `define-translation-hash-table'. The vector is indexed by the table id
2365 Vtranslation_hash_table_vector
= Qnil
;
2367 defsubr (&Sccl_program_p
);
2368 defsubr (&Sccl_execute
);
2369 defsubr (&Sccl_execute_on_string
);
2370 defsubr (&Sregister_ccl_program
);
2371 defsubr (&Sregister_code_conversion_map
);
2374 /* arch-tag: bb9a37be-68ce-4576-8d3d-15d750e4a860
2375 (do not change this comment) */