1 /* Copyright (c) 1994, 1995 Free Software Foundation, Inc.
2 Copyright (c) 1995 Sun Microsystems, Inc.
3 Copyright (c) 1995, 1996, 2000 Ben Wing.
5 This file is part of SXEmacs
7 SXEmacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 SXEmacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
21 /* Synched up with: Not in FSF. */
23 /* This file has been Mule-ized. */
25 /* Written by Ben Wing <ben@xemacs.org>.
27 [Originally written by some people at Lucid.
29 Start/end-open stuff added by John Rose (john.rose@eng.sun.com).
30 Rewritten from scratch by Ben Wing, December 1994.] */
34 Extents are regions over a buffer, with a start and an end position
35 denoting the region of the buffer included in the extent. In
36 addition, either end can be closed or open, meaning that the endpoint
37 is or is not logically included in the extent. Insertion of a character
38 at a closed endpoint causes the character to go inside the extent;
39 insertion at an open endpoint causes the character to go outside.
41 Extent endpoints are stored using memory indices (see insdel.c),
42 to minimize the amount of adjusting that needs to be done when
43 characters are inserted or deleted.
45 (Formerly, extent endpoints at the gap could be either before or
46 after the gap, depending on the open/closedness of the endpoint.
47 The intent of this was to make it so that insertions would
48 automatically go inside or out of extents as necessary with no
49 further work needing to be done. It didn't work out that way,
50 however, and just ended up complexifying and buggifying all the
53 Extents are compared using memory indices. There are two orderings
54 for extents and both orders are kept current at all times. The normal
55 or "display" order is as follows:
57 Extent A is "less than" extent B, that is, earlier in the display order,
58 if: A-start < B-start,
59 or if: A-start = B-start, and A-end > B-end
61 So if two extents begin at the same position, the larger of them is the
62 earlier one in the display order (EXTENT_LESS is true).
64 For the e-order, the same thing holds: Extent A is "less than" extent B
65 in e-order, that is, later in the buffer,
67 or if: A-end = B-end, and A-start > B-start
69 So if two extents end at the same position, the smaller of them is the
70 earlier one in the e-order (EXTENT_E_LESS is true).
72 The display order and the e-order are complementary orders: any
73 theorem about the display order also applies to the e-order if you
74 swap all occurrences of "display order" and "e-order", "less than"
75 and "greater than", and "extent start" and "extent end".
77 Extents can be zero-length, and will end up that way if their endpoints
78 are explicitly set that way or if their detachable property is nil
79 and all the text in the extent is deleted. (The exception is open-open
80 zero-length extents, which are barred from existing because there is
81 no sensible way to define their properties. Deletion of the text in
82 an open-open extent causes it to be converted into a closed-open
83 extent.) Zero-length extents are primarily used to represent
84 annotations, and behave as follows:
86 1) Insertion at the position of a zero-length extent expands the extent
87 if both endpoints are closed; goes after the extent if it is closed-open;
88 and goes before the extent if it is open-closed.
90 2) Deletion of a character on a side of a zero-length extent whose
91 corresponding endpoint is closed causes the extent to be detached if
92 it is detachable; if the extent is not detachable or the corresponding
93 endpoint is open, the extent remains in the buffer, moving as necessary.
95 Note that closed-open, non-detachable zero-length extents behave exactly
96 like markers and that open-closed, non-detachable zero-length extents
97 behave like the "point-type" marker in Mule.
99 #### The following information is wrong in places.
101 More about the different orders:
102 --------------------------------
104 The extents in a buffer are ordered by "display order" because that
105 is that order that the redisplay mechanism needs to process them in.
106 The e-order is an auxiliary ordering used to facilitate operations
107 over extents. The operations that can be performed on the ordered
108 list of extents in a buffer are
110 1) Locate where an extent would go if inserted into the list.
111 2) Insert an extent into the list.
112 3) Remove an extent from the list.
113 4) Map over all the extents that overlap a range.
115 (4) requires being able to determine the first and last extents
116 that overlap a range.
118 NOTE: "overlap" is used as follows:
120 -- two ranges overlap if they have at least one point in common.
121 Whether the endpoints are open or closed makes a difference here.
122 -- a point overlaps a range if the point is contained within the
123 range; this is equivalent to treating a point P as the range
125 -- In the case of an *extent* overlapping a point or range, the
126 extent is normally treated as having closed endpoints. This
127 applies consistently in the discussion of stacks of extents
128 and such below. Note that this definition of overlap is not
129 necessarily consistent with the extents that `map-extents'
130 maps over, since `map-extents' sometimes pays attention to
131 whether the endpoints of an extents are open or closed.
132 But for our purposes, it greatly simplifies things to treat
133 all extents as having closed endpoints.
135 First, define >, <, <=, etc. as applied to extents to mean
136 comparison according to the display order. Comparison between an
137 extent E and an index I means comparison between E and the range
139 Also define e>, e<, e<=, etc. to mean comparison according to the
141 For any range R, define R(0) to be the starting index of the range
142 and R(1) to be the ending index of the range.
143 For any extent E, define E(next) to be the extent directly following
144 E, and E(prev) to be the extent directly preceding E. Assume
145 E(next) and E(prev) can be determined from E in constant time.
146 (This is because we store the extent list as a doubly linked
148 Similarly, define E(e-next) and E(e-prev) to be the extents
149 directly following and preceding E in the e-order.
154 Let F be the first extent overlapping R.
155 Let L be the last extent overlapping R.
157 Theorem 1: R(1) lies between L and L(next), i.e. L <= R(1) < L(next).
159 This follows easily from the definition of display order. The
160 basic reason that this theorem applies is that the display order
161 sorts by increasing starting index.
163 Therefore, we can determine L just by looking at where we would
164 insert R(1) into the list, and if we know F and are moving forward
165 over extents, we can easily determine when we've hit L by comparing
166 the extent we're at to R(1).
168 Theorem 2: F(e-prev) e< [1, R(0)] e<= F.
170 This is the analog of Theorem 1, and applies because the e-order
171 sorts by increasing ending index.
173 Therefore, F can be found in the same amount of time as operation (1),
174 i.e. the time that it takes to locate where an extent would go if
175 inserted into the e-order list.
177 If the lists were stored as balanced binary trees, then operation (1)
178 would take logarithmic time, which is usually quite fast. However,
179 currently they're stored as simple doubly-linked lists, and instead
180 we do some caching to try to speed things up.
182 Define a "stack of extents" (or "SOE") as the set of extents
183 (ordered in the display order) that overlap an index I, together with
184 the SOE's "previous" extent, which is an extent that precedes I in
185 the e-order. (Hopefully there will not be very many extents between
186 I and the previous extent.)
190 Let I be an index, let S be the stack of extents on I, let F be
191 the first extent in S, and let P be S's previous extent.
193 Theorem 3: The first extent in S is the first extent that overlaps
196 Proof: Any extent that overlaps [I, J] but does not include I must
197 have a start index > I, and thus be greater than any extent in S.
199 Therefore, finding the first extent that overlaps a range R is the
200 same as finding the first extent that overlaps R(0).
202 Theorem 4: Let I2 be an index such that I2 > I, and let F2 be the
203 first extent that overlaps I2. Then, either F2 is in S or F2 is
204 greater than any extent in S.
206 Proof: If F2 does not include I then its start index is greater
207 than I and thus it is greater than any extent in S, including F.
208 Otherwise, F2 includes I and thus is in S, and thus F2 >= F.
217 #include "ui/device.h"
220 #include "ui/faces.h"
221 #include "ui/frame.h"
222 #include "ui/glyphs.h"
223 #include "ui/insdel.h"
224 #include "ui/keymap.h"
227 #include "ui/redisplay.h"
228 #include "ui/gutter.h"
230 /* ------------------------------- */
232 /* ------------------------------- */
234 /* Note that this object is not extent-specific and should perhaps be
235 moved into another file. */
237 typedef struct gap_array_marker_s *gap_array_marker_t;
238 typedef struct gap_array_s *gap_array_t;
240 /* Holds a marker that moves as elements in the array are inserted and
241 deleted, similar to standard markers. */
243 struct gap_array_marker_s {
245 gap_array_marker_t 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
260 gap_array_marker_t markers;
263 #if !defined HAVE_BDWGC || !defined EF_USE_BDWGC
264 static gap_array_marker_t gap_array_marker_freelist;
267 /* Convert a "memory position" (i.e. taking the gap into account) into
268 the address of the element at (i.e. after) that position. "Memory
269 positions" are only used internally and are of type Memind.
270 "Array positions" are used externally and are of type int. */
271 #define GAP_ARRAY_MEMEL_ADDR(ga, memel) ((ga)->array + (ga)->elsize*(memel))
273 /* Number of elements currently in a gap array */
274 #define GAP_ARRAY_NUM_ELS(ga) ((ga)->numels)
276 #define GAP_ARRAY_ARRAY_TO_MEMORY_POS(ga, pos) \
277 ((pos) <= (ga)->gap ? (pos) : (pos) + (ga)->gapsize)
279 #define GAP_ARRAY_MEMORY_TO_ARRAY_POS(ga, pos) \
280 ((pos) <= (ga)->gap ? (pos) : (pos) - (ga)->gapsize)
282 /* Convert an array position into the address of the element at
283 (i.e. after) that position. */
284 #define GAP_ARRAY_EL_ADDR(ga, pos) \
286 ? GAP_ARRAY_MEMEL_ADDR(ga, pos) \
287 : GAP_ARRAY_MEMEL_ADDR(ga, (pos) + (ga)->gapsize))
289 /* ------------------------------- */
291 /* ------------------------------- */
293 typedef struct extent_list_marker_s *extent_list_marker_t;
294 typedef struct extent_list_s *extent_list_t;
296 struct extent_list_marker_s {
297 gap_array_marker_t m;
299 extent_list_marker_t next;
302 struct extent_list_s {
305 extent_list_marker_t markers;
308 #if !defined HAVE_BDWGC || !defined EF_USE_BDWGC
309 static extent_list_marker_t extent_list_marker_freelist;
312 #define EXTENT_LESS_VALS(e,st,nd) \
313 ((extent_start (e) < (st)) || \
314 ((extent_start (e) == (st)) && \
315 (extent_end (e) > (nd))))
317 #define EXTENT_EQUAL_VALS(e,st,nd) \
318 ((extent_start (e) == (st)) && \
319 (extent_end (e) == (nd)))
321 #define EXTENT_LESS_EQUAL_VALS(e,st,nd) \
322 ((extent_start (e) < (st)) || \
323 ((extent_start (e) == (st)) && \
324 (extent_end (e) >= (nd))))
326 /* Is extent E1 less than extent E2 in the display order? */
327 #define EXTENT_LESS(e1,e2) \
328 EXTENT_LESS_VALS (e1, extent_start (e2), extent_end (e2))
330 /* Is extent E1 equal to extent E2? */
331 #define EXTENT_EQUAL(e1,e2) \
332 EXTENT_EQUAL_VALS (e1, extent_start (e2), extent_end (e2))
334 /* Is extent E1 less than or equal to extent E2 in the display order? */
335 #define EXTENT_LESS_EQUAL(e1,e2) \
336 EXTENT_LESS_EQUAL_VALS (e1, extent_start (e2), extent_end (e2))
338 #define EXTENT_E_LESS_VALS(e,st,nd) \
339 ((extent_end (e) < (nd)) || \
340 ((extent_end (e) == (nd)) && \
341 (extent_start (e) > (st))))
343 #define EXTENT_E_LESS_EQUAL_VALS(e,st,nd) \
344 ((extent_end (e) < (nd)) || \
345 ((extent_end (e) == (nd)) && \
346 (extent_start (e) >= (st))))
348 /* Is extent E1 less than extent E2 in the e-order? */
349 #define EXTENT_E_LESS(e1,e2) \
350 EXTENT_E_LESS_VALS(e1, extent_start (e2), extent_end (e2))
352 /* Is extent E1 less than or equal to extent E2 in the e-order? */
353 #define EXTENT_E_LESS_EQUAL(e1,e2) \
354 EXTENT_E_LESS_EQUAL_VALS (e1, extent_start (e2), extent_end (e2))
356 #define EXTENT_GAP_ARRAY_AT(ga, pos) (*(EXTENT*)GAP_ARRAY_EL_ADDR(ga, pos))
358 /* ------------------------------- */
359 /* auxiliary extent structure */
360 /* ------------------------------- */
362 struct extent_auxiliary extent_auxiliary_defaults;
364 /* ------------------------------- */
365 /* buffer-extent primitives */
366 /* ------------------------------- */
367 typedef struct extent_stack_s *extent_stack_t;
369 struct extent_stack_s {
370 extent_list_t extents;
371 /* Position of stack of extents. EXTENTS is the list of
372 all extents that overlap this position. This position
373 can be -1 if the stack of extents is invalid (this
374 happens when a buffer is first created or a string's
375 stack of extents is created [a string's stack of extents
376 is nuked when a GC occurs, to conserve memory]). */
380 /* ------------------------------- */
382 /* ------------------------------- */
384 typedef int Endpoint_Index;
386 #define memind_to_startind(x, start_open) \
387 ((Endpoint_Index) (((x) << 1) + !!(start_open)))
388 #define memind_to_endind(x, end_open) \
389 ((Endpoint_Index) (((x) << 1) - !!(end_open)))
391 /* Combination macros */
392 #define bytind_to_startind(buf, x, start_open) \
393 memind_to_startind (bytind_to_memind (buf, x), start_open)
394 #define bytind_to_endind(buf, x, end_open) \
395 memind_to_endind (bytind_to_memind (buf, x), end_open)
397 /* ------------------------------- */
398 /* buffer-or-string primitives */
399 /* ------------------------------- */
401 /* Similar for Bytinds and start/end indices. */
403 #define buffer_or_string_bytind_to_startind(obj, ind, start_open) \
404 memind_to_startind(buffer_or_string_bytind_to_memind (obj, ind), \
407 #define buffer_or_string_bytind_to_endind(obj, ind, end_open) \
408 memind_to_endind(buffer_or_string_bytind_to_memind (obj, ind), \
411 /* ------------------------------- */
412 /* Lisp-level functions */
413 /* ------------------------------- */
415 /* flags for decode_extent() */
416 #define DE_MUST_HAVE_BUFFER 1
417 #define DE_MUST_BE_ATTACHED 2
419 Lisp_Object Vlast_highlighted_extent;
420 Fixnum mouse_highlight_priority;
422 Lisp_Object Qextentp;
423 Lisp_Object Qextent_live_p;
425 Lisp_Object Qall_extents_closed;
426 Lisp_Object Qall_extents_open;
427 Lisp_Object Qall_extents_closed_open;
428 Lisp_Object Qall_extents_open_closed;
429 Lisp_Object Qstart_in_region;
430 Lisp_Object Qend_in_region;
431 Lisp_Object Qstart_and_end_in_region;
432 Lisp_Object Qstart_or_end_in_region;
433 Lisp_Object Qnegate_in_region;
435 Lisp_Object Qdetached;
436 Lisp_Object Qdestroyed;
437 Lisp_Object Qbegin_glyph;
438 Lisp_Object Qend_glyph;
439 Lisp_Object Qstart_open;
440 Lisp_Object Qend_open;
441 Lisp_Object Qstart_closed;
442 Lisp_Object Qend_closed;
443 Lisp_Object Qread_only;
444 /* Qhighlight defined in general.c */
446 Lisp_Object Qduplicable;
447 Lisp_Object Qdetachable;
448 Lisp_Object Qpriority;
449 Lisp_Object Qmouse_face;
450 Lisp_Object Qinitial_redisplay_function;
452 /* This exists only for backwards compatibility. */
453 Lisp_Object Qglyph_layout;
454 Lisp_Object Qbegin_glyph_layout, Qend_glyph_layout;
455 Lisp_Object Qoutside_margin;
456 Lisp_Object Qinside_margin;
457 Lisp_Object Qwhitespace;
458 /* Qtext defined in general.c */
460 Lisp_Object Qcopy_function;
461 Lisp_Object Qpaste_function;
463 /* The idea here is that if we're given a list of faces, we
464 need to "memoize" this so that two lists of faces that are `equal'
465 turn into the same object. When `set-extent-face' is called, we
466 "memoize" into a list of actual faces; when `extent-face' is called,
467 we do a reverse lookup to get the list of symbols. */
469 static Lisp_Object canonicalize_extent_property(Lisp_Object prop,
471 Lisp_Object Vextent_face_memoize_hash_table;
472 Lisp_Object Vextent_face_reverse_memoize_hash_table;
473 Lisp_Object Vextent_face_reusable_list;
474 /* FSFmacs bogosity */
475 Lisp_Object Vdefault_text_properties;
477 EXFUN(Fextent_properties, 1);
478 EXFUN(Fset_extent_property, 3);
480 /* if true, we don't want to set any redisplay flags on modeline extent
482 int in_modeline_generation;
484 /************************************************************************/
485 /* Generalized gap array */
486 /************************************************************************/
488 /* This generalizes the "array with a gap" model used to store buffer
489 characters. This is based on the stuff in insdel.c and should
490 probably be merged with it. This is not extent-specific and should
491 perhaps be moved into a separate file. */
493 /* ------------------------------- */
494 /* internal functions */
495 /* ------------------------------- */
497 /* Adjust the gap array markers in the range (FROM, TO]. Parallel to
498 adjust_markers() in insdel.c. */
501 gap_array_adjust_markers(gap_array_t ga, Memind from, Memind to, int amount)
503 gap_array_marker_t m;
505 for (m = ga->markers; m; m = m->next) {
506 m->pos = do_marker_adjustment(m->pos, from, to, amount);
511 /* Move the gap to array position POS. Parallel to move_gap() in
512 insdel.c but somewhat simplified. */
515 gap_array_move_gap(gap_array_t ga, int pos)
518 int gapsize = ga->gapsize;
522 memmove(GAP_ARRAY_MEMEL_ADDR(ga, pos + gapsize),
523 GAP_ARRAY_MEMEL_ADDR(ga, pos),
524 (gap - pos) * ga->elsize);
525 gap_array_adjust_markers(ga, (Memind) pos, (Memind) gap,
527 } else if (pos > gap) {
528 memmove(GAP_ARRAY_MEMEL_ADDR(ga, gap),
529 GAP_ARRAY_MEMEL_ADDR(ga, gap + gapsize),
530 (pos - gap) * ga->elsize);
531 gap_array_adjust_markers(ga, (Memind) (gap + gapsize),
532 (Memind) (pos + gapsize), -gapsize);
538 /* Make the gap INCREMENT characters longer. Parallel to make_gap() in
542 gap_array_make_gap(gap_array_t ga, int increment)
544 char *ptr = ga->array;
548 /* If we have to get more space, get enough to last a while. We use
549 a geometric progression that saves on realloc space. */
550 increment += 100 + ga->numels / 8;
552 ptr = (char*)xrealloc(ptr,
553 (ga->numels + ga->gapsize +
554 increment) * ga->elsize);
560 real_gap_loc = ga->gap;
561 old_gap_size = ga->gapsize;
563 /* Call the newly allocated space a gap at the end of the whole
565 ga->gap = ga->numels + ga->gapsize;
566 ga->gapsize = increment;
568 /* Move the new gap down to be consecutive with the end of the old one.
569 This adjusts the markers properly too. */
570 gap_array_move_gap(ga, real_gap_loc + old_gap_size);
572 /* Now combine the two into one large gap. */
573 ga->gapsize += old_gap_size;
574 ga->gap = real_gap_loc;
578 /* ------------------------------- */
579 /* external functions */
580 /* ------------------------------- */
582 /* Insert NUMELS elements (pointed to by ELPTR) into the specified
586 gap_array_insert_els(gap_array_t ga, int pos, void *elptr, int numels)
588 assert(pos >= 0 && pos <= ga->numels);
589 if (ga->gapsize < numels) {
590 gap_array_make_gap(ga, numels - ga->gapsize);
592 if (pos != ga->gap) {
593 gap_array_move_gap(ga, pos);
595 memcpy(GAP_ARRAY_MEMEL_ADDR(ga, ga->gap), (char *)elptr,
596 numels * ga->elsize);
597 ga->gapsize -= numels;
599 ga->numels += numels;
600 /* This is the equivalent of insert-before-markers.
602 #### Should only happen if marker is "moves forward at insert" type.
605 gap_array_adjust_markers(ga, pos - 1, pos, numels);
609 /* Delete NUMELS elements from the specified gap array, starting at FROM. */
612 gap_array_delete_els(gap_array_t ga, int from, int numdel)
614 int to = from + numdel;
615 int gapsize = ga->gapsize;
619 assert(to <= ga->numels);
621 /* Make sure the gap is somewhere in or next to what we are deleting. */
623 gap_array_move_gap(ga, to);
625 if (from > ga->gap) {
626 gap_array_move_gap(ga, from);
628 /* Relocate all markers pointing into the new, larger gap
629 to point at the end of the text before the gap. */
630 gap_array_adjust_markers(ga, to + gapsize, to + gapsize,
633 ga->gapsize += numdel;
634 ga->numels -= numdel;
639 static gap_array_marker_t
640 gap_array_make_marker(gap_array_t ga, int pos)
642 gap_array_marker_t m;
644 assert(pos >= 0 && pos <= ga->numels);
645 #if defined HAVE_BDWGC && defined EF_USE_BDWGC
646 m = xnew(struct gap_array_marker_s);
648 if (gap_array_marker_freelist) {
649 m = gap_array_marker_freelist;
650 gap_array_marker_freelist = gap_array_marker_freelist->next;
652 m = xnew(struct gap_array_marker_s);
656 m->pos = GAP_ARRAY_ARRAY_TO_MEMORY_POS(ga, pos);
657 m->next = ga->markers;
663 gap_array_delete_marker(gap_array_t ga, gap_array_marker_t m)
665 volatile gap_array_marker_t p, prev;
667 for (prev = 0, p = ga->markers; p && p != m; prev = p, p = p->next);
668 if (UNLIKELY(p == NULL)) {
673 prev->next = p->next;
675 ga->markers = p->next;
677 #if defined HAVE_BDWGC && defined EF_USE_BDWGC
680 m->next = gap_array_marker_freelist;
682 gap_array_marker_freelist = m;
688 gap_array_delete_all_markers(gap_array_t ga)
690 for (volatile gap_array_marker_t p = ga->markers, next; p; p = next) {
692 #if defined HAVE_BDWGC && defined EF_USE_BDWGC
695 p->next = gap_array_marker_freelist;
697 gap_array_marker_freelist = p;
705 gap_array_move_marker(gap_array_t ga, gap_array_marker_t m, int pos)
707 assert(pos >= 0 && pos <= ga->numels);
708 m->pos = GAP_ARRAY_ARRAY_TO_MEMORY_POS(ga, pos);
711 #define gap_array_marker_pos(ga, m) \
712 GAP_ARRAY_MEMORY_TO_ARRAY_POS (ga, (m)->pos)
715 make_gap_array(int elsize)
717 gap_array_t ga = xnew_and_zero(struct gap_array_s);
723 free_gap_array(gap_array_t ga)
728 gap_array_delete_all_markers(ga);
733 /************************************************************************/
734 /* Extent list primitives */
735 /************************************************************************/
737 /* A list of extents is maintained as a double gap array: one gap array
738 is ordered by start index (the "display order") and the other is
739 ordered by end index (the "e-order"). Note that positions in an
740 extent list should logically be conceived of as referring *to*
741 a particular extent (as is the norm in programs) rather than
742 sitting between two extents. Note also that callers of these
743 functions should not be aware of the fact that the extent list is
744 implemented as an array, except for the fact that positions are
745 integers (this should be generalized to handle integers and linked
749 /* Number of elements in an extent list */
750 #define extent_list_num_els(el) GAP_ARRAY_NUM_ELS(el->start)
752 /* Return the position at which EXTENT is located in the specified extent
753 list (in the display order if ENDP is 0, in the e-order otherwise).
754 If the extent is not found, the position where the extent would
755 be inserted is returned. If ENDP is 0, the insertion would go after
756 all other equal extents. If ENDP is not 0, the insertion would go
757 before all other equal extents. If FOUNDP is not 0, then whether
758 the extent was found will get written into it. */
761 extent_list_locate(extent_list_t el, EXTENT extent, int endp, bool *foundp)
763 gap_array_t ga = endp ? el->end : el->start;
764 int left = 0, right = GAP_ARRAY_NUM_ELS(ga);
765 int oldfoundpos, foundpos;
768 while (left != right) {
769 /* RIGHT might not point to a valid extent (i.e. it's at the end
770 of the list), so NEWPOS must round down. */
771 unsigned int newpos = (left + right) >> 1;
772 EXTENT e = EXTENT_GAP_ARRAY_AT(ga, (int)newpos);
774 if (endp ? EXTENT_E_LESS(e, extent) : EXTENT_LESS(e, extent)) {
781 /* Now we're at the beginning of all equal extents. */
783 oldfoundpos = foundpos = left;
784 while (foundpos < GAP_ARRAY_NUM_ELS(ga)) {
785 EXTENT e = EXTENT_GAP_ARRAY_AT(ga, foundpos);
790 if (!EXTENT_EQUAL(e, extent)) {
798 if (found || !endp) {
805 /* Return the position of the first extent that begins at or after POS
806 (or ends at or after POS, if ENDP is not 0).
808 An out-of-range value for POS is allowed, and guarantees that the
809 position at the beginning or end of the extent list is returned. */
812 extent_list_locate_from_pos(extent_list_t el, Memind pos, int endp)
814 struct extent fake_extent;
817 Note that if we search for [POS, POS], then we get the following:
819 -- if ENDP is 0, then all extents whose start position is <= POS
820 lie before the returned position, and all extents whose start
821 position is > POS lie at or after the returned position.
823 -- if ENDP is not 0, then all extents whose end position is < POS
824 lie before the returned position, and all extents whose end
825 position is >= POS lie at or after the returned position.
828 set_extent_start(&fake_extent, endp ? pos : pos - 1);
829 set_extent_end(&fake_extent, endp ? pos : pos - 1);
830 return extent_list_locate(el, &fake_extent, endp, 0);
833 /* Return the extent at POS. */
836 extent_list_at(extent_list_t el, Memind pos, int endp)
838 gap_array_t ga = endp ? el->end : el->start;
840 assert(pos >= 0 && pos < GAP_ARRAY_NUM_ELS(ga));
841 return EXTENT_GAP_ARRAY_AT(ga, pos);
844 /* Insert an extent into an extent list. */
847 extent_list_insert(extent_list_t el, EXTENT extent)
852 pos = extent_list_locate(el, extent, 0, &foundp);
854 gap_array_insert_els(el->start, pos, &extent, 1);
855 pos = extent_list_locate(el, extent, 1, &foundp);
857 gap_array_insert_els(el->end, pos, &extent, 1);
861 /* Delete an extent from an extent list. */
864 extent_list_delete(extent_list_t el, EXTENT extent)
869 pos = extent_list_locate(el, extent, 0, &foundp);
871 gap_array_delete_els(el->start, pos, 1);
872 pos = extent_list_locate(el, extent, 1, &foundp);
874 gap_array_delete_els(el->end, pos, 1);
879 extent_list_delete_all(extent_list_t el)
881 gap_array_delete_els(el->start, 0, GAP_ARRAY_NUM_ELS(el->start));
882 gap_array_delete_els(el->end, 0, GAP_ARRAY_NUM_ELS(el->end));
886 static extent_list_marker_t
887 extent_list_make_marker(extent_list_t el, int pos, int endp)
889 extent_list_marker_t m;
891 #if defined HAVE_BDWGC && defined EF_USE_BDWGC
892 m = xnew(struct extent_list_marker_s);
894 if (extent_list_marker_freelist) {
895 m = extent_list_marker_freelist;
896 extent_list_marker_freelist = extent_list_marker_freelist->next;
898 m = xnew(struct extent_list_marker_s);
902 m->m = gap_array_make_marker(endp ? el->end : el->start, pos);
904 m->next = el->markers;
909 #define extent_list_move_marker(el, mkr, pos) \
910 gap_array_move_marker((mkr)->endp \
912 : (el)->start, (mkr)->m, pos)
915 extent_list_delete_marker(extent_list_t el, extent_list_marker_t m)
917 extent_list_marker_t p, prev;
919 for (prev = 0, p = el->markers; p && p != m; prev = p, p = p->next);
922 prev->next = p->next;
924 el->markers = p->next;
926 #if defined HAVE_BDWGC && defined EF_USE_BDWGC
929 m->next = extent_list_marker_freelist;
930 extent_list_marker_freelist = m;
932 gap_array_delete_marker(m->endp ? el->end : el->start, m->m);
936 #define extent_list_marker_pos(el, mkr) \
937 gap_array_marker_pos ((mkr)->endp \
939 : (el)->start, (mkr)->m)
942 allocate_extent_list(void)
944 extent_list_t el = xnew(struct extent_list_s);
945 el->start = make_gap_array(sizeof(EXTENT));
946 el->end = make_gap_array(sizeof(EXTENT));
952 free_extent_list(extent_list_t el)
954 free_gap_array(el->start);
955 free_gap_array(el->end);
960 /************************************************************************/
961 /* Auxiliary extent structure */
962 /************************************************************************/
964 static Lisp_Object mark_extent_auxiliary(Lisp_Object obj)
966 struct extent_auxiliary *data = XEXTENT_AUXILIARY(obj);
967 mark_object(data->begin_glyph);
968 mark_object(data->end_glyph);
969 mark_object(data->invisible);
970 mark_object(data->children);
971 mark_object(data->read_only);
972 mark_object(data->mouse_face);
973 mark_object(data->initial_redisplay_function);
974 mark_object(data->before_change_functions);
975 mark_object(data->after_change_functions);
979 DEFINE_LRECORD_IMPLEMENTATION("extent-auxiliary", extent_auxiliary,
980 mark_extent_auxiliary, internal_object_printer,
981 0, 0, 0, 0, struct extent_auxiliary);
983 void allocate_extent_auxiliary(EXTENT ext)
985 Lisp_Object extent_aux;
986 struct extent_auxiliary *data =
987 alloc_lcrecord_type(struct extent_auxiliary,
988 &lrecord_extent_auxiliary);
990 copy_lcrecord(data, &extent_auxiliary_defaults);
991 XSETEXTENT_AUXILIARY(extent_aux, data);
992 ext->plist = Fcons(extent_aux, ext->plist);
993 ext->flags.has_aux = 1;
997 /************************************************************************/
998 /* Extent info structure */
999 /************************************************************************/
1001 /* An extent-info structure consists of a list of the buffer or string's
1002 extents and a "stack of extents" that lists all of the extents over
1003 a particular position. The stack-of-extents info is used for
1004 optimization purposes -- it basically caches some info that might
1005 be expensive to compute. Certain otherwise hard computations are easy
1006 given the stack of extents over a particular position, and if the
1007 stack of extents over a nearby position is known (because it was
1008 calculated at some prior point in time), it's easy to move the stack
1009 of extents to the proper position.
1011 Given that the stack of extents is an optimization, and given that
1012 it requires memory, a string's stack of extents is wiped out each
1013 time a garbage collection occurs. Therefore, any time you retrieve
1014 the stack of extents, it might not be there. If you need it to
1015 be there, use the _force version.
1017 Similarly, a string may or may not have an extent_info structure.
1018 (Generally it won't if there haven't been any extents added to the
1019 string.) So use the _force version if you need the extent_info
1020 structure to be there. */
1022 static extent_stack_t allocate_soe(void);
1023 static void free_soe(extent_stack_t);
1024 static void soe_invalidate(Lisp_Object obj);
1026 #if !defined HAVE_BDWGC || !defined EF_USE_BDWGC
1028 mark_extent_info(Lisp_Object obj)
1030 struct extent_info *data = (struct extent_info *)XEXTENT_INFO(obj);
1032 extent_list_t list = data->extents;
1034 /* Vbuffer_defaults and Vbuffer_local_symbols are buffer-like
1035 objects that are created specially and never have their extent
1036 list initialized (or rather, it is set to zero in
1037 nuke_all_buffer_slots()). However, these objects get
1038 garbage-collected so we have to deal.
1040 (Also the list can be zero when we're dealing with a destroyed
1044 for (i = 0; i < extent_list_num_els(list); i++) {
1045 struct extent *extent = extent_list_at(list, i, 0);
1048 XSETEXTENT(exobj, extent);
1057 finalize_extent_info(void *header, int for_disksave)
1059 struct extent_info *data = (struct extent_info *)header;
1065 free_soe(data->soe);
1068 if (data->extents) {
1069 free_extent_list(data->extents);
1074 /* just define dummies */
1076 mark_extent_info(Lisp_Object UNUSED(obj))
1082 finalize_extent_info(void *UNUSED(header), int UNUSED(for_disksave))
1088 DEFINE_LRECORD_IMPLEMENTATION("extent-info", extent_info,
1089 mark_extent_info, internal_object_printer,
1090 finalize_extent_info, 0, 0, 0,
1091 struct extent_info);
1094 allocate_extent_info(void)
1096 Lisp_Object extent_info;
1097 struct extent_info *data =
1098 alloc_lcrecord_type(struct extent_info, &lrecord_extent_info);
1100 XSETEXTENT_INFO(extent_info, data);
1101 data->extents = allocate_extent_list();
1107 flush_cached_extent_info(Lisp_Object extent_info)
1109 struct extent_info *data = XEXTENT_INFO(extent_info);
1112 free_soe(data->soe);
1117 /************************************************************************/
1118 /* Buffer/string extent primitives */
1119 /************************************************************************/
1121 /* The functions in this section are the ONLY ones that should know
1122 about the internal implementation of the extent lists. Other functions
1123 should only know that there are two orderings on extents, the "display"
1124 order (sorted by start position, basically) and the e-order (sorted
1125 by end position, basically), and that certain operations are provided
1126 to manipulate the list. */
1128 /* ------------------------------- */
1129 /* basic primitives */
1130 /* ------------------------------- */
1133 decode_buffer_or_string(Lisp_Object object)
1135 if (LIKELY(NILP(object))) {
1136 XSETBUFFER(object, current_buffer);
1137 } else if (BUFFERP(object)) {
1138 CHECK_LIVE_BUFFER(object);
1139 } else if (STRINGP(object)) {
1142 dead_wrong_type_argument(Qbuffer_or_string_p, object);
1147 EXTENT extent_ancestor_1(EXTENT e)
1149 while (e->flags.has_parent) {
1150 /* There should be no circularities except in case of a logic
1151 error somewhere in the extent code */
1152 e = XEXTENT(XEXTENT_AUXILIARY(XCAR(e->plist))->parent);
1157 /* Given an extent object (string or buffer or nil), return its extent info.
1158 This may be 0 for a string. */
1160 static struct extent_info*
1161 buffer_or_string_extent_info(Lisp_Object object)
1163 if (STRINGP(object)) {
1164 Lisp_Object plist = XSTRING(object)->plist;
1165 if (!CONSP(plist) || !EXTENT_INFOP(XCAR(plist))) {
1168 return XEXTENT_INFO(XCAR(plist));
1169 } else if (NILP(object)) {
1172 return XEXTENT_INFO(XBUFFER(object)->extent_info);
1176 /* Given a string or buffer, return its extent list. This may be
1179 static extent_list_t
1180 buffer_or_string_extent_list(Lisp_Object object)
1182 struct extent_info *info = buffer_or_string_extent_info(object);
1187 return info->extents;
1190 /* Given a string or buffer, return its extent info. If it's not there,
1193 static struct extent_info*
1194 buffer_or_string_extent_info_force(Lisp_Object object)
1196 struct extent_info *info = buffer_or_string_extent_info(object);
1199 Lisp_Object extent_info;
1201 /* should never happen for buffers --
1202 the only buffers without an extent
1203 info are those after finalization,
1204 destroyed buffers, or special
1205 Lisp-inaccessible buffer objects. */
1206 assert(STRINGP(object));
1208 extent_info = allocate_extent_info();
1209 XSTRING(object)->plist =
1210 Fcons(extent_info, XSTRING(object)->plist);
1211 return XEXTENT_INFO(extent_info);
1216 /* Detach all the extents in OBJECT. Called from redisplay. */
1219 detach_all_extents(Lisp_Object object)
1221 struct extent_info *data = buffer_or_string_extent_info(object);
1224 if (data->extents) {
1226 i < extent_list_num_els(data->extents);
1228 EXTENT e = extent_list_at(data->extents, i, 0);
1229 /* No need to do detach_extent(). Just nuke the
1230 damn things, which results in the equivalent
1232 set_extent_start(e, -1);
1233 set_extent_end(e, -1);
1235 /* But we need to clear all the lists containing extents
1236 or havoc will result. */
1237 extent_list_delete_all(data->extents);
1239 soe_invalidate(object);
1245 init_buffer_extents(struct buffer *b)
1247 b->extent_info = allocate_extent_info();
1252 uninit_buffer_extents(struct buffer *b)
1254 struct extent_info *data = XEXTENT_INFO(b->extent_info);
1256 /* Don't destroy the extents here -- there may still be children
1257 extents pointing to the extents. */
1258 detach_all_extents(make_buffer(b));
1259 finalize_extent_info(data, 0);
1263 /* Retrieve the extent list that an extent is a member of; the
1264 return value will never be 0 except in destroyed buffers (in which
1265 case the only extents that can refer to this buffer are detached
1268 #define extent_extent_list(e) buffer_or_string_extent_list (extent_object (e))
1270 /* ------------------------------- */
1271 /* stack of extents */
1272 /* ------------------------------- */
1274 #ifdef ERROR_CHECK_EXTENTS
1277 sledgehammer_extent_check(Lisp_Object object)
1279 extent_list_t el = buffer_or_string_extent_list(object);
1280 struct buffer *buf = 0;
1285 if (BUFFERP(object)) {
1286 buf = XBUFFER(object);
1288 for (int endp = 0; endp < 2; endp++) {
1289 for (int i = 1; i < extent_list_num_els(el); i++) {
1290 EXTENT e1 = extent_list_at(el, i - 1, endp);
1291 EXTENT e2 = extent_list_at(el, i, endp);
1293 assert(extent_start(e1) <= buf->text->gpt ||
1295 buf->text->gpt + buf->text->gap_size);
1296 assert(extent_end(e1) <= buf->text->gpt
1298 buf->text->gpt + buf->text->gap_size);
1300 assert(extent_start(e1) <= extent_end(e1));
1302 ? (EXTENT_E_LESS_EQUAL(e1, e2))
1303 : (EXTENT_LESS_EQUAL(e1, e2)));
1308 #endif /* ERROR_CHECK_EXTENTS */
1310 static extent_stack_t
1311 buffer_or_string_stack_of_extents(Lisp_Object object)
1313 struct extent_info *info = buffer_or_string_extent_info(object);
1320 static extent_stack_t
1321 buffer_or_string_stack_of_extents_force(Lisp_Object object)
1323 struct extent_info *info = buffer_or_string_extent_info_force(object);
1325 info->soe = allocate_soe();
1330 /* #define SOE_DEBUG */
1334 static void print_extent_1(char *buf, Lisp_Object extent);
1337 print_extent_2(EXTENT e)
1342 XSETEXTENT(extent, e);
1343 print_extent_1(buf, extent);
1348 soe_dump(Lisp_Object obj)
1351 extent_stack_t soe = buffer_or_string_stack_of_extents(obj);
1360 printf("SOE pos is %d (memind %d)\n",
1361 soe->pos < 0 ? soe->pos :
1362 buffer_or_string_memind_to_bytind(obj, soe->pos), soe->pos);
1363 for (endp = 0; endp < 2; endp++) {
1364 printf(endp ? "SOE end:" : "SOE start:");
1365 for (i = 0; i < extent_list_num_els(sel); i++) {
1366 EXTENT e = extent_list_at(sel, i, endp);
1375 #endif /* SOE_DEBUG */
1377 /* Insert EXTENT into OBJ's stack of extents, if necessary. */
1380 soe_insert(Lisp_Object obj, EXTENT extent)
1382 extent_stack_t soe = buffer_or_string_stack_of_extents(obj);
1385 printf("Inserting into SOE: ");
1386 print_extent_2(extent);
1389 if (!soe || soe->pos < extent_start(extent) ||
1390 soe->pos > extent_end(extent)) {
1392 printf("(not needed)\n\n");
1396 extent_list_insert(soe->extents, extent);
1398 puts("SOE afterwards is:");
1404 /* Delete EXTENT from OBJ's stack of extents, if necessary. */
1407 soe_delete(Lisp_Object obj, EXTENT extent)
1409 extent_stack_t soe = buffer_or_string_stack_of_extents(obj);
1412 printf("Deleting from SOE: ");
1413 print_extent_2(extent);
1416 if (!soe || soe->pos < extent_start(extent) ||
1417 soe->pos > extent_end(extent)) {
1419 puts("(not needed)\n");
1423 extent_list_delete(soe->extents, extent);
1425 puts("SOE afterwards is:");
1431 /* Move OBJ's stack of extents to lie over the specified position. */
1434 soe_move(Lisp_Object obj, Memind pos)
1436 extent_stack_t soe = buffer_or_string_stack_of_extents_force(obj);
1437 extent_list_t sel = soe->extents;
1438 int numsoe = extent_list_num_els(sel);
1439 extent_list_t bel = buffer_or_string_extent_list(obj);
1443 #ifdef ERROR_CHECK_EXTENTS
1448 printf("Moving SOE from %d (memind %d) to %d (memind %d)\n",
1449 soe->pos < 0 ? soe->pos :
1450 buffer_or_string_memind_to_bytind(obj, soe->pos), soe->pos,
1451 buffer_or_string_memind_to_bytind(obj, pos), pos);
1453 if (soe->pos < pos) {
1456 } else if (soe->pos > pos) {
1461 puts("(not needed)\n");
1466 /* For DIRECTION = 1: Any extent that overlaps POS is either in the
1467 SOE (if the extent starts at or before SOE->POS) or is greater
1468 (in the display order) than any extent in the SOE (if it starts
1471 For DIRECTION = -1: Any extent that overlaps POS is either in the
1472 SOE (if the extent ends at or after SOE->POS) or is less (in the
1473 e-order) than any extent in the SOE (if it ends before SOE->POS).
1475 We proceed in two stages:
1477 1) delete all extents in the SOE that don't overlap POS.
1478 2) insert all extents into the SOE that start (or end, when
1479 DIRECTION = -1) in (SOE->POS, POS] and that overlap
1480 POS. (Don't include SOE->POS in the range because those
1481 extents would already be in the SOE.)
1487 /* Delete all extents in the SOE that don't overlap POS.
1488 This is all extents that end before (or start after,
1489 if DIRECTION = -1) POS.
1492 /* Deleting extents from the SOE is tricky because it changes
1493 the positions of extents. If we are deleting in the forward
1494 direction we have to call extent_list_at() on the same position
1495 over and over again because positions after the deleted element
1496 get shifted back by 1. To make life simplest, we delete forward
1497 irrespective of DIRECTION.
1502 if (direction > 0) {
1504 end = extent_list_locate_from_pos(sel, pos, 1);
1506 start = extent_list_locate_from_pos(sel, pos + 1, 0);
1510 for (i = start; i < end; i++) {
1512 sel, extent_list_at(sel, start, !endp));
1521 if (direction < 0) {
1523 extent_list_locate_from_pos(
1524 bel, soe->pos, endp) - 1;
1527 extent_list_locate_from_pos(
1528 bel, soe->pos + 1, endp);
1531 for (; start_pos >= 0 && start_pos < extent_list_num_els(bel);
1532 start_pos += direction) {
1533 EXTENT e = extent_list_at(bel, start_pos, endp);
1535 ? (extent_start(e) > pos)
1536 : (extent_end(e) < pos)) {
1537 /* All further extents lie on the far side of
1538 POS and thus can't overlap. */
1542 ? (extent_end(e) >= pos)
1543 : (extent_start(e) <= pos)) {
1544 extent_list_insert(sel, e);
1551 puts("SOE afterwards is:");
1558 soe_invalidate(Lisp_Object obj)
1560 extent_stack_t soe = buffer_or_string_stack_of_extents(obj);
1563 extent_list_delete_all(soe->extents);
1569 static extent_stack_t
1572 extent_stack_t soe = xnew_and_zero(struct extent_stack_s);
1573 soe->extents = allocate_extent_list();
1579 free_soe(extent_stack_t soe)
1581 free_extent_list(soe->extents);
1586 /* ------------------------------- */
1587 /* other primitives */
1588 /* ------------------------------- */
1590 /* Return the start (endp == 0) or end (endp == 1) of an extent as
1591 a byte index. If you want the value as a memory index, use
1592 extent_endpoint(). If you want the value as a buffer position,
1593 use extent_endpoint_bufpos(). */
1595 static Bytind extent_endpoint_bytind(EXTENT extent, int endp)
1597 assert(EXTENT_LIVE_P(extent));
1598 assert(!extent_detached_p(extent));
1600 Memind i = endp ? extent_end(extent) : extent_start(extent);
1601 Lisp_Object obj = extent_object(extent);
1602 return buffer_or_string_memind_to_bytind(obj, i);
1606 static Bufpos extent_endpoint_bufpos(EXTENT extent, int endp)
1608 assert(EXTENT_LIVE_P(extent));
1609 assert(!extent_detached_p(extent));
1611 Memind i = endp ? extent_end(extent) : extent_start(extent);
1612 Lisp_Object obj = extent_object(extent);
1613 return buffer_or_string_memind_to_bufpos(obj, i);
1617 /* A change to an extent occurred that will change the display, so
1618 notify redisplay. Maybe also recurse over all the extent's
1622 extent_changed_for_redisplay(EXTENT extent, int descendants_too,
1623 int invisibility_change)
1628 /* we could easily encounter a detached extent while traversing the
1629 children, but we should never be able to encounter a dead extent. */
1630 assert(EXTENT_LIVE_P(extent));
1632 if (descendants_too) {
1633 Lisp_Object children = extent_children(extent);
1635 if (!NILP(children)) {
1636 /* first mark all of the extent's children. We will
1637 lose big-time if there are any circularities here, so
1638 we sure as hell better ensure that there aren't. */
1639 LIST_LOOP(rest, XWEAK_LIST_LIST(children)) {
1640 extent_changed_for_redisplay(
1641 XEXTENT(XCAR(rest)), 1,
1642 invisibility_change);
1647 /* now mark the extent itself. */
1649 object = extent_object(extent);
1651 if (extent_detached_p(extent)) {
1654 } else if (STRINGP(object)) {
1655 /* #### Changes to string extents can affect redisplay if they
1656 are in the modeline or in the gutters.
1658 If the extent is in some generated-modeline-string: when we
1659 change an extent in generated-modeline-string, this changes
1660 its parent, which is in `modeline-format', so we should force
1661 the modeline to be updated. But how to determine whether a
1662 string is a `generated-modeline-string'? Looping through all
1663 buffers is not very efficient. Should we add all
1664 `generated-modeline-string' strings to a hash table? Maybe
1665 efficiency is not the greatest concern here and there's no
1666 big loss in looping over the buffers.
1668 If the extent is in a gutter we mark the gutter as
1669 changed. This means (a) we can update extents in the gutters
1670 when we need it. (b) we don't have to update the gutters when
1671 only extents attached to buffers have changed. */
1673 if (!in_modeline_generation) {
1674 MARK_EXTENTS_CHANGED;
1676 gutter_extent_signal_changed_region_maybe(
1678 extent_endpoint_bufpos(extent, 0),
1679 extent_endpoint_bufpos(extent, 1));
1681 } else if (BUFFERP(object)) {
1683 b = XBUFFER(object);
1684 BUF_FACECHANGE(b)++;
1685 MARK_EXTENTS_CHANGED;
1686 if (invisibility_change) {
1689 buffer_extent_signal_changed_region(
1691 extent_endpoint_bufpos(extent, 0),
1692 extent_endpoint_bufpos(extent, 1));
1696 /* A change to an extent occurred that might affect redisplay.
1697 This is called when properties such as the endpoints, the layout,
1698 or the priority changes. Redisplay will be affected only if
1699 the extent has any displayable attributes. */
1702 extent_maybe_changed_for_redisplay(EXTENT extent, int descendants_too,
1703 int invisibility_change)
1705 /* Retrieve the ancestor for efficiency */
1706 EXTENT anc = extent_ancestor(extent);
1707 if (!NILP(extent_face(anc)) ||
1708 !NILP(extent_begin_glyph(anc)) ||
1709 !NILP(extent_end_glyph(anc)) ||
1710 !NILP(extent_mouse_face(anc)) ||
1711 !NILP(extent_invisible(anc)) ||
1712 !NILP(extent_initial_redisplay_function(anc)) ||
1713 invisibility_change)
1714 extent_changed_for_redisplay(extent, descendants_too,
1715 invisibility_change);
1719 make_extent_detached(Lisp_Object object)
1721 EXTENT extent = allocate_extent();
1723 assert(NILP(object) || STRINGP(object) ||
1724 (BUFFERP(object) && BUFFER_LIVE_P(XBUFFER(object))));
1725 extent_object(extent) = object;
1726 /* Now make sure the extent info exists. */
1727 if (!NILP(object)) {
1728 buffer_or_string_extent_info_force(object);
1733 /* A "real" extent is any extent other than the internal (not-user-visible)
1734 extents used by `map-extents'. */
1737 real_extent_at_forward(extent_list_t el, int pos, int endp)
1739 for (; pos < extent_list_num_els(el); pos++) {
1740 EXTENT e = extent_list_at(el, pos, endp);
1741 if (!extent_internal_p(e)) {
1749 real_extent_at_backward(extent_list_t el, int pos, int endp)
1751 for (; pos >= 0; pos--) {
1752 EXTENT e = extent_list_at(el, pos, endp);
1753 if (!extent_internal_p(e)) {
1761 extent_first(Lisp_Object obj)
1763 extent_list_t el = buffer_or_string_extent_list(obj);
1768 return real_extent_at_forward(el, 0, 0);
1771 #ifdef DEBUG_SXEMACS
1773 extent_e_first(Lisp_Object obj)
1775 extent_list_t el = buffer_or_string_extent_list(obj);
1780 return real_extent_at_forward(el, 0, 1);
1782 #endif /* DEBUG_SXEMACS */
1785 extent_next(EXTENT e)
1787 extent_list_t el = extent_extent_list(e);
1789 int pos = extent_list_locate(el, e, 0, &foundp);
1791 return real_extent_at_forward(el, pos + 1, 0);
1794 #ifdef DEBUG_SXEMACS
1796 extent_e_next(EXTENT e)
1798 extent_list_t el = extent_extent_list(e);
1800 int pos = extent_list_locate(el, e, 1, &foundp);
1802 return real_extent_at_forward(el, pos + 1, 1);
1804 #endif /* DEBUG_SXEMACS */
1807 extent_last(Lisp_Object obj)
1809 extent_list_t el = buffer_or_string_extent_list(obj);
1814 return real_extent_at_backward(el, extent_list_num_els(el) - 1, 0);
1817 #ifdef DEBUG_SXEMACS
1819 extent_e_last(Lisp_Object obj)
1821 extent_list_t el = buffer_or_string_extent_list(obj);
1826 return real_extent_at_backward(el, extent_list_num_els(el) - 1, 1);
1828 #endif /* DEBUG_SXEMACS */
1831 extent_previous(EXTENT e)
1833 extent_list_t el = extent_extent_list(e);
1835 int pos = extent_list_locate(el, e, 0, &foundp);
1837 return real_extent_at_backward(el, pos - 1, 0);
1840 #ifdef DEBUG_SXEMACS
1842 extent_e_previous(EXTENT e)
1844 extent_list_t el = extent_extent_list(e);
1846 int pos = extent_list_locate(el, e, 1, &foundp);
1848 return real_extent_at_backward(el, pos - 1, 1);
1850 #endif /* DEBUG_SXEMACS */
1853 extent_attach(EXTENT extent)
1855 extent_list_t el = extent_extent_list(extent);
1857 extent_list_insert(el, extent);
1858 soe_insert(extent_object(extent), extent);
1859 /* only this extent changed */
1860 extent_maybe_changed_for_redisplay(
1861 extent, 0, !NILP(extent_invisible(extent)));
1866 extent_detach(EXTENT extent)
1870 if (extent_detached_p(extent)) {
1873 el = extent_extent_list(extent);
1875 /* call this before messing with the extent. */
1876 extent_maybe_changed_for_redisplay(
1877 extent, 0, !NILP(extent_invisible(extent)));
1878 extent_list_delete(el, extent);
1879 soe_delete(extent_object(extent), extent);
1880 set_extent_start(extent, -1);
1881 set_extent_end(extent, -1);
1885 /* ------------------------------- */
1886 /* map-extents et al. */
1887 /* ------------------------------- */
1889 /* Returns true iff map_extents() would visit the given extent.
1890 See the comments at map_extents() for info on the overlap rule.
1891 Assumes that all validation on the extent and buffer positions has
1892 already been performed (see Fextent_in_region_p ()).
1895 extent_in_region_p(EXTENT extent, Bytind from, Bytind to, unsigned int flags)
1897 Lisp_Object obj = extent_object(extent);
1898 Endpoint_Index start, end, exs, exe;
1899 int start_open, end_open;
1900 unsigned int all_extents_flags = flags & ME_ALL_EXTENTS_MASK;
1901 unsigned int in_region_flags = flags & ME_IN_REGION_MASK;
1904 /* A zero-length region is treated as closed-closed. */
1906 flags |= ME_END_CLOSED;
1907 flags &= ~ME_START_OPEN;
1910 /* So is a zero-length extent. */
1911 if (extent_start(extent) == extent_end(extent)) {
1912 start_open = 0, end_open = 0;
1913 } else if (LIKELY(all_extents_flags == 0)) {
1914 /* `all_extents_flags' will almost always be zero. */
1915 start_open = extent_start_open_p(extent);
1916 end_open = extent_end_open_p(extent);
1918 switch (all_extents_flags) {
1919 case ME_ALL_EXTENTS_CLOSED:
1920 start_open = 0, end_open = 0;
1922 case ME_ALL_EXTENTS_OPEN:
1923 start_open = 1, end_open = 1;
1925 case ME_ALL_EXTENTS_CLOSED_OPEN:
1926 start_open = 0, end_open = 1;
1928 case ME_ALL_EXTENTS_OPEN_CLOSED:
1929 start_open = 1, end_open = 0;
1936 start = buffer_or_string_bytind_to_startind(obj, from,
1937 flags & ME_START_OPEN);
1938 end = buffer_or_string_bytind_to_endind(obj, to,
1939 !(flags & ME_END_CLOSED));
1940 exs = memind_to_startind(extent_start(extent), start_open);
1941 exe = memind_to_endind(extent_end(extent), end_open);
1943 /* It's easy to determine whether an extent lies *outside* the
1944 region -- just determine whether it's completely before
1945 or completely after the region. Reject all such extents, so
1946 we're now left with only the extents that overlap the region.
1949 if (exs > end || exe < start) {
1952 /* See if any further restrictions are called for. */
1953 /* in_region_flags will almost always be zero. */
1954 if (in_region_flags == 0) {
1957 switch (in_region_flags) {
1958 case ME_START_IN_REGION:
1959 retval = start <= exs && exs <= end;
1961 case ME_END_IN_REGION:
1962 retval = start <= exe && exe <= end;
1964 case ME_START_AND_END_IN_REGION:
1965 retval = start <= exs && exe <= end;
1967 case ME_START_OR_END_IN_REGION:
1968 retval = (start <= exs && exs <= end) ||
1969 (start <= exe && exe <= end);
1976 return flags & ME_NEGATE_IN_REGION ? !retval : retval;
1979 struct map_extents_struct {
1981 extent_list_marker_t mkr;
1986 map_extents_unwind(Lisp_Object obj)
1988 struct map_extents_struct *closure =
1989 (struct map_extents_struct *)get_opaque_ptr(obj);
1990 free_opaque_ptr(obj);
1991 if (closure->range) {
1992 extent_detach(closure->range);
1995 extent_list_delete_marker(closure->el, closure->mkr);
2000 /* This is the guts of `map-extents' and the other functions that
2001 map over extents. In theory the operation of this function is
2002 simple: just figure out what extents we're mapping over, and
2003 call the function on each one of them in the range. Unfortunately
2004 there are a wide variety of things that the mapping function
2005 might do, and we have to be very tricky to avoid getting messed
2006 up. Furthermore, this function needs to be very fast (it is
2007 called multiple times every time text is inserted or deleted
2008 from a buffer), and so we can't always afford the overhead of
2009 dealing with all the possible things that the mapping function
2010 might do; thus, there are many flags that can be specified
2011 indicating what the mapping function might or might not do.
2013 The result of all this is that this is the most complicated
2014 function in this file. Change it at your own risk!
2016 A potential simplification to the logic below is to determine
2017 all the extents that the mapping function should be called on
2018 before any calls are actually made and save them in an array.
2019 That introduces its own complications, however (the array
2020 needs to be marked for garbage-collection, and a static array
2021 cannot be used because map_extents() needs to be reentrant).
2022 Furthermore, the results might be a little less sensible than
2026 map_extents_bytind(Bytind from, Bytind to, map_extents_fun fn, void *arg,
2027 Lisp_Object obj, EXTENT after, unsigned int flags)
2029 Memind st, en; /* range we're mapping over */
2030 EXTENT range = 0; /* extent for this, if ME_MIGHT_MODIFY_TEXT */
2031 extent_list_t el = 0; /* extent list we're iterating over */
2032 extent_list_marker_t posm = 0; /* marker for extent list,
2033 if ME_MIGHT_MODIFY_EXTENTS */
2034 /* count and struct for unwind-protect, if ME_MIGHT_THROW */
2036 struct map_extents_struct closure;
2038 #ifdef ERROR_CHECK_EXTENTS
2040 assert(from >= buffer_or_string_absolute_begin_byte(obj) &&
2041 from <= buffer_or_string_absolute_end_byte(obj) &&
2042 to >= buffer_or_string_absolute_begin_byte(obj) &&
2043 to <= buffer_or_string_absolute_end_byte(obj));
2047 assert(EQ(obj, extent_object(after)));
2048 assert(!extent_detached_p(after));
2051 el = buffer_or_string_extent_list(obj);
2052 if (!el || !extent_list_num_els(el))
2056 st = buffer_or_string_bytind_to_memind(obj, from);
2057 en = buffer_or_string_bytind_to_memind(obj, to);
2059 if (flags & ME_MIGHT_MODIFY_TEXT) {
2060 /* The mapping function might change the text in the buffer,
2061 so make an internal extent to hold the range we're mapping
2063 range = make_extent_detached(obj);
2064 set_extent_start(range, st);
2065 set_extent_end(range, en);
2066 range->flags.start_open = flags & ME_START_OPEN;
2067 range->flags.end_open = !(flags & ME_END_CLOSED);
2068 range->flags.internal = 1;
2069 range->flags.detachable = 0;
2070 extent_attach(range);
2073 if (flags & ME_MIGHT_THROW) {
2074 /* The mapping function might throw past us so we need to use an
2075 unwind_protect() to eliminate the internal extent and range
2077 count = specpdl_depth();
2078 closure.range = range;
2080 record_unwind_protect(map_extents_unwind,
2081 make_opaque_ptr(&closure));
2084 /* ---------- Figure out where we start and what direction
2085 we move in. This is the trickiest part of this
2086 function. ---------- */
2088 /* If ME_START_IN_REGION, ME_END_IN_REGION or ME_START_AND_END_IN_REGION
2089 was specified and ME_NEGATE_IN_REGION was not specified, our job
2090 is simple because of the presence of the display order and e-order.
2091 (Note that theoretically do something similar for
2092 ME_START_OR_END_IN_REGION, but that would require more trickiness
2093 than it's worth to avoid hitting the same extent twice.)
2095 In the general case, all the extents that overlap a range can be
2096 divided into two classes: those whose start position lies within
2097 the range (including the range's end but not including the
2098 range's start), and those that overlap the start position,
2099 i.e. those in the SOE for the start position. Or equivalently,
2100 the extents can be divided into those whose end position lies
2101 within the range and those in the SOE for the end position. Note
2102 that for this purpose we treat both the range and all extents in
2103 the buffer as closed on both ends. If this is not what the ME_
2104 flags specified, then we've mapped over a few too many extents,
2105 but no big deal because extent_in_region_p() will filter them
2106 out. Ideally, we could move the SOE to the closer of the range's
2107 two ends and work forwards or backwards from there. However, in
2108 order to make the semantics of the AFTER argument work out, we
2109 have to always go in the same direction; so we choose to always
2110 move the SOE to the start position.
2112 When it comes time to do the SOE stage, we first call soe_move()
2113 so that the SOE gets set up. Note that the SOE might get
2114 changed while we are mapping over its contents. If we can
2115 guarantee that the SOE won't get moved to a new position, we
2116 simply need to put a marker in the SOE and we will track deletions
2117 and insertions of extents in the SOE. If the SOE might get moved,
2118 however (this would happen as a result of a recursive invocation
2119 of map-extents or a call to a redisplay-type function), then
2120 trying to track its changes is hopeless, so we just keep a
2121 marker to the first (or last) extent in the SOE and use that as
2124 Finally, if DONT_USE_SOE is defined, we don't use the SOE at all
2125 and instead just map from the beginning of the buffer. This is
2126 used for testing purposes and allows the SOE to be calculated
2127 using map_extents() instead of the other way around. */
2130 int range_flag; /* ME_*_IN_REGION subset of flags */
2131 int do_soe_stage = 0; /* Are we mapping over the SOE? */
2132 /* Does the range stage map over start or end positions? */
2134 /* If type == 0, we include the start position in the range
2136 If type == 1, we exclude the start position in the range
2138 If type == 2, we begin at range_start_pos, an extent-list
2141 int range_start_type = 0;
2142 int range_start_pos = 0;
2145 range_flag = flags & ME_IN_REGION_MASK;
2146 if ((range_flag == ME_START_IN_REGION ||
2147 range_flag == ME_START_AND_END_IN_REGION) &&
2148 !(flags & ME_NEGATE_IN_REGION)) {
2149 /* map over start position in [range-start, range-end].
2152 } else if (range_flag == ME_END_IN_REGION
2153 && !(flags & ME_NEGATE_IN_REGION)) {
2154 /* map over end position in [range-start, range-end].
2158 /* Need to include the SOE extents. */
2160 /* Just brute-force it: start from the beginning. */
2162 range_start_type = 2;
2163 range_start_pos = 0;
2165 extent_stack_t soe =
2166 buffer_or_string_stack_of_extents_force(obj);
2169 /* Move the SOE to the closer end of the range. This
2170 dictates whether we map over start positions or end
2174 numsoe = extent_list_num_els(soe->extents);
2176 if (flags & ME_MIGHT_MOVE_SOE) {
2178 /* Can't map over SOE, so just extend
2179 range to cover the SOE. */
2180 EXTENT e = extent_list_at(
2181 soe->extents, 0, 0);
2182 range_start_pos = extent_list_locate
2183 (buffer_or_string_extent_list
2184 (obj), e, 0, &foundp);
2186 range_start_type = 2;
2188 /* We can map over the SOE. */
2190 range_start_type = 1;
2193 /* No extents in the SOE to map over, so we act
2194 just as if ME_START_IN_REGION or
2195 ME_END_IN_REGION was specified. RANGE_ENDP
2196 already specified so no need to do anything
2202 /* ---------- Now loop over the extents. ---------- */
2204 /* We combine the code for the two stages because much of it
2206 for (stage = 0; stage < 2; stage++) {
2207 int pos = 0; /* Position in extent list */
2209 /* First set up start conditions */
2210 if (stage == 0) { /* The SOE stage */
2213 el = buffer_or_string_stack_of_extents_force
2215 /* We will always be looping over start extents
2217 assert(!range_endp);
2219 } else { /* The range stage */
2220 el = buffer_or_string_extent_list(obj);
2221 switch (range_start_type) {
2223 pos = extent_list_locate_from_pos
2224 (el, st, range_endp);
2227 pos = extent_list_locate_from_pos
2228 (el, st + 1, range_endp);
2231 pos = range_start_pos;
2238 if (flags & ME_MIGHT_MODIFY_EXTENTS) {
2239 /* Create a marker to track changes to the
2242 /* Delete the marker used in the SOE
2244 extent_list_delete_marker
2245 (buffer_or_string_stack_of_extents_force
2246 (obj)->extents, posm);
2247 posm = extent_list_make_marker(
2248 el, pos, range_endp);
2249 /* tell the unwind function about the marker. */
2259 /* ----- update position in extent list
2260 and fetch next extent ----- */
2263 /* fetch POS again to track extent
2264 insertions or deletions */
2265 pos = extent_list_marker_pos(el, posm);
2267 if (pos >= extent_list_num_els(el)) {
2270 e = extent_list_at(el, pos, range_endp);
2273 /* now point the marker to the next one
2274 we're going to process. This ensures
2275 graceful behavior if this extent is
2277 extent_list_move_marker(el, posm, pos);
2279 /* ----- deal with internal extents ----- */
2281 if (extent_internal_p(e)) {
2282 if (!(flags & ME_INCLUDE_INTERNAL)) {
2284 } else if (e == range) {
2285 /* We're processing internal
2286 extents and we've come across
2287 our own special range extent.
2288 (This happens only in
2289 adjust_extents*() and
2290 process_extents*(), which
2291 handle text insertion and
2292 deletion.) We need to omit
2293 processing of this extent;
2294 otherwise we will probably
2296 terminating this loop. */
2301 /* ----- deal with AFTER condition ----- */
2304 /* if e > after, then we can stop
2305 skipping extents. */
2306 if (EXTENT_LESS(after, e)) {
2309 /* otherwise, skip this
2315 /* ----- stop if we're completely outside the
2318 /* fetch ST and EN again to track text
2319 insertions or deletions */
2321 st = extent_start(range);
2322 en = extent_end(range);
2324 if (extent_endpoint(e, range_endp) > en) {
2325 /* Can't be mapping over SOE because all
2326 extents in there should overlap ST */
2331 /* ----- Now actually call the function ----- */
2333 obj2 = extent_object(e);
2334 if (extent_in_region_p(
2336 buffer_or_string_memind_to_bytind
2338 buffer_or_string_memind_to_bytind
2339 (obj2, en), flags)) {
2340 if ((*fn) (e, arg)) {
2341 /* Function wants us to stop
2344 /* so outer for loop will
2351 /* ---------- Finished looping. ---------- */
2354 if (flags & ME_MIGHT_THROW) {
2355 /* This deletes the range extent and frees the marker. */
2356 unbind_to(count, Qnil);
2358 /* Delete them ourselves */
2360 extent_detach(range);
2363 extent_list_delete_marker(el, posm);
2369 map_extents(Bufpos from, Bufpos to, map_extents_fun fn,
2370 void *arg, Lisp_Object obj, EXTENT after, unsigned int flags)
2372 map_extents_bytind(buffer_or_string_bufpos_to_bytind(obj, from),
2373 buffer_or_string_bufpos_to_bytind(obj, to), fn, arg,
2377 /* ------------------------------- */
2378 /* adjust_extents() */
2379 /* ------------------------------- */
2381 /* Add AMOUNT to all extent endpoints in the range (FROM, TO]. This
2382 happens whenever the gap is moved or (under Mule) a character in a
2383 string is substituted for a different-length one. The reason for
2384 this is that extent endpoints behave just like markers (all memory
2385 indices do) and this adjustment correct for markers -- see
2386 adjust_markers(). Note that it is important that we visit all
2387 extent endpoints in the range, irrespective of whether the
2388 endpoints are open or closed.
2390 We could use map_extents() for this (and in fact the function
2391 was originally written that way), but the gap is in an incoherent
2392 state when this function is called and this function plays
2393 around with extent endpoints without detaching and reattaching
2394 the extents (this is provably correct and saves lots of time),
2395 so for safety we make it just look at the extent lists directly. */
2398 adjust_extents(Lisp_Object obj, Memind from, Memind to, int amount)
2406 #ifdef ERROR_CHECK_EXTENTS
2407 sledgehammer_extent_check(obj);
2409 el = buffer_or_string_extent_list(obj);
2411 if (!el || !extent_list_num_els(el)) {
2414 /* IMPORTANT! Compute the starting positions of the extents to
2415 modify BEFORE doing any modification! Otherwise the starting
2416 position for the second time through the loop might get
2417 incorrectly calculated (I got bit by this bug real bad). */
2418 startpos[0] = extent_list_locate_from_pos(el, from + 1, 0);
2419 startpos[1] = extent_list_locate_from_pos(el, from + 1, 1);
2420 for (endp = 0; endp < 2; endp++) {
2421 for (pos = startpos[endp]; pos < extent_list_num_els(el);
2423 EXTENT e = extent_list_at(el, pos, endp);
2424 if (extent_endpoint(e, endp) > to) {
2427 set_extent_endpoint(
2429 do_marker_adjustment(
2430 extent_endpoint(e, endp),
2436 /* The index for the buffer's SOE is a memory index and thus
2437 needs to be adjusted like a marker. */
2438 soe = buffer_or_string_stack_of_extents(obj);
2439 if (soe && soe->pos >= 0) {
2440 soe->pos = do_marker_adjustment(soe->pos, from, to, amount);
2445 /* ------------------------------- */
2446 /* adjust_extents_for_deletion() */
2447 /* ------------------------------- */
2449 struct adjust_extents_for_deletion_arg {
2450 EXTENT_dynarr *list;
2453 static int adjust_extents_for_deletion_mapper(EXTENT extent, void *arg)
2455 struct adjust_extents_for_deletion_arg *closure =
2456 (struct adjust_extents_for_deletion_arg *)arg;
2458 Dynarr_add(closure->list, extent);
2459 /* continue mapping */
2463 /* For all extent endpoints in the range (FROM, TO], move them to the beginning
2464 of the new gap. Note that it is important that we visit all extent
2465 endpoints in the range, irrespective of whether the endpoints are open or
2468 This function deals with weird stuff such as the fact that extents
2471 There is no string correspondent for this because you can't
2472 delete characters from a string.
2476 adjust_extents_for_deletion(Lisp_Object object, Bytind from,
2477 Bytind to, int gapsize, int numdel, int movegapsize)
2479 struct adjust_extents_for_deletion_arg closure;
2481 Memind adjust_to = (Memind) (to + gapsize);
2482 Bytecount amount = -numdel - movegapsize;
2483 Memind oldsoe = 0, newsoe = 0;
2484 extent_stack_t soe = buffer_or_string_stack_of_extents(object);
2486 #ifdef ERROR_CHECK_EXTENTS
2487 sledgehammer_extent_check(object);
2489 closure.list = Dynarr_new(EXTENT);
2491 /* We're going to be playing weird games below with extents and the SOE
2492 and such, so compute the list now of all the extents that we're going
2493 to muck with. If we do the mapping and adjusting together, things
2494 can get all screwed up. */
2496 map_extents_bytind(from, to, adjust_extents_for_deletion_mapper,
2497 (void *)&closure, object, 0,
2498 /* extent endpoints move like markers regardless
2499 of their open/closeness. */
2500 ME_ALL_EXTENTS_CLOSED | ME_END_CLOSED |
2501 ME_START_OR_END_IN_REGION | ME_INCLUDE_INTERNAL);
2504 Old and new values for the SOE's position. (It gets adjusted
2505 like a marker, just like extent endpoints.)
2510 if (soe->pos >= 0) {
2511 newsoe = do_marker_adjustment(
2512 soe->pos, adjust_to, adjust_to, amount);
2518 for (i = 0; i < Dynarr_length(closure.list); i++) {
2519 EXTENT extent = Dynarr_at(closure.list, i);
2520 Memind new_start = extent_start(extent);
2521 Memind new_end = extent_end(extent);
2523 /* do_marker_adjustment() will not adjust values that should not
2524 be adjusted. We're passing the same funky arguments to
2525 do_marker_adjustment() as buffer_delete_range() does. */
2526 new_start = do_marker_adjustment(
2527 new_start, adjust_to, adjust_to, amount);
2528 new_end = do_marker_adjustment(
2529 new_end, adjust_to, adjust_to, amount);
2531 /* We need to be very careful here so that the SOE doesn't get
2532 corrupted. We are shrinking extents out of the deleted
2533 region and simultaneously moving the SOE's pos out of the
2534 deleted region, so the SOE should contain the same extents at
2535 the end as at the beginning. However, extents may get
2536 reordered by this process, so we have to operate by pulling
2537 the extents out of the buffer and SOE, changing their bounds,
2538 and then reinserting them. In order for the SOE not to get
2539 screwed up, we have to make sure that the SOE's pos points to
2540 its old location whenever we pull an extent out, and points
2541 to its new location whenever we put the extent back in.
2544 if (new_start != extent_start(extent) ||
2545 new_end != extent_end(extent)) {
2546 extent_detach(extent);
2547 set_extent_start(extent, new_start);
2548 set_extent_end(extent, new_end);
2552 extent_attach(extent);
2563 #ifdef ERROR_CHECK_EXTENTS
2564 sledgehammer_extent_check(object);
2566 Dynarr_free(closure.list);
2570 /* ------------------------------- */
2571 /* extent fragments */
2572 /* ------------------------------- */
2574 /* Imagine that the buffer is divided up into contiguous,
2575 nonoverlapping "runs" of text such that no extent
2576 starts or ends within a run (extents that abut the
2579 An extent fragment is a structure that holds data about
2580 the run that contains a particular buffer position (if
2581 the buffer position is at the junction of two runs, the
2582 run after the position is used) -- the beginning and
2583 end of the run, a list of all of the extents in that
2584 run, the "merged face" that results from merging all of
2585 the faces corresponding to those extents, the begin and
2586 end glyphs at the beginning of the run, etc. This is
2587 the information that redisplay needs in order to
2590 Extent fragments have to be very quick to update to
2591 a new buffer position when moving linearly through
2592 the buffer. They rely on the stack-of-extents code,
2593 which does the heavy-duty algorithmic work of determining
2594 which extents overly a particular position. */
2596 /* This function returns the position of the beginning of
2597 the first run that begins after POS, or returns POS if
2598 there are no such runs. */
2601 extent_find_end_of_run(Lisp_Object obj, Bytind pos, int outside_accessible)
2604 extent_list_t bel = buffer_or_string_extent_list(obj);
2607 Memind mempos = buffer_or_string_bytind_to_memind(obj, pos);
2608 Bytind limit = outside_accessible ?
2609 buffer_or_string_absolute_end_byte(obj) :
2610 buffer_or_string_accessible_end_byte(obj);
2612 if (!bel || !extent_list_num_els(bel)) {
2615 sel = buffer_or_string_stack_of_extents_force(obj)->extents;
2616 soe_move(obj, mempos);
2618 /* Find the first start position after POS. */
2619 elind1 = extent_list_locate_from_pos(bel, mempos + 1, 0);
2620 if (elind1 < extent_list_num_els(bel)) {
2621 pos1 = buffer_or_string_memind_to_bytind(
2622 obj, extent_start(extent_list_at(bel, elind1, 0)));
2627 /* Find the first end position after POS. The extent corresponding
2628 to this position is either in the SOE or is greater than or
2629 equal to POS1, so we just have to look in the SOE. */
2630 elind2 = extent_list_locate_from_pos(sel, mempos + 1, 1);
2631 if (elind2 < extent_list_num_els(sel)) {
2632 pos2 = buffer_or_string_memind_to_bytind(
2633 obj, extent_end(extent_list_at(sel, elind2, 1)));
2637 return min(min(pos1, pos2), limit);
2641 extent_find_beginning_of_run(Lisp_Object obj, Bytind pos,
2642 int outside_accessible)
2645 extent_list_t bel = buffer_or_string_extent_list(obj);
2648 Memind mempos = buffer_or_string_bytind_to_memind(obj, pos);
2649 Bytind limit = outside_accessible
2650 ? buffer_or_string_absolute_begin_byte(obj)
2651 : buffer_or_string_accessible_begin_byte(obj);
2653 if (!bel || !extent_list_num_els(bel)) {
2656 sel = buffer_or_string_stack_of_extents_force(obj)->extents;
2657 soe_move(obj, mempos);
2659 /* Find the first end position before POS. */
2660 elind1 = extent_list_locate_from_pos(bel, mempos, 1);
2662 pos1 = buffer_or_string_memind_to_bytind(
2663 obj, extent_end(extent_list_at(bel, elind1 - 1, 1)));
2667 /* Find the first start position before POS. The extent corresponding
2668 to this position is either in the SOE or is less than or
2669 equal to POS1, so we just have to look in the SOE. */
2670 elind2 = extent_list_locate_from_pos(sel, mempos, 0);
2672 pos2 = buffer_or_string_memind_to_bytind(
2673 obj, extent_start(extent_list_at(sel, elind2 - 1, 0)));
2677 return max(max(pos1, pos2), limit);
2680 struct extent_fragment*
2681 extent_fragment_new(Lisp_Object buffer_or_string, struct frame *frm)
2683 struct extent_fragment *ef = xnew_and_zero(struct extent_fragment);
2685 ef->object = buffer_or_string;
2687 ef->extents = Dynarr_new(EXTENT);
2688 ef->glyphs = Dynarr_new(glyph_block);
2693 void extent_fragment_delete(struct extent_fragment *ef)
2695 Dynarr_free(ef->extents);
2696 Dynarr_free(ef->glyphs);
2701 extent_priority_sort_function(const void *humpty, const void *dumpty)
2703 const EXTENT foo = *(const EXTENT *)humpty;
2704 const EXTENT bar = *(const EXTENT *)dumpty;
2705 if (extent_priority(foo) < extent_priority(bar)) {
2708 return extent_priority(foo) > extent_priority(bar);
2712 extent_fragment_sort_by_priority(EXTENT_dynarr * extarr)
2716 /* Sort our copy of the stack by extent_priority. We use a bubble
2717 sort here because it's going to be faster than qsort() for small
2718 numbers of extents (less than 10 or so), and 99.999% of the time
2719 there won't ever be more extents than this in the stack. */
2720 if (Dynarr_length(extarr) < 10) {
2721 for (i = 1; i < Dynarr_length(extarr); i++) {
2724 (extent_priority(Dynarr_at(extarr, j)) >
2725 extent_priority(Dynarr_at(extarr, j + 1)))) {
2726 EXTENT tmp = Dynarr_at(extarr, j);
2727 Dynarr_at(extarr, j) = Dynarr_at(extarr, j + 1);
2728 Dynarr_at(extarr, j + 1) = tmp;
2733 /* But some loser programs mess up and may create a large number
2734 of extents overlapping the same spot. This will result in
2735 catastrophic behavior if we use the bubble sort above. */
2736 qsort(Dynarr_atp(extarr, 0), Dynarr_length(extarr),
2737 sizeof(EXTENT), extent_priority_sort_function);
2741 /* If PROP is the `invisible' property of an extent,
2742 this is 1 if the extent should be treated as invisible. */
2744 #define EXTENT_PROP_MEANS_INVISIBLE(buf, prop) \
2745 (EQ (buf->invisibility_spec, Qt) \
2747 : invisible_p (prop, buf->invisibility_spec))
2749 /* If PROP is the `invisible' property of a extent,
2750 this is 1 if the extent should be treated as invisible
2751 and should have an ellipsis. */
2753 #define EXTENT_PROP_MEANS_INVISIBLE_WITH_ELLIPSIS(buf, prop) \
2754 (EQ (buf->invisibility_spec, Qt) \
2756 : invisible_ellipsis_p (prop, buf->invisibility_spec))
2758 /* This is like a combination of memq and assq.
2759 Return 1 if PROPVAL appears as an element of LIST
2760 or as the car of an element of LIST.
2761 If PROPVAL is a list, compare each element against LIST
2762 in that way, and return 1 if any element of PROPVAL is found in LIST.
2764 This function cannot quit. */
2767 invisible_p(REGISTER Lisp_Object propval, Lisp_Object list)
2769 REGISTER Lisp_Object tail, proptail;
2770 for (tail = list; CONSP(tail); tail = XCDR(tail)) {
2771 REGISTER Lisp_Object tem;
2773 if (EQ(propval, tem))
2775 if (CONSP(tem) && EQ(propval, XCAR(tem)))
2778 if (CONSP(propval)) {
2779 for (proptail = propval; CONSP(proptail);
2780 proptail = XCDR(proptail)) {
2781 Lisp_Object propelt;
2782 propelt = XCAR(proptail);
2783 for (tail = list; CONSP(tail); tail = XCDR(tail)) {
2784 REGISTER Lisp_Object tem;
2786 if (EQ(propelt, tem)) {
2789 if (CONSP(tem) && EQ(propelt, XCAR(tem))) {
2798 /* Return 1 if PROPVAL appears as the car of an element of LIST
2799 and the cdr of that element is non-nil.
2800 If PROPVAL is a list, check each element of PROPVAL in that way,
2801 and the first time some element is found,
2802 return 1 if the cdr of that element is non-nil.
2804 This function cannot quit. */
2807 invisible_ellipsis_p(REGISTER Lisp_Object propval, Lisp_Object list)
2809 REGISTER Lisp_Object tail, proptail;
2811 for (tail = list; CONSP(tail); tail = XCDR(tail)) {
2812 REGISTER Lisp_Object tem;
2814 if (CONSP(tem) && EQ(propval, XCAR(tem))) {
2815 return !NILP(XCDR(tem));
2818 if (CONSP(propval)) {
2819 for (proptail = propval; CONSP(proptail);
2820 proptail = XCDR(proptail)) {
2821 Lisp_Object propelt;
2822 propelt = XCAR(proptail);
2823 for (tail = list; CONSP(tail); tail = XCDR(tail)) {
2824 REGISTER Lisp_Object tem;
2826 if (CONSP(tem) && EQ(propelt, XCAR(tem))) {
2827 return !NILP(XCDR(tem));
2836 extent_fragment_update(struct window * w, struct extent_fragment * ef,
2837 Bytind pos, Lisp_Object last_glyph)
2840 int seen_glyph = NILP(last_glyph) ? 1 : 0;
2842 buffer_or_string_stack_of_extents_force(ef->object)->extents;
2844 struct extent dummy_lhe_extent;
2845 Memind mempos = buffer_or_string_bytind_to_memind(ef->object, pos);
2846 glyph_block_dynarr *glyphs; /* List of glyphs to post process */
2847 int invis_before = 0; /* Exiting an invisible extent. */
2848 int invis_after = 0; /* Entering an invisible extent. */
2849 int insert_empty = 0; /* Position to insert empty extent glyphs */
2850 int queuing_begin = 0; /* Queuing begin glyphs. */
2852 #ifdef ERROR_CHECK_EXTENTS
2853 assert(pos >= buffer_or_string_accessible_begin_byte(ef->object)
2854 && pos <= buffer_or_string_accessible_end_byte(ef->object));
2857 Dynarr_reset(ef->extents);
2858 Dynarr_reset(ef->glyphs);
2860 ef->previously_invisible = ef->invisible;
2861 if (ef->invisible) {
2862 if (ef->invisible_ellipses)
2863 ef->invisible_ellipses_already_displayed = 1;
2865 ef->invisible_ellipses_already_displayed = 0;
2868 ef->invisible_ellipses = 0;
2870 /* Set up the begin and end positions. */
2872 ef->end = extent_find_end_of_run(ef->object, pos, 0);
2874 /* Note that extent_find_end_of_run() already moved the SOE for us. */
2875 /* soe_move (ef->object, mempos); */
2877 /* We tried determining all the charsets used in the run here,
2878 but that fails even if we only do the current line -- display
2879 tables or non-printable characters might cause other charsets
2882 /* Determine whether the last-highlighted-extent is present. */
2883 if (EXTENTP(Vlast_highlighted_extent))
2884 lhe = XEXTENT(Vlast_highlighted_extent);
2886 /* Now add all extents that overlap the character after POS and
2887 have a non-nil face. Also check if the character is
2888 invisible. We also queue begin and end glyphs of extents
2889 that being/end at just before POS. These are ordered as
2890 follows. 1) end glyphs of non-empty extents in reverse
2891 display order. 2) begin glyphs of empty extents. 3) end
2892 glyphs of empty extents. 4) begin glyphs of non-empty
2893 extents in display order. Empty extents are shown nested,
2894 but the invisibility property of an empty extent is
2895 ignored and not used to determine whether an 'interior'
2896 empty extent's glyphs should be shown or not. */
2897 glyphs = Dynarr_new(glyph_block);
2898 for (i = 0; i < extent_list_num_els(sel); i++) {
2899 EXTENT e = extent_list_at(sel, i, 0);
2900 int zero_width = extent_start(e) == extent_end(e);
2901 Lisp_Object invis_prop = extent_invisible(e);
2904 if (extent_start(e) == mempos) {
2905 /* The extent starts here. If we are queuing
2906 end glyphs, we should display all the end
2907 glyphs we've pushed. */
2909 if (!queuing_begin) {
2910 /* Append any already seen end glyphs */
2911 for (j = Dynarr_length(glyphs); j--;) {
2912 struct glyph_block *gbp
2913 = Dynarr_atp(glyphs, j);
2916 Dynarr_add(ef->glyphs, *gbp);
2917 else if (EQ(gbp->glyph, last_glyph))
2921 /* Pop the end glyphs just displayed. */
2922 Dynarr_set_size(glyphs, 0);
2923 /* We are now queuing begin glyphs. */
2925 /* And will insert empty extent glyphs
2927 insert_empty = Dynarr_length (ef->glyphs);
2930 glyph = extent_begin_glyph(e);
2933 struct glyph_block gb;
2936 gb.active = 0; /* BEGIN_GLYPH */
2937 XSETEXTENT(gb.extent, e);
2941 == Dynarr_length (ef->glyphs))
2942 Dynarr_add (ef->glyphs, gb);
2947 } else if (!invis_after)
2948 Dynarr_add (glyphs, gb);
2952 if (extent_end(e) == mempos) {
2953 /* The extend ends here. Push the end glyph. */
2954 glyph = extent_end_glyph(e);
2956 if (!NILP (glyph)) {
2957 struct glyph_block gb;
2959 gb.width = gb.findex = 0; /* just init */
2961 gb.active = 1; /* END_GLYPH */
2962 XSETEXTENT(gb.extent, e);
2965 Dynarr_add (ef->glyphs, gb);
2966 else if (!invis_before)
2967 Dynarr_add(glyphs, gb);
2969 /* If this extent is not empty, any inner
2970 extents ending here will not be visible. */
2971 if (extent_start (e) < mempos && !NILP (invis_prop))
2975 if (extent_end(e) > mempos) {
2976 /* This extent covers POS. */
2977 if (!NILP(invis_prop)) {
2979 /* If this extend spans POS, all
2980 glyphs are invisible. */
2981 if (extent_start (e) < mempos)
2982 Dynarr_set_size (glyphs, 0);
2984 if (!BUFFERP(ef->object))
2985 /* #### no `string-invisibility-spec' */
2989 invisible_ellipses_already_displayed
2991 EXTENT_PROP_MEANS_INVISIBLE_WITH_ELLIPSIS
2992 (XBUFFER(ef->object), invis_prop)) {
2994 ef->invisible_ellipses = 1;
2995 } else if (EXTENT_PROP_MEANS_INVISIBLE
2996 (XBUFFER(ef->object),
3002 /* Remember that one of the extents in the list might be
3003 our dummy extent representing the highlighting that
3004 is attached to some other extent that is currently
3005 mouse-highlighted. When an extent is
3006 mouse-highlighted, it is as if there are two extents
3007 there, of potentially different priorities: the
3008 extent being highlighted, with whatever face and
3009 priority it has; and an ephemeral extent in the
3010 `mouse-face' face with `mouse-highlight-priority'.
3013 if (!NILP(extent_face(e)))
3014 Dynarr_add(ef->extents, e);
3017 /* zeroing isn't really necessary; we only deref
3018 `priority' and `face' */
3019 xzero(dummy_lhe_extent);
3020 set_extent_priority(&dummy_lhe_extent,
3021 mouse_highlight_priority);
3022 /* Need to break up the following expression,
3024 /* error in the Digital UNIX 3.2g C compiler
3026 /* UNIX Compiler Driver 3.11). */
3027 f = extent_mouse_face(lhe);
3028 extent_face(&dummy_lhe_extent) = f;
3029 Dynarr_add(ef->extents, &dummy_lhe_extent);
3031 /* since we are looping anyway, we might as well do this
3033 if ((!NILP(extent_initial_redisplay_function(e))) &&
3034 !extent_in_red_event_p(e)) {
3035 Lisp_Object function =
3036 extent_initial_redisplay_function(e);
3039 /* print_extent_2 (e);
3042 /* FIXME: One should probably inhibit the
3043 displaying of this extent to reduce
3045 extent_in_red_event_p(e) = 1;
3047 /* call the function */
3049 if (!NILP(function)) {
3050 Fenqueue_eval_event(function, obj);
3056 if (!queuing_begin) {
3057 /* Append end glyphs in reverse order */
3058 for (j = Dynarr_length(glyphs); j--;) {
3059 struct glyph_block *gbp = Dynarr_atp(glyphs, j);
3062 Dynarr_add(ef->glyphs, *gbp);
3063 else if (EQ(gbp->glyph, last_glyph))
3068 /* Scan the zero length glyphs and see where we
3069 start a glyph that has not been displayed yet. */
3070 for (j = insert_empty;
3071 j != Dynarr_length (ef->glyphs); j++) {
3072 struct glyph_block *gbp
3073 = Dynarr_atp(ef->glyphs, j);
3075 if (EQ(gbp->glyph, last_glyph)) {
3081 Dynarr_delete_many (ef->glyphs, insert_empty,
3085 /* Now copy the begin glyphs. */
3086 for (j = 0; j != Dynarr_length (glyphs); j++) {
3087 struct glyph_block *gbp = Dynarr_atp(glyphs, j);
3090 Dynarr_add(ef->glyphs, *gbp);
3091 else if (EQ(gbp->glyph, last_glyph))
3096 Dynarr_free(glyphs);
3098 extent_fragment_sort_by_priority(ef->extents);
3100 /* Now merge the faces together into a single face. The code to
3101 do this is in faces.c because it involves manipulating faces. */
3102 return get_extent_fragment_face_cache_index(w, ef);
3105 /************************************************************************/
3106 /* extent-object methods */
3107 /************************************************************************/
3109 /* These are the basic helper functions for handling the allocation of
3110 extent objects. They are similar to the functions for other
3111 lrecord objects. allocate_extent() is in alloc.c, not here. */
3113 static Lisp_Object mark_extent(Lisp_Object obj)
3115 struct extent *extent = XEXTENT(obj);
3117 mark_object(extent_object(extent));
3118 mark_object(extent_no_chase_normal_field(extent, face));
3119 return extent->plist;
3123 print_extent_1(Lisp_Object obj, Lisp_Object printcharfun, int escapeflag)
3125 EXTENT ext = XEXTENT(obj);
3126 EXTENT anc = extent_ancestor(ext);
3128 char buf[100], *bp = buf;
3130 /* Retrieve the ancestor and use it, for faster retrieval of properties */
3132 if (!NILP(extent_begin_glyph(anc)))
3134 *bp++ = (extent_start_open_p(anc) ? '(' : '[');
3135 if (extent_detached_p(ext))
3136 strcpy(bp, "detached");
3138 sprintf(bp, "%ld, %ld",
3139 XINT(Fextent_start_position(obj)),
3140 XINT(Fextent_end_position(obj)));
3142 *bp++ = (extent_end_open_p(anc) ? ')' : ']');
3143 if (!NILP(extent_end_glyph(anc)))
3147 if (!NILP(extent_read_only(anc)))
3149 if (!NILP(extent_mouse_face(anc)))
3151 if (extent_unique_p(anc))
3153 else if (extent_duplicable_p(anc))
3155 if (!NILP(extent_invisible(anc)))
3158 if (!NILP(extent_read_only(anc)) || !NILP(extent_mouse_face(anc)) ||
3159 extent_unique_p(anc) ||
3160 extent_duplicable_p(anc) || !NILP(extent_invisible(anc)))
3163 write_c_string(buf, printcharfun);
3165 tail = extent_plist_slot(anc);
3167 for (; !NILP(tail); tail = Fcdr(Fcdr(tail))) {
3168 Lisp_Object v = XCAR(XCDR(tail));
3171 print_internal(XCAR(tail), printcharfun, escapeflag);
3172 write_c_string(" ", printcharfun);
3175 sprintf(buf, "0x%lx", (long)ext);
3176 write_c_string(buf, printcharfun);
3180 print_extent(Lisp_Object obj, Lisp_Object printcharfun, int escapeflag)
3183 const char *title = "";
3184 const char *name = "";
3185 const char *posttitle = "";
3186 Lisp_Object obj2 = Qnil;
3188 /* Destroyed extents have 't' in the object field, causing
3189 extent_object() to abort (maybe). */
3190 if (EXTENT_LIVE_P(XEXTENT(obj)))
3191 obj2 = extent_object(XEXTENT(obj));
3194 title = "no buffer";
3195 else if (BUFFERP(obj2)) {
3196 if (BUFFER_LIVE_P(XBUFFER(obj2))) {
3199 (char *)XSTRING_DATA(XBUFFER(obj2)->name);
3201 title = "Killed Buffer";
3205 assert(STRINGP(obj2));
3206 title = "string \"";
3208 name = (char *)XSTRING_DATA(obj2);
3211 if (print_readably) {
3212 if (!EXTENT_LIVE_P(XEXTENT(obj))) {
3213 error("printing unreadable object "
3214 "#<destroyed extent>");
3216 error("printing unreadable object "
3217 "#<extent %p>", XEXTENT(obj));
3221 if (!EXTENT_LIVE_P(XEXTENT(obj))) {
3222 write_c_string("#<destroyed extent", printcharfun);
3225 size_t bufsz = strlen(title) + strlen(name) +
3226 strlen(posttitle) + 1;
3229 write_c_string("#<extent ", printcharfun);
3230 print_extent_1(obj, printcharfun, escapeflag);
3231 write_c_string(extent_detached_p(XEXTENT(obj))
3232 ? " from " : " in ", printcharfun);
3233 snprintf(buf, bufsz, "%s%s%s", title, name, posttitle);
3234 write_c_string(buf, printcharfun);
3238 error("printing unreadable object #<extent>");
3239 write_c_string("#<extent", printcharfun);
3241 write_c_string(">", printcharfun);
3244 static int properties_equal(EXTENT e1, EXTENT e2, int depth)
3246 /* When this function is called, all indirections have been followed.
3247 Thus, the indirection checks in the various macros below will not
3248 amount to anything, and could be removed. However, the time
3249 savings would probably not be significant. */
3250 if (!(EQ(extent_face(e1), extent_face(e2)) &&
3251 extent_priority(e1) == extent_priority(e2) &&
3252 internal_equal(extent_begin_glyph(e1), extent_begin_glyph(e2),
3254 internal_equal(extent_end_glyph(e1), extent_end_glyph(e2),
3258 /* compare the bit flags. */
3260 /* The has_aux field should not be relevant. */
3261 int e1_has_aux = e1->flags.has_aux;
3262 int e2_has_aux = e2->flags.has_aux;
3265 e1->flags.has_aux = e2->flags.has_aux = 0;
3266 value = memcmp(&e1->flags, &e2->flags, sizeof(e1->flags));
3267 e1->flags.has_aux = e1_has_aux;
3268 e2->flags.has_aux = e2_has_aux;
3273 /* compare the random elements of the plists. */
3274 return !plists_differ(extent_no_chase_plist(e1),
3275 extent_no_chase_plist(e2), 0, 0, depth + 1);
3278 static int extent_equal(Lisp_Object obj1, Lisp_Object obj2, int depth)
3280 struct extent *e1 = XEXTENT(obj1);
3281 struct extent *e2 = XEXTENT(obj2);
3283 (extent_start(e1) == extent_start(e2) &&
3284 extent_end(e1) == extent_end(e2) &&
3285 internal_equal(extent_object(e1), extent_object(e2), depth + 1) &&
3286 properties_equal(extent_ancestor(e1), extent_ancestor(e2), depth));
3289 static unsigned long extent_hash(Lisp_Object obj, int depth)
3291 struct extent *e = XEXTENT(obj);
3292 /* No need to hash all of the elements; that would take too long.
3293 Just hash the most common ones. */
3294 return HASH3(extent_start(e), extent_end(e),
3295 internal_hash(extent_object(e), depth + 1));
3298 static const struct lrecord_description extent_description[] = {
3299 {XD_LISP_OBJECT, offsetof(struct extent, object)},
3300 {XD_LISP_OBJECT, offsetof(struct extent, flags.face)},
3301 {XD_LISP_OBJECT, offsetof(struct extent, plist)},
3305 static Lisp_Object extent_getprop(Lisp_Object obj, Lisp_Object prop)
3307 return Fextent_property(obj, prop, Qunbound);
3310 static int extent_putprop(Lisp_Object obj, Lisp_Object prop, Lisp_Object value)
3312 Fset_extent_property(obj, prop, value);
3316 static int extent_remprop(Lisp_Object obj, Lisp_Object prop)
3318 EXTENT ext = XEXTENT(obj);
3320 /* This list is taken from Fset_extent_property, and should be kept
3322 if (EQ(prop, Qread_only)
3323 || EQ(prop, Qunique)
3324 || EQ(prop, Qduplicable)
3325 || EQ(prop, Qinvisible)
3326 || EQ(prop, Qdetachable)
3327 || EQ(prop, Qdetached)
3328 || EQ(prop, Qdestroyed)
3329 || EQ(prop, Qpriority)
3331 || EQ(prop, Qinitial_redisplay_function)
3332 || EQ(prop, Qafter_change_functions)
3333 || EQ(prop, Qbefore_change_functions)
3334 || EQ(prop, Qmouse_face)
3335 || EQ(prop, Qhighlight)
3336 || EQ(prop, Qbegin_glyph_layout)
3337 || EQ(prop, Qend_glyph_layout)
3338 || EQ(prop, Qglyph_layout)
3339 || EQ(prop, Qbegin_glyph)
3340 || EQ(prop, Qend_glyph)
3341 || EQ(prop, Qstart_open)
3342 || EQ(prop, Qend_open)
3343 || EQ(prop, Qstart_closed)
3344 || EQ(prop, Qend_closed)
3345 || EQ(prop, Qkeymap)) {
3346 /* #### Is this correct, anyway? */
3350 return external_remprop(extent_plist_addr(ext), prop, 0, ERROR_ME);
3353 static Lisp_Object extent_plist(Lisp_Object obj)
3355 return Fextent_properties(obj);
3358 DEFINE_BASIC_LRECORD_IMPLEMENTATION_WITH_PROPS("extent", extent,
3359 mark_extent, print_extent,
3360 /* NOTE: If you declare a
3361 finalization method here,
3362 it will NOT be called.
3365 extent_equal, extent_hash,
3367 extent_getprop, extent_putprop,
3368 extent_remprop, extent_plist,
3371 /************************************************************************/
3372 /* basic extent accessors */
3373 /************************************************************************/
3375 /* These functions are for checking externally-passed extent objects
3376 and returning an extent's basic properties, which include the
3377 buffer the extent is associated with, the endpoints of the extent's
3378 range, the open/closed-ness of those endpoints, and whether the
3379 extent is detached. Manipulating these properties requires
3380 manipulating the ordered lists that hold extents; thus, functions
3381 to do that are in a later section. */
3383 /* Given a Lisp_Object that is supposed to be an extent, make sure it
3384 is OK and return an extent pointer. Extents can be in one of four
3388 2) detached and not associated with a buffer
3389 3) detached and associated with a buffer
3390 4) attached to a buffer
3392 If FLAGS is 0, types 2-4 are allowed. If FLAGS is DE_MUST_HAVE_BUFFER,
3393 types 3-4 are allowed. If FLAGS is DE_MUST_BE_ATTACHED, only type 4
3397 static EXTENT decode_extent(Lisp_Object extent_obj, unsigned int flags)
3402 CHECK_LIVE_EXTENT(extent_obj);
3403 extent = XEXTENT(extent_obj);
3404 obj = extent_object(extent);
3406 /* the following condition will fail if we're dealing with a freed extent */
3407 assert(NILP(obj) || BUFFERP(obj) || STRINGP(obj));
3409 if (flags & DE_MUST_BE_ATTACHED)
3410 flags |= DE_MUST_HAVE_BUFFER;
3412 /* if buffer is dead, then convert extent to have no buffer. */
3413 if (BUFFERP(obj) && !BUFFER_LIVE_P(XBUFFER(obj)))
3414 obj = extent_object(extent) = Qnil;
3416 assert(!NILP(obj) || extent_detached_p(extent));
3418 if ((NILP(obj) && (flags & DE_MUST_HAVE_BUFFER))
3419 || (extent_detached_p(extent) && (flags & DE_MUST_BE_ATTACHED))) {
3420 invalid_argument("extent doesn't belong to a buffer or string",
3427 /* Note that the returned value is a buffer position, not a byte index. */
3429 static Lisp_Object extent_endpoint_external(Lisp_Object extent_obj, int endp)
3431 EXTENT extent = decode_extent(extent_obj, 0);
3433 if (extent_detached_p(extent))
3436 return make_int(extent_endpoint_bufpos(extent, endp));
3439 DEFUN("extentp", Fextentp, 1, 1, 0, /*
3440 Return t if OBJECT is an extent.
3444 return EXTENTP(object) ? Qt : Qnil;
3447 DEFUN("extent-live-p", Fextent_live_p, 1, 1, 0, /*
3448 Return t if OBJECT is an extent that has not been destroyed.
3452 return EXTENTP(object) && EXTENT_LIVE_P(XEXTENT(object)) ? Qt : Qnil;
3455 DEFUN("extent-detached-p", Fextent_detached_p, 1, 1, 0, /*
3456 Return t if EXTENT is detached.
3460 return extent_detached_p(decode_extent(extent, 0)) ? Qt : Qnil;
3463 DEFUN("extent-object", Fextent_object, 1, 1, 0, /*
3464 Return object (buffer or string) that EXTENT refers to.
3468 return extent_object(decode_extent(extent, 0));
3471 DEFUN("extent-start-position", Fextent_start_position, 1, 1, 0, /*
3472 Return start position of EXTENT, or nil if EXTENT is detached.
3476 return extent_endpoint_external(extent, 0);
3479 DEFUN("extent-end-position", Fextent_end_position, 1, 1, 0, /*
3480 Return end position of EXTENT, or nil if EXTENT is detached.
3484 return extent_endpoint_external(extent, 1);
3487 DEFUN("extent-length", Fextent_length, 1, 1, 0, /*
3488 Return length of EXTENT in characters.
3492 EXTENT e = decode_extent(extent, DE_MUST_BE_ATTACHED);
3493 return make_int(extent_endpoint_bufpos(e, 1)
3494 - extent_endpoint_bufpos(e, 0));
3497 DEFUN("next-extent", Fnext_extent, 1, 1, 0, /*
3498 Find next extent after EXTENT.
3499 If EXTENT is a buffer return the first extent in the buffer; likewise
3501 Extents in a buffer are ordered in what is called the "display"
3502 order, which sorts by increasing start positions and then by *decreasing*
3504 If you want to perform an operation on a series of extents, use
3505 `map-extents' instead of this function; it is much more efficient.
3506 The primary use of this function should be to enumerate all the
3507 extents in a buffer.
3508 Note: The display order is not necessarily the order that `map-extents'
3509 processes extents in!
3516 if (EXTENTP(extent))
3517 next = extent_next(decode_extent(extent, DE_MUST_BE_ATTACHED));
3519 next = extent_first(decode_buffer_or_string(extent));
3523 XSETEXTENT(val, next);
3527 DEFUN("previous-extent", Fprevious_extent, 1, 1, 0, /*
3528 Find last extent before EXTENT.
3529 If EXTENT is a buffer return the last extent in the buffer; likewise
3531 This function is analogous to `next-extent'.
3538 if (EXTENTP(extent))
3540 extent_previous(decode_extent(extent, DE_MUST_BE_ATTACHED));
3542 prev = extent_last(decode_buffer_or_string(extent));
3546 XSETEXTENT(val, prev);
3550 #ifdef DEBUG_SXEMACS
3552 DEFUN("next-e-extent", Fnext_e_extent, 1, 1, 0, /*
3553 Find next extent after EXTENT using the "e" order.
3554 If EXTENT is a buffer return the first extent in the buffer; likewise
3562 if (EXTENTP(extent))
3564 extent_e_next(decode_extent(extent, DE_MUST_BE_ATTACHED));
3566 next = extent_e_first(decode_buffer_or_string(extent));
3570 XSETEXTENT(val, next);
3574 DEFUN("previous-e-extent", Fprevious_e_extent, 1, 1, 0, /*
3575 Find last extent before EXTENT using the "e" order.
3576 If EXTENT is a buffer return the last extent in the buffer; likewise
3578 This function is analogous to `next-e-extent'.
3585 if (EXTENTP(extent))
3587 extent_e_previous(decode_extent
3588 (extent, DE_MUST_BE_ATTACHED));
3590 prev = extent_e_last(decode_buffer_or_string(extent));
3594 XSETEXTENT(val, prev);
3600 DEFUN("next-extent-change", Fnext_extent_change, 1, 2, 0, /*
3601 Return the next position after POS where an extent begins or ends.
3602 If POS is at the end of the buffer or string, POS will be returned;
3603 otherwise a position greater than POS will always be returned.
3604 If OBJECT is nil, the current buffer is assumed.
3608 Lisp_Object obj = decode_buffer_or_string(object);
3612 get_buffer_or_string_pos_byte(obj, pos, GB_ALLOW_PAST_ACCESSIBLE);
3613 bpos = extent_find_end_of_run(obj, bpos, 1);
3614 return make_int(buffer_or_string_bytind_to_bufpos(obj, bpos));
3617 DEFUN("previous-extent-change", Fprevious_extent_change, 1, 2, 0, /*
3618 Return the last position before POS where an extent begins or ends.
3619 If POS is at the beginning of the buffer or string, POS will be returned;
3620 otherwise a position less than POS will always be returned.
3621 If OBJECT is nil, the current buffer is assumed.
3625 Lisp_Object obj = decode_buffer_or_string(object);
3629 get_buffer_or_string_pos_byte(obj, pos, GB_ALLOW_PAST_ACCESSIBLE);
3630 bpos = extent_find_beginning_of_run(obj, bpos, 1);
3631 return make_int(buffer_or_string_bytind_to_bufpos(obj, bpos));
3634 /************************************************************************/
3635 /* parent and children stuff */
3636 /************************************************************************/
3638 DEFUN("extent-parent", Fextent_parent, 1, 1, 0, /*
3639 Return the parent (if any) of EXTENT.
3640 If an extent has a parent, it derives all its properties from that extent
3641 and has no properties of its own. (The only "properties" that the
3642 extent keeps are the buffer/string it refers to and the start and end
3643 points.) It is possible for an extent's parent to itself have a parent.
3646 /* do I win the prize for the strangest split infinitive? */
3648 EXTENT e = decode_extent(extent, 0);
3649 return extent_parent(e);
3652 DEFUN("extent-children", Fextent_children, 1, 1, 0, /*
3653 Return a list of the children (if any) of EXTENT.
3654 The children of an extent are all those extents whose parent is that extent.
3655 This function does not recursively trace children of children.
3656 \(To do that, use `extent-descendants'.)
3660 EXTENT e = decode_extent(extent, 0);
3661 Lisp_Object children = extent_children(e);
3663 if (!NILP(children))
3664 return Fcopy_sequence(XWEAK_LIST_LIST(children));
3669 static void remove_extent_from_children_list(EXTENT e, Lisp_Object child)
3671 Lisp_Object children = extent_children(e);
3673 #ifdef ERROR_CHECK_EXTENTS
3674 assert(!NILP(memq_no_quit(child, XWEAK_LIST_LIST(children))));
3676 XWEAK_LIST_LIST(children) =
3677 delq_no_quit(child, XWEAK_LIST_LIST(children));
3680 static void add_extent_to_children_list(EXTENT e, Lisp_Object child)
3682 Lisp_Object children = extent_children(e);
3684 if (NILP(children)) {
3685 children = make_weak_list(WEAK_LIST_SIMPLE);
3686 set_extent_no_chase_aux_field(e, children, children);
3688 #ifdef ERROR_CHECK_EXTENTS
3689 assert(NILP(memq_no_quit(child, XWEAK_LIST_LIST(children))));
3691 XWEAK_LIST_LIST(children) = Fcons(child, XWEAK_LIST_LIST(children));
3694 DEFUN("set-extent-parent", Fset_extent_parent, 2, 2, 0, /*
3695 Set the parent of EXTENT to PARENT (may be nil).
3696 See `extent-parent'.
3700 EXTENT e = decode_extent(extent, 0);
3701 Lisp_Object cur_parent = extent_parent(e);
3704 XSETEXTENT(extent, e);
3706 CHECK_LIVE_EXTENT(parent);
3707 if (EQ(parent, cur_parent))
3709 for (rest = parent; !NILP(rest); rest = extent_parent(XEXTENT(rest)))
3710 if (EQ(rest, extent))
3711 signal_type_error(Qinvalid_change,
3712 "Circular parent chain would result",
3715 remove_extent_from_children_list(XEXTENT(cur_parent), extent);
3716 set_extent_no_chase_aux_field(e, parent, Qnil);
3717 e->flags.has_parent = 0;
3719 add_extent_to_children_list(XEXTENT(parent), extent);
3720 set_extent_no_chase_aux_field(e, parent, parent);
3721 e->flags.has_parent = 1;
3723 /* changing the parent also changes the properties of all children. */
3725 int old_invis = (!NILP(cur_parent) &&
3726 !NILP(extent_invisible(XEXTENT(cur_parent))));
3727 int new_invis = (!NILP(parent) &&
3728 !NILP(extent_invisible(XEXTENT(parent))));
3730 extent_maybe_changed_for_redisplay(e, 1,
3731 new_invis != old_invis);
3737 /************************************************************************/
3738 /* basic extent mutators */
3739 /************************************************************************/
3741 /* Note: If you track non-duplicable extents by undo, you'll get bogus
3742 undo records for transient extents via update-extent.
3743 For example, query-replace will do this.
3746 static void set_extent_endpoints_1(EXTENT extent, Memind start, Memind end)
3748 #ifdef ERROR_CHECK_EXTENTS
3749 Lisp_Object obj = extent_object(extent);
3751 assert(start <= end);
3753 assert(valid_memind_p(XBUFFER(obj), start));
3754 assert(valid_memind_p(XBUFFER(obj), end));
3758 /* Optimization: if the extent is already where we want it to be,
3760 if (!extent_detached_p(extent) && extent_start(extent) == start &&
3761 extent_end(extent) == end)
3764 if (extent_detached_p(extent)) {
3765 if (extent_duplicable_p(extent)) {
3766 Lisp_Object extent_obj;
3767 XSETEXTENT(extent_obj, extent);
3768 record_extent(extent_obj, 1);
3771 extent_detach(extent);
3773 set_extent_start(extent, start);
3774 set_extent_end(extent, end);
3775 extent_attach(extent);
3778 /* Set extent's endpoints to S and E, and put extent in buffer or string
3779 OBJECT. (If OBJECT is nil, do not change the extent's object.) */
3781 void set_extent_endpoints(EXTENT extent, Bytind s, Bytind e, Lisp_Object object)
3786 object = extent_object(extent);
3787 assert(!NILP(object));
3788 } else if (!EQ(object, extent_object(extent))) {
3789 extent_detach(extent);
3790 extent_object(extent) = object;
3793 start = s < 0 ? extent_start(extent) :
3794 buffer_or_string_bytind_to_memind(object, s);
3795 end = e < 0 ? extent_end(extent) :
3796 buffer_or_string_bytind_to_memind(object, e);
3797 set_extent_endpoints_1(extent, start, end);
3800 static void set_extent_openness(EXTENT extent, int start_open, int end_open)
3802 if (start_open != -1)
3803 extent_start_open_p(extent) = start_open;
3805 extent_end_open_p(extent) = end_open;
3806 /* changing the open/closedness of an extent does not affect
3810 static EXTENT make_extent_internal(Lisp_Object object, Bytind from, Bytind to)
3814 extent = make_extent_detached(object);
3815 set_extent_endpoints(extent, from, to, Qnil);
3820 copy_extent(EXTENT original, Bytind from, Bytind to, Lisp_Object object)
3824 e = make_extent_detached(object);
3826 set_extent_endpoints(e, from, to, Qnil);
3828 e->plist = Fcopy_sequence(original->plist);
3829 memcpy(&e->flags, &original->flags, sizeof(e->flags));
3830 if (e->flags.has_aux) {
3831 /* also need to copy the aux struct. It won't work for
3832 this extent to share the same aux struct as the original
3834 struct extent_auxiliary *data =
3835 alloc_lcrecord_type(struct extent_auxiliary,
3836 &lrecord_extent_auxiliary);
3838 copy_lcrecord(data, XEXTENT_AUXILIARY(XCAR(original->plist)));
3839 XSETEXTENT_AUXILIARY(XCAR(e->plist), data);
3843 /* we may have just added another child to the parent extent. */
3844 Lisp_Object parent = extent_parent(e);
3845 if (!NILP(parent)) {
3847 XSETEXTENT(extent, e);
3848 add_extent_to_children_list(XEXTENT(parent), extent);
3855 static void destroy_extent(EXTENT extent)
3857 Lisp_Object rest, nextrest, children;
3858 Lisp_Object extent_obj;
3860 if (!extent_detached_p(extent))
3861 extent_detach(extent);
3862 /* disassociate the extent from its children and parent */
3863 children = extent_children(extent);
3864 if (!NILP(children)) {
3865 LIST_LOOP_DELETING(rest, nextrest, XWEAK_LIST_LIST(children))
3866 Fset_extent_parent(XCAR(rest), Qnil);
3868 XSETEXTENT(extent_obj, extent);
3869 Fset_extent_parent(extent_obj, Qnil);
3870 /* mark the extent as destroyed */
3871 extent_object(extent) = Qt;
3874 DEFUN("make-extent", Fmake_extent, 2, 3, 0, /*
3875 Make an extent for the range [FROM, TO) in BUFFER-OR-STRING.
3876 BUFFER-OR-STRING defaults to the current buffer. Insertions at point
3877 TO will be outside of the extent; insertions at FROM will be inside the
3878 extent, causing the extent to grow. (This is the same way that markers
3879 behave.) You can change the behavior of insertions at the endpoints
3880 using `set-extent-property'. The extent is initially detached if both
3881 FROM and TO are nil, and in this case BUFFER-OR-STRING defaults to nil,
3882 meaning the extent is in no buffer and no string.
3884 (from, to, buffer_or_string))
3886 Lisp_Object extent_obj;
3889 obj = decode_buffer_or_string(buffer_or_string);
3890 if (NILP(from) && NILP(to)) {
3891 if (NILP(buffer_or_string))
3893 XSETEXTENT(extent_obj, make_extent_detached(obj));
3897 get_buffer_or_string_range_byte(obj, from, to, &start, &end,
3898 GB_ALLOW_PAST_ACCESSIBLE);
3899 XSETEXTENT(extent_obj, make_extent_internal(obj, start, end));
3904 DEFUN("copy-extent", Fcopy_extent, 1, 2, 0, /*
3905 Make a copy of EXTENT. It is initially detached.
3906 Optional argument BUFFER-OR-STRING defaults to EXTENT's buffer or string.
3908 (extent, buffer_or_string))
3910 EXTENT ext = decode_extent(extent, 0);
3912 if (NILP(buffer_or_string))
3913 buffer_or_string = extent_object(ext);
3915 buffer_or_string = decode_buffer_or_string(buffer_or_string);
3917 XSETEXTENT(extent, copy_extent(ext, -1, -1, buffer_or_string));
3921 DEFUN("delete-extent", Fdelete_extent, 1, 1, 0, /*
3922 Remove EXTENT from its buffer and destroy it.
3923 This does not modify the buffer's text, only its display properties.
3924 The extent cannot be used thereafter.
3930 /* We do not call decode_extent() here because already-destroyed
3932 CHECK_EXTENT(extent);
3933 ext = XEXTENT(extent);
3935 if (!EXTENT_LIVE_P(ext))
3937 destroy_extent(ext);
3941 DEFUN("detach-extent", Fdetach_extent, 1, 1, 0, /*
3942 Remove EXTENT from its buffer in such a way that it can be re-inserted.
3943 An extent is also detached when all of its characters are all killed by a
3944 deletion, unless its `detachable' property has been unset.
3946 Extents which have the `duplicable' attribute are tracked by the undo
3947 mechanism. Detachment via `detach-extent' and string deletion is recorded,
3948 as is attachment via `insert-extent' and string insertion. Extent motion,
3949 face changes, and attachment via `make-extent' and `set-extent-endpoints'
3950 are not recorded. This means that extent changes which are to be undo-able
3951 must be performed by character editing, or by insertion and detachment of
3956 EXTENT ext = decode_extent(extent, 0);
3958 if (extent_detached_p(ext))
3960 if (extent_duplicable_p(ext))
3961 record_extent(extent, 0);
3967 DEFUN("set-extent-endpoints", Fset_extent_endpoints, 3, 4, 0, /*
3968 Set the endpoints of EXTENT to START, END.
3969 If START and END are null, call detach-extent on EXTENT.
3970 BUFFER-OR-STRING specifies the new buffer or string that the extent should
3971 be in, and defaults to EXTENT's buffer or string. (If nil, and EXTENT
3972 is in no buffer and no string, it defaults to the current buffer.)
3973 See documentation on `detach-extent' for a discussion of undo recording.
3975 (extent, start, end, buffer_or_string))
3980 ext = decode_extent(extent, 0);
3982 if (NILP(buffer_or_string)) {
3983 buffer_or_string = extent_object(ext);
3984 if (NILP(buffer_or_string))
3985 buffer_or_string = Fcurrent_buffer();
3987 buffer_or_string = decode_buffer_or_string(buffer_or_string);
3989 if (NILP(start) && NILP(end))
3990 return Fdetach_extent(extent);
3992 get_buffer_or_string_range_byte(buffer_or_string, start, end, &s, &e,
3993 GB_ALLOW_PAST_ACCESSIBLE);
3995 buffer_or_string_extent_info_force(buffer_or_string);
3996 set_extent_endpoints(ext, s, e, buffer_or_string);
4000 /************************************************************************/
4001 /* mapping over extents */
4002 /************************************************************************/
4004 static unsigned int decode_map_extents_flags(Lisp_Object flags)
4006 unsigned int retval = 0;
4007 unsigned int all_extents_specified = 0;
4008 unsigned int in_region_specified = 0;
4010 if (EQ(flags, Qt)) /* obsoleteness compatibility */
4011 return ME_END_CLOSED;
4015 flags = Fcons(flags, Qnil);
4016 while (!NILP(flags)) {
4021 if (EQ(sym, Qall_extents_closed) || EQ(sym, Qall_extents_open)
4022 || EQ(sym, Qall_extents_closed_open)
4023 || EQ(sym, Qall_extents_open_closed)) {
4024 if (all_extents_specified)
4026 ("Only one `all-extents-*' flag may be specified");
4027 all_extents_specified = 1;
4029 if (EQ(sym, Qstart_in_region) || EQ(sym, Qend_in_region) ||
4030 EQ(sym, Qstart_and_end_in_region) ||
4031 EQ(sym, Qstart_or_end_in_region)) {
4032 if (in_region_specified)
4034 ("Only one `*-in-region' flag may be specified");
4035 in_region_specified = 1;
4038 /* I do so love that conditional operator ... */
4040 EQ(sym, Qend_closed) ? ME_END_CLOSED :
4041 EQ(sym, Qstart_open) ? ME_START_OPEN :
4042 EQ(sym, Qall_extents_closed) ? ME_ALL_EXTENTS_CLOSED :
4043 EQ(sym, Qall_extents_open) ? ME_ALL_EXTENTS_OPEN :
4045 Qall_extents_closed_open) ? ME_ALL_EXTENTS_CLOSED_OPEN :
4047 Qall_extents_open_closed) ? ME_ALL_EXTENTS_OPEN_CLOSED :
4048 EQ(sym, Qstart_in_region) ? ME_START_IN_REGION : EQ(sym,
4050 ? ME_END_IN_REGION : EQ(sym,
4051 Qstart_and_end_in_region) ?
4052 ME_START_AND_END_IN_REGION : EQ(sym,
4053 Qstart_or_end_in_region) ?
4054 ME_START_OR_END_IN_REGION : EQ(sym,
4055 Qnegate_in_region) ?
4057 : (invalid_argument("Invalid `map-extents' flag", sym), 0);
4059 flags = XCDR(flags);
4064 DEFUN("extent-in-region-p", Fextent_in_region_p, 1, 4, 0, /*
4065 Return whether EXTENT overlaps a specified region.
4066 This is equivalent to whether `map-extents' would visit EXTENT when called
4069 (extent, from, to, flags))
4072 EXTENT ext = decode_extent(extent, DE_MUST_BE_ATTACHED);
4073 Lisp_Object obj = extent_object(ext);
4075 get_buffer_or_string_range_byte(obj, from, to, &start, &end,
4077 GB_ALLOW_PAST_ACCESSIBLE);
4079 return extent_in_region_p(ext, start, end,
4080 decode_map_extents_flags(flags)) ? Qt : Qnil;
4083 struct slow_map_extents_arg {
4084 Lisp_Object map_arg;
4085 Lisp_Object map_routine;
4087 Lisp_Object property;
4091 static int slow_map_extents_function(EXTENT extent, void *arg)
4093 /* This function can GC */
4094 struct slow_map_extents_arg *closure =
4095 (struct slow_map_extents_arg *)arg;
4096 Lisp_Object extent_obj;
4098 XSETEXTENT(extent_obj, extent);
4100 /* make sure this extent qualifies according to the PROPERTY
4103 if (!NILP(closure->property)) {
4105 Fextent_property(extent_obj, closure->property,
4107 if ((NILP(closure->value) && NILP(value)) ||
4108 (!NILP(closure->value) && !EQ(value, closure->value)))
4112 closure->result = call2(closure->map_routine, extent_obj,
4114 return !NILP(closure->result);
4117 DEFUN("map-extents", Fmap_extents, 1, 8, 0, /*
4118 Map FUNCTION over the extents which overlap a region in OBJECT.
4119 OBJECT is normally a buffer or string but could be an extent (see below).
4120 The region is normally bounded by [FROM, TO) (i.e. the beginning of the
4121 region is closed and the end of the region is open), but this can be
4122 changed with the FLAGS argument (see below for a complete discussion).
4124 FUNCTION is called with the arguments (extent, MAPARG). The arguments
4125 OBJECT, FROM, TO, MAPARG, and FLAGS are all optional and default to
4126 the current buffer, the beginning of OBJECT, the end of OBJECT, nil,
4127 and nil, respectively. `map-extents' returns the first non-nil result
4128 produced by FUNCTION, and no more calls to FUNCTION are made after it
4131 If OBJECT is an extent, FROM and TO default to the extent's endpoints,
4132 and the mapping omits that extent and its predecessors. This feature
4133 supports restarting a loop based on `map-extents'. Note: OBJECT must
4134 be attached to a buffer or string, and the mapping is done over that
4137 An extent overlaps the region if there is any point in the extent that is
4138 also in the region. (For the purpose of overlap, zero-length extents and
4139 regions are treated as closed on both ends regardless of their endpoints'
4140 specified open/closedness.) Note that the endpoints of an extent or region
4141 are considered to be in that extent or region if and only if the
4142 corresponding end is closed. For example, the extent [5,7] overlaps the
4143 region [2,5] because 5 is in both the extent and the region. However, (5,7]
4144 does not overlap [2,5] because 5 is not in the extent, and neither [5,7] nor
4145 \(5,7] overlaps the region [2,5) because 5 is not in the region.
4147 The optional FLAGS can be a symbol or a list of one or more symbols,
4148 modifying the behavior of `map-extents'. Allowed symbols are:
4150 end-closed The region's end is closed.
4152 start-open The region's start is open.
4154 all-extents-closed Treat all extents as closed on both ends for the
4155 purpose of determining whether they overlap the
4156 region, irrespective of their actual open- or
4158 all-extents-open Treat all extents as open on both ends.
4159 all-extents-closed-open Treat all extents as start-closed, end-open.
4160 all-extents-open-closed Treat all extents as start-open, end-closed.
4162 start-in-region In addition to the above conditions for extent
4163 overlap, the extent's start position must lie within
4164 the specified region. Note that, for this
4165 condition, open start positions are treated as if
4166 0.5 was added to the endpoint's value, and open
4167 end positions are treated as if 0.5 was subtracted
4168 from the endpoint's value.
4169 end-in-region The extent's end position must lie within the
4171 start-and-end-in-region Both the extent's start and end positions must lie
4173 start-or-end-in-region Either the extent's start or end position must lie
4176 negate-in-region The condition specified by a `*-in-region' flag
4177 must NOT hold for the extent to be considered.
4179 At most one of `all-extents-closed', `all-extents-open',
4180 `all-extents-closed-open', and `all-extents-open-closed' may be specified.
4182 At most one of `start-in-region', `end-in-region',
4183 `start-and-end-in-region', and `start-or-end-in-region' may be specified.
4185 If optional arg PROPERTY is non-nil, only extents with that property set
4186 on them will be visited. If optional arg VALUE is non-nil, only extents
4187 whose value for that property is `eq' to VALUE will be visited.
4189 (function, object, from, to, maparg, flags, property, value))
4191 /* This function can GC */
4192 struct slow_map_extents_arg closure;
4193 unsigned int me_flags;
4195 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
4198 if (EXTENTP(object)) {
4199 after = decode_extent(object, DE_MUST_BE_ATTACHED);
4201 from = Fextent_start_position(object);
4203 to = Fextent_end_position(object);
4204 object = extent_object(after);
4206 object = decode_buffer_or_string(object);
4208 get_buffer_or_string_range_byte(object, from, to, &start, &end,
4210 GB_ALLOW_PAST_ACCESSIBLE);
4212 me_flags = decode_map_extents_flags(flags);
4214 if (!NILP(property)) {
4216 value = canonicalize_extent_property(property, value);
4219 GCPRO5(function, maparg, object, property, value);
4221 closure.map_arg = maparg;
4222 closure.map_routine = function;
4223 closure.result = Qnil;
4224 closure.property = property;
4225 closure.value = value;
4227 map_extents_bytind(start, end, slow_map_extents_function,
4228 (void *)&closure, object, after,
4229 /* You never know what the user might do ... */
4230 me_flags | ME_MIGHT_CALL_ELISP);
4233 return closure.result;
4236 /************************************************************************/
4237 /* mapping over extents -- other functions */
4238 /************************************************************************/
4240 /* ------------------------------- */
4241 /* map-extent-children */
4242 /* ------------------------------- */
4244 struct slow_map_extent_children_arg {
4245 Lisp_Object map_arg;
4246 Lisp_Object map_routine;
4248 Lisp_Object property;
4255 static int slow_map_extent_children_function(EXTENT extent, void *arg)
4257 /* This function can GC */
4258 struct slow_map_extent_children_arg *closure =
4259 (struct slow_map_extent_children_arg *)arg;
4260 Lisp_Object extent_obj;
4261 Bytind start = extent_endpoint_bytind(extent, 0);
4262 Bytind end = extent_endpoint_bytind(extent, 1);
4263 /* Make sure the extent starts inside the region of interest,
4264 rather than just overlaps it.
4266 if (start < closure->start_min)
4268 /* Make sure the extent is not a child of a previous visited one.
4269 We know already, because of extent ordering,
4270 that start >= prev_start, and that if
4271 start == prev_start, then end <= prev_end.
4273 if (start == closure->prev_start) {
4274 if (end < closure->prev_end)
4276 } else { /* start > prev_start */
4278 if (start < closure->prev_end)
4280 /* corner case: prev_end can be -1 if there is no prev */
4282 XSETEXTENT(extent_obj, extent);
4284 /* make sure this extent qualifies according to the PROPERTY
4287 if (!NILP(closure->property)) {
4289 Fextent_property(extent_obj, closure->property,
4291 if ((NILP(closure->value) && NILP(value)) ||
4292 (!NILP(closure->value) && !EQ(value, closure->value)))
4296 closure->result = call2(closure->map_routine, extent_obj,
4299 /* Since the callback may change the buffer, compute all stored
4300 buffer positions here.
4302 closure->start_min = -1; /* no need for this any more */
4303 closure->prev_start = extent_endpoint_bytind(extent, 0);
4304 closure->prev_end = extent_endpoint_bytind(extent, 1);
4306 return !NILP(closure->result);
4309 DEFUN("map-extent-children", Fmap_extent_children, 1, 8, 0, /*
4310 Map FUNCTION over the extents in the region from FROM to TO.
4311 FUNCTION is called with arguments (extent, MAPARG). See `map-extents'
4312 for a full discussion of the arguments FROM, TO, and FLAGS.
4314 The arguments are the same as for `map-extents', but this function differs
4315 in that it only visits extents which start in the given region, and also
4316 in that, after visiting an extent E, it skips all other extents which start
4317 inside E but end before E's end.
4319 Thus, this function may be used to walk a tree of extents in a buffer:
4320 (defun walk-extents (buffer &optional ignore)
4321 (map-extent-children 'walk-extents buffer))
4323 (function, object, from, to, maparg, flags, property, value))
4325 /* This function can GC */
4326 struct slow_map_extent_children_arg closure;
4327 unsigned int me_flags;
4329 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
4332 if (EXTENTP(object)) {
4333 after = decode_extent(object, DE_MUST_BE_ATTACHED);
4335 from = Fextent_start_position(object);
4337 to = Fextent_end_position(object);
4338 object = extent_object(after);
4340 object = decode_buffer_or_string(object);
4342 get_buffer_or_string_range_byte(object, from, to, &start, &end,
4344 GB_ALLOW_PAST_ACCESSIBLE);
4346 me_flags = decode_map_extents_flags(flags);
4348 if (!NILP(property)) {
4350 value = canonicalize_extent_property(property, value);
4353 GCPRO5(function, maparg, object, property, value);
4355 closure.map_arg = maparg;
4356 closure.map_routine = function;
4357 closure.result = Qnil;
4358 closure.property = property;
4359 closure.value = value;
4360 closure.start_min = start;
4361 closure.prev_start = -1;
4362 closure.prev_end = -1;
4363 map_extents_bytind(start, end, slow_map_extent_children_function,
4364 (void *)&closure, object, after,
4365 /* You never know what the user might do ... */
4366 me_flags | ME_MIGHT_CALL_ELISP);
4369 return closure.result;
4372 /* ------------------------------- */
4374 /* ------------------------------- */
4376 /* find "smallest" matching extent containing pos -- (flag == 0) means
4377 all extents match, else (EXTENT_FLAGS (extent) & flag) must be true;
4378 for more than one matching extent with precisely the same endpoints,
4379 we choose the last extent in the extents_list.
4380 The search stops just before "before", if that is non-null.
4383 struct extent_at_arg {
4384 Lisp_Object best_match; /* or list of extents */
4392 enum extent_at_flag {
4398 static enum extent_at_flag decode_extent_at_flag(Lisp_Object at_flag)
4401 return EXTENT_AT_AFTER;
4403 CHECK_SYMBOL(at_flag);
4404 if (EQ(at_flag, Qafter))
4405 return EXTENT_AT_AFTER;
4406 if (EQ(at_flag, Qbefore))
4407 return EXTENT_AT_BEFORE;
4408 if (EQ(at_flag, Qat))
4409 return EXTENT_AT_AT;
4411 invalid_argument("Invalid AT-FLAG in `extent-at'", at_flag);
4412 return EXTENT_AT_AFTER; /* unreached */
4415 static int extent_at_mapper(EXTENT e, void *arg)
4417 struct extent_at_arg *closure = (struct extent_at_arg *)arg;
4419 if (e == closure->before)
4422 /* If closure->prop is non-nil, then the extent is only acceptable
4423 if it has a non-nil value for that property. */
4424 if (!NILP(closure->prop)) {
4426 XSETEXTENT(extent, e);
4427 if (NILP(Fextent_property(extent, closure->prop, Qnil)))
4431 if (!closure->all_extents) {
4434 if (NILP(closure->best_match))
4436 current = XEXTENT(closure->best_match);
4437 /* redundant but quick test */
4438 if (extent_start(current) > extent_start(e))
4441 /* we return the "last" best fit, instead of the first --
4442 this is because then the glyph closest to two equivalent
4443 extents corresponds to the "extent-at" the text just past
4445 else if (!EXTENT_LESS_VALS(e, closure->best_start,
4451 XSETEXTENT(closure->best_match, e);
4452 closure->best_start = extent_start(e);
4453 closure->best_end = extent_end(e);
4457 XSETEXTENT(extent, e);
4458 closure->best_match = Fcons(extent, closure->best_match);
4465 extent_at_bytind(Bytind position, Lisp_Object object, Lisp_Object property,
4466 EXTENT before, enum extent_at_flag at_flag, int all_extents)
4468 struct extent_at_arg closure;
4469 struct gcpro gcpro1;
4471 /* it might be argued that invalid positions should cause
4472 errors, but the principle of least surprise dictates that
4473 nil should be returned (extent-at is often used in
4474 response to a mouse event, and in many cases previous events
4475 have changed the buffer contents).
4477 Also, the openness stuff in the text-property code currently
4478 does not check its limits and might go off the end. */
4479 if ((at_flag == EXTENT_AT_BEFORE
4480 ? position <= buffer_or_string_absolute_begin_byte(object)
4481 : position < buffer_or_string_absolute_begin_byte(object))
4482 || (at_flag == EXTENT_AT_AFTER
4483 ? position >= buffer_or_string_absolute_end_byte(object)
4484 : position > buffer_or_string_absolute_end_byte(object)))
4487 closure.best_match = Qnil;
4488 closure.prop = property;
4489 closure.before = before;
4490 closure.all_extents = all_extents;
4492 GCPRO1(closure.best_match);
4493 map_extents_bytind(at_flag ==
4494 EXTENT_AT_BEFORE ? position - 1 : position,
4495 at_flag == EXTENT_AT_AFTER ? position + 1 : position,
4496 extent_at_mapper, (void *)&closure, object, 0,
4497 ME_START_OPEN | ME_ALL_EXTENTS_CLOSED);
4499 closure.best_match = Fnreverse(closure.best_match);
4502 return closure.best_match;
4505 DEFUN("extent-at", Fextent_at, 1, 5, 0, /*
4506 Find "smallest" extent at POS in OBJECT having PROPERTY set.
4507 Normally, an extent is "at" POS if it overlaps the region (POS, POS+1);
4508 i.e. if it covers the character after POS. (However, see the definition
4509 of AT-FLAG.) "Smallest" means the extent that comes last in the display
4510 order; this normally means the extent whose start position is closest to
4511 POS. See `next-extent' for more information.
4512 OBJECT specifies a buffer or string and defaults to the current buffer.
4513 PROPERTY defaults to nil, meaning that any extent will do.
4514 Properties are attached to extents with `set-extent-property', which see.
4515 Returns nil if POS is invalid or there is no matching extent at POS.
4516 If the fourth argument BEFORE is not nil, it must be an extent; any returned
4517 extent will precede that extent. This feature allows `extent-at' to be
4518 used by a loop over extents.
4519 AT-FLAG controls how end cases are handled, and should be one of:
4521 nil or `after' An extent is at POS if it covers the character
4522 after POS. This is consistent with the way
4523 that text properties work.
4524 `before' An extent is at POS if it covers the character
4526 `at' An extent is at POS if it overlaps or abuts POS.
4527 This includes all zero-length extents at POS.
4529 Note that in all cases, the start-openness and end-openness of the extents
4530 considered is ignored. If you want to pay attention to those properties,
4531 you should use `map-extents', which gives you more control.
4533 (pos, object, property, before, at_flag))
4536 EXTENT before_extent;
4537 enum extent_at_flag fl;
4539 object = decode_buffer_or_string(object);
4541 get_buffer_or_string_pos_byte(object, pos, GB_NO_ERROR_IF_BAD);
4545 before_extent = decode_extent(before, DE_MUST_BE_ATTACHED);
4546 if (before_extent && !EQ(object, extent_object(before_extent)))
4547 invalid_argument("extent not in specified buffer or string",
4549 fl = decode_extent_at_flag(at_flag);
4551 return extent_at_bytind(position, object, property, before_extent, fl,
4555 DEFUN("extents-at", Fextents_at, 1, 5, 0, /*
4556 Find all extents at POS in OBJECT having PROPERTY set.
4557 Normally, an extent is "at" POS if it overlaps the region (POS, POS+1);
4558 i.e. if it covers the character after POS. (However, see the definition
4560 This provides similar functionality to `extent-list', but does so in a way
4561 that is compatible with `extent-at'. (For example, errors due to POS out of
4562 range are ignored; this makes it safer to use this function in response to
4563 a mouse event, because in many cases previous events have changed the buffer
4565 OBJECT specifies a buffer or string and defaults to the current buffer.
4566 PROPERTY defaults to nil, meaning that any extent will do.
4567 Properties are attached to extents with `set-extent-property', which see.
4568 Returns nil if POS is invalid or there is no matching extent at POS.
4569 If the fourth argument BEFORE is not nil, it must be an extent; any returned
4570 extent will precede that extent. This feature allows `extents-at' to be
4571 used by a loop over extents.
4572 AT-FLAG controls how end cases are handled, and should be one of:
4574 nil or `after' An extent is at POS if it covers the character
4575 after POS. This is consistent with the way
4576 that text properties work.
4577 `before' An extent is at POS if it covers the character
4579 `at' An extent is at POS if it overlaps or abuts POS.
4580 This includes all zero-length extents at POS.
4582 Note that in all cases, the start-openness and end-openness of the extents
4583 considered is ignored. If you want to pay attention to those properties,
4584 you should use `map-extents', which gives you more control.
4586 (pos, object, property, before, at_flag))
4589 EXTENT before_extent;
4590 enum extent_at_flag fl;
4592 object = decode_buffer_or_string(object);
4594 get_buffer_or_string_pos_byte(object, pos, GB_NO_ERROR_IF_BAD);
4598 before_extent = decode_extent(before, DE_MUST_BE_ATTACHED);
4599 if (before_extent && !EQ(object, extent_object(before_extent)))
4600 invalid_argument("extent not in specified buffer or string",
4602 fl = decode_extent_at_flag(at_flag);
4604 return extent_at_bytind(position, object, property, before_extent, fl,
4608 /* ------------------------------- */
4609 /* verify_extent_modification() */
4610 /* ------------------------------- */
4612 /* verify_extent_modification() is called when a buffer or string is
4613 modified to check whether the modification is occuring inside a
4617 struct verify_extents_arg {
4621 Lisp_Object iro; /* value of inhibit-read-only */
4624 static int verify_extent_mapper(EXTENT extent, void *arg)
4626 struct verify_extents_arg *closure = (struct verify_extents_arg *)arg;
4627 Lisp_Object prop = extent_read_only(extent);
4632 if (CONSP(closure->iro) && !NILP(Fmemq(prop, closure->iro)))
4635 #if 0 /* Nobody seems to care for this any more -sb */
4636 /* Allow deletion if the extent is completely contained in
4637 the region being deleted.
4638 This is important for supporting tokens which are internally
4639 write-protected, but which can be killed and yanked as a whole.
4640 Ignore open/closed distinctions at this point.
4643 if (closure->start != closure->end &&
4644 extent_start(extent) >= closure->start &&
4645 extent_end(extent) <= closure->end)
4650 Fsignal(Qbuffer_read_only, (list1(closure->object)));
4652 RETURN_NOT_REACHED(0)
4655 /* Value of Vinhibit_read_only is precomputed and passed in for
4659 verify_extent_modification(Lisp_Object object, Bytind from, Bytind to,
4660 Lisp_Object inhibit_read_only_value)
4663 struct verify_extents_arg closure;
4665 /* If insertion, visit closed-endpoint extents touching the insertion
4666 point because the text would go inside those extents. If deletion,
4667 treat the range as open on both ends so that touching extents are not
4668 visited. Note that we assume that an insertion is occurring if the
4669 changed range has zero length, and a deletion otherwise. This
4670 fails if a change (i.e. non-insertion, non-deletion) is happening.
4671 As far as I know, this doesn't currently occur in XEmacs. --ben */
4672 closed = (from == to);
4673 closure.object = object;
4674 closure.start = buffer_or_string_bytind_to_memind(object, from);
4675 closure.end = buffer_or_string_bytind_to_memind(object, to);
4676 closure.iro = inhibit_read_only_value;
4678 map_extents_bytind(from, to, verify_extent_mapper, (void *)&closure,
4679 object, 0, closed ? ME_END_CLOSED : ME_START_OPEN);
4682 /* ------------------------------------ */
4683 /* process_extents_for_insertion() */
4684 /* ------------------------------------ */
4686 struct process_extents_for_insertion_arg {
4692 /* A region of length LENGTH was just inserted at OPOINT. Modify all
4693 of the extents as required for the insertion, based on their
4694 start-open/end-open properties.
4697 static int process_extents_for_insertion_mapper(EXTENT extent, void *arg)
4699 struct process_extents_for_insertion_arg *closure =
4700 (struct process_extents_for_insertion_arg *)arg;
4701 Memind indice = buffer_or_string_bytind_to_memind(closure->object,
4704 /* When this function is called, one end of the newly-inserted text should
4705 be adjacent to some endpoint of the extent, or disjoint from it. If
4706 the insertion overlaps any existing extent, something is wrong.
4708 #ifdef ERROR_CHECK_EXTENTS
4709 if (extent_start(extent) > indice &&
4710 extent_start(extent) < indice + closure->length)
4712 if (extent_end(extent) > indice &&
4713 extent_end(extent) < indice + closure->length)
4717 /* The extent-adjustment code adjusted the extent's endpoints as if
4718 all extents were closed-open -- endpoints at the insertion point
4719 remain unchanged. We need to fix the other kinds of extents:
4721 1. Start position of start-open extents needs to be moved.
4723 2. End position of end-closed extents needs to be moved.
4725 Note that both conditions hold for zero-length (] extents at the
4726 insertion point. But under these rules, zero-length () extents
4727 would get adjusted such that their start is greater than their
4728 end; instead of allowing that, we treat them as [) extents by
4729 modifying condition #1 to not fire nothing when dealing with a
4730 zero-length open-open extent.
4732 Existence of zero-length open-open extents is unfortunately an
4733 inelegant part of the extent model, but there is no way around
4737 Memind new_start = extent_start(extent);
4738 Memind new_end = extent_end(extent);
4740 if (indice == extent_start(extent)
4741 && extent_start_open_p(extent)
4742 /* zero-length () extents are exempt; see comment above. */
4743 && !(new_start == new_end && extent_end_open_p(extent))
4745 new_start += closure->length;
4746 if (indice == extent_end(extent) && !extent_end_open_p(extent))
4747 new_end += closure->length;
4749 set_extent_endpoints_1(extent, new_start, new_end);
4756 process_extents_for_insertion(Lisp_Object object, Bytind opoint,
4759 struct process_extents_for_insertion_arg closure;
4761 closure.opoint = opoint;
4762 closure.length = length;
4763 closure.object = object;
4765 map_extents_bytind(opoint, opoint + length,
4766 process_extents_for_insertion_mapper,
4767 (void *)&closure, object, 0,
4768 ME_END_CLOSED | ME_MIGHT_MODIFY_EXTENTS |
4769 ME_INCLUDE_INTERNAL);
4772 /* ------------------------------------ */
4773 /* process_extents_for_deletion() */
4774 /* ------------------------------------ */
4776 struct process_extents_for_deletion_arg {
4778 int destroy_included_extents;
4781 /* This function is called when we're about to delete the range [from, to].
4782 Detach all of the extents that are completely inside the range [from, to],
4783 if they're detachable or open-open. */
4785 static int process_extents_for_deletion_mapper(EXTENT extent, void *arg)
4787 struct process_extents_for_deletion_arg *closure =
4788 (struct process_extents_for_deletion_arg *)arg;
4790 /* If the extent lies completely within the range that
4791 is being deleted, then nuke the extent if it's detachable
4792 (otherwise, it will become a zero-length extent). */
4794 if (closure->start <= extent_start(extent) &&
4795 extent_end(extent) <= closure->end) {
4796 if (extent_detachable_p(extent)) {
4797 if (closure->destroy_included_extents)
4798 destroy_extent(extent);
4800 extent_detach(extent);
4807 /* DESTROY_THEM means destroy the extents instead of just deleting them.
4808 It is unused currently, but perhaps might be used (there used to
4809 be a function process_extents_for_destruction(), #if 0'd out,
4810 that did the equivalent). */
4812 process_extents_for_deletion(Lisp_Object object, Bytind from,
4813 Bytind to, int destroy_them)
4815 struct process_extents_for_deletion_arg closure;
4817 closure.start = buffer_or_string_bytind_to_memind(object, from);
4818 closure.end = buffer_or_string_bytind_to_memind(object, to);
4819 closure.destroy_included_extents = destroy_them;
4821 map_extents_bytind(from, to, process_extents_for_deletion_mapper,
4822 (void *)&closure, object, 0,
4823 ME_END_CLOSED | ME_MIGHT_MODIFY_EXTENTS);
4826 /* ------------------------------- */
4827 /* report_extent_modification() */
4828 /* ------------------------------- */
4829 struct report_extent_modification_closure {
4836 static Lisp_Object report_extent_modification_restore(Lisp_Object buffer)
4838 if (current_buffer != XBUFFER(buffer))
4839 Fset_buffer(buffer);
4843 static int report_extent_modification_mapper(EXTENT extent, void *arg)
4845 struct report_extent_modification_closure *closure =
4846 (struct report_extent_modification_closure *)arg;
4847 Lisp_Object exobj, startobj, endobj;
4848 Lisp_Object hook = (closure->afterp
4849 ? extent_after_change_functions(extent)
4850 : extent_before_change_functions(extent));
4854 XSETEXTENT(exobj, extent);
4855 XSETINT(startobj, closure->start);
4856 XSETINT(endobj, closure->end);
4858 /* Now that we are sure to call elisp, set up an unwind-protect so
4859 inside_change_hook gets restored in case we throw. Also record
4860 the current buffer, in case we change it. Do the recording only
4863 One confusing thing here is that our caller never actually calls
4864 unbind_to (closure.speccount, Qnil). This is because
4865 map_extents_bytind() unbinds before, and with a smaller
4866 speccount. The additional unbind_to() in
4867 report_extent_modification() would cause XEmacs to abort. */
4868 if (closure->speccount == -1) {
4869 closure->speccount = specpdl_depth();
4870 record_unwind_protect(report_extent_modification_restore,
4874 /* The functions will expect closure->buffer to be the current
4875 buffer, so change it if it isn't. */
4876 if (current_buffer != XBUFFER(closure->buffer))
4877 Fset_buffer(closure->buffer);
4879 /* #### It's a shame that we can't use any of the existing run_hook*
4880 functions here. This is so because all of them work with
4881 symbols, to be able to retrieve default values of local hooks.
4884 #### Idea: we could set up a dummy symbol, and call the hook
4885 functions on *that*. */
4887 if (!CONSP(hook) || EQ(XCAR(hook), Qlambda))
4888 call3(hook, exobj, startobj, endobj);
4891 EXTERNAL_LIST_LOOP(tail, hook)
4892 /* #### Shouldn't this perform the same Fset_buffer() check as
4894 call3(XCAR(tail), exobj, startobj, endobj);
4900 report_extent_modification(Lisp_Object buffer, Bufpos start, Bufpos end,
4903 struct report_extent_modification_closure closure;
4905 closure.buffer = buffer;
4906 closure.start = start;
4908 closure.afterp = afterp;
4909 closure.speccount = -1;
4911 map_extents(start, end, report_extent_modification_mapper,
4912 (void *)&closure, buffer, NULL, ME_MIGHT_CALL_ELISP);
4915 /************************************************************************/
4916 /* extent properties */
4917 /************************************************************************/
4919 static void set_extent_invisible(EXTENT extent, Lisp_Object value)
4921 if (!EQ(extent_invisible(extent), value)) {
4922 set_extent_invisible_1(extent, value);
4923 extent_changed_for_redisplay(extent, 1, 1);
4927 /* This function does "memoization" -- similar to the interning
4928 that happens with symbols. Given a list of faces, an equivalent
4929 list is returned such that if this function is called twice with
4930 input that is `equal', the resulting outputs will be `eq'.
4932 Note that the inputs and outputs are in general *not* `equal' --
4933 faces in symbol form become actual face objects in the output.
4934 This is necessary so that temporary faces stay around. */
4936 static Lisp_Object memoize_extent_face_internal(Lisp_Object list)
4940 Lisp_Object cons, thecons;
4941 Lisp_Object oldtail, tail;
4942 struct gcpro gcpro1;
4947 return Fget_face(list);
4949 /* To do the memoization, we use a hash table mapping from
4950 external lists to internal lists. We do `equal' comparisons
4951 on the keys so the memoization works correctly.
4953 Note that we canonicalize things so that the keys in the
4954 hash table (the external lists) always contain symbols and
4955 the values (the internal lists) always contain face objects.
4957 We also maintain a "reverse" table that maps from the internal
4958 lists to the external equivalents. The idea here is twofold:
4960 1) `extent-face' wants to return a list containing face symbols
4961 rather than face objects.
4962 2) We don't want things to get quite so messed up if the user
4963 maliciously side-effects the returned lists.
4966 len = XINT(Flength(list));
4967 thelen = XINT(Flength(Vextent_face_reusable_list));
4972 /* We canonicalize the given list into another list.
4973 We try to avoid consing except when necessary, so we have
4978 cons = Vextent_face_reusable_list;
4979 while (!NILP(XCDR(cons)))
4981 XCDR(cons) = Fmake_list(make_int(len - thelen), Qnil);
4982 } else if (thelen > len) {
4985 /* Truncate the list temporarily so it's the right length;
4986 remember the old tail. */
4987 cons = Vextent_face_reusable_list;
4988 for (i = 0; i < len - 1; i++)
4991 oldtail = XCDR(cons);
4995 thecons = Vextent_face_reusable_list;
4996 EXTERNAL_LIST_LOOP(cons, list) {
4997 Lisp_Object face = Fget_face(XCAR(cons));
4999 XCAR(thecons) = Fface_name(face);
5000 thecons = XCDR(thecons);
5004 Fgethash(Vextent_face_reusable_list,
5005 Vextent_face_memoize_hash_table, Qnil);
5007 Lisp_Object symlist =
5008 Fcopy_sequence(Vextent_face_reusable_list);
5009 Lisp_Object facelist =
5010 Fcopy_sequence(Vextent_face_reusable_list);
5012 LIST_LOOP(cons, facelist) {
5013 XCAR(cons) = Fget_face(XCAR(cons));
5015 Fputhash(symlist, facelist, Vextent_face_memoize_hash_table);
5016 Fputhash(facelist, symlist,
5017 Vextent_face_reverse_memoize_hash_table);
5021 /* Now restore the truncated tail of the reusable list, if necessary. */
5023 XCDR(tail) = oldtail;
5029 static Lisp_Object external_of_internal_memoized_face(Lisp_Object face)
5033 else if (!CONSP(face))
5034 return XFACE(face)->name;
5036 face = Fgethash(face, Vextent_face_reverse_memoize_hash_table,
5038 assert(!UNBOUNDP(face));
5044 canonicalize_extent_property(Lisp_Object prop, Lisp_Object value)
5046 if (EQ(prop, Qface) || EQ(prop, Qmouse_face))
5047 value = (external_of_internal_memoized_face
5048 (memoize_extent_face_internal(value)));
5052 /* Do we need a lisp-level function ? */
5053 DEFUN("set-extent-initial-redisplay-function", Fset_extent_initial_redisplay_function, 2, 2, 0, /*
5054 Note: This feature is experimental!
5056 Set initial-redisplay-function of EXTENT to the function
5059 The first time the EXTENT is (re)displayed, an eval event will be
5060 dispatched calling FUNCTION with EXTENT as its only argument.
5064 EXTENT e = decode_extent(extent, DE_MUST_BE_ATTACHED);
5066 e = extent_ancestor(e); /* Is this needed? Macro also does chasing! */
5067 set_extent_initial_redisplay_function(e, function);
5068 extent_in_red_event_p(e) = 0; /* If the function changed we can spawn
5070 extent_changed_for_redisplay(e, 1, 0); /* Do we need to mark children too ? */
5075 DEFUN("extent-face", Fextent_face, 1, 1, 0, /*
5076 Return the name of the face in which EXTENT is displayed, or nil
5077 if the extent's face is unspecified. This might also return a list
5084 CHECK_EXTENT(extent);
5085 face = extent_face(XEXTENT(extent));
5087 return external_of_internal_memoized_face(face);
5090 DEFUN("set-extent-face", Fset_extent_face, 2, 2, 0, /*
5091 Make the given EXTENT have the graphic attributes specified by FACE.
5092 FACE can also be a list of faces, and all faces listed will apply,
5093 with faces earlier in the list taking priority over those later in the
5098 EXTENT e = decode_extent(extent, 0);
5099 Lisp_Object orig_face = face;
5101 /* retrieve the ancestor for efficiency and proper redisplay noting. */
5102 e = extent_ancestor(e);
5104 face = memoize_extent_face_internal(face);
5106 extent_face(e) = face;
5107 extent_changed_for_redisplay(e, 1, 0);
5112 DEFUN("extent-mouse-face", Fextent_mouse_face, 1, 1, 0, /*
5113 Return the face used to highlight EXTENT when the mouse passes over it.
5114 The return value will be a face name, a list of face names, or nil
5115 if the extent's mouse face is unspecified.
5121 CHECK_EXTENT(extent);
5122 face = extent_mouse_face(XEXTENT(extent));
5124 return external_of_internal_memoized_face(face);
5127 DEFUN("set-extent-mouse-face", Fset_extent_mouse_face, 2, 2, 0, /*
5128 Set the face used to highlight EXTENT when the mouse passes over it.
5129 FACE can also be a list of faces, and all faces listed will apply,
5130 with faces earlier in the list taking priority over those later in the
5136 Lisp_Object orig_face = face;
5138 CHECK_EXTENT(extent);
5139 e = XEXTENT(extent);
5140 /* retrieve the ancestor for efficiency and proper redisplay noting. */
5141 e = extent_ancestor(e);
5143 face = memoize_extent_face_internal(face);
5145 set_extent_mouse_face(e, face);
5146 extent_changed_for_redisplay(e, 1, 0);
5152 set_extent_glyph(EXTENT extent, Lisp_Object glyph, int endp,
5153 glyph_layout layout)
5155 extent = extent_ancestor(extent);
5158 set_extent_begin_glyph(extent, glyph);
5159 extent_begin_glyph_layout(extent) = layout;
5161 set_extent_end_glyph(extent, glyph);
5162 extent_end_glyph_layout(extent) = layout;
5165 extent_changed_for_redisplay(extent, 1, 0);
5168 static Lisp_Object glyph_layout_to_symbol(glyph_layout layout)
5173 case GL_OUTSIDE_MARGIN:
5174 return Qoutside_margin;
5175 case GL_INSIDE_MARGIN:
5176 return Qinside_margin;
5181 return Qnil; /* unreached */
5185 static glyph_layout symbol_to_glyph_layout(Lisp_Object layout_obj)
5187 if (NILP(layout_obj))
5190 CHECK_SYMBOL(layout_obj);
5191 if (EQ(layout_obj, Qoutside_margin))
5192 return GL_OUTSIDE_MARGIN;
5193 if (EQ(layout_obj, Qinside_margin))
5194 return GL_INSIDE_MARGIN;
5195 if (EQ(layout_obj, Qwhitespace))
5196 return GL_WHITESPACE;
5197 if (EQ(layout_obj, Qtext))
5200 invalid_argument("Unknown glyph layout type", layout_obj);
5201 return GL_TEXT; /* unreached */
5205 set_extent_glyph_1(Lisp_Object extent_obj, Lisp_Object glyph, int endp,
5206 Lisp_Object layout_obj)
5208 EXTENT extent = decode_extent(extent_obj, 0);
5209 glyph_layout layout = symbol_to_glyph_layout(layout_obj);
5211 /* Make sure we've actually been given a valid glyph or it's nil
5212 (meaning we're deleting a glyph from an extent). */
5214 CHECK_BUFFER_GLYPH(glyph);
5216 set_extent_glyph(extent, glyph, endp, layout);
5220 DEFUN("set-extent-begin-glyph", Fset_extent_begin_glyph, 2, 3, 0, /*
5221 Display a bitmap, subwindow or string at the beginning of EXTENT.
5222 BEGIN-GLYPH must be a glyph object. The layout policy defaults to `text'.
5224 (extent, begin_glyph, layout))
5226 return set_extent_glyph_1(extent, begin_glyph, 0, layout);
5229 DEFUN("set-extent-end-glyph", Fset_extent_end_glyph, 2, 3, 0, /*
5230 Display a bitmap, subwindow or string at the end of EXTENT.
5231 END-GLYPH must be a glyph object. The layout policy defaults to `text'.
5233 (extent, end_glyph, layout))
5235 return set_extent_glyph_1(extent, end_glyph, 1, layout);
5238 DEFUN("extent-begin-glyph", Fextent_begin_glyph, 1, 1, 0, /*
5239 Return the glyph object displayed at the beginning of EXTENT.
5240 If there is none, nil is returned.
5244 return extent_begin_glyph(decode_extent(extent, 0));
5247 DEFUN("extent-end-glyph", Fextent_end_glyph, 1, 1, 0, /*
5248 Return the glyph object displayed at the end of EXTENT.
5249 If there is none, nil is returned.
5253 return extent_end_glyph(decode_extent(extent, 0));
5256 DEFUN("set-extent-begin-glyph-layout", Fset_extent_begin_glyph_layout, 2, 2, 0, /*
5257 Set the layout policy of EXTENT's begin glyph.
5258 Access this using the `extent-begin-glyph-layout' function.
5262 EXTENT e = decode_extent(extent, 0);
5263 e = extent_ancestor(e);
5264 extent_begin_glyph_layout(e) = symbol_to_glyph_layout(layout);
5265 extent_maybe_changed_for_redisplay(e, 1, 0);
5269 DEFUN("set-extent-end-glyph-layout", Fset_extent_end_glyph_layout, 2, 2, 0, /*
5270 Set the layout policy of EXTENT's end glyph.
5271 Access this using the `extent-end-glyph-layout' function.
5275 EXTENT e = decode_extent(extent, 0);
5276 e = extent_ancestor(e);
5277 extent_end_glyph_layout(e) = symbol_to_glyph_layout(layout);
5278 extent_maybe_changed_for_redisplay(e, 1, 0);
5282 DEFUN("extent-begin-glyph-layout", Fextent_begin_glyph_layout, 1, 1, 0, /*
5283 Return the layout policy associated with EXTENT's begin glyph.
5284 Set this using the `set-extent-begin-glyph-layout' function.
5288 EXTENT e = decode_extent(extent, 0);
5289 return glyph_layout_to_symbol((glyph_layout)
5290 extent_begin_glyph_layout(e));
5293 DEFUN("extent-end-glyph-layout", Fextent_end_glyph_layout, 1, 1, 0, /*
5294 Return the layout policy associated with EXTENT's end glyph.
5295 Set this using the `set-extent-end-glyph-layout' function.
5299 EXTENT e = decode_extent(extent, 0);
5300 return glyph_layout_to_symbol((glyph_layout)
5301 extent_end_glyph_layout(e));
5304 DEFUN("set-extent-priority", Fset_extent_priority, 2, 2, 0, /*
5305 Set the display priority of EXTENT to PRIORITY (an integer).
5306 When the extent attributes are being merged for display, the priority
5307 is used to determine which extent takes precedence in the event of a
5308 conflict (two extents whose faces both specify font, for example: the
5309 font of the extent with the higher priority will be used).
5310 Extents are created with priority 0; priorities may be negative.
5314 EXTENT e = decode_extent(extent, 0);
5316 CHECK_INT(priority);
5317 e = extent_ancestor(e);
5318 set_extent_priority(e, XINT(priority));
5319 extent_maybe_changed_for_redisplay(e, 1, 0);
5323 DEFUN("extent-priority", Fextent_priority, 1, 1, 0, /*
5324 Return the display priority of EXTENT; see `set-extent-priority'.
5328 EXTENT e = decode_extent(extent, 0);
5329 return make_int(extent_priority(e));
5332 DEFUN("set-extent-property", Fset_extent_property, 3, 3, 0, /*
5333 Change a property of an extent.
5334 PROPERTY may be any symbol; the value stored may be accessed with
5335 the `extent-property' function.
5336 The following symbols have predefined meanings:
5338 detached Removes the extent from its buffer; setting this is
5339 the same as calling `detach-extent'.
5341 destroyed Removes the extent from its buffer, and makes it
5342 unusable in the future; this is the same calling
5345 priority Change redisplay priority; same as `set-extent-priority'.
5347 start-open Whether the set of characters within the extent is
5348 treated being open on the left, that is, whether
5349 the start position is an exclusive, rather than
5350 inclusive, boundary. If true, then characters
5351 inserted exactly at the beginning of the extent
5352 will remain outside of the extent; otherwise they
5353 will go into the extent, extending it.
5355 end-open Whether the set of characters within the extent is
5356 treated being open on the right, that is, whether
5357 the end position is an exclusive, rather than
5358 inclusive, boundary. If true, then characters
5359 inserted exactly at the end of the extent will
5360 remain outside of the extent; otherwise they will
5361 go into the extent, extending it.
5363 By default, extents have the `end-open' but not the
5364 `start-open' property set.
5366 read-only Text within this extent will be unmodifiable.
5368 initial-redisplay-function (EXPERIMENTAL)
5369 function to be called the first time (part of) the extent
5370 is redisplayed. It will be called with the extent as its
5372 Note: The function will not be called immediately
5373 during redisplay, an eval event will be dispatched.
5375 detachable Whether the extent gets detached (as with
5376 `detach-extent') when all the text within the
5377 extent is deleted. This is true by default. If
5378 this property is not set, the extent becomes a
5379 zero-length extent when its text is deleted. (In
5380 such a case, the `start-open' property is
5381 automatically removed if both the `start-open' and
5382 `end-open' properties are set, since zero-length
5383 extents open on both ends are not allowed.)
5385 face The face in which to display the text. Setting
5386 this is the same as calling `set-extent-face'.
5388 mouse-face If non-nil, the extent will be highlighted in this
5389 face when the mouse moves over it.
5391 pointer If non-nil, and a valid pointer glyph, this specifies
5392 the shape of the mouse pointer while over the extent.
5394 highlight Obsolete: Setting this property is equivalent to
5395 setting a `mouse-face' property of `highlight'.
5396 Reading this property returns non-nil if
5397 the extent has a non-nil `mouse-face' property.
5399 duplicable Whether this extent should be copied into strings,
5400 so that kill, yank, and undo commands will restore
5401 or copy it. `duplicable' extents are copied from
5402 an extent into a string when `buffer-substring' or
5403 a similar function creates a string. The extents
5404 in a string are copied into other strings created
5405 from the string using `concat' or `substring'.
5406 When `insert' or a similar function inserts the
5407 string into a buffer, the extents are copied back
5410 unique Meaningful only in conjunction with `duplicable'.
5411 When this is set, there may be only one instance
5412 of this extent attached at a time: if it is copied
5413 to the kill ring and then yanked, the extent is
5414 not copied. If, however, it is killed (removed
5415 from the buffer) and then yanked, it will be
5416 re-attached at the new position.
5418 invisible If the value is non-nil, text under this extent
5419 may be treated as not present for the purpose of
5420 redisplay, or may be displayed using an ellipsis
5421 or other marker; see `buffer-invisibility-spec'
5422 and `invisible-text-glyph'. In all cases,
5423 however, the text is still visible to other
5424 functions that examine a buffer's text.
5426 keymap This keymap is consulted for mouse clicks on this
5427 extent, or keypresses made while point is within the
5430 copy-function This is a hook that is run when a duplicable extent
5431 is about to be copied from a buffer to a string (or
5432 the kill ring). It is called with three arguments,
5433 the extent, and the buffer-positions within it
5434 which are being copied. If this function returns
5435 nil, then the extent will not be copied; otherwise
5438 paste-function This is a hook that is run when a duplicable extent is
5439 about to be copied from a string (or the kill ring)
5440 into a buffer. It is called with three arguments,
5441 the original extent, and the buffer positions which
5442 the copied extent will occupy. (This hook is run
5443 after the corresponding text has already been
5444 inserted into the buffer.) Note that the extent
5445 argument may be detached when this function is run.
5446 If this function returns nil, no extent will be
5447 inserted. Otherwise, there will be an extent
5448 covering the range in question.
5450 If the original extent is not attached to a buffer,
5451 then it will be re-attached at this range.
5452 Otherwise, a copy will be made, and that copy
5455 The copy-function and paste-function are meaningful
5456 only for extents with the `duplicable' flag set,
5457 and if they are not specified, behave as if `t' was
5458 the returned value. When these hooks are invoked,
5459 the current buffer is the buffer which the extent
5460 is being copied from/to, respectively.
5462 begin-glyph A glyph to be displayed at the beginning of the extent,
5465 end-glyph A glyph to be displayed at the end of the extent,
5468 begin-glyph-layout The layout policy (one of `text', `whitespace',
5469 `inside-margin', or `outside-margin') of the extent's
5472 end-glyph-layout The layout policy of the extent's end glyph.
5474 syntax-table A cons or a syntax table object. If a cons, the car must
5475 be an integer (interpreted as a syntax code, applicable to
5476 all characters in the extent). Otherwise, syntax of
5477 characters in the extent is looked up in the syntax table.
5478 You should use the text property API to manipulate this
5479 property. (This may be required in the future.)
5481 (extent, property, value))
5483 /* This function can GC if property is `keymap' */
5484 EXTENT e = decode_extent(extent, 0);
5486 if (EQ(property, Qread_only))
5487 set_extent_read_only(e, value);
5488 else if (EQ(property, Qunique))
5489 extent_unique_p(e) = !NILP(value);
5490 else if (EQ(property, Qduplicable))
5491 extent_duplicable_p(e) = !NILP(value);
5492 else if (EQ(property, Qinvisible))
5493 set_extent_invisible(e, value);
5494 else if (EQ(property, Qdetachable))
5495 extent_detachable_p(e) = !NILP(value);
5497 else if (EQ(property, Qdetached)) {
5499 error("can only set `detached' to t");
5500 Fdetach_extent(extent);
5501 } else if (EQ(property, Qdestroyed)) {
5503 error("can only set `destroyed' to t");
5504 Fdelete_extent(extent);
5505 } else if (EQ(property, Qpriority))
5506 Fset_extent_priority(extent, value);
5507 else if (EQ(property, Qface))
5508 Fset_extent_face(extent, value);
5509 else if (EQ(property, Qinitial_redisplay_function))
5510 Fset_extent_initial_redisplay_function(extent, value);
5511 else if (EQ(property, Qbefore_change_functions))
5512 set_extent_before_change_functions(e, value);
5513 else if (EQ(property, Qafter_change_functions))
5514 set_extent_after_change_functions(e, value);
5515 else if (EQ(property, Qmouse_face))
5516 Fset_extent_mouse_face(extent, value);
5518 else if (EQ(property, Qhighlight))
5519 Fset_extent_mouse_face(extent, Qhighlight);
5520 else if (EQ(property, Qbegin_glyph_layout))
5521 Fset_extent_begin_glyph_layout(extent, value);
5522 else if (EQ(property, Qend_glyph_layout))
5523 Fset_extent_end_glyph_layout(extent, value);
5524 /* For backwards compatibility. We use begin glyph because it is by
5525 far the more used of the two. */
5526 else if (EQ(property, Qglyph_layout))
5527 Fset_extent_begin_glyph_layout(extent, value);
5528 else if (EQ(property, Qbegin_glyph))
5529 Fset_extent_begin_glyph(extent, value, Qnil);
5530 else if (EQ(property, Qend_glyph))
5531 Fset_extent_end_glyph(extent, value, Qnil);
5532 else if (EQ(property, Qstart_open))
5533 set_extent_openness(e, !NILP(value), -1);
5534 else if (EQ(property, Qend_open))
5535 set_extent_openness(e, -1, !NILP(value));
5536 /* Support (but don't document...) the obvious *_closed antonyms. */
5537 else if (EQ(property, Qstart_closed))
5538 set_extent_openness(e, NILP(value), -1);
5539 else if (EQ(property, Qend_closed))
5540 set_extent_openness(e, -1, NILP(value));
5542 if (EQ(property, Qkeymap))
5543 while (!NILP(value) && NILP(Fkeymapp(value)))
5544 value = wrong_type_argument(Qkeymapp, value);
5546 external_plist_put(extent_plist_addr(e), property, value, 0,
5553 DEFUN("set-extent-properties", Fset_extent_properties, 2, 2, 0, /*
5554 Change some properties of EXTENT.
5555 PLIST is a property list.
5556 For a list of built-in properties, see `set-extent-property'.
5560 /* This function can GC, if one of the properties is `keymap' */
5561 Lisp_Object property, value;
5562 struct gcpro gcpro1;
5565 plist = Fcopy_sequence(plist);
5566 Fcanonicalize_plist(plist, Qnil);
5568 while (!NILP(plist)) {
5569 property = Fcar(plist);
5570 plist = Fcdr(plist);
5571 value = Fcar(plist);
5572 plist = Fcdr(plist);
5573 Fset_extent_property(extent, property, value);
5579 DEFUN("extent-property", Fextent_property, 2, 3, 0, /*
5580 Return EXTENT's value for property PROPERTY.
5581 If no such property exists, DEFAULT is returned.
5582 See `set-extent-property' for the built-in property names.
5584 (extent, property, default_))
5586 EXTENT e = decode_extent(extent, 0);
5588 if (EQ(property, Qdetached))
5589 return extent_detached_p(e) ? Qt : Qnil;
5590 else if (EQ(property, Qdestroyed))
5591 return !EXTENT_LIVE_P(e) ? Qt : Qnil;
5592 else if (EQ(property, Qstart_open))
5593 return extent_normal_field(e, start_open) ? Qt : Qnil;
5594 else if (EQ(property, Qend_open))
5595 return extent_normal_field(e, end_open) ? Qt : Qnil;
5596 else if (EQ(property, Qunique))
5597 return extent_normal_field(e, unique) ? Qt : Qnil;
5598 else if (EQ(property, Qduplicable))
5599 return extent_normal_field(e, duplicable) ? Qt : Qnil;
5600 else if (EQ(property, Qdetachable))
5601 return extent_normal_field(e, detachable) ? Qt : Qnil;
5602 /* Support (but don't document...) the obvious *_closed antonyms. */
5603 else if (EQ(property, Qstart_closed))
5604 return extent_start_open_p(e) ? Qnil : Qt;
5605 else if (EQ(property, Qend_closed))
5606 return extent_end_open_p(e) ? Qnil : Qt;
5607 else if (EQ(property, Qpriority))
5608 return make_int(extent_priority(e));
5609 else if (EQ(property, Qread_only))
5610 return extent_read_only(e);
5611 else if (EQ(property, Qinvisible))
5612 return extent_invisible(e);
5613 else if (EQ(property, Qface))
5614 return Fextent_face(extent);
5615 else if (EQ(property, Qinitial_redisplay_function))
5616 return extent_initial_redisplay_function(e);
5617 else if (EQ(property, Qbefore_change_functions))
5618 return extent_before_change_functions(e);
5619 else if (EQ(property, Qafter_change_functions))
5620 return extent_after_change_functions(e);
5621 else if (EQ(property, Qmouse_face))
5622 return Fextent_mouse_face(extent);
5624 else if (EQ(property, Qhighlight))
5625 return !NILP(Fextent_mouse_face(extent)) ? Qt : Qnil;
5626 else if (EQ(property, Qbegin_glyph_layout))
5627 return Fextent_begin_glyph_layout(extent);
5628 else if (EQ(property, Qend_glyph_layout))
5629 return Fextent_end_glyph_layout(extent);
5630 /* For backwards compatibility. We use begin glyph because it is by
5631 far the more used of the two. */
5632 else if (EQ(property, Qglyph_layout))
5633 return Fextent_begin_glyph_layout(extent);
5634 else if (EQ(property, Qbegin_glyph))
5635 return extent_begin_glyph(e);
5636 else if (EQ(property, Qend_glyph))
5637 return extent_end_glyph(e);
5639 Lisp_Object value = external_plist_get(extent_plist_addr(e),
5640 property, 0, ERROR_ME);
5641 return UNBOUNDP(value) ? default_ : value;
5645 DEFUN("extent-properties", Fextent_properties, 1, 1, 0, /*
5646 Return a property list of the attributes of EXTENT.
5647 Do not modify this list; use `set-extent-property' instead.
5652 Lisp_Object result, face, anc_obj;
5653 glyph_layout layout;
5655 CHECK_EXTENT(extent);
5656 e = XEXTENT(extent);
5657 if (!EXTENT_LIVE_P(e))
5658 return cons3(Qdestroyed, Qt, Qnil);
5660 anc = extent_ancestor(e);
5661 XSETEXTENT(anc_obj, anc);
5663 /* For efficiency, use the ancestor for all properties except detached */
5665 result = extent_plist_slot(anc);
5667 if (!NILP(face = Fextent_face(anc_obj)))
5668 result = cons3(Qface, face, result);
5670 if (!NILP(face = Fextent_mouse_face(anc_obj)))
5671 result = cons3(Qmouse_face, face, result);
5673 if ((layout = (glyph_layout) extent_begin_glyph_layout(anc)) != GL_TEXT) {
5674 Lisp_Object sym = glyph_layout_to_symbol(layout);
5675 result = cons3(Qglyph_layout, sym, result); /* compatibility */
5676 result = cons3(Qbegin_glyph_layout, sym, result);
5679 if ((layout = (glyph_layout) extent_end_glyph_layout(anc)) != GL_TEXT)
5681 cons3(Qend_glyph_layout, glyph_layout_to_symbol(layout),
5684 if (!NILP(extent_end_glyph(anc)))
5685 result = cons3(Qend_glyph, extent_end_glyph(anc), result);
5687 if (!NILP(extent_begin_glyph(anc)))
5688 result = cons3(Qbegin_glyph, extent_begin_glyph(anc), result);
5690 if (extent_priority(anc) != 0)
5692 cons3(Qpriority, make_int(extent_priority(anc)), result);
5694 if (!NILP(extent_initial_redisplay_function(anc)))
5695 result = cons3(Qinitial_redisplay_function,
5696 extent_initial_redisplay_function(anc), result);
5698 if (!NILP(extent_before_change_functions(anc)))
5699 result = cons3(Qbefore_change_functions,
5700 extent_before_change_functions(anc), result);
5702 if (!NILP(extent_after_change_functions(anc)))
5703 result = cons3(Qafter_change_functions,
5704 extent_after_change_functions(anc), result);
5706 if (!NILP(extent_invisible(anc)))
5707 result = cons3(Qinvisible, extent_invisible(anc), result);
5709 if (!NILP(extent_read_only(anc)))
5710 result = cons3(Qread_only, extent_read_only(anc), result);
5712 if (extent_normal_field(anc, end_open))
5713 result = cons3(Qend_open, Qt, result);
5715 if (extent_normal_field(anc, start_open))
5716 result = cons3(Qstart_open, Qt, result);
5718 if (extent_normal_field(anc, detachable))
5719 result = cons3(Qdetachable, Qt, result);
5721 if (extent_normal_field(anc, duplicable))
5722 result = cons3(Qduplicable, Qt, result);
5724 if (extent_normal_field(anc, unique))
5725 result = cons3(Qunique, Qt, result);
5727 /* detached is not an inherited property */
5728 if (extent_detached_p(e))
5729 result = cons3(Qdetached, Qt, result);
5734 /************************************************************************/
5736 /************************************************************************/
5738 /* The display code looks into the Vlast_highlighted_extent variable to
5739 correctly display highlighted extents. This updates that variable,
5740 and marks the appropriate buffers as needing some redisplay.
5742 static void do_highlight(Lisp_Object extent_obj, int highlight_p)
5744 if ((highlight_p && (EQ(Vlast_highlighted_extent, extent_obj))) ||
5745 (!highlight_p && (EQ(Vlast_highlighted_extent, Qnil))))
5747 if (EXTENTP(Vlast_highlighted_extent) &&
5748 EXTENT_LIVE_P(XEXTENT(Vlast_highlighted_extent))) {
5749 /* do not recurse on descendants. Only one extent is highlighted
5751 extent_changed_for_redisplay(XEXTENT(Vlast_highlighted_extent),
5754 Vlast_highlighted_extent = Qnil;
5755 if (!NILP(extent_obj)
5756 && BUFFERP(extent_object(XEXTENT(extent_obj)))
5758 extent_changed_for_redisplay(XEXTENT(extent_obj), 0, 0);
5759 Vlast_highlighted_extent = extent_obj;
5763 DEFUN("force-highlight-extent", Fforce_highlight_extent, 1, 2, 0, /*
5764 Highlight or unhighlight the given extent.
5765 If the second arg is non-nil, it will be highlighted, else dehighlighted.
5766 This is the same as `highlight-extent', except that it will work even
5767 on extents without the `mouse-face' property.
5769 (extent, highlight_p))
5774 XSETEXTENT(extent, decode_extent(extent, DE_MUST_BE_ATTACHED));
5775 do_highlight(extent, !NILP(highlight_p));
5779 DEFUN("highlight-extent", Fhighlight_extent, 1, 2, 0, /*
5780 Highlight EXTENT, if it is highlightable.
5781 \(that is, if it has the `mouse-face' property).
5782 If the second arg is non-nil, it will be highlighted, else dehighlighted.
5783 Highlighted extents are displayed as if they were merged with the face
5784 or faces specified by the `mouse-face' property.
5786 (extent, highlight_p))
5788 if (EXTENTP(extent) && NILP(extent_mouse_face(XEXTENT(extent))))
5791 return Fforce_highlight_extent(extent, highlight_p);
5794 /************************************************************************/
5795 /* strings and extents */
5796 /************************************************************************/
5798 /* copy/paste hooks */
5801 run_extent_copy_paste_internal(EXTENT e, Bufpos from, Bufpos to,
5802 Lisp_Object object, Lisp_Object prop)
5804 /* This function can GC */
5806 Lisp_Object copy_fn;
5807 XSETEXTENT(extent, e);
5808 copy_fn = Fextent_property(extent, prop, Qnil);
5809 if (!NILP(copy_fn)) {
5811 struct gcpro gcpro1, gcpro2, gcpro3;
5812 GCPRO3(extent, copy_fn, object);
5813 if (BUFFERP(object))
5814 flag = call3_in_buffer(XBUFFER(object), copy_fn, extent,
5815 make_int(from), make_int(to));
5818 call3(copy_fn, extent, make_int(from),
5821 if (NILP(flag) || !EXTENT_LIVE_P(XEXTENT(extent)))
5827 static int run_extent_copy_function(EXTENT e, Bytind from, Bytind to)
5829 Lisp_Object object = extent_object(e);
5830 /* This function can GC */
5831 return run_extent_copy_paste_internal
5832 (e, buffer_or_string_bytind_to_bufpos(object, from),
5833 buffer_or_string_bytind_to_bufpos(object, to), object,
5838 run_extent_paste_function(EXTENT e, Bytind from, Bytind to, Lisp_Object object)
5840 /* This function can GC */
5841 return run_extent_copy_paste_internal
5842 (e, buffer_or_string_bytind_to_bufpos(object, from),
5843 buffer_or_string_bytind_to_bufpos(object, to), object,
5847 static void update_extent(EXTENT extent, Bytind from, Bytind to)
5849 set_extent_endpoints(extent, from, to, Qnil);
5852 /* Insert an extent, usually from the dup_list of a string which
5853 has just been inserted.
5854 This code does not handle the case of undo.
5857 insert_extent(EXTENT extent, Bytind new_start, Bytind new_end,
5858 Lisp_Object object, int run_hooks)
5860 /* This function can GC */
5863 if (!EQ(extent_object(extent), object))
5866 if (extent_detached_p(extent)) {
5868 !run_extent_paste_function(extent, new_start, new_end,
5870 /* The paste-function said don't re-attach this extent here. */
5873 update_extent(extent, new_start, new_end);
5875 Bytind exstart = extent_endpoint_bytind(extent, 0);
5876 Bytind exend = extent_endpoint_bytind(extent, 1);
5878 if (exend < new_start || exstart > new_end)
5881 new_start = min(exstart, new_start);
5882 new_end = max(exend, new_end);
5883 if (exstart != new_start || exend != new_end)
5884 update_extent(extent, new_start, new_end);
5888 XSETEXTENT(tmp, extent);
5893 !run_extent_paste_function(extent, new_start, new_end, object))
5894 /* The paste-function said don't attach a copy of the extent here. */
5898 copy_extent(extent, new_start, new_end, object));
5903 DEFUN("insert-extent", Finsert_extent, 1, 5, 0, /*
5904 Insert EXTENT from START to END in BUFFER-OR-STRING.
5905 BUFFER-OR-STRING defaults to the current buffer if omitted.
5906 This operation does not insert any characters,
5907 but otherwise acts as if there were a replicating extent whose
5908 parent is EXTENT in some string that was just inserted.
5909 Returns the newly-inserted extent.
5910 The fourth arg, NO-HOOKS, can be used to inhibit the running of the
5911 extent's `paste-function' property if it has one.
5912 See documentation on `detach-extent' for a discussion of undo recording.
5914 (extent, start, end, no_hooks, buffer_or_string))
5916 EXTENT ext = decode_extent(extent, 0);
5920 buffer_or_string = decode_buffer_or_string(buffer_or_string);
5921 get_buffer_or_string_range_byte(buffer_or_string, start, end, &s, &e,
5922 GB_ALLOW_PAST_ACCESSIBLE);
5924 copy = insert_extent(ext, s, e, buffer_or_string, NILP(no_hooks));
5925 if (EXTENTP(copy)) {
5926 if (extent_duplicable_p(XEXTENT(copy)))
5927 record_extent(copy, 1);
5932 /* adding buffer extents to a string */
5934 struct add_string_extents_arg {
5940 static int add_string_extents_mapper(EXTENT extent, void *arg)
5942 /* This function can GC */
5943 struct add_string_extents_arg *closure =
5944 (struct add_string_extents_arg *)arg;
5945 Bytecount start = extent_endpoint_bytind(extent, 0) - closure->from;
5946 Bytecount end = extent_endpoint_bytind(extent, 1) - closure->from;
5948 if (extent_duplicable_p(extent)) {
5949 start = max(start, 0);
5950 end = min(end, closure->length);
5952 /* Run the copy-function to give an extent the option of
5953 not being copied into the string (or kill ring).
5955 if (extent_duplicable_p(extent) &&
5956 !run_extent_copy_function(extent, start + closure->from,
5957 end + closure->from))
5959 copy_extent(extent, start, end, closure->string);
5965 /* Add the extents in buffer BUF from OPOINT to OPOINT+LENGTH to
5966 the string STRING. */
5968 add_string_extents(Lisp_Object string, struct buffer *buf, Bytind opoint,
5971 /* This function can GC */
5972 struct add_string_extents_arg closure;
5973 struct gcpro gcpro1, gcpro2;
5976 closure.from = opoint;
5977 closure.length = length;
5978 closure.string = string;
5979 buffer = make_buffer(buf);
5980 GCPRO2(buffer, string);
5981 map_extents_bytind(opoint, opoint + length, add_string_extents_mapper,
5982 (void *)&closure, buffer, 0,
5983 /* ignore extents that just abut the region */
5984 ME_END_CLOSED | ME_ALL_EXTENTS_OPEN |
5985 /* we are calling E-Lisp (the extent's copy function)
5986 so anything might happen */
5987 ME_MIGHT_CALL_ELISP);
5991 struct splice_in_string_extents_arg {
5998 static int splice_in_string_extents_mapper(EXTENT extent, void *arg)
6000 /* This function can GC */
6001 struct splice_in_string_extents_arg *closure =
6002 (struct splice_in_string_extents_arg *)arg;
6003 /* BASE_START and BASE_END are the limits in the buffer of the string
6004 that was just inserted.
6006 NEW_START and NEW_END are the prospective buffer positions of the
6007 extent that is going into the buffer. */
6008 Bytind base_start = closure->opoint;
6009 Bytind base_end = base_start + closure->length;
6010 Bytind new_start = (base_start + extent_endpoint_bytind(extent, 0) -
6012 Bytind new_end = (base_start + extent_endpoint_bytind(extent, 1) -
6015 if (new_start < base_start)
6016 new_start = base_start;
6017 if (new_end > base_end)
6019 if (new_end <= new_start)
6022 if (!extent_duplicable_p(extent))
6026 !run_extent_paste_function(extent, new_start, new_end,
6029 copy_extent(extent, new_start, new_end, closure->buffer);
6034 /* We have just inserted a section of STRING (starting at POS, of
6035 length LENGTH) into buffer BUF at OPOINT. Do whatever is necessary
6036 to get the string's extents into the buffer. */
6039 splice_in_string_extents(Lisp_Object string, struct buffer *buf,
6040 Bytind opoint, Bytecount length, Bytecount pos)
6042 struct splice_in_string_extents_arg closure;
6043 struct gcpro gcpro1, gcpro2;
6046 buffer = make_buffer(buf);
6047 closure.opoint = opoint;
6049 closure.length = length;
6050 closure.buffer = buffer;
6051 GCPRO2(buffer, string);
6052 map_extents_bytind(pos, pos + length,
6053 splice_in_string_extents_mapper,
6054 (void *)&closure, string, 0,
6055 /* ignore extents that just abut the region */
6056 ME_END_CLOSED | ME_ALL_EXTENTS_OPEN |
6057 /* we are calling E-Lisp (the extent's copy function)
6058 so anything might happen */
6059 ME_MIGHT_CALL_ELISP);
6063 struct copy_string_extents_arg {
6067 Lisp_Object new_string;
6070 struct copy_string_extents_1_arg {
6071 Lisp_Object parent_in_question;
6072 EXTENT found_extent;
6075 static int copy_string_extents_mapper(EXTENT extent, void *arg)
6077 struct copy_string_extents_arg *closure =
6078 (struct copy_string_extents_arg *)arg;
6079 Bytecount old_start, old_end, new_start, new_end;
6081 old_start = extent_endpoint_bytind(extent, 0);
6082 old_end = extent_endpoint_bytind(extent, 1);
6084 old_start = max(closure->old_pos, old_start);
6085 old_end = min(closure->old_pos + closure->length, old_end);
6087 if (old_start >= old_end)
6090 new_start = old_start + closure->new_pos - closure->old_pos;
6091 new_end = old_end + closure->new_pos - closure->old_pos;
6093 copy_extent(extent, new_start, new_end, closure->new_string);
6097 /* The string NEW_STRING was partially constructed from OLD_STRING.
6098 In particular, the section of length LEN starting at NEW_POS in
6099 NEW_STRING came from the section of the same length starting at
6100 OLD_POS in OLD_STRING. Copy the extents as appropriate. */
6103 copy_string_extents(Lisp_Object new_string, Lisp_Object old_string,
6104 Bytecount new_pos, Bytecount old_pos, Bytecount length)
6106 struct copy_string_extents_arg closure;
6107 struct gcpro gcpro1, gcpro2;
6109 closure.new_pos = new_pos;
6110 closure.old_pos = old_pos;
6111 closure.new_string = new_string;
6112 closure.length = length;
6113 GCPRO2(new_string, old_string);
6114 map_extents_bytind(old_pos, old_pos + length,
6115 copy_string_extents_mapper,
6116 (void *)&closure, old_string, 0,
6117 /* ignore extents that just abut the region */
6118 ME_END_CLOSED | ME_ALL_EXTENTS_OPEN |
6119 /* we are calling E-Lisp (the extent's copy function)
6120 so anything might happen */
6121 ME_MIGHT_CALL_ELISP);
6125 /* Checklist for sanity checking:
6126 - {kill, yank, copy} at {open, closed} {start, end} of {writable, read-only} extent
6127 - {kill, copy} & yank {once, repeatedly} duplicable extent in {same, different} buffer
6130 /************************************************************************/
6131 /* text properties */
6132 /************************************************************************/
6135 Originally this stuff was implemented in lisp (all of the functionality
6136 exists to make that possible) but speed was a problem.
6139 Lisp_Object Qtext_prop;
6140 Lisp_Object Qtext_prop_extent_paste_function;
6143 get_text_property_bytind(Bytind position, Lisp_Object prop,
6144 Lisp_Object object, enum extent_at_flag fl,
6145 int text_props_only)
6149 /* text_props_only specifies whether we only consider text-property
6150 extents (those with the 'text-prop property set) or all extents. */
6151 if (!text_props_only)
6152 extent = extent_at_bytind(position, object, prop, 0, fl, 0);
6157 extent_at_bytind(position, object, Qtext_prop,
6162 (prop, Fextent_property(extent, Qtext_prop, Qnil)))
6164 prior = XEXTENT(extent);
6169 return Fextent_property(extent, prop, Qnil);
6170 if (!NILP(Vdefault_text_properties))
6171 return Fplist_get(Vdefault_text_properties, prop, Qnil);
6176 get_text_property_1(Lisp_Object pos, Lisp_Object prop, Lisp_Object object,
6177 Lisp_Object at_flag, int text_props_only)
6182 object = decode_buffer_or_string(object);
6184 get_buffer_or_string_pos_byte(object, pos, GB_NO_ERROR_IF_BAD);
6186 /* We canonicalize the start/end-open/closed properties to the
6187 non-default version -- "adding" the default property really
6188 needs to remove the non-default one. See below for more
6190 if (EQ(prop, Qstart_closed)) {
6195 if (EQ(prop, Qend_open)) {
6202 get_text_property_bytind(position, prop, object,
6203 decode_extent_at_flag(at_flag),
6206 val = NILP(val) ? Qt : Qnil;
6211 DEFUN("get-text-property", Fget_text_property, 2, 4, 0, /*
6212 Return the value of the PROP property at the given position.
6213 Optional arg OBJECT specifies the buffer or string to look in, and
6214 defaults to the current buffer.
6215 Optional arg AT-FLAG controls what it means for a property to be "at"
6216 a position, and has the same meaning as in `extent-at'.
6217 This examines only those properties added with `put-text-property'.
6218 See also `get-char-property'.
6220 (pos, prop, object, at_flag))
6222 return get_text_property_1(pos, prop, object, at_flag, 1);
6225 DEFUN("get-char-property", Fget_char_property, 2, 4, 0, /*
6226 Return the value of the PROP property at the given position.
6227 Optional arg OBJECT specifies the buffer or string to look in, and
6228 defaults to the current buffer.
6229 Optional arg AT-FLAG controls what it means for a property to be "at"
6230 a position, and has the same meaning as in `extent-at'.
6231 This examines properties on all extents.
6232 See also `get-text-property'.
6234 (pos, prop, object, at_flag))
6236 return get_text_property_1(pos, prop, object, at_flag, 0);
6239 /* About start/end-open/closed:
6241 These properties have to be handled specially because of their
6242 strange behavior. If I put the "start-open" property on a region,
6243 then *all* text-property extents in the region have to have their
6244 start be open. This is unlike all other properties, which don't
6245 affect the extents of text properties other than their own.
6249 1) We have to map start-closed to (not start-open) and end-open
6250 to (not end-closed) -- i.e. adding the default is really the
6251 same as remove the non-default property. It won't work, for
6252 example, to have both "start-open" and "start-closed" on
6254 2) Whenever we add one of these properties, we go through all
6255 text-property extents in the region and set the appropriate
6256 open/closedness on them.
6257 3) Whenever we change a text-property extent for a property,
6258 we have to make sure we set the open/closedness properly.
6260 (2) and (3) together rely on, and maintain, the invariant
6261 that the open/closedness of text-property extents is correct
6262 at the beginning and end of each operation.
6265 struct put_text_prop_arg {
6266 Lisp_Object prop, value; /* The property and value we are storing */
6267 Bytind start, end; /* The region into which we are storing it */
6269 Lisp_Object the_extent; /* Our chosen extent; this is used for
6270 communication between subsequent passes. */
6271 int changed_p; /* Output: whether we have modified anything */
6274 static int put_text_prop_mapper(EXTENT e, void *arg)
6276 struct put_text_prop_arg *closure = (struct put_text_prop_arg *)arg;
6278 Lisp_Object object = closure->object;
6279 Lisp_Object value = closure->value;
6280 Bytind e_start, e_end;
6281 Bytind start = closure->start;
6282 Bytind end = closure->end;
6283 Lisp_Object extent, e_val;
6286 XSETEXTENT(extent, e);
6288 /* Note: in some cases when the property itself is 'start-open
6289 or 'end-closed, the checks to set the openness may do a bit
6290 of extra work; but it won't hurt because we then fix up the
6291 openness later on in put_text_prop_openness_mapper(). */
6292 if (!EQ(Fextent_property(extent, Qtext_prop, Qnil), closure->prop))
6293 /* It's not for this property; do nothing. */
6296 e_start = extent_endpoint_bytind(e, 0);
6297 e_end = extent_endpoint_bytind(e, 1);
6298 e_val = Fextent_property(extent, closure->prop, Qnil);
6299 is_eq = EQ(value, e_val);
6301 if (!NILP(value) && NILP(closure->the_extent) && is_eq) {
6302 /* We want there to be an extent here at the end, and we haven't picked
6303 one yet, so use this one. Extend it as necessary. We only reuse an
6304 extent which has an EQ value for the prop in question to avoid
6305 side-effecting the kill ring (that is, we never change the property
6306 on an extent after it has been created.)
6308 if (e_start != start || e_end != end) {
6309 Bytind new_start = min(e_start, start);
6310 Bytind new_end = max(e_end, end);
6311 set_extent_endpoints(e, new_start, new_end, Qnil);
6312 /* If we changed the endpoint, then we need to set its
6314 set_extent_openness(e, new_start != e_start
6315 ? !NILP(get_text_property_bytind
6316 (start, Qstart_open, object,
6317 EXTENT_AT_AFTER, 1)) : -1,
6319 ? NILP(get_text_property_bytind
6320 (end - 1, Qend_closed,
6321 object, EXTENT_AT_AFTER, 1))
6323 closure->changed_p = 1;
6325 closure->the_extent = extent;
6328 /* Even if we're adding a prop, at this point, we want all other extents of
6329 this prop to go away (as now they overlap). So the theory here is that,
6330 when we are adding a prop to a region that has multiple (disjoint)
6331 occurrences of that prop in it already, we pick one of those and extend
6332 it, and remove the others.
6335 else if (EQ(extent, closure->the_extent)) {
6336 /* just in case map-extents hits it again (does that happen?) */
6338 } else if (e_start >= start && e_end <= end) {
6339 /* Extent is contained in region; remove it. Don't destroy or modify
6340 it, because we don't want to change the attributes pointed to by the
6341 duplicates in the kill ring.
6344 closure->changed_p = 1;
6345 } else if (!NILP(closure->the_extent) &&
6346 is_eq && e_start <= end && e_end >= start) {
6347 EXTENT te = XEXTENT(closure->the_extent);
6348 /* This extent overlaps, and has the same prop/value as the extent we've
6349 decided to reuse, so we can remove this existing extent as well (the
6350 whole thing, even the part outside of the region) and extend
6351 the-extent to cover it, resulting in the minimum number of extents in
6354 Bytind the_start = extent_endpoint_bytind(te, 0);
6355 Bytind the_end = extent_endpoint_bytind(te, 1);
6356 if (e_start != the_start && /* note AND not OR -- hmm, why is this
6357 the case? I think it's because the
6358 assumption that the text-property
6359 extents don't overlap makes it
6360 OK; changing it to an OR would
6361 result in changed_p sometimes getting
6362 falsely marked. Is this bad? */
6364 Bytind new_start = min(e_start, the_start);
6365 Bytind new_end = max(e_end, the_end);
6366 set_extent_endpoints(te, new_start, new_end, Qnil);
6367 /* If we changed the endpoint, then we need to set its
6368 openness. We are setting the endpoint to be the same as
6369 that of the extent we're about to remove, and we assume
6370 (the invariant mentioned above) that extent has the
6371 proper endpoint setting, so we just use it. */
6372 set_extent_openness(te, new_start != e_start ?
6373 (int)extent_start_open_p(e) : -1,
6375 (int)extent_end_open_p(e) : -1);
6376 closure->changed_p = 1;
6379 } else if (e_end <= end) {
6380 /* Extent begins before start but ends before end, so we can just
6381 decrease its end position.
6383 if (e_end != start) {
6384 set_extent_endpoints(e, e_start, start, Qnil);
6385 set_extent_openness(e, -1, NILP(get_text_property_bytind
6386 (start - 1, Qend_closed,
6388 EXTENT_AT_AFTER, 1)));
6389 closure->changed_p = 1;
6391 } else if (e_start >= start) {
6392 /* Extent ends after end but begins after start, so we can just
6393 increase its start position.
6395 if (e_start != end) {
6396 set_extent_endpoints(e, end, e_end, Qnil);
6397 set_extent_openness(e, !NILP(get_text_property_bytind
6398 (end, Qstart_open, object,
6399 EXTENT_AT_AFTER, 1)), -1);
6400 closure->changed_p = 1;
6403 /* Otherwise, `extent' straddles the region. We need to split it.
6405 set_extent_endpoints(e, e_start, start, Qnil);
6406 set_extent_openness(e, -1, NILP(get_text_property_bytind
6407 (start - 1, Qend_closed, object,
6408 EXTENT_AT_AFTER, 1)));
6409 set_extent_openness(copy_extent
6410 (e, end, e_end, extent_object(e)),
6411 !NILP(get_text_property_bytind
6412 (end, Qstart_open, object,
6413 EXTENT_AT_AFTER, 1)), -1);
6414 closure->changed_p = 1;
6417 return 0; /* to continue mapping. */
6420 static int put_text_prop_openness_mapper(EXTENT e, void *arg)
6422 struct put_text_prop_arg *closure = (struct put_text_prop_arg *)arg;
6423 Bytind e_start, e_end;
6424 Bytind start = closure->start;
6425 Bytind end = closure->end;
6427 XSETEXTENT(extent, e);
6428 e_start = extent_endpoint_bytind(e, 0);
6429 e_end = extent_endpoint_bytind(e, 1);
6431 if (NILP(Fextent_property(extent, Qtext_prop, Qnil))) {
6432 /* It's not a text-property extent; do nothing. */
6435 /* Note end conditions and NILP/!NILP's carefully. */
6436 else if (EQ(closure->prop, Qstart_open)
6437 && e_start >= start && e_start < end)
6438 set_extent_openness(e, !NILP(closure->value), -1);
6439 else if (EQ(closure->prop, Qend_closed)
6440 && e_end > start && e_end <= end)
6441 set_extent_openness(e, -1, NILP(closure->value));
6443 return 0; /* to continue mapping. */
6447 put_text_prop(Bytind start, Bytind end, Lisp_Object object,
6448 Lisp_Object prop, Lisp_Object value, int duplicable_p)
6450 /* This function can GC */
6451 struct put_text_prop_arg closure;
6453 if (start == end) /* There are no characters in the region. */
6456 /* convert to the non-default versions, since a nil property is
6457 the same as it not being present. */
6458 if (EQ(prop, Qstart_closed)) {
6460 value = NILP(value) ? Qt : Qnil;
6461 } else if (EQ(prop, Qend_open)) {
6463 value = NILP(value) ? Qt : Qnil;
6466 value = canonicalize_extent_property(prop, value);
6468 closure.prop = prop;
6469 closure.value = value;
6470 closure.start = start;
6472 closure.object = object;
6473 closure.changed_p = 0;
6474 closure.the_extent = Qnil;
6476 map_extents_bytind(start, end,
6477 put_text_prop_mapper, (void *)&closure, object, 0,
6478 /* get all extents that abut the region */
6479 ME_ALL_EXTENTS_CLOSED | ME_END_CLOSED |
6480 /* it might QUIT or error if the user has
6481 fucked with the extent plist. */
6482 /* #### dmoore - I think this should include
6483 ME_MIGHT_MOVE_SOE, since the callback function
6484 might recurse back into map_extents_bytind. */
6485 ME_MIGHT_THROW | ME_MIGHT_MODIFY_EXTENTS);
6487 /* If we made it through the loop without reusing an extent
6488 (and we want there to be one) make it now.
6490 if (!NILP(value) && NILP(closure.the_extent)) {
6493 XSETEXTENT(extent, make_extent_internal(object, start, end));
6494 closure.changed_p = 1;
6495 Fset_extent_property(extent, Qtext_prop, prop);
6496 Fset_extent_property(extent, prop, value);
6498 extent_duplicable_p(XEXTENT(extent)) = 1;
6499 Fset_extent_property(extent, Qpaste_function,
6500 Qtext_prop_extent_paste_function);
6502 set_extent_openness(XEXTENT(extent),
6503 !NILP(get_text_property_bytind
6504 (start, Qstart_open, object,
6505 EXTENT_AT_AFTER, 1)),
6506 NILP(get_text_property_bytind
6507 (end - 1, Qend_closed, object,
6508 EXTENT_AT_AFTER, 1)));
6511 if (EQ(prop, Qstart_open) || EQ(prop, Qend_closed)) {
6512 map_extents_bytind(start, end,
6513 put_text_prop_openness_mapper,
6514 (void *)&closure, object, 0,
6515 /* get all extents that abut the region */
6516 ME_ALL_EXTENTS_CLOSED | ME_END_CLOSED |
6517 ME_MIGHT_MODIFY_EXTENTS);
6520 return closure.changed_p;
6523 DEFUN("put-text-property", Fput_text_property, 4, 5, 0, /*
6524 Adds the given property/value to all characters in the specified region.
6525 The property is conceptually attached to the characters rather than the
6526 region. The properties are copied when the characters are copied/pasted.
6527 Fifth argument OBJECT is the buffer or string containing the text, and
6528 defaults to the current buffer.
6530 (start, end, prop, value, object))
6532 /* This function can GC */
6535 object = decode_buffer_or_string(object);
6536 get_buffer_or_string_range_byte(object, start, end, &s, &e, 0);
6537 put_text_prop(s, e, object, prop, value, 1);
6541 DEFUN("put-nonduplicable-text-property", Fput_nonduplicable_text_property, 4, 5, 0, /*
6542 Adds the given property/value to all characters in the specified region.
6543 The property is conceptually attached to the characters rather than the
6544 region, however the properties will not be copied when the characters
6546 Fifth argument OBJECT is the buffer or string containing the text, and
6547 defaults to the current buffer.
6549 (start, end, prop, value, object))
6551 /* This function can GC */
6554 object = decode_buffer_or_string(object);
6555 get_buffer_or_string_range_byte(object, start, end, &s, &e, 0);
6556 put_text_prop(s, e, object, prop, value, 0);
6560 DEFUN("add-text-properties", Fadd_text_properties, 3, 4, 0, /*
6561 Add properties to the characters from START to END.
6562 The third argument PROPS is a property list specifying the property values
6563 to add. The optional fourth argument, OBJECT, is the buffer or string
6564 containing the text and defaults to the current buffer. Returns t if
6565 any property was changed, nil otherwise.
6567 (start, end, props, object))
6569 /* This function can GC */
6573 object = decode_buffer_or_string(object);
6574 get_buffer_or_string_range_byte(object, start, end, &s, &e, 0);
6576 for (; !NILP(props); props = Fcdr(Fcdr(props))) {
6577 Lisp_Object prop = XCAR(props);
6578 Lisp_Object value = Fcar(XCDR(props));
6579 changed |= put_text_prop(s, e, object, prop, value, 1);
6581 return changed ? Qt : Qnil;
6584 DEFUN("add-nonduplicable-text-properties", Fadd_nonduplicable_text_properties, 3, 4, 0, /*
6585 Add nonduplicable properties to the characters from START to END.
6586 \(The properties will not be copied when the characters are copied.)
6587 The third argument PROPS is a property list specifying the property values
6588 to add. The optional fourth argument, OBJECT, is the buffer or string
6589 containing the text and defaults to the current buffer. Returns t if
6590 any property was changed, nil otherwise.
6592 (start, end, props, object))
6594 /* This function can GC */
6598 object = decode_buffer_or_string(object);
6599 get_buffer_or_string_range_byte(object, start, end, &s, &e, 0);
6601 for (; !NILP(props); props = Fcdr(Fcdr(props))) {
6602 Lisp_Object prop = XCAR(props);
6603 Lisp_Object value = Fcar(XCDR(props));
6604 changed |= put_text_prop(s, e, object, prop, value, 0);
6606 return changed ? Qt : Qnil;
6609 DEFUN("remove-text-properties", Fremove_text_properties, 3, 4, 0, /*
6610 Remove the given properties from all characters in the specified region.
6611 PROPS should be a plist, but the values in that plist are ignored (treated
6612 as nil). Returns t if any property was changed, nil otherwise.
6613 Fourth argument OBJECT is the buffer or string containing the text, and
6614 defaults to the current buffer.
6616 (start, end, props, object))
6618 /* This function can GC */
6622 object = decode_buffer_or_string(object);
6623 get_buffer_or_string_range_byte(object, start, end, &s, &e, 0);
6625 for (; !NILP(props); props = Fcdr(Fcdr(props))) {
6626 Lisp_Object prop = XCAR(props);
6627 changed |= put_text_prop(s, e, object, prop, Qnil, 1);
6629 return changed ? Qt : Qnil;
6632 /* Whenever a text-prop extent is pasted into a buffer (via `yank' or `insert'
6633 or whatever) we attach the properties to the buffer by calling
6634 `put-text-property' instead of by simply allowing the extent to be copied or
6635 re-attached. Then we return nil, telling the extents code not to attach it
6636 again. By handing the insertion hackery in this way, we make kill/yank
6637 behave consistently with put-text-property and not fragment the extents
6638 (since text-prop extents must partition, not overlap).
6640 The lisp implementation of this was probably fast enough, but since I moved
6641 the rest of the put-text-prop code here, I moved this as well for
6644 DEFUN("text-prop-extent-paste-function", Ftext_prop_extent_paste_function, 3, 3, 0, /*
6645 Used as the `paste-function' property of `text-prop' extents.
6649 /* This function can GC */
6650 Lisp_Object prop, val;
6652 prop = Fextent_property(extent, Qtext_prop, Qnil);
6654 signal_type_error(Qinternal_error,
6655 "Internal error: no text-prop", extent);
6656 val = Fextent_property(extent, prop, Qnil);
6658 /* removed by bill perry, 2/9/97
6659 ** This little bit of code would not allow you to have a text property
6660 ** with a value of Qnil. This is bad bad bad.
6663 signal_type_error_2(Qinternal_error,
6664 "Internal error: no text-prop",
6667 Fput_text_property(from, to, prop, val, Qnil);
6668 return Qnil; /* important! */
6671 /* This function could easily be written in Lisp but the C code wants
6672 to use it in connection with invisible extents (at least currently).
6673 If this changes, consider moving this back into Lisp. */
6675 DEFUN("next-single-property-change", Fnext_single_property_change, 2, 4, 0, /*
6676 Return the position of next property change for a specific property.
6677 Scans characters forward from POS till it finds a change in the PROP
6678 property, then returns the position of the change. The optional third
6679 argument OBJECT is the buffer or string to scan (defaults to the current
6681 The property values are compared with `eq'.
6682 Return nil if the property is constant all the way to the end of OBJECT.
6683 If the value is non-nil, it is a position greater than POS, never equal.
6685 If the optional fourth argument LIMIT is non-nil, don't search
6686 past position LIMIT; return LIMIT if nothing is found before LIMIT.
6687 If two or more extents with conflicting non-nil values for PROP overlap
6688 a particular character, it is undefined which value is considered to be
6689 the value of PROP. (Note that this situation will not happen if you always
6690 use the text-property primitives.)
6692 (pos, prop, object, limit))
6696 Lisp_Object extent, value;
6699 object = decode_buffer_or_string(object);
6700 bpos = get_buffer_or_string_pos_char(object, pos, 0);
6702 blim = buffer_or_string_accessible_end_char(object);
6705 blim = get_buffer_or_string_pos_char(object, limit, 0);
6709 extent = Fextent_at(make_int(bpos), object, prop, Qnil, Qnil);
6711 value = Fextent_property(extent, prop, Qnil);
6716 bpos = XINT(Fnext_extent_change(make_int(bpos), object));
6718 break; /* property is the same all the way to the end */
6719 extent = Fextent_at(make_int(bpos), object, prop, Qnil, Qnil);
6720 if ((NILP(extent) && !NILP(value)) ||
6721 (!NILP(extent) && !EQ(value,
6722 Fextent_property(extent, prop,
6724 return make_int(bpos);
6727 /* I think it's more sensible for this function to return nil always
6728 in this situation and it used to do it this way, but it's been changed
6729 for FSF compatibility. */
6733 return make_int(blim);
6736 /* See comment on previous function about why this is written in C. */
6738 DEFUN("previous-single-property-change", Fprevious_single_property_change, 2, 4, 0, /*
6739 Return the position of next property change for a specific property.
6740 Scans characters backward from POS till it finds a change in the PROP
6741 property, then returns the position of the change. The optional third
6742 argument OBJECT is the buffer or string to scan (defaults to the current
6744 The property values are compared with `eq'.
6745 Return nil if the property is constant all the way to the start of OBJECT.
6746 If the value is non-nil, it is a position less than POS, never equal.
6748 If the optional fourth argument LIMIT is non-nil, don't search back
6749 past position LIMIT; return LIMIT if nothing is found until LIMIT.
6750 If two or more extents with conflicting non-nil values for PROP overlap
6751 a particular character, it is undefined which value is considered to be
6752 the value of PROP. (Note that this situation will not happen if you always
6753 use the text-property primitives.)
6755 (pos, prop, object, limit))
6759 Lisp_Object extent, value;
6762 object = decode_buffer_or_string(object);
6763 bpos = get_buffer_or_string_pos_char(object, pos, 0);
6765 blim = buffer_or_string_accessible_begin_char(object);
6768 blim = get_buffer_or_string_pos_char(object, limit, 0);
6772 /* extent-at refers to the character AFTER bpos, but we want the
6773 character before bpos. Thus the - 1. extent-at simply
6774 returns nil on bogus positions, so not to worry. */
6775 extent = Fextent_at(make_int(bpos - 1), object, prop, Qnil, Qnil);
6777 value = Fextent_property(extent, prop, Qnil);
6782 bpos = XINT(Fprevious_extent_change(make_int(bpos), object));
6784 break; /* property is the same all the way to the beginning */
6786 Fextent_at(make_int(bpos - 1), object, prop, Qnil, Qnil);
6787 if ((NILP(extent) && !NILP(value))
6789 && !EQ(value, Fextent_property(extent, prop, Qnil))))
6790 return make_int(bpos);
6793 /* I think it's more sensible for this function to return nil always
6794 in this situation and it used to do it this way, but it's been changed
6795 for FSF compatibility. */
6799 return make_int(blim);
6802 #ifdef MEMORY_USAGE_STATS
6805 compute_buffer_extent_usage(struct buffer *b, struct overhead_stats *ovstats)
6807 /* #### not yet written */
6811 #endif /* MEMORY_USAGE_STATS */
6813 /************************************************************************/
6814 /* initialization */
6815 /************************************************************************/
6817 void syms_of_extents(void)
6819 INIT_LRECORD_IMPLEMENTATION(extent);
6820 INIT_LRECORD_IMPLEMENTATION(extent_info);
6821 INIT_LRECORD_IMPLEMENTATION(extent_auxiliary);
6823 defsymbol(&Qextentp, "extentp");
6824 defsymbol(&Qextent_live_p, "extent-live-p");
6826 defsymbol(&Qall_extents_closed, "all-extents-closed");
6827 defsymbol(&Qall_extents_open, "all-extents-open");
6828 defsymbol(&Qall_extents_closed_open, "all-extents-closed-open");
6829 defsymbol(&Qall_extents_open_closed, "all-extents-open-closed");
6830 defsymbol(&Qstart_in_region, "start-in-region");
6831 defsymbol(&Qend_in_region, "end-in-region");
6832 defsymbol(&Qstart_and_end_in_region, "start-and-end-in-region");
6833 defsymbol(&Qstart_or_end_in_region, "start-or-end-in-region");
6834 defsymbol(&Qnegate_in_region, "negate-in-region");
6836 defsymbol(&Qdetached, "detached");
6837 defsymbol(&Qdestroyed, "destroyed");
6838 defsymbol(&Qbegin_glyph, "begin-glyph");
6839 defsymbol(&Qend_glyph, "end-glyph");
6840 defsymbol(&Qstart_open, "start-open");
6841 defsymbol(&Qend_open, "end-open");
6842 defsymbol(&Qstart_closed, "start-closed");
6843 defsymbol(&Qend_closed, "end-closed");
6844 defsymbol(&Qread_only, "read-only");
6845 /* defsymbol (&Qhighlight, "highlight"); in faces.c */
6846 defsymbol(&Qunique, "unique");
6847 defsymbol(&Qduplicable, "duplicable");
6848 defsymbol(&Qdetachable, "detachable");
6849 defsymbol(&Qpriority, "priority");
6850 defsymbol(&Qmouse_face, "mouse-face");
6851 defsymbol(&Qinitial_redisplay_function, "initial-redisplay-function");
6853 defsymbol(&Qglyph_layout, "glyph-layout"); /* backwards compatibility */
6854 defsymbol(&Qbegin_glyph_layout, "begin-glyph-layout");
6855 defsymbol(&Qend_glyph_layout, "end-glyph-layout");
6856 defsymbol(&Qoutside_margin, "outside-margin");
6857 defsymbol(&Qinside_margin, "inside-margin");
6858 defsymbol(&Qwhitespace, "whitespace");
6859 /* Qtext defined in general.c */
6861 defsymbol(&Qpaste_function, "paste-function");
6862 defsymbol(&Qcopy_function, "copy-function");
6864 defsymbol(&Qtext_prop, "text-prop");
6865 defsymbol(&Qtext_prop_extent_paste_function,
6866 "text-prop-extent-paste-function");
6869 DEFSUBR(Fextent_live_p);
6870 DEFSUBR(Fextent_detached_p);
6871 DEFSUBR(Fextent_start_position);
6872 DEFSUBR(Fextent_end_position);
6873 DEFSUBR(Fextent_object);
6874 DEFSUBR(Fextent_length);
6876 DEFSUBR(Fmake_extent);
6877 DEFSUBR(Fcopy_extent);
6878 DEFSUBR(Fdelete_extent);
6879 DEFSUBR(Fdetach_extent);
6880 DEFSUBR(Fset_extent_endpoints);
6881 DEFSUBR(Fnext_extent);
6882 DEFSUBR(Fprevious_extent);
6884 DEFSUBR(Fnext_e_extent);
6885 DEFSUBR(Fprevious_e_extent);
6887 DEFSUBR(Fnext_extent_change);
6888 DEFSUBR(Fprevious_extent_change);
6890 DEFSUBR(Fextent_parent);
6891 DEFSUBR(Fextent_children);
6892 DEFSUBR(Fset_extent_parent);
6894 DEFSUBR(Fextent_in_region_p);
6895 DEFSUBR(Fmap_extents);
6896 DEFSUBR(Fmap_extent_children);
6897 DEFSUBR(Fextent_at);
6898 DEFSUBR(Fextents_at);
6900 DEFSUBR(Fset_extent_initial_redisplay_function);
6901 DEFSUBR(Fextent_face);
6902 DEFSUBR(Fset_extent_face);
6903 DEFSUBR(Fextent_mouse_face);
6904 DEFSUBR(Fset_extent_mouse_face);
6905 DEFSUBR(Fset_extent_begin_glyph);
6906 DEFSUBR(Fset_extent_end_glyph);
6907 DEFSUBR(Fextent_begin_glyph);
6908 DEFSUBR(Fextent_end_glyph);
6909 DEFSUBR(Fset_extent_begin_glyph_layout);
6910 DEFSUBR(Fset_extent_end_glyph_layout);
6911 DEFSUBR(Fextent_begin_glyph_layout);
6912 DEFSUBR(Fextent_end_glyph_layout);
6913 DEFSUBR(Fset_extent_priority);
6914 DEFSUBR(Fextent_priority);
6915 DEFSUBR(Fset_extent_property);
6916 DEFSUBR(Fset_extent_properties);
6917 DEFSUBR(Fextent_property);
6918 DEFSUBR(Fextent_properties);
6920 DEFSUBR(Fhighlight_extent);
6921 DEFSUBR(Fforce_highlight_extent);
6923 DEFSUBR(Finsert_extent);
6925 DEFSUBR(Fget_text_property);
6926 DEFSUBR(Fget_char_property);
6927 DEFSUBR(Fput_text_property);
6928 DEFSUBR(Fput_nonduplicable_text_property);
6929 DEFSUBR(Fadd_text_properties);
6930 DEFSUBR(Fadd_nonduplicable_text_properties);
6931 DEFSUBR(Fremove_text_properties);
6932 DEFSUBR(Ftext_prop_extent_paste_function);
6933 DEFSUBR(Fnext_single_property_change);
6934 DEFSUBR(Fprevious_single_property_change);
6937 void reinit_vars_of_extents(void)
6939 extent_auxiliary_defaults.begin_glyph = Qnil;
6940 extent_auxiliary_defaults.end_glyph = Qnil;
6941 extent_auxiliary_defaults.parent = Qnil;
6942 extent_auxiliary_defaults.children = Qnil;
6943 extent_auxiliary_defaults.priority = 0;
6944 extent_auxiliary_defaults.invisible = Qnil;
6945 extent_auxiliary_defaults.read_only = Qnil;
6946 extent_auxiliary_defaults.mouse_face = Qnil;
6947 extent_auxiliary_defaults.initial_redisplay_function = Qnil;
6948 extent_auxiliary_defaults.before_change_functions = Qnil;
6949 extent_auxiliary_defaults.after_change_functions = Qnil;
6952 void vars_of_extents(void)
6954 reinit_vars_of_extents();
6956 DEFVAR_INT("mouse-highlight-priority", &mouse_highlight_priority /*
6957 The priority to use for the mouse-highlighting pseudo-extent
6958 that is used to highlight extents with the `mouse-face' attribute set.
6959 See `set-extent-priority'.
6961 /* Set mouse-highlight-priority (which ends up being used both for the
6962 mouse-highlighting pseudo-extent and the primary selection extent)
6963 to a very high value because very few extents should override it.
6964 1000 gives lots of room below it for different-prioritized extents.
6965 10 doesn't. ediff, for example, likes to use priorities around 100.
6967 mouse_highlight_priority = /* 10 */ 1000;
6969 DEFVAR_LISP("default-text-properties", &Vdefault_text_properties /*
6970 Property list giving default values for text properties.
6971 Whenever a character does not specify a value for a property, the value
6972 stored in this list is used instead. This only applies when the
6973 functions `get-text-property' or `get-char-property' are called.
6975 Vdefault_text_properties = Qnil;
6977 staticpro(&Vlast_highlighted_extent);
6978 Vlast_highlighted_extent = Qnil;
6980 Vextent_face_reusable_list = Fcons(Qnil, Qnil);
6981 staticpro(&Vextent_face_reusable_list);
6984 void complex_vars_of_extents(void)
6986 staticpro(&Vextent_face_memoize_hash_table);
6987 /* The memoize hash table maps from lists of symbols to lists of
6988 faces. It needs to be `equal' to implement the memoization.
6989 The reverse table maps in the other direction and just needs
6990 to do `eq' comparison because the lists of faces are already
6992 Vextent_face_memoize_hash_table =
6993 make_lisp_hash_table(100, HASH_TABLE_VALUE_WEAK, HASH_TABLE_EQUAL);
6994 staticpro(&Vextent_face_reverse_memoize_hash_table);
6995 Vextent_face_reverse_memoize_hash_table =
6996 make_lisp_hash_table(100, HASH_TABLE_KEY_WEAK, HASH_TABLE_EQ);