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
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
18 19
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
20

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

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

/* 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
35 36 37 38 39 40


/* 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
41 42
  set_properties needs to deal with the interval property cache.

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

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

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

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

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

72
Lisp_Object Vinhibit_point_motion_hooks;
73
Lisp_Object Vdefault_text_properties;
74

75 76 77 78
/* 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
79

Joseph Arceneaux's avatar
Joseph Arceneaux committed
80 81 82 83 84 85
/* 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
86

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

Joseph Arceneaux's avatar
Joseph Arceneaux committed
90 91 92 93 94 95 96 97 98
   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
99 100
   create an interval tree for OBJECT if one doesn't exist, provided
   the object actually contains text.  In the current design, if there
101
   is no text, there can be no text properties.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
102 103 104 105 106 107 108 109 110 111

#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;
112 113
  int searchpos;

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

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

131
  if (BUFFERP (object))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
132 133 134 135 136 137
    {
      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);
138
      i = BUF_INTERVALS (b);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
139

140 141 142 143 144
      /* 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
145 146 147 148 149
    }
  else
    {
      register struct Lisp_String *s = XSTRING (object);

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

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

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

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

/* 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)
178
     Lisp_Object list;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
179 180 181 182 183 184 185 186 187
{
  if (NILP (list))
    return Qnil;

  if (CONSP (list))
    {
      register int i;
      register Lisp_Object tail;
      for (i = 0, tail = list; !NILP (tail); i++)
188 189 190 191
	{
	  tail = Fcdr (tail);
	  QUIT;
	}
Joseph Arceneaux's avatar
Joseph Arceneaux committed
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 222
      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. */
223
	    if (! EQ (Fcar (Fcdr (tail1)), Fcar (Fcdr (tail2))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
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 260
	      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;
}
261

262 263 264 265
/* Changing the plists of individual intervals.  */

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

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

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

      /* 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))
318 319 320 321 322 323 324
	  {
	    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);
325 326
	    signal_after_change (interval->position, LENGTH (interval),
				 LENGTH (interval));
327
	  }
328 329 330 331 332
    }

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

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

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

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

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

  /* 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)))
	  {
373 374
	    /* No need to gcpro, because tail2 protects this
	       and it must be a cons cell (we get an error otherwise).  */
375
	    register Lisp_Object this_cdr;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
376

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

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

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

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

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

420 421
  UNGCPRO;

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

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

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

438
  current_plist = i->plist;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
439 440 441 442 443 444 445 446
  /* 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)))
	{
447
	  if (BUFFERP (object))
448
	    {
449 450
	      modify_region (XBUFFER (object),
			     make_number (i->position),
451
			     make_number (i->position + LENGTH (i)));
452 453 454
	      record_property_change (i->position, LENGTH (i),
				      sym, Fcar (Fcdr (current_plist)),
				      object);
455
	      signal_after_change (i->position, LENGTH (i), LENGTH (i));
456 457
	    }

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

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

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

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

492
#if 0
Joseph Arceneaux's avatar
Joseph Arceneaux committed
493 494 495 496 497 498 499 500 501 502 503 504 505
/* 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;
}
506
#endif
Joseph Arceneaux's avatar
Joseph Arceneaux committed
507 508 509 510 511

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\
512 513
defaults to the current buffer.\n\
If POSITION is at the end of OBJECT, the value is nil.")
514 515
  (position, object)
     Lisp_Object position, object;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
516 517 518 519
{
  register INTERVAL i;

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

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

  return i->plist;
}

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

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

560
  CHECK_NUMBER_COERCE_MARKER (position, 0);
561 562

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

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

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

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

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

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

599 600
      set_buffer_temp (obuf);

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

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

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

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

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

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

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

  next = next_interval (i);

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

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

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

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

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

  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);
693 694
      if (NULL_INTERVAL_P (next))
	return 0;
695 696 697 698 699 700 701 702
      if (next->position >= end)
	return 0;
    }

  if (NULL_INTERVAL_P (next))
    return 0;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

874 875 876 877
  /* 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
878 879 880 881 882 883 884 885 886 887 888 889
  /* 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;
890
	  i = next_interval (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
891 892 893 894
	}
      else
	{
	  unchanged = i;
895
	  i = split_interval_right (unchanged, s - unchanged->position);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
896 897 898 899
	  copy_properties (unchanged, i);
	}
    }

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

Joseph Arceneaux's avatar
Joseph Arceneaux committed
906 907
      if (LENGTH (i) >= len)
	{
908 909 910 911 912
	  /* 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
913 914 915 916 917
	  if (interval_has_all_properties (properties, i))
	    return modified ? Qt : Qnil;

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

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

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

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

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

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

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

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

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

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

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

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

994 995 996 997 998
      /* 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
999 1000 1001 1002 1003
      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
1004 1005 1006 1007 1008 1009 1010

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

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

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