1 /* Interface code for dealing with text properties.
2 Copyright (C) 1993, 1994, 1995 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2, or (at your option)
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs; see the file COPYING. If not, write to
18 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
22 #include "intervals.h"
27 #define NULL (void *)0
30 /* Test for membership, allowing for t (actually any non-cons) to mean the
33 #define TMEM(sym, set) (CONSP (set) ? ! NILP (Fmemq (sym, set)) : ! NILP (set))
36 /* NOTES: previous- and next- property change will have to skip
37 zero-length intervals if they are implemented. This could be done
38 inside next_interval and previous_interval.
40 set_properties needs to deal with the interval property cache.
42 It is assumed that for any interval plist, a property appears
43 only once on the list. Although some code i.e., remove_properties,
44 handles the more general case, the uniqueness of properties is
45 necessary for the system to remain consistent. This requirement
46 is enforced by the subrs installing properties onto the intervals. */
48 /* The rest of the file is within this conditional */
49 #ifdef USE_TEXT_PROPERTIES
52 Lisp_Object Qmouse_left
;
53 Lisp_Object Qmouse_entered
;
54 Lisp_Object Qpoint_left
;
55 Lisp_Object Qpoint_entered
;
56 Lisp_Object Qcategory
;
57 Lisp_Object Qlocal_map
;
59 /* Visual properties text (including strings) may have. */
60 Lisp_Object Qforeground
, Qbackground
, Qfont
, Qunderline
, Qstipple
;
61 Lisp_Object Qinvisible
, Qread_only
, Qintangible
;
63 /* Sticky properties */
64 Lisp_Object Qfront_sticky
, Qrear_nonsticky
;
66 /* If o1 is a cons whose cdr is a cons, return non-zero and set o2 to
67 the o1's cdr. Otherwise, return zero. This is handy for
69 #define PLIST_ELT_P(o1, o2) (CONSP (o1) && ((o2)=XCONS (o1)->cdr, CONSP (o2)))
71 Lisp_Object Vinhibit_point_motion_hooks
;
72 Lisp_Object Vdefault_text_properties
;
74 /* verify_interval_modification saves insertion hooks here
75 to be run later by report_interval_modification. */
76 Lisp_Object interval_insert_behind_hooks
;
77 Lisp_Object interval_insert_in_front_hooks
;
79 /* Extract the interval at the position pointed to by BEGIN from
80 OBJECT, a string or buffer. Additionally, check that the positions
81 pointed to by BEGIN and END are within the bounds of OBJECT, and
82 reverse them if *BEGIN is greater than *END. The objects pointed
83 to by BEGIN and END may be integers or markers; if the latter, they
84 are coerced to integers.
86 When OBJECT is a string, we increment *BEGIN and *END
87 to make them origin-one.
89 Note that buffer points don't correspond to interval indices.
90 For example, point-max is 1 greater than the index of the last
91 character. This difference is handled in the caller, which uses
92 the validated points to determine a length, and operates on that.
93 Exceptions are Ftext_properties_at, Fnext_property_change, and
94 Fprevious_property_change which call this function with BEGIN == END.
95 Handle this case specially.
97 If FORCE is soft (0), it's OK to return NULL_INTERVAL. Otherwise,
98 create an interval tree for OBJECT if one doesn't exist, provided
99 the object actually contains text. In the current design, if there
100 is no text, there can be no text properties. */
106 validate_interval_range (object
, begin
, end
, force
)
107 Lisp_Object object
, *begin
, *end
;
113 CHECK_STRING_OR_BUFFER (object
, 0);
114 CHECK_NUMBER_COERCE_MARKER (*begin
, 0);
115 CHECK_NUMBER_COERCE_MARKER (*end
, 0);
117 /* If we are asked for a point, but from a subr which operates
118 on a range, then return nothing. */
119 if (EQ (*begin
, *end
) && begin
!= end
)
120 return NULL_INTERVAL
;
122 if (XINT (*begin
) > XINT (*end
))
130 if (BUFFERP (object
))
132 register struct buffer
*b
= XBUFFER (object
);
134 if (!(BUF_BEGV (b
) <= XINT (*begin
) && XINT (*begin
) <= XINT (*end
)
135 && XINT (*end
) <= BUF_ZV (b
)))
136 args_out_of_range (*begin
, *end
);
137 i
= BUF_INTERVALS (b
);
139 /* If there's no text, there are no properties. */
140 if (BUF_BEGV (b
) == BUF_ZV (b
))
141 return NULL_INTERVAL
;
143 searchpos
= XINT (*begin
);
147 register struct Lisp_String
*s
= XSTRING (object
);
149 if (! (0 <= XINT (*begin
) && XINT (*begin
) <= XINT (*end
)
150 && XINT (*end
) <= s
->size
))
151 args_out_of_range (*begin
, *end
);
152 /* User-level Positions in strings start with 0,
153 but the interval code always wants positions starting with 1. */
154 XSETFASTINT (*begin
, XFASTINT (*begin
) + 1);
156 XSETFASTINT (*end
, XFASTINT (*end
) + 1);
160 return NULL_INTERVAL
;
162 searchpos
= XINT (*begin
);
165 if (NULL_INTERVAL_P (i
))
166 return (force
? create_root_interval (object
) : i
);
168 return find_interval (i
, searchpos
);
171 /* Validate LIST as a property list. If LIST is not a list, then
172 make one consisting of (LIST nil). Otherwise, verify that LIST
173 is even numbered and thus suitable as a plist. */
176 validate_plist (list
)
185 register Lisp_Object tail
;
186 for (i
= 0, tail
= list
; !NILP (tail
); i
++)
192 error ("Odd length text property list");
196 return Fcons (list
, Fcons (Qnil
, Qnil
));
199 /* Return nonzero if interval I has all the properties,
200 with the same values, of list PLIST. */
203 interval_has_all_properties (plist
, i
)
207 register Lisp_Object tail1
, tail2
, sym1
, sym2
;
210 /* Go through each element of PLIST. */
211 for (tail1
= plist
; ! NILP (tail1
); tail1
= Fcdr (Fcdr (tail1
)))
216 /* Go through I's plist, looking for sym1 */
217 for (tail2
= i
->plist
; ! NILP (tail2
); tail2
= Fcdr (Fcdr (tail2
)))
218 if (EQ (sym1
, Fcar (tail2
)))
220 /* Found the same property on both lists. If the
221 values are unequal, return zero. */
222 if (! EQ (Fcar (Fcdr (tail1
)), Fcar (Fcdr (tail2
))))
225 /* Property has same value on both lists; go to next one. */
237 /* Return nonzero if the plist of interval I has any of the
238 properties of PLIST, regardless of their values. */
241 interval_has_some_properties (plist
, i
)
245 register Lisp_Object tail1
, tail2
, sym
;
247 /* Go through each element of PLIST. */
248 for (tail1
= plist
; ! NILP (tail1
); tail1
= Fcdr (Fcdr (tail1
)))
252 /* Go through i's plist, looking for tail1 */
253 for (tail2
= i
->plist
; ! NILP (tail2
); tail2
= Fcdr (Fcdr (tail2
)))
254 if (EQ (sym
, Fcar (tail2
)))
261 /* Changing the plists of individual intervals. */
263 /* Return the value of PROP in property-list PLIST, or Qunbound if it
266 property_value (plist
, prop
)
267 Lisp_Object plist
, prop
;
271 while (PLIST_ELT_P (plist
, value
))
272 if (EQ (XCONS (plist
)->car
, prop
))
273 return XCONS (value
)->car
;
275 plist
= XCONS (value
)->cdr
;
280 /* Set the properties of INTERVAL to PROPERTIES,
281 and record undo info for the previous values.
282 OBJECT is the string or buffer that INTERVAL belongs to. */
285 set_properties (properties
, interval
, object
)
286 Lisp_Object properties
, object
;
289 Lisp_Object sym
, value
;
291 if (BUFFERP (object
))
293 /* For each property in the old plist which is missing from PROPERTIES,
294 or has a different value in PROPERTIES, make an undo record. */
295 for (sym
= interval
->plist
;
296 PLIST_ELT_P (sym
, value
);
297 sym
= XCONS (value
)->cdr
)
298 if (! EQ (property_value (properties
, XCONS (sym
)->car
),
301 modify_region (XBUFFER (object
),
302 make_number (interval
->position
),
303 make_number (interval
->position
+ LENGTH (interval
)));
304 record_property_change (interval
->position
, LENGTH (interval
),
305 XCONS (sym
)->car
, XCONS (value
)->car
,
309 /* For each new property that has no value at all in the old plist,
310 make an undo record binding it to nil, so it will be removed. */
311 for (sym
= properties
;
312 PLIST_ELT_P (sym
, value
);
313 sym
= XCONS (value
)->cdr
)
314 if (EQ (property_value (interval
->plist
, XCONS (sym
)->car
), Qunbound
))
316 modify_region (XBUFFER (object
),
317 make_number (interval
->position
),
318 make_number (interval
->position
+ LENGTH (interval
)));
319 record_property_change (interval
->position
, LENGTH (interval
),
320 XCONS (sym
)->car
, Qnil
,
325 /* Store new properties. */
326 interval
->plist
= Fcopy_sequence (properties
);
329 /* Add the properties of PLIST to the interval I, or set
330 the value of I's property to the value of the property on PLIST
331 if they are different.
333 OBJECT should be the string or buffer the interval is in.
335 Return nonzero if this changes I (i.e., if any members of PLIST
336 are actually added to I's plist) */
339 add_properties (plist
, i
, object
)
344 Lisp_Object tail1
, tail2
, sym1
, val1
;
345 register int changed
= 0;
347 struct gcpro gcpro1
, gcpro2
, gcpro3
;
352 /* No need to protect OBJECT, because we can GC only in the case
353 where it is a buffer, and live buffers are always protected.
354 I and its plist are also protected, via OBJECT. */
355 GCPRO3 (tail1
, sym1
, val1
);
357 /* Go through each element of PLIST. */
358 for (tail1
= plist
; ! NILP (tail1
); tail1
= Fcdr (Fcdr (tail1
)))
361 val1
= Fcar (Fcdr (tail1
));
364 /* Go through I's plist, looking for sym1 */
365 for (tail2
= i
->plist
; ! NILP (tail2
); tail2
= Fcdr (Fcdr (tail2
)))
366 if (EQ (sym1
, Fcar (tail2
)))
368 /* No need to gcpro, because tail2 protects this
369 and it must be a cons cell (we get an error otherwise). */
370 register Lisp_Object this_cdr
;
372 this_cdr
= Fcdr (tail2
);
373 /* Found the property. Now check its value. */
376 /* The properties have the same value on both lists.
377 Continue to the next property. */
378 if (EQ (val1
, Fcar (this_cdr
)))
381 /* Record this change in the buffer, for undo purposes. */
382 if (BUFFERP (object
))
384 modify_region (XBUFFER (object
),
385 make_number (i
->position
),
386 make_number (i
->position
+ LENGTH (i
)));
387 record_property_change (i
->position
, LENGTH (i
),
388 sym1
, Fcar (this_cdr
), object
);
391 /* I's property has a different value -- change it */
392 Fsetcar (this_cdr
, val1
);
399 /* Record this change in the buffer, for undo purposes. */
400 if (BUFFERP (object
))
402 modify_region (XBUFFER (object
),
403 make_number (i
->position
),
404 make_number (i
->position
+ LENGTH (i
)));
405 record_property_change (i
->position
, LENGTH (i
),
408 i
->plist
= Fcons (sym1
, Fcons (val1
, i
->plist
));
418 /* For any members of PLIST which are properties of I, remove them
420 OBJECT is the string or buffer containing I. */
423 remove_properties (plist
, i
, object
)
428 register Lisp_Object tail1
, tail2
, sym
, current_plist
;
429 register int changed
= 0;
431 current_plist
= i
->plist
;
432 /* Go through each element of plist. */
433 for (tail1
= plist
; ! NILP (tail1
); tail1
= Fcdr (Fcdr (tail1
)))
437 /* First, remove the symbol if its at the head of the list */
438 while (! NILP (current_plist
) && EQ (sym
, Fcar (current_plist
)))
440 if (BUFFERP (object
))
442 modify_region (XBUFFER (object
),
443 make_number (i
->position
),
444 make_number (i
->position
+ LENGTH (i
)));
445 record_property_change (i
->position
, LENGTH (i
),
446 sym
, Fcar (Fcdr (current_plist
)),
450 current_plist
= Fcdr (Fcdr (current_plist
));
454 /* Go through i's plist, looking for sym */
455 tail2
= current_plist
;
456 while (! NILP (tail2
))
458 register Lisp_Object
this;
459 this = Fcdr (Fcdr (tail2
));
460 if (EQ (sym
, Fcar (this)))
462 if (BUFFERP (object
))
464 modify_region (XBUFFER (object
),
465 make_number (i
->position
),
466 make_number (i
->position
+ LENGTH (i
)));
467 record_property_change (i
->position
, LENGTH (i
),
468 sym
, Fcar (Fcdr (this)), object
);
471 Fsetcdr (Fcdr (tail2
), Fcdr (Fcdr (this)));
479 i
->plist
= current_plist
;
484 /* Remove all properties from interval I. Return non-zero
485 if this changes the interval. */
499 DEFUN ("text-properties-at", Ftext_properties_at
,
500 Stext_properties_at
, 1, 2, 0,
501 "Return the list of properties held by the character at POSITION\n\
502 in optional argument OBJECT, a string or buffer. If nil, OBJECT\n\
503 defaults to the current buffer.\n\
504 If POSITION is at the end of OBJECT, the value is nil.")
506 Lisp_Object pos
, object
;
511 XSETBUFFER (object
, current_buffer
);
513 i
= validate_interval_range (object
, &pos
, &pos
, soft
);
514 if (NULL_INTERVAL_P (i
))
516 /* If POS is at the end of the interval,
517 it means it's the end of OBJECT.
518 There are no properties at the very end,
519 since no character follows. */
520 if (XINT (pos
) == LENGTH (i
) + i
->position
)
526 DEFUN ("get-text-property", Fget_text_property
, Sget_text_property
, 2, 3, 0,
527 "Return the value of position POS's property PROP, in OBJECT.\n\
528 OBJECT is optional and defaults to the current buffer.\n\
529 If POSITION is at the end of OBJECT, the value is nil.")
531 Lisp_Object pos
, object
;
534 return textget (Ftext_properties_at (pos
, object
), prop
);
537 DEFUN ("get-char-property", Fget_char_property
, Sget_char_property
, 2, 3, 0,
538 "Return the value of position POS's property PROP, in OBJECT.\n\
539 OBJECT is optional and defaults to the current buffer.\n\
540 If POS is at the end of OBJECT, the value is nil.\n\
541 If OBJECT is a buffer, then overlay properties are considered as well as\n\
543 If OBJECT is a window, then that window's buffer is used, but window-specific\n\
544 overlays are considered only if they are associated with OBJECT.")
546 Lisp_Object pos
, object
;
547 register Lisp_Object prop
;
549 struct window
*w
= 0;
551 CHECK_NUMBER_COERCE_MARKER (pos
, 0);
554 XSETBUFFER (object
, current_buffer
);
556 if (WINDOWP (object
))
558 w
= XWINDOW (object
);
561 if (BUFFERP (object
))
563 int posn
= XINT (pos
);
565 Lisp_Object
*overlay_vec
, tem
;
568 struct buffer
*obuf
= current_buffer
;
570 set_buffer_temp (XBUFFER (object
));
572 /* First try with room for 40 overlays. */
574 overlay_vec
= (Lisp_Object
*) alloca (len
* sizeof (Lisp_Object
));
576 noverlays
= overlays_at (posn
, 0, &overlay_vec
, &len
,
577 &next_overlay
, NULL
);
579 /* If there are more than 40,
580 make enough space for all, and try again. */
584 overlay_vec
= (Lisp_Object
*) alloca (len
* sizeof (Lisp_Object
));
585 noverlays
= overlays_at (posn
, 0, &overlay_vec
, &len
,
586 &next_overlay
, NULL
);
588 noverlays
= sort_overlays (overlay_vec
, noverlays
, w
);
590 set_buffer_temp (obuf
);
592 /* Now check the overlays in order of decreasing priority. */
593 while (--noverlays
>= 0)
595 tem
= Foverlay_get (overlay_vec
[noverlays
], prop
);
600 /* Not a buffer, or no appropriate overlay, so fall through to the
602 return (Fget_text_property (pos
, prop
, object
));
605 DEFUN ("next-property-change", Fnext_property_change
,
606 Snext_property_change
, 1, 3, 0,
607 "Return the position of next property change.\n\
608 Scans characters forward from POS in OBJECT till it finds\n\
609 a change in some text property, then returns the position of the change.\n\
610 The optional second argument OBJECT is the string or buffer to scan.\n\
611 Return nil if the property is constant all the way to the end of OBJECT.\n\
612 If the value is non-nil, it is a position greater than POS, never equal.\n\n\
613 If the optional third argument LIMIT is non-nil, don't search\n\
614 past position LIMIT; return LIMIT if nothing is found before LIMIT.")
616 Lisp_Object pos
, object
, limit
;
618 register INTERVAL i
, next
;
621 XSETBUFFER (object
, current_buffer
);
623 if (! NILP (limit
) && ! EQ (limit
, Qt
))
624 CHECK_NUMBER_COERCE_MARKER (limit
, 0);
626 i
= validate_interval_range (object
, &pos
, &pos
, soft
);
627 if (NULL_INTERVAL_P (i
))
630 next
= next_interval (i
);
631 /* If LIMIT is t, return start of next interval--don't
632 bother checking further intervals. */
635 if (NULL_INTERVAL_P (next
))
636 XSETFASTINT (pos
, (STRINGP (object
)
637 ? XSTRING (object
)->size
638 : BUF_ZV (XBUFFER (object
))));
640 XSETFASTINT (pos
, next
->position
- (STRINGP (object
)));
644 while (! NULL_INTERVAL_P (next
) && intervals_equal (i
, next
)
645 && (NILP (limit
) || next
->position
< XFASTINT (limit
)))
646 next
= next_interval (next
);
648 if (NULL_INTERVAL_P (next
))
650 if (! NILP (limit
) && !(next
->position
< XFASTINT (limit
)))
653 XSETFASTINT (pos
, next
->position
- (STRINGP (object
)));
657 /* Return 1 if there's a change in some property between BEG and END. */
660 property_change_between_p (beg
, end
)
663 register INTERVAL i
, next
;
664 Lisp_Object object
, pos
;
666 XSETBUFFER (object
, current_buffer
);
667 XSETFASTINT (pos
, beg
);
669 i
= validate_interval_range (object
, &pos
, &pos
, soft
);
670 if (NULL_INTERVAL_P (i
))
673 next
= next_interval (i
);
674 while (! NULL_INTERVAL_P (next
) && intervals_equal (i
, next
))
676 next
= next_interval (next
);
677 if (NULL_INTERVAL_P (next
))
679 if (next
->position
>= end
)
683 if (NULL_INTERVAL_P (next
))
689 DEFUN ("next-single-property-change", Fnext_single_property_change
,
690 Snext_single_property_change
, 2, 4, 0,
691 "Return the position of next property change for a specific property.\n\
692 Scans characters forward from POS till it finds\n\
693 a change in the PROP property, then returns the position of the change.\n\
694 The optional third argument OBJECT is the string or buffer to scan.\n\
695 The property values are compared with `eq'.\n\
696 Return nil if the property is constant all the way to the end of OBJECT.\n\
697 If the value is non-nil, it is a position greater than POS, never equal.\n\n\
698 If the optional fourth argument LIMIT is non-nil, don't search\n\
699 past position LIMIT; return LIMIT if nothing is found before LIMIT.")
700 (pos
, prop
, object
, limit
)
701 Lisp_Object pos
, prop
, object
, limit
;
703 register INTERVAL i
, next
;
704 register Lisp_Object here_val
;
707 XSETBUFFER (object
, current_buffer
);
710 CHECK_NUMBER_COERCE_MARKER (limit
, 0);
712 i
= validate_interval_range (object
, &pos
, &pos
, soft
);
713 if (NULL_INTERVAL_P (i
))
716 here_val
= textget (i
->plist
, prop
);
717 next
= next_interval (i
);
718 while (! NULL_INTERVAL_P (next
)
719 && EQ (here_val
, textget (next
->plist
, prop
))
720 && (NILP (limit
) || next
->position
< XFASTINT (limit
)))
721 next
= next_interval (next
);
723 if (NULL_INTERVAL_P (next
))
725 if (! NILP (limit
) && !(next
->position
< XFASTINT (limit
)))
728 XSETFASTINT (pos
, next
->position
- (STRINGP (object
)));
732 DEFUN ("previous-property-change", Fprevious_property_change
,
733 Sprevious_property_change
, 1, 3, 0,
734 "Return the position of previous property change.\n\
735 Scans characters backwards from POS in OBJECT till it finds\n\
736 a change in some text property, then returns the position of the change.\n\
737 The optional second argument OBJECT is the string or buffer to scan.\n\
738 Return nil if the property is constant all the way to the start of OBJECT.\n\
739 If the value is non-nil, it is a position less than POS, never equal.\n\n\
740 If the optional third argument LIMIT is non-nil, don't search\n\
741 back past position LIMIT; return LIMIT if nothing is found until LIMIT.")
743 Lisp_Object pos
, object
, limit
;
745 register INTERVAL i
, previous
;
748 XSETBUFFER (object
, current_buffer
);
751 CHECK_NUMBER_COERCE_MARKER (limit
, 0);
753 i
= validate_interval_range (object
, &pos
, &pos
, soft
);
754 if (NULL_INTERVAL_P (i
))
757 /* Start with the interval containing the char before point. */
758 if (i
->position
== XFASTINT (pos
))
759 i
= previous_interval (i
);
761 previous
= previous_interval (i
);
762 while (! NULL_INTERVAL_P (previous
) && intervals_equal (previous
, i
)
764 || previous
->position
+ LENGTH (previous
) > XFASTINT (limit
)))
765 previous
= previous_interval (previous
);
766 if (NULL_INTERVAL_P (previous
))
769 && !(previous
->position
+ LENGTH (previous
) > XFASTINT (limit
)))
772 XSETFASTINT (pos
, (previous
->position
+ LENGTH (previous
)
773 - (STRINGP (object
))));
777 DEFUN ("previous-single-property-change", Fprevious_single_property_change
,
778 Sprevious_single_property_change
, 2, 4, 0,
779 "Return the position of previous property change for a specific property.\n\
780 Scans characters backward from POS till it finds\n\
781 a change in the PROP property, then returns the position of the change.\n\
782 The optional third argument OBJECT is the string or buffer to scan.\n\
783 The property values are compared with `eq'.\n\
784 Return nil if the property is constant all the way to the start of OBJECT.\n\
785 If the value is non-nil, it is a position less than POS, never equal.\n\n\
786 If the optional fourth argument LIMIT is non-nil, don't search\n\
787 back past position LIMIT; return LIMIT if nothing is found until LIMIT.")
788 (pos
, prop
, object
, limit
)
789 Lisp_Object pos
, prop
, object
, limit
;
791 register INTERVAL i
, previous
;
792 register Lisp_Object here_val
;
795 XSETBUFFER (object
, current_buffer
);
798 CHECK_NUMBER_COERCE_MARKER (limit
, 0);
800 i
= validate_interval_range (object
, &pos
, &pos
, soft
);
802 /* Start with the interval containing the char before point. */
803 if (! NULL_INTERVAL_P (i
) && i
->position
== XFASTINT (pos
))
804 i
= previous_interval (i
);
806 if (NULL_INTERVAL_P (i
))
809 here_val
= textget (i
->plist
, prop
);
810 previous
= previous_interval (i
);
811 while (! NULL_INTERVAL_P (previous
)
812 && EQ (here_val
, textget (previous
->plist
, prop
))
814 || previous
->position
+ LENGTH (previous
) > XFASTINT (limit
)))
815 previous
= previous_interval (previous
);
816 if (NULL_INTERVAL_P (previous
))
819 && !(previous
->position
+ LENGTH (previous
) > XFASTINT (limit
)))
822 XSETFASTINT (pos
, (previous
->position
+ LENGTH (previous
)
823 - (STRINGP (object
))));
827 /* Callers note, this can GC when OBJECT is a buffer (or nil). */
829 DEFUN ("add-text-properties", Fadd_text_properties
,
830 Sadd_text_properties
, 3, 4, 0,
831 "Add properties to the text from START to END.\n\
832 The third argument PROPS is a property list\n\
833 specifying the property values to add.\n\
834 The optional fourth argument, OBJECT,\n\
835 is the string or buffer containing the text.\n\
836 Return t if any property value actually changed, nil otherwise.")
837 (start
, end
, properties
, object
)
838 Lisp_Object start
, end
, properties
, object
;
840 register INTERVAL i
, unchanged
;
841 register int s
, len
, modified
= 0;
844 properties
= validate_plist (properties
);
845 if (NILP (properties
))
849 XSETBUFFER (object
, current_buffer
);
851 i
= validate_interval_range (object
, &start
, &end
, hard
);
852 if (NULL_INTERVAL_P (i
))
856 len
= XINT (end
) - s
;
858 /* No need to protect OBJECT, because we GC only if it's a buffer,
859 and live buffers are always protected. */
862 /* If we're not starting on an interval boundary, we have to
863 split this interval. */
864 if (i
->position
!= s
)
866 /* If this interval already has the properties, we can
868 if (interval_has_all_properties (properties
, i
))
870 int got
= (LENGTH (i
) - (s
- i
->position
));
874 i
= next_interval (i
);
879 i
= split_interval_right (unchanged
, s
- unchanged
->position
);
880 copy_properties (unchanged
, i
);
884 /* We are at the beginning of interval I, with LEN chars to scan. */
890 if (LENGTH (i
) >= len
)
892 /* We can UNGCPRO safely here, because there will be just
893 one more chance to gc, in the next call to add_properties,
894 and after that we will not need PROPERTIES or OBJECT again. */
897 if (interval_has_all_properties (properties
, i
))
898 return modified
? Qt
: Qnil
;
900 if (LENGTH (i
) == len
)
902 add_properties (properties
, i
, object
);
906 /* i doesn't have the properties, and goes past the change limit */
908 i
= split_interval_left (unchanged
, len
);
909 copy_properties (unchanged
, i
);
910 add_properties (properties
, i
, object
);
915 modified
+= add_properties (properties
, i
, object
);
916 i
= next_interval (i
);
920 /* Callers note, this can GC when OBJECT is a buffer (or nil). */
922 DEFUN ("put-text-property", Fput_text_property
,
923 Sput_text_property
, 4, 5, 0,
924 "Set one property of the text from START to END.\n\
925 The third and fourth arguments PROP and VALUE\n\
926 specify the property to add.\n\
927 The optional fifth argument, OBJECT,\n\
928 is the string or buffer containing the text.")
929 (start
, end
, prop
, value
, object
)
930 Lisp_Object start
, end
, prop
, value
, object
;
932 Fadd_text_properties (start
, end
,
933 Fcons (prop
, Fcons (value
, Qnil
)),
938 DEFUN ("set-text-properties", Fset_text_properties
,
939 Sset_text_properties
, 3, 4, 0,
940 "Completely replace properties of text from START to END.\n\
941 The third argument PROPS is the new property list.\n\
942 The optional fourth argument, OBJECT,\n\
943 is the string or buffer containing the text.")
944 (start
, end
, props
, object
)
945 Lisp_Object start
, end
, props
, object
;
947 register INTERVAL i
, unchanged
;
948 register INTERVAL prev_changed
= NULL_INTERVAL
;
950 Lisp_Object ostart
, oend
;
955 props
= validate_plist (props
);
958 XSETBUFFER (object
, current_buffer
);
960 /* If we want no properties for a whole string,
961 get rid of its intervals. */
962 if (NILP (props
) && STRINGP (object
)
963 && XFASTINT (start
) == 0
964 && XFASTINT (end
) == XSTRING (object
)->size
)
966 XSTRING (object
)->intervals
= 0;
970 i
= validate_interval_range (object
, &start
, &end
, soft
);
972 if (NULL_INTERVAL_P (i
))
974 /* If buffer has no props, and we want none, return now. */
978 /* Restore the original START and END values
979 because validate_interval_range increments them for strings. */
983 i
= validate_interval_range (object
, &start
, &end
, hard
);
984 /* This can return if start == end. */
985 if (NULL_INTERVAL_P (i
))
990 len
= XINT (end
) - s
;
992 if (i
->position
!= s
)
995 i
= split_interval_right (unchanged
, s
- unchanged
->position
);
997 if (LENGTH (i
) > len
)
999 copy_properties (unchanged
, i
);
1000 i
= split_interval_left (i
, len
);
1001 set_properties (props
, i
, object
);
1005 set_properties (props
, i
, object
);
1007 if (LENGTH (i
) == len
)
1012 i
= next_interval (i
);
1015 /* We are starting at the beginning of an interval, I */
1021 if (LENGTH (i
) >= len
)
1023 if (LENGTH (i
) > len
)
1024 i
= split_interval_left (i
, len
);
1026 if (NULL_INTERVAL_P (prev_changed
))
1027 set_properties (props
, i
, object
);
1029 merge_interval_left (i
);
1034 if (NULL_INTERVAL_P (prev_changed
))
1036 set_properties (props
, i
, object
);
1040 prev_changed
= i
= merge_interval_left (i
);
1042 i
= next_interval (i
);
1048 DEFUN ("remove-text-properties", Fremove_text_properties
,
1049 Sremove_text_properties
, 3, 4, 0,
1050 "Remove some properties from text from START to END.\n\
1051 The third argument PROPS is a property list\n\
1052 whose property names specify the properties to remove.\n\
1053 \(The values stored in PROPS are ignored.)\n\
1054 The optional fourth argument, OBJECT,\n\
1055 is the string or buffer containing the text.\n\
1056 Return t if any property was actually removed, nil otherwise.")
1057 (start
, end
, props
, object
)
1058 Lisp_Object start
, end
, props
, object
;
1060 register INTERVAL i
, unchanged
;
1061 register int s
, len
, modified
= 0;
1064 XSETBUFFER (object
, current_buffer
);
1066 i
= validate_interval_range (object
, &start
, &end
, soft
);
1067 if (NULL_INTERVAL_P (i
))
1071 len
= XINT (end
) - s
;
1073 if (i
->position
!= s
)
1075 /* No properties on this first interval -- return if
1076 it covers the entire region. */
1077 if (! interval_has_some_properties (props
, i
))
1079 int got
= (LENGTH (i
) - (s
- i
->position
));
1083 i
= next_interval (i
);
1085 /* Split away the beginning of this interval; what we don't
1090 i
= split_interval_right (unchanged
, s
- unchanged
->position
);
1091 copy_properties (unchanged
, i
);
1095 /* We are at the beginning of an interval, with len to scan */
1101 if (LENGTH (i
) >= len
)
1103 if (! interval_has_some_properties (props
, i
))
1104 return modified
? Qt
: Qnil
;
1106 if (LENGTH (i
) == len
)
1108 remove_properties (props
, i
, object
);
1112 /* i has the properties, and goes past the change limit */
1114 i
= split_interval_left (i
, len
);
1115 copy_properties (unchanged
, i
);
1116 remove_properties (props
, i
, object
);
1121 modified
+= remove_properties (props
, i
, object
);
1122 i
= next_interval (i
);
1126 DEFUN ("text-property-any", Ftext_property_any
,
1127 Stext_property_any
, 4, 5, 0,
1128 "Check text from START to END to see if PROP is ever `eq' to VALUE.\n\
1129 If so, return the position of the first character whose PROP is `eq'\n\
1130 to VALUE. Otherwise return nil.\n\
1131 The optional fifth argument, OBJECT, is the string or buffer\n\
1132 containing the text.")
1133 (start
, end
, prop
, value
, object
)
1134 Lisp_Object start
, end
, prop
, value
, object
;
1136 register INTERVAL i
;
1137 register int e
, pos
;
1140 XSETBUFFER (object
, current_buffer
);
1141 i
= validate_interval_range (object
, &start
, &end
, soft
);
1142 if (NULL_INTERVAL_P (i
))
1143 return (!NILP (value
) || EQ (start
, end
) ? Qnil
: start
);
1146 while (! NULL_INTERVAL_P (i
))
1148 if (i
->position
>= e
)
1150 if (EQ (textget (i
->plist
, prop
), value
))
1153 if (pos
< XINT (start
))
1155 return make_number (pos
- (STRINGP (object
)));
1157 i
= next_interval (i
);
1162 DEFUN ("text-property-not-all", Ftext_property_not_all
,
1163 Stext_property_not_all
, 4, 5, 0,
1164 "Check text from START to END to see if PROP is ever not `eq' to VALUE.\n\
1165 If so, return the position of the first character whose PROP is not\n\
1166 `eq' to VALUE. Otherwise, return nil.\n\
1167 The optional fifth argument, OBJECT, is the string or buffer\n\
1168 containing the text.")
1169 (start
, end
, prop
, value
, object
)
1170 Lisp_Object start
, end
, prop
, value
, object
;
1172 register INTERVAL i
;
1176 XSETBUFFER (object
, current_buffer
);
1177 i
= validate_interval_range (object
, &start
, &end
, soft
);
1178 if (NULL_INTERVAL_P (i
))
1179 return (NILP (value
) || EQ (start
, end
)) ? Qnil
: start
;
1183 while (! NULL_INTERVAL_P (i
))
1185 if (i
->position
>= e
)
1187 if (! EQ (textget (i
->plist
, prop
), value
))
1189 if (i
->position
> s
)
1191 return make_number (s
- (STRINGP (object
)));
1193 i
= next_interval (i
);
1198 #if 0 /* You can use set-text-properties for this. */
1200 DEFUN ("erase-text-properties", Ferase_text_properties
,
1201 Serase_text_properties
, 2, 3, 0,
1202 "Remove all properties from the text from START to END.\n\
1203 The optional third argument, OBJECT,\n\
1204 is the string or buffer containing the text.")
1205 (start
, end
, object
)
1206 Lisp_Object start
, end
, object
;
1208 register INTERVAL i
;
1209 register INTERVAL prev_changed
= NULL_INTERVAL
;
1210 register int s
, len
, modified
;
1213 XSETBUFFER (object
, current_buffer
);
1215 i
= validate_interval_range (object
, &start
, &end
, soft
);
1216 if (NULL_INTERVAL_P (i
))
1220 len
= XINT (end
) - s
;
1222 if (i
->position
!= s
)
1225 register INTERVAL unchanged
= i
;
1227 /* If there are properties here, then this text will be modified. */
1228 if (! NILP (i
->plist
))
1230 i
= split_interval_right (unchanged
, s
- unchanged
->position
);
1234 if (LENGTH (i
) > len
)
1236 i
= split_interval_right (i
, len
);
1237 copy_properties (unchanged
, i
);
1241 if (LENGTH (i
) == len
)
1246 /* If the text of I is without any properties, and contains
1247 LEN or more characters, then we may return without changing
1249 else if (LENGTH (i
) - (s
- i
->position
) <= len
)
1251 /* The amount of text to change extends past I, so just note
1252 how much we've gotten. */
1254 got
= LENGTH (i
) - (s
- i
->position
);
1258 i
= next_interval (i
);
1261 /* We are starting at the beginning of an interval, I. */
1264 if (LENGTH (i
) >= len
)
1266 /* If I has no properties, simply merge it if possible. */
1267 if (NILP (i
->plist
))
1269 if (! NULL_INTERVAL_P (prev_changed
))
1270 merge_interval_left (i
);
1272 return modified
? Qt
: Qnil
;
1275 if (LENGTH (i
) > len
)
1276 i
= split_interval_left (i
, len
);
1277 if (! NULL_INTERVAL_P (prev_changed
))
1278 merge_interval_left (i
);
1285 /* Here if we still need to erase past the end of I */
1287 if (NULL_INTERVAL_P (prev_changed
))
1289 modified
+= erase_properties (i
);
1294 modified
+= ! NILP (i
->plist
);
1295 /* Merging I will give it the properties of PREV_CHANGED. */
1296 prev_changed
= i
= merge_interval_left (i
);
1299 i
= next_interval (i
);
1302 return modified
? Qt
: Qnil
;
1306 /* I don't think this is the right interface to export; how often do you
1307 want to do something like this, other than when you're copying objects
1310 I think it would be better to have a pair of functions, one which
1311 returns the text properties of a region as a list of ranges and
1312 plists, and another which applies such a list to another object. */
1314 /* Add properties from SRC to SRC of SRC, starting at POS in DEST.
1315 SRC and DEST may each refer to strings or buffers.
1316 Optional sixth argument PROP causes only that property to be copied.
1317 Properties are copied to DEST as if by `add-text-properties'.
1318 Return t if any property value actually changed, nil otherwise. */
1320 /* Note this can GC when DEST is a buffer. */
1323 copy_text_properties (start
, end
, src
, pos
, dest
, prop
)
1324 Lisp_Object start
, end
, src
, pos
, dest
, prop
;
1330 int s
, e
, e2
, p
, len
, modified
= 0;
1331 struct gcpro gcpro1
, gcpro2
;
1333 i
= validate_interval_range (src
, &start
, &end
, soft
);
1334 if (NULL_INTERVAL_P (i
))
1337 CHECK_NUMBER_COERCE_MARKER (pos
, 0);
1339 Lisp_Object dest_start
, dest_end
;
1342 XSETFASTINT (dest_end
, XINT (dest_start
) + (XINT (end
) - XINT (start
)));
1343 /* Apply this to a copy of pos; it will try to increment its arguments,
1344 which we don't want. */
1345 validate_interval_range (dest
, &dest_start
, &dest_end
, soft
);
1356 e2
= i
->position
+ LENGTH (i
);
1363 while (! NILP (plist
))
1365 if (EQ (Fcar (plist
), prop
))
1367 plist
= Fcons (prop
, Fcons (Fcar (Fcdr (plist
)), Qnil
));
1370 plist
= Fcdr (Fcdr (plist
));
1374 /* Must defer modifications to the interval tree in case src
1375 and dest refer to the same string or buffer. */
1376 stuff
= Fcons (Fcons (make_number (p
),
1377 Fcons (make_number (p
+ len
),
1378 Fcons (plist
, Qnil
))),
1382 i
= next_interval (i
);
1383 if (NULL_INTERVAL_P (i
))
1390 GCPRO2 (stuff
, dest
);
1392 while (! NILP (stuff
))
1395 res
= Fadd_text_properties (Fcar (res
), Fcar (Fcdr (res
)),
1396 Fcar (Fcdr (Fcdr (res
))), dest
);
1399 stuff
= Fcdr (stuff
);
1404 return modified
? Qt
: Qnil
;
1407 /* Call the modification hook functions in LIST, each with START and END. */
1410 call_mod_hooks (list
, start
, end
)
1411 Lisp_Object list
, start
, end
;
1413 struct gcpro gcpro1
;
1415 while (!NILP (list
))
1417 call2 (Fcar (list
), start
, end
);
1423 /* Check for read-only intervals and signal an error if we find one.
1424 Then check for any modification hooks in the range START up to
1425 (but not including) END. Create a list of all these hooks in
1426 lexicographic order, eliminating consecutive extra copies of the
1427 same hook. Then call those hooks in order, with START and END - 1
1431 verify_interval_modification (buf
, start
, end
)
1435 register INTERVAL intervals
= BUF_INTERVALS (buf
);
1436 register INTERVAL i
, prev
;
1438 register Lisp_Object prev_mod_hooks
;
1439 Lisp_Object mod_hooks
;
1440 struct gcpro gcpro1
;
1443 prev_mod_hooks
= Qnil
;
1446 interval_insert_behind_hooks
= Qnil
;
1447 interval_insert_in_front_hooks
= Qnil
;
1449 if (NULL_INTERVAL_P (intervals
))
1459 /* For an insert operation, check the two chars around the position. */
1463 Lisp_Object before
, after
;
1465 /* Set I to the interval containing the char after START,
1466 and PREV to the interval containing the char before START.
1467 Either one may be null. They may be equal. */
1468 i
= find_interval (intervals
, start
);
1470 if (start
== BUF_BEGV (buf
))
1472 else if (i
->position
== start
)
1473 prev
= previous_interval (i
);
1474 else if (i
->position
< start
)
1476 if (start
== BUF_ZV (buf
))
1479 /* If Vinhibit_read_only is set and is not a list, we can
1480 skip the read_only checks. */
1481 if (NILP (Vinhibit_read_only
) || CONSP (Vinhibit_read_only
))
1483 /* If I and PREV differ we need to check for the read-only
1484 property together with its stickyness. If either I or
1485 PREV are 0, this check is all we need.
1486 We have to take special care, since read-only may be
1487 indirectly defined via the category property. */
1490 if (! NULL_INTERVAL_P (i
))
1492 after
= textget (i
->plist
, Qread_only
);
1494 /* If interval I is read-only and read-only is
1495 front-sticky, inhibit insertion.
1496 Check for read-only as well as category. */
1498 && NILP (Fmemq (after
, Vinhibit_read_only
)))
1502 tem
= textget (i
->plist
, Qfront_sticky
);
1503 if (TMEM (Qread_only
, tem
)
1504 || (NILP (Fplist_get (i
->plist
, Qread_only
))
1505 && TMEM (Qcategory
, tem
)))
1506 error ("Attempt to insert within read-only text");
1510 if (! NULL_INTERVAL_P (prev
))
1512 before
= textget (prev
->plist
, Qread_only
);
1514 /* If interval PREV is read-only and read-only isn't
1515 rear-nonsticky, inhibit insertion.
1516 Check for read-only as well as category. */
1518 && NILP (Fmemq (before
, Vinhibit_read_only
)))
1522 tem
= textget (prev
->plist
, Qrear_nonsticky
);
1523 if (! TMEM (Qread_only
, tem
)
1524 && (! NILP (Fplist_get (prev
->plist
,Qread_only
))
1525 || ! TMEM (Qcategory
, tem
)))
1526 error ("Attempt to insert within read-only text");
1530 else if (! NULL_INTERVAL_P (i
))
1532 after
= textget (i
->plist
, Qread_only
);
1534 /* If interval I is read-only and read-only is
1535 front-sticky, inhibit insertion.
1536 Check for read-only as well as category. */
1537 if (! NILP (after
) && NILP (Fmemq (after
, Vinhibit_read_only
)))
1541 tem
= textget (i
->plist
, Qfront_sticky
);
1542 if (TMEM (Qread_only
, tem
)
1543 || (NILP (Fplist_get (i
->plist
, Qread_only
))
1544 && TMEM (Qcategory
, tem
)))
1545 error ("Attempt to insert within read-only text");
1547 tem
= textget (prev
->plist
, Qrear_nonsticky
);
1548 if (! TMEM (Qread_only
, tem
)
1549 && (! NILP (Fplist_get (prev
->plist
, Qread_only
))
1550 || ! TMEM (Qcategory
, tem
)))
1551 error ("Attempt to insert within read-only text");
1556 /* Run both insert hooks (just once if they're the same). */
1557 if (!NULL_INTERVAL_P (prev
))
1558 interval_insert_behind_hooks
1559 = textget (prev
->plist
, Qinsert_behind_hooks
);
1560 if (!NULL_INTERVAL_P (i
))
1561 interval_insert_in_front_hooks
1562 = textget (i
->plist
, Qinsert_in_front_hooks
);
1566 /* Loop over intervals on or next to START...END,
1567 collecting their hooks. */
1569 i
= find_interval (intervals
, start
);
1572 if (! INTERVAL_WRITABLE_P (i
))
1573 error ("Attempt to modify read-only text");
1575 mod_hooks
= textget (i
->plist
, Qmodification_hooks
);
1576 if (! NILP (mod_hooks
) && ! EQ (mod_hooks
, prev_mod_hooks
))
1578 hooks
= Fcons (mod_hooks
, hooks
);
1579 prev_mod_hooks
= mod_hooks
;
1582 i
= next_interval (i
);
1584 /* Keep going thru the interval containing the char before END. */
1585 while (! NULL_INTERVAL_P (i
) && i
->position
< end
);
1588 hooks
= Fnreverse (hooks
);
1589 while (! EQ (hooks
, Qnil
))
1591 call_mod_hooks (Fcar (hooks
), make_number (start
),
1593 hooks
= Fcdr (hooks
);
1599 /* Run the interval hooks for an insertion.
1600 verify_interval_modification chose which hooks to run;
1601 this function is called after the insertion happens
1602 so it can indicate the range of inserted text. */
1605 report_interval_modification (start
, end
)
1606 Lisp_Object start
, end
;
1608 if (! NILP (interval_insert_behind_hooks
))
1609 call_mod_hooks (interval_insert_behind_hooks
,
1610 make_number (start
), make_number (end
));
1611 if (! NILP (interval_insert_in_front_hooks
)
1612 && ! EQ (interval_insert_in_front_hooks
,
1613 interval_insert_behind_hooks
))
1614 call_mod_hooks (interval_insert_in_front_hooks
,
1615 make_number (start
), make_number (end
));
1621 DEFVAR_LISP ("default-text-properties", &Vdefault_text_properties
,
1622 "Property-list used as default values.\n\
1623 The value of a property in this list is seen as the value for every\n\
1624 character that does not have its own value for that property.");
1625 Vdefault_text_properties
= Qnil
;
1627 DEFVAR_LISP ("inhibit-point-motion-hooks", &Vinhibit_point_motion_hooks
,
1628 "If non-nil, don't run `point-left' and `point-entered' text properties.\n\
1629 This also inhibits the use of the `intangible' text property.");
1630 Vinhibit_point_motion_hooks
= Qnil
;
1632 staticpro (&interval_insert_behind_hooks
);
1633 staticpro (&interval_insert_in_front_hooks
);
1634 interval_insert_behind_hooks
= Qnil
;
1635 interval_insert_in_front_hooks
= Qnil
;
1638 /* Common attributes one might give text */
1640 staticpro (&Qforeground
);
1641 Qforeground
= intern ("foreground");
1642 staticpro (&Qbackground
);
1643 Qbackground
= intern ("background");
1645 Qfont
= intern ("font");
1646 staticpro (&Qstipple
);
1647 Qstipple
= intern ("stipple");
1648 staticpro (&Qunderline
);
1649 Qunderline
= intern ("underline");
1650 staticpro (&Qread_only
);
1651 Qread_only
= intern ("read-only");
1652 staticpro (&Qinvisible
);
1653 Qinvisible
= intern ("invisible");
1654 staticpro (&Qintangible
);
1655 Qintangible
= intern ("intangible");
1656 staticpro (&Qcategory
);
1657 Qcategory
= intern ("category");
1658 staticpro (&Qlocal_map
);
1659 Qlocal_map
= intern ("local-map");
1660 staticpro (&Qfront_sticky
);
1661 Qfront_sticky
= intern ("front-sticky");
1662 staticpro (&Qrear_nonsticky
);
1663 Qrear_nonsticky
= intern ("rear-nonsticky");
1665 /* Properties that text might use to specify certain actions */
1667 staticpro (&Qmouse_left
);
1668 Qmouse_left
= intern ("mouse-left");
1669 staticpro (&Qmouse_entered
);
1670 Qmouse_entered
= intern ("mouse-entered");
1671 staticpro (&Qpoint_left
);
1672 Qpoint_left
= intern ("point-left");
1673 staticpro (&Qpoint_entered
);
1674 Qpoint_entered
= intern ("point-entered");
1676 defsubr (&Stext_properties_at
);
1677 defsubr (&Sget_text_property
);
1678 defsubr (&Sget_char_property
);
1679 defsubr (&Snext_property_change
);
1680 defsubr (&Snext_single_property_change
);
1681 defsubr (&Sprevious_property_change
);
1682 defsubr (&Sprevious_single_property_change
);
1683 defsubr (&Sadd_text_properties
);
1684 defsubr (&Sput_text_property
);
1685 defsubr (&Sset_text_properties
);
1686 defsubr (&Sremove_text_properties
);
1687 defsubr (&Stext_property_any
);
1688 defsubr (&Stext_property_not_all
);
1689 /* defsubr (&Serase_text_properties); */
1690 /* defsubr (&Scopy_text_properties); */
1695 lose
-- this shouldn
't be compiled if USE_TEXT_PROPERTIES isn't defined
1697 #endif /* USE_TEXT_PROPERTIES */