X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/7855e674d72674171da39af1f4206f091e5d15c8..17cea80917206c92bd0029bd620bd718926eae9c:/src/textprop.c diff --git a/src/textprop.c b/src/textprop.c index 1600928fde..0309f8c2d9 100644 --- a/src/textprop.c +++ b/src/textprop.c @@ -1,11 +1,11 @@ /* Interface code for dealing with text properties. - Copyright (C) 1992 Free Software Foundation, Inc. + Copyright (C) 1993, 1994, 1995, 1997 Free Software Foundation, Inc. This file is part of GNU Emacs. GNU Emacs is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by -the Free Software Foundation; either version 1, or (at your option) +the Free Software Foundation; either version 2, or (at your option) any later version. GNU Emacs is distributed in the hope that it will be useful, @@ -15,12 +15,23 @@ GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Emacs; see the file COPYING. If not, write to -the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */ +the Free Software Foundation, Inc., 59 Temple Place - Suite 330, +Boston, MA 02111-1307, USA. */ -#include "config.h" +#include #include "lisp.h" #include "intervals.h" #include "buffer.h" +#include "window.h" + +#ifndef NULL +#define NULL (void *)0 +#endif + +/* Test for membership, allowing for t (actually any non-cons) to mean the + universal set. */ + +#define TMEM(sym, set) (CONSP (set) ? ! NILP (Fmemq (sym, set)) : ! NILP (set)) /* NOTES: previous- and next- property change will have to skip @@ -30,22 +41,41 @@ the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */ set_properties needs to deal with the interval property cache. It is assumed that for any interval plist, a property appears - only once on the list. Although some code i.e., remove_properties (), + only once on the list. Although some code i.e., remove_properties, handles the more general case, the uniqueness of properties is - neccessary for the system to remain consistent. This requirement - is enforced by the subrs installing properties onto the intervals. */ + necessary for the system to remain consistent. This requirement + is enforced by the subrs installing properties onto the intervals. */ +/* The rest of the file is within this conditional */ +#ifdef USE_TEXT_PROPERTIES -/* Types of hooks. */ +/* Types of hooks. */ Lisp_Object Qmouse_left; Lisp_Object Qmouse_entered; Lisp_Object Qpoint_left; Lisp_Object Qpoint_entered; -Lisp_Object Qmodification; +Lisp_Object Qcategory; +Lisp_Object Qlocal_map; -/* Visual properties text (including strings) may have. */ +/* Visual properties text (including strings) may have. */ Lisp_Object Qforeground, Qbackground, Qfont, Qunderline, Qstipple; -Lisp_Object Qinvisible, Qread_only; +Lisp_Object Qinvisible, Qread_only, Qintangible; + +/* Sticky properties */ +Lisp_Object Qfront_sticky, Qrear_nonsticky; + +/* If o1 is a cons whose cdr is a cons, return non-zero and set o2 to + the o1's cdr. Otherwise, return zero. This is handy for + traversing plists. */ +#define PLIST_ELT_P(o1, o2) (CONSP (o1) && ((o2)=XCONS (o1)->cdr, CONSP (o2))) + +Lisp_Object Vinhibit_point_motion_hooks; +Lisp_Object Vdefault_text_properties; + +/* verify_interval_modification saves insertion hooks here + to be run later by report_interval_modification. */ +Lisp_Object interval_insert_behind_hooks; +Lisp_Object interval_insert_in_front_hooks; /* Extract the interval at the position pointed to by BEGIN from OBJECT, a string or buffer. Additionally, check that the positions @@ -54,6 +84,9 @@ Lisp_Object Qinvisible, Qread_only; to by BEGIN and END may be integers or markers; if the latter, they are coerced to integers. + When OBJECT is a string, we increment *BEGIN and *END + to make them origin-one. + Note that buffer points don't correspond to interval indices. For example, point-max is 1 greater than the index of the last character. This difference is handled in the caller, which uses @@ -65,7 +98,7 @@ Lisp_Object Qinvisible, Qread_only; If FORCE is soft (0), it's OK to return NULL_INTERVAL. Otherwise, create an interval tree for OBJECT if one doesn't exist, provided the object actually contains text. In the current design, if there - is no text, there can be no text properties. */ + is no text, there can be no text properties. */ #define soft 0 #define hard 1 @@ -76,63 +109,73 @@ validate_interval_range (object, begin, end, force) int force; { register INTERVAL i; + int searchpos; + CHECK_STRING_OR_BUFFER (object, 0); CHECK_NUMBER_COERCE_MARKER (*begin, 0); CHECK_NUMBER_COERCE_MARKER (*end, 0); /* If we are asked for a point, but from a subr which operates - on a range, then return nothing. */ - if (*begin == *end && begin != end) + on a range, then return nothing. */ + if (EQ (*begin, *end) && begin != end) return NULL_INTERVAL; if (XINT (*begin) > XINT (*end)) { - register int n; - n = XFASTINT (*begin); /* This is legit even if *begin is < 0 */ + Lisp_Object n; + n = *begin; *begin = *end; - XFASTINT (*end) = n; /* because this is all we do with n. */ + *end = n; } - if (XTYPE (object) == Lisp_Buffer) + if (BUFFERP (object)) { register struct buffer *b = XBUFFER (object); - /* If there's no text, there are no properties. */ - if (BUF_BEGV (b) == BUF_ZV (b)) - return NULL_INTERVAL; - if (!(BUF_BEGV (b) <= XINT (*begin) && XINT (*begin) <= XINT (*end) && XINT (*end) <= BUF_ZV (b))) args_out_of_range (*begin, *end); - i = b->intervals; + i = BUF_INTERVALS (b); - /* Special case for point-max: return the interval for the - last character. */ - if (*begin == *end && *begin == BUF_Z (b)) - *begin -= 1; + /* If there's no text, there are no properties. */ + if (BUF_BEGV (b) == BUF_ZV (b)) + return NULL_INTERVAL; + + searchpos = XINT (*begin); } else { register struct Lisp_String *s = XSTRING (object); - if (! (1 <= XINT (*begin) && XINT (*begin) <= XINT (*end) + if (! (0 <= XINT (*begin) && XINT (*begin) <= XINT (*end) && XINT (*end) <= s->size)) args_out_of_range (*begin, *end); + /* User-level Positions in strings start with 0, + but the interval code always wants positions starting with 1. */ + XSETFASTINT (*begin, XFASTINT (*begin) + 1); + if (begin != end) + XSETFASTINT (*end, XFASTINT (*end) + 1); i = s->intervals; + + if (s->size == 0) + return NULL_INTERVAL; + + searchpos = XINT (*begin); } if (NULL_INTERVAL_P (i)) return (force ? create_root_interval (object) : i); - return find_interval (i, XINT (*begin)); + return find_interval (i, searchpos); } /* Validate LIST as a property list. If LIST is not a list, then make one consisting of (LIST nil). Otherwise, verify that LIST - is even numbered and thus suitable as a plist. */ + is even numbered and thus suitable as a plist. */ static Lisp_Object validate_plist (list) + Lisp_Object list; { if (NILP (list)) return Qnil; @@ -142,7 +185,10 @@ validate_plist (list) register int i; register Lisp_Object tail; for (i = 0, tail = list; !NILP (tail); i++) - tail = Fcdr (tail); + { + tail = Fcdr (tail); + QUIT; + } if (i & 1) error ("Odd length text property list"); return list; @@ -151,10 +197,8 @@ validate_plist (list) return Fcons (list, Fcons (Qnil, Qnil)); } -#define set_properties(list,i) (i->plist = Fcopy_sequence (list)) - /* Return nonzero if interval I has all the properties, - with the same values, of list PLIST. */ + with the same values, of list PLIST. */ static int interval_has_all_properties (plist, i) @@ -164,7 +208,7 @@ interval_has_all_properties (plist, i) register Lisp_Object tail1, tail2, sym1, sym2; register int found; - /* Go through each element of PLIST. */ + /* Go through each element of PLIST. */ for (tail1 = plist; ! NILP (tail1); tail1 = Fcdr (Fcdr (tail1))) { sym1 = Fcar (tail1); @@ -175,12 +219,11 @@ interval_has_all_properties (plist, i) if (EQ (sym1, Fcar (tail2))) { /* Found the same property on both lists. If the - values are unequal, return zero. */ - if (! EQ (Fequal (Fcar (Fcdr (tail1)), Fcar (Fcdr (tail2))), - Qt)) + values are unequal, return zero. */ + if (! EQ (Fcar (Fcdr (tail1)), Fcar (Fcdr (tail2)))) return 0; - /* Property has same value on both lists; go to next one. */ + /* Property has same value on both lists; go to next one. */ found = 1; break; } @@ -193,7 +236,7 @@ interval_has_all_properties (plist, i) } /* Return nonzero if the plist of interval I has any of the - properties of PLIST, regardless of their values. */ + properties of PLIST, regardless of their values. */ static INLINE int interval_has_some_properties (plist, i) @@ -202,7 +245,7 @@ interval_has_some_properties (plist, i) { register Lisp_Object tail1, tail2, sym; - /* Go through each element of PLIST. */ + /* Go through each element of PLIST. */ for (tail1 = plist; ! NILP (tail1); tail1 = Fcdr (Fcdr (tail1))) { sym = Fcar (tail1); @@ -215,24 +258,98 @@ interval_has_some_properties (plist, i) return 0; } + +/* Changing the plists of individual intervals. */ + +/* Return the value of PROP in property-list PLIST, or Qunbound if it + has none. */ +static Lisp_Object +property_value (plist, prop) + Lisp_Object plist, prop; +{ + Lisp_Object value; + + while (PLIST_ELT_P (plist, value)) + if (EQ (XCONS (plist)->car, prop)) + return XCONS (value)->car; + else + plist = XCONS (value)->cdr; + + return Qunbound; +} + +/* Set the properties of INTERVAL to PROPERTIES, + and record undo info for the previous values. + OBJECT is the string or buffer that INTERVAL belongs to. */ + +static void +set_properties (properties, interval, object) + Lisp_Object properties, object; + INTERVAL interval; +{ + Lisp_Object sym, value; + + if (BUFFERP (object)) + { + /* For each property in the old plist which is missing from PROPERTIES, + or has a different value in PROPERTIES, make an undo record. */ + for (sym = interval->plist; + PLIST_ELT_P (sym, value); + sym = XCONS (value)->cdr) + if (! EQ (property_value (properties, XCONS (sym)->car), + XCONS (value)->car)) + { + record_property_change (interval->position, LENGTH (interval), + XCONS (sym)->car, XCONS (value)->car, + object); + } + + /* For each new property that has no value at all in the old plist, + make an undo record binding it to nil, so it will be removed. */ + for (sym = properties; + PLIST_ELT_P (sym, value); + sym = XCONS (value)->cdr) + if (EQ (property_value (interval->plist, XCONS (sym)->car), Qunbound)) + { + record_property_change (interval->position, LENGTH (interval), + XCONS (sym)->car, Qnil, + object); + } + } + + /* Store new properties. */ + interval->plist = Fcopy_sequence (properties); +} /* Add the properties of PLIST to the interval I, or set the value of I's property to the value of the property on PLIST if they are different. + OBJECT should be the string or buffer the interval is in. + Return nonzero if this changes I (i.e., if any members of PLIST are actually added to I's plist) */ -static INLINE int -add_properties (plist, i) +static int +add_properties (plist, i, object) Lisp_Object plist; INTERVAL i; + Lisp_Object object; { - register Lisp_Object tail1, tail2, sym1, val1; + Lisp_Object tail1, tail2, sym1, val1; register int changed = 0; register int found; + struct gcpro gcpro1, gcpro2, gcpro3; + + tail1 = plist; + sym1 = Qnil; + val1 = Qnil; + /* No need to protect OBJECT, because we can GC only in the case + where it is a buffer, and live buffers are always protected. + I and its plist are also protected, via OBJECT. */ + GCPRO3 (tail1, sym1, val1); - /* Go through each element of PLIST. */ + /* Go through each element of PLIST. */ for (tail1 = plist; ! NILP (tail1); tail1 = Fcdr (Fcdr (tail1))) { sym1 = Fcar (tail1); @@ -243,16 +360,26 @@ add_properties (plist, i) for (tail2 = i->plist; ! NILP (tail2); tail2 = Fcdr (Fcdr (tail2))) if (EQ (sym1, Fcar (tail2))) { - register Lisp_Object this_cdr = Fcdr (tail2); + /* No need to gcpro, because tail2 protects this + and it must be a cons cell (we get an error otherwise). */ + register Lisp_Object this_cdr; - /* Found the property. Now check its value. */ + this_cdr = Fcdr (tail2); + /* Found the property. Now check its value. */ found = 1; /* The properties have the same value on both lists. - Continue to the next property. */ - if (Fequal (val1, Fcar (this_cdr))) + Continue to the next property. */ + if (EQ (val1, Fcar (this_cdr))) break; + /* Record this change in the buffer, for undo purposes. */ + if (BUFFERP (object)) + { + record_property_change (i->position, LENGTH (i), + sym1, Fcar (this_cdr), object); + } + /* I's property has a different value -- change it */ Fsetcar (this_cdr, val1); changed++; @@ -261,27 +388,37 @@ add_properties (plist, i) if (! found) { + /* Record this change in the buffer, for undo purposes. */ + if (BUFFERP (object)) + { + record_property_change (i->position, LENGTH (i), + sym1, Qnil, object); + } i->plist = Fcons (sym1, Fcons (val1, i->plist)); changed++; } } + UNGCPRO; + return changed; } /* For any members of PLIST which are properties of I, remove them - from I's plist. */ + from I's plist. + OBJECT is the string or buffer containing I. */ -static INLINE int -remove_properties (plist, i) +static int +remove_properties (plist, i, object) Lisp_Object plist; INTERVAL i; + Lisp_Object object; { - register Lisp_Object tail1, tail2, sym; - register Lisp_Object current_plist = i->plist; + register Lisp_Object tail1, tail2, sym, current_plist; register int changed = 0; - /* Go through each element of plist. */ + current_plist = i->plist; + /* Go through each element of plist. */ for (tail1 = plist; ! NILP (tail1); tail1 = Fcdr (Fcdr (tail1))) { sym = Fcar (tail1); @@ -289,6 +426,13 @@ remove_properties (plist, i) /* First, remove the symbol if its at the head of the list */ while (! NILP (current_plist) && EQ (sym, Fcar (current_plist))) { + if (BUFFERP (object)) + { + record_property_change (i->position, LENGTH (i), + sym, Fcar (Fcdr (current_plist)), + object); + } + current_plist = Fcdr (Fcdr (current_plist)); changed++; } @@ -297,9 +441,16 @@ remove_properties (plist, i) tail2 = current_plist; while (! NILP (tail2)) { - register Lisp_Object this = Fcdr (Fcdr (tail2)); + register Lisp_Object this; + this = Fcdr (Fcdr (tail2)); if (EQ (sym, Fcar (this))) { + if (BUFFERP (object)) + { + record_property_change (i->position, LENGTH (i), + sym, Fcar (Fcdr (this)), object); + } + Fsetcdr (Fcdr (tail2), Fcdr (Fcdr (this))); changed++; } @@ -312,8 +463,9 @@ remove_properties (plist, i) return changed; } +#if 0 /* Remove all properties from interval I. Return non-zero - if this changes the interval. */ + if this changes the interval. */ static INLINE int erase_properties (i) @@ -325,140 +477,468 @@ erase_properties (i) i->plist = Qnil; return 1; } +#endif + +/* Returns the interval of the POSITION in OBJECT. + POSITION is BEG-based. */ + +INTERVAL +interval_of (position, object) + int position; + Lisp_Object object; +{ + register INTERVAL i; + int beg, end; + + if (NILP (object)) + XSETBUFFER (object, current_buffer); + else if (EQ (object, Qt)) + return NULL_INTERVAL; + + CHECK_STRING_OR_BUFFER (object, 0); + + if (BUFFERP (object)) + { + register struct buffer *b = XBUFFER (object); + + beg = BUF_BEGV (b); + end = BUF_ZV (b); + i = BUF_INTERVALS (b); + } + else + { + register struct Lisp_String *s = XSTRING (object); + + /* We expect position to be 1-based. */ + beg = BEG; + end = s->size + BEG; + i = s->intervals; + } + + if (!(beg <= position && position <= end)) + args_out_of_range (make_number (position), make_number (position)); + if (beg == end || NULL_INTERVAL_P (i)) + return NULL_INTERVAL; + + return find_interval (i, position); +} DEFUN ("text-properties-at", Ftext_properties_at, Stext_properties_at, 1, 2, 0, - "Return the list of properties held by the character at POSITION\n\ -in optional argument OBJECT, a string or buffer. If nil, OBJECT\n\ -defaults to the current buffer.") - (pos, object) - Lisp_Object pos, object; + "Return the list of properties of the character at POSITION in OBJECT.\n\ +OBJECT is the string or buffer to look for the properties in;\n\ +nil means the current buffer.\n\ +If POSITION is at the end of OBJECT, the value is nil.") + (position, object) + Lisp_Object position, object; { register INTERVAL i; - register int p; if (NILP (object)) - XSET (object, Lisp_Buffer, current_buffer); + XSETBUFFER (object, current_buffer); - i = validate_interval_range (object, &pos, &pos, soft); + i = validate_interval_range (object, &position, &position, soft); if (NULL_INTERVAL_P (i)) return Qnil; + /* If POSITION is at the end of the interval, + it means it's the end of OBJECT. + There are no properties at the very end, + since no character follows. */ + if (XINT (position) == LENGTH (i) + i->position) + return Qnil; return i->plist; } +DEFUN ("get-text-property", Fget_text_property, Sget_text_property, 2, 3, 0, + "Return the value of POSITION's property PROP, in OBJECT.\n\ +OBJECT is optional and defaults to the current buffer.\n\ +If POSITION is at the end of OBJECT, the value is nil.") + (position, prop, object) + Lisp_Object position, object; + Lisp_Object prop; +{ + return textget (Ftext_properties_at (position, object), prop); +} + +DEFUN ("get-char-property", Fget_char_property, Sget_char_property, 2, 3, 0, + "Return the value of POSITION's property PROP, in OBJECT.\n\ +OBJECT is optional and defaults to the current buffer.\n\ +If POSITION is at the end of OBJECT, the value is nil.\n\ +If OBJECT is a buffer, then overlay properties are considered as well as\n\ +text properties.\n\ +If OBJECT is a window, then that window's buffer is used, but window-specific\n\ +overlays are considered only if they are associated with OBJECT.") + (position, prop, object) + Lisp_Object position, object; + register Lisp_Object prop; +{ + struct window *w = 0; + + CHECK_NUMBER_COERCE_MARKER (position, 0); + + if (NILP (object)) + XSETBUFFER (object, current_buffer); + + if (WINDOWP (object)) + { + w = XWINDOW (object); + object = w->buffer; + } + if (BUFFERP (object)) + { + int posn = XINT (position); + int noverlays; + Lisp_Object *overlay_vec, tem; + int next_overlay; + int len; + struct buffer *obuf = current_buffer; + + set_buffer_temp (XBUFFER (object)); + + /* First try with room for 40 overlays. */ + len = 40; + overlay_vec = (Lisp_Object *) alloca (len * sizeof (Lisp_Object)); + + noverlays = overlays_at (posn, 0, &overlay_vec, &len, + &next_overlay, NULL); + + /* If there are more than 40, + make enough space for all, and try again. */ + if (noverlays > len) + { + len = noverlays; + overlay_vec = (Lisp_Object *) alloca (len * sizeof (Lisp_Object)); + noverlays = overlays_at (posn, 0, &overlay_vec, &len, + &next_overlay, NULL); + } + noverlays = sort_overlays (overlay_vec, noverlays, w); + + set_buffer_temp (obuf); + + /* Now check the overlays in order of decreasing priority. */ + while (--noverlays >= 0) + { + tem = Foverlay_get (overlay_vec[noverlays], prop); + if (!NILP (tem)) + return (tem); + } + } + /* Not a buffer, or no appropriate overlay, so fall through to the + simpler case. */ + return (Fget_text_property (position, prop, object)); +} + +DEFUN ("next-char-property-change", Fnext_char_property_change, + Snext_char_property_change, 1, 2, 0, + "Return the position of next text property or overlay change.\n\ +This scans characters forward from POSITION in OBJECT till it finds\n\ +a change in some text property, or the beginning or end of an overlay,\n\ +and returns the position of that.\n\ +If none is found, the function returns (point-max).\n\ +\n\ +If the optional third argument LIMIT is non-nil, don't search\n\ +past position LIMIT; return LIMIT if nothing is found before LIMIT.") + (position, limit) + Lisp_Object position, limit; +{ + Lisp_Object temp; + + temp = Fnext_overlay_change (position); + if (! NILP (limit)) + { + CHECK_NUMBER (limit, 2); + if (XINT (limit) < XINT (temp)) + temp = limit; + } + return Fnext_property_change (position, Qnil, temp); +} + +DEFUN ("previous-char-property-change", Fprevious_char_property_change, + Sprevious_char_property_change, 1, 2, 0, + "Return the position of previous text property or overlay change.\n\ +Scans characters backward from POSITION in OBJECT till it finds\n\ +a change in some text property, or the beginning or end of an overlay,\n\ +and returns the position of that.\n\ +If none is found, the function returns (point-max).\n\ +\n\ +If the optional third argument LIMIT is non-nil, don't search\n\ +past position LIMIT; return LIMIT if nothing is found before LIMIT.") + (position, limit) + Lisp_Object position, limit; +{ + Lisp_Object temp; + + temp = Fprevious_overlay_change (position); + if (! NILP (limit)) + { + CHECK_NUMBER (limit, 2); + if (XINT (limit) > XINT (temp)) + temp = limit; + } + return Fprevious_property_change (position, Qnil, temp); +} + DEFUN ("next-property-change", Fnext_property_change, - Snext_property_change, 2, 2, 0, - "Return the position after POSITION in OBJECT which has properties\n\ -different from those at POSITION. OBJECT may be a string or buffer.\n\ -Returns nil if unsuccessful.") - (pos, object) - Lisp_Object pos, object; + Snext_property_change, 1, 3, 0, + "Return the position of next property change.\n\ +Scans characters forward from POSITION in OBJECT till it finds\n\ +a change in some text property, then returns the position of the change.\n\ +The optional second argument OBJECT is the string or buffer to scan.\n\ +Return nil if the property is constant all the way to the end of OBJECT.\n\ +If the value is non-nil, it is a position greater than POSITION, never equal.\n\n\ +If the optional third argument LIMIT is non-nil, don't search\n\ +past position LIMIT; return LIMIT if nothing is found before LIMIT.") + (position, object, limit) + Lisp_Object position, object, limit; +{ + register INTERVAL i, next; + + if (NILP (object)) + XSETBUFFER (object, current_buffer); + + if (! NILP (limit) && ! EQ (limit, Qt)) + CHECK_NUMBER_COERCE_MARKER (limit, 0); + + i = validate_interval_range (object, &position, &position, soft); + + /* If LIMIT is t, return start of next interval--don't + bother checking further intervals. */ + if (EQ (limit, Qt)) + { + if (NULL_INTERVAL_P (i)) + next = i; + else + next = next_interval (i); + + if (NULL_INTERVAL_P (next)) + XSETFASTINT (position, (STRINGP (object) + ? XSTRING (object)->size + : BUF_ZV (XBUFFER (object)))); + else + XSETFASTINT (position, next->position - (STRINGP (object))); + return position; + } + + if (NULL_INTERVAL_P (i)) + return limit; + + next = next_interval (i); + + while (! NULL_INTERVAL_P (next) && intervals_equal (i, next) + && (NILP (limit) + || next->position - (STRINGP (object)) < XFASTINT (limit))) + next = next_interval (next); + + if (NULL_INTERVAL_P (next)) + return limit; + if (! NILP (limit) + && !(next->position - (STRINGP (object)) < XFASTINT (limit))) + return limit; + + XSETFASTINT (position, next->position - (STRINGP (object))); + return position; +} + +/* Return 1 if there's a change in some property between BEG and END. */ + +int +property_change_between_p (beg, end) + int beg, end; { register INTERVAL i, next; + Lisp_Object object, pos; + + XSETBUFFER (object, current_buffer); + XSETFASTINT (pos, beg); i = validate_interval_range (object, &pos, &pos, soft); if (NULL_INTERVAL_P (i)) - return Qnil; + return 0; next = next_interval (i); while (! NULL_INTERVAL_P (next) && intervals_equal (i, next)) - next = next_interval (next); + { + next = next_interval (next); + if (NULL_INTERVAL_P (next)) + return 0; + if (next->position - (STRINGP (object)) >= end) + return 0; + } if (NULL_INTERVAL_P (next)) - return Qnil; + return 0; - return next->position; + return 1; } DEFUN ("next-single-property-change", Fnext_single_property_change, - Snext_single_property_change, 3, 3, 0, - "Return the position after POSITION in OBJECT which has a different\n\ -value for PROPERTY than the text at POSITION. OBJECT may be a string or\n\ -buffer. Returns nil if unsuccessful.") - (pos, object, prop) + Snext_single_property_change, 2, 4, 0, + "Return the position of next property change for a specific property.\n\ +Scans characters forward from POSITION till it finds\n\ +a change in the PROP property, then returns the position of the change.\n\ +The optional third argument OBJECT is the string or buffer to scan.\n\ +The property values are compared with `eq'.\n\ +Return nil if the property is constant all the way to the end of OBJECT.\n\ +If the value is non-nil, it is a position greater than POSITION, never equal.\n\n\ +If the optional fourth argument LIMIT is non-nil, don't search\n\ +past position LIMIT; return LIMIT if nothing is found before LIMIT.") + (position, prop, object, limit) + Lisp_Object position, prop, object, limit; { register INTERVAL i, next; register Lisp_Object here_val; - i = validate_interval_range (object, &pos, &pos, soft); + if (NILP (object)) + XSETBUFFER (object, current_buffer); + + if (!NILP (limit)) + CHECK_NUMBER_COERCE_MARKER (limit, 0); + + i = validate_interval_range (object, &position, &position, soft); if (NULL_INTERVAL_P (i)) - return Qnil; + return limit; - here_val = Fget (prop, i->plist); + here_val = textget (i->plist, prop); next = next_interval (i); - while (! NULL_INTERVAL_P (next) && EQ (here_val, Fget (prop, next->plist))) + while (! NULL_INTERVAL_P (next) + && EQ (here_val, textget (next->plist, prop)) + && (NILP (limit) || next->position - (STRINGP (object)) < XFASTINT (limit))) next = next_interval (next); if (NULL_INTERVAL_P (next)) - return Qnil; + return limit; + if (! NILP (limit) + && !(next->position - (STRINGP (object)) < XFASTINT (limit))) + return limit; - return next->position; + XSETFASTINT (position, next->position - (STRINGP (object))); + return position; } DEFUN ("previous-property-change", Fprevious_property_change, - Sprevious_property_change, 2, 2, 0, - "Return the position preceding POSITION in OBJECT which has properties\n\ -different from those at POSITION. OBJECT may be a string or buffer.\n\ -Returns nil if unsuccessful.") - (pos, object) - Lisp_Object pos, object; + Sprevious_property_change, 1, 3, 0, + "Return the position of previous property change.\n\ +Scans characters backwards from POSITION in OBJECT till it finds\n\ +a change in some text property, then returns the position of the change.\n\ +The optional second argument OBJECT is the string or buffer to scan.\n\ +Return nil if the property is constant all the way to the start of OBJECT.\n\ +If the value is non-nil, it is a position less than POSITION, never equal.\n\n\ +If the optional third argument LIMIT is non-nil, don't search\n\ +back past position LIMIT; return LIMIT if nothing is found until LIMIT.") + (position, object, limit) + Lisp_Object position, object, limit; { register INTERVAL i, previous; - i = validate_interval_range (object, &pos, &pos, soft); + if (NILP (object)) + XSETBUFFER (object, current_buffer); + + if (!NILP (limit)) + CHECK_NUMBER_COERCE_MARKER (limit, 0); + + i = validate_interval_range (object, &position, &position, soft); if (NULL_INTERVAL_P (i)) - return Qnil; + return limit; + + /* Start with the interval containing the char before point. */ + if (i->position == XFASTINT (position)) + i = previous_interval (i); previous = previous_interval (i); - while (! NULL_INTERVAL_P (previous) && intervals_equal (previous, i)) + while (! NULL_INTERVAL_P (previous) && intervals_equal (previous, i) + && (NILP (limit) + || (previous->position + LENGTH (previous) - (STRINGP (object)) + > XFASTINT (limit)))) previous = previous_interval (previous); if (NULL_INTERVAL_P (previous)) - return Qnil; - - return previous->position + LENGTH (previous) - 1; + return limit; + if (!NILP (limit) + && !(previous->position + LENGTH (previous) - (STRINGP (object)) + > XFASTINT (limit))) + return limit; + + XSETFASTINT (position, (previous->position + LENGTH (previous) + - (STRINGP (object)))); + return position; } DEFUN ("previous-single-property-change", Fprevious_single_property_change, - Sprevious_single_property_change, 3, 3, 0, - "Return the position preceding POSITION in OBJECT which has a\n\ -different value for PROPERTY than the text at POSITION. OBJECT may be -a string or buffer. Returns nil if unsuccessful.") - (pos, object, prop) + Sprevious_single_property_change, 2, 4, 0, + "Return the position of previous property change for a specific property.\n\ +Scans characters backward from POSITION till it finds\n\ +a change in the PROP property, then returns the position of the change.\n\ +The optional third argument OBJECT is the string or buffer to scan.\n\ +The property values are compared with `eq'.\n\ +Return nil if the property is constant all the way to the start of OBJECT.\n\ +If the value is non-nil, it is a position less than POSITION, never equal.\n\n\ +If the optional fourth argument LIMIT is non-nil, don't search\n\ +back past position LIMIT; return LIMIT if nothing is found until LIMIT.") + (position, prop, object, limit) + Lisp_Object position, prop, object, limit; { register INTERVAL i, previous; register Lisp_Object here_val; - i = validate_interval_range (object, &pos, &pos, soft); + if (NILP (object)) + XSETBUFFER (object, current_buffer); + + if (!NILP (limit)) + CHECK_NUMBER_COERCE_MARKER (limit, 0); + + i = validate_interval_range (object, &position, &position, soft); + + /* Start with the interval containing the char before point. */ + if (! NULL_INTERVAL_P (i) && i->position == XFASTINT (position)) + i = previous_interval (i); + if (NULL_INTERVAL_P (i)) - return Qnil; + return limit; - here_val = Fget (prop, i->plist); + here_val = textget (i->plist, prop); previous = previous_interval (i); while (! NULL_INTERVAL_P (previous) - && EQ (here_val, Fget (prop, previous->plist))) + && EQ (here_val, textget (previous->plist, prop)) + && (NILP (limit) + || (previous->position + LENGTH (previous) - (STRINGP (object)) + > XFASTINT (limit)))) previous = previous_interval (previous); if (NULL_INTERVAL_P (previous)) - return Qnil; - - return previous->position + LENGTH (previous) - 1; + return limit; + if (!NILP (limit) + && !(previous->position + LENGTH (previous) - (STRINGP (object)) + > XFASTINT (limit))) + return limit; + + XSETFASTINT (position, (previous->position + LENGTH (previous) + - (STRINGP (object)))); + return position; } + +/* Callers note, this can GC when OBJECT is a buffer (or nil). */ DEFUN ("add-text-properties", Fadd_text_properties, - Sadd_text_properties, 4, 4, 0, - "Add the PROPERTIES (a property list) to the text of OBJECT\n\ -(a string or buffer) in the range START to END. Returns t if any change\n\ -was made, nil otherwise.") - (object, start, end, properties) - Lisp_Object object, start, end, properties; + Sadd_text_properties, 3, 4, 0, + "Add properties to the text from START to END.\n\ +The third argument PROPERTIES is a property list\n\ +specifying the property values to add.\n\ +The optional fourth argument, OBJECT,\n\ +is the string or buffer containing the text.\n\ +Return t if any property value actually changed, nil otherwise.") + (start, end, properties, object) + Lisp_Object start, end, properties, object; { register INTERVAL i, unchanged; - register int s, len, modified; + register int s, len, modified = 0; + struct gcpro gcpro1; properties = validate_plist (properties); if (NILP (properties)) return Qnil; + if (NILP (object)) + XSETBUFFER (object, current_buffer); + i = validate_interval_range (object, &start, &end, hard); if (NULL_INTERVAL_P (i)) return Qnil; @@ -466,159 +946,255 @@ was made, nil otherwise.") s = XINT (start); len = XINT (end) - s; + /* No need to protect OBJECT, because we GC only if it's a buffer, + and live buffers are always protected. */ + GCPRO1 (properties); + /* If we're not starting on an interval boundary, we have to - split this interval. */ + split this interval. */ if (i->position != s) { /* If this interval already has the properties, we can - skip it. */ + skip it. */ if (interval_has_all_properties (properties, i)) { int got = (LENGTH (i) - (s - i->position)); if (got >= len) - return Qnil; + RETURN_UNGCPRO (Qnil); len -= got; + i = next_interval (i); } else { unchanged = i; - i = split_interval_right (unchanged, s - unchanged->position + 1); + i = split_interval_right (unchanged, s - unchanged->position); copy_properties (unchanged, i); - if (LENGTH (i) > len) - { - i = split_interval_left (i, len + 1); - copy_properties (unchanged, i); - add_properties (properties, i); - return Qt; - } - - add_properties (properties, i); - modified = 1; - len -= LENGTH (i); - i = next_interval (i); } } - /* We are at the beginning of an interval, with len to scan */ - while (1) + if (BUFFERP (object)) + modify_region (XBUFFER (object), XINT (start), XINT (end)); + + /* We are at the beginning of interval I, with LEN chars to scan. */ + for (;;) { + if (i == 0) + abort (); + if (LENGTH (i) >= len) { + /* We can UNGCPRO safely here, because there will be just + one more chance to gc, in the next call to add_properties, + and after that we will not need PROPERTIES or OBJECT again. */ + UNGCPRO; + if (interval_has_all_properties (properties, i)) - return modified ? Qt : Qnil; + { + if (BUFFERP (object)) + signal_after_change (XINT (start), XINT (end) - XINT (start), + XINT (end) - XINT (start)); + + return modified ? Qt : Qnil; + } if (LENGTH (i) == len) { - add_properties (properties, i); + add_properties (properties, i, object); + if (BUFFERP (object)) + signal_after_change (XINT (start), XINT (end) - XINT (start), + XINT (end) - XINT (start)); return Qt; } /* i doesn't have the properties, and goes past the change limit */ unchanged = i; - i = split_interval_left (unchanged, len + 1); + i = split_interval_left (unchanged, len); copy_properties (unchanged, i); - add_properties (properties, i); + add_properties (properties, i, object); + if (BUFFERP (object)) + signal_after_change (XINT (start), XINT (end) - XINT (start), + XINT (end) - XINT (start)); return Qt; } len -= LENGTH (i); - modified += add_properties (properties, i); + modified += add_properties (properties, i, object); i = next_interval (i); } } +/* Callers note, this can GC when OBJECT is a buffer (or nil). */ + +DEFUN ("put-text-property", Fput_text_property, + Sput_text_property, 4, 5, 0, + "Set one property of the text from START to END.\n\ +The third and fourth arguments PROPERTY and VALUE\n\ +specify the property to add.\n\ +The optional fifth argument, OBJECT,\n\ +is the string or buffer containing the text.") + (start, end, property, value, object) + Lisp_Object start, end, property, value, object; +{ + Fadd_text_properties (start, end, + Fcons (property, Fcons (value, Qnil)), + object); + return Qnil; +} + DEFUN ("set-text-properties", Fset_text_properties, - Sset_text_properties, 4, 4, 0, - "Make the text of OBJECT (a string or buffer) have precisely\n\ -PROPERTIES (a list of properties) in the range START to END.\n\ -\n\ -If called with a valid property list, return t (text was changed).\n\ -Otherwise return nil.") - (object, start, end, properties) - Lisp_Object object, start, end, properties; + Sset_text_properties, 3, 4, 0, + "Completely replace properties of text from START to END.\n\ +The third argument PROPERTIES is the new property list.\n\ +The optional fourth argument, OBJECT,\n\ +is the string or buffer containing the text.") + (start, end, properties, object) + Lisp_Object start, end, properties, object; { register INTERVAL i, unchanged; register INTERVAL prev_changed = NULL_INTERVAL; register int s, len; + Lisp_Object ostart, oend; + int have_modified = 0; + + ostart = start; + oend = end; properties = validate_plist (properties); - if (NILP (properties)) - return Qnil; - i = validate_interval_range (object, &start, &end, hard); + if (NILP (object)) + XSETBUFFER (object, current_buffer); + + /* If we want no properties for a whole string, + get rid of its intervals. */ + if (NILP (properties) && STRINGP (object) + && XFASTINT (start) == 0 + && XFASTINT (end) == XSTRING (object)->size) + { + if (! XSTRING (object)->intervals) + return Qt; + + XSTRING (object)->intervals = 0; + return Qt; + } + + i = validate_interval_range (object, &start, &end, soft); + if (NULL_INTERVAL_P (i)) - return Qnil; + { + /* If buffer has no properties, and we want none, return now. */ + if (NILP (properties)) + return Qnil; + + /* Restore the original START and END values + because validate_interval_range increments them for strings. */ + start = ostart; + end = oend; + + i = validate_interval_range (object, &start, &end, hard); + /* This can return if start == end. */ + if (NULL_INTERVAL_P (i)) + return Qnil; + } s = XINT (start); len = XINT (end) - s; + if (BUFFERP (object)) + modify_region (XBUFFER (object), XINT (start), XINT (end)); + if (i->position != s) { unchanged = i; - i = split_interval_right (unchanged, s - unchanged->position + 1); - set_properties (properties, i); + i = split_interval_right (unchanged, s - unchanged->position); if (LENGTH (i) > len) { - i = split_interval_right (i, len); copy_properties (unchanged, i); + i = split_interval_left (i, len); + set_properties (properties, i, object); + if (BUFFERP (object)) + signal_after_change (XINT (start), XINT (end) - XINT (start), + XINT (end) - XINT (start)); + return Qt; } + set_properties (properties, i, object); + if (LENGTH (i) == len) - return Qt; + { + if (BUFFERP (object)) + signal_after_change (XINT (start), XINT (end) - XINT (start), + XINT (end) - XINT (start)); + + return Qt; + } prev_changed = i; len -= LENGTH (i); i = next_interval (i); } + /* We are starting at the beginning of an interval, I */ while (len > 0) { + if (i == 0) + abort (); + if (LENGTH (i) >= len) { - if (LENGTH (i) == len) - { - if (NULL_INTERVAL_P (prev_changed)) - set_properties (properties, i); - else - merge_interval_left (i); - return Qt; - } + if (LENGTH (i) > len) + i = split_interval_left (i, len); - i = split_interval_left (i, len + 1); - if (NULL_INTERVAL_P (prev_changed)) - set_properties (properties, i); - else + /* We have to call set_properties even if we are going to + merge the intervals, so as to make the undo records + and cause redisplay to happen. */ + set_properties (properties, i, object); + if (!NULL_INTERVAL_P (prev_changed)) merge_interval_left (i); + if (BUFFERP (object)) + signal_after_change (XINT (start), XINT (end) - XINT (start), + XINT (end) - XINT (start)); return Qt; } len -= LENGTH (i); + + /* We have to call set_properties even if we are going to + merge the intervals, so as to make the undo records + and cause redisplay to happen. */ + set_properties (properties, i, object); if (NULL_INTERVAL_P (prev_changed)) - { - set_properties (properties, i); - prev_changed = i; - } + prev_changed = i; else prev_changed = i = merge_interval_left (i); i = next_interval (i); } + if (BUFFERP (object)) + signal_after_change (XINT (start), XINT (end) - XINT (start), + XINT (end) - XINT (start)); return Qt; } DEFUN ("remove-text-properties", Fremove_text_properties, - Sremove_text_properties, 4, 4, 0, - "Remove the PROPERTIES (a property list) from the text of OBJECT\n\ -(a string or buffer) in the range START to END. Returns t if any change\n\ -was made, nil otherwise.") - (object, start, end, properties) - Lisp_Object object, start, end, properties; + Sremove_text_properties, 3, 4, 0, + "Remove some properties from text from START to END.\n\ +The third argument PROPERTIES is a property list\n\ +whose property names specify the properties to remove.\n\ +\(The values stored in PROPERTIES are ignored.)\n\ +The optional fourth argument, OBJECT,\n\ +is the string or buffer containing the text.\n\ +Return t if any property was actually removed, nil otherwise.") + (start, end, properties, object) + Lisp_Object start, end, properties, object; { register INTERVAL i, unchanged; - register int s, len, modified; + register int s, len, modified = 0; + + if (NILP (object)) + XSETBUFFER (object, current_buffer); i = validate_interval_range (object, &start, &end, soft); if (NULL_INTERVAL_P (i)) @@ -630,39 +1206,34 @@ was made, nil otherwise.") if (i->position != s) { /* No properties on this first interval -- return if - it covers the entire region. */ + it covers the entire region. */ if (! interval_has_some_properties (properties, i)) { int got = (LENGTH (i) - (s - i->position)); if (got >= len) return Qnil; len -= got; + i = next_interval (i); } - /* Remove the properties from this interval. If it's short - enough, return, splitting it if it's too short. */ + /* Split away the beginning of this interval; what we don't + want to modify. */ else { unchanged = i; - i = split_interval_right (unchanged, s - unchanged->position + 1); + i = split_interval_right (unchanged, s - unchanged->position); copy_properties (unchanged, i); - if (LENGTH (i) > len) - { - i = split_interval_left (i, len + 1); - copy_properties (unchanged, i); - remove_properties (properties, i); - return Qt; - } - - remove_properties (properties, i); - modified = 1; - len -= LENGTH (i); - i = next_interval (i); } } + if (BUFFERP (object)) + modify_region (XBUFFER (object), XINT (start), XINT (end)); + /* We are at the beginning of an interval, with len to scan */ - while (1) + for (;;) { + if (i == 0) + abort (); + if (LENGTH (i) >= len) { if (! interval_has_some_properties (properties, i)) @@ -670,34 +1241,119 @@ was made, nil otherwise.") if (LENGTH (i) == len) { - remove_properties (properties, i); + remove_properties (properties, i, object); + if (BUFFERP (object)) + signal_after_change (XINT (start), XINT (end) - XINT (start), + XINT (end) - XINT (start)); return Qt; } /* i has the properties, and goes past the change limit */ - unchanged = split_interval_right (i, len + 1); + unchanged = i; + i = split_interval_left (i, len); copy_properties (unchanged, i); - remove_properties (properties, i); + remove_properties (properties, i, object); + if (BUFFERP (object)) + signal_after_change (XINT (start), XINT (end) - XINT (start), + XINT (end) - XINT (start)); return Qt; } len -= LENGTH (i); - modified += remove_properties (properties, i); + modified += remove_properties (properties, i, object); i = next_interval (i); } } + +DEFUN ("text-property-any", Ftext_property_any, + Stext_property_any, 4, 5, 0, + "Check text from START to END for property PROPERTY equalling VALUE.\n\ +If so, return the position of the first character whose property PROPERTY\n\ +is `eq' to VALUE. Otherwise return nil.\n\ +The optional fifth argument, OBJECT, is the string or buffer\n\ +containing the text.") + (start, end, property, value, object) + Lisp_Object start, end, property, value, object; +{ + register INTERVAL i; + register int e, pos; + + if (NILP (object)) + XSETBUFFER (object, current_buffer); + i = validate_interval_range (object, &start, &end, soft); + if (NULL_INTERVAL_P (i)) + return (!NILP (value) || EQ (start, end) ? Qnil : start); + e = XINT (end); + + while (! NULL_INTERVAL_P (i)) + { + if (i->position >= e) + break; + if (EQ (textget (i->plist, property), value)) + { + pos = i->position; + if (pos < XINT (start)) + pos = XINT (start); + return make_number (pos - (STRINGP (object))); + } + i = next_interval (i); + } + return Qnil; +} + +DEFUN ("text-property-not-all", Ftext_property_not_all, + Stext_property_not_all, 4, 5, 0, + "Check text from START to END for property PROPERTY not equalling VALUE.\n\ +If so, return the position of the first character whose property PROPERTY\n\ +is not `eq' to VALUE. Otherwise, return nil.\n\ +The optional fifth argument, OBJECT, is the string or buffer\n\ +containing the text.") + (start, end, property, value, object) + Lisp_Object start, end, property, value, object; +{ + register INTERVAL i; + register int s, e; + + if (NILP (object)) + XSETBUFFER (object, current_buffer); + i = validate_interval_range (object, &start, &end, soft); + if (NULL_INTERVAL_P (i)) + return (NILP (value) || EQ (start, end)) ? Qnil : start; + s = XINT (start); + e = XINT (end); + + while (! NULL_INTERVAL_P (i)) + { + if (i->position >= e) + break; + if (! EQ (textget (i->plist, property), value)) + { + if (i->position > s) + s = i->position; + return make_number (s - (STRINGP (object))); + } + i = next_interval (i); + } + return Qnil; +} + +#if 0 /* You can use set-text-properties for this. */ DEFUN ("erase-text-properties", Ferase_text_properties, - Serase_text_properties, 3, 3, 0, - "Remove all text properties from OBJECT (a string or buffer), in the\n\ -range START to END. Returns t if any change was made, nil otherwise.") - (object, start, end) - Lisp_Object object, start, end; + Serase_text_properties, 2, 3, 0, + "Remove all properties from the text from START to END.\n\ +The optional third argument, OBJECT,\n\ +is the string or buffer containing the text.") + (start, end, object) + Lisp_Object start, end, object; { - register INTERVAL i, unchanged; - register prev_changed = NULL_INTERVAL; + register INTERVAL i; + register INTERVAL prev_changed = NULL_INTERVAL; register int s, len, modified; + if (NILP (object)) + XSETBUFFER (object, current_buffer); + i = validate_interval_range (object, &start, &end, soft); if (NULL_INTERVAL_P (i)) return Qnil; @@ -708,18 +1364,18 @@ range START to END. Returns t if any change was made, nil otherwise.") if (i->position != s) { register int got; - unchanged = i; + register INTERVAL unchanged = i; - /* If there are properties here, then this text will be modified. */ - if (!NILP (i->plist)) + /* If there are properties here, then this text will be modified. */ + if (! NILP (i->plist)) { - i = split_interval_right (unchanged, s - unchanged->position + 1); + i = split_interval_right (unchanged, s - unchanged->position); i->plist = Qnil; modified++; if (LENGTH (i) > len) { - i = split_interval_right (i, len + 1); + i = split_interval_right (i, len); copy_properties (unchanged, i); return Qt; } @@ -729,10 +1385,13 @@ range START to END. Returns t if any change was made, nil otherwise.") got = LENGTH (i); } - /* If the text of i is without any properties, and contains - LEN or more characters, then we return witout changing anything.*/ + /* If the text of I is without any properties, and contains + LEN or more characters, then we may return without changing + anything.*/ else if (LENGTH (i) - (s - i->position) <= len) return Qnil; + /* The amount of text to change extends past I, so just note + how much we've gotten. */ else got = LENGTH (i) - (s - i->position); @@ -741,15 +1400,13 @@ range START to END. Returns t if any change was made, nil otherwise.") i = next_interval (i); } - /* We are starting at the beginning of an interval, I. */ + /* We are starting at the beginning of an interval, I. */ while (len > 0) { if (LENGTH (i) >= len) { - /* If this last interval is exactly the right length, - or is already without properties, then there's nothing - to do except merge it if possible. */ - if (NILP (i->plist) || LENGTH (i) == len) + /* If I has no properties, simply merge it if possible. */ + if (NILP (i->plist)) { if (! NULL_INTERVAL_P (prev_changed)) merge_interval_left (i); @@ -757,16 +1414,17 @@ range START to END. Returns t if any change was made, nil otherwise.") return modified ? Qt : Qnil; } - /* Here we know the last interval is longer than LEN and - has properties. */ - i = split_interval_left (i, len + 1); - modified += erase_properties (i); + if (LENGTH (i) > len) + i = split_interval_left (i, len); if (! NULL_INTERVAL_P (prev_changed)) merge_interval_left (i); + else + i->plist = Qnil; - return modified ? Qt : Qnil; + return Qt; } + /* Here if we still need to erase past the end of I */ len -= LENGTH (i); if (NULL_INTERVAL_P (prev_changed)) { @@ -775,8 +1433,8 @@ range START to END. Returns t if any change was made, nil otherwise.") } else { - if (! NULL_INTERVAL_P (i)) - modified++; + modified += ! NILP (i->plist); + /* Merging I will give it the properties of PREV_CHANGED. */ prev_changed = i = merge_interval_left (i); } @@ -785,15 +1443,339 @@ range START to END. Returns t if any change was made, nil otherwise.") return modified ? Qt : Qnil; } +#endif /* 0 */ + +/* I don't think this is the right interface to export; how often do you + want to do something like this, other than when you're copying objects + around? + + I think it would be better to have a pair of functions, one which + returns the text properties of a region as a list of ranges and + plists, and another which applies such a list to another object. */ + +/* Add properties from SRC to SRC of SRC, starting at POS in DEST. + SRC and DEST may each refer to strings or buffers. + Optional sixth argument PROP causes only that property to be copied. + Properties are copied to DEST as if by `add-text-properties'. + Return t if any property value actually changed, nil otherwise. */ + +/* Note this can GC when DEST is a buffer. */ + +Lisp_Object +copy_text_properties (start, end, src, pos, dest, prop) + Lisp_Object start, end, src, pos, dest, prop; +{ + INTERVAL i; + Lisp_Object res; + Lisp_Object stuff; + Lisp_Object plist; + int s, e, e2, p, len, modified = 0; + struct gcpro gcpro1, gcpro2; + + i = validate_interval_range (src, &start, &end, soft); + if (NULL_INTERVAL_P (i)) + return Qnil; + + CHECK_NUMBER_COERCE_MARKER (pos, 0); + { + Lisp_Object dest_start, dest_end; + + dest_start = pos; + XSETFASTINT (dest_end, XINT (dest_start) + (XINT (end) - XINT (start))); + /* Apply this to a copy of pos; it will try to increment its arguments, + which we don't want. */ + validate_interval_range (dest, &dest_start, &dest_end, soft); + } + + s = XINT (start); + e = XINT (end); + p = XINT (pos); + + stuff = Qnil; + + while (s < e) + { + e2 = i->position + LENGTH (i); + if (e2 > e) + e2 = e; + len = e2 - s; + + plist = i->plist; + if (! NILP (prop)) + while (! NILP (plist)) + { + if (EQ (Fcar (plist), prop)) + { + plist = Fcons (prop, Fcons (Fcar (Fcdr (plist)), Qnil)); + break; + } + plist = Fcdr (Fcdr (plist)); + } + if (! NILP (plist)) + { + /* Must defer modifications to the interval tree in case src + and dest refer to the same string or buffer. */ + stuff = Fcons (Fcons (make_number (p), + Fcons (make_number (p + len), + Fcons (plist, Qnil))), + stuff); + } + + i = next_interval (i); + if (NULL_INTERVAL_P (i)) + break; + + p += len; + s = i->position; + } + + GCPRO2 (stuff, dest); + + while (! NILP (stuff)) + { + res = Fcar (stuff); + res = Fadd_text_properties (Fcar (res), Fcar (Fcdr (res)), + Fcar (Fcdr (Fcdr (res))), dest); + if (! NILP (res)) + modified++; + stuff = Fcdr (stuff); + } + + UNGCPRO; + + return modified ? Qt : Qnil; +} + +/* Call the modification hook functions in LIST, each with START and END. */ + +static void +call_mod_hooks (list, start, end) + Lisp_Object list, start, end; +{ + struct gcpro gcpro1; + GCPRO1 (list); + while (!NILP (list)) + { + call2 (Fcar (list), start, end); + list = Fcdr (list); + } + UNGCPRO; +} + +/* Check for read-only intervals between character positions START ... END, + in BUF, and signal an error if we find one. + + Then check for any modification hooks in the range. + Create a list of all these hooks in lexicographic order, + eliminating consecutive extra copies of the same hook. Then call + those hooks in order, with START and END - 1 as arguments. */ void -syms_of_textprop () +verify_interval_modification (buf, start, end) + struct buffer *buf; + int start, end; { - DEFVAR_INT ("interval-balance-threshold", &interval_balance_threshold, - "Threshold for rebalancing interval trees, expressed as the -percentage by which the left interval tree should not differ from the right."); - interval_balance_threshold = 8; + register INTERVAL intervals = BUF_INTERVALS (buf); + register INTERVAL i, prev; + Lisp_Object hooks; + register Lisp_Object prev_mod_hooks; + Lisp_Object mod_hooks; + struct gcpro gcpro1; + + hooks = Qnil; + prev_mod_hooks = Qnil; + mod_hooks = Qnil; + + interval_insert_behind_hooks = Qnil; + interval_insert_in_front_hooks = Qnil; + + if (NULL_INTERVAL_P (intervals)) + return; + + if (start > end) + { + int temp = start; + start = end; + end = temp; + } + + /* For an insert operation, check the two chars around the position. */ + if (start == end) + { + INTERVAL prev; + Lisp_Object before, after; + + /* Set I to the interval containing the char after START, + and PREV to the interval containing the char before START. + Either one may be null. They may be equal. */ + i = find_interval (intervals, start); + + if (start == BUF_BEGV (buf)) + prev = 0; + else if (i->position == start) + prev = previous_interval (i); + else if (i->position < start) + prev = i; + if (start == BUF_ZV (buf)) + i = 0; + + /* If Vinhibit_read_only is set and is not a list, we can + skip the read_only checks. */ + if (NILP (Vinhibit_read_only) || CONSP (Vinhibit_read_only)) + { + /* If I and PREV differ we need to check for the read-only + property together with its stickiness. If either I or + PREV are 0, this check is all we need. + We have to take special care, since read-only may be + indirectly defined via the category property. */ + if (i != prev) + { + if (! NULL_INTERVAL_P (i)) + { + after = textget (i->plist, Qread_only); + + /* If interval I is read-only and read-only is + front-sticky, inhibit insertion. + Check for read-only as well as category. */ + if (! NILP (after) + && NILP (Fmemq (after, Vinhibit_read_only))) + { + Lisp_Object tem; + + tem = textget (i->plist, Qfront_sticky); + if (TMEM (Qread_only, tem) + || (NILP (Fplist_get (i->plist, Qread_only)) + && TMEM (Qcategory, tem))) + error ("Attempt to insert within read-only text"); + } + } + + if (! NULL_INTERVAL_P (prev)) + { + before = textget (prev->plist, Qread_only); + + /* If interval PREV is read-only and read-only isn't + rear-nonsticky, inhibit insertion. + Check for read-only as well as category. */ + if (! NILP (before) + && NILP (Fmemq (before, Vinhibit_read_only))) + { + Lisp_Object tem; + + tem = textget (prev->plist, Qrear_nonsticky); + if (! TMEM (Qread_only, tem) + && (! NILP (Fplist_get (prev->plist,Qread_only)) + || ! TMEM (Qcategory, tem))) + error ("Attempt to insert within read-only text"); + } + } + } + else if (! NULL_INTERVAL_P (i)) + { + after = textget (i->plist, Qread_only); + + /* If interval I is read-only and read-only is + front-sticky, inhibit insertion. + Check for read-only as well as category. */ + if (! NILP (after) && NILP (Fmemq (after, Vinhibit_read_only))) + { + Lisp_Object tem; + + tem = textget (i->plist, Qfront_sticky); + if (TMEM (Qread_only, tem) + || (NILP (Fplist_get (i->plist, Qread_only)) + && TMEM (Qcategory, tem))) + error ("Attempt to insert within read-only text"); + + tem = textget (prev->plist, Qrear_nonsticky); + if (! TMEM (Qread_only, tem) + && (! NILP (Fplist_get (prev->plist, Qread_only)) + || ! TMEM (Qcategory, tem))) + error ("Attempt to insert within read-only text"); + } + } + } + + /* Run both insert hooks (just once if they're the same). */ + if (!NULL_INTERVAL_P (prev)) + interval_insert_behind_hooks + = textget (prev->plist, Qinsert_behind_hooks); + if (!NULL_INTERVAL_P (i)) + interval_insert_in_front_hooks + = textget (i->plist, Qinsert_in_front_hooks); + } + else + { + /* Loop over intervals on or next to START...END, + collecting their hooks. */ + i = find_interval (intervals, start); + do + { + if (! INTERVAL_WRITABLE_P (i)) + error ("Attempt to modify read-only text"); + + mod_hooks = textget (i->plist, Qmodification_hooks); + if (! NILP (mod_hooks) && ! EQ (mod_hooks, prev_mod_hooks)) + { + hooks = Fcons (mod_hooks, hooks); + prev_mod_hooks = mod_hooks; + } + + i = next_interval (i); + } + /* Keep going thru the interval containing the char before END. */ + while (! NULL_INTERVAL_P (i) && i->position < end); + + GCPRO1 (hooks); + hooks = Fnreverse (hooks); + while (! EQ (hooks, Qnil)) + { + call_mod_hooks (Fcar (hooks), make_number (start), + make_number (end)); + hooks = Fcdr (hooks); + } + UNGCPRO; + } +} + +/* Run the interval hooks for an insertion on character range START ... END. + verify_interval_modification chose which hooks to run; + this function is called after the insertion happens + so it can indicate the range of inserted text. */ + +void +report_interval_modification (start, end) + Lisp_Object start, end; +{ + if (! NILP (interval_insert_behind_hooks)) + call_mod_hooks (interval_insert_behind_hooks, start, end); + if (! NILP (interval_insert_in_front_hooks) + && ! EQ (interval_insert_in_front_hooks, + interval_insert_behind_hooks)) + call_mod_hooks (interval_insert_in_front_hooks, start, end); +} + +void +syms_of_textprop () +{ + DEFVAR_LISP ("default-text-properties", &Vdefault_text_properties, + "Property-list used as default values.\n\ +The value of a property in this list is seen as the value for every\n\ +character that does not have its own value for that property."); + Vdefault_text_properties = Qnil; + + DEFVAR_LISP ("inhibit-point-motion-hooks", &Vinhibit_point_motion_hooks, + "If non-nil, don't run `point-left' and `point-entered' text properties.\n\ +This also inhibits the use of the `intangible' text property."); + Vinhibit_point_motion_hooks = Qnil; + + staticpro (&interval_insert_behind_hooks); + staticpro (&interval_insert_in_front_hooks); + interval_insert_behind_hooks = Qnil; + interval_insert_in_front_hooks = Qnil; + + /* Common attributes one might give text */ staticpro (&Qforeground); @@ -810,6 +1792,16 @@ percentage by which the left interval tree should not differ from the right."); Qread_only = intern ("read-only"); staticpro (&Qinvisible); Qinvisible = intern ("invisible"); + staticpro (&Qintangible); + Qintangible = intern ("intangible"); + staticpro (&Qcategory); + Qcategory = intern ("category"); + staticpro (&Qlocal_map); + Qlocal_map = intern ("local-map"); + staticpro (&Qfront_sticky); + Qfront_sticky = intern ("front-sticky"); + staticpro (&Qrear_nonsticky); + Qrear_nonsticky = intern ("rear-nonsticky"); /* Properties that text might use to specify certain actions */ @@ -821,16 +1813,28 @@ percentage by which the left interval tree should not differ from the right."); Qpoint_left = intern ("point-left"); staticpro (&Qpoint_entered); Qpoint_entered = intern ("point-entered"); - staticpro (&Qmodification); - Qmodification = intern ("modification"); defsubr (&Stext_properties_at); + defsubr (&Sget_text_property); + defsubr (&Sget_char_property); + defsubr (&Snext_char_property_change); + defsubr (&Sprevious_char_property_change); defsubr (&Snext_property_change); defsubr (&Snext_single_property_change); defsubr (&Sprevious_property_change); defsubr (&Sprevious_single_property_change); defsubr (&Sadd_text_properties); + defsubr (&Sput_text_property); defsubr (&Sset_text_properties); defsubr (&Sremove_text_properties); - defsubr (&Serase_text_properties); + defsubr (&Stext_property_any); + defsubr (&Stext_property_not_all); +/* defsubr (&Serase_text_properties); */ +/* defsubr (&Scopy_text_properties); */ } + +#else + +lose -- this shouldn't be compiled if USE_TEXT_PROPERTIES isn't defined + +#endif /* USE_TEXT_PROPERTIES */