textprop.c 51.3 KB
Newer Older
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1
/* Interface code for dealing with text properties.
2
   Copyright (C) 1993, 1994, 1995, 1997 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
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
18 19
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
20

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

#ifndef NULL
#define NULL (void *)0
#endif
30 31 32 33 34

/* Test for membership, allowing for t (actually any non-cons) to mean the
   universal set.  */

#define TMEM(sym, set) (CONSP (set) ? ! NILP (Fmemq (sym, set)) : ! NILP (set))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
35 36 37 38 39 40


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

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

49 50
/* The rest of the file is within this conditional */
#ifdef USE_TEXT_PROPERTIES
Joseph Arceneaux's avatar
Joseph Arceneaux committed
51

52
/* Types of hooks.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
53 54 55 56
Lisp_Object Qmouse_left;
Lisp_Object Qmouse_entered;
Lisp_Object Qpoint_left;
Lisp_Object Qpoint_entered;
57 58
Lisp_Object Qcategory;
Lisp_Object Qlocal_map;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
59

60
/* Visual properties text (including strings) may have.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
61
Lisp_Object Qforeground, Qbackground, Qfont, Qunderline, Qstipple;
62
Lisp_Object Qinvisible, Qread_only, Qintangible;
63 64 65

/* Sticky properties */
Lisp_Object Qfront_sticky, Qrear_nonsticky;
66 67 68 69

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

72
Lisp_Object Vinhibit_point_motion_hooks;
73
Lisp_Object Vdefault_text_properties;
74

75 76 77 78
/* verify_interval_modification saves insertion hooks here
   to be run later by report_interval_modification.  */
Lisp_Object interval_insert_behind_hooks;
Lisp_Object interval_insert_in_front_hooks;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
79

Joseph Arceneaux's avatar
Joseph Arceneaux committed
80 81 82 83 84 85
/* 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
86

87 88 89
   When OBJECT is a string, we increment *BEGIN and *END
   to make them origin-one.

Joseph Arceneaux's avatar
Joseph Arceneaux committed
90 91 92 93 94 95 96 97 98
   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
99 100
   create an interval tree for OBJECT if one doesn't exist, provided
   the object actually contains text.  In the current design, if there
101
   is no text, there can be no text properties.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
102 103 104 105 106 107 108 109 110 111

#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;
112 113
  int searchpos;

Joseph Arceneaux's avatar
Joseph Arceneaux committed
114 115 116 117 118
  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
119
     on a range, then return nothing.  */
120
  if (EQ (*begin, *end) && begin != end)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
121 122 123 124
    return NULL_INTERVAL;

  if (XINT (*begin) > XINT (*end))
    {
125 126
      Lisp_Object n;
      n = *begin;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
127
      *begin = *end;
128
      *end = n;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
129 130
    }

131
  if (BUFFERP (object))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
132 133 134 135 136 137
    {
      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);
138
      i = BUF_INTERVALS (b);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
139

140
      /* If there's no text, there are no properties.  */
141 142 143 144
      if (BUF_BEGV (b) == BUF_ZV (b))
	return NULL_INTERVAL;

      searchpos = XINT (*begin);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
145 146 147 148 149
    }
  else
    {
      register struct Lisp_String *s = XSTRING (object);

150
      if (! (0 <= XINT (*begin) && XINT (*begin) <= XINT (*end)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
151 152
	     && XINT (*end) <= s->size))
	args_out_of_range (*begin, *end);
153 154
      /* User-level Positions in strings start with 0,
	 but the interval code always wants positions starting with 1.  */
155
      XSETFASTINT (*begin, XFASTINT (*begin) + 1);
156
      if (begin != end)
157
	XSETFASTINT (*end, XFASTINT (*end) + 1);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
158
      i = s->intervals;
159 160 161 162 163

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

      searchpos = XINT (*begin);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
164 165 166 167 168
    }

  if (NULL_INTERVAL_P (i))
    return (force ? create_root_interval (object) : i);
    
169
  return find_interval (i, searchpos);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
170 171 172 173
}

/* Validate LIST as a property list.  If LIST is not a list, then
   make one consisting of (LIST nil).  Otherwise, verify that LIST
174
   is even numbered and thus suitable as a plist.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
175 176 177

static Lisp_Object
validate_plist (list)
178
     Lisp_Object list;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
179 180 181 182 183 184 185 186 187
{
  if (NILP (list))
    return Qnil;

  if (CONSP (list))
    {
      register int i;
      register Lisp_Object tail;
      for (i = 0, tail = list; !NILP (tail); i++)
188 189 190 191
	{
	  tail = Fcdr (tail);
	  QUIT;
	}
Joseph Arceneaux's avatar
Joseph Arceneaux committed
192 193 194 195 196 197 198 199 200
      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,
201
   with the same values, of list PLIST.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
202 203 204 205 206 207 208 209 210

static int
interval_has_all_properties (plist, i)
     Lisp_Object plist;
     INTERVAL i;
{
  register Lisp_Object tail1, tail2, sym1, sym2;
  register int found;

211
  /* Go through each element of PLIST.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
212 213 214 215 216 217 218 219 220 221
  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
222
	       values are unequal, return zero.  */
223
	    if (! EQ (Fcar (Fcdr (tail1)), Fcar (Fcdr (tail2))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
224 225
	      return 0;

226
	    /* Property has same value on both lists;  go to next one.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
227 228 229 230 231 232 233 234 235 236 237 238
	    found = 1;
	    break;
	  }

      if (! found)
	return 0;
    }

  return 1;
}

/* Return nonzero if the plist of interval I has any of the
239
   properties of PLIST, regardless of their values.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
240 241 242 243 244 245 246 247

static INLINE int
interval_has_some_properties (plist, i)
     Lisp_Object plist;
     INTERVAL i;
{
  register Lisp_Object tail1, tail2, sym;

248
  /* Go through each element of PLIST.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
249 250 251 252 253 254 255 256 257 258 259 260
  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;
}
261

262 263 264 265
/* Changing the plists of individual intervals.  */

/* Return the value of PROP in property-list PLIST, or Qunbound if it
   has none.  */
266
static Lisp_Object
267
property_value (plist, prop)
268
     Lisp_Object plist, prop;
269 270 271 272 273 274 275 276 277 278 279 280
{
  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;
}

281 282 283 284 285 286 287 288 289
/* 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;
{
290
  Lisp_Object sym, value;
291

292
  if (BUFFERP (object))
293
    {
294 295 296 297 298 299 300
      /* 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))
301 302 303 304 305
	  {
	    record_property_change (interval->position, LENGTH (interval),
				    XCONS (sym)->car, XCONS (value)->car,
				    object);
	  }
306 307 308 309 310 311 312

      /* 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))
313 314 315 316 317
	  {
	    record_property_change (interval->position, LENGTH (interval),
				    XCONS (sym)->car, Qnil,
				    object);
	  }
318 319 320 321 322
    }

  /* Store new properties.  */
  interval->plist = Fcopy_sequence (properties);
}
Joseph Arceneaux's avatar
Joseph Arceneaux committed
323 324 325 326 327

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

328 329
   OBJECT should be the string or buffer the interval is in.

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

333 334
static int
add_properties (plist, i, object)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
335 336
     Lisp_Object plist;
     INTERVAL i;
337
     Lisp_Object object;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
338
{
339
  Lisp_Object tail1, tail2, sym1, val1;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
340 341
  register int changed = 0;
  register int found;
342 343 344 345 346 347 348 349 350
  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
351

352
  /* Go through each element of PLIST.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
353 354 355 356 357 358 359 360 361 362
  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)))
	  {
363 364
	    /* No need to gcpro, because tail2 protects this
	       and it must be a cons cell (we get an error otherwise).  */
365
	    register Lisp_Object this_cdr;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
366

367
	    this_cdr = Fcdr (tail2);
368
	    /* Found the property.  Now check its value.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
369 370 371
	    found = 1;

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

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

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

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

402 403
  UNGCPRO;

Joseph Arceneaux's avatar
Joseph Arceneaux committed
404 405 406 407
  return changed;
}

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

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

420
  current_plist = i->plist;
421
  /* Go through each element of plist.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
422 423 424 425 426 427 428
  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)))
	{
429
	  if (BUFFERP (object))
430
	    {
431 432 433
	      record_property_change (i->position, LENGTH (i),
				      sym, Fcar (Fcdr (current_plist)),
				      object);
434 435
	    }

Joseph Arceneaux's avatar
Joseph Arceneaux committed
436 437 438 439 440 441 442 443
	  current_plist = Fcdr (Fcdr (current_plist));
	  changed++;
	}

      /* Go through i's plist, looking for sym */
      tail2 = current_plist;
      while (! NILP (tail2))
	{
444 445
	  register Lisp_Object this;
	  this = Fcdr (Fcdr (tail2));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
446 447
	  if (EQ (sym, Fcar (this)))
	    {
448
	      if (BUFFERP (object))
449
		{
450 451
		  record_property_change (i->position, LENGTH (i),
					  sym, Fcar (Fcdr (this)), object);
452 453
		}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
454 455 456 457 458 459 460 461 462 463 464 465
	      Fsetcdr (Fcdr (tail2), Fcdr (Fcdr (this)));
	      changed++;
	    }
	  tail2 = this;
	}
    }

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

466
#if 0
Joseph Arceneaux's avatar
Joseph Arceneaux committed
467
/* Remove all properties from interval I.  Return non-zero
468
   if this changes the interval.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
469 470 471 472 473 474 475 476 477 478 479

static INLINE int
erase_properties (i)
     INTERVAL i;
{
  if (NILP (i->plist))
    return 0;

  i->plist = Qnil;
  return 1;
}
480
#endif
Joseph Arceneaux's avatar
Joseph Arceneaux committed
481

482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
/* Returns the interval of the POSITION in OBJECT. 
   POSITION is BEG-based.  */

INTERVAL
interval_of (position, object)
     int position;
     Lisp_Object object;
{
  register INTERVAL i;
  int beg, end;

  if (NILP (object))
    XSETBUFFER (object, current_buffer);

  CHECK_STRING_OR_BUFFER (object, 0);

  if (BUFFERP (object))
    {
      register struct buffer *b = XBUFFER (object);

      beg = BUF_BEGV (b);
      end = BUF_ZV (b);
      i = BUF_INTERVALS (b);
    }
  else
    {
      register struct Lisp_String *s = XSTRING (object);

      /* We expect position to be 1-based.  */
      beg = BEG;
      end = s->size + BEG;
      i = s->intervals;
    }

  if (!(beg <= position && position <= end))
517
    args_out_of_range (make_number (position), make_number (position));
518 519 520 521 522 523
  if (beg == end || NULL_INTERVAL_P (i))
    return NULL_INTERVAL;
    
  return find_interval (i, position);
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
524 525 526 527
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\
528 529
defaults to the current buffer.\n\
If POSITION is at the end of OBJECT, the value is nil.")
530 531
  (position, object)
     Lisp_Object position, object;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
532 533 534 535
{
  register INTERVAL i;

  if (NILP (object))
536
    XSETBUFFER (object, current_buffer);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
537

538
  i = validate_interval_range (object, &position, &position, soft);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
539 540
  if (NULL_INTERVAL_P (i))
    return Qnil;
541
  /* If POSITION is at the end of the interval,
542 543 544
     it means it's the end of OBJECT.
     There are no properties at the very end,
     since no character follows.  */
545
  if (XINT (position) == LENGTH (i) + i->position)
546
    return Qnil;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
547 548 549 550

  return i->plist;
}

551
DEFUN ("get-text-property", Fget_text_property, Sget_text_property, 2, 3, 0,
552
  "Return the value of POSITION's property PROP, in OBJECT.\n\
553 554
OBJECT is optional and defaults to the current buffer.\n\
If POSITION is at the end of OBJECT, the value is nil.")
555 556
  (position, prop, object)
     Lisp_Object position, object;
557
     Lisp_Object prop;
558
{
559
  return textget (Ftext_properties_at (position, object), prop);
560 561
}

562
DEFUN ("get-char-property", Fget_char_property, Sget_char_property, 2, 3, 0,
563
  "Return the value of POSITION's property PROP, in OBJECT.\n\
564
OBJECT is optional and defaults to the current buffer.\n\
565
If POSITION is at the end of OBJECT, the value is nil.\n\
566
If OBJECT is a buffer, then overlay properties are considered as well as\n\
567 568
text properties.\n\
If OBJECT is a window, then that window's buffer is used, but window-specific\n\
569
overlays are considered only if they are associated with OBJECT.")
570 571
  (position, prop, object)
     Lisp_Object position, object;
572 573 574 575
     register Lisp_Object prop;
{
  struct window *w = 0;

576
  CHECK_NUMBER_COERCE_MARKER (position, 0);
577 578

  if (NILP (object))
579
    XSETBUFFER (object, current_buffer);
580 581 582 583

  if (WINDOWP (object))
    {
      w = XWINDOW (object);
584
      object = w->buffer;
585 586 587
    }
  if (BUFFERP (object))
    {
588
      int posn = XINT (position);
589 590 591 592
      int noverlays;
      Lisp_Object *overlay_vec, tem;
      int next_overlay;
      int len;
593 594 595
      struct buffer *obuf = current_buffer;

      set_buffer_temp (XBUFFER (object));
596 597 598 599 600

      /* First try with room for 40 overlays.  */
      len = 40;
      overlay_vec = (Lisp_Object *) alloca (len * sizeof (Lisp_Object));

601 602
      noverlays = overlays_at (posn, 0, &overlay_vec, &len,
			       &next_overlay, NULL);
603 604 605 606 607 608 609

      /* 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));
610 611
	  noverlays = overlays_at (posn, 0, &overlay_vec, &len,
				   &next_overlay, NULL);
612 613 614
	}
      noverlays = sort_overlays (overlay_vec, noverlays, w);

615 616
      set_buffer_temp (obuf);

617 618 619 620 621 622 623 624 625 626
      /* 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.  */
627
  return (Fget_text_property (position, prop, object));
628
}
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668

DEFUN ("next-char-property-change", Fnext_char_property_change,
       Snext_char_property_change, 1, 2, 0,
  "Return the position of next text property or overlay change.\n\
This scans characters forward from POSITION in OBJECT till it finds\n\
a change in some text property, or the beginning or end of an overlay,\n\
and returns the position of that.\n\
If none is found, the function returns (point-max).\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.")
  (position, limit)
     Lisp_Object position, limit;
{
  Lisp_Object temp;

  temp = Fnext_overlay_change (position);
  if (! NILP (limit))
    {
      CHECK_NUMBER (limit, 2);
      if (XINT (limit) < XINT (temp))
	temp = limit;
    }
  return Fnext_property_change (position, Qnil, temp);
}

DEFUN ("previous-char-property-change", Fprevious_char_property_change,
       Sprevious_char_property_change, 1, 2, 0,
  "Return the position of previous text property or overlay change.\n\
Scans characters backward from POSITION in OBJECT till it finds\n\
a change in some text property, or the beginning or end of an overlay,\n\
and returns the position of that.\n\
If none is found, the function returns (point-max).\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.")
  (position, limit)
     Lisp_Object position, limit;
{
  Lisp_Object temp;
669

670 671 672 673 674 675 676 677 678 679
  temp = Fprevious_overlay_change (position);
  if (! NILP (limit))
    {
      CHECK_NUMBER (limit, 2);
      if (XINT (limit) > XINT (temp))
	temp = limit;
    }
  return Fprevious_property_change (position, Qnil, temp);
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
680
DEFUN ("next-property-change", Fnext_property_change,
681
       Snext_property_change, 1, 3, 0,
682
  "Return the position of next property change.\n\
683
Scans characters forward from POSITION in OBJECT till it finds\n\
684 685 686
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\
687
If the value is non-nil, it is a position greater than POSITION, never equal.\n\n\
688 689
If the optional third argument LIMIT is non-nil, don't search\n\
past position LIMIT; return LIMIT if nothing is found before LIMIT.")
690 691
  (position, object, limit)
     Lisp_Object position, object, limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
692 693 694
{
  register INTERVAL i, next;

695
  if (NILP (object))
696
    XSETBUFFER (object, current_buffer);
697

698
  if (! NILP (limit) && ! EQ (limit, Qt))
699 700
    CHECK_NUMBER_COERCE_MARKER (limit, 0);

701
  i = validate_interval_range (object, &position, &position, soft);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
702

703 704 705 706
  /* If LIMIT is t, return start of next interval--don't
     bother checking further intervals.  */
  if (EQ (limit, Qt))
    {
707 708 709 710 711
      if (NULL_INTERVAL_P (i))
	next = i;
      else
	next = next_interval (i);
	
712
      if (NULL_INTERVAL_P (next))
713 714 715
	XSETFASTINT (position, (STRINGP (object)
				? XSTRING (object)->size
				: BUF_ZV (XBUFFER (object))));
716
      else
717 718
	XSETFASTINT (position, next->position - (STRINGP (object)));
      return position;
719 720
    }

721 722 723 724 725
  if (NULL_INTERVAL_P (i))
    return limit;

  next = next_interval (i);

726 727
  while (! NULL_INTERVAL_P (next) && intervals_equal (i, next)
	 && (NILP (limit) || next->position < XFASTINT (limit)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
728 729 730
    next = next_interval (next);

  if (NULL_INTERVAL_P (next))
731 732 733
    return limit;
  if (! NILP (limit) && !(next->position < XFASTINT (limit)))
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
734

735 736
  XSETFASTINT (position, next->position - (STRINGP (object)));
  return position;
737 738 739 740 741 742 743 744 745 746 747
}

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

748
  XSETBUFFER (object, current_buffer);
749
  XSETFASTINT (pos, beg);
750 751 752 753 754 755 756 757 758

  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);
759 760
      if (NULL_INTERVAL_P (next))
	return 0;
761 762 763 764 765 766 767 768
      if (next->position >= end)
	return 0;
    }

  if (NULL_INTERVAL_P (next))
    return 0;

  return 1;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
769 770
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
771
DEFUN ("next-single-property-change", Fnext_single_property_change,
772
       Snext_single_property_change, 2, 4, 0,
773
  "Return the position of next property change for a specific property.\n\
774
Scans characters forward from POSITION till it finds\n\
775 776
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\
777
The property values are compared with `eq'.\n\
778
Return nil if the property is constant all the way to the end of OBJECT.\n\
779
If the value is non-nil, it is a position greater than POSITION, never equal.\n\n\
780
If the optional fourth argument LIMIT is non-nil, don't search\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
781
past position LIMIT; return LIMIT if nothing is found before LIMIT.")
782 783
  (position, prop, object, limit)
     Lisp_Object position, prop, object, limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
784 785 786 787
{
  register INTERVAL i, next;
  register Lisp_Object here_val;

788
  if (NILP (object))
789
    XSETBUFFER (object, current_buffer);
790

791 792 793
  if (!NILP (limit))
    CHECK_NUMBER_COERCE_MARKER (limit, 0);

794
  i = validate_interval_range (object, &position, &position, soft);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
795
  if (NULL_INTERVAL_P (i))
796
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
797

798
  here_val = textget (i->plist, prop);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
799
  next = next_interval (i);
800
  while (! NULL_INTERVAL_P (next) 
801 802
	 && EQ (here_val, textget (next->plist, prop))
	 && (NILP (limit) || next->position < XFASTINT (limit)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
803 804 805
    next = next_interval (next);

  if (NULL_INTERVAL_P (next))
806 807 808
    return limit;
  if (! NILP (limit) && !(next->position < XFASTINT (limit)))
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
809

810 811
  XSETFASTINT (position, next->position - (STRINGP (object)));
  return position;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
812 813
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
814
DEFUN ("previous-property-change", Fprevious_property_change,
815
       Sprevious_property_change, 1, 3, 0,
816
  "Return the position of previous property change.\n\
817
Scans characters backwards from POSITION in OBJECT till it finds\n\
818 819 820
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\
821
If the value is non-nil, it is a position less than POSITION, never equal.\n\n\
822
If the optional third argument LIMIT is non-nil, don't search\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
823
back past position LIMIT; return LIMIT if nothing is found until LIMIT.")
824 825
  (position, object, limit)
     Lisp_Object position, object, limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
826 827 828
{
  register INTERVAL i, previous;

829
  if (NILP (object))
830
    XSETBUFFER (object, current_buffer);
831

832 833 834
  if (!NILP (limit))
    CHECK_NUMBER_COERCE_MARKER (limit, 0);

835
  i = validate_interval_range (object, &position, &position, soft);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
836
  if (NULL_INTERVAL_P (i))
837
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
838

839
  /* Start with the interval containing the char before point.  */
840
  if (i->position == XFASTINT (position))
841 842
    i = previous_interval (i);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
843
  previous = previous_interval (i);
844 845 846
  while (! NULL_INTERVAL_P (previous) && intervals_equal (previous, i)
	 && (NILP (limit)
	     || previous->position + LENGTH (previous) > XFASTINT (limit)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
847 848
    previous = previous_interval (previous);
  if (NULL_INTERVAL_P (previous))
849 850 851 852
    return limit;
  if (!NILP (limit)
      && !(previous->position + LENGTH (previous) > XFASTINT (limit)))
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
853

854
  XSETFASTINT (position, (previous->position + LENGTH (previous)
855
		     - (STRINGP (object))));
856
  return position;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
857 858
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
859
DEFUN ("previous-single-property-change", Fprevious_single_property_change,
860
       Sprevious_single_property_change, 2, 4, 0,
861
  "Return the position of previous property change for a specific property.\n\
862
Scans characters backward from POSITION till it finds\n\
863 864
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\
865
The property values are compared with `eq'.\n\
866
Return nil if the property is constant all the way to the start of OBJECT.\n\
867
If the value is non-nil, it is a position less than POSITION, never equal.\n\n\
868
If the optional fourth argument LIMIT is non-nil, don't search\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
869
back past position LIMIT; return LIMIT if nothing is found until LIMIT.")
870 871
     (position, prop, object, limit)
     Lisp_Object position, prop, object, limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
872 873 874 875
{
  register INTERVAL i, previous;
  register Lisp_Object here_val;

876
  if (NILP (object))
877
    XSETBUFFER (object, current_buffer);
878

879 880 881
  if (!NILP (limit))
    CHECK_NUMBER_COERCE_MARKER (limit, 0);

882
  i = validate_interval_range (object, &position, &position, soft);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
883

884
  /* Start with the interval containing the char before point.  */
885
  if (! NULL_INTERVAL_P (i) && i->position == XFASTINT (position))
886 887
    i = previous_interval (i);

888 889 890
  if (NULL_INTERVAL_P (i))
    return limit;

891
  here_val = textget (i->plist, prop);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
892 893
  previous = previous_interval (i);
  while (! NULL_INTERVAL_P (previous)
894 895 896
	 && EQ (here_val, textget (previous->plist, prop))
	 && (NILP (limit)
	     || previous->position + LENGTH (previous) > XFASTINT (limit)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
897 898
    previous = previous_interval (previous);
  if (NULL_INTERVAL_P (previous))
899 900 901 902
    return limit;
  if (!NILP (limit)
      && !(previous->position + LENGTH (previous) > XFASTINT (limit)))
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
903

904
  XSETFASTINT (position, (previous->position + LENGTH (previous)
905
		     - (STRINGP (object))));
906
  return position;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
907
}
908

909 910
/* Callers note, this can GC when OBJECT is a buffer (or nil).  */

Joseph Arceneaux's avatar
Joseph Arceneaux committed
911
DEFUN ("add-text-properties", Fadd_text_properties,
912 913
       Sadd_text_properties, 3, 4, 0,
  "Add properties to the text from START to END.\n\
914
The third argument PROPERTIES is a property list\n\
915 916 917 918 919 920
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
921 922
{
  register INTERVAL i, unchanged;
923
  register int s, len, modified = 0;
924
  struct gcpro gcpro1;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
925 926 927 928 929

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

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

Joseph Arceneaux's avatar
Joseph Arceneaux committed
933 934 935 936 937 938 939
  i = validate_interval_range (object, &start, &end, hard);
  if (NULL_INTERVAL_P (i))
    return Qnil;

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

940 941 942 943
  /* 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
944
  /* If we're not starting on an interval boundary, we have to
945
    split this interval.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
946 947 948
  if (i->position != s)
    {
      /* If this interval already has the properties, we can
949
         skip it.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
950 951 952 953
      if (interval_has_all_properties (properties, i))
	{
	  int got = (LENGTH (i) - (s - i->position));
	  if (got >= len)
954
	    RETURN_UNGCPRO (Qnil);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
955
	  len -= got;
956
	  i = next_interval (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
957 958 959 960
	}
      else
	{
	  unchanged = i;
961
	  i = split_interval_right (unchanged, s - unchanged->position);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
962 963 964 965
	  copy_properties (unchanged, i);
	}
    }

966 967
  if (BUFFERP (object))
    modify_region (XBUFFER (object), XINT (start), XINT (end));
968

969
  /* We are at the beginning of interval I, with LEN chars to scan.  */
970
  for (;;)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
971
    {
972 973 974
      if (i == 0)
	abort ();

Joseph Arceneaux's avatar
Joseph Arceneaux committed
975 976
      if (LENGTH (i) >= len)
	{
977 978 979 980 981
	  /* 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
982
	  if (interval_has_all_properties (properties, i))
983
	    {
984 985 986
	      if (BUFFERP (object))
		signal_after_change (XINT (start), XINT (end) - XINT (start),
				     XINT (end) - XINT (start));
987 988 989

	      return modified ? Qt : Qnil;
	    }
Joseph Arceneaux's avatar
Joseph Arceneaux committed
990 991 992

	  if (LENGTH (i) == len)
	    {
993
	      add_properties (properties, i, object);
994 995 996
	      if (BUFFERP (object))
		signal_after_change (XINT (start), XINT (end) - XINT (start),
				     XINT (end) - XINT (start));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
997 998 999 1000 1001
	      return Qt;
	    }

	  /* i doesn't have the properties, and goes past the change limit */
	  unchanged = i;
1002
	  i = split_interval_left (unchanged, len);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1003
	  copy_properties (unchanged, i);
1004
	  add_properties (properties, i, object);
1005 1006 1007
	  if (BUFFERP (object))
	    signal_after_change (XINT (start), XINT (end) - XINT (start),
				 XINT (end) - XINT (start));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1008 1009 1010 1011
	  return Qt;
	}

      len -= LENGTH (i);
1012
      modified += add_properties (properties, i, object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1013 1014 1015 1016
      i = next_interval (i);
    }
}

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

1019 1020 1021
DEFUN ("put-text-property", Fput_text_property,
       Sput_text_property, 4, 5, 0,
  "Set one property of the text from START to END.\n\
1022
The third and fourth arguments PROPERTY and VALUE\n\
1023 1024 1025
specify the property to add.\n\
The optional fifth argument, OBJECT,\n\
is the string or buffer containing the text.")
1026 1027
  (start, end, property, value, object)
     Lisp_Object start, end, property, value, object;
1028 1029
{
  Fadd_text_properties (start, end,