1 /* CCL (Code Conversion Language) interpreter.
2 Copyright (C) 2001, 2002, 2003, 2004, 2005,
3 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
4 Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
5 2005, 2006, 2007, 2008, 2009, 2010
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 of the License, or
17 (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>. */
33 #include "character.h"
38 Lisp_Object Qccl
, Qcclp
;
40 /* This contains all code conversion map available to CCL. */
41 Lisp_Object Vcode_conversion_map_vector
;
43 /* Alist of fontname patterns vs corresponding CCL program. */
44 Lisp_Object Vfont_ccl_encoder_alist
;
46 /* This symbol is a property which associates with ccl program vector.
47 Ex: (get 'ccl-big5-encoder 'ccl-program) returns ccl program vector. */
48 Lisp_Object Qccl_program
;
50 /* These symbols are properties which associate with code conversion
51 map and their ID respectively. */
52 Lisp_Object Qcode_conversion_map
;
53 Lisp_Object Qcode_conversion_map_id
;
55 /* Symbols of ccl program have this property, a value of the property
56 is an index for Vccl_protram_table. */
57 Lisp_Object Qccl_program_idx
;
59 /* Table of registered CCL programs. Each element is a vector of
60 NAME, CCL_PROG, RESOLVEDP, and UPDATEDP, where NAME (symbol) is the
61 name of the program, CCL_PROG (vector) is the compiled code of the
62 program, RESOLVEDP (t or nil) is the flag to tell if symbols in
63 CCL_PROG is already resolved to index numbers or not, UPDATEDP (t
64 or nil) is the flat to tell if the CCL program is updated after it
66 Lisp_Object Vccl_program_table
;
68 /* Vector of registered hash tables for translation. */
69 Lisp_Object Vtranslation_hash_table_vector
;
71 /* Return a hash table of id number ID. */
72 #define GET_HASH_TABLE(id) \
73 (XHASH_TABLE (XCDR(XVECTOR(Vtranslation_hash_table_vector)->contents[(id)])))
75 extern int charset_unicode
;
77 /* CCL (Code Conversion Language) is a simple language which has
78 operations on one input buffer, one output buffer, and 7 registers.
79 The syntax of CCL is described in `ccl.el'. Emacs Lisp function
80 `ccl-compile' compiles a CCL program and produces a CCL code which
81 is a vector of integers. The structure of this vector is as
82 follows: The 1st element: buffer-magnification, a factor for the
83 size of output buffer compared with the size of input buffer. The
84 2nd element: address of CCL code to be executed when encountered
85 with end of input stream. The 3rd and the remaining elements: CCL
88 /* Header of CCL compiled code */
89 #define CCL_HEADER_BUF_MAG 0
90 #define CCL_HEADER_EOF 1
91 #define CCL_HEADER_MAIN 2
93 /* CCL code is a sequence of 28-bit non-negative integers (i.e. the
94 MSB is always 0), each contains CCL command and/or arguments in the
97 |----------------- integer (28-bit) ------------------|
98 |------- 17-bit ------|- 3-bit --|- 3-bit --|- 5-bit -|
99 |--constant argument--|-register-|-register-|-command-|
100 ccccccccccccccccc RRR rrr XXXXX
102 |------- relative address -------|-register-|-command-|
103 cccccccccccccccccccc rrr XXXXX
105 |------------- constant or other args ----------------|
106 cccccccccccccccccccccccccccc
108 where, `cc...c' is a non-negative integer indicating constant value
109 (the left most `c' is always 0) or an absolute jump address, `RRR'
110 and `rrr' are CCL register number, `XXXXX' is one of the following
115 Each comment fields shows one or more lines for command syntax and
116 the following lines for semantics of the command. In semantics, IC
117 stands for Instruction Counter. */
119 #define CCL_SetRegister 0x00 /* Set register a register value:
120 1:00000000000000000RRRrrrXXXXX
121 ------------------------------
125 #define CCL_SetShortConst 0x01 /* Set register a short constant value:
126 1:CCCCCCCCCCCCCCCCCCCCrrrXXXXX
127 ------------------------------
128 reg[rrr] = CCCCCCCCCCCCCCCCCCC;
131 #define CCL_SetConst 0x02 /* Set register a constant value:
132 1:00000000000000000000rrrXXXXX
134 ------------------------------
139 #define CCL_SetArray 0x03 /* Set register an element of array:
140 1:CCCCCCCCCCCCCCCCCRRRrrrXXXXX
144 ------------------------------
145 if (0 <= reg[RRR] < CC..C)
146 reg[rrr] = ELEMENT[reg[RRR]];
150 #define CCL_Jump 0x04 /* Jump:
151 1:A--D--D--R--E--S--S-000XXXXX
152 ------------------------------
156 /* Note: If CC..C is greater than 0, the second code is omitted. */
158 #define CCL_JumpCond 0x05 /* Jump conditional:
159 1:A--D--D--R--E--S--S-rrrXXXXX
160 ------------------------------
166 #define CCL_WriteRegisterJump 0x06 /* Write register and jump:
167 1:A--D--D--R--E--S--S-rrrXXXXX
168 ------------------------------
173 #define CCL_WriteRegisterReadJump 0x07 /* Write register, read, and jump:
174 1:A--D--D--R--E--S--S-rrrXXXXX
175 2:A--D--D--R--E--S--S-rrrYYYYY
176 -----------------------------
182 /* Note: If read is suspended, the resumed execution starts from the
183 second code (YYYYY == CCL_ReadJump). */
185 #define CCL_WriteConstJump 0x08 /* Write constant and jump:
186 1:A--D--D--R--E--S--S-000XXXXX
188 ------------------------------
193 #define CCL_WriteConstReadJump 0x09 /* Write constant, read, and jump:
194 1:A--D--D--R--E--S--S-rrrXXXXX
196 3:A--D--D--R--E--S--S-rrrYYYYY
197 -----------------------------
203 /* Note: If read is suspended, the resumed execution starts from the
204 second code (YYYYY == CCL_ReadJump). */
206 #define CCL_WriteStringJump 0x0A /* Write string and jump:
207 1:A--D--D--R--E--S--S-000XXXXX
209 3:000MSTRIN[0]STRIN[1]STRIN[2]
211 ------------------------------
213 write_multibyte_string (STRING, LENGTH);
215 write_string (STRING, LENGTH);
219 #define CCL_WriteArrayReadJump 0x0B /* Write an array element, read, and jump:
220 1:A--D--D--R--E--S--S-rrrXXXXX
225 N:A--D--D--R--E--S--S-rrrYYYYY
226 ------------------------------
227 if (0 <= reg[rrr] < LENGTH)
228 write (ELEMENT[reg[rrr]]);
229 IC += LENGTH + 2; (... pointing at N+1)
233 /* Note: If read is suspended, the resumed execution starts from the
234 Nth code (YYYYY == CCL_ReadJump). */
236 #define CCL_ReadJump 0x0C /* Read and jump:
237 1:A--D--D--R--E--S--S-rrrYYYYY
238 -----------------------------
243 #define CCL_Branch 0x0D /* Jump by branch table:
244 1:CCCCCCCCCCCCCCCCCCCCrrrXXXXX
245 2:A--D--D--R--E-S-S[0]000XXXXX
246 3:A--D--D--R--E-S-S[1]000XXXXX
248 ------------------------------
249 if (0 <= reg[rrr] < CC..C)
250 IC += ADDRESS[reg[rrr]];
252 IC += ADDRESS[CC..C];
255 #define CCL_ReadRegister 0x0E /* Read bytes into registers:
256 1:CCCCCCCCCCCCCCCCCCCCrrrXXXXX
257 2:CCCCCCCCCCCCCCCCCCCCrrrXXXXX
259 ------------------------------
264 #define CCL_WriteExprConst 0x0F /* write result of expression:
265 1:00000OPERATION000RRR000XXXXX
267 ------------------------------
268 write (reg[RRR] OPERATION CONSTANT);
272 /* Note: If the Nth read is suspended, the resumed execution starts
273 from the Nth code. */
275 #define CCL_ReadBranch 0x10 /* Read one byte into a register,
276 and jump by branch table:
277 1:CCCCCCCCCCCCCCCCCCCCrrrXXXXX
278 2:A--D--D--R--E-S-S[0]000XXXXX
279 3:A--D--D--R--E-S-S[1]000XXXXX
281 ------------------------------
283 if (0 <= reg[rrr] < CC..C)
284 IC += ADDRESS[reg[rrr]];
286 IC += ADDRESS[CC..C];
289 #define CCL_WriteRegister 0x11 /* Write registers:
290 1:CCCCCCCCCCCCCCCCCCCrrrXXXXX
291 2:CCCCCCCCCCCCCCCCCCCrrrXXXXX
293 ------------------------------
299 /* Note: If the Nth write is suspended, the resumed execution
300 starts from the Nth code. */
302 #define CCL_WriteExprRegister 0x12 /* Write result of expression
303 1:00000OPERATIONRrrRRR000XXXXX
304 ------------------------------
305 write (reg[RRR] OPERATION reg[Rrr]);
308 #define CCL_Call 0x13 /* Call the CCL program whose ID is
310 1:CCCCCCCCCCCCCCCCCCCCFFFXXXXX
311 [2:00000000cccccccccccccccccccc]
312 ------------------------------
320 #define CCL_WriteConstString 0x14 /* Write a constant or a string:
321 1:CCCCCCCCCCCCCCCCCCCCrrrXXXXX
322 [2:000MSTRIN[0]STRIN[1]STRIN[2]]
324 -----------------------------
329 write_multibyte_string (STRING, CC..C);
331 write_string (STRING, CC..C);
332 IC += (CC..C + 2) / 3;
335 #define CCL_WriteArray 0x15 /* Write an element of array:
336 1:CCCCCCCCCCCCCCCCCCCCrrrXXXXX
340 ------------------------------
341 if (0 <= reg[rrr] < CC..C)
342 write (ELEMENT[reg[rrr]]);
346 #define CCL_End 0x16 /* Terminate:
347 1:00000000000000000000000XXXXX
348 ------------------------------
352 /* The following two codes execute an assignment arithmetic/logical
353 operation. The form of the operation is like REG OP= OPERAND. */
355 #define CCL_ExprSelfConst 0x17 /* REG OP= constant:
356 1:00000OPERATION000000rrrXXXXX
358 ------------------------------
359 reg[rrr] OPERATION= CONSTANT;
362 #define CCL_ExprSelfReg 0x18 /* REG1 OP= REG2:
363 1:00000OPERATION000RRRrrrXXXXX
364 ------------------------------
365 reg[rrr] OPERATION= reg[RRR];
368 /* The following codes execute an arithmetic/logical operation. The
369 form of the operation is like REG_X = REG_Y OP OPERAND2. */
371 #define CCL_SetExprConst 0x19 /* REG_X = REG_Y OP constant:
372 1:00000OPERATION000RRRrrrXXXXX
374 ------------------------------
375 reg[rrr] = reg[RRR] OPERATION CONSTANT;
379 #define CCL_SetExprReg 0x1A /* REG1 = REG2 OP REG3:
380 1:00000OPERATIONRrrRRRrrrXXXXX
381 ------------------------------
382 reg[rrr] = reg[RRR] OPERATION reg[Rrr];
385 #define CCL_JumpCondExprConst 0x1B /* Jump conditional according to
386 an operation on constant:
387 1:A--D--D--R--E--S--S-rrrXXXXX
390 -----------------------------
391 reg[7] = reg[rrr] OPERATION CONSTANT;
398 #define CCL_JumpCondExprReg 0x1C /* Jump conditional according to
399 an operation on register:
400 1:A--D--D--R--E--S--S-rrrXXXXX
403 -----------------------------
404 reg[7] = reg[rrr] OPERATION reg[RRR];
411 #define CCL_ReadJumpCondExprConst 0x1D /* Read and jump conditional according
412 to an operation on constant:
413 1:A--D--D--R--E--S--S-rrrXXXXX
416 -----------------------------
418 reg[7] = reg[rrr] OPERATION CONSTANT;
425 #define CCL_ReadJumpCondExprReg 0x1E /* Read and jump conditional according
426 to an operation on register:
427 1:A--D--D--R--E--S--S-rrrXXXXX
430 -----------------------------
432 reg[7] = reg[rrr] OPERATION reg[RRR];
439 #define CCL_Extension 0x1F /* Extended CCL code
440 1:ExtendedCOMMNDRrrRRRrrrXXXXX
443 ------------------------------
444 extended_command (rrr,RRR,Rrr,ARGS)
448 Here after, Extended CCL Instructions.
449 Bit length of extended command is 14.
450 Therefore, the instruction code range is 0..16384(0x3fff).
453 /* Read a multibyte characeter.
454 A code point is stored into reg[rrr]. A charset ID is stored into
457 #define CCL_ReadMultibyteChar2 0x00 /* Read Multibyte Character
458 1:ExtendedCOMMNDRrrRRRrrrXXXXX */
460 /* Write a multibyte character.
461 Write a character whose code point is reg[rrr] and the charset ID
464 #define CCL_WriteMultibyteChar2 0x01 /* Write Multibyte Character
465 1:ExtendedCOMMNDRrrRRRrrrXXXXX */
467 /* Translate a character whose code point is reg[rrr] and the charset
468 ID is reg[RRR] by a translation table whose ID is reg[Rrr].
470 A translated character is set in reg[rrr] (code point) and reg[RRR]
473 #define CCL_TranslateCharacter 0x02 /* Translate a multibyte character
474 1:ExtendedCOMMNDRrrRRRrrrXXXXX */
476 /* Translate a character whose code point is reg[rrr] and the charset
477 ID is reg[RRR] by a translation table whose ID is ARGUMENT.
479 A translated character is set in reg[rrr] (code point) and reg[RRR]
482 #define CCL_TranslateCharacterConstTbl 0x03 /* Translate a multibyte character
483 1:ExtendedCOMMNDRrrRRRrrrXXXXX
484 2:ARGUMENT(Translation Table ID)
487 /* Iterate looking up MAPs for reg[rrr] starting from the Nth (N =
488 reg[RRR]) MAP until some value is found.
490 Each MAP is a Lisp vector whose element is number, nil, t, or
492 If the element is nil, ignore the map and proceed to the next map.
493 If the element is t or lambda, finish without changing reg[rrr].
494 If the element is a number, set reg[rrr] to the number and finish.
496 Detail of the map structure is descibed in the comment for
497 CCL_MapMultiple below. */
499 #define CCL_IterateMultipleMap 0x10 /* Iterate multiple maps
500 1:ExtendedCOMMNDXXXRRRrrrXXXXX
507 /* Map the code in reg[rrr] by MAPs starting from the Nth (N =
510 MAPs are supplied in the succeeding CCL codes as follows:
512 When CCL program gives this nested structure of map to this command:
515 (MAP-ID121 MAP-ID122 MAP-ID123)
518 (MAP-ID211 (MAP-ID2111) MAP-ID212)
520 the compiled CCL codes has this sequence:
521 CCL_MapMultiple (CCL code of this command)
522 16 (total number of MAPs and SEPARATORs)
540 A value of each SEPARATOR follows this rule:
541 MAP-SET := SEPARATOR [(MAP-ID | MAP-SET)]+
542 SEPARATOR := -(number of MAP-IDs and SEPARATORs in the MAP-SET)
544 (*)....Nest level of MAP-SET must not be over than MAX_MAP_SET_LEVEL.
546 When some map fails to map (i.e. it doesn't have a value for
547 reg[rrr]), the mapping is treated as identity.
549 The mapping is iterated for all maps in each map set (set of maps
550 separated by SEPARATOR) except in the case that lambda is
551 encountered. More precisely, the mapping proceeds as below:
553 At first, VAL0 is set to reg[rrr], and it is translated by the
554 first map to VAL1. Then, VAL1 is translated by the next map to
555 VAL2. This mapping is iterated until the last map is used. The
556 result of the mapping is the last value of VAL?. When the mapping
557 process reached to the end of the map set, it moves to the next
558 map set. If the next does not exit, the mapping process terminates,
559 and regard the last value as a result.
561 But, when VALm is mapped to VALn and VALn is not a number, the
562 mapping proceed as below:
564 If VALn is nil, the lastest map is ignored and the mapping of VALm
565 proceed to the next map.
567 In VALn is t, VALm is reverted to reg[rrr] and the mapping of VALm
568 proceed to the next map.
570 If VALn is lambda, move to the next map set like reaching to the
571 end of the current map set.
573 If VALn is a symbol, call the CCL program refered by it.
574 Then, use reg[rrr] as a mapped value except for -1, -2 and -3.
575 Such special values are regarded as nil, t, and lambda respectively.
577 Each map is a Lisp vector of the following format (a) or (b):
578 (a)......[STARTPOINT VAL1 VAL2 ...]
579 (b)......[t VAL STARTPOINT ENDPOINT],
581 STARTPOINT is an offset to be used for indexing a map,
582 ENDPOINT is a maximum index number of a map,
583 VAL and VALn is a number, nil, t, or lambda.
585 Valid index range of a map of type (a) is:
586 STARTPOINT <= index < STARTPOINT + map_size - 1
587 Valid index range of a map of type (b) is:
588 STARTPOINT <= index < ENDPOINT */
590 #define CCL_MapMultiple 0x11 /* Mapping by multiple code conversion maps
591 1:ExtendedCOMMNDXXXRRRrrrXXXXX
603 #define MAX_MAP_SET_LEVEL 30
611 static tr_stack mapping_stack
[MAX_MAP_SET_LEVEL
];
612 static tr_stack
*mapping_stack_pointer
;
614 /* If this variable is non-zero, it indicates the stack_idx
615 of immediately called by CCL_MapMultiple. */
616 static int stack_idx_of_map_multiple
;
618 #define PUSH_MAPPING_STACK(restlen, orig) \
621 mapping_stack_pointer->rest_length = (restlen); \
622 mapping_stack_pointer->orig_val = (orig); \
623 mapping_stack_pointer++; \
627 #define POP_MAPPING_STACK(restlen, orig) \
630 mapping_stack_pointer--; \
631 (restlen) = mapping_stack_pointer->rest_length; \
632 (orig) = mapping_stack_pointer->orig_val; \
636 #define CCL_CALL_FOR_MAP_INSTRUCTION(symbol, ret_ic) \
639 struct ccl_program called_ccl; \
640 if (stack_idx >= 256 \
641 || (setup_ccl_program (&called_ccl, (symbol)) != 0)) \
645 ccl_prog = ccl_prog_stack_struct[0].ccl_prog; \
646 ic = ccl_prog_stack_struct[0].ic; \
647 eof_ic = ccl_prog_stack_struct[0].eof_ic; \
651 ccl_prog_stack_struct[stack_idx].ccl_prog = ccl_prog; \
652 ccl_prog_stack_struct[stack_idx].ic = (ret_ic); \
653 ccl_prog_stack_struct[stack_idx].eof_ic = eof_ic; \
655 ccl_prog = called_ccl.prog; \
656 ic = CCL_HEADER_MAIN; \
657 eof_ic = XFASTINT (ccl_prog[CCL_HEADER_EOF]); \
662 #define CCL_MapSingle 0x12 /* Map by single code conversion map
663 1:ExtendedCOMMNDXXXRRRrrrXXXXX
665 ------------------------------
666 Map reg[rrr] by MAP-ID.
667 If some valid mapping is found,
668 set reg[rrr] to the result,
673 #define CCL_LookupIntConstTbl 0x13 /* Lookup multibyte character by
674 integer key. Afterwards R7 set
675 to 1 if lookup succeeded.
676 1:ExtendedCOMMNDRrrRRRXXXXXXXX
677 2:ARGUMENT(Hash table ID) */
679 #define CCL_LookupCharConstTbl 0x14 /* Lookup integer by multibyte
680 character key. Afterwards R7 set
681 to 1 if lookup succeeded.
682 1:ExtendedCOMMNDRrrRRRrrrXXXXX
683 2:ARGUMENT(Hash table ID) */
685 /* CCL arithmetic/logical operators. */
686 #define CCL_PLUS 0x00 /* X = Y + Z */
687 #define CCL_MINUS 0x01 /* X = Y - Z */
688 #define CCL_MUL 0x02 /* X = Y * Z */
689 #define CCL_DIV 0x03 /* X = Y / Z */
690 #define CCL_MOD 0x04 /* X = Y % Z */
691 #define CCL_AND 0x05 /* X = Y & Z */
692 #define CCL_OR 0x06 /* X = Y | Z */
693 #define CCL_XOR 0x07 /* X = Y ^ Z */
694 #define CCL_LSH 0x08 /* X = Y << Z */
695 #define CCL_RSH 0x09 /* X = Y >> Z */
696 #define CCL_LSH8 0x0A /* X = (Y << 8) | Z */
697 #define CCL_RSH8 0x0B /* X = Y >> 8, r[7] = Y & 0xFF */
698 #define CCL_DIVMOD 0x0C /* X = Y / Z, r[7] = Y % Z */
699 #define CCL_LS 0x10 /* X = (X < Y) */
700 #define CCL_GT 0x11 /* X = (X > Y) */
701 #define CCL_EQ 0x12 /* X = (X == Y) */
702 #define CCL_LE 0x13 /* X = (X <= Y) */
703 #define CCL_GE 0x14 /* X = (X >= Y) */
704 #define CCL_NE 0x15 /* X = (X != Y) */
706 #define CCL_DECODE_SJIS 0x16 /* X = HIGHER_BYTE (DE-SJIS (Y, Z))
707 r[7] = LOWER_BYTE (DE-SJIS (Y, Z)) */
708 #define CCL_ENCODE_SJIS 0x17 /* X = HIGHER_BYTE (SJIS (Y, Z))
709 r[7] = LOWER_BYTE (SJIS (Y, Z) */
711 /* Terminate CCL program successfully. */
712 #define CCL_SUCCESS \
715 ccl->status = CCL_STAT_SUCCESS; \
720 /* Suspend CCL program because of reading from empty input buffer or
721 writing to full output buffer. When this program is resumed, the
722 same I/O command is executed. */
723 #define CCL_SUSPEND(stat) \
727 ccl->status = stat; \
732 /* Terminate CCL program because of invalid command. Should not occur
733 in the normal case. */
736 #define CCL_INVALID_CMD \
739 ccl->status = CCL_STAT_INVALID_CMD; \
740 goto ccl_error_handler; \
746 #define CCL_INVALID_CMD \
749 ccl_debug_hook (this_ic); \
750 ccl->status = CCL_STAT_INVALID_CMD; \
751 goto ccl_error_handler; \
757 /* Encode one character CH to multibyte form and write to the current
758 output buffer. If CH is less than 256, CH is written as is. */
759 #define CCL_WRITE_CHAR(ch) \
763 else if (dst < dst_end) \
766 CCL_SUSPEND (CCL_STAT_SUSPEND_BY_DST); \
769 /* Write a string at ccl_prog[IC] of length LEN to the current output
771 #define CCL_WRITE_STRING(len) \
776 else if (dst + len <= dst_end) \
778 if (XFASTINT (ccl_prog[ic]) & 0x1000000) \
779 for (i = 0; i < len; i++) \
780 *dst++ = XFASTINT (ccl_prog[ic + i]) & 0xFFFFFF; \
782 for (i = 0; i < len; i++) \
783 *dst++ = ((XFASTINT (ccl_prog[ic + (i / 3)])) \
784 >> ((2 - (i % 3)) * 8)) & 0xFF; \
787 CCL_SUSPEND (CCL_STAT_SUSPEND_BY_DST); \
790 /* Read one byte from the current input buffer into Rth register. */
791 #define CCL_READ_CHAR(r) \
795 else if (src < src_end) \
797 else if (ccl->last_block) \
804 CCL_SUSPEND (CCL_STAT_SUSPEND_BY_SRC); \
807 /* Decode CODE by a charset whose id is ID. If ID is 0, return CODE
808 as is for backward compatibility. Assume that we can use the
809 variable `charset'. */
811 #define CCL_DECODE_CHAR(id, code) \
812 ((id) == 0 ? (code) \
813 : (charset = CHARSET_FROM_ID ((id)), DECODE_CHAR (charset, (code))))
815 /* Encode character C by some of charsets in CHARSET_LIST. Set ID to
816 the id of the used charset, ENCODED to the resulf of encoding.
817 Assume that we can use the variable `charset'. */
819 #define CCL_ENCODE_CHAR(c, charset_list, id, encoded) \
823 charset = char_charset ((c), (charset_list), &code); \
824 if (! charset && ! NILP (charset_list)) \
825 charset = char_charset ((c), Qnil, &code); \
828 (id) = CHARSET_ID (charset); \
833 /* Execute CCL code on characters at SOURCE (length SRC_SIZE). The
834 resulting text goes to a place pointed by DESTINATION, the length
835 of which should not exceed DST_SIZE. As a side effect, how many
836 characters are consumed and produced are recorded in CCL->consumed
837 and CCL->produced, and the contents of CCL registers are updated.
838 If SOURCE or DESTINATION is NULL, only operations on registers are
842 #define CCL_DEBUG_BACKTRACE_LEN 256
843 int ccl_backtrace_table
[CCL_DEBUG_BACKTRACE_LEN
];
844 int ccl_backtrace_idx
;
847 ccl_debug_hook (int ic
)
854 struct ccl_prog_stack
856 Lisp_Object
*ccl_prog
; /* Pointer to an array of CCL code. */
857 int ic
; /* Instruction Counter. */
858 int eof_ic
; /* Instruction Counter to jump on EOF. */
861 /* For the moment, we only support depth 256 of stack. */
862 static struct ccl_prog_stack ccl_prog_stack_struct
[256];
865 ccl_driver (struct ccl_program
*ccl
, int *source
, int *destination
, int src_size
, int dst_size
, Lisp_Object charset_list
)
867 register int *reg
= ccl
->reg
;
868 register int ic
= ccl
->ic
;
869 register int code
= 0, field1
, field2
;
870 register Lisp_Object
*ccl_prog
= ccl
->prog
;
871 int *src
= source
, *src_end
= src
+ src_size
;
872 int *dst
= destination
, *dst_end
= dst
+ dst_size
;
875 int stack_idx
= ccl
->stack_idx
;
876 /* Instruction counter of the current CCL code. */
878 struct charset
*charset
;
879 int eof_ic
= ccl
->eof_ic
;
882 if (ccl
->buf_magnification
== 0) /* We can't read/produce any bytes. */
885 /* Set mapping stack pointer. */
886 mapping_stack_pointer
= mapping_stack
;
889 ccl_backtrace_idx
= 0;
896 ccl_backtrace_table
[ccl_backtrace_idx
++] = ic
;
897 if (ccl_backtrace_idx
>= CCL_DEBUG_BACKTRACE_LEN
)
898 ccl_backtrace_idx
= 0;
899 ccl_backtrace_table
[ccl_backtrace_idx
] = 0;
902 if (!NILP (Vquit_flag
) && NILP (Vinhibit_quit
))
904 /* We can't just signal Qquit, instead break the loop as if
905 the whole data is processed. Don't reset Vquit_flag, it
906 must be handled later at a safer place. */
908 src
= source
+ src_size
;
909 ccl
->status
= CCL_STAT_QUIT
;
914 code
= XINT (ccl_prog
[ic
]); ic
++;
916 field2
= (code
& 0xFF) >> 5;
919 #define RRR (field1 & 7)
920 #define Rrr ((field1 >> 3) & 7)
922 #define EXCMD (field1 >> 6)
926 case CCL_SetRegister
: /* 00000000000000000RRRrrrXXXXX */
930 case CCL_SetShortConst
: /* CCCCCCCCCCCCCCCCCCCCrrrXXXXX */
934 case CCL_SetConst
: /* 00000000000000000000rrrXXXXX */
935 reg
[rrr
] = XINT (ccl_prog
[ic
]);
939 case CCL_SetArray
: /* CCCCCCCCCCCCCCCCCCCCRRRrrrXXXXX */
942 if ((unsigned int) i
< j
)
943 reg
[rrr
] = XINT (ccl_prog
[ic
+ i
]);
947 case CCL_Jump
: /* A--D--D--R--E--S--S-000XXXXX */
951 case CCL_JumpCond
: /* A--D--D--R--E--S--S-rrrXXXXX */
956 case CCL_WriteRegisterJump
: /* A--D--D--R--E--S--S-rrrXXXXX */
962 case CCL_WriteRegisterReadJump
: /* A--D--D--R--E--S--S-rrrXXXXX */
966 CCL_READ_CHAR (reg
[rrr
]);
970 case CCL_WriteConstJump
: /* A--D--D--R--E--S--S-000XXXXX */
971 i
= XINT (ccl_prog
[ic
]);
976 case CCL_WriteConstReadJump
: /* A--D--D--R--E--S--S-rrrXXXXX */
977 i
= XINT (ccl_prog
[ic
]);
980 CCL_READ_CHAR (reg
[rrr
]);
984 case CCL_WriteStringJump
: /* A--D--D--R--E--S--S-000XXXXX */
985 j
= XINT (ccl_prog
[ic
]);
987 CCL_WRITE_STRING (j
);
991 case CCL_WriteArrayReadJump
: /* A--D--D--R--E--S--S-rrrXXXXX */
993 j
= XINT (ccl_prog
[ic
]);
994 if ((unsigned int) i
< j
)
996 i
= XINT (ccl_prog
[ic
+ 1 + i
]);
1000 CCL_READ_CHAR (reg
[rrr
]);
1001 ic
+= ADDR
- (j
+ 2);
1004 case CCL_ReadJump
: /* A--D--D--R--E--S--S-rrrYYYYY */
1005 CCL_READ_CHAR (reg
[rrr
]);
1009 case CCL_ReadBranch
: /* CCCCCCCCCCCCCCCCCCCCrrrXXXXX */
1010 CCL_READ_CHAR (reg
[rrr
]);
1011 /* fall through ... */
1012 case CCL_Branch
: /* CCCCCCCCCCCCCCCCCCCCrrrXXXXX */
1013 if ((unsigned int) reg
[rrr
] < field1
)
1014 ic
+= XINT (ccl_prog
[ic
+ reg
[rrr
]]);
1016 ic
+= XINT (ccl_prog
[ic
+ field1
]);
1019 case CCL_ReadRegister
: /* CCCCCCCCCCCCCCCCCCCCrrXXXXX */
1022 CCL_READ_CHAR (reg
[rrr
]);
1024 code
= XINT (ccl_prog
[ic
]); ic
++;
1026 field2
= (code
& 0xFF) >> 5;
1030 case CCL_WriteExprConst
: /* 1:00000OPERATION000RRR000XXXXX */
1033 j
= XINT (ccl_prog
[ic
]);
1035 jump_address
= ic
+ 1;
1038 case CCL_WriteRegister
: /* CCCCCCCCCCCCCCCCCCCrrrXXXXX */
1044 code
= XINT (ccl_prog
[ic
]); ic
++;
1046 field2
= (code
& 0xFF) >> 5;
1050 case CCL_WriteExprRegister
: /* 1:00000OPERATIONRrrRRR000XXXXX */
1058 case CCL_Call
: /* 1:CCCCCCCCCCCCCCCCCCCCFFFXXXXX */
1063 /* If FFF is nonzero, the CCL program ID is in the
1067 prog_id
= XINT (ccl_prog
[ic
]);
1073 if (stack_idx
>= 256
1075 || prog_id
>= ASIZE (Vccl_program_table
)
1076 || (slot
= AREF (Vccl_program_table
, prog_id
), !VECTORP (slot
))
1077 || !VECTORP (AREF (slot
, 1)))
1081 ccl_prog
= ccl_prog_stack_struct
[0].ccl_prog
;
1082 ic
= ccl_prog_stack_struct
[0].ic
;
1083 eof_ic
= ccl_prog_stack_struct
[0].eof_ic
;
1088 ccl_prog_stack_struct
[stack_idx
].ccl_prog
= ccl_prog
;
1089 ccl_prog_stack_struct
[stack_idx
].ic
= ic
;
1090 ccl_prog_stack_struct
[stack_idx
].eof_ic
= eof_ic
;
1092 ccl_prog
= XVECTOR (AREF (slot
, 1))->contents
;
1093 ic
= CCL_HEADER_MAIN
;
1094 eof_ic
= XFASTINT (ccl_prog
[CCL_HEADER_EOF
]);
1098 case CCL_WriteConstString
: /* CCCCCCCCCCCCCCCCCCCCrrrXXXXX */
1100 CCL_WRITE_CHAR (field1
);
1103 CCL_WRITE_STRING (field1
);
1104 ic
+= (field1
+ 2) / 3;
1108 case CCL_WriteArray
: /* CCCCCCCCCCCCCCCCCCCCrrrXXXXX */
1110 if ((unsigned int) i
< field1
)
1112 j
= XINT (ccl_prog
[ic
+ i
]);
1118 case CCL_End
: /* 0000000000000000000000XXXXX */
1122 ccl_prog
= ccl_prog_stack_struct
[stack_idx
].ccl_prog
;
1123 ic
= ccl_prog_stack_struct
[stack_idx
].ic
;
1124 eof_ic
= ccl_prog_stack_struct
[stack_idx
].eof_ic
;
1131 /* ccl->ic should points to this command code again to
1132 suppress further processing. */
1136 case CCL_ExprSelfConst
: /* 00000OPERATION000000rrrXXXXX */
1137 i
= XINT (ccl_prog
[ic
]);
1142 case CCL_ExprSelfReg
: /* 00000OPERATION000RRRrrrXXXXX */
1149 case CCL_PLUS
: reg
[rrr
] += i
; break;
1150 case CCL_MINUS
: reg
[rrr
] -= i
; break;
1151 case CCL_MUL
: reg
[rrr
] *= i
; break;
1152 case CCL_DIV
: reg
[rrr
] /= i
; break;
1153 case CCL_MOD
: reg
[rrr
] %= i
; break;
1154 case CCL_AND
: reg
[rrr
] &= i
; break;
1155 case CCL_OR
: reg
[rrr
] |= i
; break;
1156 case CCL_XOR
: reg
[rrr
] ^= i
; break;
1157 case CCL_LSH
: reg
[rrr
] <<= i
; break;
1158 case CCL_RSH
: reg
[rrr
] >>= i
; break;
1159 case CCL_LSH8
: reg
[rrr
] <<= 8; reg
[rrr
] |= i
; break;
1160 case CCL_RSH8
: reg
[7] = reg
[rrr
] & 0xFF; reg
[rrr
] >>= 8; break;
1161 case CCL_DIVMOD
: reg
[7] = reg
[rrr
] % i
; reg
[rrr
] /= i
; break;
1162 case CCL_LS
: reg
[rrr
] = reg
[rrr
] < i
; break;
1163 case CCL_GT
: reg
[rrr
] = reg
[rrr
] > i
; break;
1164 case CCL_EQ
: reg
[rrr
] = reg
[rrr
] == i
; break;
1165 case CCL_LE
: reg
[rrr
] = reg
[rrr
] <= i
; break;
1166 case CCL_GE
: reg
[rrr
] = reg
[rrr
] >= i
; break;
1167 case CCL_NE
: reg
[rrr
] = reg
[rrr
] != i
; break;
1168 default: CCL_INVALID_CMD
;
1172 case CCL_SetExprConst
: /* 00000OPERATION000RRRrrrXXXXX */
1174 j
= XINT (ccl_prog
[ic
]);
1176 jump_address
= ++ic
;
1179 case CCL_SetExprReg
: /* 00000OPERATIONRrrRRRrrrXXXXX */
1186 case CCL_ReadJumpCondExprConst
: /* A--D--D--R--E--S--S-rrrXXXXX */
1187 CCL_READ_CHAR (reg
[rrr
]);
1188 case CCL_JumpCondExprConst
: /* A--D--D--R--E--S--S-rrrXXXXX */
1190 op
= XINT (ccl_prog
[ic
]);
1191 jump_address
= ic
++ + ADDR
;
1192 j
= XINT (ccl_prog
[ic
]);
1197 case CCL_ReadJumpCondExprReg
: /* A--D--D--R--E--S--S-rrrXXXXX */
1198 CCL_READ_CHAR (reg
[rrr
]);
1199 case CCL_JumpCondExprReg
:
1201 op
= XINT (ccl_prog
[ic
]);
1202 jump_address
= ic
++ + ADDR
;
1203 j
= reg
[XINT (ccl_prog
[ic
])];
1210 case CCL_PLUS
: reg
[rrr
] = i
+ j
; break;
1211 case CCL_MINUS
: reg
[rrr
] = i
- j
; break;
1212 case CCL_MUL
: reg
[rrr
] = i
* j
; break;
1213 case CCL_DIV
: reg
[rrr
] = i
/ j
; break;
1214 case CCL_MOD
: reg
[rrr
] = i
% j
; break;
1215 case CCL_AND
: reg
[rrr
] = i
& j
; break;
1216 case CCL_OR
: reg
[rrr
] = i
| j
; break;
1217 case CCL_XOR
: reg
[rrr
] = i
^ j
; break;
1218 case CCL_LSH
: reg
[rrr
] = i
<< j
; break;
1219 case CCL_RSH
: reg
[rrr
] = i
>> j
; break;
1220 case CCL_LSH8
: reg
[rrr
] = (i
<< 8) | j
; break;
1221 case CCL_RSH8
: reg
[rrr
] = i
>> 8; reg
[7] = i
& 0xFF; break;
1222 case CCL_DIVMOD
: reg
[rrr
] = i
/ j
; reg
[7] = i
% j
; break;
1223 case CCL_LS
: reg
[rrr
] = i
< j
; break;
1224 case CCL_GT
: reg
[rrr
] = i
> j
; break;
1225 case CCL_EQ
: reg
[rrr
] = i
== j
; break;
1226 case CCL_LE
: reg
[rrr
] = i
<= j
; break;
1227 case CCL_GE
: reg
[rrr
] = i
>= j
; break;
1228 case CCL_NE
: reg
[rrr
] = i
!= j
; break;
1229 case CCL_DECODE_SJIS
:
1237 case CCL_ENCODE_SJIS
:
1245 default: CCL_INVALID_CMD
;
1248 if (code
== CCL_WriteExprConst
|| code
== CCL_WriteExprRegister
)
1261 case CCL_ReadMultibyteChar2
:
1265 CCL_ENCODE_CHAR (i
, charset_list
, reg
[RRR
], reg
[rrr
]);
1268 case CCL_WriteMultibyteChar2
:
1271 i
= CCL_DECODE_CHAR (reg
[RRR
], reg
[rrr
]);
1275 case CCL_TranslateCharacter
:
1276 i
= CCL_DECODE_CHAR (reg
[RRR
], reg
[rrr
]);
1277 op
= translate_char (GET_TRANSLATION_TABLE (reg
[Rrr
]), i
);
1278 CCL_ENCODE_CHAR (op
, charset_list
, reg
[RRR
], reg
[rrr
]);
1281 case CCL_TranslateCharacterConstTbl
:
1282 op
= XINT (ccl_prog
[ic
]); /* table */
1284 i
= CCL_DECODE_CHAR (reg
[RRR
], reg
[rrr
]);
1285 op
= translate_char (GET_TRANSLATION_TABLE (op
), i
);
1286 CCL_ENCODE_CHAR (op
, charset_list
, reg
[RRR
], reg
[rrr
]);
1289 case CCL_LookupIntConstTbl
:
1290 op
= XINT (ccl_prog
[ic
]); /* table */
1293 struct Lisp_Hash_Table
*h
= GET_HASH_TABLE (op
);
1295 op
= hash_lookup (h
, make_number (reg
[RRR
]), NULL
);
1299 opl
= HASH_VALUE (h
, op
);
1300 if (! CHARACTERP (opl
))
1302 reg
[RRR
] = charset_unicode
;
1304 reg
[7] = 1; /* r7 true for success */
1311 case CCL_LookupCharConstTbl
:
1312 op
= XINT (ccl_prog
[ic
]); /* table */
1314 i
= CCL_DECODE_CHAR (reg
[RRR
], reg
[rrr
]);
1316 struct Lisp_Hash_Table
*h
= GET_HASH_TABLE (op
);
1318 op
= hash_lookup (h
, make_number (i
), NULL
);
1322 opl
= HASH_VALUE (h
, op
);
1323 if (!INTEGERP (opl
))
1325 reg
[RRR
] = XINT (opl
);
1326 reg
[7] = 1; /* r7 true for success */
1333 case CCL_IterateMultipleMap
:
1335 Lisp_Object map
, content
, attrib
, value
;
1336 int point
, size
, fin_ic
;
1338 j
= XINT (ccl_prog
[ic
++]); /* number of maps. */
1341 if ((j
> reg
[RRR
]) && (j
>= 0))
1356 size
= ASIZE (Vcode_conversion_map_vector
);
1357 point
= XINT (ccl_prog
[ic
++]);
1358 if (point
>= size
) continue;
1359 map
= AREF (Vcode_conversion_map_vector
, point
);
1361 /* Check map validity. */
1362 if (!CONSP (map
)) continue;
1364 if (!VECTORP (map
)) continue;
1366 if (size
<= 1) continue;
1368 content
= AREF (map
, 0);
1371 [STARTPOINT VAL1 VAL2 ...] or
1372 [t ELEMENT STARTPOINT ENDPOINT] */
1373 if (NUMBERP (content
))
1375 point
= XUINT (content
);
1376 point
= op
- point
+ 1;
1377 if (!((point
>= 1) && (point
< size
))) continue;
1378 content
= AREF (map
, point
);
1380 else if (EQ (content
, Qt
))
1382 if (size
!= 4) continue;
1383 if ((op
>= XUINT (AREF (map
, 2)))
1384 && (op
< XUINT (AREF (map
, 3))))
1385 content
= AREF (map
, 1);
1394 else if (NUMBERP (content
))
1397 reg
[rrr
] = XINT(content
);
1400 else if (EQ (content
, Qt
) || EQ (content
, Qlambda
))
1405 else if (CONSP (content
))
1407 attrib
= XCAR (content
);
1408 value
= XCDR (content
);
1409 if (!NUMBERP (attrib
) || !NUMBERP (value
))
1412 reg
[rrr
] = XUINT (value
);
1415 else if (SYMBOLP (content
))
1416 CCL_CALL_FOR_MAP_INSTRUCTION (content
, fin_ic
);
1426 case CCL_MapMultiple
:
1428 Lisp_Object map
, content
, attrib
, value
;
1429 int point
, size
, map_vector_size
;
1430 int map_set_rest_length
, fin_ic
;
1431 int current_ic
= this_ic
;
1433 /* inhibit recursive call on MapMultiple. */
1434 if (stack_idx_of_map_multiple
> 0)
1436 if (stack_idx_of_map_multiple
<= stack_idx
)
1438 stack_idx_of_map_multiple
= 0;
1439 mapping_stack_pointer
= mapping_stack
;
1444 mapping_stack_pointer
= mapping_stack
;
1445 stack_idx_of_map_multiple
= 0;
1447 map_set_rest_length
=
1448 XINT (ccl_prog
[ic
++]); /* number of maps and separators. */
1449 fin_ic
= ic
+ map_set_rest_length
;
1452 if ((map_set_rest_length
> reg
[RRR
]) && (reg
[RRR
] >= 0))
1456 map_set_rest_length
-= i
;
1462 mapping_stack_pointer
= mapping_stack
;
1466 if (mapping_stack_pointer
<= (mapping_stack
+ 1))
1468 /* Set up initial state. */
1469 mapping_stack_pointer
= mapping_stack
;
1470 PUSH_MAPPING_STACK (0, op
);
1475 /* Recover after calling other ccl program. */
1478 POP_MAPPING_STACK (map_set_rest_length
, orig_op
);
1479 POP_MAPPING_STACK (map_set_rest_length
, reg
[rrr
]);
1483 /* Regard it as Qnil. */
1487 map_set_rest_length
--;
1490 /* Regard it as Qt. */
1494 map_set_rest_length
--;
1497 /* Regard it as Qlambda. */
1499 i
+= map_set_rest_length
;
1500 ic
+= map_set_rest_length
;
1501 map_set_rest_length
= 0;
1504 /* Regard it as normal mapping. */
1505 i
+= map_set_rest_length
;
1506 ic
+= map_set_rest_length
;
1507 POP_MAPPING_STACK (map_set_rest_length
, reg
[rrr
]);
1511 map_vector_size
= ASIZE (Vcode_conversion_map_vector
);
1514 for (;map_set_rest_length
> 0;i
++, ic
++, map_set_rest_length
--)
1516 point
= XINT(ccl_prog
[ic
]);
1519 /* +1 is for including separator. */
1521 if (mapping_stack_pointer
1522 >= &mapping_stack
[MAX_MAP_SET_LEVEL
])
1524 PUSH_MAPPING_STACK (map_set_rest_length
- point
,
1526 map_set_rest_length
= point
;
1531 if (point
>= map_vector_size
) continue;
1532 map
= AREF (Vcode_conversion_map_vector
, point
);
1534 /* Check map validity. */
1535 if (!CONSP (map
)) continue;
1537 if (!VECTORP (map
)) continue;
1539 if (size
<= 1) continue;
1541 content
= AREF (map
, 0);
1544 [STARTPOINT VAL1 VAL2 ...] or
1545 [t ELEMENT STARTPOINT ENDPOINT] */
1546 if (NUMBERP (content
))
1548 point
= XUINT (content
);
1549 point
= op
- point
+ 1;
1550 if (!((point
>= 1) && (point
< size
))) continue;
1551 content
= AREF (map
, point
);
1553 else if (EQ (content
, Qt
))
1555 if (size
!= 4) continue;
1556 if ((op
>= XUINT (AREF (map
, 2))) &&
1557 (op
< XUINT (AREF (map
, 3))))
1558 content
= AREF (map
, 1);
1569 if (NUMBERP (content
))
1571 op
= XINT (content
);
1572 i
+= map_set_rest_length
- 1;
1573 ic
+= map_set_rest_length
- 1;
1574 POP_MAPPING_STACK (map_set_rest_length
, reg
[rrr
]);
1575 map_set_rest_length
++;
1577 else if (CONSP (content
))
1579 attrib
= XCAR (content
);
1580 value
= XCDR (content
);
1581 if (!NUMBERP (attrib
) || !NUMBERP (value
))
1584 i
+= map_set_rest_length
- 1;
1585 ic
+= map_set_rest_length
- 1;
1586 POP_MAPPING_STACK (map_set_rest_length
, reg
[rrr
]);
1587 map_set_rest_length
++;
1589 else if (EQ (content
, Qt
))
1593 else if (EQ (content
, Qlambda
))
1595 i
+= map_set_rest_length
;
1596 ic
+= map_set_rest_length
;
1599 else if (SYMBOLP (content
))
1601 if (mapping_stack_pointer
1602 >= &mapping_stack
[MAX_MAP_SET_LEVEL
])
1604 PUSH_MAPPING_STACK (map_set_rest_length
, reg
[rrr
]);
1605 PUSH_MAPPING_STACK (map_set_rest_length
, op
);
1606 stack_idx_of_map_multiple
= stack_idx
+ 1;
1607 CCL_CALL_FOR_MAP_INSTRUCTION (content
, current_ic
);
1612 if (mapping_stack_pointer
<= (mapping_stack
+ 1))
1614 POP_MAPPING_STACK (map_set_rest_length
, reg
[rrr
]);
1615 i
+= map_set_rest_length
;
1616 ic
+= map_set_rest_length
;
1617 POP_MAPPING_STACK (map_set_rest_length
, reg
[rrr
]);
1627 Lisp_Object map
, attrib
, value
, content
;
1629 j
= XINT (ccl_prog
[ic
++]); /* map_id */
1631 if (j
>= ASIZE (Vcode_conversion_map_vector
))
1636 map
= AREF (Vcode_conversion_map_vector
, j
);
1649 point
= XUINT (AREF (map
, 0));
1650 point
= op
- point
+ 1;
1653 (!((point
>= 1) && (point
< size
))))
1658 content
= AREF (map
, point
);
1661 else if (NUMBERP (content
))
1662 reg
[rrr
] = XINT (content
);
1663 else if (EQ (content
, Qt
));
1664 else if (CONSP (content
))
1666 attrib
= XCAR (content
);
1667 value
= XCDR (content
);
1668 if (!NUMBERP (attrib
) || !NUMBERP (value
))
1670 reg
[rrr
] = XUINT(value
);
1673 else if (SYMBOLP (content
))
1674 CCL_CALL_FOR_MAP_INSTRUCTION (content
, ic
);
1692 /* The suppress_error member is set when e.g. a CCL-based coding
1693 system is used for terminal output. */
1694 if (!ccl
->suppress_error
&& destination
)
1696 /* We can insert an error message only if DESTINATION is
1697 specified and we still have a room to store the message
1705 switch (ccl
->status
)
1707 case CCL_STAT_INVALID_CMD
:
1708 sprintf(msg
, "\nCCL: Invalid command %x (ccl_code = %x) at %d.",
1709 code
& 0x1F, code
, this_ic
);
1712 int i
= ccl_backtrace_idx
- 1;
1715 msglen
= strlen (msg
);
1716 if (dst
+ msglen
<= (dst_bytes
? dst_end
: src
))
1718 memcpy (dst
, msg
, msglen
);
1722 for (j
= 0; j
< CCL_DEBUG_BACKTRACE_LEN
; j
++, i
--)
1724 if (i
< 0) i
= CCL_DEBUG_BACKTRACE_LEN
- 1;
1725 if (ccl_backtrace_table
[i
] == 0)
1727 sprintf(msg
, " %d", ccl_backtrace_table
[i
]);
1728 msglen
= strlen (msg
);
1729 if (dst
+ msglen
> (dst_bytes
? dst_end
: src
))
1731 memcpy (dst
, msg
, msglen
);
1740 if (! ccl
->quit_silently
)
1741 sprintf(msg
, "\nCCL: Quited.");
1745 sprintf(msg
, "\nCCL: Unknown error type (%d)", ccl
->status
);
1748 msglen
= strlen (msg
);
1749 if (dst
+ msglen
<= dst_end
)
1751 for (i
= 0; i
< msglen
; i
++)
1755 if (ccl
->status
== CCL_STAT_INVALID_CMD
)
1757 #if 0 /* If the remaining bytes contain 0x80..0x9F, copying them
1758 results in an invalid multibyte sequence. */
1760 /* Copy the remaining source data. */
1761 int i
= src_end
- src
;
1762 if (dst_bytes
&& (dst_end
- dst
) < i
)
1764 memcpy (dst
, src
, i
);
1768 /* Signal that we've consumed everything. */
1776 ccl
->stack_idx
= stack_idx
;
1777 ccl
->prog
= ccl_prog
;
1778 ccl
->consumed
= src
- source
;
1780 ccl
->produced
= dst
- destination
;
1785 /* Resolve symbols in the specified CCL code (Lisp vector). This
1786 function converts symbols of code conversion maps and character
1787 translation tables embeded in the CCL code into their ID numbers.
1789 The return value is a vector (CCL itself or a new vector in which
1790 all symbols are resolved), Qt if resolving of some symbol failed,
1791 or nil if CCL contains invalid data. */
1794 resolve_symbol_ccl_program (Lisp_Object ccl
)
1796 int i
, veclen
, unresolved
= 0;
1797 Lisp_Object result
, contents
, val
;
1800 veclen
= ASIZE (result
);
1802 for (i
= 0; i
< veclen
; i
++)
1804 contents
= AREF (result
, i
);
1805 if (INTEGERP (contents
))
1807 else if (CONSP (contents
)
1808 && SYMBOLP (XCAR (contents
))
1809 && SYMBOLP (XCDR (contents
)))
1811 /* This is the new style for embedding symbols. The form is
1812 (SYMBOL . PROPERTY). (get SYMBOL PROPERTY) should give
1815 if (EQ (result
, ccl
))
1816 result
= Fcopy_sequence (ccl
);
1818 val
= Fget (XCAR (contents
), XCDR (contents
));
1820 ASET (result
, i
, val
);
1825 else if (SYMBOLP (contents
))
1827 /* This is the old style for embedding symbols. This style
1828 may lead to a bug if, for instance, a translation table
1829 and a code conversion map have the same name. */
1830 if (EQ (result
, ccl
))
1831 result
= Fcopy_sequence (ccl
);
1833 val
= Fget (contents
, Qtranslation_table_id
);
1835 ASET (result
, i
, val
);
1838 val
= Fget (contents
, Qcode_conversion_map_id
);
1840 ASET (result
, i
, val
);
1843 val
= Fget (contents
, Qccl_program_idx
);
1845 ASET (result
, i
, val
);
1855 return (unresolved
? Qt
: result
);
1858 /* Return the compiled code (vector) of CCL program CCL_PROG.
1859 CCL_PROG is a name (symbol) of the program or already compiled
1860 code. If necessary, resolve symbols in the compiled code to index
1861 numbers. If we failed to get the compiled code or to resolve
1862 symbols, return Qnil. */
1865 ccl_get_compiled_code (Lisp_Object ccl_prog
, int *idx
)
1867 Lisp_Object val
, slot
;
1869 if (VECTORP (ccl_prog
))
1871 val
= resolve_symbol_ccl_program (ccl_prog
);
1873 return (VECTORP (val
) ? val
: Qnil
);
1875 if (!SYMBOLP (ccl_prog
))
1878 val
= Fget (ccl_prog
, Qccl_program_idx
);
1880 || XINT (val
) >= ASIZE (Vccl_program_table
))
1882 slot
= AREF (Vccl_program_table
, XINT (val
));
1883 if (! VECTORP (slot
)
1884 || ASIZE (slot
) != 4
1885 || ! VECTORP (AREF (slot
, 1)))
1888 if (NILP (AREF (slot
, 2)))
1890 val
= resolve_symbol_ccl_program (AREF (slot
, 1));
1891 if (! VECTORP (val
))
1893 ASET (slot
, 1, val
);
1896 return AREF (slot
, 1);
1899 /* Setup fields of the structure pointed by CCL appropriately for the
1900 execution of CCL program CCL_PROG. CCL_PROG is the name (symbol)
1901 of the CCL program or the already compiled code (vector).
1902 Return 0 if we succeed this setup, else return -1.
1904 If CCL_PROG is nil, we just reset the structure pointed by CCL. */
1906 setup_ccl_program (struct ccl_program
*ccl
, Lisp_Object ccl_prog
)
1910 if (! NILP (ccl_prog
))
1912 struct Lisp_Vector
*vp
;
1914 ccl_prog
= ccl_get_compiled_code (ccl_prog
, &ccl
->idx
);
1915 if (! VECTORP (ccl_prog
))
1917 vp
= XVECTOR (ccl_prog
);
1918 ccl
->size
= vp
->size
;
1919 ccl
->prog
= vp
->contents
;
1920 ccl
->eof_ic
= XINT (vp
->contents
[CCL_HEADER_EOF
]);
1921 ccl
->buf_magnification
= XINT (vp
->contents
[CCL_HEADER_BUF_MAG
]);
1926 slot
= AREF (Vccl_program_table
, ccl
->idx
);
1927 ASET (slot
, 3, Qnil
);
1930 ccl
->ic
= CCL_HEADER_MAIN
;
1931 for (i
= 0; i
< 8; i
++)
1933 ccl
->last_block
= 0;
1934 ccl
->private_state
= 0;
1937 ccl
->suppress_error
= 0;
1938 ccl
->eight_bit_control
= 0;
1939 ccl
->quit_silently
= 0;
1944 /* Check if CCL is updated or not. If not, re-setup members of CCL. */
1947 check_ccl_update (struct ccl_program
*ccl
)
1949 Lisp_Object slot
, ccl_prog
;
1953 slot
= AREF (Vccl_program_table
, ccl
->idx
);
1954 if (NILP (AREF (slot
, 3)))
1956 ccl_prog
= ccl_get_compiled_code (AREF (slot
, 0), &ccl
->idx
);
1957 if (! VECTORP (ccl_prog
))
1959 ccl
->size
= ASIZE (ccl_prog
);
1960 ccl
->prog
= XVECTOR (ccl_prog
)->contents
;
1961 ccl
->eof_ic
= XINT (AREF (ccl_prog
, CCL_HEADER_EOF
));
1962 ccl
->buf_magnification
= XINT (AREF (ccl_prog
, CCL_HEADER_BUF_MAG
));
1963 ASET (slot
, 3, Qnil
);
1968 DEFUN ("ccl-program-p", Fccl_program_p
, Sccl_program_p
, 1, 1, 0,
1969 doc
: /* Return t if OBJECT is a CCL program name or a compiled CCL program code.
1970 See the documentation of `define-ccl-program' for the detail of CCL program. */)
1971 (Lisp_Object object
)
1975 if (VECTORP (object
))
1977 val
= resolve_symbol_ccl_program (object
);
1978 return (VECTORP (val
) ? Qt
: Qnil
);
1980 if (!SYMBOLP (object
))
1983 val
= Fget (object
, Qccl_program_idx
);
1984 return ((! NATNUMP (val
)
1985 || XINT (val
) >= ASIZE (Vccl_program_table
))
1989 DEFUN ("ccl-execute", Fccl_execute
, Sccl_execute
, 2, 2, 0,
1990 doc
: /* Execute CCL-PROGRAM with registers initialized by REGISTERS.
1992 CCL-PROGRAM is a CCL program name (symbol)
1993 or compiled code generated by `ccl-compile' (for backward compatibility.
1994 In the latter case, the execution overhead is bigger than in the former).
1995 No I/O commands should appear in CCL-PROGRAM.
1997 REGISTERS is a vector of [R0 R1 ... R7] where RN is an initial value
1998 for the Nth register.
2000 As side effect, each element of REGISTERS holds the value of
2001 the corresponding register after the execution.
2003 See the documentation of `define-ccl-program' for a definition of CCL
2005 (Lisp_Object ccl_prog
, Lisp_Object reg
)
2007 struct ccl_program ccl
;
2010 if (setup_ccl_program (&ccl
, ccl_prog
) < 0)
2011 error ("Invalid CCL program");
2014 if (ASIZE (reg
) != 8)
2015 error ("Length of vector REGISTERS is not 8");
2017 for (i
= 0; i
< 8; i
++)
2018 ccl
.reg
[i
] = (INTEGERP (AREF (reg
, i
))
2019 ? XINT (AREF (reg
, i
))
2022 ccl_driver (&ccl
, NULL
, NULL
, 0, 0, Qnil
);
2024 if (ccl
.status
!= CCL_STAT_SUCCESS
)
2025 error ("Error in CCL program at %dth code", ccl
.ic
);
2027 for (i
= 0; i
< 8; i
++)
2028 ASET (reg
, i
, make_number (ccl
.reg
[i
]));
2032 DEFUN ("ccl-execute-on-string", Fccl_execute_on_string
, Sccl_execute_on_string
,
2034 doc
: /* Execute CCL-PROGRAM with initial STATUS on STRING.
2036 CCL-PROGRAM is a symbol registered by `register-ccl-program',
2037 or a compiled code generated by `ccl-compile' (for backward compatibility,
2038 in this case, the execution is slower).
2040 Read buffer is set to STRING, and write buffer is allocated automatically.
2042 STATUS is a vector of [R0 R1 ... R7 IC], where
2043 R0..R7 are initial values of corresponding registers,
2044 IC is the instruction counter specifying from where to start the program.
2045 If R0..R7 are nil, they are initialized to 0.
2046 If IC is nil, it is initialized to head of the CCL program.
2048 If optional 4th arg CONTINUE is non-nil, keep IC on read operation
2049 when read buffer is exausted, else, IC is always set to the end of
2050 CCL-PROGRAM on exit.
2052 It returns the contents of write buffer as a string,
2053 and as side effect, STATUS is updated.
2054 If the optional 5th arg UNIBYTE-P is non-nil, the returned string
2055 is a unibyte string. By default it is a multibyte string.
2057 See the documentation of `define-ccl-program' for the detail of CCL program.
2058 usage: (ccl-execute-on-string CCL-PROGRAM STATUS STRING &optional CONTINUE UNIBYTE-P) */)
2059 (Lisp_Object ccl_prog
, Lisp_Object status
, Lisp_Object str
, Lisp_Object contin
, Lisp_Object unibyte_p
)
2062 struct ccl_program ccl
;
2065 unsigned char *outbuf
, *outp
;
2066 int str_chars
, str_bytes
;
2067 #define CCL_EXECUTE_BUF_SIZE 1024
2068 int source
[CCL_EXECUTE_BUF_SIZE
], destination
[CCL_EXECUTE_BUF_SIZE
];
2069 int consumed_chars
, consumed_bytes
, produced_chars
;
2071 if (setup_ccl_program (&ccl
, ccl_prog
) < 0)
2072 error ("Invalid CCL program");
2074 CHECK_VECTOR (status
);
2075 if (ASIZE (status
) != 9)
2076 error ("Length of vector STATUS is not 9");
2079 str_chars
= SCHARS (str
);
2080 str_bytes
= SBYTES (str
);
2082 for (i
= 0; i
< 8; i
++)
2084 if (NILP (AREF (status
, i
)))
2085 ASET (status
, i
, make_number (0));
2086 if (INTEGERP (AREF (status
, i
)))
2087 ccl
.reg
[i
] = XINT (AREF (status
, i
));
2089 if (INTEGERP (AREF (status
, i
)))
2091 i
= XFASTINT (AREF (status
, 8));
2092 if (ccl
.ic
< i
&& i
< ccl
.size
)
2096 outbufsize
= (ccl
.buf_magnification
2097 ? str_bytes
* ccl
.buf_magnification
+ 256
2099 outp
= outbuf
= (unsigned char *) xmalloc (outbufsize
);
2101 consumed_chars
= consumed_bytes
= 0;
2105 const unsigned char *p
= SDATA (str
) + consumed_bytes
;
2106 const unsigned char *endp
= SDATA (str
) + str_bytes
;
2110 if (endp
- p
== str_chars
- consumed_chars
)
2111 while (i
< CCL_EXECUTE_BUF_SIZE
&& p
< endp
)
2114 while (i
< CCL_EXECUTE_BUF_SIZE
&& p
< endp
)
2115 source
[i
++] = STRING_CHAR_ADVANCE (p
);
2116 consumed_chars
+= i
;
2117 consumed_bytes
= p
- SDATA (str
);
2119 if (consumed_bytes
== str_bytes
)
2120 ccl
.last_block
= NILP (contin
);
2125 ccl_driver (&ccl
, src
, destination
, src_size
, CCL_EXECUTE_BUF_SIZE
,
2127 produced_chars
+= ccl
.produced
;
2128 if (NILP (unibyte_p
))
2130 if (outp
- outbuf
+ MAX_MULTIBYTE_LENGTH
* ccl
.produced
2133 int offset
= outp
- outbuf
;
2134 outbufsize
+= MAX_MULTIBYTE_LENGTH
* ccl
.produced
;
2135 outbuf
= (unsigned char *) xrealloc (outbuf
, outbufsize
);
2136 outp
= outbuf
+ offset
;
2138 for (i
= 0; i
< ccl
.produced
; i
++)
2139 CHAR_STRING_ADVANCE (destination
[i
], outp
);
2143 if (outp
- outbuf
+ ccl
.produced
> outbufsize
)
2145 int offset
= outp
- outbuf
;
2146 outbufsize
+= ccl
.produced
;
2147 outbuf
= (unsigned char *) xrealloc (outbuf
, outbufsize
);
2148 outp
= outbuf
+ offset
;
2150 for (i
= 0; i
< ccl
.produced
; i
++)
2151 *outp
++ = destination
[i
];
2153 src
+= ccl
.consumed
;
2154 src_size
-= ccl
.consumed
;
2155 if (ccl
.status
!= CCL_STAT_SUSPEND_BY_DST
)
2159 if (ccl
.status
!= CCL_STAT_SUSPEND_BY_SRC
2160 || str_chars
== consumed_chars
)
2164 if (ccl
.status
== CCL_STAT_INVALID_CMD
)
2165 error ("Error in CCL program at %dth code", ccl
.ic
);
2166 if (ccl
.status
== CCL_STAT_QUIT
)
2167 error ("CCL program interrupted at %dth code", ccl
.ic
);
2169 for (i
= 0; i
< 8; i
++)
2170 ASET (status
, i
, make_number (ccl
.reg
[i
]));
2171 ASET (status
, 8, make_number (ccl
.ic
));
2173 if (NILP (unibyte_p
))
2174 val
= make_multibyte_string ((char *) outbuf
, produced_chars
,
2177 val
= make_unibyte_string ((char *) outbuf
, produced_chars
);
2183 DEFUN ("register-ccl-program", Fregister_ccl_program
, Sregister_ccl_program
,
2185 doc
: /* Register CCL program CCL-PROG as NAME in `ccl-program-table'.
2186 CCL-PROG should be a compiled CCL program (vector), or nil.
2187 If it is nil, just reserve NAME as a CCL program name.
2188 Return index number of the registered CCL program. */)
2189 (Lisp_Object name
, Lisp_Object ccl_prog
)
2191 int len
= ASIZE (Vccl_program_table
);
2193 Lisp_Object resolved
;
2195 CHECK_SYMBOL (name
);
2197 if (!NILP (ccl_prog
))
2199 CHECK_VECTOR (ccl_prog
);
2200 resolved
= resolve_symbol_ccl_program (ccl_prog
);
2201 if (NILP (resolved
))
2202 error ("Error in CCL program");
2203 if (VECTORP (resolved
))
2205 ccl_prog
= resolved
;
2212 for (idx
= 0; idx
< len
; idx
++)
2216 slot
= AREF (Vccl_program_table
, idx
);
2217 if (!VECTORP (slot
))
2218 /* This is the first unused slot. Register NAME here. */
2221 if (EQ (name
, AREF (slot
, 0)))
2223 /* Update this slot. */
2224 ASET (slot
, 1, ccl_prog
);
2225 ASET (slot
, 2, resolved
);
2227 return make_number (idx
);
2232 /* Extend the table. */
2233 Vccl_program_table
= larger_vector (Vccl_program_table
, len
* 2, Qnil
);
2238 elt
= Fmake_vector (make_number (4), Qnil
);
2239 ASET (elt
, 0, name
);
2240 ASET (elt
, 1, ccl_prog
);
2241 ASET (elt
, 2, resolved
);
2243 ASET (Vccl_program_table
, idx
, elt
);
2246 Fput (name
, Qccl_program_idx
, make_number (idx
));
2247 return make_number (idx
);
2250 /* Register code conversion map.
2251 A code conversion map consists of numbers, Qt, Qnil, and Qlambda.
2252 The first element is the start code point.
2253 The other elements are mapped numbers.
2254 Symbol t means to map to an original number before mapping.
2255 Symbol nil means that the corresponding element is empty.
2256 Symbol lambda means to terminate mapping here.
2259 DEFUN ("register-code-conversion-map", Fregister_code_conversion_map
,
2260 Sregister_code_conversion_map
,
2262 doc
: /* Register SYMBOL as code conversion map MAP.
2263 Return index number of the registered map. */)
2264 (Lisp_Object symbol
, Lisp_Object map
)
2266 int len
= ASIZE (Vcode_conversion_map_vector
);
2270 CHECK_SYMBOL (symbol
);
2273 for (i
= 0; i
< len
; i
++)
2275 Lisp_Object slot
= AREF (Vcode_conversion_map_vector
, i
);
2280 if (EQ (symbol
, XCAR (slot
)))
2282 index
= make_number (i
);
2283 XSETCDR (slot
, map
);
2284 Fput (symbol
, Qcode_conversion_map
, map
);
2285 Fput (symbol
, Qcode_conversion_map_id
, index
);
2291 Vcode_conversion_map_vector
= larger_vector (Vcode_conversion_map_vector
,
2294 index
= make_number (i
);
2295 Fput (symbol
, Qcode_conversion_map
, map
);
2296 Fput (symbol
, Qcode_conversion_map_id
, index
);
2297 ASET (Vcode_conversion_map_vector
, i
, Fcons (symbol
, map
));
2305 staticpro (&Vccl_program_table
);
2306 Vccl_program_table
= Fmake_vector (make_number (32), Qnil
);
2308 Qccl
= intern_c_string ("ccl");
2311 Qcclp
= intern_c_string ("cclp");
2314 Qccl_program
= intern_c_string ("ccl-program");
2315 staticpro (&Qccl_program
);
2317 Qccl_program_idx
= intern_c_string ("ccl-program-idx");
2318 staticpro (&Qccl_program_idx
);
2320 Qcode_conversion_map
= intern_c_string ("code-conversion-map");
2321 staticpro (&Qcode_conversion_map
);
2323 Qcode_conversion_map_id
= intern_c_string ("code-conversion-map-id");
2324 staticpro (&Qcode_conversion_map_id
);
2326 DEFVAR_LISP ("code-conversion-map-vector", &Vcode_conversion_map_vector
,
2327 doc
: /* Vector of code conversion maps. */);
2328 Vcode_conversion_map_vector
= Fmake_vector (make_number (16), Qnil
);
2330 DEFVAR_LISP ("font-ccl-encoder-alist", &Vfont_ccl_encoder_alist
,
2331 doc
: /* Alist of fontname patterns vs corresponding CCL program.
2332 Each element looks like (REGEXP . CCL-CODE),
2333 where CCL-CODE is a compiled CCL program.
2334 When a font whose name matches REGEXP is used for displaying a character,
2335 CCL-CODE is executed to calculate the code point in the font
2336 from the charset number and position code(s) of the character which are set
2337 in CCL registers R0, R1, and R2 before the execution.
2338 The code point in the font is set in CCL registers R1 and R2
2339 when the execution terminated.
2340 If the font is single-byte font, the register R2 is not used. */);
2341 Vfont_ccl_encoder_alist
= Qnil
;
2343 DEFVAR_LISP ("translation-hash-table-vector", &Vtranslation_hash_table_vector
,
2344 doc
: /* Vector containing all translation hash tables ever defined.
2345 Comprises pairs (SYMBOL . TABLE) where SYMBOL and TABLE were set up by calls
2346 to `define-translation-hash-table'. The vector is indexed by the table id
2348 Vtranslation_hash_table_vector
= Qnil
;
2350 defsubr (&Sccl_program_p
);
2351 defsubr (&Sccl_execute
);
2352 defsubr (&Sccl_execute_on_string
);
2353 defsubr (&Sregister_ccl_program
);
2354 defsubr (&Sregister_code_conversion_map
);
2357 /* arch-tag: bb9a37be-68ce-4576-8d3d-15d750e4a860
2358 (do not change this comment) */