textprop.c 63.4 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, 1999, 2000, 2001, 2002
3
   Free Software Foundation, Inc.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
4 5 6 7 8

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
9
the Free Software Foundation; either version 2, or (at your option)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
10 11 12 13 14 15 16 17 18
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
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
21

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

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

/* 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
36 37 38 39 40 41


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

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


51
/* Types of hooks.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
52 53 54 55
Lisp_Object Qmouse_left;
Lisp_Object Qmouse_entered;
Lisp_Object Qpoint_left;
Lisp_Object Qpoint_entered;
56 57
Lisp_Object Qcategory;
Lisp_Object Qlocal_map;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
58

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

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

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

71
Lisp_Object Vinhibit_point_motion_hooks;
72
Lisp_Object Vdefault_text_properties;
73
Lisp_Object Vtext_property_default_nonsticky;
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;
79 80 81 82 83 84 85 86 87 88 89 90


/* Signal a `text-read-only' error.  This function makes it easier
   to capture that error in GDB by putting a breakpoint on it.  */

static void
text_read_only ()
{
  Fsignal (Qtext_read_only, Qnil);
}


Joseph Arceneaux's avatar
Joseph Arceneaux committed
91

Joseph Arceneaux's avatar
Joseph Arceneaux committed
92 93 94 95 96 97
/* 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
98

99 100 101
   When OBJECT is a string, we increment *BEGIN and *END
   to make them origin-one.

Joseph Arceneaux's avatar
Joseph Arceneaux committed
102 103 104 105 106 107 108 109 110
   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
111 112
   create an interval tree for OBJECT if one doesn't exist, provided
   the object actually contains text.  In the current design, if there
113
   is no text, there can be no text properties.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
114 115 116 117

#define soft 0
#define hard 1

Gerd Moellmann's avatar
Gerd Moellmann committed
118
INTERVAL
Joseph Arceneaux's avatar
Joseph Arceneaux committed
119 120 121 122 123
validate_interval_range (object, begin, end, force)
     Lisp_Object object, *begin, *end;
     int force;
{
  register INTERVAL i;
124 125
  int searchpos;

126 127 128
  CHECK_STRING_OR_BUFFER (object);
  CHECK_NUMBER_COERCE_MARKER (*begin);
  CHECK_NUMBER_COERCE_MARKER (*end);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
129 130

  /* If we are asked for a point, but from a subr which operates
131
     on a range, then return nothing.  */
132
  if (EQ (*begin, *end) && begin != end)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
133 134 135 136
    return NULL_INTERVAL;

  if (XINT (*begin) > XINT (*end))
    {
137 138
      Lisp_Object n;
      n = *begin;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
139
      *begin = *end;
140
      *end = n;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
141 142
    }

143
  if (BUFFERP (object))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
144 145 146 147 148 149
    {
      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);
150
      i = BUF_INTERVALS (b);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
151

152
      /* If there's no text, there are no properties.  */
153 154 155 156
      if (BUF_BEGV (b) == BUF_ZV (b))
	return NULL_INTERVAL;

      searchpos = XINT (*begin);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
157 158 159 160 161
    }
  else
    {
      register struct Lisp_String *s = XSTRING (object);

162
      if (! (0 <= XINT (*begin) && XINT (*begin) <= XINT (*end)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
163 164
	     && XINT (*end) <= s->size))
	args_out_of_range (*begin, *end);
165
      XSETFASTINT (*begin, XFASTINT (*begin));
166
      if (begin != end)
167
	XSETFASTINT (*end, XFASTINT (*end));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
168
      i = s->intervals;
169 170 171 172 173

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

      searchpos = XINT (*begin);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
174 175 176 177 178
    }

  if (NULL_INTERVAL_P (i))
    return (force ? create_root_interval (object) : i);
    
179
  return find_interval (i, searchpos);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
180 181 182 183
}

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

static Lisp_Object
validate_plist (list)
188
     Lisp_Object list;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
189 190 191 192 193 194 195 196 197
{
  if (NILP (list))
    return Qnil;

  if (CONSP (list))
    {
      register int i;
      register Lisp_Object tail;
      for (i = 0, tail = list; !NILP (tail); i++)
198 199 200 201
	{
	  tail = Fcdr (tail);
	  QUIT;
	}
Joseph Arceneaux's avatar
Joseph Arceneaux committed
202 203 204 205 206 207 208 209 210
      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,
211
   with the same values, of list PLIST.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
212 213 214 215 216 217

static int
interval_has_all_properties (plist, i)
     Lisp_Object plist;
     INTERVAL i;
{
218
  register Lisp_Object tail1, tail2, sym1;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
219 220
  register int found;

221
  /* Go through each element of PLIST.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
222 223 224 225 226 227 228 229 230 231
  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
232
	       values are unequal, return zero.  */
233
	    if (! EQ (Fcar (Fcdr (tail1)), Fcar (Fcdr (tail2))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
234 235
	      return 0;

236
	    /* Property has same value on both lists;  go to next one.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
237 238 239 240 241 242 243 244 245 246 247 248
	    found = 1;
	    break;
	  }

      if (! found)
	return 0;
    }

  return 1;
}

/* Return nonzero if the plist of interval I has any of the
249
   properties of PLIST, regardless of their values.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
250 251 252 253 254 255 256 257

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

258
  /* Go through each element of PLIST.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
259 260 261 262 263 264 265 266 267 268 269 270
  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;
}
271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294

/* Return nonzero if the plist of interval I has any of the
   property names in LIST, regardless of their values.  */

static INLINE int
interval_has_some_properties_list (list, i)
     Lisp_Object list;
     INTERVAL i;
{
  register Lisp_Object tail1, tail2, sym;

  /* Go through each element of LIST.  */
  for (tail1 = list; ! NILP (tail1); tail1 = XCDR (tail1))
    {
      sym = Fcar (tail1);

      /* Go through i's plist, looking for tail1 */
      for (tail2 = i->plist; ! NILP (tail2); tail2 = XCDR (XCDR (tail2)))
	if (EQ (sym, XCAR (tail2)))
	  return 1;
    }

  return 0;
}
295

296 297 298 299
/* Changing the plists of individual intervals.  */

/* Return the value of PROP in property-list PLIST, or Qunbound if it
   has none.  */
300
static Lisp_Object
301
property_value (plist, prop)
302
     Lisp_Object plist, prop;
303 304 305 306
{
  Lisp_Object value;

  while (PLIST_ELT_P (plist, value))
307 308
    if (EQ (XCAR (plist), prop))
      return XCAR (value);
309
    else
310
      plist = XCDR (value);
311 312 313 314

  return Qunbound;
}

315 316 317 318 319 320 321 322 323
/* 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;
{
324
  Lisp_Object sym, value;
325

326
  if (BUFFERP (object))
327
    {
328 329 330 331
      /* 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);
332 333 334
	   sym = XCDR (value))
	if (! EQ (property_value (properties, XCAR (sym)),
		  XCAR (value)))
335 336
	  {
	    record_property_change (interval->position, LENGTH (interval),
337
				    XCAR (sym), XCAR (value),
338 339
				    object);
	  }
340 341 342 343 344

      /* 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);
345 346
	   sym = XCDR (value))
	if (EQ (property_value (interval->plist, XCAR (sym)), Qunbound))
347 348
	  {
	    record_property_change (interval->position, LENGTH (interval),
349
				    XCAR (sym), Qnil,
350 351
				    object);
	  }
352 353 354 355 356
    }

  /* Store new properties.  */
  interval->plist = Fcopy_sequence (properties);
}
Joseph Arceneaux's avatar
Joseph Arceneaux committed
357 358 359 360 361

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

362 363
   OBJECT should be the string or buffer the interval is in.

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

367 368
static int
add_properties (plist, i, object)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
369 370
     Lisp_Object plist;
     INTERVAL i;
371
     Lisp_Object object;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
372
{
373
  Lisp_Object tail1, tail2, sym1, val1;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
374 375
  register int changed = 0;
  register int found;
376 377 378 379 380 381 382 383 384
  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
385

386
  /* Go through each element of PLIST.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
387 388 389 390 391 392 393 394 395 396
  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)))
	  {
397 398
	    /* No need to gcpro, because tail2 protects this
	       and it must be a cons cell (we get an error otherwise).  */
399
	    register Lisp_Object this_cdr;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
400

401
	    this_cdr = Fcdr (tail2);
402
	    /* Found the property.  Now check its value.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
403 404 405
	    found = 1;

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

410
	    /* Record this change in the buffer, for undo purposes.  */
411
	    if (BUFFERP (object))
412
	      {
413 414
		record_property_change (i->position, LENGTH (i),
					sym1, Fcar (this_cdr), object);
415 416
	      }

Joseph Arceneaux's avatar
Joseph Arceneaux committed
417 418 419 420 421 422 423 424
	    /* I's property has a different value -- change it */
	    Fsetcar (this_cdr, val1);
	    changed++;
	    break;
	  }

      if (! found)
	{
425
	  /* Record this change in the buffer, for undo purposes.  */
426
	  if (BUFFERP (object))
427
	    {
428 429
	      record_property_change (i->position, LENGTH (i),
				      sym1, Qnil, object);
430
	    }
Joseph Arceneaux's avatar
Joseph Arceneaux committed
431 432 433 434 435
	  i->plist = Fcons (sym1, Fcons (val1, i->plist));
	  changed++;
	}
    }

436 437
  UNGCPRO;

Joseph Arceneaux's avatar
Joseph Arceneaux committed
438 439 440
  return changed;
}

441 442 443
/* For any members of PLIST, or LIST,
   which are properties of I, remove them from I's plist.
   (If PLIST is non-nil, use that, otherwise use LIST.)
444
   OBJECT is the string or buffer containing I.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
445

446
static int
447 448
remove_properties (plist, list, i, object)
     Lisp_Object plist, list;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
449
     INTERVAL i;
450
     Lisp_Object object;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
451
{
452
  register Lisp_Object tail1, tail2, sym, current_plist;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
453 454
  register int changed = 0;

455 456 457
  /* Nonzero means tail1 is a list, otherwise it is a plist.  */
  int use_list;

458
  current_plist = i->plist;
459 460 461 462 463 464 465 466

  if (! NILP (plist))
    tail1 = plist, use_list = 0;
  else
    tail1 = list, use_list = 1;

  /* Go through each element of LIST or PLIST.  */
  while (! NILP (tail1))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
467
    {
468
      sym = XCAR (tail1);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
469

470 471
      /* First, remove the symbol if it's at the head of the list */
      while (! NILP (current_plist) && EQ (sym, XCAR (current_plist)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
472
	{
473
	  if (BUFFERP (object))
474 475 476
	    record_property_change (i->position, LENGTH (i),
				    sym, XCAR (XCDR (current_plist)),
				    object);
477

478
	  current_plist = XCDR (XCDR (current_plist));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
479 480 481
	  changed++;
	}

482
      /* Go through I's plist, looking for SYM.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
483 484 485
      tail2 = current_plist;
      while (! NILP (tail2))
	{
486
	  register Lisp_Object this;
487 488
	  this = XCDR (XCDR (tail2));
	  if (EQ (sym, XCAR (this)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
489
	    {
490
	      if (BUFFERP (object))
491 492
		record_property_change (i->position, LENGTH (i),
					sym, XCAR (XCDR (this)), object);
493

494
	      Fsetcdr (XCDR (tail2), XCDR (XCDR (this)));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
495 496 497 498
	      changed++;
	    }
	  tail2 = this;
	}
499 500 501 502 503 504

      /* Advance thru TAIL1 one way or the other.  */
      if (use_list)
	tail1 = XCDR (tail1);
      else
	tail1 = XCDR (XCDR (tail1));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
505 506 507 508 509 510 511
    }

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

512
#if 0
Joseph Arceneaux's avatar
Joseph Arceneaux committed
513
/* Remove all properties from interval I.  Return non-zero
514
   if this changes the interval.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
515 516 517 518 519 520 521 522 523 524 525

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

  i->plist = Qnil;
  return 1;
}
526
#endif
Joseph Arceneaux's avatar
Joseph Arceneaux committed
527

528
/* Returns the interval of POSITION in OBJECT. 
529 530 531 532 533 534 535 536 537 538 539 540
   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);
Karl Heuer's avatar
Karl Heuer committed
541 542
  else if (EQ (object, Qt))
    return NULL_INTERVAL;
543

544
  CHECK_STRING_OR_BUFFER (object);
545 546 547 548 549 550 551 552 553 554 555 556 557

  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);

558 559
      beg = 0;
      end = s->size;
560 561 562 563
      i = s->intervals;
    }

  if (!(beg <= position && position <= end))
564
    args_out_of_range (make_number (position), make_number (position));
565 566 567 568 569 570
  if (beg == end || NULL_INTERVAL_P (i))
    return NULL_INTERVAL;
    
  return find_interval (i, position);
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
571 572
DEFUN ("text-properties-at", Ftext_properties_at,
       Stext_properties_at, 1, 2, 0,
573 574 575 576 577
       doc: /* Return the list of properties of the character at POSITION in OBJECT.
OBJECT is the string or buffer to look for the properties in;
nil means the current buffer.
If POSITION is at the end of OBJECT, the value is nil.  */)
     (position, object)
578
     Lisp_Object position, object;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
579 580 581 582
{
  register INTERVAL i;

  if (NILP (object))
583
    XSETBUFFER (object, current_buffer);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
584

585
  i = validate_interval_range (object, &position, &position, soft);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
586 587
  if (NULL_INTERVAL_P (i))
    return Qnil;
588
  /* If POSITION is at the end of the interval,
589 590 591
     it means it's the end of OBJECT.
     There are no properties at the very end,
     since no character follows.  */
592
  if (XINT (position) == LENGTH (i) + i->position)
593
    return Qnil;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
594 595 596 597

  return i->plist;
}

598
DEFUN ("get-text-property", Fget_text_property, Sget_text_property, 2, 3, 0,
599 600 601 602
       doc: /* Return the value of POSITION's property PROP, in OBJECT.
OBJECT is optional and defaults to the current buffer.
If POSITION is at the end of OBJECT, the value is nil.  */)
     (position, prop, object)
603
     Lisp_Object position, object;
604
     Lisp_Object prop;
605
{
606
  return textget (Ftext_properties_at (position, object), prop);
607 608
}

609 610 611 612 613 614 615 616 617 618 619 620 621
/* Return the value of POSITION's property PROP, in OBJECT.
   OBJECT is optional and defaults to the current buffer.
   If OVERLAY is non-0, then in the case that the returned property is from
   an overlay, the overlay found is returned in *OVERLAY, otherwise nil is
   returned in *OVERLAY.
   If POSITION is at the end of OBJECT, the value is nil.
   If OBJECT is a buffer, then overlay properties are considered as well as
   text properties.
   If OBJECT is a window, then that window's buffer is used, but
   window-specific overlays are considered only if they are associated
   with OBJECT. */
Lisp_Object
get_char_property_and_overlay (position, prop, object, overlay)
622
     Lisp_Object position, object;
623
     register Lisp_Object prop;
624
     Lisp_Object *overlay;
625 626 627
{
  struct window *w = 0;

628
  CHECK_NUMBER_COERCE_MARKER (position);
629 630

  if (NILP (object))
631
    XSETBUFFER (object, current_buffer);
632 633 634 635

  if (WINDOWP (object))
    {
      w = XWINDOW (object);
636
      object = w->buffer;
637 638 639
    }
  if (BUFFERP (object))
    {
640
      int posn = XINT (position);
641 642 643 644
      int noverlays;
      Lisp_Object *overlay_vec, tem;
      int next_overlay;
      int len;
645 646 647
      struct buffer *obuf = current_buffer;

      set_buffer_temp (XBUFFER (object));
648 649 650 651 652

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

653
      noverlays = overlays_at (posn, 0, &overlay_vec, &len,
654
			       &next_overlay, NULL, 0);
655 656 657 658 659 660 661

      /* 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));
662
	  noverlays = overlays_at (posn, 0, &overlay_vec, &len,
663
				   &next_overlay, NULL, 0);
664 665 666
	}
      noverlays = sort_overlays (overlay_vec, noverlays, w);

667 668
      set_buffer_temp (obuf);

669 670 671 672 673
      /* Now check the overlays in order of decreasing priority.  */
      while (--noverlays >= 0)
	{
	  tem = Foverlay_get (overlay_vec[noverlays], prop);
	  if (!NILP (tem))
674 675 676 677 678 679
	    {
	      if (overlay)
		/* Return the overlay we got the property from.  */
		*overlay = overlay_vec[noverlays];
	      return tem;
	    }
680 681
	}
    }
682 683 684 685 686

  if (overlay)
    /* Indicate that the return value is not from an overlay.  */
    *overlay = Qnil;

687 688
  /* Not a buffer, or no appropriate overlay, so fall through to the
     simpler case.  */
689 690 691 692
  return Fget_text_property (position, prop, object);
}

DEFUN ("get-char-property", Fget_char_property, Sget_char_property, 2, 3, 0,
693
       doc: /* Return the value of POSITION's property PROP, in OBJECT.
694
Both overlay properties and text properties are checked.
695 696 697 698 699 700 701
OBJECT is optional and defaults to the current buffer.
If POSITION is at the end of OBJECT, the value is nil.
If OBJECT is a buffer, then overlay properties are considered as well as
text properties.
If OBJECT is a window, then that window's buffer is used, but window-specific
overlays are considered only if they are associated with OBJECT.  */)
     (position, prop, object)
702 703 704 705
     Lisp_Object position, object;
     register Lisp_Object prop;
{
  return get_char_property_and_overlay (position, prop, object, 0);
706
}
707 708 709

DEFUN ("next-char-property-change", Fnext_char_property_change,
       Snext_char_property_change, 1, 2, 0,
710 711 712 713 714 715 716 717 718
       doc: /* Return the position of next text property or overlay change.
This scans characters forward from POSITION till it finds a change in
some text property, or the beginning or end of an overlay, and returns
the position of that.
If none is found, the function returns (point-max).

If the optional third argument LIMIT is non-nil, don't search
past position LIMIT; return LIMIT if nothing is found before LIMIT.  */)
     (position, limit)
719 720 721 722 723 724 725
     Lisp_Object position, limit;
{
  Lisp_Object temp;

  temp = Fnext_overlay_change (position);
  if (! NILP (limit))
    {
726
      CHECK_NUMBER (limit);
727 728 729 730 731 732 733 734
      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,
735 736 737 738 739 740 741 742 743
       doc: /* Return the position of previous text property or overlay change.
Scans characters backward from POSITION till it finds a change in some
text property, or the beginning or end of an overlay, and returns the
position of that.
If none is found, the function returns (point-max).

If the optional third argument LIMIT is non-nil, don't search
past position LIMIT; return LIMIT if nothing is found before LIMIT.  */)
     (position, limit)
744 745 746
     Lisp_Object position, limit;
{
  Lisp_Object temp;
747

748 749 750
  temp = Fprevious_overlay_change (position);
  if (! NILP (limit))
    {
751
      CHECK_NUMBER (limit);
752 753 754 755 756
      if (XINT (limit) > XINT (temp))
	temp = limit;
    }
  return Fprevious_property_change (position, Qnil, temp);
}
757 758


759 760
DEFUN ("next-single-char-property-change", Fnext_single_char_property_change,
       Snext_single_char_property_change, 2, 4, 0,
761 762 763 764 765 766 767 768 769 770
       doc: /* Return the position of next text property or overlay change for a specific property.
Scans characters forward from POSITION till it finds
a change in the PROP property, then returns the position of the change.
The optional third argument OBJECT is the string or buffer to scan.
The property values are compared with `eq'.
If the property is constant all the way to the end of OBJECT, return the
last valid position in OBJECT.
If the optional fourth argument LIMIT is non-nil, don't search
past position LIMIT; return LIMIT if nothing is found before LIMIT.  */)
     (position, prop, object, limit)
771
     Lisp_Object prop, position, object, limit;
772 773 774
{
  if (STRINGP (object))
    {
775 776
      position = Fnext_single_property_change (position, prop, object, limit);
      if (NILP (position))
777 778
	{
	  if (NILP (limit))
779
	    position = make_number (XSTRING (object)->size);
780
	  else
781
	    position = limit;
782 783 784 785 786 787 788
	}
    }
  else
    {
      Lisp_Object initial_value, value;
      int count = specpdl_ptr - specpdl;

789
      if (! NILP (object))
790
	CHECK_BUFFER (object);
791 792 793 794 795 796 797
      
      if (BUFFERP (object) && current_buffer != XBUFFER (object))
	{
	  record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
	  Fset_buffer (object);
	}

798
      initial_value = Fget_char_property (position, prop, object);
799
      
800 801 802
      if (NILP (limit))
	XSETFASTINT (limit, BUF_ZV (current_buffer));
      else
803
	CHECK_NUMBER_COERCE_MARKER (limit);
804 805

      for (;;)
806
	{
807 808 809 810 811 812 813
	  position = Fnext_char_property_change (position, limit);
	  if (XFASTINT (position) >= XFASTINT (limit)) {
	    position = limit;
	    break;
	  }

	  value = Fget_char_property (position, prop, object);
814 815 816 817 818 819 820
	  if (!EQ (value, initial_value))
	    break;
	}

      unbind_to (count, Qnil);
    }

821
  return position;
822 823
}

824 825 826
DEFUN ("previous-single-char-property-change",
       Fprevious_single_char_property_change,
       Sprevious_single_char_property_change, 2, 4, 0,
827 828 829 830 831 832 833 834 835 836
       doc: /* Return the position of previous text property or overlay change for a specific property.
Scans characters backward from POSITION till it finds
a change in the PROP property, then returns the position of the change.
The optional third argument OBJECT is the string or buffer to scan.
The property values are compared with `eq'.
If the property is constant all the way to the start of OBJECT, return the
first valid position in OBJECT.
If the optional fourth argument LIMIT is non-nil, don't search
back past position LIMIT; return LIMIT if nothing is found before LIMIT.  */)
     (position, prop, object, limit)
837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854
     Lisp_Object prop, position, object, limit;
{
  if (STRINGP (object))
    {
      position = Fprevious_single_property_change (position, prop, object, limit);
      if (NILP (position))
	{
	  if (NILP (limit))
	    position = make_number (XSTRING (object)->size);
	  else
	    position = limit;
	}
    }
  else
    {
      int count = specpdl_ptr - specpdl;

      if (! NILP (object))
855
	CHECK_BUFFER (object);
856 857 858 859 860 861 862 863 864 865
      
      if (BUFFERP (object) && current_buffer != XBUFFER (object))
	{
	  record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
	  Fset_buffer (object);
	}
      
      if (NILP (limit))
	XSETFASTINT (limit, BUF_BEGV (current_buffer));
      else
866
	CHECK_NUMBER_COERCE_MARKER (limit);
867

868 869 870
      if (XFASTINT (position) <= XFASTINT (limit))
	position = limit;
      else
871
	{
872
	  Lisp_Object initial_value =
873 874
	    Fget_char_property (make_number (XFASTINT (position) - 1),
				prop, object);
875 876 877 878
      
	  for (;;)
	    {
	      position = Fprevious_char_property_change (position, limit);
879

880 881 882 883 884 885 886 887
	      if (XFASTINT (position) <= XFASTINT (limit))
		{
		  position = limit;
		  break;
		}
	      else
		{
		  Lisp_Object value =
888 889
		    Fget_char_property (make_number (XFASTINT (position) - 1),
					prop, object);
890 891 892 893 894

		  if (!EQ (value, initial_value))
		    break;
		}
	    }
895 896 897 898 899 900 901
	}

      unbind_to (count, Qnil);
    }

  return position;
}
902

Joseph Arceneaux's avatar
Joseph Arceneaux committed
903
DEFUN ("next-property-change", Fnext_property_change,
904
       Snext_property_change, 1, 3, 0,
905 906 907 908 909 910 911 912 913 914
       doc: /* Return the position of next property change.
Scans characters forward from POSITION in OBJECT till it finds
a change in some text property, then returns the position of the change.
The optional second argument OBJECT is the string or buffer to scan.
Return nil if the property is constant all the way to the end of OBJECT.
If the value is non-nil, it is a position greater than POSITION, never equal.

If the optional third argument LIMIT is non-nil, don't search
past position LIMIT; return LIMIT if nothing is found before LIMIT.  */)
     (position, object, limit)
915
     Lisp_Object position, object, limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
916 917 918
{
  register INTERVAL i, next;

919
  if (NILP (object))
920
    XSETBUFFER (object, current_buffer);
921

922
  if (!NILP (limit) && !EQ (limit, Qt))
923
    CHECK_NUMBER_COERCE_MARKER (limit);
924

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

927 928 929 930
  /* If LIMIT is t, return start of next interval--don't
     bother checking further intervals.  */
  if (EQ (limit, Qt))
    {
931 932 933 934 935
      if (NULL_INTERVAL_P (i))
	next = i;
      else
	next = next_interval (i);
	
936
      if (NULL_INTERVAL_P (next))
937 938 939
	XSETFASTINT (position, (STRINGP (object)
				? XSTRING (object)->size
				: BUF_ZV (XBUFFER (object))));
940
      else
941
	XSETFASTINT (position, next->position);
942
      return position;
943 944
    }

945 946 947 948 949
  if (NULL_INTERVAL_P (i))
    return limit;

  next = next_interval (i);

950
  while (!NULL_INTERVAL_P (next) && intervals_equal (i, next)
951
	 && (NILP (limit) || next->position < XFASTINT (limit)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
952 953 954
    next = next_interval (next);

  if (NULL_INTERVAL_P (next))
955
    return limit;
956 957 958 959 960
  if (NILP (limit))
    XSETFASTINT (limit, (STRINGP (object)
			 ? XSTRING (object)->size
			 : BUF_ZV (XBUFFER (object))));
  if (!(next->position < XFASTINT (limit)))
961
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
962

963
  XSETFASTINT (position, next->position);
964
  return position;
965 966 967 968 969 970 971 972 973 974 975
}

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

976
  XSETBUFFER (object, current_buffer);
977
  XSETFASTINT (pos, beg);
978 979 980 981 982 983 984 985 986

  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);
987 988
      if (NULL_INTERVAL_P (next))
	return 0;
989
      if (next->position >= end)
990 991 992 993 994 995 996
	return 0;
    }

  if (NULL_INTERVAL_P (next))
    return 0;

  return 1;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
997 998
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
999
DEFUN ("next-single-property-change", Fnext_single_property_change,
1000
       Snext_single_property_change, 2, 4, 0,
1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011
       doc: /* Return the position of next property change for a specific property.
Scans characters forward from POSITION till it finds
a change in the PROP property, then returns the position of the change.
The optional third argument OBJECT is the string or buffer to scan.
The property values are compared with `eq'.
Return nil if the property is constant all the way to the end of OBJECT.
If the value is non-nil, it is a position greater than POSITION, never equal.

If the optional fourth argument LIMIT is non-nil, don't search
past position LIMIT; return LIMIT if nothing is found before LIMIT.  */)
     (position, prop, object, limit)
1012
     Lisp_Object position, prop, object, limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1013 1014 1015 1016
{
  register INTERVAL i, next;
  register Lisp_Object here_val;

1017
  if (NILP (object))
1018
    XSETBUFFER (object, current_buffer);
1019

1020
  if (!NILP (limit))
1021
    CHECK_NUMBER_COERCE_MARKER (limit);
1022

1023
  i = validate_interval_range (object, &position, &position, soft);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1024
  if (NULL_INTERVAL_P (i))
1025
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1026

1027
  here_val = textget (i->plist, prop);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1028
  next = next_interval (i);
1029
  while (! NULL_INTERVAL_P (next) 
1030
	 && EQ (here_val, textget (next->plist, prop))
1031
	 && (NILP (limit) || next->position < XFASTINT (limit)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1032 1033 1034
    next = next_interval (next);

  if (NULL_INTERVAL_P (next))
1035
    return limit;
1036 1037 1038 1039 1040
  if (NILP (limit))
    XSETFASTINT (limit, (STRINGP (object)
			 ? XSTRING (object)->size
			 : BUF_ZV (XBUFFER (object))));
  if (!(next->position < XFASTINT (limit)))
1041
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1042

1043
  return make_number (next->position);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1044 1045
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1046
DEFUN ("previous-property-change", Fprevious_property_change,
1047
       Sprevious_property_change, 1, 3, 0,
1048 1049 1050 1051 1052 1053 1054 1055 1056 1057
       doc: /* Return the position of previous property change.
Scans characters backwards from POSITION in OBJECT till it finds
a change in some text property, then returns the position of the change.
The optional second argument OBJECT is the string or buffer to scan.
Return nil if the property is constant all the way to the start of OBJECT.
If the value is non-nil, it is a position less than POSITION, never equal.

If the optional third argument LIMIT is non-nil, don't search
back past position LIMIT; return LIMIT if nothing is found until LIMIT.  */)
     (position, object, limit)
1058
     Lisp_Object position, object, limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1059 1060 1061
{
  register INTERVAL i, previous;

1062
  if (NILP (object))
1063
    XSETBUFFER (object, current_buffer);
1064

1065
  if (!NILP (limit))
1066
    CHECK_NUMBER_COERCE_MARKER (limit);
1067

1068
  i = validate_interval_range (object, &position, &position, soft);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1069
  if (NULL_INTERVAL_P (i))
1070
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1071

1072
  /* Start with the interval containing the char before point.  */
1073
  if (i->position == XFASTINT (position))
1074 1075
    i = previous_interval (i);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1076
  previous = previous_interval (i);