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

This file is part of GNU Emacs.

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

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

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

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

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

/* NOTES:  previous- and next- property change will have to skip
  zero-length intervals if they are implemented.  This could be done
  inside next_interval and previous_interval.

Joseph Arceneaux's avatar
Joseph Arceneaux committed
35 36
  set_properties needs to deal with the interval property cache.

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

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

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

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

/* If o1 is a cons whose cdr is a cons, return non-zero and set o2 to
   the o1's cdr.  Otherwise, return zero.  This is handy for
   traversing plists.  */
64
#define PLIST_ELT_P(o1, o2) (CONSP (o1) && ((o2)=XCONS (o1)->cdr, CONSP (o2)))
65

66
Lisp_Object Vinhibit_point_motion_hooks;
67
Lisp_Object Vdefault_properties;
68

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

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

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

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

Joseph Arceneaux's avatar
Joseph Arceneaux committed
104 105 106 107 108 109
  CHECK_STRING_OR_BUFFER (object, 0);
  CHECK_NUMBER_COERCE_MARKER (*begin, 0);
  CHECK_NUMBER_COERCE_MARKER (*end, 0);

  /* If we are asked for a point, but from a subr which operates
     on a range, then return nothing. */
110
  if (EQ (*begin, *end) && begin != end)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
111 112 113 114
    return NULL_INTERVAL;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  tail1 = plist;
  sym1 = Qnil;
  val1 = Qnil;
  /* No need to protect OBJECT, because we can GC only in the case
     where it is a buffer, and live buffers are always protected.
     I and its plist are also protected, via OBJECT.  */
  GCPRO3 (tail1, sym1, val1);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
347 348 349 350 351 352 353 354 355 356 357 358

  /* 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)))
	  {
359 360
	    /* No need to gcpro, because tail2 protects this
	       and it must be a cons cell (we get an error otherwise).  */
361
	    register Lisp_Object this_cdr;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
362

363
	    this_cdr = Fcdr (tail2);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
364 365 366 367 368
	    /* Found the property.  Now check its value. */
	    found = 1;

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

372
	    /* Record this change in the buffer, for undo purposes.  */
373
	    if (BUFFERP (object))
374
	      {
375 376
		modify_region (XBUFFER (object),
			       make_number (i->position),
377
			       make_number (i->position + LENGTH (i)));
378 379
		record_property_change (i->position, LENGTH (i),
					sym1, Fcar (this_cdr), object);
380 381
	      }

Joseph Arceneaux's avatar
Joseph Arceneaux committed
382 383 384 385 386 387 388 389
	    /* I's property has a different value -- change it */
	    Fsetcar (this_cdr, val1);
	    changed++;
	    break;
	  }

      if (! found)
	{
390
	  /* Record this change in the buffer, for undo purposes.  */
391
	  if (BUFFERP (object))
392
	    {
393 394
	      modify_region (XBUFFER (object),
			     make_number (i->position),
395
			     make_number (i->position + LENGTH (i)));
396 397
	      record_property_change (i->position, LENGTH (i),
				      sym1, Qnil, object);
398
	    }
Joseph Arceneaux's avatar
Joseph Arceneaux committed
399 400 401 402 403
	  i->plist = Fcons (sym1, Fcons (val1, i->plist));
	  changed++;
	}
    }

404 405
  UNGCPRO;

Joseph Arceneaux's avatar
Joseph Arceneaux committed
406 407 408 409
  return changed;
}

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

413 414
static int
remove_properties (plist, i, object)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
415 416
     Lisp_Object plist;
     INTERVAL i;
417
     Lisp_Object object;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
418
{
419
  register Lisp_Object tail1, tail2, sym, current_plist;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
420 421
  register int changed = 0;

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

Joseph Arceneaux's avatar
Joseph Arceneaux committed
441 442 443 444 445 446 447 448
	  current_plist = Fcdr (Fcdr (current_plist));
	  changed++;
	}

      /* Go through i's plist, looking for sym */
      tail2 = current_plist;
      while (! NILP (tail2))
	{
449 450
	  register Lisp_Object this;
	  this = Fcdr (Fcdr (tail2));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
451 452
	  if (EQ (sym, Fcar (this)))
	    {
453
	      if (BUFFERP (object))
454
		{
455 456
		  modify_region (XBUFFER (object),
				 make_number (i->position),
457
				 make_number (i->position + LENGTH (i)));
458 459
		  record_property_change (i->position, LENGTH (i),
					  sym, Fcar (Fcdr (this)), object);
460 461
		}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
462 463 464 465 466 467 468 469 470 471 472 473
	      Fsetcdr (Fcdr (tail2), Fcdr (Fcdr (this)));
	      changed++;
	    }
	  tail2 = this;
	}
    }

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

474
#if 0
Joseph Arceneaux's avatar
Joseph Arceneaux committed
475 476 477 478 479 480 481 482 483 484 485 486 487
/* 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;
}
488
#endif
Joseph Arceneaux's avatar
Joseph Arceneaux committed
489 490 491 492 493

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\
494 495
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
496 497 498 499 500 501
  (pos, object)
     Lisp_Object pos, object;
{
  register INTERVAL i;

  if (NILP (object))
502
    XSETBUFFER (object, current_buffer);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
503 504 505 506

  i = validate_interval_range (object, &pos, &pos, soft);
  if (NULL_INTERVAL_P (i))
    return Qnil;
507 508 509 510 511 512
  /* 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
513 514 515 516

  return i->plist;
}

517
DEFUN ("get-text-property", Fget_text_property, Sget_text_property, 2, 3, 0,
518
  "Return the value of position POS's property PROP, in OBJECT.\n\
519 520
OBJECT is optional and defaults to the current buffer.\n\
If POSITION is at the end of OBJECT, the value is nil.")
521
  (pos, prop, object)
522
     Lisp_Object pos, object;
523
     Lisp_Object prop;
524
{
525
  return textget (Ftext_properties_at (pos, object), prop);
526 527
}

528 529 530
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
531
If POS is at the end of OBJECT, the value is nil.\n\
532
If OBJECT is a buffer, then overlay properties are considered as well as\n\
533 534
text properties.\n\
If OBJECT is a window, then that window's buffer is used, but window-specific\n\
535 536 537 538 539 540 541 542 543 544
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))
545
    XSETBUFFER (object, current_buffer);
546 547 548 549

  if (WINDOWP (object))
    {
      w = XWINDOW (object);
550
      object = w->buffer;
551 552 553 554 555 556 557 558 559 560 561 562 563
    }
  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));

564 565
      noverlays = overlays_at (posn, 0, &overlay_vec, &len,
			       &next_overlay, NULL);
566 567 568 569 570 571 572

      /* 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));
573 574
	  noverlays = overlays_at (posn, 0, &overlay_vec, &len,
				   &next_overlay, NULL);
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590
	}
      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
591
DEFUN ("next-property-change", Fnext_property_change,
592
       Snext_property_change, 1, 3, 0,
593 594 595 596 597
  "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\
598 599 600 601 602
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
603 604 605
{
  register INTERVAL i, next;

606
  if (NILP (object))
607
    XSETBUFFER (object, current_buffer);
608

609 610 611
  if (!NILP (limit))
    CHECK_NUMBER_COERCE_MARKER (limit, 0);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
612 613
  i = validate_interval_range (object, &pos, &pos, soft);
  if (NULL_INTERVAL_P (i))
614
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
615 616

  next = next_interval (i);
617 618
  while (! NULL_INTERVAL_P (next) && intervals_equal (i, next)
	 && (NILP (limit) || next->position < XFASTINT (limit)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
619 620 621
    next = next_interval (next);

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

626
  XSETFASTINT (pos, next->position - (STRINGP (object)));
627
  return pos;
628 629 630 631 632 633 634 635 636 637 638
}

/* Return 1 if there's a change in some property between BEG and END.  */

int
property_change_between_p (beg, end)
     int beg, end;
{
  register INTERVAL i, next;
  Lisp_Object object, pos;

639
  XSETBUFFER (object, current_buffer);
640
  XSETFASTINT (pos, beg);
641 642 643 644 645 646 647 648 649

  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);
650 651
      if (NULL_INTERVAL_P (next))
	return 0;
652 653 654 655 656 657 658 659
      if (next->position >= end)
	return 0;
    }

  if (NULL_INTERVAL_P (next))
    return 0;

  return 1;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
660 661
}

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

679
  if (NILP (object))
680
    XSETBUFFER (object, current_buffer);
681

682 683 684
  if (!NILP (limit))
    CHECK_NUMBER_COERCE_MARKER (limit, 0);

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
  next = next_interval (i);
691
  while (! NULL_INTERVAL_P (next) 
692 693
	 && EQ (here_val, textget (next->plist, prop))
	 && (NILP (limit) || next->position < XFASTINT (limit)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
694 695 696
    next = next_interval (next);

  if (NULL_INTERVAL_P (next))
697 698 699
    return limit;
  if (! NILP (limit) && !(next->position < XFASTINT (limit)))
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
700

701
  XSETFASTINT (pos, next->position - (STRINGP (object)));
702
  return pos;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
703 704
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
705
DEFUN ("previous-property-change", Fprevious_property_change,
706
       Sprevious_property_change, 1, 3, 0,
707 708 709 710 711
  "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\
712 713
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
714
back past position LIMIT; return LIMIT if nothing is found until LIMIT.")
715 716
  (pos, object, limit)
     Lisp_Object pos, object, limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
717 718 719
{
  register INTERVAL i, previous;

720
  if (NILP (object))
721
    XSETBUFFER (object, current_buffer);
722

723 724 725
  if (!NILP (limit))
    CHECK_NUMBER_COERCE_MARKER (limit, 0);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
726 727
  i = validate_interval_range (object, &pos, &pos, soft);
  if (NULL_INTERVAL_P (i))
728
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
729

730 731 732 733
  /* 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
734
  previous = previous_interval (i);
735 736 737
  while (! NULL_INTERVAL_P (previous) && intervals_equal (previous, i)
	 && (NILP (limit)
	     || previous->position + LENGTH (previous) > XFASTINT (limit)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
738 739
    previous = previous_interval (previous);
  if (NULL_INTERVAL_P (previous))
740 741 742 743
    return limit;
  if (!NILP (limit)
      && !(previous->position + LENGTH (previous) > XFASTINT (limit)))
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
744

745 746
  XSETFASTINT (pos, (previous->position + LENGTH (previous)
		     - (STRINGP (object))));
747
  return pos;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
748 749
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
750
DEFUN ("previous-single-property-change", Fprevious_single_property_change,
751
       Sprevious_single_property_change, 2, 4, 0,
752 753 754 755
  "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\
756
The property values are compared with `eq'.\n\
757
Return nil if the property is constant all the way to the start of OBJECT.\n\
758 759
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
760
back past position LIMIT; return LIMIT if nothing is found until LIMIT.")
761 762
     (pos, prop, object, limit)
     Lisp_Object pos, prop, object, limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
763 764 765 766
{
  register INTERVAL i, previous;
  register Lisp_Object here_val;

767
  if (NILP (object))
768
    XSETBUFFER (object, current_buffer);
769

770 771 772
  if (!NILP (limit))
    CHECK_NUMBER_COERCE_MARKER (limit, 0);

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

775
  /* Start with the interval containing the char before point.  */
776
  if (! NULL_INTERVAL_P (i) && i->position == XFASTINT (pos))
777 778
    i = previous_interval (i);

779 780 781
  if (NULL_INTERVAL_P (i))
    return limit;

782
  here_val = textget (i->plist, prop);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
783 784
  previous = previous_interval (i);
  while (! NULL_INTERVAL_P (previous)
785 786 787
	 && EQ (here_val, textget (previous->plist, prop))
	 && (NILP (limit)
	     || previous->position + LENGTH (previous) > XFASTINT (limit)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
788 789
    previous = previous_interval (previous);
  if (NULL_INTERVAL_P (previous))
790 791 792 793
    return limit;
  if (!NILP (limit)
      && !(previous->position + LENGTH (previous) > XFASTINT (limit)))
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
794

795 796
  XSETFASTINT (pos, (previous->position + LENGTH (previous)
		     - (STRINGP (object))));
797
  return pos;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
798 799
}

800 801
/* Callers note, this can GC when OBJECT is a buffer (or nil).  */

Joseph Arceneaux's avatar
Joseph Arceneaux committed
802
DEFUN ("add-text-properties", Fadd_text_properties,
803 804 805 806 807 808 809 810 811
       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
812 813
{
  register INTERVAL i, unchanged;
814
  register int s, len, modified = 0;
815
  struct gcpro gcpro1;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
816 817 818 819 820

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

821
  if (NILP (object))
822
    XSETBUFFER (object, current_buffer);
823

Joseph Arceneaux's avatar
Joseph Arceneaux committed
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;

831 832 833 834
  /* No need to protect OBJECT, because we GC only if it's a buffer,
     and live buffers are always protected.  */
  GCPRO1 (properties);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
835 836 837 838 839 840 841 842 843 844 845 846
  /* 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;
847
	  i = next_interval (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
848 849 850 851
	}
      else
	{
	  unchanged = i;
852
	  i = split_interval_right (unchanged, s - unchanged->position);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
853 854 855 856
	  copy_properties (unchanged, i);
	}
    }

857
  /* We are at the beginning of interval I, with LEN chars to scan.  */
858
  for (;;)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
859
    {
860 861 862
      if (i == 0)
	abort ();

Joseph Arceneaux's avatar
Joseph Arceneaux committed
863 864
      if (LENGTH (i) >= len)
	{
865 866 867 868 869
	  /* We can UNGCPRO safely here, because there will be just
	     one more chance to gc, in the next call to add_properties,
	     and after that we will not need PROPERTIES or OBJECT again.  */
	  UNGCPRO;

Joseph Arceneaux's avatar
Joseph Arceneaux committed
870 871 872 873 874
	  if (interval_has_all_properties (properties, i))
	    return modified ? Qt : Qnil;

	  if (LENGTH (i) == len)
	    {
875
	      add_properties (properties, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
876 877 878 879 880
	      return Qt;
	    }

	  /* i doesn't have the properties, and goes past the change limit */
	  unchanged = i;
881
	  i = split_interval_left (unchanged, len);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
882
	  copy_properties (unchanged, i);
883
	  add_properties (properties, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
884 885 886 887
	  return Qt;
	}

      len -= LENGTH (i);
888
      modified += add_properties (properties, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
889 890 891 892
      i = next_interval (i);
    }
}

893 894
/* Callers note, this can GC when OBJECT is a buffer (or nil).  */

895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910
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
911
DEFUN ("set-text-properties", Fset_text_properties,
912 913 914 915 916 917 918
       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
919 920
{
  register INTERVAL i, unchanged;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
921
  register INTERVAL prev_changed = NULL_INTERVAL;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
922
  register int s, len;
923 924 925 926
  Lisp_Object ostart, oend;

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

928
  props = validate_plist (props);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
929

930
  if (NILP (object))
931
    XSETBUFFER (object, current_buffer);
932

933 934 935 936 937 938 939 940 941 942
  /* If we want no properties for a whole string,
     get rid of its intervals.  */
  if (NILP (props) && STRINGP (object)
      && XFASTINT (start) == 0
      && XFASTINT (end) == XSTRING (object)->size)
    {
      XSTRING (object)->intervals = 0;
      return Qt;
    }

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

Joseph Arceneaux's avatar
Joseph Arceneaux committed
945
  if (NULL_INTERVAL_P (i))
Richard M. Stallman's avatar
Richard M. Stallman committed
946 947 948 949 950
    {
      /* If buffer has no props, and we want none, return now.  */
      if (NILP (props))
	return Qnil;

951 952 953 954 955
      /* Restore the original START and END values
	 because validate_interval_range increments them for strings.  */
      start = ostart;
      end = oend;

Richard M. Stallman's avatar
Richard M. Stallman committed
956 957 958 959 960
      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
961 962 963 964 965 966 967

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

  if (i->position != s)
    {
      unchanged = i;
968
      i = split_interval_right (unchanged, s - unchanged->position);
969

Joseph Arceneaux's avatar
Joseph Arceneaux committed
970 971
      if (LENGTH (i) > len)
	{
Joseph Arceneaux's avatar
Joseph Arceneaux committed
972
	  copy_properties (unchanged, i);
973
	  i = split_interval_left (i, len);
974
	  set_properties (props, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
975 976 977
	  return Qt;
	}

978 979
      set_properties (props, i, object);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
980 981 982 983
      if (LENGTH (i) == len)
	return Qt;

      prev_changed = i;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
984 985 986 987
      len -= LENGTH (i);
      i = next_interval (i);
    }

988
  /* We are starting at the beginning of an interval, I */
989
  while (len > 0)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
990
    {
991 992 993
      if (i == 0)
	abort ();

Joseph Arceneaux's avatar
Joseph Arceneaux committed
994 995
      if (LENGTH (i) >= len)
	{
996
	  if (LENGTH (i) > len)
997
	    i = split_interval_left (i, len);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
998

Joseph Arceneaux's avatar
Joseph Arceneaux committed
999
	  if (NULL_INTERVAL_P (prev_changed))
1000
	    set_properties (props, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1001 1002
	  else
	    merge_interval_left (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1003 1004 1005 1006
	  return Qt;
	}

      len -= LENGTH (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1007 1008
      if (NULL_INTERVAL_P (prev_changed))
	{
1009
	  set_properties (props, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1010 1011 1012 1013 1014
	  prev_changed = i;
	}
      else
	prev_changed = i = merge_interval_left (i);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1015 1016 1017 1018 1019 1020 1021
      i = next_interval (i);
    }

  return Qt;
}

DEFUN ("remove-text-properties", Fremove_text_properties,
1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
       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
1032 1033
{
  register INTERVAL i, unchanged;
1034
  register int s, len, modified = 0;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1035

1036
  if (NILP (object))
1037
    XSETBUFFER (object, current_buffer);
1038

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1039 1040 1041 1042 1043 1044
  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
1045

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1046 1047 1048 1049
  if (i->position != s)
    {
      /* No properties on this first interval -- return if
         it covers the entire region. */
1050
      if (! interval_has_some_properties (props, i))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1051 1052 1053 1054 1055
	{
	  int got = (LENGTH (i) - (s - i->position));
	  if (got >= len)
	    return Qnil;
	  len -= got;
1056
	  i = next_interval (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1057
	}
1058 1059
      /* Split away the beginning of this interval; what we don't
	 want to modify.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1060 1061 1062
      else
	{
	  unchanged = i;
1063
	  i = split_interval_right (unchanged, s - unchanged->position);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1064 1065 1066 1067 1068
	  copy_properties (unchanged, i);
	}
    }

  /* We are at the beginning of an interval, with len to scan */
1069
  for (;;)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1070
    {
1071 1072 1073
      if (i == 0)
	abort ();

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1074 1075
      if (LENGTH (i) >= len)
	{
1076
	  if (! interval_has_some_properties (props, i))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1077 1078 1079 1080
	    return modified ? Qt : Qnil;

	  if (LENGTH (i) == len)
	    {
1081
	      remove_properties (props, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1082 1083 1084 1085
	      return Qt;
	    }

	  /* i has the properties, and goes past the change limit */
1086
	  unchanged = i;
1087
	  i = split_interval_left (i, len);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1088
	  copy_properties (unchanged, i);
1089
	  remove_properties (props, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1090 1091 1092 1093
	  return Qt;
	}

      len -= LENGTH (i);