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

This file is part of GNU Emacs.

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

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

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

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

/* 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
34 35 36 37 38 39


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

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

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

57
/* Visual properties text (including strings) may have.  */
58 59 60 61 62
static Lisp_Object Qforeground, Qbackground, Qunderline;
Lisp_Object Qfont;
static Lisp_Object Qstipple;
Lisp_Object Qinvisible, Qintangible, Qmouse_face;
static Lisp_Object Qread_only;
63
Lisp_Object Qminibuffer_prompt;
64 65 66

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

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

73 74
/* verify_interval_modification saves insertion hooks here
   to be run later by report_interval_modification.  */
75 76
static Lisp_Object interval_insert_behind_hooks;
static Lisp_Object interval_insert_in_front_hooks;
77

78
static void text_read_only (Lisp_Object) NO_RETURN;
79 80
static Lisp_Object Fprevious_property_change (Lisp_Object, Lisp_Object,
					      Lisp_Object);
81

82 83 84 85 86

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

  xsignal0 (Qtext_read_only);
93 94 95
}


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

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

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

#define soft 0
#define hard 1

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

129 130 131
  CHECK_STRING_OR_BUFFER (object);
  CHECK_NUMBER_COERCE_MARKER (*begin);
  CHECK_NUMBER_COERCE_MARKER (*end);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
132 133

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

  if (XINT (*begin) > XINT (*end))
    {
140 141
      Lisp_Object n;
      n = *begin;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
142
      *begin = *end;
143
      *end = n;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
144 145
    }

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

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

      searchpos = XINT (*begin);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
160 161 162
    }
  else
    {
163
      EMACS_INT len = SCHARS (object);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
164

165
      if (! (0 <= XINT (*begin) && XINT (*begin) <= XINT (*end)
166
	     && XINT (*end) <= len))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
167
	args_out_of_range (*begin, *end);
168
      XSETFASTINT (*begin, XFASTINT (*begin));
169
      if (begin != end)
170
	XSETFASTINT (*end, XFASTINT (*end));
171
      i = STRING_INTERVALS (object);
172

173
      if (len == 0)
174 175 176
	return NULL_INTERVAL;

      searchpos = XINT (*begin);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
177 178 179 180
    }

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

182
  return find_interval (i, searchpos);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
183 184 185 186
}

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

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

  if (CONSP (list))
    {
      register int i;
      register Lisp_Object tail;
199
      for (i = 0, tail = list; CONSP (tail); i++)
200
	{
201
	  tail = XCDR (tail);
202 203
	  QUIT;
	}
Joseph Arceneaux's avatar
Joseph Arceneaux committed
204 205 206 207 208 209 210 211 212
      if (i & 1)
	error ("Odd length text property list");
      return list;
    }

  return Fcons (list, Fcons (Qnil, Qnil));
}

/* Return nonzero if interval I has all the properties,
213
   with the same values, of list PLIST.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
214 215

static int
216
interval_has_all_properties (Lisp_Object plist, INTERVAL i)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
217
{
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.  */
222
  for (tail1 = plist; CONSP (tail1); tail1 = Fcdr (XCDR (tail1)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
223
    {
224
      sym1 = XCAR (tail1);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
225 226 227
      found = 0;

      /* Go through I's plist, looking for sym1 */
228 229
      for (tail2 = i->plist; CONSP (tail2); tail2 = Fcdr (XCDR (tail2)))
	if (EQ (sym1, XCAR (tail2)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
230 231
	  {
	    /* Found the same property on both lists.  If the
232
	       values are unequal, return zero.  */
233
	    if (! EQ (Fcar (XCDR (tail1)), Fcar (XCDR (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

Paul Eggert's avatar
Paul Eggert committed
251
static inline int
252
interval_has_some_properties (Lisp_Object plist, INTERVAL i)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
253 254 255
{
  register Lisp_Object tail1, tail2, sym;

256
  /* Go through each element of PLIST.  */
257
  for (tail1 = plist; CONSP (tail1); tail1 = Fcdr (XCDR (tail1)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
258
    {
259
      sym = XCAR (tail1);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
260 261

      /* Go through i's plist, looking for tail1 */
262 263
      for (tail2 = i->plist; CONSP (tail2); tail2 = Fcdr (XCDR (tail2)))
	if (EQ (sym, XCAR (tail2)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
264 265 266 267 268
	  return 1;
    }

  return 0;
}
269 270 271 272

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

Paul Eggert's avatar
Paul Eggert committed
273
static inline int
274
interval_has_some_properties_list (Lisp_Object list, INTERVAL i)
275 276 277 278
{
  register Lisp_Object tail1, tail2, sym;

  /* Go through each element of LIST.  */
279
  for (tail1 = list; CONSP (tail1); tail1 = XCDR (tail1))
280 281 282 283
    {
      sym = Fcar (tail1);

      /* Go through i's plist, looking for tail1 */
284
      for (tail2 = i->plist; CONSP (tail2); tail2 = XCDR (XCDR (tail2)))
285 286 287 288 289 290
	if (EQ (sym, XCAR (tail2)))
	  return 1;
    }

  return 0;
}
291

292 293 294 295
/* Changing the plists of individual intervals.  */

/* Return the value of PROP in property-list PLIST, or Qunbound if it
   has none.  */
296
static Lisp_Object
297
property_value (Lisp_Object plist, Lisp_Object prop)
298 299 300 301
{
  Lisp_Object value;

  while (PLIST_ELT_P (plist, value))
302 303
    if (EQ (XCAR (plist), prop))
      return XCAR (value);
304
    else
305
      plist = XCDR (value);
306 307 308 309

  return Qunbound;
}

310 311 312 313 314
/* 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
315
set_properties (Lisp_Object properties, INTERVAL interval, Lisp_Object object)
316
{
317
  Lisp_Object sym, value;
318

319
  if (BUFFERP (object))
320
    {
321 322 323 324
      /* 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);
325 326 327
	   sym = XCDR (value))
	if (! EQ (property_value (properties, XCAR (sym)),
		  XCAR (value)))
328 329
	  {
	    record_property_change (interval->position, LENGTH (interval),
330
				    XCAR (sym), XCAR (value),
331 332
				    object);
	  }
333 334 335 336 337

      /* 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);
338 339
	   sym = XCDR (value))
	if (EQ (property_value (interval->plist, XCAR (sym)), Qunbound))
340 341
	  {
	    record_property_change (interval->position, LENGTH (interval),
342
				    XCAR (sym), Qnil,
343 344
				    object);
	  }
345 346 347 348 349
    }

  /* Store new properties.  */
  interval->plist = Fcopy_sequence (properties);
}
Joseph Arceneaux's avatar
Joseph Arceneaux committed
350 351 352 353 354

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

355 356
   OBJECT should be the string or buffer the interval is in.

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

360
static int
361
add_properties (Lisp_Object plist, INTERVAL i, Lisp_Object object)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
362
{
363
  Lisp_Object tail1, tail2, sym1, val1;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
364 365
  register int changed = 0;
  register int found;
366 367 368 369 370 371 372 373 374
  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
375

376
  /* Go through each element of PLIST.  */
377
  for (tail1 = plist; CONSP (tail1); tail1 = Fcdr (XCDR (tail1)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
378
    {
379 380
      sym1 = XCAR (tail1);
      val1 = Fcar (XCDR (tail1));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
381 382 383
      found = 0;

      /* Go through I's plist, looking for sym1 */
384 385
      for (tail2 = i->plist; CONSP (tail2); tail2 = Fcdr (XCDR (tail2)))
	if (EQ (sym1, XCAR (tail2)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
386
	  {
387 388
	    /* No need to gcpro, because tail2 protects this
	       and it must be a cons cell (we get an error otherwise).  */
389
	    register Lisp_Object this_cdr;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
390

391
	    this_cdr = XCDR (tail2);
392
	    /* Found the property.  Now check its value.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
393 394 395
	    found = 1;

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

400
	    /* Record this change in the buffer, for undo purposes.  */
401
	    if (BUFFERP (object))
402
	      {
403 404
		record_property_change (i->position, LENGTH (i),
					sym1, Fcar (this_cdr), object);
405 406
	      }

Joseph Arceneaux's avatar
Joseph Arceneaux committed
407 408 409 410 411 412 413 414
	    /* I's property has a different value -- change it */
	    Fsetcar (this_cdr, val1);
	    changed++;
	    break;
	  }

      if (! found)
	{
415
	  /* Record this change in the buffer, for undo purposes.  */
416
	  if (BUFFERP (object))
417
	    {
418 419
	      record_property_change (i->position, LENGTH (i),
				      sym1, Qnil, object);
420
	    }
Joseph Arceneaux's avatar
Joseph Arceneaux committed
421 422 423 424 425
	  i->plist = Fcons (sym1, Fcons (val1, i->plist));
	  changed++;
	}
    }

426 427
  UNGCPRO;

Joseph Arceneaux's avatar
Joseph Arceneaux committed
428 429 430
  return changed;
}

431 432 433
/* 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.)
434
   OBJECT is the string or buffer containing I.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
435

436
static int
437
remove_properties (Lisp_Object plist, Lisp_Object list, INTERVAL i, Lisp_Object object)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
438
{
439
  register Lisp_Object tail1, tail2, sym, current_plist;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
440 441
  register int changed = 0;

442 443
  /* Nonzero means tail1 is a plist, otherwise it is a list.  */
  int use_plist;
444

445
  current_plist = i->plist;
446 447

  if (! NILP (plist))
448
    tail1 = plist, use_plist = 1;
449
  else
450
    tail1 = list, use_plist = 0;
451 452

  /* Go through each element of LIST or PLIST.  */
453
  while (CONSP (tail1))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
454
    {
455
      sym = XCAR (tail1);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
456

457
      /* First, remove the symbol if it's at the head of the list */
458
      while (CONSP (current_plist) && EQ (sym, XCAR (current_plist)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
459
	{
460
	  if (BUFFERP (object))
461 462 463
	    record_property_change (i->position, LENGTH (i),
				    sym, XCAR (XCDR (current_plist)),
				    object);
464

465
	  current_plist = XCDR (XCDR (current_plist));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
466 467 468
	  changed++;
	}

469
      /* Go through I's plist, looking for SYM.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
470 471 472
      tail2 = current_plist;
      while (! NILP (tail2))
	{
473
	  register Lisp_Object this;
474
	  this = XCDR (XCDR (tail2));
475
	  if (CONSP (this) && EQ (sym, XCAR (this)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
476
	    {
477
	      if (BUFFERP (object))
478 479
		record_property_change (i->position, LENGTH (i),
					sym, XCAR (XCDR (this)), object);
480

481
	      Fsetcdr (XCDR (tail2), XCDR (XCDR (this)));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
482 483 484 485
	      changed++;
	    }
	  tail2 = this;
	}
486 487

      /* Advance thru TAIL1 one way or the other.  */
488 489
      tail1 = XCDR (tail1);
      if (use_plist && CONSP (tail1))
490
	tail1 = XCDR (tail1);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
491 492 493 494 495 496 497
    }

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

498
#if 0
Joseph Arceneaux's avatar
Joseph Arceneaux committed
499
/* Remove all properties from interval I.  Return non-zero
500
   if this changes the interval.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
501

Paul Eggert's avatar
Paul Eggert committed
502
static inline int
Andreas Schwab's avatar
Andreas Schwab committed
503
erase_properties (INTERVAL i)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
504 505 506 507 508 509 510
{
  if (NILP (i->plist))
    return 0;

  i->plist = Qnil;
  return 1;
}
511
#endif
Joseph Arceneaux's avatar
Joseph Arceneaux committed
512

513
/* Returns the interval of POSITION in OBJECT.
514 515 516
   POSITION is BEG-based.  */

INTERVAL
517
interval_of (EMACS_INT position, Lisp_Object object)
518 519
{
  register INTERVAL i;
520
  EMACS_INT beg, end;
521 522 523

  if (NILP (object))
    XSETBUFFER (object, current_buffer);
Karl Heuer's avatar
Karl Heuer committed
524 525
  else if (EQ (object, Qt))
    return NULL_INTERVAL;
526

527
  CHECK_STRING_OR_BUFFER (object);
528 529 530 531 532 533 534 535 536 537 538

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

      beg = BUF_BEGV (b);
      end = BUF_ZV (b);
      i = BUF_INTERVALS (b);
    }
  else
    {
539
      beg = 0;
540 541
      end = SCHARS (object);
      i = STRING_INTERVALS (object);
542 543 544
    }

  if (!(beg <= position && position <= end))
545
    args_out_of_range (make_number (position), make_number (position));
546 547
  if (beg == end || NULL_INTERVAL_P (i))
    return NULL_INTERVAL;
548

549 550 551
  return find_interval (i, position);
}

Paul Eggert's avatar
Paul Eggert committed
552
DEFUN ("text-properties-at", Ftext_properties_at,
Joseph Arceneaux's avatar
Joseph Arceneaux committed
553
       Stext_properties_at, 1, 2, 0,
554
       doc: /* Return the list of properties of the character at POSITION in OBJECT.
555 556 557
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.
558
If POSITION is at the end of OBJECT, the value is nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
559
  (Lisp_Object position, Lisp_Object object)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
560 561 562 563
{
  register INTERVAL i;

  if (NILP (object))
564
    XSETBUFFER (object, current_buffer);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
565

566
  i = validate_interval_range (object, &position, &position, soft);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
567 568
  if (NULL_INTERVAL_P (i))
    return Qnil;
569
  /* If POSITION is at the end of the interval,
570 571 572
     it means it's the end of OBJECT.
     There are no properties at the very end,
     since no character follows.  */
573
  if (XINT (position) == LENGTH (i) + i->position)
574
    return Qnil;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
575 576 577 578

  return i->plist;
}

Paul Eggert's avatar
Paul Eggert committed
579
DEFUN ("get-text-property", Fget_text_property, Sget_text_property, 2, 3, 0,
580 581 582
       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.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
583
  (Lisp_Object position, Lisp_Object prop, Lisp_Object object)
584
{
585
  return textget (Ftext_properties_at (position, object), prop);
586 587
}

588
/* Return the value of char's property PROP, in OBJECT at POSITION.
589 590 591 592 593 594 595 596 597 598 599
   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
600
get_char_property_and_overlay (Lisp_Object position, register Lisp_Object prop, Lisp_Object object, Lisp_Object *overlay)
601 602 603
{
  struct window *w = 0;

604
  CHECK_NUMBER_COERCE_MARKER (position);
605 606

  if (NILP (object))
607
    XSETBUFFER (object, current_buffer);
608 609 610 611

  if (WINDOWP (object))
    {
      w = XWINDOW (object);
612
      object = w->buffer;
613 614 615
    }
  if (BUFFERP (object))
    {
616
      ptrdiff_t noverlays;
617
      Lisp_Object *overlay_vec;
618 619
      struct buffer *obuf = current_buffer;

620 621 622 623
      if (XINT (position) < BUF_BEGV (XBUFFER (object))
	  || XINT (position) > BUF_ZV (XBUFFER (object)))
	xsignal1 (Qargs_out_of_range, position);

624
      set_buffer_temp (XBUFFER (object));
625

626
      GET_OVERLAYS_AT (XINT (position), overlay_vec, noverlays, NULL, 0);
627 628
      noverlays = sort_overlays (overlay_vec, noverlays, w);

629 630
      set_buffer_temp (obuf);

631 632 633
      /* Now check the overlays in order of decreasing priority.  */
      while (--noverlays >= 0)
	{
634
	  Lisp_Object tem = Foverlay_get (overlay_vec[noverlays], prop);
635
	  if (!NILP (tem))
636 637 638 639 640 641
	    {
	      if (overlay)
		/* Return the overlay we got the property from.  */
		*overlay = overlay_vec[noverlays];
	      return tem;
	    }
642 643
	}
    }
644 645 646 647 648

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

649 650
  /* Not a buffer, or no appropriate overlay, so fall through to the
     simpler case.  */
651 652 653
  return Fget_text_property (position, prop, object);
}

Paul Eggert's avatar
Paul Eggert committed
654
DEFUN ("get-char-property", Fget_char_property, Sget_char_property, 2, 3, 0,
655
       doc: /* Return the value of POSITION's property PROP, in OBJECT.
656
Both overlay properties and text properties are checked.
657 658 659 660 661 662
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.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
663
  (Lisp_Object position, Lisp_Object prop, Lisp_Object object)
664 665
{
  return get_char_property_and_overlay (position, prop, object, 0);
666
}
667 668 669 670

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.
671 672 673
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
674
found, or nil, if it was found as a text property or not found at all.
675

676 677 678 679 680 681
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.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
682
  (Lisp_Object position, Lisp_Object prop, Lisp_Object object)
683 684 685 686
{
  Lisp_Object overlay;
  Lisp_Object val
    = get_char_property_and_overlay (position, prop, object, &overlay);
Richard M. Stallman's avatar
Richard M. Stallman committed
687
  return Fcons (val, overlay);
688 689
}

690

Paul Eggert's avatar
Paul Eggert committed
691
DEFUN ("next-char-property-change", Fnext_char_property_change,
692
       Snext_char_property_change, 1, 2, 0,
693
       doc: /* Return the position of next text property or overlay change.
694 695 696
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.
697
If none is found up to (point-max), the function returns (point-max).
698

699
If the optional second argument LIMIT is non-nil, don't search
700 701
past position LIMIT; return LIMIT if nothing is found before LIMIT.
LIMIT is a no-op if it is greater than (point-max).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
702
  (Lisp_Object position, Lisp_Object limit)
703 704 705 706 707 708
{
  Lisp_Object temp;

  temp = Fnext_overlay_change (position);
  if (! NILP (limit))
    {
David Kastrup's avatar
David Kastrup committed
709
      CHECK_NUMBER_COERCE_MARKER (limit);
710 711 712 713 714 715
      if (XINT (limit) < XINT (temp))
	temp = limit;
    }
  return Fnext_property_change (position, Qnil, temp);
}

Paul Eggert's avatar
Paul Eggert committed
716
DEFUN ("previous-char-property-change", Fprevious_char_property_change,
717
       Sprevious_char_property_change, 1, 2, 0,
718
       doc: /* Return the position of previous text property or overlay change.
719 720 721
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.
722
If none is found since (point-min), the function returns (point-min).
723

724
If the optional second argument LIMIT is non-nil, don't search
725 726
past position LIMIT; return LIMIT if nothing is found before LIMIT.
LIMIT is a no-op if it is less than (point-min).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
727
  (Lisp_Object position, Lisp_Object limit)
728 729
{
  Lisp_Object temp;
730

731 732 733
  temp = Fprevious_overlay_change (position);
  if (! NILP (limit))
    {
David Kastrup's avatar
David Kastrup committed
734
      CHECK_NUMBER_COERCE_MARKER (limit);
735 736 737 738 739
      if (XINT (limit) > XINT (temp))
	temp = limit;
    }
  return Fprevious_property_change (position, Qnil, temp);
}
740 741


Paul Eggert's avatar
Paul Eggert committed
742
DEFUN ("next-single-char-property-change", Fnext_single_char_property_change,
743
       Snext_single_char_property_change, 2, 4, 0,
744 745 746
       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.
747 748 749 750
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.

751 752 753
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.

754 755 756 757 758
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.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
759
  (Lisp_Object position, Lisp_Object prop, Lisp_Object object, Lisp_Object limit)
760 761 762
{
  if (STRINGP (object))
    {
763 764
      position = Fnext_single_property_change (position, prop, object, limit);
      if (NILP (position))
765 766
	{
	  if (NILP (limit))
767
	    position = make_number (SCHARS (object));
768
	  else
David Kastrup's avatar
David Kastrup committed
769 770 771 772
	    {
	      CHECK_NUMBER (limit);
	      position = limit;
	    }
773 774 775 776 777
	}
    }
  else
    {
      Lisp_Object initial_value, value;
Juanma Barranquero's avatar
Juanma Barranquero committed
778
      int count = SPECPDL_INDEX ();
779

780
      if (! NILP (object))
781
	CHECK_BUFFER (object);
782

783 784 785 786 787 788
      if (BUFFERP (object) && current_buffer != XBUFFER (object))
	{
	  record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
	  Fset_buffer (object);
	}

David Kastrup's avatar
David Kastrup committed
789 790
      CHECK_NUMBER_COERCE_MARKER (position);

791
      initial_value = Fget_char_property (position, prop, object);
792

793
      if (NILP (limit))
794
	XSETFASTINT (limit, ZV);
795
      else
796
	CHECK_NUMBER_COERCE_MARKER (limit);
797

798
      if (XFASTINT (position) >= XFASTINT (limit))
799
	{
800 801 802
	  position = limit;
	  if (XFASTINT (position) > ZV)
	    XSETFASTINT (position, ZV);
803
	}
804 805 806 807 808 809 810 811 812 813 814 815 816 817
      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;
	  }
818 819 820 821

      unbind_to (count, Qnil);
    }

822
  return position;
823 824
}

Paul Eggert's avatar
Paul Eggert committed
825
DEFUN ("previous-single-char-property-change",
826 827
       Fprevious_single_char_property_change,
       Sprevious_single_char_property_change, 2, 4, 0,
828 829 830
       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.
831 832 833 834
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.

835 836 837
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.

838 839 840
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.
841 842
If the optional fourth argument LIMIT is non-nil, don't search back past
position LIMIT; return LIMIT if nothing is found before reaching LIMIT.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
843
  (Lisp_Object position, Lisp_Object prop, Lisp_Object object, Lisp_Object limit)
844 845 846 847 848 849 850
{
  if (STRINGP (object))
    {
      position = Fprevious_single_property_change (position, prop, object, limit);
      if (NILP (position))
	{
	  if (NILP (limit))
851
	    position = make_number (0);
852
	  else
David Kastrup's avatar
David Kastrup committed
853 854 855 856
	    {
	      CHECK_NUMBER (limit);
	      position = limit;
	    }
857 858 859 860
	}
    }
  else
    {
Juanma Barranquero's avatar
Juanma Barranquero committed
861
      int count = SPECPDL_INDEX ();
862 863

      if (! NILP (object))
864
	CHECK_BUFFER (object);
865

866 867 868 869 870
      if (BUFFERP (object) && current_buffer != XBUFFER (object))
	{
	  record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
	  Fset_buffer (object);
	}
871

David Kastrup's avatar
David Kastrup committed
872 873
      CHECK_NUMBER_COERCE_MARKER (position);

874
      if (NILP (limit))
875
	XSETFASTINT (limit, BEGV);
876
      else
877
	CHECK_NUMBER_COERCE_MARKER (limit);
878

879
      if (XFASTINT (position) <= XFASTINT (limit))
880 881 882 883 884
	{
	  position = limit;
	  if (XFASTINT (position) < BEGV)
	    XSETFASTINT (position, BEGV);
	}
885
      else
886
	{
887 888 889
	  Lisp_Object initial_value
	    = Fget_char_property (make_number (XFASTINT (position) - 1),
				  prop, object);
890

891
	  while (1)
892 893
	    {
	      position = Fprevious_char_property_change (position, limit);
894

895 896 897 898 899 900 901
	      if (XFASTINT (position) <= XFASTINT (limit))
		{
		  position = limit;
		  break;
		}
	      else
		{
902 903 904
		  Lisp_Object value
		    = Fget_char_property (make_number (XFASTINT (position) - 1),
					  prop, object);
905 906 907 908 909

		  if (!EQ (value, initial_value))
		    break;
		}
	    }
910 911 912 913 914 915 916
	}

      unbind_to (count, Qnil);
    }

  return position;
}
917

Paul Eggert's avatar
Paul Eggert committed
918
DEFUN ("next-property-change", Fnext_property_change,
919
       Snext_property_change, 1, 3, 0,
920 921 922
       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.
923 924 925
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.
926 927 928 929 930
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.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
931
  (Lisp_Object position, Lisp_Object object, Lisp_Object limit)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
932 933 934
{
  register INTERVAL i, next;

935
  if (NILP (object))
936
    XSETBUFFER (object, current_buffer);
937

938
  if (!NILP (limit) && !EQ (limit, Qt))
939
    CHECK_NUMBER_COERCE_MARKER (limit);
940

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

943 944 945 946
  /* If LIMIT is t, return start of next interval--don't
     bother checking further intervals.  */
  if (EQ (limit, Qt))
    {
947 948 949 950
      if (NULL_INTERVAL_P (i))
	next = i;
      else
	next = next_interval (i);
951

952
      if (NULL_INTERVAL_P (next))
953
	XSETFASTINT (position, (STRINGP (object)
954
				? SCHARS (object)
955
				: BUF_ZV (XBUFFER (object))));
956
      else
957
	XSETFASTINT (position, next->position);
958
      return position;
959 960
    }

961 962 963 964 965
  if (NULL_INTERVAL_P (i))
    return limit;

  next = next_interval (i);

966
  while (!NULL_INTERVAL_P (next) && intervals_equal (i, next)
967
	 && (NILP (limit) || next->position < XFASTINT (limit)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
968 969
    next = next_interval (next);

970 971 972 973 974 975 976
  if (NULL_INTERVAL_P (next)
      || (next->position
	  >= (INTEGERP (limit)
	      ? XFASTINT (limit)
	      : (STRINGP (object)
		 ? SCHARS (object)
		 : BUF_ZV (XBUFFER (object))))))
977
    return limit;
978 979
  else
    return make_number (next->position);
980 981
}

Paul Eggert's avatar
Paul Eggert committed
982
DEFUN ("next-single-property-change", Fnext_single_property_change,
983
       Snext_single_property_change, 2, 4, 0,
984 985 986
       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.
987 988 989
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.
990 991 992 993 994 995
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.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
996
  (Lisp_Object position, Lisp_Object prop, Lisp_Object object, Lisp_Object limit)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
997 998 999 1000
{
  register INTERVAL i, next;
  register Lisp_Object here_val;

1001
  if (NILP (object))
1002
    XSETBUFFER (object, current_buffer);
1003

1004
  if (!NILP (limit))
1005
    CHECK_NUMBER_COERCE_MARKER (limit);
1006

1007
  i = validate_interval_range (object, &position, &position, soft);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1008
  if (NULL_INTERVAL_P (i))
1009
    return limit;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1010

1011
  here_val = textget (i->plist, prop);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1012
  next = next_interval (i);
1013
  while (! NULL_INTERVAL_P (next)
1014
	 && EQ (here_val, textget (next->plist, prop))