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"
232 /* ------------------------------- */
234 /* ------------------------------- */
236 /* Note that this object is not extent-specific and should perhaps be
237 moved into another file. */
239 /* Holds a marker that moves as elements in the array are inserted and
240 deleted, similar to standard markers. */
242 typedef struct gap_array_marker
245 struct gap_array_marker *next;
248 /* Holds a "gap array", which is an array of elements with a gap located
249 in it. Insertions and deletions with a high degree of locality
250 are very fast, essentially in constant time. Array positions as
251 used and returned in the gap array functions are independent of
254 typedef struct gap_array
261 Gap_Array_Marker *markers;
264 static Gap_Array_Marker *gap_array_marker_freelist;
266 /* Convert a "memory position" (i.e. taking the gap into account) into
267 the address of the element at (i.e. after) that position. "Memory
268 positions" are only used internally and are of type Memind.
269 "Array positions" are used externally and are of type int. */
270 #define GAP_ARRAY_MEMEL_ADDR(ga, memel) ((ga)->array + (ga)->elsize*(memel))
272 /* Number of elements currently in a gap array */
273 #define GAP_ARRAY_NUM_ELS(ga) ((ga)->numels)
275 #define GAP_ARRAY_ARRAY_TO_MEMORY_POS(ga, pos) \
276 ((pos) <= (ga)->gap ? (pos) : (pos) + (ga)->gapsize)
278 #define GAP_ARRAY_MEMORY_TO_ARRAY_POS(ga, pos) \
279 ((pos) <= (ga)->gap ? (pos) : (pos) - (ga)->gapsize)
281 /* Convert an array position into the address of the element at
282 (i.e. after) that position. */
283 #define GAP_ARRAY_EL_ADDR(ga, pos) ((pos) < (ga)->gap ? \
284 GAP_ARRAY_MEMEL_ADDR(ga, pos) : \
285 GAP_ARRAY_MEMEL_ADDR(ga, (pos) + (ga)->gapsize))
287 /* ------------------------------- */
289 /* ------------------------------- */
291 typedef struct extent_list_marker
295 struct extent_list_marker *next;
296 } Extent_List_Marker;
298 typedef struct extent_list
302 Extent_List_Marker *markers;
305 static Extent_List_Marker *extent_list_marker_freelist;
307 #define EXTENT_LESS_VALS(e,st,nd) ((extent_start (e) < (st)) || \
308 ((extent_start (e) == (st)) && \
309 (extent_end (e) > (nd))))
311 #define EXTENT_EQUAL_VALS(e,st,nd) ((extent_start (e) == (st)) && \
312 (extent_end (e) == (nd)))
314 #define EXTENT_LESS_EQUAL_VALS(e,st,nd) ((extent_start (e) < (st)) || \
315 ((extent_start (e) == (st)) && \
316 (extent_end (e) >= (nd))))
318 /* Is extent E1 less than extent E2 in the display order? */
319 #define EXTENT_LESS(e1,e2) \
320 EXTENT_LESS_VALS (e1, extent_start (e2), extent_end (e2))
322 /* Is extent E1 equal to extent E2? */
323 #define EXTENT_EQUAL(e1,e2) \
324 EXTENT_EQUAL_VALS (e1, extent_start (e2), extent_end (e2))
326 /* Is extent E1 less than or equal to extent E2 in the display order? */
327 #define EXTENT_LESS_EQUAL(e1,e2) \
328 EXTENT_LESS_EQUAL_VALS (e1, extent_start (e2), extent_end (e2))
330 #define EXTENT_E_LESS_VALS(e,st,nd) ((extent_end (e) < (nd)) || \
331 ((extent_end (e) == (nd)) && \
332 (extent_start (e) > (st))))
334 #define EXTENT_E_LESS_EQUAL_VALS(e,st,nd) ((extent_end (e) < (nd)) || \
335 ((extent_end (e) == (nd)) && \
336 (extent_start (e) >= (st))))
338 /* Is extent E1 less than extent E2 in the e-order? */
339 #define EXTENT_E_LESS(e1,e2) \
340 EXTENT_E_LESS_VALS(e1, extent_start (e2), extent_end (e2))
342 /* Is extent E1 less than or equal to extent E2 in the e-order? */
343 #define EXTENT_E_LESS_EQUAL(e1,e2) \
344 EXTENT_E_LESS_EQUAL_VALS (e1, extent_start (e2), extent_end (e2))
346 #define EXTENT_GAP_ARRAY_AT(ga, pos) (* (EXTENT *) GAP_ARRAY_EL_ADDR(ga, pos))
348 /* ------------------------------- */
349 /* auxiliary extent structure */
350 /* ------------------------------- */
352 struct extent_auxiliary extent_auxiliary_defaults;
354 /* ------------------------------- */
355 /* buffer-extent primitives */
356 /* ------------------------------- */
358 typedef struct stack_of_extents
360 Extent_List *extents;
361 Memind pos; /* Position of stack of extents. EXTENTS is the list of
362 all extents that overlap this position. This position
363 can be -1 if the stack of extents is invalid (this
364 happens when a buffer is first created or a string's
365 stack of extents is created [a string's stack of extents
366 is nuked when a GC occurs, to conserve memory]). */
369 /* ------------------------------- */
371 /* ------------------------------- */
373 typedef int Endpoint_Index;
375 #define memind_to_startind(x, start_open) \
376 ((Endpoint_Index) (((x) << 1) + !!(start_open)))
377 #define memind_to_endind(x, end_open) \
378 ((Endpoint_Index) (((x) << 1) - !!(end_open)))
380 /* Combination macros */
381 #define bytind_to_startind(buf, x, start_open) \
382 memind_to_startind (bytind_to_memind (buf, x), start_open)
383 #define bytind_to_endind(buf, x, end_open) \
384 memind_to_endind (bytind_to_memind (buf, x), end_open)
386 /* ------------------------------- */
387 /* buffer-or-string primitives */
388 /* ------------------------------- */
390 /* Similar for Bytinds and start/end indices. */
392 #define buffer_or_string_bytind_to_startind(obj, ind, start_open) \
393 memind_to_startind (buffer_or_string_bytind_to_memind (obj, ind), \
396 #define buffer_or_string_bytind_to_endind(obj, ind, end_open) \
397 memind_to_endind (buffer_or_string_bytind_to_memind (obj, ind), \
400 /* ------------------------------- */
401 /* Lisp-level functions */
402 /* ------------------------------- */
404 /* flags for decode_extent() */
405 #define DE_MUST_HAVE_BUFFER 1
406 #define DE_MUST_BE_ATTACHED 2
408 Lisp_Object Vlast_highlighted_extent;
409 int mouse_highlight_priority;
411 Lisp_Object Qextentp;
412 Lisp_Object Qextent_live_p;
414 Lisp_Object Qall_extents_closed;
415 Lisp_Object Qall_extents_open;
416 Lisp_Object Qall_extents_closed_open;
417 Lisp_Object Qall_extents_open_closed;
418 Lisp_Object Qstart_in_region;
419 Lisp_Object Qend_in_region;
420 Lisp_Object Qstart_and_end_in_region;
421 Lisp_Object Qstart_or_end_in_region;
422 Lisp_Object Qnegate_in_region;
424 Lisp_Object Qdetached;
425 Lisp_Object Qdestroyed;
426 Lisp_Object Qbegin_glyph;
427 Lisp_Object Qend_glyph;
428 Lisp_Object Qstart_open;
429 Lisp_Object Qend_open;
430 Lisp_Object Qstart_closed;
431 Lisp_Object Qend_closed;
432 Lisp_Object Qread_only;
433 /* Qhighlight defined in general.c */
435 Lisp_Object Qduplicable;
436 Lisp_Object Qdetachable;
437 Lisp_Object Qpriority;
438 Lisp_Object Qmouse_face;
439 Lisp_Object Qinitial_redisplay_function;
441 Lisp_Object Qglyph_layout; /* This exists only for backwards compatibility. */
442 Lisp_Object Qbegin_glyph_layout, Qend_glyph_layout;
443 Lisp_Object Qoutside_margin;
444 Lisp_Object Qinside_margin;
445 Lisp_Object Qwhitespace;
446 /* Qtext defined in general.c */
448 Lisp_Object Qcopy_function;
449 Lisp_Object Qpaste_function;
451 /* The idea here is that if we're given a list of faces, we
452 need to "memoize" this so that two lists of faces that are `equal'
453 turn into the same object. When `set-extent-face' is called, we
454 "memoize" into a list of actual faces; when `extent-face' is called,
455 we do a reverse lookup to get the list of symbols. */
457 static Lisp_Object canonicalize_extent_property (Lisp_Object prop,
459 Lisp_Object Vextent_face_memoize_hash_table;
460 Lisp_Object Vextent_face_reverse_memoize_hash_table;
461 Lisp_Object Vextent_face_reusable_list;
462 /* FSFmacs bogosity */
463 Lisp_Object Vdefault_text_properties;
465 EXFUN (Fextent_properties, 1);
466 EXFUN (Fset_extent_property, 3);
468 /* if true, we don't want to set any redisplay flags on modeline extent
470 int in_modeline_generation;
473 /************************************************************************/
474 /* Generalized gap array */
475 /************************************************************************/
477 /* This generalizes the "array with a gap" model used to store buffer
478 characters. This is based on the stuff in insdel.c and should
479 probably be merged with it. This is not extent-specific and should
480 perhaps be moved into a separate file. */
482 /* ------------------------------- */
483 /* internal functions */
484 /* ------------------------------- */
486 /* Adjust the gap array markers in the range (FROM, TO]. Parallel to
487 adjust_markers() in insdel.c. */
490 gap_array_adjust_markers (Gap_Array *ga, Memind from,
491 Memind to, int amount)
495 for (m = ga->markers; m; m = m->next)
496 m->pos = do_marker_adjustment (m->pos, from, to, amount);
499 /* Move the gap to array position POS. Parallel to move_gap() in
500 insdel.c but somewhat simplified. */
503 gap_array_move_gap (Gap_Array *ga, int pos)
506 int gapsize = ga->gapsize;
511 memmove (GAP_ARRAY_MEMEL_ADDR (ga, pos + gapsize),
512 GAP_ARRAY_MEMEL_ADDR (ga, pos),
513 (gap - pos)*ga->elsize);
514 gap_array_adjust_markers (ga, (Memind) pos, (Memind) gap,
519 memmove (GAP_ARRAY_MEMEL_ADDR (ga, gap),
520 GAP_ARRAY_MEMEL_ADDR (ga, gap + gapsize),
521 (pos - gap)*ga->elsize);
522 gap_array_adjust_markers (ga, (Memind) (gap + gapsize),
523 (Memind) (pos + gapsize), - gapsize);
528 /* Make the gap INCREMENT characters longer. Parallel to make_gap() in
532 gap_array_make_gap (Gap_Array *ga, int increment)
534 char *ptr = ga->array;
538 /* If we have to get more space, get enough to last a while. We use
539 a geometric progression that saves on realloc space. */
540 increment += 100 + ga->numels / 8;
542 ptr = (char *) xrealloc (ptr,
543 (ga->numels + ga->gapsize + increment)*ga->elsize);
548 real_gap_loc = ga->gap;
549 old_gap_size = ga->gapsize;
551 /* Call the newly allocated space a gap at the end of the whole space. */
552 ga->gap = ga->numels + ga->gapsize;
553 ga->gapsize = increment;
555 /* Move the new gap down to be consecutive with the end of the old one.
556 This adjusts the markers properly too. */
557 gap_array_move_gap (ga, real_gap_loc + old_gap_size);
559 /* Now combine the two into one large gap. */
560 ga->gapsize += old_gap_size;
561 ga->gap = real_gap_loc;
564 /* ------------------------------- */
565 /* external functions */
566 /* ------------------------------- */
568 /* Insert NUMELS elements (pointed to by ELPTR) into the specified
572 gap_array_insert_els (Gap_Array *ga, int pos, void *elptr, int numels)
574 assert (pos >= 0 && pos <= ga->numels);
575 if (ga->gapsize < numels)
576 gap_array_make_gap (ga, numels - ga->gapsize);
578 gap_array_move_gap (ga, pos);
580 memcpy (GAP_ARRAY_MEMEL_ADDR (ga, ga->gap), (char *) elptr,
582 ga->gapsize -= numels;
584 ga->numels += numels;
585 /* This is the equivalent of insert-before-markers.
587 #### Should only happen if marker is "moves forward at insert" type.
590 gap_array_adjust_markers (ga, pos - 1, pos, numels);
593 /* Delete NUMELS elements from the specified gap array, starting at FROM. */
596 gap_array_delete_els (Gap_Array *ga, int from, int numdel)
598 int to = from + numdel;
599 int gapsize = ga->gapsize;
602 assert (numdel >= 0);
603 assert (to <= ga->numels);
605 /* Make sure the gap is somewhere in or next to what we are deleting. */
607 gap_array_move_gap (ga, to);
609 gap_array_move_gap (ga, from);
611 /* Relocate all markers pointing into the new, larger gap
612 to point at the end of the text before the gap. */
613 gap_array_adjust_markers (ga, to + gapsize, to + gapsize,
616 ga->gapsize += numdel;
617 ga->numels -= numdel;
621 static Gap_Array_Marker *
622 gap_array_make_marker (Gap_Array *ga, int pos)
626 assert (pos >= 0 && pos <= ga->numels);
627 if (gap_array_marker_freelist)
629 m = gap_array_marker_freelist;
630 gap_array_marker_freelist = gap_array_marker_freelist->next;
633 m = xnew (Gap_Array_Marker);
635 m->pos = GAP_ARRAY_ARRAY_TO_MEMORY_POS (ga, pos);
636 m->next = ga->markers;
642 gap_array_delete_marker (Gap_Array *ga, Gap_Array_Marker *m)
644 Gap_Array_Marker *p, *prev;
646 for (prev = 0, p = ga->markers; p && p != m; prev = p, p = p->next)
650 prev->next = p->next;
652 ga->markers = p->next;
653 m->next = gap_array_marker_freelist;
654 m->pos = 0xDEADBEEF; /* -559038737 as an int */
655 gap_array_marker_freelist = m;
659 gap_array_delete_all_markers (Gap_Array *ga)
661 Gap_Array_Marker *p, *next;
663 for (p = ga->markers; p; p = next)
666 p->next = gap_array_marker_freelist;
667 p->pos = 0xDEADBEEF; /* -559038737 as an int */
668 gap_array_marker_freelist = p;
673 gap_array_move_marker (Gap_Array *ga, Gap_Array_Marker *m, int pos)
675 assert (pos >= 0 && pos <= ga->numels);
676 m->pos = GAP_ARRAY_ARRAY_TO_MEMORY_POS (ga, pos);
679 #define gap_array_marker_pos(ga, m) \
680 GAP_ARRAY_MEMORY_TO_ARRAY_POS (ga, (m)->pos)
683 make_gap_array (int elsize)
685 Gap_Array *ga = xnew_and_zero (Gap_Array);
691 free_gap_array (Gap_Array *ga)
695 gap_array_delete_all_markers (ga);
700 /************************************************************************/
701 /* Extent list primitives */
702 /************************************************************************/
704 /* A list of extents is maintained as a double gap array: one gap array
705 is ordered by start index (the "display order") and the other is
706 ordered by end index (the "e-order"). Note that positions in an
707 extent list should logically be conceived of as referring *to*
708 a particular extent (as is the norm in programs) rather than
709 sitting between two extents. Note also that callers of these
710 functions should not be aware of the fact that the extent list is
711 implemented as an array, except for the fact that positions are
712 integers (this should be generalized to handle integers and linked
716 /* Number of elements in an extent list */
717 #define extent_list_num_els(el) GAP_ARRAY_NUM_ELS(el->start)
719 /* Return the position at which EXTENT is located in the specified extent
720 list (in the display order if ENDP is 0, in the e-order otherwise).
721 If the extent is not found, the position where the extent would
722 be inserted is returned. If ENDP is 0, the insertion would go after
723 all other equal extents. If ENDP is not 0, the insertion would go
724 before all other equal extents. If FOUNDP is not 0, then whether
725 the extent was found will get written into it. */
728 extent_list_locate (Extent_List *el, EXTENT extent, int endp, int *foundp)
730 Gap_Array *ga = endp ? el->end : el->start;
731 int left = 0, right = GAP_ARRAY_NUM_ELS (ga);
732 int oldfoundpos, foundpos;
735 while (left != right)
737 /* RIGHT might not point to a valid extent (i.e. it's at the end
738 of the list), so NEWPOS must round down. */
739 unsigned int newpos = (left + right) >> 1;
740 EXTENT e = EXTENT_GAP_ARRAY_AT (ga, (int) newpos);
742 if (endp ? EXTENT_E_LESS (e, extent) : EXTENT_LESS (e, extent))
748 /* Now we're at the beginning of all equal extents. */
750 oldfoundpos = foundpos = left;
751 while (foundpos < GAP_ARRAY_NUM_ELS (ga))
753 EXTENT e = EXTENT_GAP_ARRAY_AT (ga, foundpos);
759 if (!EXTENT_EQUAL (e, extent))
771 /* Return the position of the first extent that begins at or after POS
772 (or ends at or after POS, if ENDP is not 0).
774 An out-of-range value for POS is allowed, and guarantees that the
775 position at the beginning or end of the extent list is returned. */
778 extent_list_locate_from_pos (Extent_List *el, Memind pos, int endp)
780 struct extent fake_extent;
783 Note that if we search for [POS, POS], then we get the following:
785 -- if ENDP is 0, then all extents whose start position is <= POS
786 lie before the returned position, and all extents whose start
787 position is > POS lie at or after the returned position.
789 -- if ENDP is not 0, then all extents whose end position is < POS
790 lie before the returned position, and all extents whose end
791 position is >= POS lie at or after the returned position.
794 set_extent_start (&fake_extent, endp ? pos : pos-1);
795 set_extent_end (&fake_extent, endp ? pos : pos-1);
796 return extent_list_locate (el, &fake_extent, endp, 0);
799 /* Return the extent at POS. */
802 extent_list_at (Extent_List *el, Memind pos, int endp)
804 Gap_Array *ga = endp ? el->end : el->start;
806 assert (pos >= 0 && pos < GAP_ARRAY_NUM_ELS (ga));
807 return EXTENT_GAP_ARRAY_AT (ga, pos);
810 /* Insert an extent into an extent list. */
813 extent_list_insert (Extent_List *el, EXTENT extent)
817 pos = extent_list_locate (el, extent, 0, &foundp);
819 gap_array_insert_els (el->start, pos, &extent, 1);
820 pos = extent_list_locate (el, extent, 1, &foundp);
822 gap_array_insert_els (el->end, pos, &extent, 1);
825 /* Delete an extent from an extent list. */
828 extent_list_delete (Extent_List *el, EXTENT extent)
832 pos = extent_list_locate (el, extent, 0, &foundp);
834 gap_array_delete_els (el->start, pos, 1);
835 pos = extent_list_locate (el, extent, 1, &foundp);
837 gap_array_delete_els (el->end, pos, 1);
841 extent_list_delete_all (Extent_List *el)
843 gap_array_delete_els (el->start, 0, GAP_ARRAY_NUM_ELS (el->start));
844 gap_array_delete_els (el->end, 0, GAP_ARRAY_NUM_ELS (el->end));
847 static Extent_List_Marker *
848 extent_list_make_marker (Extent_List *el, int pos, int endp)
850 Extent_List_Marker *m;
852 if (extent_list_marker_freelist)
854 m = extent_list_marker_freelist;
855 extent_list_marker_freelist = extent_list_marker_freelist->next;
858 m = xnew (Extent_List_Marker);
860 m->m = gap_array_make_marker (endp ? el->end : el->start, pos);
862 m->next = el->markers;
867 #define extent_list_move_marker(el, mkr, pos) \
868 gap_array_move_marker((mkr)->endp ? (el)->end : (el)->start, (mkr)->m, pos)
871 extent_list_delete_marker (Extent_List *el, Extent_List_Marker *m)
873 Extent_List_Marker *p, *prev;
875 for (prev = 0, p = el->markers; p && p != m; prev = p, p = p->next)
879 prev->next = p->next;
881 el->markers = p->next;
882 m->next = extent_list_marker_freelist;
883 extent_list_marker_freelist = m;
884 gap_array_delete_marker (m->endp ? el->end : el->start, m->m);
887 #define extent_list_marker_pos(el, mkr) \
888 gap_array_marker_pos ((mkr)->endp ? (el)->end : (el)->start, (mkr)->m)
891 allocate_extent_list (void)
893 Extent_List *el = xnew (Extent_List);
894 el->start = make_gap_array (sizeof (EXTENT));
895 el->end = make_gap_array (sizeof (EXTENT));
901 free_extent_list (Extent_List *el)
903 free_gap_array (el->start);
904 free_gap_array (el->end);
909 /************************************************************************/
910 /* Auxiliary extent structure */
911 /************************************************************************/
914 mark_extent_auxiliary (Lisp_Object obj)
916 struct extent_auxiliary *data = XEXTENT_AUXILIARY (obj);
917 mark_object (data->begin_glyph);
918 mark_object (data->end_glyph);
919 mark_object (data->invisible);
920 mark_object (data->children);
921 mark_object (data->read_only);
922 mark_object (data->mouse_face);
923 mark_object (data->initial_redisplay_function);
924 mark_object (data->before_change_functions);
925 mark_object (data->after_change_functions);
929 DEFINE_LRECORD_IMPLEMENTATION ("extent-auxiliary", extent_auxiliary,
930 mark_extent_auxiliary, internal_object_printer,
931 0, 0, 0, 0, struct extent_auxiliary);
934 allocate_extent_auxiliary (EXTENT ext)
936 Lisp_Object extent_aux;
937 struct extent_auxiliary *data =
938 alloc_lcrecord_type (struct extent_auxiliary, &lrecord_extent_auxiliary);
940 copy_lcrecord (data, &extent_auxiliary_defaults);
941 XSETEXTENT_AUXILIARY (extent_aux, data);
942 ext->plist = Fcons (extent_aux, ext->plist);
943 ext->flags.has_aux = 1;
947 /************************************************************************/
948 /* Extent info structure */
949 /************************************************************************/
951 /* An extent-info structure consists of a list of the buffer or string's
952 extents and a "stack of extents" that lists all of the extents over
953 a particular position. The stack-of-extents info is used for
954 optimization purposes -- it basically caches some info that might
955 be expensive to compute. Certain otherwise hard computations are easy
956 given the stack of extents over a particular position, and if the
957 stack of extents over a nearby position is known (because it was
958 calculated at some prior point in time), it's easy to move the stack
959 of extents to the proper position.
961 Given that the stack of extents is an optimization, and given that
962 it requires memory, a string's stack of extents is wiped out each
963 time a garbage collection occurs. Therefore, any time you retrieve
964 the stack of extents, it might not be there. If you need it to
965 be there, use the _force version.
967 Similarly, a string may or may not have an extent_info structure.
968 (Generally it won't if there haven't been any extents added to the
969 string.) So use the _force version if you need the extent_info
970 structure to be there. */
972 static struct stack_of_extents *allocate_soe (void);
973 static void free_soe (struct stack_of_extents *soe);
974 static void soe_invalidate (Lisp_Object obj);
977 mark_extent_info (Lisp_Object obj)
979 struct extent_info *data = (struct extent_info *) XEXTENT_INFO (obj);
981 Extent_List *list = data->extents;
983 /* Vbuffer_defaults and Vbuffer_local_symbols are buffer-like
984 objects that are created specially and never have their extent
985 list initialized (or rather, it is set to zero in
986 nuke_all_buffer_slots()). However, these objects get
987 garbage-collected so we have to deal.
989 (Also the list can be zero when we're dealing with a destroyed
994 for (i = 0; i < extent_list_num_els (list); i++)
996 struct extent *extent = extent_list_at (list, i, 0);
999 XSETEXTENT (exobj, extent);
1000 mark_object (exobj);
1008 finalize_extent_info (void *header, int for_disksave)
1010 struct extent_info *data = (struct extent_info *) header;
1017 free_soe (data->soe);
1022 free_extent_list (data->extents);
1027 DEFINE_LRECORD_IMPLEMENTATION ("extent-info", extent_info,
1028 mark_extent_info, internal_object_printer,
1029 finalize_extent_info, 0, 0, 0,
1030 struct extent_info);
1033 allocate_extent_info (void)
1035 Lisp_Object extent_info;
1036 struct extent_info *data =
1037 alloc_lcrecord_type (struct extent_info, &lrecord_extent_info);
1039 XSETEXTENT_INFO (extent_info, data);
1040 data->extents = allocate_extent_list ();
1046 flush_cached_extent_info (Lisp_Object extent_info)
1048 struct extent_info *data = XEXTENT_INFO (extent_info);
1052 free_soe (data->soe);
1058 /************************************************************************/
1059 /* Buffer/string extent primitives */
1060 /************************************************************************/
1062 /* The functions in this section are the ONLY ones that should know
1063 about the internal implementation of the extent lists. Other functions
1064 should only know that there are two orderings on extents, the "display"
1065 order (sorted by start position, basically) and the e-order (sorted
1066 by end position, basically), and that certain operations are provided
1067 to manipulate the list. */
1069 /* ------------------------------- */
1070 /* basic primitives */
1071 /* ------------------------------- */
1074 decode_buffer_or_string (Lisp_Object object)
1077 XSETBUFFER (object, current_buffer);
1078 else if (BUFFERP (object))
1079 CHECK_LIVE_BUFFER (object);
1080 else if (STRINGP (object))
1083 dead_wrong_type_argument (Qbuffer_or_string_p, object);
1089 extent_ancestor_1 (EXTENT e)
1091 while (e->flags.has_parent)
1093 /* There should be no circularities except in case of a logic
1094 error somewhere in the extent code */
1095 e = XEXTENT (XEXTENT_AUXILIARY (XCAR (e->plist))->parent);
1100 /* Given an extent object (string or buffer or nil), return its extent info.
1101 This may be 0 for a string. */
1103 static struct extent_info *
1104 buffer_or_string_extent_info (Lisp_Object object)
1106 if (STRINGP (object))
1108 Lisp_Object plist = XSTRING (object)->plist;
1109 if (!CONSP (plist) || !EXTENT_INFOP (XCAR (plist)))
1111 return XEXTENT_INFO (XCAR (plist));
1113 else if (NILP (object))
1116 return XEXTENT_INFO (XBUFFER (object)->extent_info);
1119 /* Given a string or buffer, return its extent list. This may be
1122 static Extent_List *
1123 buffer_or_string_extent_list (Lisp_Object object)
1125 struct extent_info *info = buffer_or_string_extent_info (object);
1129 return info->extents;
1132 /* Given a string or buffer, return its extent info. If it's not there,
1135 static struct extent_info *
1136 buffer_or_string_extent_info_force (Lisp_Object object)
1138 struct extent_info *info = buffer_or_string_extent_info (object);
1142 Lisp_Object extent_info;
1144 assert (STRINGP (object)); /* should never happen for buffers --
1145 the only buffers without an extent
1146 info are those after finalization,
1147 destroyed buffers, or special
1148 Lisp-inaccessible buffer objects. */
1149 extent_info = allocate_extent_info ();
1150 XSTRING (object)->plist = Fcons (extent_info, XSTRING (object)->plist);
1151 return XEXTENT_INFO (extent_info);
1157 /* Detach all the extents in OBJECT. Called from redisplay. */
1160 detach_all_extents (Lisp_Object object)
1162 struct extent_info *data = buffer_or_string_extent_info (object);
1170 for (i = 0; i < extent_list_num_els (data->extents); i++)
1172 EXTENT e = extent_list_at (data->extents, i, 0);
1173 /* No need to do detach_extent(). Just nuke the damn things,
1174 which results in the equivalent but faster. */
1175 set_extent_start (e, -1);
1176 set_extent_end (e, -1);
1180 /* But we need to clear all the lists containing extents or
1181 havoc will result. */
1182 extent_list_delete_all (data->extents);
1183 soe_invalidate (object);
1189 init_buffer_extents (struct buffer *b)
1191 b->extent_info = allocate_extent_info ();
1195 uninit_buffer_extents (struct buffer *b)
1197 struct extent_info *data = XEXTENT_INFO (b->extent_info);
1199 /* Don't destroy the extents here -- there may still be children
1200 extents pointing to the extents. */
1201 detach_all_extents (make_buffer (b));
1202 finalize_extent_info (data, 0);
1205 /* Retrieve the extent list that an extent is a member of; the
1206 return value will never be 0 except in destroyed buffers (in which
1207 case the only extents that can refer to this buffer are detached
1210 #define extent_extent_list(e) buffer_or_string_extent_list (extent_object (e))
1212 /* ------------------------------- */
1213 /* stack of extents */
1214 /* ------------------------------- */
1216 #ifdef ERROR_CHECK_EXTENTS
1219 sledgehammer_extent_check (Lisp_Object object)
1223 Extent_List *el = buffer_or_string_extent_list (object);
1224 struct buffer *buf = 0;
1229 if (BUFFERP (object))
1230 buf = XBUFFER (object);
1232 for (endp = 0; endp < 2; endp++)
1233 for (i = 1; i < extent_list_num_els (el); i++)
1235 EXTENT e1 = extent_list_at (el, i-1, endp);
1236 EXTENT e2 = extent_list_at (el, i, endp);
1239 assert (extent_start (e1) <= buf->text->gpt ||
1240 extent_start (e1) > buf->text->gpt + buf->text->gap_size);
1241 assert (extent_end (e1) <= buf->text->gpt ||
1242 extent_end (e1) > buf->text->gpt + buf->text->gap_size);
1244 assert (extent_start (e1) <= extent_end (e1));
1245 assert (endp ? (EXTENT_E_LESS_EQUAL (e1, e2)) :
1246 (EXTENT_LESS_EQUAL (e1, e2)));
1252 static Stack_Of_Extents *
1253 buffer_or_string_stack_of_extents (Lisp_Object object)
1255 struct extent_info *info = buffer_or_string_extent_info (object);
1261 static Stack_Of_Extents *
1262 buffer_or_string_stack_of_extents_force (Lisp_Object object)
1264 struct extent_info *info = buffer_or_string_extent_info_force (object);
1266 info->soe = allocate_soe ();
1270 /* #define SOE_DEBUG */
1274 static void print_extent_1 (char *buf, Lisp_Object extent);
1277 print_extent_2 (EXTENT e)
1282 XSETEXTENT (extent, e);
1283 print_extent_1 (buf, extent);
1284 fputs (buf, stdout);
1288 soe_dump (Lisp_Object obj)
1291 Stack_Of_Extents *soe = buffer_or_string_stack_of_extents (obj);
1301 printf ("SOE pos is %d (memind %d)\n",
1302 soe->pos < 0 ? soe->pos :
1303 buffer_or_string_memind_to_bytind (obj, soe->pos),
1305 for (endp = 0; endp < 2; endp++)
1307 printf (endp ? "SOE end:" : "SOE start:");
1308 for (i = 0; i < extent_list_num_els (sel); i++)
1310 EXTENT e = extent_list_at (sel, i, endp);
1321 /* Insert EXTENT into OBJ's stack of extents, if necessary. */
1324 soe_insert (Lisp_Object obj, EXTENT extent)
1326 Stack_Of_Extents *soe = buffer_or_string_stack_of_extents (obj);
1329 printf ("Inserting into SOE: ");
1330 print_extent_2 (extent);
1333 if (!soe || soe->pos < extent_start (extent) ||
1334 soe->pos > extent_end (extent))
1337 printf ("(not needed)\n\n");
1341 extent_list_insert (soe->extents, extent);
1343 puts ("SOE afterwards is:");
1348 /* Delete EXTENT from OBJ's stack of extents, if necessary. */
1351 soe_delete (Lisp_Object obj, EXTENT extent)
1353 Stack_Of_Extents *soe = buffer_or_string_stack_of_extents (obj);
1356 printf ("Deleting from SOE: ");
1357 print_extent_2 (extent);
1360 if (!soe || soe->pos < extent_start (extent) ||
1361 soe->pos > extent_end (extent))
1364 puts ("(not needed)\n");
1368 extent_list_delete (soe->extents, extent);
1370 puts ("SOE afterwards is:");
1375 /* Move OBJ's stack of extents to lie over the specified position. */
1378 soe_move (Lisp_Object obj, Memind pos)
1380 Stack_Of_Extents *soe = buffer_or_string_stack_of_extents_force (obj);
1381 Extent_List *sel = soe->extents;
1382 int numsoe = extent_list_num_els (sel);
1383 Extent_List *bel = buffer_or_string_extent_list (obj);
1387 #ifdef ERROR_CHECK_EXTENTS
1392 printf ("Moving SOE from %d (memind %d) to %d (memind %d)\n",
1393 soe->pos < 0 ? soe->pos :
1394 buffer_or_string_memind_to_bytind (obj, soe->pos), soe->pos,
1395 buffer_or_string_memind_to_bytind (obj, pos), pos);
1402 else if (soe->pos > pos)
1410 puts ("(not needed)\n");
1415 /* For DIRECTION = 1: Any extent that overlaps POS is either in the
1416 SOE (if the extent starts at or before SOE->POS) or is greater
1417 (in the display order) than any extent in the SOE (if it starts
1420 For DIRECTION = -1: Any extent that overlaps POS is either in the
1421 SOE (if the extent ends at or after SOE->POS) or is less (in the
1422 e-order) than any extent in the SOE (if it ends before SOE->POS).
1424 We proceed in two stages:
1426 1) delete all extents in the SOE that don't overlap POS.
1427 2) insert all extents into the SOE that start (or end, when
1428 DIRECTION = -1) in (SOE->POS, POS] and that overlap
1429 POS. (Don't include SOE->POS in the range because those
1430 extents would already be in the SOE.)
1437 /* Delete all extents in the SOE that don't overlap POS.
1438 This is all extents that end before (or start after,
1439 if DIRECTION = -1) POS.
1442 /* Deleting extents from the SOE is tricky because it changes
1443 the positions of extents. If we are deleting in the forward
1444 direction we have to call extent_list_at() on the same position
1445 over and over again because positions after the deleted element
1446 get shifted back by 1. To make life simplest, we delete forward
1447 irrespective of DIRECTION.
1455 end = extent_list_locate_from_pos (sel, pos, 1);
1459 start = extent_list_locate_from_pos (sel, pos+1, 0);
1463 for (i = start; i < end; i++)
1464 extent_list_delete (sel, extent_list_at (sel, start /* see above */,
1474 start_pos = extent_list_locate_from_pos (bel, soe->pos, endp) - 1;
1476 start_pos = extent_list_locate_from_pos (bel, soe->pos + 1, endp);
1478 for (; start_pos >= 0 && start_pos < extent_list_num_els (bel);
1479 start_pos += direction)
1481 EXTENT e = extent_list_at (bel, start_pos, endp);
1482 if ((direction > 0) ?
1483 (extent_start (e) > pos) :
1484 (extent_end (e) < pos))
1485 break; /* All further extents lie on the far side of POS
1486 and thus can't overlap. */
1487 if ((direction > 0) ?
1488 (extent_end (e) >= pos) :
1489 (extent_start (e) <= pos))
1490 extent_list_insert (sel, e);
1496 puts ("SOE afterwards is:");
1502 soe_invalidate (Lisp_Object obj)
1504 Stack_Of_Extents *soe = buffer_or_string_stack_of_extents (obj);
1508 extent_list_delete_all (soe->extents);
1513 static struct stack_of_extents *
1516 struct stack_of_extents *soe = xnew_and_zero (struct stack_of_extents);
1517 soe->extents = allocate_extent_list ();
1523 free_soe (struct stack_of_extents *soe)
1525 free_extent_list (soe->extents);
1529 /* ------------------------------- */
1530 /* other primitives */
1531 /* ------------------------------- */
1533 /* Return the start (endp == 0) or end (endp == 1) of an extent as
1534 a byte index. If you want the value as a memory index, use
1535 extent_endpoint(). If you want the value as a buffer position,
1536 use extent_endpoint_bufpos(). */
1539 extent_endpoint_bytind (EXTENT extent, int endp)
1541 assert (EXTENT_LIVE_P (extent));
1542 assert (!extent_detached_p (extent));
1544 Memind i = endp ? extent_end (extent) : extent_start (extent);
1545 Lisp_Object obj = extent_object (extent);
1546 return buffer_or_string_memind_to_bytind (obj, i);
1551 extent_endpoint_bufpos (EXTENT extent, int endp)
1553 assert (EXTENT_LIVE_P (extent));
1554 assert (!extent_detached_p (extent));
1556 Memind i = endp ? extent_end (extent) : extent_start (extent);
1557 Lisp_Object obj = extent_object (extent);
1558 return buffer_or_string_memind_to_bufpos (obj, i);
1562 /* A change to an extent occurred that will change the display, so
1563 notify redisplay. Maybe also recurse over all the extent's
1567 extent_changed_for_redisplay (EXTENT extent, int descendants_too,
1568 int invisibility_change)
1573 /* we could easily encounter a detached extent while traversing the
1574 children, but we should never be able to encounter a dead extent. */
1575 assert (EXTENT_LIVE_P (extent));
1577 if (descendants_too)
1579 Lisp_Object children = extent_children (extent);
1581 if (!NILP (children))
1583 /* first mark all of the extent's children. We will lose big-time
1584 if there are any circularities here, so we sure as hell better
1585 ensure that there aren't. */
1586 LIST_LOOP (rest, XWEAK_LIST_LIST (children))
1587 extent_changed_for_redisplay (XEXTENT (XCAR (rest)), 1,
1588 invisibility_change);
1592 /* now mark the extent itself. */
1594 object = extent_object (extent);
1596 if (extent_detached_p (extent))
1599 else if (STRINGP (object))
1601 /* #### Changes to string extents can affect redisplay if they are
1602 in the modeline or in the gutters.
1604 If the extent is in some generated-modeline-string: when we
1605 change an extent in generated-modeline-string, this changes its
1606 parent, which is in `modeline-format', so we should force the
1607 modeline to be updated. But how to determine whether a string
1608 is a `generated-modeline-string'? Looping through all buffers
1609 is not very efficient. Should we add all
1610 `generated-modeline-string' strings to a hash table? Maybe
1611 efficiency is not the greatest concern here and there's no big
1612 loss in looping over the buffers.
1614 If the extent is in a gutter we mark the gutter as
1615 changed. This means (a) we can update extents in the gutters
1616 when we need it. (b) we don't have to update the gutters when
1617 only extents attached to buffers have changed. */
1619 if (!in_modeline_generation)
1620 MARK_EXTENTS_CHANGED;
1621 gutter_extent_signal_changed_region_maybe (object,
1622 extent_endpoint_bufpos (extent, 0),
1623 extent_endpoint_bufpos (extent, 1));
1625 else if (BUFFERP (object))
1628 b = XBUFFER (object);
1629 BUF_FACECHANGE (b)++;
1630 MARK_EXTENTS_CHANGED;
1631 if (invisibility_change)
1633 buffer_extent_signal_changed_region (b,
1634 extent_endpoint_bufpos (extent, 0),
1635 extent_endpoint_bufpos (extent, 1));
1639 /* A change to an extent occurred that might affect redisplay.
1640 This is called when properties such as the endpoints, the layout,
1641 or the priority changes. Redisplay will be affected only if
1642 the extent has any displayable attributes. */
1645 extent_maybe_changed_for_redisplay (EXTENT extent, int descendants_too,
1646 int invisibility_change)
1648 /* Retrieve the ancestor for efficiency */
1649 EXTENT anc = extent_ancestor (extent);
1650 if (!NILP (extent_face (anc)) ||
1651 !NILP (extent_begin_glyph (anc)) ||
1652 !NILP (extent_end_glyph (anc)) ||
1653 !NILP (extent_mouse_face (anc)) ||
1654 !NILP (extent_invisible (anc)) ||
1655 !NILP (extent_initial_redisplay_function (anc)) ||
1656 invisibility_change)
1657 extent_changed_for_redisplay (extent, descendants_too,
1658 invisibility_change);
1662 make_extent_detached (Lisp_Object object)
1664 EXTENT extent = allocate_extent ();
1666 assert (NILP (object) || STRINGP (object) ||
1667 (BUFFERP (object) && BUFFER_LIVE_P (XBUFFER (object))));
1668 extent_object (extent) = object;
1669 /* Now make sure the extent info exists. */
1671 buffer_or_string_extent_info_force (object);
1675 /* A "real" extent is any extent other than the internal (not-user-visible)
1676 extents used by `map-extents'. */
1679 real_extent_at_forward (Extent_List *el, int pos, int endp)
1681 for (; pos < extent_list_num_els (el); pos++)
1683 EXTENT e = extent_list_at (el, pos, endp);
1684 if (!extent_internal_p (e))
1691 real_extent_at_backward (Extent_List *el, int pos, int endp)
1693 for (; pos >= 0; pos--)
1695 EXTENT e = extent_list_at (el, pos, endp);
1696 if (!extent_internal_p (e))
1703 extent_first (Lisp_Object obj)
1705 Extent_List *el = buffer_or_string_extent_list (obj);
1709 return real_extent_at_forward (el, 0, 0);
1714 extent_e_first (Lisp_Object obj)
1716 Extent_List *el = buffer_or_string_extent_list (obj);
1720 return real_extent_at_forward (el, 0, 1);
1725 extent_next (EXTENT e)
1727 Extent_List *el = extent_extent_list (e);
1729 int pos = extent_list_locate (el, e, 0, &foundp);
1731 return real_extent_at_forward (el, pos+1, 0);
1736 extent_e_next (EXTENT e)
1738 Extent_List *el = extent_extent_list (e);
1740 int pos = extent_list_locate (el, e, 1, &foundp);
1742 return real_extent_at_forward (el, pos+1, 1);
1747 extent_last (Lisp_Object obj)
1749 Extent_List *el = buffer_or_string_extent_list (obj);
1753 return real_extent_at_backward (el, extent_list_num_els (el) - 1, 0);
1758 extent_e_last (Lisp_Object obj)
1760 Extent_List *el = buffer_or_string_extent_list (obj);
1764 return real_extent_at_backward (el, extent_list_num_els (el) - 1, 1);
1769 extent_previous (EXTENT e)
1771 Extent_List *el = extent_extent_list (e);
1773 int pos = extent_list_locate (el, e, 0, &foundp);
1775 return real_extent_at_backward (el, pos-1, 0);
1780 extent_e_previous (EXTENT e)
1782 Extent_List *el = extent_extent_list (e);
1784 int pos = extent_list_locate (el, e, 1, &foundp);
1786 return real_extent_at_backward (el, pos-1, 1);
1791 extent_attach (EXTENT extent)
1793 Extent_List *el = extent_extent_list (extent);
1795 extent_list_insert (el, extent);
1796 soe_insert (extent_object (extent), extent);
1797 /* only this extent changed */
1798 extent_maybe_changed_for_redisplay (extent, 0,
1799 !NILP (extent_invisible (extent)));
1803 extent_detach (EXTENT extent)
1807 if (extent_detached_p (extent))
1809 el = extent_extent_list (extent);
1811 /* call this before messing with the extent. */
1812 extent_maybe_changed_for_redisplay (extent, 0,
1813 !NILP (extent_invisible (extent)));
1814 extent_list_delete (el, extent);
1815 soe_delete (extent_object (extent), extent);
1816 set_extent_start (extent, -1);
1817 set_extent_end (extent, -1);
1820 /* ------------------------------- */
1821 /* map-extents et al. */
1822 /* ------------------------------- */
1824 /* Returns true iff map_extents() would visit the given extent.
1825 See the comments at map_extents() for info on the overlap rule.
1826 Assumes that all validation on the extent and buffer positions has
1827 already been performed (see Fextent_in_region_p ()).
1830 extent_in_region_p (EXTENT extent, Bytind from, Bytind to,
1833 Lisp_Object obj = extent_object (extent);
1834 Endpoint_Index start, end, exs, exe;
1835 int start_open, end_open;
1836 unsigned int all_extents_flags = flags & ME_ALL_EXTENTS_MASK;
1837 unsigned int in_region_flags = flags & ME_IN_REGION_MASK;
1840 /* A zero-length region is treated as closed-closed. */
1843 flags |= ME_END_CLOSED;
1844 flags &= ~ME_START_OPEN;
1847 /* So is a zero-length extent. */
1848 if (extent_start (extent) == extent_end (extent))
1849 start_open = 0, end_open = 0;
1850 /* `all_extents_flags' will almost always be zero. */
1851 else if (all_extents_flags == 0)
1853 start_open = extent_start_open_p (extent);
1854 end_open = extent_end_open_p (extent);
1857 switch (all_extents_flags)
1859 case ME_ALL_EXTENTS_CLOSED: start_open = 0, end_open = 0; break;
1860 case ME_ALL_EXTENTS_OPEN: start_open = 1, end_open = 1; break;
1861 case ME_ALL_EXTENTS_CLOSED_OPEN: start_open = 0, end_open = 1; break;
1862 case ME_ALL_EXTENTS_OPEN_CLOSED: start_open = 1, end_open = 0; break;
1863 default: abort(); break;
1866 start = buffer_or_string_bytind_to_startind (obj, from,
1867 flags & ME_START_OPEN);
1868 end = buffer_or_string_bytind_to_endind (obj, to, ! (flags & ME_END_CLOSED));
1869 exs = memind_to_startind (extent_start (extent), start_open);
1870 exe = memind_to_endind (extent_end (extent), end_open);
1872 /* It's easy to determine whether an extent lies *outside* the
1873 region -- just determine whether it's completely before
1874 or completely after the region. Reject all such extents, so
1875 we're now left with only the extents that overlap the region.
1878 if (exs > end || exe < start)
1881 /* See if any further restrictions are called for. */
1882 /* in_region_flags will almost always be zero. */
1883 if (in_region_flags == 0)
1886 switch (in_region_flags)
1888 case ME_START_IN_REGION:
1889 retval = start <= exs && exs <= end; break;
1890 case ME_END_IN_REGION:
1891 retval = start <= exe && exe <= end; break;
1892 case ME_START_AND_END_IN_REGION:
1893 retval = start <= exs && exe <= end; break;
1894 case ME_START_OR_END_IN_REGION:
1895 retval = (start <= exs && exs <= end) || (start <= exe && exe <= end);
1900 return flags & ME_NEGATE_IN_REGION ? !retval : retval;
1903 struct map_extents_struct
1906 Extent_List_Marker *mkr;
1911 map_extents_unwind (Lisp_Object obj)
1913 struct map_extents_struct *closure =
1914 (struct map_extents_struct *) get_opaque_ptr (obj);
1915 free_opaque_ptr (obj);
1917 extent_detach (closure->range);
1919 extent_list_delete_marker (closure->el, closure->mkr);
1923 /* This is the guts of `map-extents' and the other functions that
1924 map over extents. In theory the operation of this function is
1925 simple: just figure out what extents we're mapping over, and
1926 call the function on each one of them in the range. Unfortunately
1927 there are a wide variety of things that the mapping function
1928 might do, and we have to be very tricky to avoid getting messed
1929 up. Furthermore, this function needs to be very fast (it is
1930 called multiple times every time text is inserted or deleted
1931 from a buffer), and so we can't always afford the overhead of
1932 dealing with all the possible things that the mapping function
1933 might do; thus, there are many flags that can be specified
1934 indicating what the mapping function might or might not do.
1936 The result of all this is that this is the most complicated
1937 function in this file. Change it at your own risk!
1939 A potential simplification to the logic below is to determine
1940 all the extents that the mapping function should be called on
1941 before any calls are actually made and save them in an array.
1942 That introduces its own complications, however (the array
1943 needs to be marked for garbage-collection, and a static array
1944 cannot be used because map_extents() needs to be reentrant).
1945 Furthermore, the results might be a little less sensible than
1950 map_extents_bytind (Bytind from, Bytind to, map_extents_fun fn, void *arg,
1951 Lisp_Object obj, EXTENT after, unsigned int flags)
1953 Memind st, en; /* range we're mapping over */
1954 EXTENT range = 0; /* extent for this, if ME_MIGHT_MODIFY_TEXT */
1955 Extent_List *el = 0; /* extent list we're iterating over */
1956 Extent_List_Marker *posm = 0; /* marker for extent list,
1957 if ME_MIGHT_MODIFY_EXTENTS */
1958 /* count and struct for unwind-protect, if ME_MIGHT_THROW */
1960 struct map_extents_struct closure;
1962 #ifdef ERROR_CHECK_EXTENTS
1963 assert (from <= to);
1964 assert (from >= buffer_or_string_absolute_begin_byte (obj) &&
1965 from <= buffer_or_string_absolute_end_byte (obj) &&
1966 to >= buffer_or_string_absolute_begin_byte (obj) &&
1967 to <= buffer_or_string_absolute_end_byte (obj));
1972 assert (EQ (obj, extent_object (after)));
1973 assert (!extent_detached_p (after));
1976 el = buffer_or_string_extent_list (obj);
1977 if (!el || !extent_list_num_els(el))
1981 st = buffer_or_string_bytind_to_memind (obj, from);
1982 en = buffer_or_string_bytind_to_memind (obj, to);
1984 if (flags & ME_MIGHT_MODIFY_TEXT)
1986 /* The mapping function might change the text in the buffer,
1987 so make an internal extent to hold the range we're mapping
1989 range = make_extent_detached (obj);
1990 set_extent_start (range, st);
1991 set_extent_end (range, en);
1992 range->flags.start_open = flags & ME_START_OPEN;
1993 range->flags.end_open = !(flags & ME_END_CLOSED);
1994 range->flags.internal = 1;
1995 range->flags.detachable = 0;
1996 extent_attach (range);
1999 if (flags & ME_MIGHT_THROW)
2001 /* The mapping function might throw past us so we need to use an
2002 unwind_protect() to eliminate the internal extent and range
2004 count = specpdl_depth ();
2005 closure.range = range;
2007 record_unwind_protect (map_extents_unwind,
2008 make_opaque_ptr (&closure));
2011 /* ---------- Figure out where we start and what direction
2012 we move in. This is the trickiest part of this
2013 function. ---------- */
2015 /* If ME_START_IN_REGION, ME_END_IN_REGION or ME_START_AND_END_IN_REGION
2016 was specified and ME_NEGATE_IN_REGION was not specified, our job
2017 is simple because of the presence of the display order and e-order.
2018 (Note that theoretically do something similar for
2019 ME_START_OR_END_IN_REGION, but that would require more trickiness
2020 than it's worth to avoid hitting the same extent twice.)
2022 In the general case, all the extents that overlap a range can be
2023 divided into two classes: those whose start position lies within
2024 the range (including the range's end but not including the
2025 range's start), and those that overlap the start position,
2026 i.e. those in the SOE for the start position. Or equivalently,
2027 the extents can be divided into those whose end position lies
2028 within the range and those in the SOE for the end position. Note
2029 that for this purpose we treat both the range and all extents in
2030 the buffer as closed on both ends. If this is not what the ME_
2031 flags specified, then we've mapped over a few too many extents,
2032 but no big deal because extent_in_region_p() will filter them
2033 out. Ideally, we could move the SOE to the closer of the range's
2034 two ends and work forwards or backwards from there. However, in
2035 order to make the semantics of the AFTER argument work out, we
2036 have to always go in the same direction; so we choose to always
2037 move the SOE to the start position.
2039 When it comes time to do the SOE stage, we first call soe_move()
2040 so that the SOE gets set up. Note that the SOE might get
2041 changed while we are mapping over its contents. If we can
2042 guarantee that the SOE won't get moved to a new position, we
2043 simply need to put a marker in the SOE and we will track deletions
2044 and insertions of extents in the SOE. If the SOE might get moved,
2045 however (this would happen as a result of a recursive invocation
2046 of map-extents or a call to a redisplay-type function), then
2047 trying to track its changes is hopeless, so we just keep a
2048 marker to the first (or last) extent in the SOE and use that as
2051 Finally, if DONT_USE_SOE is defined, we don't use the SOE at all
2052 and instead just map from the beginning of the buffer. This is
2053 used for testing purposes and allows the SOE to be calculated
2054 using map_extents() instead of the other way around. */
2057 int range_flag; /* ME_*_IN_REGION subset of flags */
2058 int do_soe_stage = 0; /* Are we mapping over the SOE? */
2059 /* Does the range stage map over start or end positions? */
2061 /* If type == 0, we include the start position in the range stage mapping.
2062 If type == 1, we exclude the start position in the range stage mapping.
2063 If type == 2, we begin at range_start_pos, an extent-list position.
2065 int range_start_type = 0;
2066 int range_start_pos = 0;
2069 range_flag = flags & ME_IN_REGION_MASK;
2070 if ((range_flag == ME_START_IN_REGION ||
2071 range_flag == ME_START_AND_END_IN_REGION) &&
2072 !(flags & ME_NEGATE_IN_REGION))
2074 /* map over start position in [range-start, range-end]. No SOE
2078 else if (range_flag == ME_END_IN_REGION && !(flags & ME_NEGATE_IN_REGION))
2080 /* map over end position in [range-start, range-end]. No SOE
2086 /* Need to include the SOE extents. */
2088 /* Just brute-force it: start from the beginning. */
2090 range_start_type = 2;
2091 range_start_pos = 0;
2093 Stack_Of_Extents *soe = buffer_or_string_stack_of_extents_force (obj);
2096 /* Move the SOE to the closer end of the range. This dictates
2097 whether we map over start positions or end positions. */
2100 numsoe = extent_list_num_els (soe->extents);
2103 if (flags & ME_MIGHT_MOVE_SOE)
2106 /* Can't map over SOE, so just extend range to cover the
2108 EXTENT e = extent_list_at (soe->extents, 0, 0);
2110 extent_list_locate (buffer_or_string_extent_list (obj), e, 0,
2113 range_start_type = 2;
2117 /* We can map over the SOE. */
2119 range_start_type = 1;
2124 /* No extents in the SOE to map over, so we act just as if
2125 ME_START_IN_REGION or ME_END_IN_REGION was specified.
2126 RANGE_ENDP already specified so no need to do anything else. */
2131 /* ---------- Now loop over the extents. ---------- */
2133 /* We combine the code for the two stages because much of it
2135 for (stage = 0; stage < 2; stage++)
2137 int pos = 0; /* Position in extent list */
2139 /* First set up start conditions */
2141 { /* The SOE stage */
2144 el = buffer_or_string_stack_of_extents_force (obj)->extents;
2145 /* We will always be looping over start extents here. */
2146 assert (!range_endp);
2150 { /* The range stage */
2151 el = buffer_or_string_extent_list (obj);
2152 switch (range_start_type)
2155 pos = extent_list_locate_from_pos (el, st, range_endp);
2158 pos = extent_list_locate_from_pos (el, st + 1, range_endp);
2161 pos = range_start_pos;
2166 if (flags & ME_MIGHT_MODIFY_EXTENTS)
2168 /* Create a marker to track changes to the extent list */
2170 /* Delete the marker used in the SOE stage. */
2171 extent_list_delete_marker
2172 (buffer_or_string_stack_of_extents_force (obj)->extents, posm);
2173 posm = extent_list_make_marker (el, pos, range_endp);
2174 /* tell the unwind function about the marker. */
2185 /* ----- update position in extent list
2186 and fetch next extent ----- */
2189 /* fetch POS again to track extent insertions or deletions */
2190 pos = extent_list_marker_pos (el, posm);
2191 if (pos >= extent_list_num_els (el))
2193 e = extent_list_at (el, pos, range_endp);
2196 /* now point the marker to the next one we're going to process.
2197 This ensures graceful behavior if this extent is deleted. */
2198 extent_list_move_marker (el, posm, pos);
2200 /* ----- deal with internal extents ----- */
2202 if (extent_internal_p (e))
2204 if (!(flags & ME_INCLUDE_INTERNAL))
2206 else if (e == range)
2208 /* We're processing internal extents and we've
2209 come across our own special range extent.
2210 (This happens only in adjust_extents*() and
2211 process_extents*(), which handle text
2212 insertion and deletion.) We need to omit
2213 processing of this extent; otherwise
2214 we will probably end up prematurely
2215 terminating this loop. */
2220 /* ----- deal with AFTER condition ----- */
2224 /* if e > after, then we can stop skipping extents. */
2225 if (EXTENT_LESS (after, e))
2227 else /* otherwise, skip this extent. */
2231 /* ----- stop if we're completely outside the range ----- */
2233 /* fetch ST and EN again to track text insertions or deletions */
2236 st = extent_start (range);
2237 en = extent_end (range);
2239 if (extent_endpoint (e, range_endp) > en)
2241 /* Can't be mapping over SOE because all extents in
2242 there should overlap ST */
2243 assert (stage == 1);
2247 /* ----- Now actually call the function ----- */
2249 obj2 = extent_object (e);
2250 if (extent_in_region_p (e,
2251 buffer_or_string_memind_to_bytind (obj2,
2253 buffer_or_string_memind_to_bytind (obj2,
2259 /* Function wants us to stop mapping. */
2260 stage = 1; /* so outer for loop will terminate */
2266 /* ---------- Finished looping. ---------- */
2269 if (flags & ME_MIGHT_THROW)
2270 /* This deletes the range extent and frees the marker. */
2271 unbind_to (count, Qnil);
2274 /* Delete them ourselves */
2276 extent_detach (range);
2278 extent_list_delete_marker (el, posm);
2283 map_extents (Bufpos from, Bufpos to, map_extents_fun fn,
2284 void *arg, Lisp_Object obj, EXTENT after, unsigned int flags)
2286 map_extents_bytind (buffer_or_string_bufpos_to_bytind (obj, from),
2287 buffer_or_string_bufpos_to_bytind (obj, to), fn, arg,
2291 /* ------------------------------- */
2292 /* adjust_extents() */
2293 /* ------------------------------- */
2295 /* Add AMOUNT to all extent endpoints in the range (FROM, TO]. This
2296 happens whenever the gap is moved or (under Mule) a character in a
2297 string is substituted for a different-length one. The reason for
2298 this is that extent endpoints behave just like markers (all memory
2299 indices do) and this adjustment correct for markers -- see
2300 adjust_markers(). Note that it is important that we visit all
2301 extent endpoints in the range, irrespective of whether the
2302 endpoints are open or closed.
2304 We could use map_extents() for this (and in fact the function
2305 was originally written that way), but the gap is in an incoherent
2306 state when this function is called and this function plays
2307 around with extent endpoints without detaching and reattaching
2308 the extents (this is provably correct and saves lots of time),
2309 so for safety we make it just look at the extent lists directly. */
2312 adjust_extents (Lisp_Object obj, Memind from, Memind to, int amount)
2318 Stack_Of_Extents *soe;
2320 #ifdef ERROR_CHECK_EXTENTS
2321 sledgehammer_extent_check (obj);
2323 el = buffer_or_string_extent_list (obj);
2325 if (!el || !extent_list_num_els(el))
2328 /* IMPORTANT! Compute the starting positions of the extents to
2329 modify BEFORE doing any modification! Otherwise the starting
2330 position for the second time through the loop might get
2331 incorrectly calculated (I got bit by this bug real bad). */
2332 startpos[0] = extent_list_locate_from_pos (el, from+1, 0);
2333 startpos[1] = extent_list_locate_from_pos (el, from+1, 1);
2334 for (endp = 0; endp < 2; endp++)
2336 for (pos = startpos[endp]; pos < extent_list_num_els (el);
2339 EXTENT e = extent_list_at (el, pos, endp);
2340 if (extent_endpoint (e, endp) > to)
2342 set_extent_endpoint (e,
2343 do_marker_adjustment (extent_endpoint (e, endp),
2349 /* The index for the buffer's SOE is a memory index and thus
2350 needs to be adjusted like a marker. */
2351 soe = buffer_or_string_stack_of_extents (obj);
2352 if (soe && soe->pos >= 0)
2353 soe->pos = do_marker_adjustment (soe->pos, from, to, amount);
2356 /* ------------------------------- */
2357 /* adjust_extents_for_deletion() */
2358 /* ------------------------------- */
2360 struct adjust_extents_for_deletion_arg
2362 EXTENT_dynarr *list;
2366 adjust_extents_for_deletion_mapper (EXTENT extent, void *arg)
2368 struct adjust_extents_for_deletion_arg *closure =
2369 (struct adjust_extents_for_deletion_arg *) arg;
2371 Dynarr_add (closure->list, extent);
2372 return 0; /* continue mapping */
2375 /* For all extent endpoints in the range (FROM, TO], move them to the beginning
2376 of the new gap. Note that it is important that we visit all extent
2377 endpoints in the range, irrespective of whether the endpoints are open or
2380 This function deals with weird stuff such as the fact that extents
2383 There is no string correspondent for this because you can't
2384 delete characters from a string.
2388 adjust_extents_for_deletion (Lisp_Object object, Bytind from,
2389 Bytind to, int gapsize, int numdel,
2392 struct adjust_extents_for_deletion_arg closure;
2394 Memind adjust_to = (Memind) (to + gapsize);
2395 Bytecount amount = - numdel - movegapsize;
2396 Memind oldsoe = 0, newsoe = 0;
2397 Stack_Of_Extents *soe = buffer_or_string_stack_of_extents (object);
2399 #ifdef ERROR_CHECK_EXTENTS
2400 sledgehammer_extent_check (object);
2402 closure.list = Dynarr_new (EXTENT);
2404 /* We're going to be playing weird games below with extents and the SOE
2405 and such, so compute the list now of all the extents that we're going
2406 to muck with. If we do the mapping and adjusting together, things can
2407 get all screwed up. */
2409 map_extents_bytind (from, to, adjust_extents_for_deletion_mapper,
2410 (void *) &closure, object, 0,
2411 /* extent endpoints move like markers regardless
2412 of their open/closeness. */
2413 ME_ALL_EXTENTS_CLOSED | ME_END_CLOSED |
2414 ME_START_OR_END_IN_REGION | ME_INCLUDE_INTERNAL);
2417 Old and new values for the SOE's position. (It gets adjusted
2418 like a marker, just like extent endpoints.)
2425 newsoe = do_marker_adjustment (soe->pos,
2426 adjust_to, adjust_to,
2432 for (i = 0; i < Dynarr_length (closure.list); i++)
2434 EXTENT extent = Dynarr_at (closure.list, i);
2435 Memind new_start = extent_start (extent);
2436 Memind new_end = extent_end (extent);
2438 /* do_marker_adjustment() will not adjust values that should not be
2439 adjusted. We're passing the same funky arguments to
2440 do_marker_adjustment() as buffer_delete_range() does. */
2442 do_marker_adjustment (new_start,
2443 adjust_to, adjust_to,
2446 do_marker_adjustment (new_end,
2447 adjust_to, adjust_to,
2450 /* We need to be very careful here so that the SOE doesn't get
2451 corrupted. We are shrinking extents out of the deleted region
2452 and simultaneously moving the SOE's pos out of the deleted
2453 region, so the SOE should contain the same extents at the end
2454 as at the beginning. However, extents may get reordered
2455 by this process, so we have to operate by pulling the extents
2456 out of the buffer and SOE, changing their bounds, and then
2457 reinserting them. In order for the SOE not to get screwed up,
2458 we have to make sure that the SOE's pos points to its old
2459 location whenever we pull an extent out, and points to its
2460 new location whenever we put the extent back in.
2463 if (new_start != extent_start (extent) ||
2464 new_end != extent_end (extent))
2466 extent_detach (extent);
2467 set_extent_start (extent, new_start);
2468 set_extent_end (extent, new_end);
2471 extent_attach (extent);
2480 #ifdef ERROR_CHECK_EXTENTS
2481 sledgehammer_extent_check (object);
2483 Dynarr_free (closure.list);
2486 /* ------------------------------- */
2487 /* extent fragments */
2488 /* ------------------------------- */
2490 /* Imagine that the buffer is divided up into contiguous,
2491 nonoverlapping "runs" of text such that no extent
2492 starts or ends within a run (extents that abut the
2495 An extent fragment is a structure that holds data about
2496 the run that contains a particular buffer position (if
2497 the buffer position is at the junction of two runs, the
2498 run after the position is used) -- the beginning and
2499 end of the run, a list of all of the extents in that
2500 run, the "merged face" that results from merging all of
2501 the faces corresponding to those extents, the begin and
2502 end glyphs at the beginning of the run, etc. This is
2503 the information that redisplay needs in order to
2506 Extent fragments have to be very quick to update to
2507 a new buffer position when moving linearly through
2508 the buffer. They rely on the stack-of-extents code,
2509 which does the heavy-duty algorithmic work of determining
2510 which extents overly a particular position. */
2512 /* This function returns the position of the beginning of
2513 the first run that begins after POS, or returns POS if
2514 there are no such runs. */
2517 extent_find_end_of_run (Lisp_Object obj, Bytind pos, int outside_accessible)
2520 Extent_List *bel = buffer_or_string_extent_list (obj);
2523 Memind mempos = buffer_or_string_bytind_to_memind (obj, pos);
2524 Bytind limit = outside_accessible ?
2525 buffer_or_string_absolute_end_byte (obj) :
2526 buffer_or_string_accessible_end_byte (obj);
2528 if (!bel || !extent_list_num_els(bel))
2531 sel = buffer_or_string_stack_of_extents_force (obj)->extents;
2532 soe_move (obj, mempos);
2534 /* Find the first start position after POS. */
2535 elind1 = extent_list_locate_from_pos (bel, mempos+1, 0);
2536 if (elind1 < extent_list_num_els (bel))
2537 pos1 = buffer_or_string_memind_to_bytind
2538 (obj, extent_start (extent_list_at (bel, elind1, 0)));
2542 /* Find the first end position after POS. The extent corresponding
2543 to this position is either in the SOE or is greater than or
2544 equal to POS1, so we just have to look in the SOE. */
2545 elind2 = extent_list_locate_from_pos (sel, mempos+1, 1);
2546 if (elind2 < extent_list_num_els (sel))
2547 pos2 = buffer_or_string_memind_to_bytind
2548 (obj, extent_end (extent_list_at (sel, elind2, 1)));
2552 return min (min (pos1, pos2), limit);
2556 extent_find_beginning_of_run (Lisp_Object obj, Bytind pos,
2557 int outside_accessible)
2560 Extent_List *bel = buffer_or_string_extent_list (obj);
2563 Memind mempos = buffer_or_string_bytind_to_memind (obj, pos);
2564 Bytind limit = outside_accessible ?
2565 buffer_or_string_absolute_begin_byte (obj) :
2566 buffer_or_string_accessible_begin_byte (obj);
2568 if (!bel || !extent_list_num_els(bel))
2571 sel = buffer_or_string_stack_of_extents_force (obj)->extents;
2572 soe_move (obj, mempos);
2574 /* Find the first end position before POS. */
2575 elind1 = extent_list_locate_from_pos (bel, mempos, 1);
2577 pos1 = buffer_or_string_memind_to_bytind
2578 (obj, extent_end (extent_list_at (bel, elind1 - 1, 1)));
2582 /* Find the first start position before POS. The extent corresponding
2583 to this position is either in the SOE or is less than or
2584 equal to POS1, so we just have to look in the SOE. */
2585 elind2 = extent_list_locate_from_pos (sel, mempos, 0);
2587 pos2 = buffer_or_string_memind_to_bytind
2588 (obj, extent_start (extent_list_at (sel, elind2 - 1, 0)));
2592 return max (max (pos1, pos2), limit);
2595 struct extent_fragment *
2596 extent_fragment_new (Lisp_Object buffer_or_string, struct frame *frm)
2598 struct extent_fragment *ef = xnew_and_zero (struct extent_fragment);
2600 ef->object = buffer_or_string;
2602 ef->extents = Dynarr_new (EXTENT);
2603 ef->begin_glyphs = Dynarr_new (glyph_block);
2604 ef->end_glyphs = Dynarr_new (glyph_block);
2610 extent_fragment_delete (struct extent_fragment *ef)
2612 Dynarr_free (ef->extents);
2613 Dynarr_free (ef->begin_glyphs);
2614 Dynarr_free (ef->end_glyphs);
2619 extent_priority_sort_function (const void *humpty, const void *dumpty)
2621 const EXTENT foo = * (const EXTENT *) humpty;
2622 const EXTENT bar = * (const EXTENT *) dumpty;
2623 if (extent_priority (foo) < extent_priority (bar))
2625 return extent_priority (foo) > extent_priority (bar);
2629 extent_fragment_sort_by_priority (EXTENT_dynarr *extarr)
2633 /* Sort our copy of the stack by extent_priority. We use a bubble
2634 sort here because it's going to be faster than qsort() for small
2635 numbers of extents (less than 10 or so), and 99.999% of the time
2636 there won't ever be more extents than this in the stack. */
2637 if (Dynarr_length (extarr) < 10)
2639 for (i = 1; i < Dynarr_length (extarr); i++)
2643 (extent_priority (Dynarr_at (extarr, j)) >
2644 extent_priority (Dynarr_at (extarr, j+1))))
2646 EXTENT tmp = Dynarr_at (extarr, j);
2647 Dynarr_at (extarr, j) = Dynarr_at (extarr, j+1);
2648 Dynarr_at (extarr, j+1) = tmp;
2654 /* But some loser programs mess up and may create a large number
2655 of extents overlapping the same spot. This will result in
2656 catastrophic behavior if we use the bubble sort above. */
2657 qsort (Dynarr_atp (extarr, 0), Dynarr_length (extarr),
2658 sizeof (EXTENT), extent_priority_sort_function);
2661 /* If PROP is the `invisible' property of an extent,
2662 this is 1 if the extent should be treated as invisible. */
2664 #define EXTENT_PROP_MEANS_INVISIBLE(buf, prop) \
2665 (EQ (buf->invisibility_spec, Qt) \
2667 : invisible_p (prop, buf->invisibility_spec))
2669 /* If PROP is the `invisible' property of a extent,
2670 this is 1 if the extent should be treated as invisible
2671 and should have an ellipsis. */
2673 #define EXTENT_PROP_MEANS_INVISIBLE_WITH_ELLIPSIS(buf, prop) \
2674 (EQ (buf->invisibility_spec, Qt) \
2676 : invisible_ellipsis_p (prop, buf->invisibility_spec))
2678 /* This is like a combination of memq and assq.
2679 Return 1 if PROPVAL appears as an element of LIST
2680 or as the car of an element of LIST.
2681 If PROPVAL is a list, compare each element against LIST
2682 in that way, and return 1 if any element of PROPVAL is found in LIST.
2684 This function cannot quit. */
2687 invisible_p (REGISTER Lisp_Object propval, Lisp_Object list)
2689 REGISTER Lisp_Object tail, proptail;
2690 for (tail = list; CONSP (tail); tail = XCDR (tail))
2692 REGISTER Lisp_Object tem;
2694 if (EQ (propval, tem))
2696 if (CONSP (tem) && EQ (propval, XCAR (tem)))
2699 if (CONSP (propval))
2700 for (proptail = propval; CONSP (proptail);
2701 proptail = XCDR (proptail))
2703 Lisp_Object propelt;
2704 propelt = XCAR (proptail);
2705 for (tail = list; CONSP (tail); tail = XCDR (tail))
2707 REGISTER Lisp_Object tem;
2709 if (EQ (propelt, tem))
2711 if (CONSP (tem) && EQ (propelt, XCAR (tem)))
2718 /* Return 1 if PROPVAL appears as the car of an element of LIST
2719 and the cdr of that element is non-nil.
2720 If PROPVAL is a list, check each element of PROPVAL in that way,
2721 and the first time some element is found,
2722 return 1 if the cdr of that element is non-nil.
2724 This function cannot quit. */
2727 invisible_ellipsis_p (REGISTER Lisp_Object propval, Lisp_Object list)
2729 REGISTER Lisp_Object tail, proptail;
2730 for (tail = list; CONSP (tail); tail = XCDR (tail))
2732 REGISTER Lisp_Object tem;
2734 if (CONSP (tem) && EQ (propval, XCAR (tem)))
2735 return ! NILP (XCDR (tem));
2737 if (CONSP (propval))
2738 for (proptail = propval; CONSP (proptail);
2739 proptail = XCDR (proptail))
2741 Lisp_Object propelt;
2742 propelt = XCAR (proptail);
2743 for (tail = list; CONSP (tail); tail = XCDR (tail))
2745 REGISTER Lisp_Object tem;
2747 if (CONSP (tem) && EQ (propelt, XCAR (tem)))
2748 return ! NILP (XCDR (tem));
2755 extent_fragment_update (struct window *w, struct extent_fragment *ef,
2760 buffer_or_string_stack_of_extents_force (ef->object)->extents;
2762 struct extent dummy_lhe_extent;
2763 Memind mempos = buffer_or_string_bytind_to_memind (ef->object, pos);
2765 #ifdef ERROR_CHECK_EXTENTS
2766 assert (pos >= buffer_or_string_accessible_begin_byte (ef->object)
2767 && pos <= buffer_or_string_accessible_end_byte (ef->object));
2770 Dynarr_reset (ef->extents);
2771 Dynarr_reset (ef->begin_glyphs);
2772 Dynarr_reset (ef->end_glyphs);
2774 ef->previously_invisible = ef->invisible;
2777 if (ef->invisible_ellipses)
2778 ef->invisible_ellipses_already_displayed = 1;
2781 ef->invisible_ellipses_already_displayed = 0;
2783 ef->invisible_ellipses = 0;
2785 /* Set up the begin and end positions. */
2787 ef->end = extent_find_end_of_run (ef->object, pos, 0);
2789 /* Note that extent_find_end_of_run() already moved the SOE for us. */
2790 /* soe_move (ef->object, mempos); */
2792 /* Determine the begin glyphs at POS. */
2793 for (i = 0; i < extent_list_num_els (sel); i++)
2795 EXTENT e = extent_list_at (sel, i, 0);
2796 if (extent_start (e) == mempos && !NILP (extent_begin_glyph (e)))
2798 Lisp_Object glyph = extent_begin_glyph (e);
2799 struct glyph_block gb;
2802 XSETEXTENT (gb.extent, e);
2803 Dynarr_add (ef->begin_glyphs, gb);
2807 /* Determine the end glyphs at POS. */
2808 for (i = 0; i < extent_list_num_els (sel); i++)
2810 EXTENT e = extent_list_at (sel, i, 1);
2811 if (extent_end (e) == mempos && !NILP (extent_end_glyph (e)))
2813 Lisp_Object glyph = extent_end_glyph (e);
2814 struct glyph_block gb;
2817 XSETEXTENT (gb.extent, e);
2818 Dynarr_add (ef->end_glyphs, gb);
2822 /* We tried determining all the charsets used in the run here,
2823 but that fails even if we only do the current line -- display
2824 tables or non-printable characters might cause other charsets
2827 /* Determine whether the last-highlighted-extent is present. */
2828 if (EXTENTP (Vlast_highlighted_extent))
2829 lhe = XEXTENT (Vlast_highlighted_extent);
2831 /* Now add all extents that overlap the character after POS and
2832 have a non-nil face. Also check if the character is invisible. */
2833 for (i = 0; i < extent_list_num_els (sel); i++)
2835 EXTENT e = extent_list_at (sel, i, 0);
2836 if (extent_end (e) > mempos)
2838 Lisp_Object invis_prop = extent_invisible (e);
2840 if (!NILP (invis_prop))
2842 if (!BUFFERP (ef->object))
2843 /* #### no `string-invisibility-spec' */
2847 if (!ef->invisible_ellipses_already_displayed &&
2848 EXTENT_PROP_MEANS_INVISIBLE_WITH_ELLIPSIS
2849 (XBUFFER (ef->object), invis_prop))
2852 ef->invisible_ellipses = 1;
2854 else if (EXTENT_PROP_MEANS_INVISIBLE
2855 (XBUFFER (ef->object), invis_prop))
2860 /* Remember that one of the extents in the list might be our
2861 dummy extent representing the highlighting that is
2862 attached to some other extent that is currently
2863 mouse-highlighted. When an extent is mouse-highlighted,
2864 it is as if there are two extents there, of potentially
2865 different priorities: the extent being highlighted, with
2866 whatever face and priority it has; and an ephemeral
2867 extent in the `mouse-face' face with
2868 `mouse-highlight-priority'.
2871 if (!NILP (extent_face (e)))
2872 Dynarr_add (ef->extents, e);
2876 /* zeroing isn't really necessary; we only deref `priority'
2878 xzero (dummy_lhe_extent);
2879 set_extent_priority (&dummy_lhe_extent,
2880 mouse_highlight_priority);
2881 /* Need to break up the following expression, due to an */
2882 /* error in the Digital UNIX 3.2g C compiler (Digital */
2883 /* UNIX Compiler Driver 3.11). */
2884 f = extent_mouse_face (lhe);
2885 extent_face (&dummy_lhe_extent) = f;
2886 Dynarr_add (ef->extents, &dummy_lhe_extent);
2888 /* since we are looping anyway, we might as well do this here */
2889 if ((!NILP(extent_initial_redisplay_function (e))) &&
2890 !extent_in_red_event_p(e))
2892 Lisp_Object function = extent_initial_redisplay_function (e);
2895 /* printf ("initial redisplay function called!\n "); */
2897 /* print_extent_2 (e);
2900 /* FIXME: One should probably inhibit the displaying of
2901 this extent to reduce flicker */
2902 extent_in_red_event_p(e) = 1;
2904 /* call the function */
2907 Fenqueue_eval_event(function,obj);
2912 extent_fragment_sort_by_priority (ef->extents);
2914 /* Now merge the faces together into a single face. The code to
2915 do this is in faces.c because it involves manipulating faces. */
2916 return get_extent_fragment_face_cache_index (w, ef);
2920 /************************************************************************/
2921 /* extent-object methods */
2922 /************************************************************************/
2924 /* These are the basic helper functions for handling the allocation of
2925 extent objects. They are similar to the functions for other
2926 lrecord objects. allocate_extent() is in alloc.c, not here. */
2929 mark_extent (Lisp_Object obj)
2931 struct extent *extent = XEXTENT (obj);
2933 mark_object (extent_object (extent));
2934 mark_object (extent_no_chase_normal_field (extent, face));
2935 return extent->plist;
2939 print_extent_1 (Lisp_Object obj, Lisp_Object printcharfun, int escapeflag)
2941 EXTENT ext = XEXTENT (obj);
2942 EXTENT anc = extent_ancestor (ext);
2944 char buf[64], *bp = buf;
2946 /* Retrieve the ancestor and use it, for faster retrieval of properties */
2948 if (!NILP (extent_begin_glyph (anc))) *bp++ = '*';
2949 *bp++ = (extent_start_open_p (anc) ? '(': '[');
2950 if (extent_detached_p (ext))
2951 strcpy (bp, "detached");
2953 sprintf (bp, "%ld, %ld",
2954 (long) XINT (Fextent_start_position (obj)),
2955 (long) XINT (Fextent_end_position (obj)));
2957 *bp++ = (extent_end_open_p (anc) ? ')': ']');
2958 if (!NILP (extent_end_glyph (anc))) *bp++ = '*';
2961 if (!NILP (extent_read_only (anc))) *bp++ = '%';
2962 if (!NILP (extent_mouse_face (anc))) *bp++ = 'H';
2963 if (extent_unique_p (anc)) *bp++ = 'U';
2964 else if (extent_duplicable_p (anc)) *bp++ = 'D';
2965 if (!NILP (extent_invisible (anc))) *bp++ = 'I';
2967 if (!NILP (extent_read_only (anc)) || !NILP (extent_mouse_face (anc)) ||
2968 extent_unique_p (anc) ||
2969 extent_duplicable_p (anc) || !NILP (extent_invisible (anc)))
2972 write_c_string (buf, printcharfun);
2974 tail = extent_plist_slot (anc);
2976 for (; !NILP (tail); tail = Fcdr (Fcdr (tail)))
2978 Lisp_Object v = XCAR (XCDR (tail));
2979 if (NILP (v)) continue;
2980 print_internal (XCAR (tail), printcharfun, escapeflag);
2981 write_c_string (" ", printcharfun);
2984 sprintf (buf, "0x%lx", (long) ext);
2985 write_c_string (buf, printcharfun);
2989 print_extent (Lisp_Object obj, Lisp_Object printcharfun, int escapeflag)
2993 const char *title = "";
2994 const char *name = "";
2995 const char *posttitle = "";
2996 Lisp_Object obj2 = Qnil;
2998 /* Destroyed extents have 't' in the object field, causing
2999 extent_object() to abort (maybe). */
3000 if (EXTENT_LIVE_P (XEXTENT (obj)))
3001 obj2 = extent_object (XEXTENT (obj));
3004 title = "no buffer";
3005 else if (BUFFERP (obj2))
3007 if (BUFFER_LIVE_P (XBUFFER (obj2)))
3010 name = (char *) XSTRING_DATA (XBUFFER (obj2)->name);
3014 title = "Killed Buffer";
3020 assert (STRINGP (obj2));
3021 title = "string \"";
3023 name = (char *) XSTRING_DATA (obj2);
3028 if (!EXTENT_LIVE_P (XEXTENT (obj)))
3029 error ("printing unreadable object #<destroyed extent>");
3031 error ("printing unreadable object #<extent 0x%lx>",
3032 (long) XEXTENT (obj));
3035 if (!EXTENT_LIVE_P (XEXTENT (obj)))
3036 write_c_string ("#<destroyed extent", printcharfun);
3039 char *buf = (char *)
3040 alloca (strlen (title) + strlen (name) + strlen (posttitle) + 1);
3041 write_c_string ("#<extent ", printcharfun);
3042 print_extent_1 (obj, printcharfun, escapeflag);
3043 write_c_string (extent_detached_p (XEXTENT (obj))
3044 ? " from " : " in ", printcharfun);
3045 sprintf (buf, "%s%s%s", title, name, posttitle);
3046 write_c_string (buf, printcharfun);
3052 error ("printing unreadable object #<extent>");
3053 write_c_string ("#<extent", printcharfun);
3055 write_c_string (">", printcharfun);
3059 properties_equal (EXTENT e1, EXTENT e2, int depth)
3061 /* When this function is called, all indirections have been followed.
3062 Thus, the indirection checks in the various macros below will not
3063 amount to anything, and could be removed. However, the time
3064 savings would probably not be significant. */
3065 if (!(EQ (extent_face (e1), extent_face (e2)) &&
3066 extent_priority (e1) == extent_priority (e2) &&
3067 internal_equal (extent_begin_glyph (e1), extent_begin_glyph (e2),
3069 internal_equal (extent_end_glyph (e1), extent_end_glyph (e2),
3073 /* compare the bit flags. */
3075 /* The has_aux field should not be relevant. */
3076 int e1_has_aux = e1->flags.has_aux;
3077 int e2_has_aux = e2->flags.has_aux;
3080 e1->flags.has_aux = e2->flags.has_aux = 0;
3081 value = memcmp (&e1->flags, &e2->flags, sizeof (e1->flags));
3082 e1->flags.has_aux = e1_has_aux;
3083 e2->flags.has_aux = e2_has_aux;
3088 /* compare the random elements of the plists. */
3089 return !plists_differ (extent_no_chase_plist (e1),
3090 extent_no_chase_plist (e2),
3095 extent_equal (Lisp_Object obj1, Lisp_Object obj2, int depth)
3097 struct extent *e1 = XEXTENT (obj1);
3098 struct extent *e2 = XEXTENT (obj2);
3100 (extent_start (e1) == extent_start (e2) &&
3101 extent_end (e1) == extent_end (e2) &&
3102 internal_equal (extent_object (e1), extent_object (e2), depth + 1) &&
3103 properties_equal (extent_ancestor (e1), extent_ancestor (e2),
3107 static unsigned long
3108 extent_hash (Lisp_Object obj, int depth)
3110 struct extent *e = XEXTENT (obj);
3111 /* No need to hash all of the elements; that would take too long.
3112 Just hash the most common ones. */
3113 return HASH3 (extent_start (e), extent_end (e),
3114 internal_hash (extent_object (e), depth + 1));
3117 static const struct lrecord_description extent_description[] = {
3118 { XD_LISP_OBJECT, offsetof (struct extent, object) },
3119 { XD_LISP_OBJECT, offsetof (struct extent, flags.face) },
3120 { XD_LISP_OBJECT, offsetof (struct extent, plist) },
3125 extent_getprop (Lisp_Object obj, Lisp_Object prop)
3127 return Fextent_property (obj, prop, Qunbound);
3131 extent_putprop (Lisp_Object obj, Lisp_Object prop, Lisp_Object value)
3133 Fset_extent_property (obj, prop, value);
3138 extent_remprop (Lisp_Object obj, Lisp_Object prop)
3140 EXTENT ext = XEXTENT (obj);
3142 /* This list is taken from Fset_extent_property, and should be kept
3144 if (EQ (prop, Qread_only)
3145 || EQ (prop, Qunique)
3146 || EQ (prop, Qduplicable)
3147 || EQ (prop, Qinvisible)
3148 || EQ (prop, Qdetachable)
3149 || EQ (prop, Qdetached)
3150 || EQ (prop, Qdestroyed)
3151 || EQ (prop, Qpriority)
3153 || EQ (prop, Qinitial_redisplay_function)
3154 || EQ (prop, Qafter_change_functions)
3155 || EQ (prop, Qbefore_change_functions)
3156 || EQ (prop, Qmouse_face)
3157 || EQ (prop, Qhighlight)
3158 || EQ (prop, Qbegin_glyph_layout)
3159 || EQ (prop, Qend_glyph_layout)
3160 || EQ (prop, Qglyph_layout)
3161 || EQ (prop, Qbegin_glyph)
3162 || EQ (prop, Qend_glyph)
3163 || EQ (prop, Qstart_open)
3164 || EQ (prop, Qend_open)
3165 || EQ (prop, Qstart_closed)
3166 || EQ (prop, Qend_closed)
3167 || EQ (prop, Qkeymap))
3169 /* #### Is this correct, anyway? */
3173 return external_remprop (extent_plist_addr (ext), prop, 0, ERROR_ME);
3177 extent_plist (Lisp_Object obj)
3179 return Fextent_properties (obj);
3182 DEFINE_BASIC_LRECORD_IMPLEMENTATION_WITH_PROPS ("extent", extent,
3185 /* NOTE: If you declare a
3186 finalization method here,
3187 it will NOT be called.
3190 extent_equal, extent_hash,
3192 extent_getprop, extent_putprop,
3193 extent_remprop, extent_plist,
3197 /************************************************************************/
3198 /* basic extent accessors */
3199 /************************************************************************/
3201 /* These functions are for checking externally-passed extent objects
3202 and returning an extent's basic properties, which include the
3203 buffer the extent is associated with, the endpoints of the extent's
3204 range, the open/closed-ness of those endpoints, and whether the
3205 extent is detached. Manipulating these properties requires
3206 manipulating the ordered lists that hold extents; thus, functions
3207 to do that are in a later section. */
3209 /* Given a Lisp_Object that is supposed to be an extent, make sure it
3210 is OK and return an extent pointer. Extents can be in one of four
3214 2) detached and not associated with a buffer
3215 3) detached and associated with a buffer
3216 4) attached to a buffer
3218 If FLAGS is 0, types 2-4 are allowed. If FLAGS is DE_MUST_HAVE_BUFFER,
3219 types 3-4 are allowed. If FLAGS is DE_MUST_BE_ATTACHED, only type 4
3224 decode_extent (Lisp_Object extent_obj, unsigned int flags)
3229 CHECK_LIVE_EXTENT (extent_obj);
3230 extent = XEXTENT (extent_obj);
3231 obj = extent_object (extent);
3233 /* the following condition will fail if we're dealing with a freed extent */
3234 assert (NILP (obj) || BUFFERP (obj) || STRINGP (obj));
3236 if (flags & DE_MUST_BE_ATTACHED)
3237 flags |= DE_MUST_HAVE_BUFFER;
3239 /* if buffer is dead, then convert extent to have no buffer. */
3240 if (BUFFERP (obj) && !BUFFER_LIVE_P (XBUFFER (obj)))
3241 obj = extent_object (extent) = Qnil;
3243 assert (!NILP (obj) || extent_detached_p (extent));
3245 if ((NILP (obj) && (flags & DE_MUST_HAVE_BUFFER))
3246 || (extent_detached_p (extent) && (flags & DE_MUST_BE_ATTACHED)))
3248 signal_simple_error ("extent doesn't belong to a buffer or string",
3255 /* Note that the returned value is a buffer position, not a byte index. */
3258 extent_endpoint_external (Lisp_Object extent_obj, int endp)
3260 EXTENT extent = decode_extent (extent_obj, 0);
3262 if (extent_detached_p (extent))
3265 return make_int (extent_endpoint_bufpos (extent, endp));
3268 DEFUN ("extentp", Fextentp, 1, 1, 0, /*
3269 Return t if OBJECT is an extent.
3273 return EXTENTP (object) ? Qt : Qnil;
3276 DEFUN ("extent-live-p", Fextent_live_p, 1, 1, 0, /*
3277 Return t if OBJECT is an extent that has not been destroyed.
3281 return EXTENTP (object) && EXTENT_LIVE_P (XEXTENT (object)) ? Qt : Qnil;
3284 DEFUN ("extent-detached-p", Fextent_detached_p, 1, 1, 0, /*
3285 Return t if EXTENT is detached.
3289 return extent_detached_p (decode_extent (extent, 0)) ? Qt : Qnil;
3292 DEFUN ("extent-object", Fextent_object, 1, 1, 0, /*
3293 Return object (buffer or string) that EXTENT refers to.
3297 return extent_object (decode_extent (extent, 0));
3300 DEFUN ("extent-start-position", Fextent_start_position, 1, 1, 0, /*
3301 Return start position of EXTENT, or nil if EXTENT is detached.
3305 return extent_endpoint_external (extent, 0);
3308 DEFUN ("extent-end-position", Fextent_end_position, 1, 1, 0, /*
3309 Return end position of EXTENT, or nil if EXTENT is detached.
3313 return extent_endpoint_external (extent, 1);
3316 DEFUN ("extent-length", Fextent_length, 1, 1, 0, /*
3317 Return length of EXTENT in characters.
3321 EXTENT e = decode_extent (extent, DE_MUST_BE_ATTACHED);
3322 return make_int (extent_endpoint_bufpos (e, 1)
3323 - extent_endpoint_bufpos (e, 0));
3326 DEFUN ("next-extent", Fnext_extent, 1, 1, 0, /*
3327 Find next extent after EXTENT.
3328 If EXTENT is a buffer return the first extent in the buffer; likewise
3330 Extents in a buffer are ordered in what is called the "display"
3331 order, which sorts by increasing start positions and then by *decreasing*
3333 If you want to perform an operation on a series of extents, use
3334 `map-extents' instead of this function; it is much more efficient.
3335 The primary use of this function should be to enumerate all the
3336 extents in a buffer.
3337 Note: The display order is not necessarily the order that `map-extents'
3338 processes extents in!
3345 if (EXTENTP (extent))
3346 next = extent_next (decode_extent (extent, DE_MUST_BE_ATTACHED));
3348 next = extent_first (decode_buffer_or_string (extent));
3352 XSETEXTENT (val, next);
3356 DEFUN ("previous-extent", Fprevious_extent, 1, 1, 0, /*
3357 Find last extent before EXTENT.
3358 If EXTENT is a buffer return the last extent in the buffer; likewise
3360 This function is analogous to `next-extent'.
3367 if (EXTENTP (extent))
3368 prev = extent_previous (decode_extent (extent, DE_MUST_BE_ATTACHED));
3370 prev = extent_last (decode_buffer_or_string (extent));
3374 XSETEXTENT (val, prev);
3380 DEFUN ("next-e-extent", Fnext_e_extent, 1, 1, 0, /*
3381 Find next extent after EXTENT using the "e" order.
3382 If EXTENT is a buffer return the first extent in the buffer; likewise
3390 if (EXTENTP (extent))
3391 next = extent_e_next (decode_extent (extent, DE_MUST_BE_ATTACHED));
3393 next = extent_e_first (decode_buffer_or_string (extent));
3397 XSETEXTENT (val, next);
3401 DEFUN ("previous-e-extent", Fprevious_e_extent, 1, 1, 0, /*
3402 Find last extent before EXTENT using the "e" order.
3403 If EXTENT is a buffer return the last extent in the buffer; likewise
3405 This function is analogous to `next-e-extent'.
3412 if (EXTENTP (extent))
3413 prev = extent_e_previous (decode_extent (extent, DE_MUST_BE_ATTACHED));
3415 prev = extent_e_last (decode_buffer_or_string (extent));
3419 XSETEXTENT (val, prev);
3425 DEFUN ("next-extent-change", Fnext_extent_change, 1, 2, 0, /*
3426 Return the next position after POS where an extent begins or ends.
3427 If POS is at the end of the buffer or string, POS will be returned;
3428 otherwise a position greater than POS will always be returned.
3429 If BUFFER is nil, the current buffer is assumed.
3433 Lisp_Object obj = decode_buffer_or_string (object);
3436 bpos = get_buffer_or_string_pos_byte (obj, pos, GB_ALLOW_PAST_ACCESSIBLE);
3437 bpos = extent_find_end_of_run (obj, bpos, 1);
3438 return make_int (buffer_or_string_bytind_to_bufpos (obj, bpos));
3441 DEFUN ("previous-extent-change", Fprevious_extent_change, 1, 2, 0, /*
3442 Return the last position before POS where an extent begins or ends.
3443 If POS is at the beginning of the buffer or string, POS will be returned;
3444 otherwise a position less than POS will always be returned.
3445 If OBJECT is nil, the current buffer is assumed.
3449 Lisp_Object obj = decode_buffer_or_string (object);
3452 bpos = get_buffer_or_string_pos_byte (obj, pos, GB_ALLOW_PAST_ACCESSIBLE);
3453 bpos = extent_find_beginning_of_run (obj, bpos, 1);
3454 return make_int (buffer_or_string_bytind_to_bufpos (obj, bpos));
3458 /************************************************************************/
3459 /* parent and children stuff */
3460 /************************************************************************/
3462 DEFUN ("extent-parent", Fextent_parent, 1, 1, 0, /*
3463 Return the parent (if any) of EXTENT.
3464 If an extent has a parent, it derives all its properties from that extent
3465 and has no properties of its own. (The only "properties" that the
3466 extent keeps are the buffer/string it refers to and the start and end
3467 points.) It is possible for an extent's parent to itself have a parent.
3470 /* do I win the prize for the strangest split infinitive? */
3472 EXTENT e = decode_extent (extent, 0);
3473 return extent_parent (e);
3476 DEFUN ("extent-children", Fextent_children, 1, 1, 0, /*
3477 Return a list of the children (if any) of EXTENT.
3478 The children of an extent are all those extents whose parent is that extent.
3479 This function does not recursively trace children of children.
3480 \(To do that, use `extent-descendants'.)
3484 EXTENT e = decode_extent (extent, 0);
3485 Lisp_Object children = extent_children (e);
3487 if (!NILP (children))
3488 return Fcopy_sequence (XWEAK_LIST_LIST (children));
3494 remove_extent_from_children_list (EXTENT e, Lisp_Object child)
3496 Lisp_Object children = extent_children (e);
3498 #ifdef ERROR_CHECK_EXTENTS
3499 assert (!NILP (memq_no_quit (child, XWEAK_LIST_LIST (children))));
3501 XWEAK_LIST_LIST (children) =
3502 delq_no_quit (child, XWEAK_LIST_LIST (children));
3506 add_extent_to_children_list (EXTENT e, Lisp_Object child)
3508 Lisp_Object children = extent_children (e);
3510 if (NILP (children))
3512 children = make_weak_list (WEAK_LIST_SIMPLE);
3513 set_extent_no_chase_aux_field (e, children, children);
3516 #ifdef ERROR_CHECK_EXTENTS
3517 assert (NILP (memq_no_quit (child, XWEAK_LIST_LIST (children))));
3519 XWEAK_LIST_LIST (children) = Fcons (child, XWEAK_LIST_LIST (children));
3522 DEFUN ("set-extent-parent", Fset_extent_parent, 2, 2, 0, /*
3523 Set the parent of EXTENT to PARENT (may be nil).
3524 See `extent-parent'.
3528 EXTENT e = decode_extent (extent, 0);
3529 Lisp_Object cur_parent = extent_parent (e);
3532 XSETEXTENT (extent, e);
3534 CHECK_LIVE_EXTENT (parent);
3535 if (EQ (parent, cur_parent))
3537 for (rest = parent; !NILP (rest); rest = extent_parent (XEXTENT (rest)))
3538 if (EQ (rest, extent))
3539 signal_simple_error ("Circular parent chain would result", extent);
3542 remove_extent_from_children_list (XEXTENT (cur_parent), extent);
3543 set_extent_no_chase_aux_field (e, parent, Qnil);
3544 e->flags.has_parent = 0;
3548 add_extent_to_children_list (XEXTENT (parent), extent);
3549 set_extent_no_chase_aux_field (e, parent, parent);
3550 e->flags.has_parent = 1;
3552 /* changing the parent also changes the properties of all children. */
3554 int old_invis = (!NILP (cur_parent) &&
3555 !NILP (extent_invisible (XEXTENT (cur_parent))));
3556 int new_invis = (!NILP (parent) &&
3557 !NILP (extent_invisible (XEXTENT (parent))));
3559 extent_maybe_changed_for_redisplay (e, 1, new_invis != old_invis);
3566 /************************************************************************/
3567 /* basic extent mutators */
3568 /************************************************************************/
3570 /* Note: If you track non-duplicable extents by undo, you'll get bogus
3571 undo records for transient extents via update-extent.
3572 For example, query-replace will do this.
3576 set_extent_endpoints_1 (EXTENT extent, Memind start, Memind end)
3578 #ifdef ERROR_CHECK_EXTENTS
3579 Lisp_Object obj = extent_object (extent);
3581 assert (start <= end);
3584 assert (valid_memind_p (XBUFFER (obj), start));
3585 assert (valid_memind_p (XBUFFER (obj), end));
3589 /* Optimization: if the extent is already where we want it to be,
3591 if (!extent_detached_p (extent) && extent_start (extent) == start &&
3592 extent_end (extent) == end)
3595 if (extent_detached_p (extent))
3597 if (extent_duplicable_p (extent))
3599 Lisp_Object extent_obj;
3600 XSETEXTENT (extent_obj, extent);
3601 record_extent (extent_obj, 1);
3605 extent_detach (extent);
3607 set_extent_start (extent, start);
3608 set_extent_end (extent, end);
3609 extent_attach (extent);
3612 /* Set extent's endpoints to S and E, and put extent in buffer or string
3613 OBJECT. (If OBJECT is nil, do not change the extent's object.) */
3616 set_extent_endpoints (EXTENT extent, Bytind s, Bytind e, Lisp_Object object)
3622 object = extent_object (extent);
3623 assert (!NILP (object));
3625 else if (!EQ (object, extent_object (extent)))
3627 extent_detach (extent);
3628 extent_object (extent) = object;
3631 start = s < 0 ? extent_start (extent) :
3632 buffer_or_string_bytind_to_memind (object, s);
3633 end = e < 0 ? extent_end (extent) :
3634 buffer_or_string_bytind_to_memind (object, e);
3635 set_extent_endpoints_1 (extent, start, end);
3639 set_extent_openness (EXTENT extent, int start_open, int end_open)
3641 if (start_open != -1)
3642 extent_start_open_p (extent) = start_open;
3644 extent_end_open_p (extent) = end_open;
3645 /* changing the open/closedness of an extent does not affect
3650 make_extent_internal (Lisp_Object object, Bytind from, Bytind to)
3654 extent = make_extent_detached (object);
3655 set_extent_endpoints (extent, from, to, Qnil);
3660 copy_extent (EXTENT original, Bytind from, Bytind to, Lisp_Object object)
3664 e = make_extent_detached (object);
3666 set_extent_endpoints (e, from, to, Qnil);
3668 e->plist = Fcopy_sequence (original->plist);
3669 memcpy (&e->flags, &original->flags, sizeof (e->flags));
3670 if (e->flags.has_aux)
3672 /* also need to copy the aux struct. It won't work for
3673 this extent to share the same aux struct as the original
3675 struct extent_auxiliary *data =
3676 alloc_lcrecord_type (struct extent_auxiliary,
3677 &lrecord_extent_auxiliary);
3679 copy_lcrecord (data, XEXTENT_AUXILIARY (XCAR (original->plist)));
3680 XSETEXTENT_AUXILIARY (XCAR (e->plist), data);
3684 /* we may have just added another child to the parent extent. */
3685 Lisp_Object parent = extent_parent (e);
3689 XSETEXTENT (extent, e);
3690 add_extent_to_children_list (XEXTENT (parent), extent);
3698 destroy_extent (EXTENT extent)
3700 Lisp_Object rest, nextrest, children;
3701 Lisp_Object extent_obj;
3703 if (!extent_detached_p (extent))
3704 extent_detach (extent);
3705 /* disassociate the extent from its children and parent */
3706 children = extent_children (extent);
3707 if (!NILP (children))
3709 LIST_LOOP_DELETING (rest, nextrest, XWEAK_LIST_LIST (children))
3710 Fset_extent_parent (XCAR (rest), Qnil);
3712 XSETEXTENT (extent_obj, extent);
3713 Fset_extent_parent (extent_obj, Qnil);
3714 /* mark the extent as destroyed */
3715 extent_object (extent) = Qt;
3718 DEFUN ("make-extent", Fmake_extent, 2, 3, 0, /*
3719 Make an extent for the range [FROM, TO) in BUFFER-OR-STRING.
3720 BUFFER-OR-STRING defaults to the current buffer. Insertions at point
3721 TO will be outside of the extent; insertions at FROM will be inside the
3722 extent, causing the extent to grow. (This is the same way that markers
3723 behave.) You can change the behavior of insertions at the endpoints
3724 using `set-extent-property'. The extent is initially detached if both
3725 FROM and TO are nil, and in this case BUFFER-OR-STRING defaults to nil,
3726 meaning the extent is in no buffer and no string.
3728 (from, to, buffer_or_string))
3730 Lisp_Object extent_obj;
3733 obj = decode_buffer_or_string (buffer_or_string);
3734 if (NILP (from) && NILP (to))
3736 if (NILP (buffer_or_string))
3738 XSETEXTENT (extent_obj, make_extent_detached (obj));
3744 get_buffer_or_string_range_byte (obj, from, to, &start, &end,
3745 GB_ALLOW_PAST_ACCESSIBLE);
3746 XSETEXTENT (extent_obj, make_extent_internal (obj, start, end));
3751 DEFUN ("copy-extent", Fcopy_extent, 1, 2, 0, /*
3752 Make a copy of EXTENT. It is initially detached.
3753 Optional argument BUFFER-OR-STRING defaults to EXTENT's buffer or string.
3755 (extent, buffer_or_string))
3757 EXTENT ext = decode_extent (extent, 0);
3759 if (NILP (buffer_or_string))
3760 buffer_or_string = extent_object (ext);
3762 buffer_or_string = decode_buffer_or_string (buffer_or_string);
3764 XSETEXTENT (extent, copy_extent (ext, -1, -1, buffer_or_string));
3768 DEFUN ("delete-extent", Fdelete_extent, 1, 1, 0, /*
3769 Remove EXTENT from its buffer and destroy it.
3770 This does not modify the buffer's text, only its display properties.
3771 The extent cannot be used thereafter.
3777 /* We do not call decode_extent() here because already-destroyed
3779 CHECK_EXTENT (extent);
3780 ext = XEXTENT (extent);
3782 if (!EXTENT_LIVE_P (ext))
3784 destroy_extent (ext);
3788 DEFUN ("detach-extent", Fdetach_extent, 1, 1, 0, /*
3789 Remove EXTENT from its buffer in such a way that it can be re-inserted.
3790 An extent is also detached when all of its characters are all killed by a
3791 deletion, unless its `detachable' property has been unset.
3793 Extents which have the `duplicable' attribute are tracked by the undo
3794 mechanism. Detachment via `detach-extent' and string deletion is recorded,
3795 as is attachment via `insert-extent' and string insertion. Extent motion,
3796 face changes, and attachment via `make-extent' and `set-extent-endpoints'
3797 are not recorded. This means that extent changes which are to be undo-able
3798 must be performed by character editing, or by insertion and detachment of
3803 EXTENT ext = decode_extent (extent, 0);
3805 if (extent_detached_p (ext))
3807 if (extent_duplicable_p (ext))
3808 record_extent (extent, 0);
3809 extent_detach (ext);
3814 DEFUN ("set-extent-endpoints", Fset_extent_endpoints, 3, 4, 0, /*
3815 Set the endpoints of EXTENT to START, END.
3816 If START and END are null, call detach-extent on EXTENT.
3817 BUFFER-OR-STRING specifies the new buffer or string that the extent should
3818 be in, and defaults to EXTENT's buffer or string. (If nil, and EXTENT
3819 is in no buffer and no string, it defaults to the current buffer.)
3820 See documentation on `detach-extent' for a discussion of undo recording.
3822 (extent, start, end, buffer_or_string))
3827 ext = decode_extent (extent, 0);
3829 if (NILP (buffer_or_string))
3831 buffer_or_string = extent_object (ext);
3832 if (NILP (buffer_or_string))
3833 buffer_or_string = Fcurrent_buffer ();
3836 buffer_or_string = decode_buffer_or_string (buffer_or_string);
3838 if (NILP (start) && NILP (end))
3839 return Fdetach_extent (extent);
3841 get_buffer_or_string_range_byte (buffer_or_string, start, end, &s, &e,
3842 GB_ALLOW_PAST_ACCESSIBLE);
3844 set_extent_endpoints (ext, s, e, buffer_or_string);
3849 /************************************************************************/
3850 /* mapping over extents */
3851 /************************************************************************/
3854 decode_map_extents_flags (Lisp_Object flags)
3856 unsigned int retval = 0;
3857 unsigned int all_extents_specified = 0;
3858 unsigned int in_region_specified = 0;
3860 if (EQ (flags, Qt)) /* obsoleteness compatibility */
3861 return ME_END_CLOSED;
3864 if (SYMBOLP (flags))
3865 flags = Fcons (flags, Qnil);
3866 while (!NILP (flags))
3872 if (EQ (sym, Qall_extents_closed) || EQ (sym, Qall_extents_open) ||
3873 EQ (sym, Qall_extents_closed_open) ||
3874 EQ (sym, Qall_extents_open_closed))
3876 if (all_extents_specified)
3877 error ("Only one `all-extents-*' flag may be specified");
3878 all_extents_specified = 1;
3880 if (EQ (sym, Qstart_in_region) || EQ (sym, Qend_in_region) ||
3881 EQ (sym, Qstart_and_end_in_region) ||
3882 EQ (sym, Qstart_or_end_in_region))
3884 if (in_region_specified)
3885 error ("Only one `*-in-region' flag may be specified");
3886 in_region_specified = 1;
3889 /* I do so love that conditional operator ... */
3891 EQ (sym, Qend_closed) ? ME_END_CLOSED :
3892 EQ (sym, Qstart_open) ? ME_START_OPEN :
3893 EQ (sym, Qall_extents_closed) ? ME_ALL_EXTENTS_CLOSED :
3894 EQ (sym, Qall_extents_open) ? ME_ALL_EXTENTS_OPEN :
3895 EQ (sym, Qall_extents_closed_open) ? ME_ALL_EXTENTS_CLOSED_OPEN :
3896 EQ (sym, Qall_extents_open_closed) ? ME_ALL_EXTENTS_OPEN_CLOSED :
3897 EQ (sym, Qstart_in_region) ? ME_START_IN_REGION :
3898 EQ (sym, Qend_in_region) ? ME_END_IN_REGION :
3899 EQ (sym, Qstart_and_end_in_region) ? ME_START_AND_END_IN_REGION :
3900 EQ (sym, Qstart_or_end_in_region) ? ME_START_OR_END_IN_REGION :
3901 EQ (sym, Qnegate_in_region) ? ME_NEGATE_IN_REGION :
3902 (signal_simple_error ("Invalid `map-extents' flag", sym), 0);
3904 flags = XCDR (flags);
3909 DEFUN ("extent-in-region-p", Fextent_in_region_p, 1, 4, 0, /*
3910 Return whether EXTENT overlaps a specified region.
3911 This is equivalent to whether `map-extents' would visit EXTENT when called
3914 (extent, from, to, flags))
3917 EXTENT ext = decode_extent (extent, DE_MUST_BE_ATTACHED);
3918 Lisp_Object obj = extent_object (ext);
3920 get_buffer_or_string_range_byte (obj, from, to, &start, &end, GB_ALLOW_NIL |
3921 GB_ALLOW_PAST_ACCESSIBLE);
3923 return extent_in_region_p (ext, start, end, decode_map_extents_flags (flags)) ?
3927 struct slow_map_extents_arg
3929 Lisp_Object map_arg;
3930 Lisp_Object map_routine;
3932 Lisp_Object property;
3937 slow_map_extents_function (EXTENT extent, void *arg)
3939 /* This function can GC */
3940 struct slow_map_extents_arg *closure = (struct slow_map_extents_arg *) arg;
3941 Lisp_Object extent_obj;
3943 XSETEXTENT (extent_obj, extent);
3945 /* make sure this extent qualifies according to the PROPERTY
3948 if (!NILP (closure->property))
3950 Lisp_Object value = Fextent_property (extent_obj, closure->property,
3952 if ((NILP (closure->value) && NILP (value)) ||
3953 (!NILP (closure->value) && !EQ (value, closure->value)))
3957 closure->result = call2 (closure->map_routine, extent_obj,
3959 return !NILP (closure->result);
3962 DEFUN ("map-extents", Fmap_extents, 1, 8, 0, /*
3963 Map FUNCTION over the extents which overlap a region in OBJECT.
3964 OBJECT is normally a buffer or string but could be an extent (see below).
3965 The region is normally bounded by [FROM, TO) (i.e. the beginning of the
3966 region is closed and the end of the region is open), but this can be
3967 changed with the FLAGS argument (see below for a complete discussion).
3969 FUNCTION is called with the arguments (extent, MAPARG). The arguments
3970 OBJECT, FROM, TO, MAPARG, and FLAGS are all optional and default to
3971 the current buffer, the beginning of OBJECT, the end of OBJECT, nil,
3972 and nil, respectively. `map-extents' returns the first non-nil result
3973 produced by FUNCTION, and no more calls to FUNCTION are made after it
3976 If OBJECT is an extent, FROM and TO default to the extent's endpoints,
3977 and the mapping omits that extent and its predecessors. This feature
3978 supports restarting a loop based on `map-extents'. Note: OBJECT must
3979 be attached to a buffer or string, and the mapping is done over that
3982 An extent overlaps the region if there is any point in the extent that is
3983 also in the region. (For the purpose of overlap, zero-length extents and
3984 regions are treated as closed on both ends regardless of their endpoints'
3985 specified open/closedness.) Note that the endpoints of an extent or region
3986 are considered to be in that extent or region if and only if the
3987 corresponding end is closed. For example, the extent [5,7] overlaps the
3988 region [2,5] because 5 is in both the extent and the region. However, (5,7]
3989 does not overlap [2,5] because 5 is not in the extent, and neither [5,7] nor
3990 \(5,7] overlaps the region [2,5) because 5 is not in the region.
3992 The optional FLAGS can be a symbol or a list of one or more symbols,
3993 modifying the behavior of `map-extents'. Allowed symbols are:
3995 end-closed The region's end is closed.
3997 start-open The region's start is open.
3999 all-extents-closed Treat all extents as closed on both ends for the
4000 purpose of determining whether they overlap the
4001 region, irrespective of their actual open- or
4003 all-extents-open Treat all extents as open on both ends.
4004 all-extents-closed-open Treat all extents as start-closed, end-open.
4005 all-extents-open-closed Treat all extents as start-open, end-closed.
4007 start-in-region In addition to the above conditions for extent
4008 overlap, the extent's start position must lie within
4009 the specified region. Note that, for this
4010 condition, open start positions are treated as if
4011 0.5 was added to the endpoint's value, and open
4012 end positions are treated as if 0.5 was subtracted
4013 from the endpoint's value.
4014 end-in-region The extent's end position must lie within the
4016 start-and-end-in-region Both the extent's start and end positions must lie
4018 start-or-end-in-region Either the extent's start or end position must lie
4021 negate-in-region The condition specified by a `*-in-region' flag
4022 must NOT hold for the extent to be considered.
4025 At most one of `all-extents-closed', `all-extents-open',
4026 `all-extents-closed-open', and `all-extents-open-closed' may be specified.
4028 At most one of `start-in-region', `end-in-region',
4029 `start-and-end-in-region', and `start-or-end-in-region' may be specified.
4031 If optional arg PROPERTY is non-nil, only extents with that property set
4032 on them will be visited. If optional arg VALUE is non-nil, only extents
4033 whose value for that property is `eq' to VALUE will be visited.
4035 (function, object, from, to, maparg, flags, property, value))
4037 /* This function can GC */
4038 struct slow_map_extents_arg closure;
4039 unsigned int me_flags;
4041 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
4044 if (EXTENTP (object))
4046 after = decode_extent (object, DE_MUST_BE_ATTACHED);
4048 from = Fextent_start_position (object);
4050 to = Fextent_end_position (object);
4051 object = extent_object (after);
4054 object = decode_buffer_or_string (object);
4056 get_buffer_or_string_range_byte (object, from, to, &start, &end,
4057 GB_ALLOW_NIL | GB_ALLOW_PAST_ACCESSIBLE);
4059 me_flags = decode_map_extents_flags (flags);
4061 if (!NILP (property))
4064 value = canonicalize_extent_property (property, value);
4067 GCPRO5 (function, maparg, object, property, value);
4069 closure.map_arg = maparg;
4070 closure.map_routine = function;
4071 closure.result = Qnil;
4072 closure.property = property;
4073 closure.value = value;
4075 map_extents_bytind (start, end, slow_map_extents_function,
4076 (void *) &closure, object, after,
4077 /* You never know what the user might do ... */
4078 me_flags | ME_MIGHT_CALL_ELISP);
4081 return closure.result;
4085 /************************************************************************/
4086 /* mapping over extents -- other functions */
4087 /************************************************************************/
4089 /* ------------------------------- */
4090 /* map-extent-children */
4091 /* ------------------------------- */
4093 struct slow_map_extent_children_arg
4095 Lisp_Object map_arg;
4096 Lisp_Object map_routine;
4098 Lisp_Object property;
4106 slow_map_extent_children_function (EXTENT extent, void *arg)
4108 /* This function can GC */
4109 struct slow_map_extent_children_arg *closure =
4110 (struct slow_map_extent_children_arg *) arg;
4111 Lisp_Object extent_obj;
4112 Bytind start = extent_endpoint_bytind (extent, 0);
4113 Bytind end = extent_endpoint_bytind (extent, 1);
4114 /* Make sure the extent starts inside the region of interest,
4115 rather than just overlaps it.
4117 if (start < closure->start_min)
4119 /* Make sure the extent is not a child of a previous visited one.
4120 We know already, because of extent ordering,
4121 that start >= prev_start, and that if
4122 start == prev_start, then end <= prev_end.
4124 if (start == closure->prev_start)
4126 if (end < closure->prev_end)
4129 else /* start > prev_start */
4131 if (start < closure->prev_end)
4133 /* corner case: prev_end can be -1 if there is no prev */
4135 XSETEXTENT (extent_obj, extent);
4137 /* make sure this extent qualifies according to the PROPERTY
4140 if (!NILP (closure->property))
4142 Lisp_Object value = Fextent_property (extent_obj, closure->property,
4144 if ((NILP (closure->value) && NILP (value)) ||
4145 (!NILP (closure->value) && !EQ (value, closure->value)))
4149 closure->result = call2 (closure->map_routine, extent_obj,
4152 /* Since the callback may change the buffer, compute all stored
4153 buffer positions here.
4155 closure->start_min = -1; /* no need for this any more */
4156 closure->prev_start = extent_endpoint_bytind (extent, 0);
4157 closure->prev_end = extent_endpoint_bytind (extent, 1);
4159 return !NILP (closure->result);
4162 DEFUN ("map-extent-children", Fmap_extent_children, 1, 8, 0, /*
4163 Map FUNCTION over the extents in the region from FROM to TO.
4164 FUNCTION is called with arguments (extent, MAPARG). See `map-extents'
4165 for a full discussion of the arguments FROM, TO, and FLAGS.
4167 The arguments are the same as for `map-extents', but this function differs
4168 in that it only visits extents which start in the given region, and also
4169 in that, after visiting an extent E, it skips all other extents which start
4170 inside E but end before E's end.
4172 Thus, this function may be used to walk a tree of extents in a buffer:
4173 (defun walk-extents (buffer &optional ignore)
4174 (map-extent-children 'walk-extents buffer))
4176 (function, object, from, to, maparg, flags, property, value))
4178 /* This function can GC */
4179 struct slow_map_extent_children_arg closure;
4180 unsigned int me_flags;
4182 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
4185 if (EXTENTP (object))
4187 after = decode_extent (object, DE_MUST_BE_ATTACHED);
4189 from = Fextent_start_position (object);
4191 to = Fextent_end_position (object);
4192 object = extent_object (after);
4195 object = decode_buffer_or_string (object);
4197 get_buffer_or_string_range_byte (object, from, to, &start, &end,
4198 GB_ALLOW_NIL | GB_ALLOW_PAST_ACCESSIBLE);
4200 me_flags = decode_map_extents_flags (flags);
4202 if (!NILP (property))
4205 value = canonicalize_extent_property (property, value);
4208 GCPRO5 (function, maparg, object, property, value);
4210 closure.map_arg = maparg;
4211 closure.map_routine = function;
4212 closure.result = Qnil;
4213 closure.property = property;
4214 closure.value = value;
4215 closure.start_min = start;
4216 closure.prev_start = -1;
4217 closure.prev_end = -1;
4218 map_extents_bytind (start, end, slow_map_extent_children_function,
4219 (void *) &closure, object, after,
4220 /* You never know what the user might do ... */
4221 me_flags | ME_MIGHT_CALL_ELISP);
4224 return closure.result;
4227 /* ------------------------------- */
4229 /* ------------------------------- */
4231 /* find "smallest" matching extent containing pos -- (flag == 0) means
4232 all extents match, else (EXTENT_FLAGS (extent) & flag) must be true;
4233 for more than one matching extent with precisely the same endpoints,
4234 we choose the last extent in the extents_list.
4235 The search stops just before "before", if that is non-null.
4238 struct extent_at_arg
4254 static enum extent_at_flag
4255 decode_extent_at_flag (Lisp_Object at_flag)
4258 return EXTENT_AT_AFTER;
4260 CHECK_SYMBOL (at_flag);
4261 if (EQ (at_flag, Qafter)) return EXTENT_AT_AFTER;
4262 if (EQ (at_flag, Qbefore)) return EXTENT_AT_BEFORE;
4263 if (EQ (at_flag, Qat)) return EXTENT_AT_AT;
4265 signal_simple_error ("Invalid AT-FLAG in `extent-at'", at_flag);
4266 return EXTENT_AT_AFTER; /* unreached */
4270 extent_at_mapper (EXTENT e, void *arg)
4272 struct extent_at_arg *closure = (struct extent_at_arg *) arg;
4274 if (e == closure->before)
4277 /* If closure->prop is non-nil, then the extent is only acceptable
4278 if it has a non-nil value for that property. */
4279 if (!NILP (closure->prop))
4282 XSETEXTENT (extent, e);
4283 if (NILP (Fextent_property (extent, closure->prop, Qnil)))
4288 EXTENT current = closure->best_match;
4292 /* redundant but quick test */
4293 else if (extent_start (current) > extent_start (e))
4296 /* we return the "last" best fit, instead of the first --
4297 this is because then the glyph closest to two equivalent
4298 extents corresponds to the "extent-at" the text just past
4300 else if (!EXTENT_LESS_VALS (e, closure->best_start,
4306 closure->best_match = e;
4307 closure->best_start = extent_start (e);
4308 closure->best_end = extent_end (e);
4315 extent_at_bytind (Bytind position, Lisp_Object object, Lisp_Object property,
4316 EXTENT before, enum extent_at_flag at_flag)
4318 struct extent_at_arg closure;
4319 Lisp_Object extent_obj;
4321 /* it might be argued that invalid positions should cause
4322 errors, but the principle of least surprise dictates that
4323 nil should be returned (extent-at is often used in
4324 response to a mouse event, and in many cases previous events
4325 have changed the buffer contents).
4327 Also, the openness stuff in the text-property code currently
4328 does not check its limits and might go off the end. */
4329 if ((at_flag == EXTENT_AT_BEFORE
4330 ? position <= buffer_or_string_absolute_begin_byte (object)
4331 : position < buffer_or_string_absolute_begin_byte (object))
4332 || (at_flag == EXTENT_AT_AFTER
4333 ? position >= buffer_or_string_absolute_end_byte (object)
4334 : position > buffer_or_string_absolute_end_byte (object)))
4337 closure.best_match = 0;
4338 closure.prop = property;
4339 closure.before = before;
4341 map_extents_bytind (at_flag == EXTENT_AT_BEFORE ? position - 1 : position,
4342 at_flag == EXTENT_AT_AFTER ? position + 1 : position,
4343 extent_at_mapper, (void *) &closure, object, 0,
4344 ME_START_OPEN | ME_ALL_EXTENTS_CLOSED);
4346 if (!closure.best_match)
4349 XSETEXTENT (extent_obj, closure.best_match);
4353 DEFUN ("extent-at", Fextent_at, 1, 5, 0, /*
4354 Find "smallest" extent at POS in OBJECT having PROPERTY set.
4355 Normally, an extent is "at" POS if it overlaps the region (POS, POS+1);
4356 i.e. if it covers the character after POS. (However, see the definition
4357 of AT-FLAG.) "Smallest" means the extent that comes last in the display
4358 order; this normally means the extent whose start position is closest to
4359 POS. See `next-extent' for more information.
4360 OBJECT specifies a buffer or string and defaults to the current buffer.
4361 PROPERTY defaults to nil, meaning that any extent will do.
4362 Properties are attached to extents with `set-extent-property', which see.
4363 Returns nil if POS is invalid or there is no matching extent at POS.
4364 If the fourth argument BEFORE is not nil, it must be an extent; any returned
4365 extent will precede that extent. This feature allows `extent-at' to be
4366 used by a loop over extents.
4367 AT-FLAG controls how end cases are handled, and should be one of:
4369 nil or `after' An extent is at POS if it covers the character
4370 after POS. This is consistent with the way
4371 that text properties work.
4372 `before' An extent is at POS if it covers the character
4374 `at' An extent is at POS if it overlaps or abuts POS.
4375 This includes all zero-length extents at POS.
4377 Note that in all cases, the start-openness and end-openness of the extents
4378 considered is ignored. If you want to pay attention to those properties,
4379 you should use `map-extents', which gives you more control.
4381 (pos, object, property, before, at_flag))
4384 EXTENT before_extent;
4385 enum extent_at_flag fl;
4387 object = decode_buffer_or_string (object);
4388 position = get_buffer_or_string_pos_byte (object, pos, GB_NO_ERROR_IF_BAD);
4392 before_extent = decode_extent (before, DE_MUST_BE_ATTACHED);
4393 if (before_extent && !EQ (object, extent_object (before_extent)))
4394 signal_simple_error ("extent not in specified buffer or string", object);
4395 fl = decode_extent_at_flag (at_flag);
4397 return extent_at_bytind (position, object, property, before_extent, fl);
4400 /* ------------------------------- */
4401 /* verify_extent_modification() */
4402 /* ------------------------------- */
4404 /* verify_extent_modification() is called when a buffer or string is
4405 modified to check whether the modification is occuring inside a
4409 struct verify_extents_arg
4414 Lisp_Object iro; /* value of inhibit-read-only */
4418 verify_extent_mapper (EXTENT extent, void *arg)
4420 struct verify_extents_arg *closure = (struct verify_extents_arg *) arg;
4421 Lisp_Object prop = extent_read_only (extent);
4426 if (CONSP (closure->iro) && !NILP (Fmemq (prop, closure->iro)))
4429 #if 0 /* Nobody seems to care for this any more -sb */
4430 /* Allow deletion if the extent is completely contained in
4431 the region being deleted.
4432 This is important for supporting tokens which are internally
4433 write-protected, but which can be killed and yanked as a whole.
4434 Ignore open/closed distinctions at this point.
4437 if (closure->start != closure->end &&
4438 extent_start (extent) >= closure->start &&
4439 extent_end (extent) <= closure->end)
4444 Fsignal (Qbuffer_read_only, (list1 (closure->object)));
4446 RETURN_NOT_REACHED(0)
4449 /* Value of Vinhibit_read_only is precomputed and passed in for
4453 verify_extent_modification (Lisp_Object object, Bytind from, Bytind to,
4454 Lisp_Object inhibit_read_only_value)
4457 struct verify_extents_arg closure;
4459 /* If insertion, visit closed-endpoint extents touching the insertion
4460 point because the text would go inside those extents. If deletion,
4461 treat the range as open on both ends so that touching extents are not
4462 visited. Note that we assume that an insertion is occurring if the
4463 changed range has zero length, and a deletion otherwise. This
4464 fails if a change (i.e. non-insertion, non-deletion) is happening.
4465 As far as I know, this doesn't currently occur in XEmacs. --ben */
4466 closed = (from==to);
4467 closure.object = object;
4468 closure.start = buffer_or_string_bytind_to_memind (object, from);
4469 closure.end = buffer_or_string_bytind_to_memind (object, to);
4470 closure.iro = inhibit_read_only_value;
4472 map_extents_bytind (from, to, verify_extent_mapper, (void *) &closure,
4473 object, 0, closed ? ME_END_CLOSED : ME_START_OPEN);
4476 /* ------------------------------------ */
4477 /* process_extents_for_insertion() */
4478 /* ------------------------------------ */
4480 struct process_extents_for_insertion_arg
4487 /* A region of length LENGTH was just inserted at OPOINT. Modify all
4488 of the extents as required for the insertion, based on their
4489 start-open/end-open properties.
4493 process_extents_for_insertion_mapper (EXTENT extent, void *arg)
4495 struct process_extents_for_insertion_arg *closure =
4496 (struct process_extents_for_insertion_arg *) arg;
4497 Memind indice = buffer_or_string_bytind_to_memind (closure->object,
4500 /* When this function is called, one end of the newly-inserted text should
4501 be adjacent to some endpoint of the extent, or disjoint from it. If
4502 the insertion overlaps any existing extent, something is wrong.
4504 #ifdef ERROR_CHECK_EXTENTS
4505 if (extent_start (extent) > indice &&
4506 extent_start (extent) < indice + closure->length)
4508 if (extent_end (extent) > indice &&
4509 extent_end (extent) < indice + closure->length)
4513 /* The extent-adjustment code adjusted the extent's endpoints as if
4514 they were markers -- endpoints at the gap (i.e. the insertion
4515 point) go to the left of the insertion point, which is correct
4516 for [) extents. We need to fix the other kinds of extents.
4518 Note that both conditions below will hold for zero-length (]
4519 extents at the gap. Zero-length () extents would get adjusted
4520 such that their start is greater than their end; we treat them
4521 as [) extents. This is unfortunately an inelegant part of the
4522 extent model, but there is no way around it. */
4525 Memind new_start, new_end;
4527 new_start = extent_start (extent);
4528 new_end = extent_end (extent);
4529 if (indice == extent_start (extent) && extent_start_open_p (extent) &&
4530 /* coerce zero-length () extents to [) */
4531 new_start != new_end)
4532 new_start += closure->length;
4533 if (indice == extent_end (extent) && !extent_end_open_p (extent))
4534 new_end += closure->length;
4535 set_extent_endpoints_1 (extent, new_start, new_end);
4542 process_extents_for_insertion (Lisp_Object object, Bytind opoint,
4545 struct process_extents_for_insertion_arg closure;
4547 closure.opoint = opoint;
4548 closure.length = length;
4549 closure.object = object;
4551 map_extents_bytind (opoint, opoint + length,
4552 process_extents_for_insertion_mapper,
4553 (void *) &closure, object, 0,
4554 ME_END_CLOSED | ME_MIGHT_MODIFY_EXTENTS |
4555 ME_INCLUDE_INTERNAL);
4558 /* ------------------------------------ */
4559 /* process_extents_for_deletion() */
4560 /* ------------------------------------ */
4562 struct process_extents_for_deletion_arg
4565 int destroy_included_extents;
4568 /* This function is called when we're about to delete the range [from, to].
4569 Detach all of the extents that are completely inside the range [from, to],
4570 if they're detachable or open-open. */
4573 process_extents_for_deletion_mapper (EXTENT extent, void *arg)
4575 struct process_extents_for_deletion_arg *closure =
4576 (struct process_extents_for_deletion_arg *) arg;
4578 /* If the extent lies completely within the range that
4579 is being deleted, then nuke the extent if it's detachable
4580 (otherwise, it will become a zero-length extent). */
4582 if (closure->start <= extent_start (extent) &&
4583 extent_end (extent) <= closure->end)
4585 if (extent_detachable_p (extent))
4587 if (closure->destroy_included_extents)
4588 destroy_extent (extent);
4590 extent_detach (extent);
4597 /* DESTROY_THEM means destroy the extents instead of just deleting them.
4598 It is unused currently, but perhaps might be used (there used to
4599 be a function process_extents_for_destruction(), #if 0'd out,
4600 that did the equivalent). */
4602 process_extents_for_deletion (Lisp_Object object, Bytind from,
4603 Bytind to, int destroy_them)
4605 struct process_extents_for_deletion_arg closure;
4607 closure.start = buffer_or_string_bytind_to_memind (object, from);
4608 closure.end = buffer_or_string_bytind_to_memind (object, to);
4609 closure.destroy_included_extents = destroy_them;
4611 map_extents_bytind (from, to, process_extents_for_deletion_mapper,
4612 (void *) &closure, object, 0,
4613 ME_END_CLOSED | ME_MIGHT_MODIFY_EXTENTS);
4616 /* ------------------------------- */
4617 /* report_extent_modification() */
4618 /* ------------------------------- */
4619 struct report_extent_modification_closure {
4627 report_extent_modification_restore (Lisp_Object buffer)
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
4655 One confusing thing here is that our caller never actually calls
4656 unbind_to (closure.speccount, Qnil). This is because
4657 map_extents_bytind() unbinds before, and with a smaller
4658 speccount. The additional unbind_to() in
4659 report_extent_modification() would cause XEmacs to abort. */
4660 if (closure->speccount == -1)
4662 closure->speccount = specpdl_depth ();
4663 record_unwind_protect (report_extent_modification_restore,
4664 Fcurrent_buffer ());
4667 /* The functions will expect closure->buffer to be the current
4668 buffer, so change it if it isn't. */
4669 if (current_buffer != XBUFFER (closure->buffer))
4670 Fset_buffer (closure->buffer);
4672 /* #### It's a shame that we can't use any of the existing run_hook*
4673 functions here. This is so because all of them work with
4674 symbols, to be able to retrieve default values of local hooks.
4677 #### Idea: we could set up a dummy symbol, and call the hook
4678 functions on *that*. */
4680 if (!CONSP (hook) || EQ (XCAR (hook), Qlambda))
4681 call3 (hook, exobj, startobj, endobj);
4685 EXTERNAL_LIST_LOOP (tail, hook)
4686 /* #### Shouldn't this perform the same Fset_buffer() check as
4688 call3 (XCAR (tail), exobj, startobj, endobj);
4694 report_extent_modification (Lisp_Object buffer, Bufpos start, Bufpos end,
4697 struct report_extent_modification_closure closure;
4699 closure.buffer = buffer;
4700 closure.start = start;
4702 closure.afterp = afterp;
4703 closure.speccount = -1;
4705 map_extents (start, end, report_extent_modification_mapper, (void *)&closure,
4706 buffer, NULL, ME_MIGHT_CALL_ELISP);
4710 /************************************************************************/
4711 /* extent properties */
4712 /************************************************************************/
4715 set_extent_invisible (EXTENT extent, Lisp_Object value)
4717 if (!EQ (extent_invisible (extent), value))
4719 set_extent_invisible_1 (extent, value);
4720 extent_changed_for_redisplay (extent, 1, 1);
4724 /* This function does "memoization" -- similar to the interning
4725 that happens with symbols. Given a list of faces, an equivalent
4726 list is returned such that if this function is called twice with
4727 input that is `equal', the resulting outputs will be `eq'.
4729 Note that the inputs and outputs are in general *not* `equal' --
4730 faces in symbol form become actual face objects in the output.
4731 This is necessary so that temporary faces stay around. */
4734 memoize_extent_face_internal (Lisp_Object list)
4738 Lisp_Object cons, thecons;
4739 Lisp_Object oldtail, tail;
4740 struct gcpro gcpro1;
4745 return Fget_face (list);
4747 /* To do the memoization, we use a hash table mapping from
4748 external lists to internal lists. We do `equal' comparisons
4749 on the keys so the memoization works correctly.
4751 Note that we canonicalize things so that the keys in the
4752 hash table (the external lists) always contain symbols and
4753 the values (the internal lists) always contain face objects.
4755 We also maintain a "reverse" table that maps from the internal
4756 lists to the external equivalents. The idea here is twofold:
4758 1) `extent-face' wants to return a list containing face symbols
4759 rather than face objects.
4760 2) We don't want things to get quite so messed up if the user
4761 maliciously side-effects the returned lists.
4764 len = XINT (Flength (list));
4765 thelen = XINT (Flength (Vextent_face_reusable_list));
4770 /* We canonicalize the given list into another list.
4771 We try to avoid consing except when necessary, so we have
4777 cons = Vextent_face_reusable_list;
4778 while (!NILP (XCDR (cons)))
4780 XCDR (cons) = Fmake_list (make_int (len - thelen), Qnil);
4782 else if (thelen > len)
4786 /* Truncate the list temporarily so it's the right length;
4787 remember the old tail. */
4788 cons = Vextent_face_reusable_list;
4789 for (i = 0; i < len - 1; i++)
4792 oldtail = XCDR (cons);
4796 thecons = Vextent_face_reusable_list;
4797 EXTERNAL_LIST_LOOP (cons, list)
4799 Lisp_Object face = Fget_face (XCAR (cons));
4801 XCAR (thecons) = Fface_name (face);
4802 thecons = XCDR (thecons);
4805 list = Fgethash (Vextent_face_reusable_list, Vextent_face_memoize_hash_table,
4809 Lisp_Object symlist = Fcopy_sequence (Vextent_face_reusable_list);
4810 Lisp_Object facelist = Fcopy_sequence (Vextent_face_reusable_list);
4812 LIST_LOOP (cons, facelist)
4814 XCAR (cons) = Fget_face (XCAR (cons));
4816 Fputhash (symlist, facelist, Vextent_face_memoize_hash_table);
4817 Fputhash (facelist, symlist, Vextent_face_reverse_memoize_hash_table);
4821 /* Now restore the truncated tail of the reusable list, if necessary. */
4823 XCDR (tail) = oldtail;
4830 external_of_internal_memoized_face (Lisp_Object face)
4834 else if (!CONSP (face))
4835 return XFACE (face)->name;
4838 face = Fgethash (face, Vextent_face_reverse_memoize_hash_table,
4840 assert (!UNBOUNDP (face));
4846 canonicalize_extent_property (Lisp_Object prop, Lisp_Object value)
4848 if (EQ (prop, Qface) || EQ (prop, Qmouse_face))
4849 value = (external_of_internal_memoized_face
4850 (memoize_extent_face_internal (value)));
4854 /* Do we need a lisp-level function ? */
4855 DEFUN ("set-extent-initial-redisplay-function", Fset_extent_initial_redisplay_function,
4857 Note: This feature is experimental!
4859 Set initial-redisplay-function of EXTENT to the function
4862 The first time the EXTENT is (re)displayed, an eval event will be
4863 dispatched calling FUNCTION with EXTENT as its only argument.
4867 EXTENT e = decode_extent(extent, DE_MUST_BE_ATTACHED);
4869 e = extent_ancestor (e); /* Is this needed? Macro also does chasing!*/
4870 set_extent_initial_redisplay_function(e,function);
4871 extent_in_red_event_p(e) = 0; /* If the function changed we can spawn
4873 extent_changed_for_redisplay(e,1,0); /* Do we need to mark children too ?*/
4878 DEFUN ("extent-face", Fextent_face, 1, 1, 0, /*
4879 Return the name of the face in which EXTENT is displayed, or nil
4880 if the extent's face is unspecified. This might also return a list
4887 CHECK_EXTENT (extent);
4888 face = extent_face (XEXTENT (extent));
4890 return external_of_internal_memoized_face (face);
4893 DEFUN ("set-extent-face", Fset_extent_face, 2, 2, 0, /*
4894 Make the given EXTENT have the graphic attributes specified by FACE.
4895 FACE can also be a list of faces, and all faces listed will apply,
4896 with faces earlier in the list taking priority over those later in the
4901 EXTENT e = decode_extent(extent, 0);
4902 Lisp_Object orig_face = face;
4904 /* retrieve the ancestor for efficiency and proper redisplay noting. */
4905 e = extent_ancestor (e);
4907 face = memoize_extent_face_internal (face);
4909 extent_face (e) = face;
4910 extent_changed_for_redisplay (e, 1, 0);
4916 DEFUN ("extent-mouse-face", Fextent_mouse_face, 1, 1, 0, /*
4917 Return the face used to highlight EXTENT when the mouse passes over it.
4918 The return value will be a face name, a list of face names, or nil
4919 if the extent's mouse face is unspecified.
4925 CHECK_EXTENT (extent);
4926 face = extent_mouse_face (XEXTENT (extent));
4928 return external_of_internal_memoized_face (face);
4931 DEFUN ("set-extent-mouse-face", Fset_extent_mouse_face, 2, 2, 0, /*
4932 Set the face used to highlight EXTENT when the mouse passes over it.
4933 FACE can also be a list of faces, and all faces listed will apply,
4934 with faces earlier in the list taking priority over those later in the
4940 Lisp_Object orig_face = face;
4942 CHECK_EXTENT (extent);
4943 e = XEXTENT (extent);
4944 /* retrieve the ancestor for efficiency and proper redisplay noting. */
4945 e = extent_ancestor (e);
4947 face = memoize_extent_face_internal (face);
4949 set_extent_mouse_face (e, face);
4950 extent_changed_for_redisplay (e, 1, 0);
4956 set_extent_glyph (EXTENT extent, Lisp_Object glyph, int endp,
4957 glyph_layout layout)
4959 extent = extent_ancestor (extent);
4963 set_extent_begin_glyph (extent, glyph);
4964 extent_begin_glyph_layout (extent) = layout;
4968 set_extent_end_glyph (extent, glyph);
4969 extent_end_glyph_layout (extent) = layout;
4972 extent_changed_for_redisplay (extent, 1, 0);
4976 glyph_layout_to_symbol (glyph_layout layout)
4980 case GL_TEXT: return Qtext;
4981 case GL_OUTSIDE_MARGIN: return Qoutside_margin;
4982 case GL_INSIDE_MARGIN: return Qinside_margin;
4983 case GL_WHITESPACE: return Qwhitespace;
4986 return Qnil; /* unreached */
4991 symbol_to_glyph_layout (Lisp_Object layout_obj)
4993 if (NILP (layout_obj))
4996 CHECK_SYMBOL (layout_obj);
4997 if (EQ (layout_obj, Qoutside_margin)) return GL_OUTSIDE_MARGIN;
4998 if (EQ (layout_obj, Qinside_margin)) return GL_INSIDE_MARGIN;
4999 if (EQ (layout_obj, Qwhitespace)) return GL_WHITESPACE;
5000 if (EQ (layout_obj, Qtext)) return GL_TEXT;
5002 signal_simple_error ("Unknown glyph layout type", layout_obj);
5003 return GL_TEXT; /* unreached */
5007 set_extent_glyph_1 (Lisp_Object extent_obj, Lisp_Object glyph, int endp,
5008 Lisp_Object layout_obj)
5010 EXTENT extent = decode_extent (extent_obj, 0);
5011 glyph_layout layout = symbol_to_glyph_layout (layout_obj);
5013 /* Make sure we've actually been given a valid glyph or it's nil
5014 (meaning we're deleting a glyph from an extent). */
5016 CHECK_BUFFER_GLYPH (glyph);
5018 set_extent_glyph (extent, glyph, endp, layout);
5022 DEFUN ("set-extent-begin-glyph", Fset_extent_begin_glyph, 2, 3, 0, /*
5023 Display a bitmap, subwindow or string at the beginning of EXTENT.
5024 BEGIN-GLYPH must be a glyph object. The layout policy defaults to `text'.
5026 (extent, begin_glyph, layout))
5028 return set_extent_glyph_1 (extent, begin_glyph, 0, layout);
5031 DEFUN ("set-extent-end-glyph", Fset_extent_end_glyph, 2, 3, 0, /*
5032 Display a bitmap, subwindow or string at the end of EXTENT.
5033 END-GLYPH must be a glyph object. The layout policy defaults to `text'.
5035 (extent, end_glyph, layout))
5037 return set_extent_glyph_1 (extent, end_glyph, 1, layout);
5040 DEFUN ("extent-begin-glyph", Fextent_begin_glyph, 1, 1, 0, /*
5041 Return the glyph object displayed at the beginning of EXTENT.
5042 If there is none, nil is returned.
5046 return extent_begin_glyph (decode_extent (extent, 0));
5049 DEFUN ("extent-end-glyph", Fextent_end_glyph, 1, 1, 0, /*
5050 Return the glyph object displayed at the end of EXTENT.
5051 If there is none, nil is returned.
5055 return extent_end_glyph (decode_extent (extent, 0));
5058 DEFUN ("set-extent-begin-glyph-layout", Fset_extent_begin_glyph_layout, 2, 2, 0, /*
5059 Set the layout policy of EXTENT's begin glyph.
5060 Access this using the `extent-begin-glyph-layout' function.
5064 EXTENT e = decode_extent (extent, 0);
5065 e = extent_ancestor (e);
5066 extent_begin_glyph_layout (e) = symbol_to_glyph_layout (layout);
5067 extent_maybe_changed_for_redisplay (e, 1, 0);
5071 DEFUN ("set-extent-end-glyph-layout", Fset_extent_end_glyph_layout, 2, 2, 0, /*
5072 Set the layout policy of EXTENT's end glyph.
5073 Access this using the `extent-end-glyph-layout' function.
5077 EXTENT e = decode_extent (extent, 0);
5078 e = extent_ancestor (e);
5079 extent_end_glyph_layout (e) = symbol_to_glyph_layout (layout);
5080 extent_maybe_changed_for_redisplay (e, 1, 0);
5084 DEFUN ("extent-begin-glyph-layout", Fextent_begin_glyph_layout, 1, 1, 0, /*
5085 Return the layout policy associated with EXTENT's begin glyph.
5086 Set this using the `set-extent-begin-glyph-layout' function.
5090 EXTENT e = decode_extent (extent, 0);
5091 return glyph_layout_to_symbol ((glyph_layout) extent_begin_glyph_layout (e));
5094 DEFUN ("extent-end-glyph-layout", Fextent_end_glyph_layout, 1, 1, 0, /*
5095 Return the layout policy associated with EXTENT's end glyph.
5096 Set this using the `set-extent-end-glyph-layout' function.
5100 EXTENT e = decode_extent (extent, 0);
5101 return glyph_layout_to_symbol ((glyph_layout) extent_end_glyph_layout (e));
5104 DEFUN ("set-extent-priority", Fset_extent_priority, 2, 2, 0, /*
5105 Set the display priority of EXTENT to PRIORITY (an integer).
5106 When the extent attributes are being merged for display, the priority
5107 is used to determine which extent takes precedence in the event of a
5108 conflict (two extents whose faces both specify font, for example: the
5109 font of the extent with the higher priority will be used).
5110 Extents are created with priority 0; priorities may be negative.
5114 EXTENT e = decode_extent (extent, 0);
5116 CHECK_INT (priority);
5117 e = extent_ancestor (e);
5118 set_extent_priority (e, XINT (priority));
5119 extent_maybe_changed_for_redisplay (e, 1, 0);
5123 DEFUN ("extent-priority", Fextent_priority, 1, 1, 0, /*
5124 Return the display priority of EXTENT; see `set-extent-priority'.
5128 EXTENT e = decode_extent (extent, 0);
5129 return make_int (extent_priority (e));
5132 DEFUN ("set-extent-property", Fset_extent_property, 3, 3, 0, /*
5133 Change a property of an extent.
5134 PROPERTY may be any symbol; the value stored may be accessed with
5135 the `extent-property' function.
5136 The following symbols have predefined meanings:
5138 detached Removes the extent from its buffer; setting this is
5139 the same as calling `detach-extent'.
5141 destroyed Removes the extent from its buffer, and makes it
5142 unusable in the future; this is the same calling
5145 priority Change redisplay priority; same as `set-extent-priority'.
5147 start-open Whether the set of characters within the extent is
5148 treated being open on the left, that is, whether
5149 the start position is an exclusive, rather than
5150 inclusive, boundary. If true, then characters
5151 inserted exactly at the beginning of the extent
5152 will remain outside of the extent; otherwise they
5153 will go into the extent, extending it.
5155 end-open Whether the set of characters within the extent is
5156 treated being open on the right, that is, whether
5157 the end position is an exclusive, rather than
5158 inclusive, boundary. If true, then characters
5159 inserted exactly at the end of the extent will
5160 remain outside of the extent; otherwise they will
5161 go into the extent, extending it.
5163 By default, extents have the `end-open' but not the
5164 `start-open' property set.
5166 read-only Text within this extent will be unmodifiable.
5168 initial-redisplay-function (EXPERIMENTAL)
5169 function to be called the first time (part of) the extent
5170 is redisplayed. It will be called with the extent as its
5172 Note: The function will not be called immediately
5173 during redisplay, an eval event will be dispatched.
5175 detachable Whether the extent gets detached (as with
5176 `detach-extent') when all the text within the
5177 extent is deleted. This is true by default. If
5178 this property is not set, the extent becomes a
5179 zero-length extent when its text is deleted. (In
5180 such a case, the `start-open' property is
5181 automatically removed if both the `start-open' and
5182 `end-open' properties are set, since zero-length
5183 extents open on both ends are not allowed.)
5185 face The face in which to display the text. Setting
5186 this is the same as calling `set-extent-face'.
5188 mouse-face If non-nil, the extent will be highlighted in this
5189 face when the mouse moves over it.
5191 pointer If non-nil, and a valid pointer glyph, this specifies
5192 the shape of the mouse pointer while over the extent.
5194 highlight Obsolete: Setting this property is equivalent to
5195 setting a `mouse-face' property of `highlight'.
5196 Reading this property returns non-nil if
5197 the extent has a non-nil `mouse-face' property.
5199 duplicable Whether this extent should be copied into strings,
5200 so that kill, yank, and undo commands will restore
5201 or copy it. `duplicable' extents are copied from
5202 an extent into a string when `buffer-substring' or
5203 a similar function creates a string. The extents
5204 in a string are copied into other strings created
5205 from the string using `concat' or `substring'.
5206 When `insert' or a similar function inserts the
5207 string into a buffer, the extents are copied back
5210 unique Meaningful only in conjunction with `duplicable'.
5211 When this is set, there may be only one instance
5212 of this extent attached at a time: if it is copied
5213 to the kill ring and then yanked, the extent is
5214 not copied. If, however, it is killed (removed
5215 from the buffer) and then yanked, it will be
5216 re-attached at the new position.
5218 invisible If the value is non-nil, text under this extent
5219 may be treated as not present for the purpose of
5220 redisplay, or may be displayed using an ellipsis
5221 or other marker; see `buffer-invisibility-spec'
5222 and `invisible-text-glyph'. In all cases,
5223 however, the text is still visible to other
5224 functions that examine a buffer's text.
5226 keymap This keymap is consulted for mouse clicks on this
5227 extent, or keypresses made while point is within the
5230 copy-function This is a hook that is run when a duplicable extent
5231 is about to be copied from a buffer to a string (or
5232 the kill ring). It is called with three arguments,
5233 the extent, and the buffer-positions within it
5234 which are being copied. If this function returns
5235 nil, then the extent will not be copied; otherwise
5238 paste-function This is a hook that is run when a duplicable extent is
5239 about to be copied from a string (or the kill ring)
5240 into a buffer. It is called with three arguments,
5241 the original extent, and the buffer positions which
5242 the copied extent will occupy. (This hook is run
5243 after the corresponding text has already been
5244 inserted into the buffer.) Note that the extent
5245 argument may be detached when this function is run.
5246 If this function returns nil, no extent will be
5247 inserted. Otherwise, there will be an extent
5248 covering the range in question.
5250 If the original extent is not attached to a buffer,
5251 then it will be re-attached at this range.
5252 Otherwise, a copy will be made, and that copy
5255 The copy-function and paste-function are meaningful
5256 only for extents with the `duplicable' flag set,
5257 and if they are not specified, behave as if `t' was
5258 the returned value. When these hooks are invoked,
5259 the current buffer is the buffer which the extent
5260 is being copied from/to, respectively.
5262 begin-glyph A glyph to be displayed at the beginning of the extent,
5265 end-glyph A glyph to be displayed at the end of the extent,
5268 begin-glyph-layout The layout policy (one of `text', `whitespace',
5269 `inside-margin', or `outside-margin') of the extent's
5272 end-glyph-layout The layout policy of the extent's end glyph.
5274 (extent, property, value))
5276 /* This function can GC if property is `keymap' */
5277 EXTENT e = decode_extent (extent, 0);
5279 if (EQ (property, Qread_only))
5280 set_extent_read_only (e, value);
5281 else if (EQ (property, Qunique))
5282 extent_unique_p (e) = !NILP (value);
5283 else if (EQ (property, Qduplicable))
5284 extent_duplicable_p (e) = !NILP (value);
5285 else if (EQ (property, Qinvisible))
5286 set_extent_invisible (e, value);
5287 else if (EQ (property, Qdetachable))
5288 extent_detachable_p (e) = !NILP (value);
5290 else if (EQ (property, Qdetached))
5293 error ("can only set `detached' to t");
5294 Fdetach_extent (extent);
5296 else if (EQ (property, Qdestroyed))
5299 error ("can only set `destroyed' to t");
5300 Fdelete_extent (extent);
5302 else if (EQ (property, Qpriority))
5303 Fset_extent_priority (extent, value);
5304 else if (EQ (property, Qface))
5305 Fset_extent_face (extent, value);
5306 else if (EQ (property, Qinitial_redisplay_function))
5307 Fset_extent_initial_redisplay_function (extent, value);
5308 else if (EQ (property, Qbefore_change_functions))
5309 set_extent_before_change_functions (e, value);
5310 else if (EQ (property, Qafter_change_functions))
5311 set_extent_after_change_functions (e, value);
5312 else if (EQ (property, Qmouse_face))
5313 Fset_extent_mouse_face (extent, value);
5315 else if (EQ (property, Qhighlight))
5316 Fset_extent_mouse_face (extent, Qhighlight);
5317 else if (EQ (property, Qbegin_glyph_layout))
5318 Fset_extent_begin_glyph_layout (extent, value);
5319 else if (EQ (property, Qend_glyph_layout))
5320 Fset_extent_end_glyph_layout (extent, value);
5321 /* For backwards compatibility. We use begin glyph because it is by
5322 far the more used of the two. */
5323 else if (EQ (property, Qglyph_layout))
5324 Fset_extent_begin_glyph_layout (extent, value);
5325 else if (EQ (property, Qbegin_glyph))
5326 Fset_extent_begin_glyph (extent, value, Qnil);
5327 else if (EQ (property, Qend_glyph))
5328 Fset_extent_end_glyph (extent, value, Qnil);
5329 else if (EQ (property, Qstart_open))
5330 set_extent_openness (e, !NILP (value), -1);
5331 else if (EQ (property, Qend_open))
5332 set_extent_openness (e, -1, !NILP (value));
5333 /* Support (but don't document...) the obvious *_closed antonyms. */
5334 else if (EQ (property, Qstart_closed))
5335 set_extent_openness (e, NILP (value), -1);
5336 else if (EQ (property, Qend_closed))
5337 set_extent_openness (e, -1, NILP (value));
5340 if (EQ (property, Qkeymap))
5341 while (!NILP (value) && NILP (Fkeymapp (value)))
5342 value = wrong_type_argument (Qkeymapp, value);
5344 external_plist_put (extent_plist_addr (e), property, value, 0, ERROR_ME);
5350 DEFUN ("set-extent-properties", Fset_extent_properties, 2, 2, 0, /*
5351 Change some properties of EXTENT.
5352 PLIST is a property list.
5353 For a list of built-in properties, see `set-extent-property'.
5357 /* This function can GC, if one of the properties is `keymap' */
5358 Lisp_Object property, value;
5359 struct gcpro gcpro1;
5362 plist = Fcopy_sequence (plist);
5363 Fcanonicalize_plist (plist, Qnil);
5365 while (!NILP (plist))
5367 property = Fcar (plist); plist = Fcdr (plist);
5368 value = Fcar (plist); plist = Fcdr (plist);
5369 Fset_extent_property (extent, property, value);
5375 DEFUN ("extent-property", Fextent_property, 2, 3, 0, /*
5376 Return EXTENT's value for property PROPERTY.
5377 See `set-extent-property' for the built-in property names.
5379 (extent, property, default_))
5381 EXTENT e = decode_extent (extent, 0);
5383 if (EQ (property, Qdetached))
5384 return extent_detached_p (e) ? Qt : Qnil;
5385 else if (EQ (property, Qdestroyed))
5386 return !EXTENT_LIVE_P (e) ? Qt : Qnil;
5387 else if (EQ (property, Qstart_open))
5388 return extent_normal_field (e, start_open) ? Qt : Qnil;
5389 else if (EQ (property, Qend_open))
5390 return extent_normal_field (e, end_open) ? Qt : Qnil;
5391 else if (EQ (property, Qunique))
5392 return extent_normal_field (e, unique) ? Qt : Qnil;
5393 else if (EQ (property, Qduplicable))
5394 return extent_normal_field (e, duplicable) ? Qt : Qnil;
5395 else if (EQ (property, Qdetachable))
5396 return extent_normal_field (e, detachable) ? Qt : Qnil;
5397 /* Support (but don't document...) the obvious *_closed antonyms. */
5398 else if (EQ (property, Qstart_closed))
5399 return extent_start_open_p (e) ? Qnil : Qt;
5400 else if (EQ (property, Qend_closed))
5401 return extent_end_open_p (e) ? Qnil : Qt;
5402 else if (EQ (property, Qpriority))
5403 return make_int (extent_priority (e));
5404 else if (EQ (property, Qread_only))
5405 return extent_read_only (e);
5406 else if (EQ (property, Qinvisible))
5407 return extent_invisible (e);
5408 else if (EQ (property, Qface))
5409 return Fextent_face (extent);
5410 else if (EQ (property, Qinitial_redisplay_function))
5411 return extent_initial_redisplay_function (e);
5412 else if (EQ (property, Qbefore_change_functions))
5413 return extent_before_change_functions (e);
5414 else if (EQ (property, Qafter_change_functions))
5415 return extent_after_change_functions (e);
5416 else if (EQ (property, Qmouse_face))
5417 return Fextent_mouse_face (extent);
5419 else if (EQ (property, Qhighlight))
5420 return !NILP (Fextent_mouse_face (extent)) ? Qt : Qnil;
5421 else if (EQ (property, Qbegin_glyph_layout))
5422 return Fextent_begin_glyph_layout (extent);
5423 else if (EQ (property, Qend_glyph_layout))
5424 return Fextent_end_glyph_layout (extent);
5425 /* For backwards compatibility. We use begin glyph because it is by
5426 far the more used of the two. */
5427 else if (EQ (property, Qglyph_layout))
5428 return Fextent_begin_glyph_layout (extent);
5429 else if (EQ (property, Qbegin_glyph))
5430 return extent_begin_glyph (e);
5431 else if (EQ (property, Qend_glyph))
5432 return extent_end_glyph (e);
5435 Lisp_Object value = external_plist_get (extent_plist_addr (e),
5436 property, 0, ERROR_ME);
5437 return UNBOUNDP (value) ? default_ : value;
5441 DEFUN ("extent-properties", Fextent_properties, 1, 1, 0, /*
5442 Return a property list of the attributes of EXTENT.
5443 Do not modify this list; use `set-extent-property' instead.
5448 Lisp_Object result, face, anc_obj;
5449 glyph_layout layout;
5451 CHECK_EXTENT (extent);
5452 e = XEXTENT (extent);
5453 if (!EXTENT_LIVE_P (e))
5454 return cons3 (Qdestroyed, Qt, Qnil);
5456 anc = extent_ancestor (e);
5457 XSETEXTENT (anc_obj, anc);
5459 /* For efficiency, use the ancestor for all properties except detached */
5461 result = extent_plist_slot (anc);
5463 if (!NILP (face = Fextent_face (anc_obj)))
5464 result = cons3 (Qface, face, result);
5466 if (!NILP (face = Fextent_mouse_face (anc_obj)))
5467 result = cons3 (Qmouse_face, face, result);
5469 if ((layout = (glyph_layout) extent_begin_glyph_layout (anc)) != GL_TEXT)
5471 Lisp_Object sym = glyph_layout_to_symbol (layout);
5472 result = cons3 (Qglyph_layout, sym, result); /* compatibility */
5473 result = cons3 (Qbegin_glyph_layout, sym, result);
5476 if ((layout = (glyph_layout) extent_end_glyph_layout (anc)) != GL_TEXT)
5477 result = cons3 (Qend_glyph_layout, glyph_layout_to_symbol (layout), result);
5479 if (!NILP (extent_end_glyph (anc)))
5480 result = cons3 (Qend_glyph, extent_end_glyph (anc), result);
5482 if (!NILP (extent_begin_glyph (anc)))
5483 result = cons3 (Qbegin_glyph, extent_begin_glyph (anc), result);
5485 if (extent_priority (anc) != 0)
5486 result = cons3 (Qpriority, make_int (extent_priority (anc)), result);
5488 if (!NILP (extent_initial_redisplay_function (anc)))
5489 result = cons3 (Qinitial_redisplay_function,
5490 extent_initial_redisplay_function (anc), result);
5492 if (!NILP (extent_before_change_functions (anc)))
5493 result = cons3 (Qbefore_change_functions,
5494 extent_before_change_functions (anc), result);
5496 if (!NILP (extent_after_change_functions (anc)))
5497 result = cons3 (Qafter_change_functions,
5498 extent_after_change_functions (anc), result);
5500 if (!NILP (extent_invisible (anc)))
5501 result = cons3 (Qinvisible, extent_invisible (anc), result);
5503 if (!NILP (extent_read_only (anc)))
5504 result = cons3 (Qread_only, extent_read_only (anc), result);
5506 if (extent_normal_field (anc, end_open))
5507 result = cons3 (Qend_open, Qt, result);
5509 if (extent_normal_field (anc, start_open))
5510 result = cons3 (Qstart_open, Qt, result);
5512 if (extent_normal_field (anc, detachable))
5513 result = cons3 (Qdetachable, Qt, result);
5515 if (extent_normal_field (anc, duplicable))
5516 result = cons3 (Qduplicable, Qt, result);
5518 if (extent_normal_field (anc, unique))
5519 result = cons3 (Qunique, Qt, result);
5521 /* detached is not an inherited property */
5522 if (extent_detached_p (e))
5523 result = cons3 (Qdetached, Qt, result);
5529 /************************************************************************/
5531 /************************************************************************/
5533 /* The display code looks into the Vlast_highlighted_extent variable to
5534 correctly display highlighted extents. This updates that variable,
5535 and marks the appropriate buffers as needing some redisplay.
5538 do_highlight (Lisp_Object extent_obj, int highlight_p)
5540 if (( highlight_p && (EQ (Vlast_highlighted_extent, extent_obj))) ||
5541 (!highlight_p && (EQ (Vlast_highlighted_extent, Qnil))))
5543 if (EXTENTP (Vlast_highlighted_extent) &&
5544 EXTENT_LIVE_P (XEXTENT (Vlast_highlighted_extent)))
5546 /* do not recurse on descendants. Only one extent is highlighted
5548 extent_changed_for_redisplay (XEXTENT (Vlast_highlighted_extent), 0, 0);
5550 Vlast_highlighted_extent = Qnil;
5551 if (!NILP (extent_obj)
5552 && BUFFERP (extent_object (XEXTENT (extent_obj)))
5555 extent_changed_for_redisplay (XEXTENT (extent_obj), 0, 0);
5556 Vlast_highlighted_extent = extent_obj;
5560 DEFUN ("force-highlight-extent", Fforce_highlight_extent, 1, 2, 0, /*
5561 Highlight or unhighlight the given extent.
5562 If the second arg is non-nil, it will be highlighted, else dehighlighted.
5563 This is the same as `highlight-extent', except that it will work even
5564 on extents without the `mouse-face' property.
5566 (extent, highlight_p))
5571 XSETEXTENT (extent, decode_extent (extent, DE_MUST_BE_ATTACHED));
5572 do_highlight (extent, !NILP (highlight_p));
5576 DEFUN ("highlight-extent", Fhighlight_extent, 1, 2, 0, /*
5577 Highlight EXTENT, if it is highlightable.
5578 \(that is, if it has the `mouse-face' property).
5579 If the second arg is non-nil, it will be highlighted, else dehighlighted.
5580 Highlighted extents are displayed as if they were merged with the face
5581 or faces specified by the `mouse-face' property.
5583 (extent, highlight_p))
5585 if (EXTENTP (extent) && NILP (extent_mouse_face (XEXTENT (extent))))
5588 return Fforce_highlight_extent (extent, highlight_p);
5592 /************************************************************************/
5593 /* strings and extents */
5594 /************************************************************************/
5596 /* copy/paste hooks */
5599 run_extent_copy_paste_internal (EXTENT e, Bufpos from, Bufpos to,
5603 /* This function can GC */
5605 Lisp_Object copy_fn;
5606 XSETEXTENT (extent, e);
5607 copy_fn = Fextent_property (extent, prop, Qnil);
5608 if (!NILP (copy_fn))
5611 struct gcpro gcpro1, gcpro2, gcpro3;
5612 GCPRO3 (extent, copy_fn, object);
5613 if (BUFFERP (object))
5614 flag = call3_in_buffer (XBUFFER (object), copy_fn, extent,
5615 make_int (from), make_int (to));
5617 flag = call3 (copy_fn, extent, make_int (from), make_int (to));
5619 if (NILP (flag) || !EXTENT_LIVE_P (XEXTENT (extent)))
5626 run_extent_copy_function (EXTENT e, Bytind from, Bytind to)
5628 Lisp_Object object = extent_object (e);
5629 /* This function can GC */
5630 return run_extent_copy_paste_internal
5631 (e, buffer_or_string_bytind_to_bufpos (object, from),
5632 buffer_or_string_bytind_to_bufpos (object, to), object,
5637 run_extent_paste_function (EXTENT e, Bytind from, Bytind to,
5640 /* This function can GC */
5641 return run_extent_copy_paste_internal
5642 (e, buffer_or_string_bytind_to_bufpos (object, from),
5643 buffer_or_string_bytind_to_bufpos (object, to), object,
5648 update_extent (EXTENT extent, Bytind from, Bytind to)
5650 set_extent_endpoints (extent, from, to, Qnil);
5653 /* Insert an extent, usually from the dup_list of a string which
5654 has just been inserted.
5655 This code does not handle the case of undo.
5658 insert_extent (EXTENT extent, Bytind new_start, Bytind new_end,
5659 Lisp_Object object, int run_hooks)
5661 /* This function can GC */
5664 if (!EQ (extent_object (extent), object))
5667 if (extent_detached_p (extent))
5670 !run_extent_paste_function (extent, new_start, new_end, object))
5671 /* The paste-function said don't re-attach this extent here. */
5674 update_extent (extent, new_start, new_end);
5678 Bytind exstart = extent_endpoint_bytind (extent, 0);
5679 Bytind exend = extent_endpoint_bytind (extent, 1);
5681 if (exend < new_start || exstart > new_end)
5685 new_start = min (exstart, new_start);
5686 new_end = max (exend, new_end);
5687 if (exstart != new_start || exend != new_end)
5688 update_extent (extent, new_start, new_end);
5692 XSETEXTENT (tmp, extent);
5697 !run_extent_paste_function (extent, new_start, new_end, object))
5698 /* The paste-function said don't attach a copy of the extent here. */
5702 XSETEXTENT (tmp, copy_extent (extent, new_start, new_end, object));
5707 DEFUN ("insert-extent", Finsert_extent, 1, 5, 0, /*
5708 Insert EXTENT from START to END in BUFFER-OR-STRING.
5709 BUFFER-OR-STRING defaults to the current buffer if omitted.
5710 This operation does not insert any characters,
5711 but otherwise acts as if there were a replicating extent whose
5712 parent is EXTENT in some string that was just inserted.
5713 Returns the newly-inserted extent.
5714 The fourth arg, NO-HOOKS, can be used to inhibit the running of the
5715 extent's `paste-function' property if it has one.
5716 See documentation on `detach-extent' for a discussion of undo recording.
5718 (extent, start, end, no_hooks, buffer_or_string))
5720 EXTENT ext = decode_extent (extent, 0);
5724 buffer_or_string = decode_buffer_or_string (buffer_or_string);
5725 get_buffer_or_string_range_byte (buffer_or_string, start, end, &s, &e,
5726 GB_ALLOW_PAST_ACCESSIBLE);
5728 copy = insert_extent (ext, s, e, buffer_or_string, NILP (no_hooks));
5731 if (extent_duplicable_p (XEXTENT (copy)))
5732 record_extent (copy, 1);
5738 /* adding buffer extents to a string */
5740 struct add_string_extents_arg
5748 add_string_extents_mapper (EXTENT extent, void *arg)
5750 /* This function can GC */
5751 struct add_string_extents_arg *closure =
5752 (struct add_string_extents_arg *) arg;
5753 Bytecount start = extent_endpoint_bytind (extent, 0) - closure->from;
5754 Bytecount end = extent_endpoint_bytind (extent, 1) - closure->from;
5756 if (extent_duplicable_p (extent))
5758 start = max (start, 0);
5759 end = min (end, closure->length);
5761 /* Run the copy-function to give an extent the option of
5762 not being copied into the string (or kill ring).
5764 if (extent_duplicable_p (extent) &&
5765 !run_extent_copy_function (extent, start + closure->from,
5766 end + closure->from))
5768 copy_extent (extent, start, end, closure->string);
5774 /* Add the extents in buffer BUF from OPOINT to OPOINT+LENGTH to
5775 the string STRING. */
5777 add_string_extents (Lisp_Object string, struct buffer *buf, Bytind opoint,
5780 /* This function can GC */
5781 struct add_string_extents_arg closure;
5782 struct gcpro gcpro1, gcpro2;
5785 closure.from = opoint;
5786 closure.length = length;
5787 closure.string = string;
5788 buffer = make_buffer (buf);
5789 GCPRO2 (buffer, string);
5790 map_extents_bytind (opoint, opoint + length, add_string_extents_mapper,
5791 (void *) &closure, buffer, 0,
5792 /* ignore extents that just abut the region */
5793 ME_END_CLOSED | ME_ALL_EXTENTS_OPEN |
5794 /* we are calling E-Lisp (the extent's copy function)
5795 so anything might happen */
5796 ME_MIGHT_CALL_ELISP);
5800 struct splice_in_string_extents_arg
5809 splice_in_string_extents_mapper (EXTENT extent, void *arg)
5811 /* This function can GC */
5812 struct splice_in_string_extents_arg *closure =
5813 (struct splice_in_string_extents_arg *) arg;
5814 /* BASE_START and BASE_END are the limits in the buffer of the string
5815 that was just inserted.
5817 NEW_START and NEW_END are the prospective buffer positions of the
5818 extent that is going into the buffer. */
5819 Bytind base_start = closure->opoint;
5820 Bytind base_end = base_start + closure->length;
5821 Bytind new_start = (base_start + extent_endpoint_bytind (extent, 0) -
5823 Bytind new_end = (base_start + extent_endpoint_bytind (extent, 1) -
5826 if (new_start < base_start)
5827 new_start = base_start;
5828 if (new_end > base_end)
5830 if (new_end <= new_start)
5833 if (!extent_duplicable_p (extent))
5837 !run_extent_paste_function (extent, new_start, new_end,
5840 copy_extent (extent, new_start, new_end, closure->buffer);
5845 /* We have just inserted a section of STRING (starting at POS, of
5846 length LENGTH) into buffer BUF at OPOINT. Do whatever is necessary
5847 to get the string's extents into the buffer. */
5850 splice_in_string_extents (Lisp_Object string, struct buffer *buf,
5851 Bytind opoint, Bytecount length, Bytecount pos)
5853 struct splice_in_string_extents_arg closure;
5854 struct gcpro gcpro1, gcpro2;
5857 buffer = make_buffer (buf);
5858 closure.opoint = opoint;
5860 closure.length = length;
5861 closure.buffer = buffer;
5862 GCPRO2 (buffer, string);
5863 map_extents_bytind (pos, pos + length,
5864 splice_in_string_extents_mapper,
5865 (void *) &closure, string, 0,
5866 /* ignore extents that just abut the region */
5867 ME_END_CLOSED | ME_ALL_EXTENTS_OPEN |
5868 /* we are calling E-Lisp (the extent's copy function)
5869 so anything might happen */
5870 ME_MIGHT_CALL_ELISP);
5874 struct copy_string_extents_arg
5879 Lisp_Object new_string;
5882 struct copy_string_extents_1_arg
5884 Lisp_Object parent_in_question;
5885 EXTENT found_extent;
5889 copy_string_extents_mapper (EXTENT extent, void *arg)
5891 struct copy_string_extents_arg *closure =
5892 (struct copy_string_extents_arg *) arg;
5893 Bytecount old_start, old_end, new_start, new_end;
5895 old_start = extent_endpoint_bytind (extent, 0);
5896 old_end = extent_endpoint_bytind (extent, 1);
5898 old_start = max (closure->old_pos, old_start);
5899 old_end = min (closure->old_pos + closure->length, old_end);
5901 if (old_start >= old_end)
5904 new_start = old_start + closure->new_pos - closure->old_pos;
5905 new_end = old_end + closure->new_pos - closure->old_pos;
5907 copy_extent (extent, new_start, new_end, closure->new_string);
5911 /* The string NEW_STRING was partially constructed from OLD_STRING.
5912 In particular, the section of length LEN starting at NEW_POS in
5913 NEW_STRING came from the section of the same length starting at
5914 OLD_POS in OLD_STRING. Copy the extents as appropriate. */
5917 copy_string_extents (Lisp_Object new_string, Lisp_Object old_string,
5918 Bytecount new_pos, Bytecount old_pos,
5921 struct copy_string_extents_arg closure;
5922 struct gcpro gcpro1, gcpro2;
5924 closure.new_pos = new_pos;
5925 closure.old_pos = old_pos;
5926 closure.new_string = new_string;
5927 closure.length = length;
5928 GCPRO2 (new_string, old_string);
5929 map_extents_bytind (old_pos, old_pos + length,
5930 copy_string_extents_mapper,
5931 (void *) &closure, old_string, 0,
5932 /* ignore extents that just abut the region */
5933 ME_END_CLOSED | ME_ALL_EXTENTS_OPEN |
5934 /* we are calling E-Lisp (the extent's copy function)
5935 so anything might happen */
5936 ME_MIGHT_CALL_ELISP);
5940 /* Checklist for sanity checking:
5941 - {kill, yank, copy} at {open, closed} {start, end} of {writable, read-only} extent
5942 - {kill, copy} & yank {once, repeatedly} duplicable extent in {same, different} buffer
5946 /************************************************************************/
5947 /* text properties */
5948 /************************************************************************/
5951 Originally this stuff was implemented in lisp (all of the functionality
5952 exists to make that possible) but speed was a problem.
5955 Lisp_Object Qtext_prop;
5956 Lisp_Object Qtext_prop_extent_paste_function;
5959 get_text_property_bytind (Bytind position, Lisp_Object prop,
5960 Lisp_Object object, enum extent_at_flag fl,
5961 int text_props_only)
5965 /* text_props_only specifies whether we only consider text-property
5966 extents (those with the 'text-prop property set) or all extents. */
5967 if (!text_props_only)
5968 extent = extent_at_bytind (position, object, prop, 0, fl);
5974 extent = extent_at_bytind (position, object, Qtext_prop, prior,
5978 if (EQ (prop, Fextent_property (extent, Qtext_prop, Qnil)))
5980 prior = XEXTENT (extent);
5985 return Fextent_property (extent, prop, Qnil);
5986 if (!NILP (Vdefault_text_properties))
5987 return Fplist_get (Vdefault_text_properties, prop, Qnil);
5992 get_text_property_1 (Lisp_Object pos, Lisp_Object prop, Lisp_Object object,
5993 Lisp_Object at_flag, int text_props_only)
5998 object = decode_buffer_or_string (object);
5999 position = get_buffer_or_string_pos_byte (object, pos, GB_NO_ERROR_IF_BAD);
6001 /* We canonicalize the start/end-open/closed properties to the
6002 non-default version -- "adding" the default property really
6003 needs to remove the non-default one. See below for more
6005 if (EQ (prop, Qstart_closed))
6011 if (EQ (prop, Qend_open))
6019 get_text_property_bytind (position, prop, object,
6020 decode_extent_at_flag (at_flag),
6023 val = NILP (val) ? Qt : Qnil;
6028 DEFUN ("get-text-property", Fget_text_property, 2, 4, 0, /*
6029 Return the value of the PROP property at the given position.
6030 Optional arg OBJECT specifies the buffer or string to look in, and
6031 defaults to the current buffer.
6032 Optional arg AT-FLAG controls what it means for a property to be "at"
6033 a position, and has the same meaning as in `extent-at'.
6034 This examines only those properties added with `put-text-property'.
6035 See also `get-char-property'.
6037 (pos, prop, object, at_flag))
6039 return get_text_property_1 (pos, prop, object, at_flag, 1);
6042 DEFUN ("get-char-property", Fget_char_property, 2, 4, 0, /*
6043 Return the value of the PROP property at the given position.
6044 Optional arg OBJECT specifies the buffer or string to look in, and
6045 defaults to the current buffer.
6046 Optional arg AT-FLAG controls what it means for a property to be "at"
6047 a position, and has the same meaning as in `extent-at'.
6048 This examines properties on all extents.
6049 See also `get-text-property'.
6051 (pos, prop, object, at_flag))
6053 return get_text_property_1 (pos, prop, object, at_flag, 0);
6056 /* About start/end-open/closed:
6058 These properties have to be handled specially because of their
6059 strange behavior. If I put the "start-open" property on a region,
6060 then *all* text-property extents in the region have to have their
6061 start be open. This is unlike all other properties, which don't
6062 affect the extents of text properties other than their own.
6066 1) We have to map start-closed to (not start-open) and end-open
6067 to (not end-closed) -- i.e. adding the default is really the
6068 same as remove the non-default property. It won't work, for
6069 example, to have both "start-open" and "start-closed" on
6071 2) Whenever we add one of these properties, we go through all
6072 text-property extents in the region and set the appropriate
6073 open/closedness on them.
6074 3) Whenever we change a text-property extent for a property,
6075 we have to make sure we set the open/closedness properly.
6077 (2) and (3) together rely on, and maintain, the invariant
6078 that the open/closedness of text-property extents is correct
6079 at the beginning and end of each operation.
6082 struct put_text_prop_arg
6084 Lisp_Object prop, value; /* The property and value we are storing */
6085 Bytind start, end; /* The region into which we are storing it */
6087 Lisp_Object the_extent; /* Our chosen extent; this is used for
6088 communication between subsequent passes. */
6089 int changed_p; /* Output: whether we have modified anything */
6093 put_text_prop_mapper (EXTENT e, void *arg)
6095 struct put_text_prop_arg *closure = (struct put_text_prop_arg *) arg;
6097 Lisp_Object object = closure->object;
6098 Lisp_Object value = closure->value;
6099 Bytind e_start, e_end;
6100 Bytind start = closure->start;
6101 Bytind end = closure->end;
6102 Lisp_Object extent, e_val;
6105 XSETEXTENT (extent, e);
6107 /* Note: in some cases when the property itself is 'start-open
6108 or 'end-closed, the checks to set the openness may do a bit
6109 of extra work; but it won't hurt because we then fix up the
6110 openness later on in put_text_prop_openness_mapper(). */
6111 if (!EQ (Fextent_property (extent, Qtext_prop, Qnil), closure->prop))
6112 /* It's not for this property; do nothing. */
6115 e_start = extent_endpoint_bytind (e, 0);
6116 e_end = extent_endpoint_bytind (e, 1);
6117 e_val = Fextent_property (extent, closure->prop, Qnil);
6118 is_eq = EQ (value, e_val);
6120 if (!NILP (value) && NILP (closure->the_extent) && is_eq)
6122 /* We want there to be an extent here at the end, and we haven't picked
6123 one yet, so use this one. Extend it as necessary. We only reuse an
6124 extent which has an EQ value for the prop in question to avoid
6125 side-effecting the kill ring (that is, we never change the property
6126 on an extent after it has been created.)
6128 if (e_start != start || e_end != end)
6130 Bytind new_start = min (e_start, start);
6131 Bytind new_end = max (e_end, end);
6132 set_extent_endpoints (e, new_start, new_end, Qnil);
6133 /* If we changed the endpoint, then we need to set its
6135 set_extent_openness (e, new_start != e_start
6136 ? !NILP (get_text_property_bytind
6137 (start, Qstart_open, object,
6138 EXTENT_AT_AFTER, 1)) : -1,
6140 ? NILP (get_text_property_bytind
6141 (end - 1, Qend_closed, object,
6142 EXTENT_AT_AFTER, 1))
6144 closure->changed_p = 1;
6146 closure->the_extent = extent;
6149 /* Even if we're adding a prop, at this point, we want all other extents of
6150 this prop to go away (as now they overlap). So the theory here is that,
6151 when we are adding a prop to a region that has multiple (disjoint)
6152 occurrences of that prop in it already, we pick one of those and extend
6153 it, and remove the others.
6156 else if (EQ (extent, closure->the_extent))
6158 /* just in case map-extents hits it again (does that happen?) */
6161 else if (e_start >= start && e_end <= end)
6163 /* Extent is contained in region; remove it. Don't destroy or modify
6164 it, because we don't want to change the attributes pointed to by the
6165 duplicates in the kill ring.
6168 closure->changed_p = 1;
6170 else if (!NILP (closure->the_extent) &&
6175 EXTENT te = XEXTENT (closure->the_extent);
6176 /* This extent overlaps, and has the same prop/value as the extent we've
6177 decided to reuse, so we can remove this existing extent as well (the
6178 whole thing, even the part outside of the region) and extend
6179 the-extent to cover it, resulting in the minimum number of extents in
6182 Bytind the_start = extent_endpoint_bytind (te, 0);
6183 Bytind the_end = extent_endpoint_bytind (te, 1);
6184 if (e_start != the_start && /* note AND not OR -- hmm, why is this
6185 the case? I think it's because the
6186 assumption that the text-property
6187 extents don't overlap makes it
6188 OK; changing it to an OR would
6189 result in changed_p sometimes getting
6190 falsely marked. Is this bad? */
6193 Bytind new_start = min (e_start, the_start);
6194 Bytind new_end = max (e_end, the_end);
6195 set_extent_endpoints (te, new_start, new_end, Qnil);
6196 /* If we changed the endpoint, then we need to set its
6197 openness. We are setting the endpoint to be the same as
6198 that of the extent we're about to remove, and we assume
6199 (the invariant mentioned above) that extent has the
6200 proper endpoint setting, so we just use it. */
6201 set_extent_openness (te, new_start != e_start ?
6202 (int) extent_start_open_p (e) : -1,
6204 (int) extent_end_open_p (e) : -1);
6205 closure->changed_p = 1;
6209 else if (e_end <= end)
6211 /* Extent begins before start but ends before end, so we can just
6212 decrease its end position.
6216 set_extent_endpoints (e, e_start, start, Qnil);
6217 set_extent_openness (e, -1, NILP (get_text_property_bytind
6218 (start - 1, Qend_closed, object,
6219 EXTENT_AT_AFTER, 1)));
6220 closure->changed_p = 1;
6223 else if (e_start >= start)
6225 /* Extent ends after end but begins after start, so we can just
6226 increase its start position.
6230 set_extent_endpoints (e, end, e_end, Qnil);
6231 set_extent_openness (e, !NILP (get_text_property_bytind
6232 (end, Qstart_open, object,
6233 EXTENT_AT_AFTER, 1)), -1);
6234 closure->changed_p = 1;
6239 /* Otherwise, `extent' straddles the region. We need to split it.
6241 set_extent_endpoints (e, e_start, start, Qnil);
6242 set_extent_openness (e, -1, NILP (get_text_property_bytind
6243 (start - 1, Qend_closed, object,
6244 EXTENT_AT_AFTER, 1)));
6245 set_extent_openness (copy_extent (e, end, e_end, extent_object (e)),
6246 !NILP (get_text_property_bytind
6247 (end, Qstart_open, object,
6248 EXTENT_AT_AFTER, 1)), -1);
6249 closure->changed_p = 1;
6252 return 0; /* to continue mapping. */
6256 put_text_prop_openness_mapper (EXTENT e, void *arg)
6258 struct put_text_prop_arg *closure = (struct put_text_prop_arg *) arg;
6259 Bytind e_start, e_end;
6260 Bytind start = closure->start;
6261 Bytind end = closure->end;
6263 XSETEXTENT (extent, e);
6264 e_start = extent_endpoint_bytind (e, 0);
6265 e_end = extent_endpoint_bytind (e, 1);
6267 if (NILP (Fextent_property (extent, Qtext_prop, Qnil)))
6269 /* It's not a text-property extent; do nothing. */
6272 /* Note end conditions and NILP/!NILP's carefully. */
6273 else if (EQ (closure->prop, Qstart_open)
6274 && e_start >= start && e_start < end)
6275 set_extent_openness (e, !NILP (closure->value), -1);
6276 else if (EQ (closure->prop, Qend_closed)
6277 && e_end > start && e_end <= end)
6278 set_extent_openness (e, -1, NILP (closure->value));
6280 return 0; /* to continue mapping. */
6284 put_text_prop (Bytind start, Bytind end, Lisp_Object object,
6285 Lisp_Object prop, Lisp_Object value,
6288 /* This function can GC */
6289 struct put_text_prop_arg closure;
6291 if (start == end) /* There are no characters in the region. */
6294 /* convert to the non-default versions, since a nil property is
6295 the same as it not being present. */
6296 if (EQ (prop, Qstart_closed))
6299 value = NILP (value) ? Qt : Qnil;
6301 else if (EQ (prop, Qend_open))
6304 value = NILP (value) ? Qt : Qnil;
6307 value = canonicalize_extent_property (prop, value);
6309 closure.prop = prop;
6310 closure.value = value;
6311 closure.start = start;
6313 closure.object = object;
6314 closure.changed_p = 0;
6315 closure.the_extent = Qnil;
6317 map_extents_bytind (start, end,
6318 put_text_prop_mapper,
6319 (void *) &closure, object, 0,
6320 /* get all extents that abut the region */
6321 ME_ALL_EXTENTS_CLOSED | ME_END_CLOSED |
6322 /* it might QUIT or error if the user has
6323 fucked with the extent plist. */
6324 /* #### dmoore - I think this should include
6325 ME_MIGHT_MOVE_SOE, since the callback function
6326 might recurse back into map_extents_bytind. */
6328 ME_MIGHT_MODIFY_EXTENTS);
6330 /* If we made it through the loop without reusing an extent
6331 (and we want there to be one) make it now.
6333 if (!NILP (value) && NILP (closure.the_extent))
6337 XSETEXTENT (extent, make_extent_internal (object, start, end));
6338 closure.changed_p = 1;
6339 Fset_extent_property (extent, Qtext_prop, prop);
6340 Fset_extent_property (extent, prop, value);
6343 extent_duplicable_p (XEXTENT (extent)) = 1;
6344 Fset_extent_property (extent, Qpaste_function,
6345 Qtext_prop_extent_paste_function);
6347 set_extent_openness (XEXTENT (extent),
6348 !NILP (get_text_property_bytind
6349 (start, Qstart_open, object,
6350 EXTENT_AT_AFTER, 1)),
6351 NILP (get_text_property_bytind
6352 (end - 1, Qend_closed, object,
6353 EXTENT_AT_AFTER, 1)));
6356 if (EQ (prop, Qstart_open) || EQ (prop, Qend_closed))
6358 map_extents_bytind (start, end,
6359 put_text_prop_openness_mapper,
6360 (void *) &closure, object, 0,
6361 /* get all extents that abut the region */
6362 ME_ALL_EXTENTS_CLOSED | ME_END_CLOSED |
6363 ME_MIGHT_MODIFY_EXTENTS);
6366 return closure.changed_p;
6369 DEFUN ("put-text-property", Fput_text_property, 4, 5, 0, /*
6370 Adds the given property/value to all characters in the specified region.
6371 The property is conceptually attached to the characters rather than the
6372 region. The properties are copied when the characters are copied/pasted.
6373 Fifth argument OBJECT is the buffer or string containing the text, and
6374 defaults to the current buffer.
6376 (start, end, prop, value, object))
6378 /* This function can GC */
6381 object = decode_buffer_or_string (object);
6382 get_buffer_or_string_range_byte (object, start, end, &s, &e, 0);
6383 put_text_prop (s, e, object, prop, value, 1);
6387 DEFUN ("put-nonduplicable-text-property", Fput_nonduplicable_text_property,
6389 Adds the given property/value to all characters in the specified region.
6390 The property is conceptually attached to the characters rather than the
6391 region, however the properties will not be copied when the characters
6393 Fifth argument OBJECT is the buffer or string containing the text, and
6394 defaults to the current buffer.
6396 (start, end, prop, value, object))
6398 /* This function can GC */
6401 object = decode_buffer_or_string (object);
6402 get_buffer_or_string_range_byte (object, start, end, &s, &e, 0);
6403 put_text_prop (s, e, object, prop, value, 0);
6407 DEFUN ("add-text-properties", Fadd_text_properties, 3, 4, 0, /*
6408 Add properties to the characters from START to END.
6409 The third argument PROPS is a property list specifying the property values
6410 to add. The optional fourth argument, OBJECT, is the buffer or string
6411 containing the text and defaults to the current buffer. Returns t if
6412 any property was changed, nil otherwise.
6414 (start, end, props, object))
6416 /* This function can GC */
6420 object = decode_buffer_or_string (object);
6421 get_buffer_or_string_range_byte (object, start, end, &s, &e, 0);
6423 for (; !NILP (props); props = Fcdr (Fcdr (props)))
6425 Lisp_Object prop = XCAR (props);
6426 Lisp_Object value = Fcar (XCDR (props));
6427 changed |= put_text_prop (s, e, object, prop, value, 1);
6429 return changed ? Qt : Qnil;
6433 DEFUN ("add-nonduplicable-text-properties", Fadd_nonduplicable_text_properties,
6435 Add nonduplicable properties to the characters from START to END.
6436 \(The properties will not be copied when the characters are copied.)
6437 The third argument PROPS is a property list specifying the property values
6438 to add. The optional fourth argument, OBJECT, is the buffer or string
6439 containing the text and defaults to the current buffer. Returns t if
6440 any property was changed, nil otherwise.
6442 (start, end, props, object))
6444 /* This function can GC */
6448 object = decode_buffer_or_string (object);
6449 get_buffer_or_string_range_byte (object, start, end, &s, &e, 0);
6451 for (; !NILP (props); props = Fcdr (Fcdr (props)))
6453 Lisp_Object prop = XCAR (props);
6454 Lisp_Object value = Fcar (XCDR (props));
6455 changed |= put_text_prop (s, e, object, prop, value, 0);
6457 return changed ? Qt : Qnil;
6460 DEFUN ("remove-text-properties", Fremove_text_properties, 3, 4, 0, /*
6461 Remove the given properties from all characters in the specified region.
6462 PROPS should be a plist, but the values in that plist are ignored (treated
6463 as nil). Returns t if any property was changed, nil otherwise.
6464 Fourth argument OBJECT is the buffer or string containing the text, and
6465 defaults to the current buffer.
6467 (start, end, props, object))
6469 /* This function can GC */
6473 object = decode_buffer_or_string (object);
6474 get_buffer_or_string_range_byte (object, start, end, &s, &e, 0);
6476 for (; !NILP (props); props = Fcdr (Fcdr (props)))
6478 Lisp_Object prop = XCAR (props);
6479 changed |= put_text_prop (s, e, object, prop, Qnil, 1);
6481 return changed ? Qt : Qnil;
6484 /* Whenever a text-prop extent is pasted into a buffer (via `yank' or `insert'
6485 or whatever) we attach the properties to the buffer by calling
6486 `put-text-property' instead of by simply allowing the extent to be copied or
6487 re-attached. Then we return nil, telling the extents code not to attach it
6488 again. By handing the insertion hackery in this way, we make kill/yank
6489 behave consistently with put-text-property and not fragment the extents
6490 (since text-prop extents must partition, not overlap).
6492 The lisp implementation of this was probably fast enough, but since I moved
6493 the rest of the put-text-prop code here, I moved this as well for
6496 DEFUN ("text-prop-extent-paste-function", Ftext_prop_extent_paste_function,
6498 Used as the `paste-function' property of `text-prop' extents.
6502 /* This function can GC */
6503 Lisp_Object prop, val;
6505 prop = Fextent_property (extent, Qtext_prop, Qnil);
6507 signal_simple_error ("Internal error: no text-prop", extent);
6508 val = Fextent_property (extent, prop, Qnil);
6510 /* removed by bill perry, 2/9/97
6511 ** This little bit of code would not allow you to have a text property
6512 ** with a value of Qnil. This is bad bad bad.
6515 signal_simple_error_2 ("Internal error: no text-prop",
6518 Fput_text_property (from, to, prop, val, Qnil);
6519 return Qnil; /* important! */
6522 /* This function could easily be written in Lisp but the C code wants
6523 to use it in connection with invisible extents (at least currently).
6524 If this changes, consider moving this back into Lisp. */
6526 DEFUN ("next-single-property-change", Fnext_single_property_change,
6528 Return the position of next property change for a specific property.
6529 Scans characters forward from POS till it finds a change in the PROP
6530 property, then returns the position of the change. The optional third
6531 argument OBJECT is the buffer or string to scan (defaults to the current
6533 The property values are compared with `eq'.
6534 Return nil if the property is constant all the way to the end of BUFFER.
6535 If the value is non-nil, it is a position greater than POS, never equal.
6537 If the optional fourth argument LIMIT is non-nil, don't search
6538 past position LIMIT; return LIMIT if nothing is found before LIMIT.
6539 If two or more extents with conflicting non-nil values for PROP overlap
6540 a particular character, it is undefined which value is considered to be
6541 the value of PROP. (Note that this situation will not happen if you always
6542 use the text-property primitives.)
6544 (pos, prop, object, limit))
6548 Lisp_Object extent, value;
6551 object = decode_buffer_or_string (object);
6552 bpos = get_buffer_or_string_pos_char (object, pos, 0);
6555 blim = buffer_or_string_accessible_end_char (object);
6560 blim = get_buffer_or_string_pos_char (object, limit, 0);
6564 extent = Fextent_at (make_int (bpos), object, prop, Qnil, Qnil);
6566 value = Fextent_property (extent, prop, Qnil);
6572 bpos = XINT (Fnext_extent_change (make_int (bpos), object));
6574 break; /* property is the same all the way to the end */
6575 extent = Fextent_at (make_int (bpos), object, prop, Qnil, Qnil);
6576 if ((NILP (extent) && !NILP (value)) ||
6577 (!NILP (extent) && !EQ (value,
6578 Fextent_property (extent, prop, Qnil))))
6579 return make_int (bpos);
6582 /* I think it's more sensible for this function to return nil always
6583 in this situation and it used to do it this way, but it's been changed
6584 for FSF compatibility. */
6588 return make_int (blim);
6591 /* See comment on previous function about why this is written in C. */
6593 DEFUN ("previous-single-property-change", Fprevious_single_property_change,
6595 Return the position of next property change for a specific property.
6596 Scans characters backward from POS till it finds a change in the PROP
6597 property, then returns the position of the change. The optional third
6598 argument OBJECT is the buffer or string to scan (defaults to the current
6600 The property values are compared with `eq'.
6601 Return nil if the property is constant all the way to the start of BUFFER.
6602 If the value is non-nil, it is a position less than POS, never equal.
6604 If the optional fourth argument LIMIT is non-nil, don't search back
6605 past position LIMIT; return LIMIT if nothing is found until LIMIT.
6606 If two or more extents with conflicting non-nil values for PROP overlap
6607 a particular character, it is undefined which value is considered to be
6608 the value of PROP. (Note that this situation will not happen if you always
6609 use the text-property primitives.)
6611 (pos, prop, object, limit))
6615 Lisp_Object extent, value;
6618 object = decode_buffer_or_string (object);
6619 bpos = get_buffer_or_string_pos_char (object, pos, 0);
6622 blim = buffer_or_string_accessible_begin_char (object);
6627 blim = get_buffer_or_string_pos_char (object, limit, 0);
6631 /* extent-at refers to the character AFTER bpos, but we want the
6632 character before bpos. Thus the - 1. extent-at simply
6633 returns nil on bogus positions, so not to worry. */
6634 extent = Fextent_at (make_int (bpos - 1), object, prop, Qnil, Qnil);
6636 value = Fextent_property (extent, prop, Qnil);
6642 bpos = XINT (Fprevious_extent_change (make_int (bpos), object));
6644 break; /* property is the same all the way to the beginning */
6645 extent = Fextent_at (make_int (bpos - 1), object, prop, Qnil, Qnil);
6646 if ((NILP (extent) && !NILP (value)) ||
6647 (!NILP (extent) && !EQ (value,
6648 Fextent_property (extent, prop, Qnil))))
6649 return make_int (bpos);
6652 /* I think it's more sensible for this function to return nil always
6653 in this situation and it used to do it this way, but it's been changed
6654 for FSF compatibility. */
6658 return make_int (blim);
6661 #ifdef MEMORY_USAGE_STATS
6664 compute_buffer_extent_usage (struct buffer *b, struct overhead_stats *ovstats)
6666 /* #### not yet written */
6670 #endif /* MEMORY_USAGE_STATS */
6673 /************************************************************************/
6674 /* initialization */
6675 /************************************************************************/
6678 syms_of_extents (void)
6680 INIT_LRECORD_IMPLEMENTATION (extent);
6681 INIT_LRECORD_IMPLEMENTATION (extent_info);
6682 INIT_LRECORD_IMPLEMENTATION (extent_auxiliary);
6684 defsymbol (&Qextentp, "extentp");
6685 defsymbol (&Qextent_live_p, "extent-live-p");
6687 defsymbol (&Qall_extents_closed, "all-extents-closed");
6688 defsymbol (&Qall_extents_open, "all-extents-open");
6689 defsymbol (&Qall_extents_closed_open, "all-extents-closed-open");
6690 defsymbol (&Qall_extents_open_closed, "all-extents-open-closed");
6691 defsymbol (&Qstart_in_region, "start-in-region");
6692 defsymbol (&Qend_in_region, "end-in-region");
6693 defsymbol (&Qstart_and_end_in_region, "start-and-end-in-region");
6694 defsymbol (&Qstart_or_end_in_region, "start-or-end-in-region");
6695 defsymbol (&Qnegate_in_region, "negate-in-region");
6697 defsymbol (&Qdetached, "detached");
6698 defsymbol (&Qdestroyed, "destroyed");
6699 defsymbol (&Qbegin_glyph, "begin-glyph");
6700 defsymbol (&Qend_glyph, "end-glyph");
6701 defsymbol (&Qstart_open, "start-open");
6702 defsymbol (&Qend_open, "end-open");
6703 defsymbol (&Qstart_closed, "start-closed");
6704 defsymbol (&Qend_closed, "end-closed");
6705 defsymbol (&Qread_only, "read-only");
6706 /* defsymbol (&Qhighlight, "highlight"); in faces.c */
6707 defsymbol (&Qunique, "unique");
6708 defsymbol (&Qduplicable, "duplicable");
6709 defsymbol (&Qdetachable, "detachable");
6710 defsymbol (&Qpriority, "priority");
6711 defsymbol (&Qmouse_face, "mouse-face");
6712 defsymbol (&Qinitial_redisplay_function,"initial-redisplay-function");
6715 defsymbol (&Qglyph_layout, "glyph-layout"); /* backwards compatibility */
6716 defsymbol (&Qbegin_glyph_layout, "begin-glyph-layout");
6717 defsymbol (&Qend_glyph_layout, "end-glyph-layout");
6718 defsymbol (&Qoutside_margin, "outside-margin");
6719 defsymbol (&Qinside_margin, "inside-margin");
6720 defsymbol (&Qwhitespace, "whitespace");
6721 /* Qtext defined in general.c */
6723 defsymbol (&Qpaste_function, "paste-function");
6724 defsymbol (&Qcopy_function, "copy-function");
6726 defsymbol (&Qtext_prop, "text-prop");
6727 defsymbol (&Qtext_prop_extent_paste_function,
6728 "text-prop-extent-paste-function");
6731 DEFSUBR (Fextent_live_p);
6732 DEFSUBR (Fextent_detached_p);
6733 DEFSUBR (Fextent_start_position);
6734 DEFSUBR (Fextent_end_position);
6735 DEFSUBR (Fextent_object);
6736 DEFSUBR (Fextent_length);
6738 DEFSUBR (Fmake_extent);
6739 DEFSUBR (Fcopy_extent);
6740 DEFSUBR (Fdelete_extent);
6741 DEFSUBR (Fdetach_extent);
6742 DEFSUBR (Fset_extent_endpoints);
6743 DEFSUBR (Fnext_extent);
6744 DEFSUBR (Fprevious_extent);
6746 DEFSUBR (Fnext_e_extent);
6747 DEFSUBR (Fprevious_e_extent);
6749 DEFSUBR (Fnext_extent_change);
6750 DEFSUBR (Fprevious_extent_change);
6752 DEFSUBR (Fextent_parent);
6753 DEFSUBR (Fextent_children);
6754 DEFSUBR (Fset_extent_parent);
6756 DEFSUBR (Fextent_in_region_p);
6757 DEFSUBR (Fmap_extents);
6758 DEFSUBR (Fmap_extent_children);
6759 DEFSUBR (Fextent_at);
6761 DEFSUBR (Fset_extent_initial_redisplay_function);
6762 DEFSUBR (Fextent_face);
6763 DEFSUBR (Fset_extent_face);
6764 DEFSUBR (Fextent_mouse_face);
6765 DEFSUBR (Fset_extent_mouse_face);
6766 DEFSUBR (Fset_extent_begin_glyph);
6767 DEFSUBR (Fset_extent_end_glyph);
6768 DEFSUBR (Fextent_begin_glyph);
6769 DEFSUBR (Fextent_end_glyph);
6770 DEFSUBR (Fset_extent_begin_glyph_layout);
6771 DEFSUBR (Fset_extent_end_glyph_layout);
6772 DEFSUBR (Fextent_begin_glyph_layout);
6773 DEFSUBR (Fextent_end_glyph_layout);
6774 DEFSUBR (Fset_extent_priority);
6775 DEFSUBR (Fextent_priority);
6776 DEFSUBR (Fset_extent_property);
6777 DEFSUBR (Fset_extent_properties);
6778 DEFSUBR (Fextent_property);
6779 DEFSUBR (Fextent_properties);
6781 DEFSUBR (Fhighlight_extent);
6782 DEFSUBR (Fforce_highlight_extent);
6784 DEFSUBR (Finsert_extent);
6786 DEFSUBR (Fget_text_property);
6787 DEFSUBR (Fget_char_property);
6788 DEFSUBR (Fput_text_property);
6789 DEFSUBR (Fput_nonduplicable_text_property);
6790 DEFSUBR (Fadd_text_properties);
6791 DEFSUBR (Fadd_nonduplicable_text_properties);
6792 DEFSUBR (Fremove_text_properties);
6793 DEFSUBR (Ftext_prop_extent_paste_function);
6794 DEFSUBR (Fnext_single_property_change);
6795 DEFSUBR (Fprevious_single_property_change);
6799 reinit_vars_of_extents (void)
6801 extent_auxiliary_defaults.begin_glyph = Qnil;
6802 extent_auxiliary_defaults.end_glyph = Qnil;
6803 extent_auxiliary_defaults.parent = Qnil;
6804 extent_auxiliary_defaults.children = Qnil;
6805 extent_auxiliary_defaults.priority = 0;
6806 extent_auxiliary_defaults.invisible = Qnil;
6807 extent_auxiliary_defaults.read_only = Qnil;
6808 extent_auxiliary_defaults.mouse_face = Qnil;
6809 extent_auxiliary_defaults.initial_redisplay_function = Qnil;
6810 extent_auxiliary_defaults.before_change_functions = Qnil;
6811 extent_auxiliary_defaults.after_change_functions = Qnil;
6815 vars_of_extents (void)
6817 reinit_vars_of_extents ();
6819 DEFVAR_INT ("mouse-highlight-priority", &mouse_highlight_priority /*
6820 The priority to use for the mouse-highlighting pseudo-extent
6821 that is used to highlight extents with the `mouse-face' attribute set.
6822 See `set-extent-priority'.
6824 /* Set mouse-highlight-priority (which ends up being used both for the
6825 mouse-highlighting pseudo-extent and the primary selection extent)
6826 to a very high value because very few extents should override it.
6827 1000 gives lots of room below it for different-prioritized extents.
6828 10 doesn't. ediff, for example, likes to use priorities around 100.
6830 mouse_highlight_priority = /* 10 */ 1000;
6832 DEFVAR_LISP ("default-text-properties", &Vdefault_text_properties /*
6833 Property list giving default values for text properties.
6834 Whenever a character does not specify a value for a property, the value
6835 stored in this list is used instead. This only applies when the
6836 functions `get-text-property' or `get-char-property' are called.
6838 Vdefault_text_properties = Qnil;
6840 staticpro (&Vlast_highlighted_extent);
6841 Vlast_highlighted_extent = Qnil;
6843 Vextent_face_reusable_list = Fcons (Qnil, Qnil);
6844 staticpro (&Vextent_face_reusable_list);
6848 complex_vars_of_extents (void)
6850 staticpro (&Vextent_face_memoize_hash_table);
6851 /* The memoize hash table maps from lists of symbols to lists of
6852 faces. It needs to be `equal' to implement the memoization.
6853 The reverse table maps in the other direction and just needs
6854 to do `eq' comparison because the lists of faces are already
6856 Vextent_face_memoize_hash_table =
6857 make_lisp_hash_table (100, HASH_TABLE_VALUE_WEAK, HASH_TABLE_EQUAL);
6858 staticpro (&Vextent_face_reverse_memoize_hash_table);
6859 Vextent_face_reverse_memoize_hash_table =
6860 make_lisp_hash_table (100, HASH_TABLE_KEY_WEAK, HASH_TABLE_EQ);