Commit | Line | Data |
---|---|---|
ca4c9455 KH |
1 | /* Composite sequence support. |
2 | Copyright (C) 1999 Electrotechnical Laboratory, JAPAN. | |
3 | Licensed to the Free Software Foundation. | |
72632c83 | 4 | Copyright (C) 2001 Free Software Foundation, Inc. |
1527c36e KH |
5 | Copyright (C) 2001, 2002 |
6 | National Institute of Advanced Industrial Science and Technology (AIST) | |
7 | Registration Number H13PRO009 | |
ca4c9455 KH |
8 | |
9 | This file is part of GNU Emacs. | |
10 | ||
11 | GNU Emacs is free software; you can redistribute it and/or modify | |
12 | it under the terms of the GNU General Public License as published by | |
13 | the Free Software Foundation; either version 2, or (at your option) | |
14 | any later version. | |
15 | ||
16 | GNU Emacs is distributed in the hope that it will be useful, | |
17 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
18 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
19 | GNU General Public License for more details. | |
20 | ||
21 | You should have received a copy of the GNU General Public License | |
22 | along with GNU Emacs; see the file COPYING. If not, write to | |
23 | the Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
24 | Boston, MA 02111-1307, USA. */ | |
25 | ||
26 | #include <config.h> | |
27 | #include "lisp.h" | |
28 | #include "buffer.h" | |
1527c36e | 29 | #include "character.h" |
ca4c9455 KH |
30 | #include "intervals.h" |
31 | ||
32 | /* Emacs uses special text property `composition' to support character | |
33 | composition. A sequence of characters that have the same (i.e. eq) | |
34 | `composition' property value is treated as a single composite | |
35 | sequence (we call it just `composition' here after). Characters in | |
36 | a composition are all composed somehow on the screen. | |
37 | ||
38 | The property value has this form when the composition is made: | |
39 | ((LENGTH . COMPONENTS) . MODIFICATION-FUNC) | |
40 | then turns to this form: | |
41 | (COMPOSITION-ID . (LENGTH COMPONENTS-VEC . MODIFICATION-FUNC)) | |
42 | when the composition is registered in composition_hash_table and | |
43 | composition_table. These rather peculiar structures were designed | |
44 | to make it easy to distinguish them quickly (we can do that by | |
45 | checking only the first element) and to extract LENGTH (from the | |
46 | former form) and COMPOSITION-ID (from the latter form). | |
47 | ||
48 | We register a composition when it is displayed, or when the width | |
49 | is required (for instance, to calculate columns). | |
50 | ||
51 | LENGTH -- Length of the composition. This information is used to | |
52 | check the validity of the composition. | |
53 | ||
54 | COMPONENTS -- Character, string, vector, list, or nil. | |
55 | ||
56 | If it is nil, characters in the text are composed relatively | |
57 | according to their metrics in font glyphs. | |
58 | ||
59 | If it is a character or a string, the character or characters | |
60 | in the string are composed relatively. | |
61 | ||
62 | If it is a vector or list of integers, the element is a | |
63 | character or an encoded composition rule. The characters are | |
64 | composed according to the rules. (2N)th elements are | |
65 | characters to be composed and (2N+1)th elements are | |
66 | composition rules to tell how to compose (2N+2)th element with | |
67 | the previously composed 2N glyphs. | |
68 | ||
69 | COMPONENTS-VEC -- Vector of integers. In relative composition, the | |
70 | elements are characters to be composed. In rule-base | |
71 | composition, the elements are characters or encoded | |
72 | composition rules. | |
73 | ||
74 | MODIFICATION-FUNC -- If non nil, it is a function to call when the | |
75 | composition gets invalid after a modification in a buffer. If | |
76 | it is nil, a function in `composition-function-table' of the | |
77 | first character in the sequence is called. | |
78 | ||
79 | COMPOSITION-ID --Identification number of the composition. It is | |
80 | used as an index to composition_table for the composition. | |
81 | ||
82 | When Emacs has to display a composition or has to know its | |
83 | displaying width, the function get_composition_id is called. It | |
84 | returns COMPOSITION-ID so that the caller can access the | |
85 | information about the composition through composition_table. If a | |
86 | COMPOSITION-ID has not yet been assigned to the composition, | |
87 | get_composition_id checks the validity of `composition' property, | |
88 | and, if valid, assigns a new ID, registers the information in | |
89 | composition_hash_table and composition_table, and changes the form | |
90 | of the property value. If the property is invalid, return -1 | |
91 | without changing the property value. | |
92 | ||
93 | We use two tables to keep information about composition; | |
94 | composition_hash_table and composition_table. | |
95 | ||
96 | The former is a hash table in which keys are COMPONENTS-VECs and | |
97 | values are the corresponding COMPOSITION-IDs. This hash table is | |
98 | weak, but as each key (COMPONENTS-VEC) is also kept as a value of | |
99 | `composition' property, it won't be collected as garbage until all | |
100 | text that have the same COMPONENTS-VEC are deleted. | |
101 | ||
102 | The latter is a table of pointers to `struct composition' indexed | |
103 | by COMPOSITION-ID. This structure keep the other information (see | |
104 | composite.h). | |
105 | ||
106 | In general, a text property holds information about individual | |
107 | characters. But, a `composition' property holds information about | |
108 | a sequence of characters (in this sense, it is like `intangible' | |
109 | property). That means that we should not share the property value | |
110 | in adjacent compositions we can't distinguish them if they have the | |
111 | same property. So, after any changes, we call | |
112 | `update_compositions' and change a property of one of adjacent | |
113 | compositions to a copy of it. This function also runs a proper | |
114 | composition modification function to make a composition that gets | |
115 | invalid by the change valid again. | |
116 | ||
117 | As a value of `composition' property holds information about a | |
118 | specific range of text, the value gets invalid if we change the | |
119 | text in the range. We treat `composition' property always | |
120 | rear-nonsticky (currently by setting default-text-properties to | |
121 | (rear-nonsticky (composition))) and we never make properties of | |
122 | adjacent compositions identical. Thus, any such changes make the | |
123 | range just shorter. So, we can check the validity of `composition' | |
124 | property by comparing LENGTH information with the actual length of | |
125 | the composition. | |
126 | ||
127 | */ | |
128 | ||
129 | ||
130 | Lisp_Object Qcomposition; | |
131 | ||
132 | /* Table of pointers to the structure `composition' indexed by | |
133 | COMPOSITION-ID. This structure is for storing information about | |
134 | each composition except for COMPONENTS-VEC. */ | |
135 | struct composition **composition_table; | |
136 | ||
137 | /* The current size of `composition_table'. */ | |
138 | static int composition_table_size; | |
139 | ||
140 | /* Number of compositions currently made. */ | |
141 | int n_compositions; | |
142 | ||
143 | /* Hash table for compositions. The key is COMPONENTS-VEC of | |
144 | `composition' property. The value is the corresponding | |
145 | COMPOSITION-ID. */ | |
146 | Lisp_Object composition_hash_table; | |
147 | ||
148 | /* Function to call to adjust composition. */ | |
149 | Lisp_Object Vcompose_chars_after_function; | |
150 | ||
40add26d KH |
151 | /* Char-table of patterns and functions to make a composition. */ |
152 | Lisp_Object Vcomposition_function_table; | |
153 | Lisp_Object Qcomposition_function_table; | |
154 | ||
ca4c9455 KH |
155 | /* Temporary variable used in macros COMPOSITION_XXX. */ |
156 | Lisp_Object composition_temp; | |
157 | \f | |
ca4c9455 KH |
158 | /* Return COMPOSITION-ID of a composition at buffer position |
159 | CHARPOS/BYTEPOS and length NCHARS. The `composition' property of | |
160 | the sequence is PROP. STRING, if non-nil, is a string that | |
161 | contains the composition instead of the current buffer. | |
162 | ||
163 | If the composition is invalid, return -1. */ | |
164 | ||
165 | int | |
166 | get_composition_id (charpos, bytepos, nchars, prop, string) | |
167 | int charpos, bytepos, nchars; | |
168 | Lisp_Object prop, string; | |
169 | { | |
170 | Lisp_Object id, length, components, key, *key_contents; | |
171 | int glyph_len; | |
172 | struct Lisp_Hash_Table *hash_table = XHASH_TABLE (composition_hash_table); | |
173 | int hash_index; | |
174 | unsigned hash_code; | |
175 | struct composition *cmp; | |
176 | int i, ch; | |
177 | ||
178 | /* PROP should be | |
179 | Form-A: ((LENGTH . COMPONENTS) . MODIFICATION-FUNC) | |
180 | or | |
181 | Form-B: (COMPOSITION-ID . (LENGTH COMPONENTS-VEC . MODIFICATION-FUNC)) | |
182 | */ | |
183 | if (nchars == 0 || !CONSP (prop)) | |
184 | goto invalid_composition; | |
185 | ||
186 | id = XCAR (prop); | |
187 | if (INTEGERP (id)) | |
188 | { | |
189 | /* PROP should be Form-B. */ | |
190 | if (XINT (id) < 0 || XINT (id) >= n_compositions) | |
191 | goto invalid_composition; | |
192 | return XINT (id); | |
193 | } | |
194 | ||
195 | /* PROP should be Form-A. | |
196 | Thus, ID should be (LENGTH . COMPONENTS). */ | |
197 | if (!CONSP (id)) | |
198 | goto invalid_composition; | |
199 | length = XCAR (id); | |
200 | if (!INTEGERP (length) || XINT (length) != nchars) | |
201 | goto invalid_composition; | |
202 | ||
203 | components = XCDR (id); | |
204 | ||
205 | /* Check if the same composition has already been registered or not | |
206 | by consulting composition_hash_table. The key for this table is | |
207 | COMPONENTS (converted to a vector COMPONENTS-VEC) or, if it is | |
208 | nil, vector of characters in the composition range. */ | |
209 | if (INTEGERP (components)) | |
210 | key = Fmake_vector (make_number (1), components); | |
211 | else if (STRINGP (components) || CONSP (components)) | |
212 | key = Fvconcat (1, &components); | |
213 | else if (VECTORP (components)) | |
214 | key = components; | |
215 | else if (NILP (components)) | |
216 | { | |
217 | key = Fmake_vector (make_number (nchars), Qnil); | |
218 | if (STRINGP (string)) | |
219 | for (i = 0; i < nchars; i++) | |
220 | { | |
221 | FETCH_STRING_CHAR_ADVANCE (ch, string, charpos, bytepos); | |
222 | XVECTOR (key)->contents[i] = make_number (ch); | |
223 | } | |
224 | else | |
225 | for (i = 0; i < nchars; i++) | |
226 | { | |
227 | FETCH_CHAR_ADVANCE (ch, charpos, bytepos); | |
228 | XVECTOR (key)->contents[i] = make_number (ch); | |
229 | } | |
230 | } | |
231 | else | |
232 | goto invalid_composition; | |
233 | ||
234 | hash_index = hash_lookup (hash_table, key, &hash_code); | |
235 | if (hash_index >= 0) | |
236 | { | |
237 | /* We have already registered the same composition. Change PROP | |
238 | from Form-A above to Form-B while replacing COMPONENTS with | |
239 | COMPONENTS-VEC stored in the hash table. We can directly | |
240 | modify the cons cell of PROP because it is not shared. */ | |
241 | key = HASH_KEY (hash_table, hash_index); | |
242 | id = HASH_VALUE (hash_table, hash_index); | |
f3fbd155 KR |
243 | XSETCAR (prop, id); |
244 | XSETCDR (prop, Fcons (make_number (nchars), Fcons (key, XCDR (prop)))); | |
ca4c9455 KH |
245 | return XINT (id); |
246 | } | |
247 | ||
248 | /* This composition is a new one. We must register it. */ | |
249 | ||
250 | /* Check if we have sufficient memory to store this information. */ | |
251 | if (composition_table_size == 0) | |
252 | { | |
253 | composition_table_size = 256; | |
254 | composition_table | |
255 | = (struct composition **) xmalloc (sizeof (composition_table[0]) | |
256 | * composition_table_size); | |
257 | } | |
258 | else if (composition_table_size <= n_compositions) | |
259 | { | |
260 | composition_table_size += 256; | |
261 | composition_table | |
262 | = (struct composition **) xrealloc (composition_table, | |
263 | sizeof (composition_table[0]) | |
264 | * composition_table_size); | |
265 | } | |
266 | ||
267 | key_contents = XVECTOR (key)->contents; | |
268 | ||
269 | /* Check if the contents of COMPONENTS are valid if COMPONENTS is a | |
270 | vector or a list. It should be a sequence of: | |
271 | char1 rule1 char2 rule2 char3 ... ruleN charN+1 */ | |
272 | if (VECTORP (components) || CONSP (components)) | |
273 | { | |
274 | int len = XVECTOR (key)->size; | |
275 | ||
276 | /* The number of elements should be odd. */ | |
277 | if ((len % 2) == 0) | |
278 | goto invalid_composition; | |
279 | /* All elements should be integers (character or encoded | |
280 | composition rule). */ | |
281 | for (i = 0; i < len; i++) | |
282 | { | |
283 | if (!INTEGERP (key_contents[i])) | |
284 | goto invalid_composition; | |
285 | } | |
286 | } | |
287 | ||
288 | /* Change PROP from Form-A above to Form-B. We can directly modify | |
289 | the cons cell of PROP because it is not shared. */ | |
290 | XSETFASTINT (id, n_compositions); | |
f3fbd155 KR |
291 | XSETCAR (prop, id); |
292 | XSETCDR (prop, Fcons (make_number (nchars), Fcons (key, XCDR (prop)))); | |
ca4c9455 KH |
293 | |
294 | /* Register the composition in composition_hash_table. */ | |
295 | hash_index = hash_put (hash_table, key, id, hash_code); | |
296 | ||
297 | /* Register the composition in composition_table. */ | |
298 | cmp = (struct composition *) xmalloc (sizeof (struct composition)); | |
299 | ||
300 | cmp->method = (NILP (components) | |
301 | ? COMPOSITION_RELATIVE | |
302 | : ((INTEGERP (components) || STRINGP (components)) | |
303 | ? COMPOSITION_WITH_ALTCHARS | |
304 | : COMPOSITION_WITH_RULE_ALTCHARS)); | |
305 | cmp->hash_index = hash_index; | |
306 | glyph_len = (cmp->method == COMPOSITION_WITH_RULE_ALTCHARS | |
307 | ? (XVECTOR (key)->size + 1) / 2 | |
308 | : XVECTOR (key)->size); | |
309 | cmp->glyph_len = glyph_len; | |
310 | cmp->offsets = (short *) xmalloc (sizeof (short) * glyph_len * 2); | |
311 | cmp->font = NULL; | |
312 | ||
313 | /* Calculate the width of overall glyphs of the composition. */ | |
314 | if (cmp->method != COMPOSITION_WITH_RULE_ALTCHARS) | |
315 | { | |
316 | /* Relative composition. */ | |
317 | cmp->width = 0; | |
318 | for (i = 0; i < glyph_len; i++) | |
319 | { | |
320 | int this_width; | |
321 | ch = XINT (key_contents[i]); | |
322 | this_width = CHAR_WIDTH (ch); | |
323 | if (cmp->width < this_width) | |
324 | cmp->width = this_width; | |
325 | } | |
326 | } | |
327 | else | |
328 | { | |
329 | /* Rule-base composition. */ | |
330 | float leftmost = 0.0, rightmost; | |
331 | ||
332 | ch = XINT (key_contents[0]); | |
333 | rightmost = CHAR_WIDTH (ch); | |
334 | ||
335 | for (i = 1; i < glyph_len; i += 2) | |
336 | { | |
337 | int rule, gref, nref; | |
338 | int this_width; | |
339 | float this_left; | |
340 | ||
341 | rule = XINT (key_contents[i]); | |
342 | ch = XINT (key_contents[i + 1]); | |
343 | this_width = CHAR_WIDTH (ch); | |
344 | ||
345 | /* A composition rule is specified by an integer value | |
346 | that encodes global and new reference points (GREF and | |
347 | NREF). GREF and NREF are specified by numbers as | |
348 | below: | |
349 | 0---1---2 -- ascent | |
350 | | | | |
351 | | | | |
352 | | | | |
353 | 9--10--11 -- center | |
354 | | | | |
355 | ---3---4---5--- baseline | |
356 | | | | |
357 | 6---7---8 -- descent | |
358 | */ | |
359 | COMPOSITION_DECODE_RULE (rule, gref, nref); | |
360 | this_left = (leftmost | |
361 | + (gref % 3) * (rightmost - leftmost) / 2.0 | |
362 | - (nref % 3) * this_width / 2.0); | |
363 | ||
364 | if (this_left < leftmost) | |
365 | leftmost = this_left; | |
366 | if (this_left + this_width > rightmost) | |
367 | rightmost = this_left + this_width; | |
368 | } | |
369 | ||
370 | cmp->width = rightmost - leftmost; | |
371 | if (cmp->width < (rightmost - leftmost)) | |
372 | /* To get a ceiling integer value. */ | |
373 | cmp->width++; | |
374 | } | |
375 | ||
376 | composition_table[n_compositions] = cmp; | |
377 | ||
378 | return n_compositions++; | |
379 | ||
380 | invalid_composition: | |
381 | /* Would it be better to remove this `composition' property? */ | |
382 | return -1; | |
383 | } | |
384 | ||
385 | \f | |
386 | /* Find a composition at or nearest to position POS of OBJECT (buffer | |
387 | or string). | |
388 | ||
389 | OBJECT defaults to the current buffer. If there's a composition at | |
390 | POS, set *START and *END to the start and end of the sequence, | |
391 | *PROP to the `composition' property, and return 1. | |
392 | ||
393 | If there's no composition at POS and LIMIT is negative, return 0. | |
394 | ||
395 | Otherwise, search for a composition forward (LIMIT > POS) or | |
396 | backward (LIMIT < POS). In this case, LIMIT bounds the search. | |
397 | ||
398 | If a composition is found, set *START, *END, and *PROP as above, | |
399 | and return 1, else return 0. | |
400 | ||
401 | This doesn't check the validity of composition. */ | |
402 | ||
403 | int | |
404 | find_composition (pos, limit, start, end, prop, object) | |
405 | int pos, limit, *start, *end; | |
406 | Lisp_Object *prop, object; | |
407 | { | |
408 | Lisp_Object val; | |
409 | ||
410 | if (get_property_and_range (pos, Qcomposition, prop, start, end, object)) | |
411 | return 1; | |
412 | ||
413 | if (limit < 0 || limit == pos) | |
414 | return 0; | |
415 | ||
416 | if (limit > pos) /* search forward */ | |
d279f620 KH |
417 | { |
418 | val = Fnext_single_property_change (make_number (pos), Qcomposition, | |
419 | object, make_number (limit)); | |
420 | pos = XINT (val); | |
421 | if (pos == limit) | |
422 | return 0; | |
423 | } | |
ca4c9455 | 424 | else /* search backward */ |
d279f620 KH |
425 | { |
426 | if (get_property_and_range (pos - 1, Qcomposition, prop, start, end, | |
427 | object)) | |
428 | return 1; | |
429 | val = Fprevious_single_property_change (make_number (pos), Qcomposition, | |
430 | object, make_number (limit)); | |
431 | pos = XINT (val); | |
432 | if (pos == limit) | |
433 | return 0; | |
434 | pos--; | |
435 | } | |
ca4c9455 KH |
436 | get_property_and_range (pos, Qcomposition, prop, start, end, object); |
437 | return 1; | |
438 | } | |
439 | ||
440 | /* Run a proper function to adjust the composition sitting between | |
441 | FROM and TO with property PROP. */ | |
442 | ||
443 | static void | |
444 | run_composition_function (from, to, prop) | |
445 | int from, to; | |
446 | Lisp_Object prop; | |
447 | { | |
7d019510 | 448 | Lisp_Object func; |
ca4c9455 KH |
449 | int start, end; |
450 | ||
451 | func = COMPOSITION_MODIFICATION_FUNC (prop); | |
452 | /* If an invalid composition precedes or follows, try to make them | |
453 | valid too. */ | |
454 | if (from > BEGV | |
455 | && find_composition (from - 1, -1, &start, &end, &prop, Qnil) | |
456 | && !COMPOSITION_VALID_P (start, end, prop)) | |
457 | from = start; | |
458 | if (to < ZV | |
459 | && find_composition (to, -1, &start, &end, &prop, Qnil) | |
460 | && !COMPOSITION_VALID_P (start, end, prop)) | |
461 | to = end; | |
462 | if (!NILP (func)) | |
463 | call2 (func, make_number (from), make_number (to)); | |
09654086 | 464 | else if (!NILP (Ffboundp (Vcompose_chars_after_function))) |
40add26d KH |
465 | call3 (Vcompose_chars_after_function, |
466 | make_number (from), make_number (to), Qnil); | |
ca4c9455 KH |
467 | } |
468 | ||
469 | /* Make invalid compositions adjacent to or inside FROM and TO valid. | |
470 | CHECK_MASK is bitwise `or' of mask bits defined by macros | |
471 | CHECK_XXX (see the comment in composite.h). | |
472 | ||
473 | This function is called when a buffer text is changed. If the | |
474 | change is deletion, FROM == TO. Otherwise, FROM < TO. */ | |
475 | ||
476 | void | |
477 | update_compositions (from, to, check_mask) | |
8e8b9e3e | 478 | int from, to, check_mask; |
ca4c9455 | 479 | { |
7d019510 | 480 | Lisp_Object prop; |
ca4c9455 KH |
481 | int start, end; |
482 | ||
6c1aa7f1 GM |
483 | if (inhibit_modification_hooks) |
484 | return; | |
485 | ||
d3f40cbd KH |
486 | /* If FROM and TO are not in a valid range, do nothing. */ |
487 | if (! (BEGV <= from && from <= to && to <= ZV)) | |
488 | return; | |
489 | ||
ca4c9455 KH |
490 | if (check_mask & CHECK_HEAD) |
491 | { | |
492 | /* FROM should be at composition boundary. But, insertion or | |
493 | deletion will make two compositions adjacent and | |
494 | indistinguishable when they have same (eq) property. To | |
495 | avoid it, in such a case, we change the property of the | |
496 | latter to the copy of it. */ | |
497 | if (from > BEGV | |
498 | && find_composition (from - 1, -1, &start, &end, &prop, Qnil)) | |
499 | { | |
500 | if (from < end) | |
501 | Fput_text_property (make_number (from), make_number (end), | |
502 | Qcomposition, | |
503 | Fcons (XCAR (prop), XCDR (prop)), Qnil); | |
504 | run_composition_function (start, end, prop); | |
505 | from = end; | |
506 | } | |
dd33cc56 | 507 | else if (from < ZV |
ca4c9455 KH |
508 | && find_composition (from, -1, &start, &from, &prop, Qnil)) |
509 | run_composition_function (start, from, prop); | |
510 | } | |
511 | ||
512 | if (check_mask & CHECK_INSIDE) | |
513 | { | |
514 | /* In this case, we are sure that (check & CHECK_TAIL) is also | |
515 | nonzero. Thus, here we should check only compositions before | |
516 | (to - 1). */ | |
517 | while (from < to - 1 | |
518 | && find_composition (from, to, &start, &from, &prop, Qnil) | |
519 | && from < to - 1) | |
520 | run_composition_function (start, from, prop); | |
521 | } | |
522 | ||
523 | if (check_mask & CHECK_TAIL) | |
524 | { | |
525 | if (from < to | |
526 | && find_composition (to - 1, -1, &start, &end, &prop, Qnil)) | |
527 | { | |
528 | /* TO should be also at composition boundary. But, | |
529 | insertion or deletion will make two compositions adjacent | |
530 | and indistinguishable when they have same (eq) property. | |
531 | To avoid it, in such a case, we change the property of | |
532 | the former to the copy of it. */ | |
533 | if (to < end) | |
534 | Fput_text_property (make_number (start), make_number (to), | |
535 | Qcomposition, | |
536 | Fcons (XCAR (prop), XCDR (prop)), Qnil); | |
537 | run_composition_function (start, end, prop); | |
538 | } | |
539 | else if (to < ZV | |
540 | && find_composition (to, -1, &start, &end, &prop, Qnil)) | |
541 | run_composition_function (start, end, prop); | |
542 | } | |
543 | } | |
544 | ||
c1361885 KH |
545 | |
546 | /* Modify composition property values in LIST destructively. LIST is | |
547 | a list as returned from text_property_list. Change values to the | |
548 | top-level copies of them so that none of them are `eq'. */ | |
549 | ||
550 | void | |
551 | make_composition_value_copy (list) | |
552 | Lisp_Object list; | |
553 | { | |
554 | Lisp_Object plist, val; | |
555 | ||
556 | for (; CONSP (list); list = XCDR (list)) | |
557 | { | |
558 | plist = XCAR (XCDR (XCDR (XCAR (list)))); | |
559 | while (CONSP (plist) && CONSP (XCDR (plist))) | |
560 | { | |
561 | if (EQ (XCAR (plist), Qcomposition) | |
562 | && (val = XCAR (XCDR (plist)), CONSP (val))) | |
f3fbd155 | 563 | XSETCAR (XCDR (plist), Fcons (XCAR (val), XCDR (val))); |
c1361885 KH |
564 | plist = XCDR (XCDR (plist)); |
565 | } | |
566 | } | |
567 | } | |
568 | ||
569 | ||
ca4c9455 KH |
570 | /* Make text in the region between START and END a composition that |
571 | has COMPONENTS and MODIFICATION-FUNC. | |
572 | ||
573 | If STRING is non-nil, then operate on characters contained between | |
574 | indices START and END in STRING. */ | |
575 | ||
576 | void | |
577 | compose_text (start, end, components, modification_func, string) | |
578 | int start, end; | |
579 | Lisp_Object components, modification_func, string; | |
580 | { | |
581 | Lisp_Object prop; | |
582 | ||
583 | prop = Fcons (Fcons (make_number (end - start), components), | |
584 | modification_func); | |
585 | Fput_text_property (make_number (start), make_number (end), | |
586 | Qcomposition, prop, string); | |
587 | } | |
588 | ||
40add26d KH |
589 | /* Compose sequences of characters in the region between START and END |
590 | by functions registered in Vcomposition_function_table. If STRING | |
591 | is non-nil, operate on characters contained between indices START | |
592 | and END in STRING. */ | |
593 | ||
594 | void | |
595 | compose_chars_in_text (start, end, string) | |
596 | int start, end; | |
597 | Lisp_Object string; | |
598 | { | |
6c1aa7f1 | 599 | int count = 0; |
40add26d KH |
600 | struct gcpro gcpro1; |
601 | Lisp_Object tail, elt, val, to; | |
602 | /* Set to nonzero if we don't have to compose ASCII characters. */ | |
603 | int skip_ascii; | |
604 | int i, len, stop, c; | |
605 | unsigned char *ptr, *pend; | |
606 | ||
607 | if (! CHAR_TABLE_P (Vcomposition_function_table)) | |
608 | return; | |
609 | ||
610 | if (STRINGP (string)) | |
611 | { | |
612 | count = specpdl_ptr - specpdl; | |
613 | GCPRO1 (string); | |
614 | stop = end; | |
615 | ptr = XSTRING (string)->data + string_char_to_byte (string, start); | |
616 | pend = ptr + STRING_BYTES (XSTRING (string)); | |
617 | } | |
618 | else | |
619 | { | |
620 | record_unwind_protect (save_excursion_restore, save_excursion_save ()); | |
621 | TEMP_SET_PT (start); | |
622 | stop = (start < GPT && GPT < end ? GPT : end); | |
623 | ptr = CHAR_POS_ADDR (start); | |
624 | pend = CHAR_POS_ADDR (end); | |
625 | } | |
626 | ||
627 | /* Preserve the match data. */ | |
628 | record_unwind_protect (Fset_match_data, Fmatch_data (Qnil, Qnil)); | |
629 | ||
630 | /* If none of ASCII characters have composition functions, we can | |
631 | skip them quickly. */ | |
632 | for (i = 0; i < 128; i++) | |
633 | if (!NILP (CHAR_TABLE_REF (Vcomposition_function_table, i))) | |
634 | break; | |
635 | skip_ascii = (i == 128); | |
636 | ||
637 | ||
638 | while (1) | |
639 | { | |
640 | if (skip_ascii) | |
641 | while (start < stop && ASCII_BYTE_P (*ptr)) | |
642 | start++, ptr++; | |
643 | ||
644 | if (start >= stop) | |
645 | { | |
646 | if (stop == end || start >= end) | |
647 | break; | |
648 | stop = end; | |
649 | if (STRINGP (string)) | |
650 | ptr = XSTRING (string)->data + string_char_to_byte (string, start); | |
651 | else | |
652 | ptr = CHAR_POS_ADDR (start); | |
653 | } | |
654 | ||
655 | c = STRING_CHAR_AND_LENGTH (ptr, pend - ptr, len); | |
656 | tail = CHAR_TABLE_REF (Vcomposition_function_table, c); | |
657 | while (CONSP (tail)) | |
658 | { | |
659 | elt = XCAR (tail); | |
660 | if (CONSP (elt) | |
661 | && STRINGP (XCAR (elt)) | |
662 | && !NILP (Ffboundp (XCDR (elt)))) | |
663 | { | |
664 | if (STRINGP (string)) | |
665 | val = Fstring_match (XCAR (elt), string, make_number (start)); | |
666 | else | |
667 | { | |
668 | val = Flooking_at (XCAR (elt)); | |
669 | if (!NILP (val)) | |
670 | val = make_number (start); | |
671 | } | |
672 | if (INTEGERP (val) && XFASTINT (val) == start) | |
673 | { | |
674 | to = Fmatch_end (make_number (0)); | |
675 | val = call4 (XCDR (elt), val, to, XCAR (elt), string); | |
676 | if (INTEGERP (val) && XINT (val) > 1) | |
677 | { | |
678 | start += XINT (val); | |
679 | if (STRINGP (string)) | |
680 | ptr = XSTRING (string)->data + string_char_to_byte (string, start); | |
681 | else | |
682 | ptr = CHAR_POS_ADDR (start); | |
683 | } | |
684 | else | |
685 | { | |
686 | start++; | |
687 | ptr += len; | |
688 | } | |
689 | break; | |
690 | } | |
691 | } | |
692 | tail = XCDR (tail); | |
693 | } | |
694 | if (!CONSP (tail)) | |
695 | { | |
696 | /* No composition done. Try the next character. */ | |
697 | start++; | |
698 | ptr += len; | |
699 | } | |
700 | } | |
701 | ||
702 | unbind_to (count, Qnil); | |
703 | if (STRINGP (string)) | |
704 | UNGCPRO; | |
705 | } | |
ca4c9455 KH |
706 | \f |
707 | /* Emacs Lisp APIs. */ | |
708 | ||
709 | DEFUN ("compose-region-internal", Fcompose_region_internal, | |
710 | Scompose_region_internal, 2, 4, 0, | |
335c5470 PJ |
711 | doc: /* Internal use only. |
712 | ||
713 | Compose text in the region between START and END. | |
714 | Optional 3rd and 4th arguments are COMPONENTS and MODIFICATION-FUNC | |
715 | for the composition. See `compose-region' for more detial. */) | |
716 | (start, end, components, mod_func) | |
ca4c9455 KH |
717 | Lisp_Object start, end, components, mod_func; |
718 | { | |
719 | validate_region (&start, &end); | |
720 | if (!NILP (components) | |
721 | && !INTEGERP (components) | |
722 | && !CONSP (components) | |
723 | && !STRINGP (components)) | |
b7826503 | 724 | CHECK_VECTOR (components); |
ca4c9455 KH |
725 | |
726 | compose_text (XINT (start), XINT (end), components, mod_func, Qnil); | |
727 | return Qnil; | |
728 | } | |
729 | ||
730 | DEFUN ("compose-string-internal", Fcompose_string_internal, | |
731 | Scompose_string_internal, 3, 5, 0, | |
335c5470 PJ |
732 | doc: /* Internal use only. |
733 | ||
734 | Compose text between indices START and END of STRING. | |
735 | Optional 4th and 5th arguments are COMPONENTS and MODIFICATION-FUNC | |
736 | for the composition. See `compose-string' for more detial. */) | |
737 | (string, start, end, components, mod_func) | |
ca4c9455 KH |
738 | Lisp_Object string, start, end, components, mod_func; |
739 | { | |
b7826503 PJ |
740 | CHECK_STRING (string); |
741 | CHECK_NUMBER (start); | |
742 | CHECK_NUMBER (end); | |
ca4c9455 KH |
743 | |
744 | if (XINT (start) < 0 || | |
745 | XINT (start) > XINT (end) | |
746 | || XINT (end) > XSTRING (string)->size) | |
747 | args_out_of_range (start, end); | |
748 | ||
749 | compose_text (XINT (start), XINT (end), components, mod_func, string); | |
750 | return string; | |
751 | } | |
752 | ||
753 | DEFUN ("find-composition-internal", Ffind_composition_internal, | |
754 | Sfind_composition_internal, 4, 4, 0, | |
335c5470 PJ |
755 | doc: /* Internal use only. |
756 | ||
757 | Return information about composition at or nearest to position POS. | |
758 | See `find-composition' for more detail. */) | |
759 | (pos, limit, string, detail_p) | |
ca4c9455 KH |
760 | Lisp_Object pos, limit, string, detail_p; |
761 | { | |
762 | Lisp_Object prop, tail; | |
763 | int start, end; | |
764 | int id; | |
765 | ||
b7826503 | 766 | CHECK_NUMBER_COERCE_MARKER (pos); |
ca4c9455 KH |
767 | start = XINT (pos); |
768 | if (!NILP (limit)) | |
769 | { | |
b7826503 | 770 | CHECK_NUMBER_COERCE_MARKER (limit); |
ca4c9455 KH |
771 | end = XINT (limit); |
772 | } | |
773 | else | |
774 | end = -1; | |
e3b3e327 | 775 | |
ca4c9455 | 776 | if (!NILP (string)) |
e3b3e327 | 777 | { |
b7826503 | 778 | CHECK_STRING (string); |
fa9090b8 | 779 | if (XINT (pos) < 0 || XINT (pos) > XSTRING (string)->size) |
e3b3e327 GM |
780 | args_out_of_range (string, pos); |
781 | } | |
782 | else | |
783 | { | |
fa9090b8 | 784 | if (XINT (pos) < BEGV || XINT (pos) > ZV) |
e3b3e327 GM |
785 | args_out_of_range (Fcurrent_buffer (), pos); |
786 | } | |
ca4c9455 KH |
787 | |
788 | if (!find_composition (start, end, &start, &end, &prop, string)) | |
789 | return Qnil; | |
790 | if (!COMPOSITION_VALID_P (start, end, prop)) | |
791 | return Fcons (make_number (start), Fcons (make_number (end), | |
792 | Fcons (Qnil, Qnil))); | |
793 | if (NILP (detail_p)) | |
794 | return Fcons (make_number (start), Fcons (make_number (end), | |
795 | Fcons (Qt, Qnil))); | |
796 | ||
797 | if (COMPOSITION_REGISTERD_P (prop)) | |
798 | id = COMPOSITION_ID (prop); | |
799 | else | |
800 | { | |
801 | int start_byte = (NILP (string) | |
802 | ? CHAR_TO_BYTE (start) | |
803 | : string_char_to_byte (string, start)); | |
804 | id = get_composition_id (start, start_byte, end - start, prop, string); | |
805 | } | |
806 | ||
807 | if (id >= 0) | |
808 | { | |
809 | Lisp_Object components, relative_p, mod_func; | |
810 | enum composition_method method = COMPOSITION_METHOD (prop); | |
811 | int width = composition_table[id]->width; | |
812 | ||
813 | components = Fcopy_sequence (COMPOSITION_COMPONENTS (prop)); | |
814 | relative_p = (method == COMPOSITION_WITH_RULE_ALTCHARS | |
815 | ? Qnil : Qt); | |
816 | mod_func = COMPOSITION_MODIFICATION_FUNC (prop); | |
817 | tail = Fcons (components, | |
818 | Fcons (relative_p, | |
819 | Fcons (mod_func, | |
820 | Fcons (make_number (width), Qnil)))); | |
821 | } | |
822 | else | |
823 | tail = Qnil; | |
824 | ||
825 | return Fcons (make_number (start), Fcons (make_number (end), tail)); | |
826 | } | |
827 | ||
828 | \f | |
829 | void | |
830 | syms_of_composite () | |
831 | { | |
832 | Qcomposition = intern ("composition"); | |
833 | staticpro (&Qcomposition); | |
834 | ||
835 | /* Make a hash table for composition. */ | |
836 | { | |
09654086 | 837 | Lisp_Object args[6]; |
ca4c9455 KH |
838 | extern Lisp_Object QCsize; |
839 | ||
840 | args[0] = QCtest; | |
841 | args[1] = Qequal; | |
842 | args[2] = QCweakness; | |
843 | args[3] = Qnil; | |
844 | args[4] = QCsize; | |
845 | args[5] = make_number (311); | |
09654086 | 846 | composition_hash_table = Fmake_hash_table (6, args); |
ca4c9455 KH |
847 | staticpro (&composition_hash_table); |
848 | } | |
849 | ||
850 | /* Text property `composition' should be nonsticky by default. */ | |
851 | Vtext_property_default_nonsticky | |
852 | = Fcons (Fcons (Qcomposition, Qt), Vtext_property_default_nonsticky); | |
853 | ||
854 | DEFVAR_LISP ("compose-chars-after-function", &Vcompose_chars_after_function, | |
335c5470 PJ |
855 | doc: /* Function to adjust composition of buffer text. |
856 | ||
857 | The function is called with three arguments FROM, TO, and OBJECT. | |
858 | FROM and TO specify the range of text of which composition should be | |
859 | adjusted. OBJECT, if non-nil, is a string that contains the text. | |
860 | ||
861 | This function is called after a text with `composition' property is | |
862 | inserted or deleted to keep `composition' property of buffer text | |
863 | valid. | |
864 | ||
865 | The default value is the function `compose-chars-after'. */); | |
ca4c9455 KH |
866 | Vcompose_chars_after_function = intern ("compose-chars-after"); |
867 | ||
40add26d KH |
868 | Qcomposition_function_table = intern ("composition-function-table"); |
869 | staticpro (&Qcomposition_function_table); | |
870 | ||
871 | /* Intern this now in case it isn't already done. | |
872 | Setting this variable twice is harmless. | |
873 | But don't staticpro it here--that is done in alloc.c. */ | |
874 | Qchar_table_extra_slots = intern ("char-table-extra-slots"); | |
875 | ||
876 | Fput (Qcomposition_function_table, Qchar_table_extra_slots, make_number (0)); | |
877 | ||
878 | DEFVAR_LISP ("composition-function-table", &Vcomposition_function_table, | |
335c5470 PJ |
879 | doc: /* Char table of patterns and functions to make a composition. |
880 | ||
881 | Each element is nil or an alist of PATTERNs vs FUNCs, where PATTERNs | |
882 | are regular expressions and FUNCs are functions. FUNC is responsible | |
883 | for composing text matching the corresponding PATTERN. FUNC is called | |
884 | with three arguments FROM, TO, and PATTERN. See the function | |
885 | `compose-chars-after' for more detail. | |
886 | ||
887 | This table is looked up by the first character of a composition when | |
888 | the composition gets invalid after a change in a buffer. */); | |
40add26d KH |
889 | Vcomposition_function_table |
890 | = Fmake_char_table (Qcomposition_function_table, Qnil); | |
891 | ||
ca4c9455 KH |
892 | defsubr (&Scompose_region_internal); |
893 | defsubr (&Scompose_string_internal); | |
894 | defsubr (&Sfind_composition_internal); | |
895 | } |