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

This file is part of GNU Emacs.

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

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

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

20
#include <config.h>
Joseph Arceneaux's avatar
Joseph Arceneaux committed
21 22 23
#include "lisp.h"
#include "intervals.h"
#include "buffer.h"
24
#include "window.h"
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
Lisp_Object Qinvisible, Qread_only, Qintangible;
53 54 55

/* 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
  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. */
105
  if (EQ (*begin, *end) && begin != end)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
106 107 108 109
    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
/* Changing the plists of individual intervals.  */

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

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

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

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

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

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

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

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

324 325
static int
add_properties (plist, i, object)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
326 327
     Lisp_Object plist;
     INTERVAL i;
328
     Lisp_Object object;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
{
  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)))
	  {
345
	    register Lisp_Object this_cdr;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
346

347
	    this_cdr = Fcdr (tail2);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
348 349 350 351 352
	    /* Found the property.  Now check its value. */
	    found = 1;

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

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

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

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

  return changed;
}

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

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

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

Joseph Arceneaux's avatar
Joseph Arceneaux committed
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))
	{
431 432
	  register Lisp_Object this;
	  this = Fcdr (Fcdr (tail2));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
433 434
	  if (EQ (sym, Fcar (this)))
	    {
435 436
	      if (XTYPE (object) == Lisp_Buffer)
		{
437 438
		  modify_region (XBUFFER (object),
				 make_number (i->position),
439
				 make_number (i->position + LENGTH (i)));
440 441
		  record_property_change (i->position, LENGTH (i),
					  sym, Fcar (Fcdr (this)), object);
442 443
		}

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

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

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

  return i->plist;
}

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

510 511 512
DEFUN ("get-char-property", Fget_char_property, Sget_char_property, 2, 3, 0,
  "Return the value of position POS's property PROP, in OBJECT.\n\
OBJECT is optional and defaults to the current buffer.\n\
Karl Heuer's avatar
Karl Heuer committed
513
If POS is at the end of OBJECT, the value is nil.\n\
514
If OBJECT is a buffer, then overlay properties are considered as well as\n\
515 516
text properties.\n\
If OBJECT is a window, then that window's buffer is used, but window-specific\n\
517 518 519 520 521 522 523 524 525 526 527 528 529 530 531
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);
532
      object = w->buffer;
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
    }
  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
571
DEFUN ("next-property-change", Fnext_property_change,
572
       Snext_property_change, 1, 3, 0,
573 574 575 576 577
  "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\
578 579 580 581 582
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
583 584 585
{
  register INTERVAL i, next;

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

589 590 591
  if (!NILP (limit))
    CHECK_NUMBER_COERCE_MARKER (limit, 0);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
592 593
  i = validate_interval_range (object, &pos, &pos, soft);
  if (NULL_INTERVAL_P (i))
594
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
595 596

  next = next_interval (i);
597 598
  while (! NULL_INTERVAL_P (next) && intervals_equal (i, next)
	 && (NILP (limit) || next->position < XFASTINT (limit)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
599 600 601
    next = next_interval (next);

  if (NULL_INTERVAL_P (next))
602 603 604
    return limit;
  if (! NILP (limit) && !(next->position < XFASTINT (limit)))
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
605

606 607
  XFASTINT (pos) = next->position - (XTYPE (object) == Lisp_String);
  return pos;
608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629
}

/* 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);
630 631
      if (NULL_INTERVAL_P (next))
	return 0;
632 633 634 635 636 637 638 639
      if (next->position >= end)
	return 0;
    }

  if (NULL_INTERVAL_P (next))
    return 0;

  return 1;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
640 641
}

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

659 660 661
  if (NILP (object))
    XSET (object, Lisp_Buffer, current_buffer);

662 663 664
  if (!NILP (limit))
    CHECK_NUMBER_COERCE_MARKER (limit, 0);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
665 666
  i = validate_interval_range (object, &pos, &pos, soft);
  if (NULL_INTERVAL_P (i))
667
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
668

669
  here_val = textget (i->plist, prop);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
670
  next = next_interval (i);
671
  while (! NULL_INTERVAL_P (next) 
672 673
	 && EQ (here_val, textget (next->plist, prop))
	 && (NILP (limit) || next->position < XFASTINT (limit)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
674 675 676
    next = next_interval (next);

  if (NULL_INTERVAL_P (next))
677 678 679
    return limit;
  if (! NILP (limit) && !(next->position < XFASTINT (limit)))
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
680

681 682
  XFASTINT (pos) = next->position - (XTYPE (object) == Lisp_String);
  return pos;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
683 684
}

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

700 701 702
  if (NILP (object))
    XSET (object, Lisp_Buffer, current_buffer);

703 704 705
  if (!NILP (limit))
    CHECK_NUMBER_COERCE_MARKER (limit, 0);

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

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

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

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

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

750 751 752
  if (!NILP (limit))
    CHECK_NUMBER_COERCE_MARKER (limit, 0);

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

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

759 760 761
  if (NULL_INTERVAL_P (i))
    return limit;

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

775 776 777
  XFASTINT (pos) = (previous->position + LENGTH (previous)
		    - (XTYPE (object) == Lisp_String));
  return pos;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
778 779
}

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

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

798 799 800
  if (NILP (object))
    XSET (object, Lisp_Buffer, current_buffer);

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

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

Joseph Arceneaux's avatar
Joseph Arceneaux committed
836 837 838 839 840 841 842
      if (LENGTH (i) >= len)
	{
	  if (interval_has_all_properties (properties, i))
	    return modified ? Qt : Qnil;

	  if (LENGTH (i) == len)
	    {
843
	      add_properties (properties, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
844 845 846 847 848
	      return Qt;
	    }

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

      len -= LENGTH (i);
856
      modified += add_properties (properties, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
857 858 859 860
      i = next_interval (i);
    }
}

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

890
  props = validate_plist (props);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
891

892 893 894
  if (NILP (object))
    XSET (object, Lisp_Buffer, current_buffer);

Richard M. Stallman's avatar
Richard M. Stallman committed
895
  i = validate_interval_range (object, &start, &end, soft);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
896
  if (NULL_INTERVAL_P (i))
Richard M. Stallman's avatar
Richard M. Stallman committed
897 898 899 900 901 902 903 904 905 906
    {
      /* If buffer has no props, and we want none, return now.  */
      if (NILP (props))
	return Qnil;

      i = validate_interval_range (object, &start, &end, hard);
      /* This can return if start == end.  */
      if (NULL_INTERVAL_P (i))
	return Qnil;
    }
Joseph Arceneaux's avatar
Joseph Arceneaux committed
907 908 909 910 911 912 913

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

  if (i->position != s)
    {
      unchanged = i;
914
      i = split_interval_right (unchanged, s - unchanged->position);
915

Joseph Arceneaux's avatar
Joseph Arceneaux committed
916 917
      if (LENGTH (i) > len)
	{
Joseph Arceneaux's avatar
Joseph Arceneaux committed
918
	  copy_properties (unchanged, i);
919
	  i = split_interval_left (i, len);
920
	  set_properties (props, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
921 922 923
	  return Qt;
	}

924 925
      set_properties (props, i, object);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
926 927 928 929
      if (LENGTH (i) == len)
	return Qt;

      prev_changed = i;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
930 931 932 933
      len -= LENGTH (i);
      i = next_interval (i);
    }

934
  /* We are starting at the beginning of an interval, I */
935
  while (len > 0)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
936
    {
937 938 939
      if (i == 0)
	abort ();

Joseph Arceneaux's avatar
Joseph Arceneaux committed
940 941
      if (LENGTH (i) >= len)
	{
942
	  if (LENGTH (i) > len)
943
	    i = split_interval_left (i, len);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
944

Joseph Arceneaux's avatar
Joseph Arceneaux committed
945
	  if (NULL_INTERVAL_P (prev_changed))
946
	    set_properties (props, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
947 948
	  else
	    merge_interval_left (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
949 950 951 952
	  return Qt;
	}

      len -= LENGTH (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
953 954
      if (NULL_INTERVAL_P (prev_changed))
	{
955
	  set_properties (props, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
956 957 958 959 960
	  prev_changed = i;
	}
      else
	prev_changed = i = merge_interval_left (i);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
961 962 963 964 965 966 967
      i = next_interval (i);
    }

  return Qt;
}

DEFUN ("remove-text-properties", Fremove_text_properties,
968 969 970 971 972 973 974 975 976 977
       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
978 979
{
  register INTERVAL i, unchanged;
980
  register int s, len, modified = 0;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
981

982 983 984
  if (NILP (object))
    XSET (object, Lisp_Buffer, current_buffer);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
985 986 987 988 989 990
  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
991

Joseph Arceneaux's avatar
Joseph Arceneaux committed
992 993 994 995
  if (i->position != s)
    {
      /* No properties on this first interval -- return if
         it covers the entire region. */
996
      if (! interval_has_some_properties (props, i))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
997 998 999 1000 1001
	{
	  int got = (LENGTH (i) - (s - i->position));
	  if (got >= len)
	    return Qnil;
	  len -= got;
1002
	  i = next_interval (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1003
	}
1004 1005
      /* Split away the beginning of this interval; what we don't
	 want to modify.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1006 1007 1008
      else
	{
	  unchanged = i;
1009
	  i = split_interval_right (unchanged, s - unchanged->position);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1010 1011 1012 1013 1014
	  copy_properties (unchanged, i);
	}
    }

  /* We are at the beginning of an interval, with len to scan */
1015
  for (;;)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1016
    {
1017 1018 1019
      if (i == 0)
	abort ();

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1020 1021
      if (LENGTH (i) >= len)
	{
1022
	  if (! interval_has_some_properties (props, i))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1023 1024 1025 1026
	    return modified ? Qt : Qnil;

	  if (LENGTH (i) == len)
	    {
1027
	      remove_properties (props, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1028 1029 1030 1031
	      return Qt;
	    }

	  /* i has the properties, and goes past the change limit */
1032
	  unchanged = i;
1033
	  i = split_interval_left (i, len);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1034
	  copy_properties (unchanged, i);
1035
	  remove_properties (props, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1036 1037 1038 1039
	  return Qt;
	}

      len -= LENGTH (i);
1040
      modified += remove_properties (props, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1041 1042 1043 1044
      i = next_interval (i);
    }
}

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 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095
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))
1096
    return (NILP (value) || EQ (start, end)) ? Qnil : start;
1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114
  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;
}

1115 1116
#if 0 /* You can use set-text-properties for this.  */

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1117
DEFUN ("erase-text-properties", Ferase_text_properties,
1118 1119 1120 1121 1122 1123
       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
1124
{
1125
  register INTERVAL i;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1126
  register INTERVAL prev_changed = NULL_INTERVAL;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1127 1128
  register int s, len, modified;

1129 1130 1131
  if (NILP (object))
    XSET (object, Lisp_Buffer, current_buffer);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1132 1133 1134 1135 1136 1137
  i = validate_interval_range (object, &start, &end, soft);
  if (NULL_INTERVAL_P (i))
    return Qnil;

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

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1139 1140
  if (i->position != s)
    {
1141
      register int got;
1142
      register INTERVAL unchanged = i;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1143

1144
      /* If there are properties here, then this text will be modified. */
1145
      if (! NILP (i->plist))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1146
	{
1147
	  i = split_interval_right (unchanged, s - unchanged->position);
1148
	  i->plist = Qnil;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1149
	  modified++;
1150 1151 1152

	  if (LENGTH (i) > len)
	    {
1153
	      i = split_interval_right (i, len);
1154 1155 1156 1157 1158 1159 1160 1161
	      copy_properties (unchanged, i);
	      return Qt;
	    }

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

	  got = LENGTH (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1162
	}
1163 1164 1165
      /* If the text of I is without any properties, and contains
         LEN or more characters, then we may return without changing
	 anything.*/
1166 1167
      else if (LENGTH (i) - (s - i->position) <= len)
	return Qnil;
1168 1169
      /* The amount of text to change extends past I, so just note
	 how much we've gotten. */
1170 1171
      else
	got = LENGTH (i) - (s - i->position);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1172 1173

      len -= got;
1174
      prev_changed = i;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1175 1176 1177
      i = next_interval (i);
    }

1178
  /* We are starting at the beginning of an interval, I. */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1179 1180
  while (len > 0)
    {
1181
      if (LENGTH (i) >= len)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1182
	{
1183 1184
	  /* If I has no properties, simply merge it if possible.  */
	  if (NILP (i->plist))
1185 1186 1187
	    {
	      if (! NULL_INTERVAL_P (prev_changed))
		merge_interval_left (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1188

1189 1190 1191
	      return modified ? Qt : Qnil;
	    }

1192
          if (LENGTH (i) > len)
1193
            i = split_interval_left (i, len);
1194 1195
	  if (! NULL_INTERVAL_P (prev_changed))
	    merge_interval_left (i);
1196 1197
	  else
	    i->plist = Qnil;
1198

1199
	  return Qt;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1200 1201
	}

1202
      /* Here if we still need to erase past the end of I */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1203
      len -= LENGTH (i);
1204 1205 1206 1207 1208 1209 1210
      if (NULL_INTERVAL_P (prev_changed))
	{
	  modified += erase_properties (i);
	  prev_changed = i;
	}
      else
	{
1211 1212
	  modified += ! NILP (i->plist);
	  /* Merging I will give it the properties of PREV_CHANGED. */
1213 1214 1215
	  prev_changed = i = merge_interval_left (i);
	}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1216 1217 1218 1219 1220
      i = next_interval (i);
    }

  return modified ? Qt : Qnil;
}
1221
#endif /* 0 */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
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 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318
/* 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
1319 1320 1321
void
syms_of_textprop ()
{
1322
  DEFVAR_LISP ("inhibit-point-motion-hooks", &Vinhibit_point_motion_hooks,
Richard M. Stallman's avatar
Richard M. Stallman committed
1323
	       "If non-nil, don't call the text property values of\n\
1324 1325 1326
`point-left' and `point-entered'.");
  Vinhibit_point_motion_hooks = Qnil;
	       
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342
  /* 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");
1343 1344
  staticpro (&Qintangible);
  Qintangible = intern ("intangible");
1345 1346 1347 1348
  staticpro (&Qcategory);
  Qcategory = intern ("category");
  staticpro (&Qlocal_map);
  Qlocal_map = intern ("local-map");
1349 1350 1351 1352
  staticpro (&Qfront_sticky);
  Qfront_sticky = intern ("front-sticky");
  staticpro (&Qrear_nonsticky);
  Qrear_nonsticky = intern ("rear-nonsticky");
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365

  /* 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);
1366
  defsubr (&Sget_text_property);
1367
  defsubr (&Sget_char_property);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1368
  defsubr (&Snext_property_change);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1369
  defsubr (&Snext_single_property_change);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1370
  defsubr (&Sprevious_property_change);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1371
  defsubr (&Sprevious_single_property_change);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1372
  defsubr (&Sadd_text_properties);
1373
  defsubr (&Sput_text_property);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1374 1375
  defsubr (&Sset_text_properties);
  defsubr (&Sremove_text_properties);
1376 1377
  defsubr (&Stext_property_any);
  defsubr (&Stext_property_not_all);
1378
/*  defsubr (&Serase_text_properties); */
1379
/*  defsubr (&Scopy_text_properties); */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1380
}
1381 1382 1383 1384 1385 1386

#else

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

#endif /* USE_TEXT_PROPERTIES */