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