(mouse-drag-region-1): When remapping mouse-1 to mouse-2, go back to
[bpt/emacs.git] / src / composite.c
1 /* Composite sequence support.
2 Copyright (C) 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
3 Copyright (C) 1999
4 National Institute of Advanced Industrial Science and Technology (AIST)
5 Registration Number H14PRO021
6
7 This file is part of GNU Emacs.
8
9 GNU Emacs is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 2, or (at your option)
12 any later version.
13
14 GNU Emacs is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
18
19 You should have received a copy of the GNU General Public License
20 along with GNU Emacs; see the file COPYING. If not, write to
21 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
22 Boston, MA 02110-1301, USA. */
23
24 #include <config.h>
25 #include "lisp.h"
26 #include "buffer.h"
27 #include "charset.h"
28 #include "intervals.h"
29
30 /* Emacs uses special text property `composition' to support character
31 composition. A sequence of characters that have the same (i.e. eq)
32 `composition' property value is treated as a single composite
33 sequence (we call it just `composition' here after). Characters in
34 a composition are all composed somehow on the screen.
35
36 The property value has this form when the composition is made:
37 ((LENGTH . COMPONENTS) . MODIFICATION-FUNC)
38 then turns to this form:
39 (COMPOSITION-ID . (LENGTH COMPONENTS-VEC . MODIFICATION-FUNC))
40 when the composition is registered in composition_hash_table and
41 composition_table. These rather peculiar structures were designed
42 to make it easy to distinguish them quickly (we can do that by
43 checking only the first element) and to extract LENGTH (from the
44 former form) and COMPOSITION-ID (from the latter form).
45
46 We register a composition when it is displayed, or when the width
47 is required (for instance, to calculate columns).
48
49 LENGTH -- Length of the composition. This information is used to
50 check the validity of the composition.
51
52 COMPONENTS -- Character, string, vector, list, or nil.
53
54 If it is nil, characters in the text are composed relatively
55 according to their metrics in font glyphs.
56
57 If it is a character or a string, the character or characters
58 in the string are composed relatively.
59
60 If it is a vector or list of integers, the element is a
61 character or an encoded composition rule. The characters are
62 composed according to the rules. (2N)th elements are
63 characters to be composed and (2N+1)th elements are
64 composition rules to tell how to compose (2N+2)th element with
65 the previously composed 2N glyphs.
66
67 COMPONENTS-VEC -- Vector of integers. In relative composition, the
68 elements are characters to be composed. In rule-base
69 composition, the elements are characters or encoded
70 composition rules.
71
72 MODIFICATION-FUNC -- If non nil, it is a function to call when the
73 composition gets invalid after a modification in a buffer. If
74 it is nil, a function in `composition-function-table' of the
75 first character in the sequence is called.
76
77 COMPOSITION-ID --Identification number of the composition. It is
78 used as an index to composition_table for the composition.
79
80 When Emacs has to display a composition or has to know its
81 displaying width, the function get_composition_id is called. It
82 returns COMPOSITION-ID so that the caller can access the
83 information about the composition through composition_table. If a
84 COMPOSITION-ID has not yet been assigned to the composition,
85 get_composition_id checks the validity of `composition' property,
86 and, if valid, assigns a new ID, registers the information in
87 composition_hash_table and composition_table, and changes the form
88 of the property value. If the property is invalid, return -1
89 without changing the property value.
90
91 We use two tables to keep information about composition;
92 composition_hash_table and composition_table.
93
94 The former is a hash table in which keys are COMPONENTS-VECs and
95 values are the corresponding COMPOSITION-IDs. This hash table is
96 weak, but as each key (COMPONENTS-VEC) is also kept as a value of the
97 `composition' property, it won't be collected as garbage until all
98 bits of text that have the same COMPONENTS-VEC are deleted.
99
100 The latter is a table of pointers to `struct composition' indexed
101 by COMPOSITION-ID. This structure keeps the other information (see
102 composite.h).
103
104 In general, a text property holds information about individual
105 characters. But, a `composition' property holds information about
106 a sequence of characters (in this sense, it is like the `intangible'
107 property). That means that we should not share the property value
108 in adjacent compositions -- we can't distinguish them if they have the
109 same property. So, after any changes, we call
110 `update_compositions' and change a property of one of adjacent
111 compositions to a copy of it. This function also runs a proper
112 composition modification function to make a composition that gets
113 invalid by the change valid again.
114
115 As the value of the `composition' property holds information about a
116 specific range of text, the value gets invalid if we change the
117 text in the range. We treat the `composition' property as always
118 rear-nonsticky (currently by setting default-text-properties to
119 (rear-nonsticky (composition))) and we never make properties of
120 adjacent compositions identical. Thus, any such changes make the
121 range just shorter. So, we can check the validity of the `composition'
122 property by comparing LENGTH information with the actual length of
123 the composition.
124
125 */
126
127
128 Lisp_Object Qcomposition;
129
130 /* Table of pointers to the structure `composition' indexed by
131 COMPOSITION-ID. This structure is for storing information about
132 each composition except for COMPONENTS-VEC. */
133 struct composition **composition_table;
134
135 /* The current size of `composition_table'. */
136 static int composition_table_size;
137
138 /* Number of compositions currently made. */
139 int n_compositions;
140
141 /* Hash table for compositions. The key is COMPONENTS-VEC of
142 `composition' property. The value is the corresponding
143 COMPOSITION-ID. */
144 Lisp_Object composition_hash_table;
145
146 /* Function to call to adjust composition. */
147 Lisp_Object Vcompose_chars_after_function;
148
149 /* Char-table of patterns and functions to make a composition. */
150 Lisp_Object Vcomposition_function_table;
151 Lisp_Object Qcomposition_function_table;
152
153 /* Temporary variable used in macros COMPOSITION_XXX. */
154 Lisp_Object composition_temp;
155 \f
156 /* Return how many columns C will occupy on the screen. It always
157 returns 1 for control characters and 8-bit characters because those
158 are just ignored in a composition. */
159 #define CHAR_WIDTH(c) \
160 (SINGLE_BYTE_CHAR_P (c) ? 1 : CHARSET_WIDTH (CHAR_CHARSET (c)))
161
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;
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);
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, *start, *end;
410 Lisp_Object *prop, object;
411 {
412 Lisp_Object val;
413
414 if (get_property_and_range (pos, Qcomposition, prop, start, end, object))
415 return 1;
416
417 if (limit < 0 || limit == pos)
418 return 0;
419
420 if (limit > pos) /* search forward */
421 {
422 val = Fnext_single_property_change (make_number (pos), Qcomposition,
423 object, make_number (limit));
424 pos = XINT (val);
425 if (pos == limit)
426 return 0;
427 }
428 else /* search backward */
429 {
430 if (get_property_and_range (pos - 1, Qcomposition, prop, start, end,
431 object))
432 return 1;
433 val = Fprevious_single_property_change (make_number (pos), Qcomposition,
434 object, make_number (limit));
435 pos = XINT (val);
436 if (pos == limit)
437 return 0;
438 pos--;
439 }
440 get_property_and_range (pos, Qcomposition, prop, start, end, object);
441 return 1;
442 }
443
444 /* Run a proper function to adjust the composition sitting between
445 FROM and TO with property PROP. */
446
447 static void
448 run_composition_function (from, to, prop)
449 int from, to;
450 Lisp_Object prop;
451 {
452 Lisp_Object func;
453 int start, end;
454
455 func = COMPOSITION_MODIFICATION_FUNC (prop);
456 /* If an invalid composition precedes or follows, try to make them
457 valid too. */
458 if (from > BEGV
459 && find_composition (from - 1, -1, &start, &end, &prop, Qnil)
460 && !COMPOSITION_VALID_P (start, end, prop))
461 from = start;
462 if (to < ZV
463 && find_composition (to, -1, &start, &end, &prop, Qnil)
464 && !COMPOSITION_VALID_P (start, end, prop))
465 to = end;
466 if (!NILP (Ffboundp (func)))
467 call2 (func, make_number (from), make_number (to));
468 else if (!NILP (Ffboundp (Vcompose_chars_after_function)))
469 call3 (Vcompose_chars_after_function,
470 make_number (from), make_number (to), Qnil);
471 }
472
473 /* Make invalid compositions adjacent to or inside FROM and TO valid.
474 CHECK_MASK is bitwise `or' of mask bits defined by macros
475 CHECK_XXX (see the comment in composite.h).
476
477 This function is called when a buffer text is changed. If the
478 change is deletion, FROM == TO. Otherwise, FROM < TO. */
479
480 void
481 update_compositions (from, to, check_mask)
482 int from, to, check_mask;
483 {
484 Lisp_Object prop;
485 int start, end;
486
487 if (inhibit_modification_hooks)
488 return;
489
490 /* If FROM and TO are not in a valid range, do nothing. */
491 if (! (BEGV <= from && from <= to && to <= ZV))
492 return;
493
494 if (check_mask & CHECK_HEAD)
495 {
496 /* FROM should be at composition boundary. But, insertion or
497 deletion will make two compositions adjacent and
498 indistinguishable when they have same (eq) property. To
499 avoid it, in such a case, we change the property of the
500 latter to the copy of it. */
501 if (from > BEGV
502 && find_composition (from - 1, -1, &start, &end, &prop, Qnil))
503 {
504 if (from < end)
505 Fput_text_property (make_number (from), make_number (end),
506 Qcomposition,
507 Fcons (XCAR (prop), XCDR (prop)), Qnil);
508 run_composition_function (start, end, prop);
509 from = end;
510 }
511 else if (from < ZV
512 && find_composition (from, -1, &start, &from, &prop, Qnil))
513 run_composition_function (start, from, prop);
514 }
515
516 if (check_mask & CHECK_INSIDE)
517 {
518 /* In this case, we are sure that (check & CHECK_TAIL) is also
519 nonzero. Thus, here we should check only compositions before
520 (to - 1). */
521 while (from < to - 1
522 && find_composition (from, to, &start, &from, &prop, Qnil)
523 && from < to - 1)
524 run_composition_function (start, from, prop);
525 }
526
527 if (check_mask & CHECK_TAIL)
528 {
529 if (from < to
530 && find_composition (to - 1, -1, &start, &end, &prop, Qnil))
531 {
532 /* TO should be also at composition boundary. But,
533 insertion or deletion will make two compositions adjacent
534 and indistinguishable when they have same (eq) property.
535 To avoid it, in such a case, we change the property of
536 the former to the copy of it. */
537 if (to < end)
538 Fput_text_property (make_number (start), make_number (to),
539 Qcomposition,
540 Fcons (XCAR (prop), XCDR (prop)), Qnil);
541 run_composition_function (start, end, prop);
542 }
543 else if (to < ZV
544 && find_composition (to, -1, &start, &end, &prop, Qnil))
545 run_composition_function (start, end, prop);
546 }
547 }
548
549
550 /* Modify composition property values in LIST destructively. LIST is
551 a list as returned from text_property_list. Change values to the
552 top-level copies of them so that none of them are `eq'. */
553
554 void
555 make_composition_value_copy (list)
556 Lisp_Object list;
557 {
558 Lisp_Object plist, val;
559
560 for (; CONSP (list); list = XCDR (list))
561 {
562 plist = XCAR (XCDR (XCDR (XCAR (list))));
563 while (CONSP (plist) && CONSP (XCDR (plist)))
564 {
565 if (EQ (XCAR (plist), Qcomposition)
566 && (val = XCAR (XCDR (plist)), CONSP (val)))
567 XSETCAR (XCDR (plist), Fcons (XCAR (val), XCDR (val)));
568 plist = XCDR (XCDR (plist));
569 }
570 }
571 }
572
573
574 /* Make text in the region between START and END a composition that
575 has COMPONENTS and MODIFICATION-FUNC.
576
577 If STRING is non-nil, then operate on characters contained between
578 indices START and END in STRING. */
579
580 void
581 compose_text (start, end, components, modification_func, string)
582 int start, end;
583 Lisp_Object components, modification_func, string;
584 {
585 Lisp_Object prop;
586
587 prop = Fcons (Fcons (make_number (end - start), components),
588 modification_func);
589 Fput_text_property (make_number (start), make_number (end),
590 Qcomposition, prop, string);
591 }
592
593 \f
594 /* Emacs Lisp APIs. */
595
596 DEFUN ("compose-region-internal", Fcompose_region_internal,
597 Scompose_region_internal, 2, 4, 0,
598 doc: /* Internal use only.
599
600 Compose text in the region between START and END.
601 Optional 3rd and 4th arguments are COMPONENTS and MODIFICATION-FUNC
602 for the composition. See `compose-region' for more detail. */)
603 (start, end, components, modification_func)
604 Lisp_Object start, end, components, modification_func;
605 {
606 validate_region (&start, &end);
607 if (!NILP (components)
608 && !INTEGERP (components)
609 && !CONSP (components)
610 && !STRINGP (components))
611 CHECK_VECTOR (components);
612
613 compose_text (XINT (start), XINT (end), components, modification_func, Qnil);
614 return Qnil;
615 }
616
617 DEFUN ("compose-string-internal", Fcompose_string_internal,
618 Scompose_string_internal, 3, 5, 0,
619 doc: /* Internal use only.
620
621 Compose text between indices START and END of STRING.
622 Optional 4th and 5th arguments are COMPONENTS and MODIFICATION-FUNC
623 for the composition. See `compose-string' for more detail. */)
624 (string, start, end, components, modification_func)
625 Lisp_Object string, start, end, components, modification_func;
626 {
627 CHECK_STRING (string);
628 CHECK_NUMBER (start);
629 CHECK_NUMBER (end);
630
631 if (XINT (start) < 0 ||
632 XINT (start) > XINT (end)
633 || XINT (end) > SCHARS (string))
634 args_out_of_range (start, end);
635
636 compose_text (XINT (start), XINT (end), components, modification_func, string);
637 return string;
638 }
639
640 DEFUN ("find-composition-internal", Ffind_composition_internal,
641 Sfind_composition_internal, 4, 4, 0,
642 doc: /* Internal use only.
643
644 Return information about composition at or nearest to position POS.
645 See `find-composition' for more detail. */)
646 (pos, limit, string, detail_p)
647 Lisp_Object pos, limit, string, detail_p;
648 {
649 Lisp_Object prop, tail;
650 int start, end;
651 int id;
652
653 CHECK_NUMBER_COERCE_MARKER (pos);
654 start = XINT (pos);
655 if (!NILP (limit))
656 {
657 CHECK_NUMBER_COERCE_MARKER (limit);
658 end = XINT (limit);
659 }
660 else
661 end = -1;
662
663 if (!NILP (string))
664 {
665 CHECK_STRING (string);
666 if (XINT (pos) < 0 || XINT (pos) > SCHARS (string))
667 args_out_of_range (string, pos);
668 }
669 else
670 {
671 if (XINT (pos) < BEGV || XINT (pos) > ZV)
672 args_out_of_range (Fcurrent_buffer (), pos);
673 }
674
675 if (!find_composition (start, end, &start, &end, &prop, string))
676 return Qnil;
677 if (!COMPOSITION_VALID_P (start, end, prop))
678 return Fcons (make_number (start), Fcons (make_number (end),
679 Fcons (Qnil, Qnil)));
680 if (NILP (detail_p))
681 return Fcons (make_number (start), Fcons (make_number (end),
682 Fcons (Qt, Qnil)));
683
684 if (COMPOSITION_REGISTERD_P (prop))
685 id = COMPOSITION_ID (prop);
686 else
687 {
688 int start_byte = (NILP (string)
689 ? CHAR_TO_BYTE (start)
690 : string_char_to_byte (string, start));
691 id = get_composition_id (start, start_byte, end - start, prop, string);
692 }
693
694 if (id >= 0)
695 {
696 Lisp_Object components, relative_p, mod_func;
697 enum composition_method method = COMPOSITION_METHOD (prop);
698 int width = composition_table[id]->width;
699
700 components = Fcopy_sequence (COMPOSITION_COMPONENTS (prop));
701 relative_p = (method == COMPOSITION_WITH_RULE_ALTCHARS
702 ? Qnil : Qt);
703 mod_func = COMPOSITION_MODIFICATION_FUNC (prop);
704 tail = Fcons (components,
705 Fcons (relative_p,
706 Fcons (mod_func,
707 Fcons (make_number (width), Qnil))));
708 }
709 else
710 tail = Qnil;
711
712 return Fcons (make_number (start), Fcons (make_number (end), tail));
713 }
714
715 \f
716 void
717 syms_of_composite ()
718 {
719 Qcomposition = intern ("composition");
720 staticpro (&Qcomposition);
721
722 /* Make a hash table for composition. */
723 {
724 Lisp_Object args[6];
725 extern Lisp_Object QCsize;
726
727 args[0] = QCtest;
728 args[1] = Qequal;
729 /* We used to make the hash table weak so that unreferenced
730 compostions can be garbage-collected. But, usually once
731 created compositions are repeatedly used in an Emacs session,
732 and thus it's not worth to save memory in such a way. So, we
733 make the table not weak. */
734 args[2] = QCweakness;
735 args[3] = Qnil;
736 args[4] = QCsize;
737 args[5] = make_number (311);
738 composition_hash_table = Fmake_hash_table (6, args);
739 staticpro (&composition_hash_table);
740 }
741
742 /* Text property `composition' should be nonsticky by default. */
743 Vtext_property_default_nonsticky
744 = Fcons (Fcons (Qcomposition, Qt), Vtext_property_default_nonsticky);
745
746 DEFVAR_LISP ("compose-chars-after-function", &Vcompose_chars_after_function,
747 doc: /* Function to adjust composition of buffer text.
748
749 The function is called with three arguments FROM, TO, and OBJECT.
750 FROM and TO specify the range of text of which composition should be
751 adjusted. OBJECT, if non-nil, is a string that contains the text.
752
753 This function is called after a text with `composition' property is
754 inserted or deleted to keep `composition' property of buffer text
755 valid.
756
757 The default value is the function `compose-chars-after'. */);
758 Vcompose_chars_after_function = intern ("compose-chars-after");
759
760 Qcomposition_function_table = intern ("composition-function-table");
761 staticpro (&Qcomposition_function_table);
762
763 /* Intern this now in case it isn't already done.
764 Setting this variable twice is harmless.
765 But don't staticpro it here--that is done in alloc.c. */
766 Qchar_table_extra_slots = intern ("char-table-extra-slots");
767
768 Fput (Qcomposition_function_table, Qchar_table_extra_slots, make_number (0));
769
770 DEFVAR_LISP ("composition-function-table", &Vcomposition_function_table,
771 doc: /* Char table of patterns and functions to make a composition.
772
773 Each element is nil or an alist of PATTERNs vs FUNCs, where PATTERNs
774 are regular expressions and FUNCs are functions. FUNC is responsible
775 for composing text matching the corresponding PATTERN. FUNC is called
776 with three arguments FROM, TO, and PATTERN. See the function
777 `compose-chars-after' for more detail.
778
779 This table is looked up by the first character of a composition when
780 the composition gets invalid after a change in a buffer. */);
781 Vcomposition_function_table
782 = Fmake_char_table (Qcomposition_function_table, Qnil);
783
784 defsubr (&Scompose_region_internal);
785 defsubr (&Scompose_string_internal);
786 defsubr (&Sfind_composition_internal);
787 }
788
789 /* arch-tag: 79cefaf8-ca48-4eed-97e5-d5afb290d272
790 (do not change this comment) */