Revision: emacs@sv.gnu.org/emacs--unicode--0--patch-17
[bpt/emacs.git] / src / composite.c
1 /* Composite sequence support.
2 Copyright (C) 2001, 2002, 2003, 2004, 2005,
3 2006 Free Software Foundation, Inc.
4 Copyright (C) 1999
5 National Institute of Advanced Industrial Science and Technology (AIST)
6 Registration Number H14PRO021
7 Copyright (C) 2003
8 National Institute of Advanced Industrial Science and Technology (AIST)
9 Registration Number H13PRO009
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
15 the Free Software Foundation; either version 2, or (at your option)
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
25 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
26 Boston, MA 02110-1301, USA. */
27
28 #include <config.h>
29 #include "lisp.h"
30 #include "buffer.h"
31 #include "character.h"
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
100 weak, but as each key (COMPONENTS-VEC) is also kept as a value of the
101 `composition' property, it won't be collected as garbage until all
102 bits of text that have the same COMPONENTS-VEC are deleted.
103
104 The latter is a table of pointers to `struct composition' indexed
105 by COMPOSITION-ID. This structure keeps the other information (see
106 composite.h).
107
108 In general, a text property holds information about individual
109 characters. But, a `composition' property holds information about
110 a sequence of characters (in this sense, it is like the `intangible'
111 property). That means that we should not share the property value
112 in adjacent compositions -- we can't distinguish them if they have the
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
119 As the value of the `composition' property holds information about a
120 specific range of text, the value gets invalid if we change the
121 text in the range. We treat the `composition' property as always
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
125 range just shorter. So, we can check the validity of the `composition'
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
153 Lisp_Object Qauto_composed;
154 Lisp_Object Vauto_composition_function;
155 Lisp_Object Qauto_composition_function;
156
157 EXFUN (Fremove_list_of_text_properties, 4);
158
159 /* Temporary variable used in macros COMPOSITION_XXX. */
160 Lisp_Object composition_temp;
161 \f
162 /* Return COMPOSITION-ID of a composition at buffer position
163 CHARPOS/BYTEPOS and length NCHARS. The `composition' property of
164 the sequence is PROP. STRING, if non-nil, is a string that
165 contains the composition instead of the current buffer.
166
167 If the composition is invalid, return -1. */
168
169 int
170 get_composition_id (charpos, bytepos, nchars, prop, string)
171 int charpos, bytepos, nchars;
172 Lisp_Object prop, string;
173 {
174 Lisp_Object id, length, components, key, *key_contents;
175 int glyph_len;
176 struct Lisp_Hash_Table *hash_table = XHASH_TABLE (composition_hash_table);
177 int hash_index;
178 unsigned hash_code;
179 struct composition *cmp;
180 int i, ch;
181
182 /* PROP should be
183 Form-A: ((LENGTH . COMPONENTS) . MODIFICATION-FUNC)
184 or
185 Form-B: (COMPOSITION-ID . (LENGTH COMPONENTS-VEC . MODIFICATION-FUNC))
186 */
187 if (nchars == 0 || !CONSP (prop))
188 goto invalid_composition;
189
190 id = XCAR (prop);
191 if (INTEGERP (id))
192 {
193 /* PROP should be Form-B. */
194 if (XINT (id) < 0 || XINT (id) >= n_compositions)
195 goto invalid_composition;
196 return XINT (id);
197 }
198
199 /* PROP should be Form-A.
200 Thus, ID should be (LENGTH . COMPONENTS). */
201 if (!CONSP (id))
202 goto invalid_composition;
203 length = XCAR (id);
204 if (!INTEGERP (length) || XINT (length) != nchars)
205 goto invalid_composition;
206
207 components = XCDR (id);
208
209 /* Check if the same composition has already been registered or not
210 by consulting composition_hash_table. The key for this table is
211 COMPONENTS (converted to a vector COMPONENTS-VEC) or, if it is
212 nil, vector of characters in the composition range. */
213 if (INTEGERP (components))
214 key = Fmake_vector (make_number (1), components);
215 else if (STRINGP (components) || CONSP (components))
216 key = Fvconcat (1, &components);
217 else if (VECTORP (components))
218 key = components;
219 else if (NILP (components))
220 {
221 key = Fmake_vector (make_number (nchars), Qnil);
222 if (STRINGP (string))
223 for (i = 0; i < nchars; i++)
224 {
225 FETCH_STRING_CHAR_ADVANCE (ch, string, charpos, bytepos);
226 XVECTOR (key)->contents[i] = make_number (ch);
227 }
228 else
229 for (i = 0; i < nchars; i++)
230 {
231 FETCH_CHAR_ADVANCE (ch, charpos, bytepos);
232 XVECTOR (key)->contents[i] = make_number (ch);
233 }
234 }
235 else
236 goto invalid_composition;
237
238 hash_index = hash_lookup (hash_table, key, &hash_code);
239 if (hash_index >= 0)
240 {
241 /* We have already registered the same composition. Change PROP
242 from Form-A above to Form-B while replacing COMPONENTS with
243 COMPONENTS-VEC stored in the hash table. We can directly
244 modify the cons cell of PROP because it is not shared. */
245 key = HASH_KEY (hash_table, hash_index);
246 id = HASH_VALUE (hash_table, hash_index);
247 XSETCAR (prop, id);
248 XSETCDR (prop, Fcons (make_number (nchars), Fcons (key, XCDR (prop))));
249 return XINT (id);
250 }
251
252 /* This composition is a new one. We must register it. */
253
254 /* Check if we have sufficient memory to store this information. */
255 if (composition_table_size == 0)
256 {
257 composition_table_size = 256;
258 composition_table
259 = (struct composition **) xmalloc (sizeof (composition_table[0])
260 * composition_table_size);
261 }
262 else if (composition_table_size <= n_compositions)
263 {
264 composition_table_size += 256;
265 composition_table
266 = (struct composition **) xrealloc (composition_table,
267 sizeof (composition_table[0])
268 * composition_table_size);
269 }
270
271 key_contents = XVECTOR (key)->contents;
272
273 /* Check if the contents of COMPONENTS are valid if COMPONENTS is a
274 vector or a list. It should be a sequence of:
275 char1 rule1 char2 rule2 char3 ... ruleN charN+1 */
276 if (VECTORP (components) || CONSP (components))
277 {
278 int len = XVECTOR (key)->size;
279
280 /* The number of elements should be odd. */
281 if ((len % 2) == 0)
282 goto invalid_composition;
283 /* All elements should be integers (character or encoded
284 composition rule). */
285 for (i = 0; i < len; i++)
286 {
287 if (!INTEGERP (key_contents[i]))
288 goto invalid_composition;
289 }
290 }
291
292 /* Change PROP from Form-A above to Form-B. We can directly modify
293 the cons cell of PROP because it is not shared. */
294 XSETFASTINT (id, n_compositions);
295 XSETCAR (prop, id);
296 XSETCDR (prop, Fcons (make_number (nchars), Fcons (key, XCDR (prop))));
297
298 /* Register the composition in composition_hash_table. */
299 hash_index = hash_put (hash_table, key, id, hash_code);
300
301 /* Register the composition in composition_table. */
302 cmp = (struct composition *) xmalloc (sizeof (struct composition));
303
304 cmp->method = (NILP (components)
305 ? COMPOSITION_RELATIVE
306 : ((INTEGERP (components) || STRINGP (components))
307 ? COMPOSITION_WITH_ALTCHARS
308 : COMPOSITION_WITH_RULE_ALTCHARS));
309 cmp->hash_index = hash_index;
310 glyph_len = (cmp->method == COMPOSITION_WITH_RULE_ALTCHARS
311 ? (XVECTOR (key)->size + 1) / 2
312 : XVECTOR (key)->size);
313 cmp->glyph_len = glyph_len;
314 cmp->offsets = (short *) xmalloc (sizeof (short) * glyph_len * 2);
315 cmp->font = NULL;
316
317 /* Calculate the width of overall glyphs of the composition. */
318 if (cmp->method != COMPOSITION_WITH_RULE_ALTCHARS)
319 {
320 /* Relative composition. */
321 cmp->width = 0;
322 for (i = 0; i < glyph_len; i++)
323 {
324 int this_width;
325 ch = XINT (key_contents[i]);
326 this_width = CHAR_WIDTH (ch);
327 if (cmp->width < this_width)
328 cmp->width = this_width;
329 }
330 }
331 else
332 {
333 /* Rule-base composition. */
334 float leftmost = 0.0, rightmost;
335
336 ch = XINT (key_contents[0]);
337 rightmost = CHAR_WIDTH (ch);
338
339 for (i = 1; i < glyph_len; i += 2)
340 {
341 int rule, gref, nref, xoff, yoff;
342 int this_width;
343 float this_left;
344
345 rule = XINT (key_contents[i]);
346 ch = XINT (key_contents[i + 1]);
347 this_width = CHAR_WIDTH (ch);
348
349 /* A composition rule is specified by an integer value
350 that encodes global and new reference points (GREF and
351 NREF). GREF and NREF are specified by numbers as
352 below:
353 0---1---2 -- ascent
354 | |
355 | |
356 | |
357 9--10--11 -- center
358 | |
359 ---3---4---5--- baseline
360 | |
361 6---7---8 -- descent
362 */
363 COMPOSITION_DECODE_RULE (rule, gref, nref, xoff, yoff);
364 this_left = (leftmost
365 + (gref % 3) * (rightmost - leftmost) / 2.0
366 - (nref % 3) * this_width / 2.0);
367
368 if (this_left < leftmost)
369 leftmost = this_left;
370 if (this_left + this_width > rightmost)
371 rightmost = this_left + this_width;
372 }
373
374 cmp->width = rightmost - leftmost;
375 if (cmp->width < (rightmost - leftmost))
376 /* To get a ceiling integer value. */
377 cmp->width++;
378 }
379
380 composition_table[n_compositions] = cmp;
381
382 return n_compositions++;
383
384 invalid_composition:
385 /* Would it be better to remove this `composition' property? */
386 return -1;
387 }
388
389 \f
390 /* Find a composition at or nearest to position POS of OBJECT (buffer
391 or string).
392
393 OBJECT defaults to the current buffer. If there's a composition at
394 POS, set *START and *END to the start and end of the sequence,
395 *PROP to the `composition' property, and return 1.
396
397 If there's no composition at POS and LIMIT is negative, return 0.
398
399 Otherwise, search for a composition forward (LIMIT > POS) or
400 backward (LIMIT < POS). In this case, LIMIT bounds the search.
401
402 If a composition is found, set *START, *END, and *PROP as above,
403 and return 1, else return 0.
404
405 This doesn't check the validity of composition. */
406
407 int
408 find_composition (pos, limit, start, end, prop, object)
409 int pos, limit;
410 EMACS_INT *start, *end;
411 Lisp_Object *prop, object;
412 {
413 Lisp_Object val;
414
415 if (get_property_and_range (pos, Qcomposition, prop, start, end, object))
416 return 1;
417
418 if (limit < 0 || limit == pos)
419 return 0;
420
421 if (limit > pos) /* search forward */
422 {
423 val = Fnext_single_property_change (make_number (pos), Qcomposition,
424 object, make_number (limit));
425 pos = XINT (val);
426 if (pos == limit)
427 return 0;
428 }
429 else /* search backward */
430 {
431 if (get_property_and_range (pos - 1, Qcomposition, prop, start, end,
432 object))
433 return 1;
434 val = Fprevious_single_property_change (make_number (pos), Qcomposition,
435 object, make_number (limit));
436 pos = XINT (val);
437 if (pos == limit)
438 return 0;
439 pos--;
440 }
441 get_property_and_range (pos, Qcomposition, prop, start, end, object);
442 return 1;
443 }
444
445 /* Run a proper function to adjust the composition sitting between
446 FROM and TO with property PROP. */
447
448 static void
449 run_composition_function (from, to, prop)
450 int from, to;
451 Lisp_Object prop;
452 {
453 Lisp_Object func;
454 EMACS_INT start, end;
455
456 func = COMPOSITION_MODIFICATION_FUNC (prop);
457 /* If an invalid composition precedes or follows, try to make them
458 valid too. */
459 if (from > BEGV
460 && find_composition (from - 1, -1, &start, &end, &prop, Qnil)
461 && !COMPOSITION_VALID_P (start, end, prop))
462 from = start;
463 if (to < ZV
464 && find_composition (to, -1, &start, &end, &prop, Qnil)
465 && !COMPOSITION_VALID_P (start, end, prop))
466 to = end;
467 if (!NILP (Ffboundp (func)))
468 call2 (func, make_number (from), make_number (to));
469 }
470
471 /* Make invalid compositions adjacent to or inside FROM and TO valid.
472 CHECK_MASK is bitwise `or' of mask bits defined by macros
473 CHECK_XXX (see the comment in composite.h).
474
475 It also resets the text-property `auto-composed' to a proper region
476 so that automatic character composition works correctly later while
477 displaying the region.
478
479 This function is called when a buffer text is changed. If the
480 change is deletion, FROM == TO. Otherwise, FROM < TO. */
481
482 void
483 update_compositions (from, to, check_mask)
484 EMACS_INT from, to;
485 int check_mask;
486 {
487 Lisp_Object prop;
488 EMACS_INT start, end;
489 /* The beginning and end of the region to set the property
490 `auto-composed' to nil. */
491 EMACS_INT min_pos = from, max_pos = to;
492
493 if (inhibit_modification_hooks)
494 return;
495
496 /* If FROM and TO are not in a valid range, do nothing. */
497 if (! (BEGV <= from && from <= to && to <= ZV))
498 return;
499
500 if (check_mask & CHECK_HEAD)
501 {
502 /* FROM should be at composition boundary. But, insertion or
503 deletion will make two compositions adjacent and
504 indistinguishable when they have same (eq) property. To
505 avoid it, in such a case, we change the property of the
506 latter to the copy of it. */
507 if (from > BEGV
508 && find_composition (from - 1, -1, &start, &end, &prop, Qnil))
509 {
510 min_pos = start;
511 if (end > to)
512 max_pos = end;
513 if (from < end)
514 Fput_text_property (make_number (from), make_number (end),
515 Qcomposition,
516 Fcons (XCAR (prop), XCDR (prop)), Qnil);
517 run_composition_function (start, end, prop);
518 from = end;
519 }
520 else if (from < ZV
521 && find_composition (from, -1, &start, &from, &prop, Qnil))
522 {
523 if (from > to)
524 max_pos = from;
525 run_composition_function (start, from, prop);
526 }
527 }
528
529 if (check_mask & CHECK_INSIDE)
530 {
531 /* In this case, we are sure that (check & CHECK_TAIL) is also
532 nonzero. Thus, here we should check only compositions before
533 (to - 1). */
534 while (from < to - 1
535 && find_composition (from, to, &start, &from, &prop, Qnil)
536 && from < to - 1)
537 run_composition_function (start, from, prop);
538 }
539
540 if (check_mask & CHECK_TAIL)
541 {
542 if (from < to
543 && find_composition (to - 1, -1, &start, &end, &prop, Qnil))
544 {
545 /* TO should be also at composition boundary. But,
546 insertion or deletion will make two compositions adjacent
547 and indistinguishable when they have same (eq) property.
548 To avoid it, in such a case, we change the property of
549 the former to the copy of it. */
550 if (to < end)
551 {
552 Fput_text_property (make_number (start), make_number (to),
553 Qcomposition,
554 Fcons (XCAR (prop), XCDR (prop)), Qnil);
555 max_pos = end;
556 }
557 run_composition_function (start, end, prop);
558 }
559 else if (to < ZV
560 && find_composition (to, -1, &start, &end, &prop, Qnil))
561 {
562 run_composition_function (start, end, prop);
563 max_pos = end;
564 }
565 }
566 if (min_pos < max_pos)
567 {
568 int count = SPECPDL_INDEX ();
569
570 specbind (Qinhibit_read_only, Qt);
571 specbind (Qinhibit_modification_hooks, Qt);
572 specbind (Qinhibit_point_motion_hooks, Qt);
573 Fremove_list_of_text_properties (make_number (min_pos),
574 make_number (max_pos),
575 Fcons (Qauto_composed, Qnil), Qnil);
576 unbind_to (count, Qnil);
577 }
578 }
579
580
581 /* Modify composition property values in LIST destructively. LIST is
582 a list as returned from text_property_list. Change values to the
583 top-level copies of them so that none of them are `eq'. */
584
585 void
586 make_composition_value_copy (list)
587 Lisp_Object list;
588 {
589 Lisp_Object plist, val;
590
591 for (; CONSP (list); list = XCDR (list))
592 {
593 plist = XCAR (XCDR (XCDR (XCAR (list))));
594 while (CONSP (plist) && CONSP (XCDR (plist)))
595 {
596 if (EQ (XCAR (plist), Qcomposition)
597 && (val = XCAR (XCDR (plist)), CONSP (val)))
598 XSETCAR (XCDR (plist), Fcons (XCAR (val), XCDR (val)));
599 plist = XCDR (XCDR (plist));
600 }
601 }
602 }
603
604
605 /* Make text in the region between START and END a composition that
606 has COMPONENTS and MODIFICATION-FUNC.
607
608 If STRING is non-nil, then operate on characters contained between
609 indices START and END in STRING. */
610
611 void
612 compose_text (start, end, components, modification_func, string)
613 int start, end;
614 Lisp_Object components, modification_func, string;
615 {
616 Lisp_Object prop;
617
618 prop = Fcons (Fcons (make_number (end - start), components),
619 modification_func);
620 Fput_text_property (make_number (start), make_number (end),
621 Qcomposition, prop, string);
622 }
623 \f
624 /* Emacs Lisp APIs. */
625
626 DEFUN ("compose-region-internal", Fcompose_region_internal,
627 Scompose_region_internal, 2, 4, 0,
628 doc: /* Internal use only.
629
630 Compose text in the region between START and END.
631 Optional 3rd and 4th arguments are COMPONENTS and MODIFICATION-FUNC
632 for the composition. See `compose-region' for more detail. */)
633 (start, end, components, modification_func)
634 Lisp_Object start, end, components, modification_func;
635 {
636 validate_region (&start, &end);
637 if (!NILP (components)
638 && !INTEGERP (components)
639 && !CONSP (components)
640 && !STRINGP (components))
641 CHECK_VECTOR (components);
642
643 compose_text (XINT (start), XINT (end), components, modification_func, Qnil);
644 return Qnil;
645 }
646
647 DEFUN ("compose-string-internal", Fcompose_string_internal,
648 Scompose_string_internal, 3, 5, 0,
649 doc: /* Internal use only.
650
651 Compose text between indices START and END of STRING.
652 Optional 4th and 5th arguments are COMPONENTS and MODIFICATION-FUNC
653 for the composition. See `compose-string' for more detail. */)
654 (string, start, end, components, modification_func)
655 Lisp_Object string, start, end, components, modification_func;
656 {
657 CHECK_STRING (string);
658 CHECK_NUMBER (start);
659 CHECK_NUMBER (end);
660
661 if (XINT (start) < 0 ||
662 XINT (start) > XINT (end)
663 || XINT (end) > SCHARS (string))
664 args_out_of_range (start, end);
665
666 compose_text (XINT (start), XINT (end), components, modification_func, string);
667 return string;
668 }
669
670 DEFUN ("find-composition-internal", Ffind_composition_internal,
671 Sfind_composition_internal, 4, 4, 0,
672 doc: /* Internal use only.
673
674 Return information about composition at or nearest to position POS.
675 See `find-composition' for more detail. */)
676 (pos, limit, string, detail_p)
677 Lisp_Object pos, limit, string, detail_p;
678 {
679 Lisp_Object prop, tail;
680 EMACS_INT start, end;
681 int id;
682
683 CHECK_NUMBER_COERCE_MARKER (pos);
684 start = XINT (pos);
685 if (!NILP (limit))
686 {
687 CHECK_NUMBER_COERCE_MARKER (limit);
688 end = XINT (limit);
689 }
690 else
691 end = -1;
692
693 if (!NILP (string))
694 {
695 CHECK_STRING (string);
696 if (XINT (pos) < 0 || XINT (pos) > SCHARS (string))
697 args_out_of_range (string, pos);
698 }
699 else
700 {
701 if (XINT (pos) < BEGV || XINT (pos) > ZV)
702 args_out_of_range (Fcurrent_buffer (), pos);
703 }
704
705 if (!find_composition (start, end, &start, &end, &prop, string))
706 return Qnil;
707 if (!COMPOSITION_VALID_P (start, end, prop))
708 return Fcons (make_number (start), Fcons (make_number (end),
709 Fcons (Qnil, Qnil)));
710 if (NILP (detail_p))
711 return Fcons (make_number (start), Fcons (make_number (end),
712 Fcons (Qt, Qnil)));
713
714 if (COMPOSITION_REGISTERD_P (prop))
715 id = COMPOSITION_ID (prop);
716 else
717 {
718 int start_byte = (NILP (string)
719 ? CHAR_TO_BYTE (start)
720 : string_char_to_byte (string, start));
721 id = get_composition_id (start, start_byte, end - start, prop, string);
722 }
723
724 if (id >= 0)
725 {
726 Lisp_Object components, relative_p, mod_func;
727 enum composition_method method = COMPOSITION_METHOD (prop);
728 int width = composition_table[id]->width;
729
730 components = Fcopy_sequence (COMPOSITION_COMPONENTS (prop));
731 relative_p = (method == COMPOSITION_WITH_RULE_ALTCHARS
732 ? Qnil : Qt);
733 mod_func = COMPOSITION_MODIFICATION_FUNC (prop);
734 tail = Fcons (components,
735 Fcons (relative_p,
736 Fcons (mod_func,
737 Fcons (make_number (width), Qnil))));
738 }
739 else
740 tail = Qnil;
741
742 return Fcons (make_number (start), Fcons (make_number (end), tail));
743 }
744
745 \f
746 void
747 syms_of_composite ()
748 {
749 Qcomposition = intern ("composition");
750 staticpro (&Qcomposition);
751
752 /* Make a hash table for composition. */
753 {
754 Lisp_Object args[6];
755 extern Lisp_Object QCsize;
756
757 args[0] = QCtest;
758 args[1] = Qequal;
759 args[2] = QCweakness;
760 /* We used to make the hash table weak so that unreferenced
761 compostions can be garbage-collected. But, usually once
762 created compositions are repeatedly used in an Emacs session,
763 and thus it's not worth to save memory in such a way. So, we
764 make the table not weak. */
765 args[3] = Qnil;
766 args[4] = QCsize;
767 args[5] = make_number (311);
768 composition_hash_table = Fmake_hash_table (6, args);
769 staticpro (&composition_hash_table);
770 }
771
772 /* Text property `composition' should be nonsticky by default. */
773 Vtext_property_default_nonsticky
774 = Fcons (Fcons (Qcomposition, Qt), Vtext_property_default_nonsticky);
775
776 DEFVAR_LISP ("compose-chars-after-function", &Vcompose_chars_after_function,
777 doc: /* Function to adjust composition of buffer text.
778
779 The function is called with three arguments FROM, TO, and OBJECT.
780 FROM and TO specify the range of text of which composition should be
781 adjusted. OBJECT, if non-nil, is a string that contains the text.
782
783 This function is called after a text with `composition' property is
784 inserted or deleted to keep `composition' property of buffer text
785 valid.
786
787 The default value is the function `compose-chars-after'. */);
788 Vcompose_chars_after_function = intern ("compose-chars-after");
789
790 Qauto_composed = intern ("auto-composed");
791 staticpro (&Qauto_composed);
792
793 Qauto_composition_function = intern ("auto-composition-function");
794 staticpro (&Qauto_composition_function);
795
796 DEFVAR_LISP ("auto-composition-function", &Vauto_composition_function,
797 doc: /* Function to call to compose characters automatically.
798 The function is called from the display routine with two arguments,
799 POS and STRING.
800
801 If STRING is nil, the function must compose characters following POS
802 in the current buffer.
803
804 Otherwise, STRING is a string, and POS is an index to the string. In
805 this case, the function must compose characters following POS in
806 the string. */);
807 Vauto_composition_function = Qnil;
808
809 defsubr (&Scompose_region_internal);
810 defsubr (&Scompose_string_internal);
811 defsubr (&Sfind_composition_internal);
812 }
813
814 /* arch-tag: 79cefaf8-ca48-4eed-97e5-d5afb290d272
815 (do not change this comment) */