textprop.c 36.2 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 24 25 26 27 28 29
#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
  handles the more general case, the uniqueness of properties is
35
  necessary for the system to remain consistent.  This requirement
Joseph Arceneaux's avatar
Joseph Arceneaux committed
36 37
  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 47
Lisp_Object Qcategory;
Lisp_Object Qlocal_map;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
48 49 50

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

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

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

61 62
Lisp_Object Vinhibit_point_motion_hooks;

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

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

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

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

Joseph Arceneaux's avatar
Joseph Arceneaux committed
98 99 100 101 102 103 104 105 106 107 108
  CHECK_STRING_OR_BUFFER (object, 0);
  CHECK_NUMBER_COERCE_MARKER (*begin, 0);
  CHECK_NUMBER_COERCE_MARKER (*end, 0);

  /* If we are asked for a point, but from a subr which operates
     on a range, then return nothing. */
  if (*begin == *end && begin != end)
    return NULL_INTERVAL;

  if (XINT (*begin) > XINT (*end))
    {
109 110
      Lisp_Object n;
      n = *begin;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
111
      *begin = *end;
112
      *end = n;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
113 114 115 116 117 118 119 120 121 122 123
    }

  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;

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

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

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

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

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

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

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

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

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

      /* 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))
299 300 301 302 303 304 305 306
	  {
	    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);
	  }
307 308 309 310 311
    }

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

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

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

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

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

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

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

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

  return changed;
}

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

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

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

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

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

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

  return i->plist;
}

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

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

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

Joseph Arceneaux's avatar
Joseph Arceneaux committed
522
DEFUN ("next-property-change", Fnext_property_change,
523
       Snext_property_change, 1, 3, 0,
524 525 526 527 528
  "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\
529 530 531 532 533
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
534 535 536
{
  register INTERVAL i, next;

537 538 539
  if (NILP (object))
    XSET (object, Lisp_Buffer, current_buffer);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
540 541
  i = validate_interval_range (object, &pos, &pos, soft);
  if (NULL_INTERVAL_P (i))
542
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
543 544

  next = next_interval (i);
545 546
  while (! NULL_INTERVAL_P (next) && intervals_equal (i, next)
	 && (NILP (limit) || next->position < XFASTINT (limit)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
547 548 549
    next = next_interval (next);

  if (NULL_INTERVAL_P (next))
550 551 552
    return limit;
  if (! NILP (limit) && !(next->position < XFASTINT (limit)))
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
553

554
  return next->position - (XTYPE (object) == Lisp_String);
555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576
}

/* 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);
577 578
      if (NULL_INTERVAL_P (next))
	return 0;
579 580 581 582 583 584 585 586
      if (next->position >= end)
	return 0;
    }

  if (NULL_INTERVAL_P (next))
    return 0;

  return 1;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
587 588
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
589
DEFUN ("next-single-property-change", Fnext_single_property_change,
590
       Snext_single_property_change, 2, 4, 0,
591 592 593 594
  "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\
595
The property values are compared with `eq'.\n\
596
Return nil if the property is constant all the way to the end of OBJECT.\n\
597 598 599 600 601
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\
past position LIMIT; fail if nothing is found before LIMIT.")
  (pos, prop, object, limit)
     Lisp_Object pos, prop, object, limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
602 603 604 605
{
  register INTERVAL i, next;
  register Lisp_Object here_val;

606 607 608
  if (NILP (object))
    XSET (object, Lisp_Buffer, current_buffer);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
609 610
  i = validate_interval_range (object, &pos, &pos, soft);
  if (NULL_INTERVAL_P (i))
611
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
612

613
  here_val = textget (i->plist, prop);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
614
  next = next_interval (i);
615
  while (! NULL_INTERVAL_P (next) 
616 617
	 && EQ (here_val, textget (next->plist, prop))
	 && (NILP (limit) || next->position < XFASTINT (limit)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
618 619 620
    next = next_interval (next);

  if (NULL_INTERVAL_P (next))
621 622 623
    return limit;
  if (! NILP (limit) && !(next->position < XFASTINT (limit)))
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
624

625
  return next->position - (XTYPE (object) == Lisp_String);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
626 627
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
628
DEFUN ("previous-property-change", Fprevious_property_change,
629
       Sprevious_property_change, 1, 3, 0,
630 631 632 633 634
  "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\
635 636 637 638 639
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\
back past position LIMIT; fail if nothing is found before LIMIT.")
  (pos, object, limit)
     Lisp_Object pos, object, limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
640 641 642
{
  register INTERVAL i, previous;

643 644 645
  if (NILP (object))
    XSET (object, Lisp_Buffer, current_buffer);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
646 647
  i = validate_interval_range (object, &pos, &pos, soft);
  if (NULL_INTERVAL_P (i))
648
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
649 650

  previous = previous_interval (i);
651 652 653
  while (! NULL_INTERVAL_P (previous) && intervals_equal (previous, i)
	 && (NILP (limit)
	     || previous->position + LENGTH (previous) > XFASTINT (limit)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
654 655
    previous = previous_interval (previous);
  if (NULL_INTERVAL_P (previous))
656 657 658 659
    return limit;
  if (!NILP (limit)
      && !(previous->position + LENGTH (previous) > XFASTINT (limit)))
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
660

661
  return (previous->position + LENGTH (previous)
662
	  - (XTYPE (object) == Lisp_String));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
663 664
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
665
DEFUN ("previous-single-property-change", Fprevious_single_property_change,
666
       Sprevious_single_property_change, 2, 4, 0,
667 668 669 670
  "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\
671
The property values are compared with `eq'.\n\
672
Return nil if the property is constant all the way to the start of OBJECT.\n\
673 674 675 676 677
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\
back past position LIMIT; fail if nothing is found before LIMIT.")
     (pos, prop, object, limit)
     Lisp_Object pos, prop, object, limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
678 679 680 681
{
  register INTERVAL i, previous;
  register Lisp_Object here_val;

682 683 684
  if (NILP (object))
    XSET (object, Lisp_Buffer, current_buffer);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
685 686
  i = validate_interval_range (object, &pos, &pos, soft);
  if (NULL_INTERVAL_P (i))
687
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
688

689
  here_val = textget (i->plist, prop);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
690 691
  previous = previous_interval (i);
  while (! NULL_INTERVAL_P (previous)
692 693 694
	 && EQ (here_val, textget (previous->plist, prop))
	 && (NILP (limit)
	     || previous->position + LENGTH (previous) > XFASTINT (limit)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
695 696
    previous = previous_interval (previous);
  if (NULL_INTERVAL_P (previous))
697 698 699 700
    return limit;
  if (!NILP (limit)
      && !(previous->position + LENGTH (previous) > XFASTINT (limit)))
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
701

702
  return (previous->position + LENGTH (previous)
703
	  - (XTYPE (object) == Lisp_String));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
704 705
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
706
DEFUN ("add-text-properties", Fadd_text_properties,
707 708 709 710 711 712 713 714 715
       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
716 717
{
  register INTERVAL i, unchanged;
718
  register int s, len, modified = 0;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
719 720 721 722 723

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

724 725 726
  if (NILP (object))
    XSET (object, Lisp_Buffer, current_buffer);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745
  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;
746
	  i = next_interval (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
747 748 749 750
	}
      else
	{
	  unchanged = i;
751
	  i = split_interval_right (unchanged, s - unchanged->position);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
752 753 754 755
	  copy_properties (unchanged, i);
	}
    }

756
  /* We are at the beginning of interval I, with LEN chars to scan.  */
757
  for (;;)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
758
    {
759 760 761
      if (i == 0)
	abort ();

Joseph Arceneaux's avatar
Joseph Arceneaux committed
762 763 764 765 766 767 768
      if (LENGTH (i) >= len)
	{
	  if (interval_has_all_properties (properties, i))
	    return modified ? Qt : Qnil;

	  if (LENGTH (i) == len)
	    {
769
	      add_properties (properties, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
770 771 772 773 774
	      return Qt;
	    }

	  /* i doesn't have the properties, and goes past the change limit */
	  unchanged = i;
775
	  i = split_interval_left (unchanged, len);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
776
	  copy_properties (unchanged, i);
777
	  add_properties (properties, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
778 779 780 781
	  return Qt;
	}

      len -= LENGTH (i);
782
      modified += add_properties (properties, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
783 784 785 786
      i = next_interval (i);
    }
}

787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802
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
803
DEFUN ("set-text-properties", Fset_text_properties,
804 805 806 807 808 809 810
       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
811 812
{
  register INTERVAL i, unchanged;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
813
  register INTERVAL prev_changed = NULL_INTERVAL;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
814 815
  register int s, len;

816
  props = validate_plist (props);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
817

818 819 820
  if (NILP (object))
    XSET (object, Lisp_Buffer, current_buffer);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
821 822 823 824 825 826 827 828 829 830
  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;
831
      i = split_interval_right (unchanged, s - unchanged->position);
832

Joseph Arceneaux's avatar
Joseph Arceneaux committed
833 834
      if (LENGTH (i) > len)
	{
Joseph Arceneaux's avatar
Joseph Arceneaux committed
835
	  copy_properties (unchanged, i);
836
	  i = split_interval_left (i, len);
837
	  set_properties (props, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
838 839 840
	  return Qt;
	}

841 842
      set_properties (props, i, object);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
843 844 845 846
      if (LENGTH (i) == len)
	return Qt;

      prev_changed = i;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
847 848 849 850
      len -= LENGTH (i);
      i = next_interval (i);
    }

851
  /* We are starting at the beginning of an interval, I */
852
  while (len > 0)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
853
    {
854 855 856
      if (i == 0)
	abort ();

Joseph Arceneaux's avatar
Joseph Arceneaux committed
857 858
      if (LENGTH (i) >= len)
	{
859
	  if (LENGTH (i) > len)
860
	    i = split_interval_left (i, len);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
861

Joseph Arceneaux's avatar
Joseph Arceneaux committed
862
	  if (NULL_INTERVAL_P (prev_changed))
863
	    set_properties (props, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
864 865
	  else
	    merge_interval_left (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
866 867 868 869
	  return Qt;
	}

      len -= LENGTH (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
870 871
      if (NULL_INTERVAL_P (prev_changed))
	{
872
	  set_properties (props, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
873 874 875 876 877
	  prev_changed = i;
	}
      else
	prev_changed = i = merge_interval_left (i);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
878 879 880 881 882 883 884
      i = next_interval (i);
    }

  return Qt;
}

DEFUN ("remove-text-properties", Fremove_text_properties,
885 886 887 888 889 890 891 892 893 894
       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
895 896
{
  register INTERVAL i, unchanged;
897
  register int s, len, modified = 0;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
898

899 900 901
  if (NILP (object))
    XSET (object, Lisp_Buffer, current_buffer);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
902 903 904 905 906 907
  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
908

Joseph Arceneaux's avatar
Joseph Arceneaux committed
909 910 911 912
  if (i->position != s)
    {
      /* No properties on this first interval -- return if
         it covers the entire region. */
913
      if (! interval_has_some_properties (props, i))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
914 915 916 917 918
	{
	  int got = (LENGTH (i) - (s - i->position));
	  if (got >= len)
	    return Qnil;
	  len -= got;
919
	  i = next_interval (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
920
	}
921 922
      /* Split away the beginning of this interval; what we don't
	 want to modify.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
923 924 925
      else
	{
	  unchanged = i;
926
	  i = split_interval_right (unchanged, s - unchanged->position);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
927 928 929 930 931
	  copy_properties (unchanged, i);
	}
    }

  /* We are at the beginning of an interval, with len to scan */
932
  for (;;)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
933
    {
934 935 936
      if (i == 0)
	abort ();

Joseph Arceneaux's avatar
Joseph Arceneaux committed
937 938
      if (LENGTH (i) >= len)
	{
939
	  if (! interval_has_some_properties (props, i))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
940 941 942 943
	    return modified ? Qt : Qnil;

	  if (LENGTH (i) == len)
	    {
944
	      remove_properties (props, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
945 946 947 948
	      return Qt;
	    }

	  /* i has the properties, and goes past the change limit */
949
	  unchanged = i;
950
	  i = split_interval_left (i, len);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
951
	  copy_properties (unchanged, i);
952
	  remove_properties (props, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
953 954 955 956
	  return Qt;
	}

      len -= LENGTH (i);
957
      modified += remove_properties (props, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
958 959 960 961
      i = next_interval (i);
    }
}

962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
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))
1013
    return (NILP (value) || EQ (start, end)) ? Qnil : start;
1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
  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;
}

1032 1033
#if 0 /* You can use set-text-properties for this.  */

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1034
DEFUN ("erase-text-properties", Ferase_text_properties,
1035 1036 1037 1038 1039 1040
       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
1041
{
1042
  register INTERVAL i;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1043
  register INTERVAL prev_changed = NULL_INTERVAL;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1044 1045
  register int s, len, modified;

1046 1047 1048
  if (NILP (object))
    XSET (object, Lisp_Buffer, current_buffer);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1049 1050 1051 1052 1053 1054
  i = validate_interval_range (object, &start, &end, soft);
  if (NULL_INTERVAL_P (i))
    return Qnil;

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

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1056 1057
  if (i->position != s)
    {
1058
      register int got;
1059
      register INTERVAL unchanged = i;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1060

1061
      /* If there are properties here, then this text will be modified. */
1062
      if (! NILP (i->plist))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1063
	{
1064
	  i = split_interval_right (unchanged, s - unchanged->position);
1065
	  i->plist = Qnil;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1066
	  modified++;
1067 1068 1069

	  if (LENGTH (i) > len)
	    {
1070
	      i = split_interval_right (i, len);
1071 1072 1073 1074 1075 1076 1077 1078
	      copy_properties (unchanged, i);
	      return Qt;
	    }

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

	  got = LENGTH (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1079
	}
1080 1081 1082
      /* If the text of I is without any properties, and contains
         LEN or more characters, then we may return without changing
	 anything.*/
1083 1084
      else if (LENGTH (i) - (s - i->position) <= len)
	return Qnil;
1085 1086
      /* The amount of text to change extends past I, so just note
	 how much we've gotten. */
1087 1088
      else
	got = LENGTH (i) - (s - i->position);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1089 1090

      len -= got;
1091
      prev_changed = i;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1092 1093 1094
      i = next_interval (i);
    }

1095
  /* We are starting at the beginning of an interval, I. */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1096 1097
  while (len > 0)
    {
1098
      if (LENGTH (i) >= len)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1099
	{
1100 1101
	  /* If I has no properties, simply merge it if possible.  */
	  if (NILP (i->plist))
1102 1103 1104
	    {
	      if (! NULL_INTERVAL_P (prev_changed))
		merge_interval_left (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1105

1106 1107 1108
	      return modified ? Qt : Qnil;
	    }

1109
          if (LENGTH (i) > len)
1110
            i = split_interval_left (i, len);
1111 1112
	  if (! NULL_INTERVAL_P (prev_changed))
	    merge_interval_left (i);
1113 1114
	  else
	    i->plist = Qnil;
1115

1116
	  return Qt;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1117 1118
	}

1119
      /* Here if we still need to erase past the end of I */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1120
      len -= LENGTH (i);
1121 1122 1123 1124 1125 1126 1127
      if (NULL_INTERVAL_P (prev_changed))
	{
	  modified += erase_properties (i);
	  prev_changed = i;
	}
      else
	{
1128 1129
	  modified += ! NILP (i->plist);
	  /* Merging I will give it the properties of PREV_CHANGED. */
1130 1131 1132
	  prev_changed = i = merge_interval_left (i);
	}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1133 1134 1135 1136 1137
      i = next_interval (i);
    }

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

1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 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
/* 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
1236 1237 1238 1239
void
syms_of_textprop ()
{
  DEFVAR_INT ("interval-balance-threshold", &interval_balance_threshold,
1240
	      "Threshold for rebalancing interval trees, expressed as the\n\
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1241 1242 1243
percentage by which the left interval tree should not differ from the right.");
  interval_balance_threshold = 8;

1244 1245 1246 1247 1248
  DEFVAR_LISP ("inhibit-point-motion-hooks", &Vinhibit_point_motion_hooks,
	       "If nonnil, don't call the text property values of\n\
`point-left' and `point-entered'.");
  Vinhibit_point_motion_hooks = Qnil;
	       
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263