textprop.c 48.4 KB
Newer Older
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1
/* Interface code for dealing with text properties.
2
   Copyright (C) 1993, 1994, 1995 Free Software Foundation, Inc.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
3 4 5 6 7

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
Jim Blandy's avatar
Jim Blandy committed
8
the Free Software Foundation; either version 2, or (at your option)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
9 10 11 12 13 14 15 16 17 18 19
any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
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.  */

20
#include <config.h>
Joseph Arceneaux's avatar
Joseph Arceneaux committed
21 22 23
#include "lisp.h"
#include "intervals.h"
#include "buffer.h"
24
#include "window.h"
25 26 27 28

#ifndef NULL
#define NULL (void *)0
#endif
29 30 31 32 33

/* 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))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
34 35 36 37 38 39


/* NOTES:  previous- and next- property change will have to skip
  zero-length intervals if they are implemented.  This could be done
  inside next_interval and previous_interval.

Joseph Arceneaux's avatar
Joseph Arceneaux committed
40 41
  set_properties needs to deal with the interval property cache.

Joseph Arceneaux's avatar
Joseph Arceneaux committed
42
  It is assumed that for any interval plist, a property appears
43
  only once on the list.  Although some code i.e., remove_properties,
Joseph Arceneaux's avatar
Joseph Arceneaux committed
44
  handles the more general case, the uniqueness of properties is
45
  necessary for the system to remain consistent.  This requirement
Joseph Arceneaux's avatar
Joseph Arceneaux committed
46 47
  is enforced by the subrs installing properties onto the intervals. */

48 49
/* The rest of the file is within this conditional */
#ifdef USE_TEXT_PROPERTIES
Joseph Arceneaux's avatar
Joseph Arceneaux committed
50 51 52 53 54 55

/* Types of hooks. */
Lisp_Object Qmouse_left;
Lisp_Object Qmouse_entered;
Lisp_Object Qpoint_left;
Lisp_Object Qpoint_entered;
56 57
Lisp_Object Qcategory;
Lisp_Object Qlocal_map;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
58 59 60

/* Visual properties text (including strings) may have. */
Lisp_Object Qforeground, Qbackground, Qfont, Qunderline, Qstipple;
61
Lisp_Object Qinvisible, Qread_only, Qintangible;
62 63 64

/* Sticky properties */
Lisp_Object Qfront_sticky, Qrear_nonsticky;
65 66 67 68

/* 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.  */
69
#define PLIST_ELT_P(o1, o2) (CONSP (o1) && ((o2)=XCONS (o1)->cdr, CONSP (o2)))
70

71
Lisp_Object Vinhibit_point_motion_hooks;
72
Lisp_Object Vdefault_text_properties;
73

74 75 76 77
/* 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;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
78

Joseph Arceneaux's avatar
Joseph Arceneaux committed
79 80 81 82 83 84
/* Extract the interval at the position pointed to by BEGIN from
   OBJECT, a string or buffer.  Additionally, check that the positions
   pointed to by BEGIN and END are within the bounds of OBJECT, and
   reverse them if *BEGIN is greater than *END.  The objects pointed
   to by BEGIN and END may be integers or markers; if the latter, they
   are coerced to integers.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
85

86 87 88
   When OBJECT is a string, we increment *BEGIN and *END
   to make them origin-one.

Joseph Arceneaux's avatar
Joseph Arceneaux committed
89 90 91 92 93 94 95 96 97
   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
   the validated points to determine a length, and operates on that.
   Exceptions are Ftext_properties_at, Fnext_property_change, and
   Fprevious_property_change which call this function with BEGIN == END.
   Handle this case specially.

   If FORCE is soft (0), it's OK to return NULL_INTERVAL.  Otherwise,
Joseph Arceneaux's avatar
Joseph Arceneaux committed
98 99
   create an interval tree for OBJECT if one doesn't exist, provided
   the object actually contains text.  In the current design, if there
100
   is no text, there can be no text properties.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
101 102 103 104 105 106 107 108 109 110

#define soft 0
#define hard 1

static INTERVAL
validate_interval_range (object, begin, end, force)
     Lisp_Object object, *begin, *end;
     int force;
{
  register INTERVAL i;
111 112
  int searchpos;

Joseph Arceneaux's avatar
Joseph Arceneaux committed
113 114 115 116 117 118
  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. */
119
  if (EQ (*begin, *end) && begin != end)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
120 121 122 123
    return NULL_INTERVAL;

  if (XINT (*begin) > XINT (*end))
    {
124 125
      Lisp_Object n;
      n = *begin;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
126
      *begin = *end;
127
      *end = n;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
128 129
    }

130
  if (BUFFERP (object))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
131 132 133 134 135 136
    {
      register struct buffer *b = XBUFFER (object);

      if (!(BUF_BEGV (b) <= XINT (*begin) && XINT (*begin) <= XINT (*end)
	    && XINT (*end) <= BUF_ZV (b)))
	args_out_of_range (*begin, *end);
137
      i = BUF_INTERVALS (b);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
138

139 140 141 142 143
      /* If there's no text, there are no properties. */
      if (BUF_BEGV (b) == BUF_ZV (b))
	return NULL_INTERVAL;

      searchpos = XINT (*begin);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
144 145 146 147 148
    }
  else
    {
      register struct Lisp_String *s = XSTRING (object);

149
      if (! (0 <= XINT (*begin) && XINT (*begin) <= XINT (*end)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
150 151
	     && XINT (*end) <= s->size))
	args_out_of_range (*begin, *end);
152 153
      /* User-level Positions in strings start with 0,
	 but the interval code always wants positions starting with 1.  */
154
      XSETFASTINT (*begin, XFASTINT (*begin) + 1);
155
      if (begin != end)
156
	XSETFASTINT (*end, XFASTINT (*end) + 1);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
157
      i = s->intervals;
158 159 160 161 162

      if (s->size == 0)
	return NULL_INTERVAL;

      searchpos = XINT (*begin);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
163 164 165 166 167
    }

  if (NULL_INTERVAL_P (i))
    return (force ? create_root_interval (object) : i);
    
168
  return find_interval (i, searchpos);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
169 170 171 172 173 174 175 176
}

/* 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. */

static Lisp_Object
validate_plist (list)
177
     Lisp_Object list;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
178 179 180 181 182 183 184 185 186
{
  if (NILP (list))
    return Qnil;

  if (CONSP (list))
    {
      register int i;
      register Lisp_Object tail;
      for (i = 0, tail = list; !NILP (tail); i++)
187 188 189 190
	{
	  tail = Fcdr (tail);
	  QUIT;
	}
Joseph Arceneaux's avatar
Joseph Arceneaux committed
191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
      if (i & 1)
	error ("Odd length text property list");
      return list;
    }

  return Fcons (list, Fcons (Qnil, Qnil));
}

/* Return nonzero if interval I has all the properties,
   with the same values, of list PLIST. */

static int
interval_has_all_properties (plist, i)
     Lisp_Object plist;
     INTERVAL i;
{
  register Lisp_Object tail1, tail2, sym1, sym2;
  register int found;

  /* Go through each element of PLIST. */
  for (tail1 = plist; ! NILP (tail1); tail1 = Fcdr (Fcdr (tail1)))
    {
      sym1 = Fcar (tail1);
      found = 0;

      /* Go through I's plist, looking for sym1 */
      for (tail2 = i->plist; ! NILP (tail2); tail2 = Fcdr (Fcdr (tail2)))
	if (EQ (sym1, Fcar (tail2)))
	  {
	    /* Found the same property on both lists.  If the
	       values are unequal, return zero. */
222
	    if (! EQ (Fcar (Fcdr (tail1)), Fcar (Fcdr (tail2))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
	      return 0;

	    /* Property has same value on both lists;  go to next one. */
	    found = 1;
	    break;
	  }

      if (! found)
	return 0;
    }

  return 1;
}

/* Return nonzero if the plist of interval I has any of the
   properties of PLIST, regardless of their values. */

static INLINE int
interval_has_some_properties (plist, i)
     Lisp_Object plist;
     INTERVAL i;
{
  register Lisp_Object tail1, tail2, sym;

  /* Go through each element of PLIST. */
  for (tail1 = plist; ! NILP (tail1); tail1 = Fcdr (Fcdr (tail1)))
    {
      sym = Fcar (tail1);

      /* Go through i's plist, looking for tail1 */
      for (tail2 = i->plist; ! NILP (tail2); tail2 = Fcdr (Fcdr (tail2)))
	if (EQ (sym, Fcar (tail2)))
	  return 1;
    }

  return 0;
}
260

261 262 263 264
/* Changing the plists of individual intervals.  */

/* Return the value of PROP in property-list PLIST, or Qunbound if it
   has none.  */
265
static Lisp_Object
266
property_value (plist, prop)
267
     Lisp_Object plist, prop;
268 269 270 271 272 273 274 275 276 277 278 279
{
  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;
}

280 281 282 283 284 285 286 287 288
/* 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;
{
289
  Lisp_Object sym, value;
290

291
  if (BUFFERP (object))
292
    {
293 294 295 296 297 298 299
      /* 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))
300 301 302 303 304 305 306
	  {
	    modify_region (XBUFFER (object),
			   make_number (interval->position),
			   make_number (interval->position + LENGTH (interval)));
	    record_property_change (interval->position, LENGTH (interval),
				    XCONS (sym)->car, XCONS (value)->car,
				    object);
307 308
	    signal_after_change (interval->position, LENGTH (interval),
				 LENGTH (interval));
309
	  }
310 311 312 313 314 315 316

      /* 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))
317 318 319 320 321 322 323
	  {
	    modify_region (XBUFFER (object),
			   make_number (interval->position),
			   make_number (interval->position + LENGTH (interval)));
	    record_property_change (interval->position, LENGTH (interval),
				    XCONS (sym)->car, Qnil,
				    object);
324 325
	    signal_after_change (interval->position, LENGTH (interval),
				 LENGTH (interval));
326
	  }
327 328 329 330 331
    }

  /* Store new properties.  */
  interval->plist = Fcopy_sequence (properties);
}
Joseph Arceneaux's avatar
Joseph Arceneaux committed
332 333 334 335 336

/* 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.

337 338
   OBJECT should be the string or buffer the interval is in.

Joseph Arceneaux's avatar
Joseph Arceneaux committed
339 340 341
   Return nonzero if this changes I (i.e., if any members of PLIST
   are actually added to I's plist) */

342 343
static int
add_properties (plist, i, object)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
344 345
     Lisp_Object plist;
     INTERVAL i;
346
     Lisp_Object object;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
347
{
348
  Lisp_Object tail1, tail2, sym1, val1;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
349 350
  register int changed = 0;
  register int found;
351 352 353 354 355 356 357 358 359
  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);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
360 361 362 363 364 365 366 367 368 369 370 371

  /* Go through each element of PLIST. */
  for (tail1 = plist; ! NILP (tail1); tail1 = Fcdr (Fcdr (tail1)))
    {
      sym1 = Fcar (tail1);
      val1 = Fcar (Fcdr (tail1));
      found = 0;

      /* Go through I's plist, looking for sym1 */
      for (tail2 = i->plist; ! NILP (tail2); tail2 = Fcdr (Fcdr (tail2)))
	if (EQ (sym1, Fcar (tail2)))
	  {
372 373
	    /* No need to gcpro, because tail2 protects this
	       and it must be a cons cell (we get an error otherwise).  */
374
	    register Lisp_Object this_cdr;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
375

376
	    this_cdr = Fcdr (tail2);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
377 378 379 380 381
	    /* Found the property.  Now check its value. */
	    found = 1;

	    /* The properties have the same value on both lists.
	       Continue to the next property. */
382
	    if (EQ (val1, Fcar (this_cdr)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
383 384
	      break;

385
	    /* Record this change in the buffer, for undo purposes.  */
386
	    if (BUFFERP (object))
387
	      {
388 389
		modify_region (XBUFFER (object),
			       make_number (i->position),
390
			       make_number (i->position + LENGTH (i)));
391 392
		record_property_change (i->position, LENGTH (i),
					sym1, Fcar (this_cdr), object);
393
		signal_after_change (i->position, LENGTH (i), LENGTH (i));
394 395
	      }

Joseph Arceneaux's avatar
Joseph Arceneaux committed
396 397 398 399 400 401 402 403
	    /* I's property has a different value -- change it */
	    Fsetcar (this_cdr, val1);
	    changed++;
	    break;
	  }

      if (! found)
	{
404
	  /* Record this change in the buffer, for undo purposes.  */
405
	  if (BUFFERP (object))
406
	    {
407 408
	      modify_region (XBUFFER (object),
			     make_number (i->position),
409
			     make_number (i->position + LENGTH (i)));
410 411
	      record_property_change (i->position, LENGTH (i),
				      sym1, Qnil, object);
412
	      signal_after_change (i->position, LENGTH (i), LENGTH (i));
413
	    }
Joseph Arceneaux's avatar
Joseph Arceneaux committed
414 415 416 417 418
	  i->plist = Fcons (sym1, Fcons (val1, i->plist));
	  changed++;
	}
    }

419 420
  UNGCPRO;

Joseph Arceneaux's avatar
Joseph Arceneaux committed
421 422 423 424
  return changed;
}

/* For any members of PLIST which are properties of I, remove them
425 426
   from I's plist.
   OBJECT is the string or buffer containing I.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
427

428 429
static int
remove_properties (plist, i, object)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
430 431
     Lisp_Object plist;
     INTERVAL i;
432
     Lisp_Object object;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
433
{
434
  register Lisp_Object tail1, tail2, sym, current_plist;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
435 436
  register int changed = 0;

437
  current_plist = i->plist;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
438 439 440 441 442 443 444 445
  /* Go through each element of plist. */
  for (tail1 = plist; ! NILP (tail1); tail1 = Fcdr (Fcdr (tail1)))
    {
      sym = Fcar (tail1);

      /* First, remove the symbol if its at the head of the list */
      while (! NILP (current_plist) && EQ (sym, Fcar (current_plist)))
	{
446
	  if (BUFFERP (object))
447
	    {
448 449
	      modify_region (XBUFFER (object),
			     make_number (i->position),
450
			     make_number (i->position + LENGTH (i)));
451 452 453
	      record_property_change (i->position, LENGTH (i),
				      sym, Fcar (Fcdr (current_plist)),
				      object);
454
	      signal_after_change (i->position, LENGTH (i), LENGTH (i));
455 456
	    }

Joseph Arceneaux's avatar
Joseph Arceneaux committed
457 458 459 460 461 462 463 464
	  current_plist = Fcdr (Fcdr (current_plist));
	  changed++;
	}

      /* Go through i's plist, looking for sym */
      tail2 = current_plist;
      while (! NILP (tail2))
	{
465 466
	  register Lisp_Object this;
	  this = Fcdr (Fcdr (tail2));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
467 468
	  if (EQ (sym, Fcar (this)))
	    {
469
	      if (BUFFERP (object))
470
		{
471 472
		  modify_region (XBUFFER (object),
				 make_number (i->position),
473
				 make_number (i->position + LENGTH (i)));
474 475
		  record_property_change (i->position, LENGTH (i),
					  sym, Fcar (Fcdr (this)), object);
476
		  signal_after_change (i->position, LENGTH (i), LENGTH (i));
477 478
		}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
479 480 481 482 483 484 485 486 487 488 489 490
	      Fsetcdr (Fcdr (tail2), Fcdr (Fcdr (this)));
	      changed++;
	    }
	  tail2 = this;
	}
    }

  if (changed)
    i->plist = current_plist;
  return changed;
}

491
#if 0
Joseph Arceneaux's avatar
Joseph Arceneaux committed
492 493 494 495 496 497 498 499 500 501 502 503 504
/* Remove all properties from interval I.  Return non-zero
   if this changes the interval. */

static INLINE int
erase_properties (i)
     INTERVAL i;
{
  if (NILP (i->plist))
    return 0;

  i->plist = Qnil;
  return 1;
}
505
#endif
Joseph Arceneaux's avatar
Joseph Arceneaux committed
506 507 508 509 510

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\
511 512
defaults to the current buffer.\n\
If POSITION is at the end of OBJECT, the value is nil.")
513 514
  (position, object)
     Lisp_Object position, object;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
515 516 517 518
{
  register INTERVAL i;

  if (NILP (object))
519
    XSETBUFFER (object, current_buffer);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
520

521
  i = validate_interval_range (object, &position, &position, soft);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
522 523
  if (NULL_INTERVAL_P (i))
    return Qnil;
524
  /* If POSITION is at the end of the interval,
525 526 527
     it means it's the end of OBJECT.
     There are no properties at the very end,
     since no character follows.  */
528
  if (XINT (position) == LENGTH (i) + i->position)
529
    return Qnil;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
530 531 532 533

  return i->plist;
}

534
DEFUN ("get-text-property", Fget_text_property, Sget_text_property, 2, 3, 0,
535
  "Return the value of POSITION's property PROP, in OBJECT.\n\
536 537
OBJECT is optional and defaults to the current buffer.\n\
If POSITION is at the end of OBJECT, the value is nil.")
538 539
  (position, prop, object)
     Lisp_Object position, object;
540
     Lisp_Object prop;
541
{
542
  return textget (Ftext_properties_at (position, object), prop);
543 544
}

545
DEFUN ("get-char-property", Fget_char_property, Sget_char_property, 2, 3, 0,
546
  "Return the value of POSITION's property PROP, in OBJECT.\n\
547
OBJECT is optional and defaults to the current buffer.\n\
548
If POSITION is at the end of OBJECT, the value is nil.\n\
549
If OBJECT is a buffer, then overlay properties are considered as well as\n\
550 551
text properties.\n\
If OBJECT is a window, then that window's buffer is used, but window-specific\n\
552
overlays are considered only if they are associated with OBJECT.")
553 554
  (position, prop, object)
     Lisp_Object position, object;
555 556 557 558
     register Lisp_Object prop;
{
  struct window *w = 0;

559
  CHECK_NUMBER_COERCE_MARKER (position, 0);
560 561

  if (NILP (object))
562
    XSETBUFFER (object, current_buffer);
563 564 565 566

  if (WINDOWP (object))
    {
      w = XWINDOW (object);
567
      object = w->buffer;
568 569 570
    }
  if (BUFFERP (object))
    {
571
      int posn = XINT (position);
572 573 574 575
      int noverlays;
      Lisp_Object *overlay_vec, tem;
      int next_overlay;
      int len;
576 577 578
      struct buffer *obuf = current_buffer;

      set_buffer_temp (XBUFFER (object));
579 580 581 582 583

      /* First try with room for 40 overlays.  */
      len = 40;
      overlay_vec = (Lisp_Object *) alloca (len * sizeof (Lisp_Object));

584 585
      noverlays = overlays_at (posn, 0, &overlay_vec, &len,
			       &next_overlay, NULL);
586 587 588 589 590 591 592

      /* 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));
593 594
	  noverlays = overlays_at (posn, 0, &overlay_vec, &len,
				   &next_overlay, NULL);
595 596 597
	}
      noverlays = sort_overlays (overlay_vec, noverlays, w);

598 599
      set_buffer_temp (obuf);

600 601 602 603 604 605 606 607 608 609
      /* 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.  */
610
  return (Fget_text_property (position, prop, object));
611 612
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
613
DEFUN ("next-property-change", Fnext_property_change,
614
       Snext_property_change, 1, 3, 0,
615
  "Return the position of next property change.\n\
616
Scans characters forward from POSITION in OBJECT till it finds\n\
617 618 619
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\
620
If the value is non-nil, it is a position greater than POSITION, never equal.\n\n\
621 622
If the optional third argument LIMIT is non-nil, don't search\n\
past position LIMIT; return LIMIT if nothing is found before LIMIT.")
623 624
  (position, object, limit)
     Lisp_Object position, object, limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
625 626 627
{
  register INTERVAL i, next;

628
  if (NILP (object))
629
    XSETBUFFER (object, current_buffer);
630

631
  if (! NILP (limit) && ! EQ (limit, Qt))
632 633
    CHECK_NUMBER_COERCE_MARKER (limit, 0);

634
  i = validate_interval_range (object, &position, &position, soft);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
635

636 637 638 639
  /* If LIMIT is t, return start of next interval--don't
     bother checking further intervals.  */
  if (EQ (limit, Qt))
    {
640 641 642 643 644
      if (NULL_INTERVAL_P (i))
	next = i;
      else
	next = next_interval (i);
	
645
      if (NULL_INTERVAL_P (next))
646 647 648
	XSETFASTINT (position, (STRINGP (object)
				? XSTRING (object)->size
				: BUF_ZV (XBUFFER (object))));
649
      else
650 651
	XSETFASTINT (position, next->position - (STRINGP (object)));
      return position;
652 653
    }

654 655 656 657 658
  if (NULL_INTERVAL_P (i))
    return limit;

  next = next_interval (i);

659 660
  while (! NULL_INTERVAL_P (next) && intervals_equal (i, next)
	 && (NILP (limit) || next->position < XFASTINT (limit)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
661 662 663
    next = next_interval (next);

  if (NULL_INTERVAL_P (next))
664 665 666
    return limit;
  if (! NILP (limit) && !(next->position < XFASTINT (limit)))
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
667

668 669
  XSETFASTINT (position, next->position - (STRINGP (object)));
  return position;
670 671 672 673 674 675 676 677 678 679 680
}

/* 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;

681
  XSETBUFFER (object, current_buffer);
682
  XSETFASTINT (pos, beg);
683 684 685 686 687 688 689 690 691

  i = validate_interval_range (object, &pos, &pos, soft);
  if (NULL_INTERVAL_P (i))
    return 0;

  next = next_interval (i);
  while (! NULL_INTERVAL_P (next) && intervals_equal (i, next))
    {
      next = next_interval (next);
692 693
      if (NULL_INTERVAL_P (next))
	return 0;
694 695 696 697 698 699 700 701
      if (next->position >= end)
	return 0;
    }

  if (NULL_INTERVAL_P (next))
    return 0;

  return 1;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
702 703
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
704
DEFUN ("next-single-property-change", Fnext_single_property_change,
705
       Snext_single_property_change, 2, 4, 0,
706
  "Return the position of next property change for a specific property.\n\
707
Scans characters forward from POSITION till it finds\n\
708 709
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\
710
The property values are compared with `eq'.\n\
711
Return nil if the property is constant all the way to the end of OBJECT.\n\
712
If the value is non-nil, it is a position greater than POSITION, never equal.\n\n\
713
If the optional fourth argument LIMIT is non-nil, don't search\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
714
past position LIMIT; return LIMIT if nothing is found before LIMIT.")
715 716
  (position, prop, object, limit)
     Lisp_Object position, prop, object, limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
717 718 719 720
{
  register INTERVAL i, next;
  register Lisp_Object here_val;

721
  if (NILP (object))
722
    XSETBUFFER (object, current_buffer);
723

724 725 726
  if (!NILP (limit))
    CHECK_NUMBER_COERCE_MARKER (limit, 0);

727
  i = validate_interval_range (object, &position, &position, soft);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
728
  if (NULL_INTERVAL_P (i))
729
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
730

731
  here_val = textget (i->plist, prop);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
732
  next = next_interval (i);
733
  while (! NULL_INTERVAL_P (next) 
734 735
	 && EQ (here_val, textget (next->plist, prop))
	 && (NILP (limit) || next->position < XFASTINT (limit)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
736 737 738
    next = next_interval (next);

  if (NULL_INTERVAL_P (next))
739 740 741
    return limit;
  if (! NILP (limit) && !(next->position < XFASTINT (limit)))
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
742

743 744
  XSETFASTINT (position, next->position - (STRINGP (object)));
  return position;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
745 746
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
747
DEFUN ("previous-property-change", Fprevious_property_change,
748
       Sprevious_property_change, 1, 3, 0,
749
  "Return the position of previous property change.\n\
750
Scans characters backwards from POSITION in OBJECT till it finds\n\
751 752 753
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\
754
If the value is non-nil, it is a position less than POSITION, never equal.\n\n\
755
If the optional third argument LIMIT is non-nil, don't search\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
756
back past position LIMIT; return LIMIT if nothing is found until LIMIT.")
757 758
  (position, object, limit)
     Lisp_Object position, object, limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
759 760 761
{
  register INTERVAL i, previous;

762
  if (NILP (object))
763
    XSETBUFFER (object, current_buffer);
764

765 766 767
  if (!NILP (limit))
    CHECK_NUMBER_COERCE_MARKER (limit, 0);

768
  i = validate_interval_range (object, &position, &position, soft);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
769
  if (NULL_INTERVAL_P (i))
770
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
771

772
  /* Start with the interval containing the char before point.  */
773
  if (i->position == XFASTINT (position))
774 775
    i = previous_interval (i);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
776
  previous = previous_interval (i);
777 778 779
  while (! NULL_INTERVAL_P (previous) && intervals_equal (previous, i)
	 && (NILP (limit)
	     || previous->position + LENGTH (previous) > XFASTINT (limit)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
780 781
    previous = previous_interval (previous);
  if (NULL_INTERVAL_P (previous))
782 783 784 785
    return limit;
  if (!NILP (limit)
      && !(previous->position + LENGTH (previous) > XFASTINT (limit)))
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
786

787
  XSETFASTINT (position, (previous->position + LENGTH (previous)
788
		     - (STRINGP (object))));
789
  return position;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
790 791
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
792
DEFUN ("previous-single-property-change", Fprevious_single_property_change,
793
       Sprevious_single_property_change, 2, 4, 0,
794
  "Return the position of previous property change for a specific property.\n\
795
Scans characters backward from POSITION till it finds\n\
796 797
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\
798
The property values are compared with `eq'.\n\
799
Return nil if the property is constant all the way to the start of OBJECT.\n\
800
If the value is non-nil, it is a position less than POSITION, never equal.\n\n\
801
If the optional fourth argument LIMIT is non-nil, don't search\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
802
back past position LIMIT; return LIMIT if nothing is found until LIMIT.")
803 804
     (position, prop, object, limit)
     Lisp_Object position, prop, object, limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
805 806 807 808
{
  register INTERVAL i, previous;
  register Lisp_Object here_val;

809
  if (NILP (object))
810
    XSETBUFFER (object, current_buffer);
811

812 813 814
  if (!NILP (limit))
    CHECK_NUMBER_COERCE_MARKER (limit, 0);

815
  i = validate_interval_range (object, &position, &position, soft);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
816

817
  /* Start with the interval containing the char before point.  */
818
  if (! NULL_INTERVAL_P (i) && i->position == XFASTINT (position))
819 820
    i = previous_interval (i);

821 822 823
  if (NULL_INTERVAL_P (i))
    return limit;

824
  here_val = textget (i->plist, prop);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
825 826
  previous = previous_interval (i);
  while (! NULL_INTERVAL_P (previous)
827 828 829
	 && EQ (here_val, textget (previous->plist, prop))
	 && (NILP (limit)
	     || previous->position + LENGTH (previous) > XFASTINT (limit)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
830 831
    previous = previous_interval (previous);
  if (NULL_INTERVAL_P (previous))
832 833 834 835
    return limit;
  if (!NILP (limit)
      && !(previous->position + LENGTH (previous) > XFASTINT (limit)))
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
836

837
  XSETFASTINT (position, (previous->position + LENGTH (previous)
838
		     - (STRINGP (object))));
839
  return position;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
840 841
}

842 843
/* Callers note, this can GC when OBJECT is a buffer (or nil).  */

Joseph Arceneaux's avatar
Joseph Arceneaux committed
844
DEFUN ("add-text-properties", Fadd_text_properties,
845 846
       Sadd_text_properties, 3, 4, 0,
  "Add properties to the text from START to END.\n\
847
The third argument PROPERTIES is a property list\n\
848 849 850 851 852 853
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;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
854 855
{
  register INTERVAL i, unchanged;
856
  register int s, len, modified = 0;
857
  struct gcpro gcpro1;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
858 859 860 861 862

  properties = validate_plist (properties);
  if (NILP (properties))
    return Qnil;

863
  if (NILP (object))
864
    XSETBUFFER (object, current_buffer);
865

Joseph Arceneaux's avatar
Joseph Arceneaux committed
866 867 868 869 870 871 872
  i = validate_interval_range (object, &start, &end, hard);
  if (NULL_INTERVAL_P (i))
    return Qnil;

  s = XINT (start);
  len = XINT (end) - s;

873 874 875 876
  /* No need to protect OBJECT, because we GC only if it's a buffer,
     and live buffers are always protected.  */
  GCPRO1 (properties);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
877 878 879 880 881 882 883 884 885 886 887 888
  /* If we're not starting on an interval boundary, we have to
    split this interval. */
  if (i->position != s)
    {
      /* If this interval already has the properties, we can
         skip it. */
      if (interval_has_all_properties (properties, i))
	{
	  int got = (LENGTH (i) - (s - i->position));
	  if (got >= len)
	    return Qnil;
	  len -= got;
889
	  i = next_interval (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
890 891 892 893
	}
      else
	{
	  unchanged = i;
894
	  i = split_interval_right (unchanged, s - unchanged->position);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
895 896 897 898
	  copy_properties (unchanged, i);
	}
    }

899
  /* We are at the beginning of interval I, with LEN chars to scan.  */
900
  for (;;)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
901
    {
902 903 904
      if (i == 0)
	abort ();

Joseph Arceneaux's avatar
Joseph Arceneaux committed
905 906
      if (LENGTH (i) >= len)
	{
907 908 909 910 911
	  /* 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;

Joseph Arceneaux's avatar
Joseph Arceneaux committed
912 913 914 915 916
	  if (interval_has_all_properties (properties, i))
	    return modified ? Qt : Qnil;

	  if (LENGTH (i) == len)
	    {
917
	      add_properties (properties, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
918 919 920 921 922
	      return Qt;
	    }

	  /* i doesn't have the properties, and goes past the change limit */
	  unchanged = i;
923
	  i = split_interval_left (unchanged, len);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
924
	  copy_properties (unchanged, i);
925
	  add_properties (properties, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
926 927 928 929
	  return Qt;
	}

      len -= LENGTH (i);
930
      modified += add_properties (properties, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
931 932 933 934
      i = next_interval (i);
    }
}

935 936
/* Callers note, this can GC when OBJECT is a buffer (or nil).  */

937 938 939
DEFUN ("put-text-property", Fput_text_property,
       Sput_text_property, 4, 5, 0,
  "Set one property of the text from START to END.\n\
940
The third and fourth arguments PROPERTY and VALUE\n\
941 942 943
specify the property to add.\n\
The optional fifth argument, OBJECT,\n\
is the string or buffer containing the text.")
944 945
  (start, end, property, value, object)
     Lisp_Object start, end, property, value, object;
946 947
{
  Fadd_text_properties (start, end,
948
			Fcons (property, Fcons (value, Qnil)),
949 950 951 952
			object);
  return Qnil;
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
953
DEFUN ("set-text-properties", Fset_text_properties,
954 955
       Sset_text_properties, 3, 4, 0,
  "Completely replace properties of text from START to END.\n\
956
The third argument PROPERTIES is the new property list.\n\
957 958
The optional fourth argument, OBJECT,\n\
is the string or buffer containing the text.")
959 960
  (start, end, properties, object)
     Lisp_Object start, end, properties, object;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
961 962
{
  register INTERVAL i, unchanged;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
963
  register INTERVAL prev_changed = NULL_INTERVAL;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
964
  register int s, len;
965 966 967 968
  Lisp_Object ostart, oend;

  ostart = start;
  oend = end;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
969

970
  properties = validate_plist (properties);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
971

972
  if (NILP (object))
973
    XSETBUFFER (object, current_buffer);
974

975 976
  /* If we want no properties for a whole string,
     get rid of its intervals.  */
977
  if (NILP (properties) && STRINGP (object)
978 979 980 981 982 983 984
      && XFASTINT (start) == 0
      && XFASTINT (end) == XSTRING (object)->size)
    {
      XSTRING (object)->intervals = 0;
      return Qt;
    }

Richard M. Stallman's avatar
Richard M. Stallman committed
985
  i = validate_interval_range (object, &start, &end, soft);
986

Joseph Arceneaux's avatar
Joseph Arceneaux committed
987
  if (NULL_INTERVAL_P (i))
Richard M. Stallman's avatar
Richard M. Stallman committed
988
    {
989 990
      /* If buffer has no properties, and we want none, return now.  */
      if (NILP (properties))
Richard M. Stallman's avatar
Richard M. Stallman committed
991 992
	return Qnil;

993 994 995 996 997
      /* Restore the original START and END values
	 because validate_interval_range increments them for strings.  */
      start = ostart;
      end = oend;

Richard M. Stallman's avatar
Richard M. Stallman committed
998 999 1000 1001 1002
      i = validate_interval_range (object, &start, &end, hard);
      /* This can return if start == end.  */
      if (NULL_INTERVAL_P (i))
	return Qnil;
    }
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1003 1004 1005 1006 1007 1008 1009

  s = XINT (start);
  len = XINT (end) - s;

  if (i->position != s)
    {
      unchanged = i;
1010
      i = split_interval_right (unchanged, s - unchanged->position);
1011

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1012 1013
      if (LENGTH (i) > len)
	{
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1014
	  copy_properties (unchanged, i);
1015
	  i = split_interval_left (i, len);
1016
	  set_properties (properties, i, object);