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