textprop.c 69.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, 2003,
Glenn Morris's avatar
Glenn Morris committed
3
                 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
4 5 6

This file is part of GNU Emacs.

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

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
18
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
19

20
#include <config.h>
21
#include <setjmp.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
/* Types of hooks.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
51 52 53 54
Lisp_Object Qmouse_left;
Lisp_Object Qmouse_entered;
Lisp_Object Qpoint_left;
Lisp_Object Qpoint_entered;
55 56
Lisp_Object Qcategory;
Lisp_Object Qlocal_map;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
57

58
/* Visual properties text (including strings) may have.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
59
Lisp_Object Qforeground, Qbackground, Qfont, Qunderline, Qstipple;
60
Lisp_Object Qinvisible, Qread_only, Qintangible, Qmouse_face;
61
Lisp_Object Qminibuffer_prompt;
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 Vchar_property_alias_alist;
74
Lisp_Object Vtext_property_default_nonsticky;
75

76 77 78 79
/* 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;
80

81
static void text_read_only (Lisp_Object) NO_RETURN;
82

83 84 85 86 87

/* 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
88 89
text_read_only (propval)
     Lisp_Object propval;
90
{
91 92 93 94
  if (STRINGP (propval))
    xsignal1 (Qtext_read_only, propval);

  xsignal0 (Qtext_read_only);
95 96 97
}


Joseph Arceneaux's avatar
Joseph Arceneaux committed
98

Joseph Arceneaux's avatar
Joseph Arceneaux committed
99 100 101 102 103 104
/* 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
105

106 107 108
   When OBJECT is a string, we increment *BEGIN and *END
   to make them origin-one.

Joseph Arceneaux's avatar
Joseph Arceneaux committed
109 110 111 112 113 114 115 116 117
   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
118 119
   create an interval tree for OBJECT if one doesn't exist, provided
   the object actually contains text.  In the current design, if there
120
   is no text, there can be no text properties.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
121 122 123 124

#define soft 0
#define hard 1

Gerd Moellmann's avatar
Gerd Moellmann committed
125
INTERVAL
Joseph Arceneaux's avatar
Joseph Arceneaux committed
126 127 128 129 130
validate_interval_range (object, begin, end, force)
     Lisp_Object object, *begin, *end;
     int force;
{
  register INTERVAL i;
131 132
  int searchpos;

133 134 135
  CHECK_STRING_OR_BUFFER (object);
  CHECK_NUMBER_COERCE_MARKER (*begin);
  CHECK_NUMBER_COERCE_MARKER (*end);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
136 137

  /* If we are asked for a point, but from a subr which operates
138
     on a range, then return nothing.  */
139
  if (EQ (*begin, *end) && begin != end)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
140 141 142 143
    return NULL_INTERVAL;

  if (XINT (*begin) > XINT (*end))
    {
144 145
      Lisp_Object n;
      n = *begin;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
146
      *begin = *end;
147
      *end = n;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
148 149
    }

150
  if (BUFFERP (object))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
151 152 153 154 155 156
    {
      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);
157
      i = BUF_INTERVALS (b);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
158

159
      /* If there's no text, there are no properties.  */
160 161 162 163
      if (BUF_BEGV (b) == BUF_ZV (b))
	return NULL_INTERVAL;

      searchpos = XINT (*begin);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
164 165 166
    }
  else
    {
167
      int len = SCHARS (object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
168

169
      if (! (0 <= XINT (*begin) && XINT (*begin) <= XINT (*end)
170
	     && XINT (*end) <= len))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
171
	args_out_of_range (*begin, *end);
172
      XSETFASTINT (*begin, XFASTINT (*begin));
173
      if (begin != end)
174
	XSETFASTINT (*end, XFASTINT (*end));
175
      i = STRING_INTERVALS (object);
176

177
      if (len == 0)
178 179 180
	return NULL_INTERVAL;

      searchpos = XINT (*begin);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
181 182 183 184
    }

  if (NULL_INTERVAL_P (i))
    return (force ? create_root_interval (object) : i);
185

186
  return find_interval (i, searchpos);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
187 188 189 190
}

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

static Lisp_Object
validate_plist (list)
195
     Lisp_Object list;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
196 197 198 199 200 201 202 203
{
  if (NILP (list))
    return Qnil;

  if (CONSP (list))
    {
      register int i;
      register Lisp_Object tail;
204
      for (i = 0, tail = list; CONSP (tail); i++)
205
	{
206
	  tail = XCDR (tail);
207 208
	  QUIT;
	}
Joseph Arceneaux's avatar
Joseph Arceneaux committed
209 210 211 212 213 214 215 216 217
      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,
218
   with the same values, of list PLIST.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
219 220 221 222 223 224

static int
interval_has_all_properties (plist, i)
     Lisp_Object plist;
     INTERVAL i;
{
225
  register Lisp_Object tail1, tail2, sym1;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
226 227
  register int found;

228
  /* Go through each element of PLIST.  */
229
  for (tail1 = plist; CONSP (tail1); tail1 = Fcdr (XCDR (tail1)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
230
    {
231
      sym1 = XCAR (tail1);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
232 233 234
      found = 0;

      /* Go through I's plist, looking for sym1 */
235 236
      for (tail2 = i->plist; CONSP (tail2); tail2 = Fcdr (XCDR (tail2)))
	if (EQ (sym1, XCAR (tail2)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
237 238
	  {
	    /* Found the same property on both lists.  If the
239
	       values are unequal, return zero.  */
240
	    if (! EQ (Fcar (XCDR (tail1)), Fcar (XCDR (tail2))))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
241 242
	      return 0;

243
	    /* Property has same value on both lists;  go to next one.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
244 245 246 247 248 249 250 251 252 253 254 255
	    found = 1;
	    break;
	  }

      if (! found)
	return 0;
    }

  return 1;
}

/* Return nonzero if the plist of interval I has any of the
256
   properties of PLIST, regardless of their values.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
257 258 259 260 261 262 263 264

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

265
  /* Go through each element of PLIST.  */
266
  for (tail1 = plist; CONSP (tail1); tail1 = Fcdr (XCDR (tail1)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
267
    {
268
      sym = XCAR (tail1);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
269 270

      /* Go through i's plist, looking for tail1 */
271 272
      for (tail2 = i->plist; CONSP (tail2); tail2 = Fcdr (XCDR (tail2)))
	if (EQ (sym, XCAR (tail2)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
273 274 275 276 277
	  return 1;
    }

  return 0;
}
278 279 280 281 282 283 284 285 286 287 288 289

/* 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.  */
290
  for (tail1 = list; CONSP (tail1); tail1 = XCDR (tail1))
291 292 293 294
    {
      sym = Fcar (tail1);

      /* Go through i's plist, looking for tail1 */
295
      for (tail2 = i->plist; CONSP (tail2); tail2 = XCDR (XCDR (tail2)))
296 297 298 299 300 301
	if (EQ (sym, XCAR (tail2)))
	  return 1;
    }

  return 0;
}
302

303 304 305 306
/* Changing the plists of individual intervals.  */

/* Return the value of PROP in property-list PLIST, or Qunbound if it
   has none.  */
307
static Lisp_Object
308
property_value (plist, prop)
309
     Lisp_Object plist, prop;
310 311 312 313
{
  Lisp_Object value;

  while (PLIST_ELT_P (plist, value))
314 315
    if (EQ (XCAR (plist), prop))
      return XCAR (value);
316
    else
317
      plist = XCDR (value);
318 319 320 321

  return Qunbound;
}

322 323 324 325 326 327 328 329 330
/* 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;
{
331
  Lisp_Object sym, value;
332

333
  if (BUFFERP (object))
334
    {
335 336 337 338
      /* 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);
339 340 341
	   sym = XCDR (value))
	if (! EQ (property_value (properties, XCAR (sym)),
		  XCAR (value)))
342 343
	  {
	    record_property_change (interval->position, LENGTH (interval),
344
				    XCAR (sym), XCAR (value),
345 346
				    object);
	  }
347 348 349 350 351

      /* 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);
352 353
	   sym = XCDR (value))
	if (EQ (property_value (interval->plist, XCAR (sym)), Qunbound))
354 355
	  {
	    record_property_change (interval->position, LENGTH (interval),
356
				    XCAR (sym), Qnil,
357 358
				    object);
	  }
359 360 361 362 363
    }

  /* Store new properties.  */
  interval->plist = Fcopy_sequence (properties);
}
Joseph Arceneaux's avatar
Joseph Arceneaux committed
364 365 366 367 368

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

369 370
   OBJECT should be the string or buffer the interval is in.

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

374 375
static int
add_properties (plist, i, object)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
376 377
     Lisp_Object plist;
     INTERVAL i;
378
     Lisp_Object object;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
379
{
380
  Lisp_Object tail1, tail2, sym1, val1;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
381 382
  register int changed = 0;
  register int found;
383 384 385 386 387 388 389 390 391
  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
392

393
  /* Go through each element of PLIST.  */
394
  for (tail1 = plist; CONSP (tail1); tail1 = Fcdr (XCDR (tail1)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
395
    {
396 397
      sym1 = XCAR (tail1);
      val1 = Fcar (XCDR (tail1));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
398 399 400
      found = 0;

      /* Go through I's plist, looking for sym1 */
401 402
      for (tail2 = i->plist; CONSP (tail2); tail2 = Fcdr (XCDR (tail2)))
	if (EQ (sym1, XCAR (tail2)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
403
	  {
404 405
	    /* No need to gcpro, because tail2 protects this
	       and it must be a cons cell (we get an error otherwise).  */
406
	    register Lisp_Object this_cdr;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
407

408
	    this_cdr = XCDR (tail2);
409
	    /* Found the property.  Now check its value.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
410 411 412
	    found = 1;

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

417
	    /* Record this change in the buffer, for undo purposes.  */
418
	    if (BUFFERP (object))
419
	      {
420 421
		record_property_change (i->position, LENGTH (i),
					sym1, Fcar (this_cdr), object);
422 423
	      }

Joseph Arceneaux's avatar
Joseph Arceneaux committed
424 425 426 427 428 429 430 431
	    /* I's property has a different value -- change it */
	    Fsetcar (this_cdr, val1);
	    changed++;
	    break;
	  }

      if (! found)
	{
432
	  /* Record this change in the buffer, for undo purposes.  */
433
	  if (BUFFERP (object))
434
	    {
435 436
	      record_property_change (i->position, LENGTH (i),
				      sym1, Qnil, object);
437
	    }
Joseph Arceneaux's avatar
Joseph Arceneaux committed
438 439 440 441 442
	  i->plist = Fcons (sym1, Fcons (val1, i->plist));
	  changed++;
	}
    }

443 444
  UNGCPRO;

Joseph Arceneaux's avatar
Joseph Arceneaux committed
445 446 447
  return changed;
}

448 449 450
/* 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.)
451
   OBJECT is the string or buffer containing I.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
452

453
static int
454 455
remove_properties (plist, list, i, object)
     Lisp_Object plist, list;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
456
     INTERVAL i;
457
     Lisp_Object object;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
458
{
459
  register Lisp_Object tail1, tail2, sym, current_plist;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
460 461
  register int changed = 0;

462 463
  /* Nonzero means tail1 is a plist, otherwise it is a list.  */
  int use_plist;
464

465
  current_plist = i->plist;
466 467

  if (! NILP (plist))
468
    tail1 = plist, use_plist = 1;
469
  else
470
    tail1 = list, use_plist = 0;
471 472

  /* Go through each element of LIST or PLIST.  */
473
  while (CONSP (tail1))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
474
    {
475
      sym = XCAR (tail1);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
476

477
      /* First, remove the symbol if it's at the head of the list */
478
      while (CONSP (current_plist) && EQ (sym, XCAR (current_plist)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
479
	{
480
	  if (BUFFERP (object))
481 482 483
	    record_property_change (i->position, LENGTH (i),
				    sym, XCAR (XCDR (current_plist)),
				    object);
484

485
	  current_plist = XCDR (XCDR (current_plist));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
486 487 488
	  changed++;
	}

489
      /* Go through I's plist, looking for SYM.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
490 491 492
      tail2 = current_plist;
      while (! NILP (tail2))
	{
493
	  register Lisp_Object this;
494
	  this = XCDR (XCDR (tail2));
495
	  if (CONSP (this) && EQ (sym, XCAR (this)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
496
	    {
497
	      if (BUFFERP (object))
498 499
		record_property_change (i->position, LENGTH (i),
					sym, XCAR (XCDR (this)), object);
500

501
	      Fsetcdr (XCDR (tail2), XCDR (XCDR (this)));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
502 503 504 505
	      changed++;
	    }
	  tail2 = this;
	}
506 507

      /* Advance thru TAIL1 one way or the other.  */
508 509
      tail1 = XCDR (tail1);
      if (use_plist && CONSP (tail1))
510
	tail1 = XCDR (tail1);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
511 512 513 514 515 516 517
    }

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

518
#if 0
Joseph Arceneaux's avatar
Joseph Arceneaux committed
519
/* Remove all properties from interval I.  Return non-zero
520
   if this changes the interval.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
521 522 523 524 525 526 527 528 529 530 531

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

  i->plist = Qnil;
  return 1;
}
532
#endif
Joseph Arceneaux's avatar
Joseph Arceneaux committed
533

534
/* Returns the interval of POSITION in OBJECT.
535 536 537 538 539 540 541 542 543 544 545 546
   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
547 548
  else if (EQ (object, Qt))
    return NULL_INTERVAL;
549

550
  CHECK_STRING_OR_BUFFER (object);
551 552 553 554 555 556 557 558 559 560 561

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

      beg = BUF_BEGV (b);
      end = BUF_ZV (b);
      i = BUF_INTERVALS (b);
    }
  else
    {
562
      beg = 0;
563 564
      end = SCHARS (object);
      i = STRING_INTERVALS (object);
565 566 567
    }

  if (!(beg <= position && position <= end))
568
    args_out_of_range (make_number (position), make_number (position));
569 570
  if (beg == end || NULL_INTERVAL_P (i))
    return NULL_INTERVAL;
571

572 573 574
  return find_interval (i, position);
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
575 576
DEFUN ("text-properties-at", Ftext_properties_at,
       Stext_properties_at, 1, 2, 0,
577
       doc: /* Return the list of properties of the character at POSITION in OBJECT.
578 579 580
If the optional second argument OBJECT is a buffer (or nil, which means
the current buffer), POSITION is a buffer position (integer or marker).
If OBJECT is a string, POSITION is a 0-based index into it.
581 582
If POSITION is at the end of OBJECT, the value is nil.  */)
     (position, object)
583
     Lisp_Object position, object;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
584 585 586 587
{
  register INTERVAL i;

  if (NILP (object))
588
    XSETBUFFER (object, current_buffer);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
589

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

  return i->plist;
}

603
DEFUN ("get-text-property", Fget_text_property, Sget_text_property, 2, 3, 0,
604 605 606 607
       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)
608
     Lisp_Object position, object;
609
     Lisp_Object prop;
610
{
611
  return textget (Ftext_properties_at (position, object), prop);
612 613
}

614
/* Return the value of char's property PROP, in OBJECT at POSITION.
615 616 617 618 619 620 621 622 623 624 625 626
   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)
627
     Lisp_Object position, object;
628
     register Lisp_Object prop;
629
     Lisp_Object *overlay;
630 631 632
{
  struct window *w = 0;

633
  CHECK_NUMBER_COERCE_MARKER (position);
634 635

  if (NILP (object))
636
    XSETBUFFER (object, current_buffer);
637 638 639 640

  if (WINDOWP (object))
    {
      w = XWINDOW (object);
641
      object = w->buffer;
642 643 644 645
    }
  if (BUFFERP (object))
    {
      int noverlays;
646
      Lisp_Object *overlay_vec;
647 648
      struct buffer *obuf = current_buffer;

649 650 651 652
      if (XINT (position) < BUF_BEGV (XBUFFER (object))
	  || XINT (position) > BUF_ZV (XBUFFER (object)))
	xsignal1 (Qargs_out_of_range, position);

653
      set_buffer_temp (XBUFFER (object));
654

655
      GET_OVERLAYS_AT (XINT (position), overlay_vec, noverlays, NULL, 0);
656 657
      noverlays = sort_overlays (overlay_vec, noverlays, w);

658 659
      set_buffer_temp (obuf);

660 661 662
      /* Now check the overlays in order of decreasing priority.  */
      while (--noverlays >= 0)
	{
663
	  Lisp_Object tem = Foverlay_get (overlay_vec[noverlays], prop);
664
	  if (!NILP (tem))
665 666 667 668 669 670
	    {
	      if (overlay)
		/* Return the overlay we got the property from.  */
		*overlay = overlay_vec[noverlays];
	      return tem;
	    }
671 672
	}
    }
673 674 675 676 677

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

678 679
  /* Not a buffer, or no appropriate overlay, so fall through to the
     simpler case.  */
680 681 682 683
  return Fget_text_property (position, prop, object);
}

DEFUN ("get-char-property", Fget_char_property, Sget_char_property, 2, 3, 0,
684
       doc: /* Return the value of POSITION's property PROP, in OBJECT.
685
Both overlay properties and text properties are checked.
686 687 688 689 690 691 692
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)
693 694 695 696
     Lisp_Object position, object;
     register Lisp_Object prop;
{
  return get_char_property_and_overlay (position, prop, object, 0);
697
}
698 699 700 701

DEFUN ("get-char-property-and-overlay", Fget_char_property_and_overlay,
       Sget_char_property_and_overlay, 2, 3, 0,
       doc: /* Like `get-char-property', but with extra overlay information.
702 703 704
The value is a cons cell.  Its car is the return value of `get-char-property'
with the same arguments--that is, the value of POSITION's property
PROP in OBJECT.  Its cdr is the overlay in which the property was
705
found, or nil, if it was found as a text property or not found at all.
706

707 708 709 710 711 712 713 714 715 716 717 718 719
OBJECT is optional and defaults to the current buffer.  OBJECT may be
a string, a buffer or a window.  For strings, the cdr of the return
value is always nil, since strings do not have overlays.  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.  If
POSITION is at the end of OBJECT, both car and cdr are nil.  */)
     (position, prop, object)
     Lisp_Object position, object;
     register Lisp_Object prop;
{
  Lisp_Object overlay;
  Lisp_Object val
    = get_char_property_and_overlay (position, prop, object, &overlay);
Richard M. Stallman's avatar
Richard M. Stallman committed
720
  return Fcons (val, overlay);
721 722
}

723 724 725

DEFUN ("next-char-property-change", Fnext_char_property_change,
       Snext_char_property_change, 1, 2, 0,
726
       doc: /* Return the position of next text property or overlay change.
727 728 729
This scans characters forward in the current buffer 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.
730
If none is found up to (point-max), the function returns (point-max).
731

732
If the optional second argument LIMIT is non-nil, don't search
733 734
past position LIMIT; return LIMIT if nothing is found before LIMIT.
LIMIT is a no-op if it is greater than (point-max).  */)
735
     (position, limit)
736 737 738 739 740 741 742
     Lisp_Object position, limit;
{
  Lisp_Object temp;

  temp = Fnext_overlay_change (position);
  if (! NILP (limit))
    {
David Kastrup's avatar
David Kastrup committed
743
      CHECK_NUMBER_COERCE_MARKER (limit);
744 745 746 747 748 749 750 751
      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,
752
       doc: /* Return the position of previous text property or overlay change.
753 754 755
Scans characters backward in the current buffer 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.
756
If none is found since (point-min), the function returns (point-min).
757

758
If the optional second argument LIMIT is non-nil, don't search
759 760
past position LIMIT; return LIMIT if nothing is found before LIMIT.
LIMIT is a no-op if it is less than (point-min).  */)
761
     (position, limit)
762 763 764
     Lisp_Object position, limit;
{
  Lisp_Object temp;
765

766 767 768
  temp = Fprevious_overlay_change (position);
  if (! NILP (limit))
    {
David Kastrup's avatar
David Kastrup committed
769
      CHECK_NUMBER_COERCE_MARKER (limit);
770 771 772 773 774
      if (XINT (limit) > XINT (temp))
	temp = limit;
    }
  return Fprevious_property_change (position, Qnil, temp);
}
775 776


777 778
DEFUN ("next-single-char-property-change", Fnext_single_char_property_change,
       Snext_single_char_property_change, 2, 4, 0,
779 780 781
       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.
782 783 784 785
If the optional third argument OBJECT is a buffer (or nil, which means
the current buffer), POSITION is a buffer position (integer or marker).
If OBJECT is a string, POSITION is a 0-based index into it.

786 787 788
In a string, scan runs to the end of the string.
In a buffer, it runs to (point-max), and the value cannot exceed that.

789 790 791 792 793 794
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)
795
     Lisp_Object prop, position, object, limit;
796 797 798
{
  if (STRINGP (object))
    {
799 800
      position = Fnext_single_property_change (position, prop, object, limit);
      if (NILP (position))
801 802
	{
	  if (NILP (limit))
803
	    position = make_number (SCHARS (object));
804
	  else
David Kastrup's avatar
David Kastrup committed
805 806 807 808
	    {
	      CHECK_NUMBER (limit);
	      position = limit;
	    }
809 810 811 812 813
	}
    }
  else
    {
      Lisp_Object initial_value, value;
Juanma Barranquero's avatar
Juanma Barranquero committed
814
      int count = SPECPDL_INDEX ();
815

816
      if (! NILP (object))
817
	CHECK_BUFFER (object);
818

819 820 821 822 823 824
      if (BUFFERP (object) && current_buffer != XBUFFER (object))
	{
	  record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
	  Fset_buffer (object);
	}

David Kastrup's avatar
David Kastrup committed
825 826
      CHECK_NUMBER_COERCE_MARKER (position);

827
      initial_value = Fget_char_property (position, prop, object);
828

829
      if (NILP (limit))
830
	XSETFASTINT (limit, ZV);
831
      else
832
	CHECK_NUMBER_COERCE_MARKER (limit);
833

834
      if (XFASTINT (position) >= XFASTINT (limit))
835
	{
836 837 838
	  position = limit;
	  if (XFASTINT (position) > ZV)
	    XSETFASTINT (position, ZV);
839
	}
840 841 842 843 844 845 846 847 848 849 850 851 852 853
      else
	while (1)
	  {
	    position = Fnext_char_property_change (position, limit);
	    if (XFASTINT (position) >= XFASTINT (limit))
	      {
		position = limit;
		break;
	      }

	    value = Fget_char_property (position, prop, object);
	    if (!EQ (value, initial_value))
	      break;
	  }
854 855 856 857

      unbind_to (count, Qnil);
    }

858
  return position;
859 860
}

861 862 863
DEFUN ("previous-single-char-property-change",
       Fprevious_single_char_property_change,
       Sprevious_single_char_property_change, 2, 4, 0,
864 865 866
       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.
867 868 869 870
If the optional third argument OBJECT is a buffer (or nil, which means
the current buffer), POSITION is a buffer position (integer or marker).
If OBJECT is a string, POSITION is a 0-based index into it.

871 872 873
In a string, scan runs to the start of the string.
In a buffer, it runs to (point-min), and the value cannot be less than that.

874 875 876 877 878 879
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)
880 881 882 883 884 885 886 887
     Lisp_Object prop, position, object, limit;
{
  if (STRINGP (object))
    {
      position = Fprevious_single_property_change (position, prop, object, limit);
      if (NILP (position))
	{
	  if (NILP (limit))
888
	    position = make_number (0);
889
	  else
David Kastrup's avatar
David Kastrup committed
890 891 892 893
	    {
	      CHECK_NUMBER (limit);
	      position = limit;
	    }
894 895 896 897
	}
    }
  else
    {
Juanma Barranquero's avatar
Juanma Barranquero committed
898
      int count = SPECPDL_INDEX ();
899 900

      if (! NILP (object))
901
	CHECK_BUFFER (object);
902

903 904 905 906 907
      if (BUFFERP (object) && current_buffer != XBUFFER (object))
	{
	  record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
	  Fset_buffer (object);
	}
908

David Kastrup's avatar
David Kastrup committed
909 910
      CHECK_NUMBER_COERCE_MARKER (position);

911
      if (NILP (limit))
912
	XSETFASTINT (limit, BEGV);
913
      else
914
	CHECK_NUMBER_COERCE_MARKER (limit);
915

916
      if (XFASTINT (position) <= XFASTINT (limit))
917 918 919 920 921
	{
	  position = limit;
	  if (XFASTINT (position) < BEGV)
	    XSETFASTINT (position, BEGV);
	}
922
      else
923
	{
924 925 926
	  Lisp_Object initial_value
	    = Fget_char_property (make_number (XFASTINT (position) - 1),
				  prop, object);
927

928
	  while (1)
929 930
	    {
	      position = Fprevious_char_property_change (position, limit);
931

932 933 934 935 936 937 938
	      if (XFASTINT (position) <= XFASTINT (limit))
		{
		  position = limit;
		  break;
		}
	      else
		{
939 940 941
		  Lisp_Object value
		    = Fget_char_property (make_number (XFASTINT (position) - 1),
					  prop, object);
942 943 944 945 946

		  if (!EQ (value, initial_value))
		    break;
		}
	    }
947 948 949 950 951 952 953
	}

      unbind_to (count, Qnil);
    }

  return position;
}
954

Joseph Arceneaux's avatar
Joseph Arceneaux committed
955
DEFUN ("next-property-change", Fnext_property_change,
956
       Snext_property_change, 1, 3, 0,
957 958 959
       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.
960 961 962
If the optional second argument OBJECT is a buffer (or nil, which means
the current buffer), POSITION is a buffer position (integer or marker).
If OBJECT is a string, POSITION is a 0-based index into it.
963 964 965 966 967 968
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)
969
     Lisp_Object position, object, limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
970 971 972
{
  register INTERVAL i, next;

973
  if (NILP (object))
974
    XSETBUFFER (object, current_buffer);
975

976
  if (!NILP (limit) && !EQ (limit, Qt))