textprop.c 28.5 KB
Newer Older
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1
/* Interface code for dealing with text properties.
2
   Copyright (C) 1993 Free Software Foundation, Inc.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29

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
the Free Software Foundation; either version 1, or (at your option)
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.  */

#include "config.h"
#include "lisp.h"
#include "intervals.h"
#include "buffer.h"


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

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

38 39
/* The rest of the file is within this conditional */
#ifdef USE_TEXT_PROPERTIES
Joseph Arceneaux's avatar
Joseph Arceneaux committed
40 41 42 43 44 45

/* Types of hooks. */
Lisp_Object Qmouse_left;
Lisp_Object Qmouse_entered;
Lisp_Object Qpoint_left;
Lisp_Object Qpoint_entered;
46
Lisp_Object Qmodification_hooks;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
47 48 49 50 51

/* Visual properties text (including strings) may have. */
Lisp_Object Qforeground, Qbackground, Qfont, Qunderline, Qstipple;
Lisp_Object Qinvisible, Qread_only;

Joseph Arceneaux's avatar
Joseph Arceneaux committed
52 53 54 55 56 57
/* 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
58

59 60 61
   When OBJECT is a string, we increment *BEGIN and *END
   to make them origin-one.

Joseph Arceneaux's avatar
Joseph Arceneaux committed
62 63 64 65 66 67 68 69 70
   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
71 72
   create an interval tree for OBJECT if one doesn't exist, provided
   the object actually contains text.  In the current design, if there
73
   is no text, there can be no text properties.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
74 75 76 77 78 79 80 81 82 83

#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;
84 85
  int searchpos;

Joseph Arceneaux's avatar
Joseph Arceneaux committed
86 87 88 89 90 91 92 93 94 95 96
  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. */
  if (*begin == *end && begin != end)
    return NULL_INTERVAL;

  if (XINT (*begin) > XINT (*end))
    {
97 98
      Lisp_Object n;
      n = *begin;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
99
      *begin = *end;
100
      *end = n;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
101 102 103 104 105 106 107 108 109 110 111
    }

  if (XTYPE (object) == Lisp_Buffer)
    {
      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;

112 113 114 115 116 117 118 119
      /* If there's no text, there are no properties. */
      if (BUF_BEGV (b) == BUF_ZV (b))
	return NULL_INTERVAL;

      searchpos = XINT (*begin);
      if (searchpos == BUF_Z (b))
	searchpos--;
#if 0
Joseph Arceneaux's avatar
Joseph Arceneaux committed
120 121 122 123
      /* Special case for point-max:  return the interval for the
         last character. */
      if (*begin == *end && *begin == BUF_Z (b))
	*begin -= 1;
124
#endif
Joseph Arceneaux's avatar
Joseph Arceneaux committed
125 126 127 128 129
    }
  else
    {
      register struct Lisp_String *s = XSTRING (object);

130
      if (! (0 <= XINT (*begin) && XINT (*begin) <= XINT (*end)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
131 132
	     && XINT (*end) <= s->size))
	args_out_of_range (*begin, *end);
133 134 135 136
      /* User-level Positions in strings start with 0,
	 but the interval code always wants positions starting with 1.  */
      XFASTINT (*begin) += 1;
      XFASTINT (*end) += 1;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
137
      i = s->intervals;
138 139 140 141 142 143 144

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

      searchpos = XINT (*begin);
      if (searchpos > s->size)
	searchpos--;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
145 146 147 148 149
    }

  if (NULL_INTERVAL_P (i))
    return (force ? create_root_interval (object) : i);
    
150
  return find_interval (i, searchpos);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 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 212 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
}

/* 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)
{
  if (NILP (list))
    return Qnil;

  if (CONSP (list))
    {
      register int i;
      register Lisp_Object tail;
      for (i = 0, tail = list; !NILP (tail); i++)
	tail = Fcdr (tail);
      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. */
	    if (! EQ (Fequal (Fcar (Fcdr (tail1)), Fcar (Fcdr (tail2))),
		      Qt))
	      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;
}
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266

/* 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;
{
  Lisp_Object oldprops;
  oldprops = interval->plist;

  /* Record undo for old properties.  */
  while (XTYPE (oldprops) == Lisp_Cons)
    {
      Lisp_Object sym;
      sym = Fcar (oldprops);
      record_property_change (interval->position, LENGTH (interval),
			      sym, Fcar_safe (Fcdr (oldprops)),
			      object);
      
      oldprops = Fcdr_safe (Fcdr (oldprops));
    }

  /* Store new properties.  */
  interval->plist = Fcopy_sequence (properties);
}
Joseph Arceneaux's avatar
Joseph Arceneaux committed
267 268 269 270 271

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

272 273
   OBJECT should be the string or buffer the interval is in.

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

277 278
static int
add_properties (plist, i, object)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
279 280
     Lisp_Object plist;
     INTERVAL i;
281
     Lisp_Object object;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
{
  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)))
	  {
	    register Lisp_Object this_cdr = Fcdr (tail2);

	    /* Found the property.  Now check its value. */
	    found = 1;

	    /* The properties have the same value on both lists.
	       Continue to the next property. */
305
	    if (!NILP (Fequal (val1, Fcar (this_cdr))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
306 307
	      break;

308 309 310 311 312 313 314 315 316
	    /* Record this change in the buffer, for undo purposes.  */
	    if (XTYPE (object) == Lisp_Buffer)
	      {
		record_property_change (i->position, LENGTH (i),
					sym1, Fcar (this_cdr), object);
		modify_region (make_number (i->position),
			       make_number (i->position + LENGTH (i)));
	      }

Joseph Arceneaux's avatar
Joseph Arceneaux committed
317 318 319 320 321 322 323 324
	    /* I's property has a different value -- change it */
	    Fsetcar (this_cdr, val1);
	    changed++;
	    break;
	  }

      if (! found)
	{
325 326 327 328 329 330 331 332
	  /* Record this change in the buffer, for undo purposes.  */
	  if (XTYPE (object) == Lisp_Buffer)
	    {
	      record_property_change (i->position, LENGTH (i),
				      sym1, Qnil, object);
	      modify_region (make_number (i->position),
			     make_number (i->position + LENGTH (i)));
	    }
Joseph Arceneaux's avatar
Joseph Arceneaux committed
333 334 335 336 337 338 339 340 341
	  i->plist = Fcons (sym1, Fcons (val1, i->plist));
	  changed++;
	}
    }

  return changed;
}

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

345 346
static int
remove_properties (plist, i, object)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
347 348
     Lisp_Object plist;
     INTERVAL i;
349
     Lisp_Object object;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
350 351 352 353 354 355 356 357 358 359 360 361 362
{
  register Lisp_Object tail1, tail2, sym;
  register Lisp_Object current_plist = i->plist;
  register int changed = 0;

  /* 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)))
	{
363 364 365 366 367 368 369 370 371
	  if (XTYPE (object) == Lisp_Buffer)
	    {
	      record_property_change (i->position, LENGTH (i),
				      sym, Fcar (Fcdr (current_plist)),
				      object);
	      modify_region (make_number (i->position),
			     make_number (i->position + LENGTH (i)));
	    }

Joseph Arceneaux's avatar
Joseph Arceneaux committed
372 373 374 375 376 377 378 379 380 381 382
	  current_plist = Fcdr (Fcdr (current_plist));
	  changed++;
	}

      /* Go through i's plist, looking for sym */
      tail2 = current_plist;
      while (! NILP (tail2))
	{
	  register Lisp_Object this = Fcdr (Fcdr (tail2));
	  if (EQ (sym, Fcar (this)))
	    {
383 384 385 386 387 388 389 390
	      if (XTYPE (object) == Lisp_Buffer)
		{
		  record_property_change (i->position, LENGTH (i),
					  sym, Fcar (Fcdr (this)), object);
		  modify_region (make_number (i->position),
				 make_number (i->position + LENGTH (i)));
		}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
391 392 393 394 395 396 397 398 399 400 401 402
	      Fsetcdr (Fcdr (tail2), Fcdr (Fcdr (this)));
	      changed++;
	    }
	  tail2 = this;
	}
    }

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

403
#if 0
Joseph Arceneaux's avatar
Joseph Arceneaux committed
404 405 406 407 408 409 410 411 412 413 414 415 416
/* 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;
}
417
#endif
Joseph Arceneaux's avatar
Joseph Arceneaux committed
418 419 420 421 422

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\
423 424
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
425 426 427 428 429 430 431 432 433 434 435
  (pos, object)
     Lisp_Object pos, object;
{
  register INTERVAL i;

  if (NILP (object))
    XSET (object, Lisp_Buffer, current_buffer);

  i = validate_interval_range (object, &pos, &pos, soft);
  if (NULL_INTERVAL_P (i))
    return Qnil;
436 437 438 439 440 441
  /* 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
442 443 444 445

  return i->plist;
}

446
DEFUN ("get-text-property", Fget_text_property, Sget_text_property, 2, 3, 0,
447
  "Return the value of position POS's property PROP, in OBJECT.\n\
448 449
OBJECT is optional and defaults to the current buffer.\n\
If POSITION is at the end of OBJECT, the value is nil.")
450
  (pos, prop, object)
451
     Lisp_Object pos, object;
452 453 454 455 456 457 458 459 460 461 462
     register Lisp_Object prop;
{
  register INTERVAL i;
  register Lisp_Object tail;

  if (NILP (object))
    XSET (object, Lisp_Buffer, current_buffer);
  i = validate_interval_range (object, &pos, &pos, soft);
  if (NULL_INTERVAL_P (i))
    return Qnil;

463 464 465 466 467 468 469
  /* 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;

470 471 472 473 474 475 476 477 478 479
  for (tail = i->plist; !NILP (tail); tail = Fcdr (Fcdr (tail)))
    {
      register Lisp_Object tem;
      tem = Fcar (tail);
      if (EQ (prop, tem))
	return Fcar (Fcdr (tail));
    }
  return Qnil;
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
480
DEFUN ("next-property-change", Fnext_property_change,
481 482 483 484 485 486 487
       Snext_property_change, 1, 2, 0,
  "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\
If the value is non-nil, it is a position greater than POS, never equal.")
Joseph Arceneaux's avatar
Joseph Arceneaux committed
488 489 490 491 492
  (pos, object)
     Lisp_Object pos, object;
{
  register INTERVAL i, next;

493 494 495
  if (NILP (object))
    XSET (object, Lisp_Buffer, current_buffer);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
496 497 498 499 500 501 502 503 504 505 506
  i = validate_interval_range (object, &pos, &pos, soft);
  if (NULL_INTERVAL_P (i))
    return Qnil;

  next = next_interval (i);
  while (! NULL_INTERVAL_P (next) && intervals_equal (i, next))
    next = next_interval (next);

  if (NULL_INTERVAL_P (next))
    return Qnil;

507 508
  return next->position - (XTYPE (object) == Lisp_String);
;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
509 510
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
511
DEFUN ("next-single-property-change", Fnext_single_property_change,
512 513 514 515 516 517 518 519 520
       Snext_single_property_change, 1, 3, 0,
  "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\
Return nil if the property is constant all the way to the end of OBJECT.\n\
If the value is non-nil, it is a position greater than POS, never equal.")
  (pos, prop, object)
     Lisp_Object pos, prop, object;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
521 522 523 524
{
  register INTERVAL i, next;
  register Lisp_Object here_val;

525 526 527
  if (NILP (object))
    XSET (object, Lisp_Buffer, current_buffer);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
528 529 530 531 532 533 534 535 536 537 538 539
  i = validate_interval_range (object, &pos, &pos, soft);
  if (NULL_INTERVAL_P (i))
    return Qnil;

  here_val = Fget (prop, i->plist);
  next = next_interval (i);
  while (! NULL_INTERVAL_P (next) && EQ (here_val, Fget (prop, next->plist)))
    next = next_interval (next);

  if (NULL_INTERVAL_P (next))
    return Qnil;

540
  return next->position - (XTYPE (object) == Lisp_String);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
541 542
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
543
DEFUN ("previous-property-change", Fprevious_property_change,
544 545 546 547 548 549 550
       Sprevious_property_change, 1, 2, 0,
  "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\
If the value is non-nil, it is a position less than POS, never equal.")
Joseph Arceneaux's avatar
Joseph Arceneaux committed
551 552 553 554 555
  (pos, object)
     Lisp_Object pos, object;
{
  register INTERVAL i, previous;

556 557 558
  if (NILP (object))
    XSET (object, Lisp_Buffer, current_buffer);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
559 560 561 562 563 564 565 566 567 568
  i = validate_interval_range (object, &pos, &pos, soft);
  if (NULL_INTERVAL_P (i))
    return Qnil;

  previous = previous_interval (i);
  while (! NULL_INTERVAL_P (previous) && intervals_equal (previous, i))
    previous = previous_interval (previous);
  if (NULL_INTERVAL_P (previous))
    return Qnil;

569 570
  return (previous->position + LENGTH (previous) - 1
	  - (XTYPE (object) == Lisp_String));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
571 572
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
573
DEFUN ("previous-single-property-change", Fprevious_single_property_change,
574 575 576 577 578 579 580 581 582
       Sprevious_single_property_change, 2, 3, 0,
  "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\
Return nil if the property is constant all the way to the start of OBJECT.\n\
If the value is non-nil, it is a position less than POS, never equal.")
     (pos, prop, object)
     Lisp_Object pos, prop, object;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
583 584 585 586
{
  register INTERVAL i, previous;
  register Lisp_Object here_val;

587 588 589
  if (NILP (object))
    XSET (object, Lisp_Buffer, current_buffer);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
590 591 592 593 594 595 596 597 598 599 600 601
  i = validate_interval_range (object, &pos, &pos, soft);
  if (NULL_INTERVAL_P (i))
    return Qnil;

  here_val = Fget (prop, i->plist);
  previous = previous_interval (i);
  while (! NULL_INTERVAL_P (previous)
	 && EQ (here_val, Fget (prop, previous->plist)))
    previous = previous_interval (previous);
  if (NULL_INTERVAL_P (previous))
    return Qnil;

602 603
  return (previous->position + LENGTH (previous) - 1
	  - (XTYPE (object) == Lisp_String));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
604 605
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
606
DEFUN ("add-text-properties", Fadd_text_properties,
607 608 609 610 611 612 613 614 615
       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
616 617 618 619 620 621 622 623
{
  register INTERVAL i, unchanged;
  register int s, len, modified;

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

624 625 626
  if (NILP (object))
    XSET (object, Lisp_Buffer, current_buffer);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
627 628 629 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
  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;
	}
      else
	{
	  unchanged = i;
	  i = split_interval_right (unchanged, s - unchanged->position + 1);
	  copy_properties (unchanged, i);
	  if (LENGTH (i) > len)
	    {
	      i = split_interval_left (i, len + 1);
	      copy_properties (unchanged, i);
656
	      add_properties (properties, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
657 658 659
	      return Qt;
	    }

660
	  add_properties (properties, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
661 662 663 664 665 666 667
	  modified = 1;
	  len -= LENGTH (i);
	  i = next_interval (i);
	}
    }

  /* We are at the beginning of an interval, with len to scan */
668
  while (len > 0)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
669
    {
670 671 672
      if (i == 0)
	abort ();

Joseph Arceneaux's avatar
Joseph Arceneaux committed
673 674 675 676 677 678 679
      if (LENGTH (i) >= len)
	{
	  if (interval_has_all_properties (properties, i))
	    return modified ? Qt : Qnil;

	  if (LENGTH (i) == len)
	    {
680
	      add_properties (properties, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
681 682 683 684 685 686 687
	      return Qt;
	    }

	  /* i doesn't have the properties, and goes past the change limit */
	  unchanged = i;
	  i = split_interval_left (unchanged, len + 1);
	  copy_properties (unchanged, i);
688
	  add_properties (properties, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
689 690 691 692
	  return Qt;
	}

      len -= LENGTH (i);
693
      modified += add_properties (properties, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
694 695 696 697
      i = next_interval (i);
    }
}

698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713
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
714
DEFUN ("set-text-properties", Fset_text_properties,
715 716 717 718 719 720 721
       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
722 723
{
  register INTERVAL i, unchanged;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
724
  register INTERVAL prev_changed = NULL_INTERVAL;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
725 726
  register int s, len;

727 728
  props = validate_plist (props);
  if (NILP (props))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
729 730
    return Qnil;

731 732 733
  if (NILP (object))
    XSET (object, Lisp_Buffer, current_buffer);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
734 735 736 737 738 739 740 741 742 743 744
  i = validate_interval_range (object, &start, &end, hard);
  if (NULL_INTERVAL_P (i))
    return Qnil;

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

  if (i->position != s)
    {
      unchanged = i;
      i = split_interval_right (unchanged, s - unchanged->position + 1);
745
      set_properties (props, i, object);
746

Joseph Arceneaux's avatar
Joseph Arceneaux committed
747 748
      if (LENGTH (i) > len)
	{
Joseph Arceneaux's avatar
Joseph Arceneaux committed
749 750
	  i = split_interval_right (i, len);
	  copy_properties (unchanged, i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
751 752 753
	  return Qt;
	}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
754 755 756 757
      if (LENGTH (i) == len)
	return Qt;

      prev_changed = i;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
758 759 760 761
      len -= LENGTH (i);
      i = next_interval (i);
    }

762
  /* We are starting at the beginning of an interval, I */
763
  while (len > 0)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
764
    {
765 766 767
      if (i == 0)
	abort ();

Joseph Arceneaux's avatar
Joseph Arceneaux committed
768 769
      if (LENGTH (i) >= len)
	{
770 771
	  if (LENGTH (i) > len)
	    i = split_interval_left (i, len + 1);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
772

Joseph Arceneaux's avatar
Joseph Arceneaux committed
773
	  if (NULL_INTERVAL_P (prev_changed))
774
	    set_properties (props, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
775 776
	  else
	    merge_interval_left (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
777 778 779 780
	  return Qt;
	}

      len -= LENGTH (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
781 782
      if (NULL_INTERVAL_P (prev_changed))
	{
783
	  set_properties (props, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
784 785 786 787 788
	  prev_changed = i;
	}
      else
	prev_changed = i = merge_interval_left (i);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
789 790 791 792 793 794 795
      i = next_interval (i);
    }

  return Qt;
}

DEFUN ("remove-text-properties", Fremove_text_properties,
796 797 798 799 800 801 802 803 804 805
       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
806 807 808 809
{
  register INTERVAL i, unchanged;
  register int s, len, modified;

810 811 812
  if (NILP (object))
    XSET (object, Lisp_Buffer, current_buffer);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
813 814 815 816 817 818
  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
819

Joseph Arceneaux's avatar
Joseph Arceneaux committed
820 821 822 823
  if (i->position != s)
    {
      /* No properties on this first interval -- return if
         it covers the entire region. */
824
      if (! interval_has_some_properties (props, i))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841
	{
	  int got = (LENGTH (i) - (s - i->position));
	  if (got >= len)
	    return Qnil;
	  len -= got;
	}
      /* Remove the properties from this interval.  If it's short
         enough, return, splitting it if it's too short. */
      else
	{
	  unchanged = i;
	  i = split_interval_right (unchanged, s - unchanged->position + 1);
	  copy_properties (unchanged, i);
	  if (LENGTH (i) > len)
	    {
	      i = split_interval_left (i, len + 1);
	      copy_properties (unchanged, i);
842
	      remove_properties (props, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
843 844 845
	      return Qt;
	    }

846
	  remove_properties (props, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
847 848 849 850 851 852 853
	  modified = 1;
	  len -= LENGTH (i);
	  i = next_interval (i);
	}
    }

  /* We are at the beginning of an interval, with len to scan */
854
  while (len > 0)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
855
    {
856 857 858
      if (i == 0)
	abort ();

Joseph Arceneaux's avatar
Joseph Arceneaux committed
859 860
      if (LENGTH (i) >= len)
	{
861
	  if (! interval_has_some_properties (props, i))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
862 863 864 865
	    return modified ? Qt : Qnil;

	  if (LENGTH (i) == len)
	    {
866
	      remove_properties (props, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
867 868 869 870 871 872
	      return Qt;
	    }

	  /* i has the properties, and goes past the change limit */
	  unchanged = split_interval_right (i, len + 1);
	  copy_properties (unchanged, i);
873
	  remove_properties (props, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
874 875 876 877
	  return Qt;
	}

      len -= LENGTH (i);
878
      modified += remove_properties (props, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
879 880 881 882
      i = next_interval (i);
    }
}

883 884
#if 0 /* You can use set-text-properties for this.  */

Joseph Arceneaux's avatar
Joseph Arceneaux committed
885
DEFUN ("erase-text-properties", Ferase_text_properties,
886 887 888 889 890 891
       Serase_text_properties, 2, 3, 0,
  "Remove all properties from the text from START to END.\n\
The optional third argument, OBJECT,\n\
is the string or buffer containing the text.")
  (start, end, object)
     Lisp_Object start, end, object;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
892
{
893
  register INTERVAL i;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
894
  register INTERVAL prev_changed = NULL_INTERVAL;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
895 896
  register int s, len, modified;

897 898 899
  if (NILP (object))
    XSET (object, Lisp_Buffer, current_buffer);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
900 901 902 903 904 905
  i = validate_interval_range (object, &start, &end, soft);
  if (NULL_INTERVAL_P (i))
    return Qnil;

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

Joseph Arceneaux's avatar
Joseph Arceneaux committed
907 908
  if (i->position != s)
    {
909
      register int got;
910
      register INTERVAL unchanged = i;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
911

912
      /* If there are properties here, then this text will be modified. */
913
      if (! NILP (i->plist))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
914 915
	{
	  i = split_interval_right (unchanged, s - unchanged->position + 1);
916
	  i->plist = Qnil;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
917
	  modified++;
918 919 920 921 922 923 924 925 926 927 928 929

	  if (LENGTH (i) > len)
	    {
	      i = split_interval_right (i, len + 1);
	      copy_properties (unchanged, i);
	      return Qt;
	    }

	  if (LENGTH (i) == len)
	    return Qt;

	  got = LENGTH (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
930
	}
931 932 933
      /* If the text of I is without any properties, and contains
         LEN or more characters, then we may return without changing
	 anything.*/
934 935
      else if (LENGTH (i) - (s - i->position) <= len)
	return Qnil;
936 937
      /* The amount of text to change extends past I, so just note
	 how much we've gotten. */
938 939
      else
	got = LENGTH (i) - (s - i->position);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
940 941

      len -= got;
942
      prev_changed = i;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
943 944 945
      i = next_interval (i);
    }

946
  /* We are starting at the beginning of an interval, I. */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
947 948
  while (len > 0)
    {
949
      if (LENGTH (i) >= len)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
950
	{
951 952
	  /* If I has no properties, simply merge it if possible.  */
	  if (NILP (i->plist))
953 954 955
	    {
	      if (! NULL_INTERVAL_P (prev_changed))
		merge_interval_left (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
956

957 958 959
	      return modified ? Qt : Qnil;
	    }

960 961
          if (LENGTH (i) > len)
            i = split_interval_left (i, len + 1);
962 963
	  if (! NULL_INTERVAL_P (prev_changed))
	    merge_interval_left (i);
964 965
	  else
	    i->plist = Qnil;
966

967
	  return Qt;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
968 969
	}

970
      /* Here if we still need to erase past the end of I */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
971
      len -= LENGTH (i);
972 973 974 975 976 977 978
      if (NULL_INTERVAL_P (prev_changed))
	{
	  modified += erase_properties (i);
	  prev_changed = i;
	}
      else
	{
979 980
	  modified += ! NILP (i->plist);
	  /* Merging I will give it the properties of PREV_CHANGED. */
981 982 983
	  prev_changed = i = merge_interval_left (i);
	}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
984 985 986 987 988
      i = next_interval (i);
    }

  return modified ? Qt : Qnil;
}
989
#endif /* 0 */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
990 991 992 993 994

void
syms_of_textprop ()
{
  DEFVAR_INT ("interval-balance-threshold", &interval_balance_threshold,
995
	      "Threshold for rebalancing interval trees, expressed as the\n\
Joseph Arceneaux's avatar
Joseph Arceneaux committed
996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
percentage by which the left interval tree should not differ from the right.");
  interval_balance_threshold = 8;

  /* Common attributes one might give text */

  staticpro (&Qforeground);
  Qforeground = intern ("foreground");
  staticpro (&Qbackground);
  Qbackground = intern ("background");
  staticpro (&Qfont);
  Qfont = intern ("font");
  staticpro (&Qstipple);
  Qstipple = intern ("stipple");
  staticpro (&Qunderline);
  Qunderline = intern ("underline");
  staticpro (&Qread_only);
  Qread_only = intern ("read-only");
  staticpro (&Qinvisible);
  Qinvisible = intern ("invisible");

  /* Properties that text might use to specify certain actions */

  staticpro (&Qmouse_left);
  Qmouse_left = intern ("mouse-left");
  staticpro (&Qmouse_entered);
  Qmouse_entered = intern ("mouse-entered");
  staticpro (&Qpoint_left);
  Qpoint_left = intern ("point-left");
  staticpro (&Qpoint_entered);
  Qpoint_entered = intern ("point-entered");
1026 1027
  staticpro (&Qmodification_hooks);
  Qmodification_hooks = intern ("modification-hooks");
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1028 1029

  defsubr (&Stext_properties_at);
1030
  defsubr (&Sget_text_property);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1031
  defsubr (&Snext_property_change);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1032
  defsubr (&Snext_single_property_change);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1033
  defsubr (&Sprevious_property_change);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1034
  defsubr (&Sprevious_single_property_change);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1035
  defsubr (&Sadd_text_properties);
1036
  defsubr (&Sput_text_property);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1037 1038
  defsubr (&Sset_text_properties);
  defsubr (&Sremove_text_properties);
1039
/*  defsubr (&Serase_text_properties); */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1040
}
1041 1042 1043 1044 1045 1046

#else

lose -- this shouldn't be compiled if USE_TEXT_PROPERTIES isn't defined

#endif /* USE_TEXT_PROPERTIES */