textprop.c 48.7 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
	  {
	    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 353 354 355 356 357 358 359 360 361 362

  /* 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)))
	  {
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);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
368 369 370 371 372
	    /* Found the property.  Now check its value. */
	    found = 1;

	    /* The properties have the same value on both lists.
	       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;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
421 422 423 424 425 426 427 428
  /* 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)))
	{
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 468 469 470 471 472 473 474 475 476 477 478 479
/* 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;
}
480
#endif
Joseph Arceneaux's avatar
Joseph Arceneaux committed
481 482 483 484 485

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\
486 487
defaults to the current buffer.\n\
If POSITION is at the end of OBJECT, the value is nil.")
488 489
  (position, object)
     Lisp_Object position, object;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
490 491 492 493
{
  register INTERVAL i;

  if (NILP (object))
494
    XSETBUFFER (object, current_buffer);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
495

496
  i = validate_interval_range (object, &position, &position, soft);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
497 498
  if (NULL_INTERVAL_P (i))
    return Qnil;
499
  /* If POSITION is at the end of the interval,
500 501 502
     it means it's the end of OBJECT.
     There are no properties at the very end,
     since no character follows.  */
503
  if (XINT (position) == LENGTH (i) + i->position)
504
    return Qnil;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
505 506 507 508

  return i->plist;
}

509
DEFUN ("get-text-property", Fget_text_property, Sget_text_property, 2, 3, 0,
510
  "Return the value of POSITION's property PROP, in OBJECT.\n\
511 512
OBJECT is optional and defaults to the current buffer.\n\
If POSITION is at the end of OBJECT, the value is nil.")
513 514
  (position, prop, object)
     Lisp_Object position, object;
515
     Lisp_Object prop;
516
{
517
  return textget (Ftext_properties_at (position, object), prop);
518 519
}

520
DEFUN ("get-char-property", Fget_char_property, Sget_char_property, 2, 3, 0,
521
  "Return the value of POSITION's property PROP, in OBJECT.\n\
522
OBJECT is optional and defaults to the current buffer.\n\
523
If POSITION is at the end of OBJECT, the value is nil.\n\
524
If OBJECT is a buffer, then overlay properties are considered as well as\n\
525 526
text properties.\n\
If OBJECT is a window, then that window's buffer is used, but window-specific\n\
527
overlays are considered only if they are associated with OBJECT.")
528 529
  (position, prop, object)
     Lisp_Object position, object;
530 531 532 533
     register Lisp_Object prop;
{
  struct window *w = 0;

534
  CHECK_NUMBER_COERCE_MARKER (position, 0);
535 536

  if (NILP (object))
537
    XSETBUFFER (object, current_buffer);
538 539 540 541

  if (WINDOWP (object))
    {
      w = XWINDOW (object);
542
      object = w->buffer;
543 544 545
    }
  if (BUFFERP (object))
    {
546
      int posn = XINT (position);
547 548 549 550
      int noverlays;
      Lisp_Object *overlay_vec, tem;
      int next_overlay;
      int len;
551 552 553
      struct buffer *obuf = current_buffer;

      set_buffer_temp (XBUFFER (object));
554 555 556 557 558

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

559 560
      noverlays = overlays_at (posn, 0, &overlay_vec, &len,
			       &next_overlay, NULL);
561 562 563 564 565 566 567

      /* 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));
568 569
	  noverlays = overlays_at (posn, 0, &overlay_vec, &len,
				   &next_overlay, NULL);
570 571 572
	}
      noverlays = sort_overlays (overlay_vec, noverlays, w);

573 574
      set_buffer_temp (obuf);

575 576 577 578 579 580 581 582 583 584
      /* 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.  */
585
  return (Fget_text_property (position, prop, object));
586 587
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
588
DEFUN ("next-property-change", Fnext_property_change,
589
       Snext_property_change, 1, 3, 0,
590
  "Return the position of next property change.\n\
591
Scans characters forward from POSITION in OBJECT till it finds\n\
592 593 594
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\
595
If the value is non-nil, it is a position greater than POSITION, never equal.\n\n\
596 597
If the optional third argument LIMIT is non-nil, don't search\n\
past position LIMIT; return LIMIT if nothing is found before LIMIT.")
598 599
  (position, object, limit)
     Lisp_Object position, object, limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
600 601 602
{
  register INTERVAL i, next;

603
  if (NILP (object))
604
    XSETBUFFER (object, current_buffer);
605

606
  if (! NILP (limit) && ! EQ (limit, Qt))
607 608
    CHECK_NUMBER_COERCE_MARKER (limit, 0);

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

611 612 613 614
  /* If LIMIT is t, return start of next interval--don't
     bother checking further intervals.  */
  if (EQ (limit, Qt))
    {
615 616 617 618 619
      if (NULL_INTERVAL_P (i))
	next = i;
      else
	next = next_interval (i);
	
620
      if (NULL_INTERVAL_P (next))
621 622 623
	XSETFASTINT (position, (STRINGP (object)
				? XSTRING (object)->size
				: BUF_ZV (XBUFFER (object))));
624
      else
625 626
	XSETFASTINT (position, next->position - (STRINGP (object)));
      return position;
627 628
    }

629 630 631 632 633
  if (NULL_INTERVAL_P (i))
    return limit;

  next = next_interval (i);

634 635
  while (! NULL_INTERVAL_P (next) && intervals_equal (i, next)
	 && (NILP (limit) || next->position < XFASTINT (limit)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
636 637 638
    next = next_interval (next);

  if (NULL_INTERVAL_P (next))
639 640 641
    return limit;
  if (! NILP (limit) && !(next->position < XFASTINT (limit)))
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
642

643 644
  XSETFASTINT (position, next->position - (STRINGP (object)));
  return position;
645 646 647 648 649 650 651 652 653 654 655
}

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

656
  XSETBUFFER (object, current_buffer);
657
  XSETFASTINT (pos, beg);
658 659 660 661 662 663 664 665 666

  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);
667 668
      if (NULL_INTERVAL_P (next))
	return 0;
669 670 671 672 673 674 675 676
      if (next->position >= end)
	return 0;
    }

  if (NULL_INTERVAL_P (next))
    return 0;

  return 1;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
677 678
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
679
DEFUN ("next-single-property-change", Fnext_single_property_change,
680
       Snext_single_property_change, 2, 4, 0,
681
  "Return the position of next property change for a specific property.\n\
682
Scans characters forward from POSITION till it finds\n\
683 684
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\
685
The property values are compared with `eq'.\n\
686
Return nil if the property is constant all the way to the end of OBJECT.\n\
687
If the value is non-nil, it is a position greater than POSITION, never equal.\n\n\
688
If the optional fourth argument LIMIT is non-nil, don't search\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
689
past position LIMIT; return LIMIT if nothing is found before LIMIT.")
690 691
  (position, prop, object, limit)
     Lisp_Object position, prop, object, limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
692 693 694 695
{
  register INTERVAL i, next;
  register Lisp_Object here_val;

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

699 700 701
  if (!NILP (limit))
    CHECK_NUMBER_COERCE_MARKER (limit, 0);

702
  i = validate_interval_range (object, &position, &position, soft);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
703
  if (NULL_INTERVAL_P (i))
704
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
705

706
  here_val = textget (i->plist, prop);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
707
  next = next_interval (i);
708
  while (! NULL_INTERVAL_P (next) 
709 710
	 && EQ (here_val, textget (next->plist, prop))
	 && (NILP (limit) || next->position < XFASTINT (limit)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
711 712 713
    next = next_interval (next);

  if (NULL_INTERVAL_P (next))
714 715 716
    return limit;
  if (! NILP (limit) && !(next->position < XFASTINT (limit)))
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
717

718 719
  XSETFASTINT (position, next->position - (STRINGP (object)));
  return position;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
720 721
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
722
DEFUN ("previous-property-change", Fprevious_property_change,
723
       Sprevious_property_change, 1, 3, 0,
724
  "Return the position of previous property change.\n\
725
Scans characters backwards from POSITION in OBJECT till it finds\n\
726 727 728
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\
729
If the value is non-nil, it is a position less than POSITION, never equal.\n\n\
730
If the optional third argument LIMIT is non-nil, don't search\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
731
back past position LIMIT; return LIMIT if nothing is found until LIMIT.")
732 733
  (position, object, limit)
     Lisp_Object position, object, limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
734 735 736
{
  register INTERVAL i, previous;

737
  if (NILP (object))
738
    XSETBUFFER (object, current_buffer);
739

740 741 742
  if (!NILP (limit))
    CHECK_NUMBER_COERCE_MARKER (limit, 0);

743
  i = validate_interval_range (object, &position, &position, soft);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
744
  if (NULL_INTERVAL_P (i))
745
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
746

747
  /* Start with the interval containing the char before point.  */
748
  if (i->position == XFASTINT (position))
749 750
    i = previous_interval (i);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
751
  previous = previous_interval (i);
752 753 754
  while (! NULL_INTERVAL_P (previous) && intervals_equal (previous, i)
	 && (NILP (limit)
	     || previous->position + LENGTH (previous) > XFASTINT (limit)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
755 756
    previous = previous_interval (previous);
  if (NULL_INTERVAL_P (previous))
757 758 759 760
    return limit;
  if (!NILP (limit)
      && !(previous->position + LENGTH (previous) > XFASTINT (limit)))
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
761

762
  XSETFASTINT (position, (previous->position + LENGTH (previous)
763
		     - (STRINGP (object))));
764
  return position;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
765 766
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
767
DEFUN ("previous-single-property-change", Fprevious_single_property_change,
768
       Sprevious_single_property_change, 2, 4, 0,
769
  "Return the position of previous property change for a specific property.\n\
770
Scans characters backward from POSITION till it finds\n\
771 772
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\
773
The property values are compared with `eq'.\n\
774
Return nil if the property is constant all the way to the start of OBJECT.\n\
775
If the value is non-nil, it is a position less than POSITION, never equal.\n\n\
776
If the optional fourth argument LIMIT is non-nil, don't search\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
777
back past position LIMIT; return LIMIT if nothing is found until LIMIT.")
778 779
     (position, prop, object, limit)
     Lisp_Object position, prop, object, limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
780 781 782 783
{
  register INTERVAL i, previous;
  register Lisp_Object here_val;

784
  if (NILP (object))
785
    XSETBUFFER (object, current_buffer);
786

787 788 789
  if (!NILP (limit))
    CHECK_NUMBER_COERCE_MARKER (limit, 0);

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

792
  /* Start with the interval containing the char before point.  */
793
  if (! NULL_INTERVAL_P (i) && i->position == XFASTINT (position))
794 795
    i = previous_interval (i);

796 797 798
  if (NULL_INTERVAL_P (i))
    return limit;

799
  here_val = textget (i->plist, prop);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
800 801
  previous = previous_interval (i);
  while (! NULL_INTERVAL_P (previous)
802 803 804
	 && EQ (here_val, textget (previous->plist, prop))
	 && (NILP (limit)
	     || previous->position + LENGTH (previous) > XFASTINT (limit)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
805 806
    previous = previous_interval (previous);
  if (NULL_INTERVAL_P (previous))
807 808 809 810
    return limit;
  if (!NILP (limit)
      && !(previous->position + LENGTH (previous) > XFASTINT (limit)))
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
811

812
  XSETFASTINT (position, (previous->position + LENGTH (previous)
813
		     - (STRINGP (object))));
814
  return position;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
815 816
}

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

Joseph Arceneaux's avatar
Joseph Arceneaux committed
819
DEFUN ("add-text-properties", Fadd_text_properties,
820 821
       Sadd_text_properties, 3, 4, 0,
  "Add properties to the text from START to END.\n\
822
The third argument PROPERTIES is a property list\n\
823 824 825 826 827 828
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
829 830
{
  register INTERVAL i, unchanged;
831
  register int s, len, modified = 0;
832
  struct gcpro gcpro1;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
833 834 835 836 837

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

838
  if (NILP (object))
839
    XSETBUFFER (object, current_buffer);
840

Joseph Arceneaux's avatar
Joseph Arceneaux committed
841 842 843 844 845 846 847
  i = validate_interval_range (object, &start, &end, hard);
  if (NULL_INTERVAL_P (i))
    return Qnil;

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

848 849 850 851
  /* 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
852 853 854 855 856 857 858 859 860 861
  /* 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)
862
	    RETURN_UNGCPRO (Qnil);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
863
	  len -= got;
864
	  i = next_interval (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
865 866 867 868
	}
      else
	{
	  unchanged = i;
869
	  i = split_interval_right (unchanged, s - unchanged->position);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
870 871 872 873
	  copy_properties (unchanged, i);
	}
    }

874 875
  if (BUFFERP (object))
    modify_region (XBUFFER (object), XINT (start), XINT (end));
876

877
  /* We are at the beginning of interval I, with LEN chars to scan.  */
878
  for (;;)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
879
    {
880 881 882
      if (i == 0)
	abort ();

Joseph Arceneaux's avatar
Joseph Arceneaux committed
883 884
      if (LENGTH (i) >= len)
	{
885 886 887 888 889
	  /* 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
890
	  if (interval_has_all_properties (properties, i))
891
	    {
892 893 894
	      if (BUFFERP (object))
		signal_after_change (XINT (start), XINT (end) - XINT (start),
				     XINT (end) - XINT (start));
895 896 897

	      return modified ? Qt : Qnil;
	    }
Joseph Arceneaux's avatar
Joseph Arceneaux committed
898 899 900

	  if (LENGTH (i) == len)
	    {
901
	      add_properties (properties, i, object);
902 903 904
	      if (BUFFERP (object))
		signal_after_change (XINT (start), XINT (end) - XINT (start),
				     XINT (end) - XINT (start));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
905 906 907 908 909
	      return Qt;
	    }

	  /* i doesn't have the properties, and goes past the change limit */
	  unchanged = i;
910
	  i = split_interval_left (unchanged, len);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
911
	  copy_properties (unchanged, i);
912
	  add_properties (properties, i, object);
913 914 915
	  if (BUFFERP (object))
	    signal_after_change (XINT (start), XINT (end) - XINT (start),
				 XINT (end) - XINT (start));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
916 917 918 919
	  return Qt;
	}

      len -= LENGTH (i);
920
      modified += add_properties (properties, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
921 922 923 924
      i = next_interval (i);
    }
}

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

927 928 929
DEFUN ("put-text-property", Fput_text_property,
       Sput_text_property, 4, 5, 0,
  "Set one property of the text from START to END.\n\
930
The third and fourth arguments PROPERTY and VALUE\n\
931 932 933
specify the property to add.\n\
The optional fifth argument, OBJECT,\n\
is the string or buffer containing the text.")
934 935
  (start, end, property, value, object)
     Lisp_Object start, end, property, value, object;
936 937
{
  Fadd_text_properties (start, end,
938
			Fcons (property, Fcons (value, Qnil)),
939 940 941 942
			object);
  return Qnil;
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
943
DEFUN ("set-text-properties", Fset_text_properties,
944 945
       Sset_text_properties, 3, 4, 0,
  "Completely replace properties of text from START to END.\n\
946
The third argument PROPERTIES is the new property list.\n\
947 948
The optional fourth argument, OBJECT,\n\
is the string or buffer containing the text.")
949 950
  (start, end, properties, object)
     Lisp_Object start, end, properties, object;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
951 952
{
  register INTERVAL i, unchanged;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
953
  register INTERVAL prev_changed = NULL_INTERVAL;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
954
  register int s, len;
955
  Lisp_Object ostart, oend;
956
  int have_modified = 0;
957 958 959

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

961
  properties = validate_plist (properties);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
962

963
  if (NILP (object))
964
    XSETBUFFER (object, current_buffer);
965

966 967
  /* If we want no properties for a whole string,
     get rid of its intervals.  */
968
  if (NILP (properties) && STRINGP (object)
969 970 971
      && XFASTINT (start) == 0
      && XFASTINT (end) == XSTRING (object)->size)
    {
972 973 974
      if (! XSTRING (object)->intervals)
	return Qt;

975 976 977 978
      XSTRING (object)->intervals = 0;
      return Qt;
    }

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

Joseph Arceneaux's avatar
Joseph Arceneaux committed
981
  if (NULL_INTERVAL_P (i))
Richard M. Stallman's avatar
Richard M. Stallman committed
982
    {
983 984
      /* If buffer has no properties, and we want none, return now.  */
      if (NILP (properties))
Richard M. Stallman's avatar
Richard M. Stallman committed
985 986
	return Qnil;

987 988 989 990 991
      /* 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
992 993 994 995 996
      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
997 998 999 1000

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

1001 1002
  if (BUFFERP (object))
    modify_region (XBUFFER (object), XINT (start), XINT (end));
1003

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1004 1005 1006
  if (i->position != s)
    {
      unchanged = i;
1007
      i = split_interval_right (unchanged, s - unchanged->position);
1008

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1009 1010
      if (LENGTH (i) > len)
	{
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1011
	  copy_properties (unchanged, i);
1012
	  i = split_interval_left (i, len);
1013
	  set_properties (properties, i, object);
1014 1015 1016
	  if (BUFFERP (object))
	    signal_after_change (XINT (start), XINT (end) - XINT (start),
				 XINT (end) - XINT (start));
1017

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1018 1019 1020
	  return Qt;
	}

1021
      set_properties (properties, i, object);
1022

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1023
      if (LENGTH (i) == len)
1024
	{
1025 1026 1027
	  if (BUFFERP (object))
	    signal_after_change (XINT (start), XINT (end) - XINT (start),
				 XINT (end) - XINT (start));
1028 1029 1030

	  return Qt;
	}
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1031 1032

      prev_changed = i;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1033 1034 1035 1036
      len -= LENGTH (i);
      i = next_interval (i);
    }

1037
  /* We are starting at the beginning of an interval, I */
1038
  while (len > 0)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1039
    {
1040 1041 1042
      if (i == 0)
	abort ();

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1043 1044
      if (LENGTH (i) >= len)
	{
1045
	  if (LENGTH (i) > len)
1046
	    i = split_interval_left (i, len);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1047

1048 1049 1050
	  /* We have to call set_properties even if we are going to
	     merge the intervals, so as to make the undo records
	     and cause redisplay to happen.  */
1051
	  set_properties (properties, i, object);
1052
	  if (!NULL_INTERVAL_P (prev_changed))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1053
	    merge_interval_left (i);
1054 1055 1056
	  if (BUFFERP (object))
	    signal_after_change (XINT (start), XINT (end) - XINT (start),
				 XINT (end) - XINT (start));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1057 1058 1059 1060
	  return Qt;
	}

      len -= LENGTH (i);
1061 1062 1063 1064

      /* We have to call set_properties even if we are going to
	 merge the intervals, so as to make the undo records
	 and cause redisplay to happen.  */
1065
      set_properties (properties, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1066
      if (NULL_INTERVAL_P (prev_changed))
1067
	prev_changed = i;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1068 1069 1070
      else
	prev_changed = i = merge_interval_left (i);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1071 1072 1073
      i = next_interval (i);
    }

1074 1075 1076
  if (BUFFERP (object))
    signal_after_change (XINT (start), XINT (end) - XINT (start),
			 XINT (end) - XINT (start));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1077 1078 1079 1080
  return Qt;
}

DEFUN ("remove-text-properties", Fremove_text_properties,
1081 1082
       Sremove_text_properties, 3, 4, 0,
  "Remove some properties from text from START to END.\n\
1083
The third argument PROPERTIES is a property list\n\
1084
whose property names specify the properties to remove.\n\
1085
\(The values stored in PROPERTIES are ignored.)\n\
1086 1087 1088
The optional fourth argument, OBJECT,\n\
is the string or buffer containing the text.\n\
Return t if any property was actually removed, nil otherwise.")
1089 1090
  (start, end, properties, object)
     Lisp_Object start, end, properties, object;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1091 1092
{
  register INTERVAL i, unchanged;
1093
  register int s, len, modified = 0;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1094

1095
  if (NILP (object))
1096
    XSETBUFFER (object, current_buffer);
1097

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1098 1099 1100 1101 1102 1103
  i = validate_interval_range (object, &start, &end, soft);
  if (NULL_INTERVAL_P (i))
    return Qnil;

  s = XINT (start);
  len = XINT (end) - s;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1104

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1105 1106 1107 1108
  if (i->position != s)
    {
      /* No properties on this first interval -- return if
         it covers the entire region. */
1109
      if (! interval_has_some_properties (properties, i))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1110 1111 1112 1113 1114
	{
	  int got = (LENGTH (i) - (s - i->position));
	  if (got >= len)
	    return Qnil;
	  len -= got;
1115
	  i = next_interval (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1116
	}
1117 1118
      /* Split away the beginning of this interval; what we don't
	 want to modify.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1119 1120 1121
      else