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

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Jim Blandy's avatar
Jim Blandy committed
8
the Free Software Foundation; either version 2, or (at your option)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
9 10 11 12 13 14 15 16 17 18 19
any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */

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

#ifndef NULL
#define NULL (void *)0
#endif
Joseph Arceneaux's avatar
Joseph Arceneaux committed
29 30 31 32 33 34


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

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

43 44
/* The rest of the file is within this conditional */
#ifdef USE_TEXT_PROPERTIES
Joseph Arceneaux's avatar
Joseph Arceneaux committed
45 46 47 48 49 50

/* Types of hooks. */
Lisp_Object Qmouse_left;
Lisp_Object Qmouse_entered;
Lisp_Object Qpoint_left;
Lisp_Object Qpoint_entered;
51 52
Lisp_Object Qcategory;
Lisp_Object Qlocal_map;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
53 54 55

/* Visual properties text (including strings) may have. */
Lisp_Object Qforeground, Qbackground, Qfont, Qunderline, Qstipple;
56
Lisp_Object Qinvisible, Qread_only, Qintangible;
57 58 59

/* Sticky properties */
Lisp_Object Qfront_sticky, Qrear_nonsticky;
60 61 62 63

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

66 67
Lisp_Object Vinhibit_point_motion_hooks;

Joseph Arceneaux's avatar
Joseph Arceneaux committed
68

Joseph Arceneaux's avatar
Joseph Arceneaux committed
69 70 71 72 73 74
/* 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
75

76 77 78
   When OBJECT is a string, we increment *BEGIN and *END
   to make them origin-one.

Joseph Arceneaux's avatar
Joseph Arceneaux committed
79 80 81 82 83 84 85 86 87
   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
88 89
   create an interval tree for OBJECT if one doesn't exist, provided
   the object actually contains text.  In the current design, if there
90
   is no text, there can be no text properties.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
91 92 93 94 95 96 97 98 99 100

#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;
101 102
  int searchpos;

Joseph Arceneaux's avatar
Joseph Arceneaux committed
103 104 105 106 107 108
  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. */
109
  if (EQ (*begin, *end) && begin != end)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
110 111 112 113
    return NULL_INTERVAL;

  if (XINT (*begin) > XINT (*end))
    {
114 115
      Lisp_Object n;
      n = *begin;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
116
      *begin = *end;
117
      *end = n;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
118 119
    }

120
  if (BUFFERP (object))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
121 122 123 124 125 126 127 128
    {
      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);
      i = b->intervals;

129 130 131 132 133
      /* 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
134 135 136 137 138
    }
  else
    {
      register struct Lisp_String *s = XSTRING (object);

139
      if (! (0 <= XINT (*begin) && XINT (*begin) <= XINT (*end)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
140 141
	     && XINT (*end) <= s->size))
	args_out_of_range (*begin, *end);
142 143
      /* User-level Positions in strings start with 0,
	 but the interval code always wants positions starting with 1.  */
144
      XSETFASTINT (*begin, XFASTINT (*begin) + 1);
145
      if (begin != end)
146
	XSETFASTINT (*end, XFASTINT (*end) + 1);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
147
      i = s->intervals;
148 149 150 151 152

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

      searchpos = XINT (*begin);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
153 154 155 156 157
    }

  if (NULL_INTERVAL_P (i))
    return (force ? create_root_interval (object) : i);
    
158
  return find_interval (i, searchpos);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
159 160 161 162 163 164 165 166
}

/* 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)
167
     Lisp_Object list;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
168 169 170 171 172 173 174 175 176
{
  if (NILP (list))
    return Qnil;

  if (CONSP (list))
    {
      register int i;
      register Lisp_Object tail;
      for (i = 0, tail = list; !NILP (tail); i++)
177 178 179 180
	{
	  tail = Fcdr (tail);
	  QUIT;
	}
Joseph Arceneaux's avatar
Joseph Arceneaux committed
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
      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. */
212
	    if (! EQ (Fcar (Fcdr (tail1)), Fcar (Fcdr (tail2))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249
	      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;
}
250

251 252 253 254
/* Changing the plists of individual intervals.  */

/* Return the value of PROP in property-list PLIST, or Qunbound if it
   has none.  */
255
static Lisp_Object
256
property_value (plist, prop)
257
     Lisp_Object plist, prop;
258 259 260 261 262 263 264 265 266 267 268 269
{
  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;
}

270 271 272 273 274 275 276 277 278
/* 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;
{
279
  Lisp_Object sym, value;
280

281
  if (BUFFERP (object))
282
    {
283 284 285 286 287 288 289
      /* 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))
290 291 292 293 294 295 296 297
	  {
	    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);
	  }
298 299 300 301 302 303 304

      /* 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))
305 306 307 308 309 310 311 312
	  {
	    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);
	  }
313 314 315 316 317
    }

  /* Store new properties.  */
  interval->plist = Fcopy_sequence (properties);
}
Joseph Arceneaux's avatar
Joseph Arceneaux committed
318 319 320 321 322

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

323 324
   OBJECT should be the string or buffer the interval is in.

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

328 329
static int
add_properties (plist, i, object)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
330 331
     Lisp_Object plist;
     INTERVAL i;
332
     Lisp_Object object;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
{
  register Lisp_Object tail1, tail2, sym1, val1;
  register int changed = 0;
  register int found;

  /* 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)))
	  {
349
	    register Lisp_Object this_cdr;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
350

351
	    this_cdr = Fcdr (tail2);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
352 353 354 355 356
	    /* Found the property.  Now check its value. */
	    found = 1;

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

360
	    /* Record this change in the buffer, for undo purposes.  */
361
	    if (BUFFERP (object))
362
	      {
363 364
		modify_region (XBUFFER (object),
			       make_number (i->position),
365
			       make_number (i->position + LENGTH (i)));
366 367
		record_property_change (i->position, LENGTH (i),
					sym1, Fcar (this_cdr), object);
368 369
	      }

Joseph Arceneaux's avatar
Joseph Arceneaux committed
370 371 372 373 374 375 376 377
	    /* I's property has a different value -- change it */
	    Fsetcar (this_cdr, val1);
	    changed++;
	    break;
	  }

      if (! found)
	{
378
	  /* Record this change in the buffer, for undo purposes.  */
379
	  if (BUFFERP (object))
380
	    {
381 382
	      modify_region (XBUFFER (object),
			     make_number (i->position),
383
			     make_number (i->position + LENGTH (i)));
384 385
	      record_property_change (i->position, LENGTH (i),
				      sym1, Qnil, object);
386
	    }
Joseph Arceneaux's avatar
Joseph Arceneaux committed
387 388 389 390 391 392 393 394 395
	  i->plist = Fcons (sym1, Fcons (val1, i->plist));
	  changed++;
	}
    }

  return changed;
}

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

399 400
static int
remove_properties (plist, i, object)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
401 402
     Lisp_Object plist;
     INTERVAL i;
403
     Lisp_Object object;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
404
{
405
  register Lisp_Object tail1, tail2, sym, current_plist;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
406 407
  register int changed = 0;

408
  current_plist = i->plist;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
409 410 411 412 413 414 415 416
  /* 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)))
	{
417
	  if (BUFFERP (object))
418
	    {
419 420
	      modify_region (XBUFFER (object),
			     make_number (i->position),
421
			     make_number (i->position + LENGTH (i)));
422 423 424
	      record_property_change (i->position, LENGTH (i),
				      sym, Fcar (Fcdr (current_plist)),
				      object);
425 426
	    }

Joseph Arceneaux's avatar
Joseph Arceneaux committed
427 428 429 430 431 432 433 434
	  current_plist = Fcdr (Fcdr (current_plist));
	  changed++;
	}

      /* Go through i's plist, looking for sym */
      tail2 = current_plist;
      while (! NILP (tail2))
	{
435 436
	  register Lisp_Object this;
	  this = Fcdr (Fcdr (tail2));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
437 438
	  if (EQ (sym, Fcar (this)))
	    {
439
	      if (BUFFERP (object))
440
		{
441 442
		  modify_region (XBUFFER (object),
				 make_number (i->position),
443
				 make_number (i->position + LENGTH (i)));
444 445
		  record_property_change (i->position, LENGTH (i),
					  sym, Fcar (Fcdr (this)), object);
446 447
		}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
448 449 450 451 452 453 454 455 456 457 458 459
	      Fsetcdr (Fcdr (tail2), Fcdr (Fcdr (this)));
	      changed++;
	    }
	  tail2 = this;
	}
    }

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

460
#if 0
Joseph Arceneaux's avatar
Joseph Arceneaux committed
461 462 463 464 465 466 467 468 469 470 471 472 473
/* 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;
}
474
#endif
Joseph Arceneaux's avatar
Joseph Arceneaux committed
475 476 477 478 479

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\
480 481
defaults to the current buffer.\n\
If POSITION is at the end of OBJECT, the value is nil.")
Joseph Arceneaux's avatar
Joseph Arceneaux committed
482 483 484 485 486 487
  (pos, object)
     Lisp_Object pos, object;
{
  register INTERVAL i;

  if (NILP (object))
488
    XSETBUFFER (object, current_buffer);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
489 490 491 492

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

  return i->plist;
}

503
DEFUN ("get-text-property", Fget_text_property, Sget_text_property, 2, 3, 0,
504
  "Return the value of position POS's property PROP, in OBJECT.\n\
505 506
OBJECT is optional and defaults to the current buffer.\n\
If POSITION is at the end of OBJECT, the value is nil.")
507
  (pos, prop, object)
508
     Lisp_Object pos, object;
509
     Lisp_Object prop;
510
{
511
  return textget (Ftext_properties_at (pos, object), prop);
512 513
}

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

  CHECK_NUMBER_COERCE_MARKER (pos, 0);

  if (NILP (object))
531
    XSETBUFFER (object, current_buffer);
532 533 534 535

  if (WINDOWP (object))
    {
      w = XWINDOW (object);
536
      object = w->buffer;
537 538 539 540 541 542 543 544 545 546 547 548 549
    }
  if (BUFFERP (object))
    {
      int posn = XINT (pos);
      int noverlays;
      Lisp_Object *overlay_vec, tem;
      int next_overlay;
      int len;

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

550 551
      noverlays = overlays_at (posn, 0, &overlay_vec, &len,
			       &next_overlay, NULL);
552 553 554 555 556 557 558

      /* 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));
559 560
	  noverlays = overlays_at (posn, 0, &overlay_vec, &len,
				   &next_overlay, NULL);
561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576
	}
      noverlays = sort_overlays (overlay_vec, noverlays, w);

      /* Now check the overlays in order of decreasing priority.  */
      while (--noverlays >= 0)
	{
	  tem = Foverlay_get (overlay_vec[noverlays], prop);
	  if (!NILP (tem))
	    return (tem);
	}
    }
  /* Not a buffer, or no appropriate overlay, so fall through to the
     simpler case.  */
  return (Fget_text_property (pos, prop, object));
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
577
DEFUN ("next-property-change", Fnext_property_change,
578
       Snext_property_change, 1, 3, 0,
579 580 581 582 583
  "Return the position of next property change.\n\
Scans characters forward from POS in OBJECT till it finds\n\
a change in some text property, then returns the position of the change.\n\
The optional second argument OBJECT is the string or buffer to scan.\n\
Return nil if the property is constant all the way to the end of OBJECT.\n\
584 585 586 587 588
If the value is non-nil, it is a position greater than POS, never equal.\n\n\
If the optional third argument LIMIT is non-nil, don't search\n\
past position LIMIT; return LIMIT if nothing is found before LIMIT.")
  (pos, object, limit)
     Lisp_Object pos, object, limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
589 590 591
{
  register INTERVAL i, next;

592
  if (NILP (object))
593
    XSETBUFFER (object, current_buffer);
594

595 596 597
  if (!NILP (limit))
    CHECK_NUMBER_COERCE_MARKER (limit, 0);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
598 599
  i = validate_interval_range (object, &pos, &pos, soft);
  if (NULL_INTERVAL_P (i))
600
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
601 602

  next = next_interval (i);
603 604
  while (! NULL_INTERVAL_P (next) && intervals_equal (i, next)
	 && (NILP (limit) || next->position < XFASTINT (limit)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
605 606 607
    next = next_interval (next);

  if (NULL_INTERVAL_P (next))
608 609 610
    return limit;
  if (! NILP (limit) && !(next->position < XFASTINT (limit)))
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
611

612
  XSETFASTINT (pos, next->position - (STRINGP (object)));
613
  return pos;
614 615 616 617 618 619 620 621 622 623 624
}

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

625
  XSETBUFFER (object, current_buffer);
626
  XSETFASTINT (pos, beg);
627 628 629 630 631 632 633 634 635

  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);
636 637
      if (NULL_INTERVAL_P (next))
	return 0;
638 639 640 641 642 643 644 645
      if (next->position >= end)
	return 0;
    }

  if (NULL_INTERVAL_P (next))
    return 0;

  return 1;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
646 647
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
648
DEFUN ("next-single-property-change", Fnext_single_property_change,
649
       Snext_single_property_change, 2, 4, 0,
650 651 652 653
  "Return the position of next property change for a specific property.\n\
Scans characters forward from POS till it finds\n\
a change in the PROP property, then returns the position of the change.\n\
The optional third argument OBJECT is the string or buffer to scan.\n\
654
The property values are compared with `eq'.\n\
655
Return nil if the property is constant all the way to the end of OBJECT.\n\
656 657
If the value is non-nil, it is a position greater than POS, never equal.\n\n\
If the optional fourth argument LIMIT is non-nil, don't search\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
658
past position LIMIT; return LIMIT if nothing is found before LIMIT.")
659 660
  (pos, prop, object, limit)
     Lisp_Object pos, prop, object, limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
661 662 663 664
{
  register INTERVAL i, next;
  register Lisp_Object here_val;

665
  if (NILP (object))
666
    XSETBUFFER (object, current_buffer);
667

668 669 670
  if (!NILP (limit))
    CHECK_NUMBER_COERCE_MARKER (limit, 0);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
671 672
  i = validate_interval_range (object, &pos, &pos, soft);
  if (NULL_INTERVAL_P (i))
673
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
674

675
  here_val = textget (i->plist, prop);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
676
  next = next_interval (i);
677
  while (! NULL_INTERVAL_P (next) 
678 679
	 && EQ (here_val, textget (next->plist, prop))
	 && (NILP (limit) || next->position < XFASTINT (limit)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
680 681 682
    next = next_interval (next);

  if (NULL_INTERVAL_P (next))
683 684 685
    return limit;
  if (! NILP (limit) && !(next->position < XFASTINT (limit)))
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
686

687
  XSETFASTINT (pos, next->position - (STRINGP (object)));
688
  return pos;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
689 690
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
691
DEFUN ("previous-property-change", Fprevious_property_change,
692
       Sprevious_property_change, 1, 3, 0,
693 694 695 696 697
  "Return the position of previous property change.\n\
Scans characters backwards from POS in OBJECT till it finds\n\
a change in some text property, then returns the position of the change.\n\
The optional second argument OBJECT is the string or buffer to scan.\n\
Return nil if the property is constant all the way to the start of OBJECT.\n\
698 699
If the value is non-nil, it is a position less than POS, never equal.\n\n\
If the optional third argument LIMIT is non-nil, don't search\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
700
back past position LIMIT; return LIMIT if nothing is found until LIMIT.")
701 702
  (pos, object, limit)
     Lisp_Object pos, object, limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
703 704 705
{
  register INTERVAL i, previous;

706
  if (NILP (object))
707
    XSETBUFFER (object, current_buffer);
708

709 710 711
  if (!NILP (limit))
    CHECK_NUMBER_COERCE_MARKER (limit, 0);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
712 713
  i = validate_interval_range (object, &pos, &pos, soft);
  if (NULL_INTERVAL_P (i))
714
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
715

716 717 718 719
  /* Start with the interval containing the char before point.  */
  if (i->position == XFASTINT (pos))
    i = previous_interval (i);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
720
  previous = previous_interval (i);
721 722 723
  while (! NULL_INTERVAL_P (previous) && intervals_equal (previous, i)
	 && (NILP (limit)
	     || previous->position + LENGTH (previous) > XFASTINT (limit)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
724 725
    previous = previous_interval (previous);
  if (NULL_INTERVAL_P (previous))
726 727 728 729
    return limit;
  if (!NILP (limit)
      && !(previous->position + LENGTH (previous) > XFASTINT (limit)))
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
730

731 732
  XSETFASTINT (pos, (previous->position + LENGTH (previous)
		     - (STRINGP (object))));
733
  return pos;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
734 735
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
736
DEFUN ("previous-single-property-change", Fprevious_single_property_change,
737
       Sprevious_single_property_change, 2, 4, 0,
738 739 740 741
  "Return the position of previous property change for a specific property.\n\
Scans characters backward from POS till it finds\n\
a change in the PROP property, then returns the position of the change.\n\
The optional third argument OBJECT is the string or buffer to scan.\n\
742
The property values are compared with `eq'.\n\
743
Return nil if the property is constant all the way to the start of OBJECT.\n\
744 745
If the value is non-nil, it is a position less than POS, never equal.\n\n\
If the optional fourth argument LIMIT is non-nil, don't search\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
746
back past position LIMIT; return LIMIT if nothing is found until LIMIT.")
747 748
     (pos, prop, object, limit)
     Lisp_Object pos, prop, object, limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
749 750 751 752
{
  register INTERVAL i, previous;
  register Lisp_Object here_val;

753
  if (NILP (object))
754
    XSETBUFFER (object, current_buffer);
755

756 757 758
  if (!NILP (limit))
    CHECK_NUMBER_COERCE_MARKER (limit, 0);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
759 760
  i = validate_interval_range (object, &pos, &pos, soft);

761
  /* Start with the interval containing the char before point.  */
762
  if (! NULL_INTERVAL_P (i) && i->position == XFASTINT (pos))
763 764
    i = previous_interval (i);

765 766 767
  if (NULL_INTERVAL_P (i))
    return limit;

768
  here_val = textget (i->plist, prop);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
769 770
  previous = previous_interval (i);
  while (! NULL_INTERVAL_P (previous)
771 772 773
	 && EQ (here_val, textget (previous->plist, prop))
	 && (NILP (limit)
	     || previous->position + LENGTH (previous) > XFASTINT (limit)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
774 775
    previous = previous_interval (previous);
  if (NULL_INTERVAL_P (previous))
776 777 778 779
    return limit;
  if (!NILP (limit)
      && !(previous->position + LENGTH (previous) > XFASTINT (limit)))
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
780

781 782
  XSETFASTINT (pos, (previous->position + LENGTH (previous)
		     - (STRINGP (object))));
783
  return pos;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
784 785
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
786
DEFUN ("add-text-properties", Fadd_text_properties,
787 788 789 790 791 792 793 794 795
       Sadd_text_properties, 3, 4, 0,
  "Add properties to the text from START to END.\n\
The third argument PROPS is a property list\n\
specifying the property values to add.\n\
The optional fourth argument, OBJECT,\n\
is the string or buffer containing the text.\n\
Return t if any property value actually changed, nil otherwise.")
  (start, end, properties, object)
     Lisp_Object start, end, properties, object;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
796 797
{
  register INTERVAL i, unchanged;
798
  register int s, len, modified = 0;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
799 800 801 802 803

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

804
  if (NILP (object))
805
    XSETBUFFER (object, current_buffer);
806

Joseph Arceneaux's avatar
Joseph Arceneaux committed
807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825
  i = validate_interval_range (object, &start, &end, hard);
  if (NULL_INTERVAL_P (i))
    return Qnil;

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

  /* 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;
826
	  i = next_interval (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
827 828 829 830
	}
      else
	{
	  unchanged = i;
831
	  i = split_interval_right (unchanged, s - unchanged->position);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
832 833 834 835
	  copy_properties (unchanged, i);
	}
    }

836
  /* We are at the beginning of interval I, with LEN chars to scan.  */
837
  for (;;)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
838
    {
839 840 841
      if (i == 0)
	abort ();

Joseph Arceneaux's avatar
Joseph Arceneaux committed
842 843 844 845 846 847 848
      if (LENGTH (i) >= len)
	{
	  if (interval_has_all_properties (properties, i))
	    return modified ? Qt : Qnil;

	  if (LENGTH (i) == len)
	    {
849
	      add_properties (properties, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
850 851 852 853 854
	      return Qt;
	    }

	  /* i doesn't have the properties, and goes past the change limit */
	  unchanged = i;
855
	  i = split_interval_left (unchanged, len);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
856
	  copy_properties (unchanged, i);
857
	  add_properties (properties, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
858 859 860 861
	  return Qt;
	}

      len -= LENGTH (i);
862
      modified += add_properties (properties, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
863 864 865 866
      i = next_interval (i);
    }
}

867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882
DEFUN ("put-text-property", Fput_text_property,
       Sput_text_property, 4, 5, 0,
  "Set one property of the text from START to END.\n\
The third and fourth arguments PROP and VALUE\n\
specify the property to add.\n\
The optional fifth argument, OBJECT,\n\
is the string or buffer containing the text.")
  (start, end, prop, value, object)
     Lisp_Object start, end, prop, value, object;
{
  Fadd_text_properties (start, end,
			Fcons (prop, Fcons (value, Qnil)),
			object);
  return Qnil;
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
883
DEFUN ("set-text-properties", Fset_text_properties,
884 885 886 887 888 889 890
       Sset_text_properties, 3, 4, 0,
  "Completely replace properties of text from START to END.\n\
The third argument PROPS is the new property list.\n\
The optional fourth argument, OBJECT,\n\
is the string or buffer containing the text.")
  (start, end, props, object)
     Lisp_Object start, end, props, object;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
891 892
{
  register INTERVAL i, unchanged;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
893
  register INTERVAL prev_changed = NULL_INTERVAL;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
894
  register int s, len;
895 896 897 898
  Lisp_Object ostart, oend;

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

900
  props = validate_plist (props);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
901

902
  if (NILP (object))
903
    XSETBUFFER (object, current_buffer);
904

905 906 907 908 909 910 911 912 913 914
  /* If we want no properties for a whole string,
     get rid of its intervals.  */
  if (NILP (props) && STRINGP (object)
      && XFASTINT (start) == 0
      && XFASTINT (end) == XSTRING (object)->size)
    {
      XSTRING (object)->intervals = 0;
      return Qt;
    }

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

Joseph Arceneaux's avatar
Joseph Arceneaux committed
917
  if (NULL_INTERVAL_P (i))
Richard M. Stallman's avatar
Richard M. Stallman committed
918 919 920 921 922
    {
      /* If buffer has no props, and we want none, return now.  */
      if (NILP (props))
	return Qnil;

923 924 925 926 927
      /* 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
928 929 930 931 932
      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
933 934 935 936 937 938 939

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

  if (i->position != s)
    {
      unchanged = i;
940
      i = split_interval_right (unchanged, s - unchanged->position);
941

Joseph Arceneaux's avatar
Joseph Arceneaux committed
942 943
      if (LENGTH (i) > len)
	{
Joseph Arceneaux's avatar
Joseph Arceneaux committed
944
	  copy_properties (unchanged, i);
945
	  i = split_interval_left (i, len);
946
	  set_properties (props, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
947 948 949
	  return Qt;
	}

950 951
      set_properties (props, i, object);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
952 953 954 955
      if (LENGTH (i) == len)
	return Qt;

      prev_changed = i;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
956 957 958 959
      len -= LENGTH (i);
      i = next_interval (i);
    }

960
  /* We are starting at the beginning of an interval, I */
961
  while (len > 0)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
962
    {
963 964 965
      if (i == 0)
	abort ();

Joseph Arceneaux's avatar
Joseph Arceneaux committed
966 967
      if (LENGTH (i) >= len)
	{
968
	  if (LENGTH (i) > len)
969
	    i = split_interval_left (i, len);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
970

Joseph Arceneaux's avatar
Joseph Arceneaux committed
971
	  if (NULL_INTERVAL_P (prev_changed))
972
	    set_properties (props, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
973 974
	  else
	    merge_interval_left (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
975 976 977 978
	  return Qt;
	}

      len -= LENGTH (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
979 980
      if (NULL_INTERVAL_P (prev_changed))
	{
981
	  set_properties (props, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
982 983 984 985 986
	  prev_changed = i;
	}
      else
	prev_changed = i = merge_interval_left (i);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
987 988 989 990 991 992 993
      i = next_interval (i);
    }

  return Qt;
}

DEFUN ("remove-text-properties", Fremove_text_properties,
994 995 996 997 998 999 1000 1001 1002 1003
       Sremove_text_properties, 3, 4, 0,
  "Remove some properties from text from START to END.\n\
The third argument PROPS is a property list\n\
whose property names specify the properties to remove.\n\
\(The values stored in PROPS are ignored.)\n\
The optional fourth argument, OBJECT,\n\
is the string or buffer containing the text.\n\
Return t if any property was actually removed, nil otherwise.")
  (start, end, props, object)
     Lisp_Object start, end, props, object;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1004 1005
{
  register INTERVAL i, unchanged;
1006
  register int s, len, modified = 0;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1007

1008
  if (NILP (object))
1009
    XSETBUFFER (object, current_buffer);
1010

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1011 1012 1013 1014 1015 1016
  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
1017

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1018 1019 1020 1021
  if (i->position != s)
    {
      /* No properties on this first interval -- return if
         it covers the entire region. */
1022
      if (! interval_has_some_properties (props, i))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1023 1024 1025 1026 1027
	{
	  int got = (LENGTH (i) - (s - i->position));
	  if (got >= len)
	    return Qnil;
	  len -= got;
1028
	  i = next_interval (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1029
	}
1030 1031
      /* Split away the beginning of this interval; what we don't
	 want to modify.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1032 1033 1034
      else
	{
	  unchanged = i;
1035
	  i = split_interval_right (unchanged, s - unchanged->position);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1036 1037 1038 1039 1040
	  copy_properties (unchanged, i);
	}
    }

  /* We are at the beginning of an interval, with len to scan */
1041
  for (;;)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1042
    {
1043 1044 1045
      if (i == 0)
	abort ();

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1046 1047
      if (LENGTH (i) >= len)
	{
1048
	  if (! interval_has_some_properties (props, i))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1049 1050 1051 1052
	    return modified ? Qt : Qnil;

	  if (LENGTH (i) == len)
	    {
1053
	      remove_properties (props, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1054 1055 1056 1057
	      return Qt;
	    }

	  /* i has the properties, and goes past the change limit */
1058
	  unchanged = i;
1059
	  i = split_interval_left (i, len);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1060
	  copy_properties (unchanged, i);
1061
	  remove_properties (props, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1062 1063 1064 1065
	  return Qt;
	}

      len -= LENGTH (i);
1066
      modified += remove_properties (props, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1067 1068 1069 1070
      i = next_interval (i);
    }
}

1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084
DEFUN ("text-property-any", Ftext_property_any,
       Stext_property_any, 4, 5, 0,
  "Check text from START to END to see if PROP is ever `eq' to VALUE.\n\
If so, return the position of the first character whose PROP is `eq'\n\
to VALUE.  Otherwise return nil.\n\
The optional fifth argument, OBJECT, is the string or buffer\n\
containing the text.")
  (start, end, prop, value, object)
       Lisp_Object start, end, prop, value, object;
{
  register INTERVAL i;
  register int e, pos;

  if (NILP (object))
1085
    XSETBUFFER (object, current_buffer);
1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097
  i = validate_interval_range (object, &start, &end, soft);
  e = XINT (end);

  while (! NULL_INTERVAL_P (i))
    {
      if (i->position >= e)
	break;
      if (EQ (textget (i->plist, prop), value))
	{
	  pos = i->position;
	  if (pos < XINT (start))
	    pos = XINT (start);
1098
	  return make_number (pos - (STRINGP (object)));
1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118
	}
      i = next_interval (i);
    }
  return Qnil;
}

DEFUN ("text-property-not-all", Ftext_property_not_all,
       Stext_property_not_all, 4, 5, 0,
  "Check text from START to END to see if PROP is ever not `eq' to VALUE.\n\
If so, return the position of the first character whose PROP is not\n\
`eq' to VALUE.  Otherwise, return nil.\n\
The optional fifth argument, OBJECT, is the string or buffer\n\
containing the text.")
  (start, end, prop, value, object)
       Lisp_Object start, end, prop, value, object;
{
  register INTERVAL i;
  register int s, e;

  if (NILP (object))
1119
    XSETBUFFER (object, current_buffer);
1120 1121
  i = validate_interval_range (object, &start, &end, soft