1 /* CCL (Code Conversion Language) interpreter.
2 Copyright (C) 2001, 2002, 2003, 2004, 2005,
3 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
4 Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
5 2005, 2006, 2007, 2008, 2009
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/>. */
32 #include "character.h"
37 Lisp_Object Qccl
, Qcclp
;
39 /* This contains all code conversion map available to CCL. */
40 Lisp_Object Vcode_conversion_map_vector
;
42 /* Alist of fontname patterns vs corresponding CCL program. */
43 Lisp_Object Vfont_ccl_encoder_alist
;
45 /* This symbol is a property which assocates with ccl program vector.
46 Ex: (get 'ccl-big5-encoder 'ccl-program) returns ccl program vector. */
47 Lisp_Object Qccl_program
;
49 /* These symbols are properties which associate with code conversion
50 map and their ID respectively. */
51 Lisp_Object Qcode_conversion_map
;
52 Lisp_Object Qcode_conversion_map_id
;
54 /* Symbols of ccl program have this property, a value of the property
55 is an index for Vccl_protram_table. */
56 Lisp_Object Qccl_program_idx
;
58 /* Table of registered CCL programs. Each element is a vector of
59 NAME, CCL_PROG, RESOLVEDP, and UPDATEDP, where NAME (symbol) is the
60 name of the program, CCL_PROG (vector) is the compiled code of the
61 program, RESOLVEDP (t or nil) is the flag to tell if symbols in
62 CCL_PROG is already resolved to index numbers or not, UPDATEDP (t
63 or nil) is the flat to tell if the CCL program is updated after it
65 Lisp_Object Vccl_program_table
;
67 /* Vector of registered hash tables for translation. */
68 Lisp_Object Vtranslation_hash_table_vector
;
70 /* Return a hash table of id number ID. */
71 #define GET_HASH_TABLE(id) \
72 (XHASH_TABLE (XCDR(XVECTOR(Vtranslation_hash_table_vector)->contents[(id)])))
74 extern int charset_unicode
;
76 /* CCL (Code Conversion Language) is a simple language which has
77 operations on one input buffer, one output buffer, and 7 registers.
78 The syntax of CCL is described in `ccl.el'. Emacs Lisp function
79 `ccl-compile' compiles a CCL program and produces a CCL code which
80 is a vector of integers. The structure of this vector is as
81 follows: The 1st element: buffer-magnification, a factor for the
82 size of output buffer compared with the size of input buffer. The
83 2nd element: address of CCL code to be executed when encountered
84 with end of input stream. The 3rd and the remaining elements: CCL
87 /* Header of CCL compiled code */
88 #define CCL_HEADER_BUF_MAG 0
89 #define CCL_HEADER_EOF 1
90 #define CCL_HEADER_MAIN 2
92 /* CCL code is a sequence of 28-bit non-negative integers (i.e. the
93 MSB is always 0), each contains CCL command and/or arguments in the
96 |----------------- integer (28-bit) ------------------|
97 |------- 17-bit ------|- 3-bit --|- 3-bit --|- 5-bit -|
98 |--constant argument--|-register-|-register-|-command-|
99 ccccccccccccccccc RRR rrr XXXXX
101 |------- relative address -------|-register-|-command-|
102 cccccccccccccccccccc rrr XXXXX
104 |------------- constant or other args ----------------|
105 cccccccccccccccccccccccccccc
107 where, `cc...c' is a non-negative integer indicating constant value
108 (the left most `c' is always 0) or an absolute jump address, `RRR'
109 and `rrr' are CCL register number, `XXXXX' is one of the following
114 Each comment fields shows one or more lines for command syntax and
115 the following lines for semantics of the command. In semantics, IC
116 stands for Instruction Counter. */
118 #define CCL_SetRegister 0x00 /* Set register a register value:
119 1:00000000000000000RRRrrrXXXXX
120 ------------------------------
124 #define CCL_SetShortConst 0x01 /* Set register a short constant value:
125 1:CCCCCCCCCCCCCCCCCCCCrrrXXXXX
126 ------------------------------
127 reg[rrr] = CCCCCCCCCCCCCCCCCCC;
130 #define CCL_SetConst 0x02 /* Set register a constant value:
131 1:00000000000000000000rrrXXXXX
133 ------------------------------
138 #define CCL_SetArray 0x03 /* Set register an element of array:
139 1:CCCCCCCCCCCCCCCCCRRRrrrXXXXX
143 ------------------------------
144 if (0 <= reg[RRR] < CC..C)
145 reg[rrr] = ELEMENT[reg[RRR]];
149 #define CCL_Jump 0x04 /* Jump:
150 1:A--D--D--R--E--S--S-000XXXXX
151 ------------------------------
155 /* Note: If CC..C is greater than 0, the second code is omitted. */
157 #define CCL_JumpCond 0x05 /* Jump conditional:
158 1:A--D--D--R--E--S--S-rrrXXXXX
159 ------------------------------
165 #define CCL_WriteRegisterJump 0x06 /* Write register and jump:
166 1:A--D--D--R--E--S--S-rrrXXXXX
167 ------------------------------
172 #define CCL_WriteRegisterReadJump 0x07 /* Write register, read, and jump:
173 1:A--D--D--R--E--S--S-rrrXXXXX
174 2:A--D--D--R--E--S--S-rrrYYYYY
175 -----------------------------
181 /* Note: If read is suspended, the resumed execution starts from the
182 second code (YYYYY == CCL_ReadJump). */
184 #define CCL_WriteConstJump 0x08 /* Write constant and jump:
185 1:A--D--D--R--E--S--S-000XXXXX
187 ------------------------------
192 #define CCL_WriteConstReadJump 0x09 /* Write constant, read, and jump:
193 1:A--D--D--R--E--S--S-rrrXXXXX
195 3:A--D--D--R--E--S--S-rrrYYYYY
196 -----------------------------
202 /* Note: If read is suspended, the resumed execution starts from the
203 second code (YYYYY == CCL_ReadJump). */
205 #define CCL_WriteStringJump 0x0A /* Write string and jump:
206 1:A--D--D--R--E--S--S-000XXXXX
208 3:000MSTRIN[0]STRIN[1]STRIN[2]
210 ------------------------------
212 write_multibyte_string (STRING, LENGTH);
214 write_string (STRING, LENGTH);
218 #define CCL_WriteArrayReadJump 0x0B /* Write an array element, read, and jump:
219 1:A--D--D--R--E--S--S-rrrXXXXX
224 N:A--D--D--R--E--S--S-rrrYYYYY
225 ------------------------------
226 if (0 <= reg[rrr] < LENGTH)
227 write (ELEMENT[reg[rrr]]);
228 IC += LENGTH + 2; (... pointing at N+1)
232 /* Note: If read is suspended, the resumed execution starts from the
233 Nth code (YYYYY == CCL_ReadJump). */
235 #define CCL_ReadJump 0x0C /* Read and jump:
236 1:A--D--D--R--E--S--S-rrrYYYYY
237 -----------------------------
242 #define CCL_Branch 0x0D /* Jump by branch table:
243 1:CCCCCCCCCCCCCCCCCCCCrrrXXXXX
244 2:A--D--D--R--E-S-S[0]000XXXXX
245 3:A--D--D--R--E-S-S[1]000XXXXX
247 ------------------------------
248 if (0 <= reg[rrr] < CC..C)
249 IC += ADDRESS[reg[rrr]];
251 IC += ADDRESS[CC..C];
254 #define CCL_ReadRegister 0x0E /* Read bytes into registers:
255 1:CCCCCCCCCCCCCCCCCCCCrrrXXXXX
256 2:CCCCCCCCCCCCCCCCCCCCrrrXXXXX
258 ------------------------------
263 #define CCL_WriteExprConst 0x0F /* write result of expression:
264 1:00000OPERATION000RRR000XXXXX
266 ------------------------------
267 write (reg[RRR] OPERATION CONSTANT);
271 /* Note: If the Nth read is suspended, the resumed execution starts
272 from the Nth code. */
274 #define CCL_ReadBranch 0x10 /* Read one byte into a register,
275 and jump by branch table:
276 1:CCCCCCCCCCCCCCCCCCCCrrrXXXXX
277 2:A--D--D--R--E-S-S[0]000XXXXX
278 3:A--D--D--R--E-S-S[1]000XXXXX
280 ------------------------------
282 if (0 <= reg[rrr] < CC..C)
283 IC += ADDRESS[reg[rrr]];
285 IC += ADDRESS[CC..C];
288 #define CCL_WriteRegister 0x11 /* Write registers:
289 1:CCCCCCCCCCCCCCCCCCCrrrXXXXX
290 2:CCCCCCCCCCCCCCCCCCCrrrXXXXX
292 ------------------------------
298 /* Note: If the Nth write is suspended, the resumed execution
299 starts from the Nth code. */
301 #define CCL_WriteExprRegister 0x12 /* Write result of expression
302 1:00000OPERATIONRrrRRR000XXXXX
303 ------------------------------
304 write (reg[RRR] OPERATION reg[Rrr]);
307 #define CCL_Call 0x13 /* Call the CCL program whose ID is
309 1:CCCCCCCCCCCCCCCCCCCCFFFXXXXX
310 [2:00000000cccccccccccccccccccc]
311 ------------------------------
319 #define CCL_WriteConstString 0x14 /* Write a constant or a string:
320 1:CCCCCCCCCCCCCCCCCCCCrrrXXXXX
321 [2:000MSTRIN[0]STRIN[1]STRIN[2]]
323 -----------------------------
328 write_multibyte_string (STRING, CC..C);
330 write_string (STRING, CC..C);
331 IC += (CC..C + 2) / 3;
334 #define CCL_WriteArray 0x15 /* Write an element of array:
335 1:CCCCCCCCCCCCCCCCCCCCrrrXXXXX
339 ------------------------------
340 if (0 <= reg[rrr] < CC..C)
341 write (ELEMENT[reg[rrr]]);
345 #define CCL_End 0x16 /* Terminate:
346 1:00000000000000000000000XXXXX
347 ------------------------------
351 /* The following two codes execute an assignment arithmetic/logical
352 operation. The form of the operation is like REG OP= OPERAND. */
354 #define CCL_ExprSelfConst 0x17 /* REG OP= constant:
355 1:00000OPERATION000000rrrXXXXX
357 ------------------------------
358 reg[rrr] OPERATION= CONSTANT;
361 #define CCL_ExprSelfReg 0x18 /* REG1 OP= REG2:
362 1:00000OPERATION000RRRrrrXXXXX
363 ------------------------------
364 reg[rrr] OPERATION= reg[RRR];
367 /* The following codes execute an arithmetic/logical operation. The
368 form of the operation is like REG_X = REG_Y OP OPERAND2. */
370 #define CCL_SetExprConst 0x19 /* REG_X = REG_Y OP constant:
371 1:00000OPERATION000RRRrrrXXXXX
373 ------------------------------
374 reg[rrr] = reg[RRR] OPERATION CONSTANT;
378 #define CCL_SetExprReg 0x1A /* REG1 = REG2 OP REG3:
379 1:00000OPERATIONRrrRRRrrrXXXXX
380 ------------------------------
381 reg[rrr] = reg[RRR] OPERATION reg[Rrr];
384 #define CCL_JumpCondExprConst 0x1B /* Jump conditional according to
385 an operation on constant:
386 1:A--D--D--R--E--S--S-rrrXXXXX
389 -----------------------------
390 reg[7] = reg[rrr] OPERATION CONSTANT;
397 #define CCL_JumpCondExprReg 0x1C /* Jump conditional according to
398 an operation on register:
399 1:A--D--D--R--E--S--S-rrrXXXXX
402 -----------------------------
403 reg[7] = reg[rrr] OPERATION reg[RRR];
410 #define CCL_ReadJumpCondExprConst 0x1D /* Read and jump conditional according
411 to an operation on constant:
412 1:A--D--D--R--E--S--S-rrrXXXXX
415 -----------------------------
417 reg[7] = reg[rrr] OPERATION CONSTANT;
424 #define CCL_ReadJumpCondExprReg 0x1E /* Read and jump conditional according
425 to an operation on register:
426 1:A--D--D--R--E--S--S-rrrXXXXX
429 -----------------------------
431 reg[7] = reg[rrr] OPERATION reg[RRR];
438 #define CCL_Extension 0x1F /* Extended CCL code
439 1:ExtendedCOMMNDRrrRRRrrrXXXXX
442 ------------------------------
443 extended_command (rrr,RRR,Rrr,ARGS)
447 Here after, Extended CCL Instructions.
448 Bit length of extended command is 14.
449 Therefore, the instruction code range is 0..16384(0x3fff).
452 /* Read a multibyte characeter.
453 A code point is stored into reg[rrr]. A charset ID is stored into
456 #define CCL_ReadMultibyteChar2 0x00 /* Read Multibyte Character
457 1:ExtendedCOMMNDRrrRRRrrrXXXXX */
459 /* Write a multibyte character.
460 Write a character whose code point is reg[rrr] and the charset ID
463 #define CCL_WriteMultibyteChar2 0x01 /* Write Multibyte Character
464 1:ExtendedCOMMNDRrrRRRrrrXXXXX */
466 /* Translate a character whose code point is reg[rrr] and the charset
467 ID is reg[RRR] by a translation table whose ID is reg[Rrr].
469 A translated character is set in reg[rrr] (code point) and reg[RRR]
472 #define CCL_TranslateCharacter 0x02 /* Translate a multibyte character
473 1:ExtendedCOMMNDRrrRRRrrrXXXXX */
475 /* Translate a character whose code point is reg[rrr] and the charset
476 ID is reg[RRR] by a translation table whose ID is ARGUMENT.
478 A translated character is set in reg[rrr] (code point) and reg[RRR]
481 #define CCL_TranslateCharacterConstTbl 0x03 /* Translate a multibyte character
482 1:ExtendedCOMMNDRrrRRRrrrXXXXX
483 2:ARGUMENT(Translation Table ID)
486 /* Iterate looking up MAPs for reg[rrr] starting from the Nth (N =
487 reg[RRR]) MAP until some value is found.
489 Each MAP is a Lisp vector whose element is number, nil, t, or
491 If the element is nil, ignore the map and proceed to the next map.
492 If the element is t or lambda, finish without changing reg[rrr].
493 If the element is a number, set reg[rrr] to the number and finish.
495 Detail of the map structure is descibed in the comment for
496 CCL_MapMultiple below. */
498 #define CCL_IterateMultipleMap 0x10 /* Iterate multiple maps
499 1:ExtendedCOMMNDXXXRRRrrrXXXXX
506 /* Map the code in reg[rrr] by MAPs starting from the Nth (N =
509 MAPs are supplied in the succeeding CCL codes as follows:
511 When CCL program gives this nested structure of map to this command:
514 (MAP-ID121 MAP-ID122 MAP-ID123)
517 (MAP-ID211 (MAP-ID2111) MAP-ID212)
519 the compiled CCL codes has this sequence:
520 CCL_MapMultiple (CCL code of this command)
521 16 (total number of MAPs and SEPARATORs)
539 A value of each SEPARATOR follows this rule:
540 MAP-SET := SEPARATOR [(MAP-ID | MAP-SET)]+
541 SEPARATOR := -(number of MAP-IDs and SEPARATORs in the MAP-SET)
543 (*)....Nest level of MAP-SET must not be over than MAX_MAP_SET_LEVEL.
545 When some map fails to map (i.e. it doesn't have a value for
546 reg[rrr]), the mapping is treated as identity.
548 The mapping is iterated for all maps in each map set (set of maps
549 separated by SEPARATOR) except in the case that lambda is
550 encountered. More precisely, the mapping proceeds as below:
552 At first, VAL0 is set to reg[rrr], and it is translated by the
553 first map to VAL1. Then, VAL1 is translated by the next map to
554 VAL2. This mapping is iterated until the last map is used. The
555 result of the mapping is the last value of VAL?. When the mapping
556 process reached to the end of the map set, it moves to the next
557 map set. If the next does not exit, the mapping process terminates,
558 and regard the last value as a result.
560 But, when VALm is mapped to VALn and VALn is not a number, the
561 mapping proceed as below:
563 If VALn is nil, the lastest map is ignored and the mapping of VALm
564 proceed to the next map.
566 In VALn is t, VALm is reverted to reg[rrr] and the mapping of VALm
567 proceed to the next map.
569 If VALn is lambda, move to the next map set like reaching to the
570 end of the current map set.
572 If VALn is a symbol, call the CCL program refered by it.
573 Then, use reg[rrr] as a mapped value except for -1, -2 and -3.
574 Such special values are regarded as nil, t, and lambda respectively.
576 Each map is a Lisp vector of the following format (a) or (b):
577 (a)......[STARTPOINT VAL1 VAL2 ...]
578 (b)......[t VAL STARTPOINT ENDPOINT],
580 STARTPOINT is an offset to be used for indexing a map,
581 ENDPOINT is a maximum index number of a map,
582 VAL and VALn is a number, nil, t, or lambda.
584 Valid index range of a map of type (a) is:
585 STARTPOINT <= index < STARTPOINT + map_size - 1
586 Valid index range of a map of type (b) is:
587 STARTPOINT <= index < ENDPOINT */
589 #define CCL_MapMultiple 0x11 /* Mapping by multiple code conversion maps
590 1:ExtendedCOMMNDXXXRRRrrrXXXXX
602 #define MAX_MAP_SET_LEVEL 30
610 static tr_stack mapping_stack
[MAX_MAP_SET_LEVEL
];
611 static tr_stack
*mapping_stack_pointer
;
613 /* If this variable is non-zero, it indicates the stack_idx
614 of immediately called by CCL_MapMultiple. */
615 static int stack_idx_of_map_multiple
;
617 #define PUSH_MAPPING_STACK(restlen, orig) \
620 mapping_stack_pointer->rest_length = (restlen); \
621 mapping_stack_pointer->orig_val = (orig); \
622 mapping_stack_pointer++; \
626 #define POP_MAPPING_STACK(restlen, orig) \
629 mapping_stack_pointer--; \
630 (restlen) = mapping_stack_pointer->rest_length; \
631 (orig) = mapping_stack_pointer->orig_val; \
635 #define CCL_CALL_FOR_MAP_INSTRUCTION(symbol, ret_ic) \
638 struct ccl_program called_ccl; \
639 if (stack_idx >= 256 \
640 || (setup_ccl_program (&called_ccl, (symbol)) != 0)) \
644 ccl_prog = ccl_prog_stack_struct[0].ccl_prog; \
645 ic = ccl_prog_stack_struct[0].ic; \
646 eof_ic = ccl_prog_stack_struct[0].eof_ic; \
650 ccl_prog_stack_struct[stack_idx].ccl_prog = ccl_prog; \
651 ccl_prog_stack_struct[stack_idx].ic = (ret_ic); \
652 ccl_prog_stack_struct[stack_idx].eof_ic = eof_ic; \
654 ccl_prog = called_ccl.prog; \
655 ic = CCL_HEADER_MAIN; \
656 eof_ic = XFASTINT (ccl_prog[CCL_HEADER_EOF]); \
661 #define CCL_MapSingle 0x12 /* Map by single code conversion map
662 1:ExtendedCOMMNDXXXRRRrrrXXXXX
664 ------------------------------
665 Map reg[rrr] by MAP-ID.
666 If some valid mapping is found,
667 set reg[rrr] to the result,
672 #define CCL_LookupIntConstTbl 0x13 /* Lookup multibyte character by
673 integer key. Afterwards R7 set
674 to 1 if lookup succeeded.
675 1:ExtendedCOMMNDRrrRRRXXXXXXXX
676 2:ARGUMENT(Hash table ID) */
678 #define CCL_LookupCharConstTbl 0x14 /* Lookup integer by multibyte
679 character key. Afterwards R7 set
680 to 1 if lookup succeeded.
681 1:ExtendedCOMMNDRrrRRRrrrXXXXX
682 2:ARGUMENT(Hash table ID) */
684 /* CCL arithmetic/logical operators. */
685 #define CCL_PLUS 0x00 /* X = Y + Z */
686 #define CCL_MINUS 0x01 /* X = Y - Z */
687 #define CCL_MUL 0x02 /* X = Y * Z */
688 #define CCL_DIV 0x03 /* X = Y / Z */
689 #define CCL_MOD 0x04 /* X = Y % Z */
690 #define CCL_AND 0x05 /* X = Y & Z */
691 #define CCL_OR 0x06 /* X = Y | Z */
692 #define CCL_XOR 0x07 /* X = Y ^ Z */
693 #define CCL_LSH 0x08 /* X = Y << Z */
694 #define CCL_RSH 0x09 /* X = Y >> Z */
695 #define CCL_LSH8 0x0A /* X = (Y << 8) | Z */
696 #define CCL_RSH8 0x0B /* X = Y >> 8, r[7] = Y & 0xFF */
697 #define CCL_DIVMOD 0x0C /* X = Y / Z, r[7] = Y % Z */
698 #define CCL_LS 0x10 /* X = (X < Y) */
699 #define CCL_GT 0x11 /* X = (X > Y) */
700 #define CCL_EQ 0x12 /* X = (X == Y) */
701 #define CCL_LE 0x13 /* X = (X <= Y) */
702 #define CCL_GE 0x14 /* X = (X >= Y) */
703 #define CCL_NE 0x15 /* X = (X != Y) */
705 #define CCL_DECODE_SJIS 0x16 /* X = HIGHER_BYTE (DE-SJIS (Y, Z))
706 r[7] = LOWER_BYTE (DE-SJIS (Y, Z)) */
707 #define CCL_ENCODE_SJIS 0x17 /* X = HIGHER_BYTE (SJIS (Y, Z))
708 r[7] = LOWER_BYTE (SJIS (Y, Z) */
710 /* Terminate CCL program successfully. */
711 #define CCL_SUCCESS \
714 ccl->status = CCL_STAT_SUCCESS; \
719 /* Suspend CCL program because of reading from empty input buffer or
720 writing to full output buffer. When this program is resumed, the
721 same I/O command is executed. */
722 #define CCL_SUSPEND(stat) \
726 ccl->status = stat; \
731 /* Terminate CCL program because of invalid command. Should not occur
732 in the normal case. */
735 #define CCL_INVALID_CMD \
738 ccl->status = CCL_STAT_INVALID_CMD; \
739 goto ccl_error_handler; \
745 #define CCL_INVALID_CMD \
748 ccl_debug_hook (this_ic); \
749 ccl->status = CCL_STAT_INVALID_CMD; \
750 goto ccl_error_handler; \
756 /* Encode one character CH to multibyte form and write to the current
757 output buffer. If CH is less than 256, CH is written as is. */
758 #define CCL_WRITE_CHAR(ch) \
762 else if (dst < dst_end) \
765 CCL_SUSPEND (CCL_STAT_SUSPEND_BY_DST); \
768 /* Write a string at ccl_prog[IC] of length LEN to the current output
770 #define CCL_WRITE_STRING(len) \
775 else if (dst + len <= dst_end) \
777 if (XFASTINT (ccl_prog[ic]) & 0x1000000) \
778 for (i = 0; i < len; i++) \
779 *dst++ = XFASTINT (ccl_prog[ic + i]) & 0xFFFFFF; \
781 for (i = 0; i < len; i++) \
782 *dst++ = ((XFASTINT (ccl_prog[ic + (i / 3)])) \
783 >> ((2 - (i % 3)) * 8)) & 0xFF; \
786 CCL_SUSPEND (CCL_STAT_SUSPEND_BY_DST); \
789 /* Read one byte from the current input buffer into Rth register. */
790 #define CCL_READ_CHAR(r) \
794 else if (src < src_end) \
796 else if (ccl->last_block) \
803 CCL_SUSPEND (CCL_STAT_SUSPEND_BY_SRC); \
806 /* Decode CODE by a charset whose id is ID. If ID is 0, return CODE
807 as is for backward compatibility. Assume that we can use the
808 variable `charset'. */
810 #define CCL_DECODE_CHAR(id, code) \
811 ((id) == 0 ? (code) \
812 : (charset = CHARSET_FROM_ID ((id)), DECODE_CHAR (charset, (code))))
814 /* Encode character C by some of charsets in CHARSET_LIST. Set ID to
815 the id of the used charset, ENCODED to the resulf of encoding.
816 Assume that we can use the variable `charset'. */
818 #define CCL_ENCODE_CHAR(c, charset_list, id, encoded) \
822 charset = char_charset ((c), (charset_list), &code); \
823 if (! charset && ! NILP (charset_list)) \
824 charset = char_charset ((c), Qnil, &code); \
827 (id) = CHARSET_ID (charset); \
832 /* Execute CCL code on characters at SOURCE (length SRC_SIZE). The
833 resulting text goes to a place pointed by DESTINATION, the length
834 of which should not exceed DST_SIZE. As a side effect, how many
835 characters are consumed and produced are recorded in CCL->consumed
836 and CCL->produced, and the contents of CCL registers are updated.
837 If SOURCE or DESTINATION is NULL, only operations on registers are
841 #define CCL_DEBUG_BACKTRACE_LEN 256
842 int ccl_backtrace_table
[CCL_DEBUG_BACKTRACE_LEN
];
843 int ccl_backtrace_idx
;
846 ccl_debug_hook (int ic
)
853 struct ccl_prog_stack
855 Lisp_Object
*ccl_prog
; /* Pointer to an array of CCL code. */
856 int ic
; /* Instruction Counter. */
857 int eof_ic
; /* Instruction Counter to jump on EOF. */
860 /* For the moment, we only support depth 256 of stack. */
861 static struct ccl_prog_stack ccl_prog_stack_struct
[256];
864 ccl_driver (ccl
, source
, destination
, src_size
, dst_size
, charset_list
)
865 struct ccl_program
*ccl
;
866 int *source
, *destination
;
867 int src_size
, dst_size
;
868 Lisp_Object charset_list
;
870 register int *reg
= ccl
->reg
;
871 register int ic
= ccl
->ic
;
872 register int code
= 0, field1
, field2
;
873 register Lisp_Object
*ccl_prog
= ccl
->prog
;
874 int *src
= source
, *src_end
= src
+ src_size
;
875 int *dst
= destination
, *dst_end
= dst
+ dst_size
;
878 int stack_idx
= ccl
->stack_idx
;
879 /* Instruction counter of the current CCL code. */
881 struct charset
*charset
;
882 int eof_ic
= ccl
->eof_ic
;
886 ic
= CCL_HEADER_MAIN
;
888 if (ccl
->buf_magnification
== 0) /* We can't read/produce any bytes. */
891 /* Set mapping stack pointer. */
892 mapping_stack_pointer
= mapping_stack
;
895 ccl_backtrace_idx
= 0;
902 ccl_backtrace_table
[ccl_backtrace_idx
++] = ic
;
903 if (ccl_backtrace_idx
>= CCL_DEBUG_BACKTRACE_LEN
)
904 ccl_backtrace_idx
= 0;
905 ccl_backtrace_table
[ccl_backtrace_idx
] = 0;
908 if (!NILP (Vquit_flag
) && NILP (Vinhibit_quit
))
910 /* We can't just signal Qquit, instead break the loop as if
911 the whole data is processed. Don't reset Vquit_flag, it
912 must be handled later at a safer place. */
914 src
= source
+ src_size
;
915 ccl
->status
= CCL_STAT_QUIT
;
920 code
= XINT (ccl_prog
[ic
]); ic
++;
922 field2
= (code
& 0xFF) >> 5;
925 #define RRR (field1 & 7)
926 #define Rrr ((field1 >> 3) & 7)
928 #define EXCMD (field1 >> 6)
932 case CCL_SetRegister
: /* 00000000000000000RRRrrrXXXXX */
936 case CCL_SetShortConst
: /* CCCCCCCCCCCCCCCCCCCCrrrXXXXX */
940 case CCL_SetConst
: /* 00000000000000000000rrrXXXXX */
941 reg
[rrr
] = XINT (ccl_prog
[ic
]);
945 case CCL_SetArray
: /* CCCCCCCCCCCCCCCCCCCCRRRrrrXXXXX */
948 if ((unsigned int) i
< j
)
949 reg
[rrr
] = XINT (ccl_prog
[ic
+ i
]);
953 case CCL_Jump
: /* A--D--D--R--E--S--S-000XXXXX */
957 case CCL_JumpCond
: /* A--D--D--R--E--S--S-rrrXXXXX */
962 case CCL_WriteRegisterJump
: /* A--D--D--R--E--S--S-rrrXXXXX */
968 case CCL_WriteRegisterReadJump
: /* A--D--D--R--E--S--S-rrrXXXXX */
972 CCL_READ_CHAR (reg
[rrr
]);
976 case CCL_WriteConstJump
: /* A--D--D--R--E--S--S-000XXXXX */
977 i
= XINT (ccl_prog
[ic
]);
982 case CCL_WriteConstReadJump
: /* A--D--D--R--E--S--S-rrrXXXXX */
983 i
= XINT (ccl_prog
[ic
]);
986 CCL_READ_CHAR (reg
[rrr
]);
990 case CCL_WriteStringJump
: /* A--D--D--R--E--S--S-000XXXXX */
991 j
= XINT (ccl_prog
[ic
]);
993 CCL_WRITE_STRING (j
);
997 case CCL_WriteArrayReadJump
: /* A--D--D--R--E--S--S-rrrXXXXX */
999 j
= XINT (ccl_prog
[ic
]);
1000 if ((unsigned int) i
< j
)
1002 i
= XINT (ccl_prog
[ic
+ 1 + i
]);
1006 CCL_READ_CHAR (reg
[rrr
]);
1007 ic
+= ADDR
- (j
+ 2);
1010 case CCL_ReadJump
: /* A--D--D--R--E--S--S-rrrYYYYY */
1011 CCL_READ_CHAR (reg
[rrr
]);
1015 case CCL_ReadBranch
: /* CCCCCCCCCCCCCCCCCCCCrrrXXXXX */
1016 CCL_READ_CHAR (reg
[rrr
]);
1017 /* fall through ... */
1018 case CCL_Branch
: /* CCCCCCCCCCCCCCCCCCCCrrrXXXXX */
1019 if ((unsigned int) reg
[rrr
] < field1
)
1020 ic
+= XINT (ccl_prog
[ic
+ reg
[rrr
]]);
1022 ic
+= XINT (ccl_prog
[ic
+ field1
]);
1025 case CCL_ReadRegister
: /* CCCCCCCCCCCCCCCCCCCCrrXXXXX */
1028 CCL_READ_CHAR (reg
[rrr
]);
1030 code
= XINT (ccl_prog
[ic
]); ic
++;
1032 field2
= (code
& 0xFF) >> 5;
1036 case CCL_WriteExprConst
: /* 1:00000OPERATION000RRR000XXXXX */
1039 j
= XINT (ccl_prog
[ic
]);
1041 jump_address
= ic
+ 1;
1044 case CCL_WriteRegister
: /* CCCCCCCCCCCCCCCCCCCrrrXXXXX */
1050 code
= XINT (ccl_prog
[ic
]); ic
++;
1052 field2
= (code
& 0xFF) >> 5;
1056 case CCL_WriteExprRegister
: /* 1:00000OPERATIONRrrRRR000XXXXX */
1064 case CCL_Call
: /* 1:CCCCCCCCCCCCCCCCCCCCFFFXXXXX */
1069 /* If FFF is nonzero, the CCL program ID is in the
1073 prog_id
= XINT (ccl_prog
[ic
]);
1079 if (stack_idx
>= 256
1081 || prog_id
>= ASIZE (Vccl_program_table
)
1082 || (slot
= AREF (Vccl_program_table
, prog_id
), !VECTORP (slot
))
1083 || !VECTORP (AREF (slot
, 1)))
1087 ccl_prog
= ccl_prog_stack_struct
[0].ccl_prog
;
1088 ic
= ccl_prog_stack_struct
[0].ic
;
1089 eof_ic
= ccl_prog_stack_struct
[0].eof_ic
;
1094 ccl_prog_stack_struct
[stack_idx
].ccl_prog
= ccl_prog
;
1095 ccl_prog_stack_struct
[stack_idx
].ic
= ic
;
1096 ccl_prog_stack_struct
[stack_idx
].eof_ic
= eof_ic
;
1098 ccl_prog
= XVECTOR (AREF (slot
, 1))->contents
;
1099 ic
= CCL_HEADER_MAIN
;
1100 eof_ic
= XFASTINT (ccl_prog
[CCL_HEADER_EOF
]);
1104 case CCL_WriteConstString
: /* CCCCCCCCCCCCCCCCCCCCrrrXXXXX */
1106 CCL_WRITE_CHAR (field1
);
1109 CCL_WRITE_STRING (field1
);
1110 ic
+= (field1
+ 2) / 3;
1114 case CCL_WriteArray
: /* CCCCCCCCCCCCCCCCCCCCrrrXXXXX */
1116 if ((unsigned int) i
< field1
)
1118 j
= XINT (ccl_prog
[ic
+ i
]);
1124 case CCL_End
: /* 0000000000000000000000XXXXX */
1128 ccl_prog
= ccl_prog_stack_struct
[stack_idx
].ccl_prog
;
1129 ic
= ccl_prog_stack_struct
[stack_idx
].ic
;
1130 eof_ic
= ccl_prog_stack_struct
[stack_idx
].eof_ic
;
1137 /* ccl->ic should points to this command code again to
1138 suppress further processing. */
1142 case CCL_ExprSelfConst
: /* 00000OPERATION000000rrrXXXXX */
1143 i
= XINT (ccl_prog
[ic
]);
1148 case CCL_ExprSelfReg
: /* 00000OPERATION000RRRrrrXXXXX */
1155 case CCL_PLUS
: reg
[rrr
] += i
; break;
1156 case CCL_MINUS
: reg
[rrr
] -= i
; break;
1157 case CCL_MUL
: reg
[rrr
] *= i
; break;
1158 case CCL_DIV
: reg
[rrr
] /= i
; break;
1159 case CCL_MOD
: reg
[rrr
] %= i
; break;
1160 case CCL_AND
: reg
[rrr
] &= i
; break;
1161 case CCL_OR
: reg
[rrr
] |= i
; break;
1162 case CCL_XOR
: reg
[rrr
] ^= i
; break;
1163 case CCL_LSH
: reg
[rrr
] <<= i
; break;
1164 case CCL_RSH
: reg
[rrr
] >>= i
; break;
1165 case CCL_LSH8
: reg
[rrr
] <<= 8; reg
[rrr
] |= i
; break;
1166 case CCL_RSH8
: reg
[7] = reg
[rrr
] & 0xFF; reg
[rrr
] >>= 8; break;
1167 case CCL_DIVMOD
: reg
[7] = reg
[rrr
] % i
; reg
[rrr
] /= i
; break;
1168 case CCL_LS
: reg
[rrr
] = reg
[rrr
] < i
; break;
1169 case CCL_GT
: reg
[rrr
] = reg
[rrr
] > i
; break;
1170 case CCL_EQ
: reg
[rrr
] = reg
[rrr
] == i
; break;
1171 case CCL_LE
: reg
[rrr
] = reg
[rrr
] <= i
; break;
1172 case CCL_GE
: reg
[rrr
] = reg
[rrr
] >= i
; break;
1173 case CCL_NE
: reg
[rrr
] = reg
[rrr
] != i
; break;
1174 default: CCL_INVALID_CMD
;
1178 case CCL_SetExprConst
: /* 00000OPERATION000RRRrrrXXXXX */
1180 j
= XINT (ccl_prog
[ic
]);
1182 jump_address
= ++ic
;
1185 case CCL_SetExprReg
: /* 00000OPERATIONRrrRRRrrrXXXXX */
1192 case CCL_ReadJumpCondExprConst
: /* A--D--D--R--E--S--S-rrrXXXXX */
1193 CCL_READ_CHAR (reg
[rrr
]);
1194 case CCL_JumpCondExprConst
: /* A--D--D--R--E--S--S-rrrXXXXX */
1196 op
= XINT (ccl_prog
[ic
]);
1197 jump_address
= ic
++ + ADDR
;
1198 j
= XINT (ccl_prog
[ic
]);
1203 case CCL_ReadJumpCondExprReg
: /* A--D--D--R--E--S--S-rrrXXXXX */
1204 CCL_READ_CHAR (reg
[rrr
]);
1205 case CCL_JumpCondExprReg
:
1207 op
= XINT (ccl_prog
[ic
]);
1208 jump_address
= ic
++ + ADDR
;
1209 j
= reg
[XINT (ccl_prog
[ic
])];
1216 case CCL_PLUS
: reg
[rrr
] = i
+ j
; break;
1217 case CCL_MINUS
: reg
[rrr
] = i
- j
; break;
1218 case CCL_MUL
: reg
[rrr
] = i
* j
; break;
1219 case CCL_DIV
: reg
[rrr
] = i
/ j
; break;
1220 case CCL_MOD
: reg
[rrr
] = i
% j
; break;
1221 case CCL_AND
: reg
[rrr
] = i
& j
; break;
1222 case CCL_OR
: reg
[rrr
] = i
| j
; break;
1223 case CCL_XOR
: reg
[rrr
] = i
^ j
; break;
1224 case CCL_LSH
: reg
[rrr
] = i
<< j
; break;
1225 case CCL_RSH
: reg
[rrr
] = i
>> j
; break;
1226 case CCL_LSH8
: reg
[rrr
] = (i
<< 8) | j
; break;
1227 case CCL_RSH8
: reg
[rrr
] = i
>> 8; reg
[7] = i
& 0xFF; break;
1228 case CCL_DIVMOD
: reg
[rrr
] = i
/ j
; reg
[7] = i
% j
; break;
1229 case CCL_LS
: reg
[rrr
] = i
< j
; break;
1230 case CCL_GT
: reg
[rrr
] = i
> j
; break;
1231 case CCL_EQ
: reg
[rrr
] = i
== j
; break;
1232 case CCL_LE
: reg
[rrr
] = i
<= j
; break;
1233 case CCL_GE
: reg
[rrr
] = i
>= j
; break;
1234 case CCL_NE
: reg
[rrr
] = i
!= j
; break;
1235 case CCL_DECODE_SJIS
:
1243 case CCL_ENCODE_SJIS
:
1251 default: CCL_INVALID_CMD
;
1254 if (code
== CCL_WriteExprConst
|| code
== CCL_WriteExprRegister
)
1267 case CCL_ReadMultibyteChar2
:
1271 CCL_ENCODE_CHAR (i
, charset_list
, reg
[RRR
], reg
[rrr
]);
1274 case CCL_WriteMultibyteChar2
:
1277 i
= CCL_DECODE_CHAR (reg
[RRR
], reg
[rrr
]);
1281 case CCL_TranslateCharacter
:
1282 i
= CCL_DECODE_CHAR (reg
[RRR
], reg
[rrr
]);
1283 op
= translate_char (GET_TRANSLATION_TABLE (reg
[Rrr
]), i
);
1284 CCL_ENCODE_CHAR (op
, charset_list
, reg
[RRR
], reg
[rrr
]);
1287 case CCL_TranslateCharacterConstTbl
:
1288 op
= XINT (ccl_prog
[ic
]); /* table */
1290 i
= CCL_DECODE_CHAR (reg
[RRR
], reg
[rrr
]);
1291 op
= translate_char (GET_TRANSLATION_TABLE (op
), i
);
1292 CCL_ENCODE_CHAR (op
, charset_list
, reg
[RRR
], reg
[rrr
]);
1295 case CCL_LookupIntConstTbl
:
1296 op
= XINT (ccl_prog
[ic
]); /* table */
1299 struct Lisp_Hash_Table
*h
= GET_HASH_TABLE (op
);
1301 op
= hash_lookup (h
, make_number (reg
[RRR
]), NULL
);
1305 opl
= HASH_VALUE (h
, op
);
1306 if (! CHARACTERP (opl
))
1308 reg
[RRR
] = charset_unicode
;
1310 reg
[7] = 1; /* r7 true for success */
1317 case CCL_LookupCharConstTbl
:
1318 op
= XINT (ccl_prog
[ic
]); /* table */
1320 i
= CCL_DECODE_CHAR (reg
[RRR
], reg
[rrr
]);
1322 struct Lisp_Hash_Table
*h
= GET_HASH_TABLE (op
);
1324 op
= hash_lookup (h
, make_number (i
), NULL
);
1328 opl
= HASH_VALUE (h
, op
);
1329 if (!INTEGERP (opl
))
1331 reg
[RRR
] = XINT (opl
);
1332 reg
[7] = 1; /* r7 true for success */
1339 case CCL_IterateMultipleMap
:
1341 Lisp_Object map
, content
, attrib
, value
;
1342 int point
, size
, fin_ic
;
1344 j
= XINT (ccl_prog
[ic
++]); /* number of maps. */
1347 if ((j
> reg
[RRR
]) && (j
>= 0))
1362 size
= ASIZE (Vcode_conversion_map_vector
);
1363 point
= XINT (ccl_prog
[ic
++]);
1364 if (point
>= size
) continue;
1365 map
= AREF (Vcode_conversion_map_vector
, point
);
1367 /* Check map varidity. */
1368 if (!CONSP (map
)) continue;
1370 if (!VECTORP (map
)) continue;
1372 if (size
<= 1) continue;
1374 content
= AREF (map
, 0);
1377 [STARTPOINT VAL1 VAL2 ...] or
1378 [t ELELMENT STARTPOINT ENDPOINT] */
1379 if (NUMBERP (content
))
1381 point
= XUINT (content
);
1382 point
= op
- point
+ 1;
1383 if (!((point
>= 1) && (point
< size
))) continue;
1384 content
= AREF (map
, point
);
1386 else if (EQ (content
, Qt
))
1388 if (size
!= 4) continue;
1389 if ((op
>= XUINT (AREF (map
, 2)))
1390 && (op
< XUINT (AREF (map
, 3))))
1391 content
= AREF (map
, 1);
1400 else if (NUMBERP (content
))
1403 reg
[rrr
] = XINT(content
);
1406 else if (EQ (content
, Qt
) || EQ (content
, Qlambda
))
1411 else if (CONSP (content
))
1413 attrib
= XCAR (content
);
1414 value
= XCDR (content
);
1415 if (!NUMBERP (attrib
) || !NUMBERP (value
))
1418 reg
[rrr
] = XUINT (value
);
1421 else if (SYMBOLP (content
))
1422 CCL_CALL_FOR_MAP_INSTRUCTION (content
, fin_ic
);
1432 case CCL_MapMultiple
:
1434 Lisp_Object map
, content
, attrib
, value
;
1435 int point
, size
, map_vector_size
;
1436 int map_set_rest_length
, fin_ic
;
1437 int current_ic
= this_ic
;
1439 /* inhibit recursive call on MapMultiple. */
1440 if (stack_idx_of_map_multiple
> 0)
1442 if (stack_idx_of_map_multiple
<= stack_idx
)
1444 stack_idx_of_map_multiple
= 0;
1445 mapping_stack_pointer
= mapping_stack
;
1450 mapping_stack_pointer
= mapping_stack
;
1451 stack_idx_of_map_multiple
= 0;
1453 map_set_rest_length
=
1454 XINT (ccl_prog
[ic
++]); /* number of maps and separators. */
1455 fin_ic
= ic
+ map_set_rest_length
;
1458 if ((map_set_rest_length
> reg
[RRR
]) && (reg
[RRR
] >= 0))
1462 map_set_rest_length
-= i
;
1468 mapping_stack_pointer
= mapping_stack
;
1472 if (mapping_stack_pointer
<= (mapping_stack
+ 1))
1474 /* Set up initial state. */
1475 mapping_stack_pointer
= mapping_stack
;
1476 PUSH_MAPPING_STACK (0, op
);
1481 /* Recover after calling other ccl program. */
1484 POP_MAPPING_STACK (map_set_rest_length
, orig_op
);
1485 POP_MAPPING_STACK (map_set_rest_length
, reg
[rrr
]);
1489 /* Regard it as Qnil. */
1493 map_set_rest_length
--;
1496 /* Regard it as Qt. */
1500 map_set_rest_length
--;
1503 /* Regard it as Qlambda. */
1505 i
+= map_set_rest_length
;
1506 ic
+= map_set_rest_length
;
1507 map_set_rest_length
= 0;
1510 /* Regard it as normal mapping. */
1511 i
+= map_set_rest_length
;
1512 ic
+= map_set_rest_length
;
1513 POP_MAPPING_STACK (map_set_rest_length
, reg
[rrr
]);
1517 map_vector_size
= ASIZE (Vcode_conversion_map_vector
);
1520 for (;map_set_rest_length
> 0;i
++, ic
++, map_set_rest_length
--)
1522 point
= XINT(ccl_prog
[ic
]);
1525 /* +1 is for including separator. */
1527 if (mapping_stack_pointer
1528 >= &mapping_stack
[MAX_MAP_SET_LEVEL
])
1530 PUSH_MAPPING_STACK (map_set_rest_length
- point
,
1532 map_set_rest_length
= point
;
1537 if (point
>= map_vector_size
) continue;
1538 map
= AREF (Vcode_conversion_map_vector
, point
);
1540 /* Check map varidity. */
1541 if (!CONSP (map
)) continue;
1543 if (!VECTORP (map
)) continue;
1545 if (size
<= 1) continue;
1547 content
= AREF (map
, 0);
1550 [STARTPOINT VAL1 VAL2 ...] or
1551 [t ELEMENT STARTPOINT ENDPOINT] */
1552 if (NUMBERP (content
))
1554 point
= XUINT (content
);
1555 point
= op
- point
+ 1;
1556 if (!((point
>= 1) && (point
< size
))) continue;
1557 content
= AREF (map
, point
);
1559 else if (EQ (content
, Qt
))
1561 if (size
!= 4) continue;
1562 if ((op
>= XUINT (AREF (map
, 2))) &&
1563 (op
< XUINT (AREF (map
, 3))))
1564 content
= AREF (map
, 1);
1575 if (NUMBERP (content
))
1577 op
= XINT (content
);
1578 i
+= map_set_rest_length
- 1;
1579 ic
+= map_set_rest_length
- 1;
1580 POP_MAPPING_STACK (map_set_rest_length
, reg
[rrr
]);
1581 map_set_rest_length
++;
1583 else if (CONSP (content
))
1585 attrib
= XCAR (content
);
1586 value
= XCDR (content
);
1587 if (!NUMBERP (attrib
) || !NUMBERP (value
))
1590 i
+= map_set_rest_length
- 1;
1591 ic
+= map_set_rest_length
- 1;
1592 POP_MAPPING_STACK (map_set_rest_length
, reg
[rrr
]);
1593 map_set_rest_length
++;
1595 else if (EQ (content
, Qt
))
1599 else if (EQ (content
, Qlambda
))
1601 i
+= map_set_rest_length
;
1602 ic
+= map_set_rest_length
;
1605 else if (SYMBOLP (content
))
1607 if (mapping_stack_pointer
1608 >= &mapping_stack
[MAX_MAP_SET_LEVEL
])
1610 PUSH_MAPPING_STACK (map_set_rest_length
, reg
[rrr
]);
1611 PUSH_MAPPING_STACK (map_set_rest_length
, op
);
1612 stack_idx_of_map_multiple
= stack_idx
+ 1;
1613 CCL_CALL_FOR_MAP_INSTRUCTION (content
, current_ic
);
1618 if (mapping_stack_pointer
<= (mapping_stack
+ 1))
1620 POP_MAPPING_STACK (map_set_rest_length
, reg
[rrr
]);
1621 i
+= map_set_rest_length
;
1622 ic
+= map_set_rest_length
;
1623 POP_MAPPING_STACK (map_set_rest_length
, reg
[rrr
]);
1633 Lisp_Object map
, attrib
, value
, content
;
1635 j
= XINT (ccl_prog
[ic
++]); /* map_id */
1637 if (j
>= ASIZE (Vcode_conversion_map_vector
))
1642 map
= AREF (Vcode_conversion_map_vector
, j
);
1655 point
= XUINT (AREF (map
, 0));
1656 point
= op
- point
+ 1;
1659 (!((point
>= 1) && (point
< size
))))
1664 content
= AREF (map
, point
);
1667 else if (NUMBERP (content
))
1668 reg
[rrr
] = XINT (content
);
1669 else if (EQ (content
, Qt
));
1670 else if (CONSP (content
))
1672 attrib
= XCAR (content
);
1673 value
= XCDR (content
);
1674 if (!NUMBERP (attrib
) || !NUMBERP (value
))
1676 reg
[rrr
] = XUINT(value
);
1679 else if (SYMBOLP (content
))
1680 CCL_CALL_FOR_MAP_INSTRUCTION (content
, ic
);
1698 /* The suppress_error member is set when e.g. a CCL-based coding
1699 system is used for terminal output. */
1700 if (!ccl
->suppress_error
&& destination
)
1702 /* We can insert an error message only if DESTINATION is
1703 specified and we still have a room to store the message
1711 switch (ccl
->status
)
1713 case CCL_STAT_INVALID_CMD
:
1714 sprintf(msg
, "\nCCL: Invalid command %x (ccl_code = %x) at %d.",
1715 code
& 0x1F, code
, this_ic
);
1718 int i
= ccl_backtrace_idx
- 1;
1721 msglen
= strlen (msg
);
1722 if (dst
+ msglen
<= (dst_bytes
? dst_end
: src
))
1724 bcopy (msg
, dst
, msglen
);
1728 for (j
= 0; j
< CCL_DEBUG_BACKTRACE_LEN
; j
++, i
--)
1730 if (i
< 0) i
= CCL_DEBUG_BACKTRACE_LEN
- 1;
1731 if (ccl_backtrace_table
[i
] == 0)
1733 sprintf(msg
, " %d", ccl_backtrace_table
[i
]);
1734 msglen
= strlen (msg
);
1735 if (dst
+ msglen
> (dst_bytes
? dst_end
: src
))
1737 bcopy (msg
, dst
, msglen
);
1746 if (! ccl
->quit_silently
)
1747 sprintf(msg
, "\nCCL: Quited.");
1751 sprintf(msg
, "\nCCL: Unknown error type (%d)", ccl
->status
);
1754 msglen
= strlen (msg
);
1755 if (dst
+ msglen
<= dst_end
)
1757 for (i
= 0; i
< msglen
; i
++)
1761 if (ccl
->status
== CCL_STAT_INVALID_CMD
)
1763 #if 0 /* If the remaining bytes contain 0x80..0x9F, copying them
1764 results in an invalid multibyte sequence. */
1766 /* Copy the remaining source data. */
1767 int i
= src_end
- src
;
1768 if (dst_bytes
&& (dst_end
- dst
) < i
)
1770 bcopy (src
, dst
, i
);
1774 /* Signal that we've consumed everything. */
1782 ccl
->stack_idx
= stack_idx
;
1783 ccl
->prog
= ccl_prog
;
1784 ccl
->consumed
= src
- source
;
1786 ccl
->produced
= dst
- destination
;
1791 /* Resolve symbols in the specified CCL code (Lisp vector). This
1792 function converts symbols of code conversion maps and character
1793 translation tables embeded in the CCL code into their ID numbers.
1795 The return value is a vector (CCL itself or a new vector in which
1796 all symbols are resolved), Qt if resolving of some symbol failed,
1797 or nil if CCL contains invalid data. */
1800 resolve_symbol_ccl_program (ccl
)
1803 int i
, veclen
, unresolved
= 0;
1804 Lisp_Object result
, contents
, val
;
1807 veclen
= ASIZE (result
);
1809 for (i
= 0; i
< veclen
; i
++)
1811 contents
= AREF (result
, i
);
1812 if (INTEGERP (contents
))
1814 else if (CONSP (contents
)
1815 && SYMBOLP (XCAR (contents
))
1816 && SYMBOLP (XCDR (contents
)))
1818 /* This is the new style for embedding symbols. The form is
1819 (SYMBOL . PROPERTY). (get SYMBOL PROPERTY) should give
1822 if (EQ (result
, ccl
))
1823 result
= Fcopy_sequence (ccl
);
1825 val
= Fget (XCAR (contents
), XCDR (contents
));
1827 ASET (result
, i
, val
);
1832 else if (SYMBOLP (contents
))
1834 /* This is the old style for embedding symbols. This style
1835 may lead to a bug if, for instance, a translation table
1836 and a code conversion map have the same name. */
1837 if (EQ (result
, ccl
))
1838 result
= Fcopy_sequence (ccl
);
1840 val
= Fget (contents
, Qtranslation_table_id
);
1842 ASET (result
, i
, val
);
1845 val
= Fget (contents
, Qcode_conversion_map_id
);
1847 ASET (result
, i
, val
);
1850 val
= Fget (contents
, Qccl_program_idx
);
1852 ASET (result
, i
, val
);
1862 return (unresolved
? Qt
: result
);
1865 /* Return the compiled code (vector) of CCL program CCL_PROG.
1866 CCL_PROG is a name (symbol) of the program or already compiled
1867 code. If necessary, resolve symbols in the compiled code to index
1868 numbers. If we failed to get the compiled code or to resolve
1869 symbols, return Qnil. */
1872 ccl_get_compiled_code (ccl_prog
, idx
)
1873 Lisp_Object ccl_prog
;
1876 Lisp_Object val
, slot
;
1878 if (VECTORP (ccl_prog
))
1880 val
= resolve_symbol_ccl_program (ccl_prog
);
1882 return (VECTORP (val
) ? val
: Qnil
);
1884 if (!SYMBOLP (ccl_prog
))
1887 val
= Fget (ccl_prog
, Qccl_program_idx
);
1889 || XINT (val
) >= ASIZE (Vccl_program_table
))
1891 slot
= AREF (Vccl_program_table
, XINT (val
));
1892 if (! VECTORP (slot
)
1893 || ASIZE (slot
) != 4
1894 || ! VECTORP (AREF (slot
, 1)))
1897 if (NILP (AREF (slot
, 2)))
1899 val
= resolve_symbol_ccl_program (AREF (slot
, 1));
1900 if (! VECTORP (val
))
1902 ASET (slot
, 1, val
);
1905 return AREF (slot
, 1);
1908 /* Setup fields of the structure pointed by CCL appropriately for the
1909 execution of CCL program CCL_PROG. CCL_PROG is the name (symbol)
1910 of the CCL program or the already compiled code (vector).
1911 Return 0 if we succeed this setup, else return -1.
1913 If CCL_PROG is nil, we just reset the structure pointed by CCL. */
1915 setup_ccl_program (ccl
, ccl_prog
)
1916 struct ccl_program
*ccl
;
1917 Lisp_Object ccl_prog
;
1921 if (! NILP (ccl_prog
))
1923 struct Lisp_Vector
*vp
;
1925 ccl_prog
= ccl_get_compiled_code (ccl_prog
, &ccl
->idx
);
1926 if (! VECTORP (ccl_prog
))
1928 vp
= XVECTOR (ccl_prog
);
1929 ccl
->size
= vp
->size
;
1930 ccl
->prog
= vp
->contents
;
1931 ccl
->eof_ic
= XINT (vp
->contents
[CCL_HEADER_EOF
]);
1932 ccl
->buf_magnification
= XINT (vp
->contents
[CCL_HEADER_BUF_MAG
]);
1937 slot
= AREF (Vccl_program_table
, ccl
->idx
);
1938 ASET (slot
, 3, Qnil
);
1941 ccl
->ic
= CCL_HEADER_MAIN
;
1942 for (i
= 0; i
< 8; i
++)
1944 ccl
->last_block
= 0;
1945 ccl
->private_state
= 0;
1948 ccl
->suppress_error
= 0;
1949 ccl
->eight_bit_control
= 0;
1950 ccl
->quit_silently
= 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 ASET (reg
, i
, make_number (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 ASET (status
, i
, make_number (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 ASET (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) */