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