textprop.c 51.6 KB
Newer Older
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1
/* Interface code for dealing with text properties.
2
   Copyright (C) 1993, 1994, 1995, 1997 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
47
  is enforced by the subrs installing properties onto the intervals.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
48

49 50
/* The rest of the file is within this conditional */
#ifdef USE_TEXT_PROPERTIES
Joseph Arceneaux's avatar
Joseph Arceneaux committed
51

52
/* Types of hooks.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
53 54 55 56
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
/* Visual properties text (including strings) may have.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
61
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
  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
119
     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
      /* If there's no text, there are no properties.  */
141 142 143 144
      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
}

/* Validate LIST as a property list.  If LIST is not a list, then
   make one consisting of (LIST nil).  Otherwise, verify that LIST
174
   is even numbered and thus suitable as a plist.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
175 176 177

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
      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,
201
   with the same values, of list PLIST.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
202 203 204 205 206 207 208 209 210

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

211
  /* Go through each element of PLIST.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
212 213 214 215 216 217 218 219 220 221
  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
222
	       values are unequal, return zero.  */
223
	    if (! EQ (Fcar (Fcdr (tail1)), Fcar (Fcdr (tail2))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
224 225
	      return 0;

226
	    /* Property has same value on both lists;  go to next one.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
227 228 229 230 231 232 233 234 235 236 237 238
	    found = 1;
	    break;
	  }

      if (! found)
	return 0;
    }

  return 1;
}

/* Return nonzero if the plist of interval I has any of the
239
   properties of PLIST, regardless of their values.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
240 241 242 243 244 245 246 247

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

248
  /* Go through each element of PLIST.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
249 250 251 252 253 254 255 256 257 258 259 260
  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
	  {
	    record_property_change (interval->position, LENGTH (interval),
				    XCONS (sym)->car, XCONS (value)->car,
				    object);
	  }
306 307 308 309 310 311 312

      /* 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))
313 314 315 316 317
	  {
	    record_property_change (interval->position, LENGTH (interval),
				    XCONS (sym)->car, Qnil,
				    object);
	  }
318 319 320 321 322
    }

  /* Store new properties.  */
  interval->plist = Fcopy_sequence (properties);
}
Joseph Arceneaux's avatar
Joseph Arceneaux committed
323 324 325 326 327

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

328 329
   OBJECT should be the string or buffer the interval is in.

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

333 334
static int
add_properties (plist, i, object)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
335 336
     Lisp_Object plist;
     INTERVAL i;
337
     Lisp_Object object;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
338
{
339
  Lisp_Object tail1, tail2, sym1, val1;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
340 341
  register int changed = 0;
  register int found;
342 343 344 345 346 347 348 349 350
  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
351

352
  /* Go through each element of PLIST.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
353 354 355 356 357 358 359 360 361 362
  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)))
	  {
363 364
	    /* No need to gcpro, because tail2 protects this
	       and it must be a cons cell (we get an error otherwise).  */
365
	    register Lisp_Object this_cdr;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
366

367
	    this_cdr = Fcdr (tail2);
368
	    /* Found the property.  Now check its value.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
369 370 371
	    found = 1;

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

376
	    /* Record this change in the buffer, for undo purposes.  */
377
	    if (BUFFERP (object))
378
	      {
379 380
		record_property_change (i->position, LENGTH (i),
					sym1, Fcar (this_cdr), object);
381 382
	      }

Joseph Arceneaux's avatar
Joseph Arceneaux committed
383 384 385 386 387 388 389 390
	    /* I's property has a different value -- change it */
	    Fsetcar (this_cdr, val1);
	    changed++;
	    break;
	  }

      if (! found)
	{
391
	  /* Record this change in the buffer, for undo purposes.  */
392
	  if (BUFFERP (object))
393
	    {
394 395
	      record_property_change (i->position, LENGTH (i),
				      sym1, Qnil, object);
396
	    }
Joseph Arceneaux's avatar
Joseph Arceneaux committed
397 398 399 400 401
	  i->plist = Fcons (sym1, Fcons (val1, i->plist));
	  changed++;
	}
    }

402 403
  UNGCPRO;

Joseph Arceneaux's avatar
Joseph Arceneaux committed
404 405 406 407
  return changed;
}

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

411 412
static int
remove_properties (plist, i, object)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
413 414
     Lisp_Object plist;
     INTERVAL i;
415
     Lisp_Object object;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
416
{
417
  register Lisp_Object tail1, tail2, sym, current_plist;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
418 419
  register int changed = 0;

420
  current_plist = i->plist;
421
  /* Go through each element of plist.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
422 423 424 425 426 427 428
  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)))
	{
429
	  if (BUFFERP (object))
430
	    {
431 432 433
	      record_property_change (i->position, LENGTH (i),
				      sym, Fcar (Fcdr (current_plist)),
				      object);
434 435
	    }

Joseph Arceneaux's avatar
Joseph Arceneaux committed
436 437 438 439 440 441 442 443
	  current_plist = Fcdr (Fcdr (current_plist));
	  changed++;
	}

      /* Go through i's plist, looking for sym */
      tail2 = current_plist;
      while (! NILP (tail2))
	{
444 445
	  register Lisp_Object this;
	  this = Fcdr (Fcdr (tail2));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
446 447
	  if (EQ (sym, Fcar (this)))
	    {
448
	      if (BUFFERP (object))
449
		{
450 451
		  record_property_change (i->position, LENGTH (i),
					  sym, Fcar (Fcdr (this)), object);
452 453
		}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
454 455 456 457 458 459 460 461 462 463 464 465
	      Fsetcdr (Fcdr (tail2), Fcdr (Fcdr (this)));
	      changed++;
	    }
	  tail2 = this;
	}
    }

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

466
#if 0
Joseph Arceneaux's avatar
Joseph Arceneaux committed
467
/* Remove all properties from interval I.  Return non-zero
468
   if this changes the interval.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
469 470 471 472 473 474 475 476 477 478 479

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

  i->plist = Qnil;
  return 1;
}
480
#endif
Joseph Arceneaux's avatar
Joseph Arceneaux committed
481

482 483 484 485 486 487 488 489 490 491 492 493 494
/* 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);
Karl Heuer's avatar
Karl Heuer committed
495 496
  else if (EQ (object, Qt))
    return NULL_INTERVAL;
497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518

  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))
519
    args_out_of_range (make_number (position), make_number (position));
520 521 522 523 524 525
  if (beg == end || NULL_INTERVAL_P (i))
    return NULL_INTERVAL;
    
  return find_interval (i, position);
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
526 527
DEFUN ("text-properties-at", Ftext_properties_at,
       Stext_properties_at, 1, 2, 0,
528 529 530
  "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\
531
If POSITION is at the end of OBJECT, the value is nil.")
532 533
  (position, object)
     Lisp_Object position, object;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
534 535 536 537
{
  register INTERVAL i;

  if (NILP (object))
538
    XSETBUFFER (object, current_buffer);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
539

540
  i = validate_interval_range (object, &position, &position, soft);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
541 542
  if (NULL_INTERVAL_P (i))
    return Qnil;
543
  /* If POSITION is at the end of the interval,
544 545 546
     it means it's the end of OBJECT.
     There are no properties at the very end,
     since no character follows.  */
547
  if (XINT (position) == LENGTH (i) + i->position)
548
    return Qnil;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
549 550 551 552

  return i->plist;
}

553
DEFUN ("get-text-property", Fget_text_property, Sget_text_property, 2, 3, 0,
554
  "Return the value of POSITION's property PROP, in OBJECT.\n\
555 556
OBJECT is optional and defaults to the current buffer.\n\
If POSITION is at the end of OBJECT, the value is nil.")
557 558
  (position, prop, object)
     Lisp_Object position, object;
559
     Lisp_Object prop;
560
{
561
  return textget (Ftext_properties_at (position, object), prop);
562 563
}

564
DEFUN ("get-char-property", Fget_char_property, Sget_char_property, 2, 3, 0,
565
  "Return the value of POSITION's property PROP, in OBJECT.\n\
566
OBJECT is optional and defaults to the current buffer.\n\
567
If POSITION is at the end of OBJECT, the value is nil.\n\
568
If OBJECT is a buffer, then overlay properties are considered as well as\n\
569 570
text properties.\n\
If OBJECT is a window, then that window's buffer is used, but window-specific\n\
571
overlays are considered only if they are associated with OBJECT.")
572 573
  (position, prop, object)
     Lisp_Object position, object;
574 575 576 577
     register Lisp_Object prop;
{
  struct window *w = 0;

578
  CHECK_NUMBER_COERCE_MARKER (position, 0);
579 580

  if (NILP (object))
581
    XSETBUFFER (object, current_buffer);
582 583 584 585

  if (WINDOWP (object))
    {
      w = XWINDOW (object);
586
      object = w->buffer;
587 588 589
    }
  if (BUFFERP (object))
    {
590
      int posn = XINT (position);
591 592 593 594
      int noverlays;
      Lisp_Object *overlay_vec, tem;
      int next_overlay;
      int len;
595 596 597
      struct buffer *obuf = current_buffer;

      set_buffer_temp (XBUFFER (object));
598 599 600 601 602

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

603 604
      noverlays = overlays_at (posn, 0, &overlay_vec, &len,
			       &next_overlay, NULL);
605 606 607 608 609 610 611

      /* 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));
612 613
	  noverlays = overlays_at (posn, 0, &overlay_vec, &len,
				   &next_overlay, NULL);
614 615 616
	}
      noverlays = sort_overlays (overlay_vec, noverlays, w);

617 618
      set_buffer_temp (obuf);

619 620 621 622 623 624 625 626 627 628
      /* 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.  */
629
  return (Fget_text_property (position, prop, object));
630
}
631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670

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;
671

672 673 674 675 676 677 678 679 680 681
  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);
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
682
DEFUN ("next-property-change", Fnext_property_change,
683
       Snext_property_change, 1, 3, 0,
684
  "Return the position of next property change.\n\
685
Scans characters forward from POSITION in OBJECT till it finds\n\
686 687 688
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\
689
If the value is non-nil, it is a position greater than POSITION, never equal.\n\n\
690 691
If the optional third argument LIMIT is non-nil, don't search\n\
past position LIMIT; return LIMIT if nothing is found before LIMIT.")
692 693
  (position, object, limit)
     Lisp_Object position, object, limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
694 695 696
{
  register INTERVAL i, next;

697
  if (NILP (object))
698
    XSETBUFFER (object, current_buffer);
699

700
  if (! NILP (limit) && ! EQ (limit, Qt))
701 702
    CHECK_NUMBER_COERCE_MARKER (limit, 0);

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

705 706 707 708
  /* If LIMIT is t, return start of next interval--don't
     bother checking further intervals.  */
  if (EQ (limit, Qt))
    {
709 710 711 712 713
      if (NULL_INTERVAL_P (i))
	next = i;
      else
	next = next_interval (i);
	
714
      if (NULL_INTERVAL_P (next))
715 716 717
	XSETFASTINT (position, (STRINGP (object)
				? XSTRING (object)->size
				: BUF_ZV (XBUFFER (object))));
718
      else
719 720
	XSETFASTINT (position, next->position - (STRINGP (object)));
      return position;
721 722
    }

723 724 725 726 727
  if (NULL_INTERVAL_P (i))
    return limit;

  next = next_interval (i);

728
  while (! NULL_INTERVAL_P (next) && intervals_equal (i, next)
729 730
	 && (NILP (limit)
	     || next->position - (STRINGP (object)) < XFASTINT (limit)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
731 732 733
    next = next_interval (next);

  if (NULL_INTERVAL_P (next))
734
    return limit;
735 736
  if (! NILP (limit)
      && !(next->position - (STRINGP (object)) < XFASTINT (limit)))
737
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
738

739 740
  XSETFASTINT (position, next->position - (STRINGP (object)));
  return position;
741 742 743 744 745 746 747 748 749 750 751
}

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

752
  XSETBUFFER (object, current_buffer);
753
  XSETFASTINT (pos, beg);
754 755 756 757 758 759 760 761 762

  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);
763 764
      if (NULL_INTERVAL_P (next))
	return 0;
765
      if (next->position - (STRINGP (object)) >= end)
766 767 768 769 770 771 772
	return 0;
    }

  if (NULL_INTERVAL_P (next))
    return 0;

  return 1;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
773 774
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
775
DEFUN ("next-single-property-change", Fnext_single_property_change,
776
       Snext_single_property_change, 2, 4, 0,
777
  "Return the position of next property change for a specific property.\n\
778
Scans characters forward from POSITION till it finds\n\
779 780
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\
781
The property values are compared with `eq'.\n\
782
Return nil if the property is constant all the way to the end of OBJECT.\n\
783
If the value is non-nil, it is a position greater than POSITION, never equal.\n\n\
784
If the optional fourth argument LIMIT is non-nil, don't search\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
785
past position LIMIT; return LIMIT if nothing is found before LIMIT.")
786 787
  (position, prop, object, limit)
     Lisp_Object position, prop, object, limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
788 789 790 791
{
  register INTERVAL i, next;
  register Lisp_Object here_val;

792
  if (NILP (object))
793
    XSETBUFFER (object, current_buffer);
794

795 796 797
  if (!NILP (limit))
    CHECK_NUMBER_COERCE_MARKER (limit, 0);

798
  i = validate_interval_range (object, &position, &position, soft);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
799
  if (NULL_INTERVAL_P (i))
800
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
801

802
  here_val = textget (i->plist, prop);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
803
  next = next_interval (i);
804
  while (! NULL_INTERVAL_P (next) 
805
	 && EQ (here_val, textget (next->plist, prop))
806
	 && (NILP (limit) || next->position - (STRINGP (object)) < XFASTINT (limit)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
807 808 809
    next = next_interval (next);

  if (NULL_INTERVAL_P (next))
810
    return limit;
811 812
  if (! NILP (limit)
      && !(next->position - (STRINGP (object)) < XFASTINT (limit)))
813
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
814

815 816
  XSETFASTINT (position, next->position - (STRINGP (object)));
  return position;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
817 818
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
819
DEFUN ("previous-property-change", Fprevious_property_change,
820
       Sprevious_property_change, 1, 3, 0,
821
  "Return the position of previous property change.\n\
822
Scans characters backwards from POSITION in OBJECT till it finds\n\
823 824 825
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\
826
If the value is non-nil, it is a position less than POSITION, never equal.\n\n\
827
If the optional third argument LIMIT is non-nil, don't search\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
828
back past position LIMIT; return LIMIT if nothing is found until LIMIT.")
829 830
  (position, object, limit)
     Lisp_Object position, object, limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
831 832 833
{
  register INTERVAL i, previous;

834
  if (NILP (object))
835
    XSETBUFFER (object, current_buffer);
836

837 838 839
  if (!NILP (limit))
    CHECK_NUMBER_COERCE_MARKER (limit, 0);

840
  i = validate_interval_range (object, &position, &position, soft);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
841
  if (NULL_INTERVAL_P (i))
842
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
843

844
  /* Start with the interval containing the char before point.  */
845
  if (i->position == XFASTINT (position))
846 847
    i = previous_interval (i);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
848
  previous = previous_interval (i);
849 850
  while (! NULL_INTERVAL_P (previous) && intervals_equal (previous, i)
	 && (NILP (limit)
851 852
	     || (previous->position + LENGTH (previous) - (STRINGP (object))
		 > XFASTINT (limit))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
853 854
    previous = previous_interval (previous);
  if (NULL_INTERVAL_P (previous))
855 856
    return limit;
  if (!NILP (limit)
857 858
      && !(previous->position + LENGTH (previous) - (STRINGP (object))
	   > XFASTINT (limit)))
859
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
860

861
  XSETFASTINT (position, (previous->position + LENGTH (previous)
862
			  - (STRINGP (object))));
863
  return position;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
864 865
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
866
DEFUN ("previous-single-property-change", Fprevious_single_property_change,
867
       Sprevious_single_property_change, 2, 4, 0,
868
  "Return the position of previous property change for a specific property.\n\
869
Scans characters backward from POSITION till it finds\n\
870 871
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\
872
The property values are compared with `eq'.\n\
873
Return nil if the property is constant all the way to the start of OBJECT.\n\
874
If the value is non-nil, it is a position less than POSITION, never equal.\n\n\
875
If the optional fourth argument LIMIT is non-nil, don't search\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
876
back past position LIMIT; return LIMIT if nothing is found until LIMIT.")
877 878
     (position, prop, object, limit)
     Lisp_Object position, prop, object, limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
879 880 881 882
{
  register INTERVAL i, previous;
  register Lisp_Object here_val;

883
  if (NILP (object))
884
    XSETBUFFER (object, current_buffer);
885

886 887 888
  if (!NILP (limit))
    CHECK_NUMBER_COERCE_MARKER (limit, 0);

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

891
  /* Start with the interval containing the char before point.  */
892
  if (! NULL_INTERVAL_P (i) && i->position == XFASTINT (position))
893 894
    i = previous_interval (i);

895 896 897
  if (NULL_INTERVAL_P (i))
    return limit;

898
  here_val = textget (i->plist, prop);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
899 900
  previous = previous_interval (i);
  while (! NULL_INTERVAL_P (previous)
901 902
	 && EQ (here_val, textget (previous->plist, prop))
	 && (NILP (limit)
903 904
	     || (previous->position + LENGTH (previous) - (STRINGP (object))
		 > XFASTINT (limit))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
905 906
    previous = previous_interval (previous);
  if (NULL_INTERVAL_P (previous))
907 908
    return limit;
  if (!NILP (limit)
909 910
      && !(previous->position + LENGTH (previous) - (STRINGP (object))
	   > XFASTINT (limit)))
911
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
912

913
  XSETFASTINT (position, (previous->position + LENGTH (previous)
914
			  - (STRINGP (object))));
915
  return position;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
916
}
917

918 919
/* Callers note, this can GC when OBJECT is a buffer (or nil).  */

Joseph Arceneaux's avatar
Joseph Arceneaux committed
920
DEFUN ("add-text-properties", Fadd_text_properties,
921 922
       Sadd_text_properties, 3, 4, 0,
  "Add properties to the text from START to END.\n\
923
The third argument PROPERTIES is a property list\n\
924 925 926 927 928 929
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
930 931
{
  register INTERVAL i, unchanged;
932
  register int s, len, modified = 0;
933
  struct gcpro gcpro1;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
934 935 936 937 938

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

939
  if (NILP (object))
940
    XSETBUFFER (object, current_buffer);
941

Joseph Arceneaux's avatar
Joseph Arceneaux committed
942 943 944 945 946 947 948
  i = validate_interval_range (object, &start, &end, hard);
  if (NULL_INTERVAL_P (i))
    return Qnil;

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

949 950 951 952
  /* 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
953
  /* If we're not starting on an interval boundary, we have to
954
    split this interval.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
955 956 957
  if (i->position != s)
    {
      /* If this interval already has the properties, we can
958
         skip it.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
959 960 961 962
      if (interval_has_all_properties (properties, i))
	{
	  int got = (LENGTH (i) - (s - i->position));
	  if (got >= len)
963
	    RETURN_UNGCPRO (Qnil);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
964
	  len -= got;
965
	  i = next_interval (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
966 967 968 969
	}
      else
	{
	  unchanged = i;
970
	  i = split_interval_right (unchanged, s - unchanged->position);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
971 972 973 974
	  copy_properties (unchanged, i);
	}
    }

975 976
  if (BUFFERP (object))
    modify_region (XBUFFER (object), XINT (start), XINT (end));
977

978
  /* We are at the beginning of interval I, with LEN chars to scan.  */
979
  for (;;)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
980
    {
981 982 983
      if (i == 0)
	abort ();

Joseph Arceneaux's avatar
Joseph Arceneaux committed
984 985
      if (LENGTH (i) >= len)
	{
986 987 988 989 990
	  /* 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
991
	  if (interval_has_all_properties (properties, i))
992
	    {
993 994 995
	      if (BUFFERP (object))
		signal_after_change (XINT (start), XINT (end) - XINT (start),
				     XINT (end) - XINT (start));
996 997 998

	      return modified ? Qt : Qnil;
	    }
Joseph Arceneaux's avatar
Joseph Arceneaux committed
999 1000 1001

	  if (LENGTH (i) == len)
	    {
1002
	      add_properties (properties, i, object);
1003 1004 1005
	      if (BUFFERP (object))
		signal_after_change (XINT (start), XINT (end) - XINT (start),
				     XINT (end) - XINT (start));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1006 1007 1008 1009 1010
	      return Qt;
	    }

	  /* i doesn't have the properties, and goes past the change limit */
	  unchanged = i;
1011
	  i = split_interval_left (unchanged, len);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1012
	  copy_properties (unchanged, i);
1013
	  add_properties (properties, i, object);
1014 1015 1016
	  if (BUFFERP (object))
	    signal_after_change (XINT (start), XINT (end) - XINT (start),
				 XINT (end) - XINT (start));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1017 1018 1019 1020
	  return Qt;
	}

      len -= LENGTH (i);
1021
      modified += add_properties (properties, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1022 1023 1024 1025
      i = next_interval (i);
    }
}

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

1028 1029 1030
DEFUN ("put-text-property", Fput_text_property,
       Sput_text_property, 4, 5, 0,
  "Set one property of the text from START to END.\n\
1031
The third and fourth arguments PROPERTY and VALUE\n\
1032 1033 1034
specify the property to add.\n\
The optional fifth argument, OBJECT,\n\
is the string or buffer containing the text.")
1035 1036
  (start, end, property, value, object)
     Lisp_Object start, end, property, value, object;
1037 1038
{
  Fadd_text_properties (start, end,
1039
			Fcons (property, Fcons (value, Qnil)),
1040 1041 1042 1043
			object);
  return Qnil;
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1044
DEFUN ("set-text-properties", Fset_text_properties,
1045 1046
       Sset_text_properties, 3, 4, 0,
  "Completely replace properties of text from START to END.\n\
1047
The third argument PROPERTIES is the new property list.\n\
1048 1049
The optional fourth argument, OBJECT,\n\
is the string or buffer containing the text.")
1050 1051
  (start, end, properties, object)
     Lisp_Object start, end, properties, object;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1052 1053
{
  register INTERVAL i, unchanged;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1054
  register INTERVAL prev_changed = NULL_INTERVAL;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1055
  register int s, len;
1056
  Lisp_Object ostart, oend;
1057
  int have_modified = 0;
1058 1059 1060

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

1062
  properties = validate_plist (properties);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1063

1064
  if (NILP (object))
1065
    XSETBUFFER (object, current_buffer);
1066

1067 1068
  /* If we want no properties for a whole string,
     get rid of its intervals.  */
1069
  if (NILP (properties) && STRINGP (object)
1070 1071 1072
      && XFASTINT (start) == 0
      && XFASTINT (end) == XSTRING (object)->size)
    {
1073 1074 1075
      if (! XSTRING (object)->intervals)
	return Qt;

1076 1077 1078 1079
      XSTRING (object)->intervals = 0;
      return Qt;
    }

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

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1082
  if (NULL_INTERVAL_P (i))
Richard M. Stallman's avatar
Richard M. Stallman committed
1083
    {
1084 1085
      /* If buffer has no properties, and we want none, return now.  */
      if (NILP (properties))
Richard M. Stallman's avatar
Richard M. Stallman committed
1086 1087
	return Qnil;

1088 1089 1090 1091 1092
      /* 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
1093 1094 1095 1096 1097
      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
1098 1099 1100 1101

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

1102 1103
  if (BUFFERP (object))
    modify_region (XBUFFER (object), XINT (start), XINT (end));
1104

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1105 1106 1107
  if (i->position != s)
    {
      unchanged = i;
1108
      i = split_interval_right (unchanged, s - unchanged->position);
1109

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1110 1111
      if (LENGTH (i) > len)
	{
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1112
	  copy_properties (unchanged, i);
1113
	  i = split_interval_left (i, len);
1114
	  set_properties (properties, i, object);
1115