]> code.delx.au - gnu-emacs/blob - src/textprop.c
(Fnext_property_change): Properly offset interval
[gnu-emacs] / src / textprop.c
1 /* Interface code for dealing with text properties.
2 Copyright (C) 1993, 1994, 1995, 1997 Free Software Foundation, Inc.
3
4 This file is part of GNU Emacs.
5
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)
9 any later version.
10
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.
15
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, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
20
21 #include <config.h>
22 #include "lisp.h"
23 #include "intervals.h"
24 #include "buffer.h"
25 #include "window.h"
26
27 #ifndef NULL
28 #define NULL (void *)0
29 #endif
30
31 /* Test for membership, allowing for t (actually any non-cons) to mean the
32 universal set. */
33
34 #define TMEM(sym, set) (CONSP (set) ? ! NILP (Fmemq (sym, set)) : ! NILP (set))
35 \f
36
37 /* NOTES: previous- and next- property change will have to skip
38 zero-length intervals if they are implemented. This could be done
39 inside next_interval and previous_interval.
40
41 set_properties needs to deal with the interval property cache.
42
43 It is assumed that for any interval plist, a property appears
44 only once on the list. Although some code i.e., remove_properties,
45 handles the more general case, the uniqueness of properties is
46 necessary for the system to remain consistent. This requirement
47 is enforced by the subrs installing properties onto the intervals. */
48
49 /* The rest of the file is within this conditional */
50 #ifdef USE_TEXT_PROPERTIES
51 \f
52 /* Types of hooks. */
53 Lisp_Object Qmouse_left;
54 Lisp_Object Qmouse_entered;
55 Lisp_Object Qpoint_left;
56 Lisp_Object Qpoint_entered;
57 Lisp_Object Qcategory;
58 Lisp_Object Qlocal_map;
59
60 /* Visual properties text (including strings) may have. */
61 Lisp_Object Qforeground, Qbackground, Qfont, Qunderline, Qstipple;
62 Lisp_Object Qinvisible, Qread_only, Qintangible;
63
64 /* Sticky properties */
65 Lisp_Object Qfront_sticky, Qrear_nonsticky;
66
67 /* If o1 is a cons whose cdr is a cons, return non-zero and set o2 to
68 the o1's cdr. Otherwise, return zero. This is handy for
69 traversing plists. */
70 #define PLIST_ELT_P(o1, o2) (CONSP (o1) && ((o2)=XCONS (o1)->cdr, CONSP (o2)))
71
72 Lisp_Object Vinhibit_point_motion_hooks;
73 Lisp_Object Vdefault_text_properties;
74
75 /* verify_interval_modification saves insertion hooks here
76 to be run later by report_interval_modification. */
77 Lisp_Object interval_insert_behind_hooks;
78 Lisp_Object interval_insert_in_front_hooks;
79 \f
80 /* Extract the interval at the position pointed to by BEGIN from
81 OBJECT, a string or buffer. Additionally, check that the positions
82 pointed to by BEGIN and END are within the bounds of OBJECT, and
83 reverse them if *BEGIN is greater than *END. The objects pointed
84 to by BEGIN and END may be integers or markers; if the latter, they
85 are coerced to integers.
86
87 When OBJECT is a string, we increment *BEGIN and *END
88 to make them origin-one.
89
90 Note that buffer points don't correspond to interval indices.
91 For example, point-max is 1 greater than the index of the last
92 character. This difference is handled in the caller, which uses
93 the validated points to determine a length, and operates on that.
94 Exceptions are Ftext_properties_at, Fnext_property_change, and
95 Fprevious_property_change which call this function with BEGIN == END.
96 Handle this case specially.
97
98 If FORCE is soft (0), it's OK to return NULL_INTERVAL. Otherwise,
99 create an interval tree for OBJECT if one doesn't exist, provided
100 the object actually contains text. In the current design, if there
101 is no text, there can be no text properties. */
102
103 #define soft 0
104 #define hard 1
105
106 static INTERVAL
107 validate_interval_range (object, begin, end, force)
108 Lisp_Object object, *begin, *end;
109 int force;
110 {
111 register INTERVAL i;
112 int searchpos;
113
114 CHECK_STRING_OR_BUFFER (object, 0);
115 CHECK_NUMBER_COERCE_MARKER (*begin, 0);
116 CHECK_NUMBER_COERCE_MARKER (*end, 0);
117
118 /* If we are asked for a point, but from a subr which operates
119 on a range, then return nothing. */
120 if (EQ (*begin, *end) && begin != end)
121 return NULL_INTERVAL;
122
123 if (XINT (*begin) > XINT (*end))
124 {
125 Lisp_Object n;
126 n = *begin;
127 *begin = *end;
128 *end = n;
129 }
130
131 if (BUFFERP (object))
132 {
133 register struct buffer *b = XBUFFER (object);
134
135 if (!(BUF_BEGV (b) <= XINT (*begin) && XINT (*begin) <= XINT (*end)
136 && XINT (*end) <= BUF_ZV (b)))
137 args_out_of_range (*begin, *end);
138 i = BUF_INTERVALS (b);
139
140 /* If there's no text, there are no properties. */
141 if (BUF_BEGV (b) == BUF_ZV (b))
142 return NULL_INTERVAL;
143
144 searchpos = XINT (*begin);
145 }
146 else
147 {
148 register struct Lisp_String *s = XSTRING (object);
149
150 if (! (0 <= XINT (*begin) && XINT (*begin) <= XINT (*end)
151 && XINT (*end) <= s->size))
152 args_out_of_range (*begin, *end);
153 /* User-level Positions in strings start with 0,
154 but the interval code always wants positions starting with 1. */
155 XSETFASTINT (*begin, XFASTINT (*begin) + 1);
156 if (begin != end)
157 XSETFASTINT (*end, XFASTINT (*end) + 1);
158 i = s->intervals;
159
160 if (s->size == 0)
161 return NULL_INTERVAL;
162
163 searchpos = XINT (*begin);
164 }
165
166 if (NULL_INTERVAL_P (i))
167 return (force ? create_root_interval (object) : i);
168
169 return find_interval (i, searchpos);
170 }
171
172 /* Validate LIST as a property list. If LIST is not a list, then
173 make one consisting of (LIST nil). Otherwise, verify that LIST
174 is even numbered and thus suitable as a plist. */
175
176 static Lisp_Object
177 validate_plist (list)
178 Lisp_Object list;
179 {
180 if (NILP (list))
181 return Qnil;
182
183 if (CONSP (list))
184 {
185 register int i;
186 register Lisp_Object tail;
187 for (i = 0, tail = list; !NILP (tail); i++)
188 {
189 tail = Fcdr (tail);
190 QUIT;
191 }
192 if (i & 1)
193 error ("Odd length text property list");
194 return list;
195 }
196
197 return Fcons (list, Fcons (Qnil, Qnil));
198 }
199
200 /* Return nonzero if interval I has all the properties,
201 with the same values, of list PLIST. */
202
203 static int
204 interval_has_all_properties (plist, i)
205 Lisp_Object plist;
206 INTERVAL i;
207 {
208 register Lisp_Object tail1, tail2, sym1, sym2;
209 register int found;
210
211 /* Go through each element of PLIST. */
212 for (tail1 = plist; ! NILP (tail1); tail1 = Fcdr (Fcdr (tail1)))
213 {
214 sym1 = Fcar (tail1);
215 found = 0;
216
217 /* Go through I's plist, looking for sym1 */
218 for (tail2 = i->plist; ! NILP (tail2); tail2 = Fcdr (Fcdr (tail2)))
219 if (EQ (sym1, Fcar (tail2)))
220 {
221 /* Found the same property on both lists. If the
222 values are unequal, return zero. */
223 if (! EQ (Fcar (Fcdr (tail1)), Fcar (Fcdr (tail2))))
224 return 0;
225
226 /* Property has same value on both lists; go to next one. */
227 found = 1;
228 break;
229 }
230
231 if (! found)
232 return 0;
233 }
234
235 return 1;
236 }
237
238 /* Return nonzero if the plist of interval I has any of the
239 properties of PLIST, regardless of their values. */
240
241 static INLINE int
242 interval_has_some_properties (plist, i)
243 Lisp_Object plist;
244 INTERVAL i;
245 {
246 register Lisp_Object tail1, tail2, sym;
247
248 /* Go through each element of PLIST. */
249 for (tail1 = plist; ! NILP (tail1); tail1 = Fcdr (Fcdr (tail1)))
250 {
251 sym = Fcar (tail1);
252
253 /* Go through i's plist, looking for tail1 */
254 for (tail2 = i->plist; ! NILP (tail2); tail2 = Fcdr (Fcdr (tail2)))
255 if (EQ (sym, Fcar (tail2)))
256 return 1;
257 }
258
259 return 0;
260 }
261 \f
262 /* Changing the plists of individual intervals. */
263
264 /* Return the value of PROP in property-list PLIST, or Qunbound if it
265 has none. */
266 static Lisp_Object
267 property_value (plist, prop)
268 Lisp_Object plist, prop;
269 {
270 Lisp_Object value;
271
272 while (PLIST_ELT_P (plist, value))
273 if (EQ (XCONS (plist)->car, prop))
274 return XCONS (value)->car;
275 else
276 plist = XCONS (value)->cdr;
277
278 return Qunbound;
279 }
280
281 /* Set the properties of INTERVAL to PROPERTIES,
282 and record undo info for the previous values.
283 OBJECT is the string or buffer that INTERVAL belongs to. */
284
285 static void
286 set_properties (properties, interval, object)
287 Lisp_Object properties, object;
288 INTERVAL interval;
289 {
290 Lisp_Object sym, value;
291
292 if (BUFFERP (object))
293 {
294 /* For each property in the old plist which is missing from PROPERTIES,
295 or has a different value in PROPERTIES, make an undo record. */
296 for (sym = interval->plist;
297 PLIST_ELT_P (sym, value);
298 sym = XCONS (value)->cdr)
299 if (! EQ (property_value (properties, XCONS (sym)->car),
300 XCONS (value)->car))
301 {
302 record_property_change (interval->position, LENGTH (interval),
303 XCONS (sym)->car, XCONS (value)->car,
304 object);
305 }
306
307 /* For each new property that has no value at all in the old plist,
308 make an undo record binding it to nil, so it will be removed. */
309 for (sym = properties;
310 PLIST_ELT_P (sym, value);
311 sym = XCONS (value)->cdr)
312 if (EQ (property_value (interval->plist, XCONS (sym)->car), Qunbound))
313 {
314 record_property_change (interval->position, LENGTH (interval),
315 XCONS (sym)->car, Qnil,
316 object);
317 }
318 }
319
320 /* Store new properties. */
321 interval->plist = Fcopy_sequence (properties);
322 }
323
324 /* Add the properties of PLIST to the interval I, or set
325 the value of I's property to the value of the property on PLIST
326 if they are different.
327
328 OBJECT should be the string or buffer the interval is in.
329
330 Return nonzero if this changes I (i.e., if any members of PLIST
331 are actually added to I's plist) */
332
333 static int
334 add_properties (plist, i, object)
335 Lisp_Object plist;
336 INTERVAL i;
337 Lisp_Object object;
338 {
339 Lisp_Object tail1, tail2, sym1, val1;
340 register int changed = 0;
341 register int found;
342 struct gcpro gcpro1, gcpro2, gcpro3;
343
344 tail1 = plist;
345 sym1 = Qnil;
346 val1 = Qnil;
347 /* No need to protect OBJECT, because we can GC only in the case
348 where it is a buffer, and live buffers are always protected.
349 I and its plist are also protected, via OBJECT. */
350 GCPRO3 (tail1, sym1, val1);
351
352 /* Go through each element of PLIST. */
353 for (tail1 = plist; ! NILP (tail1); tail1 = Fcdr (Fcdr (tail1)))
354 {
355 sym1 = Fcar (tail1);
356 val1 = Fcar (Fcdr (tail1));
357 found = 0;
358
359 /* Go through I's plist, looking for sym1 */
360 for (tail2 = i->plist; ! NILP (tail2); tail2 = Fcdr (Fcdr (tail2)))
361 if (EQ (sym1, Fcar (tail2)))
362 {
363 /* No need to gcpro, because tail2 protects this
364 and it must be a cons cell (we get an error otherwise). */
365 register Lisp_Object this_cdr;
366
367 this_cdr = Fcdr (tail2);
368 /* Found the property. Now check its value. */
369 found = 1;
370
371 /* The properties have the same value on both lists.
372 Continue to the next property. */
373 if (EQ (val1, Fcar (this_cdr)))
374 break;
375
376 /* Record this change in the buffer, for undo purposes. */
377 if (BUFFERP (object))
378 {
379 record_property_change (i->position, LENGTH (i),
380 sym1, Fcar (this_cdr), object);
381 }
382
383 /* I's property has a different value -- change it */
384 Fsetcar (this_cdr, val1);
385 changed++;
386 break;
387 }
388
389 if (! found)
390 {
391 /* Record this change in the buffer, for undo purposes. */
392 if (BUFFERP (object))
393 {
394 record_property_change (i->position, LENGTH (i),
395 sym1, Qnil, object);
396 }
397 i->plist = Fcons (sym1, Fcons (val1, i->plist));
398 changed++;
399 }
400 }
401
402 UNGCPRO;
403
404 return changed;
405 }
406
407 /* For any members of PLIST which are properties of I, remove them
408 from I's plist.
409 OBJECT is the string or buffer containing I. */
410
411 static int
412 remove_properties (plist, i, object)
413 Lisp_Object plist;
414 INTERVAL i;
415 Lisp_Object object;
416 {
417 register Lisp_Object tail1, tail2, sym, current_plist;
418 register int changed = 0;
419
420 current_plist = i->plist;
421 /* Go through each element of plist. */
422 for (tail1 = plist; ! NILP (tail1); tail1 = Fcdr (Fcdr (tail1)))
423 {
424 sym = Fcar (tail1);
425
426 /* First, remove the symbol if its at the head of the list */
427 while (! NILP (current_plist) && EQ (sym, Fcar (current_plist)))
428 {
429 if (BUFFERP (object))
430 {
431 record_property_change (i->position, LENGTH (i),
432 sym, Fcar (Fcdr (current_plist)),
433 object);
434 }
435
436 current_plist = Fcdr (Fcdr (current_plist));
437 changed++;
438 }
439
440 /* Go through i's plist, looking for sym */
441 tail2 = current_plist;
442 while (! NILP (tail2))
443 {
444 register Lisp_Object this;
445 this = Fcdr (Fcdr (tail2));
446 if (EQ (sym, Fcar (this)))
447 {
448 if (BUFFERP (object))
449 {
450 record_property_change (i->position, LENGTH (i),
451 sym, Fcar (Fcdr (this)), object);
452 }
453
454 Fsetcdr (Fcdr (tail2), Fcdr (Fcdr (this)));
455 changed++;
456 }
457 tail2 = this;
458 }
459 }
460
461 if (changed)
462 i->plist = current_plist;
463 return changed;
464 }
465
466 #if 0
467 /* Remove all properties from interval I. Return non-zero
468 if this changes the interval. */
469
470 static INLINE int
471 erase_properties (i)
472 INTERVAL i;
473 {
474 if (NILP (i->plist))
475 return 0;
476
477 i->plist = Qnil;
478 return 1;
479 }
480 #endif
481 \f
482 /* Returns the interval of the POSITION in OBJECT.
483 POSITION is BEG-based. */
484
485 INTERVAL
486 interval_of (position, object)
487 int position;
488 Lisp_Object object;
489 {
490 register INTERVAL i;
491 int beg, end;
492
493 if (NILP (object))
494 XSETBUFFER (object, current_buffer);
495 else if (EQ (object, Qt))
496 return NULL_INTERVAL;
497
498 CHECK_STRING_OR_BUFFER (object, 0);
499
500 if (BUFFERP (object))
501 {
502 register struct buffer *b = XBUFFER (object);
503
504 beg = BUF_BEGV (b);
505 end = BUF_ZV (b);
506 i = BUF_INTERVALS (b);
507 }
508 else
509 {
510 register struct Lisp_String *s = XSTRING (object);
511
512 /* We expect position to be 1-based. */
513 beg = BEG;
514 end = s->size + BEG;
515 i = s->intervals;
516 }
517
518 if (!(beg <= position && position <= end))
519 args_out_of_range (make_number (position), make_number (position));
520 if (beg == end || NULL_INTERVAL_P (i))
521 return NULL_INTERVAL;
522
523 return find_interval (i, position);
524 }
525 \f
526 DEFUN ("text-properties-at", Ftext_properties_at,
527 Stext_properties_at, 1, 2, 0,
528 "Return the list of properties of the character at POSITION in OBJECT.\n\
529 OBJECT is the string or buffer to look for the properties in;\n\
530 nil means the current buffer.\n\
531 If POSITION is at the end of OBJECT, the value is nil.")
532 (position, object)
533 Lisp_Object position, object;
534 {
535 register INTERVAL i;
536
537 if (NILP (object))
538 XSETBUFFER (object, current_buffer);
539
540 i = validate_interval_range (object, &position, &position, soft);
541 if (NULL_INTERVAL_P (i))
542 return Qnil;
543 /* If POSITION is at the end of the interval,
544 it means it's the end of OBJECT.
545 There are no properties at the very end,
546 since no character follows. */
547 if (XINT (position) == LENGTH (i) + i->position)
548 return Qnil;
549
550 return i->plist;
551 }
552
553 DEFUN ("get-text-property", Fget_text_property, Sget_text_property, 2, 3, 0,
554 "Return the value of POSITION's property PROP, in OBJECT.\n\
555 OBJECT is optional and defaults to the current buffer.\n\
556 If POSITION is at the end of OBJECT, the value is nil.")
557 (position, prop, object)
558 Lisp_Object position, object;
559 Lisp_Object prop;
560 {
561 return textget (Ftext_properties_at (position, object), prop);
562 }
563
564 DEFUN ("get-char-property", Fget_char_property, Sget_char_property, 2, 3, 0,
565 "Return the value of POSITION's property PROP, in OBJECT.\n\
566 OBJECT is optional and defaults to the current buffer.\n\
567 If POSITION is at the end of OBJECT, the value is nil.\n\
568 If OBJECT is a buffer, then overlay properties are considered as well as\n\
569 text properties.\n\
570 If OBJECT is a window, then that window's buffer is used, but window-specific\n\
571 overlays are considered only if they are associated with OBJECT.")
572 (position, prop, object)
573 Lisp_Object position, object;
574 register Lisp_Object prop;
575 {
576 struct window *w = 0;
577
578 CHECK_NUMBER_COERCE_MARKER (position, 0);
579
580 if (NILP (object))
581 XSETBUFFER (object, current_buffer);
582
583 if (WINDOWP (object))
584 {
585 w = XWINDOW (object);
586 object = w->buffer;
587 }
588 if (BUFFERP (object))
589 {
590 int posn = XINT (position);
591 int noverlays;
592 Lisp_Object *overlay_vec, tem;
593 int next_overlay;
594 int len;
595 struct buffer *obuf = current_buffer;
596
597 set_buffer_temp (XBUFFER (object));
598
599 /* First try with room for 40 overlays. */
600 len = 40;
601 overlay_vec = (Lisp_Object *) alloca (len * sizeof (Lisp_Object));
602
603 noverlays = overlays_at (posn, 0, &overlay_vec, &len,
604 &next_overlay, NULL);
605
606 /* If there are more than 40,
607 make enough space for all, and try again. */
608 if (noverlays > len)
609 {
610 len = noverlays;
611 overlay_vec = (Lisp_Object *) alloca (len * sizeof (Lisp_Object));
612 noverlays = overlays_at (posn, 0, &overlay_vec, &len,
613 &next_overlay, NULL);
614 }
615 noverlays = sort_overlays (overlay_vec, noverlays, w);
616
617 set_buffer_temp (obuf);
618
619 /* Now check the overlays in order of decreasing priority. */
620 while (--noverlays >= 0)
621 {
622 tem = Foverlay_get (overlay_vec[noverlays], prop);
623 if (!NILP (tem))
624 return (tem);
625 }
626 }
627 /* Not a buffer, or no appropriate overlay, so fall through to the
628 simpler case. */
629 return (Fget_text_property (position, prop, object));
630 }
631 \f
632 DEFUN ("next-char-property-change", Fnext_char_property_change,
633 Snext_char_property_change, 1, 2, 0,
634 "Return the position of next text property or overlay change.\n\
635 This scans characters forward from POSITION in OBJECT till it finds\n\
636 a change in some text property, or the beginning or end of an overlay,\n\
637 and returns the position of that.\n\
638 If none is found, the function returns (point-max).\n\
639 \n\
640 If the optional third argument LIMIT is non-nil, don't search\n\
641 past position LIMIT; return LIMIT if nothing is found before LIMIT.")
642 (position, limit)
643 Lisp_Object position, limit;
644 {
645 Lisp_Object temp;
646
647 temp = Fnext_overlay_change (position);
648 if (! NILP (limit))
649 {
650 CHECK_NUMBER (limit, 2);
651 if (XINT (limit) < XINT (temp))
652 temp = limit;
653 }
654 return Fnext_property_change (position, Qnil, temp);
655 }
656
657 DEFUN ("previous-char-property-change", Fprevious_char_property_change,
658 Sprevious_char_property_change, 1, 2, 0,
659 "Return the position of previous text property or overlay change.\n\
660 Scans characters backward from POSITION in OBJECT till it finds\n\
661 a change in some text property, or the beginning or end of an overlay,\n\
662 and returns the position of that.\n\
663 If none is found, the function returns (point-max).\n\
664 \n\
665 If the optional third argument LIMIT is non-nil, don't search\n\
666 past position LIMIT; return LIMIT if nothing is found before LIMIT.")
667 (position, limit)
668 Lisp_Object position, limit;
669 {
670 Lisp_Object temp;
671
672 temp = Fprevious_overlay_change (position);
673 if (! NILP (limit))
674 {
675 CHECK_NUMBER (limit, 2);
676 if (XINT (limit) > XINT (temp))
677 temp = limit;
678 }
679 return Fprevious_property_change (position, Qnil, temp);
680 }
681 \f
682 DEFUN ("next-property-change", Fnext_property_change,
683 Snext_property_change, 1, 3, 0,
684 "Return the position of next property change.\n\
685 Scans characters forward from POSITION in OBJECT till it finds\n\
686 a change in some text property, then returns the position of the change.\n\
687 The optional second argument OBJECT is the string or buffer to scan.\n\
688 Return nil if the property is constant all the way to the end of OBJECT.\n\
689 If the value is non-nil, it is a position greater than POSITION, never equal.\n\n\
690 If the optional third argument LIMIT is non-nil, don't search\n\
691 past position LIMIT; return LIMIT if nothing is found before LIMIT.")
692 (position, object, limit)
693 Lisp_Object position, object, limit;
694 {
695 register INTERVAL i, next;
696
697 if (NILP (object))
698 XSETBUFFER (object, current_buffer);
699
700 if (! NILP (limit) && ! EQ (limit, Qt))
701 CHECK_NUMBER_COERCE_MARKER (limit, 0);
702
703 i = validate_interval_range (object, &position, &position, soft);
704
705 /* If LIMIT is t, return start of next interval--don't
706 bother checking further intervals. */
707 if (EQ (limit, Qt))
708 {
709 if (NULL_INTERVAL_P (i))
710 next = i;
711 else
712 next = next_interval (i);
713
714 if (NULL_INTERVAL_P (next))
715 XSETFASTINT (position, (STRINGP (object)
716 ? XSTRING (object)->size
717 : BUF_ZV (XBUFFER (object))));
718 else
719 XSETFASTINT (position, next->position - (STRINGP (object)));
720 return position;
721 }
722
723 if (NULL_INTERVAL_P (i))
724 return limit;
725
726 next = next_interval (i);
727
728 while (! NULL_INTERVAL_P (next) && intervals_equal (i, next)
729 && (NILP (limit)
730 || next->position - (STRINGP (object)) < XFASTINT (limit)))
731 next = next_interval (next);
732
733 if (NULL_INTERVAL_P (next))
734 return limit;
735 if (! NILP (limit)
736 && !(next->position - (STRINGP (object)) < XFASTINT (limit)))
737 return limit;
738
739 XSETFASTINT (position, next->position - (STRINGP (object)));
740 return position;
741 }
742
743 /* Return 1 if there's a change in some property between BEG and END. */
744
745 int
746 property_change_between_p (beg, end)
747 int beg, end;
748 {
749 register INTERVAL i, next;
750 Lisp_Object object, pos;
751
752 XSETBUFFER (object, current_buffer);
753 XSETFASTINT (pos, beg);
754
755 i = validate_interval_range (object, &pos, &pos, soft);
756 if (NULL_INTERVAL_P (i))
757 return 0;
758
759 next = next_interval (i);
760 while (! NULL_INTERVAL_P (next) && intervals_equal (i, next))
761 {
762 next = next_interval (next);
763 if (NULL_INTERVAL_P (next))
764 return 0;
765 if (next->position - (STRINGP (object)) >= end)
766 return 0;
767 }
768
769 if (NULL_INTERVAL_P (next))
770 return 0;
771
772 return 1;
773 }
774
775 DEFUN ("next-single-property-change", Fnext_single_property_change,
776 Snext_single_property_change, 2, 4, 0,
777 "Return the position of next property change for a specific property.\n\
778 Scans characters forward from POSITION till it finds\n\
779 a change in the PROP property, then returns the position of the change.\n\
780 The optional third argument OBJECT is the string or buffer to scan.\n\
781 The property values are compared with `eq'.\n\
782 Return nil if the property is constant all the way to the end of OBJECT.\n\
783 If the value is non-nil, it is a position greater than POSITION, never equal.\n\n\
784 If the optional fourth argument LIMIT is non-nil, don't search\n\
785 past position LIMIT; return LIMIT if nothing is found before LIMIT.")
786 (position, prop, object, limit)
787 Lisp_Object position, prop, object, limit;
788 {
789 register INTERVAL i, next;
790 register Lisp_Object here_val;
791
792 if (NILP (object))
793 XSETBUFFER (object, current_buffer);
794
795 if (!NILP (limit))
796 CHECK_NUMBER_COERCE_MARKER (limit, 0);
797
798 i = validate_interval_range (object, &position, &position, soft);
799 if (NULL_INTERVAL_P (i))
800 return limit;
801
802 here_val = textget (i->plist, prop);
803 next = next_interval (i);
804 while (! NULL_INTERVAL_P (next)
805 && EQ (here_val, textget (next->plist, prop))
806 && (NILP (limit) || next->position - (STRINGP (object)) < XFASTINT (limit)))
807 next = next_interval (next);
808
809 if (NULL_INTERVAL_P (next))
810 return limit;
811 if (! NILP (limit)
812 && !(next->position - (STRINGP (object)) < XFASTINT (limit)))
813 return limit;
814
815 XSETFASTINT (position, next->position - (STRINGP (object)));
816 return position;
817 }
818
819 DEFUN ("previous-property-change", Fprevious_property_change,
820 Sprevious_property_change, 1, 3, 0,
821 "Return the position of previous property change.\n\
822 Scans characters backwards from POSITION in OBJECT till it finds\n\
823 a change in some text property, then returns the position of the change.\n\
824 The optional second argument OBJECT is the string or buffer to scan.\n\
825 Return nil if the property is constant all the way to the start of OBJECT.\n\
826 If the value is non-nil, it is a position less than POSITION, never equal.\n\n\
827 If the optional third argument LIMIT is non-nil, don't search\n\
828 back past position LIMIT; return LIMIT if nothing is found until LIMIT.")
829 (position, object, limit)
830 Lisp_Object position, object, limit;
831 {
832 register INTERVAL i, previous;
833
834 if (NILP (object))
835 XSETBUFFER (object, current_buffer);
836
837 if (!NILP (limit))
838 CHECK_NUMBER_COERCE_MARKER (limit, 0);
839
840 i = validate_interval_range (object, &position, &position, soft);
841 if (NULL_INTERVAL_P (i))
842 return limit;
843
844 /* Start with the interval containing the char before point. */
845 if (i->position == XFASTINT (position))
846 i = previous_interval (i);
847
848 previous = previous_interval (i);
849 while (! NULL_INTERVAL_P (previous) && intervals_equal (previous, i)
850 && (NILP (limit)
851 || (previous->position + LENGTH (previous) - (STRINGP (object))
852 > XFASTINT (limit))))
853 previous = previous_interval (previous);
854 if (NULL_INTERVAL_P (previous))
855 return limit;
856 if (!NILP (limit)
857 && !(previous->position + LENGTH (previous) - (STRINGP (object))
858 > XFASTINT (limit)))
859 return limit;
860
861 XSETFASTINT (position, (previous->position + LENGTH (previous)
862 - (STRINGP (object))));
863 return position;
864 }
865
866 DEFUN ("previous-single-property-change", Fprevious_single_property_change,
867 Sprevious_single_property_change, 2, 4, 0,
868 "Return the position of previous property change for a specific property.\n\
869 Scans characters backward from POSITION till it finds\n\
870 a change in the PROP property, then returns the position of the change.\n\
871 The optional third argument OBJECT is the string or buffer to scan.\n\
872 The property values are compared with `eq'.\n\
873 Return nil if the property is constant all the way to the start of OBJECT.\n\
874 If the value is non-nil, it is a position less than POSITION, never equal.\n\n\
875 If the optional fourth argument LIMIT is non-nil, don't search\n\
876 back past position LIMIT; return LIMIT if nothing is found until LIMIT.")
877 (position, prop, object, limit)
878 Lisp_Object position, prop, object, limit;
879 {
880 register INTERVAL i, previous;
881 register Lisp_Object here_val;
882
883 if (NILP (object))
884 XSETBUFFER (object, current_buffer);
885
886 if (!NILP (limit))
887 CHECK_NUMBER_COERCE_MARKER (limit, 0);
888
889 i = validate_interval_range (object, &position, &position, soft);
890
891 /* Start with the interval containing the char before point. */
892 if (! NULL_INTERVAL_P (i) && i->position == XFASTINT (position))
893 i = previous_interval (i);
894
895 if (NULL_INTERVAL_P (i))
896 return limit;
897
898 here_val = textget (i->plist, prop);
899 previous = previous_interval (i);
900 while (! NULL_INTERVAL_P (previous)
901 && EQ (here_val, textget (previous->plist, prop))
902 && (NILP (limit)
903 || (previous->position + LENGTH (previous) - (STRINGP (object))
904 > XFASTINT (limit))))
905 previous = previous_interval (previous);
906 if (NULL_INTERVAL_P (previous))
907 return limit;
908 if (!NILP (limit)
909 && !(previous->position + LENGTH (previous) - (STRINGP (object))
910 > XFASTINT (limit)))
911 return limit;
912
913 XSETFASTINT (position, (previous->position + LENGTH (previous)
914 - (STRINGP (object))));
915 return position;
916 }
917 \f
918 /* Callers note, this can GC when OBJECT is a buffer (or nil). */
919
920 DEFUN ("add-text-properties", Fadd_text_properties,
921 Sadd_text_properties, 3, 4, 0,
922 "Add properties to the text from START to END.\n\
923 The third argument PROPERTIES is a property list\n\
924 specifying the property values to add.\n\
925 The optional fourth argument, OBJECT,\n\
926 is the string or buffer containing the text.\n\
927 Return t if any property value actually changed, nil otherwise.")
928 (start, end, properties, object)
929 Lisp_Object start, end, properties, object;
930 {
931 register INTERVAL i, unchanged;
932 register int s, len, modified = 0;
933 struct gcpro gcpro1;
934
935 properties = validate_plist (properties);
936 if (NILP (properties))
937 return Qnil;
938
939 if (NILP (object))
940 XSETBUFFER (object, current_buffer);
941
942 i = validate_interval_range (object, &start, &end, hard);
943 if (NULL_INTERVAL_P (i))
944 return Qnil;
945
946 s = XINT (start);
947 len = XINT (end) - s;
948
949 /* No need to protect OBJECT, because we GC only if it's a buffer,
950 and live buffers are always protected. */
951 GCPRO1 (properties);
952
953 /* If we're not starting on an interval boundary, we have to
954 split this interval. */
955 if (i->position != s)
956 {
957 /* If this interval already has the properties, we can
958 skip it. */
959 if (interval_has_all_properties (properties, i))
960 {
961 int got = (LENGTH (i) - (s - i->position));
962 if (got >= len)
963 RETURN_UNGCPRO (Qnil);
964 len -= got;
965 i = next_interval (i);
966 }
967 else
968 {
969 unchanged = i;
970 i = split_interval_right (unchanged, s - unchanged->position);
971 copy_properties (unchanged, i);
972 }
973 }
974
975 if (BUFFERP (object))
976 modify_region (XBUFFER (object), XINT (start), XINT (end));
977
978 /* We are at the beginning of interval I, with LEN chars to scan. */
979 for (;;)
980 {
981 if (i == 0)
982 abort ();
983
984 if (LENGTH (i) >= len)
985 {
986 /* We can UNGCPRO safely here, because there will be just
987 one more chance to gc, in the next call to add_properties,
988 and after that we will not need PROPERTIES or OBJECT again. */
989 UNGCPRO;
990
991 if (interval_has_all_properties (properties, i))
992 {
993 if (BUFFERP (object))
994 signal_after_change (XINT (start), XINT (end) - XINT (start),
995 XINT (end) - XINT (start));
996
997 return modified ? Qt : Qnil;
998 }
999
1000 if (LENGTH (i) == len)
1001 {
1002 add_properties (properties, i, object);
1003 if (BUFFERP (object))
1004 signal_after_change (XINT (start), XINT (end) - XINT (start),
1005 XINT (end) - XINT (start));
1006 return Qt;
1007 }
1008
1009 /* i doesn't have the properties, and goes past the change limit */
1010 unchanged = i;
1011 i = split_interval_left (unchanged, len);
1012 copy_properties (unchanged, i);
1013 add_properties (properties, i, object);
1014 if (BUFFERP (object))
1015 signal_after_change (XINT (start), XINT (end) - XINT (start),
1016 XINT (end) - XINT (start));
1017 return Qt;
1018 }
1019
1020 len -= LENGTH (i);
1021 modified += add_properties (properties, i, object);
1022 i = next_interval (i);
1023 }
1024 }
1025
1026 /* Callers note, this can GC when OBJECT is a buffer (or nil). */
1027
1028 DEFUN ("put-text-property", Fput_text_property,
1029 Sput_text_property, 4, 5, 0,
1030 "Set one property of the text from START to END.\n\
1031 The third and fourth arguments PROPERTY and VALUE\n\
1032 specify the property to add.\n\
1033 The optional fifth argument, OBJECT,\n\
1034 is the string or buffer containing the text.")
1035 (start, end, property, value, object)
1036 Lisp_Object start, end, property, value, object;
1037 {
1038 Fadd_text_properties (start, end,
1039 Fcons (property, Fcons (value, Qnil)),
1040 object);
1041 return Qnil;
1042 }
1043
1044 DEFUN ("set-text-properties", Fset_text_properties,
1045 Sset_text_properties, 3, 4, 0,
1046 "Completely replace properties of text from START to END.\n\
1047 The third argument PROPERTIES is the new property list.\n\
1048 The optional fourth argument, OBJECT,\n\
1049 is the string or buffer containing the text.")
1050 (start, end, properties, object)
1051 Lisp_Object start, end, properties, object;
1052 {
1053 register INTERVAL i, unchanged;
1054 register INTERVAL prev_changed = NULL_INTERVAL;
1055 register int s, len;
1056 Lisp_Object ostart, oend;
1057 int have_modified = 0;
1058
1059 ostart = start;
1060 oend = end;
1061
1062 properties = validate_plist (properties);
1063
1064 if (NILP (object))
1065 XSETBUFFER (object, current_buffer);
1066
1067 /* If we want no properties for a whole string,
1068 get rid of its intervals. */
1069 if (NILP (properties) && STRINGP (object)
1070 && XFASTINT (start) == 0
1071 && XFASTINT (end) == XSTRING (object)->size)
1072 {
1073 if (! XSTRING (object)->intervals)
1074 return Qt;
1075
1076 XSTRING (object)->intervals = 0;
1077 return Qt;
1078 }
1079
1080 i = validate_interval_range (object, &start, &end, soft);
1081
1082 if (NULL_INTERVAL_P (i))
1083 {
1084 /* If buffer has no properties, and we want none, return now. */
1085 if (NILP (properties))
1086 return Qnil;
1087
1088 /* Restore the original START and END values
1089 because validate_interval_range increments them for strings. */
1090 start = ostart;
1091 end = oend;
1092
1093 i = validate_interval_range (object, &start, &end, hard);
1094 /* This can return if start == end. */
1095 if (NULL_INTERVAL_P (i))
1096 return Qnil;
1097 }
1098
1099 s = XINT (start);
1100 len = XINT (end) - s;
1101
1102 if (BUFFERP (object))
1103 modify_region (XBUFFER (object), XINT (start), XINT (end));
1104
1105 if (i->position != s)
1106 {
1107 unchanged = i;
1108 i = split_interval_right (unchanged, s - unchanged->position);
1109
1110 if (LENGTH (i) > len)
1111 {
1112 copy_properties (unchanged, i);
1113 i = split_interval_left (i, len);
1114 set_properties (properties, i, object);
1115 if (BUFFERP (object))
1116 signal_after_change (XINT (start), XINT (end) - XINT (start),
1117 XINT (end) - XINT (start));
1118
1119 return Qt;
1120 }
1121
1122 set_properties (properties, i, object);
1123
1124 if (LENGTH (i) == len)
1125 {
1126 if (BUFFERP (object))
1127 signal_after_change (XINT (start), XINT (end) - XINT (start),
1128 XINT (end) - XINT (start));
1129
1130 return Qt;
1131 }
1132
1133 prev_changed = i;
1134 len -= LENGTH (i);
1135 i = next_interval (i);
1136 }
1137
1138 /* We are starting at the beginning of an interval, I */
1139 while (len > 0)
1140 {
1141 if (i == 0)
1142 abort ();
1143
1144 if (LENGTH (i) >= len)
1145 {
1146 if (LENGTH (i) > len)
1147 i = split_interval_left (i, len);
1148
1149 /* We have to call set_properties even if we are going to
1150 merge the intervals, so as to make the undo records
1151 and cause redisplay to happen. */
1152 set_properties (properties, i, object);
1153 if (!NULL_INTERVAL_P (prev_changed))
1154 merge_interval_left (i);
1155 if (BUFFERP (object))
1156 signal_after_change (XINT (start), XINT (end) - XINT (start),
1157 XINT (end) - XINT (start));
1158 return Qt;
1159 }
1160
1161 len -= LENGTH (i);
1162
1163 /* We have to call set_properties even if we are going to
1164 merge the intervals, so as to make the undo records
1165 and cause redisplay to happen. */
1166 set_properties (properties, i, object);
1167 if (NULL_INTERVAL_P (prev_changed))
1168 prev_changed = i;
1169 else
1170 prev_changed = i = merge_interval_left (i);
1171
1172 i = next_interval (i);
1173 }
1174
1175 if (BUFFERP (object))
1176 signal_after_change (XINT (start), XINT (end) - XINT (start),
1177 XINT (end) - XINT (start));
1178 return Qt;
1179 }
1180
1181 DEFUN ("remove-text-properties", Fremove_text_properties,
1182 Sremove_text_properties, 3, 4, 0,
1183 "Remove some properties from text from START to END.\n\
1184 The third argument PROPERTIES is a property list\n\
1185 whose property names specify the properties to remove.\n\
1186 \(The values stored in PROPERTIES are ignored.)\n\
1187 The optional fourth argument, OBJECT,\n\
1188 is the string or buffer containing the text.\n\
1189 Return t if any property was actually removed, nil otherwise.")
1190 (start, end, properties, object)
1191 Lisp_Object start, end, properties, object;
1192 {
1193 register INTERVAL i, unchanged;
1194 register int s, len, modified = 0;
1195
1196 if (NILP (object))
1197 XSETBUFFER (object, current_buffer);
1198
1199 i = validate_interval_range (object, &start, &end, soft);
1200 if (NULL_INTERVAL_P (i))
1201 return Qnil;
1202
1203 s = XINT (start);
1204 len = XINT (end) - s;
1205
1206 if (i->position != s)
1207 {
1208 /* No properties on this first interval -- return if
1209 it covers the entire region. */
1210 if (! interval_has_some_properties (properties, i))
1211 {
1212 int got = (LENGTH (i) - (s - i->position));
1213 if (got >= len)
1214 return Qnil;
1215 len -= got;
1216 i = next_interval (i);
1217 }
1218 /* Split away the beginning of this interval; what we don't
1219 want to modify. */
1220 else
1221 {
1222 unchanged = i;
1223 i = split_interval_right (unchanged, s - unchanged->position);
1224 copy_properties (unchanged, i);
1225 }
1226 }
1227
1228 if (BUFFERP (object))
1229 modify_region (XBUFFER (object), XINT (start), XINT (end));
1230
1231 /* We are at the beginning of an interval, with len to scan */
1232 for (;;)
1233 {
1234 if (i == 0)
1235 abort ();
1236
1237 if (LENGTH (i) >= len)
1238 {
1239 if (! interval_has_some_properties (properties, i))
1240 return modified ? Qt : Qnil;
1241
1242 if (LENGTH (i) == len)
1243 {
1244 remove_properties (properties, i, object);
1245 if (BUFFERP (object))
1246 signal_after_change (XINT (start), XINT (end) - XINT (start),
1247 XINT (end) - XINT (start));
1248 return Qt;
1249 }
1250
1251 /* i has the properties, and goes past the change limit */
1252 unchanged = i;
1253 i = split_interval_left (i, len);
1254 copy_properties (unchanged, i);
1255 remove_properties (properties, i, object);
1256 if (BUFFERP (object))
1257 signal_after_change (XINT (start), XINT (end) - XINT (start),
1258 XINT (end) - XINT (start));
1259 return Qt;
1260 }
1261
1262 len -= LENGTH (i);
1263 modified += remove_properties (properties, i, object);
1264 i = next_interval (i);
1265 }
1266 }
1267 \f
1268 DEFUN ("text-property-any", Ftext_property_any,
1269 Stext_property_any, 4, 5, 0,
1270 "Check text from START to END for property PROPERTY equalling VALUE.\n\
1271 If so, return the position of the first character whose property PROPERTY\n\
1272 is `eq' to VALUE. Otherwise return nil.\n\
1273 The optional fifth argument, OBJECT, is the string or buffer\n\
1274 containing the text.")
1275 (start, end, property, value, object)
1276 Lisp_Object start, end, property, value, object;
1277 {
1278 register INTERVAL i;
1279 register int e, pos;
1280
1281 if (NILP (object))
1282 XSETBUFFER (object, current_buffer);
1283 i = validate_interval_range (object, &start, &end, soft);
1284 if (NULL_INTERVAL_P (i))
1285 return (!NILP (value) || EQ (start, end) ? Qnil : start);
1286 e = XINT (end);
1287
1288 while (! NULL_INTERVAL_P (i))
1289 {
1290 if (i->position >= e)
1291 break;
1292 if (EQ (textget (i->plist, property), value))
1293 {
1294 pos = i->position;
1295 if (pos < XINT (start))
1296 pos = XINT (start);
1297 return make_number (pos - (STRINGP (object)));
1298 }
1299 i = next_interval (i);
1300 }
1301 return Qnil;
1302 }
1303
1304 DEFUN ("text-property-not-all", Ftext_property_not_all,
1305 Stext_property_not_all, 4, 5, 0,
1306 "Check text from START to END for property PROPERTY not equalling VALUE.\n\
1307 If so, return the position of the first character whose property PROPERTY\n\
1308 is not `eq' to VALUE. Otherwise, return nil.\n\
1309 The optional fifth argument, OBJECT, is the string or buffer\n\
1310 containing the text.")
1311 (start, end, property, value, object)
1312 Lisp_Object start, end, property, value, object;
1313 {
1314 register INTERVAL i;
1315 register int s, e;
1316
1317 if (NILP (object))
1318 XSETBUFFER (object, current_buffer);
1319 i = validate_interval_range (object, &start, &end, soft);
1320 if (NULL_INTERVAL_P (i))
1321 return (NILP (value) || EQ (start, end)) ? Qnil : start;
1322 s = XINT (start);
1323 e = XINT (end);
1324
1325 while (! NULL_INTERVAL_P (i))
1326 {
1327 if (i->position >= e)
1328 break;
1329 if (! EQ (textget (i->plist, property), value))
1330 {
1331 if (i->position > s)
1332 s = i->position;
1333 return make_number (s - (STRINGP (object)));
1334 }
1335 i = next_interval (i);
1336 }
1337 return Qnil;
1338 }
1339 \f
1340 #if 0 /* You can use set-text-properties for this. */
1341
1342 DEFUN ("erase-text-properties", Ferase_text_properties,
1343 Serase_text_properties, 2, 3, 0,
1344 "Remove all properties from the text from START to END.\n\
1345 The optional third argument, OBJECT,\n\
1346 is the string or buffer containing the text.")
1347 (start, end, object)
1348 Lisp_Object start, end, object;
1349 {
1350 register INTERVAL i;
1351 register INTERVAL prev_changed = NULL_INTERVAL;
1352 register int s, len, modified;
1353
1354 if (NILP (object))
1355 XSETBUFFER (object, current_buffer);
1356
1357 i = validate_interval_range (object, &start, &end, soft);
1358 if (NULL_INTERVAL_P (i))
1359 return Qnil;
1360
1361 s = XINT (start);
1362 len = XINT (end) - s;
1363
1364 if (i->position != s)
1365 {
1366 register int got;
1367 register INTERVAL unchanged = i;
1368
1369 /* If there are properties here, then this text will be modified. */
1370 if (! NILP (i->plist))
1371 {
1372 i = split_interval_right (unchanged, s - unchanged->position);
1373 i->plist = Qnil;
1374 modified++;
1375
1376 if (LENGTH (i) > len)
1377 {
1378 i = split_interval_right (i, len);
1379 copy_properties (unchanged, i);
1380 return Qt;
1381 }
1382
1383 if (LENGTH (i) == len)
1384 return Qt;
1385
1386 got = LENGTH (i);
1387 }
1388 /* If the text of I is without any properties, and contains
1389 LEN or more characters, then we may return without changing
1390 anything.*/
1391 else if (LENGTH (i) - (s - i->position) <= len)
1392 return Qnil;
1393 /* The amount of text to change extends past I, so just note
1394 how much we've gotten. */
1395 else
1396 got = LENGTH (i) - (s - i->position);
1397
1398 len -= got;
1399 prev_changed = i;
1400 i = next_interval (i);
1401 }
1402
1403 /* We are starting at the beginning of an interval, I. */
1404 while (len > 0)
1405 {
1406 if (LENGTH (i) >= len)
1407 {
1408 /* If I has no properties, simply merge it if possible. */
1409 if (NILP (i->plist))
1410 {
1411 if (! NULL_INTERVAL_P (prev_changed))
1412 merge_interval_left (i);
1413
1414 return modified ? Qt : Qnil;
1415 }
1416
1417 if (LENGTH (i) > len)
1418 i = split_interval_left (i, len);
1419 if (! NULL_INTERVAL_P (prev_changed))
1420 merge_interval_left (i);
1421 else
1422 i->plist = Qnil;
1423
1424 return Qt;
1425 }
1426
1427 /* Here if we still need to erase past the end of I */
1428 len -= LENGTH (i);
1429 if (NULL_INTERVAL_P (prev_changed))
1430 {
1431 modified += erase_properties (i);
1432 prev_changed = i;
1433 }
1434 else
1435 {
1436 modified += ! NILP (i->plist);
1437 /* Merging I will give it the properties of PREV_CHANGED. */
1438 prev_changed = i = merge_interval_left (i);
1439 }
1440
1441 i = next_interval (i);
1442 }
1443
1444 return modified ? Qt : Qnil;
1445 }
1446 #endif /* 0 */
1447
1448 /* I don't think this is the right interface to export; how often do you
1449 want to do something like this, other than when you're copying objects
1450 around?
1451
1452 I think it would be better to have a pair of functions, one which
1453 returns the text properties of a region as a list of ranges and
1454 plists, and another which applies such a list to another object. */
1455
1456 /* Add properties from SRC to SRC of SRC, starting at POS in DEST.
1457 SRC and DEST may each refer to strings or buffers.
1458 Optional sixth argument PROP causes only that property to be copied.
1459 Properties are copied to DEST as if by `add-text-properties'.
1460 Return t if any property value actually changed, nil otherwise. */
1461
1462 /* Note this can GC when DEST is a buffer. */
1463 \f
1464 Lisp_Object
1465 copy_text_properties (start, end, src, pos, dest, prop)
1466 Lisp_Object start, end, src, pos, dest, prop;
1467 {
1468 INTERVAL i;
1469 Lisp_Object res;
1470 Lisp_Object stuff;
1471 Lisp_Object plist;
1472 int s, e, e2, p, len, modified = 0;
1473 struct gcpro gcpro1, gcpro2;
1474
1475 i = validate_interval_range (src, &start, &end, soft);
1476 if (NULL_INTERVAL_P (i))
1477 return Qnil;
1478
1479 CHECK_NUMBER_COERCE_MARKER (pos, 0);
1480 {
1481 Lisp_Object dest_start, dest_end;
1482
1483 dest_start = pos;
1484 XSETFASTINT (dest_end, XINT (dest_start) + (XINT (end) - XINT (start)));
1485 /* Apply this to a copy of pos; it will try to increment its arguments,
1486 which we don't want. */
1487 validate_interval_range (dest, &dest_start, &dest_end, soft);
1488 }
1489
1490 s = XINT (start);
1491 e = XINT (end);
1492 p = XINT (pos);
1493
1494 stuff = Qnil;
1495
1496 while (s < e)
1497 {
1498 e2 = i->position + LENGTH (i);
1499 if (e2 > e)
1500 e2 = e;
1501 len = e2 - s;
1502
1503 plist = i->plist;
1504 if (! NILP (prop))
1505 while (! NILP (plist))
1506 {
1507 if (EQ (Fcar (plist), prop))
1508 {
1509 plist = Fcons (prop, Fcons (Fcar (Fcdr (plist)), Qnil));
1510 break;
1511 }
1512 plist = Fcdr (Fcdr (plist));
1513 }
1514 if (! NILP (plist))
1515 {
1516 /* Must defer modifications to the interval tree in case src
1517 and dest refer to the same string or buffer. */
1518 stuff = Fcons (Fcons (make_number (p),
1519 Fcons (make_number (p + len),
1520 Fcons (plist, Qnil))),
1521 stuff);
1522 }
1523
1524 i = next_interval (i);
1525 if (NULL_INTERVAL_P (i))
1526 break;
1527
1528 p += len;
1529 s = i->position;
1530 }
1531
1532 GCPRO2 (stuff, dest);
1533
1534 while (! NILP (stuff))
1535 {
1536 res = Fcar (stuff);
1537 res = Fadd_text_properties (Fcar (res), Fcar (Fcdr (res)),
1538 Fcar (Fcdr (Fcdr (res))), dest);
1539 if (! NILP (res))
1540 modified++;
1541 stuff = Fcdr (stuff);
1542 }
1543
1544 UNGCPRO;
1545
1546 return modified ? Qt : Qnil;
1547 }
1548 \f
1549 /* Call the modification hook functions in LIST, each with START and END. */
1550
1551 static void
1552 call_mod_hooks (list, start, end)
1553 Lisp_Object list, start, end;
1554 {
1555 struct gcpro gcpro1;
1556 GCPRO1 (list);
1557 while (!NILP (list))
1558 {
1559 call2 (Fcar (list), start, end);
1560 list = Fcdr (list);
1561 }
1562 UNGCPRO;
1563 }
1564
1565 /* Check for read-only intervals between character positions START ... END,
1566 in BUF, and signal an error if we find one.
1567
1568 Then check for any modification hooks in the range.
1569 Create a list of all these hooks in lexicographic order,
1570 eliminating consecutive extra copies of the same hook. Then call
1571 those hooks in order, with START and END - 1 as arguments. */
1572
1573 void
1574 verify_interval_modification (buf, start, end)
1575 struct buffer *buf;
1576 int start, end;
1577 {
1578 register INTERVAL intervals = BUF_INTERVALS (buf);
1579 register INTERVAL i, prev;
1580 Lisp_Object hooks;
1581 register Lisp_Object prev_mod_hooks;
1582 Lisp_Object mod_hooks;
1583 struct gcpro gcpro1;
1584
1585 hooks = Qnil;
1586 prev_mod_hooks = Qnil;
1587 mod_hooks = Qnil;
1588
1589 interval_insert_behind_hooks = Qnil;
1590 interval_insert_in_front_hooks = Qnil;
1591
1592 if (NULL_INTERVAL_P (intervals))
1593 return;
1594
1595 if (start > end)
1596 {
1597 int temp = start;
1598 start = end;
1599 end = temp;
1600 }
1601
1602 /* For an insert operation, check the two chars around the position. */
1603 if (start == end)
1604 {
1605 INTERVAL prev;
1606 Lisp_Object before, after;
1607
1608 /* Set I to the interval containing the char after START,
1609 and PREV to the interval containing the char before START.
1610 Either one may be null. They may be equal. */
1611 i = find_interval (intervals, start);
1612
1613 if (start == BUF_BEGV (buf))
1614 prev = 0;
1615 else if (i->position == start)
1616 prev = previous_interval (i);
1617 else if (i->position < start)
1618 prev = i;
1619 if (start == BUF_ZV (buf))
1620 i = 0;
1621
1622 /* If Vinhibit_read_only is set and is not a list, we can
1623 skip the read_only checks. */
1624 if (NILP (Vinhibit_read_only) || CONSP (Vinhibit_read_only))
1625 {
1626 /* If I and PREV differ we need to check for the read-only
1627 property together with its stickiness. If either I or
1628 PREV are 0, this check is all we need.
1629 We have to take special care, since read-only may be
1630 indirectly defined via the category property. */
1631 if (i != prev)
1632 {
1633 if (! NULL_INTERVAL_P (i))
1634 {
1635 after = textget (i->plist, Qread_only);
1636
1637 /* If interval I is read-only and read-only is
1638 front-sticky, inhibit insertion.
1639 Check for read-only as well as category. */
1640 if (! NILP (after)
1641 && NILP (Fmemq (after, Vinhibit_read_only)))
1642 {
1643 Lisp_Object tem;
1644
1645 tem = textget (i->plist, Qfront_sticky);
1646 if (TMEM (Qread_only, tem)
1647 || (NILP (Fplist_get (i->plist, Qread_only))
1648 && TMEM (Qcategory, tem)))
1649 error ("Attempt to insert within read-only text");
1650 }
1651 }
1652
1653 if (! NULL_INTERVAL_P (prev))
1654 {
1655 before = textget (prev->plist, Qread_only);
1656
1657 /* If interval PREV is read-only and read-only isn't
1658 rear-nonsticky, inhibit insertion.
1659 Check for read-only as well as category. */
1660 if (! NILP (before)
1661 && NILP (Fmemq (before, Vinhibit_read_only)))
1662 {
1663 Lisp_Object tem;
1664
1665 tem = textget (prev->plist, Qrear_nonsticky);
1666 if (! TMEM (Qread_only, tem)
1667 && (! NILP (Fplist_get (prev->plist,Qread_only))
1668 || ! TMEM (Qcategory, tem)))
1669 error ("Attempt to insert within read-only text");
1670 }
1671 }
1672 }
1673 else if (! NULL_INTERVAL_P (i))
1674 {
1675 after = textget (i->plist, Qread_only);
1676
1677 /* If interval I is read-only and read-only is
1678 front-sticky, inhibit insertion.
1679 Check for read-only as well as category. */
1680 if (! NILP (after) && NILP (Fmemq (after, Vinhibit_read_only)))
1681 {
1682 Lisp_Object tem;
1683
1684 tem = textget (i->plist, Qfront_sticky);
1685 if (TMEM (Qread_only, tem)
1686 || (NILP (Fplist_get (i->plist, Qread_only))
1687 && TMEM (Qcategory, tem)))
1688 error ("Attempt to insert within read-only text");
1689
1690 tem = textget (prev->plist, Qrear_nonsticky);
1691 if (! TMEM (Qread_only, tem)
1692 && (! NILP (Fplist_get (prev->plist, Qread_only))
1693 || ! TMEM (Qcategory, tem)))
1694 error ("Attempt to insert within read-only text");
1695 }
1696 }
1697 }
1698
1699 /* Run both insert hooks (just once if they're the same). */
1700 if (!NULL_INTERVAL_P (prev))
1701 interval_insert_behind_hooks
1702 = textget (prev->plist, Qinsert_behind_hooks);
1703 if (!NULL_INTERVAL_P (i))
1704 interval_insert_in_front_hooks
1705 = textget (i->plist, Qinsert_in_front_hooks);
1706 }
1707 else
1708 {
1709 /* Loop over intervals on or next to START...END,
1710 collecting their hooks. */
1711
1712 i = find_interval (intervals, start);
1713 do
1714 {
1715 if (! INTERVAL_WRITABLE_P (i))
1716 error ("Attempt to modify read-only text");
1717
1718 mod_hooks = textget (i->plist, Qmodification_hooks);
1719 if (! NILP (mod_hooks) && ! EQ (mod_hooks, prev_mod_hooks))
1720 {
1721 hooks = Fcons (mod_hooks, hooks);
1722 prev_mod_hooks = mod_hooks;
1723 }
1724
1725 i = next_interval (i);
1726 }
1727 /* Keep going thru the interval containing the char before END. */
1728 while (! NULL_INTERVAL_P (i) && i->position < end);
1729
1730 GCPRO1 (hooks);
1731 hooks = Fnreverse (hooks);
1732 while (! EQ (hooks, Qnil))
1733 {
1734 call_mod_hooks (Fcar (hooks), make_number (start),
1735 make_number (end));
1736 hooks = Fcdr (hooks);
1737 }
1738 UNGCPRO;
1739 }
1740 }
1741
1742 /* Run the interval hooks for an insertion on character range START ... END.
1743 verify_interval_modification chose which hooks to run;
1744 this function is called after the insertion happens
1745 so it can indicate the range of inserted text. */
1746
1747 void
1748 report_interval_modification (start, end)
1749 Lisp_Object start, end;
1750 {
1751 if (! NILP (interval_insert_behind_hooks))
1752 call_mod_hooks (interval_insert_behind_hooks, start, end);
1753 if (! NILP (interval_insert_in_front_hooks)
1754 && ! EQ (interval_insert_in_front_hooks,
1755 interval_insert_behind_hooks))
1756 call_mod_hooks (interval_insert_in_front_hooks, start, end);
1757 }
1758 \f
1759 void
1760 syms_of_textprop ()
1761 {
1762 DEFVAR_LISP ("default-text-properties", &Vdefault_text_properties,
1763 "Property-list used as default values.\n\
1764 The value of a property in this list is seen as the value for every\n\
1765 character that does not have its own value for that property.");
1766 Vdefault_text_properties = Qnil;
1767
1768 DEFVAR_LISP ("inhibit-point-motion-hooks", &Vinhibit_point_motion_hooks,
1769 "If non-nil, don't run `point-left' and `point-entered' text properties.\n\
1770 This also inhibits the use of the `intangible' text property.");
1771 Vinhibit_point_motion_hooks = Qnil;
1772
1773 staticpro (&interval_insert_behind_hooks);
1774 staticpro (&interval_insert_in_front_hooks);
1775 interval_insert_behind_hooks = Qnil;
1776 interval_insert_in_front_hooks = Qnil;
1777
1778
1779 /* Common attributes one might give text */
1780
1781 staticpro (&Qforeground);
1782 Qforeground = intern ("foreground");
1783 staticpro (&Qbackground);
1784 Qbackground = intern ("background");
1785 staticpro (&Qfont);
1786 Qfont = intern ("font");
1787 staticpro (&Qstipple);
1788 Qstipple = intern ("stipple");
1789 staticpro (&Qunderline);
1790 Qunderline = intern ("underline");
1791 staticpro (&Qread_only);
1792 Qread_only = intern ("read-only");
1793 staticpro (&Qinvisible);
1794 Qinvisible = intern ("invisible");
1795 staticpro (&Qintangible);
1796 Qintangible = intern ("intangible");
1797 staticpro (&Qcategory);
1798 Qcategory = intern ("category");
1799 staticpro (&Qlocal_map);
1800 Qlocal_map = intern ("local-map");
1801 staticpro (&Qfront_sticky);
1802 Qfront_sticky = intern ("front-sticky");
1803 staticpro (&Qrear_nonsticky);
1804 Qrear_nonsticky = intern ("rear-nonsticky");
1805
1806 /* Properties that text might use to specify certain actions */
1807
1808 staticpro (&Qmouse_left);
1809 Qmouse_left = intern ("mouse-left");
1810 staticpro (&Qmouse_entered);
1811 Qmouse_entered = intern ("mouse-entered");
1812 staticpro (&Qpoint_left);
1813 Qpoint_left = intern ("point-left");
1814 staticpro (&Qpoint_entered);
1815 Qpoint_entered = intern ("point-entered");
1816
1817 defsubr (&Stext_properties_at);
1818 defsubr (&Sget_text_property);
1819 defsubr (&Sget_char_property);
1820 defsubr (&Snext_char_property_change);
1821 defsubr (&Sprevious_char_property_change);
1822 defsubr (&Snext_property_change);
1823 defsubr (&Snext_single_property_change);
1824 defsubr (&Sprevious_property_change);
1825 defsubr (&Sprevious_single_property_change);
1826 defsubr (&Sadd_text_properties);
1827 defsubr (&Sput_text_property);
1828 defsubr (&Sset_text_properties);
1829 defsubr (&Sremove_text_properties);
1830 defsubr (&Stext_property_any);
1831 defsubr (&Stext_property_not_all);
1832 /* defsubr (&Serase_text_properties); */
1833 /* defsubr (&Scopy_text_properties); */
1834 }
1835
1836 #else
1837
1838 lose -- this shouldn't be compiled if USE_TEXT_PROPERTIES isn't defined
1839
1840 #endif /* USE_TEXT_PROPERTIES */