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