textprop.c 38.4 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

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"
Joseph Arceneaux's avatar
Joseph Arceneaux committed
25 26 27 28 29 30


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

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

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

/* Visual properties text (including strings) may have. */
Lisp_Object Qforeground, Qbackground, Qfont, Qunderline, Qstipple;
52 53 54 55
Lisp_Object Qinvisible, Qread_only, Qhidden;

/* Sticky properties */
Lisp_Object Qfront_sticky, Qrear_nonsticky;
56 57 58 59 60 61

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

62 63
Lisp_Object Vinhibit_point_motion_hooks;

Joseph Arceneaux's avatar
Joseph Arceneaux committed
64

Joseph Arceneaux's avatar
Joseph Arceneaux committed
65 66 67 68 69 70
/* 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
71

72 73 74
   When OBJECT is a string, we increment *BEGIN and *END
   to make them origin-one.

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

#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;
97 98
  int searchpos;

Joseph Arceneaux's avatar
Joseph Arceneaux committed
99 100 101 102 103 104 105 106 107 108 109
  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))
    {
110 111
      Lisp_Object n;
      n = *begin;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
112
      *begin = *end;
113
      *end = n;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
114 115 116 117 118 119 120 121 122 123 124
    }

  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;

125 126 127 128 129
      /* 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
130 131 132 133 134
    }
  else
    {
      register struct Lisp_String *s = XSTRING (object);

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

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

      searchpos = XINT (*begin);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
149 150 151 152 153
    }

  if (NULL_INTERVAL_P (i))
    return (force ? create_root_interval (object) : i);
    
154
  return find_interval (i, searchpos);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
155 156 157 158 159 160 161 162
}

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

  if (CONSP (list))
    {
      register int i;
      register Lisp_Object tail;
      for (i = 0, tail = list; !NILP (tail); i++)
173 174 175 176
	{
	  tail = Fcdr (tail);
	  QUIT;
	}
Joseph Arceneaux's avatar
Joseph Arceneaux committed
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
      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. */
208
	    if (! EQ (Fcar (Fcdr (tail1)), Fcar (Fcdr (tail2))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
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 239 240 241 242 243 244 245
	      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;
}
246

247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
/* Changing the plists of individual intervals.  */

/* Return the value of PROP in property-list PLIST, or Qunbound if it
   has none.  */
static int
property_value (plist, prop)
{
  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;
}

265 266 267 268 269 270 271 272 273
/* 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;
{
274
  Lisp_Object sym, value;
275

276
  if (BUFFERP (object))
277
    {
278 279 280 281 282 283 284
      /* 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))
285 286 287 288 289 290 291 292
	  {
	    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);
	  }
293 294 295 296 297 298 299

      /* 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))
300 301 302 303 304 305 306 307
	  {
	    modify_region (XBUFFER (object),
			   make_number (interval->position),
			   make_number (interval->position + LENGTH (interval)));
	    record_property_change (interval->position, LENGTH (interval),
				    XCONS (sym)->car, Qnil,
				    object);
	  }
308 309 310 311 312
    }

  /* Store new properties.  */
  interval->plist = Fcopy_sequence (properties);
}
Joseph Arceneaux's avatar
Joseph Arceneaux committed
313 314 315 316 317

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

318 319
   OBJECT should be the string or buffer the interval is in.

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

323 324
static int
add_properties (plist, i, object)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
325 326
     Lisp_Object plist;
     INTERVAL i;
327
     Lisp_Object object;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350
{
  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. */
351
	    if (EQ (val1, Fcar (this_cdr)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
352 353
	      break;

354 355 356
	    /* Record this change in the buffer, for undo purposes.  */
	    if (XTYPE (object) == Lisp_Buffer)
	      {
357 358
		modify_region (XBUFFER (object),
			       make_number (i->position),
359
			       make_number (i->position + LENGTH (i)));
360 361
		record_property_change (i->position, LENGTH (i),
					sym1, Fcar (this_cdr), object);
362 363
	      }

Joseph Arceneaux's avatar
Joseph Arceneaux committed
364 365 366 367 368 369 370 371
	    /* I's property has a different value -- change it */
	    Fsetcar (this_cdr, val1);
	    changed++;
	    break;
	  }

      if (! found)
	{
372 373 374
	  /* Record this change in the buffer, for undo purposes.  */
	  if (XTYPE (object) == Lisp_Buffer)
	    {
375 376
	      modify_region (XBUFFER (object),
			     make_number (i->position),
377
			     make_number (i->position + LENGTH (i)));
378 379
	      record_property_change (i->position, LENGTH (i),
				      sym1, Qnil, object);
380
	    }
Joseph Arceneaux's avatar
Joseph Arceneaux committed
381 382 383 384 385 386 387 388 389
	  i->plist = Fcons (sym1, Fcons (val1, i->plist));
	  changed++;
	}
    }

  return changed;
}

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

393 394
static int
remove_properties (plist, i, object)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
395 396
     Lisp_Object plist;
     INTERVAL i;
397
     Lisp_Object object;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
398 399 400 401 402 403 404 405 406 407 408 409 410
{
  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)))
	{
411 412
	  if (XTYPE (object) == Lisp_Buffer)
	    {
413 414
	      modify_region (XBUFFER (object),
			     make_number (i->position),
415
			     make_number (i->position + LENGTH (i)));
416 417 418
	      record_property_change (i->position, LENGTH (i),
				      sym, Fcar (Fcdr (current_plist)),
				      object);
419 420
	    }

Joseph Arceneaux's avatar
Joseph Arceneaux committed
421 422 423 424 425 426 427 428 429 430 431
	  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)))
	    {
432 433
	      if (XTYPE (object) == Lisp_Buffer)
		{
434 435
		  modify_region (XBUFFER (object),
				 make_number (i->position),
436
				 make_number (i->position + LENGTH (i)));
437 438
		  record_property_change (i->position, LENGTH (i),
					  sym, Fcar (Fcdr (this)), object);
439 440
		}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
441 442 443 444 445 446 447 448 449 450 451 452
	      Fsetcdr (Fcdr (tail2), Fcdr (Fcdr (this)));
	      changed++;
	    }
	  tail2 = this;
	}
    }

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

453
#if 0
Joseph Arceneaux's avatar
Joseph Arceneaux committed
454 455 456 457 458 459 460 461 462 463 464 465 466
/* 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;
}
467
#endif
Joseph Arceneaux's avatar
Joseph Arceneaux committed
468 469 470 471 472

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\
473 474
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
475 476 477 478 479 480 481 482 483 484 485
  (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;
486 487 488 489 490 491
  /* 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
492 493 494 495

  return i->plist;
}

496
DEFUN ("get-text-property", Fget_text_property, Sget_text_property, 2, 3, 0,
497
  "Return the value of position POS's property PROP, in OBJECT.\n\
498 499
OBJECT is optional and defaults to the current buffer.\n\
If POSITION is at the end of OBJECT, the value is nil.")
500
  (pos, prop, object)
501
     Lisp_Object pos, object;
502 503 504 505 506 507 508 509 510 511 512
     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;

513 514 515 516 517 518 519
  /* 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;

520
  return textget (i->plist, prop);
521 522
}

523 524 525 526 527
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\
If POSITION is at the end of OBJECT, the value is nil.\n\
If OBJECT is a buffer, then overlay properties are considered as well as\n\
528 529
text properties.\n\
If OBJECT is a window, then that window's buffer is used, but window-specific\n\
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583
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))
    XSET (object, Lisp_Buffer, current_buffer);

  if (WINDOWP (object))
    {
      w = XWINDOW (object);
      XSET (object, Lisp_Buffer, w->buffer);
    }
  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));

      noverlays = overlays_at (posn, 0, &overlay_vec, &len, &next_overlay);

      /* 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));
	  noverlays = overlays_at (posn, 0, &overlay_vec, &len, &next_overlay);
	}
      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
584
DEFUN ("next-property-change", Fnext_property_change,
585
       Snext_property_change, 1, 3, 0,
586 587 588 589 590
  "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\
591 592 593 594 595
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
596 597 598
{
  register INTERVAL i, next;

599 600 601
  if (NILP (object))
    XSET (object, Lisp_Buffer, current_buffer);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
602 603
  i = validate_interval_range (object, &pos, &pos, soft);
  if (NULL_INTERVAL_P (i))
604
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
605 606

  next = next_interval (i);
607 608
  while (! NULL_INTERVAL_P (next) && intervals_equal (i, next)
	 && (NILP (limit) || next->position < XFASTINT (limit)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
609 610 611
    next = next_interval (next);

  if (NULL_INTERVAL_P (next))
612 613 614
    return limit;
  if (! NILP (limit) && !(next->position < XFASTINT (limit)))
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
615

616
  return next->position - (XTYPE (object) == Lisp_String);
617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
}

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

  XSET (object, Lisp_Buffer, current_buffer);
  XFASTINT (pos) = beg;

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

  if (NULL_INTERVAL_P (next))
    return 0;

  return 1;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
649 650
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
651
DEFUN ("next-single-property-change", Fnext_single_property_change,
652
       Snext_single_property_change, 2, 4, 0,
653 654 655 656
  "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\
657
The property values are compared with `eq'.\n\
658
Return nil if the property is constant all the way to the end of OBJECT.\n\
659 660
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
661
past position LIMIT; return LIMIT if nothing is found before LIMIT.")
662 663
  (pos, prop, object, limit)
     Lisp_Object pos, prop, object, limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
664 665 666 667
{
  register INTERVAL i, next;
  register Lisp_Object here_val;

668 669 670
  if (NILP (object))
    XSET (object, Lisp_Buffer, current_buffer);

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
  return next->position - (XTYPE (object) == Lisp_String);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
688 689
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
690
DEFUN ("previous-property-change", Fprevious_property_change,
691
       Sprevious_property_change, 1, 3, 0,
692 693 694 695 696
  "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\
697 698
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
699
back past position LIMIT; return LIMIT if nothing is found until LIMIT.")
700 701
  (pos, object, limit)
     Lisp_Object pos, object, limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
702 703 704
{
  register INTERVAL i, previous;

705 706 707
  if (NILP (object))
    XSET (object, Lisp_Buffer, current_buffer);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
708 709
  i = validate_interval_range (object, &pos, &pos, soft);
  if (NULL_INTERVAL_P (i))
710
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
711

712 713 714 715
  /* 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
716
  previous = previous_interval (i);
717 718 719
  while (! NULL_INTERVAL_P (previous) && intervals_equal (previous, i)
	 && (NILP (limit)
	     || previous->position + LENGTH (previous) > XFASTINT (limit)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
720 721
    previous = previous_interval (previous);
  if (NULL_INTERVAL_P (previous))
722 723 724 725
    return limit;
  if (!NILP (limit)
      && !(previous->position + LENGTH (previous) > XFASTINT (limit)))
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
726

727
  return (previous->position + LENGTH (previous)
728
	  - (XTYPE (object) == Lisp_String));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
729 730
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
731
DEFUN ("previous-single-property-change", Fprevious_single_property_change,
732
       Sprevious_single_property_change, 2, 4, 0,
733 734 735 736
  "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\
737
The property values are compared with `eq'.\n\
738
Return nil if the property is constant all the way to the start of OBJECT.\n\
739 740
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
741
back past position LIMIT; return LIMIT if nothing is found until LIMIT.")
742 743
     (pos, prop, object, limit)
     Lisp_Object pos, prop, object, limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
744 745 746 747
{
  register INTERVAL i, previous;
  register Lisp_Object here_val;

748 749 750
  if (NILP (object))
    XSET (object, Lisp_Buffer, current_buffer);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
751 752
  i = validate_interval_range (object, &pos, &pos, soft);
  if (NULL_INTERVAL_P (i))
753
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
754

755 756 757 758
  /* Start with the interval containing the char before point.  */
  if (i->position == XFASTINT (pos))
    i = previous_interval (i);

759
  here_val = textget (i->plist, prop);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
760 761
  previous = previous_interval (i);
  while (! NULL_INTERVAL_P (previous)
762 763 764
	 && EQ (here_val, textget (previous->plist, prop))
	 && (NILP (limit)
	     || previous->position + LENGTH (previous) > XFASTINT (limit)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
765 766
    previous = previous_interval (previous);
  if (NULL_INTERVAL_P (previous))
767 768 769 770
    return limit;
  if (!NILP (limit)
      && !(previous->position + LENGTH (previous) > XFASTINT (limit)))
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
771

772
  return (previous->position + LENGTH (previous)
773
	  - (XTYPE (object) == Lisp_String));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
774 775
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
776
DEFUN ("add-text-properties", Fadd_text_properties,
777 778 779 780 781 782 783 784 785
       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
786 787
{
  register INTERVAL i, unchanged;
788
  register int s, len, modified = 0;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
789 790 791 792 793

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

794 795 796
  if (NILP (object))
    XSET (object, Lisp_Buffer, current_buffer);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815
  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;
816
	  i = next_interval (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
817 818 819 820
	}
      else
	{
	  unchanged = i;
821
	  i = split_interval_right (unchanged, s - unchanged->position);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
822 823 824 825
	  copy_properties (unchanged, i);
	}
    }

826
  /* We are at the beginning of interval I, with LEN chars to scan.  */
827
  for (;;)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
828
    {
829 830 831
      if (i == 0)
	abort ();

Joseph Arceneaux's avatar
Joseph Arceneaux committed
832 833 834 835 836 837 838
      if (LENGTH (i) >= len)
	{
	  if (interval_has_all_properties (properties, i))
	    return modified ? Qt : Qnil;

	  if (LENGTH (i) == len)
	    {
839
	      add_properties (properties, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
840 841 842 843 844
	      return Qt;
	    }

	  /* i doesn't have the properties, and goes past the change limit */
	  unchanged = i;
845
	  i = split_interval_left (unchanged, len);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
846
	  copy_properties (unchanged, i);
847
	  add_properties (properties, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
848 849 850 851
	  return Qt;
	}

      len -= LENGTH (i);
852
      modified += add_properties (properties, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
853 854 855 856
      i = next_interval (i);
    }
}

857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872
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
873
DEFUN ("set-text-properties", Fset_text_properties,
874 875 876 877 878 879 880
       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
881 882
{
  register INTERVAL i, unchanged;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
883
  register INTERVAL prev_changed = NULL_INTERVAL;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
884 885
  register int s, len;

886
  props = validate_plist (props);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
887

888 889 890
  if (NILP (object))
    XSET (object, Lisp_Buffer, current_buffer);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
891 892 893 894 895 896 897 898 899 900
  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;
901
      i = split_interval_right (unchanged, s - unchanged->position);
902

Joseph Arceneaux's avatar
Joseph Arceneaux committed
903 904
      if (LENGTH (i) > len)
	{
Joseph Arceneaux's avatar
Joseph Arceneaux committed
905
	  copy_properties (unchanged, i);
906
	  i = split_interval_left (i, len);
907
	  set_properties (props, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
908 909 910
	  return Qt;
	}

911 912
      set_properties (props, i, object);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
913 914 915 916
      if (LENGTH (i) == len)
	return Qt;

      prev_changed = i;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
917 918 919 920
      len -= LENGTH (i);
      i = next_interval (i);
    }

921
  /* We are starting at the beginning of an interval, I */
922
  while (len > 0)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
923
    {
924 925 926
      if (i == 0)
	abort ();

Joseph Arceneaux's avatar
Joseph Arceneaux committed
927 928
      if (LENGTH (i) >= len)
	{
929
	  if (LENGTH (i) > len)
930
	    i = split_interval_left (i, len);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
931

Joseph Arceneaux's avatar
Joseph Arceneaux committed
932
	  if (NULL_INTERVAL_P (prev_changed))
933
	    set_properties (props, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
934 935
	  else
	    merge_interval_left (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
936 937 938 939
	  return Qt;
	}

      len -= LENGTH (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
940 941
      if (NULL_INTERVAL_P (prev_changed))
	{
942
	  set_properties (props, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
943 944 945 946 947
	  prev_changed = i;
	}
      else
	prev_changed = i = merge_interval_left (i);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
948 949 950 951 952 953 954
      i = next_interval (i);
    }

  return Qt;
}

DEFUN ("remove-text-properties", Fremove_text_properties,
955 956 957 958 959 960 961 962 963 964
       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
965 966
{
  register INTERVAL i, unchanged;
967
  register int s, len, modified = 0;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
968

969 970 971
  if (NILP (object))
    XSET (object, Lisp_Buffer, current_buffer);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
972 973 974 975 976 977
  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
978

Joseph Arceneaux's avatar
Joseph Arceneaux committed
979 980 981 982
  if (i->position != s)
    {
      /* No properties on this first interval -- return if
         it covers the entire region. */
983
      if (! interval_has_some_properties (props, i))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
984 985 986 987 988
	{
	  int got = (LENGTH (i) - (s - i->position));
	  if (got >= len)
	    return Qnil;
	  len -= got;
989
	  i = next_interval (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
990
	}
991 992
      /* Split away the beginning of this interval; what we don't
	 want to modify.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
993 994 995
      else
	{
	  unchanged = i;
996
	  i = split_interval_right (unchanged, s - unchanged->position);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
997 998 999 1000 1001
	  copy_properties (unchanged, i);
	}
    }

  /* We are at the beginning of an interval, with len to scan */
1002
  for (;;)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1003
    {
1004 1005 1006
      if (i == 0)
	abort ();

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1007 1008
      if (LENGTH (i) >= len)
	{
1009
	  if (! interval_has_some_properties (props, i))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1010 1011 1012 1013
	    return modified ? Qt : Qnil;

	  if (LENGTH (i) == len)
	    {
1014
	      remove_properties (props, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1015 1016 1017 1018
	      return Qt;
	    }

	  /* i has the properties, and goes past the change limit */
1019
	  unchanged = i;
1020
	  i = split_interval_left (i, len);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1021
	  copy_properties (unchanged, i);
1022
	  remove_properties (props, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1023 1024 1025 1026
	  return Qt;
	}

      len -= LENGTH (i);
1027
      modified += remove_properties (props, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1028 1029 1030 1031
      i = next_interval (i);
    }
}

1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082
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))
    XSET (object, Lisp_Buffer, current_buffer);
  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);
	  return make_number (pos - (XTYPE (object) == Lisp_String));
	}
      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))
    XSET (object, Lisp_Buffer, current_buffer);
  i = validate_interval_range (object, &start, &end, soft);
  if (NULL_INTERVAL_P (i))
1083
    return (NILP (value) || EQ (start, end)) ? Qnil : start;
1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101
  s = XINT (start);
  e = XINT (end);

  while (! NULL_INTERVAL_P (i))
    {
      if (i->position >= e)
	break;
      if (! EQ (textget (i->plist, prop), value))
	{
	  if (i->position > s)
	    s = i->position;
	  return make_number (s - (XTYPE (object) == Lisp_String));
	}
      i = next_interval (i);
    }
  return Qnil;
}

1102 1103
#if 0 /* You can use set-text-properties for this.  */

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1104
DEFUN ("erase-text-properties", Ferase_text_properties,
1105 1106 1107 1108 1109 1110
       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
1111
{
1112
  register INTERVAL i;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1113
  register INTERVAL prev_changed = NULL_INTERVAL;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1114 1115
  register int s, len, modified;

1116 1117 1118
  if (NILP (object))
    XSET (object, Lisp_Buffer, current_buffer);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1119 1120 1121 1122 1123 1124
  i = validate_interval_range (object, &start, &end, soft);
  if (NULL_INTERVAL_P (i))
    return Qnil;

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

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1126 1127
  if (i->position != s)
    {
1128
      register int got;
1129
      register INTERVAL unchanged = i;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1130

1131
      /* If there are properties here, then this text will be modified. */
1132
      if (! NILP (i->plist))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1133
	{
1134
	  i = split_interval_right (unchanged, s - unchanged->position);
1135
	  i->plist = Qnil;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1136
	  modified++;
1137 1138 1139

	  if (LENGTH (i) > len)
	    {
1140
	      i = split_interval_right (i, len);
1141 1142 1143 1144 1145 1146 1147 1148
	      copy_properties (unchanged, i);
	      return Qt;
	    }

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

	  got = LENGTH (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1149
	}
1150 1151 1152
      /* If the text of I is without any properties, and contains
         LEN or more characters, then we may return without changing
	 anything.*/
1153 1154
      else if (LENGTH (i) - (s - i->position) <= len)
	return Qnil;
1155 1156
      /* The amount of text to change extends past I, so just note
	 how much we've gotten. */
1157 1158
      else
	got = LENGTH (i) - (s - i->position);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1159 1160

      len -= got;
1161
      prev_changed = i;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1162 1163 1164
      i = next_interval (i);
    }

1165
  /* We are starting at the beginning of an interval, I. */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1166 1167
  while (len > 0)
    {
1168
      if (LENGTH (i) >= len)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1169
	{
1170 1171
	  /* If I has no properties, simply merge it if possible.  */
	  if (NILP (i->plist))
1172 1173 1174
	    {
	      if (! NULL_INTERVAL_P (prev_changed))
		merge_interval_left (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1175

1176 1177 1178
	      return modified ? Qt : Qnil;
	    }

1179
          if (LENGTH (i) > len)
1180
            i = split_interval_left (i, len);
1181 1182
	  if (! NULL_INTERVAL_P (prev_changed))
	    merge_interval_left (i);
1183 1184
	  else
	    i->plist = Qnil;
1185

1186
	  return Qt;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1187 1188
	}

1189
      /* Here if we still need to erase past the end of I */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1190
      len -= LENGTH (i);
1191 1192 1193 1194 1195 1196 1197
      if (NULL_INTERVAL_P (prev_changed))
	{
	  modified += erase_properties (i);
	  prev_changed = i;
	}
      else
	{
1198 1199
	  modified += ! NILP (i->plist);
	  /* Merging I will give it the properties of PREV_CHANGED. */
1200 1201 1202
	  prev_changed = i = merge_interval_left (i);
	}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1203 1204 1205 1206 1207
      i = next_interval (i);
    }

  return modified ? Qt : Qnil;
}
1208
#endif /* 0 */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1209

1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305
/* I don't think this is the right interface to export; how often do you
   want to do something like this, other than when you're copying objects
   around?

   I think it would be better to have a pair of functions, one which
   returns the text properties of a region as a list of ranges and
   plists, and another which applies such a list to another object.  */

/* DEFUN ("copy-text-properties", Fcopy_text_properties,
       Scopy_text_properties, 5, 6, 0,
  "Add properties from SRC-START to SRC-END of SRC at DEST-POS of DEST.\n\
SRC and DEST may each refer to strings or buffers.\n\
Optional sixth argument PROP causes only that property to be copied.\n\
Properties are copied to DEST as if by `add-text-properties'.\n\
Return t if any property value actually changed, nil otherwise.") */

Lisp_Object
copy_text_properties (start, end, src, pos, dest, prop)
       Lisp_Object start, end, src, pos, dest, prop;
{
  INTERVAL i;
  Lisp_Object res;
  Lisp_Object stuff;
  Lisp_Object plist;
  int s, e, e2, p, len, modified = 0;

  i = validate_interval_range (src, &start, &end, soft);
  if (NULL_INTERVAL_P (i))
    return Qnil;

  CHECK_NUMBER_COERCE_MARKER (pos, 0);
  {
    Lisp_Object dest_start, dest_end;

    dest_start = pos;
    XFASTINT (dest_end) = XINT (dest_start) + (XINT (end) - XINT (start));
    /* Apply this to a copy of pos; it will try to increment its arguments,
       which we don't want.  */
    validate_interval_range (dest, &dest_start, &dest_end, soft);
  }

  s = XINT (start);
  e = XINT (end);
  p = XINT (pos);

  stuff = Qnil;

  while (s < e)
    {
      e2 = i->position + LENGTH (i);
      if (e2 > e)
	e2 = e;
      len = e2 - s;

      plist = i->plist;
      if (! NILP (prop))
	while (! NILP (plist))
	  {
	    if (EQ (Fcar (plist), prop))
	      {
		plist = Fcons (prop, Fcons (Fcar (Fcdr (plist)), Qnil));
		break;
	      }
	    plist = Fcdr (Fcdr (plist));
	  }
      if (! NILP (plist))
	{
	  /* Must defer modifications to the interval tree in case src
	     and dest refer to the same string or buffer. */
	  stuff = Fcons (Fcons (make_number (p),
				Fcons (make_number (p + len),
				       Fcons (plist, Qnil))),
			stuff);
	}

      i = next_interval (i);
      if (NULL_INTERVAL_P (i))
	break;

      p += len;
      s = i->position;
    }

  while (! NILP (stuff))
    {
      res = Fcar (stuff);
      res = Fadd_text_properties (Fcar (res), Fcar (Fcdr (res)),
				  Fcar (Fcdr (Fcdr (res))), dest);
      if (! NILP (res))
	modified++;
      stuff = Fcdr (stuff);
    }

  return modified ? Qt : Qnil;
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1306 1307 1308 1309
void
syms_of_textprop ()
{
  DEFVAR_INT ("interval-balance-threshold", &interval_balance_threshold,
1310
	      "Threshold for rebalancing interval trees, expressed as the\n\
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1311 1312 1313
percentage by which the left interval tree should not differ from the right.");
  interval_balance_threshold = 8;

1314
  DEFVAR_LISP ("inhibit-point-motion-hooks", &Vinhibit_point_motion_hooks,
Richard M. Stallman's avatar
Richard M. Stallman committed
1315
	       "If non-nil, don't call the text property values of\n\
1316 1317 1318
`point-left' and `point-entered'.");
  Vinhibit_point_motion_hooks = Qnil;
	       
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334
  /* 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");
1335 1336
  staticpro (&Qhidden);
  Qhidden = intern ("hidden");
1337 1338 1339 1340
  staticpro (&Qcategory);
  Qcategory = intern ("category");
  staticpro (&Qlocal_map);
  Qlocal_map = intern ("local-map");
1341 1342 1343 1344
  staticpro (&Qfront_sticky);
  Qfront_sticky = intern ("front-sticky");
  staticpro (&Qrear_nonsticky);
  Qrear_nonsticky = intern ("rear-nonsticky");
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357

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

  defsubr (&Stext_properties_at);
1358
  defsubr (&Sget_text_property);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1359
  defsubr (&Snext_property_change);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1360
  defsubr (&Snext_single_property_change);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1361
  defsubr (&Sprevious_property_change);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1362
  defsubr (&Sprevious_single_property_change);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1363
  defsubr (&Sadd_text_properties);
1364
  defsubr (&Sput_text_property);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1365 1366
  defsubr (&Sset_text_properties);
  defsubr (&Sremove_text_properties);
1367 1368
  defsubr (&Stext_property_any);
  defsubr (&Stext_property_not_all);
1369
/*  defsubr (&Serase_text_properties); */
1370
/*  defsubr (&Scopy_text_properties); */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1371
}
1372 1373 1374 1375 1376 1377

#else

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

#endif /* USE_TEXT_PROPERTIES */