1 /* Copyright (c) 1994, 1995 Free Software Foundation, Inc.
2 Copyright (c) 1995 Sun Microsystems, Inc.
3 Copyright (c) 1995, 1996 Ben Wing.
5 This file is part of XEmacs.
7 XEmacs is free software; you can redistribute it and/or modify it
8 under the terms of the GNU General Public License as published by the
9 Free Software Foundation; either version 2, or (at your option) any
12 XEmacs is distributed in the hope that it will be useful, but WITHOUT
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
17 You should have received a copy of the GNU General Public License
18 along with XEmacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 /* Synched up with: Not in FSF. */
24 /* This file has been Mule-ized. */
26 /* Written by Ben Wing <ben@xemacs.org>.
28 [Originally written by some people at Lucid.
30 Start/end-open stuff added by John Rose (john.rose@eng.sun.com).
31 Rewritten from scratch by Ben Wing, December 1994.] */
35 Extents are regions over a buffer, with a start and an end position
36 denoting the region of the buffer included in the extent. In
37 addition, either end can be closed or open, meaning that the endpoint
38 is or is not logically included in the extent. Insertion of a character
39 at a closed endpoint causes the character to go inside the extent;
40 insertion at an open endpoint causes the character to go outside.
42 Extent endpoints are stored using memory indices (see insdel.c),
43 to minimize the amount of adjusting that needs to be done when
44 characters are inserted or deleted.
46 (Formerly, extent endpoints at the gap could be either before or
47 after the gap, depending on the open/closedness of the endpoint.
48 The intent of this was to make it so that insertions would
49 automatically go inside or out of extents as necessary with no
50 further work needing to be done. It didn't work out that way,
51 however, and just ended up complexifying and buggifying all the
54 Extents are compared using memory indices. There are two orderings
55 for extents and both orders are kept current at all times. The normal
56 or "display" order is as follows:
58 Extent A is "less than" extent B, that is, earlier in the display order,
59 if: A-start < B-start,
60 or if: A-start = B-start, and A-end > B-end
62 So if two extents begin at the same position, the larger of them is the
63 earlier one in the display order (EXTENT_LESS is true).
65 For the e-order, the same thing holds: Extent A is "less than" extent B
66 in e-order, that is, later in the buffer,
68 or if: A-end = B-end, and A-start > B-start
70 So if two extents end at the same position, the smaller of them is the
71 earlier one in the e-order (EXTENT_E_LESS is true).
73 The display order and the e-order are complementary orders: any
74 theorem about the display order also applies to the e-order if you
75 swap all occurrences of "display order" and "e-order", "less than"
76 and "greater than", and "extent start" and "extent end".
78 Extents can be zero-length, and will end up that way if their endpoints
79 are explicitly set that way or if their detachable property is nil
80 and all the text in the extent is deleted. (The exception is open-open
81 zero-length extents, which are barred from existing because there is
82 no sensible way to define their properties. Deletion of the text in
83 an open-open extent causes it to be converted into a closed-open
84 extent.) Zero-length extents are primarily used to represent
85 annotations, and behave as follows:
87 1) Insertion at the position of a zero-length extent expands the extent
88 if both endpoints are closed; goes after the extent if it is closed-open;
89 and goes before the extent if it is open-closed.
91 2) Deletion of a character on a side of a zero-length extent whose
92 corresponding endpoint is closed causes the extent to be detached if
93 it is detachable; if the extent is not detachable or the corresponding
94 endpoint is open, the extent remains in the buffer, moving as necessary.
96 Note that closed-open, non-detachable zero-length extents behave exactly
97 like markers and that open-closed, non-detachable zero-length extents
98 behave like the "point-type" marker in Mule.
101 #### The following information is wrong in places.
103 More about the different orders:
104 --------------------------------
106 The extents in a buffer are ordered by "display order" because that
107 is that order that the redisplay mechanism needs to process them in.
108 The e-order is an auxiliary ordering used to facilitate operations
109 over extents. The operations that can be performed on the ordered
110 list of extents in a buffer are
112 1) Locate where an extent would go if inserted into the list.
113 2) Insert an extent into the list.
114 3) Remove an extent from the list.
115 4) Map over all the extents that overlap a range.
117 (4) requires being able to determine the first and last extents
118 that overlap a range.
120 NOTE: "overlap" is used as follows:
122 -- two ranges overlap if they have at least one point in common.
123 Whether the endpoints are open or closed makes a difference here.
124 -- a point overlaps a range if the point is contained within the
125 range; this is equivalent to treating a point P as the range
127 -- In the case of an *extent* overlapping a point or range, the
128 extent is normally treated as having closed endpoints. This
129 applies consistently in the discussion of stacks of extents
130 and such below. Note that this definition of overlap is not
131 necessarily consistent with the extents that `map-extents'
132 maps over, since `map-extents' sometimes pays attention to
133 whether the endpoints of an extents are open or closed.
134 But for our purposes, it greatly simplifies things to treat
135 all extents as having closed endpoints.
137 First, define >, <, <=, etc. as applied to extents to mean
138 comparison according to the display order. Comparison between an
139 extent E and an index I means comparison between E and the range
141 Also define e>, e<, e<=, etc. to mean comparison according to the
143 For any range R, define R(0) to be the starting index of the range
144 and R(1) to be the ending index of the range.
145 For any extent E, define E(next) to be the extent directly following
146 E, and E(prev) to be the extent directly preceding E. Assume
147 E(next) and E(prev) can be determined from E in constant time.
148 (This is because we store the extent list as a doubly linked
150 Similarly, define E(e-next) and E(e-prev) to be the extents
151 directly following and preceding E in the e-order.
156 Let F be the first extent overlapping R.
157 Let L be the last extent overlapping R.
159 Theorem 1: R(1) lies between L and L(next), i.e. L <= R(1) < L(next).
161 This follows easily from the definition of display order. The
162 basic reason that this theorem applies is that the display order
163 sorts by increasing starting index.
165 Therefore, we can determine L just by looking at where we would
166 insert R(1) into the list, and if we know F and are moving forward
167 over extents, we can easily determine when we've hit L by comparing
168 the extent we're at to R(1).
170 Theorem 2: F(e-prev) e< [1, R(0)] e<= F.
172 This is the analog of Theorem 1, and applies because the e-order
173 sorts by increasing ending index.
175 Therefore, F can be found in the same amount of time as operation (1),
176 i.e. the time that it takes to locate where an extent would go if
177 inserted into the e-order list.
179 If the lists were stored as balanced binary trees, then operation (1)
180 would take logarithmic time, which is usually quite fast. However,
181 currently they're stored as simple doubly-linked lists, and instead
182 we do some caching to try to speed things up.
184 Define a "stack of extents" (or "SOE") as the set of extents
185 (ordered in the display order) that overlap an index I, together with
186 the SOE's "previous" extent, which is an extent that precedes I in
187 the e-order. (Hopefully there will not be very many extents between
188 I and the previous extent.)
192 Let I be an index, let S be the stack of extents on I, let F be
193 the first extent in S, and let P be S's previous extent.
195 Theorem 3: The first extent in S is the first extent that overlaps
198 Proof: Any extent that overlaps [I, J] but does not include I must
199 have a start index > I, and thus be greater than any extent in S.
201 Therefore, finding the first extent that overlaps a range R is the
202 same as finding the first extent that overlaps R(0).
204 Theorem 4: Let I2 be an index such that I2 > I, and let F2 be the
205 first extent that overlaps I2. Then, either F2 is in S or F2 is
206 greater than any extent in S.
208 Proof: If F2 does not include I then its start index is greater
209 than I and thus it is greater than any extent in S, including F.
210 Otherwise, F2 includes I and thus is in S, and thus F2 >= F.
229 #include "redisplay.h"
231 /* ------------------------------- */
233 /* ------------------------------- */
235 /* Note that this object is not extent-specific and should perhaps be
236 moved into another file. */
238 /* Holds a marker that moves as elements in the array are inserted and
239 deleted, similar to standard markers. */
241 typedef struct gap_array_marker
244 struct gap_array_marker *next;
247 /* Holds a "gap array", which is an array of elements with a gap located
248 in it. Insertions and deletions with a high degree of locality
249 are very fast, essentially in constant time. Array positions as
250 used and returned in the gap array functions are independent of
253 typedef struct gap_array
260 Gap_Array_Marker *markers;
263 static Gap_Array_Marker *gap_array_marker_freelist;
265 /* Convert a "memory position" (i.e. taking the gap into account) into
266 the address of the element at (i.e. after) that position. "Memory
267 positions" are only used internally and are of type Memind.
268 "Array positions" are used externally and are of type int. */
269 #define GAP_ARRAY_MEMEL_ADDR(ga, memel) ((ga)->array + (ga)->elsize*(memel))
271 /* Number of elements currently in a gap array */
272 #define GAP_ARRAY_NUM_ELS(ga) ((ga)->numels)
274 #define GAP_ARRAY_ARRAY_TO_MEMORY_POS(ga, pos) \
275 ((pos) <= (ga)->gap ? (pos) : (pos) + (ga)->gapsize)
277 #define GAP_ARRAY_MEMORY_TO_ARRAY_POS(ga, pos) \
278 ((pos) <= (ga)->gap ? (pos) : (pos) - (ga)->gapsize)
280 /* Convert an array position into the address of the element at
281 (i.e. after) that position. */
282 #define GAP_ARRAY_EL_ADDR(ga, pos) ((pos) < (ga)->gap ? \
283 GAP_ARRAY_MEMEL_ADDR(ga, pos) : \
284 GAP_ARRAY_MEMEL_ADDR(ga, (pos) + (ga)->gapsize))
286 /* ------------------------------- */
288 /* ------------------------------- */
290 typedef struct extent_list_marker
294 struct extent_list_marker *next;
295 } Extent_List_Marker;
297 typedef struct extent_list
301 Extent_List_Marker *markers;
304 static Extent_List_Marker *extent_list_marker_freelist;
306 #define EXTENT_LESS_VALS(e,st,nd) ((extent_start (e) < (st)) || \
307 ((extent_start (e) == (st)) && \
308 (extent_end (e) > (nd))))
310 #define EXTENT_EQUAL_VALS(e,st,nd) ((extent_start (e) == (st)) && \
311 (extent_end (e) == (nd)))
313 #define EXTENT_LESS_EQUAL_VALS(e,st,nd) ((extent_start (e) < (st)) || \
314 ((extent_start (e) == (st)) && \
315 (extent_end (e) >= (nd))))
317 /* Is extent E1 less than extent E2 in the display order? */
318 #define EXTENT_LESS(e1,e2) \
319 EXTENT_LESS_VALS (e1, extent_start (e2), extent_end (e2))
321 /* Is extent E1 equal to extent E2? */
322 #define EXTENT_EQUAL(e1,e2) \
323 EXTENT_EQUAL_VALS (e1, extent_start (e2), extent_end (e2))
325 /* Is extent E1 less than or equal to extent E2 in the display order? */
326 #define EXTENT_LESS_EQUAL(e1,e2) \
327 EXTENT_LESS_EQUAL_VALS (e1, extent_start (e2), extent_end (e2))
329 #define EXTENT_E_LESS_VALS(e,st,nd) ((extent_end (e) < (nd)) || \
330 ((extent_end (e) == (nd)) && \
331 (extent_start (e) > (st))))
333 #define EXTENT_E_LESS_EQUAL_VALS(e,st,nd) ((extent_end (e) < (nd)) || \
334 ((extent_end (e) == (nd)) && \
335 (extent_start (e) >= (st))))
337 /* Is extent E1 less than extent E2 in the e-order? */
338 #define EXTENT_E_LESS(e1,e2) \
339 EXTENT_E_LESS_VALS(e1, extent_start (e2), extent_end (e2))
341 /* Is extent E1 less than or equal to extent E2 in the e-order? */
342 #define EXTENT_E_LESS_EQUAL(e1,e2) \
343 EXTENT_E_LESS_EQUAL_VALS (e1, extent_start (e2), extent_end (e2))
345 #define EXTENT_GAP_ARRAY_AT(ga, pos) (* (EXTENT *) GAP_ARRAY_EL_ADDR(ga, pos))
347 /* ------------------------------- */
348 /* auxiliary extent structure */
349 /* ------------------------------- */
351 struct extent_auxiliary extent_auxiliary_defaults;
353 /* ------------------------------- */
354 /* buffer-extent primitives */
355 /* ------------------------------- */
357 typedef struct stack_of_extents
359 Extent_List *extents;
360 Memind pos; /* Position of stack of extents. EXTENTS is the list of
361 all extents that overlap this position. This position
362 can be -1 if the stack of extents is invalid (this
363 happens when a buffer is first created or a string's
364 stack of extents is created [a string's stack of extents
365 is nuked when a GC occurs, to conserve memory]). */
368 /* ------------------------------- */
370 /* ------------------------------- */
372 typedef int Endpoint_Index;
374 #define memind_to_startind(x, start_open) \
375 ((Endpoint_Index) (((x) << 1) + !!(start_open)))
376 #define memind_to_endind(x, end_open) \
377 ((Endpoint_Index) (((x) << 1) - !!(end_open)))
379 /* Combination macros */
380 #define bytind_to_startind(buf, x, start_open) \
381 memind_to_startind (bytind_to_memind (buf, x), start_open)
382 #define bytind_to_endind(buf, x, end_open) \
383 memind_to_endind (bytind_to_memind (buf, x), end_open)
385 /* ------------------------------- */
386 /* buffer-or-string primitives */
387 /* ------------------------------- */
389 /* Similar for Bytinds and start/end indices. */
391 #define buffer_or_string_bytind_to_startind(obj, ind, start_open) \
392 memind_to_startind (buffer_or_string_bytind_to_memind (obj, ind), \
395 #define buffer_or_string_bytind_to_endind(obj, ind, end_open) \
396 memind_to_endind (buffer_or_string_bytind_to_memind (obj, ind), \
399 /* ------------------------------- */
400 /* Lisp-level functions */
401 /* ------------------------------- */
403 /* flags for decode_extent() */
404 #define DE_MUST_HAVE_BUFFER 1
405 #define DE_MUST_BE_ATTACHED 2
407 Lisp_Object Vlast_highlighted_extent;
408 int mouse_highlight_priority;
410 Lisp_Object Qextentp;
411 Lisp_Object Qextent_live_p;
413 Lisp_Object Qall_extents_closed;
414 Lisp_Object Qall_extents_open;
415 Lisp_Object Qall_extents_closed_open;
416 Lisp_Object Qall_extents_open_closed;
417 Lisp_Object Qstart_in_region;
418 Lisp_Object Qend_in_region;
419 Lisp_Object Qstart_and_end_in_region;
420 Lisp_Object Qstart_or_end_in_region;
421 Lisp_Object Qnegate_in_region;
423 Lisp_Object Qdetached;
424 Lisp_Object Qdestroyed;
425 Lisp_Object Qbegin_glyph;
426 Lisp_Object Qend_glyph;
427 Lisp_Object Qstart_open;
428 Lisp_Object Qend_open;
429 Lisp_Object Qstart_closed;
430 Lisp_Object Qend_closed;
431 Lisp_Object Qread_only;
432 /* Qhighlight defined in general.c */
434 Lisp_Object Qduplicable;
435 Lisp_Object Qdetachable;
436 Lisp_Object Qpriority;
437 Lisp_Object Qmouse_face;
438 Lisp_Object Qinitial_redisplay_function;
440 Lisp_Object Qglyph_layout; /* This exists only for backwards compatibility. */
441 Lisp_Object Qbegin_glyph_layout, Qend_glyph_layout;
442 Lisp_Object Qoutside_margin;
443 Lisp_Object Qinside_margin;
444 Lisp_Object Qwhitespace;
445 /* Qtext defined in general.c */
447 Lisp_Object Qcopy_function;
448 Lisp_Object Qpaste_function;
450 /* The idea here is that if we're given a list of faces, we
451 need to "memoize" this so that two lists of faces that are `equal'
452 turn into the same object. When `set-extent-face' is called, we
453 "memoize" into a list of actual faces; when `extent-face' is called,
454 we do a reverse lookup to get the list of symbols. */
456 static Lisp_Object canonicalize_extent_property (Lisp_Object prop,
458 Lisp_Object Vextent_face_memoize_hash_table;
459 Lisp_Object Vextent_face_reverse_memoize_hash_table;
460 Lisp_Object Vextent_face_reusable_list;
461 /* FSFmacs bogosity */
462 Lisp_Object Vdefault_text_properties;
465 EXFUN (Fextent_properties, 1);
466 EXFUN (Fset_extent_property, 3);
469 /************************************************************************/
470 /* Generalized gap array */
471 /************************************************************************/
473 /* This generalizes the "array with a gap" model used to store buffer
474 characters. This is based on the stuff in insdel.c and should
475 probably be merged with it. This is not extent-specific and should
476 perhaps be moved into a separate file. */
478 /* ------------------------------- */
479 /* internal functions */
480 /* ------------------------------- */
482 /* Adjust the gap array markers in the range (FROM, TO]. Parallel to
483 adjust_markers() in insdel.c. */
486 gap_array_adjust_markers (Gap_Array *ga, Memind from,
487 Memind to, int amount)
491 for (m = ga->markers; m; m = m->next)
492 m->pos = do_marker_adjustment (m->pos, from, to, amount);
495 /* Move the gap to array position POS. Parallel to move_gap() in
496 insdel.c but somewhat simplified. */
499 gap_array_move_gap (Gap_Array *ga, int pos)
502 int gapsize = ga->gapsize;
507 memmove (GAP_ARRAY_MEMEL_ADDR (ga, pos + gapsize),
508 GAP_ARRAY_MEMEL_ADDR (ga, pos),
509 (gap - pos)*ga->elsize);
510 gap_array_adjust_markers (ga, (Memind) pos, (Memind) gap,
515 memmove (GAP_ARRAY_MEMEL_ADDR (ga, gap),
516 GAP_ARRAY_MEMEL_ADDR (ga, gap + gapsize),
517 (pos - gap)*ga->elsize);
518 gap_array_adjust_markers (ga, (Memind) (gap + gapsize),
519 (Memind) (pos + gapsize), - gapsize);
524 /* Make the gap INCREMENT characters longer. Parallel to make_gap() in
528 gap_array_make_gap (Gap_Array *ga, int increment)
530 char *ptr = ga->array;
534 /* If we have to get more space, get enough to last a while. We use
535 a geometric progression that saves on realloc space. */
536 increment += 100 + ga->numels / 8;
538 ptr = (char *) xrealloc (ptr,
539 (ga->numels + ga->gapsize + increment)*ga->elsize);
544 real_gap_loc = ga->gap;
545 old_gap_size = ga->gapsize;
547 /* Call the newly allocated space a gap at the end of the whole space. */
548 ga->gap = ga->numels + ga->gapsize;
549 ga->gapsize = increment;
551 /* Move the new gap down to be consecutive with the end of the old one.
552 This adjusts the markers properly too. */
553 gap_array_move_gap (ga, real_gap_loc + old_gap_size);
555 /* Now combine the two into one large gap. */
556 ga->gapsize += old_gap_size;
557 ga->gap = real_gap_loc;
560 /* ------------------------------- */
561 /* external functions */
562 /* ------------------------------- */
564 /* Insert NUMELS elements (pointed to by ELPTR) into the specified
568 gap_array_insert_els (Gap_Array *ga, int pos, void *elptr, int numels)
570 assert (pos >= 0 && pos <= ga->numels);
571 if (ga->gapsize < numels)
572 gap_array_make_gap (ga, numels - ga->gapsize);
574 gap_array_move_gap (ga, pos);
576 memcpy (GAP_ARRAY_MEMEL_ADDR (ga, ga->gap), (char *) elptr,
578 ga->gapsize -= numels;
580 ga->numels += numels;
581 /* This is the equivalent of insert-before-markers.
583 #### Should only happen if marker is "moves forward at insert" type.
586 gap_array_adjust_markers (ga, pos - 1, pos, numels);
589 /* Delete NUMELS elements from the specified gap array, starting at FROM. */
592 gap_array_delete_els (Gap_Array *ga, int from, int numdel)
594 int to = from + numdel;
595 int gapsize = ga->gapsize;
598 assert (numdel >= 0);
599 assert (to <= ga->numels);
601 /* Make sure the gap is somewhere in or next to what we are deleting. */
603 gap_array_move_gap (ga, to);
605 gap_array_move_gap (ga, from);
607 /* Relocate all markers pointing into the new, larger gap
608 to point at the end of the text before the gap. */
609 gap_array_adjust_markers (ga, to + gapsize, to + gapsize,
612 ga->gapsize += numdel;
613 ga->numels -= numdel;
617 static Gap_Array_Marker *
618 gap_array_make_marker (Gap_Array *ga, int pos)
622 assert (pos >= 0 && pos <= ga->numels);
623 if (gap_array_marker_freelist)
625 m = gap_array_marker_freelist;
626 gap_array_marker_freelist = gap_array_marker_freelist->next;
629 m = xnew (Gap_Array_Marker);
631 m->pos = GAP_ARRAY_ARRAY_TO_MEMORY_POS (ga, pos);
632 m->next = ga->markers;
638 gap_array_delete_marker (Gap_Array *ga, Gap_Array_Marker *m)
640 Gap_Array_Marker *p, *prev;
642 for (prev = 0, p = ga->markers; p && p != m; prev = p, p = p->next)
646 prev->next = p->next;
648 ga->markers = p->next;
649 m->next = gap_array_marker_freelist;
650 m->pos = 0xDEADBEEF; /* -559038737 as an int */
651 gap_array_marker_freelist = m;
655 gap_array_delete_all_markers (Gap_Array *ga)
657 Gap_Array_Marker *p, *next;
659 for (p = ga->markers; p; p = next)
662 p->next = gap_array_marker_freelist;
663 p->pos = 0xDEADBEEF; /* -559038737 as an int */
664 gap_array_marker_freelist = p;
669 gap_array_move_marker (Gap_Array *ga, Gap_Array_Marker *m, int pos)
671 assert (pos >= 0 && pos <= ga->numels);
672 m->pos = GAP_ARRAY_ARRAY_TO_MEMORY_POS (ga, pos);
675 #define gap_array_marker_pos(ga, m) \
676 GAP_ARRAY_MEMORY_TO_ARRAY_POS (ga, (m)->pos)
679 make_gap_array (int elsize)
681 Gap_Array *ga = xnew_and_zero (Gap_Array);
687 free_gap_array (Gap_Array *ga)
691 gap_array_delete_all_markers (ga);
696 /************************************************************************/
697 /* Extent list primitives */
698 /************************************************************************/
700 /* A list of extents is maintained as a double gap array: one gap array
701 is ordered by start index (the "display order") and the other is
702 ordered by end index (the "e-order"). Note that positions in an
703 extent list should logically be conceived of as referring *to*
704 a particular extent (as is the norm in programs) rather than
705 sitting between two extents. Note also that callers of these
706 functions should not be aware of the fact that the extent list is
707 implemented as an array, except for the fact that positions are
708 integers (this should be generalized to handle integers and linked
712 /* Number of elements in an extent list */
713 #define extent_list_num_els(el) GAP_ARRAY_NUM_ELS(el->start)
715 /* Return the position at which EXTENT is located in the specified extent
716 list (in the display order if ENDP is 0, in the e-order otherwise).
717 If the extent is not found, the position where the extent would
718 be inserted is returned. If ENDP is 0, the insertion would go after
719 all other equal extents. If ENDP is not 0, the insertion would go
720 before all other equal extents. If FOUNDP is not 0, then whether
721 the extent was found will get written into it. */
724 extent_list_locate (Extent_List *el, EXTENT extent, int endp, int *foundp)
726 Gap_Array *ga = endp ? el->end : el->start;
727 int left = 0, right = GAP_ARRAY_NUM_ELS (ga);
728 int oldfoundpos, foundpos;
731 while (left != right)
733 /* RIGHT might not point to a valid extent (i.e. it's at the end
734 of the list), so NEWPOS must round down. */
735 unsigned int newpos = (left + right) >> 1;
736 EXTENT e = EXTENT_GAP_ARRAY_AT (ga, (int) newpos);
738 if (endp ? EXTENT_E_LESS (e, extent) : EXTENT_LESS (e, extent))
744 /* Now we're at the beginning of all equal extents. */
746 oldfoundpos = foundpos = left;
747 while (foundpos < GAP_ARRAY_NUM_ELS (ga))
749 EXTENT e = EXTENT_GAP_ARRAY_AT (ga, foundpos);
755 if (!EXTENT_EQUAL (e, extent))
767 /* Return the position of the first extent that begins at or after POS
768 (or ends at or after POS, if ENDP is not 0).
770 An out-of-range value for POS is allowed, and guarantees that the
771 position at the beginning or end of the extent list is returned. */
774 extent_list_locate_from_pos (Extent_List *el, Memind pos, int endp)
776 struct extent fake_extent;
779 Note that if we search for [POS, POS], then we get the following:
781 -- if ENDP is 0, then all extents whose start position is <= POS
782 lie before the returned position, and all extents whose start
783 position is > POS lie at or after the returned position.
785 -- if ENDP is not 0, then all extents whose end position is < POS
786 lie before the returned position, and all extents whose end
787 position is >= POS lie at or after the returned position.
790 set_extent_start (&fake_extent, endp ? pos : pos-1);
791 set_extent_end (&fake_extent, endp ? pos : pos-1);
792 return extent_list_locate (el, &fake_extent, endp, 0);
795 /* Return the extent at POS. */
798 extent_list_at (Extent_List *el, Memind pos, int endp)
800 Gap_Array *ga = endp ? el->end : el->start;
802 assert (pos >= 0 && pos < GAP_ARRAY_NUM_ELS (ga));
803 return EXTENT_GAP_ARRAY_AT (ga, pos);
806 /* Insert an extent into an extent list. */
809 extent_list_insert (Extent_List *el, EXTENT extent)
813 pos = extent_list_locate (el, extent, 0, &foundp);
815 gap_array_insert_els (el->start, pos, &extent, 1);
816 pos = extent_list_locate (el, extent, 1, &foundp);
818 gap_array_insert_els (el->end, pos, &extent, 1);
821 /* Delete an extent from an extent list. */
824 extent_list_delete (Extent_List *el, EXTENT extent)
828 pos = extent_list_locate (el, extent, 0, &foundp);
830 gap_array_delete_els (el->start, pos, 1);
831 pos = extent_list_locate (el, extent, 1, &foundp);
833 gap_array_delete_els (el->end, pos, 1);
837 extent_list_delete_all (Extent_List *el)
839 gap_array_delete_els (el->start, 0, GAP_ARRAY_NUM_ELS (el->start));
840 gap_array_delete_els (el->end, 0, GAP_ARRAY_NUM_ELS (el->end));
843 static Extent_List_Marker *
844 extent_list_make_marker (Extent_List *el, int pos, int endp)
846 Extent_List_Marker *m;
848 if (extent_list_marker_freelist)
850 m = extent_list_marker_freelist;
851 extent_list_marker_freelist = extent_list_marker_freelist->next;
854 m = xnew (Extent_List_Marker);
856 m->m = gap_array_make_marker (endp ? el->end : el->start, pos);
858 m->next = el->markers;
863 #define extent_list_move_marker(el, mkr, pos) \
864 gap_array_move_marker((mkr)->endp ? (el)->end : (el)->start, (mkr)->m, pos)
867 extent_list_delete_marker (Extent_List *el, Extent_List_Marker *m)
869 Extent_List_Marker *p, *prev;
871 for (prev = 0, p = el->markers; p && p != m; prev = p, p = p->next)
875 prev->next = p->next;
877 el->markers = p->next;
878 m->next = extent_list_marker_freelist;
879 extent_list_marker_freelist = m;
880 gap_array_delete_marker (m->endp ? el->end : el->start, m->m);
883 #define extent_list_marker_pos(el, mkr) \
884 gap_array_marker_pos ((mkr)->endp ? (el)->end : (el)->start, (mkr)->m)
887 allocate_extent_list (void)
889 Extent_List *el = xnew (Extent_List);
890 el->start = make_gap_array (sizeof(EXTENT));
891 el->end = make_gap_array (sizeof(EXTENT));
897 free_extent_list (Extent_List *el)
899 free_gap_array (el->start);
900 free_gap_array (el->end);
905 /************************************************************************/
906 /* Auxiliary extent structure */
907 /************************************************************************/
910 mark_extent_auxiliary (Lisp_Object obj)
912 struct extent_auxiliary *data = XEXTENT_AUXILIARY (obj);
913 mark_object (data->begin_glyph);
914 mark_object (data->end_glyph);
915 mark_object (data->invisible);
916 mark_object (data->children);
917 mark_object (data->read_only);
918 mark_object (data->mouse_face);
919 mark_object (data->initial_redisplay_function);
920 mark_object (data->before_change_functions);
921 mark_object (data->after_change_functions);
925 DEFINE_LRECORD_IMPLEMENTATION ("extent-auxiliary", extent_auxiliary,
926 mark_extent_auxiliary, internal_object_printer,
927 0, 0, 0, 0, struct extent_auxiliary);
930 allocate_extent_auxiliary (EXTENT ext)
932 Lisp_Object extent_aux;
933 struct extent_auxiliary *data =
934 alloc_lcrecord_type (struct extent_auxiliary, &lrecord_extent_auxiliary);
936 copy_lcrecord (data, &extent_auxiliary_defaults);
937 XSETEXTENT_AUXILIARY (extent_aux, data);
938 ext->plist = Fcons (extent_aux, ext->plist);
939 ext->flags.has_aux = 1;
943 /************************************************************************/
944 /* Extent info structure */
945 /************************************************************************/
947 /* An extent-info structure consists of a list of the buffer or string's
948 extents and a "stack of extents" that lists all of the extents over
949 a particular position. The stack-of-extents info is used for
950 optimization purposes -- it basically caches some info that might
951 be expensive to compute. Certain otherwise hard computations are easy
952 given the stack of extents over a particular position, and if the
953 stack of extents over a nearby position is known (because it was
954 calculated at some prior point in time), it's easy to move the stack
955 of extents to the proper position.
957 Given that the stack of extents is an optimization, and given that
958 it requires memory, a string's stack of extents is wiped out each
959 time a garbage collection occurs. Therefore, any time you retrieve
960 the stack of extents, it might not be there. If you need it to
961 be there, use the _force version.
963 Similarly, a string may or may not have an extent_info structure.
964 (Generally it won't if there haven't been any extents added to the
965 string.) So use the _force version if you need the extent_info
966 structure to be there. */
968 static struct stack_of_extents *allocate_soe (void);
969 static void free_soe (struct stack_of_extents *soe);
970 static void soe_invalidate (Lisp_Object obj);
973 mark_extent_info (Lisp_Object obj)
975 struct extent_info *data = (struct extent_info *) XEXTENT_INFO (obj);
977 Extent_List *list = data->extents;
979 /* Vbuffer_defaults and Vbuffer_local_symbols are buffer-like
980 objects that are created specially and never have their extent
981 list initialized (or rather, it is set to zero in
982 nuke_all_buffer_slots()). However, these objects get
983 garbage-collected so we have to deal.
985 (Also the list can be zero when we're dealing with a destroyed
990 for (i = 0; i < extent_list_num_els (list); i++)
992 struct extent *extent = extent_list_at (list, i, 0);
995 XSETEXTENT (exobj, extent);
1004 finalize_extent_info (void *header, int for_disksave)
1006 struct extent_info *data = (struct extent_info *) header;
1013 free_soe (data->soe);
1018 free_extent_list (data->extents);
1023 DEFINE_LRECORD_IMPLEMENTATION ("extent-info", extent_info,
1024 mark_extent_info, internal_object_printer,
1025 finalize_extent_info, 0, 0, 0,
1026 struct extent_info);
1029 allocate_extent_info (void)
1031 Lisp_Object extent_info;
1032 struct extent_info *data =
1033 alloc_lcrecord_type (struct extent_info, &lrecord_extent_info);
1035 XSETEXTENT_INFO (extent_info, data);
1036 data->extents = allocate_extent_list ();
1042 flush_cached_extent_info (Lisp_Object extent_info)
1044 struct extent_info *data = XEXTENT_INFO (extent_info);
1048 free_soe (data->soe);
1054 /************************************************************************/
1055 /* Buffer/string extent primitives */
1056 /************************************************************************/
1058 /* The functions in this section are the ONLY ones that should know
1059 about the internal implementation of the extent lists. Other functions
1060 should only know that there are two orderings on extents, the "display"
1061 order (sorted by start position, basically) and the e-order (sorted
1062 by end position, basically), and that certain operations are provided
1063 to manipulate the list. */
1065 /* ------------------------------- */
1066 /* basic primitives */
1067 /* ------------------------------- */
1070 decode_buffer_or_string (Lisp_Object object)
1073 XSETBUFFER (object, current_buffer);
1074 else if (BUFFERP (object))
1075 CHECK_LIVE_BUFFER (object);
1076 else if (STRINGP (object))
1079 dead_wrong_type_argument (Qbuffer_or_string_p, object);
1085 extent_ancestor_1 (EXTENT e)
1087 while (e->flags.has_parent)
1089 /* There should be no circularities except in case of a logic
1090 error somewhere in the extent code */
1091 e = XEXTENT (XEXTENT_AUXILIARY (XCAR (e->plist))->parent);
1096 /* Given an extent object (string or buffer or nil), return its extent info.
1097 This may be 0 for a string. */
1099 static struct extent_info *
1100 buffer_or_string_extent_info (Lisp_Object object)
1102 if (STRINGP (object))
1104 Lisp_Object plist = XSTRING (object)->plist;
1105 if (!CONSP (plist) || !EXTENT_INFOP (XCAR (plist)))
1107 return XEXTENT_INFO (XCAR (plist));
1109 else if (NILP (object))
1112 return XEXTENT_INFO (XBUFFER (object)->extent_info);
1115 /* Given a string or buffer, return its extent list. This may be
1118 static Extent_List *
1119 buffer_or_string_extent_list (Lisp_Object object)
1121 struct extent_info *info = buffer_or_string_extent_info (object);
1125 return info->extents;
1128 /* Given a string or buffer, return its extent info. If it's not there,
1131 static struct extent_info *
1132 buffer_or_string_extent_info_force (Lisp_Object object)
1134 struct extent_info *info = buffer_or_string_extent_info (object);
1138 Lisp_Object extent_info;
1140 assert (STRINGP (object)); /* should never happen for buffers --
1141 the only buffers without an extent
1142 info are those after finalization,
1143 destroyed buffers, or special
1144 Lisp-inaccessible buffer objects. */
1145 extent_info = allocate_extent_info ();
1146 XSTRING (object)->plist = Fcons (extent_info, XSTRING (object)->plist);
1147 return XEXTENT_INFO (extent_info);
1153 /* Detach all the extents in OBJECT. Called from redisplay. */
1156 detach_all_extents (Lisp_Object object)
1158 struct extent_info *data = buffer_or_string_extent_info (object);
1166 for (i = 0; i < extent_list_num_els (data->extents); i++)
1168 EXTENT e = extent_list_at (data->extents, i, 0);
1169 /* No need to do detach_extent(). Just nuke the damn things,
1170 which results in the equivalent but faster. */
1171 set_extent_start (e, -1);
1172 set_extent_end (e, -1);
1176 /* But we need to clear all the lists containing extents or
1177 havoc will result. */
1178 extent_list_delete_all (data->extents);
1179 soe_invalidate (object);
1185 init_buffer_extents (struct buffer *b)
1187 b->extent_info = allocate_extent_info ();
1191 uninit_buffer_extents (struct buffer *b)
1193 struct extent_info *data = XEXTENT_INFO (b->extent_info);
1195 /* Don't destroy the extents here -- there may still be children
1196 extents pointing to the extents. */
1197 detach_all_extents (make_buffer (b));
1198 finalize_extent_info (data, 0);
1201 /* Retrieve the extent list that an extent is a member of; the
1202 return value will never be 0 except in destroyed buffers (in which
1203 case the only extents that can refer to this buffer are detached
1206 #define extent_extent_list(e) buffer_or_string_extent_list (extent_object (e))
1208 /* ------------------------------- */
1209 /* stack of extents */
1210 /* ------------------------------- */
1212 #ifdef ERROR_CHECK_EXTENTS
1215 sledgehammer_extent_check (Lisp_Object object)
1219 Extent_List *el = buffer_or_string_extent_list (object);
1220 struct buffer *buf = 0;
1225 if (BUFFERP (object))
1226 buf = XBUFFER (object);
1228 for (endp = 0; endp < 2; endp++)
1229 for (i = 1; i < extent_list_num_els (el); i++)
1231 EXTENT e1 = extent_list_at (el, i-1, endp);
1232 EXTENT e2 = extent_list_at (el, i, endp);
1235 assert (extent_start (e1) <= buf->text->gpt ||
1236 extent_start (e1) > buf->text->gpt + buf->text->gap_size);
1237 assert (extent_end (e1) <= buf->text->gpt ||
1238 extent_end (e1) > buf->text->gpt + buf->text->gap_size);
1240 assert (extent_start (e1) <= extent_end (e1));
1241 assert (endp ? (EXTENT_E_LESS_EQUAL (e1, e2)) :
1242 (EXTENT_LESS_EQUAL (e1, e2)));
1248 static Stack_Of_Extents *
1249 buffer_or_string_stack_of_extents (Lisp_Object object)
1251 struct extent_info *info = buffer_or_string_extent_info (object);
1257 static Stack_Of_Extents *
1258 buffer_or_string_stack_of_extents_force (Lisp_Object object)
1260 struct extent_info *info = buffer_or_string_extent_info_force (object);
1262 info->soe = allocate_soe ();
1266 /* #define SOE_DEBUG */
1270 static void print_extent_1 (char *buf, Lisp_Object extent);
1273 print_extent_2 (EXTENT e)
1278 XSETEXTENT (extent, e);
1279 print_extent_1 (buf, extent);
1280 fputs (buf, stdout);
1284 soe_dump (Lisp_Object obj)
1287 Stack_Of_Extents *soe = buffer_or_string_stack_of_extents (obj);
1297 printf ("SOE pos is %d (memind %d)\n",
1298 soe->pos < 0 ? soe->pos :
1299 buffer_or_string_memind_to_bytind (obj, soe->pos),
1301 for (endp = 0; endp < 2; endp++)
1303 printf (endp ? "SOE end:" : "SOE start:");
1304 for (i = 0; i < extent_list_num_els (sel); i++)
1306 EXTENT e = extent_list_at (sel, i, endp);
1317 /* Insert EXTENT into OBJ's stack of extents, if necessary. */
1320 soe_insert (Lisp_Object obj, EXTENT extent)
1322 Stack_Of_Extents *soe = buffer_or_string_stack_of_extents (obj);
1325 printf ("Inserting into SOE: ");
1326 print_extent_2 (extent);
1329 if (!soe || soe->pos < extent_start (extent) ||
1330 soe->pos > extent_end (extent))
1333 printf ("(not needed)\n\n");
1337 extent_list_insert (soe->extents, extent);
1339 puts ("SOE afterwards is:");
1344 /* Delete EXTENT from OBJ's stack of extents, if necessary. */
1347 soe_delete (Lisp_Object obj, EXTENT extent)
1349 Stack_Of_Extents *soe = buffer_or_string_stack_of_extents (obj);
1352 printf ("Deleting from SOE: ");
1353 print_extent_2 (extent);
1356 if (!soe || soe->pos < extent_start (extent) ||
1357 soe->pos > extent_end (extent))
1360 puts ("(not needed)\n");
1364 extent_list_delete (soe->extents, extent);
1366 puts ("SOE afterwards is:");
1371 /* Move OBJ's stack of extents to lie over the specified position. */
1374 soe_move (Lisp_Object obj, Memind pos)
1376 Stack_Of_Extents *soe = buffer_or_string_stack_of_extents_force (obj);
1377 Extent_List *sel = soe->extents;
1378 int numsoe = extent_list_num_els (sel);
1379 Extent_List *bel = buffer_or_string_extent_list (obj);
1383 #ifdef ERROR_CHECK_EXTENTS
1388 printf ("Moving SOE from %d (memind %d) to %d (memind %d)\n",
1389 soe->pos < 0 ? soe->pos :
1390 buffer_or_string_memind_to_bytind (obj, soe->pos), soe->pos,
1391 buffer_or_string_memind_to_bytind (obj, pos), pos);
1398 else if (soe->pos > pos)
1406 puts ("(not needed)\n");
1411 /* For DIRECTION = 1: Any extent that overlaps POS is either in the
1412 SOE (if the extent starts at or before SOE->POS) or is greater
1413 (in the display order) than any extent in the SOE (if it starts
1416 For DIRECTION = -1: Any extent that overlaps POS is either in the
1417 SOE (if the extent ends at or after SOE->POS) or is less (in the
1418 e-order) than any extent in the SOE (if it ends before SOE->POS).
1420 We proceed in two stages:
1422 1) delete all extents in the SOE that don't overlap POS.
1423 2) insert all extents into the SOE that start (or end, when
1424 DIRECTION = -1) in (SOE->POS, POS] and that overlap
1425 POS. (Don't include SOE->POS in the range because those
1426 extents would already be in the SOE.)
1433 /* Delete all extents in the SOE that don't overlap POS.
1434 This is all extents that end before (or start after,
1435 if DIRECTION = -1) POS.
1438 /* Deleting extents from the SOE is tricky because it changes
1439 the positions of extents. If we are deleting in the forward
1440 direction we have to call extent_list_at() on the same position
1441 over and over again because positions after the deleted element
1442 get shifted back by 1. To make life simplest, we delete forward
1443 irrespective of DIRECTION.
1451 end = extent_list_locate_from_pos (sel, pos, 1);
1455 start = extent_list_locate_from_pos (sel, pos+1, 0);
1459 for (i = start; i < end; i++)
1460 extent_list_delete (sel, extent_list_at (sel, start /* see above */,
1470 start_pos = extent_list_locate_from_pos (bel, soe->pos, endp) - 1;
1472 start_pos = extent_list_locate_from_pos (bel, soe->pos + 1, endp);
1474 for (; start_pos >= 0 && start_pos < extent_list_num_els (bel);
1475 start_pos += direction)
1477 EXTENT e = extent_list_at (bel, start_pos, endp);
1478 if ((direction > 0) ?
1479 (extent_start (e) > pos) :
1480 (extent_end (e) < pos))
1481 break; /* All further extents lie on the far side of POS
1482 and thus can't overlap. */
1483 if ((direction > 0) ?
1484 (extent_end (e) >= pos) :
1485 (extent_start (e) <= pos))
1486 extent_list_insert (sel, e);
1492 puts ("SOE afterwards is:");
1498 soe_invalidate (Lisp_Object obj)
1500 Stack_Of_Extents *soe = buffer_or_string_stack_of_extents (obj);
1504 extent_list_delete_all (soe->extents);
1509 static struct stack_of_extents *
1512 struct stack_of_extents *soe = xnew_and_zero (struct stack_of_extents);
1513 soe->extents = allocate_extent_list ();
1519 free_soe (struct stack_of_extents *soe)
1521 free_extent_list (soe->extents);
1525 /* ------------------------------- */
1526 /* other primitives */
1527 /* ------------------------------- */
1529 /* Return the start (endp == 0) or end (endp == 1) of an extent as
1530 a byte index. If you want the value as a memory index, use
1531 extent_endpoint(). If you want the value as a buffer position,
1532 use extent_endpoint_bufpos(). */
1535 extent_endpoint_bytind (EXTENT extent, int endp)
1537 assert (EXTENT_LIVE_P (extent));
1538 assert (!extent_detached_p (extent));
1540 Memind i = (endp) ? (extent_end (extent)) :
1541 (extent_start (extent));
1542 Lisp_Object obj = extent_object (extent);
1543 return buffer_or_string_memind_to_bytind (obj, i);
1548 extent_endpoint_bufpos (EXTENT extent, int endp)
1550 assert (EXTENT_LIVE_P (extent));
1551 assert (!extent_detached_p (extent));
1553 Memind i = (endp) ? (extent_end (extent)) :
1554 (extent_start (extent));
1555 Lisp_Object obj = extent_object (extent);
1556 return buffer_or_string_memind_to_bufpos (obj, i);
1560 /* A change to an extent occurred that will change the display, so
1561 notify redisplay. Maybe also recurse over all the extent's
1565 extent_changed_for_redisplay (EXTENT extent, int descendants_too,
1566 int invisibility_change)
1571 /* we could easily encounter a detached extent while traversing the
1572 children, but we should never be able to encounter a dead extent. */
1573 assert (EXTENT_LIVE_P (extent));
1575 if (descendants_too)
1577 Lisp_Object children = extent_children (extent);
1579 if (!NILP (children))
1581 /* first mark all of the extent's children. We will lose big-time
1582 if there are any circularities here, so we sure as hell better
1583 ensure that there aren't. */
1584 LIST_LOOP (rest, XWEAK_LIST_LIST (children))
1585 extent_changed_for_redisplay (XEXTENT (XCAR (rest)), 1,
1586 invisibility_change);
1590 /* now mark the extent itself. */
1592 object = extent_object (extent);
1594 if (!BUFFERP (object) || extent_detached_p (extent))
1595 /* #### Can changes to string extents affect redisplay?
1596 I will have to think about this. What about string glyphs?
1597 Things in the modeline? etc. */
1598 /* #### changes to string extents can certainly affect redisplay
1599 if the extent is in some generated-modeline-string: when
1600 we change an extent in generated-modeline-string, this changes
1601 its parent, which is in `modeline-format', so we should
1602 force the modeline to be updated. But how to determine whether
1603 a string is a `generated-modeline-string'? Looping through
1604 all buffers is not very efficient. Should we add all
1605 `generated-modeline-string' strings to a hash table?
1606 Maybe efficiency is not the greatest concern here and there's
1607 no big loss in looping over the buffers. */
1612 b = XBUFFER (object);
1613 BUF_FACECHANGE (b)++;
1614 MARK_EXTENTS_CHANGED;
1615 if (invisibility_change)
1617 buffer_extent_signal_changed_region (b,
1618 extent_endpoint_bufpos (extent, 0),
1619 extent_endpoint_bufpos (extent, 1));
1623 /* A change to an extent occurred that might affect redisplay.
1624 This is called when properties such as the endpoints, the layout,
1625 or the priority changes. Redisplay will be affected only if
1626 the extent has any displayable attributes. */
1629 extent_maybe_changed_for_redisplay (EXTENT extent, int descendants_too,
1630 int invisibility_change)
1632 /* Retrieve the ancestor for efficiency */
1633 EXTENT anc = extent_ancestor (extent);
1634 if (!NILP (extent_face (anc)) ||
1635 !NILP (extent_begin_glyph (anc)) ||
1636 !NILP (extent_end_glyph (anc)) ||
1637 !NILP (extent_mouse_face (anc)) ||
1638 !NILP (extent_invisible (anc)) ||
1639 !NILP (extent_initial_redisplay_function (anc)) ||
1640 invisibility_change)
1641 extent_changed_for_redisplay (extent, descendants_too,
1642 invisibility_change);
1646 make_extent_detached (Lisp_Object object)
1648 EXTENT extent = allocate_extent ();
1650 assert (NILP (object) || STRINGP (object) ||
1651 (BUFFERP (object) && BUFFER_LIVE_P (XBUFFER (object))));
1652 extent_object (extent) = object;
1653 /* Now make sure the extent info exists. */
1655 buffer_or_string_extent_info_force (object);
1659 /* A "real" extent is any extent other than the internal (not-user-visible)
1660 extents used by `map-extents'. */
1663 real_extent_at_forward (Extent_List *el, int pos, int endp)
1665 for (; pos < extent_list_num_els (el); pos++)
1667 EXTENT e = extent_list_at (el, pos, endp);
1668 if (!extent_internal_p (e))
1675 real_extent_at_backward (Extent_List *el, int pos, int endp)
1677 for (; pos >= 0; pos--)
1679 EXTENT e = extent_list_at (el, pos, endp);
1680 if (!extent_internal_p (e))
1687 extent_first (Lisp_Object obj)
1689 Extent_List *el = buffer_or_string_extent_list (obj);
1693 return real_extent_at_forward (el, 0, 0);
1698 extent_e_first (Lisp_Object obj)
1700 Extent_List *el = buffer_or_string_extent_list (obj);
1704 return real_extent_at_forward (el, 0, 1);
1709 extent_next (EXTENT e)
1711 Extent_List *el = extent_extent_list (e);
1713 int pos = extent_list_locate (el, e, 0, &foundp);
1715 return real_extent_at_forward (el, pos+1, 0);
1720 extent_e_next (EXTENT e)
1722 Extent_List *el = extent_extent_list (e);
1724 int pos = extent_list_locate (el, e, 1, &foundp);
1726 return real_extent_at_forward (el, pos+1, 1);
1731 extent_last (Lisp_Object obj)
1733 Extent_List *el = buffer_or_string_extent_list (obj);
1737 return real_extent_at_backward (el, extent_list_num_els (el) - 1, 0);
1742 extent_e_last (Lisp_Object obj)
1744 Extent_List *el = buffer_or_string_extent_list (obj);
1748 return real_extent_at_backward (el, extent_list_num_els (el) - 1, 1);
1753 extent_previous (EXTENT e)
1755 Extent_List *el = extent_extent_list (e);
1757 int pos = extent_list_locate (el, e, 0, &foundp);
1759 return real_extent_at_backward (el, pos-1, 0);
1764 extent_e_previous (EXTENT e)
1766 Extent_List *el = extent_extent_list (e);
1768 int pos = extent_list_locate (el, e, 1, &foundp);
1770 return real_extent_at_backward (el, pos-1, 1);
1775 extent_attach (EXTENT extent)
1777 Extent_List *el = extent_extent_list (extent);
1779 extent_list_insert (el, extent);
1780 soe_insert (extent_object (extent), extent);
1781 /* only this extent changed */
1782 extent_maybe_changed_for_redisplay (extent, 0,
1783 !NILP (extent_invisible (extent)));
1787 extent_detach (EXTENT extent)
1791 if (extent_detached_p (extent))
1793 el = extent_extent_list (extent);
1795 /* call this before messing with the extent. */
1796 extent_maybe_changed_for_redisplay (extent, 0,
1797 !NILP (extent_invisible (extent)));
1798 extent_list_delete (el, extent);
1799 soe_delete (extent_object (extent), extent);
1800 set_extent_start (extent, -1);
1801 set_extent_end (extent, -1);
1804 /* ------------------------------- */
1805 /* map-extents et al. */
1806 /* ------------------------------- */
1808 /* Returns true iff map_extents() would visit the given extent.
1809 See the comments at map_extents() for info on the overlap rule.
1810 Assumes that all validation on the extent and buffer positions has
1811 already been performed (see Fextent_in_region_p ()).
1814 extent_in_region_p (EXTENT extent, Bytind from, Bytind to,
1817 Lisp_Object obj = extent_object (extent);
1818 Endpoint_Index start, end, exs, exe;
1819 int start_open, end_open;
1820 unsigned int all_extents_flags = flags & ME_ALL_EXTENTS_MASK;
1821 unsigned int in_region_flags = flags & ME_IN_REGION_MASK;
1824 /* A zero-length region is treated as closed-closed. */
1827 flags |= ME_END_CLOSED;
1828 flags &= ~ME_START_OPEN;
1831 /* So is a zero-length extent. */
1832 if (extent_start (extent) == extent_end (extent))
1833 start_open = 0, end_open = 0;
1834 /* `all_extents_flags' will almost always be zero. */
1835 else if (all_extents_flags == 0)
1837 start_open = extent_start_open_p (extent);
1838 end_open = extent_end_open_p (extent);
1841 switch (all_extents_flags)
1843 case ME_ALL_EXTENTS_CLOSED: start_open = 0, end_open = 0; break;
1844 case ME_ALL_EXTENTS_OPEN: start_open = 1, end_open = 1; break;
1845 case ME_ALL_EXTENTS_CLOSED_OPEN: start_open = 0, end_open = 1; break;
1846 case ME_ALL_EXTENTS_OPEN_CLOSED: start_open = 1, end_open = 0; break;
1847 default: abort(); break;
1850 start = buffer_or_string_bytind_to_startind (obj, from,
1851 flags & ME_START_OPEN);
1852 end = buffer_or_string_bytind_to_endind (obj, to, ! (flags & ME_END_CLOSED));
1853 exs = memind_to_startind (extent_start (extent), start_open);
1854 exe = memind_to_endind (extent_end (extent), end_open);
1856 /* It's easy to determine whether an extent lies *outside* the
1857 region -- just determine whether it's completely before
1858 or completely after the region. Reject all such extents, so
1859 we're now left with only the extents that overlap the region.
1862 if (exs > end || exe < start)
1865 /* See if any further restrictions are called for. */
1866 /* in_region_flags will almost always be zero. */
1867 if (in_region_flags == 0)
1870 switch (in_region_flags)
1872 case ME_START_IN_REGION:
1873 retval = start <= exs && exs <= end; break;
1874 case ME_END_IN_REGION:
1875 retval = start <= exe && exe <= end; break;
1876 case ME_START_AND_END_IN_REGION:
1877 retval = start <= exs && exe <= end; break;
1878 case ME_START_OR_END_IN_REGION:
1879 retval = (start <= exs && exs <= end) || (start <= exe && exe <= end);
1884 return flags & ME_NEGATE_IN_REGION ? !retval : retval;
1887 struct map_extents_struct
1890 Extent_List_Marker *mkr;
1895 map_extents_unwind (Lisp_Object obj)
1897 struct map_extents_struct *closure =
1898 (struct map_extents_struct *) get_opaque_ptr (obj);
1899 free_opaque_ptr (obj);
1901 extent_detach (closure->range);
1903 extent_list_delete_marker (closure->el, closure->mkr);
1907 /* This is the guts of `map-extents' and the other functions that
1908 map over extents. In theory the operation of this function is
1909 simple: just figure out what extents we're mapping over, and
1910 call the function on each one of them in the range. Unfortunately
1911 there are a wide variety of things that the mapping function
1912 might do, and we have to be very tricky to avoid getting messed
1913 up. Furthermore, this function needs to be very fast (it is
1914 called multiple times every time text is inserted or deleted
1915 from a buffer), and so we can't always afford the overhead of
1916 dealing with all the possible things that the mapping function
1917 might do; thus, there are many flags that can be specified
1918 indicating what the mapping function might or might not do.
1920 The result of all this is that this is the most complicated
1921 function in this file. Change it at your own risk!
1923 A potential simplification to the logic below is to determine
1924 all the extents that the mapping function should be called on
1925 before any calls are actually made and save them in an array.
1926 That introduces its own complications, however (the array
1927 needs to be marked for garbage-collection, and a static array
1928 cannot be used because map_extents() needs to be reentrant).
1929 Furthermore, the results might be a little less sensible than
1934 map_extents_bytind (Bytind from, Bytind to, map_extents_fun fn, void *arg,
1935 Lisp_Object obj, EXTENT after, unsigned int flags)
1937 Memind st, en; /* range we're mapping over */
1938 EXTENT range = 0; /* extent for this, if ME_MIGHT_MODIFY_TEXT */
1939 Extent_List *el = 0; /* extent list we're iterating over */
1940 Extent_List_Marker *posm = 0; /* marker for extent list,
1941 if ME_MIGHT_MODIFY_EXTENTS */
1942 /* count and struct for unwind-protect, if ME_MIGHT_THROW */
1944 struct map_extents_struct closure;
1946 #ifdef ERROR_CHECK_EXTENTS
1947 assert (from <= to);
1948 assert (from >= buffer_or_string_absolute_begin_byte (obj) &&
1949 from <= buffer_or_string_absolute_end_byte (obj) &&
1950 to >= buffer_or_string_absolute_begin_byte (obj) &&
1951 to <= buffer_or_string_absolute_end_byte (obj));
1956 assert (EQ (obj, extent_object (after)));
1957 assert (!extent_detached_p (after));
1960 el = buffer_or_string_extent_list (obj);
1961 if (!el || !extent_list_num_els(el))
1965 st = buffer_or_string_bytind_to_memind (obj, from);
1966 en = buffer_or_string_bytind_to_memind (obj, to);
1968 if (flags & ME_MIGHT_MODIFY_TEXT)
1970 /* The mapping function might change the text in the buffer,
1971 so make an internal extent to hold the range we're mapping
1973 range = make_extent_detached (obj);
1974 set_extent_start (range, st);
1975 set_extent_end (range, en);
1976 range->flags.start_open = flags & ME_START_OPEN;
1977 range->flags.end_open = !(flags & ME_END_CLOSED);
1978 range->flags.internal = 1;
1979 range->flags.detachable = 0;
1980 extent_attach (range);
1983 if (flags & ME_MIGHT_THROW)
1985 /* The mapping function might throw past us so we need to use an
1986 unwind_protect() to eliminate the internal extent and range
1988 count = specpdl_depth ();
1989 closure.range = range;
1991 record_unwind_protect (map_extents_unwind,
1992 make_opaque_ptr (&closure));
1995 /* ---------- Figure out where we start and what direction
1996 we move in. This is the trickiest part of this
1997 function. ---------- */
1999 /* If ME_START_IN_REGION, ME_END_IN_REGION or ME_START_AND_END_IN_REGION
2000 was specified and ME_NEGATE_IN_REGION was not specified, our job
2001 is simple because of the presence of the display order and e-order.
2002 (Note that theoretically do something similar for
2003 ME_START_OR_END_IN_REGION, but that would require more trickiness
2004 than it's worth to avoid hitting the same extent twice.)
2006 In the general case, all the extents that overlap a range can be
2007 divided into two classes: those whose start position lies within
2008 the range (including the range's end but not including the
2009 range's start), and those that overlap the start position,
2010 i.e. those in the SOE for the start position. Or equivalently,
2011 the extents can be divided into those whose end position lies
2012 within the range and those in the SOE for the end position. Note
2013 that for this purpose we treat both the range and all extents in
2014 the buffer as closed on both ends. If this is not what the ME_
2015 flags specified, then we've mapped over a few too many extents,
2016 but no big deal because extent_in_region_p() will filter them
2017 out. Ideally, we could move the SOE to the closer of the range's
2018 two ends and work forwards or backwards from there. However, in
2019 order to make the semantics of the AFTER argument work out, we
2020 have to always go in the same direction; so we choose to always
2021 move the SOE to the start position.
2023 When it comes time to do the SOE stage, we first call soe_move()
2024 so that the SOE gets set up. Note that the SOE might get
2025 changed while we are mapping over its contents. If we can
2026 guarantee that the SOE won't get moved to a new position, we
2027 simply need to put a marker in the SOE and we will track deletions
2028 and insertions of extents in the SOE. If the SOE might get moved,
2029 however (this would happen as a result of a recursive invocation
2030 of map-extents or a call to a redisplay-type function), then
2031 trying to track its changes is hopeless, so we just keep a
2032 marker to the first (or last) extent in the SOE and use that as
2035 Finally, if DONT_USE_SOE is defined, we don't use the SOE at all
2036 and instead just map from the beginning of the buffer. This is
2037 used for testing purposes and allows the SOE to be calculated
2038 using map_extents() instead of the other way around. */
2041 int range_flag; /* ME_*_IN_REGION subset of flags */
2042 int do_soe_stage = 0; /* Are we mapping over the SOE? */
2043 /* Does the range stage map over start or end positions? */
2045 /* If type == 0, we include the start position in the range stage mapping.
2046 If type == 1, we exclude the start position in the range stage mapping.
2047 If type == 2, we begin at range_start_pos, an extent-list position.
2049 int range_start_type = 0;
2050 int range_start_pos = 0;
2053 range_flag = flags & ME_IN_REGION_MASK;
2054 if ((range_flag == ME_START_IN_REGION ||
2055 range_flag == ME_START_AND_END_IN_REGION) &&
2056 !(flags & ME_NEGATE_IN_REGION))
2058 /* map over start position in [range-start, range-end]. No SOE
2062 else if (range_flag == ME_END_IN_REGION && !(flags & ME_NEGATE_IN_REGION))
2064 /* map over end position in [range-start, range-end]. No SOE
2070 /* Need to include the SOE extents. */
2072 /* Just brute-force it: start from the beginning. */
2074 range_start_type = 2;
2075 range_start_pos = 0;
2077 Stack_Of_Extents *soe = buffer_or_string_stack_of_extents_force (obj);
2080 /* Move the SOE to the closer end of the range. This dictates
2081 whether we map over start positions or end positions. */
2084 numsoe = extent_list_num_els (soe->extents);
2087 if (flags & ME_MIGHT_MOVE_SOE)
2090 /* Can't map over SOE, so just extend range to cover the
2092 EXTENT e = extent_list_at (soe->extents, 0, 0);
2094 extent_list_locate (buffer_or_string_extent_list (obj), e, 0,
2097 range_start_type = 2;
2101 /* We can map over the SOE. */
2103 range_start_type = 1;
2108 /* No extents in the SOE to map over, so we act just as if
2109 ME_START_IN_REGION or ME_END_IN_REGION was specified.
2110 RANGE_ENDP already specified so no need to do anything else. */
2115 /* ---------- Now loop over the extents. ---------- */
2117 /* We combine the code for the two stages because much of it
2119 for (stage = 0; stage < 2; stage++)
2121 int pos = 0; /* Position in extent list */
2123 /* First set up start conditions */
2125 { /* The SOE stage */
2128 el = buffer_or_string_stack_of_extents_force (obj)->extents;
2129 /* We will always be looping over start extents here. */
2130 assert (!range_endp);
2134 { /* The range stage */
2135 el = buffer_or_string_extent_list (obj);
2136 switch (range_start_type)
2139 pos = extent_list_locate_from_pos (el, st, range_endp);
2142 pos = extent_list_locate_from_pos (el, st + 1, range_endp);
2145 pos = range_start_pos;
2150 if (flags & ME_MIGHT_MODIFY_EXTENTS)
2152 /* Create a marker to track changes to the extent list */
2154 /* Delete the marker used in the SOE stage. */
2155 extent_list_delete_marker
2156 (buffer_or_string_stack_of_extents_force (obj)->extents, posm);
2157 posm = extent_list_make_marker (el, pos, range_endp);
2158 /* tell the unwind function about the marker. */
2169 /* ----- update position in extent list
2170 and fetch next extent ----- */
2173 /* fetch POS again to track extent insertions or deletions */
2174 pos = extent_list_marker_pos (el, posm);
2175 if (pos >= extent_list_num_els (el))
2177 e = extent_list_at (el, pos, range_endp);
2180 /* now point the marker to the next one we're going to process.
2181 This ensures graceful behavior if this extent is deleted. */
2182 extent_list_move_marker (el, posm, pos);
2184 /* ----- deal with internal extents ----- */
2186 if (extent_internal_p (e))
2188 if (!(flags & ME_INCLUDE_INTERNAL))
2190 else if (e == range)
2192 /* We're processing internal extents and we've
2193 come across our own special range extent.
2194 (This happens only in adjust_extents*() and
2195 process_extents*(), which handle text
2196 insertion and deletion.) We need to omit
2197 processing of this extent; otherwise
2198 we will probably end up prematurely
2199 terminating this loop. */
2204 /* ----- deal with AFTER condition ----- */
2208 /* if e > after, then we can stop skipping extents. */
2209 if (EXTENT_LESS (after, e))
2211 else /* otherwise, skip this extent. */
2215 /* ----- stop if we're completely outside the range ----- */
2217 /* fetch ST and EN again to track text insertions or deletions */
2220 st = extent_start (range);
2221 en = extent_end (range);
2223 if (extent_endpoint (e, range_endp) > en)
2225 /* Can't be mapping over SOE because all extents in
2226 there should overlap ST */
2227 assert (stage == 1);
2231 /* ----- Now actually call the function ----- */
2233 obj2 = extent_object (e);
2234 if (extent_in_region_p (e,
2235 buffer_or_string_memind_to_bytind (obj2,
2237 buffer_or_string_memind_to_bytind (obj2,
2243 /* Function wants us to stop mapping. */
2244 stage = 1; /* so outer for loop will terminate */
2250 /* ---------- Finished looping. ---------- */
2253 if (flags & ME_MIGHT_THROW)
2254 /* This deletes the range extent and frees the marker. */
2255 unbind_to (count, Qnil);
2258 /* Delete them ourselves */
2260 extent_detach (range);
2262 extent_list_delete_marker (el, posm);
2267 map_extents (Bufpos from, Bufpos to, map_extents_fun fn,
2268 void *arg, Lisp_Object obj, EXTENT after, unsigned int flags)
2270 map_extents_bytind (buffer_or_string_bufpos_to_bytind (obj, from),
2271 buffer_or_string_bufpos_to_bytind (obj, to), fn, arg,
2275 /* ------------------------------- */
2276 /* adjust_extents() */
2277 /* ------------------------------- */
2279 /* Add AMOUNT to all extent endpoints in the range (FROM, TO]. This
2280 happens whenever the gap is moved or (under Mule) a character in a
2281 string is substituted for a different-length one. The reason for
2282 this is that extent endpoints behave just like markers (all memory
2283 indices do) and this adjustment correct for markers -- see
2284 adjust_markers(). Note that it is important that we visit all
2285 extent endpoints in the range, irrespective of whether the
2286 endpoints are open or closed.
2288 We could use map_extents() for this (and in fact the function
2289 was originally written that way), but the gap is in an incoherent
2290 state when this function is called and this function plays
2291 around with extent endpoints without detaching and reattaching
2292 the extents (this is provably correct and saves lots of time),
2293 so for safety we make it just look at the extent lists directly. */
2296 adjust_extents (Lisp_Object obj, Memind from, Memind to, int amount)
2302 Stack_Of_Extents *soe;
2304 #ifdef ERROR_CHECK_EXTENTS
2305 sledgehammer_extent_check (obj);
2307 el = buffer_or_string_extent_list (obj);
2309 if (!el || !extent_list_num_els(el))
2312 /* IMPORTANT! Compute the starting positions of the extents to
2313 modify BEFORE doing any modification! Otherwise the starting
2314 position for the second time through the loop might get
2315 incorrectly calculated (I got bit by this bug real bad). */
2316 startpos[0] = extent_list_locate_from_pos (el, from+1, 0);
2317 startpos[1] = extent_list_locate_from_pos (el, from+1, 1);
2318 for (endp = 0; endp < 2; endp++)
2320 for (pos = startpos[endp]; pos < extent_list_num_els (el);
2323 EXTENT e = extent_list_at (el, pos, endp);
2324 if (extent_endpoint (e, endp) > to)
2326 set_extent_endpoint (e,
2327 do_marker_adjustment (extent_endpoint (e, endp),
2333 /* The index for the buffer's SOE is a memory index and thus
2334 needs to be adjusted like a marker. */
2335 soe = buffer_or_string_stack_of_extents (obj);
2336 if (soe && soe->pos >= 0)
2337 soe->pos = do_marker_adjustment (soe->pos, from, to, amount);
2340 /* ------------------------------- */
2341 /* adjust_extents_for_deletion() */
2342 /* ------------------------------- */
2344 struct adjust_extents_for_deletion_arg
2346 EXTENT_dynarr *list;
2350 adjust_extents_for_deletion_mapper (EXTENT extent, void *arg)
2352 struct adjust_extents_for_deletion_arg *closure =
2353 (struct adjust_extents_for_deletion_arg *) arg;
2355 Dynarr_add (closure->list, extent);
2356 return 0; /* continue mapping */
2359 /* For all extent endpoints in the range (FROM, TO], move them to the beginning
2360 of the new gap. Note that it is important that we visit all extent
2361 endpoints in the range, irrespective of whether the endpoints are open or
2364 This function deals with weird stuff such as the fact that extents
2367 There is no string correspondent for this because you can't
2368 delete characters from a string.
2372 adjust_extents_for_deletion (Lisp_Object object, Bytind from,
2373 Bytind to, int gapsize, int numdel,
2376 struct adjust_extents_for_deletion_arg closure;
2378 Memind adjust_to = (Memind) (to + gapsize);
2379 Bytecount amount = - numdel - movegapsize;
2380 Memind oldsoe = 0, newsoe = 0;
2381 Stack_Of_Extents *soe = buffer_or_string_stack_of_extents (object);
2383 #ifdef ERROR_CHECK_EXTENTS
2384 sledgehammer_extent_check (object);
2386 closure.list = Dynarr_new (EXTENT);
2388 /* We're going to be playing weird games below with extents and the SOE
2389 and such, so compute the list now of all the extents that we're going
2390 to muck with. If we do the mapping and adjusting together, things can
2391 get all screwed up. */
2393 map_extents_bytind (from, to, adjust_extents_for_deletion_mapper,
2394 (void *) &closure, object, 0,
2395 /* extent endpoints move like markers regardless
2396 of their open/closeness. */
2397 ME_ALL_EXTENTS_CLOSED | ME_END_CLOSED |
2398 ME_START_OR_END_IN_REGION | ME_INCLUDE_INTERNAL);
2401 Old and new values for the SOE's position. (It gets adjusted
2402 like a marker, just like extent endpoints.)
2409 newsoe = do_marker_adjustment (soe->pos,
2410 adjust_to, adjust_to,
2416 for (i = 0; i < Dynarr_length (closure.list); i++)
2418 EXTENT extent = Dynarr_at (closure.list, i);
2419 Memind new_start = extent_start (extent);
2420 Memind new_end = extent_end (extent);
2422 /* do_marker_adjustment() will not adjust values that should not be
2423 adjusted. We're passing the same funky arguments to
2424 do_marker_adjustment() as buffer_delete_range() does. */
2426 do_marker_adjustment (new_start,
2427 adjust_to, adjust_to,
2430 do_marker_adjustment (new_end,
2431 adjust_to, adjust_to,
2434 /* We need to be very careful here so that the SOE doesn't get
2435 corrupted. We are shrinking extents out of the deleted region
2436 and simultaneously moving the SOE's pos out of the deleted
2437 region, so the SOE should contain the same extents at the end
2438 as at the beginning. However, extents may get reordered
2439 by this process, so we have to operate by pulling the extents
2440 out of the buffer and SOE, changing their bounds, and then
2441 reinserting them. In order for the SOE not to get screwed up,
2442 we have to make sure that the SOE's pos points to its old
2443 location whenever we pull an extent out, and points to its
2444 new location whenever we put the extent back in.
2447 if (new_start != extent_start (extent) ||
2448 new_end != extent_end (extent))
2450 extent_detach (extent);
2451 set_extent_start (extent, new_start);
2452 set_extent_end (extent, new_end);
2455 extent_attach (extent);
2464 #ifdef ERROR_CHECK_EXTENTS
2465 sledgehammer_extent_check (object);
2467 Dynarr_free (closure.list);
2470 /* ------------------------------- */
2471 /* extent fragments */
2472 /* ------------------------------- */
2474 /* Imagine that the buffer is divided up into contiguous,
2475 nonoverlapping "runs" of text such that no extent
2476 starts or ends within a run (extents that abut the
2479 An extent fragment is a structure that holds data about
2480 the run that contains a particular buffer position (if
2481 the buffer position is at the junction of two runs, the
2482 run after the position is used) -- the beginning and
2483 end of the run, a list of all of the extents in that
2484 run, the "merged face" that results from merging all of
2485 the faces corresponding to those extents, the begin and
2486 end glyphs at the beginning of the run, etc. This is
2487 the information that redisplay needs in order to
2490 Extent fragments have to be very quick to update to
2491 a new buffer position when moving linearly through
2492 the buffer. They rely on the stack-of-extents code,
2493 which does the heavy-duty algorithmic work of determining
2494 which extents overly a particular position. */
2496 /* This function returns the position of the beginning of
2497 the first run that begins after POS, or returns POS if
2498 there are no such runs. */
2501 extent_find_end_of_run (Lisp_Object obj, Bytind pos, int outside_accessible)
2504 Extent_List *bel = buffer_or_string_extent_list (obj);
2507 Memind mempos = buffer_or_string_bytind_to_memind (obj, pos);
2508 Bytind limit = outside_accessible ?
2509 buffer_or_string_absolute_end_byte (obj) :
2510 buffer_or_string_accessible_end_byte (obj);
2512 if (!bel || !extent_list_num_els(bel))
2515 sel = buffer_or_string_stack_of_extents_force (obj)->extents;
2516 soe_move (obj, mempos);
2518 /* Find the first start position after POS. */
2519 elind1 = extent_list_locate_from_pos (bel, mempos+1, 0);
2520 if (elind1 < extent_list_num_els (bel))
2521 pos1 = buffer_or_string_memind_to_bytind
2522 (obj, extent_start (extent_list_at (bel, elind1, 0)));
2526 /* Find the first end position after POS. The extent corresponding
2527 to this position is either in the SOE or is greater than or
2528 equal to POS1, so we just have to look in the SOE. */
2529 elind2 = extent_list_locate_from_pos (sel, mempos+1, 1);
2530 if (elind2 < extent_list_num_els (sel))
2531 pos2 = buffer_or_string_memind_to_bytind
2532 (obj, extent_end (extent_list_at (sel, elind2, 1)));
2536 return min (min (pos1, pos2), limit);
2540 extent_find_beginning_of_run (Lisp_Object obj, Bytind pos,
2541 int outside_accessible)
2544 Extent_List *bel = buffer_or_string_extent_list (obj);
2547 Memind mempos = buffer_or_string_bytind_to_memind (obj, pos);
2548 Bytind limit = outside_accessible ?
2549 buffer_or_string_absolute_begin_byte (obj) :
2550 buffer_or_string_accessible_begin_byte (obj);
2552 if (!bel || !extent_list_num_els(bel))
2555 sel = buffer_or_string_stack_of_extents_force (obj)->extents;
2556 soe_move (obj, mempos);
2558 /* Find the first end position before POS. */
2559 elind1 = extent_list_locate_from_pos (bel, mempos, 1);
2561 pos1 = buffer_or_string_memind_to_bytind
2562 (obj, extent_end (extent_list_at (bel, elind1 - 1, 1)));
2566 /* Find the first start position before POS. The extent corresponding
2567 to this position is either in the SOE or is less than or
2568 equal to POS1, so we just have to look in the SOE. */
2569 elind2 = extent_list_locate_from_pos (sel, mempos, 0);
2571 pos2 = buffer_or_string_memind_to_bytind
2572 (obj, extent_start (extent_list_at (sel, elind2 - 1, 0)));
2576 return max (max (pos1, pos2), limit);
2579 struct extent_fragment *
2580 extent_fragment_new (Lisp_Object buffer_or_string, struct frame *frm)
2582 struct extent_fragment *ef = xnew_and_zero (struct extent_fragment);
2584 ef->object = buffer_or_string;
2586 ef->extents = Dynarr_new (EXTENT);
2587 ef->begin_glyphs = Dynarr_new (glyph_block);
2588 ef->end_glyphs = Dynarr_new (glyph_block);
2594 extent_fragment_delete (struct extent_fragment *ef)
2596 Dynarr_free (ef->extents);
2597 Dynarr_free (ef->begin_glyphs);
2598 Dynarr_free (ef->end_glyphs);
2602 /* Note: CONST is losing, but `const' is part of the interface of qsort() */
2604 extent_priority_sort_function (const void *humpty, const void *dumpty)
2606 CONST EXTENT foo = * (CONST EXTENT *) humpty;
2607 CONST EXTENT bar = * (CONST EXTENT *) dumpty;
2608 if (extent_priority (foo) < extent_priority (bar))
2610 return extent_priority (foo) > extent_priority (bar);
2614 extent_fragment_sort_by_priority (EXTENT_dynarr *extarr)
2618 /* Sort our copy of the stack by extent_priority. We use a bubble
2619 sort here because it's going to be faster than qsort() for small
2620 numbers of extents (less than 10 or so), and 99.999% of the time
2621 there won't ever be more extents than this in the stack. */
2622 if (Dynarr_length (extarr) < 10)
2624 for (i = 1; i < Dynarr_length (extarr); i++)
2628 (extent_priority (Dynarr_at (extarr, j)) >
2629 extent_priority (Dynarr_at (extarr, j+1))))
2631 EXTENT tmp = Dynarr_at (extarr, j);
2632 Dynarr_at (extarr, j) = Dynarr_at (extarr, j+1);
2633 Dynarr_at (extarr, j+1) = tmp;
2639 /* But some loser programs mess up and may create a large number
2640 of extents overlapping the same spot. This will result in
2641 catastrophic behavior if we use the bubble sort above. */
2642 qsort (Dynarr_atp (extarr, 0), Dynarr_length (extarr),
2643 sizeof (EXTENT), extent_priority_sort_function);
2646 /* If PROP is the `invisible' property of an extent,
2647 this is 1 if the extent should be treated as invisible. */
2649 #define EXTENT_PROP_MEANS_INVISIBLE(buf, prop) \
2650 (EQ (buf->invisibility_spec, Qt) \
2652 : invisible_p (prop, buf->invisibility_spec))
2654 /* If PROP is the `invisible' property of a extent,
2655 this is 1 if the extent should be treated as invisible
2656 and should have an ellipsis. */
2658 #define EXTENT_PROP_MEANS_INVISIBLE_WITH_ELLIPSIS(buf, prop) \
2659 (EQ (buf->invisibility_spec, Qt) \
2661 : invisible_ellipsis_p (prop, buf->invisibility_spec))
2663 /* This is like a combination of memq and assq.
2664 Return 1 if PROPVAL appears as an element of LIST
2665 or as the car of an element of LIST.
2666 If PROPVAL is a list, compare each element against LIST
2667 in that way, and return 1 if any element of PROPVAL is found in LIST.
2669 This function cannot quit. */
2672 invisible_p (REGISTER Lisp_Object propval, Lisp_Object list)
2674 REGISTER Lisp_Object tail, proptail;
2675 for (tail = list; CONSP (tail); tail = XCDR (tail))
2677 REGISTER Lisp_Object tem;
2679 if (EQ (propval, tem))
2681 if (CONSP (tem) && EQ (propval, XCAR (tem)))
2684 if (CONSP (propval))
2685 for (proptail = propval; CONSP (proptail);
2686 proptail = XCDR (proptail))
2688 Lisp_Object propelt;
2689 propelt = XCAR (proptail);
2690 for (tail = list; CONSP (tail); tail = XCDR (tail))
2692 REGISTER Lisp_Object tem;
2694 if (EQ (propelt, tem))
2696 if (CONSP (tem) && EQ (propelt, XCAR (tem)))
2703 /* Return 1 if PROPVAL appears as the car of an element of LIST
2704 and the cdr of that element is non-nil.
2705 If PROPVAL is a list, check each element of PROPVAL in that way,
2706 and the first time some element is found,
2707 return 1 if the cdr of that element is non-nil.
2709 This function cannot quit. */
2712 invisible_ellipsis_p (REGISTER Lisp_Object propval, Lisp_Object list)
2714 REGISTER Lisp_Object tail, proptail;
2715 for (tail = list; CONSP (tail); tail = XCDR (tail))
2717 REGISTER Lisp_Object tem;
2719 if (CONSP (tem) && EQ (propval, XCAR (tem)))
2720 return ! NILP (XCDR (tem));
2722 if (CONSP (propval))
2723 for (proptail = propval; CONSP (proptail);
2724 proptail = XCDR (proptail))
2726 Lisp_Object propelt;
2727 propelt = XCAR (proptail);
2728 for (tail = list; CONSP (tail); tail = XCDR (tail))
2730 REGISTER Lisp_Object tem;
2732 if (CONSP (tem) && EQ (propelt, XCAR (tem)))
2733 return ! NILP (XCDR (tem));
2740 extent_fragment_update (struct window *w, struct extent_fragment *ef,
2745 buffer_or_string_stack_of_extents_force (ef->object)->extents;
2747 struct extent dummy_lhe_extent;
2748 Memind mempos = buffer_or_string_bytind_to_memind (ef->object, pos);
2750 #ifdef ERROR_CHECK_EXTENTS
2751 assert (pos >= buffer_or_string_accessible_begin_byte (ef->object)
2752 && pos <= buffer_or_string_accessible_end_byte (ef->object));
2755 Dynarr_reset (ef->extents);
2756 Dynarr_reset (ef->begin_glyphs);
2757 Dynarr_reset (ef->end_glyphs);
2759 ef->previously_invisible = ef->invisible;
2762 if (ef->invisible_ellipses)
2763 ef->invisible_ellipses_already_displayed = 1;
2766 ef->invisible_ellipses_already_displayed = 0;
2768 ef->invisible_ellipses = 0;
2770 /* Set up the begin and end positions. */
2772 ef->end = extent_find_end_of_run (ef->object, pos, 0);
2774 /* Note that extent_find_end_of_run() already moved the SOE for us. */
2775 /* soe_move (ef->object, mempos); */
2777 /* Determine the begin glyphs at POS. */
2778 for (i = 0; i < extent_list_num_els (sel); i++)
2780 EXTENT e = extent_list_at (sel, i, 0);
2781 if (extent_start (e) == mempos && !NILP (extent_begin_glyph (e)))
2783 Lisp_Object glyph = extent_begin_glyph (e);
2784 struct glyph_block gb;
2787 XSETEXTENT (gb.extent, e);
2788 Dynarr_add (ef->begin_glyphs, gb);
2792 /* Determine the end glyphs at POS. */
2793 for (i = 0; i < extent_list_num_els (sel); i++)
2795 EXTENT e = extent_list_at (sel, i, 1);
2796 if (extent_end (e) == mempos && !NILP (extent_end_glyph (e)))
2798 Lisp_Object glyph = extent_end_glyph (e);
2799 struct glyph_block gb;
2802 XSETEXTENT (gb.extent, e);
2803 Dynarr_add (ef->end_glyphs, gb);
2807 /* We tried determining all the charsets used in the run here,
2808 but that fails even if we only do the current line -- display
2809 tables or non-printable characters might cause other charsets
2812 /* Determine whether the last-highlighted-extent is present. */
2813 if (EXTENTP (Vlast_highlighted_extent))
2814 lhe = XEXTENT (Vlast_highlighted_extent);
2816 /* Now add all extents that overlap the character after POS and
2817 have a non-nil face. Also check if the character is invisible. */
2818 for (i = 0; i < extent_list_num_els (sel); i++)
2820 EXTENT e = extent_list_at (sel, i, 0);
2821 if (extent_end (e) > mempos)
2823 Lisp_Object invis_prop = extent_invisible (e);
2825 if (!NILP (invis_prop))
2827 if (!BUFFERP (ef->object))
2828 /* #### no `string-invisibility-spec' */
2832 if (!ef->invisible_ellipses_already_displayed &&
2833 EXTENT_PROP_MEANS_INVISIBLE_WITH_ELLIPSIS
2834 (XBUFFER (ef->object), invis_prop))
2837 ef->invisible_ellipses = 1;
2839 else if (EXTENT_PROP_MEANS_INVISIBLE
2840 (XBUFFER (ef->object), invis_prop))
2845 /* Remember that one of the extents in the list might be our
2846 dummy extent representing the highlighting that is
2847 attached to some other extent that is currently
2848 mouse-highlighted. When an extent is mouse-highlighted,
2849 it is as if there are two extents there, of potentially
2850 different priorities: the extent being highlighted, with
2851 whatever face and priority it has; and an ephemeral
2852 extent in the `mouse-face' face with
2853 `mouse-highlight-priority'.
2856 if (!NILP (extent_face (e)))
2857 Dynarr_add (ef->extents, e);
2861 /* zeroing isn't really necessary; we only deref `priority'
2863 xzero (dummy_lhe_extent);
2864 set_extent_priority (&dummy_lhe_extent,
2865 mouse_highlight_priority);
2866 /* Need to break up the following expression, due to an */
2867 /* error in the Digital UNIX 3.2g C compiler (Digital */
2868 /* UNIX Compiler Driver 3.11). */
2869 f = extent_mouse_face (lhe);
2870 extent_face (&dummy_lhe_extent) = f;
2871 Dynarr_add (ef->extents, &dummy_lhe_extent);
2873 /* since we are looping anyway, we might as well do this here */
2874 if ((!NILP(extent_initial_redisplay_function (e))) &&
2875 !extent_in_red_event_p(e))
2877 Lisp_Object function = extent_initial_redisplay_function (e);
2880 /* printf ("initial redisplay function called!\n "); */
2882 /* print_extent_2 (e);
2885 /* FIXME: One should probably inhibit the displaying of
2886 this extent to reduce flicker */
2887 extent_in_red_event_p(e) = 1;
2889 /* call the function */
2892 Fenqueue_eval_event(function,obj);
2897 extent_fragment_sort_by_priority (ef->extents);
2899 /* Now merge the faces together into a single face. The code to
2900 do this is in faces.c because it involves manipulating faces. */
2901 return get_extent_fragment_face_cache_index (w, ef);
2905 /************************************************************************/
2906 /* extent-object methods */
2907 /************************************************************************/
2909 /* These are the basic helper functions for handling the allocation of
2910 extent objects. They are similar to the functions for other
2911 lrecord objects. allocate_extent() is in alloc.c, not here. */
2913 static Lisp_Object mark_extent (Lisp_Object);
2914 static int extent_equal (Lisp_Object, Lisp_Object, int depth);
2915 static unsigned long extent_hash (Lisp_Object obj, int depth);
2916 static void print_extent (Lisp_Object obj, Lisp_Object printcharfun,
2918 static Lisp_Object extent_getprop (Lisp_Object obj, Lisp_Object prop);
2919 static int extent_putprop (Lisp_Object obj, Lisp_Object prop,
2921 static int extent_remprop (Lisp_Object obj, Lisp_Object prop);
2922 static Lisp_Object extent_plist (Lisp_Object obj);
2924 static const struct lrecord_description extent_description[] = {
2925 { XD_LISP_OBJECT, offsetof(struct extent, object), 2 },
2926 { XD_LISP_OBJECT, offsetof(struct extent, plist), 1 },
2930 DEFINE_BASIC_LRECORD_IMPLEMENTATION_WITH_PROPS ("extent", extent,
2933 /* NOTE: If you declare a
2934 finalization method here,
2935 it will NOT be called.
2938 extent_equal, extent_hash,
2940 extent_getprop, extent_putprop,
2941 extent_remprop, extent_plist,
2945 mark_extent (Lisp_Object obj)
2947 struct extent *extent = XEXTENT (obj);
2949 mark_object (extent_object (extent));
2950 mark_object (extent_no_chase_normal_field (extent, face));
2951 return extent->plist;
2955 print_extent_1 (Lisp_Object obj, Lisp_Object printcharfun, int escapeflag)
2957 EXTENT ext = XEXTENT (obj);
2958 EXTENT anc = extent_ancestor (ext);
2960 char buf[64], *bp = buf;
2962 /* Retrieve the ancestor and use it, for faster retrieval of properties */
2964 if (!NILP (extent_begin_glyph (anc))) *bp++ = '*';
2965 *bp++ = (extent_start_open_p (anc) ? '(': '[');
2966 if (extent_detached_p (ext))
2967 strcpy (bp, "detached");
2969 sprintf (bp, "%ld, %ld",
2970 (long) XINT (Fextent_start_position (obj)),
2971 (long) XINT (Fextent_end_position (obj)));
2973 *bp++ = (extent_end_open_p (anc) ? ')': ']');
2974 if (!NILP (extent_end_glyph (anc))) *bp++ = '*';
2977 if (!NILP (extent_read_only (anc))) *bp++ = '%';
2978 if (!NILP (extent_mouse_face (anc))) *bp++ = 'H';
2979 if (extent_unique_p (anc)) *bp++ = 'U';
2980 else if (extent_duplicable_p (anc)) *bp++ = 'D';
2981 if (!NILP (extent_invisible (anc))) *bp++ = 'I';
2983 if (!NILP (extent_read_only (anc)) || !NILP (extent_mouse_face (anc)) ||
2984 extent_unique_p (anc) ||
2985 extent_duplicable_p (anc) || !NILP (extent_invisible (anc)))
2988 write_c_string (buf, printcharfun);
2990 tail = extent_plist_slot (anc);
2992 for (; !NILP (tail); tail = Fcdr (Fcdr (tail)))
2994 Lisp_Object v = XCAR (XCDR (tail));
2995 if (NILP (v)) continue;
2996 print_internal (XCAR (tail), printcharfun, escapeflag);
2997 write_c_string (" ", printcharfun);
3000 sprintf (buf, "0x%lx", (long) ext);
3001 write_c_string (buf, printcharfun);
3005 print_extent (Lisp_Object obj, Lisp_Object printcharfun, int escapeflag)
3009 CONST char *title = "";
3010 CONST char *name = "";
3011 CONST char *posttitle = "";
3012 Lisp_Object obj2 = Qnil;
3014 /* Destroyed extents have 't' in the object field, causing
3015 extent_object() to abort (maybe). */
3016 if (EXTENT_LIVE_P (XEXTENT (obj)))
3017 obj2 = extent_object (XEXTENT (obj));
3020 title = "no buffer";
3021 else if (BUFFERP (obj2))
3023 if (BUFFER_LIVE_P (XBUFFER (obj2)))
3026 name = (char *) XSTRING_DATA (XBUFFER (obj2)->name);
3030 title = "Killed Buffer";
3036 assert (STRINGP (obj2));
3037 title = "string \"";
3039 name = (char *) XSTRING_DATA (obj2);
3044 if (!EXTENT_LIVE_P (XEXTENT (obj)))
3045 error ("printing unreadable object #<destroyed extent>");
3047 error ("printing unreadable object #<extent 0x%lx>",
3048 (long) XEXTENT (obj));
3051 if (!EXTENT_LIVE_P (XEXTENT (obj)))
3052 write_c_string ("#<destroyed extent", printcharfun);
3055 char *buf = (char *)
3056 alloca (strlen (title) + strlen (name) + strlen (posttitle) + 1);
3057 write_c_string ("#<extent ", printcharfun);
3058 print_extent_1 (obj, printcharfun, escapeflag);
3059 write_c_string (extent_detached_p (XEXTENT (obj))
3060 ? " from " : " in ", printcharfun);
3061 sprintf (buf, "%s%s%s", title, name, posttitle);
3062 write_c_string (buf, printcharfun);
3068 error ("printing unreadable object #<extent>");
3069 write_c_string ("#<extent", printcharfun);
3071 write_c_string (">", printcharfun);
3075 properties_equal (EXTENT e1, EXTENT e2, int depth)
3077 /* When this function is called, all indirections have been followed.
3078 Thus, the indirection checks in the various macros below will not
3079 amount to anything, and could be removed. However, the time
3080 savings would probably not be significant. */
3081 if (!(EQ (extent_face (e1), extent_face (e2)) &&
3082 extent_priority (e1) == extent_priority (e2) &&
3083 internal_equal (extent_begin_glyph (e1), extent_begin_glyph (e2),
3085 internal_equal (extent_end_glyph (e1), extent_end_glyph (e2),
3089 /* compare the bit flags. */
3091 /* The has_aux field should not be relevant. */
3092 int e1_has_aux = e1->flags.has_aux;
3093 int e2_has_aux = e2->flags.has_aux;
3096 e1->flags.has_aux = e2->flags.has_aux = 0;
3097 value = memcmp (&e1->flags, &e2->flags, sizeof (e1->flags));
3098 e1->flags.has_aux = e1_has_aux;
3099 e2->flags.has_aux = e2_has_aux;
3104 /* compare the random elements of the plists. */
3105 return !plists_differ (extent_no_chase_plist (e1),
3106 extent_no_chase_plist (e2),
3111 extent_equal (Lisp_Object obj1, Lisp_Object obj2, int depth)
3113 struct extent *e1 = XEXTENT (obj1);
3114 struct extent *e2 = XEXTENT (obj2);
3116 (extent_start (e1) == extent_start (e2) &&
3117 extent_end (e1) == extent_end (e2) &&
3118 internal_equal (extent_object (e1), extent_object (e2), depth + 1) &&
3119 properties_equal (extent_ancestor (e1), extent_ancestor (e2),
3123 static unsigned long
3124 extent_hash (Lisp_Object obj, int depth)
3126 struct extent *e = XEXTENT (obj);
3127 /* No need to hash all of the elements; that would take too long.
3128 Just hash the most common ones. */
3129 return HASH3 (extent_start (e), extent_end (e),
3130 internal_hash (extent_object (e), depth + 1));
3134 extent_getprop (Lisp_Object obj, Lisp_Object prop)
3136 return Fextent_property (obj, prop, Qunbound);
3140 extent_putprop (Lisp_Object obj, Lisp_Object prop, Lisp_Object value)
3142 Fset_extent_property (obj, prop, value);
3147 extent_remprop (Lisp_Object obj, Lisp_Object prop)
3149 EXTENT ext = XEXTENT (obj);
3151 /* This list is taken from Fset_extent_property, and should be kept
3153 if (EQ (prop, Qread_only)
3154 || EQ (prop, Qunique)
3155 || EQ (prop, Qduplicable)
3156 || EQ (prop, Qinvisible)
3157 || EQ (prop, Qdetachable)
3158 || EQ (prop, Qdetached)
3159 || EQ (prop, Qdestroyed)
3160 || EQ (prop, Qpriority)
3162 || EQ (prop, Qinitial_redisplay_function)
3163 || EQ (prop, Qafter_change_functions)
3164 || EQ (prop, Qbefore_change_functions)
3165 || EQ (prop, Qmouse_face)
3166 || EQ (prop, Qhighlight)
3167 || EQ (prop, Qbegin_glyph_layout)
3168 || EQ (prop, Qend_glyph_layout)
3169 || EQ (prop, Qglyph_layout)
3170 || EQ (prop, Qbegin_glyph)
3171 || EQ (prop, Qend_glyph)
3172 || EQ (prop, Qstart_open)
3173 || EQ (prop, Qend_open)
3174 || EQ (prop, Qstart_closed)
3175 || EQ (prop, Qend_closed)
3176 || EQ (prop, Qkeymap))
3178 /* #### Is this correct, anyway? */
3182 return external_remprop (extent_plist_addr (ext), prop, 0, ERROR_ME);
3186 extent_plist (Lisp_Object obj)
3188 return Fextent_properties (obj);
3192 /************************************************************************/
3193 /* basic extent accessors */
3194 /************************************************************************/
3196 /* These functions are for checking externally-passed extent objects
3197 and returning an extent's basic properties, which include the
3198 buffer the extent is associated with, the endpoints of the extent's
3199 range, the open/closed-ness of those endpoints, and whether the
3200 extent is detached. Manipulating these properties requires
3201 manipulating the ordered lists that hold extents; thus, functions
3202 to do that are in a later section. */
3204 /* Given a Lisp_Object that is supposed to be an extent, make sure it
3205 is OK and return an extent pointer. Extents can be in one of four
3209 2) detached and not associated with a buffer
3210 3) detached and associated with a buffer
3211 4) attached to a buffer
3213 If FLAGS is 0, types 2-4 are allowed. If FLAGS is DE_MUST_HAVE_BUFFER,
3214 types 3-4 are allowed. If FLAGS is DE_MUST_BE_ATTACHED, only type 4
3219 decode_extent (Lisp_Object extent_obj, unsigned int flags)
3224 CHECK_LIVE_EXTENT (extent_obj);
3225 extent = XEXTENT (extent_obj);
3226 obj = extent_object (extent);
3228 /* the following condition will fail if we're dealing with a freed extent */
3229 assert (NILP (obj) || BUFFERP (obj) || STRINGP (obj));
3231 if (flags & DE_MUST_BE_ATTACHED)
3232 flags |= DE_MUST_HAVE_BUFFER;
3234 /* if buffer is dead, then convert extent to have no buffer. */
3235 if (BUFFERP (obj) && !BUFFER_LIVE_P (XBUFFER (obj)))
3236 obj = extent_object (extent) = Qnil;
3238 assert (!NILP (obj) || extent_detached_p (extent));
3240 if ((NILP (obj) && (flags & DE_MUST_HAVE_BUFFER))
3241 || (extent_detached_p (extent) && (flags & DE_MUST_BE_ATTACHED)))
3243 signal_simple_error ("extent doesn't belong to a buffer or string",
3250 /* Note that the returned value is a buffer position, not a byte index. */
3253 extent_endpoint_external (Lisp_Object extent_obj, int endp)
3255 EXTENT extent = decode_extent (extent_obj, 0);
3257 if (extent_detached_p (extent))
3260 return make_int (extent_endpoint_bufpos (extent, endp));
3263 DEFUN ("extentp", Fextentp, 1, 1, 0, /*
3264 Return t if OBJECT is an extent.
3268 return EXTENTP (object) ? Qt : Qnil;
3271 DEFUN ("extent-live-p", Fextent_live_p, 1, 1, 0, /*
3272 Return t if OBJECT is an extent that has not been destroyed.
3276 return EXTENTP (object) && EXTENT_LIVE_P (XEXTENT (object)) ? Qt : Qnil;
3279 DEFUN ("extent-detached-p", Fextent_detached_p, 1, 1, 0, /*
3280 Return t if EXTENT is detached.
3284 return extent_detached_p (decode_extent (extent, 0)) ? Qt : Qnil;
3287 DEFUN ("extent-object", Fextent_object, 1, 1, 0, /*
3288 Return object (buffer or string) that EXTENT refers to.
3292 return extent_object (decode_extent (extent, 0));
3295 DEFUN ("extent-start-position", Fextent_start_position, 1, 1, 0, /*
3296 Return start position of EXTENT, or nil if EXTENT is detached.
3300 return extent_endpoint_external (extent, 0);
3303 DEFUN ("extent-end-position", Fextent_end_position, 1, 1, 0, /*
3304 Return end position of EXTENT, or nil if EXTENT is detached.
3308 return extent_endpoint_external (extent, 1);
3311 DEFUN ("extent-length", Fextent_length, 1, 1, 0, /*
3312 Return length of EXTENT in characters.
3316 EXTENT e = decode_extent (extent, DE_MUST_BE_ATTACHED);
3317 return make_int (extent_endpoint_bufpos (e, 1)
3318 - extent_endpoint_bufpos (e, 0));
3321 DEFUN ("next-extent", Fnext_extent, 1, 1, 0, /*
3322 Find next extent after EXTENT.
3323 If EXTENT is a buffer return the first extent in the buffer; likewise
3325 Extents in a buffer are ordered in what is called the "display"
3326 order, which sorts by increasing start positions and then by *decreasing*
3328 If you want to perform an operation on a series of extents, use
3329 `map-extents' instead of this function; it is much more efficient.
3330 The primary use of this function should be to enumerate all the
3331 extents in a buffer.
3332 Note: The display order is not necessarily the order that `map-extents'
3333 processes extents in!
3340 if (EXTENTP (extent))
3341 next = extent_next (decode_extent (extent, DE_MUST_BE_ATTACHED));
3343 next = extent_first (decode_buffer_or_string (extent));
3347 XSETEXTENT (val, next);
3351 DEFUN ("previous-extent", Fprevious_extent, 1, 1, 0, /*
3352 Find last extent before EXTENT.
3353 If EXTENT is a buffer return the last extent in the buffer; likewise
3355 This function is analogous to `next-extent'.
3362 if (EXTENTP (extent))
3363 prev = extent_previous (decode_extent (extent, DE_MUST_BE_ATTACHED));
3365 prev = extent_last (decode_buffer_or_string (extent));
3369 XSETEXTENT (val, prev);
3375 DEFUN ("next-e-extent", Fnext_e_extent, 1, 1, 0, /*
3376 Find next extent after EXTENT using the "e" order.
3377 If EXTENT is a buffer return the first extent in the buffer; likewise
3385 if (EXTENTP (extent))
3386 next = extent_e_next (decode_extent (extent, DE_MUST_BE_ATTACHED));
3388 next = extent_e_first (decode_buffer_or_string (extent));
3392 XSETEXTENT (val, next);
3396 DEFUN ("previous-e-extent", Fprevious_e_extent, 1, 1, 0, /*
3397 Find last extent before EXTENT using the "e" order.
3398 If EXTENT is a buffer return the last extent in the buffer; likewise
3400 This function is analogous to `next-e-extent'.
3407 if (EXTENTP (extent))
3408 prev = extent_e_previous (decode_extent (extent, DE_MUST_BE_ATTACHED));
3410 prev = extent_e_last (decode_buffer_or_string (extent));
3414 XSETEXTENT (val, prev);
3420 DEFUN ("next-extent-change", Fnext_extent_change, 1, 2, 0, /*
3421 Return the next position after POS where an extent begins or ends.
3422 If POS is at the end of the buffer or string, POS will be returned;
3423 otherwise a position greater than POS will always be returned.
3424 If BUFFER is nil, the current buffer is assumed.
3428 Lisp_Object obj = decode_buffer_or_string (object);
3431 bpos = get_buffer_or_string_pos_byte (obj, pos, GB_ALLOW_PAST_ACCESSIBLE);
3432 bpos = extent_find_end_of_run (obj, bpos, 1);
3433 return make_int (buffer_or_string_bytind_to_bufpos (obj, bpos));
3436 DEFUN ("previous-extent-change", Fprevious_extent_change, 1, 2, 0, /*
3437 Return the last position before POS where an extent begins or ends.
3438 If POS is at the beginning of the buffer or string, POS will be returned;
3439 otherwise a position less than POS will always be returned.
3440 If OBJECT is nil, the current buffer is assumed.
3444 Lisp_Object obj = decode_buffer_or_string (object);
3447 bpos = get_buffer_or_string_pos_byte (obj, pos, GB_ALLOW_PAST_ACCESSIBLE);
3448 bpos = extent_find_beginning_of_run (obj, bpos, 1);
3449 return make_int (buffer_or_string_bytind_to_bufpos (obj, bpos));
3453 /************************************************************************/
3454 /* parent and children stuff */
3455 /************************************************************************/
3457 DEFUN ("extent-parent", Fextent_parent, 1, 1, 0, /*
3458 Return the parent (if any) of EXTENT.
3459 If an extent has a parent, it derives all its properties from that extent
3460 and has no properties of its own. (The only "properties" that the
3461 extent keeps are the buffer/string it refers to and the start and end
3462 points.) It is possible for an extent's parent to itself have a parent.
3465 /* do I win the prize for the strangest split infinitive? */
3467 EXTENT e = decode_extent (extent, 0);
3468 return extent_parent (e);
3471 DEFUN ("extent-children", Fextent_children, 1, 1, 0, /*
3472 Return a list of the children (if any) of EXTENT.
3473 The children of an extent are all those extents whose parent is that extent.
3474 This function does not recursively trace children of children.
3475 \(To do that, use `extent-descendants'.)
3479 EXTENT e = decode_extent (extent, 0);
3480 Lisp_Object children = extent_children (e);
3482 if (!NILP (children))
3483 return Fcopy_sequence (XWEAK_LIST_LIST (children));
3489 remove_extent_from_children_list (EXTENT e, Lisp_Object child)
3491 Lisp_Object children = extent_children (e);
3493 #ifdef ERROR_CHECK_EXTENTS
3494 assert (!NILP (memq_no_quit (child, XWEAK_LIST_LIST (children))));
3496 XWEAK_LIST_LIST (children) =
3497 delq_no_quit (child, XWEAK_LIST_LIST (children));
3501 add_extent_to_children_list (EXTENT e, Lisp_Object child)
3503 Lisp_Object children = extent_children (e);
3505 if (NILP (children))
3507 children = make_weak_list (WEAK_LIST_SIMPLE);
3508 set_extent_no_chase_aux_field (e, children, children);
3511 #ifdef ERROR_CHECK_EXTENTS
3512 assert (NILP (memq_no_quit (child, XWEAK_LIST_LIST (children))));
3514 XWEAK_LIST_LIST (children) = Fcons (child, XWEAK_LIST_LIST (children));
3517 DEFUN ("set-extent-parent", Fset_extent_parent, 2, 2, 0, /*
3518 Set the parent of EXTENT to PARENT (may be nil).
3519 See `extent-parent'.
3523 EXTENT e = decode_extent (extent, 0);
3524 Lisp_Object cur_parent = extent_parent (e);
3527 XSETEXTENT (extent, e);
3529 CHECK_LIVE_EXTENT (parent);
3530 if (EQ (parent, cur_parent))
3532 for (rest = parent; !NILP (rest); rest = extent_parent (XEXTENT (rest)))
3533 if (EQ (rest, extent))
3534 signal_simple_error ("Circular parent chain would result", extent);
3537 remove_extent_from_children_list (XEXTENT (cur_parent), extent);
3538 set_extent_no_chase_aux_field (e, parent, Qnil);
3539 e->flags.has_parent = 0;
3543 add_extent_to_children_list (XEXTENT (parent), extent);
3544 set_extent_no_chase_aux_field (e, parent, parent);
3545 e->flags.has_parent = 1;
3547 /* changing the parent also changes the properties of all children. */
3549 int old_invis = (!NILP (cur_parent) &&
3550 !NILP (extent_invisible (XEXTENT (cur_parent))));
3551 int new_invis = (!NILP (parent) &&
3552 !NILP (extent_invisible (XEXTENT (parent))));
3554 extent_maybe_changed_for_redisplay (e, 1, new_invis != old_invis);
3561 /************************************************************************/
3562 /* basic extent mutators */
3563 /************************************************************************/
3565 /* Note: If you track non-duplicable extents by undo, you'll get bogus
3566 undo records for transient extents via update-extent.
3567 For example, query-replace will do this.
3571 set_extent_endpoints_1 (EXTENT extent, Memind start, Memind end)
3573 #ifdef ERROR_CHECK_EXTENTS
3574 Lisp_Object obj = extent_object (extent);
3576 assert (start <= end);
3579 assert (valid_memind_p (XBUFFER (obj), start));
3580 assert (valid_memind_p (XBUFFER (obj), end));
3584 /* Optimization: if the extent is already where we want it to be,
3586 if (!extent_detached_p (extent) && extent_start (extent) == start &&
3587 extent_end (extent) == end)
3590 if (extent_detached_p (extent))
3592 if (extent_duplicable_p (extent))
3594 Lisp_Object extent_obj;
3595 XSETEXTENT (extent_obj, extent);
3596 record_extent (extent_obj, 1);
3600 extent_detach (extent);
3602 set_extent_start (extent, start);
3603 set_extent_end (extent, end);
3604 extent_attach (extent);
3607 /* Set extent's endpoints to S and E, and put extent in buffer or string
3608 OBJECT. (If OBJECT is nil, do not change the extent's object.) */
3611 set_extent_endpoints (EXTENT extent, Bytind s, Bytind e, Lisp_Object object)
3617 object = extent_object (extent);
3618 assert (!NILP (object));
3620 else if (!EQ (object, extent_object (extent)))
3622 extent_detach (extent);
3623 extent_object (extent) = object;
3626 start = s < 0 ? extent_start (extent) :
3627 buffer_or_string_bytind_to_memind (object, s);
3628 end = e < 0 ? extent_end (extent) :
3629 buffer_or_string_bytind_to_memind (object, e);
3630 set_extent_endpoints_1 (extent, start, end);
3634 set_extent_openness (EXTENT extent, int start_open, int end_open)
3636 if (start_open != -1)
3637 extent_start_open_p (extent) = start_open;
3639 extent_end_open_p (extent) = end_open;
3640 /* changing the open/closedness of an extent does not affect
3645 make_extent_internal (Lisp_Object object, Bytind from, Bytind to)
3649 extent = make_extent_detached (object);
3650 set_extent_endpoints (extent, from, to, Qnil);
3655 copy_extent (EXTENT original, Bytind from, Bytind to, Lisp_Object object)
3659 e = make_extent_detached (object);
3661 set_extent_endpoints (e, from, to, Qnil);
3663 e->plist = Fcopy_sequence (original->plist);
3664 memcpy (&e->flags, &original->flags, sizeof (e->flags));
3665 if (e->flags.has_aux)
3667 /* also need to copy the aux struct. It won't work for
3668 this extent to share the same aux struct as the original
3670 struct extent_auxiliary *data =
3671 alloc_lcrecord_type (struct extent_auxiliary,
3672 &lrecord_extent_auxiliary);
3674 copy_lcrecord (data, XEXTENT_AUXILIARY (XCAR (original->plist)));
3675 XSETEXTENT_AUXILIARY (XCAR (e->plist), data);
3679 /* we may have just added another child to the parent extent. */
3680 Lisp_Object parent = extent_parent (e);
3684 XSETEXTENT (extent, e);
3685 add_extent_to_children_list (XEXTENT (parent), extent);
3693 destroy_extent (EXTENT extent)
3695 Lisp_Object rest, nextrest, children;
3696 Lisp_Object extent_obj;
3698 if (!extent_detached_p (extent))
3699 extent_detach (extent);
3700 /* disassociate the extent from its children and parent */
3701 children = extent_children (extent);
3702 if (!NILP (children))
3704 LIST_LOOP_DELETING (rest, nextrest, XWEAK_LIST_LIST (children))
3705 Fset_extent_parent (XCAR (rest), Qnil);
3707 XSETEXTENT (extent_obj, extent);
3708 Fset_extent_parent (extent_obj, Qnil);
3709 /* mark the extent as destroyed */
3710 extent_object (extent) = Qt;
3713 DEFUN ("make-extent", Fmake_extent, 2, 3, 0, /*
3714 Make an extent for the range [FROM, TO) in BUFFER-OR-STRING.
3715 BUFFER-OR-STRING defaults to the current buffer. Insertions at point
3716 TO will be outside of the extent; insertions at FROM will be inside the
3717 extent, causing the extent to grow. (This is the same way that markers
3718 behave.) You can change the behavior of insertions at the endpoints
3719 using `set-extent-property'. The extent is initially detached if both
3720 FROM and TO are nil, and in this case BUFFER-OR-STRING defaults to nil,
3721 meaning the extent is in no buffer and no string.
3723 (from, to, buffer_or_string))
3725 Lisp_Object extent_obj;
3728 obj = decode_buffer_or_string (buffer_or_string);
3729 if (NILP (from) && NILP (to))
3731 if (NILP (buffer_or_string))
3733 XSETEXTENT (extent_obj, make_extent_detached (obj));
3739 get_buffer_or_string_range_byte (obj, from, to, &start, &end,
3740 GB_ALLOW_PAST_ACCESSIBLE);
3741 XSETEXTENT (extent_obj, make_extent_internal (obj, start, end));
3746 DEFUN ("copy-extent", Fcopy_extent, 1, 2, 0, /*
3747 Make a copy of EXTENT. It is initially detached.
3748 Optional argument BUFFER-OR-STRING defaults to EXTENT's buffer or string.
3750 (extent, buffer_or_string))
3752 EXTENT ext = decode_extent (extent, 0);
3754 if (NILP (buffer_or_string))
3755 buffer_or_string = extent_object (ext);
3757 buffer_or_string = decode_buffer_or_string (buffer_or_string);
3759 XSETEXTENT (extent, copy_extent (ext, -1, -1, buffer_or_string));
3763 DEFUN ("delete-extent", Fdelete_extent, 1, 1, 0, /*
3764 Remove EXTENT from its buffer and destroy it.
3765 This does not modify the buffer's text, only its display properties.
3766 The extent cannot be used thereafter.
3772 /* We do not call decode_extent() here because already-destroyed
3774 CHECK_EXTENT (extent);
3775 ext = XEXTENT (extent);
3777 if (!EXTENT_LIVE_P (ext))
3779 destroy_extent (ext);
3783 DEFUN ("detach-extent", Fdetach_extent, 1, 1, 0, /*
3784 Remove EXTENT from its buffer in such a way that it can be re-inserted.
3785 An extent is also detached when all of its characters are all killed by a
3786 deletion, unless its `detachable' property has been unset.
3788 Extents which have the `duplicable' attribute are tracked by the undo
3789 mechanism. Detachment via `detach-extent' and string deletion is recorded,
3790 as is attachment via `insert-extent' and string insertion. Extent motion,
3791 face changes, and attachment via `make-extent' and `set-extent-endpoints'
3792 are not recorded. This means that extent changes which are to be undo-able
3793 must be performed by character editing, or by insertion and detachment of
3798 EXTENT ext = decode_extent (extent, 0);
3800 if (extent_detached_p (ext))
3802 if (extent_duplicable_p (ext))
3803 record_extent (extent, 0);
3804 extent_detach (ext);
3809 DEFUN ("set-extent-endpoints", Fset_extent_endpoints, 3, 4, 0, /*
3810 Set the endpoints of EXTENT to START, END.
3811 If START and END are null, call detach-extent on EXTENT.
3812 BUFFER-OR-STRING specifies the new buffer or string that the extent should
3813 be in, and defaults to EXTENT's buffer or string. (If nil, and EXTENT
3814 is in no buffer and no string, it defaults to the current buffer.)
3815 See documentation on `detach-extent' for a discussion of undo recording.
3817 (extent, start, end, buffer_or_string))
3822 ext = decode_extent (extent, 0);
3824 if (NILP (buffer_or_string))
3826 buffer_or_string = extent_object (ext);
3827 if (NILP (buffer_or_string))
3828 buffer_or_string = Fcurrent_buffer ();
3831 buffer_or_string = decode_buffer_or_string (buffer_or_string);
3833 if (NILP (start) && NILP (end))
3834 return Fdetach_extent (extent);
3836 get_buffer_or_string_range_byte (buffer_or_string, start, end, &s, &e,
3837 GB_ALLOW_PAST_ACCESSIBLE);
3839 set_extent_endpoints (ext, s, e, buffer_or_string);
3844 /************************************************************************/
3845 /* mapping over extents */
3846 /************************************************************************/
3849 decode_map_extents_flags (Lisp_Object flags)
3851 unsigned int retval = 0;
3852 unsigned int all_extents_specified = 0;
3853 unsigned int in_region_specified = 0;
3855 if (EQ (flags, Qt)) /* obsoleteness compatibility */
3856 return ME_END_CLOSED;
3859 if (SYMBOLP (flags))
3860 flags = Fcons (flags, Qnil);
3861 while (!NILP (flags))
3867 if (EQ (sym, Qall_extents_closed) || EQ (sym, Qall_extents_open) ||
3868 EQ (sym, Qall_extents_closed_open) ||
3869 EQ (sym, Qall_extents_open_closed))
3871 if (all_extents_specified)
3872 error ("Only one `all-extents-*' flag may be specified");
3873 all_extents_specified = 1;
3875 if (EQ (sym, Qstart_in_region) || EQ (sym, Qend_in_region) ||
3876 EQ (sym, Qstart_and_end_in_region) ||
3877 EQ (sym, Qstart_or_end_in_region))
3879 if (in_region_specified)
3880 error ("Only one `*-in-region' flag may be specified");
3881 in_region_specified = 1;
3884 /* I do so love that conditional operator ... */
3886 EQ (sym, Qend_closed) ? ME_END_CLOSED :
3887 EQ (sym, Qstart_open) ? ME_START_OPEN :
3888 EQ (sym, Qall_extents_closed) ? ME_ALL_EXTENTS_CLOSED :
3889 EQ (sym, Qall_extents_open) ? ME_ALL_EXTENTS_OPEN :
3890 EQ (sym, Qall_extents_closed_open) ? ME_ALL_EXTENTS_CLOSED_OPEN :
3891 EQ (sym, Qall_extents_open_closed) ? ME_ALL_EXTENTS_OPEN_CLOSED :
3892 EQ (sym, Qstart_in_region) ? ME_START_IN_REGION :
3893 EQ (sym, Qend_in_region) ? ME_END_IN_REGION :
3894 EQ (sym, Qstart_and_end_in_region) ? ME_START_AND_END_IN_REGION :
3895 EQ (sym, Qstart_or_end_in_region) ? ME_START_OR_END_IN_REGION :
3896 EQ (sym, Qnegate_in_region) ? ME_NEGATE_IN_REGION :
3897 (signal_simple_error ("Invalid `map-extents' flag", sym), 0);
3899 flags = XCDR (flags);
3904 DEFUN ("extent-in-region-p", Fextent_in_region_p, 1, 4, 0, /*
3905 Return whether EXTENT overlaps a specified region.
3906 This is equivalent to whether `map-extents' would visit EXTENT when called
3909 (extent, from, to, flags))
3912 EXTENT ext = decode_extent (extent, DE_MUST_BE_ATTACHED);
3913 Lisp_Object obj = extent_object (ext);
3915 get_buffer_or_string_range_byte (obj, from, to, &start, &end, GB_ALLOW_NIL |
3916 GB_ALLOW_PAST_ACCESSIBLE);
3918 return extent_in_region_p (ext, start, end, decode_map_extents_flags (flags)) ?
3922 struct slow_map_extents_arg
3924 Lisp_Object map_arg;
3925 Lisp_Object map_routine;
3927 Lisp_Object property;
3932 slow_map_extents_function (EXTENT extent, void *arg)
3934 /* This function can GC */
3935 struct slow_map_extents_arg *closure = (struct slow_map_extents_arg *) arg;
3936 Lisp_Object extent_obj;
3938 XSETEXTENT (extent_obj, extent);
3940 /* make sure this extent qualifies according to the PROPERTY
3943 if (!NILP (closure->property))
3945 Lisp_Object value = Fextent_property (extent_obj, closure->property,
3947 if ((NILP (closure->value) && NILP (value)) ||
3948 (!NILP (closure->value) && !EQ (value, closure->value)))
3952 closure->result = call2 (closure->map_routine, extent_obj,
3954 return !NILP (closure->result);
3957 DEFUN ("map-extents", Fmap_extents, 1, 8, 0, /*
3958 Map FUNCTION over the extents which overlap a region in OBJECT.
3959 OBJECT is normally a buffer or string but could be an extent (see below).
3960 The region is normally bounded by [FROM, TO) (i.e. the beginning of the
3961 region is closed and the end of the region is open), but this can be
3962 changed with the FLAGS argument (see below for a complete discussion).
3964 FUNCTION is called with the arguments (extent, MAPARG). The arguments
3965 OBJECT, FROM, TO, MAPARG, and FLAGS are all optional and default to
3966 the current buffer, the beginning of OBJECT, the end of OBJECT, nil,
3967 and nil, respectively. `map-extents' returns the first non-nil result
3968 produced by FUNCTION, and no more calls to FUNCTION are made after it
3971 If OBJECT is an extent, FROM and TO default to the extent's endpoints,
3972 and the mapping omits that extent and its predecessors. This feature
3973 supports restarting a loop based on `map-extents'. Note: OBJECT must
3974 be attached to a buffer or string, and the mapping is done over that
3977 An extent overlaps the region if there is any point in the extent that is
3978 also in the region. (For the purpose of overlap, zero-length extents and
3979 regions are treated as closed on both ends regardless of their endpoints'
3980 specified open/closedness.) Note that the endpoints of an extent or region
3981 are considered to be in that extent or region if and only if the
3982 corresponding end is closed. For example, the extent [5,7] overlaps the
3983 region [2,5] because 5 is in both the extent and the region. However, (5,7]
3984 does not overlap [2,5] because 5 is not in the extent, and neither [5,7] nor
3985 \(5,7] overlaps the region [2,5) because 5 is not in the region.
3987 The optional FLAGS can be a symbol or a list of one or more symbols,
3988 modifying the behavior of `map-extents'. Allowed symbols are:
3990 end-closed The region's end is closed.
3992 start-open The region's start is open.
3994 all-extents-closed Treat all extents as closed on both ends for the
3995 purpose of determining whether they overlap the
3996 region, irrespective of their actual open- or
3998 all-extents-open Treat all extents as open on both ends.
3999 all-extents-closed-open Treat all extents as start-closed, end-open.
4000 all-extents-open-closed Treat all extents as start-open, end-closed.
4002 start-in-region In addition to the above conditions for extent
4003 overlap, the extent's start position must lie within
4004 the specified region. Note that, for this
4005 condition, open start positions are treated as if
4006 0.5 was added to the endpoint's value, and open
4007 end positions are treated as if 0.5 was subtracted
4008 from the endpoint's value.
4009 end-in-region The extent's end position must lie within the
4011 start-and-end-in-region Both the extent's start and end positions must lie
4013 start-or-end-in-region Either the extent's start or end position must lie
4016 negate-in-region The condition specified by a `*-in-region' flag
4017 must NOT hold for the extent to be considered.
4020 At most one of `all-extents-closed', `all-extents-open',
4021 `all-extents-closed-open', and `all-extents-open-closed' may be specified.
4023 At most one of `start-in-region', `end-in-region',
4024 `start-and-end-in-region', and `start-or-end-in-region' may be specified.
4026 If optional arg PROPERTY is non-nil, only extents with that property set
4027 on them will be visited. If optional arg VALUE is non-nil, only extents
4028 whose value for that property is `eq' to VALUE will be visited.
4030 (function, object, from, to, maparg, flags, property, value))
4032 /* This function can GC */
4033 struct slow_map_extents_arg closure;
4034 unsigned int me_flags;
4036 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
4039 if (EXTENTP (object))
4041 after = decode_extent (object, DE_MUST_BE_ATTACHED);
4043 from = Fextent_start_position (object);
4045 to = Fextent_end_position (object);
4046 object = extent_object (after);
4049 object = decode_buffer_or_string (object);
4051 get_buffer_or_string_range_byte (object, from, to, &start, &end,
4052 GB_ALLOW_NIL | GB_ALLOW_PAST_ACCESSIBLE);
4054 me_flags = decode_map_extents_flags (flags);
4056 if (!NILP (property))
4059 value = canonicalize_extent_property (property, value);
4062 GCPRO5 (function, maparg, object, property, value);
4064 closure.map_arg = maparg;
4065 closure.map_routine = function;
4066 closure.result = Qnil;
4067 closure.property = property;
4068 closure.value = value;
4070 map_extents_bytind (start, end, slow_map_extents_function,
4071 (void *) &closure, object, after,
4072 /* You never know what the user might do ... */
4073 me_flags | ME_MIGHT_CALL_ELISP);
4076 return closure.result;
4080 /************************************************************************/
4081 /* mapping over extents -- other functions */
4082 /************************************************************************/
4084 /* ------------------------------- */
4085 /* map-extent-children */
4086 /* ------------------------------- */
4088 struct slow_map_extent_children_arg
4090 Lisp_Object map_arg;
4091 Lisp_Object map_routine;
4093 Lisp_Object property;
4101 slow_map_extent_children_function (EXTENT extent, void *arg)
4103 /* This function can GC */
4104 struct slow_map_extent_children_arg *closure =
4105 (struct slow_map_extent_children_arg *) arg;
4106 Lisp_Object extent_obj;
4107 Bytind start = extent_endpoint_bytind (extent, 0);
4108 Bytind end = extent_endpoint_bytind (extent, 1);
4109 /* Make sure the extent starts inside the region of interest,
4110 rather than just overlaps it.
4112 if (start < closure->start_min)
4114 /* Make sure the extent is not a child of a previous visited one.
4115 We know already, because of extent ordering,
4116 that start >= prev_start, and that if
4117 start == prev_start, then end <= prev_end.
4119 if (start == closure->prev_start)
4121 if (end < closure->prev_end)
4124 else /* start > prev_start */
4126 if (start < closure->prev_end)
4128 /* corner case: prev_end can be -1 if there is no prev */
4130 XSETEXTENT (extent_obj, extent);
4132 /* make sure this extent qualifies according to the PROPERTY
4135 if (!NILP (closure->property))
4137 Lisp_Object value = Fextent_property (extent_obj, closure->property,
4139 if ((NILP (closure->value) && NILP (value)) ||
4140 (!NILP (closure->value) && !EQ (value, closure->value)))
4144 closure->result = call2 (closure->map_routine, extent_obj,
4147 /* Since the callback may change the buffer, compute all stored
4148 buffer positions here.
4150 closure->start_min = -1; /* no need for this any more */
4151 closure->prev_start = extent_endpoint_bytind (extent, 0);
4152 closure->prev_end = extent_endpoint_bytind (extent, 1);
4154 return !NILP (closure->result);
4157 DEFUN ("map-extent-children", Fmap_extent_children, 1, 8, 0, /*
4158 Map FUNCTION over the extents in the region from FROM to TO.
4159 FUNCTION is called with arguments (extent, MAPARG). See `map-extents'
4160 for a full discussion of the arguments FROM, TO, and FLAGS.
4162 The arguments are the same as for `map-extents', but this function differs
4163 in that it only visits extents which start in the given region, and also
4164 in that, after visiting an extent E, it skips all other extents which start
4165 inside E but end before E's end.
4167 Thus, this function may be used to walk a tree of extents in a buffer:
4168 (defun walk-extents (buffer &optional ignore)
4169 (map-extent-children 'walk-extents buffer))
4171 (function, object, from, to, maparg, flags, property, value))
4173 /* This function can GC */
4174 struct slow_map_extent_children_arg closure;
4175 unsigned int me_flags;
4177 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
4180 if (EXTENTP (object))
4182 after = decode_extent (object, DE_MUST_BE_ATTACHED);
4184 from = Fextent_start_position (object);
4186 to = Fextent_end_position (object);
4187 object = extent_object (after);
4190 object = decode_buffer_or_string (object);
4192 get_buffer_or_string_range_byte (object, from, to, &start, &end,
4193 GB_ALLOW_NIL | GB_ALLOW_PAST_ACCESSIBLE);
4195 me_flags = decode_map_extents_flags (flags);
4197 if (!NILP (property))
4200 value = canonicalize_extent_property (property, value);
4203 GCPRO5 (function, maparg, object, property, value);
4205 closure.map_arg = maparg;
4206 closure.map_routine = function;
4207 closure.result = Qnil;
4208 closure.property = property;
4209 closure.value = value;
4210 closure.start_min = start;
4211 closure.prev_start = -1;
4212 closure.prev_end = -1;
4213 map_extents_bytind (start, end, slow_map_extent_children_function,
4214 (void *) &closure, object, after,
4215 /* You never know what the user might do ... */
4216 me_flags | ME_MIGHT_CALL_ELISP);
4219 return closure.result;
4222 /* ------------------------------- */
4224 /* ------------------------------- */
4226 /* find "smallest" matching extent containing pos -- (flag == 0) means
4227 all extents match, else (EXTENT_FLAGS (extent) & flag) must be true;
4228 for more than one matching extent with precisely the same endpoints,
4229 we choose the last extent in the extents_list.
4230 The search stops just before "before", if that is non-null.
4233 struct extent_at_arg
4249 static enum extent_at_flag
4250 decode_extent_at_flag (Lisp_Object at_flag)
4253 return EXTENT_AT_AFTER;
4255 CHECK_SYMBOL (at_flag);
4256 if (EQ (at_flag, Qafter)) return EXTENT_AT_AFTER;
4257 if (EQ (at_flag, Qbefore)) return EXTENT_AT_BEFORE;
4258 if (EQ (at_flag, Qat)) return EXTENT_AT_AT;
4260 signal_simple_error ("Invalid AT-FLAG in `extent-at'", at_flag);
4261 return EXTENT_AT_AFTER; /* unreached */
4265 extent_at_mapper (EXTENT e, void *arg)
4267 struct extent_at_arg *closure = (struct extent_at_arg *) arg;
4269 if (e == closure->before)
4272 /* If closure->prop is non-nil, then the extent is only acceptable
4273 if it has a non-nil value for that property. */
4274 if (!NILP (closure->prop))
4277 XSETEXTENT (extent, e);
4278 if (NILP (Fextent_property (extent, closure->prop, Qnil)))
4283 EXTENT current = closure->best_match;
4287 /* redundant but quick test */
4288 else if (extent_start (current) > extent_start (e))
4291 /* we return the "last" best fit, instead of the first --
4292 this is because then the glyph closest to two equivalent
4293 extents corresponds to the "extent-at" the text just past
4295 else if (!EXTENT_LESS_VALS (e, closure->best_start,
4301 closure->best_match = e;
4302 closure->best_start = extent_start (e);
4303 closure->best_end = extent_end (e);
4310 extent_at_bytind (Bytind position, Lisp_Object object, Lisp_Object property,
4311 EXTENT before, enum extent_at_flag at_flag)
4313 struct extent_at_arg closure;
4314 Lisp_Object extent_obj;
4316 /* it might be argued that invalid positions should cause
4317 errors, but the principle of least surprise dictates that
4318 nil should be returned (extent-at is often used in
4319 response to a mouse event, and in many cases previous events
4320 have changed the buffer contents).
4322 Also, the openness stuff in the text-property code currently
4323 does not check its limits and might go off the end. */
4324 if ((at_flag == EXTENT_AT_BEFORE
4325 ? position <= buffer_or_string_absolute_begin_byte (object)
4326 : position < buffer_or_string_absolute_begin_byte (object))
4327 || (at_flag == EXTENT_AT_AFTER
4328 ? position >= buffer_or_string_absolute_end_byte (object)
4329 : position > buffer_or_string_absolute_end_byte (object)))
4332 closure.best_match = 0;
4333 closure.prop = property;
4334 closure.before = before;
4336 map_extents_bytind (at_flag == EXTENT_AT_BEFORE ? position - 1 : position,
4337 at_flag == EXTENT_AT_AFTER ? position + 1 : position,
4338 extent_at_mapper, (void *) &closure, object, 0,
4339 ME_START_OPEN | ME_ALL_EXTENTS_CLOSED);
4341 if (!closure.best_match)
4344 XSETEXTENT (extent_obj, closure.best_match);
4348 DEFUN ("extent-at", Fextent_at, 1, 5, 0, /*
4349 Find "smallest" extent at POS in OBJECT having PROPERTY set.
4350 Normally, an extent is "at" POS if it overlaps the region (POS, POS+1);
4351 i.e. if it covers the character after POS. (However, see the definition
4352 of AT-FLAG.) "Smallest" means the extent that comes last in the display
4353 order; this normally means the extent whose start position is closest to
4354 POS. See `next-extent' for more information.
4355 OBJECT specifies a buffer or string and defaults to the current buffer.
4356 PROPERTY defaults to nil, meaning that any extent will do.
4357 Properties are attached to extents with `set-extent-property', which see.
4358 Returns nil if POS is invalid or there is no matching extent at POS.
4359 If the fourth argument BEFORE is not nil, it must be an extent; any returned
4360 extent will precede that extent. This feature allows `extent-at' to be
4361 used by a loop over extents.
4362 AT-FLAG controls how end cases are handled, and should be one of:
4364 nil or `after' An extent is at POS if it covers the character
4365 after POS. This is consistent with the way
4366 that text properties work.
4367 `before' An extent is at POS if it covers the character
4369 `at' An extent is at POS if it overlaps or abuts POS.
4370 This includes all zero-length extents at POS.
4372 Note that in all cases, the start-openness and end-openness of the extents
4373 considered is ignored. If you want to pay attention to those properties,
4374 you should use `map-extents', which gives you more control.
4376 (pos, object, property, before, at_flag))
4379 EXTENT before_extent;
4380 enum extent_at_flag fl;
4382 object = decode_buffer_or_string (object);
4383 position = get_buffer_or_string_pos_byte (object, pos, GB_NO_ERROR_IF_BAD);
4387 before_extent = decode_extent (before, DE_MUST_BE_ATTACHED);
4388 if (before_extent && !EQ (object, extent_object (before_extent)))
4389 signal_simple_error ("extent not in specified buffer or string", object);
4390 fl = decode_extent_at_flag (at_flag);
4392 return extent_at_bytind (position, object, property, before_extent, fl);
4395 /* ------------------------------- */
4396 /* verify_extent_modification() */
4397 /* ------------------------------- */
4399 /* verify_extent_modification() is called when a buffer or string is
4400 modified to check whether the modification is occuring inside a
4404 struct verify_extents_arg
4409 Lisp_Object iro; /* value of inhibit-read-only */
4413 verify_extent_mapper (EXTENT extent, void *arg)
4415 struct verify_extents_arg *closure = (struct verify_extents_arg *) arg;
4416 Lisp_Object prop = extent_read_only (extent);
4421 if (CONSP (closure->iro) && !NILP (Fmemq (prop, closure->iro)))
4424 #if 0 /* Nobody seems to care for this any more -sb */
4425 /* Allow deletion if the extent is completely contained in
4426 the region being deleted.
4427 This is important for supporting tokens which are internally
4428 write-protected, but which can be killed and yanked as a whole.
4429 Ignore open/closed distinctions at this point.
4432 if (closure->start != closure->end &&
4433 extent_start (extent) >= closure->start &&
4434 extent_end (extent) <= closure->end)
4439 Fsignal (Qbuffer_read_only, (list1 (closure->object)));
4441 RETURN_NOT_REACHED(0)
4444 /* Value of Vinhibit_read_only is precomputed and passed in for
4448 verify_extent_modification (Lisp_Object object, Bytind from, Bytind to,
4449 Lisp_Object inhibit_read_only_value)
4452 struct verify_extents_arg closure;
4454 /* If insertion, visit closed-endpoint extents touching the insertion
4455 point because the text would go inside those extents. If deletion,
4456 treat the range as open on both ends so that touching extents are not
4457 visited. Note that we assume that an insertion is occurring if the
4458 changed range has zero length, and a deletion otherwise. This
4459 fails if a change (i.e. non-insertion, non-deletion) is happening.
4460 As far as I know, this doesn't currently occur in XEmacs. --ben */
4461 closed = (from==to);
4462 closure.object = object;
4463 closure.start = buffer_or_string_bytind_to_memind (object, from);
4464 closure.end = buffer_or_string_bytind_to_memind (object, to);
4465 closure.iro = inhibit_read_only_value;
4467 map_extents_bytind (from, to, verify_extent_mapper, (void *) &closure,
4468 object, 0, closed ? ME_END_CLOSED : ME_START_OPEN);
4471 /* ------------------------------------ */
4472 /* process_extents_for_insertion() */
4473 /* ------------------------------------ */
4475 struct process_extents_for_insertion_arg
4482 /* A region of length LENGTH was just inserted at OPOINT. Modify all
4483 of the extents as required for the insertion, based on their
4484 start-open/end-open properties.
4488 process_extents_for_insertion_mapper (EXTENT extent, void *arg)
4490 struct process_extents_for_insertion_arg *closure =
4491 (struct process_extents_for_insertion_arg *) arg;
4492 Memind indice = buffer_or_string_bytind_to_memind (closure->object,
4495 /* When this function is called, one end of the newly-inserted text should
4496 be adjacent to some endpoint of the extent, or disjoint from it. If
4497 the insertion overlaps any existing extent, something is wrong.
4499 #ifdef ERROR_CHECK_EXTENTS
4500 if (extent_start (extent) > indice &&
4501 extent_start (extent) < indice + closure->length)
4503 if (extent_end (extent) > indice &&
4504 extent_end (extent) < indice + closure->length)
4508 /* The extent-adjustment code adjusted the extent's endpoints as if
4509 they were markers -- endpoints at the gap (i.e. the insertion
4510 point) go to the left of the insertion point, which is correct
4511 for [) extents. We need to fix the other kinds of extents.
4513 Note that both conditions below will hold for zero-length (]
4514 extents at the gap. Zero-length () extents would get adjusted
4515 such that their start is greater than their end; we treat them
4516 as [) extents. This is unfortunately an inelegant part of the
4517 extent model, but there is no way around it. */
4520 Memind new_start, new_end;
4522 new_start = extent_start (extent);
4523 new_end = extent_end (extent);
4524 if (indice == extent_start (extent) && extent_start_open_p (extent) &&
4525 /* coerce zero-length () extents to [) */
4526 new_start != new_end)
4527 new_start += closure->length;
4528 if (indice == extent_end (extent) && !extent_end_open_p (extent))
4529 new_end += closure->length;
4530 set_extent_endpoints_1 (extent, new_start, new_end);
4537 process_extents_for_insertion (Lisp_Object object, Bytind opoint,
4540 struct process_extents_for_insertion_arg closure;
4542 closure.opoint = opoint;
4543 closure.length = length;
4544 closure.object = object;
4546 map_extents_bytind (opoint, opoint + length,
4547 process_extents_for_insertion_mapper,
4548 (void *) &closure, object, 0,
4549 ME_END_CLOSED | ME_MIGHT_MODIFY_EXTENTS |
4550 ME_INCLUDE_INTERNAL);
4553 /* ------------------------------------ */
4554 /* process_extents_for_deletion() */
4555 /* ------------------------------------ */
4557 struct process_extents_for_deletion_arg
4560 int destroy_included_extents;
4563 /* This function is called when we're about to delete the range [from, to].
4564 Detach all of the extents that are completely inside the range [from, to],
4565 if they're detachable or open-open. */
4568 process_extents_for_deletion_mapper (EXTENT extent, void *arg)
4570 struct process_extents_for_deletion_arg *closure =
4571 (struct process_extents_for_deletion_arg *) arg;
4573 /* If the extent lies completely within the range that
4574 is being deleted, then nuke the extent if it's detachable
4575 (otherwise, it will become a zero-length extent). */
4577 if (closure->start <= extent_start (extent) &&
4578 extent_end (extent) <= closure->end)
4580 if (extent_detachable_p (extent))
4582 if (closure->destroy_included_extents)
4583 destroy_extent (extent);
4585 extent_detach (extent);
4592 /* DESTROY_THEM means destroy the extents instead of just deleting them.
4593 It is unused currently, but perhaps might be used (there used to
4594 be a function process_extents_for_destruction(), #if 0'd out,
4595 that did the equivalent). */
4597 process_extents_for_deletion (Lisp_Object object, Bytind from,
4598 Bytind to, int destroy_them)
4600 struct process_extents_for_deletion_arg closure;
4602 closure.start = buffer_or_string_bytind_to_memind (object, from);
4603 closure.end = buffer_or_string_bytind_to_memind (object, to);
4604 closure.destroy_included_extents = destroy_them;
4606 map_extents_bytind (from, to, process_extents_for_deletion_mapper,
4607 (void *) &closure, object, 0,
4608 ME_END_CLOSED | ME_MIGHT_MODIFY_EXTENTS);
4611 /* ------------------------------- */
4612 /* report_extent_modification() */
4613 /* ------------------------------- */
4614 struct report_extent_modification_closure {
4621 /* This juggling with the pointer to another file's global variable is
4622 kind of yucky. Perhaps I should just export the variable. */
4623 static int *inside_change_hook_pointer;
4626 report_extent_modification_restore (Lisp_Object buffer)
4628 *inside_change_hook_pointer = 0;
4629 if (current_buffer != XBUFFER (buffer))
4630 Fset_buffer (buffer);
4635 report_extent_modification_mapper (EXTENT extent, void *arg)
4637 struct report_extent_modification_closure *closure =
4638 (struct report_extent_modification_closure *)arg;
4639 Lisp_Object exobj, startobj, endobj;
4640 Lisp_Object hook = (closure->afterp
4641 ? extent_after_change_functions (extent)
4642 : extent_before_change_functions (extent));
4646 XSETEXTENT (exobj, extent);
4647 XSETINT (startobj, closure->start);
4648 XSETINT (endobj, closure->end);
4650 /* Now that we are sure to call elisp, set up an unwind-protect so
4651 inside_change_hook gets restored in case we throw. Also record
4652 the current buffer, in case we change it. Do the recording only
4654 if (closure->speccount == -1)
4656 closure->speccount = specpdl_depth ();
4657 record_unwind_protect (report_extent_modification_restore,
4658 Fcurrent_buffer ());
4661 /* The functions will expect closure->buffer to be the current
4662 buffer, so change it if it isn't. */
4663 if (current_buffer != XBUFFER (closure->buffer))
4664 Fset_buffer (closure->buffer);
4666 /* #### It's a shame that we can't use any of the existing run_hook*
4667 functions here. This is so because all of them work with
4668 symbols, to be able to retrieve default values of local hooks.
4671 if (!CONSP (hook) || EQ (XCAR (hook), Qlambda))
4672 call3 (hook, exobj, startobj, endobj);
4676 EXTERNAL_LIST_LOOP (tail, hook)
4677 call3 (XCAR (tail), exobj, startobj, endobj);
4683 report_extent_modification (Lisp_Object buffer, Bufpos start, Bufpos end,
4684 int *inside, int afterp)
4686 struct report_extent_modification_closure closure;
4688 closure.buffer = buffer;
4689 closure.start = start;
4691 closure.afterp = afterp;
4692 closure.speccount = -1;
4694 inside_change_hook_pointer = inside;
4697 map_extents (start, end, report_extent_modification_mapper, (void *)&closure,
4698 buffer, NULL, ME_MIGHT_CALL_ELISP);
4700 if (closure.speccount == -1)
4704 /* We mustn't unbind when closure.speccount != -1 because
4705 map_extents_bytind has already done that. */
4706 assert (*inside == 0);
4711 /************************************************************************/
4712 /* extent properties */
4713 /************************************************************************/
4716 set_extent_invisible (EXTENT extent, Lisp_Object value)
4718 if (!EQ (extent_invisible (extent), value))
4720 set_extent_invisible_1 (extent, value);
4721 extent_changed_for_redisplay (extent, 1, 1);
4725 /* This function does "memoization" -- similar to the interning
4726 that happens with symbols. Given a list of faces, an equivalent
4727 list is returned such that if this function is called twice with
4728 input that is `equal', the resulting outputs will be `eq'.
4730 Note that the inputs and outputs are in general *not* `equal' --
4731 faces in symbol form become actual face objects in the output.
4732 This is necessary so that temporary faces stay around. */
4735 memoize_extent_face_internal (Lisp_Object list)
4739 Lisp_Object cons, thecons;
4740 Lisp_Object oldtail, tail;
4741 struct gcpro gcpro1;
4746 return Fget_face (list);
4748 /* To do the memoization, we use a hash table mapping from
4749 external lists to internal lists. We do `equal' comparisons
4750 on the keys so the memoization works correctly.
4752 Note that we canonicalize things so that the keys in the
4753 hash table (the external lists) always contain symbols and
4754 the values (the internal lists) always contain face objects.
4756 We also maintain a "reverse" table that maps from the internal
4757 lists to the external equivalents. The idea here is twofold:
4759 1) `extent-face' wants to return a list containing face symbols
4760 rather than face objects.
4761 2) We don't want things to get quite so messed up if the user
4762 maliciously side-effects the returned lists.
4765 len = XINT (Flength (list));
4766 thelen = XINT (Flength (Vextent_face_reusable_list));
4771 /* We canonicalize the given list into another list.
4772 We try to avoid consing except when necessary, so we have
4778 cons = Vextent_face_reusable_list;
4779 while (!NILP (XCDR (cons)))
4781 XCDR (cons) = Fmake_list (make_int (len - thelen), Qnil);
4783 else if (thelen > len)
4787 /* Truncate the list temporarily so it's the right length;
4788 remember the old tail. */
4789 cons = Vextent_face_reusable_list;
4790 for (i = 0; i < len - 1; i++)
4793 oldtail = XCDR (cons);
4797 thecons = Vextent_face_reusable_list;
4798 EXTERNAL_LIST_LOOP (cons, list)
4800 Lisp_Object face = Fget_face (XCAR (cons));
4802 XCAR (thecons) = Fface_name (face);
4803 thecons = XCDR (thecons);
4806 list = Fgethash (Vextent_face_reusable_list, Vextent_face_memoize_hash_table,
4810 Lisp_Object symlist = Fcopy_sequence (Vextent_face_reusable_list);
4811 Lisp_Object facelist = Fcopy_sequence (Vextent_face_reusable_list);
4813 LIST_LOOP (cons, facelist)
4815 XCAR (cons) = Fget_face (XCAR (cons));
4817 Fputhash (symlist, facelist, Vextent_face_memoize_hash_table);
4818 Fputhash (facelist, symlist, Vextent_face_reverse_memoize_hash_table);
4822 /* Now restore the truncated tail of the reusable list, if necessary. */
4824 XCDR (tail) = oldtail;
4831 external_of_internal_memoized_face (Lisp_Object face)
4835 else if (!CONSP (face))
4836 return XFACE (face)->name;
4839 face = Fgethash (face, Vextent_face_reverse_memoize_hash_table,
4841 assert (!UNBOUNDP (face));
4847 canonicalize_extent_property (Lisp_Object prop, Lisp_Object value)
4849 if (EQ (prop, Qface) || EQ (prop, Qmouse_face))
4850 value = (external_of_internal_memoized_face
4851 (memoize_extent_face_internal (value)));
4855 /* Do we need a lisp-level function ? */
4856 DEFUN ("set-extent-initial-redisplay-function", Fset_extent_initial_redisplay_function,
4858 Note: This feature is experimental!
4860 Set initial-redisplay-function of EXTENT to the function
4863 The first time the EXTENT is (re)displayed, an eval event will be
4864 dispatched calling FUNCTION with EXTENT as its only argument.
4868 EXTENT e = decode_extent(extent, DE_MUST_BE_ATTACHED);
4870 e = extent_ancestor (e); /* Is this needed? Macro also does chasing!*/
4871 set_extent_initial_redisplay_function(e,function);
4872 extent_in_red_event_p(e) = 0; /* If the function changed we can spawn
4874 extent_changed_for_redisplay(e,1,0); /* Do we need to mark children too ?*/
4879 DEFUN ("extent-face", Fextent_face, 1, 1, 0, /*
4880 Return the name of the face in which EXTENT is displayed, or nil
4881 if the extent's face is unspecified. This might also return a list
4888 CHECK_EXTENT (extent);
4889 face = extent_face (XEXTENT (extent));
4891 return external_of_internal_memoized_face (face);
4894 DEFUN ("set-extent-face", Fset_extent_face, 2, 2, 0, /*
4895 Make the given EXTENT have the graphic attributes specified by FACE.
4896 FACE can also be a list of faces, and all faces listed will apply,
4897 with faces earlier in the list taking priority over those later in the
4902 EXTENT e = decode_extent(extent, 0);
4903 Lisp_Object orig_face = face;
4905 /* retrieve the ancestor for efficiency and proper redisplay noting. */
4906 e = extent_ancestor (e);
4908 face = memoize_extent_face_internal (face);
4910 extent_face (e) = face;
4911 extent_changed_for_redisplay (e, 1, 0);
4917 DEFUN ("extent-mouse-face", Fextent_mouse_face, 1, 1, 0, /*
4918 Return the face used to highlight EXTENT when the mouse passes over it.
4919 The return value will be a face name, a list of face names, or nil
4920 if the extent's mouse face is unspecified.
4926 CHECK_EXTENT (extent);
4927 face = extent_mouse_face (XEXTENT (extent));
4929 return external_of_internal_memoized_face (face);
4932 DEFUN ("set-extent-mouse-face", Fset_extent_mouse_face, 2, 2, 0, /*
4933 Set the face used to highlight EXTENT when the mouse passes over it.
4934 FACE can also be a list of faces, and all faces listed will apply,
4935 with faces earlier in the list taking priority over those later in the
4941 Lisp_Object orig_face = face;
4943 CHECK_EXTENT (extent);
4944 e = XEXTENT (extent);
4945 /* retrieve the ancestor for efficiency and proper redisplay noting. */
4946 e = extent_ancestor (e);
4948 face = memoize_extent_face_internal (face);
4950 set_extent_mouse_face (e, face);
4951 extent_changed_for_redisplay (e, 1, 0);
4957 set_extent_glyph (EXTENT extent, Lisp_Object glyph, int endp,
4958 glyph_layout layout)
4960 extent = extent_ancestor (extent);
4964 set_extent_begin_glyph (extent, glyph);
4965 extent_begin_glyph_layout (extent) = layout;
4969 set_extent_end_glyph (extent, glyph);
4970 extent_end_glyph_layout (extent) = layout;
4973 extent_changed_for_redisplay (extent, 1, 0);
4977 glyph_layout_to_symbol (glyph_layout layout)
4981 case GL_TEXT: return Qtext;
4982 case GL_OUTSIDE_MARGIN: return Qoutside_margin;
4983 case GL_INSIDE_MARGIN: return Qinside_margin;
4984 case GL_WHITESPACE: return Qwhitespace;
4987 return Qnil; /* unreached */
4992 symbol_to_glyph_layout (Lisp_Object layout_obj)
4994 if (NILP (layout_obj))
4997 CHECK_SYMBOL (layout_obj);
4998 if (EQ (layout_obj, Qoutside_margin)) return GL_OUTSIDE_MARGIN;
4999 if (EQ (layout_obj, Qinside_margin)) return GL_INSIDE_MARGIN;
5000 if (EQ (layout_obj, Qwhitespace)) return GL_WHITESPACE;
5001 if (EQ (layout_obj, Qtext)) return GL_TEXT;
5003 signal_simple_error ("Unknown glyph layout type", layout_obj);
5004 return GL_TEXT; /* unreached */
5008 set_extent_glyph_1 (Lisp_Object extent_obj, Lisp_Object glyph, int endp,
5009 Lisp_Object layout_obj)
5011 EXTENT extent = decode_extent (extent_obj, DE_MUST_HAVE_BUFFER);
5012 glyph_layout layout = symbol_to_glyph_layout (layout_obj);
5014 /* Make sure we've actually been given a valid glyph or it's nil
5015 (meaning we're deleting a glyph from an extent). */
5017 CHECK_BUFFER_GLYPH (glyph);
5019 set_extent_glyph (extent, glyph, endp, layout);
5023 DEFUN ("set-extent-begin-glyph", Fset_extent_begin_glyph, 2, 3, 0, /*
5024 Display a bitmap, subwindow or string at the beginning of EXTENT.
5025 BEGIN-GLYPH must be a glyph object. The layout policy defaults to `text'.
5027 (extent, begin_glyph, layout))
5029 return set_extent_glyph_1 (extent, begin_glyph, 0, layout);
5032 DEFUN ("set-extent-end-glyph", Fset_extent_end_glyph, 2, 3, 0, /*
5033 Display a bitmap, subwindow or string at the end of EXTENT.
5034 END-GLYPH must be a glyph object. The layout policy defaults to `text'.
5036 (extent, end_glyph, layout))
5038 return set_extent_glyph_1 (extent, end_glyph, 1, layout);
5041 DEFUN ("extent-begin-glyph", Fextent_begin_glyph, 1, 1, 0, /*
5042 Return the glyph object displayed at the beginning of EXTENT.
5043 If there is none, nil is returned.
5047 return extent_begin_glyph (decode_extent (extent, 0));
5050 DEFUN ("extent-end-glyph", Fextent_end_glyph, 1, 1, 0, /*
5051 Return the glyph object displayed at the end of EXTENT.
5052 If there is none, nil is returned.
5056 return extent_end_glyph (decode_extent (extent, 0));
5059 DEFUN ("set-extent-begin-glyph-layout", Fset_extent_begin_glyph_layout, 2, 2, 0, /*
5060 Set the layout policy of EXTENT's begin glyph.
5061 Access this using the `extent-begin-glyph-layout' function.
5065 EXTENT e = decode_extent (extent, 0);
5066 e = extent_ancestor (e);
5067 extent_begin_glyph_layout (e) = symbol_to_glyph_layout (layout);
5068 extent_maybe_changed_for_redisplay (e, 1, 0);
5072 DEFUN ("set-extent-end-glyph-layout", Fset_extent_end_glyph_layout, 2, 2, 0, /*
5073 Set the layout policy of EXTENT's end glyph.
5074 Access this using the `extent-end-glyph-layout' function.
5078 EXTENT e = decode_extent (extent, 0);
5079 e = extent_ancestor (e);
5080 extent_end_glyph_layout (e) = symbol_to_glyph_layout (layout);
5081 extent_maybe_changed_for_redisplay (e, 1, 0);
5085 DEFUN ("extent-begin-glyph-layout", Fextent_begin_glyph_layout, 1, 1, 0, /*
5086 Return the layout policy associated with EXTENT's begin glyph.
5087 Set this using the `set-extent-begin-glyph-layout' function.
5091 EXTENT e = decode_extent (extent, 0);
5092 return glyph_layout_to_symbol ((glyph_layout) extent_begin_glyph_layout (e));
5095 DEFUN ("extent-end-glyph-layout", Fextent_end_glyph_layout, 1, 1, 0, /*
5096 Return the layout policy associated with EXTENT's end glyph.
5097 Set this using the `set-extent-end-glyph-layout' function.
5101 EXTENT e = decode_extent (extent, 0);
5102 return glyph_layout_to_symbol ((glyph_layout) extent_end_glyph_layout (e));
5105 DEFUN ("set-extent-priority", Fset_extent_priority, 2, 2, 0, /*
5106 Set the display priority of EXTENT to PRIORITY (an integer).
5107 When the extent attributes are being merged for display, the priority
5108 is used to determine which extent takes precedence in the event of a
5109 conflict (two extents whose faces both specify font, for example: the
5110 font of the extent with the higher priority will be used).
5111 Extents are created with priority 0; priorities may be negative.
5115 EXTENT e = decode_extent (extent, 0);
5117 CHECK_INT (priority);
5118 e = extent_ancestor (e);
5119 set_extent_priority (e, XINT (priority));
5120 extent_maybe_changed_for_redisplay (e, 1, 0);
5124 DEFUN ("extent-priority", Fextent_priority, 1, 1, 0, /*
5125 Return the display priority of EXTENT; see `set-extent-priority'.
5129 EXTENT e = decode_extent (extent, 0);
5130 return make_int (extent_priority (e));
5133 DEFUN ("set-extent-property", Fset_extent_property, 3, 3, 0, /*
5134 Change a property of an extent.
5135 PROPERTY may be any symbol; the value stored may be accessed with
5136 the `extent-property' function.
5137 The following symbols have predefined meanings:
5139 detached Removes the extent from its buffer; setting this is
5140 the same as calling `detach-extent'.
5142 destroyed Removes the extent from its buffer, and makes it
5143 unusable in the future; this is the same calling
5146 priority Change redisplay priority; same as `set-extent-priority'.
5148 start-open Whether the set of characters within the extent is
5149 treated being open on the left, that is, whether
5150 the start position is an exclusive, rather than
5151 inclusive, boundary. If true, then characters
5152 inserted exactly at the beginning of the extent
5153 will remain outside of the extent; otherwise they
5154 will go into the extent, extending it.
5156 end-open Whether the set of characters within the extent is
5157 treated being open on the right, that is, whether
5158 the end position is an exclusive, rather than
5159 inclusive, boundary. If true, then characters
5160 inserted exactly at the end of the extent will
5161 remain outside of the extent; otherwise they will
5162 go into the extent, extending it.
5164 By default, extents have the `end-open' but not the
5165 `start-open' property set.
5167 read-only Text within this extent will be unmodifiable.
5169 initial-redisplay-function (EXPERIMENTAL)
5170 function to be called the first time (part of) the extent
5171 is redisplayed. It will be called with the extent as its
5173 Note: The function will not be called immediately
5174 during redisplay, an eval event will be dispatched.
5176 detachable Whether the extent gets detached (as with
5177 `detach-extent') when all the text within the
5178 extent is deleted. This is true by default. If
5179 this property is not set, the extent becomes a
5180 zero-length extent when its text is deleted. (In
5181 such a case, the `start-open' property is
5182 automatically removed if both the `start-open' and
5183 `end-open' properties are set, since zero-length
5184 extents open on both ends are not allowed.)
5186 face The face in which to display the text. Setting
5187 this is the same as calling `set-extent-face'.
5189 mouse-face If non-nil, the extent will be highlighted in this
5190 face when the mouse moves over it.
5192 pointer If non-nil, and a valid pointer glyph, this specifies
5193 the shape of the mouse pointer while over the extent.
5195 highlight Obsolete: Setting this property is equivalent to
5196 setting a `mouse-face' property of `highlight'.
5197 Reading this property returns non-nil if
5198 the extent has a non-nil `mouse-face' property.
5200 duplicable Whether this extent should be copied into strings,
5201 so that kill, yank, and undo commands will restore
5202 or copy it. `duplicable' extents are copied from
5203 an extent into a string when `buffer-substring' or
5204 a similar function creates a string. The extents
5205 in a string are copied into other strings created
5206 from the string using `concat' or `substring'.
5207 When `insert' or a similar function inserts the
5208 string into a buffer, the extents are copied back
5211 unique Meaningful only in conjunction with `duplicable'.
5212 When this is set, there may be only one instance
5213 of this extent attached at a time: if it is copied
5214 to the kill ring and then yanked, the extent is
5215 not copied. If, however, it is killed (removed
5216 from the buffer) and then yanked, it will be
5217 re-attached at the new position.
5219 invisible If the value is non-nil, text under this extent
5220 may be treated as not present for the purpose of
5221 redisplay, or may be displayed using an ellipsis
5222 or other marker; see `buffer-invisibility-spec'
5223 and `invisible-text-glyph'. In all cases,
5224 however, the text is still visible to other
5225 functions that examine a buffer's text.
5227 keymap This keymap is consulted for mouse clicks on this
5228 extent, or keypresses made while point is within the
5231 copy-function This is a hook that is run when a duplicable extent
5232 is about to be copied from a buffer to a string (or
5233 the kill ring). It is called with three arguments,
5234 the extent, and the buffer-positions within it
5235 which are being copied. If this function returns
5236 nil, then the extent will not be copied; otherwise
5239 paste-function This is a hook that is run when a duplicable extent is
5240 about to be copied from a string (or the kill ring)
5241 into a buffer. It is called with three arguments,
5242 the original extent, and the buffer positions which
5243 the copied extent will occupy. (This hook is run
5244 after the corresponding text has already been
5245 inserted into the buffer.) Note that the extent
5246 argument may be detached when this function is run.
5247 If this function returns nil, no extent will be
5248 inserted. Otherwise, there will be an extent
5249 covering the range in question.
5251 If the original extent is not attached to a buffer,
5252 then it will be re-attached at this range.
5253 Otherwise, a copy will be made, and that copy
5256 The copy-function and paste-function are meaningful
5257 only for extents with the `duplicable' flag set,
5258 and if they are not specified, behave as if `t' was
5259 the returned value. When these hooks are invoked,
5260 the current buffer is the buffer which the extent
5261 is being copied from/to, respectively.
5263 begin-glyph A glyph to be displayed at the beginning of the extent,
5266 end-glyph A glyph to be displayed at the end of the extent,
5269 begin-glyph-layout The layout policy (one of `text', `whitespace',
5270 `inside-margin', or `outside-margin') of the extent's
5273 end-glyph-layout The layout policy of the extent's end glyph.
5275 (extent, property, value))
5277 /* This function can GC if property is `keymap' */
5278 EXTENT e = decode_extent (extent, 0);
5280 if (EQ (property, Qread_only))
5281 set_extent_read_only (e, value);
5282 else if (EQ (property, Qunique))
5283 extent_unique_p (e) = !NILP (value);
5284 else if (EQ (property, Qduplicable))
5285 extent_duplicable_p (e) = !NILP (value);
5286 else if (EQ (property, Qinvisible))
5287 set_extent_invisible (e, value);
5288 else if (EQ (property, Qdetachable))
5289 extent_detachable_p (e) = !NILP (value);
5291 else if (EQ (property, Qdetached))
5294 error ("can only set `detached' to t");
5295 Fdetach_extent (extent);
5297 else if (EQ (property, Qdestroyed))
5300 error ("can only set `destroyed' to t");
5301 Fdelete_extent (extent);
5303 else if (EQ (property, Qpriority))
5304 Fset_extent_priority (extent, value);
5305 else if (EQ (property, Qface))
5306 Fset_extent_face (extent, value);
5307 else if (EQ (property, Qinitial_redisplay_function))
5308 Fset_extent_initial_redisplay_function (extent, value);
5309 else if (EQ (property, Qbefore_change_functions))
5310 set_extent_before_change_functions (e, value);
5311 else if (EQ (property, Qafter_change_functions))
5312 set_extent_after_change_functions (e, value);
5313 else if (EQ (property, Qmouse_face))
5314 Fset_extent_mouse_face (extent, value);
5316 else if (EQ (property, Qhighlight))
5317 Fset_extent_mouse_face (extent, Qhighlight);
5318 else if (EQ (property, Qbegin_glyph_layout))
5319 Fset_extent_begin_glyph_layout (extent, value);
5320 else if (EQ (property, Qend_glyph_layout))
5321 Fset_extent_end_glyph_layout (extent, value);
5322 /* For backwards compatibility. We use begin glyph because it is by
5323 far the more used of the two. */
5324 else if (EQ (property, Qglyph_layout))
5325 Fset_extent_begin_glyph_layout (extent, value);
5326 else if (EQ (property, Qbegin_glyph))
5327 Fset_extent_begin_glyph (extent, value, Qnil);
5328 else if (EQ (property, Qend_glyph))
5329 Fset_extent_end_glyph (extent, value, Qnil);
5330 else if (EQ (property, Qstart_open))
5331 set_extent_openness (e, !NILP (value), -1);
5332 else if (EQ (property, Qend_open))
5333 set_extent_openness (e, -1, !NILP (value));
5334 /* Support (but don't document...) the obvious *_closed antonyms. */
5335 else if (EQ (property, Qstart_closed))
5336 set_extent_openness (e, NILP (value), -1);
5337 else if (EQ (property, Qend_closed))
5338 set_extent_openness (e, -1, NILP (value));
5341 if (EQ (property, Qkeymap))
5342 while (!NILP (value) && NILP (Fkeymapp (value)))
5343 value = wrong_type_argument (Qkeymapp, value);
5345 external_plist_put (extent_plist_addr (e), property, value, 0, ERROR_ME);
5351 DEFUN ("set-extent-properties", Fset_extent_properties, 2, 2, 0, /*
5352 Change some properties of EXTENT.
5353 PLIST is a property list.
5354 For a list of built-in properties, see `set-extent-property'.
5358 /* This function can GC, if one of the properties is `keymap' */
5359 Lisp_Object property, value;
5360 struct gcpro gcpro1;
5363 plist = Fcopy_sequence (plist);
5364 Fcanonicalize_plist (plist, Qnil);
5366 while (!NILP (plist))
5368 property = Fcar (plist); plist = Fcdr (plist);
5369 value = Fcar (plist); plist = Fcdr (plist);
5370 Fset_extent_property (extent, property, value);
5376 DEFUN ("extent-property", Fextent_property, 2, 3, 0, /*
5377 Return EXTENT's value for property PROPERTY.
5378 See `set-extent-property' for the built-in property names.
5380 (extent, property, default_))
5382 EXTENT e = decode_extent (extent, 0);
5384 if (EQ (property, Qdetached))
5385 return extent_detached_p (e) ? Qt : Qnil;
5386 else if (EQ (property, Qdestroyed))
5387 return !EXTENT_LIVE_P (e) ? Qt : Qnil;
5388 else if (EQ (property, Qstart_open))
5389 return extent_normal_field (e, start_open) ? Qt : Qnil;
5390 else if (EQ (property, Qend_open))
5391 return extent_normal_field (e, end_open) ? Qt : Qnil;
5392 else if (EQ (property, Qunique))
5393 return extent_normal_field (e, unique) ? Qt : Qnil;
5394 else if (EQ (property, Qduplicable))
5395 return extent_normal_field (e, duplicable) ? Qt : Qnil;
5396 else if (EQ (property, Qdetachable))
5397 return extent_normal_field (e, detachable) ? Qt : Qnil;
5398 /* Support (but don't document...) the obvious *_closed antonyms. */
5399 else if (EQ (property, Qstart_closed))
5400 return extent_start_open_p (e) ? Qnil : Qt;
5401 else if (EQ (property, Qend_closed))
5402 return extent_end_open_p (e) ? Qnil : Qt;
5403 else if (EQ (property, Qpriority))
5404 return make_int (extent_priority (e));
5405 else if (EQ (property, Qread_only))
5406 return extent_read_only (e);
5407 else if (EQ (property, Qinvisible))
5408 return extent_invisible (e);
5409 else if (EQ (property, Qface))
5410 return Fextent_face (extent);
5411 else if (EQ (property, Qinitial_redisplay_function))
5412 return extent_initial_redisplay_function (e);
5413 else if (EQ (property, Qbefore_change_functions))
5414 return extent_before_change_functions (e);
5415 else if (EQ (property, Qafter_change_functions))
5416 return extent_after_change_functions (e);
5417 else if (EQ (property, Qmouse_face))
5418 return Fextent_mouse_face (extent);
5420 else if (EQ (property, Qhighlight))
5421 return !NILP (Fextent_mouse_face (extent)) ? Qt : Qnil;
5422 else if (EQ (property, Qbegin_glyph_layout))
5423 return Fextent_begin_glyph_layout (extent);
5424 else if (EQ (property, Qend_glyph_layout))
5425 return Fextent_end_glyph_layout (extent);
5426 /* For backwards compatibility. We use begin glyph because it is by
5427 far the more used of the two. */
5428 else if (EQ (property, Qglyph_layout))
5429 return Fextent_begin_glyph_layout (extent);
5430 else if (EQ (property, Qbegin_glyph))
5431 return extent_begin_glyph (e);
5432 else if (EQ (property, Qend_glyph))
5433 return extent_end_glyph (e);
5436 Lisp_Object value = external_plist_get (extent_plist_addr (e),
5437 property, 0, ERROR_ME);
5438 return UNBOUNDP (value) ? default_ : value;
5442 DEFUN ("extent-properties", Fextent_properties, 1, 1, 0, /*
5443 Return a property list of the attributes of EXTENT.
5444 Do not modify this list; use `set-extent-property' instead.
5449 Lisp_Object result, face, anc_obj;
5450 glyph_layout layout;
5452 CHECK_EXTENT (extent);
5453 e = XEXTENT (extent);
5454 if (!EXTENT_LIVE_P (e))
5455 return cons3 (Qdestroyed, Qt, Qnil);
5457 anc = extent_ancestor (e);
5458 XSETEXTENT (anc_obj, anc);
5460 /* For efficiency, use the ancestor for all properties except detached */
5462 result = extent_plist_slot (anc);
5464 if (!NILP (face = Fextent_face (anc_obj)))
5465 result = cons3 (Qface, face, result);
5467 if (!NILP (face = Fextent_mouse_face (anc_obj)))
5468 result = cons3 (Qmouse_face, face, result);
5470 if ((layout = (glyph_layout) extent_begin_glyph_layout (anc)) != GL_TEXT)
5472 Lisp_Object sym = glyph_layout_to_symbol (layout);
5473 result = cons3 (Qglyph_layout, sym, result); /* compatibility */
5474 result = cons3 (Qbegin_glyph_layout, sym, result);
5477 if ((layout = (glyph_layout) extent_end_glyph_layout (anc)) != GL_TEXT)
5478 result = cons3 (Qend_glyph_layout, glyph_layout_to_symbol (layout), result);
5480 if (!NILP (extent_end_glyph (anc)))
5481 result = cons3 (Qend_glyph, extent_end_glyph (anc), result);
5483 if (!NILP (extent_begin_glyph (anc)))
5484 result = cons3 (Qbegin_glyph, extent_begin_glyph (anc), result);
5486 if (extent_priority (anc) != 0)
5487 result = cons3 (Qpriority, make_int (extent_priority (anc)), result);
5489 if (!NILP (extent_initial_redisplay_function (anc)))
5490 result = cons3 (Qinitial_redisplay_function,
5491 extent_initial_redisplay_function (anc), result);
5493 if (!NILP (extent_before_change_functions (anc)))
5494 result = cons3 (Qbefore_change_functions,
5495 extent_before_change_functions (anc), result);
5497 if (!NILP (extent_after_change_functions (anc)))
5498 result = cons3 (Qafter_change_functions,
5499 extent_after_change_functions (anc), result);
5501 if (!NILP (extent_invisible (anc)))
5502 result = cons3 (Qinvisible, extent_invisible (anc), result);
5504 if (!NILP (extent_read_only (anc)))
5505 result = cons3 (Qread_only, extent_read_only (anc), result);
5507 if (extent_normal_field (anc, end_open))
5508 result = cons3 (Qend_open, Qt, result);
5510 if (extent_normal_field (anc, start_open))
5511 result = cons3 (Qstart_open, Qt, result);
5513 if (extent_normal_field (anc, detachable))
5514 result = cons3 (Qdetachable, Qt, result);
5516 if (extent_normal_field (anc, duplicable))
5517 result = cons3 (Qduplicable, Qt, result);
5519 if (extent_normal_field (anc, unique))
5520 result = cons3 (Qunique, Qt, result);
5522 /* detached is not an inherited property */
5523 if (extent_detached_p (e))
5524 result = cons3 (Qdetached, Qt, result);
5530 /************************************************************************/
5532 /************************************************************************/
5534 /* The display code looks into the Vlast_highlighted_extent variable to
5535 correctly display highlighted extents. This updates that variable,
5536 and marks the appropriate buffers as needing some redisplay.
5539 do_highlight (Lisp_Object extent_obj, int highlight_p)
5541 if (( highlight_p && (EQ (Vlast_highlighted_extent, extent_obj))) ||
5542 (!highlight_p && (EQ (Vlast_highlighted_extent, Qnil))))
5544 if (EXTENTP (Vlast_highlighted_extent) &&
5545 EXTENT_LIVE_P (XEXTENT (Vlast_highlighted_extent)))
5547 /* do not recurse on descendants. Only one extent is highlighted
5549 extent_changed_for_redisplay (XEXTENT (Vlast_highlighted_extent), 0, 0);
5551 Vlast_highlighted_extent = Qnil;
5552 if (!NILP (extent_obj)
5553 && BUFFERP (extent_object (XEXTENT (extent_obj)))
5556 extent_changed_for_redisplay (XEXTENT (extent_obj), 0, 0);
5557 Vlast_highlighted_extent = extent_obj;
5561 DEFUN ("force-highlight-extent", Fforce_highlight_extent, 1, 2, 0, /*
5562 Highlight or unhighlight the given extent.
5563 If the second arg is non-nil, it will be highlighted, else dehighlighted.
5564 This is the same as `highlight-extent', except that it will work even
5565 on extents without the `mouse-face' property.
5567 (extent, highlight_p))
5572 XSETEXTENT (extent, decode_extent (extent, DE_MUST_BE_ATTACHED));
5573 do_highlight (extent, !NILP (highlight_p));
5577 DEFUN ("highlight-extent", Fhighlight_extent, 1, 2, 0, /*
5578 Highlight EXTENT, if it is highlightable.
5579 \(that is, if it has the `mouse-face' property).
5580 If the second arg is non-nil, it will be highlighted, else dehighlighted.
5581 Highlighted extents are displayed as if they were merged with the face
5582 or faces specified by the `mouse-face' property.
5584 (extent, highlight_p))
5586 if (EXTENTP (extent) && NILP (extent_mouse_face (XEXTENT (extent))))
5589 return Fforce_highlight_extent (extent, highlight_p);
5593 /************************************************************************/
5594 /* strings and extents */
5595 /************************************************************************/
5597 /* copy/paste hooks */
5600 run_extent_copy_paste_internal (EXTENT e, Bufpos from, Bufpos to,
5604 /* This function can GC */
5606 Lisp_Object copy_fn;
5607 XSETEXTENT (extent, e);
5608 copy_fn = Fextent_property (extent, prop, Qnil);
5609 if (!NILP (copy_fn))
5612 struct gcpro gcpro1, gcpro2, gcpro3;
5613 GCPRO3 (extent, copy_fn, object);
5614 if (BUFFERP (object))
5615 flag = call3_in_buffer (XBUFFER (object), copy_fn, extent,
5616 make_int (from), make_int (to));
5618 flag = call3 (copy_fn, extent, make_int (from), make_int (to));
5620 if (NILP (flag) || !EXTENT_LIVE_P (XEXTENT (extent)))
5627 run_extent_copy_function (EXTENT e, Bytind from, Bytind to)
5629 Lisp_Object object = extent_object (e);
5630 /* This function can GC */
5631 return run_extent_copy_paste_internal
5632 (e, buffer_or_string_bytind_to_bufpos (object, from),
5633 buffer_or_string_bytind_to_bufpos (object, to), object,
5638 run_extent_paste_function (EXTENT e, Bytind from, Bytind to,
5641 /* This function can GC */
5642 return run_extent_copy_paste_internal
5643 (e, buffer_or_string_bytind_to_bufpos (object, from),
5644 buffer_or_string_bytind_to_bufpos (object, to), object,
5649 update_extent (EXTENT extent, Bytind from, Bytind to)
5651 set_extent_endpoints (extent, from, to, Qnil);
5654 /* Insert an extent, usually from the dup_list of a string which
5655 has just been inserted.
5656 This code does not handle the case of undo.
5659 insert_extent (EXTENT extent, Bytind new_start, Bytind new_end,
5660 Lisp_Object object, int run_hooks)
5662 /* This function can GC */
5665 if (!EQ (extent_object (extent), object))
5668 if (extent_detached_p (extent))
5671 !run_extent_paste_function (extent, new_start, new_end, object))
5672 /* The paste-function said don't re-attach this extent here. */
5675 update_extent (extent, new_start, new_end);
5679 Bytind exstart = extent_endpoint_bytind (extent, 0);
5680 Bytind exend = extent_endpoint_bytind (extent, 1);
5682 if (exend < new_start || exstart > new_end)
5686 new_start = min (exstart, new_start);
5687 new_end = max (exend, new_end);
5688 if (exstart != new_start || exend != new_end)
5689 update_extent (extent, new_start, new_end);
5693 XSETEXTENT (tmp, extent);
5698 !run_extent_paste_function (extent, new_start, new_end, object))
5699 /* The paste-function said don't attach a copy of the extent here. */
5703 XSETEXTENT (tmp, copy_extent (extent, new_start, new_end, object));
5708 DEFUN ("insert-extent", Finsert_extent, 1, 5, 0, /*
5709 Insert EXTENT from START to END in BUFFER-OR-STRING.
5710 BUFFER-OR-STRING defaults to the current buffer if omitted.
5711 This operation does not insert any characters,
5712 but otherwise acts as if there were a replicating extent whose
5713 parent is EXTENT in some string that was just inserted.
5714 Returns the newly-inserted extent.
5715 The fourth arg, NO-HOOKS, can be used to inhibit the running of the
5716 extent's `paste-function' property if it has one.
5717 See documentation on `detach-extent' for a discussion of undo recording.
5719 (extent, start, end, no_hooks, buffer_or_string))
5721 EXTENT ext = decode_extent (extent, 0);
5725 buffer_or_string = decode_buffer_or_string (buffer_or_string);
5726 get_buffer_or_string_range_byte (buffer_or_string, start, end, &s, &e,
5727 GB_ALLOW_PAST_ACCESSIBLE);
5729 copy = insert_extent (ext, s, e, buffer_or_string, NILP (no_hooks));
5732 if (extent_duplicable_p (XEXTENT (copy)))
5733 record_extent (copy, 1);
5739 /* adding buffer extents to a string */
5741 struct add_string_extents_arg
5749 add_string_extents_mapper (EXTENT extent, void *arg)
5751 /* This function can GC */
5752 struct add_string_extents_arg *closure =
5753 (struct add_string_extents_arg *) arg;
5754 Bytecount start = extent_endpoint_bytind (extent, 0) - closure->from;
5755 Bytecount end = extent_endpoint_bytind (extent, 1) - closure->from;
5757 if (extent_duplicable_p (extent))
5759 start = max (start, 0);
5760 end = min (end, closure->length);
5762 /* Run the copy-function to give an extent the option of
5763 not being copied into the string (or kill ring).
5765 if (extent_duplicable_p (extent) &&
5766 !run_extent_copy_function (extent, start + closure->from,
5767 end + closure->from))
5769 copy_extent (extent, start, end, closure->string);
5775 /* Add the extents in buffer BUF from OPOINT to OPOINT+LENGTH to
5776 the string STRING. */
5778 add_string_extents (Lisp_Object string, struct buffer *buf, Bytind opoint,
5781 /* This function can GC */
5782 struct add_string_extents_arg closure;
5783 struct gcpro gcpro1, gcpro2;
5786 closure.from = opoint;
5787 closure.length = length;
5788 closure.string = string;
5789 buffer = make_buffer (buf);
5790 GCPRO2 (buffer, string);
5791 map_extents_bytind (opoint, opoint + length, add_string_extents_mapper,
5792 (void *) &closure, buffer, 0,
5793 /* ignore extents that just abut the region */
5794 ME_END_CLOSED | ME_ALL_EXTENTS_OPEN |
5795 /* we are calling E-Lisp (the extent's copy function)
5796 so anything might happen */
5797 ME_MIGHT_CALL_ELISP);
5801 struct splice_in_string_extents_arg
5810 splice_in_string_extents_mapper (EXTENT extent, void *arg)
5812 /* This function can GC */
5813 struct splice_in_string_extents_arg *closure =
5814 (struct splice_in_string_extents_arg *) arg;
5815 /* BASE_START and BASE_END are the limits in the buffer of the string
5816 that was just inserted.
5818 NEW_START and NEW_END are the prospective buffer positions of the
5819 extent that is going into the buffer. */
5820 Bytind base_start = closure->opoint;
5821 Bytind base_end = base_start + closure->length;
5822 Bytind new_start = (base_start + extent_endpoint_bytind (extent, 0) -
5824 Bytind new_end = (base_start + extent_endpoint_bytind (extent, 1) -
5827 if (new_start < base_start)
5828 new_start = base_start;
5829 if (new_end > base_end)
5831 if (new_end <= new_start)
5834 if (!extent_duplicable_p (extent))
5838 !run_extent_paste_function (extent, new_start, new_end,
5841 copy_extent (extent, new_start, new_end, closure->buffer);
5846 /* We have just inserted a section of STRING (starting at POS, of
5847 length LENGTH) into buffer BUF at OPOINT. Do whatever is necessary
5848 to get the string's extents into the buffer. */
5851 splice_in_string_extents (Lisp_Object string, struct buffer *buf,
5852 Bytind opoint, Bytecount length, Bytecount pos)
5854 struct splice_in_string_extents_arg closure;
5855 struct gcpro gcpro1, gcpro2;
5858 buffer = make_buffer (buf);
5859 closure.opoint = opoint;
5861 closure.length = length;
5862 closure.buffer = buffer;
5863 GCPRO2 (buffer, string);
5864 map_extents_bytind (pos, pos + length,
5865 splice_in_string_extents_mapper,
5866 (void *) &closure, string, 0,
5867 /* ignore extents that just abut the region */
5868 ME_END_CLOSED | ME_ALL_EXTENTS_OPEN |
5869 /* we are calling E-Lisp (the extent's copy function)
5870 so anything might happen */
5871 ME_MIGHT_CALL_ELISP);
5875 struct copy_string_extents_arg
5880 Lisp_Object new_string;
5883 struct copy_string_extents_1_arg
5885 Lisp_Object parent_in_question;
5886 EXTENT found_extent;
5890 copy_string_extents_mapper (EXTENT extent, void *arg)
5892 struct copy_string_extents_arg *closure =
5893 (struct copy_string_extents_arg *) arg;
5894 Bytecount old_start, old_end, new_start, new_end;
5896 old_start = extent_endpoint_bytind (extent, 0);
5897 old_end = extent_endpoint_bytind (extent, 1);
5899 old_start = max (closure->old_pos, old_start);
5900 old_end = min (closure->old_pos + closure->length, old_end);
5902 if (old_start >= old_end)
5905 new_start = old_start + closure->new_pos - closure->old_pos;
5906 new_end = old_end + closure->new_pos - closure->old_pos;
5908 copy_extent (extent, new_start, new_end, closure->new_string);
5912 /* The string NEW_STRING was partially constructed from OLD_STRING.
5913 In particular, the section of length LEN starting at NEW_POS in
5914 NEW_STRING came from the section of the same length starting at
5915 OLD_POS in OLD_STRING. Copy the extents as appropriate. */
5918 copy_string_extents (Lisp_Object new_string, Lisp_Object old_string,
5919 Bytecount new_pos, Bytecount old_pos,
5922 struct copy_string_extents_arg closure;
5923 struct gcpro gcpro1, gcpro2;
5925 closure.new_pos = new_pos;
5926 closure.old_pos = old_pos;
5927 closure.new_string = new_string;
5928 closure.length = length;
5929 GCPRO2 (new_string, old_string);
5930 map_extents_bytind (old_pos, old_pos + length,
5931 copy_string_extents_mapper,
5932 (void *) &closure, old_string, 0,
5933 /* ignore extents that just abut the region */
5934 ME_END_CLOSED | ME_ALL_EXTENTS_OPEN |
5935 /* we are calling E-Lisp (the extent's copy function)
5936 so anything might happen */
5937 ME_MIGHT_CALL_ELISP);
5941 /* Checklist for sanity checking:
5942 - {kill, yank, copy} at {open, closed} {start, end} of {writable, read-only} extent
5943 - {kill, copy} & yank {once, repeatedly} duplicable extent in {same, different} buffer
5947 /************************************************************************/
5948 /* text properties */
5949 /************************************************************************/
5952 Originally this stuff was implemented in lisp (all of the functionality
5953 exists to make that possible) but speed was a problem.
5956 Lisp_Object Qtext_prop;
5957 Lisp_Object Qtext_prop_extent_paste_function;
5960 get_text_property_bytind (Bytind position, Lisp_Object prop,
5961 Lisp_Object object, enum extent_at_flag fl,
5962 int text_props_only)
5966 /* text_props_only specifies whether we only consider text-property
5967 extents (those with the 'text-prop property set) or all extents. */
5968 if (!text_props_only)
5969 extent = extent_at_bytind (position, object, prop, 0, fl);
5975 extent = extent_at_bytind (position, object, Qtext_prop, prior,
5979 if (EQ (prop, Fextent_property (extent, Qtext_prop, Qnil)))
5981 prior = XEXTENT (extent);
5986 return Fextent_property (extent, prop, Qnil);
5987 if (!NILP (Vdefault_text_properties))
5988 return Fplist_get (Vdefault_text_properties, prop, Qnil);
5993 get_text_property_1 (Lisp_Object pos, Lisp_Object prop, Lisp_Object object,
5994 Lisp_Object at_flag, int text_props_only)
5999 object = decode_buffer_or_string (object);
6000 position = get_buffer_or_string_pos_byte (object, pos, GB_NO_ERROR_IF_BAD);
6002 /* We canonicalize the start/end-open/closed properties to the
6003 non-default version -- "adding" the default property really
6004 needs to remove the non-default one. See below for more
6006 if (EQ (prop, Qstart_closed))
6012 if (EQ (prop, Qend_open))
6020 get_text_property_bytind (position, prop, object,
6021 decode_extent_at_flag (at_flag),
6024 val = NILP (val) ? Qt : Qnil;
6029 DEFUN ("get-text-property", Fget_text_property, 2, 4, 0, /*
6030 Return the value of the PROP property at the given position.
6031 Optional arg OBJECT specifies the buffer or string to look in, and
6032 defaults to the current buffer.
6033 Optional arg AT-FLAG controls what it means for a property to be "at"
6034 a position, and has the same meaning as in `extent-at'.
6035 This examines only those properties added with `put-text-property'.
6036 See also `get-char-property'.
6038 (pos, prop, object, at_flag))
6040 return get_text_property_1 (pos, prop, object, at_flag, 1);
6043 DEFUN ("get-char-property", Fget_char_property, 2, 4, 0, /*
6044 Return the value of the PROP property at the given position.
6045 Optional arg OBJECT specifies the buffer or string to look in, and
6046 defaults to the current buffer.
6047 Optional arg AT-FLAG controls what it means for a property to be "at"
6048 a position, and has the same meaning as in `extent-at'.
6049 This examines properties on all extents.
6050 See also `get-text-property'.
6052 (pos, prop, object, at_flag))
6054 return get_text_property_1 (pos, prop, object, at_flag, 0);
6057 /* About start/end-open/closed:
6059 These properties have to be handled specially because of their
6060 strange behavior. If I put the "start-open" property on a region,
6061 then *all* text-property extents in the region have to have their
6062 start be open. This is unlike all other properties, which don't
6063 affect the extents of text properties other than their own.
6067 1) We have to map start-closed to (not start-open) and end-open
6068 to (not end-closed) -- i.e. adding the default is really the
6069 same as remove the non-default property. It won't work, for
6070 example, to have both "start-open" and "start-closed" on
6072 2) Whenever we add one of these properties, we go through all
6073 text-property extents in the region and set the appropriate
6074 open/closedness on them.
6075 3) Whenever we change a text-property extent for a property,
6076 we have to make sure we set the open/closedness properly.
6078 (2) and (3) together rely on, and maintain, the invariant
6079 that the open/closedness of text-property extents is correct
6080 at the beginning and end of each operation.
6083 struct put_text_prop_arg
6085 Lisp_Object prop, value; /* The property and value we are storing */
6086 Bytind start, end; /* The region into which we are storing it */
6088 Lisp_Object the_extent; /* Our chosen extent; this is used for
6089 communication between subsequent passes. */
6090 int changed_p; /* Output: whether we have modified anything */
6094 put_text_prop_mapper (EXTENT e, void *arg)
6096 struct put_text_prop_arg *closure = (struct put_text_prop_arg *) arg;
6098 Lisp_Object object = closure->object;
6099 Lisp_Object value = closure->value;
6100 Bytind e_start, e_end;
6101 Bytind start = closure->start;
6102 Bytind end = closure->end;
6103 Lisp_Object extent, e_val;
6106 XSETEXTENT (extent, e);
6108 /* Note: in some cases when the property itself is 'start-open
6109 or 'end-closed, the checks to set the openness may do a bit
6110 of extra work; but it won't hurt because we then fix up the
6111 openness later on in put_text_prop_openness_mapper(). */
6112 if (!EQ (Fextent_property (extent, Qtext_prop, Qnil), closure->prop))
6113 /* It's not for this property; do nothing. */
6116 e_start = extent_endpoint_bytind (e, 0);
6117 e_end = extent_endpoint_bytind (e, 1);
6118 e_val = Fextent_property (extent, closure->prop, Qnil);
6119 is_eq = EQ (value, e_val);
6121 if (!NILP (value) && NILP (closure->the_extent) && is_eq)
6123 /* We want there to be an extent here at the end, and we haven't picked
6124 one yet, so use this one. Extend it as necessary. We only reuse an
6125 extent which has an EQ value for the prop in question to avoid
6126 side-effecting the kill ring (that is, we never change the property
6127 on an extent after it has been created.)
6129 if (e_start != start || e_end != end)
6131 Bytind new_start = min (e_start, start);
6132 Bytind new_end = max (e_end, end);
6133 set_extent_endpoints (e, new_start, new_end, Qnil);
6134 /* If we changed the endpoint, then we need to set its
6136 set_extent_openness (e, new_start != e_start
6137 ? !NILP (get_text_property_bytind
6138 (start, Qstart_open, object,
6139 EXTENT_AT_AFTER, 1)) : -1,
6141 ? NILP (get_text_property_bytind
6142 (end - 1, Qend_closed, object,
6143 EXTENT_AT_AFTER, 1))
6145 closure->changed_p = 1;
6147 closure->the_extent = extent;
6150 /* Even if we're adding a prop, at this point, we want all other extents of
6151 this prop to go away (as now they overlap). So the theory here is that,
6152 when we are adding a prop to a region that has multiple (disjoint)
6153 occurrences of that prop in it already, we pick one of those and extend
6154 it, and remove the others.
6157 else if (EQ (extent, closure->the_extent))
6159 /* just in case map-extents hits it again (does that happen?) */
6162 else if (e_start >= start && e_end <= end)
6164 /* Extent is contained in region; remove it. Don't destroy or modify
6165 it, because we don't want to change the attributes pointed to by the
6166 duplicates in the kill ring.
6169 closure->changed_p = 1;
6171 else if (!NILP (closure->the_extent) &&
6176 EXTENT te = XEXTENT (closure->the_extent);
6177 /* This extent overlaps, and has the same prop/value as the extent we've
6178 decided to reuse, so we can remove this existing extent as well (the
6179 whole thing, even the part outside of the region) and extend
6180 the-extent to cover it, resulting in the minimum number of extents in
6183 Bytind the_start = extent_endpoint_bytind (te, 0);
6184 Bytind the_end = extent_endpoint_bytind (te, 1);
6185 if (e_start != the_start && /* note AND not OR -- hmm, why is this
6186 the case? I think it's because the
6187 assumption that the text-property
6188 extents don't overlap makes it
6189 OK; changing it to an OR would
6190 result in changed_p sometimes getting
6191 falsely marked. Is this bad? */
6194 Bytind new_start = min (e_start, the_start);
6195 Bytind new_end = max (e_end, the_end);
6196 set_extent_endpoints (te, new_start, new_end, Qnil);
6197 /* If we changed the endpoint, then we need to set its
6198 openness. We are setting the endpoint to be the same as
6199 that of the extent we're about to remove, and we assume
6200 (the invariant mentioned above) that extent has the
6201 proper endpoint setting, so we just use it. */
6202 set_extent_openness (te, new_start != e_start ?
6203 (int) extent_start_open_p (e) : -1,
6205 (int) extent_end_open_p (e) : -1);
6206 closure->changed_p = 1;
6210 else if (e_end <= end)
6212 /* Extent begins before start but ends before end, so we can just
6213 decrease its end position.
6217 set_extent_endpoints (e, e_start, start, Qnil);
6218 set_extent_openness (e, -1, NILP (get_text_property_bytind
6219 (start - 1, Qend_closed, object,
6220 EXTENT_AT_AFTER, 1)));
6221 closure->changed_p = 1;
6224 else if (e_start >= start)
6226 /* Extent ends after end but begins after start, so we can just
6227 increase its start position.
6231 set_extent_endpoints (e, end, e_end, Qnil);
6232 set_extent_openness (e, !NILP (get_text_property_bytind
6233 (end, Qstart_open, object,
6234 EXTENT_AT_AFTER, 1)), -1);
6235 closure->changed_p = 1;
6240 /* Otherwise, `extent' straddles the region. We need to split it.
6242 set_extent_endpoints (e, e_start, start, Qnil);
6243 set_extent_openness (e, -1, NILP (get_text_property_bytind
6244 (start - 1, Qend_closed, object,
6245 EXTENT_AT_AFTER, 1)));
6246 set_extent_openness (copy_extent (e, end, e_end, extent_object (e)),
6247 !NILP (get_text_property_bytind
6248 (end, Qstart_open, object,
6249 EXTENT_AT_AFTER, 1)), -1);
6250 closure->changed_p = 1;
6253 return 0; /* to continue mapping. */
6257 put_text_prop_openness_mapper (EXTENT e, void *arg)
6259 struct put_text_prop_arg *closure = (struct put_text_prop_arg *) arg;
6260 Bytind e_start, e_end;
6261 Bytind start = closure->start;
6262 Bytind end = closure->end;
6264 XSETEXTENT (extent, e);
6265 e_start = extent_endpoint_bytind (e, 0);
6266 e_end = extent_endpoint_bytind (e, 1);
6268 if (NILP (Fextent_property (extent, Qtext_prop, Qnil)))
6270 /* It's not a text-property extent; do nothing. */
6273 /* Note end conditions and NILP/!NILP's carefully. */
6274 else if (EQ (closure->prop, Qstart_open)
6275 && e_start >= start && e_start < end)
6276 set_extent_openness (e, !NILP (closure->value), -1);
6277 else if (EQ (closure->prop, Qend_closed)
6278 && e_end > start && e_end <= end)
6279 set_extent_openness (e, -1, NILP (closure->value));
6281 return 0; /* to continue mapping. */
6285 put_text_prop (Bytind start, Bytind end, Lisp_Object object,
6286 Lisp_Object prop, Lisp_Object value,
6289 /* This function can GC */
6290 struct put_text_prop_arg closure;
6292 if (start == end) /* There are no characters in the region. */
6295 /* convert to the non-default versions, since a nil property is
6296 the same as it not being present. */
6297 if (EQ (prop, Qstart_closed))
6300 value = NILP (value) ? Qt : Qnil;
6302 else if (EQ (prop, Qend_open))
6305 value = NILP (value) ? Qt : Qnil;
6308 value = canonicalize_extent_property (prop, value);
6310 closure.prop = prop;
6311 closure.value = value;
6312 closure.start = start;
6314 closure.object = object;
6315 closure.changed_p = 0;
6316 closure.the_extent = Qnil;
6318 map_extents_bytind (start, end,
6319 put_text_prop_mapper,
6320 (void *) &closure, object, 0,
6321 /* get all extents that abut the region */
6322 ME_ALL_EXTENTS_CLOSED | ME_END_CLOSED |
6323 /* it might QUIT or error if the user has
6324 fucked with the extent plist. */
6325 /* #### dmoore - I think this should include
6326 ME_MIGHT_MOVE_SOE, since the callback function
6327 might recurse back into map_extents_bytind. */
6329 ME_MIGHT_MODIFY_EXTENTS);
6331 /* If we made it through the loop without reusing an extent
6332 (and we want there to be one) make it now.
6334 if (!NILP (value) && NILP (closure.the_extent))
6338 XSETEXTENT (extent, make_extent_internal (object, start, end));
6339 closure.changed_p = 1;
6340 Fset_extent_property (extent, Qtext_prop, prop);
6341 Fset_extent_property (extent, prop, value);
6344 extent_duplicable_p (XEXTENT (extent)) = 1;
6345 Fset_extent_property (extent, Qpaste_function,
6346 Qtext_prop_extent_paste_function);
6348 set_extent_openness (XEXTENT (extent),
6349 !NILP (get_text_property_bytind
6350 (start, Qstart_open, object,
6351 EXTENT_AT_AFTER, 1)),
6352 NILP (get_text_property_bytind
6353 (end - 1, Qend_closed, object,
6354 EXTENT_AT_AFTER, 1)));
6357 if (EQ (prop, Qstart_open) || EQ (prop, Qend_closed))
6359 map_extents_bytind (start, end,
6360 put_text_prop_openness_mapper,
6361 (void *) &closure, object, 0,
6362 /* get all extents that abut the region */
6363 ME_ALL_EXTENTS_CLOSED | ME_END_CLOSED |
6364 ME_MIGHT_MODIFY_EXTENTS);
6367 return closure.changed_p;
6370 DEFUN ("put-text-property", Fput_text_property, 4, 5, 0, /*
6371 Adds the given property/value to all characters in the specified region.
6372 The property is conceptually attached to the characters rather than the
6373 region. The properties are copied when the characters are copied/pasted.
6374 Fifth argument OBJECT is the buffer or string containing the text, and
6375 defaults to the current buffer.
6377 (start, end, prop, value, object))
6379 /* This function can GC */
6382 object = decode_buffer_or_string (object);
6383 get_buffer_or_string_range_byte (object, start, end, &s, &e, 0);
6384 put_text_prop (s, e, object, prop, value, 1);
6388 DEFUN ("put-nonduplicable-text-property", Fput_nonduplicable_text_property,
6390 Adds the given property/value to all characters in the specified region.
6391 The property is conceptually attached to the characters rather than the
6392 region, however the properties will not be copied when the characters
6394 Fifth argument OBJECT is the buffer or string containing the text, and
6395 defaults to the current buffer.
6397 (start, end, prop, value, object))
6399 /* This function can GC */
6402 object = decode_buffer_or_string (object);
6403 get_buffer_or_string_range_byte (object, start, end, &s, &e, 0);
6404 put_text_prop (s, e, object, prop, value, 0);
6408 DEFUN ("add-text-properties", Fadd_text_properties, 3, 4, 0, /*
6409 Add properties to the characters from START to END.
6410 The third argument PROPS is a property list specifying the property values
6411 to add. The optional fourth argument, OBJECT, is the buffer or string
6412 containing the text and defaults to the current buffer. Returns t if
6413 any property was changed, nil otherwise.
6415 (start, end, props, object))
6417 /* This function can GC */
6421 object = decode_buffer_or_string (object);
6422 get_buffer_or_string_range_byte (object, start, end, &s, &e, 0);
6424 for (; !NILP (props); props = Fcdr (Fcdr (props)))
6426 Lisp_Object prop = XCAR (props);
6427 Lisp_Object value = Fcar (XCDR (props));
6428 changed |= put_text_prop (s, e, object, prop, value, 1);
6430 return changed ? Qt : Qnil;
6434 DEFUN ("add-nonduplicable-text-properties", Fadd_nonduplicable_text_properties,
6436 Add nonduplicable properties to the characters from START to END.
6437 \(The properties will not be copied when the characters are copied.)
6438 The third argument PROPS is a property list specifying the property values
6439 to add. The optional fourth argument, OBJECT, is the buffer or string
6440 containing the text and defaults to the current buffer. Returns t if
6441 any property was changed, nil otherwise.
6443 (start, end, props, object))
6445 /* This function can GC */
6449 object = decode_buffer_or_string (object);
6450 get_buffer_or_string_range_byte (object, start, end, &s, &e, 0);
6452 for (; !NILP (props); props = Fcdr (Fcdr (props)))
6454 Lisp_Object prop = XCAR (props);
6455 Lisp_Object value = Fcar (XCDR (props));
6456 changed |= put_text_prop (s, e, object, prop, value, 0);
6458 return changed ? Qt : Qnil;
6461 DEFUN ("remove-text-properties", Fremove_text_properties, 3, 4, 0, /*
6462 Remove the given properties from all characters in the specified region.
6463 PROPS should be a plist, but the values in that plist are ignored (treated
6464 as nil). Returns t if any property was changed, nil otherwise.
6465 Fourth argument OBJECT is the buffer or string containing the text, and
6466 defaults to the current buffer.
6468 (start, end, props, object))
6470 /* This function can GC */
6474 object = decode_buffer_or_string (object);
6475 get_buffer_or_string_range_byte (object, start, end, &s, &e, 0);
6477 for (; !NILP (props); props = Fcdr (Fcdr (props)))
6479 Lisp_Object prop = XCAR (props);
6480 changed |= put_text_prop (s, e, object, prop, Qnil, 1);
6482 return changed ? Qt : Qnil;
6485 /* Whenever a text-prop extent is pasted into a buffer (via `yank' or `insert'
6486 or whatever) we attach the properties to the buffer by calling
6487 `put-text-property' instead of by simply allowing the extent to be copied or
6488 re-attached. Then we return nil, telling the extents code not to attach it
6489 again. By handing the insertion hackery in this way, we make kill/yank
6490 behave consistently with put-text-property and not fragment the extents
6491 (since text-prop extents must partition, not overlap).
6493 The lisp implementation of this was probably fast enough, but since I moved
6494 the rest of the put-text-prop code here, I moved this as well for
6497 DEFUN ("text-prop-extent-paste-function", Ftext_prop_extent_paste_function,
6499 Used as the `paste-function' property of `text-prop' extents.
6503 /* This function can GC */
6504 Lisp_Object prop, val;
6506 prop = Fextent_property (extent, Qtext_prop, Qnil);
6508 signal_simple_error ("Internal error: no text-prop", extent);
6509 val = Fextent_property (extent, prop, Qnil);
6511 /* removed by bill perry, 2/9/97
6512 ** This little bit of code would not allow you to have a text property
6513 ** with a value of Qnil. This is bad bad bad.
6516 signal_simple_error_2 ("Internal error: no text-prop",
6519 Fput_text_property (from, to, prop, val, Qnil);
6520 return Qnil; /* important! */
6523 /* This function could easily be written in Lisp but the C code wants
6524 to use it in connection with invisible extents (at least currently).
6525 If this changes, consider moving this back into Lisp. */
6527 DEFUN ("next-single-property-change", Fnext_single_property_change,
6529 Return the position of next property change for a specific property.
6530 Scans characters forward from POS till it finds a change in the PROP
6531 property, then returns the position of the change. The optional third
6532 argument OBJECT is the buffer or string to scan (defaults to the current
6534 The property values are compared with `eq'.
6535 Return nil if the property is constant all the way to the end of BUFFER.
6536 If the value is non-nil, it is a position greater than POS, never equal.
6538 If the optional fourth argument LIMIT is non-nil, don't search
6539 past position LIMIT; return LIMIT if nothing is found before LIMIT.
6540 If two or more extents with conflicting non-nil values for PROP overlap
6541 a particular character, it is undefined which value is considered to be
6542 the value of PROP. (Note that this situation will not happen if you always
6543 use the text-property primitives.)
6545 (pos, prop, object, limit))
6549 Lisp_Object extent, value;
6552 object = decode_buffer_or_string (object);
6553 bpos = get_buffer_or_string_pos_char (object, pos, 0);
6556 blim = buffer_or_string_accessible_end_char (object);
6561 blim = get_buffer_or_string_pos_char (object, limit, 0);
6565 extent = Fextent_at (make_int (bpos), object, prop, Qnil, Qnil);
6567 value = Fextent_property (extent, prop, Qnil);
6573 bpos = XINT (Fnext_extent_change (make_int (bpos), object));
6575 break; /* property is the same all the way to the end */
6576 extent = Fextent_at (make_int (bpos), object, prop, Qnil, Qnil);
6577 if ((NILP (extent) && !NILP (value)) ||
6578 (!NILP (extent) && !EQ (value,
6579 Fextent_property (extent, prop, Qnil))))
6580 return make_int (bpos);
6583 /* I think it's more sensible for this function to return nil always
6584 in this situation and it used to do it this way, but it's been changed
6585 for FSF compatibility. */
6589 return make_int (blim);
6592 /* See comment on previous function about why this is written in C. */
6594 DEFUN ("previous-single-property-change", Fprevious_single_property_change,
6596 Return the position of next property change for a specific property.
6597 Scans characters backward from POS till it finds a change in the PROP
6598 property, then returns the position of the change. The optional third
6599 argument OBJECT is the buffer or string to scan (defaults to the current
6601 The property values are compared with `eq'.
6602 Return nil if the property is constant all the way to the start of BUFFER.
6603 If the value is non-nil, it is a position less than POS, never equal.
6605 If the optional fourth argument LIMIT is non-nil, don't search back
6606 past position LIMIT; return LIMIT if nothing is found until LIMIT.
6607 If two or more extents with conflicting non-nil values for PROP overlap
6608 a particular character, it is undefined which value is considered to be
6609 the value of PROP. (Note that this situation will not happen if you always
6610 use the text-property primitives.)
6612 (pos, prop, object, limit))
6616 Lisp_Object extent, value;
6619 object = decode_buffer_or_string (object);
6620 bpos = get_buffer_or_string_pos_char (object, pos, 0);
6623 blim = buffer_or_string_accessible_begin_char (object);
6628 blim = get_buffer_or_string_pos_char (object, limit, 0);
6632 /* extent-at refers to the character AFTER bpos, but we want the
6633 character before bpos. Thus the - 1. extent-at simply
6634 returns nil on bogus positions, so not to worry. */
6635 extent = Fextent_at (make_int (bpos - 1), object, prop, Qnil, Qnil);
6637 value = Fextent_property (extent, prop, Qnil);
6643 bpos = XINT (Fprevious_extent_change (make_int (bpos), object));
6645 break; /* property is the same all the way to the beginning */
6646 extent = Fextent_at (make_int (bpos - 1), object, prop, Qnil, Qnil);
6647 if ((NILP (extent) && !NILP (value)) ||
6648 (!NILP (extent) && !EQ (value,
6649 Fextent_property (extent, prop, Qnil))))
6650 return make_int (bpos);
6653 /* I think it's more sensible for this function to return nil always
6654 in this situation and it used to do it this way, but it's been changed
6655 for FSF compatibility. */
6659 return make_int (blim);
6662 #ifdef MEMORY_USAGE_STATS
6665 compute_buffer_extent_usage (struct buffer *b, struct overhead_stats *ovstats)
6667 /* #### not yet written */
6671 #endif /* MEMORY_USAGE_STATS */
6674 /************************************************************************/
6675 /* initialization */
6676 /************************************************************************/
6679 syms_of_extents (void)
6681 defsymbol (&Qextentp, "extentp");
6682 defsymbol (&Qextent_live_p, "extent-live-p");
6684 defsymbol (&Qall_extents_closed, "all-extents-closed");
6685 defsymbol (&Qall_extents_open, "all-extents-open");
6686 defsymbol (&Qall_extents_closed_open, "all-extents-closed-open");
6687 defsymbol (&Qall_extents_open_closed, "all-extents-open-closed");
6688 defsymbol (&Qstart_in_region, "start-in-region");
6689 defsymbol (&Qend_in_region, "end-in-region");
6690 defsymbol (&Qstart_and_end_in_region, "start-and-end-in-region");
6691 defsymbol (&Qstart_or_end_in_region, "start-or-end-in-region");
6692 defsymbol (&Qnegate_in_region, "negate-in-region");
6694 defsymbol (&Qdetached, "detached");
6695 defsymbol (&Qdestroyed, "destroyed");
6696 defsymbol (&Qbegin_glyph, "begin-glyph");
6697 defsymbol (&Qend_glyph, "end-glyph");
6698 defsymbol (&Qstart_open, "start-open");
6699 defsymbol (&Qend_open, "end-open");
6700 defsymbol (&Qstart_closed, "start-closed");
6701 defsymbol (&Qend_closed, "end-closed");
6702 defsymbol (&Qread_only, "read-only");
6703 /* defsymbol (&Qhighlight, "highlight"); in faces.c */
6704 defsymbol (&Qunique, "unique");
6705 defsymbol (&Qduplicable, "duplicable");
6706 defsymbol (&Qdetachable, "detachable");
6707 defsymbol (&Qpriority, "priority");
6708 defsymbol (&Qmouse_face, "mouse-face");
6709 defsymbol (&Qinitial_redisplay_function,"initial-redisplay-function");
6712 defsymbol (&Qglyph_layout, "glyph-layout"); /* backwards compatibility */
6713 defsymbol (&Qbegin_glyph_layout, "begin-glyph-layout");
6714 defsymbol (&Qend_glyph_layout, "end-glyph-layout");
6715 defsymbol (&Qoutside_margin, "outside-margin");
6716 defsymbol (&Qinside_margin, "inside-margin");
6717 defsymbol (&Qwhitespace, "whitespace");
6718 /* Qtext defined in general.c */
6720 defsymbol (&Qpaste_function, "paste-function");
6721 defsymbol (&Qcopy_function, "copy-function");
6723 defsymbol (&Qtext_prop, "text-prop");
6724 defsymbol (&Qtext_prop_extent_paste_function,
6725 "text-prop-extent-paste-function");
6728 DEFSUBR (Fextent_live_p);
6729 DEFSUBR (Fextent_detached_p);
6730 DEFSUBR (Fextent_start_position);
6731 DEFSUBR (Fextent_end_position);
6732 DEFSUBR (Fextent_object);
6733 DEFSUBR (Fextent_length);
6735 DEFSUBR (Fmake_extent);
6736 DEFSUBR (Fcopy_extent);
6737 DEFSUBR (Fdelete_extent);
6738 DEFSUBR (Fdetach_extent);
6739 DEFSUBR (Fset_extent_endpoints);
6740 DEFSUBR (Fnext_extent);
6741 DEFSUBR (Fprevious_extent);
6743 DEFSUBR (Fnext_e_extent);
6744 DEFSUBR (Fprevious_e_extent);
6746 DEFSUBR (Fnext_extent_change);
6747 DEFSUBR (Fprevious_extent_change);
6749 DEFSUBR (Fextent_parent);
6750 DEFSUBR (Fextent_children);
6751 DEFSUBR (Fset_extent_parent);
6753 DEFSUBR (Fextent_in_region_p);
6754 DEFSUBR (Fmap_extents);
6755 DEFSUBR (Fmap_extent_children);
6756 DEFSUBR (Fextent_at);
6758 DEFSUBR (Fset_extent_initial_redisplay_function);
6759 DEFSUBR (Fextent_face);
6760 DEFSUBR (Fset_extent_face);
6761 DEFSUBR (Fextent_mouse_face);
6762 DEFSUBR (Fset_extent_mouse_face);
6763 DEFSUBR (Fset_extent_begin_glyph);
6764 DEFSUBR (Fset_extent_end_glyph);
6765 DEFSUBR (Fextent_begin_glyph);
6766 DEFSUBR (Fextent_end_glyph);
6767 DEFSUBR (Fset_extent_begin_glyph_layout);
6768 DEFSUBR (Fset_extent_end_glyph_layout);
6769 DEFSUBR (Fextent_begin_glyph_layout);
6770 DEFSUBR (Fextent_end_glyph_layout);
6771 DEFSUBR (Fset_extent_priority);
6772 DEFSUBR (Fextent_priority);
6773 DEFSUBR (Fset_extent_property);
6774 DEFSUBR (Fset_extent_properties);
6775 DEFSUBR (Fextent_property);
6776 DEFSUBR (Fextent_properties);
6778 DEFSUBR (Fhighlight_extent);
6779 DEFSUBR (Fforce_highlight_extent);
6781 DEFSUBR (Finsert_extent);
6783 DEFSUBR (Fget_text_property);
6784 DEFSUBR (Fget_char_property);
6785 DEFSUBR (Fput_text_property);
6786 DEFSUBR (Fput_nonduplicable_text_property);
6787 DEFSUBR (Fadd_text_properties);
6788 DEFSUBR (Fadd_nonduplicable_text_properties);
6789 DEFSUBR (Fremove_text_properties);
6790 DEFSUBR (Ftext_prop_extent_paste_function);
6791 DEFSUBR (Fnext_single_property_change);
6792 DEFSUBR (Fprevious_single_property_change);
6796 reinit_vars_of_extents (void)
6798 extent_auxiliary_defaults.begin_glyph = Qnil;
6799 extent_auxiliary_defaults.end_glyph = Qnil;
6800 extent_auxiliary_defaults.parent = Qnil;
6801 extent_auxiliary_defaults.children = Qnil;
6802 extent_auxiliary_defaults.priority = 0;
6803 extent_auxiliary_defaults.invisible = Qnil;
6804 extent_auxiliary_defaults.read_only = Qnil;
6805 extent_auxiliary_defaults.mouse_face = Qnil;
6806 extent_auxiliary_defaults.initial_redisplay_function = Qnil;
6807 extent_auxiliary_defaults.before_change_functions = Qnil;
6808 extent_auxiliary_defaults.after_change_functions = Qnil;
6812 vars_of_extents (void)
6814 reinit_vars_of_extents ();
6816 DEFVAR_INT ("mouse-highlight-priority", &mouse_highlight_priority /*
6817 The priority to use for the mouse-highlighting pseudo-extent
6818 that is used to highlight extents with the `mouse-face' attribute set.
6819 See `set-extent-priority'.
6821 /* Set mouse-highlight-priority (which ends up being used both for the
6822 mouse-highlighting pseudo-extent and the primary selection extent)
6823 to a very high value because very few extents should override it.
6824 1000 gives lots of room below it for different-prioritized extents.
6825 10 doesn't. ediff, for example, likes to use priorities around 100.
6827 mouse_highlight_priority = /* 10 */ 1000;
6829 DEFVAR_LISP ("default-text-properties", &Vdefault_text_properties /*
6830 Property list giving default values for text properties.
6831 Whenever a character does not specify a value for a property, the value
6832 stored in this list is used instead. This only applies when the
6833 functions `get-text-property' or `get-char-property' are called.
6835 Vdefault_text_properties = Qnil;
6837 staticpro (&Vlast_highlighted_extent);
6838 Vlast_highlighted_extent = Qnil;
6840 Vextent_face_reusable_list = Fcons (Qnil, Qnil);
6841 staticpro (&Vextent_face_reusable_list);
6845 complex_vars_of_extents (void)
6847 staticpro (&Vextent_face_memoize_hash_table);
6848 /* The memoize hash table maps from lists of symbols to lists of
6849 faces. It needs to be `equal' to implement the memoization.
6850 The reverse table maps in the other direction and just needs
6851 to do `eq' comparison because the lists of faces are already
6853 Vextent_face_memoize_hash_table =
6854 make_lisp_hash_table (100, HASH_TABLE_VALUE_WEAK, HASH_TABLE_EQUAL);
6855 staticpro (&Vextent_face_reverse_memoize_hash_table);
6856 Vextent_face_reverse_memoize_hash_table =
6857 make_lisp_hash_table (100, HASH_TABLE_KEY_WEAK, HASH_TABLE_EQ);